@gradientedge/commercetools-utils 5.9.1 → 5.10.0

package/dist/mjs/utils/axios/convert-response.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-response.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/axios/convert-response.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,iCAAiC,EAAE,MAAM,gBAAgB,CAAA;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAGrC,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,aAAa,EACvB,KAAK,EAAE,iCAAiC,GACvC,4BAA4B,CAgB9B"}

package/dist/mjs/utils/axios/convert-response.js

@@ -0,0 +1,19 @@
+import { extractAxiosHeaders } from './extract-headers.js';
+export function convertAxiosResponse(response, stats) {
+    return {
+        request: {
+            url: response.config?.url ?? '',
+            method: response.config?.method,
+            params: response.config?.params,
+            headers: extractAxiosHeaders(response.config?.headers),
+            data: response.config?.data,
+        },
+        response: {
+            status: response.status,
+            headers: extractAxiosHeaders(response.headers),
+            data: response.data,
+        },
+        stats,
+    };
+}
+//# sourceMappingURL=convert-response.js.map

package/dist/mjs/utils/axios/convert-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"convert-response.js","sourceRoot":"","sources":["../../../../src/lib/utils/axios/convert-response.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAE1D,MAAM,UAAU,oBAAoB,CAClC,QAAuB,EACvB,KAAwC;IAExC,OAAO;QACL,OAAO,EAAE;YACP,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE;YAC/B,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAgB;YACzC,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM;YAC/B,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;YACtD,IAAI,EAAE,QAAQ,CAAC,MAAM,EAAE,IAAI;SAC5B;QACD,QAAQ,EAAE;YACR,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,OAAO,EAAE,mBAAmB,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC9C,IAAI,EAAE,QAAQ,CAAC,IAAI;SACpB;QACD,KAAK;KACN,CAAA;AACH,CAAC"}

package/dist/mjs/utils/axios/create-instance.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" resolution-mode="require"/>
+import { AxiosInstance } from 'axios';
+import https from 'https';
+/**
+ * Define the base axios instance that forms the foundation
+ * of all axios calls made by the {@see request} method.
+ */
+export declare function createAxiosInstance(options: {
+    httpsAgent?: https.Agent;
+}): AxiosInstance;
+//# sourceMappingURL=create-instance.d.ts.map

package/dist/mjs/utils/axios/create-instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-instance.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/axios/create-instance.ts"],"names":[],"mappings":";AACA,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE;IAAE,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAA;CAAE,GAAG,aAAa,CAcxF"}

package/dist/mjs/utils/axios/create-instance.js

@@ -0,0 +1,23 @@
+import { DEFAULT_HTTPS_AGENT_CONFIG } from '../../constants.js';
+import axios from 'axios';
+/**
+ * Define the base axios instance that forms the foundation
+ * of all axios calls made by the {@see request} method.
+ */
+export function createAxiosInstance(options) {
+    let agent;
+    try {
+        if (process.env.GECTU_IS_BROWSER !== '1') {
+            if (options.httpsAgent) {
+                agent = options.httpsAgent;
+            }
+            else {
+                const https = require('https');
+                agent = new https.Agent(DEFAULT_HTTPS_AGENT_CONFIG);
+            }
+        }
+    }
+    catch (e) { }
+    return axios.create({ httpsAgent: agent });
+}
+//# sourceMappingURL=create-instance.js.map

package/dist/mjs/utils/axios/create-instance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-instance.js","sourceRoot":"","sources":["../../../../src/lib/utils/axios/create-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,KAAwB,MAAM,OAAO,CAAA;AAG5C;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAqC;IACvE,IAAI,KAAK,CAAA;IACT,IAAI,CAAC;QACH,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,GAAG,EAAE,CAAC;YACzC,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,KAAK,GAAG,OAAO,CAAC,UAAU,CAAA;YAC5B,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;gBAC9B,KAAK,GAAG,IAAI,KAAK,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;IAEd,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;AAC5C,CAAC"}

package/dist/mjs/utils/axios/extract-headers.d.ts

@@ -0,0 +1,2 @@
+export declare function extractAxiosHeaders(headers: unknown): Record<string, string> | undefined;
+//# sourceMappingURL=extract-headers.d.ts.map

