@sisense/sdk-rest-client 1.3.0 → 1.4.0

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,6 +1,7 @@
 /// <reference lib="dom" />
 import { Authenticator } from './interfaces.js';
 export declare class SsoAuthenticator implements Authenticator {
+    readonly type = "sso";
     readonly url: string;
     private _enableSilentPreAuth;
     private _valid;
@@ -14,3 +15,10 @@ export declare class SsoAuthenticator implements Authenticator {
     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

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { TranslatableError } from './translation/translatable-error.js';
 export class SsoAuthenticator {
     constructor(url, enableSilentPreAuth = false) {
+        this.type = 'sso';
         this._valid = true;
         this._authenticating = false;
         this.url = url;
@@ -85,3 +86,12 @@ export class SsoAuthenticator {
         });
     }
 }
+/**
+ * Checks if the authenticator is SSO authenticator
+ *
+ * @param authenticator - authenticator to check
+ * @internal
+ */
+export function isSsoAuthenticator(authenticator) {
+    return authenticator.type === 'sso';
+}

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.3.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.3.0",
+    "@sisense/sdk-common": "^1.4.0",
     "fetch-intercept": "^2.4.0"
   },
   "scripts": {