create-bcp-app 0.2.12 → 0.2.13

package/README.md

@@ -69,17 +69,17 @@ Select storage provider:
 
 New projects include `bcp.project.json`.
 
-Example for the `0.2.12` target:
+Example for the `0.2.13` target:
 
 ```json
 {
   "schemaVersion": 1,
   "framework": "bcp",
   "projectName": "my-app",
-  "frameworkPackage": "npm:@chidchanun/bcp@0.2.12",
+  "frameworkPackage": "npm:@chidchanun/bcp@0.2.13",
   "createdWith": {
     "package": "create-bcp-app",
-    "version": "0.2.12"
+    "version": "0.2.13"
   },
   "packageManager": "npm",
   "presets": {
@@ -167,26 +167,6 @@ export const onboarding =
 Applications using the SQL Database Platform can persist integration events in the same transaction as business data:
 
 ```ts
-import {
-    db,
-} from "bcp/database";
-
-import {
-    createSqlOutboxStore,
-    createTransactionalOutbox,
-} from "bcp/events";
-
-const outboxStore =
-    createSqlOutboxStore({
-        database: db,
-        driver: "mysql",
-    });
-
-const outbox =
-    createTransactionalOutbox({
-        store: outboxStore,
-    });
-
 await db.transaction(
     async tx => {
         await tx.execute(
@@ -204,42 +184,78 @@ await db.transaction(
 );
 ```
 
-Create migration SQL with:
+After commit, `createOutboxDispatcher()` can hand off events to durable jobs/custom publishers.
+
+## Realtime Platform — 0.2.13+
+
+Generated applications can add server-side realtime channels without changing the scaffold preset model:
 
 ```ts
 import {
-    createOutboxMigrationSql,
-} from "bcp/events";
+    createRealtime,
+} from "bcp/realtime";
 
-const migrationSql =
-    createOutboxMigrationSql(
-        "mysql"
-    );
+export const realtime =
+    createRealtime();
 ```
 
-After commit, dispatch to the durable job queue:
+Channel/room usage:
 
 ```ts
-import {
-    createOutboxDispatcher,
-} from "bcp/events";
+const connection =
+    await realtime.connect();
 
-const dispatcher =
-    createOutboxDispatcher({
-        store: outboxStore,
-        queue: jobs,
-        ownerId: "outbox-a",
-    });
+await connection.join(
+    "orders:42"
+);
+
+await realtime.broadcast(
+    "orders:42",
+    "order.updated",
+    {
+        status: "paid",
+    }
+);
+```
+
+Presence metadata can be attached during `join()` and read with `realtime.members(channel)`.
+
+For private channels, configure `authenticate`, `getUserId` and `authorizeChannel` on `createRealtime()`.
 
-const runner =
-    dispatcher.start();
+### WebSocket integration
+
+BCP does not install a WebSocket library. Adapt your selected provider to `RealtimeSocket` and pass it to:
+
+```ts
+await realtime.attachSocket(
+    socketAdapter,
+    {
+        request,
+    }
+);
 ```
 
-Event type `order.created` is handed off to queue name `event.order.created`.
+### Server-Sent Events
+
+SSE is available without another dependency:
+
+```ts
+export function GET(
+    request: Request
+) {
+    return realtime.sse(
+        "jobs:42",
+        {
+            signal:
+                request.signal,
+        }
+    );
+}
+```
 
-The outbox dispatcher supports leases, stale recovery, retry/backoff, custom publishers, a local EventBus, cleanup and statistics.
+The memory broker/presence store are local-only. Multi-instance production deployments should provide shared `RealtimeBroker` and `RealtimePresenceStore` implementations.
 
-`bcp/events` is server-only. The SQL outbox protects the database-commit/external-publish boundary, but downstream delivery remains at-least-once, so non-repeatable side effects should use idempotency protection.
+`bcp/realtime` is server-only and cannot be imported into page/client bundles.
 
 ## Storage providers
 
@@ -279,5 +295,5 @@ npm run generate -- migration create_users
 For prerelease/local package verification:
 
 ```bash
-npx create-bcp-app my-app --bcp file:../chidchanun-bcp-0.2.12.tgz
+npx create-bcp-app my-app --bcp file:../chidchanun-bcp-0.2.13.tgz
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-bcp-app",
-  "version": "0.2.12",
+  "version": "0.2.13",
   "description": "Create a new BCP Framework application.",
   "type": "module",
   "license": "MIT",

package/template/README.md

@@ -112,26 +112,6 @@ Workflows support sequential/parallel steps, retries, persisted delays, compensa
 Use `bcp/events` when application data and an integration event must commit atomically in the same SQL transaction.
 
 ```ts
-import {
-    db,
-} from "bcp/database";
-
-import {
-    createSqlOutboxStore,
-    createTransactionalOutbox,
-} from "bcp/events";
-
-const outboxStore =
-    createSqlOutboxStore({
-        database: db,
-        driver: "mysql",
-    });
-
-const outbox =
-    createTransactionalOutbox({
-        store: outboxStore,
-    });
-
 await db.transaction(
     async tx => {
         await tx.execute(
@@ -149,42 +129,63 @@ await db.transaction(
 );
 ```
 
-Generate the required table SQL:
+After commit, `createOutboxDispatcher()` can deliver through durable jobs or a custom publisher.
+
+## Realtime Platform — BCP 0.2.13+
+
+Create a server-side realtime hub:
 
 ```ts
 import {
-    createOutboxMigrationSql,
-} from "bcp/events";
+    createRealtime,
+} from "bcp/realtime";
 
-const sql =
-    createOutboxMigrationSql(
-        "mysql"
-    );
+export const realtime =
+    createRealtime();
 ```
 
-Dispatch committed events to the durable queue:
+Channels/rooms:
 
 ```ts
-import {
-    createOutboxDispatcher,
-} from "bcp/events";
+const connection =
+    await realtime.connect();
 
-const dispatcher =
-    createOutboxDispatcher({
-        store: outboxStore,
-        queue: jobs,
-        ownerId: "outbox-a",
-    });
+await connection.join(
+    "orders:42"
+);
 
-const runner =
-    dispatcher.start();
+await realtime.broadcast(
+    "orders:42",
+    "order.updated",
+    {
+        status: "paid",
+    }
+);
 ```
 
-Event `order.created` is queued as `event.order.created`.
+Presence metadata can be supplied during `join()` and queried with `realtime.members(channel)`.
+
+BCP does not install a WebSocket server dependency. Adapt the selected provider to `RealtimeSocket` and call `realtime.attachSocket(socketAdapter, { request })`.
+
+SSE is built in:
+
+```ts
+export function GET(
+    request: Request
+) {
+    return realtime.sse(
+        "jobs:42",
+        {
+            signal:
+                request.signal,
+        }
+    );
+}
+```
 
-The dispatcher supports leases, stale recovery, retry/backoff, custom publishers, local EventBus delivery, retention cleanup and statistics.
+For multi-instance deployment, replace the memory broker/presence store with shared `RealtimeBroker` and `RealtimePresenceStore` implementations.
 
-`bcp/events` is server-only. Outbox delivery remains at-least-once, so non-repeatable downstream side effects should use idempotency protection.
+`bcp/realtime` is server-only and cannot be imported into page/client bundles.
 
 ## Generate framework files