Rename @fedify/nextjs to @fedify/next

2chanhaeng · 2chanhaeng · commit 7f76abd165a2 · 2025-08-20T04:45:12.000Z
fedify-dev#355 (comment) Rename `@fedify/nextjs` to `@fedify/next` fedify-dev#355 (comment) Rename `@fedify/nextjs` to `@fedify/next` fedify-dev#355 (comment) Rename `@fedify/nextjs` to `@fedify/next` fedify-dev#355 (comment) Rename `@fedify/nextjs` to `@fedify/next` fedify-dev#355 (comment)
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -425,6 +425,7 @@ jobs:
           | @fedify/express  | ${{ steps.versioning.outputs.version }} | [JSR][jsr:@fedify/express]  | [npm][npm:@fedify/express]  |
           | @fedify/h3       | ${{ steps.versioning.outputs.version }} | [JSR][jsr:@fedify/h3]       | [npm][npm:@fedify/h3]       |
           | @fedify/nestjs   | ${{ steps.versioning.outputs.version }} |                             | [npm][npm:@fedify/nestjs]   |
+          | @fedify/next     | ${{ steps.versioning.outputs.version }} |                             | [npm][npm:@fedify/next]     |
           | @fedify/postgres | ${{ steps.versioning.outputs.version }} | [JSR][jsr:@fedify/postgres] | [npm][npm:@fedify/postgres] |
           | @fedify/redis    | ${{ steps.versioning.outputs.version }} | [JSR][jsr:@fedify/redis]    | [npm][npm:@fedify/redis]    |
           | @fedify/sqlite   | ${{ steps.versioning.outputs.version }} | [JSR][jsr:@fedify/sqlite]   | [npm][npm:@fedify/sqlite]   |
diff --git a/AGENTS.md b/AGENTS.md
@@ -70,6 +70,7 @@ The repository is organized as a monorepo with the following packages:
  -  *packages/postgres/*: PostgreSQL drivers (@fedify/postgres)
  -  *packages/redis/*: Redis drivers (@fedify/redis)
  -  *packages/nestjs/*: NestJS integration (@fedify/nestjs)
+ -  *packages/next/*: Next.js integration (@fedify/next)
  -  *packages/sqlite/*: SQLite driver (@fedify/sqlite)
  -  *packages/testing/*: Testing utilities (@fedify/testing)
  -  *docs/*: Documentation built with Node.js and VitePress
diff --git a/CHANGES.md b/CHANGES.md
@@ -8,6 +8,21 @@ Version 1.8.6
 
 To be released.
 
+### @fedify/next
+
+ -  Created [Next.js] integration as the *@fedify/next* package.
+      [[#313] by Chanhaeng Lee]
+
+### @fedify/cli
+
+ -  Added `Next.js` option to `fedify init` command. This option allows users
+    to initialize a new Fedify project with Next.js integration.
+    [[#313] by Chanhaeng Lee]
+
+
+[Next.js]: https://nextjs.org/
+[#313]: https://github.com/fedify-dev/fedify/issues/313
+
 
 Version 1.8.5
 -------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -193,6 +193,7 @@ The repository is organized as a monorepo with the following packages:
  -  *packages/postgres/*: PostgreSQL drivers (@fedify/postgres) for Fedify.
  -  *packages/redis/*: Redis drivers (@fedify/redis) for Fedify.
  -  *packages/nestjs/*: NestJS integration (@fedify/nestjs) for Fedify.
+ -  *packages/next/*: Next.js integration (@fedify/next) for Fedify.
  -  *packages/sqlite/*: SQLite driver (@fedify/sqlite) for Fedify.
  -  *packages/testing/*: Testing utilities (@fedify/testing) for Fedify.
  -  *docs/*: The Fedify docs.  The docs are built with [Node.js] and
diff --git a/docs/manual/integration.md b/docs/manual/integration.md
@@ -480,6 +480,81 @@ console.log("Elysia App Start!");
 [Elysia]: https://elysiajs.com/
 
 
+Next.js
+------
+
+*This API is available since Fedify 1.9.0.*
+
+[Next.js] is a React framework that enables you to build server-rendered
+and statically generated web applications.  Fedify has the `@fedify/next`
+module that provides a middleware to integrate Fedify with Next.js.  Create
+an app with the following command using the Fedify CLI:
+
+~~~~ sh
+fedify init my-next-app
+
+? Choose the JavaScript runtime to use › Node.js
+? Choose the package manager to use › npm
+? Choose the web framework to integrate Fedify with › Next.js
+? Choose the key–value store to use for caching › In-memory
+? Choose the message queue to use for background jobs › In-process
+✔ Would you like your code inside a `src/` directory? … No
+✔ Would you like to customize the import alias (`@/*` by default)? … No
+~~~~
+
+Then you can see the Next.js boilerplate code in the `my-next-app` directory.
+But if you created a Next.js app with `create-next-app` before, you'll see
+some differences in the code. There is a `middleware.ts` file in the
+`my-next-app` directory, which is the entry point to the Fedify middleware
+from the Next.js framework:
+
+
+~~~~ typescript
+import { fedifyWith } from "@fedify/next";
+import federation from "./federation";
+
+export default fedifyWith(federation)(
+/*
+  function (request: Request) {
+    // If you need to handle other requests besides federation
+    // requests in middleware, you can do it here.
+    // If you handle only federation requests in middleware,
+    // you don't need this function.
+    return NextResponse.next();
+  },
+*/
+)
+
+// This config needs because 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).*",
+      },
+    ],
+  }],
+};
+~~~~
+
+As you can see in the comment, you can handle other requests besides
+federation requests in the middleware.  If you handle only federation requests
+in the middleware, you can omit the function argument of `fedifyWith()`.
+The `config` object is necessary to let Next.js know that the middleware
+should process requests with the `Accept` header matching the federation
+accept regex.  This is because Next.js middleware processes only requests
+with the `Accept` header matching the regex by default.  More details can be
+found in the [Next.js documentation](https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional).
+
+[Next.js]: https://nextjs.org/
+
+
 Custom middleware
 -----------------
 
