@axeom/ws 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Axeom
+
+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.cjs

@@ -0,0 +1,54 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default,
+  wsPlugin: () => wsPlugin
+});
+module.exports = __toCommonJS(index_exports);
+var wsPlugin = () => {
+  return (app) => {
+    app.ws = function(path, handlers) {
+      return this.addRoute(
+        "GET",
+        path,
+        () => {
+          return new Response(null, {
+            status: 200,
+            headers: {
+              Upgrade: "websocket",
+              Connection: "Upgrade",
+              "X-Axeom-Status": "101"
+            }
+          });
+        },
+        void 0,
+        { ws: handlers }
+      );
+    };
+    return app;
+  };
+};
+var index_default = wsPlugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  wsPlugin
+});

package/dist/index.d.cts

@@ -0,0 +1,27 @@
+import { Axeom } from '@axeom/core';
+
+interface WSHandlers {
+    open?: (ws: any) => void | Promise<void>;
+    message?: (ws: any, message: any) => void | Promise<void>;
+    close?: (ws: any, code: number, reason: string) => void | Promise<void>;
+    error?: (ws: any, error: any) => void | Promise<void>;
+}
+/**
+ * Axeom WebSocket Plugin.
+ * Adds the .ws() method to the Axeom instance.
+ */
+declare module "@axeom/core" {
+    interface Axeom<T, D> {
+        /**
+         * Registers a WebSocket route.
+         * Triggers a '101 Switching Protocols' response and delegates to the runtime's native upgrade handler.
+         *
+         * @param path The route path.
+         * @param handlers WebSocket lifecycle handlers (open, message, close, etc.).
+         */
+        ws(path: string, handlers: WSHandlers): this;
+    }
+}
+declare const wsPlugin: () => <T extends Record<string, any>, D extends Record<string, any>>(app: Axeom<T, D>) => Axeom<T, D>;
+
+export { type WSHandlers, wsPlugin as default, wsPlugin };

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { Axeom } from '@axeom/core';
+
+interface WSHandlers {
+    open?: (ws: any) => void | Promise<void>;
+    message?: (ws: any, message: any) => void | Promise<void>;
+    close?: (ws: any, code: number, reason: string) => void | Promise<void>;
+    error?: (ws: any, error: any) => void | Promise<void>;
+}
+/**
+ * Axeom WebSocket Plugin.
+ * Adds the .ws() method to the Axeom instance.
+ */
+declare module "@axeom/core" {
+    interface Axeom<T, D> {
+        /**
+         * Registers a WebSocket route.
+         * Triggers a '101 Switching Protocols' response and delegates to the runtime's native upgrade handler.
+         *
+         * @param path The route path.
+         * @param handlers WebSocket lifecycle handlers (open, message, close, etc.).
+         */
+        ws(path: string, handlers: WSHandlers): this;
+    }
+}
+declare const wsPlugin: () => <T extends Record<string, any>, D extends Record<string, any>>(app: Axeom<T, D>) => Axeom<T, D>;
+
+export { type WSHandlers, wsPlugin as default, wsPlugin };

package/dist/index.js

@@ -0,0 +1,29 @@
+// src/index.ts
+var wsPlugin = () => {
+  return (app) => {
+    app.ws = function(path, handlers) {
+      return this.addRoute(
+        "GET",
+        path,
+        () => {
+          return new Response(null, {
+            status: 200,
+            headers: {
+              Upgrade: "websocket",
+              Connection: "Upgrade",
+              "X-Axeom-Status": "101"
+            }
+          });
+        },
+        void 0,
+        { ws: handlers }
+      );
+    };
+    return app;
+  };
+};
+var index_default = wsPlugin;
+export {
+  index_default as default,
+  wsPlugin
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@axeom/ws",
+  "version": "0.1.1",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@axeom/core": "0.1.1"
+  },
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch"
+  }
+}