@arkstack/driver-express 0.3.16 → 0.4.0

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.
package/README.md CHANGED
@@ -5,10 +5,10 @@ Express driver package for Arkstack, providing Express-specific implementations
5
5
  ## Auth Middleware
6
6
 
7
7
  ```ts
8
- import { auth, type AuthenticatedExpressRequest } from '@arkstack/driver-express/middlewares';
8
+ import { auth } from '@arkstack/driver-express/middlewares';
9
9
 
10
10
  app.use('/account', auth, (req, res) => {
11
- const request = req as AuthenticatedExpressRequest;
11
+ const request = req;
12
12
 
13
13
  res.json({
14
14
  user: request.authUser,
package/dist/index.d.ts CHANGED
@@ -1,9 +1,18 @@
1
- import { ErrorRequestHandler, Express, Handler } from "express";
2
- import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from "@arkstack/contract";
1
+ import { ErrorRequestHandler, Express, Handler, Router as Router$1 } from "express";
2
+ import { ArkstackKitDriver, ArkstackMiddlewareConfig, ArkstackRouteListOptions, PromiseOrValue } from "@arkstack/contract";
3
+ import { Router as Router$2 } from "clear-router/express";
4
+ import { Route } from "clear-router";
5
+ import { Handler as Handler$1, HttpContext, Middleware } from "clear-router/types/express";
3
6
 
4
7
  //#region src/error-handler.d.ts
5
8
  declare const defaultErrorHandler: ErrorRequestHandler;
6
9
  //#endregion
10
+ //#region src/Router.d.ts
11
+ declare class Router extends Router$2 {
12
+ static bind(): Promise<Router$1>;
13
+ static list(_options?: ArkstackRouteListOptions): Promise<Array<Route<HttpContext, Middleware, Handler$1>>>;
14
+ }
15
+ //#endregion
7
16
  //#region src/index.d.ts
8
17
  interface ExpressDriverOptions {
9
18
  bindRouter: (app: Express) => PromiseOrValue<void>;
@@ -22,5 +31,5 @@ declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
22
31
  start(app: Express, port: number): void;
23
32
  }
24
33
  //#endregion
25
- export { ExpressDriver, ExpressDriverOptions, defaultErrorHandler };
34
+ export { ExpressDriver, ExpressDriverOptions, Router, defaultErrorHandler };
26
35
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../src/error-handler.ts","../src/Router.ts","../src/index.ts"],"mappings":";;;;;;;cAOa,mBAAA,EAAqB,mBAAA;;;cCMrB,MAAA,SAAe,QAAA;EAAA,OACb,IAAA,CAAA,GAAS,OAAA,CAAQ,QAAA;EAAA,OAyBjB,IAAA,CACX,QAAA,GAAU,wBAAA,GACT,OAAA,CAAQ,KAAA,CAAM,KAAA,CAAM,WAAA,EAAa,UAAA,EAAY,SAAA;AAAA;;;UCnCjC,oBAAA;EACb,UAAA,GAAa,GAAA,EAAK,OAAA,KAAY,cAAA;EAC9B,iBAAA,IAAqB,GAAA,EAAK,OAAA,EAAS,UAAA,aAAuB,cAAA;EAC1D,YAAA,GAAe,mBAAA,GAAsB,OAAA;AAAA;AAAA,cAO5B,aAAA,SAAsB,iBAAA,CAAkB,OAAA,EAAS,OAAA;EAAA,SACjD,IAAA;EAAA,iBACQ,OAAA;cAOL,OAAA,EAAS,oBAAA;EAUrB,SAAA,CAAA,GAAc,OAAA;EAUd,iBAAA,CAAmB,GAAA,EAAK,OAAA,EAAS,UAAA,WAAqB,cAAA;EAqBtD,UAAA,CAAY,GAAA,EAAK,OAAA,GAAU,cAAA;EAU3B,eAAA,CACI,GAAA,EAAK,OAAA,EACL,UAAA,EAAY,OAAA,GAAU,wBAAA,CAAyB,OAAA;EA8BnD,oBAAA,CAAsB,GAAA,EAAK,OAAA;EAU3B,KAAA,CAAO,GAAA,EAAK,OAAA,EAAS,IAAA;AAAA"}
package/dist/index.js CHANGED
@@ -1,6 +1,10 @@
1
1
  import express from "express";
2
2
  import { ArkstackKitDriver } from "@arkstack/contract";
3
- import { ErrorHandler, Logger, buildHtmlErrorResponse } from "@arkstack/common";
3
+ import { ErrorHandler, Logger, RequestException, importFile, renderError } from "@arkstack/common";
4
+ import { Router as Router$2 } from "clear-router/express";
5
+ import { clearRouterExpressPlugin } from "@resora/plugin-clear-router";
6
+ import { join } from "node:path";
7
+ import { registerPlugin } from "resora";
4
8
 
5
9
  //#region src/error-handler.ts
6
10
  const defaultErrorHandler = (err, req, res, next) => {
@@ -21,13 +25,38 @@ const defaultErrorHandler = (err, req, res, next) => {
21
25
  res.status(code).json(responseBody);
22
26
  return;
23
27
  }
24
- res.status(code).setHeader("Content-Type", "text/html").send(buildHtmlErrorResponse({
28
+ res.status(code).setHeader("Content-Type", "text/html").send(renderError({
25
29
  message: String(responseBody.message),
26
30
  stack: typeof responseBody.stack === "string" ? responseBody.stack : void 0,
27
31
  code
28
32
  }));
29
33
  };
30
34
 
35
+ //#endregion
36
+ //#region src/Router.ts
37
+ registerPlugin(clearRouterExpressPlugin);
38
+ var Router = class extends Router$2 {
39
+ static async bind() {
40
+ const router = express.Router();
41
+ await Router$2.group("/api", async () => {
42
+ await importFile(join(process.cwd(), "src/routes/api.ts"));
43
+ });
44
+ await Router$2.group("/", async () => {
45
+ await importFile(join(process.cwd(), "src/routes/web.ts"));
46
+ });
47
+ Router$2.apply(router);
48
+ router.all("/*splat", (req, _res, next) => {
49
+ const url = req.originalUrl || req.url;
50
+ next(new RequestException(`Cannot find any route matching [${req.method}] ${url}`, 404));
51
+ });
52
+ return router;
53
+ }
54
+ static async list(_options = {}) {
55
+ await this.bind();
56
+ return this.allRoutes();
57
+ }
58
+ };
59
+
31
60
  //#endregion
32
61
  //#region src/index.ts
33
62
  /**
@@ -122,5 +151,5 @@ var ExpressDriver = class extends ArkstackKitDriver {
122
151
  };
123
152
 
124
153
  //#endregion
125
- export { ExpressDriver, defaultErrorHandler };
154
+ export { ExpressDriver, Router, defaultErrorHandler };
126
155
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/error-handler.ts","../src/index.ts"],"sourcesContent":["import {\n buildHtmlErrorResponse,\n ErrorHandler,\n} from '@arkstack/common'\n\nimport type { ErrorRequestHandler } from 'express'\n\nexport const defaultErrorHandler: ErrorRequestHandler = (err, req, res, next) => {\n const responseBody = ErrorHandler.createErrorPayload(err)\n\n if (ErrorHandler.shouldLogError(err)) {\n ErrorHandler.logUnhandledError(err, {\n headers: req.headers,\n method: req.method,\n url: req.originalUrl || req.url,\n }, 'Unhandled Express request error')\n }\n\n if (process.env.NODE_ENV === 'development') console.error(responseBody)\n\n if (res.headersSent) {\n next(err)\n\n return\n }\n\n const acceptsHeader = Array.isArray(req.headers.accept) ? req.headers.accept.join(',') : req.headers.accept ?? ''\n const expectsJson = acceptsHeader.includes('application/json') || req.originalUrl.startsWith('/api/')\n const code = ErrorHandler.normalizeStatusCode(responseBody.code)\n\n if (expectsJson) {\n res.status(code).json(responseBody)\n\n return\n }\n\n res.status(code).setHeader('Content-Type', 'text/html').send(buildHtmlErrorResponse({\n message: String(responseBody.message),\n stack: typeof responseBody.stack === 'string' ? responseBody.stack : undefined,\n code,\n }))\n}\n\nexport default defaultErrorHandler\n","import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { Logger } from '@arkstack/common'\nimport { defaultErrorHandler } from './error-handler'\n\nexport interface ExpressDriverOptions {\n bindRouter: (app: Express) => PromiseOrValue<void>;\n mountPublicAssets?: (app: Express, publicPath: string) => PromiseOrValue<void>;\n errorHandler?: ErrorRequestHandler | Handler;\n}\n\n/**\n * The ExpressDriver class implements the ArkstackKitDriver \n * contract for the Express framework.\n */\nexport class ExpressDriver extends ArkstackKitDriver<Express, Handler> {\n readonly name = 'express'\n private readonly options: ExpressDriverOptions\n\n /**\n * Creates an instance of ExpressDriver.\n * \n * @param options \n */\n constructor(options: ExpressDriverOptions) {\n super()\n this.options = options\n }\n\n /**\n * Creates an Express application instance.\n * \n * @returns \n */\n createApp (): Express {\n return express()\n }\n\n /**\n * Mounts static assets from the specified public path to the Express application.\n * \n * @param app \n * @param publicPath \n */\n mountPublicAssets (app: Express, publicPath: string): PromiseOrValue<void> {\n if (this.options.mountPublicAssets) {\n return this.options.mountPublicAssets(app, publicPath)\n }\n\n app.use(express.static(publicPath, {\n maxAge: '1y',\n immutable: true,\n setHeaders: (res) => {\n res.setHeader('Access-Control-Allow-Origin', '*')\n res.setHeader('Access-Control-Allow-Methods', 'GET, HEAD, OPTIONS')\n res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')\n },\n }))\n }\n\n /**\n * Binds the router to the Express application using the provided bindRouter function.\n * \n * @param app \n */\n bindRouter (app: Express): PromiseOrValue<void> {\n return this.options.bindRouter(app)\n }\n\n /**\n * Applies middleware to the Express application.\n * \n * @param app \n * @param middleware \n */\n applyMiddleware (\n app: Express,\n middleware: Handler | ArkstackMiddlewareConfig<Handler>,\n ): void {\n if (typeof middleware === 'function') {\n app.use(middleware)\n\n return\n }\n\n for (const [pos, entries] of Object.entries(middleware) as [string, Handler[]][]) {\n for (const entry of entries) {\n if (pos === 'after') {\n app.use(async (req, res, next) => {\n res.once('finish', async () => {\n await entry(req, res, next)\n })\n next()\n })\n } else {\n app.use(entry)\n }\n }\n }\n }\n\n /**\n * Registers an error handler middleware to the Express \n * application if provided in the options.\n * \n * @param app \n */\n registerErrorHandler (app: Express): void {\n app.use((this.options.errorHandler ?? defaultErrorHandler) as ErrorRequestHandler)\n }\n\n /**\n * Starts the Express server on the specified port.\n * \n * @param app \n * @param port \n */\n start (app: Express, port: number): void {\n app.listen(port, () => {\n Logger.log([\n ['Server is running on', 'white'],\n [`http://localhost:${port}`, 'cyan']\n ], ' ')\n })\n }\n}\n\nexport * from './error-handler'\n"],"mappings":";;;;;AAOA,MAAa,uBAA4C,KAAK,KAAK,KAAK,SAAS;CAC7E,MAAM,eAAe,aAAa,mBAAmB,IAAI;AAEzD,KAAI,aAAa,eAAe,IAAI,CAChC,cAAa,kBAAkB,KAAK;EAChC,SAAS,IAAI;EACb,QAAQ,IAAI;EACZ,KAAK,IAAI,eAAe,IAAI;EAC/B,EAAE,kCAAkC;AAGzC,KAAI,QAAQ,IAAI,aAAa,cAAe,SAAQ,MAAM,aAAa;AAEvE,KAAI,IAAI,aAAa;AACjB,OAAK,IAAI;AAET;;CAIJ,MAAM,eADgB,MAAM,QAAQ,IAAI,QAAQ,OAAO,GAAG,IAAI,QAAQ,OAAO,KAAK,IAAI,GAAG,IAAI,QAAQ,UAAU,IAC7E,SAAS,mBAAmB,IAAI,IAAI,YAAY,WAAW,QAAQ;CACrG,MAAM,OAAO,aAAa,oBAAoB,aAAa,KAAK;AAEhE,KAAI,aAAa;AACb,MAAI,OAAO,KAAK,CAAC,KAAK,aAAa;AAEnC;;AAGJ,KAAI,OAAO,KAAK,CAAC,UAAU,gBAAgB,YAAY,CAAC,KAAK,uBAAuB;EAChF,SAAS,OAAO,aAAa,QAAQ;EACrC,OAAO,OAAO,aAAa,UAAU,WAAW,aAAa,QAAQ;EACrE;EACH,CAAC,CAAC;;;;;;;;;ACxBP,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA+B;AACvC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAsB;AAClB,SAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0C;AACvE,MAAI,KAAK,QAAQ,kBACb,QAAO,KAAK,QAAQ,kBAAkB,KAAK,WAAW;AAG1D,MAAI,IAAI,QAAQ,OAAO,YAAY;GAC/B,QAAQ;GACR,WAAW;GACX,aAAa,QAAQ;AACjB,QAAI,UAAU,+BAA+B,IAAI;AACjD,QAAI,UAAU,gCAAgC,qBAAqB;AACnE,QAAI,UAAU,gCAAgC,8BAA8B;;GAEnF,CAAC,CAAC;;;;;;;CAQP,WAAY,KAAoC;AAC5C,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBACI,KACA,YACI;AACJ,MAAI,OAAO,eAAe,YAAY;AAClC,OAAI,IAAI,WAAW;AAEnB;;AAGJ,OAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,CACnD,MAAK,MAAM,SAAS,QAChB,KAAI,QAAQ,QACR,KAAI,IAAI,OAAO,KAAK,KAAK,SAAS;AAC9B,OAAI,KAAK,UAAU,YAAY;AAC3B,UAAM,MAAM,KAAK,KAAK,KAAK;KAC7B;AACF,SAAM;IACR;MAEF,KAAI,IAAI,MAAM;;;;;;;;CAY9B,qBAAsB,KAAoB;AACtC,MAAI,IAAK,KAAK,QAAQ,gBAAgB,oBAA4C;;;;;;;;CAStF,MAAO,KAAc,MAAoB;AACrC,MAAI,OAAO,YAAY;AACnB,UAAO,IAAI,CACP,CAAC,wBAAwB,QAAQ,EACjC,CAAC,oBAAoB,QAAQ,OAAO,CACvC,EAAE,IAAI;IACT"}
1
+ {"version":3,"file":"index.js","names":["ClearRouter"],"sources":["../src/error-handler.ts","../src/Router.ts","../src/index.ts"],"sourcesContent":["import {\n ErrorHandler,\n renderError,\n} from '@arkstack/common'\n\nimport type { ErrorRequestHandler } from 'express'\n\nexport const defaultErrorHandler: ErrorRequestHandler = (err, req, res, next) => {\n const responseBody = ErrorHandler.createErrorPayload(err)\n\n if (ErrorHandler.shouldLogError(err)) {\n ErrorHandler.logUnhandledError(err, {\n headers: req.headers,\n method: req.method,\n url: req.originalUrl || req.url,\n }, 'Unhandled Express request error')\n }\n\n if (process.env.NODE_ENV === 'development') console.error(responseBody)\n\n if (res.headersSent) {\n next(err)\n\n return\n }\n\n const acceptsHeader = Array.isArray(req.headers.accept) ? req.headers.accept.join(',') : req.headers.accept ?? ''\n const expectsJson = acceptsHeader.includes('application/json') || req.originalUrl.startsWith('/api/')\n const code = ErrorHandler.normalizeStatusCode(responseBody.code)\n\n if (expectsJson) {\n res.status(code).json(responseBody)\n\n return\n }\n\n res.status(code).setHeader('Content-Type', 'text/html').send(renderError({\n message: String(responseBody.message),\n stack: typeof responseBody.stack === 'string' ? responseBody.stack : undefined,\n code,\n }))\n}\n\nexport default defaultErrorHandler\n","import { RequestException, importFile } from '@arkstack/common'\nimport express, { Router as ExpressRouter } from 'express'\n\nimport { ArkstackRouteListOptions } from '@arkstack/contract'\nimport { Router as ClearRouter } from 'clear-router/express'\nimport { type Route } from 'clear-router'\nimport { clearRouterExpressPlugin } from '@resora/plugin-clear-router'\nimport { join } from 'node:path'\nimport { registerPlugin } from 'resora'\nimport type { Handler, HttpContext, Middleware } from 'clear-router/types/express'\n\nregisterPlugin(clearRouterExpressPlugin)\n\nexport class Router extends ClearRouter {\n static async bind (): Promise<ExpressRouter> {\n const router = express.Router()\n\n // Register API routes\n await ClearRouter.group('/api', async () => {\n await importFile(join(process.cwd(), 'src/routes/api.ts'))\n })\n\n // Register web routes\n await ClearRouter.group('/', async () => {\n await importFile(join(process.cwd(), 'src/routes/web.ts'))\n })\n\n // Apply the registered routes to the Express application\n ClearRouter.apply(router)\n\n // Handle unmatched routes\n router.all('/*splat', (req, _res, next) => {\n const url = req.originalUrl || req.url\n next(new RequestException(`Cannot find any route matching [${req.method}] ${url}`, 404))\n })\n\n return router\n }\n\n static async list (\n _options: ArkstackRouteListOptions = {}\n ): Promise<Array<Route<HttpContext, Middleware, Handler>>> {\n await this.bind()\n\n return this.allRoutes()\n }\n}\n","import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { Logger } from '@arkstack/common'\nimport { defaultErrorHandler } from './error-handler'\n\nexport interface ExpressDriverOptions {\n bindRouter: (app: Express) => PromiseOrValue<void>;\n mountPublicAssets?: (app: Express, publicPath: string) => PromiseOrValue<void>;\n errorHandler?: ErrorRequestHandler | Handler;\n}\n\n/**\n * The ExpressDriver class implements the ArkstackKitDriver \n * contract for the Express framework.\n */\nexport class ExpressDriver extends ArkstackKitDriver<Express, Handler> {\n readonly name = 'express'\n private readonly options: ExpressDriverOptions\n\n /**\n * Creates an instance of ExpressDriver.\n * \n * @param options \n */\n constructor(options: ExpressDriverOptions) {\n super()\n this.options = options\n }\n\n /**\n * Creates an Express application instance.\n * \n * @returns \n */\n createApp (): Express {\n return express()\n }\n\n /**\n * Mounts static assets from the specified public path to the Express application.\n * \n * @param app \n * @param publicPath \n */\n mountPublicAssets (app: Express, publicPath: string): PromiseOrValue<void> {\n if (this.options.mountPublicAssets) {\n return this.options.mountPublicAssets(app, publicPath)\n }\n\n app.use(express.static(publicPath, {\n maxAge: '1y',\n immutable: true,\n setHeaders: (res) => {\n res.setHeader('Access-Control-Allow-Origin', '*')\n res.setHeader('Access-Control-Allow-Methods', 'GET, HEAD, OPTIONS')\n res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization')\n },\n }))\n }\n\n /**\n * Binds the router to the Express application using the provided bindRouter function.\n * \n * @param app \n */\n bindRouter (app: Express): PromiseOrValue<void> {\n return this.options.bindRouter(app)\n }\n\n /**\n * Applies middleware to the Express application.\n * \n * @param app \n * @param middleware \n */\n applyMiddleware (\n app: Express,\n middleware: Handler | ArkstackMiddlewareConfig<Handler>,\n ): void {\n if (typeof middleware === 'function') {\n app.use(middleware)\n\n return\n }\n\n for (const [pos, entries] of Object.entries(middleware) as [string, Handler[]][]) {\n for (const entry of entries) {\n if (pos === 'after') {\n app.use(async (req, res, next) => {\n res.once('finish', async () => {\n await entry(req, res, next)\n })\n next()\n })\n } else {\n app.use(entry)\n }\n }\n }\n }\n\n /**\n * Registers an error handler middleware to the Express \n * application if provided in the options.\n * \n * @param app \n */\n registerErrorHandler (app: Express): void {\n app.use((this.options.errorHandler ?? defaultErrorHandler) as ErrorRequestHandler)\n }\n\n /**\n * Starts the Express server on the specified port.\n * \n * @param app \n * @param port \n */\n start (app: Express, port: number): void {\n app.listen(port, () => {\n Logger.log([\n ['Server is running on', 'white'],\n [`http://localhost:${port}`, 'cyan']\n ], ' ')\n })\n }\n}\n\nexport * from './error-handler'\nexport * from './Router'\n"],"mappings":";;;;;;;;;AAOA,MAAa,uBAA4C,KAAK,KAAK,KAAK,SAAS;CAC7E,MAAM,eAAe,aAAa,mBAAmB,IAAI;AAEzD,KAAI,aAAa,eAAe,IAAI,CAChC,cAAa,kBAAkB,KAAK;EAChC,SAAS,IAAI;EACb,QAAQ,IAAI;EACZ,KAAK,IAAI,eAAe,IAAI;EAC/B,EAAE,kCAAkC;AAGzC,KAAI,QAAQ,IAAI,aAAa,cAAe,SAAQ,MAAM,aAAa;AAEvE,KAAI,IAAI,aAAa;AACjB,OAAK,IAAI;AAET;;CAIJ,MAAM,eADgB,MAAM,QAAQ,IAAI,QAAQ,OAAO,GAAG,IAAI,QAAQ,OAAO,KAAK,IAAI,GAAG,IAAI,QAAQ,UAAU,IAC7E,SAAS,mBAAmB,IAAI,IAAI,YAAY,WAAW,QAAQ;CACrG,MAAM,OAAO,aAAa,oBAAoB,aAAa,KAAK;AAEhE,KAAI,aAAa;AACb,MAAI,OAAO,KAAK,CAAC,KAAK,aAAa;AAEnC;;AAGJ,KAAI,OAAO,KAAK,CAAC,UAAU,gBAAgB,YAAY,CAAC,KAAK,YAAY;EACrE,SAAS,OAAO,aAAa,QAAQ;EACrC,OAAO,OAAO,aAAa,UAAU,WAAW,aAAa,QAAQ;EACrE;EACH,CAAC,CAAC;;;;;AC7BP,eAAe,yBAAyB;AAExC,IAAa,SAAb,cAA4BA,SAAY;CACtC,aAAa,OAAgC;EAC3C,MAAM,SAAS,QAAQ,QAAQ;AAG/B,QAAMA,SAAY,MAAM,QAAQ,YAAY;AAC1C,SAAM,WAAW,KAAK,QAAQ,KAAK,EAAE,oBAAoB,CAAC;IAC1D;AAGF,QAAMA,SAAY,MAAM,KAAK,YAAY;AACvC,SAAM,WAAW,KAAK,QAAQ,KAAK,EAAE,oBAAoB,CAAC;IAC1D;AAGF,WAAY,MAAM,OAAO;AAGzB,SAAO,IAAI,YAAY,KAAK,MAAM,SAAS;GACzC,MAAM,MAAM,IAAI,eAAe,IAAI;AACnC,QAAK,IAAI,iBAAiB,mCAAmC,IAAI,OAAO,IAAI,OAAO,IAAI,CAAC;IACxF;AAEF,SAAO;;CAGT,aAAa,KACX,WAAqC,EAAE,EACkB;AACzD,QAAM,KAAK,MAAM;AAEjB,SAAO,KAAK,WAAW;;;;;;;;;;AC5B3B,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA+B;AACvC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAsB;AAClB,SAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0C;AACvE,MAAI,KAAK,QAAQ,kBACb,QAAO,KAAK,QAAQ,kBAAkB,KAAK,WAAW;AAG1D,MAAI,IAAI,QAAQ,OAAO,YAAY;GAC/B,QAAQ;GACR,WAAW;GACX,aAAa,QAAQ;AACjB,QAAI,UAAU,+BAA+B,IAAI;AACjD,QAAI,UAAU,gCAAgC,qBAAqB;AACnE,QAAI,UAAU,gCAAgC,8BAA8B;;GAEnF,CAAC,CAAC;;;;;;;CAQP,WAAY,KAAoC;AAC5C,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBACI,KACA,YACI;AACJ,MAAI,OAAO,eAAe,YAAY;AAClC,OAAI,IAAI,WAAW;AAEnB;;AAGJ,OAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,CACnD,MAAK,MAAM,SAAS,QAChB,KAAI,QAAQ,QACR,KAAI,IAAI,OAAO,KAAK,KAAK,SAAS;AAC9B,OAAI,KAAK,UAAU,YAAY;AAC3B,UAAM,MAAM,KAAK,KAAK,KAAK;KAC7B;AACF,SAAM;IACR;MAEF,KAAI,IAAI,MAAM;;;;;;;;CAY9B,qBAAsB,KAAoB;AACtC,MAAI,IAAK,KAAK,QAAQ,gBAAgB,oBAA4C;;;;;;;;CAStF,MAAO,KAAc,MAAoB;AACrC,MAAI,OAAO,YAAY;AACnB,UAAO,IAAI,CACP,CAAC,wBAAwB,QAAQ,EACjC,CAAC,oBAAoB,QAAQ,OAAO,CACvC,EAAE,IAAI;IACT"}
@@ -1,12 +1,6 @@
1
1
  import { Handler, NextFunction, Request, Response } from "express";
