@narrative.io/data-collaboration-sdk-ts 0.0.123 → 0.0.125

package/build/index.d.ts

@@ -16,7 +16,7 @@ import { type PingStatus } from "./ping/types";
 import { type Product, ProductsApi } from "./products";
 import { CompanyInfoApi, type CompanyInfo } from "./company-info";
 import { InstallationsApi, type Installation } from "./installations";
-import { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression } from "./nql";
+import { NqlApi, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, compileStatement, parseStatement } from "./nql";
 import { DataStreamsApi, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet } from "./data-streams";
 import { ForecastApi, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState } from "./forecast";
 import { ContractsApi, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView } from "./contracts";
@@ -33,4 +33,4 @@ declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaArrayProperty, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaArrayProperty, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, compileStatement, parseStatement, };

package/build/index.js

@@ -10,7 +10,7 @@ import { UploadsApi } from "./uploads";
 import { ProductsApi } from "./products";
 import { CompanyInfoApi } from "./company-info";
 import { InstallationsApi } from "./installations";
-import { NqlApi, } from "./nql";
+import { NqlApi, compileStatement, parseStatement, } from "./nql";
 import { DataStreamsApi, } from "./data-streams";
 import { ForecastApi, } from "./forecast";
 import { ContractsApi, } from "./contracts";
@@ -45,4 +45,4 @@ applyMixins(NarrativeApi, [
     AccessRulesApi,
     SubscriptionsApi,
 ]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, compileStatement, parseStatement, };

package/build/nql/Ast.d.ts

@@ -174,9 +174,9 @@ interface NqlExplain {
     query: NqlAst;
     type: "explain";
 }
