@hamelin.sh/compiler 0.1.30 → 0.1.31-prerelease.20250606T212425

package/dist/main.d.ts

@@ -7,21 +7,70 @@ type CompileResult = { Ok: Translation } | { Err: ContextualTranslationErrors };
 
 type StatementDatasetsResult = { Ok: string[] } | { Err: ContextualTranslationErrors };
 
-interface Translation {
-    sql: string;
-    columns: Column[];
-}
-
 interface FunctionDescription {
     name: string;
     parameters: string;
 }
 
+interface ContextualResult {
+    hamelin: string;
+    errors: ContextualTranslationError[];
+    completions: ContextualCompletion | undefined;
+    translation: Translation | undefined;
+}
+
+interface ContextualCompletion {
+    pretty: string;
+    completion: Completion;
+}
+
+type CompletionItemKind = "Text" | "Variable" | "Function" | "Command" | "Keyword";
+
+interface CompletionItem {
+    /**
+     * What to show
+     */
+    label: string;
+    /**
+     * What to actually put down
+     */
+    apply_string: string;
+    /**
+     * Small text next to the label.
+     */
+    detail: string | undefined;
+    /**
+     * Floating shit out to the right.
+     */
+    description: string | undefined;
+    /**
+     * Icon
+     */
+    kind: CompletionItemKind;
+    snippet: string | undefined;
+    /**
+     * Which section of text.
+     */
+    section: string | undefined;
+}
+
+interface Completion {
+    at: { start: number; end: number };
+    items: CompletionItem[];
+}
+
+interface Translation {
+    sql: string;
+    columns: Column[];
+}
+
 interface ContextualTranslationErrors {
     hamelin: string;
     errors: ContextualTranslationError[];
 }
 
