@fedify/nestjs 1.8.0-pr.309.1062

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024–2025 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,133 @@
+<!-- deno-fmt-ignore-file -->
+
+@fedify/nestjs: Integrate Fedify with NestJS
+==============================================
+
+[![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 [NestJS].
+
+The integration code looks like this:
+
+~~~~ typescript
+// --- modules/federation/federation.service ---
+
+import { Injectable, Inject, OnModuleInit } from '@nestjs/common';
+import {
+  FEDIFY_FEDERATION,
+} from '@fedify/nestjs';   
+import { Federation, parseSemVer } from '@fedify/fedify';
+
+@Injectable()
+export class FederationService implements OnModuleInit {
+  private initialized = false;
+
+  constructor(
+    @Inject(FEDIFY_FEDERATION) private federation: Federation<unknown>,
+  ) { }
+
+  async onModuleInit() {
+    if (!this.initialized) {
+      await this.initialize();
+      this.initialized = true;
+    }
+  }
+
+  async initialize() {
+    this.federation.setNodeInfoDispatcher(async (context) => {
+      return {
+        software: {
+          name: "Fedify NestJS sample",
+          version: parseSemVer("0.0.1")
+        }
+      }
+    });
+  }
+}
+
+
+// --- modules/federation/federation.module.ts ---
+
+import { Module } from '@nestjs/common';
+import { FederationService } from './federation.service';
+
+@Module({
+  providers: [FederationService],
+  exports: [FederationService],
+})
+export class FederationModule {}
+
+
+// --- main.module.ts ---
+import {
+  Inject,
+  MiddlewareConsumer,
+  Module,
+  NestModule,
+  RequestMethod,
+} from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { DatabaseModule } from './database/database.module';
+import { FederationModule } from './modules/federation/federation.module';
+import { InProcessMessageQueue, MemoryKvStore, Federation } from '@fedify/fedify';
+
+import {
+  FEDIFY_FEDERATION,
+  FedifyModule,
+  integrateFederation,
+} from '@fedify/nestjs';
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      isGlobal: true,
+    }),
+    DatabaseModule,
+    FedifyModule.forRoot({
+      // Allow localhost URLs in development
+      kv: new MemoryKvStore(),
+      queue: new InProcessMessageQueue(),
+      origin: process.env.FEDERATION_ORIGIN || 'http://localhost:3000',
+    }),
+    FederationModule,
+  ],
+  controllers: [AppController],
+  providers: [AppService],
+})
+
+export class AppModule implements NestModule {
+  constructor(
+    @Inject(FEDIFY_FEDERATION) private federation: Federation<unknown>,
+  ) { }
+
+  configure(consumer: MiddlewareConsumer) {
+    const fedifyMiddleware = integrateFederation(
+      this.federation,
+      async (req, res) => {
+        // Create rich context with database access and request info
+        return {
+          request: req,
+          response: res,
+          url: new URL(req.url, `${req.protocol}://${req.get('host')}`),
+        };
+      },
+    );
+
+    // Apply middleware to all routes except auth endpoints
+    consumer.apply(fedifyMiddleware)
+  }
+}
+
+~~~~
+
+[npm]: https://www.npmjs.com/package/@fedify/express
+[npm badge]: https://img.shields.io/npm/v/@fedify/express?logo=npm
+[Matrix]: https://matrix.to/#/#fedify:matrix.org
+[Matrix badge]: https://img.shields.io/matrix/fedify%3Amatrix.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/
+[Express]: https://expressjs.com/

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import { DynamicModule, NestMiddleware, Type } from "@nestjs/common";
+import { Federation, FederationOptions } from "@fedify/fedify";
+import { Request, Response } from "express";
+
+//#region fedify.module.d.ts
+declare class FedifyModule {
+  static forRoot(options: FederationOptions<unknown>): DynamicModule;
+}
+//#endregion
+//#region fedify.constants.d.ts
+declare const FEDIFY_FEDERATION = "FEDIFY_FEDERATION";
+//#endregion
+//#region fedify.middleware.d.ts
+type ContextDataFactory<TContextData> = (req: Request, res: Response) => TContextData | Promise<TContextData>;
+declare function integrateFederation<TContextData>(federation: Federation<unknown>, contextDataFactory: ContextDataFactory<TContextData>): Type<NestMiddleware>;
+//#endregion
+export { ContextDataFactory, FEDIFY_FEDERATION, FedifyModule, integrateFederation };

package/dist/index.js

@@ -0,0 +1,65 @@
+import { Injectable, Module } from "@nestjs/common";
+import { MemoryKvStore, createFederation } from "@fedify/fedify";
+import { Request } from "express";
+
+//#region fedify.constants.ts
+const FEDIFY_FEDERATION = "FEDIFY_FEDERATION";
+
+//#endregion
+//#region fedify.module.ts
+var FedifyModule = @Module({}) class FedifyModule {
+	static forRoot(options) {
+		const providers = [{
+			provide: FEDIFY_FEDERATION,
+			useFactory: () => {
+				const federationOptions = { ...options };
+				federationOptions.kv = options.kv || new MemoryKvStore();
+				const federation = createFederation(federationOptions);
+				return federation;
+			}
+		}];
+		return {
+			module: FedifyModule,
+			providers,
+			exports: [FEDIFY_FEDERATION],
+			global: true
+		};
+	}
+};
+
+//#endregion
+//#region fedify.middleware.ts
+function integrateFederation(federation, contextDataFactory) {
+	@Injectable() class FedifyIntegrationMiddleware {
+		async use(req, res, next) {
+			try {
+				const contextData = await contextDataFactory(req, res);
+				const url = new URL(req.url, `${req.protocol}://${req.get("host")}`);
+				const headers = new Headers();
+				Object.entries(req.headers).forEach(([key, value]) => {
+					if (value) headers.set(key, Array.isArray(value) ? value.join(", ") : value.toString());
+				});
+				const webRequest = new Request(url.toString(), {
+					method: req.method,
+					headers,
+					body: ["GET", "HEAD"].includes(req.method) ? void 0 : JSON.stringify(req.body)
+				});
+				const response = await federation.fetch(webRequest, { contextData });
+				if (response) {
+					response.headers.forEach((value, key) => {
+						res.setHeader(key, value);
+					});
+					res.status(response.status);
+					const body = await response.text();
+					res.send(body);
+				} else next();
+			} catch (error) {
+				next(error);
+			}
+		}
+	}
+	return FedifyIntegrationMiddleware;
+}
+
+//#endregion
+export { FEDIFY_FEDERATION, FedifyModule, integrateFederation };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@fedify/nestjs",
+  "version": "1.8.0-pr.309.1062+7bc9cc4d",
+  "description": "Integrate Fedify with Nest.js",
+  "keywords": [
+    "Fedify",
+    "Nest",
+    "Nest.js"
+  ],
+  "author": {
+    "name": "Jaeyeol Lee",
+    "email": "jaeyeol.lee@hey.com",
+    "url": "https://kodingwarrior.github.io/"
+  },
+  "homepage": "https://fedify.dev/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fedify-dev/fedify.git",
+    "directory": "nestjs"
+  },
+  "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",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.js",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/",
+    "package.json"
+  ],
+  "peerDependencies": {
+    "@nestjs/common": "^11.0.1",
+    "express": "^4.0.0",
+    "@fedify/fedify": "1.8.0-pr.309.1062+7bc9cc4d"
+  },
+  "devDependencies": {
+    "@types/express": "^4.0.0",
+    "@types/node": "^22.16.0",
+    "tsdown": "^0.12.9",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "prepublish": "tsdown"
+  }
+}