@gradientedge/commercetools-utils 1.54.1 → 1.55.0

package/build/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/build/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,UAoCzC"}

package/build/utils/format.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatAsKey = void 0;
+var error_1 = require("../error");
+/**
+ * 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
+ */
+function formatAsKey(input) {
+    var output = '';
+    if (typeof input !== 'string') {
+        throw new error_1.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 error_1.CommercetoolsError("Formatted key did not meet minimum length of 2 characters: " + output);
+    }
+    if (output.length > 256) {
+        throw new error_1.CommercetoolsError("Formatted key exceeds the maximum length of 256 characters: " + output);
+    }
+    return output;
+}
+exports.formatAsKey = formatAsKey;
+//# sourceMappingURL=format.js.map

package/build/utils/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/lib/utils/format.ts"],"names":[],"mappings":";;;AAAA,kCAA6C;AAE7C;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAM,IAAI,0BAAkB,CAAC,wCAAwC,CAAC,CAAA;KACvE;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;QACtC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;KACzB;IACD,6BAA6B;IAC7B,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QACtD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;KAC7B;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,0BAAkB,CAAC,gEAA8D,MAAQ,CAAC,CAAA;KACrG;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;QACvB,MAAM,IAAI,0BAAkB,CAAC,iEAA+D,MAAQ,CAAC,CAAA;KACtG;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AApCD,kCAoCC"}

package/build/utils/index.d.ts

@@ -1,12 +1,4 @@
-export declare function buildUserAgent(systemIdentifier?: string): string;
-/**
- * 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: string): string;
+export * from './format';
+export * from './useragent';
+export * from './mask';
 //# sourceMappingURL=index.d.ts.map

package/build/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/utils/index.ts"],"names":[],"mappings":"AAUA,wBAAgB,cAAc,CAAC,gBAAgB,CAAC,EAAE,MAAM,UAMvD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,UAoCxC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA"}

package/build/utils/index.js

@@ -1,64 +1,16 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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 });
-exports.formatAsKey = exports.buildUserAgent = void 0;
-/**
- * Build a string suitable for sending as the `User-Agent` HTTP header.
- * This should contain information that allows commercetools to easily
- * identify the source of the request. The `systemIdentifier` comes from
- * {@see CommercetoolsApiConfig.systemIdentifier} and should be a string
- * that uniquely identifies the application where this package is being
- * used.
- */
-var error_1 = require("../error");
-function buildUserAgent(systemIdentifier) {
-    var userAgent = "@gradientedge/commercetools-utils";
-    if (systemIdentifier) {
-        userAgent = userAgent + " (" + systemIdentifier + ")";
-    }
-    return userAgent;
-}
-exports.buildUserAgent = buildUserAgent;
-/**
- * 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
- */
-function formatAsKey(input) {
-    var output = '';
-    if (typeof input !== 'string') {
-        throw new error_1.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 error_1.CommercetoolsError("Formatted key did not meet minimum length of 2 characters: " + output);
-    }
-    if (output.length > 256) {
-        throw new error_1.CommercetoolsError("Formatted key exceeds the maximum length of 256 characters: " + output);
-    }
-    return output;
-}
-exports.formatAsKey = formatAsKey;
+__exportStar(require("./format"), exports);
+__exportStar(require("./useragent"), exports);
+__exportStar(require("./mask"), exports);
 //# sourceMappingURL=index.js.map

package/build/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/utils/index.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,kCAA6C;AAE7C,SAAgB,cAAc,CAAC,gBAAyB;IACtD,IAAI,SAAS,GAAG,mCAAmC,CAAA;IACnD,IAAI,gBAAgB,EAAE;QACpB,SAAS,GAAM,SAAS,UAAK,gBAAgB,MAAG,CAAA;KACjD;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAND,wCAMC;AAED;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,KAAa;IACvC,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,MAAM,IAAI,0BAAkB,CAAC,wCAAwC,CAAC,CAAA;KACvE;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;QACtC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;KACzB;IACD,6BAA6B;IAC7B,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;QACtD,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;KAC7B;IAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,0BAAkB,CAAC,gEAA8D,MAAQ,CAAC,CAAA;KACrG;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;QACvB,MAAM,IAAI,0BAAkB,CAAC,iEAA+D,MAAQ,CAAC,CAAA;KACtG;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AApCD,kCAoCC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAwB;AACxB,8CAA2B;AAC3B,yCAAsB"}

package/build/utils/useragent.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Build a string suitable for sending as the `User-Agent` HTTP header.
+ * This should contain information that allows commercetools to easily
+ * identify the source of the request. The `systemIdentifier` comes from
+ * {@see CommercetoolsApiConfig.systemIdentifier} and should be a string
+ * that uniquely identifies the application where this package is being
+ * used.
+ */
+export declare function buildUserAgent(systemIdentifier?: string): string;
+//# sourceMappingURL=useragent.d.ts.map

package/build/utils/useragent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useragent.d.ts","sourceRoot":"","sources":["../../src/lib/utils/useragent.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,gBAAgB,CAAC,EAAE,MAAM,UAMvD"}

package/build/utils/useragent.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildUserAgent = void 0;
+/**
+ * Build a string suitable for sending as the `User-Agent` HTTP header.
+ * This should contain information that allows commercetools to easily
+ * identify the source of the request. The `systemIdentifier` comes from
+ * {@see CommercetoolsApiConfig.systemIdentifier} and should be a string
+ * that uniquely identifies the application where this package is being
+ * used.
+ */
+function buildUserAgent(systemIdentifier) {
+    var userAgent = "@gradientedge/commercetools-utils";
+    if (systemIdentifier) {
+        userAgent = userAgent + " (" + systemIdentifier + ")";
+    }
+    return userAgent;
+}
+exports.buildUserAgent = buildUserAgent;
+//# sourceMappingURL=useragent.js.map

package/build/utils/useragent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useragent.js","sourceRoot":"","sources":["../../src/lib/utils/useragent.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,SAAgB,cAAc,CAAC,gBAAyB;IACtD,IAAI,SAAS,GAAG,mCAAmC,CAAA;IACnD,IAAI,gBAAgB,EAAE;QACpB,SAAS,GAAM,SAAS,UAAK,gBAAgB,MAAG,CAAA;KACjD;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAND,wCAMC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gradientedge/commercetools-utils",
-  "version": "1.54.1",
+  "version": "1.55.0",
   "description": "Provide utility classes and functions for interacting with the commercetools API",
   "main": "build/index.js",
   "scripts": {