quankee-framework-keycloak 1.0.1 → 1.3.0

package/fesm2022/quankee-framework-keycloak.mjs

@@ -0,0 +1,96 @@
+import * as i0 from '@angular/core';
+import { Injectable } from '@angular/core';
+import Keycloak from 'keycloak-js';
+
+class KeycloakService {
+    keycloak;
+    initialized = false;
+    constructor() { }
+    async init(config) {
+        this.keycloak = new Keycloak({
+            url: config.url,
+            realm: config.realm,
+            clientId: config.clientId,
+        });
+        const initOptions = {
+            onLoad: config.onLoad ?? "login-required",
+            checkLoginIframe: config.checkLoginIframe ?? false,
+            silentCheckSsoRedirectUri: config.silentCheckSsoRedirectUri,
+            pkceMethod: config.pkceMethod ?? "S256",
+            flow: config.flow ?? "standard",
+        };
+        try {
+            const authenticated = await this.keycloak.init(initOptions);
+            this.initialized = true;
+            return authenticated;
+        }
+        catch (error) {
+            console.error("Keycloak initialization failed", error);
+            return false;
+        }
+    }
+    login() {
+        this.keycloak?.login();
+    }
+    logout(redirectUri) {
+        this.keycloak?.logout({ redirectUri });
+    }
+    accountManagement() {
+        this.keycloak?.accountManagement();
+    }
+    getToken() {
+        return this.keycloak?.token;
+    }
+    getParsedToken() {
+        return this.keycloak?.tokenParsed;
+    }
+    async refreshToken(minValidity = 5) {
+        if (!this.keycloak)
+            return false;
+        try {
+            return await this.keycloak.updateToken(minValidity);
+        }
+        catch (e) {
+            console.error("Token refresh failed", e);
+            return false;
+        }
+    }
+    getUsername() {
+        return this.getParsedToken()?.preferred_username;
+    }
+    isLoggedIn() {
+        return !!this.keycloak?.authenticated;
+    }
+    async getUser() {
+        if (!this.keycloak?.token || !this.keycloak.tokenParsed)
+            return;
+        const profile = await this.keycloak.loadUserProfile();
+        return {
+            token: this.keycloak.token,
+            parsedToken: this.keycloak.tokenParsed,
+            profile,
+        };
+    }
+    getKeycloak() {
+        return this.keycloak;
+    }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: KeycloakService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: KeycloakService, providedIn: 'root' });
+}
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: KeycloakService, decorators: [{
+            type: Injectable,
+            args: [{
+                    providedIn: 'root',
+                }]
+        }], ctorParameters: () => [] });
+
+/*
+ * Public API Surface of quankee-framework-keycloak
+ */
+
+/**
+ * Generated bundle index. Do not edit.
+ */
+
+export { KeycloakService };
+//# sourceMappingURL=quankee-framework-keycloak.mjs.map

