@fedify/next 1.9.0-pr.355.1353

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,204 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/next: Integrate Fedify with Next.js
+===========================================
+
+[![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
+
+This package provides a simple way to integrate [Fedify] with [Next.js].
+
+> [!IMPORTANT]
+> We recommend initializing your app using the `init` command of the
+> [Fedify CLI] rather than installing this package directly.
+
+> [!IMPORTANT]
+> This package runs Next.js middleware on the Node.js runtime.
+> Therefore, you must use version 15.5 or later, or at least 15.4 canary.
+> For more details, refer to the [official documentation of `middleware`].
+
+
+
+### Usage
+
+~~~~ typescript
+// --- middleware.ts ---
+import { fedifyWith } from "@fedify/next";
+import { federation } from "./federation";
+
+export default fedifyWith(federation)();
+
+// This config must be defined on `middleware.ts`.
+export const config = {
+  runtime: "nodejs",
+  matcher: [{
+    source: "/:path*",
+    has: [
+      {
+        type: "header",
+        key: "Accept",
+        value: ".*application\\/((jrd|activity|ld)\\+json|xrd\\+xml).*",
+      },
+    ],
+  }],
+};
+~~~~
+
+
+The integration code looks like this:
+
+
+~~~~ typescript
+/**
+ * Fedify with Next.js
+ * ===================
+ *
+ * This module provides a [Next.js] middleware to integrate with the Fedify.
+ *
+ * [Next.js]: https://nextjs.org/
+ *
+ * @module
+ * @since 1.9.0
+ */
+import type { Federation, FederationFetchOptions } from "@fedify/fedify";
+import { notFound } from "next/navigation";
+import { NextResponse } from "next/server";
+import { getXForwardedRequest } from "x-forwarded-fetch";
+
+interface ContextDataFactory<TContextData> {
+  (request: Request):
+    | TContextData
+    | Promise<TContextData>;
+}
+type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
+
+/**
+ * Wrapper function for Next.js middleware to integrate with the
+ * {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the
+ *                         {@link Federation} object.
+ * @param {Federation<TContextData>} federation A {@link Federation} object
+ *                         to integrate with Next.js.
+ * @param {ContextDataFactory<TContextData>} contextDataFactory A function
+ *                         to create a context data for the
+ *                         {@link Federation} object.
+ * @param {Partial<ErrorHandlers>} errorHandlers A set of error handlers to
+ *                         handle errors during the federation fetch.
+ * @returns A Next.js middleware function to integrate with the
+ *          {@link Federation} object.
+ *
+ * @example
+ * ```ts
+ * import { fedifyWith } from "@fedify/next";
+ * import { federation } from "./federation";
+ *
+ * export default fedifyWith(federation)(
+ *   function (request: Request) {
+ *     // You can add custom logic here for other requests
+ *     // except federation requests.  If there is no custom logic,
+ *     // you can omit this function.
+ *   }
+ * )
+ *
+ * // This config makes middleware process only requests with the
+ * // "Accept" header matching the federation accept regex.
+ * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
+ * export const config = {
+ *   runtime: "nodejs",
+ *   matcher: [{
+ *     source: "/:path*",
+ *     has: [
+ *       {
+ *         type: "header",
+ *         key: "Accept",
+ *         value: ".*application\\/((jrd|activity|ld)\\+json|xrd\\+xml).*",
+ *       },
+ *     ],
+ *   }],
+ * };
+ * ```
+ */
+export const fedifyWith = <TContextData>(
+  federation: Federation<TContextData>,
+  contextDataFactory?: ContextDataFactory<TContextData>,
+  errorHandlers?: Partial<ErrorHandlers>,
+) =>
+(
+  middleware: (request: Request) => unknown =
+    ((_: Request) => NextResponse.next()),
+): (request: Request) => unknown =>
+async (request: Request) => {
+  if (hasFederationAcceptHeader(request)) {
+    return await integrateFederation(
+      federation,
+      contextDataFactory,
+      errorHandlers,
+    )(request);
+  }
+  return await middleware(request);
+};
+
+/**
+ * Check if the request has the "Accept" header matching the federation
+ * accept regex.
+ *
+ * @param {Request} request The request to check.
+ * @returns {boolean} `true` if the request has the "Accept" header matching
+ *                    the federation accept regex, `false` otherwise.
+ */
+export const hasFederationAcceptHeader = (request: Request): boolean => {
+  const acceptHeader = request.headers.get("Accept");
+  // Check if the Accept header matches the federation accept regex.
+  // If the header is not present, return false.
+  return acceptHeader ? FEDERATION_ACCEPT_REGEX.test(acceptHeader) : false;
+};
+const FEDERATION_ACCEPT_REGEX =
+  /.*application\/((jrd|activity|ld)\+json|xrd\+xml).*/;
+
+/**
+ * Create a Next.js handler to integrate with the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the
+ *                         {@link Federation} object.
+ * @param {Federation<TContextData>} federation A {@link Federation} object
+ *                         to integrate with Next.js.
+ * @param {ContextDataFactory<TContextData>} contextDataFactory A function
+ *                         to create a context data for the
+ *                         {@link Federation} object.
+ * @param {Partial<ErrorHandlers>} errorHandlers A set of error handlers to
+ *                         handle errors during the federation fetch.
+ * @returns A Next.js handler.
+ */
+export function integrateFederation<TContextData>(
+  federation: Federation<TContextData>,
+  contextDataFactory: ContextDataFactory<TContextData> = () =>
+    undefined as TContextData,
+  errorHandlers?: Partial<ErrorHandlers>,
+) {
+  return async (request: Request) => {
+    const forwardedRequest = await getXForwardedRequest(request);
+    const contextData = await contextDataFactory(forwardedRequest);
+    return await federation.fetch(
+      forwardedRequest,
+      {
+        contextData,
+        onNotFound: notFound,
+        onNotAcceptable,
+        ...errorHandlers,
+      },
+    );
+  };
+}
+const onNotAcceptable = () =>
+  new Response("Not acceptable", {
+    status: 406,
+    headers: { "Content-Type": "text/plain", Vary: "Accept" },
+  });
+~~~~
+
+[@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/
+[Next.js]: https://nextjs.org/
+[official documentation of `middleware`]: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#runtime
+[Fedify CLI]: https://www.npmjs.com/package/@fedify/cli

package/dist/index.d.mts

@@ -0,0 +1,78 @@
+import { Federation, FederationFetchOptions } from "@fedify/fedify";
+
+//#region src/index.d.ts
+
+interface ContextDataFactory<TContextData> {
+  (request: Request): TContextData | Promise<TContextData>;
+}
+type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
+/**
+ * Wrapper function for Next.js middleware to integrate with the
+ * {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the
+ *                         {@link Federation} object.
+ * @param federation A {@link Federation} object to integrate with Next.js.
+ * @param contextDataFactory A function to create a context data for the
+ *                         {@link Federation} object.
+ * @param errorHandlers A set of error handlers to handle errors during
+ *                      the federation fetch.
+ * @returns A Next.js middleware function to integrate with the
+ *          {@link Federation} object.
+ *
+ * @example
+ * ```ts ignore
+ * import { fedifyWith } from "@fedify/next";
+ * import { federation } from "./federation";
+ *
+ * export default fedifyWith(federation)(
+ *   function (request: Request) {
+ *     // You can add custom logic here for other requests
+ *     // except federation requests.  If there is no custom logic,
+ *     // you can omit this function.
+ *   }
+ * )
+ *
+ * // This config makes middleware process only requests with the
+ * // "Accept" header matching the federation accept regex.
+ * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
+ * export const config = {
+ *   runtime: "nodejs",
+ *   matcher: [{
+ *     source: "/:path*",
+ *     has: [
+ *       {
+ *         type: "header",
+ *         key: "Accept",
+ *         value: ".*application\\/((jrd|activity|ld)\\+json|xrd\\+xml).*",
+ *       },
+ *     ],
+ *   }],
+ * };
+ * ```
+ */
+declare const fedifyWith: <TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>) => (middleware?: (request: Request) => unknown) => (request: Request) => unknown;
+/**
+ * Check if the request has the "Accept" header matching the federation
+ * accept regex.
+ *
+ * @param request The request to check.
+ * @returns `true` if the request has the "Accept" header matching
+ *                    the federation accept regex, `false` otherwise.
+ */
+declare const hasFederationAcceptHeader: (request: Request) => boolean;
+/**
+ * Create a Next.js handler to integrate with the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the
+ *                        {@link Federation} object.
+ * @param federation A {@link Federation} object to integrate with Next.js.
+ * @param contextDataFactory A function to create a context data for the
+ *                           {@link Federation} object.
+ * @param errorHandlers A set of error handlers to handle errors during
+ *                      the federation fetch.
+ * @returns A Next.js handler.
+ */
+declare function integrateFederation<TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>): (request: Request) => Promise<Response>;
+//#endregion
+export { fedifyWith, hasFederationAcceptHeader, integrateFederation };

package/dist/index.d.ts

@@ -0,0 +1,78 @@
+import { Federation, FederationFetchOptions } from "@fedify/fedify";
+
+//#region src/index.d.ts
+
+interface ContextDataFactory<TContextData> {
+  (request: Request): TContextData | Promise<TContextData>;
+}
+type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
+/**
+ * Wrapper function for Next.js middleware to integrate with the
+ * {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the
+ *                         {@link Federation} object.
+ * @param federation A {@link Federation} object to integrate with Next.js.
+ * @param contextDataFactory A function to create a context data for the
+ *                         {@link Federation} object.
+ * @param errorHandlers A set of error handlers to handle errors during
+ *                      the federation fetch.
+ * @returns A Next.js middleware function to integrate with the
+ *          {@link Federation} object.
+ *
+ * @example
+ * ```ts ignore
+ * import { fedifyWith } from "@fedify/next";
+ * import { federation } from "./federation";
+ *
+ * export default fedifyWith(federation)(
+ *   function (request: Request) {
+ *     // You can add custom logic here for other requests
+ *     // except federation requests.  If there is no custom logic,
+ *     // you can omit this function.
+ *   }
+ * )
+ *
+ * // This config makes middleware process only requests with the
+ * // "Accept" header matching the federation accept regex.
+ * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
+ * export const config = {
+ *   runtime: "nodejs",
+ *   matcher: [{
+ *     source: "/:path*",
+ *     has: [
+ *       {
+ *         type: "header",
+ *         key: "Accept",
+ *         value: ".*application\\/((jrd|activity|ld)\\+json|xrd\\+xml).*",
+ *       },
+ *     ],
+ *   }],
+ * };
+ * ```
+ */
+declare const fedifyWith: <TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>) => (middleware?: (request: Request) => unknown) => (request: Request) => unknown;
+/**
+ * Check if the request has the "Accept" header matching the federation
+ * accept regex.
+ *
+ * @param request The request to check.
+ * @returns `true` if the request has the "Accept" header matching
+ *                    the federation accept regex, `false` otherwise.
+ */
+declare const hasFederationAcceptHeader: (request: Request) => boolean;
+/**
+ * Create a Next.js handler to integrate with the {@link Federation} object.
+ *
+ * @template TContextData A type of the context data for the
+ *                        {@link Federation} object.
+ * @param federation A {@link Federation} object to integrate with Next.js.
+ * @param contextDataFactory A function to create a context data for the
+ *                           {@link Federation} object.
+ * @param errorHandlers A set of error handlers to handle errors during
+ *                      the federation fetch.
+ * @returns A Next.js handler.
+ */
+declare function integrateFederation<TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>): (request: Request) => Promise<Response>;
+//#endregion
+export { fedifyWith, hasFederationAcceptHeader, integrateFederation };

