@acmekit/core-flows 2.13.1

package/dist/api-key/workflows/delete-api-keys.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteApiKeysWorkflow = exports.deleteApiKeysWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const remove_remote_links_1 = require("../../common/steps/remove-remote-links");
+const steps_1 = require("../steps");
+const utils_1 = require("@acmekit/framework/utils");
+exports.deleteApiKeysWorkflowId = "delete-api-keys";
+/**
+ * This workflow deletes one or more secret or publishable API keys. It's used by the
+ * [Delete API Key Admin API Route](https://docs.acmekit.com/api/admin#api-keys_deleteapikeysid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * delete API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await deleteApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["apk_123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete secret or publishable API keys.
+ */
+exports.deleteApiKeysWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deleteApiKeysWorkflowId, (input) => {
+    (0, steps_1.deleteApiKeysStep)(input.ids);
+    // Please note, the ids here should be publishable key IDs
+    (0, remove_remote_links_1.removeRemoteLinkStep)({
+        [utils_1.Modules.API_KEY]: { publishable_key_id: input.ids },
+    });
+});
+//# sourceMappingURL=delete-api-keys.js.map

package/dist/api-key/workflows/delete-api-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/delete-api-keys.ts"],"names":[],"mappings":";;;AAAA,oEAA+E;AAC/E,gFAA6E;AAC7E,oCAA4C;AAC5C,oDAAkD;AAYrC,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CAAC,KAA+C,EAAsB,EAAE;IACtE,IAAA,yBAAiB,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAE5B,0DAA0D;IAC1D,IAAA,0CAAoB,EAAC;QACnB,CAAC,eAAO,CAAC,OAAO,CAAC,EAAE,EAAE,kBAAkB,EAAE,KAAK,CAAC,GAAG,EAAE;KACrD,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

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

