@flowrunner/cli 0.1.9 → 0.1.10

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.
Files changed (70) hide show
  1. package/README.md +8 -8
  2. package/ai-docs/instructions/service-code-format/01-service-structure.md +3 -2
  3. package/ai-docs/instructions/service-code-format/02-zod-types.md +8 -0
  4. package/ai-docs/instructions/service-code-format/03-parameters.md +181 -10
  5. package/ai-docs/instructions/service-code-format/04-http-requests.md +2 -2
  6. package/ai-docs/instructions/service-code-format/05-dictionaries.md +14 -0
  7. package/ai-docs/instructions/service-code-format/07-actions.md +5 -4
  8. package/ai-docs/instructions/service-code-format/11-output-model.md +42 -6
  9. package/ai-docs/instructions/service-code-format/12-service-readme.md +1 -1
  10. package/ai-docs/instructions/service-code-format/13-runtime-contracts.md +4 -1
  11. package/ai-docs/instructions/service-code-format/15-unit-tests.md +2 -1
  12. package/ai-docs/instructions/service-code-format/16-gotchas.md +39 -1
  13. package/ai-docs/instructions/service-code-format/README.md +1 -1
  14. package/ai-docs/providers/claude/agents/flowrunner-service-test-engineer.md +1 -1
  15. package/dist/cli.js +276 -42
  16. package/dist/cli.js.map +3 -3
  17. package/dist/index.js +275 -41
  18. package/dist/index.js.map +3 -3
  19. package/dist/types/flow-extension-runner/src/v2/actions/action-method.d.ts +13 -9
  20. package/dist/types/flow-extension-runner/src/v2/loaders/loader-method.d.ts +52 -7
  21. package/dist/types/flow-extension-runner/src/v2/loaders/loader-owner.d.ts +4 -6
  22. package/dist/types/flow-extension-runner/src/v2/model/model-types.d.ts +2 -0
  23. package/dist/types/flow-extension-runner/src/v2/params/index.d.ts +2 -2
  24. package/dist/types/flow-extension-runner/src/v2/params/json/encode.d.ts +10 -2
  25. package/dist/types/flow-extension-runner/src/v2/params/json/types.d.ts +1 -0
  26. package/dist/types/flow-extension-runner/src/v2/params/zod.d.ts +29 -0
  27. package/dist/types/flow-extension-runner/src/v2/types.d.ts +20 -8
  28. package/dist/types/shared/src/constants/activity-log.d.ts +1496 -0
  29. package/dist/types/shared/src/constants/docs.d.ts +2 -0
  30. package/dist/types/shared/src/constants/notification-types.d.ts +9 -3
  31. package/dist/types/shared/src/scheme/activity-log-base.d.ts +35 -0
  32. package/dist/types/shared/src/scheme/data-types/java.dto.d.ts +2 -3
  33. package/dist/types/shared/src/scheme/flowrunner/custom-elements.d.ts +20 -0
  34. package/dist/types/shared/src/scheme/flowrunner/java.dto.d.ts +1 -0
  35. package/dist/types/shared/src/scheme/shared-extensions/base.d.ts +5 -0
  36. package/dist/types/shared/src/scheme/shared-extensions/custom-extensions.d.ts +147 -0
  37. package/dist/types/shared/src/scheme/shared-extensions/extension.d.ts +20 -0
  38. package/dist/types/shared/src/scheme/shared-extensions/methods.d.ts +33 -1
  39. package/dist/types/shared/src/scheme/shared-extensions/params-schema.d.ts +1 -0
  40. package/dist/types/shared/src/scheme/shared-extensions/resolve.d.ts +15 -0
  41. package/dist/types/shared/src/scheme/shared-extensions/search.d.ts +10 -0
  42. package/package.json +1 -1
  43. package/runtime/index.js +275 -41
  44. package/runtime/index.js.map +3 -3
  45. package/runtime/types/flow-extension-runner/src/v2/actions/action-method.d.ts +13 -9
  46. package/runtime/types/flow-extension-runner/src/v2/loaders/loader-method.d.ts +52 -7
  47. package/runtime/types/flow-extension-runner/src/v2/loaders/loader-owner.d.ts +4 -6
  48. package/runtime/types/flow-extension-runner/src/v2/model/model-types.d.ts +2 -0
  49. package/runtime/types/flow-extension-runner/src/v2/params/index.d.ts +2 -2
  50. package/runtime/types/flow-extension-runner/src/v2/params/json/encode.d.ts +10 -2
  51. package/runtime/types/flow-extension-runner/src/v2/params/json/types.d.ts +1 -0
  52. package/runtime/types/flow-extension-runner/src/v2/params/zod.d.ts +29 -0
  53. package/runtime/types/flow-extension-runner/src/v2/types.d.ts +20 -8
  54. package/runtime/types/shared/src/constants/activity-log.d.ts +1496 -0
  55. package/runtime/types/shared/src/constants/docs.d.ts +2 -0
  56. package/runtime/types/shared/src/constants/notification-types.d.ts +9 -3
  57. package/runtime/types/shared/src/scheme/activity-log-base.d.ts +35 -0
  58. package/runtime/types/shared/src/scheme/data-types/java.dto.d.ts +2 -3
  59. package/runtime/types/shared/src/scheme/flowrunner/custom-elements.d.ts +20 -0
  60. package/runtime/types/shared/src/scheme/flowrunner/java.dto.d.ts +1 -0
  61. package/runtime/types/shared/src/scheme/shared-extensions/base.d.ts +5 -0
  62. package/runtime/types/shared/src/scheme/shared-extensions/custom-extensions.d.ts +147 -0
  63. package/runtime/types/shared/src/scheme/shared-extensions/extension.d.ts +20 -0
  64. package/runtime/types/shared/src/scheme/shared-extensions/methods.d.ts +33 -1
  65. package/runtime/types/shared/src/scheme/shared-extensions/params-schema.d.ts +1 -0
  66. package/runtime/types/shared/src/scheme/shared-extensions/resolve.d.ts +15 -0
  67. package/runtime/types/shared/src/scheme/shared-extensions/search.d.ts +10 -0
  68. package/templates/demo-todo-list/files/src/index.js +6 -6
  69. package/templates/qa-test/files/README.md +23 -8
  70. package/templates/qa-test/files/src/index.js +368 -37
