@etohq/core-flows 1.4.0 → 1.5.0

package/dist/common/workflows/batch-links.js

@@ -8,6 +8,57 @@ const update_remote_links_1 = require("../steps/update-remote-links");
 exports.batchLinksWorkflowId = "batch-links";
 /**
  * This workflow manages one or more links to create, update, or dismiss them.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * manage links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await batchLinksWorkflow(container)
+ * .run({
+ *   input: {
+ *     create: [
+ *       {
+ *         // import { Modules } from "@etohq/framework/utils"
+ *         [Modules.PRODUCT]: {
+ *           product_id: "prod_123",
+ *         },
+ *         "helloModuleService": {
+ *           my_custom_id: "mc_123",
+ *         },
+ *       }
+ *     ],
+ *     update: [
+ *       {
+ *         // import { Modules } from "@etohq/framework/utils"
+ *         [Modules.PRODUCT]: {
+ *           product_id: "prod_321",
+ *         },
+ *         "helloModuleService": {
+ *           my_custom_id: "mc_321",
+ *         },
+ *         data: {
+ *           metadata: {
+ *             test: false
+ *           }
+ *         }
+ *       }
+ *     ],
+ *     delete: [
+ *       {
+ *         // import { Modules } from "@etohq/framework/utils"
+ *         [Modules.PRODUCT]: {
+ *           product_id: "prod_321",
+ *         },
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Manage links between two records of linked data models.
  */
 exports.batchLinksWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.batchLinksWorkflowId, (input) => {
     const [created, updated, deleted] = (0, workflows_sdk_1.parallelize)((0, create_remote_links_1.createRemoteLinkStep)(input.create || []), (0, update_remote_links_1.updateRemoteLinksStep)(input.update || []), (0, dismiss_remote_links_1.dismissRemoteLinkStep)(input.delete || []));

package/dist/common/workflows/batch-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch-links.js","sourceRoot":"","sources":["../../../src/common/workflows/batch-links.ts"],"names":[],"mappings":";;;AACA,kEAKuC;AACvC,sEAAmE;AACnE,wEAAqE;AACrE,sEAAoE;AAEvD,QAAA,oBAAoB,GAAG,aAAa,CAAA;AACjD;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAA,8BAAc,EAC9C,4BAAoB,EACpB,CACE,KAEC,EACD,EAAE;IACF,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,IAAA,2BAAW,EAC7C,IAAA,0CAAoB,EAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EACxC,IAAA,2CAAqB,EAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EACzC,IAAA,4CAAqB,EAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAC1C,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC;QAC1B,OAAO;QACP,OAAO;QACP,OAAO;KACR,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}
+{"version":3,"file":"batch-links.js","sourceRoot":"","sources":["../../../src/common/workflows/batch-links.ts"],"names":[],"mappings":";;;AACA,kEAKuC;AACvC,sEAAmE;AACnE,wEAAqE;AACrE,sEAAoE;AAEvD,QAAA,oBAAoB,GAAG,aAAa,CAAA;AACjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AACU,QAAA,kBAAkB,GAAG,IAAA,8BAAc,EAC9C,4BAAoB,EACpB,CACE,KAEC,EACD,EAAE;IACF,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,IAAA,2BAAW,EAC7C,IAAA,0CAAoB,EAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EACxC,IAAA,2CAAqB,EAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,EACzC,IAAA,4CAAqB,EAAC,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC,CAC1C,CAAA;IAED,OAAO,IAAI,gCAAgB,CAAC;QAC1B,OAAO;QACP,OAAO;QACP,OAAO;KACR,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}

package/dist/common/workflows/create-links.d.ts

@@ -2,6 +2,31 @@ import { LinkDefinition } from "@etohq/framework/types";
 export declare const createLinksWorkflowId = "create-link";
 /**
  * This workflow creates one or more links between records.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * create links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await createLinksWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       // import { Modules } from "@etohq/framework/utils"
+ *       [Modules.PRODUCT]: {
+ *         product_id: "prod_123",
+ *       },
+ *       "helloModuleService": {
+ *         my_custom_id: "mc_123",
+ *       },
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Create links between two records of linked data models.
  */
 export declare const createLinksWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<LinkDefinition[], LinkDefinition[], []>;
 //# sourceMappingURL=create-links.d.ts.map

package/dist/common/workflows/create-links.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-links.d.ts","sourceRoot":"","sources":["../../../src/common/workflows/create-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAQvD,eAAO,MAAM,qBAAqB,gBAAgB,CAAA;AAClD;;GAEG;AACH,eAAO,MAAM,mBAAmB,iGAK/B,CAAA"}
+{"version":3,"file":"create-links.d.ts","sourceRoot":"","sources":["../../../src/common/workflows/create-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAQvD,eAAO,MAAM,qBAAqB,gBAAgB,CAAA;AAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,mBAAmB,iGAK/B,CAAA"}

package/dist/common/workflows/create-links.js

@@ -6,6 +6,31 @@ const create_remote_links_1 = require("../steps/create-remote-links");
 exports.createLinksWorkflowId = "create-link";
 /**
  * This workflow creates one or more links between records.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * create links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await createLinksWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       // import { Modules } from "@etohq/framework/utils"
+ *       [Modules.PRODUCT]: {
+ *         product_id: "prod_123",
+ *       },
+ *       "helloModuleService": {
+ *         my_custom_id: "mc_123",
+ *       },
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Create links between two records of linked data models.
  */
 exports.createLinksWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.createLinksWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, create_remote_links_1.createRemoteLinkStep)(input));

