@quark-fw/plugin 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,43 @@
+# @quark-fw/plugin
+
+Plugin contract for the Quark framework, plus a shared registry of Express HTTP middleware that server plugins mount into.
+
+## Install
+
+```sh
+npm i @quark-fw/plugin
+```
+
+## Plugin contract
+
+A Quark plugin is a plain object registered on the global `quark` (created by [`@quark-fw/core`](https://www.npmjs.com/package/@quark-fw/core)):
+
+```ts
+import type { QuarkPlugin } from "@quark-fw/plugin";
+
+const myPlugin: QuarkPlugin = {
+	name: "my-plugin",
+	dependsOn: ["prisma"],        // optional: plugins that must load first
+	atoms: {},                    // atoms the plugin contributes to quark
+	extend(quark) {},             // add methods/fields to quark
+	onInit(quark) {},             // lifecycle hooks
+	onReady(quark) {},
+	onDestroy(quark) {},
+	onEvent: { "plugin:init": (p) => {} },
+};
+
+await quark.registerPlugin(myPlugin);
+```
+
+## HTTP middleware registry
+
+`@quark-fw/plugin/http.js` is a side-effect-free module holding two live Express routers. Plugins register routes at any time; the HTTP server mounts the routers once:
+
+```ts
+import { registerHttpMiddleware, registerHttpPreMiddleware } from "@quark-fw/plugin/http.js";
+
+registerHttpPreMiddleware(sessionMiddleware); // runs before all handlers
+registerHttpMiddleware("/api/hello", (req, res) => res.json({ ok: true }));
+```
+
+`express` is an optional peer dependency — it is only required if you import the `http.js` module.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@quark-fw/plugin",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"description": "Plugin contract and loader for the Quark framework",
 	"type": "module",
 	"main": "dist/index.js",
@@ -14,19 +14,23 @@
 		"./src/*": "./dist/*",
 		"./*": "./dist/*"
 	},
-	"files": ["dist"],
+	"files": [
+		"dist"
+	],
 	"scripts": {
 		"dev": "tsx watch src/index.ts",
 		"build": "tsc -p tsconfig.build.json && node ../../scripts/postbuild.mjs"
 	},
-	"keywords": ["quark"],
+	"keywords": [
+		"quark"
+	],
 	"author": "",
 	"license": "ISC",
 	"publishConfig": {
 		"access": "public"
 	},
 	"dependencies": {
-		"@quark-fw/atom": "0.0.1"
+		"@quark-fw/atom": "0.0.2"
 	},
 	"peerDependencies": {
 		"express": "^5.0.0"