@sinch/sdk-client 0.0.0

package/README.md

@@ -0,0 +1,109 @@
+# Sinch Http Client for Node.js
+
+This package contains the HTTP client used by the Sinch SDK client. It uses the `fetch` library to send requests. There are 3 folders in this package:
+ - api: it defines the interface for an `Api`, an `ApiClient` and for `ApiClientOptions`.
+ - client: it contains the `fetch` implementation for the `ApiClient`. This implementation handles the refresh of the JWT for the APIs which support this authentication method.
+ - plugins: calling an API can be seen as a straighforward operation as it's "just" about sending an HTTP request to a server and reading the response. And this is was the `ApiClient` does. However, all APIs don't behave the same and this is why we have introduced the request and response plugins:
+   - request plugins will modify the request: for the moment, they are all about adding some headers (for authentication, for tracking the SDK usage).
+   - response plugins will modify the response, e.g.: response content is checked and transformed into an exception if the content is empty.
+
+<span style="color:red; font-weight:bold">Warning:</span>
+**This SDK is currently available for preview purposes only. It should not be used in production environments.**
+
+## Architecture
+TODO: schema
+
+## Installation
+
+### With NPM
+
+```bash
+npm install @sinch/sdk-client
+```
+
+### With Yarn
+
+```bash
+yarn add @sinch/sdk-client
+```
+
+## Usage
+
+In this section, we'll see how to implement the `Api` interface and how to use the `ApiFetchClient` to call the API endpoint.
+
+### Api interface
+
+```typescript
+export class MyExampleApi implements Api {
+    public readonly apiName = 'MyExampleApi';
+    public readonly client: ApiClient;
+
+    constructor(apiClient: ApiClient) {
+        this.client = apiClient;
+    }
+
+    public async myApiOperation(): Promise<Response> {
+        // Define the API endpoint
+        const url = `${this.client.apiClientOptions.basePath}/myDomain`;
+        // Build the request options: you can use the method 'prepareOptions' from the apiClient 
+        // that will apply the request plugins onto the default built options
+        const requestOptions: RequestOptions = await this.client.prepareOptions(...);
+        // Send the request and apply the response plugins
+        return this.client.processCall<Response>({
+            url,
+            requestOptions,
+            apiName: this.apiName,
+        });
+    }
+}
+```
+
+### ApiFetchClient instantiation
+```typescript
+const apiClientOptions: ApiClientOptions = {
+  basePath: 'https://my-example-api-server.com',
+  requestPlugins: [
+    // Add here the plugins that will be executed before the request is sent
+  ],
+  responsePlugins: [
+    // Add here the plugins that will be executed after the response is received and parsed
+  ]
+}
+
+// Instantiate the API Client
+const apiClient = new ApiFetchClient(apiClientOptions);
+```
+
+### API class instantiation
+
+```typescript
+// Once the API Client is intantiated, it can be given as a parameter to your API
+const myApi = new MyExampleApi(apiClient);
+
+// The API operations can now be invoked
+const myResponse = await myApi.myApiOperation();
+```
+
+
+## Plugins
+
+### Request plugins
+
+| Plugin name          | Description                                                                                                                                                                                                                                                                                                             |
+|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| additional-headers   | Adds multiple headers to a request.                                                                                                                                                                                                                                                                                     |
+| api-token            | Used for the SMS API with `servicePlanId`. It adds an `Authorization` header with the value of the API token as a `Bearer`.                                                                                                                                                                                             |
+| basic-authentication | Alternative to the `oauth2` plugin: less secure and to be used for prototyping only. It adds an `Authorization` header to the request to perform a `Basic` authentication.                                                                                                                                              |
+| oauth2               | Used by all the APIs that supports the `projectId` authentication scheme. If no token is available, it will make a query to the Sinch authentication server to get a new one, valid for 1 hour. Once a token is available, it will add a `Authorization` header to the request with the value fo the token as `Bearer`. |
+| signing              | Used by the `Verification` and `Voice` APIs: it adds an `Authorization` header containing the signature of the request.                                                                                                                                                                                                 |
+| version              | Add a `user-agent` header containing information such as the SDK version and the Node.js process version.<br>**Added by default to the ApiFetchClient**                                                                                                                                                                 |
+| x-timestamp          | Add the current date in ISO format in the `x-timesstamp` header (used by the `signing` plugin).                                                                                                                                                                                                                         |
+
+### Response plugins 
+
+| Plugin name | Description                                                                                                                                   |
+|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
+| exception   | Check the response content and converts it into an error if empty or if the status is not `ok`.<br>**Added by default to the ApiFetchClient** |
+
+## Contact
+Developer Experience team: [devexp@sinch.com](mailto:devexp@sinch.com)

