\r\n\r\n# Lazy Toolbox - Server\r\n\r\n> A NodeJS toolbox made for a lazy development on server part.\r\n\r\nFind the full project on [GitHub - Lazy Toolbox](https://github.com/FriquetLuca/lazy-toolbox).\r\n\r\nMade to setup a server as fast as possible, the lazy toolbox is made so you have as few as possible to write to get things done.\r\n\n## Index\r\n\r\n- [Installation (NPM)](#install-npm)\r\n- [Updates](#updates)\r\n- [Documentation](#documentation)\n\t- [Server](#server)\r\n\t - [LazyClientSocket](#lazyClientSocket)\r\n\t - [LazyEncapProcess](#lazyEncapProcess)\r\n\t - [LazyFS](#lazyFS)\r\n\t - [LazyModLoader](#lazyModLoader)\r\n\t - [LazyNetList](#lazyNetList)\r\n\t - [LazyRouter](#lazyRouter)\r\n\t - [LazySocket](#lazySocket)\r\n\t - [LazyWatcher](#lazyWatcher)\n\n## [Installation (NPM)](#install-npm)\r\n\r\nThe installation is pretty straight forward:\r\n```terminal\r\nnpm i lazy-toolbox\r\n```\r\n\n## [Updates](#updates)\r\n\r\n### v1.4.12 - TS Loader\r\n\r\nNew modifications were introduced:\r\n- Changes the behaviour of `LazyModLoader` by adding a `extensions` property on the constructor to override the default supported extensions. By default it's now `.js`, `.ts`, `.mjs` and `.mts` (previously it was `.js` and `.mjs`).\r\n\r\n### v1.4.11 - Route lazier\r\n\r\nNew content were added:\r\n- Add `contentType` static method in `LazyRouter`.\r\n\r\nNew modifications were introduced:\r\n- Implement a Fastify type for `LazyRouter`, making it no longer `any` type.\r\n\r\n### v1.4.10 - Session\r\n\r\nNew content were added:\r\n- Add `initializeSession` method in `LazyRouter`.\r\n\r\n### v1.4.9 - Loading views on routes\r\n\r\nNew content were added:\r\n- Add `reloadViews` in `LazyRouter`.\r\n- Add `view` in `LazyRouter`.\r\n\r\nNew modifications were introduced:\r\n- Changed parameters of all routes to `(route: string, fastify: any, router: LazyRouter)` so the routes can access the router directly instead of being blind.\r\n\r\n### v1.4.6 - Socket deeper\r\n\r\nNew content were added:\r\n- Add `noError` method in `LazySocket`.\r\n\r\nNew modifications were introduced:\r\n- Changed `LazyClient` interface to `LazyClientSocket` class for a more robust client handling.\r\n- Handle unexpected client disconnection.\r\n\r\n### v1.4.1 - Lazy release\r\n\r\nStable version.\r\n\r\nNew modifications were introduced:\r\n- Add `clientID` in parameters for `onMessages`, `onConnect` and `onDisconnect` modules.\r\n\r\n\r\n### v1.3.9 - LazySocket Sharing\r\n\r\nNew content were added:\r\n- Add `getData`, `setData` and `deleteData` methods to `LazySocket`.\r\n- Add `process` property to `LazyEncapProcess`.\r\n- Add optional `inject` argument to `start` method in `LazyEncapProcess`.\r\n\r\nNew modifications were introduced:\r\n- Change the `LazyEncapProcess`'s constructor.\r\n- Change `client` parameters of type `Websocket.Websocket` to `clientID` of type `number` in disconnect socket module for `LazySocket` since the socket doesn't exist anymore at disconnect.\r\n\r\nNew patches were introduced:\r\n- Patch `clientCount` method from `LazySocket` to make it faster.\r\n- Patch eternal `created` event on `FileWatcher`.\r\n\r\n### v1.3.0 - Project repack\r\n\r\nFull project repack.\r\nDeprecated all previous versions support, getting rid of all previous known bugs.\r\n\n\n## [Documentation](#documentation)\r\n\r\nThis part explain all tools with examples if it's needed.\r\n\n### [Server](#server)\n#### [LazyClientSocket](#lazyClientSocket)\r\n```ts\r\nclass LazyClientSocket {\r\n get IsReconnected(): boolean;\r\n get ID(): number;\r\n get IP(): string;\r\n get Socket(): WebSocket.WebSocket;\r\n setNewSocket(socket: WebSocket.WebSocket): void;\r\n setData(label: string, data: any): void;\r\n getData(label: string): any;\r\n removeData(label: string): void;\r\n}\r\n```\r\n\r\nOffer a way to handle a client for a `LazySocket`.\r\n\r\nExample:\r\n```js\r\n// Executed whenever a client connect to the server.\r\nmodule.exports = (server, client, db) => {\r\n client.setData('myData', 125);\r\n console.log(client.getData('myData'));\r\n client.removeData('myData');\r\n};\r\n```\n#### [LazyEncapProcess](#lazyEncapProcess)\r\n```ts\r\nclass LazyEncapProcess {\r\n get process();\r\n constructor(root: string, processPath: string, nodeType: string | string[] = 'node', logInfo: boolean = true, showDates: boolean = true);\r\n async start(inject?: (process: any) => Promise): Promise;\r\n async stop(): Promise;\r\n}\r\n```\r\n\r\nA lazy way to encapsulate a node process.\r\n\r\nExample:\r\n\r\n```js\r\nconst { LazyEncapProcess } = require('lazy-toolbox');\r\n// Create a node process with the script `server.js`.\r\n// By default, we get back on the console everything that happened on this node.\r\nconst newNodeProcess = new LazyEncapProcess(__dirname, 'server.js');\r\n// Run the script in the background.\r\nnewNodeProcess.start();\r\n```\r\n\n#### [LazyFS](#lazyFS)\r\n```ts\r\nclass LazyFS {\r\n static getAllInDir(p: string, a: string[] = []): string[];\r\n static getAllFilesInDir(p: string): string[];\r\n static getAllDirsInDir(p: string): string[];\r\n static deleteDirectory(directoryPath: string): void;\r\n static delete(anyPath: string): void;\r\n static async readFile(filePath: string, options?: { encoding?: null | undefined; flag?: string | undefined; } | null | undefined): Promise;\r\n}\r\n```\r\n\r\nA lazy file stream for some lazy recursive functions.\r\n\r\nExample:\r\n\r\n`File explorer`:\r\n```fileExplorer\r\n- Root\r\n - FolderA\r\n - FolderC\r\n - script.js\r\n - FolderB\r\n - file.exe\r\n```\r\n`main.js`:\r\n```js\r\nconst { LazyFS } = require('lazy-toolbox');\r\n// Get everything inside a directory\r\nconst everything = LazyFS.getAllInDir(__dirname);\r\n/* Result:\r\nC:\\Somewhere\\...\\Root\\FolderA\r\nC:\\Somewhere\\...\\Root\\FolderA\\FolderC\r\nC:\\Somewhere\\...\\Root\\FolderA\\script.js\r\nC:\\Somewhere\\...\\Root\\FolderB\r\nC:\\Somewhere\\...\\Root\\file.exe\r\n*/\r\nfor(let path of everything) {\r\n console.log(path);\r\n}\r\n// Get all files inside a directory\r\nconst files = LazyFS.getAllFilesInDir(__dirname);\r\n/* Result:\r\nC:\\Somewhere\\...\\Root\\FolderA\\script.js\r\nC:\\Somewhere\\...\\Root\\file.exe\r\n*/\r\nfor(let path of files) {\r\n console.log(path);\r\n}\r\n// Get all directories inside a directory\r\nconst directories = LazyFS.getAllFilesInDir(__dirname);\r\n/* Result:\r\nC:\\Somewhere\\...\\Root\\FolderA\r\nC:\\Somewhere\\...\\Root\\FolderA\\FolderC\r\nC:\\Somewhere\\...\\Root\\FolderB\r\n*/\r\nfor(let path of directories) {\r\n console.log(path);\r\n}\r\n// Delete the current directory, it's files and all it's sub-directories and sub-files.\r\nLazyFS.deleteDirectory(__dirname);\r\n// LazyFS.delete has the same behaviour as LazyFS.deleteDirectory\r\n// except that LazyFS.delete don't care if it's a file or a directory it\r\n// needs to remove.\r\n```\r\n\n#### [LazyModLoader](#lazyModLoader)\r\n\r\n```ts\r\nclass LazyModLoader {\r\n constructor(root: string, moduleFolder: string = \"./\", ...extensions: string[]);\r\n load(): {[filePath: string]: any};\r\n static isClass(v: any): boolean;\r\n static isFunction(v: any): boolean;\r\n static isArray(v: any): boolean;\r\n static isObject(v: any): boolean;\r\n static isScalar(v: any): boolean;\r\n}\r\n```\r\n\r\nA module loader to load modules inside a directory.\r\nIt loads all `.js` files. and `.mjs` files as modules.\r\n\r\nExample:\r\n\r\n`myModule.js`:\r\n```js\r\nmodule.exports = (name) => {\r\n console.log(`Hello ${name}.`);\r\n};\r\n```\r\n`subMod/mySubModule.js`:\r\n```js\r\nclass MyClass {\r\n constructor(name) {\r\n this.name = name;\r\n this.hello();\r\n }\r\n hello() {\r\n console.log(`Hello ${this.name}.`);\r\n }\r\n}\r\nmodule.exports = MyClass;\r\n```\r\n`main.js`:\r\n```js\r\nconst { LazyModLoader } = require('lazy-toolbox');\r\n// Create a module loader.\r\nconst modLoader = new LazyModLoader(__dirname, './');\r\n// Load all modules\r\nconst loadedMods = modLoader.load();\r\n// Get all modules relative path without the extension\r\nfor(let loadedMod in loadedMods) {\r\n // Get the actual module\r\n const actualLoadedMod = loadedMods[loadedMod];\r\n // Check if the module is a class\r\n if(LazyModLoader.isClass(actualLoadedMod)) {\r\n // Do something with the class\r\n const newMod = new actualLoadedMod('test');\r\n }\r\n // Check if the module is a function\r\n else if(LazyModLoader.isFunction(actualLoadedMod)) {\r\n // Do something with the function\r\n actualLoadedMod('test');\r\n }\r\n}\r\n```\n#### [LazyNetList](#lazyNetList)\r\n```ts\r\nclass LazyNetList {\r\n static internalIPv4(): string[];\r\n static externalIPv4(): string[];\r\n static IPv4(): string[];\r\n}\r\n```\r\n\r\nA lazy way to access some network interfaces.\r\n\r\nExample:\r\n\r\n```js\r\nconst { LazyNetList } = require('lazy-toolbox');\r\n// Get all IP v4 inside an array\r\nconst IPs = LazyNetList.IPv4();\r\n// Get all internal IP v4 inside an array\r\nconst iIPs = LazyNetList.internalIPv4();\r\n// Get all external IP v4 inside an array\r\nconst eIPs = LazyNetList.externalIPv4();\r\n```\r\n\n#### [LazyRouter](#lazyRouter)\r\n```ts\r\nclass LazyRouter {\r\n // Last update at version: 1.1.2\r\n constructor(host: string, port: number, root: string, assetDir: string, db: any = undefined);\r\n // New on version: 1.4.7\r\n get Views(): { [filePath: string]: string; };\r\n // New on version: 1.4.7\r\n get DB(): any;Promise\r\n start(): void;\r\n // New on version: 1.1.2\r\n setDB(db: any): void;\r\n // New on version: 1.4.2\r\n getFastify(): any;\r\n // New on version: 1.4.7\r\n view(provided: {viewPath:string, request:any, reply:any, datas?: {[propertyName: string]: string}, templates?: {[name: string]: {(i: number, count: number): {[label: string]: string}}} }, reloadRoutes: boolean = false): string;\r\n async loadAssets(): Promise;\r\n // Last update at version: 1.1.1\r\n async registerPaths(routesFolder: string): Promise;\r\n // New on version: 1.1.1\r\n async loadStaticRoutes(route: string, staticDirectory: string): \r\n // New on version: 1.4.7\r\n async reloadViews(): Promise;\r\n // New on version: 1.4.10\r\n async initializeSession(secretKey: string = 'a secret with minimum length of 32 characters', isSecure: boolean = false, expirationTime: number = 24 * 60 * 1000): Promise;\r\n // New on version: 1.4.11\r\n static contentType(content: string = 'html'): string;\r\n}\r\n```\r\n\r\nA lazy routing setup for lazy people based on `fastify` and `@fastify/static`.\r\n\r\nExample:\r\n\r\n`File explorer`:\r\n```fileExplorer\r\n- Root\r\n - public\r\n - assets\r\n - img.png\r\n - views\r\n - index.html\r\n - dummy.html\r\n - routes\r\n - customRoute.js\r\n - app.js\r\n```\r\n`app.js`:\r\n```js\r\nconst path = require('path');\r\nconst { LazyRouter } = require('lazy-toolbox');\r\n// A little setup to make it async while loading all ours things.\r\nconst setupRouter = async () => {\r\n // Set a new router on the localhost, listening on port 3000.\r\n // The assets directory will be the static asset directory of the server.\r\n const newRouter = new LazyRouter('localhost', 3000, __dirname, './public/assets');\r\n // Load all assets static routes.\r\n // Note: The route name will always be ./assets/ on the server side.\r\n // localhost:3000/assets/\r\n // It's the equivalent of :\r\n // await this.loadStaticRoutes('/assets/', './public/assets');\r\n await newRouter.loadAssets();\r\n // Initialize the session for users.\r\n // Default value aren't that good, you should think about\r\n // setting it up a bit.\r\n await newRouter.initializeSession();\r\n // Load all custom routes modules inside the routes folder\r\n await newRouter.registerPaths('./routes', '../public/views');\r\n // Registered routes:\r\n // localhost:3000/assets/img.png\r\n // localhost:3000/customRoute\r\n newRouter.start();\r\n}\r\n// Let's just run this.\r\nsetupRouter();\r\n```\r\n`routes/customRoute.js`:\r\n```js\r\nconst { LazyRouter } = require('lazy-toolbox');\r\n// Get the folder relative path as route\r\nmodule.exports = (route, fastify, router) => {\r\n // A simple implementation for lazyness incarned.\r\n fastify.get(route, async (request, reply) => {\r\n const dummyUsers = [\r\n { name: \"John\", age: 28 },\r\n { name: \"Elena\", age: 31 },\r\n { name: \"Arthur\", age: 66 },\r\n { name: \"Sophie\", age: 17 },\r\n { name: \"Peter\", age: 19 }\r\n ];\r\n // The config of the view\r\n const config = {\r\n viewPath: 'index', // public/views/index.html\r\n request: request,\r\n reply: reply,\r\n // Some datas to inject, isn't mendatory\r\n datas: {\r\n 'replaceUseless': 'My awesome title.'\r\n },\r\n // A template to make\r\n templates: {\r\n 'feedDiv': (i) => {\r\n const user = dummyUsers[i];\r\n return {\r\n 'username': user.name,\r\n 'age': user.age\r\n };\r\n }\r\n }\r\n };\r\n // Load the view\r\n const currentView = router.view(config);\r\n // Just send the document\r\n return reply.type(LazyRouter.contentType('html')).send(currentView);\r\n });\r\n}\r\n```\r\n`public/views/index.html`:\r\n```html\r\n\r\n \r\n \r\n \r\n \r\n Dummy page\r\n \r\n \r\n
\r\n```\n#### [LazySocket](#lazySocket)\r\n```ts\r\ninterface FolderMods {\r\n onConnect: string;\r\n onMessages: string;\r\n onDisconnect: string;\r\n}\r\nclass LazySocket {\r\n constructor(port: number, root: string, paths: FolderMods = { onConnect:'./onConnect', onMessages: './onMessages', onDisconnect: './onDisconnect' }, logInfo: boolean = true, showDates: boolean = true, db: any = undefined);\r\n connect(): void;\r\n noError(): void;\r\n sendToAll(packet: string, data: any): void;\r\n sendToAllExceptSender(packet: string, socket: WebSocket.WebSocket, data: any): void;\r\n clientCount(): number;\r\n getClient(socket: WebSocket.WebSocket): LazyClientSocket;\r\n getServer(): WebSocket.Server;\r\n setDB(db: any): void;\r\n getData(label: string): any;\r\n setData(label: string, data: any): void;\r\n deleteData(label: string): void;\r\n static sendToClient(packet: string, socket: WebSocket.WebSocket, data: any): void;\r\n static closeClient(socket: WebSocket.WebSocket): void;\r\n}\r\n```\r\n\r\nA lazy socket implementation to handle websocket.\r\nAll the logic lies inside three folders that you can choose.\r\nFunctions are gonna be executed depending on the packet name given by a `LazyClientSocket`.\r\n\r\nExample:\r\n\r\n`File explorer`:\r\n```fileExplorer\r\n- Root\r\n - onConnect\r\n - connect.js\r\n - onMessages\r\n - test_msg.js\r\n - onDisconnect\r\n - disconnect.js\r\n - app.js\r\n```\r\n`app.js`\r\n```js\r\nconst { LazySocket } = require('lazy-toolbox');\r\n// Create a websocket on port 6060\r\nconst socketServer = new LazySocket(6060, __dirname);\r\n// Start all connections\r\nsocketServer.connect();\r\n```\r\n`onConnect/connect.js`\r\n```js\r\n// Executed whenever a client connect to the server.\r\nmodule.exports = (server, client, db) => {\r\n /*\r\n server: LazySocket\r\n client: LazyClientSocket\r\n db: any\r\n */\r\n // Do something when a client connect to the server.\r\n};\r\n```\r\n`onMessages/test_msg.js`\r\n```js\r\n// This packet name is: test_msg\r\n// If it was inside a folder called myFolder, then the\r\n// packet would be called: myFolder/test_msg\r\nmodule.exports = (server, client, data, db) => {\r\n /*\r\n server: LazySocket\r\n client: LazyClientSocket\r\n data: any\r\n db: any\r\n */\r\n // Send a packet from the server to all clients.\r\n server.sendToAll('message_for_all', {\r\n author: data.author,\r\n msg: data.msg\r\n });\r\n};\r\n```\r\n`onDisconnect/disconnect.js`\r\n```js\r\n// Executed whenever a client disconnect from the server.\r\nmodule.exports = (server, client, db) => {\r\n /*\r\n server: LazySocket\r\n client: LazyClientSocket\r\n db: any\r\n */\r\n // Do something if a client disconnect from the server.\r\n};\r\n```\n#### [LazyWatcher](#lazyWatcher)\r\n```ts\r\ninterface FileEvent {\r\n file: string;\r\n eventType: string;\r\n}\r\nclass LazyWatcher {\r\n constructor(root: string, timeout: number = 200, excludePaths: string[] = [], excludeEventTypes: string[] = []);\r\n checkFileChanges(): FileEvent[];\r\n async watchFiles(fn: (events: FileEvent[]) => Promise): Promise;\r\n stop(): void;\r\n skipChanges(): void;\r\n}\r\n```\r\n\r\nA lazy watcher that will watch files by not relying on `fs.watch` instability but instead on a timeout approach.\r\n\r\nExample:\r\n\r\n`manualWatcher.js`:\r\n```js\r\nconst { LazyWatcher } = require('lazy-toolbox');\r\n// Create a watcher, watching our directory\r\nconst newWatcher = new LazyWatcher(__dirname);\r\n// Set a timeout to check any changes in the next minute.\r\nsetTimeout(() => {\r\n // Check every changes\r\n const changes = newWatcher.checkFileChanges();\r\n for(let changeEvent of changes) {\r\n console.log(`Event ${changeEvent.eventType} occured on: ${changeEvent.file}`);\r\n }\r\n}, 60000); // Check changes after a minutes.\r\n```\r\n`timeoutWatcher.js`:\r\n```js\r\nconst { LazyWatcher } = require('lazy-toolbox');\r\n// Create a watcher, watching our directory with a timeout of 10s.\r\nconst newWatcher = new LazyWatcher(__dirname, 10000);\r\n// Create a counter, just to show a use case of stop function\r\nlet i = 0;\r\n// It will trigger every event that occured the next 10s, then it will wait again until it need to check for changes.\r\nnewWatcher.watchFiles(async (changes) => {\r\n if(i >= 10) {\r\n // Stop the watcher.\r\n newWatcher.stop();\r\n }\r\n // Show all events:\r\n for(let changeEvent of changes) {\r\n console.log(`Event ${changeEvent.eventType} occured on: ${changeEvent.file}`);\r\n }\r\n i++;\r\n // If you created some files in this function, it would have been useful to use\r\n // newWatcher.skipChanges();\r\n // So the watcher would just skip all your newly made files or modifications\r\n // for the next watch.\r\n});\r\n```\r\n\n\n","readmeFilename":"README.md","homepage":"https://github.com/FriquetLuca/lazy-toolbox","keywords":["lazy","toolbox","server","router","routes","network","networks","file","files","file-stream","fs","process","socket","sockets"],"bugs":{"url":"https://github.com/FriquetLuca/lazy-toolbox/issues"},"repository":{"type":"git","url":"git+https://github.com/FriquetLuca/lazy-toolbox.git"}}
![\"logo\"](\"/doc/img/logo.png\"){kind=logo}
\r ![](\"https://img.shields.io/badge/license-MIT-green\"){kind=icon}
![](\"https://img.shields.io/badge/typescript-v4.8.4-orange\"){kind=icon}
![](\"https://img.shields.io/badge/node-v14.21.0-yellow\"){kind=icon}
![](\"https://img.shields.io/badge/fastify-v4.9.2-lightblue\"){kind=icon}
![](\"https://img.shields.io/badge/ws-v8.10.0-blue\"){kind=icon}
![](\"https://img.shields.io/badge/node--html--parser-v6.1.4-red\"){kind=icon}