package/dist/mjs/utils/axios/extract-headers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-headers.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/axios/extract-headers.ts"],"names":[],"mappings":"AAEA,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,SAAS,CAexF"}

package/dist/mjs/utils/axios/extract-headers.js

@@ -0,0 +1,19 @@
+import { AxiosHeaders } from 'axios';
+export function extractAxiosHeaders(headers) {
+    let extractedHeaders = {};
+    if (headers instanceof AxiosHeaders) {
+        const jsonHeaders = headers.toJSON();
+        extractedHeaders = {};
+        Object.entries(jsonHeaders).forEach(([name, value]) => {
+            const lcName = name.toLowerCase();
+            if (typeof value === 'boolean' || typeof value === 'number' || typeof value === 'string') {
+                extractedHeaders[lcName] = value.toString();
+            }
+            else if (Array.isArray(value)) {
+                extractedHeaders[lcName] = value.join(', ');
+            }
+        });
+    }
+    return Object.keys(extractedHeaders).length ? extractedHeaders : undefined;
+}
+//# sourceMappingURL=extract-headers.js.map

package/dist/mjs/utils/axios/extract-headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extract-headers.js","sourceRoot":"","sources":["../../../../src/lib/utils/axios/extract-headers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAEpC,MAAM,UAAU,mBAAmB,CAAC,OAAgB;IAClD,IAAI,gBAAgB,GAA2B,EAAE,CAAA;IACjD,IAAI,OAAO,YAAY,YAAY,EAAE,CAAC;QACpC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,EAAyB,CAAA;QAC3D,gBAAgB,GAAG,EAAE,CAAA;QACrB,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;YACpD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;YACjC,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACzF,gBAAgB,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAA;YAC7C,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,gBAAgB,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YAC7C,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAA;AAC5E,CAAC"}

package/dist/mjs/utils/axios/index.d.ts

@@ -0,0 +1,5 @@
+export * from './convert-error.js';
+export * from './convert-response.js';
+export * from './create-instance.js';
+export * from './extract-headers.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/mjs/utils/axios/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/axios/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA"}

package/dist/mjs/utils/axios/index.js

@@ -0,0 +1,5 @@
+export * from './convert-error.js';
+export * from './convert-response.js';
+export * from './create-instance.js';
+export * from './extract-headers.js';
+//# sourceMappingURL=index.js.map

package/dist/mjs/utils/axios/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/utils/axios/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA"}

package/dist/mjs/utils/calculate-delay.d.ts

@@ -0,0 +1,7 @@
+import { CommercetoolsRetryConfig } from '../api/index.js';
+/**
+ * Calculate how long to delay before running the request.
+ * For each retry attempt, we increase the time that we delay for.
+ */
+export declare function calculateDelay(retryCount: number, retryConfig?: Omit<CommercetoolsRetryConfig, 'maxRetries'>): number;
+//# sourceMappingURL=calculate-delay.d.ts.map

package/dist/mjs/utils/calculate-delay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculate-delay.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/calculate-delay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAA;AAE1D;;;GAGG;AACH,wBAAgB,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,wBAAwB,EAAE,YAAY,CAAC,GAAG,MAAM,CAmBrH"}

package/dist/mjs/utils/calculate-delay.js

@@ -0,0 +1,26 @@
+/**
+ * Calculate how long to delay before running the request.
+ * For each retry attempt, we increase the time that we delay for.
+ */
+export function calculateDelay(retryCount, retryConfig) {
+    if (!retryConfig || retryCount === 0) {
+        return 0;
+    }
+    // `retryCount` will be at least 1 at this point
+    const exponentialDelay = retryConfig.delayMs * 2 ** (retryCount - 1);
+    if (retryConfig.jitter) {
+        // A 'full' jitter calculation usually just calculates the delay value
+        // by selecting a random value between zero and the standard exponential
+        // delay value (calculated above). This next line increases the exponential
+        // delay by a factor that reduces for each further request. This ensures
+        // more variance on earlier requests.
+        const increasedDelay = exponentialDelay * (1 + 1 / (retryCount + 1));
+        return Math.floor(Math.random() * increasedDelay);
+    }
+    else {
+        // Assuming a `delayMs` of 500, you'd get the following responses for
+        // the given `retryCount` value: 1 = 500, 2 = 1000, 3 = 2000, 4 = 4000
+        return exponentialDelay;
+    }
+}
+//# sourceMappingURL=calculate-delay.js.map

