@chidchanun/bcp 0.2.11 → 0.2.13

package/docs/README.md

@@ -2,14 +2,12 @@
 
 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.11 — Workflow Orchestration`
+> **Documentation target:** BCP Framework `0.2.13 — Realtime Platform`
 >
 > **Release state:** unreleased development target until RC validation, tagging and npm publication complete.
 
 ## Documentation architecture
 
-BCP uses three machine-readable documentation contracts:
-
 ```text
 docs/docs-web-manifest.json
   -> website navigation, routes, Markdown sources and release routes
@@ -39,53 +37,58 @@ Framework source and tests remain authoritative for runtime behavior.
 | `0.2.9` | Job Scheduling Platform |
 | `0.2.10` | Durable Jobs Platform |
 | `0.2.11` | Workflow Orchestration |
+| `0.2.12` | Transactional Outbox & Events |
+| `0.2.13` | Realtime Platform |
 
-## 0.2.11 — Workflow Orchestration
-
-`0.2.11` adds a new server-only `bcp/workflow` public entrypoint for persistent multi-step backend orchestration.
+## 0.2.13 — Realtime Platform
 
-New/updated documentation sources:
-
-| Source | Purpose |
-| --- | --- |
-| `workflow-orchestration.md` | Workflow definition, persistence, delays, retries, queue execution and compensation |
-| `durable-jobs.md` | Durable execution layer used by queue-backed workflows |
-| `api-reference.md` | Public `bcp/workflow` APIs |
-| `platform-manifest.json` | Workflow capability flags and public entrypoint |
-| `api-manifest.json` | `bcp/workflow` source/guide ownership |
-| `docs-web-manifest.json` | Workflow docs navigation and `0.2.11` release route |
-| `releases/0.2.11.md` | Workflow Orchestration release notes |
+`0.2.13` adds the server-only `bcp/realtime` public entrypoint.
 
 Primary APIs:
 
 ```ts
 import {
-    createMemoryWorkflowStore,
-    createWorkflow,
-} from "bcp/workflow";
+    createMemoryRealtimeBroker,
+    createMemoryRealtimePresenceStore,
+    createRealtime,
+    createRealtimeSseResponse,
+} from "bcp/realtime";
 ```
 
 Runtime model:
 
 ```text
-application / API
-       |
-       v
-WorkflowStore
-       |
-       v
-BCP Workflow
-       |
-       +--> sequential steps
-       +--> parallel groups
-       +--> retry / delay
-       +--> compensation
-       |
-       v
-optional durable bcp/jobs queue
+client connection
+      |
+      v
+RealtimeHub
+      |
+      +-- channels / rooms
+      +-- auth / channel authorization
+      +-- presence
+      +-- heartbeat
+      |
+      +-- RealtimeBroker
+      |       -> cross-hub delivery
+      |
+      +-- RealtimeSocket
+      |       -> WebSocket provider adapter
+      |
+      +-- SSE Response
 ```
 
-The memory workflow store is local-only. Multi-instance deployments should implement a shared durable `WorkflowStore` whose `claim()` method atomically leases one run to one executor.
+The memory broker/presence store are process-local. Multi-instance deployments should provide shared implementations.
+
+New/updated sources:
+
+| Source | Purpose |
+| --- | --- |
+| `realtime-platform.md` | Channels, presence, WebSocket adapter, SSE, heartbeat and broker model |
+| `api-reference.md` | `bcp/realtime` public APIs |
+| `platform-manifest.json` | Realtime capability flags and public entrypoint |
+| `api-manifest.json` | `bcp/realtime` source/guide ownership |
+| `docs-web-manifest.json` | Realtime docs navigation and `0.2.13` release route |
+| `releases/0.2.13.md` | Realtime Platform release notes |
 
 ## Update rule
 
@@ -94,36 +97,30 @@ When framework behavior or public surface changes:
 1. Update framework source.
 2. Add/update regression tests.
 3. Update the matching Markdown guide.