package/dist/api/api-client-options-helper.js

@@ -0,0 +1,39 @@
+"use strict";
+// import { ApiTokenRequest, Oauth2TokenRequest, SigningRequest, XTimestampRequest } from '../plugins';
+// // import { ApiClientOptions } from './api-client-options';
+//
+// export const buildApiClientOptionsForProjectId = (
+//   projectId: string,
+//   keyId: string,
+//   keySecret: string,
+// ) => {
+//   return {
+//     projectId,
+//     requestPlugins: [new Oauth2TokenRequest(keyId, keySecret)],
+//     useServicePlanId: false,
+//   };
+// };
+//
+// export const  buildApiClientOptionForServicePlanId = (
+//   servicePlanId: string,
+//   apiToken: string,
+// ) => {
+//   return {
+//     projectId: servicePlanId,
+//     requestPlugins: [new ApiTokenRequest(apiToken)],
+//     useServicePlanId: true,
+//   };
+// };
+//
+// export const buildApiClientOptionForApplication = (
+//   applicationKey: string,
+//   applicationSecret: string,
+// ) => {
+//   return {
+//     requestPlugins: [
+//       new XTimestampRequest(),
+//       new SigningRequest(applicationKey, applicationSecret),
+//     ],
+//   };
+// };
+//# sourceMappingURL=api-client-options-helper.js.map

package/dist/api/api-client-options-helper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-client-options-helper.js","sourceRoot":"","sources":["../../src/api/api-client-options-helper.ts"],"names":[],"mappings":";AAAA,uGAAuG;AACvG,8DAA8D;AAC9D,EAAE;AACF,qDAAqD;AACrD,uBAAuB;AACvB,mBAAmB;AACnB,uBAAuB;AACvB,SAAS;AACT,aAAa;AACb,iBAAiB;AACjB,kEAAkE;AAClE,+BAA+B;AAC/B,OAAO;AACP,KAAK;AACL,EAAE;AACF,yDAAyD;AACzD,2BAA2B;AAC3B,sBAAsB;AACtB,SAAS;AACT,aAAa;AACb,gCAAgC;AAChC,uDAAuD;AACvD,8BAA8B;AAC9B,OAAO;AACP,KAAK;AACL,EAAE;AACF,sDAAsD;AACtD,4BAA4B;AAC5B,+BAA+B;AAC/B,SAAS;AACT,aAAa;AACb,wBAAwB;AACxB,iCAAiC;AACjC,+DAA+D;AAC/D,SAAS;AACT,OAAO;AACP,KAAK"}

package/dist/api/api-client-options.d.ts

@@ -0,0 +1,28 @@
+import { RequestPlugin, ResponsePlugin } from '../plugins';
+interface BaseApiClientOptions {
+    /**
+     * ID of the umbrella project containing the access keys
+     * Found on your <a href=\"https://dashboard.sinch.com/settings/project-management\" target=\"_blank\">Sinch Customer Dashboard</a>.
+     */
+    projectId: string;
+    /** Base path of the API server */
+    basePath: string;
+    /**
+     * List of plugins to apply to the request before calling the API
+     * @default [new Oauth2RequestPlugin()]
+     */
+    requestPlugins: RequestPlugin[];
+    /**
+     * List of plugins to apply to the response of the API call
+     * @default [new ExceptionResponse()]
+     */
+    responsePlugins: ResponsePlugin<any>[];
+    /** Some APIs have not been migrated fully to the 'projectId' structure and use another URL for their authentication
+     *  This flag indicates the API is not using the 'projectId'
+     *  @default false
+     */
+    useServicePlanId?: boolean;
+}
+export interface ApiClientOptions extends Partial<BaseApiClientOptions> {
+}
+export {};

