@medusajs/core-flows 2.11.4-snapshot-20251125104603 → 2.11.4-snapshot-20251127111307

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -20,6 +20,8 @@ type Input = {
20
20
  * The data payload that the subscriber receives in the `data` property
21
21
  * of its first parameter. Use this property to pass data relevant for the
22
22
  * subscriber, such as the ID of a created record.
23
+ *
24
+ * If you pass an array of objects, the event will be emitted once per each object in the array.
23
25
  */
24
26
  data: ((context: StepExecutionContext) => Promise<Record<any, any>>) | Record<any, any>;
25
27
  };
@@ -32,12 +34,30 @@ export declare const emitEventStepId = "emit-event-step";
32
34
  * If the workflow fails, it won't emit the event at all.
33
35
  *
34
36
  * @example
37
+ * To emit a single event with a data payload:
38
+ *
39
+ * ```ts
35
40
  * emitEventStep({
36
41
  * eventName: "custom.created",
37
42
  * data: {
38
43
  * id: "123"
39
44
  * }
40
45
  * })
46
+ * ```
47
+ *
48
+ * To emit an event multiple times with different data payloads, pass an array of objects to the `data` property:
49
+ *
50
+ * ```ts
51
+ * emitEventStep({
52
+ * eventName: "custom.created",
53
+ * data: [
54
+ * // emit will be emitted three times, once per each object in the array
55
+ * { id: "123" },
56
+ * { id: "456" },
57
+ * { id: "789" }
58
+ * ]
59
+ * })
60
+ * ```
41
61
  */