2
- import { User } from "@arkstack/auth";
3
2
 
4
3
  //#region src/middlewares/auth.d.ts
5
- type AuthenticatedExpressRequest<TUser extends User = User> = Request & {
6
- user?: TUser;
7
- authUser?: TUser;
8
- authToken?: string;
9
- };
10
4
  declare const auth: Handler;
11
5
  //#endregion
12
6
  //#region src/middlewares/request-logger.d.ts
@@ -16,5 +10,5 @@ declare const requestLogger: ({
16
10
  allowInProduction?: boolean;
17
11
  }) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
18
12
  //#endregion
19
- export { AuthenticatedExpressRequest, auth, requestLogger };
13
+ export { auth, requestLogger };
20
14
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","names":[],"sources":["../../src/middlewares/auth.ts","../../src/middlewares/request-logger.ts"],"mappings":";;;cAKa,IAAA,EAAM,OAAA;;;cCaN,aAAA;EAAiB;AAAA;EAG1B,iBAAA;AAAA,OACc,GAAA,EAAK,OAAA,EAAS,GAAA,EAAK,QAAA,EAAU,IAAA,EAAM,YAAA,KAAY,OAAA"}
@@ -1,21 +1,32 @@
1
- import { Logger, nodeEnv } from "@arkstack/common";
1
+ import { Hook, Logger, nodeEnv } from "@arkstack/common";
2
2
  import { Auth, AuthenticationException } from "@arkstack/auth";
