@etohq/core-flows 1.3.0 → 1.5.0

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

@@ -5,7 +5,28 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.updateApiKeysWorkflowId = "update-api-keys";
 /**
- * This workflow creates one or more 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.etohq.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));

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

@@ -1 +1 @@
-{"version":3,"file":"update-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/update-api-keys.ts"],"names":[],"mappings":";;;AAKA,kEAIuC;AACvC,oCAA4C;AAO/B,QAAA,uBAAuB,GAAG,iBAAiB,CAAA;AACxD;;GAEG;AACU,QAAA,qBAAqB,GAAG,IAAA,8BAAc,EACjD,+BAAuB,EACvB,CACE,KAA+C,EAChB,EAAE;IACjC,OAAO,IAAI,gCAAgB,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,CAAC,CAAA;AACvD,CAAC,CACF,CAAA"}
+{"version":3,"file":"update-api-keys.js","sourceRoot":"","sources":["../../../src/api-key/workflows/update-api-keys.ts"],"names":[],"mappings":";;;AAKA,kEAIuC;AACvC,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/steps/set-auth-app-metadata.d.ts

@@ -5,7 +5,36 @@ export type SetAuthAppMetadataStepInput = {
 };
 export declare const setAuthAppMetadataStepId = "set-auth-app-metadata";
 /**
- * This step sets the `app_metadata` property of an auth identity.
+ * 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 Eto.
+ *
+ * You can learn more about auth identites in
+ * [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
+ *
+ * To use this for a custom actor type, check out [this guide](https://docs.etohq.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("@etohq/framework/workflows-sdk").StepFunction<SetAuthAppMetadataStepInput, import("@etohq/framework/types").AuthIdentityDTO>;
 //# sourceMappingURL=set-auth-app-metadata.d.ts.map

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

@@ -1 +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;;GAEG;AACH,eAAO,MAAM,sBAAsB,sIAuDlC,CAAA"}
+{"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,sIAuDlC,CAAA"}

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

@@ -5,7 +5,36 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const utils_1 = require("@etohq/framework/utils");
 exports.setAuthAppMetadataStepId = "set-auth-app-metadata";
 /**
- * This step sets the `app_metadata` property of an auth identity.
+ * 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 Eto.
+ *
+ * You can learn more about auth identites in
+ * [this documentation](https://docs.etohq.com/resources/commerce-modules/auth/auth-identity-and-actor-types).
+ *
+ * To use this for a custom actor type, check out [this guide](https://docs.etohq.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);

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

@@ -1 +1 @@
-{"version":3,"file":"set-auth-app-metadata.js","sourceRoot":"","sources":["../../../src/auth/steps/set-auth-app-metadata.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AAGzE,kDAA2D;AAQ9C,QAAA,wBAAwB,GAAG,uBAAuB,CAAA;AAC/D;;GAEG;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"}
+{"version":3,"file":"set-auth-app-metadata.js","sourceRoot":"","sources":["../../../src/auth/steps/set-auth-app-metadata.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AAGzE,kDAA2D;AAQ9C,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

@@ -1,7 +1,38 @@
+import { ProjectConfigOptions } from "@etohq/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.etohq.com/api/admin#auth_postactor_typeauth_providerresetpassword)
+ * and [Generate Reset Password Token for Customer](https://docs.etohq.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.etohq.com/learn/fundamentals/events-and-subscribers). Follow
+ * [this guide](https://docs.etohq.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("@etohq/framework/workflows-sdk").ReturnWorkflow<{
     entityId: string;
     actorType: string;
     provider: string;
-    secret: string;
-}, string, []>;
+    secret: ProjectConfigOptions["http"]["jwtSecret"];
+    jwtOptions?: ProjectConfigOptions["http"]["jwtOptions"];
+}, any, []>;
 //# sourceMappingURL=generate-reset-password-token.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"generate-reset-password-token.d.ts","sourceRoot":"","sources":["../../../src/auth/workflows/generate-reset-password-token.ts"],"names":[],"mappings":"AAYA,eAAO,MAAM,kCAAkC;cAGjC,MAAM;eACL,MAAM;cACP,MAAM;YACR,MAAM;cAyDjB,CAAA"}
+{"version":3,"file":"generate-reset-password-token.d.ts","sourceRoot":"","sources":["../../../src/auth/workflows/generate-reset-password-token.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;WAqD1D,CAAA"}

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

@@ -4,6 +4,35 @@ exports.generateResetPasswordTokenWorkflow = void 0;
 const utils_1 = require("@etohq/framework/utils");
 const workflows_sdk_1 = require("@etohq/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.etohq.com/api/admin#auth_postactor_typeauth_providerresetpassword)
+ * and [Generate Reset Password Token for Customer](https://docs.etohq.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.etohq.com/learn/fundamentals/events-and-subscribers). Follow
+ * [this guide](https://docs.etohq.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",
@@ -27,6 +56,7 @@ exports.generateResetPasswordTokenWorkflow = (0, workflows_sdk_1.createWorkflow)
         }, {
             secret: input.secret,
             expiresIn: "15m",
+            jwtOptions: input.jwtOptions,
         });
         return token;
     });
@@ -34,11 +64,6 @@ exports.generateResetPasswordTokenWorkflow = (0, workflows_sdk_1.createWorkflow)
         eventName: utils_1.AuthWorkflowEvents.PASSWORD_RESET,
         data: {
             entity_id: input.entityId,
-            /**
-             * Use `actor_type` instead. Will be removed in a future version.
-             * @deprecated
-             */
-            actorType: input.actorType,
             actor_type: input.actorType,
             token,
         },

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

