@chidchanun/bcp 0.2.17 → 0.2.18

package/docs/README.md

@@ -2,7 +2,7 @@
 
 The `docs/` directory is the documentation source of truth for BCP Framework and is organized for **`bcp-docs-web`**.
 
-> **Documentation target:** BCP Framework `0.2.17 — Observability Platform v3`
+> **Documentation target:** BCP Framework `0.2.18 — Deployment Platform v2`
 >
 > **Release state:** unreleased development target until RC validation, tagging and npm publication complete.
 
@@ -43,64 +43,57 @@ Framework source and tests remain authoritative for runtime behavior.
 | `0.2.15` | Plugin & Module Platform |
 | `0.2.16` | Cache Platform v2 |
 | `0.2.17` | Observability Platform v3 |
+| `0.2.18` | Deployment Platform v2 |
 
-## 0.2.17 — Observability Platform v3
+## 0.2.18 — Deployment Platform v2
 
-`0.2.17` extends the existing server-only `bcp/observability` public entrypoint while preserving Observability Platform v2 metrics and health APIs.
+`0.2.18` adds the server-only `bcp/deployment` entrypoint and completes compiled production runtime coverage for key server package surfaces.
 
-Primary tracing APIs:
+Primary APIs:
 
 ```ts
 import {
-    createCompositeTraceSpanExporter,
-    createMemoryTraceSpanExporter,
-    createRequestTracingMiddleware,
-    createTraceCarrier,
-    createTraceMetricsExporter,
-    createTracer,
-    getTraceLogFields,
-    runWithTraceCarrier,
-} from "bcp/observability";
+    createDeploymentDiagnosticsResponse,
+    createDeploymentReadinessResponse,
+    createDeploymentRuntime,
+} from "bcp/deployment";
 ```
 
 Runtime model:
 
 ```text
-Incoming HTTP
+process start
     |
     v
-request tracing middleware
+DeploymentRuntime
     |
-    +-- AsyncLocalStorage trace context
-    +-- W3C traceparent
-    +-- correlationId
+    +-- resource start order
+    +-- readiness checks
+    +-- diagnostics
+    +-- deployment metadata
+    +-- SIGTERM / SIGINT
     |
-    +-- database/cache child spans
-    +-- trace carrier -> jobs/workflows/events/realtime
+    v
+state = ready
+    |
+shutdown/drain
     |
     v
-TraceSpanExporter
-    +-- memory exporter
-    +-- trace metrics exporter
-    +-- application/vendor exporter
+reverse-order resource stop
 ```
 
-A root trace owns a stable `traceId` and `correlationId`. Nested spans inherit that identity and receive their own `spanId` / `parentSpanId` relationship.
-
-`createTraceCarrier()` and `runWithTraceCarrier()` provide explicit provider-neutral propagation through non-HTTP transports without changing persisted job/workflow/outbox schemas.
-
-Prepared npm packages compile `bcp/observability` to `observability.mjs` for standalone Node runtime use.
+Prepared npm runtime targets now include compiled ESM for `bcp/config`, `bcp/auth`, `bcp/deployment`, `bcp/server` and `bcp/middleware` in addition to the server entrypoints compiled in earlier releases.
 
 New/updated sources:
 
 | Source | Purpose |
 | --- | --- |
-| `observability-v3.md` | Tracing, propagation, W3C trace context, exporters, correlation and trace metrics |
-| `api-reference.md` | `bcp/observability` tracing APIs |
-| `platform-manifest.json` | Observability v3 capability flags |
-| `api-manifest.json` | Updated observability source/guide ownership |
-| `docs-web-manifest.json` | Observability v3 docs navigation and `0.2.17` release route |
-| `releases/0.2.17.md` | Observability Platform v3 release notes |
+| `deployment-platform-v2.md` | Runtime lifecycle, readiness, diagnostics, metadata and graceful shutdown |
+| `api-reference.md` | `bcp/deployment` APIs |
+| `platform-manifest.json` | Deployment/compiled-runtime capability flags |
+| `api-manifest.json` | `bcp/deployment` source/guide ownership |
+| `docs-web-manifest.json` | Deployment v2 navigation and `0.2.18` release route |
+| `releases/0.2.18.md` | Deployment Platform v2 release notes |
 
 ## Update rule
 
@@ -119,10 +112,8 @@ When framework behavior or public surface changes:
 
 | Website route | Markdown source |
 | --- | --- |
-| `/docs/authentication` | `authentication.md` |
-| `/docs/observability` | `observability.md` |
 | `/docs/observability-v3` | `observability-v3.md` |
