@medusajs/types 1.11.13 → 1.11.14-next-20240305095805

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

@@ -0,0 +1,21 @@
+import { BaseFilterable } from "../../dal";
+export type ApiKeyType = "secret" | "publishable";
+export interface ApiKeyDTO {
+    id: string;
+    token: string;
+    redacted: string;
+    title: string;
+    type: ApiKeyType;
+    last_used_at: Date | null;
+    created_by: string;
+    created_at: Date;
+    revoked_by: string | null;
+    revoked_at: Date | null;
+}
+export interface FilterableApiKeyProps extends BaseFilterable<FilterableApiKeyProps> {
+    id?: string | string[];
+    token?: string | string[];
+    title?: string | string[];
+    type?: ApiKeyType;
+}
+//# sourceMappingURL=api-key.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/common/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAA;AACjD,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,UAAU,CAAA;IAChB,YAAY,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,qBACf,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC7C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACzB,IAAI,CAAC,EAAE,UAAU,CAAA;CAClB"}

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

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

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

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

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

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

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

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

package/dist/api-key/common/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/common/index.js.map

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,20 @@
+import { ApiKeyType } from "../common";
+export interface CreateApiKeyDTO {
+    title: string;
+    type: ApiKeyType;
+    created_by: string;
+}
+export interface UpsertApiKeyDTO {
+    id?: string;
+    title?: string;
+    type?: ApiKeyType;
+    created_by?: string;
+}
+export interface UpdateApiKeyDTO {
+    title?: string;
+}
+export interface RevokeApiKeyDTO {
+    revoked_by: string;
+    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,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,UAAU,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CAEnB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAA;IAClB,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,104 @@
+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";
+export interface IApiKeyModuleService extends IModuleService {
+    /**
+     * Create a new api key
+     * @param data
+     * @param sharedContext
+     */
+    create(data: CreateApiKeyDTO[], sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    create(data: CreateApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method updates existing API keys, or creates new ones if they don't exist.
+     *
+     * @param {UpsertApiKeyDTO[]} data - The attributes to update or create for each API key.
+     * @returns {Promise<ApiKeyDTO[]>} The updated and created API keys.
+     *
+     * @example
+     * {example-code}
+     */
+    upsert(data: UpsertApiKeyDTO[], sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * This method updates an existing API key, or creates a new one if it doesn't exist.
+     *
+     * @param {UpsertApiKeyDTO} data - The attributes to update or create for the API key.
+     * @returns {Promise<ApiKeyDTO>} The updated or created API key.
+     *
+     * @example
+     * {example-code}
+     */
+    upsert(data: UpsertApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method updates an existing API key.
+     *
+     * @param {string} id - The API key's ID.
+     * @param {UpdateApiKeyDTO} data - The details 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.
+     */
+    update(id: string, data: UpdateApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * This method updates existing API keys.
+     *
+     * @param {FilterableApiKeyProps} selector - The filters to specify which API keys should be updated.
+     * @param {UpdateApiKeyDTO} data - The details 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
+     * {example-code}
+     */
+    update(selector: FilterableApiKeyProps, data: UpdateApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * Delete an api key
+     * @param ids
+     * @param sharedContext
+     */
+    delete(ids: string[], sharedContext?: Context): Promise<void>;
+    delete(id: string, sharedContext?: Context): Promise<void>;
+    /**
+     * Retrieve an api key
+     * @param id
+     * @param config
+     * @param sharedContext
+     */
+    retrieve(id: string, config?: FindConfig<ApiKeyDTO>, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * List api keys
+     * @param filters
+     * @param config
+     * @param sharedContext
+     */
+    list(filters?: FilterableApiKeyProps, config?: FindConfig<ApiKeyDTO>, sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * List and count api keys
+     * @param filters
+     * @param config
+     * @param sharedContext
+     */
+    listAndCount(filters?: FilterableApiKeyProps, config?: FindConfig<ApiKeyDTO>, sharedContext?: Context): Promise<[ApiKeyDTO[], number]>;
+    /**
+     * Revokes an api key
+     * @param selector
+     * @param data
+     * @param sharedContext
+     */
+    revoke(selector: FilterableApiKeyProps, data: RevokeApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO[]>;
+    /**
+     * Revokes an api key
+     * @param id
+     * @param data
+     * @param sharedContext
+     */
+    revoke(id: string, data: RevokeApiKeyDTO, sharedContext?: Context): Promise<ApiKeyDTO>;
+    /**
+     * Check the validity of an api key
+     * @param token
+     * @param sharedContext
+     */
+    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,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAC9E,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAE1E;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAE9E;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAA;IAE1E;;;;;;;OAOG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;;;;;;OAUG;IACH,MAAM,CACJ,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IAEvB;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7D,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1D;;;;;OAKG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAC9B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;;OAKG;IACH,IAAI,CACF,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;;;;;OAKG;IACH,YAAY,CACV,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;;;;;OAKG;IACH,MAAM,CACJ,QAAQ,EAAE,qBAAqB,EAC/B,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;IACvB;;;;;OAKG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,eAAe,EACrB,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,SAAS,CAAC,CAAA;IAErB;;;;OAIG;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-user.d.ts

@@ -1,30 +1,108 @@
 import { BaseFilterable } from "../../dal";
+/**
+ * @interface
+ *
+ * The auth user details.
+ */
 export type AuthUserDTO = {
+    /**
+     * The ID of the auth user.
+     */
     id: string;
+    /**
+     * The provider of the auth user.
+     */
     provider: string;
+    /**
+     * The associated providers entity's ID.
+     */
     entity_id: string;
+    /**
+     * The scope of the auth user.
+     */
     scope: string;
+    /**
+     * The provider metadata of the auth user.
+     */
     provider_metadata?: Record<string, unknown>;
+    /**
+     * The user metadata of the auth user.
+     */
     user_metadata: Record<string, unknown>;
+    /**
+     * The app metadata of the auth user.
+     */
     app_metadata: Record<string, unknown>;
 };
+/**
+ * @interface
+ *
+ * The auth user to be created.
+ */
 export type CreateAuthUserDTO = {
+    /**
+     * The ID of the auth user.
+     */
     id?: string;
+    /**
+     * The provider of the auth user.
+     */
     provider: string;
+    /**
+     * The associated entity's ID.
+     */
     entity_id: string;
+    /**
+     * The scope of the auth user.
+     */
     scope: string;
+    /**
+     * The provider metadata of the auth user.
+     */
     provider_metadata?: Record<string, unknown>;
+    /**
+     * The user metadata of the auth user.
+     */
     user_metadata?: Record<string, unknown>;
+    /**
+     * The app metadata of the auth user.
+     */
     app_metadata?: Record<string, unknown>;
 };
+/**
+ * @interface
+ *
+ * The attributes to update in the auth user.
+ */
 export type UpdateAuthUserDTO = {
+    /**
+     * The ID of the auth user.
+     */
     id: string;
+    /**
+     * The provider metadata of the auth user.
+     */
     provider_metadata?: Record<string, unknown>;
+    /**
+     * The user metadata of the auth user.
+     */
     user_metadata?: Record<string, unknown>;
+    /**
+     * The app metadata of the auth user.
+     */
     app_metadata?: Record<string, unknown>;
 };
+/**
+ * The filters to apply on the retrieved auth user.
+ */
 export interface FilterableAuthUserProps extends BaseFilterable<FilterableAuthUserProps> {
+    /**
+     * The IDs to filter the auth user by.
+     */
     id?: string[];
+    /**
+     * Filter the auth auth user by the associated provider(s).
+     */
     provider?: string[] | string;
 }
 //# sourceMappingURL=auth-user.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"auth-user.d.ts","sourceRoot":"","sources":["../../../src/auth/common/auth-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C,MAAM,MAAM,WAAW,GAAG;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACvC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED,MAAM,WAAW,uBACf,SAAQ,cAAc,CAAC,uBAAuB,CAAC;IAC/C,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC7B"}
+{"version":3,"file":"auth-user.d.ts","sourceRoot":"","sources":["../../../src/auth/common/auth-user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE3C;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAEtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACtC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;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;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;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;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACvC,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,uBACf,SAAQ,cAAc,CAAC,uBAAuB,CAAC;IAC/C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC7B"}

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

@@ -1,20 +1,77 @@
+/**
+ * @interface
+ *
+ * The details of the authentication response.
+ */
 export type AuthenticationResponse = {
+    /**
+     * Whether the authentication was successful.
+     */
     success: boolean;
+    /**
+     * The authenticated user's details. The details shape
+     * depends on the used provider ID.
+     */
     authUser?: any;
+    /**
+     * The error message, if an error occurs.
+     */
     error?: string;
+    /**
+     * Redirect location. Location takes precedence over success.
+     */
     location?: string;
 };
+/**
+ * @interface
+ *
+ * Provider configuration for the Medusa auth module.
+ */
 export type AuthModuleProviderConfig = {
+    /**
+     * Provider name
+     */
     name: string;
+    /**
+     * Scope configurations for the provider
+     */
     scopes: Record<string, AuthProviderScope>;
 };
+/**
+ * @interface
+ *
+ * Configuration of a single provider scope
+ */
 export type AuthProviderScope = Record<string, unknown>;
+/**
+ * @interface
+ *
+ * Input for authentication and callback validation methods.
+ */
 export type AuthenticationInput = {
+    /**
+     * url of incoming authentication request.
+     */
     url: string;
+    /**
+     * Headers of incoming authentication request.
+     */
     headers: Record<string, string>;
+    /**
+     *  Query params of incoming authentication request.
+     */
     query: Record<string, string>;
+    /**
+     * Body of incoming authentication request.
+     */
     body: Record<string, string>;
+    /**
+     * Scope for authentication request.
+     */
     authScope: string;
+    /**
+     * Protocol of incoming authentication request (For example, `https`).
+     */
     protocol: string;
 };
 //# sourceMappingURL=provider.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/auth/common/provider.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD,MAAM,MAAM,mBAAmB,GAAG;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC7B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../../src/auth/common/provider.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,QAAQ,CAAC,EAAE,GAAG,CAAA;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAA;CAC1C,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAEvD;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA"}