package/dist/api/api-client-options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-client-options.js.map

package/dist/api/api-client-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-client-options.js","sourceRoot":"","sources":["../../src/api/api-client-options.ts"],"names":[],"mappings":""}

package/dist/api/api-client.d.ts

@@ -0,0 +1,104 @@
+import { RequestBody, RequestOptions } from '../plugins';
+import { ApiClientOptions } from './api-client-options';
+export declare enum PaginationEnum {
+    NONE = 0,
+    TOKEN = 1,
+    PAGE = 2
+}
+export interface ApiListPromise<T> extends Promise<PageResult<T>>, AsyncIterableIterator<T> {
+}
+export type PageResult<T> = {
+    data: Array<T>;
+    hasNextPage: boolean;
+    nextPageValue: string;
+    nextPage: () => ApiListPromise<T>;
+};
+export type AutoPaginationMethods<T> = {
+    next: () => Promise<IteratorResult<T>>;
+    return: () => void;
+    [Symbol.asyncIterator]: () => AutoPaginationMethods<T>;
+};
+export interface ApiCallParameters {
+    url: string;
+    requestOptions: RequestOptions;
+    apiName: string;
+    operationId: string;
+    circuitBreaker?: number;
+}
+export interface ApiCallParametersWithPagination extends ApiCallParameters {
+    pagination: PaginationEnum;
+    dataKey: string;
+    requestOptionsPromise?: Promise<RequestOptions>;
+}
+export interface PaginatedApiProperties {
+    /** Type of pagination: can be TOKEN or PAGE */
+    pagination: PaginationEnum;
+    /** Name of the API - for logging purposes */
+    apiName: string;
+    /** Operation identifier - for logging purposes */
+    operationId: string;
+    /** Name of the property holding the array of paginated data */
+    dataKey: string;
+}
+/**
+ * API Client used to call the server
+ */
+export declare class ApiClient {
+    /** Options for the API */
+    apiClientOptions: ApiClientOptions;
+    constructor(options: ApiClientOptions);
+    /**
+     * Returns a map containing the query parameters based on the provided data and names.
+     *
+     * @param {Object} data - The data object from which to extract query parameters.
+     * @param {Array.<string>} names - An array of keys (property names) to extract from the data object.
+     * @return {Object} A map containing the extracted query parameters.
+     */
+    extractQueryParams<T extends {
+        [key: string]: any;
+    }>(data: T, names: (keyof T)[]): {
+        [p in keyof T]: string;
+    };
+    /**
+     * Asynchronously prepares options for an HTTP request.
+     *
+     * @param {string} url - The URL for the HTTP request.
+     * @param {string} method - The HTTP method for the request (e.g., 'GET', 'POST').
+     * @param {Object.<string, (string | undefined)>} queryParams - An object representing query parameters.
+     * @param {Object.<string, (string | undefined)>} headers - An object representing headers.
+     * @param {RequestBody} [body] - The request body, if applicable.
+     * @param {string} [path] - An optional path for the request.
+     * @return {Promise<RequestOptions>} A promise that resolves to the prepared options for the HTTP request.
+     */
+    prepareOptions(url: string, method: string, queryParams: {
+        [key: string]: string | undefined;
+    }, headers: {
+        [key: string]: string | undefined;
+    }, body?: RequestBody, path?: string): Promise<RequestOptions>;
+    /**
+     * Prepares the url to be called by appending query parameters.
+     *
+     * @param {string} url - The base url to be used.
+     * @param {Object.<string, string|undefined>} queryParameters - Key-value pair with the parameters. If the value is undefined, the key is dropped.
+     * @return {string} The prepared URL as a string.
+     */
+    prepareUrl(url: string, queryParameters?: {
+        [key: string]: string | undefined;
+    }): string;
+    /**
+     * Process HTTP call
+     * @abstract
+     * @template T
+     * @param {ApiCallParameters} _httpCallParameters - Parameters for the HTTP call.
+     * @return {Promise<T>} A promise that resolves to the result of the HTTP call.
+     */
+    processCall<T>(_httpCallParameters: ApiCallParameters): Promise<T>;
+    /**
+     * Process HTTP call
+     * @abstract
+     * @template T
+     * @param {ApiCallParametersWithPagination} _httpCallParameters - Parameters for the HTTP call.
+     * @return {Promise<T>} A promise that resolves to the result of the HTTP call.
+     */
+    processCallWithPagination<T>(_httpCallParameters: ApiCallParametersWithPagination): Promise<PageResult<T>>;
+}

