@flowrunner/cli 0.1.8 → 0.1.9-dev.1

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 (72) hide show
  1. package/README.md +8 -8
  2. package/ai-docs/instructions/service-code-format/01-service-structure.md +4 -3
  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 +166 -10
  5. package/ai-docs/instructions/service-code-format/04-http-requests.md +19 -15
  6. package/ai-docs/instructions/service-code-format/05-dictionaries.md +14 -0
  7. package/ai-docs/instructions/service-code-format/06-oauth2.md +1 -5
  8. package/ai-docs/instructions/service-code-format/07-actions.md +18 -13
  9. package/ai-docs/instructions/service-code-format/11-output-model.md +42 -6
  10. package/ai-docs/instructions/service-code-format/12-service-readme.md +1 -1
  11. package/ai-docs/instructions/service-code-format/14-reference-service.md +5 -4
  12. package/ai-docs/instructions/service-code-format/15-unit-tests.md +2 -1
  13. package/ai-docs/instructions/service-code-format/16-gotchas.md +31 -1
  14. package/ai-docs/instructions/service-code-format/17-client-certificates.md +5 -3
  15. package/ai-docs/instructions/service-code-format/README.md +1 -1
  16. package/ai-docs/providers/claude/agents/flowrunner-service-test-engineer.md +1 -1
  17. package/dist/cli.js +285 -42
  18. package/dist/cli.js.map +3 -3
  19. package/dist/index.js +284 -41
  20. package/dist/index.js.map +3 -3
  21. package/dist/types/flow-extension-runner/src/v2/actions/action-method.d.ts +13 -9
  22. package/dist/types/flow-extension-runner/src/v2/loaders/loader-method.d.ts +52 -7
  23. package/dist/types/flow-extension-runner/src/v2/loaders/loader-owner.d.ts +4 -6
  24. package/dist/types/flow-extension-runner/src/v2/model/model-types.d.ts +2 -0
  25. package/dist/types/flow-extension-runner/src/v2/params/index.d.ts +2 -2
  26. package/dist/types/flow-extension-runner/src/v2/params/json/encode.d.ts +10 -2
  27. package/dist/types/flow-extension-runner/src/v2/params/json/types.d.ts +1 -0
  28. package/dist/types/flow-extension-runner/src/v2/params/zod.d.ts +29 -0
  29. package/dist/types/flow-extension-runner/src/v2/types.d.ts +21 -9
  30. package/dist/types/shared/src/constants/activity-log.d.ts +1496 -0
  31. package/dist/types/shared/src/constants/docs.d.ts +2 -0
  32. package/dist/types/shared/src/constants/notification-types.d.ts +11 -5
  33. package/dist/types/shared/src/scheme/activity-log-base.d.ts +35 -0
  34. package/dist/types/shared/src/scheme/data-types/java.dto.d.ts +2 -3
  35. package/dist/types/shared/src/scheme/flowrunner/custom-elements.d.ts +20 -0
  36. package/dist/types/shared/src/scheme/flowrunner/java.dto.d.ts +1 -0
  37. package/dist/types/shared/src/scheme/shared-extensions/base.d.ts +5 -0
  38. package/dist/types/shared/src/scheme/shared-extensions/custom-extensions.d.ts +147 -0
  39. package/dist/types/shared/src/scheme/shared-extensions/extension.d.ts +20 -0
  40. package/dist/types/shared/src/scheme/shared-extensions/methods.d.ts +33 -1
  41. package/dist/types/shared/src/scheme/shared-extensions/params-schema.d.ts +1 -0
  42. package/dist/types/shared/src/scheme/shared-extensions/resolve.d.ts +15 -0
  43. package/dist/types/shared/src/scheme/shared-extensions/search.d.ts +10 -0
  44. package/package.json +1 -1
  45. package/runtime/index.js +267 -41
  46. package/runtime/index.js.map +3 -3
  47. package/runtime/types/flow-extension-runner/src/v2/actions/action-method.d.ts +13 -9
  48. package/runtime/types/flow-extension-runner/src/v2/loaders/loader-method.d.ts +52 -7
  49. package/runtime/types/flow-extension-runner/src/v2/loaders/loader-owner.d.ts +4 -6
  50. package/runtime/types/flow-extension-runner/src/v2/model/model-types.d.ts +2 -0
  51. package/runtime/types/flow-extension-runner/src/v2/params/index.d.ts +2 -2
  52. package/runtime/types/flow-extension-runner/src/v2/params/json/encode.d.ts +10 -2
  53. package/runtime/types/flow-extension-runner/src/v2/params/json/types.d.ts +1 -0
  54. package/runtime/types/flow-extension-runner/src/v2/params/zod.d.ts +29 -0
  55. package/runtime/types/flow-extension-runner/src/v2/types.d.ts +21 -9
  56. package/runtime/types/shared/src/constants/activity-log.d.ts +1496 -0
  57. package/runtime/types/shared/src/constants/docs.d.ts +2 -0
  58. package/runtime/types/shared/src/constants/notification-types.d.ts +11 -5
  59. package/runtime/types/shared/src/scheme/activity-log-base.d.ts +35 -0
  60. package/runtime/types/shared/src/scheme/data-types/java.dto.d.ts +2 -3
  61. package/runtime/types/shared/src/scheme/flowrunner/custom-elements.d.ts +20 -0
  62. package/runtime/types/shared/src/scheme/flowrunner/java.dto.d.ts +1 -0
  63. package/runtime/types/shared/src/scheme/shared-extensions/base.d.ts +5 -0
  64. package/runtime/types/shared/src/scheme/shared-extensions/custom-extensions.d.ts +147 -0
  65. package/runtime/types/shared/src/scheme/shared-extensions/extension.d.ts +20 -0
  66. package/runtime/types/shared/src/scheme/shared-extensions/methods.d.ts +33 -1
  67. package/runtime/types/shared/src/scheme/shared-extensions/params-schema.d.ts +1 -0
  68. package/runtime/types/shared/src/scheme/shared-extensions/resolve.d.ts +15 -0
  69. package/runtime/types/shared/src/scheme/shared-extensions/search.d.ts +10 -0
  70. package/templates/blank/files/src/index.js +1 -1
  71. package/templates/demo-todo-list/files/src/index.js +7 -7
  72. package/templates/qa-test/files/src/index.js +33 -4
