@fedify/hono 1.9.0-dev.1461

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024–2025 Hong Minhee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/hono: Integrate Fedify with Hono
+========================================
+
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+[![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
+
+*This package is available since Fedify 1.9.0.*
+
+This package provides a simple way to integrate [Fedify] with [Hono].
+
+The integration code looks like this:
+
+~~~~ typescript
+import { createFederation } from "@fedify/fedify";
+import { federation } from "@fedify/hono";
+import { Hono } from "hono";
+
+const fedi = createFederation<string>({
+  // Omitted for brevity; see the related section for details.
+});
+
+const app = new Hono();
+app.use(federation(fedi, (ctx) => "context data"));
+~~~~
+
+How it works
+------------
+
+Fedify behaves as a middleware that wraps around the Hono request handler.
+The middleware intercepts the incoming HTTP requests and dispatches them to
+the appropriate handler based on the request path and the `Accept` header
+(i.e., content negotiation).  This architecture allows Fedify and your Hono
+application to coexist in the same domain and port.
+
+For example, if you make a request to */.well-known/webfinger* Fedify will
+handle the request by itself, but if you make a request to */users/alice*
+(assuming your Hono app has a handler for `/users/:handle`) with `Accept:
+text/html` header, Fedify will dispatch the request to the Hono app's
+appropriate handler for `/users/:handle`.  Or if you define an actor dispatcher
+for `/users/{handle}` in Fedify, and the request is made with `Accept:
+application/activity+json` header, Fedify will dispatch the request to the
+appropriate actor dispatcher.
+
+Installation
+------------
+
+~~~~ sh
+deno add jsr:@fedify/hono  # Deno
+npm  add     @fedify/hono  # npm
+pnpm add     @fedify/hono  # pnpm
+yarn add     @fedify/hono  # Yarn
+bun  add     @fedify/hono  # Bun
+~~~~
+
+[JSR]: https://jsr.io/@fedify/hono
+[JSR badge]: https://jsr.io/badges/@fedify/hono
+[npm]: https://www.npmjs.com/package/@fedify/hono
+[npm badge]: https://img.shields.io/npm/v/@fedify/hono?logo=npm
+[@fedify@hollo.social badge]: https://fedi-badge.deno.dev/@fedify@hollo.social/followers.svg
+[@fedify@hollo.social]: https://hollo.social/@fedify
+[Fedify]: https://fedify.dev/
+[Hono]: https://hono.dev/

package/dist/mod.d.ts

@@ -0,0 +1,39 @@
+import { Federation } from "@fedify/fedify/federation";
+
+//#region src/mod.d.ts
+
+interface HonoRequest {
+  raw: Request;
+}
+interface HonoContext {
+  req: HonoRequest;
+  res: Response;
+}
+type HonoMiddleware<THonoContext extends HonoContext> = (ctx: THonoContext, next: () => Promise<void>) => Promise<Response | void>;
+/**
+ * A factory function to create a context data for the {@link Federation}
+ * object.
+ *
+ * @template TContextData A type of the context data for the {@link Federation}
+ *                         object.
+ * @template THonoContext A type of the Hono context.
+ * @param context A Hono context object.
+ * @returns A context data for the {@link Federation} object.
+ * @since 1.9.0
+ */
+type ContextDataFactory<TContextData, THonoContext> = (context: THonoContext) => TContextData | Promise<TContextData>;
+/**
+ * Create a Hono middleware to integrate with the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the {@link Federation}
+ *                         object.
+ * @template THonoContext A type of the Hono context.
+ * @param federation A {@link Federation} object to integrate with Hono.
+ * @param contextDataFactory A function to create a context data for the
+ *                           {@link Federation} object.
+ * @returns A Hono middleware.
+ * @since 1.9.0
+ */
+declare function federation<TContextData, THonoContext extends HonoContext>(federation: Federation<TContextData>, contextDataFactory: ContextDataFactory<TContextData, THonoContext>): HonoMiddleware<THonoContext>;
+//#endregion
+export { ContextDataFactory, federation };

package/dist/mod.js

@@ -0,0 +1,45 @@
+//#region src/mod.ts
+/**
+* Create a Hono middleware to integrate with the {@link Federation} object.
+*
+* @template TContextData A type of the context data for the {@link Federation}
+*                         object.
+* @template THonoContext A type of the Hono context.
+* @param federation A {@link Federation} object to integrate with Hono.
+* @param contextDataFactory A function to create a context data for the
+*                           {@link Federation} object.
+* @returns A Hono middleware.
+* @since 1.9.0
+*/
+function federation(federation$1, contextDataFactory) {
+	return async (ctx, next) => {
+		let contextData = contextDataFactory(ctx);
+		if (contextData instanceof Promise) contextData = await contextData;
+		return await federation$1.fetch(ctx.req.raw, {
+			contextData,
+			...integrateFetchOptions(ctx, next)
+		});
+	};
+}
+function integrateFetchOptions(ctx, next) {
+	return {
+		async onNotFound(_req) {
+			await next();
+			return ctx.res;
+		},
+		async onNotAcceptable(_req) {
+			await next();
+			if (ctx.res.status !== 404) return ctx.res;
+			return new Response("Not acceptable", {
+				status: 406,
+				headers: {
+					"Content-Type": "text/plain",
+					Vary: "Accept"
+				}
+			});
+		}
+	};
+}
+
+//#endregion
+export { federation };

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@fedify/hono",
+  "version": "1.9.0-dev.1461+7957aafe",
+  "description": "Integrate Fedify with Hono",
+  "keywords": [
+    "Fedify",
+    "ActivityPub",
+    "Fediverse",
+    "Hono"
+  ],
+  "author": {
+    "name": "Hong Minhee",
+    "email": "hong@minhee.org",
+    "url": "https://hongminhee.org/"
+  },
+  "homepage": "https://fedify.dev/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fedify-dev/fedify.git",
+    "directory": "packages/hono"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/fedify-dev/fedify/issues"
+  },
+  "funding": [
+    "https://opencollective.com/fedify",
+    "https://github.com/sponsors/dahlia"
+  ],
+  "type": "module",
+  "main": "./dist/mod.js",
+  "module": "./dist/mod.js",
+  "types": "./dist/mod.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/mod.d.ts",
+        "import": "./dist/mod.js",
+        "default": "./dist/mod.js"
+      },
+      "import": {
+        "types": "./dist/mod.d.ts",
+        "import": "./dist/mod.js",
+        "default": "./dist/mod.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "hono": "^4.0.0",
+    "@fedify/fedify": "1.9.0-dev.1461+7957aafe"
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.9",
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepublish": "tsdown",
+    "test": "deno task codegen && tsdown && cd dist/ && node --test"
+  }
+}