Compare commits
306 Commits
v9.1.1
...
v10.0.0-rc
Author | SHA1 | Date | |
---|---|---|---|
6013781594 | |||
1712d7e2f3 | |||
970572c441 | |||
38a9779a2f | |||
988b96825f | |||
10bbc8ae74 | |||
434b03e070 | |||
9d4543a611 | |||
b675ce7142 | |||
04461cd660 | |||
9b8952336b | |||
d15ae225b1 | |||
87ed9884ff | |||
9bbfac0896 | |||
6a487b11ce | |||
e00ab03c19 | |||
6fff769636 | |||
7904627653 | |||
7a2d7e5a9f | |||
31940102f2 | |||
2c36bfe3bb | |||
3af2eae618 | |||
a362b0fe2c | |||
891d190787 | |||
f228e50443 | |||
898a82cae1 | |||
9512e5dab1 | |||
dade9a7460 | |||
060b1ea8b8 | |||
834ae4e45b | |||
18c82a58a7 | |||
632641a067 | |||
fa051e4665 | |||
259dbbae36 | |||
87d9eb34a2 | |||
f9c55f5a43 | |||
aa880219c1 | |||
01899c034b | |||
4f930a9fba | |||
4a0ca9ff3b | |||
9cb6b73607 | |||
695cdd5c63 | |||
c2fd92f516 | |||
1911763fcb | |||
784bc71416 | |||
d3e065591b | |||
1d87e8fe8b | |||
f8bf54835d | |||
9e21b5cb93 | |||
771d6328af | |||
1a145a49ed | |||
de2d4ac497 | |||
4baeca58de | |||
0d36ddd6d3 | |||
ef3c190747 | |||
20565038f5 | |||
d6a302f6a3 | |||
70589b6442 | |||
027c8f38d8 | |||
a6f7f8ff49 | |||
fa24fb41a1 | |||
b1bec4a343 | |||
03e728fe04 | |||
58580555a4 | |||
30362df078 | |||
a70c651a11 | |||
d902859b00 | |||
3abb32ec82 | |||
081376cdd3 | |||
25621182c9 | |||
c2b990ac53 | |||
bcb70a1851 | |||
879e376bd4 | |||
4793d6dd23 | |||
4794e35989 | |||
7f55bb5ce3 | |||
aab1b7d490 | |||
7d8db7f48c | |||
12225c1265 | |||
f81ef406fb | |||
3770ec5f0d | |||
52a6edc9ca | |||
6846a683b0 | |||
98a0055490 | |||
a612fce78b | |||
fc040d8302 | |||
2b0febce19 | |||
d143e2d3ad | |||
0b72724cb4 | |||
9e0e8acda0 | |||
998f18a3ce | |||
500f558658 | |||
49f46c758a | |||
83548afa0a | |||
cf42f5b2a0 | |||
dfdc90b686 | |||
2e9d2b8bd2 | |||
95c27dd97e | |||
b871c3ecc3 | |||
82ffa801d6 | |||
b42bf24935 | |||
585c279d10 | |||
51bc65e671 | |||
ff1758cdce | |||
9909971316 | |||
05bd0885af | |||
b4abe5a22e | |||
c5c54cb807 | |||
51ec342f6f | |||
8d1c19bf1c | |||
72a3c37e84 | |||
c99cdf5566 | |||
ad339710f1 | |||
00d2d12056 | |||
6a7b472c0e | |||
6991d868be | |||
85cc665d17 | |||
5bb22fc345 | |||
5417dc1bed | |||
ee20d33724 | |||
7887bd2b67 | |||
168582efea | |||
2c55d13f91 | |||
23e5f553d4 | |||
bc44eadcec | |||
a3e3136600 | |||
c7bfcee8d2 | |||
12ebd19716 | |||
aec9ffa5db | |||
2e6321342e | |||
6e71da62f0 | |||
5bf33aae75 | |||
06b2dc63ff | |||
1bb0c9dfc2 | |||
a2b167e120 | |||
0909a4b7cc | |||
fd7d2bb9bf | |||
63c40fd816 | |||
0569fa5e58 | |||
ba74952e0b | |||
20c28f785a | |||
e9b249ddc7 | |||
604bb484a3 | |||
010c93793a | |||
dc1d4a66f4 | |||
8ef633d7ef | |||
2176d33da1 | |||
5b794e2d22 | |||
ccd75d56c5 | |||
b700066833 | |||
546ee006d3 | |||
7f333a6a36 | |||
ae757ee371 | |||
69936750d5 | |||
442bfa4ed6 | |||
79e25e69bb | |||
b95c12772d | |||
de47525d7c | |||
f49d20e47c | |||
33b9917229 | |||
2a88e6802f | |||
bcc8b12e13 | |||
9b974505eb | |||
29b1c26771 | |||
02db20d98b | |||
757354df7d | |||
319d7dbe94 | |||
feb8eaf95a | |||
563518cf46 | |||
7c42d9082a | |||
040284af71 | |||
34f64184d9 | |||
b9abd74156 | |||
a1c0bfda6c | |||
617dcef09d | |||
d9c406800a | |||
54b869def1 | |||
d80a583979 | |||
99bfd7379b | |||
5f257382fa | |||
e3e6847c82 | |||
4ee0823acb | |||
d466123b1c | |||
21cbc14a48 | |||
b2f2c3e386 | |||
b03340ed10 | |||
5b563d8e9b | |||
2790487fc7 | |||
ad5a368065 | |||
7c0a631a9a | |||
4a8920749a | |||
8ab118dd06 | |||
e6661cb898 | |||
1671850714 | |||
d568bafe04 | |||
43dcce8478 | |||
ad70a4cffd | |||
6d4a948dd8 | |||
839ba6a964 | |||
b5cfdb9d0a | |||
9706338182 | |||
05f52c3d23 | |||
df3acb6932 | |||
b3c242595e | |||
26985f8d81 | |||
05e5e4efec | |||
e88be30fc8 | |||
4d67f16e94 | |||
334ec1870a | |||
ef5e4fccd3 | |||
8535edcfd4 | |||
bda76200d7 | |||
db0dc96cc7 | |||
6d62b5a150 | |||
217439d673 | |||
1f79a8f7dc | |||
7596786b18 | |||
2540b06c94 | |||
43eeaf3002 | |||
037cd150de | |||
ae0b059217 | |||
8255ce1158 | |||
5bf905723c | |||
3e336f4937 | |||
cd1cc37916 | |||
4ad7183d7e | |||
e1b52e7439 | |||
dca8c9f9d7 | |||
22496e36eb | |||
7e4eba6376 | |||
f642a56eaa | |||
c091089830 | |||
18900d20e1 | |||
6c622b1580 | |||
4290cd23b2 | |||
5076c1e93f | |||
884b701fc6 | |||
73a8ec0295 | |||
a29b6097a4 | |||
a9231e2ed8 | |||
5f4669a7a6 | |||
75c54df109 | |||
2a07f7151d | |||
b6ecff2dd3 | |||
83df27ec99 | |||
ca255985c0 | |||
82f34c38f6 | |||
694b4c8027 | |||
bd25621b2c | |||
fde34be270 | |||
7c7ce159fe | |||
5a57bb59e5 | |||
cd278f4ab5 | |||
8b24e23721 | |||
22fa1411bf | |||
2799a52d0c | |||
4c2e01a7a8 | |||
7267d2ef38 | |||
1eb6b154f7 | |||
f55d61bf0b | |||
5b350274bd | |||
b6d2f9f691 | |||
81106b5deb | |||
66e595e649 | |||
33b7bb6184 | |||
7d9130b2af | |||
482d71743b | |||
1db37a4727 | |||
194d16ff91 | |||
b1e2284c0e | |||
70d1aa70a3 | |||
3b17d6e0ab | |||
9a5819b93b | |||
a260cd67b0 | |||
64111fb0ec | |||
faf2be23d9 | |||
0eb4a6a315 | |||
85673250ed | |||
09daa741ce | |||
55e2379aab | |||
9937977203 | |||
c897e7491a | |||
0a74a95283 | |||
74ef2c3dff | |||
9976dfacc0 | |||
659f8ddc7a | |||
9e4cc2ae57 | |||
a27d78fcdf | |||
e507435bcb | |||
d5f234909f | |||
c17f721625 | |||
600705130f | |||
5c5dce1422 | |||
53585bf2f0 | |||
116f88a503 | |||
aaba8cd2c7 | |||
b67aeb0d3a | |||
f620562d68 | |||
5231d0eaa1 | |||
cb470e3573 | |||
0a0f90aa2e | |||
635207d12c | |||
5e4a829413 | |||
b13b3fd92e | |||
564dc8e6f1 | |||
6e4cced8c6 |
@ -204,6 +204,33 @@
|
|||||||
"contributions": [
|
"contributions": [
|
||||||
"code"
|
"code"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "msiemens",
|
||||||
|
"name": "Markus Siemens",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/1873922?v=4",
|
||||||
|
"profile": "https://m-siemens.de/",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "law108000",
|
||||||
|
"name": "Rlok",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/8112024?v=4",
|
||||||
|
"profile": "https://github.com/law108000",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "Moulyy",
|
||||||
|
"name": "Moulyy",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/115405804?v=4",
|
||||||
|
"profile": "https://github.com/Moulyy",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"contributorsPerLine": 7,
|
"contributorsPerLine": 7,
|
||||||
|
3
.github/workflows/ci.yaml
vendored
3
.github/workflows/ci.yaml
vendored
@ -3,9 +3,6 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- v5
|
|
||||||
- v6
|
|
||||||
- v7
|
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
62
README.md
62
README.md
@ -14,9 +14,6 @@
|
|||||||
<a href="https://github.com/garronej/keycloakify/blob/main/LICENSE">
|
<a href="https://github.com/garronej/keycloakify/blob/main/LICENSE">
|
||||||
<img src="https://img.shields.io/npm/l/keycloakify">
|
<img src="https://img.shields.io/npm/l/keycloakify">
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/keycloakify/keycloakify/blob/729503fe31a155a823f46dd66ad4ff34ca274e0a/tsconfig.json#L14">
|
|
||||||
<img src="https://camo.githubusercontent.com/0f9fcc0ac1b8617ad4989364f60f78b2d6b32985ad6a508f215f14d8f897b8d3/68747470733a2f2f62616467656e2e6e65742f62616467652f547970655363726970742f7374726963742532302546302539462539322541412f626c7565">
|
|
||||||
</a>
|
|
||||||
<a href="https://github.com/thomasdarimont/awesome-keycloak">
|
<a href="https://github.com/thomasdarimont/awesome-keycloak">
|
||||||
<img src="https://awesome.re/mentioned-badge.svg"/>
|
<img src="https://awesome.re/mentioned-badge.svg"/>
|
||||||
</a>
|
</a>
|
||||||
@ -43,7 +40,10 @@
|
|||||||
|
|
||||||
Keycloakify is fully compatible with Keycloak 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, [~~22~~](https://github.com/keycloakify/keycloakify/issues/389#issuecomment-1822509763), **23** [and up](https://github.com/keycloakify/keycloakify/discussions/346#discussioncomment-5889791)!
|
Keycloakify is fully compatible with Keycloak 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, [~~22~~](https://github.com/keycloakify/keycloakify/issues/389#issuecomment-1822509763), **23** [and up](https://github.com/keycloakify/keycloakify/discussions/346#discussioncomment-5889791)!
|
||||||
|
|
||||||
## Sponsor 👼
|
> NOTE: Keycloak 24 introduces [important changes](https://www.keycloak.org/docs/latest/upgrading/index.html#changes-to-freemarker-templates-to-render-pages-based-on-the-user-profile-and-realm).
|
||||||
|
> We're actively working on incorporating them into Keycloakify. [Follow progress](https://github.com/keycloakify/keycloakify/pull/538).
|
||||||
|
|
||||||
|
## Sponsor
|
||||||
|
|
||||||
We are exclusively sponsored by [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), a French company offering Keycloak as a service.
|
We are exclusively sponsored by [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), a French company offering Keycloak as a service.
|
||||||
Their dedicated support helps us continue the development and maintenance of this project.
|
Their dedicated support helps us continue the development and maintenance of this project.
|
||||||
@ -66,12 +66,12 @@ Their dedicated support helps us continue the development and maintenance of thi
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<i>Checkout <a href="https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github">Cloud IAM</a> and use promo code <code>keycloakify5</code></i>
|
<i>Checkout <a href="https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github">Cloud-IAM</a> and use promo code <code>keycloakify5</code></i>
|
||||||
<br/>
|
<br/>
|
||||||
<i>5% of your annual subscription will be donated to us, and you'll get 5% off too.</i>
|
<i>5% of your annual subscription will be donated to us, and you'll get 5% off too.</i>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Thank you, [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), for your support!
|
Thank you, [Cloud-IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), for your support!
|
||||||
|
|
||||||
## Contributors ✨
|
## Contributors ✨
|
||||||
|
|
||||||
@ -111,6 +111,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/BlackVoid"><img src="https://avatars.githubusercontent.com/u/673720?v=4?s=100" width="100px;" alt="Felix Gustavsson"/><br /><sub><b>Felix Gustavsson</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=BlackVoid" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/BlackVoid"><img src="https://avatars.githubusercontent.com/u/673720?v=4?s=100" width="100px;" alt="Felix Gustavsson"/><br /><sub><b>Felix Gustavsson</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=BlackVoid" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://m-siemens.de/"><img src="https://avatars.githubusercontent.com/u/1873922?v=4?s=100" width="100px;" alt="Markus Siemens"/><br /><sub><b>Markus Siemens</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=msiemens" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/law108000"><img src="https://avatars.githubusercontent.com/u/8112024?v=4?s=100" width="100px;" alt="Rlok"/><br /><sub><b>Rlok</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=law108000" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Moulyy"><img src="https://avatars.githubusercontent.com/u/115405804?v=4?s=100" width="100px;" alt="Moulyy"/><br /><sub><b>Moulyy</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=Moulyy" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/giorgoslytos"><img src="https://avatars.githubusercontent.com/u/50946162?v=4?s=100" width="100px;" alt="giorgoslytos"/><br /><sub><b>giorgoslytos</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=giorgoslytos" title="Code">💻</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
@ -122,7 +126,21 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
|
|
||||||
# Changelog highlights
|
# Changelog highlights
|
||||||
|
|
||||||
## v9.0
|
## 9.5
|
||||||
|
|
||||||
|
- Post build hook: You can now apply custom transformation to your theme files. [Learn more](https://docs.keycloakify.dev/build-options#postbuild-hook).
|
||||||
|
- You can now specify your option in the Keycloakify's Vite plugin instead in the package.json. [See example](https://docs.keycloakify.dev/build-options#themename).
|
||||||
|
|
||||||
|
## 9.4
|
||||||
|
|
||||||
|
**Vite Support! 🎉**
|
||||||
|
|
||||||
|
- [The starter is now a Vite project](https://github.com/keycloakify/keycloakify-starter).
|
||||||
|
The Webpack based starter is accessible [here](https://github.com/keycloakify/keycloakify-starter-cra).
|
||||||
|
- CRA (Webpack) remains supported for the forseable future.
|
||||||
|
- If you have a CRA Keycloakify theme that you wish to migrate to Vite checkout [this migration guide](https://docs.keycloakify.dev/migration-guides/cra-greater-than-vite).
|
||||||
|
|
||||||
|
## 9.0
|
||||||
|
|
||||||
Bring back support for account themes in Keycloak v23 and up! [See issue](https://github.com/keycloakify/keycloakify/issues/389).
|
Bring back support for account themes in Keycloak v23 and up! [See issue](https://github.com/keycloakify/keycloakify/issues/389).
|
||||||
|
|
||||||
@ -255,79 +273,79 @@ Checkout [the migration guide](https://docs.keycloakify.dev/v5-to-v6)
|
|||||||
|
|
||||||
Fix `login-verify-email.ftl` page. [Before](https://user-images.githubusercontent.com/6702424/177436014-0bad22c4-5bfb-45bb-8fc9-dad65143cd0c.png) - [After](https://user-images.githubusercontent.com/6702424/177435797-ec5d7db3-84cf-49cb-8efc-3427a81f744e.png)
|
Fix `login-verify-email.ftl` page. [Before](https://user-images.githubusercontent.com/6702424/177436014-0bad22c4-5bfb-45bb-8fc9-dad65143cd0c.png) - [After](https://user-images.githubusercontent.com/6702424/177435797-ec5d7db3-84cf-49cb-8efc-3427a81f744e.png)
|
||||||
|
|
||||||
## v5.6.0
|
## 5.6.0
|
||||||
|
|
||||||
Add support for `login-config-totp.ftl` page [#127](https://github.com/keycloakify/keycloakify/pull/127).
|
Add support for `login-config-totp.ftl` page [#127](https://github.com/keycloakify/keycloakify/pull/127).
|
||||||
|
|
||||||
## v5.3.0
|
## 5.3.0
|
||||||
|
|
||||||
Rename `keycloak_theme_email` to `keycloak_email`.
|
Rename `keycloak_theme_email` to `keycloak_email`.
|
||||||
If you already had a `keycloak_theme_email` you should rename it `keycloak_email`.
|
If you already had a `keycloak_theme_email` you should rename it `keycloak_email`.
|
||||||
|
|
||||||
## v5.0.0
|
## 5.0.0
|
||||||
|
|
||||||
[Migration guide](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63)
|
[Migration guide](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63)
|
||||||
New i18n system.
|
New i18n system.
|
||||||
Import of terms and services have changed. [See example](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63).
|
Import of terms and services have changed. [See example](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63).
|
||||||
|
|
||||||
## v4.10.0
|
## 4.10.0
|
||||||
|
|
||||||
Add `login-idp-link-email.ftl` page [See PR](https://github.com/keycloakify/keycloakify/pull/92).
|
Add `login-idp-link-email.ftl` page [See PR](https://github.com/keycloakify/keycloakify/pull/92).
|
||||||
|
|
||||||
## v4.8.0
|
## 4.8.0
|
||||||
|
|
||||||
[Email template customization.](#email-template-customization)
|
[Email template customization.](#email-template-customization)
|
||||||
|
|
||||||
## v4.7.4
|
## 4.7.4
|
||||||
|
|
||||||
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
||||||
|
|
||||||
## v4.7.2
|
## 4.7.2
|
||||||
|
|
||||||
> WARNING: This is broken.
|
> WARNING: This is broken.
|
||||||
> Testing with local Keycloak container working with M1 Mac. Thanks to [@eduardosanzb](https://github.com/keycloakify/keycloakify/issues/43#issuecomment-975699658).
|
> Testing with local Keycloak container working with M1 Mac. Thanks to [@eduardosanzb](https://github.com/keycloakify/keycloakify/issues/43#issuecomment-975699658).
|
||||||
> Be aware: When running M1s you are testing with Keycloak v15 else the local container spun will be a Keycloak v16.1.0.
|
> Be aware: When running M1s you are testing with Keycloak v15 else the local container spun will be a Keycloak v16.1.0.
|
||||||
|
|
||||||
## v4.7.0
|
## 4.7.0
|
||||||
|
|
||||||
Register with user profile enabled: Out of the box `options` validator support.
|
Register with user profile enabled: Out of the box `options` validator support.
|
||||||
[Example](https://user-images.githubusercontent.com/6702424/158911163-81e6bbe8-feb0-4dc8-abff-de199d7a678e.mov)
|
[Example](https://user-images.githubusercontent.com/6702424/158911163-81e6bbe8-feb0-4dc8-abff-de199d7a678e.mov)
|
||||||
|
|
||||||
## v4.6.0
|
## 4.6.0
|
||||||
|
|
||||||
`tss-react` and `powerhooks` are no longer peer dependencies of `keycloakify`.
|
`tss-react` and `powerhooks` are no longer peer dependencies of `keycloakify`.
|
||||||
After updating Keycloakify you can remove `tss-react` and `powerhooks` from your dependencies if you don't use them explicitly.
|
After updating Keycloakify you can remove `tss-react` and `powerhooks` from your dependencies if you don't use them explicitly.
|
||||||
|
|
||||||
## v4.5.3
|
## 4.5.3
|
||||||
|
|
||||||
There is a new recommended way to setup highly customized theme. See [here](https://github.com/garronej/keycloakify-demo-app/blob/look_and_feel/src/KcApp/KcApp.tsx).
|
There is a new recommended way to setup highly customized theme. See [here](https://github.com/garronej/keycloakify-demo-app/blob/look_and_feel/src/KcApp/KcApp.tsx).
|
||||||
Unlike with [the previous recommended method](https://github.com/garronej/keycloakify-demo-app/blob/a51660578bea15fb3e506b8a2b78e1056c6d68bb/src/KcApp/KcApp.tsx),
|
Unlike with [the previous recommended method](https://github.com/garronej/keycloakify-demo-app/blob/a51660578bea15fb3e506b8a2b78e1056c6d68bb/src/KcApp/KcApp.tsx),
|
||||||
with this new method your theme wont break on minor Keycloakify update.
|
with this new method your theme wont break on minor Keycloakify update.
|
||||||
|
|
||||||
## v4.3.0
|
## 4.3.0
|
||||||
|
|
||||||
Feature [`login-update-password.ftl`](https://user-images.githubusercontent.com/6702424/147517600-6191cf72-93dd-437b-a35c-47180142063e.png).
|
Feature [`login-update-password.ftl`](https://user-images.githubusercontent.com/6702424/147517600-6191cf72-93dd-437b-a35c-47180142063e.png).
|
||||||
Every time a page is added it's a breaking change for non CSS-only theme.
|
Every time a page is added it's a breaking change for non CSS-only theme.
|
||||||
Change [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L17) and [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L37) to update.
|
Change [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L17) and [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L37) to update.
|
||||||
|
|
||||||
## v4
|
## 4
|
||||||
|
|
||||||
- Out of the box [frontend form validation](#user-profile-and-frontend-form-validation) 🥳
|
- Out of the box [frontend form validation](#user-profile-and-frontend-form-validation) 🥳
|
||||||
- Improvements (and breaking changes in `import { useKcMessage } from "keycloakify"`.
|
- Improvements (and breaking changes in `import { useKcMessage } from "keycloakify"`.
|
||||||
|
|
||||||
## v3
|
## 3
|
||||||
|
|
||||||
No breaking changes except that `@emotion/react`, [`tss-react`](https://www.npmjs.com/package/tss-react) and [`powerhooks`](https://www.npmjs.com/package/powerhooks) are now `peerDependencies` instead of being just dependencies.
|
No breaking changes except that `@emotion/react`, [`tss-react`](https://www.npmjs.com/package/tss-react) and [`powerhooks`](https://www.npmjs.com/package/powerhooks) are now `peerDependencies` instead of being just dependencies.
|
||||||
It's important to avoid problem when using `keycloakify` alongside [`mui`](https://mui.com) and
|
It's important to avoid problem when using `keycloakify` alongside [`mui`](https://mui.com) and
|
||||||
[when passing params from the app to the login page](https://github.com/keycloakify/keycloakify#implement-context-persistence-optional).
|
[when passing params from the app to the login page](https://github.com/keycloakify/keycloakify#implement-context-persistence-optional).
|
||||||
|
|
||||||
## v2.5
|
## 2.5
|
||||||
|
|
||||||
- Feature [Use advanced message](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
|
- Feature [Use advanced message](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
|
||||||
and [`messagesPerFields`](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
|
and [`messagesPerFields`](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
|
||||||
- Test container now uses Keycloak version `15.0.2`.
|
- Test container now uses Keycloak version `15.0.2`.
|
||||||
|
|
||||||
## v2
|
## 2
|
||||||
|
|
||||||
- It's now possible to implement custom `.ftl` pages.
|
- It's now possible to implement custom `.ftl` pages.
|
||||||
- Support for Keycloak plugins that introduce non standard ftl values.
|
- Support for Keycloak plugins that introduce non standard ftl values.
|
||||||
|
15
package.json
15
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "keycloakify",
|
"name": "keycloakify",
|
||||||
"version": "9.1.1",
|
"version": "10.0.0-rc.0",
|
||||||
"description": "Create Keycloak themes using React",
|
"description": "Create Keycloak themes using React",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -10,7 +10,7 @@
|
|||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"prepare": "yarn generate-i18n-messages",
|
"prepare": "yarn generate-i18n-messages",
|
||||||
"build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/ && cp -r src dist/",
|
"build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc -p src/vite-plugin && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/ && cp -r src dist/",
|
||||||
"generate:json-schema": "ts-node scripts/generate-json-schema.ts",
|
"generate:json-schema": "ts-node scripts/generate-json-schema.ts",
|
||||||
"grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
|
"grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
|
||||||
"copy-files": "copyfiles -u 1 src/**/*.ftl src/**/*.java",
|
"copy-files": "copyfiles -u 1 src/**/*.ftl src/**/*.java",
|
||||||
@ -65,7 +65,7 @@
|
|||||||
],
|
],
|
||||||
"homepage": "https://www.keycloakify.dev",
|
"homepage": "https://www.keycloakify.dev",
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"react": "^16.8.0 || ^17.0.0 || ^18.0.0"
|
"react": "*"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/core": "^7.0.0",
|
"@babel/core": "^7.0.0",
|
||||||
@ -105,7 +105,8 @@
|
|||||||
"tss-react": "^4.8.2",
|
"tss-react": "^4.8.2",
|
||||||
"typescript": "^4.9.1-beta",
|
"typescript": "^4.9.1-beta",
|
||||||
"vitest": "^0.29.8",
|
"vitest": "^0.29.8",
|
||||||
"zod-to-json-schema": "^3.20.4"
|
"zod-to-json-schema": "^3.20.4",
|
||||||
|
"vite": "^5.0.12"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/generator": "^7.22.9",
|
"@babel/generator": "^7.22.9",
|
||||||
@ -114,17 +115,17 @@
|
|||||||
"@octokit/rest": "^18.12.0",
|
"@octokit/rest": "^18.12.0",
|
||||||
"cheerio": "^1.0.0-rc.5",
|
"cheerio": "^1.0.0-rc.5",
|
||||||
"cli-select": "^1.1.2",
|
"cli-select": "^1.1.2",
|
||||||
"evt": "^2.4.18",
|
"evt": "^2.5.7",
|
||||||
"make-fetch-happen": "^11.0.3",
|
"make-fetch-happen": "^11.0.3",
|
||||||
"minimal-polyfills": "^2.2.2",
|
"minimal-polyfills": "^2.2.2",
|
||||||
"minimist": "^1.2.6",
|
"minimist": "^1.2.6",
|
||||||
"path-browserify": "^1.0.1",
|
|
||||||
"react-markdown": "^5.0.3",
|
"react-markdown": "^5.0.3",
|
||||||
"recast": "^0.23.3",
|
"recast": "^0.23.3",
|
||||||
"rfc4648": "^1.5.2",
|
"rfc4648": "^1.5.2",
|
||||||
"tsafe": "^1.6.0",
|
"tsafe": "^1.6.0",
|
||||||
"yauzl": "^2.10.0",
|
"yauzl": "^2.10.0",
|
||||||
"yazl": "^2.5.1",
|
"yazl": "^2.5.1",
|
||||||
"zod": "^3.17.10"
|
"zod": "^3.17.10",
|
||||||
|
"magic-string": "^0.30.7"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -3,7 +3,7 @@ import * as fs from "fs";
|
|||||||
import { join as pathJoin, relative as pathRelative, dirname as pathDirname, sep as pathSep } from "path";
|
import { join as pathJoin, relative as pathRelative, dirname as pathDirname, sep as pathSep } from "path";
|
||||||
import { crawl } from "../src/bin/tools/crawl";
|
import { crawl } from "../src/bin/tools/crawl";
|
||||||
import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
|
||||||
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
import { getThisCodebaseRootDirPath } from "../src/bin/tools/getThisCodebaseRootDirPath";
|
||||||
import { getLogger } from "../src/bin/tools/logger";
|
import { getLogger } from "../src/bin/tools/logger";
|
||||||
|
|
||||||
// NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
|
// NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
|
||||||
@ -17,17 +17,24 @@ const isSilent = true;
|
|||||||
const logger = getLogger({ isSilent });
|
const logger = getLogger({ isSilent });
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const keycloakVersion = "21.0.1";
|
const keycloakVersion = "24.0.4";
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
const thisCodebaseRootDirPath = getThisCodebaseRootDirPath();
|
||||||
|
|
||||||
|
const tmpDirPath = pathJoin(thisCodebaseRootDirPath, "tmp_xImOef9dOd44");
|
||||||
|
|
||||||
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
|
|
||||||
|
fs.mkdirSync(tmpDirPath);
|
||||||
|
|
||||||
|
fs.writeFileSync(pathJoin(tmpDirPath, ".gitignore"), Buffer.from("/*\n!.gitignore\n", "utf8"));
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath,
|
||||||
"buildOptions": {
|
"buildOptions": {
|
||||||
"cacheDirPath": pathJoin(getProjectRoot(), "node_modules", ".cache", "keycloakify")
|
"cacheDirPath": pathJoin(thisCodebaseRootDirPath, "node_modules", ".cache", "keycloakify"),
|
||||||
|
"npmWorkspaceRootDirPath": thisCodebaseRootDirPath
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -68,14 +75,13 @@ async function main() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const baseMessagesDirPath = pathJoin(getProjectRoot(), "src", themeType, "i18n", "baseMessages");
|
const baseMessagesDirPath = pathJoin(thisCodebaseRootDirPath, "src", themeType, "i18n", "baseMessages");
|
||||||
|
|
||||||
const languages = Object.keys(recordForPageType);
|
const languages = Object.keys(recordForPageType);
|
||||||
|
|
||||||
const generatedFileHeader = [
|
const generatedFileHeader = [
|
||||||
`//This code was automatically generated by running ${pathRelative(getProjectRoot(), __filename)}`,
|
`//This code was automatically generated by running ${pathRelative(thisCodebaseRootDirPath, __filename)}`,
|
||||||
"//PLEASE DO NOT EDIT MANUALLY",
|
"//PLEASE DO NOT EDIT MANUALLY"
|
||||||
""
|
|
||||||
].join("\n");
|
].join("\n");
|
||||||
|
|
||||||
languages.forEach(language => {
|
languages.forEach(language => {
|
||||||
@ -88,6 +94,7 @@ async function main() {
|
|||||||
Buffer.from(
|
Buffer.from(
|
||||||
[
|
[
|
||||||
generatedFileHeader,
|
generatedFileHeader,
|
||||||
|
"",
|
||||||
"/* spell-checker: disable */",
|
"/* spell-checker: disable */",
|
||||||
`const messages= ${JSON.stringify(recordForPageType[language], null, 2)};`,
|
`const messages= ${JSON.stringify(recordForPageType[language], null, 2)};`,
|
||||||
"",
|
"",
|
||||||
@ -106,10 +113,15 @@ async function main() {
|
|||||||
Buffer.from(
|
Buffer.from(
|
||||||
[
|
[
|
||||||
generatedFileHeader,
|
generatedFileHeader,
|
||||||
|
`import * as en from "./en";`,
|
||||||
|
"",
|
||||||
"export async function getMessages(currentLanguageTag: string) {",
|
"export async function getMessages(currentLanguageTag: string) {",
|
||||||
" const { default: messages } = await (() => {",
|
" const { default: messages } = await (() => {",
|
||||||
" switch (currentLanguageTag) {",
|
" switch (currentLanguageTag) {",
|
||||||
...languages.map(language => ` case "${language}": return import("./${language}");`),
|
` case "en": return en;`,
|
||||||
|
...languages
|
||||||
|
.filter(language => language !== "en")
|
||||||
|
.map(language => ` case "${language}": return import("./${language}");`),
|
||||||
' default: return { "default": {} };',
|
' default: return { "default": {} };',
|
||||||
" }",
|
" }",
|
||||||
" })();",
|
" })();",
|
||||||
|
@ -1,14 +0,0 @@
|
|||||||
import fs from "fs";
|
|
||||||
import path from "path";
|
|
||||||
import zodToJsonSchema from "zod-to-json-schema";
|
|
||||||
import { zParsedPackageJson } from "../src/bin/keycloakify/parsedPackageJson";
|
|
||||||
|
|
||||||
const jsonSchemaName = "keycloakifyPackageJsonSchema";
|
|
||||||
const jsonSchema = zodToJsonSchema(zParsedPackageJson, jsonSchemaName);
|
|
||||||
|
|
||||||
const baseProperties = {
|
|
||||||
// merges package.json schema with keycloakify properties
|
|
||||||
"allOf": [{ "$ref": "https://json.schemastore.org/package.json" }, { "$ref": jsonSchemaName }]
|
|
||||||
};
|
|
||||||
|
|
||||||
fs.writeFileSync(path.join(process.cwd(), "keycloakify-json-schema.json"), JSON.stringify({ ...baseProperties, ...jsonSchema }, null, 2));
|
|
@ -1,11 +1,11 @@
|
|||||||
import { execSync } from "child_process";
|
import { execSync } from "child_process";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
import { getThisCodebaseRootDirPath } from "../src/bin/tools/getThisCodebaseRootDirPath";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
|
||||||
const singletonDependencies: string[] = ["react", "@types/react"];
|
const singletonDependencies: string[] = ["react", "@types/react"];
|
||||||
|
|
||||||
const rootDirPath = getProjectRoot();
|
const rootDirPath = getThisCodebaseRootDirPath();
|
||||||
|
|
||||||
//NOTE: This is only required because of: https://github.com/garronej/ts-ci/blob/c0e207b9677523d4ec97fe672ddd72ccbb3c1cc4/README.md?plain=1#L54-L58
|
//NOTE: This is only required because of: https://github.com/garronej/ts-ci/blob/c0e207b9677523d4ec97fe672ddd72ccbb3c1cc4/README.md?plain=1#L54-L58
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
|
21
src/PUBLIC_URL.ts
Normal file
21
src/PUBLIC_URL.ts
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
import { nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "keycloakify/bin/constants";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is an equivalent of process.env.PUBLIC_URL thay you can use in Webpack projects.
|
||||||
|
* This works both in your main app and in your Keycloak theme.
|
||||||
|
*/
|
||||||
|
export const PUBLIC_URL = (() => {
|
||||||
|
const kcContext = (window as any)[nameOfTheGlobal];
|
||||||
|
|
||||||
|
if (kcContext === undefined || process.env.NODE_ENV === "development") {
|
||||||
|
assert(
|
||||||
|
process.env.PUBLIC_URL !== undefined,
|
||||||
|
`If you use keycloakify/PUBLIC_URL you should be in Webpack and thus process.env.PUBLIC_URL should be defined`
|
||||||
|
);
|
||||||
|
|
||||||
|
return process.env.PUBLIC_URL;
|
||||||
|
}
|
||||||
|
|
||||||
|
return `${kcContext.url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}`;
|
||||||
|
})();
|
@ -6,6 +6,10 @@ import { assert, type Equals } from "tsafe/assert";
|
|||||||
|
|
||||||
const Password = lazy(() => import("keycloakify/account/pages/Password"));
|
const Password = lazy(() => import("keycloakify/account/pages/Password"));
|
||||||
const Account = lazy(() => import("keycloakify/account/pages/Account"));
|
const Account = lazy(() => import("keycloakify/account/pages/Account"));
|
||||||
|
const Sessions = lazy(() => import("keycloakify/account/pages/Sessions"));
|
||||||
|
const Totp = lazy(() => import("keycloakify/account/pages/Totp"));
|
||||||
|
const Applications = lazy(() => import("keycloakify/account/pages/Applications"));
|
||||||
|
const Log = lazy(() => import("keycloakify/account/pages/Log"));
|
||||||
|
|
||||||
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
||||||
const { kcContext, ...rest } = props;
|
const { kcContext, ...rest } = props;
|
||||||
@ -16,8 +20,16 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
switch (kcContext.pageId) {
|
switch (kcContext.pageId) {
|
||||||
case "password.ftl":
|
case "password.ftl":
|
||||||
return <Password kcContext={kcContext} {...rest} />;
|
return <Password kcContext={kcContext} {...rest} />;
|
||||||
|
case "sessions.ftl":
|
||||||
|
return <Sessions kcContext={kcContext} {...rest} />;
|
||||||
case "account.ftl":
|
case "account.ftl":
|
||||||
return <Account kcContext={kcContext} {...rest} />;
|
return <Account kcContext={kcContext} {...rest} />;
|
||||||
|
case "totp.ftl":
|
||||||
|
return <Totp kcContext={kcContext} {...rest} />;
|
||||||
|
case "applications.ftl":
|
||||||
|
return <Applications kcContext={kcContext} {...rest} />;
|
||||||
|
case "log.ftl":
|
||||||
|
return <Log kcContext={kcContext} {...rest} />;
|
||||||
}
|
}
|
||||||
assert<Equals<typeof kcContext, never>>(false);
|
assert<Equals<typeof kcContext, never>>(false);
|
||||||
})()}
|
})()}
|
||||||
|
@ -1,32 +1,61 @@
|
|||||||
|
import { useEffect } from "react";
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
import { usePrepareTemplate } from "keycloakify/lib/usePrepareTemplate";
|
|
||||||
import { type TemplateProps } from "keycloakify/account/TemplateProps";
|
import { type TemplateProps } from "keycloakify/account/TemplateProps";
|
||||||
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
||||||
|
import { createUseInsertLinkTags } from "keycloakify/tools/useInsertLinkTags";
|
||||||
|
import { useSetClassName } from "keycloakify/tools/useSetClassName";
|
||||||
import type { KcContext } from "./kcContext";
|
import type { KcContext } from "./kcContext";
|
||||||
import type { I18n } from "./i18n";
|
import type { I18n } from "./i18n";
|
||||||
import { assert } from "keycloakify/tools/assert";
|
import { assert } from "keycloakify/tools/assert";
|
||||||
|
|
||||||
|
const { useInsertLinkTags } = createUseInsertLinkTags();
|
||||||
|
|
||||||
export default function Template(props: TemplateProps<KcContext, I18n>) {
|
export default function Template(props: TemplateProps<KcContext, I18n>) {
|
||||||
const { kcContext, i18n, doUseDefaultCss, active, classes, children } = props;
|
const { kcContext, i18n, doUseDefaultCss, active, classes, children } = props;
|
||||||
|
|
||||||
const { getClassName } = useGetClassName({ doUseDefaultCss, classes });
|
const { getClassName } = useGetClassName({ doUseDefaultCss, classes });
|
||||||
|
|
||||||
const { msg, changeLocale, labelBySupportedLanguageTag, currentLanguageTag } = i18n;
|
const { msg, msgStr, changeLocale, labelBySupportedLanguageTag, currentLanguageTag } = i18n;
|
||||||
|
|
||||||
const { locale, url, features, realm, message, referrer } = kcContext;
|
const { locale, url, features, realm, message, referrer } = kcContext;
|
||||||
|
|
||||||
const { isReady } = usePrepareTemplate({
|
useEffect(() => {
|
||||||
"doFetchDefaultThemeResources": doUseDefaultCss,
|
document.title = msgStr("accountManagementTitle");
|
||||||
"styles": [
|
}, []);
|
||||||
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
|
||||||
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
useSetClassName({
|
||||||
`${url.resourcesPath}/css/account.css`
|
"qualifiedName": "html",
|
||||||
],
|
"className": getClassName("kcHtmlClass")
|
||||||
"htmlClassName": getClassName("kcHtmlClass"),
|
|
||||||
"bodyClassName": clsx("admin-console", "user", getClassName("kcBodyClass"))
|
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!isReady) {
|
useSetClassName({
|
||||||
|
"qualifiedName": "body",
|
||||||
|
"className": clsx("admin-console", "user", getClassName("kcBodyClass"))
|
||||||
|
});
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const { currentLanguageTag } = locale ?? {};
|
||||||
|
|
||||||
|
if (currentLanguageTag === undefined) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const html = document.querySelector("html");
|
||||||
|
assert(html !== null);
|
||||||
|
html.lang = currentLanguageTag;
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const { areAllStyleSheetsLoaded } = useInsertLinkTags({
|
||||||
|
"hrefs": !doUseDefaultCss
|
||||||
|
? []
|
||||||
|
: [
|
||||||
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
|
`${url.resourcesPath}/css/account.css`
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!areAllStyleSheetsLoaded) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -11,4 +11,17 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey = "kcHtmlClass" | "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
export type ClassKey =
|
||||||
|
| "kcHtmlClass"
|
||||||
|
| "kcBodyClass"
|
||||||
|
| "kcButtonClass"
|
||||||
|
| "kcButtonPrimaryClass"
|
||||||
|
| "kcButtonLargeClass"
|
||||||
|
| "kcButtonDefaultClass"
|
||||||
|
| "kcContentWrapperClass"
|
||||||
|
| "kcFormClass"
|
||||||
|
| "kcFormGroupClass"
|
||||||
|
| "kcInputWrapperClass"
|
||||||
|
| "kcLabelClass"
|
||||||
|
| "kcInputClass"
|
||||||
|
| "kcInputErrorMessageClass";
|
||||||
|
@ -3,7 +3,7 @@ import { assert } from "tsafe/assert";
|
|||||||
import type { Equals } from "tsafe";
|
import type { Equals } from "tsafe";
|
||||||
import { type ThemeType } from "keycloakify/bin/constants";
|
import { type ThemeType } from "keycloakify/bin/constants";
|
||||||
|
|
||||||
export type KcContext = KcContext.Password | KcContext.Account;
|
export type KcContext = KcContext.Password | KcContext.Account | KcContext.Sessions | KcContext.Totp | KcContext.Applications | KcContext.Log;
|
||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
@ -90,6 +90,16 @@ export declare namespace KcContext {
|
|||||||
lastName?: string;
|
lastName?: string;
|
||||||
username?: string;
|
username?: string;
|
||||||
};
|
};
|
||||||
|
properties: Record<string, string | undefined>;
|
||||||
|
sessions: {
|
||||||
|
sessions: {
|
||||||
|
ipAddress: string;
|
||||||
|
started?: any;
|
||||||
|
lastAccess?: any;
|
||||||
|
expires?: any;
|
||||||
|
clients: string[];
|
||||||
|
}[];
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export type Password = Common & {
|
export type Password = Common & {
|
||||||
@ -111,6 +121,144 @@ export declare namespace KcContext {
|
|||||||
};
|
};
|
||||||
stateChecker: string;
|
stateChecker: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type Sessions = Common & {
|
||||||
|
pageId: "sessions.ftl";
|
||||||
|
sessions: {
|
||||||
|
sessions: {
|
||||||
|
ipAddress: string;
|
||||||
|
started?: any;
|
||||||
|
lastAccess?: any;
|
||||||
|
expires?: any;
|
||||||
|
clients: string[];
|
||||||
|
}[];
|
||||||
|
};
|
||||||
|
stateChecker: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type Totp = Common & {
|
||||||
|
pageId: "totp.ftl";
|
||||||
|
totp: {
|
||||||
|
enabled: boolean;
|
||||||
|
totpSecretEncoded: string;
|
||||||
|
qrUrl: string;
|
||||||
|
policy: {
|
||||||
|
algorithm: "HmacSHA1" | "HmacSHA256" | "HmacSHA512";
|
||||||
|
digits: number;
|
||||||
|
lookAheadWindow: number;
|
||||||
|
} & (
|
||||||
|
| {
|
||||||
|
type: "totp";
|
||||||
|
period: number;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
type: "hotp";
|
||||||
|
initialCounter: number;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
supportedApplications: string[];
|
||||||
|
totpSecretQrCode: string;
|
||||||
|
manualUrl: string;
|
||||||
|
totpSecret: string;
|
||||||
|
otpCredentials: { id: string; userLabel: string }[];
|
||||||
|
};
|
||||||
|
mode?: "qr" | "manual" | undefined | null;
|
||||||
|
isAppInitiatedAction: boolean;
|
||||||
|
url: {
|
||||||
|
accountUrl: string;
|
||||||
|
passwordUrl: string;
|
||||||
|
totpUrl: string;
|
||||||
|
socialUrl: string;
|
||||||
|
sessionsUrl: string;
|
||||||
|
applicationsUrl: string;
|
||||||
|
logUrl: string;
|
||||||
|
resourceUrl: string;
|
||||||
|
resourcesCommonPath: string;
|
||||||
|
resourcesPath: string;
|
||||||
|
/** @deprecated, not present in recent keycloak version apparently, use kcContext.referrer instead */
|
||||||
|
referrerURI?: string;
|
||||||
|
getLogoutUrl: () => string;
|
||||||
|
};
|
||||||
|
stateChecker: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type Applications = Common & {
|
||||||
|
pageId: "applications.ftl";
|
||||||
|
features: {
|
||||||
|
log: boolean;
|
||||||
|
identityFederation: boolean;
|
||||||
|
authorization: boolean;
|
||||||
|
passwordUpdateSupported: boolean;
|
||||||
|
};
|
||||||
|
stateChecker: string;
|
||||||
|
applications: {
|
||||||
|
applications: {
|
||||||
|
realmRolesAvailable: { name: string; description: string }[];
|
||||||
|
resourceRolesAvailable: Record<
|
||||||
|
string,
|
||||||
|
{
|
||||||
|
roleName: string;
|
||||||
|
roleDescription: string;
|
||||||
|
clientName: string;
|
||||||
|
clientId: string;
|
||||||
|
}[]
|
||||||
|
>;
|
||||||
|
additionalGrants: string[];
|
||||||
|
clientScopesGranted: string[];
|
||||||
|
effectiveUrl?: string;
|
||||||
|
client: {
|
||||||
|
consentScreenText: string;
|
||||||
|
surrogateAuthRequired: boolean;
|
||||||
|
bearerOnly: boolean;
|
||||||
|
id: string;
|
||||||
|
protocolMappersStream: Record<string, unknown>;
|
||||||
|
includeInTokenScope: boolean;
|
||||||
|
redirectUris: string[];
|
||||||
|
fullScopeAllowed: boolean;
|
||||||
|
registeredNodes: Record<string, unknown>;
|
||||||
|
enabled: boolean;
|
||||||
|
clientAuthenticatorType: string;
|
||||||
|
realmScopeMappingsStream: Record<string, unknown>;
|
||||||
|
scopeMappingsStream: Record<string, unknown>;
|
||||||
|
displayOnConsentScreen: boolean;
|
||||||
|
clientId: string;
|
||||||
|
rootUrl: string;
|
||||||
|
authenticationFlowBindingOverrides: Record<string, unknown>;
|
||||||
|
standardFlowEnabled: boolean;
|
||||||
|
attributes: Record<string, unknown>;
|
||||||
|
publicClient: boolean;
|
||||||
|
alwaysDisplayInConsole: boolean;
|
||||||
|
consentRequired: boolean;
|
||||||
|
notBefore: string;
|
||||||
|
rolesStream: Record<string, unknown>;
|
||||||
|
protocol: string;
|
||||||
|
dynamicScope: boolean;
|
||||||
|
directAccessGrantsEnabled: boolean;
|
||||||
|
name: string;
|
||||||
|
serviceAccountsEnabled: boolean;
|
||||||
|
frontchannelLogout: boolean;
|
||||||
|
nodeReRegistrationTimeout: string;
|
||||||
|
implicitFlowEnabled: boolean;
|
||||||
|
baseUrl: string;
|
||||||
|
webOrigins: string[];
|
||||||
|
realm: Record<string, unknown>;
|
||||||
|
};
|
||||||
|
}[];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type Log = Common & {
|
||||||
|
pageId: "log.ftl";
|
||||||
|
log: {
|
||||||
|
events: {
|
||||||
|
date: string | number | Date;
|
||||||
|
event: string;
|
||||||
|
ipAddress: string;
|
||||||
|
client: any;
|
||||||
|
details: any[];
|
||||||
|
}[];
|
||||||
|
};
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
{
|
||||||
|
@ -1,16 +1,16 @@
|
|||||||
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
||||||
import { deepAssign } from "keycloakify/tools/deepAssign";
|
import { deepAssign } from "keycloakify/tools/deepAssign";
|
||||||
|
import { isStorybook } from "keycloakify/lib/isStorybook";
|
||||||
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
||||||
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
import { resources_common } from "keycloakify/bin/constants";
|
|
||||||
import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
|
import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
|
||||||
|
|
||||||
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
||||||
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
||||||
|
mockProperties?: Record<string, string>;
|
||||||
}) {
|
}) {
|
||||||
const { mockData } = params ?? {};
|
const { mockData, mockProperties } = params ?? {};
|
||||||
|
|
||||||
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
||||||
mockPageId?: PageId;
|
mockPageId?: PageId;
|
||||||
@ -27,7 +27,13 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
if (mockPageId !== undefined && realKcContext === undefined) {
|
if (mockPageId !== undefined && realKcContext === undefined) {
|
||||||
//TODO maybe trow if no mock fo custom page
|
//TODO maybe trow if no mock fo custom page
|
||||||
|
|
||||||
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
warn_that_mock_is_enbaled: {
|
||||||
|
if (isStorybook) {
|
||||||
|
break warn_that_mock_is_enbaled;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
||||||
|
}
|
||||||
|
|
||||||
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
||||||
|
|
||||||
@ -77,6 +83,13 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (mockProperties !== undefined) {
|
||||||
|
deepAssign({
|
||||||
|
"target": kcContext.properties,
|
||||||
|
"source": mockProperties
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
return { kcContext };
|
return { kcContext };
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -88,8 +101,6 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
realKcContext.url.resourcesCommonPath = pathJoin(realKcContext.url.resourcesPath, resources_common);
|
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
||||||
import { ftlValuesGlobalName } from "keycloakify/bin/keycloakify/ftlValuesGlobalName";
|
import { nameOfTheGlobal } from "keycloakify/bin/constants";
|
||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
|
|
||||||
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
||||||
@ -7,5 +7,5 @@ export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [Kc
|
|||||||
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
||||||
|
|
||||||
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
||||||
return typeof window === "undefined" ? undefined : (window as any)[ftlValuesGlobalName];
|
return typeof window === "undefined" ? undefined : (window as any)[nameOfTheGlobal];
|
||||||
}
|
}
|
||||||
|
@ -1,12 +1,10 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
|
import { BASE_URL } from "keycloakify/lib/BASE_URL";
|
||||||
|
|
||||||
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
const resourcesPath = `${BASE_URL}${keycloak_resources}/account/resources`;
|
||||||
|
|
||||||
const resourcesPath = pathJoin(PUBLIC_URL, keycloak_resources, "account", "resources");
|
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
"themeVersion": "0.0.0",
|
"themeVersion": "0.0.0",
|
||||||
@ -15,7 +13,7 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"themeName": "my-theme-name",
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
resourcesPath,
|
resourcesPath,
|
||||||
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
"resourcesCommonPath": `${resourcesPath}/${resources_common}`,
|
||||||
"resourceUrl": "#",
|
"resourceUrl": "#",
|
||||||
"accountUrl": "#",
|
"accountUrl": "#",
|
||||||
"applicationsUrl": "#",
|
"applicationsUrl": "#",
|
||||||
@ -147,6 +145,28 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"lastName": "doe",
|
"lastName": "doe",
|
||||||
"email": "john.doe@code.gouv.fr",
|
"email": "john.doe@code.gouv.fr",
|
||||||
"username": "doe_j"
|
"username": "doe_j"
|
||||||
|
},
|
||||||
|
"properties": {
|
||||||
|
"parent": "account-v1",
|
||||||
|
"kcButtonLargeClass": "btn-lg",
|
||||||
|
"locales": "ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
||||||
|
"kcButtonPrimaryClass": "btn-primary",
|
||||||
|
"accountResourceProvider": "account-v1",
|
||||||
|
"styles":
|
||||||
|
"css/account.css img/icon-sidebar-active.png img/logo.png resources-common/node_modules/patternfly/dist/css/patternfly.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
||||||
|
"kcButtonClass": "btn",
|
||||||
|
"kcButtonDefaultClass": "btn-default"
|
||||||
|
},
|
||||||
|
"sessions": {
|
||||||
|
"sessions": [
|
||||||
|
{
|
||||||
|
"ipAddress": "127.0.0.1",
|
||||||
|
"started": new Date().toString(),
|
||||||
|
"lastAccess": new Date().toString(),
|
||||||
|
"expires": new Date().toString(),
|
||||||
|
"clients": ["Chrome", "Firefox"]
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -173,5 +193,62 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
"editUsernameAllowed": true
|
"editUsernameAllowed": true
|
||||||
},
|
},
|
||||||
"stateChecker": ""
|
"stateChecker": ""
|
||||||
|
}),
|
||||||
|
id<KcContext.Sessions>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "sessions.ftl",
|
||||||
|
"sessions": {
|
||||||
|
"sessions": [
|
||||||
|
{
|
||||||
|
...kcContextCommonMock.sessions,
|
||||||
|
"ipAddress": "127.0.0.1",
|
||||||
|
"started": new Date().toString(),
|
||||||
|
"lastAccess": new Date().toString(),
|
||||||
|
"expires": new Date().toString(),
|
||||||
|
"clients": ["Chrome", "Firefox"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"stateChecker": "g6WB1FaYnKotTkiy7ZrlxvFztSqS0U8jvHsOOOb2z4g"
|
||||||
|
}),
|
||||||
|
id<KcContext.Totp>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "totp.ftl",
|
||||||
|
"totp": {
|
||||||
|
"enabled": true,
|
||||||
|
"totpSecretEncoded": "KVVF G2BY N4YX S6LB IUYT K2LH IFYE 4SBV",
|
||||||
|
"qrUrl": "#",
|
||||||
|
"totpSecretQrCode":
|
||||||
|
"iVBORw0KGgoAAAANSUhEUgAAAPYAAAD2AQAAAADNaUdlAAACM0lEQVR4Xu3OIZJgOQwDUDFd2UxiurLAVnnbHw4YGDKtSiWOn4Gxf81//7r/+q8b4HfLGBZDK9d85NmNR+sB42sXvOYrN5P1DcgYYFTGfOlbzE8gzwy3euweGizw7cfdl34/GRhlkxjKNV+5AebPXPORX1JuB9x8ZfbyyD2y1krWAKsbMq1HnqQDaLfa77p4+MqvzEGSqvSAD/2IHW2yHaigR9tX3m8dDIYGcNf3f+gDpVBZbZU77zyJ6Rlcy+qoTMG887KAPD9hsh6a1Sv3gJUHGHUAxSMzj7zqDDe7Phmt2eG+8UsMxjRGm816MAO+8VMl1R1jGHOrZB/5Zo/WXAPgxixm9Mo96vDGrM1eOto8c4Ax4wF437mifOXlpiPzCnN7Y9l95NnEMxgMY9AAGA8fucH14Y1aVb6N/cqrmyh0BVht7k1e+bU8LK0Cg5vmVq9c5vHIjOfqxDIfeTraNVTwewa4wVe+SW5N+uP1qACeudUZbqGOfA6VZV750Noq2Xx3kpveV44ZelSV1V7KFHzkWyVrrlUwG0Pl9pWnoy3vsQoME6vKI69i5osVgwWzHT7zjmJtMcNUSVn1oYMd7ZodbgowZl45VG0uVuLPUr1yc79uaQBag/mqR34xhlWyHm1prplHboCWdZ4TeZjsK8+dI+jbz1C5hl65mcpgB5dhcj8+dGO+0Ko68+lD37JDD83dpDLzzK+TrQyaVwGj6pUboGV+7+AyN8An/pf84/7rv/4/1l4OCc/1BYMAAAAASUVORK5CYII=",
|
||||||
|
"manualUrl": "#",
|
||||||
|
"totpSecret": "G4nsI8lQagRMUchH8jEG",
|
||||||
|
"otpCredentials": [],
|
||||||
|
"supportedApplications": ["totpAppFreeOTPName", "totpAppMicrosoftAuthenticatorName", "totpAppGoogleName"],
|
||||||
|
"policy": {
|
||||||
|
"algorithm": "HmacSHA1",
|
||||||
|
"digits": 6,
|
||||||
|
"lookAheadWindow": 1,
|
||||||
|
"type": "totp",
|
||||||
|
"period": 30
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"mode": "qr",
|
||||||
|
"isAppInitiatedAction": false,
|
||||||
|
"stateChecker": ""
|
||||||
|
}),
|
||||||
|
id<KcContext.Log>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "log.ftl",
|
||||||
|
"log": {
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"date": "2/21/2024, 1:28:39 PM",
|
||||||
|
"event": "login",
|
||||||
|
"ipAddress": "172.17.0.1",
|
||||||
|
"client": "security-admin-console",
|
||||||
|
"details": ["auth_method = openid-connect, username = admin"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
})
|
})
|
||||||
];
|
];
|
||||||
|
@ -6,8 +6,15 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
"kcHtmlClass": undefined,
|
"kcHtmlClass": undefined,
|
||||||
"kcBodyClass": undefined,
|
"kcBodyClass": undefined,
|
||||||
"kcButtonClass": "btn",
|
"kcButtonClass": "btn",
|
||||||
|
"kcContentWrapperClass": "row",
|
||||||
"kcButtonPrimaryClass": "btn-primary",
|
"kcButtonPrimaryClass": "btn-primary",
|
||||||
"kcButtonLargeClass": "btn-lg",
|
"kcButtonLargeClass": "btn-lg",
|
||||||
"kcButtonDefaultClass": "btn-default"
|
"kcButtonDefaultClass": "btn-default",
|
||||||
|
"kcFormClass": "form-horizontal",
|
||||||
|
"kcFormGroupClass": "form-group",
|
||||||
|
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
|
"kcLabelClass": "control-label",
|
||||||
|
"kcInputClass": "form-control",
|
||||||
|
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text"
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
138
src/account/pages/Applications.tsx
Normal file
138
src/account/pages/Applications.tsx
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
||||||
|
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
||||||
|
import type { KcContext } from "../kcContext";
|
||||||
|
import type { I18n } from "../i18n";
|
||||||
|
|
||||||
|
function isArrayWithEmptyObject(variable: any): boolean {
|
||||||
|
return Array.isArray(variable) && variable.length === 1 && typeof variable[0] === "object" && Object.keys(variable[0]).length === 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function Applications(props: PageProps<Extract<KcContext, { pageId: "applications.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
const {
|
||||||
|
url,
|
||||||
|
applications: { applications },
|
||||||
|
stateChecker
|
||||||
|
} = kcContext;
|
||||||
|
|
||||||
|
const { msg, advancedMsg } = i18n;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="applications">
|
||||||
|
<div className="row">
|
||||||
|
<div className="col-md-10">
|
||||||
|
<h2>{msg("applicationsHtmlTitle")}</h2>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<form action={url.applicationsUrl} method="post">
|
||||||
|
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
||||||
|
<input type="hidden" id="referrer" name="referrer" value={stateChecker} />
|
||||||
|
|
||||||
|
<table className="table table-striped table-bordered">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<td>{msg("application")}</td>
|
||||||
|
<td>{msg("availableRoles")}</td>
|
||||||
|
<td>{msg("grantedPermissions")}</td>
|
||||||
|
<td>{msg("additionalGrants")}</td>
|
||||||
|
<td>{msg("action")}</td>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
|
||||||
|
<tbody>
|
||||||
|
{applications.map(application => (
|
||||||
|
<tr key={application.client.clientId}>
|
||||||
|
<td>
|
||||||
|
{application.effectiveUrl && (
|
||||||
|
<a href={application.effectiveUrl}>
|
||||||
|
{(application.client.name && advancedMsg(application.client.name)) || application.client.clientId}
|
||||||
|
</a>
|
||||||
|
)}
|
||||||
|
{!application.effectiveUrl &&
|
||||||
|
((application.client.name && advancedMsg(application.client.name)) || application.client.clientId)}
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td>
|
||||||
|
{!isArrayWithEmptyObject(application.realmRolesAvailable) &&
|
||||||
|
application.realmRolesAvailable.map(role => (
|
||||||
|
<span key={role.name}>
|
||||||
|
{role.description ? advancedMsg(role.description) : advancedMsg(role.name)}
|
||||||
|
{role !== application.realmRolesAvailable[application.realmRolesAvailable.length - 1] && ", "}
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
|
{!isArrayWithEmptyObject(application.realmRolesAvailable) && application.resourceRolesAvailable && ", "}
|
||||||
|
{application.resourceRolesAvailable &&
|
||||||
|
Object.keys(application.resourceRolesAvailable).map(resource => (
|
||||||
|
<span key={resource}>
|
||||||
|
{!isArrayWithEmptyObject(application.realmRolesAvailable) && ", "}
|
||||||
|
{application.resourceRolesAvailable[resource].map(clientRole => (
|
||||||
|
<span key={clientRole.roleName}>
|
||||||
|
{clientRole.roleDescription
|
||||||
|
? advancedMsg(clientRole.roleDescription)
|
||||||
|
: advancedMsg(clientRole.roleName)}{" "}
|
||||||
|
{msg("inResource")}{" "}
|
||||||
|
<strong>
|
||||||
|
{clientRole.clientName ? advancedMsg(clientRole.clientName) : clientRole.clientId}
|
||||||
|
</strong>
|
||||||
|
{clientRole !==
|
||||||
|
application.resourceRolesAvailable[resource][
|
||||||
|
application.resourceRolesAvailable[resource].length - 1
|
||||||
|
] && ", "}
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td>
|
||||||
|
{application.client.consentRequired ? (
|
||||||
|
application.clientScopesGranted.map(claim => (
|
||||||
|
<span key={claim}>
|
||||||
|
{advancedMsg(claim)}
|
||||||
|
{claim !== application.clientScopesGranted[application.clientScopesGranted.length - 1] && ", "}
|
||||||
|
</span>
|
||||||
|
))
|
||||||
|
) : (
|
||||||
|
<strong>{msg("fullAccess")}</strong>
|
||||||
|
)}
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td>
|
||||||
|
{application.additionalGrants.map(grant => (
|
||||||
|
<span key={grant}>
|
||||||
|
{advancedMsg(grant)}
|
||||||
|
{grant !== application.additionalGrants[application.additionalGrants.length - 1] && ", "}
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
|
</td>
|
||||||
|
|
||||||
|
<td>
|
||||||
|
{(application.client.consentRequired && application.clientScopesGranted.length > 0) ||
|
||||||
|
application.additionalGrants.length > 0 ? (
|
||||||
|
<button
|
||||||
|
type="submit"
|
||||||
|
className={clsx(getClassName("kcButtonPrimaryClass"), getClassName("kcButtonClass"))}
|
||||||
|
id={`revoke-${application.client.clientId}`}
|
||||||
|
name="clientId"
|
||||||
|
value={application.client.id}
|
||||||
|
>
|
||||||
|
{msg("revoke")}
|
||||||
|
</button>
|
||||||
|
) : null}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
70
src/account/pages/Log.tsx
Normal file
70
src/account/pages/Log.tsx
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
||||||
|
import type { KcContext } from "../kcContext";
|
||||||
|
import type { I18n } from "../i18n";
|
||||||
|
import { Key } from "react";
|
||||||
|
import { useGetClassName } from "../lib/useGetClassName";
|
||||||
|
|
||||||
|
export default function Log(props: PageProps<Extract<KcContext, { pageId: "log.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
const { log } = kcContext;
|
||||||
|
|
||||||
|
const { msg } = i18n;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="log">
|
||||||
|
<div className={getClassName("kcContentWrapperClass")}>
|
||||||
|
<div className="col-md-10">
|
||||||
|
<h2>{msg("accountLogHtmlTitle")}</h2>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<table className="table table-striped table-bordered">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<td>{msg("date")}</td>
|
||||||
|
<td>{msg("event")}</td>
|
||||||
|
<td>{msg("ip")}</td>
|
||||||
|
<td>{msg("client")}</td>
|
||||||
|
<td>{msg("details")}</td>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
|
||||||
|
<tbody>
|
||||||
|
{log.events.map(
|
||||||
|
(
|
||||||
|
event: {
|
||||||
|
date: string | number | Date;
|
||||||
|
event: string;
|
||||||
|
ipAddress: string;
|
||||||
|
client: any;
|
||||||
|
details: any[];
|
||||||
|
},
|
||||||
|
index: Key | null | undefined
|
||||||
|
) => (
|
||||||
|
<tr key={index}>
|
||||||
|
<td>{event.date ? new Date(event.date).toLocaleString() : ""}</td>
|
||||||
|
<td>{event.event}</td>
|
||||||
|
<td>{event.ipAddress}</td>
|
||||||
|
<td>{event.client || ""}</td>
|
||||||
|
<td>
|
||||||
|
{event.details.map((detail, detailIndex) => (
|
||||||
|
<span key={detailIndex}>
|
||||||
|
{`${detail.key} = ${detail.value}`}
|
||||||
|
{detailIndex < event.details.length - 1 && ", "}
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
)
|
||||||
|
)}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
@ -1,10 +1,11 @@
|
|||||||
import type { LazyExoticComponent } from "react";
|
|
||||||
import type { I18n } from "keycloakify/account/i18n";
|
import type { I18n } from "keycloakify/account/i18n";
|
||||||
import type { TemplateProps, ClassKey } from "keycloakify/account/TemplateProps";
|
import type { TemplateProps, ClassKey } from "keycloakify/account/TemplateProps";
|
||||||
|
import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
|
||||||
|
import type { KcContext } from "keycloakify/account/kcContext";
|
||||||
|
|
||||||
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
export type PageProps<NarowedKcContext = KcContext, I18nExtended extends I18n = I18n> = {
|
||||||
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: NarowedKcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
classes?: Partial<Record<ClassKey, string>>;
|
classes?: Partial<Record<ClassKey, string>>;
|
||||||
|
68
src/account/pages/Sessions.tsx
Normal file
68
src/account/pages/Sessions.tsx
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
||||||
|
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
||||||
|
import type { KcContext } from "../kcContext";
|
||||||
|
import type { I18n } from "../i18n";
|
||||||
|
|
||||||
|
export default function Sessions(props: PageProps<Extract<KcContext, { pageId: "sessions.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
console.log({ kcContext });
|
||||||
|
const { url, stateChecker, sessions } = kcContext;
|
||||||
|
|
||||||
|
const { msg } = i18n;
|
||||||
|
console.log({ sdf: kcContext.locale?.supported });
|
||||||
|
console.log({ asdf: "asdf" });
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="sessions">
|
||||||
|
<div className={getClassName("kcContentWrapperClass")}>
|
||||||
|
<div className="col-md-10">
|
||||||
|
<h2>{msg("sessionsHtmlTitle")}</h2>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<table className="table table-striped table-bordered">
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>{msg("ip")}</th>
|
||||||
|
<th>{msg("started")}</th>
|
||||||
|
<th>{msg("lastAccess")}</th>
|
||||||
|
<th>{msg("expires")}</th>
|
||||||
|
<th>{msg("clients")}</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
|
||||||
|
<tbody role="rowgroup">
|
||||||
|
{sessions.sessions.map((session, index: number) => (
|
||||||
|
<tr key={index}>
|
||||||
|
<td>{session.ipAddress}</td>
|
||||||
|
<td>{session?.started}</td>
|
||||||
|
<td>{session?.lastAccess}</td>
|
||||||
|
<td>{session?.expires}</td>
|
||||||
|
<td>
|
||||||
|
{session.clients.map((client: string, clientIndex: number) => (
|
||||||
|
<div key={clientIndex}>
|
||||||
|
{client}
|
||||||
|
<br />
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<form action={url.sessionsUrl} method="post">
|
||||||
|
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
||||||
|
<button id="logout-all-sessions" type="submit" className={clsx(getClassName("kcButtonDefaultClass"), getClassName("kcButtonClass"))}>
|
||||||
|
{msg("doLogOutAllSessions")}
|
||||||
|
</button>
|
||||||
|
</form>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
236
src/account/pages/Totp.tsx
Normal file
236
src/account/pages/Totp.tsx
Normal file
@ -0,0 +1,236 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
||||||
|
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
||||||
|
import type { KcContext } from "../kcContext";
|
||||||
|
import type { I18n } from "../i18n";
|
||||||
|
import { MessageKey } from "keycloakify/account/i18n/i18n";
|
||||||
|
|
||||||
|
export default function Totp(props: PageProps<Extract<KcContext, { pageId: "totp.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
const { totp, mode, url, messagesPerField, stateChecker } = kcContext;
|
||||||
|
|
||||||
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
|
const algToKeyUriAlg: Record<(typeof kcContext)["totp"]["policy"]["algorithm"], string> = {
|
||||||
|
"HmacSHA1": "SHA1",
|
||||||
|
"HmacSHA256": "SHA256",
|
||||||
|
"HmacSHA512": "SHA512"
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="totp">
|
||||||
|
<>
|
||||||
|
<div className="row">
|
||||||
|
<div className="col-md-10">
|
||||||
|
<h2>{msg("authenticatorTitle")}</h2>
|
||||||
|
</div>
|
||||||
|
{totp.otpCredentials.length === 0 && (
|
||||||
|
<div className="subtitle col-md-2">
|
||||||
|
<span className="required">*</span>
|
||||||
|
{msg("requiredFields")}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
{totp.enabled && (
|
||||||
|
<table className="table table-bordered table-striped">
|
||||||
|
<thead>
|
||||||
|
{totp.otpCredentials.length > 1 ? (
|
||||||
|
<tr>
|
||||||
|
<th colSpan={4}>{msg("configureAuthenticators")}</th>
|
||||||
|
</tr>
|
||||||
|
) : (
|
||||||
|
<tr>
|
||||||
|
<th colSpan={3}>{msg("configureAuthenticators")}</th>
|
||||||
|
</tr>
|
||||||
|
)}
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
{totp.otpCredentials.map((credential, index) => (
|
||||||
|
<tr key={index}>
|
||||||
|
<td className="provider">{msg("mobile")}</td>
|
||||||
|
{totp.otpCredentials.length > 1 && <td className="provider">{credential.id}</td>}
|
||||||
|
<td className="provider">{credential.userLabel || ""}</td>
|
||||||
|
<td className="action">
|
||||||
|
<form action={url.totpUrl} method="post" className="form-inline">
|
||||||
|
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
||||||
|
<input type="hidden" id="submitAction" name="submitAction" value="Delete" />
|
||||||
|
<input type="hidden" id="credentialId" name="credentialId" value={credential.id} />
|
||||||
|
<button id={`remove-mobile-${index}`} className="btn btn-default">
|
||||||
|
<i className="pficon pficon-delete"></i>
|
||||||
|
</button>
|
||||||
|
</form>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
)}
|
||||||
|
{!totp.enabled && (
|
||||||
|
<div>
|
||||||
|
<hr />
|
||||||
|
<ol id="kc-totp-settings">
|
||||||
|
<li>
|
||||||
|
<p>{msg("totpStep1")}</p>
|
||||||
|
|
||||||
|
<ul id="kc-totp-supported-apps">
|
||||||
|
{totp.supportedApplications.map(app => (
|
||||||
|
<li key={app}>{msg(app as MessageKey)}</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
{mode && mode == "manual" ? (
|
||||||
|
<>
|
||||||
|
<li>
|
||||||
|
<p>{msg("totpManualStep2")}</p>
|
||||||
|
<p>
|
||||||
|
<span id="kc-totp-secret-key">{totp.totpSecretEncoded}</span>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<a href={totp.qrUrl} id="mode-barcode">
|
||||||
|
{msg("totpScanBarcode")}
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<p>{msg("totpManualStep3")}</p>
|
||||||
|
<p>
|
||||||
|
<ul>
|
||||||
|
<li id="kc-totp-type">
|
||||||
|
{msg("totpType")}: {msg(`totp.${totp.policy.type}`)}
|
||||||
|
</li>
|
||||||
|
<li id="kc-totp-algorithm">
|
||||||
|
{msg("totpAlgorithm")}: {algToKeyUriAlg?.[totp.policy.algorithm] ?? totp.policy.algorithm}
|
||||||
|
</li>
|
||||||
|
<li id="kc-totp-digits">
|
||||||
|
{msg("totpDigits")}: {totp.policy.digits}
|
||||||
|
</li>
|
||||||
|
{totp.policy.type === "totp" ? (
|
||||||
|
<li id="kc-totp-period">
|
||||||
|
{msg("totpInterval")}: {totp.policy.period}
|
||||||
|
</li>
|
||||||
|
) : (
|
||||||
|
<li id="kc-totp-counter">
|
||||||
|
{msg("totpCounter")}: {totp.policy.initialCounter}
|
||||||
|
</li>
|
||||||
|
)}
|
||||||
|
</ul>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
</>
|
||||||
|
) : (
|
||||||
|
<li>
|
||||||
|
<p>{msg("totpStep2")}</p>
|
||||||
|
<p>
|
||||||
|
<img
|
||||||
|
id="kc-totp-secret-qr-code"
|
||||||
|
src={`data:image/png;base64, ${totp.totpSecretQrCode}`}
|
||||||
|
alt="Figure: Barcode"
|
||||||
|
/>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<a href={totp.manualUrl} id="mode-manual">
|
||||||
|
{msg("totpUnableToScan")}
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
</li>
|
||||||
|
)}
|
||||||
|
<li>
|
||||||
|
<p>{msg("totpStep3")}</p>
|
||||||
|
<p>{msg("totpStep3DeviceName")}</p>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
<hr />
|
||||||
|
<form action={url.totpUrl} className={getClassName("kcFormClass")} id="kc-totp-settings-form" method="post">
|
||||||
|
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div className="col-sm-2 col-md-2">
|
||||||
|
<label htmlFor="totp" className="control-label">
|
||||||
|
{msg("authenticatorCode")}
|
||||||
|
</label>
|
||||||
|
<span className="required">*</span>
|
||||||
|
</div>
|
||||||
|
<div className="col-sm-10 col-md-10">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
id="totp"
|
||||||
|
name="totp"
|
||||||
|
autoComplete="off"
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
aria-invalid={messagesPerField.existsError("totp")}
|
||||||
|
/>
|
||||||
|
|
||||||
|
{messagesPerField.existsError("totp") && (
|
||||||
|
<span id="input-error-otp-code" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
|
||||||
|
{messagesPerField.get("totp")}
|
||||||
|
</span>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
<input type="hidden" id="totpSecret" name="totpSecret" value={totp.totpSecret} />
|
||||||
|
{mode && <input type="hidden" id="mode" value={mode} />}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div className="col-sm-2 col-md-2">
|
||||||
|
<label htmlFor="userLabel" className={getClassName("kcLabelClass")}>
|
||||||
|
{msg("totpDeviceName")}
|
||||||
|
</label>
|
||||||
|
{totp.otpCredentials.length >= 1 && <span className="required">*</span>}
|
||||||
|
</div>
|
||||||
|
<div className="col-sm-10 col-md-10">
|
||||||
|
<input
|
||||||
|
type="text"
|
||||||
|
id="userLabel"
|
||||||
|
name="userLabel"
|
||||||
|
autoComplete="off"
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
aria-invalid={messagesPerField.existsError("userLabel")}
|
||||||
|
/>
|
||||||
|
{messagesPerField.existsError("userLabel") && (
|
||||||
|
<span id="input-error-otp-label" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
|
||||||
|
{messagesPerField.get("userLabel")}
|
||||||
|
</span>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="kc-form-buttons" className={clsx(getClassName("kcFormGroupClass"), "text-right")}>
|
||||||
|
<div className={getClassName("kcInputWrapperClass")}>
|
||||||
|
<input
|
||||||
|
type="submit"
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonPrimaryClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
id="saveTOTPBtn"
|
||||||
|
value={msgStr("doSave")}
|
||||||
|
/>
|
||||||
|
<button
|
||||||
|
type="submit"
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonDefaultClass"),
|
||||||
|
getClassName("kcButtonLargeClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
id="cancelTOTPBtn"
|
||||||
|
name="submitAction"
|
||||||
|
value="Cancel"
|
||||||
|
>
|
||||||
|
{msg("doCancel")}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
@ -1,9 +1,13 @@
|
|||||||
|
export const nameOfTheGlobal = "kcContext";
|
||||||
export const keycloak_resources = "keycloak-resources";
|
export const keycloak_resources = "keycloak-resources";
|
||||||
export const resources_common = "resources-common";
|
export const resources_common = "resources-common";
|
||||||
export const lastKeycloakVersionWithAccountV1 = "21.1.2";
|
export const lastKeycloakVersionWithAccountV1 = "21.1.2";
|
||||||
|
export const resolvedViteConfigJsonBasename = "vite.json";
|
||||||
|
export const basenameOfTheKeycloakifyResourcesDir = "build";
|
||||||
|
|
||||||
export const themeTypes = ["login", "account"] as const;
|
export const themeTypes = ["login", "account"] as const;
|
||||||
export const retrocompatPostfix = "_retrocompat";
|
export const accountV1ThemeName = "account-v1";
|
||||||
export const accountV1 = "account-v1";
|
|
||||||
|
|
||||||
export type ThemeType = (typeof themeTypes)[number];
|
export type ThemeType = (typeof themeTypes)[number];
|
||||||
|
|
||||||
|
export const keycloakifyBuildOptionsForPostPostBuildScriptEnvName = "KEYCLOAKIFY_BUILD_OPTIONS_POST_POST_BUILD_SCRIPT";
|
||||||
|
@ -1,20 +1,44 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
|
||||||
import { downloadKeycloakStaticResources } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
|
import { downloadKeycloakStaticResources, type BuildOptionsLike } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
import { readBuildOptions } from "./keycloakify/buildOptions";
|
||||||
import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
|
import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
|
||||||
|
import { readThisNpmProjectVersion } from "./tools/readThisNpmProjectVersion";
|
||||||
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
import { rmSync } from "./tools/fs.rmSync";
|
||||||
|
|
||||||
(async () => {
|
export async function copyKeycloakResourcesToPublic(params: { processArgv: string[] }) {
|
||||||
const reactAppRootDirPath = process.cwd();
|
const { processArgv } = params;
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({ processArgv });
|
||||||
reactAppRootDirPath,
|
|
||||||
"processArgv": process.argv.slice(2)
|
const destDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
|
||||||
|
|
||||||
|
const keycloakifyBuildinfoFilePath = pathJoin(destDirPath, "keycloakify.buildinfo");
|
||||||
|
|
||||||
|
const { keycloakifyBuildinfoRaw } = generateKeycloakifyBuildinfoRaw({
|
||||||
|
destDirPath,
|
||||||
|
"keycloakifyVersion": readThisNpmProjectVersion(),
|
||||||
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
const reservedDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
|
skip_if_already_done: {
|
||||||
|
if (!fs.existsSync(keycloakifyBuildinfoFilePath)) {
|
||||||
|
break skip_if_already_done;
|
||||||
|
}
|
||||||
|
|
||||||
|
const keycloakifyBuildinfoRaw_previousRun = fs.readFileSync(keycloakifyBuildinfoFilePath).toString("utf8");
|
||||||
|
|
||||||
|
if (keycloakifyBuildinfoRaw_previousRun !== keycloakifyBuildinfoRaw) {
|
||||||
|
break skip_if_already_done;
|
||||||
|
}
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
rmSync(destDirPath, { "force": true, "recursive": true });
|
||||||
|
|
||||||
for (const themeType of themeTypes) {
|
for (const themeType of themeTypes) {
|
||||||
await downloadKeycloakStaticResources({
|
await downloadKeycloakStaticResources({
|
||||||
@ -27,14 +51,13 @@ import * as fs from "fs";
|
|||||||
}
|
}
|
||||||
})(),
|
})(),
|
||||||
themeType,
|
themeType,
|
||||||
"themeDirPath": reservedDirPath,
|
"themeDirPath": destDirPath,
|
||||||
"usedResources": undefined,
|
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(reservedDirPath, "README.txt"),
|
pathJoin(destDirPath, "README.txt"),
|
||||||
Buffer.from(
|
Buffer.from(
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
[
|
[
|
||||||
@ -44,7 +67,46 @@ import * as fs from "fs";
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(buildOptions.publicDirPath, "keycloak-resources", ".gitignore"), Buffer.from("*", "utf8"));
|
fs.writeFileSync(pathJoin(buildOptions.publicDirPath, keycloak_resources, ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
|
|
||||||
console.log(`${pathRelative(reactAppRootDirPath, reservedDirPath)} directory created.`);
|
fs.writeFileSync(keycloakifyBuildinfoFilePath, Buffer.from(keycloakifyBuildinfoRaw, "utf8"));
|
||||||
})();
|
}
|
||||||
|
|
||||||
|
export function generateKeycloakifyBuildinfoRaw(params: {
|
||||||
|
destDirPath: string;
|
||||||
|
keycloakifyVersion: string;
|
||||||
|
buildOptions: BuildOptionsLike & {
|
||||||
|
loginThemeResourcesFromKeycloakVersion: string;
|
||||||
|
};
|
||||||
|
}) {
|
||||||
|
const { destDirPath, keycloakifyVersion, buildOptions } = params;
|
||||||
|
|
||||||
|
const { cacheDirPath, npmWorkspaceRootDirPath, loginThemeResourcesFromKeycloakVersion, ...rest } = buildOptions;
|
||||||
|
|
||||||
|
assert<Equals<typeof rest, {}>>(true);
|
||||||
|
|
||||||
|
const keycloakifyBuildinfoRaw = JSON.stringify(
|
||||||
|
{
|
||||||
|
keycloakifyVersion,
|
||||||
|
"buildOptions": {
|
||||||
|
loginThemeResourcesFromKeycloakVersion,
|
||||||
|
"cacheDirPath": pathRelative(destDirPath, cacheDirPath),
|
||||||
|
"npmWorkspaceRootDirPath": pathRelative(destDirPath, npmWorkspaceRootDirPath)
|
||||||
|
}
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
2
|
||||||
|
);
|
||||||
|
|
||||||
|
return { keycloakifyBuildinfoRaw };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function main() {
|
||||||
|
await copyKeycloakResourcesToPublic({
|
||||||
|
"processArgv": process.argv.slice(2)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (require.main === module) {
|
||||||
|
main();
|
||||||
|
}
|
||||||
|
@ -1,16 +1,19 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { downloadAndUnzip } from "./tools/downloadAndUnzip";
|
import { downloadAndUnzip } from "./downloadAndUnzip";
|
||||||
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
||||||
import { getLogger } from "./tools/logger";
|
import { getLogger } from "./tools/logger";
|
||||||
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
import { readBuildOptions, type BuildOptions } from "./keycloakify/buildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { BuildOptions } from "./keycloakify/BuildOptions";
|
|
||||||
import * as child_process from "child_process";
|
import * as child_process from "child_process";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
import { rmSync } from "./tools/fs.rmSync";
|
||||||
|
import { lastKeycloakVersionWithAccountV1 } from "./constants";
|
||||||
|
import { transformCodebase } from "./tools/transformCodebase";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
cacheDirPath: string;
|
cacheDirPath: string;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
@ -19,11 +22,10 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
const { keycloakVersion, destDirPath, buildOptions } = params;
|
const { keycloakVersion, destDirPath, buildOptions } = params;
|
||||||
|
|
||||||
await downloadAndUnzip({
|
await downloadAndUnzip({
|
||||||
"doUseCache": true,
|
|
||||||
"cacheDirPath": buildOptions.cacheDirPath,
|
|
||||||
destDirPath,
|
destDirPath,
|
||||||
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
||||||
"specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
|
"specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
|
||||||
|
buildOptions,
|
||||||
"preCacheTransform": {
|
"preCacheTransform": {
|
||||||
"actionCacheId": "npm install and build",
|
"actionCacheId": "npm install and build",
|
||||||
"action": async ({ destDirPath }) => {
|
"action": async ({ destDirPath }) => {
|
||||||
@ -48,14 +50,42 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
repatriate_common_resources_from_base_login_theme: {
|
||||||
|
const baseLoginThemeResourceDir = pathJoin(destDirPath, "base", "login", "resources");
|
||||||
|
|
||||||
|
if (!fs.existsSync(baseLoginThemeResourceDir)) {
|
||||||
|
break repatriate_common_resources_from_base_login_theme;
|
||||||
|
}
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": baseLoginThemeResourceDir,
|
||||||
|
"destDirPath": pathJoin(destDirPath, "keycloak", "login", "resources")
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
install_and_move_to_common_resources_generated_in_keycloak_v2: {
|
install_and_move_to_common_resources_generated_in_keycloak_v2: {
|
||||||
|
if (!fs.readFileSync(pathJoin(destDirPath, "keycloak", "login", "theme.properties")).toString("utf8").includes("web_modules")) {
|
||||||
|
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
||||||
|
}
|
||||||
|
|
||||||
const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
|
const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
|
||||||
|
|
||||||
if (!fs.existsSync(accountV2DirSrcDirPath)) {
|
if (!fs.existsSync(accountV2DirSrcDirPath)) {
|
||||||
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
||||||
}
|
}
|
||||||
|
|
||||||
child_process.execSync("npm install", { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
const packageManager = fs.existsSync(pathJoin(accountV2DirSrcDirPath, "pnpm-lock.yaml")) ? "pnpm" : "npm";
|
||||||
|
|
||||||
|
if (packageManager === "pnpm") {
|
||||||
|
try {
|
||||||
|
child_process.execSync(`which pnpm`);
|
||||||
|
} catch {
|
||||||
|
console.log(`Installing pnpm globally`);
|
||||||
|
child_process.execSync(`npm install -g pnpm`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
child_process.execSync(`${packageManager} install`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
|
const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
|
||||||
|
|
||||||
@ -64,17 +94,173 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
||||||
|
|
||||||
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
||||||
.replace("npm run check-types", "true")
|
.replace(`${packageManager} run check-types`, "true")
|
||||||
.replace("npm run babel", "true");
|
.replace(`${packageManager} run babel`, "true");
|
||||||
|
|
||||||
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
||||||
|
|
||||||
child_process.execSync("npm run build", { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
child_process.execSync(`${packageManager} run build`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
||||||
|
|
||||||
fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
|
fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
remove_keycloak_v2: {
|
||||||
|
const keycloakV2DirPath = pathJoin(destDirPath, "keycloak.v2");
|
||||||
|
|
||||||
|
if (!fs.existsSync(keycloakV2DirPath)) {
|
||||||
|
break remove_keycloak_v2;
|
||||||
|
}
|
||||||
|
|
||||||
|
rmSync(keycloakV2DirPath, { "recursive": true });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note, this is an optimization for reducing the size of the jar
|
||||||
|
remove_unused_node_modules: {
|
||||||
|
const nodeModuleDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
|
||||||
|
|
||||||
|
if (!fs.existsSync(nodeModuleDirPath)) {
|
||||||
|
break remove_unused_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
const toDeletePerfixes = [
|
||||||
|
"angular",
|
||||||
|
"bootstrap",
|
||||||
|
"rcue",
|
||||||
|
"font-awesome",
|
||||||
|
"ng-file-upload",
|
||||||
|
pathJoin("patternfly", "dist", "sass"),
|
||||||
|
pathJoin("patternfly", "dist", "less"),
|
||||||
|
pathJoin("patternfly", "dist", "js"),
|
||||||
|
"d3",
|
||||||
|
pathJoin("jquery", "src"),
|
||||||
|
"c3",
|
||||||
|
"core-js",
|
||||||
|
"eonasdan-bootstrap-datetimepicker",
|
||||||
|
"moment",
|
||||||
|
"react",
|
||||||
|
"patternfly-bootstrap-treeview",
|
||||||
|
"popper.js",
|
||||||
|
"tippy.js",
|
||||||
|
"jquery-match-height",
|
||||||
|
"google-code-prettify",
|
||||||
|
"patternfly-bootstrap-combobox",
|
||||||
|
"focus-trap",
|
||||||
|
"tabbable",
|
||||||
|
"scheduler",
|
||||||
|
"@types",
|
||||||
|
"datatables.net",
|
||||||
|
"datatables.net-colreorder",
|
||||||
|
"tslib",
|
||||||
|
"prop-types",
|
||||||
|
"file-selector",
|
||||||
|
"datatables.net-colreorder-bs",
|
||||||
|
"object-assign",
|
||||||
|
"warning",
|
||||||
|
"js-tokens",
|
||||||
|
"loose-envify",
|
||||||
|
"prop-types-extra",
|
||||||
|
"attr-accept",
|
||||||
|
"datatables.net-select",
|
||||||
|
"drmonty-datatables-colvis",
|
||||||
|
"datatables.net-bs",
|
||||||
|
pathJoin("@patternfly", "react"),
|
||||||
|
pathJoin("@patternfly", "patternfly", "docs")
|
||||||
|
];
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": nodeModuleDirPath,
|
||||||
|
"destDirPath": nodeModuleDirPath,
|
||||||
|
"transformSourceCode": ({ sourceCode, fileRelativePath }) => {
|
||||||
|
if (fileRelativePath.endsWith(".map")) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (toDeletePerfixes.find(prefix => fileRelativePath.startsWith(prefix)) !== undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (fileRelativePath.startsWith(pathJoin("patternfly", "dist", "fonts"))) {
|
||||||
|
if (
|
||||||
|
!fileRelativePath.endsWith(".woff2") &&
|
||||||
|
!fileRelativePath.endsWith(".woff") &&
|
||||||
|
!fileRelativePath.endsWith(".ttf")
|
||||||
|
) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Just like node_modules
|
||||||
|
remove_unused_lib: {
|
||||||
|
const libDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "lib");
|
||||||
|
|
||||||
|
if (!fs.existsSync(libDirPath)) {
|
||||||
|
break remove_unused_lib;
|
||||||
|
}
|
||||||
|
|
||||||
|
const toDeletePerfixes = ["ui-ace", "filesaver", "fileupload", "angular", "ui-ace"];
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": libDirPath,
|
||||||
|
"destDirPath": libDirPath,
|
||||||
|
"transformSourceCode": ({ sourceCode, fileRelativePath }) => {
|
||||||
|
if (fileRelativePath.endsWith(".map")) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (toDeletePerfixes.find(prefix => fileRelativePath.startsWith(prefix)) !== undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
last_account_v1_transformations: {
|
||||||
|
if (lastKeycloakVersionWithAccountV1 !== keycloakVersion) {
|
||||||
|
break last_account_v1_transformations;
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const accountCssFilePath = pathJoin(destDirPath, "keycloak", "account", "resources", "css", "account.css");
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
accountCssFilePath,
|
||||||
|
Buffer.from(fs.readFileSync(accountCssFilePath).toString("utf8").replace("top: -34px;", "top: -34px !important;"), "utf8")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Note, this is an optimization for reducing the size of the jar,
|
||||||
|
// For this version we know exactly which resources are used.
|
||||||
|
{
|
||||||
|
const nodeModulesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
|
||||||
|
|
||||||
|
const toKeepPrefixes = [
|
||||||
|
...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(fileBasename =>
|
||||||
|
pathJoin("patternfly", "dist", "css", fileBasename)
|
||||||
|
),
|
||||||
|
pathJoin("patternfly", "dist", "fonts")
|
||||||
|
];
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": nodeModulesDirPath,
|
||||||
|
"destDirPath": nodeModulesDirPath,
|
||||||
|
"transformSourceCode": ({ sourceCode, fileRelativePath }) => {
|
||||||
|
if (toKeepPrefixes.find(prefix => fileRelativePath.startsWith(prefix)) === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@ -82,7 +268,6 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
"reactAppRootDirPath": process.cwd(),
|
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
|
203
src/bin/downloadAndUnzip.ts
Normal file
203
src/bin/downloadAndUnzip.ts
Normal file
@ -0,0 +1,203 @@
|
|||||||
|
import { createHash } from "crypto";
|
||||||
|
import { mkdir, writeFile, unlink } from "fs/promises";
|
||||||
|
import fetch from "make-fetch-happen";
|
||||||
|
import { dirname as pathDirname, join as pathJoin, basename as pathBasename } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { transformCodebase } from "./tools/transformCodebase";
|
||||||
|
import { unzip, zip } from "./tools/unzip";
|
||||||
|
import { rm } from "./tools/fs.rm";
|
||||||
|
import * as child_process from "child_process";
|
||||||
|
import { existsAsync } from "./tools/fs.existsAsync";
|
||||||
|
import type { BuildOptions } from "./keycloakify/buildOptions";
|
||||||
|
import { getProxyFetchOptions } from "./tools/fetchProxyOptions";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
cacheDirPath: string;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export async function downloadAndUnzip(params: {
|
||||||
|
url: string;
|
||||||
|
destDirPath: string;
|
||||||
|
specificDirsToExtract?: string[];
|
||||||
|
preCacheTransform?: {
|
||||||
|
actionCacheId: string;
|
||||||
|
action: (params: { destDirPath: string }) => Promise<void>;
|
||||||
|
};
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
}) {
|
||||||
|
const { url, destDirPath, specificDirsToExtract, preCacheTransform, buildOptions } = params;
|
||||||
|
|
||||||
|
const { extractDirPath, zipFilePath } = (() => {
|
||||||
|
const zipFileBasenameWithoutExt = generateFileNameFromURL({
|
||||||
|
url,
|
||||||
|
"preCacheTransform":
|
||||||
|
preCacheTransform === undefined
|
||||||
|
? undefined
|
||||||
|
: {
|
||||||
|
"actionCacheId": preCacheTransform.actionCacheId,
|
||||||
|
"actionFootprint": preCacheTransform.action.toString()
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const zipFilePath = pathJoin(buildOptions.cacheDirPath, `${zipFileBasenameWithoutExt}.zip`);
|
||||||
|
const extractDirPath = pathJoin(buildOptions.cacheDirPath, `tmp_unzip_${zipFileBasenameWithoutExt}`);
|
||||||
|
|
||||||
|
return { zipFilePath, extractDirPath };
|
||||||
|
})();
|
||||||
|
|
||||||
|
download_zip_and_transform: {
|
||||||
|
if (await existsAsync(zipFilePath)) {
|
||||||
|
break download_zip_and_transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
const { response, isFromRemoteCache } = await (async () => {
|
||||||
|
const proxyFetchOptions = await getProxyFetchOptions({
|
||||||
|
"npmWorkspaceRootDirPath": buildOptions.npmWorkspaceRootDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await fetch(
|
||||||
|
`https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/${pathBasename(zipFilePath)}`,
|
||||||
|
proxyFetchOptions
|
||||||
|
);
|
||||||
|
|
||||||
|
if (response.status === 200) {
|
||||||
|
return {
|
||||||
|
response,
|
||||||
|
"isFromRemoteCache": true
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"response": await fetch(url, proxyFetchOptions),
|
||||||
|
"isFromRemoteCache": false
|
||||||
|
};
|
||||||
|
})();
|
||||||
|
|
||||||
|
await mkdir(pathDirname(zipFilePath), { "recursive": true });
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The correct way to fix this is to upgrade node-fetch beyond 3.2.5
|
||||||
|
* (see https://github.com/node-fetch/node-fetch/issues/1295#issuecomment-1144061991.)
|
||||||
|
* Unfortunately, octokit (a dependency of keycloakify) also uses node-fetch, and
|
||||||
|
* does not support node-fetch 3.x. So we stick around with this band-aid until
|
||||||
|
* octokit upgrades.
|
||||||
|
*/
|
||||||
|
response.body?.setMaxListeners(Number.MAX_VALUE);
|
||||||
|
assert(typeof response.body !== "undefined" && response.body != null);
|
||||||
|
|
||||||
|
await writeFile(zipFilePath, response.body);
|
||||||
|
|
||||||
|
if (isFromRemoteCache) {
|
||||||
|
break download_zip_and_transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (specificDirsToExtract === undefined && preCacheTransform === undefined) {
|
||||||
|
break download_zip_and_transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
|
||||||
|
|
||||||
|
try {
|
||||||
|
await preCacheTransform?.action({
|
||||||
|
"destDirPath": extractDirPath
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
await Promise.all([rm(extractDirPath, { "recursive": true }), unlink(zipFilePath)]);
|
||||||
|
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
await unlink(zipFilePath);
|
||||||
|
|
||||||
|
await zip(extractDirPath, zipFilePath);
|
||||||
|
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
|
||||||
|
upload_to_remot_cache_if_admin: {
|
||||||
|
const githubToken = process.env["KEYCLOAKIFY_ADMIN_GITHUB_PERSONAL_ACCESS_TOKEN"];
|
||||||
|
|
||||||
|
if (githubToken === undefined) {
|
||||||
|
break upload_to_remot_cache_if_admin;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log("uploading to remote cache");
|
||||||
|
|
||||||
|
try {
|
||||||
|
child_process.execSync(`which putasset`);
|
||||||
|
} catch {
|
||||||
|
child_process.execSync(`npm install -g putasset`);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
child_process.execFileSync("putasset", [
|
||||||
|
"--owner",
|
||||||
|
"keycloakify",
|
||||||
|
"--repo",
|
||||||
|
"keycloakify",
|
||||||
|
"--tag",
|
||||||
|
"v0.0.1",
|
||||||
|
"--filename",
|
||||||
|
zipFilePath,
|
||||||
|
"--token",
|
||||||
|
githubToken
|
||||||
|
]);
|
||||||
|
} catch {
|
||||||
|
console.log("upload failed, asset probably already exists in remote cache");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await unzip(zipFilePath, extractDirPath);
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": extractDirPath,
|
||||||
|
"destDirPath": destDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
|
|
||||||
|
function generateFileNameFromURL(params: {
|
||||||
|
url: string;
|
||||||
|
preCacheTransform:
|
||||||
|
| {
|
||||||
|
actionCacheId: string;
|
||||||
|
actionFootprint: string;
|
||||||
|
}
|
||||||
|
| undefined;
|
||||||
|
}): string {
|
||||||
|
const { preCacheTransform } = params;
|
||||||
|
|
||||||
|
// Parse the URL
|
||||||
|
const url = new URL(params.url);
|
||||||
|
|
||||||
|
// Extract pathname and remove leading slashes
|
||||||
|
let fileName = url.pathname.replace(/^\//, "").replace(/\//g, "_");
|
||||||
|
|
||||||
|
// Optionally, add query parameters replacing special characters
|
||||||
|
if (url.search) {
|
||||||
|
fileName += url.search.replace(/[&=?]/g, "-");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace any characters that are not valid in filenames
|
||||||
|
fileName = fileName.replace(/[^a-zA-Z0-9-_]/g, "");
|
||||||
|
|
||||||
|
// Trim or pad the fileName to a specific length
|
||||||
|
fileName = fileName.substring(0, 50);
|
||||||
|
|
||||||
|
add_pre_cache_transform: {
|
||||||
|
if (preCacheTransform === undefined) {
|
||||||
|
break add_pre_cache_transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sanitize actionCacheId the same way as other components
|
||||||
|
const sanitizedActionCacheId = preCacheTransform.actionCacheId.replace(/[^a-zA-Z0-9-_]/g, "_");
|
||||||
|
|
||||||
|
fileName += `_${sanitizedActionCacheId}_${createHash("sha256").update(preCacheTransform.actionFootprint).digest("hex").substring(0, 5)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return fileName;
|
||||||
|
}
|
@ -1,6 +1,6 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
|
||||||
import { getProjectRoot } from "./tools/getProjectRoot";
|
import { getThisCodebaseRootDirPath } from "./tools/getThisCodebaseRootDirPath";
|
||||||
import cliSelect from "cli-select";
|
import cliSelect from "cli-select";
|
||||||
import { loginThemePageIds, accountThemePageIds, type LoginThemePageId, type AccountThemePageId } from "./keycloakify/generateFtl";
|
import { loginThemePageIds, accountThemePageIds, type LoginThemePageId, type AccountThemePageId } from "./keycloakify/generateFtl";
|
||||||
import { capitalize } from "tsafe/capitalize";
|
import { capitalize } from "tsafe/capitalize";
|
||||||
@ -9,13 +9,16 @@ import { existsSync } from "fs";
|
|||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
|
import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
|
||||||
import { assert, Equals } from "tsafe/assert";
|
import { assert, Equals } from "tsafe/assert";
|
||||||
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
|
||||||
import { themeTypes, type ThemeType } from "./constants";
|
import { themeTypes, type ThemeType } from "./constants";
|
||||||
|
import { getReactAppRootDirPath } from "./keycloakify/buildOptions/getReactAppRootDirPath";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
console.log("Select a theme type");
|
console.log("Select a theme type");
|
||||||
|
|
||||||
const reactAppRootDirPath = process.cwd();
|
const { reactAppRootDirPath } = getReactAppRootDirPath({
|
||||||
|
"processArgv": process.argv.slice(2)
|
||||||
|
});
|
||||||
|
|
||||||
const { value: themeType } = await cliSelect<ThemeType>({
|
const { value: themeType } = await cliSelect<ThemeType>({
|
||||||
"values": [...themeTypes]
|
"values": [...themeTypes]
|
||||||
@ -55,7 +58,7 @@ import { themeTypes, type ThemeType } from "./constants";
|
|||||||
process.exit(-1);
|
process.exit(-1);
|
||||||
}
|
}
|
||||||
|
|
||||||
await writeFile(targetFilePath, await readFile(pathJoin(getProjectRoot(), "src", themeType, "pages", pageBasename)));
|
await writeFile(targetFilePath, await readFile(pathJoin(getThisCodebaseRootDirPath(), "src", themeType, "pages", pageBasename)));
|
||||||
|
|
||||||
console.log(`${pathRelative(process.cwd(), targetFilePath)} created`);
|
console.log(`${pathRelative(process.cwd(), targetFilePath)} created`);
|
||||||
})();
|
})();
|
||||||
|
@ -4,23 +4,21 @@ import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme"
|
|||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { transformCodebase } from "./tools/transformCodebase";
|
import { transformCodebase } from "./tools/transformCodebase";
|
||||||
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
||||||
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
import { readBuildOptions } from "./keycloakify/buildOptions";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { getLogger } from "./tools/logger";
|
import { getLogger } from "./tools/logger";
|
||||||
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
|
||||||
|
import { rmSync } from "./tools/fs.rmSync";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const reactAppRootDirPath = process.cwd();
|
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
reactAppRootDirPath,
|
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({
|
const { themeSrcDirPath } = getThemeSrcDirPath({
|
||||||
reactAppRootDirPath
|
"reactAppRootDirPath": buildOptions.reactAppRootDirPath
|
||||||
});
|
});
|
||||||
|
|
||||||
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
@ -54,7 +52,7 @@ export async function main() {
|
|||||||
|
|
||||||
logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
|
logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
|
||||||
|
|
||||||
fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
|
rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
|
||||||
}
|
}
|
||||||
|
|
||||||
if (require.main === module) {
|
if (require.main === module) {
|
||||||
|
@ -1,157 +0,0 @@
|
|||||||
import { parse as urlParse } from "url";
|
|
||||||
import { getParsedPackageJson } from "./parsedPackageJson";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import parseArgv from "minimist";
|
|
||||||
import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
|
|
||||||
|
|
||||||
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
|
||||||
export type BuildOptions = {
|
|
||||||
isSilent: boolean;
|
|
||||||
themeVersion: string;
|
|
||||||
themeNames: string[];
|
|
||||||
extraThemeProperties: string[] | undefined;
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
doCreateJar: boolean;
|
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
|
||||||
reactAppRootDirPath: string;
|
|
||||||
/** Directory of your built react project. Defaults to {cwd}/build */
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
publicDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
/** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
|
|
||||||
* In this case the urlPathname will be "/my-app/" */
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
};
|
|
||||||
|
|
||||||
export function readBuildOptions(params: { reactAppRootDirPath: string; processArgv: string[] }): BuildOptions {
|
|
||||||
const { reactAppRootDirPath, processArgv } = params;
|
|
||||||
|
|
||||||
const { isSilentCliParamProvided } = (() => {
|
|
||||||
const argv = parseArgv(processArgv);
|
|
||||||
|
|
||||||
return {
|
|
||||||
"isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
const parsedPackageJson = getParsedPackageJson({ reactAppRootDirPath });
|
|
||||||
|
|
||||||
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
|
||||||
|
|
||||||
const { extraThemeProperties, groupId, artifactId, doCreateJar, loginThemeResourcesFromKeycloakVersion } = keycloakify ?? {};
|
|
||||||
|
|
||||||
const themeNames = (() => {
|
|
||||||
if (keycloakify.themeName === undefined) {
|
|
||||||
return [
|
|
||||||
name
|
|
||||||
.replace(/^@(.*)/, "$1")
|
|
||||||
.split("/")
|
|
||||||
.join("-")
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof keycloakify.themeName === "string") {
|
|
||||||
return [keycloakify.themeName];
|
|
||||||
}
|
|
||||||
|
|
||||||
return keycloakify.themeName;
|
|
||||||
})();
|
|
||||||
|
|
||||||
return {
|
|
||||||
reactAppRootDirPath,
|
|
||||||
themeNames,
|
|
||||||
"doCreateJar": doCreateJar ?? true,
|
|
||||||
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeNames[0]}-keycloak-theme`,
|
|
||||||
"groupId": (() => {
|
|
||||||
const fallbackGroupId = `${themeNames[0]}.keycloak`;
|
|
||||||
|
|
||||||
return (
|
|
||||||
process.env.KEYCLOAKIFY_GROUP_ID ??
|
|
||||||
groupId ??
|
|
||||||
(!homepage
|
|
||||||
? fallbackGroupId
|
|
||||||
: urlParse(homepage)
|
|
||||||
.host?.replace(/:[0-9]+$/, "")
|
|
||||||
?.split(".")
|
|
||||||
.reverse()
|
|
||||||
.join(".") ?? fallbackGroupId) + ".keycloak"
|
|
||||||
);
|
|
||||||
})(),
|
|
||||||
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
|
|
||||||
extraThemeProperties,
|
|
||||||
"isSilent": isSilentCliParamProvided,
|
|
||||||
"loginThemeResourcesFromKeycloakVersion": loginThemeResourcesFromKeycloakVersion ?? "11.0.3",
|
|
||||||
"publicDirPath": (() => {
|
|
||||||
let { PUBLIC_DIR_PATH } = process.env;
|
|
||||||
|
|
||||||
if (PUBLIC_DIR_PATH !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": PUBLIC_DIR_PATH,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "public");
|
|
||||||
})(),
|
|
||||||
"reactAppBuildDirPath": (() => {
|
|
||||||
const { reactAppBuildDirPath } = parsedPackageJson.keycloakify ?? {};
|
|
||||||
|
|
||||||
if (reactAppBuildDirPath !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": reactAppBuildDirPath,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "build");
|
|
||||||
})(),
|
|
||||||
"keycloakifyBuildDirPath": (() => {
|
|
||||||
const { keycloakifyBuildDirPath } = parsedPackageJson.keycloakify ?? {};
|
|
||||||
|
|
||||||
if (keycloakifyBuildDirPath !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": keycloakifyBuildDirPath,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "build_keycloak");
|
|
||||||
})(),
|
|
||||||
"cacheDirPath": pathJoin(
|
|
||||||
(() => {
|
|
||||||
let { XDG_CACHE_HOME } = process.env;
|
|
||||||
|
|
||||||
if (XDG_CACHE_HOME !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": XDG_CACHE_HOME,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "node_modules", ".cache");
|
|
||||||
})(),
|
|
||||||
"keycloakify"
|
|
||||||
),
|
|
||||||
"urlPathname": (() => {
|
|
||||||
const { homepage } = parsedPackageJson;
|
|
||||||
|
|
||||||
let url: URL | undefined = undefined;
|
|
||||||
|
|
||||||
if (homepage !== undefined) {
|
|
||||||
url = new URL(homepage);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (url === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
const out = url.pathname.replace(/([^/])$/, "$1/");
|
|
||||||
return out === "/" ? undefined : out;
|
|
||||||
})(),
|
|
||||||
"doBuildRetrocompatAccountTheme": parsedPackageJson.keycloakify?.doBuildRetrocompatAccountTheme ?? true
|
|
||||||
};
|
|
||||||
}
|
|
163
src/bin/keycloakify/buildJars/buildJar.ts
Normal file
163
src/bin/keycloakify/buildJars/buildJar.ts
Normal file
@ -0,0 +1,163 @@
|
|||||||
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
|
import type { KeycloakAccountV1Version, KeycloakThemeAdditionalInfoExtensionVersion } from "./extensionVersions";
|
||||||
|
import { join as pathJoin, dirname as pathDirname } from "path";
|
||||||
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
|
import type { BuildOptions } from "../buildOptions";
|
||||||
|
import * as fs from "fs/promises";
|
||||||
|
import { accountV1ThemeName } from "../../constants";
|
||||||
|
import { generatePom, BuildOptionsLike as BuildOptionsLike_generatePom } from "./generatePom";
|
||||||
|
import { existsSync, readFileSync } from "fs";
|
||||||
|
import { isInside } from "../../tools/isInside";
|
||||||
|
import child_process from "child_process";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = BuildOptionsLike_generatePom & {
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
themeNames: string[];
|
||||||
|
artifactId: string;
|
||||||
|
themeVersion: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export async function buildJar(params: {
|
||||||
|
jarFileBasename: string;
|
||||||
|
keycloakAccountV1Version: KeycloakAccountV1Version;
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
}): Promise<void> {
|
||||||
|
const { jarFileBasename, keycloakAccountV1Version, keycloakThemeAdditionalInfoExtensionVersion, buildOptions } = params;
|
||||||
|
|
||||||
|
const keycloakifyBuildTmpDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "..", jarFileBasename.replace(".jar", ""));
|
||||||
|
|
||||||
|
{
|
||||||
|
if (!existsSync(buildOptions.keycloakifyBuildDirPath)) {
|
||||||
|
await fs.mkdir(buildOptions.keycloakifyBuildDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
|
|
||||||
|
await fs.writeFile(pathJoin(buildOptions.keycloakifyBuildDirPath, ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
|
}
|
||||||
|
|
||||||
|
const srcMainResourcesRelativeDirPath = pathJoin("src", "main", "resources");
|
||||||
|
|
||||||
|
{
|
||||||
|
const keycloakThemesJsonFilePath = pathJoin(srcMainResourcesRelativeDirPath, "META-INF", "keycloak-themes.json");
|
||||||
|
|
||||||
|
const themePropertiesFilePathSet = new Set(
|
||||||
|
...buildOptions.themeNames.map(themeName => pathJoin(srcMainResourcesRelativeDirPath, "themes", themeName, "account", "theme.properties"))
|
||||||
|
);
|
||||||
|
|
||||||
|
const accountV1RelativeDirPath = pathJoin(srcMainResourcesRelativeDirPath, "themes", accountV1ThemeName);
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
|
"destDirPath": keycloakifyBuildTmpDirPath,
|
||||||
|
"transformSourceCode":
|
||||||
|
keycloakAccountV1Version !== null
|
||||||
|
? undefined
|
||||||
|
: ({ fileRelativePath, sourceCode }) => {
|
||||||
|
if (fileRelativePath === keycloakThemesJsonFilePath) {
|
||||||
|
const keycloakThemesJsonParsed = JSON.parse(sourceCode.toString("utf8")) as {
|
||||||
|
themes: { name: string; types: string[] }[];
|
||||||
|
};
|
||||||
|
|
||||||
|
keycloakThemesJsonParsed.themes = keycloakThemesJsonParsed.themes.filter(({ name }) => name !== accountV1ThemeName);
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": Buffer.from(JSON.stringify(keycloakThemesJsonParsed, null, 2), "utf8") };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isInside({ "dirPath": "target", "filePath": fileRelativePath })) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isInside({ "dirPath": accountV1RelativeDirPath, "filePath": fileRelativePath })) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (themePropertiesFilePathSet.has(fileRelativePath)) {
|
||||||
|
return {
|
||||||
|
"modifiedSourceCode": Buffer.from(
|
||||||
|
sourceCode.toString("utf8").replace(`parent=${accountV1ThemeName}`, "parent=keycloak"),
|
||||||
|
"utf8"
|
||||||
|
)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
route_legacy_pages: {
|
||||||
|
// NOTE: If there's no account theme there is no special target for keycloak 24 and up so we create
|
||||||
|
// the pages anyway. If there is an account pages, since we know that account-v1 is only support keycloak
|
||||||
|
// 24 in version 0.4 and up, we can safely break the route for legacy pages.
|
||||||
|
const doBreak: boolean = (() => {
|
||||||
|
switch (keycloakAccountV1Version) {
|
||||||
|
case null:
|
||||||
|
return false;
|
||||||
|
case "0.3":
|
||||||
|
return false;
|
||||||
|
default:
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
if (doBreak) {
|
||||||
|
break route_legacy_pages;
|
||||||
|
}
|
||||||
|
|
||||||
|
(["register.ftl", "login-update-profile.ftl"] as const).forEach(pageId =>
|
||||||
|
buildOptions.themeNames.map(themeName => {
|
||||||
|
const ftlFilePath = pathJoin(srcMainResourcesRelativeDirPath, "themes", themeName, "login", pageId);
|
||||||
|
|
||||||
|
const ftlFileContent = readFileSync(ftlFilePath).toString("utf8");
|
||||||
|
|
||||||
|
const realPageId = (() => {
|
||||||
|
switch (pageId) {
|
||||||
|
case "register.ftl":
|
||||||
|
return "register-user-profile.ftl";
|
||||||
|
case "login-update-profile.ftl":
|
||||||
|
return "update-user-profile.ftl";
|
||||||
|
}
|
||||||
|
assert<Equals<typeof pageId, never>>(false);
|
||||||
|
})();
|
||||||
|
|
||||||
|
const modifiedFtlFileContent = ftlFileContent.replace(
|
||||||
|
`out["pageId"] = "${pageId}";`,
|
||||||
|
`out["pageId"] = "${pageId}"; out["realPageId"] = "${realPageId}";`
|
||||||
|
);
|
||||||
|
|
||||||
|
assert(modifiedFtlFileContent !== ftlFileContent);
|
||||||
|
|
||||||
|
fs.writeFile(pathJoin(pathDirname(ftlFilePath), realPageId), Buffer.from(modifiedFtlFileContent, "utf8"));
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const { pomFileCode } = generatePom({
|
||||||
|
buildOptions,
|
||||||
|
keycloakAccountV1Version,
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersion
|
||||||
|
});
|
||||||
|
|
||||||
|
await fs.writeFile(pathJoin(buildOptions.keycloakifyBuildDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
|
||||||
|
}
|
||||||
|
|
||||||
|
await new Promise<void>((resolve, reject) =>
|
||||||
|
child_process.exec("mvn clean install", { "cwd": keycloakifyBuildTmpDirPath }, error => {
|
||||||
|
if (error !== null) {
|
||||||
|
reject(error);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
resolve();
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
await fs.rename(
|
||||||
|
pathJoin(keycloakifyBuildTmpDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`),
|
||||||
|
pathJoin(buildOptions.keycloakifyBuildDirPath, jarFileBasename)
|
||||||
|
);
|
||||||
|
|
||||||
|
await fs.rm(keycloakifyBuildTmpDirPath, { "recursive": true });
|
||||||
|
}
|
62
src/bin/keycloakify/buildJars/buildJars.ts
Normal file
62
src/bin/keycloakify/buildJars/buildJars.ts
Normal file
@ -0,0 +1,62 @@
|
|||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { exclude } from "tsafe/exclude";
|
||||||
|
import { keycloakAccountV1Versions, keycloakThemeAdditionalInfoExtensionVersions } from "./extensionVersions";
|
||||||
|
import { getKeycloakVersionRangeForJar } from "./getKeycloakVersionRangeForJar";
|
||||||
|
import { buildJar, BuildOptionsLike as BuildOptionsLike_buildJar } from "./buildJar";
|
||||||
|
import type { BuildOptions } from "../buildOptions";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = BuildOptionsLike_buildJar & {
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export async function buildJars(params: {
|
||||||
|
doesImplementAccountTheme: boolean;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
}): Promise<{ lastJarFileBasename: string }> {
|
||||||
|
const { doesImplementAccountTheme, buildOptions } = params;
|
||||||
|
|
||||||
|
let lastJarFileBasename: string | undefined = undefined;
|
||||||
|
|
||||||
|
await Promise.all(
|
||||||
|
keycloakAccountV1Versions
|
||||||
|
.map(keycloakAccountV1Version =>
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersions
|
||||||
|
.map(keycloakThemeAdditionalInfoExtensionVersion => {
|
||||||
|
const keycloakVersionRange = getKeycloakVersionRangeForJar({
|
||||||
|
doesImplementAccountTheme,
|
||||||
|
keycloakAccountV1Version,
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersion
|
||||||
|
});
|
||||||
|
|
||||||
|
if (keycloakVersionRange === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { keycloakThemeAdditionalInfoExtensionVersion, keycloakVersionRange };
|
||||||
|
})
|
||||||
|
.filter(exclude(undefined))
|
||||||
|
.map(({ keycloakThemeAdditionalInfoExtensionVersion, keycloakVersionRange }) => {
|
||||||
|
const jarFileBasename = `keycloak-theme-for-kc-${keycloakVersionRange}.jar`;
|
||||||
|
|
||||||
|
lastJarFileBasename = jarFileBasename;
|
||||||
|
|
||||||
|
return { keycloakThemeAdditionalInfoExtensionVersion, jarFileBasename };
|
||||||
|
})
|
||||||
|
.map(({ keycloakThemeAdditionalInfoExtensionVersion, jarFileBasename }) =>
|
||||||
|
buildJar({
|
||||||
|
jarFileBasename,
|
||||||
|
keycloakAccountV1Version,
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersion,
|
||||||
|
buildOptions
|
||||||
|
})
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.flat()
|
||||||
|
);
|
||||||
|
|
||||||
|
assert(lastJarFileBasename !== undefined);
|
||||||
|
|
||||||
|
return { lastJarFileBasename };
|
||||||
|
}
|
16
src/bin/keycloakify/buildJars/extensionVersions.ts
Normal file
16
src/bin/keycloakify/buildJars/extensionVersions.ts
Normal file
@ -0,0 +1,16 @@
|
|||||||
|
// NOTE: v0.5 is a dummy version.
|
||||||
|
export const keycloakAccountV1Versions = [null, "0.3", "0.4"] as const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* https://central.sonatype.com/artifact/io.phasetwo.keycloak/keycloak-account-v1
|
||||||
|
* https://github.com/p2-inc/keycloak-account-v1
|
||||||
|
*/
|
||||||
|
export type KeycloakAccountV1Version = (typeof keycloakAccountV1Versions)[number];
|
||||||
|
|
||||||
|
export const keycloakThemeAdditionalInfoExtensionVersions = [null, "1.1.5"] as const;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* https://central.sonatype.com/artifact/dev.jcputney/keycloak-theme-additional-info-extension
|
||||||
|
* https://github.com/jcputney/keycloak-theme-additional-info-extension
|
||||||
|
* */
|
||||||
|
export type KeycloakThemeAdditionalInfoExtensionVersion = (typeof keycloakThemeAdditionalInfoExtensionVersions)[number];
|
86
src/bin/keycloakify/buildJars/generatePom.ts
Normal file
86
src/bin/keycloakify/buildJars/generatePom.ts
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "../buildOptions";
|
||||||
|
import type { KeycloakAccountV1Version, KeycloakThemeAdditionalInfoExtensionVersion } from "./extensionVersions";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
groupId: string;
|
||||||
|
artifactId: string;
|
||||||
|
themeVersion: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export function generatePom(params: {
|
||||||
|
keycloakAccountV1Version: KeycloakAccountV1Version;
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
}) {
|
||||||
|
const { keycloakAccountV1Version, keycloakThemeAdditionalInfoExtensionVersion, buildOptions } = params;
|
||||||
|
|
||||||
|
const { pomFileCode } = (function generatePomFileCode(): {
|
||||||
|
pomFileCode: string;
|
||||||
|
} {
|
||||||
|
const pomFileCode = [
|
||||||
|
`<?xml version="1.0"?>`,
|
||||||
|
`<project xmlns="http://maven.apache.org/POM/4.0.0"`,
|
||||||
|
` xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`,
|
||||||
|
` xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">`,
|
||||||
|
` <modelVersion>4.0.0</modelVersion>`,
|
||||||
|
` <groupId>${buildOptions.groupId}</groupId>`,
|
||||||
|
` <artifactId>${buildOptions.artifactId}</artifactId>`,
|
||||||
|
` <version>${buildOptions.themeVersion}</version>`,
|
||||||
|
` <name>${buildOptions.artifactId}</name>`,
|
||||||
|
` <description />`,
|
||||||
|
` <packaging>jar</packaging>`,
|
||||||
|
` <properties>`,
|
||||||
|
` <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>`,
|
||||||
|
` </properties>`,
|
||||||
|
...(keycloakAccountV1Version !== null && keycloakThemeAdditionalInfoExtensionVersion !== null
|
||||||
|
? [
|
||||||
|
` <build>`,
|
||||||
|
` <plugins>`,
|
||||||
|
` <plugin>`,
|
||||||
|
` <groupId>org.apache.maven.plugins</groupId>`,
|
||||||
|
` <artifactId>maven-shade-plugin</artifactId>`,
|
||||||
|
` <version>3.5.1</version>`,
|
||||||
|
` <executions>`,
|
||||||
|
` <execution>`,
|
||||||
|
` <phase>package</phase>`,
|
||||||
|
` <goals>`,
|
||||||
|
` <goal>shade</goal>`,
|
||||||
|
` </goals>`,
|
||||||
|
` </execution>`,
|
||||||
|
` </executions>`,
|
||||||
|
` </plugin>`,
|
||||||
|
` </plugins>`,
|
||||||
|
` </build>`,
|
||||||
|
` <dependencies>`,
|
||||||
|
...(keycloakAccountV1Version !== null
|
||||||
|
? [
|
||||||
|
` <dependency>`,
|
||||||
|
` <groupId>io.phasetwo.keycloak</groupId>`,
|
||||||
|
` <artifactId>keycloak-account-v1</artifactId>`,
|
||||||
|
` <version>${keycloakAccountV1Version}</version>`,
|
||||||
|
` </dependency>`
|
||||||
|
]
|
||||||
|
: []),
|
||||||
|
...(keycloakThemeAdditionalInfoExtensionVersion !== null
|
||||||
|
? [
|
||||||
|
` <dependency>`,
|
||||||
|
` <groupId>dev.jcputney</groupId>`,
|
||||||
|
` <artifactId>keycloak-theme-additional-info-extension</artifactId>`,
|
||||||
|
` <version>${keycloakThemeAdditionalInfoExtensionVersion}</version>`,
|
||||||
|
` </dependency>`
|
||||||
|
]
|
||||||
|
: []),
|
||||||
|
` </dependencies>`,
|
||||||
|
`</project>`
|
||||||
|
]
|
||||||
|
: [])
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
return { pomFileCode };
|
||||||
|
})();
|
||||||
|
|
||||||
|
return { pomFileCode };
|
||||||
|
}
|
@ -0,0 +1,37 @@
|
|||||||
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
|
import type { KeycloakAccountV1Version, KeycloakThemeAdditionalInfoExtensionVersion } from "./extensionVersions";
|
||||||
|
|
||||||
|
export function getKeycloakVersionRangeForJar(params: {
|
||||||
|
doesImplementAccountTheme: boolean;
|
||||||
|
keycloakAccountV1Version: KeycloakAccountV1Version;
|
||||||
|
keycloakThemeAdditionalInfoExtensionVersion: KeycloakThemeAdditionalInfoExtensionVersion;
|
||||||
|
}): string | undefined {
|
||||||
|
const { keycloakAccountV1Version, keycloakThemeAdditionalInfoExtensionVersion, doesImplementAccountTheme } = params;
|
||||||
|
|
||||||
|
switch (keycloakAccountV1Version) {
|
||||||
|
case null:
|
||||||
|
switch (keycloakThemeAdditionalInfoExtensionVersion) {
|
||||||
|
case null:
|
||||||
|
return doesImplementAccountTheme ? "21-and-below" : "21-and-below";
|
||||||
|
case "1.1.5":
|
||||||
|
return doesImplementAccountTheme ? undefined : "22-and-above";
|
||||||
|
}
|
||||||
|
assert<Equals<typeof keycloakThemeAdditionalInfoExtensionVersion, never>>(false);
|
||||||
|
case "0.3":
|
||||||
|
switch (keycloakThemeAdditionalInfoExtensionVersion) {
|
||||||
|
case null:
|
||||||
|
return doesImplementAccountTheme ? undefined : undefined;
|
||||||
|
case "1.1.5":
|
||||||
|
return doesImplementAccountTheme ? "23" : undefined;
|
||||||
|
}
|
||||||
|
assert<Equals<typeof keycloakThemeAdditionalInfoExtensionVersion, never>>(false);
|
||||||
|
case "0.4":
|
||||||
|
switch (keycloakThemeAdditionalInfoExtensionVersion) {
|
||||||
|
case null:
|
||||||
|
return doesImplementAccountTheme ? undefined : undefined;
|
||||||
|
case "1.1.5":
|
||||||
|
return doesImplementAccountTheme ? "24-and-above" : undefined;
|
||||||
|
}
|
||||||
|
assert<Equals<typeof keycloakThemeAdditionalInfoExtensionVersion, never>>(false);
|
||||||
|
}
|
||||||
|
}
|
1
src/bin/keycloakify/buildJars/index.ts
Normal file
1
src/bin/keycloakify/buildJars/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./buildJars";
|
21
src/bin/keycloakify/buildOptions/UserProvidedBuildOptions.ts
Normal file
21
src/bin/keycloakify/buildOptions/UserProvidedBuildOptions.ts
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
import { z } from "zod";
|
||||||
|
|
||||||
|
export type UserProvidedBuildOptions = {
|
||||||
|
extraThemeProperties?: string[];
|
||||||
|
artifactId?: string;
|
||||||
|
groupId?: string;
|
||||||
|
loginThemeResourcesFromKeycloakVersion?: string;
|
||||||
|
reactAppBuildDirPath?: string;
|
||||||
|
keycloakifyBuildDirPath?: string;
|
||||||
|
themeName?: string | string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
export const zUserProvidedBuildOptions = z.object({
|
||||||
|
"extraThemeProperties": z.array(z.string()).optional(),
|
||||||
|
"artifactId": z.string().optional(),
|
||||||
|
"groupId": z.string().optional(),
|
||||||
|
"loginThemeResourcesFromKeycloakVersion": z.string().optional(),
|
||||||
|
"reactAppBuildDirPath": z.string().optional(),
|
||||||
|
"keycloakifyBuildDirPath": z.string().optional(),
|
||||||
|
"themeName": z.union([z.string(), z.array(z.string())]).optional()
|
||||||
|
});
|
189
src/bin/keycloakify/buildOptions/buildOptions.ts
Normal file
189
src/bin/keycloakify/buildOptions/buildOptions.ts
Normal file
@ -0,0 +1,189 @@
|
|||||||
|
import { parse as urlParse } from "url";
|
||||||
|
import { readParsedPackageJson } from "./parsedPackageJson";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import parseArgv from "minimist";
|
||||||
|
import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
|
||||||
|
import { readResolvedViteConfig } from "./resolvedViteConfig";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { getCacheDirPath } from "./getCacheDirPath";
|
||||||
|
import { getReactAppRootDirPath } from "./getReactAppRootDirPath";
|
||||||
|
import { getNpmWorkspaceRootDirPath } from "./getNpmWorkspaceRootDirPath";
|
||||||
|
|
||||||
|
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
||||||
|
export type BuildOptions = {
|
||||||
|
bundler: "vite" | "webpack";
|
||||||
|
isSilent: boolean;
|
||||||
|
themeVersion: string;
|
||||||
|
themeNames: string[];
|
||||||
|
extraThemeProperties: string[] | undefined;
|
||||||
|
groupId: string;
|
||||||
|
artifactId: string;
|
||||||
|
loginThemeResourcesFromKeycloakVersion: string;
|
||||||
|
reactAppRootDirPath: string;
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
publicDirPath: string;
|
||||||
|
cacheDirPath: string;
|
||||||
|
/** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
|
||||||
|
* In this case the urlPathname will be "/my-app/" */
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
assetsDirPath: string;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export function readBuildOptions(params: { processArgv: string[] }): BuildOptions {
|
||||||
|
const { processArgv } = params;
|
||||||
|
|
||||||
|
const { reactAppRootDirPath } = getReactAppRootDirPath({ processArgv });
|
||||||
|
|
||||||
|
const { cacheDirPath } = getCacheDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
|
const { resolvedViteConfig } = readResolvedViteConfig({ cacheDirPath });
|
||||||
|
|
||||||
|
if (resolvedViteConfig === undefined && fs.existsSync(pathJoin(reactAppRootDirPath, "vite.config.ts"))) {
|
||||||
|
throw new Error("Keycloakify's Vite plugin output not found");
|
||||||
|
}
|
||||||
|
|
||||||
|
const { keycloakify: userProvidedBuildOptionsFromPackageJson, ...parsedPackageJson } = readParsedPackageJson({ reactAppRootDirPath });
|
||||||
|
|
||||||
|
const userProvidedBuildOptions = {
|
||||||
|
...userProvidedBuildOptionsFromPackageJson,
|
||||||
|
...resolvedViteConfig?.userProvidedBuildOptions
|
||||||
|
};
|
||||||
|
|
||||||
|
const themeNames = (() => {
|
||||||
|
if (userProvidedBuildOptions.themeName === undefined) {
|
||||||
|
return [
|
||||||
|
parsedPackageJson.name
|
||||||
|
.replace(/^@(.*)/, "$1")
|
||||||
|
.split("/")
|
||||||
|
.join("-")
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof userProvidedBuildOptions.themeName === "string") {
|
||||||
|
return [userProvidedBuildOptions.themeName];
|
||||||
|
}
|
||||||
|
|
||||||
|
return userProvidedBuildOptions.themeName;
|
||||||
|
})();
|
||||||
|
|
||||||
|
const reactAppBuildDirPath = (() => {
|
||||||
|
webpack: {
|
||||||
|
if (resolvedViteConfig !== undefined) {
|
||||||
|
break webpack;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (userProvidedBuildOptions.reactAppBuildDirPath !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": userProvidedBuildOptions.reactAppBuildDirPath,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, "build");
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, resolvedViteConfig.buildDir);
|
||||||
|
})();
|
||||||
|
|
||||||
|
const argv = parseArgv(processArgv);
|
||||||
|
|
||||||
|
const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
|
return {
|
||||||
|
"bundler": resolvedViteConfig !== undefined ? "vite" : "webpack",
|
||||||
|
"isSilent": typeof argv["silent"] === "boolean" ? argv["silent"] : false,
|
||||||
|
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
|
||||||
|
themeNames,
|
||||||
|
"extraThemeProperties": userProvidedBuildOptions.extraThemeProperties,
|
||||||
|
"groupId": (() => {
|
||||||
|
const fallbackGroupId = `${themeNames[0]}.keycloak`;
|
||||||
|
|
||||||
|
return (
|
||||||
|
process.env.KEYCLOAKIFY_GROUP_ID ??
|
||||||
|
userProvidedBuildOptions.groupId ??
|
||||||
|
(parsedPackageJson.homepage === undefined
|
||||||
|
? fallbackGroupId
|
||||||
|
: urlParse(parsedPackageJson.homepage)
|
||||||
|
.host?.replace(/:[0-9]+$/, "")
|
||||||
|
?.split(".")
|
||||||
|
.reverse()
|
||||||
|
.join(".") ?? fallbackGroupId) + ".keycloak"
|
||||||
|
);
|
||||||
|
})(),
|
||||||
|
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? userProvidedBuildOptions.artifactId ?? `${themeNames[0]}-keycloak-theme`,
|
||||||
|
"loginThemeResourcesFromKeycloakVersion": userProvidedBuildOptions.loginThemeResourcesFromKeycloakVersion ?? "24.0.4",
|
||||||
|
reactAppRootDirPath,
|
||||||
|
reactAppBuildDirPath,
|
||||||
|
"keycloakifyBuildDirPath": (() => {
|
||||||
|
if (userProvidedBuildOptions.keycloakifyBuildDirPath !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": userProvidedBuildOptions.keycloakifyBuildDirPath,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(
|
||||||
|
reactAppRootDirPath,
|
||||||
|
resolvedViteConfig?.buildDir === undefined ? "build_keycloak" : `${resolvedViteConfig.buildDir}_keycloak`
|
||||||
|
);
|
||||||
|
})(),
|
||||||
|
"publicDirPath": (() => {
|
||||||
|
webpack: {
|
||||||
|
if (resolvedViteConfig !== undefined) {
|
||||||
|
break webpack;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (process.env.PUBLIC_DIR_PATH !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": process.env.PUBLIC_DIR_PATH,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, "public");
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, resolvedViteConfig.publicDir);
|
||||||
|
})(),
|
||||||
|
cacheDirPath,
|
||||||
|
"urlPathname": (() => {
|
||||||
|
webpack: {
|
||||||
|
if (resolvedViteConfig !== undefined) {
|
||||||
|
break webpack;
|
||||||
|
}
|
||||||
|
|
||||||
|
const { homepage } = parsedPackageJson;
|
||||||
|
|
||||||
|
let url: URL | undefined = undefined;
|
||||||
|
|
||||||
|
if (homepage !== undefined) {
|
||||||
|
url = new URL(homepage);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const out = url.pathname.replace(/([^/])$/, "$1/");
|
||||||
|
return out === "/" ? undefined : out;
|
||||||
|
}
|
||||||
|
|
||||||
|
return resolvedViteConfig.urlPathname;
|
||||||
|
})(),
|
||||||
|
"assetsDirPath": (() => {
|
||||||
|
webpack: {
|
||||||
|
if (resolvedViteConfig !== undefined) {
|
||||||
|
break webpack;
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppBuildDirPath, "static");
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
|
||||||
|
})(),
|
||||||
|
npmWorkspaceRootDirPath
|
||||||
|
};
|
||||||
|
}
|
25
src/bin/keycloakify/buildOptions/getCacheDirPath.ts
Normal file
25
src/bin/keycloakify/buildOptions/getCacheDirPath.ts
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
|
||||||
|
import { getNpmWorkspaceRootDirPath } from "./getNpmWorkspaceRootDirPath";
|
||||||
|
|
||||||
|
export function getCacheDirPath(params: { reactAppRootDirPath: string }) {
|
||||||
|
const { reactAppRootDirPath } = params;
|
||||||
|
|
||||||
|
const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
|
const cacheDirPath = pathJoin(
|
||||||
|
(() => {
|
||||||
|
if (process.env.XDG_CACHE_HOME !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": process.env.XDG_CACHE_HOME,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(npmWorkspaceRootDirPath, "node_modules", ".cache");
|
||||||
|
})(),
|
||||||
|
"keycloakify"
|
||||||
|
);
|
||||||
|
|
||||||
|
return { cacheDirPath };
|
||||||
|
}
|
@ -0,0 +1,49 @@
|
|||||||
|
import * as child_process from "child_process";
|
||||||
|
import { join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
|
||||||
|
let cache:
|
||||||
|
| {
|
||||||
|
reactAppRootDirPath: string;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
|
}
|
||||||
|
| undefined = undefined;
|
||||||
|
|
||||||
|
export function getNpmWorkspaceRootDirPath(params: { reactAppRootDirPath: string }) {
|
||||||
|
const { reactAppRootDirPath } = params;
|
||||||
|
|
||||||
|
use_cache: {
|
||||||
|
if (cache === undefined || cache.reactAppRootDirPath !== reactAppRootDirPath) {
|
||||||
|
break use_cache;
|
||||||
|
}
|
||||||
|
|
||||||
|
const { npmWorkspaceRootDirPath } = cache;
|
||||||
|
|
||||||
|
return { npmWorkspaceRootDirPath };
|
||||||
|
}
|
||||||
|
|
||||||
|
const npmWorkspaceRootDirPath = (function callee(depth: number): string {
|
||||||
|
const cwd = pathResolve(pathJoin(...[reactAppRootDirPath, ...Array(depth).fill("..")]));
|
||||||
|
|
||||||
|
try {
|
||||||
|
child_process.execSync("npm config get", { cwd, "stdio": ["pipe", "pipe", "pipe"] });
|
||||||
|
} catch (error) {
|
||||||
|
if (String(error).includes("ENOWORKSPACES")) {
|
||||||
|
assert(cwd !== pathSep, "NPM workspace not found");
|
||||||
|
|
||||||
|
return callee(depth + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
return cwd;
|
||||||
|
})(0);
|
||||||
|
|
||||||
|
cache = {
|
||||||
|
reactAppRootDirPath,
|
||||||
|
npmWorkspaceRootDirPath
|
||||||
|
};
|
||||||
|
|
||||||
|
return { npmWorkspaceRootDirPath };
|
||||||
|
}
|
23
src/bin/keycloakify/buildOptions/getReactAppRootDirPath.ts
Normal file
23
src/bin/keycloakify/buildOptions/getReactAppRootDirPath.ts
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
import parseArgv from "minimist";
|
||||||
|
import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
|
||||||
|
|
||||||
|
export function getReactAppRootDirPath(params: { processArgv: string[] }) {
|
||||||
|
const { processArgv } = params;
|
||||||
|
|
||||||
|
const argv = parseArgv(processArgv);
|
||||||
|
|
||||||
|
const reactAppRootDirPath = (() => {
|
||||||
|
const arg = argv["project"] ?? argv["p"];
|
||||||
|
|
||||||
|
if (typeof arg !== "string") {
|
||||||
|
return process.cwd();
|
||||||
|
}
|
||||||
|
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": arg,
|
||||||
|
"cwd": process.cwd()
|
||||||
|
});
|
||||||
|
})();
|
||||||
|
|
||||||
|
return { reactAppRootDirPath };
|
||||||
|
}
|
1
src/bin/keycloakify/buildOptions/index.ts
Normal file
1
src/bin/keycloakify/buildOptions/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./buildOptions";
|
32
src/bin/keycloakify/buildOptions/parsedPackageJson.ts
Normal file
32
src/bin/keycloakify/buildOptions/parsedPackageJson.ts
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { assert } from "tsafe";
|
||||||
|
import type { Equals } from "tsafe";
|
||||||
|
import { z } from "zod";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { type UserProvidedBuildOptions, zUserProvidedBuildOptions } from "./UserProvidedBuildOptions";
|
||||||
|
|
||||||
|
export type ParsedPackageJson = {
|
||||||
|
name: string;
|
||||||
|
version?: string;
|
||||||
|
homepage?: string;
|
||||||
|
keycloakify?: UserProvidedBuildOptions;
|
||||||
|
};
|
||||||
|
|
||||||
|
const zParsedPackageJson = z.object({
|
||||||
|
"name": z.string(),
|
||||||
|
"version": z.string().optional(),
|
||||||
|
"homepage": z.string().optional(),
|
||||||
|
"keycloakify": zUserProvidedBuildOptions.optional()
|
||||||
|
});
|
||||||
|
|
||||||
|
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
||||||
|
|
||||||
|
let parsedPackageJson: undefined | ParsedPackageJson;
|
||||||
|
export function readParsedPackageJson(params: { reactAppRootDirPath: string }) {
|
||||||
|
const { reactAppRootDirPath } = params;
|
||||||
|
if (parsedPackageJson) {
|
||||||
|
return parsedPackageJson;
|
||||||
|
}
|
||||||
|
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
|
||||||
|
return parsedPackageJson;
|
||||||
|
}
|
74
src/bin/keycloakify/buildOptions/resolvedViteConfig.ts
Normal file
74
src/bin/keycloakify/buildOptions/resolvedViteConfig.ts
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { assert } from "tsafe";
|
||||||
|
import type { Equals } from "tsafe";
|
||||||
|
import { z } from "zod";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { resolvedViteConfigJsonBasename } from "../../constants";
|
||||||
|
import type { OptionalIfCanBeUndefined } from "../../tools/OptionalIfCanBeUndefined";
|
||||||
|
import { UserProvidedBuildOptions, zUserProvidedBuildOptions } from "./UserProvidedBuildOptions";
|
||||||
|
|
||||||
|
export type ResolvedViteConfig = {
|
||||||
|
buildDir: string;
|
||||||
|
publicDir: string;
|
||||||
|
assetsDir: string;
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
userProvidedBuildOptions: UserProvidedBuildOptions;
|
||||||
|
};
|
||||||
|
|
||||||
|
const zResolvedViteConfig = z.object({
|
||||||
|
"buildDir": z.string(),
|
||||||
|
"publicDir": z.string(),
|
||||||
|
"assetsDir": z.string(),
|
||||||
|
"urlPathname": z.string().optional(),
|
||||||
|
"userProvidedBuildOptions": zUserProvidedBuildOptions
|
||||||
|
});
|
||||||
|
|
||||||
|
{
|
||||||
|
type Got = ReturnType<(typeof zResolvedViteConfig)["parse"]>;
|
||||||
|
type Expected = OptionalIfCanBeUndefined<ResolvedViteConfig>;
|
||||||
|
|
||||||
|
assert<Equals<Got, Expected>>();
|
||||||
|
}
|
||||||
|
|
||||||
|
export function readResolvedViteConfig(params: { cacheDirPath: string }): {
|
||||||
|
resolvedViteConfig: ResolvedViteConfig | undefined;
|
||||||
|
} {
|
||||||
|
const { cacheDirPath } = params;
|
||||||
|
|
||||||
|
const resolvedViteConfigJsonFilePath = pathJoin(cacheDirPath, resolvedViteConfigJsonBasename);
|
||||||
|
|
||||||
|
if (!fs.existsSync(resolvedViteConfigJsonFilePath)) {
|
||||||
|
return { "resolvedViteConfig": undefined };
|
||||||
|
}
|
||||||
|
|
||||||
|
const resolvedViteConfig = (() => {
|
||||||
|
if (!fs.existsSync(resolvedViteConfigJsonFilePath)) {
|
||||||
|
throw new Error("Missing Keycloakify Vite plugin output.");
|
||||||
|
}
|
||||||
|
|
||||||
|
let out: ResolvedViteConfig;
|
||||||
|
|
||||||
|
try {
|
||||||
|
out = JSON.parse(fs.readFileSync(resolvedViteConfigJsonFilePath).toString("utf8"));
|
||||||
|
} catch {
|
||||||
|
throw new Error("The output of the Keycloakify Vite plugin is not a valid JSON.");
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const zodParseReturn = zResolvedViteConfig.parse(out);
|
||||||
|
|
||||||
|
// So that objectKeys from tsafe return the expected result no matter what.
|
||||||
|
Object.keys(zodParseReturn)
|
||||||
|
.filter(key => !(key in out))
|
||||||
|
.forEach(key => {
|
||||||
|
delete (out as any)[key];
|
||||||
|
});
|
||||||
|
} catch {
|
||||||
|
throw new Error("The output of the Keycloakify Vite plugin do not match the expected schema.");
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
})();
|
||||||
|
|
||||||
|
return { resolvedViteConfig };
|
||||||
|
}
|
@ -1 +0,0 @@
|
|||||||
export const ftlValuesGlobalName = "kcContext";
|
|
@ -30,30 +30,19 @@
|
|||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
<#if !messagesPerField.existsError??>
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
|
||||||
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = "">
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
<#attempt>
|
<#recover>
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
<#recover>
|
</#attempt>
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
<#if !doExistMessageForUsernameOrPassword>
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
return <#if doExistMessageForUsernameOrPassword>text<#else>undefined</#if>;
|
|
||||||
|
|
||||||
|
<#if doExistErrorOnUsernameOrPassword>
|
||||||
|
return text;
|
||||||
<#else>
|
<#else>
|
||||||
|
|
||||||
<#assign doExistMessageForField = "">
|
<#assign doExistMessageForField = "">
|
||||||
@ -70,49 +59,19 @@
|
|||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#assign doExistMessageForField = "">
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
|
||||||
|
|
||||||
<#assign doExistErrorOnUsernameOrPassword = "">
|
<#attempt>
|
||||||
|
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
<#attempt>
|
return <#if doExistMessageForField>text<#else>undefined</#if>;
|
||||||
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistErrorOnUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
<#if doExistErrorOnUsernameOrPassword>
|
|
||||||
return text;
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#assign doExistMessageForField = "">
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForField = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
return <#if doExistMessageForField>text<#else>undefined</#if>;
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#assign doExistMessageForField = "">
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForField = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
return <#if doExistMessageForField>text<#else>undefined</#if>;
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
</#list>
|
</#list>
|
||||||
|
|
||||||
@ -120,53 +79,15 @@
|
|||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
},
|
},
|
||||||
"existsError": function (fieldName) {
|
"existsError": function (){
|
||||||
|
|
||||||
<#if !messagesPerField?? || !(messagesPerField?is_hash)>
|
function existsError_singleFieldName(fieldName) {
|
||||||
throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
|
|
||||||
<#else>
|
|
||||||
<#list fieldNames as fieldName>
|
|
||||||
if(fieldName === "${fieldName}" ){
|
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
<#if !messagesPerField?? || !(messagesPerField?is_hash)>
|
||||||
<#if !messagesPerField.existsError??>
|
throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
|
||||||
|
<#else>
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#list fieldNames as fieldName>
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
if(fieldName === "${fieldName}" ){
|
||||||
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = "">
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
<#if !doExistMessageForUsernameOrPassword>
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#assign doExistMessageForField = "">
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForField = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
return <#if doExistMessageForField>true<#else>false</#if>;
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
@ -195,14 +116,24 @@
|
|||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
</#if>
|
}
|
||||||
|
</#list>
|
||||||
|
|
||||||
}
|
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
||||||
</#list>
|
|
||||||
|
|
||||||
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
</#if>
|
||||||
|
|
||||||
</#if>
|
}
|
||||||
|
|
||||||
|
for( let i = 0; i < arguments.length; i++ ){
|
||||||
|
|
||||||
|
if( existsError_singleFieldName(arguments[i]) ){
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
|
||||||
},
|
},
|
||||||
"get": function (fieldName) {
|
"get": function (fieldName) {
|
||||||
@ -214,88 +145,42 @@
|
|||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
<#if !messagesPerField.existsError??>
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
|
||||||
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = "">
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if doExistErrorOnUsernameOrPassword>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
|
||||||
<#recover>
|
<#recover>
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
return "Invalid username or password.";
|
||||||
</#attempt>
|
</#attempt>
|
||||||
|
|
||||||
<#if !doExistMessageForUsernameOrPassword>
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#if !doExistMessageForUsernameOrPassword>
|
|
||||||
return "";
|
|
||||||
<#else>
|
|
||||||
<#attempt>
|
|
||||||
return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
|
|
||||||
<#recover>
|
|
||||||
return "Invalid username or password.";
|
|
||||||
</#attempt>
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
||||||
<#recover>
|
<#recover>
|
||||||
return "invalid field";
|
return "";
|
||||||
</#attempt>
|
</#attempt>
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#attempt>
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
||||||
|
<#recover>
|
||||||
<#assign doExistErrorOnUsernameOrPassword = "">
|
return "invalid field";
|
||||||
|
</#attempt>
|
||||||
<#attempt>
|
|
||||||
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistErrorOnUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
<#if doExistErrorOnUsernameOrPassword>
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
|
|
||||||
<#recover>
|
|
||||||
return "Invalid username or password.";
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
|
||||||
<#recover>
|
|
||||||
return "";
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
|
||||||
<#recover>
|
|
||||||
return "invalid field";
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
@ -315,72 +200,30 @@
|
|||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
<#if !messagesPerField.existsError??>
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
|
||||||
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = "">
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
<#attempt>
|
return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
<#if !doExistMessageForUsernameOrPassword>
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#assign doExistMessageForField = "">
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistMessageForField = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
return <#if doExistMessageForField>true<#else>false</#if>;
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
|
|
||||||
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
<#assign doExistErrorMessageForField = "">
|
||||||
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
|
||||||
|
|
||||||
<#assign doExistErrorOnUsernameOrPassword = "">
|
<#attempt>
|
||||||
|
<#assign doExistErrorMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
<#attempt>
|
return <#if doExistErrorMessageForField>true<#else>false</#if>;
|
||||||
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistErrorOnUsernameOrPassword = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
|
|
||||||
|
|
||||||
<#else>
|
|
||||||
|
|
||||||
<#assign doExistErrorMessageForField = "">
|
|
||||||
|
|
||||||
<#attempt>
|
|
||||||
<#assign doExistErrorMessageForField = messagesPerField.exists('${fieldName}')>
|
|
||||||
<#recover>
|
|
||||||
<#assign doExistErrorMessageForField = true>
|
|
||||||
</#attempt>
|
|
||||||
|
|
||||||
return <#if doExistErrorMessageForField>true<#else>false</#if>;
|
|
||||||
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
@ -390,6 +233,19 @@
|
|||||||
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
|
},
|
||||||
|
"getFirstError": function () {
|
||||||
|
|
||||||
|
for( let i = 0; i < arguments.length; i++ ){
|
||||||
|
|
||||||
|
const fieldName = arguments[i];
|
||||||
|
|
||||||
|
if( out.messagesPerField.existsError(fieldName) ){
|
||||||
|
return out.messagesPerField.get(fieldName);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -408,6 +264,14 @@
|
|||||||
out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
|
out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
|
||||||
out["pageId"] = "${pageId}";
|
out["pageId"] = "${pageId}";
|
||||||
|
|
||||||
|
try {
|
||||||
|
|
||||||
|
out["url"]["resourcesCommonPath"] = out["url"]["resourcesPath"] + "/" + "RESOURCES_COMMON_cLsLsMrtDkpVv";
|
||||||
|
|
||||||
|
} catch(error) {
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
return out;
|
return out;
|
||||||
|
|
||||||
})()
|
})()
|
||||||
@ -423,7 +287,7 @@
|
|||||||
<#if isHash>
|
<#if isHash>
|
||||||
|
|
||||||
<#if path?size gt 10>
|
<#if path?size gt 10>
|
||||||
<#return "ABORT: Too many recursive calls">
|
<#return "ABORT: Too many recursive calls, path: " + path?join(".")>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#local keys = "">
|
<#local keys = "">
|
||||||
@ -455,9 +319,10 @@
|
|||||||
<#-- https://github.com/keycloakify/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
|
<#-- https://github.com/keycloakify/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
|
||||||
<#-- https://github.com/keycloakify/keycloakify/issues/109#issuecomment-1134610163 -->
|
<#-- https://github.com/keycloakify/keycloakify/issues/109#issuecomment-1134610163 -->
|
||||||
<#-- https://github.com/keycloakify/keycloakify/issues/357 -->
|
<#-- https://github.com/keycloakify/keycloakify/issues/357 -->
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/discussions/406#discussioncomment-7514787 -->
|
||||||
key == "loginAction" &&
|
key == "loginAction" &&
|
||||||
are_same_path(path, ["url"]) &&
|
are_same_path(path, ["url"]) &&
|
||||||
["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl", "logout-confirm.ftl"]?seq_contains(pageId) &&
|
["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl", "logout-confirm.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) &&
|
||||||
!(auth?has_content && auth.showTryAnotherWayLink())
|
!(auth?has_content && auth.showTryAnotherWayLink())
|
||||||
) || (
|
) || (
|
||||||
<#-- https://github.com/keycloakify/keycloakify/issues/362 -->
|
<#-- https://github.com/keycloakify/keycloakify/issues/362 -->
|
||||||
@ -480,24 +345,45 @@
|
|||||||
!["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
|
!["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
|
||||||
) || (
|
) || (
|
||||||
"applications.ftl" == pageId &&
|
"applications.ftl" == pageId &&
|
||||||
are_same_path(path, ["applications", "applications", "*", "client", "realm"])
|
is_subpath(path, ["applications", "applications"]) &&
|
||||||
|
(
|
||||||
|
key == "realm" ||
|
||||||
|
key == "container"
|
||||||
|
)
|
||||||
) || (
|
) || (
|
||||||
"applications.ftl" == pageId &&
|
are_same_path(path, ["user"]) &&
|
||||||
"masterAdminClient" == key
|
key == "delegateForUpdate"
|
||||||
|
) || (
|
||||||
|
<#-- Security audit forwarded by Garth (Gmail) -->
|
||||||
|
are_same_path(path, ["client", "attributes"]) &&
|
||||||
|
key == "saml.signing.private.key"
|
||||||
|
) || (
|
||||||
|
<#-- See: https://github.com/keycloakify/keycloakify/issues/534 -->
|
||||||
|
are_same_path(path, ["login"]) &&
|
||||||
|
key == "password"
|
||||||
|
) || (
|
||||||
|
<#-- Remove realmAttributes added by https://github.com/jcputney/keycloak-theme-additional-info-extension for peace of mind. -->
|
||||||
|
are_same_path(path, []) &&
|
||||||
|
key == "realmAttributes"
|
||||||
)
|
)
|
||||||
>
|
>
|
||||||
<#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
<#local out_seq += ["/*If you need '" + path?join(".") + "." + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#if pageId == "register.ftl" && key == "attemptedUsername" && are_same_path(path, ["auth"])>
|
<#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
|
||||||
|
<#if (
|
||||||
|
["register.ftl", "info.ftl", "login.ftl", "login-update-password.ftl", "login-oauth2-device-verify-user-code.ftl"]?seq_contains(pageId) &&
|
||||||
|
key == "attemptedUsername" && are_same_path(path, ["auth"])
|
||||||
|
)>
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#-- https://github.com/keycloak/keycloak/blob/3a2bf0c04bcde185e497aaa32d0bb7ab7520cf4a/themes/src/main/resources/theme/base/login/template.ftl#L63 -->
|
<#-- https://github.com/keycloak/keycloak/blob/3a2bf0c04bcde185e497aaa32d0bb7ab7520cf4a/themes/src/main/resources/theme/base/login/template.ftl#L63 -->
|
||||||
<#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
|
|
||||||
<#if !(auth?has_content && auth.showUsername() && !auth.showResetCredentials())>
|
<#if !(auth?has_content && auth.showUsername() && !auth.showResetCredentials())>
|
||||||
|
<#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
<#recover>
|
||||||
|
<#local out_seq += ["/*Testing if attemptedUsername should be skipped throwed an exception */"]>
|
||||||
</#attempt>
|
</#attempt>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
@ -642,17 +528,28 @@
|
|||||||
<#return '"' + object?datetime?iso_utc + '"'>
|
<#return '"' + object?datetime?iso_utc + '"'>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
|
<#local isNumber = "">
|
||||||
|
<#attempt>
|
||||||
|
<#local isNumber = object?is_number>
|
||||||
|
<#recover>
|
||||||
|
<#return "ABORT: Can't test if it's a number">
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if isNumber>
|
||||||
|
<#return object?c>
|
||||||
|
</#if>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#return '"' + object?js_string + '"'>;
|
<#return '"' + object?js_string + '"'>;
|
||||||
<#recover>
|
<#recover>
|
||||||
</#attempt>
|
</#attempt>
|
||||||
|
|
||||||
<#return "ABORT: Couldn't convert into string non hash, non method, non boolean, non enumerable object">
|
<#return "ABORT: Couldn't convert into string non hash, non method, non boolean, non number, non enumerable object">
|
||||||
|
|
||||||
</#function>
|
</#function>
|
||||||
<#function are_same_path path searchedPath>
|
<#function is_subpath path searchedPath>
|
||||||
|
|
||||||
<#if path?size != searchedPath?size>
|
<#if path?size < searchedPath?size>
|
||||||
<#return false>
|
<#return false>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
@ -660,8 +557,14 @@
|
|||||||
|
|
||||||
<#list path as property>
|
<#list path as property>
|
||||||
|
|
||||||
|
<#if i == searchedPath?size >
|
||||||
|
<#continue>
|
||||||
|
</#if>
|
||||||
|
|
||||||
<#local searchedProperty=searchedPath[i]>
|
<#local searchedProperty=searchedPath[i]>
|
||||||
|
|
||||||
|
<#local i+= 1>
|
||||||
|
|
||||||
<#if searchedProperty?is_string && searchedProperty == "*">
|
<#if searchedProperty?is_string && searchedProperty == "*">
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
@ -678,11 +581,13 @@
|
|||||||
<#return false>
|
<#return false>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#local i+= 1>
|
|
||||||
|
|
||||||
</#list>
|
</#list>
|
||||||
|
|
||||||
<#return true>
|
<#return true>
|
||||||
|
|
||||||
</#function>
|
</#function>
|
||||||
|
|
||||||
|
<#function are_same_path path searchedPath>
|
||||||
|
<#return path?size == searchedPath?size && is_subpath(path, searchedPath)>
|
||||||
|
</#function>
|
||||||
</script>
|
</script>
|
@ -1,18 +1,19 @@
|
|||||||
import cheerio from "cheerio";
|
import cheerio from "cheerio";
|
||||||
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
|
||||||
import { generateCssCodeToDefineGlobals } from "../replacers/replaceImportsInCssCode";
|
import { generateCssCodeToDefineGlobals } from "../replacers/replaceImportsInCssCode";
|
||||||
import { replaceImportsInInlineCssCode } from "../replacers/replaceImportsInInlineCssCode";
|
import { replaceImportsInInlineCssCode } from "../replacers/replaceImportsInInlineCssCode";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { objectKeys } from "tsafe/objectKeys";
|
import type { BuildOptions } from "../buildOptions";
|
||||||
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { ThemeType } from "../../constants";
|
import { type ThemeType, nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir, resources_common } from "../../constants";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
|
bundler: "vite" | "webpack";
|
||||||
themeVersion: string;
|
themeVersion: string;
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
assetsDirPath: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
@ -20,7 +21,6 @@ assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
|||||||
export function generateFtlFilesCodeFactory(params: {
|
export function generateFtlFilesCodeFactory(params: {
|
||||||
themeName: string;
|
themeName: string;
|
||||||
indexHtmlCode: string;
|
indexHtmlCode: string;
|
||||||
//NOTE: Expected to be an empty object if external assets mode is enabled.
|
|
||||||
cssGlobalsToDefine: Record<string, string>;
|
cssGlobalsToDefine: Record<string, string>;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
@ -37,7 +37,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
|
|
||||||
assert(jsCode !== null);
|
assert(jsCode !== null);
|
||||||
|
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({ jsCode });
|
const { fixedJsCode } = replaceImportsInJsCode({ jsCode, buildOptions });
|
||||||
|
|
||||||
$(element).text(fixedJsCode);
|
$(element).text(fixedJsCode);
|
||||||
});
|
});
|
||||||
@ -70,7 +70,10 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
|
|
||||||
$(element).attr(
|
$(element).attr(
|
||||||
attrName,
|
attrName,
|
||||||
href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
|
href.replace(
|
||||||
|
new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`),
|
||||||
|
`\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/`
|
||||||
|
)
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@ -92,34 +95,20 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
//FTL is no valid html, we can't insert with cheerio, we put placeholder for injecting later.
|
//FTL is no valid html, we can't insert with cheerio, we put placeholder for injecting later.
|
||||||
const replaceValueBySearchValue = {
|
const ftlObjectToJsCodeDeclaringAnObject = fs
|
||||||
'{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }': fs
|
.readFileSync(pathJoin(__dirname, "ftl_object_to_js_code_declaring_an_object.ftl"))
|
||||||
.readFileSync(pathJoin(__dirname, "ftl_object_to_js_code_declaring_an_object.ftl"))
|
.toString("utf8")
|
||||||
.toString("utf8")
|
.match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
|
||||||
.match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
|
.replace("FIELD_NAMES_eKsIY4ZsZ4xeM", fieldNames.map(name => `"${name}"`).join(", "))
|
||||||
.replace("FIELD_NAMES_eKsIY4ZsZ4xeM", fieldNames.map(name => `"${name}"`).join(", "))
|
.replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
|
||||||
.replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
|
.replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
|
||||||
.replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
|
.replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
|
||||||
.replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
|
.replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName)
|
||||||
.replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName),
|
.replace("RESOURCES_COMMON_cLsLsMrtDkpVv", resources_common);
|
||||||
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
|
||||||
"<#if scripts??>",
|
|
||||||
" <#list scripts as script>",
|
|
||||||
' <script src="${script}" type="text/javascript"></script>',
|
|
||||||
" </#list>",
|
|
||||||
"</#if>"
|
|
||||||
].join("\n")
|
|
||||||
};
|
|
||||||
|
|
||||||
$("head").prepend(
|
const ftlObjectToJsCodeDeclaringAnObjectPlaceholder = '{ "x": "vIdLqMeOed9sdLdIdOxdK0d" }';
|
||||||
[
|
|
||||||
"<script>",
|
$("head").prepend(["<script>", ` window.${nameOfTheGlobal}= ${ftlObjectToJsCodeDeclaringAnObjectPlaceholder};`, "</script>"].join("\n"));
|
||||||
` window.${ftlValuesGlobalName}= ${objectKeys(replaceValueBySearchValue)[0]};`,
|
|
||||||
"</script>",
|
|
||||||
"",
|
|
||||||
objectKeys(replaceValueBySearchValue)[1]
|
|
||||||
].join("\n")
|
|
||||||
);
|
|
||||||
|
|
||||||
// Remove part of the document marked as ignored.
|
// Remove part of the document marked as ignored.
|
||||||
{
|
{
|
||||||
@ -154,7 +143,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
let ftlCode = $.html();
|
let ftlCode = $.html();
|
||||||
|
|
||||||
Object.entries({
|
Object.entries({
|
||||||
...replaceValueBySearchValue,
|
[ftlObjectToJsCodeDeclaringAnObjectPlaceholder]: ftlObjectToJsCodeDeclaringAnObject,
|
||||||
"PAGE_ID_xIgLsPgGId9D8e": pageId
|
"PAGE_ID_xIgLsPgGId9D8e": pageId
|
||||||
}).map(([searchValue, replaceValue]) => (ftlCode = ftlCode.replace(searchValue, replaceValue)));
|
}).map(([searchValue, replaceValue]) => (ftlCode = ftlCode.replace(searchValue, replaceValue)));
|
||||||
|
|
||||||
|
@ -3,8 +3,8 @@ export const loginThemePageIds = [
|
|||||||
"login-username.ftl",
|
"login-username.ftl",
|
||||||
"login-password.ftl",
|
"login-password.ftl",
|
||||||
"webauthn-authenticate.ftl",
|
"webauthn-authenticate.ftl",
|
||||||
|
"webauthn-register.ftl",
|
||||||
"register.ftl",
|
"register.ftl",
|
||||||
"register-user-profile.ftl",
|
|
||||||
"info.ftl",
|
"info.ftl",
|
||||||
"error.ftl",
|
"error.ftl",
|
||||||
"login-reset-password.ftl",
|
"login-reset-password.ftl",
|
||||||
@ -20,14 +20,22 @@ export const loginThemePageIds = [
|
|||||||
"login-page-expired.ftl",
|
"login-page-expired.ftl",
|
||||||
"login-config-totp.ftl",
|
"login-config-totp.ftl",
|
||||||
"logout-confirm.ftl",
|
"logout-confirm.ftl",
|
||||||
"update-user-profile.ftl",
|
|
||||||
"idp-review-user-profile.ftl",
|
"idp-review-user-profile.ftl",
|
||||||
"update-email.ftl",
|
"update-email.ftl",
|
||||||
"select-authenticator.ftl",
|
"select-authenticator.ftl",
|
||||||
"saml-post-form.ftl"
|
"saml-post-form.ftl",
|
||||||
|
"delete-credential.ftl",
|
||||||
|
"code.ftl",
|
||||||
|
"delete-account-confirm.ftl",
|
||||||
|
"frontchannel-logout.ftl",
|
||||||
|
"login-recovery-authn-code-config.ftl",
|
||||||
|
"login-recovery-authn-code-input.ftl",
|
||||||
|
"login-reset-otp.ftl",
|
||||||
|
"login-x509-info.ftl",
|
||||||
|
"webauthn-error.ftl"
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
|
export const accountThemePageIds = ["password.ftl", "account.ftl", "sessions.ftl", "totp.ftl", "applications.ftl", "log.ftl"] as const;
|
||||||
|
|
||||||
export type LoginThemePageId = (typeof loginThemePageIds)[number];
|
export type LoginThemePageId = (typeof loginThemePageIds)[number];
|
||||||
export type AccountThemePageId = (typeof accountThemePageIds)[number];
|
export type AccountThemePageId = (typeof accountThemePageIds)[number];
|
||||||
|
@ -1,87 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { resources_common, lastKeycloakVersionWithAccountV1, accountV1 } from "../../constants";
|
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
|
||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike }) {
|
|
||||||
const { buildOptions } = params;
|
|
||||||
|
|
||||||
const builtinKeycloakThemeTmpDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "..", "tmp_yxdE2_builtin_keycloak_theme");
|
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
|
||||||
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
|
||||||
"keycloakVersion": lastKeycloakVersionWithAccountV1,
|
|
||||||
buildOptions
|
|
||||||
});
|
|
||||||
|
|
||||||
const accountV1DirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme", accountV1, "account");
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "account"),
|
|
||||||
"destDirPath": accountV1DirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
const commonResourceFilePaths = [
|
|
||||||
"node_modules/patternfly/dist/css/patternfly.min.css",
|
|
||||||
"node_modules/patternfly/dist/css/patternfly-additions.min.css"
|
|
||||||
];
|
|
||||||
|
|
||||||
for (const relativeFilePath of commonResourceFilePaths.map(path => pathJoin(...path.split("/")))) {
|
|
||||||
const destFilePath = pathJoin(accountV1DirPath, "resources", resources_common, relativeFilePath);
|
|
||||||
|
|
||||||
fs.mkdirSync(pathDirname(destFilePath), { "recursive": true });
|
|
||||||
|
|
||||||
fs.cpSync(pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "common", "resources", relativeFilePath), destFilePath);
|
|
||||||
}
|
|
||||||
|
|
||||||
const resourceFilePaths = ["css/account.css"];
|
|
||||||
|
|
||||||
for (const relativeFilePath of resourceFilePaths.map(path => pathJoin(...path.split("/")))) {
|
|
||||||
const destFilePath = pathJoin(accountV1DirPath, "resources", relativeFilePath);
|
|
||||||
|
|
||||||
fs.mkdirSync(pathDirname(destFilePath), { "recursive": true });
|
|
||||||
|
|
||||||
fs.cpSync(pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "account", "resources", relativeFilePath), destFilePath);
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true });
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(accountV1DirPath, "theme.properties"),
|
|
||||||
Buffer.from(
|
|
||||||
[
|
|
||||||
"accountResourceProvider=account-v1",
|
|
||||||
"",
|
|
||||||
"locales=ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
|
||||||
"",
|
|
||||||
"styles=" + [...resourceFilePaths, ...commonResourceFilePaths.map(path => `resources_common/${path}`)].join(" "),
|
|
||||||
"",
|
|
||||||
"##### css classes for form buttons",
|
|
||||||
"# main class used for all buttons",
|
|
||||||
"kcButtonClass=btn",
|
|
||||||
"# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
|
|
||||||
"kcButtonPrimaryClass=btn-primary",
|
|
||||||
"kcButtonDefaultClass=btn-default",
|
|
||||||
"# classes defining size of the button",
|
|
||||||
"kcButtonLargeClass=btn-lg",
|
|
||||||
""
|
|
||||||
].join("\n"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,140 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { type ThemeType, retrocompatPostfix, accountV1 } from "../../constants";
|
|
||||||
import { bringInAccountV1 } from "./bringInAccountV1";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
themeVersion: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
themeNames: string[];
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function generateJavaStackFiles(params: {
|
|
||||||
implementedThemeTypes: Record<ThemeType | "email", boolean>;
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
}): Promise<{
|
|
||||||
jarFilePath: string;
|
|
||||||
}> {
|
|
||||||
const { implementedThemeTypes, buildOptions } = params;
|
|
||||||
|
|
||||||
{
|
|
||||||
const { pomFileCode } = (function generatePomFileCode(): {
|
|
||||||
pomFileCode: string;
|
|
||||||
} {
|
|
||||||
const pomFileCode = [
|
|
||||||
`<?xml version="1.0"?>`,
|
|
||||||
`<project xmlns="http://maven.apache.org/POM/4.0.0"`,
|
|
||||||
` xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`,
|
|
||||||
` xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">`,
|
|
||||||
` <modelVersion>4.0.0</modelVersion>`,
|
|
||||||
` <groupId>${buildOptions.groupId}</groupId>`,
|
|
||||||
` <artifactId>${buildOptions.artifactId}</artifactId>`,
|
|
||||||
` <version>${buildOptions.themeVersion}</version>`,
|
|
||||||
` <name>${buildOptions.artifactId}</name>`,
|
|
||||||
` <description />`,
|
|
||||||
` <packaging>jar</packaging>`,
|
|
||||||
` <properties>`,
|
|
||||||
` <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>`,
|
|
||||||
` </properties>`,
|
|
||||||
` <build>`,
|
|
||||||
` <plugins>`,
|
|
||||||
` <plugin>`,
|
|
||||||
` <groupId>org.apache.maven.plugins</groupId>`,
|
|
||||||
` <artifactId>maven-shade-plugin</artifactId>`,
|
|
||||||
` <version>3.5.1</version>`,
|
|
||||||
` <executions>`,
|
|
||||||
` <execution>`,
|
|
||||||
` <phase>package</phase>`,
|
|
||||||
` <goals>`,
|
|
||||||
` <goal>shade</goal>`,
|
|
||||||
` </goals>`,
|
|
||||||
` </execution>`,
|
|
||||||
` </executions>`,
|
|
||||||
` </plugin>`,
|
|
||||||
` </plugins>`,
|
|
||||||
` </build>`,
|
|
||||||
` <dependencies>`,
|
|
||||||
` <dependency>`,
|
|
||||||
` <groupId>io.phasetwo.keycloak</groupId>`,
|
|
||||||
` <artifactId>keycloak-account-v1</artifactId>`,
|
|
||||||
` <version>0.1</version>`,
|
|
||||||
` </dependency>`,
|
|
||||||
` </dependencies>`,
|
|
||||||
`</project>`
|
|
||||||
].join("\n");
|
|
||||||
|
|
||||||
return { pomFileCode };
|
|
||||||
})();
|
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (implementedThemeTypes.account) {
|
|
||||||
await bringInAccountV1({ buildOptions });
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const themeManifestFilePath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "META-INF", "keycloak-themes.json");
|
|
||||||
|
|
||||||
try {
|
|
||||||
fs.mkdirSync(pathDirname(themeManifestFilePath));
|
|
||||||
} catch {}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
themeManifestFilePath,
|
|
||||||
Buffer.from(
|
|
||||||
JSON.stringify(
|
|
||||||
{
|
|
||||||
"themes": [
|
|
||||||
...(!implementedThemeTypes.account
|
|
||||||
? []
|
|
||||||
: [
|
|
||||||
{
|
|
||||||
"name": accountV1,
|
|
||||||
"types": ["account"]
|
|
||||||
}
|
|
||||||
]),
|
|
||||||
...buildOptions.themeNames
|
|
||||||
.map(themeName => [
|
|
||||||
{
|
|
||||||
"name": themeName,
|
|
||||||
"types": Object.entries(implementedThemeTypes)
|
|
||||||
.filter(([, isImplemented]) => isImplemented)
|
|
||||||
.map(([themeType]) => themeType)
|
|
||||||
},
|
|
||||||
...(!implementedThemeTypes.account
|
|
||||||
? []
|
|
||||||
: [
|
|
||||||
{
|
|
||||||
"name": `${themeName}${retrocompatPostfix}`,
|
|
||||||
"types": ["account"]
|
|
||||||
}
|
|
||||||
])
|
|
||||||
])
|
|
||||||
.flat()
|
|
||||||
]
|
|
||||||
},
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"jarFilePath": pathJoin(buildOptions.keycloakifyBuildDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`)
|
|
||||||
};
|
|
||||||
}
|
|
@ -1 +0,0 @@
|
|||||||
export * from "./generateJavaStackFiles";
|
|
@ -1,26 +1,22 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
|
import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { Reflect } from "tsafe/Reflect";
|
import type { BuildOptions } from "./buildOptions";
|
||||||
import type { BuildOptions } from "./BuildOptions";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
keycloakifyBuildDirPath: string;
|
keycloakifyBuildDirPath: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
{
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
|
generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
|
||||||
|
|
||||||
const containerName = "keycloak-testing-container";
|
const containerName = "keycloak-testing-container";
|
||||||
|
const keycloakVersion = "24.0.4";
|
||||||
|
|
||||||
/** Files for being able to run a hot reload keycloak container */
|
/** Files for being able to run a hot reload keycloak container */
|
||||||
export function generateStartKeycloakTestingContainer(params: { jarFilePath: string; keycloakVersion: string; buildOptions: BuildOptionsLike }) {
|
export function generateStartKeycloakTestingContainer(params: { jarFilePath: string; buildOptions: BuildOptionsLike }) {
|
||||||
const { jarFilePath, keycloakVersion, buildOptions } = params;
|
const { jarFilePath, buildOptions } = params;
|
||||||
|
|
||||||
const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
|
const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
|
||||||
const themeDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, themeRelativeDirPath);
|
const themeDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, themeRelativeDirPath);
|
||||||
|
78
src/bin/keycloakify/generateTheme/bringInAccountV1.ts
Normal file
78
src/bin/keycloakify/generateTheme/bringInAccountV1.ts
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "../buildOptions";
|
||||||
|
import { resources_common, lastKeycloakVersionWithAccountV1, accountV1ThemeName } from "../../constants";
|
||||||
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
|
import { rmSync } from "../../tools/fs.rmSync";
|
||||||
|
|
||||||
|
type BuildOptionsLike = {
|
||||||
|
cacheDirPath: string;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike; srcMainResourcesDirPath: string }) {
|
||||||
|
const { buildOptions, srcMainResourcesDirPath } = params;
|
||||||
|
|
||||||
|
const builtinKeycloakThemeTmpDirPath = pathJoin(srcMainResourcesDirPath, "..", "tmp_yxdE2_builtin_keycloak_theme");
|
||||||
|
|
||||||
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
||||||
|
"keycloakVersion": lastKeycloakVersionWithAccountV1,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
|
const accountV1DirPath = pathJoin(srcMainResourcesDirPath, "theme", accountV1ThemeName, "account");
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "account"),
|
||||||
|
"destDirPath": accountV1DirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "account", "resources"),
|
||||||
|
"destDirPath": pathJoin(accountV1DirPath, "resources")
|
||||||
|
});
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "common", "resources"),
|
||||||
|
"destDirPath": pathJoin(accountV1DirPath, "resources", resources_common)
|
||||||
|
});
|
||||||
|
|
||||||
|
rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true });
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
pathJoin(accountV1DirPath, "theme.properties"),
|
||||||
|
Buffer.from(
|
||||||
|
[
|
||||||
|
"accountResourceProvider=account-v1",
|
||||||
|
"",
|
||||||
|
"locales=ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
||||||
|
"",
|
||||||
|
"styles=" +
|
||||||
|
[
|
||||||
|
"css/account.css",
|
||||||
|
"img/icon-sidebar-active.png",
|
||||||
|
"img/logo.png",
|
||||||
|
...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(
|
||||||
|
fileBasename => `${resources_common}/node_modules/patternfly/dist/css/${fileBasename}`
|
||||||
|
)
|
||||||
|
].join(" "),
|
||||||
|
"",
|
||||||
|
"##### css classes for form buttons",
|
||||||
|
"# main class used for all buttons",
|
||||||
|
"kcButtonClass=btn",
|
||||||
|
"# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
|
||||||
|
"kcButtonPrimaryClass=btn-primary",
|
||||||
|
"kcButtonDefaultClass=btn-default",
|
||||||
|
"# classes defining size of the button",
|
||||||
|
"kcButtonLargeClass=btn-lg",
|
||||||
|
""
|
||||||
|
].join("\n"),
|
||||||
|
"utf8"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
@ -1,57 +1,27 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import { join as pathJoin } from "path";
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
import { resources_common, type ThemeType } from "../../constants";
|
import { resources_common, type ThemeType } from "../../constants";
|
||||||
import { BuildOptions } from "../BuildOptions";
|
import { BuildOptions } from "../buildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import * as crypto from "crypto";
|
import * as crypto from "crypto";
|
||||||
|
import { rmSync } from "../../tools/fs.rmSync";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
cacheDirPath: string;
|
cacheDirPath: string;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function downloadKeycloakStaticResources(
|
export async function downloadKeycloakStaticResources(params: {
|
||||||
// prettier-ignore
|
themeType: ThemeType;
|
||||||
params: {
|
themeDirPath: string;
|
||||||
themeType: ThemeType;
|
keycloakVersion: string;
|
||||||
themeDirPath: string;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakVersion: string;
|
}) {
|
||||||
usedResources: {
|
|
||||||
resourcesCommonFilePaths: string[];
|
|
||||||
} | undefined;
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
}
|
|
||||||
) {
|
|
||||||
const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
|
const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
|
||||||
|
|
||||||
// NOTE: Hack for 427
|
|
||||||
const usedResources = (() => {
|
|
||||||
const { usedResources } = params;
|
|
||||||
|
|
||||||
if (usedResources === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
assert(usedResources !== undefined);
|
|
||||||
|
|
||||||
return {
|
|
||||||
"resourcesCommonDirPaths": usedResources.resourcesCommonFilePaths.map(filePath => {
|
|
||||||
{
|
|
||||||
const splitArg = "/dist/";
|
|
||||||
|
|
||||||
if (filePath.includes(splitArg)) {
|
|
||||||
return filePath.split(splitArg)[0] + splitArg;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathDirname(filePath);
|
|
||||||
})
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(
|
const tmpDirPath = pathJoin(
|
||||||
themeDirPath,
|
themeDirPath,
|
||||||
`tmp_suLeKsxId_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
|
`tmp_suLeKsxId_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
|
||||||
@ -72,18 +42,8 @@ export async function downloadKeycloakStaticResources(
|
|||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
||||||
"destDirPath": pathJoin(resourcesPath, resources_common),
|
"destDirPath": pathJoin(resourcesPath, resources_common)
|
||||||
"transformSourceCode":
|
|
||||||
usedResources === undefined
|
|
||||||
? undefined
|
|
||||||
: ({ fileRelativePath, sourceCode }) => {
|
|
||||||
if (usedResources.resourcesCommonDirPaths.find(dirPath => fileRelativePath.startsWith(dirPath)) === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
}
|
}
|
||||||
|
267
src/bin/keycloakify/generateTheme/generateSrcMainResources.ts
Normal file
267
src/bin/keycloakify/generateTheme/generateSrcMainResources.ts
Normal file
@ -0,0 +1,267 @@
|
|||||||
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin, resolve as pathResolve, dirname as pathDirname } from "path";
|
||||||
|
import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
|
||||||
|
import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
|
||||||
|
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds } from "../generateFtl";
|
||||||
|
import {
|
||||||
|
type ThemeType,
|
||||||
|
lastKeycloakVersionWithAccountV1,
|
||||||
|
keycloak_resources,
|
||||||
|
accountV1ThemeName,
|
||||||
|
basenameOfTheKeycloakifyResourcesDir
|
||||||
|
} from "../../constants";
|
||||||
|
import { isInside } from "../../tools/isInside";
|
||||||
|
import type { BuildOptions } from "../buildOptions";
|
||||||
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
|
import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
|
||||||
|
import { readFieldNameUsage } from "./readFieldNameUsage";
|
||||||
|
import { readExtraPagesNames } from "./readExtraPageNames";
|
||||||
|
import { generateMessageProperties } from "./generateMessageProperties";
|
||||||
|
import { bringInAccountV1 } from "./bringInAccountV1";
|
||||||
|
import { rmSync } from "../../tools/fs.rmSync";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
bundler: "vite" | "webpack";
|
||||||
|
extraThemeProperties: string[] | undefined;
|
||||||
|
themeVersion: string;
|
||||||
|
loginThemeResourcesFromKeycloakVersion: string;
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
cacheDirPath: string;
|
||||||
|
assetsDirPath: string;
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
npmWorkspaceRootDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export async function generateSrcMainResources(params: {
|
||||||
|
themeName: string;
|
||||||
|
themeSrcDirPath: string;
|
||||||
|
keycloakifySrcDirPath: string;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
keycloakifyVersion: string;
|
||||||
|
srcMainResourcesDirPath: string;
|
||||||
|
}): Promise<{ doesImplementAccountTheme: boolean }> {
|
||||||
|
const { themeName, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion, srcMainResourcesDirPath } = params;
|
||||||
|
|
||||||
|
const getThemeTypeDirPath = (params: { themeType: ThemeType | "email" }) => {
|
||||||
|
const { themeType } = params;
|
||||||
|
return pathJoin(srcMainResourcesDirPath, "theme", themeName, themeType);
|
||||||
|
};
|
||||||
|
|
||||||
|
const cssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
|
const implementedThemeTypes: Record<ThemeType | "email", boolean> = {
|
||||||
|
"login": false,
|
||||||
|
"account": false,
|
||||||
|
"email": false
|
||||||
|
};
|
||||||
|
|
||||||
|
for (const themeType of ["login", "account"] as const) {
|
||||||
|
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
implementedThemeTypes[themeType] = true;
|
||||||
|
|
||||||
|
const themeTypeDirPath = getThemeTypeDirPath({ themeType });
|
||||||
|
|
||||||
|
apply_replacers_and_move_to_theme_resources: {
|
||||||
|
const destDirPath = pathJoin(themeTypeDirPath, "resources", basenameOfTheKeycloakifyResourcesDir);
|
||||||
|
|
||||||
|
// NOTE: Prevent accumulation of files in the assets dir, as names are hashed they pile up.
|
||||||
|
rmSync(destDirPath, { "recursive": true, "force": true });
|
||||||
|
|
||||||
|
if (themeType === "account" && implementedThemeTypes.login) {
|
||||||
|
// NOTE: We prevend doing it twice, it has been done for the login theme.
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": pathJoin(
|
||||||
|
getThemeTypeDirPath({
|
||||||
|
"themeType": "login"
|
||||||
|
}),
|
||||||
|
"resources",
|
||||||
|
basenameOfTheKeycloakifyResourcesDir
|
||||||
|
),
|
||||||
|
destDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
break apply_replacers_and_move_to_theme_resources;
|
||||||
|
}
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": buildOptions.reactAppBuildDirPath,
|
||||||
|
destDirPath,
|
||||||
|
"transformSourceCode": ({ filePath, sourceCode }) => {
|
||||||
|
//NOTE: Prevent cycles, excludes the folder we generated for debug in public/
|
||||||
|
// This should not happen if users follow the new instruction setup but we keep it for retrocompatibility.
|
||||||
|
if (
|
||||||
|
isInside({
|
||||||
|
"dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
|
||||||
|
filePath
|
||||||
|
})
|
||||||
|
) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (/\.css?$/i.test(filePath)) {
|
||||||
|
const { cssGlobalsToDefine: cssGlobalsToDefineForThisFile, fixedCssCode } = replaceImportsInCssCode({
|
||||||
|
"cssCode": sourceCode.toString("utf8")
|
||||||
|
});
|
||||||
|
|
||||||
|
Object.entries(cssGlobalsToDefineForThisFile).forEach(([key, value]) => {
|
||||||
|
cssGlobalsToDefine[key] = value;
|
||||||
|
});
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
|
||||||
|
}
|
||||||
|
|
||||||
|
if (/\.js?$/i.test(filePath)) {
|
||||||
|
const { fixedJsCode } = replaceImportsInJsCode({
|
||||||
|
"jsCode": sourceCode.toString("utf8"),
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
|
||||||
|
themeName,
|
||||||
|
"indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
|
||||||
|
cssGlobalsToDefine,
|
||||||
|
buildOptions,
|
||||||
|
keycloakifyVersion,
|
||||||
|
themeType,
|
||||||
|
"fieldNames": readFieldNameUsage({
|
||||||
|
keycloakifySrcDirPath,
|
||||||
|
themeSrcDirPath,
|
||||||
|
themeType
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
[
|
||||||
|
...(() => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "login":
|
||||||
|
return loginThemePageIds;
|
||||||
|
case "account":
|
||||||
|
return accountThemePageIds;
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
...readExtraPagesNames({
|
||||||
|
themeType,
|
||||||
|
themeSrcDirPath
|
||||||
|
})
|
||||||
|
].forEach(pageId => {
|
||||||
|
const { ftlCode } = generateFtlFilesCode({ pageId });
|
||||||
|
|
||||||
|
fs.mkdirSync(themeTypeDirPath, { "recursive": true });
|
||||||
|
|
||||||
|
fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
||||||
|
});
|
||||||
|
|
||||||
|
generateMessageProperties({
|
||||||
|
themeSrcDirPath,
|
||||||
|
themeType
|
||||||
|
}).forEach(({ languageTag, propertiesFileSource }) => {
|
||||||
|
const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
|
||||||
|
|
||||||
|
fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
|
||||||
|
|
||||||
|
const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
|
||||||
|
|
||||||
|
fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
|
||||||
|
});
|
||||||
|
|
||||||
|
await downloadKeycloakStaticResources({
|
||||||
|
"keycloakVersion": (() => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "account":
|
||||||
|
return lastKeycloakVersionWithAccountV1;
|
||||||
|
case "login":
|
||||||
|
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
"themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
|
||||||
|
themeType,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
pathJoin(themeTypeDirPath, "theme.properties"),
|
||||||
|
Buffer.from(
|
||||||
|
[
|
||||||
|
`parent=${(() => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "account":
|
||||||
|
return accountV1ThemeName;
|
||||||
|
case "login":
|
||||||
|
return "keycloak";
|
||||||
|
}
|
||||||
|
assert<Equals<typeof themeType, never>>(false);
|
||||||
|
})()}`,
|
||||||
|
...(buildOptions.extraThemeProperties ?? [])
|
||||||
|
].join("\n\n"),
|
||||||
|
"utf8"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
email: {
|
||||||
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
|
|
||||||
|
if (!fs.existsSync(emailThemeSrcDirPath)) {
|
||||||
|
break email;
|
||||||
|
}
|
||||||
|
|
||||||
|
implementedThemeTypes.email = true;
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": emailThemeSrcDirPath,
|
||||||
|
"destDirPath": getThemeTypeDirPath({ "themeType": "email" })
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const parsedKeycloakThemeJson: { themes: { name: string; types: string[] }[] } = { "themes": [] };
|
||||||
|
|
||||||
|
parsedKeycloakThemeJson.themes.push({
|
||||||
|
"name": themeName,
|
||||||
|
"types": Object.entries(implementedThemeTypes)
|
||||||
|
.filter(([, isImplemented]) => isImplemented)
|
||||||
|
.map(([themeType]) => themeType)
|
||||||
|
});
|
||||||
|
|
||||||
|
account_specific_extra_work: {
|
||||||
|
if (!implementedThemeTypes.account) {
|
||||||
|
break account_specific_extra_work;
|
||||||
|
}
|
||||||
|
|
||||||
|
await bringInAccountV1({
|
||||||
|
srcMainResourcesDirPath,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
|
parsedKeycloakThemeJson.themes.push({
|
||||||
|
"name": accountV1ThemeName,
|
||||||
|
"types": ["account"]
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const keycloakThemeJsonFilePath = pathJoin(srcMainResourcesDirPath, "META-INF", "keycloak-themes.json");
|
||||||
|
|
||||||
|
try {
|
||||||
|
fs.mkdirSync(pathDirname(keycloakThemeJsonFilePath));
|
||||||
|
} catch {}
|
||||||
|
|
||||||
|
fs.writeFileSync(keycloakThemeJsonFilePath, Buffer.from(JSON.stringify(parsedKeycloakThemeJson, null, 2), "utf8"));
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "doesImplementAccountTheme": implementedThemeTypes.account };
|
||||||
|
}
|
@ -1,234 +1,44 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { join as pathJoin } from "path";
|
||||||
import * as fs from "fs";
|
import type { BuildOptions } from "../buildOptions";
|
||||||
import { join as pathJoin, basename as pathBasename, resolve as pathResolve } from "path";
|
import { assert } from "tsafe/assert";
|
||||||
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
import { generateSrcMainResources, type BuildOptionsLike as BuildOptionsLike_generateSrcMainResources } from "./generateSrcMainResources";
|
||||||
import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
|
import { generateThemeVariations } from "./generateThemeVariants";
|
||||||
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds } from "../generateFtl";
|
|
||||||
import { themeTypes, type ThemeType, lastKeycloakVersionWithAccountV1, keycloak_resources, retrocompatPostfix, accountV1 } from "../../constants";
|
|
||||||
import { isInside } from "../../tools/isInside";
|
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { assert, type Equals } from "tsafe/assert";
|
|
||||||
import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
|
|
||||||
import { readFieldNameUsage } from "./readFieldNameUsage";
|
|
||||||
import { readExtraPagesNames } from "./readExtraPageNames";
|
|
||||||
import { generateMessageProperties } from "./generateMessageProperties";
|
|
||||||
import { readStaticResourcesUsage } from "./readStaticResourcesUsage";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = BuildOptionsLike_generateSrcMainResources & {
|
||||||
extraThemeProperties: string[] | undefined;
|
|
||||||
themeVersion: string;
|
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
keycloakifyBuildDirPath: string;
|
keycloakifyBuildDirPath: string;
|
||||||
reactAppBuildDirPath: string;
|
themeNames: string[];
|
||||||
cacheDirPath: string;
|
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function generateTheme(params: {
|
export async function generateTheme(params: {
|
||||||
themeName: string;
|
|
||||||
themeSrcDirPath: string;
|
themeSrcDirPath: string;
|
||||||
keycloakifySrcDirPath: string;
|
keycloakifySrcDirPath: string;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
}): Promise<void> {
|
}): Promise<{ doesImplementAccountTheme: boolean }> {
|
||||||
const { themeName, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
|
const { themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
|
||||||
|
|
||||||
const getThemeTypeDirPath = (params: { themeType: ThemeType | "email"; isRetrocompat?: true }) => {
|
const [themeName, ...themeVariantNames] = buildOptions.themeNames;
|
||||||
const { themeType, isRetrocompat = false } = params;
|
|
||||||
return pathJoin(
|
|
||||||
buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"src",
|
|
||||||
"main",
|
|
||||||
"resources",
|
|
||||||
"theme",
|
|
||||||
`${themeName}${isRetrocompat ? retrocompatPostfix : ""}`,
|
|
||||||
themeType
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
let allCssGlobalsToDefine: Record<string, string> = {};
|
const srcMainResourcesDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources");
|
||||||
|
|
||||||
let generateFtlFilesCode_glob: ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"] | undefined = undefined;
|
const { doesImplementAccountTheme } = await generateSrcMainResources({
|
||||||
|
themeName,
|
||||||
|
srcMainResourcesDirPath,
|
||||||
|
themeSrcDirPath,
|
||||||
|
keycloakifySrcDirPath,
|
||||||
|
keycloakifyVersion,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
for (const themeType of themeTypes) {
|
for (const themeVariantName of themeVariantNames) {
|
||||||
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
generateThemeVariations({
|
||||||
continue;
|
themeName,
|
||||||
}
|
themeVariantName,
|
||||||
|
srcMainResourcesDirPath
|
||||||
const themeTypeDirPath = getThemeTypeDirPath({ themeType });
|
|
||||||
|
|
||||||
copy_app_resources_to_theme_path: {
|
|
||||||
const isFirstPass = themeType.indexOf(themeType) === 0;
|
|
||||||
|
|
||||||
if (!isFirstPass) {
|
|
||||||
break copy_app_resources_to_theme_path;
|
|
||||||
}
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"destDirPath": pathJoin(themeTypeDirPath, "resources", "build"),
|
|
||||||
"srcDirPath": buildOptions.reactAppBuildDirPath,
|
|
||||||
"transformSourceCode": ({ filePath, sourceCode }) => {
|
|
||||||
//NOTE: Prevent cycles, excludes the folder we generated for debug in public/
|
|
||||||
if (
|
|
||||||
isInside({
|
|
||||||
"dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
|
|
||||||
filePath
|
|
||||||
})
|
|
||||||
) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (/\.css?$/i.test(filePath)) {
|
|
||||||
const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
|
|
||||||
"cssCode": sourceCode.toString("utf8")
|
|
||||||
});
|
|
||||||
|
|
||||||
register_css_variables: {
|
|
||||||
if (!isFirstPass) {
|
|
||||||
break register_css_variables;
|
|
||||||
}
|
|
||||||
|
|
||||||
allCssGlobalsToDefine = {
|
|
||||||
...allCssGlobalsToDefine,
|
|
||||||
...cssGlobalsToDefine
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
|
|
||||||
}
|
|
||||||
|
|
||||||
if (/\.js?$/i.test(filePath)) {
|
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
|
||||||
"jsCode": sourceCode.toString("utf8")
|
|
||||||
});
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
const generateFtlFilesCode =
|
|
||||||
generateFtlFilesCode_glob !== undefined
|
|
||||||
? generateFtlFilesCode_glob
|
|
||||||
: generateFtlFilesCodeFactory({
|
|
||||||
themeName,
|
|
||||||
"indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
|
|
||||||
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
|
||||||
buildOptions,
|
|
||||||
keycloakifyVersion,
|
|
||||||
themeType,
|
|
||||||
"fieldNames": readFieldNameUsage({
|
|
||||||
keycloakifySrcDirPath,
|
|
||||||
themeSrcDirPath,
|
|
||||||
themeType
|
|
||||||
})
|
|
||||||
}).generateFtlFilesCode;
|
|
||||||
|
|
||||||
[
|
|
||||||
...(() => {
|
|
||||||
switch (themeType) {
|
|
||||||
case "login":
|
|
||||||
return loginThemePageIds;
|
|
||||||
case "account":
|
|
||||||
return accountThemePageIds;
|
|
||||||
}
|
|
||||||
})(),
|
|
||||||
...readExtraPagesNames({
|
|
||||||
themeType,
|
|
||||||
themeSrcDirPath
|
|
||||||
})
|
|
||||||
].forEach(pageId => {
|
|
||||||
const { ftlCode } = generateFtlFilesCode({ pageId });
|
|
||||||
|
|
||||||
fs.mkdirSync(themeTypeDirPath, { "recursive": true });
|
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
|
||||||
});
|
|
||||||
|
|
||||||
generateMessageProperties({
|
|
||||||
themeSrcDirPath,
|
|
||||||
themeType
|
|
||||||
}).forEach(({ languageTag, propertiesFileSource }) => {
|
|
||||||
const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
|
|
||||||
|
|
||||||
fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
|
|
||||||
|
|
||||||
const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
|
|
||||||
|
|
||||||
fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
|
|
||||||
});
|
|
||||||
|
|
||||||
await downloadKeycloakStaticResources({
|
|
||||||
"keycloakVersion": (() => {
|
|
||||||
switch (themeType) {
|
|
||||||
case "account":
|
|
||||||
return lastKeycloakVersionWithAccountV1;
|
|
||||||
case "login":
|
|
||||||
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
|
||||||
}
|
|
||||||
})(),
|
|
||||||
"themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
|
|
||||||
themeType,
|
|
||||||
"usedResources": readStaticResourcesUsage({
|
|
||||||
keycloakifySrcDirPath,
|
|
||||||
themeSrcDirPath,
|
|
||||||
themeType
|
|
||||||
}),
|
|
||||||
buildOptions
|
|
||||||
});
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(themeTypeDirPath, "theme.properties"),
|
|
||||||
Buffer.from(
|
|
||||||
[
|
|
||||||
`parent=${(() => {
|
|
||||||
switch (themeType) {
|
|
||||||
case "account":
|
|
||||||
return accountV1;
|
|
||||||
case "login":
|
|
||||||
return "keycloak";
|
|
||||||
}
|
|
||||||
assert<Equals<typeof themeType, never>>(false);
|
|
||||||
})()}`,
|
|
||||||
...(buildOptions.extraThemeProperties ?? [])
|
|
||||||
].join("\n\n"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
if (themeType === "account" && buildOptions.doBuildRetrocompatAccountTheme) {
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": themeTypeDirPath,
|
|
||||||
"destDirPath": getThemeTypeDirPath({ themeType, "isRetrocompat": true }),
|
|
||||||
"transformSourceCode": ({ filePath, sourceCode }) => {
|
|
||||||
if (pathBasename(filePath) === "theme.properties") {
|
|
||||||
return {
|
|
||||||
"modifiedSourceCode": Buffer.from(sourceCode.toString("utf8").replace(`parent=${accountV1}`, "parent=keycloak"), "utf8")
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
email: {
|
|
||||||
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
|
||||||
|
|
||||||
if (!fs.existsSync(emailThemeSrcDirPath)) {
|
|
||||||
break email;
|
|
||||||
}
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": emailThemeSrcDirPath,
|
|
||||||
"destDirPath": getThemeTypeDirPath({ "themeType": "email" })
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
return { doesImplementAccountTheme };
|
||||||
}
|
}
|
||||||
|
50
src/bin/keycloakify/generateTheme/generateThemeVariants.ts
Normal file
50
src/bin/keycloakify/generateTheme/generateThemeVariants.ts
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
import { join as pathJoin, extname as pathExtname, sep as pathSep } from "path";
|
||||||
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import * as fs from "fs";
|
||||||
|
|
||||||
|
export function generateThemeVariations(params: { themeName: string; themeVariantName: string; srcMainResourcesDirPath: string }) {
|
||||||
|
const { themeName, themeVariantName, srcMainResourcesDirPath } = params;
|
||||||
|
|
||||||
|
const mainThemeDirPath = pathJoin(srcMainResourcesDirPath, "theme", themeName);
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": mainThemeDirPath,
|
||||||
|
"destDirPath": pathJoin(mainThemeDirPath, themeVariantName),
|
||||||
|
"transformSourceCode": ({ fileRelativePath, sourceCode }) => {
|
||||||
|
if (pathExtname(fileRelativePath) === ".ftl" && fileRelativePath.split(pathSep).length === 2) {
|
||||||
|
const modifiedSourceCode = Buffer.from(
|
||||||
|
Buffer.from(sourceCode)
|
||||||
|
.toString("utf-8")
|
||||||
|
.replace(`out["themeName"] = "${themeName}";`, `out["themeName"] = "${themeVariantName}";`),
|
||||||
|
"utf8"
|
||||||
|
);
|
||||||
|
|
||||||
|
assert(Buffer.compare(modifiedSourceCode, sourceCode) !== 0);
|
||||||
|
|
||||||
|
return { modifiedSourceCode };
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
{
|
||||||
|
const keycloakThemeJsonFilePath = pathJoin(srcMainResourcesDirPath, "META-INF", "keycloak-themes.json");
|
||||||
|
|
||||||
|
const modifiedParsedJson = JSON.parse(fs.readFileSync(keycloakThemeJsonFilePath).toString("utf8")) as {
|
||||||
|
themes: { name: string; types: string[] }[];
|
||||||
|
};
|
||||||
|
|
||||||
|
modifiedParsedJson.themes.push({
|
||||||
|
"name": themeVariantName,
|
||||||
|
"types": (() => {
|
||||||
|
const theme = modifiedParsedJson.themes.find(({ name }) => name === themeName);
|
||||||
|
assert(theme !== undefined);
|
||||||
|
return theme.types;
|
||||||
|
})()
|
||||||
|
});
|
||||||
|
|
||||||
|
fs.writeFileSync(keycloakThemeJsonFilePath, Buffer.from(JSON.stringify(modifiedParsedJson, null, 2), "utf8"));
|
||||||
|
}
|
||||||
|
}
|
@ -1,5 +1,4 @@
|
|||||||
import { crawl } from "../../tools/crawl";
|
import { crawl } from "../../tools/crawl";
|
||||||
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import type { ThemeType } from "../../constants";
|
import type { ThemeType } from "../../constants";
|
||||||
@ -8,7 +7,7 @@ import type { ThemeType } from "../../constants";
|
|||||||
export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
||||||
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
const fieldNames: string[] = [];
|
const fieldNames = new Set<string>();
|
||||||
|
|
||||||
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
||||||
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
||||||
@ -20,13 +19,39 @@ export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; them
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
fieldNames.push(
|
for (const functionName of ["printIfExists", "existsError", "get", "exists", "getFirstError"] as const) {
|
||||||
...Array.from(rawSourceFile.matchAll(/(?:(?:printIfExists)|(?:existsError)|(?:get)|(?:exists))\(\s*["']([^"']+)["']/g), m => m[1])
|
if (!rawSourceFile.includes(functionName)) {
|
||||||
);
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
rawSourceFile
|
||||||
|
.split(functionName)
|
||||||
|
.filter(part => part.startsWith("("))
|
||||||
|
.map(part => {
|
||||||
|
let [p1] = part.split(")");
|
||||||
|
|
||||||
|
p1 = p1.slice(1);
|
||||||
|
|
||||||
|
return p1;
|
||||||
|
})
|
||||||
|
.map(part => {
|
||||||
|
console.log(part);
|
||||||
|
|
||||||
|
return part
|
||||||
|
.split(",")
|
||||||
|
.map(a => a.trim())
|
||||||
|
.filter((...[, i]) => (functionName !== "printIfExists" ? true : i === 0))
|
||||||
|
.filter(a => a.startsWith('"') || a.startsWith("'") || a.startsWith("`"))
|
||||||
|
.filter(a => a.endsWith('"') || a.endsWith("'") || a.endsWith("`"))
|
||||||
|
.map(a => a.slice(1).slice(0, -1));
|
||||||
|
})
|
||||||
|
.flat()
|
||||||
|
.forEach(fieldName => fieldNames.add(fieldName));
|
||||||
|
} catch {}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const out = fieldNames.reduce(...removeDuplicates<string>());
|
return Array.from(fieldNames);
|
||||||
|
|
||||||
return out;
|
|
||||||
}
|
}
|
||||||
|
@ -1,76 +0,0 @@
|
|||||||
import { crawl } from "../../tools/crawl";
|
|
||||||
import { join as pathJoin, sep as pathSep } from "path";
|
|
||||||
import * as fs from "fs";
|
|
||||||
import type { ThemeType } from "../../constants";
|
|
||||||
|
|
||||||
/** Assumes the theme type exists */
|
|
||||||
export function readStaticResourcesUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): {
|
|
||||||
resourcesCommonFilePaths: string[];
|
|
||||||
} {
|
|
||||||
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
|
||||||
|
|
||||||
const resourcesCommonFilePaths = new Set<string>();
|
|
||||||
|
|
||||||
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
|
||||||
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
|
||||||
|
|
||||||
for (const filePath of filePaths) {
|
|
||||||
const rawSourceFile = fs.readFileSync(filePath).toString("utf8");
|
|
||||||
|
|
||||||
if (!rawSourceFile.includes("resourcesCommonPath") && !rawSourceFile.includes("resourcesPath")) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const wrap = readPaths({ rawSourceFile });
|
|
||||||
|
|
||||||
wrap.resourcesCommonFilePaths.forEach(filePath => resourcesCommonFilePaths.add(filePath));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Exported for testing purpose */
|
|
||||||
export function readPaths(params: { rawSourceFile: string }): {
|
|
||||||
resourcesCommonFilePaths: string[];
|
|
||||||
} {
|
|
||||||
const { rawSourceFile } = params;
|
|
||||||
|
|
||||||
const resourcesCommonFilePaths = new Set<string>();
|
|
||||||
|
|
||||||
{
|
|
||||||
const regexp = new RegExp(`resourcesCommonPath\\s*}([^\`]+)\``, "g");
|
|
||||||
|
|
||||||
const matches = [...rawSourceFile.matchAll(regexp)];
|
|
||||||
|
|
||||||
for (const match of matches) {
|
|
||||||
const filePath = match[1];
|
|
||||||
|
|
||||||
resourcesCommonFilePaths.add(filePath);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const regexp = new RegExp(`resourcesCommonPath\\s*[+,]\\s*["']([^"'\`]+)["'\`]`, "g");
|
|
||||||
|
|
||||||
const matches = [...rawSourceFile.matchAll(regexp)];
|
|
||||||
|
|
||||||
for (const match of matches) {
|
|
||||||
const filePath = match[1];
|
|
||||||
|
|
||||||
resourcesCommonFilePaths.add(filePath);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const normalizePath = (filePath: string) => {
|
|
||||||
filePath = filePath.startsWith("/") ? filePath.slice(1) : filePath;
|
|
||||||
filePath = filePath.replace(/\//g, pathSep);
|
|
||||||
return filePath;
|
|
||||||
};
|
|
||||||
|
|
||||||
return {
|
|
||||||
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths).map(normalizePath)
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,128 +1,78 @@
|
|||||||
import { generateTheme } from "./generateTheme";
|
import { generateTheme } from "./generateTheme";
|
||||||
import { generateJavaStackFiles } from "./generateJavaStackFiles";
|
import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
|
||||||
import { join as pathJoin, relative as pathRelative, basename as pathBasename, dirname as pathDirname, sep as pathSep } from "path";
|
|
||||||
import * as child_process from "child_process";
|
import * as child_process from "child_process";
|
||||||
import { generateStartKeycloakTestingContainer } from "./generateStartKeycloakTestingContainer";
|
import { generateStartKeycloakTestingContainer } from "./generateStartKeycloakTestingContainer";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { readBuildOptions } from "./BuildOptions";
|
import { readBuildOptions } from "./buildOptions";
|
||||||
import { getLogger } from "../tools/logger";
|
import { getLogger } from "../tools/logger";
|
||||||
import { assert } from "tsafe/assert";
|
import { getThemeSrcDirPath } from "../getThemeSrcDirPath";
|
||||||
import { getThemeSrcDirPath } from "../getSrcDirPath";
|
import { getThisCodebaseRootDirPath } from "../tools/getThisCodebaseRootDirPath";
|
||||||
import { getProjectRoot } from "../tools/getProjectRoot";
|
import { readThisNpmProjectVersion } from "../tools/readThisNpmProjectVersion";
|
||||||
import { objectKeys } from "tsafe/objectKeys";
|
import { keycloakifyBuildOptionsForPostPostBuildScriptEnvName } from "../constants";
|
||||||
|
import { buildJars } from "./buildJars";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const reactAppRootDirPath = process.cwd();
|
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
reactAppRootDirPath,
|
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
logger.log("🔏 Building the keycloak theme...⌚");
|
logger.log("🔏 Building the keycloak theme...⌚");
|
||||||
|
|
||||||
const keycloakifyDirPath = getProjectRoot();
|
const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
{
|
||||||
|
if (!fs.existsSync(buildOptions.keycloakifyBuildDirPath)) {
|
||||||
|
fs.mkdirSync(buildOptions.keycloakifyBuildDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
|
|
||||||
for (const themeName of buildOptions.themeNames) {
|
fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
await generateTheme({
|
|
||||||
themeName,
|
|
||||||
themeSrcDirPath,
|
|
||||||
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
|
||||||
buildOptions,
|
|
||||||
"keycloakifyVersion": (() => {
|
|
||||||
const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
|
|
||||||
|
|
||||||
assert(typeof version === "string");
|
|
||||||
|
|
||||||
return version;
|
|
||||||
})()
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const { jarFilePath } = await generateJavaStackFiles({
|
const { doesImplementAccountTheme } = await generateTheme({
|
||||||
"implementedThemeTypes": (() => {
|
themeSrcDirPath,
|
||||||
const implementedThemeTypes = {
|
"keycloakifySrcDirPath": pathJoin(getThisCodebaseRootDirPath(), "src"),
|
||||||
"login": false,
|
"keycloakifyVersion": readThisNpmProjectVersion(),
|
||||||
"account": false,
|
|
||||||
"email": false
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const themeType of objectKeys(implementedThemeTypes)) {
|
|
||||||
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
implementedThemeTypes[themeType] = true;
|
|
||||||
}
|
|
||||||
|
|
||||||
return implementedThemeTypes;
|
|
||||||
})(),
|
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
if (buildOptions.doCreateJar) {
|
run_post_build_script: {
|
||||||
child_process.execSync("mvn clean install", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
if (buildOptions.bundler !== "vite") {
|
||||||
|
break run_post_build_script;
|
||||||
|
}
|
||||||
|
|
||||||
fs.unlinkSync(pathJoin(pathDirname(jarFilePath), "original-" + pathBasename(jarFilePath)));
|
child_process.execSync("npx vite", {
|
||||||
|
"cwd": buildOptions.reactAppRootDirPath,
|
||||||
|
"env": {
|
||||||
|
...process.env,
|
||||||
|
[keycloakifyBuildOptionsForPostPostBuildScriptEnvName]: JSON.stringify(buildOptions)
|
||||||
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const containerKeycloakVersion = "23.0.0";
|
const { lastJarFileBasename } = await buildJars({
|
||||||
|
doesImplementAccountTheme,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer({
|
generateStartKeycloakTestingContainer({
|
||||||
"keycloakVersion": containerKeycloakVersion,
|
"jarFilePath": pathJoin(buildOptions.keycloakifyBuildDirPath, lastJarFileBasename),
|
||||||
jarFilePath,
|
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
logger.log(
|
logger.log(
|
||||||
[
|
[
|
||||||
|
`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathJoin(
|
||||||
|
pathRelative(buildOptions.reactAppRootDirPath, buildOptions.keycloakifyBuildDirPath),
|
||||||
|
"keycloak-theme-for-kc-*.jar"
|
||||||
|
)}`,
|
||||||
"",
|
"",
|
||||||
...(!buildOptions.doCreateJar
|
`To test your theme locally you can spin up a Keycloak container image with the theme pre loaded by running:`,
|
||||||
? []
|
|
||||||
: [
|
|
||||||
`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(reactAppRootDirPath, jarFilePath)} 🚀`,
|
|
||||||
`It is to be placed in "/opt/keycloak/providers" in the container running a quay.io/keycloak/keycloak Docker image.`,
|
|
||||||
""
|
|
||||||
]),
|
|
||||||
//TODO: Restore when we find a good Helm chart for Keycloak.
|
|
||||||
//"Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:",
|
|
||||||
"",
|
|
||||||
"value.yaml: ",
|
|
||||||
" extraInitContainers: |",
|
|
||||||
" - name: realm-ext-provider",
|
|
||||||
" image: curlimages/curl",
|
|
||||||
" imagePullPolicy: IfNotPresent",
|
|
||||||
" command:",
|
|
||||||
" - sh",
|
|
||||||
" args:",
|
|
||||||
" - -c",
|
|
||||||
` - curl -L -f -S -o /extensions/${pathBasename(jarFilePath)} https://AN.URL.FOR/${pathBasename(jarFilePath)}`,
|
|
||||||
" volumeMounts:",
|
|
||||||
" - name: extensions",
|
|
||||||
" mountPath: /extensions",
|
|
||||||
" ",
|
|
||||||
" extraVolumeMounts: |",
|
|
||||||
" - name: extensions",
|
|
||||||
" mountPath: /opt/keycloak/providers",
|
|
||||||
" extraEnv: |",
|
|
||||||
" - name: KEYCLOAK_USER",
|
|
||||||
" value: admin",
|
|
||||||
" - name: KEYCLOAK_PASSWORD",
|
|
||||||
" value: xxxxxxxxx",
|
|
||||||
" - name: JAVA_OPTS",
|
|
||||||
" value: -Dkeycloak.profile=preview",
|
|
||||||
"",
|
|
||||||
"",
|
|
||||||
`To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
|
|
||||||
"",
|
"",
|
||||||
`👉 $ .${pathSep}${pathRelative(
|
`👉 $ .${pathSep}${pathRelative(
|
||||||
reactAppRootDirPath,
|
buildOptions.reactAppRootDirPath,
|
||||||
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
||||||
)} 👈`,
|
)} 👈`,
|
||||||
"",
|
|
||||||
`Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags`,
|
|
||||||
``,
|
``,
|
||||||
`Once your container is up and running: `,
|
`Once your container is up and running: `,
|
||||||
"- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
|
"- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
|
||||||
|
@ -1,55 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { assert } from "tsafe";
|
|
||||||
import type { Equals } from "tsafe";
|
|
||||||
import { z } from "zod";
|
|
||||||
import { pathJoin } from "../tools/pathJoin";
|
|
||||||
|
|
||||||
export type ParsedPackageJson = {
|
|
||||||
name: string;
|
|
||||||
version?: string;
|
|
||||||
homepage?: string;
|
|
||||||
keycloakify?: {
|
|
||||||
extraThemeProperties?: string[];
|
|
||||||
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
|
||||||
artifactId?: string;
|
|
||||||
groupId?: string;
|
|
||||||
doCreateJar?: boolean;
|
|
||||||
loginThemeResourcesFromKeycloakVersion?: string;
|
|
||||||
reactAppBuildDirPath?: string;
|
|
||||||
keycloakifyBuildDirPath?: string;
|
|
||||||
themeName?: string | string[];
|
|
||||||
doBuildRetrocompatAccountTheme?: boolean;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
export const zParsedPackageJson = z.object({
|
|
||||||
"name": z.string(),
|
|
||||||
"version": z.string().optional(),
|
|
||||||
"homepage": z.string().optional(),
|
|
||||||
"keycloakify": z
|
|
||||||
.object({
|
|
||||||
"extraThemeProperties": z.array(z.string()).optional(),
|
|
||||||
"areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
|
|
||||||
"artifactId": z.string().optional(),
|
|
||||||
"groupId": z.string().optional(),
|
|
||||||
"doCreateJar": z.boolean().optional(),
|
|
||||||
"loginThemeResourcesFromKeycloakVersion": z.string().optional(),
|
|
||||||
"reactAppBuildDirPath": z.string().optional(),
|
|
||||||
"keycloakifyBuildDirPath": z.string().optional(),
|
|
||||||
"themeName": z.union([z.string(), z.array(z.string())]).optional(),
|
|
||||||
"doBuildRetrocompatAccountTheme": z.boolean().optional()
|
|
||||||
})
|
|
||||||
.optional()
|
|
||||||
});
|
|
||||||
|
|
||||||
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
|
||||||
|
|
||||||
let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
|
|
||||||
export function getParsedPackageJson(params: { reactAppRootDirPath: string }) {
|
|
||||||
const { reactAppRootDirPath } = params;
|
|
||||||
if (parsedPackageJson) {
|
|
||||||
return parsedPackageJson;
|
|
||||||
}
|
|
||||||
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
|
|
||||||
return parsedPackageJson;
|
|
||||||
}
|
|
@ -1,51 +0,0 @@
|
|||||||
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
|
||||||
|
|
||||||
export function replaceImportsFromStaticInJsCode(params: { jsCode: string }): { fixedJsCode: string } {
|
|
||||||
/*
|
|
||||||
NOTE:
|
|
||||||
|
|
||||||
When we have urlOrigin defined it means that
|
|
||||||
we are building with --external-assets
|
|
||||||
so we have to make sur that the fixed js code will run
|
|
||||||
inside and outside keycloak.
|
|
||||||
|
|
||||||
When urlOrigin isn't defined we can assume the fixedJsCode
|
|
||||||
will always run in keycloak context.
|
|
||||||
*/
|
|
||||||
|
|
||||||
const { jsCode } = params;
|
|
||||||
|
|
||||||
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
|
||||||
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=(function\\(([a-z]+)\\){return|([a-z]+)=>)"static\\/${language}\\/"`, "g"),
|
|
||||||
(...[, n, u, matchedFunction, eForFunction]) => {
|
|
||||||
const isArrowFunction = matchedFunction.includes("=>");
|
|
||||||
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
|
||||||
|
|
||||||
return `
|
|
||||||
${n}[(function(){
|
|
||||||
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
|
||||||
Object.defineProperty(${n}, "p", {
|
|
||||||
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
|
||||||
set: function() {}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return "${u}";
|
|
||||||
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/build/static/${language}/"`
|
|
||||||
.replace(/\s+/g, " ")
|
|
||||||
.trim();
|
|
||||||
}
|
|
||||||
];
|
|
||||||
|
|
||||||
const fixedJsCode = jsCode
|
|
||||||
.replace(...getReplaceArgs("js"))
|
|
||||||
.replace(...getReplaceArgs("css"))
|
|
||||||
.replace(/[a-zA-Z]+\.[a-zA-Z]+\+"static\//g, `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`)
|
|
||||||
//TODO: Write a test case for this
|
|
||||||
.replace(
|
|
||||||
/".chunk.css",([a-zA-Z])+=[a-zA-Z]+\.[a-zA-Z]+\+([a-zA-Z]+),/,
|
|
||||||
(...[, group1, group2]) => `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group2},`
|
|
||||||
);
|
|
||||||
|
|
||||||
return { fixedJsCode };
|
|
||||||
}
|
|
@ -1,6 +1,7 @@
|
|||||||
import * as crypto from "crypto";
|
import * as crypto from "crypto";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../buildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
|
import { basenameOfTheKeycloakifyResourcesDir } from "../../constants";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
@ -16,7 +17,7 @@ export function replaceImportsInCssCode(params: { cssCode: string }): {
|
|||||||
|
|
||||||
const cssGlobalsToDefine: Record<string, string> = {};
|
const cssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
new Set(cssCode.match(/url\(["']?\/[^/][^)"']+["']?\)[^;}]*/g) ?? []).forEach(
|
new Set(cssCode.match(/url\(["']?\/[^/][^)"']+["']?\)[^;}]*?/g) ?? []).forEach(
|
||||||
match => (cssGlobalsToDefine["url" + crypto.createHash("sha256").update(match).digest("hex").substring(0, 15)] = match)
|
match => (cssGlobalsToDefine["url" + crypto.createHash("sha256").update(match).digest("hex").substring(0, 15)] = match)
|
||||||
);
|
);
|
||||||
|
|
||||||
@ -45,7 +46,7 @@ export function generateCssCodeToDefineGlobals(params: { cssGlobalsToDefine: Rec
|
|||||||
`--${cssVariableName}:`,
|
`--${cssVariableName}:`,
|
||||||
cssGlobalsToDefine[cssVariableName].replace(
|
cssGlobalsToDefine[cssVariableName].replace(
|
||||||
new RegExp(`url\\(${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`, "g"),
|
new RegExp(`url\\(${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`, "g"),
|
||||||
"url(${url.resourcesPath}/build/"
|
`url(\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/`
|
||||||
)
|
)
|
||||||
].join(" ")
|
].join(" ")
|
||||||
)
|
)
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../buildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
|
import { basenameOfTheKeycloakifyResourcesDir } from "../../constants";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
@ -16,7 +17,7 @@ export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOp
|
|||||||
buildOptions.urlPathname === undefined
|
buildOptions.urlPathname === undefined
|
||||||
? /url\(["']?\/([^/][^)"']+)["']?\)/g
|
? /url\(["']?\/([^/][^)"']+)["']?\)/g
|
||||||
: new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
|
: new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
|
||||||
(...[, group]) => `url(\${url.resourcesPath}/build/${group})`
|
(...[, group]) => `url(\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/${group})`
|
||||||
);
|
);
|
||||||
|
|
||||||
return { fixedCssCode };
|
return { fixedCssCode };
|
||||||
|
@ -0,0 +1 @@
|
|||||||
|
export * from "./replaceImportsInJsCode";
|
@ -0,0 +1,66 @@
|
|||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "../../buildOptions";
|
||||||
|
import { replaceImportsInJsCode_vite } from "./vite";
|
||||||
|
import { replaceImportsInJsCode_webpack } from "./webpack";
|
||||||
|
import * as fs from "fs";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
assetsDirPath: string;
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
bundler: "vite" | "webpack";
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export function replaceImportsInJsCode(params: { jsCode: string; buildOptions: BuildOptionsLike }) {
|
||||||
|
const { jsCode, buildOptions } = params;
|
||||||
|
|
||||||
|
const { fixedJsCode } = (() => {
|
||||||
|
switch (buildOptions.bundler) {
|
||||||
|
case "vite":
|
||||||
|
return replaceImportsInJsCode_vite({
|
||||||
|
jsCode,
|
||||||
|
buildOptions,
|
||||||
|
"basenameOfAssetsFiles": readAssetsDirSync({
|
||||||
|
"assetsDirPath": params.buildOptions.assetsDirPath
|
||||||
|
})
|
||||||
|
});
|
||||||
|
case "webpack":
|
||||||
|
return replaceImportsInJsCode_webpack({
|
||||||
|
jsCode,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
return { fixedJsCode };
|
||||||
|
}
|
||||||
|
|
||||||
|
const { readAssetsDirSync } = (() => {
|
||||||
|
let cache:
|
||||||
|
| {
|
||||||
|
assetsDirPath: string;
|
||||||
|
basenameOfAssetsFiles: string[];
|
||||||
|
}
|
||||||
|
| undefined = undefined;
|
||||||
|
|
||||||
|
function readAssetsDirSync(params: { assetsDirPath: string }): string[] {
|
||||||
|
const { assetsDirPath } = params;
|
||||||
|
|
||||||
|
if (cache !== undefined && cache.assetsDirPath === assetsDirPath) {
|
||||||
|
return cache.basenameOfAssetsFiles;
|
||||||
|
}
|
||||||
|
|
||||||
|
const basenameOfAssetsFiles = fs.readdirSync(assetsDirPath);
|
||||||
|
|
||||||
|
cache = {
|
||||||
|
assetsDirPath,
|
||||||
|
basenameOfAssetsFiles
|
||||||
|
};
|
||||||
|
|
||||||
|
return basenameOfAssetsFiles;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { readAssetsDirSync };
|
||||||
|
})();
|
85
src/bin/keycloakify/replacers/replaceImportsInJsCode/vite.ts
Normal file
85
src/bin/keycloakify/replacers/replaceImportsInJsCode/vite.ts
Normal file
@ -0,0 +1,85 @@
|
|||||||
|
import { nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "../../../constants";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "../../buildOptions";
|
||||||
|
import * as nodePath from "path";
|
||||||
|
import { replaceAll } from "../../../tools/String.prototype.replaceAll";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
assetsDirPath: string;
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export function replaceImportsInJsCode_vite(params: {
|
||||||
|
jsCode: string;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
basenameOfAssetsFiles: string[];
|
||||||
|
systemType?: "posix" | "win32";
|
||||||
|
}): {
|
||||||
|
fixedJsCode: string;
|
||||||
|
} {
|
||||||
|
const { jsCode, buildOptions, basenameOfAssetsFiles, systemType = nodePath.sep === "/" ? "posix" : "win32" } = params;
|
||||||
|
|
||||||
|
const { relative: pathRelative, sep: pathSep } = nodePath[systemType];
|
||||||
|
|
||||||
|
let fixedJsCode = jsCode;
|
||||||
|
|
||||||
|
replace_base_javacript_import: {
|
||||||
|
if (buildOptions.urlPathname === undefined) {
|
||||||
|
break replace_base_javacript_import;
|
||||||
|
}
|
||||||
|
// Optimization
|
||||||
|
if (!jsCode.includes(buildOptions.urlPathname)) {
|
||||||
|
break replace_base_javacript_import;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace `Hv=function(e){return"/abcde12345/"+e}` by `Hv=function(e){return"/"+e}`
|
||||||
|
fixedJsCode = fixedJsCode.replace(
|
||||||
|
new RegExp(
|
||||||
|
`([\\w\\$][\\w\\d\\$]*)=function\\(([\\w\\$][\\w\\d\\$]*)\\)\\{return"${replaceAll(buildOptions.urlPathname, "/", "\\/")}"\\+\\2\\}`,
|
||||||
|
"g"
|
||||||
|
),
|
||||||
|
(...[, funcName, paramName]) => `${funcName}=function(${paramName}){return"/"+${paramName}}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
replace_javascript_relatives_import_paths: {
|
||||||
|
// Example: "assets/ or "foo/bar/"
|
||||||
|
const staticDir = (() => {
|
||||||
|
let out = pathRelative(buildOptions.reactAppBuildDirPath, buildOptions.assetsDirPath);
|
||||||
|
|
||||||
|
out = replaceAll(out, pathSep, "/") + "/";
|
||||||
|
|
||||||
|
if (out === "/") {
|
||||||
|
throw new Error(`The assetsDirPath must be a subdirectory of reactAppBuildDirPath`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
})();
|
||||||
|
|
||||||
|
// Optimization
|
||||||
|
if (!jsCode.includes(staticDir)) {
|
||||||
|
break replace_javascript_relatives_import_paths;
|
||||||
|
}
|
||||||
|
|
||||||
|
basenameOfAssetsFiles
|
||||||
|
.map(basenameOfAssetsFile => `${staticDir}${basenameOfAssetsFile}`)
|
||||||
|
.forEach(relativePathOfAssetFile => {
|
||||||
|
fixedJsCode = replaceAll(
|
||||||
|
fixedJsCode,
|
||||||
|
`"${relativePathOfAssetFile}"`,
|
||||||
|
`(window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
|
||||||
|
);
|
||||||
|
|
||||||
|
fixedJsCode = replaceAll(
|
||||||
|
fixedJsCode,
|
||||||
|
`"${buildOptions.urlPathname ?? "/"}${relativePathOfAssetFile}"`,
|
||||||
|
`(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return { fixedJsCode };
|
||||||
|
}
|
@ -0,0 +1,76 @@
|
|||||||
|
import { nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "../../../constants";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "../../buildOptions";
|
||||||
|
import * as nodePath from "path";
|
||||||
|
import { replaceAll } from "../../../tools/String.prototype.replaceAll";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
assetsDirPath: string;
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
|
export function replaceImportsInJsCode_webpack(params: { jsCode: string; buildOptions: BuildOptionsLike; systemType?: "posix" | "win32" }): {
|
||||||
|
fixedJsCode: string;
|
||||||
|
} {
|
||||||
|
const { jsCode, buildOptions, systemType = nodePath.sep === "/" ? "posix" : "win32" } = params;
|
||||||
|
|
||||||
|
const { relative: pathRelative, sep: pathSep } = nodePath[systemType];
|
||||||
|
|
||||||
|
let fixedJsCode = jsCode;
|
||||||
|
|
||||||
|
if (buildOptions.urlPathname !== undefined) {
|
||||||
|
// "__esModule",{value:!0})},n.p="/foo-bar/",function(){if("undefined" -> ... n.p="/" ...
|
||||||
|
fixedJsCode = fixedJsCode.replace(
|
||||||
|
new RegExp(`,([a-zA-Z]\\.[a-zA-Z])="${replaceAll(buildOptions.urlPathname, "/", "\\/")}",`, "g"),
|
||||||
|
(...[, assignTo]) => `,${assignTo}="/",`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Example: "static/ or "foo/bar/"
|
||||||
|
const staticDir = (() => {
|
||||||
|
let out = pathRelative(buildOptions.reactAppBuildDirPath, buildOptions.assetsDirPath);
|
||||||
|
|
||||||
|
out = replaceAll(out, pathSep, "/") + "/";
|
||||||
|
|
||||||
|
if (out === "/") {
|
||||||
|
throw new Error(`The assetsDirPath must be a subdirectory of reactAppBuildDirPath`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
})();
|
||||||
|
|
||||||
|
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
||||||
|
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=(function\\(([a-z]+)\\){return|([a-z]+)=>)"${staticDir.replace(/\//g, "\\/")}${language}\\/"`, "g"),
|
||||||
|
(...[, n, u, matchedFunction, eForFunction]) => {
|
||||||
|
const isArrowFunction = matchedFunction.includes("=>");
|
||||||
|
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
||||||
|
|
||||||
|
return `
|
||||||
|
${n}[(function(){
|
||||||
|
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
||||||
|
if( pd === undefined || pd.configurable ){
|
||||||
|
Object.defineProperty(${n}, "p", {
|
||||||
|
get: function() { return window.${nameOfTheGlobal}.url.resourcesPath; },
|
||||||
|
set: function() {}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return "${u}";
|
||||||
|
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/${basenameOfTheKeycloakifyResourcesDir}/${staticDir}${language}/"`
|
||||||
|
.replace(/\s+/g, " ")
|
||||||
|
.trim();
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
fixedJsCode = fixedJsCode
|
||||||
|
.replace(...getReplaceArgs("js"))
|
||||||
|
.replace(...getReplaceArgs("css"))
|
||||||
|
.replace(
|
||||||
|
new RegExp(`[a-zA-Z]+\\.[a-zA-Z]+\\+"${staticDir.replace(/\//g, "\\/")}`, "g"),
|
||||||
|
`window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${staticDir}`
|
||||||
|
);
|
||||||
|
|
||||||
|
return { fixedJsCode };
|
||||||
|
}
|
@ -1,6 +1,7 @@
|
|||||||
import { getLatestsSemVersionedTagFactory } from "./tools/octokit-addons/getLatestsSemVersionedTag";
|
import { getLatestsSemVersionedTagFactory } from "./tools/octokit-addons/getLatestsSemVersionedTag";
|
||||||
import { Octokit } from "@octokit/rest";
|
import { Octokit } from "@octokit/rest";
|
||||||
import cliSelect from "cli-select";
|
import cliSelect from "cli-select";
|
||||||
|
import { lastKeycloakVersionWithAccountV1 } from "./constants";
|
||||||
|
|
||||||
export async function promptKeycloakVersion() {
|
export async function promptKeycloakVersion() {
|
||||||
const { getLatestsSemVersionedTag } = (() => {
|
const { getLatestsSemVersionedTag } = (() => {
|
||||||
@ -21,11 +22,12 @@ export async function promptKeycloakVersion() {
|
|||||||
|
|
||||||
const tags = [
|
const tags = [
|
||||||
...(await getLatestsSemVersionedTag({
|
...(await getLatestsSemVersionedTag({
|
||||||
"count": 10,
|
"count": 15,
|
||||||
"doIgnoreBeta": true,
|
|
||||||
"owner": "keycloak",
|
"owner": "keycloak",
|
||||||
"repo": "keycloak"
|
"repo": "keycloak"
|
||||||
}).then(arr => arr.map(({ tag }) => tag))),
|
}).then(arr => arr.map(({ tag }) => tag))),
|
||||||
|
lastKeycloakVersionWithAccountV1,
|
||||||
|
"19.0.1",
|
||||||
"11.0.3"
|
"11.0.3"
|
||||||
];
|
];
|
||||||
|
|
||||||
|
@ -1,73 +0,0 @@
|
|||||||
export type NpmModuleVersion = {
|
|
||||||
major: number;
|
|
||||||
minor: number;
|
|
||||||
patch: number;
|
|
||||||
betaPreRelease?: number;
|
|
||||||
};
|
|
||||||
|
|
||||||
export namespace NpmModuleVersion {
|
|
||||||
export function parse(versionStr: string): NpmModuleVersion {
|
|
||||||
const match = versionStr.match(/^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-beta.([0-9]+))?/);
|
|
||||||
|
|
||||||
if (!match) {
|
|
||||||
throw new Error(`${versionStr} is not a valid NPM version`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"major": parseInt(match[1]),
|
|
||||||
"minor": parseInt(match[2]),
|
|
||||||
"patch": parseInt(match[3]),
|
|
||||||
...(() => {
|
|
||||||
const str = match[4];
|
|
||||||
return str === undefined ? {} : { "betaPreRelease": parseInt(str) };
|
|
||||||
})()
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export function stringify(v: NpmModuleVersion) {
|
|
||||||
return `${v.major}.${v.minor}.${v.patch}${v.betaPreRelease === undefined ? "" : `-beta.${v.betaPreRelease}`}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
* v1 < v2 => -1
|
|
||||||
* v1 === v2 => 0
|
|
||||||
* v1 > v2 => 1
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
export function compare(v1: NpmModuleVersion, v2: NpmModuleVersion): -1 | 0 | 1 {
|
|
||||||
const sign = (diff: number): -1 | 0 | 1 => (diff === 0 ? 0 : diff < 0 ? -1 : 1);
|
|
||||||
const noUndefined = (n: number | undefined) => n ?? Infinity;
|
|
||||||
|
|
||||||
for (const level of ["major", "minor", "patch", "betaPreRelease"] as const) {
|
|
||||||
if (noUndefined(v1[level]) !== noUndefined(v2[level])) {
|
|
||||||
return sign(noUndefined(v1[level]) - noUndefined(v2[level]));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
console.log(compare(parse("3.0.0-beta.3"), parse("3.0.0")) === -1 )
|
|
||||||
console.log(compare(parse("3.0.0-beta.3"), parse("3.0.0-beta.4")) === -1 )
|
|
||||||
console.log(compare(parse("3.0.0-beta.3"), parse("4.0.0")) === -1 )
|
|
||||||
*/
|
|
||||||
|
|
||||||
export function bumpType(params: { versionBehindStr: string; versionAheadStr: string }): "major" | "minor" | "patch" | "betaPreRelease" | "same" {
|
|
||||||
const versionAhead = parse(params.versionAheadStr);
|
|
||||||
const versionBehind = parse(params.versionBehindStr);
|
|
||||||
|
|
||||||
if (compare(versionBehind, versionAhead) === 1) {
|
|
||||||
throw new Error(`Version regression ${versionBehind} -> ${versionAhead}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const level of ["major", "minor", "patch", "betaPreRelease"] as const) {
|
|
||||||
if (versionBehind[level] !== versionAhead[level]) {
|
|
||||||
return level;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return "same";
|
|
||||||
}
|
|
||||||
}
|
|
12
src/bin/tools/OptionalIfCanBeUndefined.ts
Normal file
12
src/bin/tools/OptionalIfCanBeUndefined.ts
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
type PropertiesThatCanBeUndefined<T extends Record<string, unknown>> = {
|
||||||
|
[Key in keyof T]: undefined extends T[Key] ? Key : never;
|
||||||
|
}[keyof T];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OptionalIfCanBeUndefined<{ p1: string | undefined; p2: string; }>
|
||||||
|
* is
|
||||||
|
* { p1?: string | undefined; p2: string }
|
||||||
|
*/
|
||||||
|
export type OptionalIfCanBeUndefined<T extends Record<string, unknown>> = {
|
||||||
|
[K in PropertiesThatCanBeUndefined<T>]?: T[K];
|
||||||
|
} & { [K in Exclude<keyof T, PropertiesThatCanBeUndefined<T>>]: T[K] };
|
99
src/bin/tools/SemVer.ts
Normal file
99
src/bin/tools/SemVer.ts
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
export type SemVer = {
|
||||||
|
major: number;
|
||||||
|
minor: number;
|
||||||
|
patch: number;
|
||||||
|
rc?: number;
|
||||||
|
parsedFrom: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export namespace SemVer {
|
||||||
|
const bumpTypes = ["major", "minor", "patch", "rc", "no bump"] as const;
|
||||||
|
|
||||||
|
export type BumpType = (typeof bumpTypes)[number];
|
||||||
|
|
||||||
|
export function parse(versionStr: string): SemVer {
|
||||||
|
const match = versionStr.match(/^v?([0-9]+)\.([0-9]+)(?:\.([0-9]+))?(?:-rc.([0-9]+))?$/);
|
||||||
|
|
||||||
|
if (!match) {
|
||||||
|
throw new Error(`${versionStr} is not a valid semantic version`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const semVer: Omit<SemVer, "parsedFrom"> = {
|
||||||
|
"major": parseInt(match[1]),
|
||||||
|
"minor": parseInt(match[2]),
|
||||||
|
"patch": (() => {
|
||||||
|
const str = match[3];
|
||||||
|
|
||||||
|
return str === undefined ? 0 : parseInt(str);
|
||||||
|
})(),
|
||||||
|
...(() => {
|
||||||
|
const str = match[4];
|
||||||
|
return str === undefined ? {} : { "rc": parseInt(str) };
|
||||||
|
})()
|
||||||
|
};
|
||||||
|
|
||||||
|
const initialStr = stringify(semVer);
|
||||||
|
|
||||||
|
Object.defineProperty(semVer, "parsedFrom", {
|
||||||
|
"enumerable": true,
|
||||||
|
"get": function () {
|
||||||
|
const currentStr = stringify(this);
|
||||||
|
|
||||||
|
if (currentStr !== initialStr) {
|
||||||
|
throw new Error(`SemVer.parsedFrom can't be read anymore, the version have been modified from ${initialStr} to ${currentStr}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return versionStr;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return semVer as any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function stringify(v: Omit<SemVer, "parsedFrom">): string {
|
||||||
|
return `${v.major}.${v.minor}.${v.patch}${v.rc === undefined ? "" : `-rc.${v.rc}`}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* v1 < v2 => -1
|
||||||
|
* v1 === v2 => 0
|
||||||
|
* v1 > v2 => 1
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
export function compare(v1: SemVer, v2: SemVer): -1 | 0 | 1 {
|
||||||
|
const sign = (diff: number): -1 | 0 | 1 => (diff === 0 ? 0 : diff < 0 ? -1 : 1);
|
||||||
|
const noUndefined = (n: number | undefined) => n ?? Infinity;
|
||||||
|
|
||||||
|
for (const level of ["major", "minor", "patch", "rc"] as const) {
|
||||||
|
if (noUndefined(v1[level]) !== noUndefined(v2[level])) {
|
||||||
|
return sign(noUndefined(v1[level]) - noUndefined(v2[level]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
console.log(compare(parse("3.0.0-rc.3"), parse("3.0.0")) === -1 )
|
||||||
|
console.log(compare(parse("3.0.0-rc.3"), parse("3.0.0-rc.4")) === -1 )
|
||||||
|
console.log(compare(parse("3.0.0-rc.3"), parse("4.0.0")) === -1 )
|
||||||
|
*/
|
||||||
|
|
||||||
|
export function bumpType(params: { versionBehind: string | SemVer; versionAhead: string | SemVer }): BumpType | "no bump" {
|
||||||
|
const versionAhead = typeof params.versionAhead === "string" ? parse(params.versionAhead) : params.versionAhead;
|
||||||
|
const versionBehind = typeof params.versionBehind === "string" ? parse(params.versionBehind) : params.versionBehind;
|
||||||
|
|
||||||
|
if (compare(versionBehind, versionAhead) === 1) {
|
||||||
|
throw new Error(`Version regression ${stringify(versionBehind)} -> ${stringify(versionAhead)}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const level of ["major", "minor", "patch", "rc"] as const) {
|
||||||
|
if (versionBehind[level] !== versionAhead[level]) {
|
||||||
|
return level;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "no bump";
|
||||||
|
}
|
||||||
|
}
|
30
src/bin/tools/String.prototype.replaceAll.ts
Normal file
30
src/bin/tools/String.prototype.replaceAll.ts
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
export function replaceAll(string: string, searchValue: string | RegExp, replaceValue: string): string {
|
||||||
|
if ((string as any).replaceAll !== undefined) {
|
||||||
|
return (string as any).replaceAll(searchValue, replaceValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the searchValue is a string
|
||||||
|
if (typeof searchValue === "string") {
|
||||||
|
// Escape special characters in the string to be used in a regex
|
||||||
|
var escapedSearchValue = searchValue.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||||
|
var regex = new RegExp(escapedSearchValue, "g");
|
||||||
|
|
||||||
|
return string.replace(regex, replaceValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the searchValue is a global RegExp, use it directly
|
||||||
|
if (searchValue instanceof RegExp && searchValue.global) {
|
||||||
|
return string.replace(searchValue, replaceValue);
|
||||||
|
}
|
||||||
|
|
||||||
|
// If the searchValue is a non-global RegExp, throw an error
|
||||||
|
if (searchValue instanceof RegExp) {
|
||||||
|
throw new TypeError("replaceAll must be called with a global RegExp");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert searchValue to string if it's not a string or RegExp
|
||||||
|
var searchString = String(searchValue);
|
||||||
|
var regexFromString = new RegExp(searchString.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"), "g");
|
||||||
|
|
||||||
|
return string.replace(regexFromString, replaceValue);
|
||||||
|
}
|
@ -1,17 +1,17 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import * as path from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
|
|
||||||
const crawlRec = (dir_path: string, paths: string[]) => {
|
const crawlRec = (dirPath: string, filePaths: string[]) => {
|
||||||
for (const file_name of fs.readdirSync(dir_path)) {
|
for (const basename of fs.readdirSync(dirPath)) {
|
||||||
const file_path = path.join(dir_path, file_name);
|
const fileOrDirPath = pathJoin(dirPath, basename);
|
||||||
|
|
||||||
if (fs.lstatSync(file_path).isDirectory()) {
|
if (fs.lstatSync(fileOrDirPath).isDirectory()) {
|
||||||
crawlRec(file_path, paths);
|
crawlRec(fileOrDirPath, filePaths);
|
||||||
|
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
paths.push(file_path);
|
filePaths.push(fileOrDirPath);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -27,6 +27,6 @@ export function crawl(params: { dirPath: string; returnedPathsType: "absolute" |
|
|||||||
case "absolute":
|
case "absolute":
|
||||||
return filePaths;
|
return filePaths;
|
||||||
case "relative to dirPath":
|
case "relative to dirPath":
|
||||||
return filePaths.map(filePath => path.relative(dirPath, filePath));
|
return filePaths.map(filePath => pathRelative(dirPath, filePath));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,232 +0,0 @@
|
|||||||
import { exec as execCallback } from "child_process";
|
|
||||||
import { createHash } from "crypto";
|
|
||||||
import { mkdir, readFile, stat, writeFile, unlink, rm } from "fs/promises";
|
|
||||||
import fetch, { type FetchOptions } from "make-fetch-happen";
|
|
||||||
import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { promisify } from "util";
|
|
||||||
import { transformCodebase } from "./transformCodebase";
|
|
||||||
import { unzip, zip } from "./unzip";
|
|
||||||
|
|
||||||
const exec = promisify(execCallback);
|
|
||||||
|
|
||||||
function generateFileNameFromURL(params: {
|
|
||||||
url: string;
|
|
||||||
preCacheTransform:
|
|
||||||
| {
|
|
||||||
actionCacheId: string;
|
|
||||||
actionFootprint: string;
|
|
||||||
}
|
|
||||||
| undefined;
|
|
||||||
}): string {
|
|
||||||
const { preCacheTransform } = params;
|
|
||||||
|
|
||||||
// Parse the URL
|
|
||||||
const url = new URL(params.url);
|
|
||||||
|
|
||||||
// Extract pathname and remove leading slashes
|
|
||||||
let fileName = url.pathname.replace(/^\//, "").replace(/\//g, "_");
|
|
||||||
|
|
||||||
// Optionally, add query parameters replacing special characters
|
|
||||||
if (url.search) {
|
|
||||||
fileName += url.search.replace(/[&=?]/g, "-");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Replace any characters that are not valid in filenames
|
|
||||||
fileName = fileName.replace(/[^a-zA-Z0-9-_]/g, "");
|
|
||||||
|
|
||||||
// Trim or pad the fileName to a specific length
|
|
||||||
fileName = fileName.substring(0, 50);
|
|
||||||
|
|
||||||
add_pre_cache_transform: {
|
|
||||||
if (preCacheTransform === undefined) {
|
|
||||||
break add_pre_cache_transform;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sanitize actionCacheId the same way as other components
|
|
||||||
const sanitizedActionCacheId = preCacheTransform.actionCacheId.replace(/[^a-zA-Z0-9-_]/g, "_");
|
|
||||||
|
|
||||||
fileName += `_${sanitizedActionCacheId}_${createHash("sha256").update(preCacheTransform.actionFootprint).digest("hex").substring(0, 5)}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
return fileName;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function exists(path: string) {
|
|
||||||
try {
|
|
||||||
await stat(path);
|
|
||||||
return true;
|
|
||||||
} catch (error) {
|
|
||||||
if ((error as Error & { code: string }).code === "ENOENT") return false;
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function ensureArray<T>(arg0: T | T[]) {
|
|
||||||
return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
|
|
||||||
}
|
|
||||||
|
|
||||||
function ensureSingleOrNone<T>(arg0: T | T[]) {
|
|
||||||
if (!Array.isArray(arg0)) return arg0;
|
|
||||||
if (arg0.length === 0) return undefined;
|
|
||||||
if (arg0.length === 1) return arg0[0];
|
|
||||||
throw new Error("Illegal configuration, expected a single value but found multiple: " + arg0.map(String).join(", "));
|
|
||||||
}
|
|
||||||
|
|
||||||
type NPMConfig = Record<string, string | string[]>;
|
|
||||||
|
|
||||||
const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
|
|
||||||
key in cfg ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] } : { ...cfg, [key]: value };
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get npm configuration as map
|
|
||||||
*/
|
|
||||||
async function getNmpConfig() {
|
|
||||||
return readNpmConfig().then(parseNpmConfig);
|
|
||||||
}
|
|
||||||
|
|
||||||
function readNpmConfig(): Promise<string> {
|
|
||||||
return (async function callee(depth: number): Promise<string> {
|
|
||||||
const cwd = pathResolve(pathJoin(...[process.cwd(), ...Array(depth).fill("..")]));
|
|
||||||
|
|
||||||
let stdout: string;
|
|
||||||
|
|
||||||
try {
|
|
||||||
stdout = await exec("npm config get", { "encoding": "utf8", cwd }).then(({ stdout }) => stdout);
|
|
||||||
} catch (error) {
|
|
||||||
if (String(error).includes("ENOWORKSPACES")) {
|
|
||||||
assert(cwd !== pathSep);
|
|
||||||
|
|
||||||
return callee(depth + 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
return stdout;
|
|
||||||
})(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseNpmConfig(stdout: string) {
|
|
||||||
return stdout
|
|
||||||
.split("\n")
|
|
||||||
.filter(line => !line.startsWith(";"))
|
|
||||||
.map(line => line.trim())
|
|
||||||
.map(line => line.split("=", 2) as [string, string])
|
|
||||||
.reduce(npmConfigReducer, {} as NPMConfig);
|
|
||||||
}
|
|
||||||
|
|
||||||
function maybeBoolean(arg0: string | undefined) {
|
|
||||||
return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
|
|
||||||
}
|
|
||||||
|
|
||||||
function chunks<T>(arr: T[], size: number = 2) {
|
|
||||||
return arr.map((_, i) => i % size == 0 && arr.slice(i, i + size)).filter(Boolean) as T[][];
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readCafile(cafile: string) {
|
|
||||||
const cafileContent = await readFile(cafile, "utf-8");
|
|
||||||
return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n"));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get proxy and ssl configuration from npm config files. Note that we don't care about
|
|
||||||
* proxy config in env vars, because make-fetch-happen will do that for us.
|
|
||||||
*
|
|
||||||
* @returns proxy configuration
|
|
||||||
*/
|
|
||||||
async function getFetchOptions(): Promise<Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "ca" | "cert">> {
|
|
||||||
const cfg = await getNmpConfig();
|
|
||||||
|
|
||||||
const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
|
|
||||||
const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
|
|
||||||
const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
|
|
||||||
const cert = cfg["cert"];
|
|
||||||
const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
|
|
||||||
const cafile = ensureSingleOrNone(cfg["cafile"]);
|
|
||||||
|
|
||||||
if (typeof cafile !== "undefined" && cafile !== "null") ca.push(...(await readCafile(cafile)));
|
|
||||||
|
|
||||||
return { proxy, noProxy, strictSSL, cert, ca: ca.length === 0 ? undefined : ca };
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function downloadAndUnzip(
|
|
||||||
params: {
|
|
||||||
url: string;
|
|
||||||
destDirPath: string;
|
|
||||||
specificDirsToExtract?: string[];
|
|
||||||
preCacheTransform?: {
|
|
||||||
actionCacheId: string;
|
|
||||||
action: (params: { destDirPath: string }) => Promise<void>;
|
|
||||||
};
|
|
||||||
} & (
|
|
||||||
| {
|
|
||||||
doUseCache: true;
|
|
||||||
cacheDirPath: string;
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
doUseCache: false;
|
|
||||||
}
|
|
||||||
)
|
|
||||||
) {
|
|
||||||
const { url, destDirPath, specificDirsToExtract, preCacheTransform, ...rest } = params;
|
|
||||||
|
|
||||||
const zipFileBasename = generateFileNameFromURL({
|
|
||||||
url,
|
|
||||||
"preCacheTransform":
|
|
||||||
preCacheTransform === undefined
|
|
||||||
? undefined
|
|
||||||
: {
|
|
||||||
"actionCacheId": preCacheTransform.actionCacheId,
|
|
||||||
"actionFootprint": preCacheTransform.action.toString()
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const cacheDirPath = !rest.doUseCache ? `tmp_${Math.random().toString().slice(2, 12)}` : rest.cacheDirPath;
|
|
||||||
|
|
||||||
const zipFilePath = pathJoin(cacheDirPath, `${zipFileBasename}.zip`);
|
|
||||||
const extractDirPath = pathJoin(cacheDirPath, `tmp_unzip_${zipFileBasename}`);
|
|
||||||
|
|
||||||
if (!(await exists(zipFilePath))) {
|
|
||||||
const opts = await getFetchOptions();
|
|
||||||
const response = await fetch(url, opts);
|
|
||||||
await mkdir(pathDirname(zipFilePath), { "recursive": true });
|
|
||||||
/**
|
|
||||||
* The correct way to fix this is to upgrade node-fetch beyond 3.2.5
|
|
||||||
* (see https://github.com/node-fetch/node-fetch/issues/1295#issuecomment-1144061991.)
|
|
||||||
* Unfortunately, octokit (a dependency of keycloakify) also uses node-fetch, and
|
|
||||||
* does not support node-fetch 3.x. So we stick around with this band-aid until
|
|
||||||
* octokit upgrades.
|
|
||||||
*/
|
|
||||||
response.body?.setMaxListeners(Number.MAX_VALUE);
|
|
||||||
assert(typeof response.body !== "undefined" && response.body != null);
|
|
||||||
await writeFile(zipFilePath, response.body);
|
|
||||||
|
|
||||||
if (specificDirsToExtract !== undefined || preCacheTransform !== undefined) {
|
|
||||||
await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
|
|
||||||
|
|
||||||
await preCacheTransform?.action({
|
|
||||||
"destDirPath": extractDirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
await unlink(zipFilePath);
|
|
||||||
|
|
||||||
await zip(extractDirPath, zipFilePath);
|
|
||||||
|
|
||||||
await rm(extractDirPath, { "recursive": true });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
await unzip(zipFilePath, extractDirPath);
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": extractDirPath,
|
|
||||||
"destDirPath": destDirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!rest.doUseCache) {
|
|
||||||
await rm(cacheDirPath, { "recursive": true });
|
|
||||||
} else {
|
|
||||||
await rm(extractDirPath, { "recursive": true });
|
|
||||||
}
|
|
||||||
}
|
|
73
src/bin/tools/fetchProxyOptions.ts
Normal file
73
src/bin/tools/fetchProxyOptions.ts
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
import { exec as execCallback } from "child_process";
|
||||||
|
import { readFile } from "fs/promises";
|
||||||
|
import { type FetchOptions } from "make-fetch-happen";
|
||||||
|
import { promisify } from "util";
|
||||||
|
|
||||||
|
function ensureArray<T>(arg0: T | T[]) {
|
||||||
|
return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureSingleOrNone<T>(arg0: T | T[]) {
|
||||||
|
if (!Array.isArray(arg0)) return arg0;
|
||||||
|
if (arg0.length === 0) return undefined;
|
||||||
|
if (arg0.length === 1) return arg0[0];
|
||||||
|
throw new Error("Illegal configuration, expected a single value but found multiple: " + arg0.map(String).join(", "));
|
||||||
|
}
|
||||||
|
|
||||||
|
type NPMConfig = Record<string, string | string[]>;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get npm configuration as map
|
||||||
|
*/
|
||||||
|
async function getNmpConfig(params: { npmWorkspaceRootDirPath: string }) {
|
||||||
|
const { npmWorkspaceRootDirPath } = params;
|
||||||
|
|
||||||
|
const exec = promisify(execCallback);
|
||||||
|
|
||||||
|
const stdout = await exec("npm config get", { "encoding": "utf8", "cwd": npmWorkspaceRootDirPath }).then(({ stdout }) => stdout);
|
||||||
|
|
||||||
|
const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
|
||||||
|
key in cfg ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] } : { ...cfg, [key]: value };
|
||||||
|
|
||||||
|
return stdout
|
||||||
|
.split("\n")
|
||||||
|
.filter(line => !line.startsWith(";"))
|
||||||
|
.map(line => line.trim())
|
||||||
|
.map(line => line.split("=", 2) as [string, string])
|
||||||
|
.reduce(npmConfigReducer, {} as NPMConfig);
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ProxyFetchOptions = Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "cert" | "ca">;
|
||||||
|
|
||||||
|
export async function getProxyFetchOptions(params: { npmWorkspaceRootDirPath: string }): Promise<ProxyFetchOptions> {
|
||||||
|
const { npmWorkspaceRootDirPath } = params;
|
||||||
|
|
||||||
|
const cfg = await getNmpConfig({ npmWorkspaceRootDirPath });
|
||||||
|
|
||||||
|
const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
|
||||||
|
const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
|
||||||
|
|
||||||
|
function maybeBoolean(arg0: string | undefined) {
|
||||||
|
return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
|
||||||
|
}
|
||||||
|
|
||||||
|
const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
|
||||||
|
const cert = cfg["cert"];
|
||||||
|
const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
|
||||||
|
const cafile = ensureSingleOrNone(cfg["cafile"]);
|
||||||
|
|
||||||
|
if (typeof cafile !== "undefined" && cafile !== "null") {
|
||||||
|
ca.push(
|
||||||
|
...(await (async () => {
|
||||||
|
function chunks<T>(arr: T[], size: number = 2) {
|
||||||
|
return arr.map((_, i) => i % size == 0 && arr.slice(i, i + size)).filter(Boolean) as T[][];
|
||||||
|
}
|
||||||
|
|
||||||
|
const cafileContent = await readFile(cafile, "utf-8");
|
||||||
|
return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n"));
|
||||||
|
})())
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return { proxy, noProxy, strictSSL, cert, "ca": ca.length === 0 ? undefined : ca };
|
||||||
|
}
|
11
src/bin/tools/fs.existsAsync.ts
Normal file
11
src/bin/tools/fs.existsAsync.ts
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
import * as fs from "fs/promises";
|
||||||
|
|
||||||
|
export async function existsAsync(path: string) {
|
||||||
|
try {
|
||||||
|
await fs.stat(path);
|
||||||
|
return true;
|
||||||
|
} catch (error) {
|
||||||
|
if ((error as Error & { code: string }).code === "ENOENT") return false;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
43
src/bin/tools/fs.rm.ts
Normal file
43
src/bin/tools/fs.rm.ts
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
import * as fs from "fs/promises";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { SemVer } from "./SemVer";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Polyfill of fs.rm(dirPath, { "recursive": true })
|
||||||
|
* For older version of Node
|
||||||
|
*/
|
||||||
|
export async function rm(dirPath: string, options: { recursive: true; force?: true }) {
|
||||||
|
if (SemVer.compare(SemVer.parse(process.version), SemVer.parse("14.14.0")) > 0) {
|
||||||
|
return fs.rm(dirPath, options);
|
||||||
|
}
|
||||||
|
|
||||||
|
const { force = true } = options;
|
||||||
|
|
||||||
|
if (force && !(await checkDirExists(dirPath))) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const removeDir_rec = async (dirPath: string) =>
|
||||||
|
Promise.all(
|
||||||
|
(await fs.readdir(dirPath)).map(async basename => {
|
||||||
|
const fileOrDirpath = pathJoin(dirPath, basename);
|
||||||
|
|
||||||
|
if ((await fs.lstat(fileOrDirpath)).isDirectory()) {
|
||||||
|
await removeDir_rec(fileOrDirpath);
|
||||||
|
} else {
|
||||||
|
await fs.unlink(fileOrDirpath);
|
||||||
|
}
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
await removeDir_rec(dirPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function checkDirExists(dirPath: string) {
|
||||||
|
try {
|
||||||
|
await fs.access(dirPath, fs.constants.F_OK);
|
||||||
|
return true;
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
34
src/bin/tools/fs.rmSync.ts
Normal file
34
src/bin/tools/fs.rmSync.ts
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { SemVer } from "./SemVer";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Polyfill of fs.rmSync(dirPath, { "recursive": true })
|
||||||
|
* For older version of Node
|
||||||
|
*/
|
||||||
|
export function rmSync(dirPath: string, options: { recursive: true; force?: true }) {
|
||||||
|
if (SemVer.compare(SemVer.parse(process.version), SemVer.parse("14.14.0")) > 0) {
|
||||||
|
fs.rmSync(dirPath, options);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const { force = true } = options;
|
||||||
|
|
||||||
|
if (force && !fs.existsSync(dirPath)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const removeDir_rec = (dirPath: string) =>
|
||||||
|
fs.readdirSync(dirPath).forEach(basename => {
|
||||||
|
const fileOrDirpath = pathJoin(dirPath, basename);
|
||||||
|
|
||||||
|
if (fs.lstatSync(fileOrDirpath).isDirectory()) {
|
||||||
|
removeDir_rec(fileOrDirpath);
|
||||||
|
return;
|
||||||
|
} else {
|
||||||
|
fs.unlinkSync(fileOrDirpath);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
removeDir_rec(dirPath);
|
||||||
|
}
|
@ -7,6 +7,8 @@ export function getAbsoluteAndInOsFormatPath(params: { pathIsh: string; cwd: str
|
|||||||
|
|
||||||
pathOut = pathOut.replace(/\//g, pathSep);
|
pathOut = pathOut.replace(/\//g, pathSep);
|
||||||
|
|
||||||
|
pathOut = pathOut.endsWith(pathSep) ? pathOut.slice(0, -1) : pathOut;
|
||||||
|
|
||||||
if (!pathIsAbsolute(pathOut)) {
|
if (!pathIsAbsolute(pathOut)) {
|
||||||
pathOut = pathJoin(cwd, pathOut);
|
pathOut = pathJoin(cwd, pathOut);
|
||||||
}
|
}
|
||||||
|
@ -1,19 +1,19 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import * as path from "path";
|
import * as path from "path";
|
||||||
|
|
||||||
function getProjectRootRec(dirPath: string): string {
|
function getThisCodebaseRootDirPath_rec(dirPath: string): string {
|
||||||
if (fs.existsSync(path.join(dirPath, "package.json"))) {
|
if (fs.existsSync(path.join(dirPath, "package.json"))) {
|
||||||
return dirPath;
|
return dirPath;
|
||||||
}
|
}
|
||||||
return getProjectRootRec(path.join(dirPath, ".."));
|
return getThisCodebaseRootDirPath_rec(path.join(dirPath, ".."));
|
||||||
}
|
}
|
||||||
|
|
||||||
let result: string | undefined = undefined;
|
let result: string | undefined = undefined;
|
||||||
|
|
||||||
export function getProjectRoot(): string {
|
export function getThisCodebaseRootDirPath(): string {
|
||||||
if (result !== undefined) {
|
if (result !== undefined) {
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
return (result = getProjectRootRec(__dirname));
|
return (result = getThisCodebaseRootDirPath_rec(__dirname));
|
||||||
}
|
}
|
@ -1,13 +1,15 @@
|
|||||||
import { getProjectRoot } from "./getProjectRoot";
|
import { getThisCodebaseRootDirPath } from "./getThisCodebaseRootDirPath";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { constants } from "fs";
|
import { constants } from "fs";
|
||||||
import { chmod, stat } from "fs/promises";
|
import { chmod, stat } from "fs/promises";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const { bin } = await import(pathJoin(getProjectRoot(), "package.json"));
|
const thisCodebaseRootDirPath = getThisCodebaseRootDirPath();
|
||||||
|
|
||||||
|
const { bin } = await import(pathJoin(thisCodebaseRootDirPath, "package.json"));
|
||||||
|
|
||||||
const promises = Object.values<string>(bin).map(async scriptPath => {
|
const promises = Object.values<string>(bin).map(async scriptPath => {
|
||||||
const fullPath = pathJoin(getProjectRoot(), scriptPath);
|
const fullPath = pathJoin(thisCodebaseRootDirPath, scriptPath);
|
||||||
const oldMode = (await stat(fullPath)).mode;
|
const oldMode = (await stat(fullPath)).mode;
|
||||||
const newMode = oldMode | constants.S_IXUSR | constants.S_IXGRP | constants.S_IXOTH;
|
const newMode = oldMode | constants.S_IXUSR | constants.S_IXGRP | constants.S_IXOTH;
|
||||||
await chmod(fullPath, newMode);
|
await chmod(fullPath, newMode);
|
||||||
|
@ -1,39 +1,39 @@
|
|||||||
import { listTagsFactory } from "./listTags";
|
import { listTagsFactory } from "./listTags";
|
||||||
import type { Octokit } from "@octokit/rest";
|
import type { Octokit } from "@octokit/rest";
|
||||||
import { NpmModuleVersion } from "../NpmModuleVersion";
|
import { SemVer } from "../SemVer";
|
||||||
|
|
||||||
export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
|
export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
|
||||||
const { octokit } = params;
|
const { octokit } = params;
|
||||||
|
|
||||||
async function getLatestsSemVersionedTag(params: { owner: string; repo: string; doIgnoreBeta: boolean; count: number }): Promise<
|
async function getLatestsSemVersionedTag(params: { owner: string; repo: string; count: number }): Promise<
|
||||||
{
|
{
|
||||||
tag: string;
|
tag: string;
|
||||||
version: NpmModuleVersion;
|
version: SemVer;
|
||||||
}[]
|
}[]
|
||||||
> {
|
> {
|
||||||
const { owner, repo, doIgnoreBeta, count } = params;
|
const { owner, repo, count } = params;
|
||||||
|
|
||||||
const semVersionedTags: { tag: string; version: NpmModuleVersion }[] = [];
|
const semVersionedTags: { tag: string; version: SemVer }[] = [];
|
||||||
|
|
||||||
const { listTags } = listTagsFactory({ octokit });
|
const { listTags } = listTagsFactory({ octokit });
|
||||||
|
|
||||||
for await (const tag of listTags({ owner, repo })) {
|
for await (const tag of listTags({ owner, repo })) {
|
||||||
let version: NpmModuleVersion;
|
let version: SemVer;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
version = NpmModuleVersion.parse(tag.replace(/^[vV]?/, ""));
|
version = SemVer.parse(tag.replace(/^[vV]?/, ""));
|
||||||
} catch {
|
} catch {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (doIgnoreBeta && version.betaPreRelease !== undefined) {
|
if (version.rc !== undefined) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
semVersionedTags.push({ tag, version });
|
semVersionedTags.push({ tag, version });
|
||||||
}
|
}
|
||||||
|
|
||||||
return semVersionedTags.sort(({ version: vX }, { version: vY }) => NpmModuleVersion.compare(vY, vX)).slice(0, count);
|
return semVersionedTags.sort(({ version: vX }, { version: vY }) => SemVer.compare(vY, vX)).slice(0, count);
|
||||||
}
|
}
|
||||||
|
|
||||||
return { getLatestsSemVersionedTag };
|
return { getLatestsSemVersionedTag };
|
||||||
|
@ -1,6 +0,0 @@
|
|||||||
export function pathJoin(...path: string[]): string {
|
|
||||||
return path
|
|
||||||
.map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
|
|
||||||
.map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
|
|
||||||
.join(typeof process !== "undefined" && process.platform === "win32" ? "\\" : "/");
|
|
||||||
}
|
|
12
src/bin/tools/readThisNpmProjectVersion.ts
Normal file
12
src/bin/tools/readThisNpmProjectVersion.ts
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
import { getThisCodebaseRootDirPath } from "./getThisCodebaseRootDirPath";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
|
||||||
|
export function readThisNpmProjectVersion(): string {
|
||||||
|
const version = JSON.parse(fs.readFileSync(pathJoin(getThisCodebaseRootDirPath(), "package.json")).toString("utf8"))["version"];
|
||||||
|
|
||||||
|
assert(typeof version === "string");
|
||||||
|
|
||||||
|
return version;
|
||||||
|
}
|
@ -1,7 +1,7 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import * as path from "path";
|
import * as path from "path";
|
||||||
import { crawl } from "./crawl";
|
import { crawl } from "./crawl";
|
||||||
import { id } from "tsafe/id";
|
import { rmSync } from "../tools/fs.rmSync";
|
||||||
|
|
||||||
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; fileRelativePath: string }) =>
|
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; fileRelativePath: string }) =>
|
||||||
| {
|
| {
|
||||||
@ -10,18 +10,37 @@ type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; file
|
|||||||
}
|
}
|
||||||
| undefined;
|
| undefined;
|
||||||
|
|
||||||
/** Apply a transformation function to every file of directory */
|
/**
|
||||||
|
* Apply a transformation function to every file of directory
|
||||||
|
* If source and destination are the same this function can be used to apply the transformation in place
|
||||||
|
* like filtering out some files or modifying them.
|
||||||
|
* */
|
||||||
export function transformCodebase(params: { srcDirPath: string; destDirPath: string; transformSourceCode?: TransformSourceCode }) {
|
export function transformCodebase(params: { srcDirPath: string; destDirPath: string; transformSourceCode?: TransformSourceCode }) {
|
||||||
const {
|
const { srcDirPath, transformSourceCode } = params;
|
||||||
srcDirPath,
|
|
||||||
destDirPath,
|
const isTargetSameAsSource = path.relative(srcDirPath, params.destDirPath) === "";
|
||||||
transformSourceCode = id<TransformSourceCode>(({ sourceCode }) => ({
|
|
||||||
"modifiedSourceCode": sourceCode
|
const destDirPath = isTargetSameAsSource ? path.join(srcDirPath, "..", "tmp_xOsPdkPsTdzPs34sOkHs") : params.destDirPath;
|
||||||
}))
|
|
||||||
} = params;
|
fs.mkdirSync(destDirPath, {
|
||||||
|
"recursive": true
|
||||||
|
});
|
||||||
|
|
||||||
for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
||||||
const filePath = path.join(srcDirPath, fileRelativePath);
|
const filePath = path.join(srcDirPath, fileRelativePath);
|
||||||
|
const destFilePath = path.join(destDirPath, fileRelativePath);
|
||||||
|
|
||||||
|
// NOTE: Optimization, if we don't need to transform the file, just copy
|
||||||
|
// it using the lower level implementation.
|
||||||
|
if (transformSourceCode === undefined) {
|
||||||
|
fs.mkdirSync(path.dirname(destFilePath), {
|
||||||
|
"recursive": true
|
||||||
|
});
|
||||||
|
|
||||||
|
fs.copyFileSync(filePath, destFilePath);
|
||||||
|
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
const transformSourceCodeResult = transformSourceCode({
|
const transformSourceCodeResult = transformSourceCode({
|
||||||
"sourceCode": fs.readFileSync(filePath),
|
"sourceCode": fs.readFileSync(filePath),
|
||||||
@ -33,15 +52,18 @@ export function transformCodebase(params: { srcDirPath: string; destDirPath: str
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.mkdirSync(path.dirname(path.join(destDirPath, fileRelativePath)), {
|
fs.mkdirSync(path.dirname(destFilePath), {
|
||||||
"recursive": true
|
"recursive": true
|
||||||
});
|
});
|
||||||
|
|
||||||
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(path.join(path.dirname(destFilePath), newFileName ?? path.basename(destFilePath)), modifiedSourceCode);
|
||||||
path.join(path.dirname(path.join(destDirPath, fileRelativePath)), newFileName ?? path.basename(fileRelativePath)),
|
}
|
||||||
modifiedSourceCode
|
|
||||||
);
|
if (isTargetSameAsSource) {
|
||||||
|
rmSync(srcDirPath, { "recursive": true });
|
||||||
|
|
||||||
|
fs.renameSync(destDirPath, srcDirPath);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
44
src/lib/BASE_URL.ts
Normal file
44
src/lib/BASE_URL.ts
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* WARNING: Internal use only!!
|
||||||
|
* THIS DOES NOT WORK IN KEYCLOAK! It's only for resolving mock assets.
|
||||||
|
* This is just a way to know what's the base url that works
|
||||||
|
* both in webpack and vite.
|
||||||
|
* You can see this as a polyfill that return `import.meta.env.BASE_URL` when in Vite
|
||||||
|
* and when in Webpack returns the base url in the same format as vite does meaning
|
||||||
|
* "/" if hosted at root or "/foo/" when hosted under a subpath (always start and ends with a "/").
|
||||||
|
*/
|
||||||
|
export const BASE_URL = (() => {
|
||||||
|
vite: {
|
||||||
|
let BASE_URL: string;
|
||||||
|
|
||||||
|
try {
|
||||||
|
// @ts-expect-error
|
||||||
|
BASE_URL = import.meta.env.BASE_URL;
|
||||||
|
|
||||||
|
assert(typeof BASE_URL === "string");
|
||||||
|
} catch {
|
||||||
|
break vite;
|
||||||
|
}
|
||||||
|
|
||||||
|
return BASE_URL;
|
||||||
|
}
|
||||||
|
|
||||||
|
webpack: {
|
||||||
|
let BASE_URL: string;
|
||||||
|
|
||||||
|
try {
|
||||||
|
// @ts-expect-error
|
||||||
|
BASE_URL = process.env.PUBLIC_URL;
|
||||||
|
|
||||||
|
assert(typeof BASE_URL === "string");
|
||||||
|
} catch {
|
||||||
|
break webpack;
|
||||||
|
}
|
||||||
|
|
||||||
|
return BASE_URL === "" ? "/" : `${BASE_URL}/`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return "/";
|
||||||
|
})();
|
1
src/lib/isStorybook.ts
Normal file
1
src/lib/isStorybook.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export const isStorybook = typeof window === "object" && Object.keys(window).find(key => key.startsWith("__STORYBOOK")) !== undefined;
|
@ -36,6 +36,10 @@ export declare namespace keycloak_js {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @deprecated: This will be removed in the next major version.
|
||||||
|
* If you use this, please copy paste the code into your project.
|
||||||
|
* Better yet migrate away from keycloak-js and use https://docs.oidc-spa.dev instead.
|
||||||
|
*
|
||||||
* NOTE: This is just a slightly modified version of the default adapter in keycloak-js
|
* NOTE: This is just a slightly modified version of the default adapter in keycloak-js
|
||||||
* The goal here is just to be able to inject search param in url before keycloak redirect.
|
* The goal here is just to be able to inject search param in url before keycloak redirect.
|
||||||
* Our use case for it is to pass over the login screen the states of useGlobalState
|
* Our use case for it is to pass over the login screen the states of useGlobalState
|
||||||
|
@ -5,10 +5,10 @@ export function createUseClassName<ClassKey extends string>(params: { defaultCla
|
|||||||
const { defaultClasses } = params;
|
const { defaultClasses } = params;
|
||||||
|
|
||||||
function useGetClassName(params: { doUseDefaultCss: boolean; classes: Partial<Record<ClassKey, string>> | undefined }) {
|
function useGetClassName(params: { doUseDefaultCss: boolean; classes: Partial<Record<ClassKey, string>> | undefined }) {
|
||||||
const { classes } = params;
|
const { classes, doUseDefaultCss } = params;
|
||||||
|
|
||||||
const getClassName = useConstCallback((classKey: ClassKey): string => {
|
const getClassName = useConstCallback((classKey: ClassKey): string => {
|
||||||
return clsx(classKey, defaultClasses[classKey], classes?.[classKey]);
|
return clsx(classKey, doUseDefaultCss ? defaultClasses[classKey] : undefined, classes?.[classKey]);
|
||||||
});
|
});
|
||||||
|
|
||||||
return { getClassName };
|
return { getClassName };
|
||||||
|
@ -1,92 +0,0 @@
|
|||||||
import { useReducer, useEffect } from "react";
|
|
||||||
import { headInsert } from "keycloakify/tools/headInsert";
|
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
|
||||||
|
|
||||||
export function usePrepareTemplate(params: {
|
|
||||||
doFetchDefaultThemeResources: boolean;
|
|
||||||
styles?: string[];
|
|
||||||
scripts?: string[];
|
|
||||||
htmlClassName: string | undefined;
|
|
||||||
bodyClassName: string | undefined;
|
|
||||||
}) {
|
|
||||||
const { doFetchDefaultThemeResources, styles = [], scripts = [], htmlClassName, bodyClassName } = params;
|
|
||||||
|
|
||||||
const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (!doFetchDefaultThemeResources) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
let isUnmounted = false;
|
|
||||||
|
|
||||||
const removeArray: (() => void)[] = [];
|
|
||||||
|
|
||||||
(async () => {
|
|
||||||
for (const style of [...styles].reverse()) {
|
|
||||||
const { prLoaded, remove } = headInsert({
|
|
||||||
"type": "css",
|
|
||||||
"position": "prepend",
|
|
||||||
"href": style
|
|
||||||
});
|
|
||||||
|
|
||||||
removeArray.push(remove);
|
|
||||||
|
|
||||||
// TODO: Find a way to do that in parallel (without breaking the order)
|
|
||||||
await prLoaded;
|
|
||||||
|
|
||||||
if (isUnmounted) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
setReady();
|
|
||||||
})();
|
|
||||||
|
|
||||||
scripts.forEach(src => {
|
|
||||||
const { remove } = headInsert({
|
|
||||||
"type": "javascript",
|
|
||||||
src
|
|
||||||
});
|
|
||||||
|
|
||||||
removeArray.push(remove);
|
|
||||||
});
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
isUnmounted = true;
|
|
||||||
removeArray.forEach(remove => remove());
|
|
||||||
};
|
|
||||||
}, []);
|
|
||||||
|
|
||||||
useSetClassName({
|
|
||||||
"target": "html",
|
|
||||||
"className": htmlClassName
|
|
||||||
});
|
|
||||||
|
|
||||||
useSetClassName({
|
|
||||||
"target": "body",
|
|
||||||
"className": bodyClassName
|
|
||||||
});
|
|
||||||
|
|
||||||
return { isReady };
|
|
||||||
}
|
|
||||||
|
|
||||||
function useSetClassName(params: { target: "html" | "body"; className: string | undefined }) {
|
|
||||||
const { target, className } = params;
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
if (className === undefined) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const htmlClassList = document.getElementsByTagName(target)[0].classList;
|
|
||||||
|
|
||||||
const tokens = clsx(className).split(" ");
|
|
||||||
|
|
||||||
htmlClassList.add(...tokens);
|
|
||||||
|
|
||||||
return () => {
|
|
||||||
htmlClassList.remove(...tokens);
|
|
||||||
};
|
|
||||||
}, [className]);
|
|
||||||
}
|
|
@ -3,21 +3,23 @@ import type { PageProps } from "keycloakify/login/pages/PageProps";
|
|||||||
import { assert, type Equals } from "tsafe/assert";
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
import type { I18n } from "./i18n";
|
import type { I18n } from "./i18n";
|
||||||
import type { KcContext } from "./kcContext";
|
import type { KcContext } from "./kcContext";
|
||||||
|
import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
|
||||||
|
import type { UserProfileFormFieldsProps } from "keycloakify/login/UserProfileFormFields";
|
||||||
|
|
||||||
const Login = lazy(() => import("keycloakify/login/pages/Login"));
|
const Login = lazy(() => import("keycloakify/login/pages/Login"));
|
||||||
const Register = lazy(() => import("keycloakify/login/pages/Register"));
|
const Register = lazy(() => import("keycloakify/login/pages/Register"));
|
||||||
const RegisterUserProfile = lazy(() => import("keycloakify/login/pages/RegisterUserProfile"));
|
|
||||||
const Info = lazy(() => import("keycloakify/login/pages/Info"));
|
const Info = lazy(() => import("keycloakify/login/pages/Info"));
|
||||||
const Error = lazy(() => import("keycloakify/login/pages/Error"));
|
const Error = lazy(() => import("keycloakify/login/pages/Error"));
|
||||||
const LoginResetPassword = lazy(() => import("keycloakify/login/pages/LoginResetPassword"));
|
const LoginResetPassword = lazy(() => import("keycloakify/login/pages/LoginResetPassword"));
|
||||||
const LoginVerifyEmail = lazy(() => import("keycloakify/login/pages/LoginVerifyEmail"));
|
const LoginVerifyEmail = lazy(() => import("keycloakify/login/pages/LoginVerifyEmail"));
|
||||||
const Terms = lazy(() => import("keycloakify/login/pages/Terms"));
|
const Terms = lazy(() => import("keycloakify/login/pages/Terms"));
|
||||||
const LoginDeviceVerifyUserCode = lazy(() => import("keycloakify/login/pages/LoginDeviceVerifyUserCode"));
|
const LoginOauth2DeviceVerifyUserCode = lazy(() => import("keycloakify/login/pages/LoginOauth2DeviceVerifyUserCode"));
|
||||||
const LoginOauthGrant = lazy(() => import("keycloakify/login/pages/LoginOauthGrant"));
|
const LoginOauthGrant = lazy(() => import("keycloakify/login/pages/LoginOauthGrant"));
|
||||||
const LoginOtp = lazy(() => import("keycloakify/login/pages/LoginOtp"));
|
const LoginOtp = lazy(() => import("keycloakify/login/pages/LoginOtp"));
|
||||||
const LoginPassword = lazy(() => import("keycloakify/login/pages/LoginPassword"));
|
const LoginPassword = lazy(() => import("keycloakify/login/pages/LoginPassword"));
|
||||||
const LoginUsername = lazy(() => import("keycloakify/login/pages/LoginUsername"));
|
const LoginUsername = lazy(() => import("keycloakify/login/pages/LoginUsername"));
|
||||||
const WebauthnAuthenticate = lazy(() => import("keycloakify/login/pages/WebauthnAuthenticate"));
|
const WebauthnAuthenticate = lazy(() => import("keycloakify/login/pages/WebauthnAuthenticate"));
|
||||||
|
const WebauthnRegister = lazy(() => import("keycloakify/login/pages/WebauthnRegister"));
|
||||||
const LoginUpdatePassword = lazy(() => import("keycloakify/login/pages/LoginUpdatePassword"));
|
const LoginUpdatePassword = lazy(() => import("keycloakify/login/pages/LoginUpdatePassword"));
|
||||||
const LoginUpdateProfile = lazy(() => import("keycloakify/login/pages/LoginUpdateProfile"));
|
const LoginUpdateProfile = lazy(() => import("keycloakify/login/pages/LoginUpdateProfile"));
|
||||||
const LoginIdpLinkConfirm = lazy(() => import("keycloakify/login/pages/LoginIdpLinkConfirm"));
|
const LoginIdpLinkConfirm = lazy(() => import("keycloakify/login/pages/LoginIdpLinkConfirm"));
|
||||||
@ -25,13 +27,25 @@ const LoginPageExpired = lazy(() => import("keycloakify/login/pages/LoginPageExp
|
|||||||
const LoginIdpLinkEmail = lazy(() => import("keycloakify/login/pages/LoginIdpLinkEmail"));
|
const LoginIdpLinkEmail = lazy(() => import("keycloakify/login/pages/LoginIdpLinkEmail"));
|
||||||
const LoginConfigTotp = lazy(() => import("keycloakify/login/pages/LoginConfigTotp"));
|
const LoginConfigTotp = lazy(() => import("keycloakify/login/pages/LoginConfigTotp"));
|
||||||
const LogoutConfirm = lazy(() => import("keycloakify/login/pages/LogoutConfirm"));
|
const LogoutConfirm = lazy(() => import("keycloakify/login/pages/LogoutConfirm"));
|
||||||
const UpdateUserProfile = lazy(() => import("keycloakify/login/pages/UpdateUserProfile"));
|
|
||||||
const IdpReviewUserProfile = lazy(() => import("keycloakify/login/pages/IdpReviewUserProfile"));
|
const IdpReviewUserProfile = lazy(() => import("keycloakify/login/pages/IdpReviewUserProfile"));
|
||||||
const UpdateEmail = lazy(() => import("keycloakify/login/pages/UpdateEmail"));
|
const UpdateEmail = lazy(() => import("keycloakify/login/pages/UpdateEmail"));
|
||||||
const SelectAuthenticator = lazy(() => import("keycloakify/login/pages/SelectAuthenticator"));
|
const SelectAuthenticator = lazy(() => import("keycloakify/login/pages/SelectAuthenticator"));
|
||||||
const SamlPostForm = lazy(() => import("keycloakify/login/pages/SamlPostForm"));
|
const SamlPostForm = lazy(() => import("keycloakify/login/pages/SamlPostForm"));
|
||||||
|
const DeleteCredential = lazy(() => import("keycloakify/login/pages/DeleteCredential"));
|
||||||
|
const Code = lazy(() => import("keycloakify/login/pages/Code"));
|
||||||
|
const DeleteAccountConfirm = lazy(() => import("keycloakify/login/pages/DeleteAccountConfirm"));
|
||||||
|
const FrontchannelLogout = lazy(() => import("keycloakify/login/pages/FrontchannelLogout"));
|
||||||
|
const LoginRecoveryAuthnCodeConfig = lazy(() => import("keycloakify/login/pages/LoginRecoveryAuthnCodeConfig"));
|
||||||
|
const LoginRecoveryAuthnCodeInput = lazy(() => import("keycloakify/login/pages/LoginRecoveryAuthnCodeInput"));
|
||||||
|
const LoginResetOtp = lazy(() => import("keycloakify/login/pages/LoginResetOtp"));
|
||||||
|
const LoginX509Info = lazy(() => import("keycloakify/login/pages/LoginX509Info"));
|
||||||
|
const WebauthnError = lazy(() => import("keycloakify/login/pages/WebauthnError"));
|
||||||
|
|
||||||
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
type FallbackProps = PageProps<KcContext, I18n> & {
|
||||||
|
UserProfileFormFields: LazyOrNot<(props: UserProfileFormFieldsProps) => JSX.Element>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default function Fallback(props: FallbackProps) {
|
||||||
const { kcContext, ...rest } = props;
|
const { kcContext, ...rest } = props;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
@ -42,8 +56,6 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <Login kcContext={kcContext} {...rest} />;
|
return <Login kcContext={kcContext} {...rest} />;
|
||||||
case "register.ftl":
|
case "register.ftl":
|
||||||
return <Register kcContext={kcContext} {...rest} />;
|
return <Register kcContext={kcContext} {...rest} />;
|
||||||
case "register-user-profile.ftl":
|
|
||||||
return <RegisterUserProfile kcContext={kcContext} {...rest} />;
|
|
||||||
case "info.ftl":
|
case "info.ftl":
|
||||||
return <Info kcContext={kcContext} {...rest} />;
|
return <Info kcContext={kcContext} {...rest} />;
|
||||||
case "error.ftl":
|
case "error.ftl":
|
||||||
@ -55,7 +67,7 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
case "terms.ftl":
|
case "terms.ftl":
|
||||||
return <Terms kcContext={kcContext} {...rest} />;
|
return <Terms kcContext={kcContext} {...rest} />;
|
||||||
case "login-oauth2-device-verify-user-code.ftl":
|
case "login-oauth2-device-verify-user-code.ftl":
|
||||||
return <LoginDeviceVerifyUserCode kcContext={kcContext} {...rest} />;
|
return <LoginOauth2DeviceVerifyUserCode kcContext={kcContext} {...rest} />;
|
||||||
case "login-oauth-grant.ftl":
|
case "login-oauth-grant.ftl":
|
||||||
return <LoginOauthGrant kcContext={kcContext} {...rest} />;
|
return <LoginOauthGrant kcContext={kcContext} {...rest} />;
|
||||||
case "login-otp.ftl":
|
case "login-otp.ftl":
|
||||||
@ -66,6 +78,8 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <LoginPassword kcContext={kcContext} {...rest} />;
|
return <LoginPassword kcContext={kcContext} {...rest} />;
|
||||||
case "webauthn-authenticate.ftl":
|
case "webauthn-authenticate.ftl":
|
||||||
return <WebauthnAuthenticate kcContext={kcContext} {...rest} />;
|
return <WebauthnAuthenticate kcContext={kcContext} {...rest} />;
|
||||||
|
case "webauthn-register.ftl":
|
||||||
|
return <WebauthnRegister kcContext={kcContext} {...rest} />;
|
||||||
case "login-update-password.ftl":
|
case "login-update-password.ftl":
|
||||||
return <LoginUpdatePassword kcContext={kcContext} {...rest} />;
|
return <LoginUpdatePassword kcContext={kcContext} {...rest} />;
|
||||||
case "login-update-profile.ftl":
|
case "login-update-profile.ftl":
|
||||||
@ -80,8 +94,6 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <LoginConfigTotp kcContext={kcContext} {...rest} />;
|
return <LoginConfigTotp kcContext={kcContext} {...rest} />;
|
||||||
case "logout-confirm.ftl":
|
case "logout-confirm.ftl":
|
||||||
return <LogoutConfirm kcContext={kcContext} {...rest} />;
|
return <LogoutConfirm kcContext={kcContext} {...rest} />;
|
||||||
case "update-user-profile.ftl":
|
|
||||||
return <UpdateUserProfile kcContext={kcContext} {...rest} />;
|
|
||||||
case "idp-review-user-profile.ftl":
|
case "idp-review-user-profile.ftl":
|
||||||
return <IdpReviewUserProfile kcContext={kcContext} {...rest} />;
|
return <IdpReviewUserProfile kcContext={kcContext} {...rest} />;
|
||||||
case "update-email.ftl":
|
case "update-email.ftl":
|
||||||
@ -90,6 +102,24 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <SelectAuthenticator kcContext={kcContext} {...rest} />;
|
return <SelectAuthenticator kcContext={kcContext} {...rest} />;
|
||||||
case "saml-post-form.ftl":
|
case "saml-post-form.ftl":
|
||||||
return <SamlPostForm kcContext={kcContext} {...rest} />;
|
return <SamlPostForm kcContext={kcContext} {...rest} />;
|
||||||
|
case "delete-credential.ftl":
|
||||||
|
return <DeleteCredential kcContext={kcContext} {...rest} />;
|
||||||
|
case "code.ftl":
|
||||||
|
return <Code kcContext={kcContext} {...rest} />;
|
||||||
|
case "delete-account-confirm.ftl":
|
||||||
|
return <DeleteAccountConfirm kcContext={kcContext} {...rest} />;
|
||||||
|
case "frontchannel-logout.ftl":
|
||||||
|
return <FrontchannelLogout kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-recovery-authn-code-config.ftl":
|
||||||
|
return <LoginRecoveryAuthnCodeConfig kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-recovery-authn-code-input.ftl":
|
||||||
|
return <LoginRecoveryAuthnCodeInput kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-reset-otp.ftl":
|
||||||
|
return <LoginResetOtp kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-x509-info.ftl":
|
||||||
|
return <LoginX509Info kcContext={kcContext} {...rest} />;
|
||||||
|
case "webauthn-error.ftl":
|
||||||
|
return <WebauthnError kcContext={kcContext} {...rest} />;
|
||||||
}
|
}
|
||||||
assert<Equals<typeof kcContext, never>>(false);
|
assert<Equals<typeof kcContext, never>>(false);
|
||||||
})()}
|
})()}
|
||||||
|
@ -1,21 +1,28 @@
|
|||||||
|
import { useEffect } from "react";
|
||||||
import { assert } from "keycloakify/tools/assert";
|
import { assert } from "keycloakify/tools/assert";
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
import { usePrepareTemplate } from "keycloakify/lib/usePrepareTemplate";
|
|
||||||
import { type TemplateProps } from "keycloakify/login/TemplateProps";
|
import { type TemplateProps } from "keycloakify/login/TemplateProps";
|
||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
|
import { createUseInsertScriptTags } from "keycloakify/tools/useInsertScriptTags";
|
||||||
|
import { createUseInsertLinkTags } from "keycloakify/tools/useInsertLinkTags";
|
||||||
|
import { useSetClassName } from "keycloakify/tools/useSetClassName";
|
||||||
import type { KcContext } from "./kcContext";
|
import type { KcContext } from "./kcContext";
|
||||||
import type { I18n } from "./i18n";
|
import type { I18n } from "./i18n";
|
||||||
|
|
||||||
|
const { useInsertLinkTags } = createUseInsertLinkTags();
|
||||||
|
const { useInsertScriptTags } = createUseInsertScriptTags();
|
||||||
|
|
||||||
export default function Template(props: TemplateProps<KcContext, I18n>) {
|
export default function Template(props: TemplateProps<KcContext, I18n>) {
|
||||||
const {
|
const {
|
||||||
displayInfo = false,
|
displayInfo = false,
|
||||||
displayMessage = true,
|
displayMessage = true,
|
||||||
displayRequiredFields = false,
|
displayRequiredFields = false,
|
||||||
displayWide = false,
|
|
||||||
showAnotherWayIfPresent = true,
|
|
||||||
headerNode,
|
headerNode,
|
||||||
showUsernameNode = null,
|
showUsernameNode = null,
|
||||||
|
socialProvidersNode = null,
|
||||||
infoNode = null,
|
infoNode = null,
|
||||||
|
documentTitle,
|
||||||
|
bodyClassName,
|
||||||
kcContext,
|
kcContext,
|
||||||
i18n,
|
i18n,
|
||||||
doUseDefaultCss,
|
doUseDefaultCss,
|
||||||
@ -25,23 +32,87 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
|
|
||||||
const { getClassName } = useGetClassName({ doUseDefaultCss, classes });
|
const { getClassName } = useGetClassName({ doUseDefaultCss, classes });
|
||||||
|
|
||||||
const { msg, changeLocale, labelBySupportedLanguageTag, currentLanguageTag } = i18n;
|
const { msg, msgStr, changeLocale, labelBySupportedLanguageTag, currentLanguageTag } = i18n;
|
||||||
|
|
||||||
const { realm, locale, auth, url, message, isAppInitiatedAction } = kcContext;
|
const { realm, locale, auth, url, message, isAppInitiatedAction, authenticationSession, scripts } = kcContext;
|
||||||
|
|
||||||
const { isReady } = usePrepareTemplate({
|
useEffect(() => {
|
||||||
"doFetchDefaultThemeResources": doUseDefaultCss,
|
document.title = documentTitle ?? msgStr("loginTitle", kcContext.realm.displayName);
|
||||||
"styles": [
|
}, []);
|
||||||
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
|
||||||
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
useSetClassName({
|
||||||
`${url.resourcesCommonPath}/lib/zocial/zocial.css`,
|
"qualifiedName": "html",
|
||||||
`${url.resourcesPath}/css/login.css`
|
"className": getClassName("kcHtmlClass")
|
||||||
],
|
|
||||||
"htmlClassName": getClassName("kcHtmlClass"),
|
|
||||||
"bodyClassName": getClassName("kcBodyClass")
|
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!isReady) {
|
useSetClassName({
|
||||||
|
"qualifiedName": "body",
|
||||||
|
"className": bodyClassName ?? getClassName("kcBodyClass")
|
||||||
|
});
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const { currentLanguageTag } = locale ?? {};
|
||||||
|
|
||||||
|
if (currentLanguageTag === undefined) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const html = document.querySelector("html");
|
||||||
|
assert(html !== null);
|
||||||
|
html.lang = currentLanguageTag;
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const { areAllStyleSheetsLoaded } = useInsertLinkTags({
|
||||||
|
"hrefs": !doUseDefaultCss
|
||||||
|
? []
|
||||||
|
: [
|
||||||
|
`${url.resourcesCommonPath}/node_modules/@patternfly/patternfly/patternfly.min.css`,
|
||||||
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
|
`${url.resourcesCommonPath}/lib/pficon/pficon.css`,
|
||||||
|
`${url.resourcesPath}/css/login.css`
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
const { insertScriptTags } = useInsertScriptTags({
|
||||||
|
"scriptTags": [
|
||||||
|
{
|
||||||
|
"type": "module",
|
||||||
|
"src": `${url.resourcesPath}/js/menu-button-links.js`
|
||||||
|
},
|
||||||
|
...(authenticationSession === undefined
|
||||||
|
? []
|
||||||
|
: [
|
||||||
|
{
|
||||||
|
"type": "module",
|
||||||
|
"textContent": [
|
||||||
|
`import { checkCookiesAndSetTimer } from "${url.resourcesPath}/js/authChecker.js";`,
|
||||||
|
``,
|
||||||
|
`checkCookiesAndSetTimer(`,
|
||||||
|
` "${authenticationSession.authSessionId}",`,
|
||||||
|
` "${authenticationSession.tabId}",`,
|
||||||
|
` "${url.ssoLoginInOtherTabsUrl}"`,
|
||||||
|
`);`
|
||||||
|
].join("\n")
|
||||||
|
} as const
|
||||||
|
]),
|
||||||
|
...scripts.map(
|
||||||
|
script =>
|
||||||
|
({
|
||||||
|
"type": "text/javascript",
|
||||||
|
"src": script
|
||||||
|
} as const)
|
||||||
|
)
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (areAllStyleSheetsLoaded) {
|
||||||
|
insertScriptTags();
|
||||||
|
}
|
||||||
|
}, [areAllStyleSheetsLoaded]);
|
||||||
|
|
||||||
|
if (!areAllStyleSheetsLoaded) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -53,12 +124,12 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className={clsx(getClassName("kcFormCardClass"), displayWide && getClassName("kcFormCardAccountClass"))}>
|
<div className={getClassName("kcFormCardClass")}>
|
||||||
<header className={getClassName("kcFormHeaderClass")}>
|
<header className={getClassName("kcFormHeaderClass")}>
|
||||||
{realm.internationalizationEnabled && (assert(locale !== undefined), true) && locale.supported.length > 1 && (
|
{realm.internationalizationEnabled && (assert(locale !== undefined), true) && locale.supported.length > 1 && (
|
||||||
<div id="kc-locale">
|
<div className={getClassName("kcLocaleMainClass")} id="kc-locale">
|
||||||
<div id="kc-locale-wrapper" className={getClassName("kcLocaleWrapperClass")}>
|
<div id="kc-locale-wrapper" className={getClassName("kcLocaleWrapperClass")}>
|
||||||
<div className="kc-dropdown" id="kc-locale-dropdown">
|
<div id="kc-locale-dropdown" className={clsx("menu-button-links", getClassName("kcLocaleDropDownClass"))}>
|
||||||
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
|
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
|
||||||
<a href="#" id="kc-current-locale-link">
|
<a href="#" id="kc-current-locale-link">
|
||||||
{labelBySupportedLanguageTag[currentLanguageTag]}
|
{labelBySupportedLanguageTag[currentLanguageTag]}
|
||||||
@ -73,6 +144,40 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</li>
|
</li>
|
||||||
))}
|
))}
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
<button
|
||||||
|
tabIndex={1}
|
||||||
|
id="kc-current-locale-link"
|
||||||
|
aria-label={msgStr("languages" as any)}
|
||||||
|
aria-haspopup={true}
|
||||||
|
aria-expanded={false}
|
||||||
|
aria-controls="language-switch1"
|
||||||
|
>
|
||||||
|
{labelBySupportedLanguageTag[currentLanguageTag]}
|
||||||
|
</button>
|
||||||
|
<ul
|
||||||
|
role="menu"
|
||||||
|
tabIndex={-1}
|
||||||
|
aria-labelledby="kc-current-locale-link"
|
||||||
|
aria-activedescendant=""
|
||||||
|
id="language-switch1"
|
||||||
|
className={getClassName("kcLocaleListClass")}
|
||||||
|
>
|
||||||
|
{locale.supported.map(({ languageTag }, i) => (
|
||||||
|
<li key={languageTag} className={getClassName("kcLocaleListItemClass")} role="none">
|
||||||
|
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
|
||||||
|
<a
|
||||||
|
role="menuitem"
|
||||||
|
id={`language-${i}`}
|
||||||
|
className={getClassName("kcLocaleItemClass")}
|
||||||
|
href="#"
|
||||||
|
onClick={() => changeLocale(languageTag)}
|
||||||
|
>
|
||||||
|
{labelBySupportedLanguageTag[languageTag]}
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -102,26 +207,9 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</div>
|
</div>
|
||||||
<div className="col-md-10">
|
<div className="col-md-10">
|
||||||
{showUsernameNode}
|
{showUsernameNode}
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
<div id="kc-username" className={getClassName("kcFormGroupClass")}>
|
||||||
<div id="kc-username">
|
<label id="kc-attempted-username">{auth.attemptedUsername}</label>
|
||||||
<label id="kc-attempted-username">{auth?.attemptedUsername}</label>
|
<a id="reset-login" href={url.loginRestartFlowUrl} aria-label={msgStr("restartLoginTooltip")}>
|
||||||
<a id="reset-login" href={url.loginRestartFlowUrl}>
|
|
||||||
<div className="kc-login-tooltip">
|
|
||||||
<i className={getClassName("kcResetFlowIcon")}></i>
|
|
||||||
<span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
|
|
||||||
</div>
|
|
||||||
</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
) : (
|
|
||||||
<>
|
|
||||||
{showUsernameNode}
|
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
|
||||||
<div id="kc-username">
|
|
||||||
<label id="kc-attempted-username">{auth?.attemptedUsername}</label>
|
|
||||||
<a id="reset-login" href={url.loginRestartFlowUrl}>
|
|
||||||
<div className="kc-login-tooltip">
|
<div className="kc-login-tooltip">
|
||||||
<i className={getClassName("kcResetFlowIcon")}></i>
|
<i className={getClassName("kcResetFlowIcon")}></i>
|
||||||
<span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
|
<span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
|
||||||
@ -129,6 +217,19 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
</div>
|
||||||
|
) : (
|
||||||
|
<>
|
||||||
|
{showUsernameNode}
|
||||||
|
<div id="kc-username" className={getClassName("kcFormGroupClass")}>
|
||||||
|
<label id="kc-attempted-username">{auth.attemptedUsername}</label>
|
||||||
|
<a id="reset-login" href={url.loginRestartFlowUrl} aria-label={msgStr("restartLoginTooltip")}>
|
||||||
|
<div className="kc-login-tooltip">
|
||||||
|
<i className={getClassName("kcResetFlowIcon")}></i>
|
||||||
|
<span className="kc-tooltip-text">{msg("restartLoginTooltip")}</span>
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
</>
|
</>
|
||||||
)}
|
)}
|
||||||
</header>
|
</header>
|
||||||
@ -136,13 +237,21 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
<div id="kc-content-wrapper">
|
<div id="kc-content-wrapper">
|
||||||
{/* App-initiated actions should not see warning messages about the need to complete the action during login. */}
|
{/* App-initiated actions should not see warning messages about the need to complete the action during login. */}
|
||||||
{displayMessage && message !== undefined && (message.type !== "warning" || !isAppInitiatedAction) && (
|
{displayMessage && message !== undefined && (message.type !== "warning" || !isAppInitiatedAction) && (
|
||||||
<div className={clsx("alert", `alert-${message.type}`)}>
|
<div
|
||||||
{message.type === "success" && <span className={getClassName("kcFeedbackSuccessIcon")}></span>}
|
className={clsx(
|
||||||
{message.type === "warning" && <span className={getClassName("kcFeedbackWarningIcon")}></span>}
|
`alert-${message.type}`,
|
||||||
{message.type === "error" && <span className={getClassName("kcFeedbackErrorIcon")}></span>}
|
getClassName("kcAlertClass"),
|
||||||
{message.type === "info" && <span className={getClassName("kcFeedbackInfoIcon")}></span>}
|
`pf-m-${message?.type === "error" ? "danger" : message.type}`
|
||||||
|
)}
|
||||||
|
>
|
||||||
|
<div className="pf-c-alert__icon">
|
||||||
|
{message.type === "success" && <span className={getClassName("kcFeedbackSuccessIcon")}></span>}
|
||||||
|
{message.type === "warning" && <span className={getClassName("kcFeedbackWarningIcon")}></span>}
|
||||||
|
{message.type === "error" && <span className={getClassName("kcFeedbackErrorIcon")}></span>}
|
||||||
|
{message.type === "info" && <span className={getClassName("kcFeedbackInfoIcon")}></span>}
|
||||||
|
</div>
|
||||||
<span
|
<span
|
||||||
className="kc-feedback-text"
|
className={getClassName("kcAlertTitleClass")}
|
||||||
dangerouslySetInnerHTML={{
|
dangerouslySetInnerHTML={{
|
||||||
"__html": message.summary
|
"__html": message.summary
|
||||||
}}
|
}}
|
||||||
@ -150,18 +259,9 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
{children}
|
{children}
|
||||||
{auth !== undefined && auth.showTryAnotherWayLink && showAnotherWayIfPresent && (
|
{auth !== undefined && auth.showTryAnotherWayLink && (
|
||||||
<form
|
<form id="kc-select-try-another-way-form" action={url.loginAction} method="post">
|
||||||
id="kc-select-try-another-way-form"
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
action={url.loginAction}
|
|
||||||
method="post"
|
|
||||||
className={clsx(displayWide && getClassName("kcContentWrapperClass"))}
|
|
||||||
>
|
|
||||||
<div
|
|
||||||
className={clsx(
|
|
||||||
displayWide && [getClassName("kcFormSocialAccountContentClass"), getClassName("kcFormSocialAccountClass")]
|
|
||||||
)}
|
|
||||||
>
|
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
<input type="hidden" name="tryAnotherWay" value="on" />
|
<input type="hidden" name="tryAnotherWay" value="on" />
|
||||||
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
|
{/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
|
||||||
@ -179,6 +279,7 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</div>
|
</div>
|
||||||
</form>
|
</form>
|
||||||
)}
|
)}
|
||||||
|
{socialProvidersNode}
|
||||||
{displayInfo && (
|
{displayInfo && (
|
||||||
<div id="kc-info" className={getClassName("kcSignUpClass")}>
|
<div id="kc-info" className={getClassName("kcSignUpClass")}>
|
||||||
<div id="kc-info-wrapper" className={getClassName("kcInfoAreaWrapperClass")}>
|
<div id="kc-info-wrapper" className={getClassName("kcInfoAreaWrapperClass")}>
|
||||||
|
@ -11,88 +11,139 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
displayInfo?: boolean;
|
displayInfo?: boolean;
|
||||||
displayMessage?: boolean;
|
displayMessage?: boolean;
|
||||||
displayRequiredFields?: boolean;
|
displayRequiredFields?: boolean;
|
||||||
displayWide?: boolean;
|
|
||||||
showAnotherWayIfPresent?: boolean;
|
showAnotherWayIfPresent?: boolean;
|
||||||
headerNode: ReactNode;
|
headerNode: ReactNode;
|
||||||
showUsernameNode?: ReactNode;
|
showUsernameNode?: ReactNode;
|
||||||
|
socialProvidersNode?: ReactNode;
|
||||||
infoNode?: ReactNode;
|
infoNode?: ReactNode;
|
||||||
|
documentTitle?: string;
|
||||||
|
bodyClassName?: string;
|
||||||
|
|
||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey =
|
export type ClassKey =
|
||||||
| "kcBodyClass"
|
| "kcBodyClass"
|
||||||
| "kcHtmlClass"
|
|
||||||
| "kcLoginClass"
|
|
||||||
| "kcHeaderClass"
|
|
||||||
| "kcHeaderWrapperClass"
|
| "kcHeaderWrapperClass"
|
||||||
| "kcFormCardClass"
|
|
||||||
| "kcFormCardAccountClass"
|
|
||||||
| "kcFormHeaderClass"
|
|
||||||
| "kcLocaleWrapperClass"
|
| "kcLocaleWrapperClass"
|
||||||
| "kcContentWrapperClass"
|
|
||||||
| "kcLabelWrapperClass"
|
|
||||||
| "kcFormGroupClass"
|
|
||||||
| "kcResetFlowIcon"
|
|
||||||
| "kcFeedbackSuccessIcon"
|
|
||||||
| "kcFeedbackWarningIcon"
|
|
||||||
| "kcFeedbackErrorIcon"
|
|
||||||
| "kcFeedbackInfoIcon"
|
|
||||||
| "kcFormSocialAccountContentClass"
|
|
||||||
| "kcFormSocialAccountClass"
|
|
||||||
| "kcSignUpClass"
|
|
||||||
| "kcInfoAreaWrapperClass"
|
| "kcInfoAreaWrapperClass"
|
||||||
| "kcLogoClass"
|
| "kcFormButtonsWrapperClass"
|
||||||
| "kcContainerClass"
|
|
||||||
| "kcContentClass"
|
|
||||||
| "kcFeedbackAreaClass"
|
|
||||||
| "kcLocaleClass"
|
|
||||||
| "kcAlertIconClasserror"
|
|
||||||
| "kcFormAreaClass"
|
|
||||||
| "kcFormSocialAccountListClass"
|
|
||||||
| "kcFormSocialAccountDoubleListClass"
|
|
||||||
| "kcFormSocialAccountListLinkClass"
|
|
||||||
| "kcWebAuthnKeyIcon"
|
|
||||||
| "kcWebAuthnDefaultIcon"
|
|
||||||
| "kcFormClass"
|
|
||||||
| "kcFormGroupErrorClass"
|
|
||||||
| "kcLabelClass"
|
|
||||||
| "kcInputClass"
|
|
||||||
| "kcInputErrorMessageClass"
|
|
||||||
| "kcInputWrapperClass"
|
|
||||||
| "kcFormOptionsClass"
|
|
||||||
| "kcFormButtonsClass"
|
|
||||||
| "kcFormSettingClass"
|
|
||||||
| "kcTextareaClass"
|
|
||||||
| "kcInfoAreaClass"
|
|
||||||
| "kcFormGroupHeader"
|
|
||||||
| "kcButtonClass"
|
|
||||||
| "kcButtonPrimaryClass"
|
|
||||||
| "kcButtonDefaultClass"
|
|
||||||
| "kcButtonLargeClass"
|
|
||||||
| "kcButtonBlockClass"
|
|
||||||
| "kcInputLargeClass"
|
|
||||||
| "kcSrOnlyClass"
|
|
||||||
| "kcSelectAuthListClass"
|
|
||||||
| "kcSelectAuthListItemClass"
|
|
||||||
| "kcSelectAuthListItemFillClass"
|
|
||||||
| "kcSelectAuthListItemInfoClass"
|
|
||||||
| "kcSelectAuthListItemLeftClass"
|
|
||||||
| "kcSelectAuthListItemBodyClass"
|
|
||||||
| "kcSelectAuthListItemDescriptionClass"
|
|
||||||
| "kcSelectAuthListItemHeadingClass"
|
|
||||||
| "kcSelectAuthListItemHelpTextClass"
|
|
||||||
| "kcSelectAuthListItemIconPropertyClass"
|
|
||||||
| "kcSelectAuthListItemIconClass"
|
|
||||||
| "kcSelectAuthListItemTitle"
|
|
||||||
| "kcAuthenticatorDefaultClass"
|
|
||||||
| "kcAuthenticatorPasswordClass"
|
|
||||||
| "kcAuthenticatorOTPClass"
|
|
||||||
| "kcAuthenticatorWebAuthnClass"
|
|
||||||
| "kcAuthenticatorWebAuthnPasswordlessClass"
|
|
||||||
| "kcSelectOTPListClass"
|
|
||||||
| "kcSelectOTPListItemClass"
|
|
||||||
| "kcAuthenticatorOtpCircleClass"
|
|
||||||
| "kcSelectOTPItemHeadingClass"
|
|
||||||
| "kcFormOptionsWrapperClass"
|
| "kcFormOptionsWrapperClass"
|
||||||
| "kcFormButtonsWrapperClass";
|
| "kcCheckboxInputClass"
|
||||||
|
| "kcLocaleDropDownClass"
|
||||||
|
| "kcLocaleListItemClass"
|
||||||
|
| "kcContentWrapperClass"
|
||||||
|
| "kcLogoIdP-facebook"
|
||||||
|
| "kcAuthenticatorOTPClass"
|
||||||
|
| "kcLogoIdP-bitbucket"
|
||||||
|
| "kcAuthenticatorWebAuthnClass"
|
||||||
|
| "kcWebAuthnDefaultIcon"
|
||||||
|
| "kcLogoIdP-stackoverflow"
|
||||||
|
| "kcSelectAuthListItemClass"
|
||||||
|
| "kcLogoIdP-microsoft"
|
||||||
|
| "kcLoginOTPListItemHeaderClass"
|
||||||
|
| "kcLocaleItemClass"
|
||||||
|
| "kcLoginOTPListItemIconBodyClass"
|
||||||
|
| "kcInputHelperTextAfterClass"
|
||||||
|
| "kcFormClass"
|
||||||
|
| "kcSelectAuthListClass"
|
||||||
|
| "kcInputClassRadioCheckboxLabelDisabled"
|
||||||
|
| "kcSelectAuthListItemIconClass"
|
||||||
|
| "kcRecoveryCodesWarning"
|
||||||
|
| "kcFormSettingClass"
|
||||||
|
| "kcWebAuthnBLE"
|
||||||
|
| "kcInputWrapperClass"
|
||||||
|
| "kcSelectAuthListItemArrowIconClass"
|
||||||
|
| "kcFeedbackAreaClass"
|
||||||
|
| "kcFormPasswordVisibilityButtonClass"
|
||||||
|
| "kcLogoIdP-google"
|
||||||
|
| "kcCheckLabelClass"
|
||||||
|
| "kcSelectAuthListItemFillClass"
|
||||||
|
| "kcAuthenticatorDefaultClass"
|
||||||
|
| "kcLogoIdP-gitlab"
|
||||||
|
| "kcFormAreaClass"
|
||||||
|
| "kcFormButtonsClass"
|
||||||
|
| "kcInputClassRadioLabel"
|
||||||
|
| "kcAuthenticatorWebAuthnPasswordlessClass"
|
||||||
|
| "kcSelectAuthListItemHeadingClass"
|
||||||
|
| "kcInfoAreaClass"
|
||||||
|
| "kcLogoLink"
|
||||||
|
| "kcContainerClass"
|
||||||
|
| "kcSelectAuthListItemTitle"
|
||||||
|
| "kcHtmlClass"
|
||||||
|
| "kcLoginOTPListItemTitleClass"
|
||||||
|
| "kcLogoIdP-openshift-v4"
|
||||||
|
| "kcWebAuthnUnknownIcon"
|
||||||
|
| "kcFormSocialAccountNameClass"
|
||||||
|
| "kcLogoIdP-openshift-v3"
|
||||||
|
| "kcLoginOTPListInputClass"
|
||||||
|
| "kcWebAuthnUSB"
|
||||||
|
| "kcInputClassRadio"
|
||||||
|
| "kcWebAuthnKeyIcon"
|
||||||
|
| "kcFeedbackInfoIcon"
|
||||||
|
| "kcCommonLogoIdP"
|
||||||
|
| "kcRecoveryCodesActions"
|
||||||
|
| "kcFormGroupHeader"
|
||||||
|
| "kcFormSocialAccountSectionClass"
|
||||||
|
| "kcLogoIdP-instagram"
|
||||||
|
| "kcAlertClass"
|
||||||
|
| "kcHeaderClass"
|
||||||
|
| "kcLabelWrapperClass"
|
||||||
|
| "kcFormPasswordVisibilityIconShow"
|
||||||
|
| "kcFormSocialAccountLinkClass"
|
||||||
|
| "kcLocaleMainClass"
|
||||||
|
| "kcInputGroup"
|
||||||
|
| "kcTextareaClass"
|
||||||
|
| "kcButtonBlockClass"
|
||||||
|
| "kcButtonClass"
|
||||||
|
| "kcWebAuthnNFC"
|
||||||
|
| "kcLocaleClass"
|
||||||
|
| "kcInputClassCheckboxInput"
|
||||||
|
| "kcFeedbackErrorIcon"
|
||||||
|
| "kcInputLargeClass"
|
||||||
|
| "kcInputErrorMessageClass"
|
||||||
|
| "kcRecoveryCodesList"
|
||||||
|
| "kcFormSocialAccountListClass"
|
||||||
|
| "kcAlertTitleClass"
|
||||||
|
| "kcAuthenticatorPasswordClass"
|
||||||
|
| "kcCheckInputClass"
|
||||||
|
| "kcLogoIdP-linkedin"
|
||||||
|
| "kcLogoIdP-twitter"
|
||||||
|
| "kcFeedbackWarningIcon"
|
||||||
|
| "kcResetFlowIcon"
|
||||||
|
| "kcSelectAuthListItemIconPropertyClass"
|
||||||
|
| "kcFeedbackSuccessIcon"
|
||||||
|
| "kcLoginOTPListClass"
|
||||||
|
| "kcSrOnlyClass"
|
||||||
|
| "kcFormSocialAccountListGridClass"
|
||||||
|
| "kcButtonDefaultClass"
|
||||||
|
| "kcFormGroupErrorClass"
|
||||||
|
| "kcSelectAuthListItemDescriptionClass"
|
||||||
|
| "kcSelectAuthListItemBodyClass"
|
||||||
|
| "kcWebAuthnInternal"
|
||||||
|
| "kcSelectAuthListItemArrowClass"
|
||||||
|
| "kcCheckClass"
|
||||||
|
| "kcContentClass"
|
||||||
|
| "kcLogoClass"
|
||||||
|
| "kcLoginOTPListItemIconClass"
|
||||||
|
| "kcLoginClass"
|
||||||
|
| "kcSignUpClass"
|
||||||
|
| "kcButtonLargeClass"
|
||||||
|
| "kcFormCardClass"
|
||||||
|
| "kcLocaleListClass"
|
||||||
|
| "kcInputClass"
|
||||||
|
| "kcFormGroupClass"
|
||||||
|
| "kcLogoIdP-paypal"
|
||||||
|
| "kcInputClassCheckbox"
|
||||||
|
| "kcRecoveryCodesConfirmation"
|
||||||
|
| "kcFormPasswordVisibilityIconHide"
|
||||||
|
| "kcInputClassRadioInput"
|
||||||
|
| "kcFormSocialAccountListButtonClass"
|
||||||
|
| "kcInputClassCheckboxLabel"
|
||||||
|
| "kcFormOptionsClass"
|
||||||
|
| "kcFormHeaderClass"
|
||||||
|
| "kcFormSocialAccountGridItem"
|
||||||
|
| "kcButtonPrimaryClass"
|
||||||
|
| "kcInputHelperTextBeforeClass"
|
||||||
|
| "kcLogoIdP-github"
|
||||||
|
| "kcLabelClass";
|
||||||
|
750
src/login/UserProfileFormFields.tsx
Normal file
750
src/login/UserProfileFormFields.tsx
Normal file
@ -0,0 +1,750 @@
|
|||||||
|
import { useEffect, useReducer, Fragment } from "react";
|
||||||
|
import type { ClassKey } from "keycloakify/login/TemplateProps";
|
||||||
|
import { useUserProfileForm, type KcContextLike, type FormAction, type FormFieldError } from "keycloakify/login/lib/useUserProfileForm";
|
||||||
|
import type { Attribute } from "keycloakify/login/kcContext/KcContext";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { I18n } from "./i18n";
|
||||||
|
|
||||||
|
export type UserProfileFormFieldsProps = {
|
||||||
|
kcContext: KcContextLike;
|
||||||
|
i18n: I18n;
|
||||||
|
getClassName: (classKey: ClassKey) => string;
|
||||||
|
onIsFormSubmittableValueChange: (isFormSubmittable: boolean) => void;
|
||||||
|
BeforeField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
|
||||||
|
AfterField?: (props: BeforeAfterFieldProps) => JSX.Element | null;
|
||||||
|
};
|
||||||
|
|
||||||
|
type BeforeAfterFieldProps = {
|
||||||
|
attribute: Attribute;
|
||||||
|
dispatchFormAction: React.Dispatch<FormAction>;
|
||||||
|
displayableErrors: FormFieldError[];
|
||||||
|
i18n: I18n;
|
||||||
|
valueOrValues: string | string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
// NOTE: Enabled by default but it's a UX best practice to set it to false.
|
||||||
|
const doMakeUserConfirmPassword = true;
|
||||||
|
|
||||||
|
export default function UserProfileFormFields(props: UserProfileFormFieldsProps) {
|
||||||
|
const { kcContext, onIsFormSubmittableValueChange, i18n, getClassName, BeforeField, AfterField } = props;
|
||||||
|
|
||||||
|
const { advancedMsg } = i18n;
|
||||||
|
|
||||||
|
const {
|
||||||
|
formState: { formFieldStates, isFormSubmittable },
|
||||||
|
dispatchFormAction
|
||||||
|
} = useUserProfileForm({
|
||||||
|
kcContext,
|
||||||
|
i18n,
|
||||||
|
doMakeUserConfirmPassword
|
||||||
|
});
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
onIsFormSubmittableValueChange(isFormSubmittable);
|
||||||
|
}, [isFormSubmittable]);
|
||||||
|
|
||||||
|
const groupNameRef = { "current": "" };
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
{formFieldStates.map(({ attribute, displayableErrors, valueOrValues }) => {
|
||||||
|
return (
|
||||||
|
<Fragment key={attribute.name}>
|
||||||
|
<GroupLabel attribute={attribute} getClassName={getClassName} i18n={i18n} groupNameRef={groupNameRef} />
|
||||||
|
{BeforeField !== undefined && (
|
||||||
|
<BeforeField
|
||||||
|
attribute={attribute}
|
||||||
|
dispatchFormAction={dispatchFormAction}
|
||||||
|
displayableErrors={displayableErrors}
|
||||||
|
i18n={i18n}
|
||||||
|
valueOrValues={valueOrValues}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
<div
|
||||||
|
className={getClassName("kcFormGroupClass")}
|
||||||
|
style={{ "display": attribute.name === "password-confirm" && !doMakeUserConfirmPassword ? "none" : undefined }}
|
||||||
|
>
|
||||||
|
<div className={getClassName("kcLabelWrapperClass")}>
|
||||||
|
<label htmlFor={attribute.name} className={getClassName("kcLabelClass")}>
|
||||||
|
{advancedMsg(attribute.displayName ?? "")}
|
||||||
|
</label>
|
||||||
|
{attribute.required && <>*</>}
|
||||||
|
</div>
|
||||||
|
<div className={getClassName("kcInputWrapperClass")}>
|
||||||
|
{attribute.annotations.inputHelperTextBefore !== undefined && (
|
||||||
|
<div
|
||||||
|
className={getClassName("kcInputHelperTextBeforeClass")}
|
||||||
|
id={`form-help-text-before-${attribute.name}`}
|
||||||
|
aria-live="polite"
|
||||||
|
>
|
||||||
|
{advancedMsg(attribute.annotations.inputHelperTextBefore)}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
<InputFiledByType
|
||||||
|
attribute={attribute}
|
||||||
|
valueOrValues={valueOrValues}
|
||||||
|
displayableErrors={displayableErrors}
|
||||||
|
formValidationDispatch={dispatchFormAction}
|
||||||
|
getClassName={getClassName}
|
||||||
|
i18n={i18n}
|
||||||
|
/>
|
||||||
|
<FieldErrors
|
||||||
|
attribute={attribute}
|
||||||
|
getClassName={getClassName}
|
||||||
|
displayableErrors={displayableErrors}
|
||||||
|
fieldIndex={undefined}
|
||||||
|
/>
|
||||||
|
{attribute.annotations.inputHelperTextAfter !== undefined && (
|
||||||
|
<div
|
||||||
|
className={getClassName("kcInputHelperTextAfterClass")}
|
||||||
|
id={`form-help-text-after-${attribute.name}`}
|
||||||
|
aria-live="polite"
|
||||||
|
>
|
||||||
|
{advancedMsg(attribute.annotations.inputHelperTextAfter)}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
|
||||||
|
{AfterField !== undefined && (
|
||||||
|
<AfterField
|
||||||
|
attribute={attribute}
|
||||||
|
dispatchFormAction={dispatchFormAction}
|
||||||
|
displayableErrors={displayableErrors}
|
||||||
|
i18n={i18n}
|
||||||
|
valueOrValues={valueOrValues}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
{/* NOTE: Downloading of html5DataAnnotations scripts is done in the useUserProfileForm hook */}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</Fragment>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function GroupLabel(props: {
|
||||||
|
attribute: Attribute;
|
||||||
|
getClassName: UserProfileFormFieldsProps["getClassName"];
|
||||||
|
i18n: I18n;
|
||||||
|
groupNameRef: {
|
||||||
|
current: string;
|
||||||
|
};
|
||||||
|
}) {
|
||||||
|
const { attribute, getClassName, i18n, groupNameRef } = props;
|
||||||
|
|
||||||
|
const { advancedMsg } = i18n;
|
||||||
|
|
||||||
|
if (attribute.group?.name !== groupNameRef.current) {
|
||||||
|
groupNameRef.current = attribute.group?.name ?? "";
|
||||||
|
|
||||||
|
if (groupNameRef.current !== "") {
|
||||||
|
assert(attribute.group !== undefined);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={getClassName("kcFormGroupClass")}
|
||||||
|
{...Object.fromEntries(Object.entries(attribute.group.html5DataAnnotations).map(([key, value]) => [`data-${key}`, value]))}
|
||||||
|
>
|
||||||
|
{(() => {
|
||||||
|
const groupDisplayHeader = attribute.group.displayHeader ?? "";
|
||||||
|
const groupHeaderText = groupDisplayHeader !== "" ? advancedMsg(groupDisplayHeader) : attribute.group.name;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className={getClassName("kcContentWrapperClass")}>
|
||||||
|
<label id={`header-${attribute.group.name}`} className={getClassName("kcFormGroupHeader")}>
|
||||||
|
{groupHeaderText}
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
})()}
|
||||||
|
{(() => {
|
||||||
|
const groupDisplayDescription = attribute.group.displayDescription ?? "";
|
||||||
|
|
||||||
|
if (groupDisplayDescription !== "") {
|
||||||
|
const groupDescriptionText = advancedMsg(groupDisplayDescription);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className={getClassName("kcLabelWrapperClass")}>
|
||||||
|
<label id={`description-${attribute.group.name}`} className={getClassName("kcLabelClass")}>
|
||||||
|
{groupDescriptionText}
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
})()}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function FieldErrors(props: {
|
||||||
|
attribute: Attribute;
|
||||||
|
getClassName: UserProfileFormFieldsProps["getClassName"];
|
||||||
|
displayableErrors: FormFieldError[];
|
||||||
|
fieldIndex: number | undefined;
|
||||||
|
}) {
|
||||||
|
const { attribute, getClassName, fieldIndex } = props;
|
||||||
|
|
||||||
|
const displayableErrors = props.displayableErrors.filter(error => error.fieldIndex === fieldIndex);
|
||||||
|
|
||||||
|
if (displayableErrors.length === 0) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<span
|
||||||
|
id={`input-error-${attribute.name}${fieldIndex === undefined ? "" : `-${fieldIndex}`}`}
|
||||||
|
className={getClassName("kcInputErrorMessageClass")}
|
||||||
|
style={{
|
||||||
|
"position": displayableErrors.length === 1 ? "absolute" : undefined
|
||||||
|
}}
|
||||||
|
aria-live="polite"
|
||||||
|
>
|
||||||
|
{displayableErrors
|
||||||
|
.filter(error => error.fieldIndex === fieldIndex)
|
||||||
|
.map(({ errorMessage }, i, arr) => (
|
||||||
|
<>
|
||||||
|
<span key={i}>{errorMessage}</span>
|
||||||
|
{arr.length - 1 !== i && <br />}
|
||||||
|
</>
|
||||||
|
))}
|
||||||
|
</span>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
type InputFiledByTypeProps = {
|
||||||
|
attribute: Attribute;
|
||||||
|
valueOrValues: string | string[];
|
||||||
|
displayableErrors: FormFieldError[];
|
||||||
|
formValidationDispatch: React.Dispatch<FormAction>;
|
||||||
|
getClassName: UserProfileFormFieldsProps["getClassName"];
|
||||||
|
i18n: I18n;
|
||||||
|
};
|
||||||
|
|
||||||
|
function InputFiledByType(props: InputFiledByTypeProps) {
|
||||||
|
const { attribute, valueOrValues } = props;
|
||||||
|
|
||||||
|
switch (attribute.annotations.inputType) {
|
||||||
|
case "textarea":
|
||||||
|
return <TextareaTag {...props} />;
|
||||||
|
case "select":
|
||||||
|
case "multiselect":
|
||||||
|
return <SelectTag {...props} />;
|
||||||
|
case "select-radiobuttons":
|
||||||
|
case "multiselect-checkboxes":
|
||||||
|
return <InputTagSelects {...props} />;
|
||||||
|
default: {
|
||||||
|
if (valueOrValues instanceof Array) {
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
{valueOrValues.map((...[, i]) => (
|
||||||
|
<InputTag key={i} {...props} fieldIndex={i} />
|
||||||
|
))}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const inputNode = <InputTag {...props} fieldIndex={undefined} />;
|
||||||
|
|
||||||
|
if (attribute.name === "password" || attribute.name === "password-confirm") {
|
||||||
|
return (
|
||||||
|
<PasswordWrapper getClassName={props.getClassName} i18n={props.i18n} passwordInputId={attribute.name}>
|
||||||
|
{inputNode}
|
||||||
|
</PasswordWrapper>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return inputNode;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function PasswordWrapper(props: { getClassName: (classKey: ClassKey) => string; i18n: I18n; passwordInputId: string; children: JSX.Element }) {
|
||||||
|
const { getClassName, i18n, passwordInputId, children } = props;
|
||||||
|
|
||||||
|
const { msgStr } = i18n;
|
||||||
|
|
||||||
|
const [isPasswordRevealed, toggleIsPasswordRevealed] = useReducer((isPasswordRevealed: boolean) => !isPasswordRevealed, false);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
const passwordInputElement = document.getElementById(passwordInputId);
|
||||||
|
|
||||||
|
assert(passwordInputElement instanceof HTMLInputElement);
|
||||||
|
|
||||||
|
passwordInputElement.type = isPasswordRevealed ? "text" : "password";
|
||||||
|
}, [isPasswordRevealed]);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className={getClassName("kcInputGroup")}>
|
||||||
|
{children}
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={getClassName("kcFormPasswordVisibilityButtonClass")}
|
||||||
|
aria-label={msgStr(isPasswordRevealed ? "hidePassword" : "showPassword")}
|
||||||
|
aria-controls={passwordInputId}
|
||||||
|
onClick={toggleIsPasswordRevealed}
|
||||||
|
>
|
||||||
|
<i
|
||||||
|
className={getClassName(isPasswordRevealed ? "kcFormPasswordVisibilityIconHide" : "kcFormPasswordVisibilityIconShow")}
|
||||||
|
aria-hidden
|
||||||
|
/>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function InputTag(props: InputFiledByTypeProps & { fieldIndex: number | undefined }) {
|
||||||
|
const { attribute, fieldIndex, getClassName, formValidationDispatch, valueOrValues, i18n, displayableErrors } = props;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<input
|
||||||
|
type={(() => {
|
||||||
|
const { inputType } = attribute.annotations;
|
||||||
|
|
||||||
|
if (inputType?.startsWith("html5-")) {
|
||||||
|
return inputType.slice(6);
|
||||||
|
}
|
||||||
|
|
||||||
|
return inputType ?? "text";
|
||||||
|
})()}
|
||||||
|
id={attribute.name}
|
||||||
|
name={attribute.name}
|
||||||
|
value={(() => {
|
||||||
|
if (fieldIndex !== undefined) {
|
||||||
|
assert(valueOrValues instanceof Array);
|
||||||
|
return valueOrValues[fieldIndex];
|
||||||
|
}
|
||||||
|
|
||||||
|
assert(typeof valueOrValues === "string");
|
||||||
|
|
||||||
|
return valueOrValues;
|
||||||
|
})()}
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
aria-invalid={displayableErrors.find(error => error.fieldIndex === fieldIndex) !== undefined}
|
||||||
|
disabled={attribute.readOnly}
|
||||||
|
autoComplete={attribute.autocomplete}
|
||||||
|
placeholder={attribute.annotations.inputTypePlaceholder}
|
||||||
|
pattern={attribute.annotations.inputTypePattern}
|
||||||
|
size={attribute.annotations.inputTypeSize === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeSize}`)}
|
||||||
|
maxLength={
|
||||||
|
attribute.annotations.inputTypeMaxlength === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeMaxlength}`)
|
||||||
|
}
|
||||||
|
minLength={
|
||||||
|
attribute.annotations.inputTypeMinlength === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeMinlength}`)
|
||||||
|
}
|
||||||
|
max={attribute.annotations.inputTypeMax}
|
||||||
|
min={attribute.annotations.inputTypeMin}
|
||||||
|
step={attribute.annotations.inputTypeStep}
|
||||||
|
{...Object.fromEntries(Object.entries(attribute.html5DataAnnotations ?? {}).map(([key, value]) => [`data-${key}`, value]))}
|
||||||
|
onChange={event =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "update",
|
||||||
|
"name": attribute.name,
|
||||||
|
"valueOrValues": (() => {
|
||||||
|
if (fieldIndex !== undefined) {
|
||||||
|
assert(valueOrValues instanceof Array);
|
||||||
|
|
||||||
|
return valueOrValues.map((value, i) => {
|
||||||
|
if (i === fieldIndex) {
|
||||||
|
return event.target.value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return value;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return event.target.value;
|
||||||
|
})()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
onBlur={() =>
|
||||||
|
props.formValidationDispatch({
|
||||||
|
"action": "focus lost",
|
||||||
|
"name": attribute.name,
|
||||||
|
"fieldIndex": fieldIndex
|
||||||
|
})
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
{(() => {
|
||||||
|
if (fieldIndex === undefined) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
assert(valueOrValues instanceof Array);
|
||||||
|
|
||||||
|
const values = valueOrValues;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<FieldErrors
|
||||||
|
attribute={attribute}
|
||||||
|
getClassName={getClassName}
|
||||||
|
displayableErrors={displayableErrors}
|
||||||
|
fieldIndex={fieldIndex}
|
||||||
|
/>
|
||||||
|
<AddRemoveButtonsMultiValuedAttribute
|
||||||
|
attribute={attribute}
|
||||||
|
values={values}
|
||||||
|
fieldIndex={fieldIndex}
|
||||||
|
dispatchFormAction={formValidationDispatch}
|
||||||
|
i18n={i18n}
|
||||||
|
/>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
})()}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function AddRemoveButtonsMultiValuedAttribute(props: {
|
||||||
|
attribute: Attribute;
|
||||||
|
values: string[];
|
||||||
|
fieldIndex: number;
|
||||||
|
dispatchFormAction: React.Dispatch<Extract<FormAction, { action: "update" }>>;
|
||||||
|
i18n: I18n;
|
||||||
|
}) {
|
||||||
|
const { attribute, values, fieldIndex, dispatchFormAction, i18n } = props;
|
||||||
|
|
||||||
|
const { msg } = i18n;
|
||||||
|
|
||||||
|
const hasRemove = (() => {
|
||||||
|
if (values.length === 1) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const minCount = (() => {
|
||||||
|
const { multivalued } = attribute.validators;
|
||||||
|
|
||||||
|
if (multivalued === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const minStr = multivalued.min;
|
||||||
|
|
||||||
|
if (minStr === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseInt(`${minStr}`);
|
||||||
|
})();
|
||||||
|
|
||||||
|
if (minCount === undefined) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (values.length === minCount) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
})();
|
||||||
|
|
||||||
|
const hasAdd = (() => {
|
||||||
|
if (fieldIndex + 1 !== values.length) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const maxCount = (() => {
|
||||||
|
const { multivalued } = attribute.validators;
|
||||||
|
|
||||||
|
if (multivalued === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const maxStr = multivalued.max;
|
||||||
|
|
||||||
|
if (maxStr === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return parseInt(`${maxStr}`);
|
||||||
|
})();
|
||||||
|
|
||||||
|
if (maxCount === undefined) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (values.length === maxCount) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
})();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
{hasRemove && (
|
||||||
|
<button
|
||||||
|
id={`kc-remove-${attribute.name}-${fieldIndex + 1}`}
|
||||||
|
type="button"
|
||||||
|
className="pf-c-button pf-m-inline pf-m-link"
|
||||||
|
onClick={() =>
|
||||||
|
dispatchFormAction({
|
||||||
|
"action": "update",
|
||||||
|
"name": attribute.name,
|
||||||
|
"valueOrValues": values.filter((_, i) => i !== fieldIndex)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{msg("remove")}
|
||||||
|
{hasRemove ? <> | </> : null}
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
{hasAdd && (
|
||||||
|
<button
|
||||||
|
id="kc-add-titles-1"
|
||||||
|
type="button"
|
||||||
|
className="pf-c-button pf-m-inline pf-m-link"
|
||||||
|
onClick={() =>
|
||||||
|
dispatchFormAction({
|
||||||
|
"action": "update",
|
||||||
|
"name": attribute.name,
|
||||||
|
"valueOrValues": [...values, ""]
|
||||||
|
})
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{msg("addValue")}
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function InputTagSelects(props: InputFiledByTypeProps) {
|
||||||
|
const { attribute, formValidationDispatch, getClassName, valueOrValues } = props;
|
||||||
|
|
||||||
|
const { advancedMsg } = props.i18n;
|
||||||
|
|
||||||
|
const { classDiv, classInput, classLabel, inputType } = (() => {
|
||||||
|
const { inputType } = attribute.annotations;
|
||||||
|
|
||||||
|
assert(inputType === "select-radiobuttons" || inputType === "multiselect-checkboxes");
|
||||||
|
|
||||||
|
switch (inputType) {
|
||||||
|
case "select-radiobuttons":
|
||||||
|
return {
|
||||||
|
"inputType": "radio",
|
||||||
|
"classDiv": getClassName("kcInputClassRadio"),
|
||||||
|
"classInput": getClassName("kcInputClassRadioInput"),
|
||||||
|
"classLabel": getClassName("kcInputClassRadioLabel")
|
||||||
|
};
|
||||||
|
case "multiselect-checkboxes":
|
||||||
|
return {
|
||||||
|
"inputType": "checkbox",
|
||||||
|
"classDiv": getClassName("kcInputClassCheckbox"),
|
||||||
|
"classInput": getClassName("kcInputClassCheckboxInput"),
|
||||||
|
"classLabel": getClassName("kcInputClassCheckboxLabel")
|
||||||
|
};
|
||||||
|
}
|
||||||
|
})();
|
||||||
|
|
||||||
|
const options = (() => {
|
||||||
|
walk: {
|
||||||
|
const { inputOptionsFromValidation } = attribute.annotations;
|
||||||
|
|
||||||
|
if (inputOptionsFromValidation === undefined) {
|
||||||
|
break walk;
|
||||||
|
}
|
||||||
|
|
||||||
|
const validator = (attribute.validators as Record<string, { options?: string[] }>)[inputOptionsFromValidation];
|
||||||
|
|
||||||
|
if (validator === undefined) {
|
||||||
|
break walk;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (validator.options === undefined) {
|
||||||
|
break walk;
|
||||||
|
}
|
||||||
|
|
||||||
|
return validator.options;
|
||||||
|
}
|
||||||
|
|
||||||
|
return attribute.validators.options?.options ?? [];
|
||||||
|
})();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
{options.map(option => (
|
||||||
|
<div key={option} className={classDiv}>
|
||||||
|
<input
|
||||||
|
type={inputType}
|
||||||
|
id={`${attribute.name}-${option}`}
|
||||||
|
name={attribute.name}
|
||||||
|
value={option}
|
||||||
|
className={classInput}
|
||||||
|
aria-invalid={props.displayableErrors.length !== 0}
|
||||||
|
disabled={attribute.readOnly}
|
||||||
|
checked={valueOrValues.includes(option)}
|
||||||
|
onChange={event =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "update",
|
||||||
|
"name": attribute.name,
|
||||||
|
"valueOrValues": (() => {
|
||||||
|
const isChecked = event.target.checked;
|
||||||
|
|
||||||
|
if (valueOrValues instanceof Array) {
|
||||||
|
const newValues = [...valueOrValues];
|
||||||
|
|
||||||
|
if (isChecked) {
|
||||||
|
newValues.push(option);
|
||||||
|
} else {
|
||||||
|
newValues.splice(newValues.indexOf(option), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
return newValues;
|
||||||
|
}
|
||||||
|
|
||||||
|
return event.target.checked ? option : "";
|
||||||
|
})()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
onBlur={() =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "focus lost",
|
||||||
|
"name": attribute.name,
|
||||||
|
"fieldIndex": undefined
|
||||||
|
})
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
<label
|
||||||
|
htmlFor={`${attribute.name}-${option}`}
|
||||||
|
className={`${classLabel}${attribute.readOnly ? ` ${getClassName("kcInputClassRadioCheckboxLabelDisabled")}` : ""}`}
|
||||||
|
>
|
||||||
|
{advancedMsg(option)}
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TextareaTag(props: InputFiledByTypeProps) {
|
||||||
|
const { attribute, formValidationDispatch, getClassName, displayableErrors, valueOrValues } = props;
|
||||||
|
|
||||||
|
assert(typeof valueOrValues === "string");
|
||||||
|
|
||||||
|
const value = valueOrValues;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<textarea
|
||||||
|
id={attribute.name}
|
||||||
|
name={attribute.name}
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
aria-invalid={displayableErrors.length !== 0}
|
||||||
|
disabled={attribute.readOnly}
|
||||||
|
cols={attribute.annotations.inputTypeCols === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeCols}`)}
|
||||||
|
rows={attribute.annotations.inputTypeRows === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeRows}`)}
|
||||||
|
maxLength={attribute.annotations.inputTypeMaxlength === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeMaxlength}`)}
|
||||||
|
value={value}
|
||||||
|
onChange={event =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "update",
|
||||||
|
"name": attribute.name,
|
||||||
|
"valueOrValues": event.target.value
|
||||||
|
})
|
||||||
|
}
|
||||||
|
onBlur={() =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "focus lost",
|
||||||
|
"name": attribute.name,
|
||||||
|
"fieldIndex": undefined
|
||||||
|
})
|
||||||
|
}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function SelectTag(props: InputFiledByTypeProps) {
|
||||||
|
const { attribute, formValidationDispatch, getClassName, displayableErrors, i18n, valueOrValues } = props;
|
||||||
|
|
||||||
|
const { advancedMsg } = i18n;
|
||||||
|
|
||||||
|
const isMultiple = attribute.annotations.inputType === "multiselect";
|
||||||
|
|
||||||
|
return (
|
||||||
|
<select
|
||||||
|
id={attribute.name}
|
||||||
|
name={attribute.name}
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
aria-invalid={displayableErrors.length !== 0}
|
||||||
|
disabled={attribute.readOnly}
|
||||||
|
multiple={isMultiple}
|
||||||
|
size={attribute.annotations.inputTypeSize === undefined ? undefined : parseInt(`${attribute.annotations.inputTypeSize}`)}
|
||||||
|
value={valueOrValues}
|
||||||
|
onChange={event =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "update",
|
||||||
|
"name": attribute.name,
|
||||||
|
"valueOrValues": (() => {
|
||||||
|
if (isMultiple) {
|
||||||
|
return Array.from(event.target.selectedOptions).map(option => option.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
return event.target.value;
|
||||||
|
})()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
onBlur={() =>
|
||||||
|
formValidationDispatch({
|
||||||
|
"action": "focus lost",
|
||||||
|
"name": attribute.name,
|
||||||
|
"fieldIndex": undefined
|
||||||
|
})
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{!isMultiple && <option value=""></option>}
|
||||||
|
{(() => {
|
||||||
|
const options = (() => {
|
||||||
|
walk: {
|
||||||
|
const { inputOptionsFromValidation } = attribute.annotations;
|
||||||
|
|
||||||
|
assert(typeof inputOptionsFromValidation === "string");
|
||||||
|
|
||||||
|
if (inputOptionsFromValidation === undefined) {
|
||||||
|
break walk;
|
||||||
|
}
|
||||||
|
|
||||||
|
const validator = (attribute.validators as Record<string, { options?: string[] }>)[inputOptionsFromValidation];
|
||||||
|
|
||||||
|
if (validator === undefined) {
|
||||||
|
break walk;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (validator.options === undefined) {
|
||||||
|
break walk;
|
||||||
|
}
|
||||||
|
|
||||||
|
return validator.options;
|
||||||
|
}
|
||||||
|
|
||||||
|
return attribute.validators.options?.options ?? [];
|
||||||
|
})();
|
||||||
|
|
||||||
|
return options.map(option => (
|
||||||
|
<option key={option} value={option}>
|
||||||
|
{(() => {
|
||||||
|
if (attribute.annotations.inputOptionLabels !== undefined) {
|
||||||
|
const { inputOptionLabels } = attribute.annotations;
|
||||||
|
|
||||||
|
return advancedMsg(inputOptionLabels[option] ?? option);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (attribute.annotations.inputOptionLabelsI18nPrefix !== undefined) {
|
||||||
|
return advancedMsg(`${attribute.annotations.inputOptionLabelsI18nPrefix}.${option}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return option;
|
||||||
|
})()}
|
||||||
|
</option>
|
||||||
|
));
|
||||||
|
})()}
|
||||||
|
</select>
|
||||||
|
);
|
||||||
|
}
|
@ -212,7 +212,9 @@ const keycloakifyExtraMessages = {
|
|||||||
"shouldMatchPattern": "Pattern should match: `/{0}/`",
|
"shouldMatchPattern": "Pattern should match: `/{0}/`",
|
||||||
"mustBeAnInteger": "Must be an integer",
|
"mustBeAnInteger": "Must be an integer",
|
||||||
"notAValidOption": "Not a valid option",
|
"notAValidOption": "Not a valid option",
|
||||||
"selectAnOption": "Select an option"
|
"selectAnOption": "Select an option",
|
||||||
|
"remove": "Remove",
|
||||||
|
"addValue": "Add value"
|
||||||
},
|
},
|
||||||
"fr": {
|
"fr": {
|
||||||
/* spell-checker: disable */
|
/* spell-checker: disable */
|
||||||
@ -225,7 +227,9 @@ const keycloakifyExtraMessages = {
|
|||||||
"logoutConfirmTitle": "Déconnexion",
|
"logoutConfirmTitle": "Déconnexion",
|
||||||
"logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
|
"logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
|
||||||
"doLogout": "Se déconnecter",
|
"doLogout": "Se déconnecter",
|
||||||
"selectAnOption": "Sélectionner une option"
|
"selectAnOption": "Sélectionner une option",
|
||||||
|
"remove": "Supprimer",
|
||||||
|
"addValue": "Ajouter une valeur"
|
||||||
/* spell-checker: enable */
|
/* spell-checker: enable */
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -13,7 +13,6 @@ type ExtractAfterStartingWith<Prefix extends string, StrEnum> = StrEnum extends
|
|||||||
export type KcContext =
|
export type KcContext =
|
||||||
| KcContext.Login
|
| KcContext.Login
|
||||||
| KcContext.Register
|
| KcContext.Register
|
||||||
| KcContext.RegisterUserProfile
|
|
||||||
| KcContext.Info
|
| KcContext.Info
|
||||||
| KcContext.Error
|
| KcContext.Error
|
||||||
| KcContext.LoginResetPassword
|
| KcContext.LoginResetPassword
|
||||||
@ -24,6 +23,7 @@ export type KcContext =
|
|||||||
| KcContext.LoginOtp
|
| KcContext.LoginOtp
|
||||||
| KcContext.LoginUsername
|
| KcContext.LoginUsername
|
||||||
| KcContext.WebauthnAuthenticate
|
| KcContext.WebauthnAuthenticate
|
||||||
|
| KcContext.WebauthnRegister
|
||||||
| KcContext.LoginPassword
|
| KcContext.LoginPassword
|
||||||
| KcContext.LoginUpdatePassword
|
| KcContext.LoginUpdatePassword
|
||||||
| KcContext.LoginUpdateProfile
|
| KcContext.LoginUpdateProfile
|
||||||
@ -32,11 +32,21 @@ export type KcContext =
|
|||||||
| KcContext.LoginPageExpired
|
| KcContext.LoginPageExpired
|
||||||
| KcContext.LoginConfigTotp
|
| KcContext.LoginConfigTotp
|
||||||
| KcContext.LogoutConfirm
|
| KcContext.LogoutConfirm
|
||||||
| KcContext.UpdateUserProfile
|
|
||||||
| KcContext.IdpReviewUserProfile
|
| KcContext.IdpReviewUserProfile
|
||||||
| KcContext.UpdateEmail
|
| KcContext.UpdateEmail
|
||||||
| KcContext.SelectAuthenticator
|
| KcContext.SelectAuthenticator
|
||||||
| KcContext.SamlPostForm;
|
| KcContext.SamlPostForm
|
||||||
|
| KcContext.DeleteCredential
|
||||||
|
| KcContext.Code
|
||||||
|
| KcContext.DeleteAccountConfirm
|
||||||
|
| KcContext.FrontchannelLogout
|
||||||
|
| KcContext.LoginRecoveryAuthnCodeConfig
|
||||||
|
| KcContext.LoginRecoveryAuthnCodeInput
|
||||||
|
| KcContext.LoginResetOtp
|
||||||
|
| KcContext.LoginX509Info
|
||||||
|
| KcContext.WebauthnError;
|
||||||
|
|
||||||
|
assert<KcContext["themeType"] extends ThemeType ? true : false>();
|
||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
@ -50,6 +60,7 @@ export declare namespace KcContext {
|
|||||||
resourcesCommonPath: string;
|
resourcesCommonPath: string;
|
||||||
loginRestartFlowUrl: string;
|
loginRestartFlowUrl: string;
|
||||||
loginUrl: string;
|
loginUrl: string;
|
||||||
|
ssoLoginInOtherTabsUrl: string;
|
||||||
};
|
};
|
||||||
realm: {
|
realm: {
|
||||||
name: string;
|
name: string;
|
||||||
@ -84,7 +95,7 @@ export declare namespace KcContext {
|
|||||||
description?: string;
|
description?: string;
|
||||||
attributes: Record<string, string>;
|
attributes: Record<string, string>;
|
||||||
};
|
};
|
||||||
isAppInitiatedAction: boolean;
|
isAppInitiatedAction?: boolean;
|
||||||
messagesPerField: {
|
messagesPerField: {
|
||||||
/**
|
/**
|
||||||
* Return text if message for given field exists. Useful eg. to add css styles for fields with message.
|
* Return text if message for given field exists. Useful eg. to add css styles for fields with message.
|
||||||
@ -100,7 +111,7 @@ export declare namespace KcContext {
|
|||||||
* @param fields
|
* @param fields
|
||||||
* @return boolean
|
* @return boolean
|
||||||
*/
|
*/
|
||||||
existsError: (fieldName: string) => boolean;
|
existsError: (fieldName: string, ...otherFiledNames: string[]) => boolean;
|
||||||
/**
|
/**
|
||||||
* Get message for given field.
|
* Get message for given field.
|
||||||
*
|
*
|
||||||
@ -115,6 +126,14 @@ export declare namespace KcContext {
|
|||||||
* @return boolean
|
* @return boolean
|
||||||
*/
|
*/
|
||||||
exists: (fieldName: string) => boolean;
|
exists: (fieldName: string) => boolean;
|
||||||
|
|
||||||
|
getFirstError: (...fieldNames: string[]) => string;
|
||||||
|
};
|
||||||
|
properties: Record<string, string | undefined>;
|
||||||
|
authenticationSession?: {
|
||||||
|
authSessionId: string;
|
||||||
|
tabId: string;
|
||||||
|
ssoLoginInOtherTabsUrl: string;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -147,7 +166,7 @@ export declare namespace KcContext {
|
|||||||
registrationDisabled: boolean;
|
registrationDisabled: boolean;
|
||||||
login: {
|
login: {
|
||||||
username?: string;
|
username?: string;
|
||||||
rememberMe?: string;
|
rememberMe?: string; // "on" | undefined
|
||||||
password?: string;
|
password?: string;
|
||||||
};
|
};
|
||||||
usernameHidden?: boolean;
|
usernameHidden?: boolean;
|
||||||
@ -158,52 +177,28 @@ export declare namespace KcContext {
|
|||||||
alias: string;
|
alias: string;
|
||||||
providerId: string;
|
providerId: string;
|
||||||
displayName: string;
|
displayName: string;
|
||||||
|
iconClasses?: string;
|
||||||
}[];
|
}[];
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export type Register = RegisterUserProfile.CommonWithLegacy & {
|
export type Register = Common & {
|
||||||
pageId: "register.ftl";
|
pageId: "register.ftl";
|
||||||
register: {
|
profile: UserProfile;
|
||||||
formData: {
|
url: {
|
||||||
firstName?: string;
|
registrationAction: string;
|
||||||
displayName?: string;
|
|
||||||
lastName?: string;
|
|
||||||
email?: string;
|
|
||||||
username?: string;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
passwordRequired: boolean;
|
||||||
|
recaptchaRequired: boolean;
|
||||||
|
recaptchaSiteKey?: string;
|
||||||
|
/**
|
||||||
|
* Theses values are added by: https://github.com/jcputney/keycloak-theme-additional-info-extension
|
||||||
|
* A Keycloak Java extension used as dependency in Keycloakify.
|
||||||
|
*/
|
||||||
|
passwordPolicies?: PasswordPolicies;
|
||||||
|
termsAcceptanceRequired?: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type RegisterUserProfile = RegisterUserProfile.CommonWithLegacy & {
|
|
||||||
pageId: "register-user-profile.ftl";
|
|
||||||
profile: {
|
|
||||||
context: "REGISTRATION_PROFILE";
|
|
||||||
attributes: Attribute[];
|
|
||||||
attributesByName: Record<string, Attribute>;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
export namespace RegisterUserProfile {
|
|
||||||
export type CommonWithLegacy = Common & {
|
|
||||||
url: {
|
|
||||||
registrationAction: string;
|
|
||||||
};
|
|
||||||
passwordRequired: boolean;
|
|
||||||
recaptchaRequired: boolean;
|
|
||||||
recaptchaSiteKey?: string;
|
|
||||||
social: {
|
|
||||||
displayInfo: boolean;
|
|
||||||
providers?: {
|
|
||||||
loginUrl: string;
|
|
||||||
alias: string;
|
|
||||||
providerId: string;
|
|
||||||
displayName: string;
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Info = Common & {
|
export type Info = Common & {
|
||||||
pageId: "info.ftl";
|
pageId: "info.ftl";
|
||||||
messageHeader?: string;
|
messageHeader?: string;
|
||||||
@ -222,16 +217,21 @@ export declare namespace KcContext {
|
|||||||
baseUrl?: string;
|
baseUrl?: string;
|
||||||
};
|
};
|
||||||
message: NonNullable<Common["message"]>;
|
message: NonNullable<Common["message"]>;
|
||||||
|
skipLink?: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginResetPassword = Common & {
|
export type LoginResetPassword = Common & {
|
||||||
pageId: "login-reset-password.ftl";
|
pageId: "login-reset-password.ftl";
|
||||||
realm: {
|
realm: {
|
||||||
loginWithEmailAllowed: boolean;
|
loginWithEmailAllowed: boolean;
|
||||||
|
duplicateEmailsAllowed: boolean;
|
||||||
};
|
};
|
||||||
url: {
|
url: {
|
||||||
loginResetCredentialsUrl: string;
|
loginResetCredentialsUrl: string;
|
||||||
};
|
};
|
||||||
|
auth: {
|
||||||
|
attemptedUsername?: string;
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginVerifyEmail = Common & {
|
export type LoginVerifyEmail = Common & {
|
||||||
@ -244,6 +244,17 @@ export declare namespace KcContext {
|
|||||||
|
|
||||||
export type Terms = Common & {
|
export type Terms = Common & {
|
||||||
pageId: "terms.ftl";
|
pageId: "terms.ftl";
|
||||||
|
//NOTE: Optional because maybe it wasn't defined in older keycloak versions.
|
||||||
|
user?: {
|
||||||
|
id: string;
|
||||||
|
username: string;
|
||||||
|
attributes: Record<string, string[]>;
|
||||||
|
email: string;
|
||||||
|
emailVerified: boolean;
|
||||||
|
firstName?: string;
|
||||||
|
lastName?: string;
|
||||||
|
markedForEviction?: boolean;
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginDeviceVerifyUserCode = Common & {
|
export type LoginDeviceVerifyUserCode = Common & {
|
||||||
@ -260,6 +271,7 @@ export declare namespace KcContext {
|
|||||||
client: string;
|
client: string;
|
||||||
clientScopesRequested: {
|
clientScopesRequested: {
|
||||||
consentScreenText: string;
|
consentScreenText: string;
|
||||||
|
dynamicScopeParameter?: string;
|
||||||
}[];
|
}[];
|
||||||
};
|
};
|
||||||
url: {
|
url: {
|
||||||
@ -270,7 +282,11 @@ export declare namespace KcContext {
|
|||||||
export type LoginOtp = Common & {
|
export type LoginOtp = Common & {
|
||||||
pageId: "login-otp.ftl";
|
pageId: "login-otp.ftl";
|
||||||
otpLogin: {
|
otpLogin: {
|
||||||
userOtpCredentials: { id: string; userLabel: string }[];
|
userOtpCredentials: {
|
||||||
|
id: string;
|
||||||
|
userLabel: string;
|
||||||
|
}[];
|
||||||
|
selectedCredentialId?: string;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -293,15 +309,7 @@ export declare namespace KcContext {
|
|||||||
rememberMe?: string;
|
rememberMe?: string;
|
||||||
};
|
};
|
||||||
usernameHidden?: boolean;
|
usernameHidden?: boolean;
|
||||||
social: {
|
social: Login["social"];
|
||||||
displayInfo: boolean;
|
|
||||||
providers?: {
|
|
||||||
loginUrl: string;
|
|
||||||
alias: string;
|
|
||||||
providerId: string;
|
|
||||||
displayName: string;
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginPassword = Common & {
|
export type LoginPassword = Common & {
|
||||||
@ -322,9 +330,6 @@ export declare namespace KcContext {
|
|||||||
social: {
|
social: {
|
||||||
displayInfo: boolean;
|
displayInfo: boolean;
|
||||||
};
|
};
|
||||||
login: {
|
|
||||||
password?: string;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type WebauthnAuthenticate = Common & {
|
export type WebauthnAuthenticate = Common & {
|
||||||
@ -343,6 +348,14 @@ export declare namespace KcContext {
|
|||||||
displayInfo: boolean;
|
displayInfo: boolean;
|
||||||
};
|
};
|
||||||
login: {};
|
login: {};
|
||||||
|
realm: {
|
||||||
|
password: boolean;
|
||||||
|
registrationAllowed: boolean;
|
||||||
|
};
|
||||||
|
registrationDisabled?: boolean;
|
||||||
|
url: {
|
||||||
|
registrationUrl?: string;
|
||||||
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export namespace WebauthnAuthenticate {
|
export namespace WebauthnAuthenticate {
|
||||||
@ -350,27 +363,33 @@ export declare namespace KcContext {
|
|||||||
credentialId: string;
|
credentialId: string;
|
||||||
transports: {
|
transports: {
|
||||||
iconClass: string;
|
iconClass: string;
|
||||||
displayNameProperties: MessageKey[];
|
displayNameProperties?: MessageKey[];
|
||||||
};
|
};
|
||||||
label: string;
|
label: string;
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export type LoginUpdatePassword = Common & {
|
export type WebauthnRegister = Common & {
|
||||||
pageId: "login-update-password.ftl";
|
pageId: "webauthn-register.ftl";
|
||||||
|
challenge: string;
|
||||||
|
userid: string;
|
||||||
username: string;
|
username: string;
|
||||||
|
signatureAlgorithms: string[];
|
||||||
|
rpEntityName: string;
|
||||||
|
rpId: string;
|
||||||
|
attestationConveyancePreference: string;
|
||||||
|
authenticatorAttachment: string;
|
||||||
|
requireResidentKey: string;
|
||||||
|
userVerificationRequirement: string;
|
||||||
|
createTimeout: number;
|
||||||
|
excludeCredentialIds: string;
|
||||||
|
isSetRetry?: boolean;
|
||||||
|
isAppInitiatedAction?: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginUpdateProfile = Common & {
|
export type LoginUpdatePassword = Common & {
|
||||||
pageId: "login-update-profile.ftl";
|
pageId: "login-update-password.ftl";
|
||||||
user: {
|
|
||||||
editUsernameAllowed: boolean;
|
|
||||||
username?: string;
|
|
||||||
email?: string;
|
|
||||||
firstName?: string;
|
|
||||||
lastName?: string;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginIdpLinkConfirm = Common & {
|
export type LoginIdpLinkConfirm = Common & {
|
||||||
@ -432,28 +451,19 @@ export declare namespace KcContext {
|
|||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
export type UpdateUserProfile = Common & {
|
export type LoginUpdateProfile = Common & {
|
||||||
pageId: "update-user-profile.ftl";
|
pageId: "login-update-profile.ftl";
|
||||||
profile: {
|
profile: UserProfile;
|
||||||
attributes: Attribute[];
|
|
||||||
attributesByName: Record<string, Attribute>;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type IdpReviewUserProfile = Common & {
|
export type IdpReviewUserProfile = Common & {
|
||||||
pageId: "idp-review-user-profile.ftl";
|
pageId: "idp-review-user-profile.ftl";
|
||||||
profile: {
|
profile: UserProfile;
|
||||||
context: "IDP_REVIEW";
|
|
||||||
attributes: Attribute[];
|
|
||||||
attributesByName: Record<string, Attribute>;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type UpdateEmail = Common & {
|
export type UpdateEmail = Common & {
|
||||||
pageId: "update-email.ftl";
|
pageId: "update-email.ftl";
|
||||||
email: {
|
profile: UserProfile;
|
||||||
value?: string;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type SelectAuthenticator = Common & {
|
export type SelectAuthenticator = Common & {
|
||||||
@ -488,20 +498,124 @@ export declare namespace KcContext {
|
|||||||
| "kcAuthenticatorWebAuthnPasswordlessClass";
|
| "kcAuthenticatorWebAuthnPasswordlessClass";
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type DeleteCredential = Common & {
|
||||||
|
pageId: "delete-credential.ftl";
|
||||||
|
credentialLabel: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type Code = Common & {
|
||||||
|
pageId: "code.ftl";
|
||||||
|
code: {
|
||||||
|
success: boolean;
|
||||||
|
code?: string;
|
||||||
|
error?: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type DeleteAccountConfirm = Common & {
|
||||||
|
pageId: "delete-account-confirm.ftl";
|
||||||
|
triggered_from_aia: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
|
export type FrontchannelLogout = Common & {
|
||||||
|
pageId: "frontchannel-logout.ftl";
|
||||||
|
logout: {
|
||||||
|
clients: {
|
||||||
|
name: string;
|
||||||
|
frontChannelLogoutUrl: string;
|
||||||
|
}[];
|
||||||
|
logoutRedirectUri?: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LoginRecoveryAuthnCodeConfig = Common & {
|
||||||
|
pageId: "login-recovery-authn-code-config.ftl";
|
||||||
|
recoveryAuthnCodesConfigBean: {
|
||||||
|
generatedRecoveryAuthnCodesList: string[];
|
||||||
|
generatedRecoveryAuthnCodesAsString: string;
|
||||||
|
generatedAt: number;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LoginRecoveryAuthnCodeInput = Common & {
|
||||||
|
pageId: "login-recovery-authn-code-input.ftl";
|
||||||
|
recoveryAuthnCodesInputBean: {
|
||||||
|
codeNumber: number;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LoginResetOtp = Common & {
|
||||||
|
pageId: "login-reset-otp.ftl";
|
||||||
|
configuredOtpCredentials: {
|
||||||
|
userOtpCredentials: {
|
||||||
|
id: string;
|
||||||
|
userLabel: string;
|
||||||
|
}[];
|
||||||
|
selectedCredentialId: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LoginX509Info = Common & {
|
||||||
|
pageId: "login-x509-info.ftl";
|
||||||
|
x509: {
|
||||||
|
formData: {
|
||||||
|
subjectDN?: string;
|
||||||
|
isUserEnabled?: boolean;
|
||||||
|
username?: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type WebauthnError = Common & {
|
||||||
|
pageId: "webauthn-error.ftl";
|
||||||
|
isAppInitiatedAction?: boolean;
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type UserProfile = {
|
||||||
|
attributes: Attribute[];
|
||||||
|
attributesByName: Record<string, Attribute>;
|
||||||
|
html5DataAnnotations?: Record<string, string>;
|
||||||
|
};
|
||||||
|
|
||||||
export type Attribute = {
|
export type Attribute = {
|
||||||
name: string;
|
name: string;
|
||||||
displayName?: string;
|
displayName?: string;
|
||||||
required: boolean;
|
required: boolean;
|
||||||
value?: string;
|
value?: string;
|
||||||
group?: string;
|
values?: string[];
|
||||||
groupDisplayHeader?: string;
|
group?: {
|
||||||
groupDisplayDescription?: string;
|
html5DataAnnotations: Record<string, string>;
|
||||||
|
displayHeader?: string;
|
||||||
|
name: string;
|
||||||
|
displayDescription?: string;
|
||||||
|
};
|
||||||
|
html5DataAnnotations?: {
|
||||||
|
kcNumberFormat?: string;
|
||||||
|
kcNumberUnFormat?: string;
|
||||||
|
};
|
||||||
readOnly: boolean;
|
readOnly: boolean;
|
||||||
validators: Validators;
|
validators: Validators;
|
||||||
annotations: Record<string, string>;
|
annotations: {
|
||||||
groupAnnotations: Record<string, string>;
|
inputType?: string;
|
||||||
|
inputTypeSize?: `${number}` | number;
|
||||||
|
inputOptionsFromValidation?: string;
|
||||||
|
inputOptionLabels?: Record<string, string | undefined>;
|
||||||
|
inputOptionLabelsI18nPrefix?: string;
|
||||||
|
inputTypeCols?: `${number}` | number;
|
||||||
|
inputTypeRows?: `${number}` | number;
|
||||||
|
inputTypeMaxlength?: `${number}` | number;
|
||||||
|
inputHelperTextBefore?: string;
|
||||||
|
inputHelperTextAfter?: string;
|
||||||
|
inputTypePlaceholder?: string;
|
||||||
|
inputTypePattern?: string;
|
||||||
|
inputTypeMinlength?: `${number}` | number;
|
||||||
|
inputTypeMax?: string;
|
||||||
|
inputTypeMin?: string;
|
||||||
|
inputTypeStep?: string;
|
||||||
|
};
|
||||||
|
multivalued?: boolean;
|
||||||
autocomplete?:
|
autocomplete?:
|
||||||
| "on"
|
| "on"
|
||||||
| "off"
|
| "off"
|
||||||
@ -561,31 +675,28 @@ export type Attribute = {
|
|||||||
|
|
||||||
export type Validators = Partial<{
|
export type Validators = Partial<{
|
||||||
length: Validators.DoIgnoreEmpty & Validators.Range;
|
length: Validators.DoIgnoreEmpty & Validators.Range;
|
||||||
double: Validators.DoIgnoreEmpty & Validators.Range;
|
|
||||||
integer: Validators.DoIgnoreEmpty & Validators.Range;
|
integer: Validators.DoIgnoreEmpty & Validators.Range;
|
||||||
email: Validators.DoIgnoreEmpty;
|
email: Validators.DoIgnoreEmpty;
|
||||||
|
pattern: Validators.DoIgnoreEmpty & Validators.ErrorMessage & { pattern: string };
|
||||||
|
options: Validators.Options;
|
||||||
|
multivalued: Validators.DoIgnoreEmpty & Validators.Range;
|
||||||
|
// NOTE: Following are the validators for which we don't implement client side validation yet
|
||||||
|
// or for which the validation can't be performed on the client side.
|
||||||
|
/*
|
||||||
|
double: Validators.DoIgnoreEmpty & Validators.Range;
|
||||||
"up-immutable-attribute": {};
|
"up-immutable-attribute": {};
|
||||||
"up-attribute-required-by-metadata-value": {};
|
"up-attribute-required-by-metadata-value": {};
|
||||||
"up-username-has-value": {};
|
"up-username-has-value": {};
|
||||||
"up-duplicate-username": {};
|
"up-duplicate-username": {};
|
||||||
"up-username-mutation": {};
|
"up-username-mutation": {};
|
||||||
"up-email-exists-as-username": {};
|
"up-email-exists-as-username": {};
|
||||||
"up-blank-attribute-value": Validators.ErrorMessage & {
|
"up-blank-attribute-value": Validators.ErrorMessage & { "fail-on-null": boolean; };
|
||||||
"fail-on-null": boolean;
|
|
||||||
};
|
|
||||||
"up-duplicate-email": {};
|
"up-duplicate-email": {};
|
||||||
"local-date": Validators.DoIgnoreEmpty;
|
"local-date": Validators.DoIgnoreEmpty;
|
||||||
pattern: Validators.DoIgnoreEmpty & Validators.ErrorMessage & { pattern: string };
|
|
||||||
"person-name-prohibited-characters": Validators.DoIgnoreEmpty & Validators.ErrorMessage;
|
"person-name-prohibited-characters": Validators.DoIgnoreEmpty & Validators.ErrorMessage;
|
||||||
uri: Validators.DoIgnoreEmpty;
|
uri: Validators.DoIgnoreEmpty;
|
||||||
"username-prohibited-characters": Validators.DoIgnoreEmpty & Validators.ErrorMessage;
|
"username-prohibited-characters": Validators.DoIgnoreEmpty & Validators.ErrorMessage;
|
||||||
/** Made up validator that only exists in Keycloakify */
|
*/
|
||||||
_compareToOther: Validators.DoIgnoreEmpty &
|
|
||||||
Validators.ErrorMessage & {
|
|
||||||
name: string;
|
|
||||||
shouldBe: "equal" | "different";
|
|
||||||
};
|
|
||||||
options: Validators.Options;
|
|
||||||
}>;
|
}>;
|
||||||
|
|
||||||
export declare namespace Validators {
|
export declare namespace Validators {
|
||||||
@ -598,9 +709,8 @@ export declare namespace Validators {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export type Range = {
|
export type Range = {
|
||||||
/** "0", "1", "2"... yeah I know, don't tell me */
|
min?: `${number}` | number;
|
||||||
min?: `${number}`;
|
max?: `${number}` | number;
|
||||||
max?: `${number}`;
|
|
||||||
};
|
};
|
||||||
export type Options = {
|
export type Options = {
|
||||||
options: string[];
|
options: string[];
|
||||||
@ -618,4 +728,19 @@ export declare namespace Validators {
|
|||||||
assert<Equals<OnlyInExpected, never>>();
|
assert<Equals<OnlyInExpected, never>>();
|
||||||
}
|
}
|
||||||
|
|
||||||
assert<KcContext["themeType"] extends ThemeType ? true : false>();
|
export type PasswordPolicies = {
|
||||||
|
/** The minimum length of the password */
|
||||||
|
length?: number;
|
||||||
|
/** The minimum number of digits required in the password */
|
||||||
|
digits?: number;
|
||||||
|
/** The minimum number of lowercase characters required in the password */
|
||||||
|
lowerCase?: number;
|
||||||
|
/** The minimum number of uppercase characters required in the password */
|
||||||
|
upperCase?: number;
|
||||||
|
/** The minimum number of special characters required in the password */
|
||||||
|
specialChars?: number;
|
||||||
|
/** Whether the password can be the username */
|
||||||
|
notUsername?: boolean;
|
||||||
|
/** Whether the password can be the email address */
|
||||||
|
notEmail?: boolean;
|
||||||
|
};
|
||||||
|
@ -2,19 +2,19 @@ import type { KcContext, Attribute } from "./KcContext";
|
|||||||
import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
|
import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
|
||||||
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
||||||
import { deepAssign } from "keycloakify/tools/deepAssign";
|
import { deepAssign } from "keycloakify/tools/deepAssign";
|
||||||
|
import { isStorybook } from "keycloakify/lib/isStorybook";
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import { exclude } from "tsafe/exclude";
|
import { exclude } from "tsafe/exclude";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
||||||
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
import { resources_common } from "keycloakify/bin/constants";
|
|
||||||
|
|
||||||
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
||||||
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
||||||
|
mockProperties?: Record<string, string>;
|
||||||
}) {
|
}) {
|
||||||
const { mockData } = params ?? {};
|
const { mockData, mockProperties } = params ?? {};
|
||||||
|
|
||||||
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
||||||
mockPageId?: PageId;
|
mockPageId?: PageId;
|
||||||
@ -31,7 +31,13 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
if (mockPageId !== undefined && realKcContext === undefined) {
|
if (mockPageId !== undefined && realKcContext === undefined) {
|
||||||
//TODO maybe trow if no mock fo custom page
|
//TODO maybe trow if no mock fo custom page
|
||||||
|
|
||||||
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
warn_that_mock_is_enbaled: {
|
||||||
|
if (isStorybook) {
|
||||||
|
break warn_that_mock_is_enbaled;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
||||||
|
}
|
||||||
|
|
||||||
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
||||||
|
|
||||||
@ -80,25 +86,17 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
"source": partialKcContextCustomMock
|
"source": partialKcContextCustomMock
|
||||||
});
|
});
|
||||||
|
|
||||||
if (
|
if ("profile" in partialKcContextCustomMock) {
|
||||||
partialKcContextCustomMock.pageId === "register-user-profile.ftl" ||
|
assert(kcContextDefaultMock !== undefined && "profile" in kcContextDefaultMock);
|
||||||
partialKcContextCustomMock.pageId === "update-user-profile.ftl" ||
|
|
||||||
partialKcContextCustomMock.pageId === "idp-review-user-profile.ftl"
|
|
||||||
) {
|
|
||||||
assert(
|
|
||||||
kcContextDefaultMock?.pageId === "register-user-profile.ftl" ||
|
|
||||||
kcContextDefaultMock?.pageId === "update-user-profile.ftl" ||
|
|
||||||
kcContextDefaultMock?.pageId === "idp-review-user-profile.ftl"
|
|
||||||
);
|
|
||||||
|
|
||||||
const { attributes } = kcContextDefaultMock.profile;
|
const { attributes } = kcContextDefaultMock.profile;
|
||||||
|
|
||||||
id<KcContext.RegisterUserProfile>(kcContext).profile.attributes = [];
|
id<KcContext.Register>(kcContext).profile.attributes = [];
|
||||||
id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName = {};
|
id<KcContext.Register>(kcContext).profile.attributesByName = {};
|
||||||
|
|
||||||
const partialAttributes = [
|
const partialAttributes = [...((partialKcContextCustomMock as DeepPartial<KcContext.Register>).profile?.attributes ?? [])].filter(
|
||||||
...((partialKcContextCustomMock as DeepPartial<KcContext.RegisterUserProfile>).profile?.attributes ?? [])
|
exclude(undefined)
|
||||||
].filter(exclude(undefined));
|
);
|
||||||
|
|
||||||
attributes.forEach(attribute => {
|
attributes.forEach(attribute => {
|
||||||
const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
|
const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
|
||||||
@ -119,8 +117,8 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(augmentedAttribute);
|
id<KcContext.Register>(kcContext).profile.attributes.push(augmentedAttribute);
|
||||||
id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
|
id<KcContext.Register>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
|
||||||
});
|
});
|
||||||
|
|
||||||
partialAttributes
|
partialAttributes
|
||||||
@ -130,12 +128,19 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
|
|
||||||
assert(name !== undefined, "If you define a mock attribute it must have at least a name");
|
assert(name !== undefined, "If you define a mock attribute it must have at least a name");
|
||||||
|
|
||||||
id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
|
id<KcContext.Register>(kcContext).profile.attributes.push(partialAttribute as any);
|
||||||
id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
|
id<KcContext.Register>(kcContext).profile.attributesByName[name] = partialAttribute as any;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (mockProperties !== undefined) {
|
||||||
|
deepAssign({
|
||||||
|
"target": kcContext.properties,
|
||||||
|
"source": mockProperties
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
return { kcContext };
|
return { kcContext };
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -147,8 +152,6 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
realKcContext.url.resourcesCommonPath = pathJoin(realKcContext.url.resourcesPath, resources_common);
|
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
||||||
import { ftlValuesGlobalName } from "keycloakify/bin/keycloakify/ftlValuesGlobalName";
|
import { nameOfTheGlobal } from "keycloakify/bin/constants";
|
||||||
|
|
||||||
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
||||||
? KcContext
|
? KcContext
|
||||||
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
||||||
|
|
||||||
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
||||||
return typeof window === "undefined" ? undefined : (window as any)[ftlValuesGlobalName];
|
return typeof window === "undefined" ? undefined : (window as any)[nameOfTheGlobal];
|
||||||
}
|
}
|
||||||
|
@ -1,30 +1,23 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import type { KcContext, Attribute } from "./KcContext";
|
import type { KcContext, Attribute } from "./KcContext";
|
||||||
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import { assert, type Equals } from "tsafe/assert";
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
|
import { BASE_URL } from "keycloakify/lib/BASE_URL";
|
||||||
|
|
||||||
const attributes: Attribute[] = [
|
const attributes: Attribute[] = [
|
||||||
{
|
{
|
||||||
"validators": {
|
"validators": {
|
||||||
"username-prohibited-characters": {
|
|
||||||
"ignore.empty.value": true
|
|
||||||
},
|
|
||||||
"up-username-has-value": {},
|
|
||||||
"length": {
|
"length": {
|
||||||
"ignore.empty.value": true,
|
"ignore.empty.value": true,
|
||||||
"min": "3",
|
"min": "3",
|
||||||
"max": "255"
|
"max": "255"
|
||||||
},
|
}
|
||||||
"up-duplicate-username": {},
|
|
||||||
"up-username-mutation": {}
|
|
||||||
},
|
},
|
||||||
"displayName": "${username}",
|
"displayName": "${username}",
|
||||||
"annotations": {},
|
"annotations": {},
|
||||||
"required": true,
|
"required": true,
|
||||||
"groupAnnotations": {},
|
|
||||||
"autocomplete": "username",
|
"autocomplete": "username",
|
||||||
"readOnly": false,
|
"readOnly": false,
|
||||||
"name": "username",
|
"name": "username",
|
||||||
@ -32,16 +25,10 @@ const attributes: Attribute[] = [
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"validators": {
|
"validators": {
|
||||||
"up-email-exists-as-username": {},
|
|
||||||
"length": {
|
"length": {
|
||||||
"max": "255",
|
"max": "255",
|
||||||
"ignore.empty.value": true
|
"ignore.empty.value": true
|
||||||
},
|
},
|
||||||
"up-blank-attribute-value": {
|
|
||||||
"error-message": "missingEmailMessage",
|
|
||||||
"fail-on-null": false
|
|
||||||
},
|
|
||||||
"up-duplicate-email": {},
|
|
||||||
"email": {
|
"email": {
|
||||||
"ignore.empty.value": true
|
"ignore.empty.value": true
|
||||||
},
|
},
|
||||||
@ -53,7 +40,6 @@ const attributes: Attribute[] = [
|
|||||||
"displayName": "${email}",
|
"displayName": "${email}",
|
||||||
"annotations": {},
|
"annotations": {},
|
||||||
"required": true,
|
"required": true,
|
||||||
"groupAnnotations": {},
|
|
||||||
"autocomplete": "email",
|
"autocomplete": "email",
|
||||||
"readOnly": false,
|
"readOnly": false,
|
||||||
"name": "email"
|
"name": "email"
|
||||||
@ -63,17 +49,11 @@ const attributes: Attribute[] = [
|
|||||||
"length": {
|
"length": {
|
||||||
"max": "255",
|
"max": "255",
|
||||||
"ignore.empty.value": true
|
"ignore.empty.value": true
|
||||||
},
|
}
|
||||||
"person-name-prohibited-characters": {
|
|
||||||
"ignore.empty.value": true
|
|
||||||
},
|
|
||||||
"up-immutable-attribute": {},
|
|
||||||
"up-attribute-required-by-metadata-value": {}
|
|
||||||
},
|
},
|
||||||
"displayName": "${firstName}",
|
"displayName": "${firstName}",
|
||||||
"annotations": {},
|
"annotations": {},
|
||||||
"required": true,
|
"required": true,
|
||||||
"groupAnnotations": {},
|
|
||||||
"readOnly": false,
|
"readOnly": false,
|
||||||
"name": "firstName"
|
"name": "firstName"
|
||||||
},
|
},
|
||||||
@ -82,17 +62,11 @@ const attributes: Attribute[] = [
|
|||||||
"length": {
|
"length": {
|
||||||
"max": "255",
|
"max": "255",
|
||||||
"ignore.empty.value": true
|
"ignore.empty.value": true
|
||||||
},
|
}
|
||||||
"person-name-prohibited-characters": {
|
|
||||||
"ignore.empty.value": true
|
|
||||||
},
|
|
||||||
"up-immutable-attribute": {},
|
|
||||||
"up-attribute-required-by-metadata-value": {}
|
|
||||||
},
|
},
|
||||||
"displayName": "${lastName}",
|
"displayName": "${lastName}",
|
||||||
"annotations": {},
|
"annotations": {},
|
||||||
"required": true,
|
"required": true,
|
||||||
"groupAnnotations": {},
|
|
||||||
"readOnly": false,
|
"readOnly": false,
|
||||||
"name": "lastName"
|
"name": "lastName"
|
||||||
}
|
}
|
||||||
@ -100,9 +74,7 @@ const attributes: Attribute[] = [
|
|||||||
|
|
||||||
const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
|
const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
|
||||||
|
|
||||||
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
const resourcesPath = `${BASE_URL}${keycloak_resources}/login/resources`;
|
||||||
|
|
||||||
const resourcesPath = pathJoin(PUBLIC_URL, keycloak_resources, "login", "resources");
|
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
"themeVersion": "0.0.0",
|
"themeVersion": "0.0.0",
|
||||||
@ -112,9 +84,10 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"url": {
|
"url": {
|
||||||
"loginAction": "#",
|
"loginAction": "#",
|
||||||
resourcesPath,
|
resourcesPath,
|
||||||
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
"resourcesCommonPath": `${resourcesPath}/${resources_common}`,
|
||||||
"loginRestartFlowUrl": "/auth/realms/myrealm/login-actions/restart?client_id=account&tab_id=HoAx28ja4xg",
|
"loginRestartFlowUrl": "/auth/realms/myrealm/login-actions/restart?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
"loginUrl": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg"
|
"loginUrl": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
|
"ssoLoginInOtherTabsUrl": "/auth/realms/myrealm/login-actions/switch?client_id=account&tab_id=HoAx28ja4xg"
|
||||||
},
|
},
|
||||||
"realm": {
|
"realm": {
|
||||||
"name": "myrealm",
|
"name": "myrealm",
|
||||||
@ -128,8 +101,9 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
return undefined;
|
return undefined;
|
||||||
},
|
},
|
||||||
"existsError": () => false,
|
"existsError": () => false,
|
||||||
"get": key => `Fake error for ${key}`,
|
"get": fieldName => `Fake error for ${fieldName}`,
|
||||||
"exists": () => false
|
"exists": () => false,
|
||||||
|
"getFirstError": fieldName => `Fake error for ${fieldName}`
|
||||||
},
|
},
|
||||||
"locale": {
|
"locale": {
|
||||||
"supported": [
|
"supported": [
|
||||||
@ -238,7 +212,8 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"attributes": {}
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"scripts": [],
|
"scripts": [],
|
||||||
"isAppInitiatedAction": false
|
"isAppInitiatedAction": false,
|
||||||
|
"properties": {}
|
||||||
};
|
};
|
||||||
|
|
||||||
const loginUrl = {
|
const loginUrl = {
|
||||||
@ -270,42 +245,25 @@ export const kcContextMocks = [
|
|||||||
"login": {},
|
"login": {},
|
||||||
"registrationDisabled": false
|
"registrationDisabled": false
|
||||||
}),
|
}),
|
||||||
...(() => {
|
id<KcContext.Register>({
|
||||||
const registerCommon: KcContext.RegisterUserProfile.CommonWithLegacy = {
|
...kcContextCommonMock,
|
||||||
...kcContextCommonMock,
|
"url": {
|
||||||
"url": {
|
...loginUrl,
|
||||||
...loginUrl,
|
"registrationAction":
|
||||||
"registrationAction":
|
"http://localhost:8080/auth/realms/myrealm/login-actions/registration?session_code=gwZdUeO7pbYpFTRxiIxRg_QtzMbtFTKrNu6XW_f8asM&execution=12146ce0-b139-4bbd-b25b-0eccfee6577e&client_id=account&tab_id=uS8lYfebLa0"
|
||||||
"http://localhost:8080/auth/realms/myrealm/login-actions/registration?session_code=gwZdUeO7pbYpFTRxiIxRg_QtzMbtFTKrNu6XW_f8asM&execution=12146ce0-b139-4bbd-b25b-0eccfee6577e&client_id=account&tab_id=uS8lYfebLa0"
|
},
|
||||||
},
|
"isAppInitiatedAction": false,
|
||||||
"scripts": [],
|
"passwordRequired": true,
|
||||||
"isAppInitiatedAction": false,
|
"recaptchaRequired": false,
|
||||||
"passwordRequired": true,
|
"pageId": "register.ftl",
|
||||||
"recaptchaRequired": false,
|
"profile": {
|
||||||
"social": {
|
attributes,
|
||||||
"displayInfo": true
|
attributesByName
|
||||||
}
|
},
|
||||||
};
|
"scripts": [
|
||||||
|
//"https://www.google.com/recaptcha/api.js"
|
||||||
return [
|
]
|
||||||
id<KcContext.Register>({
|
}),
|
||||||
"pageId": "register.ftl",
|
|
||||||
...registerCommon,
|
|
||||||
"register": {
|
|
||||||
"formData": {}
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
id<KcContext.RegisterUserProfile>({
|
|
||||||
"pageId": "register-user-profile.ftl",
|
|
||||||
...registerCommon,
|
|
||||||
"profile": {
|
|
||||||
"context": "REGISTRATION_PROFILE" as const,
|
|
||||||
attributes,
|
|
||||||
attributesByName
|
|
||||||
}
|
|
||||||
})
|
|
||||||
];
|
|
||||||
})(),
|
|
||||||
id<KcContext.Info>({
|
id<KcContext.Info>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "info.ftl",
|
"pageId": "info.ftl",
|
||||||
@ -337,9 +295,11 @@ export const kcContextMocks = [
|
|||||||
"pageId": "login-reset-password.ftl",
|
"pageId": "login-reset-password.ftl",
|
||||||
"realm": {
|
"realm": {
|
||||||
...kcContextCommonMock.realm,
|
...kcContextCommonMock.realm,
|
||||||
"loginWithEmailAllowed": false
|
"loginWithEmailAllowed": false,
|
||||||
|
"duplicateEmailsAllowed": false
|
||||||
},
|
},
|
||||||
url: loginUrl
|
"url": loginUrl,
|
||||||
|
"auth": {}
|
||||||
}),
|
}),
|
||||||
id<KcContext.LoginVerifyEmail>({
|
id<KcContext.LoginVerifyEmail>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
@ -416,8 +376,7 @@ export const kcContextMocks = [
|
|||||||
},
|
},
|
||||||
"social": {
|
"social": {
|
||||||
"displayInfo": false
|
"displayInfo": false
|
||||||
},
|
}
|
||||||
"login": {}
|
|
||||||
}),
|
}),
|
||||||
id<KcContext.WebauthnAuthenticate>({
|
id<KcContext.WebauthnAuthenticate>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
@ -427,7 +386,9 @@ export const kcContextMocks = [
|
|||||||
"authenticators": []
|
"authenticators": []
|
||||||
},
|
},
|
||||||
"realm": {
|
"realm": {
|
||||||
...kcContextCommonMock.realm
|
...kcContextCommonMock.realm,
|
||||||
|
"password": true,
|
||||||
|
"registrationAllowed": true
|
||||||
},
|
},
|
||||||
"challenge": "",
|
"challenge": "",
|
||||||
"userVerification": "not specified",
|
"userVerification": "not specified",
|
||||||
@ -442,18 +403,14 @@ export const kcContextMocks = [
|
|||||||
}),
|
}),
|
||||||
id<KcContext.LoginUpdatePassword>({
|
id<KcContext.LoginUpdatePassword>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "login-update-password.ftl",
|
"pageId": "login-update-password.ftl"
|
||||||
"username": "anUsername"
|
|
||||||
}),
|
}),
|
||||||
id<KcContext.LoginUpdateProfile>({
|
id<KcContext.LoginUpdateProfile>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "login-update-profile.ftl",
|
"pageId": "login-update-profile.ftl",
|
||||||
"user": {
|
"profile": {
|
||||||
"editUsernameAllowed": true,
|
attributes,
|
||||||
"username": "anUsername",
|
attributesByName
|
||||||
"email": "foo@example.com",
|
|
||||||
"firstName": "aFirstName",
|
|
||||||
"lastName": "aLastName"
|
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
id<KcContext.LoginIdpLinkConfirm>({
|
id<KcContext.LoginIdpLinkConfirm>({
|
||||||
@ -472,21 +429,21 @@ export const kcContextMocks = [
|
|||||||
id<KcContext.LoginConfigTotp>({
|
id<KcContext.LoginConfigTotp>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "login-config-totp.ftl",
|
"pageId": "login-config-totp.ftl",
|
||||||
totp: {
|
"totp": {
|
||||||
totpSecretEncoded: "KVVF G2BY N4YX S6LB IUYT K2LH IFYE 4SBV",
|
"totpSecretEncoded": "KVVF G2BY N4YX S6LB IUYT K2LH IFYE 4SBV",
|
||||||
qrUrl: "#",
|
"qrUrl": "#",
|
||||||
totpSecretQrCode:
|
"totpSecretQrCode":
|
||||||
"iVBORw0KGgoAAAANSUhEUgAAAPYAAAD2AQAAAADNaUdlAAACM0lEQVR4Xu3OIZJgOQwDUDFd2UxiurLAVnnbHw4YGDKtSiWOn4Gxf81//7r/+q8b4HfLGBZDK9d85NmNR+sB42sXvOYrN5P1DcgYYFTGfOlbzE8gzwy3euweGizw7cfdl34/GRhlkxjKNV+5AebPXPORX1JuB9x8ZfbyyD2y1krWAKsbMq1HnqQDaLfa77p4+MqvzEGSqvSAD/2IHW2yHaigR9tX3m8dDIYGcNf3f+gDpVBZbZU77zyJ6Rlcy+qoTMG887KAPD9hsh6a1Sv3gJUHGHUAxSMzj7zqDDe7Phmt2eG+8UsMxjRGm816MAO+8VMl1R1jGHOrZB/5Zo/WXAPgxixm9Mo96vDGrM1eOto8c4Ax4wF437mifOXlpiPzCnN7Y9l95NnEMxgMY9AAGA8fucH14Y1aVb6N/cqrmyh0BVht7k1e+bU8LK0Cg5vmVq9c5vHIjOfqxDIfeTraNVTwewa4wVe+SW5N+uP1qACeudUZbqGOfA6VZV750Noq2Xx3kpveV44ZelSV1V7KFHzkWyVrrlUwG0Pl9pWnoy3vsQoME6vKI69i5osVgwWzHT7zjmJtMcNUSVn1oYMd7ZodbgowZl45VG0uVuLPUr1yc79uaQBag/mqR34xhlWyHm1prplHboCWdZ4TeZjsK8+dI+jbz1C5hl65mcpgB5dhcj8+dGO+0Ko68+lD37JDD83dpDLzzK+TrQyaVwGj6pUboGV+7+AyN8An/pf84/7rv/4/1l4OCc/1BYMAAAAASUVORK5CYII=",
|
"iVBORw0KGgoAAAANSUhEUgAAAPYAAAD2AQAAAADNaUdlAAACM0lEQVR4Xu3OIZJgOQwDUDFd2UxiurLAVnnbHw4YGDKtSiWOn4Gxf81//7r/+q8b4HfLGBZDK9d85NmNR+sB42sXvOYrN5P1DcgYYFTGfOlbzE8gzwy3euweGizw7cfdl34/GRhlkxjKNV+5AebPXPORX1JuB9x8ZfbyyD2y1krWAKsbMq1HnqQDaLfa77p4+MqvzEGSqvSAD/2IHW2yHaigR9tX3m8dDIYGcNf3f+gDpVBZbZU77zyJ6Rlcy+qoTMG887KAPD9hsh6a1Sv3gJUHGHUAxSMzj7zqDDe7Phmt2eG+8UsMxjRGm816MAO+8VMl1R1jGHOrZB/5Zo/WXAPgxixm9Mo96vDGrM1eOto8c4Ax4wF437mifOXlpiPzCnN7Y9l95NnEMxgMY9AAGA8fucH14Y1aVb6N/cqrmyh0BVht7k1e+bU8LK0Cg5vmVq9c5vHIjOfqxDIfeTraNVTwewa4wVe+SW5N+uP1qACeudUZbqGOfA6VZV750Noq2Xx3kpveV44ZelSV1V7KFHzkWyVrrlUwG0Pl9pWnoy3vsQoME6vKI69i5osVgwWzHT7zjmJtMcNUSVn1oYMd7ZodbgowZl45VG0uVuLPUr1yc79uaQBag/mqR34xhlWyHm1prplHboCWdZ4TeZjsK8+dI+jbz1C5hl65mcpgB5dhcj8+dGO+0Ko68+lD37JDD83dpDLzzK+TrQyaVwGj6pUboGV+7+AyN8An/pf84/7rv/4/1l4OCc/1BYMAAAAASUVORK5CYII=",
|
||||||
manualUrl: "#",
|
"manualUrl": "#",
|
||||||
totpSecret: "G4nsI8lQagRMUchH8jEG",
|
"totpSecret": "G4nsI8lQagRMUchH8jEG",
|
||||||
otpCredentials: [],
|
"otpCredentials": [],
|
||||||
supportedApplications: ["FreeOTP", "Google Authenticator"],
|
"supportedApplications": ["FreeOTP", "Google Authenticator"],
|
||||||
policy: {
|
"policy": {
|
||||||
algorithm: "HmacSHA1",
|
"algorithm": "HmacSHA1",
|
||||||
digits: 6,
|
"digits": 6,
|
||||||
lookAheadWindow: 1,
|
"lookAheadWindow": 1,
|
||||||
type: "totp",
|
"type": "totp",
|
||||||
period: 30
|
"period": 30
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
@ -504,19 +461,10 @@ export const kcContextMocks = [
|
|||||||
},
|
},
|
||||||
"logoutConfirm": { "code": "123", skipLink: false }
|
"logoutConfirm": { "code": "123", skipLink: false }
|
||||||
}),
|
}),
|
||||||
id<KcContext.UpdateUserProfile>({
|
|
||||||
...kcContextCommonMock,
|
|
||||||
"pageId": "update-user-profile.ftl",
|
|
||||||
"profile": {
|
|
||||||
attributes,
|
|
||||||
attributesByName
|
|
||||||
}
|
|
||||||
}),
|
|
||||||
id<KcContext.IdpReviewUserProfile>({
|
id<KcContext.IdpReviewUserProfile>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "idp-review-user-profile.ftl",
|
"pageId": "idp-review-user-profile.ftl",
|
||||||
"profile": {
|
"profile": {
|
||||||
context: "IDP_REVIEW",
|
|
||||||
attributes,
|
attributes,
|
||||||
attributesByName
|
attributesByName
|
||||||
}
|
}
|
||||||
@ -524,8 +472,11 @@ export const kcContextMocks = [
|
|||||||
id<KcContext.UpdateEmail>({
|
id<KcContext.UpdateEmail>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "update-email.ftl",
|
"pageId": "update-email.ftl",
|
||||||
"email": {
|
"profile": {
|
||||||
value: "email@example.com"
|
"attributes": attributes.filter(attribute => attribute.name === "email"),
|
||||||
|
"attributesByName": Object.fromEntries(
|
||||||
|
attributes.filter(attribute => attribute.name === "email").map(attribute => [attribute.name, attribute])
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
id<KcContext.SelectAuthenticator>({
|
id<KcContext.SelectAuthenticator>({
|
||||||
@ -558,6 +509,112 @@ export const kcContextMocks = [
|
|||||||
id<KcContext.LoginPageExpired>({
|
id<KcContext.LoginPageExpired>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
pageId: "login-page-expired.ftl"
|
pageId: "login-page-expired.ftl"
|
||||||
|
}),
|
||||||
|
|
||||||
|
id<KcContext.FrontchannelLogout>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
pageId: "frontchannel-logout.ftl",
|
||||||
|
"logout": {
|
||||||
|
"clients": [
|
||||||
|
{
|
||||||
|
"name": "myApp",
|
||||||
|
"frontChannelLogoutUrl": "#"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "myApp2",
|
||||||
|
"frontChannelLogoutUrl": "#"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.WebauthnRegister>({
|
||||||
|
"pageId": "webauthn-register.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"challenge": "random-challenge-string",
|
||||||
|
"userid": "user123",
|
||||||
|
"username": "johndoe",
|
||||||
|
"signatureAlgorithms": ["ES256", "RS256"],
|
||||||
|
"rpEntityName": "Example Corp",
|
||||||
|
"rpId": "example.com",
|
||||||
|
"attestationConveyancePreference": "direct",
|
||||||
|
"authenticatorAttachment": "platform",
|
||||||
|
"requireResidentKey": "required",
|
||||||
|
"userVerificationRequirement": "preferred",
|
||||||
|
"createTimeout": 60000,
|
||||||
|
"excludeCredentialIds": "credId123,credId456",
|
||||||
|
"isSetRetry": false,
|
||||||
|
"isAppInitiatedAction": true
|
||||||
|
}),
|
||||||
|
id<KcContext.DeleteCredential>({
|
||||||
|
"pageId": "delete-credential.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"credentialLabel": "myCredential"
|
||||||
|
}),
|
||||||
|
id<KcContext.Code>({
|
||||||
|
"pageId": "code.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"code": {
|
||||||
|
"success": true,
|
||||||
|
"code": "123456"
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.DeleteAccountConfirm>({
|
||||||
|
"pageId": "delete-account-confirm.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"triggered_from_aia": true
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginRecoveryAuthnCodeConfig>({
|
||||||
|
"pageId": "login-recovery-authn-code-config.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"recoveryAuthnCodesConfigBean": {
|
||||||
|
"generatedRecoveryAuthnCodesList": ["code123", "code456", "code789"],
|
||||||
|
"generatedRecoveryAuthnCodesAsString": "code123, code456, code789",
|
||||||
|
"generatedAt": new Date().getTime()
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginRecoveryAuthnCodeInput>({
|
||||||
|
"pageId": "login-recovery-authn-code-input.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"recoveryAuthnCodesInputBean": {
|
||||||
|
"codeNumber": 1234
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginResetOtp>({
|
||||||
|
"pageId": "login-reset-otp.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"configuredOtpCredentials": {
|
||||||
|
"userOtpCredentials": [
|
||||||
|
{
|
||||||
|
"id": "otpId1",
|
||||||
|
"userLabel": "OTP Device 1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "otpId2",
|
||||||
|
"userLabel": "OTP Device 2"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "otpId3",
|
||||||
|
"userLabel": "Backup OTP"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"selectedCredentialId": "otpId2"
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginX509Info>({
|
||||||
|
"pageId": "login-x509-info.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"x509": {
|
||||||
|
"formData": {
|
||||||
|
"subjectDN": "CN=John Doe, O=Example Corp, C=US",
|
||||||
|
"isUserEnabled": true,
|
||||||
|
"username": "johndoe"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.WebauthnError>({
|
||||||
|
"pageId": "webauthn-error.ftl",
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"isAppInitiatedAction": true
|
||||||
})
|
})
|
||||||
];
|
];
|
||||||
|
|
||||||
|
@ -5,15 +5,17 @@ import { useConst } from "keycloakify/tools/useConst";
|
|||||||
import { useConstCallback } from "keycloakify/tools/useConstCallback";
|
import { useConstCallback } from "keycloakify/tools/useConstCallback";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { Evt } from "evt";
|
import { Evt } from "evt";
|
||||||
|
import { useRerenderOnStateChange } from "evt/hooks/useRerenderOnStateChange";
|
||||||
import { KcContext } from "../kcContext";
|
import { KcContext } from "../kcContext";
|
||||||
|
|
||||||
export const evtTermMarkdown = Evt.create<string | undefined>(undefined);
|
const evtTermsMarkdown = Evt.create<string | undefined>(undefined);
|
||||||
|
|
||||||
export type KcContextLike = {
|
export type KcContextLike = {
|
||||||
pageId: string;
|
pageId: string;
|
||||||
locale?: {
|
locale?: {
|
||||||
currentLanguageTag: string;
|
currentLanguageTag: string;
|
||||||
};
|
};
|
||||||
|
termsAcceptanceRequired?: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<KcContext extends KcContextLike ? true : false>();
|
assert<KcContext extends KcContextLike ? true : false>();
|
||||||
@ -38,12 +40,18 @@ export function useDownloadTerms(params: {
|
|||||||
})();
|
})();
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (kcContext.pageId !== "terms.ftl") {
|
if (kcContext.pageId === "terms.ftl" || kcContext.termsAcceptanceRequired) {
|
||||||
return;
|
downloadTermMarkdownMemoized(kcContext.locale?.currentLanguageTag ?? fallbackLanguageTag).then(
|
||||||
|
thermMarkdown => (evtTermsMarkdown.state = thermMarkdown)
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
downloadTermMarkdownMemoized(kcContext.locale?.currentLanguageTag ?? fallbackLanguageTag).then(
|
|
||||||
thermMarkdown => (evtTermMarkdown.state = thermMarkdown)
|
|
||||||
);
|
|
||||||
}, []);
|
}, []);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function useTermsMarkdown() {
|
||||||
|
useRerenderOnStateChange(evtTermsMarkdown);
|
||||||
|
|
||||||
|
const termsMarkdown = evtTermsMarkdown.state;
|
||||||
|
|
||||||
|
return { termsMarkdown };
|
||||||
|
}
|
||||||
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user