@fedify/nuxt 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,105 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/nuxt: Integrate Fedify with Nuxt
+========================================
+
+[![JSR][JSR badge]][JSR]
+[![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 [Nuxt].
+
+Supported framework versions:
+
+ -  Nuxt 4.x
+ -  Nitro 2.x (Nuxt 4 runtime)
+
+[JSR badge]: https://jsr.io/badges/@fedify/nuxt
+[JSR]: https://jsr.io/@fedify/nuxt
+[npm badge]: https://img.shields.io/npm/v/@fedify/nuxt?logo=npm
+[npm]: https://www.npmjs.com/package/@fedify/nuxt
+[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/
+[Nuxt]: https://nuxt.com/
+
+
+Installation
+------------
+
+~~~~ bash
+deno add jsr:@fedify/nuxt
+# or
+npm add @fedify/nuxt
+# or
+pnpm add @fedify/nuxt
+# or
+yarn add @fedify/nuxt
+# or
+bun add @fedify/nuxt
+~~~~
+
+
+Usage
+-----
+
+Create your `Federation` instance in *server/federation.ts*:
+
+~~~~ typescript
+import { createFederation, MemoryKvStore } from "@fedify/fedify";
+
+const federation = createFederation({
+  kv: new MemoryKvStore(),
+});
+
+// ... configure your federation ...
+
+export default federation;
+~~~~
+
+Then enable the Nuxt module in *nuxt.config.ts*:
+
+~~~~ typescript
+export default defineNuxtConfig({
+  modules: ["@fedify/nuxt"],
+});
+~~~~
+
+By default, `@fedify/nuxt` loads your Federation instance from
+*#server/federation*.
+
+If your project uses a different file path or context data factory,
+configure the module options:
+
+~~~~ typescript
+export default defineNuxtConfig({
+  modules: ["@fedify/nuxt"],
+  fedify: {
+    federationModule: "#server/federation",
+    contextDataFactoryModule: "#server/fedify-context",
+  },
+});
+~~~~
+
+The context data factory module should export either:
+
+ -  default function, or
+ -  `contextDataFactory` named export
+
+with this signature:
+
+~~~~ typescript
+import type { ContextDataFactory } from "@fedify/nuxt";
+
+const contextDataFactory: ContextDataFactory<unknown> = async (event, request) => {
+  return {
+    ip: event.node.req.socket.remoteAddress,
+    method: request.method,
+  };
+};
+
+export default contextDataFactory;
+~~~~

package/dist/mod.cjs

@@ -0,0 +1,68 @@
+let _nuxt_kit = require("@nuxt/kit");
+let node_path = require("node:path");
+//#region src/module.ts
+function resolveModulePath(modulePath, aliases, rootDir) {
+	const resolved = (0, _nuxt_kit.resolveAlias)(modulePath, aliases);
+	if ((0, node_path.isAbsolute)(resolved)) return resolved;
+	if (resolved.startsWith("./") || resolved.startsWith("../")) return (0, node_path.resolve)(rootDir, resolved);
+	return resolved;
+}
+function buildContextFactoryResolver(contextDataFactoryModule) {
+	if (contextDataFactoryModule == null) return "const contextDataFactory = undefined;";
+	return `
+const contextDataFactory =
+  contextFactoryModule.default ??
+  contextFactoryModule.contextDataFactory;
+if (contextDataFactory == null) {
+  throw new TypeError(
+    \'@fedify/nuxt: contextDataFactoryModule must export a function as "default" or named "contextDataFactory", but neither was found.\'
+  );
+}
+if (typeof contextDataFactory !== 'function') {
+  throw new TypeError(
+    \'@fedify/nuxt: contextDataFactoryModule must export a function as "default" or named "contextDataFactory".\'
+  );
+}`;
+}
+/**
+* Nuxt module to integrate Fedify with Nuxt/Nitro request handling.
+*/
+const fedifyNuxtModule = (0, _nuxt_kit.defineNuxtModule)({
+	meta: {
+		name: "@fedify/nuxt",
+		configKey: "fedify"
+	},
+	defaults: {
+		federationModule: "#server/federation",
+		contextDataFactoryModule: void 0
+	},
+	setup(options, nuxt) {
+		const resolver = (0, _nuxt_kit.createResolver)(require("url").pathToFileURL(__filename).href);
+		const rootDir = nuxt.options.rootDir;
+		const federationModule = resolveModulePath(options.federationModule, nuxt.options.alias, rootDir);
+		const contextDataFactoryModule = options.contextDataFactoryModule == null ? void 0 : resolveModulePath(options.contextDataFactoryModule, nuxt.options.alias, rootDir);
+		const middlewareFilename = "fedify-nuxt-options.mjs";
+		(0, _nuxt_kit.addServerTemplate)({
+			filename: middlewareFilename,
+			getContents: () => {
+				const imports = [`import * as federationModule from ${JSON.stringify(federationModule)};`, `import { createFedifyMiddleware } from ${JSON.stringify(resolver.resolve("../src/runtime/server/middleware.ts"))};`];
+				if (contextDataFactoryModule != null) imports.push(`import * as contextFactoryModule from ${JSON.stringify(contextDataFactoryModule)};`);
+				return [
+					...imports,
+					"const federation = federationModule.default ?? federationModule.federation;",
+					buildContextFactoryResolver(contextDataFactoryModule ?? null),
+					"export default createFedifyMiddleware(federation, contextDataFactory);",
+					""
+				].join("\n");
+			}
+		});
+		(0, _nuxt_kit.addServerHandler)({
+			route: "",
+			middleware: true,
+			handler: middlewareFilename
+		});
+		(0, _nuxt_kit.addServerPlugin)(resolver.resolve("../src/runtime/server/plugin.ts"));
+	}
+});
+//#endregion
+module.exports = fedifyNuxtModule;