-| `/docs/background-jobs` | `background-jobs.md` |
+| `/docs/deployment-platform-v2` | `deployment-platform-v2.md` |
 | `/docs/durable-jobs` | `durable-jobs.md` |
 | `/docs/workflow-orchestration` | `workflow-orchestration.md` |
 | `/docs/transactional-outbox-events` | `transactional-outbox-events.md` |
@@ -131,7 +122,7 @@ When framework behavior or public surface changes:
 | `/docs/plugin-module-platform` | `plugin-module-platform.md` |
 | `/docs/cache-platform-v2` | `cache-platform-v2.md` |
 | `/docs/api-reference` | `api-reference.md` |
-| `/releases/0.2.17` | `releases/0.2.17.md` |
+| `/releases/0.2.18` | `releases/0.2.18.md` |
 
 Every route/source pair is validated by unit tests.
 
@@ -153,6 +144,7 @@ bcp/realtime
 bcp/testing
 bcp/plugins
 bcp/observability
+bcp/deployment
 bcp/server
 bcp/server-only
 bcp/middleware
@@ -162,7 +154,7 @@ The API-manifest entrypoint set must match the platform public-entrypoint set ex
 
 ## Release validation
 
-Before publishing `0.2.17`:
+Before publishing `0.2.18`:
 
 ```bash
 npm run typecheck
@@ -173,6 +165,6 @@ npm run test:package
 npm run rc:check
 ```
 
-Observability Platform v3 validation covers root/child spans, async trace context, W3C traceparent parsing/injection, correlation IDs, request middleware, trace carriers, error spans, metrics integration, compiled `observability.mjs` package execution and docs/platform/API parity.
+Deployment Platform v2 validation covers resource lifecycle ordering, startup rollback, readiness/diagnostics, runtime metadata, server-only boundaries, compiled production entrypoints and docs/platform/API parity.
 
 The final release tag must point to the exact commit that passed the complete RC sequence.

package/docs/api-manifest.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
   "framework": "bcp",
