@fedify/sveltekit 1.9.0-pr.388.1456 → 1.9.0-pr.388.1458

package/README.md

@@ -0,0 +1,66 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/sveltekit: Integrate Fedify with SvelteKit
+==================================================
+
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+[![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
+
+*This package is available since Fedify 1.9.0.*
+
+This package provides a simple way to integrate [Fedify] with [SvelteKit].
+
+The integration code looks like this:
+
+~~~~ typescript
+import { createFederation } from "@fedify/fedify";
+import { fedifyHook } from "@fedify/sveltekit";
+
+const federation = createFederation<string>({
+  // Omitted for brevity; see the related section for details.
+});
+
+// This is the entry point to the Fedify hook from the SvelteKit framework:
+export const handle = fedifyHook(federation, (req) => "context data");
+~~~~
+
+Put the above code in your *hooks.server.ts* file.
+
+How it works
+------------
+
+Fedify behaves as a hook handler that wraps around the SvelteKit request handler.
+The hook intercepts the incoming HTTP requests and dispatches them to
+the appropriate handler based on the request path and the `Accept` header
+(i.e., content negotiation).  This architecture allows Fedify and your SvelteKit
+application to coexist in the same domain and port.
+
+For example, if you make a request to */.well-known/webfinger* Fedify will
+handle the request by itself, but if you make a request to */users/alice*
+(assuming your SvelteKit app has a handler for `/users/[handle]`) with `Accept:
+text/html` header, Fedify will dispatch the request to the SvelteKit app's
+appropriate handler for `/users/[handle]`.  Or if you define an actor dispatcher
+for `/users/{handle}` in Fedify, and the request is made with `Accept:
+application/activity+json` header, Fedify will dispatch the request to the
+appropriate actor dispatcher.
+
+Installation
+------------
+
+~~~~ sh
+deno add jsr:@fedify/sveltekit  # Deno
+npm  add     @fedify/sveltekit  # npm
+pnpm add     @fedify/sveltekit  # pnpm
+yarn add     @fedify/sveltekit  # Yarn
+bun  add     @fedify/sveltekit  # Bun
+~~~~
+
+[JSR]: https://jsr.io/@fedify/sveltekit
+[JSR badge]: https://jsr.io/badges/@fedify/sveltekit
+[npm]: https://www.npmjs.com/package/@fedify/sveltekit
+[npm badge]: https://img.shields.io/npm/v/@fedify/sveltekit?logo=npm
+[@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/
+[SvelteKit]: https://kit.svelte.dev/

package/dist/mod.d.ts

@@ -26,7 +26,7 @@ type HookParams = {
  * @param createContextData A function to create a context data for the
  *                          {@link Federation} object.
  * @returns A SvelteKit hook handler.
- * @since 1.3.0
+ * @since 1.9.0
  */
 declare function fedifyHook<TContextData>(federation: Federation<TContextData>, createContextData: (event: RequestEvent) => TContextData | Promise<TContextData>): (params: HookParams) => Promise<Response>;
 //#endregion

package/dist/mod.js

@@ -16,7 +16,7 @@
 * @param createContextData A function to create a context data for the
 *                          {@link Federation} object.
 * @returns A SvelteKit hook handler.
-* @since 1.3.0
+* @since 1.9.0
 */
 function fedifyHook(federation, createContextData) {
 	return async ({ event, resolve }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/sveltekit",
-  "version": "1.9.0-pr.388.1456+c8cbdb88",
+  "version": "1.9.0-pr.388.1458+3f173465",
   "description": "Integrate Fedify with SvelteKit",
   "keywords": [
     "Fedify",
@@ -53,7 +53,7 @@
   ],
   "peerDependencies": {
     "@sveltejs/kit": "^2.0.0",
-    "@fedify/fedify": "1.9.0-pr.388.1456+c8cbdb88"
+    "@fedify/fedify": "1.9.0-pr.388.1458+3f173465"
   },
   "devDependencies": {
     "tsdown": "^0.12.9",