@arkstack/driver-h3 0.3.17 → 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/dist/Router-CmVPb5OI.d.ts +24 -0
- package/dist/Router-CmVPb5OI.d.ts.map +1 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +26 -3
- package/dist/index.js.map +1 -1
- package/dist/middlewares/index.d.ts +1 -1
- package/package.json +7 -5
- package/dist/error-handler-nV_ImqPa.d.ts +0 -14
- package/dist/error-handler-nV_ImqPa.d.ts.map +0 -1
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ArkstackRouteListOptions } from "@arkstack/contract";
|
|
2
|
+
import { H3, H3Event, HTTPError, HTTPResponse } from "h3";
|
|
3
|
+
import { Router } from "clear-router/h3";
|
|
4
|
+
import { H3App, Handler, HttpContext, Middleware } from "clear-router/types/h3";
|
|
5
|
+
import { Route } from "clear-router";
|
|
6
|
+
|
|
7
|
+
//#region src/error-handler.d.ts
|
|
8
|
+
declare const defaultErrorHandler: (err: HTTPError | Error | string, event: H3Event) => HTTPResponse | {
|
|
9
|
+
error: boolean;
|
|
10
|
+
message: string;
|
|
11
|
+
status: "error";
|
|
12
|
+
code: number;
|
|
13
|
+
errors?: unknown;
|
|
14
|
+
stack?: string;
|
|
15
|
+
};
|
|
16
|
+
//#endregion
|
|
17
|
+
//#region src/Router.d.ts
|
|
18
|
+
declare class Router$1 extends Router {
|
|
19
|
+
static bind(app: H3): Promise<H3App>;
|
|
20
|
+
static list(_options: ArkstackRouteListOptions | undefined, app: H3): Promise<Route<HttpContext, Middleware, Handler>[]>;
|
|
21
|
+
}
|
|
22
|
+
//#endregion
|
|
23
|
+
export { defaultErrorHandler as n, Router$1 as t };
|
|
24
|
+
//# sourceMappingURL=Router-CmVPb5OI.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Router-CmVPb5OI.d.ts","names":[],"sources":["../src/error-handler.ts","../src/Router.ts"],"mappings":";;;;;;;cAMa,mBAAA,GAAuB,GAAA,EAAK,SAAA,GAAY,KAAA,WAAgB,KAAA,EAAO,OAAA,KAAO,YAAA;;;;;;;;;;cCMtE,QAAA,SAAe,MAAA;EAAA,OACb,IAAA,CAAM,GAAA,EAAK,EAAA,GAAK,OAAA,CAAQ,KAAA;EAAA,OAiBxB,IAAA,CACX,QAAA,EAAU,wBAAA,cAA+B,GAAA,EAAK,EAAA,GAC7C,OAAA,CAAQ,KAAA,CAAM,WAAA,EAAa,UAAA,EAAY,OAAA;AAAA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { n as defaultErrorHandler, t as Router } from "./Router-CmVPb5OI.js";
|
|
2
2
|
import { ArkstackKitDriver, ArkstackMiddlewareConfig, PromiseOrValue } from "@arkstack/contract";
|
|
3
3
|
import { H3, H3Event } from "h3";
|
|
4
4
|
import { Middleware } from "clear-router/types/h3";
|
|
@@ -29,5 +29,5 @@ declare class H3Driver extends ArkstackKitDriver<H3, H3Middleware> {
|
|
|
29
29
|
start(app: H3, port: number): void;
|
|
30
30
|
}
|
|
31
31
|
//#endregion
|
|
32
|
-
export { H3Driver, H3DriverOptions, H3EventResponse, H3Middleware, defaultErrorHandler };
|
|
32
|
+
export { H3Driver, H3DriverOptions, H3EventResponse, H3Middleware, Router, defaultErrorHandler };
|
|
33
33
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import { staticAssetHandler } from "./middlewares/index.js";
|
|
2
2
|
import { ArkstackKitDriver } from "@arkstack/contract";
|
|
3
3
|
import { H3, HTTPResponse, serve, toResponse } from "h3";
|
|
4
|
-
import { ErrorHandler, Logger,
|
|
4
|
+
import { ErrorHandler, Logger, importFile, renderError } from "@arkstack/common";
|
|
5
|
+
import { join } from "node:path";
|
|
6
|
+
import { Router as Router$1 } from "clear-router/h3";
|
|
7
|
+
import { clearRouterH3Plugin } from "@resora/plugin-clear-router";
|
|
8
|
+
import { registerPlugin } from "resora";
|
|
5
9
|
|
|
6
10
|
//#region src/error-handler.ts
|
|
7
11
|
const defaultErrorHandler = (err, event) => {
|
|
@@ -19,7 +23,7 @@ const defaultErrorHandler = (err, event) => {
|
|
|
19
23
|
error: true,
|
|
20
24
|
message: responseBody.message
|
|
21
25
|
};
|
|
22
|
-
return new HTTPResponse(
|
|
26
|
+
return new HTTPResponse(renderError({
|
|
23
27
|
message: String(responseBody.message),
|
|
24
28
|
stack: typeof responseBody.stack === "string" ? responseBody.stack : void 0,
|
|
25
29
|
code
|
|
@@ -29,6 +33,25 @@ const defaultErrorHandler = (err, event) => {
|
|
|
29
33
|
});
|
|
30
34
|
};
|
|
31
35
|
|
|
36
|
+
//#endregion
|
|
37
|
+
//#region src/Router.ts
|
|
38
|
+
registerPlugin(clearRouterH3Plugin);
|
|
39
|
+
var Router = class extends Router$1 {
|
|
40
|
+
static async bind(app) {
|
|
41
|
+
await Router$1.group("/api", async () => {
|
|
42
|
+
await importFile(join(process.cwd(), "src/routes/api.ts"));
|
|
43
|
+
});
|
|
44
|
+
await Router$1.group("/", async () => {
|
|
45
|
+
await importFile(join(process.cwd(), "src/routes/web.ts"));
|
|
46
|
+
});
|
|
47
|
+
return Router$1.apply(app);
|
|
48
|
+
}
|
|
49
|
+
static async list(_options = {}, app) {
|
|
50
|
+
await this.bind(app);
|
|
51
|
+
return this.allRoutes();
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
|
|
32
55
|
//#endregion
|
|
33
56
|
//#region src/index.ts
|
|
34
57
|
var H3EventResponse = class {
|
|
@@ -125,5 +148,5 @@ var H3Driver = class extends ArkstackKitDriver {
|
|
|
125
148
|
};
|
|
126
149
|
|
|
127
150
|
//#endregion
|
|
128
|
-
export { H3Driver, H3EventResponse, defaultErrorHandler };
|
|
151
|
+
export { H3Driver, H3EventResponse, Router, defaultErrorHandler };
|
|
129
152
|
//# 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 {
|
|
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'\nimport { H3Event, HTTPError, HTTPResponse } from 'h3'\n\nexport const defaultErrorHandler = (err: HTTPError | Error | string, event: H3Event) => {\n const responseBody = ErrorHandler.createErrorPayload(err)\n\n if (ErrorHandler.shouldLogError(err)) {\n ErrorHandler.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 = ErrorHandler.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(renderError({\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\n","import { ArkstackRouteListOptions } from '@arkstack/contract'\nimport { Router as ClearRouter } from 'clear-router/h3'\nimport { H3 } from 'h3'\nimport type { H3App, Handler, HttpContext, Middleware } from 'clear-router/types/h3'\nimport { type Route } from 'clear-router'\nimport { clearRouterH3Plugin } from '@resora/plugin-clear-router'\nimport { importFile } from '@arkstack/common'\nimport { join } from 'node:path'\nimport { registerPlugin } from 'resora'\n\nregisterPlugin(clearRouterH3Plugin)\n\nexport class Router extends ClearRouter {\n static async bind (app: H3): Promise<H3App> {\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 H3 application\n const router = ClearRouter.apply(app)\n\n return router\n }\n\n static async list (\n _options: ArkstackRouteListOptions = {}, app: H3\n ): Promise<Route<HttpContext, Middleware, Handler>[]> {\n await this.bind(app)\n\n return this.allRoutes()\n }\n}\n","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'\nexport * from './Router'\n"],"mappings":";;;;;;;;;;AAMA,MAAa,uBAAuB,KAAiC,UAAmB;CACpF,MAAM,eAAe,aAAa,mBAAmB,IAAI;AAEzD,KAAI,aAAa,eAAe,IAAI,CAChC,cAAa,kBAAkB,KAAK;EAChC,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,aAAa,oBAAoB,aAAa,KAAK;AAChE,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,YAAY;EAChC,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;;;;;AChCN,eAAe,oBAAoB;AAEnC,IAAa,SAAb,cAA4BA,SAAY;CACtC,aAAa,KAAM,KAAyB;AAE1C,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;AAKF,SAFeA,SAAY,MAAM,IAAI;;CAKvC,aAAa,KACX,WAAqC,EAAE,EAAE,KACW;AACpD,QAAM,KAAK,KAAK,IAAI;AAEpB,SAAO,KAAK,WAAW;;;;;;ACjB3B,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/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkstack/driver-h3",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "H3 driver package for Arkstack providing H3-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
|
|
6
6
|
"homepage": "https://arkstack.toneflix.net",
|
|
@@ -36,13 +36,15 @@
|
|
|
36
36
|
"./package.json": "./package.json"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"
|
|
39
|
+
"clear-router": "^2.5.4",
|
|
40
|
+
"@resora/plugin-clear-router": "^1.0.3",
|
|
41
|
+
"resora": "^1.2.0",
|
|
42
|
+
"@arkstack/contract": "^0.4.0"
|
|
40
43
|
},
|
|
41
44
|
"peerDependencies": {
|
|
42
|
-
"clear-router": "^2.3.5",
|
|
43
45
|
"h3": "2.0.1-rc.16",
|
|
44
|
-
"@arkstack/auth": "^0.
|
|
45
|
-
"@arkstack/common": "^0.
|
|
46
|
+
"@arkstack/auth": "^0.4.0",
|
|
47
|
+
"@arkstack/common": "^0.4.0"
|
|
46
48
|
},
|
|
47
49
|
"peerDependenciesMeta": {
|
|
48
50
|
"@arkstack/auth": {
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { H3Event, HTTPError, HTTPResponse } from "h3";
|
|
2
|
-
|
|
3
|
-
//#region src/error-handler.d.ts
|
|
4
|
-
declare const defaultErrorHandler: (err: HTTPError | Error | string, event: H3Event) => HTTPResponse | {
|
|
5
|
-
error: boolean;
|
|
6
|
-
message: string;
|
|
7
|
-
status: "error";
|
|
8
|
-
code: number;
|
|
9
|
-
errors?: unknown;
|
|
10
|
-
stack?: string;
|
|
11
|
-
};
|
|
12
|
-
//#endregion
|
|
13
|
-
export { defaultErrorHandler as t };
|
|
14
|
-
//# sourceMappingURL=error-handler-nV_ImqPa.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"error-handler-nV_ImqPa.d.ts","names":[],"sources":["../src/error-handler.ts"],"mappings":";;;cAMa,mBAAA,GAAuB,GAAA,EAAK,SAAA,GAAY,KAAA,WAAgB,KAAA,EAAO,OAAA,KAAO,YAAA"}
|