@resora/plugin-clear-router 0.1.0

package/README.md

@@ -0,0 +1,42 @@
+# @resora/plugin-clear-router
+
+Opt-in bridge plugins for using `resora` resources inside `clear-router` routes and controller handlers without changing either core package.
+
+## Why
+
+`resora` resources are thenables, while `clear-router` resolves returned values from both inline handlers and controller actions. Registering these plugins lets Resora bind the active clear-router request context before the handler runs, so plain `return new Resource(...)` works for direct callbacks and controller methods.
+
+## Usage
+
+```ts
+import { registerPlugin } from 'resora';
+import { clearRouterExpressPlugin } from '@resora/plugin-clear-router';
+
+registerPlugin(clearRouterExpressPlugin);
+```
+
+```ts
+import { Router, Controller } from 'clear-router';
+import { Resource } from 'resora';
+
+class UserController extends Controller {
+  index() {
+    return new Resource({ id: 1, name: 'Ada' });
+  }
+}
+
+Router.get('/users', [UserController, 'index']);
+```
+
+```ts
+import { registerPlugin } from 'resora';
+import { clearRouterH3Plugin } from '@resora/plugin-clear-router';
+
+registerPlugin(clearRouterH3Plugin);
+```
+
+## Exports
+
+- `clearRouterExpressPlugin`
+- `clearRouterH3Plugin`
+- `clearRouterPlugin`

package/dist/index.cjs

@@ -0,0 +1,60 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let clear_router_express = require("clear-router/express");
+let clear_router_h3 = require("clear-router/h3");
+let resora = require("resora");
+
+//#region src/index.ts
+const patchedKey = Symbol.for("resora:clear-router-plugin:patched");
+/**
+* Patch the given Clear Router router class to wrap route handlers with the provided 
+* runWithCtx function, enabling context-aware execution of route handlers.
+*
+* @param router        The Clear Router router class to patch
+* @param runWithCtx    A function that wraps the route handler execution with a given context
+* @returns void
+*/
+const patchRouter = (router, runWithCtx) => {
+	const target = router;
+	if (target[patchedKey]) return;
+	const resolveHandler = target.resolveHandler.bind(target);
+	target.resolveHandler = ((route) => {
+		const resolved = resolveHandler(route);
+		if (!resolved.handlerFunction) return resolved;
+		const handlerFunction = resolved.handlerFunction;
+		resolved.handlerFunction = ((ctx, req) => {
+			return runWithCtx(ctx, async () => {
+				return await Promise.resolve(handlerFunction(ctx, req));
+			});
+		});
+		return resolved;
+	});
+	target[patchedKey] = true;
+};
+/**
+* Clear Router plugin for Express framework. Patches Clear Router's Express router to wrap 
+* route handlers with the provided runWithCtx function, enabling context-aware execution of 
+* route handlers in Express applications.
+*/
+const clearRouterExpressPlugin = (0, resora.definePlugin)({
+	name: "clear-router-express",
+	setup: ({ runWithCtx }) => {
+		patchRouter(clear_router_express.Router, runWithCtx);
+	}
+});
+/**
+* Clear Router plugin for H3 framework. Patches Clear Router's H3 router to wrap route 
+* handlers with the provided runWithCtx function, enabling context-aware execution of 
+* route handlers in H3 applications.
+*/
+const clearRouterH3Plugin = (0, resora.definePlugin)({
+	name: "clear-router-h3",
+	setup: ({ runWithCtx }) => {
+		patchRouter(clear_router_h3.Router, runWithCtx);
+	}
+});
+const clearRouterPlugin = [clearRouterExpressPlugin, clearRouterH3Plugin];
+
+//#endregion
+exports.clearRouterExpressPlugin = clearRouterExpressPlugin;
+exports.clearRouterH3Plugin = clearRouterH3Plugin;
+exports.clearRouterPlugin = clearRouterPlugin;

package/dist/index.d.cts

@@ -0,0 +1,33 @@
+import * as resora from "resora";
+
+//#region src/index.d.ts
+/**
+ * Clear Router plugin for Express framework. Patches Clear Router's Express router to wrap
+ * route handlers with the provided runWithCtx function, enabling context-aware execution of
+ * route handlers in Express applications.
+ */
+declare const clearRouterExpressPlugin: {
+  name: string;
+  setup: ({
+    runWithCtx
+  }: resora.ResoraPluginApi) => void;
+};
+/**
+ * Clear Router plugin for H3 framework. Patches Clear Router's H3 router to wrap route
+ * handlers with the provided runWithCtx function, enabling context-aware execution of
+ * route handlers in H3 applications.
+ */
+declare const clearRouterH3Plugin: {
+  name: string;
+  setup: ({
+    runWithCtx
+  }: resora.ResoraPluginApi) => void;
+};
+declare const clearRouterPlugin: {
+  name: string;
+  setup: ({
+    runWithCtx
+  }: resora.ResoraPluginApi) => void;
+}[];
+//#endregion
+export { clearRouterExpressPlugin, clearRouterH3Plugin, clearRouterPlugin };

