@sisense/sdk-query-client 0.16.0 → 1.0.0

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

@@ -1,18 +1,28 @@
 import { v4 as uuid } from 'uuid';
 import { applyHighlightFilters, matchHighlightsWithAttributes } from './metadata/highlights.js';
 export function getJaqlQueryPayload(queryDescription, shouldSkipHighlightsWithoutAttributes) {
-    const { attributes, measures, filters, highlights, dataSource, count, offset } = queryDescription;
-    return Object.assign({ metadata: prepareQueryMetadata({ attributes, measures, filters, highlights }, shouldSkipHighlightsWithoutAttributes) }, prepareQueryOptions(dataSource, count, offset));
+    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));
+    if (filterRelations) {
+        return Object.assign(Object.assign({}, queryPayload), { filterRelations });
+    }
+    return queryPayload;
 }
 function prepareQueryMetadata(metadataDescription, shouldSkipHighlightsWithoutAttributes) {
-    const { attributes, measures, filters, highlights } = metadataDescription;
+    const { attributes, measures, filters, filterRelations, highlights } = metadataDescription;
     const attributesMetadata = attributes.map((d) => d.jaql());
     const measuresMetadata = measures.map((d) => d.jaql());
     const [highlightsWithAttributes, highlightsWithoutAttributes] = matchHighlightsWithAttributes(attributesMetadata, highlights);
     attributesMetadata.forEach((d) => applyHighlightFilters(d, highlightsWithAttributes));
+    const getFilterJaql = (f) => {
+        if (filterRelations) {
+            return Object.assign(Object.assign({}, f.jaql()), { instanceid: f.guid });
+        }
+        return f.jaql();
+    };
     const filtersMetadata = (shouldSkipHighlightsWithoutAttributes
-        ? filters.map((d) => d.jaql())
-        : [...filters, ...highlightsWithoutAttributes].map((d) => d.jaql())).filter((f) => {
+        ? filters.map((d) => getFilterJaql(d))
+        : [...filters, ...highlightsWithoutAttributes].map((d) => getFilterJaql(d))).filter((f) => {
         return Object.keys(f.jaql.filter || {}).length !== 0;
     });
     if (shouldSkipHighlightsWithoutAttributes && highlightsWithoutAttributes.length > 0) {

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Filter, Measure, Attribute, Cell, QueryResultData, DataSource } from '@sisense/sdk-data';
+import { Filter, Measure, Attribute, Cell, QueryResultData, DataSource, FilterRelation } from '@sisense/sdk-data';
 /**
  * All the properties that fully describe a query you want to send.
  */
@@ -8,6 +8,7 @@ export type QueryDescription = {
     measures: Measure[];
     filters: Filter[];
     highlights: Filter[];
+    filterRelations?: FilterRelation;
     count?: number;
     offset?: number;
 };
@@ -37,6 +38,7 @@ export type ExecutingCsvQueryResult = {
     cancel: (reason?: string) => Promise<void>;
 };
 export type MetadataItem = {
+    instanceid?: string;
     measure?: MetadataItemJaql;
     jaql: MetadataItemJaql;
     panel?: string;
@@ -74,6 +76,7 @@ export type MetadataItemJaql = {
     filter?: MetadataItem;
 };
 export type JaqlQueryPayload = QueryOptions & {
+    filterRelations?: FilterRelation;
     metadata: MetadataItem[];
 };
 export type DataSourceField = {

package/package.json

@@ -1,6 +1,17 @@
 {
   "name": "@sisense/sdk-query-client",
-  "version": "0.16.0",
+  "homepage": "https://sisense.dev/guides/sdk/",
+  "description": "Compose SDK package for handling data queries against Sisense data sources",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sisense/compose-sdk-monorepo",
+    "directory": "packages/sdk-query-client"
+  },
+  "keywords": [
+    "Sisense",
+    "Compose SDK"
+  ],
+  "version": "1.0.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -9,9 +20,9 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^0.16.0",
-    "@sisense/sdk-data": "^0.16.0",
-    "@sisense/sdk-rest-client": "^0.16.0",
+    "@sisense/sdk-common": "^1.0.0",
+    "@sisense/sdk-data": "^1.0.0",
+    "@sisense/sdk-rest-client": "^1.0.0",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "uuid": "^9.0.0"