@sisense/sdk-rest-client 0.14.0 → 0.16.0

package/dist/http-client.d.ts

@@ -1,13 +1,18 @@
 /// <reference lib="dom" />
 import { Authenticator } from './interfaces.js';
+export interface HttpClientRequestConfig {
+    skipTrackingParam?: boolean;
+    nonJSONBody?: boolean;
+    returnBlob?: boolean;
+}
 export declare class HttpClient {
     readonly auth: Authenticator;
     readonly url: string;
     readonly env: string;
     constructor(url: string, auth: Authenticator, env: string);
     login(): Promise<boolean>;
-    call<T = unknown>(url: string, config: RequestInit): Promise<T>;
-    post<T = unknown>(endpoint: string, data: unknown, options?: RequestInit, abortSignal?: AbortSignal): Promise<T>;
-    get<T = unknown>(endpoint: string, request?: RequestInit): Promise<T>;
-    delete<T = void>(endpoint: string, request?: RequestInit): Promise<T>;
+    call<T = unknown>(url: string, config: RequestInit, requestConfig?: HttpClientRequestConfig): Promise<T>;
+    post<T = unknown>(endpoint: string, data: unknown, options?: RequestInit, abortSignal?: AbortSignal, config?: HttpClientRequestConfig): Promise<T>;
+    get<T = unknown>(endpoint: string, request?: RequestInit, config?: HttpClientRequestConfig): Promise<T>;
+    delete<T = void>(endpoint: string, request?: RequestInit, config?: HttpClientRequestConfig): Promise<T>;
 }

package/dist/http-client.js

@@ -42,7 +42,7 @@ export class HttpClient {
             return this.auth.authenticate();
         });
     }
-    call(url, config) {
+    call(url, config, requestConfig) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.auth.isAuthenticating()) {
                 return new Promise((res) => {
@@ -52,7 +52,7 @@ export class HttpClient {
                             setTimeout(retry, 10);
                             return;
                         }
-                        void this.call(url, config).then((r) => res(r));
+                        void this.call(url, config, requestConfig).then((r) => res(r));
                     };
                     retry();
                 });
@@ -67,14 +67,14 @@ export class HttpClient {
             const trackedUrl = addQueryParamsToUrl(url, {
                 trc: this.env,
             });
-            const response = yield fetch(trackedUrl, config);
+            const response = yield fetch((requestConfig === null || requestConfig === void 0 ? void 0 : requestConfig.skipTrackingParam) ? url : trackedUrl, config);
             if (response.status === 204 || // No content
                 response.status === 304 // Not modified
             ) {
                 return undefined;
             }
             try {
-                return (yield response.json());
+                return ((requestConfig === null || requestConfig === void 0 ? void 0 : requestConfig.returnBlob) ? yield response.blob() : yield response.json());
             }
             catch (e) {
                 // some of APIs in Sisense returns 200 with empty body - so it's not possible
@@ -89,25 +89,25 @@ export class HttpClient {
         });
     }
     // eslint-disable-next-line max-params