@@ -20,6 +20,7 @@ export interface ParamsSchemaField {
20
20
  value?: ParamsSchemaField;
21
21
  options?: ParamsSchemaField[];
22
22
  unsupported?: string[];
23
+ loose?: true;
23
24
  }
24
25
  declare const ParamsSchemaCheckSchema: z.ZodObject<{
25
26
  kind: z.ZodEnum<{
@@ -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;
@@ -59,7 +59,7 @@ const ext = Flowrunner.createExtension({
59
59
  'X-Api-Key' : context.apiKey,
60
60
  }
61
61
 
62
- return Flowrunner.Request[method.toLowerCase()](`${ context.baseUrl }${ path }`)
62
+ return new Flowrunner.Request(`${ context.baseUrl }${ path }`, method)
63
63
  .set(headers)
64
64
  .query(query)
65
65
  .send(body)
@@ -74,7 +74,7 @@ const ext = Flowrunner.createExtension({
74
74
  : headers
75
75
 
76
76
  try {
77
- return await Flowrunner.Request[method.toLowerCase()](url)
77
+ return await new Flowrunner.Request(url, method)
78
78
  .set(allHeaders)
79
79
  .query(query)
80
80
  .send(body)
@@ -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,
@@ -82,7 +82,7 @@ const ext = Flowrunner.createExtension({
82
82
  logger.debug(`[${ method.toUpperCase() }] ${ url } (harness ${ context.harnessVersion })`)
83
83
 
84
84
  try {
85
- return await Flowrunner.Request[method.toLowerCase()](url)
85
+ return await new Flowrunner.Request(url, method)
86
86
  .set(headers)
87
87
  .query(query)
88
88
  .send(body)
@@ -425,15 +425,15 @@ ext.addAction({
425
425
  parentId: z.string().label('Parent').dictionary(getParentsDictionary),
426
426
  }),
427
427
  dynamicParams: {
428
- criteria: z.object({ parentId: z.string().optional() }),
429
- resolve : ({ criteria }) => {
428
+ dependsOn: ['parentId'],
429
+ execute : ({ criteria }) => {
430
430
  const shape = {}
431
431
 
432
432
  for (const child of CHILDREN[criteria.parentId] || []) {
433
433
  shape[`field_${ child.id }`] = z.string().optional().label(`Field for ${ child.name }`)
434
434
  }
435
435
 
436
- return z.object(shape)
436
+ return shape
437
437
  },
438
438
  },
439
439
  result : { params: {} },
@@ -441,6 +441,35 @@ ext.addAction({
441
441
  execute : ({ params }) => ({ params, keys: Object.keys(params) }),
442
442
  })
443
443
 
444
+ ext.addAction({
445
+ category : '2. Params',
446
+ id : 'paramsDynamicProps',
447
+ label : 'Params — Fields Loaded Into An Object',
448
+ description: 'Picking a parent loads one field per child INSIDE "Child Fields". Change the parent and watch them change.',
449
+ params : z.object({
450
+ parentId : z.string().label('Parent').dictionary(getParentsDictionary),
451
+ // A loose object, so the loaded keys are kept. Declared keys (`comment`) are shown first, loaded ones after.
452
+ childFields: z.looseObject({ comment: z.string().optional().label('Comment') })
453
+ .optional()
454
+ .label('Child Fields')
455
+ .dynamicProps({
456
+ dependsOn: ['parentId'],
457
+ execute : ({ criteria }) => {
458
+ const shape = {}
459
+
460
+ for (const child of CHILDREN[criteria.parentId] || []) {
461
+ shape[`field_${ child.id }`] = z.string().optional().label(`Field for ${ child.name }`)
462
+ }
463
+
464
+ return shape
465
+ },
466
+ }),
467
+ }),
468
+ result : { params: {} },
469
+ // The loaded fields arrive nested under `childFields`
470
+ execute : ({ params }) => ({ params, keys: Object.keys(params.childFields || {}) }),
471
+ })
472
+
444
473
  ext.addAction({
445
474
  category : '2. Params',
446
475
  id : 'paramsUnknownStripped',