@fedify/express 0.1.0-dev.1

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024 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,39 @@
+@fedify/express: Integrate Fedify with Express
+==============================================
+
+[![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 [Express].
+
+The integration code looks like this:
+
+~~~~ typescript
+import express from "express";
+import { integrateFederation } from "@fedify/express";
+import { federation } from "./federation";  // Your `Federation` instance
+
+export const app = express();
+
+app.set("trust proxy", true);
+
+app.use(integrateFederation(federation, (req) => "context data goes here"));
+~~~~
+
+[npm]: https://www.npmjs.com/package/@fedify/express
+[npm badge]: https://img.shields.io/npm/v/@fedify/express?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/
+[Express]: https://expressjs.com/
+
+
+Changelog
+---------
+
+### Version 0.1.0
+
+To be released.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { Federation } from '@fedify/fedify';
+import { Request, Response, NextFunction } from 'express';
+
+type Middleware = (req: Request, res: Response, next: NextFunction) => void;
+type ContextDataFactory<TContextData> = (req: Request) => TContextData | Promise<TContextData>;
+declare function integrateFederation<TContextData>(federation: Federation<TContextData>, contextDataFactory: ContextDataFactory<TContextData>): Middleware;
+
+export { type ContextDataFactory, integrateFederation };

package/dist/index.js

@@ -0,0 +1,49 @@
+// src/index.ts
+import { Readable } from "node:stream";
+function integrateFederation(federation, contextDataFactory) {
+  return (req, res, next) => {
+    const request = fromERequest(req);
+    const contextData = contextDataFactory(req);
+    const contextDataPromise = contextData instanceof Promise ? contextData : Promise.resolve(contextData);
+    contextDataPromise.then(async (contextData2) => {
+      const response = await federation.fetch(request, {
+        contextData: contextData2,
+        onNotFound: () => {
+          next();
+          return new Response("", { status: 404 });
+        },
+        onNotAcceptable: () => {
+          if (req.route != null) next();
+          return new Response("", { status: 406 });
+        }
+      });
+      setEResponse(res, response);
+    });
+  };
+}
+function fromERequest(req) {
+  const url = `${req.protocol}://${req.header("Host") ?? req.hostname}${req.url}`;
+  const headers = new Headers();
+  for (const [key, value] of Object.entries(req.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: req.method,
+    headers,
+    body: Readable.toWeb(req)
+  });
+}
+function setEResponse(res, response) {
+  res.status(response.status);
+  response.headers.forEach((value, key) => res.setHeader(key, value));
+  if (response.body == null) return;
+  Readable.fromWeb(response.body).pipe(res);
+}
+export {
+  integrateFederation
+};
+//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsiLi4vc3JjL2luZGV4LnRzIl0sCiAgInNvdXJjZXNDb250ZW50IjogWyJpbXBvcnQgeyBSZWFkYWJsZSB9IGZyb20gXCJub2RlOnN0cmVhbVwiO1xuaW1wb3J0IHR5cGUgeyBSZWFkYWJsZVN0cmVhbSBhcyBXZWJSZWFkYWJsZVN0cmVhbSB9IGZyb20gXCJub2RlOnN0cmVhbS93ZWJcIjtcbmltcG9ydCB0eXBlIHsgRmVkZXJhdGlvbiB9IGZyb20gXCJAZmVkaWZ5L2ZlZGlmeVwiO1xuaW1wb3J0IHR5cGUge1xuICBSZXF1ZXN0IGFzIEVSZXF1ZXN0LFxuICBSZXNwb25zZSBhcyBFUmVzcG9uc2UsXG4gIE5leHRGdW5jdGlvbixcbn0gZnJvbSBcImV4cHJlc3NcIjtcblxudHlwZSBNaWRkbGV3YXJlID0gKHJlcTogRVJlcXVlc3QsIHJlczogRVJlc3BvbnNlLCBuZXh0OiBOZXh0RnVuY3Rpb24pID0+IHZvaWQ7XG5cbmV4cG9ydCB0eXBlIENvbnRleHREYXRhRmFjdG9yeTxUQ29udGV4dERhdGE+ID0gKFxuICByZXE6IEVSZXF1ZXN0LFxuKSA9PiBUQ29udGV4dERhdGEgfCBQcm9taXNlPFRDb250ZXh0RGF0YT47XG5cbmV4cG9ydCBmdW5jdGlvbiBpbnRlZ3JhdGVGZWRlcmF0aW9uPFRDb250ZXh0RGF0YT4oXG4gIGZlZGVyYXRpb246IEZlZGVyYXRpb248VENvbnRleHREYXRhPixcbiAgY29udGV4dERhdGFGYWN0b3J5OiBDb250ZXh0RGF0YUZhY3Rvcnk8VENvbnRleHREYXRhPixcbik6IE1pZGRsZXdhcmUge1xuICByZXR1cm4gKHJlcSwgcmVzLCBuZXh0KSA9PiB7XG4gICAgY29uc3QgcmVxdWVzdCA9IGZyb21FUmVxdWVzdChyZXEpO1xuICAgIGNvbnN0IGNvbnRleHREYXRhID0gY29udGV4dERhdGFGYWN0b3J5KHJlcSk7XG4gICAgY29uc3QgY29udGV4dERhdGFQcm9taXNlID1cbiAgICAgIGNvbnRleHREYXRhIGluc3RhbmNlb2YgUHJvbWlzZVxuICAgICAgICA/IGNvbnRleHREYXRhXG4gICAgICAgIDogUHJvbWlzZS5yZXNvbHZlKGNvbnRleHREYXRhKTtcbiAgICBjb250ZXh0RGF0YVByb21pc2UudGhlbihhc3luYyAoY29udGV4dERhdGEpID0+IHtcbiAgICAgIGNvbnN0IHJlc3BvbnNlID0gYXdhaXQgZmVkZXJhdGlvbi5mZXRjaChyZXF1ZXN0LCB7XG4gICAgICAgIGNvbnRleHREYXRhLFxuICAgICAgICBvbk5vdEZvdW5kOiAoKSA9PiB7XG4gICAgICAgICAgLy8gSWYgdGhlIGBmZWRlcmF0aW9uYCBvYmplY3QgZmluZHMgYSByZXF1ZXN0IG5vdCByZXNwb25zaWJsZSBmb3IgaXRcbiAgICAgICAgICAvLyAoaS5lLiwgbm90IGEgZmVkZXJhdGlvbi1yZWxhdGVkIHJlcXVlc3QpLCBpdCB3aWxsIGNhbGwgdGhlIGBuZXh0YFxuICAgICAgICAgIC8vIGZ1bmN0aW9uIHByb3ZpZGVkIGJ5IHRoZSBFeHByZXNzIGZyYW1ld29yayB0byBjb250aW51ZSB0aGUgcmVxdWVzdFxuICAgICAgICAgIC8vIGhhbmRsaW5nIGJ5IHRoZSBFeHByZXNzOlxuICAgICAgICAgIG5leHQoKTtcbiAgICAgICAgICByZXR1cm4gbmV3IFJlc3BvbnNlKFwiXCIsIHsgc3RhdHVzOiA0MDQgfSk7IC8vIHVudXNlZFxuICAgICAgICB9LFxuICAgICAgICBvbk5vdEFjY2VwdGFibGU6ICgpID0+IHtcbiAgICAgICAgICAvLyBTaW1pbGFyIHRvIGBvbk5vdEZvdW5kYCwgYnV0IHNsaWdodGx5IG1vcmUgdHJpY2t5LlxuICAgICAgICAgIC8vIFdoZW4gdGhlIGBmZWRlcmF0aW9uYCBvYmplY3QgZmluZHMgYSByZXF1ZXN0IG5vdCBhY2NlcHRhYmxlXG4gICAgICAgICAgLy8gdHlwZS13aXNlIChpLmUuLCBhIHVzZXItYWdlbnQgZG9lc24ndCB3YW50IEpTT04tTEQpLCBpdCB3aWxsIGNhbGxcbiAgICAgICAgICAvLyB0aGUgYG5leHRgIGZ1bmN0aW9uIHByb3ZpZGVkIGJ5IHRoZSBFeHByZXNzIGZyYW1ld29yayB0byBjb250aW51ZVxuICAgICAgICAgIC8vIGlmIGFueSByb3V0ZSBpcyBtYXRjaGVkLCBhbmQgb3RoZXJ3aXNlLCBpdCB3aWxsIHJldHVybiBhIDQwNiBOb3RcbiAgICAgICAgICAvLyBBY2NlcHRhYmxlIHJlc3BvbnNlOlxuICAgICAgICAgIGlmIChyZXEucm91dGUgIT0gbnVsbCkgbmV4dCgpO1xuICAgICAgICAgIHJldHVybiBuZXcgUmVzcG9uc2UoXCJcIiwgeyBzdGF0dXM6IDQwNiB9KTtcbiAgICAgICAgfSxcbiAgICAgIH0pO1xuICAgICAgc2V0RVJlc3BvbnNlKHJlcywgcmVzcG9uc2UpO1xuICAgIH0pO1xuICB9O1xufVxuXG5mdW5jdGlvbiBmcm9tRVJlcXVlc3QocmVxOiBFUmVxdWVzdCk6IFJlcXVlc3Qge1xuICBjb25zdCB1cmwgPSBgJHtyZXEucHJvdG9jb2x9Oi8vJHtyZXEuaGVhZGVyKFwiSG9zdFwiKSA/PyByZXEuaG9zdG5hbWV9JHtyZXEudXJsfWA7XG4gIGNvbnN0IGhlYWRlcnMgPSBuZXcgSGVhZGVycygpO1xuICBmb3IgKGNvbnN0IFtrZXksIHZhbHVlXSBvZiBPYmplY3QuZW50cmllcyhyZXEuaGVhZGVycykpIHtcbiAgICBpZiAoQXJyYXkuaXNBcnJheSh2YWx1ZSkpIHtcbiAgICAgIGZvciAoY29uc3QgdiBvZiB2YWx1ZSkgaGVhZGVycy5hcHBlbmQoa2V5LCB2KTtcbiAgICB9IGVsc2UgaWYgKHR5cGVvZiB2YWx1ZSA9PT0gXCJzdHJpbmdcIikge1xuICAgICAgaGVhZGVycy5hcHBlbmQoa2V5LCB2YWx1ZSk7XG4gICAgfVxuICB9XG4gIHJldHVybiBuZXcgUmVxdWVzdCh1cmwsIHtcbiAgICBtZXRob2Q6IHJlcS5tZXRob2QsXG4gICAgaGVhZGVycyxcbiAgICBib2R5OiBSZWFkYWJsZS50b1dlYihyZXEpIGFzIFJlYWRhYmxlU3RyZWFtPFVpbnQ4QXJyYXk+LFxuICB9KTtcbn1cblxuZnVuY3Rpb24gc2V0RVJlc3BvbnNlKHJlczogRVJlc3BvbnNlLCByZXNwb25zZTogUmVzcG9uc2UpOiB2b2lkIHtcbiAgcmVzLnN0YXR1cyhyZXNwb25zZS5zdGF0dXMpO1xuICByZXNwb25zZS5oZWFkZXJzLmZvckVhY2goKHZhbHVlLCBrZXkpID0+IHJlcy5zZXRIZWFkZXIoa2V5LCB2YWx1ZSkpO1xuICBpZiAocmVzcG9uc2UuYm9keSA9PSBudWxsKSByZXR1cm47XG4gIC8vIGJpb21lLWlnbm9yZSBsaW50L3N1c3BpY2lvdXMvbm9FeHBsaWNpdEFueTogUmVhZGFibGUuZnJvbVdlYiBpcyB1bnR5cGVkXG4gIFJlYWRhYmxlLmZyb21XZWIocmVzcG9uc2UuYm9keSBhcyBXZWJSZWFkYWJsZVN0cmVhbTxhbnk+KS5waXBlKHJlcyk7XG59XG4iXSwKICAibWFwcGluZ3MiOiAiO0FBQUEsU0FBUyxnQkFBZ0I7QUFlbEIsU0FBUyxvQkFDZCxZQUNBLG9CQUNZO0FBQ1osU0FBTyxDQUFDLEtBQUssS0FBSyxTQUFTO0FBQ3pCLFVBQU0sVUFBVSxhQUFhLEdBQUc7QUFDaEMsVUFBTSxjQUFjLG1CQUFtQixHQUFHO0FBQzFDLFVBQU0scUJBQ0osdUJBQXVCLFVBQ25CLGNBQ0EsUUFBUSxRQUFRLFdBQVc7QUFDakMsdUJBQW1CLEtBQUssT0FBT0EsaUJBQWdCO0FBQzdDLFlBQU0sV0FBVyxNQUFNLFdBQVcsTUFBTSxTQUFTO0FBQUEsUUFDL0MsYUFBQUE7QUFBQSxRQUNBLFlBQVksTUFBTTtBQUtoQixlQUFLO0FBQ0wsaUJBQU8sSUFBSSxTQUFTLElBQUksRUFBRSxRQUFRLElBQUksQ0FBQztBQUFBLFFBQ3pDO0FBQUEsUUFDQSxpQkFBaUIsTUFBTTtBQU9yQixjQUFJLElBQUksU0FBUyxLQUFNLE1BQUs7QUFDNUIsaUJBQU8sSUFBSSxTQUFTLElBQUksRUFBRSxRQUFRLElBQUksQ0FBQztBQUFBLFFBQ3pDO0FBQUEsTUFDRixDQUFDO0FBQ0QsbUJBQWEsS0FBSyxRQUFRO0FBQUEsSUFDNUIsQ0FBQztBQUFBLEVBQ0g7QUFDRjtBQUVBLFNBQVMsYUFBYSxLQUF3QjtBQUM1QyxRQUFNLE1BQU0sR0FBRyxJQUFJLFFBQVEsTUFBTSxJQUFJLE9BQU8sTUFBTSxLQUFLLElBQUksUUFBUSxHQUFHLElBQUksR0FBRztBQUM3RSxRQUFNLFVBQVUsSUFBSSxRQUFRO0FBQzVCLGFBQVcsQ0FBQyxLQUFLLEtBQUssS0FBSyxPQUFPLFFBQVEsSUFBSSxPQUFPLEdBQUc7QUFDdEQsUUFBSSxNQUFNLFFBQVEsS0FBSyxHQUFHO0FBQ3hCLGlCQUFXLEtBQUssTUFBTyxTQUFRLE9BQU8sS0FBSyxDQUFDO0FBQUEsSUFDOUMsV0FBVyxPQUFPLFVBQVUsVUFBVTtBQUNwQyxjQUFRLE9BQU8sS0FBSyxLQUFLO0FBQUEsSUFDM0I7QUFBQSxFQUNGO0FBQ0EsU0FBTyxJQUFJLFFBQVEsS0FBSztBQUFBLElBQ3RCLFFBQVEsSUFBSTtBQUFBLElBQ1o7QUFBQSxJQUNBLE1BQU0sU0FBUyxNQUFNLEdBQUc7QUFBQSxFQUMxQixDQUFDO0FBQ0g7QUFFQSxTQUFTLGFBQWEsS0FBZ0IsVUFBMEI7QUFDOUQsTUFBSSxPQUFPLFNBQVMsTUFBTTtBQUMxQixXQUFTLFFBQVEsUUFBUSxDQUFDLE9BQU8sUUFBUSxJQUFJLFVBQVUsS0FBSyxLQUFLLENBQUM7QUFDbEUsTUFBSSxTQUFTLFFBQVEsS0FBTTtBQUUzQixXQUFTLFFBQVEsU0FBUyxJQUE4QixFQUFFLEtBQUssR0FBRztBQUNwRTsiLAogICJuYW1lcyI6IFsiY29udGV4dERhdGEiXQp9Cg==

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@fedify/express",
+  "version": "0.1.0-dev.1+c0c51847",
+  "description": "Integrate Fedify with Express",
+  "keywords": [
+    "Fedify",
+    "Express",
+    "Express.js"
+  ],
+  "author": {
+    "name": "Hong Minhee",
+    "email": "hong@minhee.org",
+    "url": "https://hongminhee.org/"
+  },
+  "homepage": "https://github.com/dahlia/fedify-express",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dahlia/fedify-express.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dahlia/fedify-express/issues"
+  },
+  "type": "module",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "src/",
+    "dist/"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "1.8.3",
+    "@types/express": ">=4.0.0, <5",
+    "@types/node": "^20.14.10",
+    "express": ">= 4.0.0, < 5",
+    "tsup": "^8.1.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@fedify/fedify": ">=0.12.0, <1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "prepack": "tsup"
+  }
+}

