@narrative.io/data-collaboration-sdk-ts 0.0.38 → 0.0.40

package/build/index.d.ts

@@ -16,9 +16,9 @@ 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 NqlQuery, type NqlResult } from './nql';
+import { NqlApi, type NqlCompileResult, type NqlQuery, type NqlResult } from './nql';
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, 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 NqlQuery, type NqlResult };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, 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 NqlQuery, type NqlResult, type NqlCompileResult };

package/build/installations/index.js

@@ -12,8 +12,9 @@ class InstallationsApi extends BaseApi {
      * @returns {Promise<ApiRecords<Installation>>} - Promise resolving with the list of installations.
      */
     async getInstallations(appCategory) {
-        const appCategoryQuery = `?app_category=${appCategory ?? ''}`;
-        return await this.get(`${resourceName}${appCategoryQuery}`);
+        const appCategoryQuery = appCategory !== undefined ? `?app_category=${appCategory}` : '';
+        const url = `${resourceName}${appCategoryQuery}`;
+        return await this.get(url);
     }
 }
 export { InstallationsApi };

package/build/nql/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from '../base-api';
-import { type NqlQuery, type NqlResult } from './types';
+import type { NqlCompileResult, NqlQuery, NqlResult } from './types';
 /**
  * A class for accessing the NQL API.
  * @extends BaseApi
@@ -9,8 +9,15 @@ declare class NqlApi extends BaseApi {
      * Executes an NQL query and returns the result.
      *
      * @param {string} nqlQuery - The NQL query to execute.
-     * @returns {Promise<object>} A promise that resolves with the result of the NQL query.
+     * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
      */
     executeNql(nqlQuery: NqlQuery): 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>;
 }
-export { NqlApi, type NqlResult, type NqlQuery };
+export { NqlApi, type NqlResult, type NqlQuery, type NqlCompileResult };

package/build/nql/index.js

@@ -16,10 +16,20 @@ class NqlApi extends BaseApi {
      * Executes an NQL query and returns the result.
      *
      * @param {string} nqlQuery - The NQL query to execute.
-     * @returns {Promise<object>} A promise that resolves with the result of the NQL query.
+     * @returns {Promise<NqlResult>} A promise that resolves with the result of the NQL query.
      */
     async executeNql(nqlQuery) {
-        const response = await this.post(resourceName, nqlQuery);
+        const response = await this.post(`${resourceName}/run`, 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 compileNql(nqlQuery) {
+        const response = await this.post(`${resourceName}/compile`, nqlQuery);
         return response;
     }
 }

package/build/nql/types.d.ts

@@ -26,6 +26,11 @@ export interface NqlResult {
     state: string;
     updated_at: string;
 }
+export type NqlMappingErrors = Record<number, string>;
+export interface NqlCompileResult {
+    sql: string;
+    mappingErrors?: NqlMappingErrors;
+}
 export interface NqlQuery {
     nql: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.38",
+  "version": "0.0.40",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -25,7 +25,7 @@
     "@babel/preset-typescript": "^7.18.6",
     "@commitlint/cli": "^17.4.2",
     "@commitlint/config-conventional": "^17.4.2",
-    "@types/jest": "^29.4.0",
+    "@types/jest": "^29.5.0",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "babel-jest": "^29.4.3",
     "eslint": "^8.33.0",
@@ -33,10 +33,10 @@
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-promise": "^6.1.1",
+    "husky": "^8.0.0",
     "jest": "^29.4.3",
     "ts-jest": "^29.0.5",
-    "typescript": "^5.0.2",
-    "husky": "^8.0.0"
+    "typescript": "^5.0.2"
   },
   "dependencies": {
     "mande": "^2.0.3"