package/dist/api/api-client.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClient = exports.PaginationEnum = void 0;
+const node_fetch_1 = require("node-fetch");
+var PaginationEnum;
+(function (PaginationEnum) {
+    PaginationEnum[PaginationEnum["NONE"] = 0] = "NONE";
+    PaginationEnum[PaginationEnum["TOKEN"] = 1] = "TOKEN";
+    PaginationEnum[PaginationEnum["PAGE"] = 2] = "PAGE";
+})(PaginationEnum || (exports.PaginationEnum = PaginationEnum = {}));
+/**
+ * API Client used to call the server
+ */
+class ApiClient {
+    constructor(options) {
+        this.apiClientOptions = options;
+    }
+    /**
+     * Returns a map containing the query parameters based on the provided data and names.
+     *
+     * @param {Object} data - The data object from which to extract query parameters.
+     * @param {Array.<string>} names - An array of keys (property names) to extract from the data object.
+     * @return {Object} A map containing the extracted query parameters.
+     */
+    extractQueryParams(data, names) {
+        return names
+            .filter((name) => typeof data[name] !== 'undefined' && data[name] !== null)
+            .reduce((acc, name) => {
+            const prop = data[name];
+            acc[name] = typeof prop.toJSON === 'function'
+                ? prop.toJSON()
+                : Array.isArray(prop) ? prop.join(';') : prop.toString();
+            return acc;
+        }, {});
+    }
+    /**
+     * Asynchronously prepares options for an HTTP request.
+     *
+     * @param {string} url - The URL for the HTTP request.
+     * @param {string} method - The HTTP method for the request (e.g., 'GET', 'POST').
+     * @param {Object.<string, (string | undefined)>} queryParams - An object representing query parameters.
+     * @param {Object.<string, (string | undefined)>} headers - An object representing headers.
+     * @param {RequestBody} [body] - The request body, if applicable.
+     * @param {string} [path] - An optional path for the request.
+     * @return {Promise<RequestOptions>} A promise that resolves to the prepared options for the HTTP request.
+     */
+    async prepareOptions(url, method, queryParams, headers, body, path) {
+        const options = {
+            method,
+            headers: new node_fetch_1.Headers(filterUndefinedValues(headers)),
+            body,
+            queryParams: filterUndefinedValues(queryParams),
+            basePath: url,
+            path,
+        };
+        let opts = options;
+        if (this.apiClientOptions.requestPlugins) {
+            for (const plugin of this.apiClientOptions.requestPlugins) {
+                opts = await plugin.load().transform(opts);
+            }
+        }
+        return opts;
+    }
+    ;
+    /**
+     * Prepares the url to be called by appending query parameters.
+     *
+     * @param {string} url - The base url to be used.
+     * @param {Object.<string, string|undefined>} queryParameters - Key-value pair with the parameters. If the value is undefined, the key is dropped.
+     * @return {string} The prepared URL as a string.
+     */
+    prepareUrl(url, queryParameters = {}) {
+        const queryPart = Object.keys(queryParameters)
+            .filter((name) => typeof queryParameters[name] !== 'undefined')
+            .map((name) => `${name}=${queryParameters[name]}`)
+            .join('&');
+        const paramsPrefix = url.indexOf('?') > -1 ? '&' : '?';
+        return url + (!queryPart ? '' : paramsPrefix + queryPart);
+    }
+    /**
+     * Process HTTP call
+     * @abstract
+     * @template T
+     * @param {ApiCallParameters} _httpCallParameters - Parameters for the HTTP call.
+     * @return {Promise<T>} A promise that resolves to the result of the HTTP call.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    processCall(_httpCallParameters) {
+        throw new Error('Abstract method must be implemented');
+    }
+    /**
+     * Process HTTP call
+     * @abstract
+     * @template T
+     * @param {ApiCallParametersWithPagination} _httpCallParameters - Parameters for the HTTP call.
+     * @return {Promise<T>} A promise that resolves to the result of the HTTP call.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    processCallWithPagination(_httpCallParameters) {
+        throw new Error('Abstract method must be implemented');
+    }
+}
+exports.ApiClient = ApiClient;
+// ----- INTERNAL ------ \\
+/**
+ * Returns a filtered JSON object, removing all the undefined values.
+ *
+ * @param {Object.<string, string|undefined>} object - The JSON object to filter.
+ * @return {Object.<string, string>} An object without undefined values.
+ */
+function filterUndefinedValues(object) {
+    return Object.keys(object)
+        .filter((objectKey) => typeof object[objectKey] !== 'undefined')
+        .reduce((acc, objectKey) => {
+        acc[objectKey] = object[objectKey];
+        return acc;
+    }, {});
+}
+//# sourceMappingURL=api-client.js.map

package/dist/api/api-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../../src/api/api-client.ts"],"names":[],"mappings":";;;AAEA,2CAAqC;AAErC,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,mDAAI,CAAA;IACJ,qDAAK,CAAA;IACL,mDAAI,CAAA;AACN,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AA0CD;;GAEG;AACH,MAAa,SAAS;IAIpB,YAAY,OAAyB;QACnC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC;IAClC,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAChB,IAAO,EACP,KAAkB;QAElB,OAAO,KAAK;aACT,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,WAAW,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;aAC1E,MAAM,CACL,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACZ,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YACxB,GAAG,CAAC,IAAI,CAAC,GAAG,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU;gBAC3C,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE;gBACf,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3D,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAgC,CACjC,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAClB,GAAW,EACX,MAAc,EACd,WAAkD,EAClD,OAA8C,EAC9C,IAAkB,EAClB,IAAa;QAEb,MAAM,OAAO,GAAmB;YAC9B,MAAM;YACN,OAAO,EAAE,IAAI,oBAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;YACpD,IAAI;YACJ,WAAW,EAAE,qBAAqB,CAAC,WAAW,CAAC;YAC/C,QAAQ,EAAE,GAAG;YACb,IAAI;SACL,CAAC;QAEF,IAAI,IAAI,GAAG,OAAO,CAAC;QACnB,IAAI,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC;YACzC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,gBAAgB,CAAC,cAAc,EAAE,CAAC;gBAC1D,IAAI,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAAA,CAAC;IAEF;;;;;;OAMG;IACH,UAAU,CACR,GAAW,EACX,kBAAyD,EAAE;QAE3D,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC;aAC3C,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,eAAe,CAAC,IAAI,CAAC,KAAK,WAAW,CAAC;aAC9D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,IAAI,eAAe,CAAC,IAAI,CAAE,EAAE,CAAC;aAClD,IAAI,CAAC,GAAG,CAAC,CAAC;QAEb,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QAEvD,OAAO,GAAG,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACH,6DAA6D;IAC7D,WAAW,CAAI,mBAAsC;QACnD,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACH,6DAA6D;IAC7D,yBAAyB,CAAI,mBAAoD;QAC/E,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;CAGF;AArHD,8BAqHC;AAED,2BAA2B;AAC3B;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,MAA6C;IAG1E,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACvB,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,WAAW,CAAC;SAC/D,MAAM,CAA4B,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE;QACpD,GAAG,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,CAAW,CAAC;QAC7C,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC"}

package/dist/api/api-errors.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Generic error context
+ */
+export interface ErrorContext {
+    /** Api name */
+    apiName?: string;
+    /** Operation ID */
+    operationId?: string;
+    /** Base URL */
+    url?: string;
+    /** Origin domain initiating the call */
+    origin?: string | null;
+}
+/**
+ * Generic error class
+ */
+export declare class GenericError extends Error {
+    constructor(message: string, errorContext: ErrorContext);
+    private static formatUrl;
+}
+/**
+ * Request failed error class
+ */
+export declare class RequestFailedError<T> extends GenericError {
+    /**
+     * Request status code
+     */
+    statusCode: number;
+    /**
+     * Data decoded from the response body
+     */
+    data?: T;
+    constructor(message: string, statusCode: number, errorContext: ErrorContext, data?: T);
+}
+/**
+ * Empty response error class
+ */
+export declare class EmptyResponseError<T> extends GenericError {
+    /**
+     * Data decoded from the response body
+     */
+    data?: T;
+    constructor(message: string, errorContext: ErrorContext, data?: T);
+}
+/**
+ * Response parse error class
+ */
+export declare class ResponseJSONParseError extends RequestFailedError<string> {
+    constructor(message: string, httpStatus: number, errorContext: ErrorContext, bodyContent?: string);
+}

package/dist/api/api-errors.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResponseJSONParseError = exports.EmptyResponseError = exports.RequestFailedError = exports.GenericError = void 0;
+/**
+ * Generic error class
+ */
+class GenericError extends Error {
+    constructor(message, errorContext) {
+        const baseUrl = GenericError.formatUrl(errorContext.url);
+        const origin = GenericError.formatUrl(errorContext.origin);
+        super(`[SDK] [apiName: ${errorContext.apiName || 'unknown'}]
+        [operationId: ${errorContext.operationId || 'unknown'}] 
+        [baseUrl: ${baseUrl}] [origin: ${origin}] [errorType: SDK] ${message}`);
+    }
+    static formatUrl(url) {
+        const httpRegexp = /^https?:\/\//;
+        return url ? url.replace(httpRegexp, '') : 'unknown';
+    }
+}
+exports.GenericError = GenericError;
+/**
+ * Request failed error class
+ */
+class RequestFailedError extends GenericError {
+    constructor(message, statusCode, errorContext, data) {
+        super(`[status: ${statusCode}] ${message}`, errorContext);
+        this.statusCode = statusCode;
+        this.data = data;
+    }
+}
+exports.RequestFailedError = RequestFailedError;
+/**
+ * Empty response error class
+ */
+class EmptyResponseError extends GenericError {
+    constructor(message, errorContext, data) {
+        super(`[Empty response] ${message}`, errorContext);
+        this.data = data;
+    }
+}
+exports.EmptyResponseError = EmptyResponseError;
+/**
+ * Response parse error class
+ */
+class ResponseJSONParseError extends RequestFailedError {
+    constructor(message, httpStatus, errorContext, bodyContent) {
+        super(`[Response JSON parse error] ${message}`, httpStatus, errorContext, bodyContent);
+    }
+}
+exports.ResponseJSONParseError = ResponseJSONParseError;
+//# sourceMappingURL=api-errors.js.map

package/dist/api/api-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-errors.js","sourceRoot":"","sources":["../../src/api/api-errors.ts"],"names":[],"mappings":";;;AAcA;;GAEG;AACH,MAAa,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe,EAAE,YAA0B;QACrD,MAAM,OAAO,GAAG,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC3D,KAAK,CACH,mBAAmB,YAAY,CAAC,OAAO,IAAI,SAAS;wBAClC,YAAY,CAAC,WAAW,IAAI,SAAS;oBACzC,OAAO,cAAc,MAAM,sBAAsB,OAAO,EAAE,CACzE,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,SAAS,CAAC,GAA8B;QACrD,MAAM,UAAU,GAAG,cAAc,CAAC;QAClC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvD,CAAC;CAEF;AAhBD,oCAgBC;AAED;;GAEG;AACH,MAAa,kBAAsB,SAAQ,YAAY;IAWrD,YACE,OAAe,EACf,UAAkB,EAClB,YAA0B,EAC1B,IAAQ;QAER,KAAK,CAAC,YAAY,UAAU,KAAK,OAAO,EAAE,EAAE,YAAY,CAAC,CAAC;QAC1D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AArBD,gDAqBC;AAED;;GAEG;AACH,MAAa,kBAAsB,SAAQ,YAAY;IAMrD,YAAY,OAAe,EAAE,YAA0B,EAAE,IAAQ;QAC/D,KAAK,CAAC,oBAAoB,OAAO,EAAE,EAAE,YAAY,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAVD,gDAUC;AAED;;GAEG;AACH,MAAa,sBAAuB,SAAQ,kBAA0B;IACpE,YACE,OAAe,EACf,UAAkB,EAClB,YAA0B,EAC1B,WAAoB;QAEpB,KAAK,CACH,+BAA+B,OAAO,EAAE,EACxC,UAAU,EACV,YAAY,EACZ,WAAW,CACZ,CAAC;IACJ,CAAC;CACF;AAdD,wDAcC"}

package/dist/api/api-interface.d.ts

@@ -0,0 +1,8 @@
+import { ApiClient } from './api-client';
+/** API interface */
+export interface Api {
+    /** API name */
+    apiName: string;
+    /** API Client used to process the calls to the API */
+    client?: ApiClient;
+}

package/dist/api/api-interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-interface.js.map

package/dist/api/api-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-interface.js","sourceRoot":"","sources":["../../src/api/api-interface.ts"],"names":[],"mappings":""}

package/dist/api/index.d.ts

@@ -0,0 +1,4 @@
+export * from './api-client-options';
+export * from './api-client';
+export * from './api-errors';
+export * from './api-interface';

package/dist/api/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-client-options"), exports);
+// export * from './api-client-options-helper';
+__exportStar(require("./api-client"), exports);
+__exportStar(require("./api-errors"), exports);
+__exportStar(require("./api-interface"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,+CAA+C;AAC/C,+CAA6B;AAC7B,+CAA6B;AAC7B,kDAAgC"}

package/dist/client/api-client-helpers.d.ts

@@ -0,0 +1,5 @@
+import { RequestOptions, RequestPlugin } from '../plugins';
+import { ApiCallParameters, ApiCallParametersWithPagination, ErrorContext } from '../api';
+export declare const manageExpiredToken: (apiCallParameters: ApiCallParameters | ApiCallParametersWithPagination, errorContext: ErrorContext, requestPlugins: RequestPlugin[] | undefined, requestOptions: RequestOptions, callback: (props: any) => Promise<any>) => Promise<any>;
+export declare function buildErrorContext(apiCallParameters: ApiCallParameters, origin: string | null): ErrorContext;
+export declare function invalidateAndRegenerateJwt(requestPlugins: RequestPlugin[] | undefined, options: RequestOptions, errorContext: ErrorContext): Promise<RequestOptions>;

package/dist/client/api-client-helpers.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invalidateAndRegenerateJwt = exports.buildErrorContext = exports.manageExpiredToken = void 0;
+const plugins_1 = require("../plugins");
+const api_1 = require("../api");
+const manageExpiredToken = async (apiCallParameters, errorContext, requestPlugins, requestOptions, callback) => {
+    // Use the circuitBreaker variable to try to regenerate a valid JWT only 3 times
+    if (!apiCallParameters.circuitBreaker) {
+        apiCallParameters.circuitBreaker = 1;
+    }
+    else {
+        apiCallParameters.circuitBreaker++;
+        // Check the circuitBreaker value: if greater than 3, then we stop and throw
+        if (apiCallParameters.circuitBreaker >= 3) {
+            throw new api_1.GenericError('Tried to generate a new JWT with no success', errorContext);
+        }
+    }
+    const optionsWithNewJwt = await invalidateAndRegenerateJwt(requestPlugins, requestOptions, errorContext);
+    const newApiCallParameters = {
+        ...apiCallParameters,
+        requestOptions: optionsWithNewJwt,
+    };
+    return callback(newApiCallParameters);
+};
+exports.manageExpiredToken = manageExpiredToken;
+function buildErrorContext(apiCallParameters, origin) {
+    return {
+        apiName: apiCallParameters.apiName,
+        operationId: apiCallParameters.operationId,
+        url: apiCallParameters.url,
+        origin,
+    };
+}
+exports.buildErrorContext = buildErrorContext;
+async function invalidateAndRegenerateJwt(requestPlugins, options, errorContext) {
+    const oauth2Plugin = requestPlugins?.find((plugin) => plugin instanceof plugins_1.Oauth2TokenRequest);
+    if (oauth2Plugin) {
+        oauth2Plugin.invalidateToken();
+        return oauth2Plugin.load().transform(options);
+    }
+    else {
+        const errorMessage = 'Trying to invalidate an expired JWT while the Oauth2Token plugin is not registered to the API client';
+        throw new api_1.GenericError(errorMessage, errorContext);
+    }
+}
+exports.invalidateAndRegenerateJwt = invalidateAndRegenerateJwt;
+//# sourceMappingURL=api-client-helpers.js.map

package/dist/client/api-client-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-client-helpers.js","sourceRoot":"","sources":["../../src/client/api-client-helpers.ts"],"names":[],"mappings":";;;AAAA,wCAIoB;AACpB,gCAAwG;AAEjG,MAAM,kBAAkB,GAAG,KAAK,EACrC,iBAAsE,EACtE,YAA0B,EAC1B,cAA2C,EAC3C,cAA8B,EAC9B,QAAsC,EACtC,EAAE;IACF,gFAAgF;IAChF,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;QACtC,iBAAiB,CAAC,cAAc,GAAG,CAAC,CAAC;IACvC,CAAC;SAAM,CAAC;QACN,iBAAiB,CAAC,cAAc,EAAE,CAAC;QACnC,4EAA4E;QAC5E,IAAI,iBAAiB,CAAC,cAAc,IAAI,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,kBAAY,CACpB,6CAA6C,EAC7C,YAAY,CACb,CAAC;QACJ,CAAC;IACH,CAAC;IACD,MAAM,iBAAiB,GAAG,MAAM,0BAA0B,CAAC,cAAc,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;IACzG,MAAM,oBAAoB,GAAG;QAC3B,GAAG,iBAAiB;QACpB,cAAc,EAAE,iBAAiB;KAClC,CAAC;IACF,OAAO,QAAQ,CAAC,oBAAoB,CAAC,CAAC;AACxC,CAAC,CAAC;AA1BW,QAAA,kBAAkB,sBA0B7B;AAEF,SAAgB,iBAAiB,CAC/B,iBAAoC,EACpC,MAAqB;IAErB,OAAO;QACL,OAAO,EAAE,iBAAiB,CAAC,OAAO;QAClC,WAAW,EAAE,iBAAiB,CAAC,WAAW;QAC1C,GAAG,EAAE,iBAAiB,CAAC,GAAG;QAC1B,MAAM;KACP,CAAC;AACJ,CAAC;AAVD,8CAUC;AAEM,KAAK,UAAU,0BAA0B,CAC9C,cAA2C,EAC3C,OAAuB,EACvB,YAA0B;IAE1B,MAAM,YAAY,GAAG,cAAc,EAAE,IAAI,CACvC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,YAAY,4BAAkB,CAC3B,CAAC;IACxB,IAAI,YAAY,EAAE,CAAC;QACjB,YAAY,CAAC,eAAe,EAAE,CAAC;QAC/B,OAAO,YAAY,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAChD,CAAC;SAAM,CAAC;QACN,MAAM,YAAY,GACd,sGAAsG,CAAC;QAC3G,MAAM,IAAI,kBAAY,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IACrD,CAAC;AACH,CAAC;AAhBD,gEAgBC"}