@arrowsphere/api-client 3.28.0 → 3.29.0-rc.jpb.1

package/README.md

@@ -50,6 +50,18 @@ The output documentation should be located in the `docs/` folder, just open the
 
 - [CheckDomain](./src/general/CHECKDOMAIN.md)
 - [WhoAmI](./src/general/WHOAMI.md)
+- [Campaign](./src/campaign/README.md)
+- [Cart](./src/cart/README.md)
+- [Catalog](./src/catalog/README.md)
+- [Consumption](./src/consumption/README.md)
+- [Contact](./src/contact/README.md)
+- [Customers](./src/customers/README.md)
+- [Licenses](./src/licenses/README.md)
+- [Orders](./src/orders/README.md)
+- [Subscriptions](./src/subscriptions/README.md)
+- [Support Center](./src/supportCenter/README.md)
+
+- [SecurityScore](./src/securityScore/README.md)
 
 ### Licenses
 

package/build/AbstractHttpClient.d.ts

@@ -0,0 +1,47 @@
+import { HttpExceptionHandler, HandleHttpExceptionOutput } from './exception/exception-handlers';
+import { PublicApiClientException } from './exception';
+export declare enum HttpClientSecurity {
+    TOKEN = "token",
+    API_KEY = "apikey"
+}
+export declare abstract class AbstractHttpClient {
+    /**
+     * Base path for HTTP calls
+     */
+    protected basePath: string;
+    /**
+     * Current path for HTTP calls
+     */
+    protected path: string;
+    /**
+     * Token to authenticate the user
+     */
+    protected token: string;
+    /**
+     * ArrowSphere API URL
+     */
+    protected url: string;
+    /**
+     * Http Exceptions Handlers
+     */
+    protected httpExceptionHandlers: HttpExceptionHandler[];
+    /**
+     * Security used to auth on server
+     * Default to API_KEY to handle
+     * the existing codebase
+     */
+    protected security: HttpClientSecurity;
+    setToken(token: string): this;
+    setUrl(url: string): this;
+    setSecurity(security: HttpClientSecurity): this;
+    /**
+     * Allow to register error/exception handler.
+     * Handlers can be developed in another projects as long as they respect the interface HttpExceptionHandler.
+     */
+    registerHttpExceptionHandler(handler: HttpExceptionHandler): this;
+    /**
+     * Will find appropriate ErrorHandlers and apply them to the error in order of registering.
+     */
+    protected handleError(error: PublicApiClientException): Promise<HandleHttpExceptionOutput>;
+    protected mapToPublicApiException(error: any): PublicApiClientException;
+}

