@etohq/types 1.4.0 → 1.5.1-alpha.0

package/dist/analytics/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./mutations";
+export * from "./service";
+export * from "./provider";
+export * from "./providers";
+//# 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,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

package/dist/analytics/index.js

@@ -0,0 +1,21 @@
+"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("./mutations"), exports);
+__exportStar(require("./service"), exports);
+__exportStar(require("./provider"), exports);
+__exportStar(require("./providers"), 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,8CAA2B;AAC3B,4CAAyB;AACzB,6CAA0B;AAC1B,8CAA2B"}

package/dist/analytics/mutations.d.ts

@@ -0,0 +1,71 @@
+export interface TrackAnalyticsEventDTO {
+    /**
+     * The event name
+     */
+    event: string;
+    /**
+     * The actor of the event, if there is any
+     */
+    actor_id?: string;
+    /**
+     * The group that the event is for, such as an organization or team.
+     */
+    group?: {
+        /**
+         * The name of the group.
+         *
+         * @example
+         * "organization"
+         */
+        type?: string;
+        /**
+         * The group's ID.
+         */
+        id?: string;
+    };
+    /**
+     * The properties of the event. The format and content is dynamic and depends on the integrated provider.
+     */
+    properties?: Record<string, any>;
+}
+export interface IdentifyActorDTO {
+    /**
+     * The actor of the event, if there is any.
+     */
+    actor_id: string;
+    /**
+     * The properties of the actor. The format and content is dynamic and depends on the integrated provider.
+     */
+    properties?: Record<string, any>;
+}
+export interface IdentifyGroupDTO {
+    /**
+     * The group that the event is for, such as an organization or team.
+     */
+    group: {
+        /**
+         * The name of the group.
+         *
+         * @example
+         * "organization"
+         */
+        type: string;
+        /**
+         * The group's ID.
+         */
+        id: string;
+    };
+    /**
+     * When identifying a group, the actor can potentially be passed as well as metadata.
+     */
+    actor_id?: string;
+    /**
+     * The properties of the group. The format and content is dynamic and depends on the integrated provider.
+     */
+    properties?: Record<string, any>;
+}
+/**
+ * Either the `actor_id` or the `group` property must be set.
+ */
+export type IdentifyAnalyticsEventDTO = IdentifyActorDTO | IdentifyGroupDTO;
+//# sourceMappingURL=mutations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/analytics/mutations.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE;QACN;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAA;KACZ,CAAA;IACD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,EAAE;QACL;;;;;WAKG;QACH,IAAI,EAAE,MAAM,CAAA;QACZ;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IACD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,GAAG,gBAAgB,CAAA"}

package/dist/{index-data/sotrage-provider.js → analytics/mutations.js}

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

package/dist/analytics/mutations.js.map

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

package/dist/analytics/provider.d.ts

@@ -0,0 +1,41 @@
+import { IdentifyAnalyticsEventDTO, TrackAnalyticsEventDTO } from "./mutations";
+export type ProviderTrackAnalyticsEventDTO = TrackAnalyticsEventDTO;
+export type ProviderIdentifyAnalyticsEventDTO = IdentifyAnalyticsEventDTO;
+export interface IAnalyticsProvider {
+    /**
+     * This method is used to track an event in the analytics provider
+     *
+     * @param {ProviderTrackAnalyticsEventDTO} data - The data for the event.
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     */
+    track(data: ProviderTrackAnalyticsEventDTO): Promise<void>;
+    /**
+     * This method is used to identify an actor or group in the analytics provider
+     *
+     * @param {ProviderIdentifyAnalyticsEventDTO} data - The data for the actor or group..
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     */
+    identify(data: ProviderIdentifyAnalyticsEventDTO): Promise<void>;
+    /**
+     * This method is used to shutdown the analytics provider, and flush all data before shutting down.
+     *
+     * This method is called by the Analytics Module when the Eto application is shutting down.
+     *
+     * @returns {Promise<void>} Resolves when the provider is shutdown successfully.
+     *
+     * @example
+     * class MyAnalyticsProviderService extends AbstractAnalyticsProviderService {
+     *   // ...
+     *   async shutdown(): Promise<void> {
+     *     // perform any cleanup or shutdown logic
+     *     // in the analytics provider or using custom logic
+     *     // for example:
+     *     await this.client.shutdown()
+     *   }
+     * }
+     */
+    shutdown?(): Promise<void>;
+}
+//# sourceMappingURL=provider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/analytics/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAE/E,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,CAAA;AAEnE,MAAM,MAAM,iCAAiC,GAAG,yBAAyB,CAAA;AAEzE,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,EAAE,iCAAiC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEhE;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B"}

package/dist/analytics/provider.js

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

package/dist/analytics/provider.js.map

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

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

@@ -0,0 +1,3 @@
+export * from "./posthog";
+export * from "./local";
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/analytics/providers/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("./posthog"), exports);
+__exportStar(require("./local"), exports);
+//# sourceMappingURL=index.js.map

