@arkstack/driver-express 0.1.1

package/README.md

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

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { ErrorRequestHandler, Express, Handler } from "express";
+import { ArkstackKitDriver, PromiseOrValue } from "@arkstack/contract";
+
+//#region src/index.d.ts
+interface ExpressDriverOptions {
+  bindRouter: (app: Express) => PromiseOrValue<void>;
+  errorHandler?: ErrorRequestHandler | Handler;
+}
+/**
+ * The ExpressDriver class implements the ArkstackKitDriver
+ * contract for the Express framework.
+ */
+declare class ExpressDriver extends ArkstackKitDriver<Express, Handler> {
+  readonly name = "express";
+  private readonly options;
+  /**
+   * Creates an instance of ExpressDriver.
+   *
+   * @param options
+   */
+  constructor(options: ExpressDriverOptions);
+  /**
+   * Creates an Express application instance.
+   *
+   * @returns
+   */
+  createApp(): Express;
+  /**
+   * Mounts static assets from the specified public path to the Express application.
+   *
+   * @param app
+   * @param publicPath
+   */
+  mountPublicAssets(app: Express, publicPath: string): void;
+  /**
+   * Binds the router to the Express application using the provided bindRouter function.
+   *
+   * @param app
+   */
+  bindRouter(app: Express): PromiseOrValue<void>;
+  /**
+   * Applies middleware to the Express application.
+   *
+   * @param app
+   * @param middleware
+   */
+  applyMiddleware(app: Express, middleware: Handler): void;
+  /**
+   * Registers an error handler middleware to the Express
+   * application if provided in the options.
+   *
+   * @param app
+   */
+  registerErrorHandler(app: Express): void;
+  /**
+   * Starts the Express server on the specified port.
+   *
+   * @param app
+   * @param port
+   */
+  start(app: Express, port: number): void;
+}
+//#endregion
+export { ExpressDriver, ExpressDriverOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,79 @@
+import express from "express";
+import { ArkstackKitDriver } from "@arkstack/contract";
+
+//#region src/index.ts
+/**
+* The ExpressDriver class implements the ArkstackKitDriver 
+* contract for the Express framework.
+*/
+var ExpressDriver = class extends ArkstackKitDriver {
+	name = "express";
+	options;
+	/**
+	* Creates an instance of ExpressDriver.
+	* 
+	* @param options 
+	*/
+	constructor(options) {
+		super();
+		this.options = options;
+	}
+	/**
+	* Creates an Express application instance.
+	* 
+	* @returns 
+	*/
+	createApp() {
+		return express();
+	}
+	/**
+	* Mounts static assets from the specified public path to the Express application.
+	* 
+	* @param app 
+	* @param publicPath 
+	*/
+	mountPublicAssets(app, publicPath) {
+		app.use(express.static(publicPath));
+	}
+	/**
+	* Binds the router to the Express application using the provided bindRouter function.
+	* 
+	* @param app 
+	*/
+	bindRouter(app) {
+		return this.options.bindRouter(app);
+	}
+	/**
+	* Applies middleware to the Express application.
+	* 
+	* @param app 
+	* @param middleware 
+	*/
+	applyMiddleware(app, middleware) {
+		app.use(middleware);
+	}
+	/**
+	* Registers an error handler middleware to the Express 
+	* application if provided in the options.
+	* 
+	* @param app 
+	*/
+	registerErrorHandler(app) {
+		if (this.options.errorHandler) app.use(this.options.errorHandler);
+	}
+	/**
+	* Starts the Express server on the specified port.
+	* 
+	* @param app 
+	* @param port 
+	*/
+	start(app, port) {
+		app.listen(port, () => {
+			console.log(`Server is running on http://localhost:${port}`);
+		});
+	}
+};
+
+//#endregion
+export { ExpressDriver };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import express, { type ErrorRequestHandler, type Express, type Handler } from \"express\";\n\nimport { ArkstackKitDriver, PromiseOrValue } from \"@arkstack/contract\";\n\nexport interface ExpressDriverOptions {\n    bindRouter: (app: Express) => PromiseOrValue<void>;\n    errorHandler?: ErrorRequestHandler | Handler;\n}\n\n/**\n * The ExpressDriver class implements the ArkstackKitDriver \n * contract for the Express framework.\n */\nexport class ExpressDriver extends ArkstackKitDriver<Express, Handler> {\n    readonly name = \"express\";\n    private readonly options: ExpressDriverOptions;\n\n    /**\n     * Creates an instance of ExpressDriver.\n     * \n     * @param options \n     */\n    constructor(options: ExpressDriverOptions) {\n        super();\n        this.options = options;\n    }\n\n    /**\n     * Creates an Express application instance.\n     * \n     * @returns \n     */\n    createApp (): Express {\n        return express();\n    }\n\n    /**\n     * Mounts static assets from the specified public path to the Express application.\n     * \n     * @param app \n     * @param publicPath \n     */\n    mountPublicAssets (app: Express, publicPath: string): void {\n        app.use(express.static(publicPath));\n    }\n\n    /**\n     * Binds the router to the Express application using the provided bindRouter function.\n     * \n     * @param app \n     */\n    bindRouter (app: Express): PromiseOrValue<void> {\n        return this.options.bindRouter(app);\n    }\n\n    /**\n     * Applies middleware to the Express application.\n     * \n     * @param app \n     * @param middleware \n     */\n    applyMiddleware (app: Express, middleware: Handler): void {\n        app.use(middleware);\n    }\n\n    /**\n     * Registers an error handler middleware to the Express \n     * application if provided in the options.\n     * \n     * @param app \n     */\n    registerErrorHandler (app: Express): void {\n        if (this.options.errorHandler) {\n            app.use(this.options.errorHandler as ErrorRequestHandler);\n        }\n    }\n\n    /**\n     * Starts the Express server on the specified port.\n     * \n     * @param app \n     * @param port \n     */\n    start (app: Express, port: number): void {\n        app.listen(port, () => {\n            console.log(`Server is running on http://localhost:${port}`);\n        });\n    }\n}\n"],"mappings":";;;;;;;;AAaA,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA+B;AACvC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAsB;AAClB,SAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0B;AACvD,MAAI,IAAI,QAAQ,OAAO,WAAW,CAAC;;;;;;;CAQvC,WAAY,KAAoC;AAC5C,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBAAiB,KAAc,YAA2B;AACtD,MAAI,IAAI,WAAW;;;;;;;;CASvB,qBAAsB,KAAoB;AACtC,MAAI,KAAK,QAAQ,aACb,KAAI,IAAI,KAAK,QAAQ,aAAoC;;;;;;;;CAUjE,MAAO,KAAc,MAAoB;AACrC,MAAI,OAAO,YAAY;AACnB,WAAQ,IAAI,yCAAyC,OAAO;IAC9D"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@arkstack/driver-express",
+  "version": "0.1.1",
+  "type": "module",
+  "description": "Express driver package for Arkstack providing Express-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-express"
+  },
+  "keywords": [
+    "express",
+    "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": {
+    "express": "^5.2.1"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.6"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "version:patch": "pnpm version patch --no-git-tag-version"
+  }
+}

