ioserver 1.4.2 → 2.0.1

package/dist/IOServerError.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @fileoverview IOServerError - Custom error class for IOServer framework
+ *
+ * Provides structured error handling with HTTP status codes and detailed messages.
+ * Extends the native Error class with additional properties for better debugging
+ * and API error responses.
+ *
+ * @author Ben Mz <0x42en@users.noreply.github.com>
+ * @version 2.0.0
+ * @since 1.0.0
+ */
+/**
+ * Custom error class for IOServer framework
+ *
+ * Provides structured error handling with HTTP-compatible status codes
+ * and consistent error formatting across the application.
+ *
+ * @class IOServerError
+ * @extends {Error}
+ *
+ * @example
+ * ```typescript
+ * // Basic error
+ * throw new IOServerError('User not found', 404);
+ *
+ * // Validation error
+ * throw new IOServerError('Invalid email format', 400);
+ *
+ * // Server error
+ * throw new IOServerError('Database connection failed', 500);
+ *
+ * // Using in service
+ * class UserService extends BaseService {
+ *   async getUser(socket: any, data: any, callback?: Function) {
+ *     if (!data.userId) {
+ *       throw new IOServerError('User ID is required', 400);
+ *     }
+ *
+ *     const user = await this.appHandle.database.findUser(data.userId);
+ *     if (!user) {
+ *       throw new IOServerError('User not found', 404);
+ *     }
+ *
+ *     if (callback) callback(user);
+ *   }
+ * }
+ * ```
+ */
+export declare class IOServerError extends Error {
+    /**
+     * HTTP status code associated with this error
+     * @type {number}
+     */
+    statusCode: number;
+    /**
+     * Creates a new IOServerError instance
+     * @param {string} message - Error message describing what went wrong
+     * @param {number} statusCode - HTTP status code (default: 500)
+     *
+     * @example
+     * ```typescript
+     * // Client error (4xx)
+     * throw new IOServerError('Invalid request parameters', 400);
+     *
+     * // Authentication error
+     * throw new IOServerError('Access token expired', 401);
+     *
+     * // Authorization error
+     * throw new IOServerError('Insufficient permissions', 403);
+     *
+     * // Not found error
+     * throw new IOServerError('Resource not found', 404);
+     *
+     * // Server error (5xx)
+     * throw new IOServerError('Internal server error', 500);
+     * ```
+     */
+    constructor(message: string, statusCode?: number);
+}
+//# sourceMappingURL=IOServerError.d.ts.map

package/dist/IOServerError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOServerError.d.ts","sourceRoot":"","sources":["../src/IOServerError.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,aAAc,SAAQ,KAAK;IACtC;;;OAGG;IACI,UAAU,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBACS,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,MAAY;CAQtD"}

package/dist/IOServerError.js

@@ -0,0 +1,85 @@
+"use strict";
+/**
+ * @fileoverview IOServerError - Custom error class for IOServer framework
+ *
+ * Provides structured error handling with HTTP status codes and detailed messages.
+ * Extends the native Error class with additional properties for better debugging
+ * and API error responses.
+ *
+ * @author Ben Mz <0x42en@users.noreply.github.com>
+ * @version 2.0.0
+ * @since 1.0.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IOServerError = void 0;
+/**
+ * Custom error class for IOServer framework
+ *
+ * Provides structured error handling with HTTP-compatible status codes
+ * and consistent error formatting across the application.
+ *
+ * @class IOServerError
+ * @extends {Error}
+ *
+ * @example
+ * ```typescript
+ * // Basic error
+ * throw new IOServerError('User not found', 404);
+ *
+ * // Validation error
+ * throw new IOServerError('Invalid email format', 400);
+ *
+ * // Server error
+ * throw new IOServerError('Database connection failed', 500);
+ *
+ * // Using in service
+ * class UserService extends BaseService {
+ *   async getUser(socket: any, data: any, callback?: Function) {
+ *     if (!data.userId) {
+ *       throw new IOServerError('User ID is required', 400);
+ *     }
+ *
+ *     const user = await this.appHandle.database.findUser(data.userId);
+ *     if (!user) {
+ *       throw new IOServerError('User not found', 404);
+ *     }
+ *
+ *     if (callback) callback(user);
+ *   }
+ * }
+ * ```
+ */
+class IOServerError extends Error {
+    /**
+     * Creates a new IOServerError instance
+     * @param {string} message - Error message describing what went wrong
+     * @param {number} statusCode - HTTP status code (default: 500)
+     *
+     * @example
+     * ```typescript
+     * // Client error (4xx)
+     * throw new IOServerError('Invalid request parameters', 400);
+     *
+     * // Authentication error
+     * throw new IOServerError('Access token expired', 401);
+     *
+     * // Authorization error
+     * throw new IOServerError('Insufficient permissions', 403);
+     *
+     * // Not found error
+     * throw new IOServerError('Resource not found', 404);
+     *
+     * // Server error (5xx)
+     * throw new IOServerError('Internal server error', 500);
+     * ```
+     */
+    constructor(message, statusCode = 500) {
+        super(message);
+        this.name = 'IOServerError';
+        this.statusCode = statusCode;
+        // Ensure proper prototype chain for instanceof checks
+        Object.setPrototypeOf(this, IOServerError.prototype);
+    }
+}
+exports.IOServerError = IOServerError;
+//# sourceMappingURL=IOServerError.js.map

