@sisense/sdk-query-client 0.12.0 → 0.13.0

package/dist/interfaces.d.ts

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

package/dist/query-client.d.ts

@@ -1,4 +1,4 @@
-import { DataSourceField, ExecutingQueryResult, QueryDescription } from './types.js';
+import { DataSourceField, ExecutingQueryResult, QueryDescription, QueryExecutionConfig } from './types.js';
 import { QueryClient } from './interfaces.js';
 import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
@@ -16,7 +16,7 @@ export declare class DimensionalQueryClient implements QueryClient {
      * @returns promise that resolves to query result data and cancel function that can be used to cancel sent query
      * @throws Error if query description is invalid
      */
-    executeQuery(queryDescription: QueryDescription): ExecutingQueryResult;
+    executeQuery(queryDescription: QueryDescription, config?: QueryExecutionConfig): ExecutingQueryResult;
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
 }
 /**

package/dist/query-client.js

@@ -29,9 +29,9 @@ export class DimensionalQueryClient {
      * @returns promise that resolves to query result data and cancel function that can be used to cancel sent query
      * @throws Error if query description is invalid
      */
-    executeQuery(queryDescription) {
+    executeQuery(queryDescription, config) {
         validateQueryDescription(queryDescription);
-        const taskPassport = new QueryTaskPassport('SEND_JAQL_QUERY', queryDescription, this.shouldSkipHighlightsWithoutAttributes);
+        const taskPassport = new QueryTaskPassport('SEND_JAQL_QUERY', queryDescription, Object.assign(Object.assign({}, (config ? config : {})), { shouldSkipHighlightsWithoutAttributes: this.shouldSkipHighlightsWithoutAttributes || false }));
         return {
             resultPromise: new Promise((resolve, reject) => {
                 void this.taskManager.executeQuerySending(taskPassport).then((executionResult) => {

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

@@ -8,6 +8,7 @@ export declare class QueryTaskManager extends AbstractTaskManager {
     private sentRequestsAbortersMap;
     private queryApi;
     constructor(queryApi: QueryApiDispatcher);
+    private prepareJaqlPayload;
     private sendJaqlQuery;
     private cancelJaqlQuery;
     executeQuerySending: (passport: QueryTaskPassport) => Promise<import("@sisense/task-manager").TaskExecutionResult<QueryResultData, EmptyObject>>;

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

@@ -16,16 +16,26 @@ export class QueryTaskManager extends AbstractTaskManager {
         /** Map of aborters by task id to be able to cancel sent requests */
         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)),
         ]);
         this.queryApi = queryApi;
     }
-    sendJaqlQuery(task) {
+    prepareJaqlPayload(task) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { queryDescription, shouldSkipHighlightsWithoutAttributes } = task.passport;
-            const jaqlPayload = getJaqlQueryPayload(queryDescription, shouldSkipHighlightsWithoutAttributes);
+            const { queryDescription, executionConfig } = task.passport;
+            const jaqlPayload = getJaqlQueryPayload(queryDescription, executionConfig.shouldSkipHighlightsWithoutAttributes);
+            const onBeforeQuery = task.passport.executionConfig.onBeforeQuery;
+            if (onBeforeQuery) {
+                return onBeforeQuery(jaqlPayload);
+            }
+            return jaqlPayload;
+        });
+    }
+    sendJaqlQuery(task, jaqlPayload) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { queryDescription, taskId } = task.passport;
             const { responsePromise, abortHttpRequest } = this.queryApi.sendJaqlRequest(task.passport.queryDescription.dataSource, jaqlPayload);
-            const taskId = task.passport.taskId;
             this.sentRequestsAbortersMap.set(taskId, abortHttpRequest);
             const jaqlResponse = yield responsePromise.finally(() => {
                 this.sentRequestsAbortersMap.delete(taskId);

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

@@ -1,10 +1,10 @@
 import { TaskPassport } from '@sisense/task-manager';
-import { QueryDescription } from '../types.js';
+import { QueryDescription, QueryExecutionConfigInternal } from '../types.js';
 type TaskType = 'SEND_JAQL_QUERY';
 export declare class QueryTaskPassport extends TaskPassport {
     queryDescription: QueryDescription;
-    shouldSkipHighlightsWithoutAttributes: boolean;
+    executionConfig: QueryExecutionConfigInternal;
     type: TaskType;
-    constructor(type: TaskType, queryDescription: QueryDescription, shouldSkipHighlightsWithoutAttributes?: boolean);
+    constructor(type: TaskType, queryDescription: QueryDescription, executionConfig: QueryExecutionConfigInternal);
 }
 export {};

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

@@ -1,9 +1,9 @@
 import { TaskPassport } from '@sisense/task-manager';
 export class QueryTaskPassport extends TaskPassport {
-    constructor(type, queryDescription, shouldSkipHighlightsWithoutAttributes) {
+    constructor(type, queryDescription, executionConfig) {
         super();
         this.queryDescription = queryDescription;
         this.type = type;
-        this.shouldSkipHighlightsWithoutAttributes = shouldSkipHighlightsWithoutAttributes !== null && shouldSkipHighlightsWithoutAttributes !== void 0 ? shouldSkipHighlightsWithoutAttributes : false;
+        this.executionConfig = executionConfig;
     }
 }

package/dist/types.d.ts

@@ -11,6 +11,18 @@ export type QueryDescription = {
     count?: number;
     offset?: number;
 };
+/**
+ * Additional configuration for query execution.
+ */
+export type QueryExecutionConfig = {
+    /**
+     * Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
+     */
+    onBeforeQuery?: (jaql: JaqlQueryPayload) => JaqlQueryPayload | Promise<JaqlQueryPayload>;
+};
+export type QueryExecutionConfigInternal = QueryExecutionConfig & {
+    shouldSkipHighlightsWithoutAttributes: boolean;
+};
 export type QueryOptions = {
     datasource: string;
     by: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-query-client",
-  "version": "0.12.0",
+  "version": "0.13.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.12.0",
-    "@sisense/sdk-data": "^0.12.0",
-    "@sisense/sdk-rest-client": "^0.12.0",
+    "@sisense/sdk-common": "^0.13.0",
+    "@sisense/sdk-data": "^0.13.0",
+    "@sisense/sdk-rest-client": "^0.13.0",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "uuid": "^9.0.0"