redweb 0.7.2 → 0.7.4

package/index.d.ts

@@ -1,173 +1,173 @@
-declare module 'redweb' {
-    import { Application } from 'express';
-    import { CorsOptions } from 'cors';
-    import { Server as HttpServer } from 'http';
-    import { WebSocket } from 'ws';
-
-    /** ─────────────────── HTTP / CORE ─────────────────── */
-
-    export type RedWebEncoding = 'json' | 'urlencoded';
-
-    export interface RedWebOptions {
-        port?: number;
-        bind?: string;
-        publicPaths?: string[];
-        services?: Array<{ serviceName: string; method: string; function: Function }>;
-        listenCallback?: () => void;
-        encoding?: RedWebEncoding;
-        ssl?: { key: string; cert: string };
-        server?: Application;
-        corsOptions?: CorsOptions;
-        enableHtmxRendering?: boolean;
-    }
-
-    /** ─────────────────── SOCKET SERVER ─────────────────── */
-
-    export interface SocketServerOptions {
-        server?: HttpServer;
-        port?: number;
-        routes?: Array<new () => SocketRoute>;
-        ssl?: { key: string; cert: string };
-    }
-
-    /** ─────────────────── ROUTES & HANDLERS ─────────────────── */
-
-    export interface SocketRouteConfig {
-        path: string;
-        handlers: Array<new () => BaseHandler>;
-        services?: Array<new () => SocketService>;
-        allowDuplicateConnections?: boolean;
-    }
-
-    /** Socket‑side autonomous service (game loops, timers, etc.) */
-    export abstract class SocketService {
-        name: string;
-        tickRateMs?: number;
-        protected _tickHandle?: NodeJS.Timeout;
-
-        constructor(name: string, tickRateMs?: number);
-
-        /** Called once when the route is initialised */
-        onInit(route: SocketRoute): void;
-
-        /** Optional recurring tick (respecting tickRateMs) */
-        onTick?(): void;
-
-        /** Called on process shutdown / route removal */
-        onShutdown(): void;
-    }
-
-    /** Message handler, triggered by client messages */
-    export class BaseHandler {
-        name: string;
-        constructor(name: string);
-
-        handleMessage(
-            socket: WebSocket & {
-                sendJson: (message: object) => void;
-                broadcast: (message: object) => void;
-            },
-            message: any
-        ): void;
-
-        onMessage(socket: WebSocket, message: any): void;
-        onInitialContact(socket: WebSocket): void;
-    }
-
-    export class SocketRoute {
-        path: string;
-        handlers: BaseHandler[];
-        clients: Map<string, WebSocket>;
-        allowDuplicateConnections?: boolean;
-
-        constructor(config: SocketRouteConfig);
-
-        addHandler(handler: new () => BaseHandler): void;
-        handleMessage(sock: WebSocket, data: any): void;
-    }
-
-    /** ─────────────────── SERVER BASE ─────────────────── */
-
-    export class BaseSocketServer {
-        clients: Map<string, WebSocket>;
-        server: HttpServer;
-        routes: SocketRoute[];
-
-        constructor(server: HttpServer, options?: SocketServerOptions);
-
-        addRoute(route: new () => SocketRoute): void;
-    }
-
-    /** ─────────────────── REGISTRY & UTIL TYPES ─────────────────── */
-
-    export interface SocketWrapper {
-        socket: WebSocket;
-        id: string;
-        send: (type: string, payload: Record<string, any>) => void;
-        getSanitized?(): Record<string, any>;
-    }
-
-    export type SocketMessage = {
-        type: string;
-        [key: string]: any;
-    };
-
-    /** Generic event‑driven registry for socket objects */
-    /** Generic event-driven registry for socket objects */
-    export class SocketRegistry<T extends SocketWrapper = SocketWrapper> extends EventEmitter {
-        protected items: T[];
-
-        constructor();
-
-        /** Adds a socket-bound object to the registry */
-        add(item: T): void;
-
-        /**
-         * Removes a socket-bound object by reference or id (default key: 'id')
-         * @param itemOrId Object or ID string
-         * @param by Key name to match against (default is 'id')
-         */
-        remove(itemOrId: T | string, by?: keyof T): boolean;
-
-        /** Returns a shallow copy of all registered items */
-        all(): T[];
-
-        /** Returns the number of registered items */
-        count(): number;
-    }
-
-    /** ─────────────────── CONCRETE SERVERS ─────────────────── */
-
-    export class SocketServer extends BaseSocketServer {
-        constructor(options?: SocketServerOptions);
-    }
-
-    export class SecureSocketServer extends BaseSocketServer {
-        constructor(options?: SocketServerOptions);
-    }
-
-    export class HttpServer {
-        constructor(options?: RedWebOptions);
-    }
-
-    export class HttpsServer {
-        constructor(options?: RedWebOptions);
-    }
-
-    /** ─────────────────── CONSTANTS ─────────────────── */
-
-    export const METHODS: {
-        GET: 'get';
-        POST: 'post';
-        PUT: 'put';
-        DELETE: 'delete';
-    };
-
-    export const ENCODINGS: {
-        json: 'json';
-        urlencoded: 'urlencoded';
-    };
-
-    export const HTTP_OPTIONS: RedWebOptions;
-    export const SOCKET_OPTIONS: SocketServerOptions;
-}
+declare module 'redweb' {
+    import { Application } from 'express';
+    import { CorsOptions } from 'cors';
+    import { Server as HttpServer } from 'http';
+    import { WebSocket } from 'ws';
+
+    /** ─────────────────── HTTP / CORE ─────────────────── */
+
+    export type RedWebEncoding = 'json' | 'urlencoded';
+
+    export interface RedWebOptions {
+        port?: number;
+        bind?: string;
+        publicPaths?: string[];
+        services?: Array<{ serviceName: string; method: string; function: Function }>;
+        listenCallback?: () => void;
+        encoding?: RedWebEncoding;
+        ssl?: { key: string; cert: string };
+        server?: Application;
+        corsOptions?: CorsOptions;
+        enableHtmxRendering?: boolean;
+    }
+
+    /** ─────────────────── SOCKET SERVER ─────────────────── */
+
+    export interface SocketServerOptions {
+        server?: HttpServer;
+        port?: number;
+        routes?: Array<new () => SocketRoute>;
+        ssl?: { key: string; cert: string };
+    }
+
+    /** ─────────────────── ROUTES & HANDLERS ─────────────────── */
+
+    export interface SocketRouteConfig {
+        path: string;
+        handlers: Array<new () => BaseHandler>;
+        services?: Array<new () => SocketService>;
+        allowDuplicateConnections?: boolean;
+    }
+
+    /** Socket‑side autonomous service (game loops, timers, etc.) */
+    export abstract class SocketService {
+        name: string;
+        tickRateMs?: number;
+        protected _tickHandle?: NodeJS.Timeout;
+
+        constructor(name: string, tickRateMs?: number);
+
+        /** Called once when the route is initialised */
+        onInit(route: SocketRoute): void;
+
+        /** Optional recurring tick (respecting tickRateMs) */
+        onTick?(): void;
+
+        /** Called on process shutdown / route removal */
+        onShutdown(): void;
+    }
+
+    /** Message handler, triggered by client messages */
+    export class BaseHandler {
+        name: string;
+        constructor(name: string);
+
+        handleMessage(
+            socket: WebSocket & {
+                sendJson: (message: object) => void;
+                broadcast: (message: object) => void;
+            },
+            message: any
+        ): void;
+
+        onMessage(socket: WebSocket, message: any): void;
+        onInitialContact(socket: WebSocket): void;
+    }
+
+    export class SocketRoute {
+        path: string;
+        handlers: BaseHandler[];
+        clients: Map<string, WebSocket>;
+        allowDuplicateConnections?: boolean;
+
+        constructor(config: SocketRouteConfig);
+
+        addHandler(handler: new () => BaseHandler): void;
+        handleMessage(sock: WebSocket, data: any): void;
+    }
+
+    /** ─────────────────── SERVER BASE ─────────────────── */
+
+    export class BaseSocketServer {
+        clients: Map<string, WebSocket>;
+        server: HttpServer;
+        routes: SocketRoute[];
+
+        constructor(server: HttpServer, options?: SocketServerOptions);
+
+        addRoute(route: new () => SocketRoute): void;
+    }
+
+    /** ─────────────────── REGISTRY & UTIL TYPES ─────────────────── */
+
+    export interface SocketWrapper {
+        socket: WebSocket;
+        id: string;
+        send: (type: string, payload: Record<string, any>) => void;
+        getSanitized?(): Record<string, any>;
+    }
+
+    export type SocketMessage = {
+        type: string;
+        [key: string]: any;
+    };
+
+    /** Generic event‑driven registry for socket objects */
+    /** Generic event-driven registry for socket objects */
+    export class SocketRegistry<T extends SocketWrapper = SocketWrapper> extends EventEmitter {
+        protected items: T[];
+
+        constructor();
+
+        /** Adds a socket-bound object to the registry */
+        add(item: T): void;
+
+        /**
+         * Removes a socket-bound object by reference or id (default key: 'id')
+         * @param itemOrId Object or ID string
+         * @param by Key name to match against (default is 'id')
+         */
+        remove(itemOrId: T | string, by?: keyof T): boolean;
+
+        /** Returns a shallow copy of all registered items */
+        all(): T[];
+
+        /** Returns the number of registered items */
+        count(): number;
+    }
+
+    /** ─────────────────── CONCRETE SERVERS ─────────────────── */
+
+    export class SocketServer extends BaseSocketServer {
+        constructor(options?: SocketServerOptions);
+    }
+
+    export class SecureSocketServer extends BaseSocketServer {
+        constructor(options?: SocketServerOptions);
+    }
+
+    export class HttpServer {
+        constructor(options?: RedWebOptions);
+    }
+
+    export class HttpsServer {
+        constructor(options?: RedWebOptions);
+    }
+
+    /** ─────────────────── CONSTANTS ─────────────────── */
+
+    export const METHODS: {
+        GET: 'get';
+        POST: 'post';
+        PUT: 'put';
+        DELETE: 'delete';
+    };
+
+    export const ENCODINGS: {
+        json: 'json';
+        urlencoded: 'urlencoded';
+    };
+
+    export const HTTP_OPTIONS: RedWebOptions;
+    export const SOCKET_OPTIONS: SocketServerOptions;
+}

