@iadev93/zuno-express 0.0.6 → 0.0.8

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Ibrahim Aftab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.d.ts

@@ -1,2 +1,38 @@
-export * from './createZunoExpress';
+import type { Request, Response } from "express";
+import type { IncomingHttpHeaders } from "http";
+/**
+ * Options for creating an Express router for Zuno.
+ */
+export 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.
+ */
+export 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;
+};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC"}
+{"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"}

package/dist/index.js

@@ -1 +1,43 @@
-export * from './createZunoExpress';
+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),
+    };
+}

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@iadev93/zuno-express",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "exports": {
     ".": {
@@ -13,20 +14,19 @@
       "default": "./dist/index.js"
     }
   },
-  "scripts": {
-    "build": "tsc -p tsconfig.json"
-  },
   "peerDependencies": {
-    "@iadev93/zuno": "workspace:*",
-    "express": "^5.0.0"
+    "express": "^5.0.0",
+    "@iadev93/zuno": "0.0.5"
   },
   "devDependencies": {
     "@types/express": "^5.0.0",
     "@types/node": "^20.0.0",
     "typescript": "^5.9.3",
-    "@iadev93/zuno": "workspace:*"
+    "@iadev93/zuno": "0.0.5"
   },
   "keywords": [
+    "zuno",
+    "express",
     "state",
     "state-management",
     "sync",
@@ -44,5 +44,8 @@
     "url": "git+https://github.com/IADev-Channel/zuno.git"
   },
   "author": "Ibrahim Aftab",
-  "license": "MIT"
-}
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  }
+}

package/dist/createZunoExpress.d.ts

@@ -1,29 +0,0 @@
-import type { IncomingHttpHeaders } from "http";
-/**
- * Options for creating an Express router for Zuno.
- */
-type CreateZunoExpressOptions = {
-    headers?: IncomingHttpHeaders;
-};
-/**
- * Creates an Express router for Zuno.
- *
- * @param opts - Options for creating the Express router.
- * @returns An object containing the SSE, sync, and snapshot handlers
- */
-export declare function createZunoExpress(opts?: CreateZunoExpressOptions): {
-    /**
-     * Handles SSE connections.
-     */
-    sse: (req: import("express").Request, res: import("express").Response) => void;
-    /**
-     * Handles sync connections.
-     */
-    sync: (req: import("express").Request, res: import("express").Response) => void;
-    /**
-     * Handles snapshot connections.
-     */
-    snapshot: (req: import("express").Request, res: import("express").Response) => void;
-};
-export {};
-//# sourceMappingURL=createZunoExpress.d.ts.map

package/dist/createZunoExpress.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createZunoExpress.d.ts","sourceRoot":"","sources":["../src/createZunoExpress.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAA;AAK/C;;GAEG;AACH,KAAK,wBAAwB,GAAG;IAC9B,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAC9B,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,CAAC,EAAE,wBAAwB;IAI7D;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;EAGN"}

package/dist/createZunoExpress.js

@@ -1,26 +0,0 @@
-import { createExpressSSEHandler } from "./express-sse-handler";
-import { createExpressSyncHandler } from "./express-sync-handler";
-import { createExpressSnapshotHandler } from "./express-snapshot-handler";
-/**
- * Creates an Express router for Zuno.
- *
- * @param opts - Options for creating the Express router.
- * @returns An object containing the SSE, sync, and snapshot handlers
- */
-export function createZunoExpress(opts) {
-    const { headers } = opts ?? {};
-    return {
-        /**
-         * Handles SSE connections.
-         */
-        sse: createExpressSSEHandler(headers),
-        /**
-         * Handles sync connections.
-         */
-        sync: createExpressSyncHandler(),
-        /**
-         * Handles snapshot connections.
-         */
-        snapshot: createExpressSnapshotHandler(),
-    };
-}

package/dist/express-snapshot-handler.d.ts

@@ -1,7 +0,0 @@
-import type { Request, Response } from "express";
-/**
- * Creates an Express handler for handling Zuno state events.
- * @returns An Express handler function.
- */
-export declare function createExpressSnapshotHandler(): (req: Request, res: Response) => void;
-//# sourceMappingURL=express-snapshot-handler.d.ts.map

package/dist/express-snapshot-handler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"express-snapshot-handler.d.ts","sourceRoot":"","sources":["../src/express-snapshot-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGhD;;;GAGG;AACH,wBAAgB,4BAA4B,KAClC,KAAK,OAAO,EAAE,KAAK,QAAQ,UACpC"}

package/dist/express-snapshot-handler.js

@@ -1,8 +0,0 @@
-import { sendSnapshot } from "@iadev93/zuno/server";
-/**
- * Creates an Express handler for handling Zuno state events.
- * @returns An Express handler function.
- */
-export function createExpressSnapshotHandler() {
-    return (req, res) => sendSnapshot(req, res);
-}

package/dist/express-sse-handler.d.ts

@@ -1,8 +0,0 @@
-import type { Request, Response } from "express";
-import type { IncomingHttpHeaders } from "http";
-/**
- * Creates an SSE handler for express.
- * @returns An Express handler function.
- */
-export declare function createExpressSSEHandler(headers?: IncomingHttpHeaders): (req: Request, res: Response) => void;
-//# sourceMappingURL=express-sse-handler.d.ts.map

package/dist/express-sse-handler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"express-sse-handler.d.ts","sourceRoot":"","sources":["../src/express-sse-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAIhD;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,CAAC,EAAE,mBAAmB,IAI3D,KAAK,OAAO,EAAE,KAAK,QAAQ,UACpC"}

package/dist/express-sse-handler.js

@@ -1,11 +0,0 @@
-import { createSSEConnection } from "@iadev93/zuno/server";
-/**
- * Creates an SSE handler for express.
- * @returns An Express handler function.
- */
-export function createExpressSSEHandler(headers) {
-    /**
-     * Creates an SSE connection for the client.
-     */
-    return (req, res) => createSSEConnection(req, res, headers ?? {});
-}

package/dist/express-sync-handler.d.ts

@@ -1,7 +0,0 @@
-import type { Request, Response } from "express";
-/**
- * Creates an Express handler for handling Zuno state events.
- * @returns An Express handler function.
- */
-export declare function createExpressSyncHandler(): (req: Request, res: Response) => void;
-//# sourceMappingURL=express-sync-handler.d.ts.map

package/dist/express-sync-handler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"express-sync-handler.d.ts","sourceRoot":"","sources":["../src/express-sync-handler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAKhD;;;GAGG;AACH,wBAAgB,wBAAwB,KAC9B,KAAK,OAAO,EAAE,KAAK,QAAQ,UAmBpC"}

package/dist/express-sync-handler.js

@@ -1,23 +0,0 @@
-import { applyStateEvent } from "@iadev93/zuno/server";
-/**
- * Creates an Express handler for handling Zuno state events.
- * @returns An Express handler function.
- */
-export function createExpressSyncHandler() {
-    return (req, res) => {
-        /** The incoming state event to apply. */
-        const incoming = req.body;
-        /** Applies the incoming state event to the target Zuno universe or store. */
-        const result = applyStateEvent(incoming);
-        /** If the state event is not valid, returns a 409 status code with the reason and current state. */
-        if (!result.ok) {
-            res.status(409).json({
-                reason: result.reason,
-                current: result.current,
-            });
-            return;
-        }
-        /** Returns a 200 status code with the result. */
-        res.status(200).json({ ok: true, event: result.event });
-    };
-}