package/dist/common/workflows/create-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-links.js","sourceRoot":"","sources":["../../../src/common/workflows/create-links.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,sEAAmE;AAEtD,QAAA,qBAAqB,GAAG,aAAa,CAAA;AAClD;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CAAC,KAAqC,EAAE,EAAE;IACxC,OAAO,IAAI,gCAAgB,CAAC,IAAA,0CAAoB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC1D,CAAC,CACF,CAAA"}
+{"version":3,"file":"create-links.js","sourceRoot":"","sources":["../../../src/common/workflows/create-links.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,sEAAmE;AAEtD,QAAA,qBAAqB,GAAG,aAAa,CAAA;AAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CAAC,KAAqC,EAAE,EAAE;IACxC,OAAO,IAAI,gCAAgB,CAAC,IAAA,0CAAoB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC1D,CAAC,CACF,CAAA"}

package/dist/common/workflows/dismiss-links.d.ts

@@ -2,6 +2,31 @@ import { LinkDefinition } from "@etohq/framework/types";
 export declare const dismissLinksWorkflowId = "dismiss-link";
 /**
  * This workflow dismisses one or more links between records.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * dismiss links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await dismissLinksWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       // import { Modules } from "@etohq/framework/utils"
+ *       [Modules.PRODUCT]: {
+ *         product_id: "prod_123",
+ *       },
+ *       "helloModuleService": {
+ *         my_custom_id: "mc_123",
+ *       },
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Dismiss links between two records of linked data models.
  */
 export declare const dismissLinksWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<LinkDefinition[], LinkDefinition[], []>;
 //# sourceMappingURL=dismiss-links.d.ts.map

package/dist/common/workflows/dismiss-links.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dismiss-links.d.ts","sourceRoot":"","sources":["../../../src/common/workflows/dismiss-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAQvD,eAAO,MAAM,sBAAsB,iBAAiB,CAAA;AACpD;;GAEG;AACH,eAAO,MAAM,oBAAoB,iGAKhC,CAAA"}
+{"version":3,"file":"dismiss-links.d.ts","sourceRoot":"","sources":["../../../src/common/workflows/dismiss-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAQvD,eAAO,MAAM,sBAAsB,iBAAiB,CAAA;AACpD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,oBAAoB,iGAKhC,CAAA"}

package/dist/common/workflows/dismiss-links.js

@@ -6,6 +6,31 @@ const dismiss_remote_links_1 = require("../steps/dismiss-remote-links");
 exports.dismissLinksWorkflowId = "dismiss-link";
 /**
  * This workflow dismisses one or more links between records.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * dismiss links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await dismissLinksWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       // import { Modules } from "@etohq/framework/utils"
+ *       [Modules.PRODUCT]: {
+ *         product_id: "prod_123",
+ *       },
+ *       "helloModuleService": {
+ *         my_custom_id: "mc_123",
+ *       },
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Dismiss links between two records of linked data models.
  */
 exports.dismissLinksWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.dismissLinksWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, dismiss_remote_links_1.dismissRemoteLinkStep)(input));

