@fedify/next 2.4.0-pr.936.41 → 2.5.0-dev.2271

package/README.md

@@ -63,6 +63,9 @@ export const config = {
     },
     { source: "/.well-known/nodeinfo" },
     { source: "/.well-known/x-nodeinfo2" },
+    // FEP-ef61 gateway requests such as hashlink media, which clients fetch
+    // without the federation media types, e.g., with "Accept: image/*":
+    { source: "/.well-known/apgateway/:path*" },
   ],
 };
 ~~~~

package/dist/index.cjs

@@ -28,8 +28,12 @@ let next_server_js = require("next/server.js");
 *   }
 * )
 *
-* // This config makes middleware process only requests with the
-* // "Accept" header matching the federation accept regex.
+* // This config makes the middleware run only for requests that may be
+* // federation requests: requests whose "Accept" or "Content-Type" header
+* // has a federation media type, NodeInfo requests, and FEP-ef61 gateway
+* // requests such as hashlink media, which clients fetch with, e.g.,
+* // "Accept: image/*".  fedifyWith() then decides which of them Fedify
+* // handles.
 * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
 * export const config = {
 *   runtime: "nodejs",
@@ -56,6 +60,7 @@ let next_server_js = require("next/server.js");
 *     },
 *     { source: "/.well-known/nodeinfo" },
 *     { source: "/.well-known/x-nodeinfo2" },
+*     { source: "/.well-known/apgateway/:path*" },
 *   ],
 * };
 * ```
@@ -64,10 +69,24 @@ const fedifyWith = (federation, contextDataFactory, errorHandlers) => (middlewar
 	if (isFederationRequest(request)) return await integrateFederation(federation, contextDataFactory, errorHandlers)(request);
 	return await middleware(request);
 };
+/**
+* Check if the request should be handled by the {@link Federation} object.
+* A request is considered a federation request if any of the following
+* conditions is met:
+*
+* - Its `Accept` or `Content-Type` header has an ActivityPub, JSON-LD, JRD,
+*   or XRD media type.
+* - It is a NodeInfo request (see {@link isNodeInfoRequest}).
+* - It is an FEP-ef61 hashlink media request
+*   (see {@link isHashlinkMediaRequest}).
+* @param request The request to check.
+* @returns `true` if the request is a federation request, `false` otherwise.
+*/
 const isFederationRequest = (request) => [
 	hasFederationHeader("accept"),
 	hasFederationHeader("content-type"),
-	isNodeInfoRequest
+	isNodeInfoRequest,
+	isHashlinkMediaRequest
 ].some((f) => f(request));
 /**
 * Check if the request has the header matching the federation
@@ -86,6 +105,30 @@ const isNodeInfoRequest = (request) => {
 	return NODEINFO_PATHS.some((path) => url.pathname.startsWith(path));
 };
 const NODEINFO_PATHS = ["/.well-known/nodeinfo", "/.well-known/x-nodeinfo2"];
+/**
+* Check if the request is an [FEP-ef61] gateway request for a resource
+* addressed by a hashlink, e.g.,
+* `GET /.well-known/apgateway/hl:zQmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n`.
+*
+* Such requests need not carry a federation media type in their `Accept`
+* header, as clients fetch media with, e.g., `Accept: image/*`, so they are
+* recognized by their path alone.  This only checks whether the path looks
+* like a hashlink request; it does not check whether the hashlink is valid
+* nor whether a hashlink media dispatcher is registered, which
+* {@link Federation.fetch} takes care of.
+*
+* [FEP-ef61]: https://w3id.org/fep/ef61
+* @param request The request to check.
+* @returns `true` if the request is a hashlink media request,
+*          `false` otherwise.
+* @since 2.4.0
+*/
+const isHashlinkMediaRequest = (request) => {
+	const { pathname } = new URL(request.url);
+	return pathname.startsWith(GATEWAY_PATH_PREFIX) && HASHLINK_SCHEME_PATTERN.test(pathname.slice(GATEWAY_PATH_PREFIX.length));
+};
+const GATEWAY_PATH_PREFIX = "/.well-known/apgateway/";
+const HASHLINK_SCHEME_PATTERN = /^hl(?::|%3A)/i;
 const FEDERATION_ACCEPT_REGEX = /.*application\/((jrd|activity|ld)\+json|xrd\+xml).*/;
 /**
 * Create a Next.js handler to integrate with the {@link Federation} object.
@@ -120,4 +163,5 @@ exports.fedifyWith = fedifyWith;
 exports.hasFederationHeader = hasFederationHeader;
 exports.integrateFederation = integrateFederation;
 exports.isFederationRequest = isFederationRequest;
+exports.isHashlinkMediaRequest = isHashlinkMediaRequest;
 exports.isNodeInfoRequest = isNodeInfoRequest;

package/dist/index.d.cts

@@ -32,8 +32,12 @@ type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
 *   }
 * )
 *
-* // This config makes middleware process only requests with the
-* // "Accept" header matching the federation accept regex.
+* // This config makes the middleware run only for requests that may be
+* // federation requests: requests whose "Accept" or "Content-Type" header
+* // has a federation media type, NodeInfo requests, and FEP-ef61 gateway
+* // requests such as hashlink media, which clients fetch with, e.g.,
+* // "Accept: image/*".  fedifyWith() then decides which of them Fedify
+* // handles.
 * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
 * export const config = {
 *   runtime: "nodejs",
@@ -60,11 +64,25 @@ type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
 *     },
 *     { source: "/.well-known/nodeinfo" },
 *     { source: "/.well-known/x-nodeinfo2" },
+*     { source: "/.well-known/apgateway/:path*" },
 *   ],
 * };
 * ```
 */
 declare const fedifyWith: <TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>) => (middleware?: (request: Request) => unknown) => (request: Request) => unknown;
