lotobo/toolbox-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity
Files
c296281f899608d5df7fae1d83d442675d1104a2
toolbox-sdk/packages/contract/README.md

898 B
Raw Blame History

@add-ideas/toolbox-contract

Typed, runtime-validated toolbox application manifests and catalogs, plus safe same-origin context discovery and URL resolution.

import {
  loadToolboxContext,
  parseToolboxApp,
} from "@add-ideas/toolbox-contract";

const app = parseToolboxApp(await response.json());
const result = await loadToolboxContext();

The package also owns the versioned same-origin browser preference contract. Use readToolboxPreferences() and writeToolboxPreferences() to share pinned apps, ordering, visibility, and light/dark/system mode with the Toolbox portal.

See the workspace README for the v1 document formats and full API.

The canonical schemas are also published at @add-ideas/toolbox-contract/schemas/toolbox-app.v1.schema.json and @add-ideas/toolbox-contract/schemas/toolbox-catalog.v1.schema.json.