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

package/build/nql/index.d.ts

@@ -1,5 +1,6 @@
 import { BaseApi } from '../base-api';
-import type { NqlCompileResult, NqlQuery, NqlResult } from './types';
+import type { Plan } from './SubstraitParser';
+import type { Nql, NqlCompileResult, NqlQueryInput, NqlResult } from './types';
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -11,13 +12,27 @@ declare class NqlApi extends BaseApi {
      * @param {string} nqlQuery - The NQL query to execute.
      * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
      */
-    executeNql(nqlQuery: NqlQuery): Promise<NqlResult>;
+    executeNql(nqlQuery: NqlQueryInput): Promise<NqlResult>;
     /**
      * Compiles an NQL query and returns the result, including any errors.
      *
      * @param {string} nqlQuery - The NQL query to compile.
      * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL compilation.
      */
-    compileNql(nqlQuery: NqlQuery): Promise<NqlCompileResult>;
+    compileNql(nqlQuery: NqlQueryInput): Promise<NqlCompileResult>;
+    /**
+     * Compiles an NQL query and returns the result, including any errors.
+     *
+     * @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>;
+    /**
+     * 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 NqlQuery, type NqlCompileResult };
+export { NqlApi, type NqlResult, type NqlQueryInput, type NqlCompileResult, type Nql };

package/build/nql/index.js

@@ -32,5 +32,24 @@ class NqlApi extends BaseApi {
         const response = await this.post(`${resourceName}/compile`, nqlQuery);
         return response;
     }
+    /**
+     * Compiles an NQL query and returns the result, including any errors.
+     *
+     * @param {string} nqlQuery - The NQL query to compile.
+     * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL compilation.
+     */
+    async parseNql(nqlQuery) {
+        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 };