@chidchanun/bcp 0.2.8 → 0.2.10

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.8 — Background Jobs Platform`
+> **Documentation target:** BCP Framework `0.2.10 — Durable Jobs Platform`
 >
 > **Release state:** unreleased development target until RC validation, tagging and npm publication complete.
 
@@ -21,24 +21,6 @@ docs/api-manifest.json
   -> public package entrypoints, source ownership and guide mapping
 ```
 
-Markdown files under `docs/` remain the authored documentation content.
-
-Recommended flow:
-
-```text
-framework source/tests
-        ↓
-      docs/
-        ├─ Markdown content
-        ├─ docs-web-manifest.json
-        ├─ platform-manifest.json
-        └─ api-manifest.json
-        ↓
-manifest-driven sync
-        ↓
-    bcp-docs-web
-```
-
 Framework source and tests remain authoritative for runtime behavior.
 
 ## Current 0.2.x milestones
@@ -54,49 +36,58 @@ Framework source and tests remain authoritative for runtime behavior.
 | `0.2.6` | Authorization & Security v2 |
 | `0.2.7` | Observability Platform v2 |
 | `0.2.8` | Background Jobs Platform |
+| `0.2.9` | Job Scheduling Platform |
+| `0.2.10` | Durable Jobs Platform |
 
-## 0.2.8 — Background Jobs Platform
+## 0.2.10 — Durable Jobs Platform
 
-`0.2.8` adds a server-only provider-neutral queue/worker layer without adding a third-party queue dependency.
+`0.2.10` makes the queue/scheduler contracts production-oriented without changing the `bcp/jobs` public entrypoint.
 
 New/updated documentation sources:
 
 | Source | Purpose |
 | --- | --- |
-| `background-jobs.md` | Queue contract, memory adapter, delay, retries, workers and production guidance |
-| `api-reference.md` | Public `bcp/jobs` exports |
-| `platform-manifest.json` | Background Jobs capability flags and public entrypoint |
+| `background-jobs.md` | Base queue/worker contract |
+| `job-scheduling.md` | Interval/cron schedules and scheduler leases |
+| `durable-jobs.md` | Visibility leases, heartbeat recovery, DLQ, retention, statistics and Redis adapters |
+| `api-reference.md` | Current `bcp/jobs` public APIs |
+| `platform-manifest.json` | Durable Jobs capability flags |
 | `api-manifest.json` | `bcp/jobs` guide ownership |
-| `docs-web-manifest.json` | Background Jobs navigation and `0.2.8` release route |
-| `releases/0.2.8.md` | Background Jobs Platform release notes |
+| `docs-web-manifest.json` | Durable Jobs navigation and `0.2.10` release route |
+| `releases/0.2.10.md` | Durable Jobs Platform release notes |
 
-Primary APIs:
+Primary durable APIs:
 
 ```ts
 import {
     createJobQueue,
-    createMemoryJobQueueAdapter,
+    createRedisJobQueueAdapter,
+    createRedisJobScheduleStore,
 } from "bcp/jobs";
 ```
 
 Runtime model:
 
 ```text
-web/API/action
-    |
-    | enqueue
-    v
-JobQueueAdapter
-    |
-    v
-worker loop(s)
-    |
-    +-> success
-    +-> retry/backoff
-    +-> failed/cancelled
+web / API / action
+        |
+        v
+shared JobQueueAdapter
+        |
+        +--> visibility lease + heartbeat
+        +--> retry / stale recovery
+        +--> DLQ / requeue
+        |
+        v
+worker processes
+
+scheduler processes
+        |
+        v
+shared JobScheduleStore lease
 ```
 
-The built-in memory adapter is process-local and not durable. Multi-process/container production deployments should implement `JobQueueAdapter` against shared durable infrastructure.
+BCP does not bundle a Redis client library. Redis connection creation and shutdown remain application-owned through the minimal `RedisCommandClient` contract and optional close hook.
 
 ## Update rule
 
@@ -113,23 +104,6 @@ When framework behavior or public surface changes:
 
 ## Docs-web navigation
 