package/dist/analytics/providers/index.js.map

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

package/dist/analytics/providers/local.d.ts

@@ -0,0 +1,3 @@
+export interface LocalAnalyticsServiceOptions {
+}
+//# sourceMappingURL=local.d.ts.map

package/dist/analytics/providers/local.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local.d.ts","sourceRoot":"","sources":["../../../src/analytics/providers/local.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,4BAA4B;CAAG"}

package/dist/analytics/providers/local.js

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

package/dist/analytics/providers/local.js.map

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

package/dist/analytics/providers/posthog.d.ts

@@ -0,0 +1,11 @@
+export interface PosthogAnalyticsServiceOptions {
+    /**
+     * The key for the posthog events
+     */
+    posthogEventsKey: string;
+    /**
+     * The endpoint for the posthog server
+     */
+    posthogHost: string;
+}
+//# sourceMappingURL=posthog.d.ts.map

package/dist/analytics/providers/posthog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"posthog.d.ts","sourceRoot":"","sources":["../../../src/analytics/providers/posthog.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB"}

package/dist/analytics/providers/posthog.js

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

package/dist/analytics/providers/posthog.js.map

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

package/dist/analytics/service.d.ts

@@ -0,0 +1,51 @@
+import { IModuleService } from "../modules-sdk";
+import { IdentifyAnalyticsEventDTO, TrackAnalyticsEventDTO } from "./mutations";
+import { IAnalyticsProvider } from "./provider";
+export interface IAnalyticsModuleService extends IModuleService {
+    /**
+     * This method returns the service of the configured Analytics Module Provider in `eto-config.ts`. This is useful
+     * if you want to execute custom methods defined in the provider's service or you need direct access to it.
+     *
+     * @returns {IAnalyticsProvider} An instance of the Analytics Module Provider's service.
+     *
+     * @example
+     * const postHogProviderService = analyticsModuleService.getProvider()
+     * // TODO: perform custom actions with the provider
+     */
+    getProvider(): IAnalyticsProvider;
+    /**
+     * This method tracks an event in the analytics provider. The Analytics Module
+     * will use the `track` method of the underlying provider configured in `eto-config.ts` to track the event.
+     *
+     * @param {TrackAnalyticsEventDTO} data - The event's details.
+     * @returns {Promise<void>} Resolves when the event is tracked successfully.
+     *
+     * @example
+     * await analyticsModuleService.track({
+     *   event: "order_placed",
+     *   properties: {
+     *     order_id: "order_123",
+     *     customer_id: "customer_456",
+     *     total: 100,
+     *   }
+     * })
+     */
+    track(data: TrackAnalyticsEventDTO): Promise<void>;
+    /**
+     * This method identifies an actor or group in the analytics provider. The Analytics Module
+     * will use the `identify` method of the underlying provider configured in `eto-config.ts` to identify the actor or group.
+     *
+     * @param {IdentifyAnalyticsEventDTO} data - The details of the actor or group.
+     * @returns {Promise<void>} Resolves when the actor or group is identified successfully.
+     *
+     * @example
+     * await analyticsModuleService.identify({
+     *   actor_id: "123",
+     *   properties: {
+     *     name: "John Doe"
+     *   }
+     * })
+     */
+    identify(data: IdentifyAnalyticsEventDTO): Promise<void>;
+}
+//# sourceMappingURL=service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/analytics/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAE/C,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D;;;;;;;;;OASG;IACH,WAAW,IAAI,kBAAkB,CAAA;IAEjC;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAElD;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzD"}

