@fedify/fedify 1.3.0-dev.553 → 1.3.0-dev.557

package/CHANGES.md

@@ -61,6 +61,11 @@ To be released.
 
      -  Added `CreateFederationOptions.tracerProvider` option.
 
+ -  Added `@fedify/fedify/x/sveltekit` module for integrating with [SvelteKit]
+    hook.  [[#171], [#183] by Jiyu Park]
+
+     -  Added `fedifyHook()` function.
+
  -  The scaffold project generated by `fedify init` command now enables
     tracing data into log messages.
 
@@ -68,10 +73,14 @@ To be released.
     [[#173], [#186] by PGD]
 
 
+[SvelteKit]: https://kit.svelte.dev/
 [#162]: https://github.com/dahlia/fedify/issues/162
+[#171]: https://github.com/dahlia/fedify/issues/171
 [#173]: https://github.com/dahlia/fedify/issues/173
+[#183]: https://github.com/dahlia/fedify/pull/183
 [#186]: https://github.com/dahlia/fedify/pull/186
 
+
 Version 1.2.8
 -------------
 
@@ -2556,4 +2565,4 @@ Version 0.1.0
 
 Initial release.  Released on March 8, 2024.
 
-<!-- cSpell: ignore Dogeon Fabien Wressell Emelia Hana Heesun Kyunghee -->
+<!-- cSpell: ignore Dogeon Fabien Wressell Emelia Hana Heesun Kyunghee Jiyu -->

package/esm/deno.js

@@ -1,6 +1,6 @@
 export default {
     "name": "@fedify/fedify",
-    "version": "1.3.0-dev.553+ad290770",
+    "version": "1.3.0-dev.557+fb2366f2",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts",
@@ -12,7 +12,8 @@ export default {
         "./webfinger": "./webfinger/mod.ts",
         "./x/denokv": "./x/denokv.ts",
         "./x/fresh": "./x/fresh.ts",
-        "./x/hono": "./x/hono.ts"
+        "./x/hono": "./x/hono.ts",
+        "./x/sveltekit": "./x/sveltekit.ts"
     },
     "imports": {
         "@cfworker/json-schema": "npm:@cfworker/json-schema@^2.0.1",
@@ -28,6 +29,7 @@ export default {
         "@fedify/fedify/x/denokv": "./x/denokv.ts",
         "@fedify/fedify/x/fresh": "./x/fresh.ts",
         "@fedify/fedify/x/hono": "./x/hono.ts",
+        "@fedify/fedify/x/sveltekit": "./x/sveltekit.ts",
         "@hongminhee/aitertools": "jsr:@hongminhee/aitertools@^0.6.0",
         "@hugoalh/http-header-link": "jsr:@hugoalh/http-header-link@^1.0.2",
         "@logtape/logtape": "jsr:@logtape/logtape@^0.8.0",

package/esm/x/sveltekit.js

@@ -0,0 +1,64 @@
+/**
+ * Fedify with SvelteKit
+ * =====================
+ *
+ * This module provides a [SvelteKit] hook to integrate with the Fedify.
+ *
+ * [SvelteKit]: https://kit.svelte.dev/
+ *
+ * @module
+ * @since 1.3.0
+ */
+/**
+ * Create a SvelteKit hook handler to integrate with the {@link Federation}
+ * object.
+ *
+ * @example hooks.server.ts
+ * ``` typescript
+ * import { federation } from "./federation"; // Import the `Federation` object
+ *
+ * export const handle = fedifyHook(federation, () => undefined);
+ * ```
+ *
+ * @typeParam TContextData A type of the context data for the {@link Federation}
+ *                         object.
+ * @param federation A {@link Federation} object to integrate with SvelteKit.
+ * @param createContextData A function to create a context data for the
+ *                          {@link Federation} object.
+ * @returns A SvelteKit hook handler.
+ * @since 1.3.0
+ */
+export function fedifyHook(federation, createContextData) {
+    return async ({ event, resolve }) => {
+        return await federation.fetch(event.request, {
+            contextData: await createContextData(event),
+            ...integrateFetchOptions({ event, resolve }),
+        });
+    };
+}
+function integrateFetchOptions({ event, resolve }) {
+    return {
+        async onNotFound() {
+            return await resolve(event);
+        },
+        // 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 `resolve`
+        // provided by the SvelteKit 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 SvelteKit to share the same routes
+        // and they do content negotiation depending on `Accept` header:
+        async onNotAcceptable() {
+            const res = await resolve(event);
+            if (res.status !== 404)
+                return res;
+            return new Response("Not acceptable", {
+                status: 406,
+                headers: {
+                    "Content-Type": "text/plain",
+                    Vary: "Accept",
+                },
+            });
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "1.3.0-dev.553+ad290770",
+  "version": "1.3.0-dev.557+fb2366f2",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",
@@ -70,6 +70,12 @@
         "types": "./types/x/hono.d.ts",
         "default": "./esm/x/hono.js"
       }
+    },
+    "./x/sveltekit": {
+      "import": {
+        "types": "./types/x/sveltekit.d.ts",
+        "default": "./esm/x/sveltekit.js"
+      }
     }
   },
   "funding": [

package/types/deno.d.ts

@@ -13,6 +13,7 @@ declare namespace _default {
         "./x/denokv": string;
         "./x/fresh": string;
         "./x/hono": string;
+        "./x/sveltekit": string;
     };
     let imports: {
         "@cfworker/json-schema": string;
@@ -28,6 +29,7 @@ declare namespace _default {
         "@fedify/fedify/x/denokv": string;
         "@fedify/fedify/x/fresh": string;
         "@fedify/fedify/x/hono": string;
+        "@fedify/fedify/x/sveltekit": string;
         "@hongminhee/aitertools": string;
         "@hugoalh/http-header-link": string;
         "@logtape/logtape": string;

package/types/x/sveltekit.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Fedify with SvelteKit
+ * =====================
+ *
+ * This module provides a [SvelteKit] hook to integrate with the Fedify.
+ *
+ * [SvelteKit]: https://kit.svelte.dev/
+ *
+ * @module
+ * @since 1.3.0
+ */
+/// <reference types="node" />
+import type { Federation } from "../federation/federation.js";
+type RequestEvent = {
+    request: Request;
+};
+type HookParams = {
+    event: RequestEvent;
+    resolve: (event: RequestEvent) => Promise<Response>;
+};
+/**
+ * Create a SvelteKit hook handler to integrate with the {@link Federation}
+ * object.
+ *
+ * @example hooks.server.ts
+ * ``` typescript
+ * import { federation } from "./federation"; // Import the `Federation` object
+ *
+ * export const handle = fedifyHook(federation, () => undefined);
+ * ```
+ *
+ * @typeParam TContextData A type of the context data for the {@link Federation}
+ *                         object.
+ * @param federation A {@link Federation} object to integrate with SvelteKit.
+ * @param createContextData A function to create a context data for the
+ *                          {@link Federation} object.
+ * @returns A SvelteKit hook handler.
+ * @since 1.3.0
+ */
+export declare function fedifyHook<TContextData>(federation: Federation<TContextData>, createContextData: (event: RequestEvent) => TContextData | Promise<TContextData>): (params: HookParams) => Promise<Response>;
+export {};
+//# sourceMappingURL=sveltekit.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sveltekit.d.ts","sourceRoot":"","sources":["../../src/x/sveltekit.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;;AAEH,OAAO,KAAK,EACV,UAAU,EAEX,MAAM,6BAA6B,CAAC;AAErC,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;CACrD,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,UAAU,CAAC,YAAY,EACrC,UAAU,EAAE,UAAU,CAAC,YAAY,CAAC,EACpC,iBAAiB,EAAE,CACjB,KAAK,EAAE,YAAY,KAChB,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,GACxC,CAAC,MAAM,EAAE,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,CAO3C"}