diff --git a/docs/package.json b/docs/package.json
@@ -8,6 +8,7 @@
     "@fedify/fedify": "workspace:",
     "@fedify/h3": "workspace:",
     "@fedify/nestjs": "workspace:",
+    "@fedify/next": "workspace:",
     "@fedify/postgres": "workspace:",
     "@fedify/redis": "workspace:",
     "@fedify/sqlite": "workspace:",
diff --git a/packages/cli/src/init.ts b/packages/cli/src/init.ts
@@ -14,6 +14,7 @@ const packagesMetaData: Record<`@fedify/${string}`, string> = {
   "@fedify/amqp": metadata.version,
   "@fedify/express": metadata.version,
   "@fedify/h3": metadata.version,
+  "@fedify/next": metadata.version,
 };
 
 const logger = getLogger(["fedify", "cli", "init"]);
diff --git a/packages/fedify/README.md b/packages/fedify/README.md
@@ -99,6 +99,7 @@ Here is the list of packages:
 | [@fedify/express](/packages/express/)   | [JSR][jsr:@fedify/express]  | [npm][npm:@fedify/express]  | Express integration                     |
 | [@fedify/h3](/packages/h3/)             | [JSR][jsr:@fedify/h3]       | [npm][npm:@fedify/h3]       | H3 integration                          |
 | [@fedify/nestjs](/packages/nestjs/)     |                             | [npm][npm:@fedify/nestjs]   | NestJS integration                      |
+| [@fedify/next](/packages/next/)         |                             |                             | Next.js integration                     |
 | [@fedify/postgres](/packages/postgres/) | [JSR][jsr:@fedify/postgres] | [npm][npm:@fedify/postgres] | PostgreSQL driver                       |
 | [@fedify/redis](/packages/redis/)       | [JSR][jsr:@fedify/redis]    | [npm][npm:@fedify/redis]    | Redis driver                            |
 | [@fedify/sqlite](/packages/sqlite/)     | [JSR][jsr:@fedify/sqlite]   | [npm][npm:@fedify/sqlite]   | SQLite driver                           |
diff --git a/packages/next/README.md b/packages/next/README.md
@@ -0,0 +1,192 @@
+<!-- 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].
+
+
+### 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/
diff --git a/packages/next/package.json b/packages/next/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@fedify/nextjs",
+  "name": "@fedify/next",
   "version": "1.9.0",
   "description": "Integrate Fedify with Next.js",
   "keywords": [
@@ -18,7 +18,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fedify-dev/fedify.git",
-    "directory": "packages/nextjs"
+    "directory": "packages/next"
   },
   "license": "MIT",
   "bugs": {
diff --git a/packages/next/src/index.ts b/packages/next/src/index.ts
diff --git a/packages/next/tsdown.config.ts b/packages/next/tsdown.config.ts
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -5,7 +5,7 @@ packages:
 - packages/elysia
 - packages/express
 - packages/nestjs
-- packages/nextjs
+- packages/next
 - packages/h3
 - packages/postgres
 - packages/redis
