@fedify/solidstart 2.2.0-dev.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024–2026 Hong Minhee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,32 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/solidstart: Integrate Fedify with SolidStart
+====================================================
+
+[![npm][npm badge]][npm]
+[![Matrix][Matrix badge]][Matrix]
+[![Follow @fedify@hollo.social][@fedify@hollo.social badge]][@fedify@hollo.social]
+
+This package provides a simple way to integrate [Fedify] with [SolidStart].
+
+The integration code looks like this:
+
+~~~~ typescript
+// src/middleware/index.ts
+import { fedifyMiddleware } from "@fedify/solidstart";
+import federation from "../lib/federation";
+
+export default fedifyMiddleware(federation, (event) => "context data");
+~~~~
+
+Put the above code in your *src/middleware/index.ts* file, and set
+`middleware: "src/middleware/index.ts"` in your *app.config.ts*.
+
+[npm badge]: https://img.shields.io/npm/v/@fedify/solidstart?logo=npm
+[npm]: https://www.npmjs.com/package/@fedify/solidstart
+[Matrix badge]: https://img.shields.io/matrix/fedify%3Amatrix.org
+[Matrix]: https://matrix.to/#/#fedify:matrix.org
+[@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/
+[SolidStart]: https://start.solidjs.com/

package/dist/index.cjs

@@ -0,0 +1,56 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let _solidjs_start_middleware = require("@solidjs/start/middleware");
+//#region src/index.ts
+const notAcceptableResponses = /* @__PURE__ */ new WeakMap();
+/**
+* Create a SolidStart middleware to integrate with the {@link Federation}
+* object.
+*
+* @example src/middleware/index.ts
+* ``` typescript
+* import { fedifyMiddleware } from "@fedify/solidstart";
+* import federation from "../lib/federation";
+*
+* export default fedifyMiddleware(federation);
+* ```
+*
+* @template TContextData A type of the context data for the
+*                         {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with SolidStart.
+* @param createContextData A function to create context data for the
+*                          {@link Federation} object.
+* @returns A SolidStart middleware object.
+* @since 2.2.0
+*/
+function fedifyMiddleware(federation, createContextData = () => void 0) {
+	return (0, _solidjs_start_middleware.createMiddleware)({
+		onRequest: async (event) => {
+			const response = await federation.fetch(event.request, {
+				contextData: await createContextData(event),
+				onNotFound: () => new Response("Not Found", { status: 404 }),
+				onNotAcceptable: () => new Response("Not Acceptable", {
+					status: 406,
+					headers: {
+						"Content-Type": "text/plain",
+						Vary: "Accept"
+					}
+				})
+			});
+			if (response.status === 404) return;
+			if (response.status === 406) {
+				notAcceptableResponses.set(event.request, response);
+				return;
+			}
+			return response;
+		},
+		onBeforeResponse: (event) => {
+			const stored = notAcceptableResponses.get(event.request);
+			if (stored != null) {
+				notAcceptableResponses.delete(event.request);
+				if ((event.response.status ?? 200) === 404) return stored;
+			}
+		}
+	});
+}
+//#endregion
+exports.fedifyMiddleware = fedifyMiddleware;

package/dist/index.d.cts

@@ -0,0 +1,38 @@
+import { Federation } from "@fedify/fedify/federation";
+import { createMiddleware } from "@solidjs/start/middleware";
+import { FetchEvent } from "@solidjs/start/server";
+
+//#region src/index.d.ts
+/**
+* A factory function that creates the context data for the
+* {@link Federation} object.
+*
+* @template TContextData The type of the context data.
+* @param event The SolidStart {@link FetchEvent} for the current request.
+* @returns The context data, or a promise resolving to the context data.
+* @since 2.2.0
+*/
+type ContextDataFactory<TContextData> = (event: FetchEvent) => TContextData | Promise<TContextData>;
+/**
+* Create a SolidStart middleware to integrate with the {@link Federation}
+* object.
+*
+* @example src/middleware/index.ts
+* ``` typescript
+* import { fedifyMiddleware } from "@fedify/solidstart";
+* import federation from "../lib/federation";
+*
+* export default fedifyMiddleware(federation);
+* ```
+*
+* @template TContextData A type of the context data for the
+*                         {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with SolidStart.
+* @param createContextData A function to create context data for the
+*                          {@link Federation} object.
+* @returns A SolidStart middleware object.
+* @since 2.2.0
+*/
+declare function fedifyMiddleware<TContextData>(federation: Federation<TContextData>, createContextData?: ContextDataFactory<TContextData>): ReturnType<typeof createMiddleware>;
+//#endregion
+export { ContextDataFactory, fedifyMiddleware };

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+import { createMiddleware } from "@solidjs/start/middleware";
+import { Federation } from "@fedify/fedify/federation";
+import { FetchEvent } from "@solidjs/start/server";
+
+//#region src/index.d.ts
+/**
+* A factory function that creates the context data for the
+* {@link Federation} object.
+*
+* @template TContextData The type of the context data.
+* @param event The SolidStart {@link FetchEvent} for the current request.
+* @returns The context data, or a promise resolving to the context data.
+* @since 2.2.0
+*/
+type ContextDataFactory<TContextData> = (event: FetchEvent) => TContextData | Promise<TContextData>;
+/**
+* Create a SolidStart middleware to integrate with the {@link Federation}
+* object.
+*
+* @example src/middleware/index.ts
+* ``` typescript
+* import { fedifyMiddleware } from "@fedify/solidstart";
+* import federation from "../lib/federation";
+*
+* export default fedifyMiddleware(federation);
+* ```
+*
+* @template TContextData A type of the context data for the
+*                         {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with SolidStart.
+* @param createContextData A function to create context data for the
+*                          {@link Federation} object.
+* @returns A SolidStart middleware object.
+* @since 2.2.0
+*/
+declare function fedifyMiddleware<TContextData>(federation: Federation<TContextData>, createContextData?: ContextDataFactory<TContextData>): ReturnType<typeof createMiddleware>;
+//#endregion
+export { ContextDataFactory, fedifyMiddleware };

package/dist/index.js

@@ -0,0 +1,55 @@
+import { createMiddleware } from "@solidjs/start/middleware";
+//#region src/index.ts
+const notAcceptableResponses = /* @__PURE__ */ new WeakMap();
+/**
+* Create a SolidStart middleware to integrate with the {@link Federation}
+* object.
+*
+* @example src/middleware/index.ts
+* ``` typescript
+* import { fedifyMiddleware } from "@fedify/solidstart";
+* import federation from "../lib/federation";
+*
+* export default fedifyMiddleware(federation);
+* ```
+*
+* @template TContextData A type of the context data for the
+*                         {@link Federation} object.
+* @param federation A {@link Federation} object to integrate with SolidStart.
+* @param createContextData A function to create context data for the
+*                          {@link Federation} object.
+* @returns A SolidStart middleware object.
+* @since 2.2.0
+*/
+function fedifyMiddleware(federation, createContextData = () => void 0) {
+	return createMiddleware({
+		onRequest: async (event) => {
+			const response = await federation.fetch(event.request, {
+				contextData: await createContextData(event),
+				onNotFound: () => new Response("Not Found", { status: 404 }),
+				onNotAcceptable: () => new Response("Not Acceptable", {
+					status: 406,
+					headers: {
+						"Content-Type": "text/plain",
+						Vary: "Accept"
+					}
+				})
+			});
+			if (response.status === 404) return;
+			if (response.status === 406) {
+				notAcceptableResponses.set(event.request, response);
+				return;
+			}
+			return response;
+		},
+		onBeforeResponse: (event) => {
+			const stored = notAcceptableResponses.get(event.request);
+			if (stored != null) {
+				notAcceptableResponses.delete(event.request);
+				if ((event.response.status ?? 200) === 404) return stored;
+			}
+		}
+	});
+}
+//#endregion
+export { fedifyMiddleware };

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@fedify/solidstart",
+  "version": "2.2.0-dev.0",
+  "description": "Integrate Fedify with SolidStart",
+  "keywords": [
+    "Fedify",
+    "ActivityPub",
+    "Fediverse",
+    "SolidStart",
+    "SolidJS"
+  ],
+  "author": {
+    "name": "Hyeonseo Kim",
+    "email": "dodok8@gmail.com"
+  },
+  "homepage": "https://fedify.dev/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fedify-dev/fedify.git",
+    "directory": "packages/solidstart"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/fedify-dev/fedify/issues"
+  },
+  "funding": [
+    "https://opencollective.com/fedify",
+    "https://github.com/sponsors/dahlia"
+  ],
+  "type": "module",
+  "module": "./dist/index.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/index.d.ts",
+        "require": "./dist/index.d.cts",
+        "default": "./dist/index.d.ts"
+      },
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "@solidjs/start": "^1.3.0",
+    "@fedify/fedify": "^2.2.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.21.6",
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "build:self": "tsdown",
+    "build": "pnpm --filter @fedify/solidstart... run build:self",
+    "prepublish": "pnpm build"
+  }
+}