+/**
+* Check if the request should be handled by the {@link Federation} object.
+* A request is considered a federation request if any of the following
+* conditions is met:
+*
+* - Its `Accept` or `Content-Type` header has an ActivityPub, JSON-LD, JRD,
+*   or XRD media type.
+* - It is a NodeInfo request (see {@link isNodeInfoRequest}).
+* - It is an FEP-ef61 hashlink media request
+*   (see {@link isHashlinkMediaRequest}).
+* @param request The request to check.
+* @returns `true` if the request is a federation request, `false` otherwise.
+*/
 declare const isFederationRequest: (request: Request) => boolean;
 /**
 * Check if the request has the header matching the federation
@@ -77,6 +95,25 @@ declare const isFederationRequest: (request: Request) => boolean;
 declare const hasFederationHeader: (key: string) => (request: Request) => boolean;
 declare const isNodeInfoRequest: (request: Request) => boolean;
 /**
+* Check if the request is an [FEP-ef61] gateway request for a resource
+* addressed by a hashlink, e.g.,
+* `GET /.well-known/apgateway/hl:zQmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n`.
+*
+* Such requests need not carry a federation media type in their `Accept`
+* header, as clients fetch media with, e.g., `Accept: image/*`, so they are
+* recognized by their path alone.  This only checks whether the path looks
+* like a hashlink request; it does not check whether the hashlink is valid
+* nor whether a hashlink media dispatcher is registered, which
+* {@link Federation.fetch} takes care of.
+*
+* [FEP-ef61]: https://w3id.org/fep/ef61
+* @param request The request to check.
+* @returns `true` if the request is a hashlink media request,
+*          `false` otherwise.
+* @since 2.4.0
+*/
+declare const isHashlinkMediaRequest: (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
@@ -90,4 +127,4 @@ declare const isNodeInfoRequest: (request: Request) => boolean;
 */
 declare function integrateFederation<TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>): (request: Request) => Promise<Response>;
 //#endregion
-export { fedifyWith, hasFederationHeader, integrateFederation, isFederationRequest, isNodeInfoRequest };
+export { fedifyWith, hasFederationHeader, integrateFederation, isFederationRequest, isHashlinkMediaRequest, isNodeInfoRequest };

package/dist/index.d.ts

@@ -32,8 +32,12 @@ type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
 *   }
 * )
 *
