@slickteam/nestjs-keycloak-admin 2.2.2 → 2.2.3

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { UserRepresentation } from '@s3pweb/keycloak-admin-client-cjs';
+import { KeycloakActionsEmailEnum, KeycloakAdminService } from './keycloak-admin.service';
+declare function checkIfExistRealmRoleOfUser(user: {
+    realm_access: {
+        roles: string[];
+    } | undefined;
+}, roleName: string): boolean;
+declare class KeycloakAdminModule {
+}
+export { KeycloakAdminModule, KeycloakAdminService, KeycloakActionsEmailEnum, UserRepresentation, checkIfExistRealmRoleOfUser, };

package/dist/index.js

@@ -0,0 +1,29 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeycloakActionsEmailEnum = exports.KeycloakAdminService = exports.KeycloakAdminModule = void 0;
+exports.checkIfExistRealmRoleOfUser = checkIfExistRealmRoleOfUser;
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const keycloak_admin_service_1 = require("./keycloak-admin.service");
+Object.defineProperty(exports, "KeycloakActionsEmailEnum", { enumerable: true, get: function () { return keycloak_admin_service_1.KeycloakActionsEmailEnum; } });
+Object.defineProperty(exports, "KeycloakAdminService", { enumerable: true, get: function () { return keycloak_admin_service_1.KeycloakAdminService; } });
+function checkIfExistRealmRoleOfUser(user, roleName) {
+    return user.realm_access?.roles.includes(roleName) ?? false;
+}
+let KeycloakAdminModule = class KeycloakAdminModule {
+};
+exports.KeycloakAdminModule = KeycloakAdminModule;
+exports.KeycloakAdminModule = KeycloakAdminModule = __decorate([
+    (0, common_1.Module)({
+        imports: [config_1.ConfigModule.forRoot()],
+        providers: [keycloak_admin_service_1.KeycloakAdminService],
+        exports: [keycloak_admin_service_1.KeycloakAdminService],
+    })
+], KeycloakAdminModule);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAwBE,kEAA2B;AAxB7B,2CAAwC;AACxC,2CAA8C;AAG9C,qEAA0F;AAiBxF,yGAjBO,iDAAwB,OAiBP;AAFxB,qGAfiC,6CAAoB,OAejC;AAbtB,SAAS,2BAA2B,CAAC,IAAuD,EAAE,QAAgB;IAC5G,OAAO,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;AAC9D,CAAC;AAOD,IAAM,mBAAmB,GAAzB,MAAM,mBAAmB;CAAG,CAAA;AAG1B,kDAAmB;8BAHf,mBAAmB;IALxB,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,qBAAY,CAAC,OAAO,EAAE,CAAC;QACjC,SAAS,EAAE,CAAC,6CAAoB,CAAC;QACjC,OAAO,EAAE,CAAC,6CAAoB,CAAC;KAChC,CAAC;GACI,mBAAmB,CAAG"}

package/dist/keycloak-admin.service.d.ts

@@ -0,0 +1,27 @@
+import { ConfigService } from '@nestjs/config';
+import { KeycloakAdminClient, UserRepresentation } from '@s3pweb/keycloak-admin-client-cjs';
+export declare enum KeycloakActionsEmailEnum {
+    VERIFY_EMAIL = "VERIFY_EMAIL",
+    UPDATE_PROFILE = "UPDATE_PROFILE",
+    CONFIGURE_TOTP = "CONFIGURE_TOTP",
+    UPDATE_PASSWORD = "UPDATE_PASSWORD",
+    TERMS_AND_CONDITIONS = "TERMS_AND_CONDITIONS"
+}
+export declare class KeycloakAdminService {
+    private configService;
+    readonly KEYCLOAK_ADMIN_CLIENT_ID: string;
+    private readonly KEYCLOAK_ADMIN_CLIENT_SECRET;
+    private readonly KEYCLOAK_REALM;
+    readonly _client: KeycloakAdminClient;
+    constructor(configService: ConfigService);
+    private auth;
+    getAccessToken(): Promise<string>;
+    findAllUsers(): Promise<UserRepresentation[]>;
+    findUserByEmail(email: string): Promise<UserRepresentation[]>;
+    findUserByUsername(username: string): Promise<UserRepresentation[]>;
+    findUserById(id: string): Promise<UserRepresentation | undefined>;
+    createUser(email: string, firstName?: string | undefined, lastName?: string | undefined, username?: string | undefined, attributes?: Record<string, unknown>): Promise<UserRepresentation>;
+    updateAttributesOfUser(id: string, user: UserRepresentation, attributes: Record<string, unknown>): Promise<void | never>;
+    updateUserPassword(userId: string, newPassword: string): Promise<void | never>;
+    executeActionsEmail(sub: string, clientId: string | undefined, lifespan: number | undefined, redirectUri: string | undefined, actions: KeycloakActionsEmailEnum[] | undefined): Promise<void | never>;
+}

package/dist/keycloak-admin.service.js

