@acmekit/types 2.13.1

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

@@ -0,0 +1,65 @@
+import { AuthIdentityDTO } from "./auth-identity";
+/**
+ * @interface
+ *
+ * The details of the authentication response.
+ */
+export type AuthenticationResponse = {
+    /**
+     * Whether the authentication was successful.
+     */
+    success: boolean;
+    /**
+     * The authenticated user's details.
+     */
+    authIdentity?: AuthIdentityDTO;
+    /**
+     * If an error occurs during the authentication process,
+     * whether within the Auth Module or a third-party provider,
+     * the error message is set in this field.
+     */
+    error?: string;
+    /**
+     * The URL to redirect to for further authentication action
+     * with a third-party provider. This takes precedence before
+     * the `success` field.
+     *
+     * So, after checking that authentication is successful,
+     * you should check whether this field is defined and, if so, redirect to the
+     * specified location.
+     */
+    location?: string;
+};
+/**
+ * @interface
+ *
+ * The data passed to the auth provider when authenticating a user
+ * or validating a callback.
+ */
+export type AuthenticationInput = {
+    /**
+     * URL of the incoming authentication request.
+     */
+    url?: string;
+    /**
+     * Headers of incoming authentication request.
+     */
+    headers?: Record<string, string>;
+    /**
+     *  Query params of the incoming authentication request.
+     */
+    query?: Record<string, string>;
+    /**
+     * Body of the incoming authentication request.
+     *
+     * One of the arguments that is suggested to be treated in a standard manner is a `callback_url` field.
+     * The field specifies where the user is redirected to after a successful authentication in the case of Oauth auhentication.
+     * If not passed, the provider will fallback to the callback_url provided in the provider options.
+     */
+    body?: Record<string, string>;
+    /**
+     * Protocol of the incoming authentication request (For example, `https`).
+     */
+    protocol?: string;
+};
+//# sourceMappingURL=provider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/auth/common/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAAA;IAE9B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;;;;;OAQG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEhC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE9B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA"}

package/dist/auth/common/provider.js

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

package/dist/auth/common/provider.js.map

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

package/dist/auth/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./service";
+export * from "./common";
+export * from "./provider";
+export * from "./providers";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA"}

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

package/dist/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,2CAAwB;AACxB,6CAA0B;AAC1B,8CAA2B"}

package/dist/auth/provider.d.ts

@@ -0,0 +1,24 @@
+import { AuthenticationInput, AuthenticationResponse, AuthIdentityDTO } from "./common";
+export interface AuthIdentityProviderService {
+    retrieve: (selector: {
+        entity_id: string;
+    }) => Promise<AuthIdentityDTO>;
+    create: (data: {
+        entity_id: string;
+        provider_metadata?: Record<string, unknown>;
+        user_metadata?: Record<string, unknown>;
+    }) => Promise<AuthIdentityDTO>;
+    update: (entity_id: string, data: {
+        provider_metadata?: Record<string, unknown>;
+        user_metadata?: Record<string, unknown>;
+    }) => Promise<AuthIdentityDTO>;
+    setState: (key: string, value: Record<string, unknown>) => Promise<void>;
+    getState: (key: string) => Promise<Record<string, unknown> | null>;
+}
+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>;
+}
+//# sourceMappingURL=provider.d.ts.map

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

@@ -0,0 +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,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/provider.js

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

package/dist/auth/provider.js.map

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

package/dist/auth/providers/emailpass.d.ts

@@ -0,0 +1,8 @@
+export interface EmailPassAuthProviderOptions {
+    hashConfig?: {
+        logN: number;
+        r: number;
+        p: number;
+    };
+}
+//# sourceMappingURL=emailpass.d.ts.map

package/dist/auth/providers/emailpass.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emailpass.d.ts","sourceRoot":"","sources":["../../../src/auth/providers/emailpass.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,4BAA4B;IAC3C,UAAU,CAAC,EAAE;QACX,IAAI,EAAE,MAAM,CAAA;QACZ,CAAC,EAAE,MAAM,CAAA;QACT,CAAC,EAAE,MAAM,CAAA;KACV,CAAA;CACF"}

package/dist/auth/providers/emailpass.js

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

package/dist/auth/providers/emailpass.js.map

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

package/dist/auth/providers/github.d.ts

@@ -0,0 +1,6 @@
+export interface GithubAuthProviderOptions {
+    clientId: string;
+    clientSecret: string;
+    callbackUrl: string;
+}
+//# sourceMappingURL=github.d.ts.map

package/dist/auth/providers/github.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../../../src/auth/providers/github.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB"}