@@ -0,0 +1,6 @@
+export * from "./create-api-keys";
+export * from "./delete-api-keys";
+export * from "./link-sales-channels-to-publishable-key";
+export * from "./revoke-api-keys";
+export * from "./update-api-keys";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA;AACjC,cAAc,0CAA0C,CAAA;AACxD,cAAc,mBAAmB,CAAA;AACjC,cAAc,mBAAmB,CAAA"}

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

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./create-api-keys"), exports);
+__exportStar(require("./delete-api-keys"), exports);
+__exportStar(require("./link-sales-channels-to-publishable-key"), exports);
+__exportStar(require("./revoke-api-keys"), exports);
+__exportStar(require("./update-api-keys"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api-key/workflows/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAiC;AACjC,oDAAiC;AACjC,2EAAwD;AACxD,oDAAiC;AACjC,oDAAiC"}

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.d.ts

@@ -0,0 +1,32 @@
+import type { LinkWorkflowInput } from "@acmekit/framework/types";
+/**
+ * The data to manage the sales channels of a publishable API key.
+ *
+ * @property id - The ID of the publishable API key.
+ * @property add - The sales channel IDs to add to the publishable API key.
+ * @property remove - The sales channel IDs to remove from the publishable API key.
+ */
+export type LinkSalesChannelsToApiKeyWorkflowInput = LinkWorkflowInput;
+export declare const linkSalesChannelsToApiKeyWorkflowId = "link-sales-channels-to-api-key";
+/**
+ * This workflow manages the sales channels of a publishable API key. It's used by the
+ * [Manage Sales Channels API Route](https://docs.acmekit.com/api/admin#api-keys_postapikeysidsaleschannels).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * manage the sales channels of a publishable API key within your custom flows.
+ *
+ * @example
+ * const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "apk_132",
+ *     add: ["sc_123"],
+ *     remove: ["sc_321"]
+ *   }
+ * })
+ *
+ * @summary
+ * Manage the sales channels of a publishable API key.
+ */
+export declare const linkSalesChannelsToApiKeyWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<LinkWorkflowInput, unknown, any[]>;
+//# sourceMappingURL=link-sales-channels-to-publishable-key.d.ts.map

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-sales-channels-to-publishable-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/link-sales-channels-to-publishable-key.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAOjE;;;;;;GAMG;AACH,MAAM,MAAM,sCAAsC,GAAG,iBAAiB,CAAA;AAEtE,eAAO,MAAM,mCAAmC,mCACd,CAAA;AAClC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iCAAiC,8FAS7C,CAAA"}

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.linkSalesChannelsToApiKeyWorkflow = exports.linkSalesChannelsToApiKeyWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+exports.linkSalesChannelsToApiKeyWorkflowId = "link-sales-channels-to-api-key";
+/**
+ * This workflow manages the sales channels of a publishable API key. It's used by the
+ * [Manage Sales Channels API Route](https://docs.acmekit.com/api/admin#api-keys_postapikeysidsaleschannels).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * manage the sales channels of a publishable API key within your custom flows.
+ *
+ * @example
+ * const { result } = await linkSalesChannelsToApiKeyWorkflow(container)
+ * .run({
+ *   input: {
+ *     id: "apk_132",
+ *     add: ["sc_123"],
+ *     remove: ["sc_321"]
+ *   }
+ * })
+ *
+ * @summary
+ * Manage the sales channels of a publishable API key.
+ */
+exports.linkSalesChannelsToApiKeyWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.linkSalesChannelsToApiKeyWorkflowId, (input) => {
+    (0, steps_1.validateSalesChannelsExistStep)({
+        sales_channel_ids: input.add ?? [],
+    });
+    (0, steps_1.linkSalesChannelsToApiKeyStep)(input);
+});
+//# sourceMappingURL=link-sales-channels-to-publishable-key.js.map

package/dist/api-key/workflows/link-sales-channels-to-publishable-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-sales-channels-to-publishable-key.js","sourceRoot":"","sources":["../../../src/api-key/workflows/link-sales-channels-to-publishable-key.ts"],"names":[],"mappings":";;;AACA,oEAA+E;AAC/E,oCAGiB;AAWJ,QAAA,mCAAmC,GAC9C,gCAAgC,CAAA;AAClC;;;;;;;;;;;;;;;;;;;GAmBG;AACU,QAAA,iCAAiC,GAAG,IAAA,8BAAc,EAC7D,2CAAmC,EACnC,CAAC,KAA2D,EAAE,EAAE;IAC9D,IAAA,sCAA8B,EAAC;QAC7B,iBAAiB,EAAE,KAAK,CAAC,GAAG,IAAI,EAAE;KACnC,CAAC,CAAA;IAEF,IAAA,qCAA6B,EAAC,KAAK,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/revoke-api-keys.d.ts

@@ -0,0 +1,47 @@
+import { ApiKeyDTO, FilterableApiKeyProps, RevokeApiKeyDTO } from "@acmekit/framework/types";
+/**
+ * The data to revoke API keys.
+ */
+export type RevokeApiKeysWorkflowInput = {
+    /**
+     * The filters to select the API keys to revoke.
+     */
+    selector: FilterableApiKeyProps;
+    /**
+     * The data to revoke the API keys.
+     */
+    revoke: RevokeApiKeyDTO;
+};
+/**
+ * The revoked API keys.
+ */
+export type RevokeApiKeysWorkflowOutput = ApiKeyDTO[];
+export declare const revokeApiKeysWorkflowId = "revoke-api-keys";
+/**
+ * This workflow revokes one or more API keys. If the API key is a secret,
+ * it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.
+ *
+ * This workflow is used by the [Revoke API Key API Route](https://docs.acmekit.com/api/admin#api-keys_postapikeysidrevoke).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * revoke API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await revokeApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     revoke: {
+ *       revoked_by: "user_123"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Revoke secret or publishable API keys.
+ */
+export declare const revokeApiKeysWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<RevokeApiKeysWorkflowInput, RevokeApiKeysWorkflowOutput, []>;
+//# sourceMappingURL=revoke-api-keys.d.ts.map

package/dist/api-key/workflows/revoke-api-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revoke-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/revoke-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,eAAe,EAChB,MAAM,0BAA0B,CAAA;AAQjC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,SAAS,EAAE,CAAA;AAErD,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,qBAAqB,wHAOjC,CAAA"}

package/dist/api-key/workflows/revoke-api-keys.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revokeApiKeysWorkflow = exports.revokeApiKeysWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+exports.revokeApiKeysWorkflowId = "revoke-api-keys";
+/**
+ * This workflow revokes one or more API keys. If the API key is a secret,
+ * it can't be used for authentication anymore. If it's publishable, it can't be used by client applications.
+ *
+ * This workflow is used by the [Revoke API Key API Route](https://docs.acmekit.com/api/admin#api-keys_postapikeysidrevoke).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * revoke API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await revokeApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     revoke: {
+ *       revoked_by: "user_123"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Revoke secret or publishable API keys.
+ */
+exports.revokeApiKeysWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.revokeApiKeysWorkflowId, (input) => {
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.revokeApiKeysStep)(input));
+});
+//# sourceMappingURL=revoke-api-keys.js.map