+type TranslationErrors = TranslationError[];
+
 interface Context {
     interval: { start: number; end: number } | undefined;
     message: string;
@@ -56,7 +105,62 @@ interface Column {
 
 type Catalog = Record<string, Column[]>;
 
+declare class CatalogProvider {
+  private constructor();
+  free(): void;
+  static try_from_catalog(catalog: Catalog): CatalogProvider;
+}
+declare class Compiler {
+  free(): void;
+  constructor();
+  get_function_descriptions(): FunctionDescription[];
+  set_catalog_provider(provider: CatalogProvider): void;
+  set_time_range(start?: Date | null, end?: Date | null): void;
+  set_time_range_expression(expression: string): ContextualTranslationErrors | undefined;
+  compile_statement(query: string): CompileResult;
+  compile_statement_at(query: string, at?: number | null): ContextualResult;
+  get_statement_datasets(query: string): StatementDatasetsResult;
+}
+
+type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_catalogprovider_free: (a: number, b: number) => void;
+  readonly catalogprovider_try_from_catalog: (a: any) => [number, number, number];
+  readonly __wbg_compiler_free: (a: number, b: number) => void;
+  readonly compiler_new: () => number;
+  readonly compiler_get_function_descriptions: (a: number) => [number, number];
+  readonly compiler_set_catalog_provider: (a: number, b: number) => void;
+  readonly compiler_set_time_range: (a: number, b: number, c: number) => void;
+  readonly compiler_set_time_range_expression: (a: number, b: number, c: number) => any;
+  readonly compiler_compile_statement: (a: number, b: number, c: number) => any;
+  readonly compiler_compile_statement_at: (a: number, b: number, c: number, d: number) => any;
+  readonly compiler_get_statement_datasets: (a: number, b: number, c: number) => any;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_export_4: WebAssembly.Table;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __externref_drop_slice: (a: number, b: number) => void;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+declare function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
 declare const compileHamelin: (catalog: Catalog, hamelinInput: string, timeRange?: string) => Promise<CompileResult>;
+declare const createCompiler: (catalog: Catalog) => Promise<Compiler>;
 
 declare const getFunctionDescriptions: () => Promise<FunctionDescription[]>;
 
@@ -190,23 +294,17 @@ declare class HamelinLexer extends antlr.Lexer {
  */
 declare class HamelinVisitor<Result> extends AbstractParseTreeVisitor<Result> {
     /**
-     * Visit a parse tree produced by `HamelinParser.hamelin`.
+     * Visit a parse tree produced by `HamelinParser.queryEOF`.
      * @param ctx the parse tree
      * @return the visitor result
      */
-    visitHamelin?: (ctx: HamelinContext) => Result;
+    visitQueryEOF?: (ctx: QueryEOFContext) => Result;
     /**
      * Visit a parse tree produced by `HamelinParser.statementEOF`.
      * @param ctx the parse tree
      * @return the visitor result
      */
     visitStatementEOF?: (ctx: StatementEOFContext) => Result;
-    /**
-     * Visit a parse tree produced by `HamelinParser.queryEOF`.
-     * @param ctx the parse tree
-     * @return the visitor result
-     */
-    visitQueryEOF?: (ctx: QueryEOFContext) => Result;
     /**
      * Visit a parse tree produced by `HamelinParser.commandEOF`.
      * @param ctx the parse tree
@@ -862,37 +960,36 @@ declare class HamelinParser extends antlr.Parser {
     static readonly SIMPLE_COMMENT = 93;
     static readonly BRACKETED_COMMENT = 94;
     static readonly WS = 95;
-    static readonly RULE_hamelin = 0;
+    static readonly RULE_queryEOF = 0;
     static readonly RULE_statementEOF = 1;
-    static readonly RULE_queryEOF = 2;
-    static readonly RULE_commandEOF = 3;
-    static readonly RULE_expressionEOF = 4;
-    static readonly RULE_identifierEOF = 5;
-    static readonly RULE_simpleIdentifierEOF = 6;
-    static readonly RULE_statement = 7;
-    static readonly RULE_query = 8;
-    static readonly RULE_pipeline = 9;
-    static readonly RULE_command = 10;
-    static readonly RULE_assignmentClause = 11;
-    static readonly RULE_groupClause = 12;
-    static readonly RULE_assignment = 13;
-    static readonly RULE_matchDefine = 14;
-    static readonly RULE_selection = 15;
-    static readonly RULE_sortExpression = 16;
-    static readonly RULE_tableAlias = 17;
-    static readonly RULE_fromClause = 18;
-    static readonly RULE_expression = 19;
-    static readonly RULE_hamelintype = 20;
-    static readonly RULE_pattern = 21;
-    static readonly RULE_quantifier = 22;
-    static readonly RULE_columnReference = 23;
-    static readonly RULE_tableReference = 24;
-    static readonly RULE_identifier = 25;
-    static readonly RULE_simpleIdentifier = 26;
-    static readonly RULE_string = 27;
-    static readonly RULE_number = 28;
-    static readonly RULE_positionalArgument = 29;
-    static readonly RULE_namedArgument = 30;
+    static readonly RULE_commandEOF = 2;
+    static readonly RULE_expressionEOF = 3;
+    static readonly RULE_identifierEOF = 4;
+    static readonly RULE_simpleIdentifierEOF = 5;
+    static readonly RULE_statement = 6;
+    static readonly RULE_query = 7;
+    static readonly RULE_pipeline = 8;
+    static readonly RULE_command = 9;
+    static readonly RULE_assignmentClause = 10;
+    static readonly RULE_groupClause = 11;
+    static readonly RULE_assignment = 12;
+    static readonly RULE_matchDefine = 13;
+    static readonly RULE_selection = 14;
+    static readonly RULE_sortExpression = 15;
+    static readonly RULE_tableAlias = 16;
+    static readonly RULE_fromClause = 17;
+    static readonly RULE_expression = 18;
+    static readonly RULE_hamelintype = 19;
+    static readonly RULE_pattern = 20;
+    static readonly RULE_quantifier = 21;
+    static readonly RULE_columnReference = 22;
+    static readonly RULE_tableReference = 23;
+    static readonly RULE_identifier = 24;
+    static readonly RULE_simpleIdentifier = 25;
+    static readonly RULE_string = 26;
+    static readonly RULE_number = 27;
+    static readonly RULE_positionalArgument = 28;
+    static readonly RULE_namedArgument = 29;
     static readonly literalNames: (string | null)[];
     static readonly symbolicNames: (string | null)[];
     static readonly ruleNames: string[];
@@ -903,9 +1000,8 @@ declare class HamelinParser extends antlr.Parser {
     get serializedATN(): number[];
     protected createFailedPredicateException(predicate?: string, message?: string): antlr.FailedPredicateException;
     constructor(input: antlr.TokenStream);
-    hamelin(): HamelinContext;
-    statementEOF(): StatementEOFContext;
     queryEOF(): QueryEOFContext;
+    statementEOF(): StatementEOFContext;
     commandEOF(): CommandEOFContext;
     expressionEOF(): ExpressionEOFContext;
     identifierEOF(): IdentifierEOFContext;
@@ -944,11 +1040,10 @@ declare class HamelinParser extends antlr.Parser {
     get vocabulary(): antlr.Vocabulary;
     private static readonly decisionsToDFA;
 }
-declare class HamelinContext extends antlr.ParserRuleContext {
+declare class QueryEOFContext extends antlr.ParserRuleContext {
     constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
+    query(): QueryContext;
     EOF(): antlr.TerminalNode;
-    statement(): StatementContext[];
-    statement(i: number): StatementContext | null;
     get ruleIndex(): number;
     enterRule(listener: HamelinListener): void;
     exitRule(listener: HamelinListener): void;
@@ -963,15 +1058,6 @@ declare class StatementEOFContext extends antlr.ParserRuleContext {
     exitRule(listener: HamelinListener): void;
     accept<Result>(visitor: HamelinVisitor<Result>): Result | null;
 }
-declare class QueryEOFContext extends antlr.ParserRuleContext {
-    constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
-    query(): QueryContext;
-    EOF(): antlr.TerminalNode;
-    get ruleIndex(): number;
-    enterRule(listener: HamelinListener): void;
-    exitRule(listener: HamelinListener): void;
-    accept<Result>(visitor: HamelinVisitor<Result>): Result | null;
-}
 declare class CommandEOFContext extends antlr.ParserRuleContext {
     constructor(parent: antlr.ParserRuleContext | null, invokingState: number);
     command(): CommandContext;
@@ -1892,15 +1978,15 @@ declare class NamedArgumentContext extends antlr.ParserRuleContext {
  */
 declare class HamelinListener implements ParseTreeListener {
     /**
-     * Enter a parse tree produced by `HamelinParser.hamelin`.
+     * Enter a parse tree produced by `HamelinParser.queryEOF`.
      * @param ctx the parse tree
      */
-    enterHamelin?: (ctx: HamelinContext) => void;
+    enterQueryEOF?: (ctx: QueryEOFContext) => void;
     /**
-     * Exit a parse tree produced by `HamelinParser.hamelin`.
+     * Exit a parse tree produced by `HamelinParser.queryEOF`.
      * @param ctx the parse tree
      */
-    exitHamelin?: (ctx: HamelinContext) => void;
+    exitQueryEOF?: (ctx: QueryEOFContext) => void;
     /**
      * Enter a parse tree produced by `HamelinParser.statementEOF`.
      * @param ctx the parse tree
@@ -1911,16 +1997,6 @@ declare class HamelinListener implements ParseTreeListener {
      * @param ctx the parse tree
      */
     exitStatementEOF?: (ctx: StatementEOFContext) => void;
-    /**
-     * Enter a parse tree produced by `HamelinParser.queryEOF`.
-     * @param ctx the parse tree
-     */
-    enterQueryEOF?: (ctx: QueryEOFContext) => void;
-    /**
-     * Exit a parse tree produced by `HamelinParser.queryEOF`.
-     * @param ctx the parse tree
-     */
-    exitQueryEOF?: (ctx: QueryEOFContext) => void;
     /**
      * Enter a parse tree produced by `HamelinParser.commandEOF`.
      * @param ctx the parse tree
@@ -2891,4 +2967,4 @@ type QuerySort = {
  */
 declare const getSorts: (hamelinQuery: string) => QuerySort[];
 
-export { AggCommandContext, AnyNumberContext, AppendCommandContext, ArrayLiteralContext, AssignmentClauseContext, AssignmentContext, AtLeastOneContext, BackQuotedIdentifierContext, BasicDoubleQuotedStringLiteralContext, BasicSingleQuotedStringLiteralContext, BinaryLiteralContext, BinaryOperatorContext, BooleanLiteralContext, CastContext, type Catalog, ColumnReferenceAltContext, ColumnReferenceContext, CommandContext, CommandEOFContext, DecimalLiteralContext, DerefContext, DropCommandContext, ExactlyContext, ExplodeCommandContext, ExpressionContext, ExpressionEOFContext, ExpressionStatementContext, FromClauseContext, FromCommandContext, FunctionCallContext, type FunctionDescription, GroupClauseContext, HamelinContext, HamelinLexer, HamelinListener, HamelinParser, HamelinVisitor, HamelintypeContext, IdentifierContext, IdentifierEOFContext, IndexAccessContext, IntegerLiteralContext, IntervalLiteralContext, JoinCommandContext, LetCommandContext, LimitCommandContext, MatchCommandContext, MatchDefineContext, NamedArgumentContext, NestedContext, NullLiteralContext, NumberContext, NumericLiteralContext, PairLiteralContext, ParameterizedTypeContext, ParenthesizedExpressionContext, ParseCommandContext, PatternContext, PipelineAltContext, PipelineContext, PositionalArgumentContext, QuantifiedContext, QuantifierContext, QueryContext, QueryEOFContext, type QuerySort, QueryStatementContext, RowsLiteralContext, ScientificLiteralContext, SelectCommandContext, SelectionContext, SimpleIdentifierContext, SimpleIdentifierEOFContext, SimpleTypeContext, SortCommandContext, SortExpressionContext, StandaloneQueryContext, StatementContext, StatementEOFContext, StringContext, StringLiteralContext, StructLiteralContext, StructTypeContext, TableAliasContext, TableReferenceContext, TsTruncContext, TsTruncTimestampLiteralContext, TupleLiteralContext, TupleTypeContext, TypeWithArgumentsContext, UnaryPostfixOperatorContext, UnaryPrefixOperatorContext, UnboundRangeLiteralContext, UnicodeDoubleQuotedStringLiteralContext, UnicodeSingleQuotedStringLiteralContext, UnionCommandContext, UnnestCommandContext, UnquotedIdentifierContext, WhereCommandContext, WindowCommandContext, WithQueryContext, WithinCommandContext, ZeroOrOneContext, compileHamelin, getDatasetsFromQuery, getFunctionDescriptions, getLimits, getSorts, sampleCatalog };
+export { AggCommandContext, AnyNumberContext, AppendCommandContext, ArrayLiteralContext, AssignmentClauseContext, AssignmentContext, AtLeastOneContext, BackQuotedIdentifierContext, BasicDoubleQuotedStringLiteralContext, BasicSingleQuotedStringLiteralContext, BinaryLiteralContext, BinaryOperatorContext, BooleanLiteralContext, CastContext, type Catalog, CatalogProvider, type Column, ColumnReferenceAltContext, ColumnReferenceContext, CommandContext, CommandEOFContext, type CompileResult, Compiler, type Completion, type CompletionItem, type CompletionItemKind, type Context, type ContextualCompletion, type ContextualResult, type ContextualTranslationError, type ContextualTranslationErrors, DecimalLiteralContext, DerefContext, DropCommandContext, ExactlyContext, ExplodeCommandContext, ExpressionContext, ExpressionEOFContext, ExpressionStatementContext, FromClauseContext, FromCommandContext, FunctionCallContext, type FunctionDescription, GroupClauseContext, HamelinLexer, HamelinListener, HamelinParser, type HamelinType, HamelinVisitor, HamelintypeContext, IdentifierContext, IdentifierEOFContext, IndexAccessContext, type InitInput, type InitOutput, IntegerLiteralContext, IntervalLiteralContext, JoinCommandContext, type LanguageArea, LetCommandContext, type Level, LimitCommandContext, MatchCommandContext, MatchDefineContext, NamedArgumentContext, NestedContext, NullLiteralContext, NumberContext, NumericLiteralContext, PairLiteralContext, ParameterizedTypeContext, ParenthesizedExpressionContext, ParseCommandContext, PatternContext, PipelineAltContext, PipelineContext, PositionalArgumentContext, QuantifiedContext, QuantifierContext, QueryContext, QueryEOFContext, type QuerySort, QueryStatementContext, RowsLiteralContext, ScientificLiteralContext, SelectCommandContext, SelectionContext, SimpleIdentifierContext, SimpleIdentifierEOFContext, SimpleTypeContext, SortCommandContext, SortExpressionContext, type Stage, StandaloneQueryContext, StatementContext, type StatementDatasetsResult, StatementEOFContext, StringContext, StringLiteralContext, StructLiteralContext, StructTypeContext, type SyncInitInput, TableAliasContext, TableReferenceContext, type Translation, type TranslationError, type TranslationErrors, TsTruncContext, TsTruncTimestampLiteralContext, TupleLiteralContext, TupleTypeContext, TypeWithArgumentsContext, UnaryPostfixOperatorContext, UnaryPrefixOperatorContext, UnboundRangeLiteralContext, UnicodeDoubleQuotedStringLiteralContext, UnicodeSingleQuotedStringLiteralContext, UnionCommandContext, UnnestCommandContext, UnquotedIdentifierContext, WhereCommandContext, WindowCommandContext, WithQueryContext, WithinCommandContext, ZeroOrOneContext, compileHamelin, createCompiler, getDatasetsFromQuery, getFunctionDescriptions, getLimits, getSorts, initSync, sampleCatalog };