@@ -91,12 +91,17 @@ export declare const ExtensionResolveUpdatedSchema: z.ZodObject<{
91
91
  dictionary: z.ZodOptional<z.ZodString>;
92
92
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
93
93
  uiComponent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
94
+ schemaLoader: z.ZodOptional<z.ZodString>;
94
95
  }, z.core.$strip>>>;
95
96
  sampleResult: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
96
97
  sampleResultLoader: z.ZodNullable<z.ZodObject<{
97
98
  methodName: z.ZodString;
98
99
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
99
100
  }, z.core.$strip>>;
101
+ dynamicParams: z.ZodOptional<z.ZodObject<{
102
+ methodName: z.ZodString;
103
+ dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
104
+ }, z.core.$strip>>;
100
105
  }, z.core.$strip>;
101
106
  paramsSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
102
107
  v: z.ZodNumber;
@@ -202,12 +207,17 @@ export declare const ExtensionResolveResultItemSchema: z.ZodDiscriminatedUnion<[
202
207
  dictionary: z.ZodOptional<z.ZodString>;
203
208
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
204
209
  uiComponent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
210
+ schemaLoader: z.ZodOptional<z.ZodString>;
205
211
  }, z.core.$strip>>>;
206
212
  sampleResult: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
207
213
  sampleResultLoader: z.ZodNullable<z.ZodObject<{
208
214
  methodName: z.ZodString;
209
215
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
210
216
  }, z.core.$strip>>;
217
+ dynamicParams: z.ZodOptional<z.ZodObject<{
218
+ methodName: z.ZodString;
219
+ dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
220
+ }, z.core.$strip>>;
211
221
  }, z.core.$strip>;
212
222
  paramsSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
213
223
  v: z.ZodNumber;
@@ -312,12 +322,17 @@ export declare const ExtensionResolveResponseSchema: z.ZodArray<z.ZodDiscriminat
312
322
  dictionary: z.ZodOptional<z.ZodString>;
313
323
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
314
324
  uiComponent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
325
+ schemaLoader: z.ZodOptional<z.ZodString>;
315
326
  }, z.core.$strip>>>;
316
327
  sampleResult: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
317
328
  sampleResultLoader: z.ZodNullable<z.ZodObject<{
318
329
  methodName: z.ZodString;
319
330
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
320
331
  }, z.core.$strip>>;
332
+ dynamicParams: z.ZodOptional<z.ZodObject<{
333
+ methodName: z.ZodString;
334
+ dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
335
+ }, z.core.$strip>>;
321
336
  }, z.core.$strip>;
322
337
  paramsSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
323
338
  v: z.ZodNumber;
@@ -23,12 +23,17 @@ export declare const SharedExtensionSearchResultMethodSchema: z.ZodObject<{
23
23
  dictionary: z.ZodOptional<z.ZodString>;
24
24
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
25
25
  uiComponent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
26
+ schemaLoader: z.ZodOptional<z.ZodString>;
26
27
  }, z.core.$strip>>>;
27
28
  sampleResult: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
28
29
  sampleResultLoader: z.ZodNullable<z.ZodObject<{
29
30
  methodName: z.ZodString;
30
31
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
31
32
  }, z.core.$strip>>;
33
+ dynamicParams: z.ZodOptional<z.ZodObject<{
34
+ methodName: z.ZodString;
35
+ dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
36
+ }, z.core.$strip>>;
32
37
  }, z.core.$strip>;
33
38
  paramsSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
34
39
  v: z.ZodNumber;
@@ -116,12 +121,17 @@ export declare const SearchSharedExtensionsResponseSchema: z.ZodObject<{
116
121
  dictionary: z.ZodOptional<z.ZodString>;
117
122
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
118
123
  uiComponent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
124
+ schemaLoader: z.ZodOptional<z.ZodString>;
119
125
  }, z.core.$strip>>>;
120
126
  sampleResult: z.ZodOptional<z.ZodNullable<z.ZodUnknown>>;