package/dist/api-key/workflows/revoke-api-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"revoke-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/revoke-api-keys.ts"],"names":[],"mappings":";;;AAKA,oEAIyC;AACzC,oCAA4C;AAqB/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EACA,EAAE;IACjD,OAAO,IAAI,gCAAgB,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}

package/dist/api-key/workflows/update-api-keys.d.ts

@@ -0,0 +1,45 @@
+import { ApiKeyDTO, FilterableApiKeyProps, UpdateApiKeyDTO } from "@acmekit/framework/types";
+/**
+ * The data to update API keys.
+ */
+export type UpdateApiKeysWorkflowInput = {
+    /**
+     * The filters to select the API keys to update.
+     */
+    selector: FilterableApiKeyProps;
+    /**
+     * The data to update the API keys.
+     */
+    update: UpdateApiKeyDTO;
+};
+/**
+ * The updated API keys.
+ */
+export type UpdateApiKeysWorkflowOutput = ApiKeyDTO[];
+export declare const updateApiKeysWorkflowId = "update-api-keys";
+/**
+ * This workflow updates one or more secret or publishable API keys. It's used by the
+ * [Update API Key Admin API Route](https://docs.acmekit.com/api/admin#api-keys_postapikeysid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * update API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await updateApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     update: {
+ *       title: "Storefront"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update secret or publishable API keys.
+ */
+export declare const updateApiKeysWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<UpdateApiKeysWorkflowInput, UpdateApiKeysWorkflowOutput, []>;
+//# sourceMappingURL=update-api-keys.d.ts.map

package/dist/api-key/workflows/update-api-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-api-keys.d.ts","sourceRoot":"","sources":["../../../src/api-key/workflows/update-api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,qBAAqB,EACrB,eAAe,EAChB,MAAM,0BAA0B,CAAA;AAQjC;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAA;IAC/B;;OAEG;IACH,MAAM,EAAE,eAAe,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,SAAS,EAAE,CAAA;AAErD,eAAO,MAAM,uBAAuB,oBAAoB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,qBAAqB,wHAOjC,CAAA"}

package/dist/api-key/workflows/update-api-keys.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateApiKeysWorkflow = exports.updateApiKeysWorkflowId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const steps_1 = require("../steps");
+exports.updateApiKeysWorkflowId = "update-api-keys";
+/**
+ * This workflow updates one or more secret or publishable API keys. It's used by the
+ * [Update API Key Admin API Route](https://docs.acmekit.com/api/admin#api-keys_postapikeysid).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * update API keys within your custom flows.
+ *
+ * @example
+ * const { result } = await updateApiKeysWorkflow(container)
+ * .run({
+ *   input: {
+ *     selector: {
+ *       id: "apk_123"
+ *     },
+ *     update: {
+ *       title: "Storefront"
+ *     }
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Update secret or publishable API keys.
+ */
+exports.updateApiKeysWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateApiKeysWorkflowId, (input) => {
+    return new workflows_sdk_1.WorkflowResponse((0, steps_1.updateApiKeysStep)(input));
+});
+//# sourceMappingURL=update-api-keys.js.map

package/dist/api-key/workflows/update-api-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/update-api-keys.ts"],"names":[],"mappings":";;;AAKA,oEAIyC;AACzC,oCAA4C;AAqB/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EACA,EAAE;IACjD,OAAO,IAAI,gCAAgB,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}

package/dist/auth/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./steps";
+export * from "./workflows";
+//# 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,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA"}

package/dist/auth/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./steps"), exports);
+__exportStar(require("./workflows"), exports);
+//# 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":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,8CAA2B"}

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

