@sisense/sdk-query-client 1.13.0 → 1.14.0

package/dist/interfaces.d.ts

@@ -5,6 +5,6 @@ export interface QueryClient {
     executeCsvQuery(params: QueryDescription, config?: QueryExecutionConfig): ExecutingCsvQueryResult;
     executePivotQuery(params: PivotQueryDescription, config?: QueryExecutionConfig): ExecutingPivotQueryResult;
     getDataSourceFields(dataSource: DataSource): Promise<DataSourceField[]>;
-    getDataSourceSchema(datasourceName: string): Promise<DataSourceSchema>;
+    getDataSourceSchema(datasourceName: string): Promise<DataSourceSchema | undefined>;
     getDataSourceList(): Promise<DataSourceMetadata[]>;
 }

package/dist/query-api-dispatcher/query-api-dispatcher.d.ts

@@ -1,25 +1,27 @@
 import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
-import { AbortRequestFunction, DataSourceField, JaqlResponse, JaqlQueryPayload, QueryGuid, DataSourceSchema, DataSourceMetadata } from '../types.js';
-type RequestSendingResult<T> = {
-    responsePromise: Promise<T>;
-    abortHttpRequest: AbortRequestFunction;
-};
+import { DataSourceField, JaqlResponse, JaqlQueryPayload, QueryGuid, DataSourceSchema, DataSourceMetadata } from '../types.js';
 export declare class QueryApiDispatcher {
     private httpClient;
     constructor(httpClient: HttpClient);
-    getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
+    getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[] | undefined>;
     /**
      * Returns a list of data sources.
      * This method works with user of viewer role or above.
      */
-    getDataSourceList(): Promise<DataSourceMetadata[]>;
+    getDataSourceList(): Promise<DataSourceMetadata[] | undefined>;
     /**
      * Returns the schema of a data source by its name.
      */
-    getDataSourceSchema(dataSourceName: string): Promise<DataSourceSchema>;
-    sendJaqlRequest(dataSource: DataSource, jaqlPayload: JaqlQueryPayload): RequestSendingResult<JaqlResponse>;
-    sendDownloadCsvRequest(dataSource: DataSource, jaqlPayload: JaqlQueryPayload): RequestSendingResult<ReadableStream>;
+    getDataSourceSchema(dataSourceName: string): Promise<DataSourceSchema | undefined>;
+    sendJaqlRequest(dataSource: DataSource, jaqlPayload: JaqlQueryPayload): {
+        responsePromise: Promise<JaqlResponse | undefined>;
+        abortHttpRequest: (reason?: string) => void;
+    };
+    sendDownloadCsvRequest(dataSource: DataSource, jaqlPayload: JaqlQueryPayload): {
+        responsePromise: Promise<ReadableStream<any> | undefined>;
+        abortHttpRequest: (reason?: string) => void;
+    };
     /**
      * Sends a request to cancel a JAQL query.
      *
@@ -35,4 +37,3 @@ export declare class QueryApiDispatcher {
      */
     sendCancelMultipleJaqlQueriesRequest(guids: QueryGuid[], dataSource: DataSource): Promise<void>;
 }
-export {};

package/dist/query-api-dispatcher/query-api-dispatcher.js

@@ -15,17 +15,12 @@ export class QueryApiDispatcher {
         this.httpClient = httpClient;
     }
     getDataSourceFields(dataSource, count = 9999, offset = 0) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const dataSourceName = getDataSourceName(dataSource);
-            const url = `${API_DATASOURCES_BASE_PATH}/${encodeURIComponent(dataSourceName)}/fields/search`;
-            // when error is encountered, API returns only status code 400 without informative error message
-            // to remedy, catch error and throw a more informative error message
-            try {
-                return yield this.httpClient.post(url, { offset, count });
-            }
-            catch (error) {
-                throw new Error(`Failed to get fields for data source "${dataSource}". Please make sure the data source exists and is accessible.`);
-            }
+        const dataSourceName = getDataSourceName(dataSource);
+        const url = `${API_DATASOURCES_BASE_PATH}/${encodeURIComponent(dataSourceName)}/fields/search`;
+        // when error is encountered, API returns only status code 400 without informative error message
+        // to remedy, catch error and throw a more informative error message
+        return this.httpClient.post(url, { offset, count }).catch(() => {
+            throw new Error(`Failed to get fields for data source "${dataSource}". Please make sure the data source exists and is accessible.`);
         });
     }
     /**
@@ -33,19 +28,15 @@ export class QueryApiDispatcher {
      * This method works with user of viewer role or above.
      */
     getDataSourceList() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = `${API_DATASOURCES_BASE_PATH}/?sharedWith=r,w`;
