Compare commits
149 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 | |||
29a4a5027c | |||
ee327448b4 | |||
d078960c5c | |||
2e8cd375fc | |||
1f6751cb01 | |||
3cca4e31cd | |||
b93902800c | |||
70f6bb3fda | |||
c075cb6311 | |||
d7db85b062 | |||
b442e7d958 | |||
a495ae637f | |||
94748a96a9 | |||
7657429054 | |||
2ff6dbf975 | |||
4f34628c14 | |||
6ff2111cee | |||
85957980f6 | |||
a6dcfe2c87 | |||
c32d590fbb | |||
ab41462f71 | |||
951f16b1a5 | |||
b5818888bb | |||
1a326bf7e4 | |||
e1afc1cf7a | |||
bb007ddce5 | |||
b5dd0317c7 | |||
3c54541a73 | |||
2657f01135 | |||
7223409eb1 | |||
c41eae63e7 | |||
c8b85c43aa | |||
e918788c3f | |||
b53f4f997c | |||
481d93ebc4 | |||
1ce666f136 | |||
49a8e702bc | |||
5d59e652d7 | |||
02af8c7311 | |||
fadf4e867c | |||
0839859fef | |||
c122b48e35 | |||
cebb297bbf | |||
2e31b796f7 | |||
e0a61b51cb | |||
46e50e622b | |||
7cfa1df0b2 | |||
8a63648339 | |||
bb6b026720 | |||
2a13b314dc | |||
4506b3f6d4 | |||
804abef0de | |||
7e932b920e | |||
46fdfbc507 | |||
a4ff8607c5 | |||
7fe4eeda57 | |||
9f25cddaa4 | |||
eb64fe60d0 | |||
36f404e17d | |||
5398590939 | |||
96d5cfea14 | |||
79007ebd55 | |||
fcb519dac3 | |||
2b487aa959 | |||
733feadcb2 | |||
5ae568f19c | |||
0e51807856 | |||
b6eb165207 | |||
d26dbf4b3d | |||
e06ef01f72 | |||
a722582709 | |||
de64deb5c5 | |||
7de54a2cc4 | |||
c788b8cc82 | |||
cb8db1a541 | |||
8a7a551c3b | |||
84d180b810 | |||
de261a27ca | |||
28288a8f7b | |||
cd8548fc32 | |||
37dbd49589 | |||
5af8d67b62 | |||
72e6309c4a | |||
18f0f3cce1 | |||
8c3e9ff192 | |||
21d6d27435 | |||
39ff7913d6 | |||
402c6fc64a | |||
a1f934466c | |||
15aa114579 | |||
b9cc82e37d | |||
8af9c8b150 | |||
7dcc985222 | |||
9c2bc19897 | |||
801b08359a | |||
c469dee158 | |||
2aa7eda1e9 | |||
f1246c9e00 | |||
2749cbe4d1 | |||
d2a9280ab3 | |||
8e25ee0fc9 | |||
55026f913b | |||
7cc40e2453 | |||
cb6b19952d | |||
983af57842 | |||
3c2820dc31 | |||
1c25b69160 | |||
641cc38ae4 | |||
cd68b07e19 | |||
2b252c9abb | |||
b742ed73aa |
@ -158,6 +158,79 @@
|
|||||||
"contributions": [
|
"contributions": [
|
||||||
"code"
|
"code"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "zavoloklom",
|
||||||
|
"name": "Sergey Kupletsky",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/4151869?v=4",
|
||||||
|
"profile": "https://github.com/zavoloklom",
|
||||||
|
"contributions": [
|
||||||
|
"test",
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "rome-user",
|
||||||
|
"name": "rome-user",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/114131048?v=4",
|
||||||
|
"profile": "https://github.com/rome-user",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "celinepelletier",
|
||||||
|
"name": "Céline Pelletier",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/82821620?v=4",
|
||||||
|
"profile": "https://github.com/celinepelletier",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "xgp",
|
||||||
|
"name": "Garth",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/244253?v=4",
|
||||||
|
"profile": "https://github.com/xgp",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "BlackVoid",
|
||||||
|
"name": "Felix Gustavsson",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/673720?v=4",
|
||||||
|
"profile": "https://github.com/BlackVoid",
|
||||||
|
"contributions": [
|
||||||
|
"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,
|
||||||
@ -165,5 +238,6 @@
|
|||||||
"repoType": "github",
|
"repoType": "github",
|
||||||
"repoHost": "https://github.com",
|
"repoHost": "https://github.com",
|
||||||
"projectName": "keycloakify",
|
"projectName": "keycloakify",
|
||||||
"projectOwner": "keycloakify"
|
"projectOwner": "keycloakify",
|
||||||
|
"commitType": "docs"
|
||||||
}
|
}
|
||||||
|
6
.github/workflows/ci.yaml
vendored
6
.github/workflows/ci.yaml
vendored
@ -3,6 +3,9 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
- v5
|
||||||
|
- v6
|
||||||
|
- v7
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
@ -34,7 +37,7 @@ jobs:
|
|||||||
- uses: bahmutov/npm-install@v1
|
- uses: bahmutov/npm-install@v1
|
||||||
- run: yarn build
|
- run: yarn build
|
||||||
- run: yarn test
|
- run: yarn test
|
||||||
- run: yarn test:keycloakify-starter
|
#- run: yarn test:keycloakify-starter
|
||||||
|
|
||||||
storybook:
|
storybook:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@ -74,7 +77,6 @@ jobs:
|
|||||||
id: step1
|
id: step1
|
||||||
with:
|
with:
|
||||||
action_name: is_package_json_version_upgraded
|
action_name: is_package_json_version_upgraded
|
||||||
branch: ${{ github.head_ref || github.ref }}
|
|
||||||
|
|
||||||
create_github_release:
|
create_github_release:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
82
README.md
82
README.md
@ -36,22 +36,12 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<i>This build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
|
<i>This build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
|
||||||
<img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
|
<br/>
|
||||||
|
<br/>
|
||||||
|
<img width="400" src="https://github.com/keycloakify/keycloakify/assets/6702424/e66d105c-c06f-47d1-8a31-a6ab09da4e80">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
> Whether or not React is your preferred framework, Keycloakify
|
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)!
|
||||||
> offers a solid option for building Keycloak themes.
|
|
||||||
> It's not just a convenient way to create a Keycloak theme
|
|
||||||
> when using React; it's a well-regarded solution that many
|
|
||||||
> developers appreciate.
|
|
||||||
|
|
||||||
> 📣 🛑 Account themes generated by Keycloakify are not currently compatible with Keycloak 22.
|
|
||||||
> We are working on a solution. [Follow progress](https://github.com/keycloakify/keycloakify/issues/389).
|
|
||||||
> Login and email themes are not affected.
|
|
||||||
|
|
||||||
Keycloakify is fully compatible with Keycloak, starting from version 11 and is anticipated to maintain compatibility with all future versions.
|
|
||||||
You can update your Keycloak, your Keycloakify generated theme won't break.
|
|
||||||
To understand the basis of my confidence in this, you can [visit this discussion thread where I've explained in detail](https://github.com/keycloakify/keycloakify/discussions/346#discussioncomment-5889791).
|
|
||||||
|
|
||||||
## Sponsor 👼
|
## Sponsor 👼
|
||||||
|
|
||||||
@ -114,6 +104,16 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
<td align="center" valign="top" width="14.28%"><a href="https://www.gravitysoftware.be"><img src="https://avatars.githubusercontent.com/u/1140574?v=4?s=100" width="100px;" alt="Thomas Silvestre"/><br /><sub><b>Thomas Silvestre</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=thosil" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://www.gravitysoftware.be"><img src="https://avatars.githubusercontent.com/u/1140574?v=4?s=100" width="100px;" alt="Thomas Silvestre"/><br /><sub><b>Thomas Silvestre</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=thosil" title="Code">💻</a></td>
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/satanshiro"><img src="https://avatars.githubusercontent.com/u/38865738?v=4?s=100" width="100px;" alt="satanshiro"/><br /><sub><b>satanshiro</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=satanshiro" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/satanshiro"><img src="https://avatars.githubusercontent.com/u/38865738?v=4?s=100" width="100px;" alt="satanshiro"/><br /><sub><b>satanshiro</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=satanshiro" title="Code">💻</a></td>
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://poelhekke.dev"><img src="https://avatars.githubusercontent.com/u/1632377?v=4?s=100" width="100px;" alt="Koen Poelhekke"/><br /><sub><b>Koen Poelhekke</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kpoelhekke" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://poelhekke.dev"><img src="https://avatars.githubusercontent.com/u/1632377?v=4?s=100" width="100px;" alt="Koen Poelhekke"/><br /><sub><b>Koen Poelhekke</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kpoelhekke" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/zavoloklom"><img src="https://avatars.githubusercontent.com/u/4151869?v=4?s=100" width="100px;" alt="Sergey Kupletsky"/><br /><sub><b>Sergey Kupletsky</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=zavoloklom" title="Tests">⚠️</a> <a href="https://github.com/keycloakify/keycloakify/commits?author=zavoloklom" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rome-user"><img src="https://avatars.githubusercontent.com/u/114131048?v=4?s=100" width="100px;" alt="rome-user"/><br /><sub><b>rome-user</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=rome-user" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/celinepelletier"><img src="https://avatars.githubusercontent.com/u/82821620?v=4?s=100" width="100px;" alt="Céline Pelletier"/><br /><sub><b>Céline Pelletier</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=celinepelletier" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/xgp"><img src="https://avatars.githubusercontent.com/u/244253?v=4?s=100" width="100px;" alt="Garth"/><br /><sub><b>Garth</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=xgp" title="Code">💻</a></td>
|
||||||
|
</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://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>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
@ -125,15 +125,33 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
|
|
||||||
# Changelog highlights
|
# Changelog highlights
|
||||||
|
|
||||||
|
## 9.0
|
||||||
|
|
||||||
|
Bring back support for account themes in Keycloak v23 and up! [See issue](https://github.com/keycloakify/keycloakify/issues/389).
|
||||||
|
|
||||||
|
### Breaking changes
|
||||||
|
|
||||||
|
Very few. Check them out [here](https://docs.keycloakify.dev/migration-guides/v8-greater-than-v9).
|
||||||
|
|
||||||
|
## 8.0
|
||||||
|
|
||||||
|
- Much smaller .jar size. 70.2 MB -> 7.8 MB.
|
||||||
|
Keycloakify now detects which of the static resources from the default theme are actually used by your theme and only include those in the .jar.
|
||||||
|
- Build time: The first build is slowed but the subsequent build are faster. [Update your CI so that the cache is persisted across CI build](https://github.com/keycloakify/keycloakify-starter/commit/bc378d5afb67e796f520afbc348185f3e319d9d0).
|
||||||
|
|
||||||
|
### Breaking changes
|
||||||
|
|
||||||
|
There are very few breaking changes in this major version. [Check them out](https://docs.keycloakify.dev/migration-guides/v7-greater-than-v8).
|
||||||
|
|
||||||
## 7.15
|
## 7.15
|
||||||
|
|
||||||
- The i18n messages you defines in your theme are now also maid available to Keycloak.
|
- The i18n messages you defines in your theme are now also maid available to Keycloak.
|
||||||
In practice this mean that you can now customize the `kcContext.message.summary` that
|
In practice this mean that you can now customize the `kcContext.message.summary` that
|
||||||
display a general alert and the values returned by `kcContext.messagesPerField.get()` that
|
display a general alert and the values returned by `kcContext.messagesPerField.get()` that
|
||||||
are used to display specific error on some field of the form.
|
are used to display specific error on some field of the form.
|
||||||
[See video](https://youtu.be/D6tZcemReTI)
|
[See video](https://youtu.be/D6tZcemReTI)
|
||||||
|
|
||||||
## 7.14
|
## 7.14
|
||||||
|
|
||||||
- Deprecate the `extraPages` build option. Keycloakify is now able to analyze your code to detect extra pages.
|
- Deprecate the `extraPages` build option. Keycloakify is now able to analyze your code to detect extra pages.
|
||||||
|
|
||||||
@ -145,7 +163,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
## 7.12
|
## 7.12
|
||||||
|
|
||||||
- You can now pack multiple themes variant in a single `.jar` bundle. In vanilla Keycloak themes you have the ability to extend a base theme.
|
- You can now pack multiple themes variant in a single `.jar` bundle. In vanilla Keycloak themes you have the ability to extend a base theme.
|
||||||
There is now an idiomatic way of achieving the same result. [Learn more](https://docs.keycloakify.dev/build-options#keycloakify.extrathemenames).
|
There is now an idiomatic way of achieving the same result. [Learn more](https://docs.keycloakify.dev/build-options#keycloakify.themeVariantNames).
|
||||||
|
|
||||||
## 7.9
|
## 7.9
|
||||||
|
|
||||||
@ -240,79 +258,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.
|
||||||
|
@ -1,73 +0,0 @@
|
|||||||
{
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "https://json.schemastore.org/package.json"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "keycloakifyPackageJsonSchema"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"$ref": "#/definitions/keycloakifyPackageJsonSchema",
|
|
||||||
"definitions": {
|
|
||||||
"keycloakifyPackageJsonSchema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"version": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"homepage": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"keycloakify": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"extraPages": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"extraThemeProperties": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"areAppAndKeycloakServerSharingSameDomain": {
|
|
||||||
"type": "boolean"
|
|
||||||
},
|
|
||||||
"artifactId": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"groupId": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"bundler": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": ["mvn", "keycloakify", "none"]
|
|
||||||
},
|
|
||||||
"keycloakVersionDefaultAssets": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"reactAppBuildDirPath": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"keycloakifyBuildDirPath": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"themeName": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": ["name", "version"],
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
||||||
}
|
|
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "keycloakify",
|
"name": "keycloakify",
|
||||||
"version": "7.15.10",
|
"version": "9.1.11",
|
||||||
"description": "Create Keycloak themes using React",
|
"description": "Create Keycloak themes using React",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -13,7 +13,7 @@
|
|||||||
"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-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",
|
"copy-files": "copyfiles -u 1 src/**/*.ftl src/**/*.java",
|
||||||
"test": "yarn test:types && vitest run",
|
"test": "yarn test:types && vitest run",
|
||||||
"test:keycloakify-starter": "ts-node scripts/test-keycloakify-starter",
|
"test:keycloakify-starter": "ts-node scripts/test-keycloakify-starter",
|
||||||
"test:types": "tsc -p test/tsconfig.json --noEmit",
|
"test:types": "tsc -p test/tsconfig.json --noEmit",
|
||||||
|
@ -17,7 +17,7 @@ const isSilent = true;
|
|||||||
const logger = getLogger({ isSilent });
|
const logger = getLogger({ isSilent });
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const keycloakVersion = "21.0.1";
|
const keycloakVersion = "23.0.4";
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
||||||
|
|
||||||
@ -26,7 +26,9 @@ async function main() {
|
|||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath,
|
||||||
isSilent
|
"buildOptions": {
|
||||||
|
"cacheDirPath": pathJoin(getProjectRoot(), "node_modules", ".cache", "keycloakify")
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
type Dictionary = { [idiomId: string]: string };
|
type Dictionary = { [idiomId: string]: string };
|
||||||
|
@ -17,10 +17,12 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
|
|
||||||
const { isReady } = usePrepareTemplate({
|
const { isReady } = usePrepareTemplate({
|
||||||
"doFetchDefaultThemeResources": doUseDefaultCss,
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
url,
|
"styles": [
|
||||||
"stylesCommon": ["node_modules/patternfly/dist/css/patternfly.min.css", "node_modules/patternfly/dist/css/patternfly-additions.min.css"],
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
"styles": ["css/account.css"],
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
"htmlClassName": undefined,
|
`${url.resourcesPath}/css/account.css`
|
||||||
|
],
|
||||||
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
"bodyClassName": clsx("admin-console", "user", getClassName("kcBodyClass"))
|
"bodyClassName": clsx("admin-console", "user", getClassName("kcBodyClass"))
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -11,4 +11,4 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey = "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
export type ClassKey = "kcHtmlClass" | "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
||||||
|
@ -1,11 +1,13 @@
|
|||||||
import type { AccountThemePageId, ThemeType } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { AccountThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { Equals } from "tsafe";
|
import type { Equals } from "tsafe";
|
||||||
|
import { type ThemeType } from "keycloakify/bin/constants";
|
||||||
|
|
||||||
export type KcContext = KcContext.Password | KcContext.Account;
|
export type KcContext = KcContext.Password | KcContext.Account;
|
||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
|
themeVersion: string;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
themeType: "account";
|
themeType: "account";
|
||||||
themeName: string;
|
themeName: string;
|
||||||
|
@ -3,9 +3,8 @@ import { deepAssign } from "keycloakify/tools/deepAssign";
|
|||||||
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 { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
import { pathBasename } from "keycloakify/tools/pathBasename";
|
|
||||||
import { resourcesCommonDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
|
||||||
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?: {
|
||||||
@ -89,11 +88,7 @@ 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);
|
||||||
const { url } = realKcContext;
|
|
||||||
|
|
||||||
url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(resourcesCommonDirPathRelativeToPublicDir));
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
@ -1,18 +1,21 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import { resourcesCommonDirPathRelativeToPublicDir, resourcesDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
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";
|
||||||
|
|
||||||
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
||||||
|
|
||||||
|
const resourcesPath = pathJoin(PUBLIC_URL, keycloak_resources, "account", "resources");
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
|
"themeVersion": "0.0.0",
|
||||||
"keycloakifyVersion": "0.0.0",
|
"keycloakifyVersion": "0.0.0",
|
||||||
"themeType": "account",
|
"themeType": "account",
|
||||||
"themeName": "my-theme-name",
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
"resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
|
resourcesPath,
|
||||||
"resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
|
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
||||||
"resourceUrl": "#",
|
"resourceUrl": "#",
|
||||||
"accountUrl": "#",
|
"accountUrl": "#",
|
||||||
"applicationsUrl": "#",
|
"applicationsUrl": "#",
|
||||||
@ -132,10 +135,6 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
],
|
],
|
||||||
"currentLanguageTag": "en"
|
"currentLanguageTag": "en"
|
||||||
},
|
},
|
||||||
"message": {
|
|
||||||
"type": "success",
|
|
||||||
"summary": "This is a test message"
|
|
||||||
},
|
|
||||||
"features": {
|
"features": {
|
||||||
"authorization": true,
|
"authorization": true,
|
||||||
"identityFederation": true,
|
"identityFederation": true,
|
||||||
|
@ -3,6 +3,7 @@ import type { ClassKey } from "keycloakify/account/TemplateProps";
|
|||||||
|
|
||||||
export const { useGetClassName } = createUseClassName<ClassKey>({
|
export const { useGetClassName } = createUseClassName<ClassKey>({
|
||||||
"defaultClasses": {
|
"defaultClasses": {
|
||||||
|
"kcHtmlClass": undefined,
|
||||||
"kcBodyClass": undefined,
|
"kcBodyClass": undefined,
|
||||||
"kcButtonClass": "btn",
|
"kcButtonClass": "btn",
|
||||||
"kcButtonPrimaryClass": "btn-primary",
|
"kcButtonPrimaryClass": "btn-primary",
|
||||||
|
@ -51,7 +51,7 @@ export default function Account(props: PageProps<Extract<KcContext, { pageId: "a
|
|||||||
id="username"
|
id="username"
|
||||||
name="username"
|
name="username"
|
||||||
disabled={!realm.editUsernameAllowed}
|
disabled={!realm.editUsernameAllowed}
|
||||||
value={account.username ?? ""}
|
defaultValue={account.username ?? ""}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -66,7 +66,7 @@ export default function Account(props: PageProps<Extract<KcContext, { pageId: "a
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="text" className="form-control" id="email" name="email" autoFocus value={account.email ?? ""} />
|
<input type="text" className="form-control" id="email" name="email" autoFocus defaultValue={account.email ?? ""} />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -79,7 +79,7 @@ export default function Account(props: PageProps<Extract<KcContext, { pageId: "a
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="text" className="form-control" id="firstName" name="firstName" value={account.firstName ?? ""} />
|
<input type="text" className="form-control" id="firstName" name="firstName" defaultValue={account.firstName ?? ""} />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -92,7 +92,7 @@ export default function Account(props: PageProps<Extract<KcContext, { pageId: "a
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="text" className="form-control" id="lastName" name="lastName" value={account.lastName ?? ""} />
|
<input type="text" className="form-control" id="lastName" name="lastName" defaultValue={account.lastName ?? ""} />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
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";
|
||||||
|
|
||||||
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
||||||
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
|
9
src/bin/constants.ts
Normal file
9
src/bin/constants.ts
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
export const keycloak_resources = "keycloak-resources";
|
||||||
|
export const resources_common = "resources-common";
|
||||||
|
export const lastKeycloakVersionWithAccountV1 = "21.1.2";
|
||||||
|
|
||||||
|
export const themeTypes = ["login", "account"] as const;
|
||||||
|
export const retrocompatPostfix = "_retrocompat";
|
||||||
|
export const accountV1 = "account-v1";
|
||||||
|
|
||||||
|
export type ThemeType = (typeof themeTypes)[number];
|
@ -2,37 +2,39 @@
|
|||||||
|
|
||||||
import { downloadKeycloakStaticResources } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
|
import { downloadKeycloakStaticResources } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { basenameOfKeycloakDirInPublicDir } from "./mockTestingResourcesPath";
|
|
||||||
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
||||||
import { themeTypes } from "./keycloakify/generateFtl";
|
import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const projectDirPath = process.cwd();
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
"processArgv": process.argv.slice(2),
|
reactAppRootDirPath,
|
||||||
"projectDirPath": process.cwd()
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
const keycloakDirInPublicDir = pathJoin(process.env["PUBLIC_DIR_PATH"] || pathJoin(projectDirPath, "public"), basenameOfKeycloakDirInPublicDir);
|
const reservedDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
|
||||||
|
|
||||||
if (fs.existsSync(keycloakDirInPublicDir)) {
|
|
||||||
console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} already exists.`);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const themeType of themeTypes) {
|
for (const themeType of themeTypes) {
|
||||||
await downloadKeycloakStaticResources({
|
await downloadKeycloakStaticResources({
|
||||||
"isSilent": false,
|
"keycloakVersion": (() => {
|
||||||
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
switch (themeType) {
|
||||||
"themeType": themeType,
|
case "login":
|
||||||
"themeDirPath": keycloakDirInPublicDir
|
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
||||||
|
case "account":
|
||||||
|
return lastKeycloakVersionWithAccountV1;
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
themeType,
|
||||||
|
"themeDirPath": reservedDirPath,
|
||||||
|
"usedResources": undefined,
|
||||||
|
buildOptions
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(keycloakDirInPublicDir, "README.txt"),
|
pathJoin(reservedDirPath, "README.txt"),
|
||||||
Buffer.from(
|
Buffer.from(
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
[
|
[
|
||||||
@ -42,7 +44,7 @@ import * as fs from "fs";
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(keycloakDirInPublicDir, ".gitignore"), Buffer.from("*", "utf8"));
|
fs.writeFileSync(pathJoin(buildOptions.publicDirPath, "keycloak-resources", ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
|
|
||||||
console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} directory created.`);
|
console.log(`${pathRelative(reactAppRootDirPath, reservedDirPath)} directory created.`);
|
||||||
})();
|
})();
|
||||||
|
@ -4,24 +4,96 @@ import { downloadAndUnzip } from "./tools/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 } from "./keycloakify/BuildOptions";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "./keycloakify/BuildOptions";
|
||||||
|
import * as child_process from "child_process";
|
||||||
|
import * as fs from "fs";
|
||||||
|
|
||||||
export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; isSilent: boolean }) {
|
export type BuildOptionsLike = {
|
||||||
const { keycloakVersion, destDirPath } = params;
|
cacheDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
await Promise.all(
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
["", "-community"].map(ext =>
|
|
||||||
downloadAndUnzip({
|
export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
|
||||||
"destDirPath": destDirPath,
|
const { keycloakVersion, destDirPath, buildOptions } = params;
|
||||||
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
|
||||||
"pathOfDirToExtractInArchive": `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`
|
await downloadAndUnzip({
|
||||||
})
|
"doUseCache": true,
|
||||||
)
|
"cacheDirPath": buildOptions.cacheDirPath,
|
||||||
);
|
destDirPath,
|
||||||
|
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
||||||
|
"specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
|
||||||
|
"preCacheTransform": {
|
||||||
|
"actionCacheId": "npm install and build",
|
||||||
|
"action": async ({ destDirPath }) => {
|
||||||
|
install_common_node_modules: {
|
||||||
|
const commonResourcesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
|
||||||
|
|
||||||
|
if (!fs.existsSync(commonResourcesDirPath)) {
|
||||||
|
break install_common_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!fs.existsSync(pathJoin(commonResourcesDirPath, "package.json"))) {
|
||||||
|
break install_common_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (fs.existsSync(pathJoin(commonResourcesDirPath, "node_modules"))) {
|
||||||
|
break install_common_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
child_process.execSync("npm install --omit=dev", {
|
||||||
|
"cwd": commonResourcesDirPath,
|
||||||
|
"stdio": "ignore"
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
install_and_move_to_common_resources_generated_in_keycloak_v2: {
|
||||||
|
const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
|
||||||
|
|
||||||
|
if (!fs.existsSync(accountV2DirSrcDirPath)) {
|
||||||
|
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
||||||
|
}
|
||||||
|
|
||||||
|
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 packageJsonRaw = fs.readFileSync(packageJsonFilePath);
|
||||||
|
|
||||||
|
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
||||||
|
|
||||||
|
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
||||||
|
.replace(`${packageManager} run check-types`, "true")
|
||||||
|
.replace(`${packageManager} run babel`, "true");
|
||||||
|
|
||||||
|
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
||||||
|
|
||||||
|
child_process.execSync(`${packageManager} run build`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
|
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
||||||
|
|
||||||
|
fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
"projectDirPath": process.cwd(),
|
"reactAppRootDirPath": process.cwd(),
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -35,7 +107,7 @@ async function main() {
|
|||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
destDirPath,
|
destDirPath,
|
||||||
"isSilent": buildOptions.isSilent
|
buildOptions
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2,14 +2,7 @@
|
|||||||
|
|
||||||
import { getProjectRoot } from "./tools/getProjectRoot";
|
import { getProjectRoot } from "./tools/getProjectRoot";
|
||||||
import cliSelect from "cli-select";
|
import cliSelect from "cli-select";
|
||||||
import {
|
import { loginThemePageIds, accountThemePageIds, type LoginThemePageId, type AccountThemePageId } from "./keycloakify/generateFtl";
|
||||||
loginThemePageIds,
|
|
||||||
accountThemePageIds,
|
|
||||||
type LoginThemePageId,
|
|
||||||
type AccountThemePageId,
|
|
||||||
themeTypes,
|
|
||||||
type ThemeType
|
|
||||||
} from "./keycloakify/generateFtl";
|
|
||||||
import { capitalize } from "tsafe/capitalize";
|
import { capitalize } from "tsafe/capitalize";
|
||||||
import { readFile, writeFile } from "fs/promises";
|
import { readFile, writeFile } from "fs/promises";
|
||||||
import { existsSync } from "fs";
|
import { existsSync } from "fs";
|
||||||
@ -17,10 +10,13 @@ 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 "./getSrcDirPath";
|
||||||
|
import { themeTypes, type ThemeType } from "./constants";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
console.log("Select a theme type");
|
console.log("Select a theme type");
|
||||||
|
|
||||||
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
const { value: themeType } = await cliSelect<ThemeType>({
|
const { value: themeType } = await cliSelect<ThemeType>({
|
||||||
"values": [...themeTypes]
|
"values": [...themeTypes]
|
||||||
}).catch(() => {
|
}).catch(() => {
|
||||||
@ -49,7 +45,7 @@ import { getThemeSrcDirPath } from "./getSrcDirPath";
|
|||||||
|
|
||||||
const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
|
const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ "projectDirPath": process.cwd() });
|
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
|
const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
|
||||||
|
|
||||||
|
@ -2,25 +2,25 @@ import * as fs from "fs";
|
|||||||
import { exclude } from "tsafe";
|
import { exclude } from "tsafe";
|
||||||
import { crawl } from "./tools/crawl";
|
import { crawl } from "./tools/crawl";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { themeTypes } from "./keycloakify/generateFtl";
|
import { themeTypes } from "./constants";
|
||||||
|
|
||||||
const themeSrcDirBasename = "keycloak-theme";
|
const themeSrcDirBasenames = ["keycloak-theme", "keycloak_theme"];
|
||||||
|
|
||||||
/** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
|
/** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
|
||||||
export function getThemeSrcDirPath(params: { projectDirPath: string }) {
|
export function getThemeSrcDirPath(params: { reactAppRootDirPath: string }) {
|
||||||
const { projectDirPath } = params;
|
const { reactAppRootDirPath } = params;
|
||||||
|
|
||||||
const srcDirPath = pathJoin(projectDirPath, "src");
|
const srcDirPath = pathJoin(reactAppRootDirPath, "src");
|
||||||
|
|
||||||
const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
|
const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
|
||||||
.map(fileRelativePath => {
|
.map(fileRelativePath => {
|
||||||
const split = fileRelativePath.split(themeSrcDirBasename);
|
for (const themeSrcDirBasename of themeSrcDirBasenames) {
|
||||||
|
const split = fileRelativePath.split(themeSrcDirBasename);
|
||||||
if (split.length !== 2) {
|
if (split.length === 2) {
|
||||||
return undefined;
|
return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
return undefined;
|
||||||
return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
|
|
||||||
})
|
})
|
||||||
.filter(exclude(undefined))[0];
|
.filter(exclude(undefined))[0];
|
||||||
|
|
||||||
@ -38,7 +38,7 @@ export function getThemeSrcDirPath(params: { projectDirPath: string }) {
|
|||||||
console.error(
|
console.error(
|
||||||
[
|
[
|
||||||
"Can't locate your theme source directory. It should be either: ",
|
"Can't locate your theme source directory. It should be either: ",
|
||||||
"src/ or src/keycloak-theme.",
|
"src/ or src/keycloak-theme or src/keycloak_theme.",
|
||||||
"Example in the starter: https://github.com/keycloakify/keycloakify-starter/tree/main/src/keycloak-theme"
|
"Example in the starter: https://github.com/keycloakify/keycloakify-starter/tree/main/src/keycloak-theme"
|
||||||
].join("\n")
|
].join("\n")
|
||||||
);
|
);
|
||||||
|
@ -10,15 +10,17 @@ import { getLogger } from "./tools/logger";
|
|||||||
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const { isSilent } = readBuildOptions({
|
const reactAppRootDirPath = process.cwd();
|
||||||
"projectDirPath": process.cwd(),
|
|
||||||
|
const buildOptions = readBuildOptions({
|
||||||
|
reactAppRootDirPath,
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
const logger = getLogger({ isSilent });
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({
|
const { themeSrcDirPath } = getThemeSrcDirPath({
|
||||||
"projectDirPath": process.cwd()
|
reactAppRootDirPath
|
||||||
});
|
});
|
||||||
|
|
||||||
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
@ -36,7 +38,7 @@ export async function main() {
|
|||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
||||||
isSilent
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
|
@ -1,231 +1,157 @@
|
|||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { id } from "tsafe/id";
|
|
||||||
import { parse as urlParse } from "url";
|
import { parse as urlParse } from "url";
|
||||||
import { typeGuard } from "tsafe/typeGuard";
|
import { getParsedPackageJson } from "./parsedPackageJson";
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { join as pathJoin } from "path";
|
||||||
import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
|
|
||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin, sep as pathSep } from "path";
|
|
||||||
import parseArgv from "minimist";
|
import parseArgv from "minimist";
|
||||||
|
import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
|
||||||
|
|
||||||
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
||||||
export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets;
|
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 namespace BuildOptions {
|
export function readBuildOptions(params: { reactAppRootDirPath: string; processArgv: string[] }): BuildOptions {
|
||||||
export type Common = {
|
const { reactAppRootDirPath, processArgv } = params;
|
||||||
isSilent: boolean;
|
|
||||||
themeVersion: string;
|
|
||||||
themeName: string;
|
|
||||||
extraThemeNames: string[];
|
|
||||||
extraThemeProperties: string[] | undefined;
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
bundler: Bundler;
|
|
||||||
keycloakVersionDefaultAssets: 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;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
const { isSilentCliParamProvided } = (() => {
|
||||||
isStandalone: true;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
|
|
||||||
|
|
||||||
export namespace ExternalAssets {
|
|
||||||
export type CommonExternalAssets = Common & {
|
|
||||||
isStandalone: false;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type SameDomain = CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type DifferentDomains = CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function readBuildOptions(params: { projectDirPath: string; processArgv: string[] }): BuildOptions {
|
|
||||||
const { projectDirPath, processArgv } = params;
|
|
||||||
|
|
||||||
const { isExternalAssetsCliParamProvided, isSilentCliParamProvided } = (() => {
|
|
||||||
const argv = parseArgv(processArgv);
|
const argv = parseArgv(processArgv);
|
||||||
|
|
||||||
return {
|
return {
|
||||||
"isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false,
|
"isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false
|
||||||
"isExternalAssetsCliParamProvided": typeof argv["external-assets"] === "boolean" ? argv["external-assets"] : false
|
|
||||||
};
|
};
|
||||||
})();
|
})();
|
||||||
|
|
||||||
const parsedPackageJson = getParsedPackageJson({ projectDirPath });
|
const parsedPackageJson = getParsedPackageJson({ reactAppRootDirPath });
|
||||||
|
|
||||||
const url = (() => {
|
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
||||||
const { homepage } = parsedPackageJson;
|
|
||||||
|
|
||||||
let url: URL | undefined = undefined;
|
const { extraThemeProperties, groupId, artifactId, doCreateJar, loginThemeResourcesFromKeycloakVersion } = keycloakify ?? {};
|
||||||
|
|
||||||
if (homepage !== undefined) {
|
const themeNames = (() => {
|
||||||
url = new URL(homepage);
|
if (keycloakify.themeName === undefined) {
|
||||||
|
return [
|
||||||
|
name
|
||||||
|
.replace(/^@(.*)/, "$1")
|
||||||
|
.split("/")
|
||||||
|
.join("-")
|
||||||
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
const CNAME = (() => {
|
if (typeof keycloakify.themeName === "string") {
|
||||||
const cnameFilePath = pathJoin(projectDirPath, "public", "CNAME");
|
return [keycloakify.themeName];
|
||||||
|
}
|
||||||
|
|
||||||
if (!fs.existsSync(cnameFilePath)) {
|
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;
|
return undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
return fs.readFileSync(cnameFilePath).toString("utf8");
|
const out = url.pathname.replace(/([^/])$/, "$1/");
|
||||||
})();
|
return out === "/" ? undefined : out;
|
||||||
|
})(),
|
||||||
if (CNAME !== undefined) {
|
"doBuildRetrocompatAccountTheme": parsedPackageJson.keycloakify?.doBuildRetrocompatAccountTheme ?? true
|
||||||
url = new URL(`https://${CNAME.replace(/\s+$/, "")}`);
|
};
|
||||||
}
|
|
||||||
|
|
||||||
if (url === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"origin": url.origin,
|
|
||||||
"pathname": (() => {
|
|
||||||
const out = url.pathname.replace(/([^/])$/, "$1/");
|
|
||||||
|
|
||||||
return out === "/" ? undefined : out;
|
|
||||||
})()
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
const common: BuildOptions.Common = (() => {
|
|
||||||
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
|
||||||
|
|
||||||
const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
|
|
||||||
|
|
||||||
const themeName =
|
|
||||||
keycloakify.themeName ??
|
|
||||||
name
|
|
||||||
.replace(/^@(.*)/, "$1")
|
|
||||||
.split("/")
|
|
||||||
.join("-");
|
|
||||||
|
|
||||||
return {
|
|
||||||
themeName,
|
|
||||||
extraThemeNames,
|
|
||||||
"bundler": (() => {
|
|
||||||
const { KEYCLOAKIFY_BUNDLER } = process.env;
|
|
||||||
|
|
||||||
assert(
|
|
||||||
typeGuard<Bundler | undefined>(
|
|
||||||
KEYCLOAKIFY_BUNDLER,
|
|
||||||
[undefined, ...id<readonly string[]>(bundlers)].includes(KEYCLOAKIFY_BUNDLER)
|
|
||||||
),
|
|
||||||
`${symToStr({ KEYCLOAKIFY_BUNDLER })} should be one of ${bundlers.join(", ")}`
|
|
||||||
);
|
|
||||||
|
|
||||||
return KEYCLOAKIFY_BUNDLER ?? bundler ?? "keycloakify";
|
|
||||||
})(),
|
|
||||||
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeName}-keycloak-theme`,
|
|
||||||
"groupId": (() => {
|
|
||||||
const fallbackGroupId = `${themeName}.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,
|
|
||||||
"keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
|
|
||||||
"reactAppBuildDirPath": (() => {
|
|
||||||
let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
|
|
||||||
|
|
||||||
if (reactAppBuildDirPath === undefined) {
|
|
||||||
return pathJoin(projectDirPath, "build");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (pathSep === "\\") {
|
|
||||||
reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
|
|
||||||
return pathJoin(projectDirPath, reactAppBuildDirPath);
|
|
||||||
}
|
|
||||||
|
|
||||||
return reactAppBuildDirPath;
|
|
||||||
})(),
|
|
||||||
"keycloakifyBuildDirPath": (() => {
|
|
||||||
let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
|
|
||||||
|
|
||||||
if (keycloakifyBuildDirPath === undefined) {
|
|
||||||
return pathJoin(projectDirPath, "build_keycloak");
|
|
||||||
}
|
|
||||||
|
|
||||||
if (pathSep === "\\") {
|
|
||||||
keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
|
|
||||||
return pathJoin(projectDirPath, keycloakifyBuildDirPath);
|
|
||||||
}
|
|
||||||
|
|
||||||
return keycloakifyBuildDirPath;
|
|
||||||
})()
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
if (isExternalAssetsCliParamProvided) {
|
|
||||||
const commonExternalAssets = id<BuildOptions.ExternalAssets.CommonExternalAssets>({
|
|
||||||
...common,
|
|
||||||
"isStandalone": false
|
|
||||||
});
|
|
||||||
|
|
||||||
if (parsedPackageJson.keycloakify?.areAppAndKeycloakServerSharingSameDomain) {
|
|
||||||
return id<BuildOptions.ExternalAssets.SameDomain>({
|
|
||||||
...commonExternalAssets,
|
|
||||||
"areAppAndKeycloakServerSharingSameDomain": true
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
assert(
|
|
||||||
url !== undefined,
|
|
||||||
[
|
|
||||||
"Can't compile in external assets mode if we don't know where",
|
|
||||||
"the app will be hosted.",
|
|
||||||
"You should provide a homepage field in the package.json (or create a",
|
|
||||||
"public/CNAME file.",
|
|
||||||
"Alternatively, if your app and the Keycloak server are on the same domain, ",
|
|
||||||
"eg https://example.com is your app and https://example.com/auth is the keycloak",
|
|
||||||
'admin UI, you can set "keycloakify": { "areAppAndKeycloakServerSharingSameDomain": true }',
|
|
||||||
"in your package.json"
|
|
||||||
].join(" ")
|
|
||||||
);
|
|
||||||
|
|
||||||
return id<BuildOptions.ExternalAssets.DifferentDomains>({
|
|
||||||
...commonExternalAssets,
|
|
||||||
"areAppAndKeycloakServerSharingSameDomain": false,
|
|
||||||
"urlOrigin": url.origin,
|
|
||||||
"urlPathname": url.pathname
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return id<BuildOptions.Standalone>({
|
|
||||||
...common,
|
|
||||||
"isStandalone": true,
|
|
||||||
"urlPathname": url?.pathname
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
@ -478,22 +478,27 @@
|
|||||||
"error.ftl" == pageId &&
|
"error.ftl" == pageId &&
|
||||||
are_same_path(path, ["realm"]) &&
|
are_same_path(path, ["realm"]) &&
|
||||||
!["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
|
!["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
|
||||||
|
) || (
|
||||||
|
"applications.ftl" == pageId &&
|
||||||
|
are_same_path(path, ["applications", "applications", "*", "client", "realm"])
|
||||||
|
) || (
|
||||||
|
"applications.ftl" == pageId &&
|
||||||
|
"masterAdminClient" == key
|
||||||
)
|
)
|
||||||
>
|
>
|
||||||
<#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
<#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#if key == "attemptedUsername" && are_same_path(path, ["auth"])>
|
<#if pageId == "register.ftl" && 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())>
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
<#recover>
|
||||||
</#attempt>
|
</#attempt>
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
|
@ -8,48 +8,17 @@ import { objectKeys } from "tsafe/objectKeys";
|
|||||||
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
|
||||||
export const themeTypes = ["login", "account"] as const;
|
export type BuildOptionsLike = {
|
||||||
|
themeVersion: string;
|
||||||
export type ThemeType = (typeof themeTypes)[number];
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
|
||||||
|
|
||||||
export namespace BuildOptionsLike {
|
|
||||||
export type Common = {
|
|
||||||
themeName: string;
|
|
||||||
themeVersion: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
|
||||||
isStandalone: true;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
|
|
||||||
|
|
||||||
export namespace ExternalAssets {
|
|
||||||
export type CommonExternalAssets = {
|
|
||||||
isStandalone: false;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type SameDomain = Common &
|
|
||||||
CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type DifferentDomains = Common &
|
|
||||||
CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export function generateFtlFilesCodeFactory(params: {
|
export function generateFtlFilesCodeFactory(params: {
|
||||||
|
themeName: string;
|
||||||
indexHtmlCode: string;
|
indexHtmlCode: string;
|
||||||
//NOTE: Expected to be an empty object if external assets mode is enabled.
|
//NOTE: Expected to be an empty object if external assets mode is enabled.
|
||||||
cssGlobalsToDefine: Record<string, string>;
|
cssGlobalsToDefine: Record<string, string>;
|
||||||
@ -58,27 +27,28 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
themeType: ThemeType;
|
themeType: ThemeType;
|
||||||
fieldNames: string[];
|
fieldNames: string[];
|
||||||
}) {
|
}) {
|
||||||
const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
|
const { themeName, cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
|
||||||
|
|
||||||
const $ = cheerio.load(indexHtmlCode);
|
const $ = cheerio.load(indexHtmlCode);
|
||||||
|
|
||||||
fix_imports_statements: {
|
fix_imports_statements: {
|
||||||
if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
|
|
||||||
break fix_imports_statements;
|
|
||||||
}
|
|
||||||
|
|
||||||
$("script:not([src])").each((...[, element]) => {
|
$("script:not([src])").each((...[, element]) => {
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
const jsCode = $(element).html();
|
||||||
"jsCode": $(element).html()!,
|
|
||||||
buildOptions
|
assert(jsCode !== null);
|
||||||
});
|
|
||||||
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({ jsCode });
|
||||||
|
|
||||||
$(element).text(fixedJsCode);
|
$(element).text(fixedJsCode);
|
||||||
});
|
});
|
||||||
|
|
||||||
$("style").each((...[, element]) => {
|
$("style").each((...[, element]) => {
|
||||||
|
const cssCode = $(element).html();
|
||||||
|
|
||||||
|
assert(cssCode !== null);
|
||||||
|
|
||||||
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
||||||
"cssCode": $(element).html()!,
|
cssCode,
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -100,9 +70,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
|
|
||||||
$(element).attr(
|
$(element).attr(
|
||||||
attrName,
|
attrName,
|
||||||
buildOptions.isStandalone
|
href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
|
||||||
? href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
|
|
||||||
: href.replace(/^\//, `${buildOptions.urlOrigin}/`)
|
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@ -133,7 +101,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
.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", buildOptions.themeName),
|
.replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName),
|
||||||
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
||||||
"<#if scripts??>",
|
"<#if scripts??>",
|
||||||
" <#list scripts as script>",
|
" <#list scripts as script>",
|
||||||
@ -153,6 +121,27 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
].join("\n")
|
].join("\n")
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Remove part of the document marked as ignored.
|
||||||
|
{
|
||||||
|
const startTags = $('meta[name="keycloakify-ignore-start"]');
|
||||||
|
|
||||||
|
startTags.each((...[, startTag]) => {
|
||||||
|
const $startTag = $(startTag);
|
||||||
|
const $endTag = $startTag.nextAll('meta[name="keycloakify-ignore-end"]').first();
|
||||||
|
|
||||||
|
if ($endTag.length) {
|
||||||
|
let currentNode = $startTag.next();
|
||||||
|
while (currentNode.length && !currentNode.is($endTag)) {
|
||||||
|
currentNode.remove();
|
||||||
|
currentNode = $startTag.next();
|
||||||
|
}
|
||||||
|
|
||||||
|
$startTag.remove();
|
||||||
|
$endTag.remove();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
const partiallyFixedIndexHtmlCode = $.html();
|
const partiallyFixedIndexHtmlCode = $.html();
|
||||||
|
|
||||||
function generateFtlFilesCode(params: { pageId: string }): {
|
function generateFtlFilesCode(params: { pageId: string }): {
|
||||||
|
@ -10,6 +10,8 @@ export const loginThemePageIds = [
|
|||||||
"login-reset-password.ftl",
|
"login-reset-password.ftl",
|
||||||
"login-verify-email.ftl",
|
"login-verify-email.ftl",
|
||||||
"terms.ftl",
|
"terms.ftl",
|
||||||
|
"login-oauth2-device-verify-user-code.ftl",
|
||||||
|
"login-oauth-grant.ftl",
|
||||||
"login-otp.ftl",
|
"login-otp.ftl",
|
||||||
"login-update-profile.ftl",
|
"login-update-profile.ftl",
|
||||||
"login-update-password.ftl",
|
"login-update-password.ftl",
|
||||||
|
@ -1,89 +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 } from "./generateFtl";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
themeName: string;
|
|
||||||
extraThemeNames: string[];
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
themeVersion: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function generateJavaStackFiles(params: {
|
|
||||||
keycloakThemeBuildingDirPath: string;
|
|
||||||
implementedThemeTypes: Record<ThemeType | "email", boolean>;
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
}): {
|
|
||||||
jarFilePath: string;
|
|
||||||
} {
|
|
||||||
const {
|
|
||||||
buildOptions: { groupId, themeName, extraThemeNames, themeVersion, artifactId },
|
|
||||||
keycloakThemeBuildingDirPath,
|
|
||||||
implementedThemeTypes
|
|
||||||
} = 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>${groupId}</groupId>`,
|
|
||||||
` <artifactId>${artifactId}</artifactId>`,
|
|
||||||
` <version>${themeVersion}</version>`,
|
|
||||||
` <name>${artifactId}</name>`,
|
|
||||||
` <description />`,
|
|
||||||
`</project>`
|
|
||||||
].join("\n");
|
|
||||||
|
|
||||||
return { pomFileCode };
|
|
||||||
})();
|
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(keycloakThemeBuildingDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const themeManifestFilePath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "META-INF", "keycloak-themes.json");
|
|
||||||
|
|
||||||
try {
|
|
||||||
fs.mkdirSync(pathDirname(themeManifestFilePath));
|
|
||||||
} catch {}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
themeManifestFilePath,
|
|
||||||
Buffer.from(
|
|
||||||
JSON.stringify(
|
|
||||||
{
|
|
||||||
"themes": [themeName, ...extraThemeNames].map(themeName => ({
|
|
||||||
"name": themeName,
|
|
||||||
"types": Object.entries(implementedThemeTypes)
|
|
||||||
.filter(([, isImplemented]) => isImplemented)
|
|
||||||
.map(([themeType]) => themeType)
|
|
||||||
}))
|
|
||||||
},
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${themeVersion}.jar`)
|
|
||||||
};
|
|
||||||
}
|
|
@ -0,0 +1,87 @@
|
|||||||
|
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"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
@ -0,0 +1,140 @@
|
|||||||
|
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
src/bin/keycloakify/generateJavaStackFiles/index.ts
Normal file
1
src/bin/keycloakify/generateJavaStackFiles/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./generateJavaStackFiles";
|
@ -1,12 +1,11 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } 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 { Reflect } from "tsafe/Reflect";
|
||||||
import type { BuildOptions } from "./BuildOptions";
|
import type { BuildOptions } from "./BuildOptions";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
themeName: string;
|
keycloakifyBuildDirPath: string;
|
||||||
extraThemeNames: string[];
|
|
||||||
};
|
};
|
||||||
|
|
||||||
{
|
{
|
||||||
@ -20,39 +19,42 @@ generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_contain
|
|||||||
const containerName = "keycloak-testing-container";
|
const containerName = "keycloak-testing-container";
|
||||||
|
|
||||||
/** 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: {
|
export function generateStartKeycloakTestingContainer(params: { jarFilePath: string; keycloakVersion: string; buildOptions: BuildOptionsLike }) {
|
||||||
keycloakVersion: string;
|
const { jarFilePath, keycloakVersion, buildOptions } = params;
|
||||||
keycloakThemeBuildingDirPath: string;
|
|
||||||
buildOptions: BuildOptionsLike;
|
const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
|
||||||
}) {
|
const themeDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, themeRelativeDirPath);
|
||||||
const {
|
|
||||||
keycloakThemeBuildingDirPath,
|
|
||||||
keycloakVersion,
|
|
||||||
buildOptions: { themeName, extraThemeNames }
|
|
||||||
} = params;
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename),
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename),
|
||||||
Buffer.from(
|
Buffer.from(
|
||||||
[
|
[
|
||||||
"#!/usr/bin/env bash",
|
"#!/usr/bin/env bash",
|
||||||
|
`# If you want to test with Keycloak version prior to 23 use the retrocompat-${pathBasename(jarFilePath)}`,
|
||||||
"",
|
"",
|
||||||
`docker rm ${containerName} || true`,
|
`docker rm ${containerName} || true`,
|
||||||
"",
|
"",
|
||||||
`cd "${keycloakThemeBuildingDirPath.replace(/\\/g, "/")}"`,
|
`cd "${buildOptions.keycloakifyBuildDirPath}"`,
|
||||||
"",
|
"",
|
||||||
"docker run \\",
|
"docker run \\",
|
||||||
" -p 8080:8080 \\",
|
" -p 8080:8080 \\",
|
||||||
` --name ${containerName} \\`,
|
` --name ${containerName} \\`,
|
||||||
" -e KEYCLOAK_ADMIN=admin \\",
|
" -e KEYCLOAK_ADMIN=admin \\",
|
||||||
" -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
|
" -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
|
||||||
...[themeName, ...extraThemeNames].map(
|
` -v "${pathJoin(
|
||||||
themeName =>
|
"$(pwd)",
|
||||||
` -v "${pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(
|
pathRelative(buildOptions.keycloakifyBuildDirPath, jarFilePath)
|
||||||
/\\/g,
|
)}":"/opt/keycloak/providers/${pathBasename(jarFilePath)}" \\`,
|
||||||
"/"
|
...fs
|
||||||
)}":"/opt/keycloak/themes/${themeName}":rw \\`
|
.readdirSync(themeDirPath)
|
||||||
),
|
.filter(name => fs.lstatSync(pathJoin(themeDirPath, name)).isDirectory())
|
||||||
|
.map(
|
||||||
|
themeName =>
|
||||||
|
` -v "${pathJoin("$(pwd)", themeRelativeDirPath, themeName).replace(
|
||||||
|
/\\/g,
|
||||||
|
"/"
|
||||||
|
)}":"/opt/keycloak/themes/${themeName}":rw \\`
|
||||||
|
),
|
||||||
` -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
|
` -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
|
||||||
` start-dev --features=declarative-user-profile`,
|
` start-dev --features=declarative-user-profile`,
|
||||||
""
|
""
|
||||||
|
@ -1,46 +1,88 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, dirname as pathDirname } from "path";
|
||||||
import type { ThemeType } from "../generateFtl";
|
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
import {
|
import { resources_common, type ThemeType } from "../../constants";
|
||||||
resourcesCommonDirPathRelativeToPublicDir,
|
import { BuildOptions } from "../BuildOptions";
|
||||||
resourcesDirPathRelativeToPublicDir,
|
import { assert } from "tsafe/assert";
|
||||||
basenameOfKeycloakDirInPublicDir
|
|
||||||
} from "../../mockTestingResourcesPath";
|
|
||||||
import * as crypto from "crypto";
|
import * as crypto from "crypto";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
cacheDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function downloadKeycloakStaticResources(
|
export async function downloadKeycloakStaticResources(
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
params: {
|
params: {
|
||||||
themeType: ThemeType;
|
themeType: ThemeType;
|
||||||
themeDirPath: string;
|
themeDirPath: string;
|
||||||
isSilent: boolean;
|
|
||||||
keycloakVersion: string;
|
keycloakVersion: string;
|
||||||
|
usedResources: {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} | undefined;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
}
|
}
|
||||||
) {
|
) {
|
||||||
const { themeType, isSilent, themeDirPath, keycloakVersion } = 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)}`
|
||||||
);
|
);
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath,
|
||||||
isSilent
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const resourcesPath = pathJoin(themeDirPath, themeType, "resources");
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
|
||||||
"destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesDirPathRelativeToPublicDir))
|
"destDirPath": resourcesPath
|
||||||
});
|
});
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
||||||
"destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesCommonDirPathRelativeToPublicDir))
|
"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 });
|
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import type { ThemeType } from "../generateFtl";
|
import type { ThemeType } from "../../constants";
|
||||||
import { crawl } from "../../tools/crawl";
|
import { crawl } from "../../tools/crawl";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { readFileSync } from "fs";
|
import { readFileSync } from "fs";
|
||||||
|
@ -1,67 +1,53 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin, basename as pathBasename, resolve as pathResolve } from "path";
|
||||||
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
||||||
import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
|
import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
|
||||||
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds, themeTypes, type ThemeType } from "../generateFtl";
|
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds } from "../generateFtl";
|
||||||
import { basenameOfKeycloakDirInPublicDir } from "../../mockTestingResourcesPath";
|
import { themeTypes, type ThemeType, lastKeycloakVersionWithAccountV1, keycloak_resources, retrocompatPostfix, accountV1 } from "../../constants";
|
||||||
import { isInside } from "../../tools/isInside";
|
import { isInside } from "../../tools/isInside";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
|
import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
|
||||||
import { readFieldNameUsage } from "./readFieldNameUsage";
|
import { readFieldNameUsage } from "./readFieldNameUsage";
|
||||||
import { readExtraPagesNames } from "./readExtraPageNames";
|
import { readExtraPagesNames } from "./readExtraPageNames";
|
||||||
import { generateMessageProperties } from "./generateMessageProperties";
|
import { generateMessageProperties } from "./generateMessageProperties";
|
||||||
|
import { readStaticResourcesUsage } from "./readStaticResourcesUsage";
|
||||||
|
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
export type BuildOptionsLike = {
|
||||||
|
extraThemeProperties: string[] | undefined;
|
||||||
export namespace BuildOptionsLike {
|
themeVersion: string;
|
||||||
export type Common = {
|
loginThemeResourcesFromKeycloakVersion: string;
|
||||||
themeName: string;
|
urlPathname: string | undefined;
|
||||||
extraThemeProperties: string[] | undefined;
|
keycloakifyBuildDirPath: string;
|
||||||
isSilent: boolean;
|
reactAppBuildDirPath: string;
|
||||||
themeVersion: string;
|
cacheDirPath: string;
|
||||||
keycloakVersionDefaultAssets: string;
|
doBuildRetrocompatAccountTheme: boolean;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type Standalone = Common & {
|
|
||||||
isStandalone: true;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
|
|
||||||
|
|
||||||
export namespace ExternalAssets {
|
|
||||||
export type CommonExternalAssets = Common & {
|
|
||||||
isStandalone: false;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type SameDomain = CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type DifferentDomains = CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function generateTheme(params: {
|
export async function generateTheme(params: {
|
||||||
reactAppBuildDirPath: string;
|
themeName: string;
|
||||||
keycloakThemeBuildingDirPath: string;
|
|
||||||
themeSrcDirPath: string;
|
themeSrcDirPath: string;
|
||||||
keycloakifySrcDirPath: string;
|
keycloakifySrcDirPath: string;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
}): Promise<void> {
|
}): Promise<void> {
|
||||||
const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
|
const { themeName, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
|
||||||
|
|
||||||
const getThemeDirPath = (themeType: ThemeType | "email") =>
|
const getThemeTypeDirPath = (params: { themeType: ThemeType | "email"; isRetrocompat?: true }) => {
|
||||||
pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
|
const { themeType, isRetrocompat = false } = params;
|
||||||
|
return pathJoin(
|
||||||
|
buildOptions.keycloakifyBuildDirPath,
|
||||||
|
"src",
|
||||||
|
"main",
|
||||||
|
"resources",
|
||||||
|
"theme",
|
||||||
|
`${themeName}${isRetrocompat ? retrocompatPostfix : ""}`,
|
||||||
|
themeType
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
let allCssGlobalsToDefine: Record<string, string> = {};
|
let allCssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
@ -72,24 +58,23 @@ export async function generateTheme(params: {
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
const themeDirPath = getThemeDirPath(themeType);
|
const themeTypeDirPath = getThemeTypeDirPath({ themeType });
|
||||||
|
|
||||||
copy_app_resources_to_theme_path: {
|
copy_app_resources_to_theme_path: {
|
||||||
const isFirstPass = themeType.indexOf(themeType) === 0;
|
const isFirstPass = themeType.indexOf(themeType) === 0;
|
||||||
|
|
||||||
if (!isFirstPass && !buildOptions.isStandalone) {
|
if (!isFirstPass) {
|
||||||
break copy_app_resources_to_theme_path;
|
break copy_app_resources_to_theme_path;
|
||||||
}
|
}
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"destDirPath": buildOptions.isStandalone ? pathJoin(themeDirPath, "resources", "build") : reactAppBuildDirPath,
|
"destDirPath": pathJoin(themeTypeDirPath, "resources", "build"),
|
||||||
"srcDirPath": reactAppBuildDirPath,
|
"srcDirPath": buildOptions.reactAppBuildDirPath,
|
||||||
"transformSourceCode": ({ filePath, sourceCode }) => {
|
"transformSourceCode": ({ filePath, sourceCode }) => {
|
||||||
//NOTE: Prevent cycles, excludes the folder we generated for debug in public/
|
//NOTE: Prevent cycles, excludes the folder we generated for debug in public/
|
||||||
if (
|
if (
|
||||||
buildOptions.isStandalone &&
|
|
||||||
isInside({
|
isInside({
|
||||||
"dirPath": pathJoin(reactAppBuildDirPath, basenameOfKeycloakDirInPublicDir),
|
"dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
|
||||||
filePath
|
filePath
|
||||||
})
|
})
|
||||||
) {
|
) {
|
||||||
@ -97,10 +82,6 @@ export async function generateTheme(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (/\.css?$/i.test(filePath)) {
|
if (/\.css?$/i.test(filePath)) {
|
||||||
if (!buildOptions.isStandalone) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
|
const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
|
||||||
"cssCode": sourceCode.toString("utf8")
|
"cssCode": sourceCode.toString("utf8")
|
||||||
});
|
});
|
||||||
@ -120,19 +101,14 @@ export async function generateTheme(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (/\.js?$/i.test(filePath)) {
|
if (/\.js?$/i.test(filePath)) {
|
||||||
if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
||||||
"jsCode": sourceCode.toString("utf8"),
|
"jsCode": sourceCode.toString("utf8")
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
||||||
}
|
}
|
||||||
|
|
||||||
return buildOptions.isStandalone ? { "modifiedSourceCode": sourceCode } : undefined;
|
return { "modifiedSourceCode": sourceCode };
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@ -141,7 +117,8 @@ export async function generateTheme(params: {
|
|||||||
generateFtlFilesCode_glob !== undefined
|
generateFtlFilesCode_glob !== undefined
|
||||||
? generateFtlFilesCode_glob
|
? generateFtlFilesCode_glob
|
||||||
: generateFtlFilesCodeFactory({
|
: generateFtlFilesCodeFactory({
|
||||||
"indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
|
themeName,
|
||||||
|
"indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
|
||||||
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
||||||
buildOptions,
|
buildOptions,
|
||||||
keycloakifyVersion,
|
keycloakifyVersion,
|
||||||
@ -169,69 +146,77 @@ export async function generateTheme(params: {
|
|||||||
].forEach(pageId => {
|
].forEach(pageId => {
|
||||||
const { ftlCode } = generateFtlFilesCode({ pageId });
|
const { ftlCode } = generateFtlFilesCode({ pageId });
|
||||||
|
|
||||||
fs.mkdirSync(themeDirPath, { "recursive": true });
|
fs.mkdirSync(themeTypeDirPath, { "recursive": true });
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
||||||
});
|
});
|
||||||
|
|
||||||
generateMessageProperties({
|
generateMessageProperties({
|
||||||
themeSrcDirPath,
|
themeSrcDirPath,
|
||||||
themeType
|
themeType
|
||||||
}).forEach(({ languageTag, propertiesFileSource }) => {
|
}).forEach(({ languageTag, propertiesFileSource }) => {
|
||||||
const messagesDirPath = pathJoin(themeDirPath, "messages");
|
const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
|
||||||
|
|
||||||
fs.mkdirSync(pathJoin(themeDirPath, "messages"), { "recursive": true });
|
fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
|
||||||
|
|
||||||
const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
|
const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
|
||||||
|
|
||||||
fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
|
fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
|
||||||
});
|
});
|
||||||
|
|
||||||
//TODO: Remove this block we left it for now only for backward compatibility
|
|
||||||
// we now have a separate script for this
|
|
||||||
copy_keycloak_resources_to_public: {
|
|
||||||
const keycloakDirInPublicDir = pathJoin(reactAppBuildDirPath, "..", "public", basenameOfKeycloakDirInPublicDir);
|
|
||||||
|
|
||||||
if (fs.existsSync(keycloakDirInPublicDir)) {
|
|
||||||
break copy_keycloak_resources_to_public;
|
|
||||||
}
|
|
||||||
|
|
||||||
await downloadKeycloakStaticResources({
|
|
||||||
"isSilent": buildOptions.isSilent,
|
|
||||||
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
|
||||||
"themeDirPath": keycloakDirInPublicDir,
|
|
||||||
themeType
|
|
||||||
});
|
|
||||||
|
|
||||||
if (themeType !== themeTypes[0]) {
|
|
||||||
break copy_keycloak_resources_to_public;
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(keycloakDirInPublicDir, "README.txt"),
|
|
||||||
Buffer.from(
|
|
||||||
// prettier-ignore
|
|
||||||
[
|
|
||||||
"This is just a test folder that helps develop",
|
|
||||||
"the login and register page without having to run a Keycloak container"
|
|
||||||
].join(" ")
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(keycloakDirInPublicDir, ".gitignore"), Buffer.from("*", "utf8"));
|
|
||||||
}
|
|
||||||
|
|
||||||
await downloadKeycloakStaticResources({
|
await downloadKeycloakStaticResources({
|
||||||
"isSilent": buildOptions.isSilent,
|
"keycloakVersion": (() => {
|
||||||
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
switch (themeType) {
|
||||||
themeDirPath,
|
case "account":
|
||||||
themeType
|
return lastKeycloakVersionWithAccountV1;
|
||||||
|
case "login":
|
||||||
|
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
"themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
|
||||||
|
themeType,
|
||||||
|
"usedResources": readStaticResourcesUsage({
|
||||||
|
keycloakifySrcDirPath,
|
||||||
|
themeSrcDirPath,
|
||||||
|
themeType
|
||||||
|
}),
|
||||||
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(themeDirPath, "theme.properties"),
|
pathJoin(themeTypeDirPath, "theme.properties"),
|
||||||
Buffer.from([`parent=keycloak`, ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
|
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: {
|
email: {
|
||||||
@ -243,7 +228,7 @@ export async function generateTheme(params: {
|
|||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": emailThemeSrcDirPath,
|
"srcDirPath": emailThemeSrcDirPath,
|
||||||
"destDirPath": getThemeDirPath("email")
|
"destDirPath": getThemeTypeDirPath({ "themeType": "email" })
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,9 +1,10 @@
|
|||||||
import { crawl } from "../../tools/crawl";
|
import { crawl } from "../../tools/crawl";
|
||||||
import { type ThemeType, accountThemePageIds, loginThemePageIds } from "../generateFtl";
|
import { accountThemePageIds, loginThemePageIds } from "../generateFtl";
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
|
||||||
export function readExtraPagesNames(params: { themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
export function readExtraPagesNames(params: { themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
||||||
const { themeSrcDirPath, themeType } = params;
|
const { themeSrcDirPath, themeType } = params;
|
||||||
|
@ -2,8 +2,7 @@ import { crawl } from "../../tools/crawl";
|
|||||||
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
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 "../generateFtl";
|
import type { ThemeType } from "../../constants";
|
||||||
import { exclude } from "tsafe/exclude";
|
|
||||||
|
|
||||||
/** Assumes the theme type exists */
|
/** Assumes the theme type exists */
|
||||||
export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
||||||
@ -11,9 +10,7 @@ export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; them
|
|||||||
|
|
||||||
const fieldNames: string[] = [];
|
const fieldNames: string[] = [];
|
||||||
|
|
||||||
for (const srcDirPath of ([pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)] as const).filter(
|
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
||||||
exclude(undefined)
|
|
||||||
)) {
|
|
||||||
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));
|
||||||
|
|
||||||
for (const filePath of filePaths) {
|
for (const filePath of filePaths) {
|
||||||
|
@ -0,0 +1,76 @@
|
|||||||
|
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,23 +1,21 @@
|
|||||||
import { generateTheme } from "./generateTheme";
|
import { generateTheme } from "./generateTheme";
|
||||||
import { generateJavaStackFiles } from "./generateJavaStackFiles";
|
import { generateJavaStackFiles } from "./generateJavaStackFiles";
|
||||||
import { join as pathJoin, relative as pathRelative, basename as pathBasename, 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 jar from "../tools/jar";
|
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { Equals } from "tsafe";
|
|
||||||
import { getThemeSrcDirPath } from "../getSrcDirPath";
|
import { getThemeSrcDirPath } from "../getSrcDirPath";
|
||||||
import { getProjectRoot } from "../tools/getProjectRoot";
|
import { getProjectRoot } from "../tools/getProjectRoot";
|
||||||
import { objectKeys } from "tsafe/objectKeys";
|
import { objectKeys } from "tsafe/objectKeys";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const projectDirPath = process.cwd();
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
projectDirPath,
|
reactAppRootDirPath,
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -26,18 +24,14 @@ export async function main() {
|
|||||||
|
|
||||||
const keycloakifyDirPath = getProjectRoot();
|
const keycloakifyDirPath = getProjectRoot();
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
|
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
|
for (const themeName of buildOptions.themeNames) {
|
||||||
await generateTheme({
|
await generateTheme({
|
||||||
"keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
|
themeName,
|
||||||
themeSrcDirPath,
|
themeSrcDirPath,
|
||||||
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
||||||
"reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
|
buildOptions,
|
||||||
"buildOptions": {
|
|
||||||
...buildOptions,
|
|
||||||
"themeName": themeName
|
|
||||||
},
|
|
||||||
"keycloakifyVersion": (() => {
|
"keycloakifyVersion": (() => {
|
||||||
const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
|
const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
|
||||||
|
|
||||||
@ -48,8 +42,7 @@ export async function main() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const { jarFilePath } = generateJavaStackFiles({
|
const { jarFilePath } = await generateJavaStackFiles({
|
||||||
"keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"implementedThemeTypes": (() => {
|
"implementedThemeTypes": (() => {
|
||||||
const implementedThemeTypes = {
|
const implementedThemeTypes = {
|
||||||
"login": false,
|
"login": false,
|
||||||
@ -69,43 +62,45 @@ export async function main() {
|
|||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
switch (buildOptions.bundler) {
|
if (buildOptions.doCreateJar) {
|
||||||
case "none":
|
child_process.execSync("mvn clean install", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
||||||
logger.log("😱 Skipping bundling step, there will be no jar");
|
|
||||||
break;
|
const jarDirPath = pathDirname(jarFilePath);
|
||||||
case "keycloakify":
|
const retrocompatJarFilePath = pathJoin(jarDirPath, "retrocompat-" + pathBasename(jarFilePath));
|
||||||
logger.log("🫶 Let keycloakify do its thang");
|
|
||||||
await jar({
|
fs.renameSync(pathJoin(jarDirPath, "original-" + pathBasename(jarFilePath)), retrocompatJarFilePath);
|
||||||
"rootPath": buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"version": buildOptions.themeVersion,
|
fs.writeFileSync(
|
||||||
"groupId": buildOptions.groupId,
|
pathJoin(jarDirPath, "README.md"),
|
||||||
"artifactId": buildOptions.artifactId,
|
Buffer.from(
|
||||||
"targetPath": jarFilePath
|
[
|
||||||
});
|
`- The ${jarFilePath} is to be used in Keycloak 23 and up. `,
|
||||||
break;
|
`- The ${retrocompatJarFilePath} is to be used in Keycloak 21 and below.`,
|
||||||
case "mvn":
|
` Note that Keycloak 22 is only supported for login and email theme but not for account themes. `
|
||||||
logger.log("🫙 Run maven to deliver a jar");
|
].join("\n"),
|
||||||
child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
"utf8"
|
||||||
break;
|
)
|
||||||
default:
|
);
|
||||||
assert<Equals<typeof buildOptions.bundler, never>>(false);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// We want, however, to test in a container running the latest Keycloak version
|
const containerKeycloakVersion = "23.0.0";
|
||||||
const containerKeycloakVersion = "21.1.2";
|
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer({
|
generateStartKeycloakTestingContainer({
|
||||||
keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"keycloakVersion": containerKeycloakVersion,
|
"keycloakVersion": containerKeycloakVersion,
|
||||||
|
jarFilePath,
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
logger.log(
|
logger.log(
|
||||||
[
|
[
|
||||||
"",
|
"",
|
||||||
`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(projectDirPath, jarFilePath)} 🚀`,
|
...(!buildOptions.doCreateJar
|
||||||
`It is to be placed in "/opt/keycloak/providers" in the container running a quay.io/keycloak/keycloak Docker image.`,
|
? []
|
||||||
"",
|
: [
|
||||||
|
`✅ 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.
|
//TODO: Restore when we find a good Helm chart for Keycloak.
|
||||||
//"Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:",
|
//"Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:",
|
||||||
"",
|
"",
|
||||||
@ -138,7 +133,7 @@ export async function main() {
|
|||||||
`To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
|
`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(
|
||||||
projectDirPath,
|
reactAppRootDirPath,
|
||||||
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
||||||
)} 👈`,
|
)} 👈`,
|
||||||
"",
|
"",
|
||||||
@ -148,15 +143,15 @@ export async function main() {
|
|||||||
"- 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 👈",
|
||||||
`- Create a realm: Master -> AddRealm -> Name: myrealm`,
|
`- Create a realm: Master -> AddRealm -> Name: myrealm`,
|
||||||
`- Enable registration: Realm settings -> Login tab -> User registration: on`,
|
`- Enable registration: Realm settings -> Login tab -> User registration: on`,
|
||||||
`- Enable the Account theme (optional): Realm settings -> Themes tab -> Account theme: ${buildOptions.themeName}`,
|
`- Enable the Account theme (optional): Realm settings -> Themes tab -> Account theme: ${buildOptions.themeNames[0]}`,
|
||||||
` Clients -> account -> Login theme: ${buildOptions.themeName}`,
|
` Clients -> account -> Login theme: ${buildOptions.themeNames[0]}`,
|
||||||
`- Enable the email theme (optional): Realm settings -> Themes tab -> Email theme: ${buildOptions.themeName} (option will appear only if you have ran npx initialize-email-theme)`,
|
`- Enable the email theme (optional): Realm settings -> Themes tab -> Email theme: ${buildOptions.themeNames[0]} (option will appear only if you have ran npx initialize-email-theme)`,
|
||||||
`- Create a client Clients -> Create -> Client ID: myclient`,
|
`- Create a client Clients -> Create -> Client ID: myclient`,
|
||||||
` Root URL: https://www.keycloak.org/app/`,
|
` Root URL: https://www.keycloak.org/app/`,
|
||||||
` Valid redirect URIs: https://www.keycloak.org/app* http://localhost* (localhost is optional)`,
|
` Valid redirect URIs: https://www.keycloak.org/app* http://localhost* (localhost is optional)`,
|
||||||
` Valid post logout redirect URIs: https://www.keycloak.org/app* http://localhost*`,
|
` Valid post logout redirect URIs: https://www.keycloak.org/app* http://localhost*`,
|
||||||
` Web origins: *`,
|
` Web origins: *`,
|
||||||
` Login Theme: ${buildOptions.themeName}`,
|
` Login Theme: ${buildOptions.themeNames[0]}`,
|
||||||
` Save (button at the bottom of the page)`,
|
` Save (button at the bottom of the page)`,
|
||||||
``,
|
``,
|
||||||
`- Go to 👉 https://www.keycloak.org/app/ 👈 Click "Save" then "Sign in". You should see your login page`,
|
`- Go to 👉 https://www.keycloak.org/app/ 👈 Click "Save" then "Sign in". You should see your login page`,
|
||||||
|
@ -4,8 +4,6 @@ import type { Equals } from "tsafe";
|
|||||||
import { z } from "zod";
|
import { z } from "zod";
|
||||||
import { pathJoin } from "../tools/pathJoin";
|
import { pathJoin } from "../tools/pathJoin";
|
||||||
|
|
||||||
export const bundlers = ["mvn", "keycloakify", "none"] as const;
|
|
||||||
export type Bundler = (typeof bundlers)[number];
|
|
||||||
export type ParsedPackageJson = {
|
export type ParsedPackageJson = {
|
||||||
name: string;
|
name: string;
|
||||||
version?: string;
|
version?: string;
|
||||||
@ -15,12 +13,12 @@ export type ParsedPackageJson = {
|
|||||||
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
||||||
artifactId?: string;
|
artifactId?: string;
|
||||||
groupId?: string;
|
groupId?: string;
|
||||||
bundler?: Bundler;
|
doCreateJar?: boolean;
|
||||||
keycloakVersionDefaultAssets?: string;
|
loginThemeResourcesFromKeycloakVersion?: string;
|
||||||
reactAppBuildDirPath?: string;
|
reactAppBuildDirPath?: string;
|
||||||
keycloakifyBuildDirPath?: string;
|
keycloakifyBuildDirPath?: string;
|
||||||
themeName?: string;
|
themeName?: string | string[];
|
||||||
extraThemeNames?: string[];
|
doBuildRetrocompatAccountTheme?: boolean;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -34,12 +32,12 @@ export const zParsedPackageJson = z.object({
|
|||||||
"areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
|
"areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
|
||||||
"artifactId": z.string().optional(),
|
"artifactId": z.string().optional(),
|
||||||
"groupId": z.string().optional(),
|
"groupId": z.string().optional(),
|
||||||
"bundler": z.enum(bundlers).optional(),
|
"doCreateJar": z.boolean().optional(),
|
||||||
"keycloakVersionDefaultAssets": z.string().optional(),
|
"loginThemeResourcesFromKeycloakVersion": z.string().optional(),
|
||||||
"reactAppBuildDirPath": z.string().optional(),
|
"reactAppBuildDirPath": z.string().optional(),
|
||||||
"keycloakifyBuildDirPath": z.string().optional(),
|
"keycloakifyBuildDirPath": z.string().optional(),
|
||||||
"themeName": z.string().optional(),
|
"themeName": z.union([z.string(), z.array(z.string())]).optional(),
|
||||||
"extraThemeNames": z.array(z.string()).optional()
|
"doBuildRetrocompatAccountTheme": z.boolean().optional()
|
||||||
})
|
})
|
||||||
.optional()
|
.optional()
|
||||||
});
|
});
|
||||||
@ -47,11 +45,11 @@ export const zParsedPackageJson = z.object({
|
|||||||
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
||||||
|
|
||||||
let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
|
let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
|
||||||
export function getParsedPackageJson(params: { projectDirPath: string }) {
|
export function getParsedPackageJson(params: { reactAppRootDirPath: string }) {
|
||||||
const { projectDirPath } = params;
|
const { reactAppRootDirPath } = params;
|
||||||
if (parsedPackageJson) {
|
if (parsedPackageJson) {
|
||||||
return parsedPackageJson;
|
return parsedPackageJson;
|
||||||
}
|
}
|
||||||
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")));
|
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
|
||||||
return parsedPackageJson;
|
return parsedPackageJson;
|
||||||
}
|
}
|
||||||
|
@ -1,31 +1,6 @@
|
|||||||
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { is } from "tsafe/is";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
export function replaceImportsFromStaticInJsCode(params: { jsCode: string }): { fixedJsCode: string } {
|
||||||
|
|
||||||
export namespace BuildOptionsLike {
|
|
||||||
export type Standalone = {
|
|
||||||
isStandalone: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = {
|
|
||||||
isStandalone: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert(!is<BuildOptions.ExternalAssets.CommonExternalAssets>(buildOptions));
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function replaceImportsFromStaticInJsCode(params: { jsCode: string; buildOptions: BuildOptionsLike }): { fixedJsCode: string } {
|
|
||||||
/*
|
/*
|
||||||
NOTE:
|
NOTE:
|
||||||
|
|
||||||
@ -38,48 +13,38 @@ export function replaceImportsFromStaticInJsCode(params: { jsCode: string; build
|
|||||||
will always run in keycloak context.
|
will always run in keycloak context.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
const { jsCode, buildOptions } = params;
|
const { jsCode } = params;
|
||||||
|
|
||||||
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
||||||
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=function\\(([a-zA-Z]+)\\){return"static\\/${language}\\/"`, "g"),
|
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=(function\\(([a-z]+)\\){return|([a-z]+)=>)"static\\/${language}\\/"`, "g"),
|
||||||
(...[, n, u, e]) => `
|
(...[, n, u, matchedFunction, eForFunction]) => {
|
||||||
${n}[(function(){
|
const isArrowFunction = matchedFunction.includes("=>");
|
||||||
var pd= Object.getOwnPropertyDescriptor(${n}, "p");
|
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
||||||
|
|
||||||
|
return `
|
||||||
|
${n}[(function(){
|
||||||
|
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
${
|
|
||||||
buildOptions.isStandalone
|
|
||||||
? `
|
|
||||||
Object.defineProperty(${n}, "p", {
|
|
||||||
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
|
||||||
set: function (){}
|
|
||||||
});
|
|
||||||
`
|
|
||||||
: `
|
|
||||||
var p= "";
|
|
||||||
Object.defineProperty(${n}, "p", {
|
Object.defineProperty(${n}, "p", {
|
||||||
get: function() { return "${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}/" : p; },
|
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
||||||
set: function (value){ p = value;}
|
set: function() {}
|
||||||
});
|
});
|
||||||
`
|
|
||||||
}
|
}
|
||||||
}
|
return "${u}";
|
||||||
return "${u}";
|
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/build/static/${language}/"`
|
||||||
})()] = function(${e}) { return "${buildOptions.isStandalone ? "/build/" : ""}static/${language}/"`
|
.replace(/\s+/g, " ")
|
||||||
|
.trim();
|
||||||
|
}
|
||||||
];
|
];
|
||||||
|
|
||||||
const fixedJsCode = jsCode
|
const fixedJsCode = jsCode
|
||||||
.replace(...getReplaceArgs("js"))
|
.replace(...getReplaceArgs("js"))
|
||||||
.replace(...getReplaceArgs("css"))
|
.replace(...getReplaceArgs("css"))
|
||||||
.replace(/([a-zA-Z]+\.[a-zA-Z]+)\+"static\//g, (...[, group]) =>
|
.replace(/[a-zA-Z]+\.[a-zA-Z]+\+"static\//g, `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`)
|
||||||
buildOptions.isStandalone
|
|
||||||
? `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`
|
|
||||||
: `("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}/" : ${group}) + "static/`
|
|
||||||
)
|
|
||||||
//TODO: Write a test case for this
|
//TODO: Write a test case for this
|
||||||
.replace(/".chunk.css",([a-zA-Z])+=([a-zA-Z]+\.[a-zA-Z]+)\+([a-zA-Z]+),/, (...[, group1, group2, group3]) =>
|
.replace(
|
||||||
buildOptions.isStandalone
|
/".chunk.css",([a-zA-Z])+=[a-zA-Z]+\.[a-zA-Z]+\+([a-zA-Z]+),/,
|
||||||
? `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group3},`
|
(...[, group1, group2]) => `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group2},`
|
||||||
: `".chunk.css",${group1} = ("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}/" : ${group2}) + ${group3},`
|
|
||||||
);
|
);
|
||||||
|
|
||||||
return { fixedJsCode };
|
return { fixedJsCode };
|
||||||
|
@ -1,20 +1,12 @@
|
|||||||
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 { is } from "tsafe/is";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
};
|
};
|
||||||
|
|
||||||
{
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert(!is<BuildOptions.ExternalAssets.CommonExternalAssets>(buildOptions));
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function replaceImportsInCssCode(params: { cssCode: string }): {
|
export function replaceImportsInCssCode(params: { cssCode: string }): {
|
||||||
fixedCssCode: string;
|
fixedCssCode: string;
|
||||||
@ -24,7 +16,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)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
@ -1,32 +1,11 @@
|
|||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { is } from "tsafe/is";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
export type BuildOptionsLike = {
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
export namespace BuildOptionsLike {
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
export type Common = {
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
|
||||||
isStandalone: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = Common & {
|
|
||||||
isStandalone: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert(!is<BuildOptions.ExternalAssets.CommonExternalAssets>(buildOptions));
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOptions: BuildOptionsLike }): {
|
export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOptions: BuildOptionsLike }): {
|
||||||
fixedCssCode: string;
|
fixedCssCode: string;
|
||||||
@ -37,10 +16,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]) =>
|
(...[, group]) => `url(\${url.resourcesPath}/build/${group})`
|
||||||
`url(${
|
|
||||||
buildOptions.isStandalone ? "${url.resourcesPath}/build/" + group : buildOptions.urlOrigin + (buildOptions.urlPathname ?? "/") + group
|
|
||||||
})`
|
|
||||||
);
|
);
|
||||||
|
|
||||||
return { fixedCssCode };
|
return { fixedCssCode };
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
import { pathJoin } from "./tools/pathJoin";
|
|
||||||
|
|
||||||
export const basenameOfKeycloakDirInPublicDir = "keycloak-resources";
|
|
||||||
export const resourcesDirPathRelativeToPublicDir = pathJoin(basenameOfKeycloakDirInPublicDir, "resources");
|
|
||||||
export const resourcesCommonDirPathRelativeToPublicDir = pathJoin(resourcesDirPathRelativeToPublicDir, "resources_common");
|
|
@ -17,7 +17,7 @@ export async function promptKeycloakVersion() {
|
|||||||
return { getLatestsSemVersionedTag };
|
return { getLatestsSemVersionedTag };
|
||||||
})();
|
})();
|
||||||
|
|
||||||
console.log("Initialize the directory with email template from which keycloak version?");
|
console.log("Select Keycloak version?");
|
||||||
|
|
||||||
const tags = [
|
const tags = [
|
||||||
...(await getLatestsSemVersionedTag({
|
...(await getLatestsSemVersionedTag({
|
||||||
|
@ -1,18 +1,55 @@
|
|||||||
import { exec as execCallback } from "child_process";
|
import { exec as execCallback } from "child_process";
|
||||||
import { createHash } from "crypto";
|
import { createHash } from "crypto";
|
||||||
import { mkdir, readFile, stat, writeFile } from "fs/promises";
|
import { mkdir, readFile, stat, writeFile, unlink, rm } from "fs/promises";
|
||||||
import fetch, { type FetchOptions } from "make-fetch-happen";
|
import fetch, { type FetchOptions } from "make-fetch-happen";
|
||||||
import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { promisify } from "util";
|
import { promisify } from "util";
|
||||||
import { getProjectRoot } from "./getProjectRoot";
|
|
||||||
import { transformCodebase } from "./transformCodebase";
|
import { transformCodebase } from "./transformCodebase";
|
||||||
import { unzip } from "./unzip";
|
import { unzip, zip } from "./unzip";
|
||||||
|
|
||||||
const exec = promisify(execCallback);
|
const exec = promisify(execCallback);
|
||||||
|
|
||||||
function hash(s: string) {
|
function generateFileNameFromURL(params: {
|
||||||
return createHash("sha256").update(s).digest("hex");
|
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) {
|
async function exists(path: string) {
|
||||||
@ -113,14 +150,42 @@ async function getFetchOptions(): Promise<Pick<FetchOptions, "proxy" | "noProxy"
|
|||||||
return { proxy, noProxy, strictSSL, cert, ca: ca.length === 0 ? undefined : ca };
|
return { proxy, noProxy, strictSSL, cert, ca: ca.length === 0 ? undefined : ca };
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function downloadAndUnzip(params: { url: string; destDirPath: string; pathOfDirToExtractInArchive?: string }) {
|
export async function downloadAndUnzip(
|
||||||
const { url, destDirPath, pathOfDirToExtractInArchive } = params;
|
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 downloadHash = hash(JSON.stringify({ url })).substring(0, 15);
|
const zipFileBasename = generateFileNameFromURL({
|
||||||
const projectRoot = getProjectRoot();
|
url,
|
||||||
const cacheRoot = process.env.XDG_CACHE_HOME ?? pathJoin(projectRoot, "node_modules", ".cache");
|
"preCacheTransform":
|
||||||
const zipFilePath = pathJoin(cacheRoot, "keycloakify", "zip", `_${downloadHash}.zip`);
|
preCacheTransform === undefined
|
||||||
const extractDirPath = pathJoin(cacheRoot, "keycloakify", "unzip", `_${downloadHash}`);
|
? 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))) {
|
if (!(await exists(zipFilePath))) {
|
||||||
const opts = await getFetchOptions();
|
const opts = await getFetchOptions();
|
||||||
@ -136,12 +201,32 @@ export async function downloadAndUnzip(params: { url: string; destDirPath: strin
|
|||||||
response.body?.setMaxListeners(Number.MAX_VALUE);
|
response.body?.setMaxListeners(Number.MAX_VALUE);
|
||||||
assert(typeof response.body !== "undefined" && response.body != null);
|
assert(typeof response.body !== "undefined" && response.body != null);
|
||||||
await writeFile(zipFilePath, response.body);
|
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, pathOfDirToExtractInArchive);
|
await unzip(zipFilePath, extractDirPath);
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": extractDirPath,
|
"srcDirPath": extractDirPath,
|
||||||
"destDirPath": destDirPath
|
"destDirPath": destDirPath
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (!rest.doUseCache) {
|
||||||
|
await rm(cacheDirPath, { "recursive": true });
|
||||||
|
} else {
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
15
src/bin/tools/getAbsoluteAndInOsFormatPath.ts
Normal file
15
src/bin/tools/getAbsoluteAndInOsFormatPath.ts
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
import { isAbsolute as pathIsAbsolute, sep as pathSep, join as pathJoin } from "path";
|
||||||
|
|
||||||
|
export function getAbsoluteAndInOsFormatPath(params: { pathIsh: string; cwd: string }): string {
|
||||||
|
const { pathIsh, cwd } = params;
|
||||||
|
|
||||||
|
let pathOut = pathIsh;
|
||||||
|
|
||||||
|
pathOut = pathOut.replace(/\//g, pathSep);
|
||||||
|
|
||||||
|
if (!pathIsAbsolute(pathOut)) {
|
||||||
|
pathOut = pathJoin(cwd, pathOut);
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathOut;
|
||||||
|
}
|
@ -1,99 +0,0 @@
|
|||||||
import { dirname, relative, sep, join } from "path";
|
|
||||||
import { createWriteStream } from "fs";
|
|
||||||
|
|
||||||
import walk from "./walk";
|
|
||||||
import { ZipFile } from "yazl";
|
|
||||||
import { mkdir } from "fs/promises";
|
|
||||||
import trimIndent from "./trimIndent";
|
|
||||||
|
|
||||||
export type ZipEntry = { zipPath: string } & ({ fsPath: string } | { buffer: Buffer });
|
|
||||||
export type ZipEntryGenerator = AsyncGenerator<ZipEntry, void, unknown>;
|
|
||||||
|
|
||||||
type CommonJarArgs = {
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
version: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type JarStreamArgs = CommonJarArgs & {
|
|
||||||
asyncPathGeneratorFn(): ZipEntryGenerator;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type JarArgs = CommonJarArgs & {
|
|
||||||
targetPath: string;
|
|
||||||
rootPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export async function jarStream({ groupId, artifactId, version, asyncPathGeneratorFn }: JarStreamArgs) {
|
|
||||||
const manifestPath = "META-INF/MANIFEST.MF";
|
|
||||||
const manifestData = Buffer.from(trimIndent`
|
|
||||||
Manifest-Version: 1.0
|
|
||||||
Archiver-Version: Plexus Archiver
|
|
||||||
Created-By: Keycloakify
|
|
||||||
Built-By: unknown
|
|
||||||
Build-Jdk: 19.0.0
|
|
||||||
`);
|
|
||||||
|
|
||||||
const pomPropsPath = `META-INF/maven/${groupId}/${artifactId}/pom.properties`;
|
|
||||||
const pomPropsData = Buffer.from(trimIndent`
|
|
||||||
# Generated by keycloakify
|
|
||||||
# ${new Date()}
|
|
||||||
artifactId=${artifactId}
|
|
||||||
groupId=${groupId}
|
|
||||||
version=${version}
|
|
||||||
`);
|
|
||||||
|
|
||||||
const zipFile = new ZipFile();
|
|
||||||
|
|
||||||
for await (const entry of asyncPathGeneratorFn()) {
|
|
||||||
if ("buffer" in entry) {
|
|
||||||
zipFile.addBuffer(entry.buffer, entry.zipPath);
|
|
||||||
} else if ("fsPath" in entry) {
|
|
||||||
if (entry.fsPath.endsWith(sep)) {
|
|
||||||
zipFile.addEmptyDirectory(entry.zipPath);
|
|
||||||
} else {
|
|
||||||
zipFile.addFile(entry.fsPath, entry.zipPath);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
zipFile.addBuffer(manifestData, manifestPath);
|
|
||||||
zipFile.addBuffer(pomPropsData, pomPropsPath);
|
|
||||||
|
|
||||||
zipFile.end();
|
|
||||||
|
|
||||||
return zipFile;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Create a jar archive, using the resources found at `rootPath` (a directory) and write the
|
|
||||||
* archive to `targetPath` (a file). Use `groupId`, `artifactId` and `version` to define
|
|
||||||
* the contents of the pom.properties file which is going to be added to the archive.
|
|
||||||
* The root directory is expectedto have a conventional maven/gradle folder structure with a
|
|
||||||
* single `pom.xml` file at the root and a `src/main/resources` directory containing all
|
|
||||||
* application resources.
|
|
||||||
*/
|
|
||||||
export default async function jar({ groupId, artifactId, version, rootPath, targetPath }: JarArgs) {
|
|
||||||
await mkdir(dirname(targetPath), { recursive: true });
|
|
||||||
|
|
||||||
const asyncPathGeneratorFn = async function* (): ZipEntryGenerator {
|
|
||||||
const resourcesPath = join(rootPath, "src", "main", "resources");
|
|
||||||
for await (const fsPath of walk(resourcesPath)) {
|
|
||||||
const zipPath = relative(resourcesPath, fsPath).split(sep).join("/");
|
|
||||||
yield { fsPath, zipPath };
|
|
||||||
}
|
|
||||||
yield {
|
|
||||||
fsPath: join(rootPath, "pom.xml"),
|
|
||||||
zipPath: `META-INF/maven/${groupId}/${artifactId}/pom.xml`
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
const zipFile = await jarStream({ groupId, artifactId, version, asyncPathGeneratorFn });
|
|
||||||
|
|
||||||
await new Promise<void>(async (resolve, reject) => {
|
|
||||||
zipFile.outputStream
|
|
||||||
.pipe(createWriteStream(targetPath, { encoding: "binary" }))
|
|
||||||
.on("close", () => resolve())
|
|
||||||
.on("error", e => reject(e));
|
|
||||||
});
|
|
||||||
}
|
|
@ -2,5 +2,5 @@ export function pathJoin(...path: string[]): string {
|
|||||||
return path
|
return path
|
||||||
.map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
|
.map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
|
||||||
.map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
|
.map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
|
||||||
.join("/");
|
.join(typeof process !== "undefined" && process.platform === "win32" ? "\\" : "/");
|
||||||
}
|
}
|
||||||
|
@ -3,7 +3,7 @@ import * as path from "path";
|
|||||||
import { crawl } from "./crawl";
|
import { crawl } from "./crawl";
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
|
|
||||||
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string }) =>
|
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; fileRelativePath: string }) =>
|
||||||
| {
|
| {
|
||||||
modifiedSourceCode: Buffer;
|
modifiedSourceCode: Buffer;
|
||||||
newFileName?: string;
|
newFileName?: string;
|
||||||
@ -20,26 +20,27 @@ export function transformCodebase(params: { srcDirPath: string; destDirPath: str
|
|||||||
}))
|
}))
|
||||||
} = params;
|
} = params;
|
||||||
|
|
||||||
for (const file_relative_path of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
||||||
const filePath = path.join(srcDirPath, file_relative_path);
|
const filePath = path.join(srcDirPath, fileRelativePath);
|
||||||
|
|
||||||
const transformSourceCodeResult = transformSourceCode({
|
const transformSourceCodeResult = transformSourceCode({
|
||||||
"sourceCode": fs.readFileSync(filePath),
|
"sourceCode": fs.readFileSync(filePath),
|
||||||
filePath
|
filePath,
|
||||||
|
fileRelativePath
|
||||||
});
|
});
|
||||||
|
|
||||||
if (transformSourceCodeResult === undefined) {
|
if (transformSourceCodeResult === undefined) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.mkdirSync(path.dirname(path.join(destDirPath, file_relative_path)), {
|
fs.mkdirSync(path.dirname(path.join(destDirPath, fileRelativePath)), {
|
||||||
"recursive": true
|
"recursive": true
|
||||||
});
|
});
|
||||||
|
|
||||||
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
path.join(path.dirname(path.join(destDirPath, file_relative_path)), newFileName ?? path.basename(file_relative_path)),
|
path.join(path.dirname(path.join(destDirPath, fileRelativePath)), newFileName ?? path.basename(fileRelativePath)),
|
||||||
modifiedSourceCode
|
modifiedSourceCode
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
@ -2,6 +2,7 @@ import fsp from "node:fs/promises";
|
|||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import yauzl from "yauzl";
|
import yauzl from "yauzl";
|
||||||
|
import yazl from "yazl";
|
||||||
import stream from "node:stream";
|
import stream from "node:stream";
|
||||||
import { promisify } from "node:util";
|
import { promisify } from "node:util";
|
||||||
|
|
||||||
@ -19,11 +20,16 @@ async function pathExists(path: string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function unzip(file: string, targetFolder: string, unzipSubPath?: string) {
|
// Handlings of non posix path is not implemented correctly
|
||||||
// add trailing slash to unzipSubPath and targetFolder
|
// it work by coincidence. Don't have the time to fix but it should be fixed.
|
||||||
if (unzipSubPath && (!unzipSubPath.endsWith("/") || !unzipSubPath.endsWith("\\"))) {
|
export async function unzip(file: string, targetFolder: string, specificDirsToExtract?: string[]) {
|
||||||
unzipSubPath += "/";
|
specificDirsToExtract = specificDirsToExtract?.map(dirPath => {
|
||||||
}
|
if (!dirPath.endsWith("/") || !dirPath.endsWith("\\")) {
|
||||||
|
dirPath += "/";
|
||||||
|
}
|
||||||
|
|
||||||
|
return dirPath;
|
||||||
|
});
|
||||||
|
|
||||||
if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
|
if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
|
||||||
targetFolder += "/";
|
targetFolder += "/";
|
||||||
@ -42,15 +48,17 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
|
|||||||
zipfile.readEntry();
|
zipfile.readEntry();
|
||||||
|
|
||||||
zipfile.on("entry", async entry => {
|
zipfile.on("entry", async entry => {
|
||||||
if (unzipSubPath) {
|
if (specificDirsToExtract !== undefined) {
|
||||||
|
const dirPath = specificDirsToExtract.find(dirPath => entry.fileName.startsWith(dirPath));
|
||||||
|
|
||||||
// Skip files outside of the unzipSubPath
|
// Skip files outside of the unzipSubPath
|
||||||
if (!entry.fileName.startsWith(unzipSubPath)) {
|
if (dirPath === undefined) {
|
||||||
zipfile.readEntry();
|
zipfile.readEntry();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove the unzipSubPath from the file name
|
// Remove the unzipSubPath from the file name
|
||||||
entry.fileName = entry.fileName.substring(unzipSubPath.length);
|
entry.fileName = entry.fileName.substring(dirPath.length);
|
||||||
}
|
}
|
||||||
|
|
||||||
const target = path.join(targetFolder, entry.fileName);
|
const target = path.join(targetFolder, entry.fileName);
|
||||||
@ -77,6 +85,8 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
await fsp.mkdir(path.dirname(target), { "recursive": true });
|
||||||
|
|
||||||
await pipeline(readStream, fs.createWriteStream(target));
|
await pipeline(readStream, fs.createWriteStream(target));
|
||||||
|
|
||||||
zipfile.readEntry();
|
zipfile.readEntry();
|
||||||
@ -90,3 +100,42 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NOTE: This code was directly copied from ChatGPT and appears to function as expected.
|
||||||
|
// However, confidence in its complete accuracy and robustness is limited.
|
||||||
|
export async function zip(sourceFolder: string, targetZip: string) {
|
||||||
|
return new Promise<void>(async (resolve, reject) => {
|
||||||
|
const zipfile = new yazl.ZipFile();
|
||||||
|
const files: string[] = [];
|
||||||
|
|
||||||
|
// Recursive function to explore directories and their subdirectories
|
||||||
|
async function exploreDir(dir: string) {
|
||||||
|
const dirContent = await fsp.readdir(dir);
|
||||||
|
for (const file of dirContent) {
|
||||||
|
const filePath = path.join(dir, file);
|
||||||
|
const stat = await fsp.stat(filePath);
|
||||||
|
if (stat.isDirectory()) {
|
||||||
|
await exploreDir(filePath);
|
||||||
|
} else if (stat.isFile()) {
|
||||||
|
files.push(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collecting all files to be zipped
|
||||||
|
await exploreDir(sourceFolder);
|
||||||
|
|
||||||
|
// Adding files to zip
|
||||||
|
for (const file of files) {
|
||||||
|
const relativePath = path.relative(sourceFolder, file);
|
||||||
|
zipfile.addFile(file, relativePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
zipfile.outputStream
|
||||||
|
.pipe(fs.createWriteStream(targetZip))
|
||||||
|
.on("close", () => resolve())
|
||||||
|
.on("error", err => reject(err)); // Listen to error events
|
||||||
|
|
||||||
|
zipfile.end();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
@ -1,19 +0,0 @@
|
|||||||
import { readdir } from "fs/promises";
|
|
||||||
import { resolve, sep } from "path";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Asynchronously and recursively walk a directory tree, yielding every file and directory
|
|
||||||
* found. Directory paths will _always_ end with a path separator.
|
|
||||||
*
|
|
||||||
* @param root the starting directory
|
|
||||||
* @returns AsyncGenerator
|
|
||||||
*/
|
|
||||||
export default async function* walk(root: string): AsyncGenerator<string, void, unknown> {
|
|
||||||
for (const entry of await readdir(root, { withFileTypes: true })) {
|
|
||||||
const absolutePath = resolve(root, entry.name);
|
|
||||||
if (entry.isDirectory()) {
|
|
||||||
yield absolutePath.endsWith(sep) ? absolutePath : absolutePath + sep;
|
|
||||||
yield* walk(absolutePath);
|
|
||||||
} else yield absolutePath.endsWith(sep) ? absolutePath.substring(0, absolutePath.length - 1) : absolutePath;
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,21 +1,15 @@
|
|||||||
import { useReducer, useEffect } from "react";
|
import { useReducer, useEffect } from "react";
|
||||||
import { headInsert } from "keycloakify/tools/headInsert";
|
import { headInsert } from "keycloakify/tools/headInsert";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
|
||||||
export function usePrepareTemplate(params: {
|
export function usePrepareTemplate(params: {
|
||||||
doFetchDefaultThemeResources: boolean;
|
doFetchDefaultThemeResources: boolean;
|
||||||
stylesCommon?: string[];
|
|
||||||
styles?: string[];
|
styles?: string[];
|
||||||
scripts?: string[];
|
scripts?: string[];
|
||||||
url: {
|
|
||||||
resourcesCommonPath: string;
|
|
||||||
resourcesPath: string;
|
|
||||||
};
|
|
||||||
htmlClassName: string | undefined;
|
htmlClassName: string | undefined;
|
||||||
bodyClassName: string | undefined;
|
bodyClassName: string | undefined;
|
||||||
}) {
|
}) {
|
||||||
const { doFetchDefaultThemeResources, stylesCommon = [], styles = [], url, scripts = [], htmlClassName, bodyClassName } = params;
|
const { doFetchDefaultThemeResources, styles = [], scripts = [], htmlClassName, bodyClassName } = params;
|
||||||
|
|
||||||
const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
|
const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
|
||||||
|
|
||||||
@ -29,38 +23,30 @@ export function usePrepareTemplate(params: {
|
|||||||
const removeArray: (() => void)[] = [];
|
const removeArray: (() => void)[] = [];
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const prLoadedArray: Promise<void>[] = [];
|
for (const style of [...styles].reverse()) {
|
||||||
|
const { prLoaded, remove } = headInsert({
|
||||||
[
|
"type": "css",
|
||||||
...stylesCommon.map(relativePath => pathJoin(url.resourcesCommonPath, relativePath)),
|
"position": "prepend",
|
||||||
...styles.map(relativePath => pathJoin(url.resourcesPath, relativePath))
|
"href": style
|
||||||
]
|
|
||||||
.reverse()
|
|
||||||
.forEach(href => {
|
|
||||||
const { prLoaded, remove } = headInsert({
|
|
||||||
"type": "css",
|
|
||||||
"position": "prepend",
|
|
||||||
href
|
|
||||||
});
|
|
||||||
|
|
||||||
removeArray.push(remove);
|
|
||||||
|
|
||||||
prLoadedArray.push(prLoaded);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
await Promise.all(prLoadedArray);
|
removeArray.push(remove);
|
||||||
|
|
||||||
if (isUnmounted) {
|
// TODO: Find a way to do that in parallel (without breaking the order)
|
||||||
return;
|
await prLoaded;
|
||||||
|
|
||||||
|
if (isUnmounted) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
setReady();
|
setReady();
|
||||||
})();
|
})();
|
||||||
|
|
||||||
scripts.forEach(relativePath => {
|
scripts.forEach(src => {
|
||||||
const { remove } = headInsert({
|
const { remove } = headInsert({
|
||||||
"type": "javascript",
|
"type": "javascript",
|
||||||
"src": pathJoin(url.resourcesPath, relativePath)
|
src
|
||||||
});
|
});
|
||||||
|
|
||||||
removeArray.push(remove);
|
removeArray.push(remove);
|
||||||
|
@ -12,6 +12,8 @@ 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 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"));
|
||||||
@ -52,6 +54,10 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <LoginVerifyEmail kcContext={kcContext} {...rest} />;
|
return <LoginVerifyEmail kcContext={kcContext} {...rest} />;
|
||||||
case "terms.ftl":
|
case "terms.ftl":
|
||||||
return <Terms kcContext={kcContext} {...rest} />;
|
return <Terms kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-oauth2-device-verify-user-code.ftl":
|
||||||
|
return <LoginDeviceVerifyUserCode kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-oauth-grant.ftl":
|
||||||
|
return <LoginOauthGrant kcContext={kcContext} {...rest} />;
|
||||||
case "login-otp.ftl":
|
case "login-otp.ftl":
|
||||||
return <LoginOtp kcContext={kcContext} {...rest} />;
|
return <LoginOtp kcContext={kcContext} {...rest} />;
|
||||||
case "login-username.ftl":
|
case "login-username.ftl":
|
||||||
|
@ -31,21 +31,22 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
|
|
||||||
const { isReady } = usePrepareTemplate({
|
const { isReady } = usePrepareTemplate({
|
||||||
"doFetchDefaultThemeResources": doUseDefaultCss,
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
url,
|
"styles": [
|
||||||
"stylesCommon": [
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
"node_modules/patternfly/dist/css/patternfly.min.css",
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
`${url.resourcesCommonPath}/lib/zocial/zocial.css`,
|
||||||
"lib/zocial/zocial.css"
|
`${url.resourcesPath}/css/login.css`
|
||||||
],
|
],
|
||||||
"styles": ["css/login.css"],
|
|
||||||
"htmlClassName": getClassName("kcHtmlClass"),
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
"bodyClassName": undefined
|
"bodyClassName": getClassName("kcBodyClass")
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!isReady) {
|
if (!isReady) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
document.title = i18n.msgStr("loginTitle", kcContext.realm.displayName);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={getClassName("kcLoginClass")}>
|
<div className={getClassName("kcLoginClass")}>
|
||||||
<div id="kc-header" className={getClassName("kcHeaderClass")}>
|
<div id="kc-header" className={getClassName("kcHeaderClass")}>
|
||||||
|
@ -21,6 +21,7 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey =
|
export type ClassKey =
|
||||||
|
| "kcBodyClass"
|
||||||
| "kcHtmlClass"
|
| "kcHtmlClass"
|
||||||
| "kcLoginClass"
|
| "kcLoginClass"
|
||||||
| "kcHeaderClass"
|
| "kcHeaderClass"
|
||||||
@ -93,4 +94,6 @@ export type ClassKey =
|
|||||||
| "kcSelectOTPListItemClass"
|
| "kcSelectOTPListItemClass"
|
||||||
| "kcAuthenticatorOtpCircleClass"
|
| "kcAuthenticatorOtpCircleClass"
|
||||||
| "kcSelectOTPItemHeadingClass"
|
| "kcSelectOTPItemHeadingClass"
|
||||||
| "kcFormOptionsWrapperClass";
|
| "kcFormOptionsWrapperClass"
|
||||||
|
| "kcFormButtonsWrapperClass"
|
||||||
|
| "kcInputGroup";
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
import type { LoginThemePageId, ThemeType } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
|
import { type ThemeType } from "keycloakify/bin/constants";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { Equals } from "tsafe";
|
import type { Equals } from "tsafe";
|
||||||
import type { MessageKey } from "../i18n/i18n";
|
import type { MessageKey } from "../i18n/i18n";
|
||||||
@ -18,6 +19,8 @@ export type KcContext =
|
|||||||
| KcContext.LoginResetPassword
|
| KcContext.LoginResetPassword
|
||||||
| KcContext.LoginVerifyEmail
|
| KcContext.LoginVerifyEmail
|
||||||
| KcContext.Terms
|
| KcContext.Terms
|
||||||
|
| KcContext.LoginDeviceVerifyUserCode
|
||||||
|
| KcContext.LoginOauthGrant
|
||||||
| KcContext.LoginOtp
|
| KcContext.LoginOtp
|
||||||
| KcContext.LoginUsername
|
| KcContext.LoginUsername
|
||||||
| KcContext.WebauthnAuthenticate
|
| KcContext.WebauthnAuthenticate
|
||||||
@ -37,6 +40,7 @@ export type KcContext =
|
|||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
|
themeVersion: string;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
themeType: "login";
|
themeType: "login";
|
||||||
themeName: string;
|
themeName: string;
|
||||||
@ -78,6 +82,7 @@ export declare namespace KcContext {
|
|||||||
clientId: string;
|
clientId: string;
|
||||||
name?: string;
|
name?: string;
|
||||||
description?: string;
|
description?: string;
|
||||||
|
attributes: Record<string, string>;
|
||||||
};
|
};
|
||||||
isAppInitiatedAction: boolean;
|
isAppInitiatedAction: boolean;
|
||||||
messagesPerField: {
|
messagesPerField: {
|
||||||
@ -241,6 +246,27 @@ export declare namespace KcContext {
|
|||||||
pageId: "terms.ftl";
|
pageId: "terms.ftl";
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type LoginDeviceVerifyUserCode = Common & {
|
||||||
|
pageId: "login-oauth2-device-verify-user-code.ftl";
|
||||||
|
url: {
|
||||||
|
oauth2DeviceVerificationAction: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LoginOauthGrant = Common & {
|
||||||
|
pageId: "login-oauth-grant.ftl";
|
||||||
|
oauth: {
|
||||||
|
code: string;
|
||||||
|
client: string;
|
||||||
|
clientScopesRequested: {
|
||||||
|
consentScreenText: string;
|
||||||
|
}[];
|
||||||
|
};
|
||||||
|
url: {
|
||||||
|
oauthAction: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
export type LoginOtp = Common & {
|
export type LoginOtp = Common & {
|
||||||
pageId: "login-otp.ftl";
|
pageId: "login-otp.ftl";
|
||||||
otpLogin: {
|
otpLogin: {
|
||||||
|
@ -8,9 +8,8 @@ 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 { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
import { pathBasename } from "keycloakify/tools/pathBasename";
|
|
||||||
import { resourcesCommonDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
|
||||||
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>>[];
|
||||||
@ -148,11 +147,7 @@ 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);
|
||||||
const { url } = realKcContext;
|
|
||||||
|
|
||||||
url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(resourcesCommonDirPathRelativeToPublicDir));
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
@ -1,13 +1,11 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import type { KcContext, Attribute } from "./KcContext";
|
import type { KcContext, Attribute } from "./KcContext";
|
||||||
import { resourcesCommonDirPathRelativeToPublicDir, resourcesDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
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";
|
||||||
|
|
||||||
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
|
||||||
|
|
||||||
const attributes: Attribute[] = [
|
const attributes: Attribute[] = [
|
||||||
{
|
{
|
||||||
"validators": {
|
"validators": {
|
||||||
@ -102,14 +100,19 @@ 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 = pathJoin(PUBLIC_URL, keycloak_resources, "login", "resources");
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
|
"themeVersion": "0.0.0",
|
||||||
"keycloakifyVersion": "0.0.0",
|
"keycloakifyVersion": "0.0.0",
|
||||||
"themeType": "login",
|
"themeType": "login",
|
||||||
"themeName": "my-theme-name",
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
"loginAction": "#",
|
"loginAction": "#",
|
||||||
"resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
|
resourcesPath,
|
||||||
"resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
|
"resourcesCommonPath": pathJoin(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"
|
||||||
},
|
},
|
||||||
@ -231,20 +234,19 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"showTryAnotherWayLink": false
|
"showTryAnotherWayLink": false
|
||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp"
|
"clientId": "myApp",
|
||||||
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"scripts": [],
|
"scripts": [],
|
||||||
"message": {
|
|
||||||
"type": "success",
|
|
||||||
"summary": "This is a test message"
|
|
||||||
},
|
|
||||||
"isAppInitiatedAction": false
|
"isAppInitiatedAction": false
|
||||||
};
|
};
|
||||||
|
|
||||||
const loginUrl = {
|
const loginUrl = {
|
||||||
...kcContextCommonMock.url,
|
...kcContextCommonMock.url,
|
||||||
"loginResetCredentialsUrl": "/auth/realms/myrealm/login-actions/reset-credentials?client_id=account&tab_id=HoAx28ja4xg",
|
"loginResetCredentialsUrl": "/auth/realms/myrealm/login-actions/reset-credentials?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
"registrationUrl": "/auth/realms/myrealm/login-actions/registration?client_id=account&tab_id=HoAx28ja4xg"
|
"registrationUrl": "/auth/realms/myrealm/login-actions/registration?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
|
"oauth2DeviceVerificationAction": "/auth/realms/myrealm/device",
|
||||||
|
"oauthAction": "/auth/realms/myrealm/login-actions/consent?client_id=account&tab_id=HoAx28ja4xg"
|
||||||
};
|
};
|
||||||
|
|
||||||
export const kcContextMocks = [
|
export const kcContextMocks = [
|
||||||
@ -313,7 +315,8 @@ export const kcContextMocks = [
|
|||||||
"actionUri": "#",
|
"actionUri": "#",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#"
|
"baseUrl": "#",
|
||||||
|
"attributes": {}
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
id<KcContext.Error>({
|
id<KcContext.Error>({
|
||||||
@ -321,7 +324,8 @@ export const kcContextMocks = [
|
|||||||
"pageId": "error.ftl",
|
"pageId": "error.ftl",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#"
|
"baseUrl": "#",
|
||||||
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"message": {
|
"message": {
|
||||||
"type": "error",
|
"type": "error",
|
||||||
@ -348,6 +352,25 @@ export const kcContextMocks = [
|
|||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "terms.ftl"
|
"pageId": "terms.ftl"
|
||||||
}),
|
}),
|
||||||
|
id<KcContext.LoginDeviceVerifyUserCode>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "login-oauth2-device-verify-user-code.ftl",
|
||||||
|
url: loginUrl
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginOauthGrant>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "login-oauth-grant.ftl",
|
||||||
|
oauth: {
|
||||||
|
code: "5-1N4CIzfi1aprIQjmylI-9e3spLCWW9i5d-GDcs-Sw",
|
||||||
|
clientScopesRequested: [
|
||||||
|
{ consentScreenText: "${profileScopeConsentText}" },
|
||||||
|
{ consentScreenText: "${rolesScopeConsentText}" },
|
||||||
|
{ consentScreenText: "${emailScopeConsentText}" }
|
||||||
|
],
|
||||||
|
client: "account"
|
||||||
|
},
|
||||||
|
url: loginUrl
|
||||||
|
}),
|
||||||
id<KcContext.LoginOtp>({
|
id<KcContext.LoginOtp>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "login-otp.ftl",
|
"pageId": "login-otp.ftl",
|
||||||
@ -476,7 +499,8 @@ export const kcContextMocks = [
|
|||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#"
|
"baseUrl": "#",
|
||||||
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"logoutConfirm": { "code": "123", skipLink: false }
|
"logoutConfirm": { "code": "123", skipLink: false }
|
||||||
}),
|
}),
|
||||||
|
@ -3,6 +3,7 @@ import type { ClassKey } from "keycloakify/login/TemplateProps";
|
|||||||
|
|
||||||
export const { useGetClassName } = createUseClassName<ClassKey>({
|
export const { useGetClassName } = createUseClassName<ClassKey>({
|
||||||
"defaultClasses": {
|
"defaultClasses": {
|
||||||
|
"kcBodyClass": undefined,
|
||||||
"kcHtmlClass": "login-pf",
|
"kcHtmlClass": "login-pf",
|
||||||
"kcLoginClass": "login-pf-page",
|
"kcLoginClass": "login-pf-page",
|
||||||
"kcContentWrapperClass": "row",
|
"kcContentWrapperClass": "row",
|
||||||
@ -44,6 +45,7 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
"kcInputClass": "form-control",
|
"kcInputClass": "form-control",
|
||||||
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text",
|
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text",
|
||||||
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
|
"kcFormButtonsWrapperClass": undefined,
|
||||||
"kcFormOptionsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
"kcFormOptionsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
"kcFormButtonsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
"kcFormButtonsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
"kcFormSettingClass": "login-pf-settings",
|
"kcFormSettingClass": "login-pf-settings",
|
||||||
@ -65,6 +67,7 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
|
|
||||||
// css classes for input
|
// css classes for input
|
||||||
"kcInputLargeClass": "input-lg",
|
"kcInputLargeClass": "input-lg",
|
||||||
|
"kcInputGroup": "pf-c-input-group",
|
||||||
|
|
||||||
// css classes for form accessability
|
// css classes for form accessability
|
||||||
"kcSrOnlyClass": "sr-only",
|
"kcSrOnlyClass": "sr-only",
|
||||||
|
@ -8,7 +8,10 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
|
|||||||
|
|
||||||
const { msgStr, msg } = i18n;
|
const { msgStr, msg } = i18n;
|
||||||
|
|
||||||
assert(kcContext.message !== undefined);
|
assert(
|
||||||
|
kcContext.message !== undefined,
|
||||||
|
"No message in kcContext.message, there will always be a message in production context, add it in your mock"
|
||||||
|
);
|
||||||
|
|
||||||
const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
|
const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
|
||||||
|
|
||||||
|
@ -37,22 +37,18 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
|
|||||||
return (
|
return (
|
||||||
<Template
|
<Template
|
||||||
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
||||||
displayInfo={social.displayInfo}
|
displayInfo={realm.password && realm.registrationAllowed && !registrationDisabled}
|
||||||
displayWide={realm.password && social.providers !== undefined}
|
displayWide={realm.password && social.providers !== undefined}
|
||||||
headerNode={msg("doLogIn")}
|
headerNode={msg("doLogIn")}
|
||||||
infoNode={
|
infoNode={
|
||||||
realm.password &&
|
<div id="kc-registration">
|
||||||
realm.registrationAllowed &&
|
<span>
|
||||||
!registrationDisabled && (
|
{msg("noAccount")}
|
||||||
<div id="kc-registration">
|
<a tabIndex={6} href={url.registrationUrl}>
|
||||||
<span>
|
{msg("doRegister")}
|
||||||
{msg("noAccount")}
|
</a>
|
||||||
<a tabIndex={6} href={url.registrationUrl}>
|
</span>
|
||||||
{msg("doRegister")}
|
</div>
|
||||||
</a>
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
>
|
>
|
||||||
<div id="kc-form" className={clsx(realm.password && social.providers !== undefined && getClassName("kcContentWrapperClass"))}>
|
<div id="kc-form" className={clsx(realm.password && social.providers !== undefined && getClassName("kcContentWrapperClass"))}>
|
||||||
|
@ -32,7 +32,7 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
|
|||||||
|
|
||||||
<ul id="kc-totp-supported-apps">
|
<ul id="kc-totp-supported-apps">
|
||||||
{totp.supportedApplications.map(app => (
|
{totp.supportedApplications.map(app => (
|
||||||
<li>{msgStr(app as MessageKey, app)}</li>
|
<li>{msg(app as MessageKey)}</li>
|
||||||
))}
|
))}
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
67
src/login/pages/LoginDeviceVerifyUserCode.tsx
Normal file
67
src/login/pages/LoginDeviceVerifyUserCode.tsx
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import { I18n } from "../i18n";
|
||||||
|
import { KcContext } from "../kcContext";
|
||||||
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
|
import { PageProps } from "./PageProps";
|
||||||
|
|
||||||
|
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth2-device-verify-user-code.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
||||||
|
const { url } = kcContext;
|
||||||
|
|
||||||
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("oauth2DeviceVerificationTitle")}>
|
||||||
|
<form
|
||||||
|
id="kc-user-verify-device-user-code-form"
|
||||||
|
className={getClassName("kcFormClass")}
|
||||||
|
action={url.oauth2DeviceVerificationAction}
|
||||||
|
method="post"
|
||||||
|
>
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div className={getClassName("kcLabelWrapperClass")}>
|
||||||
|
<label htmlFor="device-user-code" className={getClassName("kcLabelClass")}>
|
||||||
|
{msg("verifyOAuth2DeviceUserCode")}
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className={getClassName("kcInputWrapperClass")}>
|
||||||
|
<input
|
||||||
|
id="device-user-code"
|
||||||
|
name="device_user_code"
|
||||||
|
autoComplete="off"
|
||||||
|
type="text"
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
autoFocus
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div id="kc-form-options" className={getClassName("kcFormOptionsClass")}>
|
||||||
|
<div className={getClassName("kcFormOptionsWrapperClass")}></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
|
||||||
|
<div className={getClassName("kcFormButtonsWrapperClass")}>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonPrimaryClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doSubmit")}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
72
src/login/pages/LoginOauthGrant.tsx
Normal file
72
src/login/pages/LoginOauthGrant.tsx
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import { PageProps } from "./PageProps";
|
||||||
|
import { KcContext } from "../kcContext";
|
||||||
|
import { I18n } from "../i18n";
|
||||||
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
|
|
||||||
|
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth-grant.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
||||||
|
const { url, oauth, client } = kcContext;
|
||||||
|
|
||||||
|
const { msg, msgStr, advancedMsg, advancedMsgStr } = i18n;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template
|
||||||
|
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
||||||
|
headerNode={msg("oauthGrantTitle", client.name ? advancedMsgStr(client.name) : client.clientId)}
|
||||||
|
>
|
||||||
|
<div id="kc-oauth" className="content-area">
|
||||||
|
<h3>{msg("oauthGrantRequest")}</h3>
|
||||||
|
<ul>
|
||||||
|
{oauth.clientScopesRequested.map(clientScope => (
|
||||||
|
<li key={clientScope.consentScreenText}>
|
||||||
|
<span>{advancedMsg(clientScope.consentScreenText)}</span>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<form className="form-actions" action={url.oauthAction} method="POST">
|
||||||
|
<input type="hidden" name="code" value={oauth.code} />
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div id="kc-form-options">
|
||||||
|
<div className={getClassName("kcFormOptionsWrapperClass")}></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="kc-form-buttons">
|
||||||
|
<div className={getClassName("kcFormButtonsWrapperClass")}>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonPrimaryClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
name="accept"
|
||||||
|
id="kc-login"
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doYes")}
|
||||||
|
/>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonDefaultClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
name="cancel"
|
||||||
|
id="kc-cancel"
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doNo")}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
<div className="clearfix"></div>
|
||||||
|
</div>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
@ -1,6 +1,5 @@
|
|||||||
import { useEffect } from "react";
|
import { useEffect } from "react";
|
||||||
import { headInsert } from "keycloakify/tools/headInsert";
|
import { headInsert } from "keycloakify/tools/headInsert";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
import type { PageProps } from "keycloakify/login/pages/PageProps";
|
import type { PageProps } from "keycloakify/login/pages/PageProps";
|
||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
@ -24,7 +23,7 @@ export default function LoginOtp(props: PageProps<Extract<KcContext, { pageId: "
|
|||||||
|
|
||||||
const { prLoaded, remove } = headInsert({
|
const { prLoaded, remove } = headInsert({
|
||||||
"type": "javascript",
|
"type": "javascript",
|
||||||
"src": pathJoin(kcContext.url.resourcesCommonPath, "node_modules/jquery/dist/jquery.min.js")
|
"src": `${kcContext.url.resourcesCommonPath}/node_modules/jquery/dist/jquery.min.js`
|
||||||
});
|
});
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import type { LazyExoticComponent } from "react";
|
|
||||||
import type { I18n } from "keycloakify/login/i18n";
|
import type { I18n } from "keycloakify/login/i18n";
|
||||||
import { type TemplateProps, type ClassKey } from "keycloakify/login/TemplateProps";
|
import { type TemplateProps, type ClassKey } from "keycloakify/login/TemplateProps";
|
||||||
|
import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
|
||||||
|
|
||||||
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
||||||
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
|
3
src/tools/LazyOrNot.ts
Normal file
3
src/tools/LazyOrNot.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import type { LazyExoticComponent, ComponentType } from "react";
|
||||||
|
|
||||||
|
export type LazyOrNot<Component extends ComponentType<any>> = LazyExoticComponent<Component> | Component;
|
@ -22,10 +22,11 @@ const meta: ComponentMeta<any> = {
|
|||||||
export default meta;
|
export default meta;
|
||||||
|
|
||||||
export const Default = () => <PageStory />;
|
export const Default = () => <PageStory />;
|
||||||
export const WithNoMessage = () => (
|
|
||||||
|
export const WithMessage = () => (
|
||||||
<PageStory
|
<PageStory
|
||||||
kcContext={{
|
kcContext={{
|
||||||
message: undefined
|
message: { type: "success", summary: "This is a test message" }
|
||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
|
@ -21,4 +21,13 @@ const meta: ComponentMeta<any> = {
|
|||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
|
|
||||||
export const Default = () => <PageStory />;
|
export const Default = () => (
|
||||||
|
<PageStory
|
||||||
|
kcContext={{
|
||||||
|
message: {
|
||||||
|
summary: "This is the server message",
|
||||||
|
type: "info"
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
24
stories/login/pages/LoginDeviceVerifyUserCode.stories.tsx
Normal file
24
stories/login/pages/LoginDeviceVerifyUserCode.stories.tsx
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
import React from "react";
|
||||||
|
import type { ComponentMeta } from "@storybook/react";
|
||||||
|
import { createPageStory } from "../createPageStory";
|
||||||
|
|
||||||
|
const pageId = "login-oauth2-device-verify-user-code.ftl";
|
||||||
|
|
||||||
|
const { PageStory } = createPageStory({ pageId });
|
||||||
|
|
||||||
|
const meta: ComponentMeta<any> = {
|
||||||
|
title: `login/${pageId}`,
|
||||||
|
component: PageStory,
|
||||||
|
parameters: {
|
||||||
|
viewMode: "story",
|
||||||
|
previewTabs: {
|
||||||
|
"storybook/docs/panel": {
|
||||||
|
"hidden": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export default meta;
|
||||||
|
|
||||||
|
export const Default = () => <PageStory />;
|
24
stories/login/pages/LoginOauthGrant.stories.tsx
Normal file
24
stories/login/pages/LoginOauthGrant.stories.tsx
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
import React from "react";
|
||||||
|
import type { ComponentMeta } from "@storybook/react";
|
||||||
|
import { createPageStory } from "../createPageStory";
|
||||||
|
|
||||||
|
const pageId = "login-oauth-grant.ftl";
|
||||||
|
|
||||||
|
const { PageStory } = createPageStory({ pageId });
|
||||||
|
|
||||||
|
const meta: ComponentMeta<any> = {
|
||||||
|
title: `login/${pageId}`,
|
||||||
|
component: PageStory,
|
||||||
|
parameters: {
|
||||||
|
viewMode: "story",
|
||||||
|
previewTabs: {
|
||||||
|
"storybook/docs/panel": {
|
||||||
|
"hidden": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export default meta;
|
||||||
|
|
||||||
|
export const Default = () => <PageStory />;
|
@ -1,131 +0,0 @@
|
|||||||
import jar, { jarStream, type ZipEntryGenerator } from "keycloakify/bin/tools/jar";
|
|
||||||
import { fromBuffer, Entry, ZipFile } from "yauzl";
|
|
||||||
import { it, describe, assert, afterAll } from "vitest";
|
|
||||||
import { Readable } from "stream";
|
|
||||||
import { tmpdir } from "os";
|
|
||||||
import { mkdtemp, cp, mkdir, rm, writeFile } from "fs/promises";
|
|
||||||
import path from "path";
|
|
||||||
import { createReadStream } from "fs";
|
|
||||||
import walk from "keycloakify/bin/tools/walk";
|
|
||||||
|
|
||||||
type AsyncIterable<T> = {
|
|
||||||
[Symbol.asyncIterator](): AsyncIterableIterator<T>;
|
|
||||||
};
|
|
||||||
|
|
||||||
async function arrayFromAsync<T>(asyncIterable: AsyncIterable<T>) {
|
|
||||||
const chunks: T[] = [];
|
|
||||||
for await (const chunk of asyncIterable) chunks.push(chunk);
|
|
||||||
return chunks;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function readToBuffer(stream: NodeJS.ReadableStream) {
|
|
||||||
return Buffer.concat(await arrayFromAsync(stream as AsyncIterable<Buffer>));
|
|
||||||
}
|
|
||||||
|
|
||||||
function unzipBuffer(buffer: Buffer) {
|
|
||||||
return new Promise<ZipFile>((resolve, reject) =>
|
|
||||||
fromBuffer(buffer, { lazyEntries: true }, (err, zipFile) => {
|
|
||||||
if (err !== null) {
|
|
||||||
reject(err);
|
|
||||||
} else {
|
|
||||||
resolve(zipFile);
|
|
||||||
}
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
function readEntry(zipFile: ZipFile, entry: Entry): Promise<Readable> {
|
|
||||||
return new Promise<Readable>((resolve, reject) => {
|
|
||||||
zipFile.openReadStream(entry, (err, stream) => {
|
|
||||||
if (err !== null) {
|
|
||||||
reject(err);
|
|
||||||
} else {
|
|
||||||
resolve(stream);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function readAll(zipFile: ZipFile): Promise<Map<string, Buffer>> {
|
|
||||||
return new Promise<Map<string, Buffer>>((resolve, reject) => {
|
|
||||||
const entries1: Map<string, Buffer> = new Map();
|
|
||||||
zipFile.on("entry", async (entry: Entry) => {
|
|
||||||
const stream = await readEntry(zipFile, entry);
|
|
||||||
const buffer = await readToBuffer(stream);
|
|
||||||
entries1.set(entry.fileName, buffer);
|
|
||||||
zipFile.readEntry();
|
|
||||||
});
|
|
||||||
zipFile.on("end", () => resolve(entries1));
|
|
||||||
zipFile.on("error", e => reject(e));
|
|
||||||
zipFile.readEntry();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
describe("jar", () => {
|
|
||||||
const coords = { artifactId: "someArtifactId", groupId: "someGroupId", version: "1.2.3" };
|
|
||||||
|
|
||||||
const tmpDirs: string[] = [];
|
|
||||||
|
|
||||||
afterAll(async () => {
|
|
||||||
await Promise.all(tmpDirs.map(dir => rm(dir, { force: true, recursive: true })));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("creates jar artifacts without error", async () => {
|
|
||||||
async function* mockFiles(): ZipEntryGenerator {
|
|
||||||
yield { zipPath: "foo", buffer: Buffer.from("foo") };
|
|
||||||
}
|
|
||||||
|
|
||||||
const zipped = await jarStream({ ...coords, asyncPathGeneratorFn: mockFiles });
|
|
||||||
const buffered = await readToBuffer(zipped.outputStream);
|
|
||||||
const unzipped = await unzipBuffer(buffered);
|
|
||||||
const entries = await readAll(unzipped);
|
|
||||||
|
|
||||||
assert.equal(entries.size, 3);
|
|
||||||
assert.isOk(entries.has("foo"));
|
|
||||||
assert.isOk(entries.has("META-INF/MANIFEST.MF"));
|
|
||||||
assert.isOk(entries.has("META-INF/maven/someGroupId/someArtifactId/pom.properties"));
|
|
||||||
|
|
||||||
assert.equal("foo", entries.get("foo")?.toString("utf-8"));
|
|
||||||
|
|
||||||
const manifest = entries.get("META-INF/MANIFEST.MF")?.toString("utf-8");
|
|
||||||
const pomProperties = entries.get("META-INF/maven/someGroupId/someArtifactId/pom.properties")?.toString("utf-8");
|
|
||||||
|
|
||||||
assert.isOk(manifest?.includes("Created-By: Keycloakify"));
|
|
||||||
assert.isOk(pomProperties?.includes("1.2.3"));
|
|
||||||
assert.isOk(pomProperties?.includes("someGroupId"));
|
|
||||||
assert.isOk(pomProperties?.includes("someArtifactId"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("creates a jar from _real_ files without error", async () => {
|
|
||||||
const tmp = await mkdtemp(path.join(tmpdir(), "kc-jar-test-"));
|
|
||||||
|
|
||||||
tmpDirs.push(tmp);
|
|
||||||
|
|
||||||
const rootPath = path.join(tmp, "root");
|
|
||||||
const resourcesPath = path.join(tmp, "root", "src", "main", "resources");
|
|
||||||
const targetPath = path.join(tmp, "jar.jar");
|
|
||||||
|
|
||||||
await mkdir(resourcesPath, { recursive: true });
|
|
||||||
await writeFile(path.join(rootPath, "pom.xml"), "foo", "utf-8");
|
|
||||||
|
|
||||||
await cp(path.dirname(__dirname), resourcesPath, { recursive: true });
|
|
||||||
|
|
||||||
await jar({ ...coords, rootPath, targetPath });
|
|
||||||
|
|
||||||
const buffered = await readToBuffer(createReadStream(targetPath));
|
|
||||||
const unzipped = await unzipBuffer(buffered);
|
|
||||||
const entries = await readAll(unzipped);
|
|
||||||
const zipPaths = Array.from(entries.keys());
|
|
||||||
|
|
||||||
assert.isOk(entries.has("META-INF/MANIFEST.MF"));
|
|
||||||
assert.isOk(entries.has("META-INF/maven/someGroupId/someArtifactId/pom.properties"));
|
|
||||||
assert.isOk(entries.has("META-INF/maven/someGroupId/someArtifactId/pom.xml"));
|
|
||||||
|
|
||||||
for await (const fsPath of walk(resourcesPath)) {
|
|
||||||
if (!fsPath.endsWith(path.sep)) {
|
|
||||||
const rel = path.relative(resourcesPath, fsPath).replace(path.sep === "/" ? /\//g : /\\/g, "/");
|
|
||||||
assert.isOk(zipPaths.includes(rel), `missing '${rel}' (${rel}, '${zipPaths.join("', '")}')`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
104
test/bin/readStaticResourcesUsage.spec.ts
Normal file
104
test/bin/readStaticResourcesUsage.spec.ts
Normal file
@ -0,0 +1,104 @@
|
|||||||
|
import { readPaths } from "keycloakify/bin/keycloakify/generateTheme/readStaticResourcesUsage";
|
||||||
|
import { same } from "evt/tools/inDepth/same";
|
||||||
|
import { expect, it, describe } from "vitest";
|
||||||
|
|
||||||
|
describe("Ensure it's able to extract used Keycloak resources", () => {
|
||||||
|
const expectedPaths = {
|
||||||
|
"resourcesCommonFilePaths": [
|
||||||
|
"node_modules/patternfly/dist/css/patternfly.min.css",
|
||||||
|
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
||||||
|
"lib/zocial/zocial.css",
|
||||||
|
"node_modules/jquery/dist/jquery.min.js"
|
||||||
|
]
|
||||||
|
};
|
||||||
|
|
||||||
|
it("works with coding style n°1", () => {
|
||||||
|
const paths = readPaths({
|
||||||
|
"rawSourceFile": `
|
||||||
|
const { isReady } = usePrepareTemplate({
|
||||||
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
|
"styles": [
|
||||||
|
\`\${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css\`,
|
||||||
|
\`\${
|
||||||
|
url.resourcesCommonPath
|
||||||
|
}/node_modules/patternfly/dist/css/patternfly-additions.min.css\`,
|
||||||
|
\`\${resourcesCommonPath }/lib/zocial/zocial.css\`,
|
||||||
|
\`\${url.resourcesPath}/css/login.css\`
|
||||||
|
],
|
||||||
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
|
"bodyClassName": undefined
|
||||||
|
});
|
||||||
|
|
||||||
|
const { prLoaded, remove } = headInsert({
|
||||||
|
"type": "javascript",
|
||||||
|
"src": \`\${kcContext.url.resourcesCommonPath}/node_modules/jquery/dist/jquery.min.js\`
|
||||||
|
});
|
||||||
|
|
||||||
|
`
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(same(paths, expectedPaths)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("works with coding style n°2", () => {
|
||||||
|
const paths = readPaths({
|
||||||
|
"rawSourceFile": `
|
||||||
|
|
||||||
|
const { isReady } = usePrepareTemplate({
|
||||||
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
|
"styles": [
|
||||||
|
url.resourcesCommonPath + "/node_modules/patternfly/dist/css/patternfly.min.css",
|
||||||
|
url.resourcesCommonPath + '/node_modules/patternfly/dist/css/patternfly-additions.min.css',
|
||||||
|
url.resourcesCommonPath
|
||||||
|
+ "/lib/zocial/zocial.css",
|
||||||
|
url.resourcesPath +
|
||||||
|
'/css/login.css'
|
||||||
|
],
|
||||||
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
|
"bodyClassName": undefined
|
||||||
|
});
|
||||||
|
|
||||||
|
const { prLoaded, remove } = headInsert({
|
||||||
|
"type": "javascript",
|
||||||
|
"src": kcContext.url.resourcesCommonPath + "/node_modules/jquery/dist/jquery.min.js\"
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
`
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(same(paths, expectedPaths)).toBe(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("works with coding style n°3", () => {
|
||||||
|
const paths = readPaths({
|
||||||
|
"rawSourceFile": `
|
||||||
|
|
||||||
|
const { isReady } = usePrepareTemplate({
|
||||||
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
|
"styles": [
|
||||||
|
path.join(resourcesCommonPath,"/node_modules/patternfly/dist/css/patternfly.min.css"),
|
||||||
|
path.join(url.resourcesCommonPath, '/node_modules/patternfly/dist/css/patternfly-additions.min.css'),
|
||||||
|
path.join(url.resourcesCommonPath,
|
||||||
|
"/lib/zocial/zocial.css"),
|
||||||
|
pathJoin(
|
||||||
|
url.resourcesPath,
|
||||||
|
'css/login.css'
|
||||||
|
)
|
||||||
|
],
|
||||||
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
|
"bodyClassName": undefined
|
||||||
|
});
|
||||||
|
|
||||||
|
const { prLoaded, remove } = headInsert({
|
||||||
|
"type": "javascript",
|
||||||
|
"src": path.join(kcContext.url.resourcesCommonPath, "/node_modules/jquery/dist/jquery.min.js")
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
`
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(same(paths, expectedPaths)).toBe(true);
|
||||||
|
});
|
||||||
|
});
|
@ -32,13 +32,14 @@ describe("bin/js-transforms", () => {
|
|||||||
908:"67c9ed2c"
|
908:"67c9ed2c"
|
||||||
}[e]+".chunk.css"
|
}[e]+".chunk.css"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
n.u=e=>"static/js/"+e+"."+{69:"4f205f87",128:"49264537",453:"b2fed72e",482:"f0106901"}[e]+".chunk.js"
|
||||||
|
|
||||||
|
t.miniCssF=e=>"static/css/"+e+"."+{164:"dcfd7749",908:"67c9ed2c"}[e]+".chunk.css"
|
||||||
`;
|
`;
|
||||||
it("transforms standalone code properly", () => {
|
it("transforms standalone code properly", () => {
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
||||||
"jsCode": jsCodeUntransformed,
|
"jsCode": jsCodeUntransformed
|
||||||
"buildOptions": {
|
|
||||||
"isStandalone": true
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const fixedJsCodeExpected = `
|
const fixedJsCodeExpected = `
|
||||||
@ -55,11 +56,11 @@ describe("bin/js-transforms", () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
__webpack_require__[(function (){
|
__webpack_require__[(function (){
|
||||||
var pd= Object.getOwnPropertyDescriptor(__webpack_require__, "p");
|
var pd = Object.getOwnPropertyDescriptor(__webpack_require__, "p");
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
Object.defineProperty(__webpack_require__, "p", {
|
Object.defineProperty(__webpack_require__, "p", {
|
||||||
get: function() { return window.kcContext.url.resourcesPath; },
|
get: function() { return window.kcContext.url.resourcesPath; },
|
||||||
set: function (){}
|
set: function() {}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return "u";
|
return "u";
|
||||||
@ -72,11 +73,11 @@ describe("bin/js-transforms", () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
t[(function (){
|
t[(function (){
|
||||||
var pd= Object.getOwnPropertyDescriptor(t, "p");
|
var pd = Object.getOwnPropertyDescriptor(t, "p");
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
Object.defineProperty(t, "p", {
|
Object.defineProperty(t, "p", {
|
||||||
get: function() { return window.kcContext.url.resourcesPath; },
|
get: function() { return window.kcContext.url.resourcesPath; },
|
||||||
set: function (){}
|
set: function() {}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return "miniCssF";
|
return "miniCssF";
|
||||||
@ -86,67 +87,28 @@ describe("bin/js-transforms", () => {
|
|||||||
908:"67c9ed2c"
|
908:"67c9ed2c"
|
||||||
} [e] + ".chunk.css"
|
} [e] + ".chunk.css"
|
||||||
}
|
}
|
||||||
|
|
||||||
`;
|
n[(function(){
|
||||||
|
var pd = Object.getOwnPropertyDescriptor(n, "p");
|
||||||
expect(isSameCode(fixedJsCode, fixedJsCodeExpected)).toBe(true);
|
|
||||||
});
|
|
||||||
it("transforms external app code properly", () => {
|
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
|
||||||
"jsCode": jsCodeUntransformed,
|
|
||||||
"buildOptions": {
|
|
||||||
"isStandalone": false,
|
|
||||||
"urlOrigin": "https://demo-app.keycloakify.dev"
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const fixedJsCodeExpected = `
|
|
||||||
function f() {
|
|
||||||
return ("kcContext" in window ? "https://demo-app.keycloakify.dev/" : a.p) + "static/js/" + ({}[e] || e) + "." + {
|
|
||||||
3: "0664cdc0"
|
|
||||||
}[e] + ".chunk.js"
|
|
||||||
}
|
|
||||||
|
|
||||||
function sameAsF() {
|
|
||||||
return ("kcContext" in window ? "https://demo-app.keycloakify.dev/" : a.p) + "static/js/" + ({}[e] || e) + "." + {
|
|
||||||
3: "0664cdc0"
|
|
||||||
}[e] + ".chunk.js"
|
|
||||||
}
|
|
||||||
|
|
||||||
__webpack_require__[(function (){
|
|
||||||
var pd= Object.getOwnPropertyDescriptor(__webpack_require__, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
var p= "";
|
Object.defineProperty(n, "p", {
|
||||||
Object.defineProperty(__webpack_require__, "p", {
|
get: function() { return window.kcContext.url.resourcesPath; },
|
||||||
get: function() { return "kcContext" in window ? "https://demo-app.keycloakify.dev/" : p; },
|
set: function() {}
|
||||||
set: function (value){ p = value; }
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return "u";
|
return "u";
|
||||||
})()] = function(e) {
|
})()] = e => "/build/static/js/"+e+"."+{69:"4f205f87",128:"49264537",453:"b2fed72e",482:"f0106901"}[e]+".chunk.js"
|
||||||
return "static/js/" + e + "." + {
|
|
||||||
147: "6c5cee76",
|
t[(function(){
|
||||||
787: "8da10fcf",
|
var pd = Object.getOwnPropertyDescriptor(t, "p");
|
||||||
922: "be170a73"
|
|
||||||
} [e] + ".chunk.js"
|
|
||||||
}
|
|
||||||
|
|
||||||
t[(function (){
|
|
||||||
var pd= Object.getOwnPropertyDescriptor(t, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
var p= "";
|
|
||||||
Object.defineProperty(t, "p", {
|
Object.defineProperty(t, "p", {
|
||||||
get: function() { return "kcContext" in window ? "https://demo-app.keycloakify.dev/" : p; },
|
get: function() { return window.kcContext.url.resourcesPath; },
|
||||||
set: function (value){ p = value; }
|
set: function() {}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return "miniCssF";
|
return "miniCssF";
|
||||||
})()] = function(e) {
|
})()] = e => "/build/static/css/"+e+"."+{164:"dcfd7749",908:"67c9ed2c"}[e]+".chunk.css"
|
||||||
return "static/css/" + e + "." + {
|
|
||||||
164:"dcfd7749",
|
|
||||||
908:"67c9ed2c"
|
|
||||||
} [e] + ".chunk.css"
|
|
||||||
}
|
|
||||||
`;
|
`;
|
||||||
|
|
||||||
expect(isSameCode(fixedJsCode, fixedJsCodeExpected)).toBe(true);
|
expect(isSameCode(fixedJsCode, fixedJsCodeExpected)).toBe(true);
|
||||||
@ -162,7 +124,7 @@ describe("bin/css-transforms", () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.my-div2 {
|
.my-div2 {
|
||||||
background: url(/logo192.png) no-repeat center center;
|
background: url(/logo192.png) repeat center center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div {
|
.my-div {
|
||||||
@ -173,11 +135,11 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const fixedCssCodeExpected = `
|
const fixedCssCodeExpected = `
|
||||||
.my-div {
|
.my-div {
|
||||||
background: var(--url1f9ef5a892c104c);
|
background: var(--urla882a969fd39473) no-repeat center center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div2 {
|
.my-div2 {
|
||||||
background: var(--url1f9ef5a892c104c);
|
background: var(--urla882a969fd39473) repeat center center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div {
|
.my-div {
|
||||||
@ -188,7 +150,7 @@ describe("bin/css-transforms", () => {
|
|||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
||||||
|
|
||||||
const cssGlobalsToDefineExpected = {
|
const cssGlobalsToDefineExpected = {
|
||||||
"url1f9ef5a892c104c": "url(/logo192.png) no-repeat center center",
|
"urla882a969fd39473": "url(/logo192.png)",
|
||||||
"urldd75cab58377c19": "url(/static/media/something.svg)"
|
"urldd75cab58377c19": "url(/static/media/something.svg)"
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -203,7 +165,7 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const cssCodeToPrependInHeadExpected = `
|
const cssCodeToPrependInHeadExpected = `
|
||||||
:root {
|
:root {
|
||||||
--url1f9ef5a892c104c: url(\${url.resourcesPath}/build/logo192.png) no-repeat center center;
|
--urla882a969fd39473: url(\${url.resourcesPath}/build/logo192.png);
|
||||||
--urldd75cab58377c19: url(\${url.resourcesPath}/build/static/media/something.svg);
|
--urldd75cab58377c19: url(\${url.resourcesPath}/build/static/media/something.svg);
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
@ -229,11 +191,11 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const fixedCssCodeExpected = `
|
const fixedCssCodeExpected = `
|
||||||
.my-div {
|
.my-div {
|
||||||
background: var(--urlf8277cddaa2be78);
|
background: var(--url749a3139386b2c8) no-repeat center center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div2 {
|
.my-div2 {
|
||||||
background: var(--urlf8277cddaa2be78);
|
background: var(--url749a3139386b2c8) no-repeat center center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div {
|
.my-div {
|
||||||
@ -244,7 +206,7 @@ describe("bin/css-transforms", () => {
|
|||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
||||||
|
|
||||||
const cssGlobalsToDefineExpected = {
|
const cssGlobalsToDefineExpected = {
|
||||||
"urlf8277cddaa2be78": "url(/x/y/z/logo192.png) no-repeat center center",
|
"url749a3139386b2c8": "url(/x/y/z/logo192.png)",
|
||||||
"url8bdc0887b97ac9a": "url(/x/y/z/static/media/something.svg)"
|
"url8bdc0887b97ac9a": "url(/x/y/z/static/media/something.svg)"
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -259,7 +221,7 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const cssCodeToPrependInHeadExpected = `
|
const cssCodeToPrependInHeadExpected = `
|
||||||
:root {
|
:root {
|
||||||
--urlf8277cddaa2be78: url(\${url.resourcesPath}/build/logo192.png) no-repeat center center;
|
--url749a3139386b2c8: url(\${url.resourcesPath}/build/logo192.png);
|
||||||
--url8bdc0887b97ac9a: url(\${url.resourcesPath}/build/static/media/something.svg);
|
--url8bdc0887b97ac9a: url(\${url.resourcesPath}/build/static/media/something.svg);
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
@ -304,7 +266,6 @@ describe("bin/css-inline-transforms", () => {
|
|||||||
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
||||||
cssCode,
|
cssCode,
|
||||||
"buildOptions": {
|
"buildOptions": {
|
||||||
"isStandalone": true,
|
|
||||||
"urlPathname": undefined
|
"urlPathname": undefined
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@ -344,53 +305,6 @@ describe("bin/css-inline-transforms", () => {
|
|||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
|
||||||
});
|
|
||||||
it("transforms css for external app properly", () => {
|
|
||||||
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
|
||||||
cssCode,
|
|
||||||
"buildOptions": {
|
|
||||||
"isStandalone": false,
|
|
||||||
"urlOrigin": "https://demo-app.keycloakify.dev",
|
|
||||||
"urlPathname": undefined
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const fixedCssCodeExpected = `
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 400;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/fonts/WorkSans/worksans-regular-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 500;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/fonts/WorkSans/worksans-medium-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 600;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/fonts/WorkSans/worksans-semibold-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 700;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/fonts/WorkSans/worksans-bold-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
`;
|
|
||||||
|
|
||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
@ -430,7 +344,6 @@ describe("bin/css-inline-transforms", () => {
|
|||||||
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
||||||
cssCode,
|
cssCode,
|
||||||
"buildOptions": {
|
"buildOptions": {
|
||||||
"isStandalone": true,
|
|
||||||
"urlPathname": "/x/y/z/"
|
"urlPathname": "/x/y/z/"
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@ -470,53 +383,6 @@ describe("bin/css-inline-transforms", () => {
|
|||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
|
||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
|
||||||
});
|
|
||||||
it("transforms css for external app properly", () => {
|
|
||||||
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
|
||||||
cssCode,
|
|
||||||
"buildOptions": {
|
|
||||||
"isStandalone": false,
|
|
||||||
"urlOrigin": "https://demo-app.keycloakify.dev",
|
|
||||||
"urlPathname": "/x/y/z/"
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const fixedCssCodeExpected = `
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 400;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/x/y/z/fonts/WorkSans/worksans-regular-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 500;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/x/y/z/fonts/WorkSans/worksans-medium-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 600;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/x/y/z/fonts/WorkSans/worksans-semibold-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
@font-face {
|
|
||||||
font-family: "Work Sans";
|
|
||||||
font-style: normal;
|
|
||||||
font-weight: 700;
|
|
||||||
font-display: swap;
|
|
||||||
src: url(https://demo-app.keycloakify.dev/x/y/z/fonts/WorkSans/worksans-bold-webfont.woff2)
|
|
||||||
format("woff2");
|
|
||||||
}
|
|
||||||
`;
|
|
||||||
|
|
||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
@ -12,7 +12,8 @@ export const sampleReactProjectDirPath = pathJoin(getProjectRoot(), "sample_reac
|
|||||||
async function setupSampleReactProject(destDir: string) {
|
async function setupSampleReactProject(destDir: string) {
|
||||||
await downloadAndUnzip({
|
await downloadAndUnzip({
|
||||||
"url": "https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/sample_build_dir_and_package_json.zip",
|
"url": "https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/sample_build_dir_and_package_json.zip",
|
||||||
"destDirPath": destDir
|
"destDirPath": destDir,
|
||||||
|
"doUseCache": false
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
let parsedPackageJson: Record<string, unknown> = {};
|
let parsedPackageJson: Record<string, unknown> = {};
|
||||||
@ -23,7 +24,7 @@ vi.mock("keycloakify/bin/keycloakify/parsed-package-json", async () => ({
|
|||||||
|
|
||||||
vi.mock("keycloakify/bin/promptKeycloakVersion", async () => ({
|
vi.mock("keycloakify/bin/promptKeycloakVersion", async () => ({
|
||||||
...((await vi.importActual("keycloakify/bin/promptKeycloakVersion")) as Record<string, unknown>),
|
...((await vi.importActual("keycloakify/bin/promptKeycloakVersion")) as Record<string, unknown>),
|
||||||
promptKeycloakVersion: () => ({ keycloakVersion: "11.0.3" })
|
promptKeycloakVersion: () => ({ "keycloakVersion": "11.0.3" })
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const nativeCwd = process.cwd;
|
const nativeCwd = process.cwd;
|
||||||
@ -51,17 +52,25 @@ describe("Sample Project", () => {
|
|||||||
await setupSampleReactProject(sampleReactProjectDirPath);
|
await setupSampleReactProject(sampleReactProjectDirPath);
|
||||||
await initializeEmailTheme();
|
await initializeEmailTheme();
|
||||||
|
|
||||||
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
const destDirPath = pathJoin(
|
const destDirPath = pathJoin(
|
||||||
readBuildOptions({
|
readBuildOptions({
|
||||||
"processArgv": ["--silent"],
|
"processArgv": ["--silent"],
|
||||||
"projectDirPath": process.cwd()
|
reactAppRootDirPath
|
||||||
}).keycloakifyBuildDirPath,
|
}).keycloakifyBuildDirPath,
|
||||||
"src",
|
"src",
|
||||||
"main",
|
"main",
|
||||||
"resources",
|
"resources",
|
||||||
"theme"
|
"theme"
|
||||||
);
|
);
|
||||||
await downloadBuiltinKeycloakTheme({ destDirPath, keycloakVersion: "11.0.3", "isSilent": false });
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
destDirPath,
|
||||||
|
"keycloakVersion": "11.0.3",
|
||||||
|
"buildOptions": {
|
||||||
|
"cacheDirPath": pathJoin(reactAppRootDirPath, "node_modules", ".cache", "keycloakify")
|
||||||
|
}
|
||||||
|
});
|
||||||
},
|
},
|
||||||
{ timeout: 90000 }
|
{ timeout: 90000 }
|
||||||
);
|
);
|
||||||
@ -77,17 +86,25 @@ describe("Sample Project", () => {
|
|||||||
await setupSampleReactProject(pathJoin(sampleReactProjectDirPath, "custom_input"));
|
await setupSampleReactProject(pathJoin(sampleReactProjectDirPath, "custom_input"));
|
||||||
await initializeEmailTheme();
|
await initializeEmailTheme();
|
||||||
|
|
||||||
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
const destDirPath = pathJoin(
|
const destDirPath = pathJoin(
|
||||||
readBuildOptions({
|
readBuildOptions({
|
||||||
"processArgv": ["--silent"],
|
"processArgv": ["--silent"],
|
||||||
"projectDirPath": process.cwd()
|
reactAppRootDirPath
|
||||||
}).keycloakifyBuildDirPath,
|
}).keycloakifyBuildDirPath,
|
||||||
"src",
|
"src",
|
||||||
"main",
|
"main",
|
||||||
"resources",
|
"resources",
|
||||||
"theme"
|
"theme"
|
||||||
);
|
);
|
||||||
await downloadBuiltinKeycloakTheme({ destDirPath, "keycloakVersion": "11.0.3", "isSilent": false });
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
destDirPath,
|
||||||
|
"keycloakVersion": "11.0.3",
|
||||||
|
buildOptions: {
|
||||||
|
"cacheDirPath": pathJoin(reactAppRootDirPath, "node_modules", ".cache", "keycloakify")
|
||||||
|
}
|
||||||
|
});
|
||||||
},
|
},
|
||||||
{ timeout: 90000 }
|
{ timeout: 90000 }
|
||||||
);
|
);
|
||||||
|
@ -3,6 +3,7 @@ import { downloadAndUnzip } from "keycloakify/bin/tools/downloadAndUnzip";
|
|||||||
export async function setupSampleReactProject(destDirPath: string) {
|
export async function setupSampleReactProject(destDirPath: string) {
|
||||||
await downloadAndUnzip({
|
await downloadAndUnzip({
|
||||||
"url": "https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/sample_build_dir_and_package_json.zip",
|
"url": "https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/sample_build_dir_and_package_json.zip",
|
||||||
"destDirPath": destDirPath
|
"destDirPath": destDirPath,
|
||||||
|
"doUseCache": false
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -1,65 +0,0 @@
|
|||||||
import trimIndent from "keycloakify/bin/tools/trimIndent";
|
|
||||||
import { it, describe, assert } from "vitest";
|
|
||||||
|
|
||||||
describe("trimIndent", () => {
|
|
||||||
it("does not change a left-aligned string as expected", () => {
|
|
||||||
const txt = trimIndent`lorem
|
|
||||||
ipsum`;
|
|
||||||
assert.equal(txt, ["lorem", "ipsum"].join("\n"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removes leading and trailing empty lines from a left-aligned string", () => {
|
|
||||||
const txt = trimIndent`
|
|
||||||
lorem
|
|
||||||
ipsum
|
|
||||||
`;
|
|
||||||
assert.equal(txt, ["lorem", "ipsum"].join("\n"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removes indent from an aligned string", () => {
|
|
||||||
const txt = trimIndent`
|
|
||||||
lorem
|
|
||||||
ipsum
|
|
||||||
`;
|
|
||||||
assert.equal(txt, ["lorem", "ipsum"].join("\n"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removes indent from unaligned string", () => {
|
|
||||||
const txt = trimIndent`
|
|
||||||
lorem
|
|
||||||
ipsum
|
|
||||||
`;
|
|
||||||
assert.equal(txt, ["lorem", " ipsum"].join("\n"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("removes only first and last empty line", () => {
|
|
||||||
const txt = trimIndent`
|
|
||||||
|
|
||||||
lorem
|
|
||||||
ipsum
|
|
||||||
|
|
||||||
`;
|
|
||||||
|
|
||||||
assert.equal(txt, ["", "lorem", "ipsum", ""].join("\n"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("interpolates non-strings", () => {
|
|
||||||
const d = new Date();
|
|
||||||
const txt = trimIndent`
|
|
||||||
lorem
|
|
||||||
${d}
|
|
||||||
ipsum`;
|
|
||||||
|
|
||||||
assert.equal(txt, ["lorem", String(d), "ipsum"].join("\n"));
|
|
||||||
});
|
|
||||||
|
|
||||||
it("inderpolates preserving new-lines in the interpolated bits", () => {
|
|
||||||
const a = ["ipsum", "dolor", "sit"].join("\n");
|
|
||||||
const txt = trimIndent`
|
|
||||||
lorem
|
|
||||||
${a}
|
|
||||||
amet
|
|
||||||
`;
|
|
||||||
assert.equal(txt, ["lorem", "ipsum", "dolor", "sit", "amet"].join("\n"));
|
|
||||||
});
|
|
||||||
});
|
|
Reference in New Issue
Block a user