@acmekit/types 2.13.1

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

@@ -0,0 +1,65 @@
+import { ApiKeyType } from "../common";
+/**
+ * The API key to be created.
+ */
+export interface CreateApiKeyDTO {
+    /**
+     * The title of the API key.
+     */
+    title: string;
+    /**
+     * The type of the API key.
+     */
+    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.acmekit.com/api/admin#2-api-token).
+     */
+    created_by: string;
+}
+/**
+ * The attributes in the API key to be created or updated.
+ */
+export interface UpsertApiKeyDTO {
+    /**
+     * The ID of the API key.
+     */
+    id?: string;
+    /**
+     * The title of the API key.
+     */
+    title?: string;
+    /**
+     * The type of the API key. Required only when creating an API key.
+     */
+    type?: ApiKeyType;
+    /**
+     * Who created the API key. It's only
+     * usable and required when creating an API key.
+     */
+    created_by?: string;
+}
+/**
+ * The attributes to update in the API key.
+ */
+export interface UpdateApiKeyDTO {
+    /**
+     * The title of the API key.
+     */
+    title?: string;
+}
+/**
+ * The details of revoking an API key.
+ */
+export interface RevokeApiKeyDTO {
+    /**
+     * Who revoked the API key.
+     */
+    revoked_by: string;
+    /**
+     * When to revoke the API key (time in seconds).
+     */
+    revoke_in?: number;
+}
+//# sourceMappingURL=api-key.d.ts.map

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

@@ -0,0 +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;;;;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/api-key/mutations/api-key.js

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

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

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

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

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

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

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

