Update hivegrid-cloud reference to latest main
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
1 parent
e98d38e716
commit
7b21524c86
3781 files changed
+373484
-225607
No files matched your search
@@ -1,11 +1,11 @@
|
||||
# Plugin CLI Reference
|
||||
|
||||
`toolctrl-cli plugins ...` — the author + operator command surface
|
||||
`hivegrid-cli plugins ...` — the author + operator command surface
|
||||
for the plugin pipeline. Operator subcommands manage installed-plugin
|
||||
rows; author subcommands scaffold / build / sign / lint / publish.
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins --help
|
||||
hivegrid-cli plugins --help
|
||||
```
|
||||
|
||||
## Author subcommands
|
||||
@@ -13,7 +13,7 @@ toolctrl-cli plugins --help
|
||||
### `scaffold`
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins scaffold \
|
||||
hivegrid-cli plugins scaffold \
|
||||
--name slack-notifier \
|
||||
--publisher de.acme \
|
||||
--description "Send tenant events to Slack" \
|
||||
@@ -26,7 +26,7 @@ Generates a new plugin skeleton under `<targetDir>/<name>/`:
|
||||
slack-notifier/
|
||||
├── plugin.toml # manifest seed (placeholder sig/hash)
|
||||
├── src/index.ts # HookHandler example
|
||||
├── package.json # @toolctrl/plugin-sdk devDependency
|
||||
├── package.json # @hivegrid/plugin-sdk devDependency
|
||||
├── tsconfig.json # ES2022 strict
|
||||
└── README.md # next-step checklist
|
||||
```
|
||||
@@ -36,7 +36,7 @@ slack-notifier/
|
||||
### `build`
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins build [--cwd ./slack-notifier] [--output plugin.wasm]
|
||||
hivegrid-cli plugins build [--cwd ./slack-notifier] [--output plugin.wasm]
|
||||
```
|
||||
|
||||
Detects the project's wasm toolchain (AssemblyScript via `asconfig.json`,
|
||||
@@ -47,7 +47,7 @@ run it yourself. Exits non-zero when no toolchain marker is found.
|
||||
### `sign`
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins sign \
|
||||
hivegrid-cli plugins sign \
|
||||
--wasm plugin.wasm \
|
||||
--manifest plugin.json \
|
||||
--key ./keys/publisher.priv \
|
||||
@@ -70,7 +70,7 @@ which artifact.
|
||||
### `lint`
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins lint --manifest plugin.json
|
||||
hivegrid-cli plugins lint --manifest plugin.json
|
||||
```
|
||||
|
||||
Runs the host Zod schema, then layers author checks on top:
|
||||
@@ -95,7 +95,7 @@ Exit codes:
|
||||
### `publish`
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins publish \
|
||||
hivegrid-cli plugins publish \
|
||||
--wasm plugin.wasm \
|
||||
--manifest plugin.json \
|
||||
[--signature plugin.wasm.sig] \
|
||||
@@ -140,12 +140,12 @@ API/UI flow.
|
||||
## Round-trip smoke
|
||||
|
||||
```bash
|
||||
toolctrl-cli plugins scaffold --name smoke --publisher de.smoke --dry-run
|
||||
toolctrl-cli plugins build --cwd ./smoke
|
||||
hivegrid-cli plugins scaffold --name smoke --publisher de.smoke --dry-run
|
||||
hivegrid-cli plugins build --cwd ./smoke
|
||||
# (run the printed build command in your wasm toolchain)
|
||||
toolctrl-cli plugins lint --manifest ./smoke/plugin.json
|
||||
toolctrl-cli plugins sign --wasm ./smoke/plugin.wasm --manifest ./smoke/plugin.json --key ./keys/dev.priv
|
||||
toolctrl-cli plugins publish --wasm ./smoke/plugin.wasm --manifest ./smoke/plugin.json
|
||||
hivegrid-cli plugins lint --manifest ./smoke/plugin.json
|
||||
hivegrid-cli plugins sign --wasm ./smoke/plugin.wasm --manifest ./smoke/plugin.json --key ./keys/dev.priv
|
||||
hivegrid-cli plugins publish --wasm ./smoke/plugin.wasm --manifest ./smoke/plugin.json
|
||||
```
|
||||
|
||||
The output is the file you upload through the tenant-admin plugins
|
||||
|
||||
@@ -75,7 +75,7 @@ Both fields cap at 128 characters.
|
||||
|
||||
### Foundation Hook Payloads
|
||||
|
||||
The SDK exports matching payload types from `@toolctrl/plugin-sdk`
|
||||
The SDK exports matching payload types from `@hivegrid/plugin-sdk`
|
||||
(`TypedHookHandler<"entity.updated">`, `PluginHookWorkflowExecutedPayload`,
|
||||
and friends). Runtime validation is strict, so handlers should rely on
|
||||
these field names instead of ad-hoc shapes.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Plugin SDK Reference
|
||||
|
||||
> `@toolctrl/plugin-sdk` — the typed surface plugin authors compile
|
||||
> `@hivegrid/plugin-sdk` — the typed surface plugin authors compile
|
||||
> against. Mirrors the runtime capability set so an SDK upgrade is a
|
||||
> straight version bump on the author side.
|
||||
|
||||
@@ -10,7 +10,7 @@ The SDK lives in the host monorepo today as `workspace:*`. External
|
||||
plugin authors install it as a regular npm dependency:
|
||||
|
||||
```bash
|
||||
pnpm add -D @toolctrl/plugin-sdk
|
||||
pnpm add -D @hivegrid/plugin-sdk
|
||||
```
|
||||
|
||||
## Top-level exports
|
||||
@@ -40,7 +40,7 @@ pnpm add -D @toolctrl/plugin-sdk
|
||||
## Authoring shape
|
||||
|
||||
```ts
|
||||
import { defineHook, type HookHandler } from "@toolctrl/plugin-sdk";
|
||||
import { defineHook, type HookHandler } from "@hivegrid/plugin-sdk";
|
||||
|
||||
export const handleHello: HookHandler<{ name: string }, { greeting: string }> = defineHook((input, ctx) => {
|
||||
ctx.log.info({ name: input.name }, "hello");
|
||||
@@ -59,8 +59,8 @@ JSON through two raw WebAssembly imports:
|
||||
|
||||
| Import | Signature | Purpose |
|
||||
| --------------------------- | --------------------- | ------------------------------------------------- |
|
||||
| `env.toolctrl_payload_len` | `() -> i32` | Length in bytes of the JSON payload |
|
||||
| `env.toolctrl_payload_byte` | `(index: i32) -> i32` | Byte value at `index`, or `0` outside the payload |
|
||||
| `env.hivegrid_payload_len` | `() -> i32` | Length in bytes of the JSON payload |
|
||||
| `env.hivegrid_payload_byte` | `(index: i32) -> i32` | Byte value at `index`, or `0` outside the payload |
|
||||
|
||||
The SDK exports `PLUGIN_PAYLOAD_ABI_VERSION` and
|
||||
`PLUGIN_PAYLOAD_ABI_IMPORTS` so toolchain bindings can assert the host
|
||||
@@ -81,7 +81,7 @@ only when the message came from `window.parent` and matches the expected
|
||||
protocol version, plugin id, channel id, and request id:
|
||||
|
||||
```ts
|
||||
import { createPluginSettingsClient, PluginSettingsClientError, PluginSettingsClientTimeoutError } from "@toolctrl/plugin-sdk";
|
||||
import { createPluginSettingsClient, PluginSettingsClientError, PluginSettingsClientTimeoutError } from "@hivegrid/plugin-sdk";
|
||||
|
||||
const settings = createPluginSettingsClient({
|
||||
pluginId: "com.acme.settings",
|
||||
|
||||
@@ -9,8 +9,8 @@ the compatibility checks the host enforces at install time.
|
||||
| Axis | Scope | Policy |
|
||||
| ----------------------- | ----------------------------------------------------- | ----------------------------------------------- |
|
||||
| Manifest schema version | `schemaVersion` field on every plugin.toml | Integer-bumped on breaking schema changes |
|
||||
| Plugin SDK version | `@toolctrl/plugin-sdk` npm package | NPM SemVer |
|
||||
| Host runtime version | The host binary running the plugin | NPM SemVer (toolctrl-boilerplate `package.json`) |
|
||||
| Plugin SDK version | `@hivegrid/plugin-sdk` npm package | NPM SemVer |
|
||||
| Host runtime version | The host binary running the plugin | NPM SemVer (hivegrid-cloud `package.json`) |
|
||||
|
||||
Each plugin pins:
|
||||
|
||||
|
||||
Reference in new issue
Block a user