package/dist/index.js

@@ -0,0 +1,121 @@
+//#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 next_navigation = __toESM(require("next/navigation"));
+const next_server = __toESM(require("next/server"));
+
+//#region src/index.ts
+/**
+* Wrapper function for Next.js middleware to integrate with the
+* {@link Federation} object.
+*
+* @template TContextData A type of the context data for the
+*                         {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with Next.js.
+* @param contextDataFactory A function to create a context data for the
+*                         {@link Federation} object.
+* @param errorHandlers A set of error handlers to handle errors during
+*                      the federation fetch.
+* @returns A Next.js middleware function to integrate with the
+*          {@link Federation} object.
+*
+* @example
+* ```ts ignore
+* import { fedifyWith } from "@fedify/next";
+* import { federation } from "./federation";
+*
+* export default fedifyWith(federation)(
+*   function (request: Request) {
+*     // You can add custom logic here for other requests
+*     // except federation requests.  If there is no custom logic,
+*     // you can omit this function.
+*   }
+* )
+*
+* // This config makes middleware process only requests with the
+* // "Accept" header matching the federation accept regex.
+* // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
+* export const config = {
+*   runtime: "nodejs",
+*   matcher: [{
+*     source: "/:path*",
+*     has: [
+*       {
+*         type: "header",
+*         key: "Accept",
+*         value: ".*application\\/((jrd|activity|ld)\\+json|xrd\\+xml).*",
+*       },
+*     ],
+*   }],
+* };
+* ```
+*/
+const fedifyWith = (federation, contextDataFactory, errorHandlers) => (middleware = (_) => next_server.NextResponse.next()) => async (request) => {
+	if (hasFederationAcceptHeader(request)) return await integrateFederation(federation, contextDataFactory, errorHandlers)(request);
+	return await middleware(request);
+};
+/**
+* Check if the request has the "Accept" header matching the federation
+* accept regex.
+*
+* @param request The request to check.
+* @returns `true` if the request has the "Accept" header matching
+*                    the federation accept regex, `false` otherwise.
+*/
+const hasFederationAcceptHeader = (request) => {
+	const acceptHeader = request.headers.get("Accept");
+	return acceptHeader ? FEDERATION_ACCEPT_REGEX.test(acceptHeader) : false;
+};
+const FEDERATION_ACCEPT_REGEX = /.*application\/((jrd|activity|ld)\+json|xrd\+xml).*/;
+/**
+* Create a Next.js handler to integrate with the {@link Federation} object.
+*
+* @template TContextData A type of the context data for the
+*                        {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with Next.js.
+* @param contextDataFactory A function to create a context data for the
+*                           {@link Federation} object.
+* @param errorHandlers A set of error handlers to handle errors during
+*                      the federation fetch.
+* @returns A Next.js handler.
+*/
+function integrateFederation(federation, contextDataFactory = () => void 0, errorHandlers) {
+	return async (request) => await federation.fetch(request, {
+		contextData: await contextDataFactory(request),
+		onNotFound: next_navigation.notFound,
+		onNotAcceptable,
+		...errorHandlers
+	});
+}
+const onNotAcceptable = () => new Response("Not acceptable", {
+	status: 406,
+	headers: {
+		"Content-Type": "text/plain",
+		Vary: "Accept"
+	}
+});
+
+//#endregion
+exports.fedifyWith = fedifyWith;
+exports.hasFederationAcceptHeader = hasFederationAcceptHeader;
+exports.integrateFederation = integrateFederation;

