@arrowsphere/api-client 3.28.0-rc.bdj.2 → 3.28.0-rc.bjp.2

package/README.md

@@ -50,6 +50,17 @@ 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

@@ -32,4 +32,5 @@ export declare abstract class AbstractHttpClient {
      * 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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AbstractHttpClient = void 0;
+const exception_1 = require("./exception");
 class AbstractHttpClient {
     constructor() {
         /**
@@ -44,11 +45,7 @@ class AbstractHttpClient {
      * Will find appropriate ErrorHandlers and apply them to the error in order of registering.
      */
     async handleError(error) {
-        const appropriateHandlers = this.httpExceptionHandlers.filter((handler) => {
-            console.log('httpStatus', error.httpCode);
-            const res = handler.getHandledHttpStatuses().includes(error.httpCode);
-            return res;
-        });
+        const appropriateHandlers = this.httpExceptionHandlers.filter((handler) => handler.getHandledHttpStatuses().includes(error.httpCode));
         // handle retry
         const output = { mustRetry: false };
         for (const handler of appropriateHandlers) {
@@ -59,6 +56,10 @@ class AbstractHttpClient {
         }
         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/abstractGraphQLClient.d.ts

@@ -1,7 +1,9 @@
 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 extends AbstractHttpClient {
     protected client: GraphQLClient;
     protected optionsHeader?: Dom.RequestInit['headers'];

package/build/catalog/catalogGraphQLClient.d.ts

@@ -1,5 +1,6 @@
 import { AbstractGraphQLClient } from '../abstractGraphQLClient';
 import { GetProductsType } from './types/catalogGraphQLTypes';
+import { CatalogQuery } from './types/catalogGraphQLQueries';
 export declare class CatalogGraphQLClient extends AbstractGraphQLClient {
     /**
      * The base path of the API
@@ -10,4 +11,5 @@ export declare class CatalogGraphQLClient extends AbstractGraphQLClient {
      */
     private GRAPHQL;
     find(request: string): Promise<GetProductsType>;
+    findByQuery(query: CatalogQuery): Promise<GetProductsType | null>;
 }

package/build/catalog/catalogGraphQLClient.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CatalogGraphQLClient = void 0;
 const abstractGraphQLClient_1 = require("../abstractGraphQLClient");
-// import { inspect } from 'util';
 class CatalogGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient {
     constructor() {
         super(...arguments);
@@ -19,6 +18,20 @@ class CatalogGraphQLClient extends abstractGraphQLClient_1.AbstractGraphQLClient
         this.path = this.GRAPHQL;
         return await this.post(request);
     }
+    async findByQuery(query) {
+        const queryStr = this.stringifyQuery(query);
+        try {
+            return await this.find(queryStr);
+        }
+        catch (error) {
+            const exception = this.mapToPublicApiException(error);
+            const { mustRetry } = await this.handleError(exception);
+            if (mustRetry) {
+                return await this.find(queryStr);
+            }
+        }
+        return null;
+    }
 }
 exports.CatalogGraphQLClient = CatalogGraphQLClient;
 //# sourceMappingURL=catalogGraphQLClient.js.map

package/build/catalog/index.d.ts

@@ -1,2 +1,4 @@
 export * from './catalogGraphQLClient';
 export * from './types/catalogGraphQLTypes';
+export * from './types/catalogGraphQLQueries';
+export * from './types/catalogGraphQLSchemas';

package/build/catalog/index.js

@@ -16,4 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./catalogGraphQLClient"), exports);
 __exportStar(require("./types/catalogGraphQLTypes"), exports);
+__exportStar(require("./types/catalogGraphQLQueries"), exports);
+__exportStar(require("./types/catalogGraphQLSchemas"), exports);
 //# sourceMappingURL=index.js.map

package/build/catalog/types/catalogGraphQLQueries.d.ts

@@ -0,0 +1,12 @@
+import { QueryArguments } from './queryArguments';
+import { FiltersSchema, PaginationSchema, ProductSchema } from './catalogGraphQLSchemas';
+export declare type CatalogQuery = {
+    getProducts: GetPaginatedProductsQuery;
+};
+export declare type GetPaginatedProductsQuery = {
+    __args: QueryArguments;
+    filters?: FiltersSchema;
+    pagination?: PaginationSchema;
+    products?: ProductSchema;
+    topOffers?: ProductSchema;
+};

package/build/catalog/types/catalogGraphQLQueries.js

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

package/build/catalog/types/catalogGraphQLSchemas.d.ts

@@ -0,0 +1,30 @@
+import { AttributeType, FiltersType, IdentifiersType, PaginationType, PriceBandType, PricesType, ProductType, RelatedOfferType } from './catalogGraphQLTypes';
+import { Merge, Schema } from 'type-fest';
+export declare type PaginationSchema = Schema<PaginationType, boolean>;
+export declare type FiltersSchema = Schema<FiltersType, boolean>;
+declare type IdentifiersSchema = Schema<IdentifiersType, boolean>;
+declare type RelatedOfferSchema = Schema<RelatedOfferType, boolean>;
+/**
+ * Field of type array are not handled by Schema, they must be overwritten
+ */
+declare type MissingFieldsOfProductSchema = {
+    addonPrimaries?: IdentifiersSchema;
+    baseOfferPrimaries?: IdentifiersSchema;
+    conversionOfferPrimaries?: IdentifiersSchema;
+    relatedOffers?: RelatedOfferSchema;
+    priceBand?: PriceBandSchema;
+};
+export declare type ProductSchema = Merge<Schema<ProductType, boolean>, MissingFieldsOfProductSchema>;
+declare type AttributeSchema = Schema<AttributeType, boolean>;
+/**
+ * Field of type array are not handled by Schema, they must be overwritten
+ */
+declare type MissingFieldsOfPriceBandSchema = {
+    attributes?: Array<AttributeSchema>;
+};
+/**
+ * No type corresponding
+ */
+export declare type PriceBandSchema = Merge<Schema<PriceBandType, boolean>, MissingFieldsOfPriceBandSchema>;
+export declare type PriceBandPriceSchema = Schema<PricesType, boolean>;
+export {};

package/build/catalog/types/catalogGraphQLSchemas.js

@@ -0,0 +1,4 @@
+"use strict";
+// Here are the schemas, they are useful to build the graphql requests
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=catalogGraphQLSchemas.js.map

package/build/catalog/types/catalogGraphQLTypes.js

@@ -1,3 +1,4 @@
 "use strict";
+// Here are the types, they are useful to have exact types of the responses
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=catalogGraphQLTypes.js.map

package/build/catalog/types/queryArguments.d.ts

@@ -0,0 +1,41 @@
+/**
+ * For field __args
+ */
+export declare type QueryArguments = {
+    paginate?: PaginateArgument;
+    searchBody: SearchBodyArgument;
+};
+export declare type PaginateArgument = {
+    page: number;
+    perPage: number;
+};
+export declare type SearchBodyArgument = {
+    aggregatorFilter?: string[];
+    endCustomerRef?: string;
+    exclusionFilters?: SearchFilterArgument[];
+    filters?: SearchFilterArgument[];
+    getFamilies?: boolean;
+    highlight?: boolean;
+    keywords?: string;
+    marketplace?: string;
+    quantity?: number;
+    resellerRef?: string;
+    restricted?: boolean;
+    sort?: SortArgument;
+    topOffers?: boolean;
+};
+export declare type SearchFilterArgument = {
+    name: string;
+    value: string | string[];
+    operator?: OperatorArgument;
+    filters?: SearchFilterArgument[];
+};
+export declare enum OperatorArgument {
+    OR = "OR",
+    AND = "AND",
+    BETWEEN = "BETWEEN"
+}
+export declare type SortArgument = {
+    name?: string;
+    order?: string;
+};

package/build/catalog/types/queryArguments.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperatorArgument = void 0;
+var OperatorArgument;
+(function (OperatorArgument) {
+    OperatorArgument["OR"] = "OR";
+    OperatorArgument["AND"] = "AND";
+    OperatorArgument["BETWEEN"] = "BETWEEN";
+})(OperatorArgument = exports.OperatorArgument || (exports.OperatorArgument = {}));
+//# sourceMappingURL=queryArguments.js.map

package/build/exception/exception-handlers/HttpExceptionHandler.d.ts

@@ -1,4 +1,4 @@
-import { HandleHttpExceptionOutput } from '././HandleHttpExceptionOutput';
+import { HandleHttpExceptionOutput } from './HandleHttpExceptionOutput';
 import { Hooks } from './Hooks';
 import { PublicApiClientException } from '../publicApiClientException';
 /**

package/build/exception/publicApiClientException.d.ts

@@ -1,5 +1,6 @@
 export declare class PublicApiClientException extends Error {
     httpCode: number;
     httpError: string;
-    constructor(message: string, httpError?: string, httpCode?: number);
+    config: any;
+    constructor(message: string, httpError?: string, httpCode?: number, config?: {});
 }

package/build/exception/publicApiClientException.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PublicApiClientException = void 0;
 class PublicApiClientException extends Error {
-    constructor(message, httpError = '', httpCode = 0) {
+    constructor(message, httpError = '', httpCode = 0, config = {}) {
         super(message);
         this.httpCode = httpCode;
         this.httpError = httpError;
+        this.config = config;
     }
 }
 exports.PublicApiClientException = PublicApiClientException;

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/ArrowSphere/nodejs-api-client.git"
   },
-  "version": "3.28.0-rc.bdj.2",
+  "version": "3.28.0-rc.bjp.2",
   "description": "Node.js client for ArrowSphere's public API",
   "main": "build/index.js",
   "types": "build/index.d.ts",