@vxnus/siduri 0.0.5 → 0.0.7

package/README.md

@@ -1,47 +1,66 @@
 # @vxnus/siduri
 
-Experimental CLI for creating and configuring Siduri companions.
+Experimental CLI for creating, diagnosing, and managing standalone Siduri companions powered by the `@siduri-x/*` organ ecosystem.
 
 Requires Node.js 20 or newer.
 
 ```bash
-npx @vxnus/siduri@0.0.5 create
+npx @vxnus/siduri create my-companion
 ```
 
-The companion name becomes the project directory. For example, answering
-`My Companion` creates `./my-companion/siduri.config.json` from the current
-directory.
+## Features
 
-The wizard configures the required Brain and Memory organs, then lets you
-enable or disable Voice, Knowledge, Behavior, Body, and Vision. Knowledge can
-come from an installed E pack, an E Hub distribution, or a hosted provider.
+- **Manifest-Driven Organ Discovery**: Dynamically discovers installed `@siduri-x/*` organs and generates custom, standalone ESM instance code.
+- **Zero Monolithic Bundling**: Scaffolds standard Node.js ESM projects with explicit dependency trees.
+- **Diagnostics (`siduri doctor`)**: Runs environment variable validation, external service checks, database health probes, and organ-specific assertions.
+- **Database Migrations (`siduri db push`)**: Inspects database-owning organs (such as `@siduri-x/memory`) and executes SQL migrations with SHA-256 integrity checksums.
 
-Brain providers:
+## CLI Usage
 
-- **OpenRouter** — managed model routing using `OPENROUTER_API_KEY`.
-- **OpenAI-compatible API** — a custom `baseUrl`, model ID, and API-key
-  environment variable.
+### 1. Create a Standalone Companion
 
-Memory currently uses PostgreSQL. The wizard lets you choose Local PostgreSQL,
-Neon, Supabase, or another PostgreSQL provider; all use `DATABASE_URL`. SQLite
-is shown as a future option but is not selectable in this release.
+```bash
+npx @vxnus/siduri create [directory]
+```
+
+The interactive wizard allows you to name your companion and select any combination of available `@siduri-x/*` organs. It generates:
+
+```text
+my-companion/
+├── package.json          # ESM package referencing only selected @siduri-x/* organs
+├── siduri.config.json    # Selected organ configurations
+├── siduri.schema.json    # Composed JSON Schema from organ manifests
+├── .env.example          # Only environment variables required by selected organs
+├── README.md             # Instance-specific guide
+└── src/
+    └── index.js          # Direct runtime bootstrapping with explicit organ factories
+```
+
+### 2. Run Diagnostics
+
+```bash
+npx @vxnus/siduri doctor [directory]
+```
+
+Inspects active configuration, checks required/optional environment variables, and executes health probes.
+
+### 3. Apply Migrations
+
+```bash
+npx @vxnus/siduri db push [directory]
+```
+
+Runs database migrations exclusively for configured database organs. If no database organs are selected (e.g. Brain + Hands), reports that no migrations are needed.
 
-The wizard creates a project directory from the companion name, writes
-`siduri.config.json`, copies the Siduri runtime, and installs the runtime
-dependencies. API keys are never written to the configuration file. Optional
-organs can be configured as `{ "provider": "none" }`; Brain and Memory remain
-required.
+## Local Development
 
-After setup, start the generated instance with:
+From the repository root:
 
 ```bash
-cd my-companion
-npm run start
+pnpm --filter @vxnus/siduri build
+pnpm --filter @vxnus/siduri test
 ```
 
-For local development, build the CLI from the repository root with
-`pnpm --filter @vxnus/siduri build`. For the full architecture, see the
-[CLI documentation](../docs/cli.md) and
-[configuration reference](../docs/configuration.md).
+## License
 
-This release is experimental and is not intended for production use.
+Licensed under the [Apache License, Version 2.0](./LICENSE).

package/dist/builtin-manifests.d.ts

@@ -0,0 +1,2 @@
+import { OrganManifest } from './manifest';
+export declare const BUILTIN_ORGAN_MANIFESTS: OrganManifest[];

package/dist/builtin-manifests.js

