@arkstack/driver-h3 0.3.6 → 0.3.8
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/index.d.ts +1 -1
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/middlewares/index.d.ts +6 -1
- package/dist/middlewares/index.js +32 -1
- package/dist/middlewares/index.js.map +1 -1
- package/package.json +3 -3
package/dist/index.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import { Middleware } from "clear-router/types/h3";
|
|
|
6
6
|
type H3Middleware = Middleware | [Middleware, Record<string, any>];
|
|
7
7
|
interface H3DriverOptions {
|
|
8
8
|
bindRouter: (app: H3) => PromiseOrValue<void>;
|
|
9
|
-
mountPublicAssets
|
|
9
|
+
mountPublicAssets?: (app: H3, publicPath: string) => PromiseOrValue<void>;
|
|
10
10
|
createApp?: () => H3;
|
|
11
11
|
}
|
|
12
12
|
declare class H3EventResponse {
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { staticAssetHandler } from "./middlewares/index.js";
|
|
1
2
|
import { ArkstackKitDriver } from "@arkstack/contract";
|
|
2
3
|
import { H3, serve, toResponse } from "h3";
|
|
3
4
|
import { Logger } from "@arkstack/common";
|
|
@@ -45,7 +46,8 @@ var H3Driver = class extends ArkstackKitDriver {
|
|
|
45
46
|
* @param publicPath
|
|
46
47
|
*/
|
|
47
48
|
mountPublicAssets(app, publicPath) {
|
|
48
|
-
return this.options.mountPublicAssets(app, publicPath);
|
|
49
|
+
if (this.options.mountPublicAssets) return this.options.mountPublicAssets(app, publicPath);
|
|
50
|
+
app.use(staticAssetHandler(publicPath));
|
|
49
51
|
}
|
|
50
52
|
/**
|
|
51
53
|
* Binds the router to the H3 application using the provided bindRouter function.
|
package/dist/index.js.map
CHANGED
|
@@ -1 +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'\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
|
|
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"}
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { H3Middleware } from "../index.js";
|
|
2
|
+
import * as h3 from "h3";
|
|
3
|
+
import { H3Event } from "h3";
|
|
2
4
|
|
|
3
5
|
//#region src/middlewares/request-logger.d.ts
|
|
4
6
|
declare const requestLogger: ({
|
|
@@ -7,5 +9,8 @@ declare const requestLogger: ({
|
|
|
7
9
|
allowInProduction?: boolean;
|
|
8
10
|
}) => H3Middleware;
|
|
9
11
|
//#endregion
|
|
10
|
-
|
|
12
|
+
//#region src/middlewares/static-asset-handler.d.ts
|
|
13
|
+
declare const staticAssetHandler: (publicPath?: string) => (event: H3Event) => Promise<h3.HTTPResponse | undefined> | undefined;
|
|
14
|
+
//#endregion
|
|
15
|
+
export { requestLogger, staticAssetHandler };
|
|
11
16
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
import { serveStatic } from "h3";
|
|
1
2
|
import { Logger, nodeEnv } from "@arkstack/common";
|
|
3
|
+
import { readFile, stat } from "node:fs/promises";
|
|
4
|
+
import { join, resolve } from "node:path";
|
|
2
5
|
|
|
3
6
|
//#region src/middlewares/request-logger.ts
|
|
4
7
|
const colors = {
|
|
@@ -31,5 +34,33 @@ const requestLogger = ({ allowInProduction = false } = {}) => async (event, next
|
|
|
31
34
|
};
|
|
32
35
|
|
|
33
36
|
//#endregion
|
|
34
|
-
|
|
37
|
+
//#region src/middlewares/static-asset-handler.ts
|
|
38
|
+
const staticAssetHandler = (publicPath = "public") => {
|
|
39
|
+
const rootPath = resolve(process.cwd(), publicPath);
|
|
40
|
+
return (event) => {
|
|
41
|
+
const { pathname } = new URL(event.req.url);
|
|
42
|
+
if (!/\.[a-zA-Z0-9]+$/.test(pathname)) return;
|
|
43
|
+
if (pathname.startsWith("/.") || pathname.includes("..")) return;
|
|
44
|
+
event.res.headers.set("Cache-Control", "public, max-age=31536000, immutable");
|
|
45
|
+
event.res.headers.set("Access-Control-Allow-Origin", "*");
|
|
46
|
+
event.res.headers.set("Access-Control-Allow-Methods", "GET, HEAD, OPTIONS");
|
|
47
|
+
event.res.headers.set("Access-Control-Allow-Headers", "Content-Type, Authorization");
|
|
48
|
+
return serveStatic(event, {
|
|
49
|
+
indexNames: ["/index.html"],
|
|
50
|
+
getContents: (id) => {
|
|
51
|
+
return readFile(join(rootPath, id.replace(/^\/+/, ""))).catch(() => null);
|
|
52
|
+
},
|
|
53
|
+
getMeta: async (id) => {
|
|
54
|
+
const stats = await stat(join(rootPath, id.replace(/^\/+/, ""))).catch(() => void 0);
|
|
55
|
+
if (stats?.isFile()) return {
|
|
56
|
+
size: stats.size,
|
|
57
|
+
mtime: stats.mtimeMs
|
|
58
|
+
};
|
|
59
|
+
}
|
|
60
|
+
});
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
//#endregion
|
|
65
|
+
export { requestLogger, staticAssetHandler };
|
|
35
66
|
//# 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'\n\nimport { H3Middleware } from '..'\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 H3Middleware function\n */\nexport const requestLogger = ({\n allowInProduction = false,\n}: {\n allowInProduction?: boolean\n} = {}): H3Middleware => async (event, next) => {\n if (nodeEnv() === 'prod' && !allowInProduction) return next()\n\n await next()\n\n const start = Date.now()\n const req = event.req\n const status = event.res.status || 200\n const duration = Date.now() - start\n\n Logger.log([\n [`[${req.method}]`, colors[req.method] || 'green'],\n [req.url, 'cyan'],\n [status.toString(), status >= 500 ? 'red' : status >= 400 ? 'yellow' : 'green'],\n [`- ${duration}ms`, 'dim']\n ], ' ')\n}"],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../../src/middlewares/request-logger.ts","../../src/middlewares/static-asset-handler.ts"],"sourcesContent":["import { Logger, nodeEnv } from '@arkstack/common'\n\nimport { H3Middleware } from '..'\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 H3Middleware function\n */\nexport const requestLogger = ({\n allowInProduction = false,\n}: {\n allowInProduction?: boolean\n} = {}): H3Middleware => async (event, next) => {\n if (nodeEnv() === 'prod' && !allowInProduction) return next()\n\n await next()\n\n const start = Date.now()\n const req = event.req\n const status = event.res.status || 200\n const duration = Date.now() - start\n\n Logger.log([\n [`[${req.method}]`, colors[req.method] || 'green'],\n [req.url, 'cyan'],\n [status.toString(), status >= 500 ? 'red' : status >= 400 ? 'yellow' : 'green'],\n [`- ${duration}ms`, 'dim']\n ], ' ')\n}","import { H3Event, serveStatic } from 'h3'\nimport { readFile, stat } from 'node:fs/promises'\nimport { join, resolve } from 'node:path'\n\nexport const staticAssetHandler = (publicPath: string = 'public') => {\n const rootPath = resolve(process.cwd(), publicPath)\n\n return (event: H3Event) => {\n const { pathname } = new URL(event.req.url)\n\n if (!/\\.[a-zA-Z0-9]+$/.test(pathname)) return\n if (pathname.startsWith('/.') || pathname.includes('..')) return\n\n event.res.headers.set('Cache-Control', 'public, max-age=31536000, immutable')\n event.res.headers.set('Access-Control-Allow-Origin', '*')\n event.res.headers.set('Access-Control-Allow-Methods', 'GET, HEAD, OPTIONS')\n event.res.headers.set('Access-Control-Allow-Headers', 'Content-Type, Authorization')\n\n return serveStatic(event, {\n indexNames: ['/index.html'],\n getContents: (id) => {\n const relativePath = id.replace(/^\\/+/, '')\n const file = join(rootPath, relativePath)\n\n return readFile(file).catch(() => null) as never\n },\n getMeta: async (id) => {\n const relativePath = id.replace(/^\\/+/, '')\n const file = join(rootPath, relativePath)\n const stats = await stat(file).catch(() => undefined)\n\n if (stats?.isFile()) {\n return {\n size: stats.size,\n mtime: stats.mtimeMs,\n }\n }\n },\n })\n }\n}"],"mappings":";;;;;;AAIA,MAAM,SAAuE;CACzE,KAAK;CACL,MAAM;CACN,KAAK;CACL,QAAQ;CACR,OAAO;CACV;;;;;;;;AASD,MAAa,iBAAiB,EAC1B,oBAAoB,UAGpB,EAAE,KAAmB,OAAO,OAAO,SAAS;AAC5C,KAAI,SAAS,KAAK,UAAU,CAAC,kBAAmB,QAAO,MAAM;AAE7D,OAAM,MAAM;CAEZ,MAAM,QAAQ,KAAK,KAAK;CACxB,MAAM,MAAM,MAAM;CAClB,MAAM,SAAS,MAAM,IAAI,UAAU;CACnC,MAAM,WAAW,KAAK,KAAK,GAAG;AAE9B,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;;;;;AClCX,MAAa,sBAAsB,aAAqB,aAAa;CACjE,MAAM,WAAW,QAAQ,QAAQ,KAAK,EAAE,WAAW;AAEnD,SAAQ,UAAmB;EACvB,MAAM,EAAE,aAAa,IAAI,IAAI,MAAM,IAAI,IAAI;AAE3C,MAAI,CAAC,kBAAkB,KAAK,SAAS,CAAE;AACvC,MAAI,SAAS,WAAW,KAAK,IAAI,SAAS,SAAS,KAAK,CAAE;AAE1D,QAAM,IAAI,QAAQ,IAAI,iBAAiB,sCAAsC;AAC7E,QAAM,IAAI,QAAQ,IAAI,+BAA+B,IAAI;AACzD,QAAM,IAAI,QAAQ,IAAI,gCAAgC,qBAAqB;AAC3E,QAAM,IAAI,QAAQ,IAAI,gCAAgC,8BAA8B;AAEpF,SAAO,YAAY,OAAO;GACtB,YAAY,CAAC,cAAc;GAC3B,cAAc,OAAO;AAIjB,WAAO,SAFM,KAAK,UADG,GAAG,QAAQ,QAAQ,GAAG,CACF,CAEpB,CAAC,YAAY,KAAK;;GAE3C,SAAS,OAAO,OAAO;IAGnB,MAAM,QAAQ,MAAM,KADP,KAAK,UADG,GAAG,QAAQ,QAAQ,GAAG,CACF,CACX,CAAC,YAAY,OAAU;AAErD,QAAI,OAAO,QAAQ,CACf,QAAO;KACH,MAAM,MAAM;KACZ,OAAO,MAAM;KAChB;;GAGZ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkstack/driver-h3",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.8",
|
|
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,12 +36,12 @@
|
|
|
36
36
|
"./package.json": "./package.json"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@arkstack/contract": "^0.3.
|
|
39
|
+
"@arkstack/contract": "^0.3.8"
|
|
40
40
|
},
|
|
41
41
|
"peerDependencies": {
|
|
42
42
|
"clear-router": "^2.3.3",
|
|
43
43
|
"h3": "2.0.1-rc.16",
|
|
44
|
-
"@arkstack/common": "^0.3.
|
|
44
|
+
"@arkstack/common": "^0.3.8"
|
|
45
45
|
},
|
|
46
46
|
"scripts": {
|
|
47
47
|
"build": "tsdown",
|