@arkstack/driver-h3 0.1.1

package/README.md

@@ -0,0 +1,3 @@
+# @arkstack/driver-h3
+
+H3 driver package for Arkstack providing H3-specific implementations of core Arkstack features such as routing, middleware, and database integration.

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+import { ArkstackKitDriver, PromiseOrValue } from "@arkstack/contract";
+import { H3 } from "h3";
+import { Middleware } from "clear-router/types/h3";
+
+//#region src/index.d.ts
+type H3Middleware = Middleware | [Middleware, Record<string, any>];
+interface H3DriverOptions {
+  bindRouter: (app: H3) => PromiseOrValue<void>;
+  mountPublicAssets: (app: H3, publicPath: string) => PromiseOrValue<void>;
+  createApp?: () => H3;
+}
+/**
+ * The H3Driver class implements the ArkstackKitDriver contract for the H3 framework.
+ */
+declare class H3Driver extends ArkstackKitDriver<H3, H3Middleware> {
+  readonly name = "h3";
+  private readonly options;
+  /**
+   * Creates an instance of H3Driver.
+   *
+   * @param options
+   */
+  constructor(options: H3DriverOptions);
+  /**
+   * Creates an H3 application instance.
+   *
+   * @returns
+   */
+  createApp(): H3;
+  /**
+   * Mounts static assets from the specified public path to the H3 application.
+   *
+   * @param app
+   * @param publicPath
+   */
+  mountPublicAssets(app: H3, publicPath: string): PromiseOrValue<void>;
+  /**
+   * Binds the router to the H3 application using the provided bindRouter function.
+   *
+   * @param app
+   */
+  bindRouter(app: H3): PromiseOrValue<void>;
+  /**
+   * Applies middleware to the H3 application.
+   *
+   * @param app
+   * @param middleware
+   */
+  applyMiddleware(app: H3, middleware: H3Middleware): void;
+  /**
+   * Starts the H3 server on the specified port.
+   *
+   * @param app
+   * @param port
+   */
+  start(app: H3, port: number): void;
+}
+//#endregion
+export { H3Driver, H3DriverOptions, H3Middleware };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,67 @@
+import { ArkstackKitDriver } from "@arkstack/contract";
+import { H3, serve } from "h3";
+
+//#region src/index.ts
+/**
+* The H3Driver class implements the ArkstackKitDriver contract for the H3 framework.
+*/
+var H3Driver = class extends ArkstackKitDriver {
+	name = "h3";
+	options;
+	/**
+	* Creates an instance of H3Driver.
+	* 
+	* @param options 
+	*/
+	constructor(options) {
+		super();
+		this.options = options;
+	}
+	/**
+	* Creates an H3 application instance.
+	* 
+	* @returns 
+	*/
+	createApp() {
+		return this.options.createApp?.() ?? new H3();
+	}
+	/**
+	* Mounts static assets from the specified public path to the H3 application.
+	* 
+	* @param app 
+	* @param publicPath 
+	*/
+	mountPublicAssets(app, publicPath) {
+		return this.options.mountPublicAssets(app, publicPath);
+	}
+	/**
+	* Binds the router to the H3 application using the provided bindRouter function.
+	* 
+	* @param app 
+	*/
+	bindRouter(app) {
+		return this.options.bindRouter(app);
+	}
+	/**
+	* Applies middleware to the H3 application.
+	* 
+	* @param app 
+	* @param middleware 
+	*/
+	applyMiddleware(app, middleware) {
+		app.use(Array.isArray(middleware) ? middleware[0] : middleware, Array.isArray(middleware) ? middleware[1] : void 0);
+	}
+	/**
+	* Starts the H3 server on the specified port.
+	* 
+	* @param app 
+	* @param port 
+	*/
+	start(app, port) {
+		serve(app, { port });
+	}
+};
+
+//#endregion
+export { H3Driver };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { ArkstackKitDriver, PromiseOrValue } from \"@arkstack/contract\";\nimport { H3, serve } from \"h3\";\n\nimport { Middleware as H3BaseMiddleware } from \"clear-router/types/h3\";\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\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        return this.options.mountPublicAssets(app, 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 (app: H3, middleware: H3Middleware): void {\n        app.use(\n            Array.isArray(middleware) ? middleware[0] : middleware,\n            Array.isArray(middleware) ? middleware[1] : undefined,\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 });\n    }\n}\n"],"mappings":";;;;;;;AAiBA,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,SAAO,KAAK,QAAQ,kBAAkB,KAAK,WAAW;;;;;;;CAQ1D,WAAY,KAA+B;AACvC,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBAAiB,KAAS,YAAgC;AACtD,MAAI,IACA,MAAM,QAAQ,WAAW,GAAG,WAAW,KAAK,YAC5C,MAAM,QAAQ,WAAW,GAAG,WAAW,KAAK,OAC/C;;;;;;;;CASL,MAAO,KAAS,MAAoB;AAChC,QAAM,KAAK,EAAE,MAAM,CAAC"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@arkstack/driver-h3",
+  "version": "0.1.1",
+  "type": "module",
+  "description": "H3 driver package for Arkstack providing H3-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arkstack-hq/arkstack.git",
+    "directory": "packages/driver-h3"
+  },
+  "keywords": [
+    "h3",
+    "driver",
+    "integration",
+    "routing",
+    "middleware",
+    "database",
+    "arkstack",
+    "http",
+    "server",
+    "rest",
+    "api",
+    "framework"
+  ],
+  "files": [
+    "dist",
+    "stubs"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@arkstack/contract": "^0.1.1"
+  },
+  "peerDependencies": {
+    "clear-router": "^2.1.6",
+    "h3": "2.0.1-rc.14"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "version:patch": "pnpm version patch --no-git-tag-version"
+  }
+}

