@arkstack/driver-h3 0.3.10 → 0.3.11

package/dist/error-handler-nV_ImqPa.d.ts

@@ -0,0 +1,14 @@
+import { H3Event, HTTPError, HTTPResponse } from "h3";
+
+//#region src/error-handler.d.ts
+declare const defaultErrorHandler: (err: HTTPError | Error | string, event: H3Event) => HTTPResponse | {
+  error: boolean;
+  message: string;
+  status: "error";
+  code: number;
+  errors?: unknown;
+  stack?: string;
+};
+//#endregion
+export { defaultErrorHandler as t };
+//# sourceMappingURL=error-handler-nV_ImqPa.d.ts.map

package/dist/index.d.ts

@@ -1,5 +1,6 @@
+import { t as defaultErrorHandler } from "./error-handler-nV_ImqPa.js";
 import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from "@arkstack/contract";
-import { H3 } from "h3";
+import { H3, H3Event } from "h3";
 import { Middleware } from "clear-router/types/h3";
 
 //#region src/index.d.ts
@@ -8,6 +9,7 @@ interface H3DriverOptions {
   bindRouter: (app: H3) => PromiseOrValue<void>;
   mountPublicAssets?: (app: H3, publicPath: string) => PromiseOrValue<void>;
   createApp?: () => H3;
+  onError?: (err: Error | string, event: H3Event) => unknown;
 }
 declare class H3EventResponse {
   response: Response;
@@ -27,5 +29,5 @@ declare class H3Driver extends ArkstackKitDriver<H3, H3Middleware> {
   start(app: H3, port: number): void;
 }
 //#endregion
-export { H3Driver, H3DriverOptions, H3EventResponse, H3Middleware };
+export { H3Driver, H3DriverOptions, H3EventResponse, H3Middleware, defaultErrorHandler };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,8 +1,35 @@
 import { staticAssetHandler } from "./middlewares/index.js";
 import { ArkstackKitDriver } from "@arkstack/contract";
-import { H3, serve, toResponse } from "h3";
-import { Logger } from "@arkstack/common";
+import { H3, HTTPResponse, serve, toResponse } from "h3";
+import { Logger, buildHtmlErrorResponse, createErrorPayload, logUnhandledError, normalizeStatusCode, shouldLogError } from "@arkstack/common";
 
+//#region src/error-handler.ts
+const defaultErrorHandler = (err, event) => {
+	const responseBody = createErrorPayload(err);
+	if (shouldLogError(err)) logUnhandledError(err, {
+		headers: Object.fromEntries(event.req.headers.entries()),
+		method: event.req.method,
+		url: event.req.url
+	}, "Unhandled H3 request error");
+	if (process.env.NODE_ENV === "development") console.error(responseBody);
+	const code = normalizeStatusCode(responseBody.code);
+	event.res.status = code;
+	if ((event.req.headers.get("accept") ?? "").includes("application/json") || event.req._url?.pathname?.startsWith("/api")) return {
+		...responseBody,
+		error: true,
+		message: responseBody.message
+	};
+	return new HTTPResponse(buildHtmlErrorResponse({
+		message: String(responseBody.message),
+		stack: typeof responseBody.stack === "string" ? responseBody.stack : void 0,
+		code
+	}), {
+		status: code,
+		headers: { "Content-Type": "text/html" }
+	});
+};
+
+//#endregion
 //#region src/index.ts
 var H3EventResponse = class {
 	status = 200;
@@ -37,7 +64,7 @@ var H3Driver = class extends ArkstackKitDriver {
 	* @returns 
 	*/
 	createApp() {
-		return this.options.createApp?.() ?? new H3();
+		return this.options.createApp?.() ?? new H3({ onError: this.options.onError ?? defaultErrorHandler });
 	}
 	/**
 	* Mounts static assets from the specified public path to the H3 application.
@@ -98,5 +125,5 @@ var H3Driver = class extends ArkstackKitDriver {
 };
 
 //#endregion
-export { H3Driver, H3EventResponse };
+export { H3Driver, H3EventResponse, defaultErrorHandler };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { H3, serve, toResponse } from 'h3'\n\nimport { Middleware as H3BaseMiddleware } from 'clear-router/types/h3'\nimport { Logger } from '@arkstack/common'\nimport { staticAssetHandler } from './middlewares'\n\n// oxlint-disable-next-line typescript/no-explicit-any\nexport type H3Middleware = H3BaseMiddleware | [H3BaseMiddleware, Record<string, any>];\n\nexport interface H3DriverOptions {\n    bindRouter: (app: H3) => PromiseOrValue<void>;\n    mountPublicAssets?: (app: H3, publicPath: string) => PromiseOrValue<void>;\n    createApp?: () => H3;\n}\n\nexport class H3EventResponse {\n    status: number = 200\n    statusText?: string\n\n    constructor(public response: Response) {\n        this.status = response.status\n        this.statusText = response.statusText\n    }\n\n    get headers (): Headers {\n        return this.response.headers\n    }\n}\n\n/**\n * The H3Driver class implements the ArkstackKitDriver contract for the H3 framework.\n */\nexport class H3Driver extends ArkstackKitDriver<H3, H3Middleware> {\n    readonly name = 'h3'\n    private readonly options: H3DriverOptions\n\n    /**\n     * Creates an instance of H3Driver.\n     * \n     * @param options \n     */\n    constructor(options: H3DriverOptions) {\n        super()\n        this.options = options\n    }\n\n    /**\n     * Creates an H3 application instance.\n     * \n     * @returns \n     */\n    createApp (): H3 {\n        return this.options.createApp?.() ?? new H3()\n    }\n\n    /**\n     * Mounts static assets from the specified public path to the H3 application.\n     * \n     * @param app \n     * @param publicPath \n     */\n    mountPublicAssets (app: H3, publicPath: string): PromiseOrValue<void> {\n        if (this.options.mountPublicAssets) {\n            return this.options.mountPublicAssets(app, publicPath)\n        }\n\n        app.use(staticAssetHandler(publicPath))\n    }\n\n    /**\n     * Binds the router to the H3 application using the provided bindRouter function.\n     * \n     * @param app \n     */\n    bindRouter (app: H3): PromiseOrValue<void> {\n        return this.options.bindRouter(app)\n    }\n\n    /**\n     * Applies middleware to the H3 application.\n     * \n     * @param app \n     * @param middleware \n     */\n    applyMiddleware (\n        app: H3,\n        middleware: H3Middleware | ArkstackMiddlewareConfig<H3Middleware>,\n    ): void {\n        const mw = Array.isArray(middleware) ? middleware[0] : middleware\n        const conf = Array.isArray(middleware) && middleware[1] ? middleware[1] : {}\n\n        if (typeof mw === 'function') {\n            app.use(mw, conf)\n\n            return\n        }\n\n        for (const [pos, entries] of Object.entries(middleware) as [string, H3Middleware[]][]) {\n            for (const entry of entries) {\n                const mw = Array.isArray(entry) ? entry[0] : entry\n                const conf = Array.isArray(entry) && entry[1] ? entry[1] : {}\n\n                if (pos === 'after') {\n                    app.use(async (evt, next) => {\n                        const response = await toResponse(await next(), evt)\n                        // evt.res.status = response.status\n                        evt[Symbol.for('h3.internal.event.res') as never] = new H3EventResponse(response) as never\n                        await mw(evt, next)\n                        next()\n                    }, conf)\n                } else {\n                    app.use(mw, conf)\n                }\n            }\n        }\n    }\n\n    /**\n     * Starts the H3 server on the specified port.\n     * \n     * @param app \n     * @param port \n     */\n    start (app: H3, port: number): void {\n        serve(app, { port, silent: true }).ready().then(() => {\n            Logger.log([\n                ['Server is running on', 'white'],\n                [`http://localhost:${port}`, 'cyan']\n            ], ' ')\n        })\n    }\n}\n"],"mappings":";;;;;;AAgBA,IAAa,kBAAb,MAA6B;CACzB,SAAiB;CACjB;CAEA,YAAY,AAAO,UAAoB;EAApB;AACf,OAAK,SAAS,SAAS;AACvB,OAAK,aAAa,SAAS;;CAG/B,IAAI,UAAoB;AACpB,SAAO,KAAK,SAAS;;;;;;AAO7B,IAAa,WAAb,cAA8B,kBAAoC;CAC9D,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA0B;AAClC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAiB;AACb,SAAO,KAAK,QAAQ,aAAa,IAAI,IAAI,IAAI;;;;;;;;CASjD,kBAAmB,KAAS,YAA0C;AAClE,MAAI,KAAK,QAAQ,kBACb,QAAO,KAAK,QAAQ,kBAAkB,KAAK,WAAW;AAG1D,MAAI,IAAI,mBAAmB,WAAW,CAAC;;;;;;;CAQ3C,WAAY,KAA+B;AACvC,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBACI,KACA,YACI;EACJ,MAAM,KAAK,MAAM,QAAQ,WAAW,GAAG,WAAW,KAAK;EACvD,MAAM,OAAO,MAAM,QAAQ,WAAW,IAAI,WAAW,KAAK,WAAW,KAAK,EAAE;AAE5E,MAAI,OAAO,OAAO,YAAY;AAC1B,OAAI,IAAI,IAAI,KAAK;AAEjB;;AAGJ,OAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,CACnD,MAAK,MAAM,SAAS,SAAS;GACzB,MAAM,KAAK,MAAM,QAAQ,MAAM,GAAG,MAAM,KAAK;GAC7C,MAAM,OAAO,MAAM,QAAQ,MAAM,IAAI,MAAM,KAAK,MAAM,KAAK,EAAE;AAE7D,OAAI,QAAQ,QACR,KAAI,IAAI,OAAO,KAAK,SAAS;AAGzB,QAAI,OAAO,IAAI,wBAAwB,IAAa,IAAI,gBAFvC,MAAM,WAAW,MAAM,MAAM,EAAE,IAAI,CAE6B;AACjF,UAAM,GAAG,KAAK,KAAK;AACnB,UAAM;MACP,KAAK;OAER,KAAI,IAAI,IAAI,KAAK;;;;;;;;;CAYjC,MAAO,KAAS,MAAoB;AAChC,QAAM,KAAK;GAAE;GAAM,QAAQ;GAAM,CAAC,CAAC,OAAO,CAAC,WAAW;AAClD,UAAO,IAAI,CACP,CAAC,wBAAwB,QAAQ,EACjC,CAAC,oBAAoB,QAAQ,OAAO,CACvC,EAAE,IAAI;IACT"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/error-handler.ts","../src/index.ts"],"sourcesContent":["import { H3Event, HTTPError, HTTPResponse } from 'h3'\nimport {\n    buildHtmlErrorResponse,\n    createErrorPayload,\n    logUnhandledError,\n    normalizeStatusCode,\n    shouldLogError,\n} from '@arkstack/common'\n\nexport const defaultErrorHandler = (err: HTTPError | Error | string, event: H3Event) => {\n    const responseBody = createErrorPayload(err)\n\n    if (shouldLogError(err)) {\n        logUnhandledError(err, {\n            headers: Object.fromEntries(event.req.headers.entries()),\n            method: event.req.method,\n            url: event.req.url,\n        }, 'Unhandled H3 request error')\n    }\n\n    if (process.env.NODE_ENV === 'development') console.error(responseBody)\n\n    const code = normalizeStatusCode(responseBody.code)\n    event.res.status = code\n\n    const acceptsHeader = event.req.headers.get('accept') ?? ''\n    const expectsJson = acceptsHeader.includes('application/json') || event.req._url?.pathname?.startsWith('/api')\n\n    if (expectsJson) {\n        return {\n            ...responseBody,\n            error: true,\n            message: responseBody.message,\n        }\n    }\n\n    return new HTTPResponse(buildHtmlErrorResponse({\n        message: String(responseBody.message),\n        stack: typeof responseBody.stack === 'string' ? responseBody.stack : undefined,\n        code,\n    }), {\n        status: code,\n        headers: {\n            'Content-Type': 'text/html',\n        },\n    })\n}\n\nexport default defaultErrorHandler","import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from '@arkstack/contract'\nimport { H3, H3Event, serve, toResponse } from 'h3'\n\nimport { Middleware as H3BaseMiddleware } from 'clear-router/types/h3'\nimport { Logger } from '@arkstack/common'\nimport { defaultErrorHandler } from './error-handler'\nimport { staticAssetHandler } from './middlewares'\n\n// oxlint-disable-next-line typescript/no-explicit-any\nexport type H3Middleware = H3BaseMiddleware | [H3BaseMiddleware, Record<string, any>];\n\nexport interface H3DriverOptions {\n    bindRouter: (app: H3) => PromiseOrValue<void>;\n    mountPublicAssets?: (app: H3, publicPath: string) => PromiseOrValue<void>;\n    createApp?: () => H3;\n    onError?: (err: Error | string, event: H3Event) => unknown;\n}\n\nexport class H3EventResponse {\n    status: number = 200\n    statusText?: string\n\n    constructor(public response: Response) {\n        this.status = response.status\n        this.statusText = response.statusText\n    }\n\n    get headers (): Headers {\n        return this.response.headers\n    }\n}\n\n/**\n * The H3Driver class implements the ArkstackKitDriver contract for the H3 framework.\n */\nexport class H3Driver extends ArkstackKitDriver<H3, H3Middleware> {\n    readonly name = 'h3'\n    private readonly options: H3DriverOptions\n\n    /**\n     * Creates an instance of H3Driver.\n     * \n     * @param options \n     */\n    constructor(options: H3DriverOptions) {\n        super()\n        this.options = options\n    }\n\n    /**\n     * Creates an H3 application instance.\n     * \n     * @returns \n     */\n    createApp (): H3 {\n        return this.options.createApp?.() ?? new H3({\n            onError: this.options.onError ?? defaultErrorHandler,\n        })\n    }\n\n    /**\n     * Mounts static assets from the specified public path to the H3 application.\n     * \n     * @param app \n     * @param publicPath \n     */\n    mountPublicAssets (app: H3, publicPath: string): PromiseOrValue<void> {\n        if (this.options.mountPublicAssets) {\n            return this.options.mountPublicAssets(app, publicPath)\n        }\n\n        app.use(staticAssetHandler(publicPath))\n    }\n\n    /**\n     * Binds the router to the H3 application using the provided bindRouter function.\n     * \n     * @param app \n     */\n    bindRouter (app: H3): PromiseOrValue<void> {\n        return this.options.bindRouter(app)\n    }\n\n    /**\n     * Applies middleware to the H3 application.\n     * \n     * @param app \n     * @param middleware \n     */\n    applyMiddleware (\n        app: H3,\n        middleware: H3Middleware | ArkstackMiddlewareConfig<H3Middleware>,\n    ): void {\n        const mw = Array.isArray(middleware) ? middleware[0] : middleware\n        const conf = Array.isArray(middleware) && middleware[1] ? middleware[1] : {}\n\n        if (typeof mw === 'function') {\n            app.use(mw, conf)\n\n            return\n        }\n\n        for (const [pos, entries] of Object.entries(middleware) as [string, H3Middleware[]][]) {\n            for (const entry of entries) {\n                const mw = Array.isArray(entry) ? entry[0] : entry\n                const conf = Array.isArray(entry) && entry[1] ? entry[1] : {}\n\n                if (pos === 'after') {\n                    app.use(async (evt, next) => {\n                        const response = await toResponse(await next(), evt)\n                        // evt.res.status = response.status\n                        evt[Symbol.for('h3.internal.event.res') as never] = new H3EventResponse(response) as never\n                        await mw(evt, next)\n                        next()\n                    }, conf)\n                } else {\n                    app.use(mw, conf)\n                }\n            }\n        }\n    }\n\n    /**\n     * Starts the H3 server on the specified port.\n     * \n     * @param app \n     * @param port \n     */\n    start (app: H3, port: number): void {\n        serve(app, { port, silent: true }).ready().then(() => {\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":";;;;;;AASA,MAAa,uBAAuB,KAAiC,UAAmB;CACpF,MAAM,eAAe,mBAAmB,IAAI;AAE5C,KAAI,eAAe,IAAI,CACnB,mBAAkB,KAAK;EACnB,SAAS,OAAO,YAAY,MAAM,IAAI,QAAQ,SAAS,CAAC;EACxD,QAAQ,MAAM,IAAI;EAClB,KAAK,MAAM,IAAI;EAClB,EAAE,6BAA6B;AAGpC,KAAI,QAAQ,IAAI,aAAa,cAAe,SAAQ,MAAM,aAAa;CAEvE,MAAM,OAAO,oBAAoB,aAAa,KAAK;AACnD,OAAM,IAAI,SAAS;AAKnB,MAHsB,MAAM,IAAI,QAAQ,IAAI,SAAS,IAAI,IACvB,SAAS,mBAAmB,IAAI,MAAM,IAAI,MAAM,UAAU,WAAW,OAAO,CAG1G,QAAO;EACH,GAAG;EACH,OAAO;EACP,SAAS,aAAa;EACzB;AAGL,QAAO,IAAI,aAAa,uBAAuB;EAC3C,SAAS,OAAO,aAAa,QAAQ;EACrC,OAAO,OAAO,aAAa,UAAU,WAAW,aAAa,QAAQ;EACrE;EACH,CAAC,EAAE;EACA,QAAQ;EACR,SAAS,EACL,gBAAgB,aACnB;EACJ,CAAC;;;;;AC3BN,IAAa,kBAAb,MAA6B;CACzB,SAAiB;CACjB;CAEA,YAAY,AAAO,UAAoB;EAApB;AACf,OAAK,SAAS,SAAS;AACvB,OAAK,aAAa,SAAS;;CAG/B,IAAI,UAAoB;AACpB,SAAO,KAAK,SAAS;;;;;;AAO7B,IAAa,WAAb,cAA8B,kBAAoC;CAC9D,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA0B;AAClC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAiB;AACb,SAAO,KAAK,QAAQ,aAAa,IAAI,IAAI,GAAG,EACxC,SAAS,KAAK,QAAQ,WAAW,qBACpC,CAAC;;;;;;;;CASN,kBAAmB,KAAS,YAA0C;AAClE,MAAI,KAAK,QAAQ,kBACb,QAAO,KAAK,QAAQ,kBAAkB,KAAK,WAAW;AAG1D,MAAI,IAAI,mBAAmB,WAAW,CAAC;;;;;;;CAQ3C,WAAY,KAA+B;AACvC,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBACI,KACA,YACI;EACJ,MAAM,KAAK,MAAM,QAAQ,WAAW,GAAG,WAAW,KAAK;EACvD,MAAM,OAAO,MAAM,QAAQ,WAAW,IAAI,WAAW,KAAK,WAAW,KAAK,EAAE;AAE5E,MAAI,OAAO,OAAO,YAAY;AAC1B,OAAI,IAAI,IAAI,KAAK;AAEjB;;AAGJ,OAAK,MAAM,CAAC,KAAK,YAAY,OAAO,QAAQ,WAAW,CACnD,MAAK,MAAM,SAAS,SAAS;GACzB,MAAM,KAAK,MAAM,QAAQ,MAAM,GAAG,MAAM,KAAK;GAC7C,MAAM,OAAO,MAAM,QAAQ,MAAM,IAAI,MAAM,KAAK,MAAM,KAAK,EAAE;AAE7D,OAAI,QAAQ,QACR,KAAI,IAAI,OAAO,KAAK,SAAS;AAGzB,QAAI,OAAO,IAAI,wBAAwB,IAAa,IAAI,gBAFvC,MAAM,WAAW,MAAM,MAAM,EAAE,IAAI,CAE6B;AACjF,UAAM,GAAG,KAAK,KAAK;AACnB,UAAM;MACP,KAAK;OAER,KAAI,IAAI,IAAI,KAAK;;;;;;;;;CAYjC,MAAO,KAAS,MAAoB;AAChC,QAAM,KAAK;GAAE;GAAM,QAAQ;GAAM,CAAC,CAAC,OAAO,CAAC,WAAW;AAClD,UAAO,IAAI,CACP,CAAC,wBAAwB,QAAQ,EACjC,CAAC,oBAAoB,QAAQ,OAAO,CACvC,EAAE,IAAI;IACT"}

package/dist/middlewares/index.d.ts

@@ -1,3 +1,4 @@
+import "../error-handler-nV_ImqPa.js";
 import { H3Middleware } from "../index.js";
 import * as h3 from "h3";
 import { H3Event } from "h3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/driver-h3",
-  "version": "0.3.10",
+  "version": "0.3.11",
   "type": "module",
   "description": "H3 driver package for Arkstack providing H3-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
   "homepage": "https://arkstack.toneflix.net",
@@ -36,12 +36,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/contract": "^0.3.10"
+    "@arkstack/contract": "^0.3.11"
   },
   "peerDependencies": {
     "clear-router": "^2.3.3",
     "h3": "2.0.1-rc.16",
-    "@arkstack/common": "^0.3.10"
+    "@arkstack/common": "^0.3.11"
   },
   "scripts": {
     "build": "tsdown",