First release of yoga plugin

Author: mvantellingen

.changeset/shy-laws-guess.md

@@ -0,0 +1,5 @@
+---
+"@labdigital/federated-token-yoga": major
+---
+
+First release of yoga plugin

packages/yoga/.eslintignore

@@ -0,0 +1 @@
+dist/**

packages/yoga/.eslintrc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+	extends: ["../../.eslintrc.cjs"],
+};

packages/yoga/README.md

@@ -0,0 +1,17 @@
+# Federated Token - Yoga Plugin
+
+[![npm](https://img.shields.io/npm/v/@labdigital/federated-token.svg)](https://www.npmjs.com/package/@labdigital/federated-token)
+
+This packages provides a GraphQL Yoga plugin so that for Yoga can be used as a
+federated service.
+
+## Usage
+
+- `useFederatedToken()` - The plugin for federated services that reads
+  the token passed in the `x-access-token` header and stores it on the context
+  as `federatedToken`.
+
+When a federated services creates a new token (when non exist) it can also
+return a refresh token in the `x-refresh-token` header. The gateway will then
+encrypt all refresh tokens and encrypt them before passing them to the client
+as `x-refresh-token` header.

packages/yoga/package.json

@@ -0,0 +1,60 @@
+{
+	"name": "@labdigital/federated-token-yoga",
+	"version": "0.0.0",
+	"description": "Federated token plugin for GraphQL Yoga",
+	"module": "./dist/index.js",
+	"main": "./dist/index.cjs",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		}
+	},
+	"keywords": [
+		"graphql",
+		"authentication",
+		"yoga"
+	],
+	"author": "Lab Digital <[email protected]>",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/labd/node-federated-token"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"build": "tsup",
+		"test": "vitest run",
+		"test:ci": "vitest run --coverage",
+		"tsc": "tsc --noEmit",
+		"format": "eslint src --fix && prettier --write .",
+		"lint": "eslint src && prettier --check ."
+	},
+	"files": [
+		"dist",
+		"src"
+	],
+	"dependencies": {
+		"@labdigital/federated-token": "workspace:*",
+		"graphql-yoga": "^5.9.0"
+	},
+	"devDependencies": {
+		"@types/express": "^4.17.21",
+		"@typescript-eslint/eslint-plugin": "^7.18.0",
+		"@vitest/coverage-v8": "1.6.0",
+		"eslint": "^8.57.1",
+		"eslint-plugin-unused-imports": "^4.1.4",
+		"node-mocks-http": "^1.16.1",
+		"prettier": "^3.3.3",
+		"tsup": "^8.3.0",
+		"typescript": "^5.6.3",
+		"vitest": "1.6.0"
+	},
+	"peerDependencies": {
+		"graphql": ">= 16.6.0"
+	}
+}

packages/yoga/src/index.ts

@@ -0,0 +1,53 @@
+import type { Plugin } from "graphql-yoga";
+import { FederatedToken } from "@labdigital/federated-token";
+
+type FederatedTokenContext = {
+	federatedToken: FederatedToken;
+};
+
+export const useFederatedToken = <T extends FederatedTokenContext>(): Plugin<
+	object,
+	T
+> => ({
+	onRequest: ({ request, serverContext }) => {
+		// Initialize FederatedToken and add it to the context
+		const federatedToken = serverContext.federatedToken ?? new FederatedToken();
+
+		// Retrieve tokens from headers using the serverContext
+		const accessToken = request.headers.get("x-access-token") as string;
+		const refreshToken = request.headers.get("x-refresh-token") as string;
+
+		if (accessToken) {
+			federatedToken.deserializeAccessToken(accessToken);
+		}
+
+		if (refreshToken) {
+			federatedToken.loadRefreshToken(refreshToken);
+		}
+
+		serverContext.federatedToken = federatedToken;
+	},
+
+	onResponse: async ({ response, serverContext }) => {
+		const { federatedToken } = serverContext;
+		if (!federatedToken) return;
+
+		// Check if the tokens were modified and set headers accordingly
+		if (
+			federatedToken.isAccessTokenModified() ||
+			federatedToken.isValueModified()
+		) {
+			const serializedToken = federatedToken.serializeAccessToken();
+			if (serializedToken) {
+				response.headers.set("X-Access-Token", serializedToken);
+			}
+		}
+
+		if (federatedToken.isRefreshTokenModified()) {
+			const serializedRefreshToken = federatedToken.dumpRefreshToken();
+			if (serializedRefreshToken) {
+				response.headers.set("X-Refresh-Token", serializedRefreshToken);
+			}
+		}
+	},
+});

packages/yoga/tsconfig.json

@@ -0,0 +1,4 @@
+{
+	"extends": "../../tsconfig.json",
+	"include": ["src/**/*"]
+}

packages/yoga/tsup.config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig([
+	{
+		entry: ["src/index.ts"],
+		clean: true,
+		splitting: false,
+		dts: true,
+		sourcemap: true,
+		format: ["esm", "cjs"],
+		outDir: "dist",
+	},
+]);

packages/yoga/vitest.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from "vitest/config";
+import path from "path";
+
+export default defineConfig({
+	test: {
+		coverage: {
+			provider: "v8",
+			all: true,
+			include: ["src/**/*.ts"],
+			reportsDirectory: "./test-reports/",
+		},
+		passWithNoTests: true,
+	},
+
+	resolve: {
+		alias: {
+			"~src": path.join(__dirname, "src"),
+		},
+	},
+});