@@ -0,0 +1,132 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeycloakAdminService = exports.KeycloakActionsEmailEnum = void 0;
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const keycloak_admin_client_cjs_1 = require("@s3pweb/keycloak-admin-client-cjs");
+const jwt_decode_1 = require("jwt-decode");
+const logger = new common_1.Logger('KeycloakAdminService');
+var KeycloakActionsEmailEnum;
+(function (KeycloakActionsEmailEnum) {
+    KeycloakActionsEmailEnum["VERIFY_EMAIL"] = "VERIFY_EMAIL";
+    KeycloakActionsEmailEnum["UPDATE_PROFILE"] = "UPDATE_PROFILE";
+    KeycloakActionsEmailEnum["CONFIGURE_TOTP"] = "CONFIGURE_TOTP";
+    KeycloakActionsEmailEnum["UPDATE_PASSWORD"] = "UPDATE_PASSWORD";
+    KeycloakActionsEmailEnum["TERMS_AND_CONDITIONS"] = "TERMS_AND_CONDITIONS";
+})(KeycloakActionsEmailEnum || (exports.KeycloakActionsEmailEnum = KeycloakActionsEmailEnum = {}));
+let KeycloakAdminService = class KeycloakAdminService {
+    configService;
+    KEYCLOAK_ADMIN_CLIENT_ID;
+    KEYCLOAK_ADMIN_CLIENT_SECRET;
+    KEYCLOAK_REALM;
+    _client;
+    constructor(configService) {
+        this.configService = configService;
+        const keycloakUrl = this.configService.getOrThrow('KEYCLOAK_URL');
+        this.KEYCLOAK_ADMIN_CLIENT_ID = this.configService.getOrThrow('KEYCLOAK_ADMIN_CLIENT_ID');
+        this.KEYCLOAK_ADMIN_CLIENT_SECRET = this.configService.getOrThrow('KEYCLOAK_ADMIN_CLIENT_SECRET');
+        this.KEYCLOAK_REALM = this.configService.getOrThrow('KEYCLOAK_ADMIN_REALM');
+        this._client = new keycloak_admin_client_cjs_1.KeycloakAdminClient({
+            baseUrl: keycloakUrl,
+            realmName: this.KEYCLOAK_REALM,
+        });
+    }
+    async auth() {
+        await this._client.auth({
+            grantType: 'client_credentials',
+            clientId: this.KEYCLOAK_ADMIN_CLIENT_ID,
+            clientSecret: this.KEYCLOAK_ADMIN_CLIENT_SECRET,
+        });
+    }
+    async getAccessToken() {
+        let accessToken;
+        try {
+            accessToken = await this._client.getAccessToken();
+        }
+        catch {
+        }
+        if (!accessToken) {
+            logger.debug('Get an access token');
+            await this.auth();
+        }
+        let newAccessToken = accessToken ?? this._client.accessToken;
+        if (newAccessToken === undefined) {
+            throw new Error(`Can't have access_token on keycloak by client_secret method`);
+        }
+        const decodedTokenExpTime = (0, jwt_decode_1.jwtDecode)(newAccessToken)?.exp ?? 0;
+        const nowTmSecond = Math.ceil(Date.now() / 1000) + 2;
+        if (decodedTokenExpTime < nowTmSecond) {
+            logger.debug('Renew a new access token');
+            await this.auth();
+            newAccessToken = this._client.accessToken;
+        }
+        else {
+            logger.verbose(`Remain time for this access token : ${decodedTokenExpTime - nowTmSecond} seconds`);
+        }
+        return newAccessToken;
+    }
+    async findAllUsers() {
+        await this.getAccessToken();
+        logger.verbose('findAllUsers()');
+        return this._client.users.find();
+    }
+    async findUserByEmail(email) {
+        await this.getAccessToken();
+        logger.verbose(`findUserByEmail(email=${email})`);
+        return this._client.users.find({ email });
+    }
+    async findUserByUsername(username) {
+        await this.getAccessToken();
+        logger.verbose(`findUserByUsername(username=${username})`);
+        return this._client.users.find({ username });
+    }
+    async findUserById(id) {
+        await this.getAccessToken();
+        logger.verbose(`findUserById(id=${id})`);
+        return this._client.users.findOne({ id: id });
+    }
+    async createUser(email, firstName = undefined, lastName = undefined, username = undefined, attributes = {}) {
+        await this.getAccessToken();
+        logger.verbose(`createUser(email=${email}, firstName=${firstName}, lastName=${lastName}, username=${username})`);
+        return this._client.users.create({ username, email, firstName, lastName, attributes, enabled: true, emailVerified: true });
+    }
+    async updateAttributesOfUser(id, user, attributes) {
+        await this.getAccessToken();
+        await this._client.users.update({ id }, {
+            ...user,
+            attributes,
+        });
+    }
+    async updateUserPassword(userId, newPassword) {
+        await this.getAccessToken();
+        await this._client.users.resetPassword({
+            id: userId,
+            credential: { type: 'password', value: newPassword, temporary: false },
+        });
+    }
+    async executeActionsEmail(sub, clientId, lifespan, redirectUri, actions) {
+        await this.getAccessToken();
+        await this._client.users.executeActionsEmail({
+            id: sub,
+            clientId,
+            lifespan,
+            redirectUri,
+            actions,
+        });
+    }
+};
+exports.KeycloakAdminService = KeycloakAdminService;
+exports.KeycloakAdminService = KeycloakAdminService = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [config_1.ConfigService])
+], KeycloakAdminService);
+//# sourceMappingURL=keycloak-admin.service.js.map