-* // This config makes middleware process only requests with the
-* // "Accept" header matching the federation accept regex.
+* // This config makes the middleware run only for requests that may be
+* // federation requests: requests whose "Accept" or "Content-Type" header
+* // has a federation media type, NodeInfo requests, and FEP-ef61 gateway
+* // requests such as hashlink media, which clients fetch with, e.g.,
+* // "Accept: image/*".  fedifyWith() then decides which of them Fedify
+* // handles.
 * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
 * export const config = {
 *   runtime: "nodejs",
@@ -60,11 +64,25 @@ type ErrorHandlers = Omit<FederationFetchOptions<unknown>, "contextData">;
 *     },
 *     { source: "/.well-known/nodeinfo" },
 *     { source: "/.well-known/x-nodeinfo2" },
+*     { source: "/.well-known/apgateway/:path*" },
 *   ],
 * };
 * ```
 */
 declare const fedifyWith: <TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>) => (middleware?: (request: Request) => unknown) => (request: Request) => unknown;
+/**
+* Check if the request should be handled by the {@link Federation} object.
+* A request is considered a federation request if any of the following
+* conditions is met:
+*
+* - Its `Accept` or `Content-Type` header has an ActivityPub, JSON-LD, JRD,
+*   or XRD media type.
+* - It is a NodeInfo request (see {@link isNodeInfoRequest}).
+* - It is an FEP-ef61 hashlink media request
+*   (see {@link isHashlinkMediaRequest}).
+* @param request The request to check.
+* @returns `true` if the request is a federation request, `false` otherwise.
+*/
 declare const isFederationRequest: (request: Request) => boolean;
 /**
 * Check if the request has the header matching the federation
@@ -77,6 +95,25 @@ declare const isFederationRequest: (request: Request) => boolean;
 declare const hasFederationHeader: (key: string) => (request: Request) => boolean;
 declare const isNodeInfoRequest: (request: Request) => boolean;
 /**
+* Check if the request is an [FEP-ef61] gateway request for a resource
+* addressed by a hashlink, e.g.,
+* `GET /.well-known/apgateway/hl:zQmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n`.
+*
+* Such requests need not carry a federation media type in their `Accept`
+* header, as clients fetch media with, e.g., `Accept: image/*`, so they are
+* recognized by their path alone.  This only checks whether the path looks
+* like a hashlink request; it does not check whether the hashlink is valid
+* nor whether a hashlink media dispatcher is registered, which
+* {@link Federation.fetch} takes care of.
+*
+* [FEP-ef61]: https://w3id.org/fep/ef61
+* @param request The request to check.
+* @returns `true` if the request is a hashlink media request,
+*          `false` otherwise.
+* @since 2.4.0
+*/
+declare const isHashlinkMediaRequest: (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
@@ -90,4 +127,4 @@ declare const isNodeInfoRequest: (request: Request) => boolean;
 */
 declare function integrateFederation<TContextData>(federation: Federation<TContextData>, contextDataFactory?: ContextDataFactory<TContextData>, errorHandlers?: Partial<ErrorHandlers>): (request: Request) => Promise<Response>;
 //#endregion
-export { fedifyWith, hasFederationHeader, integrateFederation, isFederationRequest, isNodeInfoRequest };
+export { fedifyWith, hasFederationHeader, integrateFederation, isFederationRequest, isHashlinkMediaRequest, isNodeInfoRequest };

package/dist/index.js

@@ -27,8 +27,12 @@ import { NextResponse } from "next/server.js";
 *   }
 * )
 *
-* // This config makes middleware process only requests with the
-* // "Accept" header matching the federation accept regex.
+* // This config makes the middleware run only for requests that may be
+* // federation requests: requests whose "Accept" or "Content-Type" header
+* // has a federation media type, NodeInfo requests, and FEP-ef61 gateway
+* // requests such as hashlink media, which clients fetch with, e.g.,
+* // "Accept: image/*".  fedifyWith() then decides which of them Fedify
+* // handles.
 * // More details: https://nextjs.org/docs/app/api-reference/file-conventions/middleware#config-object-optional.
 * export const config = {
 *   runtime: "nodejs",
@@ -55,6 +59,7 @@ import { NextResponse } from "next/server.js";
 *     },
 *     { source: "/.well-known/nodeinfo" },
 *     { source: "/.well-known/x-nodeinfo2" },
