npm - arkos - Versions diffs - 1.1.15-test → 1.1.16-test - Mend

arkos 1.1.15-test → 1.1.16-test

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/dist/cjs/proxy.js +1 -1
package/dist/cjs/server.js +1 -1
package/dist/cjs/server.js.map +1 -1
package/dist/cjs/types/arkos-config.js.map +1 -1
package/dist/es2020/server.js +1 -1
package/dist/es2020/server.js.map +1 -1
package/dist/es2020/types/arkos-config.js.map +1 -1
package/dist/types/types/arkos-config.d.ts +2 -0
package/package.json +1 -1

package/dist/cjs/proxy.js CHANGED Viewed

	@@ -1 +1 @@
1	- "use strict";var __createBinding=this&&this.__createBinding\|\|(Object.create?function(r,e,o,t){t===void 0&&(t=o);var n=Object.getOwnPropertyDescriptor(e,o);(!n\|\|("get"in n?!e.__esModule:n.writable\|\|n.configurable))&&(n={enumerable:!0,get:function(){return e[o]}}),Object.defineProperty(r,t,n)}:function(r,e,o,t){t===void 0&&(t=o),r[t]=e[o]}),__setModuleDefault=this&&this.__setModuleDefault\|\|(Object.create?function(r,e){Object.defineProperty(r,"default",{enumerable:!0,value:e})}:function(r,e){r.default=e}),__importStar=this&&this.__importStar\|\|function(){var r=function(e){return r=Object.getOwnPropertyNames\|\|function(o){var t=[];for(var n in o)Object.prototype.hasOwnProperty.call(o,n)&&(t[t.length]=n);return t},r(e)};return function(e){if(e&&e.__esModule)return e;var o={};if(e!=null)for(var t=r(e),n=0;n<t.length;n++)t[n]!=="default"&&__createBinding(o,e,t[n]);return __setModuleDefault(o,e),o}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.arkosProxy=void 0,exports.getCapturedConfig=getCapturedConfig;let capturedConfig=null;exports.arkosProxy={init:r=>(capturedConfig=r,Promise.resolve().then(()=>__importStar(require("../path/to/real/arkos"))).then(e=>e.initApp(r)))};function getCapturedConfig(){return capturedConfig}
1	+ "use strict";var __createBinding=this&&this.__createBinding\|\|(Object.create?function(r,e,i,t){t===void 0&&(t=i);var n=Object.getOwnPropertyDescriptor(e,i);(!n\|\|("get"in n?!e.__esModule:n.writable\|\|n.configurable))&&(n={enumerable:!0,get:function(){return e[i]}}),Object.defineProperty(r,t,n)}:function(r,e,i,t){t===void 0&&(t=i),r[t]=e[i]}),__setModuleDefault=this&&this.__setModuleDefault\|\|(Object.create?function(r,e){Object.defineProperty(r,"default",{enumerable:!0,value:e})}:function(r,e){r.default=e}),__importStar=this&&this.__importStar\|\|function(){var r=function(e){return r=Object.getOwnPropertyNames\|\|function(i){var t=[];for(var n in i)Object.prototype.hasOwnProperty.call(i,n)&&(t[t.length]=n);return t},r(e)};return function(e){if(e&&e.__esModule)return e;var i={};if(e!=null)for(var t=r(e),n=0;n<t.length;n++)t[n]!=="default"&&__createBinding(i,e,t[n]);return __setModuleDefault(i,e),i}}();Object.defineProperty(exports,"__esModule",{value:!0}),exports.arkosProxy=void 0,exports.getCapturedConfig=getCapturedConfig;let capturedConfig=null;exports.arkosProxy={init:r=>(capturedConfig=r,Promise.resolve().then(()=>__importStar(require("../path/to/real/arkos"))).then(e=>e.initApp(r)))};function getCapturedConfig(){return capturedConfig}

package/dist/cjs/server.js CHANGED Viewed

	@@ -1 +1 @@
1	- "use strict";var __importDefault=this&&this.__importDefault\|\|function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.server=void 0,exports.getArkosConfig=getArkosConfig,exports.getExpressApp=getExpressApp,exports.initApp=initApp;const app_1=require("./app"),deepmerge_helper_1=__importDefault(require("./utils/helpers/deepmerge.helper"));process.on("uncaughtException",e=>{console.error("UNCAUGHT EXCEPTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),process.exit(1)});let server,_app,_arkosConfig={welcomeMessage:"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com",port:Number(process.env.PORT)\|\|8e3,host:process.env.HOST\|\|"localhost",fileUpload:{baseUploadDir:"uploads",baseRoute:"/api/uploads"},available:!1};async function initApp(e={}){_arkosConfig.available=!0,_arkosConfig=(0,deepmerge_helper_1.default)(_arkosConfig,e);const o=_arkosConfig.port;return _app=await(0,app_1.bootstrap)(_arkosConfig),o&&(exports.server=server=_app.listen(o,_arkosConfig.host,()=>{})),_app}process.on("unhandledRejection",e=>{console.error("UNHANDLED REJECTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),server?.close(()=>{process.exit(1)})});function getArkosConfig(){return _arkosConfig}function getExpressApp(){return _app}
1	+ "use strict";var __importDefault=this&&this.__importDefault\|\|function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.server=void 0,exports.getArkosConfig=getArkosConfig,exports.getExpressApp=getExpressApp,exports.initApp=initApp;const app_1=require("./app"),deepmerge_helper_1=__importDefault(require("./utils/helpers/deepmerge.helper")),http_1=__importDefault(require("http"));process.on("uncaughtException",e=>{console.error("UNCAUGHT EXCEPTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),process.exit(1)});let server,_app,_arkosConfig={welcomeMessage:"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com",port:Number(process.env.PORT)\|\|8e3,host:process.env.HOST\|\|"localhost",fileUpload:{baseUploadDir:"uploads",baseRoute:"/api/uploads"},available:!1};async function initApp(e={}){_arkosConfig.available=!0,_arkosConfig=(0,deepmerge_helper_1.default)(_arkosConfig,e);const r=_arkosConfig.port;return _app=await(0,app_1.bootstrap)(_arkosConfig),r&&(exports.server=server=http_1.default.createServer(_app),_arkosConfig?.configureServer&&await _arkosConfig.configureServer(server),server.listen(r,_arkosConfig.host,()=>{})),_app}process.on("unhandledRejection",e=>{console.error("UNHANDLED REJECTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),server?.close(()=>{process.exit(1)})});function getArkosConfig(){return _arkosConfig}function getExpressApp(){return _app}

package/dist/cjs/server.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":";;;;;;~~AA0EA~~,wCAEC;AAED,sCAEC;AAEgB,0BAAO;~~AA/ExB~~,+BAAkC;AAElC,wFAAyD;~~AAEzD~~,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;IACtC,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,MAA6D,CAAC;AAClE,IAAI,IAAa,CAAC;AAElB,IAAI,YAAY,GAA0C;IACxD,cAAc,EACZ,6FAA6F;IAC/F,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;IACtC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW;IACrC,UAAU,EAAE;QACV,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,cAAc;KAC1B;IACD,SAAS,EAAE,KAAK;CACjB,CAAC;AAeF,KAAK,UAAU,OAAO,CAAC,cAA2B,EAAE;IAClD,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;IAC9B,YAAY,GAAG,IAAA,0BAAS,EAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEpD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IAC/B,IAAI,GAAG,MAAM,IAAA,eAAS,EAAC,YAAY,CAAC,CAAC;IAErC,IAAI,IAAI;~~QACN~~,iBAAA,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,IAAK,EAAE,GAAG,EAAE;~~QAUpD~~,CAAC,CAAC,CAAC;~~IAEL~~,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAa,EAAE,EAAE;IACjD,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,cAAc;IAC5B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAgB,aAAa;IAC3B,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import { IncomingMessage, Server, ServerResponse } from \"http\";\nimport AppError from \"./modules/error-handler/utils/app-error\";\nimport { Express } from \"express\";\nimport { bootstrap } from \"./app\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\n\nprocess.on(\"uncaughtException\", (err) => {\n console.error(\"UNCAUGHT EXCEPTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n process.exit(1);\n});\n\nlet server: Server<typeof IncomingMessage, typeof ServerResponse>;\nlet _app: Express;\n\nlet _arkosConfig: ArkosConfig & { available?: boolean } = {\n welcomeMessage:\n \"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com\",\n port: Number(process.env.PORT) \|\| 8000,\n host: process.env.HOST \|\| \"localhost\",\n fileUpload: {\n baseUploadDir: \"uploads\",\n baseRoute: \"/api/uploads\",\n },\n available: false,\n};\n\n/*\n Initializes the application server.\n \n This function starts the server by listening on a specified port.\n * The port is determined by the following order of precedence:\n * 1. The `port` argument passed to the function.\n * 2. Defaults to `8000` if neither is provided.\n \n @param {ArkosConfig} arkosConfig - initial configs for the api ( authentication, port).\n * @returns {Promise<Express>} This function returns the Express App after all middlewares configurations.\n * You can prevent it from listen py passing port as undefined\n \n /\nasync function initApp(arkosConfig: ArkosConfig = {}): Promise<Express> {\n _arkosConfig.available = true;\n _arkosConfig = deepmerge(_arkosConfig, arkosConfig);\n\n const port = _arkosConfig.port;\n _app = await bootstrap(_arkosConfig);\n\n if (port)\n server = _app.listen(port, _arkosConfig.host!, () => {\n // const time = new Date().toTimeString().split(\" \")[0];\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m server waiting on http://localhost:${port}`\n // );\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m App running on port \\x1b[33m${port}\\x1b[0m, server waiting on http://localhost:${port}`\n // );\n // if (!!process.env.NODE_ENV)\n // console.info(`${`Environment: ${process.env.NODE_ENV}`}`);\n });\n\n return _app;\n}\n\nprocess.on(\"unhandledRejection\", (err: AppError) => {\n console.error(\"UNHANDLED REJECTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n server?.close(() => {\n process.exit(1);\n });\n});\n\nexport function getArkosConfig() {\n return _arkosConfig;\n}\n\nexport function getExpressApp() {\n return _app;\n}\n\nexport { server, initApp };\n"]}
1	+ {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":";;;;;;AAiFA,wCAEC;AAED,sCAEC;AAEgB,0BAAO;AAtFxB,+BAAkC;AAElC,wFAAyD;AACzD,gDAAwB;AAExB,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;IACtC,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,MAA6D,CAAC;AAClE,IAAI,IAAa,CAAC;AAElB,IAAI,YAAY,GAA0C;IACxD,cAAc,EACZ,6FAA6F;IAC/F,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;IACtC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW;IACrC,UAAU,EAAE;QACV,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,cAAc;KAC1B;IACD,SAAS,EAAE,KAAK;CACjB,CAAC;AAeF,KAAK,UAAU,OAAO,CAAC,cAA2B,EAAE;IAClD,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;IAC9B,YAAY,GAAG,IAAA,0BAAS,EAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEpD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IAC/B,IAAI,GAAG,MAAM,IAAA,eAAS,EAAC,YAAY,CAAC,CAAC;IAErC,IAAI,IAAI,EAAE,CAAC;QACT,iBAAA,MAAM,GAAG,cAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,YAAY,EAAE,eAAe;YAC/B,MAAM,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,IAAK,EAAE,GAAG,EAAE;QAU7C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAa,EAAE,EAAE;IACjD,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,cAAc;IAC5B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAgB,aAAa;IAC3B,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["import { IncomingMessage, Server, ServerResponse } from \"http\";\nimport AppError from \"./modules/error-handler/utils/app-error\";\nimport { Express } from \"express\";\nimport { bootstrap } from \"./app\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport http from \"http\";\n\nprocess.on(\"uncaughtException\", (err) => {\n console.error(\"UNCAUGHT EXCEPTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n process.exit(1);\n});\n\nlet server: Server<typeof IncomingMessage, typeof ServerResponse>;\nlet _app: Express;\n\nlet _arkosConfig: ArkosConfig & { available?: boolean } = {\n welcomeMessage:\n \"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com\",\n port: Number(process.env.PORT) \|\| 8000,\n host: process.env.HOST \|\| \"localhost\",\n fileUpload: {\n baseUploadDir: \"uploads\",\n baseRoute: \"/api/uploads\",\n },\n available: false,\n};\n\n/*\n Initializes the application server.\n \n This function starts the server by listening on a specified port.\n * The port is determined by the following order of precedence:\n * 1. The `port` argument passed to the function.\n * 2. Defaults to `8000` if neither is provided.\n \n @param {ArkosConfig} arkosConfig - initial configs for the api ( authentication, port).\n * @returns {Promise<Express>} This function returns the Express App after all middlewares configurations.\n * You can prevent it from listen py passing port as undefined\n \n /\nasync function initApp(arkosConfig: ArkosConfig = {}): Promise<Express> {\n _arkosConfig.available = true;\n _arkosConfig = deepmerge(_arkosConfig, arkosConfig);\n\n const port = _arkosConfig.port;\n _app = await bootstrap(_arkosConfig);\n\n if (port) {\n server = http.createServer(_app);\n\n if (_arkosConfig?.configureServer)\n await _arkosConfig.configureServer(server);\n\n server.listen(port, _arkosConfig.host!, () => {\n // const time = new Date().toTimeString().split(\" \")[0];\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m server waiting on http://localhost:${port}`\n // );\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m App running on port \\x1b[33m${port}\\x1b[0m, server waiting on http://localhost:${port}`\n // );\n // if (!!process.env.NODE_ENV)\n // console.info(`${`Environment: ${process.env.NODE_ENV}`}`);\n });\n }\n\n return _app;\n}\n\nprocess.on(\"unhandledRejection\", (err: AppError) => {\n console.error(\"UNHANDLED REJECTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n server?.close(() => {\n process.exit(1);\n });\n});\n\nexport function getArkosConfig() {\n return _arkosConfig;\n}\n\nexport function getExpressApp() {\n return _app;\n}\n\nexport { server, initApp };\n"]}

