@rizom/brain 0.2.0-alpha.46 → 0.2.0-alpha.48

package/dist/index.d.ts

@@ -1,50 +1,64 @@
-/** Public root library export for brain definitions and plugin API compatibility. */
-
-import type { Plugin } from "./plugins";
-
-export const PLUGIN_API_VERSION: string;
-
-export type BrainEnvironment = Record<string, string | undefined>;
-export type PluginConfig = Record<string, unknown>;
-export type CapabilityConfig =
-  | PluginConfig
-  | ((env: BrainEnvironment) => PluginConfig)
-  | undefined;
-export type PluginFactory = (config: PluginConfig) => Plugin | Plugin[];
-export type CapabilityEntry = [
-  id: string,
-  factory: PluginFactory,
-  config: CapabilityConfig,
+/** Public brain definition contract for external authors. */
+type BrainEnvironment = Record<string, string | undefined>;
+type PluginConfig = Record<string, unknown>;
+interface Plugin {
+    readonly id: string;
+    readonly version: string;
+    readonly type: "core" | "entity" | "service" | "interface";
+    readonly packageName: string;
+    readonly description?: string;
+    readonly dependencies?: string[];
+    ready?(): Promise<void>;
+    shutdown?(): Promise<void>;
+    requiresDaemonStartup?(): boolean;
+}
+type CapabilityConfig = PluginConfig | ((env: BrainEnvironment) => PluginConfig) | undefined;
+type PluginFactory = (config: PluginConfig) => Plugin | Plugin[];
+type CapabilityEntry = [
+    id: string,
+    factory: PluginFactory,
+    config: CapabilityConfig
 ];
-export type InterfaceConstructor = new (config: PluginConfig) => Plugin;
-export type InterfaceEntry = [
-  id: string,
-  constructor: InterfaceConstructor,
-  envMapper: (env: BrainEnvironment) => PluginConfig | null,
+type InterfaceConstructor = new (config: PluginConfig) => Plugin;
+type InterfaceEntry = [
+    id: string,
+    constructor: InterfaceConstructor,
+    envMapper: (env: BrainEnvironment) => PluginConfig | null
 ];
-export type PresetName = "core" | "default" | "full";
-export type BrainMode = "eval";
-
-export interface BrainIdentity {
-  characterName: string;
-  role: string;
-  purpose: string;
-  values: string[];
+type PresetName = "core" | "default" | "full";
+type BrainMode = "eval";
+interface BrainIdentity {
+    characterName: string;
+    role: string;
+    purpose: string;
+    values: string[];
 }
-export interface BrainDefinition {
-  name: string;
-  version: string;
-  model?: string;
-  identity?: BrainIdentity;
-  site?: unknown;
-  theme?: string;
-  capabilities: CapabilityEntry[];
-  interfaces: InterfaceEntry[];
-  presets?: Partial<Record<PresetName, string[]>>;
-  defaultPreset?: PresetName;
-  permissions?: unknown;
-  deployment?: unknown;
-  evalDisable?: string[];
-  extra?: Record<string, unknown>;
+interface BrainDefinition {
+    name: string;
+    version: string;
+    model?: string;
+    identity?: BrainIdentity;
+    site?: unknown;
+    theme?: string;
+    capabilities: CapabilityEntry[];
+    interfaces: InterfaceEntry[];
+    presets?: Partial<Record<PresetName, string[]>>;
+    defaultPreset?: PresetName;
+    permissions?: unknown;
+    deployment?: unknown;
+    evalDisable?: string[];
+    extra?: Record<string, unknown>;
 }
-export function defineBrain(definition: BrainDefinition): BrainDefinition;
+declare function defineBrain(definition: BrainDefinition): BrainDefinition;
+
+/**
+ * Pre-v1 external plugin API marker.
+ *
+ * During alpha, the external plugin API compatibility marker tracks the
+ * published @rizom/brain package version. Once the plugin API is declared
+ * stable, this can move to an independent semver contract such as 1.0.0.
+ */
+declare const PLUGIN_API_VERSION: string;
+
+export { PLUGIN_API_VERSION, defineBrain };
+export type { BrainDefinition, BrainEnvironment, BrainIdentity, BrainMode, CapabilityConfig, CapabilityEntry, InterfaceConstructor, InterfaceEntry, Plugin, PluginConfig, PluginFactory, PresetName };