package/stubs/controller.api.resource.stub

@@ -0,0 +1,97 @@
+import BaseController from '@controllers/BaseController'
+import BaseController from '@controllers/BaseController'
+import { HttpContext } from 'clear-router/types/h3'
+import {{ResourceName}} from '@app/http/resources/{{ResourceName}}'
+import {{CollectionResourceName}} from '@app/http/resources/{{CollectionResourceName}}'
+
+import { Resource } from 'resora';
+
+/**
+ * {{ControllerName}}
+ */
+export default class extends BaseController {
+    /**
+     * Get all resources
+     * 
+     * @param req 
+     * @param res 
+     */
+    index = async ({ res }: HttpContext) => {
+        return await new Resource( { data: [] })
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response(res)
+        .setStatusCode(200);
+    }
+
+    /**
+     * Get a specific resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    show = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response(res)
+        .setStatusCode(200);
+    }
+
+    /**
+     * Create a resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    create = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({ 
+            status: 'success',
+            message: 'New {{Name}} created successfully',
+            code: 201,
+        })
+        .response(res)
+        .setStatusCode(201);
+    }
+
+    /**
+     * Update a specific resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    update = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: '{{Name}} updated successfully',
+            code: 202,
+        })
+        .response(res)
+        .setStatusCode(202);
+    }
+
+    /**
+     * Delete a specific resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    destroy = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: '{{Name}} deleted successfully',
+            code: 202,
+        })
+        .response(res)
+        .setStatusCode(202);
+    }
+}

package/stubs/controller.api.stub

@@ -0,0 +1,94 @@
+import BaseController from '@controllers/BaseController';
+import { HttpContext } from 'clear-router/types/h3'
+
+import { Resource } from 'resora';
+
+/**
+ * {{ControllerName}}
+ */
+export default class extends BaseController {
+    /**
+     * Get all resources
+     * 
+     * @param req 
+     * @param res 
+     */
+    index = async ({ res }: HttpContext) => {
+        return await new Resource({ data: [] })
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response(res)
+        .setStatusCode(200);
+    }
+
+    /**
+     * Get a specific resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    show = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response(res)
+        .setStatusCode(200);
+    }
+
+    /**
+     * Create a resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    create = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: 'New {{Name}} created successfully',
+            code: 201,
+        })
+        .response(res)
+        .setStatusCode(201);
+    }
+
+    /**
+     * Update a specific resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    update = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: '{{Name}} updated successfully',
+            code: 202,
+        })
+        .response(res)
+        .setStatusCode(202);
+    }
+
+    /**
+     * Delete a specific resource
+     * 
+     * @param req 
+     * @param res 
+     */
+    destroy = async ({ res }: HttpContext) => {
+        return await new Resource({ data: {} })
+        .additional({
+            status: 'success',
+            message: '{{Name}} deleted successfully',
+            code: 202,
+        })
+        .response(res)
+        .setStatusCode(202);
+    }
+}

package/stubs/controller.model.stub

@@ -0,0 +1,120 @@
+import BaseController from '@controllers/BaseController'
+import { HttpContext } from 'clear-router/types/h3'
+import { Resource } from 'resora';
+import { prisma } from '@core/DB'
+import { readBody } from 'h3'
+
+/**
+ * {{ControllerName}}
+ */
+export default class extends BaseController {
+    /**
+     * Get all resource from the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    index = async ({ res }: HttpContext) => {
+        const data = await prisma.{{ModelName}}.findMany(
+            { orderBy: { id: 'asc' } }
+        )
+
+        return await new Resource({ data })
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response(res)
+        .setStatusCode(200);
+    }
+
+    /**
+     * Get a specific resource from the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    show = async ({ res, context }: HttpContext) => {
+        const data = await prisma.{{ModelName}}.findFirst(
+            { where: { id: String(context.params?.id) } }
+        )
+
+        return await new Resource({ data })
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response(res)
+        .setStatusCode(200);
+    }
+
+    /**
+     * Create a new resource in the database
+     * 
+     * The calling route must recieve a multer.RequestHandler instance
+     * 
+     * @example router.post('/{{ModelName}}s', upload.none(), new AdminController().create);
+     * 
+     * @param req 
+     * @param res 
+     */
+    create = async (evt: HttpContext) => {
+        const data = await prisma.{{ModelName}}.create({
+            data: readBody(evt) as any,
+        })
+
+        return await new Resource({ data })
+        .additional({
+            status: 'success',
+            message: 'New {{ModelName}} created successfully',
+            code: 201,
+        })
+        .response(evt.res)
+        .setStatusCode(201);
+    }
+
+    /**
+     * Update a specific resource in the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    update = async (evt: HttpContext) => {
+        const data = await prisma.{{ModelName}}.update({
+            where: { id: String(evt.context.params?.id) },
+            data: readBody(evt) as any,
+        })
+
+        return await new Resource({ data })
+        .additional({
+            status: 'success',
+            message: '{{ModelName}} updated successfully',
+            code: 202,
+        })
+        .response(evt.res)
+        .setStatusCode(202);
+    }
+
+    /**
+     * Delete a specific resource from the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    destroy = async ({ res, context }: HttpContext) => {
+        await prisma.{{ModelName}}.delete(
+            { where: { id: String(context.params?.id) } }
+        )
+
+        return await new Resource({ data: null })
+        .additional({
+            status: 'success',
+            message: '{{ModelName}} deleted successfully',
+            code: 202,
+        })
+        .response(res)
+        .setStatusCode(202);
+    }
+}

package/stubs/controller.stub

@@ -0,0 +1,11 @@
+import BaseController from '@controllers/BaseController';
+import { HttpContext } from 'clear-router/types/h3'
+
+/**
+ * {{ControllerName}}
+ */
+export default class extends BaseController {
+    index = async ({ req, res }: HttpContext) => {
+        return '<p>Hello!</p>'
+    }
+}