package/src/index.ts

@@ -0,0 +1,77 @@
+import { Readable } from "node:stream";
+import type { ReadableStream as WebReadableStream } from "node:stream/web";
+import type { Federation } from "@fedify/fedify";
+import type {
+  Request as ERequest,
+  Response as EResponse,
+  NextFunction,
+} from "express";
+
+type Middleware = (req: ERequest, res: EResponse, next: NextFunction) => void;
+
+export type ContextDataFactory<TContextData> = (
+  req: ERequest,
+) => TContextData | Promise<TContextData>;
+
+export function integrateFederation<TContextData>(
+  federation: Federation<TContextData>,
+  contextDataFactory: ContextDataFactory<TContextData>,
+): Middleware {
+  return (req, res, next) => {
+    const request = fromERequest(req);
+    const contextData = contextDataFactory(req);
+    const contextDataPromise =
+      contextData instanceof Promise
+        ? contextData
+        : Promise.resolve(contextData);
+    contextDataPromise.then(async (contextData) => {
+      const response = await federation.fetch(request, {
+        contextData,
+        onNotFound: () => {
+          // If the `federation` object finds a request not responsible for it
+          // (i.e., not a federation-related request), it will call the `next`
+          // function provided by the Express framework to continue the request
+          // handling by the Express:
+          next();
+          return new Response("", { status: 404 }); // unused
+        },
+        onNotAcceptable: () => {
+          // Similar to `onNotFound`, but slightly more tricky.
+          // When the `federation` object finds a request not acceptable
+          // type-wise (i.e., a user-agent doesn't want JSON-LD), it will call
+          // the `next` function provided by the Express framework to continue
+          // if any route is matched, and otherwise, it will return a 406 Not
+          // Acceptable response:
+          if (req.route != null) next();
+          return new Response("", { status: 406 });
+        },
+      });
+      setEResponse(res, response);
+    });
+  };
+}
+
+function fromERequest(req: ERequest): Request {
+  const url = `${req.protocol}://${req.header("Host") ?? req.hostname}${req.url}`;
+  const headers = new Headers();
+  for (const [key, value] of Object.entries(req.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: req.method,
+    headers,
+    body: Readable.toWeb(req) as ReadableStream<Uint8Array>,
+  });
+}
+
+function setEResponse(res: EResponse, response: Response): void {
+  res.status(response.status);
+  response.headers.forEach((value, key) => res.setHeader(key, value));
+  if (response.body == null) return;
+  // biome-ignore lint/suspicious/noExplicitAny: Readable.fromWeb is untyped
+  Readable.fromWeb(response.body as WebReadableStream<any>).pipe(res);
+}