@sisense/sdk-query-client 0.14.0 → 0.16.0

package/dist/interfaces.d.ts

@@ -1,6 +1,7 @@
-import { DataSourceField, ExecutingQueryResult, QueryDescription, QueryExecutionConfig } from './types.js';
+import { DataSourceField, ExecutingCsvQueryResult, ExecutingQueryResult, QueryDescription, QueryExecutionConfig } from './types.js';
 import { DataSource } from '@sisense/sdk-data';
 export interface QueryClient {
     executeQuery(params: QueryDescription, config?: QueryExecutionConfig): ExecutingQueryResult;
+    executeCsvQuery(params: QueryDescription, config?: QueryExecutionConfig): ExecutingCsvQueryResult;
     getDataSourceFields(dataSource: DataSource): Promise<DataSourceField[]>;
 }

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

@@ -10,6 +10,7 @@ export declare class QueryApiDispatcher {
     constructor(httpClient: HttpClient);
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
     sendJaqlRequest(dataSource: DataSource, jaqlPayload: JaqlQueryPayload): RequestSendingResult<JaqlResponse>;
+    sendDownloadCsvRequest(dataSource: DataSource, jaqlPayload: JaqlQueryPayload): RequestSendingResult<ReadableStream>;
     /**
      * Sends a request to cancel a JAQL query.
      *

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

@@ -33,6 +33,16 @@ export class QueryApiDispatcher {
             abortHttpRequest: (reason) => abortController.abort(reason),
         };
     }
+    sendDownloadCsvRequest(dataSource, jaqlPayload) {
+        const url = getDownloadCsvUrl(dataSource);
+        const abortController = new AbortController();
+        const params = new URLSearchParams();
+        params.append('data', encodeURIComponent(JSON.stringify(jaqlPayload)));
+        return {
+            responsePromise: this.httpClient.post(url, params, { headers: { 'Content-Type': 'application/x-www-form-urlencoded' } }, abortController.signal, { nonJSONBody: true, returnBlob: true }),
+            abortHttpRequest: (reason) => abortController.abort(reason),
+        };
+    }
     /**
      * Sends a request to cancel a JAQL query.
      *
@@ -77,7 +87,7 @@ export class QueryApiDispatcher {
  */
 function getRegularCancelQueryUrl(dataSource) {
     const datasourcePath = encodeURIComponent(dataSource);
-    return `${API_DATASOURCES_BASE_PATH}/${datasourcePath}/cancel_queries`;
+    return `${API_DATASOURCES_BASE_PATH}/localhost/${datasourcePath}/cancel_queries`;
 }
 /**
  * Returns the URL for canceling queries for a live datasource.
@@ -98,3 +108,11 @@ function getJaqlUrl(dataSource) {
     const dataSourcePath = encodeURIComponent(dataSource);
     return `${API_DATASOURCES_BASE_PATH}/${dataSourcePath}/jaql`;
 }
+/**
+ * Returns the URL for sending a Download CSV request.
+ *
+ * @param dataSource - The data source of the query.
+ */
+function getDownloadCsvUrl(dataSource) {
+    return `${getJaqlUrl(dataSource)}/csv`;
+}

package/dist/query-client.d.ts

@@ -1,4 +1,4 @@
-import { DataSourceField, ExecutingQueryResult, QueryDescription, QueryExecutionConfig } from './types.js';
+import { DataSourceField, ExecutingCsvQueryResult, ExecutingQueryResult, QueryDescription, QueryExecutionConfig } from './types.js';
 import { QueryClient } from './interfaces.js';
 import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
@@ -17,6 +17,7 @@ export declare class DimensionalQueryClient implements QueryClient {
      * @throws Error if query description is invalid
      */
     executeQuery(queryDescription: QueryDescription, config?: QueryExecutionConfig): ExecutingQueryResult;
+    executeCsvQuery(queryDescription: QueryDescription, config?: QueryExecutionConfig): ExecutingCsvQueryResult;
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
 }
 /**
@@ -25,4 +26,6 @@ export declare class DimensionalQueryClient implements QueryClient {
  * @param queryDescription - query description to validate
  * @throws Error if query description is invalid
  */
-export declare function validateQueryDescription(queryDescription: QueryDescription): void;
+export declare function validateQueryDescription(queryDescription: QueryDescription, config?: {
+    ignoreQueryLimit?: boolean;
+}): void;

package/dist/query-client.js

@@ -46,6 +46,23 @@ export class DimensionalQueryClient {
             cancel: (reason) => this.taskManager.cancel(taskPassport.taskId, reason || 'Unspecified reason'),
         };
     }
+    executeCsvQuery(queryDescription, config) {
+        validateQueryDescription(queryDescription, { ignoreQueryLimit: true });
+        const taskPassport = new QueryTaskPassport('SEND_DOWNLOAD_CSV_QUERY', queryDescription, Object.assign(Object.assign({}, (config ? config : {})), { shouldSkipHighlightsWithoutAttributes: this.shouldSkipHighlightsWithoutAttributes || false }));
+        return {
+            resultPromise: new Promise((resolve, reject) => {
+                void this.taskManager.executeDownloadCsvSending(taskPassport).then((executionResult) => {
+                    if (executionResult.status === ExecutionResultStatus.SUCCESS) {
+                        resolve(executionResult.result);
+                    }
+                    else {
+                        reject(executionResult.error);
+                    }
+                });
+            }),
+            cancel: (reason) => this.taskManager.cancel(taskPassport.taskId, reason || 'Unspecified reason'),
+        };
+    }
     getDataSourceFields(dataSource, count = 9999, offset = 0) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.queryApi.getDataSourceFields(dataSource, count, offset);
