@antelopejs/dms-automation 0.4.0 → 0.4.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.
- package/README.md +58 -112
- package/dist/db/models/automation_template.model.d.ts +1 -0
- package/dist/db/models/procedure.model.d.ts +1 -0
- package/dist/db/models/procedure_run.model.d.ts +1 -0
- package/dist/db/models/type_switch.model.d.ts +1 -0
- package/dist/runtime/typeOrigin.js +1 -1
- package/dist/runtime/typeOrigin.js.map +1 -1
- package/frontend-vue/app/components/Editor.vue +18 -19
- package/frontend-vue/package.json +4 -4
- package/frontend-vue/pnpm-lock.yaml +1429 -2947
- package/package.json +31 -15
- package/skills/dms-automation/SKILL.md +30 -0
package/package.json
CHANGED
|
@@ -1,10 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antelopejs/dms-automation",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.1",
|
|
4
|
+
"description": "Visual automation builder for the AntelopeJS DMS: procedures as node graphs started by schedules, webhooks, manual runs or DMS events, with a trace for every run.",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"antelopejs",
|
|
7
|
+
"automation",
|
|
8
|
+
"dms",
|
|
9
|
+
"dms-module",
|
|
10
|
+
"workflow"
|
|
11
|
+
],
|
|
12
|
+
"homepage": "https://dms.antelopejs.com/docs/modules/automation",
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/AntelopeJS/dms-automation/issues"
|
|
15
|
+
},
|
|
4
16
|
"license": "Apache-2.0",
|
|
5
17
|
"repository": {
|
|
6
18
|
"type": "git",
|
|
7
|
-
"url": "git+https://github.com/AntelopeJS/dms-automation.git"
|
|
19
|
+
"url": "git+https://github.com/AntelopeJS/dms-automation.git",
|
|
20
|
+
"directory": "packages/dms-automation"
|
|
8
21
|
},
|
|
9
22
|
"files": [
|
|
10
23
|
"dist",
|
|
@@ -12,7 +25,8 @@
|
|
|
12
25
|
"frontend-vue",
|
|
13
26
|
"package.json",
|
|
14
27
|
"README.md",
|
|
15
|
-
"LICENSE"
|
|
28
|
+
"LICENSE",
|
|
29
|
+
"skills"
|
|
16
30
|
],
|
|
17
31
|
"main": "dist/index.js",
|
|
18
32
|
"types": "dist/index.d.ts",
|
|
@@ -29,23 +43,22 @@
|
|
|
29
43
|
"registry": "https://registry.npmjs.org/"
|
|
30
44
|
},
|
|
31
45
|
"dependencies": {
|
|
32
|
-
"@antelopejs/interface-api": ">=0.0.
|
|
33
|
-
"@antelopejs/interface-api-util": ">=0.1.
|
|
34
|
-
"@antelopejs/interface-core": ">=0.
|
|
35
|
-
"@antelopejs/interface-data-api": ">=0.2.
|
|
36
|
-
"@antelopejs/interface-database": ">=0.1.
|
|
37
|
-
"@antelopejs/interface-database-decorators": ">=0.1.
|
|
38
|
-
"@antelopejs/interface-dms": ">=0.7.
|
|
39
|
-
"@antelopejs/interface-dms-automation": ">=0.2.
|
|
46
|
+
"@antelopejs/interface-api": ">=0.0.15 <1.0.0",
|
|
47
|
+
"@antelopejs/interface-api-util": ">=0.1.3 <1.0.0",
|
|
48
|
+
"@antelopejs/interface-core": ">=0.2.4 <1.0.0",
|
|
49
|
+
"@antelopejs/interface-data-api": ">=0.2.2 <1.0.0",
|
|
50
|
+
"@antelopejs/interface-database": ">=0.1.10 <1.0.0",
|
|
51
|
+
"@antelopejs/interface-database-decorators": ">=0.1.9 <1.0.0",
|
|
52
|
+
"@antelopejs/interface-dms": ">=0.7.2 <1.0.0",
|
|
53
|
+
"@antelopejs/interface-dms-automation": ">=0.2.1 <0.3.0",
|
|
40
54
|
"defu": "^6.1.4",
|
|
41
55
|
"node-cron": "^4.2.1",
|
|
42
56
|
"zod": "^3.25.76"
|
|
43
57
|
},
|
|
44
58
|
"devDependencies": {
|
|
45
|
-
"@antelopejs/core": "1.
|
|
46
|
-
"@antelopejs/tooling-configs": ">=0.0.
|
|
59
|
+
"@antelopejs/core": "1.16.0",
|
|
60
|
+
"@antelopejs/tooling-configs": ">=0.0.9 <1.0.0",
|
|
47
61
|
"@types/node": "^24.0.0",
|
|
48
|
-
"@types/node-cron": "^3.0.11",
|
|
49
62
|
"knip": "^6.34.0",
|
|
50
63
|
"oxfmt": "^0.66.0",
|
|
51
64
|
"oxlint": "1.81.0",
|
|
@@ -56,12 +69,15 @@
|
|
|
56
69
|
"typescript": "^6.0.3"
|
|
57
70
|
},
|
|
58
71
|
"optionalDependencies": {
|
|
59
|
-
"@antelopejs/interface-redis": ">=0.0.
|
|
72
|
+
"@antelopejs/interface-redis": ">=0.0.9 <1.0.0"
|
|
60
73
|
},
|
|
61
74
|
"antelopeJs": {
|
|
62
75
|
"baseUrl": "dist",
|
|
63
76
|
"implements": [
|
|
64
77
|
"@antelopejs/interface-dms-automation"
|
|
78
|
+
],
|
|
79
|
+
"skills": [
|
|
80
|
+
"./skills"
|
|
65
81
|
]
|
|
66
82
|
},
|
|
67
83
|
"scripts": {
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: dms-automation
|
|
3
|
+
description: Uses the @antelopejs/dms-automation module of the AntelopeJS DMS (procedures as node graphs started by schedules, webhooks, manual runs or DMS events, with run history and traces under /modules/automation). Use when installing or configuring dms-automation (runs.retentionDays, runs.sensitiveNames, httpRequest.blockPrivateNetwork, cluster.driver), creating or importing a procedure, debugging a failing run, or choosing a trigger. To declare new nodes from a module, use dms-automation-interface instead.
|
|
4
|
+
icon: i-lucide-workflow
|
|
5
|
+
category: automation
|
|
6
|
+
tags: [automation, procedures, workflows, triggers, webhooks, cron]
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# dms-automation
|
|
10
|
+
|
|
11
|
+
Runs procedures: a trigger starts a run, actions run along trigger edges, data nodes compute values along data edges, flow nodes (If, Switch, For each, Try/Catch, Retry, Delay…) branch and loop. Every run keeps a trace. User docs: https://dms.antelopejs.com/docs/modules/automation (source: `docs/` of this package). Declaring nodes from another module: the `dms-automation-interface` skill.
|
|
12
|
+
|
|
13
|
+
## Key facts
|
|
14
|
+
|
|
15
|
+
- Pages (owner-only): Overview, Procedures, Builder (`/modules/automation/builder?selected=<id>`), Run history, Run trace (`/modules/automation/trace?run=<id>`), Library.
|
|
16
|
+
- API under `/api/automation` (owner-only). A procedure exported from the builder (`{ name, description, graph }`) is re-created with `POST /api/automation/procedures/import` `{ json }` as a disabled draft; `PUT …/:id/enabled` `{ enabled }` enables it; `POST …/:id/run-now` `{ payload }` runs it.
|
|
17
|
+
- States: failing (last run failed, or the trigger cannot be armed), degraded (a failure in 7 days), healthy, paused, draft. Test runs never count.
|
|
18
|
+
|
|
19
|
+
## Config (`antelope.config.ts`, all optional)
|
|
20
|
+
|
|
21
|
+
`runs.retentionDays` (30; 0 keeps all), `runs.sensitiveNames` (extra credential names, stored as `[redacted]`), `httpRequest.blockPrivateNetwork` (false), `cluster.driver` (`auto` | `redis` | `memory`).
|
|
22
|
+
|
|
23
|
+
## Gotchas
|
|
24
|
+
|
|
25
|
+
- Webhook paths cannot overlap an existing route or start with `/api`, `/auth`, `/dms`, `/modules`, `/settings`; two enabled procedures cannot share method + path. URLs shown use the DMS `apiBaseUrl` (the API server, not the frontend server).
|
|
26
|
+
- Version 0.4+ needs `@antelopejs/dms` 0.9 (`interface-dms` 0.7) and `@antelopejs/dms-frontend` 0.6; 0.3 is the DMS 0.8 line.
|
|
27
|
+
- A re-run sends `[redacted]` where the original request held credentials.
|
|
28
|
+
- In a Redis cluster, singleton triggers (cron, table watch) are fire-once, not exactly-once: make their effects idempotent.
|
|
29
|
+
- Keep credentials out of graphs: every builder user sees them.
|
|
30
|
+
- Turn on `blockPrivateNetwork` when untrusted people build procedures or URLs come from payloads.
|