package/dist/index.mjs

@@ -0,0 +1,96 @@
+import { notFound } from "next/navigation";
+import { NextResponse } from "next/server";
+
+//#region src/index.ts
+/**
+* Wrapper function for Next.js middleware to integrate with the
+* {@link Federation} object.
+*
+* @template TContextData A type of the context data for the
+*                         {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with Next.js.
+* @param contextDataFactory A function to create a context data for the
+*                         {@link Federation} object.
+* @param errorHandlers A set of error handlers to handle errors during
+*                      the federation fetch.
+* @returns A Next.js middleware function to integrate with the
+*          {@link Federation} object.
+*
+* @example
+* ```ts ignore
+* import { fedifyWith } from "@fedify/next";
+* import { federation } from "./federation";
+*
+* export default fedifyWith(federation)(
+*   function (request: Request) {
+*     // You can add custom logic here for other requests
+*     // except federation requests.  If there is no custom logic,
+*     // you can omit this function.
+*   }
+* )
+*
+* // This config makes middleware process only requests with the
+* // "Accept" header matching the federation accept regex.
+* // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
+* export const config = {
+*   runtime: "nodejs",
+*   matcher: [{
+*     source: "/:path*",
+*     has: [
+*       {
+*         type: "header",
+*         key: "Accept",
+*         value: ".*application\\/((jrd|activity|ld)\\+json|xrd\\+xml).*",
+*       },
+*     ],
+*   }],
+* };
+* ```
+*/
+const fedifyWith = (federation, contextDataFactory, errorHandlers) => (middleware = (_) => NextResponse.next()) => async (request) => {
+	if (hasFederationAcceptHeader(request)) return await integrateFederation(federation, contextDataFactory, errorHandlers)(request);
+	return await middleware(request);
+};
+/**
+* Check if the request has the "Accept" header matching the federation
+* accept regex.
+*
+* @param request The request to check.
+* @returns `true` if the request has the "Accept" header matching
+*                    the federation accept regex, `false` otherwise.
+*/
+const hasFederationAcceptHeader = (request) => {
+	const acceptHeader = request.headers.get("Accept");
+	return acceptHeader ? FEDERATION_ACCEPT_REGEX.test(acceptHeader) : false;
+};
+const FEDERATION_ACCEPT_REGEX = /.*application\/((jrd|activity|ld)\+json|xrd\+xml).*/;
+/**
+* Create a Next.js handler to integrate with the {@link Federation} object.
+*
+* @template TContextData A type of the context data for the
+*                        {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with Next.js.
+* @param contextDataFactory A function to create a context data for the
+*                           {@link Federation} object.
+* @param errorHandlers A set of error handlers to handle errors during
+*                      the federation fetch.
+* @returns A Next.js handler.
+*/
+function integrateFederation(federation, contextDataFactory = () => void 0, errorHandlers) {
+	return async (request) => await federation.fetch(request, {
+		contextData: await contextDataFactory(request),
+		onNotFound: notFound,
+		onNotAcceptable,
+		...errorHandlers
+	});
+}
+const onNotAcceptable = () => new Response("Not acceptable", {
+	status: 406,
+	headers: {
+		"Content-Type": "text/plain",
+		Vary: "Accept"
+	}
+});
+
+//#endregion
+export { fedifyWith, hasFederationAcceptHeader, integrateFederation };

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@fedify/next",
+  "version": "1.9.0-pr.355.1353+2b6be9b6",
+  "description": "Integrate Fedify with Next.js",
+  "keywords": [
+    "Fedify",
+    "ActivityPub",
+    "Fediverse",
+    "Next",
+    "Next.js"
+  ],
+  "author": {
+    "name": "Chanhaeng Lee",
+    "email": "2chanhaeng@gmail.com",
+    "url": "https://chomu.dev"
+  },
+  "homepage": "https://fedify.dev/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fedify-dev/fedify.git",
+    "directory": "packages/next"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/fedify-dev/fedify/issues"
+  },
+  "funding": [
+    "https://opencollective.com/fedify",
+    "https://github.com/sponsors/dahlia"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "next": "^15.4.2-canary",
+    "@fedify/fedify": "1.9.0-pr.355.1353+2b6be9b6"
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.9",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepublish": "tsdown"
+  }
+}