@acmekit/js-sdk 2.13.1

package/dist/auth/index.d.ts

@@ -0,0 +1,264 @@
+import { HttpTypes } from "@acmekit/types";
+import { Client } from "../client";
+import { ClientHeaders, Config } from "../types";
+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.acmekit.com/api/store#auth_postactor_typeauth_provider_register).
+     *
+     * Then, it stores the returned token and passes it in the header of subsequent requests. So, you can call the
+     * [store.customer.create](https://docs.acmekit.com/resources/references/js-sdk/store/customer#create) method,
+     * for example, after calling this method.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+     *
+     * @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.
+     *
+     * @tags auth
+     *
+     * @example
+     * await sdk.auth.register(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     email: "customer@gmail.com",
+     *     password: "supersecret"
+     *   }
+     * )
+     *
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.create({
+     *   email: "customer@gmail.com",
+     *   password: "supersecret"
+     * })
+     */
+    register: (actor: string, method: string, payload: HttpTypes.AdminSignUpWithEmailPassword | Record<string, unknown>) => 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.acmekit.com/api/admin#auth_postactor_typeauth_provider).
+     *
+     * ### Third-Party Authentication
+     *
+     * If the API route returns a `location` property, it means that the authentication requires additional steps,
+     * typically in a third-party service. The `location` property is returned so that you
+     * can redirect the user to the appropriate page.
+     *
+     * :::note
+     *
+     * For an example of implementing third-party authentication, refer to the
+     * [Third-Party Login in Storefront](https://docs.acmekit.com/resources/storefront-development/customers/third-party-login) guide.
+     *
+     * :::
+     *
+     * ### Session Authentication
+     *
+     * 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.acmekit.com/api/admin#auth_postsession).
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+     *
+     * ### Automatic Authentication
+     *
+     * If the authentication was successful, subsequent requests using the SDK will automatically have the necessary authentication headers / session
+     * set, based on your JS SDK authentication configurations.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+     *
+     * @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
+     *
+     * @tags auth
+     *
+     * @example
+     * const result = await sdk.auth.login(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     email: "customer@gmail.com",
+     *     password: "supersecret"
+     *   }
+     * )
+     *
+     * if (typeof result !== "string") {
+     *   alert("Authentication requires additional steps")
+     *   // replace with the redirect logic of your application
+     *   window.location.href = result.location
+     *   return
+     * }
+     *
+     * // customer is now authenticated
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.retrieve()
+     */
+    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.acmekit.com/api/admin#auth_postactor_typeauth_providercallback).
+     *
+     * The method stores the returned token and passes it in the header of subsequent requests. So, you can call the
+     * [store.customer.create](https://docs.acmekit.com/resources/references/js-sdk/store/customer#create) or {@link refresh} methods,
+     * for example, after calling this method.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+     *
+     * @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. This includes query parameters like
+     * `code` and `state`.
+     * @returns The authentication JWT token
+     *
+     * @tags auth
+     *
+     * @example
+     * await sdk.auth.callback(
+     *   "customer",
+     *   "google",
+     *   {
+     *     code: "123",
+     *     state: "456"
+     *   }
+     * )
+     *
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.create({
+     *   email: "customer@gmail.com",
+     *   password: "supersecret"
+     * })
+     *
+     * @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.acmekit.com/api/admin#auth_postadminauthtokenrefresh).
+     *
+     * The method stores the returned token and passes it in the header of subsequent requests. So, you can call other
+     * methods that require authentication after calling this method.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+     *
+     * For an example of implementing third-party authentication, refer to the
+     * [Third-Party Login in Storefront](https://docs.acmekit.com/resources/storefront-development/customers/third-party-login) guide.
+     *
+     * @param headers - Headers to pass in the request
+     *
+     * @returns The refreshed JWT authentication token.
+     *
+     * @tags auth
+     *
+     * @example
+     * const token = await sdk.auth.refresh()
+     *
+     * // all subsequent requests will use the token in the header
+     * const { customer } = await sdk.store.customer.retrieve()
+     */
+    refresh: (headers?: ClientHeaders) => Promise<string>;
+    /**
+     * This method logs out the currently authenticated user based on your JS SDK authentication configurations.
+     *
+     * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
+     * [Delete Authentication Session API route](https://docs.acmekit.com/api/admin#auth_deletesession).
+     *
+     * The method also clears any stored tokens or sessions, based on your JS SDK authentication configurations.
+     *
+     * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+     *
+     * @tags auth
+     *
+     * @example
+     * await sdk.auth.logout()
+     *
+     * // user is now logged out
+     * // you can't send any requests that require authentication
+     */
+    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.acmekit.com/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.acmekit.com/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.
+     *
+     * @tags auth
+     *
+     * @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;
+        /**
+         * Optional metadata to include in the reset password request.
+         *
+         * @since 2.12.4
+         */
+        metadata?: Record<string, unknown>;
+    }) => 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.acmekit.com/api/admin#auth_postactor_typeauth_providerupdate).
+     *
+     * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.acmekit.com/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 `password` property.
+     *
+     * @tags auth
+     *
+     * @example
+     * sdk.auth.updateProvider(
+     *   "customer",
+     *   "emailpass",
+     *   {
+     *     password: "supersecret"
+     *   },
+     *   token
+     * )
+     * .then(() => {
+     *   // password updated
+     * })
+     */
+    updateProvider: (actor: string, provider: string, body: HttpTypes.AdminUpdateProvider, token: string) => Promise<void>;
+    /**
+     * @ignore
+     */
+    private setToken_;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEhD,qBAAa,IAAI;IACf,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAK1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,QAAQ,GACN,OAAO,MAAM,EACb,QAAQ,MAAM,EACd,SAAS,SAAS,CAAC,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,qBAa1E;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2DG;IACH,KAAK,GACH,OAAO,MAAM,EACb,QAAQ,MAAM,EACd,SAAS,SAAS,CAAC,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;OAmB1E;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,QAAQ,GACN,OAAO,MAAM,EACb,QAAQ,MAAM,EACd,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,qBAYhC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,GAAU,UAAU,aAAa,qBAavC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,sBAQL;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,aAAa,GACX,OAAO,MAAM,EACb,UAAU,MAAM,EAChB,MAAM;QACJ;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAA;QAClB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACnC,mBAOF;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,cAAc,GACZ,OAAO,MAAM,EACb,UAAU,MAAM,EAChB,MAAM,SAAS,CAAC,mBAAmB,EACnC,OAAO,MAAM,mBAOd;IAED;;OAEG;IACH,OAAO,CAAC,SAAS,CAUhB;CACF"}

