@narrative.io/data-collaboration-sdk-ts 0.0.122 → 0.0.124

package/build/datasets/index.d.ts

@@ -1,7 +1,7 @@
 import { type ApiRecords } from "../types";
 import { BaseApi } from "../base-api";
-import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics, RetentionPolicy, DatasetTableSummary, RecalculationInfo, UpdateDatasetRequest } from "./types";
-export { type FilePerSnapshotResponse, type Dataset, type RetentionPolicy, type DatasetTableSummaryAPIResponse, type ColumnStatistics, type UpdateDatasetRequest, };
+import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics, RetentionPolicy, DatasetTableSummary, RecalculationInfo, UpdateDatasetRequest, SchemaFileConfigType, SchemaPropertiesType, DatasetStatus, DatasetWriteMode, SchemaFileConfig, SchemaProperties, SchemaArrayProperty, Schema, AdvancedStatisticsMetadata, SnapshotRange, Configuration, Columns, ColumnSummary, BasicStatistics, AdvancedStatistics, Histogram, Value } from "./types";
+export { type FilePerSnapshotResponse, type Dataset, type RetentionPolicy, type DatasetTableSummaryAPIResponse, type ColumnStatistics, 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, };
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.

package/build/datasets/types.d.ts

@@ -70,10 +70,10 @@ export interface DatasetTableSummaryAPIResponse {
     dataset_id: number;
     records: DatasetTableSummary[];
 }
-type SchemaFileConfigType = "flat" | "json" | "parquet";
-type SchemaPropertiesType = "string" | "boolean" | "double" | "long" | "timestamptz" | "object" | "array";
-type DatasetStatus = "active" | "archived";
-type DatasetWriteMode = "append" | "overwrite";
+export type SchemaFileConfigType = "flat" | "json" | "parquet";
+export type SchemaPropertiesType = "string" | "boolean" | "double" | "long" | "timestamptz" | "object" | "array";
+export type DatasetStatus = "active" | "archived";
+export type DatasetWriteMode = "append" | "overwrite";
 type ExpressionlessRetentionPolicyType = "retain_everything" | "expire_everything";
 type ExpressionedRetentionPolicyType = "retain_when" | "expire_when";
 type SchemaType = "object" | "value";
@@ -93,14 +93,14 @@ export type RetentionPolicy = {
         period: string;
     };
 };
