@bakingrl/plugin-sdk

TypeScript contracts and helpers for BakingRL plugin packages.

Install

npm install @bakingrl/plugin-sdk

Usage

import { defineWebview, type WebviewContext } from "@bakingrl/plugin-sdk";

export default defineWebview({
  async mount(context: WebviewContext) {
    const settings = await context.settings.get();
    const snapshot = await context.telemetryHub.snapshot<"UpdateState">();
    context.root.textContent = String(settings.title ?? snapshot?.Data.MatchGuid ?? "Tool");
  }
});

Extensions can register commands and services:

import { defineExtension, type ExtensionContext } from "@bakingrl/plugin-sdk";

export const activate = defineExtension({
  activate(context: ExtensionContext) {
    context.services.register("echo", {
      ping(input) {
        return { ok: true, input };
      }
    });
  }
}).activate;

Browser webview entries can use the host bridge without copying the internal postMessage protocol:

import { createWebviewBridge } from "@bakingrl/plugin-sdk";

const bridge = createWebviewBridge();
bridge.ready();

const asset = await bridge.request<{ url: string }>("bakingrl:asset-url", {
  ref: "resources/logo.svg"
});

Host-opened webviews also receive optional typed helpers such as context.services?.call(...), await context.assets?.url(...), context.registry?.get(...), context.diagnostics, and context.secrets?.configured(...) when BakingRL mounts them.

This SDK targets BakingRL trusted plugin package schema bakingrl.plugin/4, SDK version 2.3.0, and bakingrlApi: "2.3.0" for the current V4 runtime contract. Compatible packages target 2.3.x, with 2.3.0 as the minimum; manifests outside that window are rejected.

See the repository docs-src/ documentation for the full SDK API, manifest format, telemetry types, and security model.