-    post(endpoint, data, options = {}, abortSignal) {
+    post(endpoint, data, options = {}, abortSignal, config) {
         return __awaiter(this, void 0, void 0, function* () {
-            const request = Object.assign({ method: 'POST', body: JSON.stringify(data), headers: {
+            const request = Object.assign({ method: 'POST', body: ((config === null || config === void 0 ? void 0 : config.nonJSONBody) ? data : JSON.stringify(data)), headers: {
                     Accept: 'application/json, text/plain, */*',
                     'Content-Type': 'application/json;charset=UTF-8',
                 }, signal: abortSignal }, options);
-            return this.call(this.url + endpoint, request);
+            return this.call(this.url + endpoint, request, config);
         });
     }
-    get(endpoint, request = {}) {
+    get(endpoint, request = {}, config) {
         return __awaiter(this, void 0, void 0, function* () {
             request.method = 'GET';
-            return this.call(this.url + endpoint, request);
+            return this.call(this.url + endpoint, request, config);
         });
     }
-    delete(endpoint, request = {}) {
+    delete(endpoint, request = {}, config) {
         return __awaiter(this, void 0, void 0, function* () {
             request.method = 'DELETE';
-            return this.call(this.url + endpoint, request);
+            return this.call(this.url + endpoint, request, config);
         });
     }
 }

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import './translation/initialize-i18n.js';
 export * from './interfaces.js';
 export { PasswordAuthenticator } from './password-authenticator.js';
 export { SsoAuthenticator } from './sso-authenticator.js';

package/dist/index.js

@@ -1,3 +1,4 @@
+import './translation/initialize-i18n.js';
 export * from './interfaces.js';
 export { PasswordAuthenticator } from './password-authenticator.js';
 export { SsoAuthenticator } from './sso-authenticator.js';

package/dist/interceptors.js

@@ -2,10 +2,14 @@ import { BearerAuthenticator } from './bearer-authenticator.js';
 import { WatAuthenticator } from './wat-authenticator.js';
 import { PasswordAuthenticator } from './password-authenticator.js';
 import { SsoAuthenticator } from './sso-authenticator.js';
-import { ERROR_PREFIX } from './constants.js';
+import { TranslatableError } from './translation/translatable-error.js';
 export function handleErrorResponse(response) {
     if (!response.ok) {
-        throw Error(`${ERROR_PREFIX} Status: ${response.status}${response.statusText ? ' - ' + response.statusText : ''}`);
+        throw new TranslatableError('errors.responseError', {
+            status: response.status.toString(),
+            statusText: response.statusText,
+            context: response.statusText ? 'withStatusText' : 'onlyStatus',
+        });
     }
     return response;
 }
@@ -13,18 +17,14 @@ export function handleUnauthorizedResponse(response, auth) {
     auth.invalidate();
     // skip login redirect for token auth
     if (auth instanceof PasswordAuthenticator) {
-        throw Error(`${ERROR_PREFIX} Username and password authentication was not successful. Check credentials.`);
+        throw new TranslatableError('errors.passwordAuthFailed');
     }
     if (auth instanceof BearerAuthenticator || auth instanceof WatAuthenticator) {
-        throw Error(`${ERROR_PREFIX} Token authentication was not successful. Check credentials.`);
+        throw new TranslatableError('errors.tokenAuthFailed');
     }
-    if (auth instanceof SsoAuthenticator) {
-        if (!auth.isAuthenticating()) {
-            // try to reauthenticate
-            void auth.authenticate();
-        }
-        // throw error to display while waiting for redirect
-        throw Error(`${ERROR_PREFIX} Not authenticated. Please wait for redirect or check SSO provider.`);
+    if (auth instanceof SsoAuthenticator && !auth.isAuthenticating()) {
+        // try to reauthenticate
+        void auth.authenticate();
     }
     return response;
 }
@@ -45,5 +45,5 @@ export function isNetworkError(responseError) {
  * @returns A promise that rejects with an error message.
  */
 export function handleNetworkError() {
-    return Promise.reject(new Error("Network error. Probably you forgot to add your domain to 'CORS Allowed Origins' in Sisense Admin Panel -> Security Settings."));
+    return Promise.reject(new TranslatableError('errors.networkError'));
 }

package/dist/sso-authenticator.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+import { TranslatableError } from './translation/translatable-error.js';
 export class SsoAuthenticator {
     constructor(url) {
         this._valid = true;
@@ -40,7 +41,7 @@ export class SsoAuthenticator {
                 if (!res.isAuthenticated) {
                     // SSO is disabled on instance, do not proceed
                     if (!res.ssoEnabled)
-                        throw new Error('SSO is not enabled on target instance, please choose another authentication method');
+                        throw new TranslatableError('errors.ssoNotEnabled');
                     // redirect to login page
                     window.location.href = `${res.loginUrl}?return_to=${window.location.href}`;
                 }

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 @@
+/**
+ * Translation dictionary for English language.
+ */
+export declare const translation: {
+    errorPrefix: string;
+    errors: {
+        networkError: string;
+        ssoNotEnabled: string;
+        passwordAuthFailed: string;
+        tokenAuthFailed: string;
+        responseError_onlyStatus: string;
+        responseError_withStatusText: string;
+    };
+};
+export declare type TranslationDictionary = typeof translation;

package/dist/translation/resources/en.js

@@ -0,0 +1,14 @@
+/**
+ * Translation dictionary for English language.
+ */
+export const translation = {
+    errorPrefix: '[request-error]',
+    errors: {
+        networkError: "Network error. Probably you forgot to add your domain to 'CORS Allowed Origins' in Sisense Admin Panel -> Security Settings.",
+        ssoNotEnabled: 'SSO is not enabled on target instance, please choose another authentication method',
+        passwordAuthFailed: '$t(errorPrefix) Username and password authentication was not successful. Check credentials.',
+        tokenAuthFailed: '$t(errorPrefix) Token authentication was not successful. Check credentials.',
+        responseError_onlyStatus: '$t(errorPrefix) Status: {{status}}',
+        responseError_withStatusText: '$t(errorPrefix) Status: {{status}} - {{statusText}}',
+    },
+};

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

@@ -0,0 +1,27 @@
+import { TranslationDictionary } from './en.js';
+export type { TranslationDictionary };
+export declare const PACKAGE_NAMESPACE: "sdkRestClient";
+export declare const resources: {
+    en: {
+        errorPrefix: string;
+        errors: {
+            networkError: string;
+            ssoNotEnabled: string;
+            passwordAuthFailed: string;
+            tokenAuthFailed: string;
+            responseError_onlyStatus: string;
+            responseError_withStatusText: string;
+        };
+    };
+    uk: {
+        errorPrefix: string;
+        errors: {
+            networkError: string;
+            ssoNotEnabled: string;
+            passwordAuthFailed: string;
+            tokenAuthFailed: string;
+            responseError_onlyStatus: string;
+            responseError_withStatusText: 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 = 'sdkRestClient';
+export const resources = {
+    en: enDictionary,
+    uk: ukDictionary,
+};

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

@@ -0,0 +1,5 @@
+import { TranslationDictionary } from './index.js';
+/**
+ * Translation dictionary for Ukrainian language.
+ */
+export declare const translation: TranslationDictionary;

package/dist/translation/resources/uk.js

@@ -0,0 +1,14 @@
+/**
+ * Translation dictionary for Ukrainian language.
+ */
+export const translation = {
+    errorPrefix: '[request-error]',
+    errors: {
+        networkError: 'Помилка мережі. Можливо ви забули додати свій домен до «CORS Allowed Origins» в панелі адміністратора Sisense -> Security Settings.',
+        ssoNotEnabled: 'SSO не ввімкнено на цьому сервері, будь ласка, виберіть інший метод аутентифікації',
+        passwordAuthFailed: '$t(errorPrefix) Помилка автентифікації за допомогою імені користувача та пароля. Перевірте дані для входу.',
+        tokenAuthFailed: '$t(errorPrefix) Помилка автентифікації за допомогою токена. Перевірте дані для входу.',
+        responseError_onlyStatus: '$t(errorPrefix) Статус: {{status}}',
+        responseError_withStatusText: '$t(errorPrefix) Статус: {{status}} - {{statusText}}',
+    },
+};

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-rest-client",
-  "version": "0.14.0",
+  "version": "0.16.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -9,6 +9,7 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
+    "@sisense/sdk-common": "^0.16.0",
     "fetch-intercept": "^2.4.0"
   },
   "scripts": {