@kisaki3/extension-api
v0.0.1
Published
Public contracts for the Kisaki extension system
Readme
@kisaki3/extension-api
Public contracts for the Kisaki extension system.
This package is shared by the desktop host, extension host, SDK, CLI tooling, and
extension projects. It owns stable runtime types and validation helpers; distributed
registry metadata lives in @kisaki3/extension-registry.
Contents
- Extension manifests, parser helpers, and the manifest JSON Schema.
ExtensionContext,KisakiApi, runtime metadata, logger, storage, secrets, and disposables.- Host capabilities: library, network, notify, events, runtime, scrapers, ingest, commands, and background tasks.
- Contributions: entity menus, settings panels, scraper providers, deeplink routes, themes, and commands.
- RPC contracts for lifecycle, runtime context services, host capabilities, and contribution callbacks.
- Shared DTOs, value objects, serialization helpers, and validation issues.
Manifest Schema
"$schema": "./node_modules/@kisaki3/extension-api/schemas/extension-manifest.schema.json"A minimal runtime manifest:
{
"$schema": "./node_modules/@kisaki3/extension-api/schemas/extension-manifest.schema.json",
"id": "example-extension",
"name": "Example Extension",
"version": "0.0.1",
"categories": ["tool"],
"entry": "./dist/index.mjs",
"description": "Adds an example command.",
"engines": {
"kisaki": ">=0.0.4"
}
}Manifest rules:
idmust be a valid Kisaki extension identifier.versionmust be semver.categoriesmust usescraper,tool,theme, orintegration.entryand optionaliconare package-relative paths inside the package root.engines.kisaki, when provided, must be a semver range. Registry publishing requires it.- Unknown manifest fields are rejected.
Boundary
.kisx packages use this package for the runtime manifest and extension code
contracts. Static extension repositories use @kisaki3/extension-registry for
installable releases, artifact URLs, sha256 digests, platform targets, changelogs,
and optional Ed25519 signatures.
