@sisense/sdk-query-client 1.8.0 → 1.10.0

package/dist/interfaces.d.ts

@@ -1,8 +1,10 @@
-import { DataSourceField, ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, QueryDescription, QueryExecutionConfig } from './types.js';
+import { DataSourceField, DataSourceMetadata, DataSourceSchema, ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, 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;
     executePivotQuery(params: PivotQueryDescription, config?: QueryExecutionConfig): ExecutingPivotQueryResult;
     getDataSourceFields(dataSource: DataSource): Promise<DataSourceField[]>;
+    getDataSourceSchema(datasourceName: string): Promise<DataSourceSchema>;
+    getDataSourceList(): Promise<DataSourceMetadata[]>;
 }

package/dist/jaql/get-jaql-query-payload.js

@@ -1,5 +1,3 @@
-/* eslint-disable complexity */
-/* eslint-disable max-lines */
 import { v4 as uuid } from 'uuid';
 import merge from 'ts-deepmerge';
 import { isPivotAttribute, isPivotMeasure, DEFAULT_PIVOT_GRAND_TOTALS, isDataSourceInfo, } from '@sisense/sdk-data';
@@ -64,10 +62,8 @@ export function getPivotJaqlQueryPayload(pivotQueryDescription, shouldSkipHighli
     return queryPayload;
 }
 function jaqlPivotAttribute(a, panel, index, metadataStats) {
-    const jaql = Object.assign(Object.assign({}, (isPivotAttribute(a) ? a.attribute.jaql(true) : a.jaql(true))), (panel === 'rows' &&
-        isPivotAttribute(a) &&
-        a.sort &&
-        preparePivotRowJaqlSortOptions(a.sort, index, metadataStats)));
+    const isSortedRowAttribute = panel === 'rows' && isPivotAttribute(a) && a.sort && a.sort.direction !== 'sortNone';
+    const jaql = Object.assign(Object.assign({}, (isPivotAttribute(a) ? a.attribute.jaql(true) : a.jaql(true))), (isSortedRowAttribute && preparePivotRowJaqlSortOptions(a.sort, index, metadataStats)));
     return Object.assign(Object.assign({ jaql }, (isPivotAttribute(a) && a.includeSubTotals ? { format: { subtotal: true } } : {})), { panel, field: { index: index, id: `${panel}-${index}` } });
 }
 function jaqlPivotMeasure(m, panel, index) {

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

@@ -1,6 +1,6 @@
 import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
-import { AbortRequestFunction, DataSourceField, JaqlResponse, JaqlQueryPayload, QueryGuid, DataSourceSchema } from '../types.js';
+import { AbortRequestFunction, DataSourceField, JaqlResponse, JaqlQueryPayload, QueryGuid, DataSourceSchema, DataSourceMetadata } from '../types.js';
 type RequestSendingResult<T> = {
     responsePromise: Promise<T>;
     abortHttpRequest: AbortRequestFunction;
@@ -9,6 +9,11 @@ export declare class QueryApiDispatcher {
     private httpClient;
     constructor(httpClient: HttpClient);
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
+    /**
+     * Returns a list of data sources.
+     * This method works with user of viewer role or above.
+     */
+    getDataSourceList(): Promise<DataSourceMetadata[]>;
     /**
      * Returns the schema of a data source by its name.
      */

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

@@ -28,6 +28,16 @@ export class QueryApiDispatcher {
             }
         });
     }
+    /**
+     * Returns a list of data sources.
+     * 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);
+        });
+    }
     /**
      * Returns the schema of a data source by its name.
      */
@@ -41,7 +51,17 @@ export class QueryApiDispatcher {
         const url = getJaqlUrl(dataSource);
         const abortController = new AbortController();
         return {
-            responsePromise: this.httpClient.post(url, jaqlPayload, undefined, abortController.signal),
+            responsePromise: this.httpClient
+                .post(url, jaqlPayload, undefined, abortController.signal)
+                .then((response) => {
+                if (Array.isArray(response)) {
+                    return {
+                        values: [],
+                        metadata: [],
+                    };
+                }
+                return response;
+            }),
             abortHttpRequest: (reason) => abortController.abort(reason),
         };
     }
