@arkstack/driver-express 0.3.12 → 0.3.15

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
@@ -1,3 +1,19 @@
1
1
  # @arkstack/driver-express
2
2
 
3
3
  Express driver package for Arkstack, providing Express-specific implementations of core Arkstack features such as routing, middleware, and database integration.
4
+
5
+ ## Auth Middleware
6
+
7
+ ```ts
8
+ import { auth, type AuthenticatedExpressRequest } from '@arkstack/driver-express/middlewares';
9
+
10
+ app.use('/account', auth, (req, res) => {
11
+ const request = req as AuthenticatedExpressRequest;
12
+
13
+ res.json({
14
+ user: request.authUser,
15
+ });
16
+ });
17
+ ```
18
+
19
+ The middleware expects `Authorization: Bearer <token>` and attaches `user`, `authUser`, and `authToken` to the request.
package/dist/index.js CHANGED
@@ -1,11 +1,11 @@
1
1
  import express from "express";
2
2
  import { ArkstackKitDriver } from "@arkstack/contract";
3
- import { Logger, buildHtmlErrorResponse, createErrorPayload, logUnhandledError, normalizeStatusCode, shouldLogError } from "@arkstack/common";
3
+ import { ErrorHandler, Logger, buildHtmlErrorResponse } from "@arkstack/common";
4
4
 
5
5
  //#region src/error-handler.ts
6
6
  const defaultErrorHandler = (err, req, res, next) => {
7
- const responseBody = createErrorPayload(err);
8
- if (shouldLogError(err)) logUnhandledError(err, {
7
+ const responseBody = ErrorHandler.createErrorPayload(err);
8
+ if (ErrorHandler.shouldLogError(err)) ErrorHandler.logUnhandledError(err, {
9
9
  headers: req.headers,
10
10
  method: req.method,
11
11
  url: req.originalUrl || req.url
@@ -16,7 +16,7 @@ const defaultErrorHandler = (err, req, res, next) => {
16
16
  return;
17
17
  }
18
18
  const expectsJson = (Array.isArray(req.headers.accept) ? req.headers.accept.join(",") : req.headers.accept ?? "").includes("application/json") || req.originalUrl.startsWith("/api/");
19
- const code = normalizeStatusCode(responseBody.code);
19
+ const code = ErrorHandler.normalizeStatusCode(responseBody.code);
20
20
  if (expectsJson) {
21
21
  res.status(code).json(responseBody);
22
22
  return;
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 createErrorPayload,\n logUnhandledError,\n normalizeStatusCode,\n shouldLogError,\n} from '@arkstack/common'\n\nimport type { ErrorRequestHandler } from 'express'\n\nexport const defaultErrorHandler: ErrorRequestHandler = (err, req, res, next) => {\n const responseBody = createErrorPayload(err)\n\n if (shouldLogError(err)) {\n 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 = 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","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":";;;;;AAUA,MAAa,uBAA4C,KAAK,KAAK,KAAK,SAAS;CAC7E,MAAM,eAAe,mBAAmB,IAAI;AAE5C,KAAI,eAAe,IAAI,CACnB,mBAAkB,KAAK;EACnB,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,oBAAoB,aAAa,KAAK;AAEnD,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;;;;;;;;;AC3BP,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":[],"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,5 +1,14 @@
1
- import { NextFunction, Request, Response } from "express";
1
+ import { Handler, NextFunction, Request, Response } from "express";
2
+ import { User } from "@arkstack/auth";
2
3
 
4
+ //#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
+ declare const auth: Handler;
11
+ //#endregion
3
12
  //#region src/middlewares/request-logger.d.ts
4
13
  declare const requestLogger: ({
5
14
  allowInProduction
@@ -7,5 +16,5 @@ declare const requestLogger: ({
7
16
  allowInProduction?: boolean;
8
17
  }) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
9
18
  //#endregion
10
- export { requestLogger };
19
+ export { AuthenticatedExpressRequest, auth, requestLogger };
11
20
  //# sourceMappingURL=index.d.ts.map
@@ -1,5 +1,31 @@
1
1
  import { Logger, nodeEnv } from "@arkstack/common";
2
+ import { Auth, AuthenticationException } from "@arkstack/auth";
2
3
 
4
+ //#region src/middlewares/auth.ts
5
+ const auth = async (req, _res, next) => {
6
+ try {
7
+ const token = readBearerToken(req.headers.authorization);
8
+ if (!token) throw new AuthenticationException("Unauthenticated", {
9
+ req,
10
+ status: 401
11
+ });
12
+ 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
+ next();
18
+ } catch (error) {
19
+ next(error);
20
+ }
21
+ };
22
+ const readBearerToken = (authorization) => {
23
+ const value = Array.isArray(authorization) ? authorization[0] : authorization;
24
+ if (!value?.startsWith("Bearer ")) return null;
25
+ return value.substring(7);
26
+ };
27
+
28
+ //#endregion
3
29
  //#region src/middlewares/request-logger.ts
4
30
  const colors = {
5
31
  GET: "green",
@@ -30,5 +56,5 @@ const requestLogger = ({ allowInProduction = false } = {}) => async (req, res, n
30
56
  };
31
57
 
32
58
  //#endregion
33
- export { requestLogger };
59
+ export { auth, requestLogger };
34
60
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/request-logger.ts"],"sourcesContent":["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":";;;AAGA,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 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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arkstack/driver-express",
3
- "version": "0.3.12",
3
+ "version": "0.3.15",
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,11 +36,18 @@
36
36
  "./package.json": "./package.json"
37
37
  },
38
38
  "dependencies": {
39
- "@arkstack/contract": "^0.3.12"
39
+ "express-rate-limit": "^8.4.1",
40
+ "@arkstack/contract": "^0.3.15"
40
41
  },
41
42
  "peerDependencies": {
42
43
  "express": "^5.2.1",
43
- "@arkstack/common": "^0.3.12"
44
+ "@arkstack/auth": "^0.3.15",
45
+ "@arkstack/common": "^0.3.15"
46
+ },
47
+ "peerDependenciesMeta": {
48
+ "@arkstack/auth": {
49
+ "optional": true
50
+ }
44
51
  },
45
52
  "devDependencies": {
46
53
  "@types/express": "^5.0.6"