package/fesm2022/quankee-framework-keycloak.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"quankee-framework-keycloak.mjs","sources":["../../../projects/quankee-framework-keycloak/src/lib/core/keycloak.service.ts","../../../projects/quankee-framework-keycloak/src/public-api.ts","../../../projects/quankee-framework-keycloak/src/quankee-framework-keycloak.ts"],"sourcesContent":["import {Injectable} from '@angular/core';\r\nimport Keycloak from 'keycloak-js';\r\nimport {AuthenticatedUser} from './authenticated-user';\r\nimport {KeycloakToken} from './keycloak-token';\r\n\r\n// Your own type definition for 'onLoad' because keycloak-js doesn't export it\r\nexport type AppKeycloakOnLoad = \"login-required\" | \"check-sso\";\r\n\r\nexport type KeycloakPkceMethod = \"S256\";\r\n\r\n// Your own config interface\r\nexport interface KeycloakConfig {\r\n  url: string;\r\n  realm: string;\r\n  clientId: string;\r\n  onLoad?: AppKeycloakOnLoad;\r\n  checkLoginIframe?: boolean;\r\n  silentCheckSsoRedirectUri?: string;\r\n  pkceMethod?: KeycloakPkceMethod;\r\n  flow?: \"standard\" | \"implicit\";\r\n}\r\n\r\n\r\n@Injectable({\r\n  providedIn: 'root',\r\n})\r\nexport class KeycloakService{\r\n\r\n  private  keycloak?: Keycloak;\r\n\r\n  private initialized = false;\r\n\r\n  constructor() {}\r\n\r\n  async init(config: KeycloakConfig): Promise<boolean> {\r\n    this.keycloak = new Keycloak({\r\n      url: config.url,\r\n      realm: config.realm,\r\n      clientId: config.clientId,\r\n    });\r\n\r\n    const initOptions: {\r\n      onLoad: \"login-required\" | \"check-sso\";\r\n      checkLoginIframe: boolean;\r\n      silentCheckSsoRedirectUri?: string;\r\n      pkceMethod: KeycloakPkceMethod;\r\n      flow: \"standard\" | \"implicit\";\r\n    } = {\r\n      onLoad: config.onLoad ?? \"login-required\",\r\n      checkLoginIframe: config.checkLoginIframe ?? false,\r\n      silentCheckSsoRedirectUri: config.silentCheckSsoRedirectUri,\r\n      pkceMethod: config.pkceMethod ?? \"S256\",\r\n      flow: config.flow ?? \"standard\",\r\n    };\r\n\r\n    try {\r\n      const authenticated = await this.keycloak.init(initOptions);\r\n      this.initialized = true;\r\n      return authenticated;\r\n    } catch (error) {\r\n      console.error(\"Keycloak initialization failed\", error);\r\n      return false;\r\n    }\r\n\r\n  }\r\n\r\n  login(): void {\r\n    this.keycloak?.login();\r\n  }\r\n\r\n  logout(redirectUri?: string): void {\r\n    this.keycloak?.logout({ redirectUri });\r\n  }\r\n\r\n  accountManagement(): void {\r\n    this.keycloak?.accountManagement();\r\n  }\r\n\r\n  getToken(): string | undefined {\r\n    return this.keycloak?.token;\r\n  }\r\n\r\n  getParsedToken(): KeycloakToken | undefined {\r\n    return this.keycloak?.tokenParsed as KeycloakToken;\r\n  }\r\n\r\n  async refreshToken(minValidity = 5): Promise<boolean> {\r\n    if (!this.keycloak) return false;\r\n    try {\r\n      return await this.keycloak.updateToken(minValidity);\r\n    } catch (e) {\r\n      console.error(\"Token refresh failed\", e);\r\n      return false;\r\n    }\r\n  }\r\n\r\n  getUsername(): string | undefined {\r\n    return this.getParsedToken()?.preferred_username;\r\n  }\r\n\r\n  isLoggedIn(): boolean {\r\n    return !!this.keycloak?.authenticated;\r\n  }\r\n\r\n  async getUser(): Promise<AuthenticatedUser | undefined> {\r\n    if (!this.keycloak?.token || !this.keycloak.tokenParsed) return;\r\n\r\n    const profile = await this.keycloak.loadUserProfile();\r\n    return {\r\n      token: this.keycloak.token,\r\n      parsedToken: this.keycloak.tokenParsed as KeycloakToken,\r\n      profile,\r\n    };\r\n  }\r\n\r\n  getKeycloak(): Keycloak | undefined {\r\n    return this.keycloak;\r\n  }\r\n\r\n\r\n}\r\n","/*\r\n * Public API Surface of quankee-framework-keycloak\r\n */\r\n\r\nexport * from './lib/core/keycloak-token';\r\nexport * from './lib/core/authenticated-user';\r\nexport * from './lib/core/keycloak.service';\r\n\r\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './public-api';\n"],"names":[],"mappings":";;;;MA0Ba,eAAe,CAAA;AAEjB,IAAA,QAAQ;IAET,WAAW,GAAG,KAAK;AAE3B,IAAA,WAAA,GAAA;IAEA,MAAM,IAAI,CAAC,MAAsB,EAAA;AAC/B,QAAA,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC3B,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;AAC1B,SAAA,CAAC;AAEF,QAAA,MAAM,WAAW,GAMb;AACF,YAAA,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,gBAAgB;AACzC,YAAA,gBAAgB,EAAE,MAAM,CAAC,gBAAgB,IAAI,KAAK;YAClD,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;AAC3D,YAAA,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,MAAM;AACvC,YAAA,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,UAAU;SAChC;AAED,QAAA,IAAI;YACF,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC;AAC3D,YAAA,IAAI,CAAC,WAAW,GAAG,IAAI;AACvB,YAAA,OAAO,aAAa;;QACpB,OAAO,KAAK,EAAE;AACd,YAAA,OAAO,CAAC,KAAK,CAAC,gCAAgC,EAAE,KAAK,CAAC;AACtD,YAAA,OAAO,KAAK;;;IAKhB,KAAK,GAAA;AACH,QAAA,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE;;AAGxB,IAAA,MAAM,CAAC,WAAoB,EAAA;QACzB,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;;IAGxC,iBAAiB,GAAA;AACf,QAAA,IAAI,CAAC,QAAQ,EAAE,iBAAiB,EAAE;;IAGpC,QAAQ,GAAA;AACN,QAAA,OAAO,IAAI,CAAC,QAAQ,EAAE,KAAK;;IAG7B,cAAc,GAAA;AACZ,QAAA,OAAO,IAAI,CAAC,QAAQ,EAAE,WAA4B;;AAGpD,IAAA,MAAM,YAAY,CAAC,WAAW,GAAG,CAAC,EAAA;QAChC,IAAI,CAAC,IAAI,CAAC,QAAQ;AAAE,YAAA,OAAO,KAAK;AAChC,QAAA,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC;;QACnD,OAAO,CAAC,EAAE;AACV,YAAA,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC;AACxC,YAAA,OAAO,KAAK;;;IAIhB,WAAW,GAAA;AACT,QAAA,OAAO,IAAI,CAAC,cAAc,EAAE,EAAE,kBAAkB;;IAGlD,UAAU,GAAA;AACR,QAAA,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa;;AAGvC,IAAA,MAAM,OAAO,GAAA;AACX,QAAA,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW;YAAE;QAEzD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE;QACrD,OAAO;AACL,YAAA,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK;AAC1B,YAAA,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,WAA4B;YACvD,OAAO;SACR;;IAGH,WAAW,GAAA;QACT,OAAO,IAAI,CAAC,QAAQ;;wGA1FX,eAAe,EAAA,IAAA,EAAA,EAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA;AAAf,IAAA,OAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,SAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,eAAe,cAFd,MAAM,EAAA,CAAA;;4FAEP,eAAe,EAAA,UAAA,EAAA,CAAA;kBAH3B,UAAU;AAAC,YAAA,IAAA,EAAA,CAAA;AACV,oBAAA,UAAU,EAAE,MAAM;AACnB,iBAAA;;;ACzBD;;AAEG;;ACFH;;AAEG;;;;"}