package/dist/mjs/utils/calculate-delay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculate-delay.js","sourceRoot":"","sources":["../../../src/lib/utils/calculate-delay.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,UAAkB,EAAE,WAA0D;IAC3G,IAAI,CAAC,WAAW,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrC,OAAO,CAAC,CAAA;IACV,CAAC;IACD,gDAAgD;IAChD,MAAM,gBAAgB,GAAG,WAAW,CAAC,OAAO,GAAG,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,CAAA;IACpE,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;QACvB,sEAAsE;QACtE,wEAAwE;QACxE,2EAA2E;QAC3E,wEAAwE;QACxE,qCAAqC;QACrC,MAAM,cAAc,GAAG,gBAAgB,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAA;QACpE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,cAAc,CAAC,CAAA;IACnD,CAAC;SAAM,CAAC;QACN,qEAAqE;QACrE,sEAAsE;QACtE,OAAO,gBAAgB,CAAA;IACzB,CAAC;AACH,CAAC"}

package/dist/mjs/utils/ensure-non-empty-string.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Options interface for {@see ensureNonEmptyString}
+ */
+export interface EnsureNonEmptyStringParams {
+    /** string value to be checked */
+    value: string;
+    /** name of property to be checked */
+    name: string;
+}
+/**
+ * Ensure the string value passed in will not result in an empty value once trimmed.
+ *
+ * @throws CommercetoolsError
+ */
+export declare function ensureNonEmptyString(options: EnsureNonEmptyStringParams): void;
+//# sourceMappingURL=ensure-non-empty-string.d.ts.map

package/dist/mjs/utils/ensure-non-empty-string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensure-non-empty-string.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/ensure-non-empty-string.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAI9E"}

package/dist/mjs/utils/ensure-non-empty-string.js

@@ -0,0 +1,12 @@
+import { CommercetoolsError } from '../error/index.js';
+/**
+ * Ensure the string value passed in will not result in an empty value once trimmed.
+ *
+ * @throws CommercetoolsError
+ */
+export function ensureNonEmptyString(options) {
+    if (!options.value.trim()) {
+        throw new CommercetoolsError(`The string parameter '${options.name}' cannot be empty`);
+    }
+}
+//# sourceMappingURL=ensure-non-empty-string.js.map

package/dist/mjs/utils/ensure-non-empty-string.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensure-non-empty-string.js","sourceRoot":"","sources":["../../../src/lib/utils/ensure-non-empty-string.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAYtD;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAmC;IACtE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAC1B,MAAM,IAAI,kBAAkB,CAAC,yBAAyB,OAAO,CAAC,IAAI,mBAAmB,CAAC,CAAA;IACxF,CAAC;AACH,CAAC"}

package/dist/mjs/utils/format.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Format a string for use as a key.
+ *
+ * Keys may only contain alphanumeric characters, underscores and hyphens
+ * and must have a minimum length of 2 characters and maximum length of
+ * 256 characters.
+ *
+ * @param {string} input The string that you want to format as a key
+ */
+export declare function formatAsKey(input: unknown): string;
+//# sourceMappingURL=format.d.ts.map

package/dist/mjs/utils/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/format.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAoClD"}

package/dist/mjs/utils/format.js

