@wfgraph/client 0.0.1 → 0.1.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 +36 -0
- package/package.json +6 -3
package/README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# @wfgraph/client
|
|
2
|
+
|
|
3
|
+
The visual editor for [Workflow Graph](https://github.com/alandotcom/wfgraph), shipped as a
|
|
4
|
+
built single-page bundle. Your team builds workflow graphs and declares Lifecycle Rules here,
|
|
5
|
+
against the Events and actions your code declared with
|
|
6
|
+
[`@wfgraph/core`](https://www.npmjs.com/package/@wfgraph/core).
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install @wfgraph/client
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
The package exports one value, a pointer to the built assets on disk. Workflow Graph's server
|
|
13
|
+
does not depend on this package and cannot find it on its own, so passing it is what turns the
|
|
14
|
+
UI on.
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
import { clientBundle } from "@wfgraph/client";
|
|
18
|
+
import { createWfGraphApp } from "@wfgraph/core";
|
|
19
|
+
|
|
20
|
+
const wfgraph = await createWfGraphApp({
|
|
21
|
+
client: clientBundle /* ...the rest */,
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Nothing here is a React component you render yourself, and the package has no runtime
|
|
26
|
+
dependencies: React, the graph canvas, and the stylesheet are already inside the bundle. It is
|
|
27
|
+
released in lockstep with `@wfgraph/core` and always carries the same version, because the
|
|
28
|
+
editor speaks that version's API contract.
|
|
29
|
+
|
|
30
|
+
## Docs
|
|
31
|
+
|
|
32
|
+
- [Embedding](https://github.com/alandotcom/wfgraph/blob/main/docs/embedding.md), which covers
|
|
33
|
+
serving the editor and the SPA path rule
|
|
34
|
+
- [Product and design vocabulary](https://github.com/alandotcom/wfgraph/blob/main/packages/client/PRODUCT.md)
|
|
35
|
+
|
|
36
|
+
Apache-2.0.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wfgraph/client",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Workflow Graph's node-based editor, built and handed to createWfGraphApp as its client bundle",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"automation",
|
|
@@ -68,8 +68,11 @@
|
|
|
68
68
|
"tw-animate-css": "^1.4.0",
|
|
69
69
|
"vaul": "^1.1.2",
|
|
70
70
|
"vite": "^8.2.1",
|
|
71
|
-
"@wfgraph/
|
|
72
|
-
"@wfgraph/
|
|
71
|
+
"@wfgraph/shared": "0.1.0",
|
|
72
|
+
"@wfgraph/plugins": "0.1.0"
|
|
73
|
+
},
|
|
74
|
+
"engines": {
|
|
75
|
+
"node": ">=24"
|
|
73
76
|
},
|
|
74
77
|
"scripts": {
|
|
75
78
|
"dev": "vite",
|