@arkstack/driver-h3 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -9,50 +9,14 @@ interface H3DriverOptions {
   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

package/dist/index.js.map

@@ -1 +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"}
+{"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

@@ -1,8 +1,9 @@
 {
   "name": "@arkstack/driver-h3",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "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",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/arkstack-hq/arkstack.git",
@@ -34,14 +35,14 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/contract": "^0.1.1"
+    "@arkstack/contract": "^0.2.0"
   },
   "peerDependencies": {
-    "clear-router": "^2.1.6",
-    "h3": "2.0.1-rc.14"
+    "clear-router": "^2.3.3",
+    "h3": "2.0.1-rc.16"
   },
   "scripts": {
     "build": "tsdown",
-    "version:patch": "pnpm version patch --no-git-tag-version"
+    "version:patch": "pnpm version patch"
   }
 }

package/stubs/controller.api.resource.stub

@@ -1,15 +1,15 @@
-import BaseController from '@controllers/BaseController'
+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';
+import { Resource } from 'resora'
 
 /**
  * {{ControllerName}}
  */
-export default class extends BaseController {
+export default class {{ControllerName}} extends BaseController {
     /**
      * Get all resources
      * 
@@ -24,7 +24,7 @@ export default class extends BaseController {
             code: 200,
         })
         .response(res)
-        .setStatusCode(200);
+        .setStatusCode(200)
     }
 
     /**
@@ -41,7 +41,7 @@ export default class extends BaseController {
             code: 200,
         })
         .response(res)
-        .setStatusCode(200);
+        .setStatusCode(200)
     }
 
     /**
@@ -58,7 +58,7 @@ export default class extends BaseController {
             code: 201,
         })
         .response(res)
-        .setStatusCode(201);
+        .setStatusCode(201)
     }
 
     /**
@@ -75,7 +75,7 @@ export default class extends BaseController {
             code: 202,
         })
         .response(res)
-        .setStatusCode(202);
+        .setStatusCode(202)
     }
 
     /**
@@ -92,6 +92,6 @@ export default class extends BaseController {
             code: 202,
         })
         .response(res)
-        .setStatusCode(202);
+        .setStatusCode(202)
     }
 }

package/stubs/controller.api.stub

@@ -1,12 +1,12 @@
-import BaseController from '@controllers/BaseController';
+import { BaseController } from '@controllers/BaseController'
 import { HttpContext } from 'clear-router/types/h3'
 
-import { Resource } from 'resora';
+import { Resource } from 'resora'
 
 /**
  * {{ControllerName}}
  */
-export default class extends BaseController {
+export default class {{ControllerName}} extends BaseController {
     /**
      * Get all resources
      * 
@@ -21,7 +21,7 @@ export default class extends BaseController {
             code: 200,
         })
         .response(res)
-        .setStatusCode(200);
+        .setStatusCode(200)
     }
 
     /**
@@ -38,7 +38,7 @@ export default class extends BaseController {
             code: 200,
         })
         .response(res)
-        .setStatusCode(200);
+        .setStatusCode(200)
     }
 
     /**
@@ -55,7 +55,7 @@ export default class extends BaseController {
             code: 201,
         })
         .response(res)
-        .setStatusCode(201);
+        .setStatusCode(201)
     }
 
     /**
@@ -72,7 +72,7 @@ export default class extends BaseController {
             code: 202,
         })
         .response(res)
-        .setStatusCode(202);
+        .setStatusCode(202)
     }
 
     /**
@@ -89,6 +89,6 @@ export default class extends BaseController {
             code: 202,
         })
         .response(res)
-        .setStatusCode(202);
+        .setStatusCode(202)
     }
 }

package/stubs/controller.model.stub

@@ -1,13 +1,13 @@
-import BaseController from '@controllers/BaseController'
+import { BaseController } from '@controllers/BaseController'
 import { HttpContext } from 'clear-router/types/h3'
-import { Resource } from 'resora';
-import { prisma } from '@core/DB'
+import { Resource } from 'resora'
+import { {{Model}} } from 'src/models/{{Model}}'
 import { readBody } from 'h3'
 
 /**
  * {{ControllerName}}
  */
-export default class extends BaseController {
+export default class {{ControllerName}} extends BaseController {
     /**
      * Get all resource from the database
      * 
@@ -15,9 +15,7 @@ export default class extends BaseController {
      * @param res 
      */
     index = async ({ res }: HttpContext) => {
-        const data = await prisma.{{ModelName}}.findMany(
-            { orderBy: { id: 'asc' } }
-        )
+        const data = await {{Model}}.query().orderBy({ id: 'asc' }).get()
 
         return await new Resource({ data })
         .additional({
@@ -26,7 +24,7 @@ export default class extends BaseController {
             code: 200,
         })
         .response(res)
-        .setStatusCode(200);
+        .setStatusCode(200)
     }
 
     /**
@@ -36,9 +34,7 @@ export default class extends BaseController {
      * @param res 
      */
     show = async ({ res, context }: HttpContext) => {
-        const data = await prisma.{{ModelName}}.findFirst(
-            { where: { id: String(context.params?.id) } }
-        )
+        const data = await {{Model}}.query().where({ id: String(context.params?.id) }).firstOrFail()
 
         return await new Resource({ data })
         .additional({
@@ -47,7 +43,7 @@ export default class extends BaseController {
             code: 200,
         })
         .response(res)
-        .setStatusCode(200);
+        .setStatusCode(200)
     }
 
     /**
@@ -55,13 +51,13 @@ export default class extends BaseController {
      * 
      * The calling route must recieve a multer.RequestHandler instance
      * 
-     * @example router.post('/{{ModelName}}s', upload.none(), new AdminController().create);
+     * @example router.post('/{{ModelName}}s', upload.none(), new AdminController().create)
      * 
      * @param req 
      * @param res 
      */
     create = async (evt: HttpContext) => {
-        const data = await prisma.{{ModelName}}.create({
+        const data = await {{Model}}.query().create({
             data: readBody(evt) as any,
         })
 
@@ -72,7 +68,7 @@ export default class extends BaseController {
             code: 201,
         })
         .response(evt.res)
-        .setStatusCode(201);
+        .setStatusCode(201)
     }
 
     /**
@@ -82,10 +78,11 @@ export default class extends BaseController {
      * @param res 
      */
     update = async (evt: HttpContext) => {
-        const data = await prisma.{{ModelName}}.update({
-            where: { id: String(evt.context.params?.id) },
-            data: readBody(evt) as any,
-        })
+        const data = await {{Model}}.query()
+            .where({ id: String(evt.context.params?.id) })
+            .update({
+                data: readBody(evt) as any,
+            })
 
         return await new Resource({ data })
         .additional({
@@ -94,7 +91,7 @@ export default class extends BaseController {
             code: 202,
         })
         .response(evt.res)
-        .setStatusCode(202);
+        .setStatusCode(202)
     }
 
     /**
@@ -104,9 +101,7 @@ export default class extends BaseController {
      * @param res 
      */
     destroy = async ({ res, context }: HttpContext) => {
-        await prisma.{{ModelName}}.delete(
-            { where: { id: String(context.params?.id) } }
-        )
+        await {{Model}}.query().where({ id: String(context.params?.id) }).delete()
 
         return await new Resource({ data: null })
         .additional({
@@ -115,6 +110,6 @@ export default class extends BaseController {
             code: 202,
         })
         .response(res)
-        .setStatusCode(202);
+        .setStatusCode(202)
     }
 }

package/stubs/controller.stub

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