@@ -0,0 +1,44 @@
+import { CommercetoolsError } from '../error/index.js';
+/**
+ * Format a string for use as a key.
+ *
+ * Keys may only contain alphanumeric characters, underscores and hyphens
+ * and must have a minimum length of 2 characters and maximum length of
+ * 256 characters.
+ *
+ * @param {string} input The string that you want to format as a key
+ */
+export function formatAsKey(input) {
+    let output = '';
+    if (typeof input !== 'string') {
+        throw new CommercetoolsError(`The [input] parameter must be a string`);
+    }
+    // Trim and make lowercase
+    output = input.trim().toLowerCase();
+    // Replace any instance of more than one space, with a single space
+    output = output.replace(/ {2,}/g, '');
+    // Replacing '&' for 'and'
+    output = output.replace(/&/g, 'and');
+    // Replace spaces for hyphen or underscore
+    output = output.replace(/[ _]/g, '-');
+    // Remove any non-alphanumeric characters (except for hyphens)
+    output = output.replace(/[^0-9a-z-]+/g, '');
+    // Replace any instance of more than one hyphen, with a single hyphen
+    output = output.replace(/-{2,}/g, '-');
+    // Remove any leading hyphen
+    if (output.length && output[0] === '-') {
+        output = output.slice(1);
+    }
+    // Remove any trailing hyphen
+    if (output.length && output[output.length - 1] === '-') {
+        output = output.slice(0, -1);
+    }
+    if (output.length < 2) {
+        throw new CommercetoolsError(`Formatted key did not meet minimum length of 2 characters: ${output}`);
+    }
+    if (output.length > 256) {
+        throw new CommercetoolsError(`Formatted key exceeds the maximum length of 256 characters: ${output}`);
+    }
+    return output;
+}
+//# sourceMappingURL=format.js.map

package/dist/mjs/utils/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../../src/lib/utils/format.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAEtD;;;;;;;;GAQG;AACH,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,kBAAkB,CAAC,wCAAwC,CAAC,CAAA;IACxE,CAAC;IAED,0BAA0B;IAC1B,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;IACnC,mEAAmE;IACnE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACrC,0BAA0B;IAC1B,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;IACpC,0CAA0C;IAC1C,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;IACrC,8DAA8D;IAC9D,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;IAC3C,qEAAqE;IACrE,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IACtC,4BAA4B;IAC5B,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACvC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IAC1B,CAAC;IACD,6BAA6B;IAC7B,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QACvD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAC9B,CAAC;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,kBAAkB,CAAC,8DAA8D,MAAM,EAAE,CAAC,CAAA;IACtG,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,kBAAkB,CAAC,+DAA+D,MAAM,EAAE,CAAC,CAAA;IACvG,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/mjs/utils/get-attribute-value.d.ts

@@ -0,0 +1,17 @@
+import { Attribute } from '../models/index.js';
+/**
+ * Options interface for {@see getAttributeValue}
+ */
+export interface GetAttributeValueParams {
+    /** Attribute list */
+    attributes: Attribute[] | null | undefined;
+    /** Name of the attribute that you want to retrieve the value of */
+    name: string;
+}
+/**
+ * Retrieve the value of the attribute for the given attribute name
+ *
+ * Returns `null` if no attribute is found
+ */
+export declare function getAttributeValue<T = any>(options: GetAttributeValueParams): T | null;
+//# sourceMappingURL=get-attribute-value.d.ts.map

package/dist/mjs/utils/get-attribute-value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-attribute-value.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/get-attribute-value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C;;GAEG;AAEH,MAAM,WAAW,uBAAuB;IACtC,qBAAqB;IACrB,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,GAAG,SAAS,CAAA;IAC1C,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,uBAAuB,GAAG,CAAC,GAAG,IAAI,CAQrF"}

package/dist/mjs/utils/get-attribute-value.js

@@ -0,0 +1,15 @@
+/**
+ * Retrieve the value of the attribute for the given attribute name
+ *
+ * Returns `null` if no attribute is found
+ */
+export function getAttributeValue(options) {
+    if (options?.attributes?.length) {
+        const attribute = options.attributes?.find((attribute) => attribute.name === options.name);
+        if (attribute) {
+            return attribute.value;
+        }
+    }
+    return null;
+}
+//# sourceMappingURL=get-attribute-value.js.map

package/dist/mjs/utils/get-attribute-value.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-attribute-value.js","sourceRoot":"","sources":["../../../src/lib/utils/get-attribute-value.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAU,OAAgC;IACzE,IAAI,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;QAC1F,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,SAAS,CAAC,KAAK,CAAA;QACxB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/mjs/utils/index.d.ts