121
127
  sampleResultLoader: z.ZodNullable<z.ZodObject<{
122
128
  methodName: z.ZodString;
123
129
  dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
124
130
  }, z.core.$strip>>;
131
+ dynamicParams: z.ZodOptional<z.ZodObject<{
132
+ methodName: z.ZodString;
133
+ dependsOn: z.ZodOptional<z.ZodArray<z.ZodString>>;
134
+ }, z.core.$strip>>;
125
135
  }, z.core.$strip>;
126
136
  paramsSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
127
137
  v: z.ZodNumber;
@@ -300,19 +300,19 @@ ext.addAction({
300
300
  dueDate : z.coerce.date().optional().label('Due Date'),
301
301
  tags : z.array(z.string()).optional().label('Tags'),
302
302
  }),
303
- // The list's Custom Fields become real inputs here. `criteria` is what the console watches: pick a
304
- // different list and these fields are regenerated.
303
+ // The list's Custom Fields become real inputs here. `dependsOn` is what the console watches: pick a
304
+ // different list and these fields are loaded again. `execute` returns them as a plain zod shape.
305
305
  dynamicParams: {
306
- criteria: z.object({ listId: z.string().optional() }),
307
- resolve : ({ criteria }) => {
308
- const list = criteria.listId && storage.lists.get(criteria.listId)
306
+ dependsOn: ['listId'],
307
+ execute : ({ criteria }) => {
308
+ const list = storage.lists.get(criteria.listId)
309
309
  const shape = {}
310
310
 
311
311
  for (const label of list ? list.customFields : []) {
312
312
  shape[customFieldKey(label)] = z.string().optional().label(label)
313
313
  }
314
314
 
315
- return z.object(shape)
315
+ return shape
316
316
  },
317
317
  },
318
318
  result : taskResult,
@@ -25,9 +25,11 @@ Endpoint**, where you supply the URL.
25
25
  4. **Params — Date Forms** — put the same value in every field and compare what each declaration hands over
26
26
  5. **Params — List Of Objects** and **Params — List Of Choices** — the repeatable editors
27
27
  6. **Params — Dictionary-backed** — dependent, paged and failing dropdowns
28
- 7. **Files — Upload, Read, List, Delete** — the whole storage surface in one call
29
- 8. **Throw An Error** and **Run Longer Than A Timeout** — failure propagation, and that a long run survives
30
- 9. Enable one of the triggers and wait for a poll
28
+ 7. **Dynamic Props — Every Field Type** — pick a record type, fill its fields, switch type and check "Name" keeps its value
29
+ 8. **Dynamic Props — Loader States** — slow, failing and invalid loaders, and how each one surfaces
30
+ 9. **Files — Upload, Read, List, Delete** — the whole storage surface in one call
31
+ 10. **Throw An Error** and **Run Longer Than A Timeout** — failure propagation, and that a long run survives
32
+ 11. Enable one of the triggers and wait for a poll
31
33
 
32
34
  ## List of Actions
33
35
 
@@ -47,10 +49,23 @@ Endpoint**, where you supply the URL.
47
49
  - Params — List Of Choices
48
50
  - Params — Nested Object
49
51
  - Params — Dictionary-backed
50
- - Params — Generated At Runtime
51
52
  - Params — Unknown Fields Are Stripped
52
53
 
53
- **3. Results** — one per `result` form, because each publishes a different return type or sample source
54
+ **3. Dynamic Fields** — fields loaded at design time from the values of other params; each echoes `params` back
55
+
56
+ - Dynamic Props — Every Field Type
57
+ - Dynamic Props — Declared Keys Plus Loaded Ones
58
+ - Dynamic Props — Dropdowns Inside
59
+ - Dynamic Props — List Of Objects
60
+ - Dynamic Props — No Dependencies
61
+ - Dynamic Props — Several Dependencies, Typed
62
+ - Dynamic Props — One Definition, Two Params
63
+ - Dynamic Props — Loader States
64
+ - Dynamic Params — One Field Per Child
65
+ - Dynamic Params — Every Field Type
66
+ - Dynamic Params And Props Together
67
+
68
+ **4. Results** — one per `result` form, because each publishes a different return type or sample source
54
69
 
55
70
  - Returns — Object
56
71
  - Returns — List
@@ -58,7 +73,7 @@ Endpoint**, where you supply the URL.
58
73
  - Returns — Sample From A Schema
59
74
  - Returns — Sample Computed From Params
60
75
 
61
- **4. Runtime**
76
+ **5. Runtime**
62
77
 
63
78
  - Call Helpers
64
79
  - Emit Logs
@@ -66,11 +81,11 @@ Endpoint**, where you supply the URL.
66
81
  - Run Longer Than A Timeout
67
82
  - Read OAuth Without Declaring It
68
83
 
69
- **5. HTTP**
84
+ **6. HTTP**
70
85
 
71
86
  - Call An HTTP Endpoint
72
87
 
73
- **6. Files**
88
+ **7. Files**
74
89
 
75
90
  - Files — Upload, Read, List, Delete
76
91
  - Files — Storage Usage