@sisense/sdk-rest-client 1.2.0 → 1.4.0

package/dist/authenticator.d.ts

@@ -1,2 +1,2 @@
 import { Authenticator } from './interfaces.js';
-export declare function getAuthenticator(url: string, username: string | undefined, password: string | undefined, token: string | undefined, wat: string | undefined, ssoEnabled: boolean | undefined): Authenticator | null;
+export declare function getAuthenticator(url: string, username: string | undefined, password: string | undefined, token: string | undefined, wat: string | undefined, ssoEnabled: boolean | undefined, enableSilentPreAuth?: boolean): Authenticator | null;

package/dist/authenticator.js

@@ -2,10 +2,10 @@ import { PasswordAuthenticator } from './password-authenticator.js';
 import { BearerAuthenticator } from './bearer-authenticator.js';
 import { WatAuthenticator } from './wat-authenticator.js';
 import { SsoAuthenticator } from './sso-authenticator.js';
-export function getAuthenticator(url, username, password, token, wat, ssoEnabled) {
+export function getAuthenticator(url, username, password, token, wat, ssoEnabled, enableSilentPreAuth = false) {
     // sso overrides all other auth methods
     if (ssoEnabled) {
-        return new SsoAuthenticator(url);
+        return new SsoAuthenticator(url, enableSilentPreAuth);
     }
     // username/password or tokens are chosen relative to priority
     if (username && password) {

package/dist/bearer-authenticator.d.ts

@@ -1,5 +1,6 @@
 import { Authenticator } from './interfaces.js';
 export declare class BearerAuthenticator implements Authenticator {
+    readonly type = "bearer";
     readonly bearer: string;
     readonly url: string;
     private _valid;
@@ -10,3 +11,10 @@ export declare class BearerAuthenticator implements Authenticator {
     applyHeader(headers: HeadersInit): void;
     authenticate(): Promise<boolean>;
 }
+/**
+ * Checks if an authenticator is a BearerAuthenticator.
+ *
+ * @param authenticator - The authenticator to check.
+ * @internal
+ */
+export declare function isBearerAuthenticator(authenticator: Authenticator): authenticator is BearerAuthenticator;

package/dist/bearer-authenticator.js

@@ -12,6 +12,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { appendHeaders } from './helpers.js';
 export class BearerAuthenticator {
     constructor(url, bearer) {
+        this.type = 'bearer';
         this._valid = true;
         this.bearer = bearer;
         this.url = url;
@@ -36,3 +37,12 @@ export class BearerAuthenticator {
         });
     }
 }
+/**
+ * Checks if an authenticator is a BearerAuthenticator.
+ *
+ * @param authenticator - The authenticator to check.
+ * @internal
+ */
+export function isBearerAuthenticator(authenticator) {
+    return authenticator.type === 'bearer';
+}

package/dist/http-client.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import fetchIntercept from 'fetch-intercept';
-import { handleNetworkError, handleErrorResponse, handleUnauthorizedResponse, isNetworkError, } from './interceptors.js';
+import { getResponseInterceptor, errorInterceptor } from './interceptors.js';
 import { SsoAuthenticator } from './sso-authenticator.js';
 import { addQueryParamsToUrl } from './helpers.js';
 export class HttpClient {
@@ -20,21 +20,8 @@ export class HttpClient {
         this.auth = auth;
         this.env = env;
         fetchIntercept.register({
-            response: (response) => {
-                if (response.status === 401) {
-                    return handleUnauthorizedResponse(response, auth);
-                }
-                if (!response.ok) {
-                    return handleErrorResponse(response);
-                }
-                return response;
-            },
-            responseError: (error) => {
-                if (isNetworkError(error)) {
-                    return handleNetworkError();
-                }
-                return Promise.reject(error);
-            },
+            response: getResponseInterceptor(auth),
+            responseError: errorInterceptor,
         });
     }
     login() {

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import './translation/initialize-i18n.js';
 export * from './interfaces.js';
 export { PasswordAuthenticator } from './password-authenticator.js';
-export { SsoAuthenticator } from './sso-authenticator.js';
-export { BearerAuthenticator } from './bearer-authenticator.js';
-export { WatAuthenticator } from './wat-authenticator.js';
+export { SsoAuthenticator, isSsoAuthenticator } from './sso-authenticator.js';
+export { BearerAuthenticator, isBearerAuthenticator } from './bearer-authenticator.js';
+export { WatAuthenticator, isWatAuthenticator } from './wat-authenticator.js';
 export { getAuthenticator } from './authenticator.js';
 export { HttpClient } from './http-client.js';

package/dist/index.js

@@ -1,8 +1,8 @@
 import './translation/initialize-i18n.js';
 export * from './interfaces.js';
 export { PasswordAuthenticator } from './password-authenticator.js';
-export { SsoAuthenticator } from './sso-authenticator.js';
-export { BearerAuthenticator } from './bearer-authenticator.js';
-export { WatAuthenticator } from './wat-authenticator.js';
+export { SsoAuthenticator, isSsoAuthenticator } from './sso-authenticator.js';
+export { BearerAuthenticator, isBearerAuthenticator } from './bearer-authenticator.js';
+export { WatAuthenticator, isWatAuthenticator } from './wat-authenticator.js';
 export { getAuthenticator } from './authenticator.js';
 export { HttpClient } from './http-client.js';

package/dist/interceptors.d.ts

@@ -1,19 +1,4 @@
 import { FetchInterceptorResponse } from 'fetch-intercept';
 import { Authenticator } from './interfaces.js';
-export declare function handleErrorResponse(response: FetchInterceptorResponse): FetchInterceptorResponse;
-export declare function handleUnauthorizedResponse(response: FetchInterceptorResponse, auth: Authenticator): FetchInterceptorResponse;
-/**
- * Checks if the given response error indicates a Network error.
- *
- * It is impossible to distinguish between a CORS error and other network errors, such as
- * 'net::ERR_SSL_PROTOCOL_ERROR' and 'net::ERR_EMPTY_RESPONSE'. This information is hidden by the browser.
- *
- * @param responseError - The error object received from the failed response.
- */
-export declare function isNetworkError(responseError: Error): boolean;
-/**
- * Handles a Network error.
- *
- * @returns A promise that rejects with an error message.
- */
-export declare function handleNetworkError(): Promise<never>;
+export declare const getResponseInterceptor: (auth: Authenticator) => (response: FetchInterceptorResponse) => FetchInterceptorResponse;
+export declare const errorInterceptor: (error: Error) => Promise<never>;

package/dist/interceptors.js

@@ -3,7 +3,7 @@ import { WatAuthenticator } from './wat-authenticator.js';
 import { PasswordAuthenticator } from './password-authenticator.js';
 import { SsoAuthenticator } from './sso-authenticator.js';
 import { TranslatableError } from './translation/translatable-error.js';
-export function handleErrorResponse(response) {
+function handleErrorResponse(response) {
     if (!response.ok) {
         throw new TranslatableError('errors.responseError', {
             status: response.status.toString(),
@@ -13,7 +13,7 @@ export function handleErrorResponse(response) {
     }
     return response;
 }
-export function handleUnauthorizedResponse(response, auth) {
+function handleUnauthorizedResponse(response, auth) {
     auth.invalidate();
     // skip login redirect for token auth
     if (auth instanceof PasswordAuthenticator) {
@@ -36,7 +36,7 @@ export function handleUnauthorizedResponse(response, auth) {
  *
  * @param responseError - The error object received from the failed response.
  */
-export function isNetworkError(responseError) {
+function isNetworkError(responseError) {
     return !!(responseError.message === 'Failed to fetch' && responseError.name === 'TypeError');
 }
 /**
@@ -44,6 +44,21 @@ export function isNetworkError(responseError) {
  *
  * @returns A promise that rejects with an error message.
  */
-export function handleNetworkError() {
+function handleNetworkError() {
     return Promise.reject(new TranslatableError('errors.networkError'));
 }
+export const getResponseInterceptor = (auth) => (response) => {
+    if (response.status === 401) {
+        return handleUnauthorizedResponse(response, auth);
+    }
+    if (!response.ok) {
+        return handleErrorResponse(response);
+    }
+    return response;
+};
+export const errorInterceptor = (error) => {
+    if (isNetworkError(error)) {
+        return handleNetworkError();
+    }
+    return Promise.reject(error);
+};

package/dist/interfaces.d.ts

@@ -1,4 +1,5 @@
 export interface Authenticator {
+    readonly type: 'password' | 'bearer' | 'wat' | 'sso';
     isValid: () => boolean;
     invalidate: () => void;
     authenticate: () => Promise<boolean>;

package/dist/password-authenticator.d.ts

@@ -1,6 +1,7 @@
 /// <reference lib="dom" />
 import { Authenticator } from './interfaces.js';
 export declare class PasswordAuthenticator implements Authenticator {
+    readonly type = "password";
     private _authheader;
     readonly user: string;
     readonly pass: string;
@@ -14,3 +15,10 @@ export declare class PasswordAuthenticator implements Authenticator {
     applyHeader(headers: HeadersInit): void;
     authenticate(): Promise<boolean>;
 }
+/**
+ * Checks if an authenticator is a PasswordAuthenticator.
+ *
+ * @param authenticator - the authenticator to check
+ * @internal
+ */
+export declare function isPasswordAuthenticator(authenticator: Authenticator): authenticator is PasswordAuthenticator;

package/dist/password-authenticator.js

@@ -16,6 +16,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { appendHeaders } from './helpers.js';
 export class PasswordAuthenticator {
     constructor(url, user, pass) {
+        this.type = 'password';
         this._authenticating = false;
         this._valid = true;
         this._authheader = undefined;
@@ -59,3 +60,12 @@ export class PasswordAuthenticator {
         });
     }
 }
+/**
+ * Checks if an authenticator is a PasswordAuthenticator.
+ *
+ * @param authenticator - the authenticator to check
+ * @internal
+ */
+export function isPasswordAuthenticator(authenticator) {
+    return authenticator.type === 'password';
+}

package/dist/sso-authenticator.d.ts

@@ -1,13 +1,24 @@
 /// <reference lib="dom" />
 import { Authenticator } from './interfaces.js';
 export declare class SsoAuthenticator implements Authenticator {
+    readonly type = "sso";
     readonly url: string;
+    private _enableSilentPreAuth;
     private _valid;
     private _authenticating;
-    constructor(url: string);
+    constructor(url: string, enableSilentPreAuth?: boolean);
     isValid(): boolean;
     invalidate(): void;
     isAuthenticating(): boolean;
     applyHeader(headers: HeadersInit): HeadersInit;
-    authenticate(): Promise<boolean>;
+    private authenticateSilent;
+    private checkAuthentication;
+    authenticate(silent?: boolean): Promise<boolean>;
 }
+/**
+ * Checks if the authenticator is SSO authenticator
+ *
+ * @param authenticator - authenticator to check
+ * @internal
+ */
+export declare function isSsoAuthenticator(authenticator: Authenticator): authenticator is SsoAuthenticator;

package/dist/sso-authenticator.js

@@ -10,10 +10,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { TranslatableError } from './translation/translatable-error.js';
 export class SsoAuthenticator {
-    constructor(url) {
+    constructor(url, enableSilentPreAuth = false) {
+        this.type = 'sso';
         this._valid = true;
         this._authenticating = false;
         this.url = url;
+        this._enableSilentPreAuth = enableSilentPreAuth;
     }
     isValid() {
         return this._valid;
@@ -27,31 +29,69 @@ export class SsoAuthenticator {
     applyHeader(headers) {
         return headers;
     }
-    authenticate() {
+    authenticateSilent(loginUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const iframe = document.createElement('iframe');
+            iframe.style.display = 'none';
+            document.body.appendChild(iframe);
+            iframe.src = `${loginUrl}?return_to=${window.location.href}`;
+            yield new Promise((resolve) => {
+                iframe.onload = () => {
+                    resolve(true);
+                };
+            });
+            document.body.removeChild(iframe);
+        });
+    }
+    checkAuthentication() {
         return __awaiter(this, void 0, void 0, function* () {
-            this._authenticating = true;
             const fetchUrl = `${this.url}${!this.url.endsWith('/') ? '/' : ''}api/auth/isauth`;
-            return fetch(fetchUrl, {
+            const response = yield fetch(fetchUrl, {
                 headers: { Internal: 'true' },
                 credentials: 'include',
-            })
-                .then((res) => res.json())
-                .then((res) => {
-                var _a;
-                if (!res.isAuthenticated) {
-                    // SSO is disabled on instance, do not proceed
-                    if (!res.ssoEnabled)
-                        throw new TranslatableError('errors.ssoNotEnabled');
-                    // redirect to login page
-                    (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.assign(`${res.loginUrl}?return_to=${window.location.href}`);
-                    return false;
+            });
+            const result = yield response.json();
+            if (!result.isAuthenticated) {
+                if (!result.ssoEnabled) {
+                    throw new TranslatableError('errors.ssoNotEnabled');
                 }
-                else {
-                    // no authentication needed, indicate success
-                    this._authenticating = false;
-                    return true;
+                if (!result.loginUrl) {
+                    throw new TranslatableError('errors.ssoNoLoginUrl');
                 }
-            });
+            }
+            return {
+                isAuthenticated: result.isAuthenticated,
+                loginUrl: `${result.loginUrl}?return_to=${window.location.href}`,
+            };
         });
     }
+    authenticate(silent = true) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            this._authenticating = true;
+            const { isAuthenticated, loginUrl } = yield this.checkAuthentication();
+            if (!isAuthenticated) {
+                if (this._enableSilentPreAuth && silent) {
+                    yield this.authenticateSilent(loginUrl);
+                    return this.authenticate(false);
+                }
+                (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.assign(loginUrl);
+                return false;
+            }
+            else {
+                // no authentication needed, indicate success
+                this._authenticating = false;
+                return true;
+            }
+        });
+    }
+}
+/**
+ * Checks if the authenticator is SSO authenticator
+ *
+ * @param authenticator - authenticator to check
+ * @internal
+ */
+export function isSsoAuthenticator(authenticator) {
+    return authenticator.type === 'sso';
 }

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

@@ -6,6 +6,7 @@ export declare const translation: {
     errors: {
         networkError: string;
         ssoNotEnabled: string;
+        ssoNoLoginUrl: string;
         passwordAuthFailed: string;
         tokenAuthFailed: string;
         responseError_onlyStatus: string;

package/dist/translation/resources/en.js

@@ -5,7 +5,8 @@ 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',
+        ssoNotEnabled: 'SSO is not enabled on target instance, please choose another authentication method.',
+        ssoNoLoginUrl: 'Can not fetch login URL on target instance. Check SSO settings.',
         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}}',

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

@@ -7,6 +7,7 @@ export declare const resources: {
         errors: {
             networkError: string;
             ssoNotEnabled: string;
+            ssoNoLoginUrl: string;
             passwordAuthFailed: string;
             tokenAuthFailed: string;
             responseError_onlyStatus: string;
@@ -18,6 +19,7 @@ export declare const resources: {
         errors: {
             networkError: string;
             ssoNotEnabled: string;
+            ssoNoLoginUrl: string;
             passwordAuthFailed: string;
             tokenAuthFailed: string;
             responseError_onlyStatus: string;

package/dist/translation/resources/uk.js

@@ -6,6 +6,7 @@ export const translation = {
     errors: {
         networkError: 'Помилка мережі. Можливо ви забули додати свій домен до «CORS Allowed Origins» в панелі адміністратора Sisense -> Security Settings.',
         ssoNotEnabled: 'SSO не ввімкнено на цьому сервері, будь ласка, виберіть інший метод аутентифікації',
+        ssoNoLoginUrl: 'Неможливо отримати loginUrl з сервера. Перевірте налаштування SSO.',
         passwordAuthFailed: '$t(errorPrefix) Помилка автентифікації за допомогою імені користувача та пароля. Перевірте дані для входу.',
         tokenAuthFailed: '$t(errorPrefix) Помилка автентифікації за допомогою токена. Перевірте дані для входу.',
         responseError_onlyStatus: '$t(errorPrefix) Статус: {{status}}',

package/dist/wat-authenticator.d.ts

@@ -1,6 +1,7 @@
 /// <reference lib="dom" />
 import { Authenticator } from './interfaces.js';
 export declare class WatAuthenticator implements Authenticator {
+    readonly type = "wat";
     private _initialiser;
     private _webSessionToken;
     readonly wat: string;
@@ -14,3 +15,10 @@ export declare class WatAuthenticator implements Authenticator {
     applyHeader(headers: HeadersInit): void;
     authenticate(): Promise<boolean>;
 }
+/**
+ * Checks if an authenticator is a WatAuthenticator.
+ *
+ * @param authenticator - the authenticator to check
+ * @internal
+ */
+export declare function isWatAuthenticator(authenticator: Authenticator): authenticator is WatAuthenticator;

package/dist/wat-authenticator.js

@@ -12,6 +12,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { appendHeaders } from './helpers.js';
 export class WatAuthenticator {
     constructor(url, wat) {
+        this.type = 'wat';
         this._authenticating = false;
         this._valid = true;
         this._initialiser = undefined;
@@ -67,3 +68,12 @@ export class WatAuthenticator {
         });
     }
 }
+/**
+ * Checks if an authenticator is a WatAuthenticator.
+ *
+ * @param authenticator - the authenticator to check
+ * @internal
+ */
+export function isWatAuthenticator(authenticator) {
+    return authenticator.type === 'wat';
+}

package/package.json

@@ -11,7 +11,7 @@
     "Sisense",
     "Compose SDK"
   ],
-  "version": "1.2.0",
+  "version": "1.4.0",
   "type": "module",
   "exports": "./dist/index.js",
   "main": "./dist/index.js",
@@ -20,7 +20,7 @@
   "author": "Sisense",
   "license": "SEE LICENSE IN LICENSE.md",
   "dependencies": {
-    "@sisense/sdk-common": "^1.2.0",
+    "@sisense/sdk-common": "^1.4.0",
     "fetch-intercept": "^2.4.0"
   },
   "scripts": {