package/dist/keycloak-admin.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keycloak-admin.service.js","sourceRoot":"","sources":["../src/keycloak-admin.service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAAoD;AACpD,2CAA+C;AAC/C,iFAA4F;AAC5F,2CAAuC;AAEvC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,sBAAsB,CAAC,CAAC;AAElD,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,yDAA6B,CAAA;IAC7B,6DAAiC,CAAA;IACjC,6DAAiC,CAAA;IACjC,+DAAmC,CAAA;IACnC,yEAA6C,CAAA;AAC/C,CAAC,EANW,wBAAwB,wCAAxB,wBAAwB,QAMnC;AAGM,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAMJ;IALX,wBAAwB,CAAS;IAChC,4BAA4B,CAAS;IACrC,cAAc,CAAS;IACxB,OAAO,CAAsB;IAE7C,YAA2B,aAA4B;QAA5B,kBAAa,GAAb,aAAa,CAAe;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAS,cAAc,CAAC,CAAC;QAC1E,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,0BAA0B,CAAC,CAAC;QAC1F,IAAI,CAAC,4BAA4B,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;QAClG,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAS,sBAAsB,CAAC,CAAC;QAEpF,IAAI,CAAC,OAAO,GAAG,IAAI,+CAAmB,CAAC;YACrC,OAAO,EAAE,WAAW;YACpB,SAAS,EAAE,IAAI,CAAC,cAAc;SAC/B,CAAC,CAAC;IACL,CAAC;IAMO,KAAK,CAAC,IAAI;QAChB,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YACtB,SAAS,EAAE,oBAAoB;YAC/B,QAAQ,EAAE,IAAI,CAAC,wBAAwB;YACvC,YAAY,EAAE,IAAI,CAAC,4BAA4B;SAChD,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,cAAc;QACzB,IAAI,WAAW,CAAC;QAChB,IAAI,CAAC;YACH,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;QAET,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YACpC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,cAAc,GAAG,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QAC7D,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;QACjF,CAAC;QACD,MAAM,mBAAmB,GAAG,IAAA,sBAAS,EAAC,cAAc,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;QAChE,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QACrD,IAAI,mBAAmB,GAAG,WAAW,EAAE,CAAC;YACtC,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;YACzC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC;QAC7C,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,OAAO,CAAC,uCAAuC,mBAAmB,GAAG,WAAW,UAAU,CAAC,CAAC;QACrG,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAMM,KAAK,CAAC,YAAY;QACvB,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,KAAa;QACxC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,yBAAyB,KAAK,GAAG,CAAC,CAAC;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,QAAgB;QAC9C,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,+BAA+B,QAAQ,GAAG,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,EAAU;QAClC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAMM,KAAK,CAAC,UAAU,CACrB,KAAa,EACb,YAAgC,SAAS,EACzC,WAA+B,SAAS,EACxC,WAA+B,SAAS,EACxC,aAAsC,EAAE;QAExC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,CAAC,oBAAoB,KAAK,eAAe,SAAS,cAAc,QAAQ,cAAc,QAAQ,GAAG,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7H,CAAC;IAMM,KAAK,CAAC,sBAAsB,CAAC,EAAU,EAAE,IAAwB,EAAE,UAAmC;QAC3G,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAC7B,EAAE,EAAE,EAAE,EACN;YACE,GAAG,IAAI;YACP,UAAU;SACX,CACF,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,WAAmB;QACjE,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;YACrC,EAAE,EAAE,MAAM;YACV,UAAU,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE;SACvE,CAAC,CAAC;IACL,CAAC;IAMM,KAAK,CAAC,mBAAmB,CAC9B,GAAW,EACX,QAA4B,EAC5B,QAA4B,EAC5B,WAA+B,EAC/B,OAA+C;QAE/C,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC;YAC3C,EAAE,EAAE,GAAG;YACP,QAAQ;YACR,QAAQ;YACR,WAAW;YACX,OAAO;SACR,CAAC,CAAC;IACL,CAAC;CACF,CAAA;AAhJY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;qCAO+B,sBAAa;GAN5C,oBAAoB,CAgJhC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@slickteam/nestjs-keycloak-admin",
   "description": "Module for Keycloak admin usage with Nestjs",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "keywords": [
     "Slickteam",
     "Nestjs",