@acmekit/js-sdk 2.13.1

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

@@ -0,0 +1,95 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export class WorkflowExecution {
+    /**
+     * @ignore
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * This method retrieves a list of workflow executions. It sends a request to the
+     * [List Workflow Executions](https://docs.acmekit.com/api/admin#workflows-executions_getworkflowsexecutions)
+     * API route.
+     *
+     * @param queryParams - Filters and pagination configurations.
+     * @param headers - Headers to pass in the request.
+     * @returns The list of workflow executions.
+     *
+     * @example
+     * To retrieve the list of workflow executions:
+     *
+     * ```ts
+     * sdk.admin.workflowExecution.list()
+     * .then(({ workflow_executions, count, limit, offset }) => {
+     *   console.log(workflow_executions)
+     * })
+     * ```
+     *
+     * 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.workflowExecution.list({
+     *   limit: 10,
+     *   offset: 10
+     * })
+     * .then(({ workflow_executions, count, limit, offset }) => {
+     *   console.log(workflow_executions)
+     * })
+     * ```
+     *
+     * Using the `fields` query parameter, you can specify the fields and relations to retrieve
+     * in each workflow execution:
+     *
+     * ```ts
+     * sdk.admin.workflowExecution.list({
+     *   fields: "id,name"
+     * })
+     * .then(({ workflow_executions, count, limit, offset }) => {
+     *   console.log(workflow_executions)
+     * })
+     * ```
+     *
+     * Learn more about the `fields` property in the [API reference](https://docs.acmekit.com/api/admin#select-fields-and-relations).
+     */
+    list(queryParams, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/workflows-executions`, {
+                query: queryParams,
+                headers,
+            });
+        });
+    }
+    /**
+     * This method retrieves a workflow execution by its ID. It sends a request to the
+     * [Get Workflow Execution](https://docs.acmekit.com/api/admin#workflows-executions_getworkflowsexecutionsworkflow_idtransaction_id)
+     * API route.
+     *
+     * @param id - The ID of the workflow execution to retrieve.
+     * @param headers - Headers to pass in the request.
+     * @returns The workflow execution's details.
+     *
+     * @example
+     * sdk.admin.workflowExecution.retrieve("wrk_123")
+     * .then(({ workflow_execution }) => {
+     *   console.log(workflow_execution)
+     * })
+     */
+    retrieve(id, headers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.client.fetch(`/admin/workflows-executions/${id}`, {
+                headers,
+            });
+        });
+    }
+}
+//# sourceMappingURL=workflow-execution.js.map

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

@@ -0,0 +1 @@
+{"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;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,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;IAED;;;;;;;;;;;;;;OAcG;IACG,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

@@ -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/esm/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"}