package/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="quankee-framework-keycloak" />
+export * from './public-api';

package/lib/core/authenticated-user.d.ts

@@ -0,0 +1,6 @@
+import { KeycloakToken } from './keycloak-token';
+export interface AuthenticatedUser {
+    token: string;
+    parsedToken: KeycloakToken;
+    profile?: Keycloak.KeycloakProfile;
+}

package/lib/core/keycloak-token.d.ts

@@ -0,0 +1,25 @@
+export interface KeycloakToken {
+    exp: number;
+    iat: number;
+    jti: string;
+    iss: string;
+    sub: string;
+    typ: string;
+    azp?: string;
+    session_state?: string;
+    acr?: string;
+    realm_access?: {
+        roles: string[];
+    };
+    resource_access?: {
+        [clientId: string]: {
+            roles: string[];
+        };
+    };
+    scope?: string;
+    email?: string;
+    preferred_username?: string;
+    given_name?: string;
+    family_name?: string;
+    name?: string;
+}

package/lib/core/keycloak.service.d.ts

@@ -0,0 +1,34 @@
+import Keycloak from 'keycloak-js';
+import { AuthenticatedUser } from './authenticated-user';
+import { KeycloakToken } from './keycloak-token';
+import * as i0 from "@angular/core";
+export type AppKeycloakOnLoad = "login-required" | "check-sso";
+export type KeycloakPkceMethod = "S256";
+export interface KeycloakConfig {
+    url: string;
+    realm: string;
+    clientId: string;
+    onLoad?: AppKeycloakOnLoad;
+    checkLoginIframe?: boolean;
+    silentCheckSsoRedirectUri?: string;
+    pkceMethod?: KeycloakPkceMethod;
+    flow?: "standard" | "implicit";
+}
+export declare class KeycloakService {
+    private keycloak?;
+    private initialized;
+    constructor();
+    init(config: KeycloakConfig): Promise<boolean>;
+    login(): void;
+    logout(redirectUri?: string): void;
+    accountManagement(): void;
+    getToken(): string | undefined;
+    getParsedToken(): KeycloakToken | undefined;
+    refreshToken(minValidity?: number): Promise<boolean>;
+    getUsername(): string | undefined;
+    isLoggedIn(): boolean;
+    getUser(): Promise<AuthenticatedUser | undefined>;
+    getKeycloak(): Keycloak | undefined;
+    static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<KeycloakService>;
+}

