@abraca/plugin 2.3.0 → 2.5.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 +25 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# @abraca/plugin
|
|
2
|
+
|
|
3
|
+
The shared plugin contract for Abracadabra — the `AbraPlugin` shape, `PluginManifest` types, a capability-guarded host, an iframe sandbox, and an in-process registry. Shared by `@abraca/nuxt` and cou-shell. **Zero dependencies.**
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
Full, code-derived documentation lives in [`docs/`](docs/) — the `AbraPlugin`
|
|
8
|
+
contract, manifest & capability tokens, the host/sandbox isolation model, and the
|
|
9
|
+
registry + source spec. It is the source of truth.
|
|
10
|
+
|
|
11
|
+
## What's inside
|
|
12
|
+
|
|
13
|
+
- **`AbraPlugin`** — the universal plugin shape (editor + server contributions); version-decoupled via structural markers (no pinned yjs/TipTap/Vue).
|
|
14
|
+
- **`PluginManifest`** — declarative descriptor types (the Zod **validator** lives in `@abraca/schema`).
|
|
15
|
+
- **`createPluginHost`** — capability-guarded fetch/clipboard/notifications.
|
|
16
|
+
- **`loadSandboxedPlugin`** — null-origin iframe, `postMessage`-only.
|
|
17
|
+
- **`PluginRegistry`** — in-process built-in + space-plugin manager with contribution aggregators.
|
|
18
|
+
|
|
19
|
+
::
|
|
20
|
+
|
|
21
|
+
> Phase-1 host gating is advisory (a plugin can grab `globalThis.fetch`); the iframe sandbox is the real boundary, and functions don't cross `postMessage`. `integrity` is documented as bare hex here but `@abraca/plugin-cli` writes `sha256-<hex>` — see the docs.
|
|
22
|
+
|
|
23
|
+
## License
|
|
24
|
+
|
|
25
|
+
MIT.
|