-4. Update `platform-manifest.json` when runtime/public-entrypoint/capability metadata changes.
-5. Update `api-manifest.json` when public API ownership/guide mapping changes.
-6. Update `docs-web-manifest.json` when website routes/navigation change.
+4. Update `platform-manifest.json` for runtime/public-entrypoint/capability changes.
+5. Update `api-manifest.json` for public API ownership/guide changes.
+6. Update `docs-web-manifest.json` for website route/navigation changes.
 7. Update `docs/releases/<version>.md`.
 8. Change release state only after the release workflow reaches that state.
 
-## Docs-web navigation
-
-Important current routes:
+## Important docs-web routes
 
 | Website route | Markdown source |
 | --- | --- |
 | `/docs/authentication` | `authentication.md` |
-| `/docs/authorization-security` | `authorization-security.md` |
 | `/docs/observability` | `observability.md` |
 | `/docs/background-jobs` | `background-jobs.md` |
-| `/docs/job-scheduling` | `job-scheduling.md` |
 | `/docs/durable-jobs` | `durable-jobs.md` |
 | `/docs/workflow-orchestration` | `workflow-orchestration.md` |
-| `/docs/application-packaging` | `application-packaging.md` |
-| `/docs/database` | `database.md` |
+| `/docs/transactional-outbox-events` | `transactional-outbox-events.md` |
+| `/docs/realtime-platform` | `realtime-platform.md` |
 | `/docs/api-reference` | `api-reference.md` |
-| `/releases/0.2.11` | `releases/0.2.11.md` |
+| `/releases/0.2.13` | `releases/0.2.13.md` |
 
 Every route/source pair is validated by unit tests.
 
 ## Public entrypoints
 
-Current documented entrypoints:
-
 ```text
 bcp
 bcp/island
@@ -135,6 +132,8 @@ bcp/database
 bcp/auth
 bcp/jobs
 bcp/workflow
+bcp/events
+bcp/realtime
 bcp/observability
 bcp/server
 bcp/server-only
@@ -145,33 +144,17 @@ The API-manifest entrypoint set must match the platform public-entrypoint set ex
 
 ## Release validation
 
-Before publishing `0.2.11`:
+Before publishing `0.2.13`:
 
 ```bash
 npm run typecheck
 npm run test:unit
 npm run test:integration
-npm run test:package
 npm run test:e2e
