@makinbakin/sdk 0.0.0-bootstrap.0

package/metadata/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * `@bakin/sdk/metadata` — docs-aware contract helpers.
+ *
+ * Re-exports the canonical `RouteContract`, `CliCommandContract`,
+ * `HookContract`, `SlotContract`, `ExecToolContract`, and the corresponding
+ * `define*Contract` helpers from `@bakin/core/docs`. The duplicated copy that
+ * previously lived in this file has been retired (T1) — keeping it
+ * structurally identical to the core copy was a maintenance burden the spec
+ * explicitly removes.
+ *
+ * `defineApiRoute` / `definePluginRoute` are kept as re-exports for backward
+ * compatibility with existing call sites; new code should use `defineRoute`
+ * from `@bakin/sdk/routing` (the typed declarative shape).
+ */
+export type { ContractMetadata, ContractStability, ContractVisibility, CliCommandContract, DocsAwareAPIRoute, DocsExample, ExecToolContract, HookContract, HookKind, PublicContract, RouteContract, SchemaLike, SlotContract, SourceLocation, } from '../_internal/core/docs';
+export { defineApiRoute, defineCliCommandContract, defineExecToolContract, defineHookContract, definePluginRoute, defineRouteContract, defineSlotContract, } from '../_internal/core/docs';

package/metadata/index.js

