@iadev93/zuno-express 0.0.8 → 0.0.10

package/README.md

@@ -1,8 +1,8 @@
 # @iadev93/zuno-express
 
-Express adapter for **Zuno**.
+<p><b>Express adapter for Zuno.</b></p>
 
-Provides server‑side synchronization endpoints using Server‑Sent Events (SSE).
+Provides server-side synchronization endpoints using Server-Sent Events (SSE) for Express applications.
 
 ---
 
@@ -13,7 +13,6 @@ npm install @iadev93/zuno-express
 ```
 
 Peer dependency:
-
 * `express >= 4`
 
 ---
@@ -23,23 +22,36 @@ Peer dependency:
 ```ts
 import express from "express";
 import { createZunoExpress } from "@iadev93/zuno-express";
-import { createZuno } from "@iadev93/zuno";
 
 const app = express();
-const zuno = createZuno();
+app.use(express.json());
+
+const zuno = createZunoExpress();
 
-createZunoExpress(app, { zuno });
+// Unified handlers
+app.get("/zuno/sse", zuno.sse);
+app.post("/zuno/sync", zuno.sync);
+app.get("/zuno/snapshot", zuno.snapshot);
 
 app.listen(3000);
 ```
 
 ---
 
-## What It Provides
+## API
+
+### `createZunoExpress(opts?)`
+
+Returns an object containing the following Express handlers:
+
+#### `sse` (GET)
+Handles persistent SSE connections, heartbeats, and initial synchronization.
+
+#### `sync` (POST)
+Validates and applies incoming state events.
 
-* SSE endpoint for state sync
-* Snapshot delivery
-* Version‑safe event ingestion
+#### `snapshot` (GET)
+Returns the current full state of the universe.
 
 ---
 

package/dist/index.d.mts

@@ -0,0 +1,40 @@
+import { Request, Response } from 'express';
+import { IncomingHttpHeaders } from 'http';
+
+/**
+ * Options for creating an Express router for Zuno.
+ */
+type CreateZunoExpressOptions = {
+    /** Optional custom headers to be sent with the SSE response. */
+    headers?: IncomingHttpHeaders;
+};
+/**
+ * Creates a Zuno Express instance.
+ * @param {CreateZunoExpressOptions} [opts] - Options for creating the Express router.
+ * @returns {Object} An object with the following properties:
+ *   - sse: An Express handler function that handles SSE connections.
+ *   - sync: An Express handler function that handles sync POST requests.
+ *   - snapshot: An Express handler function that handles snapshot GET requests.
+ */
+declare function createZunoExpress(opts?: CreateZunoExpressOptions): {
+    /**
+     * Handles SSE connections for Express.
+     * @param {Request} req - Express request object.
+     * @param {Response} res - Express response object.
+     */
+    sse: (req: Request, res: Response) => void;
+    /**
+     * Handles sync POST requests for Express.
+     * @param {Request} req - Express request object.
+     * @param {Response} res - Express response object.
+     */
+    sync: (req: Request, res: Response) => void;
+    /**
+     * Handles snapshot GET requests for Express.
+     * @param {Request} req - Express request object.
+     * @param {Response} res - Express response object.
+     */
+    snapshot: (req: Request, res: Response) => void;
+};
+
+export { type CreateZunoExpressOptions, createZunoExpress };

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-import type { Request, Response } from "express";
-import type { IncomingHttpHeaders } from "http";
+import { Request, Response } from 'express';
+import { IncomingHttpHeaders } from 'http';
+
 /**
  * Options for creating an Express router for Zuno.
  */
-export type CreateZunoExpressOptions = {
+type CreateZunoExpressOptions = {
     /** Optional custom headers to be sent with the SSE response. */
     headers?: IncomingHttpHeaders;
 };
@@ -15,7 +16,7 @@ export type CreateZunoExpressOptions = {
  *   - sync: An Express handler function that handles sync POST requests.
  *   - snapshot: An Express handler function that handles snapshot GET requests.
  */
-export declare function createZunoExpress(opts?: CreateZunoExpressOptions): {
+declare function createZunoExpress(opts?: CreateZunoExpressOptions): {
     /**
      * Handles SSE connections for Express.
      * @param {Request} req - Express request object.
@@ -35,4 +36,5 @@ export declare function createZunoExpress(opts?: CreateZunoExpressOptions): {
      */
     snapshot: (req: Request, res: Response) => void;
 };
-//# sourceMappingURL=index.d.ts.map
+
+export { type CreateZunoExpressOptions, createZunoExpress };

package/dist/index.js

@@ -1,43 +1,2 @@
-import { createSSEConnection, applyStateEvent, sendSnapshot } from "@iadev93/zuno/server";
-/**
- * Creates a Zuno Express instance.
- * @param {CreateZunoExpressOptions} [opts] - Options for creating the Express router.
- * @returns {Object} An object with the following properties:
- *   - sse: An Express handler function that handles SSE connections.
- *   - sync: An Express handler function that handles sync POST requests.
- *   - snapshot: An Express handler function that handles snapshot GET requests.
- */
-export function createZunoExpress(opts) {
-    const { headers } = opts ?? {};
-    return {
-        /**
-         * Handles SSE connections for Express.
-         * @param {Request} req - Express request object.
-         * @param {Response} res - Express response object.
-         */
-        sse: (req, res) => createSSEConnection(req, res, headers ?? {}),
-        /**
-         * Handles sync POST requests for Express.
-         * @param {Request} req - Express request object.
-         * @param {Response} res - Express response object.
-         */
-        sync: (req, res) => {
-            const incoming = req.body;
-            const result = applyStateEvent(incoming);
-            if (!result.ok) {
-                res.status(409).json({
-                    reason: result.reason,
-                    current: result.current,
-                });
-                return;
-            }
-            res.status(200).json({ ok: true, event: result.event });
-        },
-        /**
-         * Handles snapshot GET requests for Express.
-         * @param {Request} req - Express request object.
-         * @param {Response} res - Express response object.
-         */
-        snapshot: (req, res) => sendSnapshot(req, res),
-    };
-}
+'use strict';var server=require('@iadev93/zuno/server');function c(n){let{headers:o}=n??{};return {sse:(t,e)=>server.createSSEConnection(t,e,o??{}),sync:(t,e)=>{let r=t.body,s=server.applyStateEvent(r);if(!s.ok){e.status(409).json({reason:s.reason,current:s.current});return}e.status(200).json({ok:true,event:s.event});},snapshot:(t,e)=>server.sendSnapshot(t,e)}}exports.createZunoExpress=c;//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["createZunoExpress","opts","headers","req","res","createSSEConnection","incoming","result","applyStateEvent","sendSnapshot"],"mappings":"wDAyBO,SAASA,CAAAA,CAAkBC,EAAiC,CAClE,GAAM,CAAE,OAAA,CAAAC,CAAQ,EAAID,CAAAA,EAAQ,GAE5B,OAAO,CAMN,GAAA,CAAK,CAACE,EAAcC,CAAAA,GACnBC,0BAAAA,CAAoBF,EAAKC,CAAAA,CAAKF,CAAAA,EAAW,EAAE,CAAA,CAO5C,KAAM,CAACC,CAAAA,CAAcC,IAAkB,CACtC,IAAME,EAAWH,CAAAA,CAAI,IAAA,CACfI,EAASC,sBAAAA,CAAgBF,CAAQ,CAAA,CAEvC,GAAI,CAACC,CAAAA,CAAO,EAAA,CAAI,CACfH,CAAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,CACpB,MAAA,CAAQG,CAAAA,CAAO,OACf,OAAA,CAASA,CAAAA,CAAO,OACjB,CAAC,CAAA,CACD,MACD,CAEAH,CAAAA,CAAI,MAAA,CAAO,GAAG,EAAE,IAAA,CAAK,CAAE,GAAI,IAAA,CAAM,KAAA,CAAOG,EAAO,KAAM,CAAC,EACvD,CAAA,CAOA,QAAA,CAAU,CAACJ,CAAAA,CAAcC,CAAAA,GAAkBK,oBAAaN,CAAAA,CAAKC,CAAG,CACjE,CACD","file":"index.js","sourcesContent":["import type { ZunoStateEvent } from \"@iadev93/zuno\";\nimport {\n\tapplyStateEvent,\n\tcreateSSEConnection,\n\tsendSnapshot,\n} from \"@iadev93/zuno/server\";\nimport type { Request, Response } from \"express\";\nimport type { IncomingHttpHeaders } from \"http\";\n\n/**\n * Options for creating an Express router for Zuno.\n */\nexport type CreateZunoExpressOptions = {\n\t/** Optional custom headers to be sent with the SSE response. */\n\theaders?: IncomingHttpHeaders;\n};\n\n/**\n * Creates a Zuno Express instance.\n * @param {CreateZunoExpressOptions} [opts] - Options for creating the Express router.\n * @returns {Object} An object with the following properties:\n *   - sse: An Express handler function that handles SSE connections.\n *   - sync: An Express handler function that handles sync POST requests.\n *   - snapshot: An Express handler function that handles snapshot GET requests.\n */\nexport function createZunoExpress(opts?: CreateZunoExpressOptions) {\n\tconst { headers } = opts ?? {};\n\n\treturn {\n\t\t/**\n\t\t * Handles SSE connections for Express.\n\t\t * @param {Request} req - Express request object.\n\t\t * @param {Response} res - Express response object.\n\t\t */\n\t\tsse: (req: Request, res: Response) =>\n\t\t\tcreateSSEConnection(req, res, headers ?? {}),\n\n\t\t/**\n\t\t * Handles sync POST requests for Express.\n\t\t * @param {Request} req - Express request object.\n\t\t * @param {Response} res - Express response object.\n\t\t */\n\t\tsync: (req: Request, res: Response) => {\n\t\t\tconst incoming = req.body as ZunoStateEvent;\n\t\t\tconst result = applyStateEvent(incoming);\n\n\t\t\tif (!result.ok) {\n\t\t\t\tres.status(409).json({\n\t\t\t\t\treason: result.reason,\n\t\t\t\t\tcurrent: result.current,\n\t\t\t\t});\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tres.status(200).json({ ok: true, event: result.event });\n\t\t},\n\n\t\t/**\n\t\t * Handles snapshot GET requests for Express.\n\t\t * @param {Request} req - Express request object.\n\t\t * @param {Response} res - Express response object.\n\t\t */\n\t\tsnapshot: (req: Request, res: Response) => sendSnapshot(req, res),\n\t};\n}\n"]}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import {sendSnapshot,createSSEConnection,applyStateEvent}from'@iadev93/zuno/server';function c(n){let{headers:o}=n??{};return {sse:(t,e)=>createSSEConnection(t,e,o??{}),sync:(t,e)=>{let r=t.body,s=applyStateEvent(r);if(!s.ok){e.status(409).json({reason:s.reason,current:s.current});return}e.status(200).json({ok:true,event:s.event});},snapshot:(t,e)=>sendSnapshot(t,e)}}export{c as createZunoExpress};//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":["createZunoExpress","opts","headers","req","res","createSSEConnection","incoming","result","applyStateEvent","sendSnapshot"],"mappings":"oFAyBO,SAASA,CAAAA,CAAkBC,EAAiC,CAClE,GAAM,CAAE,OAAA,CAAAC,CAAQ,EAAID,CAAAA,EAAQ,GAE5B,OAAO,CAMN,GAAA,CAAK,CAACE,EAAcC,CAAAA,GACnBC,mBAAAA,CAAoBF,EAAKC,CAAAA,CAAKF,CAAAA,EAAW,EAAE,CAAA,CAO5C,KAAM,CAACC,CAAAA,CAAcC,IAAkB,CACtC,IAAME,EAAWH,CAAAA,CAAI,IAAA,CACfI,EAASC,eAAAA,CAAgBF,CAAQ,CAAA,CAEvC,GAAI,CAACC,CAAAA,CAAO,EAAA,CAAI,CACfH,CAAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,CACpB,MAAA,CAAQG,CAAAA,CAAO,OACf,OAAA,CAASA,CAAAA,CAAO,OACjB,CAAC,CAAA,CACD,MACD,CAEAH,CAAAA,CAAI,MAAA,CAAO,GAAG,EAAE,IAAA,CAAK,CAAE,GAAI,IAAA,CAAM,KAAA,CAAOG,EAAO,KAAM,CAAC,EACvD,CAAA,CAOA,QAAA,CAAU,CAACJ,CAAAA,CAAcC,CAAAA,GAAkBK,aAAaN,CAAAA,CAAKC,CAAG,CACjE,CACD","file":"index.mjs","sourcesContent":["import type { ZunoStateEvent } from \"@iadev93/zuno\";\nimport {\n\tapplyStateEvent,\n\tcreateSSEConnection,\n\tsendSnapshot,\n} from \"@iadev93/zuno/server\";\nimport type { Request, Response } from \"express\";\nimport type { IncomingHttpHeaders } from \"http\";\n\n/**\n * Options for creating an Express router for Zuno.\n */\nexport type CreateZunoExpressOptions = {\n\t/** Optional custom headers to be sent with the SSE response. */\n\theaders?: IncomingHttpHeaders;\n};\n\n/**\n * Creates a Zuno Express instance.\n * @param {CreateZunoExpressOptions} [opts] - Options for creating the Express router.\n * @returns {Object} An object with the following properties:\n *   - sse: An Express handler function that handles SSE connections.\n *   - sync: An Express handler function that handles sync POST requests.\n *   - snapshot: An Express handler function that handles snapshot GET requests.\n */\nexport function createZunoExpress(opts?: CreateZunoExpressOptions) {\n\tconst { headers } = opts ?? {};\n\n\treturn {\n\t\t/**\n\t\t * Handles SSE connections for Express.\n\t\t * @param {Request} req - Express request object.\n\t\t * @param {Response} res - Express response object.\n\t\t */\n\t\tsse: (req: Request, res: Response) =>\n\t\t\tcreateSSEConnection(req, res, headers ?? {}),\n\n\t\t/**\n\t\t * Handles sync POST requests for Express.\n\t\t * @param {Request} req - Express request object.\n\t\t * @param {Response} res - Express response object.\n\t\t */\n\t\tsync: (req: Request, res: Response) => {\n\t\t\tconst incoming = req.body as ZunoStateEvent;\n\t\t\tconst result = applyStateEvent(incoming);\n\n\t\t\tif (!result.ok) {\n\t\t\t\tres.status(409).json({\n\t\t\t\t\treason: result.reason,\n\t\t\t\t\tcurrent: result.current,\n\t\t\t\t});\n\t\t\t\treturn;\n\t\t\t}\n\n\t\t\tres.status(200).json({ ok: true, event: result.event });\n\t\t},\n\n\t\t/**\n\t\t * Handles snapshot GET requests for Express.\n\t\t * @param {Request} req - Express request object.\n\t\t * @param {Response} res - Express response object.\n\t\t */\n\t\tsnapshot: (req: Request, res: Response) => sendSnapshot(req, res),\n\t};\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iadev93/zuno-express",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -16,13 +16,14 @@
   },
   "peerDependencies": {
     "express": "^5.0.0",
-    "@iadev93/zuno": "0.0.5"
+    "@iadev93/zuno": "0.0.8"
   },
   "devDependencies": {
     "@types/express": "^5.0.0",
     "@types/node": "^20.0.0",
+    "tsup": "^8.5.1",
     "typescript": "^5.9.3",
-    "@iadev93/zuno": "0.0.5"
+    "@iadev93/zuno": "0.0.8"
   },
   "keywords": [
     "zuno",
@@ -46,6 +47,7 @@
   "author": "Ibrahim Aftab",
   "license": "MIT",
   "scripts": {
-    "build": "tsc -p tsconfig.json"
+    "build": "tsup",
+    "dev": "tsup --watch"
   }
 }

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAQhD;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,gEAAgE;IAChE,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IAI7D;;;;OAIG;eACQ,OAAO,OAAO,QAAQ;IAEjC;;;;OAIG;gBACS,OAAO,OAAO,QAAQ;IAelC;;;;OAIG;oBACa,OAAO,OAAO,QAAQ;EAEzC"}