@fedify/koa 1.9.0-pr.455.1742

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,35 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/koa: Integrate Fedify with Koa
+=======================================
+
+[![npm][npm badge]][npm]
+[![Matrix][Matrix badge]][Matrix]
+[![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
+
+This package provides a simple way to integrate [Fedify] with [Koa].
+
+Supports Koa v2.x and v3.x.
+
+The integration code looks like this:
+
+~~~~ typescript
+import Koa from "koa";
+import { createMiddleware } from "@fedify/koa";
+import { federation } from "./federation.ts";  // Your `Federation` instance
+
+const app = new Koa();
+
+app.proxy = true;  // Trust proxy headers
+
+app.use(createMiddleware(federation, (ctx) => "context data goes here"));
+~~~~
+
+[npm]: https://www.npmjs.com/package/@fedify/koa
+[npm badge]: https://img.shields.io/npm/v/@fedify/koa?logo=npm
+[Matrix]: https://matrix.to/#/#fedify:matrix.org
+[Matrix badge]: https://img.shields.io/matrix/fedify%3Amatrix.org
+[@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/
+[Koa]: https://koajs.com/

package/dist/index.cjs

@@ -0,0 +1,95 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+const node_stream = __toESM(require("node:stream"));
+
+//#region src/index.ts
+/**
+* Create a Koa middleware to integrate with the {@link Federation} object.
+*
+* @template TContextData A type of the context data for the {@link Federation}
+*                        object.
+* @template TKoaContext A type of the Koa context.
+* @param federation A {@link Federation} object to integrate with Koa.
+* @param contextDataFactory A function to create a context data for the
+*                           {@link Federation} object.
+* @returns A Koa middleware.
+* @since 1.9.0
+*/
+function createMiddleware(federation, contextDataFactory) {
+	return async (ctx, next) => {
+		const request = toRequest(ctx);
+		const contextData = await contextDataFactory(ctx);
+		let notFound = false;
+		let notAcceptable = false;
+		const response = await federation.fetch(request, {
+			contextData,
+			onNotFound: async () => {
+				notFound = true;
+				await next();
+				return new Response("Not found", { status: 404 });
+			},
+			onNotAcceptable: async () => {
+				notAcceptable = true;
+				await next();
+				return new Response("Not acceptable", {
+					status: 406,
+					headers: {
+						"Content-Type": "text/plain",
+						Vary: "Accept"
+					}
+				});
+			}
+		});
+		if (!notFound && !notAcceptable) setResponse(ctx, response);
+	};
+}
+function toRequest(ctx) {
+	const url = `${ctx.protocol}://${ctx.host}${ctx.url}`;
+	const headers = new Headers();
+	for (const [key, value] of Object.entries(ctx.headers)) if (Array.isArray(value)) for (const v of value) headers.append(key, v);
+	else if (typeof value === "string") headers.append(key, value);
+	return new Request(url, {
+		method: ctx.method,
+		headers,
+		duplex: "half",
+		body: ctx.method === "GET" || ctx.method === "HEAD" ? void 0 : node_stream.Readable.toWeb(ctx.req)
+	});
+}
+function setResponse(ctx, response) {
+	ctx.status = response.status;
+	response.headers.forEach((value, key) => ctx.set(key, value));
+	if (response.body == null) return;
+	const body = response.body;
+	const reader = body.getReader();
+	ctx.body = new node_stream.Readable({ async read() {
+		const { done, value } = await reader.read();
+		if (done) {
+			this.push(null);
+			reader.releaseLock();
+		} else this.push(value);
+	} });
+}
+
+//#endregion
+exports.createMiddleware = createMiddleware;

package/dist/index.d.cts

@@ -0,0 +1,30 @@
+import { Federation } from "@fedify/fedify/federation";
+
+//#region src/index.d.ts
+
+/**
+ * A factory function to create context data for the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the {@link Federation}
+ *                        object.
+ * @template TKoaContext A type of the Koa context.
+ * @param context A Koa context object.
+ * @returns A context data for the {@link Federation} object.
+ * @since 1.9.0
+ */
+type ContextDataFactory<TContextData, TKoaContext = any> = (context: TKoaContext) => TContextData | Promise<TContextData>;
+/**
+ * Create a Koa middleware to integrate with the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the {@link Federation}
+ *                        object.
+ * @template TKoaContext A type of the Koa context.
+ * @param federation A {@link Federation} object to integrate with Koa.
+ * @param contextDataFactory A function to create a context data for the
+ *                           {@link Federation} object.
+ * @returns A Koa middleware.
+ * @since 1.9.0
+ */
+declare function createMiddleware<TContextData, TKoaContext = any>(federation: Federation<TContextData>, contextDataFactory: ContextDataFactory<TContextData, TKoaContext>): (ctx: TKoaContext, next: () => Promise<void>) => Promise<void>;
+//#endregion
+export { ContextDataFactory, createMiddleware };

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import { Federation } from "@fedify/fedify/federation";
+
+//#region src/index.d.ts
+
+/**
+ * A factory function to create context data for the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the {@link Federation}
+ *                        object.
+ * @template TKoaContext A type of the Koa context.
+ * @param context A Koa context object.
+ * @returns A context data for the {@link Federation} object.
+ * @since 1.9.0
+ */
+type ContextDataFactory<TContextData, TKoaContext = any> = (context: TKoaContext) => TContextData | Promise<TContextData>;
+/**
+ * Create a Koa middleware to integrate with the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the {@link Federation}
+ *                        object.
+ * @template TKoaContext A type of the Koa context.
+ * @param federation A {@link Federation} object to integrate with Koa.
+ * @param contextDataFactory A function to create a context data for the
+ *                           {@link Federation} object.
+ * @returns A Koa middleware.
+ * @since 1.9.0
+ */
+declare function createMiddleware<TContextData, TKoaContext = any>(federation: Federation<TContextData>, contextDataFactory: ContextDataFactory<TContextData, TKoaContext>): (ctx: TKoaContext, next: () => Promise<void>) => Promise<void>;
+//#endregion
+export { ContextDataFactory, createMiddleware };

package/dist/index.js

@@ -0,0 +1,72 @@
+import { Readable } from "node:stream";
+
+//#region src/index.ts
+/**
+* Create a Koa middleware to integrate with the {@link Federation} object.
+*
+* @template TContextData A type of the context data for the {@link Federation}
+*                        object.
+* @template TKoaContext A type of the Koa context.
+* @param federation A {@link Federation} object to integrate with Koa.
+* @param contextDataFactory A function to create a context data for the
+*                           {@link Federation} object.
+* @returns A Koa middleware.
+* @since 1.9.0
+*/
+function createMiddleware(federation, contextDataFactory) {
+	return async (ctx, next) => {
+		const request = toRequest(ctx);
+		const contextData = await contextDataFactory(ctx);
+		let notFound = false;
+		let notAcceptable = false;
+		const response = await federation.fetch(request, {
+			contextData,
+			onNotFound: async () => {
+				notFound = true;
+				await next();
+				return new Response("Not found", { status: 404 });
+			},
+			onNotAcceptable: async () => {
+				notAcceptable = true;
+				await next();
+				return new Response("Not acceptable", {
+					status: 406,
+					headers: {
+						"Content-Type": "text/plain",
+						Vary: "Accept"
+					}
+				});
+			}
+		});
+		if (!notFound && !notAcceptable) setResponse(ctx, response);
+	};
+}
+function toRequest(ctx) {
+	const url = `${ctx.protocol}://${ctx.host}${ctx.url}`;
+	const headers = new Headers();
+	for (const [key, value] of Object.entries(ctx.headers)) if (Array.isArray(value)) for (const v of value) headers.append(key, v);
+	else if (typeof value === "string") headers.append(key, value);
+	return new Request(url, {
+		method: ctx.method,
+		headers,
+		duplex: "half",
+		body: ctx.method === "GET" || ctx.method === "HEAD" ? void 0 : Readable.toWeb(ctx.req)
+	});
+}
+function setResponse(ctx, response) {
+	ctx.status = response.status;
+	response.headers.forEach((value, key) => ctx.set(key, value));
+	if (response.body == null) return;
+	const body = response.body;
+	const reader = body.getReader();
+	ctx.body = new Readable({ async read() {
+		const { done, value } = await reader.read();
+		if (done) {
+			this.push(null);
+			reader.releaseLock();
+		} else this.push(value);
+	} });
+}
+
+//#endregion
+export { createMiddleware };

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@fedify/koa",
+  "version": "1.9.0-pr.455.1742+fb29545a",
+  "description": "Integrate Fedify with Koa",
+  "keywords": [
+    "Fedify",
+    "Koa",
+    "ActivityPub",
+    "Fediverse"
+  ],
+  "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/koa"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/fedify-dev/fedify/issues"
+  },
+  "funding": [
+    "https://opencollective.com/fedify",
+    "https://github.com/sponsors/dahlia"
+  ],
+  "type": "module",
+  "module": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts",
+        "default": "./dist/index.d.ts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "koa": "^2.0.0 || ^3.0.0",
+    "@fedify/fedify": "^1.9.0-pr.455.1742+fb29545a"
+  },
+  "devDependencies": {
+    "@types/koa": "^2.15.0",
+    "@types/node": "^22.16.0",
+    "tsdown": "^0.12.9",
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepublish": "tsdown"
+  }
+}