@arkstack/driver-express 0.5.0 → 0.5.2

package/dist/middlewares/index.js

@@ -4,10 +4,10 @@ import multer from "multer";
 //#region src/middlewares/auth.ts
 const auth = async (req, res, next) => {
 	try {
-		if (Hook.has("middleware:auth", "before")) Hook.get("middleware:auth", "before")?.({
+		if (Hook.has("middleware:auth", "before")) await Promise.resolve(Hook.get("middleware:auth", "before")?.({
 			req,
 			res
-		});
+		}));
 		const token = readBearerToken(req.headers.authorization);
 		if (!token) throw new AuthenticationException("Unauthenticated", {
 			req,
@@ -19,16 +19,16 @@ const auth = async (req, res, next) => {
 		req.auth = auth;
 		req.authUser = user;
 		req.authToken = token;
-		if (Hook.has("middleware:auth", "after")) Hook.get("middleware:auth", "after")?.({
+		if (Hook.has("middleware:auth", "after")) await Promise.resolve(Hook.get("middleware:auth", "after")?.({
 			req,
 			res
-		});
+		}));
 		next();
 	} catch (error) {
-		if (Hook.has("middleware:auth", "error")) Hook.get("middleware:auth", "error")?.(error, {
+		if (Hook.has("middleware:auth", "error")) await Promise.resolve(Hook.get("middleware:auth", "error")?.(error, {
 			req,
 			res
-		});
+		}));
 		next(error);
 	}
 };

package/dist/middlewares/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/auth.ts","../../src/middlewares/formdata.ts","../../src/middlewares/request-logger.ts"],"sourcesContent":["import { Auth, AuthenticationException } from '@arkstack/auth'\n\nimport type { Handler } from 'express'\nimport { Hook } from '@arkstack/common'\n\nexport const auth: Handler = async (req, res, next) => {\n    try {\n        if (Hook.has('middleware:auth', 'before'))\n            Hook.get('middleware:auth', 'before')?.({ req, res })\n\n        const token = readBearerToken(req.headers.authorization)\n\n        if (!token) {\n            throw new AuthenticationException('Unauthenticated', { req, status: 401 })\n        }\n\n        const auth = Auth.make().setRequest(req)\n        const user = await Auth.make().setRequest(req).authorizeToken(token)\n\n        req.user = user\n        req.auth = auth\n        req.authUser = user\n        req.authToken = token\n\n        if (Hook.has('middleware:auth', 'after'))\n            Hook.get('middleware:auth', 'after')?.({ req, res })\n\n        next()\n    } catch (error) {\n        if (Hook.has('middleware:auth', 'error'))\n            Hook.get('middleware:auth', 'error')?.(error, { req, res })\n\n        next(error)\n    }\n}\n\nconst readBearerToken = (authorization: string | string[] | undefined) => {\n    const value = Array.isArray(authorization) ? authorization[0] : authorization\n\n    if (!value?.startsWith('Bearer ')) {\n        return null\n    }\n\n    return value.substring(7)\n}\n","import multer from 'multer'\n\nexport const formdata = multer({ storage: multer.memoryStorage() })","import { Logger, nodeEnv } from '@arkstack/common'\nimport { NextFunction, Request, Response } from 'express'\n\nconst colors: Record<string, 'green' | 'blue' | 'yellow' | 'red' | 'cyan'> = {\n    GET: 'green',\n    POST: 'blue',\n    PUT: 'yellow',\n    DELETE: 'red',\n    PATCH: 'cyan',\n}\n\n/**\n * Middleware to log incoming requests and their response times.\n * \n * @param config Configuration options for the request logger middleware.\n * @param config.allowInProduction If true, the logger will also log requests in production environment. Default is false. \n * @returns \n */\nexport const requestLogger = ({\n    allowInProduction = false,\n}: {\n    allowInProduction?: boolean\n} = {}) => async (req: Request, res: Response, next: NextFunction) => {\n    if (nodeEnv() === 'prod' && !allowInProduction) return next()\n\n    const start = Date.now()\n\n    const status = res.statusCode || 200\n    const duration = Date.now() - start\n    Logger.log([\n        [`[${req.method}]`, colors[req.method] || 'white'],\n        [req.url, 'cyan'],\n        [status.toString(), status >= 500 ? 'red' : status >= 400 ? 'yellow' : 'green'],\n        [`- ${duration}ms`, 'dim']\n    ], ' ')\n\n    next()\n}"],"mappings":";;;;AAKA,MAAa,OAAgB,OAAO,KAAK,KAAK,SAAS;CACnD,IAAI;EACA,IAAI,KAAK,IAAI,mBAAmB,SAAS,EACrC,KAAK,IAAI,mBAAmB,SAAS,GAAG;GAAE;GAAK;GAAK,CAAC;EAEzD,MAAM,QAAQ,gBAAgB,IAAI,QAAQ,cAAc;EAExD,IAAI,CAAC,OACD,MAAM,IAAI,wBAAwB,mBAAmB;GAAE;GAAK,QAAQ;GAAK,CAAC;EAG9E,MAAM,OAAO,KAAK,MAAM,CAAC,WAAW,IAAI;EACxC,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,CAAC,eAAe,MAAM;EAEpE,IAAI,OAAO;EACX,IAAI,OAAO;EACX,IAAI,WAAW;EACf,IAAI,YAAY;EAEhB,IAAI,KAAK,IAAI,mBAAmB,QAAQ,EACpC,KAAK,IAAI,mBAAmB,QAAQ,GAAG;GAAE;GAAK;GAAK,CAAC;EAExD,MAAM;UACD,OAAO;EACZ,IAAI,KAAK,IAAI,mBAAmB,QAAQ,EACpC,KAAK,IAAI,mBAAmB,QAAQ,GAAG,OAAO;GAAE;GAAK;GAAK,CAAC;EAE/D,KAAK,MAAM;;;AAInB,MAAM,mBAAmB,kBAAiD;CACtE,MAAM,QAAQ,MAAM,QAAQ,cAAc,GAAG,cAAc,KAAK;CAEhE,IAAI,CAAC,OAAO,WAAW,UAAU,EAC7B,OAAO;CAGX,OAAO,MAAM,UAAU,EAAE;;;;ACzC7B,MAAa,WAAW,OAAO,EAAE,SAAS,OAAO,eAAe,EAAE,CAAA;;;ACClE,MAAM,SAAuE;CACzE,KAAK;CACL,MAAM;CACN,KAAK;CACL,QAAQ;CACR,OAAO;CACV;;;;;;;;AASD,MAAa,iBAAiB,EAC1B,oBAAoB,UAGpB,EAAE,KAAK,OAAO,KAAc,KAAe,SAAuB;CAClE,IAAI,SAAS,KAAK,UAAU,CAAC,mBAAmB,OAAO,MAAM;CAE7D,MAAM,QAAQ,KAAK,KAAK;CAExB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,WAAW,KAAK,KAAK,GAAG;CAC9B,OAAO,IAAI;EACP,CAAC,IAAI,IAAI,OAAO,IAAI,OAAO,IAAI,WAAW,QAAQ;EAClD,CAAC,IAAI,KAAK,OAAO;EACjB,CAAC,OAAO,UAAU,EAAE,UAAU,MAAM,QAAQ,UAAU,MAAM,WAAW,QAAQ;EAC/E,CAAC,KAAK,SAAS,KAAK,MAAM;EAC7B,EAAE,IAAI;CAEP,MAAM"}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/auth.ts","../../src/middlewares/formdata.ts","../../src/middlewares/request-logger.ts"],"sourcesContent":["import { Auth, AuthenticationException } from '@arkstack/auth'\n\nimport type { Handler } from 'express'\nimport { Hook } from '@arkstack/common'\n\nexport const auth: Handler = async (req, res, next) => {\n    try {\n        if (Hook.has('middleware:auth', 'before'))\n            await Promise.resolve(Hook.get('middleware:auth', 'before')?.({ req, res }))\n\n        const token = readBearerToken(req.headers.authorization)\n\n        if (!token) {\n            throw new AuthenticationException('Unauthenticated', { req, status: 401 })\n        }\n\n        const auth = Auth.make().setRequest(req)\n        const user = await Auth.make().setRequest(req).authorizeToken(token)\n\n        req.user = user\n        req.auth = auth\n        req.authUser = user\n        req.authToken = token\n\n        if (Hook.has('middleware:auth', 'after'))\n            await Promise.resolve(Hook.get('middleware:auth', 'after')?.({ req, res }))\n\n        next()\n    } catch (error) {\n        if (Hook.has('middleware:auth', 'error'))\n            await Promise.resolve(Hook.get('middleware:auth', 'error')?.(error, {\n                req,\n                res\n            }))\n\n        next(error)\n    }\n}\n\nconst readBearerToken = (authorization: string | string[] | undefined) => {\n    const value = Array.isArray(authorization) ? authorization[0] : authorization\n\n    if (!value?.startsWith('Bearer ')) {\n        return null\n    }\n\n    return value.substring(7)\n}\n","import multer from 'multer'\n\nexport const formdata = multer({ storage: multer.memoryStorage() })","import { Logger, nodeEnv } from '@arkstack/common'\nimport { NextFunction, Request, Response } from 'express'\n\nconst colors: Record<string, 'green' | 'blue' | 'yellow' | 'red' | 'cyan'> = {\n    GET: 'green',\n    POST: 'blue',\n    PUT: 'yellow',\n    DELETE: 'red',\n    PATCH: 'cyan',\n}\n\n/**\n * Middleware to log incoming requests and their response times.\n * \n * @param config Configuration options for the request logger middleware.\n * @param config.allowInProduction If true, the logger will also log requests in production environment. Default is false. \n * @returns \n */\nexport const requestLogger = ({\n    allowInProduction = false,\n}: {\n    allowInProduction?: boolean\n} = {}) => async (req: Request, res: Response, next: NextFunction) => {\n    if (nodeEnv() === 'prod' && !allowInProduction) return next()\n\n    const start = Date.now()\n\n    const status = res.statusCode || 200\n    const duration = Date.now() - start\n    Logger.log([\n        [`[${req.method}]`, colors[req.method] || 'white'],\n        [req.url, 'cyan'],\n        [status.toString(), status >= 500 ? 'red' : status >= 400 ? 'yellow' : 'green'],\n        [`- ${duration}ms`, 'dim']\n    ], ' ')\n\n    next()\n}"],"mappings":";;;;AAKA,MAAa,OAAgB,OAAO,KAAK,KAAK,SAAS;CACnD,IAAI;EACA,IAAI,KAAK,IAAI,mBAAmB,SAAS,EACrC,MAAM,QAAQ,QAAQ,KAAK,IAAI,mBAAmB,SAAS,GAAG;GAAE;GAAK;GAAK,CAAC,CAAC;EAEhF,MAAM,QAAQ,gBAAgB,IAAI,QAAQ,cAAc;EAExD,IAAI,CAAC,OACD,MAAM,IAAI,wBAAwB,mBAAmB;GAAE;GAAK,QAAQ;GAAK,CAAC;EAG9E,MAAM,OAAO,KAAK,MAAM,CAAC,WAAW,IAAI;EACxC,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,CAAC,eAAe,MAAM;EAEpE,IAAI,OAAO;EACX,IAAI,OAAO;EACX,IAAI,WAAW;EACf,IAAI,YAAY;EAEhB,IAAI,KAAK,IAAI,mBAAmB,QAAQ,EACpC,MAAM,QAAQ,QAAQ,KAAK,IAAI,mBAAmB,QAAQ,GAAG;GAAE;GAAK;GAAK,CAAC,CAAC;EAE/E,MAAM;UACD,OAAO;EACZ,IAAI,KAAK,IAAI,mBAAmB,QAAQ,EACpC,MAAM,QAAQ,QAAQ,KAAK,IAAI,mBAAmB,QAAQ,GAAG,OAAO;GAChE;GACA;GACH,CAAC,CAAC;EAEP,KAAK,MAAM;;;AAInB,MAAM,mBAAmB,kBAAiD;CACtE,MAAM,QAAQ,MAAM,QAAQ,cAAc,GAAG,cAAc,KAAK;CAEhE,IAAI,CAAC,OAAO,WAAW,UAAU,EAC7B,OAAO;CAGX,OAAO,MAAM,UAAU,EAAE;;;;AC5C7B,MAAa,WAAW,OAAO,EAAE,SAAS,OAAO,eAAe,EAAE,CAAA;;;ACClE,MAAM,SAAuE;CACzE,KAAK;CACL,MAAM;CACN,KAAK;CACL,QAAQ;CACR,OAAO;CACV;;;;;;;;AASD,MAAa,iBAAiB,EAC1B,oBAAoB,UAGpB,EAAE,KAAK,OAAO,KAAc,KAAe,SAAuB;CAClE,IAAI,SAAS,KAAK,UAAU,CAAC,mBAAmB,OAAO,MAAM;CAE7D,MAAM,QAAQ,KAAK,KAAK;CAExB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,WAAW,KAAK,KAAK,GAAG;CAC9B,OAAO,IAAI;EACP,CAAC,IAAI,IAAI,OAAO,IAAI,OAAO,IAAI,WAAW,QAAQ;EAClD,CAAC,IAAI,KAAK,OAAO;EACjB,CAAC,OAAO,UAAU,EAAE,UAAU,MAAM,QAAQ,UAAU,MAAM,WAAW,QAAQ;EAC/E,CAAC,KAAK,SAAS,KAAK,MAAM;EAC7B,EAAE,IAAI;CAEP,MAAM"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-express",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "type": "module",
   "description": "Express driver for Arkstack, providing Express-based runtime integration for the framework.",
   "homepage": "https://arkstack.toneflix.net",
@@ -40,13 +40,13 @@
     "clear-router": "^2.6.4",
     "express-rate-limit": "^8.4.1",
     "@resora/plugin-clear-router": "^1.0.14",
-    "resora": "^1.2.3",
-    "@arkstack/contract": "^0.5.0"
+    "resora": "^1.2.4",
+    "@arkstack/contract": "^0.5.2"
   },
   "peerDependencies": {
     "express": "^5.2.1",
-    "@arkstack/auth": "^0.5.0",
-    "@arkstack/common": "^0.5.0"
+    "@arkstack/auth": "^0.5.2",
+    "@arkstack/common": "^0.5.2"
   },
   "peerDependenciesMeta": {
     "@arkstack/auth": {

package/stubs/controller.api.resource.stub

@@ -1,5 +1,4 @@
 import { BaseController } from '@controllers/BaseController'
-import { HttpContext } from 'clear-router/types/express'
 import {{ResourceName}} from '@app/http/resources/{{ResourceName}}'
 import {{CollectionResourceName}} from '@app/http/resources/{{CollectionResourceName}}'
 
@@ -11,86 +10,56 @@ import { Resource, ResourceCollection } from 'resora'
 export default class {{ControllerName}} extends BaseController {
     /**
      * Get all resources
-     * 
-     * @param req 
-     * @param res 
      */
-    index = async ({ res }: HttpContext) => {
-        return await new ResourceCollection( { data: [] }, res)
-        .additional({
+    async index () {
+        return await new {{CollectionResourceName}}([]).additional({
             status: 'success',
             message: 'OK',
             code: 200,
-        })
-        .response()
-        .setStatusCode(200)
+        }).response().setStatusCode(200)
     }
 
     /**
      * Get a specific resource
-     * 
-     * @param req 
-     * @param res 
      */
-    show = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async show () {
+        return new {{ResourceName}}({}).additional({
             status: 'success',
             message: 'OK',
             code: 200,
-        })
-        .response()
-        .setStatusCode(200)
+        }).response().setStatusCode(200)
     }
 
     /**
      * Create a resource
-     * 
-     * @param req 
-     * @param res 
      */
-    create = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async create () {
+        return new {{ResourceName}}({}).additional({
             status: 'success',
             message: 'New {{Name}} created successfully',
             code: 201,
-        })
-        .response()
-        .setStatusCode(201)
+        }).response().setStatusCode(201)
     }
 
     /**
      * Update a specific resource
-     * 
-     * @param req 
-     * @param res 
      */
-    update = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async update () {
+        return new {{ResourceName}}({}).additional({
             status: 'success',
             message: '{{Name}} updated successfully',
             code: 202,
-        })
-        .response()
-        .setStatusCode(202)
+        }).response().setStatusCode(202)
     }
 
     /**
      * Delete a specific resource
-     * 
-     * @param req 
-     * @param res 
      */