@@ -0,0 +1,31 @@
+// @bun
+// packages/core/src/docs/metadata.ts
+function defineRouteContract(contract) {
+  return contract;
+}
+function defineCliCommandContract(contract) {
+  return contract;
+}
+function defineHookContract(contract) {
+  return contract;
+}
+function defineSlotContract(contract) {
+  return contract;
+}
+function defineExecToolContract(contract) {
+  return contract;
+}
+// packages/core/src/docs/route.ts
+function defineApiRoute(route) {
+  return route;
+}
+var definePluginRoute = defineApiRoute;
+export {
+  defineSlotContract,
+  defineRouteContract,
+  definePluginRoute,
+  defineHookContract,
+  defineExecToolContract,
+  defineCliCommandContract,
+  defineApiRoute
+};

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@makinbakin/sdk",
+  "version": "0.0.0-bootstrap.0",
+  "description": "SDK for building Bakin plugins — UI components, slot types, hooks, and the runtime registerPlugin helper.",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./index.d.ts"
+    },
+    "./ui": {
+      "import": "./ui/index.js",
+      "types": "./ui/index.d.ts"
+    },
+    "./hooks": {
+      "import": "./hooks/index.js",
+      "types": "./hooks/index.d.ts"
+    },
+    "./components": {
+      "import": "./components/index.js",
+      "types": "./components/index.d.ts"
+    },
+    "./slots": {
+      "import": "./slots/index.js",
+      "types": "./slots/index.d.ts"
+    },
+    "./types": {
+      "import": "./types/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./utils": {
+      "import": "./utils/index.js",
+      "types": "./utils/index.d.ts"
+    },
+    "./metadata": {
+      "import": "./metadata/index.js",
+      "types": "./metadata/index.d.ts"
+    },
+    "./routing": {
+      "import": "./routing/index.js",
+      "types": "./routing/index.d.ts"
+    }
+  },
+  "files": [
+    "**/*.js",
+    "**/*.d.ts",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "dependencies": {
+    "@base-ui/react": "^1.3.0",
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "cmdk": "^1.1.1",
+    "lucide-react": "^0.577.0",
+    "react-hook-form": "^7.72.0",
+    "zod": "^4.3.0",
+    "zustand": "^5.0.12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/markhayden/bakin.git",
+    "directory": "packages/sdk"
+  },
+  "homepage": "https://github.com/markhayden/bakin/tree/main/packages/sdk#readme",
+  "bugs": {
+    "url": "https://github.com/markhayden/bakin/issues"
+  },
+  "author": "markhayden",
+  "license": "MIT",
+  "keywords": [
+    "bakin",
+    "plugin",
+    "sdk",
+    "react",
+    "orchestration",
+    "agents"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/register.d.ts

@@ -0,0 +1,103 @@
+/**
+ * `registerPlugin` — single-call plugin contribution API.
+ *
+ * Consolidates what each plugin's client.tsx does into one call:
+ *   registerPlugin({
+ *     id: 'my-plugin',
+ *     navItems: [ ... ],
+ *     slots: { 'asset-preview': AssetRenderer, 'page:/foo': MyPage },
+ *   })
+ *
+ * Companion `unregisterPlugin` tears everything back down — used by the
+ * v2 dev-mode plugin hot-swap path and by any consumer that needs a clean
+ * reload. Plugin-local registries (e.g., workflows' node renderers and
+ * source definitions) hook into the teardown via `registerPluginCleanup`.
+ *
+ * Shell subscribes via `subscribeRegistry` / `getRegistryVersion` so the
+ * nav + slot trees re-render when plugins come or go at runtime.
+ */
+import type { ComponentType } from 'react';
+interface NavItem {
+    id: string;
+    label: string;
+    icon?: string;
+    href?: string;
+    order?: number;
+    alwaysExpanded?: boolean;
+    children?: NavItem[];
+}
+interface PluginRegistration {
+    id: string;
+    navItems?: NavItem[];
+    /**
+     * Route path pattern -> page component. Patterns support exact paths and
+     * dynamic segments in either `:id`, `[id]`, or `$id` form.
+     */
+    routes?: Record<string, ComponentType<any>>;
+    /**
+     * Map of slot name → component. Registered with the default order (100).
+     * Components are typed as `ComponentType<any>` because different slots
+     * accept different prop shapes (e.g. `page:/team/[id]` takes `agentId`,
+     * `asset-preview` takes `asset`) and `Slot` threads props through unchanged.
+     * For fine-grained ordering, call `registerSlot(name, Component, order, id)`
+     * directly from the plugin's client.tsx alongside registerPlugin.
+     */
+    slots?: Record<string, ComponentType<any>>;
+}
+interface ClientRouteEntry {
+    path: string;
+    component: ComponentType<Record<string, unknown>>;
+    owner: string;
+}
+/**
+ * Register everything a plugin contributes in one call. Invoked at the top
+ * of the plugin's client.tsx (or on dynamic import by the host's PluginHost).
+ */
+export declare function registerPlugin(reg: PluginRegistration): void;
+/**
+ * Remove every contribution a plugin made — nav items, owned slot entries,
+ * and any plugin-local registry cleanup functions it enrolled via
+ * `registerPluginCleanup`. Idempotent. Used by the v2 dev-mode hot-swap
+ * path before re-importing the plugin's client bundle.
+ */
+export declare function unregisterPlugin(id: string): void;
+/**
+ * Enroll a teardown function for the given plugin id. Runs when
+ * `unregisterPlugin(id)` is called. Plugins that maintain their own
+ * client-side registries (workflows' node renderers, source definitions)
+ * use this to hook into the unified teardown path.
+ */
+export declare function registerPluginCleanup(id: string, fn: () => void): void;
+/**
+ * Monotonic counter bumped on every register / unregister. Used with
+ * React's `useSyncExternalStore` (via `subscribeRegistry`) so the shell
+ * re-renders nav + slots when plugins come or go at runtime.
+ */
+export declare function getRegistryVersion(): number;
+/**
+ * Subscribe to registry mutations. Returns an unsubscribe function.
+ */
+export declare function subscribeRegistry(listener: () => void): () => void;
+/**
+ * All nav items from all registered plugins, sorted by `order` (default 100).
+ * The shell's sidebar reads this at render time.
+ */
+export declare function getAllNavItems(): NavItem[];
+/**
+ * Stable nav snapshot for React's useSyncExternalStore. The returned array
+ * identity only changes when plugin registration changes.
+ */
+export declare function getNavItemsSnapshot(): readonly NavItem[];
+/**
+ * Nav items for a specific plugin. Returned as a readonly copy.
+ */
+export declare function getPluginNavItems(pluginId: string): ReadonlyArray<NavItem>;
+export interface MatchedPluginRoute {
+    pluginId: string;
+    path: string;
+    component: ComponentType<Record<string, unknown>>;
+    params: Record<string, string>;
+}
+export declare function getPluginRoute(pathname: string): MatchedPluginRoute | null;
+export declare function getPluginRoutes(pluginId?: string): ReadonlyArray<ClientRouteEntry>;
+export type { NavItem, PluginRegistration, ClientRouteEntry };

package/routing/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * `@bakin/sdk/routing` — typed route contracts for plugin authors.
+ *
+ * Re-exports from `@bakin/core/routing` for a single source of truth. The
+ * SDK's general type module (`@bakin/sdk/types`) keeps duplicated primitives
+ * for self-containment, but the routing surface re-exports because keeping
+ * two parallel `APIRoute<...>` definitions in sync is a debt we are
+ * deliberately avoiding.
+ */
+export { defineRoute, defineCoreRoute, definePlugin, } from '../_internal/core/routing';
+export type { HttpMethod, HttpStatus, RouteContext, PluginContextLite, CoreContext, JsonBodySpec, MultipartBodySpec, RawBodySpec, NoBodySpec, BodySpec, JsonResponseSpec, NoContentResponseSpec, NonJsonResponseSpec, ResponseSpec, ParsedInput, APIRoute, PluginWithRoutes, DefinePluginInput, } from '../_internal/core/routing';