Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
6e666b6ee2 | |||
4c66c9877a | |||
e8fce5f796 | |||
481131d58b | |||
0a4e71e149 | |||
96f5139421 |
.all-contributorsrcvitest.config.tsyarn.lock
.github/workflows
README.mdkeycloakify-json-schema.jsonpackage.jsonscripts
src
PUBLIC_URL.ts
account
bin
constants.tscopy-keycloak-resources-to-public.tsdownload-builtin-keycloak-theme.tsdownloadAndUnzip.tseject-keycloak-page.tsgetSrcDirPath.tsinitialize-email-theme.ts
keycloakify
BuildOptions.ts
mockTestingResourcesPath.tspromptKeycloakVersion.tsbuildOptions
UserProvidedBuildOptions.tsbuildOptions.tsgetCacheDirPath.tsgetNpmWorkspaceRootDirPath.tsgetReactAppRootDirPath.tsindex.tsparsedPackageJson.tsresolvedViteConfig.ts
ftlValuesGlobalName.tsgenerateFtl
generateJavaStackFiles.tsgeneratePom.tsgenerateStartKeycloakTestingContainer.tsgenerateTheme
bringInAccountV1.tsdownloadKeycloakStaticResources.tsgenerateMessageProperties.tsgenerateTheme.tsreadExtraPageNames.tsreadFieldNameUsage.tsreadStaticResourcesUsage.ts
keycloakify.tsparsedPackageJson.tsreplacers
tools
NpmModuleVersion.tsOptionalIfCanBeUndefined.tsSemVer.tsString.prototype.replaceAll.tscrawl.tsdownloadAndUnzip.tsfetchProxyOptions.tsfs.existsAsync.tsfs.rm.tsfs.rmSync.tsgetAbsoluteAndInOsFormatPath.tsgetProjectRoot.tsgrant-exec-perms.tsjar.ts
octokit-addons
pathJoin.tsreadThisNpmProjectVersion.tstransformCodebase.tswalk.tslib
login
tools
tsconfig.jsonvite-plugin
stories/account/pages
test
bin
jar.spec.tsreadStaticResourcesUsage.spec.tsreplaceImportFromStatic.spec.tsreplacers.spec.tssetupSampleReactProject.spec.tssetupSampleReactProject.ts
tsconfig.jsontools
@ -186,51 +186,6 @@
|
|||||||
"contributions": [
|
"contributions": [
|
||||||
"code"
|
"code"
|
||||||
]
|
]
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "xgp",
|
|
||||||
"name": "Garth",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/244253?v=4",
|
|
||||||
"profile": "https://github.com/xgp",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "BlackVoid",
|
|
||||||
"name": "Felix Gustavsson",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/673720?v=4",
|
|
||||||
"profile": "https://github.com/BlackVoid",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "msiemens",
|
|
||||||
"name": "Markus Siemens",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/1873922?v=4",
|
|
||||||
"profile": "https://m-siemens.de/",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "law108000",
|
|
||||||
"name": "Rlok",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/8112024?v=4",
|
|
||||||
"profile": "https://github.com/law108000",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"login": "Moulyy",
|
|
||||||
"name": "Moulyy",
|
|
||||||
"avatar_url": "https://avatars.githubusercontent.com/u/115405804?v=4",
|
|
||||||
"profile": "https://github.com/Moulyy",
|
|
||||||
"contributions": [
|
|
||||||
"code"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"contributorsPerLine": 7,
|
"contributorsPerLine": 7,
|
||||||
|
1
.github/workflows/ci.yaml
vendored
1
.github/workflows/ci.yaml
vendored
@ -3,6 +3,7 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
- v8
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
144
README.md
144
README.md
@ -14,6 +14,9 @@
|
|||||||
<a href="https://github.com/garronej/keycloakify/blob/main/LICENSE">
|
<a href="https://github.com/garronej/keycloakify/blob/main/LICENSE">
|
||||||
<img src="https://img.shields.io/npm/l/keycloakify">
|
<img src="https://img.shields.io/npm/l/keycloakify">
|
||||||
</a>
|
</a>
|
||||||
|
<a href="https://github.com/keycloakify/keycloakify/blob/729503fe31a155a823f46dd66ad4ff34ca274e0a/tsconfig.json#L14">
|
||||||
|
<img src="https://camo.githubusercontent.com/0f9fcc0ac1b8617ad4989364f60f78b2d6b32985ad6a508f215f14d8f897b8d3/68747470733a2f2f62616467656e2e6e65742f62616467652f547970655363726970742f7374726963742532302546302539462539322541412f626c7565">
|
||||||
|
</a>
|
||||||
<a href="https://github.com/thomasdarimont/awesome-keycloak">
|
<a href="https://github.com/thomasdarimont/awesome-keycloak">
|
||||||
<img src="https://awesome.re/mentioned-badge.svg"/>
|
<img src="https://awesome.re/mentioned-badge.svg"/>
|
||||||
</a>
|
</a>
|
||||||
@ -33,14 +36,26 @@
|
|||||||
|
|
||||||
<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.
|
||||||
|
|
||||||
## Sponsor
|
> 📣 🛑 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**.
|
||||||
|
> UPDATE: [The PR](https://github.com/keycloak/keycloak/pull/22317) that should future proof Keycloakify account themes has been
|
||||||
|
> merged into Keycloak! 🥳 Credit to @xgp. We are now waiting for a new Keycloak release to be published.
|
||||||
|
|
||||||
|
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. (Well except for Keycloak 22's Account theme obviously but this was hopefully a one time debacle)
|
||||||
|
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 👼
|
||||||
|
|
||||||
We are exclusively sponsored by [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), a French company offering Keycloak as a service.
|
We are exclusively sponsored by [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), a French company offering Keycloak as a service.
|
||||||
Their dedicated support helps us continue the development and maintenance of this project.
|
Their dedicated support helps us continue the development and maintenance of this project.
|
||||||
@ -63,12 +78,12 @@ Their dedicated support helps us continue the development and maintenance of thi
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<i>Checkout <a href="https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github">Cloud-IAM</a> and use promo code <code>keycloakify5</code></i>
|
<i>Checkout <a href="https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github">Cloud IAM</a> and use promo code <code>keycloakify5</code></i>
|
||||||
<br/>
|
<br/>
|
||||||
<i>5% of your annual subscription will be donated to us, and you'll get 5% off too.</i>
|
<i>5% of your annual subscription will be donated to us, and you'll get 5% off too.</i>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
Thank you, [Cloud-IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), for your support!
|
Thank you, [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), for your support!
|
||||||
|
|
||||||
## Contributors ✨
|
## Contributors ✨
|
||||||
|
|
||||||
@ -104,14 +119,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
<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/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/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/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>
|
||||||
@ -123,28 +130,6 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
|
|
||||||
# Changelog highlights
|
# Changelog highlights
|
||||||
|
|
||||||
## 9.5
|
|
||||||
|
|
||||||
- Post build hook: You can now apply custom transformation to your theme files. [Learn more](https://docs.keycloakify.dev/build-options#postbuild-hook).
|
|
||||||
- You can now specify your option in the Keycloakify's Vite plugin instead in the package.json. [See example](https://docs.keycloakify.dev/build-options#themename).
|
|
||||||
|
|
||||||
## 9.4
|
|
||||||
|
|
||||||
**Vite Support! 🎉**
|
|
||||||
|
|
||||||
- [The starter is now a Vite project](https://github.com/keycloakify/keycloakify-starter).
|
|
||||||
The Webpack based starter is accessible [here](https://github.com/keycloakify/keycloakify-starter-cra).
|
|
||||||
- CRA (Webpack) remains supported for the forseable future.
|
|
||||||
- If you have a CRA Keycloakify theme that you wish to migrate to Vite checkout [this migration guide](https://docs.keycloakify.dev/migration-guides/cra-greater-than-vite).
|
|
||||||
|
|
||||||
## 9.0
|
|
||||||
|
|
||||||
Bring back support for account themes in Keycloak v23 and up! [See issue](https://github.com/keycloakify/keycloakify/issues/389).
|
|
||||||
|
|
||||||
### Breaking changes
|
|
||||||
|
|
||||||
Very few. Check them out [here](https://docs.keycloakify.dev/migration-guides/v8-greater-than-v9).
|
|
||||||
|
|
||||||
## 8.0
|
## 8.0
|
||||||
|
|
||||||
- Much smaller .jar size. 70.2 MB -> 7.8 MB.
|
- Much smaller .jar size. 70.2 MB -> 7.8 MB.
|
||||||
@ -153,7 +138,58 @@ Very few. Check them out [here](https://docs.keycloakify.dev/migration-guides/v8
|
|||||||
|
|
||||||
### 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.
|
||||||
|
|
||||||
|
- `kcContext.usernameEditDisabled` is now `kcContext.usernameHidden`, the type was lying, it has been updated to reflect what's actually on the `kcContext` at runtime.
|
||||||
|
If you want to see in detail what should be updated [see issue](https://github.com/keycloakify/keycloakify/pull/399), or you can search and replace `usernameEditDisabled` -> `usernameHidden` it'll do the trick.
|
||||||
|
|
||||||
|
- The `usePrepareTemplate` prototype has been changed, you can search and replace:
|
||||||
|
|
||||||
|
`src/keycloak-theme/login/Template.tsx`
|
||||||
|
|
||||||
|
```ts
|
||||||
|
url,
|
||||||
|
"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
|
||||||
|
url,
|
||||||
|
"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
|
||||||
|
|
||||||
@ -175,7 +211,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
|
||||||
|
|
||||||
@ -270,79 +306,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#"
|
||||||
|
}
|
13
package.json
13
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "keycloakify",
|
"name": "keycloakify",
|
||||||
"version": "9.6.1",
|
"version": "8.4.3",
|
||||||
"description": "Create Keycloak themes using React",
|
"description": "Create Keycloak themes using React",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -10,10 +10,10 @@
|
|||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"prepare": "yarn generate-i18n-messages",
|
"prepare": "yarn generate-i18n-messages",
|
||||||
"build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc -p src/vite-plugin && 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",
|
||||||
@ -105,8 +105,7 @@
|
|||||||
"tss-react": "^4.8.2",
|
"tss-react": "^4.8.2",
|
||||||
"typescript": "^4.9.1-beta",
|
"typescript": "^4.9.1-beta",
|
||||||
"vitest": "^0.29.8",
|
"vitest": "^0.29.8",
|
||||||
"zod-to-json-schema": "^3.20.4",
|
"zod-to-json-schema": "^3.20.4"
|
||||||
"vite": "^5.0.12"
|
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/generator": "^7.22.9",
|
"@babel/generator": "^7.22.9",
|
||||||
@ -119,13 +118,13 @@
|
|||||||
"make-fetch-happen": "^11.0.3",
|
"make-fetch-happen": "^11.0.3",
|
||||||
"minimal-polyfills": "^2.2.2",
|
"minimal-polyfills": "^2.2.2",
|
||||||
"minimist": "^1.2.6",
|
"minimist": "^1.2.6",
|
||||||
|
"path-browserify": "^1.0.1",
|
||||||
"react-markdown": "^5.0.3",
|
"react-markdown": "^5.0.3",
|
||||||
"recast": "^0.23.3",
|
"recast": "^0.23.3",
|
||||||
"rfc4648": "^1.5.2",
|
"rfc4648": "^1.5.2",
|
||||||
"tsafe": "^1.6.0",
|
"tsafe": "^1.6.0",
|
||||||
"yauzl": "^2.10.0",
|
"yauzl": "^2.10.0",
|
||||||
"yazl": "^2.5.1",
|
"yazl": "^2.5.1",
|
||||||
"zod": "^3.17.10",
|
"zod": "^3.17.10"
|
||||||
"magic-string": "^0.30.7"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -3,7 +3,7 @@ import * as fs from "fs";
|
|||||||
import { join as pathJoin, relative as pathRelative, dirname as pathDirname, sep as pathSep } from "path";
|
import { join as pathJoin, relative as pathRelative, dirname as pathDirname, sep as pathSep } from "path";
|
||||||
import { crawl } from "../src/bin/tools/crawl";
|
import { crawl } from "../src/bin/tools/crawl";
|
||||||
import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
|
||||||
import { getThisCodebaseRootDirPath } from "../src/bin/tools/getThisCodebaseRootDirPath";
|
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
||||||
import { getLogger } from "../src/bin/tools/logger";
|
import { getLogger } from "../src/bin/tools/logger";
|
||||||
|
|
||||||
// NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
|
// NOTE: To run without argument when we want to generate src/i18n/generated_kcMessages files,
|
||||||
@ -17,25 +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 thisCodebaseRootDirPath = getThisCodebaseRootDirPath();
|
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(thisCodebaseRootDirPath, "tmp_xImOef9dOd44");
|
|
||||||
|
|
||||||
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
|
|
||||||
fs.mkdirSync(tmpDirPath);
|
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(tmpDirPath, ".gitignore"), Buffer.from("/*\n!.gitignore\n", "utf8"));
|
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
"projectDirPath": getProjectRoot(),
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath
|
||||||
"buildOptions": {
|
|
||||||
"cacheDirPath": pathJoin(thisCodebaseRootDirPath, "node_modules", ".cache", "keycloakify"),
|
|
||||||
"npmWorkspaceRootDirPath": thisCodebaseRootDirPath
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|
||||||
type Dictionary = { [idiomId: string]: string };
|
type Dictionary = { [idiomId: string]: string };
|
||||||
@ -75,13 +66,14 @@ async function main() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const baseMessagesDirPath = pathJoin(thisCodebaseRootDirPath, "src", themeType, "i18n", "baseMessages");
|
const baseMessagesDirPath = pathJoin(getProjectRoot(), "src", themeType, "i18n", "baseMessages");
|
||||||
|
|
||||||
const languages = Object.keys(recordForPageType);
|
const languages = Object.keys(recordForPageType);
|
||||||
|
|
||||||
const generatedFileHeader = [
|
const generatedFileHeader = [
|
||||||
`//This code was automatically generated by running ${pathRelative(thisCodebaseRootDirPath, __filename)}`,
|
`//This code was automatically generated by running ${pathRelative(getProjectRoot(), __filename)}`,
|
||||||
"//PLEASE DO NOT EDIT MANUALLY"
|
"//PLEASE DO NOT EDIT MANUALLY",
|
||||||
|
""
|
||||||
].join("\n");
|
].join("\n");
|
||||||
|
|
||||||
languages.forEach(language => {
|
languages.forEach(language => {
|
||||||
@ -94,7 +86,6 @@ async function main() {
|
|||||||
Buffer.from(
|
Buffer.from(
|
||||||
[
|
[
|
||||||
generatedFileHeader,
|
generatedFileHeader,
|
||||||
"",
|
|
||||||
"/* spell-checker: disable */",
|
"/* spell-checker: disable */",
|
||||||
`const messages= ${JSON.stringify(recordForPageType[language], null, 2)};`,
|
`const messages= ${JSON.stringify(recordForPageType[language], null, 2)};`,
|
||||||
"",
|
"",
|
||||||
@ -113,15 +104,10 @@ async function main() {
|
|||||||
Buffer.from(
|
Buffer.from(
|
||||||
[
|
[
|
||||||
generatedFileHeader,
|
generatedFileHeader,
|
||||||
`import * as en from "./en";`,
|
|
||||||
"",
|
|
||||||
"export async function getMessages(currentLanguageTag: string) {",
|
"export async function getMessages(currentLanguageTag: string) {",
|
||||||
" const { default: messages } = await (() => {",
|
" const { default: messages } = await (() => {",
|
||||||
" switch (currentLanguageTag) {",
|
" switch (currentLanguageTag) {",
|
||||||
` case "en": return en;`,
|
...languages.map(language => ` case "${language}": return import("./${language}");`),
|
||||||
...languages
|
|
||||||
.filter(language => language !== "en")
|
|
||||||
.map(language => ` case "${language}": return import("./${language}");`),
|
|
||||||
' default: return { "default": {} };',
|
' default: return { "default": {} };',
|
||||||
" }",
|
" }",
|
||||||
" })();",
|
" })();",
|
||||||
|
14
scripts/generate-json-schema.ts
Normal file
14
scripts/generate-json-schema.ts
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
import fs from "fs";
|
||||||
|
import path from "path";
|
||||||
|
import zodToJsonSchema from "zod-to-json-schema";
|
||||||
|
import { zParsedPackageJson } from "../src/bin/keycloakify/parsedPackageJson";
|
||||||
|
|
||||||
|
const jsonSchemaName = "keycloakifyPackageJsonSchema";
|
||||||
|
const jsonSchema = zodToJsonSchema(zParsedPackageJson, jsonSchemaName);
|
||||||
|
|
||||||
|
const baseProperties = {
|
||||||
|
// merges package.json schema with keycloakify properties
|
||||||
|
"allOf": [{ "$ref": "https://json.schemastore.org/package.json" }, { "$ref": jsonSchemaName }]
|
||||||
|
};
|
||||||
|
|
||||||
|
fs.writeFileSync(path.join(process.cwd(), "keycloakify-json-schema.json"), JSON.stringify({ ...baseProperties, ...jsonSchema }, null, 2));
|
@ -1,11 +1,11 @@
|
|||||||
import { execSync } from "child_process";
|
import { execSync } from "child_process";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { getThisCodebaseRootDirPath } from "../src/bin/tools/getThisCodebaseRootDirPath";
|
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
|
|
||||||
const singletonDependencies: string[] = ["react", "@types/react"];
|
const singletonDependencies: string[] = ["react", "@types/react"];
|
||||||
|
|
||||||
const rootDirPath = getThisCodebaseRootDirPath();
|
const rootDirPath = getProjectRoot();
|
||||||
|
|
||||||
//NOTE: This is only required because of: https://github.com/garronej/ts-ci/blob/c0e207b9677523d4ec97fe672ddd72ccbb3c1cc4/README.md?plain=1#L54-L58
|
//NOTE: This is only required because of: https://github.com/garronej/ts-ci/blob/c0e207b9677523d4ec97fe672ddd72ccbb3c1cc4/README.md?plain=1#L54-L58
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
|
@ -1,21 +0,0 @@
|
|||||||
import { nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "keycloakify/bin/constants";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This is an equivalent of process.env.PUBLIC_URL thay you can use in Webpack projects.
|
|
||||||
* This works both in your main app and in your Keycloak theme.
|
|
||||||
*/
|
|
||||||
export const PUBLIC_URL = (() => {
|
|
||||||
const kcContext = (window as any)[nameOfTheGlobal];
|
|
||||||
|
|
||||||
if (kcContext === undefined || process.env.NODE_ENV === "development") {
|
|
||||||
assert(
|
|
||||||
process.env.PUBLIC_URL !== undefined,
|
|
||||||
`If you use keycloakify/PUBLIC_URL you should be in Webpack and thus process.env.PUBLIC_URL should be defined`
|
|
||||||
);
|
|
||||||
|
|
||||||
return process.env.PUBLIC_URL;
|
|
||||||
}
|
|
||||||
|
|
||||||
return `${kcContext.url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}`;
|
|
||||||
})();
|
|
@ -6,10 +6,6 @@ import { assert, type Equals } from "tsafe/assert";
|
|||||||
|
|
||||||
const Password = lazy(() => import("keycloakify/account/pages/Password"));
|
const Password = lazy(() => import("keycloakify/account/pages/Password"));
|
||||||
const Account = lazy(() => import("keycloakify/account/pages/Account"));
|
const Account = lazy(() => import("keycloakify/account/pages/Account"));
|
||||||
const Sessions = lazy(() => import("keycloakify/account/pages/Sessions"));
|
|
||||||
const Totp = lazy(() => import("keycloakify/account/pages/Totp"));
|
|
||||||
const Applications = lazy(() => import("keycloakify/account/pages/Applications"));
|
|
||||||
const Log = lazy(() => import("keycloakify/account/pages/Log"));
|
|
||||||
|
|
||||||
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
||||||
const { kcContext, ...rest } = props;
|
const { kcContext, ...rest } = props;
|
||||||
@ -20,16 +16,8 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
switch (kcContext.pageId) {
|
switch (kcContext.pageId) {
|
||||||
case "password.ftl":
|
case "password.ftl":
|
||||||
return <Password kcContext={kcContext} {...rest} />;
|
return <Password kcContext={kcContext} {...rest} />;
|
||||||
case "sessions.ftl":
|
|
||||||
return <Sessions kcContext={kcContext} {...rest} />;
|
|
||||||
case "account.ftl":
|
case "account.ftl":
|
||||||
return <Account kcContext={kcContext} {...rest} />;
|
return <Account kcContext={kcContext} {...rest} />;
|
||||||
case "totp.ftl":
|
|
||||||
return <Totp kcContext={kcContext} {...rest} />;
|
|
||||||
case "applications.ftl":
|
|
||||||
return <Applications kcContext={kcContext} {...rest} />;
|
|
||||||
case "log.ftl":
|
|
||||||
return <Log kcContext={kcContext} {...rest} />;
|
|
||||||
}
|
}
|
||||||
assert<Equals<typeof kcContext, never>>(false);
|
assert<Equals<typeof kcContext, never>>(false);
|
||||||
})()}
|
})()}
|
||||||
|
@ -11,17 +11,4 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey =
|
export type ClassKey = "kcHtmlClass" | "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
||||||
| "kcHtmlClass"
|
|
||||||
| "kcBodyClass"
|
|
||||||
| "kcButtonClass"
|
|
||||||
| "kcButtonPrimaryClass"
|
|
||||||
| "kcButtonLargeClass"
|
|
||||||
| "kcButtonDefaultClass"
|
|
||||||
| "kcContentWrapperClass"
|
|
||||||
| "kcFormClass"
|
|
||||||
| "kcFormGroupClass"
|
|
||||||
| "kcInputWrapperClass"
|
|
||||||
| "kcLabelClass"
|
|
||||||
| "kcInputClass"
|
|
||||||
| "kcInputErrorMessageClass";
|
|
||||||
|
@ -1,9 +1,8 @@
|
|||||||
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 | KcContext.Sessions | KcContext.Totp | KcContext.Applications | KcContext.Log;
|
export type KcContext = KcContext.Password | KcContext.Account;
|
||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
@ -90,16 +89,6 @@ export declare namespace KcContext {
|
|||||||
lastName?: string;
|
lastName?: string;
|
||||||
username?: string;
|
username?: string;
|
||||||
};
|
};
|
||||||
properties: Record<string, string | undefined>;
|
|
||||||
sessions: {
|
|
||||||
sessions: {
|
|
||||||
ipAddress: string;
|
|
||||||
started?: any;
|
|
||||||
lastAccess?: any;
|
|
||||||
expires?: any;
|
|
||||||
clients: string[];
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type Password = Common & {
|
export type Password = Common & {
|
||||||
@ -121,144 +110,6 @@ export declare namespace KcContext {
|
|||||||
};
|
};
|
||||||
stateChecker: string;
|
stateChecker: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type Sessions = Common & {
|
|
||||||
pageId: "sessions.ftl";
|
|
||||||
sessions: {
|
|
||||||
sessions: {
|
|
||||||
ipAddress: string;
|
|
||||||
started?: any;
|
|
||||||
lastAccess?: any;
|
|
||||||
expires?: any;
|
|
||||||
clients: string[];
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
stateChecker: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Totp = Common & {
|
|
||||||
pageId: "totp.ftl";
|
|
||||||
totp: {
|
|
||||||
enabled: boolean;
|
|
||||||
totpSecretEncoded: string;
|
|
||||||
qrUrl: string;
|
|
||||||
policy: {
|
|
||||||
algorithm: "HmacSHA1" | "HmacSHA256" | "HmacSHA512";
|
|
||||||
digits: number;
|
|
||||||
lookAheadWindow: number;
|
|
||||||
} & (
|
|
||||||
| {
|
|
||||||
type: "totp";
|
|
||||||
period: number;
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
type: "hotp";
|
|
||||||
initialCounter: number;
|
|
||||||
}
|
|
||||||
);
|
|
||||||
supportedApplications: string[];
|
|
||||||
totpSecretQrCode: string;
|
|
||||||
manualUrl: string;
|
|
||||||
totpSecret: string;
|
|
||||||
otpCredentials: { id: string; userLabel: string }[];
|
|
||||||
};
|
|
||||||
mode?: "qr" | "manual" | undefined | null;
|
|
||||||
isAppInitiatedAction: boolean;
|
|
||||||
url: {
|
|
||||||
accountUrl: string;
|
|
||||||
passwordUrl: string;
|
|
||||||
totpUrl: string;
|
|
||||||
socialUrl: string;
|
|
||||||
sessionsUrl: string;
|
|
||||||
applicationsUrl: string;
|
|
||||||
logUrl: string;
|
|
||||||
resourceUrl: string;
|
|
||||||
resourcesCommonPath: string;
|
|
||||||
resourcesPath: string;
|
|
||||||
/** @deprecated, not present in recent keycloak version apparently, use kcContext.referrer instead */
|
|
||||||
referrerURI?: string;
|
|
||||||
getLogoutUrl: () => string;
|
|
||||||
};
|
|
||||||
stateChecker: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Applications = Common & {
|
|
||||||
pageId: "applications.ftl";
|
|
||||||
features: {
|
|
||||||
log: boolean;
|
|
||||||
identityFederation: boolean;
|
|
||||||
authorization: boolean;
|
|
||||||
passwordUpdateSupported: boolean;
|
|
||||||
};
|
|
||||||
stateChecker: string;
|
|
||||||
applications: {
|
|
||||||
applications: {
|
|
||||||
realmRolesAvailable: { name: string; description: string }[];
|
|
||||||
resourceRolesAvailable: Record<
|
|
||||||
string,
|
|
||||||
{
|
|
||||||
roleName: string;
|
|
||||||
roleDescription: string;
|
|
||||||
clientName: string;
|
|
||||||
clientId: string;
|
|
||||||
}[]
|
|
||||||
>;
|
|
||||||
additionalGrants: string[];
|
|
||||||
clientScopesGranted: string[];
|
|
||||||
effectiveUrl?: string;
|
|
||||||
client: {
|
|
||||||
consentScreenText: string;
|
|
||||||
surrogateAuthRequired: boolean;
|
|
||||||
bearerOnly: boolean;
|
|
||||||
id: string;
|
|
||||||
protocolMappersStream: Record<string, unknown>;
|
|
||||||
includeInTokenScope: boolean;
|
|
||||||
redirectUris: string[];
|
|
||||||
fullScopeAllowed: boolean;
|
|
||||||
registeredNodes: Record<string, unknown>;
|
|
||||||
enabled: boolean;
|
|
||||||
clientAuthenticatorType: string;
|
|
||||||
realmScopeMappingsStream: Record<string, unknown>;
|
|
||||||
scopeMappingsStream: Record<string, unknown>;
|
|
||||||
displayOnConsentScreen: boolean;
|
|
||||||
clientId: string;
|
|
||||||
rootUrl: string;
|
|
||||||
authenticationFlowBindingOverrides: Record<string, unknown>;
|
|
||||||
standardFlowEnabled: boolean;
|
|
||||||
attributes: Record<string, unknown>;
|
|
||||||
publicClient: boolean;
|
|
||||||
alwaysDisplayInConsole: boolean;
|
|
||||||
consentRequired: boolean;
|
|
||||||
notBefore: string;
|
|
||||||
rolesStream: Record<string, unknown>;
|
|
||||||
protocol: string;
|
|
||||||
dynamicScope: boolean;
|
|
||||||
directAccessGrantsEnabled: boolean;
|
|
||||||
name: string;
|
|
||||||
serviceAccountsEnabled: boolean;
|
|
||||||
frontchannelLogout: boolean;
|
|
||||||
nodeReRegistrationTimeout: string;
|
|
||||||
implicitFlowEnabled: boolean;
|
|
||||||
baseUrl: string;
|
|
||||||
webOrigins: string[];
|
|
||||||
realm: Record<string, unknown>;
|
|
||||||
};
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Log = Common & {
|
|
||||||
pageId: "log.ftl";
|
|
||||||
log: {
|
|
||||||
events: {
|
|
||||||
date: string | number | Date;
|
|
||||||
event: string;
|
|
||||||
ipAddress: string;
|
|
||||||
client: any;
|
|
||||||
details: any[];
|
|
||||||
}[];
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
{
|
||||||
|
@ -1,16 +1,17 @@
|
|||||||
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
||||||
import { deepAssign } from "keycloakify/tools/deepAssign";
|
import { deepAssign } from "keycloakify/tools/deepAssign";
|
||||||
import { isStorybook } from "keycloakify/lib/isStorybook";
|
|
||||||
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
||||||
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
||||||
|
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
|
import { pathBasename } from "keycloakify/tools/pathBasename";
|
||||||
|
import { resourcesCommonDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
|
import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
|
||||||
|
|
||||||
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
||||||
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
||||||
mockProperties?: Record<string, string>;
|
|
||||||
}) {
|
}) {
|
||||||
const { mockData, mockProperties } = params ?? {};
|
const { mockData } = params ?? {};
|
||||||
|
|
||||||
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
||||||
mockPageId?: PageId;
|
mockPageId?: PageId;
|
||||||
@ -27,13 +28,7 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
if (mockPageId !== undefined && realKcContext === undefined) {
|
if (mockPageId !== undefined && realKcContext === undefined) {
|
||||||
//TODO maybe trow if no mock fo custom page
|
//TODO maybe trow if no mock fo custom page
|
||||||
|
|
||||||
warn_that_mock_is_enbaled: {
|
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
||||||
if (isStorybook) {
|
|
||||||
break warn_that_mock_is_enbaled;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
|
||||||
}
|
|
||||||
|
|
||||||
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
||||||
|
|
||||||
@ -83,13 +78,6 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
if (mockProperties !== undefined) {
|
|
||||||
deepAssign({
|
|
||||||
"target": kcContext.properties,
|
|
||||||
"source": mockProperties
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return { kcContext };
|
return { kcContext };
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -101,6 +89,12 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const { url } = realKcContext;
|
||||||
|
|
||||||
|
url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(resourcesCommonDirPathRelativeToPublicDir));
|
||||||
|
}
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
||||||
import { nameOfTheGlobal } from "keycloakify/bin/constants";
|
import { ftlValuesGlobalName } from "keycloakify/bin/keycloakify/ftlValuesGlobalName";
|
||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
|
|
||||||
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
||||||
@ -7,5 +7,5 @@ export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [Kc
|
|||||||
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
||||||
|
|
||||||
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
||||||
return typeof window === "undefined" ? undefined : (window as any)[nameOfTheGlobal];
|
return typeof window === "undefined" ? undefined : (window as any)[ftlValuesGlobalName];
|
||||||
}
|
}
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
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 { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
import { BASE_URL } from "keycloakify/lib/BASE_URL";
|
|
||||||
|
|
||||||
const resourcesPath = `${BASE_URL}${keycloak_resources}/account/resources`;
|
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
"themeVersion": "0.0.0",
|
"themeVersion": "0.0.0",
|
||||||
@ -12,8 +12,8 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"themeType": "account",
|
"themeType": "account",
|
||||||
"themeName": "my-theme-name",
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
resourcesPath,
|
"resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
|
||||||
"resourcesCommonPath": `${resourcesPath}/${resources_common}`,
|
"resourcesCommonPath": pathJoin(PUBLIC_URL, resourcesCommonDirPathRelativeToPublicDir),
|
||||||
"resourceUrl": "#",
|
"resourceUrl": "#",
|
||||||
"accountUrl": "#",
|
"accountUrl": "#",
|
||||||
"applicationsUrl": "#",
|
"applicationsUrl": "#",
|
||||||
@ -145,28 +145,6 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"lastName": "doe",
|
"lastName": "doe",
|
||||||
"email": "john.doe@code.gouv.fr",
|
"email": "john.doe@code.gouv.fr",
|
||||||
"username": "doe_j"
|
"username": "doe_j"
|
||||||
},
|
|
||||||
"properties": {
|
|
||||||
"parent": "account-v1",
|
|
||||||
"kcButtonLargeClass": "btn-lg",
|
|
||||||
"locales": "ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
|
||||||
"kcButtonPrimaryClass": "btn-primary",
|
|
||||||
"accountResourceProvider": "account-v1",
|
|
||||||
"styles":
|
|
||||||
"css/account.css img/icon-sidebar-active.png img/logo.png resources-common/node_modules/patternfly/dist/css/patternfly.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css resources-common/node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
|
||||||
"kcButtonClass": "btn",
|
|
||||||
"kcButtonDefaultClass": "btn-default"
|
|
||||||
},
|
|
||||||
"sessions": {
|
|
||||||
"sessions": [
|
|
||||||
{
|
|
||||||
"ipAddress": "127.0.0.1",
|
|
||||||
"started": new Date().toString(),
|
|
||||||
"lastAccess": new Date().toString(),
|
|
||||||
"expires": new Date().toString(),
|
|
||||||
"clients": ["Chrome", "Firefox"]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -193,62 +171,5 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
"editUsernameAllowed": true
|
"editUsernameAllowed": true
|
||||||
},
|
},
|
||||||
"stateChecker": ""
|
"stateChecker": ""
|
||||||
}),
|
|
||||||
id<KcContext.Sessions>({
|
|
||||||
...kcContextCommonMock,
|
|
||||||
"pageId": "sessions.ftl",
|
|
||||||
"sessions": {
|
|
||||||
"sessions": [
|
|
||||||
{
|
|
||||||
...kcContextCommonMock.sessions,
|
|
||||||
"ipAddress": "127.0.0.1",
|
|
||||||
"started": new Date().toString(),
|
|
||||||
"lastAccess": new Date().toString(),
|
|
||||||
"expires": new Date().toString(),
|
|
||||||
"clients": ["Chrome", "Firefox"]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"stateChecker": "g6WB1FaYnKotTkiy7ZrlxvFztSqS0U8jvHsOOOb2z4g"
|
|
||||||
}),
|
|
||||||
id<KcContext.Totp>({
|
|
||||||
...kcContextCommonMock,
|
|
||||||
"pageId": "totp.ftl",
|
|
||||||
"totp": {
|
|
||||||
"enabled": true,
|
|
||||||
"totpSecretEncoded": "KVVF G2BY N4YX S6LB IUYT K2LH IFYE 4SBV",
|
|
||||||
"qrUrl": "#",
|
|
||||||
"totpSecretQrCode":
|
|
||||||
"iVBORw0KGgoAAAANSUhEUgAAAPYAAAD2AQAAAADNaUdlAAACM0lEQVR4Xu3OIZJgOQwDUDFd2UxiurLAVnnbHw4YGDKtSiWOn4Gxf81//7r/+q8b4HfLGBZDK9d85NmNR+sB42sXvOYrN5P1DcgYYFTGfOlbzE8gzwy3euweGizw7cfdl34/GRhlkxjKNV+5AebPXPORX1JuB9x8ZfbyyD2y1krWAKsbMq1HnqQDaLfa77p4+MqvzEGSqvSAD/2IHW2yHaigR9tX3m8dDIYGcNf3f+gDpVBZbZU77zyJ6Rlcy+qoTMG887KAPD9hsh6a1Sv3gJUHGHUAxSMzj7zqDDe7Phmt2eG+8UsMxjRGm816MAO+8VMl1R1jGHOrZB/5Zo/WXAPgxixm9Mo96vDGrM1eOto8c4Ax4wF437mifOXlpiPzCnN7Y9l95NnEMxgMY9AAGA8fucH14Y1aVb6N/cqrmyh0BVht7k1e+bU8LK0Cg5vmVq9c5vHIjOfqxDIfeTraNVTwewa4wVe+SW5N+uP1qACeudUZbqGOfA6VZV750Noq2Xx3kpveV44ZelSV1V7KFHzkWyVrrlUwG0Pl9pWnoy3vsQoME6vKI69i5osVgwWzHT7zjmJtMcNUSVn1oYMd7ZodbgowZl45VG0uVuLPUr1yc79uaQBag/mqR34xhlWyHm1prplHboCWdZ4TeZjsK8+dI+jbz1C5hl65mcpgB5dhcj8+dGO+0Ko68+lD37JDD83dpDLzzK+TrQyaVwGj6pUboGV+7+AyN8An/pf84/7rv/4/1l4OCc/1BYMAAAAASUVORK5CYII=",
|
|
||||||
"manualUrl": "#",
|
|
||||||
"totpSecret": "G4nsI8lQagRMUchH8jEG",
|
|
||||||
"otpCredentials": [],
|
|
||||||
"supportedApplications": ["totpAppFreeOTPName", "totpAppMicrosoftAuthenticatorName", "totpAppGoogleName"],
|
|
||||||
"policy": {
|
|
||||||
"algorithm": "HmacSHA1",
|
|
||||||
"digits": 6,
|
|
||||||
"lookAheadWindow": 1,
|
|
||||||
"type": "totp",
|
|
||||||
"period": 30
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"mode": "qr",
|
|
||||||
"isAppInitiatedAction": false,
|
|
||||||
"stateChecker": ""
|
|
||||||
}),
|
|
||||||
id<KcContext.Log>({
|
|
||||||
...kcContextCommonMock,
|
|
||||||
"pageId": "log.ftl",
|
|
||||||
"log": {
|
|
||||||
"events": [
|
|
||||||
{
|
|
||||||
"date": "2/21/2024, 1:28:39 PM",
|
|
||||||
"event": "login",
|
|
||||||
"ipAddress": "172.17.0.1",
|
|
||||||
"client": "security-admin-console",
|
|
||||||
"details": ["auth_method = openid-connect, username = admin"]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
];
|
];
|
||||||
|
@ -6,15 +6,8 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
"kcHtmlClass": undefined,
|
"kcHtmlClass": undefined,
|
||||||
"kcBodyClass": undefined,
|
"kcBodyClass": undefined,
|
||||||
"kcButtonClass": "btn",
|
"kcButtonClass": "btn",
|
||||||
"kcContentWrapperClass": "row",
|
|
||||||
"kcButtonPrimaryClass": "btn-primary",
|
"kcButtonPrimaryClass": "btn-primary",
|
||||||
"kcButtonLargeClass": "btn-lg",
|
"kcButtonLargeClass": "btn-lg",
|
||||||
"kcButtonDefaultClass": "btn-default",
|
"kcButtonDefaultClass": "btn-default"
|
||||||
"kcFormClass": "form-horizontal",
|
|
||||||
"kcFormGroupClass": "form-group",
|
|
||||||
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
|
||||||
"kcLabelClass": "control-label",
|
|
||||||
"kcInputClass": "form-control",
|
|
||||||
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text"
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
@ -1,138 +0,0 @@
|
|||||||
import { clsx } from "keycloakify/tools/clsx";
|
|
||||||
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
|
||||||
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
|
||||||
import type { KcContext } from "../kcContext";
|
|
||||||
import type { I18n } from "../i18n";
|
|
||||||
|
|
||||||
function isArrayWithEmptyObject(variable: any): boolean {
|
|
||||||
return Array.isArray(variable) && variable.length === 1 && typeof variable[0] === "object" && Object.keys(variable[0]).length === 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function Applications(props: PageProps<Extract<KcContext, { pageId: "applications.ftl" }>, I18n>) {
|
|
||||||
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
|
||||||
|
|
||||||
const { getClassName } = useGetClassName({
|
|
||||||
doUseDefaultCss,
|
|
||||||
classes
|
|
||||||
});
|
|
||||||
|
|
||||||
const {
|
|
||||||
url,
|
|
||||||
applications: { applications },
|
|
||||||
stateChecker
|
|
||||||
} = kcContext;
|
|
||||||
|
|
||||||
const { msg, advancedMsg } = i18n;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="applications">
|
|
||||||
<div className="row">
|
|
||||||
<div className="col-md-10">
|
|
||||||
<h2>{msg("applicationsHtmlTitle")}</h2>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<form action={url.applicationsUrl} method="post">
|
|
||||||
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
|
||||||
<input type="hidden" id="referrer" name="referrer" value={stateChecker} />
|
|
||||||
|
|
||||||
<table className="table table-striped table-bordered">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<td>{msg("application")}</td>
|
|
||||||
<td>{msg("availableRoles")}</td>
|
|
||||||
<td>{msg("grantedPermissions")}</td>
|
|
||||||
<td>{msg("additionalGrants")}</td>
|
|
||||||
<td>{msg("action")}</td>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
|
|
||||||
<tbody>
|
|
||||||
{applications.map(application => (
|
|
||||||
<tr key={application.client.clientId}>
|
|
||||||
<td>
|
|
||||||
{application.effectiveUrl && (
|
|
||||||
<a href={application.effectiveUrl}>
|
|
||||||
{(application.client.name && advancedMsg(application.client.name)) || application.client.clientId}
|
|
||||||
</a>
|
|
||||||
)}
|
|
||||||
{!application.effectiveUrl &&
|
|
||||||
((application.client.name && advancedMsg(application.client.name)) || application.client.clientId)}
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
{!isArrayWithEmptyObject(application.realmRolesAvailable) &&
|
|
||||||
application.realmRolesAvailable.map(role => (
|
|
||||||
<span key={role.name}>
|
|
||||||
{role.description ? advancedMsg(role.description) : advancedMsg(role.name)}
|
|
||||||
{role !== application.realmRolesAvailable[application.realmRolesAvailable.length - 1] && ", "}
|
|
||||||
</span>
|
|
||||||
))}
|
|
||||||
{!isArrayWithEmptyObject(application.realmRolesAvailable) && application.resourceRolesAvailable && ", "}
|
|
||||||
{application.resourceRolesAvailable &&
|
|
||||||
Object.keys(application.resourceRolesAvailable).map(resource => (
|
|
||||||
<span key={resource}>
|
|
||||||
{!isArrayWithEmptyObject(application.realmRolesAvailable) && ", "}
|
|
||||||
{application.resourceRolesAvailable[resource].map(clientRole => (
|
|
||||||
<span key={clientRole.roleName}>
|
|
||||||
{clientRole.roleDescription
|
|
||||||
? advancedMsg(clientRole.roleDescription)
|
|
||||||
: advancedMsg(clientRole.roleName)}{" "}
|
|
||||||
{msg("inResource")}{" "}
|
|
||||||
<strong>
|
|
||||||
{clientRole.clientName ? advancedMsg(clientRole.clientName) : clientRole.clientId}
|
|
||||||
</strong>
|
|
||||||
{clientRole !==
|
|
||||||
application.resourceRolesAvailable[resource][
|
|
||||||
application.resourceRolesAvailable[resource].length - 1
|
|
||||||
] && ", "}
|
|
||||||
</span>
|
|
||||||
))}
|
|
||||||
</span>
|
|
||||||
))}
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
{application.client.consentRequired ? (
|
|
||||||
application.clientScopesGranted.map(claim => (
|
|
||||||
<span key={claim}>
|
|
||||||
{advancedMsg(claim)}
|
|
||||||
{claim !== application.clientScopesGranted[application.clientScopesGranted.length - 1] && ", "}
|
|
||||||
</span>
|
|
||||||
))
|
|
||||||
) : (
|
|
||||||
<strong>{msg("fullAccess")}</strong>
|
|
||||||
)}
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
{application.additionalGrants.map(grant => (
|
|
||||||
<span key={grant}>
|
|
||||||
{advancedMsg(grant)}
|
|
||||||
{grant !== application.additionalGrants[application.additionalGrants.length - 1] && ", "}
|
|
||||||
</span>
|
|
||||||
))}
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
{(application.client.consentRequired && application.clientScopesGranted.length > 0) ||
|
|
||||||
application.additionalGrants.length > 0 ? (
|
|
||||||
<button
|
|
||||||
type="submit"
|
|
||||||
className={clsx(getClassName("kcButtonPrimaryClass"), getClassName("kcButtonClass"))}
|
|
||||||
id={`revoke-${application.client.clientId}`}
|
|
||||||
name="clientId"
|
|
||||||
value={application.client.id}
|
|
||||||
>
|
|
||||||
{msg("revoke")}
|
|
||||||
</button>
|
|
||||||
) : null}
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
))}
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
</Template>
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,70 +0,0 @@
|
|||||||
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
|
||||||
import type { KcContext } from "../kcContext";
|
|
||||||
import type { I18n } from "../i18n";
|
|
||||||
import { Key } from "react";
|
|
||||||
import { useGetClassName } from "../lib/useGetClassName";
|
|
||||||
|
|
||||||
export default function Log(props: PageProps<Extract<KcContext, { pageId: "log.ftl" }>, I18n>) {
|
|
||||||
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
|
||||||
|
|
||||||
const { getClassName } = useGetClassName({
|
|
||||||
doUseDefaultCss,
|
|
||||||
classes
|
|
||||||
});
|
|
||||||
|
|
||||||
const { log } = kcContext;
|
|
||||||
|
|
||||||
const { msg } = i18n;
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="log">
|
|
||||||
<div className={getClassName("kcContentWrapperClass")}>
|
|
||||||
<div className="col-md-10">
|
|
||||||
<h2>{msg("accountLogHtmlTitle")}</h2>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<table className="table table-striped table-bordered">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<td>{msg("date")}</td>
|
|
||||||
<td>{msg("event")}</td>
|
|
||||||
<td>{msg("ip")}</td>
|
|
||||||
<td>{msg("client")}</td>
|
|
||||||
<td>{msg("details")}</td>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
|
|
||||||
<tbody>
|
|
||||||
{log.events.map(
|
|
||||||
(
|
|
||||||
event: {
|
|
||||||
date: string | number | Date;
|
|
||||||
event: string;
|
|
||||||
ipAddress: string;
|
|
||||||
client: any;
|
|
||||||
details: any[];
|
|
||||||
},
|
|
||||||
index: Key | null | undefined
|
|
||||||
) => (
|
|
||||||
<tr key={index}>
|
|
||||||
<td>{event.date ? new Date(event.date).toLocaleString() : ""}</td>
|
|
||||||
<td>{event.event}</td>
|
|
||||||
<td>{event.ipAddress}</td>
|
|
||||||
<td>{event.client || ""}</td>
|
|
||||||
<td>
|
|
||||||
{event.details.map((detail, detailIndex) => (
|
|
||||||
<span key={detailIndex}>
|
|
||||||
{`${detail.key} = ${detail.value}`}
|
|
||||||
{detailIndex < event.details.length - 1 && ", "}
|
|
||||||
</span>
|
|
||||||
))}
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
)
|
|
||||||
)}
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</Template>
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,11 +1,10 @@
|
|||||||
|
import type { LazyExoticComponent } from "react";
|
||||||
import type { I18n } from "keycloakify/account/i18n";
|
import type { I18n } from "keycloakify/account/i18n";
|
||||||
import type { TemplateProps, ClassKey } from "keycloakify/account/TemplateProps";
|
import type { TemplateProps, ClassKey } from "keycloakify/account/TemplateProps";
|
||||||
import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
|
|
||||||
import type { KcContext } from "keycloakify/account/kcContext";
|
|
||||||
|
|
||||||
export type PageProps<NarowedKcContext = KcContext, I18nExtended extends I18n = 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: NarowedKcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
classes?: Partial<Record<ClassKey, string>>;
|
classes?: Partial<Record<ClassKey, string>>;
|
||||||
|
@ -1,68 +0,0 @@
|
|||||||
import { clsx } from "keycloakify/tools/clsx";
|
|
||||||
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
|
||||||
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
|
||||||
import type { KcContext } from "../kcContext";
|
|
||||||
import type { I18n } from "../i18n";
|
|
||||||
|
|
||||||
export default function Sessions(props: PageProps<Extract<KcContext, { pageId: "sessions.ftl" }>, I18n>) {
|
|
||||||
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
|
||||||
|
|
||||||
const { getClassName } = useGetClassName({
|
|
||||||
doUseDefaultCss,
|
|
||||||
classes
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log({ kcContext });
|
|
||||||
const { url, stateChecker, sessions } = kcContext;
|
|
||||||
|
|
||||||
const { msg } = i18n;
|
|
||||||
console.log({ sdf: kcContext.locale?.supported });
|
|
||||||
console.log({ asdf: "asdf" });
|
|
||||||
return (
|
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="sessions">
|
|
||||||
<div className={getClassName("kcContentWrapperClass")}>
|
|
||||||
<div className="col-md-10">
|
|
||||||
<h2>{msg("sessionsHtmlTitle")}</h2>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<table className="table table-striped table-bordered">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>{msg("ip")}</th>
|
|
||||||
<th>{msg("started")}</th>
|
|
||||||
<th>{msg("lastAccess")}</th>
|
|
||||||
<th>{msg("expires")}</th>
|
|
||||||
<th>{msg("clients")}</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
|
|
||||||
<tbody role="rowgroup">
|
|
||||||
{sessions.sessions.map((session, index: number) => (
|
|
||||||
<tr key={index}>
|
|
||||||
<td>{session.ipAddress}</td>
|
|
||||||
<td>{session?.started}</td>
|
|
||||||
<td>{session?.lastAccess}</td>
|
|
||||||
<td>{session?.expires}</td>
|
|
||||||
<td>
|
|
||||||
{session.clients.map((client: string, clientIndex: number) => (
|
|
||||||
<div key={clientIndex}>
|
|
||||||
{client}
|
|
||||||
<br />
|
|
||||||
</div>
|
|
||||||
))}
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
))}
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<form action={url.sessionsUrl} method="post">
|
|
||||||
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
|
||||||
<button id="logout-all-sessions" type="submit" className={clsx(getClassName("kcButtonDefaultClass"), getClassName("kcButtonClass"))}>
|
|
||||||
{msg("doLogOutAllSessions")}
|
|
||||||
</button>
|
|
||||||
</form>
|
|
||||||
</Template>
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,236 +0,0 @@
|
|||||||
import { clsx } from "keycloakify/tools/clsx";
|
|
||||||
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
|
||||||
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
|
||||||
import type { KcContext } from "../kcContext";
|
|
||||||
import type { I18n } from "../i18n";
|
|
||||||
import { MessageKey } from "keycloakify/account/i18n/i18n";
|
|
||||||
|
|
||||||
export default function Totp(props: PageProps<Extract<KcContext, { pageId: "totp.ftl" }>, I18n>) {
|
|
||||||
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
|
||||||
const { getClassName } = useGetClassName({
|
|
||||||
doUseDefaultCss,
|
|
||||||
classes
|
|
||||||
});
|
|
||||||
|
|
||||||
const { totp, mode, url, messagesPerField, stateChecker } = kcContext;
|
|
||||||
|
|
||||||
const { msg, msgStr } = i18n;
|
|
||||||
|
|
||||||
const algToKeyUriAlg: Record<(typeof kcContext)["totp"]["policy"]["algorithm"], string> = {
|
|
||||||
"HmacSHA1": "SHA1",
|
|
||||||
"HmacSHA256": "SHA256",
|
|
||||||
"HmacSHA512": "SHA512"
|
|
||||||
};
|
|
||||||
|
|
||||||
return (
|
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="totp">
|
|
||||||
<>
|
|
||||||
<div className="row">
|
|
||||||
<div className="col-md-10">
|
|
||||||
<h2>{msg("authenticatorTitle")}</h2>
|
|
||||||
</div>
|
|
||||||
{totp.otpCredentials.length === 0 && (
|
|
||||||
<div className="subtitle col-md-2">
|
|
||||||
<span className="required">*</span>
|
|
||||||
{msg("requiredFields")}
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
{totp.enabled && (
|
|
||||||
<table className="table table-bordered table-striped">
|
|
||||||
<thead>
|
|
||||||
{totp.otpCredentials.length > 1 ? (
|
|
||||||
<tr>
|
|
||||||
<th colSpan={4}>{msg("configureAuthenticators")}</th>
|
|
||||||
</tr>
|
|
||||||
) : (
|
|
||||||
<tr>
|
|
||||||
<th colSpan={3}>{msg("configureAuthenticators")}</th>
|
|
||||||
</tr>
|
|
||||||
)}
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
{totp.otpCredentials.map((credential, index) => (
|
|
||||||
<tr key={index}>
|
|
||||||
<td className="provider">{msg("mobile")}</td>
|
|
||||||
{totp.otpCredentials.length > 1 && <td className="provider">{credential.id}</td>}
|
|
||||||
<td className="provider">{credential.userLabel || ""}</td>
|
|
||||||
<td className="action">
|
|
||||||
<form action={url.totpUrl} method="post" className="form-inline">
|
|
||||||
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
|
||||||
<input type="hidden" id="submitAction" name="submitAction" value="Delete" />
|
|
||||||
<input type="hidden" id="credentialId" name="credentialId" value={credential.id} />
|
|
||||||
<button id={`remove-mobile-${index}`} className="btn btn-default">
|
|
||||||
<i className="pficon pficon-delete"></i>
|
|
||||||
</button>
|
|
||||||
</form>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
))}
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
)}
|
|
||||||
{!totp.enabled && (
|
|
||||||
<div>
|
|
||||||
<hr />
|
|
||||||
<ol id="kc-totp-settings">
|
|
||||||
<li>
|
|
||||||
<p>{msg("totpStep1")}</p>
|
|
||||||
|
|
||||||
<ul id="kc-totp-supported-apps">
|
|
||||||
{totp.supportedApplications.map(app => (
|
|
||||||
<li key={app}>{msg(app as MessageKey)}</li>
|
|
||||||
))}
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
{mode && mode == "manual" ? (
|
|
||||||
<>
|
|
||||||
<li>
|
|
||||||
<p>{msg("totpManualStep2")}</p>
|
|
||||||
<p>
|
|
||||||
<span id="kc-totp-secret-key">{totp.totpSecretEncoded}</span>
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
<a href={totp.qrUrl} id="mode-barcode">
|
|
||||||
{msg("totpScanBarcode")}
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<p>{msg("totpManualStep3")}</p>
|
|
||||||
<p>
|
|
||||||
<ul>
|
|
||||||
<li id="kc-totp-type">
|
|
||||||
{msg("totpType")}: {msg(`totp.${totp.policy.type}`)}
|
|
||||||
</li>
|
|
||||||
<li id="kc-totp-algorithm">
|
|
||||||
{msg("totpAlgorithm")}: {algToKeyUriAlg?.[totp.policy.algorithm] ?? totp.policy.algorithm}
|
|
||||||
</li>
|
|
||||||
<li id="kc-totp-digits">
|
|
||||||
{msg("totpDigits")}: {totp.policy.digits}
|
|
||||||
</li>
|
|
||||||
{totp.policy.type === "totp" ? (
|
|
||||||
<li id="kc-totp-period">
|
|
||||||
{msg("totpInterval")}: {totp.policy.period}
|
|
||||||
</li>
|
|
||||||
) : (
|
|
||||||
<li id="kc-totp-counter">
|
|
||||||
{msg("totpCounter")}: {totp.policy.initialCounter}
|
|
||||||
</li>
|
|
||||||
)}
|
|
||||||
</ul>
|
|
||||||
</p>
|
|
||||||
</li>
|
|
||||||
</>
|
|
||||||
) : (
|
|
||||||
<li>
|
|
||||||
<p>{msg("totpStep2")}</p>
|
|
||||||
<p>
|
|
||||||
<img
|
|
||||||
id="kc-totp-secret-qr-code"
|
|
||||||
src={`data:image/png;base64, ${totp.totpSecretQrCode}`}
|
|
||||||
alt="Figure: Barcode"
|
|
||||||
/>
|
|
||||||
</p>
|
|
||||||
<p>
|
|
||||||
<a href={totp.manualUrl} id="mode-manual">
|
|
||||||
{msg("totpUnableToScan")}
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
</li>
|
|
||||||
)}
|
|
||||||
<li>
|
|
||||||
<p>{msg("totpStep3")}</p>
|
|
||||||
<p>{msg("totpStep3DeviceName")}</p>
|
|
||||||
</li>
|
|
||||||
</ol>
|
|
||||||
<hr />
|
|
||||||
<form action={url.totpUrl} className={getClassName("kcFormClass")} id="kc-totp-settings-form" method="post">
|
|
||||||
<input type="hidden" id="stateChecker" name="stateChecker" value={stateChecker} />
|
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
|
||||||
<div className="col-sm-2 col-md-2">
|
|
||||||
<label htmlFor="totp" className="control-label">
|
|
||||||
{msg("authenticatorCode")}
|
|
||||||
</label>
|
|
||||||
<span className="required">*</span>
|
|
||||||
</div>
|
|
||||||
<div className="col-sm-10 col-md-10">
|
|
||||||
<input
|
|
||||||
type="text"
|
|
||||||
id="totp"
|
|
||||||
name="totp"
|
|
||||||
autoComplete="off"
|
|
||||||
className={getClassName("kcInputClass")}
|
|
||||||
aria-invalid={messagesPerField.existsError("totp")}
|
|
||||||
/>
|
|
||||||
|
|
||||||
{messagesPerField.existsError("totp") && (
|
|
||||||
<span id="input-error-otp-code" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
|
|
||||||
{messagesPerField.get("totp")}
|
|
||||||
</span>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
<input type="hidden" id="totpSecret" name="totpSecret" value={totp.totpSecret} />
|
|
||||||
{mode && <input type="hidden" id="mode" value={mode} />}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
|
||||||
<div className="col-sm-2 col-md-2">
|
|
||||||
<label htmlFor="userLabel" className={getClassName("kcLabelClass")}>
|
|
||||||
{msg("totpDeviceName")}
|
|
||||||
</label>
|
|
||||||
{totp.otpCredentials.length >= 1 && <span className="required">*</span>}
|
|
||||||
</div>
|
|
||||||
<div className="col-sm-10 col-md-10">
|
|
||||||
<input
|
|
||||||
type="text"
|
|
||||||
id="userLabel"
|
|
||||||
name="userLabel"
|
|
||||||
autoComplete="off"
|
|
||||||
className={getClassName("kcInputClass")}
|
|
||||||
aria-invalid={messagesPerField.existsError("userLabel")}
|
|
||||||
/>
|
|
||||||
{messagesPerField.existsError("userLabel") && (
|
|
||||||
<span id="input-error-otp-label" className={getClassName("kcInputErrorMessageClass")} aria-live="polite">
|
|
||||||
{messagesPerField.get("userLabel")}
|
|
||||||
</span>
|
|
||||||
)}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div id="kc-form-buttons" className={clsx(getClassName("kcFormGroupClass"), "text-right")}>
|
|
||||||
<div className={getClassName("kcInputWrapperClass")}>
|
|
||||||
<input
|
|
||||||
type="submit"
|
|
||||||
className={clsx(
|
|
||||||
getClassName("kcButtonClass"),
|
|
||||||
getClassName("kcButtonPrimaryClass"),
|
|
||||||
getClassName("kcButtonLargeClass")
|
|
||||||
)}
|
|
||||||
id="saveTOTPBtn"
|
|
||||||
value={msgStr("doSave")}
|
|
||||||
/>
|
|
||||||
<button
|
|
||||||
type="submit"
|
|
||||||
className={clsx(
|
|
||||||
getClassName("kcButtonClass"),
|
|
||||||
getClassName("kcButtonDefaultClass"),
|
|
||||||
getClassName("kcButtonLargeClass"),
|
|
||||||
getClassName("kcButtonLargeClass")
|
|
||||||
)}
|
|
||||||
id="cancelTOTPBtn"
|
|
||||||
name="submitAction"
|
|
||||||
value="Cancel"
|
|
||||||
>
|
|
||||||
{msg("doCancel")}
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
)}
|
|
||||||
</>
|
|
||||||
</Template>
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,14 +0,0 @@
|
|||||||
export const nameOfTheGlobal = "kcContext";
|
|
||||||
export const keycloak_resources = "keycloak-resources";
|
|
||||||
export const resources_common = "resources-common";
|
|
||||||
export const lastKeycloakVersionWithAccountV1 = "21.1.2";
|
|
||||||
export const resolvedViteConfigJsonBasename = "vite.json";
|
|
||||||
export const basenameOfTheKeycloakifyResourcesDir = "build";
|
|
||||||
|
|
||||||
export const themeTypes = ["login", "account"] as const;
|
|
||||||
export const retrocompatPostfix = "_retrocompat";
|
|
||||||
export const accountV1ThemeName = "account-v1";
|
|
||||||
|
|
||||||
export type ThemeType = (typeof themeTypes)[number];
|
|
||||||
|
|
||||||
export const keycloakifyBuildOptionsForPostPostBuildScriptEnvName = "KEYCLOAKIFY_BUILD_OPTIONS_POST_POST_BUILD_SCRIPT";
|
|
@ -1,63 +1,39 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
|
||||||
import { downloadKeycloakStaticResources, type BuildOptionsLike } 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 { readBuildOptions } from "./keycloakify/buildOptions";
|
import { basenameOfKeycloakDirInPublicDir } from "./mockTestingResourcesPath";
|
||||||
import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
|
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
||||||
import { readThisNpmProjectVersion } from "./tools/readThisNpmProjectVersion";
|
import { themeTypes } from "./keycloakify/generateFtl";
|
||||||
import { assert, type Equals } from "tsafe/assert";
|
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { rmSync } from "./tools/fs.rmSync";
|
|
||||||
|
|
||||||
export async function copyKeycloakResourcesToPublic(params: { processArgv: string[] }) {
|
(async () => {
|
||||||
const { processArgv } = params;
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({ processArgv });
|
const buildOptions = readBuildOptions({
|
||||||
|
"processArgv": process.argv.slice(2),
|
||||||
const destDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
|
"projectDirPath": process.cwd()
|
||||||
|
|
||||||
const keycloakifyBuildinfoFilePath = pathJoin(destDirPath, "keycloakify.buildinfo");
|
|
||||||
|
|
||||||
const { keycloakifyBuildinfoRaw } = generateKeycloakifyBuildinfoRaw({
|
|
||||||
destDirPath,
|
|
||||||
"keycloakifyVersion": readThisNpmProjectVersion(),
|
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
skip_if_already_done: {
|
const keycloakDirInPublicDir = pathJoin(process.env["PUBLIC_DIR_PATH"] || pathJoin(projectDirPath, "public"), basenameOfKeycloakDirInPublicDir);
|
||||||
if (!fs.existsSync(keycloakifyBuildinfoFilePath)) {
|
|
||||||
break skip_if_already_done;
|
|
||||||
}
|
|
||||||
|
|
||||||
const keycloakifyBuildinfoRaw_previousRun = fs.readFileSync(keycloakifyBuildinfoFilePath).toString("utf8");
|
|
||||||
|
|
||||||
if (keycloakifyBuildinfoRaw_previousRun !== keycloakifyBuildinfoRaw) {
|
|
||||||
break skip_if_already_done;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
if (fs.existsSync(keycloakDirInPublicDir)) {
|
||||||
|
console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} already exists.`);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
rmSync(destDirPath, { "force": true, "recursive": true });
|
|
||||||
|
|
||||||
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": destDirPath,
|
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(destDirPath, "README.txt"),
|
pathJoin(keycloakDirInPublicDir, "README.txt"),
|
||||||
Buffer.from(
|
Buffer.from(
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
[
|
[
|
||||||
@ -67,46 +43,7 @@ export async function copyKeycloakResourcesToPublic(params: { processArgv: strin
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(buildOptions.publicDirPath, keycloak_resources, ".gitignore"), Buffer.from("*", "utf8"));
|
fs.writeFileSync(pathJoin(keycloakDirInPublicDir, ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
|
|
||||||
fs.writeFileSync(keycloakifyBuildinfoFilePath, Buffer.from(keycloakifyBuildinfoRaw, "utf8"));
|
console.log(`${pathRelative(projectDirPath, keycloakDirInPublicDir)} directory created.`);
|
||||||
}
|
})();
|
||||||
|
|
||||||
export function generateKeycloakifyBuildinfoRaw(params: {
|
|
||||||
destDirPath: string;
|
|
||||||
keycloakifyVersion: string;
|
|
||||||
buildOptions: BuildOptionsLike & {
|
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
|
||||||
};
|
|
||||||
}) {
|
|
||||||
const { destDirPath, keycloakifyVersion, buildOptions } = params;
|
|
||||||
|
|
||||||
const { cacheDirPath, npmWorkspaceRootDirPath, loginThemeResourcesFromKeycloakVersion, ...rest } = buildOptions;
|
|
||||||
|
|
||||||
assert<Equals<typeof rest, {}>>(true);
|
|
||||||
|
|
||||||
const keycloakifyBuildinfoRaw = JSON.stringify(
|
|
||||||
{
|
|
||||||
keycloakifyVersion,
|
|
||||||
"buildOptions": {
|
|
||||||
loginThemeResourcesFromKeycloakVersion,
|
|
||||||
"cacheDirPath": pathRelative(destDirPath, cacheDirPath),
|
|
||||||
"npmWorkspaceRootDirPath": pathRelative(destDirPath, npmWorkspaceRootDirPath)
|
|
||||||
}
|
|
||||||
},
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
);
|
|
||||||
|
|
||||||
return { keycloakifyBuildinfoRaw };
|
|
||||||
}
|
|
||||||
|
|
||||||
async function main() {
|
|
||||||
await copyKeycloakResourcesToPublic({
|
|
||||||
"processArgv": process.argv.slice(2)
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (require.main === module) {
|
|
||||||
main();
|
|
||||||
}
|
|
||||||
|
@ -1,31 +1,21 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { downloadAndUnzip } from "./downloadAndUnzip";
|
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, type BuildOptions } from "./keycloakify/buildOptions";
|
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import * as child_process from "child_process";
|
import * as child_process from "child_process";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { rmSync } from "./tools/fs.rmSync";
|
|
||||||
import { lastKeycloakVersionWithAccountV1 } from "./constants";
|
|
||||||
import { transformCodebase } from "./tools/transformCodebase";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export async function downloadBuiltinKeycloakTheme(params: { projectDirPath: string; keycloakVersion: string; destDirPath: string }) {
|
||||||
cacheDirPath: string;
|
const { projectDirPath, keycloakVersion, destDirPath } = params;
|
||||||
npmWorkspaceRootDirPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
|
|
||||||
export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
|
|
||||||
const { keycloakVersion, destDirPath, buildOptions } = params;
|
|
||||||
|
|
||||||
await downloadAndUnzip({
|
await downloadAndUnzip({
|
||||||
|
"doUseCache": true,
|
||||||
|
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`),
|
||||||
buildOptions,
|
|
||||||
"preCacheTransform": {
|
"preCacheTransform": {
|
||||||
"actionCacheId": "npm install and build",
|
"actionCacheId": "npm install and build",
|
||||||
"action": async ({ destDirPath }) => {
|
"action": async ({ destDirPath }) => {
|
||||||
@ -50,160 +40,32 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
remove_keycloak_v2: {
|
install_and_move_to_common_resources_generated_in_keycloak_v2: {
|
||||||
const keycloakV2DirPath = pathJoin(destDirPath, "keycloak.v2");
|
const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
|
||||||
|
|
||||||
if (!fs.existsSync(keycloakV2DirPath)) {
|
if (!fs.existsSync(accountV2DirSrcDirPath)) {
|
||||||
break remove_keycloak_v2;
|
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
||||||
}
|
}
|
||||||
|
|
||||||
rmSync(keycloakV2DirPath, { "recursive": true });
|
child_process.execSync("npm install", { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
}
|
|
||||||
|
|
||||||
// Note, this is an optimization for reducing the size of the jar
|
const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
|
||||||
remove_unused_node_modules: {
|
|
||||||
const nodeModuleDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
|
|
||||||
|
|
||||||
if (!fs.existsSync(nodeModuleDirPath)) {
|
const packageJsonRaw = fs.readFileSync(packageJsonFilePath);
|
||||||
break remove_unused_node_modules;
|
|
||||||
}
|
|
||||||
|
|
||||||
const toDeletePerfixes = [
|
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
||||||
"angular",
|
|
||||||
"bootstrap",
|
|
||||||
"rcue",
|
|
||||||
"font-awesome",
|
|
||||||
"ng-file-upload",
|
|
||||||
pathJoin("patternfly", "dist", "sass"),
|
|
||||||
pathJoin("patternfly", "dist", "less"),
|
|
||||||
pathJoin("patternfly", "dist", "js"),
|
|
||||||
"d3",
|
|
||||||
pathJoin("jquery", "src"),
|
|
||||||
"c3",
|
|
||||||
"core-js",
|
|
||||||
"eonasdan-bootstrap-datetimepicker",
|
|
||||||
"moment",
|
|
||||||
"react",
|
|
||||||
"patternfly-bootstrap-treeview",
|
|
||||||
"popper.js",
|
|
||||||
"tippy.js",
|
|
||||||
"jquery-match-height",
|
|
||||||
"google-code-prettify",
|
|
||||||
"patternfly-bootstrap-combobox",
|
|
||||||
"focus-trap",
|
|
||||||
"tabbable",
|
|
||||||
"scheduler",
|
|
||||||
"@types",
|
|
||||||
"datatables.net",
|
|
||||||
"datatables.net-colreorder",
|
|
||||||
"tslib",
|
|
||||||
"prop-types",
|
|
||||||
"file-selector",
|
|
||||||
"datatables.net-colreorder-bs",
|
|
||||||
"object-assign",
|
|
||||||
"warning",
|
|
||||||
"js-tokens",
|
|
||||||
"loose-envify",
|
|
||||||
"prop-types-extra",
|
|
||||||
"attr-accept",
|
|
||||||
"datatables.net-select",
|
|
||||||
"drmonty-datatables-colvis",
|
|
||||||
"datatables.net-bs",
|
|
||||||
pathJoin("@patternfly", "react"),
|
|
||||||
pathJoin("@patternfly", "patternfly", "docs")
|
|
||||||
];
|
|
||||||
|
|
||||||
transformCodebase({
|
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
||||||
"srcDirPath": nodeModuleDirPath,
|
.replace("npm run check-types", "true")
|
||||||
"destDirPath": nodeModuleDirPath,
|
.replace("npm run babel", "true");
|
||||||
"transformSourceCode": ({ sourceCode, fileRelativePath }) => {
|
|
||||||
if (fileRelativePath.endsWith(".map")) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (toDeletePerfixes.find(prefix => fileRelativePath.startsWith(prefix)) !== undefined) {
|
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (fileRelativePath.startsWith(pathJoin("patternfly", "dist", "fonts"))) {
|
child_process.execSync("npm run build", { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
if (
|
|
||||||
!fileRelativePath.endsWith(".woff2") &&
|
|
||||||
!fileRelativePath.endsWith(".woff") &&
|
|
||||||
!fileRelativePath.endsWith(".ttf")
|
|
||||||
) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Just like node_modules
|
fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
|
||||||
remove_unused_lib: {
|
|
||||||
const libDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "lib");
|
|
||||||
|
|
||||||
if (!fs.existsSync(libDirPath)) {
|
|
||||||
break remove_unused_lib;
|
|
||||||
}
|
|
||||||
|
|
||||||
const toDeletePerfixes = ["ui-ace", "filesaver", "fileupload", "angular", "ui-ace", "pficon"];
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": libDirPath,
|
|
||||||
"destDirPath": libDirPath,
|
|
||||||
"transformSourceCode": ({ sourceCode, fileRelativePath }) => {
|
|
||||||
if (fileRelativePath.endsWith(".map")) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (toDeletePerfixes.find(prefix => fileRelativePath.startsWith(prefix)) !== undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
last_account_v1_transformations: {
|
|
||||||
if (lastKeycloakVersionWithAccountV1 !== keycloakVersion) {
|
|
||||||
break last_account_v1_transformations;
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const accountCssFilePath = pathJoin(destDirPath, "keycloak", "account", "resources", "css", "account.css");
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
accountCssFilePath,
|
|
||||||
Buffer.from(fs.readFileSync(accountCssFilePath).toString("utf8").replace("top: -34px;", "top: -34px !important;"), "utf8")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Note, this is an optimization for reducing the size of the jar,
|
|
||||||
// For this version we know exactly which resources are used.
|
|
||||||
{
|
|
||||||
const nodeModulesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources", "node_modules");
|
|
||||||
|
|
||||||
const toKeepPrefixes = [
|
|
||||||
...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(fileBasename =>
|
|
||||||
pathJoin("patternfly", "dist", "css", fileBasename)
|
|
||||||
),
|
|
||||||
pathJoin("patternfly", "dist", "fonts")
|
|
||||||
];
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": nodeModulesDirPath,
|
|
||||||
"destDirPath": nodeModulesDirPath,
|
|
||||||
"transformSourceCode": ({ sourceCode, fileRelativePath }) => {
|
|
||||||
if (toKeepPrefixes.find(prefix => fileRelativePath.startsWith(prefix)) === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -212,6 +74,7 @@ export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: st
|
|||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
|
"projectDirPath": process.cwd(),
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -223,9 +86,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
|
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,203 +0,0 @@
|
|||||||
import { createHash } from "crypto";
|
|
||||||
import { mkdir, writeFile, unlink } from "fs/promises";
|
|
||||||
import fetch from "make-fetch-happen";
|
|
||||||
import { dirname as pathDirname, join as pathJoin, basename as pathBasename } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { transformCodebase } from "./tools/transformCodebase";
|
|
||||||
import { unzip, zip } from "./tools/unzip";
|
|
||||||
import { rm } from "./tools/fs.rm";
|
|
||||||
import * as child_process from "child_process";
|
|
||||||
import { existsAsync } from "./tools/fs.existsAsync";
|
|
||||||
import type { BuildOptions } from "./keycloakify/buildOptions";
|
|
||||||
import { getProxyFetchOptions } from "./tools/fetchProxyOptions";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
cacheDirPath: string;
|
|
||||||
npmWorkspaceRootDirPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
|
|
||||||
export async function downloadAndUnzip(params: {
|
|
||||||
url: string;
|
|
||||||
destDirPath: string;
|
|
||||||
specificDirsToExtract?: string[];
|
|
||||||
preCacheTransform?: {
|
|
||||||
actionCacheId: string;
|
|
||||||
action: (params: { destDirPath: string }) => Promise<void>;
|
|
||||||
};
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
}) {
|
|
||||||
const { url, destDirPath, specificDirsToExtract, preCacheTransform, buildOptions } = params;
|
|
||||||
|
|
||||||
const { extractDirPath, zipFilePath } = (() => {
|
|
||||||
const zipFileBasenameWithoutExt = generateFileNameFromURL({
|
|
||||||
url,
|
|
||||||
"preCacheTransform":
|
|
||||||
preCacheTransform === undefined
|
|
||||||
? undefined
|
|
||||||
: {
|
|
||||||
"actionCacheId": preCacheTransform.actionCacheId,
|
|
||||||
"actionFootprint": preCacheTransform.action.toString()
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
const zipFilePath = pathJoin(buildOptions.cacheDirPath, `${zipFileBasenameWithoutExt}.zip`);
|
|
||||||
const extractDirPath = pathJoin(buildOptions.cacheDirPath, `tmp_unzip_${zipFileBasenameWithoutExt}`);
|
|
||||||
|
|
||||||
return { zipFilePath, extractDirPath };
|
|
||||||
})();
|
|
||||||
|
|
||||||
download_zip_and_transform: {
|
|
||||||
if (await existsAsync(zipFilePath)) {
|
|
||||||
break download_zip_and_transform;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { response, isFromRemoteCache } = await (async () => {
|
|
||||||
const proxyFetchOptions = await getProxyFetchOptions({
|
|
||||||
"npmWorkspaceRootDirPath": buildOptions.npmWorkspaceRootDirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
const response = await fetch(
|
|
||||||
`https://github.com/keycloakify/keycloakify/releases/download/v0.0.1/${pathBasename(zipFilePath)}`,
|
|
||||||
proxyFetchOptions
|
|
||||||
);
|
|
||||||
|
|
||||||
if (response.status === 200) {
|
|
||||||
return {
|
|
||||||
response,
|
|
||||||
"isFromRemoteCache": true
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"response": await fetch(url, proxyFetchOptions),
|
|
||||||
"isFromRemoteCache": false
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
await mkdir(pathDirname(zipFilePath), { "recursive": true });
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The correct way to fix this is to upgrade node-fetch beyond 3.2.5
|
|
||||||
* (see https://github.com/node-fetch/node-fetch/issues/1295#issuecomment-1144061991.)
|
|
||||||
* Unfortunately, octokit (a dependency of keycloakify) also uses node-fetch, and
|
|
||||||
* does not support node-fetch 3.x. So we stick around with this band-aid until
|
|
||||||
* octokit upgrades.
|
|
||||||
*/
|
|
||||||
response.body?.setMaxListeners(Number.MAX_VALUE);
|
|
||||||
assert(typeof response.body !== "undefined" && response.body != null);
|
|
||||||
|
|
||||||
await writeFile(zipFilePath, response.body);
|
|
||||||
|
|
||||||
if (isFromRemoteCache) {
|
|
||||||
break download_zip_and_transform;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (specificDirsToExtract === undefined && preCacheTransform === undefined) {
|
|
||||||
break download_zip_and_transform;
|
|
||||||
}
|
|
||||||
|
|
||||||
await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
|
|
||||||
|
|
||||||
try {
|
|
||||||
await preCacheTransform?.action({
|
|
||||||
"destDirPath": extractDirPath
|
|
||||||
});
|
|
||||||
} catch (error) {
|
|
||||||
await Promise.all([rm(extractDirPath, { "recursive": true }), unlink(zipFilePath)]);
|
|
||||||
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
await unlink(zipFilePath);
|
|
||||||
|
|
||||||
await zip(extractDirPath, zipFilePath);
|
|
||||||
|
|
||||||
await rm(extractDirPath, { "recursive": true });
|
|
||||||
|
|
||||||
upload_to_remot_cache_if_admin: {
|
|
||||||
const githubToken = process.env["KEYCLOAKIFY_ADMIN_GITHUB_PERSONAL_ACCESS_TOKEN"];
|
|
||||||
|
|
||||||
if (githubToken === undefined) {
|
|
||||||
break upload_to_remot_cache_if_admin;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log("uploading to remote cache");
|
|
||||||
|
|
||||||
try {
|
|
||||||
child_process.execSync(`which putasset`);
|
|
||||||
} catch {
|
|
||||||
child_process.execSync(`npm install -g putasset`);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
child_process.execFileSync("putasset", [
|
|
||||||
"--owner",
|
|
||||||
"keycloakify",
|
|
||||||
"--repo",
|
|
||||||
"keycloakify",
|
|
||||||
"--tag",
|
|
||||||
"v0.0.1",
|
|
||||||
"--filename",
|
|
||||||
zipFilePath,
|
|
||||||
"--token",
|
|
||||||
githubToken
|
|
||||||
]);
|
|
||||||
} catch {
|
|
||||||
console.log("upload failed, asset probably already exists in remote cache");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
await unzip(zipFilePath, extractDirPath);
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": extractDirPath,
|
|
||||||
"destDirPath": destDirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
await rm(extractDirPath, { "recursive": true });
|
|
||||||
}
|
|
||||||
|
|
||||||
function generateFileNameFromURL(params: {
|
|
||||||
url: string;
|
|
||||||
preCacheTransform:
|
|
||||||
| {
|
|
||||||
actionCacheId: string;
|
|
||||||
actionFootprint: string;
|
|
||||||
}
|
|
||||||
| undefined;
|
|
||||||
}): string {
|
|
||||||
const { preCacheTransform } = params;
|
|
||||||
|
|
||||||
// Parse the URL
|
|
||||||
const url = new URL(params.url);
|
|
||||||
|
|
||||||
// Extract pathname and remove leading slashes
|
|
||||||
let fileName = url.pathname.replace(/^\//, "").replace(/\//g, "_");
|
|
||||||
|
|
||||||
// Optionally, add query parameters replacing special characters
|
|
||||||
if (url.search) {
|
|
||||||
fileName += url.search.replace(/[&=?]/g, "-");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Replace any characters that are not valid in filenames
|
|
||||||
fileName = fileName.replace(/[^a-zA-Z0-9-_]/g, "");
|
|
||||||
|
|
||||||
// Trim or pad the fileName to a specific length
|
|
||||||
fileName = fileName.substring(0, 50);
|
|
||||||
|
|
||||||
add_pre_cache_transform: {
|
|
||||||
if (preCacheTransform === undefined) {
|
|
||||||
break add_pre_cache_transform;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sanitize actionCacheId the same way as other components
|
|
||||||
const sanitizedActionCacheId = preCacheTransform.actionCacheId.replace(/[^a-zA-Z0-9-_]/g, "_");
|
|
||||||
|
|
||||||
fileName += `_${sanitizedActionCacheId}_${createHash("sha256").update(preCacheTransform.actionFootprint).digest("hex").substring(0, 5)}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
return fileName;
|
|
||||||
}
|
|
@ -1,25 +1,26 @@
|
|||||||
#!/usr/bin/env node
|
#!/usr/bin/env node
|
||||||
|
|
||||||
import { getThisCodebaseRootDirPath } from "./tools/getThisCodebaseRootDirPath";
|
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";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
|
import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
|
||||||
import { assert, Equals } from "tsafe/assert";
|
import { assert, Equals } from "tsafe/assert";
|
||||||
import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
|
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
||||||
import { themeTypes, type ThemeType } from "./constants";
|
|
||||||
import { getReactAppRootDirPath } from "./keycloakify/buildOptions/getReactAppRootDirPath";
|
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
console.log("Select a theme type");
|
console.log("Select a theme type");
|
||||||
|
|
||||||
const { reactAppRootDirPath } = getReactAppRootDirPath({
|
|
||||||
"processArgv": process.argv.slice(2)
|
|
||||||
});
|
|
||||||
|
|
||||||
const { value: themeType } = await cliSelect<ThemeType>({
|
const { value: themeType } = await cliSelect<ThemeType>({
|
||||||
"values": [...themeTypes]
|
"values": [...themeTypes]
|
||||||
}).catch(() => {
|
}).catch(() => {
|
||||||
@ -48,7 +49,7 @@ import { getReactAppRootDirPath } from "./keycloakify/buildOptions/getReactAppRo
|
|||||||
|
|
||||||
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);
|
||||||
|
|
||||||
@ -58,7 +59,7 @@ import { getReactAppRootDirPath } from "./keycloakify/buildOptions/getReactAppRo
|
|||||||
process.exit(-1);
|
process.exit(-1);
|
||||||
}
|
}
|
||||||
|
|
||||||
await writeFile(targetFilePath, await readFile(pathJoin(getThisCodebaseRootDirPath(), "src", themeType, "pages", pageBasename)));
|
await writeFile(targetFilePath, await readFile(pathJoin(getProjectRoot(), "src", themeType, "pages", pageBasename)));
|
||||||
|
|
||||||
console.log(`${pathRelative(process.cwd(), targetFilePath)} created`);
|
console.log(`${pathRelative(process.cwd(), targetFilePath)} created`);
|
||||||
})();
|
})();
|
||||||
|
@ -2,15 +2,15 @@ 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 themeSrcDirBasenames = ["keycloak-theme", "keycloak_theme"];
|
||||||
|
|
||||||
/** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
|
/** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
|
||||||
export function getThemeSrcDirPath(params: { 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 => {
|
@ -4,21 +4,23 @@ import { downloadBuiltinKeycloakTheme } from "./download-builtin-keycloak-theme"
|
|||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
import { transformCodebase } from "./tools/transformCodebase";
|
import { transformCodebase } from "./tools/transformCodebase";
|
||||||
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
||||||
import { readBuildOptions } from "./keycloakify/buildOptions";
|
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { getLogger } from "./tools/logger";
|
import { getLogger } from "./tools/logger";
|
||||||
import { getThemeSrcDirPath } from "./getThemeSrcDirPath";
|
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
||||||
import { rmSync } from "./tools/fs.rmSync";
|
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const buildOptions = readBuildOptions({
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
|
const { isSilent } = readBuildOptions({
|
||||||
|
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": buildOptions.reactAppRootDirPath
|
projectDirPath
|
||||||
});
|
});
|
||||||
|
|
||||||
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
@ -34,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({
|
||||||
@ -52,7 +54,7 @@ export async function main() {
|
|||||||
|
|
||||||
logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
|
logger.log(`${pathRelative(process.cwd(), emailThemeSrcDirPath)} ready to be customized, feel free to remove every file you do not customize`);
|
||||||
|
|
||||||
rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
|
fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true, "force": true });
|
||||||
}
|
}
|
||||||
|
|
||||||
if (require.main === module) {
|
if (require.main === module) {
|
||||||
|
138
src/bin/keycloakify/BuildOptions.ts
Normal file
138
src/bin/keycloakify/BuildOptions.ts
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { id } from "tsafe/id";
|
||||||
|
import { parse as urlParse } from "url";
|
||||||
|
import { typeGuard } from "tsafe/typeGuard";
|
||||||
|
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";
|
||||||
|
|
||||||
|
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
||||||
|
export type BuildOptions = {
|
||||||
|
isSilent: boolean;
|
||||||
|
themeVersion: string;
|
||||||
|
themeName: string;
|
||||||
|
extraThemeNames: string[];
|
||||||
|
extraThemeProperties: string[] | undefined;
|
||||||
|
groupId: string;
|
||||||
|
artifactId: string;
|
||||||
|
bundler: Bundler;
|
||||||
|
keycloakVersionDefaultAssets: string;
|
||||||
|
/** Directory of your built react project. Defaults to {cwd}/build */
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
/** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
|
||||||
|
* In this case the urlPathname will be "/my-app/" */
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
|
export function readBuildOptions(params: { projectDirPath: string; processArgv: string[] }): BuildOptions {
|
||||||
|
const { projectDirPath, processArgv } = params;
|
||||||
|
|
||||||
|
const { isSilentCliParamProvided } = (() => {
|
||||||
|
const argv = parseArgv(processArgv);
|
||||||
|
|
||||||
|
return {
|
||||||
|
"isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false
|
||||||
|
};
|
||||||
|
})();
|
||||||
|
|
||||||
|
const parsedPackageJson = getParsedPackageJson({ projectDirPath });
|
||||||
|
|
||||||
|
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
||||||
|
|
||||||
|
const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
|
||||||
|
|
||||||
|
const themeName =
|
||||||
|
keycloakify.themeName ??
|
||||||
|
name
|
||||||
|
.replace(/^@(.*)/, "$1")
|
||||||
|
.split("/")
|
||||||
|
.join("-");
|
||||||
|
|
||||||
|
return {
|
||||||
|
themeName,
|
||||||
|
extraThemeNames,
|
||||||
|
"bundler": (() => {
|
||||||
|
const { KEYCLOAKIFY_BUNDLER } = process.env;
|
||||||
|
|
||||||
|
assert(
|
||||||
|
typeGuard<Bundler | undefined>(KEYCLOAKIFY_BUNDLER, [undefined, ...id<readonly string[]>(bundlers)].includes(KEYCLOAKIFY_BUNDLER)),
|
||||||
|
`${symToStr({ KEYCLOAKIFY_BUNDLER })} should be one of ${bundlers.join(", ")}`
|
||||||
|
);
|
||||||
|
|
||||||
|
return KEYCLOAKIFY_BUNDLER ?? bundler ?? "keycloakify";
|
||||||
|
})(),
|
||||||
|
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeName}-keycloak-theme`,
|
||||||
|
"groupId": (() => {
|
||||||
|
const fallbackGroupId = `${themeName}.keycloak`;
|
||||||
|
|
||||||
|
return (
|
||||||
|
process.env.KEYCLOAKIFY_GROUP_ID ??
|
||||||
|
groupId ??
|
||||||
|
(!homepage
|
||||||
|
? fallbackGroupId
|
||||||
|
: urlParse(homepage)
|
||||||
|
.host?.replace(/:[0-9]+$/, "")
|
||||||
|
?.split(".")
|
||||||
|
.reverse()
|
||||||
|
.join(".") ?? fallbackGroupId) + ".keycloak"
|
||||||
|
);
|
||||||
|
})(),
|
||||||
|
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
|
||||||
|
extraThemeProperties,
|
||||||
|
"isSilent": isSilentCliParamProvided,
|
||||||
|
"keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
|
||||||
|
"reactAppBuildDirPath": (() => {
|
||||||
|
let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
|
||||||
|
|
||||||
|
if (reactAppBuildDirPath === undefined) {
|
||||||
|
return pathJoin(projectDirPath, "build");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (pathSep === "\\") {
|
||||||
|
reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
|
||||||
|
return pathJoin(projectDirPath, reactAppBuildDirPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
return reactAppBuildDirPath;
|
||||||
|
})(),
|
||||||
|
"keycloakifyBuildDirPath": (() => {
|
||||||
|
let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
|
||||||
|
|
||||||
|
if (keycloakifyBuildDirPath === undefined) {
|
||||||
|
return pathJoin(projectDirPath, "build_keycloak");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (pathSep === "\\") {
|
||||||
|
keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
|
||||||
|
return pathJoin(projectDirPath, keycloakifyBuildDirPath);
|
||||||
|
}
|
||||||
|
|
||||||
|
return keycloakifyBuildDirPath;
|
||||||
|
})(),
|
||||||
|
"urlPathname": (() => {
|
||||||
|
const { homepage } = parsedPackageJson;
|
||||||
|
|
||||||
|
let url: URL | undefined = undefined;
|
||||||
|
|
||||||
|
if (homepage !== undefined) {
|
||||||
|
url = new URL(homepage);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const out = url.pathname.replace(/([^/])$/, "$1/");
|
||||||
|
return out === "/" ? undefined : out;
|
||||||
|
})()
|
||||||
|
};
|
||||||
|
}
|
@ -1,25 +0,0 @@
|
|||||||
import { z } from "zod";
|
|
||||||
|
|
||||||
export type UserProvidedBuildOptions = {
|
|
||||||
extraThemeProperties?: string[];
|
|
||||||
artifactId?: string;
|
|
||||||
groupId?: string;
|
|
||||||
doCreateJar?: boolean;
|
|
||||||
loginThemeResourcesFromKeycloakVersion?: string;
|
|
||||||
reactAppBuildDirPath?: string;
|
|
||||||
keycloakifyBuildDirPath?: string;
|
|
||||||
themeName?: string | string[];
|
|
||||||
doBuildRetrocompatAccountTheme?: boolean;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const zUserProvidedBuildOptions = z.object({
|
|
||||||
"extraThemeProperties": z.array(z.string()).optional(),
|
|
||||||
"artifactId": z.string().optional(),
|
|
||||||
"groupId": z.string().optional(),
|
|
||||||
"doCreateJar": z.boolean().optional(),
|
|
||||||
"loginThemeResourcesFromKeycloakVersion": z.string().optional(),
|
|
||||||
"reactAppBuildDirPath": z.string().optional(),
|
|
||||||
"keycloakifyBuildDirPath": z.string().optional(),
|
|
||||||
"themeName": z.union([z.string(), z.array(z.string())]).optional(),
|
|
||||||
"doBuildRetrocompatAccountTheme": z.boolean().optional()
|
|
||||||
});
|
|
@ -1,193 +0,0 @@
|
|||||||
import { parse as urlParse } from "url";
|
|
||||||
import { readParsedPackageJson } from "./parsedPackageJson";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import parseArgv from "minimist";
|
|
||||||
import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
|
|
||||||
import { readResolvedViteConfig } from "./resolvedViteConfig";
|
|
||||||
import * as fs from "fs";
|
|
||||||
import { getCacheDirPath } from "./getCacheDirPath";
|
|
||||||
import { getReactAppRootDirPath } from "./getReactAppRootDirPath";
|
|
||||||
import { getNpmWorkspaceRootDirPath } from "./getNpmWorkspaceRootDirPath";
|
|
||||||
|
|
||||||
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
|
||||||
export type BuildOptions = {
|
|
||||||
bundler: "vite" | "webpack";
|
|
||||||
isSilent: boolean;
|
|
||||||
themeVersion: string;
|
|
||||||
themeNames: string[];
|
|
||||||
extraThemeProperties: string[] | undefined;
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
doCreateJar: boolean;
|
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
|
||||||
reactAppRootDirPath: string;
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
publicDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
/** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
|
|
||||||
* In this case the urlPathname will be "/my-app/" */
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
assetsDirPath: string;
|
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
npmWorkspaceRootDirPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export function readBuildOptions(params: { processArgv: string[] }): BuildOptions {
|
|
||||||
const { processArgv } = params;
|
|
||||||
|
|
||||||
const { reactAppRootDirPath } = getReactAppRootDirPath({ processArgv });
|
|
||||||
|
|
||||||
const { cacheDirPath } = getCacheDirPath({ reactAppRootDirPath });
|
|
||||||
|
|
||||||
const { resolvedViteConfig } = readResolvedViteConfig({ cacheDirPath });
|
|
||||||
|
|
||||||
if (resolvedViteConfig === undefined && fs.existsSync(pathJoin(reactAppRootDirPath, "vite.config.ts"))) {
|
|
||||||
throw new Error("Keycloakify's Vite plugin output not found");
|
|
||||||
}
|
|
||||||
|
|
||||||
const { keycloakify: userProvidedBuildOptionsFromPackageJson, ...parsedPackageJson } = readParsedPackageJson({ reactAppRootDirPath });
|
|
||||||
|
|
||||||
const userProvidedBuildOptions = {
|
|
||||||
...userProvidedBuildOptionsFromPackageJson,
|
|
||||||
...resolvedViteConfig?.userProvidedBuildOptions
|
|
||||||
};
|
|
||||||
|
|
||||||
const themeNames = (() => {
|
|
||||||
if (userProvidedBuildOptions.themeName === undefined) {
|
|
||||||
return [
|
|
||||||
parsedPackageJson.name
|
|
||||||
.replace(/^@(.*)/, "$1")
|
|
||||||
.split("/")
|
|
||||||
.join("-")
|
|
||||||
];
|
|
||||||
}
|
|
||||||
|
|
||||||
if (typeof userProvidedBuildOptions.themeName === "string") {
|
|
||||||
return [userProvidedBuildOptions.themeName];
|
|
||||||
}
|
|
||||||
|
|
||||||
return userProvidedBuildOptions.themeName;
|
|
||||||
})();
|
|
||||||
|
|
||||||
const reactAppBuildDirPath = (() => {
|
|
||||||
webpack: {
|
|
||||||
if (resolvedViteConfig !== undefined) {
|
|
||||||
break webpack;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (userProvidedBuildOptions.reactAppBuildDirPath !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": userProvidedBuildOptions.reactAppBuildDirPath,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "build");
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, resolvedViteConfig.buildDir);
|
|
||||||
})();
|
|
||||||
|
|
||||||
const argv = parseArgv(processArgv);
|
|
||||||
|
|
||||||
const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({ reactAppRootDirPath });
|
|
||||||
|
|
||||||
return {
|
|
||||||
"bundler": resolvedViteConfig !== undefined ? "vite" : "webpack",
|
|
||||||
"isSilent": typeof argv["silent"] === "boolean" ? argv["silent"] : false,
|
|
||||||
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? parsedPackageJson.version ?? "0.0.0",
|
|
||||||
themeNames,
|
|
||||||
"extraThemeProperties": userProvidedBuildOptions.extraThemeProperties,
|
|
||||||
"groupId": (() => {
|
|
||||||
const fallbackGroupId = `${themeNames[0]}.keycloak`;
|
|
||||||
|
|
||||||
return (
|
|
||||||
process.env.KEYCLOAKIFY_GROUP_ID ??
|
|
||||||
userProvidedBuildOptions.groupId ??
|
|
||||||
(parsedPackageJson.homepage === undefined
|
|
||||||
? fallbackGroupId
|
|
||||||
: urlParse(parsedPackageJson.homepage)
|
|
||||||
.host?.replace(/:[0-9]+$/, "")
|
|
||||||
?.split(".")
|
|
||||||
.reverse()
|
|
||||||
.join(".") ?? fallbackGroupId) + ".keycloak"
|
|
||||||
);
|
|
||||||
})(),
|
|
||||||
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? userProvidedBuildOptions.artifactId ?? `${themeNames[0]}-keycloak-theme`,
|
|
||||||
"doCreateJar": userProvidedBuildOptions.doCreateJar ?? true,
|
|
||||||
"loginThemeResourcesFromKeycloakVersion": userProvidedBuildOptions.loginThemeResourcesFromKeycloakVersion ?? "11.0.3",
|
|
||||||
reactAppRootDirPath,
|
|
||||||
reactAppBuildDirPath,
|
|
||||||
"keycloakifyBuildDirPath": (() => {
|
|
||||||
if (userProvidedBuildOptions.keycloakifyBuildDirPath !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": userProvidedBuildOptions.keycloakifyBuildDirPath,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(
|
|
||||||
reactAppRootDirPath,
|
|
||||||
resolvedViteConfig?.buildDir === undefined ? "build_keycloak" : `${resolvedViteConfig.buildDir}_keycloak`
|
|
||||||
);
|
|
||||||
})(),
|
|
||||||
"publicDirPath": (() => {
|
|
||||||
webpack: {
|
|
||||||
if (resolvedViteConfig !== undefined) {
|
|
||||||
break webpack;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (process.env.PUBLIC_DIR_PATH !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": process.env.PUBLIC_DIR_PATH,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, "public");
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppRootDirPath, resolvedViteConfig.publicDir);
|
|
||||||
})(),
|
|
||||||
cacheDirPath,
|
|
||||||
"urlPathname": (() => {
|
|
||||||
webpack: {
|
|
||||||
if (resolvedViteConfig !== undefined) {
|
|
||||||
break webpack;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { homepage } = parsedPackageJson;
|
|
||||||
|
|
||||||
let url: URL | undefined = undefined;
|
|
||||||
|
|
||||||
if (homepage !== undefined) {
|
|
||||||
url = new URL(homepage);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (url === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
const out = url.pathname.replace(/([^/])$/, "$1/");
|
|
||||||
return out === "/" ? undefined : out;
|
|
||||||
}
|
|
||||||
|
|
||||||
return resolvedViteConfig.urlPathname;
|
|
||||||
})(),
|
|
||||||
"assetsDirPath": (() => {
|
|
||||||
webpack: {
|
|
||||||
if (resolvedViteConfig !== undefined) {
|
|
||||||
break webpack;
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppBuildDirPath, "static");
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(reactAppBuildDirPath, resolvedViteConfig.assetsDir);
|
|
||||||
})(),
|
|
||||||
"doBuildRetrocompatAccountTheme": userProvidedBuildOptions.doBuildRetrocompatAccountTheme ?? true,
|
|
||||||
npmWorkspaceRootDirPath
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,25 +0,0 @@
|
|||||||
import { join as pathJoin } from "path";
|
|
||||||
import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
|
|
||||||
import { getNpmWorkspaceRootDirPath } from "./getNpmWorkspaceRootDirPath";
|
|
||||||
|
|
||||||
export function getCacheDirPath(params: { reactAppRootDirPath: string }) {
|
|
||||||
const { reactAppRootDirPath } = params;
|
|
||||||
|
|
||||||
const { npmWorkspaceRootDirPath } = getNpmWorkspaceRootDirPath({ reactAppRootDirPath });
|
|
||||||
|
|
||||||
const cacheDirPath = pathJoin(
|
|
||||||
(() => {
|
|
||||||
if (process.env.XDG_CACHE_HOME !== undefined) {
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": process.env.XDG_CACHE_HOME,
|
|
||||||
"cwd": reactAppRootDirPath
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathJoin(npmWorkspaceRootDirPath, "node_modules", ".cache");
|
|
||||||
})(),
|
|
||||||
"keycloakify"
|
|
||||||
);
|
|
||||||
|
|
||||||
return { cacheDirPath };
|
|
||||||
}
|
|
@ -1,49 +0,0 @@
|
|||||||
import * as child_process from "child_process";
|
|
||||||
import { join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
|
|
||||||
let cache:
|
|
||||||
| {
|
|
||||||
reactAppRootDirPath: string;
|
|
||||||
npmWorkspaceRootDirPath: string;
|
|
||||||
}
|
|
||||||
| undefined = undefined;
|
|
||||||
|
|
||||||
export function getNpmWorkspaceRootDirPath(params: { reactAppRootDirPath: string }) {
|
|
||||||
const { reactAppRootDirPath } = params;
|
|
||||||
|
|
||||||
use_cache: {
|
|
||||||
if (cache === undefined || cache.reactAppRootDirPath !== reactAppRootDirPath) {
|
|
||||||
break use_cache;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { npmWorkspaceRootDirPath } = cache;
|
|
||||||
|
|
||||||
return { npmWorkspaceRootDirPath };
|
|
||||||
}
|
|
||||||
|
|
||||||
const npmWorkspaceRootDirPath = (function callee(depth: number): string {
|
|
||||||
const cwd = pathResolve(pathJoin(...[reactAppRootDirPath, ...Array(depth).fill("..")]));
|
|
||||||
|
|
||||||
try {
|
|
||||||
child_process.execSync("npm config get", { cwd: cwd });
|
|
||||||
} catch (error) {
|
|
||||||
if (String(error).includes("ENOWORKSPACES")) {
|
|
||||||
assert(cwd !== pathSep, "NPM workspace not found");
|
|
||||||
|
|
||||||
return callee(depth + 1);
|
|
||||||
}
|
|
||||||
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
|
|
||||||
return cwd;
|
|
||||||
})(0);
|
|
||||||
|
|
||||||
cache = {
|
|
||||||
reactAppRootDirPath,
|
|
||||||
npmWorkspaceRootDirPath
|
|
||||||
};
|
|
||||||
|
|
||||||
return { npmWorkspaceRootDirPath };
|
|
||||||
}
|
|
@ -1,23 +0,0 @@
|
|||||||
import parseArgv from "minimist";
|
|
||||||
import { getAbsoluteAndInOsFormatPath } from "../../tools/getAbsoluteAndInOsFormatPath";
|
|
||||||
|
|
||||||
export function getReactAppRootDirPath(params: { processArgv: string[] }) {
|
|
||||||
const { processArgv } = params;
|
|
||||||
|
|
||||||
const argv = parseArgv(processArgv);
|
|
||||||
|
|
||||||
const reactAppRootDirPath = (() => {
|
|
||||||
const arg = argv["project"] ?? argv["p"];
|
|
||||||
|
|
||||||
if (typeof arg !== "string") {
|
|
||||||
return process.cwd();
|
|
||||||
}
|
|
||||||
|
|
||||||
return getAbsoluteAndInOsFormatPath({
|
|
||||||
"pathIsh": arg,
|
|
||||||
"cwd": process.cwd()
|
|
||||||
});
|
|
||||||
})();
|
|
||||||
|
|
||||||
return { reactAppRootDirPath };
|
|
||||||
}
|
|
@ -1 +0,0 @@
|
|||||||
export * from "./buildOptions";
|
|
@ -1,32 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { assert } from "tsafe";
|
|
||||||
import type { Equals } from "tsafe";
|
|
||||||
import { z } from "zod";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import { type UserProvidedBuildOptions, zUserProvidedBuildOptions } from "./UserProvidedBuildOptions";
|
|
||||||
|
|
||||||
export type ParsedPackageJson = {
|
|
||||||
name: string;
|
|
||||||
version?: string;
|
|
||||||
homepage?: string;
|
|
||||||
keycloakify?: UserProvidedBuildOptions;
|
|
||||||
};
|
|
||||||
|
|
||||||
const zParsedPackageJson = z.object({
|
|
||||||
"name": z.string(),
|
|
||||||
"version": z.string().optional(),
|
|
||||||
"homepage": z.string().optional(),
|
|
||||||
"keycloakify": zUserProvidedBuildOptions.optional()
|
|
||||||
});
|
|
||||||
|
|
||||||
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
|
||||||
|
|
||||||
let parsedPackageJson: undefined | ParsedPackageJson;
|
|
||||||
export function readParsedPackageJson(params: { reactAppRootDirPath: string }) {
|
|
||||||
const { reactAppRootDirPath } = params;
|
|
||||||
if (parsedPackageJson) {
|
|
||||||
return parsedPackageJson;
|
|
||||||
}
|
|
||||||
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
|
|
||||||
return parsedPackageJson;
|
|
||||||
}
|
|
@ -1,74 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { assert } from "tsafe";
|
|
||||||
import type { Equals } from "tsafe";
|
|
||||||
import { z } from "zod";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import { resolvedViteConfigJsonBasename } from "../../constants";
|
|
||||||
import type { OptionalIfCanBeUndefined } from "../../tools/OptionalIfCanBeUndefined";
|
|
||||||
import { UserProvidedBuildOptions, zUserProvidedBuildOptions } from "./UserProvidedBuildOptions";
|
|
||||||
|
|
||||||
export type ResolvedViteConfig = {
|
|
||||||
buildDir: string;
|
|
||||||
publicDir: string;
|
|
||||||
assetsDir: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
userProvidedBuildOptions: UserProvidedBuildOptions;
|
|
||||||
};
|
|
||||||
|
|
||||||
const zResolvedViteConfig = z.object({
|
|
||||||
"buildDir": z.string(),
|
|
||||||
"publicDir": z.string(),
|
|
||||||
"assetsDir": z.string(),
|
|
||||||
"urlPathname": z.string().optional(),
|
|
||||||
"userProvidedBuildOptions": zUserProvidedBuildOptions
|
|
||||||
});
|
|
||||||
|
|
||||||
{
|
|
||||||
type Got = ReturnType<(typeof zResolvedViteConfig)["parse"]>;
|
|
||||||
type Expected = OptionalIfCanBeUndefined<ResolvedViteConfig>;
|
|
||||||
|
|
||||||
assert<Equals<Got, Expected>>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function readResolvedViteConfig(params: { cacheDirPath: string }): {
|
|
||||||
resolvedViteConfig: ResolvedViteConfig | undefined;
|
|
||||||
} {
|
|
||||||
const { cacheDirPath } = params;
|
|
||||||
|
|
||||||
const resolvedViteConfigJsonFilePath = pathJoin(cacheDirPath, resolvedViteConfigJsonBasename);
|
|
||||||
|
|
||||||
if (!fs.existsSync(resolvedViteConfigJsonFilePath)) {
|
|
||||||
return { "resolvedViteConfig": undefined };
|
|
||||||
}
|
|
||||||
|
|
||||||
const resolvedViteConfig = (() => {
|
|
||||||
if (!fs.existsSync(resolvedViteConfigJsonFilePath)) {
|
|
||||||
throw new Error("Missing Keycloakify Vite plugin output.");
|
|
||||||
}
|
|
||||||
|
|
||||||
let out: ResolvedViteConfig;
|
|
||||||
|
|
||||||
try {
|
|
||||||
out = JSON.parse(fs.readFileSync(resolvedViteConfigJsonFilePath).toString("utf8"));
|
|
||||||
} catch {
|
|
||||||
throw new Error("The output of the Keycloakify Vite plugin is not a valid JSON.");
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const zodParseReturn = zResolvedViteConfig.parse(out);
|
|
||||||
|
|
||||||
// So that objectKeys from tsafe return the expected result no matter what.
|
|
||||||
Object.keys(zodParseReturn)
|
|
||||||
.filter(key => !(key in out))
|
|
||||||
.forEach(key => {
|
|
||||||
delete (out as any)[key];
|
|
||||||
});
|
|
||||||
} catch {
|
|
||||||
throw new Error("The output of the Keycloakify Vite plugin do not match the expected schema.");
|
|
||||||
}
|
|
||||||
|
|
||||||
return out;
|
|
||||||
})();
|
|
||||||
|
|
||||||
return { resolvedViteConfig };
|
|
||||||
}
|
|
1
src/bin/keycloakify/ftlValuesGlobalName.ts
Normal file
1
src/bin/keycloakify/ftlValuesGlobalName.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export const ftlValuesGlobalName = "kcContext";
|
@ -1,34 +1,36 @@
|
|||||||
import cheerio from "cheerio";
|
import cheerio from "cheerio";
|
||||||
import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
|
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
||||||
import { generateCssCodeToDefineGlobals } from "../replacers/replaceImportsInCssCode";
|
import { generateCssCodeToDefineGlobals } from "../replacers/replaceImportsInCssCode";
|
||||||
import { replaceImportsInInlineCssCode } from "../replacers/replaceImportsInInlineCssCode";
|
import { replaceImportsInInlineCssCode } from "../replacers/replaceImportsInInlineCssCode";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { objectKeys } from "tsafe/objectKeys";
|
import { objectKeys } from "tsafe/objectKeys";
|
||||||
import type { BuildOptions } from "../buildOptions";
|
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
||||||
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { type ThemeType, nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir, resources_common } from "../../constants";
|
|
||||||
|
export const themeTypes = ["login", "account"] as const;
|
||||||
|
|
||||||
|
export type ThemeType = (typeof themeTypes)[number];
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
bundler: "vite" | "webpack";
|
themeName: string;
|
||||||
themeVersion: string;
|
themeVersion: string;
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
assetsDirPath: string;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
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.
|
||||||
cssGlobalsToDefine: Record<string, string>;
|
cssGlobalsToDefine: Record<string, string>;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
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);
|
||||||
|
|
||||||
@ -38,7 +40,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
|
|
||||||
assert(jsCode !== null);
|
assert(jsCode !== null);
|
||||||
|
|
||||||
const { fixedJsCode } = replaceImportsInJsCode({ jsCode, buildOptions });
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({ jsCode });
|
||||||
|
|
||||||
$(element).text(fixedJsCode);
|
$(element).text(fixedJsCode);
|
||||||
});
|
});
|
||||||
@ -71,10 +73,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
|
|
||||||
$(element).attr(
|
$(element).attr(
|
||||||
attrName,
|
attrName,
|
||||||
href.replace(
|
href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
|
||||||
new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`),
|
|
||||||
`\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/`
|
|
||||||
)
|
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@ -105,8 +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),
|
||||||
.replace("RESOURCES_COMMON_cLsLsMrtDkpVv", resources_common),
|
|
||||||
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
||||||
"<#if scripts??>",
|
"<#if scripts??>",
|
||||||
" <#list scripts as script>",
|
" <#list scripts as script>",
|
||||||
@ -119,7 +117,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
$("head").prepend(
|
$("head").prepend(
|
||||||
[
|
[
|
||||||
"<script>",
|
"<script>",
|
||||||
` window.${nameOfTheGlobal}= ${objectKeys(replaceValueBySearchValue)[0]};`,
|
` window.${ftlValuesGlobalName}= ${objectKeys(replaceValueBySearchValue)[0]};`,
|
||||||
"</script>",
|
"</script>",
|
||||||
"",
|
"",
|
||||||
objectKeys(replaceValueBySearchValue)[1]
|
objectKeys(replaceValueBySearchValue)[1]
|
||||||
|
@ -27,7 +27,7 @@ export const loginThemePageIds = [
|
|||||||
"saml-post-form.ftl"
|
"saml-post-form.ftl"
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
export const accountThemePageIds = ["password.ftl", "account.ftl", "sessions.ftl", "totp.ftl", "applications.ftl", "log.ftl"] as const;
|
export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
|
||||||
|
|
||||||
export type LoginThemePageId = (typeof loginThemePageIds)[number];
|
export type LoginThemePageId = (typeof loginThemePageIds)[number];
|
||||||
export type AccountThemePageId = (typeof accountThemePageIds)[number];
|
export type AccountThemePageId = (typeof accountThemePageIds)[number];
|
||||||
|
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,70 +0,0 @@
|
|||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "./buildOptions";
|
|
||||||
|
|
||||||
type BuildOptionsLike = {
|
|
||||||
groupId: string;
|
|
||||||
artifactId: string;
|
|
||||||
themeVersion: string;
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function generatePom(params: { buildOptions: BuildOptionsLike }) {
|
|
||||||
const { 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 };
|
|
||||||
})();
|
|
||||||
|
|
||||||
return { pomFileCode };
|
|
||||||
}
|
|
@ -1,59 +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",
|
||||||
"",
|
"",
|
||||||
`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,84 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "../buildOptions";
|
|
||||||
import { resources_common, lastKeycloakVersionWithAccountV1, accountV1ThemeName } from "../../constants";
|
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
|
||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
|
||||||
import { rmSync } from "../../tools/fs.rmSync";
|
|
||||||
|
|
||||||
type BuildOptionsLike = {
|
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
npmWorkspaceRootDirPath: 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", accountV1ThemeName, "account");
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "account"),
|
|
||||||
"destDirPath": accountV1DirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "account", "resources"),
|
|
||||||
"destDirPath": pathJoin(accountV1DirPath, "resources")
|
|
||||||
});
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "common", "resources"),
|
|
||||||
"destDirPath": pathJoin(accountV1DirPath, "resources", resources_common)
|
|
||||||
});
|
|
||||||
|
|
||||||
rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true });
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(accountV1DirPath, "theme.properties"),
|
|
||||||
Buffer.from(
|
|
||||||
[
|
|
||||||
"accountResourceProvider=account-v1",
|
|
||||||
"",
|
|
||||||
"locales=ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
|
||||||
"",
|
|
||||||
"styles=" +
|
|
||||||
[
|
|
||||||
"css/account.css",
|
|
||||||
"img/icon-sidebar-active.png",
|
|
||||||
"img/logo.png",
|
|
||||||
...["patternfly.min.css", "patternfly-additions.min.css", "patternfly-additions.min.css"].map(
|
|
||||||
fileBasename => `${resources_common}/node_modules/patternfly/dist/css/${fileBasename}`
|
|
||||||
)
|
|
||||||
].join(" "),
|
|
||||||
"",
|
|
||||||
"##### css classes for form buttons",
|
|
||||||
"# main class used for all buttons",
|
|
||||||
"kcButtonClass=btn",
|
|
||||||
"# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
|
|
||||||
"kcButtonPrimaryClass=btn-primary",
|
|
||||||
"kcButtonDefaultClass=btn-default",
|
|
||||||
"# classes defining size of the button",
|
|
||||||
"kcButtonLargeClass=btn-lg",
|
|
||||||
""
|
|
||||||
].join("\n"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
@ -1,49 +1,86 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import { join as pathJoin } from "path";
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin, relative as pathRelative, dirname as pathDirname } from "path";
|
||||||
|
import type { ThemeType } from "../generateFtl";
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
import { 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";
|
||||||
import { rmSync } from "../../tools/fs.rmSync";
|
import { assert } from "tsafe/assert";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export async function downloadKeycloakStaticResources(
|
||||||
cacheDirPath: string;
|
// prettier-ignore
|
||||||
npmWorkspaceRootDirPath: string;
|
params: {
|
||||||
};
|
projectDirPath: string;
|
||||||
|
themeType: ThemeType;
|
||||||
|
themeDirPath: string;
|
||||||
|
keycloakVersion: string;
|
||||||
|
usedResources: {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} | undefined
|
||||||
|
}
|
||||||
|
) {
|
||||||
|
const { projectDirPath, themeType, themeDirPath, keycloakVersion } = params;
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
// NOTE: Hack for 427
|
||||||
|
const usedResources = (() => {
|
||||||
|
const { usedResources } = params;
|
||||||
|
|
||||||
export async function downloadKeycloakStaticResources(params: {
|
if (usedResources === undefined) {
|
||||||
themeType: ThemeType;
|
return undefined;
|
||||||
themeDirPath: string;
|
}
|
||||||
keycloakVersion: string;
|
|
||||||
buildOptions: BuildOptionsLike;
|
assert(usedResources !== undefined);
|
||||||
}) {
|
|
||||||
const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
|
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({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
||||||
"destDirPath": pathJoin(resourcesPath, resources_common)
|
"destDirPath": pathJoin(themeDirPath, pathRelative(basenameOfKeycloakDirInPublicDir, resourcesCommonDirPathRelativeToPublicDir)),
|
||||||
|
"transformSourceCode":
|
||||||
|
usedResources === undefined
|
||||||
|
? undefined
|
||||||
|
: ({ fileRelativePath, sourceCode }) => {
|
||||||
|
if (usedResources.resourcesCommonDirPaths.find(dirPath => fileRelativePath.startsWith(dirPath)) === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
rmSync(tmpDirPath, { "recursive": true, "force": true });
|
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
}
|
}
|
||||||
|
@ -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,115 +1,77 @@
|
|||||||
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, dirname as pathDirname } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
|
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 {
|
import { basenameOfKeycloakDirInPublicDir } from "../../mockTestingResourcesPath";
|
||||||
type ThemeType,
|
|
||||||
lastKeycloakVersionWithAccountV1,
|
|
||||||
keycloak_resources,
|
|
||||||
retrocompatPostfix,
|
|
||||||
accountV1ThemeName,
|
|
||||||
basenameOfTheKeycloakifyResourcesDir
|
|
||||||
} from "../../constants";
|
|
||||||
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";
|
||||||
import { generateMessageProperties } from "./generateMessageProperties";
|
import { generateMessageProperties } from "./generateMessageProperties";
|
||||||
import { bringInAccountV1 } from "./bringInAccountV1";
|
import { readStaticResourcesUsage } from "./readStaticResourcesUsage";
|
||||||
import { rmSync } from "../../tools/fs.rmSync";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
bundler: "vite" | "webpack";
|
themeName: string;
|
||||||
extraThemeProperties: string[] | undefined;
|
extraThemeProperties: string[] | undefined;
|
||||||
themeVersion: string;
|
themeVersion: string;
|
||||||
loginThemeResourcesFromKeycloakVersion: string;
|
keycloakVersionDefaultAssets: string;
|
||||||
keycloakifyBuildDirPath: string;
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
cacheDirPath: string;
|
|
||||||
assetsDirPath: string;
|
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
doBuildRetrocompatAccountTheme: boolean;
|
|
||||||
themeNames: string[];
|
|
||||||
npmWorkspaceRootDirPath: string;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
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
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
const cssGlobalsToDefine: Record<string, string> = {};
|
let allCssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
const implementedThemeTypes: Record<ThemeType | "email", boolean> = {
|
let generateFtlFilesCode_glob: ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"] | undefined = undefined;
|
||||||
"login": false,
|
|
||||||
"account": false,
|
|
||||||
"email": false
|
|
||||||
};
|
|
||||||
|
|
||||||
for (const themeType of ["login", "account"] as const) {
|
for (const themeType of themeTypes) {
|
||||||
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
implementedThemeTypes[themeType] = true;
|
const themeDirPath = getThemeDirPath(themeType);
|
||||||
|
|
||||||
const themeTypeDirPath = getThemeTypeDirPath({ themeType });
|
copy_app_resources_to_theme_path: {
|
||||||
|
const isFirstPass = themeType.indexOf(themeType) === 0;
|
||||||
|
|
||||||
apply_replacers_and_move_to_theme_resources: {
|
if (!isFirstPass) {
|
||||||
const destDirPath = pathJoin(themeTypeDirPath, "resources", basenameOfTheKeycloakifyResourcesDir);
|
break copy_app_resources_to_theme_path;
|
||||||
|
|
||||||
// NOTE: Prevent accumulation of files in the assets dir, as names are hashed they pile up.
|
|
||||||
rmSync(destDirPath, { "recursive": true, "force": true });
|
|
||||||
|
|
||||||
if (themeType === "account" && implementedThemeTypes.login) {
|
|
||||||
// NOTE: We prevend doing it twice, it has been done for the login theme.
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": pathJoin(
|
|
||||||
getThemeTypeDirPath({
|
|
||||||
"themeType": "login"
|
|
||||||
}),
|
|
||||||
"resources",
|
|
||||||
basenameOfTheKeycloakifyResourcesDir
|
|
||||||
),
|
|
||||||
destDirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
break apply_replacers_and_move_to_theme_resources;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": buildOptions.reactAppBuildDirPath,
|
"destDirPath": pathJoin(themeDirPath, "resources", "build"),
|
||||||
destDirPath,
|
"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/
|
||||||
// This should not happen if users follow the new instruction setup but we keep it for retrocompatibility.
|
|
||||||
if (
|
if (
|
||||||
isInside({
|
isInside({
|
||||||
"dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
|
"dirPath": pathJoin(reactAppBuildDirPath, basenameOfKeycloakDirInPublicDir),
|
||||||
filePath
|
filePath
|
||||||
})
|
})
|
||||||
) {
|
) {
|
||||||
@ -117,21 +79,27 @@ export async function generateTheme(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (/\.css?$/i.test(filePath)) {
|
if (/\.css?$/i.test(filePath)) {
|
||||||
const { cssGlobalsToDefine: cssGlobalsToDefineForThisFile, fixedCssCode } = replaceImportsInCssCode({
|
const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
|
||||||
"cssCode": sourceCode.toString("utf8")
|
"cssCode": sourceCode.toString("utf8")
|
||||||
});
|
});
|
||||||
|
|
||||||
Object.entries(cssGlobalsToDefineForThisFile).forEach(([key, value]) => {
|
register_css_variables: {
|
||||||
cssGlobalsToDefine[key] = value;
|
if (!isFirstPass) {
|
||||||
});
|
break register_css_variables;
|
||||||
|
}
|
||||||
|
|
||||||
|
allCssGlobalsToDefine = {
|
||||||
|
...allCssGlobalsToDefine,
|
||||||
|
...cssGlobalsToDefine
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
|
return { "modifiedSourceCode": Buffer.from(fixedCssCode, "utf8") };
|
||||||
}
|
}
|
||||||
|
|
||||||
if (/\.js?$/i.test(filePath)) {
|
if (/\.js?$/i.test(filePath)) {
|
||||||
const { fixedJsCode } = replaceImportsInJsCode({
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
||||||
"jsCode": sourceCode.toString("utf8"),
|
"jsCode": sourceCode.toString("utf8")
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
||||||
@ -142,19 +110,21 @@ export async function generateTheme(params: {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
|
const generateFtlFilesCode =
|
||||||
themeName,
|
generateFtlFilesCode_glob !== undefined
|
||||||
"indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
|
? generateFtlFilesCode_glob
|
||||||
cssGlobalsToDefine,
|
: generateFtlFilesCodeFactory({
|
||||||
buildOptions,
|
"indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
|
||||||
keycloakifyVersion,
|
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
||||||
themeType,
|
buildOptions,
|
||||||
"fieldNames": readFieldNameUsage({
|
keycloakifyVersion,
|
||||||
keycloakifySrcDirPath,
|
themeType,
|
||||||
themeSrcDirPath,
|
"fieldNames": readFieldNameUsage({
|
||||||
themeType
|
keycloakifySrcDirPath,
|
||||||
})
|
themeSrcDirPath,
|
||||||
});
|
themeType
|
||||||
|
})
|
||||||
|
}).generateFtlFilesCode;
|
||||||
|
|
||||||
[
|
[
|
||||||
...(() => {
|
...(() => {
|
||||||
@ -172,75 +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,
|
||||||
buildOptions
|
"usedResources": readStaticResourcesUsage({
|
||||||
|
keycloakifySrcDirPath,
|
||||||
|
themeSrcDirPath,
|
||||||
|
themeType
|
||||||
|
})
|
||||||
});
|
});
|
||||||
|
|
||||||
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 accountV1ThemeName;
|
|
||||||
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=${accountV1ThemeName}`, "parent=keycloak"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
email: {
|
email: {
|
||||||
@ -250,82 +220,9 @@ export async function generateTheme(params: {
|
|||||||
break email;
|
break email;
|
||||||
}
|
}
|
||||||
|
|
||||||
implementedThemeTypes.email = true;
|
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": emailThemeSrcDirPath,
|
"srcDirPath": emailThemeSrcDirPath,
|
||||||
"destDirPath": getThemeTypeDirPath({ "themeType": "email" })
|
"destDirPath": getThemeDirPath("email")
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const parsedKeycloakThemeJson: { themes: { name: string; types: string[] }[] } = { "themes": [] };
|
|
||||||
|
|
||||||
buildOptions.themeNames.forEach(themeName =>
|
|
||||||
parsedKeycloakThemeJson.themes.push({
|
|
||||||
"name": themeName,
|
|
||||||
"types": Object.entries(implementedThemeTypes)
|
|
||||||
.filter(([, isImplemented]) => isImplemented)
|
|
||||||
.map(([themeType]) => themeType)
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
account_specific_extra_work: {
|
|
||||||
if (!implementedThemeTypes.account) {
|
|
||||||
break account_specific_extra_work;
|
|
||||||
}
|
|
||||||
|
|
||||||
await bringInAccountV1({ buildOptions });
|
|
||||||
|
|
||||||
parsedKeycloakThemeJson.themes.push({
|
|
||||||
"name": accountV1ThemeName,
|
|
||||||
"types": ["account"]
|
|
||||||
});
|
|
||||||
|
|
||||||
add_retrocompat_account_theme: {
|
|
||||||
if (!buildOptions.doBuildRetrocompatAccountTheme) {
|
|
||||||
break add_retrocompat_account_theme;
|
|
||||||
}
|
|
||||||
|
|
||||||
transformCodebase({
|
|
||||||
"srcDirPath": getThemeTypeDirPath({ "themeType": "account" }),
|
|
||||||
"destDirPath": getThemeTypeDirPath({ "themeType": "account", "isRetrocompat": true }),
|
|
||||||
"transformSourceCode": ({ filePath, sourceCode }) => {
|
|
||||||
if (pathBasename(filePath) === "theme.properties") {
|
|
||||||
return {
|
|
||||||
"modifiedSourceCode": Buffer.from(
|
|
||||||
sourceCode.toString("utf8").replace(`parent=${accountV1ThemeName}`, "parent=keycloak"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "modifiedSourceCode": sourceCode };
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
buildOptions.themeNames.forEach(themeName =>
|
|
||||||
parsedKeycloakThemeJson.themes.push({
|
|
||||||
"name": `${themeName}${retrocompatPostfix}`,
|
|
||||||
"types": ["account"]
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const keycloakThemeJsonFilePath = pathJoin(
|
|
||||||
buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"src",
|
|
||||||
"main",
|
|
||||||
"resources",
|
|
||||||
"META-INF",
|
|
||||||
"keycloak-themes.json"
|
|
||||||
);
|
|
||||||
|
|
||||||
try {
|
|
||||||
fs.mkdirSync(pathDirname(keycloakThemeJsonFilePath));
|
|
||||||
} catch {}
|
|
||||||
|
|
||||||
fs.writeFileSync(keycloakThemeJsonFilePath, Buffer.from(JSON.stringify(parsedKeycloakThemeJson, null, 2), "utf8"));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
@ -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[] {
|
||||||
|
@ -0,0 +1,76 @@
|
|||||||
|
import { crawl } from "../../tools/crawl";
|
||||||
|
import { join as pathJoin, sep as pathSep } from "path";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import type { ThemeType } from "../generateFtl";
|
||||||
|
|
||||||
|
/** Assumes the theme type exists */
|
||||||
|
export function readStaticResourcesUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} {
|
||||||
|
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
|
const resourcesCommonFilePaths = new Set<string>();
|
||||||
|
|
||||||
|
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
||||||
|
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
||||||
|
|
||||||
|
for (const filePath of filePaths) {
|
||||||
|
const rawSourceFile = fs.readFileSync(filePath).toString("utf8");
|
||||||
|
|
||||||
|
if (!rawSourceFile.includes("resourcesCommonPath") && !rawSourceFile.includes("resourcesPath")) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const wrap = readPaths({ rawSourceFile });
|
||||||
|
|
||||||
|
wrap.resourcesCommonFilePaths.forEach(filePath => resourcesCommonFilePaths.add(filePath));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Exported for testing purpose */
|
||||||
|
export function readPaths(params: { rawSourceFile: string }): {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} {
|
||||||
|
const { rawSourceFile } = params;
|
||||||
|
|
||||||
|
const resourcesCommonFilePaths = new Set<string>();
|
||||||
|
|
||||||
|
{
|
||||||
|
const regexp = new RegExp(`resourcesCommonPath\\s*}([^\`]+)\``, "g");
|
||||||
|
|
||||||
|
const matches = [...rawSourceFile.matchAll(regexp)];
|
||||||
|
|
||||||
|
for (const match of matches) {
|
||||||
|
const filePath = match[1];
|
||||||
|
|
||||||
|
resourcesCommonFilePaths.add(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const regexp = new RegExp(`resourcesCommonPath\\s*[+,]\\s*["']([^"'\`]+)["'\`]`, "g");
|
||||||
|
|
||||||
|
const matches = [...rawSourceFile.matchAll(regexp)];
|
||||||
|
|
||||||
|
for (const match of matches) {
|
||||||
|
const filePath = match[1];
|
||||||
|
|
||||||
|
resourcesCommonFilePaths.add(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const normalizePath = (filePath: string) => {
|
||||||
|
filePath = filePath.startsWith("/") ? filePath.slice(1) : filePath;
|
||||||
|
filePath = filePath.replace(/\//g, pathSep);
|
||||||
|
return filePath;
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths).map(normalizePath)
|
||||||
|
};
|
||||||
|
}
|
@ -1,125 +1,163 @@
|
|||||||
import { generateTheme } from "./generateTheme";
|
import { generateTheme } from "./generateTheme";
|
||||||
import { generatePom } from "./generatePom";
|
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 { getThemeSrcDirPath } from "../getThemeSrcDirPath";
|
import jar from "../tools/jar";
|
||||||
import { getThisCodebaseRootDirPath } from "../tools/getThisCodebaseRootDirPath";
|
import { assert } from "tsafe/assert";
|
||||||
import { readThisNpmProjectVersion } from "../tools/readThisNpmProjectVersion";
|
import { Equals } from "tsafe";
|
||||||
import { keycloakifyBuildOptionsForPostPostBuildScriptEnvName } from "../constants";
|
import { getThemeSrcDirPath } from "../getSrcDirPath";
|
||||||
|
import { getProjectRoot } from "../tools/getProjectRoot";
|
||||||
|
import { objectKeys } from "tsafe/objectKeys";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
|
const projectDirPath = process.cwd();
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
|
projectDirPath,
|
||||||
"processArgv": process.argv.slice(2)
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
logger.log("🔏 Building the keycloak theme...⌚");
|
logger.log("🔏 Building the keycloak theme...⌚");
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ "reactAppRootDirPath": buildOptions.reactAppRootDirPath });
|
const keycloakifyDirPath = getProjectRoot();
|
||||||
|
|
||||||
for (const themeName of buildOptions.themeNames) {
|
const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
|
||||||
|
|
||||||
|
for (const themeName of [buildOptions.themeName, ...buildOptions.extraThemeNames]) {
|
||||||
await generateTheme({
|
await generateTheme({
|
||||||
themeName,
|
projectDirPath,
|
||||||
|
"keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
themeSrcDirPath,
|
themeSrcDirPath,
|
||||||
"keycloakifySrcDirPath": pathJoin(getThisCodebaseRootDirPath(), "src"),
|
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
||||||
"keycloakifyVersion": readThisNpmProjectVersion(),
|
"reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
|
||||||
buildOptions
|
"buildOptions": {
|
||||||
|
...buildOptions,
|
||||||
|
"themeName": themeName
|
||||||
|
},
|
||||||
|
"keycloakifyVersion": (() => {
|
||||||
|
const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
|
||||||
|
|
||||||
|
assert(typeof version === "string");
|
||||||
|
|
||||||
|
return version;
|
||||||
|
})()
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
const { jarFilePath } = generateJavaStackFiles({
|
||||||
const { pomFileCode } = generatePom({ buildOptions });
|
"keycloakThemeBuildingDirPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
|
"implementedThemeTypes": (() => {
|
||||||
|
const implementedThemeTypes = {
|
||||||
|
"login": false,
|
||||||
|
"account": false,
|
||||||
|
"email": false
|
||||||
|
};
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
|
for (const themeType of objectKeys(implementedThemeTypes)) {
|
||||||
}
|
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
implementedThemeTypes[themeType] = true;
|
||||||
|
}
|
||||||
|
|
||||||
const containerKeycloakVersion = "23.0.6";
|
return implementedThemeTypes;
|
||||||
|
})(),
|
||||||
const jarFilePath = pathJoin(buildOptions.keycloakifyBuildDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`);
|
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer({
|
|
||||||
"keycloakVersion": containerKeycloakVersion,
|
|
||||||
jarFilePath,
|
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, ".gitignore"), Buffer.from("*", "utf8"));
|
switch (buildOptions.bundler) {
|
||||||
|
case "none":
|
||||||
run_post_build_script: {
|
logger.log("😱 Skipping bundling step, there will be no jar");
|
||||||
if (buildOptions.bundler !== "vite") {
|
break;
|
||||||
break run_post_build_script;
|
case "keycloakify":
|
||||||
}
|
logger.log("🫶 Let keycloakify do its thang");
|
||||||
|
await jar({
|
||||||
child_process.execSync("npx vite", {
|
"rootPath": buildOptions.keycloakifyBuildDirPath,
|
||||||
"cwd": buildOptions.reactAppRootDirPath,
|
"version": buildOptions.themeVersion,
|
||||||
"env": {
|
"groupId": buildOptions.groupId,
|
||||||
...process.env,
|
"artifactId": buildOptions.artifactId,
|
||||||
[keycloakifyBuildOptionsForPostPostBuildScriptEnvName]: JSON.stringify(buildOptions)
|
"targetPath": jarFilePath
|
||||||
}
|
});
|
||||||
});
|
break;
|
||||||
|
case "mvn":
|
||||||
|
logger.log("🫙 Run maven to deliver a jar");
|
||||||
|
child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
assert<Equals<typeof buildOptions.bundler, never>>(false);
|
||||||
}
|
}
|
||||||
|
|
||||||
create_jar: {
|
// We want, however, to test in a container running the latest Keycloak version
|
||||||
if (!buildOptions.doCreateJar) {
|
const containerKeycloakVersion = "21.1.2";
|
||||||
break create_jar;
|
|
||||||
}
|
|
||||||
|
|
||||||
child_process.execSync("mvn clean install", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
generateStartKeycloakTestingContainer({
|
||||||
|
keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
|
||||||
const jarDirPath = pathDirname(jarFilePath);
|
"keycloakVersion": containerKeycloakVersion,
|
||||||
const retrocompatJarFilePath = pathJoin(jarDirPath, "retrocompat-" + pathBasename(jarFilePath));
|
buildOptions
|
||||||
|
});
|
||||||
fs.renameSync(pathJoin(jarDirPath, "original-" + pathBasename(jarFilePath)), retrocompatJarFilePath);
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(jarDirPath, "README.md"),
|
|
||||||
Buffer.from(
|
|
||||||
[
|
|
||||||
`- The ${jarFilePath} is to be used in Keycloak 23 and up. `,
|
|
||||||
`- The ${retrocompatJarFilePath} is to be used in Keycloak 22 and below.`,
|
|
||||||
` Note that Keycloak 22 is only supported for login and email theme but not for account themes. `
|
|
||||||
].join("\n"),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
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(
|
//TODO: Restore when we find a good Helm chart for Keycloak.
|
||||||
buildOptions.reactAppRootDirPath,
|
//"Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:",
|
||||||
jarFilePath
|
"",
|
||||||
)} 🚀`
|
"value.yaml: ",
|
||||||
]),
|
" extraInitContainers: |",
|
||||||
|
" - name: realm-ext-provider",
|
||||||
|
" image: curlimages/curl",
|
||||||
|
" imagePullPolicy: IfNotPresent",
|
||||||
|
" command:",
|
||||||
|
" - sh",
|
||||||
|
" args:",
|
||||||
|
" - -c",
|
||||||
|
` - curl -L -f -S -o /extensions/${pathBasename(jarFilePath)} https://AN.URL.FOR/${pathBasename(jarFilePath)}`,
|
||||||
|
" volumeMounts:",
|
||||||
|
" - name: extensions",
|
||||||
|
" mountPath: /extensions",
|
||||||
|
" ",
|
||||||
|
" extraVolumeMounts: |",
|
||||||
|
" - name: extensions",
|
||||||
|
" mountPath: /opt/keycloak/providers",
|
||||||
|
" extraEnv: |",
|
||||||
|
" - name: KEYCLOAK_USER",
|
||||||
|
" value: admin",
|
||||||
|
" - name: KEYCLOAK_PASSWORD",
|
||||||
|
" value: xxxxxxxxx",
|
||||||
|
" - name: JAVA_OPTS",
|
||||||
|
" value: -Dkeycloak.profile=preview",
|
||||||
|
"",
|
||||||
"",
|
"",
|
||||||
`To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
|
`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(
|
||||||
buildOptions.reactAppRootDirPath,
|
projectDirPath,
|
||||||
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
||||||
)} 👈`,
|
)} 👈`,
|
||||||
|
"",
|
||||||
|
`Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags`,
|
||||||
``,
|
``,
|
||||||
`Once your container is up and running: `,
|
`Once your container is up and running: `,
|
||||||
"- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
|
"- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
|
||||||
`- 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`,
|
||||||
|
57
src/bin/keycloakify/parsedPackageJson.ts
Normal file
57
src/bin/keycloakify/parsedPackageJson.ts
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { assert } from "tsafe";
|
||||||
|
import type { Equals } from "tsafe";
|
||||||
|
import { z } from "zod";
|
||||||
|
import { pathJoin } from "../tools/pathJoin";
|
||||||
|
|
||||||
|
export const bundlers = ["mvn", "keycloakify", "none"] as const;
|
||||||
|
export type Bundler = (typeof bundlers)[number];
|
||||||
|
export type ParsedPackageJson = {
|
||||||
|
name: string;
|
||||||
|
version?: string;
|
||||||
|
homepage?: string;
|
||||||
|
keycloakify?: {
|
||||||
|
extraThemeProperties?: string[];
|
||||||
|
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
||||||
|
artifactId?: string;
|
||||||
|
groupId?: string;
|
||||||
|
bundler?: Bundler;
|
||||||
|
keycloakVersionDefaultAssets?: string;
|
||||||
|
reactAppBuildDirPath?: string;
|
||||||
|
keycloakifyBuildDirPath?: string;
|
||||||
|
themeName?: string;
|
||||||
|
extraThemeNames?: string[];
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export const zParsedPackageJson = z.object({
|
||||||
|
"name": z.string(),
|
||||||
|
"version": z.string().optional(),
|
||||||
|
"homepage": z.string().optional(),
|
||||||
|
"keycloakify": z
|
||||||
|
.object({
|
||||||
|
"extraThemeProperties": z.array(z.string()).optional(),
|
||||||
|
"areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
|
||||||
|
"artifactId": z.string().optional(),
|
||||||
|
"groupId": z.string().optional(),
|
||||||
|
"bundler": z.enum(bundlers).optional(),
|
||||||
|
"keycloakVersionDefaultAssets": z.string().optional(),
|
||||||
|
"reactAppBuildDirPath": z.string().optional(),
|
||||||
|
"keycloakifyBuildDirPath": z.string().optional(),
|
||||||
|
"themeName": z.string().optional(),
|
||||||
|
"extraThemeNames": z.array(z.string()).optional()
|
||||||
|
})
|
||||||
|
.optional()
|
||||||
|
});
|
||||||
|
|
||||||
|
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
||||||
|
|
||||||
|
let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
|
||||||
|
export function getParsedPackageJson(params: { projectDirPath: string }) {
|
||||||
|
const { projectDirPath } = params;
|
||||||
|
if (parsedPackageJson) {
|
||||||
|
return parsedPackageJson;
|
||||||
|
}
|
||||||
|
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")));
|
||||||
|
return parsedPackageJson;
|
||||||
|
}
|
@ -0,0 +1,51 @@
|
|||||||
|
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
||||||
|
|
||||||
|
export function replaceImportsFromStaticInJsCode(params: { jsCode: string }): { fixedJsCode: string } {
|
||||||
|
/*
|
||||||
|
NOTE:
|
||||||
|
|
||||||
|
When we have urlOrigin defined it means that
|
||||||
|
we are building with --external-assets
|
||||||
|
so we have to make sur that the fixed js code will run
|
||||||
|
inside and outside keycloak.
|
||||||
|
|
||||||
|
When urlOrigin isn't defined we can assume the fixedJsCode
|
||||||
|
will always run in keycloak context.
|
||||||
|
*/
|
||||||
|
|
||||||
|
const { jsCode } = params;
|
||||||
|
|
||||||
|
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
||||||
|
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=(function\\(([a-z]+)\\){return|([a-z]+)=>)"static\\/${language}\\/"`, "g"),
|
||||||
|
(...[, n, u, matchedFunction, eForFunction]) => {
|
||||||
|
const isArrowFunction = matchedFunction.includes("=>");
|
||||||
|
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
||||||
|
|
||||||
|
return `
|
||||||
|
${n}[(function(){
|
||||||
|
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
||||||
|
if( pd === undefined || pd.configurable ){
|
||||||
|
Object.defineProperty(${n}, "p", {
|
||||||
|
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
||||||
|
set: function() {}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return "${u}";
|
||||||
|
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/build/static/${language}/"`
|
||||||
|
.replace(/\s+/g, " ")
|
||||||
|
.trim();
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
const fixedJsCode = jsCode
|
||||||
|
.replace(...getReplaceArgs("js"))
|
||||||
|
.replace(...getReplaceArgs("css"))
|
||||||
|
.replace(/[a-zA-Z]+\.[a-zA-Z]+\+"static\//g, `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`)
|
||||||
|
//TODO: Write a test case for this
|
||||||
|
.replace(
|
||||||
|
/".chunk.css",([a-zA-Z])+=[a-zA-Z]+\.[a-zA-Z]+\+([a-zA-Z]+),/,
|
||||||
|
(...[, group1, group2]) => `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group2},`
|
||||||
|
);
|
||||||
|
|
||||||
|
return { fixedJsCode };
|
||||||
|
}
|
@ -1,7 +1,6 @@
|
|||||||
import * as crypto from "crypto";
|
import * as crypto from "crypto";
|
||||||
import type { BuildOptions } from "../buildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { basenameOfTheKeycloakifyResourcesDir } from "../../constants";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
@ -17,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)
|
||||||
);
|
);
|
||||||
|
|
||||||
@ -46,7 +45,7 @@ export function generateCssCodeToDefineGlobals(params: { cssGlobalsToDefine: Rec
|
|||||||
`--${cssVariableName}:`,
|
`--${cssVariableName}:`,
|
||||||
cssGlobalsToDefine[cssVariableName].replace(
|
cssGlobalsToDefine[cssVariableName].replace(
|
||||||
new RegExp(`url\\(${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`, "g"),
|
new RegExp(`url\\(${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`, "g"),
|
||||||
`url(\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/`
|
"url(${url.resourcesPath}/build/"
|
||||||
)
|
)
|
||||||
].join(" ")
|
].join(" ")
|
||||||
)
|
)
|
||||||
|
@ -1,6 +1,5 @@
|
|||||||
import type { BuildOptions } from "../buildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { basenameOfTheKeycloakifyResourcesDir } from "../../constants";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
@ -17,7 +16,7 @@ export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOp
|
|||||||
buildOptions.urlPathname === undefined
|
buildOptions.urlPathname === undefined
|
||||||
? /url\(["']?\/([^/][^)"']+)["']?\)/g
|
? /url\(["']?\/([^/][^)"']+)["']?\)/g
|
||||||
: new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
|
: new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
|
||||||
(...[, group]) => `url(\${url.resourcesPath}/${basenameOfTheKeycloakifyResourcesDir}/${group})`
|
(...[, group]) => `url(\${url.resourcesPath}/build/${group})`
|
||||||
);
|
);
|
||||||
|
|
||||||
return { fixedCssCode };
|
return { fixedCssCode };
|
||||||
|
@ -1 +0,0 @@
|
|||||||
export * from "./replaceImportsInJsCode";
|
|
@ -1,66 +0,0 @@
|
|||||||
import { assert } from "tsafe/assert";
|
|
||||||
import type { BuildOptions } from "../../buildOptions";
|
|
||||||
import { replaceImportsInJsCode_vite } from "./vite";
|
|
||||||
import { replaceImportsInJsCode_webpack } from "./webpack";
|
|
||||||
import * as fs from "fs";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
assetsDirPath: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
bundler: "vite" | "webpack";
|
|
||||||
};
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
|
|
||||||
export function replaceImportsInJsCode(params: { jsCode: string; buildOptions: BuildOptionsLike }) {
|
|
||||||
const { jsCode, buildOptions } = params;
|
|
||||||
|
|
||||||
const { fixedJsCode } = (() => {
|
|
||||||
switch (buildOptions.bundler) {
|
|
||||||
case "vite":
|
|
||||||
return replaceImportsInJsCode_vite({
|
|
||||||
jsCode,
|
|
||||||
buildOptions,
|
|
||||||
"basenameOfAssetsFiles": readAssetsDirSync({
|
|
||||||
"assetsDirPath": params.buildOptions.assetsDirPath
|
|
||||||
})
|
|
||||||
});
|
|
||||||
case "webpack":
|
|
||||||
return replaceImportsInJsCode_webpack({
|
|
||||||
jsCode,
|
|
||||||
buildOptions
|
|
||||||
});
|
|
||||||
}
|
|
||||||
})();
|
|
||||||
|
|
||||||
return { fixedJsCode };
|
|
||||||
}
|
|
||||||
|
|
||||||
const { readAssetsDirSync } = (() => {
|
|
||||||
let cache:
|
|
||||||
| {
|
|
||||||
assetsDirPath: string;
|
|
||||||
basenameOfAssetsFiles: string[];
|
|
||||||
}
|
|
||||||
| undefined = undefined;
|
|
||||||
|
|
||||||
function readAssetsDirSync(params: { assetsDirPath: string }): string[] {
|
|
||||||
const { assetsDirPath } = params;
|
|
||||||
|
|
||||||
if (cache !== undefined && cache.assetsDirPath === assetsDirPath) {
|
|
||||||
return cache.basenameOfAssetsFiles;
|
|
||||||
}
|
|
||||||
|
|
||||||
const basenameOfAssetsFiles = fs.readdirSync(assetsDirPath);
|
|
||||||
|
|
||||||
cache = {
|
|
||||||
assetsDirPath,
|
|
||||||
basenameOfAssetsFiles
|
|
||||||
};
|
|
||||||
|
|
||||||
return basenameOfAssetsFiles;
|
|
||||||
}
|
|
||||||
|
|
||||||
return { readAssetsDirSync };
|
|
||||||
})();
|
|
@ -1,85 +0,0 @@
|
|||||||
import { nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "../../../constants";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import type { BuildOptions } from "../../buildOptions";
|
|
||||||
import * as nodePath from "path";
|
|
||||||
import { replaceAll } from "../../../tools/String.prototype.replaceAll";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
assetsDirPath: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
|
|
||||||
export function replaceImportsInJsCode_vite(params: {
|
|
||||||
jsCode: string;
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
basenameOfAssetsFiles: string[];
|
|
||||||
systemType?: "posix" | "win32";
|
|
||||||
}): {
|
|
||||||
fixedJsCode: string;
|
|
||||||
} {
|
|
||||||
const { jsCode, buildOptions, basenameOfAssetsFiles, systemType = nodePath.sep === "/" ? "posix" : "win32" } = params;
|
|
||||||
|
|
||||||
const { relative: pathRelative, sep: pathSep } = nodePath[systemType];
|
|
||||||
|
|
||||||
let fixedJsCode = jsCode;
|
|
||||||
|
|
||||||
replace_base_javacript_import: {
|
|
||||||
if (buildOptions.urlPathname === undefined) {
|
|
||||||
break replace_base_javacript_import;
|
|
||||||
}
|
|
||||||
// Optimization
|
|
||||||
if (!jsCode.includes(buildOptions.urlPathname)) {
|
|
||||||
break replace_base_javacript_import;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Replace `Hv=function(e){return"/abcde12345/"+e}` by `Hv=function(e){return"/"+e}`
|
|
||||||
fixedJsCode = fixedJsCode.replace(
|
|
||||||
new RegExp(
|
|
||||||
`([\\w\\$][\\w\\d\\$]*)=function\\(([\\w\\$][\\w\\d\\$]*)\\)\\{return"${replaceAll(buildOptions.urlPathname, "/", "\\/")}"\\+\\2\\}`,
|
|
||||||
"g"
|
|
||||||
),
|
|
||||||
(...[, funcName, paramName]) => `${funcName}=function(${paramName}){return"/"+${paramName}}`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
replace_javascript_relatives_import_paths: {
|
|
||||||
// Example: "assets/ or "foo/bar/"
|
|
||||||
const staticDir = (() => {
|
|
||||||
let out = pathRelative(buildOptions.reactAppBuildDirPath, buildOptions.assetsDirPath);
|
|
||||||
|
|
||||||
out = replaceAll(out, pathSep, "/") + "/";
|
|
||||||
|
|
||||||
if (out === "/") {
|
|
||||||
throw new Error(`The assetsDirPath must be a subdirectory of reactAppBuildDirPath`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return out;
|
|
||||||
})();
|
|
||||||
|
|
||||||
// Optimization
|
|
||||||
if (!jsCode.includes(staticDir)) {
|
|
||||||
break replace_javascript_relatives_import_paths;
|
|
||||||
}
|
|
||||||
|
|
||||||
basenameOfAssetsFiles
|
|
||||||
.map(basenameOfAssetsFile => `${staticDir}${basenameOfAssetsFile}`)
|
|
||||||
.forEach(relativePathOfAssetFile => {
|
|
||||||
fixedJsCode = replaceAll(
|
|
||||||
fixedJsCode,
|
|
||||||
`"${relativePathOfAssetFile}"`,
|
|
||||||
`(window.${nameOfTheGlobal}.url.resourcesPath.substring(1) + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
|
|
||||||
);
|
|
||||||
|
|
||||||
fixedJsCode = replaceAll(
|
|
||||||
fixedJsCode,
|
|
||||||
`"${buildOptions.urlPathname ?? "/"}${relativePathOfAssetFile}"`,
|
|
||||||
`(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${relativePathOfAssetFile}")`
|
|
||||||
);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return { fixedJsCode };
|
|
||||||
}
|
|
@ -1,76 +0,0 @@
|
|||||||
import { nameOfTheGlobal, basenameOfTheKeycloakifyResourcesDir } from "../../../constants";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import type { BuildOptions } from "../../buildOptions";
|
|
||||||
import * as nodePath from "path";
|
|
||||||
import { replaceAll } from "../../../tools/String.prototype.replaceAll";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
reactAppBuildDirPath: string;
|
|
||||||
assetsDirPath: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
|
|
||||||
export function replaceImportsInJsCode_webpack(params: { jsCode: string; buildOptions: BuildOptionsLike; systemType?: "posix" | "win32" }): {
|
|
||||||
fixedJsCode: string;
|
|
||||||
} {
|
|
||||||
const { jsCode, buildOptions, systemType = nodePath.sep === "/" ? "posix" : "win32" } = params;
|
|
||||||
|
|
||||||
const { relative: pathRelative, sep: pathSep } = nodePath[systemType];
|
|
||||||
|
|
||||||
let fixedJsCode = jsCode;
|
|
||||||
|
|
||||||
if (buildOptions.urlPathname !== undefined) {
|
|
||||||
// "__esModule",{value:!0})},n.p="/foo-bar/",function(){if("undefined" -> ... n.p="/" ...
|
|
||||||
fixedJsCode = fixedJsCode.replace(
|
|
||||||
new RegExp(`,([a-zA-Z]\\.[a-zA-Z])="${replaceAll(buildOptions.urlPathname, "/", "\\/")}",`, "g"),
|
|
||||||
(...[, assignTo]) => `,${assignTo}="/",`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Example: "static/ or "foo/bar/"
|
|
||||||
const staticDir = (() => {
|
|
||||||
let out = pathRelative(buildOptions.reactAppBuildDirPath, buildOptions.assetsDirPath);
|
|
||||||
|
|
||||||
out = replaceAll(out, pathSep, "/") + "/";
|
|
||||||
|
|
||||||
if (out === "/") {
|
|
||||||
throw new Error(`The assetsDirPath must be a subdirectory of reactAppBuildDirPath`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return out;
|
|
||||||
})();
|
|
||||||
|
|
||||||
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
|
||||||
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=(function\\(([a-z]+)\\){return|([a-z]+)=>)"${staticDir.replace(/\//g, "\\/")}${language}\\/"`, "g"),
|
|
||||||
(...[, n, u, matchedFunction, eForFunction]) => {
|
|
||||||
const isArrowFunction = matchedFunction.includes("=>");
|
|
||||||
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
|
||||||
|
|
||||||
return `
|
|
||||||
${n}[(function(){
|
|
||||||
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
|
||||||
if( pd === undefined || pd.configurable ){
|
|
||||||
Object.defineProperty(${n}, "p", {
|
|
||||||
get: function() { return window.${nameOfTheGlobal}.url.resourcesPath; },
|
|
||||||
set: function() {}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return "${u}";
|
|
||||||
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/${basenameOfTheKeycloakifyResourcesDir}/${staticDir}${language}/"`
|
|
||||||
.replace(/\s+/g, " ")
|
|
||||||
.trim();
|
|
||||||
}
|
|
||||||
];
|
|
||||||
|
|
||||||
fixedJsCode = fixedJsCode
|
|
||||||
.replace(...getReplaceArgs("js"))
|
|
||||||
.replace(...getReplaceArgs("css"))
|
|
||||||
.replace(
|
|
||||||
new RegExp(`[a-zA-Z]+\\.[a-zA-Z]+\\+"${staticDir.replace(/\//g, "\\/")}`, "g"),
|
|
||||||
`window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/${staticDir}`
|
|
||||||
);
|
|
||||||
|
|
||||||
return { fixedJsCode };
|
|
||||||
}
|
|
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 } = (() => {
|
||||||
@ -23,10 +22,10 @@ export async function promptKeycloakVersion() {
|
|||||||
const tags = [
|
const tags = [
|
||||||
...(await getLatestsSemVersionedTag({
|
...(await getLatestsSemVersionedTag({
|
||||||
"count": 10,
|
"count": 10,
|
||||||
|
"doIgnoreBeta": true,
|
||||||
"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"
|
||||||
];
|
];
|
||||||
|
|
||||||
|
73
src/bin/tools/NpmModuleVersion.ts
Normal file
73
src/bin/tools/NpmModuleVersion.ts
Normal file
@ -0,0 +1,73 @@
|
|||||||
|
export type NpmModuleVersion = {
|
||||||
|
major: number;
|
||||||
|
minor: number;
|
||||||
|
patch: number;
|
||||||
|
betaPreRelease?: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
export namespace NpmModuleVersion {
|
||||||
|
export function parse(versionStr: string): NpmModuleVersion {
|
||||||
|
const match = versionStr.match(/^([0-9]+)\.([0-9]+)\.([0-9]+)(?:-beta.([0-9]+))?/);
|
||||||
|
|
||||||
|
if (!match) {
|
||||||
|
throw new Error(`${versionStr} is not a valid NPM version`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"major": parseInt(match[1]),
|
||||||
|
"minor": parseInt(match[2]),
|
||||||
|
"patch": parseInt(match[3]),
|
||||||
|
...(() => {
|
||||||
|
const str = match[4];
|
||||||
|
return str === undefined ? {} : { "betaPreRelease": parseInt(str) };
|
||||||
|
})()
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function stringify(v: NpmModuleVersion) {
|
||||||
|
return `${v.major}.${v.minor}.${v.patch}${v.betaPreRelease === undefined ? "" : `-beta.${v.betaPreRelease}`}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* v1 < v2 => -1
|
||||||
|
* v1 === v2 => 0
|
||||||
|
* v1 > v2 => 1
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
export function compare(v1: NpmModuleVersion, v2: NpmModuleVersion): -1 | 0 | 1 {
|
||||||
|
const sign = (diff: number): -1 | 0 | 1 => (diff === 0 ? 0 : diff < 0 ? -1 : 1);
|
||||||
|
const noUndefined = (n: number | undefined) => n ?? Infinity;
|
||||||
|
|
||||||
|
for (const level of ["major", "minor", "patch", "betaPreRelease"] as const) {
|
||||||
|
if (noUndefined(v1[level]) !== noUndefined(v2[level])) {
|
||||||
|
return sign(noUndefined(v1[level]) - noUndefined(v2[level]));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
console.log(compare(parse("3.0.0-beta.3"), parse("3.0.0")) === -1 )
|
||||||
|
console.log(compare(parse("3.0.0-beta.3"), parse("3.0.0-beta.4")) === -1 )
|
||||||
|
console.log(compare(parse("3.0.0-beta.3"), parse("4.0.0")) === -1 )
|
||||||
|
*/
|
||||||
|
|
||||||
|
export function bumpType(params: { versionBehindStr: string; versionAheadStr: string }): "major" | "minor" | "patch" | "betaPreRelease" | "same" {
|
||||||
|
const versionAhead = parse(params.versionAheadStr);
|
||||||
|
const versionBehind = parse(params.versionBehindStr);
|
||||||
|
|
||||||
|
if (compare(versionBehind, versionAhead) === 1) {
|
||||||
|
throw new Error(`Version regression ${versionBehind} -> ${versionAhead}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const level of ["major", "minor", "patch", "betaPreRelease"] as const) {
|
||||||
|
if (versionBehind[level] !== versionAhead[level]) {
|
||||||
|
return level;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "same";
|
||||||
|
}
|
||||||
|
}
|
@ -1,12 +0,0 @@
|
|||||||
type PropertiesThatCanBeUndefined<T extends Record<string, unknown>> = {
|
|
||||||
[Key in keyof T]: undefined extends T[Key] ? Key : never;
|
|
||||||
}[keyof T];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* OptionalIfCanBeUndefined<{ p1: string | undefined; p2: string; }>
|
|
||||||
* is
|
|
||||||
* { p1?: string | undefined; p2: string }
|
|
||||||
*/
|
|
||||||
export type OptionalIfCanBeUndefined<T extends Record<string, unknown>> = {
|
|
||||||
[K in PropertiesThatCanBeUndefined<T>]?: T[K];
|
|
||||||
} & { [K in Exclude<keyof T, PropertiesThatCanBeUndefined<T>>]: T[K] };
|
|
@ -1,99 +0,0 @@
|
|||||||
export type SemVer = {
|
|
||||||
major: number;
|
|
||||||
minor: number;
|
|
||||||
patch: number;
|
|
||||||
rc?: number;
|
|
||||||
parsedFrom: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export namespace SemVer {
|
|
||||||
const bumpTypes = ["major", "minor", "patch", "rc", "no bump"] as const;
|
|
||||||
|
|
||||||
export type BumpType = (typeof bumpTypes)[number];
|
|
||||||
|
|
||||||
export function parse(versionStr: string): SemVer {
|
|
||||||
const match = versionStr.match(/^v?([0-9]+)\.([0-9]+)(?:\.([0-9]+))?(?:-rc.([0-9]+))?$/);
|
|
||||||
|
|
||||||
if (!match) {
|
|
||||||
throw new Error(`${versionStr} is not a valid semantic version`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const semVer: Omit<SemVer, "parsedFrom"> = {
|
|
||||||
"major": parseInt(match[1]),
|
|
||||||
"minor": parseInt(match[2]),
|
|
||||||
"patch": (() => {
|
|
||||||
const str = match[3];
|
|
||||||
|
|
||||||
return str === undefined ? 0 : parseInt(str);
|
|
||||||
})(),
|
|
||||||
...(() => {
|
|
||||||
const str = match[4];
|
|
||||||
return str === undefined ? {} : { "rc": parseInt(str) };
|
|
||||||
})()
|
|
||||||
};
|
|
||||||
|
|
||||||
const initialStr = stringify(semVer);
|
|
||||||
|
|
||||||
Object.defineProperty(semVer, "parsedFrom", {
|
|
||||||
"enumerable": true,
|
|
||||||
"get": function () {
|
|
||||||
const currentStr = stringify(this);
|
|
||||||
|
|
||||||
if (currentStr !== initialStr) {
|
|
||||||
throw new Error(`SemVer.parsedFrom can't be read anymore, the version have been modified from ${initialStr} to ${currentStr}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
return versionStr;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return semVer as any;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function stringify(v: Omit<SemVer, "parsedFrom">): string {
|
|
||||||
return `${v.major}.${v.minor}.${v.patch}${v.rc === undefined ? "" : `-rc.${v.rc}`}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
* v1 < v2 => -1
|
|
||||||
* v1 === v2 => 0
|
|
||||||
* v1 > v2 => 1
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
export function compare(v1: SemVer, v2: SemVer): -1 | 0 | 1 {
|
|
||||||
const sign = (diff: number): -1 | 0 | 1 => (diff === 0 ? 0 : diff < 0 ? -1 : 1);
|
|
||||||
const noUndefined = (n: number | undefined) => n ?? Infinity;
|
|
||||||
|
|
||||||
for (const level of ["major", "minor", "patch", "rc"] as const) {
|
|
||||||
if (noUndefined(v1[level]) !== noUndefined(v2[level])) {
|
|
||||||
return sign(noUndefined(v1[level]) - noUndefined(v2[level]));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
console.log(compare(parse("3.0.0-rc.3"), parse("3.0.0")) === -1 )
|
|
||||||
console.log(compare(parse("3.0.0-rc.3"), parse("3.0.0-rc.4")) === -1 )
|
|
||||||
console.log(compare(parse("3.0.0-rc.3"), parse("4.0.0")) === -1 )
|
|
||||||
*/
|
|
||||||
|
|
||||||
export function bumpType(params: { versionBehind: string | SemVer; versionAhead: string | SemVer }): BumpType | "no bump" {
|
|
||||||
const versionAhead = typeof params.versionAhead === "string" ? parse(params.versionAhead) : params.versionAhead;
|
|
||||||
const versionBehind = typeof params.versionBehind === "string" ? parse(params.versionBehind) : params.versionBehind;
|
|
||||||
|
|
||||||
if (compare(versionBehind, versionAhead) === 1) {
|
|
||||||
throw new Error(`Version regression ${stringify(versionBehind)} -> ${stringify(versionAhead)}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
for (const level of ["major", "minor", "patch", "rc"] as const) {
|
|
||||||
if (versionBehind[level] !== versionAhead[level]) {
|
|
||||||
return level;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return "no bump";
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,30 +0,0 @@
|
|||||||
export function replaceAll(string: string, searchValue: string | RegExp, replaceValue: string): string {
|
|
||||||
if ((string as any).replaceAll !== undefined) {
|
|
||||||
return (string as any).replaceAll(searchValue, replaceValue);
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the searchValue is a string
|
|
||||||
if (typeof searchValue === "string") {
|
|
||||||
// Escape special characters in the string to be used in a regex
|
|
||||||
var escapedSearchValue = searchValue.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
|
||||||
var regex = new RegExp(escapedSearchValue, "g");
|
|
||||||
|
|
||||||
return string.replace(regex, replaceValue);
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the searchValue is a global RegExp, use it directly
|
|
||||||
if (searchValue instanceof RegExp && searchValue.global) {
|
|
||||||
return string.replace(searchValue, replaceValue);
|
|
||||||
}
|
|
||||||
|
|
||||||
// If the searchValue is a non-global RegExp, throw an error
|
|
||||||
if (searchValue instanceof RegExp) {
|
|
||||||
throw new TypeError("replaceAll must be called with a global RegExp");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert searchValue to string if it's not a string or RegExp
|
|
||||||
var searchString = String(searchValue);
|
|
||||||
var regexFromString = new RegExp(searchString.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"), "g");
|
|
||||||
|
|
||||||
return string.replace(regexFromString, replaceValue);
|
|
||||||
}
|
|
@ -1,17 +1,17 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import * as path from "path";
|
||||||
|
|
||||||
const crawlRec = (dirPath: string, filePaths: string[]) => {
|
const crawlRec = (dir_path: string, paths: string[]) => {
|
||||||
for (const basename of fs.readdirSync(dirPath)) {
|
for (const file_name of fs.readdirSync(dir_path)) {
|
||||||
const fileOrDirPath = pathJoin(dirPath, basename);
|
const file_path = path.join(dir_path, file_name);
|
||||||
|
|
||||||
if (fs.lstatSync(fileOrDirPath).isDirectory()) {
|
if (fs.lstatSync(file_path).isDirectory()) {
|
||||||
crawlRec(fileOrDirPath, filePaths);
|
crawlRec(file_path, paths);
|
||||||
|
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
filePaths.push(fileOrDirPath);
|
paths.push(file_path);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -27,6 +27,6 @@ export function crawl(params: { dirPath: string; returnedPathsType: "absolute" |
|
|||||||
case "absolute":
|
case "absolute":
|
||||||
return filePaths;
|
return filePaths;
|
||||||
case "relative to dirPath":
|
case "relative to dirPath":
|
||||||
return filePaths.map(filePath => pathRelative(dirPath, filePath));
|
return filePaths.map(filePath => path.relative(dirPath, filePath));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
233
src/bin/tools/downloadAndUnzip.ts
Normal file
233
src/bin/tools/downloadAndUnzip.ts
Normal file
@ -0,0 +1,233 @@
|
|||||||
|
import { exec as execCallback } from "child_process";
|
||||||
|
import { createHash } from "crypto";
|
||||||
|
import { mkdir, readFile, stat, writeFile, unlink, rm } from "fs/promises";
|
||||||
|
import fetch, { type FetchOptions } from "make-fetch-happen";
|
||||||
|
import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { promisify } from "util";
|
||||||
|
import { transformCodebase } from "./transformCodebase";
|
||||||
|
import { unzip, zip } from "./unzip";
|
||||||
|
|
||||||
|
const exec = promisify(execCallback);
|
||||||
|
|
||||||
|
function generateFileNameFromURL(params: {
|
||||||
|
url: string;
|
||||||
|
preCacheTransform:
|
||||||
|
| {
|
||||||
|
actionCacheId: string;
|
||||||
|
actionFootprint: string;
|
||||||
|
}
|
||||||
|
| undefined;
|
||||||
|
}): string {
|
||||||
|
const { preCacheTransform } = params;
|
||||||
|
|
||||||
|
// Parse the URL
|
||||||
|
const url = new URL(params.url);
|
||||||
|
|
||||||
|
// Extract pathname and remove leading slashes
|
||||||
|
let fileName = url.pathname.replace(/^\//, "").replace(/\//g, "_");
|
||||||
|
|
||||||
|
// Optionally, add query parameters replacing special characters
|
||||||
|
if (url.search) {
|
||||||
|
fileName += url.search.replace(/[&=?]/g, "-");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace any characters that are not valid in filenames
|
||||||
|
fileName = fileName.replace(/[^a-zA-Z0-9-_]/g, "");
|
||||||
|
|
||||||
|
// Trim or pad the fileName to a specific length
|
||||||
|
fileName = fileName.substring(0, 50);
|
||||||
|
|
||||||
|
add_pre_cache_transform: {
|
||||||
|
if (preCacheTransform === undefined) {
|
||||||
|
break add_pre_cache_transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sanitize actionCacheId the same way as other components
|
||||||
|
const sanitizedActionCacheId = preCacheTransform.actionCacheId.replace(/[^a-zA-Z0-9-_]/g, "_");
|
||||||
|
|
||||||
|
fileName += `_${sanitizedActionCacheId}_${createHash("sha256").update(preCacheTransform.actionFootprint).digest("hex").substring(0, 5)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return fileName;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function exists(path: string) {
|
||||||
|
try {
|
||||||
|
await stat(path);
|
||||||
|
return true;
|
||||||
|
} catch (error) {
|
||||||
|
if ((error as Error & { code: string }).code === "ENOENT") return false;
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureArray<T>(arg0: T | T[]) {
|
||||||
|
return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
|
||||||
|
}
|
||||||
|
|
||||||
|
function ensureSingleOrNone<T>(arg0: T | T[]) {
|
||||||
|
if (!Array.isArray(arg0)) return arg0;
|
||||||
|
if (arg0.length === 0) return undefined;
|
||||||
|
if (arg0.length === 1) return arg0[0];
|
||||||
|
throw new Error("Illegal configuration, expected a single value but found multiple: " + arg0.map(String).join(", "));
|
||||||
|
}
|
||||||
|
|
||||||
|
type NPMConfig = Record<string, string | string[]>;
|
||||||
|
|
||||||
|
const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
|
||||||
|
key in cfg ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] } : { ...cfg, [key]: value };
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get npm configuration as map
|
||||||
|
*/
|
||||||
|
async function getNmpConfig() {
|
||||||
|
return readNpmConfig().then(parseNpmConfig);
|
||||||
|
}
|
||||||
|
|
||||||
|
function readNpmConfig(): Promise<string> {
|
||||||
|
return (async function callee(depth: number): Promise<string> {
|
||||||
|
const cwd = pathResolve(pathJoin(...[process.cwd(), ...Array(depth).fill("..")]));
|
||||||
|
|
||||||
|
let stdout: string;
|
||||||
|
|
||||||
|
try {
|
||||||
|
stdout = await exec("npm config get", { "encoding": "utf8", cwd }).then(({ stdout }) => stdout);
|
||||||
|
} catch (error) {
|
||||||
|
if (String(error).includes("ENOWORKSPACES")) {
|
||||||
|
assert(cwd !== pathSep);
|
||||||
|
|
||||||
|
return callee(depth + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
|
||||||
|
return stdout;
|
||||||
|
})(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseNpmConfig(stdout: string) {
|
||||||
|
return stdout
|
||||||
|
.split("\n")
|
||||||
|
.filter(line => !line.startsWith(";"))
|
||||||
|
.map(line => line.trim())
|
||||||
|
.map(line => line.split("=", 2) as [string, string])
|
||||||
|
.reduce(npmConfigReducer, {} as NPMConfig);
|
||||||
|
}
|
||||||
|
|
||||||
|
function maybeBoolean(arg0: string | undefined) {
|
||||||
|
return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
|
||||||
|
}
|
||||||
|
|
||||||
|
function chunks<T>(arr: T[], size: number = 2) {
|
||||||
|
return arr.map((_, i) => i % size == 0 && arr.slice(i, i + size)).filter(Boolean) as T[][];
|
||||||
|
}
|
||||||
|
|
||||||
|
async function readCafile(cafile: string) {
|
||||||
|
const cafileContent = await readFile(cafile, "utf-8");
|
||||||
|
return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n"));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get proxy and ssl configuration from npm config files. Note that we don't care about
|
||||||
|
* proxy config in env vars, because make-fetch-happen will do that for us.
|
||||||
|
*
|
||||||
|
* @returns proxy configuration
|
||||||
|
*/
|
||||||
|
async function getFetchOptions(): Promise<Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "ca" | "cert">> {
|
||||||
|
const cfg = await getNmpConfig();
|
||||||
|
|
||||||
|
const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
|
||||||
|
const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
|
||||||
|
const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
|
||||||
|
const cert = cfg["cert"];
|
||||||
|
const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
|
||||||
|
const cafile = ensureSingleOrNone(cfg["cafile"]);
|
||||||
|
|
||||||
|
if (typeof cafile !== "undefined" && cafile !== "null") ca.push(...(await readCafile(cafile)));
|
||||||
|
|
||||||
|
return { proxy, noProxy, strictSSL, cert, ca: ca.length === 0 ? undefined : ca };
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function downloadAndUnzip(
|
||||||
|
params: {
|
||||||
|
url: string;
|
||||||
|
destDirPath: string;
|
||||||
|
specificDirsToExtract?: string[];
|
||||||
|
preCacheTransform?: {
|
||||||
|
actionCacheId: string;
|
||||||
|
action: (params: { destDirPath: string }) => Promise<void>;
|
||||||
|
};
|
||||||
|
} & (
|
||||||
|
| {
|
||||||
|
doUseCache: true;
|
||||||
|
projectDirPath: string;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
doUseCache: false;
|
||||||
|
}
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
const { url, destDirPath, specificDirsToExtract, preCacheTransform, ...rest } = params;
|
||||||
|
|
||||||
|
const zipFileBasename = generateFileNameFromURL({
|
||||||
|
url,
|
||||||
|
"preCacheTransform":
|
||||||
|
preCacheTransform === undefined
|
||||||
|
? undefined
|
||||||
|
: {
|
||||||
|
"actionCacheId": preCacheTransform.actionCacheId,
|
||||||
|
"actionFootprint": preCacheTransform.action.toString()
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const cacheRoot = !rest.doUseCache
|
||||||
|
? `tmp_${Math.random().toString().slice(2, 12)}`
|
||||||
|
: pathJoin(process.env.XDG_CACHE_HOME ?? pathJoin(rest.projectDirPath, "node_modules", ".cache"), "keycloakify");
|
||||||
|
const zipFilePath = pathJoin(cacheRoot, `${zipFileBasename}.zip`);
|
||||||
|
const extractDirPath = pathJoin(cacheRoot, `tmp_unzip_${zipFileBasename}`);
|
||||||
|
|
||||||
|
if (!(await exists(zipFilePath))) {
|
||||||
|
const opts = await getFetchOptions();
|
||||||
|
const response = await fetch(url, opts);
|
||||||
|
await mkdir(pathDirname(zipFilePath), { "recursive": true });
|
||||||
|
/**
|
||||||
|
* The correct way to fix this is to upgrade node-fetch beyond 3.2.5
|
||||||
|
* (see https://github.com/node-fetch/node-fetch/issues/1295#issuecomment-1144061991.)
|
||||||
|
* Unfortunately, octokit (a dependency of keycloakify) also uses node-fetch, and
|
||||||
|
* does not support node-fetch 3.x. So we stick around with this band-aid until
|
||||||
|
* octokit upgrades.
|
||||||
|
*/
|
||||||
|
response.body?.setMaxListeners(Number.MAX_VALUE);
|
||||||
|
assert(typeof response.body !== "undefined" && response.body != null);
|
||||||
|
await writeFile(zipFilePath, response.body);
|
||||||
|
|
||||||
|
if (specificDirsToExtract !== undefined || preCacheTransform !== undefined) {
|
||||||
|
await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
|
||||||
|
|
||||||
|
await preCacheTransform?.action({
|
||||||
|
"destDirPath": extractDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
await unlink(zipFilePath);
|
||||||
|
|
||||||
|
await zip(extractDirPath, zipFilePath);
|
||||||
|
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
await unzip(zipFilePath, extractDirPath);
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": extractDirPath,
|
||||||
|
"destDirPath": destDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!rest.doUseCache) {
|
||||||
|
await rm(cacheRoot, { "recursive": true });
|
||||||
|
} else {
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
|
}
|
@ -1,73 +0,0 @@
|
|||||||
import { exec as execCallback } from "child_process";
|
|
||||||
import { readFile } from "fs/promises";
|
|
||||||
import { type FetchOptions } from "make-fetch-happen";
|
|
||||||
import { promisify } from "util";
|
|
||||||
|
|
||||||
function ensureArray<T>(arg0: T | T[]) {
|
|
||||||
return Array.isArray(arg0) ? arg0 : typeof arg0 === "undefined" ? [] : [arg0];
|
|
||||||
}
|
|
||||||
|
|
||||||
function ensureSingleOrNone<T>(arg0: T | T[]) {
|
|
||||||
if (!Array.isArray(arg0)) return arg0;
|
|
||||||
if (arg0.length === 0) return undefined;
|
|
||||||
if (arg0.length === 1) return arg0[0];
|
|
||||||
throw new Error("Illegal configuration, expected a single value but found multiple: " + arg0.map(String).join(", "));
|
|
||||||
}
|
|
||||||
|
|
||||||
type NPMConfig = Record<string, string | string[]>;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get npm configuration as map
|
|
||||||
*/
|
|
||||||
async function getNmpConfig(params: { npmWorkspaceRootDirPath: string }) {
|
|
||||||
const { npmWorkspaceRootDirPath } = params;
|
|
||||||
|
|
||||||
const exec = promisify(execCallback);
|
|
||||||
|
|
||||||
const stdout = await exec("npm config get", { "encoding": "utf8", "cwd": npmWorkspaceRootDirPath }).then(({ stdout }) => stdout);
|
|
||||||
|
|
||||||
const npmConfigReducer = (cfg: NPMConfig, [key, value]: [string, string]) =>
|
|
||||||
key in cfg ? { ...cfg, [key]: [...ensureArray(cfg[key]), value] } : { ...cfg, [key]: value };
|
|
||||||
|
|
||||||
return stdout
|
|
||||||
.split("\n")
|
|
||||||
.filter(line => !line.startsWith(";"))
|
|
||||||
.map(line => line.trim())
|
|
||||||
.map(line => line.split("=", 2) as [string, string])
|
|
||||||
.reduce(npmConfigReducer, {} as NPMConfig);
|
|
||||||
}
|
|
||||||
|
|
||||||
export type ProxyFetchOptions = Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "cert" | "ca">;
|
|
||||||
|
|
||||||
export async function getProxyFetchOptions(params: { npmWorkspaceRootDirPath: string }): Promise<ProxyFetchOptions> {
|
|
||||||
const { npmWorkspaceRootDirPath } = params;
|
|
||||||
|
|
||||||
const cfg = await getNmpConfig({ npmWorkspaceRootDirPath });
|
|
||||||
|
|
||||||
const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
|
|
||||||
const noProxy = cfg["noproxy"] ?? cfg["no-proxy"];
|
|
||||||
|
|
||||||
function maybeBoolean(arg0: string | undefined) {
|
|
||||||
return typeof arg0 === "undefined" ? undefined : Boolean(arg0);
|
|
||||||
}
|
|
||||||
|
|
||||||
const strictSSL = maybeBoolean(ensureSingleOrNone(cfg["strict-ssl"]));
|
|
||||||
const cert = cfg["cert"];
|
|
||||||
const ca = ensureArray(cfg["ca"] ?? cfg["ca[]"]);
|
|
||||||
const cafile = ensureSingleOrNone(cfg["cafile"]);
|
|
||||||
|
|
||||||
if (typeof cafile !== "undefined" && cafile !== "null") {
|
|
||||||
ca.push(
|
|
||||||
...(await (async () => {
|
|
||||||
function chunks<T>(arr: T[], size: number = 2) {
|
|
||||||
return arr.map((_, i) => i % size == 0 && arr.slice(i, i + size)).filter(Boolean) as T[][];
|
|
||||||
}
|
|
||||||
|
|
||||||
const cafileContent = await readFile(cafile, "utf-8");
|
|
||||||
return chunks(cafileContent.split(/(-----END CERTIFICATE-----)/), 2).map(ca => ca.join("").replace(/^\n/, "").replace(/\n/g, "\\n"));
|
|
||||||
})())
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return { proxy, noProxy, strictSSL, cert, "ca": ca.length === 0 ? undefined : ca };
|
|
||||||
}
|
|
@ -1,11 +0,0 @@
|
|||||||
import * as fs from "fs/promises";
|
|
||||||
|
|
||||||
export async function existsAsync(path: string) {
|
|
||||||
try {
|
|
||||||
await fs.stat(path);
|
|
||||||
return true;
|
|
||||||
} catch (error) {
|
|
||||||
if ((error as Error & { code: string }).code === "ENOENT") return false;
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,43 +0,0 @@
|
|||||||
import * as fs from "fs/promises";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import { SemVer } from "./SemVer";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Polyfill of fs.rm(dirPath, { "recursive": true })
|
|
||||||
* For older version of Node
|
|
||||||
*/
|
|
||||||
export async function rm(dirPath: string, options: { recursive: true; force?: true }) {
|
|
||||||
if (SemVer.compare(SemVer.parse(process.version), SemVer.parse("14.14.0")) > 0) {
|
|
||||||
return fs.rm(dirPath, options);
|
|
||||||
}
|
|
||||||
|
|
||||||
const { force = true } = options;
|
|
||||||
|
|
||||||
if (force && !(await checkDirExists(dirPath))) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const removeDir_rec = async (dirPath: string) =>
|
|
||||||
Promise.all(
|
|
||||||
(await fs.readdir(dirPath)).map(async basename => {
|
|
||||||
const fileOrDirpath = pathJoin(dirPath, basename);
|
|
||||||
|
|
||||||
if ((await fs.lstat(fileOrDirpath)).isDirectory()) {
|
|
||||||
await removeDir_rec(fileOrDirpath);
|
|
||||||
} else {
|
|
||||||
await fs.unlink(fileOrDirpath);
|
|
||||||
}
|
|
||||||
})
|
|
||||||
);
|
|
||||||
|
|
||||||
await removeDir_rec(dirPath);
|
|
||||||
}
|
|
||||||
|
|
||||||
async function checkDirExists(dirPath: string) {
|
|
||||||
try {
|
|
||||||
await fs.access(dirPath, fs.constants.F_OK);
|
|
||||||
return true;
|
|
||||||
} catch {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,34 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import { SemVer } from "./SemVer";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Polyfill of fs.rmSync(dirPath, { "recursive": true })
|
|
||||||
* For older version of Node
|
|
||||||
*/
|
|
||||||
export function rmSync(dirPath: string, options: { recursive: true; force?: true }) {
|
|
||||||
if (SemVer.compare(SemVer.parse(process.version), SemVer.parse("14.14.0")) > 0) {
|
|
||||||
fs.rmSync(dirPath, options);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { force = true } = options;
|
|
||||||
|
|
||||||
if (force && !fs.existsSync(dirPath)) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const removeDir_rec = (dirPath: string) =>
|
|
||||||
fs.readdirSync(dirPath).forEach(basename => {
|
|
||||||
const fileOrDirpath = pathJoin(dirPath, basename);
|
|
||||||
|
|
||||||
if (fs.lstatSync(fileOrDirpath).isDirectory()) {
|
|
||||||
removeDir_rec(fileOrDirpath);
|
|
||||||
return;
|
|
||||||
} else {
|
|
||||||
fs.unlinkSync(fileOrDirpath);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
removeDir_rec(dirPath);
|
|
||||||
}
|
|
@ -1,17 +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);
|
|
||||||
|
|
||||||
pathOut = pathOut.endsWith(pathSep) ? pathOut.slice(0, -1) : pathOut;
|
|
||||||
|
|
||||||
if (!pathIsAbsolute(pathOut)) {
|
|
||||||
pathOut = pathJoin(cwd, pathOut);
|
|
||||||
}
|
|
||||||
|
|
||||||
return pathOut;
|
|
||||||
}
|
|
@ -1,19 +1,19 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import * as path from "path";
|
import * as path from "path";
|
||||||
|
|
||||||
function getThisCodebaseRootDirPath_rec(dirPath: string): string {
|
function getProjectRootRec(dirPath: string): string {
|
||||||
if (fs.existsSync(path.join(dirPath, "package.json"))) {
|
if (fs.existsSync(path.join(dirPath, "package.json"))) {
|
||||||
return dirPath;
|
return dirPath;
|
||||||
}
|
}
|
||||||
return getThisCodebaseRootDirPath_rec(path.join(dirPath, ".."));
|
return getProjectRootRec(path.join(dirPath, ".."));
|
||||||
}
|
}
|
||||||
|
|
||||||
let result: string | undefined = undefined;
|
let result: string | undefined = undefined;
|
||||||
|
|
||||||
export function getThisCodebaseRootDirPath(): string {
|
export function getProjectRoot(): string {
|
||||||
if (result !== undefined) {
|
if (result !== undefined) {
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
return (result = getThisCodebaseRootDirPath_rec(__dirname));
|
return (result = getProjectRootRec(__dirname));
|
||||||
}
|
}
|
@ -1,15 +1,13 @@
|
|||||||
import { getThisCodebaseRootDirPath } from "./getThisCodebaseRootDirPath";
|
import { getProjectRoot } from "./getProjectRoot";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { constants } from "fs";
|
import { constants } from "fs";
|
||||||
import { chmod, stat } from "fs/promises";
|
import { chmod, stat } from "fs/promises";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const thisCodebaseRootDirPath = getThisCodebaseRootDirPath();
|
const { bin } = await import(pathJoin(getProjectRoot(), "package.json"));
|
||||||
|
|
||||||
const { bin } = await import(pathJoin(thisCodebaseRootDirPath, "package.json"));
|
|
||||||
|
|
||||||
const promises = Object.values<string>(bin).map(async scriptPath => {
|
const promises = Object.values<string>(bin).map(async scriptPath => {
|
||||||
const fullPath = pathJoin(thisCodebaseRootDirPath, scriptPath);
|
const fullPath = pathJoin(getProjectRoot(), scriptPath);
|
||||||
const oldMode = (await stat(fullPath)).mode;
|
const oldMode = (await stat(fullPath)).mode;
|
||||||
const newMode = oldMode | constants.S_IXUSR | constants.S_IXGRP | constants.S_IXOTH;
|
const newMode = oldMode | constants.S_IXUSR | constants.S_IXGRP | constants.S_IXOTH;
|
||||||
await chmod(fullPath, newMode);
|
await chmod(fullPath, newMode);
|
||||||
|
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));
|
||||||
|
});
|
||||||
|
}
|
@ -1,39 +1,39 @@
|
|||||||
import { listTagsFactory } from "./listTags";
|
import { listTagsFactory } from "./listTags";
|
||||||
import type { Octokit } from "@octokit/rest";
|
import type { Octokit } from "@octokit/rest";
|
||||||
import { SemVer } from "../SemVer";
|
import { NpmModuleVersion } from "../NpmModuleVersion";
|
||||||
|
|
||||||
export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
|
export function getLatestsSemVersionedTagFactory(params: { octokit: Octokit }) {
|
||||||
const { octokit } = params;
|
const { octokit } = params;
|
||||||
|
|
||||||
async function getLatestsSemVersionedTag(params: { owner: string; repo: string; count: number }): Promise<
|
async function getLatestsSemVersionedTag(params: { owner: string; repo: string; doIgnoreBeta: boolean; count: number }): Promise<
|
||||||
{
|
{
|
||||||
tag: string;
|
tag: string;
|
||||||
version: SemVer;
|
version: NpmModuleVersion;
|
||||||
}[]
|
}[]
|
||||||
> {
|
> {
|
||||||
const { owner, repo, count } = params;
|
const { owner, repo, doIgnoreBeta, count } = params;
|
||||||
|
|
||||||
const semVersionedTags: { tag: string; version: SemVer }[] = [];
|
const semVersionedTags: { tag: string; version: NpmModuleVersion }[] = [];
|
||||||
|
|
||||||
const { listTags } = listTagsFactory({ octokit });
|
const { listTags } = listTagsFactory({ octokit });
|
||||||
|
|
||||||
for await (const tag of listTags({ owner, repo })) {
|
for await (const tag of listTags({ owner, repo })) {
|
||||||
let version: SemVer;
|
let version: NpmModuleVersion;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
version = SemVer.parse(tag.replace(/^[vV]?/, ""));
|
version = NpmModuleVersion.parse(tag.replace(/^[vV]?/, ""));
|
||||||
} catch {
|
} catch {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (version.rc !== undefined) {
|
if (doIgnoreBeta && version.betaPreRelease !== undefined) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
semVersionedTags.push({ tag, version });
|
semVersionedTags.push({ tag, version });
|
||||||
}
|
}
|
||||||
|
|
||||||
return semVersionedTags.sort(({ version: vX }, { version: vY }) => SemVer.compare(vY, vX)).slice(0, count);
|
return semVersionedTags.sort(({ version: vX }, { version: vY }) => NpmModuleVersion.compare(vY, vX)).slice(0, count);
|
||||||
}
|
}
|
||||||
|
|
||||||
return { getLatestsSemVersionedTag };
|
return { getLatestsSemVersionedTag };
|
||||||
|
6
src/bin/tools/pathJoin.ts
Normal file
6
src/bin/tools/pathJoin.ts
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
export function pathJoin(...path: string[]): string {
|
||||||
|
return path
|
||||||
|
.map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
|
||||||
|
.map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
|
||||||
|
.join("/");
|
||||||
|
}
|
@ -1,12 +0,0 @@
|
|||||||
import { getThisCodebaseRootDirPath } from "./getThisCodebaseRootDirPath";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
|
|
||||||
export function readThisNpmProjectVersion(): string {
|
|
||||||
const version = JSON.parse(fs.readFileSync(pathJoin(getThisCodebaseRootDirPath(), "package.json")).toString("utf8"))["version"];
|
|
||||||
|
|
||||||
assert(typeof version === "string");
|
|
||||||
|
|
||||||
return version;
|
|
||||||
}
|
|
@ -1,7 +1,7 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import * as path from "path";
|
import * as path from "path";
|
||||||
import { crawl } from "./crawl";
|
import { crawl } from "./crawl";
|
||||||
import { rmSync } from "../tools/fs.rmSync";
|
import { id } from "tsafe/id";
|
||||||
|
|
||||||
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; fileRelativePath: string }) =>
|
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; fileRelativePath: string }) =>
|
||||||
| {
|
| {
|
||||||
@ -10,37 +10,18 @@ type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; file
|
|||||||
}
|
}
|
||||||
| undefined;
|
| undefined;
|
||||||
|
|
||||||
/**
|
/** Apply a transformation function to every file of directory */
|
||||||
* Apply a transformation function to every file of directory
|
|
||||||
* If source and destination are the same this function can be used to apply the transformation in place
|
|
||||||
* like filtering out some files or modifying them.
|
|
||||||
* */
|
|
||||||
export function transformCodebase(params: { srcDirPath: string; destDirPath: string; transformSourceCode?: TransformSourceCode }) {
|
export function transformCodebase(params: { srcDirPath: string; destDirPath: string; transformSourceCode?: TransformSourceCode }) {
|
||||||
const { srcDirPath, transformSourceCode } = params;
|
const {
|
||||||
|
srcDirPath,
|
||||||
const isTargetSameAsSource = path.relative(srcDirPath, params.destDirPath) === "";
|
destDirPath,
|
||||||
|
transformSourceCode = id<TransformSourceCode>(({ sourceCode }) => ({
|
||||||
const destDirPath = isTargetSameAsSource ? path.join(srcDirPath, "..", "tmp_xOsPdkPsTdzPs34sOkHs") : params.destDirPath;
|
"modifiedSourceCode": sourceCode
|
||||||
|
}))
|
||||||
fs.mkdirSync(destDirPath, {
|
} = params;
|
||||||
"recursive": true
|
|
||||||
});
|
|
||||||
|
|
||||||
for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
||||||
const filePath = path.join(srcDirPath, fileRelativePath);
|
const filePath = path.join(srcDirPath, fileRelativePath);
|
||||||
const destFilePath = path.join(destDirPath, fileRelativePath);
|
|
||||||
|
|
||||||
// NOTE: Optimization, if we don't need to transform the file, just copy
|
|
||||||
// it using the lower level implementation.
|
|
||||||
if (transformSourceCode === undefined) {
|
|
||||||
fs.mkdirSync(path.dirname(destFilePath), {
|
|
||||||
"recursive": true
|
|
||||||
});
|
|
||||||
|
|
||||||
fs.copyFileSync(filePath, destFilePath);
|
|
||||||
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
const transformSourceCodeResult = transformSourceCode({
|
const transformSourceCodeResult = transformSourceCode({
|
||||||
"sourceCode": fs.readFileSync(filePath),
|
"sourceCode": fs.readFileSync(filePath),
|
||||||
@ -52,18 +33,15 @@ export function transformCodebase(params: { srcDirPath: string; destDirPath: str
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.mkdirSync(path.dirname(destFilePath), {
|
fs.mkdirSync(path.dirname(path.join(destDirPath, fileRelativePath)), {
|
||||||
"recursive": true
|
"recursive": true
|
||||||
});
|
});
|
||||||
|
|
||||||
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
||||||
|
|
||||||
fs.writeFileSync(path.join(path.dirname(destFilePath), newFileName ?? path.basename(destFilePath)), modifiedSourceCode);
|
fs.writeFileSync(
|
||||||
}
|
path.join(path.dirname(path.join(destDirPath, fileRelativePath)), newFileName ?? path.basename(fileRelativePath)),
|
||||||
|
modifiedSourceCode
|
||||||
if (isTargetSameAsSource) {
|
);
|
||||||
rmSync(srcDirPath, { "recursive": true });
|
|
||||||
|
|
||||||
fs.renameSync(destDirPath, srcDirPath);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
@ -1,44 +0,0 @@
|
|||||||
import { assert } from "tsafe/assert";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* WARNING: Internal use only!!
|
|
||||||
* THIS DOES NOT WORK IN KEYCLOAK! It's only for resolving mock assets.
|
|
||||||
* This is just a way to know what's the base url that works
|
|
||||||
* both in webpack and vite.
|
|
||||||
* You can see this as a polyfill that return `import.meta.env.BASE_URL` when in Vite
|
|
||||||
* and when in Webpack returns the base url in the same format as vite does meaning
|
|
||||||
* "/" if hosted at root or "/foo/" when hosted under a subpath (always start and ends with a "/").
|
|
||||||
*/
|
|
||||||
export const BASE_URL = (() => {
|
|
||||||
vite: {
|
|
||||||
let BASE_URL: string;
|
|
||||||
|
|
||||||
try {
|
|
||||||
// @ts-expect-error
|
|
||||||
BASE_URL = import.meta.env.BASE_URL;
|
|
||||||
|
|
||||||
assert(typeof BASE_URL === "string");
|
|
||||||
} catch {
|
|
||||||
break vite;
|
|
||||||
}
|
|
||||||
|
|
||||||
return BASE_URL;
|
|
||||||
}
|
|
||||||
|
|
||||||
webpack: {
|
|
||||||
let BASE_URL: string;
|
|
||||||
|
|
||||||
try {
|
|
||||||
// @ts-expect-error
|
|
||||||
BASE_URL = process.env.PUBLIC_URL;
|
|
||||||
|
|
||||||
assert(typeof BASE_URL === "string");
|
|
||||||
} catch {
|
|
||||||
break webpack;
|
|
||||||
}
|
|
||||||
|
|
||||||
return BASE_URL === "" ? "/" : `${BASE_URL}/`;
|
|
||||||
}
|
|
||||||
|
|
||||||
throw new Error("Bundler not supported");
|
|
||||||
})();
|
|
@ -1 +0,0 @@
|
|||||||
export const isStorybook = typeof window === "object" && Object.keys(window).find(key => key.startsWith("__STORYBOOK")) !== undefined;
|
|
@ -36,10 +36,6 @@ export declare namespace keycloak_js {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @deprecated: This will be removed in the next major version.
|
|
||||||
* If you use this, please copy paste the code into your project.
|
|
||||||
* Better yet migrate away from keycloak-js and use https://docs.oidc-spa.dev instead.
|
|
||||||
*
|
|
||||||
* NOTE: This is just a slightly modified version of the default adapter in keycloak-js
|
* NOTE: This is just a slightly modified version of the default adapter in keycloak-js
|
||||||
* The goal here is just to be able to inject search param in url before keycloak redirect.
|
* The goal here is just to be able to inject search param in url before keycloak redirect.
|
||||||
* Our use case for it is to pass over the login screen the states of useGlobalState
|
* Our use case for it is to pass over the login screen the states of useGlobalState
|
||||||
|
@ -45,8 +45,6 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
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")}>
|
||||||
|
@ -95,5 +95,4 @@ export type ClassKey =
|
|||||||
| "kcAuthenticatorOtpCircleClass"
|
| "kcAuthenticatorOtpCircleClass"
|
||||||
| "kcSelectOTPItemHeadingClass"
|
| "kcSelectOTPItemHeadingClass"
|
||||||
| "kcFormOptionsWrapperClass"
|
| "kcFormOptionsWrapperClass"
|
||||||
| "kcFormButtonsWrapperClass"
|
| "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";
|
||||||
@ -82,9 +81,8 @@ 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: {
|
||||||
/**
|
/**
|
||||||
* Return text if message for given field exists. Useful eg. to add css styles for fields with message.
|
* Return text if message for given field exists. Useful eg. to add css styles for fields with message.
|
||||||
@ -116,7 +114,6 @@ export declare namespace KcContext {
|
|||||||
*/
|
*/
|
||||||
exists: (fieldName: string) => boolean;
|
exists: (fieldName: string) => boolean;
|
||||||
};
|
};
|
||||||
properties: Record<string, string | undefined>;
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type SamlPostForm = Common & {
|
export type SamlPostForm = Common & {
|
||||||
@ -245,17 +242,6 @@ export declare namespace KcContext {
|
|||||||
|
|
||||||
export type Terms = Common & {
|
export type Terms = Common & {
|
||||||
pageId: "terms.ftl";
|
pageId: "terms.ftl";
|
||||||
//NOTE: Optional because maybe it wasn't defined in older keycloak versions.
|
|
||||||
user?: {
|
|
||||||
id: string;
|
|
||||||
username: string;
|
|
||||||
attributes: Record<string, string[]>;
|
|
||||||
email: string;
|
|
||||||
emailVerified: boolean;
|
|
||||||
firstName?: string;
|
|
||||||
lastName?: string;
|
|
||||||
markedForEviction?: boolean;
|
|
||||||
};
|
|
||||||
};
|
};
|
||||||
|
|
||||||
export type LoginDeviceVerifyUserCode = Common & {
|
export type LoginDeviceVerifyUserCode = Common & {
|
||||||
|
@ -2,19 +2,20 @@ import type { KcContext, Attribute } from "./KcContext";
|
|||||||
import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
|
import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
|
||||||
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
import type { DeepPartial } from "keycloakify/tools/DeepPartial";
|
||||||
import { deepAssign } from "keycloakify/tools/deepAssign";
|
import { deepAssign } from "keycloakify/tools/deepAssign";
|
||||||
import { isStorybook } from "keycloakify/lib/isStorybook";
|
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import { exclude } from "tsafe/exclude";
|
import { exclude } from "tsafe/exclude";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
||||||
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
||||||
|
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
|
import { pathBasename } from "keycloakify/tools/pathBasename";
|
||||||
|
import { resourcesCommonDirPathRelativeToPublicDir } from "keycloakify/bin/mockTestingResourcesPath";
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
|
|
||||||
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
||||||
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
||||||
mockProperties?: Record<string, string>;
|
|
||||||
}) {
|
}) {
|
||||||
const { mockData, mockProperties } = params ?? {};
|
const { mockData } = params ?? {};
|
||||||
|
|
||||||
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
|
||||||
mockPageId?: PageId;
|
mockPageId?: PageId;
|
||||||
@ -31,13 +32,7 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
if (mockPageId !== undefined && realKcContext === undefined) {
|
if (mockPageId !== undefined && realKcContext === undefined) {
|
||||||
//TODO maybe trow if no mock fo custom page
|
//TODO maybe trow if no mock fo custom page
|
||||||
|
|
||||||
warn_that_mock_is_enbaled: {
|
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
||||||
if (isStorybook) {
|
|
||||||
break warn_that_mock_is_enbaled;
|
|
||||||
}
|
|
||||||
|
|
||||||
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
|
||||||
}
|
|
||||||
|
|
||||||
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
||||||
|
|
||||||
@ -142,13 +137,6 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (mockProperties !== undefined) {
|
|
||||||
deepAssign({
|
|
||||||
"target": kcContext.properties,
|
|
||||||
"source": mockProperties
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
return { kcContext };
|
return { kcContext };
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -160,6 +148,12 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const { url } = realKcContext;
|
||||||
|
|
||||||
|
url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(resourcesCommonDirPathRelativeToPublicDir));
|
||||||
|
}
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,11 +1,11 @@
|
|||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
|
||||||
import { nameOfTheGlobal } from "keycloakify/bin/constants";
|
import { ftlValuesGlobalName } from "keycloakify/bin/keycloakify/ftlValuesGlobalName";
|
||||||
|
|
||||||
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
|
||||||
? KcContext
|
? KcContext
|
||||||
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
: AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
|
||||||
|
|
||||||
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
|
||||||
return typeof window === "undefined" ? undefined : (window as any)[nameOfTheGlobal];
|
return typeof window === "undefined" ? undefined : (window as any)[ftlValuesGlobalName];
|
||||||
}
|
}
|
||||||
|
@ -1,10 +1,12 @@
|
|||||||
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 { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import { assert, type Equals } from "tsafe/assert";
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
import { BASE_URL } from "keycloakify/lib/BASE_URL";
|
|
||||||
|
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
||||||
|
|
||||||
const attributes: Attribute[] = [
|
const attributes: Attribute[] = [
|
||||||
{
|
{
|
||||||
@ -100,8 +102,6 @@ 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 resourcesPath = `${BASE_URL}${keycloak_resources}/login/resources`;
|
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
"themeVersion": "0.0.0",
|
"themeVersion": "0.0.0",
|
||||||
"keycloakifyVersion": "0.0.0",
|
"keycloakifyVersion": "0.0.0",
|
||||||
@ -109,8 +109,8 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"themeName": "my-theme-name",
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
"loginAction": "#",
|
"loginAction": "#",
|
||||||
resourcesPath,
|
"resourcesPath": pathJoin(PUBLIC_URL, resourcesDirPathRelativeToPublicDir),
|
||||||
"resourcesCommonPath": `${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"
|
||||||
},
|
},
|
||||||
@ -232,131 +232,10 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"showTryAnotherWayLink": false
|
"showTryAnotherWayLink": false
|
||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp"
|
||||||
"attributes": {}
|
|
||||||
},
|
},
|
||||||
"scripts": [],
|
"scripts": [],
|
||||||
"isAppInitiatedAction": false,
|
"isAppInitiatedAction": false
|
||||||
"properties": {
|
|
||||||
"kcLogoIdP-facebook": "fa fa-facebook",
|
|
||||||
"parent": "keycloak",
|
|
||||||
"kcAuthenticatorOTPClass": "fa fa-mobile list-view-pf-icon-lg",
|
|
||||||
"kcLogoIdP-bitbucket": "fa fa-bitbucket",
|
|
||||||
"kcAuthenticatorWebAuthnClass": "fa fa-key list-view-pf-icon-lg",
|
|
||||||
"kcWebAuthnDefaultIcon": "pficon pficon-key",
|
|
||||||
"kcLogoIdP-stackoverflow": "fa fa-stack-overflow",
|
|
||||||
"kcSelectAuthListItemClass": "pf-l-stack__item select-auth-box-parent pf-l-split",
|
|
||||||
"kcLogoIdP-microsoft": "fa fa-windows",
|
|
||||||
"kcLocaleItemClass": "pf-c-dropdown__menu-item",
|
|
||||||
"kcLoginOTPListItemHeaderClass": "pf-c-tile__header",
|
|
||||||
"kcLoginOTPListItemIconBodyClass": "pf-c-tile__icon",
|
|
||||||
"kcInputHelperTextAfterClass": "pf-c-form__helper-text pf-c-form__helper-text-after",
|
|
||||||
"kcFormClass": "form-horizontal",
|
|
||||||
"kcSelectAuthListClass": "pf-l-stack select-auth-container",
|
|
||||||
"kcInputClassRadioCheckboxLabelDisabled": "pf-m-disabled",
|
|
||||||
"kcSelectAuthListItemIconClass": "pf-l-split__item select-auth-box-icon",
|
|
||||||
"kcRecoveryCodesWarning": "kc-recovery-codes-warning",
|
|
||||||
"kcFormSettingClass": "login-pf-settings",
|
|
||||||
"kcWebAuthnBLE": "fa fa-bluetooth-b",
|
|
||||||
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
|
||||||
"kcSelectAuthListItemArrowIconClass": "fa fa-angle-right fa-lg",
|
|
||||||
"meta": "viewport==width=device-width,initial-scale=1",
|
|
||||||
"styles": "css/login.css css/tile.css",
|
|
||||||
"kcFeedbackAreaClass": "col-md-12",
|
|
||||||
"kcLogoIdP-google": "fa fa-google",
|
|
||||||
"kcCheckLabelClass": "pf-c-check__label",
|
|
||||||
"kcSelectAuthListItemFillClass": "pf-l-split__item pf-m-fill",
|
|
||||||
"kcAuthenticatorDefaultClass": "fa fa-list list-view-pf-icon-lg",
|
|
||||||
"kcLogoIdP-gitlab": "fa fa-gitlab",
|
|
||||||
"kcFormAreaClass": "col-sm-10 col-sm-offset-1 col-md-8 col-md-offset-2 col-lg-8 col-lg-offset-2",
|
|
||||||
"kcFormButtonsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
|
||||||
"kcInputClassRadioLabel": "pf-c-radio__label",
|
|
||||||
"kcAuthenticatorWebAuthnPasswordlessClass": "fa fa-key list-view-pf-icon-lg",
|
|
||||||
"kcSelectAuthListItemHeadingClass": "pf-l-stack__item select-auth-box-headline pf-c-title",
|
|
||||||
"kcInfoAreaClass": "col-xs-12 col-sm-4 col-md-4 col-lg-5 details",
|
|
||||||
"kcLogoLink": "http://www.keycloak.org",
|
|
||||||
"kcContainerClass": "container-fluid",
|
|
||||||
"kcSelectAuthListItemTitle": "select-auth-box-paragraph",
|
|
||||||
"kcHtmlClass": "login-pf",
|
|
||||||
"kcLoginOTPListItemTitleClass": "pf-c-tile__title",
|
|
||||||
"locales": "ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
|
||||||
"serviceTitle": "CodeGouv",
|
|
||||||
"kcLogoIdP-openshift-v4": "pf-icon pf-icon-openshift",
|
|
||||||
"kcWebAuthnUnknownIcon": "pficon pficon-key unknown-transport-class",
|
|
||||||
"kcFormSocialAccountNameClass": "kc-social-provider-name",
|
|
||||||
"kcLogoIdP-openshift-v3": "pf-icon pf-icon-openshift",
|
|
||||||
"kcLoginOTPListInputClass": "pf-c-tile__input",
|
|
||||||
"kcWebAuthnUSB": "fa fa-usb",
|
|
||||||
"kcInputClassRadio": "pf-c-radio",
|
|
||||||
"kcWebAuthnKeyIcon": "pficon pficon-key",
|
|
||||||
"kcFeedbackInfoIcon": "fa fa-fw fa-info-circle",
|
|
||||||
"kcCommonLogoIdP": "kc-social-provider-logo kc-social-gray",
|
|
||||||
"stylesCommon":
|
|
||||||
"web_modules/@patternfly/react-core/dist/styles/base.css web_modules/@patternfly/react-core/dist/styles/app.css node_modules/patternfly/dist/css/patternfly.min.css node_modules/patternfly/dist/css/patternfly-additions.min.css lib/pficon/pficon.css",
|
|
||||||
"kcRecoveryCodesActions": "kc-recovery-codes-actions",
|
|
||||||
"kcFormGroupHeader": "pf-c-form__group",
|
|
||||||
"kcFormSocialAccountSectionClass": "kc-social-section kc-social-gray",
|
|
||||||
"kcLogoIdP-instagram": "fa fa-instagram",
|
|
||||||
"kcAlertClass": "pf-c-alert pf-m-inline",
|
|
||||||
"kcHeaderClass": "login-pf-page-header",
|
|
||||||
"kcLabelWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
|
||||||
"kcFormSocialAccountLinkClass": "pf-c-login__main-footer-links-item-link",
|
|
||||||
"kcLocaleMainClass": "pf-c-dropdown",
|
|
||||||
"kcTextareaClass": "form-control",
|
|
||||||
"kcButtonBlockClass": "pf-m-block",
|
|
||||||
"kcButtonClass": "pf-c-button",
|
|
||||||
"kcWebAuthnNFC": "fa fa-wifi",
|
|
||||||
"kcLocaleClass": "col-xs-12 col-sm-1",
|
|
||||||
"kcInputClassCheckboxInput": "pf-c-check__input",
|
|
||||||
"kcFeedbackErrorIcon": "fa fa-fw fa-exclamation-circle",
|
|
||||||
"kcInputLargeClass": "input-lg",
|
|
||||||
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text",
|
|
||||||
"kcRecoveryCodesList": "kc-recovery-codes-list",
|
|
||||||
"kcFormSocialAccountListClass": "pf-c-login__main-footer-links kc-social-links",
|
|
||||||
"kcAlertTitleClass": "pf-c-alert__title kc-feedback-text",
|
|
||||||
"kcAuthenticatorPasswordClass": "fa fa-unlock list-view-pf-icon-lg",
|
|
||||||
"kcCheckInputClass": "pf-c-check__input",
|
|
||||||
"kcLogoIdP-linkedin": "fa fa-linkedin",
|
|
||||||
"kcLogoIdP-twitter": "fa fa-twitter",
|
|
||||||
"kcFeedbackWarningIcon": "fa fa-fw fa-exclamation-triangle",
|
|
||||||
"kcResetFlowIcon": "pficon pficon-arrow fa",
|
|
||||||
"kcSelectAuthListItemIconPropertyClass": "fa-2x select-auth-box-icon-properties",
|
|
||||||
"kcFeedbackSuccessIcon": "fa fa-fw fa-check-circle",
|
|
||||||
"kcLoginOTPListClass": "pf-c-tile",
|
|
||||||
"kcSrOnlyClass": "sr-only",
|
|
||||||
"kcFormSocialAccountListGridClass": "pf-l-grid kc-social-grid",
|
|
||||||
"kcButtonDefaultClass": "btn-default",
|
|
||||||
"kcFormGroupErrorClass": "has-error",
|
|
||||||
"kcSelectAuthListItemDescriptionClass": "pf-l-stack__item select-auth-box-desc",
|
|
||||||
"kcSelectAuthListItemBodyClass": "pf-l-split__item pf-l-stack",
|
|
||||||
"import": "common/keycloak",
|
|
||||||
"kcWebAuthnInternal": "pficon pficon-key",
|
|
||||||
"kcSelectAuthListItemArrowClass": "pf-l-split__item select-auth-box-arrow",
|
|
||||||
"kcCheckClass": "pf-c-check",
|
|
||||||
"kcContentClass": "col-sm-8 col-sm-offset-2 col-md-6 col-md-offset-3 col-lg-6 col-lg-offset-3",
|
|
||||||
"kcLogoClass": "login-pf-brand",
|
|
||||||
"kcLoginOTPListItemIconClass": "fa fa-mobile",
|
|
||||||
"kcLoginClass": "login-pf-page",
|
|
||||||
"kcSignUpClass": "login-pf-signup",
|
|
||||||
"kcButtonLargeClass": "btn-lg",
|
|
||||||
"kcFormCardClass": "card-pf",
|
|
||||||
"kcLocaleListClass": "pf-c-dropdown__menu pf-m-align-right",
|
|
||||||
"kcInputClass": "pf-c-form-control",
|
|
||||||
"kcFormGroupClass": "form-group",
|
|
||||||
"kcLogoIdP-paypal": "fa fa-paypal",
|
|
||||||
"kcInputClassCheckbox": "pf-c-check",
|
|
||||||
"kcRecoveryCodesConfirmation": "kc-recovery-codes-confirmation",
|
|
||||||
"kcInputClassRadioInput": "pf-c-radio__input",
|
|
||||||
"kcFormSocialAccountListButtonClass": "pf-c-button pf-m-control pf-m-block kc-social-item kc-social-gray",
|
|
||||||
"kcInputClassCheckboxLabel": "pf-c-check__label",
|
|
||||||
"kcFormOptionsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
|
||||||
"kcFormHeaderClass": "login-pf-header",
|
|
||||||
"kcFormSocialAccountGridItem": "pf-l-grid__item",
|
|
||||||
"kcButtonPrimaryClass": "pf-m-primary",
|
|
||||||
"kcInputHelperTextBeforeClass": "pf-c-form__helper-text pf-c-form__helper-text-before",
|
|
||||||
"kcLogoIdP-github": "fa fa-github",
|
|
||||||
"kcLabelClass": "pf-c-form__label pf-c-form__label-text"
|
|
||||||
}
|
|
||||||
};
|
};
|
||||||
|
|
||||||
const loginUrl = {
|
const loginUrl = {
|
||||||
@ -433,8 +312,7 @@ export const kcContextMocks = [
|
|||||||
"actionUri": "#",
|
"actionUri": "#",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#",
|
"baseUrl": "#"
|
||||||
"attributes": {}
|
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
id<KcContext.Error>({
|
id<KcContext.Error>({
|
||||||
@ -442,8 +320,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",
|
||||||
@ -617,8 +494,7 @@ export const kcContextMocks = [
|
|||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#",
|
"baseUrl": "#"
|
||||||
"attributes": {}
|
|
||||||
},
|
},
|
||||||
"logoutConfirm": { "code": "123", skipLink: false }
|
"logoutConfirm": { "code": "123", skipLink: false }
|
||||||
}),
|
}),
|
||||||
|
@ -67,7 +67,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 +93,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",
|
||||||
|
@ -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"))}>
|
||||||
|
@ -1,11 +1,12 @@
|
|||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import Template from "../Template";
|
||||||
import { I18n } from "../i18n";
|
import { I18n } from "../i18n";
|
||||||
import { KcContext } from "../kcContext";
|
import { KcContext } from "../kcContext";
|
||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "../lib/useGetClassName";
|
||||||
import { PageProps } from "./PageProps";
|
import { PageProps } from "./PageProps";
|
||||||
|
|
||||||
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth2-device-verify-user-code.ftl" }>, I18n>) {
|
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 { kcContext, i18n, doUseDefaultCss, classes } = props;
|
||||||
const { url } = kcContext;
|
const { url } = kcContext;
|
||||||
|
|
||||||
const { msg, msgStr } = i18n;
|
const { msg, msgStr } = i18n;
|
||||||
|
@ -2,10 +2,11 @@ import { clsx } from "keycloakify/tools/clsx";
|
|||||||
import { PageProps } from "./PageProps";
|
import { PageProps } from "./PageProps";
|
||||||
import { KcContext } from "../kcContext";
|
import { KcContext } from "../kcContext";
|
||||||
import { I18n } from "../i18n";
|
import { I18n } from "../i18n";
|
||||||
|
import Template from "../Template";
|
||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
|
|
||||||
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth-grant.ftl" }>, I18n>) {
|
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth-grant.ftl" }>, I18n>) {
|
||||||
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
const { kcContext, i18n, doUseDefaultCss, classes } = props;
|
||||||
const { url, oauth, client } = kcContext;
|
const { url, oauth, client } = kcContext;
|
||||||
|
|
||||||
const { msg, msgStr, advancedMsg, advancedMsgStr } = i18n;
|
const { msg, msgStr, advancedMsg, advancedMsgStr } = i18n;
|
||||||
|
@ -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,11 +1,10 @@
|
|||||||
|
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";
|
|
||||||
import type { KcContext } from "keycloakify/account/kcContext";
|
|
||||||
|
|
||||||
export type PageProps<NarowedKcContext = KcContext, I18nExtended extends I18n = 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: NarowedKcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
classes?: Partial<Record<ClassKey, string>>;
|
classes?: Partial<Record<ClassKey, string>>;
|
||||||
|
@ -1,3 +0,0 @@
|
|||||||
import type { LazyExoticComponent, ComponentType } from "react";
|
|
||||||
|
|
||||||
export type LazyOrNot<Component extends ComponentType<any>> = LazyExoticComponent<Component> | Component;
|
|
@ -14,7 +14,7 @@
|
|||||||
"jsx": "react-jsx",
|
"jsx": "react-jsx",
|
||||||
"allowSyntheticDefaultImports": true
|
"allowSyntheticDefaultImports": true
|
||||||
},
|
},
|
||||||
"exclude": ["./bin", "./vite-plugin"],
|
"exclude": ["./bin"],
|
||||||
"references": [
|
"references": [
|
||||||
{
|
{
|
||||||
"path": "./bin"
|
"path": "./bin"
|
||||||
|
@ -1 +0,0 @@
|
|||||||
export * from "./vite-plugin";
|
|
@ -1,18 +0,0 @@
|
|||||||
{
|
|
||||||
"extends": "../../tsproject.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"module": "CommonJS",
|
|
||||||
"target": "ES2019",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"lib": ["es2019", "es2020.bigint", "es2020.string", "es2020.symbol.wellknown"],
|
|
||||||
"outDir": "../../dist/vite-plugin",
|
|
||||||
"rootDir": ".",
|
|
||||||
// https://github.com/vitejs/vite/issues/15112#issuecomment-1823908010
|
|
||||||
"skipLibCheck": true
|
|
||||||
},
|
|
||||||
"references": [
|
|
||||||
{
|
|
||||||
"path": "../bin"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
@ -1,192 +0,0 @@
|
|||||||
import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
|
|
||||||
import type { Plugin } from "vite";
|
|
||||||
import * as fs from "fs";
|
|
||||||
import {
|
|
||||||
resolvedViteConfigJsonBasename,
|
|
||||||
nameOfTheGlobal,
|
|
||||||
basenameOfTheKeycloakifyResourcesDir,
|
|
||||||
keycloak_resources,
|
|
||||||
keycloakifyBuildOptionsForPostPostBuildScriptEnvName
|
|
||||||
} from "../bin/constants";
|
|
||||||
import type { ResolvedViteConfig } from "../bin/keycloakify/buildOptions/resolvedViteConfig";
|
|
||||||
import { getCacheDirPath } from "../bin/keycloakify/buildOptions/getCacheDirPath";
|
|
||||||
import { id } from "tsafe/id";
|
|
||||||
import { rm } from "../bin/tools/fs.rm";
|
|
||||||
import { copyKeycloakResourcesToPublic } from "../bin/copy-keycloak-resources-to-public";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import type { BuildOptions } from "../bin/keycloakify/buildOptions";
|
|
||||||
import type { UserProvidedBuildOptions } from "../bin/keycloakify/buildOptions/UserProvidedBuildOptions";
|
|
||||||
import MagicString from "magic-string";
|
|
||||||
|
|
||||||
export type Params = UserProvidedBuildOptions & {
|
|
||||||
postBuild?: (buildOptions: Omit<BuildOptions, "bundler">) => Promise<void>;
|
|
||||||
};
|
|
||||||
|
|
||||||
export function keycloakify(params?: Params) {
|
|
||||||
const { postBuild, ...userProvidedBuildOptions } = params ?? {};
|
|
||||||
|
|
||||||
let reactAppRootDirPath: string | undefined = undefined;
|
|
||||||
let urlPathname: string | undefined = undefined;
|
|
||||||
let buildDirPath: string | undefined = undefined;
|
|
||||||
let command: "build" | "serve" | undefined = undefined;
|
|
||||||
let shouldGenerateSourcemap: boolean | undefined = undefined;
|
|
||||||
|
|
||||||
const plugin = {
|
|
||||||
"name": "keycloakify" as const,
|
|
||||||
"configResolved": async resolvedConfig => {
|
|
||||||
shouldGenerateSourcemap = resolvedConfig.build.sourcemap !== false;
|
|
||||||
|
|
||||||
run_post_build_script: {
|
|
||||||
const buildOptionJson = process.env[keycloakifyBuildOptionsForPostPostBuildScriptEnvName];
|
|
||||||
|
|
||||||
if (buildOptionJson === undefined) {
|
|
||||||
break run_post_build_script;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (postBuild === undefined) {
|
|
||||||
process.exit(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
const buildOptions: BuildOptions = JSON.parse(buildOptionJson);
|
|
||||||
|
|
||||||
await postBuild(buildOptions);
|
|
||||||
|
|
||||||
process.exit(0);
|
|
||||||
}
|
|
||||||
|
|
||||||
command = resolvedConfig.command;
|
|
||||||
|
|
||||||
reactAppRootDirPath = resolvedConfig.root;
|
|
||||||
urlPathname = (() => {
|
|
||||||
let out = resolvedConfig.env.BASE_URL;
|
|
||||||
|
|
||||||
if (out.startsWith(".") && command === "build" && resolvedConfig.envPrefix?.includes("STORYBOOK_") !== true) {
|
|
||||||
throw new Error(
|
|
||||||
[
|
|
||||||
`BASE_URL=${out} is not supported By Keycloakify. Use an absolute URL instead.`,
|
|
||||||
`If this is a problem, please open an issue at https://github.com/keycloakify/keycloakify/issues/new`
|
|
||||||
].join("\n")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (out === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!out.startsWith("/")) {
|
|
||||||
out = "/" + out;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!out.endsWith("/")) {
|
|
||||||
out += "/";
|
|
||||||
}
|
|
||||||
|
|
||||||
return out;
|
|
||||||
})();
|
|
||||||
|
|
||||||
buildDirPath = pathJoin(reactAppRootDirPath, resolvedConfig.build.outDir);
|
|
||||||
|
|
||||||
const { cacheDirPath } = getCacheDirPath({
|
|
||||||
reactAppRootDirPath
|
|
||||||
});
|
|
||||||
|
|
||||||
if (!fs.existsSync(cacheDirPath)) {
|
|
||||||
fs.mkdirSync(cacheDirPath, { "recursive": true });
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(cacheDirPath, resolvedViteConfigJsonBasename),
|
|
||||||
Buffer.from(
|
|
||||||
JSON.stringify(
|
|
||||||
id<ResolvedViteConfig>({
|
|
||||||
"publicDir": pathRelative(reactAppRootDirPath, resolvedConfig.publicDir),
|
|
||||||
"assetsDir": resolvedConfig.build.assetsDir,
|
|
||||||
"buildDir": resolvedConfig.build.outDir,
|
|
||||||
urlPathname,
|
|
||||||
userProvidedBuildOptions
|
|
||||||
}),
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
await copyKeycloakResourcesToPublic({
|
|
||||||
"processArgv": ["--project", reactAppRootDirPath]
|
|
||||||
});
|
|
||||||
},
|
|
||||||
"transform": (code, id) => {
|
|
||||||
assert(command !== undefined);
|
|
||||||
assert(shouldGenerateSourcemap !== undefined);
|
|
||||||
|
|
||||||
if (command !== "build") {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
assert(reactAppRootDirPath !== undefined);
|
|
||||||
|
|
||||||
{
|
|
||||||
const isWithinSourceDirectory = id.startsWith(pathJoin(reactAppRootDirPath, "src") + pathSep);
|
|
||||||
|
|
||||||
if (!isWithinSourceDirectory) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const isJavascriptFile = id.endsWith(".js") || id.endsWith(".jsx");
|
|
||||||
const isTypeScriptFile = id.endsWith(".ts") || id.endsWith(".tsx");
|
|
||||||
|
|
||||||
if (!isTypeScriptFile && !isJavascriptFile) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const transformedCode = new MagicString(code);
|
|
||||||
|
|
||||||
transformedCode.replaceAll(
|
|
||||||
/import\.meta\.env(?:(?:\.BASE_URL)|(?:\["BASE_URL"\]))/g,
|
|
||||||
[
|
|
||||||
`(`,
|
|
||||||
`(window.${nameOfTheGlobal} === undefined || import.meta.env.MODE === "development")?`,
|
|
||||||
`"${urlPathname ?? "/"}":`,
|
|
||||||
`(window.${nameOfTheGlobal}.url.resourcesPath + "/${basenameOfTheKeycloakifyResourcesDir}/")`,
|
|
||||||
`)`
|
|
||||||
].join("")
|
|
||||||
);
|
|
||||||
|
|
||||||
if (!transformedCode.hasChanged()) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!shouldGenerateSourcemap) {
|
|
||||||
return transformedCode.toString();
|
|
||||||
}
|
|
||||||
|
|
||||||
const map = transformedCode.generateMap({
|
|
||||||
"source": id,
|
|
||||||
"includeContent": true,
|
|
||||||
"hires": true
|
|
||||||
});
|
|
||||||
|
|
||||||
return {
|
|
||||||
"code": transformedCode.toString(),
|
|
||||||
"map": map.toString()
|
|
||||||
};
|
|
||||||
},
|
|
||||||
"closeBundle": async () => {
|
|
||||||
assert(command !== undefined);
|
|
||||||
|
|
||||||
if (command !== "build") {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
assert(buildDirPath !== undefined);
|
|
||||||
|
|
||||||
await rm(pathJoin(buildDirPath, keycloak_resources), { "recursive": true, "force": true });
|
|
||||||
}
|
|
||||||
} satisfies Plugin;
|
|
||||||
|
|
||||||
return plugin as any;
|
|
||||||
}
|
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user