-            return this.httpClient.get(url);
-        });
+        const url = `${API_DATASOURCES_BASE_PATH}/?sharedWith=r,w`;
+        return this.httpClient.get(url);
     }
     /**
      * Returns the schema of a data source by its name.
      */
     getDataSourceSchema(dataSourceName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const url = `${API_DATAMODELS_BASE_PATH}/schema?title=${encodeURIComponent(dataSourceName)}`;
-            return this.httpClient.get(url);
-        });
+        const url = `${API_DATAMODELS_BASE_PATH}/schema?title=${encodeURIComponent(dataSourceName)}`;
+        return this.httpClient.get(url);
     }
     sendJaqlRequest(dataSource, jaqlPayload) {
         const url = getJaqlUrl(dataSource);
@@ -115,7 +106,7 @@ export class QueryApiDispatcher {
 /**
  * Returns the URL for canceling queries for a regular (non-live) datasource.
  *
- * @param dataSource
+ * @param dataSource - The data source of the query.
  */
 function getRegularCancelQueryUrl(dataSource) {
     const datasourcePath = encodeURIComponent(getDataSourceName(dataSource));
@@ -125,7 +116,7 @@ function getRegularCancelQueryUrl(dataSource) {
  * Returns the URL for canceling queries for a live datasource.
  * Live datasources require a different URL for canceling queries.
  *
- * @param dataSource
+ * @param dataSource - The data source of the query.
  */
 function getLiveCancelQueryUrl(dataSource) {
     const datasourcePath = encodeURIComponent(getDataSourceName(dataSource));
@@ -134,7 +125,7 @@ function getLiveCancelQueryUrl(dataSource) {
 /**
  * Returns the URL for sending a JAQL request.
  *
- * @param dataSource
+ * @param dataSource - The data source of the query.
  */
 function getJaqlUrl(dataSource) {
     const dataSourcePath = encodeURIComponent(getDataSourceName(dataSource));

package/dist/query-client.d.ts

@@ -1,4 +1,4 @@
-import { DataSourceField, DataSourceMetadata, DataSourceSchema, ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, QueryDescription, QueryExecutionConfig } from './types.js';
+import { ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, QueryDescription, QueryExecutionConfig } from './types.js';
 import { QueryClient } from './interfaces.js';
 import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
@@ -29,15 +29,15 @@ export declare class DimensionalQueryClient implements QueryClient {
      * @throws Error if query description is invalid
      */
     executePivotQuery(pivotQueryDescription: PivotQueryDescription, config?: QueryExecutionConfig): ExecutingPivotQueryResult;
-    getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
+    getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<import("./types.js").DataSourceField[]>;
     /**
      * Returns the schema of a data source by its name.
      */
-    getDataSourceSchema(datasourceName: string): Promise<DataSourceSchema>;
+    getDataSourceSchema(datasourceName: string): Promise<import("./types.js").DataSourceSchema | undefined>;
     /**
      * Returns a list of data sources
      */
-    getDataSourceList(): Promise<DataSourceMetadata[]>;
+    getDataSourceList(): Promise<import("./types.js").DataSourceMetadata[]>;
 }
 /**
  * Validates query description

package/dist/query-client.js

@@ -93,23 +93,23 @@ export class DimensionalQueryClient {
     }
     getDataSourceFields(dataSource, count = 9999, offset = 0) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.queryApi.getDataSourceFields(dataSource, count, offset);
+            const dataSourceFields = yield this.queryApi.getDataSourceFields(dataSource, count, offset);
+            return dataSourceFields || [];
         });
     }
     /**
      * Returns the schema of a data source by its name.
      */
     getDataSourceSchema(datasourceName) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.queryApi.getDataSourceSchema(datasourceName);
-        });
+        return this.queryApi.getDataSourceSchema(datasourceName);
     }
     /**
      * Returns a list of data sources
      */
     getDataSourceList() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.queryApi.getDataSourceList();
+            const dataSourceList = yield this.queryApi.getDataSourceList();
+            return dataSourceList || [];
         });
     }
 }

package/dist/query-task-manager/query-task-manager.d.ts

@@ -37,4 +37,4 @@ export declare class QueryTaskManager extends AbstractTaskManager {
     executeDownloadCsvSending: (passport: QueryTaskPassport) => Promise<import("@sisense/task-manager").TaskExecutionResult<Blob, EmptyObject>>;
     executePivotQuerySending: (passport: PivotQueryTaskPassport) => Promise<import("@sisense/task-manager").TaskExecutionResult<PivotQueryResultData, EmptyObject>>;
 }
-export declare function validateJaqlResponse(jaqlResponse: JaqlResponse): boolean;
+export declare function validateJaqlResponse(jaqlResponse: JaqlResponse | undefined): asserts jaqlResponse is JaqlResponse;

package/dist/query-task-manager/query-task-manager.js

@@ -118,8 +118,10 @@ export class QueryTaskManager extends AbstractTaskManager {
 }
 export function validateJaqlResponse(jaqlResponse) {
     var _a;
+    if (!jaqlResponse) {
+        throw new Error('No jaql response received from the server');
+    }
     if (jaqlResponse.error) {
         throw new Error(`${jaqlResponse.details} ${(_a = jaqlResponse.database) !== null && _a !== void 0 ? _a : ''} ${jaqlResponse.extraDetails ? JSON.stringify(jaqlResponse.extraDetails) : ''}`);
     }
-    return true;
 }

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.13.0",
+  "version": "1.14.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -20,10 +20,10 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^1.13.0",
-    "@sisense/sdk-data": "^1.13.0",
-    "@sisense/sdk-pivot-client": "^1.13.0",
-    "@sisense/sdk-rest-client": "^1.13.0",
+    "@sisense/sdk-common": "^1.14.0",
+    "@sisense/sdk-data": "^1.14.0",
+    "@sisense/sdk-pivot-client": "^1.14.0",
+    "@sisense/sdk-rest-client": "^1.14.0",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "ts-deepmerge": "6.0.2",