-    destroy = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async destroy () {
+        return new {{ResourceName}}({}).additional({
             status: 'success',
             message: '{{Name}} deleted successfully',
             code: 202,
-        })
-        .response()
-        .setStatusCode(202)
+        }).response().setStatusCode(202)
     }
 }

package/stubs/controller.api.stub

@@ -1,5 +1,4 @@
 import { BaseController } from '@controllers/BaseController'
-import { HttpContext } from 'clear-router/types/express'
 import { Resource, ResourceCollection } from 'resora'
 
 /**
@@ -8,85 +7,56 @@ import { Resource, ResourceCollection } from 'resora'
 export default class {{ControllerName}} extends BaseController {
     /**
      * Get all resources
-     * 
-     * @param req 
-     * @param res 
      */
-    index = async ({ res }: HttpContext) => {
-        return new ResourceCollection({ data: [] }, res)
-        .additional({
+    async index () {
+        return new ResourceCollection({ data: [] }).additional({
             status: 'success',
             message: 'OK',
             code: 200,
-        })
-        .response()
-        .setStatusCode(200)
+        }).response().setStatusCode(200)
     }
 
     /**
      * Get a specific resource
-     * 
-     * @param req 
-     * @param res 
      */
-    show = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async show () {
+        return new Resource({ data: {} }).additional({
             status: 'success',
             message: 'OK',
             code: 200,
-        })
-        .response()
-        .setStatusCode(200)
+        }).response().setStatusCode(200)
     }
 
     /**
      * Create a resource
-     * 
-     * @param req 
-     * @param res 
      */
