@open-pioneer/authentication-keycloak 4.0.0 → 4.1.0-dev.20250818125237

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/CHANGELOG.md CHANGED
@@ -1,5 +1,74 @@
1
1
  # @open-pioneer/authentication-keycloak
2
2
 
3
+ ## 4.1.0-dev.20250818125237
4
+
5
+ ### Minor Changes
6
+
7
+ - f67fd7e: Support configuration of keycloak's login options and logout options.
8
+
9
+ For example, to redirect to a different site after logout:
10
+
11
+ ```ts
12
+ // app.ts
13
+ const element = createCustomElement({
14
+ component: AppUI,
15
+ appMetadata,
16
+ config: {
17
+ properties: {
18
+ "@open-pioneer/authentication-keycloak": {
19
+ keycloakOptions: {
20
+ // ...
21
+ keycloakLogoutOptions: {
22
+ redirectUri: "https://example.com"
23
+ }
24
+ }
25
+ } satisfies KeycloakProperties
26
+ }
27
+ }
28
+ });
29
+ ```
30
+
31
+ The plugin also supports options for the `logout` method to supply dynamic logout options:
32
+
33
+ ```ts
34
+ // via auth service
35
+ const authService = ...;
36
+ authService.logout({
37
+ // These are passed directly the keycloak plugin (if it is being used).
38
+ pluginOptions: {
39
+ redirectUri: "https://example.com",
40
+ }
41
+ })
42
+
43
+ // via direct reference to the plugin ("authentication-keycloak.KeycloakAuthPlugin")
44
+ const keycloakAuthPlugin = ...;
45
+ keycloakAuthPlugin.logout({
46
+ redirectUri: "https://example.com",
47
+ });
48
+ ```
49
+
50
+ - f67fd7e: Make `RefreshOptions` optional with sensible default values. The default values have been changed to:
51
+ - `autoRefresh`: true
52
+ - `interval` (for token lifetime checks): 10 seconds
53
+ - `timeLeft`: 60 seconds (minimum required lifetime during token validity checks)
54
+
55
+ These values are used when they are not explicitly configured using package properties.
56
+
57
+ ### Patch Changes
58
+
59
+ - b7a854d: Update dependencies
60
+ - adf277b: Update dependencies
61
+ - Updated dependencies [b7a854d]
62
+ - Updated dependencies [3881d08]
63
+ - Updated dependencies [f67fd7e]
64
+ - Updated dependencies [2da02e7]
65
+ - Updated dependencies [adf277b]
66
+ - Updated dependencies [3c6191a]
67
+ - @open-pioneer/authentication@4.1.0-dev.20250818125237
68
+ - @open-pioneer/core@4.1.0-dev.20250818125237
69
+ - @open-pioneer/notifier@4.1.0-dev.20250818125237
70
+ - @open-pioneer/runtime@4.1.0-dev.20250818125237
71
+
3
72
  ## 4.0.0
4
73
 
5
74
  ### Patch Changes
@@ -32,7 +101,6 @@
32
101
  ### Major Changes
33
102
 
34
103
  - 9477e54: Update dependencies
35
-
36
104
  - React 19
37
105
  - Vite 6
38
106
  - FormatJS 3
@@ -1,19 +1,19 @@
1
- import { AuthPlugin, AuthState, LoginBehavior } from "@open-pioneer/authentication";
1
+ import { AuthState, LoginBehavior } from "@open-pioneer/authentication";
2
2
  import { NotificationService } from "@open-pioneer/notifier";
3
3
  import { Service, ServiceOptions, type DECLARE_SERVICE_INTERFACE } from "@open-pioneer/runtime";
4
- import { KeycloakOptions, KeycloakProperties } from "./api";
4
+ import { KeycloakLogoutOptions } from "keycloak-js";
5
+ import { KeycloakAuthPlugin } from "./api";
5
6
  interface References {
6
7
  notifier: NotificationService;
7
8
  }
