@arrowsphere/api-client 3.30.0-rc-jpb.1 → 3.30.0-rc-jpb.4

package/build/AbstractHttpClient.d.ts

@@ -4,6 +4,7 @@ export declare enum HttpClientSecurity {
     TOKEN = "token",
     API_KEY = "apikey"
 }
+export declare type Headers = Record<string, string>;
 export declare abstract class AbstractHttpClient {
     /**
      * Base path for HTTP calls
@@ -21,6 +22,10 @@ export declare abstract class AbstractHttpClient {
      * ArrowSphere API URL
      */
     protected url: string;
+    /**
+     * Defines header information for http requests
+     */
+    protected headers: Headers;
     /**
      * Http Exceptions Handlers
      */
@@ -34,11 +39,26 @@ export declare abstract class AbstractHttpClient {
     setToken(token: string): this;
     setUrl(url: string): this;
     setSecurity(security: HttpClientSecurity): this;
+    /**
+     * Warning: can remove useful headers, prefer use mergeHeaders()
+     * @param headers
+     */
+    setHeaders(headers: Record<string, string>): this;
+    /**
+     * Will merge existing headers with those in parameters.
+     * If There is key equality, the header passed as parameter has priority.
+     * @param headers
+     */
+    mergeHeaders(headers: Record<string, string>): 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;
+    /**
+     * Allow to set error handlers.
+     */
+    setHttpExceptionHandlers(handlers: HttpExceptionHandler[]): this;
     /**
      * Will find appropriate ErrorHandlers and apply them to the error in order of registering.
      */

package/build/AbstractHttpClient.js

@@ -25,6 +25,10 @@ class AbstractHttpClient {
          * ArrowSphere API URL
          */
         this.url = '';
+        /**
+         * Defines header information for http requests
+         */
+        this.headers = {};
         /**
          * Http Exceptions Handlers
          */
@@ -48,6 +52,27 @@ class AbstractHttpClient {
         this.security = security;
         return this;
     }
+    /**
+     * Warning: can remove useful headers, prefer use mergeHeaders()
+     * @param headers
+     */
+    setHeaders(headers) {
+        this.headers = headers;
+        return this;
+    }
+    /**
+     * Will merge existing headers with those in parameters.
+     * If There is key equality, the header passed as parameter has priority.
+     * @param headers
+     */
+    mergeHeaders(headers) {
+        const mergedHeaders = {
+            ...this.headers,
+            ...headers,
+        };
+        this.setHeaders(mergedHeaders);
+        return this;
+    }
     /**
      * Allow to register error/exception handler.
      * Handlers can be developed in another projects as long as they respect the interface HttpExceptionHandler.
@@ -56,6 +81,13 @@ class AbstractHttpClient {
         this.httpExceptionHandlers.push(handler);
         return this;
     }
+    /**
+     * Allow to set error handlers.
+     */
+    setHttpExceptionHandlers(handlers) {
+        this.httpExceptionHandlers = handlers;
+        return this;
+    }
     /**
      * Will find appropriate ErrorHandlers and apply them to the error in order of registering.
      */

package/build/abstractGraphQLClient.d.ts

@@ -5,13 +5,17 @@ import { GetProductsType } from './catalog';
 import { AbstractHttpClient } from './AbstractHttpClient';
 export declare type GraphQLResponseTypes = GetProductsType;
 export declare abstract class AbstractGraphQLClient extends AbstractHttpClient {
-    protected client: GraphQLClient;
+    /**
+     * Must not be called directly.
+     * Use getClientInstance() to access it.
+     * @protected
+     */
+    protected graphQLClient: GraphQLClient;
     protected optionsHeader?: Dom.RequestInit['headers'];
     protected options: Options;
-    private getClient;
-    setOptionsHeader(options: Dom.RequestInit['headers']): this;
+    private getClientInstance;
     setOptions(options: Options): this;
     protected post<GraphQLResponseTypes>(query: string): Promise<GraphQLResponseTypes>;
-    protected generateUrl(): string;
+    private generateUrl;
     protected stringifyQuery(query: any): string;
 }

package/build/abstractGraphQLClient.js

@@ -33,24 +33,21 @@ class AbstractGraphQLClient extends AbstractHttpClient_1.AbstractHttpClient {
         super(...arguments);
         this.options = {};
     }
-    getClient() {
-        this.client = new graphql_request_1.GraphQLClient(this.generateUrl());
-        return this;
-    }
-    setOptionsHeader(options) {
-        this.optionsHeader = options;
-        return this;
+    getClientInstance() {
+        var _a;
+        return ((_a = this.graphQLClient) !== null && _a !== void 0 ? _a : (this.graphQLClient = new graphql_request_1.GraphQLClient(this.generateUrl())));
     }
     setOptions(options) {
         this.options = options;
         return this;
     }
     async post(query) {
-        this.getClient().client.setHeaders({
+        const headers = {
             authorization: this.token,
-            ...this.optionsHeader,
-        });
-        return await this.client.request(query);
+            ...this.headers,
+        };
+        this.getClientInstance().setHeaders(headers);
+        return await this.getClientInstance().request(query);
     }
     generateUrl() {
         const url = new URL(`${this.options.isAdmin ? path.join('admin', this.basePath) : this.basePath}${this.path}`, this.url);

package/build/abstractRestfulClient.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosResponse } from 'axios';
-import { AbstractHttpClient } from './AbstractHttpClient';
+import { AbstractHttpClient, Headers } from './AbstractHttpClient';
 /**
  * Lists of available query parameters for the API call
  */
@@ -25,7 +25,6 @@ export declare type ParametersWithPaginationType = (Parameters & {
     [ParameterKeys.PER_PAGE_CAMEL]?: number;
 });
 export declare type Parameters = Record<string, string | string[] | number | number[] | boolean | null | undefined>;
-export declare type Headers = Record<string, string>;
 export declare type Payload = Record<string, unknown> | Array<Payload>;
 export declare type Options = {
     isAdmin?: boolean;
@@ -59,10 +58,6 @@ export declare abstract class AbstractRestfulClient extends AbstractHttpClient {
      * Defines whether the pagination options are camel cased or not
      */
     protected isCamelPagination: boolean;
-    /**
-     * Defines header information for axios call
-     */
-    protected headers: Headers;
     /**
      * AbstractClient constructor.
      * @returns AbstractRestfulClient
@@ -91,12 +86,6 @@ export declare abstract class AbstractRestfulClient extends AbstractHttpClient {
      * @returns AbstractRestfulClient
      */
     setPage(page: number): this;
-    /**
-     * Sets Header Information
-     * @param headers - Header axios information
-     * @returns AbstractRestfulClient
-     */
-    setHeaders(headers: Record<string, string>): this;
     /**
      * Sends a GET request and returns the response
      * @param parameters - Query parameters to send

package/build/abstractRestfulClient.js

@@ -52,10 +52,6 @@ class AbstractRestfulClient extends AbstractHttpClient_1.AbstractHttpClient {
          * Defines whether the pagination options are camel cased or not
          */
         this.isCamelPagination = false;
-        /**
-         * Defines header information for axios call
-         */
-        this.headers = {};
         this.client = axiosSingleton_1.AxiosSingleton.getInstance();
         this.setApiKey((_a = configuration === null || configuration === void 0 ? void 0 : configuration[ParameterKeys.API_KEY]) !== null && _a !== void 0 ? _a : '');
         this.setUrl((_b = configuration === null || configuration === void 0 ? void 0 : configuration[ParameterKeys.URL]) !== null && _b !== void 0 ? _b : '');
@@ -95,15 +91,6 @@ class AbstractRestfulClient extends AbstractHttpClient_1.AbstractHttpClient {
         this.page = page;
         return this;
     }
-    /**
-     * Sets Header Information
-     * @param headers - Header axios information
-     * @returns AbstractRestfulClient
-     */
-    setHeaders(headers) {
-        this.headers = headers;
-        return this;
-    }
     /**
      * Sends a GET request and returns the response
      * @param parameters - Query parameters to send

package/build/publicApiClient.js

@@ -31,7 +31,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new customers_1.CustomersClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link WhoAmIClient} instance and returns it
@@ -41,7 +42,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new general_1.WhoAmIClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link LicensesClient} instance and returns it
@@ -51,7 +53,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new licenses_1.LicensesClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link CheckDomainClient} instance and returns it
@@ -61,7 +64,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new general_1.CheckDomainClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link SubscriptionsClient} instance and returns it
@@ -71,7 +75,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new subscriptions_1.SubscriptionsClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link OrdersClient} instance and returns it
@@ -81,7 +86,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new orders_1.OrdersClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link ContactClient} instance and returns it
@@ -91,7 +97,8 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new contact_1.ContactClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     /**
      * Creates a new {@link ContactClient} instance and returns it
@@ -101,49 +108,57 @@ class PublicApiClient extends abstractRestfulClient_1.AbstractRestfulClient {
         return new campaign_1.CampaignClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getConsumptionClient() {
         return new consumption_1.ConsumptionClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getSecurityStandardsClient() {
         return new standardsClient_1.StandardsClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getSecurityRegisterClient() {
         return new security_1.RegisterClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getCartClient() {
         return new cartClient_1.CartClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getSupportCenterClient() {
         return new supportCenter_1.SupportCenterClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getCatalogClient() {
         return new catalog_1.CatalogClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
     getUserClient() {
         return new user_1.UserClient()
             .setUrl(this.url)
             .setApiKey(this.apiKey)
-            .setHeaders(this.headers);
+            .setHeaders(this.headers)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
 }
 exports.PublicApiClient = PublicApiClient;

package/build/publicGraphQLClient.js

@@ -5,7 +5,12 @@ const catalogGraphQLClient_1 = require("./catalog/catalogGraphQLClient");
 const abstractGraphQLClient_1 = require("./abstractGraphQLClient");
 class PublicGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
     getCatalogGraphQLClient() {
-        return new catalogGraphQLClient_1.CatalogGraphQLClient().setUrl(this.url).setToken(this.token);
+        return new catalogGraphQLClient_1.CatalogGraphQLClient()
+            .setUrl(this.url)
+            .setToken(this.token)
+            .setHeaders(this.headers)
+            .setToken(this.token)
+            .setHttpExceptionHandlers(this.httpExceptionHandlers);
     }
 }
 exports.PublicGraphQLClient = PublicGraphQLClient;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.30.0-rc-jpb.1",
+  "version": "3.30.0-rc-jpb.4",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -16,6 +16,7 @@
     "lint:fix": "eslint ./{src,tests}/**/*.ts --fix && prettier --write ./{src,tests}/**/*.ts",
     "prepare": "npm run clean && npm run build",
     "test": "mocha -r ts-node/register \"tests/**/*.ts\"",
+    "test:one": "mocha -r ts-node/register",
     "test:watch": "mocha --watch -r ts-node/register \"tests/**/*.ts\"",
     "test:coverage": "nyc --check-coverage npm run test",
     "test:coverage:report": "nyc report --reporter=text-lcov | coveralls"