+*     { source: "/.well-known/apgateway/:path*" },
 *   ],
 * };
 * ```
@@ -63,10 +68,24 @@ const fedifyWith = (federation, contextDataFactory, errorHandlers) => (middlewar
 	if (isFederationRequest(request)) return await integrateFederation(federation, contextDataFactory, errorHandlers)(request);
 	return await middleware(request);
 };
+/**
+* Check if the request should be handled by the {@link Federation} object.
+* A request is considered a federation request if any of the following
+* conditions is met:
+*
+* - Its `Accept` or `Content-Type` header has an ActivityPub, JSON-LD, JRD,
+*   or XRD media type.
+* - It is a NodeInfo request (see {@link isNodeInfoRequest}).
+* - It is an FEP-ef61 hashlink media request
+*   (see {@link isHashlinkMediaRequest}).
+* @param request The request to check.
+* @returns `true` if the request is a federation request, `false` otherwise.
+*/
 const isFederationRequest = (request) => [
 	hasFederationHeader("accept"),
 	hasFederationHeader("content-type"),
-	isNodeInfoRequest
+	isNodeInfoRequest,
+	isHashlinkMediaRequest
 ].some((f) => f(request));
 /**
 * Check if the request has the header matching the federation
@@ -85,6 +104,30 @@ const isNodeInfoRequest = (request) => {
 	return NODEINFO_PATHS.some((path) => url.pathname.startsWith(path));
 };
 const NODEINFO_PATHS = ["/.well-known/nodeinfo", "/.well-known/x-nodeinfo2"];
+/**
+* Check if the request is an [FEP-ef61] gateway request for a resource
+* addressed by a hashlink, e.g.,
+* `GET /.well-known/apgateway/hl:zQmdfTbBqBPQ7VNxZEYEj14VmRuZBkqFbiwReogJgS1zR1n`.
+*
+* Such requests need not carry a federation media type in their `Accept`
+* header, as clients fetch media with, e.g., `Accept: image/*`, so they are
+* recognized by their path alone.  This only checks whether the path looks
+* like a hashlink request; it does not check whether the hashlink is valid
+* nor whether a hashlink media dispatcher is registered, which
+* {@link Federation.fetch} takes care of.
+*
+* [FEP-ef61]: https://w3id.org/fep/ef61
+* @param request The request to check.
+* @returns `true` if the request is a hashlink media request,
+*          `false` otherwise.
+* @since 2.4.0
+*/
+const isHashlinkMediaRequest = (request) => {
+	const { pathname } = new URL(request.url);
+	return pathname.startsWith(GATEWAY_PATH_PREFIX) && HASHLINK_SCHEME_PATTERN.test(pathname.slice(GATEWAY_PATH_PREFIX.length));
+};
+const GATEWAY_PATH_PREFIX = "/.well-known/apgateway/";
+const HASHLINK_SCHEME_PATTERN = /^hl(?::|%3A)/i;
 const FEDERATION_ACCEPT_REGEX = /.*application\/((jrd|activity|ld)\+json|xrd\+xml).*/;
 /**
 * Create a Next.js handler to integrate with the {@link Federation} object.
@@ -115,4 +158,4 @@ const onNotAcceptable = () => new Response("Not acceptable", {
 	}
 });
 //#endregion
-export { fedifyWith, hasFederationHeader, integrateFederation, isFederationRequest, isNodeInfoRequest };
+export { fedifyWith, hasFederationHeader, integrateFederation, isFederationRequest, isHashlinkMediaRequest, isNodeInfoRequest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/next",
-  "version": "2.4.0-pr.936.41+59c7432c",
+  "version": "2.5.0-dev.2271+49d937e2",
   "description": "Integrate Fedify with Next.js",
   "keywords": [
     "Fedify",
@@ -48,15 +48,18 @@
   ],
   "peerDependencies": {
     "next": ">=15.4.6 <17",
-    "@fedify/fedify": "^2.4.0-pr.936.41+59c7432c"
+    "@fedify/fedify": "^2.5.0-dev.2271+49d937e2"
   },
   "devDependencies": {
     "tsdown": "^0.22.0",
-    "typescript": "^6.0.0"
+    "typescript": "^6.0.0",
+    "@fedify/fixture": "^2.0.0"
   },
   "scripts": {
     "build:self": "tsdown",
     "build": "pnpm --filter @fedify/next... run build:self",
-    "prepublish": "pnpm build"
+    "prepublish": "pnpm build",
+    "test": "node --test dist/",
+    "test:bun": "bun test"
   }
 }