@hamelin.sh/compiler 0.9.3 → 0.9.5

package/dist/main.d.ts

@@ -11,6 +11,15 @@ interface Completion {
     items: CompletionItem[];
 }
 
+/**
+ * One output column of type `timestamp` with optional `TruncUnit` and `multiplier` from `@` truncation.
+ */
+interface OutputTimestampColumn {
+    name: string;
+    unit?: TruncUnit;
+    multiplier?: number;
+}
+
 interface BuildCatalogOutput {
     catalog: Catalog;
     errors: BuildCatalogError[];
@@ -79,6 +88,10 @@ interface FunctionDescription {
     parameters: string;
 }
 
+interface GetOutputTimestampColumnsResultOk {
+    columns: OutputTimestampColumn[];
+}
+
 interface TranslationError {
     area: LanguageArea | undefined;
     stage: Stage;
@@ -96,6 +109,8 @@ type CompileHamelinQueryResult = { Ok: CompileHamelinQueryResultOk } | { Err: Co
 
 type CompletionItemKind = "Text" | "Variable" | "Function" | "Command" | "Keyword";
 
+type GetOutputTimestampColumnsResult = { Ok: GetOutputTimestampColumnsResultOk } | { Err: ContextualTranslationErrors };
+
 type HamelinType = "binary" | "boolean" | "interval" | "calendar_interval" | "int" | "double" | "rows" | "string" | "timestamp" | "unknown" | { decimal: { precision: number; scale: number } } | { array: { element_type: HamelinType } } | { map: { key_type: HamelinType; value_type: HamelinType } } | { tuple: { elements: HamelinType[] } } | "variant" | { range: { of: HamelinType } } | { range_inclusive: { of: HamelinType } } | { struct: Column[] };
 
 type IncrementalEligibilityResult = { Eligible: { strategies: string[] } } | { NotEligible: { reasons: string[] } } | { CompilationError: ContextualTranslationErrors };
@@ -108,6 +123,8 @@ type QueryDatasetsResult = { Ok: string[] } | { Err: ContextualTranslationErrors
 
 type Stage = "Translation" | "Parsing" | "SemanticAnalysis" | "Normalization" | "Lowering";
 
+type TruncUnit = "Second" | "Minute" | "Hour" | "Day" | "Week" | "Month" | "Quarter" | "Year";
+
 type CatalogResourceInput = Omit<CatalogResource, "isUnion"> & {
     isUnion?: boolean;
 };
@@ -148,6 +165,8 @@ declare function getFunctionDescriptions(): Promise<FunctionDescription[]>;
  */
 declare const getLimits: (hamelinQuery: string) => number[];
 
+declare const getOutputTimestampColumns: (catalog: Catalog, hamelinInput: string) => Promise<GetOutputTimestampColumnsResult>;
+
 type FieldNames = string[] | null;
 declare const getSelectedFields: (query: string) => FieldNames;
 
@@ -159,4 +178,4 @@ declare function parseTokenValueClass(stream: {
 
 declare const sampleCatalog: Catalog;
 
-export { type BuildCatalogError, type BuildCatalogOutput, type Catalog, type Column, type CompileHamelinQueryResult, type CompileHamelinQueryResultOk, type Completion, type CompletionItem, type ContextualTranslationError, type ContextualTranslationErrors, type FunctionDescription, type HamelinType, type IncrementalEligibilityResult, type QuerySort, type TranslationError, buildCatalog, checkIncrementalEligibility, compileHamelinQuery, getAggregations, getCompletions, getDatasetsFromQuery, getFunctionDescriptions, getLimits, getSelectedFields, getSorts, hamelinGrammar, hamelinPrompt, parseTokenValueClass, sampleCatalog };
+export { type BuildCatalogError, type BuildCatalogOutput, type Catalog, type Column, type CompileHamelinQueryResult, type CompileHamelinQueryResultOk, type Completion, type CompletionItem, type ContextualTranslationError, type ContextualTranslationErrors, type FunctionDescription, type GetOutputTimestampColumnsResult, type GetOutputTimestampColumnsResultOk, type HamelinType, type IncrementalEligibilityResult, type OutputTimestampColumn, type QuerySort, type TranslationError, type TruncUnit, buildCatalog, checkIncrementalEligibility, compileHamelinQuery, getAggregations, getCompletions, getDatasetsFromQuery, getFunctionDescriptions, getLimits, getOutputTimestampColumns, getSelectedFields, getSorts, hamelinGrammar, hamelinPrompt, parseTokenValueClass, sampleCatalog };