botinabox 0.2.1 → 0.2.3

package/dist/index.d.ts

@@ -517,6 +517,8 @@ interface EntityContextDef {
     slugColumn: string;
     files: Record<string, EntityFileSpec>;
     indexFile?: string;
+    /** Custom index render function. If omitted, a default listing is generated. */
+    indexRender?: (rows: Row[]) => string;
     protectedFiles?: string[];
     /** When true, this entity's data is never rendered into other entities' context files. */
     protected?: boolean;
@@ -970,6 +972,20 @@ declare const CORE_MIGRATIONS: Array<{
     sql: string;
 }>;
 
+/**
+ * Define default entity context rendering for botinabox core tables.
+ * Call after defineCoreTables() and before or after init().
+ *
+ * Renders:
+ * - agents/ — per-agent context (AGENT.md, PROJECTS.md if agent_project exists)
+ * - users/  — per-user context (USER.md) — protected
+ * - skills/ — per-skill context (SKILL.md)
+ *
+ * Apps can override by calling db.defineEntityContext() with the same table name
+ * BEFORE calling defineCoreEntityContexts().
+ */
+declare function defineCoreEntityContexts(db: DataStore): void;
+
 interface SanitizerOptions {
     fieldLengthLimits?: Record<string, number>;
     truncateSuffix?: string;
@@ -1357,4 +1373,4 @@ declare class SecretStore {
     private _toMeta;
 }
 
-export { AGENT_STATUSES, type AgentConfig, type AgentDefinition, type AgentFilter, type AgentRecord, AgentRegistry, type AgentStatus, ApiExecutionAdapter, AuditEmitter, type AuditEvent, BackupManager, type BotConfig, type BudgetCheck, type BudgetConfig, BudgetController, CORE_MIGRATIONS, ChannelAdapter, ChannelRegistry, ChannelRegistryError, ChatMessage, ChatSessionManager, CliExecutionAdapter, type ColumnValidator, ColumnValidatorImpl, type ConfigLoadError, type ConfigLoadResult, DEFAULTS, DEFAULT_CONFIG, type DataConfig, DataStore, DataStoreError, EVENTS, type EntityColumnDef, type EntityConfig, type EntityContextDef, type EntityFileSpec, type EntitySource, type ExecutionAdapter, type Filter, HealthStatus, HeartbeatScheduler, HookBus, type HookHandler, type HookOptions, type HookRegistration, InboundMessage, LLMProvider, MAX_CHAIN_DEPTH, MessagePipeline, type ModelConfig, ModelInfo, ModelRouter, NdjsonLogger, NotificationQueue, type PackageMigration, type PackageUpdate, type PkLookup, ProviderRegistry, type QueryOptions, RUN_STATUSES, type RelationDef, type RenderConfig, ResolvedModel, type RetryPolicy, type Row, type RunContext, RunManager, type RunResult, type RunStatus, type SanitizerOptions, type SchemaError, type SecretInput, type SecretMeta, SecretStore, type SecurityConfig, type SeedItem, SessionKey, SessionManager, type SqliteAdapter, type StepRef, TASK_STATUSES, type TableDefinition, type TableInfoRow, type TaskDefinition, TaskQueue, type TaskRecord, type TaskStatus, TokenUsage, type Unsubscribe, UpdateChecker, type UpdateConfig, UpdateManager, type UpdateManifest, type User, type UserInput, UserRegistry, WakeupQueue, type WorkflowConfigEntry, type WorkflowDefinition$1 as WorkflowDefinition, WorkflowEngine, type WorkflowRunRecord, type WorkflowRunStatus, type WorkflowStep$1 as WorkflowStep, type WorkflowStepConfig, type WorkflowTrigger, _resetConfig, areDependenciesMet, buildAgentBindings, buildChainOrigin, checkAllowlist, checkChainDepth, checkMentionGate, chunkText, classifyUpdate, compareVersions, createConfigRevision, defineCoreTables, detectCycle, discoverChannels, discoverProviders, formatText, getConfig, initConfig, interpolate, interpolateEnv, loadConfig, parseVersion, runPackageMigrations, sanitize, topologicalSort, validateConfig };
+export { AGENT_STATUSES, type AgentConfig, type AgentDefinition, type AgentFilter, type AgentRecord, AgentRegistry, type AgentStatus, ApiExecutionAdapter, AuditEmitter, type AuditEvent, BackupManager, type BotConfig, type BudgetCheck, type BudgetConfig, BudgetController, CORE_MIGRATIONS, ChannelAdapter, ChannelRegistry, ChannelRegistryError, ChatMessage, ChatSessionManager, CliExecutionAdapter, type ColumnValidator, ColumnValidatorImpl, type ConfigLoadError, type ConfigLoadResult, DEFAULTS, DEFAULT_CONFIG, type DataConfig, DataStore, DataStoreError, EVENTS, type EntityColumnDef, type EntityConfig, type EntityContextDef, type EntityFileSpec, type EntitySource, type ExecutionAdapter, type Filter, HealthStatus, HeartbeatScheduler, HookBus, type HookHandler, type HookOptions, type HookRegistration, InboundMessage, LLMProvider, MAX_CHAIN_DEPTH, MessagePipeline, type ModelConfig, ModelInfo, ModelRouter, NdjsonLogger, NotificationQueue, type PackageMigration, type PackageUpdate, type PkLookup, ProviderRegistry, type QueryOptions, RUN_STATUSES, type RelationDef, type RenderConfig, ResolvedModel, type RetryPolicy, type Row, type RunContext, RunManager, type RunResult, type RunStatus, type SanitizerOptions, type SchemaError, type SecretInput, type SecretMeta, SecretStore, type SecurityConfig, type SeedItem, SessionKey, SessionManager, type SqliteAdapter, type StepRef, TASK_STATUSES, type TableDefinition, type TableInfoRow, type TaskDefinition, TaskQueue, type TaskRecord, type TaskStatus, TokenUsage, type Unsubscribe, UpdateChecker, type UpdateConfig, UpdateManager, type UpdateManifest, type User, type UserInput, UserRegistry, WakeupQueue, type WorkflowConfigEntry, type WorkflowDefinition$1 as WorkflowDefinition, WorkflowEngine, type WorkflowRunRecord, type WorkflowRunStatus, type WorkflowStep$1 as WorkflowStep, type WorkflowStepConfig, type WorkflowTrigger, _resetConfig, areDependenciesMet, buildAgentBindings, buildChainOrigin, checkAllowlist, checkChainDepth, checkMentionGate, chunkText, classifyUpdate, compareVersions, createConfigRevision, defineCoreEntityContexts, defineCoreTables, detectCycle, discoverChannels, discoverProviders, formatText, getConfig, initConfig, interpolate, interpolateEnv, loadConfig, parseVersion, runPackageMigrations, sanitize, topologicalSort, validateConfig };

package/dist/index.js

@@ -1140,7 +1140,25 @@ var DataStore = class {
       protectedFiles: def.protectedFiles,
       protected: def.protected,
       encrypted: def.encrypted,
-      index: def.indexFile ? { outputFile: def.indexFile, render: (rows) => "" } : void 0
+      index: def.indexFile ? {
+        outputFile: def.indexFile,
+        render: def.indexRender ?? ((rows) => {
+          const title = def.directory.charAt(0).toUpperCase() + def.directory.slice(1);
+          if (!rows.length) return `# ${title}
+
+None.
+`;
+          const lines = rows.map((r) => {
+            const name2 = String(r.name ?? r[def.slugColumn] ?? r.id ?? "unknown");
+            const status = r.status ? ` (${r.status})` : "";
+            return `- **${name2}**${status}`;
+          });
+          return `# ${title}
+
+${lines.join("\n")}
+`;
+        })
+      } : void 0
     });
   }
   async init(opts) {
@@ -1570,6 +1588,86 @@ var CORE_MIGRATIONS = [
   }
 ];
 