package/index.js

@@ -1,19 +1,19 @@
-const { METHODS } = require('./src/http');
-const { sendJson } = require('./src/ws/util');
-const { SocketServer, SecureSocketServer, SOCKET_OPTIONS, SocketRoute, SocketService, SocketRegistry } = require('./src/ws');
-const { BaseHandler } = require('./src/ws/BaseHandler');
-const HttpServer = require('./src/http/HttpServer');
-const HttpsServer = require('./src/http/HttpsServer');
-module.exports = {
-    HttpServer,
-    HttpsServer,
-    SocketServer,
-    SecureSocketServer,
-    BaseHandler,
-    SocketRoute,
-    SocketService,
-    SocketRegistry,
-    sendJson,
-    SOCKET_OPTIONS,
-    METHODS
-};
+const { METHODS } = require('./src/http');
+const { sendJson } = require('./src/ws/util');
+const { SocketServer, SecureSocketServer, SOCKET_OPTIONS, SocketRoute, SocketService, SocketRegistry } = require('./src/ws');
+const { BaseHandler } = require('./src/ws/BaseHandler');
+const HttpServer = require('./src/http/HttpServer');
+const HttpsServer = require('./src/http/HttpsServer');
+module.exports = {
+    HttpServer,
+    HttpsServer,
+    SocketServer,
+    SecureSocketServer,
+    BaseHandler,
+    SocketRoute,
+    SocketService,
+    SocketRegistry,
+    sendJson,
+    SOCKET_OPTIONS,
+    METHODS
+};

