@open-flow/ui 0.2.0 → 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 +23 -21
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,40 +1,42 @@
|
|
|
1
1
|
# open-flow
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
A live workbench over the Next.js app you already have — real components, real
|
|
4
|
+
design tokens, real user flows. Nothing is a copy: the viewer imports your
|
|
5
|
+
app's own components, so a preview and the shipped component can never drift,
|
|
6
|
+
because they are the same code.
|
|
7
7
|
|
|
8
8
|
```
|
|
9
9
|
pnpm add -D @open-flow/ui
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
Public and zero-config: any repository installs it with no tokens and no
|
|
13
|
+
registry setup.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## The two halves
|
|
16
16
|
|
|
17
|
-
- **`@open-flow/ui`** (
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
17
|
+
- **`@open-flow/ui`** (this repository, open source): the complete viewer —
|
|
18
|
+
design tokens, the component catalog, the flow storyboard with its live
|
|
19
|
+
mirror board, named UI surfaces, the ⌥P overlay for pointing at real pages,
|
|
20
|
+
and the demo-authoring API.
|
|
21
|
+
- **The scan engine** (private): the analyzer that reads your repository and
|
|
22
|
+
produces the map this viewer renders. Distributed separately, under
|
|
23
|
+
authorization from Ecorona LLC.
|
|
23
24
|
|
|
24
|
-
|
|
25
|
-
|
|
25
|
+
The viewer consumes the artifacts the engine generates (`.workbench/`); with
|
|
26
|
+
pre-generated artifacts, the viewer mounts on its own.
|
|
26
27
|
|
|
27
|
-
##
|
|
28
|
+
## Development
|
|
28
29
|
|
|
29
30
|
```
|
|
30
31
|
pnpm install
|
|
31
|
-
pnpm build # tsc +
|
|
32
|
+
pnpm build # tsc + minify
|
|
32
33
|
pnpm test # vitest
|
|
33
34
|
pnpm typecheck
|
|
34
35
|
```
|
|
35
36
|
|
|
36
|
-
##
|
|
37
|
+
## License
|
|
37
38
|
|
|
38
|
-
Elastic License 2.0 —
|
|
39
|
-
|
|
40
|
-
|
|
39
|
+
Elastic License 2.0 — the source is visible and modifiable; it may not be
|
|
40
|
+
offered as a managed service to third parties, and the separation from the
|
|
41
|
+
gated engine may not be circumvented. See [LICENSE](./LICENSE).
|
|
42
|
+
_(Text pending legal review by Ecorona LLC.)_
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-flow/ui",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"description": "A live workbench over your Next.js app — real components, tokens, and flows. The open-flow viewer, open source.",
|
|
5
5
|
"license": "Elastic-2.0",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|