@arkstack/driver-express 0.3.10 → 0.3.11

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 (4) hide show
  1. package/dist/index.d.ts +4 -1
  2. package/dist/index.js +30 -3
  3. package/dist/index.js.map +1 -1
  4. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -1,6 +1,9 @@
1
1
  import { ErrorRequestHandler, Express, Handler } from "express";
2
2
  import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from "@arkstack/contract";
3
3
 
4
+ //#region src/error-handler.d.ts
5
+ declare const defaultErrorHandler: ErrorRequestHandler;
6
+ //#endregion
4
7
  //#region src/index.d.ts
5
8
  interface ExpressDriverOptions {
6
9
  bindRouter: (app: Express) => PromiseOrValue<void>;
@@ -19,5 +22,5 @@ declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
19
22
  start(app: Express, port: number): void;
20
23
  }
21
24
  //#endregion
22
- export { ExpressDriver, ExpressDriverOptions };
25
+ export { ExpressDriver, ExpressDriverOptions, defaultErrorHandler };
23
26
  //# sourceMappingURL=index.d.ts.map
package/dist/index.js CHANGED
@@ -1,7 +1,34 @@
1
1
  import express from "express";
2
2
  import { ArkstackKitDriver } from "@arkstack/contract";
3
- import { Logger } from "@arkstack/common";
3
+ import { Logger, buildHtmlErrorResponse, createErrorPayload, logUnhandledError, normalizeStatusCode, shouldLogError } from "@arkstack/common";
4
4
 
5
+ //#region src/error-handler.ts
6
+ const defaultErrorHandler = (err, req, res, next) => {
7
+ const responseBody = createErrorPayload(err);
8
+ if (shouldLogError(err)) logUnhandledError(err, {
9
+ headers: req.headers,
10
+ method: req.method,
11
+ url: req.originalUrl || req.url
12
+ }, "Unhandled Express request error");
13
+ if (process.env.NODE_ENV === "development") console.error(responseBody);
14
+ if (res.headersSent) {
15
+ next(err);
16
+ return;
17
+ }
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);
20
+ if (expectsJson) {
21
+ res.status(code).json(responseBody);
22
+ return;
23
+ }
24
+ res.status(code).setHeader("Content-Type", "text/html").send(buildHtmlErrorResponse({
25
+ message: String(responseBody.message),
26
+ stack: typeof responseBody.stack === "string" ? responseBody.stack : void 0,
27
+ code
28
+ }));
29
+ };
30
+
31
+ //#endregion
5
32
  //#region src/index.ts
6
33
  /**
7
34
  * The ExpressDriver class implements the ArkstackKitDriver
@@ -79,7 +106,7 @@ var ExpressDriver = class extends ArkstackKitDriver {
79
106
  * @param app
80
107
  */
81
108
  registerErrorHandler(app) {
82
- if (this.options.errorHandler) app.use(this.options.errorHandler);
109
+ app.use(this.options.errorHandler ?? defaultErrorHandler);
83
110
  }
84
111
  /**
85
112
  * Starts the Express server on the specified port.
@@ -95,5 +122,5 @@ var ExpressDriver = class extends ArkstackKitDriver {
95
122
  };
96
123
 
97
124
  //#endregion
98
- export { ExpressDriver };
125
+ export { ExpressDriver, defaultErrorHandler };
99
126
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { Logger } from '@arkstack/common'\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 if (this.options.errorHandler) {\n app.use(this.options.errorHandler as ErrorRequestHandler)\n }\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"],"mappings":";;;;;;;;;AAeA,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,KAAK,QAAQ,aACb,KAAI,IAAI,KAAK,QAAQ,aAAoC;;;;;;;;CAUjE,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 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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arkstack/driver-express",
3
- "version": "0.3.10",
3
+ "version": "0.3.11",
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,11 @@
36
36
  "./package.json": "./package.json"
37
37
  },
38
38
  "dependencies": {
39
- "@arkstack/contract": "^0.3.10"
39
+ "@arkstack/contract": "^0.3.11"
40
40
  },
41
41
  "peerDependencies": {
42
42
  "express": "^5.2.1",
43
- "@arkstack/common": "^0.3.10"
43
+ "@arkstack/common": "^0.3.11"
44
44
  },
45
45
  "devDependencies": {
46
46
  "@types/express": "^5.0.6"