package/package.json

@@ -1,37 +1,40 @@
-{
-  "name": "quankee-framework-keycloak",
-  "description": "Quankee Framework Keycloak Lib",
-  "version": "1.0.1",
-  "author": {
-    "email": "info@quankee.co.mz",
-    "name": "Quankee Software, Lda",
-    "license": "MIT",
-    "repository": {
-      "type": "git",
-      "url": "https://gitlab.com/quankee-framework/quankee-framework-common-ts"
-    },
-    "homepage": "https://gitlab.com/quankee-framework/quankee-framework-common-ts#readme",
-    "publishConfig": {
-      "registry": "https://registry.npmjs.org/"
-    }
-  },
-  "peerDependencies": {
-    "@angular/common": "^19.2.0",
-    "@angular/core": "^19.2.0",
-    "keycloak-angular": "20.0.0",
-    "keycloak-js": "26.2.0",
-    "jwt-decode": "4.0.0"
-  },
-  "dependencies": {
-
-    "tslib": "^2.3.0"
-  },
-  "ngPackage": {
-    "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-    "dest": "../../dist/quankee-framework-keycloak",
-    "lib": {
-      "entryFile": "src/public-api.ts"
-    }
-  },
-  "sideEffects": false
-}
+{
+  "name": "quankee-framework-keycloak",
+  "description": "Quankee Framework Keycloak Lib",
+  "version": "1.3.0",
+  "author": {
+    "email": "info@quankee.co.mz",
+    "name": "Quankee Software, Lda",
+    "license": "MIT",
+    "repository": {
+      "type": "git",
+      "url": "https://gitlab.com/quankee-framework/quankee-framework-common-ts"
+    },
+    "homepage": "https://gitlab.com/quankee-framework/quankee-framework-common-ts#readme",
+    "publishConfig": {
+      "registry": "https://registry.npmjs.org/"
+    }
+  },
+  "peerDependencies": {
+    "@angular/common": "^19.2.0",
+    "@angular/core": "^19.2.0",
+    "keycloak-angular": "20.0.0",
+    "keycloak-js": "26.2.0",
+    "jwt-decode": "4.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/quankee-framework-keycloak.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/quankee-framework-keycloak.mjs"
+    }
+  }
+}

package/public-api.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/core/keycloak-token';
+export * from './lib/core/authenticated-user';
+export * from './lib/core/keycloak.service';

package/ng-package.json

@@ -1,7 +0,0 @@
-{
-  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-  "dest": "../../dist/quankee-framework-keycloak",
-  "lib": {
-    "entryFile": "src/public-api.ts"
-  }
-}