Compare commits
2 Commits
v9.3.1
...
v8.0.0-rc.
Author | SHA1 | Date | |
---|---|---|---|
344a5916a4 | |||
2e3fd4885f |
@ -158,88 +158,6 @@
|
|||||||
"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"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "giorgoslytos",
|
|
||||||
"name": "giorgoslytos",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/50946162?v=4",
|
|
||||||
"profile": "https://github.com/giorgoslytos",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"contributorsPerLine": 7,
|
"contributorsPerLine": 7,
|
||||||
@ -247,6 +165,5 @@
|
|||||||
"repoType": "github",
|
"repoType": "github",
|
||||||
"repoHost": "https://github.com",
|
"repoHost": "https://github.com",
|
||||||
"projectName": "keycloakify",
|
"projectName": "keycloakify",
|
||||||
"projectOwner": "keycloakify",
|
"projectOwner": "keycloakify"
|
||||||
"commitType": "docs"
|
|
||||||
}
|
}
|
||||||
|
3
.github/workflows/ci.yaml
vendored
3
.github/workflows/ci.yaml
vendored
@ -3,9 +3,6 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
- v5
|
|
||||||
- v6
|
|
||||||
- v7
|
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
125
README.md
125
README.md
@ -36,12 +36,22 @@
|
|||||||
|
|
||||||
<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>
|
||||||
<br/>
|
<img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
|
||||||
<br/>
|
|
||||||
<img width="400" src="https://github.com/keycloakify/keycloakify/assets/6702424/e66d105c-c06f-47d1-8a31-a6ab09da4e80">
|
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
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)!
|
> Whether or not React is your preferred framework, Keycloakify
|
||||||
|
> 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 👼
|
||||||
|
|
||||||
@ -104,17 +114,6 @@ 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>
|
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/giorgoslytos"><img src="https://avatars.githubusercontent.com/u/50946162?v=4?s=100" width="100px;" alt="giorgoslytos"/><br /><sub><b>giorgoslytos</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=giorgoslytos" title="Code">💻</a></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
@ -126,33 +125,71 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
|
|
||||||
# Changelog highlights
|
# Changelog highlights
|
||||||
|
|
||||||
## 9.0
|
## 5.0 (candidate)
|
||||||
|
|
||||||
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.
|
- 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.
|
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).
|
- Build time: The first build is slowed but the subsequent build are faster. Update your CI so that nodes_modules/.cache is not deleted between builds.
|
||||||
|
|
||||||
### Breaking changes
|
### 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).
|
There are very few breaking changes in this major version.
|
||||||
|
|
||||||
|
- The [`--external-assets` build option has been removed](https://docs.keycloakify.dev/v/v7/build-options#external-assets-deprecated) it was a performance optimization that is no longer relevant now that
|
||||||
|
we have lazy loading.
|
||||||
|
|
||||||
|
- The `usePrepareTemplate` prototype has been changed, you can search and replace:
|
||||||
|
|
||||||
|
`src/keycloak-theme/login/Template.tsx`
|
||||||
|
|
||||||
|
```ts
|
||||||
|
"stylesCommon": [
|
||||||
|
"node_modules/patternfly/dist/css/patternfly.min.css",
|
||||||
|
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
||||||
|
"lib/zocial/zocial.css"
|
||||||
|
],
|
||||||
|
"styles": ["css/login.css"],
|
||||||
|
```
|
||||||
|
|
||||||
|
by
|
||||||
|
|
||||||
|
```ts
|
||||||
|
"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`
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
and
|
||||||
|
|
||||||
|
`src/keycloak-theme/account/Template.css`
|
||||||
|
|
||||||
|
```ts
|
||||||
|
"stylesCommon": ["node_modules/patternfly/dist/css/patternfly.min.css", "node_modules/patternfly/dist/css/patternfly-additions.min.css"],
|
||||||
|
"styles": ["css/account.css"],
|
||||||
|
```
|
||||||
|
|
||||||
|
by
|
||||||
|
|
||||||
|
```ts
|
||||||
|
"styles": [
|
||||||
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
|
`${url.resourcesPath}/css/account.css`
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
## 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.
|
||||||
|
|
||||||
@ -164,7 +201,7 @@ There are very few breaking changes in this major version. [Check them out](http
|
|||||||
## 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.themeVariantNames).
|
There is now an idiomatic way of achieving the same result. [Learn more](https://docs.keycloakify.dev/build-options#keycloakify.extrathemenames).
|
||||||
|
|
||||||
## 7.9
|
## 7.9
|
||||||
|
|
||||||
@ -259,79 +296,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)
|
||||||
|
|
||||||
## 5.6.0
|
## v5.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).
|
||||||
|
|
||||||
## 5.3.0
|
## v5.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`.
|
||||||
|
|
||||||
## 5.0.0
|
## v5.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).
|
||||||
|
|
||||||
## 4.10.0
|
## v4.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).
|
||||||
|
|
||||||
## 4.8.0
|
## v4.8.0
|
||||||
|
|
||||||
[Email template customization.](#email-template-customization)
|
[Email template customization.](#email-template-customization)
|
||||||
|
|
||||||
## 4.7.4
|
## v4.7.4
|
||||||
|
|
||||||
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
||||||
|
|
||||||
## 4.7.2
|
## v4.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.
|
||||||
|
|
||||||
## 4.7.0
|
## v4.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)
|
||||||
|
|
||||||
## 4.6.0
|
## v4.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.
|
||||||
|
|
||||||
## 4.5.3
|
## v4.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.
|
||||||
|
|
||||||
## 4.3.0
|
## v4.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.
|
||||||
|
|
||||||
## 4
|
## v4
|
||||||
|
|
||||||
- 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"`.
|
||||||
|
|
||||||
## 3
|
## v3
|
||||||
|
|
||||||
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).
|
||||||
|
|
||||||
## 2.5
|
## v2.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`.
|
||||||
|
|
||||||
## 2
|
## v2
|
||||||
|
|
||||||
- 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.
|
||||||
|
73
keycloakify-json-schema.json
Normal file
73
keycloakify-json-schema.json
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
{
|
||||||
|
"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": "9.3.1",
|
"version": "8.0.0-rc.1",
|
||||||
"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 src/**/*.java",
|
"copy-files": "copyfiles -u 1 src/**/*.ftl",
|
||||||
"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,18 +17,16 @@ const isSilent = true;
|
|||||||
const logger = getLogger({ isSilent });
|
const logger = getLogger({ isSilent });
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const keycloakVersion = "23.0.4";
|
const keycloakVersion = "21.0.1";
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
||||||
|
|
||||||
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
"projectDirPath": getProjectRoot(),
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath
|
||||||
"buildOptions": {
|
|
||||||
"cacheDirPath": pathJoin(getProjectRoot(), "node_modules", ".cache", "keycloakify")
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
type Dictionary = { [idiomId: string]: string };
|
type Dictionary = { [idiomId: string]: string };
|
||||||
|
@ -22,7 +22,7 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
`${url.resourcesPath}/css/account.css`
|
`${url.resourcesPath}/css/account.css`
|
||||||
],
|
],
|
||||||
"htmlClassName": getClassName("kcHtmlClass"),
|
"htmlClassName": undefined,
|
||||||
"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 = "kcHtmlClass" | "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
export type ClassKey = "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
||||||
|
@ -1,13 +1,11 @@
|
|||||||
import type { AccountThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { AccountThemePageId, ThemeType } 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,8 +3,9 @@ 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?: {
|
||||||
@ -88,7 +89,11 @@ 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,21 +1,18 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
import { resourcesCommonDirPathRelativeToPublicDir, resourcesDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
||||||
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,
|
"resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
|
||||||
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
"resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
|
||||||
"resourceUrl": "#",
|
"resourceUrl": "#",
|
||||||
"accountUrl": "#",
|
"accountUrl": "#",
|
||||||
"applicationsUrl": "#",
|
"applicationsUrl": "#",
|
||||||
|
@ -3,7 +3,6 @@ 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}
|
||||||
defaultValue={account.username ?? ""}
|
value={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 defaultValue={account.email ?? ""} />
|
<input type="text" className="form-control" id="email" name="email" autoFocus value={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" defaultValue={account.firstName ?? ""} />
|
<input type="text" className="form-control" id="firstName" name="firstName" value={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" defaultValue={account.lastName ?? ""} />
|
<input type="text" className="form-control" id="lastName" name="lastName" value={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: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
|
@ -1,9 +0,0 @@
|
|||||||
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,39 +2,38 @@
|
|||||||
|
|
||||||
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, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
|
import { themeTypes } from "./keycloakify/generateFtl";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const reactAppRootDirPath = process.cwd();
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
reactAppRootDirPath,
|
"processArgv": process.argv.slice(2),
|
||||||
"processArgv": process.argv.slice(2)
|
"projectDirPath": process.cwd()
|
||||||
});
|
});
|
||||||
|
|
||||||
const reservedDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
|
const keycloakDirInPublicDir = pathJoin(process.env["PUBLIC_DIR_PATH"] || pathJoin(projectDirPath, "public"), basenameOfKeycloakDirInPublicDir);
|
||||||
|
|
||||||
|
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({
|
||||||
"keycloakVersion": (() => {
|
projectDirPath,
|
||||||
switch (themeType) {
|
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
||||||
case "login":
|
"themeType": themeType,
|
||||||
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
"themeDirPath": keycloakDirInPublicDir,
|
||||||
case "account":
|
"usedResources": undefined
|
||||||
return lastKeycloakVersionWithAccountV1;
|
|
||||||
}
|
|
||||||
})(),
|
|
||||||
themeType,
|
|
||||||
"themeDirPath": reservedDirPath,
|
|
||||||
"usedResources": undefined,
|
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(reservedDirPath, "README.txt"),
|
pathJoin(keycloakDirInPublicDir, "README.txt"),
|
||||||
Buffer.from(
|
Buffer.from(
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
[
|
[
|
||||||
@ -44,7 +43,7 @@ import * as fs from "fs";
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(buildOptions.publicDirPath, "keycloak-resources", ".gitignore"), Buffer.from("*", "utf8"));
|
fs.writeFileSync(pathJoin(keycloakDirInPublicDir, ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
|
|
||||||
console.log(`${pathRelative(reactAppRootDirPath, reservedDirPath)} directory created.`);
|
console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} directory created.`);
|
||||||
})();
|
})();
|
||||||
|
@ -4,74 +4,23 @@ 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 child_process from "child_process";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export async function downloadBuiltinKeycloakTheme(params: { projectDirPath: string; keycloakVersion: string; destDirPath: string }) {
|
||||||
cacheDirPath: string;
|
const { projectDirPath, keycloakVersion, destDirPath } = params;
|
||||||
};
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
const start = Date.now();
|
||||||
|
|
||||||
export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
|
|
||||||
const { keycloakVersion, destDirPath, buildOptions } = params;
|
|
||||||
|
|
||||||
await downloadAndUnzip({
|
await downloadAndUnzip({
|
||||||
"doUseCache": true,
|
"doUseCache": true,
|
||||||
"cacheDirPath": buildOptions.cacheDirPath,
|
projectDirPath,
|
||||||
destDirPath,
|
destDirPath,
|
||||||
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
||||||
"specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
|
"specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
|
||||||
"preCacheTransform": {
|
"preCacheTransform": {
|
||||||
"actionCacheId": "npm install and build",
|
"actionCacheId": "npm install and build",
|
||||||
"action": async ({ destDirPath }) => {
|
"action": async ({ destDirPath }) => {
|
||||||
fix_account_css: {
|
|
||||||
const accountCssFilePath = pathJoin(destDirPath, "keycloak", "account", "resources", "css", "account.css");
|
|
||||||
|
|
||||||
if (!fs.existsSync(accountCssFilePath)) {
|
|
||||||
break fix_account_css;
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
accountCssFilePath,
|
|
||||||
Buffer.from(fs.readFileSync(accountCssFilePath).toString("utf8").replace("top: -34px;", "top: -34px !important;"), "utf8")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
fix_account_topt: {
|
|
||||||
const totpFtlFilePath = pathJoin(destDirPath, "base", "account", "totp.ftl");
|
|
||||||
|
|
||||||
if (!fs.existsSync(totpFtlFilePath)) {
|
|
||||||
break fix_account_topt;
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
totpFtlFilePath,
|
|
||||||
Buffer.from(
|
|
||||||
fs
|
|
||||||
.readFileSync(totpFtlFilePath)
|
|
||||||
.toString("utf8")
|
|
||||||
.replace(
|
|
||||||
[
|
|
||||||
" <#list totp.policy.supportedApplications as app>",
|
|
||||||
" <li>${app}</li>",
|
|
||||||
" </#list>"
|
|
||||||
].join("\n"),
|
|
||||||
[
|
|
||||||
" <#if totp.policy.supportedApplications?has_content>",
|
|
||||||
" <#list totp.policy.supportedApplications as app>",
|
|
||||||
" <li>${app}</li>",
|
|
||||||
" </#list>",
|
|
||||||
" </#if>"
|
|
||||||
].join("\n")
|
|
||||||
),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
install_common_node_modules: {
|
install_common_node_modules: {
|
||||||
const commonResourcesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
|
const commonResourcesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
|
||||||
|
|
||||||
@ -100,18 +49,7 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
||||||
}
|
}
|
||||||
|
|
||||||
const packageManager = fs.existsSync(pathJoin(accountV2DirSrcDirPath, "pnpm-lock.yaml")) ? "pnpm" : "npm";
|
child_process.execSync("npm install", { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
if (packageManager === "pnpm") {
|
|
||||||
try {
|
|
||||||
child_process.execSync(`which pnpm`);
|
|
||||||
} catch {
|
|
||||||
console.log(`Installing pnpm globally`);
|
|
||||||
child_process.execSync(`npm install -g pnpm`);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
child_process.execSync(`${packageManager} install`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
|
||||||
|
|
||||||
const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
|
const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
|
||||||
|
|
||||||
@ -120,12 +58,12 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
||||||
|
|
||||||
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
||||||
.replace(`${packageManager} run check-types`, "true")
|
.replace("npm run check-types", "true")
|
||||||
.replace(`${packageManager} run babel`, "true");
|
.replace("npm run babel", "true");
|
||||||
|
|
||||||
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
||||||
|
|
||||||
child_process.execSync(`${packageManager} run build`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
child_process.execSync("npm run build", { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
||||||
|
|
||||||
@ -134,11 +72,13 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
console.log("Downloaded Keycloak theme in", Date.now() - start, "ms");
|
||||||
}
|
}
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
"reactAppRootDirPath": process.cwd(),
|
"projectDirPath": process.cwd(),
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -150,9 +90,9 @@ async function main() {
|
|||||||
logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
|
logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
"projectDirPath": process.cwd(),
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
destDirPath,
|
destDirPath
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2,7 +2,14 @@
|
|||||||
|
|
||||||
import { getProjectRoot } from "./tools/getProjectRoot";
|
import { getProjectRoot } from "./tools/getProjectRoot";
|
||||||
import cliSelect from "cli-select";
|
import cliSelect from "cli-select";
|
||||||
import { loginThemePageIds, accountThemePageIds, type LoginThemePageId, type AccountThemePageId } from "./keycloakify/generateFtl";
|
import {
|
||||||
|
loginThemePageIds,
|
||||||
|
accountThemePageIds,
|
||||||
|
type LoginThemePageId,
|
||||||
|
type AccountThemePageId,
|
||||||
|
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";
|
||||||
@ -10,13 +17,10 @@ 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(() => {
|
||||||
@ -45,7 +49,7 @@ import { themeTypes, type ThemeType } from "./constants";
|
|||||||
|
|
||||||
const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
|
const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
const { themeSrcDirPath } = getThemeSrcDirPath({ "projectDirPath": process.cwd() });
|
||||||
|
|
||||||
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 "./constants";
|
import { themeTypes } from "./keycloakify/generateFtl";
|
||||||
|
|
||||||
const themeSrcDirBasenames = ["keycloak-theme", "keycloak_theme"];
|
const themeSrcDirBasename = "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: { reactAppRootDirPath: string }) {
|
export function getThemeSrcDirPath(params: { projectDirPath: string }) {
|
||||||
const { reactAppRootDirPath } = params;
|
const { projectDirPath } = params;
|
||||||
|
|
||||||
const srcDirPath = pathJoin(reactAppRootDirPath, "src");
|
const srcDirPath = pathJoin(projectDirPath, "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 => {
|
||||||
for (const themeSrcDirBasename of themeSrcDirBasenames) {
|
const split = fileRelativePath.split(themeSrcDirBasename);
|
||||||
const split = fileRelativePath.split(themeSrcDirBasename);
|
|
||||||
if (split.length === 2) {
|
if (split.length !== 2) {
|
||||||
return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
|
return undefined;
|
||||||
}
|
|
||||||
}
|
}
|
||||||
return undefined;
|
|
||||||
|
return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
|
||||||
})
|
})
|
||||||
.filter(exclude(undefined))[0];
|
.filter(exclude(undefined))[0];
|
||||||
|
|
||||||
@ -38,7 +38,7 @@ export function getThemeSrcDirPath(params: { reactAppRootDirPath: 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 or src/keycloak_theme.",
|
"src/ 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,17 +10,17 @@ import { getLogger } from "./tools/logger";
|
|||||||
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const reactAppRootDirPath = process.cwd();
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const { isSilent } = readBuildOptions({
|
||||||
reactAppRootDirPath,
|
projectDirPath,
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
const logger = getLogger({ isSilent });
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({
|
const { themeSrcDirPath } = getThemeSrcDirPath({
|
||||||
reactAppRootDirPath
|
projectDirPath
|
||||||
});
|
});
|
||||||
|
|
||||||
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
@ -36,9 +36,9 @@ export async function main() {
|
|||||||
const builtinKeycloakThemeTmpDirPath = pathJoin(emailThemeSrcDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
|
const builtinKeycloakThemeTmpDirPath = pathJoin(emailThemeSrcDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
projectDirPath,
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
"destDirPath": builtinKeycloakThemeTmpDirPath
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
|
@ -1,34 +1,34 @@
|
|||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { id } from "tsafe/id";
|
||||||
import { parse as urlParse } from "url";
|
import { parse as urlParse } from "url";
|
||||||
import { getParsedPackageJson } from "./parsedPackageJson";
|
import { typeGuard } from "tsafe/typeGuard";
|
||||||
import { join as pathJoin } from "path";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
|
import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
|
||||||
|
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 = {
|
export type BuildOptions = {
|
||||||
isSilent: boolean;
|
isSilent: boolean;
|
||||||
themeVersion: string;
|
themeVersion: string;
|
||||||
themeNames: string[];
|
themeName: string;
|
||||||
|
extraThemeNames: string[];
|
||||||
extraThemeProperties: string[] | undefined;
|
extraThemeProperties: string[] | undefined;
|
||||||
groupId: string;
|
groupId: string;
|
||||||
artifactId: string;
|
artifactId: string;
|
||||||
doCreateJar: boolean;
|
bundler: Bundler;
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
keycloakVersionDefaultAssets: string;
|
||||||
reactAppRootDirPath: string;
|
|
||||||
/** Directory of your built react project. Defaults to {cwd}/build */
|
/** Directory of your built react project. Defaults to {cwd}/build */
|
||||||
reactAppBuildDirPath: string;
|
reactAppBuildDirPath: string;
|
||||||
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
||||||
keycloakifyBuildDirPath: string;
|
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
|
/** 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/" */
|
* In this case the urlPathname will be "/my-app/" */
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export function readBuildOptions(params: { reactAppRootDirPath: string; processArgv: string[] }): BuildOptions {
|
export function readBuildOptions(params: { projectDirPath: string; processArgv: string[] }): BuildOptions {
|
||||||
const { reactAppRootDirPath, processArgv } = params;
|
const { projectDirPath, processArgv } = params;
|
||||||
|
|
||||||
const { isSilentCliParamProvided } = (() => {
|
const { isSilentCliParamProvided } = (() => {
|
||||||
const argv = parseArgv(processArgv);
|
const argv = parseArgv(processArgv);
|
||||||
@ -38,36 +38,35 @@ export function readBuildOptions(params: { reactAppRootDirPath: string; processA
|
|||||||
};
|
};
|
||||||
})();
|
})();
|
||||||
|
|
||||||
const parsedPackageJson = getParsedPackageJson({ reactAppRootDirPath });
|
const parsedPackageJson = getParsedPackageJson({ projectDirPath });
|
||||||
|
|
||||||
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
||||||
|
|
||||||
const { extraThemeProperties, groupId, artifactId, doCreateJar, loginThemeResourcesFromKeycloakVersion } = keycloakify ?? {};
|
const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
|
||||||
|
|
||||||
const themeNames = (() => {
|
const themeName =
|
||||||
if (keycloakify.themeName === undefined) {
|
keycloakify.themeName ??
|
||||||
return [
|
name
|
||||||
name
|
.replace(/^@(.*)/, "$1")
|
||||||
.replace(/^@(.*)/, "$1")
|
.split("/")
|
||||||
.split("/")
|
.join("-");
|
||||||
.join("-")
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof keycloakify.themeName === "string") {
|
|
||||||
return [keycloakify.themeName];
|
|
||||||
}
|
|
||||||
|
|
||||||
return keycloakify.themeName;
|
|
||||||
})();
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
reactAppRootDirPath,
|
themeName,
|
||||||
themeNames,
|
extraThemeNames,
|
||||||
"doCreateJar": doCreateJar ?? true,
|
"bundler": (() => {
|
||||||
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeNames[0]}-keycloak-theme`,
|
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": (() => {
|
"groupId": (() => {
|
||||||
const fallbackGroupId = `${themeNames[0]}.keycloak`;
|
const fallbackGroupId = `${themeName}.keycloak`;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
process.env.KEYCLOAKIFY_GROUP_ID ??
|
process.env.KEYCLOAKIFY_GROUP_ID ??
|
||||||
@ -84,58 +83,41 @@ export function readBuildOptions(params: { reactAppRootDirPath: string; processA
|
|||||||
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
|
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
|
||||||
extraThemeProperties,
|
extraThemeProperties,
|
||||||
"isSilent": isSilentCliParamProvided,
|
"isSilent": isSilentCliParamProvided,
|
||||||
"loginThemeResourcesFromKeycloakVersion": loginThemeResourcesFromKeycloakVersion ?? "11.0.3",
|
"keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "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": (() => {
|
"reactAppBuildDirPath": (() => {
|
||||||
const { reactAppBuildDirPath } = parsedPackageJson.keycloakify ?? {};
|
let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
|
||||||
|
|
||||||
if (reactAppBuildDirPath !== undefined) {
|
if (reactAppBuildDirPath === undefined) {
|
||||||
return getAbsoluteAndInOsFormatPath({
|
return pathJoin(projectDirPath, "build");
|
||||||
"pathIsh": reactAppBuildDirPath,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "build");
|
if (pathSep === "\\") {
|
||||||
|
reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
|
||||||
|
return pathJoin(projectDirPath, reactAppBuildDirPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
return reactAppBuildDirPath;
|
||||||
})(),
|
})(),
|
||||||
"keycloakifyBuildDirPath": (() => {
|
"keycloakifyBuildDirPath": (() => {
|
||||||
const { keycloakifyBuildDirPath } = parsedPackageJson.keycloakify ?? {};
|
let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
|
||||||
|
|
||||||
if (keycloakifyBuildDirPath !== undefined) {
|
if (keycloakifyBuildDirPath === undefined) {
|
||||||
return getAbsoluteAndInOsFormatPath({
|
return pathJoin(projectDirPath, "build_keycloak");
|
||||||
"pathIsh": keycloakifyBuildDirPath,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "build_keycloak");
|
if (pathSep === "\\") {
|
||||||
|
keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
|
||||||
|
return pathJoin(projectDirPath, keycloakifyBuildDirPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
return keycloakifyBuildDirPath;
|
||||||
})(),
|
})(),
|
||||||
"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": (() => {
|
"urlPathname": (() => {
|
||||||
const { homepage } = parsedPackageJson;
|
const { homepage } = parsedPackageJson;
|
||||||
|
|
||||||
@ -151,7 +133,6 @@ export function readBuildOptions(params: { reactAppRootDirPath: string; processA
|
|||||||
|
|
||||||
const out = url.pathname.replace(/([^/])$/, "$1/");
|
const out = url.pathname.replace(/([^/])$/, "$1/");
|
||||||
return out === "/" ? undefined : out;
|
return out === "/" ? undefined : out;
|
||||||
})(),
|
})()
|
||||||
"doBuildRetrocompatAccountTheme": parsedPackageJson.keycloakify?.doBuildRetrocompatAccountTheme ?? true
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
@ -478,28 +478,11 @@
|
|||||||
"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 pageId == "register.ftl" && key == "attemptedUsername" && are_same_path(path, ["auth"])>
|
|
||||||
<#attempt>
|
|
||||||
<#-- 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())>
|
|
||||||
<#continue>
|
|
||||||
</#if>
|
|
||||||
<#recover>
|
|
||||||
</#attempt>
|
|
||||||
</#if>
|
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#if !object[key]??>
|
<#if !object[key]??>
|
||||||
|
@ -8,9 +8,13 @@ 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 ThemeType = (typeof themeTypes)[number];
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
|
themeName: string;
|
||||||
themeVersion: string;
|
themeVersion: string;
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
};
|
};
|
||||||
@ -18,7 +22,6 @@ export type BuildOptionsLike = {
|
|||||||
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>;
|
||||||
@ -27,7 +30,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
themeType: ThemeType;
|
themeType: ThemeType;
|
||||||
fieldNames: string[];
|
fieldNames: string[];
|
||||||
}) {
|
}) {
|
||||||
const { themeName, cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
|
const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
|
||||||
|
|
||||||
const $ = cheerio.load(indexHtmlCode);
|
const $ = cheerio.load(indexHtmlCode);
|
||||||
|
|
||||||
@ -101,7 +104,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", themeName),
|
.replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", buildOptions.themeName),
|
||||||
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
||||||
"<#if scripts??>",
|
"<#if scripts??>",
|
||||||
" <#list scripts as script>",
|
" <#list scripts as script>",
|
||||||
@ -121,27 +124,6 @@ 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,8 +10,6 @@ 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",
|
||||||
|
84
src/bin/keycloakify/generateJavaStackFiles.ts
Normal file
84
src/bin/keycloakify/generateJavaStackFiles.ts
Normal file
@ -0,0 +1,84 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin, dirname as pathDirname } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "./BuildOptions";
|
||||||
|
import type { ThemeType } from "./generateFtl";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
themeName: string;
|
||||||
|
extraThemeNames: string[];
|
||||||
|
groupId: string;
|
||||||
|
artifactId: string;
|
||||||
|
themeVersion: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<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`)
|
||||||
|
};
|
||||||
|
}
|
@ -1,101 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { resources_common, lastKeycloakVersionWithAccountV1, accountV1 } from "../../constants";
|
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
|
||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike }) {
|
|
||||||
const { buildOptions } = params;
|
|
||||||
|
|
||||||
const builtinKeycloakThemeTmpDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "..", "tmp_yxdE2_builtin_keycloak_theme");
|
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
|
||||||
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
|
||||||
"keycloakVersion": lastKeycloakVersionWithAccountV1,
|
|
||||||
buildOptions
|
|
||||||
});
|
|
||||||
|
|
||||||
const accountV1DirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme", accountV1, "account");
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "account"),
|
|
||||||
"destDirPath": accountV1DirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
const commonResourceFilePaths = [
|
|
||||||
"node_modules/patternfly/dist/css/patternfly.min.css",
|
|
||||||
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
|
||||||
...[
|
|
||||||
"OpenSans-Light-webfont.woff2",
|
|
||||||
"OpenSans-Regular-webfont.woff2",
|
|
||||||
"OpenSans-Bold-webfont.woff2",
|
|
||||||
"OpenSans-Semibold-webfont.woff2",
|
|
||||||
"OpenSans-Bold-webfont.woff",
|
|
||||||
"OpenSans-Light-webfont.woff",
|
|
||||||
"OpenSans-Regular-webfont.woff",
|
|
||||||
"OpenSans-Semibold-webfont.woff",
|
|
||||||
"OpenSans-Regular-webfont.ttf",
|
|
||||||
"OpenSans-Light-webfont.ttf",
|
|
||||||
"OpenSans-Semibold-webfont.ttf",
|
|
||||||
"OpenSans-Bold-webfont.ttf"
|
|
||||||
].map(path => `node_modules/patternfly/dist/fonts/${path}`)
|
|
||||||
];
|
|
||||||
|
|
||||||
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", "img/icon-sidebar-active.png", "img/logo.png"];
|
|
||||||
|
|
||||||
for (const relativeFilePath of resourceFilePaths.map(path => pathJoin(...path.split("/")))) {
|
|
||||||
const destFilePath = pathJoin(accountV1DirPath, "resources", relativeFilePath);
|
|
||||||
|
|
||||||
fs.mkdirSync(pathDirname(destFilePath), { "recursive": true });
|
|
||||||
|
|
||||||
fs.cpSync(pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "account", "resources", relativeFilePath), destFilePath);
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true });
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(accountV1DirPath, "theme.properties"),
|
|
||||||
Buffer.from(
|
|
||||||
[
|
|
||||||
"accountResourceProvider=account-v1",
|
|
||||||
"",
|
|
||||||
"locales=ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
|
||||||
"",
|
|
||||||
"styles=" + [...resourceFilePaths, ...commonResourceFilePaths.map(path => `resources-common/${path}`)].join(" "),
|
|
||||||
"",
|
|
||||||
"##### css classes for form buttons",
|
|
||||||
"# main class used for all buttons",
|
|
||||||
"kcButtonClass=btn",
|
|
||||||
"# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
|
|
||||||
"kcButtonPrimaryClass=btn-primary",
|
|
||||||
"kcButtonDefaultClass=btn-default",
|
|
||||||
"# classes defining size of the button",
|
|
||||||
"kcButtonLargeClass=btn-lg",
|
|
||||||
""
|
|
||||||
].join("\n"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,141 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { type ThemeType, retrocompatPostfix, accountV1 } from "../../constants";
|
|
||||||
import { bringInAccountV1 } from "./bringInAccountV1";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
themeVersion: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
themeNames: string[];
|
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
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 || !buildOptions.doBuildRetrocompatAccountTheme
|
|
||||||
? []
|
|
||||||
: [
|
|
||||||
{
|
|
||||||
"name": `${themeName}${retrocompatPostfix}`,
|
|
||||||
"types": ["account"]
|
|
||||||
}
|
|
||||||
])
|
|
||||||
])
|
|
||||||
.flat()
|
|
||||||
]
|
|
||||||
},
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"jarFilePath": pathJoin(buildOptions.keycloakifyBuildDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`)
|
|
||||||
};
|
|
||||||
}
|
|
@ -1 +0,0 @@
|
|||||||
export * from "./generateJavaStackFiles";
|
|
@ -1,60 +1,53 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "./BuildOptions";
|
import type { BuildOptions } from "./BuildOptions";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
keycloakifyBuildDirPath: string;
|
themeName: string;
|
||||||
|
extraThemeNames: string[];
|
||||||
};
|
};
|
||||||
|
|
||||||
{
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
|
generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_container.sh";
|
||||||
|
|
||||||
const containerName = "keycloak-testing-container";
|
const containerName = "keycloak-testing-container";
|
||||||
|
|
||||||
/** Files for being able to run a hot reload keycloak container */
|
/** Files for being able to run a hot reload keycloak container */
|
||||||
export function generateStartKeycloakTestingContainer(params: { jarFilePath: string; keycloakVersion: string; buildOptions: BuildOptionsLike }) {
|
export function generateStartKeycloakTestingContainer(params: {
|
||||||
const { jarFilePath, keycloakVersion, buildOptions } = params;
|
keycloakVersion: string;
|
||||||
|
keycloakThemeBuildingDirPath: string;
|
||||||
const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
|
buildOptions: BuildOptionsLike;
|
||||||
const themeDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, themeRelativeDirPath);
|
}) {
|
||||||
|
const {
|
||||||
|
keycloakThemeBuildingDirPath,
|
||||||
|
keycloakVersion,
|
||||||
|
buildOptions: { themeName, extraThemeNames }
|
||||||
|
} = params;
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename),
|
pathJoin(keycloakThemeBuildingDirPath, 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 "${buildOptions.keycloakifyBuildDirPath}"`,
|
`cd "${keycloakThemeBuildingDirPath.replace(/\\/g, "/")}"`,
|
||||||
"",
|
"",
|
||||||
"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 \\",
|
||||||
` -v "${pathJoin(
|
...[themeName, ...extraThemeNames].map(
|
||||||
"$(pwd)",
|
themeName =>
|
||||||
pathRelative(buildOptions.keycloakifyBuildDirPath, jarFilePath)
|
` -v "${pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(
|
||||||
)}":"/opt/keycloak/providers/${pathBasename(jarFilePath)}" \\`,
|
/\\/g,
|
||||||
...fs
|
"/"
|
||||||
.readdirSync(themeDirPath)
|
)}":"/opt/keycloak/themes/${themeName}":rw \\`
|
||||||
.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,83 +1,65 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
|
import type { ThemeType } from "../generateFtl";
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
import { resources_common, type ThemeType } from "../../constants";
|
import {
|
||||||
import { BuildOptions } from "../BuildOptions";
|
resourcesCommonDirPathRelativeToPublicDir,
|
||||||
import { assert } from "tsafe/assert";
|
resourcesDirPathRelativeToPublicDir,
|
||||||
|
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: {
|
||||||
|
projectDirPath: string;
|
||||||
themeType: ThemeType;
|
themeType: ThemeType;
|
||||||
themeDirPath: string;
|
themeDirPath: string;
|
||||||
keycloakVersion: string;
|
keycloakVersion: string;
|
||||||
usedResources: {
|
usedResources: {
|
||||||
resourcesCommonFilePaths: string[];
|
resourcesCommonFilePaths: string[];
|
||||||
} | undefined;
|
resourcesFilePaths: string[];
|
||||||
buildOptions: BuildOptionsLike;
|
} | undefined
|
||||||
}
|
}
|
||||||
) {
|
) {
|
||||||
const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
|
const { projectDirPath, themeType, themeDirPath, keycloakVersion, usedResources } = 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({
|
||||||
|
projectDirPath,
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const resourcesPath = pathJoin(themeDirPath, themeType, "resources");
|
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
|
||||||
"destDirPath": resourcesPath
|
"destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesDirPathRelativeToPublicDir)),
|
||||||
});
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
|
||||||
"destDirPath": pathJoin(resourcesPath, resources_common),
|
|
||||||
"transformSourceCode":
|
"transformSourceCode":
|
||||||
usedResources === undefined
|
usedResources === undefined
|
||||||
? undefined
|
? undefined
|
||||||
: ({ fileRelativePath, sourceCode }) => {
|
: ({ fileRelativePath, sourceCode }) => {
|
||||||
if (usedResources.resourcesCommonDirPaths.find(dirPath => fileRelativePath.startsWith(dirPath)) === undefined) {
|
if (!usedResources.resourcesFilePaths.includes(fileRelativePath)) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
||||||
|
"destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesCommonDirPathRelativeToPublicDir)),
|
||||||
|
"transformSourceCode":
|
||||||
|
usedResources === undefined
|
||||||
|
? undefined
|
||||||
|
: ({ fileRelativePath, sourceCode }) => {
|
||||||
|
if (!usedResources.resourcesCommonFilePaths.includes(fileRelativePath)) {
|
||||||
return undefined;
|
return undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import type { ThemeType } from "../../constants";
|
import type { ThemeType } from "../generateFtl";
|
||||||
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,13 +1,13 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, basename as pathBasename, resolve as pathResolve } from "path";
|
import { join as pathJoin } 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 } from "../generateFtl";
|
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds, themeTypes, type ThemeType } from "../generateFtl";
|
||||||
import { themeTypes, type ThemeType, lastKeycloakVersionWithAccountV1, keycloak_resources, retrocompatPostfix, accountV1 } from "../../constants";
|
import { basenameOfKeycloakDirInPublicDir } from "../../mockTestingResourcesPath";
|
||||||
import { isInside } from "../../tools/isInside";
|
import { isInside } from "../../tools/isInside";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert, type Equals } from "tsafe/assert";
|
import { assert } 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";
|
||||||
@ -15,39 +15,36 @@ import { generateMessageProperties } from "./generateMessageProperties";
|
|||||||
import { readStaticResourcesUsage } from "./readStaticResourcesUsage";
|
import { readStaticResourcesUsage } from "./readStaticResourcesUsage";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
|
themeName: string;
|
||||||
extraThemeProperties: string[] | undefined;
|
extraThemeProperties: string[] | undefined;
|
||||||
themeVersion: string;
|
themeVersion: string;
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
keycloakVersionDefaultAssets: string;
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function generateTheme(params: {
|
export async function generateTheme(params: {
|
||||||
themeName: string;
|
projectDirPath: string;
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
keycloakThemeBuildingDirPath: string;
|
||||||
themeSrcDirPath: string;
|
themeSrcDirPath: string;
|
||||||
keycloakifySrcDirPath: string;
|
keycloakifySrcDirPath: string;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
}): Promise<void> {
|
}): Promise<void> {
|
||||||
const { themeName, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
|
const {
|
||||||
|
projectDirPath,
|
||||||
|
reactAppBuildDirPath,
|
||||||
|
keycloakThemeBuildingDirPath,
|
||||||
|
themeSrcDirPath,
|
||||||
|
keycloakifySrcDirPath,
|
||||||
|
buildOptions,
|
||||||
|
keycloakifyVersion
|
||||||
|
} = params;
|
||||||
|
|
||||||
const getThemeTypeDirPath = (params: { themeType: ThemeType | "email"; isRetrocompat?: true }) => {
|
const getThemeDirPath = (themeType: ThemeType | "email") =>
|
||||||
const { themeType, isRetrocompat = false } = params;
|
pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
|
||||||
return pathJoin(
|
|
||||||
buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"src",
|
|
||||||
"main",
|
|
||||||
"resources",
|
|
||||||
"theme",
|
|
||||||
`${themeName}${isRetrocompat ? retrocompatPostfix : ""}`,
|
|
||||||
themeType
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
let allCssGlobalsToDefine: Record<string, string> = {};
|
let allCssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
@ -58,7 +55,7 @@ export async function generateTheme(params: {
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
const themeTypeDirPath = getThemeTypeDirPath({ themeType });
|
const themeDirPath = getThemeDirPath(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;
|
||||||
@ -68,13 +65,13 @@ export async function generateTheme(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"destDirPath": pathJoin(themeTypeDirPath, "resources", "build"),
|
"destDirPath": pathJoin(themeDirPath, "resources", "build"),
|
||||||
"srcDirPath": buildOptions.reactAppBuildDirPath,
|
"srcDirPath": 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 (
|
||||||
isInside({
|
isInside({
|
||||||
"dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
|
"dirPath": pathJoin(reactAppBuildDirPath, basenameOfKeycloakDirInPublicDir),
|
||||||
filePath
|
filePath
|
||||||
})
|
})
|
||||||
) {
|
) {
|
||||||
@ -117,8 +114,7 @@ export async function generateTheme(params: {
|
|||||||
generateFtlFilesCode_glob !== undefined
|
generateFtlFilesCode_glob !== undefined
|
||||||
? generateFtlFilesCode_glob
|
? generateFtlFilesCode_glob
|
||||||
: generateFtlFilesCodeFactory({
|
: generateFtlFilesCodeFactory({
|
||||||
themeName,
|
"indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
|
||||||
"indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
|
|
||||||
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
||||||
buildOptions,
|
buildOptions,
|
||||||
keycloakifyVersion,
|
keycloakifyVersion,
|
||||||
@ -146,77 +142,75 @@ export async function generateTheme(params: {
|
|||||||
].forEach(pageId => {
|
].forEach(pageId => {
|
||||||
const { ftlCode } = generateFtlFilesCode({ pageId });
|
const { ftlCode } = generateFtlFilesCode({ pageId });
|
||||||
|
|
||||||
fs.mkdirSync(themeTypeDirPath, { "recursive": true });
|
fs.mkdirSync(themeDirPath, { "recursive": true });
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
||||||
});
|
});
|
||||||
|
|
||||||
generateMessageProperties({
|
generateMessageProperties({
|
||||||
themeSrcDirPath,
|
themeSrcDirPath,
|
||||||
themeType
|
themeType
|
||||||
}).forEach(({ languageTag, propertiesFileSource }) => {
|
}).forEach(({ languageTag, propertiesFileSource }) => {
|
||||||
const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
|
const messagesDirPath = pathJoin(themeDirPath, "messages");
|
||||||
|
|
||||||
fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
|
fs.mkdirSync(pathJoin(themeDirPath, "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({
|
||||||
|
projectDirPath,
|
||||||
|
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
||||||
|
"themeDirPath": keycloakDirInPublicDir,
|
||||||
|
themeType,
|
||||||
|
"usedResources": undefined
|
||||||
|
});
|
||||||
|
|
||||||
|
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({
|
||||||
"keycloakVersion": (() => {
|
projectDirPath,
|
||||||
switch (themeType) {
|
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
||||||
case "account":
|
themeDirPath,
|
||||||
return lastKeycloakVersionWithAccountV1;
|
|
||||||
case "login":
|
|
||||||
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
|
||||||
}
|
|
||||||
})(),
|
|
||||||
"themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
|
|
||||||
themeType,
|
themeType,
|
||||||
"usedResources": readStaticResourcesUsage({
|
"usedResources": readStaticResourcesUsage({
|
||||||
keycloakifySrcDirPath,
|
keycloakifySrcDirPath,
|
||||||
themeSrcDirPath,
|
themeSrcDirPath,
|
||||||
themeType
|
themeType
|
||||||
}),
|
})
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(themeTypeDirPath, "theme.properties"),
|
pathJoin(themeDirPath, "theme.properties"),
|
||||||
Buffer.from(
|
Buffer.from([`parent=keycloak`, ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
|
||||||
[
|
|
||||||
`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: {
|
||||||
@ -228,7 +222,7 @@ export async function generateTheme(params: {
|
|||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": emailThemeSrcDirPath,
|
"srcDirPath": emailThemeSrcDirPath,
|
||||||
"destDirPath": getThemeTypeDirPath({ "themeType": "email" })
|
"destDirPath": getThemeDirPath("email")
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,10 +1,9 @@
|
|||||||
import { crawl } from "../../tools/crawl";
|
import { crawl } from "../../tools/crawl";
|
||||||
import { accountThemePageIds, loginThemePageIds } from "../generateFtl";
|
import { type ThemeType, 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,7 +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 "../../constants";
|
import type { ThemeType } from "../generateFtl";
|
||||||
|
|
||||||
/** 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[] {
|
||||||
|
@ -1,15 +1,17 @@
|
|||||||
import { crawl } from "../../tools/crawl";
|
import { crawl } from "../../tools/crawl";
|
||||||
import { join as pathJoin, sep as pathSep } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import type { ThemeType } from "../../constants";
|
import type { ThemeType } from "../generateFtl";
|
||||||
|
|
||||||
/** Assumes the theme type exists */
|
/** Assumes the theme type exists */
|
||||||
export function readStaticResourcesUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): {
|
export function readStaticResourcesUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): {
|
||||||
resourcesCommonFilePaths: string[];
|
resourcesCommonFilePaths: string[];
|
||||||
|
resourcesFilePaths: string[];
|
||||||
} {
|
} {
|
||||||
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
const resourcesCommonFilePaths = new Set<string>();
|
const resourcesCommonFilePaths = new Set<string>();
|
||||||
|
const resourcesFilePaths = new Set<string>();
|
||||||
|
|
||||||
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
||||||
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
||||||
@ -24,53 +26,58 @@ export function readStaticResourcesUsage(params: { keycloakifySrcDirPath: string
|
|||||||
const wrap = readPaths({ rawSourceFile });
|
const wrap = readPaths({ rawSourceFile });
|
||||||
|
|
||||||
wrap.resourcesCommonFilePaths.forEach(filePath => resourcesCommonFilePaths.add(filePath));
|
wrap.resourcesCommonFilePaths.forEach(filePath => resourcesCommonFilePaths.add(filePath));
|
||||||
|
wrap.resourcesFilePaths.forEach(filePath => resourcesFilePaths.add(filePath));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths)
|
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths),
|
||||||
|
"resourcesFilePaths": Array.from(resourcesFilePaths)
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Exported for testing purpose */
|
/** Exported for testing purpose */
|
||||||
export function readPaths(params: { rawSourceFile: string }): {
|
export function readPaths(params: { rawSourceFile: string }): {
|
||||||
resourcesCommonFilePaths: string[];
|
resourcesCommonFilePaths: string[];
|
||||||
|
resourcesFilePaths: string[];
|
||||||
} {
|
} {
|
||||||
const { rawSourceFile } = params;
|
const { rawSourceFile } = params;
|
||||||
|
|
||||||
const resourcesCommonFilePaths = new Set<string>();
|
const resourcesCommonFilePaths = new Set<string>();
|
||||||
|
const resourcesFilePaths = new Set<string>();
|
||||||
|
|
||||||
{
|
for (const isCommon of [true, false]) {
|
||||||
const regexp = new RegExp(`resourcesCommonPath\\s*}([^\`]+)\``, "g");
|
const set = isCommon ? resourcesCommonFilePaths : resourcesFilePaths;
|
||||||
|
|
||||||
const matches = [...rawSourceFile.matchAll(regexp)];
|
{
|
||||||
|
const regexp = new RegExp(`resources${isCommon ? "Common" : ""}Path\\s*}([^\`]+)\``, "g");
|
||||||
|
|
||||||
for (const match of matches) {
|
const matches = [...rawSourceFile.matchAll(regexp)];
|
||||||
const filePath = match[1];
|
|
||||||
|
|
||||||
resourcesCommonFilePaths.add(filePath);
|
for (const match of matches) {
|
||||||
|
const filePath = match[1];
|
||||||
|
|
||||||
|
set.add(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const regexp = new RegExp(`resources${isCommon ? "Common" : ""}Path\\s*[+,]\\s*["']([^"'\`]+)["'\`]`, "g");
|
||||||
|
|
||||||
|
const matches = [...rawSourceFile.matchAll(regexp)];
|
||||||
|
|
||||||
|
for (const match of matches) {
|
||||||
|
const filePath = match[1];
|
||||||
|
|
||||||
|
set.add(filePath);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
const removePrefixSlash = (filePath: string) => (filePath.startsWith("/") ? filePath.slice(1) : 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 {
|
return {
|
||||||
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths).map(normalizePath)
|
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths).map(removePrefixSlash),
|
||||||
|
"resourcesFilePaths": Array.from(resourcesFilePaths).map(removePrefixSlash)
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
@ -1,21 +1,23 @@
|
|||||||
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, dirname as pathDirname, sep as pathSep } from "path";
|
import { join as pathJoin, relative as pathRelative, basename as pathBasename, 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 reactAppRootDirPath = process.cwd();
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
reactAppRootDirPath,
|
projectDirPath,
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -24,14 +26,19 @@ export async function main() {
|
|||||||
|
|
||||||
const keycloakifyDirPath = getProjectRoot();
|
const keycloakifyDirPath = getProjectRoot();
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
|
||||||
|
|
||||||
for (const themeName of buildOptions.themeNames) {
|
for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
|
||||||
await generateTheme({
|
await generateTheme({
|
||||||
themeName,
|
projectDirPath,
|
||||||
|
"keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
themeSrcDirPath,
|
themeSrcDirPath,
|
||||||
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
||||||
buildOptions,
|
"reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
|
||||||
|
"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"];
|
||||||
|
|
||||||
@ -42,7 +49,8 @@ export async function main() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const { jarFilePath } = await generateJavaStackFiles({
|
const { jarFilePath } = generateJavaStackFiles({
|
||||||
|
"keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
"implementedThemeTypes": (() => {
|
"implementedThemeTypes": (() => {
|
||||||
const implementedThemeTypes = {
|
const implementedThemeTypes = {
|
||||||
"login": false,
|
"login": false,
|
||||||
@ -62,45 +70,43 @@ export async function main() {
|
|||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
if (buildOptions.doCreateJar) {
|
switch (buildOptions.bundler) {
|
||||||
child_process.execSync("mvn clean install", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
case "none":
|
||||||
|
logger.log("😱 Skipping bundling step, there will be no jar");
|
||||||
const jarDirPath = pathDirname(jarFilePath);
|
break;
|
||||||
const retrocompatJarFilePath = pathJoin(jarDirPath, "retrocompat-" + pathBasename(jarFilePath));
|
case "keycloakify":
|
||||||
|
logger.log("🫶 Let keycloakify do its thang");
|
||||||
fs.renameSync(pathJoin(jarDirPath, "original-" + pathBasename(jarFilePath)), retrocompatJarFilePath);
|
await jar({
|
||||||
|
"rootPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
fs.writeFileSync(
|
"version": buildOptions.themeVersion,
|
||||||
pathJoin(jarDirPath, "README.md"),
|
"groupId": buildOptions.groupId,
|
||||||
Buffer.from(
|
"artifactId": buildOptions.artifactId,
|
||||||
[
|
"targetPath": jarFilePath
|
||||||
`- The ${jarFilePath} is to be used in Keycloak 23 and up. `,
|
});
|
||||||
`- The ${retrocompatJarFilePath} is to be used in Keycloak 22 and below.`,
|
break;
|
||||||
` Note that Keycloak 22 is only supported for login and email theme but not for account themes. `
|
case "mvn":
|
||||||
].join("\n"),
|
logger.log("🫙 Run maven to deliver a jar");
|
||||||
"utf8"
|
child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
||||||
)
|
break;
|
||||||
);
|
default:
|
||||||
|
assert<Equals<typeof buildOptions.bundler, never>>(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
const containerKeycloakVersion = "23.0.0";
|
// We want, however, to test in a container running the latest Keycloak version
|
||||||
|
const containerKeycloakVersion = "21.1.2";
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer({
|
generateStartKeycloakTestingContainer({
|
||||||
|
keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
|
||||||
"keycloakVersion": containerKeycloakVersion,
|
"keycloakVersion": containerKeycloakVersion,
|
||||||
jarFilePath,
|
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
logger.log(
|
logger.log(
|
||||||
[
|
[
|
||||||
"",
|
"",
|
||||||
...(!buildOptions.doCreateJar
|
`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(projectDirPath, jarFilePath)} 🚀`,
|
||||||
? []
|
`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:",
|
||||||
"",
|
"",
|
||||||
@ -133,7 +139,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(
|
||||||
reactAppRootDirPath,
|
projectDirPath,
|
||||||
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
||||||
)} 👈`,
|
)} 👈`,
|
||||||
"",
|
"",
|
||||||
@ -143,15 +149,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.themeNames[0]}`,
|
`- Enable the Account theme (optional): Realm settings -> Themes tab -> Account theme: ${buildOptions.themeName}`,
|
||||||
` Clients -> account -> Login theme: ${buildOptions.themeNames[0]}`,
|
` Clients -> account -> Login theme: ${buildOptions.themeName}`,
|
||||||
`- 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)`,
|
`- 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)`,
|
||||||
`- 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.themeNames[0]}`,
|
` Login Theme: ${buildOptions.themeName}`,
|
||||||
` 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,6 +4,8 @@ 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;
|
||||||
@ -13,12 +15,12 @@ export type ParsedPackageJson = {
|
|||||||
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
||||||
artifactId?: string;
|
artifactId?: string;
|
||||||
groupId?: string;
|
groupId?: string;
|
||||||
doCreateJar?: boolean;
|
bundler?: Bundler;
|
||||||
loginThemeResourcesFromKeycloakVersion?: string;
|
keycloakVersionDefaultAssets?: string;
|
||||||
reactAppBuildDirPath?: string;
|
reactAppBuildDirPath?: string;
|
||||||
keycloakifyBuildDirPath?: string;
|
keycloakifyBuildDirPath?: string;
|
||||||
themeName?: string | string[];
|
themeName?: string;
|
||||||
doBuildRetrocompatAccountTheme?: boolean;
|
extraThemeNames?: string[];
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -32,12 +34,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(),
|
||||||
"doCreateJar": z.boolean().optional(),
|
"bundler": z.enum(bundlers).optional(),
|
||||||
"loginThemeResourcesFromKeycloakVersion": z.string().optional(),
|
"keycloakVersionDefaultAssets": z.string().optional(),
|
||||||
"reactAppBuildDirPath": z.string().optional(),
|
"reactAppBuildDirPath": z.string().optional(),
|
||||||
"keycloakifyBuildDirPath": z.string().optional(),
|
"keycloakifyBuildDirPath": z.string().optional(),
|
||||||
"themeName": z.union([z.string(), z.array(z.string())]).optional(),
|
"themeName": z.string().optional(),
|
||||||
"doBuildRetrocompatAccountTheme": z.boolean().optional()
|
"extraThemeNames": z.array(z.string()).optional()
|
||||||
})
|
})
|
||||||
.optional()
|
.optional()
|
||||||
});
|
});
|
||||||
@ -45,11 +47,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: { reactAppRootDirPath: string }) {
|
export function getParsedPackageJson(params: { projectDirPath: string }) {
|
||||||
const { reactAppRootDirPath } = params;
|
const { projectDirPath } = params;
|
||||||
if (parsedPackageJson) {
|
if (parsedPackageJson) {
|
||||||
return parsedPackageJson;
|
return parsedPackageJson;
|
||||||
}
|
}
|
||||||
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
|
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")));
|
||||||
return parsedPackageJson;
|
return parsedPackageJson;
|
||||||
}
|
}
|
||||||
|
@ -16,25 +16,18 @@ export function replaceImportsFromStaticInJsCode(params: { jsCode: string }): {
|
|||||||
const { jsCode } = 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-z]+)\\){return|([a-z]+)=>)"static\\/${language}\\/"`, "g"),
|
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=function\\(([a-zA-Z]+)\\){return"static\\/${language}\\/"`, "g"),
|
||||||
(...[, n, u, matchedFunction, eForFunction]) => {
|
(...[, n, u, e]) => `
|
||||||
const isArrowFunction = matchedFunction.includes("=>");
|
${n}[(function(){
|
||||||
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
var pd= Object.getOwnPropertyDescriptor(${n}, "p");
|
||||||
|
|
||||||
return `
|
|
||||||
${n}[(function(){
|
|
||||||
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
Object.defineProperty(${n}, "p", {
|
Object.defineProperty(${n}, "p", {
|
||||||
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
||||||
set: function() {}
|
set: function (){}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
return "${u}";
|
return "${u}";
|
||||||
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/build/static/${language}/"`
|
})()] = function(${e}) { return "${true ? "/build/" : ""}static/${language}/"`
|
||||||
.replace(/\s+/g, " ")
|
|
||||||
.trim();
|
|
||||||
}
|
|
||||||
];
|
];
|
||||||
|
|
||||||
const fixedJsCode = jsCode
|
const fixedJsCode = jsCode
|
||||||
|
@ -16,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)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
5
src/bin/mockTestingResourcesPath.ts
Normal file
5
src/bin/mockTestingResourcesPath.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
import { pathJoin } from "./tools/pathJoin";
|
||||||
|
|
||||||
|
export const basenameOfKeycloakDirInPublicDir = "keycloak-resources";
|
||||||
|
export const resourcesDirPathRelativeToPublicDir = pathJoin(basenameOfKeycloakDirInPublicDir, "resources");
|
||||||
|
export const resourcesCommonDirPathRelativeToPublicDir = pathJoin(resourcesDirPathRelativeToPublicDir, "resources_common");
|
@ -1,7 +1,6 @@
|
|||||||
import { getLatestsSemVersionedTagFactory } from "./tools/octokit-addons/getLatestsSemVersionedTag";
|
import { getLatestsSemVersionedTagFactory } from "./tools/octokit-addons/getLatestsSemVersionedTag";
|
||||||
import { Octokit } from "@octokit/rest";
|
import { Octokit } from "@octokit/rest";
|
||||||
import cliSelect from "cli-select";
|
import cliSelect from "cli-select";
|
||||||
import { lastKeycloakVersionWithAccountV1 } from "./constants";
|
|
||||||
|
|
||||||
export async function promptKeycloakVersion() {
|
export async function promptKeycloakVersion() {
|
||||||
const { getLatestsSemVersionedTag } = (() => {
|
const { getLatestsSemVersionedTag } = (() => {
|
||||||
@ -18,7 +17,7 @@ export async function promptKeycloakVersion() {
|
|||||||
return { getLatestsSemVersionedTag };
|
return { getLatestsSemVersionedTag };
|
||||||
})();
|
})();
|
||||||
|
|
||||||
console.log("Select Keycloak version?");
|
console.log("Initialize the directory with email template from which keycloak version?");
|
||||||
|
|
||||||
const tags = [
|
const tags = [
|
||||||
...(await getLatestsSemVersionedTag({
|
...(await getLatestsSemVersionedTag({
|
||||||
@ -27,7 +26,6 @@ export async function promptKeycloakVersion() {
|
|||||||
"owner": "keycloak",
|
"owner": "keycloak",
|
||||||
"repo": "keycloak"
|
"repo": "keycloak"
|
||||||
}).then(arr => arr.map(({ tag }) => tag))),
|
}).then(arr => arr.map(({ tag }) => tag))),
|
||||||
lastKeycloakVersionWithAccountV1,
|
|
||||||
"11.0.3"
|
"11.0.3"
|
||||||
];
|
];
|
||||||
|
|
||||||
|
@ -162,7 +162,7 @@ export async function downloadAndUnzip(
|
|||||||
} & (
|
} & (
|
||||||
| {
|
| {
|
||||||
doUseCache: true;
|
doUseCache: true;
|
||||||
cacheDirPath: string;
|
projectDirPath: string;
|
||||||
}
|
}
|
||||||
| {
|
| {
|
||||||
doUseCache: false;
|
doUseCache: false;
|
||||||
@ -182,10 +182,11 @@ export async function downloadAndUnzip(
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const cacheDirPath = !rest.doUseCache ? `tmp_${Math.random().toString().slice(2, 12)}` : rest.cacheDirPath;
|
const cacheRoot = !rest.doUseCache
|
||||||
|
? `tmp_${Math.random().toString().slice(2, 12)}`
|
||||||
const zipFilePath = pathJoin(cacheDirPath, `${zipFileBasename}.zip`);
|
: pathJoin(process.env.XDG_CACHE_HOME ?? pathJoin(rest.projectDirPath, "node_modules", ".cache"), "keycloakify");
|
||||||
const extractDirPath = pathJoin(cacheDirPath, `tmp_unzip_${zipFileBasename}`);
|
const zipFilePath = pathJoin(cacheRoot, `${zipFileBasename}.zip`);
|
||||||
|
const extractDirPath = pathJoin(cacheRoot, `tmp_unzip_${zipFileBasename}`);
|
||||||
|
|
||||||
if (!(await exists(zipFilePath))) {
|
if (!(await exists(zipFilePath))) {
|
||||||
const opts = await getFetchOptions();
|
const opts = await getFetchOptions();
|
||||||
@ -225,7 +226,7 @@ export async function downloadAndUnzip(
|
|||||||
});
|
});
|
||||||
|
|
||||||
if (!rest.doUseCache) {
|
if (!rest.doUseCache) {
|
||||||
await rm(cacheDirPath, { "recursive": true });
|
await rm(cacheRoot, { "recursive": true });
|
||||||
} else {
|
} else {
|
||||||
await rm(extractDirPath, { "recursive": true });
|
await rm(extractDirPath, { "recursive": true });
|
||||||
}
|
}
|
||||||
|
@ -1,15 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
99
src/bin/tools/jar.ts
Normal file
99
src/bin/tools/jar.ts
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
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(typeof process !== "undefined" && process.platform === "win32" ? "\\" : "/");
|
.join("/");
|
||||||
}
|
}
|
||||||
|
19
src/bin/tools/walk.ts
Normal file
19
src/bin/tools/walk.ts
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
@ -23,21 +23,24 @@ export function usePrepareTemplate(params: {
|
|||||||
const removeArray: (() => void)[] = [];
|
const removeArray: (() => void)[] = [];
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
for (const style of [...styles].reverse()) {
|
const prLoadedArray: Promise<void>[] = [];
|
||||||
|
|
||||||
|
styles.reverse().forEach(href => {
|
||||||
const { prLoaded, remove } = headInsert({
|
const { prLoaded, remove } = headInsert({
|
||||||
"type": "css",
|
"type": "css",
|
||||||
"position": "prepend",
|
"position": "prepend",
|
||||||
"href": style
|
href
|
||||||
});
|
});
|
||||||
|
|
||||||
removeArray.push(remove);
|
removeArray.push(remove);
|
||||||
|
|
||||||
// TODO: Find a way to do that in parallel (without breaking the order)
|
prLoadedArray.push(prLoaded);
|
||||||
await prLoaded;
|
});
|
||||||
|
|
||||||
if (isUnmounted) {
|
await Promise.all(prLoadedArray);
|
||||||
return;
|
|
||||||
}
|
if (isUnmounted) {
|
||||||
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
setReady();
|
setReady();
|
||||||
|
@ -12,8 +12,6 @@ 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"));
|
||||||
@ -54,10 +52,6 @@ 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":
|
||||||
|
@ -38,15 +38,13 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
`${url.resourcesPath}/css/login.css`
|
`${url.resourcesPath}/css/login.css`
|
||||||
],
|
],
|
||||||
"htmlClassName": getClassName("kcHtmlClass"),
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
"bodyClassName": getClassName("kcBodyClass")
|
"bodyClassName": undefined
|
||||||
});
|
});
|
||||||
|
|
||||||
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,7 +21,6 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey =
|
export type ClassKey =
|
||||||
| "kcBodyClass"
|
|
||||||
| "kcHtmlClass"
|
| "kcHtmlClass"
|
||||||
| "kcLoginClass"
|
| "kcLoginClass"
|
||||||
| "kcHeaderClass"
|
| "kcHeaderClass"
|
||||||
@ -94,6 +93,4 @@ export type ClassKey =
|
|||||||
| "kcSelectOTPListItemClass"
|
| "kcSelectOTPListItemClass"
|
||||||
| "kcAuthenticatorOtpCircleClass"
|
| "kcAuthenticatorOtpCircleClass"
|
||||||
| "kcSelectOTPItemHeadingClass"
|
| "kcSelectOTPItemHeadingClass"
|
||||||
| "kcFormOptionsWrapperClass"
|
| "kcFormOptionsWrapperClass";
|
||||||
| "kcFormButtonsWrapperClass"
|
|
||||||
| "kcInputGroup";
|
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { LoginThemePageId, ThemeType } 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";
|
||||||
@ -19,8 +18,6 @@ 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
|
||||||
@ -40,7 +37,6 @@ 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;
|
||||||
@ -82,7 +78,6 @@ 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: {
|
||||||
@ -246,27 +241,6 @@ 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,8 +8,9 @@ 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>>[];
|
||||||
@ -147,7 +148,11 @@ 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,11 +1,13 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import type { KcContext, Attribute } from "./KcContext";
|
import type { KcContext, Attribute } from "./KcContext";
|
||||||
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
import { resourcesCommonDirPathRelativeToPublicDir, resourcesDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
||||||
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": {
|
||||||
@ -100,19 +102,14 @@ 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,
|
"resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
|
||||||
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
"resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
|
||||||
"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"
|
||||||
},
|
},
|
||||||
@ -234,8 +231,7 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"showTryAnotherWayLink": false
|
"showTryAnotherWayLink": false
|
||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp"
|
||||||
"attributes": {}
|
|
||||||
},
|
},
|
||||||
"scripts": [],
|
"scripts": [],
|
||||||
"isAppInitiatedAction": false
|
"isAppInitiatedAction": false
|
||||||
@ -244,9 +240,7 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
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 = [
|
||||||
@ -315,8 +309,7 @@ export const kcContextMocks = [
|
|||||||
"actionUri": "#",
|
"actionUri": "#",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#",
|
"baseUrl": "#"
|
||||||
"attributes": {}
|
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
id<KcContext.Error>({
|
id<KcContext.Error>({
|
||||||
@ -324,8 +317,7 @@ export const kcContextMocks = [
|
|||||||
"pageId": "error.ftl",
|
"pageId": "error.ftl",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#",
|
"baseUrl": "#"
|
||||||
"attributes": {}
|
|
||||||
},
|
},
|
||||||
"message": {
|
"message": {
|
||||||
"type": "error",
|
"type": "error",
|
||||||
@ -352,25 +344,6 @@ 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",
|
||||||
@ -499,8 +472,7 @@ export const kcContextMocks = [
|
|||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#",
|
"baseUrl": "#"
|
||||||
"attributes": {}
|
|
||||||
},
|
},
|
||||||
"logoutConfirm": { "code": "123", skipLink: false }
|
"logoutConfirm": { "code": "123", skipLink: false }
|
||||||
}),
|
}),
|
||||||
|
@ -3,7 +3,6 @@ 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",
|
||||||
@ -45,7 +44,6 @@ 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",
|
||||||
@ -67,7 +65,6 @@ 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",
|
||||||
@ -94,7 +91,7 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
"kcAuthenticatorWebAuthnPasswordlessClass": "fa fa-key list-view-pf-icon-lg",
|
"kcAuthenticatorWebAuthnPasswordlessClass": "fa fa-key list-view-pf-icon-lg",
|
||||||
|
|
||||||
//css classes for the OTP Login Form
|
//css classes for the OTP Login Form
|
||||||
"kcSelectOTPListClass": "card-pf card-pf-view card-pf-view-select card-pf-view-single-select col-xs-12",
|
"kcSelectOTPListClass": "card-pf card-pf-view card-pf-view-select card-pf-view-single-select",
|
||||||
"kcSelectOTPListItemClass": "card-pf-body card-pf-top-element",
|
"kcSelectOTPListItemClass": "card-pf-body card-pf-top-element",
|
||||||
"kcAuthenticatorOtpCircleClass": "fa fa-mobile card-pf-icon-circle",
|
"kcAuthenticatorOtpCircleClass": "fa fa-mobile card-pf-icon-circle",
|
||||||
"kcSelectOTPItemHeadingClass": "card-pf-title text-center",
|
"kcSelectOTPItemHeadingClass": "card-pf-title text-center",
|
||||||
|
@ -8,10 +8,7 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
|
|||||||
|
|
||||||
const { msgStr, msg } = i18n;
|
const { msgStr, msg } = i18n;
|
||||||
|
|
||||||
assert(
|
assert(kcContext.message !== undefined);
|
||||||
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,18 +37,22 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
|
|||||||
return (
|
return (
|
||||||
<Template
|
<Template
|
||||||
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
||||||
displayInfo={realm.password && realm.registrationAllowed && !registrationDisabled}
|
displayInfo={social.displayInfo}
|
||||||
displayWide={realm.password && social.providers !== undefined}
|
displayWide={realm.password && social.providers !== undefined}
|
||||||
headerNode={msg("doLogIn")}
|
headerNode={msg("doLogIn")}
|
||||||
infoNode={
|
infoNode={
|
||||||
<div id="kc-registration">
|
realm.password &&
|
||||||
<span>
|
realm.registrationAllowed &&
|
||||||
{msg("noAccount")}
|
!registrationDisabled && (
|
||||||
<a tabIndex={6} href={url.registrationUrl}>
|
<div id="kc-registration">
|
||||||
{msg("doRegister")}
|
<span>
|
||||||
</a>
|
{msg("noAccount")}
|
||||||
</span>
|
<a tabIndex={6} href={url.registrationUrl}>
|
||||||
</div>
|
{msg("doRegister")}
|
||||||
|
</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>{msg(app as MessageKey)}</li>
|
<li>{msgStr(app as MessageKey, app)}</li>
|
||||||
))}
|
))}
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
|
@ -1,67 +0,0 @@
|
|||||||
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>
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,72 +0,0 @@
|
|||||||
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,3 +1,5 @@
|
|||||||
|
import { useEffect } from "react";
|
||||||
|
import { headInsert } from "keycloakify/tools/headInsert";
|
||||||
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";
|
||||||
@ -16,77 +18,105 @@ export default function LoginOtp(props: PageProps<Extract<KcContext, { pageId: "
|
|||||||
|
|
||||||
const { msg, msgStr } = i18n;
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
let isCleanedUp = false;
|
||||||
|
|
||||||
|
const { prLoaded, remove } = headInsert({
|
||||||
|
"type": "javascript",
|
||||||
|
"src": `${kcContext.url.resourcesCommonPath}/node_modules/jquery/dist/jquery.min.js`
|
||||||
|
});
|
||||||
|
|
||||||
|
(async () => {
|
||||||
|
await prLoaded;
|
||||||
|
|
||||||
|
if (isCleanedUp) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
evaluateInlineScript();
|
||||||
|
})();
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
isCleanedUp = true;
|
||||||
|
remove();
|
||||||
|
};
|
||||||
|
}, []);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("doLogIn")}>
|
||||||
<style>
|
<form id="kc-otp-login-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
|
||||||
{`
|
{otpLogin.userOtpCredentials.length > 1 && (
|
||||||
input[type="radio"]:checked~label.kcSelectOTPListClass{
|
|
||||||
border: 2px solid #39a5dc;
|
|
||||||
}`}
|
|
||||||
</style>
|
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("doLogIn")}>
|
|
||||||
<form id="kc-otp-login-form" className={getClassName("kcFormClass")} action={url.loginAction} method="post">
|
|
||||||
{otpLogin.userOtpCredentials.length > 1 && (
|
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
|
||||||
<div className={getClassName("kcInputWrapperClass")}>
|
|
||||||
{otpLogin.userOtpCredentials.map((otpCredential, index) => (
|
|
||||||
<div key={otpCredential.id}>
|
|
||||||
<input
|
|
||||||
id={`kc-otp-credential-${index}`}
|
|
||||||
name="selectedCredentialId"
|
|
||||||
type="radio"
|
|
||||||
value={otpCredential.id}
|
|
||||||
style={{ display: "none" }}
|
|
||||||
/>
|
|
||||||
<label
|
|
||||||
htmlFor={`kc-otp-credential-${index}`}
|
|
||||||
key={otpCredential.id}
|
|
||||||
className={getClassName("kcSelectOTPListClass")}
|
|
||||||
>
|
|
||||||
<div className={getClassName("kcSelectOTPListItemClass")}>
|
|
||||||
<span className={getClassName("kcAuthenticatorOtpCircleClass")} />
|
|
||||||
<h2 className={getClassName("kcSelectOTPItemHeadingClass")}>{otpCredential.userLabel}</h2>
|
|
||||||
</div>
|
|
||||||
</label>
|
|
||||||
</div>
|
|
||||||
))}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
<div className={getClassName("kcLabelWrapperClass")}>
|
|
||||||
<label htmlFor="otp" className={getClassName("kcLabelClass")}>
|
|
||||||
{msg("loginOtpOneTime")}
|
|
||||||
</label>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div className={getClassName("kcInputWrapperClass")}>
|
<div className={getClassName("kcInputWrapperClass")}>
|
||||||
<input id="otp" name="otp" autoComplete="off" type="text" className={getClassName("kcInputClass")} autoFocus />
|
{otpLogin.userOtpCredentials.map(otpCredential => (
|
||||||
|
<div key={otpCredential.id} className={getClassName("kcSelectOTPListClass")}>
|
||||||
|
<input type="hidden" value="${otpCredential.id}" />
|
||||||
|
<div className={getClassName("kcSelectOTPListItemClass")}>
|
||||||
|
<span className={getClassName("kcAuthenticatorOtpCircleClass")} />
|
||||||
|
<h2 className={getClassName("kcSelectOTPItemHeadingClass")}>{otpCredential.userLabel}</h2>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
)}
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
<div id="kc-form-options" className={getClassName("kcFormOptionsClass")}>
|
<div className={getClassName("kcLabelWrapperClass")}>
|
||||||
<div className={getClassName("kcFormOptionsWrapperClass")} />
|
<label htmlFor="otp" className={getClassName("kcLabelClass")}>
|
||||||
</div>
|
{msg("loginOtpOneTime")}
|
||||||
|
</label>
|
||||||
<div id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
|
|
||||||
<input
|
|
||||||
className={clsx(
|
|
||||||
getClassName("kcButtonClass"),
|
|
||||||
getClassName("kcButtonPrimaryClass"),
|
|
||||||
getClassName("kcButtonBlockClass"),
|
|
||||||
getClassName("kcButtonLargeClass")
|
|
||||||
)}
|
|
||||||
name="login"
|
|
||||||
id="kc-login"
|
|
||||||
type="submit"
|
|
||||||
value={msgStr("doLogIn")}
|
|
||||||
/>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</form>
|
|
||||||
</Template>
|
<div className={getClassName("kcInputWrapperClass")}>
|
||||||
</>
|
<input id="otp" name="otp" 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 id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonPrimaryClass"),
|
||||||
|
getClassName("kcButtonBlockClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
name="login"
|
||||||
|
id="kc-login"
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doLogIn")}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</Template>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
declare const $: any;
|
||||||
|
|
||||||
|
function evaluateInlineScript() {
|
||||||
|
$(document).ready(function () {
|
||||||
|
// Card Single Select
|
||||||
|
$(".card-pf-view-single-select").click(function (this: any) {
|
||||||
|
if ($(this).hasClass("active")) {
|
||||||
|
$(this).removeClass("active");
|
||||||
|
$(this).children().removeAttr("name");
|
||||||
|
} else {
|
||||||
|
$(".card-pf-view-single-select").removeClass("active");
|
||||||
|
$(".card-pf-view-single-select").children().removeAttr("name");
|
||||||
|
$(this).addClass("active");
|
||||||
|
$(this).children().attr("name", "selectedCredentialId");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
var defaultCred = $(".card-pf-view-single-select")[0];
|
||||||
|
if (defaultCred) {
|
||||||
|
defaultCred.click();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
@ -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: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
|
@ -1,3 +0,0 @@
|
|||||||
import type { LazyExoticComponent, ComponentType } from "react";
|
|
||||||
|
|
||||||
export type LazyOrNot<Component extends ComponentType<any>> = LazyExoticComponent<Component> | Component;
|
|
@ -21,13 +21,4 @@ const meta: ComponentMeta<any> = {
|
|||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
|
|
||||||
export const Default = () => (
|
export const Default = () => <PageStory />;
|
||||||
<PageStory
|
|
||||||
kcContext={{
|
|
||||||
message: {
|
|
||||||
summary: "This is the server message",
|
|
||||||
type: "info"
|
|
||||||
}
|
|
||||||
}}
|
|
||||||
/>
|
|
||||||
);
|
|
||||||
|
@ -1,24 +0,0 @@
|
|||||||
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 />;
|
|
@ -1,24 +0,0 @@
|
|||||||
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 />;
|
|
131
test/bin/jar.spec.ts
Normal file
131
test/bin/jar.spec.ts
Normal file
@ -0,0 +1,131 @@
|
|||||||
|
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("', '")}')`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
@ -9,7 +9,8 @@ describe("Ensure it's able to extract used Keycloak resources", () => {
|
|||||||
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
||||||
"lib/zocial/zocial.css",
|
"lib/zocial/zocial.css",
|
||||||
"node_modules/jquery/dist/jquery.min.js"
|
"node_modules/jquery/dist/jquery.min.js"
|
||||||
]
|
],
|
||||||
|
"resourcesFilePaths": ["css/login.css"]
|
||||||
};
|
};
|
||||||
|
|
||||||
it("works with coding style n°1", () => {
|
it("works with coding style n°1", () => {
|
||||||
@ -67,6 +68,9 @@ describe("Ensure it's able to extract used Keycloak resources", () => {
|
|||||||
`
|
`
|
||||||
});
|
});
|
||||||
|
|
||||||
|
console.log(paths);
|
||||||
|
console.log(expectedPaths);
|
||||||
|
|
||||||
expect(same(paths, expectedPaths)).toBe(true);
|
expect(same(paths, expectedPaths)).toBe(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -32,10 +32,6 @@ 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({
|
||||||
@ -56,11 +52,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";
|
||||||
@ -73,11 +69,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";
|
||||||
@ -87,28 +83,7 @@ describe("bin/js-transforms", () => {
|
|||||||
908:"67c9ed2c"
|
908:"67c9ed2c"
|
||||||
} [e] + ".chunk.css"
|
} [e] + ".chunk.css"
|
||||||
}
|
}
|
||||||
|
|
||||||
n[(function(){
|
|
||||||
var pd = Object.getOwnPropertyDescriptor(n, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
|
||||||
Object.defineProperty(n, "p", {
|
|
||||||
get: function() { return window.kcContext.url.resourcesPath; },
|
|
||||||
set: function() {}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return "u";
|
|
||||||
})()] = e => "/build/static/js/"+e+"."+{69:"4f205f87",128:"49264537",453:"b2fed72e",482:"f0106901"}[e]+".chunk.js"
|
|
||||||
|
|
||||||
t[(function(){
|
|
||||||
var pd = Object.getOwnPropertyDescriptor(t, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
|
||||||
Object.defineProperty(t, "p", {
|
|
||||||
get: function() { return window.kcContext.url.resourcesPath; },
|
|
||||||
set: function() {}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return "miniCssF";
|
|
||||||
})()] = e => "/build/static/css/"+e+"."+{164:"dcfd7749",908:"67c9ed2c"}[e]+".chunk.css"
|
|
||||||
`;
|
`;
|
||||||
|
|
||||||
expect(isSameCode(fixedJsCode, fixedJsCodeExpected)).toBe(true);
|
expect(isSameCode(fixedJsCode, fixedJsCodeExpected)).toBe(true);
|
||||||
@ -124,7 +99,7 @@ describe("bin/css-transforms", () => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.my-div2 {
|
.my-div2 {
|
||||||
background: url(/logo192.png) repeat center center;
|
background: url(/logo192.png) no-repeat center center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div {
|
.my-div {
|
||||||
@ -135,11 +110,11 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const fixedCssCodeExpected = `
|
const fixedCssCodeExpected = `
|
||||||
.my-div {
|
.my-div {
|
||||||
background: var(--urla882a969fd39473) no-repeat center center;
|
background: var(--url1f9ef5a892c104c);
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div2 {
|
.my-div2 {
|
||||||
background: var(--urla882a969fd39473) repeat center center;
|
background: var(--url1f9ef5a892c104c);
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div {
|
.my-div {
|
||||||
@ -150,7 +125,7 @@ describe("bin/css-transforms", () => {
|
|||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
||||||
|
|
||||||
const cssGlobalsToDefineExpected = {
|
const cssGlobalsToDefineExpected = {
|
||||||
"urla882a969fd39473": "url(/logo192.png)",
|
"url1f9ef5a892c104c": "url(/logo192.png) no-repeat center center",
|
||||||
"urldd75cab58377c19": "url(/static/media/something.svg)"
|
"urldd75cab58377c19": "url(/static/media/something.svg)"
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -165,7 +140,7 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const cssCodeToPrependInHeadExpected = `
|
const cssCodeToPrependInHeadExpected = `
|
||||||
:root {
|
:root {
|
||||||
--urla882a969fd39473: url(\${url.resourcesPath}/build/logo192.png);
|
--url1f9ef5a892c104c: url(\${url.resourcesPath}/build/logo192.png) no-repeat center center;
|
||||||
--urldd75cab58377c19: url(\${url.resourcesPath}/build/static/media/something.svg);
|
--urldd75cab58377c19: url(\${url.resourcesPath}/build/static/media/something.svg);
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
@ -191,11 +166,11 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const fixedCssCodeExpected = `
|
const fixedCssCodeExpected = `
|
||||||
.my-div {
|
.my-div {
|
||||||
background: var(--url749a3139386b2c8) no-repeat center center;
|
background: var(--urlf8277cddaa2be78);
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div2 {
|
.my-div2 {
|
||||||
background: var(--url749a3139386b2c8) no-repeat center center;
|
background: var(--urlf8277cddaa2be78);
|
||||||
}
|
}
|
||||||
|
|
||||||
.my-div {
|
.my-div {
|
||||||
@ -206,7 +181,7 @@ describe("bin/css-transforms", () => {
|
|||||||
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
expect(isSameCode(fixedCssCode, fixedCssCodeExpected)).toBe(true);
|
||||||
|
|
||||||
const cssGlobalsToDefineExpected = {
|
const cssGlobalsToDefineExpected = {
|
||||||
"url749a3139386b2c8": "url(/x/y/z/logo192.png)",
|
"urlf8277cddaa2be78": "url(/x/y/z/logo192.png) no-repeat center center",
|
||||||
"url8bdc0887b97ac9a": "url(/x/y/z/static/media/something.svg)"
|
"url8bdc0887b97ac9a": "url(/x/y/z/static/media/something.svg)"
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -221,7 +196,7 @@ describe("bin/css-transforms", () => {
|
|||||||
|
|
||||||
const cssCodeToPrependInHeadExpected = `
|
const cssCodeToPrependInHeadExpected = `
|
||||||
:root {
|
:root {
|
||||||
--url749a3139386b2c8: url(\${url.resourcesPath}/build/logo192.png);
|
--urlf8277cddaa2be78: url(\${url.resourcesPath}/build/logo192.png) no-repeat center center;
|
||||||
--url8bdc0887b97ac9a: url(\${url.resourcesPath}/build/static/media/something.svg);
|
--url8bdc0887b97ac9a: url(\${url.resourcesPath}/build/static/media/something.svg);
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
|
@ -24,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;
|
||||||
@ -52,25 +52,19 @@ describe("Sample Project", () => {
|
|||||||
await setupSampleReactProject(sampleReactProjectDirPath);
|
await setupSampleReactProject(sampleReactProjectDirPath);
|
||||||
await initializeEmailTheme();
|
await initializeEmailTheme();
|
||||||
|
|
||||||
const reactAppRootDirPath = process.cwd();
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const destDirPath = pathJoin(
|
const destDirPath = pathJoin(
|
||||||
readBuildOptions({
|
readBuildOptions({
|
||||||
"processArgv": ["--silent"],
|
"processArgv": ["--silent"],
|
||||||
reactAppRootDirPath
|
projectDirPath
|
||||||
}).keycloakifyBuildDirPath,
|
}).keycloakifyBuildDirPath,
|
||||||
"src",
|
"src",
|
||||||
"main",
|
"main",
|
||||||
"resources",
|
"resources",
|
||||||
"theme"
|
"theme"
|
||||||
);
|
);
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({ destDirPath, "keycloakVersion": "11.0.3", projectDirPath });
|
||||||
destDirPath,
|
|
||||||
"keycloakVersion": "11.0.3",
|
|
||||||
"buildOptions": {
|
|
||||||
"cacheDirPath": pathJoin(reactAppRootDirPath, "node_modules", ".cache", "keycloakify")
|
|
||||||
}
|
|
||||||
});
|
|
||||||
},
|
},
|
||||||
{ timeout: 90000 }
|
{ timeout: 90000 }
|
||||||
);
|
);
|
||||||
@ -86,25 +80,19 @@ describe("Sample Project", () => {
|
|||||||
await setupSampleReactProject(pathJoin(sampleReactProjectDirPath, "custom_input"));
|
await setupSampleReactProject(pathJoin(sampleReactProjectDirPath, "custom_input"));
|
||||||
await initializeEmailTheme();
|
await initializeEmailTheme();
|
||||||
|
|
||||||
const reactAppRootDirPath = process.cwd();
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const destDirPath = pathJoin(
|
const destDirPath = pathJoin(
|
||||||
readBuildOptions({
|
readBuildOptions({
|
||||||
"processArgv": ["--silent"],
|
"processArgv": ["--silent"],
|
||||||
reactAppRootDirPath
|
projectDirPath
|
||||||
}).keycloakifyBuildDirPath,
|
}).keycloakifyBuildDirPath,
|
||||||
"src",
|
"src",
|
||||||
"main",
|
"main",
|
||||||
"resources",
|
"resources",
|
||||||
"theme"
|
"theme"
|
||||||
);
|
);
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({ destDirPath, "keycloakVersion": "11.0.3", projectDirPath });
|
||||||
destDirPath,
|
|
||||||
"keycloakVersion": "11.0.3",
|
|
||||||
buildOptions: {
|
|
||||||
"cacheDirPath": pathJoin(reactAppRootDirPath, "node_modules", ".cache", "keycloakify")
|
|
||||||
}
|
|
||||||
});
|
|
||||||
},
|
},
|
||||||
{ timeout: 90000 }
|
{ timeout: 90000 }
|
||||||
);
|
);
|
||||||
|
65
test/bin/tools/trimIndet.spec.ts
Normal file
65
test/bin/tools/trimIndet.spec.ts
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
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