package/dist/IOServerError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IOServerError.js","sourceRoot":"","sources":["../src/IOServerError.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAa,aAAc,SAAQ,KAAK;IAOtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,YAAY,OAAe,EAAE,aAAqB,GAAG;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,sDAAsD;QACtD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;CACF;AAtCD,sCAsCC"}

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview IOServer Framework - TypeScript Socket.IO Server Framework
+ *
+ * A comprehensive framework for building real-time applications with TypeScript,
+ * combining Fastify HTTP server with Socket.IO WebSocket support.
+ *
+ * Features:
+ * - Modular architecture with Services, Controllers, Managers, and Watchers
+ * - Type-safe development with full TypeScript support
+ * - Built-in error handling and logging
+ * - Middleware support for HTTP and WebSocket routes
+ * - Production-ready with security best practices
+ *
+ * @author Ben Mz <0x42en@users.noreply.github.com>
+ * @version 2.0.0
+ * @since 1.0.0
+ *
+ * @example
+ * ```typescript
+ * import { IOServer, BaseService } from 'ioserver';
+ *
+ * class ChatService extends BaseService {
+ *   async sendMessage(socket: any, data: any, callback?: Function) {
+ *     socket.broadcast.emit('new_message', data);
+ *     if (callback) callback({ status: 'sent' });
+ *   }
+ * }
+ *
+ * const server = new IOServer({ port: 3000 });
+ * server.addService({ service: ChatService });
+ * await server.start();
+ * ```
+ */
+export { IOServer as default, IOServer } from './IOServer';
+export { IOServerError } from './IOServerError';
+export { BaseService, BaseController, BaseManager, BaseWatcher, BaseMiddleware, } from './BaseClasses';
+export type { IOServerOptions, ServiceOptions, ControllerOptions, ManagerOptions, WatcherOptions, SendToOptions, AppHandle, LogLevel, TransportMode, } from './IOServer';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAGH,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,WAAW,EACX,cAAc,GACf,MAAM,eAAe,CAAC;AAGvB,YAAY,EACV,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,aAAa,EACb,SAAS,EACT,QAAQ,EACR,aAAa,GACd,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * @fileoverview IOServer Framework - TypeScript Socket.IO Server Framework
+ *
+ * A comprehensive framework for building real-time applications with TypeScript,
+ * combining Fastify HTTP server with Socket.IO WebSocket support.
+ *
+ * Features:
+ * - Modular architecture with Services, Controllers, Managers, and Watchers
+ * - Type-safe development with full TypeScript support
+ * - Built-in error handling and logging
+ * - Middleware support for HTTP and WebSocket routes
+ * - Production-ready with security best practices
+ *
+ * @author Ben Mz <0x42en@users.noreply.github.com>
+ * @version 2.0.0
+ * @since 1.0.0
+ *
+ * @example
+ * ```typescript
+ * import { IOServer, BaseService } from 'ioserver';
+ *
+ * class ChatService extends BaseService {
+ *   async sendMessage(socket: any, data: any, callback?: Function) {
+ *     socket.broadcast.emit('new_message', data);
+ *     if (callback) callback({ status: 'sent' });
+ *   }
+ * }
+ *
+ * const server = new IOServer({ port: 3000 });
+ * server.addService({ service: ChatService });
+ * await server.start();
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseMiddleware = exports.BaseWatcher = exports.BaseManager = exports.BaseController = exports.BaseService = exports.IOServerError = exports.IOServer = exports.default = void 0;
+// Main framework exports
+var IOServer_1 = require("./IOServer");
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return IOServer_1.IOServer; } });
+Object.defineProperty(exports, "IOServer", { enumerable: true, get: function () { return IOServer_1.IOServer; } });
+var IOServerError_1 = require("./IOServerError");
+Object.defineProperty(exports, "IOServerError", { enumerable: true, get: function () { return IOServerError_1.IOServerError; } });
+// Base classes for extending
+var BaseClasses_1 = require("./BaseClasses");
+Object.defineProperty(exports, "BaseService", { enumerable: true, get: function () { return BaseClasses_1.BaseService; } });
+Object.defineProperty(exports, "BaseController", { enumerable: true, get: function () { return BaseClasses_1.BaseController; } });
+Object.defineProperty(exports, "BaseManager", { enumerable: true, get: function () { return BaseClasses_1.BaseManager; } });
+Object.defineProperty(exports, "BaseWatcher", { enumerable: true, get: function () { return BaseClasses_1.BaseWatcher; } });
+Object.defineProperty(exports, "BaseMiddleware", { enumerable: true, get: function () { return BaseClasses_1.BaseMiddleware; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;;;AAEH,yBAAyB;AACzB,uCAA2D;AAAlD,mGAAA,QAAQ,OAAW;AAAE,oGAAA,QAAQ,OAAA;AACtC,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AAEtB,6BAA6B;AAC7B,6CAMuB;AALrB,0GAAA,WAAW,OAAA;AACX,6GAAA,cAAc,OAAA;AACd,0GAAA,WAAW,OAAA;AACX,0GAAA,WAAW,OAAA;AACX,6GAAA,cAAc,OAAA"}

package/package.json

@@ -1,59 +1,78 @@
 {
   "name": "ioserver",
-  "version": "1.4.2",
-  "description": "Damn simple way to setup your Socket.io server using coffeescript or vanilla JS class.",
-  "main": "build/ioserver.js",
-  "files": [
-    "build/"
-  ],
-  "directories": {
-    "test": "test"
-  },
-  "dependencies": {
-    "@fastify/cors": "^8.2.0",
-    "@fastify/sensible": "^5.2.0",
-    "colors": "^1.4.0",
-    "fastify": "^4.13.0",
-    "fastify-socket.io": "^4.0.0",
-    "socket.io": "^4.6.0"
-  },
-  "devDependencies": {
-    "@snyk/protect": "^1.1105.0",
-    "chai": "^4.3.3",
-    "chai-http": "^4.3.0",
-    "coffeescript": "^2.7.0",
-    "mocha": "^10.2.0",
-    "socket.io-client": "^4.5.0"
-  },
-  "scripts": {
-    "prepare": "npm run snyk-protect",
-    "snyk-protect": "snyk-protect",
-    "dev": "$(npm bin)/coffee --no-header --map --watch --output build/ --compile src/",
-    "build": "$(npm bin)/coffee --no-header --map --output build/ --compile src/",
-    "test": "$(npm bin)/coffee --no-header -c ./test && mocha --exit",
-    "gpr-setup": "node scripts/gpr.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/x42en/IOServer.git"
-  },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org"
-  },
+  "version": "2.0.1",
+  "description": "Damn simple Fastify & Socket.io server framework with TypeScript support",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "keywords": [
     "socket.io",
-    "coffeescript",
-    "webservice",
-    "network",
-    "x42en",
-    "websockets"
+    "fastify",
+    "typescript",
+    "websocket",
+    "server",
+    "framework",
+    "real-time"
   ],
-  "author": "Ben Mz",
+  "author": "Ben Mz <0x42en@users.noreply.github.com>",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/x42en/IOServer.git"
+  },
   "bugs": {
     "url": "https://github.com/x42en/IOServer/issues"
   },
   "homepage": "https://github.com/x42en/IOServer#readme",
-  "optionalDependencies": {},
-  "snyk": true
-}
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@fastify/cors": "^10.1.0",
+    "@fastify/sensible": "^6.0.3",
+    "fastify": "^5.3.3",
+    "socket.io": "^4.8.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.28.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.15.30",
+    "@types/supertest": "^6.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.33.1",
+    "@typescript-eslint/parser": "^8.33.1",
+    "eslint": "^9.28.0",
+    "jest": "^29.7.0",
+    "socket.io-client": "^4.8.1",
+    "supertest": "^7.1.1",
+    "ts-jest": "^29.3.4",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.28.5",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "build:watch": "tsc --watch",
+    "dev": "ts-node",
+    "dev:chat": "ts-node examples/chat-app/app.ts",
+    "dev:simple": "ts-node examples/simple-example.ts",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:unit": "jest --testPathPattern=unit",
+    "test:integration": "jest --testPathPattern=integration",
+    "test:e2e": "jest --testPathPattern=e2e",
+    "test:performance": "jest --testPathPattern=performance",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "docs:build": "cd docs && make html",
+    "docs:api": "typedoc --options typedoc.json",
+    "docs:serve": "cd docs/build/html && python -m http.server 8000"
+  }
+}