-interface SchemaFileConfig {
+export interface SchemaFileConfig {
     type: SchemaFileConfigType;
     delimiter?: string;
     escape?: string;
     header?: boolean;
     quote?: string;
 }
-type SchemaProperties = Record<string, {
+export type SchemaProperties = Record<string, {
     type: SchemaPropertiesType;
     order?: number;
     approximate_cardinality?: number;
@@ -108,11 +108,11 @@ type SchemaProperties = Record<string, {
     items?: SchemaArrayProperty;
     properties?: SchemaProperties;
 }>;
-interface SchemaArrayProperty {
+export interface SchemaArrayProperty {
     type: SchemaPropertiesType;
     properties?: SchemaProperties;
 }
-interface Schema {
+export interface Schema {
     file_config: SchemaFileConfig;
     type: SchemaType;
     properties: SchemaProperties;
@@ -137,17 +137,17 @@ export interface ColumnStatistics {
     advanced_statistics_metadata: AdvancedStatisticsMetadata;
     columns_summary: ColumnSummary[];
 }
-interface AdvancedStatisticsMetadata {
+export interface AdvancedStatisticsMetadata {
     snapshot_range: SnapshotRange;
     configuration: Configuration;
 }
-interface SnapshotRange {
+export interface SnapshotRange {
     from_snapshot: string;
     until_snapshot: string;
     from_snapshot_timestamp: string;
     until_snapshot_timestamp: string;
 }
-interface Configuration {
+export interface Configuration {
     value_histogram: Columns;
     completeness: Columns;
     approx_count_distinct: Columns;
@@ -156,16 +156,16 @@ interface Configuration {
     mean: Columns;
     deviation: Columns;
 }
-interface Columns {
+export interface Columns {
     columns: string[];
 }
-interface ColumnSummary {
+export interface ColumnSummary {
     name: string;
     type: string;
     basic_statistics: BasicStatistics;
     advanced_statistics: AdvancedStatistics;
 }
-interface BasicStatistics {
+export interface BasicStatistics {
     nan_value_count: number | null;
     null_value_count: number;
     lower_bound: string | number;
@@ -173,7 +173,7 @@ interface BasicStatistics {
     value_count: number;
     column_store_bytes: number;
 }
-interface AdvancedStatistics {
+export interface AdvancedStatistics {
     approx_count_distinct: number | null;
     count_distinct: null;
     histogram: Histogram | null;
@@ -182,11 +182,11 @@ interface AdvancedStatistics {
     completeness: number;
     observed_types: Histogram | null;
 }
-interface Histogram {
+export interface Histogram {
     values: Record<string, Value>;
     number_of_bins: number;
 }
-interface Value {
+export interface Value {
     absolute: number;
     ratio: number;
 }

package/build/index.d.ts

@@ -3,7 +3,7 @@ import { DatasetApi } from "./datasets";
 import { HealthCheckApi } from "./health";
 import { RosettaStoneApi } from "./rosetta-stone";
 import { type Environment, type Config, type ApiRecords, type MonetaryAmount } from "./types";
-import type { DatasetTableSummaryAPIResponse, Dataset, DatasetTableSummary, FilePerSnapshotResponse, RetentionPolicy, UpdateDatasetRequest } from "./datasets/types";
+import type { DatasetTableSummaryAPIResponse, Dataset, DatasetTableSummary, FilePerSnapshotResponse, RetentionPolicy, UpdateDatasetRequest, SchemaFileConfigType, SchemaPropertiesType, DatasetStatus, DatasetWriteMode, SchemaFileConfig, SchemaProperties, SchemaArrayProperty, Schema, AdvancedStatisticsMetadata, SnapshotRange, Configuration, Columns, ColumnSummary, BasicStatistics, AdvancedStatistics, Histogram, Value } from "./datasets/types";
 import { type HealthCheckResult } from "./health/types";
 import { type SampleRecords } from "./rosetta-stone/types";
 import { AttributeApi } from "./attributes";
@@ -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 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 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, };

package/build/nql/Ast.d.ts

@@ -0,0 +1,184 @@
+type Quantifier = "all" | "distinct";
+interface NqlAggFunction {
+    nql: string;
+    as?: string;
+    args: NqlAst[];
+    name: string;
+    quantifier: Quantifier | null;
+    type: "agg_function";
+}
+interface NqlBinaryOp {
+    nql: string;
+    as?: string;
+    name: string;
+    left: NqlAst;
+    right: NqlAst;
+    type: "binary_op";
+}
+interface NqlCase {
+    nql: string;
+    as?: string;
+    args: CaseArg[];
+    type: "case";
+}
+type CaseArg = NqlWhen | NqlElse;
+interface NqlWhen {
+    nql: string;
+    condition: NqlAst;
+    value: NqlAst;
+    type: "when";
+}
+interface NqlElse {
+    nql: string;
+    value: NqlAst;
+    type: "else";
+}
+interface NqlFunction {
+    nql: string;
+    as?: string;
+    args: NqlAst[];
+    name: string;
+    type: "function";
+}
+interface NqlArrayType {
+    type: "array";
+    items: NqlSimpleType | null;
+}
+interface NqlBinaryType {
+    type: "binary";
+    format: NqlBinaryTypeFormat | null;
+}
+type NqlBinaryTypeFormat = "geometry";
+interface NqlBooleanType {
+    type: "bool";
+}
+interface NqlDoubleType {
+    type: "double";
+}
+interface NqlLongType {
+    type: "long";
+}
+interface NqlIntervalType {
+    type: "interval";
+    period: NqlIntervalTypePeriod;
+}
+type NqlIntervalTypePeriod = "day" | "day_hour" | "day_minute" | "day_second" | "hour" | "hour_minute" | "hour_second" | "minute" | "minute_second" | "month" | "second" | "year" | "year_month";
+interface NqlObjectType {
+    type: "object";
+    properties: NqlSimpleType[];
+}
+interface NqlOtherType {
+    type: "other";
+}
+interface NqlStringType {
+    type: "string";
+}
+interface NqlTimestampType {
+    type: "timestamp";
+}
+type NqlSimpleType = NqlArrayType | NqlBinaryType | NqlBooleanType | NqlDoubleType | NqlLongType | NqlIntervalType | NqlObjectType | NqlOtherType | NqlStringType | NqlTimestampType;
+interface NqlLit {
+    nql: string;
+    as?: string;
+    value_type: NqlSimpleType;
+    value: string | null;
+    type: "literal";
+}
+interface NqlIdentColumn {
+    nql: string;
+    as?: string;
+    db: string | null;
+    schema: string | null;
+    table: string;
+    column: string;
+    type: "column";
+}
+interface NqlIdentTable {
+    nql: string;
+    as?: string;
+    db: string | null;
+    schema: string | null;
+    table: string;
+    type: "table";
+}
+type NqlIdent = NqlIdentColumn | NqlIdentTable;
+type NqlJoinConditionType = "none" | "on" | "using";
+type NqlJoinType = "comma" | "cross" | "full" | "inner" | "left" | "left_semi" | "right";
+interface NqlJoin {
+    condition: NqlAst | null;
+    condition_type: NqlJoinConditionType;
+    left: NqlAst;
+    join_type: NqlJoinType;
+    right: NqlAst;
+    type: "join";
+}
+interface NqlTypeSpec {
+    nql: string;
+    value: string;
+    type: "type_spec";
+}
+interface NqlOp {
+    nql: string;
+    as?: string;
+    args: NqlAst[];
+    name: string;
+    type: "operator";
+}
+interface NqlWindow {
+    nql: string;
+    lower_bound: NqlAst | null;
+    name: NqlIdent | null;
+    order_by: NqlAst[];
+    partitions: NqlAst[];
+    upper_bound: NqlAst | null;
+    type: "window";
+}
+interface NqlUnknown {
+    nql: string;
+    type: "unknown";
+}
+interface NqlBudget {
+    amount: {
+        currency: string;
+        value: number;
+    };
+    period: {
+        type: "calendar_daily" | "calendar_monthly";
+    };
+}
+interface NqlSelect {
+    nql: string;
+    as?: string;
+    budget: NqlBudget | null;
+    columns: NqlAst[];
+    from: NqlAst | null;
+    group_by: NqlAst[];
+    having: NqlAst | null;
+    is_distinct: boolean;
+    limit: NqlAst | null;
+    order_by: NqlAst[];
+    qualify: NqlAst | null;
+    where: NqlAst | null;
+    windows: NqlAst[];
+    with: NqlAst[] | null;
+    type: "select";
+}
+interface NqlCreateMaterializedView {
+    nql: string;
+    name: string;
+    select: NqlSelect;
+    type: "create_materialized_view";
+}
+interface NqlExplain {
+    nql: string;
+    query: NqlAst;
+    type: "explain";
+}
+type NqlAstList = NqlAst[] & {
+    type: "ast_list";
+};
+export declare function isAstArray(n: NqlAst): n is NqlAstList;
+type NqlAst = {
+    type: string;
+} & (NqlAstList | NqlAggFunction | NqlBinaryOp | NqlCase | NqlFunction | NqlLit | NqlIdent | NqlJoin | NqlTypeSpec | NqlOp | NqlWindow | NqlUnknown | NqlSelect | NqlCreateMaterializedView | NqlExplain);
+export type { NqlAst, NqlAstList, NqlAggFunction, NqlBinaryOp, NqlBudget, NqlCase, NqlFunction, NqlSimpleType, NqlLit, NqlIdent, NqlIdentColumn, NqlIdentTable, NqlJoin, NqlJoinType, NqlJoinConditionType, NqlTypeSpec, NqlOp, NqlWindow, NqlUnknown, NqlSelect, NqlCreateMaterializedView, NqlExplain, };

package/build/nql/Ast.js

@@ -0,0 +1,3 @@
+export function isAstArray(n) {
+    return Array.isArray(n);
+}

package/build/nql/AstParser.d.ts

@@ -0,0 +1,186 @@
+import * as ast from "./Ast";
+interface Select {
+    type: "select";
+    budget: ast.NqlBudget | null;
+    columns: Expression[];
+    from: Table[] | Raw;
+    where: BooleanExpression | Raw | null;
+}
+type Expression = ArithmeticExpression | BooleanExpression | ColumnRef | Lit | FunctionCall | StringExpression | UnaryMinus | Raw;
+interface Raw {
+    type: "nql";
+    as?: string;
+    nql: string;
+}
+type ColumnRef = AttributeRef | DatasetColumnRef | RawRef;
+type ArithmeticExpression = BinaryArithmeticExpression | UnaryMinus;
+type BinaryArithmeticExpression = Add | Divide | Multiply | Subtract;
+type BooleanExpression = And | Between | Equals | NotEquals | Gt | Gte | In | IsNull | Like | Lt | Lte | Not | Or;
+type StringExpression = Concat;
+type Table = RosettaTable | DatasetTable | RawTable;
+interface RosettaTable {
+    type: "rosetta_stone";
+    as?: string;
+    join?: Join;
+}
+interface DatasetTable {
+    type: "dataset";
+    as?: string;
+    datasetId: number;
+    join?: Join;
+}
+interface RawTable {
+    type: "raw_table";
+    as?: string;
+    nql: string;
+    join?: Join;
+}
+interface Join {
+    type: "join";
+    condition: BooleanExpression | Raw | null;
+    conditionType: ast.NqlJoinConditionType;
+    joinType: ast.NqlJoinType;
+}
+interface AttributeRef {
+    type: "attribute_ref";
+    as?: string;
+    name: string;
+    column: string;
+}
+interface DatasetColumnRef {
+    type: "dataset_column_ref";
+    as?: string;
+    column: string;
+    datasetId: number;
+}
+interface RawRef {
+    type: "raw_ref";
+    as?: string;
+    nql: string;
+}
+interface Lit {
+    type: "lit";
+    as?: string;
+    value_type: ast.NqlSimpleType;
+    value: string | null;
+}
+interface FunctionCall {
+    type: "function";
+    as?: string;
+    args: Expression[];
+    name: string;
+}
+interface Add {
+    type: "+";
+    as?: string;
+    operands: Expression[];
+}
+interface Divide {
+    type: "/";
+    as?: string;
+    operands: Expression[];
+}
+interface Multiply {
+    type: "*";
+    as?: string;
+    operands: Expression[];
+}
+interface Subtract {
+    type: "-";
+    as?: string;
+    operands: Expression[];
+}
+interface UnaryMinus {
+    type: "unary_-";
+    as?: string;
+    operand: Expression;
+}
+interface And {
+    type: "and";
+    as?: string;
+    operands: Expression[];
+}
+interface Or {
+    type: "or";
+    as?: string;
+    operands: Expression[];
+}
+interface Not {
+    type: "not";
+    as?: string;
+    operand: BooleanExpression | Raw;
+}
+/** Implicitly we only support asymmetric betweens. */
+interface Between {
+    type: "between";
+    as?: string;
+    operand: Expression;
+    lower: Expression;
+    upper: Expression;
+}
+interface Equals {
+    type: "=";
+    as?: string;
+    left: Expression;
+    right: Expression;
+}
+interface NotEquals {
+    type: "<>";
+    as?: string;
+    left: Expression;
+    right: Expression;
+}
+interface Lt {
+    type: "<";
+    as?: string;
+    left: Expression;
+    right: Expression;
+}
+interface Lte {
+    type: "<=";
+    as?: string;
+    left: Expression;
+    right: Expression;
+}
+interface Gt {
+    type: ">";
+    as?: string;
+    left: Expression;
+    right: Expression;
+}
+interface Gte {
+    type: ">=";
+    as?: string;
+    left: Expression;
+    right: Expression;
+}
+interface In {
+    type: "in";
+    as?: string;
+    negated: boolean;
+    expression: Expression;
+    values: Expression[] | Raw;
+}
+interface IsNull {
+    type: "is_null";
+    as?: string;
+    negated: boolean;
+    operand: Expression;
+}
+interface Like {
+    type: "like";
+    as?: string;
+    negated: boolean;
+    value: Expression;
+    pattern: string;
+}
+interface Concat {
+    type: "||";
+    as?: string;
+    operands: Expression[];
+}
+export type { Expression, Raw, Select, Table };
+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 parseExpression(n: ast.NqlAst): Expression;