-  "version": "0.2.17",
+  "version": "0.2.18",
   "releaseState": "unreleased",
   "coverage": "public-entrypoints",
   "entrypoints": [
@@ -34,8 +34,8 @@
       "source": "packages/client/src/config.ts",
       "environment": "server",
       "route": "/docs/api-reference#bcp-config",
-      "summary": "Typed BCP configuration, environment-schema validation and configuration diagnostics APIs.",
-      "guides": ["/docs/configuration", "/docs/environment-validation"]
+      "summary": "Typed BCP configuration, environment-schema validation and configuration diagnostics APIs with a compiled production runtime.",
+      "guides": ["/docs/configuration", "/docs/environment-validation", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/validation",
@@ -59,15 +59,15 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-database",
       "summary": "Provider-neutral MySQL, PostgreSQL and SQLite query, transaction, lifecycle and migration primitives.",
-      "guides": ["/docs/database", "/docs/database-migrations", "/docs/transactional-outbox-events", "/docs/testing-platform", "/docs/observability-v3"]
+      "guides": ["/docs/database", "/docs/database-migrations", "/docs/transactional-outbox-events", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/auth",
       "source": "packages/client/src/auth.ts",
       "environment": "server",
       "route": "/docs/api-reference#bcp-auth",
-      "summary": "Authentication Platform v2 plus permission checks, authorization policies and auth/guest/role/permission route guards.",
-      "guides": ["/docs/authentication", "/docs/auth-session-store", "/docs/auth-route-guards", "/docs/authorization-security", "/docs/session-auth", "/docs/testing-platform"]
+      "summary": "Authentication Platform v2 plus permission checks, authorization policies and auth/guest/role/permission route guards, published with a compiled Node runtime.",
+      "guides": ["/docs/authentication", "/docs/auth-session-store", "/docs/auth-route-guards", "/docs/authorization-security", "/docs/session-auth", "/docs/testing-platform", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/jobs",
@@ -75,7 +75,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-jobs",
       "summary": "Background queues and schedules with visibility leases, heartbeats, stale recovery, DLQ maintenance and Redis-compatible durable adapters.",
-      "guides": ["/docs/background-jobs", "/docs/job-scheduling", "/docs/durable-jobs", "/docs/transactional-outbox-events", "/docs/realtime-platform", "/docs/testing-platform", "/docs/observability-v3"]
+      "guides": ["/docs/background-jobs", "/docs/job-scheduling", "/docs/durable-jobs", "/docs/transactional-outbox-events", "/docs/realtime-platform", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/workflow",
@@ -83,7 +83,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-workflow",
       "summary": "Persistent workflow orchestration with sequential and parallel steps, retries, delays, compensation, run leases and optional durable queue execution.",
-      "guides": ["/docs/workflow-orchestration", "/docs/durable-jobs", "/docs/realtime-platform", "/docs/testing-platform", "/docs/observability-v3"]
+      "guides": ["/docs/workflow-orchestration", "/docs/durable-jobs", "/docs/realtime-platform", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/events",
@@ -91,7 +91,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-events",
       "summary": "Transactional outbox and event delivery APIs with SQL persistence, dispatcher leases, retries, stale recovery, queue handoff and in-process event bus delivery.",
-      "guides": ["/docs/transactional-outbox-events", "/docs/database", "/docs/durable-jobs", "/docs/realtime-platform", "/docs/testing-platform", "/docs/observability-v3"]
+      "guides": ["/docs/transactional-outbox-events", "/docs/database", "/docs/durable-jobs", "/docs/realtime-platform", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/realtime",
@@ -99,7 +99,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-realtime",
       "summary": "Realtime channels, cross-hub broker delivery, presence, channel authorization, WebSocket adapter integration, heartbeat handling and built-in Server-Sent Events responses.",
-      "guides": ["/docs/realtime-platform", "/docs/authentication", "/docs/testing-platform", "/docs/observability-v3"]
+      "guides": ["/docs/realtime-platform", "/docs/authentication", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/testing",
@@ -115,7 +115,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-plugins",
       "summary": "Plugin and module composition with dependency ordering, lifecycle hooks, typed config parsing, shared services and asynchronous extension hooks.",
-      "guides": ["/docs/plugin-module-platform", "/docs/configuration", "/docs/testing-platform", "/docs/observability-v3"]
+      "guides": ["/docs/plugin-module-platform", "/docs/configuration", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/observability",
@@ -123,15 +123,23 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-observability",
       "summary": "Metrics, Prometheus output, health checks and Observability Platform v3 distributed tracing with W3C trace context, correlation IDs, request tracing, span exporters and trace-to-metrics integration.",
-      "guides": ["/docs/observability", "/docs/observability-v3", "/docs/development-logging", "/docs/cache-platform-v2"]
+      "guides": ["/docs/observability", "/docs/observability-v3", "/docs/development-logging", "/docs/cache-platform-v2", "/docs/deployment-platform-v2"]
+    },
+    {
+      "package": "bcp/deployment",
+      "source": "packages/client/src/deployment.ts",
+      "environment": "server",
+      "route": "/docs/api-reference#bcp-deployment",
+      "summary": "Deployment Platform v2 runtime lifecycle with resource startup/shutdown ordering, readiness, diagnostics, deployment metadata, signal handling and framework shutdown-hook integration.",
+      "guides": ["/docs/deployment-platform-v2", "/docs/application-packaging", "/docs/production-hardening", "/docs/observability-v3"]
     },
     {
       "package": "bcp/server",
       "source": "packages/client/src/server.ts",
       "environment": "server",
       "route": "/docs/api-reference#bcp-server",
-      "summary": "Request context, cookies, CSRF/same-origin protection, logging, production hardening, upload, storage, response and session APIs.",
-      "guides": ["/docs/server-request-apis", "/docs/authorization-security", "/docs/file-upload", "/docs/storage", "/docs/storage-ecosystem", "/docs/production-hardening", "/docs/testing-platform", "/docs/observability-v3"]
+      "summary": "Request context, cookies, CSRF/same-origin protection, logging, production hardening, upload, storage, response and session APIs, published with a compiled Node runtime.",
+      "guides": ["/docs/server-request-apis", "/docs/authorization-security", "/docs/file-upload", "/docs/storage", "/docs/storage-ecosystem", "/docs/production-hardening", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     },
     {
       "package": "bcp/server-only",
@@ -146,8 +154,8 @@
       "source": "packages/server/src/middleware.ts",
       "environment": "server",
       "route": "/docs/api-reference#bcp-middleware",
-      "summary": "Middleware System v2 request/response pipeline types and helpers.",
-      "guides": ["/docs/middleware", "/docs/testing-platform", "/docs/observability-v3"]
+      "summary": "Middleware System v2 request/response pipeline types and helpers, published with a compiled Node runtime.",
+      "guides": ["/docs/middleware", "/docs/testing-platform", "/docs/observability-v3", "/docs/deployment-platform-v2"]
     }
   ]
 }