-    create = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async create () {
+        return new Resource({ data: {} }).additional({
             status: 'success',
             message: 'New {{Name}} created successfully',
             code: 201,
-        })
-        .response()
-        .setStatusCode(201)
+        }).response().setStatusCode(201)
     }
 
     /**
      * Update a specific resource
-     * 
-     * @param req 
-     * @param res 
      */
-    update = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async update () {
+        return new Resource({ data: {} }).additional({
             status: 'success',
             message: '{{Name}} updated successfully',
             code: 202,
-        })
-        .response()
-        .setStatusCode(202)
+        }).response().setStatusCode(202)
     }
 
     /**
      * Delete a specific resource
-     * 
-     * @param res 
      */
-    destroy = async ({ res }: HttpContext) => {
-        return new Resource({ data: {} }, res)
-        .additional({
+    async destroy () {
+        return new Resource({ data: {}} ).additional({
             status: 'success',
             message: '{{Name}} deleted successfully',
             code: 202,
-        })
-        .response()
-        .setStatusCode(202)
+        }).response().setStatusCode(202)
     }
 }

package/stubs/controller.model.stub

@@ -1,7 +1,8 @@
 import { BaseController } from '@controllers/BaseController'
-import { HttpContext } from 'clear-router/types/express'
+import { Bind } from 'clear-router/decorators'
 import { Resource, ResourceCollection } from 'resora'