@@ -1 +1 @@
-{"version":3,"file":"generate-reset-password-token.js","sourceRoot":"","sources":["../../../src/auth/workflows/generate-reset-password-token.ts"],"names":[],"mappings":";;;AAAA,kDAI+B;AAC/B,kEAIuC;AACvC,yCAAgE;AAEnD,QAAA,kCAAkC,GAAG,IAAA,8BAAc,EAC9D,+BAA+B,EAC/B,CAAC,KAKA,EAAE,EAAE;IACH,MAAM,kBAAkB,GAAG,IAAA,2BAAkB,EAAC;QAC5C,WAAW,EAAE,mBAAmB;QAChC,MAAM,EAAE,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;QACjD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,SAAS,EAAE,KAAK,CAAC,QAAQ;gBACzB,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB;SACF;KACF,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,IAAA,yBAAS,EACrB,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAC7B,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,EAAE;QAChC,MAAM,gBAAgB,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAA;QAEhD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,oCAAoC,KAAK,CAAC,QAAQ,iBAAiB,KAAK,CAAC,QAAQ,YAAY,CAC9F,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAA,wBAAgB,EAC5B;YACE,SAAS,EAAE,KAAK,CAAC,QAAQ;YACzB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,UAAU,EAAE,KAAK,CAAC,SAAS;SAC5B,EACD;YACE,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,KAAK;SACjB,CACF,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC,CACF,CAAA;IAED,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,cAAc;QAC5C,IAAI,EAAE;YACJ,SAAS,EAAE,KAAK,CAAC,QAAQ;YACzB;;;eAGG;YACH,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,UAAU,EAAE,KAAK,CAAC,SAAS;YAC3B,KAAK;SACN;KACF,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAA;AACpC,CAAC,CACF,CAAA"}
+{"version":3,"file":"generate-reset-password-token.js","sourceRoot":"","sources":["../../../src/auth/workflows/generate-reset-password-token.ts"],"names":[],"mappings":";;;AAAA,kDAI+B;AAC/B,kEAIuC;AACvC,yCAAgE;AAGhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACU,QAAA,kCAAkC,GAAG,IAAA,8BAAc,EAC9D,+BAA+B,EAC/B,CAAC,KAMA,EAAE,EAAE;IACH,MAAM,kBAAkB,GAAG,IAAA,2BAAkB,EAAC;QAC5C,WAAW,EAAE,mBAAmB;QAChC,MAAM,EAAE,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;QACjD,SAAS,EAAE;YACT,OAAO,EAAE;gBACP,SAAS,EAAE,KAAK,CAAC,QAAQ;gBACzB,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB;SACF;KACF,CAAC,CAAA;IAEF,MAAM,KAAK,GAAG,IAAA,yBAAS,EACrB,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAC7B,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,EAAE;QAChC,MAAM,gBAAgB,GAAG,kBAAkB,EAAE,CAAC,CAAC,CAAC,CAAA;QAEhD,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,gBAAQ,CAChB,gBAAQ,CAAC,KAAK,CAAC,YAAY,EAC3B,oCAAoC,KAAK,CAAC,QAAQ,iBAAiB,KAAK,CAAC,QAAQ,YAAY,CAC9F,CAAA;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAA,wBAAgB,EAC5B;YACE,SAAS,EAAE,KAAK,CAAC,QAAQ;YACzB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,UAAU,EAAE,KAAK,CAAC,SAAS;SAC5B,EACD;YACE,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE,KAAK,CAAC,UAAU;SAC7B,CACF,CAAA;QAED,OAAO,KAAK,CAAA;IACd,CAAC,CACF,CAAA;IAED,IAAA,sBAAa,EAAC;QACZ,SAAS,EAAE,0BAAkB,CAAC,cAAc;QAC5C,IAAI,EAAE;YACJ,SAAS,EAAE,KAAK,CAAC,QAAQ;YACzB,UAAU,EAAE,KAAK,CAAC,SAAS;YAC3B,KAAK;SACN;KACF,CAAC,CAAA;IAEF,OAAO,IAAI,gCAAgB,CAAC,KAAK,CAAC,CAAA;AACpC,CAAC,CACF,CAAA"}