package/dist/api-key/mutations/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"), exports);
+//# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,265 @@
+import { IModuleService } from "../modules-sdk";
+import { ApiKeyDTO, FilterableApiKeyProps } from "./common";
+import { FindConfig } from "../common";
+import { Context } from "../shared-context";
+import { CreateApiKeyDTO, RevokeApiKeyDTO, UpdateApiKeyDTO, UpsertApiKeyDTO } from "./mutations";
+/**
+ * The main service interface for the Api Key Module.
+ */
+export interface IApiKeyModuleService extends IModuleService {
+    /**
+     * This method creates API keys.
+     *
+     * @param {CreateApiKeyDTO[]} data - The API keys to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO[]>} The created API keys.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.createApiKeys([{
+     *   title: "Development API key",
+     *   type: "publishable",
+     *   created_by: "user_123"
+     * }])
+     */
+    createApiKeys(data: CreateApiKeyDTO[], sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * This method creates an API key.
+     *
+     * @param {CreateApiKeyDTO} data - The API key to be created.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO>} The created API key.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.createApiKeys({
+     *   title: "Development API key",
+     *   type: "publishable",
+     *   created_by: "user_123"
+     * })
+     */
+    createApiKeys(data: CreateApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method updates or creates API keys if they don't exist.
+     *
+     * @param {UpsertApiKeyDTO[]} data - The attributes in the API keys that are created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO[]>} The created or updated API keys.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.upsertApiKeys([
+     *   {
+     *     id: "apk_123",
+     *     title: "My development key",
+     *   },
+     *   {
+     *     title: "New development key",
+     *     type: "secret",
+     *     created_by: "user_123",
+     *   },
+     * ])
+     */
+    upsertApiKeys(data: UpsertApiKeyDTO[], sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * This method updates or creates an API key if it doesn't exist.
+     *
+     * @param {UpsertApiKeyDTO} data - The attributes in the API key that's created or updated.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO>} The created or updated API key.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.upsertApiKeys({
+     *   id: "apk_123",
+     *   title: "My development key"
+     * })
+     */
+    upsertApiKeys(data: UpsertApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method updates an existing API key.
+     *
+     * @param {string} id - The ID of the API key.
+     * @param {UpdateApiKeyDTO} data - The attributes to update in the API key.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO>} The updated API key.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.updateApiKeys("apk_123", {
+     *   title: "My development key"
+     * })
+     */
+    updateApiKeys(id: string, data: UpdateApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method updates existing API keys.
+     *
+     * @param {FilterableApiKeyProps} selector - The filters that specify which API keys should be updated.
+     * @param {UpdateApiKeyDTO} data - The attributes to update in the API keys.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO[]>} The updated API keys.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.updateApiKeys(
+     *   {
+     *     title: "Development key",
+     *   },
+     *   {
+     *     title: "My development key",
+     *   }
+     * )
+     */
+    updateApiKeys(selector: FilterableApiKeyProps, data: UpdateApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * This method deletes API keys by their IDs.
+     *
+     * @param {string[]} ids - The IDs of the API keys.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the API keys are deleted successfully.
+     *
+     * @example
+     * await apiKeyModuleService.deleteApiKeys(["apk_123"])
+     */
+    deleteApiKeys(ids: string[], sharedContext?: Context): Promise<void>;
+    /**
+     * This method deletes an API key by its ID.
+     *
+     * @param {string} id - The ID of the API key.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<void>} Resolves when the API key is deleted successfully.
+     *
+     * @example
+     * await apiKeyModuleService.deleteApiKeys("apk_123")
+     */
+    deleteApiKeys(id: string, sharedContext?: Context): Promise<void>;
+    /**
+     * This method retrieves an API key by its ID.
+     *
+     * @param {string} id - The ID of the API key.
+     * @param {FindConfig<ApiKeyDTO>} config - The configurations determining how the API key is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a api key.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO>} The retrieved API key.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.retrieveApiKey("apk_123")
+     */
+    retrieveApiKey(id: string, config?: FindConfig<ApiKeyDTO>, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method retrieves a paginated list of API keys based on optional filters and configuration.
+     *
+     * @param {FilterableApiKeyProps} filters - The filters to apply on the retrieved API keys.
+     * @param {FindConfig<ApiKeyDTO>} config - The configurations determining how the API key is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a API key.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO[]>} The list of API keys.
+     *
+     * @example
+     * To retrieve a list of API keys using their IDs:
+     *
+     * ```ts
+     * const apiKeys = await apiKeyModuleService.listApiKeys({
+     *   id: ["apk_123", "apk_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 apiKeys = await apiKeyModuleService.listApiKeys(
+     *   {
+     *     id: ["apk_123", "apk_321"],
+     *   },
+     *   {
+     *     take: 20,
+     *     skip: 2,
+     *   }
+     * )
+     * ```
+     */
+    listApiKeys(filters?: FilterableApiKeyProps, config?: FindConfig<ApiKeyDTO>, sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * This method retrieves a paginated list of API keys along with the total count of available API keys satisfying the provided filters.
+     *
+     * @param {FilterableApiKeyProps} filters - The filters to apply on the retrieved API keys.
+     * @param {FindConfig<ApiKeyDTO>} config - The configurations determining how the api API is retrieved. Its properties, such as `select` or `relations`, accept the
+     * attributes or relations associated with a API key.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<[ApiKeyDTO[], number]>} The list of API keys along with their total count.
+     *
+     * @example
+     * To retrieve a list of API keys using their IDs:
+     *
+     * ```ts
+     * const [apiKeys, count] =
+     * await apiKeyModuleService.listAndCountApiKeys({
+     *   id: ["apk_123", "apk_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 [apiKeys, count] =
+     *   await apiKeyModuleService.listAndCountApiKeys(
+     *     {
+     *       id: ["apk_123", "apk_321"],
+     *     },
+     *     {
+     *       take: 15,
+     *       skip: 2,
+     *     }
+     *   )
+     * ```
+     */
+    listAndCountApiKeys(filters?: FilterableApiKeyProps, config?: FindConfig<ApiKeyDTO>, sharedContext?: Context): Promise<[ApiKeyDTO[], number]>;
+    /**
+     * This method revokes API keys based on the filters provided.
+     *
+     * @param {FilterableApiKeyProps} selector - The filters to specify which API keys should be revoked.
+     * @param {RevokeApiKeyDTO} data - The details of revoking the API keys.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO[]>} The revoked API keys.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.revoke(
+     *   {
+     *     id: "apk_123",
+     *   },
+     *   {
+     *     revoked_by: "user_123",
+     *     // 1 minute
+     *     revoke_in: 60,
+     *   }
+     * )
+     */
+    revoke(selector: FilterableApiKeyProps, data: RevokeApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * This method revokes an API key based on the ID provided.
+     *
+     * @param {string} id - The ID of the API key to revoke.
+     * @param {RevokeApiKeyDTO} data - The details of revoking the API key.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<ApiKeyDTO>} The revoked API key.
+     *
+     * @example
+     * const apiKey = await apiKeyModuleService.revoke("apk_123", {
+     *   revoked_by: "user_123",
+     *   // 1 minute
+     *   revoke_in: 60,
+     * })
+     */
+    revoke(id: string, data: RevokeApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method verifies whether a token is valid, considering it authenticated.
+     *
+     * @param {string} token - The token to verify.
+     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
+     * @returns {Promise<false | ApiKeyDTO>} If the token is verified successfully, the API key associated with the token is returned. Otherwise, `false` is returned.
+     *
+     * @example
+     * const apiKey =
+     *   await apiKeyModuleService.authenticate("AbCD123987")
+     *
+     * if (!apiKey) {
+     *   // authentication failed
+     * }
+     */
+    authenticate(token: string, sharedContext?: Context): Promise<ApiKeyDTO | false>;
+}
+//# sourceMappingURL=service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/api-key/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EACL,eAAe,EACf,eAAe,EACf,eAAe,EACf,eAAe,EAChB,MAAM,aAAa,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EAAE,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EAAE,EACvB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;OAYG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CACX,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;OASG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpE;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEjE;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,WAAW,CACT,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,mBAAmB,CACjB,OAAO,CAAC,EAAE,qBAAqB,EAC/B,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;;;;;OAcG;IACH,YAAY,CACV,KAAK,EAAE,MAAM,EACb,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,CAAA;CAC9B"}

package/dist/api-key/service.js

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

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

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

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

@@ -0,0 +1,190 @@
+import { BaseFilterable } from "../../dal";
+/**
+ * @interface
+ *
+ * The auth identity details.
+ */
+export type AuthIdentityDTO = {
+    /**
+     * The ID of the auth identity.
+     */
+    id: string;
+    /**
+     * The list of provider identities linked to the auth identity.
+     **/
+    provider_identities?: ProviderIdentityDTO[];
+    /**
+     * Holds information related to the actor IDs tied to the auth identity.
+     */
+    app_metadata?: Record<string, unknown>;
+};
+/**
+ * @interface
+ *
+ * The auth identity to be created.
+ */
+export type CreateAuthIdentityDTO = {
+    /**
+     * The ID of the auth identity.
+     */
+    id?: string;
+    /**
+     * The list of provider identities linked to the auth identity.
+     **/
+    provider_identities?: CreateProviderIdentityDTO[];
+    /**
+     * Holds information related to the actor IDs tied to the auth identity.
+     */
+    app_metadata?: Record<string, unknown>;
+};
+/**
+ * @interface
+ *
+ * The attributes to update in the auth identity.
+ */
+export type UpdateAuthIdentityDTO = {
+    /**
+     * The ID of the auth identity.
+     */
+    id: string;
+    /**
+     * Holds information related to the actor IDs tied to the auth identity.
+     */
+    app_metadata?: Record<string, unknown>;
+};
+/**
+ * @interface
+ *
+ * The provider identity details.
+ */
+export type ProviderIdentityDTO = {
+    /**
+     * The ID of the provider identity.
+     */
+    id: string;
+    provider: string;
+    /**
+     * The user's identifier. For example, when using the `emailpass`
+     * provider, the `entity_id` would be the user's email.
+     */
+    entity_id: string;
+    /**
+     * The ID of the auth identity linked to the provider identity.
+     */
+    auth_identity_id?: string;
+    /**
+     * The auth identity linked to the provider identity.
+     */
+    auth_identity?: AuthIdentityDTO;
+    /**
+     * Holds custom data related to the provider in key-value pairs.
+     */
+    provider_metadata?: Record<string, unknown>;
+    /**
+     * Holds custom data related to the user in key-value pairs.
+     */
+    user_metadata?: Record<string, unknown>;
+};
+/**
+ * @interface
+ *
+ * The provider identity to be created.
+ */
+export type CreateProviderIdentityDTO = {
+    /**
+     * The ID of the provider identity.
+     */
+    id?: string;
+    provider: string;
+    /**
+     * The user's identifier. For example, when using the `emailpass`
+     * provider, the `entity_id` would be the user's email.
+     */
+    entity_id: string;
+    /**
+     * The auth identity linked to the provider identity. Needs to be specified if creating a new provider identity directly.
+     */
+    auth_identity_id?: string;
+    /**
+     * Holds custom data related to the provider in key-value pairs.
+     */
+    provider_metadata?: Record<string, unknown>;
+    /**
+     * Holds custom data related to the user in key-value pairs.
+     */
+    user_metadata?: Record<string, unknown>;
+};
+/**
+ * @interface
+ *
+ * The provider identity to be created.
+ */
+export type UpdateProviderIdentityDTO = {
+    /**
+     * The ID of the provider identity.
+     */
+    id: string;
+    /**
+     * The user's identifier. For example, when using the `emailpass`
+     * provider, the `entity_id` would be the user's email.
+     */
+    entity_id?: string;
+    /**
+     * Holds custom data related to the provider in key-value pairs.
+     */
+    provider_metadata?: Record<string, unknown>;
+    /**
+     * Holds custom data related to the user in key-value pairs.
+     */
+    user_metadata?: Record<string, unknown>;
+};
+/**
+ * The filters to apply on the retrieved auth identity.
+ */
+export interface FilterableAuthIdentityProps extends BaseFilterable<FilterableAuthIdentityProps> {
+    /**
+     * The IDs to filter the auth identity by.
+     */
+    id?: string[];
+    /**
+     * The provider identities to filter the auth identity by.
+     */
+    provider_identities?: {
+        /**
+         * Filter the provider identities by the ID of the provider identity ID they are linked to.
+         */
+        entity_id?: string;
+        /**
+         * Filter the provider identities by the provider handle.
+         */
+        provider?: string;
+    };
+    app_metadata?: Record<string, unknown>;
+}
+export interface FilterableProviderIdentityProps extends BaseFilterable<FilterableProviderIdentityProps> {
+    /**
+     * The IDs to filter the provider identity by.
+     */
+    id?: string[];
+    /**
+     * Filter the provider identities by the ID of the provider identity they are linked to.
+     */
+    entity_id?: string;
+    /**
+     * Filter the provider identities by the ID of the auth identity they are linked to.
+     */
+    auth_identity_id?: string;
+    /**
+     * The provider handle to filter the provider identity by.
+     */
+    provider?: string;
+    /**
+     * Holds custom data related to the provider in key-value pairs.
+     */
+    provider_metadata?: Record<string, unknown>;
+    /**
+     * Holds custom data related to the user in key-value pairs.
+     */
+    user_metadata?: Record<string, unknown>;
+}
+//# sourceMappingURL=auth-identity.d.ts.map

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

@@ -0,0 +1 @@
+{"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/common/auth-identity.js

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

package/dist/auth/common/auth-identity.js.map

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

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/auth/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,YAAY,CAAA"}

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/auth/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAA+B;AAC/B,6CAA0B"}