package/dist/common/workflows/dismiss-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"dismiss-links.js","sourceRoot":"","sources":["../../../src/common/workflows/dismiss-links.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,wEAAqE;AAExD,QAAA,sBAAsB,GAAG,cAAc,CAAA;AACpD;;GAEG;AACU,QAAA,oBAAoB,GAAG,IAAA,8BAAc,EAChD,8BAAsB,EACtB,CAAC,KAAqC,EAAE,EAAE;IACxC,OAAO,IAAI,gCAAgB,CAAC,IAAA,4CAAqB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC3D,CAAC,CACF,CAAA"}
+{"version":3,"file":"dismiss-links.js","sourceRoot":"","sources":["../../../src/common/workflows/dismiss-links.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,wEAAqE;AAExD,QAAA,sBAAsB,GAAG,cAAc,CAAA;AACpD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACU,QAAA,oBAAoB,GAAG,IAAA,8BAAc,EAChD,8BAAsB,EACtB,CAAC,KAAqC,EAAE,EAAE;IACxC,OAAO,IAAI,gCAAgB,CAAC,IAAA,4CAAqB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC3D,CAAC,CACF,CAAA"}

package/dist/common/workflows/update-links.d.ts

@@ -2,6 +2,36 @@ import { LinkDefinition } from "@etohq/framework/types";
 export declare const updateLinksWorkflowId = "update-link";
 /**
  * This workflow updates one or more links between records.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * update links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await updateLinksWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       // import { Modules } from "@etohq/framework/utils"
+ *       [Modules.PRODUCT]: {
+ *         product_id: "prod_123",
+ *       },
+ *       "helloModuleService": {
+ *         my_custom_id: "mc_123",
+ *       },
+ *       data: {
+ *         metadata: {
+ *           test: false,
+ *         },
+ *       }
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Update links between two records of linked data models.
  */
 export declare const updateLinksWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<LinkDefinition[], LinkDefinition[], []>;
 //# sourceMappingURL=update-links.d.ts.map

package/dist/common/workflows/update-links.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update-links.d.ts","sourceRoot":"","sources":["../../../src/common/workflows/update-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAQvD,eAAO,MAAM,qBAAqB,gBAAgB,CAAA;AAClD;;GAEG;AACH,eAAO,MAAM,mBAAmB,iGAK/B,CAAA"}
+{"version":3,"file":"update-links.d.ts","sourceRoot":"","sources":["../../../src/common/workflows/update-links.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAQvD,eAAO,MAAM,qBAAqB,gBAAgB,CAAA;AAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,mBAAmB,iGAK/B,CAAA"}

package/dist/common/workflows/update-links.js

@@ -6,6 +6,36 @@ const update_remote_links_1 = require("../steps/update-remote-links");
 exports.updateLinksWorkflowId = "update-link";
 /**
  * This workflow updates one or more links between records.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * update links within your custom flows.
+ *
+ * Learn more about links in [this documentation](https://docs.etohq.com/learn/fundamentals/module-links/link).
+ *
+ * @example
+ * const { result } = await updateLinksWorkflow(container)
+ * .run({
+ *   input: [
+ *     {
+ *       // import { Modules } from "@etohq/framework/utils"
+ *       [Modules.PRODUCT]: {
+ *         product_id: "prod_123",
+ *       },
+ *       "helloModuleService": {
+ *         my_custom_id: "mc_123",
+ *       },
+ *       data: {
+ *         metadata: {
+ *           test: false,
+ *         },
+ *       }
+ *     }
+ *   ]
+ * })
+ *
+ * @summary
+ *
+ * Update links between two records of linked data models.
  */
 exports.updateLinksWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.updateLinksWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, update_remote_links_1.updateRemoteLinksStep)(input));

