quankee-framework-keycloak 1.4.3 → 1.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,15 +1,15 @@
1
- ISC License
2
-
3
- Copyright (c) 2025 Quankee Software, Lda
4
-
5
- Permission to use, copy, modify, and/or distribute this software for any
6
- purpose with or without fee is hereby granted, provided that the above
7
- copyright notice and this permission notice appear in all copies.
8
-
9
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1
+ ISC License
2
+
3
+ Copyright (c) 2025 Quankee Software, Lda
4
+
5
+ Permission to use, copy, modify, and/or distribute this software for any
6
+ purpose with or without fee is hereby granted, provided that the above
7
+ copyright notice and this permission notice appear in all copies.
8
+
9
+ THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10
+ WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11
+ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12
+ ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13
+ WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14
+ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15
+ OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
package/README.md CHANGED
@@ -1,7 +1,7 @@
1
- # Quankee Framework Keycloak
2
-
3
- # Keycloak
4
- npm install keycloak-angular keycloak-js
5
-
6
- # JWT
7
- npm install jwt-decode
1
+ # Quankee Framework Keycloak
2
+
3
+ # Keycloak
4
+ npm install keycloak-angular keycloak-js
5
+
6
+ # JWT
7
+ npm install jwt-decode
@@ -1 +1 @@
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;;;;"}
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';\nimport Keycloak from 'keycloak-js';\nimport {AuthenticatedUser} from './authenticated-user';\nimport {KeycloakToken} from './keycloak-token';\n\n// Your own type definition for 'onLoad' because keycloak-js doesn't export it\nexport type AppKeycloakOnLoad = \"login-required\" | \"check-sso\";\n\nexport type KeycloakPkceMethod = \"S256\";\n\n// Your own config interface\nexport interface KeycloakConfig {\n url: string;\n realm: string;\n clientId: string;\n onLoad?: AppKeycloakOnLoad;\n checkLoginIframe?: boolean;\n silentCheckSsoRedirectUri?: string;\n pkceMethod?: KeycloakPkceMethod;\n flow?: \"standard\" | \"implicit\";\n}\n\n\n@Injectable({\n providedIn: 'root',\n})\nexport class KeycloakService{\n\n private keycloak?: Keycloak;\n\n private initialized = false;\n\n constructor() {}\n\n async init(config: KeycloakConfig): Promise<boolean> {\n this.keycloak = new Keycloak({\n url: config.url,\n realm: config.realm,\n clientId: config.clientId,\n });\n\n const initOptions: {\n onLoad: \"login-required\" | \"check-sso\";\n checkLoginIframe: boolean;\n silentCheckSsoRedirectUri?: string;\n pkceMethod: KeycloakPkceMethod;\n flow: \"standard\" | \"implicit\";\n } = {\n onLoad: config.onLoad ?? \"login-required\",\n checkLoginIframe: config.checkLoginIframe ?? false,\n silentCheckSsoRedirectUri: config.silentCheckSsoRedirectUri,\n pkceMethod: config.pkceMethod ?? \"S256\",\n flow: config.flow ?? \"standard\",\n };\n\n try {\n const authenticated = await this.keycloak.init(initOptions);\n this.initialized = true;\n return authenticated;\n } catch (error) {\n console.error(\"Keycloak initialization failed\", error);\n return false;\n }\n\n }\n\n login(): void {\n this.keycloak?.login();\n }\n\n logout(redirectUri?: string): void {\n this.keycloak?.logout({ redirectUri });\n }\n\n accountManagement(): void {\n this.keycloak?.accountManagement();\n }\n\n getToken(): string | undefined {\n return this.keycloak?.token;\n }\n\n getParsedToken(): KeycloakToken | undefined {\n return this.keycloak?.tokenParsed as KeycloakToken;\n }\n\n async refreshToken(minValidity = 5): Promise<boolean> {\n if (!this.keycloak) return false;\n try {\n return await this.keycloak.updateToken(minValidity);\n } catch (e) {\n console.error(\"Token refresh failed\", e);\n return false;\n }\n }\n\n getUsername(): string | undefined {\n return this.getParsedToken()?.preferred_username;\n }\n\n isLoggedIn(): boolean {\n return !!this.keycloak?.authenticated;\n }\n\n async getUser(): Promise<AuthenticatedUser | undefined> {\n if (!this.keycloak?.token || !this.keycloak.tokenParsed) return;\n\n const profile = await this.keycloak.loadUserProfile();\n return {\n token: this.keycloak.token,\n parsedToken: this.keycloak.tokenParsed as KeycloakToken,\n profile,\n };\n }\n\n getKeycloak(): Keycloak | undefined {\n return this.keycloak;\n }\n\n\n}\n","/*\n * Public API Surface of quankee-framework-keycloak\n */\n\nexport * from './lib/core/keycloak-token';\nexport * from './lib/core/authenticated-user';\nexport * from './lib/core/keycloak.service';\n\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/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "quankee-framework-keycloak",
3
3
  "description": "Quankee Framework Keycloak Lib",
4
- "version": "1.4.3",
4
+ "version": "1.4.5",
5
5
  "author": {
6
6
  "email": "info@quankee.co.mz",
7
7
  "name": "Quankee Software, Lda",