@narrative.io/data-collaboration-sdk-ts 0.0.52 → 0.0.54

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 NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression } 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 NqlQueryInput, type NqlResult, type NqlCompileResult, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, 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, NqlCompileResult, NqlQueryInput, NqlResult, NqlWhere, NqlFilterBinaryExpression, NqlBooleanExpression, NqlFilterExpression } from './types';
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -27,5 +27,12 @@ declare class NqlApi extends BaseApi {
      * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL compilation.
      */
     parseNql(nqlQuery: NqlQueryInput): Promise<Plan>;
+    /**
+     * Gets an existing NQL query by it's id
+     *
+     * @param {string} id - The id for the NQL query to return.
+     * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
+     */
+    getNqlByJobId(id: string): Promise<NqlResult>;
 }
-export { NqlApi, type NqlResult, type NqlQueryInput, type NqlCompileResult, type Nql };
+export { NqlApi, type NqlResult, type NqlQueryInput, type NqlCompileResult, type Nql, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression };

package/build/nql/index.js

@@ -42,5 +42,14 @@ class NqlApi extends BaseApi {
         const response = await this.post(`${resourceName}/parse`, nqlQuery);
         return response;
     }
+    /**
+     * Gets an existing NQL query by it's id
+     *
+     * @param {string} id - The id for the NQL query to return.
+     * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
+     */
+    async getNqlByJobId(id) {
+        return await this.get(`${resourceName}/${id}`);
+    }
 }
 export { NqlApi };

package/build/nql/types.d.ts

@@ -724,7 +724,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 +1243,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;

package/package.json

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