@@ -0,0 +1,433 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BUILTIN_ORGAN_MANIFESTS = void 0;
+exports.BUILTIN_ORGAN_MANIFESTS = [
+    {
+        name: '@siduri-x/behavior',
+        organType: 'behavior',
+        version: '1.0.0',
+        displayName: 'Behavior (Active Self Directives)',
+        description: 'Atomic directive state machine and personality projection compiler',
+        entrypoint: './dist/index.js',
+        factory: 'ActiveSelfCompiler',
+        configKey: 'behavior',
+        configSchema: {
+            type: 'object',
+            required: ['provider'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['active_self', 'none']
+                },
+                preset: {
+                    type: 'string'
+                }
+            }
+        },
+        environment: [],
+        services: [],
+        database: null,
+        healthCheck: null
+    },
+    {
+        name: '@siduri-x/body',
+        organType: 'body',
+        version: '1.0.0',
+        displayName: 'Body (Live2D & Avatar State)',
+        description: 'Renderer-agnostic avatar expression and embodiment event adapter',
+        entrypoint: './dist/index.js',
+        factory: 'NeutralBodyOrgan',
+        configKey: 'body',
+        configSchema: {
+            type: 'object',
+            required: ['provider'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['live2d', 'none']
+                },
+                initialExpression: {
+                    type: 'string',
+                    default: 'neutral'
+                }
+            }
+        },
+        environment: [],
+        services: [],
+        database: null,
+        healthCheck: null
+    },
+    {
+        name: '@siduri-x/brain',
+        organType: 'brain',
+        version: '1.0.0',
+        displayName: 'Brain (Cognition & Planning)',
+        description: 'Provider-neutral LLM reasoning, response planning, and proposal generation',
+        entrypoint: './dist/index.js',
+        factory: 'OpenRouterBrain',
+        configKey: 'brain',
+        configSchema: {
+            type: 'object',
+            required: ['provider', 'model'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['openrouter', 'openai-compatible']
+                },
+                model: {
+                    type: 'string'
+                },
+                apiKey: {
+                    type: 'string'
+                },
+                apiKeyEnv: {
+                    type: 'string',
+                    default: 'OPENROUTER_API_KEY'
+                },
+                baseUrl: {
+                    type: 'string'
+                }
+            }
+        },
+        environment: [
+            {
+                name: 'OPENROUTER_API_KEY',
+                required: false,
+                secret: true,
+                description: 'API key for OpenRouter managed routing'
+            },
+            {
+                name: 'OPENAI_COMPATIBLE_API_KEY',
+                required: false,
+                secret: true,
+                description: 'API key for OpenAI-compatible endpoint'
+            }
+        ],
+        services: [
+            {
+                name: 'LLM Inference API',
+                kind: 'http_service',
+                optional: false
+            }
+        ],
+        database: null,
+        healthCheck: 'probeBrainHealth'
+    },
+    {
+        name: '@siduri-x/ear',
+        organType: 'ear',
+        version: '1.0.0',
+        displayName: 'Ear (Perception Ingress)',
+        description: 'Multi-modal sensory input ingestion, transcription bounds, and mime validation',
+        entrypoint: './dist/index.js',
+        factory: 'DefaultEarOrgan',
+        configKey: 'ear',
+        configSchema: {
+            type: 'object',
+            properties: {
+                defaultSource: {
+                    type: 'string',
+                    default: 'text_chat'
+                },
+                maxTextLength: {
+                    type: 'number',
+                    default: 4000
+                },
+                maxAudioBytes: {
+                    type: 'number',
+                    default: 10485760
+                }
+            }
+        },
+        environment: [],
+        services: [],
+        database: null,
+        healthCheck: null
+    },
+    {
+        name: '@siduri-x/hands',
+        organType: 'hands',
+        version: '1.0.0',
+        displayName: 'Hands (MCP Tool Execution)',
+        description: 'Model Context Protocol tool management and cryptographically authorized action execution',
+        entrypoint: './dist/index.js',
+        factory: 'DefaultHandsOrgan',
+        configKey: 'hands',
+        configSchema: {
+            type: 'object',
+            properties: {
+                defaultTimeoutMs: {
+                    type: 'number',
+                    default: 10000
+                },
+                providers: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: ['serverName'],
+                        properties: {
+                            serverName: {
+                                type: 'string'
+                            },
+                            baseUrl: {
+                                type: 'string'
+                            },
+                            command: {
+                                type: 'string'
+                            },
+                            args: {
+                                type: 'array',
+                                items: {
+                                    type: 'string'
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        environment: [
+            {
+                name: 'ACTION_POLICY_SECRET',
+                required: false,
+                secret: true,
+                description: 'HMAC secret key for signing and verifying action execution capabilities (required in production)'
+            }
+        ],
+        services: [],
+        database: null,
+        healthCheck: 'probeHandsHealth'
+    },
+    {
+        name: '@siduri-x/knowledge',
+        organType: 'knowledge',
+        version: '1.0.0',
+        displayName: 'Knowledge (E-Compatible Cited Facts)',
+        description: 'Factual context retrieval from local or hosted E Knowledge packs',
+        entrypoint: './dist/index.js',
+        factory: 'EKnowledgeAdapter',
+        configKey: 'knowledge',
+        configSchema: {
+            type: 'object',
+            required: ['provider'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['e-knowledge', 'e-remote', 'e-hub', 'none']
+                },
+                packPath: {
+                    type: 'string'
+                },
+                baseUrl: {
+                    type: 'string'
+                },
+                registryUrl: {
+                    type: 'string'
+                },
+                packId: {
+                    type: 'string'
+                },
+                timeoutMs: {
+                    type: 'number',
+                    default: 5000
+                },
+                preferredMode: {
+                    type: 'string',
+                    enum: ['lexical', 'semantic', 'hybrid'],
+                    default: 'lexical'
+                }
+            }
+        },
+        environment: [
+            {
+                name: 'SIDURI_KNOWLEDGE_PACK',
+                required: false,
+                secret: false,
+                description: 'Path to local E knowledge pack'
+            },
+            {
+                name: 'SIDURI_KNOWLEDGE_REGISTRY_URL',
+                required: false,
+                secret: false,
+                default: 'https://e.vxnus.xyz/api/v1/knowledge',
+                description: 'URL of the E Knowledge Hub registry'
+            }
+        ],
+        services: [
+            {
+                name: 'E Knowledge Hub',
+                kind: 'http_service',
+                optional: true
+            }
+        ],
+        database: null,
+        healthCheck: null
+    },
+    {
+        name: '@siduri-x/memory',
+        organType: 'memory',
+        version: '1.0.0',
+        displayName: 'Memory (PostgreSQL FTS Claims)',
+        description: 'Relational semantic claims with Full-Text Search and companion isolation',
+        entrypoint: './dist/index.js',
+        factory: 'PostgresMemoryOrgan',
+        configKey: 'memory',
+        configSchema: {
+            type: 'object',
+            required: ['provider'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['postgres']
+                },
+                deployment: {
+                    type: 'string',
+                    enum: ['local', 'neon', 'supabase', 'other']
+                },
+                connectionString: {
+                    type: 'string'
+                },
+                maxConnections: {
+                    type: 'number',
+                    default: 10
+                }
+            }
+        },
+        environment: [
+            {
+                name: 'DATABASE_URL',
+                required: true,
+                secret: true,
+                default: 'postgresql://postgres:postgres@localhost:5432/siduri',
+                description: 'PostgreSQL connection string'
+            }
+        ],
+        services: [
+            {
+                name: 'PostgreSQL Database',
+                kind: 'database',
+                optional: false
+            }
+        ],
+        database: {
+            engine: 'postgres',
+            migrationsDir: './migrations'
+        },
+        healthCheck: 'probeMemoryHealth'
+    },
+    {
+        name: '@siduri-x/observation',
+        organType: 'observation',
+        version: '1.0.0',
+        displayName: 'Observation (Grounded Observation Ingestion)',
+        description: 'Cryptographically hashed video/image observation ingest and duplicate detection',
+        entrypoint: './dist/index.js',
+        factory: 'FixtureObservationOrgan',
+        configKey: 'observation',
+        configSchema: {
+            type: 'object',
+            properties: {}
+        },
+        environment: [],
+        services: [],
+        database: null,
+        healthCheck: null
+    },
+    {
+        name: '@siduri-x/vision',
+        organType: 'vision',
+        version: '1.0.0',
+        displayName: 'Vision (Visual Perception & OCR)',
+        description: 'Image inspection, cropping, and multi-pass OCR perception adapter',
+        entrypoint: './dist/index.js',
+        factory: 'OpenRouterVisionAdapter',
+        configKey: 'vision',
+        configSchema: {
+            type: 'object',
+            required: ['provider'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['openrouter', 'none']
+                },
+                model: {
+                    type: 'string',
+                    default: 'gpt-4-vision'
+                },
+                apiKey: {
+                    type: 'string'
+                },
+                baseUrl: {
+                    type: 'string'
+                }
+            }
+        },
+        environment: [
+            {
+                name: 'OPENROUTER_API_KEY',
+                required: false,
+                secret: true,
+                description: 'API key for vision model inference'
+            }
+        ],
+        services: [
+            {
+                name: 'Vision Inference API',
+                kind: 'http_service',
+                optional: false
+            }
+        ],
+        database: null,
+        healthCheck: null
+    },
+    {
+        name: '@siduri-x/voice',
+        organType: 'voice',
+        version: '1.0.0',
+        displayName: 'Voice (VOICEVOX Speech Synthesis)',
+        description: 'Queued speech synthesis and audio rendering lifecycle adapter',
+        entrypoint: './dist/index.js',
+        factory: 'VoicevoxAdapter',
+        configKey: 'voice',
+        configSchema: {
+            type: 'object',
+            required: ['provider'],
+            properties: {
+                provider: {
+                    type: 'string',
+                    enum: ['voicevox', 'none']
+                },
+                speakerId: {
+                    type: 'number',
+                    default: 1
+                },
+                baseUrl: {
+                    type: 'string',
+                    default: 'http://localhost:50021'
+                },
+                maxQueueDepth: {
+                    type: 'number',
+                    default: 50
+                }
+            }
+        },
+        environment: [
+            {
+                name: 'VOICEVOX_URL',
+                required: false,
+                secret: false,
+                default: 'http://localhost:50021',
+                description: 'Base URL of the running VOICEVOX engine'
+            }
+        ],
+        services: [
+            {
+                name: 'VOICEVOX Engine',
+                kind: 'http_service',
+                optional: false
+            }
+        ],
+        database: null,
+        healthCheck: null
+    }
+];

package/dist/clean-machine-e2e.test.d.ts

@@ -0,0 +1 @@
+export {};