package/stubs/controller.api.resource.stub

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

package/stubs/controller.api.stub

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

package/stubs/controller.model.stub

@@ -0,0 +1,125 @@
+import BaseController from '@controllers/BaseController';
+import { HttpContext } from 'clear-router/types/express'
+import { Resource, ResourceCollection } from "resora";
+import { prisma } from '@core/DB';
+
+/**
+ * {{ControllerName}}
+ */
+export default class extends BaseController {
+    /**
+     * Get all resource from the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    index = async ({ res }: HttpContext) => {
+        return new ResourceCollection({
+            data: await prisma.{{ModelName}}.findMany(
+                { orderBy: { id: 'asc' } }
+            ),
+        }, res)
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response()
+        .setStatusCode(200);
+    }
+
+    /**
+     * Get a specific resource from the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    show = async ({ req, res }: HttpContext) => {
+        return new Resource({
+            data: await prisma.{{ModelName}}.findFirst(
+                { where: { id: String(req.params.id) } }
+            ),
+        }, res)
+        .additional({
+            status: 'success',
+            message: 'OK',
+            code: 200,
+        })
+        .response()
+        .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 ({ req, res }: HttpContext) => {
+        const data = await prisma.{{ModelName}}.create({
+            data: req.body,
+        })
+
+        return new Resource({
+            data: data,
+        }, res)
+        .additional({
+            status: 'success',
+            message: 'New {{ModelName}} created successfully',
+            code: 201,
+        })
+        .response()
+        .setStatusCode(201);
+    }
+
+    /**
+     * Update a specific resource in the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    update = async ({ req, res }: HttpContext) => {
+        const data = await prisma.{{ModelName}}.update({
+            where: { id: String(req.params.id) },
+            data: req.body(),
+        })
+
+        return new Resource({
+            data,
+        }, res)
+        .additional({
+            status: 'success',
+            message: '{{ModelName}} updated successfully',
+            code: 202,
+        })
+        .response()
+        .setStatusCode(202);
+    }
+
+    /**
+     * Delete a specific resource from the database
+     * 
+     * @param req 
+     * @param res 
+     */
+    destroy = async ({ req, res }: HttpContext) => {
+        await prisma.{{ModelName}}.delete(
+            { where: { id: String(req.params.id) } }
+        )
+
+        return new Resource({
+            data: {},
+        }, res)
+        .additional({
+            status: 'success',
+            message: '{{ModelName}} deleted successfully',
+            code: 202,
+        })
+        .response()
+        .setStatusCode(202);
+    }
+}

package/stubs/controller.stub

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