Skip to content

Export parser AST types from the alasql module declaration #2547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
assapir wants to merge 1 commit into
base: develop
Choose a base branch
from
+35 −28
Open

Export parser AST types from the alasql module declaration #2547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 35 additions & 28 deletions types/alasql.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ declare module 'alasql' {
import * as xlsx from 'xlsx';

// Callback with error-first convention and optional data
interface AlaSQLCallback<T = unknown> {
export interface AlaSQLCallback<T = unknown> {
(err: Error | null, data?: T): void;
}

interface AlaSQLOptions {
export interface AlaSQLOptions {
errorlog: boolean;
valueof: boolean;
dropifnotexists: boolean; // drop database in any case
Expand All @@ -35,93 +35,100 @@ declare module 'alasql' {
}

// compiled Statement
interface AlaSQLStatement {
export interface AlaSQLStatement {
<T = unknown>(params?: any, cb?: AlaSQLCallback<T>, scope?: unknown): T;
}

type AlaSQLDefaultColumns = {[columnName: string]: string};
export type AlaSQLDefaultColumns = {[columnName: string]: string};

/**
* Base parsed expression node.
* Node shapes below are part of the public parser AST surface and follow semver.
*/
interface AlaSQLExpression {
export interface AlaSQLExpression {
toJS(context: string, tableid: string | number, defcols: AlaSQLDefaultColumns | null): string;
}

interface Op extends AlaSQLExpression {
export interface Op extends AlaSQLExpression {
left: ExpressionNode;
op: string;
right?: ExpressionNode;
right1?: ExpressionNode;
right2?: ExpressionNode;
}

interface Column extends AlaSQLExpression {
export interface Column extends AlaSQLExpression {
columnid: string;
tableid?: string;
databaseid?: string;
}

interface ParamValue extends AlaSQLExpression {
export interface ParamValue extends AlaSQLExpression {
param: string | number;
}

interface NumValue extends AlaSQLExpression {
export interface NumValue extends AlaSQLExpression {
value: number;
}

interface StringValue extends AlaSQLExpression {
export interface StringValue extends AlaSQLExpression {
value: string;
}

interface LogicValue extends AlaSQLExpression {
export interface LogicValue extends AlaSQLExpression {
value: boolean;
}

interface UniOp extends AlaSQLExpression {
export interface UniOp extends AlaSQLExpression {
op: string | null;
right: ExpressionNode;
}

type ExpressionNode = Op | Column | ParamValue | NumValue | StringValue | LogicValue | UniOp;
export type ExpressionNode =
| Op
| Column
| ParamValue
| NumValue
| StringValue
| LogicValue
| UniOp;

interface ExpressionWrapper extends AlaSQLExpression {
export interface ExpressionWrapper extends AlaSQLExpression {
expression: ExpressionNode;
reduced?: boolean;
}

interface Statement {
export interface Statement {
compile(databaseid: string): AlaSQLStatement;
where?: ExpressionWrapper;
[key: string]: unknown;
}

// abstract Syntax Tree
interface AlaSQLAST {
export interface AlaSQLAST {
statements: Statement[];
compile(databaseid: string): AlaSQLStatement;
}

// see https://github.com/alasql/alasql/wiki/User%20Defined%20Functions
interface userDefinedFunction {
export interface userDefinedFunction {
(...x: unknown[]): unknown;
}

interface userDefinedFunctionLookUp {
export interface userDefinedFunctionLookUp {
[x: string]: userDefinedFunction;
}

// see https://github.com/alasql/alasql/wiki/User%20Defined%20Functions
interface userAggregator {
export interface userAggregator {
(value: unknown, accumulator: unknown, stage: number): unknown;
}

interface userAggregatorLookUp {
export interface userAggregatorLookUp {
[x: string]: userAggregator;
}

interface userFromFunction {
export interface userFromFunction {
(
dataReference: unknown,
options: unknown,
Expand All @@ -131,7 +138,7 @@ declare module 'alasql' {
): void;
}

interface userFromFunctionLookUp {
export interface userFromFunctionLookUp {
[x: string]: userFromFunction;
}

Expand All @@ -140,7 +147,7 @@ declare module 'alasql' {
*
* @interface database
*/
interface database {
export interface database {
/**
* The database ID.
*
Expand All @@ -163,7 +170,7 @@ declare module 'alasql' {
*
* @interface table
*/
interface table {
export interface table {
/**
* The array of data stored in the table which can be queried
*
Expand All @@ -178,7 +185,7 @@ declare module 'alasql' {
*
* @interface databaseLookUp
*/
interface databaseLookUp {
export interface databaseLookUp {
[databaseName: string]: database;
}

Expand All @@ -187,11 +194,11 @@ declare module 'alasql' {
*
* @interface tableLookUp
*/
interface tableLookUp {
export interface tableLookUp {
[tableName: string]: table;
}

interface Database {
export interface Database {
new (databaseid?: string): Database;
databaseid: string;
dbversion: number;
Expand All @@ -209,7 +216,7 @@ declare module 'alasql' {
autoval(tablename: string, colname: string, getNext: boolean): unknown;
}

interface AlaSQL {
export interface AlaSQL {
options: AlaSQLOptions;
error: Error;
<T = unknown>(sql: string, params?: any, cb?: AlaSQLCallback<T>, scope?: unknown): T;
Expand Down