@gradientedge/commercetools-utils 5.9.1 → 5.11.0

package/dist/cjs/models/zone.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { BaseResource, CreatedBy, LastModifiedBy } from './common.js';
+/**
+ *	A geographical location representing a country and optionally a state within this country.  A location can only be assigned to one Zone.
+ */
+export interface Location {
+    /**
+     *	Country code of the geographic location.
+     *
+     */
+    readonly country: string;
+    /**
+     *	State within the country.
+     *
+     */
+    readonly state?: string;
+}
+export interface Zone extends BaseResource {
+    /**
+     *	Unique identifier of the Zone.
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the Zone.
+     *
+     */
+    readonly version: number;
+    /**
+     *	Date and time (UTC) the Zone was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the Zone was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked).
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked).
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+    /**
+     *	User-defined unique identifier of the Zone.
+     *
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Name of the Zone.
+     *
+     */
+    readonly name: string;
+    /**
+     *	Description of the Zone.
+     *
+     */
+    readonly description?: string;
+    /**
+     *	List of locations that belong to the Zone.
+     *
+     */
+    readonly locations: Location[];
+}
+export interface ZoneDraft {
+    /**
+     *	User-defined unique identifier for the Zone.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Name of the Zone.
+     *
+     */
+    readonly name: string;
+    /**
+     *	Description of the Zone.
+     *
+     */
+    readonly description?: string;
+    /**
+     *	List of locations that belong to the Zone.
+     *
+     */
+    readonly locations?: Location[];
+}
+/**
+ *	[PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [Zone](ctp:api:type:Zone).
+ *
+ */
+export interface ZonePagedQueryResponse {
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	Actual number of results returned.
+     *
+     *
+     */
+    readonly count: number;
+    /**
+     *	Total number of results matching the query.
+     *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+     *	This field is returned by default.
+     *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
+     *	When the results are filtered with a [Query Predicate](/../api/predicates/query), `total` is subject to a [limit](/../api/limits#queries).
+     *
+     *
+     */
+    readonly total?: number;
+    /**
+     *	[Zones](ctp:api:type:Zone) matching the query.
+     *
+     *
+     */
+    readonly results: Zone[];
+}
+/**
+ *	[Reference](ctp:api:type:Reference) to a [Zone](ctp:api:type:Zone).
+ *
+ */
+export interface ZoneReference {
+    readonly typeId: 'zone';
+    /**
+     *	Unique identifier of the referenced [Zone](ctp:api:type:Zone).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded Zone. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Zones.
+     *
+     *
+     */
+    readonly obj?: Zone;
+}
+/**
+ *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Zone](ctp:api:type:Zone).
+ *
+ */
+export interface ZoneResourceIdentifier {
+    readonly typeId: 'zone';
+    /**
+     *	Unique identifier of the referenced [Zone](ctp:api:type:Zone). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly id?: string;
+    /**
+     *	User-defined unique identifier of the referenced [Zone](ctp:api:type:Zone). Either `id` or `key` is required.
+     *
+     *
+     */
+    readonly key?: string;
+}
+export interface ZoneUpdate {
+    /**
+     *	Expected version of the Zone on which the changes should be applied. If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error is returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the Zone.
+     *
+     *
+     */
+    readonly actions: ZoneUpdateAction[];
+}
+export type ZoneUpdateAction = ZoneAddLocationAction | ZoneChangeNameAction | ZoneRemoveLocationAction | ZoneSetDescriptionAction | ZoneSetKeyAction;
+export interface ZoneAddLocationAction {
+    readonly action: 'addLocation';
+    /**
+     *	Location to be added to the Zone.
+     *
+     */
+    readonly location: Location;
+}
+export interface ZoneChangeNameAction {
+    readonly action: 'changeName';
+    /**
+     *	New name of the Zone.
+     *
+     */
+    readonly name: string;
+}
+export interface ZoneRemoveLocationAction {
+    readonly action: 'removeLocation';
+    /**
+     *	Location to be removed from the Zone.
+     *
+     */
+    readonly location: Location;
+}
+export interface ZoneSetDescriptionAction {
+    readonly action: 'setDescription';
+    /**
+     *	Description of the Zone.
+     *
+     */
+    readonly description?: string;
+}
+export interface ZoneSetKeyAction {
+    readonly action: 'setKey';
+    /**
+     *	If `key` is absent or `null`, the existing key, if any, will be removed.
+     *
+     */
+    readonly key?: string;
+}
+//# sourceMappingURL=zone.d.ts.map