42
62
  export declare const emitEventStep: import("@medusajs/framework/workflows-sdk").StepFunction<Input, {
43
63
  eventGroupId: string | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"emit-event.d.ts","sourceRoot":"","sources":["../../../src/common/steps/emit-event.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,oBAAoB,EAGrB,MAAM,mCAAmC,CAAA;AAE1C;;GAEG;AACH,KAAK,KAAK,GAAG;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC9B;;;;OAIG;IACH,IAAI,EACA,CAAC,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,GAC9D,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,eAAe,oBAAoB,CAAA;AAEhD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa;;;EA0DzB,CAAA"}
1
+ {"version":3,"file":"emit-event.d.ts","sourceRoot":"","sources":["../../../src/common/steps/emit-event.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,oBAAoB,EAGrB,MAAM,mCAAmC,CAAA;AAE1C;;GAEG;AACH,KAAK,KAAK,GAAG;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC9B;;;;;;OAMG;IACH,IAAI,EACA,CAAC,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,GAC9D,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,eAAe,oBAAoB,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,aAAa;;;EA0DzB,CAAA"}
@@ -12,12 +12,30 @@ exports.emitEventStepId = "emit-event-step";
12
12
  * If the workflow fails, it won't emit the event at all.
13
13
  *
14
14
  * @example
15
+ * To emit a single event with a data payload:
16
+ *
17
+ * ```ts
15
18
  * emitEventStep({
16
19
  * eventName: "custom.created",
17
20
  * data: {
18
21
  * id: "123"
19
22
  * }
20
23
  * })
24
+ * ```
25
+ *
26
+ * To emit an event multiple times with different data payloads, pass an array of objects to the `data` property:
27
+ *
28
+ * ```ts
29
+ * emitEventStep({
30
+ * eventName: "custom.created",
31
+ * data: [
32
+ * // emit will be emitted three times, once per each object in the array
33
+ * { id: "123" },
34
+ * { id: "456" },
35
+ * { id: "789" }
36
+ * ]
37
+ * })
38
+ * ```
21
39
  */
22
40
  exports.emitEventStep = (0, workflows_sdk_1.createStep)(exports.emitEventStepId, async (input, context) => {
23
41
  if (!input?.data) {
@@ -1 +1 @@
1
- {"version":3,"file":"emit-event.js","sourceRoot":"","sources":["../../../src/common/steps/emit-event.ts"],"names":[],"mappings":";;;AAIA,qDAAmD;AACnD,qEAI0C;AA6B7B,QAAA,eAAe,GAAG,iBAAiB,CAAA;AAEhD;;;;;;;;;;;;;;GAcG;AACU,QAAA,aAAa,GAAG,IAAA,0BAAU,EACrC,uBAAe,EACf,KAAK,EAAE,KAAY,EAAE,OAAO,EAAE,EAAE;IAC9B,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;QACjB,OAAM;IACR,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IAE7B,MAAM,QAAQ,GAA2B,SAAS,CAAC,OAAO,CACxD,eAAO,CAAC,SAAS,CAClB,CAAA;IAED,MAAM,KAAK,GACT,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAA;IAE3E,MAAM,QAAQ,GAAoC;QAChD,GAAG,KAAK,CAAC,QAAQ;KAClB,CAAA;IAED,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,QAAQ,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAA;IAC9C,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IACxD,MAAM,OAAO,GAA4B,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9D,IAAI,EAAE,KAAK,CAAC,SAAS;QACrB,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,QAAQ;KACT,CAAC,CAAC,CAAA;IAEH,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAM;IACR,CAAC;IAED,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAE5B,OAAO,IAAI,4BAAY,CAAC;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;IACtB,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACjC,OAAM;IACR,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IAE7B,MAAM,QAAQ,GAA2B,SAAS,CAAC,OAAO,CACxD,eAAO,CAAC,SAAS,CAClB,CAAA;IAED,MAAM,QAAQ,CAAC,kBAAkB,CAAC,IAAK,CAAC,YAAY,EAAE;QACpD,UAAU,EAAE,CAAC,IAAK,CAAC,SAAS,CAAC;KAC9B,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}
1
+ {"version":3,"file":"emit-event.js","sourceRoot":"","sources":["../../../src/common/steps/emit-event.ts"],"names":[],"mappings":";;;AAIA,qDAAmD;AACnD,qEAI0C;AA+B7B,QAAA,eAAe,GAAG,iBAAiB,CAAA;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACU,QAAA,aAAa,GAAG,IAAA,0BAAU,EACrC,uBAAe,EACf,KAAK,EAAE,KAAY,EAAE,OAAO,EAAE,EAAE;IAC9B,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC;QACjB,OAAM;IACR,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IAE7B,MAAM,QAAQ,GAA2B,SAAS,CAAC,OAAO,CACxD,eAAO,CAAC,SAAS,CAClB,CAAA;IAED,MAAM,KAAK,GACT,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAA;IAE3E,MAAM,QAAQ,GAAoC;QAChD,GAAG,KAAK,CAAC,QAAQ;KAClB,CAAA;IAED,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,QAAQ,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAA;IAC9C,CAAC;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;IACxD,MAAM,OAAO,GAA4B,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9D,IAAI,EAAE,KAAK,CAAC,SAAS;QACrB,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,QAAQ;KACT,CAAC,CAAC,CAAA;IAEH,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAM;IACR,CAAC;IAED,MAAM,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAE5B,OAAO,IAAI,4BAAY,CAAC;QACtB,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC,CAAA;AACJ,CAAC,EACD,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;IACtB,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,CAAC;QACjC,OAAM;IACR,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;IAE7B,MAAM,QAAQ,GAA2B,SAAS,CAAC,OAAO,CACxD,eAAO,CAAC,SAAS,CAClB,CAAA;IAED,MAAM,QAAQ,CAAC,kBAAkB,CAAC,IAAK,CAAC,YAAY,EAAE;QACpD,UAAU,EAAE,CAAC,IAAK,CAAC,SAAS,CAAC;KAC9B,CAAC,CAAA;AACJ,CAAC,CACF,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medusajs/core-flows",
3
- "version": "2.11.4-snapshot-20251125104603",
3
+ "version": "2.11.4-snapshot-20251127111307",
4
4
  "description": "Set of workflow definitions for Medusa",
5
5
  "main": "dist/index.js",
6
6
  "exports": {
@@ -26,7 +26,7 @@
26
26
  "author": "Medusa",
27
27
  "license": "MIT",
28
28
  "devDependencies": {
29
- "@medusajs/framework": "2.11.4-snapshot-20251125104603"
29
+ "@medusajs/framework": "2.11.4-snapshot-20251127111307"
30
30
  },
31
31
  "dependencies": {
32
32
  "csv-parse": "^5.6.0",
@@ -34,7 +34,7 @@
34
34
  "zod": "3.25.76"
35
35
  },
36
36
  "peerDependencies": {
37
- "@medusajs/framework": "2.11.4-snapshot-20251125104603"
37
+ "@medusajs/framework": "2.11.4-snapshot-20251127111307"
38
38
  },
39
39
  "scripts": {
40
40
  "build": "yarn run -T rimraf dist && yarn run -T tsc --build",