@vibesdotdev/config 0.0.1 → 0.0.2

package/README.md

@@ -1,85 +1,22 @@
 # @vibesdotdev/config
 
-Schema-driven configuration for vibes. Zod schemas define config types; the
-runtime resolves storage, environment overlays, and surface forms.
+Configuration manifests, environment resolution, and validation utilities for Vibes applications.
 
-## Quickstart
+This package is part of the public Vibes framework package set. The source repository is private while the public repository split is being prepared, so package documentation is published on the Vibes docs site.
 
-### Define a manifest
+## Install
 
-```ts
-import { z } from 'zod';
-import { createConfigManifest } from '@vibesdotdev/config/manifest';
-import { configField } from '@vibesdotdev/config/schema';
-
-export const appConfig = createConfigManifest({
-  id: 'app-config',
-  name: 'Application Settings',
-  tier: 'user',
-  schema: z.object({
-    apiEndpoint: z.string().url().default('http://localhost:3000'),
-    timeout: z.number().default(30000),
-    features: z.object({
-      experimental: z.boolean().default(false),
-    }),
-  }),
-  fields: {
-    apiEndpoint: configField('API Endpoint').description('Base URL for API requests'),
-    timeout: configField('Timeout').description('Request timeout in milliseconds'),
-    'features.experimental': configField('Experimental Features').component('toggle'),
-  },
-  storage: { namespace: 'app', adapter: 'localdb' },
-});
-```
-
-### Load / get / set
-
-```ts
-import { ConfigManifest } from '@vibesdotdev/config';
-
-const config = new ConfigManifest('app-config');
-const values = await config.load();
-const timeout = await config.get('timeout', 30000);
-await config.set('features.experimental', true);
-```
-
-### Render a form (Svelte)
-
-```svelte
-<script>
-  import ManifestForm from '@vibesdotdev/config/adapters/web/components/ManifestForm.svelte';
-  import { appConfig } from './app-config';
-</script>
-
-<ManifestForm manifest={appConfig} onSubmit={(v) => saveConfig(v)} />
+```sh
+bun add @vibesdotdev/config
+# or
+npm install @vibesdotdev/config
 ```
 
-### Render a form (CLI)
+## Documentation
 
-```ts
-import { runManifestPrompts } from '@vibesdotdev/config/adapters/cli';
-
-const values = await runManifestPrompts(appConfig);
-```
-
-### Diagnose
-
-```ts
-import { diagnoseConfig } from '@vibesdotdev/config/doctor';
-
-const result = diagnoseConfig(manifest, values);
-for (const issue of result.issues) {
-  console.log(`[${issue.severity}] ${issue.path}: ${issue.message}`);
-}
-```
-
-## Test
-
-```bash
-bun --bun vitest run
-```
+- Package guide: https://docs.vibes.dev/packages/config
+- Vibes docs: https://docs.vibes.dev
 
-## Docs
+## License
 
-- [SPEC.md](./SPEC.md) — package contract, owned surfaces, hard rules
-- [runtime](../runtime/SPEC.md), [storage](../storage/SPEC.md), [tui](../tui/SPEC.md), [cli](../cli/SPEC.md)
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibesdotdev/config",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -364,13 +364,8 @@
     "registry": "https://registry.npmjs.org",
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vibesdotdev/monorepo.git",
-    "directory": "packages/config"
-  },
   "peerDependencies": {
-    "@vibesdotdev/runtime": "0.0.1"
+    "@vibesdotdev/runtime": "0.0.2"
   },
   "dependencies": {
     "js-yaml": "^4.1.1",
@@ -392,7 +387,6 @@
     "src",
     "bin",
     "README.md",
-    "SPEC.md",
     "LICENSE",
     "!src/**/__tests__/**",
     "!src/**/__stubs__/**",
@@ -413,5 +407,10 @@
   ],
   "vibes": {
     "visibility": "public-framework"
+  },
+  "description": "Configuration manifests, environment resolution, and validation utilities for Vibes applications.",
+  "homepage": "https://docs.vibes.dev/packages/config",
+  "bugs": {
+    "url": "https://docs.vibes.dev/packages/config#support"
   }
 }

package/SPEC.md

@@ -1,71 +0,0 @@
-# @vibesdotdev/config
-
-Schema-driven configuration. Zod schemas define config types; the runtime resolves storage, environment overlays, and surface forms.
-
-## Owns
-
-- **Runtime kinds:** `config/manifest`, `config/collection`, `config/environment`, `settings/section`
-- **`ConfigManifest<T>`** (`./manifest`): load, get, set, validate against a Zod schema; resolves storage adapter through the runtime
-- **`ConfigCollection`** (`./collection`): grouped/related manifests
-- **`SettingsSectionDescriptor`** (`./settings`): pure-data contribution kind. Each owning module registers one or more `settings/section` descriptors naming the `config/manifest` IDs in its section. `assembleSettingsSections(runtime)` concatenates every registered section sorted by `order`. Config never enumerates which sections exist.
-- **Environment system** (`./environment`): `local`, `staging`, `production` descriptors + `environment.plugin`; current-environment detection; per-env value overlays
-- **Form core** (`./form/core`): field resolution, Zod validation, visibility rules, groups
-- **Generic env helpers** (`./env`, `./env.runtime`): `getEnv` / `getEnvNumber` / `getEnvBoolean` / `validateRequiredEnv` / `readRuntimeEnv`. Isomorphic (Node + browser). **No monorepo-wide `env` aggregate** — domain env lives with the domain.
-- **Surface adapters:**
-  - `./adapters/cli` — Inquirer-based prompts
-  - `./adapters/web` — `ManifestForm.svelte` and Svelte form components
-  - `./tui` — OpenTUI/React `config-settings` and `config-registry` descriptors + impls
-- **Loader** (`./loader`): file-loader, discovery, merge, validation, server/client entrypoints
-- **Schema utilities** (`./schema`, `./schemas`)
-- **Routing** (`./routing`): config route registry + merge
-- **CRUD primitives** (`./crud`): base types, schemas, shared helpers
-- **Extensions** (`./extensions`): pluggable extension registry
-- **Services** (`./services`): config accessor, manifest utils, encryption (AES-256-GCM + PBKDF2)
-- **Doctor** (`./doctor`): generic `diagnoseConfig(manifest, values, options)`
-- **Plugins:** `./config.plugin` (core), `./environment/environment.plugin`
-- **Context:** `config.context.descriptor` (DI handle for resolved config)
-
-## Does not own
-
-- Storage implementations / adapters → [`storage`](../storage/SPEC.md). Config consumes `storage/adapter` through the runtime.
-- Secrets backends (keychain, OS credential store) → [`secrets`](../secrets/SPEC.md). Encryption hands off to storage's encrypted adapters.
-- TUI substrate (gateway, dispatcher, kinds) → [`tui`](../tui/SPEC.md). Config registers TUI assets against tui-owned kinds.
-- CLI runtime / command dispatcher → [`cli`](../cli/SPEC.md).
-- Domain-specific config manifests (AI providers, chat modes, knowledge sources, etc.). Each owning module defines its own `config/manifest` descriptors.
-- AI-specific diagnostics (`diagnoseAIConfig`), AI source maps, chat-mode normalizers — **migrated to `packages/ai/src/config/` on 2026-05-09.** See [`packages/ai/SPEC.md`](../ai/SPEC.md) and `@vibesdotdev/ai/config/*` exports.
-- **Domain env values.** AI provider URLs/keys, OAuth callback URLs, Linear team/status IDs, SMTP/Proton, scheduler crons, rate limits, etc. — owned by the consuming module (`packages/ai`, `packages/auth`, `packages/workers`, `apps/auth-web`, etc.). Config supplies `getEnv` / `getEnvBoolean` / `getEnvNumber`; the domain builds its own typed env from them. **Removed 2026-05-11** along with `./system`, `./schemas/env`, `./schemas/system`, `./settings`, `./form/navigation`.
-- **Hard-coded global settings layout.** The old `./settings/manifest.ts` enumerated domain manifest IDs (`ai.providers`, `chat.modes`, `knowledge.bases`, …) in a single hard-coded list — that violated the no-domain-manifests rule. The current `./settings` exposes the `settings/section` contribution kind instead: each owning module's plugin registers its section via `descriptors: [...]` and `assembleSettingsSections(runtime)` concatenates them. Config never enumerates which sections exist.
-- **`DEFAULT_PAGES` navigation table.** Same pattern — the deleted `./form/navigation` bundled an `ai`/`knowledge`/`session` page list. If page-tree navigation comes back, the page list is supplied by callers, not baked into config.
-
-## Hard rules
-
-- **All config access goes through `ConfigManifest` or storage manifest.** No raw `fs.readFileSync` / `node:fs/promises` in config code. All persistence is runtime-resolved through storage adapters.
-- **Resolution order is canonical:** env var → env-specific config file → base config file → schema default. Don't invent alternative orders.
-- **Sensitive values use storage-adapter encryption, not Zod markers.** No `.encrypted()` extension on schemas. Encryption is a property of the storage adapter the manifest binds to.
-- **Storage adapter selection is runtime-resolved.** Manifests declare what storage they want; the runtime picks the implementation. No `if (isCloud)` branches in config code.
-- **Bootstrap order:** `storage` plugin → `config.plugin` → `environment.plugin` → consumers. Do not reorder.
-- **`./ai/*` subpath removed (2026-05-09).** AI config utilities now live at `@vibesdotdev/ai/config/*`. Do not recreate.
-- **No `config.ai` state here.** The stable `config.ai` TUI state id is registered by `@vibesdotdev/ai`; consumers resolve it through `runtime.query('tui/state')`.
-- **No domain manifests in this package.** If a manifest is "AI providers" or "chat modes" or "tools agents," it lives in the owning module, not here.
-- **No monorepo-wide `env` aggregate.** `@vibesdotdev/config/env` exports only the generic helpers (`getEnv`, `getEnvNumber`, `getEnvBoolean`, `validateRequiredEnv`). Do not reintroduce a `services.{ollama,…}` / `ai.{openai,…}` / `oauth.{github,…}` / `email.{…}` god-object. Domain env lives with the domain.
-- **Domain env must be Zod-validated at its owning module's boundary.** Each owning module's `src/config/env.schema.ts` defines a Zod schema; `env.ts` parses `process.env` once through that schema and exports a typed value. No untyped `process.env.X` access in feature code.
-- **Global settings layout is contributed, not enumerated.** Surfaces call `assembleSettingsSections(runtime)`; modules contribute `settings/section` descriptors via their plugin's `descriptors: [...]`. The owning module decides which of its `config/manifest` IDs participate in its section.
-
-## Public entrypoints
-
-`package.json#exports` is canonical. Grouped: `.`, `./manifest/*`, `./form` + `./form/core/*`, `./loader/*`, `./schema/*`, `./schemas/*`, `./routing/*`, `./crud/*`, `./collection/*`, `./extensions/*`, `./services/*`, `./settings` + `./settings/*`, `./adapters/cli/*`, `./adapters/web/*`, `./browser`, `./server`, `./common`, `./cli/*`, `./tui/*`, `./environment/*`, `./client/*`, `./env`, `./env.runtime`, `./system-constants`, `./doctor`, `./plugin` (= `./config.plugin`).
-
-Removed entries (do not reintroduce without restoring the domain-ownership review): `./system`, `./form/navigation`, `./form/navigation/*`, `./schemas/env`, `./schemas/system`.
-
-Note: `./settings` is reintroduced as the runtime-first contribution surface (descriptor schema + assembly helper). It does **not** export a hard-coded manifest list — see Hard rules.
-
-## Verification
-
-`bun --bun vitest run` from package root. Covers manifest CRUD, form core (field resolution, validation, visibility), encryption roundtrip, environment detection, doctor diagnostics, loader/merge.
-
-## Links
-
-- [runtime/SPEC.md](../runtime/SPEC.md)
-- [storage/SPEC.md](../storage/SPEC.md)
-- [tui/SPEC.md](../tui/SPEC.md)
-- [cli/SPEC.md](../cli/SPEC.md)