@@ -0,0 +1,2 @@
+export * from "./set-auth-app-metadata";
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/auth/steps/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./set-auth-app-metadata"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/auth/steps/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC"}

package/dist/auth/steps/set-auth-app-metadata.d.ts

@@ -0,0 +1,40 @@
+export type SetAuthAppMetadataStepInput = {
+    authIdentityId: string;
+    actorType: string;
+    value: string | null;
+};
+export declare const setAuthAppMetadataStepId = "set-auth-app-metadata";
+/**
+ * This step sets the `app_metadata` property of an auth identity. This is useful to
+ * associate a user (whether it's an admin user or customer) with an auth identity
+ * that allows them to authenticate into AcmeKit.
+ *
+ * You can learn more about auth identites in
+ * [this documentation](https://docs.acmekit.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
+ *
+ * To use this for a custom actor type, check out [this guide](https://docs.acmekit.com/resources/commerce-modules/auth/create-actor-type)
+ * that explains how to create a custom `manager` actor type and manage its users.
+ *
+ * @example
+ * To associate an auth identity with an actor type (user, customer, or other actor types):
+ *
+ * ```ts
+ * const data = setAuthAppMetadataStep({
+ *   authIdentityId: "au_1234",
+ *   actorType: "user", // or `customer`, or custom type
+ *   value: "user_123"
+ * })
+ * ```
+ *
+ * To remove the association with an actor type, such as when deleting the user:
+ *
+ * ```ts
+ * const data = setAuthAppMetadataStep({
+ *   authIdentityId: "au_1234",
+ *   actorType: "user", // or `customer`, or custom type
+ *   value: null
+ * })
+ * ```
+ */
+export declare const setAuthAppMetadataStep: import("@acmekit/framework/workflows-sdk").StepFunction<SetAuthAppMetadataStepInput, import("@acmekit/framework/types").AuthIdentityDTO>;
+//# sourceMappingURL=set-auth-app-metadata.d.ts.map

package/dist/auth/steps/set-auth-app-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-auth-app-metadata.d.ts","sourceRoot":"","sources":["../../../src/auth/steps/set-auth-app-metadata.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,2BAA2B,GAAG;IACxC,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,wBAAwB,0BAA0B,CAAA;AAC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,sBAAsB,0IAuDlC,CAAA"}

package/dist/auth/steps/set-auth-app-metadata.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setAuthAppMetadataStep = exports.setAuthAppMetadataStepId = void 0;
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const utils_1 = require("@acmekit/framework/utils");
+exports.setAuthAppMetadataStepId = "set-auth-app-metadata";
+/**
+ * This step sets the `app_metadata` property of an auth identity. This is useful to
+ * associate a user (whether it's an admin user or customer) with an auth identity
+ * that allows them to authenticate into AcmeKit.
+ *
+ * You can learn more about auth identites in
+ * [this documentation](https://docs.acmekit.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
+ *
+ * To use this for a custom actor type, check out [this guide](https://docs.acmekit.com/resources/commerce-modules/auth/create-actor-type)
+ * that explains how to create a custom `manager` actor type and manage its users.
+ *
+ * @example
+ * To associate an auth identity with an actor type (user, customer, or other actor types):
+ *
+ * ```ts
+ * const data = setAuthAppMetadataStep({
+ *   authIdentityId: "au_1234",
+ *   actorType: "user", // or `customer`, or custom type
+ *   value: "user_123"
+ * })
+ * ```
+ *
+ * To remove the association with an actor type, such as when deleting the user:
+ *
+ * ```ts
+ * const data = setAuthAppMetadataStep({
+ *   authIdentityId: "au_1234",
+ *   actorType: "user", // or `customer`, or custom type
+ *   value: null
+ * })
+ * ```
+ */
+exports.setAuthAppMetadataStep = (0, workflows_sdk_1.createStep)(exports.setAuthAppMetadataStepId, async (data, { container }) => {
+    const service = container.resolve(utils_1.Modules.AUTH);
+    const key = `${data.actorType}_id`;
+    const authIdentity = await service.retrieveAuthIdentity(data.authIdentityId);
+    const appMetadata = authIdentity.app_metadata || {};
+    // If the value is null, we are deleting the association with an actor
+    if ((0, utils_1.isDefined)(appMetadata[key]) && data.value !== null) {
+        throw new Error(`Key ${key} already exists in app metadata`);
+    }
+    const oldValue = appMetadata[key];
+    appMetadata[key] = data.value;
+    await service.updateAuthIdentities({
+        id: authIdentity.id,
+        app_metadata: appMetadata,
+    });
+    return new workflows_sdk_1.StepResponse(authIdentity, {
+        id: authIdentity.id,
+        key: key,
+        value: data.value,
+        oldValue,
+    });
+}, async (idAndKeyAndValue, { container }) => {
+    if (!idAndKeyAndValue) {
+        return;
+    }
+    const { id, key, oldValue, value } = idAndKeyAndValue;
+    const service = container.resolve(utils_1.Modules.AUTH);
+    const authIdentity = await service.retrieveAuthIdentity(id);
+    const appMetadata = authIdentity.app_metadata || {};
+    // If the value is null, we WERE deleting the association with an actor, so we need to restore it
+    if (value === null) {
+        appMetadata[key] = oldValue;
+    }
+    else {
+        delete appMetadata[key];
+    }
+    await service.updateAuthIdentities({
+        id: authIdentity.id,
+        app_metadata: appMetadata,
+    });
+});
+//# sourceMappingURL=set-auth-app-metadata.js.map

