@revenexx/integrations-node-devkit 0.2.1 → 0.3.0
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 +35 -13
- package/dist/{chunk-UBYGZFB7.js → chunk-PS3HCKE7.js} +263 -68
- package/dist/chunk-PS3HCKE7.js.map +1 -0
- package/dist/cli.cjs +426 -545
- package/dist/cli.cjs.map +1 -1
- package/dist/cli.js +140 -452
- package/dist/cli.js.map +1 -1
- package/dist/index.cjs +258 -68
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +80 -8
- package/dist/index.d.ts +80 -8
- package/dist/index.js +1 -1
- package/package.json +7 -4
- package/preview-host/app.vue +22 -0
- package/preview-host/assets/css/main.css +22 -0
- package/preview-host/composables/devkit-console-stubs.ts +52 -0
- package/preview-host/middleware/hide-workflows.global.ts +13 -0
- package/preview-host/nuxt.config.ts +38 -0
- package/preview-host/package.json +37 -0
- package/preview-host/pages/index.vue +63 -0
- package/preview-host/pages/nodes.vue +208 -0
- package/dist/chunk-UBYGZFB7.js.map +0 -1
package/README.md
CHANGED
|
@@ -57,10 +57,17 @@ host app. The devkit scaffolds and runs that host for you:
|
|
|
57
57
|
npm run preview
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
This (1)
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
60
|
+
This (1) copies the host into a shared cache directory, (2) `npm install`s it there
|
|
61
|
+
(heavy the first time — pulls Nuxt + the studio packages), (3) starts the mock API,
|
|
62
|
+
and (4) runs `nuxt dev` wired to the mock. Open
|
|
63
|
+
**http://localhost:3000/integrations**.
|
|
64
|
+
|
|
65
|
+
**The host does not go into your repo.** It is copied to
|
|
66
|
+
`${XDG_CACHE_HOME:-~/.cache}/revenexx/devkit-preview/<devkit-version>/`, so every
|
|
67
|
+
one of your node packages shares a single dependency install, and a devkit upgrade
|
|
68
|
+
can never leave you running a stale host. Your repo only gets
|
|
69
|
+
`.revenexx-dev/state.json`. If you still have a `.revenexx-dev/preview/` from an
|
|
70
|
+
older devkit, it is unused and can be deleted.
|
|
64
71
|
|
|
65
72
|
No auth shim is needed: `@revenexx/studio-shared`'s standalone
|
|
66
73
|
`usePlatformAuth`/`usePlatformTenant` read a dev token/tenant from
|
|
@@ -68,15 +75,24 @@ No auth shim is needed: `@revenexx/studio-shared`'s standalone
|
|
|
68
75
|
mock ignores the values). `runtimeConfig.public.integrationsApi` is pointed at
|
|
69
76
|
the mock automatically.
|
|
70
77
|
|
|
71
|
-
|
|
72
|
-
|
|
78
|
+
The managed copy is a disposable artifact — don't edit it, it is replaced on the
|
|
79
|
+
next version bump. To change the host, take a copy that is yours:
|
|
80
|
+
|
|
81
|
+
- `integrations-devkit init-preview --dir ./my-preview` — an **unmanaged** copy,
|
|
82
|
+
never touched by devkit upgrades.
|
|
83
|
+
- `integrations-devkit preview --dir ./my-preview` — run that copy instead.
|
|
73
84
|
|
|
74
85
|
> **Scope:** the preview targets the **slimmed** studio build — node listing +
|
|
75
|
-
> credential/template management + **config-field resolving
|
|
76
|
-
>
|
|
77
|
-
>
|
|
78
|
-
>
|
|
79
|
-
|
|
86
|
+
> credential/template management + **config-field resolving** (the UI
|
|
87
|
+
> `POST`s to `/nodes/{slug}/{version}/config:resolve`, which the mock serves).
|
|
88
|
+
> The **Workflows** surface is hidden until phase 2, because workflow execution is
|
|
89
|
+
> not mocked; the Temporal parts (run history, `…/runs/*`) are intentionally absent.
|
|
90
|
+
|
|
91
|
+
The mock is checked against the service's own OpenAPI contract — see
|
|
92
|
+
[docs/architecture.md](docs/architecture.md#staying-in-step-with-the-real-api).
|
|
93
|
+
One caveat to know up front: `POST /nodes/{slug}/{version}/config:validate` is a
|
|
94
|
+
**devkit-only** endpoint used by the preview's node page. It does not exist in the
|
|
95
|
+
real API.
|
|
80
96
|
|
|
81
97
|
Pass `--ui <dir>` to `integrations-devkit` if you instead have a prebuilt static SPA.
|
|
82
98
|
|
|
@@ -92,6 +108,8 @@ Pass `--ui <dir>` to `integrations-devkit` if you instead have a prebuilt static
|
|
|
92
108
|
| `--ui <dir>` | resolve UI package | Static UI build to serve |
|
|
93
109
|
| `--no-ui` | off | Run API-only |
|
|
94
110
|
| `--open` | off | Open the preview in a browser |
|
|
111
|
+
| `--dir <path>` | managed cache | Use this preview-host dir instead (unmanaged) |
|
|
112
|
+
| `--force` | off | Re-copy the host even if the target looks complete |
|
|
95
113
|
| `reset` (subcommand) | | Delete the session overlay |
|
|
96
114
|
|
|
97
115
|
## Seeds + persistence (layered)
|
|
@@ -176,5 +194,9 @@ This is a faithful **dev** stand-in, not the production service:
|
|
|
176
194
|
reproduced.
|
|
177
195
|
- Workflow-blob validation is light and schema-based; the production service
|
|
178
196
|
does deeper cross-validation on save.
|
|
179
|
-
- Workflow **run execution** is not included (v1)
|
|
180
|
-
|
|
197
|
+
- Workflow **run execution** is not included (v1), so the Workflows surface is
|
|
198
|
+
hidden in the preview.
|
|
199
|
+
- `assets/schemas/` is still empty, so `GET /schemas/{domain}` 404s and the UI's
|
|
200
|
+
client-side schema validation is inactive.
|
|
201
|
+
- `POST /nodes/{slug}/{version}/config:validate` exists only here, not in the real
|
|
202
|
+
API.
|