+npm run test:package
 npm run rc:check
 ```
 
-Workflow Orchestration validation covers:
-
-- sequential step execution,
-- step retries,
-- parallel child execution/state,
-- persisted delay/resume behavior,
-- manual retry,
-- reverse-order compensation,
-- queue-backed execution and delayed continuation,
-- workflow store run leases,
-- server-only client boundary enforcement,
-- compiled `workflow.mjs` package execution,
-- docs/platform/API version parity.
+Realtime validation covers broker broadcasts, presence, authentication/channel authorization, socket protocol, heartbeat cleanup, SSE streaming, server-only boundaries, compiled `realtime.mjs` package execution and docs/platform/API parity.
 
 The final release tag must point to the exact commit that passed the complete RC sequence.
-
-## Repository authority
-
-The framework repository remains authoritative for source, public exports, tests, Markdown docs, manifests and release notes. `bcp-docs-web` remains the presentation/search/navigation layer.

package/docs/api-manifest.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": 1,
   "framework": "bcp",
-  "version": "0.2.11",
+  "version": "0.2.13",
   "releaseState": "unreleased",
   "coverage": "public-entrypoints",
   "entrypoints": [
@@ -11,12 +11,7 @@
       "environment": "universal",
       "route": "/docs/api-reference#bcp",
       "summary": "React application APIs for routing, links, forms, loader/guard data, islands, metadata and route error handling.",
-      "guides": [
-        "/docs/routing",
-        "/docs/server-data-loaders",
-        "/docs/route-guards",
-        "/docs/form-actions"
-      ]
+      "guides": ["/docs/routing", "/docs/server-data-loaders", "/docs/route-guards", "/docs/form-actions"]
     },
     {
       "package": "bcp/island",
@@ -24,9 +19,7 @@
       "environment": "universal",
       "route": "/docs/api-reference#bcp-island",
       "summary": "Partial-hydration island creation and island loading strategy types.",
-      "guides": [
-        "/docs/hydration"
-      ]
+      "guides": ["/docs/hydration"]
     },
     {
       "package": "bcp/cache",
@@ -34,9 +27,7 @@
       "environment": "server-preferred",
       "route": "/docs/api-reference#bcp-cache",
       "summary": "Cache, deduplication, statistics and path/tag revalidation primitives.",
-      "guides": [
-        "/docs/caching"
-      ]
+      "guides": ["/docs/caching"]
     },
     {
       "package": "bcp/config",
@@ -44,10 +35,7 @@
       "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"
-      ]
+      "guides": ["/docs/configuration", "/docs/environment-validation"]
     },
     {
       "package": "bcp/validation",
@@ -55,9 +43,7 @@
       "environment": "universal",
       "route": "/docs/api-reference#bcp-validation",
       "summary": "Typed validators, parse helpers and structured validation errors.",
-      "guides": [
-        "/docs/validation"
-      ]
+      "guides": ["/docs/validation"]
     },
     {
       "package": "bcp/error",
@@ -65,9 +51,7 @@
       "environment": "universal",
       "route": "/docs/api-reference#bcp-error",
       "summary": "Structured HTTP error creation, classification and response helpers.",
-      "guides": [
-        "/docs/error-handling"
-      ]
+      "guides": ["/docs/error-handling"]
     },
     {
       "package": "bcp/database",
@@ -75,10 +59,7 @@
       "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"
-      ]
+      "guides": ["/docs/database", "/docs/database-migrations", "/docs/transactional-outbox-events"]
     },
     {
       "package": "bcp/auth",
@@ -86,13 +67,7 @@
       "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"
-      ]
+      "guides": ["/docs/authentication", "/docs/auth-session-store", "/docs/auth-route-guards", "/docs/authorization-security", "/docs/session-auth"]
     },
     {
       "package": "bcp/jobs",
@@ -100,12 +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/observability"
-      ]
+      "guides": ["/docs/background-jobs", "/docs/job-scheduling", "/docs/durable-jobs", "/docs/transactional-outbox-events", "/docs/realtime-platform", "/docs/observability"]
     },
     {
       "package": "bcp/workflow",
@@ -113,11 +83,23 @@
       "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/observability"
-      ]
+      "guides": ["/docs/workflow-orchestration", "/docs/durable-jobs", "/docs/realtime-platform", "/docs/observability"]
+    },
+    {
+      "package": "bcp/events",
+      "source": "packages/client/src/events.ts",
+      "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/observability"]
+    },
+    {
+      "package": "bcp/realtime",
+      "source": "packages/client/src/realtime.ts",
+      "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/observability"]
     },
     {
       "package": "bcp/observability",
@@ -125,10 +107,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-observability",
       "summary": "In-process metrics, Prometheus exposition, request metrics middleware and health/readiness checks.",
-      "guides": [
-        "/docs/observability",
-        "/docs/development-logging"
-      ]
+      "guides": ["/docs/observability", "/docs/development-logging"]
     },
     {
       "package": "bcp/server",
@@ -136,14 +115,7 @@
       "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"
-      ]
+      "guides": ["/docs/server-request-apis", "/docs/authorization-security", "/docs/file-upload", "/docs/storage", "/docs/storage-ecosystem", "/docs/production-hardening"]
     },
     {
       "package": "bcp/server-only",
@@ -151,9 +123,7 @@
       "environment": "server-marker",
       "route": "/docs/api-reference#bcp-server-only",
       "summary": "Server-only module boundary marker that prevents accidental browser inclusion.",
-      "guides": [
-        "/docs/application-modules"
-      ]
+      "guides": ["/docs/application-modules"]
     },
     {
       "package": "bcp/middleware",
@@ -161,9 +131,7 @@
       "environment": "server",
       "route": "/docs/api-reference#bcp-middleware",
       "summary": "Middleware System v2 request/response pipeline types and helpers.",
-      "guides": [
-        "/docs/middleware"
-      ]
+      "guides": ["/docs/middleware"]
     }
   ]
 }

package/docs/api-reference.md

@@ -54,7 +54,7 @@ Server-only Database Platform v2 APIs.
 
 Built-in SQL providers are MySQL, PostgreSQL and SQLite. `BcpDatabase` instances expose lazy query/execute/transaction operations plus explicit `connect()`, `disconnect()` and backward-compatible `close()` lifecycle methods.
 
-Related guides: [Database](database.md), [Database Migrations](database-migrations.md).
+Related guides: [Database](database.md), [Database Migrations](database-migrations.md), [Transactional Outbox & Events](transactional-outbox-events.md).
 
 ## `bcp/auth`
 
@@ -68,104 +68,17 @@ Related guides: [Authentication](authentication.md), [Auth Session Stores](auth-
 
 Server-only Background Jobs, Job Scheduling and Durable Jobs APIs.
 
-Core queue APIs:
+Core queue APIs include `createJobQueue()`, `createMemoryJobQueueAdapter()`, queue/worker records, retry/backoff, visibility leases, heartbeat renewal, stale recovery, DLQ operations, retention cleanup and queue statistics.
 
-```ts
-import {
-    createJobQueue,
-    createMemoryJobQueueAdapter,
-    type BackgroundJobQueue,
-    type CleanupJobsOptions,
-    type DeadLetterJobRecord,
-    type EnqueueJobOptions,
-    type HeartbeatJobOptions,
-    type JobHandler,
-    type JobHandlerContext,
-    type JobQueueAdapter,
-    type JobQueueOptions,
-    type JobQueueStats,
-    type JobRecord,
-    type JobRetryDelay,
-    type JobState,
-    type JobWorker,
-    type MemoryJobQueueAdapter,
-    type ProcessNextJobOptions,
-    type RecoverStaleJobsOptions,
-    type RequeueDeadLetterOptions,
-    type ReserveJobOptions,
-    type StartJobWorkerOptions,
-} from "bcp/jobs";
-```
-
-Scheduling APIs:
-
-```ts
-import {
-    createJobScheduler,
-    createMemoryJobScheduleStore,
-    nextCronTime,
-    nextScheduleTime,
-    type JobSchedule,
-    type JobScheduleRecord,
-    type JobScheduleStore,
-    type JobScheduler,
-    type JobSchedulerOptions,
-    type JobSchedulerRunner,
-    type MemoryJobScheduleStore,
-    type RunDueSchedulesOptions,
-    type ScheduleJobOptions,
-    type StartJobSchedulerOptions,
-} from "bcp/jobs";
-```
-
-Durable Redis-compatible APIs added in `0.2.10`:
-
-```ts
-import {
-    createRedisJobQueueAdapter,
-    createRedisJobScheduleStore,
-    type RedisCommandClient,
-    type RedisJobQueueAdapter,
-    type RedisJobsAdapterOptions,
-    type RedisJobScheduleStore,
-} from "bcp/jobs";
-```
-
-### Queue lifecycle
-
-`createJobQueue()` supports immediate/delayed enqueue, retry/backoff, cancellation, manual `processNext()`, worker concurrency, visibility timeout, heartbeat lease renewal, stale-running recovery, DLQ inspection/requeue, terminal retention cleanup and queue statistics.
-
-Durable adapter methods such as `heartbeat()`, `recoverStale()`, `listDeadLetters()`, `requeueDeadLetter()`, `cleanup()` and `stats()` are optional so earlier `JobQueueAdapter` implementations remain compatible.
+Scheduling APIs include `createJobScheduler()`, `createMemoryJobScheduleStore()`, `nextCronTime()` and `nextScheduleTime()`.
 
-`reserve()` receives an optional second `ReserveJobOptions` argument containing `ownerId` and `visibilityTimeoutMs`. Production durable adapters should use it to create an atomic visibility lease.
-
-### Scheduling
-
-`createJobScheduler()` supports recurring interval and UTC five-field cron schedules.
-
-The scheduler leases due records from `JobScheduleStore`, then enqueues normal jobs using deterministic occurrence IDs. `nextCronTime()` and `nextScheduleTime()` are available for tooling and tests.
-
-### Redis-compatible durable adapters
-
-`createRedisJobQueueAdapter()` implements the queue contract on a shared Redis-compatible command client.
-
-`createRedisJobScheduleStore()` implements the schedule-store contract using the same minimal client shape:
-
-```ts
-interface RedisCommandClient {
-    sendCommand(
-        command: string[]
-    ): Promise<unknown>;
-}
-```
+Durable Redis-compatible APIs added in `0.2.10` include `createRedisJobQueueAdapter()` and `createRedisJobScheduleStore()`.
 
 BCP does not install a Redis library and does not create the connection. Applications own authentication, TLS, Cluster/Sentinel configuration and connection shutdown.
 
-The reference adapters use atomic Lua state transitions. The default namespace `bcp:{jobs}` uses a Redis Cluster hash tag so all job/schedule keys share one slot.
-
 The processing model is at-least-once. Handlers that perform non-idempotent external side effects should use application-level idempotency protection.
 
-Related guides: [Background Jobs Platform](background-jobs.md), [Job Scheduling Platform](job-scheduling.md), [Durable Jobs Platform](durable-jobs.md), [Observability Platform v2](observability.md).
+Related guides: [Background Jobs Platform](background-jobs.md), [Job Scheduling Platform](job-scheduling.md), [Durable Jobs Platform](durable-jobs.md), [Transactional Outbox & Events](transactional-outbox-events.md), [Realtime Platform](realtime-platform.md), [Observability Platform v2](observability.md).
 
 ## `bcp/workflow`
 
@@ -175,29 +88,10 @@ Server-only Workflow Orchestration APIs added in `0.2.11`.
 import {
     createMemoryWorkflowStore,
     createWorkflow,
-    type CancelWorkflowOptions,
-    type MemoryWorkflowStore,
-    type ResumeWorkflowOptions,
-    type StartWorkflowOptions,
-    type Workflow,
-    type WorkflowBuilder,
-    type WorkflowCompensationHandler,
-    type WorkflowOptions,
-    type WorkflowParallelBuilder,
-    type WorkflowRetryDelay,
-    type WorkflowRunRecord,
-    type WorkflowRunState,
-    type WorkflowStepContext,
-    type WorkflowStepHandler,
-    type WorkflowStepKind,
-    type WorkflowStepOptions,
-    type WorkflowStepRecord,
-    type WorkflowStepState,
-    type WorkflowStore,
 } from "bcp/workflow";
 ```
 