-`docs/docs-web-manifest.json` is the authoritative ordered navigation contract.
-
-Current sections:
-
-```text
-Getting Started
-Routing & Data
-Authentication & Authorization
-Database
-Runtime & Infrastructure
-Storage & Uploads
-Developer Experience
-Platform & Compatibility
-API Reference
-Releases
-```
-
 Important current routes:
 
 | Website route | Markdown source |
@@ -138,40 +112,18 @@ Important current routes:
 | `/docs/authorization-security` | `authorization-security.md` |
 | `/docs/observability` | `observability.md` |
 | `/docs/background-jobs` | `background-jobs.md` |
-| `/docs/development-logging` | `development-logging.md` |
+| `/docs/job-scheduling` | `job-scheduling.md` |
+| `/docs/durable-jobs` | `durable-jobs.md` |
 | `/docs/application-packaging` | `application-packaging.md` |
 | `/docs/database` | `database.md` |
 | `/docs/api-reference` | `api-reference.md` |
-| `/releases/0.2.8` | `releases/0.2.8.md` |
+| `/releases/0.2.10` | `releases/0.2.10.md` |
 
 Every route/source pair is validated by unit tests.
 
-## Platform manifest
-
-`docs/platform-manifest.json` describes:
-
-```text
-framework version/release state
-Node/React/runtime baseline
-production build/package target
-public package entrypoints
-CLI command families
-capability flags
-previous-baseline compatibility intent
-documentation contract files
-```
+## Public entrypoints
 
-The supported production target remains:
-
-```text
-standalone-node
-```
-
-## API manifest
-
-`docs/api-manifest.json` describes public package entrypoints documentation tooling may present as supported APIs.
-
-Current entrypoints:
+Current documented entrypoints:
 
 ```text
 bcp
@@ -191,39 +143,9 @@ bcp/middleware
 
 The API-manifest entrypoint set must match the platform public-entrypoint set exactly.
 
-## bcp-docs-web synchronization
-
-The docs website sync loads the manifests before Markdown content:
-
-```text
-selected framework ref
-        ↓
-docs-web-manifest.json
-platform-manifest.json
-api-manifest.json
-        ↓
-validate version/release/API parity
-        ↓
-load referenced Markdown
-        ↓
-synchronize CMS/search/navigation
-```
-
-## Source conventions
-
-- one H1 per Markdown page,
-- stable heading hierarchy,
-- fenced code blocks with language tags,
-- relative links between docs,
-- exact public API names,
-- clear stable/RC/roadmap labels,
-- security limitations next to affected APIs,
-- no framework-internal module presented as public API,
-- no secrets/runtime `.env` values in public documentation metadata.
-
 ## Release validation
 
-Before publishing `0.2.8`:
+Before publishing `0.2.10`:
 
 ```bash
 npm run typecheck
@@ -234,33 +156,20 @@ npm run test:e2e
 npm run rc:check
 ```
 
-Background Jobs Platform validation covers:
+Durable Jobs Platform validation covers:
 
-- immediate and delayed jobs,
-- retry/backoff behavior,
-- terminal success/failure/cancellation states,
-- duplicate job IDs,
-- worker concurrency and graceful stop,
-- public `bcp/jobs` exports,
-- server-only browser/client boundaries,
-- prepared npm package contents,
+- worker visibility leases and heartbeat renewal,
+- stale-running recovery,
+- retry exhaustion and DLQ indexing,
+- dead-letter requeue,
+- queue statistics,
+- terminal retention cleanup,
+- Redis queue and schedule adapter command contracts,
+- compiled `bcp/jobs` runtime imports,
 - docs/platform/API version 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:
-
-```text
-source
-public exports
-tests
-Markdown docs
-docs-web manifest
-platform manifest
-API manifest
-release notes
-```
-
-`bcp-docs-web` remains the presentation/search/navigation layer for this content.
+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.8",
+  "version": "0.2.10",
   "releaseState": "unreleased",
   "coverage": "public-entrypoints",
   "entrypoints": [
@@ -99,9 +99,11 @@
       "source": "packages/client/src/jobs.ts",
       "environment": "server",
       "route": "/docs/api-reference#bcp-jobs",
-      "summary": "Background job queue contract with in-memory adapter, delayed jobs, retry/backoff, cancellation and concurrent workers.",
+      "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"
       ]
     },