@sisense/sdk-query-client 1.10.0 → 1.11.0

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

@@ -1,8 +1,10 @@
-import { JaqlQueryPayload, QueryDescription, PivotQueryDescription } from '../types.js';
+import { JaqlQueryPayload, QueryDescription, PivotQueryDescription, QueryOptions } from '../types.js';
+import { DataSource } from '@sisense/sdk-data';
 /**
  * @internal
  */
 export declare function getJaqlQueryPayload(queryDescription: QueryDescription, shouldSkipHighlightsWithoutAttributes: boolean): JaqlQueryPayload;
+export declare function prepareQueryOptions(dataSource: DataSource, count?: number, offset?: number, includeUngroup?: boolean): QueryOptions;
 /**
  * Converts a pivot query description to a JAQL query payload.
  *

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

@@ -8,8 +8,13 @@ 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));
+    const { attributes, measures, filters, filterRelations, highlights, dataSource, count, offset, ungroup, } = queryDescription;
+    // "ungroup: true" will be set in JAQL when two conditions are met:
+    // (1) ungroup is set to true
+    // AND
+    // (2) the query has no measures (unaggregated query)
+    const includeUngroup = ungroup && measures.length === 0;
+    const queryPayload = Object.assign({ metadata: prepareQueryMetadata({ attributes, measures, filters, filterRelations, highlights }, shouldSkipHighlightsWithoutAttributes) }, prepareQueryOptions(dataSource, count, offset, includeUngroup));
     if (filterRelations) {
         return Object.assign(Object.assign({}, queryPayload), { filterRelations });
     }
@@ -43,8 +48,8 @@ function prepareQueryMetadata(metadataDescription, shouldSkipHighlightsWithoutAt
     const filtersMetadata = prepareFilterMetadata(attributesMetadata, filters, filterRelations, highlights, shouldSkipHighlightsWithoutAttributes);
     return [...attributesMetadata, ...measuresMetadata, ...filtersMetadata];
 }
-function prepareQueryOptions(dataSource, count, offset) {
-    return Object.assign(Object.assign({ datasource: getJaqlDataSource(dataSource), by: JAQL_BY_CSDK, queryGuid: uuid() }, (count ? { count } : {})), (offset ? { offset } : {}));
+export function prepareQueryOptions(dataSource, count, offset, includeUngroup) {
+    return Object.assign(Object.assign(Object.assign({ datasource: getJaqlDataSource(dataSource), by: JAQL_BY_CSDK, queryGuid: uuid() }, (includeUngroup ? { ungroup: true } : {})), (count ? { count } : {})), (offset ? { offset } : {}));
 }
 /**
  * Converts a pivot query description to a JAQL query payload.

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

@@ -119,7 +119,7 @@ export class QueryTaskManager extends AbstractTaskManager {
 export function validateJaqlResponse(jaqlResponse) {
     var _a;
     if (jaqlResponse.error) {
-        throw new Error(`${jaqlResponse.details} ${(_a = jaqlResponse.database) !== null && _a !== void 0 ? _a : ''}`);
+        throw new Error(`${jaqlResponse.details} ${(_a = jaqlResponse.database) !== null && _a !== void 0 ? _a : ''} ${jaqlResponse.extraDetails ? JSON.stringify(jaqlResponse.extraDetails) : ''}`);
     }
     return true;
 }

package/dist/types.d.ts

@@ -12,6 +12,7 @@ export type QueryDescription = {
     filterRelations?: FilterRelationsJaql;
     count?: number;
     offset?: number;
+    ungroup?: boolean;
 };
 /**
  * All the properties that fully describe a pivot query you want to send.
@@ -51,6 +52,9 @@ export type QueryOptions = {
     datasource: JaqlDataSource;
     by: string;
     queryGuid: string;
+    count?: number;
+    offset?: number;
+    ungroup?: boolean;
     dashboard?: string;
     widget?: string;
     format?: string;
@@ -192,6 +196,7 @@ export type JaqlResponse = {
     values?: Cell[][] | Cell[];
     error?: boolean;
     details?: string;
+    extraDetails?: string;
     type?: string;
     errorSource?: string;
     httpStatusCode?: number;

package/package.json

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