package/package.json

@@ -1,27 +1,27 @@
-{
-  "name": "redweb",
-  "version": "0.7.2",
-  "description": "A way to quickly set up an express server",
-  "main": "index.js",
-  "scripts": {
-    "test": "node tester.js"
-  },
-  "files": [
-    "src/*",
-    "index.d.ts"
-  ],
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "cors": "^2.8.5",
-    "express": "^4.19.2",
-    "ws": "^8.17.0"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.21",
-    "@types/jest": "^29.5.12",
-    "jest": "^29.7.0",
-    "supertest": "^7.0.0"
-  }
-}
+{
+  "name": "redweb",
+  "version": "0.7.4",
+  "description": "A way to quickly set up an express server",
+  "main": "index.js",
+  "scripts": {
+    "test": "npx jest"
+  },
+  "files": [
+    "src/*",
+    "index.d.ts"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.19.2",
+    "ws": "^8.17.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "supertest": "^7.0.0"
+  }
+}

package/src/htmx/HtmxRenderer.js

@@ -1,65 +1,65 @@
-const fs = require('fs');
-const vm = require('vm');
-const path = require('path');
-
-class HtmxRenderer {
-    /**
-     * Render an .htmx file as JavaScript with embedded print statements.
-     * @param {string} filePath - Path to the .htmx file.
-     * @returns {string} Rendered HTML string with normalized whitespace.
-     */
-    static render(filePath) {
-        if (!fs.existsSync(filePath)) {
-            throw new Error(`Template file not found: ${filePath}`);
-        }
-
-        let output = '';
-        const templateContent = fs.readFileSync(filePath, 'utf-8');
-
-        // Transform <@ ... @/> blocks into print() calls
-        const transformedTemplate = templateContent.replace(
-            /<@>([\s\S]*?)<@\/>/g,
-            (_, content) => `print(\`${content.replace(/{{\s*(.*?)\s*}}/g, '${$1}')}\`);`
-        );
-
-        // Wrap the script in an IIFE
-        const wrappedScript = `
-        (() => {
-            const print = (html) => output += html;
-            ${transformedTemplate}
-            return output;
-        })();
-        `;
-
-        // Create a custom require function that resolves paths relative to the template
-        const customRequire = (modulePath) => {
-            const absolutePath = path.resolve(path.dirname(filePath), modulePath);
-            return require(absolutePath);
-        };
-
-        // Execute the script in a sandbox
-        const script = new vm.Script(wrappedScript);
-        const sandbox = {
-            output: '',
-            require: customRequire, // Add custom require
-            __dirname: path.dirname(filePath),
-            __filename: filePath,
-        };
-        vm.createContext(sandbox);
-
-        // Get the rendered output
-        let result = script.runInContext(sandbox);
-
-        // Normalize spaces but preserve those in content
-        result = result
-            .replace(/>\s+</g, '><')       // Remove spaces between tags
-            .replace(/\s+/g, ' ')         // Collapse multiple spaces to one
-            .replace(/>\s+/g, '>')        // Remove spaces after tags
-            .replace(/\s+</g, '<')        // Remove spaces before tags
-            .trim();                      // Trim leading and trailing spaces
-
-        return result;
-    }
-}
-
-module.exports = HtmxRenderer;
+const fs = require('fs');
+const vm = require('vm');
+const path = require('path');
+
+class HtmxRenderer {
+    /**
+     * Render an .htmx file as JavaScript with embedded print statements.
+     * @param {string} filePath - Path to the .htmx file.
+     * @returns {string} Rendered HTML string with normalized whitespace.
+     */
+    static render(filePath) {
+        if (!fs.existsSync(filePath)) {
+            throw new Error(`Template file not found: ${filePath}`);
+        }
+
+        let output = '';
+        const templateContent = fs.readFileSync(filePath, 'utf-8');
+
+        // Transform <@ ... @/> blocks into print() calls
+        const transformedTemplate = templateContent.replace(
+            /<@>([\s\S]*?)<@\/>/g,
+            (_, content) => `print(\`${content.replace(/{{\s*(.*?)\s*}}/g, '${$1}')}\`);`
+        );
+
+        // Wrap the script in an IIFE
+        const wrappedScript = `
+        (() => {
+            const print = (html) => output += html;
+            ${transformedTemplate}
+            return output;
+        })();
+        `;
+
+        // Create a custom require function that resolves paths relative to the template
+        const customRequire = (modulePath) => {
+            const absolutePath = path.resolve(path.dirname(filePath), modulePath);
+            return require(absolutePath);
+        };
+
+        // Execute the script in a sandbox
+        const script = new vm.Script(wrappedScript);
+        const sandbox = {
+            output: '',
+            require: customRequire, // Add custom require
+            __dirname: path.dirname(filePath),
+            __filename: filePath,
+        };
+        vm.createContext(sandbox);
+
+        // Get the rendered output
+        let result = script.runInContext(sandbox);
+
+        // Normalize spaces but preserve those in content
+        result = result
+            .replace(/>\s+</g, '><')       // Remove spaces between tags
+            .replace(/\s+/g, ' ')         // Collapse multiple spaces to one
+            .replace(/>\s+/g, '>')        // Remove spaces after tags
+            .replace(/\s+</g, '<')        // Remove spaces before tags
+            .trim();                      // Trim leading and trailing spaces
+
+        return result;
+    }
+}
+
+module.exports = HtmxRenderer;

package/src/htmx/RedWebHtmxComponent.js

@@ -1,11 +1,11 @@
-class RedWebHtmxComponent {
-    constructor(props = {}) {
-        this.props = props;
-    }
-
-    render() {
-        throw new Error('Render method must be implemented in derived components');
-    }
-}
-
-module.exports = RedWebHtmxComponent;
+class RedWebHtmxComponent {
+    constructor(props = {}) {
+        this.props = props;
+    }
+
+    render() {
+        throw new Error('Render method must be implemented in derived components');
+    }
+}
+
+module.exports = RedWebHtmxComponent;