package/dist/{link-modules-sdk → analytics}/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/link-modules-sdk/service.ts"],"names":[],"mappings":""}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/analytics/service.ts"],"names":[],"mappings":""}

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

@@ -13,6 +13,8 @@ export interface CreateApiKeyDTO {
     type: ApiKeyType;
     /**
      * Who created the API key.
+     * If the API key type is `secret`, the user can use the created API key's token to authenticate
+     * as explained in the [API Reference](https://docs.etohq.com/api/admin#2-api-token).
      */
     created_by: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/mutations/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CAEnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/mutations/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAA;CAEnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}

package/dist/auth/common/auth-identity.d.ts

@@ -1,4 +1,4 @@
-import type { BaseFilterable } from "../../http/encore";
+import { BaseFilterable } from "../../dal";
 /**
  * @interface
  *

package/dist/auth/common/auth-identity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth-identity.d.ts","sourceRoot":"","sources":["../../../src/auth/common/auth-identity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAGvD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;QAEI;IACJ,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;QAEI;IACJ,mBAAmB,CAAC,EAAE,yBAAyB,EAAE,CAAA;IAEjD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAKV,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,eAAe,CAAA;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAKX,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,cAAc,CAAC,2BAA2B,CAAC;IACnD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE;QACpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IAED,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC;AAED,MAAM,WAAW,+BACf,SAAQ,cAAc,CAAC,+BAA+B,CAAC;IACvD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC"}
+{"version":3,"file":"auth-identity.d.ts","sourceRoot":"","sources":["../../../src/auth/common/auth-identity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;QAEI;IACJ,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAA;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;QAEI;IACJ,mBAAmB,CAAC,EAAE,yBAAyB,EAAE,CAAA;IAEjD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAKV,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,eAAe,CAAA;IAE/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAKX,QAAQ,EAAE,MAAM,CAAA;IAEhB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,2BACf,SAAQ,cAAc,CAAC,2BAA2B,CAAC;IACnD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,mBAAmB,CAAC,EAAE;QACpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,CAAA;IAED,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC;AAED,MAAM,WAAW,+BACf,SAAQ,cAAc,CAAC,+BAA+B,CAAC;IACvD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACxC"}

package/dist/auth/provider.d.ts

@@ -15,16 +15,10 @@ export interface AuthIdentityProviderService {
     setState: (key: string, value: Record<string, unknown>) => Promise<void>;
     getState: (key: string) => Promise<Record<string, unknown> | null>;
 }
-/**
- * ## Overview
- *
- * Authentication provider interface for the auth module.
- *
- */
 export interface IAuthProvider {
     authenticate(data: AuthenticationInput, authIdentityProviderService: AuthIdentityProviderService): Promise<AuthenticationResponse>;
     register(data: AuthenticationInput, authIdentityProviderService: AuthIdentityProviderService): Promise<AuthenticationResponse>;
     validateCallback(data: AuthenticationInput, authIdentityProviderService: AuthIdentityProviderService): Promise<AuthenticationResponse>;
-    update: (data: Record<string, unknown>, authIdentityProviderService: AuthIdentityProviderService) => Promise<AuthenticationResponse>;
+    update(data: Record<string, unknown>, authIdentityProviderService: AuthIdentityProviderService): Promise<AuthenticationResponse>;
 }
 //# sourceMappingURL=provider.d.ts.map

