@acmekit/utils 2.13.1

package/dist/analytics/abstract-analytics-provider.d.ts

@@ -0,0 +1,110 @@
+import { IAnalyticsProvider, ProviderIdentifyAnalyticsEventDTO, ProviderTrackAnalyticsEventDTO } from "@acmekit/types";
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { Logger } from "@acmekit/framework/types"
+ * import { AbstractAnalyticsProviderService } from "@acmekit/framework/utils"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   static identifier = "my-analytics"
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyAnalyticsProviderService
+ * ```
+ */
+export declare class AbstractAnalyticsProviderService implements IAnalyticsProvider {
+    /**
+     * Each analytics provider has a unique ID used to identify it. The provider's ID
+     * will be stored as `aly_{identifier}_{id}`, where `{id}` is the provider's `id`
+     * property in the `acmekit-config.ts`.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   static identifier = "my-analytics"
+     *   // ...
+     * }
+     */
+    static identifier: string;
+    /**
+     * @ignore
+     */
+    getIdentifier(): any;
+    /**
+     * This method tracks an event with the third-party analytics provider. The Analytics Module
+     * will use this method in its `track` method if your provider is configured in `acmekit-config.ts`.
+     *
+     * You can send the event to the third-party provider based on its semantics.
+     *
+     * @param {ProviderTrackAnalyticsEventDTO} data - The event's details.
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async track(
+     *     data: ProviderTrackAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // track event to third-party provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.track(data)
+     *   }
+     * }
+     */
+    track(data: ProviderTrackAnalyticsEventDTO): Promise<void>;
+    /**
+     * This method identifies an actor or group in the third-party analytics provider. The Analytics Module
+     * will use this method in its `identify` method if your provider is configured in `acmekit-config.ts`.
+     *
+     * @param {ProviderIdentifyAnalyticsEventDTO} data - The details of the actor or group.
+     * @returns {Promise<void>} Resolves when the actor or group is identified successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async identify(
+     *     data: ProviderIdentifyAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // identify actor or group in the analytics provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.identify(data)
+     *   }
+     * }
+     */
+    identify(data: ProviderIdentifyAnalyticsEventDTO): Promise<void>;
+}
+//# sourceMappingURL=abstract-analytics-provider.d.ts.map

package/dist/analytics/abstract-analytics-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-analytics-provider.d.ts","sourceRoot":"","sources":["../../src/analytics/abstract-analytics-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,iCAAiC,EACjC,8BAA8B,EAC/B,MAAM,gBAAgB,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,qBAAa,gCAAiC,YAAW,kBAAkB;IACzE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,UAAU,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,aAAa;IAIb;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,KAAK,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,QAAQ,CAAC,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC;CAGvE"}

package/dist/analytics/abstract-analytics-provider.js

@@ -0,0 +1,107 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractAnalyticsProviderService = void 0;
+/**
+ * ### constructor
+ *
+ * The constructor allows you to access resources from the module's container using the first parameter,
+ * and the module's options using the second parameter.
+ *
+ * If you're creating a client or establishing a connection with a third-party service, do it in the constructor.
+ *
+ * #### Example
+ *
+ * ```ts
+ * import { Logger } from "@acmekit/framework/types"
+ * import { AbstractAnalyticsProviderService } from "@acmekit/framework/utils"
+ *
+ * type InjectedDependencies = {
+ *   logger: Logger
+ * }
+ *
+ * type Options = {
+ *   apiKey: string
+ * }
+ *
+ * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+ *   protected logger_: Logger
+ *   protected options_: Options
+ *   static identifier = "my-analytics"
+ *   // assuming you're initializing a client
+ *   protected client
+ *
+ *   constructor (
+ *     { logger }: InjectedDependencies,
+ *     options: Options
+ *   ) {
+ *     super()
+ *
+ *     this.logger_ = logger
+ *     this.options_ = options
+ *
+ *     // assuming you're initializing a client
+ *     this.client = new Client(options)
+ *   }
+ * }
+ *
+ * export default MyAnalyticsProviderService
+ * ```
+ */
+class AbstractAnalyticsProviderService {
+    /**
+     * @ignore
+     */
+    getIdentifier() {
+        return this.constructor.identifier;
+    }
+    /**
+     * This method tracks an event with the third-party analytics provider. The Analytics Module
+     * will use this method in its `track` method if your provider is configured in `acmekit-config.ts`.
+     *
+     * You can send the event to the third-party provider based on its semantics.
+     *
+     * @param {ProviderTrackAnalyticsEventDTO} data - The event's details.
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async track(
+     *     data: ProviderTrackAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // track event to third-party provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.track(data)
+     *   }
+     * }
+     */
+    async track(data) {
+        throw Error("track must be overridden by the child class");
+    }
+    /**
+     * This method identifies an actor or group in the third-party analytics provider. The Analytics Module
+     * will use this method in its `identify` method if your provider is configured in `acmekit-config.ts`.
+     *
+     * @param {ProviderIdentifyAnalyticsEventDTO} data - The details of the actor or group.
+     * @returns {Promise<void>} Resolves when the actor or group is identified successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async identify(
+     *     data: ProviderIdentifyAnalyticsEventDTO
+     *   ): Promise<void> {
+     *     // identify actor or group in the analytics provider
+     *     // or using custom logic
+     *     // for example:
+     *     this.client.identify(data)
+     *   }
+     * }
+     */
+    async identify(data) {
+        throw Error("identify must be overridden by the child class");
+    }
+}
+exports.AbstractAnalyticsProviderService = AbstractAnalyticsProviderService;
+//# sourceMappingURL=abstract-analytics-provider.js.map

package/dist/analytics/abstract-analytics-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-analytics-provider.js","sourceRoot":"","sources":["../../src/analytics/abstract-analytics-provider.ts"],"names":[],"mappings":";;;AAMA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAa,gCAAgC;IAc3C;;OAEG;IACH,aAAa;QACX,OAAQ,IAAI,CAAC,WAAmB,CAAC,UAAU,CAAA;IAC7C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,KAAK,CAAC,IAAoC;QAC9C,MAAM,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAC5D,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAK,CAAC,QAAQ,CAAC,IAAuC;QACpD,MAAM,KAAK,CAAC,gDAAgD,CAAC,CAAA;IAC/D,CAAC;CACF;AAtED,4EAsEC"}

package/dist/analytics/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./abstract-analytics-provider";
+//# sourceMappingURL=index.d.ts.map

package/dist/analytics/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAA"}

package/dist/analytics/index.js

@@ -0,0 +1,18 @@
+"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("./abstract-analytics-provider"), exports);
+//# sourceMappingURL=index.js.map

package/dist/analytics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/analytics/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA6C"}

package/dist/api-key/api-key-type.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @enum
+ *
+ * The API key's type.
+ */
+export declare enum ApiKeyType {
+    /**
+     * Publishable key that is tied to eg. a sales channel
+     */
+    PUBLISHABLE = "publishable",
+    /**
+     * Secret key that allows access to the admin API
+     */
+    SECRET = "secret"
+}
+export declare const PUBLISHABLE_KEY_HEADER = "x-publishable-api-key";
+//# sourceMappingURL=api-key-type.d.ts.map

package/dist/api-key/api-key-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-type.d.ts","sourceRoot":"","sources":["../../src/api-key/api-key-type.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,UAAU;IACpB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,MAAM,WAAW;CAClB;AAED,eAAO,MAAM,sBAAsB,0BAA0B,CAAA"}

package/dist/api-key/api-key-type.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PUBLISHABLE_KEY_HEADER = exports.ApiKeyType = void 0;
+/**
+ * @enum
+ *
+ * The API key's type.
+ */
+var ApiKeyType;
+(function (ApiKeyType) {
+    /**
+     * Publishable key that is tied to eg. a sales channel
+     */
+    ApiKeyType["PUBLISHABLE"] = "publishable";
+    /**
+     * Secret key that allows access to the admin API
+     */
+    ApiKeyType["SECRET"] = "secret";
+})(ApiKeyType || (exports.ApiKeyType = ApiKeyType = {}));
+exports.PUBLISHABLE_KEY_HEADER = "x-publishable-api-key";
+//# sourceMappingURL=api-key-type.js.map

package/dist/api-key/api-key-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key-type.js","sourceRoot":"","sources":["../../src/api-key/api-key-type.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,IAAY,UASX;AATD,WAAY,UAAU;IACpB;;OAEG;IACH,yCAA2B,CAAA;IAC3B;;OAEG;IACH,+BAAiB,CAAA;AACnB,CAAC,EATW,UAAU,0BAAV,UAAU,QASrB;AAEY,QAAA,sBAAsB,GAAG,uBAAuB,CAAA"}

package/dist/api-key/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api-key-type";
+//# sourceMappingURL=index.d.ts.map

package/dist/api-key/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-key/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA"}

package/dist/api-key/index.js

@@ -0,0 +1,18 @@
+"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("./api-key-type"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api-key/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api-key/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA8B"}