@sisense/sdk-query-client 0.11.3 → 0.12.0

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/query-client.d.ts

@@ -19,3 +19,10 @@ export declare class DimensionalQueryClient implements QueryClient {
     executeQuery(queryDescription: QueryDescription): ExecutingQueryResult;
     getDataSourceFields(dataSource: DataSource, count?: number, offset?: number): Promise<DataSourceField[]>;
 }
+/**
+ * Validates query description
+ *
+ * @param queryDescription - query description to validate
+ * @throws Error if query description is invalid
+ */
+export declare function validateQueryDescription(queryDescription: QueryDescription): void;

package/dist/query-client.js

@@ -12,6 +12,7 @@ import { QueryTaskPassport } from './query-task-manager/query-task-passport.js';
 import { ExecutionResultStatus } from '@sisense/task-manager';
 import { QueryApiDispatcher } from './query-api-dispatcher/query-api-dispatcher.js';
 import { MetadataTypes } from '@sisense/sdk-data';
+import { TranslatableError } from './translation/translatable-error.js';
 /** @internal */
 export const QUERY_DEFAULT_LIMIT = 20000;
 export class DimensionalQueryClient {
@@ -57,38 +58,41 @@ export class DimensionalQueryClient {
  * @param queryDescription - query description to validate
  * @throws Error if query description is invalid
  */
-function validateQueryDescription(queryDescription) {
+export function validateQueryDescription(queryDescription) {
     const { attributes, measures, filters, highlights, count, offset } = queryDescription;
     if (count && count < 0) {
-        throw new Error(`Invalid count "${count}". Count should be non-negative.`);
+        throw new TranslatableError('errors.invalidCountNegative', { count: count.toString() });
     }
     if (count && count > QUERY_DEFAULT_LIMIT) {
-        throw new Error(`Invalid count "${count}". Count should not exceed ${QUERY_DEFAULT_LIMIT}.`);
+        throw new TranslatableError('errors.invalidCountLimit', {
+            count: count.toString(),
+            limit: QUERY_DEFAULT_LIMIT.toString(),
+        });
     }
     if (offset && offset < 0) {
-        throw new Error(`Invalid offset "${offset}". Offset should be non-negative.`);
+        throw new TranslatableError('errors.invalidOffset', { offset: offset.toString() });
     }
     if (attributes.length + measures.length === 0) {
-        throw new Error('Neither dimensions nor measures found. Query should have at least one dimension or measure.');
+        throw new TranslatableError('errors.noDimensionsOrMeasures');
     }
     attributes.forEach((attribute) => {
         if (!attribute.skipValidation && !MetadataTypes.isAttribute(attribute)) {
-            throw new Error(`Invalid attribute "${attribute.name}". Hint: attributes for query should be extracted from the data model generated by the CLI tool.`);
+            throw new TranslatableError('errors.invalidAttribute', { attributeName: attribute.name });
         }
     });
     measures.forEach((measure) => {
         if (!measure.skipValidation && !MetadataTypes.isMeasure(measure)) {
-            throw new Error(`Invalid measure "${measure.name}". Hint: measures for query can be constructed using the "measures" functions.`);
+            throw new TranslatableError('errors.invalidMeasure', { measureName: measure.name });
         }
     });
     filters.forEach((filter) => {
         if (!filter.skipValidation && !MetadataTypes.isFilter(filter)) {
-            throw new Error(`Invalid filter "${filter.name}". Hint: filters for query can be constructed using the "filters" functions.`);
+            throw new TranslatableError('errors.invalidFilter', { filterName: filter.name });
         }
     });
     highlights.forEach((highlight) => {
         if (!highlight.skipValidation && !MetadataTypes.isFilter(highlight)) {
-            throw new Error(`Invalid highlight "${highlight.name}". Hint: highlights for query can be constructed using the "filters" functions.`);
+            throw new TranslatableError('errors.invalidHighlight', { highlightName: highlight.name });
         }
     });
 }
@@ -99,8 +103,10 @@ function validateQueryDescription(queryDescription) {
  * @throws Error if http client is invalid
  */
 function validateHttpClient(httpClient) {
-    if (!httpClient)
-        throw new Error('Query requires httpClient to work properly');
-    if (!httpClient.post)
-        throw new Error('httpClient must provide "post" method');
+    if (!httpClient) {
+        throw new TranslatableError('errors.missingHttpClient');
+    }
+    if (!httpClient.post) {
+        throw new TranslatableError('errors.missingPostMethod');
+    }
 }

package/dist/translation/initialize-i18n.d.ts

@@ -0,0 +1,2 @@
+export declare function initializeI18n(): import("@sisense/sdk-common").I18NextInitResult;
+export declare const i18nextInstance: import("i18next").i18n;

package/dist/translation/initialize-i18n.js

@@ -0,0 +1,10 @@
+import { initI18next } from '@sisense/sdk-common';
+import { resources, PACKAGE_NAMESPACE } from './resources/index.js';
+export function initializeI18n() {
+    return initI18next({
+        resource: resources,
+        language: 'en',
+        namespace: PACKAGE_NAMESPACE,
+    });
+}
+export const { i18nextInstance } = initializeI18n();

package/dist/translation/resources/en.d.ts

@@ -0,0 +1,15 @@
+export declare const translation: {
+    errors: {
+        invalidAttribute: string;
+        noDimensionsOrMeasures: string;
+        invalidMeasure: string;
+        invalidFilter: string;
+        invalidHighlight: string;
+        invalidCountNegative: string;
+        invalidCountLimit: string;
+        invalidOffset: string;
+        missingHttpClient: string;
+        missingPostMethod: string;
+    };
+};
+export type TranslationDictionary = typeof translation;

package/dist/translation/resources/en.js

@@ -0,0 +1,14 @@
+export const translation = {
+    errors: {
+        invalidAttribute: 'Invalid attribute {{attributeName}}. Hint: attributes for query should be extracted from the data model generated by the CLI tool.',
+        noDimensionsOrMeasures: 'Neither dimensions nor measures found. Query should have at least one dimension or measure.',
+        invalidMeasure: 'Invalid measure "{{measureName}}". Hint: measures for the query can be constructed using the "measures" functions.',
+        invalidFilter: 'Invalid filter "{{filterName}}". Hint: filters for the query can be constructed using the "filters" functions.',
+        invalidHighlight: 'Invalid highlight "{{highlightName}}". Hint: highlights for the query can be constructed using the "filters" functions.',
+        invalidCountNegative: 'Invalid count "{{count}}". Count should be non-negative.',
+        invalidCountLimit: 'Invalid count "{{count}}". Count should not exceed {{limit}}.',
+        invalidOffset: 'Invalid offset "{{offset}}". Offset should be non-negative.',
+        missingHttpClient: 'Query requires httpClient to work properly.',
+        missingPostMethod: 'httpClient must provide "post" method.',
+    },
+};

package/dist/translation/resources/index.d.ts

@@ -0,0 +1,33 @@
+import { TranslationDictionary } from './en.js';
+export type { TranslationDictionary };
+export declare const PACKAGE_NAMESPACE: "sdkQueryClient";
+export declare const resources: {
+    en: {
+        errors: {
+            invalidAttribute: string;
+            noDimensionsOrMeasures: string;
+            invalidMeasure: string;
+            invalidFilter: string;
+            invalidHighlight: string;
+            invalidCountNegative: string;
+            invalidCountLimit: string;
+            invalidOffset: string;
+            missingHttpClient: string;
+            missingPostMethod: string;
+        };
+    };
+    uk: {
+        errors: {
+            invalidAttribute: string;
+            noDimensionsOrMeasures: string;
+            invalidMeasure: string;
+            invalidFilter: string;
+            invalidHighlight: string;
+            invalidCountNegative: string;
+            invalidCountLimit: string;
+            invalidOffset: string;
+            missingHttpClient: string;
+            missingPostMethod: string;
+        };
+    };
+};

package/dist/translation/resources/index.js

@@ -0,0 +1,7 @@
+import { translation as enDictionary } from './en.js';
+import { translation as ukDictionary } from './uk.js';
+export const PACKAGE_NAMESPACE = 'sdkQueryClient';
+export const resources = {
+    en: enDictionary,
+    uk: ukDictionary,
+};

package/dist/translation/resources/uk.d.ts

@@ -0,0 +1,2 @@
+import { TranslationDictionary } from './index.js';
+export declare const translation: TranslationDictionary;

package/dist/translation/resources/uk.js

@@ -0,0 +1,14 @@
+export const translation = {
+    errors: {
+        invalidAttribute: `Недійсний атрибут {{attributeName}}. Підказка: атрибути для запиту повинні бути витягнуті з моделі даних, створеної за допомогою CLI-інструменту.`,
+        noDimensionsOrMeasures: `Не знайдено ні розмірів, ні показників. Запит повинен мати щонайменше один розмір або показник.`,
+        invalidMeasure: `Недійсний показник "{{measureName}}". Підказка: показники для запиту можна створити за допомогою функцій "measures".`,
+        invalidFilter: `Недійсний фільтр "{{filterName}}". Підказка: фільтри для запиту можна створити за допомогою функцій "filters".`,
+        invalidHighlight: `Недійсне виділення "{{highlightName}}". Підказка: виділення для запиту можна створити за допомогою функцій "filters".`,
+        invalidCountNegative: `Недійсний count "{{count}}". Count повинен бути не від'ємним.`,
+        invalidCountLimit: `Недійсний count "{{count}}". Count не повинен перевищувати {{limit}}.`,
+        invalidOffset: `Недійсний offset "{{offset}}". Offset повинен бути не від'ємним.`,
+        missingHttpClient: `Для запиту потрібен httpClient, щоб працювати належним чином.`,
+        missingPostMethod: `httpClient повинен мати метод "post".`,
+    },
+};

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

@@ -0,0 +1,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>);
+}

package/dist/translation/translatable-error.js

@@ -0,0 +1,11 @@
+import { AbstractTranslatableError } from '@sisense/sdk-common';
+import { i18nextInstance } from './initialize-i18n.js';
+import { PACKAGE_NAMESPACE } from './resources/index.js';
+export class TranslatableError extends AbstractTranslatableError {
+    constructor(translationKey, interpolationOptions) {
+        super(PACKAGE_NAMESPACE, {
+            key: translationKey,
+            interpolationOptions: interpolationOptions,
+        }, i18nextInstance.t);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sisense/sdk-query-client",
-  "version": "0.11.3",
+  "version": "0.12.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -9,8 +9,9 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-data": "^0.11.3",
-    "@sisense/sdk-rest-client": "^0.11.3",
+    "@sisense/sdk-common": "^0.12.0",
+    "@sisense/sdk-data": "^0.12.0",
+    "@sisense/sdk-rest-client": "^0.12.0",
     "@sisense/task-manager": "^0.1.0",
     "numeral": "^2.0.6",
     "uuid": "^9.0.0"