package/dist/auth/index.js

@@ -0,0 +1,318 @@
+"use strict";
+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.acmekit.com/api/store#auth_postactor_typeauth_provider_register).
+         *
+         * Then, it stores the returned token and passes it in the header of subsequent requests. So, you can call the
+         * [store.customer.create](https://docs.acmekit.com/resources/references/js-sdk/store/customer#create) method,
+         * for example, after calling this method.
+         *
+         * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+         *
+         * @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.
+         *
+         * @tags auth
+         *
+         * @example
+         * await sdk.auth.register(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     email: "customer@gmail.com",
+         *     password: "supersecret"
+         *   }
+         * )
+         *
+         * // all subsequent requests will use the token in the header
+         * const { customer } = await sdk.store.customer.create({
+         *   email: "customer@gmail.com",
+         *   password: "supersecret"
+         * })
+         */
+        this.register = async (actor, method, payload) => {
+            const { token } = await this.client.fetch(`/auth/${actor}/${method}/register`, {
+                method: "POST",
+                body: payload,
+            });
+            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.acmekit.com/api/admin#auth_postactor_typeauth_provider).
+         *
+         * ### Third-Party Authentication
+         *
+         * If the API route returns a `location` property, it means that the authentication requires additional steps,
+         * typically in a third-party service. The `location` property is returned so that you
+         * can redirect the user to the appropriate page.
+         *
+         * :::note
+         *
+         * For an example of implementing third-party authentication, refer to the
+         * [Third-Party Login in Storefront](https://docs.acmekit.com/resources/storefront-development/customers/third-party-login) guide.
+         *
+         * :::
+         *
+         * ### Session Authentication
+         *
+         * 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.acmekit.com/api/admin#auth_postsession).
+         *
+         * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+         *
+         * ### Automatic Authentication
+         *
+         * If the authentication was successful, subsequent requests using the SDK will automatically have the necessary authentication headers / session
+         * set, based on your JS SDK authentication configurations.
+         *
+         * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+         *
+         * @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
+         *
+         * @tags auth
+         *
+         * @example
+         * const result = await sdk.auth.login(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     email: "customer@gmail.com",
+         *     password: "supersecret"
+         *   }
+         * )
+         *
+         * if (typeof result !== "string") {
+         *   alert("Authentication requires additional steps")
+         *   // replace with the redirect logic of your application
+         *   window.location.href = result.location
+         *   return
+         * }
+         *
+         * // customer is now authenticated
+         * // all subsequent requests will use the token in the header
+         * const { customer } = await sdk.store.customer.retrieve()
+         */
+        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}`, {
+                method: "POST",
+                body: payload,
+            });
+            // In the case of an oauth login, we return the redirect location to the caller.
+            // They can decide if they do an immediate redirect or put it in an <a> tag.
+            if (location) {
+                return { location };
+            }
+            await this.setToken_(token);
+            return token;
+        };
+        /**
+         * 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.acmekit.com/api/admin#auth_postactor_typeauth_providercallback).
+         *
+         * The method stores the returned token and passes it in the header of subsequent requests. So, you can call the
+         * [store.customer.create](https://docs.acmekit.com/resources/references/js-sdk/store/customer#create) or {@link refresh} methods,
+         * for example, after calling this method.
+         *
+         * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+         *
+         * @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. This includes query parameters like
+         * `code` and `state`.
+         * @returns The authentication JWT token
+         *
+         * @tags auth
+         *
+         * @example
+         * await sdk.auth.callback(
+         *   "customer",
+         *   "google",
+         *   {
+         *     code: "123",
+         *     state: "456"
+         *   }
+         * )
+         *
+         * // all subsequent requests will use the token in the header
+         * const { customer } = await sdk.store.customer.create({
+         *   email: "customer@gmail.com",
+         *   password: "supersecret"
+         * })
+         *
+         * @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",
+                query,
+            });
+            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.acmekit.com/api/admin#auth_postadminauthtokenrefresh).
+         *
+         * The method stores the returned token and passes it in the header of subsequent requests. So, you can call other
+         * methods that require authentication after calling this method.
+         *
+         * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+         *
+         * For an example of implementing third-party authentication, refer to the
+         * [Third-Party Login in Storefront](https://docs.acmekit.com/resources/storefront-development/customers/third-party-login) guide.
+         *
+         * @param headers - Headers to pass in the request
+         *
+         * @returns The refreshed JWT authentication token.
+         *
+         * @tags auth
+         *
+         * @example
+         * const token = await sdk.auth.refresh()
+         *
+         * // all subsequent requests will use the token in the header
+         * const { customer } = await sdk.store.customer.retrieve()
+         */
+        this.refresh = async (headers) => {
+            const { token } = await this.client.fetch("/auth/token/refresh", {
+                method: "POST",
+                headers,
+            });
+            // Putting the token in session after refreshing is only useful when the new token has updated info (eg. actor_id).
+            // Ideally we don't use the full JWT in session as key, but just store a pseudorandom key that keeps the rest of the auth context as value.
+            await this.setToken_(token);
+            return token;
+        };
+        /**
+         * This method logs out the currently authenticated user based on your JS SDK authentication configurations.
+         *
+         * If the `auth.type` of the SDK is set to `session`, this method will also send a request to the
+         * [Delete Authentication Session API route](https://docs.acmekit.com/api/admin#auth_deletesession).
+         *
+         * The method also clears any stored tokens or sessions, based on your JS SDK authentication configurations.
+         *
+         * Learn more in the [JS SDK Authentication](https://docs.acmekit.com/resources/js-sdk/auth/overview) guide.
+         *
+         * @tags auth
+         *
+         * @example
+         * await sdk.auth.logout()
+         *
+         * // user is now logged out
+         * // you can't send any requests that require authentication
+         */
+        this.logout = async () => {
+            if (this.config?.auth?.type === "session") {
+                await this.client.fetch("/auth/session", {
+                    method: "DELETE",
+                });
+            }
+            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.acmekit.com/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.acmekit.com/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.
+         *
+         * @tags auth
+         *
+         * @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",
+                body,
+                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.acmekit.com/api/admin#auth_postactor_typeauth_providerupdate).
+         *
+         * Related guide: [How to allow customers to reset their passwords in a storefront](https://docs.acmekit.com/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 `password` property.
+         *
+         * @tags auth
+         *
+         * @example
+         * sdk.auth.updateProvider(
+         *   "customer",
+         *   "emailpass",
+         *   {
+         *     password: "supersecret"
+         *   },
+         *   token
+         * )
+         * .then(() => {
+         *   // password updated
+         * })
+         */
+        this.updateProvider = async (actor, provider, body, token) => {
+            await this.client.fetch(`/auth/${actor}/${provider}/update`, {
+                method: "POST",
+                body,
+                headers: { Authorization: `Bearer ${token}` },
+            });
+        };
+        /**
+         * @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") {
+                await this.client.fetch("/auth/session", {
+                    method: "POST",
+                    headers: { Authorization: `Bearer ${token}` },
+                });
+            }
+            else {
+                this.client.setToken(token);
+            }
+        };
+        this.client = client;
+        this.config = config;
+    }
+}
+exports.Auth = Auth;
+//# sourceMappingURL=index.js.map

package/dist/auth/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":";;;AAIA,MAAa,IAAI;IAIf,YAAY,MAAc,EAAE,MAAc;QAK1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiCG;QACH,aAAQ,GAAG,KAAK,EACd,KAAa,EACb,MAAc,EACd,OAAyE,EACzE,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2DG;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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCG;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;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,YAAO,GAAG,KAAK,EAAE,OAAuB,EAAE,EAAE;YAC1C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CACvC,qBAAqB,EACrB;gBACE,MAAM,EAAE,MAAM;gBACd,OAAO;aACR,CACF,CAAA;YAED,mHAAmH;YACnH,2IAA2I;YAC3I,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAC3B,OAAO,KAAK,CAAA;QACd,CAAC,CAAA;QAED;;;;;;;;;;;;;;;;;WAiBG;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;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,kBAAa,GAAG,KAAK,EACnB,KAAa,EACb,QAAgB,EAChB,IAYC,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,mBAAc,GAAG,KAAK,EACpB,KAAa,EACb,QAAgB,EAChB,IAAmC,EACnC,KAAa,EACb,EAAE;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,KAAK,IAAI,QAAQ,SAAS,EAAE;gBAC3D,MAAM,EAAE,MAAM;gBACd,IAAI;gBACJ,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE;aAC9C,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;QAhXC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CA+WF;AAtXD,oBAsXC"}

package/dist/client.d.ts

@@ -0,0 +1,65 @@
+import { ClientFetch, Config, FetchArgs, FetchInput, FetchStreamResponse } from "./types";
+export declare const PUBLISHABLE_KEY_HEADER = "x-publishable-api-key";
+export declare const LOCALE_STORAGE_KEY = "acmekit_locale";
+export declare class FetchError extends Error {
+    status: number | undefined;
+    statusText: string | undefined;
+    constructor(message: string, statusText?: string, status?: number);
+}
+export declare class Client {
+    fetch_: ClientFetch;
+    private config;
+    private logger;
+    private DEFAULT_JWT_STORAGE_KEY;
+    private token;
+    private locale_;
+    get locale(): string;
+    constructor(config: Config);
+    setLocale(locale: string): void;
+    /**
+     * `fetch` closely follows (and uses under the hood) the native `fetch` API. There are, however, few key differences:
+     * - Non 2xx statuses throw a `FetchError` with the status code as the `status` property, rather than resolving the promise
+     * - You can pass `body` and `query` as objects, and they will be encoded and stringified.
+     * - The response gets parsed as JSON if the `accept` header is set to `application/json`, otherwise the raw Response object is returned
+     *
+     * Since the response is dynamically determined, we cannot know if it is JSON or not. Therefore, it is important to pass `Response` as the return type
+     *
+     * @param input: FetchInput
+     * @param init: FetchArgs
+     * @returns Promise<T>
+     */
+    fetch<T extends any>(input: FetchInput, init?: FetchArgs): Promise<T>;
+    /**
+     * `fetchStream` is a helper method to deal with server-sent events. It returns an object with a stream and an abort function.
+     * It follows a very similar interface to `fetch`, with the return value being an async generator.
+     * The stream is an async generator that yields `ServerSentEventMessage` objects, which contains the event name, stringified data, and few other properties.
+     * The caller is responsible for handling `disconnect` events and aborting the stream. The caller is also responsible for parsing the data field.
+     *
+     * @param input: FetchInput
+     * @param init: FetchArgs
+     * @returns FetchStreamResponse
+     */
+    fetchStream(input: FetchInput, init?: FetchArgs): Promise<FetchStreamResponse>;
+    setToken(token: string): Promise<void>;
+    getToken(): Promise<string | null | undefined>;
+    clearToken(): Promise<void>;
+    protected clearToken_(): Promise<void>;
+    protected initClient(): ClientFetch;
+    protected getApiKeyHeader_: () => {
+        Authorization: string;
+    } | {};
+    protected getPublishableKeyHeader_: () => {
+        [PUBLISHABLE_KEY_HEADER]: string;
+    } | {};
+    protected getJwtHeader_(): Promise<{
+        Authorization: string;
+    } | {}>;
+    protected setToken_(token: string): Promise<void>;
+    protected getToken_(): Promise<string | null | undefined>;
+    protected getTokenStorageInfo_: () => {
+        storageMethod: "session" | "local" | "memory" | "custom" | "nostore";
+        storageKey: string;
+    };
+    protected throwError_(message: string): void;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +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;AAC7D,eAAO,MAAM,kBAAkB,mBAAmB,CAAA;AAoFlD,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,CAAuB;IACtD,OAAO,CAAC,KAAK,CAAK;IAElB,OAAO,CAAC,OAAO,CAAK;IAEpB,IAAI,MAAM,WAQT;gBAEW,MAAM,EAAE,MAAM;IAqB1B,SAAS,CAAC,MAAM,EAAE,MAAM;IAexB;;;;;;;;;;;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;IAiBzB,QAAQ,CAAC,KAAK,EAAE,MAAM;IAItB,QAAQ;IAIR,UAAU;cAIA,WAAW;IAsB3B,SAAS,CAAC,UAAU,IAAI,WAAW;IAyEnC,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;cAEe,aAAa,IAAI,OAAO,CAAC;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,GAAG,EAAE,CAAC;cAUxD,SAAS,CAAC,KAAK,EAAE,MAAM;cAsBvB,SAAS;IAoBzB,SAAS,CAAC,oBAAoB;;;MAyB7B;IAED,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM;CAItC"}