@medusajs/js-sdk 1.0.0-rc-20241016093905 → 2.0.0-preview-20241022094107

package/dist/esm/admin/user.d.ts

@@ -2,7 +2,13 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class User {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
     create(body: HttpTypes.AdminCreateUser, query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserResponse>;
     update(id: string, body: HttpTypes.AdminUpdateUser, query?: HttpTypes.AdminUserParams, headers?: ClientHeaders): Promise<HttpTypes.AdminUserResponse>;

package/dist/esm/admin/user.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/admin/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAUnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAC3C,OAAO,CAAC,EAAE,aAAa;IAQnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa;CAMpE"}
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../src/admin/user.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,IAAI;IACf;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAUnB,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,eAAe,EAC/B,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAanB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,mBAAmB,EAC3C,OAAO,CAAC,EAAE,aAAa;IAQnB,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EACjC,OAAO,CAAC,EAAE,aAAa;IAWnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa;CAMpE"}

package/dist/esm/admin/user.js

@@ -8,6 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 export class User {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }

package/dist/esm/admin/user.js.map

@@ -1 +1 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/admin/user.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,IAAI;IAEf,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAA+B,EAC/B,KAAiC,EACjC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAA8B,cAAc,EAAE;gBACpE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAA+B,EAC/B,KAAiC,EACjC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAAE,EAAE,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,WAA2C,EAC3C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAkC,cAAc,EAAE;gBACxE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAiC,EACjC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAAE,EAAE,EACpB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAAE,EAAE,EACpB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,EAAE,CAAC,KAAiC,EAAE,OAAuB;;YACjE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAA8B,iBAAiB,EAAE;gBACvE,KAAK;gBACL,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;CACF"}
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../src/admin/user.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,IAAI;IAKf;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,MAAM,CACV,IAA+B,EAC/B,KAAiC,EACjC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAA8B,cAAc,EAAE;gBACpE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAA+B,EAC/B,KAAiC,EACjC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAAE,EAAE,EACpB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,IAAI,CACR,WAA2C,EAC3C,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAkC,cAAc,EAAE;gBACxE,OAAO;gBACP,KAAK,EAAE,WAAW;aACnB,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,QAAQ,CACZ,EAAU,EACV,KAAiC,EACjC,OAAuB;;YAEvB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAAE,EAAE,EACpB;gBACE,KAAK;gBACL,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CACtB,gBAAgB,EAAE,EAAE,EACpB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,EAAE,CAAC,KAAiC,EAAE,OAAuB;;YACjE,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAA8B,iBAAiB,EAAE;gBACvE,KAAK;gBACL,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;CACF"}

package/dist/esm/admin/workflow-execution.d.ts

@@ -2,7 +2,13 @@ import { HttpTypes } from "@medusajs/types";
 import { Client } from "../client";
 import { ClientHeaders } from "../types";
 export declare class WorkflowExecution {
+    /**
+     * @ignore
+     */
     private client;
+    /**
+     * @ignore
+     */
     constructor(client: Client);
     list(queryParams?: HttpTypes.AdminGetWorkflowExecutionsParams, headers?: ClientHeaders): Promise<HttpTypes.AdminWorkflowExecutionListResponse>;
     retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminWorkflowExecutionResponse>;

package/dist/esm/admin/workflow-execution.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-execution.d.ts","sourceRoot":"","sources":["../../../src/admin/workflow-execution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAQ;gBACV,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,gCAAgC,EACxD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAQnD"}
+{"version":3,"file":"workflow-execution.d.ts","sourceRoot":"","sources":["../../../src/admin/workflow-execution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,gCAAgC,EACxD,OAAO,CAAC,EAAE,aAAa;IAWnB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;CAQnD"}

package/dist/esm/admin/workflow-execution.js

@@ -8,6 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 export class WorkflowExecution {
+    /**
+     * @ignore
+     */
     constructor(client) {
         this.client = client;
     }

package/dist/esm/admin/workflow-execution.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-execution.js","sourceRoot":"","sources":["../../../src/admin/workflow-execution.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,iBAAiB;IAE5B,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,WAAwD,EACxD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,6BAA6B,EAC7B;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,OAAuB;;YAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,EAAE,EAAE,EACnC;gBACE,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"workflow-execution.js","sourceRoot":"","sources":["../../../src/admin/workflow-execution.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,iBAAiB;IAK5B;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,WAAwD,EACxD,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,6BAA6B,EAC7B;gBACE,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,OAAuB;;YAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,+BAA+B,EAAE,EAAE,EACnC;gBACE,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;CACF"}

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

@@ -5,17 +5,173 @@ export declare class Auth {
     private client;
     private config;
     constructor(client: Client, config: Config);
+    /**
+     * This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
+     * [Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth_postactor_typeauth_provider_register).
+     *
+     * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+     * @param method - The authentication provider to use. For example, `emailpass` or `google`.
+     * @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
+     * you pass the email and password.
+     * @returns The JWT token used for registration later.
+     *
+     * @example
+     * sdk.auth.register(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     email: "customer@gmail.com",
+     *     password: "supersecret"
+     *   }
+     * ).then((token) => {
+     *   console.log(token)
+     * })
+     */
     register: (actor: string, method: string, payload: HttpTypes.AdminSignUpWithEmailPassword) => Promise<string>;
+    /**
+     * This method retrieves the JWT authenticated token for an admin user, customer, or custom
+     * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_provider).
+     *
+     * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
+     * [Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_postsession).
+     *
+     * Subsequent requests using the SDK will automatically have the necessary authentication headers / session
+     * set.
+     *
+     * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+     * @param method - The authentication provider to use. For example, `emailpass` or `google`.
+     * @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
+     * you pass the email and password.
+     * @returns The authentication JWT token
+     *
+     * @example
+     * sdk.auth.login(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     email: "customer@gmail.com",
+     *     password: "supersecret"
+     *   }
+     * ).then((token) => {
+     *   console.log(token)
+     * })
+     */
     login: (actor: string, method: string, payload: HttpTypes.AdminSignInWithEmailPassword | Record<string, unknown>) => Promise<string | {
         location: string;
     }>;
+    /**
+     * This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
+     * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providercallback).
+     *
+     * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+     * @param method - The authentication provider to use. For example, `google`.
+     * @param query - The query parameters from the Oauth callback, which should be passed to the API route.
+     * @returns The authentication JWT token
+     *
+     * @example
+     * sdk.auth.callback(
+     *   "customer",
+     *   "google",
+     *   {
+     *     code: "123",
+     *   }
+     * ).then((token) => {
+     *   console.log(token)
+     * })
+     *
+     *
+     * @privateRemarks
+     * The callback expects all query parameters from the Oauth callback to be passed to
+     * the backend, and the provider is in charge of parsing and validating them
+     */
     callback: (actor: string, method: string, query?: Record<string, unknown>) => Promise<string>;
+    /**
+     * This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
+     * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth_postadminauthtokenrefresh).
+     *
+     * @returns The refreshed JWT authentication token.
+     *
+     * @example
+     * sdk.auth.refresh()
+     * .then((token) => {
+     *   console.log(token)
+     * })
+     */
     refresh: () => Promise<string>;
+    /**
+     * This method deletes the authentication session of the currently logged-in user to log them out.
+     * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_deletesession).
+     *
+     * @example
+     * sdk.auth.logout()
+     * .then(() => {
+     *   // user is logged out
+     * })
+     */
     logout: () => Promise<void>;
+    /**
+     * This method requests a reset password token for an admin user, customer, or custom actor type.
+     * It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerresetpassword).
+     *
+     * To reset the password later using the token delivered to the user, use the {@link updateProvider} method.
+     *
+     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+     *
+     * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+     * @param provider - The authentication provider to use. For example, `emailpass`.
+     * @param body - The data required to identify the user.
+     *
+     * @example
+     * sdk.auth.resetPassword(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     identifier: "customer@gmail.com"
+     *   }
+     * )
+     * .then(() => {
+     *   // user receives token
+     * })
+     */
     resetPassword: (actor: string, provider: string, body: {
+        /**
+         * The user's identifier. For example, when using the `emailpass` provider,
+         * this would be the user's email.
+         */
         identifier: string;
     }) => Promise<void>;
+    /**
+     * This method is used to update user-related data authentication data.
+     *
+     * More specifically, use this method when updating the password of an admin user, customer, or
+     * custom actor type after requesting to reset their password with {@link resetPassword}.
+     *
+     * This method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerupdate).
+     *
+     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+     *
+     * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+     * @param provider - The authentication provider to use. For example, `emailpass`.
+     * @param body - The data necessary to update the user's authentication data. When resetting the user's password,
+     * send the `email` and `password` properties.
+     *
+     * @example
+     * sdk.auth.updateProvider(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     email: "customer@gmail.com",
+     *     password: "supersecret"
+     *   }
+     * )
+     * .then(() => {
+     *   // password updated
+     * })
+     */
     updateProvider: (actor: string, provider: string, body: Record<string, unknown>) => Promise<void>;
+    /**
+     * @ignore
+     */
     private setToken_;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK1C,QAAQ,UACC,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,qBAahD;IAED,KAAK,UACI,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;OAmB1E;IAGD,QAAQ,UACC,MAAM,UACL,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,qBAYhC;IAED,OAAO,wBAYN;IAED,MAAM,sBAQL;IAED,aAAa,UACJ,MAAM,YACH,MAAM,QACV;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,mBAO7B;IAED,cAAc,UACL,MAAM,YACH,MAAM,QACV,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,mBAM9B;IAED,OAAO,CAAC,SAAS,CAUhB;CACF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,QAAQ,UACC,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,qBAahD;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,UACI,MAAM,UACL,MAAM,WACL,SAAS,CAAC,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;OAmB1E;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,QAAQ,UACC,MAAM,UACL,MAAM,UACN,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,qBAYhC;IAED;;;;;;;;;;;OAWG;IACH,OAAO,wBAYN;IAED;;;;;;;;;OASG;IACH,MAAM,sBAQL;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,aAAa,UACJ,MAAM,YACH,MAAM,QACV;QACJ;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAA;KACnB,mBAOF;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,cAAc,UACL,MAAM,YACH,MAAM,QACV,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,mBAM9B;IAED;;OAEG;IACH,OAAO,CAAC,SAAS,CAUhB;CACF"}

package/dist/esm/auth/index.js

@@ -9,6 +9,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 export class Auth {
     constructor(client, config) {
+        /**
+         * This method is used to retrieve a registration JWT token for a user, customer, or custom actor type. It sends a request to the
+         * [Retrieve Registration Token API route](https://docs.medusajs.com/v2/api/store#auth_postactor_typeauth_provider_register).
+         *
+         * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+         * @param method - The authentication provider to use. For example, `emailpass` or `google`.
+         * @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
+         * you pass the email and password.
+         * @returns The JWT token used for registration later.
+         *
+         * @example
+         * sdk.auth.register(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     email: "customer@gmail.com",
+         *     password: "supersecret"
+         *   }
+         * ).then((token) => {
+         *   console.log(token)
+         * })
+         */
         this.register = (actor, method, payload) => __awaiter(this, void 0, void 0, function* () {
             const { token } = yield this.client.fetch(`/auth/${actor}/${method}/register`, {
                 method: "POST",
@@ -17,6 +39,34 @@ export class Auth {
             this.client.setToken(token);
             return token;
         });
+        /**
+         * This method retrieves the JWT authenticated token for an admin user, customer, or custom
+         * actor type. It sends a request to the [Authenticate API Route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_provider).
+         *
+         * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
+         * [Set Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_postsession).
+         *
+         * Subsequent requests using the SDK will automatically have the necessary authentication headers / session
+         * set.
+         *
+         * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+         * @param method - The authentication provider to use. For example, `emailpass` or `google`.
+         * @param payload - The data to pass in the request's body for authentication. When using the `emailpass` provider,
+         * you pass the email and password.
+         * @returns The authentication JWT token
+         *
+         * @example
+         * sdk.auth.login(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     email: "customer@gmail.com",
+         *     password: "supersecret"
+         *   }
+         * ).then((token) => {
+         *   console.log(token)
+         * })
+         */
         this.login = (actor, method, payload) => __awaiter(this, void 0, void 0, function* () {
             // There will either be token or location returned from the backend.
             const { token, location } = yield this.client.fetch(`/auth/${actor}/${method}`, {
@@ -31,7 +81,31 @@ export class Auth {
             yield this.setToken_(token);
             return token;
         });
-        // The callback expects all query parameters from the Oauth callback to be passed to the backend, and the provider is in charge of parsing and validating them
+        /**
+         * This method is used to validate an Oauth callback from a third-party service, such as Google, for an admin user, customer, or custom actor types.
+         * It sends a request to the [Validate Authentication Callback](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providercallback).
+         *
+         * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+         * @param method - The authentication provider to use. For example, `google`.
+         * @param query - The query parameters from the Oauth callback, which should be passed to the API route.
+         * @returns The authentication JWT token
+         *
+         * @example
+         * sdk.auth.callback(
+         *   "customer",
+         *   "google",
+         *   {
+         *     code: "123",
+         *   }
+         * ).then((token) => {
+         *   console.log(token)
+         * })
+         *
+         *
+         * @privateRemarks
+         * The callback expects all query parameters from the Oauth callback to be passed to
+         * the backend, and the provider is in charge of parsing and validating them
+         */
         this.callback = (actor, method, query) => __awaiter(this, void 0, void 0, function* () {
             const { token } = yield this.client.fetch(`/auth/${actor}/${method}/callback`, {
                 method: "GET",
@@ -40,6 +114,18 @@ export class Auth {
             yield this.setToken_(token);
             return token;
         });
+        /**
+         * This method refreshes a JWT authentication token, which is useful after validating the Oauth callback
+         * with {@link callback}. It sends a request to the [Refresh Authentication Token API route](https://docs.medusajs.com/v2/api/admin#auth_postadminauthtokenrefresh).
+         *
+         * @returns The refreshed JWT authentication token.
+         *
+         * @example
+         * sdk.auth.refresh()
+         * .then((token) => {
+         *   console.log(token)
+         * })
+         */
         this.refresh = () => __awaiter(this, void 0, void 0, function* () {
             const { token } = yield this.client.fetch("/auth/token/refresh", {
                 method: "POST",
@@ -49,6 +135,16 @@ export class Auth {
             yield this.setToken_(token);
             return token;
         });
+        /**
+         * This method deletes the authentication session of the currently logged-in user to log them out.
+         * It sends a request to the [Delete Authentication Session API route](https://docs.medusajs.com/v2/api/admin#auth_deletesession).
+         *
+         * @example
+         * sdk.auth.logout()
+         * .then(() => {
+         *   // user is logged out
+         * })
+         */
         this.logout = () => __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             if (((_b = (_a = this.config) === null || _a === void 0 ? void 0 : _a.auth) === null || _b === void 0 ? void 0 : _b.type) === "session") {
@@ -58,6 +154,30 @@ export class Auth {
             }
             this.client.clearToken();
         });
+        /**
+         * This method requests a reset password token for an admin user, customer, or custom actor type.
+         * It sends a request to the [Generate Reset Password Token API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerresetpassword).
+         *
+         * To reset the password later using the token delivered to the user, use the {@link updateProvider} method.
+         *
+         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+         *
+         * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+         * @param provider - The authentication provider to use. For example, `emailpass`.
+         * @param body - The data required to identify the user.
+         *
+         * @example
+         * sdk.auth.resetPassword(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     identifier: "customer@gmail.com"
+         *   }
+         * )
+         * .then(() => {
+         *   // user receives token
+         * })
+         */
         this.resetPassword = (actor, provider, body) => __awaiter(this, void 0, void 0, function* () {
             yield this.client.fetch(`/auth/${actor}/${provider}/reset-password`, {
                 method: "POST",
@@ -65,12 +185,43 @@ export class Auth {
                 headers: { accept: "text/plain" }, // 201 Created response
             });
         });
+        /**
+         * This method is used to update user-related data authentication data.
+         *
+         * More specifically, use this method when updating the password of an admin user, customer, or
+         * custom actor type after requesting to reset their password with {@link resetPassword}.
+         *
+         * This method sends a request to [this API route](https://docs.medusajs.com/v2/api/admin#auth_postactor_typeauth_providerupdate).
+         *
+         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.medusajs.com/v2/resources/storefront-development/customers/reset-password).
+         *
+         * @param actor - The actor type. For example, `user` for admin user, or `customer` for customer.
+         * @param provider - The authentication provider to use. For example, `emailpass`.
+         * @param body - The data necessary to update the user's authentication data. When resetting the user's password,
+         * send the `email` and `password` properties.
+         *
+         * @example
+         * sdk.auth.updateProvider(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     email: "customer@gmail.com",
+         *     password: "supersecret"
+         *   }
+         * )
+         * .then(() => {
+         *   // password updated
+         * })
+         */
         this.updateProvider = (actor, provider, body) => __awaiter(this, void 0, void 0, function* () {
             yield this.client.fetch(`/auth/${actor}/${provider}/update`, {
                 method: "POST",
                 body,
             });
         });
+        /**
+         * @ignore
+         */
         this.setToken_ = (token) => __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             // By default we just set the token in the configured storage, if configured to use sessions we convert it into session storage instead.

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/auth/index.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C,aAAQ,GAAG,CACT,KAAa,EACb,MAAc,EACd,OAA+C,EAC/C,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CACF,CAAA;YAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAE3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA,CAAA;QAED,UAAK,GAAG,CACN,KAAa,EACb,MAAc,EACd,OAAyE,EACzE,EAAE;YACF,oEAAoE;YACpE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAGhD,SAAS,KAAK,IAAI,MAAM,EAAE,EAAE;gBAC7B,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CAAC,CAAA;YAEF,gFAAgF;YAChF,4EAA4E;YAC5E,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,EAAE,QAAQ,EAAE,CAAA;YACrB,CAAC;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAe,CAAC,CAAA;YACrC,OAAO,KAAe,CAAA;QACxB,CAAC,CAAA,CAAA;QAED,8JAA8J;QAC9J,aAAQ,GAAG,CACT,KAAa,EACb,MAAc,EACd,KAA+B,EAC/B,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;aACN,CACF,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA,CAAA;QAED,YAAO,GAAG,GAAS,EAAE;YACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;aACf,CACF,CAAA;YAED,mHAAmH;YACnH,2IAA2I;YAC3I,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA,CAAA;QAED,WAAM,GAAG,GAAS,EAAE;;YAClB,IAAI,CAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,0CAAE,IAAI,MAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,QAAQ;iBACjB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QAC1B,CAAC,CAAA,CAAA;QAED,kBAAa,GAAG,CACd,KAAa,EACb,QAAgB,EAChB,IAA4B,EAC5B,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,iBAAiB,EAAE;gBACnE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,uBAAuB;aAC3D,CAAC,CAAA;QACJ,CAAC,CAAA,CAAA;QAED,mBAAc,GAAG,CACf,KAAa,EACb,QAAgB,EAChB,IAA6B,EAC7B,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,SAAS,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,IAAI;aACL,CAAC,CAAA;QACJ,CAAC,CAAA,CAAA;QAEO,cAAS,GAAG,CAAO,KAAa,EAAE,EAAE;;YAC1C,wIAAwI;YACxI,IAAI,CAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,0CAAE,IAAI,MAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;iBAC9C,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC,CAAA,CAAA;QAzHC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAwHF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/auth/index.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,aAAQ,GAAG,CACT,KAAa,EACb,MAAc,EACd,OAA+C,EAC/C,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CACF,CAAA;YAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAE3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,UAAK,GAAG,CACN,KAAa,EACb,MAAc,EACd,OAAyE,EACzE,EAAE;YACF,oEAAoE;YACpE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAGhD,SAAS,KAAK,IAAI,MAAM,EAAE,EAAE;gBAC7B,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,OAAO;aACd,CAAC,CAAA;YAEF,gFAAgF;YAChF,4EAA4E;YAC5E,IAAI,QAAQ,EAAE,CAAC;gBACb,OAAO,EAAE,QAAQ,EAAE,CAAA;YACrB,CAAC;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAe,CAAC,CAAA;YACrC,OAAO,KAAe,CAAA;QACxB,CAAC,CAAA,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,aAAQ,GAAG,CACT,KAAa,EACb,MAAc,EACd,KAA+B,EAC/B,EAAE;YACF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,SAAS,KAAK,IAAI,MAAM,WAAW,EACnC;gBACE,MAAM,EAAE,KAAK;gBACb,KAAK;aACN,CACF,CAAA;YAED,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA,CAAA;QAED;;;;;;;;;;;WAWG;QACH,YAAO,GAAG,GAAS,EAAE;YACnB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;aACf,CACF,CAAA;YAED,mHAAmH;YACnH,2IAA2I;YAC3I,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA,CAAA;QAED;;;;;;;;;WASG;QACH,WAAM,GAAG,GAAS,EAAE;;YAClB,IAAI,CAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,0CAAE,IAAI,MAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,QAAQ;iBACjB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAA;QAC1B,CAAC,CAAA,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,kBAAa,GAAG,CACd,KAAa,EACb,QAAgB,EAChB,IAMC,EACD,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,iBAAiB,EAAE;gBACnE,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,uBAAuB;aAC3D,CAAC,CAAA;QACJ,CAAC,CAAA,CAAA;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,mBAAc,GAAG,CACf,KAAa,EACb,QAAgB,EAChB,IAA6B,EAC7B,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,SAAS,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,IAAI;aACL,CAAC,CAAA;QACJ,CAAC,CAAA,CAAA;QAED;;WAEG;QACK,cAAS,GAAG,CAAO,KAAa,EAAE,EAAE;;YAC1C,wIAAwI;YACxI,IAAI,CAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,0CAAE,IAAI,MAAK,SAAS,EAAE,CAAC;gBAC1C,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;iBAC9C,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;YAC7B,CAAC;QACH,CAAC,CAAA,CAAA;QAtRC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAqRF"}