@webda/async 4.0.0-beta.2 → 4.0.0-beta.3

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 (62) hide show
  1. package/README.md +89 -4
  2. package/lib/{models.d.ts → asyncaction.model.d.ts} +75 -37
  3. package/lib/asyncaction.model.d.ts.map +1 -0
  4. package/lib/asyncaction.model.js +269 -0
  5. package/lib/asyncaction.model.js.map +1 -0
  6. package/lib/index.d.ts +6 -4
  7. package/lib/index.d.ts.map +1 -1
  8. package/lib/index.js +6 -4
  9. package/lib/index.js.map +1 -1
  10. package/lib/services/asyncevents.service.d.ts +154 -0
  11. package/lib/services/asyncevents.service.d.ts.map +1 -0
  12. package/lib/services/asyncevents.service.js +219 -0
  13. package/lib/services/asyncevents.service.js.map +1 -0
  14. package/lib/services/{asyncjobservice.d.ts → asyncjobservice.service.d.ts} +78 -61
  15. package/lib/services/asyncjobservice.service.d.ts.map +1 -0
  16. package/lib/services/asyncjobservice.service.js +584 -0
  17. package/lib/services/asyncjobservice.service.js.map +1 -0
  18. package/lib/services/{localrunner.d.ts → localrunner.service.d.ts} +24 -10
  19. package/lib/services/localrunner.service.d.ts.map +1 -0
  20. package/lib/services/localrunner.service.js +87 -0
  21. package/lib/services/localrunner.service.js.map +1 -0
  22. package/lib/services/{runner.d.ts → runner.service.d.ts} +17 -12
  23. package/lib/services/runner.service.d.ts.map +1 -0
  24. package/lib/services/{runner.js → runner.service.js} +16 -13
  25. package/lib/services/runner.service.js.map +1 -0
  26. package/lib/services/servicerunner.service.d.ts +105 -0
  27. package/lib/services/servicerunner.service.d.ts.map +1 -0
  28. package/lib/services/servicerunner.service.js +131 -0
  29. package/lib/services/servicerunner.service.js.map +1 -0
  30. package/package.json +32 -42
  31. package/webda.module.json +1925 -890
  32. package/lib/models.d.ts.map +0 -1
  33. package/lib/models.js +0 -179
  34. package/lib/models.js.map +0 -1
  35. package/lib/models.spec.d.ts +0 -7
  36. package/lib/models.spec.d.ts.map +0 -1
  37. package/lib/models.spec.js +0 -64
  38. package/lib/models.spec.js.map +0 -1
  39. package/lib/services/asyncjobservice.d.ts.map +0 -1
  40. package/lib/services/asyncjobservice.js +0 -469
  41. package/lib/services/asyncjobservice.js.map +0 -1
  42. package/lib/services/asyncjobservice.spec.d.ts +0 -2
  43. package/lib/services/asyncjobservice.spec.d.ts.map +0 -1
  44. package/lib/services/asyncjobservice.spec.js +0 -561
  45. package/lib/services/asyncjobservice.spec.js.map +0 -1
  46. package/lib/services/localrunner.d.ts.map +0 -1
  47. package/lib/services/localrunner.js +0 -70
  48. package/lib/services/localrunner.js.map +0 -1
  49. package/lib/services/localrunner.spec.d.ts +0 -2
  50. package/lib/services/localrunner.spec.d.ts.map +0 -1
  51. package/lib/services/localrunner.spec.js +0 -113
  52. package/lib/services/localrunner.spec.js.map +0 -1
  53. package/lib/services/runner.d.ts.map +0 -1
  54. package/lib/services/runner.js.map +0 -1
  55. package/lib/services/servicerunner.d.ts +0 -68
  56. package/lib/services/servicerunner.d.ts.map +0 -1
  57. package/lib/services/servicerunner.js +0 -97
  58. package/lib/services/servicerunner.js.map +0 -1
  59. package/lib/services/servicerunner.spec.d.ts +0 -2
  60. package/lib/services/servicerunner.spec.d.ts.map +0 -1
  61. package/lib/services/servicerunner.spec.js +0 -111
  62. package/lib/services/servicerunner.spec.js.map +0 -1
