foundry-design-web-adapter 0.2.0-beta.1 → 0.2.0-beta.10
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 +63 -13
- package/THIRD_PARTY_NOTICES.md +11 -11
- package/dist/adapter.js +5071 -956
- package/dist/diagnostics.d.ts +27 -0
- package/dist/diagnostics.d.ts.map +1 -0
- package/dist/effects.d.ts +15 -0
- package/dist/effects.d.ts.map +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/keyline-icons.d.ts +9 -0
- package/dist/keyline-icons.d.ts.map +1 -0
- package/dist/motion.d.ts +76 -0
- package/dist/motion.d.ts.map +1 -0
- package/dist/review.d.ts +2 -0
- package/dist/review.d.ts.map +1 -1
- package/dist/typography.d.ts +195 -0
- package/dist/typography.d.ts.map +1 -0
- package/dist/ui-foundations.d.ts +8 -0
- package/dist/ui-foundations.d.ts.map +1 -0
- package/dist/workspace.d.ts +56 -0
- package/dist/workspace.d.ts.map +1 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -4,35 +4,82 @@ Foundry is a local-first precision design workbench for Codex, Cursor, and Claud
|
|
|
4
4
|
|
|
5
5
|
## Beta installation
|
|
6
6
|
|
|
7
|
-
Foundry
|
|
7
|
+
Foundry is distributed through npm, so testers do not need GitHub access.
|
|
8
|
+
|
|
9
|
+
> **Current public beta:** `0.2.0-beta.10`. Both npm `latest` and `beta` point to the same tested release. Use the unqualified command below for normal installation.
|
|
10
|
+
|
|
11
|
+
Full documentation is available at [withfoundry.ai](https://withfoundry.ai).
|
|
12
|
+
|
|
13
|
+
### Recommended: one command
|
|
14
|
+
|
|
15
|
+
Open a terminal in the project, or ask Codex, Cursor, or Claude Code to run:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx foundry-design
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
That command detects the project and active coding agent, installs or safely updates Foundry, repairs the shared agent connection, validates its integration, starts the project when needed, and opens the visual session. Before changing local configuration, Foundry prints the exact CLI and MCP bridge versions it will use. On the first installation only, restart the coding agent once so it can load the shared MCP connection. A reviewed batch can be queued before the restart and will be claimed when the agent reconnects.
|
|
22
|
+
|
|
23
|
+
After the restart, reopen the same project folder and ask:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
Start Foundry for this project and keep listening for Apply with agent requests.
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
That is the normal workflow. Foundry resumes the most recent session for the current source revision and keeps all review and apply state local.
|
|
30
|
+
|
|
31
|
+
### Manual installation
|
|
32
|
+
|
|
33
|
+
From the first project you want to inspect, run:
|
|
8
34
|
|
|
9
35
|
```bash
|
|
10
|
-
npx foundry-design
|
|
36
|
+
npx foundry-design setup --global
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
For later projects, keep the shared agent connection and install only the development adapter:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx foundry-design setup --agent none
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Then restart the coding agent, reopen the same project folder, and ask:
|
|
46
|
+
|
|
47
|
+
```text
|
|
48
|
+
Start Foundry for this project and keep listening for Apply with agent requests.
|
|
11
49
|
```
|
|
12
50
|
|
|
13
|
-
|
|
51
|
+
You do not need to run a second terminal command when the agent starts Foundry for you. Apply requests remain queued safely when the agent is offline. Run `npx foundry-design doctor --repair` if the connection or generated integration needs repair.
|
|
14
52
|
|
|
15
|
-
|
|
53
|
+
Update an existing installation with:
|
|
16
54
|
|
|
17
55
|
```bash
|
|
18
|
-
npx foundry-design
|
|
56
|
+
npx foundry-design update
|
|
19
57
|
```
|
|
20
58
|
|
|
21
|
-
Foundry
|
|
59
|
+
The updater refreshes checksum-matched Foundry files, agent connections, and skill bundles. It preserves and reports files changed since setup, validates the project, and rolls back the update if Foundry introduces a TypeScript or lint failure. Restart the coding agent after updating.
|
|
60
|
+
|
|
61
|
+
Remove only Foundry-managed integration with:
|
|
22
62
|
|
|
23
63
|
```bash
|
|
24
|
-
npx foundry-design
|
|
64
|
+
npx foundry-design uninstall
|
|
25
65
|
```
|
|
26
66
|
|
|
27
67
|
Supported automatic web integration currently includes Next.js App Router, Vite, and plain HTML. Generic web, SwiftUI, and React Native projects receive explicit setup guidance when a safe automatic edit is not available.
|
|
28
68
|
|
|
29
|
-
|
|
69
|
+
The npm setup above is the public beta installation path and includes the same portable skill and MCP connection used by the agent plugin bundle.
|
|
70
|
+
|
|
71
|
+
If an npm mirror or existing `npx` cache reports an old tag, bypass it with a temporary cache and the exact current release:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
FOUNDRY_NPX_CACHE="$(mktemp -d)"
|
|
75
|
+
npx --yes --prefer-online --registry=https://registry.npmjs.org --cache "$FOUNDRY_NPX_CACHE" --package=foundry-design@0.2.0-beta.10 foundry-design
|
|
76
|
+
```
|
|
30
77
|
|
|
31
|
-
The beta supports Node.js 20 or newer. Read
|
|
78
|
+
The beta supports Node.js 20 or newer. Read the [local-first safety model](https://withfoundry.ai/#safety) before using it with sensitive work.
|
|
32
79
|
|
|
33
80
|
## Agent plugin
|
|
34
81
|
|
|
35
|
-
The portable plugin lives at `plugins/foundry-design-control`. The repository also includes marketplace manifests for Codex, Cursor, and Claude-compatible plugin import. Once installed, ask your agent:
|
|
82
|
+
The portable plugin lives at `plugins/foundry-design-control`. The repository also includes marketplace manifests for Codex, Cursor, and Claude-compatible plugin import. Until public marketplace review is complete, `setup --global` installs the same reusable skill and MCP connection from npm without requiring source-repository access. Once installed, ask your agent:
|
|
36
83
|
|
|
37
84
|
```text
|
|
38
85
|
Start Foundry for this project.
|
|
@@ -42,7 +89,8 @@ Foundry remains local-first. Installing the plugin does not create an account, e
|
|
|
42
89
|
|
|
43
90
|
## Current capabilities
|
|
44
91
|
|
|
45
|
-
-
|
|
92
|
+
- A dedicated local design workspace with a live product canvas, equal Layers and Inspector docks, and a direct-overlay fallback when a product blocks framing
|
|
93
|
+
- Measured browser selection with overlap cycling, parent/child traversal, hover previews, and isolated Shadow DOM canvas instrumentation
|
|
46
94
|
- A searchable, collapsible, virtualized live layer hierarchy with mapped-source context, Shadow DOM traversal, drag reordering, and selection persistence across HMR
|
|
47
95
|
- Multi-selection, measured spacing annotations, sibling-aware resize snapping, keyboard nudging, alignment, distribution, and preview undo/redo
|
|
48
96
|
- A revisioned local design graph for CSS tokens, components, Storybook variants, breakpoints, themes, states, and motion presets
|
|
@@ -54,9 +102,11 @@ Foundry remains local-first. Installing the plugin does not create an account, e
|
|
|
54
102
|
- Design Health scans for contrast, overflow and clipping, touch targets, accessible names, reduced-motion coverage, and project spacing consistency, with evidence, intentional-issue ignores, and safe corrections routed into review
|
|
55
103
|
- An in-app state workbench with real viewport frames, theme switching, forced interaction states, motion controls, and contextual verification
|
|
56
104
|
- Persistent, coalescing change ledger with JSON and consolidated prompt export
|
|
57
|
-
-
|
|
105
|
+
- Center-workspace review with editable approved batches, grouped targets, and unresolved-target blocking
|
|
58
106
|
- Persistent Apply with agent runs across Codex, Cursor, and Claude Code through MCP
|
|
107
|
+
- Leased agent handoffs that safely return abandoned or interrupted claims to the queue
|
|
59
108
|
- Live source, rebuild, validation, retry, and rendered-verification progress
|
|
109
|
+
- Rendered verification that resumes after refresh and does not depend on Review remaining open
|
|
60
110
|
- Local MCP bridge for agent access
|
|
61
111
|
- Debug adapters for web, SwiftUI, and React Native on iOS Simulator
|
|
62
112
|
- Verification records that compare requested and rendered values
|
|
@@ -90,7 +140,7 @@ The runtime binds to `127.0.0.1:4387`. Inspector preview changes remain temporar
|
|
|
90
140
|
- `packages/react-native-adapter`: React Native debug bridge
|
|
91
141
|
- `packages/mcp-server`: agent tools backed by the runtime
|
|
92
142
|
- `packages/swiftui-adapter`: Swift package for inspectable SwiftUI views
|
|
93
|
-
- `apps/inspector`:
|
|
143
|
+
- `apps/inspector`: authenticated local design workspace, canvas shell, and review surface
|
|
94
144
|
- `examples/web-fixture`: end-to-end browser fixture
|
|
95
145
|
|
|
96
146
|
## Safety model
|
package/THIRD_PARTY_NOTICES.md
CHANGED
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
# Third-party notices
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Keyline Icons
|
|
4
4
|
|
|
5
|
-
Foundry Design Control uses icons from
|
|
5
|
+
Foundry Design Control uses icons from [Keyline Icons](https://icon-sets.iconify.design/keyline-icons/), distributed through Iconify's `@iconify-icons/keyline-icons` package.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Keyline Icons is licensed under the MIT License.
|
|
8
8
|
|
|
9
|
-
Copyright (c) 2026
|
|
9
|
+
Copyright (c) 2026 Keyline Icons
|
|
10
10
|
|
|
11
|
-
Permission to use, copy, modify,
|
|
11
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
## beUI File Tree
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
The Foundry Layers interaction adapts motion and keyboard-navigation patterns from the [beUI File Tree](https://beui.dev/components/motion/file-tree).
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
beUI is licensed under the MIT License.
|
|
22
22
|
|
|
23
|
-
Copyright (c)
|
|
23
|
+
Copyright (c) 2026 Saurabh Chauhan
|
|
24
24
|
|
|
25
25
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
26
26
|
|