-import { {{Model}} } from 'src/models/{{Model}}'
+import { {{Model}} } from '@app/models/{{Model}}'
+import { Request } from '@arkstack/http'
 
 /**
  * {{ControllerName}}
@@ -9,110 +10,78 @@ import { {{Model}} } from 'src/models/{{Model}}'
 export default class {{ControllerName}} extends BaseController {
     /**
      * Get all resource from the database
-     * 
-     * @param req 
-     * @param res 
      */
-    index = async ({ res }: HttpContext) => {
-        return new ResourceCollection({
-            data: await {{Model}}.query().orderBy({ id: 'asc' }).get(),
-        }, res)
-        .additional({
+    async index () {
+        return new ResourceCollection(await {{Model}}.query().orderBy({ id: 'asc' }).get()).additional({
             status: 'success',
             message: 'OK',
             code: 200,
-        })
-        .response()
-        .setStatusCode(200)
+        }).response().setStatusCode(200)
     }
 
     /**
      * Get a specific resource from the database
      * 
-     * @param req 
-     * @param res 
+     * @param {{Param}}  
      */
-    show = async ({ req, res }: HttpContext) => {
-        return new Resource({
-            data: await {{Model}}.query().where({ id: String(req.params.id) }).firstOrFail(),
-        }, res)
-        .additional({
+     @Bind()
+    async show ({{Param}}: {{Model}}) {
+        return new Resource({{Param}}).additional({
             status: 'success',
             message: 'OK',
             code: 200,
-        })
-        .response()
-        .setStatusCode(200)
+        }).response().setStatusCode(200)
     }
 
     /**
      * Create a new resource in the database
      * 
-     * The calling route must recieve a multer.RequestHandler instance
-     * 
-     * @example router.post('/{{ModelName}}s', upload.none(), new AdminController().create)
-     * 
      * @param req 
-     * @param res 
      */
-    create = async ({ req, res }: HttpContext) => {
+    @Bind()
+    async create (req: Request) {
         const data = await {{Model}}.query().create({
             data: req.body,
         })
 
-        return new Resource({
-            data: data,
-        }, res)
-        .additional({
+        return new Resource({ data }).additional({
             status: 'success',
             message: 'New {{ModelName}} created successfully',
             code: 201,
-        })
-        .response()
-        .setStatusCode(201)
+        }).response().setStatusCode(201)
     }
 
     /**
      * Update a specific resource in the database
      * 
+     * @param {{Param}} 
      * @param req 
-     * @param res 
      */
-    update = async ({ req, res }: HttpContext) => {
-        const data = await {{Model}}.query().where({ id: String(req.params.id) }).update({
+    @Bind()
+    async update (req: Request, {{Param}}: {{Model}}) {
+        await {{Param}}.update({
             data: req.body,
         })
 
-        return new Resource({
-            data,
-        }, res)
-        .additional({
+        return new Resource({{Param}}).additional({
             status: 'success',
             message: '{{ModelName}} updated successfully',
             code: 202,
-        })
-        .response()
-        .setStatusCode(202)
+        }).response().setStatusCode(202)
     }
 
     /**
      * Delete a specific resource from the database
      * 
-     * @param req 
-     * @param res 
+     * @param {{Param}}  
      */
-    destroy = async ({ req, res }: HttpContext) => {
-        await {{Model}}.query().where({ id: String(req.params.id) }).delete()
+    async destroy ({{Param}}: {{Model}}) {
+        await {{Param}}.delete()
 
-        return new Resource({
-            data: {},
-        }, res)
-        .additional({
+        return new Resource({ data: {} }).additional({
             status: 'success',
             message: '{{ModelName}} deleted successfully',
             code: 202,
-        })
-        .response()
-        .setStatusCode(202)
+        }).response().setStatusCode(202)
     }
 }

package/stubs/controller.stub

@@ -1,11 +1,10 @@
 import { BaseController } from '@controllers/BaseController'
-import { HttpContext } from 'clear-router/types/express'
 
 /**
  * {{ControllerName}}
  */
 export default class {{ControllerName}} extends BaseController {
-    index = async ({ res }: HttpContext) => {
-        res.send('<p>Hello!</p>')
+    async index () {
+        return '<p>Hello!</p>'
     }
 }