3
3
 
4
4
  //#region src/middlewares/auth.ts
5
- const auth = async (req, _res, next) => {
5
+ const auth = async (req, res, next) => {
6
6
  try {
7
+ if (Hook.has("middleware:auth", "before")) Hook.get("middleware:auth", "before")?.({
8
+ req,
9
+ res
10
+ });
7
11
  const token = readBearerToken(req.headers.authorization);
8
12
  if (!token) throw new AuthenticationException("Unauthenticated", {
9
13
  req,
10
14
  status: 401
11
15
  });
12
16
  const user = await Auth.make().setRequest(req).authorizeToken(token);
13
- const request = req;
14
- request.user = user;
15
- request.authUser = user;
16
- request.authToken = token;
17
+ req.user = user;
18
+ req.authUser = user;
19
+ req.authToken = token;
20
+ if (Hook.has("middleware:auth", "after")) Hook.get("middleware:auth", "after")?.({
21
+ req,
22
+ res
23
+ });
17
24
  next();
18
25
  } catch (error) {
26
+ if (Hook.has("middleware:auth", "error")) Hook.get("middleware:auth", "error")?.(error, {
27
+ req,
28
+ res
29
+ });
19
30
  next(error);
20
31
  }
21
32
  };
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/auth.ts","../../src/middlewares/request-logger.ts"],"sourcesContent":["import type { Handler, Request as ExpressRequest } from 'express'\nimport { Auth, AuthenticationException, type User } from '@arkstack/auth'\n\nexport type AuthenticatedExpressRequest<TUser extends User = User> = ExpressRequest & {\n user?: TUser;\n authUser?: TUser;\n authToken?: string;\n}\n\nexport const auth: Handler = async (req, _res, next) => {\n try {\n const token = readBearerToken(req.headers.authorization)\n\n if (!token) {\n throw new AuthenticationException('Unauthenticated', { req, status: 401 })\n }\n\n const user = await Auth.make().setRequest(req).authorizeToken(token)\n const request = req as AuthenticatedExpressRequest\n\n request.user = user\n request.authUser = user\n request.authToken = token\n\n next()\n } catch (error) {\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 { 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":";;;;AASA,MAAa,OAAgB,OAAO,KAAK,MAAM,SAAS;AACpD,KAAI;EACA,MAAM,QAAQ,gBAAgB,IAAI,QAAQ,cAAc;AAExD,MAAI,CAAC,MACD,OAAM,IAAI,wBAAwB,mBAAmB;GAAE;GAAK,QAAQ;GAAK,CAAC;EAG9E,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,CAAC,eAAe,MAAM;EACpE,MAAM,UAAU;AAEhB,UAAQ,OAAO;AACf,UAAQ,WAAW;AACnB,UAAQ,YAAY;AAEpB,QAAM;UACD,OAAO;AACZ,OAAK,MAAM;;;AAInB,MAAM,mBAAmB,kBAAiD;CACtE,MAAM,QAAQ,MAAM,QAAQ,cAAc,GAAG,cAAc,KAAK;AAEhE,KAAI,CAAC,OAAO,WAAW,UAAU,CAC7B,QAAO;AAGX,QAAO,MAAM,UAAU,EAAE;;;;;AClC7B,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;AAClE,KAAI,SAAS,KAAK,UAAU,CAAC,kBAAmB,QAAO,MAAM;CAE7D,MAAM,QAAQ,KAAK,KAAK;CAExB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,QAAO,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;AAEP,OAAM"}
1
+ {"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/auth.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 user = await Auth.make().setRequest(req).authorizeToken(token)\n\n req.user = user\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 { 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;AACnD,KAAI;AACA,MAAI,KAAK,IAAI,mBAAmB,SAAS,CACrC,MAAK,IAAI,mBAAmB,SAAS,GAAG;GAAE;GAAK;GAAK,CAAC;EAEzD,MAAM,QAAQ,gBAAgB,IAAI,QAAQ,cAAc;AAExD,MAAI,CAAC,MACD,OAAM,IAAI,wBAAwB,mBAAmB;GAAE;GAAK,QAAQ;GAAK,CAAC;EAG9E,MAAM,OAAO,MAAM,KAAK,MAAM,CAAC,WAAW,IAAI,CAAC,eAAe,MAAM;AAEpE,MAAI,OAAO;AACX,MAAI,WAAW;AACf,MAAI,YAAY;AAEhB,MAAI,KAAK,IAAI,mBAAmB,QAAQ,CACpC,MAAK,IAAI,mBAAmB,QAAQ,GAAG;GAAE;GAAK;GAAK,CAAC;AAExD,QAAM;UACD,OAAO;AACZ,MAAI,KAAK,IAAI,mBAAmB,QAAQ,CACpC,MAAK,IAAI,mBAAmB,QAAQ,GAAG,OAAO;GAAE;GAAK;GAAK,CAAC;AAE/D,OAAK,MAAM;;;AAInB,MAAM,mBAAmB,kBAAiD;CACtE,MAAM,QAAQ,MAAM,QAAQ,cAAc,GAAG,cAAc,KAAK;AAEhE,KAAI,CAAC,OAAO,WAAW,UAAU,CAC7B,QAAO;AAGX,QAAO,MAAM,UAAU,EAAE;;;;;ACtC7B,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;AAClE,KAAI,SAAS,KAAK,UAAU,CAAC,kBAAmB,QAAO,MAAM;CAE7D,MAAM,QAAQ,KAAK,KAAK;CAExB,MAAM,SAAS,IAAI,cAAc;CACjC,MAAM,WAAW,KAAK,KAAK,GAAG;AAC9B,QAAO,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;AAEP,OAAM"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arkstack/driver-express",
3
- "version": "0.3.16",
3
+ "version": "0.4.0",
4
4
  "type": "module",
5
5
  "description": "Express driver package for Arkstack providing Express-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
6
6
  "homepage": "https://arkstack.toneflix.net",
@@ -36,13 +36,16 @@
36
36
  "./package.json": "./package.json"
37
37
  },
38
38
  "dependencies": {
39
+ "clear-router": "^2.5.4",
39
40
  "express-rate-limit": "^8.4.1",
40
- "@arkstack/contract": "^0.3.16"
41
+ "@resora/plugin-clear-router": "^1.0.3",
42
+ "resora": "^1.2.0",
43
+ "@arkstack/contract": "^0.4.0"
41
44
  },
42
45
  "peerDependencies": {
43
46
  "express": "^5.2.1",
44
- "@arkstack/auth": "^0.3.16",
45
- "@arkstack/common": "^0.3.16"
47
+ "@arkstack/auth": "^0.4.0",
48
+ "@arkstack/common": "^0.4.0"
46
49
  },
47
50
  "peerDependenciesMeta": {
48
51
  "@arkstack/auth": {