package/dist/auth/steps/set-auth-app-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"set-auth-app-metadata.js","sourceRoot":"","sources":["../../../src/auth/steps/set-auth-app-metadata.ts"],"names":[],"mappings":";;;AAAA,oEAA2E;AAG3E,oDAA6D;AAQhD,QAAA,wBAAwB,GAAG,uBAAuB,CAAA;AAC/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACU,QAAA,sBAAsB,GAAG,IAAA,0BAAU,EAC9C,gCAAwB,EACxB,KAAK,EAAE,IAAiC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACzD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,SAAS,KAAK,CAAA;IAClC,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAE5E,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,IAAI,EAAE,CAAA;IAEnD,sEAAsE;IACtE,IAAI,IAAA,iBAAS,EAAC,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QACvD,MAAM,IAAI,KAAK,CAAC,OAAO,GAAG,iCAAiC,CAAC,CAAA;IAC9D,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IACjC,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAA;IAE7B,MAAM,OAAO,CAAC,oBAAoB,CAAC;QACjC,EAAE,EAAE,YAAY,CAAC,EAAE;QACnB,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAA;IAEF,OAAO,IAAI,4BAAY,CAAC,YAAY,EAAE;QACpC,EAAE,EAAE,YAAY,CAAC,EAAE;QACnB,GAAG,EAAE,GAAG;QACR,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,QAAQ;KACT,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,gBAAgB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACxC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,OAAM;IACR,CAAC;IAED,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAAA;IAErD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;IAE3D,MAAM,WAAW,GAAG,YAAY,CAAC,YAAY,IAAI,EAAE,CAAA;IAEnD,iGAAiG;IACjG,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,WAAW,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAA;IAC7B,CAAC;SAAM,CAAC;QACN,OAAO,WAAW,CAAC,GAAG,CAAC,CAAA;IACzB,CAAC;IAED,MAAM,OAAO,CAAC,oBAAoB,CAAC;QACjC,EAAE,EAAE,YAAY,CAAC,EAAE;QACnB,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/auth/workflows/generate-reset-password-token.d.ts

@@ -0,0 +1,39 @@
+import type { ProjectConfigOptions } from "@acmekit/framework/types";
+/**
+ * This workflow generates a reset password token for a user. It's used by the
+ * [Generate Reset Password Token for Admin](https://docs.acmekit.com/api/admin#auth_postactor_typeauth_providerresetpassword)
+ * and [Generate Reset Password Token for Customer](https://docs.acmekit.com/api/store#auth_postactor_typeauth_providerresetpassword)
+ * API Routes.
+ *
+ * The workflow emits the `auth.password_reset` event, which you can listen to in
+ * a [subscriber](https://docs.acmekit.com/learn/fundamentals/events-and-subscribers). Follow
+ * [this guide](https://docs.acmekit.com/resources/commerce-modules/auth/reset-password) to learn
+ * how to handle this event.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * generate reset password tokens within your custom flows.
+ *
+ * @example
+ * const { result } = await generateResetPasswordTokenWorkflow(container)
+ * .run({
+ *   input: {
+ *     entityId: "example@gmail.com",
+ *     actorType: "customer",
+ *     provider: "emailpass",
+ *     secret: "jwt_123" // jwt secret
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Generate a reset password token for a user or customer.
+ */
+export declare const generateResetPasswordTokenWorkflow: import("@acmekit/framework/workflows-sdk").ReturnWorkflow<{
+    entityId: string;
+    actorType: string;
+    provider: string;
+    secret: ProjectConfigOptions["http"]["jwtSecret"];
+    jwtOptions?: ProjectConfigOptions["http"]["jwtOptions"];
+    metadata?: Record<string, unknown>;
+}, string, []>;
+//# sourceMappingURL=generate-reset-password-token.d.ts.map