package/dist/index.d.mts

@@ -0,0 +1,33 @@
+import * as resora from "resora";
+
+//#region src/index.d.ts
+/**
+ * Clear Router plugin for Express framework. Patches Clear Router's Express router to wrap
+ * route handlers with the provided runWithCtx function, enabling context-aware execution of
+ * route handlers in Express applications.
+ */
+declare const clearRouterExpressPlugin: {
+  name: string;
+  setup: ({
+    runWithCtx
+  }: resora.ResoraPluginApi) => void;
+};
+/**
+ * Clear Router plugin for H3 framework. Patches Clear Router's H3 router to wrap route
+ * handlers with the provided runWithCtx function, enabling context-aware execution of
+ * route handlers in H3 applications.
+ */
+declare const clearRouterH3Plugin: {
+  name: string;
+  setup: ({
+    runWithCtx
+  }: resora.ResoraPluginApi) => void;
+};
+declare const clearRouterPlugin: {
+  name: string;
+  setup: ({
+    runWithCtx
+  }: resora.ResoraPluginApi) => void;
+}[];
+//#endregion
+export { clearRouterExpressPlugin, clearRouterH3Plugin, clearRouterPlugin };

package/dist/index.mjs

@@ -0,0 +1,57 @@
+import { Router } from "clear-router/express";
+import { Router as Router$1 } from "clear-router/h3";
+import { definePlugin } from "resora";
+
+//#region src/index.ts
+const patchedKey = Symbol.for("resora:clear-router-plugin:patched");
+/**
+* Patch the given Clear Router router class to wrap route handlers with the provided 
+* runWithCtx function, enabling context-aware execution of route handlers.
+*
+* @param router        The Clear Router router class to patch
+* @param runWithCtx    A function that wraps the route handler execution with a given context
+* @returns void
+*/
+const patchRouter = (router, runWithCtx) => {
+	const target = router;
+	if (target[patchedKey]) return;
+	const resolveHandler = target.resolveHandler.bind(target);
+	target.resolveHandler = ((route) => {
+		const resolved = resolveHandler(route);
+		if (!resolved.handlerFunction) return resolved;
+		const handlerFunction = resolved.handlerFunction;
+		resolved.handlerFunction = ((ctx, req) => {
+			return runWithCtx(ctx, async () => {
+				return await Promise.resolve(handlerFunction(ctx, req));
+			});
+		});
+		return resolved;
+	});
+	target[patchedKey] = true;
+};
+/**
+* Clear Router plugin for Express framework. Patches Clear Router's Express router to wrap 
+* route handlers with the provided runWithCtx function, enabling context-aware execution of 
+* route handlers in Express applications.
+*/
+const clearRouterExpressPlugin = definePlugin({
+	name: "clear-router-express",
+	setup: ({ runWithCtx }) => {
+		patchRouter(Router, runWithCtx);
+	}
+});
+/**
+* Clear Router plugin for H3 framework. Patches Clear Router's H3 router to wrap route 
+* handlers with the provided runWithCtx function, enabling context-aware execution of 
+* route handlers in H3 applications.
+*/
+const clearRouterH3Plugin = definePlugin({
+	name: "clear-router-h3",
+	setup: ({ runWithCtx }) => {
+		patchRouter(Router$1, runWithCtx);
+	}
+});
+const clearRouterPlugin = [clearRouterExpressPlugin, clearRouterH3Plugin];
+
+//#endregion
+export { clearRouterExpressPlugin, clearRouterH3Plugin, clearRouterPlugin };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@resora/plugin-clear-router",
+  "version": "0.1.0",
+  "description": "Opt-in bridge plugin for using resora return values inside clear-router handlers.",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "resora",
+    "clear-router",
+    "express",
+    "h3",
+    "plugin",
+    "typescript"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.cts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "resora": "1.0.0"
+  },
+  "peerDependencies": {
+    "clear-router": "^2.3.3"
+  },
+  "peerDependenciesMeta": {
+    "clear-router": {
+      "optional": false
+    }
+  },
+  "devDependencies": {
+    "clear-router": "^2.3.3"
+  },
+  "scripts": {
+    "test": "vitest run tests/**/*.spec.ts",
+    "build": "tsdown",
+    "lint": "eslint src tests --ext .ts",
+    "version:patch": "pnpm version patch"
+  }
+}