@sisense/sdk-query-client 1.4.1 → 1.6.0

package/dist/helpers/utility-types.d.ts

@@ -0,0 +1,2 @@
+export type AnyObject = Record<string, unknown>;
+export type EmptyObject = Record<string, never>;

package/dist/helpers/utility-types.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import './translation/initialize-i18n.js';
 export { DimensionalQueryClient } from './query-client.js';
+export { getJaqlQueryPayload } from './jaql/get-jaql-query-payload.js';
 export * from './types.js';
 export * from './interfaces.js';

package/dist/index.js

@@ -1,4 +1,5 @@
 import './translation/initialize-i18n.js';
 export { DimensionalQueryClient } from './query-client.js';
+export { getJaqlQueryPayload } from './jaql/get-jaql-query-payload.js';
 export * from './types.js';
 export * from './interfaces.js';

package/dist/jaql/get-jaql-query-payload.d.ts

@@ -1,4 +1,7 @@
 import { JaqlQueryPayload, QueryDescription, PivotQueryDescription } from '../types.js';
+/**
+ * @internal
+ */
 export declare function getJaqlQueryPayload(queryDescription: QueryDescription, shouldSkipHighlightsWithoutAttributes: boolean): JaqlQueryPayload;
 /**
  * Converts a pivot query description to a JAQL query payload.

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

@@ -2,9 +2,12 @@
 /* eslint-disable max-lines */
 import { v4 as uuid } from 'uuid';
 import merge from 'ts-deepmerge';
-import { isPivotAttribute, isPivotMeasure, DEFAULT_PIVOT_GRAND_TOTALS, } from '@sisense/sdk-data';
+import { isPivotAttribute, isPivotMeasure, DEFAULT_PIVOT_GRAND_TOTALS, isDataSourceInfo, } from '@sisense/sdk-data';
 import { applyHighlightFilters, matchHighlightsWithAttributes } from './metadata/highlights.js';
 const JAQL_BY_CSDK = 'ComposeSDK';