package/webda.module.json CHANGED
@@ -1,649 +1,1775 @@
1
1
  {
2
+ "$schema": "https://webda.io/schemas/webda.module.v4.json",
2
3
  "beans": {},
3
4
  "deployers": {},
4
5
  "moddas": {
5
- "Webda/AsyncJobService": "lib/services/asyncjobservice:default",
6
- "Webda/LocalRunner": "lib/services/localrunner:default",
7
- "Webda/ServiceRunner": "lib/services/servicerunner:default"
8
- },
9
- "models": {
10
- "graph": {
11
- "Webda/AsyncAction": {},
12
- "Webda/AsyncOperationAction": {},
13
- "Webda/AsyncWebdaAction": {}
6
+ "Webda/AsyncEvents": {
7
+ "Import": "lib/services/asyncevents.service:EventService",
8
+ "Schema": {
9
+ "$schema": "http://json-schema.org/draft-07/schema#",
10
+ "additionalProperties": false,
11
+ "definitions": {
12
+ "queues": {
13
+ "additionalProperties": {
14
+ "type": "string"
15
+ },
16
+ "description": "Queues to post async events to",
17
+ "type": "object"
18
+ }
19
+ },
20
+ "inheritdoc": true,
21
+ "properties": {
22
+ "queues": {
23
+ "$ref": "#/definitions/queues",
24
+ "description": "Queues to post async events to"
25
+ },
26
+ "sync": {
27
+ "default": false,
28
+ "description": "Make the event sending asynchronous",
29
+ "type": "boolean"
30
+ },
31
+ "type": {
32
+ "description": "Type of the service",
33
+ "type": "string"
34
+ },
35
+ "openapi": {
36
+ "type": "object",
37
+ "additionalProperties": true
38
+ }
39
+ },
40
+ "required": [
41
+ "type"
42
+ ],
43
+ "type": "object",
44
+ "title": "EventService"
45
+ },
46
+ "Configuration": "lib/services/asyncevents.service:EventServiceParameters"
14
47
  },
15
- "tree": {
16
- "Webda/AsyncAction": {
17
- "Webda/AsyncWebdaAction": {},
18
- "Webda/AsyncOperationAction": {}
48
+ "Webda/AsyncJobService": {
49
+ "Import": "lib/services/asyncjobservice.service:default",
50
+ "Schema": {
51
+ "$schema": "http://json-schema.org/draft-07/schema#",
52
+ "additionalProperties": false,
53
+ "inheritdoc": true,
54
+ "properties": {
55
+ "asyncActionModel": {
56
+ "default": "Webda/AsyncWebdaAction",
57
+ "description": "Model to use when launching async action",
58
+ "type": "string"
59
+ },
60
+ "asyncOperationDefinition": {
61
+ "description": "JSON file of the AsyncOperation definition\n\nGenerated with `webda operations operations.json`",
62
+ "type": "string"
63
+ },
64
+ "asyncOperationModel": {
65
+ "default": "Webda/AsyncOperationAction",
66
+ "description": "Model to use when launching async operation",
67
+ "type": "string"
68
+ },
69
+ "concurrencyLimit": {
70
+ "description": "Limit the maximum number of jobs running in //",
71
+ "type": "number"
72
+ },
73
+ "fallbackOnFirst": {
74
+ "default": false,
75
+ "description": "Fallback on first runner if none match",
76
+ "type": "boolean"
77
+ },
78
+ "includeCron": {
79
+ "default": true,
80
+ "description": "Include Cron annotation to launch them as AsyncOperationAction",
81
+ "type": "boolean"
82
+ },
83
+ "includeSchedulerInWorker": {
84
+ "default": false,
85
+ "description": "Include the scheduler system in the worker",
86
+ "type": "boolean"
87
+ },
88
+ "localLaunch": {
89
+ "default": false,
90
+ "description": "If set runner will be called without queue",
91
+ "type": "boolean"
92
+ },
93
+ "logsLimit": {
94
+ "default": 500,
95
+ "description": "Limit the number of lines of logs available for an async action\n\nIf you need to store large amount of logs then you should use the CloudWatchLogger or similar logger",
96
+ "type": "number"
97
+ },
98
+ "onlyHttpHook": {
99
+ "default": false,
100
+ "description": "Define if we should only use an http hook and not rely on store for AsyncOperation",
101
+ "type": "boolean"
102
+ },
103
+ "queue": {
104
+ "default": "AsyncActionsQueue",
105
+ "description": "Queue to post execution to",
106
+ "type": "string"
107
+ },
108
+ "runners": {
109
+ "description": "Runners to use",
110
+ "items": {
111
+ "type": "string"
112
+ },
113
+ "type": "array"
114
+ },
115
+ "schedulerResolution": {
116
+ "default": 60000,
117
+ "description": "Schedule action resolution\n\nIf set to 1000ms, you can schedule action per second\nby default it resolve per minute",
118
+ "type": "number"
119
+ },
120
+ "type": {
121
+ "description": "Type of the service",
122
+ "type": "string"
123
+ },
124
+ "url": {
125
+ "default": "/async",
126
+ "description": "URL to expose job status report hook",
127
+ "type": "string"
128
+ },
129
+ "openapi": {
130
+ "type": "object",
131
+ "additionalProperties": true
132
+ }
133
+ },
134
+ "required": [
135
+ "runners",
136
+ "type"
137
+ ],
138
+ "type": "object",
139
+ "title": "AsyncJobService"
140
+ },
141
+ "Configuration": "lib/services/asyncjobservice.service:AsyncJobServiceParameters",
142
+ "capabilities": [
143
+ "request-filter"
144
+ ],
145
+ "commands": {
146
+ "async worker": {
147
+ "description": "Launch the async actions worker",
148
+ "method": "worker",
149
+ "args": {}
150
+ },
151
+ "async run": {
152
+ "description": "Run the async action described by the JOB_* environment variables",
153
+ "method": "runAction",
154
+ "args": {}
155
+ },
156
+ "async scheduler": {
157
+ "description": "Launch the async actions scheduler",
158
+ "method": "scheduler",
159
+ "args": {}
160
+ }
19
161
  }
20
162
  },
21
- "plurals": {},
22
- "list": {
23
- "Webda/AsyncAction": "lib/models:default",
24
- "Webda/AsyncOperationAction": "lib/models:AsyncOperationAction",
25
- "Webda/AsyncWebdaAction": "lib/models:AsyncWebdaAction"
26
- },
27
- "reflections": {
28
- "Webda/AsyncAction": {
29
- "uuid": "string",
30
- "status": "\"RUNNING\" | \"SUCCESS\" | \"ERROR\" | \"QUEUED\" | \"STARTING\" | \"TIMEOUT\" | \"SCHEDULED\"",
31
- "scheduled": "number",
32
- "errorMessage": "string",
33
- "errorName": "string",
34
- "job": "any",
35
- "_lastJobUpdate": "number",
36
- "results": "any",
37
- "statusDetails": "any",
38
- "type": "string",
39
- "arguments": "any[]",
40
- "logs": "string[]",
41
- "__secretKey": "string",
42
- "action": "\"STOP\" | string",
43
- "__class": "CoreModelDefinition<this>",
44
- "__type": "string",
45
- "__types": "string[]",
46
- "__ctx": "OperationContext",
47
- "__store": "Store<this>",
48
- "__dirty": "Set<string | symbol>",
49
- "_creationDate": "Date",
50
- "_lastUpdate": "Date",
51
- "__deleted": "boolean"
163
+ "Webda/LocalRunner": {
164
+ "Import": "lib/services/localrunner.service:default",
165
+ "Schema": {
166
+ "$schema": "http://json-schema.org/draft-07/schema#",
167
+ "additionalProperties": false,
168
+ "definitions": {
169
+ "AbortSignal": {
170
+ "additionalProperties": false,
171
+ "description": "The **`AbortSignal`** interface represents a signal object that allows you to communicate with an asynchronous operation (such as a fetch request) and abort it if required via an AbortController object.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortSignal)",
172
+ "type": "object"
173
+ },
174
+ "ProcessEnv": {
175
+ "additionalProperties": {
176
+ "type": "string"
177
+ },
178
+ "type": "object"
179
+ },
180
+ "SpawnOptions": {
181
+ "additionalProperties": false,
182
+ "properties": {
183
+ "argv0": {
184
+ "type": "string"
185
+ },
186
+ "cwd": {
187
+ "type": "string"
188
+ },
189
+ "detached": {
190
+ "default": false,
191
+ "type": "boolean"
192
+ },
193
+ "env": {
194
+ "$ref": "#/definitions/ProcessEnv"
195
+ },
196
+ "gid": {
197
+ "type": "number"
198
+ },
199
+ "killSignal": {
200
+ "anyOf": [
201
+ {
202
+ "type": "number"
203
+ },
204
+ {
205
+ "const": "SIGABRT",
206
+ "type": "string"
207
+ },
208
+ {
209
+ "const": "SIGALRM",
210
+ "type": "string"
211
+ },
212
+ {
213
+ "const": "SIGBUS",
214
+ "type": "string"
215
+ },
216
+ {
217
+ "const": "SIGCHLD",
218
+ "type": "string"
219
+ },
220
+ {
221
+ "const": "SIGCONT",
222
+ "type": "string"
223
+ },
224
+ {
225
+ "const": "SIGFPE",
226
+ "type": "string"
227
+ },
228
+ {
229
+ "const": "SIGHUP",
230
+ "type": "string"
231
+ },
232
+ {
233
+ "const": "SIGILL",
234
+ "type": "string"
235
+ },
236
+ {
237
+ "const": "SIGINT",
238
+ "type": "string"
239
+ },
240
+ {
241
+ "const": "SIGIO",
242
+ "type": "string"
243
+ },
244
+ {
245
+ "const": "SIGIOT",
246
+ "type": "string"
247
+ },
248
+ {
249
+ "const": "SIGKILL",
250
+ "type": "string"
251
+ },
252
+ {
253
+ "const": "SIGPIPE",
254
+ "type": "string"
255
+ },
256
+ {
257
+ "const": "SIGPOLL",
258
+ "type": "string"
259
+ },
260
+ {
261
+ "const": "SIGPROF",
262
+ "type": "string"
263
+ },
264
+ {
265
+ "const": "SIGPWR",
266
+ "type": "string"
267
+ },
268
+ {
269
+ "const": "SIGQUIT",
270
+ "type": "string"
271
+ },
272
+ {
273
+ "const": "SIGSEGV",
274
+ "type": "string"
275
+ },
276
+ {
277
+ "const": "SIGSTKFLT",
278
+ "type": "string"
279
+ },
280
+ {
281
+ "const": "SIGSTOP",
282
+ "type": "string"
283
+ },
284
+ {
285
+ "const": "SIGSYS",
286
+ "type": "string"
287
+ },
288
+ {
289
+ "const": "SIGTERM",
290
+ "type": "string"
291
+ },
292
+ {
293
+ "const": "SIGTRAP",
294
+ "type": "string"
295
+ },
296
+ {
297
+ "const": "SIGTSTP",
298
+ "type": "string"
299
+ },
300
+ {
301
+ "const": "SIGTTIN",
302
+ "type": "string"
303
+ },
304
+ {
305
+ "const": "SIGTTOU",
306
+ "type": "string"
307
+ },
308
+ {
309
+ "const": "SIGUNUSED",
310
+ "type": "string"
311
+ },
312
+ {
313
+ "const": "SIGURG",
314
+ "type": "string"
315
+ },
316
+ {
317
+ "const": "SIGUSR1",
318
+ "type": "string"
319
+ },
320
+ {
321
+ "const": "SIGUSR2",
322
+ "type": "string"
323
+ },
324
+ {
325
+ "const": "SIGVTALRM",
326
+ "type": "string"
327
+ },
328
+ {
329
+ "const": "SIGWINCH",
330
+ "type": "string"
331
+ },
332
+ {
333
+ "const": "SIGXCPU",
334
+ "type": "string"
335
+ },
336
+ {
337
+ "const": "SIGXFSZ",
338
+ "type": "string"
339
+ },
340
+ {
341
+ "const": "SIGBREAK",
342
+ "type": "string"
343
+ },
344
+ {
345
+ "const": "SIGLOST",
346
+ "type": "string"
347
+ },
348
+ {
349
+ "const": "SIGINFO",
350
+ "type": "string"
351
+ }
352
+ ],
353
+ "default": "'SIGTERM'",
354
+ "description": "The signal value to be used when the spawned process will be killed by the abort signal."
355
+ },
356
+ "serialization": {
357
+ "default": "'json'",
358
+ "description": "Specify the kind of serialization used for sending messages between processes.",
359
+ "enum": [
360
+ "json",
361
+ "advanced"
362
+ ],
363
+ "type": "string"
364
+ },
365
+ "shell": {
366
+ "type": [
367
+ "string",
368
+ "boolean"
369
+ ]
370
+ },
371
+ "signal": {
372
+ "$ref": "#/definitions/AbortSignal"
373
+ },
374
+ "stdio": {
375
+ "anyOf": [
376
+ {
377
+ "const": "overlapped",
378
+ "type": "string"
379
+ },
380
+ {
381
+ "const": "pipe",
382
+ "type": "string"
383
+ },
384
+ {
385
+ "const": "ignore",
386
+ "type": "string"
387
+ },
388
+ {
389
+ "const": "inherit",
390
+ "type": "string"
391
+ },
392
+ {
393
+ "items": {
394
+ "anyOf": [
395
+ {
396
+ "type": "number"
397
+ },
398
+ {
399
+ "const": "overlapped",
400
+ "type": "string"
401
+ },
402
+ {
403
+ "const": "pipe",
404
+ "type": "string"
405
+ },
406
+ {
407
+ "const": "ignore",
408
+ "type": "string"
409
+ },
410
+ {
411
+ "const": "inherit",
412
+ "type": "string"
413
+ },
414
+ {
415
+ "const": "ipc",
416
+ "type": "string"
417
+ },
418
+ {
419
+ "$ref": "#/definitions/Stream"
420
+ }
421
+ ]
422
+ },
423
+ "type": "array"
424
+ }
425
+ ],
426
+ "default": "'pipe'",
427
+ "description": "Can be set to 'pipe', 'inherit', 'overlapped', or 'ignore', or an array of these strings.\nIf passed as an array, the first element is used for `stdin`, the second for\n`stdout`, and the third for `stderr`. A fourth element can be used to\nspecify the `stdio` behavior beyond the standard streams. See\n{@link ChildProcess.stdio} for more information."
428
+ },
429
+ "timeout": {
430
+ "default": 0,
431
+ "type": "number"
432
+ },
433
+ "uid": {
434
+ "type": "number"
435
+ },
436
+ "windowsHide": {
437
+ "default": false,
438
+ "type": "boolean"
439
+ },
440
+ "windowsVerbatimArguments": {
441
+ "default": false,
442
+ "type": "boolean"
443
+ }
444
+ },
445
+ "type": "object"
446
+ },
447
+ "Stream": {
448
+ "additionalProperties": false,
449
+ "type": "object"
450
+ }
451
+ },
452
+ "description": "LocalRunner parameters",
453
+ "properties": {
454
+ "actions": {
455
+ "default": [],
456
+ "description": "Actions managed by the runner",
457
+ "items": {
458
+ "type": "string"
459
+ },
460
+ "type": "array"
461
+ },
462
+ "args": {
463
+ "description": "Args",
464
+ "items": {
465
+ "type": "string"
466
+ },
467
+ "type": "array"
468
+ },
469
+ "autoStatus": {
470
+ "default": false,
471
+ "description": "Use the observability of ChildProcess to update status accordingly",
472
+ "type": "boolean"
473
+ },
474
+ "command": {
475
+ "description": "Command to launch",
476
+ "type": "string"
477
+ },
478
+ "options": {
479
+ "$ref": "#/definitions/SpawnOptions",
480
+ "description": "Options\n\nBased on https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options"
481
+ },
482
+ "type": {
483
+ "description": "Type of the service",
484
+ "type": "string"
485
+ },
486
+ "openapi": {
487
+ "type": "object",
488
+ "additionalProperties": true
489
+ }
490
+ },
491
+ "required": [
492
+ "command",
493
+ "type"
494
+ ],
495
+ "type": "object",
496
+ "title": "LocalRunner"
52
497
  },
53
- "Webda/AsyncOperationAction": {
54
- "uuid": "string",
55
- "status": "\"RUNNING\" | \"SUCCESS\" | \"ERROR\" | \"QUEUED\" | \"STARTING\" | \"TIMEOUT\" | \"SCHEDULED\"",
56
- "scheduled": "number",
57
- "errorMessage": "string",
58
- "errorName": "string",
59
- "job": "any",
60
- "_lastJobUpdate": "number",
61
- "results": "any",
62
- "statusDetails": "any",
63
- "type": "string",
64
- "arguments": "any[]",
65
- "logs": "string[]",
66
- "__secretKey": "string",
67
- "action": "\"STOP\" | string",
68
- "__class": "CoreModelDefinition<this>",
69
- "__type": "string",
70
- "__types": "string[]",
71
- "__ctx": "OperationContext",
72
- "__store": "Store<this>",
73
- "__dirty": "Set<string | symbol>",
74
- "_creationDate": "Date",
75
- "_lastUpdate": "Date",
76
- "__deleted": "boolean"
498
+ "Configuration": "lib/services/localrunner.service:LocalRunnerParameters"
499
+ },
500
+ "Webda/ServiceRunner": {
501
+ "Import": "lib/services/servicerunner.service:default",
502
+ "Schema": {
503
+ "$schema": "http://json-schema.org/draft-07/schema#",
504
+ "additionalProperties": false,
505
+ "description": "Add the log format to capture",
506
+ "properties": {
507
+ "actions": {
508
+ "default": [],
509
+ "description": "Actions managed by the runner",
510
+ "items": {
511
+ "type": "string"
512
+ },
513
+ "type": "array"
514
+ },
515
+ "logFormat": {
516
+ "default": "ConsoleLoggerDefaultFormat",
517
+ "description": "Define the log format",
518
+ "type": "string"
519
+ },
520
+ "logSaveDelay": {
521
+ "default": 5000,
522
+ "description": "How long before saving logs (in ms)",
523
+ "type": "number"
524
+ },
525
+ "type": {
526
+ "description": "Type of the service",
527
+ "type": "string"
528
+ },
529
+ "openapi": {
530
+ "type": "object",
531
+ "additionalProperties": true
532
+ }
533
+ },
534
+ "required": [
535
+ "type"
536
+ ],
537
+ "type": "object",
538
+ "title": "ServiceRunner"
77
539
  },
78
- "Webda/AsyncWebdaAction": {
79
- "logLevel": "WorkerLogLevel",
80
- "uuid": "string",
81
- "status": "\"RUNNING\" | \"SUCCESS\" | \"ERROR\" | \"QUEUED\" | \"STARTING\" | \"TIMEOUT\" | \"SCHEDULED\"",
82
- "scheduled": "number",
83
- "errorMessage": "string",
84
- "errorName": "string",
85
- "job": "any",
86
- "_lastJobUpdate": "number",
87
- "results": "any",
88
- "statusDetails": "any",
89
- "type": "string",
90
- "arguments": "any[]",
91
- "logs": "string[]",
92
- "__secretKey": "string",
93
- "action": "\"STOP\" | string",
94
- "__class": "CoreModelDefinition<this>",
95
- "__type": "string",
96
- "__types": "string[]",
97
- "__ctx": "OperationContext",
98
- "__store": "Store<this>",
99
- "__dirty": "Set<string | symbol>",
100
- "_creationDate": "Date",
101
- "_lastUpdate": "Date",
102
- "__deleted": "boolean"
103
- }
540
+ "Configuration": "lib/services/servicerunner.service:ServiceRunnerParameters"
104
541
  }
105
542
  },
106
- "schemas": {
543
+ "models": {
107
544
  "Webda/AsyncAction": {
108
- "type": "object",
109
- "properties": {
110
- "_creationDate": {
111
- "type": "string",
112
- "format": "date-time",
113
- "description": "Creation date",
114
- "readOnly": true
115
- },
116
- "_lastUpdate": {
117
- "type": "string",
118
- "format": "date-time",
119
- "description": "Last update date",
120
- "readOnly": true
545
+ "Plural": "AsyncActions",
546
+ "Import": "lib/asyncaction.model:default",
547
+ "Relations": {},
548
+ "Ancestors": [],
549
+ "Subclasses": [
550
+ "Webda/AsyncWebdaAction",
551
+ "Webda/AsyncOperationAction"
552
+ ],
553
+ "Reflection": {
554
+ "status": {
555
+ "type": "\"RUNNING\" | \"SUCCESS\" | \"ERROR\" | \"QUEUED\" | \"STARTING\" | \"TIMEOUT\" | \"SCHEDULED\""
556
+ },
557
+ "scheduled": {
558
+ "type": "number"
559
+ },
560
+ "errorMessage": {
561
+ "type": "string"
562
+ },
563
+ "errorName": {
564
+ "type": "string"
565
+ },
566
+ "job": {
567
+ "type": "any"
568
+ },
569
+ "_lastJobUpdate": {
570
+ "type": "number"
571
+ },
572
+ "results": {
573
+ "type": "any"
574
+ },
575
+ "statusDetails": {
576
+ "type": "any"
577
+ },
578
+ "type": {
579
+ "type": "string"
580
+ },
581
+ "arguments": {
582
+ "type": "Array",
583
+ "typeParameters": [
584
+ "any"
585
+ ]
586
+ },
587
+ "logs": {
588
+ "type": "Array",
589
+ "typeParameters": [
590
+ "string"
591
+ ]
592
+ },
593
+ "__secretKey": {
594
+ "type": "string"
595
+ },
596
+ "action": {
597
+ "type": "\"STOP\" | string"
121
598
  },
122
599
  "uuid": {
123
- "type": "string",
124
- "description": "Action uuid"
600
+ "type": "string"
601
+ }
602
+ },
603
+ "Schemas": {
604
+ "Output": {
605
+ "$schema": "http://json-schema.org/draft-07/schema#",
606
+ "WebdaModel": true,
607
+ "WebdaPlural": "AsyncActions",
608
+ "additionalProperties": false,
609
+ "description": "Define here a model that can be used along with Store service",
610
+ "properties": {
611
+ "__secretKey": {
612
+ "description": "Secret key to post feedback",
613
+ "type": "string"
614
+ },
615
+ "_lastJobUpdate": {
616
+ "description": "Last time the job was updated",
617
+ "type": "number"
618
+ },
619
+ "action": {
620
+ "description": "Expected action for the job\n\nIt should be a verb",
621
+ "type": "string"
622
+ },
623
+ "arguments": {
624
+ "description": "Arguments of the action",
625
+ "items": {},
626
+ "type": "array"
627
+ },
628
+ "errorMessage": {
629
+ "description": "If an error occured it should contain the message",
630
+ "type": "string"
631
+ },
632
+ "errorName": {
633
+ "description": "If an error occured it should contain the name",
634
+ "type": "string"
635
+ },
636
+ "job": {
637
+ "description": "Job information"
638
+ },
639
+ "logs": {
640
+ "description": "Current logs",
641
+ "items": {
642
+ "type": "string"
643
+ },
644
+ "type": "array"
645
+ },
646
+ "results": {
647
+ "description": "Results from the job"
648
+ },
649
+ "scheduled": {
650
+ "description": "Timestamp when the action was scheduled",
651
+ "type": "number"
652
+ },
653
+ "status": {
654
+ "description": "Current status",
655
+ "enum": [
656
+ "RUNNING",
657
+ "SUCCESS",
658
+ "ERROR",
659
+ "QUEUED",
660
+ "STARTING",
661
+ "TIMEOUT",
662
+ "SCHEDULED"
663
+ ],
664
+ "type": "string"
665
+ },
666
+ "statusDetails": {
667
+ "description": "Job current status"
668
+ },
669
+ "type": {
670
+ "description": "Type of action",
671
+ "type": "string"
672
+ },
673
+ "uuid": {
674
+ "description": "UUID of the model",
675
+ "format": "uuid",
676
+ "type": "string"
677
+ }
678
+ },
679
+ "required": [
680
+ "__secretKey",
681
+ "_lastJobUpdate",
682
+ "job",
683
+ "logs",
684
+ "results",
685
+ "status",
686
+ "statusDetails",
687
+ "type",
688
+ "uuid"
689
+ ],
690
+ "type": "object",
691
+ "$webda": "toDto$auto"
692
+ },
693
+ "Input": {
694
+ "$schema": "http://json-schema.org/draft-07/schema#",
695
+ "WebdaModel": true,
696
+ "WebdaPlural": "AsyncActions",
697
+ "additionalProperties": false,
698
+ "description": "Define here a model that can be used along with Store service",
699
+ "properties": {
700
+ "__secretKey": {
701
+ "description": "Secret key to post feedback",
702
+ "type": "string"
703
+ },
704
+ "_lastJobUpdate": {
705
+ "description": "Last time the job was updated",
706
+ "type": "number"
707
+ },
708
+ "action": {
709
+ "description": "Expected action for the job\n\nIt should be a verb",
710
+ "type": "string"
711
+ },
712
+ "arguments": {
713
+ "description": "Arguments of the action",
714
+ "items": {},
715
+ "type": "array"
716
+ },
717
+ "errorMessage": {
718
+ "description": "If an error occured it should contain the message",
719
+ "type": "string"
720
+ },
721
+ "errorName": {
722
+ "description": "If an error occured it should contain the name",
723
+ "type": "string"
724
+ },
725
+ "job": {
726
+ "description": "Job information"
727
+ },
728
+ "logs": {
729
+ "description": "Current logs",
730
+ "items": {
731
+ "type": "string"
732
+ },
733
+ "type": "array"
734
+ },
735
+ "results": {
736
+ "description": "Results from the job"
737
+ },
738
+ "scheduled": {
739
+ "description": "Timestamp when the action was scheduled",
740
+ "type": "number"
741
+ },
742
+ "status": {
743
+ "description": "Current status",
744
+ "enum": [
745
+ "RUNNING",
746
+ "SUCCESS",
747
+ "ERROR",
748
+ "QUEUED",
749
+ "STARTING",
750
+ "TIMEOUT",
751
+ "SCHEDULED"
752
+ ],
753
+ "type": "string"
754
+ },
755
+ "statusDetails": {
756
+ "description": "Job current status"
757
+ },
758
+ "type": {
759
+ "description": "Type of action",
760
+ "type": "string"
761
+ },
762
+ "uuid": {
763
+ "description": "UUID of the model",
764
+ "format": "uuid",
765
+ "type": "string"
766
+ }
767
+ },
768
+ "required": [
769
+ "__secretKey",
770
+ "_lastJobUpdate",
771
+ "job",
772
+ "logs",
773
+ "results",
774
+ "status",
775
+ "statusDetails",
776
+ "type",
777
+ "uuid"
778
+ ],
779
+ "type": "object",
780
+ "$webda": "fromDto$auto"
781
+ },
782
+ "Stored": {
783
+ "$schema": "http://json-schema.org/draft-07/schema#",
784
+ "WebdaModel": true,
785
+ "WebdaPlural": "AsyncActions",
786
+ "additionalProperties": false,
787
+ "description": "Define here a model that can be used along with Store service",
788
+ "properties": {
789
+ "__secretKey": {
790
+ "description": "Secret key to post feedback",
791
+ "type": "string"
792
+ },
793
+ "_lastJobUpdate": {
794
+ "description": "Last time the job was updated",
795
+ "type": "number"
796
+ },
797
+ "action": {
798
+ "description": "Expected action for the job\n\nIt should be a verb",
799
+ "type": "string"
800
+ },
801
+ "arguments": {
802
+ "description": "Arguments of the action",
803
+ "items": {},
804
+ "type": "array"
805
+ },
806
+ "errorMessage": {
807
+ "description": "If an error occured it should contain the message",
808
+ "type": "string"
809
+ },
810
+ "errorName": {
811
+ "description": "If an error occured it should contain the name",
812
+ "type": "string"
813
+ },
814
+ "job": {
815
+ "description": "Job information"
816
+ },
817
+ "logs": {
818
+ "description": "Current logs",
819
+ "items": {
820
+ "type": "string"
821
+ },
822
+ "type": "array"
823
+ },
824
+ "results": {
825
+ "description": "Results from the job"
826
+ },
827
+ "scheduled": {
828
+ "description": "Timestamp when the action was scheduled",
829
+ "type": "number"
830
+ },
831
+ "status": {
832
+ "description": "Current status",
833
+ "enum": [
834
+ "RUNNING",
835
+ "SUCCESS",
836
+ "ERROR",
837
+ "QUEUED",
838
+ "STARTING",
839
+ "TIMEOUT",
840
+ "SCHEDULED"
841
+ ],
842
+ "type": "string"
843
+ },
844
+ "statusDetails": {
845
+ "description": "Job current status"
846
+ },
847
+ "type": {
848
+ "description": "Type of action",
849
+ "type": "string"
850
+ },
851
+ "uuid": {
852
+ "description": "UUID of the model",
853
+ "format": "uuid",
854
+ "type": "string"
855
+ }
856
+ },
857
+ "required": [
858
+ "__secretKey",
859
+ "_lastJobUpdate",
860
+ "job",
861
+ "logs",
862
+ "results",
863
+ "status",
864
+ "statusDetails",
865
+ "type",
866
+ "uuid"
867
+ ],
868
+ "type": "object",
869
+ "$webda": "toJSON$return"
870
+ }
871
+ },
872
+ "Actions": {
873
+ "status": {
874
+ "handler": "statusAction"
875
+ }
876
+ },
877
+ "Events": [
878
+ "Create",
879
+ "PartialUpdate",
880
+ "Delete",
881
+ "Update",
882
+ "Patch",
883
+ "Query",
884
+ "Created",
885
+ "PartialUpdated",
886
+ "Deleted",
887
+ "Patched",
888
+ "Updated",
889
+ "Queried"
890
+ ],
891
+ "PrimaryKey": [
892
+ "uuid"
893
+ ],
894
+ "Identifier": "Webda/AsyncAction"
895
+ },
896
+ "Webda/AsyncOperationAction": {
897
+ "Plural": "AsyncOperationActions",
898
+ "Import": "lib/asyncaction.model:AsyncOperationAction",
899
+ "Relations": {},
900
+ "Ancestors": [
901
+ "Webda/AsyncAction"
902
+ ],
903
+ "Subclasses": [],
904
+ "Reflection": {
905
+ "operationId": {
906
+ "type": "string"
907
+ },
908
+ "context": {
909
+ "type": "any"
910
+ },
911
+ "logLevel": {
912
+ "type": "WorkerLogLevel"
125
913
  },
126
914
  "status": {
127
- "type": "string",
128
- "enum": [
129
- "RUNNING",
130
- "SUCCESS",
131
- "ERROR",
132
- "QUEUED",
133
- "STARTING",
134
- "TIMEOUT",
135
- "SCHEDULED"
915
+ "type": "\"RUNNING\" | \"SUCCESS\" | \"ERROR\" | \"QUEUED\" | \"STARTING\" | \"TIMEOUT\" | \"SCHEDULED\""
916
+ },
917
+ "scheduled": {
918
+ "type": "number"
919
+ },
920
+ "errorMessage": {
921
+ "type": "string"
922
+ },
923
+ "errorName": {
924
+ "type": "string"
925
+ },
926
+ "job": {
927
+ "type": "any"
928
+ },
929
+ "_lastJobUpdate": {
930
+ "type": "number"
931
+ },
932
+ "results": {
933
+ "type": "any"
934
+ },
935
+ "statusDetails": {
936
+ "type": "any"
937
+ },
938
+ "type": {
939
+ "type": "string"
940
+ },
941
+ "arguments": {
942
+ "type": "Array",
943
+ "typeParameters": [
944
+ "any"
945
+ ]
946
+ },
947
+ "logs": {
948
+ "type": "Array",
949
+ "typeParameters": [
950
+ "string"
951
+ ]
952
+ },
953
+ "__secretKey": {
954
+ "type": "string"
955
+ },
956
+ "action": {
957
+ "type": "\"STOP\" | string"
958
+ },
959
+ "uuid": {
960
+ "type": "string"
961
+ }
962
+ },
963
+ "Schemas": {
964
+ "Output": {
965
+ "$schema": "http://json-schema.org/draft-07/schema#",
966
+ "WebdaModel": true,
967
+ "WebdaPlural": "AsyncOperationActions",
968
+ "additionalProperties": false,
969
+ "description": "Operation called asynchronously",
970
+ "properties": {
971
+ "__secretKey": {
972
+ "description": "Secret key to post feedback",
973
+ "type": "string"
974
+ },
975
+ "_lastJobUpdate": {
976
+ "description": "Last time the job was updated",
977
+ "type": "number"
978
+ },
979
+ "action": {
980
+ "description": "Expected action for the job\n\nIt should be a verb",
981
+ "type": "string"
982
+ },
983
+ "arguments": {
984
+ "description": "Arguments of the action",
985
+ "items": {},
986
+ "type": "array"
987
+ },
988
+ "context": {
989
+ "description": "Context to call the operation with"
990
+ },
991
+ "errorMessage": {
992
+ "description": "If an error occured it should contain the message",
993
+ "type": "string"
994
+ },
995
+ "errorName": {
996
+ "description": "If an error occured it should contain the name",
997
+ "type": "string"
998
+ },
999
+ "job": {
1000
+ "description": "Job information"
1001
+ },
1002
+ "logLevel": {
1003
+ "description": "Log level to capture",
1004
+ "enum": [
1005
+ "ERROR",
1006
+ "WARN",
1007
+ "INFO",
1008
+ "DEBUG",
1009
+ "TRACE"
1010
+ ],
1011
+ "type": "string"
1012
+ },
1013
+ "logs": {
1014
+ "description": "Current logs",
1015
+ "items": {
1016
+ "type": "string"
1017
+ },
1018
+ "type": "array"
1019
+ },
1020
+ "operationId": {
1021
+ "description": "Operation to call",
1022
+ "type": "string"
1023
+ },
1024
+ "results": {
1025
+ "description": "Results from the job"
1026
+ },
1027
+ "scheduled": {
1028
+ "description": "Timestamp when the action was scheduled",
1029
+ "type": "number"
1030
+ },
1031
+ "status": {
1032
+ "description": "Current status",
1033
+ "enum": [
1034
+ "RUNNING",
1035
+ "SUCCESS",
1036
+ "ERROR",
1037
+ "QUEUED",
1038
+ "STARTING",
1039
+ "TIMEOUT",
1040
+ "SCHEDULED"
1041
+ ],
1042
+ "type": "string"
1043
+ },
1044
+ "statusDetails": {
1045
+ "description": "Job current status"
1046
+ },
1047
+ "type": {
1048
+ "description": "Type of action",
1049
+ "type": "string"
1050
+ },
1051
+ "uuid": {
1052
+ "description": "UUID of the model",
1053
+ "format": "uuid",
1054
+ "type": "string"
1055
+ }
1056
+ },
1057
+ "required": [
1058
+ "__secretKey",
1059
+ "_lastJobUpdate",
1060
+ "context",
1061
+ "job",
1062
+ "logLevel",
1063
+ "logs",
1064
+ "operationId",
1065
+ "results",
1066
+ "status",
1067
+ "statusDetails",
1068
+ "type",
1069
+ "uuid"
1070
+ ],
1071
+ "type": "object",
1072
+ "$webda": "toDto$auto"
1073
+ },
1074
+ "Input": {
1075
+ "$schema": "http://json-schema.org/draft-07/schema#",
1076
+ "WebdaModel": true,
1077
+ "WebdaPlural": "AsyncOperationActions",
1078
+ "additionalProperties": false,
1079
+ "description": "Operation called asynchronously",
1080
+ "properties": {
1081
+ "__secretKey": {
1082
+ "description": "Secret key to post feedback",
1083
+ "type": "string"
1084
+ },
1085
+ "_lastJobUpdate": {
1086
+ "description": "Last time the job was updated",
1087
+ "type": "number"
1088
+ },
1089
+ "action": {
1090
+ "description": "Expected action for the job\n\nIt should be a verb",
1091
+ "type": "string"
1092
+ },
1093
+ "arguments": {
1094
+ "description": "Arguments of the action",
1095
+ "items": {},
1096
+ "type": "array"
1097
+ },
1098
+ "context": {
1099
+ "description": "Context to call the operation with"
1100
+ },
1101
+ "errorMessage": {
1102
+ "description": "If an error occured it should contain the message",
1103
+ "type": "string"
1104
+ },
1105
+ "errorName": {
1106
+ "description": "If an error occured it should contain the name",
1107
+ "type": "string"
1108
+ },
1109
+ "job": {
1110
+ "description": "Job information"
1111
+ },
1112
+ "logLevel": {
1113
+ "description": "Log level to capture",
1114
+ "enum": [
1115
+ "ERROR",
1116
+ "WARN",
1117
+ "INFO",
1118
+ "DEBUG",
1119
+ "TRACE"
1120
+ ],
1121
+ "type": "string"
1122
+ },
1123
+ "logs": {
1124
+ "description": "Current logs",
1125
+ "items": {
1126
+ "type": "string"
1127
+ },
1128
+ "type": "array"
1129
+ },
1130
+ "operationId": {
1131
+ "description": "Operation to call",
1132
+ "type": "string"
1133
+ },
1134
+ "results": {
1135
+ "description": "Results from the job"
1136
+ },
1137
+ "scheduled": {
1138
+ "description": "Timestamp when the action was scheduled",
1139
+ "type": "number"
1140
+ },
1141
+ "status": {
1142
+ "description": "Current status",
1143
+ "enum": [
1144
+ "RUNNING",
1145
+ "SUCCESS",
1146
+ "ERROR",
1147
+ "QUEUED",
1148
+ "STARTING",
1149
+ "TIMEOUT",
1150
+ "SCHEDULED"
1151
+ ],
1152
+ "type": "string"
1153
+ },
1154
+ "statusDetails": {
1155
+ "description": "Job current status"
1156
+ },
1157
+ "type": {
1158
+ "description": "Type of action",
1159
+ "type": "string"
1160
+ },
1161
+ "uuid": {
1162
+ "description": "UUID of the model",
1163
+ "format": "uuid",
1164
+ "type": "string"
1165
+ }
1166
+ },
1167
+ "required": [
1168
+ "__secretKey",
1169
+ "_lastJobUpdate",
1170
+ "context",
1171
+ "job",
1172
+ "logLevel",
1173
+ "logs",
1174
+ "operationId",
1175
+ "results",
1176
+ "status",
1177
+ "statusDetails",
1178
+ "type",
1179
+ "uuid"
136
1180
  ],
137
- "description": "Current status"
138
- },
139
- "scheduled": {
140
- "type": "number",
141
- "description": "Timestamp when the action was scheduled"
142
- },
143
- "errorMessage": {
144
- "type": "string",
145
- "description": "If an error occured it should contain the message"
146
- },
147
- "errorName": {
148
- "type": "string",
149
- "description": "If an error occured it should contain the name"
150
- },
151
- "job": {
152
- "description": "Job information"
153
- },
154
- "_lastJobUpdate": {
155
- "type": "number",
156
- "description": "Last time the job was updated",
157
- "readOnly": true
158
- },
159
- "results": {
160
- "description": "Results from the job"
161
- },
162
- "statusDetails": {
163
- "description": "Job current status"
164
- },
165
- "type": {
166
- "type": "string"
167
- },
168
- "arguments": {
169
- "type": "array",
170
- "items": {}
171
- },
172
- "logs": {
173
- "type": "array",
174
- "items": {
175
- "type": "string"
1181
+ "type": "object",
1182
+ "$webda": "fromDto$auto"
1183
+ },
1184
+ "Stored": {
1185
+ "$schema": "http://json-schema.org/draft-07/schema#",
1186
+ "WebdaModel": true,
1187
+ "WebdaPlural": "AsyncOperationActions",
1188
+ "additionalProperties": false,
1189
+ "description": "Operation called asynchronously",
1190
+ "properties": {
1191
+ "__secretKey": {
1192
+ "description": "Secret key to post feedback",
1193
+ "type": "string"
1194
+ },
1195
+ "_lastJobUpdate": {
1196
+ "description": "Last time the job was updated",
1197
+ "type": "number"
1198
+ },
1199
+ "action": {
1200
+ "description": "Expected action for the job\n\nIt should be a verb",
1201
+ "type": "string"
1202
+ },
1203
+ "arguments": {
1204
+ "description": "Arguments of the action",
1205
+ "items": {},
1206
+ "type": "array"
1207
+ },
1208
+ "context": {
1209
+ "description": "Context to call the operation with"
1210
+ },
1211
+ "errorMessage": {
1212
+ "description": "If an error occured it should contain the message",
1213
+ "type": "string"
1214
+ },
1215
+ "errorName": {
1216
+ "description": "If an error occured it should contain the name",
1217
+ "type": "string"
1218
+ },
1219
+ "job": {
1220
+ "description": "Job information"
1221
+ },
1222
+ "logLevel": {
1223
+ "description": "Log level to capture",
1224
+ "enum": [
1225
+ "ERROR",
1226
+ "WARN",
1227
+ "INFO",
1228
+ "DEBUG",
1229
+ "TRACE"
1230
+ ],
1231
+ "type": "string"
1232
+ },
1233
+ "logs": {
1234
+ "description": "Current logs",
1235
+ "items": {
1236
+ "type": "string"
1237
+ },
1238
+ "type": "array"
1239
+ },
1240
+ "operationId": {
1241
+ "description": "Operation to call",
1242
+ "type": "string"
1243
+ },
1244
+ "results": {
1245
+ "description": "Results from the job"
1246
+ },
1247
+ "scheduled": {
1248
+ "description": "Timestamp when the action was scheduled",
1249
+ "type": "number"
1250
+ },
1251
+ "status": {
1252
+ "description": "Current status",
1253
+ "enum": [
1254
+ "RUNNING",
1255
+ "SUCCESS",
1256
+ "ERROR",
1257
+ "QUEUED",
1258
+ "STARTING",
1259
+ "TIMEOUT",
1260
+ "SCHEDULED"
1261
+ ],
1262
+ "type": "string"
1263
+ },
1264
+ "statusDetails": {
1265
+ "description": "Job current status"
1266
+ },
1267
+ "type": {
1268
+ "description": "Type of action",
1269
+ "type": "string"
1270
+ },
1271
+ "uuid": {
1272
+ "description": "UUID of the model",
1273
+ "format": "uuid",
1274
+ "type": "string"
1275
+ }
176
1276
  },
177
- "description": "Current logs"
178
- },
179
- "action": {
180
- "type": "string",
181
- "description": "Expected action for the job\n\nIt should be a verb"
1277
+ "required": [
1278
+ "__secretKey",
1279
+ "_lastJobUpdate",
1280
+ "context",
1281
+ "job",
1282
+ "logLevel",
1283
+ "logs",
1284
+ "operationId",
1285
+ "results",
1286
+ "status",
1287
+ "statusDetails",
1288
+ "type",
1289
+ "uuid"
1290
+ ],
1291
+ "type": "object",
1292
+ "$webda": "toJSON$return"
182
1293
  }
183
1294
  },
184
- "required": [
185
- "uuid",
186
- "status",
187
- "job",
188
- "results",
189
- "statusDetails",
190
- "type",
191
- "logs"
192
- ],
193
- "description": "Define here a model that can be used along with Store service",
194
- "$schema": "http://json-schema.org/draft-07/schema#",
195
- "title": "AsyncAction"
196
- },
197
- "Webda/AsyncJobService": {
198
- "type": "object",
199
- "properties": {
200
- "type": {
201
- "type": "string",
202
- "description": "Type of the service"
203
- },
204
- "url": {
205
- "type": "string",
206
- "description": "URL to expose job status report hook",
207
- "default": "/async"
208
- },
209
- "localLaunch": {
210
- "type": "boolean",
211
- "description": "If set runner will be called without queue",
212
- "default": false
213
- },
214
- "queue": {
215
- "type": "string",
216
- "description": "Queue to post execution to",
217
- "default": "AsyncActionsQueue"
218
- },
219
- "fallbackOnFirst": {
220
- "type": "boolean",
221
- "description": "Fallback on first runner if none match",
222
- "default": false
223
- },
224
- "runners": {
225
- "type": "array",
226
- "items": {
227
- "type": "string"
228
- },
229
- "description": "Runners to use"
230
- },
231
- "concurrencyLimit": {
232
- "type": "number",
233
- "description": "Limit the maximum number of jobs running in //"
234
- },
235
- "onlyHttpHook": {
236
- "type": "boolean",
237
- "description": "Define if we should only use an http hook and not rely on store for AsyncOperation",
238
- "default": false
239
- },
240
- "includeCron": {
241
- "type": "boolean",
242
- "description": "Include Cron annotation to launch them as AsyncOperationAction",
243
- "default": true
244
- },
245
- "includeSchedulerInWorker": {
246
- "type": "boolean",
247
- "description": "Include the scheduler system in the worker"
248
- },
249
- "schedulerResolution": {
250
- "type": "number",
251
- "description": "Schedule action resolution\n\nIf set to 1000ms, you can schedule action per second by default it resolve per minute",
252
- "default": 60000
253
- },
254
- "logsLimit": {
255
- "type": "number",
256
- "description": "Limit the number of lines of logs available for an async action\n\nIf you need to store large amount of logs then you should use the CloudWatchLogger or similar logger",
257
- "default": 500
258
- },
259
- "asyncActionModel": {
260
- "type": "string",
261
- "description": "Model to use when launching async action",
262
- "default": "Webda/AsyncWebdaAction"
263
- },
264
- "asyncOperationModel": {
265
- "type": "string",
266
- "description": "Model to use when launching async operation",
267
- "default": "Webda/AsyncOperationAction"
268
- },
269
- "asyncOperationDefinition": {
270
- "type": "string",
271
- "description": "JSON file of the AsyncOperation definition\n\nGenerated with `webda operations operations.json`"
272
- },
273
- "openapi": {
274
- "type": "object",
275
- "additionalProperties": true
1295
+ "Actions": {
1296
+ "status": {
1297
+ "handler": "statusAction"
276
1298
  }
277
1299
  },
278
- "required": [
279
- "fallbackOnFirst",
280
- "logsLimit",
281
- "queue",
282
- "runners",
283
- "type",
284
- "url"
1300
+ "Events": [
1301
+ "Create",
1302
+ "PartialUpdate",
1303
+ "Delete",
1304
+ "Update",
1305
+ "Patch",
1306
+ "Query",
1307
+ "Created",
1308
+ "PartialUpdated",
1309
+ "Deleted",
1310
+ "Patched",
1311
+ "Updated",
1312
+ "Queried"
285
1313
  ],
286
- "$schema": "http://json-schema.org/draft-07/schema#",
287
- "title": "AsyncJobService"
1314
+ "PrimaryKey": [
1315
+ "uuid"
1316
+ ],
1317
+ "Identifier": "Webda/AsyncOperationAction"
288
1318
  },
289
- "Webda/AsyncOperationAction": {
290
- "type": "object",
291
- "properties": {
292
- "_creationDate": {
293
- "type": "string",
294
- "format": "date-time",
295
- "description": "Creation date",
296
- "readOnly": true
297
- },
298
- "_lastUpdate": {
299
- "type": "string",
300
- "format": "date-time",
301
- "description": "Last update date",
302
- "readOnly": true
1319
+ "Webda/AsyncWebdaAction": {
1320
+ "Plural": "AsyncWebdaActions",
1321
+ "Import": "lib/asyncaction.model:AsyncWebdaAction",
1322
+ "Relations": {},
1323
+ "Ancestors": [
1324
+ "Webda/AsyncAction"
1325
+ ],
1326
+ "Subclasses": [],
1327
+ "Reflection": {
1328
+ "logLevel": {
1329
+ "type": "WorkerLogLevel"
303
1330
  },
304
- "uuid": {
305
- "type": "string",
306
- "description": "Action uuid"
1331
+ "serviceName": {
1332
+ "type": "string"
1333
+ },
1334
+ "method": {
1335
+ "type": "string"
307
1336
  },
308
1337
  "status": {
309
- "type": "string",
310
- "enum": [
311
- "RUNNING",
312
- "SUCCESS",
313
- "ERROR",
314
- "QUEUED",
315
- "STARTING",
316
- "TIMEOUT",
317
- "SCHEDULED"
318
- ],
319
- "description": "Current status"
1338
+ "type": "\"RUNNING\" | \"SUCCESS\" | \"ERROR\" | \"QUEUED\" | \"STARTING\" | \"TIMEOUT\" | \"SCHEDULED\""
320
1339
  },
321
1340
  "scheduled": {
322
- "type": "number",
323
- "description": "Timestamp when the action was scheduled"
1341
+ "type": "number"
324
1342
  },
325
1343
  "errorMessage": {
326
- "type": "string",
327
- "description": "If an error occured it should contain the message"
1344
+ "type": "string"
328
1345
  },
329
1346
  "errorName": {
330
- "type": "string",
331
- "description": "If an error occured it should contain the name"
1347
+ "type": "string"
332
1348
  },
333
1349
  "job": {
334
- "description": "Job information"
1350
+ "type": "any"
335
1351
  },
336
1352
  "_lastJobUpdate": {
337
- "type": "number",
338
- "description": "Last time the job was updated",
339
- "readOnly": true
1353
+ "type": "number"
340
1354
  },
341
1355
  "results": {
342
- "description": "Results from the job"
1356
+ "type": "any"
343
1357
  },
344
1358
  "statusDetails": {
345
- "description": "Job current status"
1359
+ "type": "any"
346
1360
  },
347
1361
  "type": {
348
1362
  "type": "string"
349
1363
  },
350
1364
  "arguments": {
351
- "type": "array",
352
- "items": {}
1365
+ "type": "Array",
1366
+ "typeParameters": [
1367
+ "any"
1368
+ ]
353
1369
  },
354
1370
  "logs": {
355
- "type": "array",
356
- "items": {
357
- "type": "string"
358
- },
359
- "description": "Current logs"
1371
+ "type": "Array",
1372
+ "typeParameters": [
1373
+ "string"
1374
+ ]
1375
+ },
1376
+ "__secretKey": {
1377
+ "type": "string"
360
1378
  },
361
1379
  "action": {
362
- "type": "string",
363
- "description": "Expected action for the job\n\nIt should be a verb"
1380
+ "type": "\"STOP\" | string"
364
1381
  },
365
- "operationId": {
1382
+ "uuid": {
366
1383
  "type": "string"
367
- },
368
- "context": {
1384
+ }
1385
+ },
1386
+ "Schemas": {
1387
+ "Output": {
1388
+ "$schema": "http://json-schema.org/draft-07/schema#",
1389
+ "WebdaModel": true,
1390
+ "WebdaPlural": "AsyncWebdaActions",
1391
+ "additionalProperties": false,
1392
+ "description": "Define a Webda Async Action",
1393
+ "properties": {
1394
+ "__secretKey": {
1395
+ "description": "Secret key to post feedback",
1396
+ "type": "string"
1397
+ },
1398
+ "_lastJobUpdate": {
1399
+ "description": "Last time the job was updated",
1400
+ "type": "number"
1401
+ },
1402
+ "action": {
1403
+ "description": "Expected action for the job\n\nIt should be a verb",
1404
+ "type": "string"
1405
+ },
1406
+ "arguments": {
1407
+ "description": "Arguments of the action",
1408
+ "items": {},
1409
+ "type": "array"
1410
+ },
1411
+ "errorMessage": {
1412
+ "description": "If an error occured it should contain the message",
1413
+ "type": "string"
1414
+ },
1415
+ "errorName": {
1416
+ "description": "If an error occured it should contain the name",
1417
+ "type": "string"
1418
+ },
1419
+ "job": {
1420
+ "description": "Job information"
1421
+ },
1422
+ "logLevel": {
1423
+ "description": "Log level to capture",
1424
+ "enum": [
1425
+ "ERROR",
1426
+ "WARN",
1427
+ "INFO",
1428
+ "DEBUG",
1429
+ "TRACE"
1430
+ ],
1431
+ "type": "string"
1432
+ },
1433
+ "logs": {
1434
+ "description": "Current logs",
1435
+ "items": {
1436
+ "type": "string"
1437
+ },
1438
+ "type": "array"
1439
+ },
1440
+ "method": {
1441
+ "description": "Method to call",
1442
+ "type": "string"
1443
+ },
1444
+ "results": {
1445
+ "description": "Results from the job"
1446
+ },
1447
+ "scheduled": {
1448
+ "description": "Timestamp when the action was scheduled",
1449
+ "type": "number"
1450
+ },
1451
+ "serviceName": {
1452
+ "description": "Service to call",
1453
+ "type": "string"
1454
+ },
1455
+ "status": {
1456
+ "description": "Current status",
1457
+ "enum": [
1458
+ "RUNNING",
1459
+ "SUCCESS",
1460
+ "ERROR",
1461
+ "QUEUED",
1462
+ "STARTING",
1463
+ "TIMEOUT",
1464
+ "SCHEDULED"
1465
+ ],
1466
+ "type": "string"
1467
+ },
1468
+ "statusDetails": {
1469
+ "description": "Job current status"
1470
+ },
1471
+ "type": {
1472
+ "description": "Type of action",
1473
+ "type": "string"
1474
+ },
1475
+ "uuid": {
1476
+ "description": "UUID of the model",
1477
+ "format": "uuid",
1478
+ "type": "string"
1479
+ }
1480
+ },
1481
+ "required": [
1482
+ "__secretKey",
1483
+ "_lastJobUpdate",
1484
+ "job",
1485
+ "logLevel",
1486
+ "logs",
1487
+ "results",
1488
+ "status",
1489
+ "statusDetails",
1490
+ "type",
1491
+ "uuid"
1492
+ ],
369
1493
  "type": "object",
1494
+ "$webda": "toDto$auto"
1495
+ },
1496
+ "Input": {
1497
+ "$schema": "http://json-schema.org/draft-07/schema#",
1498
+ "WebdaModel": true,
1499
+ "WebdaPlural": "AsyncWebdaActions",
1500
+ "additionalProperties": false,
1501
+ "description": "Define a Webda Async Action",
370
1502
  "properties": {
371
- "_promises": {
372
- "type": "array",
1503
+ "__secretKey": {
1504
+ "description": "Secret key to post feedback",
1505
+ "type": "string"
1506
+ },
1507
+ "_lastJobUpdate": {
1508
+ "description": "Last time the job was updated",
1509
+ "type": "number"
1510
+ },
1511
+ "action": {
1512
+ "description": "Expected action for the job\n\nIt should be a verb",
1513
+ "type": "string"
1514
+ },
1515
+ "arguments": {
1516
+ "description": "Arguments of the action",
373
1517
  "items": {},
374
- "description": "Contain all registered promises to this context",
375
- "readOnly": true
1518
+ "type": "array"
376
1519
  },
377
- "parameters": {},
378
- "_stream": {
379
- "type": "object",
380
- "properties": {
381
- "writable": {
382
- "type": "boolean",
383
- "description": "Is `true` if it is safe to call `writable.write()`, which means the stream has not been destroyed, errored, or ended."
384
- },
385
- "writableEnded": {
386
- "type": "boolean",
387
- "description": "Is `true` after `writable.end()` has been called. This property does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead."
388
- },
389
- "writableFinished": {
390
- "type": "boolean",
391
- "description": "Is set to `true` immediately before the `'finish'` event is emitted."
392
- },
393
- "writableHighWaterMark": {
394
- "type": "number",
395
- "description": "Return the value of `highWaterMark` passed when creating this `Writable`."
396
- },
397
- "writableLength": {
398
- "type": "number",
399
- "description": "This property contains the number of bytes (or objects) in the queue ready to be written. The value provides introspection data regarding the status of the `highWaterMark`."
400
- },
401
- "writableObjectMode": {
402
- "type": "boolean",
403
- "description": "Getter for the property `objectMode` of a given `Writable` stream."
404
- },
405
- "writableCorked": {
406
- "type": "number",
407
- "description": "Number of times `writable.uncork()` needs to be called in order to fully uncork the stream."
408
- },
409
- "destroyed": {
410
- "type": "boolean",
411
- "description": "Is `true` after `writable.destroy()` has been called."
412
- },
413
- "closed": {
414
- "type": "boolean",
415
- "description": "Is `true` after `'close'` has been emitted."
416
- },
417
- "errored": {
418
- "anyOf": [
419
- {
420
- "type": "object",
421
- "properties": {
422
- "name": {
423
- "type": "string"
424
- },
425
- "message": {
426
- "type": "string"
427
- },
428
- "stack": {
429
- "type": "string"
430
- }
431
- },
432
- "required": [
433
- "name",
434
- "message"
435
- ]
436
- },
437
- {
438
- "type": "null"
439
- }
440
- ],
441
- "description": "Returns error if the stream has been destroyed with an error."
442
- },
443
- "writableNeedDrain": {
444
- "type": "boolean",
445
- "description": "Is `true` if the stream's buffer has been full and stream will emit `'drain'`."
446
- }
1520
+ "errorMessage": {
1521
+ "description": "If an error occured it should contain the message",
1522
+ "type": "string"
1523
+ },
1524
+ "errorName": {
1525
+ "description": "If an error occured it should contain the name",
1526
+ "type": "string"
1527
+ },
1528
+ "job": {
1529
+ "description": "Job information"
1530
+ },
1531
+ "logLevel": {
1532
+ "description": "Log level to capture",
1533
+ "enum": [
1534
+ "ERROR",
1535
+ "WARN",
1536
+ "INFO",
1537
+ "DEBUG",
1538
+ "TRACE"
1539
+ ],
1540
+ "type": "string"
1541
+ },
1542
+ "logs": {
1543
+ "description": "Current logs",
1544
+ "items": {
1545
+ "type": "string"
1546
+ },
1547
+ "type": "array"
1548
+ },
1549
+ "method": {
1550
+ "description": "Method to call",
1551
+ "type": "string"
1552
+ },
1553
+ "results": {
1554
+ "description": "Results from the job"
1555
+ },
1556
+ "scheduled": {
1557
+ "description": "Timestamp when the action was scheduled",
1558
+ "type": "number"
1559
+ },
1560
+ "serviceName": {
1561
+ "description": "Service to call",
1562
+ "type": "string"
1563
+ },
1564
+ "status": {
1565
+ "description": "Current status",
1566
+ "enum": [
1567
+ "RUNNING",
1568
+ "SUCCESS",
1569
+ "ERROR",
1570
+ "QUEUED",
1571
+ "STARTING",
1572
+ "TIMEOUT",
1573
+ "SCHEDULED"
1574
+ ],
1575
+ "type": "string"
1576
+ },
1577
+ "statusDetails": {
1578
+ "description": "Job current status"
1579
+ },
1580
+ "type": {
1581
+ "description": "Type of action",
1582
+ "type": "string"
1583
+ },
1584
+ "uuid": {
1585
+ "description": "UUID of the model",
1586
+ "format": "uuid",
1587
+ "type": "string"
1588
+ }
1589
+ },
1590
+ "required": [
1591
+ "__secretKey",
1592
+ "_lastJobUpdate",
1593
+ "job",
1594
+ "logLevel",
1595
+ "logs",
1596
+ "results",
1597
+ "status",
1598
+ "statusDetails",
1599
+ "type",
1600
+ "uuid"
1601
+ ],
1602
+ "type": "object",
1603
+ "$webda": "fromDto$auto"
1604
+ },
1605
+ "Stored": {
1606
+ "$schema": "http://json-schema.org/draft-07/schema#",
1607
+ "WebdaModel": true,
1608
+ "WebdaPlural": "AsyncWebdaActions",
1609
+ "additionalProperties": false,
1610
+ "description": "Define a Webda Async Action",
1611
+ "properties": {
1612
+ "__secretKey": {
1613
+ "description": "Secret key to post feedback",
1614
+ "type": "string"
1615
+ },
1616
+ "_lastJobUpdate": {
1617
+ "description": "Last time the job was updated",
1618
+ "type": "number"
1619
+ },
1620
+ "action": {
1621
+ "description": "Expected action for the job\n\nIt should be a verb",
1622
+ "type": "string"
1623
+ },
1624
+ "arguments": {
1625
+ "description": "Arguments of the action",
1626
+ "items": {},
1627
+ "type": "array"
1628
+ },
1629
+ "errorMessage": {
1630
+ "description": "If an error occured it should contain the message",
1631
+ "type": "string"
1632
+ },
1633
+ "errorName": {
1634
+ "description": "If an error occured it should contain the name",
1635
+ "type": "string"
1636
+ },
1637
+ "job": {
1638
+ "description": "Job information"
1639
+ },
1640
+ "logLevel": {
1641
+ "description": "Log level to capture",
1642
+ "enum": [
1643
+ "ERROR",
1644
+ "WARN",
1645
+ "INFO",
1646
+ "DEBUG",
1647
+ "TRACE"
1648
+ ],
1649
+ "type": "string"
1650
+ },
1651
+ "logs": {
1652
+ "description": "Current logs",
1653
+ "items": {
1654
+ "type": "string"
447
1655
  },
448
- "required": [
449
- "closed",
450
- "destroyed",
451
- "errored",
452
- "writable",
453
- "writableCorked",
454
- "writableEnded",
455
- "writableFinished",
456
- "writableHighWaterMark",
457
- "writableLength",
458
- "writableNeedDrain",
459
- "writableObjectMode"
1656
+ "type": "array"
1657
+ },
1658
+ "method": {
1659
+ "description": "Method to call",
1660
+ "type": "string"
1661
+ },
1662
+ "results": {
1663
+ "description": "Results from the job"
1664
+ },
1665
+ "scheduled": {
1666
+ "description": "Timestamp when the action was scheduled",
1667
+ "type": "number"
1668
+ },
1669
+ "serviceName": {
1670
+ "description": "Service to call",
1671
+ "type": "string"
1672
+ },
1673
+ "status": {
1674
+ "description": "Current status",
1675
+ "enum": [
1676
+ "RUNNING",
1677
+ "SUCCESS",
1678
+ "ERROR",
1679
+ "QUEUED",
1680
+ "STARTING",
1681
+ "TIMEOUT",
1682
+ "SCHEDULED"
460
1683
  ],
461
- "description": "Output stream",
462
- "readOnly": true
1684
+ "type": "string"
1685
+ },
1686
+ "statusDetails": {
1687
+ "description": "Job current status"
1688
+ },
1689
+ "type": {
1690
+ "description": "Type of action",
1691
+ "type": "string"
1692
+ },
1693
+ "uuid": {
1694
+ "description": "UUID of the model",
1695
+ "format": "uuid",
1696
+ "type": "string"
463
1697
  }
464
1698
  },
465
1699
  "required": [
466
- "parameters"
467
- ],
468
- "description": "OperationContext is used when call to an operation"
469
- },
470
- "logLevel": {
471
- "$ref": "#/definitions/WorkerLogLevel"
472
- }
473
- },
474
- "required": [
475
- "context",
476
- "job",
477
- "logLevel",
478
- "logs",
479
- "operationId",
480
- "results",
481
- "status",
482
- "statusDetails",
483
- "type",
484
- "uuid"
485
- ],
486
- "description": "Operation called asynchronously",
487
- "$schema": "http://json-schema.org/draft-07/schema#",
488
- "definitions": {
489
- "WorkerLogLevel": {
490
- "type": "string",
491
- "enum": [
492
- "ERROR",
493
- "WARN",
494
- "INFO",
495
- "DEBUG",
496
- "TRACE"
1700
+ "__secretKey",
1701
+ "_lastJobUpdate",
1702
+ "job",
1703
+ "logLevel",
1704
+ "logs",
1705
+ "results",
1706
+ "status",
1707
+ "statusDetails",
1708
+ "type",
1709
+ "uuid"
497
1710
  ],
498
- "description": "LogLevel as intersection to compare with integer values"
1711
+ "type": "object",
1712
+ "$webda": "toJSON$return"
499
1713
  }
500
1714
  },
501
- "title": "AsyncOperationAction"
502
- },
503
- "Webda/AsyncWebdaAction": {
504
- "type": "object",
505
- "properties": {
506
- "_creationDate": {
507
- "type": "string",
508
- "format": "date-time",
509
- "description": "Creation date",
510
- "readOnly": true
511
- },
512
- "_lastUpdate": {
513
- "type": "string",
514
- "format": "date-time",
515
- "description": "Last update date",
516
- "readOnly": true
517
- },
518
- "uuid": {
519
- "type": "string",
520
- "description": "Action uuid"
521
- },
1715
+ "Actions": {
522
1716
  "status": {
523
- "type": "string",
524
- "enum": [
525
- "RUNNING",
526
- "SUCCESS",
527
- "ERROR",
528
- "QUEUED",
529
- "STARTING",
530
- "TIMEOUT",
531
- "SCHEDULED"
532
- ],
533
- "description": "Current status"
534
- },
535
- "scheduled": {
536
- "type": "number",
537
- "description": "Timestamp when the action was scheduled"
538
- },
539
- "errorMessage": {
540
- "type": "string",
541
- "description": "If an error occured it should contain the message"
542
- },
543
- "errorName": {
544
- "type": "string",
545
- "description": "If an error occured it should contain the name"
546
- },
547
- "job": {
548
- "description": "Job information"
549
- },
550
- "_lastJobUpdate": {
551
- "type": "number",
552
- "description": "Last time the job was updated",
553
- "readOnly": true
554
- },
555
- "results": {
556
- "description": "Results from the job"
557
- },
558
- "statusDetails": {
559
- "description": "Job current status"
560
- },
561
- "type": {
562
- "type": "string"
563
- },
564
- "arguments": {
565
- "type": "array",
566
- "items": {}
567
- },
568
- "logs": {
569
- "type": "array",
570
- "items": {
571
- "type": "string"
572
- },
573
- "description": "Current logs"
574
- },
575
- "action": {
576
- "type": "string",
577
- "description": "Expected action for the job\n\nIt should be a verb"
578
- },
579
- "logLevel": {
580
- "$ref": "#/definitions/WorkerLogLevel"
581
- },
582
- "serviceName": {
583
- "type": "string",
584
- "description": "service to call"
585
- },
586
- "method": {
587
- "type": "string",
588
- "description": "method to call"
1717
+ "handler": "statusAction"
589
1718
  }
590
1719
  },
591
- "required": [
592
- "job",
593
- "logLevel",
594
- "logs",
595
- "results",
596
- "status",
597
- "statusDetails",
598
- "type",
1720
+ "Events": [
1721
+ "Create",
1722
+ "PartialUpdate",
1723
+ "Delete",
1724
+ "Update",
1725
+ "Patch",
1726
+ "Query",
1727
+ "Created",
1728
+ "PartialUpdated",
1729
+ "Deleted",
1730
+ "Patched",
1731
+ "Updated",
1732
+ "Queried"
1733
+ ],
1734
+ "PrimaryKey": [
599
1735
  "uuid"
600
1736
  ],
601
- "description": "Define a Webda Async Action",
602
- "$schema": "http://json-schema.org/draft-07/schema#",
603
- "definitions": {
604
- "WorkerLogLevel": {
605
- "type": "string",
606
- "enum": [
607
- "ERROR",
608
- "WARN",
609
- "INFO",
610
- "DEBUG",
611
- "TRACE"
612
- ],
613
- "description": "LogLevel as intersection to compare with integer values"
614
- }
615
- },
616
- "title": "AsyncWebdaAction"
617
- },
1737
+ "Identifier": "Webda/AsyncWebdaAction"
1738
+ }
1739
+ },
1740
+ "schemas": {
618
1741
  "Webda/BinaryFile": {
619
- "type": "object",
1742
+ "$schema": "http://json-schema.org/draft-07/schema#",
1743
+ "WebdaSchema": true,
1744
+ "additionalProperties": false,
1745
+ "description": "Represent a file to store",
620
1746
  "properties": {
621
- "hash": {
622
- "type": "string",
623
- "description": "Will be computed by the service\n\nhash of the content"
624
- },
625
1747
  "challenge": {
626
- "type": "string",
627
- "description": "Will be computed by the service\n\nhash of the content prefixed by 'WEBDA'"
1748
+ "description": "Will be computed by the service\n\nhash of the content prefixed by 'WEBDA'",
1749
+ "type": "string"
628
1750
  },
629
- "size": {
630
- "type": "number",
631
- "description": "Size of the binary"
1751
+ "hash": {
1752
+ "description": "Will be computed by the service\n\nhash of the content",
1753
+ "type": "string"
632
1754
  },
633
- "name": {
634
- "type": "string",
635
- "description": "Current name"
1755
+ "metadata": {
1756
+ "description": "Metadatas stored along with the binary"
636
1757
  },
637
1758
  "mimetype": {
638
- "type": "string",
639
- "description": "Mimetype of the binary"
1759
+ "description": "Mimetype of the binary",
1760
+ "type": "string"
640
1761
  },
641
- "metadata": {
642
- "description": "Metadatas stored along with the binary"
1762
+ "name": {
1763
+ "description": "Current name",
1764
+ "type": "string"
643
1765
  },
644
1766
  "originalname": {
645
- "type": "string",
646
- "description": "Original name"
1767
+ "description": "Original name",
1768
+ "type": "string"
1769
+ },
1770
+ "size": {
1771
+ "description": "Size of the binary",
1772
+ "type": "number"
647
1773
  }
648
1774
  },
649
1775
  "required": [
@@ -651,361 +1777,270 @@
651
1777
  "name",
652
1778
  "size"
653
1779
  ],
654
- "description": "Represent a file to store",
655
- "$schema": "http://json-schema.org/draft-07/schema#",
1780
+ "type": "object",
656
1781
  "title": "BinaryFile"
657
1782
  },
658
- "Webda/LocalRunner": {
1783
+ "Webda/AsyncAction.status.input": {
659
1784
  "type": "object",
660
1785
  "properties": {
661
- "type": {
662
- "type": "string",
663
- "description": "Type of the service"
664
- },
665
- "url": {
666
- "type": "string",
667
- "description": "URL on which to serve the content"
668
- },
669
- "actions": {
670
- "type": "array",
671
- "items": {
672
- "type": "string"
673
- },
674
- "description": "Actions managed by the runner",
675
- "default": []
676
- },
677
- "command": {
678
- "type": "string",
679
- "description": "Command to launch"
680
- },
681
- "args": {
682
- "type": "array",
683
- "items": {
684
- "type": "string"
685
- },
686
- "description": "Args"
687
- },
688
- "options": {
689
- "type": "object",
1786
+ "context": {
1787
+ "additionalProperties": false,
1788
+ "description": "OperationContext is used when call to an operation",
1789
+ "param": [
1790
+ "T type of input for this context",
1791
+ "U type of output for this context",
1792
+ "P type of parameters for this context"
1793
+ ],
690
1794
  "properties": {
691
- "signal": {
692
- "type": "object",
693
- "properties": {
694
- "aborted": {
695
- "type": "boolean"
696
- },
697
- "onabort": {
698
- "anyOf": [
699
- {},
700
- {
701
- "type": "null"
702
- }
703
- ]
704
- },
705
- "reason": {}
1795
+ "_promises": {
1796
+ "description": "Contain all registered promises to this context",
1797
+ "items": {
1798
+ "$ref": "#/definitions/Promise%3Cany%3E"
706
1799
  },
707
- "required": [
708
- "aborted",
709
- "onabort",
710
- "reason"
711
- ],
712
- "description": "When provided the corresponding `AbortController` can be used to cancel an asynchronous action."
713
- },
714
- "serialization": {
715
- "$ref": "#/definitions/SerializationType",
716
- "description": "Specify the kind of serialization used for sending messages between processes.",
717
- "default": "json"
718
- },
719
- "killSignal": {
720
- "anyOf": [
721
- {
722
- "$ref": "#/definitions/global.NodeJS.Signals"
723
- },
724
- {
725
- "type": "number"
726
- }
727
- ],
728
- "description": "The signal value to be used when the spawned process will be killed by the abort signal.",
729
- "default": "SIGTERM"
730
- },
731
- "timeout": {
732
- "type": "number",
733
- "default": 0
734
- },
735
- "uid": {
736
- "type": "number"
1800
+ "type": "array"
737
1801
  },
738
- "gid": {
739
- "type": "number"
740
- },
741
- "cwd": {
742
- "anyOf": [
743
- {
744
- "type": "string"
745
- },
746
- {
747
- "type": "object",
748
- "properties": {
749
- "hash": {
750
- "type": "string",
751
- "description": "Gets and sets the fragment portion of the URL.\n\n```js const myURL = new URL('https://example.org/foo#bar'); console.log(myURL.hash); // Prints #bar\n\nmyURL.hash = 'baz'; console.log(myURL.href); // Prints https://example.org/foo#baz ```\n\nInvalid URL characters included in the value assigned to the `hash` property are `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse } and {@link format } methods would produce."
752
- },
753
- "host": {
754
- "type": "string",
755
- "description": "Gets and sets the host portion of the URL.\n\n```js const myURL = new URL('https://example.org:81/foo'); console.log(myURL.host); // Prints example.org:81\n\nmyURL.host = 'example.com:82'; console.log(myURL.href); // Prints https://example.com:82/foo ```\n\nInvalid host values assigned to the `host` property are ignored."
756
- },
757
- "hostname": {
758
- "type": "string",
759
- "description": "Gets and sets the host name portion of the URL. The key difference between`url.host` and `url.hostname` is that `url.hostname` does _not_ include the port.\n\n```js const myURL = new URL('https://example.org:81/foo'); console.log(myURL.hostname); // Prints example.org\n\n// Setting the hostname does not change the port myURL.hostname = 'example.com'; console.log(myURL.href); // Prints https://example.com:81/foo\n\n// Use myURL.host to change the hostname and port myURL.host = 'example.org:82'; console.log(myURL.href); // Prints https://example.org:82/foo ```\n\nInvalid host name values assigned to the `hostname` property are ignored."
760
- },
761
- "href": {
762
- "type": "string",
763
- "description": "Gets and sets the serialized URL.\n\n```js const myURL = new URL('https://example.org/foo'); console.log(myURL.href); // Prints https://example.org/foo\n\nmyURL.href = 'https://example.com/bar'; console.log(myURL.href); // Prints https://example.com/bar ```\n\nGetting the value of the `href` property is equivalent to calling {@link toString } .\n\nSetting the value of this property to a new value is equivalent to creating a new `URL` object using `new URL(value)`. Each of the `URL`object's properties will be modified.\n\nIf the value assigned to the `href` property is not a valid URL, a `TypeError`will be thrown."
764
- },
765
- "origin": {
766
- "type": "string",
767
- "description": "Gets the read-only serialization of the URL's origin.\n\n```js const myURL = new URL('https://example.org/foo/bar?baz'); console.log(myURL.origin); // Prints https://example.org ```\n\n```js const idnURL = new URL('https://測試'); console.log(idnURL.origin); // Prints https://xn--g6w251d\n\nconsole.log(idnURL.hostname); // Prints xn--g6w251d ```"
768
- },
769
- "password": {
770
- "type": "string",
771
- "description": "Gets and sets the password portion of the URL.\n\n```js const myURL = new URL('https://abc:xyz@example.com'); console.log(myURL.password); // Prints xyz\n\nmyURL.password = '123'; console.log(myURL.href); // Prints https://abc:123@example.com/ ```\n\nInvalid URL characters included in the value assigned to the `password` property are `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse } and {@link format } methods would produce."
772
- },
773
- "pathname": {
774
- "type": "string",
775
- "description": "Gets and sets the path portion of the URL.\n\n```js const myURL = new URL('https://example.org/abc/xyz?123'); console.log(myURL.pathname); // Prints /abc/xyz\n\nmyURL.pathname = '/abcdef'; console.log(myURL.href); // Prints https://example.org/abcdef?123 ```\n\nInvalid URL characters included in the value assigned to the `pathname`property are `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse } and {@link format } methods would produce."
776
- },
777
- "port": {
778
- "type": "string",
779
- "description": "Gets and sets the port portion of the URL.\n\nThe port value may be a number or a string containing a number in the range`0` to `65535` (inclusive). Setting the value to the default port of the`URL` objects given `protocol` will result in the `port` value becoming the empty string (`''`).\n\nThe port value can be an empty string in which case the port depends on the protocol/scheme:\n\n<omitted>\n\nUpon assigning a value to the port, the value will first be converted to a string using `.toString()`.\n\nIf that string is invalid but it begins with a number, the leading number is assigned to `port`. If the number lies outside the range denoted above, it is ignored.\n\n```js const myURL = new URL('https://example.org:8888'); console.log(myURL.port); // Prints 8888\n\n// Default ports are automatically transformed to the empty string // (HTTPS protocol's default port is 443) myURL.port = '443'; console.log(myURL.port); // Prints the empty string console.log(myURL.href); // Prints https://example.org/\n\nmyURL.port = 1234; console.log(myURL.port); // Prints 1234 console.log(myURL.href); // Prints https://example.org:1234/\n\n// Completely invalid port strings are ignored myURL.port = 'abcd'; console.log(myURL.port); // Prints 1234\n\n// Leading numbers are treated as a port number myURL.port = '5678abcd'; console.log(myURL.port); // Prints 5678\n\n// Non-integers are truncated myURL.port = 1234.5678; console.log(myURL.port); // Prints 1234\n\n// Out-of-range numbers which are not represented in scientific notation // will be ignored. myURL.port = 1e10; // 10000000000, will be range-checked as described below console.log(myURL.port); // Prints 1234 ```\n\nNumbers which contain a decimal point, such as floating-point numbers or numbers in scientific notation, are not an exception to this rule. Leading numbers up to the decimal point will be set as the URL's port, assuming they are valid:\n\n```js myURL.port = 4.567e21; console.log(myURL.port); // Prints 4 (because it is the leading number in the string '4.567e21') ```"
780
- },
781
- "protocol": {
782
- "type": "string",
783
- "description": "Gets and sets the protocol portion of the URL.\n\n```js const myURL = new URL('https://example.org'); console.log(myURL.protocol); // Prints https:\n\nmyURL.protocol = 'ftp'; console.log(myURL.href); // Prints ftp://example.org/ ```\n\nInvalid URL protocol values assigned to the `protocol` property are ignored."
784
- },
785
- "search": {
786
- "type": "string",
787
- "description": "Gets and sets the serialized query portion of the URL.\n\n```js const myURL = new URL('https://example.org/abc?123'); console.log(myURL.search); // Prints ?123\n\nmyURL.search = 'abc=xyz'; console.log(myURL.href); // Prints https://example.org/abc?abc=xyz ```\n\nAny invalid URL characters appearing in the value assigned the `search`property will be `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse } and {@link format } methods would produce."
788
- },
789
- "searchParams": {
790
- "type": "object",
791
- "properties": {
792
- "size": {
793
- "type": "number",
794
- "description": "The total number of parameter entries."
795
- }
796
- },
797
- "required": [
798
- "size"
799
- ],
800
- "description": "Gets the `URLSearchParams` object representing the query parameters of the URL. This property is read-only but the `URLSearchParams` object it provides can be used to mutate the URL instance; to replace the entirety of query parameters of the URL, use the {@link search } setter. See `URLSearchParams` documentation for details.\n\nUse care when using `.searchParams` to modify the `URL` because, per the WHATWG specification, the `URLSearchParams` object uses different rules to determine which characters to percent-encode. For instance, the `URL` object will not percent encode the ASCII tilde (`~`) character, while `URLSearchParams` will always encode it:\n\n```js const myURL = new URL('https://example.org/abc?foo=~bar');\n\nconsole.log(myURL.search); // prints ?foo=~bar\n\n// Modify the URL via searchParams... myURL.searchParams.sort();\n\nconsole.log(myURL.search); // prints ?foo=%7Ebar ```"
801
- },
802
- "username": {
803
- "type": "string",
804
- "description": "Gets and sets the username portion of the URL.\n\n```js const myURL = new URL('https://abc:xyz@example.com'); console.log(myURL.username); // Prints abc\n\nmyURL.username = '123'; console.log(myURL.href); // Prints https://123:xyz@example.com/ ```\n\nAny invalid URL characters appearing in the value assigned the `username`property will be `percent-encoded`. The selection of which characters to percent-encode may vary somewhat from what the {@link parse } and {@link format } methods would produce."
805
- }
806
- },
807
- "required": [
808
- "hash",
809
- "host",
810
- "hostname",
811
- "href",
812
- "origin",
813
- "password",
814
- "pathname",
815
- "port",
816
- "protocol",
817
- "search",
818
- "searchParams",
819
- "username"
820
- ],
821
- "description": "Browser-compatible `URL` class, implemented by following the WHATWG URL Standard. [Examples of parsed URLs](https://url.spec.whatwg.org/#example-url-parsing) may be found in the Standard itself. The `URL` class is also available on the global object.\n\nIn accordance with browser conventions, all properties of `URL` objects are implemented as getters and setters on the class prototype, rather than as data properties on the object itself. Thus, unlike `legacy urlObject` s, using the `delete` keyword on any properties of `URL` objects (e.g. `delete myURL.protocol`, `delete myURL.pathname`, etc) has no effect but will still return `true`."
822
- }
823
- ]
824
- },
825
- "env": {
826
- "type": "object",
827
- "properties": {
828
- "TZ": {
829
- "type": "string",
830
- "description": "Can be used to change the default timezone at runtime"
831
- }
832
- }
1802
+ "_stream": {
1803
+ "$ref": "#/definitions/Writable",
1804
+ "description": "Output stream"
833
1805
  },
834
- "windowsHide": {
835
- "type": "boolean",
836
- "default": false
1806
+ "caches": {
1807
+ "description": "Get the caches linked to the context"
837
1808
  },
838
- "argv0": {
1809
+ "parameters": {}
1810
+ },
1811
+ "required": [
1812
+ "_promises",
1813
+ "_stream",
1814
+ "caches",
1815
+ "parameters"
1816
+ ],
1817
+ "type": "object"
1818
+ }
1819
+ },
1820
+ "definitions": {
1821
+ "Error": {
1822
+ "additionalProperties": false,
1823
+ "properties": {
1824
+ "message": {
839
1825
  "type": "string"
840
1826
  },
841
- "stdio": {
842
- "$ref": "#/definitions/StdioOptions"
843
- },
844
- "shell": {
845
- "type": [
846
- "boolean",
847
- "string"
848
- ]
1827
+ "name": {
1828
+ "type": "string"
849
1829
  },
850
- "windowsVerbatimArguments": {
1830
+ "stack": {
1831
+ "type": "string"
1832
+ }
1833
+ },
1834
+ "required": [
1835
+ "message",
1836
+ "name"
1837
+ ],
1838
+ "type": "object"
1839
+ },
1840
+ "Promise<any>": {
1841
+ "additionalProperties": false,
1842
+ "description": "Represents the completion of an asynchronous operation",
1843
+ "type": "object"
1844
+ },
1845
+ "Writable": {
1846
+ "additionalProperties": false,
1847
+ "properties": {
1848
+ "destroyed": {
1849
+ "default": false,
1850
+ "description": "Is `true` after `writable.destroy()` has been called.",
1851
+ "since": "v8.0.0",
851
1852
  "type": "boolean"
852
1853
  },
853
- "detached": {
1854
+ "writable": {
1855
+ "default": false,
1856
+ "description": "Is `true` if it is safe to call `writable.write()`, which means\nthe stream has not been destroyed, errored, or ended.",
1857
+ "since": "v11.4.0",
854
1858
  "type": "boolean"
855
1859
  }
856
1860
  },
857
- "description": "Options\n\nBased on https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options"
858
- },
859
- "autoStatus": {
860
- "type": "boolean",
861
- "description": "Use the observability of ChildProcess to update status accordingly"
862
- },
863
- "openapi": {
864
- "type": "object",
865
- "additionalProperties": true
1861
+ "since": "v0.9.4",
1862
+ "type": "object"
866
1863
  }
867
- },
868
- "required": [
869
- "command",
870
- "type"
871
- ],
1864
+ }
1865
+ },
1866
+ "Webda/AsyncAction.status.output": {
872
1867
  "$schema": "http://json-schema.org/draft-07/schema#",
1868
+ "not": {}
1869
+ },
1870
+ "Webda/AsyncOperationAction.status.input": {
1871
+ "type": "object",
1872
+ "properties": {
1873
+ "context": {
1874
+ "additionalProperties": false,
1875
+ "description": "OperationContext is used when call to an operation",
1876
+ "param": [
1877
+ "T type of input for this context",
1878
+ "U type of output for this context",
1879
+ "P type of parameters for this context"
1880
+ ],
1881
+ "properties": {
1882
+ "_promises": {
1883
+ "description": "Contain all registered promises to this context",
1884
+ "items": {
1885
+ "$ref": "#/definitions/Promise%3Cany%3E"
1886
+ },
1887
+ "type": "array"
1888
+ },
1889
+ "_stream": {
1890
+ "$ref": "#/definitions/Writable",
1891
+ "description": "Output stream"
1892
+ },
1893
+ "caches": {
1894
+ "description": "Get the caches linked to the context"
1895
+ },
1896
+ "parameters": {}
1897
+ },
1898
+ "required": [
1899
+ "_promises",
1900
+ "_stream",
1901
+ "caches",
1902
+ "parameters"
1903
+ ],
1904
+ "type": "object"
1905
+ }
1906
+ },
873
1907
  "definitions": {
874
- "SerializationType": {
875
- "type": "string",
876
- "enum": [
877
- "json",
878
- "advanced"
879
- ]
1908
+ "Error": {
1909
+ "additionalProperties": false,
1910
+ "properties": {
1911
+ "message": {
1912
+ "type": "string"
1913
+ },
1914
+ "name": {
1915
+ "type": "string"
1916
+ },
1917
+ "stack": {
1918
+ "type": "string"
1919
+ }
1920
+ },
1921
+ "required": [
1922
+ "message",
1923
+ "name"
1924
+ ],
1925
+ "type": "object"
880
1926
  },
881
- "global.NodeJS.Signals": {
882
- "type": "string",
883
- "enum": [
884
- "SIGABRT",
885
- "SIGALRM",
886
- "SIGBUS",
887
- "SIGCHLD",
888
- "SIGCONT",
889
- "SIGFPE",
890
- "SIGHUP",
891
- "SIGILL",
892
- "SIGINT",
893
- "SIGIO",
894
- "SIGIOT",
895
- "SIGKILL",
896
- "SIGPIPE",
897
- "SIGPOLL",
898
- "SIGPROF",
899
- "SIGPWR",
900
- "SIGQUIT",
901
- "SIGSEGV",
902
- "SIGSTKFLT",
903
- "SIGSTOP",
904
- "SIGSYS",
905
- "SIGTERM",
906
- "SIGTRAP",
907
- "SIGTSTP",
908
- "SIGTTIN",
909
- "SIGTTOU",
910
- "SIGUNUSED",
911
- "SIGURG",
912
- "SIGUSR1",
913
- "SIGUSR2",
914
- "SIGVTALRM",
915
- "SIGWINCH",
916
- "SIGXCPU",
917
- "SIGXFSZ",
918
- "SIGBREAK",
919
- "SIGLOST",
920
- "SIGINFO"
921
- ]
1927
+ "Promise<any>": {
1928
+ "additionalProperties": false,
1929
+ "description": "Represents the completion of an asynchronous operation",
1930
+ "type": "object"
922
1931
  },
923
- "StdioOptions": {
924
- "anyOf": [
925
- {
926
- "$ref": "#/definitions/IOType"
1932
+ "Writable": {
1933
+ "additionalProperties": false,
1934
+ "properties": {
1935
+ "destroyed": {
1936
+ "default": false,
1937
+ "description": "Is `true` after `writable.destroy()` has been called.",
1938
+ "since": "v8.0.0",
1939
+ "type": "boolean"
927
1940
  },
928
- {
929
- "type": "array",
930
- "items": {
931
- "anyOf": [
932
- {
933
- "$ref": "#/definitions/IOType"
934
- },
935
- {
936
- "type": "string",
937
- "const": "ipc"
938
- },
939
- {
940
- "type": "object",
941
- "properties": {}
942
- },
943
- {
944
- "type": "number"
945
- },
946
- {
947
- "type": "null"
948
- },
949
- {
950
- "not": {}
951
- }
952
- ]
953
- }
1941
+ "writable": {
1942
+ "default": false,
1943
+ "description": "Is `true` if it is safe to call `writable.write()`, which means\nthe stream has not been destroyed, errored, or ended.",
1944
+ "since": "v11.4.0",
1945
+ "type": "boolean"
954
1946
  }
955
- ]
956
- },
957
- "IOType": {
958
- "type": "string",
959
- "enum": [
960
- "overlapped",
961
- "pipe",
962
- "ignore",
963
- "inherit"
964
- ]
1947
+ },
1948
+ "since": "v0.9.4",
1949
+ "type": "object"
965
1950
  }
966
- },
967
- "title": "LocalRunner"
1951
+ }
968
1952
  },
969
- "Webda/ServiceRunner": {
1953
+ "Webda/AsyncOperationAction.status.output": {
1954
+ "$schema": "http://json-schema.org/draft-07/schema#",
1955
+ "not": {}
1956
+ },
1957
+ "Webda/AsyncWebdaAction.status.input": {
970
1958
  "type": "object",
971
1959
  "properties": {
972
- "type": {
973
- "type": "string",
974
- "description": "Type of the service"
975
- },
976
- "url": {
977
- "type": "string",
978
- "description": "URL on which to serve the content"
979
- },
980
- "actions": {
981
- "type": "array",
982
- "items": {
983
- "type": "string"
1960
+ "context": {
1961
+ "additionalProperties": false,
1962
+ "description": "OperationContext is used when call to an operation",
1963
+ "param": [
1964
+ "T type of input for this context",
1965
+ "U type of output for this context",
1966
+ "P type of parameters for this context"
1967
+ ],
1968
+ "properties": {
1969
+ "_promises": {
1970
+ "description": "Contain all registered promises to this context",
1971
+ "items": {
1972
+ "$ref": "#/definitions/Promise%3Cany%3E"
1973
+ },
1974
+ "type": "array"
1975
+ },
1976
+ "_stream": {
1977
+ "$ref": "#/definitions/Writable",
1978
+ "description": "Output stream"
1979
+ },
1980
+ "caches": {
1981
+ "description": "Get the caches linked to the context"
1982
+ },
1983
+ "parameters": {}
984
1984
  },
985
- "description": "Actions managed by the runner",
986
- "default": []
987
- },
988
- "logFormat": {
989
- "type": "string",
990
- "description": "Define the log format",
991
- "default": "ConsoleLoggerDefaultFormat"
1985
+ "required": [
1986
+ "_promises",
1987
+ "_stream",
1988
+ "caches",
1989
+ "parameters"
1990
+ ],
1991
+ "type": "object"
1992
+ }
1993
+ },
1994
+ "definitions": {
1995
+ "Error": {
1996
+ "additionalProperties": false,
1997
+ "properties": {
1998
+ "message": {
1999
+ "type": "string"
2000
+ },
2001
+ "name": {
2002
+ "type": "string"
2003
+ },
2004
+ "stack": {
2005
+ "type": "string"
2006
+ }
2007
+ },
2008
+ "required": [
2009
+ "message",
2010
+ "name"
2011
+ ],
2012
+ "type": "object"
992
2013
  },
993
- "logSaveDelay": {
994
- "type": "number",
995
- "description": "How long before saving logs (in ms)",
996
- "default": 5000
2014
+ "Promise<any>": {
2015
+ "additionalProperties": false,
2016
+ "description": "Represents the completion of an asynchronous operation",
2017
+ "type": "object"
997
2018
  },
998
- "openapi": {
999
- "type": "object",
1000
- "additionalProperties": true
2019
+ "Writable": {
2020
+ "additionalProperties": false,
2021
+ "properties": {
2022
+ "destroyed": {
2023
+ "default": false,
2024
+ "description": "Is `true` after `writable.destroy()` has been called.",
2025
+ "since": "v8.0.0",
2026
+ "type": "boolean"
2027
+ },
2028
+ "writable": {
2029
+ "default": false,
2030
+ "description": "Is `true` if it is safe to call `writable.write()`, which means\nthe stream has not been destroyed, errored, or ended.",
2031
+ "since": "v11.4.0",
2032
+ "type": "boolean"
2033
+ }
2034
+ },
2035
+ "since": "v0.9.4",
2036
+ "type": "object"
1001
2037
  }
1002
- },
1003
- "required": [
1004
- "type"
1005
- ],
1006
- "description": "Add the log format to capture",
2038
+ }
2039
+ },
2040
+ "Webda/AsyncWebdaAction.status.output": {
1007
2041
  "$schema": "http://json-schema.org/draft-07/schema#",
1008
- "title": "ServiceRunner"
2042
+ "not": {}
1009
2043
  }
1010
- }
2044
+ },
2045
+ "behaviors": {}
1011
2046
  }