-type NqlAstList = NqlAst[] & {
+interface NqlAstList extends Array<NqlAst> {
     type: "ast_list";
-};
+}
 export declare function isAstArray(n: NqlAst): n is NqlAstList;
 type NqlAst = {
     type: string;

package/build/nql/AstParser.d.ts

@@ -1,8 +1,19 @@
 import * as ast from "./Ast";
+type Statement = CreateMaterializedView | Explain;
+interface CreateMaterializedView {
+    type: "create_materialized_view";
+    name: string;
+    select: Select;
+}
+interface Explain {
+    type: "explain";
+    query: Select;
+}
 interface Select {
     type: "select";
     budget: ast.NqlBudget | null;
     columns: Expression[];
+    deduplication: Deduplication | Raw | null;
     from: Table[] | Raw;
     where: BooleanExpression | Raw | null;
 }
@@ -12,6 +23,10 @@ interface Raw {
     as?: string;
     nql: string;
 }
+interface Deduplication {
+    type: "deduplication";
+    expressions: Expression[];
+}
 type ColumnRef = AttributeRef | DatasetColumnRef | RawRef;
 type ArithmeticExpression = BinaryArithmeticExpression | UnaryMinus;
 type BinaryArithmeticExpression = Add | Divide | Multiply | Subtract;
@@ -179,8 +194,12 @@ interface Concat {
     as?: string;
     operands: Expression[];
 }
-export type { Expression, Raw, Select, Table };
+export type { CreateMaterializedView, Deduplication, Explain, Expression, Raw, Select, Statement, Table, };
+export declare function parseStatement(n: ast.NqlAst): Statement | Raw;
+export declare function parseCreateMaterializedView(n: ast.NqlCreateMaterializedView): CreateMaterializedView;
+export declare function parseExplain(n: ast.NqlExplain): Explain | Raw;
 export declare function parseSelect(n: ast.NqlSelect): Select;
 export declare function parseFrom(n: ast.NqlAst): Table[];
 export declare function parseWhere(n: ast.NqlAst): BooleanExpression | Raw;
+export declare function parseDeduplication(n: ast.NqlSelect): Deduplication | Raw | null;
 export declare function parseExpression(n: ast.NqlAst): Expression;

package/build/nql/AstParser.js

@@ -1,9 +1,42 @@
 import * as ast from "./Ast";
+export function parseStatement(n) {
+    switch (n.type) {
+        case "create_materialized_view":
+            return parseCreateMaterializedView(n);
+        case "explain":
+            return parseExplain(n);
+        default:
+            return nqlOrFail(n);
+    }
+}
+export function parseCreateMaterializedView(n) {
+    const select = parseSelect(n.select);
+    const create = {
+        type: "create_materialized_view",
+        name: n.name,
+        select,
+    };
+    return create;
+}
+export function parseExplain(n) {
+    switch (n.query.type) {
+        case "select": {
+            const explain = {
+                type: "explain",
+                query: parseSelect(n.query),
+            };
+            return explain;
+        }
+        default:
+            return nqlOrFail(n);
+    }
+}
 export function parseSelect(n) {
     const select = {
         type: "select",
         budget: n.budget,
         columns: n.columns.map((col) => parseExpression(col)),
+        deduplication: parseDeduplication(n),
         from: n.from !== null ? parseFrom(n.from) : [],
         where: n.where !== null ? parseWhere(n.where) : null,
     };
@@ -34,6 +67,38 @@ export function parseWhere(n) {
         return nqlOrFail(n);
     }
 }
+// Expect deduplication to be a qualify clause of the form:
+// row_number() over(partition by $expr0, $expr1, ... order by 0) = 1
+export function parseDeduplication(n) {
+    if (n.qualify !== null &&
+        n.qualify.type === "binary_op" &&
+        n.qualify.name === "=" &&
+        n.qualify.left.type === "binary_op" &&
+        n.qualify.left.name === "OVER" &&
+        n.qualify.left.left.type === "agg_function" &&
+        n.qualify.left.left.name === "ROW_NUMBER" &&
+        n.qualify.left.right.type === "window" &&
+        n.qualify.left.right.order_by.length === 1 &&
+        n.qualify.left.right.order_by[0].type === "literal" &&
+        n.qualify.left.right.order_by[0].value_type.type === "long" &&
+        n.qualify.left.right.order_by[0].value === "0" &&
+        n.qualify.left.right.lower_bound === null &&
+        n.qualify.left.right.upper_bound === null &&
+        n.qualify.left.right.partitions.length > 0 &&
+        // assert all partition expression are known/knowable
+        !n.qualify.left.right.partitions.some((e) => parseExpression(e).type === "nql") &&
+        n.qualify.right.type === "literal" &&
+        n.qualify.right.value_type.type === "long" &&
+        n.qualify.right.value === "1") {
+        const partitions = n.qualify.left.right.partitions.map(parseExpression);
+        const dedup = {
+            type: "deduplication",
+            expressions: partitions,
+        };
+        return dedup;
+    }
+    return n.qualify !== null ? nqlOrFail(n.qualify) : null;
+}
 export function parseExpression(n) {
     const parse = oneOf(parseArithmetic, parseBooleanExpression, parseColumnRef, parseFunctionCall, parseLit, parseStringExpression);
     return parse(n);

package/build/nql/NQLParser.js

@@ -93,7 +93,7 @@ function parseFieldFromString(fieldStr) {
         },
         field: f
             .map((field) => {
-            return field.replace('"value"', "value").replace('"type"', "type");
+            return field.replace("`value`", "value").replace("`type`", "type");
         })
             .join("."),
     };

package/build/nql/NqlBuilder.d.ts

@@ -1,8 +1,11 @@
 import { type NqlBudget } from "./Ast";
-import { type Select, type Expression, type Raw, type Table } from "./AstParser";
-type CompiledNql = string;
+import { type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table } from "./AstParser";
+export type CompiledNql = string;
+export declare function compileStatement(n: Statement): CompiledNql;
+export declare function compileCreateMaterializedView(n: CreateMaterializedView): CompiledNql;
+export declare function compileExplain(n: Explain): CompiledNql;
 export declare function compileSelect(q: Select): CompiledNql;
 export declare function compileBudget(budget: NqlBudget): CompiledNql;
+export declare function compileDeduplication(d: Deduplication | Raw): CompiledNql;
 export declare function compileFrom(tables: Table[] | Raw): CompiledNql;
 export declare function compileExpression(n: Expression): CompiledNql;
-export {};

package/build/nql/NqlBuilder.js

@@ -1,11 +1,31 @@
 const quoteChar = '"';
+export function compileStatement(n) {
+    switch (n.type) {
+        case "create_materialized_view":
+            return compileCreateMaterializedView(n);
+        case "explain":
+            return compileExplain(n);
+        default:
+            return unreachable(n);
+    }
+}
+export function compileCreateMaterializedView(n) {
+    // eslint-disable-next-line prettier/prettier
+    return `CREATE MATERIALIZE VIEW ${quote(n.name)} (${compileSelect(n.select)})`;
+}
+export function compileExplain(n) {
+    return `EXPLAIN ${compileSelect(n.query)}`;
+}
 export function compileSelect(q) {
     const columns = q.columns.map((e) => compileExpression(e));
     const select = `SELECT ${columns.join(", ")}`;
     const budget = q.budget !== null ? compileBudget(q.budget) : "";
     const from = `FROM ${compileFrom(q.from)}`;
     const where = q.where !== null ? `WHERE ${compileExpression(q.where)}` : "";
-    return `${select} ${from} ${where} ${budget}`;
+    const qualify = q.deduplication !== null
+        ? `QUALIFY ${compileDeduplication(q.deduplication)}`
+        : "";
+    return `${select} ${from} ${where} ${qualify} ${budget}`;
 }
 export function compileBudget(budget) {
     let period;
@@ -24,6 +44,15 @@ export function compileBudget(budget) {
     // eslint-disable-next-line prettier/prettier
     return `LIMIT ${budget.amount.value} ${budget.amount.currency.toUpperCase()} ${period}`;
 }
+export function compileDeduplication(d) {
+    if (d.type === "deduplication") {
+        const expressions = d.expressions.map(compileExpression).join(", ");
+        return `ROW_NUMBER() OVER (PARTITION BY ${expressions} ORDER BY 0) = 1`;
+    }
+    else {
+        return raw(d);
+    }
+}
 export function compileFrom(tables) {
     if (isArray(tables)) {
         return compileTableRefs(tables);

package/build/nql/index.d.ts

@@ -1,5 +1,4 @@
 import { BaseApi } from "../base-api";
-import type { Plan } from "./SubstraitParser";
 import { type NqlAst } from "./Ast";
 import type { Nql, NqlField, NqlResult, NqlCompileResult, NqlQueryInput, NqlExpression, NqlWhere, NqlFilterBinaryExpression, NqlBooleanExpression, NqlFilterExpression, NqlFilterUnaryExpression } from "./types";
 /**
@@ -27,7 +26,7 @@ declare class NqlApi extends BaseApi {
      * @param {string} nqlQuery - The NQL query to compile.
      * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL compilation.
      */
-    parseNql(nqlQuery: NqlQueryInput): Promise<Plan>;
+    parseNql(nqlQuery: NqlQueryInput): Promise<NqlAst>;
     /**
      * Validates an NQL query and returns an abstract syntax tree (AST) representing a structured form of
      * the query.
@@ -44,4 +43,7 @@ declare class NqlApi extends BaseApi {
      */
     getNqlByJobId(id: string): Promise<NqlResult>;
 }
-export { NqlApi, type Nql, type NqlAst, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, };
+export { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, };
+export * from "./Ast";
+export * from "./AstParser";
+export * from "./NqlBuilder";

package/build/nql/index.js

@@ -64,3 +64,6 @@ class NqlApi extends BaseApi {
     }
 }
 export { NqlApi, };
+export * from "./Ast";
+export * from "./AstParser";
+export * from "./NqlBuilder";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.123",
+  "version": "0.0.125",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",