package/dist/cjs/types/arkos-config.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\n\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for pass prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```\n * GET /api\n * ```\n * ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com,\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n @deprecated\n \n Use this instead:\n \n ```ts\n * arkos.init({\n * authentication: {\n * login: {\n * allowedUsernames: [\"email\", \"profile.nickname\"]\n * }\n * }\n * })\n * ```\n \n * See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n /\n usernameField?: string;\n /*\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: RateLimitOptions;\n /\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?:\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n };\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"database-connection\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default database connection check middleware\n /\n databaseConnection?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-uploader\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints](https://www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file uploader router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUploader?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n */\n name?: string;\n };\n};\n"]}
1	+ {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\n\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for pass prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```\n * GET /api\n * ```\n * ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com,\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n @deprecated\n \n Use this instead:\n \n ```ts\n * arkos.init({\n * authentication: {\n * login: {\n * allowedUsernames: [\"email\", \"profile.nickname\"]\n * }\n * }\n * })\n * ```\n \n * See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n /\n usernameField?: string;\n /*\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: RateLimitOptions;\n /\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?:\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n };\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"database-connection\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default database connection check middleware\n /\n databaseConnection?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-uploader\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints](https://www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file uploader router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUploader?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Gives access to the underlying HTTP server so that you can add custom configurations beyond Arkos customization capabilities\n \n Note: In the end Arkos will call `server.listen` for you.\n \n If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n \n See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-http-server#calling-serverlisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-http-server#calling-serverlisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-http-server) for further details on the method configureServer.\n \n @param {http.Server} server - The HTTP server instance\n * @returns {any}\n /\n configureServer?: (server: http.Server) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n */\n name?: string;\n };\n};\n"]}

