kibi-plugin-sdk
v0.8.0
Published
Public protocol types and validators for Kibi capability plugins
Readme
kibi-plugin-sdk
Public protocol types and validators for writing Kibi capability plugins. A capability plugin can provide a semantic classifier, an ontology pack, a symbol extractor or vocabulary alignment; the host keeps validation, Prolog, mutation and proof.
npm install kibi-plugin-sdkimport { KIBI_PLUGIN_API_VERSION, defineKibiPlugin } from "kibi-plugin-sdk";
export const kibiPlugin = defineKibiPlugin({
apiVersion: KIBI_PLUGIN_API_VERSION,
id: "example-ontology",
version: "0.1.0",
permissions: { network: false, metered: false, secrets: [] },
capabilities: {
// declare only the capabilities you provide
ontologyPack: {
id: "example-ontology.pack",
schemas: () => [],
match: () => [],
},
},
});A plugin package must export a named kibiPlugin binding; a default export alone is not loaded. Projects enable it by listing the package under kibi.plugins in package.json. The plugin development guide covers every capability, versioning and activation.
Links
License
AGPL-3.0-or-later