+/**
+ * @internal
+ */
 export function getJaqlQueryPayload(queryDescription, shouldSkipHighlightsWithoutAttributes) {
     const { attributes, measures, filters, filterRelations, highlights, dataSource, count, offset } = queryDescription;
     const queryPayload = Object.assign({ metadata: prepareQueryMetadata({ attributes, measures, filters, filterRelations, highlights }, shouldSkipHighlightsWithoutAttributes) }, prepareQueryOptions(dataSource, count, offset));
@@ -42,7 +45,7 @@ function prepareQueryMetadata(metadataDescription, shouldSkipHighlightsWithoutAt
     return [...attributesMetadata, ...measuresMetadata, ...filtersMetadata];
 }
 function prepareQueryOptions(dataSource, count, offset) {
-    return Object.assign(Object.assign({ datasource: dataSource, by: JAQL_BY_CSDK, queryGuid: uuid() }, (count ? { count } : {})), (offset ? { offset } : {}));
+    return Object.assign(Object.assign({ datasource: getJaqlDataSource(dataSource), by: JAQL_BY_CSDK, queryGuid: uuid() }, (count ? { count } : {})), (offset ? { offset } : {}));
 }
 /**
  * Converts a pivot query description to a JAQL query payload.
@@ -101,5 +104,16 @@ function preparePivotQueryMetadata(pivotMetadataDescription, shouldSkipHighlight
  * @param offset
  */
 function preparePivotQueryOptions(dataSource, grandTotals, count, offset) {
-    return Object.assign(Object.assign(Object.assign({ datasource: dataSource, by: JAQL_BY_CSDK, queryGuid: uuid(), dashboard: JAQL_BY_CSDK, widget: JAQL_BY_CSDK, format: 'pivot' }, (count ? { count } : {})), (offset ? { offset } : {})), { grandTotals: Object.assign(Object.assign({}, DEFAULT_PIVOT_GRAND_TOTALS), grandTotals) });
+    return Object.assign(Object.assign(Object.assign({ datasource: getJaqlDataSource(dataSource), by: JAQL_BY_CSDK, queryGuid: uuid(), dashboard: JAQL_BY_CSDK, widget: JAQL_BY_CSDK, format: 'pivot' }, (count ? { count } : {})), (offset ? { offset } : {})), { grandTotals: Object.assign(Object.assign({}, DEFAULT_PIVOT_GRAND_TOTALS), grandTotals) });
+}
+/**
+ * Converts a DataSource to a description of data source used in JAQL.
+ */
+function getJaqlDataSource(dataSource) {
+    return isDataSourceInfo(dataSource)
+        ? {
+            title: dataSource.title,
+            live: dataSource.type === 'live',
+        }
+        : dataSource;
 }

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 } from '../types.js';
+import { AbortRequestFunction, DataSourceField, JaqlResponse, JaqlQueryPayload, QueryGuid, DataSourceSchema } from '../types.js';
 type RequestSendingResult<T> = {
     responsePromise: Promise<T>;
     abortHttpRequest: AbortRequestFunction;
@@ -9,6 +9,10 @@ export declare class QueryApiDispatcher {
     private httpClient;
     constructor(httpClient: HttpClient);
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
+    /**
+     * 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>;
     /**

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

@@ -7,14 +7,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { getDataSourceName } from '@sisense/sdk-data';
 const API_DATASOURCES_BASE_PATH = 'api/datasources';
+const API_DATAMODELS_BASE_PATH = 'api/v2/datamodels';
 export class QueryApiDispatcher {
     constructor(httpClient) {
         this.httpClient = httpClient;
     }
     getDataSourceFields(dataSource, count = 9999, offset = 0) {
         return __awaiter(this, void 0, void 0, function* () {
-            const url = `${API_DATASOURCES_BASE_PATH}/${encodeURIComponent(dataSource)}/fields/search`;
+            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 {
@@ -25,6 +28,15 @@ export class QueryApiDispatcher {
             }
         });
     }
+    /**
+     * 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);
+        });
+    }
     sendJaqlRequest(dataSource, jaqlPayload) {
         const url = getJaqlUrl(dataSource);
         const abortController = new AbortController();
@@ -86,7 +98,7 @@ export class QueryApiDispatcher {
  * @param dataSource
  */
 function getRegularCancelQueryUrl(dataSource) {
-    const datasourcePath = encodeURIComponent(dataSource);
+    const datasourcePath = encodeURIComponent(getDataSourceName(dataSource));
     return `${API_DATASOURCES_BASE_PATH}/localhost/${datasourcePath}/cancel_queries`;
 }
 /**
@@ -96,7 +108,7 @@ function getRegularCancelQueryUrl(dataSource) {
  * @param dataSource
  */
 function getLiveCancelQueryUrl(dataSource) {
-    const datasourcePath = encodeURIComponent(dataSource);
+    const datasourcePath = encodeURIComponent(getDataSourceName(dataSource));
     return `${API_DATASOURCES_BASE_PATH}/live/${datasourcePath}/cancel_queries`;
 }
 /**
@@ -105,7 +117,7 @@ function getLiveCancelQueryUrl(dataSource) {
  * @param dataSource
  */
 function getJaqlUrl(dataSource) {
-    const dataSourcePath = encodeURIComponent(dataSource);
+    const dataSourcePath = encodeURIComponent(getDataSourceName(dataSource));
     return `${API_DATASOURCES_BASE_PATH}/${dataSourcePath}/jaql`;
 }
 /**

package/dist/query-client.d.ts

@@ -1,6 +1,6 @@
 import { DataSourceField, ExecutingCsvQueryResult, ExecutingPivotQueryResult, ExecutingQueryResult, PivotQueryDescription, QueryDescription, QueryExecutionConfig } from './types.js';
 import { QueryClient } from './interfaces.js';
-import { DataSource } from '@sisense/sdk-data';
+import { DataSourceInfo, DataSource } from '@sisense/sdk-data';
 import { HttpClient } from '@sisense/sdk-rest-client';
 import { PivotClient } from '@sisense/sdk-pivot-client';
 /** @internal */
@@ -30,6 +30,10 @@ 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
+     */
+    getDataSourceInfo(datasourceName: string): Promise<DataSourceInfo>;
 }
 /**
  * Validates query description

package/dist/query-client.js

@@ -96,6 +96,18 @@ export class DimensionalQueryClient {
             return this.queryApi.getDataSourceFields(dataSource, count, offset);
         });
     }
+    /**
+     * Get info about data source
+     */
+    getDataSourceInfo(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',
+            };
+        });
+    }
 }
 /**
  * Validates query description

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

@@ -1,9 +1,10 @@
 import { AbstractTaskManager } from '@sisense/task-manager';
-import { EmptyObject, JaqlResponse } from '../types.js';
+import { JaqlResponse } from '../types.js';
 import { PivotQueryTaskPassport, QueryTaskPassport } from './query-task-passport.js';
 import { QueryResultData, PivotQueryResultData } from '@sisense/sdk-data';
 import { QueryApiDispatcher } from '../query-api-dispatcher/query-api-dispatcher.js';
 import { PivotClient } from '@sisense/sdk-pivot-client';
+import { EmptyObject } from '../helpers/utility-types.js';
 export declare class QueryTaskManager extends AbstractTaskManager {
     /** Map of aborters by task id to be able to cancel sent requests */
     private sentRequestsAbortersMap;

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import { Filter, Measure, Attribute, Cell, QueryResultData, DataSource, PivotAttribute, PivotMeasure, PivotQueryResultData, PivotGrandTotals, FilterRelationsJaql } from '@sisense/sdk-data';
+import { AnyObject } from './helpers/utility-types.js';
 /**
  * All the properties that fully describe a query you want to send.
  */
@@ -39,8 +40,15 @@ export type QueryExecutionConfig = {
 export type QueryExecutionConfigInternal = QueryExecutionConfig & {
     shouldSkipHighlightsWithoutAttributes: boolean;
 };
+/**
+ * Data source description used in JAQL.
+ */
+export type JaqlDataSource = string | {
+    title: string;
+    live: boolean;
+};
 export type QueryOptions = {
-    datasource: string;
+    datasource: JaqlDataSource;
     by: string;
     queryGuid: string;
     dashboard?: string;
@@ -102,6 +110,10 @@ export type MetadataItem = {
 };
 export type MetadataItemJaql = {
     dim?: string;
+    agg?: string;
+    datatype?: string;
+    table?: string;
+    column?: string;
     level?: string;
     dateTimeLevel?: string;
     bucket?: string;
@@ -143,6 +155,9 @@ export type JaqlResponse = {
     httpStatusCode?: number;
     database?: string;
 };
+export type DataSourceSchema = {
+    title: string;
+    type: 'extract' | 'live';
+} & AnyObject;
 export type AbortRequestFunction = (reason?: string) => void;
 export type QueryGuid = string;
-export type EmptyObject = Record<string, never>;

package/package.json

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