@vibesdotdev/logging 0.0.1 → 0.0.2

package/README.md

@@ -1,80 +1,22 @@
 # @vibesdotdev/logging
 
-Universal logging core for vibes. Defines the runtime kinds, the core logger,
-isomorphic sinks/formatters, and the audit kind. Environment-specific sinks
-(file, browser, OTEL) live in sibling packages.
+Structured logging contracts, levels, formatters, and runtime descriptors for Vibes packages.
 
-## 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.
 
-```ts
-import { getLogger, getDefaultLogger } from '@vibesdotdev/logging';
+## Install
 
-const logger = getLogger('myapp');
-logger.info('Started', { version: '1.0.0' });
-logger.error('Failed', { error: err.message });
-
-const child = logger.child('database');
-child.debug('Connected');
-
-const contextual = logger.withRequestContext({
-  requestId: 'req-123',
-  userId: 'user-456',
-});
-contextual.info('Request handled');
-```
-
-### Audit
-
-```ts
-import { auditLog } from '@vibesdotdev/logging/audit';
-
-await auditLog({
-  category: 'authentication',
-  severity: 'medium',
-  action: 'login',
-  actor: { id: 'user-123', type: 'user' },
-  outcome: 'success',
-});
-```
-
-### Filter via env
-
-```bash
-VIBES_LOG='vibes:pm:*,-vibes:pm:verbose' \
-VIBES_LOG_LEVEL=debug \
-bun run app
-```
-
-## CLI
-
-```bash
-vibes logs list
-vibes logs view <output>
-vibes logs tail <output>
-vibes logs search <pattern>
-vibes logs rotate <output>
+```sh
+bun add @vibesdotdev/logging
+# or
+npm install @vibesdotdev/logging
 ```
 
-## Sinks
+## Documentation
 
-Core ships isomorphic sinks only:
-- `console` — colorized stderr
-- `buffer` — in-memory startup buffer
-- `memory` — testable in-memory store
-- `stdout` — raw stderr (MCP-safe)
-
-Environment-specific sinks load from sibling packages (apps choose what to load):
-- [`@vibesdotdev/logging-fs`](../logging-fs/) — file sink, file output, stdout-capture, file-backed audit
-- [`@vibesdotdev/logging-browser`](../logging-browser/) — browser sink
-- [`@vibesdotdev/logging-otel`](../logging-otel/) — OpenTelemetry sink
-
-## Test
-
-```bash
-bun test
-```
+- Package guide: https://docs.vibes.dev/packages/logging
+- Vibes docs: https://docs.vibes.dev
 
-## Docs
+## License
 
-- [SPEC.md](./SPEC.md) — package contract, owned surfaces, hard rules, migration debt
-- [runtime](../runtime/SPEC.md), [runtime-plugin](../runtime-plugin/SPEC.md)
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibesdotdev/logging",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -280,16 +280,11 @@
     "registry": "https://registry.npmjs.org",
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vibesdotdev/monorepo.git",
-    "directory": "packages/logging"
-  },
   "peerDependencies": {
-    "@vibesdotdev/runtime": "0.0.1"
+    "@vibesdotdev/runtime": "0.0.2"
   },
   "dependencies": {
-    "@vibesdotdev/runtime": "0.0.1",
+    "@vibesdotdev/runtime": "0.0.2",
     "zod": "^4.3.6",
     "esm-env": "^1.2.2",
     "ansis": "^4.3.0",
@@ -306,7 +301,6 @@
     "src",
     "bin",
     "README.md",
-    "SPEC.md",
     "LICENSE",
     "!src/**/__tests__/**",
     "!src/**/__stubs__/**",
@@ -327,5 +321,10 @@
   ],
   "vibes": {
     "visibility": "public-framework"
+  },
+  "description": "Structured logging contracts, levels, formatters, and runtime descriptors for Vibes packages.",
+  "homepage": "https://docs.vibes.dev/packages/logging",
+  "bugs": {
+    "url": "https://docs.vibes.dev/packages/logging#support"
   }
 }

package/SPEC.md

@@ -1,65 +0,0 @@
-# @vibesdotdev/logging
-
-Structured logging for vibes. Universal core: kinds, schemas, core logger, isomorphic sinks/formatters/outputs, audit kind, MCP-safe defaults. Environment-specific sinks live in sibling packages and register themselves.
-
-## Owns
-
-- **Runtime kinds:** `logging/sink`, `logging/formatter`, `logging/output`, `logging/audit`, `logging/logger`
-- **Context providers:** `logging/sinks`, `logging/outputs`, `cli/logger`
-- **Core** (`./core`): `createRuntimeLogger`, `getLogger(namespace)`, `getDefaultLogger`, child loggers, `withRequestContext`, glob-based namespace settings + per-namespace level
-- **Isomorphic sinks** (`./sinks/*`): `console`, `buffer`, `memory`, `stdout`
-- **Formatters** (`./formatters/*`): `jsonl`, `json`, `json5`, `pretty` (pure transforms — universal)
-- **Universal outputs** (`./outputs/*`): `remote` (HTTP via fetch)
-- **Audit** (`./audit`): `logging/audit` kind, descriptor schema, retention-policy schema. File-backed impl extracts to [`logging-fs`](../logging-fs/).
-- **Schemas** (`./schemas`): `LogLevelSchema`, `RuntimeLogEntry`, `SinkDescriptor`, `FormatterDescriptor`, `OutputDescriptor`, `AuditEntry`, `AuditDescriptor`, `LoggerDescriptor`
-- **CLI** (`./cli`): `vibes logs` group + `list/view/tail/search/rotate` descriptors. Commands query the runtime; they do not import environment-specific sinks/outputs.
-- **Paths** (`./paths`): canonical log file path resolution (string-only, no FS)
-- **Plugins:** `./plugin` (root) and `./cli-plugin` (CLI commands) — register kinds + isomorphic sinks/formatters/outputs only
-
-## Does not own
-
-- **Filesystem-backed sinks/outputs/audit impl** → [`logging-fs`](../logging-fs/) — `file` sink, `file` output, `stdout-capture` sink, file-backed audit logger
-- **Browser sink** → [`logging-browser`](../logging-browser/)
-- **OpenTelemetry sink** → [`logging-otel`](../logging-otel/) — owns OTEL peer deps
-- **Daemon-specific logger config** → [`runtime-plugin/logging`](../runtime-plugin/SPEC.md)
-- **App-specific audit policies.** Apps register their own `logging/audit` descriptors with domain rules.
-- **Logging consumers** (apps calling `getLogger`)
-- **Durable archival** (S3, etc.) — that's an output adapter, not core
-
-## Hard rules
-
-- **The core package is universal.** No Node/Bun/FS/process imports in core. Anything that breaks browser or Cloudflare bundles belongs in an environment-specific package.
-- **All logging through `getLogger(ns)` / `getDefaultLogger()`.** No raw `console.log` in features.
-- **Stdout is reserved (MCP-safe).** Universal sinks default to stderr. The `stdout-capture` sink (in `logging-fs`) redirects rogue stdout to a file.
-- **Sink/output/audit selection is runtime-resolved.** Apps register descriptors; the runtime composes them into `logging/sinks` and `logging/outputs` context providers.
-- **Sink package contract:** each environment-specific package exports a plugin that registers `logging/sink`, `logging/output`, or `logging/audit` descriptors + impls. Apps load only the packages their scope can support. Core never imports them.
-- **Namespaces are colon-separated, hierarchical.** Filter via `VIBES_LOG` (globs with `+/-`); level via `VIBES_LOG_LEVEL`.
-- **Audit entries are immutable, append-only, retention by category.** Categories: `authentication`, `authorization`, `security`, `data_access`, `data_modification`, `configuration`, `system`.
-
-## Public entrypoints
-
-`.`, `./plugin`, `./cli-plugin`, `./core`, `./core/logger`, `./core/namespace`, `./kinds`, `./kinds/sink`, `./kinds/formatter`, `./kinds/output`, `./kinds/audit`, `./kinds/logger`, `./kinds/logger.impl`, `./paths`, `./contexts`, `./contexts/logger`, `./contexts/audit`, `./schemas`, `./schemas/entry`, `./schemas/sink`, `./schemas/formatter`, `./schemas/output`, `./schemas/audit`, `./schemas/logger`, `./sinks` (universal-only barrel), `./formatters`, `./outputs` (universal-only barrel), `./audit` (kind/schema only), `./cli/types`, `./cli/logs.descriptor`, `./cli/logs.list.descriptor`, `./cli/logs.list.impl`, `./cli/logs.search.descriptor`, `./cli/logs.search.impl`, `./cli/logs.tail.descriptor`, `./cli/logs.tail.impl`, `./cli/logs.rotate.descriptor`, `./cli/logs.rotate.impl`, `./cli/logs.view.descriptor`, `./cli/logs.view.impl`.
-
-Per-adapter sub-subpaths (`./sinks/console`, `./formatters/json`, `./outputs/remote`, …) are intentionally not exposed: the canonical access pattern is descriptor registration via the plugin + `runtime.query('logging/sink' | 'logging/formatter' | 'logging/output')`. Consumers do not import the impl files directly.
-
-## Environment
-
-| Variable | Default | Purpose |
-| --- | --- | --- |
-| `VIBES_LOG` | — | Namespace selectors (`vibes:pm:*,-vibes:pm:verbose`) |
-| `VIBES_LOG_LEVEL` | `info` | Minimum level |
-| `VIBES_LOG_DIR` | `~/.vibes/logs` | Log directory (consumed by `logging-fs`) |
-| `VIBES_LOG_FILE` | `app.jsonl` | File sink filename (consumed by `logging-fs`) |
-| `OTEL_SERVICE_NAME` | `vibes` | OTEL service name (consumed by `logging-otel`) |
-| `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` | `http://localhost:4318/v1/logs` | OTEL endpoint |
-| `MCP_ENABLE_STDERR` | `false` | Mirror captured stdout to stderr |
-
-## Verification
-
-`bun test` from package root. Covers schemas, namespace globs, core logger + context providers, isomorphic sinks/formatters, `remote` output, audit retention policy. Environment-specific tests live in each extract package.
-
-## Links
-
-- [runtime/SPEC.md](../runtime/SPEC.md)
-- [runtime-plugin/SPEC.md](../runtime-plugin/SPEC.md)
-- [logging-fs](../logging-fs/), [logging-browser](../logging-browser/), [logging-otel](../logging-otel/)