package/dist/auth/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/auth/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EAChB,MAAM,UAAU,CAAA;AAGjB,MAAM,WAAW,2BAA2B;IAE1C,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IACvE,MAAM,EAAE,CAAC,IAAI,EAAE;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IAC9B,MAAM,EAAE,CACN,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE;QACJ,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC,KACE,OAAO,CAAC,eAAe,CAAC,CAAA;IAE7B,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACxE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;CACnE;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,YAAY,CACV,IAAI,EAAE,mBAAmB,EACzB,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAClC,QAAQ,CACN,IAAI,EAAE,mBAAmB,EACzB,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAClC,gBAAgB,CACd,IAAI,EAAE,mBAAmB,EACzB,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAClC,MAAM,EAAE,CACN,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,2BAA2B,EAAE,2BAA2B,KACrD,OAAO,CAAC,sBAAsB,CAAC,CAAA;CACrC"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/auth/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EAChB,MAAM,UAAU,CAAA;AAGjB,MAAM,WAAW,2BAA2B;IAE1C,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAAE,SAAS,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IACvE,MAAM,EAAE,CAAC,IAAI,EAAE;QACb,SAAS,EAAE,MAAM,CAAA;QACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;IAC9B,MAAM,EAAE,CACN,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE;QACJ,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACxC,KACE,OAAO,CAAC,eAAe,CAAC,CAAA;IAE7B,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACxE,QAAQ,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;CACnE;AAED,MAAM,WAAW,aAAa;IAC5B,YAAY,CACV,IAAI,EAAE,mBAAmB,EACzB,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAClC,QAAQ,CACN,IAAI,EAAE,mBAAmB,EACzB,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAClC,gBAAgB,CACd,IAAI,EAAE,mBAAmB,EACzB,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAClC,MAAM,CACJ,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,2BAA2B,EAAE,2BAA2B,GACvD,OAAO,CAAC,sBAAsB,CAAC,CAAA;CACnC"}

package/dist/auth/service.d.ts

