@fedify/fedify 0.12.0-dev.283 → 0.12.0-dev.284

package/CHANGES.md

@@ -96,17 +96,26 @@ To be released.
         loader that throws an error when the given URL is not an HTTP or HTTPS
         URL or refers to a private network address.
 
+ -  Added `@fedify/fedify/x/astro` module for integrating with [Astro]
+    middleware.  [[#50]]
+
+     -  Added `createMiddleware()` function.
+     -  Added `createFetchOptions()` function.
+     -  Added `ContextDataFactory` type.
+
  -  Added more log messages using the [LogTape] library.  Currently the below
     logger categories are used:
 
      -  `["fedify", "federation", "queue"]`
 
+[#50]: https://github.com/dahlia/fedify/issues/50
 [#53]: https://github.com/dahlia/fedify/issues/53
 [#66]: https://github.com/dahlia/fedify/issues/66
 [#70]: https://github.com/dahlia/fedify/issues/70
 [#81]: https://github.com/dahlia/fedify/issues/81
 [#85]: https://github.com/dahlia/fedify/issues/85
 [#92]: https://github.com/dahlia/fedify/pull/92
+[Astro]: https://astro.build/
 
 
 Version 0.11.2

package/esm/x/astro.js

@@ -0,0 +1,84 @@
+/**
+ * Create options for the {@link Federation.fetch} method to integrate with
+ * Astro.
+ *
+ * @example src/middleware.ts
+ * ``` typescript
+ * import { defineMiddleware } from "astro:middleware";
+ * import { federation } from "./federation";  // Import the `Federation` object
+ *
+ * export const onRequest = defineMiddleware((context, next) => {
+ *   return federation.fetch(context.request, {
+ *     contextData: undefined,
+ *     ...createFetchOptions(context, next),
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam TAstroContext A type of the Astro context.
+ * @param context An Astro context.
+ * @param next A function to call the next middleware.
+ * @returns Options for the {@link Federation.fetch} method.
+ * @since 0.12.0
+ */
+export function createFetchOptions(_context, next) {
+    return {
+        // If the `federation` object finds a request not responsible for it
+        // (i.e., not a federation-related request), it will call the `next`
+        // provided by the Astro framework to continue the request handling
+        // by Astro:
+        onNotFound: next,
+        // Similar to `onNotFound`, but slightly more tricky one.
+        // 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`
+        // provided by the Astro framework so that it renders HTML if there's some
+        // page.  Otherwise, it will simply return a 406 Not Acceptable response.
+        // This kind of trick enables the Fedify and Astro to share the same routes
+        // and they do content negotiation depending on `Accept` header:
+        async onNotAcceptable(_request) {
+            const response = await next();
+            if (response.status !== 404)
+                return response;
+            return new Response("Not acceptable", {
+                status: 406,
+                headers: {
+                    "Content-Type": "text/plain",
+                    Vary: "Accept",
+                },
+            });
+        },
+    };
+}
+/**
+ * Create an Astro middleware handler to integrate with the {@link Federation}
+ * object.
+ *
+ * @example src/middleware.ts
+ * ``` typescript
+ * import type { MiddlewareHandler } from "astro";
+ * import { federation } from "./federation";  // Import the `Federation` object
+ *
+ * export const onRequest: MiddlewareHandler = createMiddleware(
+ *   federation,
+ *   (astroContext) => "context data",
+ * );
+ * ```
+ *
+ * @typeParam TContextData A type of the context data for the {@link Federation}
+ *                         object.
+ * @typeParam TAstroContext A type of the Astro context.
+ * @param federation A {@link Federation} object to integrate with Astro.
+ * @param contextDataFactory A factory function to create a context data for the
+ *                           {@link Federation} object.
+ * @returns An Astro middleware handler.
+ * @since 0.12.0
+ */
+export function createMiddleware(federation, contextDataFactory) {
+    return async (context, next) => {
+        const contextData = await contextDataFactory(context);
+        return await federation.fetch(context.request, {
+            contextData,
+            ...createFetchOptions(context, next),
+        });
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "0.12.0-dev.283+1711224a",
+  "version": "0.12.0-dev.284+5b347b26",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",
@@ -65,6 +65,12 @@
         "default": "./esm/webfinger/mod.js"
       }
     },
+    "./x/astro": {
+      "import": {
+        "types": "./types/x/astro.d.ts",
+        "default": "./esm/x/astro.js"
+      }
+    },
     "./x/hono": {
       "import": {
         "types": "./types/x/hono.d.ts",

package/types/x/astro.d.ts

@@ -0,0 +1,83 @@
+/// <reference types="node" />
+/// <reference types="node" />
+/**
+ * Fedify with Astro
+ * =================
+ *
+ * This module contains some utilities for integrating Fedify with
+ * the [Astro] framework.
+ *
+ * [Astro]: https://astro.build/
+ *
+ * @module
+ * @since 0.12.0
+ */
+import type { Federation, FederationFetchOptions } from "../federation/middleware.js";
+interface AstroContext {
+    request: Request;
+}
+type RewritePayload = string | URL | Request;
+type MiddlewareNext = (rewritePayload?: RewritePayload) => Promise<Response>;
+type MiddlewareHandler<TAstroContext extends AstroContext> = (context: TAstroContext, next: MiddlewareNext) => Promise<Response> | Response | Promise<void> | void;
+/**
+ * Create options for the {@link Federation.fetch} method to integrate with
+ * Astro.
+ *
+ * @example src/middleware.ts
+ * ``` typescript
+ * import { defineMiddleware } from "astro:middleware";
+ * import { federation } from "./federation";  // Import the `Federation` object
+ *
+ * export const onRequest = defineMiddleware((context, next) => {
+ *   return federation.fetch(context.request, {
+ *     contextData: undefined,
+ *     ...createFetchOptions(context, next),
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam TAstroContext A type of the Astro context.
+ * @param context An Astro context.
+ * @param next A function to call the next middleware.
+ * @returns Options for the {@link Federation.fetch} method.
+ * @since 0.12.0
+ */
+export declare function createFetchOptions<TAstroContext extends AstroContext>(_context: TAstroContext, next: MiddlewareNext): Omit<FederationFetchOptions<void>, "contextData">;
+/**
+ * The factory function to create a context data for
+ * the {@link Federation.fetch}.
+ *
+ * @typeParam TContextData A type of the context data.
+ * @typeParam TAstroContext A type of the Astro context.
+ * @param context An Astro context.
+ * @returns The context data for the {@link Federation.fetch}.
+ * @since 0.12.0
+ */
+export type ContextDataFactory<TContextData, TAstroContext extends AstroContext> = (context: TAstroContext) => TContextData | Promise<TContextData>;
+/**
+ * Create an Astro middleware handler to integrate with the {@link Federation}
+ * object.
+ *
+ * @example src/middleware.ts
+ * ``` typescript
+ * import type { MiddlewareHandler } from "astro";
+ * import { federation } from "./federation";  // Import the `Federation` object
+ *
+ * export const onRequest: MiddlewareHandler = createMiddleware(
+ *   federation,
+ *   (astroContext) => "context data",
+ * );
+ * ```
+ *
+ * @typeParam TContextData A type of the context data for the {@link Federation}
+ *                         object.
+ * @typeParam TAstroContext A type of the Astro context.
+ * @param federation A {@link Federation} object to integrate with Astro.
+ * @param contextDataFactory A factory function to create a context data for the
+ *                           {@link Federation} object.
+ * @returns An Astro middleware handler.
+ * @since 0.12.0
+ */
+export declare function createMiddleware<TContextData, TAstroContext extends AstroContext>(federation: Federation<TContextData>, contextDataFactory: ContextDataFactory<TContextData, TAstroContext>): MiddlewareHandler<TAstroContext>;
+export {};
+//# sourceMappingURL=astro.d.ts.map

package/types/x/astro.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"astro.d.ts","sourceRoot":"","sources":["../../src/x/astro.ts"],"names":[],"mappings":";;AAAA;;;;;;;;;;;GAWG;AACH,OAAO,KAAK,EACV,UAAU,EACV,sBAAsB,EACvB,MAAM,6BAA6B,CAAC;AAErC,UAAU,YAAY;IACpB,OAAO,EAAE,OAAO,CAAC;CAClB;AACD,KAAK,cAAc,GAAG,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC;AAC7C,KAAK,cAAc,GAAG,CACpB,cAAc,CAAC,EAAE,cAAc,KAC5B,OAAO,CAAC,QAAQ,CAAC,CAAC;AACvB,KAAK,iBAAiB,CAAC,aAAa,SAAS,YAAY,IAAI,CAC3D,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,cAAc,KACjB,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEzD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,aAAa,SAAS,YAAY,EACnE,QAAQ,EAAE,aAAa,EACvB,IAAI,EAAE,cAAc,GACnB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,CA2BnD;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,CAC5B,YAAY,EACZ,aAAa,SAAS,YAAY,IAChC,CACF,OAAO,EAAE,aAAa,KACnB,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAE1C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAC9B,YAAY,EACZ,aAAa,SAAS,YAAY,EAElC,UAAU,EAAE,UAAU,CAAC,YAAY,CAAC,EACpC,kBAAkB,EAAE,kBAAkB,CAAC,YAAY,EAAE,aAAa,CAAC,GAClE,iBAAiB,CAAC,aAAa,CAAC,CAQlC"}