package/dist/auth/providers/github.js

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

package/dist/auth/providers/github.js.map

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

package/dist/auth/providers/google.d.ts

@@ -0,0 +1,6 @@
+export interface GoogleAuthProviderOptions {
+    clientId: string;
+    clientSecret: string;
+    callbackUrl: string;
+}
+//# sourceMappingURL=google.d.ts.map

package/dist/auth/providers/google.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"google.d.ts","sourceRoot":"","sources":["../../../src/auth/providers/google.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;CACpB"}

package/dist/auth/providers/google.js

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

package/dist/auth/providers/google.js.map

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

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

@@ -0,0 +1,4 @@
+export * from "./emailpass";
+export * from "./google";
+export * from "./github";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/auth/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}

package/dist/auth/providers/index.js

@@ -0,0 +1,20 @@
+"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("./emailpass"), exports);
+__exportStar(require("./google"), exports);
+__exportStar(require("./github"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/auth/providers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,2CAAwB;AACxB,2CAAwB"}

package/dist/auth/service.d.ts

@@ -0,0 +1,405 @@
+import { FindConfig } from "../common";
+import { IModuleService } from "../modules-sdk";
+import { Context } from "../shared-context";
+import { AuthenticationInput, AuthenticationResponse, AuthIdentityDTO, CreateAuthIdentityDTO, CreateProviderIdentityDTO, FilterableAuthIdentityProps, FilterableProviderIdentityProps, ProviderIdentityDTO, UpdateAuthIdentityDTO, UpdateProviderIdentityDTO } from "./common";
+/**
+ * The main service interface for the Auth Module.
+ */
+export interface IAuthModuleService extends IModuleService {
+    /**
+     * This method is used to authenticate a user using a provider. The `authenticate` 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.acmekit.com/resources/commerce-modules/auth/authentication-route) to learn more about the authentication flows.
+     *
+     * @param {string} provider - The ID of the provider to authenticate the user with.
+     * @param {AuthenticationInput} providerData - The data to pass to the provider to authenticate the user.
+     * @returns {Promise<AuthenticationResponse>} The details of the authentication result.
+     *
+     * @example
+     * The following example is in the context of an API route, where
+     * `req` is an instance of the `AcmeKitRequest` object:
+     *
+     * ```ts
+     * const { success, authIdentity, location, error } =
+     *   await authModuleService.authenticate("emailpass", {
+     *     url: req.url,
+     *     headers: req.headers,
+     *     query: req.query,
+     *     body: req.body,
+     *     protocol: req.protocol,
+     *   } as AuthenticationInput)
+     * ```
+     */
+    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.acmekit.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 `AcmeKitRequest` 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 `AcmeKitRequest` 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
+     * action to finish the authentication, such as enter their credentials in Google's sign-in
+     * form.
+     *
+     * In those cases, you must create an API route or endpoint that's called by the third-party
+     * provider when the user finishes performing the required action.
+     *
+     * In that API route, you can call this method to validate the third-party provider's
+     * callback and authenticate the user.
+     *
+     * Learn more about this authentication flow in [this guide](https://docs.acmekit.com/resources/commerce-modules/auth/authentication-route#2-third-party-service-authenticate-flow).
+     *
+     * @param {string} provider - The ID of the provider to use to validate the callback.
+     * @param {AuthenticationInput} providerData - The data to pass to the provider to validate the callback.
+     * @returns {Promise<AuthenticationResponse>} The details of the authentication result.
+     *
+     * @example
+     * The following example is in the context of an API route, where
+     * `req` is an instance of the `AcmeKitRequest` object:
+     *
+     * ```ts
+     * const { success, authIdentity, error } =
+     *   await authModuleService.validateCallback("google", {
+     *     url: req.url,
+     *     headers: req.headers,
+     *     query: req.query,
+     *     body: req.body,
+     *     protocol: req.protocol,
+     *   } as AuthenticationInput)
+     * ```
+     *
+     */
+    validateCallback(provider: string, providerData: AuthenticationInput): Promise<AuthenticationResponse>;
+    /**
+     * This method retrieves an auth identity by its ID.
+     *
+     * @param {string} id - The ID of the auth identity.
+     * @param {FindConfig<AuthIdentityDTO>} config - The configurations determining how the auth identity is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a auth identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<AuthIdentityDTO>} The retrieved auth identity.
+     *
+     * @example
+     * const authIdentity = await authModuleService.retrieveAuthIdentity("authusr_1")
+     */
+    retrieveAuthIdentity(id: string, config?: FindConfig<AuthIdentityDTO>, sharedContext?: Context): Promise<AuthIdentityDTO>;
+    /**
+     * This method retrieves a paginated list of auth identities based on optional filters and configuration.
+     *
+     * @param {FilterableAuthIdentityProps} filters - The filters to apply on the retrieved auth identities.
+     * @param {FindConfig<AuthIdentityDTO>} config - The configurations determining how the auth identity is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a auth identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<AuthIdentityDTO[]>} The list of auth identities.
+     *
+     * @example
+     * To retrieve a list of auth identities using their IDs:
+     *
+     * ```ts
+     * const authIdentities = await authModuleService.listAuthIdentities({
+     *   id: ["authusr_123", "authusr_321"],
+     * })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const authIdentities = await authModuleService.listAuthIdentities(
+     *   {
+     *     id: ["authusr_123", "authusr_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listAuthIdentities(filters?: FilterableAuthIdentityProps, config?: FindConfig<AuthIdentityDTO>, sharedContext?: Context): Promise<AuthIdentityDTO[]>;
+    /**
+     * This method retrieves a paginated list of auth identities along with the total count of available auth identities satisfying the provided filters.
+     *
+     * @param {FilterableAuthIdentityProps} filters - The filters to apply on the retrieved auth identities.
+     * @param {FindConfig<AuthIdentityDTO>} config - The configurations determining how the auth identity is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a auth identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[AuthIdentityDTO[], number]>} The list of auth identities along with their total count.
+     *
+     * @example
+     * To retrieve a list of auth identities using their IDs:
+     *
+     * ```ts
+     * const [authIdentities, count] =
+     *   await authModuleService.listAndCountAuthIdentities({
+     *     id: ["authusr_123", "authusr_321"],
+     *   })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const [authIdentities, count] =
+     *   await authModuleService.listAndCountAuthIdentities(
+     *     {
+     *       id: ["authusr_123", "authusr_321"],
+     *     },
+     *     {
+     *       take: 20,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountAuthIdentities(filters?: FilterableAuthIdentityProps, config?: FindConfig<AuthIdentityDTO>, sharedContext?: Context): Promise<[AuthIdentityDTO[], number]>;
+    /**
+     * This method creates auth identities.
+     *
+     * @param {CreateAuthIdentityDTO[]} data - The auth identities to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<AuthIdentityDTO[]>} The created auth identities.
+     *
+     * @example
+     * const authIdentities = await authModuleService.createAuthIdentities([
+     *   {
+     *     provider_identities: [{
+     *      provider: "emailpass",
+     *      entity_id: "user@example.com",
+     *     }]
+     *   },
+     *   {
+     *     provider_identities: [{
+     *      provider: "google",
+     *      entity_id: "user@gmail.com",
+     *     }]
+     *   },
+     * ])
+     */
+    createAuthIdentities(data: CreateAuthIdentityDTO[], sharedContext?: Context): Promise<AuthIdentityDTO[]>;
+    /**
+     * This method creates an auth identity.
+     *
+     * @param {CreateAuthIdentityDTO} data - The auth identity to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<AuthIdentityDTO>} The created auth identity.
+     *
+     * @example
+     * const authIdentity = await authModuleService.createAuthIdentities({
+     *     provider_identities: [{
+     *      provider: "emailpass",
+     *      entity_id: "user@example.com",
+     *     }]
+     * })
+     */
+    createAuthIdentities(data: CreateAuthIdentityDTO, sharedContext?: Context): Promise<AuthIdentityDTO>;
+    /**
+     * This method updates existing auths.
+     *
+     * @param {UpdateAuthIdentityDTO[]} data - The attributes to update in the auth identities.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<AuthIdentityDTO[]>} The updated auths.
+     *
+     * @example
+     * const authIdentities = await authModuleService.updateAuthIdentities([
+     *   {
+     *     id: "authusr_123",
+     *   },
+     * ])
+     */
+    updateAuthIdentities(data: UpdateAuthIdentityDTO[], sharedContext?: Context): Promise<AuthIdentityDTO[]>;
+    /**
+     * This method updates an existing auth.
+     *
+     * @param {UpdateAuthIdentityDTO} data - The attributes to update in the auth identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<AuthIdentityDTO>} The updated auth.
+     *
+     * @example
+     * const authIdentity = await authModuleService.updateAuthIdentities({
+     *   id: "authusr_123",
+     * })
+     */
+    updateAuthIdentities(data: UpdateAuthIdentityDTO, sharedContext?: Context): Promise<AuthIdentityDTO>;
+    /**
+     * This method deletes a auth by its ID.
+     *
+     * @param {string[]} ids - The IDs of the auth.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when {summary}
+     *
+     * @example
+     * await authModuleService.deleteAuthIdentities(["authusr_123", "authusr_321"])
+     */
+    deleteAuthIdentities(ids: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method retrieves a provider identity by its ID.
+     *
+     * @param {string} id - The ID of the provider identity.
+     * @param {FindConfig<ProviderIdentityDTO>} config - The configurations determining how the provider identity is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a provider identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProviderIdentityDTO>} The retrieved provider identity.
+     *
+     * @example
+     * const providerIdentity = await authModuleService.retrieveProviderIdentity("provider_123")
+     */
+    retrieveProviderIdentity(id: string, config?: FindConfig<ProviderIdentityDTO>, sharedContext?: Context): Promise<ProviderIdentityDTO>;
+    /**
+     * This method retrieves a paginated list of provider identities based on optional filters and configuration.
+     *
+     * @param {FilterableProviderIdentityProps} filters - The filters to apply on the retrieved provider identities.
+     * @param {FindConfig<ProviderIdentityDTO>} config - The configurations determining how the provider identity is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a provider identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProviderIdentityDTO[]>} The list of provider identities.
+     *
+     * @example
+     * To retrieve a list of provider identities using their IDs:
+     *
+     * ```ts
+     * const providerIdentities = await authModuleService.listProviderIdentities({
+     *   id: ["provider_123", "provider_234"],
+     * })
+     * ```
+     *
+     * By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+     *
+     * ```ts
+     * const providerIdentities = await authModuleService.listProviderIdentities(
+     *   {
+     *     id: ["provider_123", "provider_234"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listProviderIdentities(filters?: FilterableProviderIdentityProps, config?: FindConfig<ProviderIdentityDTO>, sharedContext?: Context): Promise<ProviderIdentityDTO[]>;
+    /**
+     * This method creates provider identities.
+     *
+     * @param {CreateProviderIdentityDTO[]} data - The provider identities to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProviderIdentityDTO[]>} The created provider identities.
+     *
+     * @example
+     * const providerIdentities = await authModuleService.createProviderIdentities([
+     *   {
+     *      provider: "emailpass",
+     *      entity_id: "user@example.com",
+     *      auth_identity_id: "uid_1"
+     *   },
+     *   {
+     *      provider: "github",
+     *      entity_id: "github_handle",
+     *      auth_identity_id: "uid_1"
+     *   },
+     * ])
+     */
+    createProviderIdentities(data: CreateProviderIdentityDTO[], sharedContext?: Context): Promise<ProviderIdentityDTO[]>;
+    /**
+     * This method creates a provider identity.
+     *
+     * @param {CreateProviderIdentityDTO} data - The provider identity to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProviderIdentityDTO>} The created provider identity.
+     *
+     * @example
+     * const providerIdentity = await authModuleService.createProviderIdentities({
+     *     provider: "github",
+     *     entity_id: "github_handle",
+     *     auth_identity_id: "uid_1"
+     * })
+     */
+    createProviderIdentities(data: CreateProviderIdentityDTO, sharedContext?: Context): Promise<ProviderIdentityDTO>;
+    /**
+     * This method updates existing provider identities.
+     *
+     * @param {UpdateProviderIdentityDTO[]} data - The attributes to update in the provider identities.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProviderIdentityDTO[]>} The updated provider identities.
+     *
+     * @example
+     * const providerIdentities = await authModuleService.updateProviderIdentities([
+     *   {
+     *     id: "provider_123",
+     *   },
+     * ])
+     */
+    updateProviderIdentities(data: UpdateProviderIdentityDTO[], sharedContext?: Context): Promise<ProviderIdentityDTO[]>;
+    /**
+     * This method updates an existing provider identity.
+     *
+     * @param {UpdateProviderIdentityDTO} data - The attributes to update in the provider identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ProviderIdentityDTO>} The updated provider identity.
+     *
+     * @example
+     * const providerIdentity = await authModuleService.updateProviderIdentities({
+     *   id: "provider_123",
+     * })
+     */
+    updateProviderIdentities(data: UpdateProviderIdentityDTO, sharedContext?: Context): Promise<ProviderIdentityDTO>;
+    /**
+     * This method deletes a provider identity by its ID.
+     *
+     * @param {string[]} ids - The IDs of the provider identity.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when {summary}
+     *
+     * @example
+     * await authModuleService.deleteProviderIdentities(["provider_123", "provider_234"])
+     */
+    deleteProviderIdentities(ids: string[], sharedContext?: Context): Promise<void>;
+}
+//# sourceMappingURL=service.d.ts.map