@@ -0,0 +1,9 @@
+export * from './axios/index.js';
+export * from './calculate-delay.js';
+export * from './ensure-non-empty-string.js';
+export * from './format.js';
+export * from './get-attribute-value.js';
+export * from './mask.js';
+export * from './retry-on-conflict.js';
+export * from './useragent.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/mjs/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,aAAa,CAAA;AAC3B,cAAc,0BAA0B,CAAA;AACxC,cAAc,WAAW,CAAA;AACzB,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA"}

package/dist/mjs/utils/index.js

@@ -0,0 +1,9 @@
+export * from './axios/index.js';
+export * from './calculate-delay.js';
+export * from './ensure-non-empty-string.js';
+export * from './format.js';
+export * from './get-attribute-value.js';
+export * from './mask.js';
+export * from './retry-on-conflict.js';
+export * from './useragent.js';
+//# sourceMappingURL=index.js.map

package/dist/mjs/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,aAAa,CAAA;AAC3B,cAAc,0BAA0B,CAAA;AACxC,cAAc,WAAW,CAAA;AACzB,cAAc,wBAAwB,CAAA;AACtC,cAAc,gBAAgB,CAAA"}

package/dist/mjs/utils/mask.d.ts

@@ -0,0 +1,28 @@
+/**
+ * List of property names that we want to mask.
+ * Names are not case sensitive.
+ */
+export declare const SENSITIVE_PROPERTY_NAMES: string[];
+/**
+ * List of HTTP header names that we want to mask.
+ * Names are not case sensitive.
+ */
+export declare const SENSITIVE_HEADER_NAMES: string[];
+/**
+ * The string mask to use if none explicitly provided.
+ */
+export declare const DEFAULT_MASKING_STRING = "********";
+/**
+ * Mask all properties matching those in {@see SENSITIVE_PROPERTY_NAMES}
+ */
+export declare function maskSensitiveInput(data: unknown): any;
+/**
+ * Mask all properties matching those in {@see SENSITIVE_HEADER_NAMES}
+ */
+export declare function maskSensitiveHeaders(data: unknown): any;
+/**
+ * Mask all properties defined by {@see propertyNames} in the given {@see data} object
+ * with the mask string defined by the {@see mask} parameter.
+ */
+export declare function maskSensitiveData(data: any, propertyNames: string[], mask?: string): any;
+//# sourceMappingURL=mask.d.ts.map

package/dist/mjs/utils/mask.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mask.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/mask.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,wBAAwB,UAAgC,CAAA;AAErE;;;GAGG;AACH,eAAO,MAAM,sBAAsB,UAAoB,CAAA;AAEvD;;GAEG;AACH,eAAO,MAAM,sBAAsB,aAAa,CAAA;AAEhD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,GAAG,GAAG,CAErD;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,GAAG,CAEvD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,IAAI,SAAyB,GAAG,GAAG,CAiBxG"}

package/dist/mjs/utils/mask.js

@@ -0,0 +1,54 @@
+import traverse from 'traverse';
+import { AxiosHeaders } from 'axios';
+import { plainClone } from './plain-clone.js';
+/**
+ * List of property names that we want to mask.
+ * Names are not case sensitive.
+ */
+export const SENSITIVE_PROPERTY_NAMES = ['password', 'refresh_token'];
+/**
+ * List of HTTP header names that we want to mask.
+ * Names are not case sensitive.
+ */
+export const SENSITIVE_HEADER_NAMES = ['authorization'];
+/**
+ * The string mask to use if none explicitly provided.
+ */
+export const DEFAULT_MASKING_STRING = '********';
+/**
+ * Mask all properties matching those in {@see SENSITIVE_PROPERTY_NAMES}
+ */
+export function maskSensitiveInput(data) {
+    return maskSensitiveData(data, SENSITIVE_PROPERTY_NAMES);
+}
+/**
+ * Mask all properties matching those in {@see SENSITIVE_HEADER_NAMES}
+ */
+export function maskSensitiveHeaders(data) {
+    return maskSensitiveData(data, SENSITIVE_HEADER_NAMES);
+}
+/**
+ * Mask all properties defined by {@see propertyNames} in the given {@see data} object
+ * with the mask string defined by the {@see mask} parameter.
+ */
+export function maskSensitiveData(data, propertyNames, mask = DEFAULT_MASKING_STRING) {
+    if (typeof data === 'object' && data !== null && data !== undefined) {
+        let mutatedData = {};
+        if (data instanceof AxiosHeaders) {
+            mutatedData = plainClone(data.toJSON());
+        }
+        else {
+            mutatedData = plainClone(data);
+        }
+        traverse(mutatedData).forEach(function () {
+            if (propertyNames.includes(this.key?.toLowerCase() ?? '')) {
+                this.update(mask);
+            }
+        });
+        return mutatedData;
+    }
+    else {
+        return data;
+    }
+}
+//# sourceMappingURL=mask.js.map