@@ -33,7 +33,57 @@ export interface IAuthModuleService extends IModuleService {
      * ```
      */
     authenticate(provider: string, providerData: AuthenticationInput): Promise<AuthenticationResponse>;
+    /**
+     * This method is used to register a user using a provider. The `register` method of the
+     * underlying provider is called, passing it the `providerData` parameter as a parameter. The method
+     * returns the data returned by the provider.
+     *
+     * Refer to [this guide](https://docs.etohq.com/resources/commerce-modules/auth/authentication-route) to learn more about the authentication flows.
+     *
+     * @param {string} provider - The ID of the provider to register the user with.
+     * @param {AuthenticationInput} providerData - The data to pass to the provider to register the user.
+     * @returns {Promise<AuthenticationResponse>} The details of the registration result.
+     *
+     * @example
+     * The following example is in the context of an API route, where
+     * `req` is an instance of the `EtoRequest` object:
+     *
+     * ```ts
+     * const { success, authIdentity, location, error } =
+     *   await authModuleService.register("emailpass", {
+     *     url: req.url,
+     *     headers: req.headers,
+     *     query: req.query,
+     *     body: req.body,
+     *     protocol: req.protocol,
+     *   } as AuthenticationInput)
+     * ```
+     */
     register(provider: string, providerData: AuthenticationInput): Promise<AuthenticationResponse>;
+    /**
+     * This method updates an auth identity's details using the provider that created it. It uses the `update` method of the
+     * underlying provider, passing it the `providerData` parameter as a parameter. The method
+     * returns the data returned by the provider.
+     *
+     * @param {string} provider - The ID of the provider to update the auth identity with.
+     * @param {Record<string, unknown>} providerData - The data to pass to the provider to update the auth identity.
+     * @returns {Promise<AuthenticationResponse>} The details of the update result.
+     *
+     * @example
+     * The following example is in the context of an API route, where
+     * `req` is an instance of the `EtoRequest` object:
+     *
+     * ```ts
+     * const { success, authIdentity, location, error } =
+     *   await authModuleService.updateProvider("emailpass", {
+     *     email: "user@example.com",
+     *     password: "password",
+     *     // The ID of a user, customer, or custom actor type that is being updated.
+     *     // For example, `user_123`.
+     *     entity_id: req.auth_context.actor_id,
+     *   })
+     * ```
+     */
     updateProvider(provider: string, providerData: Record<string, unknown>): Promise<AuthenticationResponse>;
     /**
      * When authenticating users with a third-party provider, such as Google, the user performs an

package/dist/auth/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/auth/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,yBAAyB,EACzB,2BAA2B,EAC3B,+BAA+B,EAC/B,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC,cAAc,CACZ,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,gBAAgB,CACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,0BAA0B,CACxB,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3E;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,EACxC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,+BAA+B,EACzC,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,EACxC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAAE,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAAE,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;;;;;;;OASG;IACH,wBAAwB,CACtB,GAAG,EAAE,MAAM,EAAE,EACb,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/auth/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,yBAAyB,EACzB,2BAA2B,EAC3B,+BAA+B,EAC/B,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EAC1B,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,YAAY,CACV,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,cAAc,CACZ,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,gBAAgB,CACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,mBAAmB,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAElC;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,kBAAkB,CAChB,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,0BAA0B,CACxB,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEvC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;OAWG;IACH,oBAAoB,CAClB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;OASG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3E;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,EACxC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,+BAA+B,EACzC,MAAM,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,EACxC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAAE,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAAE,EACjC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC,CAAA;IAEjC;;;;;;;;;;;OAWG;IACH,wBAAwB,CACtB,IAAI,EAAE,yBAAyB,EAC/B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,mBAAmB,CAAC,CAAA;IAE/B;;;;;;;;;OASG;IACH,wBAAwB,CACtB,GAAG,EAAE,MAAM,EAAE,EACb,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,IAAI,CAAC,CAAA;CACjB"}

package/dist/bundles.d.ts

@@ -1,4 +1,5 @@
 export * as AdminTypes from "./admin";
+export * as AnalyticsTypes from "./analytics";
 export * as ApiKeyTypes from "./api-key";
 export * as AuthTypes from "./auth";
 export * as CacheTypes from "./cache";
@@ -11,7 +12,7 @@ export * as FileTypes from "./file";
 export * as HttpTypes from "./http";
 export * as LoggerTypes from "./logger";
 export * as ModulesSdkTypes from "./modules-sdk";
-export * as LinkModulesSdkTypes from "./link-modules-sdk";
+export * as LinkModulesSdkTypes from "./link-modules";
 export * as NotificationTypes from "./notification";
 export * as SearchTypes from "./search";
 export * as TransactionBaseTypes from "./transaction-base";

package/dist/bundles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.d.ts","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,WAAW,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAA;AAC5B,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,aAAa,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,gBAAgB,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,eAAe,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,mBAAmB,MAAM,oBAAoB,CAAA;AACzD,OAAO,KAAK,iBAAiB,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,oBAAoB,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,iBAAiB,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"bundles.d.ts","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,cAAc,MAAM,aAAa,CAAA;AAC7C,OAAO,KAAK,WAAW,MAAM,WAAW,CAAA;AACxC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,UAAU,MAAM,SAAS,CAAA;AACrC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,GAAG,MAAM,OAAO,CAAA;AAC5B,OAAO,KAAK,QAAQ,MAAM,OAAO,CAAA;AACjC,OAAO,KAAK,aAAa,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,gBAAgB,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,eAAe,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,mBAAmB,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,iBAAiB,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,WAAW,MAAM,UAAU,CAAA;AACvC,OAAO,KAAK,oBAAoB,MAAM,oBAAoB,CAAA;AAC1D,OAAO,KAAK,SAAS,MAAM,QAAQ,CAAA;AACnC,OAAO,KAAK,aAAa,MAAM,YAAY,CAAA;AAC3C,OAAO,KAAK,iBAAiB,MAAM,iBAAiB,CAAA;AACpD,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAA"}

package/dist/bundles.js

@@ -33,8 +33,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexTypes = exports.WorkflowsSdkTypes = exports.WorkflowTypes = exports.UserTypes = exports.TransactionBaseTypes = exports.SearchTypes = exports.NotificationTypes = exports.LinkModulesSdkTypes = exports.ModulesSdkTypes = exports.LoggerTypes = exports.HttpTypes = exports.FileTypes = exports.FeatureFlagTypes = exports.EventBusTypes = exports.DmlTypes = exports.DAL = exports.CommonTypes = exports.CacheTypes = exports.AuthTypes = exports.ApiKeyTypes = exports.AdminTypes = void 0;
+exports.IndexTypes = exports.WorkflowsSdkTypes = exports.WorkflowTypes = exports.UserTypes = exports.TransactionBaseTypes = exports.SearchTypes = exports.NotificationTypes = exports.LinkModulesSdkTypes = exports.ModulesSdkTypes = exports.LoggerTypes = exports.HttpTypes = exports.FileTypes = exports.FeatureFlagTypes = exports.EventBusTypes = exports.DmlTypes = exports.DAL = exports.CommonTypes = exports.CacheTypes = exports.AuthTypes = exports.ApiKeyTypes = exports.AnalyticsTypes = exports.AdminTypes = void 0;
 exports.AdminTypes = __importStar(require("./admin"));
+exports.AnalyticsTypes = __importStar(require("./analytics"));
 exports.ApiKeyTypes = __importStar(require("./api-key"));
 exports.AuthTypes = __importStar(require("./auth"));
 exports.CacheTypes = __importStar(require("./cache"));
@@ -47,7 +48,7 @@ exports.FileTypes = __importStar(require("./file"));
 exports.HttpTypes = __importStar(require("./http"));
 exports.LoggerTypes = __importStar(require("./logger"));
 exports.ModulesSdkTypes = __importStar(require("./modules-sdk"));
-exports.LinkModulesSdkTypes = __importStar(require("./link-modules-sdk"));
+exports.LinkModulesSdkTypes = __importStar(require("./link-modules"));
 exports.NotificationTypes = __importStar(require("./notification"));
 exports.SearchTypes = __importStar(require("./search"));
 exports.TransactionBaseTypes = __importStar(require("./transaction-base"));

package/dist/bundles.js.map

@@ -1 +1 @@
-{"version":3,"file":"bundles.js","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAqC;AACrC,yDAAwC;AACxC,oDAAmC;AACnC,sDAAqC;AACrC,wDAAuC;AACvC,6CAA4B;AAC5B,kDAAiC;AACjC,6DAA4C;AAC5C,mEAAkD;AAClD,oDAAmC;AACnC,oDAAmC;AACnC,wDAAuC;AACvC,iEAAgD;AAChD,0EAAyD;AACzD,oEAAmD;AACnD,wDAAuC;AACvC,2EAA0D;AAC1D,oDAAmC;AACnC,4DAA2C;AAC3C,qEAAoD;AACpD,iEAAgD"}
+{"version":3,"file":"bundles.js","sourceRoot":"","sources":["../src/bundles.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sDAAqC;AACrC,8DAA6C;AAC7C,yDAAwC;AACxC,oDAAmC;AACnC,sDAAqC;AACrC,wDAAuC;AACvC,6CAA4B;AAC5B,kDAAiC;AACjC,6DAA4C;AAC5C,mEAAkD;AAClD,oDAAmC;AACnC,oDAAmC;AACnC,wDAAuC;AACvC,iEAAgD;AAChD,sEAAqD;AACrD,oEAAmD;AACnD,wDAAuC;AACvC,2EAA0D;AAC1D,oDAAmC;AACnC,4DAA2C;AAC3C,qEAAoD;AACpD,iEAAgD"}

package/dist/cache/service.d.ts

@@ -1,6 +1,33 @@
 export interface ICacheService {
+    /**
+     * This method retrieves data from the cache.
+     *
+     * @param key - The key of the item to retrieve.
+     * @returns The item that was stored in the cache. If the item was not found, null is returned.
+     *
+     * @example
+     * const data = await cacheModuleService.get("my-key")
+     */
     get<T>(key: string): Promise<T | null>;
+    /**
+     * This method stores data in the cache.
+     *
+     * @param key - The key of the item to store.
+     * @param data - The data to store in the cache.
+     * @param ttl - The time-to-live (TTL) value in seconds. If not provided, the default TTL value is used. The default value is based on the used Cache Module.
+     *
+     * @example
+     * await cacheModuleService.set("my-key", { product_id: "prod_123" }, 60)
+     */
     set(key: string, data: unknown, ttl?: number): Promise<void>;
+    /**
+     * This method removes an item from the cache.
+     *
+     * @param key - The key of the item to remove.
+     *
+     * @example
+     * await cacheModuleService.invalidate("my-key")
+     */
     invalidate(key: string): Promise<void>;
 }
 //# sourceMappingURL=service.d.ts.map

package/dist/cache/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/cache/service.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACtC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/cache/service.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B;;;;;;;;OAQG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IACtC;;;;;;;;;OASG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5D;;;;;;;OAOG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACvC"}