@narrative.io/data-collaboration-sdk-ts 0.0.53 → 0.0.55

package/build/index.d.ts

@@ -16,14 +16,13 @@ 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 NqlCompileResult, type NqlResult } from './nql';
+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 { DataStreamsApi, type DataStream } 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';
 import { getNqlObject, buildNql } from './nql/NQLParser';
-import type { Nql, NqlQueryInput } from './nql/types';
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, type Resource, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type NqlQueryInput, type NqlResult, type NqlCompileResult, type DataStream, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type Nql, getNqlObject, buildNql };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, type Resource, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, 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 ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, getNqlObject, buildNql };

package/build/nql/index.d.ts

@@ -1,6 +1,6 @@
 import { BaseApi } from '../base-api';
 import type { Plan } from './SubstraitParser';
-import type { Nql, NqlCompileResult, NqlQueryInput, NqlResult } from './types';
+import type { Nql, NqlField, NqlResult, NqlCompileResult, NqlQueryInput, NqlExpression, NqlWhere, NqlFilterBinaryExpression, NqlBooleanExpression, NqlFilterExpression, NqlFilterUnaryExpression } from './types';
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -35,4 +35,4 @@ declare class NqlApi extends BaseApi {
      */
     getNqlByJobId(id: string): Promise<NqlResult>;
 }
-export { NqlApi, type NqlResult, type NqlQueryInput, type NqlCompileResult, type Nql };
+export { NqlApi, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression };

package/build/nql/types.d.ts

@@ -140,6 +140,32 @@ export declare const NqlFilterUnaryExpressionObj: z.ZodObject<{
     operator: "IS NULL" | "IS NOT NULL";
 }>;
 export type NqlFilterUnaryExpression = z.infer<typeof NqlFilterUnaryExpressionObj>;
+declare const NqlExpressionObj: z.ZodUnion<[z.ZodObject<{
+    field: z.ZodString;
+    table: z.ZodObject<{
+        database: z.ZodEnum<["narrative"]>;
+        table: z.ZodEnum<["rosetta_stone"]>;
+    }, "strip", z.ZodTypeAny, {
+        database: "narrative";
+        table: "rosetta_stone";
+    }, {
+        database: "narrative";
+        table: "rosetta_stone";
+    }>;
+}, "strip", z.ZodTypeAny, {
+    field: string;
+    table: {
+        database: "narrative";
+        table: "rosetta_stone";
+    };
+}, {
+    field: string;
+    table: {
+        database: "narrative";
+        table: "rosetta_stone";
+    };
+}>, z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+export type NqlExpression = z.infer<typeof NqlExpressionObj>;
 export declare const NqlFilterBinaryExpressionObj: z.ZodObject<{
     left: z.ZodUnion<[z.ZodObject<{
         field: z.ZodString;
@@ -724,7 +750,7 @@ export declare const NqlWhereObj: z.ZodEffects<z.ZodObject<{
     })[];
 }>;
 export type NqlWhere = z.infer<typeof NqlWhereObj>;
-export type NqlFilteBinaryExpression = z.infer<typeof NqlFilterBinaryExpressionObj>;
+export type NqlFilterBinaryExpression = z.infer<typeof NqlFilterBinaryExpressionObj>;
 export declare const NqlObj: z.ZodObject<{
     explain: z.ZodOptional<z.ZodEnum<["EXPLAIN"]>>;
     select: z.ZodArray<z.ZodObject<{
@@ -1243,14 +1269,10 @@ export interface NqlResult {
         user_id: number;
     };
     result: {
-        success: {
-            result: {
-                forecast: {
-                    rows: number;
-                    cost: number;
-                };
-            };
-        };
+        type: string;
+        rows: number;
+        cost: number;
+        nql_type: string;
     };
     state: string;
     updated_at: string;
@@ -1260,3 +1282,4 @@ export interface NqlCompileResult {
     sql: string;
     mappingErrors?: NqlMappingErrors;
 }
+export {};

package/build/nql/types.js

@@ -51,11 +51,11 @@ export const NqlFilterUnaryExpressionObj = z.object({
     field: NqlFieldObj,
     operator: z.enum(['IS NULL', 'IS NOT NULL']).describe('The operator to use for the filter.  As a standalone operator it only expects the field to be defined.')
 });
-const NqlExpression = z.union([NqlFieldObj, z.string(), z.number(), z.boolean()]);
+const NqlExpressionObj = z.union([NqlFieldObj, z.string(), z.number(), z.boolean()]);
 export const NqlFilterBinaryExpressionObj = z.object({
-    left: NqlExpression,
+    left: NqlExpressionObj,
     operator: z.enum(['=', '!=', '>', '<', '>=', '<=', 'IN', 'NOT IN', 'LIKE', 'NOT LIKE']).describe('The operator to use for the filter.  As a binary operator it expects both a left and right expression'),
-    right: NqlExpression
+    right: NqlExpressionObj
 });
 export const NqlFilterExpressionObj = z.union([NqlFilterUnaryExpressionObj, NqlFilterBinaryExpressionObj]);
 export const NqlBooleanExpressionObj = z.enum(['AND', 'OR']).describe('The operator to use for the filter.  As a standalone operator it only expects the field to be defined.');

package/package.json

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