package/dist/mjs/utils/mask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mask.js","sourceRoot":"","sources":["../../../src/lib/utils/mask.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAE7C;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAA;AAErE;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,eAAe,CAAC,CAAA;AAEvD;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAA;AAEhD;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAa;IAC9C,OAAO,iBAAiB,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAA;AAC1D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAa;IAChD,OAAO,iBAAiB,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAA;AACxD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAS,EAAE,aAAuB,EAAE,IAAI,GAAG,sBAAsB;IACjG,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACpE,IAAI,WAAW,GAAwB,EAAE,CAAA;QACzC,IAAI,IAAI,YAAY,YAAY,EAAE,CAAC;YACjC,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,CAAwB,CAAA;QAChE,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,UAAU,CAAC,IAAI,CAAwB,CAAA;QACvD,CAAC;QACD,QAAQ,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC;YAC5B,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC1D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;QACH,CAAC,CAAC,CAAA;QACF,OAAO,WAAW,CAAA;IACpB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAA;IACb,CAAC;AACH,CAAC"}

package/dist/mjs/utils/plain-clone.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Clones a plain JavaScript object
+ *
+ * This function only guarantees to clone an object that contains the following types:
+ *  - boolean
+ *  - number
+ *  - string
+ *  - array
+ *  - null
+ *
+ * The object passed to it should not have any other data types within it.
+ */
+export declare function plainClone(source: any): any;
+//# sourceMappingURL=plain-clone.d.ts.map

package/dist/mjs/utils/plain-clone.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plain-clone.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/plain-clone.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,CAE3C"}

package/dist/mjs/utils/plain-clone.js

@@ -0,0 +1,37 @@
+/**
+ * Clones a plain JavaScript object
+ *
+ * This function only guarantees to clone an object that contains the following types:
+ *  - boolean
+ *  - number
+ *  - string
+ *  - array
+ *  - null
+ *
+ * The object passed to it should not have any other data types within it.
+ */
+export function plainClone(source) {
+    return recursiveClone(source, {});
+}
+function recursiveClone(source, target) {
+    if (target && source) {
+        for (const x in source) {
+            if (Object.prototype.hasOwnProperty.call(source, x)) {
+                if (typeof source[x] === 'object') {
+                    if (Array.isArray(source[x])) {
+                        target[x] = [];
+                    }
+                    else {
+                        target[x] = {};
+                    }
+                    target[x] = recursiveClone(source[x], target[x]);
+                }
+                else {
+                    target[x] = source[x];
+                }
+            }
+        }
+    }
+    return target;
+}
+//# sourceMappingURL=plain-clone.js.map

package/dist/mjs/utils/plain-clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plain-clone.js","sourceRoot":"","sources":["../../../src/lib/utils/plain-clone.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CAAC,MAAW;IACpC,OAAO,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AACnC,CAAC;AAED,SAAS,cAAc,CAAC,MAAW,EAAE,MAAW;IAC9C,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACrB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;YACvB,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;gBACpD,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;oBAClC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC7B,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;oBAChB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;oBAChB,CAAC;oBACD,MAAM,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;gBAClD,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;gBACvB,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/mjs/utils/retry-on-conflict.d.ts

