@fedify/fastify 1.9.0

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,36 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/fastify: Integrate Fedify with Fastify
+==============================================
+
+[![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 [Fastify].
+
+The integration code looks like this:
+
+~~~~ typescript
+import Fastify from "fastify";
+import { fedifyPlugin } from "@fedify/fastify";
+import { federation } from "./federation.ts";  // Your `Federation` instance
+
+const fastify = Fastify({ logger: true });
+
+await fastify.register(fedifyPlugin, {
+  federation,
+  contextDataFactory: () => undefined,
+});
+
+fastify.listen({ port: 3000 });
+~~~~
+
+[npm]: https://www.npmjs.com/package/@fedify/fastify
+[npm badge]: https://img.shields.io/npm/v/@fedify/fastify?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/
+[Fastify]: https://fastify.dev/

package/dist/index.cjs

@@ -0,0 +1,107 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+//#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 fastify_plugin = __toESM(require("fastify-plugin"));
+const node_stream = __toESM(require("node:stream"));
+
+//#region src/index.ts
+/**
+* Fastify plugin that integrates with a Federation instance.
+*
+* @example
+* ```typescript
+* import { createFederation, MemoryKvStore, Person } from "@fedify/fedify";
+* import fedifyPlugin from "@fedify/fastify";
+* import Fastify from "fastify";
+*
+* const fastify = Fastify();
+*
+* const federation = createFederation({ kv: new MemoryKvStore() });
+*
+* // Add federation routes
+* federation.setActorDispatcher("/users/{identifier}", async (ctx, identifier) => {
+*   return new Person({
+*     id: ctx.getActorUri(identifier),
+*     preferredUsername: identifier,
+*   });
+* });
+*
+* // Register the plugin
+* await fastify.register(fedifyPlugin, {
+*   federation,
+*   contextDataFactory: () => undefined,
+*   errorHandlers: { onNotFound: () => new Response("Not Found", { status: 404 }) },
+* });
+* ```
+*/
+const fedifyPluginCore = (fastify, options) => {
+	const { federation, contextDataFactory = () => void 0, errorHandlers } = options;
+	fastify.addHook("onRequest", async (request, reply) => {
+		const webRequest = toWebRequest(request);
+		const contextData = await contextDataFactory(request);
+		const response = await federation.fetch(webRequest, {
+			contextData,
+			onNotAcceptable: () => defaultNotAcceptableResponse,
+			onNotFound: () => dummyNotFoundResponse,
+			...errorHandlers
+		});
+		if (response === dummyNotFoundResponse) return;
+		await reply.send(response);
+	});
+	return Promise.resolve();
+};
+const fedifyPlugin = (0, fastify_plugin.default)(fedifyPluginCore, {
+	name: "fedify-plugin",
+	fastify: "5.x"
+});
+const dummyNotFoundResponse = new Response("", { status: 404 });
+const defaultNotAcceptableResponse = new Response("Not Acceptable", {
+	status: 406,
+	headers: {
+		"Content-Type": "text/plain",
+		Vary: "Accept"
+	}
+});
+/**
+* Convert Fastify request to Web API Request.
+*/
+function toWebRequest(fastifyReq) {
+	const protocol = fastifyReq.protocol;
+	const host = fastifyReq.headers.host ?? fastifyReq.hostname;
+	const url = `${protocol}://${host}${fastifyReq.url}`;
+	const headers = new Headers();
+	for (const [key, value] of Object.entries(fastifyReq.raw.headers)) if (Array.isArray(value)) for (const v of value) headers.append(key, v);
+	else if (value !== void 0) headers.set(key, String(value));
+	const body = fastifyReq.method === "GET" || fastifyReq.method === "HEAD" ? void 0 : fastifyReq.body !== void 0 ? typeof fastifyReq.body === "string" ? fastifyReq.body : JSON.stringify(fastifyReq.body) : node_stream.Readable.toWeb(fastifyReq.raw);
+	return new Request(url, {
+		method: fastifyReq.method,
+		headers,
+		body
+	});
+}
+var src_default = fedifyPlugin;
+
+//#endregion
+exports.default = src_default;
+exports.fedifyPlugin = fedifyPlugin;

package/dist/index.d.cts

@@ -0,0 +1,21 @@
+import { Federation, FederationFetchOptions } from "@fedify/fedify";
+import { FastifyPluginAsync, FastifyPluginOptions, FastifyRequest } from "fastify";
+
+//#region src/index.d.ts
+
+type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
+/**
+ * A factory function that creates context data for the Federation instance.
+ */
+type ContextDataFactory<TContextData> = (request: FastifyRequest) => TContextData | Promise<TContextData>;
+/**
+ * Plugin options for Fedify integration.
+ */
+interface FedifyPluginOptions<TContextData> extends FastifyPluginOptions {
+  federation: Federation<TContextData>;
+  contextDataFactory?: ContextDataFactory<TContextData>;
+  errorHandlers?: Partial<ErrorHandlers>;
+}
+declare const fedifyPlugin: FastifyPluginAsync<FedifyPluginOptions<unknown>>;
+//#endregion
+export { ContextDataFactory, FedifyPluginOptions, fedifyPlugin as default, fedifyPlugin };

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { Federation, FederationFetchOptions } from "@fedify/fedify";
+import { FastifyPluginAsync, FastifyPluginOptions, FastifyRequest } from "fastify";
+
+//#region src/index.d.ts
+
+type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
+/**
+ * A factory function that creates context data for the Federation instance.
+ */
+type ContextDataFactory<TContextData> = (request: FastifyRequest) => TContextData | Promise<TContextData>;
+/**
+ * Plugin options for Fedify integration.
+ */
+interface FedifyPluginOptions<TContextData> extends FastifyPluginOptions {
+  federation: Federation<TContextData>;
+  contextDataFactory?: ContextDataFactory<TContextData>;
+  errorHandlers?: Partial<ErrorHandlers>;
+}
+declare const fedifyPlugin: FastifyPluginAsync<FedifyPluginOptions<unknown>>;
+//#endregion
+export { ContextDataFactory, FedifyPluginOptions, fedifyPlugin as default, fedifyPlugin };

package/dist/index.js

@@ -0,0 +1,82 @@
+import fp from "fastify-plugin";
+import { Readable } from "node:stream";
+
+//#region src/index.ts
+/**
+* Fastify plugin that integrates with a Federation instance.
+*
+* @example
+* ```typescript
+* import { createFederation, MemoryKvStore, Person } from "@fedify/fedify";
+* import fedifyPlugin from "@fedify/fastify";
+* import Fastify from "fastify";
+*
+* const fastify = Fastify();
+*
+* const federation = createFederation({ kv: new MemoryKvStore() });
+*
+* // Add federation routes
+* federation.setActorDispatcher("/users/{identifier}", async (ctx, identifier) => {
+*   return new Person({
+*     id: ctx.getActorUri(identifier),
+*     preferredUsername: identifier,
+*   });
+* });
+*
+* // Register the plugin
+* await fastify.register(fedifyPlugin, {
+*   federation,
+*   contextDataFactory: () => undefined,
+*   errorHandlers: { onNotFound: () => new Response("Not Found", { status: 404 }) },
+* });
+* ```
+*/
+const fedifyPluginCore = (fastify, options) => {
+	const { federation, contextDataFactory = () => void 0, errorHandlers } = options;
+	fastify.addHook("onRequest", async (request, reply) => {
+		const webRequest = toWebRequest(request);
+		const contextData = await contextDataFactory(request);
+		const response = await federation.fetch(webRequest, {
+			contextData,
+			onNotAcceptable: () => defaultNotAcceptableResponse,
+			onNotFound: () => dummyNotFoundResponse,
+			...errorHandlers
+		});
+		if (response === dummyNotFoundResponse) return;
+		await reply.send(response);
+	});
+	return Promise.resolve();
+};
+const fedifyPlugin = fp(fedifyPluginCore, {
+	name: "fedify-plugin",
+	fastify: "5.x"
+});
+const dummyNotFoundResponse = new Response("", { status: 404 });
+const defaultNotAcceptableResponse = new Response("Not Acceptable", {
+	status: 406,
+	headers: {
+		"Content-Type": "text/plain",
+		Vary: "Accept"
+	}
+});
+/**
+* Convert Fastify request to Web API Request.
+*/
+function toWebRequest(fastifyReq) {
+	const protocol = fastifyReq.protocol;
+	const host = fastifyReq.headers.host ?? fastifyReq.hostname;
+	const url = `${protocol}://${host}${fastifyReq.url}`;
+	const headers = new Headers();
+	for (const [key, value] of Object.entries(fastifyReq.raw.headers)) if (Array.isArray(value)) for (const v of value) headers.append(key, v);
+	else if (value !== void 0) headers.set(key, String(value));
+	const body = fastifyReq.method === "GET" || fastifyReq.method === "HEAD" ? void 0 : fastifyReq.body !== void 0 ? typeof fastifyReq.body === "string" ? fastifyReq.body : JSON.stringify(fastifyReq.body) : Readable.toWeb(fastifyReq.raw);
+	return new Request(url, {
+		method: fastifyReq.method,
+		headers,
+		body
+	});
+}
+var src_default = fedifyPlugin;
+
+//#endregion
+export { src_default as default, fedifyPlugin };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@fedify/fastify",
+  "version": "1.9.0",
+  "description": "Integrate Fedify with Fastify",
+  "keywords": [
+    "Fedify",
+    "Fastify"
+  ],
+  "license": "MIT",
+  "author": "An Nyeong <me@annyeong.me>",
+  "homepage": "https://fedify.dev/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fedify-dev/fedify.git",
+    "directory": "packages/fastify"
+  },
+  "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",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "import": "./dist/index.cjs",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "dependencies": {
+    "fastify-plugin": "^5.0.1"
+  },
+  "peerDependencies": {
+    "fastify": "^5.2.0",
+    "@fedify/fedify": "1.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.16.0",
+    "tsdown": "^0.12.9",
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepublish": "tsdown",
+    "test": "tsdown && node --experimental-transform-types --test"
+  }
+}