package/dist/es2020/server.js CHANGED Viewed

	@@ -1 +1 @@
1	- "use strict";import{bootstrap as n}from"./app";import a from"./utils/helpers/deepmerge.helper";process.on("uncaughtException",o=>{console.error("UNCAUGHT EXCEPTION! SHUTTING DOWN..."),console.error(o.name,o.message),console.error(o),process.exit(1)});let s,~~r,e~~={welcomeMessage:"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com",port:Number(process.env.PORT)\|\|8e3,host:process.env.HOST\|\|"localhost",fileUpload:{baseUploadDir:"uploads",baseRoute:"/api/uploads"},available:!1};async function p(o={}){e.available=!0,e=a(e,o);const t=e.port;return r=await n(e),t&&(s=r.listen(t,e.host,()=>{})),r}process.on("unhandledRejection",o=>{console.error("UNHANDLED REJECTION! SHUTTING DOWN..."),console.error(o.name,o.message),console.error(o),s?.close(()=>{process.exit(1)})});export function getArkosConfig(){return e}export function getExpressApp(){return r}export{s as server,p as initApp};
1	+ "use strict";import{bootstrap as n}from"./app";import a from"./utils/helpers/deepmerge.helper";import p from"http";process.on("uncaughtException",e=>{console.error("UNCAUGHT EXCEPTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),process.exit(1)});let r,s,o={welcomeMessage:"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com",port:Number(process.env.PORT)\|\|8e3,host:process.env.HOST\|\|"localhost",fileUpload:{baseUploadDir:"uploads",baseRoute:"/api/uploads"},available:!1};async function c(e={}){o.available=!0,o=a(o,e);const t=o.port;return s=await n(o),t&&(r=p.createServer(s),o?.configureServer&&await o.configureServer(r),r.listen(t,o.host,()=>{})),s}process.on("unhandledRejection",e=>{console.error("UNHANDLED REJECTION! SHUTTING DOWN..."),console.error(e.name,e.message),console.error(e),r?.close(()=>{process.exit(1)})});export function getArkosConfig(){return o}export function getExpressApp(){return s}export{r as server,c as initApp};

package/dist/es2020/server.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,SAAS,MAAM,kCAAkC,CAAC;~~AAEzD~~,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;IACtC,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,MAA6D,CAAC;AAClE,IAAI,IAAa,CAAC;AAElB,IAAI,YAAY,GAA0C;IACxD,cAAc,EACZ,6FAA6F;IAC/F,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;IACtC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW;IACrC,UAAU,EAAE;QACV,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,cAAc;KAC1B;IACD,SAAS,EAAE,KAAK;CACjB,CAAC;AAeF,KAAK,UAAU,OAAO,CAAC,cAA2B,EAAE;IAClD,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;IAC9B,YAAY,GAAG,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEpD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IAC/B,IAAI,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC;IAErC,IAAI,IAAI;~~QACN~~,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,IAAK,EAAE,GAAG,EAAE;~~QAUpD~~,CAAC,CAAC,CAAC;~~IAEL~~,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAa,EAAE,EAAE;IACjD,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,cAAc;IAC5B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC","sourcesContent":["import { IncomingMessage, Server, ServerResponse } from \"http\";\nimport AppError from \"./modules/error-handler/utils/app-error\";\nimport { Express } from \"express\";\nimport { bootstrap } from \"./app\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\n\nprocess.on(\"uncaughtException\", (err) => {\n console.error(\"UNCAUGHT EXCEPTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n process.exit(1);\n});\n\nlet server: Server<typeof IncomingMessage, typeof ServerResponse>;\nlet _app: Express;\n\nlet _arkosConfig: ArkosConfig & { available?: boolean } = {\n welcomeMessage:\n \"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com\",\n port: Number(process.env.PORT) \|\| 8000,\n host: process.env.HOST \|\| \"localhost\",\n fileUpload: {\n baseUploadDir: \"uploads\",\n baseRoute: \"/api/uploads\",\n },\n available: false,\n};\n\n/*\n Initializes the application server.\n \n This function starts the server by listening on a specified port.\n * The port is determined by the following order of precedence:\n * 1. The `port` argument passed to the function.\n * 2. Defaults to `8000` if neither is provided.\n \n @param {ArkosConfig} arkosConfig - initial configs for the api ( authentication, port).\n * @returns {Promise<Express>} This function returns the Express App after all middlewares configurations.\n * You can prevent it from listen py passing port as undefined\n \n /\nasync function initApp(arkosConfig: ArkosConfig = {}): Promise<Express> {\n _arkosConfig.available = true;\n _arkosConfig = deepmerge(_arkosConfig, arkosConfig);\n\n const port = _arkosConfig.port;\n _app = await bootstrap(_arkosConfig);\n\n if (port)\n server = _app.listen(port, _arkosConfig.host!, () => {\n // const time = new Date().toTimeString().split(\" \")[0];\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m server waiting on http://localhost:${port}`\n // );\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m App running on port \\x1b[33m${port}\\x1b[0m, server waiting on http://localhost:${port}`\n // );\n // if (!!process.env.NODE_ENV)\n // console.info(`${`Environment: ${process.env.NODE_ENV}`}`);\n });\n\n return _app;\n}\n\nprocess.on(\"unhandledRejection\", (err: AppError) => {\n console.error(\"UNHANDLED REJECTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n server?.close(() => {\n process.exit(1);\n });\n});\n\nexport function getArkosConfig() {\n return _arkosConfig;\n}\n\nexport function getExpressApp() {\n return _app;\n}\n\nexport { server, initApp };\n"]}
1	+ {"version":3,"file":"server.js","sourceRoot":"","sources":["../../src/server.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,SAAS,MAAM,kCAAkC,CAAC;AACzD,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;IACtC,OAAO,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAC;IACtD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC;AAEH,IAAI,MAA6D,CAAC;AAClE,IAAI,IAAa,CAAC;AAElB,IAAI,YAAY,GAA0C;IACxD,cAAc,EACZ,6FAA6F;IAC/F,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI;IACtC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,WAAW;IACrC,UAAU,EAAE;QACV,aAAa,EAAE,SAAS;QACxB,SAAS,EAAE,cAAc;KAC1B;IACD,SAAS,EAAE,KAAK;CACjB,CAAC;AAeF,KAAK,UAAU,OAAO,CAAC,cAA2B,EAAE;IAClD,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC;IAC9B,YAAY,GAAG,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAEpD,MAAM,IAAI,GAAG,YAAY,CAAC,IAAI,CAAC;IAC/B,IAAI,GAAG,MAAM,SAAS,CAAC,YAAY,CAAC,CAAC;IAErC,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAEjC,IAAI,YAAY,EAAE,eAAe;YAC/B,MAAM,YAAY,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE7C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,IAAK,EAAE,GAAG,EAAE;QAU7C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,GAAa,EAAE,EAAE;IACjD,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;IACvD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,UAAU,cAAc;IAC5B,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC","sourcesContent":["import { IncomingMessage, Server, ServerResponse } from \"http\";\nimport AppError from \"./modules/error-handler/utils/app-error\";\nimport { Express } from \"express\";\nimport { bootstrap } from \"./app\";\nimport { ArkosConfig } from \"./types/arkos-config\";\nimport deepmerge from \"./utils/helpers/deepmerge.helper\";\nimport http from \"http\";\n\nprocess.on(\"uncaughtException\", (err) => {\n console.error(\"UNCAUGHT EXCEPTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n process.exit(1);\n});\n\nlet server: Server<typeof IncomingMessage, typeof ServerResponse>;\nlet _app: Express;\n\nlet _arkosConfig: ArkosConfig & { available?: boolean } = {\n welcomeMessage:\n \"Welcome to our RESTful API generated by Arkos, find out more about Arkos at www.arkosjs.com\",\n port: Number(process.env.PORT) \|\| 8000,\n host: process.env.HOST \|\| \"localhost\",\n fileUpload: {\n baseUploadDir: \"uploads\",\n baseRoute: \"/api/uploads\",\n },\n available: false,\n};\n\n/*\n Initializes the application server.\n \n This function starts the server by listening on a specified port.\n * The port is determined by the following order of precedence:\n * 1. The `port` argument passed to the function.\n * 2. Defaults to `8000` if neither is provided.\n \n @param {ArkosConfig} arkosConfig - initial configs for the api ( authentication, port).\n * @returns {Promise<Express>} This function returns the Express App after all middlewares configurations.\n * You can prevent it from listen py passing port as undefined\n \n /\nasync function initApp(arkosConfig: ArkosConfig = {}): Promise<Express> {\n _arkosConfig.available = true;\n _arkosConfig = deepmerge(_arkosConfig, arkosConfig);\n\n const port = _arkosConfig.port;\n _app = await bootstrap(_arkosConfig);\n\n if (port) {\n server = http.createServer(_app);\n\n if (_arkosConfig?.configureServer)\n await _arkosConfig.configureServer(server);\n\n server.listen(port, _arkosConfig.host!, () => {\n // const time = new Date().toTimeString().split(\" \")[0];\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m server waiting on http://localhost:${port}`\n // );\n // console.info(\n // `[\\x1b[32mREADY\\x1b[0m] \\x1b[90m${time}\\x1b[0m App running on port \\x1b[33m${port}\\x1b[0m, server waiting on http://localhost:${port}`\n // );\n // if (!!process.env.NODE_ENV)\n // console.info(`${`Environment: ${process.env.NODE_ENV}`}`);\n });\n }\n\n return _app;\n}\n\nprocess.on(\"unhandledRejection\", (err: AppError) => {\n console.error(\"UNHANDLED REJECTION! SHUTTING DOWN...\");\n console.error(err.name, err.message);\n console.error(err);\n server?.close(() => {\n process.exit(1);\n });\n});\n\nexport function getArkosConfig() {\n return _arkosConfig;\n}\n\nexport function getExpressApp() {\n return _app;\n}\n\nexport { server, initApp };\n"]}

package/dist/es2020/types/arkos-config.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\n\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for pass prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```\n * GET /api\n * ```\n * ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com,\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n @deprecated\n \n Use this instead:\n \n ```ts\n * arkos.init({\n * authentication: {\n * login: {\n * allowedUsernames: [\"email\", \"profile.nickname\"]\n * }\n * }\n * })\n * ```\n \n * See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n /\n usernameField?: string;\n /*\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: RateLimitOptions;\n /\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?:\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n };\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"database-connection\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default database connection check middleware\n /\n databaseConnection?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-uploader\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints](https://www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file uploader router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUploader?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n */\n name?: string;\n };\n};\n"]}
1	+ {"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\n\n/*\n Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n /\nexport type ArkosConfig = {\n /\n Allows to configure request configs\n /\n request?: {\n /\n Allows to configure request parameters\n /\n parameters?: {\n /\n Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for pass prisma query options.\n \n See more\n /\n allowDangerousPrismaQueryOptions?: boolean;\n };\n };\n /* Message you would like to send, as Json and 200 response when\n * ```\n * GET /api\n * ```\n * ```json\n * { \"message\": \"Welcome to YourAppName\" }\n * ```\n \n default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com,\n \n \n * /\n welcomeMessage?: string;\n /\n Port where the application will run, can be set in 3 ways:\n \n 1. default is 8000\n * 2. PORT under environment variables (Lower precedence)\n * 3. this config option (Higher precedence)\n /\n port?: number \| undefined;\n /\n Allows to listen on a different host than localhost only\n /\n host?: string;\n /\n Defines authentication related configurations, by default is undefined.\n \n See [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for details.\n /\n authentication?: {\n /\n Defines whether to use Static or Dynamic Role-Based Acess Control\n \n Visit [www.arkosjs.com/docs/core-concepts/built-in-authentication-system](https://www.arkosjs.com/docs/core-concepts/built-in-authentication-system) for more details.\n /\n mode: \"static\" \| \"dynamic\";\n /\n Defines auth login related configurations to customize the api.\n /\n login?: {\n /\n Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n \n ```json\n * {\n * \"username\": \"johndoe\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n \n Note: You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n \n ```curl\n * POST /api/auth/login?usernameField=email\n * ```\n \n See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n \n Example with email\n \n ```json\n * {\n * \"email\": \"john.doe@example.com\",\n * \"password\": \"somePassword123\"\n * }\n * ```\n /\n allowedUsernames?: string[];\n /* Defines wether to send the access token in response after login or only send as cookie, defeault is both./\n sendAccessTokenThrough?: \"cookie-only\" \| \"response-only\" \| \"both\";\n };\n /\n @deprecated\n \n Use this instead:\n \n ```ts\n * arkos.init({\n * authentication: {\n * login: {\n * allowedUsernames: [\"email\", \"profile.nickname\"]\n * }\n * }\n * })\n * ```\n \n * See more at [www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field](https://www.arkosjs.com/docs/guide/authentication-system/sending-authentication-requests#example-changing-the-username-field)\n \n /\n usernameField?: string;\n /*\n Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n \n Important: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n \n Default: ```/^(?=.[A-Z])(?=.[a-z])(?=.\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n \n * message: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n /\n passwordValidation?: { regex: RegExp; message?: string };\n /\n Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n * \n * #### Default\n {\n windowMs: 5000,\n limit: 10,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n requestRateLimitOptions?: RateLimitOptions;\n /\n JWT (JSON Web Token) authentication configuration.\n \n You can override these values directly in code, or use environment variables:\n \n - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n \n ⚠️ Values passed here take precedence over environment variables.\n /\n jwt?: {\n /* Secret key used for signing and verifying JWT tokens /\n secret?: string;\n /\n Duration after which the JWT token expires.\n * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n * Defaults to \"30d\" if not provided.\n /\n expiresIn?: MsDuration \| number;\n\n /\n Configuration for the JWT cookie sent to the client\n /\n cookie?: {\n /\n Whether the cookie should be marked as secure (sent only over HTTPS).\n * Defaults to `true` in production and `false` in development.\n /\n secure?: boolean;\n\n /\n Whether the cookie should be marked as HTTP-only.\n * Default is `true` to prevent access via JavaScript.\n /\n httpOnly?: boolean;\n\n /\n Controls the SameSite attribute of the cookie.\n * Defaults to \"none\" in production and \"lax\" in development.\n * Options: \"lax\" \| \"strict\" \| \"none\"\n /\n sameSite?: \"lax\" \| \"strict\" \| \"none\";\n };\n };\n };\n /* Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n \n ```ts\n * // src/app.ts\n * import arkos from 'arkos'\n \n arkos.init({\n * validation: {\n * resolver: \"zod\"\n * }\n * })\n * ```\n \n See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n /\n validation?:\n \| {\n resolver?: \"class-validator\";\n /\n ValidatorOptions to used while validating request data.\n \n Default:\n * ```ts\n * {\n * whitelist: true\n * }\n * ```\n /\n validationOptions?: ValidatorOptions;\n }\n \| {\n resolver?: \"zod\";\n validationOptions?: Record<string, any>;\n };\n /\n Defines file upload configurations\n \n See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n /\n fileUpload?: {\n /\n Defiens the base file upload directory, default is set to /uploads (on root directory)\n \n When setting up a path dir always now that root directory will be the starting reference.\n \n #### Example\n * passing `../my-arkos-uploaded-files`\n \n Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n \n NB: You must be aware of permissions on your server to acess files outside your project directory.\n \n /\n baseUploadDir?: string;\n /*\n Changes the default `/api/uploads` base route for accessing file upload route.\n \n #### IMPORTANT\n * Changing this will not affect the `baseUploadDir` folder. You can\n * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n \n /\n baseRoute?: string;\n /*\n Defines options for `express.static(somePath, someOptions)`\n \n #### Default:\n \n ```ts\n {\n maxAge: \"1y\",\n etag: true,\n lastModified: true,\n dotfiles: \"ignore\",\n fallthrough: true,\n index: false,\n cacheControl: true,\n }\n ```\n * \n * By passing your custom options have in mind that it\n * will be deepmerged with the default.\n * \n * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n * \n /\n expressStaticOptions?: Parameters<typeof express.static>[1];\n /\n Defines upload restrictions for each file type: image, video, document or other.\n \n #### Important:\n * Passing an object without overriding everything will only cause it\n * to be deepmerged with the default options.\n \n See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n * ```\n /\n restrictions?: {\n images?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n videos?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n documents?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n files?: {\n maxCount?: number;\n maxSize?: number;\n supportedFilesRegex?: RegExp;\n };\n };\n };\n /\n Allows to specify the request rate limit for all endpoints.\n * \n * #### Default\n ```ts\n {\n windowMs: 60 * 1000,\n limit: 1000,\n standardHeaders: \"draft-7\",\n legacyHeaders: false,\n }\n ```\n * \n * Passing an object not overriding all the default options will only\n * cause it to be deepmerged and not actually replace with empty fields\n * \n * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n /\n globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n /\n Defines options for the built-in express.json() middleware\n * Nothing is passed by default.\n /\n jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n /\n Allows to pass paremeters to cookieParser from npm package cookie-parser\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n /\n cookieParserParameters?: Parameters<typeof cookieParser>;\n /\n Allows to define options for npm package compression\n * Nothing is passed by default.\n \n See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n /\n compressionOptions?: compression.CompressionOptions;\n /\n Options to define how query must be parsed.\n \n #### for example:\n * ```\n * GET /api/product?saleId=null\n * ```\n \n Normally would parsed to { saleId: \"null\" } so query parser\n * trough setting option `parseNull` will transform { saleId: null }\n * \n * #### Default:\n * \n * {\n parseNull: true,\n parseUndefined: true,\n parseBoolean: true,\n }\n * \n * parseNumber may convert fields that are string but you only passed\n * numbers to query pay attention to this.\n * \n * Soon a feature to converted the query to the end prisma type will be added.\n /\n queryParserOptions?: QueryParserOptions;\n /\n Configuration for CORS (Cross-Origin Resource Sharing).\n \n @property {string \| string[] \| \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n \n @remarks\n * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n \n See https://www.npmjs.com/package/cors\n /\n cors?: {\n allowedOrigins?: string \| string[] \| \"\";\n options?: cors.CorsOptions;\n /*\n If you would like to override the entire middleware\n \n see\n /\n customHandler?: cors.CorsOptionsDelegate;\n };\n /\n Defines express/arkos middlewares configurations\n /\n middlewares?: {\n /\n Allows to add an array of custom express middlewares into the default middleware stack.\n \n Tip: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n \n Note: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n \n Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.RequestHandler[];\n /\n An array containing a list of defaults middlewares to be disabled\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n disable?: (\n \| \"compression\"\n \| \"global-rate-limit\"\n \| \"auth-rate-limit\"\n \| \"cors\"\n \| \"express-json\"\n \| \"cookie-parser\"\n \| \"query-parser\"\n \| \"database-connection\"\n \| \"request-logger\"\n \| \"global-error-handler\"\n )[];\n /\n Allows you to replace each of the built-in middlewares with your own implementation\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default compression middleware\n /\n compression?: express.RequestHandler;\n /\n Replace the default global rate limit middleware\n /\n globalRateLimit?: express.RequestHandler;\n /\n Replace the default authentication rate limit middleware\n /\n authRateLimit?: express.RequestHandler;\n /\n Replace the default CORS middleware\n /\n cors?: express.RequestHandler;\n /\n Replace the default JSON body parser middleware\n /\n expressJson?: express.RequestHandler;\n /\n Replace the default cookie parser middleware\n /\n cookieParser?: express.RequestHandler;\n /\n Replace the default query parser middleware\n /\n queryParser?: express.RequestHandler;\n /\n Replace the default database connection check middleware\n /\n databaseConnection?: express.RequestHandler;\n /\n Replace the default request logger middleware\n /\n requestLogger?: express.RequestHandler;\n /\n Replace the default global error handler middleware\n /\n globalErrorHandler?: express.ErrorRequestHandler;\n };\n };\n /\n Defines express/arkos routers configurations\n /\n routers?: {\n /\n Allows to add an array of custom express routers into the default middleware/router stack.\n \n Where will these be placed?: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n \n \n * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n /\n additional?: express.Router[];\n disable?: (\n \| \"auth-router\"\n \| \"prisma-models-router\"\n \| \"file-uploader\"\n \| \"welcome-endpoint\"\n )[];\n /\n Allows you to replace each of the built-in routers with your own implementation.\n \n Note: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n \n Tip: I you want to disable some prisma models specific endpoint\n * see [www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints](https://www.arkosjs.com/docs/advanced-guide/customizing-prisma-models-routers#disabling-endpoints)\n \n Caution: Be careful with this because you may endup breaking your entire application.\n /\n replace?: {\n /\n Replace the default authentication router\n * @param config The original Arkos configuration\n * @returns A router handling authentication endpoints\n /\n authRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default Prisma models router\n * @param config The original Arkos configuration\n * @returns A router handling Prisma model endpoints\n /\n prismaModelsRouter?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default file uploader router\n * @param config The original Arkos configuration\n * @returns A router handling file upload endpoints\n /\n fileUploader?: (\n config: ArkosConfig\n ) => express.Router \| Promise<express.Router>;\n /\n Replace the default welcome endpoint handler\n * @param req Express request object\n * @param res Express response object\n * @param next Express next function\n /\n welcomeEndpoint?: express.RequestHandler;\n };\n };\n /\n Gives acess to the underlying express app so that you can add custom configurations beyong Arkos customization capabilities\n \n Note: In the end Arkos will call `app.listen` for you.\n \n If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n \n See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n \n @param {express.Express} app\n * @returns {any}\n /\n configureApp?: (app: express.Express) => Promise<any> \| any;\n /\n Gives access to the underlying HTTP server so that you can add custom configurations beyond Arkos customization capabilities\n \n Note: In the end Arkos will call `server.listen` for you.\n \n If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n \n See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-http-server#calling-serverlisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-http-server#calling-serverlisten-by-yourself)\n \n See [www.arkosjs.com/docs/guide/accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-http-server) for further details on the method configureServer.\n \n @param {http.Server} server - The HTTP server instance\n * @returns {any}\n /\n configureServer?: (server: http.Server) => Promise<any> \| any;\n /\n Allows to configure email configurations for sending emails through `emailService`\n \n See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n /\n email?: {\n /\n Your email provider url\n /\n host: string;\n /\n Email provider SMTP port, Default is `465`\n /\n port?: number;\n /\n If smtp connection must be secure, Default is `true`\n /\n secure?: boolean;\n /\n Used to authenticate in your smtp server\n /\n auth: {\n /\n Email used for auth as well as sending emails\n /\n user: string;\n /\n Your SMTP password\n /\n pass: string;\n };\n /\n Email name to used like:\n \n John Doe\\<john.doe@gmail.com>\n */\n name?: string;\n };\n};\n"]}

package/dist/types/types/arkos-config.d.ts CHANGED Viewed

@@ -1,3 +1,4 @@
+import http from "http";
 import cors from "cors";
 import express from "express";
 import { Options as RateLimitOptions } from "express-rate-limit";
@@ -108,6 +109,7 @@ export type ArkosConfig = {
         };
     };
     configureApp?: (app: express.Express) => Promise<any> | any;
+    configureServer?: (server: http.Server) => Promise<any> | any;
     email?: {
         host: string;
         port?: number;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "arkos",
-  "version": "1.1.15-test",
+  "version": "1.1.16-test",
   "description": "The Express & Prisma Framework For RESTful API",
   "main": "dist/cjs/exports/index.js",
   "module": "dist/es2020/exports/index.js",