package/dist/common/workflows/update-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"update-links.js","sourceRoot":"","sources":["../../../src/common/workflows/update-links.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,sEAAoE;AAEvD,QAAA,qBAAqB,GAAG,aAAa,CAAA;AAClD;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CAAC,KAAqC,EAAE,EAAE;IACxC,OAAO,IAAI,gCAAgB,CAAC,IAAA,2CAAqB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC3D,CAAC,CACF,CAAA"}
+{"version":3,"file":"update-links.js","sourceRoot":"","sources":["../../../src/common/workflows/update-links.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,sEAAoE;AAEvD,QAAA,qBAAqB,GAAG,aAAa,CAAA;AAClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CAAC,KAAqC,EAAE,EAAE;IACxC,OAAO,IAAI,gCAAgB,CAAC,IAAA,2CAAqB,EAAC,KAAK,CAAC,CAAC,CAAA;AAC3D,CAAC,CACF,CAAA"}

package/dist/file/steps/delete-files.d.ts

@@ -1,6 +1,17 @@
+/**
+ * The IDs of the files to delete.
+ */
+export type DeleteFilesStepInput = string[];
 export declare const deleteFilesStepId = "delete-files";
 /**
- * This step deletes one or more files.
+ * This step deletes one or more files using the installed
+ * [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file). The files
+ * will be removed from the database and the storage.
+ *
+ * @example
+ * const data = deleteFilesStep([
+ *   "id_123"
+ * ])
  */
-export declare const deleteFilesStep: import("@etohq/framework/workflows-sdk").StepFunction<string[], undefined>;
+export declare const deleteFilesStep: import("@etohq/framework/workflows-sdk").StepFunction<DeleteFilesStepInput, undefined>;
 //# sourceMappingURL=delete-files.d.ts.map

package/dist/file/steps/delete-files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-files.d.ts","sourceRoot":"","sources":["../../../src/file/steps/delete-files.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C;;GAEG;AACH,eAAO,MAAM,eAAe,4EAS3B,CAAA"}
+{"version":3,"file":"delete-files.d.ts","sourceRoot":"","sources":["../../../src/file/steps/delete-files.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,EAAE,CAAA;AAE3C,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe,wFAS3B,CAAA"}

package/dist/file/steps/delete-files.js

@@ -5,7 +5,14 @@ const utils_1 = require("@etohq/framework/utils");
 const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.deleteFilesStepId = "delete-files";
 /**
- * This step deletes one or more files.
+ * This step deletes one or more files using the installed
+ * [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file). The files
+ * will be removed from the database and the storage.
+ *
+ * @example
+ * const data = deleteFilesStep([
+ *   "id_123"
+ * ])
  */
 exports.deleteFilesStep = (0, workflows_sdk_1.createStep)({ name: exports.deleteFilesStepId, noCompensation: true }, async (ids, { container }) => {
     const service = container.resolve(utils_1.Modules.FILE);

package/dist/file/steps/delete-files.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-files.js","sourceRoot":"","sources":["../../../src/file/steps/delete-files.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAE5D,QAAA,iBAAiB,GAAG,cAAc,CAAA;AAC/C;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,EAAE,IAAI,EAAE,yBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,EACjD,KAAK,EAAE,GAAa,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACrC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9B,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf,CAAA"}
+{"version":3,"file":"delete-files.js","sourceRoot":"","sources":["../../../src/file/steps/delete-files.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAO5D,QAAA,iBAAiB,GAAG,cAAc,CAAA;AAC/C;;;;;;;;;GASG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,EAAE,IAAI,EAAE,yBAAiB,EAAE,cAAc,EAAE,IAAI,EAAE,EACjD,KAAK,EAAE,GAAyB,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IACjD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9B,OAAO,IAAI,4BAAY,CAAC,KAAK,CAAC,CAAC,CAAA;AACjC,CAAC,EACD,KAAK,IAAI,EAAE,GAAE,CAAC,CACf,CAAA"}

package/dist/file/steps/upload-files.d.ts

@@ -1,14 +1,53 @@
+/**
+ * The data to upload files.
+ */
 export type UploadFilesStepInput = {
+    /**
+     * The files to upload.
+     */
     files: {
+        /**
+         * The name of the file.
+         */
         filename: string;
+        /**
+         * The MIME type of the file.
+         *
+         * @example
+         * img/jpg
+         */
         mimeType: string;
+        /**
+         * The content of the file. For images, for example,
+         * use binary string. For CSV files, use the CSV content.
+         */
         content: string;
+        /**
+         * The access level of the file. Use `public` for the file that
+         * can be accessed by anyone. For example, for images that are displayed
+         * on the storefront. Use `private` for files that are only accessible
+         * by authenticated users. For example, for CSV files used to
+         * import data.
+         */
         access: "public" | "private";
     }[];
 };
 export declare const uploadFilesStepId = "upload-files";
 /**
- * This step uploads one or more files.
+ * This step uploads one or more files using the installed
+ * [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file).
+ *
+ * @example
+ * const data = uploadFilesStep({
+ *   files: [
+ *     {
+ *       filename: "test.jpg",
+ *       mimeType: "img/jpg",
+ *       content: "binary-string",
+ *       access: "public"
+ *     }
+ *   ]
+ * })
  */
 export declare const uploadFilesStep: import("@etohq/framework/workflows-sdk").StepFunction<UploadFilesStepInput, import("@etohq/framework/types").FileDTO[]>;
 //# sourceMappingURL=upload-files.d.ts.map

package/dist/file/steps/upload-files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/file/steps/upload-files.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;KAC7B,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C;;GAEG;AACH,eAAO,MAAM,eAAe,yHAmB3B,CAAA"}
+{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/file/steps/upload-files.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;;;WAKG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;;;;WAMG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;KAC7B,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,iBAAiB,iBAAiB,CAAA;AAC/C;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,eAAe,yHAmB3B,CAAA"}

package/dist/file/steps/upload-files.js

@@ -5,7 +5,20 @@ const utils_1 = require("@etohq/framework/utils");
 const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 exports.uploadFilesStepId = "upload-files";
 /**
- * This step uploads one or more files.
+ * This step uploads one or more files using the installed
+ * [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file).
+ *
+ * @example
+ * const data = uploadFilesStep({
+ *   files: [
+ *     {
+ *       filename: "test.jpg",
+ *       mimeType: "img/jpg",
+ *       content: "binary-string",
+ *       access: "public"
+ *     }
+ *   ]
+ * })
  */
 exports.uploadFilesStep = (0, workflows_sdk_1.createStep)(exports.uploadFilesStepId, async (data, { container }) => {
     const service = container.resolve(utils_1.Modules.FILE);

package/dist/file/steps/upload-files.js.map

@@ -1 +1 @@
-{"version":3,"file":"upload-files.js","sourceRoot":"","sources":["../../../src/file/steps/upload-files.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAW5D,QAAA,iBAAiB,GAAG,cAAc,CAAA;AAC/C;;GAEG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,IAA0B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IACnE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrD,OAAO,IAAI,4BAAY,CACrB,OAAO,EACP,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAC/B,CAAA;AACH,CAAC,EACD,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;AACvC,CAAC,CACF,CAAA"}
+{"version":3,"file":"upload-files.js","sourceRoot":"","sources":["../../../src/file/steps/upload-files.ts"],"names":[],"mappings":";;;AACA,kDAAgD;AAChD,kEAAyE;AAqC5D,QAAA,iBAAiB,GAAG,cAAc,CAAA;AAC/C;;;;;;;;;;;;;;;GAeG;AACU,QAAA,eAAe,GAAG,IAAA,0BAAU,EACvC,yBAAiB,EACjB,KAAK,EAAE,IAA0B,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClD,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IACnE,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrD,OAAO,IAAI,4BAAY,CACrB,OAAO,EACP,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAC/B,CAAA;AACH,CAAC,EACD,KAAK,EAAE,UAAU,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;IAClC,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACxB,OAAM;IACR,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAqB,eAAO,CAAC,IAAI,CAAC,CAAA;IAEnE,MAAM,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;AACvC,CAAC,CACF,CAAA"}

package/dist/file/workflows/delete-files.d.ts

@@ -3,7 +3,26 @@ export type DeleteFilesWorkflowInput = {
 };
 export declare const deleteFilesWorkflowId = "delete-files";
 /**
- * This workflow deletes one or more files.
+ * This workflow deletes one or more files. It's used by the
+ * [Delete File Upload Admin API Route](https://docs.etohq.com/api/admin#uploads_deleteuploadsid).
+ *
+ * The [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file) installed
+ * in your application will be used to delete the file from storage.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * delete files within your custom flows.
+ *
+ * @example
+ * const { result } = await deleteFilesWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete files from the database and storage.
  */
 export declare const deleteFilesWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<DeleteFilesWorkflowInput, unknown, any[]>;
 //# sourceMappingURL=delete-files.d.ts.map

package/dist/file/workflows/delete-files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-files.d.ts","sourceRoot":"","sources":["../../../src/file/workflows/delete-files.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,wBAAwB,GAAG;IAAE,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAExD,eAAO,MAAM,qBAAqB,iBAAiB,CAAA;AACnD;;GAEG;AACH,eAAO,MAAM,mBAAmB,mGAK/B,CAAA"}
+{"version":3,"file":"delete-files.d.ts","sourceRoot":"","sources":["../../../src/file/workflows/delete-files.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,wBAAwB,GAAG;IAAE,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,CAAA;AAExD,eAAO,MAAM,qBAAqB,iBAAiB,CAAA;AACnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,mBAAmB,mGAK/B,CAAA"}

package/dist/file/workflows/delete-files.js

@@ -5,7 +5,26 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.deleteFilesWorkflowId = "delete-files";
 /**
- * This workflow deletes one or more files.
+ * This workflow deletes one or more files. It's used by the
+ * [Delete File Upload Admin API Route](https://docs.etohq.com/api/admin#uploads_deleteuploadsid).
+ *
+ * The [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file) installed
+ * in your application will be used to delete the file from storage.
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * delete files within your custom flows.
+ *
+ * @example
+ * const { result } = await deleteFilesWorkflow(container)
+ * .run({
+ *   input: {
+ *     ids: ["123"]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Delete files from the database and storage.
  */
 exports.deleteFilesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.deleteFilesWorkflowId, (input) => {
     (0, steps_1.deleteFilesStep)(input.ids);

package/dist/file/workflows/delete-files.js.map

@@ -1 +1 @@
-{"version":3,"file":"delete-files.js","sourceRoot":"","sources":["../../../src/file/workflows/delete-files.ts"],"names":[],"mappings":";;;AAAA,kEAA6E;AAC7E,oCAA0C;AAI7B,QAAA,qBAAqB,GAAG,cAAc,CAAA;AACnD;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CAAC,KAA6C,EAAsB,EAAE;IACpE,IAAA,uBAAe,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAC5B,CAAC,CACF,CAAA"}
+{"version":3,"file":"delete-files.js","sourceRoot":"","sources":["../../../src/file/workflows/delete-files.ts"],"names":[],"mappings":";;;AAAA,kEAA6E;AAC7E,oCAA0C;AAI7B,QAAA,qBAAqB,GAAG,cAAc,CAAA;AACnD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CAAC,KAA6C,EAAsB,EAAE;IACpE,IAAA,uBAAe,EAAC,KAAK,CAAC,GAAG,CAAC,CAAA;AAC5B,CAAC,CACF,CAAA"}

package/dist/file/workflows/upload-files.d.ts

@@ -1,15 +1,65 @@
 import { FileDTO } from "@etohq/framework/types";
+/**
+ * The data to upload files.
+ */
 export type UploadFilesWorkflowInput = {
+    /**
+     * The files to upload.
+     */
     files: {
+        /**
+         * The name of the file.
+         */
         filename: string;
+        /**
+         * The MIME type of the file.
+         *
+         * @example
+         * img/jpg
+         */
         mimeType: string;
+        /**
+         * The content of the file. For images, for example,
+         * use binary string. For CSV files, use the CSV content.
+         */
         content: string;
+        /**
+         * The access level of the file. Use `public` for the file that
+         * can be accessed by anyone. For example, for images that are displayed
+         * on the storefront. Use `private` for files that are only accessible
+         * by authenticated users. For example, for CSV files used to
+         * import data.
+         */
         access: "public" | "private";
     }[];
 };
 export declare const uploadFilesWorkflowId = "upload-files";
 /**
- * This workflow uploads one or more files.
+ * This workflow uploads one or more files using the installed
+ * [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file). The workflow is used by the
+ * [Upload Files Admin API Route](https://docs.etohq.com/api/admin#uploads_postuploads).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * upload files within your custom flows.
+ *
+ * @example
+ * const { result } = await uploadFilesWorkflow(container)
+ * .run({
+ *   input: {
+ *     files: [
+ *       {
+ *         filename: "test.jpg",
+ *         mimeType: "img/jpg",
+ *         content: "binary-string",
+ *         access: "public"
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Upload files using the installed File Module Provider.
  */
 export declare const uploadFilesWorkflow: import("@etohq/framework/workflows-sdk").ReturnWorkflow<UploadFilesWorkflowInput, FileDTO[], []>;
 //# sourceMappingURL=upload-files.d.ts.map

package/dist/file/workflows/upload-files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/file/workflows/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAQhD,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE;QACL,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;KAC7B,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,qBAAqB,iBAAiB,CAAA;AACnD;;GAEG;AACH,eAAO,MAAM,mBAAmB,kGAO/B,CAAA"}
+{"version":3,"file":"upload-files.d.ts","sourceRoot":"","sources":["../../../src/file/workflows/upload-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAQhD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;;;WAKG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;;;;WAMG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;KAC7B,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,qBAAqB,iBAAiB,CAAA;AACnD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,mBAAmB,kGAO/B,CAAA"}

package/dist/file/workflows/upload-files.js

@@ -5,7 +5,31 @@ const workflows_sdk_1 = require("@etohq/framework/workflows-sdk");
 const steps_1 = require("../steps");
 exports.uploadFilesWorkflowId = "upload-files";
 /**
- * This workflow uploads one or more files.
+ * This workflow uploads one or more files using the installed
+ * [File Module Provider](https://docs.etohq.com/resources/infrastructure-modules/file). The workflow is used by the
+ * [Upload Files Admin API Route](https://docs.etohq.com/api/admin#uploads_postuploads).
+ *
+ * You can use this workflow within your customizations or your own custom workflows, allowing you to
+ * upload files within your custom flows.
+ *
+ * @example
+ * const { result } = await uploadFilesWorkflow(container)
+ * .run({
+ *   input: {
+ *     files: [
+ *       {
+ *         filename: "test.jpg",
+ *         mimeType: "img/jpg",
+ *         content: "binary-string",
+ *         access: "public"
+ *       }
+ *     ]
+ *   }
+ * })
+ *
+ * @summary
+ *
+ * Upload files using the installed File Module Provider.
  */
 exports.uploadFilesWorkflow = (0, workflows_sdk_1.createWorkflow)(exports.uploadFilesWorkflowId, (input) => {
     return new workflows_sdk_1.WorkflowResponse((0, steps_1.uploadFilesStep)(input));

package/dist/file/workflows/upload-files.js.map

@@ -1 +1 @@
-{"version":3,"file":"upload-files.js","sourceRoot":"","sources":["../../../src/file/workflows/upload-files.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,oCAA0C;AAW7B,QAAA,qBAAqB,GAAG,cAAc,CAAA;AACnD;;GAEG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAA6C,EAChB,EAAE;IAC/B,OAAO,IAAI,gCAAgB,CAAC,IAAA,uBAAe,EAAC,KAAK,CAAC,CAAC,CAAA;AACrD,CAAC,CACF,CAAA"}
+{"version":3,"file":"upload-files.js","sourceRoot":"","sources":["../../../src/file/workflows/upload-files.ts"],"names":[],"mappings":";;;AACA,kEAIuC;AACvC,oCAA0C;AAqC7B,QAAA,qBAAqB,GAAG,cAAc,CAAA;AACnD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACU,QAAA,mBAAmB,GAAG,IAAA,8BAAc,EAC/C,6BAAqB,EACrB,CACE,KAA6C,EAChB,EAAE;IAC/B,OAAO,IAAI,gCAAgB,CAAC,IAAA,uBAAe,EAAC,KAAK,CAAC,CAAC,CAAA;AACrD,CAAC,CACF,CAAA"}

package/dist/invite/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./steps";
+export * from "./workflows";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/invite/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA"}