8
- export declare class KeycloakAuthPlugin implements Service, AuthPlugin {
9
+ export declare class KeycloakAuthPluginImpl implements Service, KeycloakAuthPlugin {
9
10
  #private;
10
11
  [DECLARE_SERVICE_INTERFACE]: "authentication-keycloak.KeycloakAuthPlugin";
11
12
  constructor(options: ServiceOptions<References>);
12
13
  destroy(): void;
13
14
  getAuthState(): AuthState;
14
15
  getLoginBehavior(): LoginBehavior;
15
- logout(): void;
16
+ logout(options?: Partial<KeycloakLogoutOptions>): void;
16
17
  private __refresh;
17
18
  }
18
- export declare function getKeycloakConfig(properties: Partial<KeycloakProperties>): KeycloakOptions;
19
19
  export {};
@@ -1,15 +1,14 @@
1
1
  import { reactive } from '@conterra/reactivity-core';
2
2
  import { createLogger, destroyResource } from '@open-pioneer/core';
3
3
  import Keycloak from 'keycloak-js';
4
+ import { getKeycloakConfig } from './getKeycloakConfig.js';
4
5
 
5
6
  const LOG = createLogger("authentication-keycloak:KeycloakAuthPlugin");
6
- class KeycloakAuthPlugin {
7
+ class KeycloakAuthPluginImpl {
7
8
  #notifier;
8
9
  #intl;
9
10
  #keycloakOptions;
10
11
  #keycloak;
11
- #logoutOptions;
12
- #loginOptions;
13
12
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
14
13
  #timerId;
15
14
  #watcher;
@@ -19,15 +18,13 @@ class KeycloakAuthPlugin {
19
18
  constructor(options) {
20
19
  this.#notifier = options.references.notifier;
21
20
  this.#intl = options.intl;
22
- this.#logoutOptions = { redirectUri: void 0 };
23
- this.#loginOptions = { redirectUri: void 0 };
24
21
  try {
25
22
  this.#keycloakOptions = getKeycloakConfig(options.properties);
26
23
  } catch (e) {
27
24
  throw new Error("Invalid keycloak configuration", { cause: e });
28
25
  }
29
26
  try {
30
- this.#keycloak = new Keycloak(this.#keycloakOptions.keycloakConfig);
27
+ this.#keycloak = new Keycloak(this.#keycloakOptions.config);
31
28
  } catch (e) {
32
29
  throw new Error("Failed to construct keycloak instance", { cause: e });
33
30
  }
@@ -58,24 +55,28 @@ class KeycloakAuthPlugin {
58
55
  }
59
56
  getLoginBehavior() {
60
57
  const doLogin = () => {
61
- LOG.debug("Login with options", this.#loginOptions);
62
- this.#keycloak.login(this.#loginOptions);
58
+ const options = this.#keycloakOptions.loginOptions;
59
+ LOG.debug("Login with options", options);
60
+ this.#keycloak.login(options);
63
61
  };
64
62
  return {
65
63
  kind: "effect",
66
64
  login: doLogin
67
65
  };
68
66
  }
69
- logout() {
70
- LOG.debug("Logout with options", this.#logoutOptions);
71
- this.#keycloak.logout(this.#logoutOptions);
67
+ logout(options) {
68
+ const logoutOptions = {
69
+ ...this.#keycloakOptions.logoutOptions,
70
+ ...options
71
+ };
72
+ LOG.debug("Logout with options", logoutOptions);
73
+ this.#keycloak.logout(logoutOptions);
72
74
  }
73
75
  async #init() {
74
- const keycloakOptions = this.#keycloakOptions;
75
- const initOptions = this.#keycloakOptions.keycloakInitOptions;
76
- const refreshOptions = keycloakOptions.refreshOptions;
76
+ const { initOptions, refreshOptions } = this.#keycloakOptions;
77
77
  let isAuthenticated;
78
78
  try {
79
+ LOG.debug("Init with options", initOptions);
79
80
  isAuthenticated = await this.#keycloak.init(initOptions);
80
81
  } catch (e) {
81
82
  const error = typeof e === "string" ? new Error(e) : e;
@@ -111,7 +112,14 @@ class KeycloakAuthPlugin {
111
112
  __refresh(interval, timeLeft) {
112
113
  clearInterval(this.#timerId);
113
114
  this.#timerId = setInterval(() => {
114
- this.#keycloak.updateToken(timeLeft).catch((e) => {
115
+ LOG.debug("Checking token validity");
116
+ this.#keycloak.updateToken(timeLeft).then((refreshed) => {
117
+ if (refreshed) {
118
+ LOG.debug("Token refreshed successfully");
119
+ } else {
120
+ LOG.debug("Token is still valid");
121
+ }
122
+ }).catch((e) => {
115
123
  LOG.error("Failed to refresh token", e);
116
124
  this.#updateState({
117
125
  kind: "not-authenticated"
@@ -124,53 +132,6 @@ class KeycloakAuthPlugin {
124
132
  this.#state.value = newState;
125
133
  }
126
134
  }
127
- const DEFAULT_AUTO_REFRESH_OPT = {
128
- autoRefresh: true,
129
- interval: 6e3,
130
- timeLeft: 70
131
- };
132
- const DEFAULT_INIT_OPT = {
133
- onLoad: "check-sso",
134
- pkceMethod: "S256"
135
- };
136
- function getKeycloakConfig(properties) {
137
- const { keycloakOptions } = properties;
138
- const { refreshOptions, keycloakInitOptions, keycloakConfig } = keycloakOptions;
139
- return {
140
- refreshOptions: { ...getRefreshOpt(refreshOptions) },
141
- keycloakInitOptions: { ...getInitOpt(keycloakInitOptions) },
142
- keycloakConfig: { ...getConfigOpt(keycloakConfig) }
143
- };
144
- }
145
- function getRefreshOpt(autoRefreshOptions) {
146
- if (!autoRefreshOptions || isObjectEmpty(autoRefreshOptions)) {
147
- LOG.warn(
148
- `The autorefresh options of the Keycloak configuration should be set to ensure automatic refreshes at specified intervals. Defaulting to '${DEFAULT_AUTO_REFRESH_OPT}'.`
149
- );
150
- return Object.assign({}, { ...DEFAULT_AUTO_REFRESH_OPT });
151
- }
152
- return autoRefreshOptions;
153
- }
154
- function getInitOpt(keycloakInitOptions) {
155
- if (!keycloakInitOptions || isObjectEmpty(keycloakInitOptions)) {
156
- LOG.warn(
157
- `The Keycloak init options of the keycloak configuration should be set. Defaulting to '${DEFAULT_INIT_OPT}'.`
158
- );
159
- return Object.assign({}, { ...DEFAULT_INIT_OPT });
160
- }
161
- return keycloakInitOptions;
162
- }
163
- function getConfigOpt(keycloakConfig) {
164
- if (!keycloakConfig || isObjectEmpty(keycloakConfig)) {
165
- throw new Error(
166
- `KeycloakConfig not found: The Keycloak configuration options are required by the plugin to perform login and logout operations`
167
- );
168
- }
169
- return keycloakConfig;
170
- }
171
- const isObjectEmpty = (objectName) => {
172
- return objectName && Object.keys(objectName).length === 0 && objectName.constructor === Object;
173
- };
174
135
 
175
- export { KeycloakAuthPlugin, getKeycloakConfig };
176
- //# sourceMappingURL=KeycloakAuthPlugin.js.map
136
+ export { KeycloakAuthPluginImpl };
137
+ //# sourceMappingURL=KeycloakAuthPluginImpl.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"KeycloakAuthPluginImpl.js","sources":["KeycloakAuthPluginImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { reactive } from \"@conterra/reactivity-core\";\nimport { AuthState, LoginBehavior } from \"@open-pioneer/authentication\";\nimport { createLogger, destroyResource, Resource } from \"@open-pioneer/core\";\nimport { NotificationService } from \"@open-pioneer/notifier\";\nimport {\n PackageIntl,\n Service,\n ServiceOptions,\n type DECLARE_SERVICE_INTERFACE\n} from \"@open-pioneer/runtime\";\nimport Keycloak, { KeycloakLogoutOptions } from \"keycloak-js\";\nimport { KeycloakAuthPlugin } from \"./api\";\nimport { getKeycloakConfig, ResolvedKeycloakOptions } from \"./getKeycloakConfig\";\n\nconst LOG = createLogger(\"authentication-keycloak:KeycloakAuthPlugin\");\n\ninterface References {\n notifier: NotificationService;\n}\n\nexport class KeycloakAuthPluginImpl implements Service, KeycloakAuthPlugin {\n declare [DECLARE_SERVICE_INTERFACE]: \"authentication-keycloak.KeycloakAuthPlugin\";\n\n #notifier: NotificationService;\n #intl: PackageIntl;\n #keycloakOptions: ResolvedKeycloakOptions;\n #keycloak: Keycloak;\n\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n #timerId: any;\n #watcher: Resource | undefined;\n\n #state = reactive<AuthState>({\n kind: \"pending\"\n });\n\n constructor(options: ServiceOptions<References>) {\n this.#notifier = options.references.notifier;\n this.#intl = options.intl;\n\n try {\n this.#keycloakOptions = getKeycloakConfig(options.properties);\n } catch (e) {\n throw new Error(\"Invalid keycloak configuration\", { cause: e });\n }\n\n try {\n this.#keycloak = new Keycloak(this.#keycloakOptions.config);\n } catch (e) {\n throw new Error(\"Failed to construct keycloak instance\", { cause: e });\n }\n this.#init().catch((e) => {\n this.#updateState({\n kind: \"error\",\n error: e\n });\n this.#notifier.notify({\n level: \"error\",\n title: this.#intl.formatMessage({\n id: \"loginFailed.title\"\n }),\n message: this.#intl.formatMessage({\n id: \"loginFailed.message\"\n })\n });\n\n LOG.error(\"Failed to check if user is authenticated\", e);\n });\n }\n\n destroy() {\n clearInterval(this.#timerId);\n this.#watcher = destroyResource(this.#watcher);\n this.#timerId = undefined;\n }\n\n getAuthState(): AuthState {\n return this.#state.value;\n }\n\n getLoginBehavior(): LoginBehavior {\n const doLogin = () => {\n const options = this.#keycloakOptions.loginOptions;\n LOG.debug(\"Login with options\", options);\n this.#keycloak.login(options);\n };\n return {\n kind: \"effect\",\n login: doLogin\n };\n }\n\n logout(options?: Partial<KeycloakLogoutOptions>) {\n const logoutOptions = {\n ...this.#keycloakOptions.logoutOptions,\n ...options\n };\n LOG.debug(\"Logout with options\", logoutOptions);\n this.#keycloak.logout(logoutOptions);\n }\n\n async #init() {\n const { initOptions, refreshOptions } = this.#keycloakOptions;\n\n let isAuthenticated: boolean;\n try {\n LOG.debug(\"Init with options\", initOptions);\n isAuthenticated = await this.#keycloak.init(initOptions);\n } catch (e) {\n // Note: keycloak.init() can also throw an exception, in addition to a rejected promise.\n // It may also just throw a string..\n const error = typeof e === \"string\" ? new Error(e) : e;\n throw new Error(\"Failed to initialize keycloak session\", { cause: error });\n }\n\n if (isAuthenticated) {\n this.#updateState({\n kind: \"authenticated\",\n sessionInfo: {\n userId: this.#keycloak.subject ? this.#keycloak.subject : \"undefined\",\n userName: this.#keycloak.idTokenParsed?.preferred_username,\n attributes: {\n keycloak: this.#keycloak,\n familyName: this.#keycloak.idTokenParsed?.family_name,\n givenName: this.#keycloak.idTokenParsed?.given_name,\n userName: this.#keycloak.idTokenParsed?.preferred_username\n }\n }\n });\n\n LOG.debug(`User ${this.#keycloak.subject} is authenticated`);\n\n if (refreshOptions.autoRefresh) {\n LOG.debug(\"Starting auto-refresh\", refreshOptions);\n this.__refresh(refreshOptions.interval, refreshOptions.timeLeft);\n }\n } else {\n this.#updateState({\n kind: \"not-authenticated\"\n });\n LOG.debug(\"User is not authenticated\");\n }\n }\n\n // Mocked in test\n private __refresh(interval: number, timeLeft: number) {\n clearInterval(this.#timerId);\n this.#timerId = setInterval(() => {\n LOG.debug(\"Checking token validity\");\n this.#keycloak\n .updateToken(timeLeft)\n .then((refreshed) => {\n if (refreshed) {\n LOG.debug(\"Token refreshed successfully\");\n } else {\n LOG.debug(\"Token is still valid\");\n }\n })\n .catch((e) => {\n LOG.error(\"Failed to refresh token\", e);\n this.#updateState({\n kind: \"not-authenticated\"\n });\n this.destroy();\n });\n }, interval);\n }\n\n #updateState(newState: AuthState) {\n this.#state.value = newState;\n }\n}\n"],"names":[],"mappings":";;;;;AAgBA,MAAM,GAAA,GAAM,aAAa,4CAA4C,CAAA;AAM9D,MAAM,sBAAA,CAA8D;AAAA,EAGvE,SAAA;AAAA,EACA,KAAA;AAAA,EACA,gBAAA;AAAA,EACA,SAAA;AAAA;AAAA,EAGA,QAAA;AAAA,EACA,QAAA;AAAA,EAEA,SAAS,QAAA,CAAoB;AAAA,IACzB,IAAA,EAAM;AAAA,GACT,CAAA;AAAA,EAED,YAAY,OAAA,EAAqC;AAC7C,IAAA,IAAA,CAAK,SAAA,GAAY,QAAQ,UAAA,CAAW,QAAA;AACpC,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,IAAA;AAErB,IAAA,IAAI;AACA,MAAA,IAAA,CAAK,gBAAA,GAAmB,iBAAA,CAAkB,OAAA,CAAQ,UAAU,CAAA;AAAA,IAChE,SAAS,CAAA,EAAG;AACR,MAAA,MAAM,IAAI,KAAA,CAAM,gCAAA,EAAkC,EAAE,KAAA,EAAO,GAAG,CAAA;AAAA,IAClE;AAEA,IAAA,IAAI;AACA,MAAA,IAAA,CAAK,SAAA,GAAY,IAAI,QAAA,CAAS,IAAA,CAAK,iBAAiB,MAAM,CAAA;AAAA,IAC9D,SAAS,CAAA,EAAG;AACR,MAAA,MAAM,IAAI,KAAA,CAAM,uCAAA,EAAyC,EAAE,KAAA,EAAO,GAAG,CAAA;AAAA,IACzE;AACA,IAAA,IAAA,CAAK,KAAA,EAAM,CAAE,KAAA,CAAM,CAAC,CAAA,KAAM;AACtB,MAAA,IAAA,CAAK,YAAA,CAAa;AAAA,QACd,IAAA,EAAM,OAAA;AAAA,QACN,KAAA,EAAO;AAAA,OACV,CAAA;AACD,MAAA,IAAA,CAAK,UAAU,MAAA,CAAO;AAAA,QAClB,KAAA,EAAO,OAAA;AAAA,QACP,KAAA,EAAO,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc;AAAA,UAC5B,EAAA,EAAI;AAAA,SACP,CAAA;AAAA,QACD,OAAA,EAAS,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc;AAAA,UAC9B,EAAA,EAAI;AAAA,SACP;AAAA,OACJ,CAAA;AAED,MAAA,GAAA,CAAI,KAAA,CAAM,4CAA4C,CAAC,CAAA;AAAA,IAC3D,CAAC,CAAA;AAAA,EACL;AAAA,EAEA,OAAA,GAAU;AACN,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA;AAC3B,IAAA,IAAA,CAAK,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,QAAQ,CAAA;AAC7C,IAAA,IAAA,CAAK,QAAA,GAAW,MAAA;AAAA,EACpB;AAAA,EAEA,YAAA,GAA0B;AACtB,IAAA,OAAO,KAAK,MAAA,CAAO,KAAA;AAAA,EACvB;AAAA,EAEA,gBAAA,GAAkC;AAC9B,IAAA,MAAM,UAAU,MAAM;AAClB,MAAA,MAAM,OAAA,GAAU,KAAK,gBAAA,CAAiB,YAAA;AACtC,MAAA,GAAA,CAAI,KAAA,CAAM,sBAAsB,OAAO,CAAA;AACvC,MAAA,IAAA,CAAK,SAAA,CAAU,MAAM,OAAO,CAAA;AAAA,IAChC,CAAA;AACA,IAAA,OAAO;AAAA,MACH,IAAA,EAAM,QAAA;AAAA,MACN,KAAA,EAAO;AAAA,KACX;AAAA,EACJ;AAAA,EAEA,OAAO,OAAA,EAA0C;AAC7C,IAAA,MAAM,aAAA,GAAgB;AAAA,MAClB,GAAG,KAAK,gBAAA,CAAiB,aAAA;AAAA,MACzB,GAAG;AAAA,KACP;AACA,IAAA,GAAA,CAAI,KAAA,CAAM,uBAAuB,aAAa,CAAA;AAC9C,IAAA,IAAA,CAAK,SAAA,CAAU,OAAO,aAAa,CAAA;AAAA,EACvC;AAAA,EAEA,MAAM,KAAA,GAAQ;AACV,IAAA,MAAM,EAAE,WAAA,EAAa,cAAA,EAAe,GAAI,IAAA,CAAK,gBAAA;AAE7C,IAAA,IAAI,eAAA;AACJ,IAAA,IAAI;AACA,MAAA,GAAA,CAAI,KAAA,CAAM,qBAAqB,WAAW,CAAA;AAC1C,MAAA,eAAA,GAAkB,MAAM,IAAA,CAAK,SAAA,CAAU,IAAA,CAAK,WAAW,CAAA;AAAA,IAC3D,SAAS,CAAA,EAAG;AAGR,MAAA,MAAM,QAAQ,OAAO,CAAA,KAAM,WAAW,IAAI,KAAA,CAAM,CAAC,CAAA,GAAI,CAAA;AACrD,MAAA,MAAM,IAAI,KAAA,CAAM,uCAAA,EAAyC,EAAE,KAAA,EAAO,OAAO,CAAA;AAAA,IAC7E;AAEA,IAAA,IAAI,eAAA,EAAiB;AACjB,MAAA,IAAA,CAAK,YAAA,CAAa;AAAA,QACd,IAAA,EAAM,eAAA;AAAA,QACN,WAAA,EAAa;AAAA,UACT,QAAQ,IAAA,CAAK,SAAA,CAAU,OAAA,GAAU,IAAA,CAAK,UAAU,OAAA,GAAU,WAAA;AAAA,UAC1D,QAAA,EAAU,IAAA,CAAK,SAAA,CAAU,aAAA,EAAe,kBAAA;AAAA,UACxC,UAAA,EAAY;AAAA,YACR,UAAU,IAAA,CAAK,SAAA;AAAA,YACf,UAAA,EAAY,IAAA,CAAK,SAAA,CAAU,aAAA,EAAe,WAAA;AAAA,YAC1C,SAAA,EAAW,IAAA,CAAK,SAAA,CAAU,aAAA,EAAe,UAAA;AAAA,YACzC,QAAA,EAAU,IAAA,CAAK,SAAA,CAAU,aAAA,EAAe;AAAA;AAC5C;AACJ,OACH,CAAA;AAED,MAAA,GAAA,CAAI,KAAA,CAAM,CAAA,KAAA,EAAQ,IAAA,CAAK,SAAA,CAAU,OAAO,CAAA,iBAAA,CAAmB,CAAA;AAE3D,MAAA,IAAI,eAAe,WAAA,EAAa;AAC5B,QAAA,GAAA,CAAI,KAAA,CAAM,yBAAyB,cAAc,CAAA;AACjD,QAAA,IAAA,CAAK,SAAA,CAAU,cAAA,CAAe,QAAA,EAAU,cAAA,CAAe,QAAQ,CAAA;AAAA,MACnE;AAAA,IACJ,CAAA,MAAO;AACH,MAAA,IAAA,CAAK,YAAA,CAAa;AAAA,QACd,IAAA,EAAM;AAAA,OACT,CAAA;AACD,MAAA,GAAA,CAAI,MAAM,2BAA2B,CAAA;AAAA,IACzC;AAAA,EACJ;AAAA;AAAA,EAGQ,SAAA,CAAU,UAAkB,QAAA,EAAkB;AAClD,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA;AAC3B,IAAA,IAAA,CAAK,QAAA,GAAW,YAAY,MAAM;AAC9B,MAAA,GAAA,CAAI,MAAM,yBAAyB,CAAA;AACnC,MAAA,IAAA,CAAK,UACA,WAAA,CAAY,QAAQ,CAAA,CACpB,IAAA,CAAK,CAAC,SAAA,KAAc;AACjB,QAAA,IAAI,SAAA,EAAW;AACX,UAAA,GAAA,CAAI,MAAM,8BAA8B,CAAA;AAAA,QAC5C,CAAA,MAAO;AACH,UAAA,GAAA,CAAI,MAAM,sBAAsB,CAAA;AAAA,QACpC;AAAA,MACJ,CAAC,CAAA,CACA,KAAA,CAAM,CAAC,CAAA,KAAM;AACV,QAAA,GAAA,CAAI,KAAA,CAAM,2BAA2B,CAAC,CAAA;AACtC,QAAA,IAAA,CAAK,YAAA,CAAa;AAAA,UACd,IAAA,EAAM;AAAA,SACT,CAAA;AACD,QAAA,IAAA,CAAK,OAAA,EAAQ;AAAA,MACjB,CAAC,CAAA;AAAA,IACT,GAAG,QAAQ,CAAA;AAAA,EACf;AAAA,EAEA,aAAa,QAAA,EAAqB;AAC9B,IAAA,IAAA,CAAK,OAAO,KAAA,GAAQ,QAAA;AAAA,EACxB;AACJ;;;;"}
package/README.md CHANGED
@@ -46,13 +46,20 @@ export function AppUI() {
46
46
  To configure the `authentication-keycloak` package, adjust these properties.
47
47
  For more details on the configuration properties, visit the [API Reference](https://www.keycloak.org/docs/latest/securing_apps/index.html#api-reference).
48
48
 
49
- | Property | Type | Description | Default |
50
- | ------------------- | :-----------------: | --------------------------------------------------------------------------------------------------------------------: | --------------------------------------------------: |
51
- | refreshOptions | RefreshOptions | Configure token refresh behavior and manage access token lifecycle in client applications. | `{autoRefresh: true, interval: 6000, timeLeft: 70}` |
52
- | keycloakInitOptions | KeycloakInitOptions | Configure Keycloak's behavior during client application initialization. | `{onLoad: "check-sso", pkceMethod: "S256"}` |
53
- | keycloakConfig | KeycloakConfig | The configuration settings required to establish a connection between the client application and the Keycloak server. | |
49
+ | Property | Type | Description | Default |
50
+ | --------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------: | ---------------------------------------------------: |
51
+ | keycloakConfig | KeycloakConfig | The configuration settings required to establish a connection between the client application and the Keycloak server. | |
52
+ | refreshOptions | RefreshOptions | Configure token refresh behavior and manage access token lifecycle in client applications. | `{autoRefresh: true, interval: 10000, timeLeft: 60}` |
53
+ | keycloakInitOptions | KeycloakInitOptions | Configure Keycloak's behavior during client application initialization. | `{onLoad: "check-sso", pkceMethod: "S256"}` |
54
+ | keycloakLoginOptions | KeycloakLoginOptions | Configure Keycloak login options (e.g. redirect URI). | |
55
+ | keycloakLogoutOptions | KeycloakLogoutOptions | Configure Keycloak logout options (e.g. redirect URI). | |
54
56
 
55
57
  ```ts
58
+ interface KeycloakConfig {
59
+ url: string;
60
+ realm: string;
61
+ clientId: string;
62
+ }
56
63
  interface RefreshOptions {
57
64
  autoRefresh: boolean;
58
65
  interval: number;
@@ -63,11 +70,6 @@ interface KeycloakInitOptions {
63
70
  pkceMethod: string;
64
71
  scope: string;
65
72
  }
66
- interface KeycloakConfig {
67
- url: string;
68
- realm: string;
69
- clientId: string;
70
- }
71
73
  ```
72
74
 
73
75
  ### Using the configuration in an app
@@ -86,21 +88,31 @@ const element = createCustomElement({
86
88
  properties: {
87
89
  "@open-pioneer/authentication-keycloak": {
88
90
  keycloakOptions: {
91
+ keycloakConfig: {
92
+ url: "http://keycloak-server/base_path",
93
+ realm: "myrealm",
94
+ clientId: "myapp"
95
+ },
96
+ // optional
89
97
  refreshOptions: {
90
98
  autoRefresh: true,
91
- interval: 6000,
92
- timeLeft: 70
99
+ interval: 10000,
100
+ timeLeft: 60
93
101
  },
102
+ // optional
94
103
  keycloakInitOptions: {
95
104
  onLoad: "check-sso",
96
105
  pkceMethod: "S256"
97
106
  // additional configuration, for example:
98
107
  // scope: "openid address phone"
99
108
  },
100
- keycloakConfig: {
101
- url: "http://keycloak-server/base_path",
102
- realm: "myrealm",
103
- clientId: "myapp"
109
+ // optional
110
+ keycloakLoginOptions: {
111
+ // ...
112
+ },
113
+ // optional
114
+ keycloakLogoutOptions: {
115
+ redirectUri: "https://example.com" // where to redirect after logout
104
116
  }
105
117
  }
106
118
  } satisfies KeycloakProperties // for auto completion / validation
package/api.d.ts CHANGED
@@ -1,4 +1,6 @@
1
- import type { KeycloakConfig, KeycloakInitOptions } from "keycloak-js";
1
+ import { AuthPlugin } from "@open-pioneer/authentication";
2
+ import { DECLARE_SERVICE_INTERFACE } from "@open-pioneer/runtime";
3
+ import type { KeycloakConfig, KeycloakInitOptions, KeycloakLoginOptions, KeycloakLogoutOptions } from "keycloak-js";
2
4
  /**
3
5
  * The central configuration properties of the plugin.
4
6
  *
@@ -13,27 +15,37 @@ export interface KeycloakProperties {
13
15
  export interface KeycloakOptions {
14
16
  /**
15
17
  * The configuration details for connecting to Keycloak.
16
- * 'url': The URL of your Keycloak server.
17
- * 'realm': The realm within Keycloak.
18
- * 'clientId': The ID of the client application registered in Keycloak.
18
+ *
19
+ * - 'url': The URL of your Keycloak server.
20
+ * - 'realm': The realm within Keycloak.
21
+ * - 'clientId': The ID of the client application registered in Keycloak.
19
22
  */
20
23
  keycloakConfig: KeycloakConfig;
21
24
  /**
22
25
  * Control the automatic refreshing of authentication tokens.
23
- * 'autoRefresh': Whether token refreshing should happen automatically.
24
- * 'interval': The interval (in milliseconds) at which token refreshing should occur.
25
- * 'timeLeft': The remaining time (in milliseconds) before token expiration.
26
+ *
27
+ * - 'autoRefresh': Whether token refreshing should happen automatically.
28
+ * - 'interval': The interval (in milliseconds) at which token refreshing should occur.
29
+ * - 'timeLeft': The remaining time (in milliseconds) before token expiration.
26
30
  */
27
- refreshOptions: RefreshOptions;
31
+ refreshOptions?: RefreshOptions;
28
32
  /**
29
33
  * Define how Keycloak initializes.
30
- * This properties can be used:
31
- * 'onLoad': Specifies when Keycloak should initialize.
32
- * 'pkceMethod': The method used for PKCE for enhanced security.
33
- * 'scope': The scope of the authentication.
34
34
  *
35
+ * These properties can be used:
36
+ * - 'onLoad': Specifies when Keycloak should initialize. Default: `check-sso`.
37
+ * - 'pkceMethod': The method used for PKCE for enhanced security. Default: `S256`.
38
+ * - 'scope': The scope of the authentication.
39
+ */
40
+ keycloakInitOptions?: Partial<KeycloakInitOptions>;
41
+ /**
42
+ * Define behavior when the user logs in.
35
43
  */
36
- keycloakInitOptions: Partial<KeycloakInitOptions>;
44
+ keycloakLoginOptions?: Partial<KeycloakLoginOptions>;
45
+ /**
46
+ * Define behavior when the user logs out.
47
+ */
48
+ keycloakLogoutOptions?: Partial<KeycloakLogoutOptions>;
37
49
  }
38
50
  /**
39
51
  * Control the automatic refreshing of authentication tokens.
@@ -41,14 +53,34 @@ export interface KeycloakOptions {
41
53
  export interface RefreshOptions {
42
54
  /**
43
55
  * Whether token refreshing should happen automatically.
56
+ *
57
+ * Default: true.
44
58
  */
45
- autoRefresh: boolean;
59
+ autoRefresh?: boolean;
46
60
  /**
47
- * The interval (in milliseconds) at which token refreshing should occur.
61
+ * The interval (in milliseconds) at which tokens are checked for validity.
62
+ * If the token's remaining lifetime is too short (see {@link timeLeft}), then the token is refreshed.
63
+ *
64
+ * Default: 10000 milliseconds.
48
65
  */
49
- interval: number;
66
+ interval?: number;
50
67
  /**
51
- * The remaining time (in milliseconds) before token expiration.
68
+ * The minimum required lifetime during token validity checks.
69
+ * Tokens that expire within `timeLeft` are refreshed.
70
+ *
71
+ * Default: 60 seconds.
72
+ */
73
+ timeLeft?: number;
74
+ }
75
+ /**
76
+ * The interface implemented by the Keycloak authentication plugin.
77
+ */
78
+ export interface KeycloakAuthPlugin extends AuthPlugin {
79
+ readonly [DECLARE_SERVICE_INTERFACE]?: "authentication-keycloak.KeycloakAuthPlugin";
80
+ /**
81
+ * Explicitly triggers a logout.
82
+ *
83
+ * `options` used here can override the package properties used by the plugin.
52
84
  */
53
- timeLeft: number;
85
+ logout(options?: Partial<KeycloakLogoutOptions>): void;
54
86
  }
@@ -0,0 +1,14 @@
1
+ import type { KeycloakConfig, KeycloakInitOptions, KeycloakLoginOptions, KeycloakLogoutOptions } from "keycloak-js";
2
+ import type { KeycloakProperties, RefreshOptions } from "./api";
3
+ export type ResolvedRefreshOptions = Required<RefreshOptions>;
4
+ export interface ResolvedKeycloakOptions {
5
+ config: KeycloakConfig;
6
+ initOptions: KeycloakInitOptions;
7
+ refreshOptions: ResolvedRefreshOptions;
8
+ loginOptions: Partial<KeycloakLoginOptions>;
9
+ logoutOptions: Partial<KeycloakLogoutOptions>;
10
+ }
11
+ /**
12
+ * Parses the user supplied package properties.
13
+ */
14
+ export declare function getKeycloakConfig(properties: Partial<KeycloakProperties>): ResolvedKeycloakOptions;
@@ -0,0 +1,75 @@
1
+ import { createLogger } from '@open-pioneer/core';
2
+
3
+ const LOG = createLogger("authentication-keycloak:getKeycloakConfig");
4
+ const DEFAULT_REFRESH_OPTS = {
5
+ autoRefresh: true,
6
+ interval: 1e4,
7
+ timeLeft: 60
8
+ };
9
+ const DEFAULT_INIT_OPTS = {
10
+ onLoad: "check-sso",
11
+ pkceMethod: "S256"
12
+ };
13
+ function getKeycloakConfig(properties) {
14
+ const { keycloakOptions } = properties;
15
+ const {
16
+ refreshOptions,
17
+ keycloakInitOptions,
18
+ keycloakConfig,
19
+ keycloakLoginOptions,
20
+ keycloakLogoutOptions
21
+ } = keycloakOptions;
22
+ return {
23
+ config: getConfig(keycloakConfig),
24
+ refreshOptions: getRefreshOptions(refreshOptions),
25
+ initOptions: getInitOptions(keycloakInitOptions),
26
+ loginOptions: getLoginOptions(keycloakLoginOptions),
27
+ logoutOptions: getLogoutOptions(keycloakLogoutOptions)
28
+ };
29
+ }
30
+ function getConfig(keycloakConfig) {
31
+ if (!keycloakConfig || isObjectEmpty(keycloakConfig)) {
32
+ throw new Error(
33
+ `KeycloakConfig not found: The Keycloak configuration options are required by the plugin to perform login and logout operations`
34
+ );
35
+ }
36
+ return { ...keycloakConfig };
37
+ }
38
+ function getRefreshOptions(refreshOptions) {
39
+ if (!refreshOptions || isObjectEmpty(refreshOptions)) {
40
+ LOG.info(`Using default options for keycloak token refresh`, DEFAULT_REFRESH_OPTS);
41
+ }
42
+ return {
43
+ ...DEFAULT_REFRESH_OPTS,
44
+ ...refreshOptions
45
+ };
46
+ }
47
+ function getInitOptions(keycloakInitOptions) {
48
+ if (!keycloakInitOptions || isObjectEmpty(keycloakInitOptions)) {
49
+ LOG.info(`Using default options for keycloak init`, DEFAULT_INIT_OPTS);
50
+ }
51
+ return {
52
+ ...DEFAULT_INIT_OPTS,
53
+ ...keycloakInitOptions
54
+ };
55
+ }
56
+ function getLoginOptions(keycloakLoginOptions) {
57
+ return {
58
+ redirectUri: void 0,
59
+ // backwards-compat; unsure if needed
60
+ ...keycloakLoginOptions
61
+ };
62
+ }
63
+ function getLogoutOptions(keycloakLogoutOptions) {
64
+ return {
65
+ redirectUri: void 0,
66
+ // backwards-compat; unsure if needed
67
+ ...keycloakLogoutOptions
68
+ };
69
+ }
70
+ const isObjectEmpty = (objectName) => {
71
+ return objectName && Object.keys(objectName).length === 0 && objectName.constructor === Object;
72
+ };
73
+
74
+ export { getKeycloakConfig };
75
+ //# sourceMappingURL=getKeycloakConfig.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getKeycloakConfig.js","sources":["getKeycloakConfig.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type {\n KeycloakConfig,\n KeycloakInitOptions,\n KeycloakLoginOptions,\n KeycloakLogoutOptions\n} from \"keycloak-js\";\nimport type { KeycloakProperties, RefreshOptions } from \"./api\";\nimport { createLogger } from \"@open-pioneer/core\";\nconst LOG = createLogger(\"authentication-keycloak:getKeycloakConfig\");\n\nconst DEFAULT_REFRESH_OPTS = {\n autoRefresh: true,\n interval: 10000,\n timeLeft: 60\n} as const;\n\nconst DEFAULT_INIT_OPTS = {\n onLoad: \"check-sso\",\n pkceMethod: \"S256\"\n} as const;\n\nexport type ResolvedRefreshOptions = Required<RefreshOptions>;\n\nexport interface ResolvedKeycloakOptions {\n config: KeycloakConfig;\n initOptions: KeycloakInitOptions;\n refreshOptions: ResolvedRefreshOptions;\n loginOptions: Partial<KeycloakLoginOptions>;\n logoutOptions: Partial<KeycloakLogoutOptions>;\n}\n\n/**\n * Parses the user supplied package properties.\n */\nexport function getKeycloakConfig(\n properties: Partial<KeycloakProperties>\n): ResolvedKeycloakOptions {\n const { keycloakOptions } = properties;\n const {\n refreshOptions,\n keycloakInitOptions,\n keycloakConfig,\n keycloakLoginOptions,\n keycloakLogoutOptions\n } = keycloakOptions!;\n return {\n config: getConfig(keycloakConfig),\n refreshOptions: getRefreshOptions(refreshOptions),\n initOptions: getInitOptions(keycloakInitOptions),\n loginOptions: getLoginOptions(keycloakLoginOptions),\n logoutOptions: getLogoutOptions(keycloakLogoutOptions)\n };\n}\n\nfunction getConfig(keycloakConfig: KeycloakConfig | undefined): KeycloakConfig {\n if (!keycloakConfig || isObjectEmpty(keycloakConfig)) {\n throw new Error(\n `KeycloakConfig not found: The Keycloak configuration options are required by the plugin to perform login and logout operations`\n );\n }\n return { ...keycloakConfig };\n}\n\nfunction getRefreshOptions(refreshOptions: RefreshOptions | undefined): ResolvedRefreshOptions {\n if (!refreshOptions || isObjectEmpty(refreshOptions)) {\n LOG.info(`Using default options for keycloak token refresh`, DEFAULT_REFRESH_OPTS);\n }\n return {\n ...DEFAULT_REFRESH_OPTS,\n ...refreshOptions\n };\n}\n\nfunction getInitOptions(keycloakInitOptions: KeycloakInitOptions | undefined): KeycloakInitOptions {\n if (!keycloakInitOptions || isObjectEmpty(keycloakInitOptions)) {\n LOG.info(`Using default options for keycloak init`, DEFAULT_INIT_OPTS);\n }\n return {\n ...DEFAULT_INIT_OPTS,\n ...keycloakInitOptions\n };\n}\n\nfunction getLoginOptions(\n keycloakLoginOptions: Partial<KeycloakLoginOptions> | undefined\n): Partial<KeycloakLoginOptions> {\n return {\n redirectUri: undefined, // backwards-compat; unsure if needed\n ...keycloakLoginOptions\n };\n}\n\nfunction getLogoutOptions(\n keycloakLogoutOptions: Partial<KeycloakLogoutOptions> | undefined\n): Partial<KeycloakLogoutOptions> {\n return {\n redirectUri: undefined, // backwards-compat; unsure if needed\n ...keycloakLogoutOptions\n };\n}\n\nconst isObjectEmpty = (objectName: unknown) => {\n return objectName && Object.keys(objectName).length === 0 && objectName.constructor === Object;\n};\n"],"names":[],"mappings":";;AAUA,MAAM,GAAA,GAAM,aAAa,2CAA2C,CAAA;AAEpE,MAAM,oBAAA,GAAuB;AAAA,EACzB,WAAA,EAAa,IAAA;AAAA,EACb,QAAA,EAAU,GAAA;AAAA,EACV,QAAA,EAAU;AACd,CAAA;AAEA,MAAM,iBAAA,GAAoB;AAAA,EACtB,MAAA,EAAQ,WAAA;AAAA,EACR,UAAA,EAAY;AAChB,CAAA;AAeO,SAAS,kBACZ,UAAA,EACuB;AACvB,EAAA,MAAM,EAAE,iBAAgB,GAAI,UAAA;AAC5B,EAAA,MAAM;AAAA,IACF,cAAA;AAAA,IACA,mBAAA;AAAA,IACA,cAAA;AAAA,IACA,oBAAA;AAAA,IACA;AAAA,GACJ,GAAI,eAAA;AACJ,EAAA,OAAO;AAAA,IACH,MAAA,EAAQ,UAAU,cAAc,CAAA;AAAA,IAChC,cAAA,EAAgB,kBAAkB,cAAc,CAAA;AAAA,IAChD,WAAA,EAAa,eAAe,mBAAmB,CAAA;AAAA,IAC/C,YAAA,EAAc,gBAAgB,oBAAoB,CAAA;AAAA,IAClD,aAAA,EAAe,iBAAiB,qBAAqB;AAAA,GACzD;AACJ;AAEA,SAAS,UAAU,cAAA,EAA4D;AAC3E,EAAA,IAAI,CAAC,cAAA,IAAkB,aAAA,CAAc,cAAc,CAAA,EAAG;AAClD,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,8HAAA;AAAA,KACJ;AAAA,EACJ;AACA,EAAA,OAAO,EAAE,GAAG,cAAA,EAAe;AAC/B;AAEA,SAAS,kBAAkB,cAAA,EAAoE;AAC3F,EAAA,IAAI,CAAC,cAAA,IAAkB,aAAA,CAAc,cAAc,CAAA,EAAG;AAClD,IAAA,GAAA,CAAI,IAAA,CAAK,oDAAoD,oBAAoB,CAAA;AAAA,EACrF;AACA,EAAA,OAAO;AAAA,IACH,GAAG,oBAAA;AAAA,IACH,GAAG;AAAA,GACP;AACJ;AAEA,SAAS,eAAe,mBAAA,EAA2E;AAC/F,EAAA,IAAI,CAAC,mBAAA,IAAuB,aAAA,CAAc,mBAAmB,CAAA,EAAG;AAC5D,IAAA,GAAA,CAAI,IAAA,CAAK,2CAA2C,iBAAiB,CAAA;AAAA,EACzE;AACA,EAAA,OAAO;AAAA,IACH,GAAG,iBAAA;AAAA,IACH,GAAG;AAAA,GACP;AACJ;AAEA,SAAS,gBACL,oBAAA,EAC6B;AAC7B,EAAA,OAAO;AAAA,IACH,WAAA,EAAa,MAAA;AAAA;AAAA,IACb,GAAG;AAAA,GACP;AACJ;AAEA,SAAS,iBACL,qBAAA,EAC8B;AAC9B,EAAA,OAAO;AAAA,IACH,WAAA,EAAa,MAAA;AAAA;AAAA,IACb,GAAG;AAAA,GACP;AACJ;AAEA,MAAM,aAAA,GAAgB,CAAC,UAAA,KAAwB;AAC3C,EAAA,OAAO,UAAA,IAAc,OAAO,IAAA,CAAK,UAAU,EAAE,MAAA,KAAW,CAAA,IAAK,WAAW,WAAA,KAAgB,MAAA;AAC5F,CAAA;;;;"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@open-pioneer/authentication-keycloak",
4
- "version": "4.0.0",
4
+ "version": "4.1.0-dev.20250818125237",
5
5
  "description": "Implements authentication against Keycloak servers.",
6
6
  "keywords": [
7
7
  "open-pioneer-trails"
@@ -16,10 +16,10 @@
16
16
  "dependencies": {
17
17
  "@conterra/reactivity-core": "^0.7.0",
18
18
  "keycloak-js": "^26.2.0",
19
- "@open-pioneer/authentication": "^4.0.0",
20
- "@open-pioneer/runtime": "^4.0.0",
21
- "@open-pioneer/core": "^4.0.0",
22
- "@open-pioneer/notifier": "^4.0.0"
19
+ "@open-pioneer/authentication": "4.1.0-dev.20250818125237",
20
+ "@open-pioneer/runtime": "4.1.0-dev.20250818125237",
21
+ "@open-pioneer/notifier": "4.1.0-dev.20250818125237",
22
+ "@open-pioneer/core": "4.1.0-dev.20250818125237"
23
23
  },
24
24
  "exports": {
25
25
  "./package.json": "./package.json",
package/services.d.ts CHANGED
@@ -1 +1 @@
1
- export { KeycloakAuthPlugin } from "./KeycloakAuthPlugin";
1
+ export { KeycloakAuthPluginImpl as KeycloakAuthPlugin } from "./KeycloakAuthPluginImpl";
package/services.js CHANGED
@@ -1,2 +1,2 @@
1
- export { KeycloakAuthPlugin } from './KeycloakAuthPlugin.js';
1
+ export { KeycloakAuthPluginImpl as KeycloakAuthPlugin } from './KeycloakAuthPluginImpl.js';
2
2
  //# sourceMappingURL=services.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"KeycloakAuthPlugin.js","sources":["KeycloakAuthPlugin.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023-2025 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { reactive } from \"@conterra/reactivity-core\";\nimport { AuthPlugin, AuthState, LoginBehavior } from \"@open-pioneer/authentication\";\nimport { Resource, createLogger, destroyResource } from \"@open-pioneer/core\";\nimport { NotificationService } from \"@open-pioneer/notifier\";\nimport {\n PackageIntl,\n Service,\n ServiceOptions,\n type DECLARE_SERVICE_INTERFACE\n} from \"@open-pioneer/runtime\";\nimport Keycloak, {\n type KeycloakConfig,\n type KeycloakInitOptions,\n type KeycloakLoginOptions,\n type KeycloakLogoutOptions\n} from \"keycloak-js\";\nimport { KeycloakOptions, KeycloakProperties, RefreshOptions } from \"./api\";\n\nconst LOG = createLogger(\"authentication-keycloak:KeycloakAuthPlugin\");\n\ninterface References {\n notifier: NotificationService;\n}\n\nexport class KeycloakAuthPlugin implements Service, AuthPlugin {\n declare [DECLARE_SERVICE_INTERFACE]: \"authentication-keycloak.KeycloakAuthPlugin\";\n\n #notifier: NotificationService;\n #intl: PackageIntl;\n #keycloakOptions: KeycloakOptions;\n #keycloak: Keycloak;\n #logoutOptions: KeycloakLogoutOptions;\n #loginOptions: KeycloakLoginOptions;\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n #timerId: any;\n #watcher: Resource | undefined;\n\n #state = reactive<AuthState>({\n kind: \"pending\"\n });\n\n constructor(options: ServiceOptions<References>) {\n this.#notifier = options.references.notifier;\n this.#intl = options.intl;\n this.#logoutOptions = { redirectUri: undefined };\n this.#loginOptions = { redirectUri: undefined };\n\n try {\n this.#keycloakOptions = getKeycloakConfig(options.properties);\n } catch (e) {\n throw new Error(\"Invalid keycloak configuration\", { cause: e });\n }\n\n try {\n this.#keycloak = new Keycloak(this.#keycloakOptions.keycloakConfig);\n } catch (e) {\n throw new Error(\"Failed to construct keycloak instance\", { cause: e });\n }\n this.#init().catch((e) => {\n this.#updateState({\n kind: \"error\",\n error: e\n });\n this.#notifier.notify({\n level: \"error\",\n title: this.#intl.formatMessage({\n id: \"loginFailed.title\"\n }),\n message: this.#intl.formatMessage({\n id: \"loginFailed.message\"\n })\n });\n\n LOG.error(\"Failed to check if user is authenticated\", e);\n });\n }\n\n destroy() {\n clearInterval(this.#timerId);\n this.#watcher = destroyResource(this.#watcher);\n this.#timerId = undefined;\n }\n\n getAuthState(): AuthState {\n return this.#state.value;\n }\n\n getLoginBehavior(): LoginBehavior {\n const doLogin = () => {\n LOG.debug(\"Login with options\", this.#loginOptions);\n this.#keycloak.login(this.#loginOptions);\n };\n return {\n kind: \"effect\",\n login: doLogin\n };\n }\n\n logout() {\n LOG.debug(\"Logout with options\", this.#logoutOptions);\n this.#keycloak.logout(this.#logoutOptions);\n }\n\n async #init() {\n const keycloakOptions = this.#keycloakOptions;\n const initOptions = this.#keycloakOptions.keycloakInitOptions;\n const refreshOptions = keycloakOptions.refreshOptions;\n\n let isAuthenticated: boolean;\n try {\n isAuthenticated = await this.#keycloak.init(initOptions);\n } catch (e) {\n // Note: keycloak.init() can also throw an exception, in addition to a rejected promise.\n // It may also just throw a string..\n const error = typeof e === \"string\" ? new Error(e) : e;\n throw new Error(\"Failed to initialize keycloak session\", { cause: error });\n }\n\n if (isAuthenticated) {\n this.#updateState({\n kind: \"authenticated\",\n sessionInfo: {\n userId: this.#keycloak.subject ? this.#keycloak.subject : \"undefined\",\n userName: this.#keycloak.idTokenParsed?.preferred_username,\n attributes: {\n keycloak: this.#keycloak,\n familyName: this.#keycloak.idTokenParsed?.family_name,\n givenName: this.#keycloak.idTokenParsed?.given_name,\n userName: this.#keycloak.idTokenParsed?.preferred_username\n }\n }\n });\n\n LOG.debug(`User ${this.#keycloak.subject} is authenticated`);\n\n if (refreshOptions.autoRefresh) {\n LOG.debug(\"Starting auto-refresh\", refreshOptions);\n this.__refresh(refreshOptions.interval, refreshOptions.timeLeft);\n }\n } else {\n this.#updateState({\n kind: \"not-authenticated\"\n });\n LOG.debug(\"User is not authenticated\");\n }\n }\n\n // Mocked in test\n private __refresh(interval: number, timeLeft: number) {\n clearInterval(this.#timerId);\n this.#timerId = setInterval(() => {\n this.#keycloak.updateToken(timeLeft).catch((e) => {\n LOG.error(\"Failed to refresh token\", e);\n this.#updateState({\n kind: \"not-authenticated\"\n });\n this.destroy();\n });\n }, interval);\n }\n\n #updateState(newState: AuthState) {\n this.#state.value = newState;\n }\n}\n\nconst DEFAULT_AUTO_REFRESH_OPT = {\n autoRefresh: true,\n interval: 6000,\n timeLeft: 70\n};\n\nconst DEFAULT_INIT_OPT = {\n onLoad: \"check-sso\",\n pkceMethod: \"S256\"\n};\n\nexport function getKeycloakConfig(properties: Partial<KeycloakProperties>): KeycloakOptions {\n const { keycloakOptions } = properties;\n\n const { refreshOptions, keycloakInitOptions, keycloakConfig } = keycloakOptions!;\n\n return {\n refreshOptions: { ...getRefreshOpt(refreshOptions) },\n keycloakInitOptions: { ...getInitOpt(keycloakInitOptions) },\n keycloakConfig: { ...getConfigOpt(keycloakConfig) }\n };\n}\n\nfunction getRefreshOpt(autoRefreshOptions: RefreshOptions | undefined): RefreshOptions {\n if (!autoRefreshOptions || isObjectEmpty(autoRefreshOptions)) {\n LOG.warn(\n `The autorefresh options of the Keycloak configuration should be set to ensure automatic refreshes at specified intervals.` +\n ` Defaulting to '${DEFAULT_AUTO_REFRESH_OPT}'.`\n );\n return Object.assign({}, { ...DEFAULT_AUTO_REFRESH_OPT });\n }\n return autoRefreshOptions;\n}\n\nfunction getInitOpt(keycloakInitOptions: KeycloakInitOptions | undefined): KeycloakInitOptions {\n if (!keycloakInitOptions || isObjectEmpty(keycloakInitOptions)) {\n LOG.warn(\n `The Keycloak init options of the keycloak configuration should be set.` +\n ` Defaulting to '${DEFAULT_INIT_OPT}'.`\n );\n return Object.assign({}, { ...DEFAULT_INIT_OPT }) as KeycloakInitOptions;\n }\n return keycloakInitOptions;\n}\n\nfunction getConfigOpt(keycloakConfig: KeycloakConfig | undefined): KeycloakConfig {\n if (!keycloakConfig || isObjectEmpty(keycloakConfig)) {\n throw new Error(\n `KeycloakConfig not found: The Keycloak configuration options are required by the plugin to perform login and logout operations`\n );\n }\n return keycloakConfig;\n}\n\nconst isObjectEmpty = (objectName: unknown) => {\n return objectName && Object.keys(objectName).length === 0 && objectName.constructor === Object;\n};\n"],"names":[],"mappings":";;;;AAoBA,MAAM,GAAA,GAAM,aAAa,4CAA4C,CAAA;AAM9D,MAAM,kBAAkD,CAAA;AAAA,EAG3D,SAAA;AAAA,EACA,KAAA;AAAA,EACA,gBAAA;AAAA,EACA,SAAA;AAAA,EACA,cAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,QAAA;AAAA,EACA,QAAA;AAAA,EAEA,SAAS,QAAoB,CAAA;AAAA,IACzB,IAAM,EAAA;AAAA,GACT,CAAA;AAAA,EAED,YAAY,OAAqC,EAAA;AAC7C,IAAK,IAAA,CAAA,SAAA,GAAY,QAAQ,UAAW,CAAA,QAAA;AACpC,IAAA,IAAA,CAAK,QAAQ,OAAQ,CAAA,IAAA;AACrB,IAAK,IAAA,CAAA,cAAA,GAAiB,EAAE,WAAA,EAAa,MAAU,EAAA;AAC/C,IAAK,IAAA,CAAA,aAAA,GAAgB,EAAE,WAAA,EAAa,MAAU,EAAA;AAE9C,IAAI,IAAA;AACA,MAAK,IAAA,CAAA,gBAAA,GAAmB,iBAAkB,CAAA,OAAA,CAAQ,UAAU,CAAA;AAAA,aACvD,CAAG,EAAA;AACR,MAAA,MAAM,IAAI,KAAM,CAAA,gCAAA,EAAkC,EAAE,KAAA,EAAO,GAAG,CAAA;AAAA;AAGlE,IAAI,IAAA;AACA,MAAA,IAAA,CAAK,SAAY,GAAA,IAAI,QAAS,CAAA,IAAA,CAAK,iBAAiB,cAAc,CAAA;AAAA,aAC7D,CAAG,EAAA;AACR,MAAA,MAAM,IAAI,KAAM,CAAA,uCAAA,EAAyC,EAAE,KAAA,EAAO,GAAG,CAAA;AAAA;AAEzE,IAAA,IAAA,CAAK,KAAM,EAAA,CAAE,KAAM,CAAA,CAAC,CAAM,KAAA;AACtB,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,OAAA;AAAA,QACN,KAAO,EAAA;AAAA,OACV,CAAA;AACD,MAAA,IAAA,CAAK,UAAU,MAAO,CAAA;AAAA,QAClB,KAAO,EAAA,OAAA;AAAA,QACP,KAAA,EAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UAC5B,EAAI,EAAA;AAAA,SACP,CAAA;AAAA,QACD,OAAA,EAAS,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,UAC9B,EAAI,EAAA;AAAA,SACP;AAAA,OACJ,CAAA;AAED,MAAI,GAAA,CAAA,KAAA,CAAM,4CAA4C,CAAC,CAAA;AAAA,KAC1D,CAAA;AAAA;AACL,EAEA,OAAU,GAAA;AACN,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA;AAC3B,IAAK,IAAA,CAAA,QAAA,GAAW,eAAgB,CAAA,IAAA,CAAK,QAAQ,CAAA;AAC7C,IAAA,IAAA,CAAK,QAAW,GAAA,MAAA;AAAA;AACpB,EAEA,YAA0B,GAAA;AACtB,IAAA,OAAO,KAAK,MAAO,CAAA,KAAA;AAAA;AACvB,EAEA,gBAAkC,GAAA;AAC9B,IAAA,MAAM,UAAU,MAAM;AAClB,MAAI,GAAA,CAAA,KAAA,CAAM,oBAAsB,EAAA,IAAA,CAAK,aAAa,CAAA;AAClD,MAAK,IAAA,CAAA,SAAA,CAAU,KAAM,CAAA,IAAA,CAAK,aAAa,CAAA;AAAA,KAC3C;AACA,IAAO,OAAA;AAAA,MACH,IAAM,EAAA,QAAA;AAAA,MACN,KAAO,EAAA;AAAA,KACX;AAAA;AACJ,EAEA,MAAS,GAAA;AACL,IAAI,GAAA,CAAA,KAAA,CAAM,qBAAuB,EAAA,IAAA,CAAK,cAAc,CAAA;AACpD,IAAK,IAAA,CAAA,SAAA,CAAU,MAAO,CAAA,IAAA,CAAK,cAAc,CAAA;AAAA;AAC7C,EAEA,MAAM,KAAQ,GAAA;AACV,IAAA,MAAM,kBAAkB,IAAK,CAAA,gBAAA;AAC7B,IAAM,MAAA,WAAA,GAAc,KAAK,gBAAiB,CAAA,mBAAA;AAC1C,IAAA,MAAM,iBAAiB,eAAgB,CAAA,cAAA;AAEvC,IAAI,IAAA,eAAA;AACJ,IAAI,IAAA;AACA,MAAA,eAAA,GAAkB,MAAM,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,WAAW,CAAA;AAAA,aAClD,CAAG,EAAA;AAGR,MAAA,MAAM,QAAQ,OAAO,CAAA,KAAM,WAAW,IAAI,KAAA,CAAM,CAAC,CAAI,GAAA,CAAA;AACrD,MAAA,MAAM,IAAI,KAAM,CAAA,uCAAA,EAAyC,EAAE,KAAA,EAAO,OAAO,CAAA;AAAA;AAG7E,IAAA,IAAI,eAAiB,EAAA;AACjB,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA,eAAA;AAAA,QACN,WAAa,EAAA;AAAA,UACT,QAAQ,IAAK,CAAA,SAAA,CAAU,OAAU,GAAA,IAAA,CAAK,UAAU,OAAU,GAAA,WAAA;AAAA,UAC1D,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,kBAAA;AAAA,UACxC,UAAY,EAAA;AAAA,YACR,UAAU,IAAK,CAAA,SAAA;AAAA,YACf,UAAA,EAAY,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,WAAA;AAAA,YAC1C,SAAA,EAAW,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA,UAAA;AAAA,YACzC,QAAA,EAAU,IAAK,CAAA,SAAA,CAAU,aAAe,EAAA;AAAA;AAC5C;AACJ,OACH,CAAA;AAED,MAAA,GAAA,CAAI,KAAM,CAAA,CAAA,KAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAO,CAAmB,iBAAA,CAAA,CAAA;AAE3D,MAAA,IAAI,eAAe,WAAa,EAAA;AAC5B,QAAI,GAAA,CAAA,KAAA,CAAM,yBAAyB,cAAc,CAAA;AACjD,QAAA,IAAA,CAAK,SAAU,CAAA,cAAA,CAAe,QAAU,EAAA,cAAA,CAAe,QAAQ,CAAA;AAAA;AACnE,KACG,MAAA;AACH,MAAA,IAAA,CAAK,YAAa,CAAA;AAAA,QACd,IAAM,EAAA;AAAA,OACT,CAAA;AACD,MAAA,GAAA,CAAI,MAAM,2BAA2B,CAAA;AAAA;AACzC;AACJ;AAAA,EAGQ,SAAA,CAAU,UAAkB,QAAkB,EAAA;AAClD,IAAA,aAAA,CAAc,KAAK,QAAQ,CAAA;AAC3B,IAAK,IAAA,CAAA,QAAA,GAAW,YAAY,MAAM;AAC9B,MAAA,IAAA,CAAK,UAAU,WAAY,CAAA,QAAQ,CAAE,CAAA,KAAA,CAAM,CAAC,CAAM,KAAA;AAC9C,QAAI,GAAA,CAAA,KAAA,CAAM,2BAA2B,CAAC,CAAA;AACtC,QAAA,IAAA,CAAK,YAAa,CAAA;AAAA,UACd,IAAM,EAAA;AAAA,SACT,CAAA;AACD,QAAA,IAAA,CAAK,OAAQ,EAAA;AAAA,OAChB,CAAA;AAAA,OACF,QAAQ,CAAA;AAAA;AACf,EAEA,aAAa,QAAqB,EAAA;AAC9B,IAAA,IAAA,CAAK,OAAO,KAAQ,GAAA,QAAA;AAAA;AAE5B;AAEA,MAAM,wBAA2B,GAAA;AAAA,EAC7B,WAAa,EAAA,IAAA;AAAA,EACb,QAAU,EAAA,GAAA;AAAA,EACV,QAAU,EAAA;AACd,CAAA;AAEA,MAAM,gBAAmB,GAAA;AAAA,EACrB,MAAQ,EAAA,WAAA;AAAA,EACR,UAAY,EAAA;AAChB,CAAA;AAEO,SAAS,kBAAkB,UAA0D,EAAA;AACxF,EAAM,MAAA,EAAE,iBAAoB,GAAA,UAAA;AAE5B,EAAA,MAAM,EAAE,cAAA,EAAgB,mBAAqB,EAAA,cAAA,EAAmB,GAAA,eAAA;AAEhE,EAAO,OAAA;AAAA,IACH,cAAgB,EAAA,EAAE,GAAG,aAAA,CAAc,cAAc,CAAE,EAAA;AAAA,IACnD,mBAAqB,EAAA,EAAE,GAAG,UAAA,CAAW,mBAAmB,CAAE,EAAA;AAAA,IAC1D,cAAgB,EAAA,EAAE,GAAG,YAAA,CAAa,cAAc,CAAE;AAAA,GACtD;AACJ;AAEA,SAAS,cAAc,kBAAgE,EAAA;AACnF,EAAA,IAAI,CAAC,kBAAA,IAAsB,aAAc,CAAA,kBAAkB,CAAG,EAAA;AAC1D,IAAI,GAAA,CAAA,IAAA;AAAA,MACA,4IACuB,wBAAwB,CAAA,EAAA;AAAA,KACnD;AACA,IAAA,OAAO,OAAO,MAAO,CAAA,IAAI,EAAE,GAAG,0BAA0B,CAAA;AAAA;AAE5D,EAAO,OAAA,kBAAA;AACX;AAEA,SAAS,WAAW,mBAA2E,EAAA;AAC3F,EAAA,IAAI,CAAC,mBAAA,IAAuB,aAAc,CAAA,mBAAmB,CAAG,EAAA;AAC5D,IAAI,GAAA,CAAA,IAAA;AAAA,MACA,yFACuB,gBAAgB,CAAA,EAAA;AAAA,KAC3C;AACA,IAAA,OAAO,OAAO,MAAO,CAAA,IAAI,EAAE,GAAG,kBAAkB,CAAA;AAAA;AAEpD,EAAO,OAAA,mBAAA;AACX;AAEA,SAAS,aAAa,cAA4D,EAAA;AAC9E,EAAA,IAAI,CAAC,cAAA,IAAkB,aAAc,CAAA,cAAc,CAAG,EAAA;AAClD,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,8HAAA;AAAA,KACJ;AAAA;AAEJ,EAAO,OAAA,cAAA;AACX;AAEA,MAAM,aAAA,GAAgB,CAAC,UAAwB,KAAA;AAC3C,EAAO,OAAA,UAAA,IAAc,OAAO,IAAK,CAAA,UAAU,EAAE,MAAW,KAAA,CAAA,IAAK,WAAW,WAAgB,KAAA,MAAA;AAC5F,CAAA;;;;"}