package/dist/common/index.d.ts

@@ -1,9 +1,8 @@
 export * from "./steps/create-entities";
-export * from "./steps/delete-entities";
 export * from "./steps/create-remote-links";
 export * from "./steps/dismiss-remote-links";
+export * from "./steps/delete-entities";
 export * from "./steps/emit-event";
-export * from "./steps/release-event";
 export * from "./steps/remove-remote-links";
 export * from "./steps/update-remote-links";
 export * from "./steps/use-query-graph";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,oBAAoB,CAAA;AAClC,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA"}

package/dist/common/index.js

@@ -15,11 +15,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./steps/create-entities"), exports);
-__exportStar(require("./steps/delete-entities"), exports);
 __exportStar(require("./steps/create-remote-links"), exports);
 __exportStar(require("./steps/dismiss-remote-links"), exports);
+__exportStar(require("./steps/delete-entities"), exports);
 __exportStar(require("./steps/emit-event"), exports);
-__exportStar(require("./steps/release-event"), exports);
 __exportStar(require("./steps/remove-remote-links"), exports);
 __exportStar(require("./steps/update-remote-links"), exports);
 __exportStar(require("./steps/use-query-graph"), exports);

package/dist/common/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,0DAAuC;AACvC,8DAA2C;AAC3C,+DAA4C;AAC5C,qDAAkC;AAClC,wDAAqC;AACrC,8DAA2C;AAC3C,8DAA2C;AAC3C,0DAAuC;AACvC,2DAAwC;AACxC,+DAA4C;AAC5C,0DAAuC;AACvC,2DAAwC;AACxC,4DAAyC;AACzC,2DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAuC;AACvC,8DAA2C;AAC3C,+DAA4C;AAC5C,0DAAuC;AACvC,qDAAkC;AAClC,8DAA2C;AAC3C,8DAA2C;AAC3C,0DAAuC;AACvC,2DAAwC;AACxC,+DAA4C;AAC5C,0DAAuC;AACvC,2DAAwC;AACxC,4DAAyC;AACzC,2DAAwC"}

package/dist/common/steps/create-entities.d.ts

@@ -1,13 +1,45 @@
 export interface CreateEntitiesStepType {
+    /**
+     * The regitration name of the module that contains the method to be invoked.
+     */
     moduleRegistrationName: string;
+    /**
+     * The method to be invoked.
+     */
     invokeMethod: string;
+    /**
+     * The method to be invoked in case of compensation (when an error occurs).
+     */
     compensateMethod: string;
+    /**
+     * A string to pass to the compensate method.
+     */
     entityIdentifier?: string;
+    /**
+     * The data to pass to the invoke method.
+     * For example, an array of objects to create.
+     */
     data: any[];
 }
 export declare const createEntitiesStepId = "create-entities-step";
 /**
- * This step creates entities for any given module or resource
+ * This step creates one or more entities using methods in a module's service.
+ *
+ * @example
+ * createEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "createCreditLines",
+ *   compensateMethod: "deleteCreditLines",
+ *   data: {
+ *     cart_id: "cart_123",
+ *     amount: 10,
+ *     reference: "payment",
+ *     reference_id: "payment_123",
+ *     metadata: {
+ *       key: "value",
+ *     },
+ *   },
+ * })
  */
 export declare const createEntitiesStep: import("@etohq/framework/workflows-sdk").StepFunction<CreateEntitiesStepType, any[]>;
 //# sourceMappingURL=create-entities.d.ts.map