+// src/core/data/core-entity-contexts.ts
+function defineCoreEntityContexts(db) {
+  db.defineEntityContext("agents", {
+    table: "agents",
+    directory: "agents",
+    slugColumn: "slug",
+    indexFile: "agents/AGENTS.md",
+    files: {
+      "AGENT.md": {
+        source: { type: "self" },
+        render: (rows) => {
+          const a = rows[0];
+          if (!a) return "";
+          return [
+            `# ${a.name}`,
+            "",
+            a.role ? `**Role:** ${a.role}` : null,
+            a.status ? `**Status:** ${a.status}` : null,
+            a.cwd ? `**Working Directory:** ${a.cwd}` : null,
+            a.reports_to ? `**Reports To:** ${a.reports_to}` : null,
+            ""
+          ].filter(Boolean).join("\n");
+        }
+      }
+    }
+  });
+  db.defineEntityContext("users", {
+    table: "users",
+    directory: "users",
+    slugColumn: "name",
+    protected: true,
+    indexFile: "users/USERS.md",
+    files: {
+      "USER.md": {
+        source: { type: "self" },
+        render: (rows) => {
+          const u = rows[0];
+          if (!u) return "";
+          return [
+            `# ${u.name}`,
+            "",
+            u.role ? `**Role:** ${u.role}` : null,
+            u.title ? `**Title:** ${u.title}` : null,
+            u.email ? `**Email:** ${u.email}` : null,
+            u.timezone ? `**Timezone:** ${u.timezone}` : null,
+            ""
+          ].filter(Boolean).join("\n");
+        }
+      }
+    }
+  });
+  db.defineEntityContext("skills", {
+    table: "skills",
+    directory: "skills",
+    slugColumn: "slug",
+    indexFile: "skills/SKILLS.md",
+    files: {
+      "SKILL.md": {
+        source: { type: "self" },
+        render: (rows) => {
+          const s = rows[0];
+          if (!s) return "";
+          return [
+            `# ${s.name}`,
+            "",
+            s.category ? `**Category:** ${s.category}` : null,
+            s.description ? `
+${s.description}` : null,
+            s.definition ? `
+## Definition
+
+${s.definition}` : null,
+            ""
+          ].filter(Boolean).join("\n");
+        }
+      }
+    }
+  });
+}
+
 // src/core/security/sanitizer.ts
 import { Buffer as Buffer2 } from "buffer";
 var DEFAULT_FIELD_LIMIT = 65535;
@@ -3179,6 +3277,7 @@ export {
   classifyUpdate,
   compareVersions,
   createConfigRevision,
+  defineCoreEntityContexts,
   defineCoreTables,
   detectCycle,
   discoverChannels,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "botinabox",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Bot in a Box — framework for building multi-agent bots",
   "type": "module",
   "main": "./dist/index.js",