@narrative.io/data-collaboration-sdk-ts 2.12.0 → 2.13.0

package/build/nql/index.d.ts

@@ -12,21 +12,21 @@ 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: NqlQueryInput): Promise<NqlResult>;
+    executeNql(payload: 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: NqlQueryInput): Promise<NqlCompileResult>;
+    compileNql(payload: 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<NqlAst>;
+    parseNql(payload: NqlQueryInput): Promise<NqlAst>;
     /**
      * Validates an NQL query and returns an abstract syntax tree (AST) representing a structured form of
      * the query.
@@ -34,7 +34,7 @@ declare class NqlApi extends BaseApi {
      * @param {string} nqlQuery - The NQL query to validate.
      * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL validation.
      */
-    validateNql(nqlQuery: NqlQueryInput): Promise<NqlAst>;
+    validateNql(payload: NqlQueryInput): Promise<NqlAst>;
     /**
      * Gets an existing NQL query by it's id
      *

package/build/nql/index.js

@@ -18,8 +18,8 @@ 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.
      */
-    async executeNql(nqlQuery) {
-        const response = await this.post(`${resourceName}/run`, nqlQuery);
+    async executeNql(payload) {
+        const response = await this.post(`${resourceName}/run`, payload);
         return response;
     }
     /**
@@ -28,8 +28,8 @@ 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.
      */
-    async compileNql(nqlQuery) {
-        const response = await this.post(`${resourceName}/compile`, nqlQuery);
+    async compileNql(payload) {
+        const response = await this.post(`${resourceName}/compile`, payload);
         return response;
     }
     /**
@@ -38,8 +38,8 @@ 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.
      */
-    async parseNql(nqlQuery) {
-        const response = await this.post(`${resourceName}/parse`, nqlQuery);
+    async parseNql(payload) {
+        const response = await this.post(`${resourceName}/parse`, payload);
         return response;
     }
     /**
@@ -49,8 +49,8 @@ class NqlApi extends BaseApi {
      * @param {string} nqlQuery - The NQL query to validate.
      * @returns {Promise<NqlCompileResult>} A promise that resolves with the result of the NQL validation.
      */
-    async validateNql(nqlQuery) {
-        const response = await this.post(`${resourceName}/validate`, nqlQuery);
+    async validateNql(payload) {
+        const response = await this.post(`${resourceName}/validate`, payload);
         return response;
     }
     /**

package/build/nql/types.d.ts

@@ -37,15 +37,18 @@ export type NqlBudget = z.infer<typeof NqlBudgetObj>;
  */
 export declare const NqlQueryInputObj: z.ZodObject<{
     nql: z.ZodString;
+    data_plane_id: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     nql: string;
+    data_plane_id: string | null;
 }, {
     nql: string;
+    data_plane_id: string | null;
 }>;
 /**
  * Type for NqlQueryInput object.  This is the object that is passed to the NQL API
  *
- * @typedef NqlBudget
+ * @typedef NqlQueryInput
  */
 export type NqlQueryInput = z.infer<typeof NqlQueryInputObj>;
 /**

package/build/nql/types.js

@@ -38,6 +38,7 @@ export const NqlQueryInputObj = z.object({
         message: "NQL query cannot contain a JOIN statement.",
     })
         .describe("A NQL query"),
+    data_plane_id: z.string().nullable().describe("Data plane identifier"),
 });
 /**
  * A schema object used to validate and infer the structure of NqlPreSelectExpression.

package/package.json

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