-`createWorkflow()` defines a persistent server-side workflow with sequential steps, parallel groups, per-step retry policies, persisted delays and compensation handlers.
+`createWorkflow()` defines persistent server-side workflows with sequential steps, parallel groups, per-step retry policies, persisted delays and compensation handlers.
 
 Workflow controls include:
 
@@ -213,17 +107,108 @@ compensate()
 close()
 ```
 
-Without a queue, workflow execution runs in the current process until it succeeds, fails, is cancelled or reaches a persisted delay.
+When an existing `BackgroundJobQueue` is supplied, workflow execution and delay continuation can run through `bcp/jobs`.
+
+`WorkflowStore.claim()` / `release()` form the run-level lease boundary for multi-instance stores.
+
+Related guides: [Workflow Orchestration](workflow-orchestration.md), [Durable Jobs Platform](durable-jobs.md), [Realtime Platform](realtime-platform.md), [Observability Platform v2](observability.md).
+
+## `bcp/events`
+
+Server-only Transactional Outbox & Events APIs added in `0.2.12`.
+
+```ts
+import {
+    createEventBus,
+    createMemoryOutboxStore,
+    createOutboxDispatcher,
+    createOutboxMigrationSql,
+    createSqlOutboxStore,
+    createTransactionalOutbox,
+} from "bcp/events";
+```
+
+`createTransactionalOutbox()` writes an event through the same `TransactionDatabase` used by `db.transaction()`, allowing business rows and outbox rows to commit or roll back together.
+
+`createSqlOutboxStore()` supports MySQL, PostgreSQL and SQLite. `createOutboxMigrationSql()` generates the outbox table/index DDL.
+
+`createOutboxDispatcher()` supports batched claims, leases, stale recovery, retry/backoff, terminal failure, job-queue handoff, custom publishing, local event-bus delivery and runner lifecycle.
+
+Delivery is at-least-once; consumers should use idempotency controls for non-repeatable side effects.
+
+Related guides: [Transactional Outbox & Events](transactional-outbox-events.md), [Database](database.md), [Durable Jobs Platform](durable-jobs.md), [Realtime Platform](realtime-platform.md), [Observability Platform v2](observability.md).
+
+## `bcp/realtime`
+
+Server-only Realtime Platform APIs added in `0.2.13`.
+
+```ts
+import {
+    createMemoryRealtimeBroker,
+    createMemoryRealtimePresenceStore,
+    createRealtime,
+    createRealtimeSseResponse,
+    type RealtimeAuthenticate,
+    type RealtimeAuthorizeChannel,
+    type RealtimeBroker,
+    type RealtimeBroadcastOptions,
+    type RealtimeConnection,
+    type RealtimeEnvelope,
+    type RealtimeEventContext,
+    type RealtimeEventHandler,
+    type RealtimeHeartbeatOptions,
+    type RealtimeHeartbeatRunner,
+    type RealtimeHub,
+    type RealtimeJoinOptions,
+    type RealtimeOptions,
+    type RealtimePresenceMember,
+    type RealtimePresenceStore,
+    type RealtimeSocket,
+    type RealtimeSseOptions,
+} from "bcp/realtime";
+```
+
+### Hub and channels
+
+`createRealtime()` creates a server-side hub. Connections can `join()`, `leave()`, `emit()`, `send()`, `touch()` and `disconnect()`.
+
+`hub.broadcast(channel, event, payload)` delivers through the configured broker and reaches connections that joined the channel.
+
+### Broker
+
+`RealtimeBroker` is the cross-hub pub/sub boundary. The memory implementation is process-local; production multi-instance applications can provide a shared broker such as Redis Pub/Sub or NATS without changing the hub surface.
+
+### Presence
+
+`RealtimePresenceStore` tracks per-channel connection presence. `hub.members(channel)` returns current presence records.
+
+The memory store is intended for tests/single-process use. Shared deployments should use a shared presence adapter.
+
+### Authentication and channel authorization
+
+`RealtimeOptions.authenticate` can resolve application user identity from a `Request`/connection data. `getUserId` maps that identity into presence records.
+
+`RealtimeOptions.authorizeChannel` runs before `join()` completes and can enforce private-room access.
+
+### Socket adapter
+
+BCP does not install a WebSocket provider. `RealtimeSocket` defines the minimal `send`, `close`, `onMessage`, `onClose` and optional `onError` surface consumed by `hub.attachSocket()`.
+
+The built-in JSON protocol accepts `join`, `leave`, `event` and `ping` messages. `ping` receives a `realtime.pong` event.
+
+### Server-Sent Events
+
+`hub.sse(channel, options)` and `createRealtimeSseResponse()` return Web-standard streaming `Response` objects using `text/event-stream`.
 
-When an existing `BackgroundJobQueue` is passed through `WorkflowOptions.queue`, workflow execution is submitted through `bcp/jobs`. Delay steps enqueue delayed continuation jobs instead of holding a long-running timer.
+Options include abort signal integration, event filtering, retry hints, keep-alive timing and response headers.
 
-`WorkflowStore` is the workflow persistence boundary. Its `claim()` / `release()` methods form the run-level lease contract for shared multi-instance stores.
+### Heartbeat
 
-`createMemoryWorkflowStore()` is intended for development and deterministic tests. Production multi-instance applications should implement a shared durable store with atomic `claim()` behavior.
+`hub.startHeartbeat()` sends `realtime.ping` messages and invokes stale connection cleanup. `hub.sweepStale()` is also public for deterministic infrastructure loops/tests.
 
-Compensation is saga-style and executes successful compensatable steps in reverse completion order. It does not turn external services into one distributed database transaction.
+Realtime delivery is transient. Use database/outbox/jobs/workflows for durable state and refetch durable state/history after reconnect when catch-up is required.
 
-Related guides: [Workflow Orchestration](workflow-orchestration.md), [Durable Jobs Platform](durable-jobs.md), [Observability Platform v2](observability.md).
+Related guides: [Realtime Platform](realtime-platform.md), [Authentication](authentication.md), [Observability Platform v2](observability.md).
 
 ## `bcp/observability`