@clemax/nest-keycloak-connect 2.0.0

package/dist/services/keycloak-multitenant.service.js

@@ -0,0 +1,174 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeycloakMultiTenantService = void 0;
+const common_1 = require("@nestjs/common");
+const keycloak_connect_1 = __importDefault(require("keycloak-connect"));
+const constants_1 = require("../constants");
+/**
+ * Stores all keycloak instances when multi tenant option is defined.
+ */
+let KeycloakMultiTenantService = class KeycloakMultiTenantService {
+    constructor(keycloakOpts) {
+        this.keycloakOpts = keycloakOpts;
+        this.instances = new Map();
+    }
+    /**
+     * Clears the cached Keycloak instances.
+     */
+    clear() {
+        this.instances.clear();
+    }
+    /**
+     * Retrieves a keycloak instance based on the realm provided.
+     * @param realm the realm to retrieve from
+     * @param request the request instance, defaults to undefined
+     * @returns the multi tenant keycloak instance
+     */
+    get(realm_1) {
+        return __awaiter(this, arguments, void 0, function* (realm, request = undefined) {
+            if (typeof this.keycloakOpts === 'string') {
+                throw new Error('Keycloak configuration is a configuration path. This should not happen after module load.');
+            }
+            if (this.keycloakOpts.multiTenant === null ||
+                this.keycloakOpts.multiTenant === undefined) {
+                throw new Error('Multi tenant is not defined yet multi tenant service is being called.');
+            }
+            const authServerUrl = yield this.resolveAuthServerUrl(realm, request);
+            const secret = yield this.resolveSecret(realm, request);
+            const clientId = yield this.resolveClientId(realm, request);
+            // Check if existing
+            if (this.instances.has(realm) &&
+                !this.keycloakOpts.multiTenant.resolveAlways) {
+                // Otherwise return the instance
+                return this.instances.get(realm);
+            }
+            else {
+                // TODO: Repeating code from  provider, will need to rework this in 2.0
+                // Override realm, secret, and authServerUrl
+                const keycloakOpts = Object.assign(this.keycloakOpts, {
+                    authServerUrl,
+                    realm,
+                    secret,
+                    clientId,
+                });
+                const keycloak = new keycloak_connect_1.default({}, keycloakOpts);
+                // The most important part
+                keycloak.accessDenied = (req, res, next) => {
+                    req.resourceDenied = true;
+                    next();
+                };
+                // Save instance
+                this.instances.set(realm, keycloak);
+                return keycloak;
+            }
+        });
+    }
+    resolveAuthServerUrl(realm_1) {
+        return __awaiter(this, arguments, void 0, function* (realm, request = undefined) {
+            if (typeof this.keycloakOpts === 'string') {
+                throw new Error('Keycloak configuration is a configuration path. This should not happen after module load.');
+            }
+            if (this.keycloakOpts.multiTenant === null ||
+                this.keycloakOpts.multiTenant === undefined) {
+                throw new Error('Multi tenant is not defined yet multi tenant service is being called.');
+            }
+            // If no realm auth server url resolver is defined, return defaults
+            if (!this.keycloakOpts.multiTenant.realmAuthServerUrlResolver) {
+                return (this.keycloakOpts.authServerUrl ||
+                    this.keycloakOpts['auth-server-url'] ||
+                    this.keycloakOpts.serverUrl ||
+                    this.keycloakOpts['server-url']);
+            }
+            // Resolve realm authServerUrl
+            const resolvedAuthServerUrl = this.keycloakOpts.multiTenant.realmAuthServerUrlResolver(realm, request);
+            const authServerUrl = resolvedAuthServerUrl || resolvedAuthServerUrl instanceof Promise
+                ? yield resolvedAuthServerUrl
+                : resolvedAuthServerUrl;
+            // Override auth server url
+            // Order of priority: resolved realm auth server url > provided auth server url
+            return (authServerUrl ||
+                this.keycloakOpts.authServerUrl ||
+                this.keycloakOpts['auth-server-url'] ||
+                this.keycloakOpts.serverUrl ||
+                this.keycloakOpts['server-url']);
+        });
+    }
+    resolveClientId(realm_1) {
+        return __awaiter(this, arguments, void 0, function* (realm, request = undefined) {
+            if (typeof this.keycloakOpts === 'string') {
+                throw new Error('Keycloak configuration is a configuration path. This should not happen after module load.');
+            }
+            if (this.keycloakOpts.multiTenant === null ||
+                this.keycloakOpts.multiTenant === undefined) {
+                throw new Error('Multi tenant is not defined yet multi tenant service is being called.');
+            }
+            // If no realm client-id resolver is defined, return defaults
+            if (!this.keycloakOpts.multiTenant.realmClientIdResolver) {
+                return this.keycloakOpts.clientId || this.keycloakOpts['client-id'];
+            }
+            // Resolve realm client-id
+            const resolvedClientId = this.keycloakOpts.multiTenant.realmClientIdResolver(realm, request);
+            const realmClientId = resolvedClientId || resolvedClientId instanceof Promise
+                ? yield resolvedClientId
+                : resolvedClientId;
+            // Override client-id
+            // Order of priority: resolved realm secret > default global secret
+            return (realmClientId ||
+                this.keycloakOpts.clientId ||
+                this.keycloakOpts['client-id']);
+        });
+    }
+    resolveSecret(realm_1) {
+        return __awaiter(this, arguments, void 0, function* (realm, request = undefined) {
+            if (typeof this.keycloakOpts === 'string') {
+                throw new Error('Keycloak configuration is a configuration path. This should not happen after module load.');
+            }
+            if (this.keycloakOpts.multiTenant === null ||
+                this.keycloakOpts.multiTenant === undefined) {
+                throw new Error('Multi tenant is not defined yet multi tenant service is being called.');
+            }
+            // If no realm secret resolver is defined, return defaults
+            if (!this.keycloakOpts.multiTenant.realmSecretResolver) {
+                return this.keycloakOpts.secret;
+            }
+            // Resolve realm secret
+            const resolvedRealmSecret = this.keycloakOpts.multiTenant.realmSecretResolver(realm, request);
+            const realmSecret = resolvedRealmSecret || resolvedRealmSecret instanceof Promise
+                ? yield resolvedRealmSecret
+                : resolvedRealmSecret;
+            // Override secret
+            // Order of priority: resolved realm secret > default global secret
+            return realmSecret || this.keycloakOpts.secret;
+        });
+    }
+};
+exports.KeycloakMultiTenantService = KeycloakMultiTenantService;
+exports.KeycloakMultiTenantService = KeycloakMultiTenantService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(constants_1.KEYCLOAK_CONNECT_OPTIONS)),
+    __metadata("design:paramtypes", [Object])
+], KeycloakMultiTenantService);