@@ -58,12 +75,12 @@ export class DimensionalQueryClient {
  * @param queryDescription - query description to validate
  * @throws Error if query description is invalid
  */
-export function validateQueryDescription(queryDescription) {
+export function validateQueryDescription(queryDescription, config) {
     const { attributes, measures, filters, highlights, count, offset } = queryDescription;
     if (count && count < 0) {
         throw new TranslatableError('errors.invalidCountNegative', { count: count.toString() });
     }
-    if (count && count > QUERY_DEFAULT_LIMIT) {
+    if (!(config === null || config === void 0 ? void 0 : config.ignoreQueryLimit) && count && count > QUERY_DEFAULT_LIMIT) {
         throw new TranslatableError('errors.invalidCountLimit', {
             count: count.toString(),
             limit: QUERY_DEFAULT_LIMIT.toString(),

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

@@ -10,7 +10,9 @@ export declare class QueryTaskManager extends AbstractTaskManager {
     constructor(queryApi: QueryApiDispatcher);
     private prepareJaqlPayload;
     private sendJaqlQuery;
-    private cancelJaqlQuery;
+    private sendCsvQuery;
+    private cancelDataRetrievalQuery;
     executeQuerySending: (passport: QueryTaskPassport) => Promise<import("@sisense/task-manager").TaskExecutionResult<QueryResultData, EmptyObject>>;
+    executeDownloadCsvSending: (passport: QueryTaskPassport) => Promise<import("@sisense/task-manager").TaskExecutionResult<Blob, EmptyObject>>;
 }
 export declare function validateJaqlResponse(jaqlResponse: JaqlResponse): boolean;

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

@@ -17,7 +17,11 @@ export class QueryTaskManager extends AbstractTaskManager {
         this.sentRequestsAbortersMap = new Map();
         this.executeQuerySending = super.createFlow([
             new Step('PREPARE_JAQL_PAYLOAD', this.prepareJaqlPayload.bind(this), () => __awaiter(this, void 0, void 0, function* () { })),
-            new Step('SEND_JAQL_QUERY', this.sendJaqlQuery.bind(this), this.cancelJaqlQuery.bind(this)),
+            new Step('SEND_JAQL_QUERY', this.sendJaqlQuery.bind(this), this.cancelDataRetrievalQuery.bind(this)),
+        ]);
+        this.executeDownloadCsvSending = super.createFlow([
+            new Step('PREPARE_JAQL_PAYLOAD', this.prepareJaqlPayload.bind(this), () => __awaiter(this, void 0, void 0, function* () { })),
+            new Step('SEND_DOWNLOAD_CSV_QUERY', this.sendCsvQuery.bind(this), this.cancelDataRetrievalQuery.bind(this)),
         ]);
         this.queryApi = queryApi;
     }
@@ -49,7 +53,17 @@ export class QueryTaskManager extends AbstractTaskManager {
             return getDataFromQueryResult(jaqlResponse, [...metadata, ...extraColumns]);
         });
     }
-    cancelJaqlQuery(task) {
+    sendCsvQuery(task, jaqlPayload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { taskId } = task.passport;
+            const { responsePromise, abortHttpRequest } = this.queryApi.sendDownloadCsvRequest(task.passport.queryDescription.dataSource, jaqlPayload);
+            this.sentRequestsAbortersMap.set(taskId, abortHttpRequest);
+            return responsePromise.finally(() => {
+                this.sentRequestsAbortersMap.delete(taskId);
+            });
+        });
+    }
+    cancelDataRetrievalQuery(task) {
         const taskId = task.passport.taskId;
         const abortInitialRequest = this.sentRequestsAbortersMap.get(taskId);
         if (abortInitialRequest) {

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

@@ -1,6 +1,6 @@
 import { TaskPassport } from '@sisense/task-manager';
 import { QueryDescription, QueryExecutionConfigInternal } from '../types.js';
-type TaskType = 'SEND_JAQL_QUERY';
+type TaskType = 'SEND_JAQL_QUERY' | 'SEND_DOWNLOAD_CSV_QUERY';
 export declare class QueryTaskPassport extends TaskPassport {
     queryDescription: QueryDescription;
     executionConfig: QueryExecutionConfigInternal;

package/dist/types.d.ts

@@ -32,6 +32,10 @@ export type ExecutingQueryResult = {
     resultPromise: Promise<QueryResultData>;
     cancel: (reason?: string) => Promise<void>;
 };
+export type ExecutingCsvQueryResult = {
+    resultPromise: Promise<Blob>;
+    cancel: (reason?: string) => Promise<void>;
+};
 export type MetadataItem = {
     measure?: MetadataItemJaql;
     jaql: MetadataItemJaql;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-query-client",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -9,9 +9,9 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^0.14.0",
-    "@sisense/sdk-data": "^0.14.0",
-    "@sisense/sdk-rest-client": "^0.14.0",
+    "@sisense/sdk-common": "^0.16.0",
+    "@sisense/sdk-data": "^0.16.0",
+    "@sisense/sdk-rest-client": "^0.16.0",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "uuid": "^9.0.0"