package/dist/cjs/models/zone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zone.d.ts","sourceRoot":"","sources":["../../../src/lib/models/zone.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAErE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CACxB;AACD,MAAM,WAAW,IAAK,SAAQ,YAAY;IACxC;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAA;CAC/B;AACD,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;CAChC;AACD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,CAAA;CACzB;AACD;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAA;CACpB;AACD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,EAAE,CAAA;CACrC;AACD,MAAM,MAAM,gBAAgB,GACxB,qBAAqB,GACrB,oBAAoB,GACpB,wBAAwB,GACxB,wBAAwB,GACxB,gBAAgB,CAAA;AACpB,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAC9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AACD,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AACD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AACD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAA;IACjC;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAC9B;AACD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAA;IACzB;;;OAGG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CACtB"}

package/dist/cjs/models/zone.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=zone.js.map

package/dist/cjs/models/zone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zone.js","sourceRoot":"","sources":["../../../src/lib/models/zone.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type": "commonjs"}

package/dist/cjs/request/index.d.ts

@@ -0,0 +1,3 @@
+export * from './request.js';
+export * from './is-retryable-error.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/request/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/request/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,yBAAyB,CAAA"}

package/dist/cjs/request/index.js

@@ -0,0 +1,19 @@
+"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("./request.js"), exports);
+__exportStar(require("./is-retryable-error.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/request/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B;AAC5B,0DAAuC"}

package/dist/cjs/request/is-retryable-error.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Determine whether the given error means we should allow the request
+ * to be retried (assuming retry config is provided).
+ */
+export declare function isRetryableError(error: any): boolean;
+//# sourceMappingURL=is-retryable-error.d.ts.map

package/dist/cjs/request/is-retryable-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-retryable-error.d.ts","sourceRoot":"","sources":["../../../src/lib/request/is-retryable-error.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAiBpD"}

package/dist/cjs/request/is-retryable-error.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRetryableError = void 0;
+const constants_js_1 = require("../constants.js");
+/**
+ * Determine whether the given error means we should allow the request
+ * to be retried (assuming retry config is provided).
+ */
+function isRetryableError(error) {
+    // If the error isn't an axios error, then something serious
+    // went wrong. Probably a coding error in this package. We should
+    // never really hit this scenario.
+    if (!error.isAxiosError) {
+        return true;
+    }
+    // If axios makes a request successfully, the `request` property will
+    // be defined. Equally, if it received a response, the `response` property
+    // will be defined. If either is not defined then we assume there was
+    // a serious connectivity issue and allow the request to be retried.
+    if (!error.request || !error.response) {
+        return true;
+    }
+    // Finally we only allow requests to be retried if the status code
+    // returned is in the given list
+    return constants_js_1.RETRYABLE_STATUS_CODES.includes(error.response.status);
+}
+exports.isRetryableError = isRetryableError;
+//# sourceMappingURL=is-retryable-error.js.map

package/dist/cjs/request/is-retryable-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-retryable-error.js","sourceRoot":"","sources":["../../../src/lib/request/is-retryable-error.ts"],"names":[],"mappings":";;;AAAA,kDAAwD;AAExD;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,KAAU;IACzC,4DAA4D;IAC5D,iEAAiE;IACjE,kCAAkC;IAClC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;QACxB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,qEAAqE;IACrE,0EAA0E;IAC1E,qEAAqE;IACrE,oEAAoE;IACpE,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QACtC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,kEAAkE;IAClE,gCAAgC;IAChC,OAAO,qCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;AAC/D,CAAC;AAjBD,4CAiBC"}

package/dist/{typings → cjs}/request/request-executor.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import https from 'https';
-import { CommercetoolsRetryConfig } from '../api';
-import { CommercetoolsHooks, RequestExecutor } from '../types';
+import { CommercetoolsRetryConfig } from '../api/index.js';
+import { CommercetoolsHooks, RequestExecutor } from '../types.js';
 export interface GetRequestExecutorProps extends CommercetoolsHooks {
     httpsAgent?: https.Agent;
     timeoutMs?: number;
@@ -9,3 +9,4 @@ export interface GetRequestExecutorProps extends CommercetoolsHooks {
     systemIdentifier?: string;
 }
 export declare function getRequestExecutor(props: GetRequestExecutorProps): RequestExecutor;
+//# sourceMappingURL=request-executor.d.ts.map

package/dist/cjs/request/request-executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-executor.d.ts","sourceRoot":"","sources":["../../../src/lib/request/request-executor.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,kBAAkB,EAAwB,eAAe,EAAE,MAAM,aAAa,CAAA;AAKvF,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAA;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,eAAe,CAelF"}

package/dist/cjs/request/request-executor.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRequestExecutor = void 0;
+const index_js_1 = require("./index.js");
+const index_js_2 = require("../utils/index.js");
+const constants_js_1 = require("../constants.js");
+function getRequestExecutor(props) {
+    const axiosInstance = (0, index_js_2.createAxiosInstance)({ httpsAgent: props.httpsAgent });
+    const instanceHeaders = { 'User-Agent': (0, index_js_2.buildUserAgent)(props.systemIdentifier) };
+    return (requestConfig) => {
+        const headers = { ...instanceHeaders, ...requestConfig.headers };
+        return (0, index_js_1.request)({
+            axiosInstance,
+            onBeforeRequest: props.onBeforeRequest,
+            onAfterResponse: props.onAfterResponse,
+            request: { ...requestConfig, headers },
+            retry: { ...constants_js_1.DEFAULT_RETRY_CONFIG, ...props.retry },
+            timeoutMs: props.timeoutMs,
+        });
+    };
+}
+exports.getRequestExecutor = getRequestExecutor;
+//# sourceMappingURL=request-executor.js.map

package/dist/cjs/request/request-executor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-executor.js","sourceRoot":"","sources":["../../../src/lib/request/request-executor.ts"],"names":[],"mappings":";;;AAGA,yCAAoC;AACpC,gDAAuE;AACvE,kDAAsD;AAStD,SAAgB,kBAAkB,CAAC,KAA8B;IAC/D,MAAM,aAAa,GAAG,IAAA,8BAAmB,EAAC,EAAE,UAAU,EAAE,KAAK,CAAC,UAAU,EAAE,CAAC,CAAA;IAC3E,MAAM,eAAe,GAAG,EAAE,YAAY,EAAE,IAAA,yBAAc,EAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAA;IAEhF,OAAO,CAAC,aAAmC,EAAE,EAAE;QAC7C,MAAM,OAAO,GAAG,EAAE,GAAG,eAAe,EAAE,GAAG,aAAa,CAAC,OAAO,EAAE,CAAA;QAChE,OAAO,IAAA,kBAAO,EAAC;YACb,aAAa;YACb,eAAe,EAAE,KAAK,CAAC,eAAe;YACtC,eAAe,EAAE,KAAK,CAAC,eAAe;YACtC,OAAO,EAAE,EAAE,GAAG,aAAa,EAAE,OAAO,EAAE;YACtC,KAAK,EAAE,EAAE,GAAG,mCAAoB,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE;YAClD,SAAS,EAAE,KAAK,CAAC,SAAS;SAC3B,CAAC,CAAA;IACJ,CAAC,CAAA;AACH,CAAC;AAfD,gDAeC"}

package/dist/{typings → cjs}/request/request.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from 'axios';
-import { CommercetoolsRetryConfig } from '../api';
-import { CommercetoolsHooks, CommercetoolsRequest } from '../types';
+import { CommercetoolsRetryConfig } from '../api/index.js';
+import { CommercetoolsHooks, CommercetoolsRequest } from '../types.js';
 export interface RequestOptions extends CommercetoolsHooks {
     axiosInstance: AxiosInstance;
     retry: CommercetoolsRetryConfig;
@@ -8,3 +8,4 @@ export interface RequestOptions extends CommercetoolsHooks {
     timeoutMs?: number;
 }
 export declare function request<T = any>(options: RequestOptions): Promise<T>;
+//# sourceMappingURL=request.d.ts.map

package/dist/cjs/request/request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/lib/request/request.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AACrC,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAMtE,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,aAAa,EAAE,aAAa,CAAA;IAC5B,KAAK,EAAE,wBAAwB,CAAA;IAC/B,OAAO,EAAE,oBAAoB,CAAA;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,wBAAsB,OAAO,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAmF1E"}

package/dist/cjs/request/request.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.request = void 0;
+const index_js_1 = require("../utils/index.js");
+const is_retryable_error_js_1 = require("./is-retryable-error.js");
+const transform_error_js_1 = require("./transform-error.js");
+const constants_js_1 = require("../constants.js");
+const plain_clone_js_1 = require("../utils/plain-clone.js");
+async function request(options) {
+    const { retry: retryConfig, onBeforeRequest, onAfterResponse, axiosInstance } = options;
+    const timeout = options.timeoutMs ?? constants_js_1.DEFAULT_REQUEST_TIMEOUT_MS;
+    const additionalHeaders = {};
+    let requestConfig = (0, plain_clone_js_1.plainClone)(options.request);
+    let retryCount = 0;
+    let lastError;
+    const headerNames = Object.keys(requestConfig.headers ?? {}).map((headerName) => headerName.toLowerCase());
+    if (!headerNames.includes('user-agent')) {
+        requestConfig.headers ??= {};
+        requestConfig.headers['User-Agent'] = (0, index_js_1.buildUserAgent)();
+    }
+    let totalDurationMs = 0;
+    let startTime;
+    let endTime;
+    do {
+        startTime = null;
+        endTime = null;
+        if (retryCount > 0) {
+            additionalHeaders['X-Retry-Count'] = `${retryCount}`;
+            const delay = (0, index_js_1.calculateDelay)(retryCount, retryConfig);
+            await new Promise((resolve) => setTimeout(resolve, delay));
+        }
+        try {
+            if (onBeforeRequest) {
+                const customRequestConfig = await onBeforeRequest(requestConfig);
+                if (customRequestConfig) {
+                    requestConfig = customRequestConfig;
+                }
+            }
+            startTime = Date.now();
+            const response = await axiosInstance({
+                ...requestConfig,
+                headers: {
+                    ...requestConfig.headers,
+                    ...additionalHeaders,
+                },
+                timeout,
+            });
+            endTime = Date.now();
+            totalDurationMs += endTime - startTime;
+            if (onAfterResponse) {
+                onAfterResponse((0, index_js_1.convertAxiosResponse)(response, {
+                    accumulativeDurationMs: totalDurationMs,
+                    durationMs: endTime - startTime,
+                    retries: retryCount,
+                }));
+            }
+            return response.data;
+        }
+        catch (error) {
+            endTime = Date.now();
+            totalDurationMs += startTime ? endTime - startTime : 0;
+            if (onAfterResponse) {
+                const convertedError = (0, index_js_1.convertAxiosError)(error, {
+                    accumulativeDurationMs: totalDurationMs,
+                    durationMs: startTime ? endTime - startTime : 0,
+                    retries: retryCount,
+                });
+                if (convertedError) {
+                    onAfterResponse(convertedError);
+                }
+            }
+            if ((0, is_retryable_error_js_1.isRetryableError)(error)) {
+                lastError = error;
+            }
+            else {
+                throw (0, transform_error_js_1.transformError)(error);
+            }
+        }
+        retryCount++;
+    } while (retryCount <= retryConfig.maxRetries);
+    throw (0, transform_error_js_1.transformError)(lastError);
+}
+exports.request = request;
+//# sourceMappingURL=request.js.map

package/dist/cjs/request/request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/lib/request/request.ts"],"names":[],"mappings":";;;AAAA,gDAA2G;AAI3G,mEAA0D;AAC1D,6DAAqD;AACrD,kDAA4D;AAC5D,4DAAoD;AAS7C,KAAK,UAAU,OAAO,CAAU,OAAuB;IAC5D,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,GAAG,OAAO,CAAA;IACvF,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,IAAI,yCAA0B,CAAA;IAC/D,MAAM,iBAAiB,GAA2B,EAAE,CAAA;IACpD,IAAI,aAAa,GAAG,IAAA,2BAAU,EAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAC/C,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,IAAI,SAAc,CAAA;IAElB,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,CAAA;IAC1G,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QACxC,aAAa,CAAC,OAAO,KAAK,EAAE,CAAA;QAC5B,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,IAAA,yBAAc,GAAE,CAAA;IACxD,CAAC;IAED,IAAI,eAAe,GAAG,CAAC,CAAA;IACvB,IAAI,SAAS,CAAA;IACb,IAAI,OAAO,CAAA;IAEX,GAAG,CAAC;QACF,SAAS,GAAG,IAAI,CAAA;QAChB,OAAO,GAAG,IAAI,CAAA;QAEd,IAAI,UAAU,GAAG,CAAC,EAAE,CAAC;YACnB,iBAAiB,CAAC,eAAe,CAAC,GAAG,GAAG,UAAU,EAAE,CAAA;YACpD,MAAM,KAAK,GAAG,IAAA,yBAAc,EAAC,UAAU,EAAE,WAAW,CAAC,CAAA;YACrD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;QAC5D,CAAC;QAED,IAAI,CAAC;YACH,IAAI,eAAe,EAAE,CAAC;gBACpB,MAAM,mBAAmB,GAAG,MAAM,eAAe,CAAC,aAAa,CAAC,CAAA;gBAChE,IAAI,mBAAmB,EAAE,CAAC;oBACxB,aAAa,GAAG,mBAAmB,CAAA;gBACrC,CAAC;YACH,CAAC;YAED,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YAEtB,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC;gBACnC,GAAG,aAAa;gBAChB,OAAO,EAAE;oBACP,GAAG,aAAa,CAAC,OAAO;oBACxB,GAAG,iBAAiB;iBACrB;gBACD,OAAO;aACR,CAAC,CAAA;YAEF,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YACpB,eAAe,IAAI,OAAO,GAAG,SAAS,CAAA;YAEtC,IAAI,eAAe,EAAE,CAAC;gBACpB,eAAe,CACb,IAAA,+BAAoB,EAAC,QAAQ,EAAE;oBAC7B,sBAAsB,EAAE,eAAe;oBACvC,UAAU,EAAE,OAAO,GAAG,SAAS;oBAC/B,OAAO,EAAE,UAAU;iBACpB,CAAC,CACH,CAAA;YACH,CAAC;YACD,OAAO,QAAQ,CAAC,IAAI,CAAA;QACtB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;YACpB,eAAe,IAAI,SAAS,CAAC,CAAC,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAA;YACtD,IAAI,eAAe,EAAE,CAAC;gBACpB,MAAM,cAAc,GAAG,IAAA,4BAAiB,EAAC,KAAK,EAAE;oBAC9C,sBAAsB,EAAE,eAAe;oBACvC,UAAU,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;oBAC/C,OAAO,EAAE,UAAU;iBACpB,CAAC,CAAA;gBACF,IAAI,cAAc,EAAE,CAAC;oBACnB,eAAe,CAAC,cAAc,CAAC,CAAA;gBACjC,CAAC;YACH,CAAC;YACD,IAAI,IAAA,wCAAgB,EAAC,KAAK,CAAC,EAAE,CAAC;gBAC5B,SAAS,GAAG,KAAK,CAAA;YACnB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAA,mCAAc,EAAC,KAAK,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC;QACD,UAAU,EAAE,CAAA;IACd,CAAC,QAAQ,UAAU,IAAI,WAAW,CAAC,UAAU,EAAC;IAE9C,MAAM,IAAA,mCAAc,EAAC,SAAS,CAAC,CAAA;AACjC,CAAC;AAnFD,0BAmFC"}

package/dist/cjs/request/transform-error.d.ts

@@ -0,0 +1,7 @@
+import { CommercetoolsError } from '../error/index.js';
+/**
+ * Transform an unknown error in to a {@see CommercetoolsError}
+ * if the error we receive is from axios.
+ */
+export declare function transformError(lastError: any): Error | CommercetoolsError;
+//# sourceMappingURL=transform-error.d.ts.map

package/dist/cjs/request/transform-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-error.d.ts","sourceRoot":"","sources":["../../../src/lib/request/transform-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD;;;GAGG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,GAAG,GAAG,KAAK,GAAG,kBAAkB,CAKzE"}

package/dist/cjs/request/transform-error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformError = void 0;
+const index_js_1 = require("../error/index.js");
+/**
+ * Transform an unknown error in to a {@see CommercetoolsError}
+ * if the error we receive is from axios.
+ */
+function transformError(lastError) {
+    if (lastError.isAxiosError) {
+        return index_js_1.CommercetoolsError.fromAxiosError(lastError);
+    }
+    return lastError;
+}
+exports.transformError = transformError;
+//# sourceMappingURL=transform-error.js.map

package/dist/cjs/request/transform-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-error.js","sourceRoot":"","sources":["../../../src/lib/request/transform-error.ts"],"names":[],"mappings":";;;AAAA,gDAAsD;AAEtD;;;GAGG;AACH,SAAgB,cAAc,CAAC,SAAc;IAC3C,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;QAC3B,OAAO,6BAAkB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAA;IACrD,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AALD,wCAKC"}

package/dist/{typings → cjs}/types.d.ts

@@ -1,4 +1,8 @@
-import { CommercetoolsRetryConfig } from './api';
+import { CommercetoolsRetryConfig } from './api/index.js';
+/**
+ * The commercetools region that your API client id/secret relate to.
+ * This is used to determine the authentication endpoint.
+ */
 export declare enum Region {
     NORTH_AMERICA_GCP = "north_america_gcp",
     NORTH_AMERICA_AWS = "north_america_aws",
@@ -6,10 +10,23 @@ export declare enum Region {
     EUROPE_AWS = "europe_aws",
     AUSTRALIA_GCP = "australia_gcp"
 }
+/**
+ * The Authentication and API endpoints for a particular region
+ */
 export interface RegionEndpoints {
+    /**
+     * The url to the commercetools auth endpoint for the region
+     */
     auth: string;
+    /**
+     * The url to the commercetools API endpoint for the region
+     */
     api: string;
 }
+/**
+ * Provides a base configuration definition from which other class
+ * specific configurations can be extended.
+ */
 export interface CommercetoolsBaseConfig extends CommercetoolsHooks {
     projectKey: string;
     storeKey?: string;
@@ -18,12 +35,29 @@ export interface CommercetoolsBaseConfig extends CommercetoolsHooks {
     region: Region;
     timeoutMs?: number;
     retry?: Partial<CommercetoolsRetryConfig>;
+    /**
+     * If provided, will be passed across to commercetools in the
+     * 'User-Agent' HTTP header, in order to help commercetools
+     * identify the source of incoming requests.
+     */
     systemIdentifier?: string;
 }
 export interface CommercetoolsHooks {
+    /**
+     * If passed in, will be called before sending a request to commercetools.
+     * The {@see requestConfig} parameter can be manipulated if you wish to
+     * modify/add headers or any other request data.
+     */
     onBeforeRequest?: (requestConfig: CommercetoolsRequest) => Promise<CommercetoolsRequest> | CommercetoolsRequest;
+    /**
+     * If passed in, will be called once a request has been made and the
+     * response received (or error thrown).
+     */
     onAfterResponse?: (response: CommercetoolsRequestResponse) => void;
 }
+/**
+ * Represents a request about to be made to commercetools
+ */
 export interface CommercetoolsRequest {
     url: string;
     method: string;
@@ -31,6 +65,9 @@ export interface CommercetoolsRequest {
     headers: Record<string, string>;
     data?: any;
 }
+/**
+ * Represents the request and response for a request made to commercetools
+ */
 export interface CommercetoolsRequestResponse {
     request: {
         url: string;
@@ -56,3 +93,4 @@ export interface CommercetoolsRequestResponseStats {
 export interface RequestExecutor<T = any> {
     (options: CommercetoolsRequest): Promise<T>;
 }
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;GAGG;AACH,oBAAY,MAAM;IAChB,iBAAiB,sBAAsB;IACvC,iBAAiB,sBAAsB;IACvC,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,aAAa,kBAAkB;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC,wBAAwB,CAAC,CAAA;IAEzC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,aAAa,EAAE,oBAAoB,KAAK,OAAO,CAAC,oBAAoB,CAAC,GAAG,oBAAoB,CAAA;IAE/G;;;OAGG;IACH,eAAe,CAAC,EAAE,CAAC,QAAQ,EAAE,4BAA4B,KAAK,IAAI,CAAA;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;IAClD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,IAAI,CAAC,EAAE,GAAG,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE;QACP,GAAG,EAAE,MAAM,CAAA;QACX,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GAAG,SAAS,CAAA;QAC9D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;QAC5C,IAAI,CAAC,EAAE,GAAG,CAAA;KACX,CAAA;IACD,QAAQ,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QACzB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAAA;QAC5C,IAAI,CAAC,EAAE,GAAG,CAAA;KACX,CAAA;IACD,KAAK,EAAE,iCAAiC,CAAA;CACzC;AAED,MAAM,WAAW,iCAAiC;IAChD,sBAAsB,EAAE,MAAM,CAAA;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG;IACtC,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CAC5C"}

package/dist/cjs/types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Region = void 0;
+/**
+ * The commercetools region that your API client id/secret relate to.
+ * This is used to determine the authentication endpoint.
+ */
+var Region;
+(function (Region) {
+    Region["NORTH_AMERICA_GCP"] = "north_america_gcp";
+    Region["NORTH_AMERICA_AWS"] = "north_america_aws";
+    Region["EUROPE_GCP"] = "europe_gcp";
+    Region["EUROPE_AWS"] = "europe_aws";
+    Region["AUSTRALIA_GCP"] = "australia_gcp";
+})(Region || (exports.Region = Region = {}));
+//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/lib/types.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,IAAY,MAMX;AAND,WAAY,MAAM;IAChB,iDAAuC,CAAA;IACvC,iDAAuC,CAAA;IACvC,mCAAyB,CAAA;IACzB,mCAAyB,CAAA;IACzB,yCAA+B,CAAA;AACjC,CAAC,EANW,MAAM,sBAAN,MAAM,QAMjB"}

package/dist/{typings → cjs}/utils/axios/convert-error.d.ts

@@ -1,3 +1,4 @@
-import { CommercetoolsRequestResponse, CommercetoolsRequestResponseStats } from '../../types';
+import { CommercetoolsRequestResponse, CommercetoolsRequestResponseStats } from '../../types.js';
 import { AxiosError } from 'axios';
 export declare function convertAxiosError(error: AxiosError | Error, stats: CommercetoolsRequestResponseStats): CommercetoolsRequestResponse | null;
+//# sourceMappingURL=convert-error.d.ts.map

package/dist/cjs/utils/axios/convert-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-error.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/axios/convert-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAA;AAChG,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAGlC,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,UAAU,GAAG,KAAK,EACzB,KAAK,EAAE,iCAAiC,GACvC,4BAA4B,GAAG,IAAI,CAqBrC"}