package/dist/auth/workflows/generate-reset-password-token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-reset-password-token.d.ts","sourceRoot":"","sources":["../../../src/auth/workflows/generate-reset-password-token.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAapE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,kCAAkC;cAGjC,MAAM;eACL,MAAM;cACP,MAAM;YACR,oBAAoB,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC;iBACpC,oBAAoB,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC;eAC5C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;cAsDrC,CAAA"}

package/dist/auth/workflows/generate-reset-password-token.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateResetPasswordTokenWorkflow = void 0;
+const utils_1 = require("@acmekit/framework/utils");
+const workflows_sdk_1 = require("@acmekit/framework/workflows-sdk");
+const common_1 = require("../../common");
+/**
+ * This workflow generates a reset password token for a user. It's used by the
+ * [Generate Reset Password Token for Admin](https://docs.acmekit.com/api/admin#auth_postactor_typeauth_providerresetpassword)
+ * and [Generate Reset Password Token for Customer](https://docs.acmekit.com/api/store#auth_postactor_typeauth_providerresetpassword)
+ * API Routes.
+ *
+ * The workflow emits the `auth.password_reset` event, which you can listen to in
+ * a [subscriber](https://docs.acmekit.com/learn/fundamentals/events-and-subscribers). Follow
+ * [this guide](https://docs.acmekit.com/resources/commerce-modules/auth/reset-password) to learn
+ * how to handle this event.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * generate reset password tokens within your custom flows.
+ *
+ * @example
+ * const { result } = await generateResetPasswordTokenWorkflow(container)
+ * .run({
+ *   input: {
+ *     entityId: "example@gmail.com",
+ *     actorType: "customer",
+ *     provider: "emailpass",
+ *     secret: "jwt_123" // jwt secret
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Generate a reset password token for a user or customer.
+ */
+exports.generateResetPasswordTokenWorkflow = (0, workflows_sdk_1.createWorkflow)("generate-reset-password-token", (input) => {
+    const providerIdentities = (0, common_1.useRemoteQueryStep)({
+        entry_point: "provider_identity",
+        fields: ["auth_identity_id", "provider_metadata"],
+        variables: {
+            filters: {
+                entity_id: input.entityId,
+                provider: input.provider,
+            },
+        },
+    });
+    const token = (0, workflows_sdk_1.transform)({ input, providerIdentities }, ({ input, providerIdentities }) => {
+        const providerIdentity = providerIdentities?.[0];
+        if (!providerIdentity) {
+            throw new utils_1.AcmeKitError(utils_1.AcmeKitError.Types.INVALID_DATA, `Provider identity with entity_id ${input.entityId} and provider ${input.provider} not found`);
+        }
+        const token = (0, utils_1.generateJwtToken)({
+            entity_id: input.entityId,
+            provider: input.provider,
+            actor_type: input.actorType,
+        }, {
+            secret: input.secret,
+            expiresIn: "15m",
+            jwtOptions: input.jwtOptions,
+        });
+        return token;
+    });
+    (0, common_1.emitEventStep)({
+        eventName: utils_1.AuthWorkflowEvents.PASSWORD_RESET,
+        data: {
+            entity_id: input.entityId,
+            actor_type: input.actorType,
+            token,
+            metadata: input.metadata ?? {},
+        },
+    });
+    return new workflows_sdk_1.WorkflowResponse(token);
+});
+//# sourceMappingURL=generate-reset-password-token.js.map