package/dist/common/steps/create-entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,sFAmC9B,CAAA"}
+{"version":3,"file":"create-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kBAAkB,sFAmC9B,CAAA"}

package/dist/common/steps/create-entities.js

@@ -4,7 +4,23 @@ exports.createEntitiesStep = exports.createEntitiesStepId = void 0;
 const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.createEntitiesStepId = "create-entities-step";
 /**
- * This step creates entities for any given module or resource
+ * This step creates one or more entities using methods in a module's service.
+ *
+ * @example
+ * createEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "createCreditLines",
+ *   compensateMethod: "deleteCreditLines",
+ *   data: {
+ *     cart_id: "cart_123",
+ *     amount: 10,
+ *     reference: "payment",
+ *     reference_id: "payment_123",
+ *     metadata: {
+ *       key: "value",
+ *     },
+ *   },
+ * })
  */
 exports.createEntitiesStep = (0, workflows_sdk_1.createStep)(exports.createEntitiesStepId, async (input, { container }) => {
     const { moduleRegistrationName, invokeMethod, compensateMethod, entityIdentifier = "id", data = [], } = input;

package/dist/common/steps/create-entities.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-entities.js","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AAU5D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,GAAG,IAAI,EACvB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAU,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAE1E,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE;QAC/B,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-entities.js","sourceRoot":"","sources":["../../../src/common/steps/create-entities.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AA0B5D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;;;;;;;;;;;;;;;;;GAkBG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,GAAG,IAAI,EACvB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,MAAM,OAAO,GAAU,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAE1E,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE;QAC/B,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}

package/dist/common/steps/create-remote-links.d.ts

@@ -6,29 +6,14 @@ export declare const createLinksStepId = "create-remote-links";
  * Learn more in the [Remote Link documentation.](https://docs.etohq.com/learn/fundamentals/module-links/remote-link#create-link).
  *
  * @example
- * import {
- *   createWorkflow
- * } from "@etohq/framework/workflows-sdk"
- * import {
- *   createRemoteLinkStep
- * } from "@etohq/eto/commerce-flows"
- * import {
- *   Modules
- * } from "@etohq/framework/utils"
- *
- * const helloWorldWorkflow = createWorkflow(
- *   "hello-world",
- *   () => {
- *     createRemoteLinkStep([{
- *       [Modules.PRODUCT]: {
- *         product_id: "prod_123",
- *       },
- *       "helloModuleService": {
- *         my_custom_id: "mc_123",
- *       },
- *     }])
- *   }
- * )
+ * createRemoteLinkStep([{
+ *   [Modules.PRODUCT]: {
+ *     product_id: "prod_123",
+ *   },
+ *   "helloModuleService": {
+ *     my_custom_id: "mc_123",
+ *   },
+ * }])
  */
 export declare const createRemoteLinkStep: import("@etohq/framework/workflows-sdk").StepFunction<LinkDefinition[], LinkDefinition[]>;
 //# sourceMappingURL=create-remote-links.d.ts.map

package/dist/common/steps/create-remote-links.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-remote-links.d.ts","sourceRoot":"","sources":["../../../src/common/steps/create-remote-links.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAIvD,eAAO,MAAM,iBAAiB,wBAAwB,CAAA;AACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,oBAAoB,2FAqBhC,CAAA"}
+{"version":3,"file":"create-remote-links.d.ts","sourceRoot":"","sources":["../../../src/common/steps/create-remote-links.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAIvD,eAAO,MAAM,iBAAiB,wBAAwB,CAAA;AACtD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,oBAAoB,2FAqBhC,CAAA"}

package/dist/common/steps/create-remote-links.js

@@ -10,29 +10,14 @@ exports.createLinksStepId = "create-remote-links";
  * Learn more in the [Remote Link documentation.](https://docs.etohq.com/learn/fundamentals/module-links/remote-link#create-link).
  *
  * @example
- * import {
- *   createWorkflow
- * } from "@etohq/framework/workflows-sdk"
- * import {
- *   createRemoteLinkStep
- * } from "@etohq/eto/commerce-flows"
- * import {
- *   Modules
- * } from "@etohq/framework/utils"
- *
- * const helloWorldWorkflow = createWorkflow(
- *   "hello-world",
- *   () => {
- *     createRemoteLinkStep([{
- *       [Modules.PRODUCT]: {
- *         product_id: "prod_123",
- *       },
- *       "helloModuleService": {
- *         my_custom_id: "mc_123",
- *       },
- *     }])
- *   }
- * )
+ * createRemoteLinkStep([{
+ *   [Modules.PRODUCT]: {
+ *     product_id: "prod_123",
+ *   },
+ *   "helloModuleService": {
+ *     my_custom_id: "mc_123",
+ *   },
+ * }])
  */
 exports.createRemoteLinkStep = (0, workflows_sdk_1.createStep)(exports.createLinksStepId, async (data, { container }) => {
     const link = container.resolve(utils_1.ContainerRegistrationKeys.LINK);

package/dist/common/steps/create-remote-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-remote-links.js","sourceRoot":"","sources":["../../../src/common/steps/create-remote-links.ts"],"names":[],"mappings":";;;AAEA,kDAAkE;AAClE,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,qBAAqB,CAAA;AACtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,oBAAoB,GAAG,IAAA,0BAAU,EAC5C,yBAAiB,EACjB,KAAK,EAAE,IAAsB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IAEpE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,IAAI,4BAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAEvB,OAAO,IAAI,4BAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AACrC,CAAC,EACD,KAAK,EAAE,YAAY,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAM;IACR,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;AAClC,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-remote-links.js","sourceRoot":"","sources":["../../../src/common/steps/create-remote-links.ts"],"names":[],"mappings":";;;AAEA,kDAAkE;AAClE,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,qBAAqB,CAAA;AACtD;;;;;;;;;;;;;;GAcG;AACU,QAAA,oBAAoB,GAAG,IAAA,0BAAU,EAC5C,yBAAiB,EACjB,KAAK,EAAE,IAAsB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAC9C,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IAEpE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,IAAI,4BAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAEvB,OAAO,IAAI,4BAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AACrC,CAAC,EACD,KAAK,EAAE,YAAY,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACpC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAM;IACR,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;AAClC,CAAC,CACF,CAAA"}

package/dist/common/steps/delete-entities.d.ts

@@ -1,13 +1,38 @@
 export interface DeleteEntitiesStepType {
+    /**
+     * The regitration name of the module that contains the method to be invoked.
+     */
     moduleRegistrationName: string;
+    /**
+     * The method to be invoked.
+     */
     invokeMethod: string;
+    /**
+     * The method to be invoked in case of compensation (when an error occurs).
+     */
     compensateMethod: string;
+    /**
+     * A string to pass to the compensate method.
+     * For example, an ID of the entity to be deleted.
+     */
     entityIdentifier?: string;
+    /**
+     * The data to pass to the invoke method.
+     * For example, an array of IDs to delete.
+     */
     data: any[];
 }
 export declare const deleteEntitiesStepId = "delete-entities-step";
 /**
- * This step deletes one or more entities.
+ * This step deletes one or more entities using methods in a module's service.
+ *
+ * @example
+ * deleteEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "softDeleteCreditLines",
+ *   compensateMethod: "restoreCreditLines",
+ *   data: input.id,
+ * })
  */
 export declare const deleteEntitiesStep: import("@etohq/framework/workflows-sdk").StepFunction<DeleteEntitiesStepType, undefined>;
 //# sourceMappingURL=delete-entities.d.ts.map

package/dist/common/steps/delete-entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;GAEG;AACH,eAAO,MAAM,kBAAkB,0FAkC9B,CAAA"}
+{"version":3,"file":"delete-entities.d.ts","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAA;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,IAAI,EAAE,GAAG,EAAE,CAAA;CACZ;AAED,eAAO,MAAM,oBAAoB,yBAAyB,CAAA;AAC1D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,0FAkC9B,CAAA"}

package/dist/common/steps/delete-entities.js

@@ -4,7 +4,15 @@ exports.deleteEntitiesStep = exports.deleteEntitiesStepId = void 0;
 const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.deleteEntitiesStepId = "delete-entities-step";
 /**
- * This step deletes one or more entities.
+ * This step deletes one or more entities using methods in a module's service.
+ *
+ * @example
+ * deleteEntitiesStep({
+ *   moduleRegistrationName: Modules.CART,
+ *   invokeMethod: "softDeleteCreditLines",
+ *   compensateMethod: "restoreCreditLines",
+ *   data: input.id,
+ * })
  */
 exports.deleteEntitiesStep = (0, workflows_sdk_1.createStep)(exports.deleteEntitiesStepId, async (input, { container }) => {
     const { moduleRegistrationName, invokeMethod, compensateMethod, data = [], } = input;

package/dist/common/steps/delete-entities.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-entities.js","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AAU5D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAEnD,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE;QAC9B,iBAAiB,EAAE,KAAK,CAAC,IAAI;QAC7B,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-entities.js","sourceRoot":"","sources":["../../../src/common/steps/delete-entities.ts"],"names":[],"mappings":";;;AAAA,kEAAyE;AA2B5D,QAAA,oBAAoB,GAAG,sBAAsB,CAAA;AAC1D;;;;;;;;;;GAUG;AACU,QAAA,kBAAkB,GAAG,IAAA,0BAAU,EAC1C,4BAAoB,EACpB,KAAK,EAAE,KAA6B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrD,MAAM,EACJ,sBAAsB,EACtB,YAAY,EACZ,gBAAgB,EAChB,IAAI,GAAG,EAAE,GACV,GAAG,KAAK,CAAA;IAET,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAEnD,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,EAAE;QAC9B,iBAAiB,EAAE,KAAK,CAAC,IAAI;QAC7B,sBAAsB;QACtB,gBAAgB;KACjB,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACvC,MAAM,EACJ,iBAAiB,GAAG,EAAE,EACtB,sBAAsB,EACtB,gBAAgB,GACjB,GAAG,eAAgB,CAAA;IAEpB,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAM,sBAAsB,CAAC,CAAA;IAE7D,MAAM,MAAM,CAAC,gBAAgB,CAAC,CAAC,iBAAiB,CAAC,CAAA;AACnD,CAAC,CACF,CAAA"}

package/dist/common/steps/dismiss-remote-links.d.ts

@@ -7,29 +7,14 @@ export declare const dismissRemoteLinkStepId = "dismiss-remote-links";
  * Learn more in the [Remote Link documentation.](https://docs.etohq.com/learn/fundamentals/module-links/remote-link#dismiss-link).
  *
  * @example
- * import {
- *   createWorkflow
- * } from "@etohq/framework/workflows-sdk"
- * import {
- *   dismissRemoteLinkStep
- * } from "@etohq/eto/commerce-flows"
- * import {
- *   Modules
- * } from "@etohq/framework/utils"
- *
- * const helloWorldWorkflow = createWorkflow(
- *   "hello-world",
- *   () => {
- *     dismissRemoteLinkStep([{
- *       [Modules.PRODUCT]: {
- *         product_id: "prod_123",
- *       },
- *       "helloModuleService": {
- *         my_custom_id: "mc_123",
- *       },
- *     }])
- *   }
- * )
+ * dismissRemoteLinkStep([{
+ *   [Modules.PRODUCT]: {
+ *     product_id: "prod_123",
+ *   },
+ *   "helloModuleService": {
+ *     my_custom_id: "mc_123",
+ *   },
+ * }])
  */
 export declare const dismissRemoteLinkStep: import("@etohq/framework/workflows-sdk").StepFunction<DismissRemoteLinksStepInput, LinkDefinition[]>;
 //# sourceMappingURL=dismiss-remote-links.d.ts.map

package/dist/common/steps/dismiss-remote-links.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dismiss-remote-links.d.ts","sourceRoot":"","sources":["../../../src/common/steps/dismiss-remote-links.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAKvD,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG,cAAc,EAAE,CAAA;AAG3E,eAAO,MAAM,uBAAuB,yBAAyB,CAAA;AAC7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,qBAAqB,sGA+BjC,CAAA"}
+{"version":3,"file":"dismiss-remote-links.d.ts","sourceRoot":"","sources":["../../../src/common/steps/dismiss-remote-links.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAKvD,MAAM,MAAM,2BAA2B,GAAG,cAAc,GAAG,cAAc,EAAE,CAAA;AAG3E,eAAO,MAAM,uBAAuB,yBAAyB,CAAA;AAC7D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB,sGA+BjC,CAAA"}

package/dist/common/steps/dismiss-remote-links.js

@@ -11,29 +11,14 @@ exports.dismissRemoteLinkStepId = "dismiss-remote-links";
  * Learn more in the [Remote Link documentation.](https://docs.etohq.com/learn/fundamentals/module-links/remote-link#dismiss-link).
  *
  * @example
- * import {
- *   createWorkflow
- * } from "@etohq/framework/workflows-sdk"
- * import {
- *   dismissRemoteLinkStep
- * } from "@etohq/eto/commerce-flows"
- * import {
- *   Modules
- * } from "@etohq/framework/utils"
- *
- * const helloWorldWorkflow = createWorkflow(
- *   "hello-world",
- *   () => {
- *     dismissRemoteLinkStep([{
- *       [Modules.PRODUCT]: {
- *         product_id: "prod_123",
- *       },
- *       "helloModuleService": {
- *         my_custom_id: "mc_123",
- *       },
- *     }])
- *   }
- * )
+ * dismissRemoteLinkStep([{
+ *   [Modules.PRODUCT]: {
+ *     product_id: "prod_123",
+ *   },
+ *   "helloModuleService": {
+ *     my_custom_id: "mc_123",
+ *   },
+ * }])
  */
 exports.dismissRemoteLinkStep = (0, workflows_sdk_1.createStep)(exports.dismissRemoteLinkStepId, async (data, { container }) => {
     const entries = Array.isArray(data) ? data : [data];

package/dist/common/steps/dismiss-remote-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"dismiss-remote-links.js","sourceRoot":"","sources":["../../../src/common/steps/dismiss-remote-links.ts"],"names":[],"mappings":";;;AAEA,kEAAyE;AAEzE,kDAAkE;AAIlE,0EAA0E;AAC7D,QAAA,uBAAuB,GAAG,sBAAsB,CAAA;AAC7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACU,QAAA,qBAAqB,GAAG,IAAA,0BAAU,EAC7C,+BAAuB,EACvB,KAAK,EAAE,IAAiC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACzD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAEnD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,IAAI,4BAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IAEpE,4EAA4E;IAC5E,+EAA+E;IAC/E,oFAAoF;IACpF,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QAC/C,gBAAgB,EAAE,IAAI;KACvB,CAAC,CAAqB,CAAA;IAEvB,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAE3B,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAA;AACrD,CAAC,EACD,KAAK,EAAE,iBAAiB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACzC,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IAEpE,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}
+{"version":3,"file":"dismiss-remote-links.js","sourceRoot":"","sources":["../../../src/common/steps/dismiss-remote-links.ts"],"names":[],"mappings":";;;AAEA,kEAAyE;AAEzE,kDAAkE;AAIlE,0EAA0E;AAC7D,QAAA,uBAAuB,GAAG,sBAAsB,CAAA;AAC7D;;;;;;;;;;;;;;GAcG;AACU,QAAA,qBAAqB,GAAG,IAAA,0BAAU,EAC7C,+BAAuB,EACvB,KAAK,EAAE,IAAiC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACzD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAEnD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,IAAI,4BAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;IACjC,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IAEpE,4EAA4E;IAC5E,+EAA+E;IAC/E,oFAAoF;IACpF,MAAM,iBAAiB,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;QAC/C,gBAAgB,EAAE,IAAI;KACvB,CAAC,CAAqB,CAAA;IAEvB,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IAE3B,OAAO,IAAI,4BAAY,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAA;AACrD,CAAC,EACD,KAAK,EAAE,iBAAiB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACzC,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IAED,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAO,iCAAyB,CAAC,IAAI,CAAC,CAAA;IAEpE,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAA;AACtC,CAAC,CACF,CAAA"}