@@ -80,7 +100,7 @@ export class QueryApiDispatcher {
                 yield this.httpClient.post(regularUrl, payload);
             }
             catch (error) {
-                if (error.status === 404) {
+                if (error.status === '404') {
                     // probably this datasource is live and requires a different URL for canceling queries
                     const liveUrl = getLiveCancelQueryUrl(dataSource);
                     yield this.httpClient.post(liveUrl, payload);

package/dist/query-client.d.ts

@@ -1,6 +1,6 @@
-import { DataSourceField, ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, QueryDescription, QueryExecutionConfig } from './types.js';
+import { DataSourceField, DataSourceMetadata, DataSourceSchema, ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, QueryDescription, QueryExecutionConfig } from './types.js';
 import { QueryClient } from './interfaces.js';
-import { DataSourceInfo, DataSource } from '@sisense/sdk-data';
+import { DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { PivotClient } from '@sisense/sdk-pivot-client';
 /** @internal */
@@ -31,9 +31,13 @@ export declare class DimensionalQueryClient implements QueryClient {
     executePivotQuery(pivotQueryDescription: PivotQueryDescription, config?: QueryExecutionConfig): ExecutingPivotQueryResult;
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
     /**
-     * Get info about data source
+     * Returns the schema of a data source by its name.
      */
-    getDataSourceInfo(datasourceName: string): Promise<DataSourceInfo>;
+    getDataSourceSchema(datasourceName: string): Promise<DataSourceSchema>;
+    /**
+     * Returns a list of data sources
+     */
+    getDataSourceList(): Promise<DataSourceMetadata[]>;
 }
 /**
  * Validates query description

package/dist/query-client.js

@@ -97,15 +97,19 @@ export class DimensionalQueryClient {
         });
     }
     /**
-     * Get info about data source
+     * Returns the schema of a data source by its name.
      */
-    getDataSourceInfo(datasourceName) {
+    getDataSourceSchema(datasourceName) {
         return __awaiter(this, void 0, void 0, function* () {
-            const completeDataSourceSchema = yield this.queryApi.getDataSourceSchema(datasourceName);
-            return {
-                title: completeDataSourceSchema.title,
-                type: completeDataSourceSchema.type === 'extract' ? 'elasticube' : 'live',
-            };
+            return this.queryApi.getDataSourceSchema(datasourceName);
+        });
+    }
+    /**
+     * Returns a list of data sources
+     */
+    getDataSourceList() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.queryApi.getDataSourceList();
         });
     }
 }

package/dist/translation/translatable-error.d.ts

@@ -2,4 +2,5 @@ import { AbstractTranslatableError } from '@sisense/sdk-common';
 import { PACKAGE_NAMESPACE } from './resources/index.js';
 export declare class TranslatableError extends AbstractTranslatableError<typeof PACKAGE_NAMESPACE> {
     constructor(translationKey: string, interpolationOptions?: Record<string, string>);
+    get status(): string;
 }

package/dist/translation/translatable-error.js

@@ -8,4 +8,7 @@ export class TranslatableError extends AbstractTranslatableError {
             interpolationOptions: interpolationOptions,
         }, i18nextInstance.t);
     }
+    get status() {
+        return this.interpolationOptions.status;
+    }
 }

package/dist/types.d.ts

@@ -201,6 +201,10 @@ export type DataSourceSchema = {
     title: string;
     type: 'extract' | 'live';
 } & AnyObject;
+export type DataSourceMetadata = {
+    title: string;
+    live: boolean;
+};
 export type AbortRequestFunction = (reason?: string) => void;
 export type QueryGuid = string;
 export {};

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.8.0",
+  "version": "1.10.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.8.0",
-    "@sisense/sdk-data": "^1.8.0",
-    "@sisense/sdk-pivot-client": "^1.8.0",
-    "@sisense/sdk-rest-client": "^1.8.0",
+    "@sisense/sdk-common": "^1.10.0",
+    "@sisense/sdk-data": "^1.10.0",
+    "@sisense/sdk-pivot-client": "^1.10.0",
+    "@sisense/sdk-rest-client": "^1.10.0",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "ts-deepmerge": "6.0.2",