package/build/AbstractHttpClient.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractHttpClient = exports.HttpClientSecurity = void 0;
+const exception_1 = require("./exception");
+var HttpClientSecurity;
+(function (HttpClientSecurity) {
+    HttpClientSecurity["TOKEN"] = "token";
+    HttpClientSecurity["API_KEY"] = "apikey";
+})(HttpClientSecurity = exports.HttpClientSecurity || (exports.HttpClientSecurity = {}));
+class AbstractHttpClient {
+    constructor() {
+        /**
+         * Base path for HTTP calls
+         */
+        this.basePath = '';
+        /**
+         * Current path for HTTP calls
+         */
+        this.path = '';
+        /**
+         * Token to authenticate the user
+         */
+        this.token = '';
+        /**
+         * ArrowSphere API URL
+         */
+        this.url = '';
+        /**
+         * Http Exceptions Handlers
+         */
+        this.httpExceptionHandlers = [];
+        /**
+         * Security used to auth on server
+         * Default to API_KEY to handle
+         * the existing codebase
+         */
+        this.security = HttpClientSecurity.API_KEY;
+    }
+    setToken(token) {
+        this.token = token;
+        return this;
+    }
+    setUrl(url) {
+        this.url = url;
+        return this;
+    }
+    setSecurity(security) {
+        this.security = security;
+        return this;
+    }
+    /**
+     * Allow to register error/exception handler.
+     * Handlers can be developed in another projects as long as they respect the interface HttpExceptionHandler.
+     */
+    registerHttpExceptionHandler(handler) {
+        this.httpExceptionHandlers.push(handler);
+        return this;
+    }
+    /**
+     * Will find appropriate ErrorHandlers and apply them to the error in order of registering.
+     */
+    async handleError(error) {
+        const appropriateHandlers = this.httpExceptionHandlers.filter((handler) => handler.getHandledHttpStatuses().includes(error.httpCode));
+        // handle retry
+        const output = { mustRetry: false };
+        for (const handler of appropriateHandlers) {
+            const res = await handler.handle(error, {
+                setToken: this.setToken,
+            });
+            output.mustRetry = res.mustRetry;
+        }
+        return output;
+    }
+    mapToPublicApiException(error) {
+        var _a, _b;
+        return new exception_1.PublicApiClientException(error === null || error === void 0 ? void 0 : error.message, String(error), (_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.status, (_b = error === null || error === void 0 ? void 0 : error.response) === null || _b === void 0 ? void 0 : _b.config);
+    }
+}
+exports.AbstractHttpClient = AbstractHttpClient;
+//# sourceMappingURL=AbstractHttpClient.js.map

package/build/abstractClient.d.ts

@@ -1,9 +1,11 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
+import { AbstractHttpClient } from './AbstractHttpClient';
 /**
  * Lists of available query parameters for the API call
  */
 export declare enum ParameterKeys {
     API_KEY = "apiKey",
+    AUTHORIZATION = "Authorization",
     HEADERS = "headers",
     ORDER_BY = "order_by",
     PAGE = "page",
@@ -36,23 +38,11 @@ export declare type ConfigurationsClient = {
 export declare type ExtraInformationType = {
     [ExtraInformationFields.COLUMN_EXTRA_INFORMATION]?: Record<string, unknown>;
 };
-export declare abstract class AbstractClient {
-    /**
-     * Base path for HTTP calls
-     */
-    protected basePath: string;
-    /**
-     * Current path for HTTP calls
-     */
-    protected path: string;
+export declare abstract class AbstractClient extends AbstractHttpClient {
     /**
      * Axios instance for client
      */
     protected client: AxiosInstance;
-    /**
-     * ArrowSphere API URL
-     */
-    protected url: string;
     /**
      * ArrowSphere API key
      */
@@ -84,12 +74,6 @@ export declare abstract class AbstractClient {
      * @returns this
      */
     setApiKey(key: string): this;
-    /**
-     * Sets the client ArrowSphere API url
-     * @param url - API url
-     * @returns this
-     */
-    setUrl(url: string): this;
     /**
      * Returns the API url.
      * @returns string

package/build/abstractClient.js

@@ -9,12 +9,14 @@ const querystring_1 = __importDefault(require("querystring"));
 const url_1 = require("url");
 const path_1 = __importDefault(require("path"));
 const axiosSingleton_1 = require("./axiosSingleton");
+const AbstractHttpClient_1 = require("./AbstractHttpClient");
 /**
  * Lists of available query parameters for the API call
  */
 var ParameterKeys;
 (function (ParameterKeys) {
     ParameterKeys["API_KEY"] = "apiKey";
+    ParameterKeys["AUTHORIZATION"] = "Authorization";
     ParameterKeys["HEADERS"] = "headers";
     ParameterKeys["ORDER_BY"] = "order_by";
     ParameterKeys["PAGE"] = "page";
@@ -27,25 +29,14 @@ var ExtraInformationFields;
 (function (ExtraInformationFields) {
     ExtraInformationFields["COLUMN_EXTRA_INFORMATION"] = "extraInformation";
 })(ExtraInformationFields = exports.ExtraInformationFields || (exports.ExtraInformationFields = {}));
-class AbstractClient {
+class AbstractClient extends AbstractHttpClient_1.AbstractHttpClient {
     /**
      * AbstractClient constructor.
      * @returns AbstractClient
      */
     constructor(configuration) {
         var _a, _b, _c;
-        /**
-         * Base path for HTTP calls
-         */
-        this.basePath = '';
-        /**
-         * Current path for HTTP calls
-         */
-        this.path = '';
-        /**
-         * ArrowSphere API URL
-         */
-        this.url = '';
+        super();
         /**
          * ArrowSphere API key
          */
@@ -80,15 +71,6 @@ class AbstractClient {
         this.apiKey = key;
         return this;
     }
-    /**
-     * Sets the client ArrowSphere API url
-     * @param url - API url
-     * @returns this
-     */
-    setUrl(url) {
-        this.url = url;
-        return this;
-    }
     /**
      * Returns the API url.
      * @returns string
@@ -157,9 +139,12 @@ class AbstractClient {
      * @returns {@link Headers}
      */
     prepareHeaders(headers) {
+        const securityHeader = this.security === AbstractHttpClient_1.HttpClientSecurity.API_KEY
+            ? { [ParameterKeys.API_KEY]: this.apiKey }
+            : { [ParameterKeys.AUTHORIZATION]: this.token };
         return {
             ...headers,
-            [ParameterKeys.API_KEY]: this.apiKey,
+            ...securityHeader,
             ...this.headers,
         };
     }

package/build/abstractEntity.js

@@ -1,21 +1,19 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to set private field on non-instance");
-    }
-    privateMap.set(receiver, value);
-    return value;
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to get private field on non-instance");
-    }
-    return privateMap.get(receiver);
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-var _entityDataInput;
+var _AbstractEntity_entityDataInput;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractEntity = void 0;
 const validatorjs_1 = __importDefault(require("validatorjs"));
@@ -29,7 +27,7 @@ class AbstractEntity {
      * @param data - Data that will be used in the Entity
      */
     constructor(data) {
-        _entityDataInput.set(this, void 0);
+        _AbstractEntity_entityDataInput.set(this, void 0);
         this.VALIDATION_RULES = {};
         this.VALIDATION_MESSAGES = {};
         /**
@@ -37,10 +35,10 @@ class AbstractEntity {
          */
         this.enableValidation = false;
         this.validate(data);
-        __classPrivateFieldSet(this, _entityDataInput, data);
+        __classPrivateFieldSet(this, _AbstractEntity_entityDataInput, data, "f");
     }
     get entityDataInput() {
-        return __classPrivateFieldGet(this, _entityDataInput);
+        return __classPrivateFieldGet(this, _AbstractEntity_entityDataInput, "f");
     }
     /**
      * Checks whether or not the entity data passes the validation rules
@@ -68,5 +66,5 @@ class AbstractEntity {
     }
 }
 exports.AbstractEntity = AbstractEntity;
-_entityDataInput = new WeakMap();
+_AbstractEntity_entityDataInput = new WeakMap();
 //# sourceMappingURL=abstractEntity.js.map

package/build/abstractGraphQLClient.d.ts

@@ -2,26 +2,16 @@ import { GraphQLClient } from 'graphql-request';
 import * as Dom from 'graphql-request/dist/types.dom';
 import { Options } from './abstractClient';
 import { GetProductsType } from './catalog';
+import { AbstractHttpClient } from './AbstractHttpClient';
 export declare type GraphQLResponseTypes = GetProductsType;
-export declare abstract class AbstractGraphQLClient {
-    /**
-     * Base path for HTTP calls
-     */
-    protected basePath: string;
-    /**
-     * Current path for HTTP calls
-     */
-    protected path: string;
+export declare abstract class AbstractGraphQLClient extends AbstractHttpClient {
     protected client: GraphQLClient;
-    protected url: string;
-    protected token: string;
     protected optionsHeader?: Dom.RequestInit['headers'];
     protected options: Options;
     private getClient;
-    setToken(apiKey: string): this;
-    setUrl(url: string): this;
     setOptionsHeader(options: Dom.RequestInit['headers']): this;
     setOptions(options: Options): this;
-    protected post(query: string): Promise<GraphQLResponseTypes>;
+    protected post<GraphQLResponseTypes>(query: string): Promise<GraphQLResponseTypes>;
     protected generateUrl(): string;
+    protected stringifyQuery(query: any): string;
 }

package/build/abstractGraphQLClient.js

@@ -1,38 +1,42 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractGraphQLClient = void 0;
 const graphql_request_1 = require("graphql-request");
-const url_1 = require("url");
-const path_1 = __importDefault(require("path"));
-class AbstractGraphQLClient {
+const path = __importStar(require("path"));
+const json_to_graphql_query_1 = require("json-to-graphql-query");
+const AbstractHttpClient_1 = require("./AbstractHttpClient");
+class AbstractGraphQLClient extends AbstractHttpClient_1.AbstractHttpClient {
     constructor() {
-        /**
-         * Base path for HTTP calls
-         */
-        this.basePath = '';
-        /**
-         * Current path for HTTP calls
-         */
-        this.path = '';
-        this.url = '';
-        this.token = '';
+        super(...arguments);
         this.options = {};
     }
     getClient() {
         this.client = new graphql_request_1.GraphQLClient(this.generateUrl());
         return this;
     }
-    setToken(apiKey) {
-        this.token = apiKey;
-        return this;
-    }
-    setUrl(url) {
-        this.url = url;
-        return this;
-    }
     setOptionsHeader(options) {
         this.optionsHeader = options;
         return this;
@@ -49,9 +53,13 @@ class AbstractGraphQLClient {
         return await this.client.request(query);
     }
     generateUrl() {
-        const url = new url_1.URL(`${this.options.isAdmin ? path_1.default.join('admin', this.basePath) : this.basePath}${this.path}`, this.url);
+        const url = new URL(`${this.options.isAdmin ? path.join('admin', this.basePath) : this.basePath}${this.path}`, this.url);
         return url.toString();
     }
+    stringifyQuery(query) {
+        const graphqlQuery = (0, json_to_graphql_query_1.jsonToGraphQLQuery)(query);
+        return `{${graphqlQuery}}`;
+    }
 }
 exports.AbstractGraphQLClient = AbstractGraphQLClient;
 //# sourceMappingURL=abstractGraphQLClient.js.map

package/build/axiosSingleton.js

@@ -41,7 +41,7 @@ class AxiosSingleton {
      */
     static cleanRequestLog(request) {
         var _a;
-        const tempRequest = lodash_1.cloneDeep(request);
+        const tempRequest = (0, lodash_1.cloneDeep)(request);
         // coverage bug delete undefined element
         /* istanbul ignore next */
         (_a = tempRequest.headers) === null || _a === void 0 ? true : delete _a.apiKey;
@@ -52,7 +52,7 @@ class AxiosSingleton {
      */
     static cleanResponseLog(response) {
         var _a;
-        const tempResponse = lodash_1.cloneDeep(response);
+        const tempResponse = (0, lodash_1.cloneDeep)(response);
         // coverage bug delete undefined element
         /* istanbul ignore next */
         (_a = tempResponse.config.headers) === null || _a === void 0 ? true : delete _a.apiKey;

package/build/campaign/entities/campaign/banners/banners.js

@@ -1,18 +1,16 @@
 "use strict";
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, privateMap, value) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to set private field on non-instance");
-    }
-    privateMap.set(receiver, value);
-    return value;
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, privateMap) {
-    if (!privateMap.has(receiver)) {
-        throw new TypeError("attempted to get private field on non-instance");
-    }
-    return privateMap.get(receiver);
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _backgroundImageUuid, _type, _buttonPlacement, _buttonText, _text, _textColor, _backgroundColor;
+var _Banners_backgroundImageUuid, _Banners_type, _Banners_buttonPlacement, _Banners_buttonText, _Banners_text, _Banners_textColor, _Banners_backgroundColor;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Banners = exports.BannersFields = void 0;
 const abstractEntity_1 = require("../../../../abstractEntity");
@@ -29,41 +27,41 @@ var BannersFields;
 class Banners extends abstractEntity_1.AbstractEntity {
     constructor(bannerInput) {
         super(bannerInput);
-        _backgroundImageUuid.set(this, void 0);
-        _type.set(this, void 0);
-        _buttonPlacement.set(this, void 0);
-        _buttonText.set(this, void 0);
-        _text.set(this, void 0);
-        _textColor.set(this, void 0);
-        _backgroundColor.set(this, void 0);
-        __classPrivateFieldSet(this, _backgroundImageUuid, bannerInput[BannersFields.COLUMN_BACKGROUND_IMAGE_UUID]);
-        __classPrivateFieldSet(this, _type, bannerInput[BannersFields.COLUMN_TYPE]);
-        __classPrivateFieldSet(this, _buttonPlacement, bannerInput[BannersFields.COLUMN_BUTTON_PLACEMENT]);
-        __classPrivateFieldSet(this, _buttonText, bannerInput[BannersFields.COLUMN_BUTTON_TEXT]);
-        __classPrivateFieldSet(this, _text, bannerInput[BannersFields.COLUMN_TEXT]);
-        __classPrivateFieldSet(this, _textColor, bannerInput[BannersFields.COLUMN_TEXT_COLOR]);
-        __classPrivateFieldSet(this, _backgroundColor, bannerInput[BannersFields.COLUMN_BACKGROUND_COLOR]);
+        _Banners_backgroundImageUuid.set(this, void 0);
+        _Banners_type.set(this, void 0);
+        _Banners_buttonPlacement.set(this, void 0);
+        _Banners_buttonText.set(this, void 0);
+        _Banners_text.set(this, void 0);
+        _Banners_textColor.set(this, void 0);
+        _Banners_backgroundColor.set(this, void 0);
+        __classPrivateFieldSet(this, _Banners_backgroundImageUuid, bannerInput[BannersFields.COLUMN_BACKGROUND_IMAGE_UUID], "f");
+        __classPrivateFieldSet(this, _Banners_type, bannerInput[BannersFields.COLUMN_TYPE], "f");
+        __classPrivateFieldSet(this, _Banners_buttonPlacement, bannerInput[BannersFields.COLUMN_BUTTON_PLACEMENT], "f");
+        __classPrivateFieldSet(this, _Banners_buttonText, bannerInput[BannersFields.COLUMN_BUTTON_TEXT], "f");
+        __classPrivateFieldSet(this, _Banners_text, bannerInput[BannersFields.COLUMN_TEXT], "f");
+        __classPrivateFieldSet(this, _Banners_textColor, bannerInput[BannersFields.COLUMN_TEXT_COLOR], "f");
+        __classPrivateFieldSet(this, _Banners_backgroundColor, bannerInput[BannersFields.COLUMN_BACKGROUND_COLOR], "f");
     }
     get backgroundImageUuid() {
-        return __classPrivateFieldGet(this, _backgroundImageUuid);
+        return __classPrivateFieldGet(this, _Banners_backgroundImageUuid, "f");
     }
     get backgroundColor() {
-        return __classPrivateFieldGet(this, _backgroundColor);
+        return __classPrivateFieldGet(this, _Banners_backgroundColor, "f");
     }
     get type() {
-        return __classPrivateFieldGet(this, _type);
+        return __classPrivateFieldGet(this, _Banners_type, "f");
     }
     get buttonPlacement() {
-        return __classPrivateFieldGet(this, _buttonPlacement);
+        return __classPrivateFieldGet(this, _Banners_buttonPlacement, "f");
     }
     get buttonText() {
-        return __classPrivateFieldGet(this, _buttonText);
+        return __classPrivateFieldGet(this, _Banners_buttonText, "f");
     }
     get text() {
-        return __classPrivateFieldGet(this, _text);
+        return __classPrivateFieldGet(this, _Banners_text, "f");
     }
     get textColor() {
-        return __classPrivateFieldGet(this, _textColor);
+        return __classPrivateFieldGet(this, _Banners_textColor, "f");
     }
     toJSON() {
         return {
@@ -78,5 +76,5 @@ class Banners extends abstractEntity_1.AbstractEntity {
     }
 }
 exports.Banners = Banners;
-_backgroundImageUuid = new WeakMap(), _type = new WeakMap(), _buttonPlacement = new WeakMap(), _buttonText = new WeakMap(), _text = new WeakMap(), _textColor = new WeakMap(), _backgroundColor = new WeakMap();
+_Banners_backgroundImageUuid = new WeakMap(), _Banners_type = new WeakMap(), _Banners_buttonPlacement = new WeakMap(), _Banners_buttonText = new WeakMap(), _Banners_text = new WeakMap(), _Banners_textColor = new WeakMap(), _Banners_backgroundColor = new WeakMap();
 //# sourceMappingURL=banners.js.map