package/dist/util.d.ts

@@ -0,0 +1 @@
+export declare const parseToken: (token: string) => any;

package/dist/util.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseToken = void 0;
+const parseToken = (token) => {
+    const parts = token.split('.');
+    return JSON.parse(Buffer.from(parts[1], 'base64').toString());
+};
+exports.parseToken = parseToken;

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@clemax/nest-keycloak-connect",
+  "version": "2.0.0",
+  "description": "keycloak-nodejs-connect module for Nest",
+  "author": "John Joshua Ferrer <johnjoshuaferrer@disroot.org>",
+  "license": "MIT",
+  "keywords": [
+    "nestjs",
+    "keycloak",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ferrerojosh/nest-keycloak-connect"
+  },
+  "bugs": "https://github.com/ferrerojosh/nest-keycloak-connect/issues",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "dist/index.d.ts": [
+        "dist/index.d.ts"
+      ],
+      "*": [
+        "dist/*"
+      ]
+    }
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./*": "./dist/*"
+  },
+  "peerDependencies": {
+    "@nestjs/common": ">=6.0.0 <12.0.0",
+    "@nestjs/core": ">=6.0.0 <12.0.0",
+    "@nestjs/graphql": ">=6",
+    "keycloak-connect": "npm:@clemax/keycloak-connect@>=10.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.0.6",
+    "@nestjs/core": "^11.0.6",
+    "@nestjs/graphql": "^13.0.2",
+    "@types/express": "^4.17.21",
+    "@types/node": "^18.19.23",
+    "class-transformer": "0.5.1",
+    "class-validator": "0.14.1",
+    "cpr": "3.0.1",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
+    "graphql": "^16.10.0",
+    "husky": "^9.0.11",
+    "keycloak-connect": "npm:@clemax/keycloak-connect@26.1.2",
+    "lint-staged": "^15.2.2",
+    "prettier": "3.2.5",
+    "reflect-metadata": "0.2.1",
+    "release-it": "17.1.1",
+    "rimraf": "3.0.2",
+    "rxjs": "7.8.1",
+    "ts-node": "10.8.2",
+    "typescript": "5.4.2",
+    "typescript-eslint": "^7.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@nestjs/graphql": {
+      "optional": true
+    }
+  },
+  "funding": [
+    {
+      "type": "individual",
+      "url": "https://www.paypal.me/ferrerojosh/"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/ferrerojosh"
+    }
+  ],
+  "volta": {
+    "node": "21.7.1"
+  },
+  "lint-staged": {
+    "**/*.ts": [
+      "prettier --write",
+      "eslint"
+    ]
+  },
+  "scripts": {
+    "start:dev": "tsc -w",
+    "clean": "rimraf dist",
+    "build": "tsc",
+    "release": "release-it",
+    "release:alpha": "release-it --preReleaseId=alpha --npm.tag=next --github.preRelease",
+    "format": "prettier src --write",
+    "lint": "eslint src"
+  }
+}