@@ -0,0 +1,99 @@
+export interface RetryOnConflictParams<T = any> {
+    /**
+     * Any function that returns a promise
+     *
+     * This function is expected to be able to throw a {@link CommercetoolsError}
+     * with a status code of 409. These errors should **not** be swallowed by the
+     * code in this function.
+     */
+    executeFn: (attemptNo: number) => Promise<T>;
+    /**
+     * The number of milliseconds to wait before retrying a failed request.
+     * This will be increased exponentially {@link CommercetoolsApi.calculateDelay}.
+     * Defaults to 100.
+     */
+    delayMs?: number;
+    /**
+     * The maximum number of times that we'll call the `executeFn` function
+     * before returning the error caught from the last failure.
+     * Defaults to 3.
+     */
+    maxRetries?: number;
+    /**
+     * If enabled, adds a random element to the exponential increase
+     * in retry time. See the following url for more details:
+     * https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
+     * We utilise the 'full' jitter + plus an additional decaying variance.
+     */
+    jitter?: boolean;
+}
+/**
+ * Re-executes a function if a 409 response code is returned from commercetools
+ *
+ * When you make a request to update a resource in commercetools, you may receive a
+ * 409 response code if the resource has been updated since you last fetched it. This
+ * function will re-execute the function passed in to {@link RetryOnConflictParams.executeFn}
+ * in that scenario.
+ *
+ * You should retrieve the latest version of the resource before re-executing the function
+ * that caused the 409 response in the first place.
+ *
+ * For example, in order to update a product, you would first need to fetch the latest
+ * product (or product projection) and then post the update actions:
+ *
+ * ```typescript
+ * import { retryOnConflict, CommercetoolsApi, Region } from '@gradientedge/commercetools-utils'
+ *
+ * const api = new CommercetoolsApi({
+ *   projectKey: 'your-project-key',
+ *   region: Region.EUROPE_GCP,
+ *   clientId: 'your-client-id',
+ *   clientSecret: 'your-client-secret',
+ *   clientScopes: ['manage_products'],
+ * })
+ *
+ * const updatedProduct = await retryOnConflict({
+ *   executeFn: async () => {
+ *     // Get the latest product projection
+ *     const productProjection = await api.getProductProjectionByKey({key: 'dummy-product-id'})
+ *
+ *     // Attempt to update the product. If this fails with a 409, the function
+ *     // will be retried, otherwise the `Product` object will be returned.
+ *     return await api.updateProductById({
+ *       id: productProjection.id,
+ *       data: {
+ *         version: productProjection.version,
+ *         actions: [
+ *           {
+ *             action: 'setMetaTitle',
+ *             metaTitle: {
+ *               en: 'New meta title',
+ *             },
+ *           },
+ *         ],
+ *       },
+ *     })
+ *   },
+ *   // The `executeFn` function will be called a maximum of 3 times (first attempt + 2 retries)
+ *   maxRetries: 2,
+ *   // The delay between for the first retry will be 20ms, increasing exponentially
+ *   delayMs: 20,
+ * })
+ *
+ * console.log(updatedProduct)
+ *
+ * ```
+ *
+ * By default, the function passed in to {@link RetryOnConflictParams.executeFn} will be
+ * retried 3 times, though this can be altered by passing in a different value for the
+ * {@link RetryOnConflictParams.maxRetries} parameter.
+ *
+ * There is by default a 100ms delay after the first unsuccessful attempt, which is then
+ * increases exponentially for each subsequent attempt. This delay can be altered by passing
+ * in a different value for the {@link RetryOnConflictParams.delayMs} parameter.
+ *
+ * If the {@link RetryOnConflictParams.jitter} parameter is set to `true`, then a random
+ * element is added to the exponential increase in retry time.
+ */
+export declare function retryOnConflict<T = any>(options: RetryOnConflictParams): Promise<T>;
+//# sourceMappingURL=retry-on-conflict.d.ts.map

package/dist/mjs/utils/retry-on-conflict.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retry-on-conflict.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/retry-on-conflict.ts"],"names":[],"mappings":"AAiBA,MAAM,WAAW,qBAAqB,CAAC,CAAC,GAAG,GAAG;IAC5C;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAA;IAC5C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,wBAAsB,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,CAAC,CAAC,CAsBzF"}