@medusajs/js-sdk 1.0.0-rc-20241018141633 → 1.0.0-rc-20241022152047

package/dist/auth/index.js

@@ -3,6 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Auth = void 0;
 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 = async (actor, method, payload) => {
             const { token } = await this.client.fetch(`/auth/${actor}/${method}/register`, {
                 method: "POST",
@@ -11,6 +33,34 @@ 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 = async (actor, method, payload) => {
             // There will either be token or location returned from the backend.
             const { token, location } = await this.client.fetch(`/auth/${actor}/${method}`, {
@@ -25,7 +75,31 @@ class Auth {
             await 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 = async (actor, method, query) => {
             const { token } = await this.client.fetch(`/auth/${actor}/${method}/callback`, {
                 method: "GET",
@@ -34,6 +108,18 @@ class Auth {
             await 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 = async () => {
             const { token } = await this.client.fetch("/auth/token/refresh", {
                 method: "POST",
@@ -43,6 +129,16 @@ class Auth {
             await 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 = async () => {
             if (this.config?.auth?.type === "session") {
                 await this.client.fetch("/auth/session", {
@@ -51,6 +147,30 @@ 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 = async (actor, provider, body) => {
             await this.client.fetch(`/auth/${actor}/${provider}/reset-password`, {
                 method: "POST",
@@ -58,12 +178,43 @@ 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 = async (actor, provider, body) => {
             await this.client.fetch(`/auth/${actor}/${provider}/update`, {
                 method: "POST",
                 body,
             });
         };
+        /**
+         * @ignore
+         */
         this.setToken_ = async (token) => {
             // By default we just set the token in the configured storage, if configured to use sessions we convert it into session storage instead.
             if (this.config?.auth?.type === "session") {

package/dist/auth/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":";;;AAIA,MAAa,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C,aAAQ,GAAG,KAAK,EACd,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;QAED,UAAK,GAAG,KAAK,EACX,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;QAED,8JAA8J;QAC9J,aAAQ,GAAG,KAAK,EACd,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;QAED,YAAO,GAAG,KAAK,IAAI,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;QAED,WAAM,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,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;QAED,kBAAa,GAAG,KAAK,EACnB,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;QAED,mBAAc,GAAG,KAAK,EACpB,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;QAEO,cAAS,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;YAC1C,wIAAwI;YACxI,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,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;QAzHC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAwHF;AA/HD,oBA+HC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":";;;AAIA,MAAa,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,aAAQ,GAAG,KAAK,EACd,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;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,UAAK,GAAG,KAAK,EACX,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;QAED;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,aAAQ,GAAG,KAAK,EACd,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;QAED;;;;;;;;;;;WAWG;QACH,YAAO,GAAG,KAAK,IAAI,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;QAED;;;;;;;;;WASG;QACH,WAAM,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,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;QAED;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,kBAAa,GAAG,KAAK,EACnB,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;QAED;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,mBAAc,GAAG,KAAK,EACpB,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;QAED;;WAEG;QACK,cAAS,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;YAC1C,wIAAwI;YACxI,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,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;QAtRC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CAqRF;AA5RD,oBA4RC"}

package/dist/client.d.ts

@@ -52,7 +52,7 @@ export declare class Client {
     protected setToken_: (token: string) => void;
     protected getToken_: () => string | null | undefined;
     protected getTokenStorageInfo_: () => {
-        storageMethod: "session" | "local" | "memory";
+        storageMethod: "session" | "local" | "memory" | "nostore";
         storageKey: string;
     };
 }

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,MAAM,EACN,SAAS,EACT,UAAU,EACV,mBAAmB,EAEpB,MAAM,SAAS,CAAA;AAEhB,eAAO,MAAM,sBAAsB,0BAA0B,CAAA;AA6D7D,qBAAa,UAAW,SAAQ,KAAK;IACnC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;gBAElB,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAKlE;AAED,qBAAa,MAAM;IACV,MAAM,EAAE,WAAW,CAAA;IAC1B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;IAEtB,OAAO,CAAC,uBAAuB,CAAsB;IACrD,OAAO,CAAC,KAAK,CAAK;gBAEN,MAAM,EAAE,MAAM;IAiB1B;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC;IAIrE;;;;;;;;;OASG;IACG,WAAW,CACf,KAAK,EAAE,UAAU,EACjB,IAAI,CAAC,EAAE,SAAS,GACf,OAAO,CAAC,mBAAmB,CAAC;IAiB/B,QAAQ,CAAC,KAAK,EAAE,MAAM;IAItB,UAAU;IAIV,SAAS,CAAC,WAAW;IAkBrB,SAAS,CAAC,UAAU,IAAI,WAAW;IA2DnC,SAAS,CAAC,gBAAgB,QAAO;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAI9D;IAED,SAAS,CAAC,wBAAwB,QAC9B;QAAE,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;KAAE,GACpC,EAAE,CAIL;IAED,SAAS,CAAC,aAAa,QAAO;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAQ3D;IAED,SAAS,CAAC,SAAS,UAAW,MAAM,UAgBnC;IAED,SAAS,CAAC,SAAS,kCAelB;IAED,SAAS,CAAC,oBAAoB;;;MAoB7B;CACF"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,WAAW,EACX,MAAM,EACN,SAAS,EACT,UAAU,EACV,mBAAmB,EAEpB,MAAM,SAAS,CAAA;AAEhB,eAAO,MAAM,sBAAsB,0BAA0B,CAAA;AA6D7D,qBAAa,UAAW,SAAQ,KAAK;IACnC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;gBAElB,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM;CAKlE;AAED,qBAAa,MAAM;IACV,MAAM,EAAE,WAAW,CAAA;IAC1B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;IAEtB,OAAO,CAAC,uBAAuB,CAAsB;IACrD,OAAO,CAAC,KAAK,CAAK;gBAEN,MAAM,EAAE,MAAM;IAiB1B;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,CAAC,SAAS,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC;IAIrE;;;;;;;;;OASG;IACG,WAAW,CACf,KAAK,EAAE,UAAU,EACjB,IAAI,CAAC,EAAE,SAAS,GACf,OAAO,CAAC,mBAAmB,CAAC;IAiB/B,QAAQ,CAAC,KAAK,EAAE,MAAM;IAItB,UAAU;IAIV,SAAS,CAAC,WAAW;IAkBrB,SAAS,CAAC,UAAU,IAAI,WAAW;IA2DnC,SAAS,CAAC,gBAAgB,QAAO;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAI9D;IAED,SAAS,CAAC,wBAAwB,QAC9B;QAAE,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAA;KAAE,GACpC,EAAE,CAIL;IAED,SAAS,CAAC,aAAa,QAAO;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAQ3D;IAED,SAAS,CAAC,SAAS,UAAW,MAAM,UAgBnC;IAED,SAAS,CAAC,SAAS,kCAelB;IAED,SAAS,CAAC,oBAAoB;;;MAqB7B;CACF"}

package/dist/client.js

@@ -112,7 +112,8 @@ class Client {
         this.getTokenStorageInfo_ = () => {
             const hasLocal = hasStorage("localStorage");
             const hasSession = hasStorage("sessionStorage");
-            const storageMethod = this.config.auth?.jwtTokenStorageMethod || (hasLocal ? "local" : "memory");
+            const storageMethod = this.config.auth?.jwtTokenStorageMethod ||
+                (hasLocal ? "local" : "nostore");
             const storageKey = this.config.auth?.jwtTokenStorageKey || this.DEFAULT_JWT_STORAGE_KEY;
             if (!hasLocal && storageMethod === "local") {
                 throw new Error("Local JWT storage is only available in the browser");

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AACnB,2DAA2C;AAU9B,QAAA,sBAAsB,GAAG,uBAAuB,CAAA;AAE7D,MAAM,UAAU,GAAG,CAAC,OAA0C,EAAE,EAAE;IAChE,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,OAAO,IAAI,MAAM,CAAA;IAC1B,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE;IAC/B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzB,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,EAAE;IAC3C,OAAO;QACL,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACxC,aAAa,EAAE,YAAY;KAC5B,CAAA;AACH,CAAC,CAAA;AAED,MAAM,gBAAgB,GAAG,CACvB,IAA2B,EAC3B,OAAgB,EAChB,MAAc,EACW,EAAE;IAC3B,IAAI,IAAI,GAAG,IAAI,EAAE,IAAI,CAAA;IACrB,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACtE,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,OAAO;QACP,iJAAiJ;QACjJ,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;QACjE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAA2B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACxC,CAAA;AAClB,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,KAAK,EAAE,IAAc,EAAE,UAAmB,EAAE,EAAE;IACtE,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAErD,CAAA;QACD,MAAM,IAAI,UAAU,CAClB,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,EACpC,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,CACZ,CAAA;IACH,CAAC;IAED,6FAA6F;IAC7F,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAA;IAC5E,OAAO,aAAa,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACjD,CAAC,CAAA;AAED,MAAa,UAAW,SAAQ,KAAK;IAInC,YAAY,OAAe,EAAE,UAAmB,EAAE,MAAe;QAC/D,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AATD,gCASC;AAED,MAAa,MAAM;IAQjB,YAAY,MAAc;QAHlB,4BAAuB,GAAG,mBAAmB,CAAA;QAC7C,UAAK,GAAG,EAAE,CAAA;QAsJR,qBAAgB,GAAG,GAAmC,EAAE;YAChE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM;gBACvB,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE;gBAClE,CAAC,CAAC,EAAE,CAAA;QACR,CAAC,CAAA;QAES,6BAAwB,GAAG,GAE9B,EAAE;YACP,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc;gBAC/B,CAAC,CAAC,EAAE,CAAC,8BAAsB,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;gBAC1D,CAAC,CAAC,EAAE,CAAA;QACR,CAAC,CAAA;QAES,kBAAa,GAAG,GAAmC,EAAE;YAC7D,oGAAoG;YACpG,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;gBACzC,OAAO,EAAE,CAAA;YACX,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAC9B,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,CAAC,CAAA;QAES,cAAS,GAAG,CAAC,KAAa,EAAE,EAAE;YACtC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;YACjE,QAAQ,aAAa,EAAE,CAAC;gBACtB,KAAK,OAAO,CAAC,CAAC,CAAC;oBACb,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;oBAC9C,MAAK;gBACP,CAAC;gBACD,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;oBAChD,MAAK;gBACP,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;oBAClB,MAAK;gBACP,CAAC;YACH,CAAC;QACH,CAAC,CAAA;QAES,cAAS,GAAG,GAAG,EAAE;YACzB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;YACjE,QAAQ,aAAa,EAAE,CAAC;gBACtB,KAAK,OAAO,CAAC,CAAC,CAAC;oBACb,OAAO,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;gBAChD,CAAC;gBACD,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,OAAO,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;gBAClD,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,OAAO,IAAI,CAAC,KAAK,CAAA;gBACnB,CAAC;YACH,CAAC;YAED,OAAM;QACR,CAAC,CAAA;QAES,yBAAoB,GAAG,GAAG,EAAE;YACpC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,CAAA;YAC3C,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAA;YAE/C,MAAM,aAAa,GACjB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,qBAAqB,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;YAC5E,MAAM,UAAU,GACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,IAAI,IAAI,CAAC,uBAAuB,CAAA;YAEtE,IAAI,CAAC,QAAQ,IAAI,aAAa,KAAK,OAAO,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;YACvE,CAAC;YACD,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;YACzE,CAAC;YAED,OAAO;gBACL,aAAa;gBACb,UAAU;aACX,CAAA;QACH,CAAC,CAAA;QAlOC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAA;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,MAAM;YACT,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC;SAC9C,CAAA;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;IACjC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAgB,KAAiB,EAAE,IAAgB;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAA0B,CAAA;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,WAAW,CACf,KAAiB,EACjB,IAAgB;QAEhB,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAE7D,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;YACjC,GAAG,IAAI;YACP,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE;SAC3D,CAAC,CAAA;QAEF,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACX,OAAO,EAAE,MAAM,EAAE,IAAA,2BAAM,EAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;QAC1E,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;IAC3C,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,UAAU;QACR,IAAI,CAAC,WAAW,EAAE,CAAA;IACpB,CAAC;IAES,WAAW;QACnB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACjE,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;gBAC1C,MAAK;YACP,CAAC;YACD,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;gBAC5C,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;gBACf,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAES,UAAU;QAClB,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC;YACjC,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,kBAAkB;YAC1B,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC1B,GAAG,IAAI,CAAC,wBAAwB,EAAE;SACnC,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,kDAAkD,EAClD,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAChE,CAAA;QAED,OAAO,KAAK,EAAE,KAAiB,EAAE,IAAgB,EAAE,EAAE;YACnD,gFAAgF;YAChF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAA;YAC3C,MAAM,aAAa,GAAG;gBACpB,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa;gBAC5B,GAAG,IAAI,CAAC,aAAa,EAAE;gBACvB,GAAG,IAAI,EAAE,OAAO;aACjB,CAAA;YACD,gGAAgG;YAChG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACrD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACrB,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBACzB,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,IAAI,eAAe,GAAsB,KAAK,CAAA;YAC9C,IAAI,KAAK,YAAY,GAAG,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACtD,eAAe,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACrD,IAAI,IAAI,EAAE,KAAK,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,CACvC,CAAA;oBACD,MAAM,gBAAgB,GAAG,YAAE,CAAC,SAAS,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;oBACnE,eAAe,CAAC,MAAM,GAAG,gBAAgB,CAAA;gBAC3C,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,0BAA0B,EAC1B,QAAQ,eAAe,CAAC,QAAQ,EAAE,IAAI,EACtC,YAAY,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAClE,CAAA;YAED,kFAAkF;YAClF,OAAO,MAAM,KAAK,CAChB,eAAe,EACf,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAC7C,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA;gBACnE,OAAO,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACzC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;IACH,CAAC;CAkFF;AA5OD,wBA4OC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AACnB,2DAA2C;AAU9B,QAAA,sBAAsB,GAAG,uBAAuB,CAAA;AAE7D,MAAM,UAAU,GAAG,CAAC,OAA0C,EAAE,EAAE;IAChE,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,OAAO,IAAI,MAAM,CAAA;IAC1B,CAAC;IAED,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,EAAE;IAC/B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzB,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,EAAE;IAC3C,OAAO;QACL,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACxC,aAAa,EAAE,YAAY;KAC5B,CAAA;AACH,CAAC,CAAA;AAED,MAAM,gBAAgB,GAAG,CACvB,IAA2B,EAC3B,OAAgB,EAChB,MAAc,EACW,EAAE;IAC3B,IAAI,IAAI,GAAG,IAAI,EAAE,IAAI,CAAA;IACrB,IAAI,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QACtE,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,OAAO;QACP,iJAAiJ;QACjJ,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;QACjE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAA2B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACxC,CAAA;AAClB,CAAC,CAAA;AAED,MAAM,iBAAiB,GAAG,KAAK,EAAE,IAAc,EAAE,UAAmB,EAAE,EAAE;IACtE,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAErD,CAAA;QACD,MAAM,IAAI,UAAU,CAClB,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,EACpC,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,MAAM,CACZ,CAAA;IACH,CAAC;IAED,6FAA6F;IAC7F,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAA;IAC5E,OAAO,aAAa,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;AACjD,CAAC,CAAA;AAED,MAAa,UAAW,SAAQ,KAAK;IAInC,YAAY,OAAe,EAAE,UAAmB,EAAE,MAAe;QAC/D,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AATD,gCASC;AAED,MAAa,MAAM;IAQjB,YAAY,MAAc;QAHlB,4BAAuB,GAAG,mBAAmB,CAAA;QAC7C,UAAK,GAAG,EAAE,CAAA;QAsJR,qBAAgB,GAAG,GAAmC,EAAE;YAChE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM;gBACvB,CAAC,CAAC,EAAE,aAAa,EAAE,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE;gBAClE,CAAC,CAAC,EAAE,CAAA;QACR,CAAC,CAAA;QAES,6BAAwB,GAAG,GAE9B,EAAE;YACP,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc;gBAC/B,CAAC,CAAC,EAAE,CAAC,8BAAsB,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE;gBAC1D,CAAC,CAAC,EAAE,CAAA;QACR,CAAC,CAAA;QAES,kBAAa,GAAG,GAAmC,EAAE;YAC7D,oGAAoG;YACpG,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,KAAK,SAAS,EAAE,CAAC;gBACzC,OAAO,EAAE,CAAA;YACX,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;YAC9B,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAC1D,CAAC,CAAA;QAES,cAAS,GAAG,CAAC,KAAa,EAAE,EAAE;YACtC,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;YACjE,QAAQ,aAAa,EAAE,CAAC;gBACtB,KAAK,OAAO,CAAC,CAAC,CAAC;oBACb,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;oBAC9C,MAAK;gBACP,CAAC;gBACD,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;oBAChD,MAAK;gBACP,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;oBAClB,MAAK;gBACP,CAAC;YACH,CAAC;QACH,CAAC,CAAA;QAES,cAAS,GAAG,GAAG,EAAE;YACzB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;YACjE,QAAQ,aAAa,EAAE,CAAC;gBACtB,KAAK,OAAO,CAAC,CAAC,CAAC;oBACb,OAAO,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;gBAChD,CAAC;gBACD,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,OAAO,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;gBAClD,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,OAAO,IAAI,CAAC,KAAK,CAAA;gBACnB,CAAC;YACH,CAAC;YAED,OAAM;QACR,CAAC,CAAA;QAES,yBAAoB,GAAG,GAAG,EAAE;YACpC,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,CAAC,CAAA;YAC3C,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAA;YAE/C,MAAM,aAAa,GACjB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,qBAAqB;gBACvC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;YAClC,MAAM,UAAU,GACd,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,kBAAkB,IAAI,IAAI,CAAC,uBAAuB,CAAA;YAEtE,IAAI,CAAC,QAAQ,IAAI,aAAa,KAAK,OAAO,EAAE,CAAC;gBAC3C,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;YACvE,CAAC;YACD,IAAI,CAAC,UAAU,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAC/C,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;YACzE,CAAC;YAED,OAAO;gBACL,aAAa;gBACb,UAAU;aACX,CAAA;QACH,CAAC,CAAA;QAnOC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI;YAC9B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAA;QAED,IAAI,CAAC,MAAM,GAAG;YACZ,GAAG,MAAM;YACT,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,GAAE,CAAC;SAC9C,CAAA;QAED,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;IACjC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAgB,KAAiB,EAAE,IAAgB;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAA0B,CAAA;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,WAAW,CACf,KAAiB,EACjB,IAAgB;QAEhB,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAA;QAC7C,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;QAE7D,IAAI,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;YACjC,GAAG,IAAI;YACP,MAAM,EAAE,eAAe,CAAC,MAAM;YAC9B,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,mBAAmB,EAAE;SAC3D,CAAC,CAAA;QAEF,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACX,OAAO,EAAE,MAAM,EAAE,IAAA,2BAAM,EAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;QAC1E,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;IAC3C,CAAC;IAED,QAAQ,CAAC,KAAa;QACpB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,UAAU;QACR,IAAI,CAAC,WAAW,EAAE,CAAA;IACpB,CAAC;IAES,WAAW;QACnB,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAA;QACjE,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;gBAC1C,MAAK;YACP,CAAC;YACD,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;gBAC5C,MAAK;YACP,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;gBACf,MAAK;YACP,CAAC;QACH,CAAC;IACH,CAAC;IAES,UAAU;QAClB,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC;YACjC,cAAc,EAAE,kBAAkB;YAClC,MAAM,EAAE,kBAAkB;YAC1B,GAAG,IAAI,CAAC,gBAAgB,EAAE;YAC1B,GAAG,IAAI,CAAC,wBAAwB,EAAE;SACnC,CAAC,CAAA;QAEF,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,kDAAkD,EAClD,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAChE,CAAA;QAED,OAAO,KAAK,EAAE,KAAiB,EAAE,IAAgB,EAAE,EAAE;YACnD,gFAAgF;YAChF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,cAAc,CAAC,CAAA;YAC3C,MAAM,aAAa,GAAG;gBACpB,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa;gBAC5B,GAAG,IAAI,CAAC,aAAa,EAAE;gBACvB,GAAG,IAAI,EAAE,OAAO;aACjB,CAAA;YACD,gGAAgG;YAChG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;gBACrD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;gBACrB,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;gBACzB,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,IAAI,eAAe,GAAsB,KAAK,CAAA;YAC9C,IAAI,KAAK,YAAY,GAAG,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACtD,eAAe,GAAG,IAAI,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;gBACrD,IAAI,IAAI,EAAE,KAAK,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAC/B,eAAe,CAAC,YAAY,CAAC,OAAO,EAAE,CACvC,CAAA;oBACD,MAAM,gBAAgB,GAAG,YAAE,CAAC,SAAS,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;oBACnE,eAAe,CAAC,MAAM,GAAG,gBAAgB,CAAA;gBAC3C,CAAC;YACH,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,0BAA0B,EAC1B,QAAQ,eAAe,CAAC,QAAQ,EAAE,IAAI,EACtC,YAAY,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAClE,CAAA;YAED,kFAAkF;YAClF,OAAO,MAAM,KAAK,CAChB,eAAe,EACf,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAC7C,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAA;gBACnE,OAAO,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACzC,CAAC,CAAC,CAAA;QACJ,CAAC,CAAA;IACH,CAAC;CAmFF;AA7OD,wBA6OC"}

package/dist/esm/admin/api-key.d.ts

@@ -10,12 +10,155 @@ export declare class ApiKey {
      * @ignore
      */
     constructor(client: Client);
-    list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.PaginatedResponse<HttpTypes.AdminApiKeyListResponse>>;
+    /**
+     * This methods retrieves a paginated list of API keys. It sends a request to the
+     * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of API keys.
+     *
+     * @example
+     * To retrieve the list of API keys:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list()
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each API key:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
+    list(queryParams?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyListResponse>;
+    /**
+     * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeys)
+     * API route.
+     *
+     * @param body - The API key's details.
+     * @param query - Configure the fields to retrieve in the created API key.
+     * @param headers - Headers to pass in the request
+     * @returns The created API key
+     *
+     * @example
+     * sdk.admin.apiKey.create({
+     *   title: "Development",
+     *   type: "publishable"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     create(body: HttpTypes.AdminCreateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method revokes an API key. It sends a request to the
+     * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.revoke("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     revoke(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method retrieves an API key's details. It sends a request to the
+     * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.retrieve("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     retrieve(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method updates an API key's details. It sends a request to the
+     * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The data to update in the API key.
+     * @param query - Configure the fields to retrieve in the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.update("apk_123", {
+     *   title: "Development"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     update(id: string, body: HttpTypes.AdminUpdateApiKey, query?: HttpTypes.AdminGetApiKeysParams, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
+    /**
+     * This method deletes an API key by its ID. It sends a request to the
+     * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.apiKey.delete("apk_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id: string, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyDeleteResponse>;
+    /**
+     * This method manages the sales channels associated with a publishable API key to either add
+     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
+     * API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The sales channels to add or remove from the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.batchSalesChannels("apk_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_321"]
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     batchSalesChannels(id: string, body: HttpTypes.AdminBatchLink, headers?: ClientHeaders): Promise<HttpTypes.AdminApiKeyResponse>;
 }
 //# sourceMappingURL=api-key.d.ts.map

package/dist/esm/admin/api-key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/admin/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAqB,MAAM,iBAAiB,CAAA;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAIpB,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAC7C,OAAO,CAAC,EAAE,aAAa;IAUnB,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAS5C,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAanB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAU1C,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/admin/api-key.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,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IACtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAAW,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAC7C,OAAO,CAAC,EAAE,aAAa;IAUzB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IASlD;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,iBAAiB,EACjC,KAAK,CAAC,EAAE,SAAS,CAAC,qBAAqB,EACvC,OAAO,CAAC,EAAE,aAAa;IAazB;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa;IAUhD;;;;;;;;;;;;;;;;;;OAkBG;IACG,kBAAkB,CACtB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,SAAS,CAAC,cAAc,EAC9B,OAAO,CAAC,EAAE,aAAa;CAW1B"}

package/dist/esm/admin/api-key.js

@@ -14,6 +14,52 @@ export class ApiKey {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * This methods retrieves a paginated list of API keys. It sends a request to the
+     * [List API Keys](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeys) API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The paginated list of API keys.
+     *
+     * @example
+     * To retrieve the list of API keys:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list()
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * To configure the pagination, pass the `limit` and `offset` query parameters.
+     *
+     * For example, to retrieve only 10 items and skip 10 items:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each API key:
+     *
+     * ```ts
+     * sdk.admin.apiKey.list({
+     *   fields: "id,*sales_channels"
+     * })
+     * .then(({ api_keys, count, limit, offset }) => {
+     *   console.log(api_keys)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.medusajs.com/v2/api/store#select-fields-and-relations).
+     */
     list(queryParams, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys`, {
@@ -22,6 +68,24 @@ export class ApiKey {
             });
         });
     }
+    /**
+     * This method creates an API key. It sends a request to the [Create API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeys)
+     * API route.
+     *
+     * @param body - The API key's details.
+     * @param query - Configure the fields to retrieve in the created API key.
+     * @param headers - Headers to pass in the request
+     * @returns The created API key
+     *
+     * @example
+     * sdk.admin.apiKey.create({
+     *   title: "Development",
+     *   type: "publishable"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     create(body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys`, {
@@ -32,6 +96,20 @@ export class ApiKey {
             });
         });
     }
+    /**
+     * This method revokes an API key. It sends a request to the
+     * [Revoke API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidrevoke) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.revoke("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     revoke(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys/${id}/revoke`, {
@@ -40,6 +118,20 @@ export class ApiKey {
             });
         });
     }
+    /**
+     * This method retrieves an API key's details. It sends a request to the
+     * [Get API key](https://docs.medusajs.com/v2/api/admin#api-keys_getapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.retrieve("apk_123")
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     retrieve(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys/${id}`, {
@@ -47,6 +139,24 @@ export class ApiKey {
             });
         });
     }
+    /**
+     * This method updates an API key's details. It sends a request to the
+     * [Update API Key](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The data to update in the API key.
+     * @param query - Configure the fields to retrieve in the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.update("apk_123", {
+     *   title: "Development"
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     update(id, body, query, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys/${id}`, {
@@ -57,6 +167,20 @@ export class ApiKey {
             });
         });
     }
+    /**
+     * This method deletes an API key by its ID. It sends a request to the
+     * [Delete API Key](https://docs.medusajs.com/v2/api/admin#api-keys_deleteapikeysid) API route.
+     *
+     * @param id - The API key's ID.
+     * @param headers - Headers to pass in the request.
+     * @returns The deletion's details.
+     *
+     * @example
+     * sdk.admin.apiKey.delete("apk_123")
+     * .then(({ deleted }) => {
+     *   console.log(deleted)
+     * })
+     */
     delete(id, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys/${id}`, {
@@ -65,6 +189,25 @@ export class ApiKey {
             });
         });
     }
+    /**
+     * This method manages the sales channels associated with a publishable API key to either add
+     * or remove associations. It sends a request to the [Manage Sales Channels](https://docs.medusajs.com/v2/api/admin#api-keys_postapikeysidsaleschannels)
+     * API route.
+     *
+     * @param id - The API key's ID.
+     * @param body - The sales channels to add or remove from the API key.
+     * @param headers - Headers to pass in the request.
+     * @returns The API key's details.
+     *
+     * @example
+     * sdk.admin.apiKey.batchSalesChannels("apk_123", {
+     *   add: ["sc_123"],
+     *   remove: ["sc_321"]
+     * })
+     * .then(({ api_key }) => {
+     *   console.log(api_key)
+     * })
+     */
     batchSalesChannels(id, body, headers) {
         return __awaiter(this, void 0, void 0, function* () {
             return yield this.client.fetch(`/admin/api-keys/${id}/sales-channels`, {

package/dist/esm/admin/api-key.js.map

@@ -1 +1 @@
-{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../../src/admin/api-key.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CACR,WAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE;gBACnB,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAEK,MAAM,CACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,SAAS,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,QAAQ,CAAC,EAAU,EAAE,OAAuB;;YAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;gBACE,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAEK,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAEK,kBAAkB,CACtB,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,iBAAiB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
+{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../../src/admin/api-key.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,MAAM;IAKjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACG,IAAI,CACR,WAA6C,EAC7C,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAE5B,iBAAiB,EAAE;gBACnB,KAAK,EAAE,WAAW;gBAClB,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,iBAAiB,EACjB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,SAAS,EAC9B;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,EAAU,EAAE,OAAuB;;YAChD,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;gBACE,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CACV,EAAU,EACV,IAAiC,EACjC,KAAuC,EACvC,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;gBACJ,KAAK;aACN,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,EAAU,EAAE,OAAuB;;YAC9C,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,EAAE,EACvB;gBACE,MAAM,EAAE,QAAQ;gBAChB,OAAO;aACR,CACF,CAAA;QACH,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACG,kBAAkB,CACtB,EAAU,EACV,IAA8B,EAC9B,OAAuB;;YAEvB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,mBAAmB,EAAE,iBAAiB,EACtC;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;gBACP,IAAI;aACL,CACF,CAAA;QACH,CAAC;KAAA;CACF"}