Compare commits
334 Commits
Author | SHA1 | Date | |
---|---|---|---|
194d16ff91 | |||
b1e2284c0e | |||
70d1aa70a3 | |||
3b17d6e0ab | |||
9a5819b93b | |||
a260cd67b0 | |||
64111fb0ec | |||
faf2be23d9 | |||
0eb4a6a315 | |||
85673250ed | |||
09daa741ce | |||
55e2379aab | |||
9937977203 | |||
c897e7491a | |||
0a74a95283 | |||
74ef2c3dff | |||
9976dfacc0 | |||
659f8ddc7a | |||
9e4cc2ae57 | |||
a27d78fcdf | |||
e507435bcb | |||
d5f234909f | |||
c17f721625 | |||
600705130f | |||
5c5dce1422 | |||
53585bf2f0 | |||
116f88a503 | |||
aaba8cd2c7 | |||
b67aeb0d3a | |||
f620562d68 | |||
5231d0eaa1 | |||
cb470e3573 | |||
0a0f90aa2e | |||
635207d12c | |||
5e4a829413 | |||
b13b3fd92e | |||
564dc8e6f1 | |||
6e4cced8c6 | |||
29a4a5027c | |||
ee327448b4 | |||
d078960c5c | |||
2e8cd375fc | |||
1f6751cb01 | |||
3cca4e31cd | |||
b93902800c | |||
70f6bb3fda | |||
c075cb6311 | |||
d7db85b062 | |||
b442e7d958 | |||
a495ae637f | |||
94748a96a9 | |||
7657429054 | |||
2ff6dbf975 | |||
4f34628c14 | |||
6ff2111cee | |||
85957980f6 | |||
a6dcfe2c87 | |||
c32d590fbb | |||
ab41462f71 | |||
951f16b1a5 | |||
b5818888bb | |||
1a326bf7e4 | |||
e1afc1cf7a | |||
bb007ddce5 | |||
b5dd0317c7 | |||
3c54541a73 | |||
2657f01135 | |||
7223409eb1 | |||
c41eae63e7 | |||
c8b85c43aa | |||
e918788c3f | |||
b53f4f997c | |||
481d93ebc4 | |||
1ce666f136 | |||
49a8e702bc | |||
5d59e652d7 | |||
02af8c7311 | |||
fadf4e867c | |||
0839859fef | |||
c122b48e35 | |||
cebb297bbf | |||
2e31b796f7 | |||
e0a61b51cb | |||
46e50e622b | |||
7cfa1df0b2 | |||
8a63648339 | |||
bb6b026720 | |||
2a13b314dc | |||
4506b3f6d4 | |||
804abef0de | |||
7e932b920e | |||
46fdfbc507 | |||
a4ff8607c5 | |||
7fe4eeda57 | |||
9f25cddaa4 | |||
eb64fe60d0 | |||
36f404e17d | |||
5398590939 | |||
96d5cfea14 | |||
79007ebd55 | |||
fcb519dac3 | |||
2b487aa959 | |||
733feadcb2 | |||
5ae568f19c | |||
0e51807856 | |||
b6eb165207 | |||
d26dbf4b3d | |||
e06ef01f72 | |||
a722582709 | |||
de64deb5c5 | |||
7de54a2cc4 | |||
c788b8cc82 | |||
cb8db1a541 | |||
8a7a551c3b | |||
84d180b810 | |||
de261a27ca | |||
28288a8f7b | |||
cd8548fc32 | |||
37dbd49589 | |||
5af8d67b62 | |||
72e6309c4a | |||
18f0f3cce1 | |||
8c3e9ff192 | |||
21d6d27435 | |||
39ff7913d6 | |||
402c6fc64a | |||
a1f934466c | |||
15aa114579 | |||
b9cc82e37d | |||
8af9c8b150 | |||
7dcc985222 | |||
9c2bc19897 | |||
801b08359a | |||
c469dee158 | |||
2aa7eda1e9 | |||
f1246c9e00 | |||
2749cbe4d1 | |||
d2a9280ab3 | |||
8e25ee0fc9 | |||
55026f913b | |||
7cc40e2453 | |||
cb6b19952d | |||
983af57842 | |||
3c2820dc31 | |||
1c25b69160 | |||
641cc38ae4 | |||
cd68b07e19 | |||
2b252c9abb | |||
e2e8370bb9 | |||
e9e31394c4 | |||
2825ccbcd5 | |||
377a14ff72 | |||
a83997b9b4 | |||
3e155d8e80 | |||
6953b72ee6 | |||
ab370a1dda | |||
20845e5860 | |||
9ed3257006 | |||
2221e30c0a | |||
ce43dca23b | |||
4acf5d0931 | |||
b742ed73aa | |||
5156b2e0cc | |||
6b81cf4a24 | |||
cca3a68fe4 | |||
adb2904872 | |||
d68b8d03dd | |||
e7afb88f22 | |||
48cbfc64c0 | |||
0b067858bc | |||
2d44d98f17 | |||
74ef3096ae | |||
8f1163fd75 | |||
a240d503c5 | |||
e331a641b2 | |||
85db4b8e0a | |||
0aa139cf4a | |||
4140ca6fbd | |||
a8ce9da9ee | |||
476a33c0ab | |||
8e868c9fda | |||
17c8b1a172 | |||
b374c04d73 | |||
e750d824ad | |||
dd4c50c3eb | |||
20cc869299 | |||
7214dbccdb | |||
e6cebdd546 | |||
0301003ccf | |||
de2efe0c01 | |||
90d765d7f6 | |||
3e0a1721ce | |||
7214fbcd4c | |||
4b8aecfe91 | |||
387c71c0aa | |||
8d5ce21df4 | |||
f6dfcfbae9 | |||
69e9595db9 | |||
de390678fd | |||
cf9a7b8c60 | |||
73e9c16a8d | |||
9775623981 | |||
20b7bb3c99 | |||
3defc16658 | |||
0dbe592182 | |||
a7c0e5bdaa | |||
3b051cbbea | |||
f7edfd1c29 | |||
b182c43965 | |||
4639e7ad2e | |||
56241203a0 | |||
8c8540de5d | |||
b45af78322 | |||
98bcf3bf7e | |||
e28bcfced3 | |||
a5bd990245 | |||
58301e0844 | |||
c9213fb6cd | |||
641819a364 | |||
3ee3a8b41d | |||
5600403088 | |||
3b00bace23 | |||
fcba470aad | |||
206e602d73 | |||
f98d1aaade | |||
310f857257 | |||
a2b1055094 | |||
f23ddecef3 | |||
54687ec3c0 | |||
545f0fcea5 | |||
5db8ce3043 | |||
ed48669ae1 | |||
69c3befb2d | |||
fc39e837ea | |||
6df9f28c02 | |||
f3d0947427 | |||
3326a4cf2a | |||
9a6ea87b0c | |||
12179d0ec0 | |||
d4141fc51e | |||
c32ab6181c | |||
3847882599 | |||
4db157f663 | |||
351b4e84c9 | |||
0c65561bcb | |||
00200f75a0 | |||
58614a74f5 | |||
f3d64663a0 | |||
8be8c270f8 | |||
a56037f1c9 | |||
2ff7955ec3 | |||
f2044c4d26 | |||
4113f0faea | |||
bacd09484a | |||
8253eb62bd | |||
70b659a0a0 | |||
79ed74ab17 | |||
93bb3ebd69 | |||
e8e516159c | |||
1431c031a0 | |||
209c2183e1 | |||
0c98c282a0 | |||
58c10796a1 | |||
603e6a99f3 | |||
6622ebc04e | |||
465dbb4a8d | |||
08ae908453 | |||
c35a1e7c50 | |||
ecb22c3829 | |||
eebf969f7e | |||
5816f25c3e | |||
b2a81d880d | |||
b10c1476a6 | |||
e11cd09a12 | |||
27575eda68 | |||
f33b9a1ec6 | |||
7c45fff7ba | |||
ecdb0775cd | |||
6ef90a56ed | |||
71b86ff43b | |||
0535e06ae1 | |||
6261f5e7cc | |||
f256b74929 | |||
4f1182a230 | |||
e7c20547f8 | |||
9ab4c510fe | |||
7d78c52064 | |||
6223d91291 | |||
840b5e1312 | |||
e69813f6e3 | |||
3c0c057e06 | |||
984d12b3f2 | |||
61dc54f115 | |||
34e47cccc1 | |||
c170345550 | |||
1e40706f72 | |||
ea1a747ebf | |||
a14e967020 | |||
0fff10d2c6 | |||
7c2123614d | |||
d149866703 | |||
18039140db | |||
4de9599018 | |||
bb85829d71 | |||
ff077943ec | |||
f057114bcc | |||
e7bfe7f80d | |||
18112a97ab | |||
8ee6fb58ac | |||
08831fc31d | |||
c5c25394fb | |||
2f649c9866 | |||
91c5dd40fa | |||
e95e688cf0 | |||
9845f1de08 | |||
07032d312d | |||
ccb5d32763 | |||
bf83e4b03b | |||
03b491763f | |||
3abc9edf0e | |||
f9accc51d3 | |||
c3bade81b4 | |||
6edd1f00dd | |||
02be899629 | |||
8e043f289a | |||
30fecf8578 | |||
1112da33e3 | |||
ffa65e871e | |||
f49c7b465b | |||
e6f75156ec | |||
10965b82a9 | |||
86884607ef | |||
1ff0449332 | |||
564ffc2be9 |
@ -131,6 +131,106 @@
|
|||||||
"contributions": [
|
"contributions": [
|
||||||
"code"
|
"code"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "thosil",
|
||||||
|
"name": "Thomas Silvestre",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/1140574?v=4",
|
||||||
|
"profile": "https://www.gravitysoftware.be",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "satanshiro",
|
||||||
|
"name": "satanshiro",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/38865738?v=4",
|
||||||
|
"profile": "https://github.com/satanshiro",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "kpoelhekke",
|
||||||
|
"name": "Koen Poelhekke",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/1632377?v=4",
|
||||||
|
"profile": "https://poelhekke.dev",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "zavoloklom",
|
||||||
|
"name": "Sergey Kupletsky",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/4151869?v=4",
|
||||||
|
"profile": "https://github.com/zavoloklom",
|
||||||
|
"contributions": [
|
||||||
|
"test",
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "rome-user",
|
||||||
|
"name": "rome-user",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/114131048?v=4",
|
||||||
|
"profile": "https://github.com/rome-user",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "celinepelletier",
|
||||||
|
"name": "Céline Pelletier",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/82821620?v=4",
|
||||||
|
"profile": "https://github.com/celinepelletier",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "xgp",
|
||||||
|
"name": "Garth",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/244253?v=4",
|
||||||
|
"profile": "https://github.com/xgp",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "BlackVoid",
|
||||||
|
"name": "Felix Gustavsson",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/673720?v=4",
|
||||||
|
"profile": "https://github.com/BlackVoid",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "msiemens",
|
||||||
|
"name": "Markus Siemens",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/1873922?v=4",
|
||||||
|
"profile": "https://m-siemens.de/",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "law108000",
|
||||||
|
"name": "Rlok",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/8112024?v=4",
|
||||||
|
"profile": "https://github.com/law108000",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"login": "Moulyy",
|
||||||
|
"name": "Moulyy",
|
||||||
|
"avatar_url": "https://avatars.githubusercontent.com/u/115405804?v=4",
|
||||||
|
"profile": "https://github.com/Moulyy",
|
||||||
|
"contributions": [
|
||||||
|
"code"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"contributorsPerLine": 7,
|
"contributorsPerLine": 7,
|
||||||
@ -138,5 +238,6 @@
|
|||||||
"repoType": "github",
|
"repoType": "github",
|
||||||
"repoHost": "https://github.com",
|
"repoHost": "https://github.com",
|
||||||
"projectName": "keycloakify",
|
"projectName": "keycloakify",
|
||||||
"projectOwner": "keycloakify"
|
"projectOwner": "keycloakify",
|
||||||
|
"commitType": "docs"
|
||||||
}
|
}
|
||||||
|
6
.github/workflows/ci.yaml
vendored
6
.github/workflows/ci.yaml
vendored
@ -3,6 +3,9 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
|
- v5
|
||||||
|
- v6
|
||||||
|
- v7
|
||||||
pull_request:
|
pull_request:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- main
|
||||||
@ -34,7 +37,7 @@ jobs:
|
|||||||
- uses: bahmutov/npm-install@v1
|
- uses: bahmutov/npm-install@v1
|
||||||
- run: yarn build
|
- run: yarn build
|
||||||
- run: yarn test
|
- run: yarn test
|
||||||
- run: yarn test:keycloakify-starter
|
#- run: yarn test:keycloakify-starter
|
||||||
|
|
||||||
storybook:
|
storybook:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@ -74,7 +77,6 @@ jobs:
|
|||||||
id: step1
|
id: step1
|
||||||
with:
|
with:
|
||||||
action_name: is_package_json_version_upgraded
|
action_name: is_package_json_version_upgraded
|
||||||
branch: ${{ github.head_ref || github.ref }}
|
|
||||||
|
|
||||||
create_github_release:
|
create_github_release:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
3
.gitignore
vendored
3
.gitignore
vendored
@ -53,8 +53,9 @@ jspm_packages
|
|||||||
|
|
||||||
# VS Code devcontainers
|
# VS Code devcontainers
|
||||||
.devcontainer
|
.devcontainer
|
||||||
|
/.yarn
|
||||||
|
/.yarnrc.yml
|
||||||
|
|
||||||
/stories/assets/fonts/
|
/stories/assets/fonts/
|
||||||
/.storybook/static/keycloak_static/
|
|
||||||
/build_storybook/
|
/build_storybook/
|
||||||
/storybook-static/
|
/storybook-static/
|
||||||
|
@ -8,9 +8,8 @@ node_modules/
|
|||||||
/.vscode/
|
/.vscode/
|
||||||
/src/login/i18n/baseMessages/
|
/src/login/i18n/baseMessages/
|
||||||
/src/account/i18n/baseMessages/
|
/src/account/i18n/baseMessages/
|
||||||
# Test Build Directories
|
|
||||||
/dist_test
|
/dist_test
|
||||||
/sample_react_project/
|
/sample_react_project/
|
||||||
/sample_custom_react_project/
|
/sample_custom_react_project/
|
||||||
/keycloakify_starter_test/
|
/keycloakify_starter_test/
|
||||||
/.storybook/static/keycloak_static/
|
/.storybook/static/keycloak-resources/
|
@ -3,8 +3,9 @@ import React from "react";
|
|||||||
import { DocsContainer as BaseContainer } from "@storybook/addon-docs";
|
import { DocsContainer as BaseContainer } from "@storybook/addon-docs";
|
||||||
import { useDarkMode } from "storybook-dark-mode";
|
import { useDarkMode } from "storybook-dark-mode";
|
||||||
import { darkTheme, lightTheme } from "./customTheme";
|
import { darkTheme, lightTheme } from "./customTheme";
|
||||||
|
import "./static/fonts/WorkSans/font.css";
|
||||||
|
|
||||||
export const DocsContainer = ({ children, context }) => {
|
export function DocsContainer({ children, context }) {
|
||||||
const isStorybookUiDark = useDarkMode();
|
const isStorybookUiDark = useDarkMode();
|
||||||
|
|
||||||
const theme = isStorybookUiDark ? darkTheme : lightTheme;
|
const theme = isStorybookUiDark ? darkTheme : lightTheme;
|
||||||
@ -15,7 +16,7 @@ export const DocsContainer = ({ children, context }) => {
|
|||||||
<>
|
<>
|
||||||
<style>{`
|
<style>{`
|
||||||
body {
|
body {
|
||||||
padding: 0 !important,
|
padding: 0 !important;
|
||||||
background-color: ${backgroundColor};
|
background-color: ${backgroundColor};
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -57,4 +58,19 @@ export const DocsContainer = ({ children, context }) => {
|
|||||||
</BaseContainer>
|
</BaseContainer>
|
||||||
</>
|
</>
|
||||||
);
|
);
|
||||||
};
|
}
|
||||||
|
|
||||||
|
export function CanvasContainer({ children }) {
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<style>{`
|
||||||
|
body {
|
||||||
|
padding: 0 !important;
|
||||||
|
}
|
||||||
|
`}</style>
|
||||||
|
{children}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
|
||||||
|
}
|
@ -1,8 +1,6 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
"stories": [
|
"stories": [
|
||||||
"../stories/*.stories.mdx",
|
"../stories/**/*.stories.@(ts|tsx|mdx)"
|
||||||
"../stories/*.stories.@(ts|tsx)",
|
|
||||||
"../stories/**/*.stories.@(ts|tsx)"
|
|
||||||
],
|
],
|
||||||
"addons": [
|
"addons": [
|
||||||
"@storybook/addon-links",
|
"@storybook/addon-links",
|
||||||
|
6
.storybook/manager.js
Normal file
6
.storybook/manager.js
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
import { addons } from '@storybook/addons';
|
||||||
|
|
||||||
|
addons.setConfig({
|
||||||
|
"selectedPanel": 'storybook/a11y/panel',
|
||||||
|
"showPanel": false,
|
||||||
|
});
|
@ -1,5 +1,5 @@
|
|||||||
import { darkTheme, lightTheme } from "./customTheme";
|
import { darkTheme, lightTheme } from "./customTheme";
|
||||||
import { DocsContainer } from "./DocsContainer";
|
import { DocsContainer, CanvasContainer } from "./Containers";
|
||||||
|
|
||||||
export const parameters = {
|
export const parameters = {
|
||||||
"actions": { "argTypesRegex": "^on[A-Z].*" },
|
"actions": { "argTypesRegex": "^on[A-Z].*" },
|
||||||
@ -17,6 +17,12 @@ export const parameters = {
|
|||||||
"docs": {
|
"docs": {
|
||||||
"container": DocsContainer
|
"container": DocsContainer
|
||||||
},
|
},
|
||||||
|
"controls": {
|
||||||
|
"disable": true,
|
||||||
|
},
|
||||||
|
"actions": {
|
||||||
|
"disable": true
|
||||||
|
},
|
||||||
"viewport": {
|
"viewport": {
|
||||||
"viewports": {
|
"viewports": {
|
||||||
"1440p": {
|
"1440p": {
|
||||||
@ -68,7 +74,7 @@ export const parameters = {
|
|||||||
"height": "844px",
|
"height": "844px",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
"iphone5se":{
|
"iphone5se": {
|
||||||
"name": "Iphone 5/SE",
|
"name": "Iphone 5/SE",
|
||||||
"styles": {
|
"styles": {
|
||||||
"width": "320px",
|
"width": "320px",
|
||||||
@ -97,16 +103,23 @@ export const parameters = {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const decorators = [
|
||||||
|
(Story) => (
|
||||||
|
<CanvasContainer>
|
||||||
|
<Story />
|
||||||
|
</CanvasContainer>
|
||||||
|
),
|
||||||
|
];
|
||||||
|
|
||||||
const { getHardCodedWeight } = (() => {
|
const { getHardCodedWeight } = (() => {
|
||||||
|
|
||||||
const orderedPagesPrefix = [
|
const orderedPagesPrefix = [
|
||||||
"Introduction",
|
"Introduction",
|
||||||
//"components/Header",
|
"login/login.ftl",
|
||||||
//"components/Footer",
|
"login/register-user-profile.ftl",
|
||||||
"components/Alert",
|
"login/register.ftl",
|
||||||
"components/Tabs",
|
"login/terms.ftl",
|
||||||
"components/Stepper",
|
"login/error.ftl",
|
||||||
"components/Button",
|
|
||||||
];
|
];
|
||||||
|
|
||||||
function getHardCodedWeight(kind) {
|
function getHardCodedWeight(kind) {
|
||||||
|
@ -1 +1 @@
|
|||||||
react-dsfr-components.etalab.studio
|
storybook.keycloakify.dev
|
138
README.md
138
README.md
@ -20,7 +20,7 @@
|
|||||||
<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>
|
||||||
<a href="https://discord.gg/rBzsYtUn">
|
<a href="https://discord.gg/kYFZG7fQmn">
|
||||||
<img src="https://img.shields.io/discord/1097708346976505977"/>
|
<img src="https://img.shields.io/discord/1097708346976505977"/>
|
||||||
</a>
|
</a>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
@ -28,38 +28,50 @@
|
|||||||
-
|
-
|
||||||
<a href="https://docs.keycloakify.dev">Documentation</a>
|
<a href="https://docs.keycloakify.dev">Documentation</a>
|
||||||
-
|
-
|
||||||
<a href="https://storybook.keycloakify.dev/storybook">Storybook</a>
|
<a href="https://storybook.keycloakify.dev">Storybook</a>
|
||||||
-
|
-
|
||||||
<a href="https://github.com/codegouvfr/keycloakify-starter">Starter project</a>
|
<a href="https://github.com/codegouvfr/keycloakify-starter">Starter project</a>
|
||||||
</p>
|
</p>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<i>Ultimately this build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
|
<i>This build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
|
||||||
<img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">
|
<br/>
|
||||||
|
<br/>
|
||||||
|
<img width="400" src="https://github.com/keycloakify/keycloakify/assets/6702424/e66d105c-c06f-47d1-8a31-a6ab09da4e80">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
Keycloakify is fully compatible with Keycloak 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, [~~22~~](https://github.com/keycloakify/keycloakify/issues/389#issuecomment-1822509763), **23** [and up](https://github.com/keycloakify/keycloakify/discussions/346#discussioncomment-5889791)!
|
||||||
|
|
||||||
## Sponsor 👼
|
## Sponsor 👼
|
||||||
|
|
||||||
We are exclusively sponsored by [Cloud IAM](https://www.cloud-iam.com), 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.
|
||||||
|
|
||||||
[Cloud IAM](https://www.cloud-iam.com/) provides the following services:
|
[Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github) provides the following services:
|
||||||
|
|
||||||
- Perfectly configured and optimized Keycloak IAM, ready in seconds.
|
- Simplify and secure your Keycloak Identity and Access Management. Keycloak as a Service.
|
||||||
- Custom theme building for your brand using Keycloakify.
|
- Custom theme building for your brand using Keycloakify.
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
</div>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://www.cloud-iam.com/">
|
<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>
|
||||||
<img src="https://user-images.githubusercontent.com/6702424/232165752-17134e68-4a55-4d6e-8672-e9132ecac5d5.svg" alt="Cloud IAM Logo" width="200"/>
|
|
||||||
</a>
|
|
||||||
<br/>
|
|
||||||
<i>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://www.cloud-iam.com/), for your support!
|
Thank you, [Cloud IAM](https://cloud-iam.com/?mtm_campaign=keycloakify-deal&mtm_source=keycloakify-github), for your support!
|
||||||
|
|
||||||
## Contributors ✨
|
## Contributors ✨
|
||||||
|
|
||||||
@ -86,7 +98,22 @@ 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/lazToum"><img src="https://avatars.githubusercontent.com/u/4764837?v=4?s=100" width="100px;" alt="Lazaros Toumanidis"/><br /><sub><b>Lazaros Toumanidis</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=lazToum" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lazToum"><img src="https://avatars.githubusercontent.com/u/4764837?v=4?s=100" width="100px;" alt="Lazaros Toumanidis"/><br /><sub><b>Lazaros Toumanidis</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=lazToum" title="Code">💻</a></td>
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/marcmrf"><img src="https://avatars.githubusercontent.com/u/9928519?v=4?s=100" width="100px;" alt="Marc"/><br /><sub><b>Marc</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=marcmrf" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/marcmrf"><img src="https://avatars.githubusercontent.com/u/9928519?v=4?s=100" width="100px;" alt="Marc"/><br /><sub><b>Marc</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=marcmrf" title="Code">💻</a></td>
|
||||||
<td align="center" valign="top" width="14.28%"><a href="http://kasir-barati.github.io"><img src="https://avatars.githubusercontent.com/u/73785723?v=4?s=100" width="100px;" alt="Kasir Barati"/><br /><sub><b>Kasir Barati</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kasir-barati" title="Documentation">📖</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="http://kasir-barati.github.io"><img src="https://avatars.githubusercontent.com/u/73785723?v=4?s=100" width="100px;" alt="Kasir Barati"/><br /><sub><b>Kasir Barati</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kasir-barati" title="Documentation">📖</a></td>
|
||||||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/asashay"><img src="https://avatars.githubusercontent.com/u/10714670?v=4?s=100" width="100px;" alt="Alex Oliynyk"/><br /><sub><b>Alex Oliynyk</b></sub></a><br /> <a href="https://github.com/keycloakify/keycloakify/commits?author=asashay" title="Code">💻</a></td>
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/asashay"><img src="https://avatars.githubusercontent.com/u/10714670?v=4?s=100" width="100px;" alt="Alex Oliynyk"/><br /><sub><b>Alex Oliynyk</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=asashay" title="Code">💻</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://www.gravitysoftware.be"><img src="https://avatars.githubusercontent.com/u/1140574?v=4?s=100" width="100px;" alt="Thomas Silvestre"/><br /><sub><b>Thomas Silvestre</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=thosil" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/satanshiro"><img src="https://avatars.githubusercontent.com/u/38865738?v=4?s=100" width="100px;" alt="satanshiro"/><br /><sub><b>satanshiro</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=satanshiro" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://poelhekke.dev"><img src="https://avatars.githubusercontent.com/u/1632377?v=4?s=100" width="100px;" alt="Koen Poelhekke"/><br /><sub><b>Koen Poelhekke</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=kpoelhekke" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/zavoloklom"><img src="https://avatars.githubusercontent.com/u/4151869?v=4?s=100" width="100px;" alt="Sergey Kupletsky"/><br /><sub><b>Sergey Kupletsky</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=zavoloklom" title="Tests">⚠️</a> <a href="https://github.com/keycloakify/keycloakify/commits?author=zavoloklom" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rome-user"><img src="https://avatars.githubusercontent.com/u/114131048?v=4?s=100" width="100px;" alt="rome-user"/><br /><sub><b>rome-user</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=rome-user" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/celinepelletier"><img src="https://avatars.githubusercontent.com/u/82821620?v=4?s=100" width="100px;" alt="Céline Pelletier"/><br /><sub><b>Céline Pelletier</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=celinepelletier" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/xgp"><img src="https://avatars.githubusercontent.com/u/244253?v=4?s=100" width="100px;" alt="Garth"/><br /><sub><b>Garth</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=xgp" title="Code">💻</a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/BlackVoid"><img src="https://avatars.githubusercontent.com/u/673720?v=4?s=100" width="100px;" alt="Felix Gustavsson"/><br /><sub><b>Felix Gustavsson</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=BlackVoid" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://m-siemens.de/"><img src="https://avatars.githubusercontent.com/u/1873922?v=4?s=100" width="100px;" alt="Markus Siemens"/><br /><sub><b>Markus Siemens</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=msiemens" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/law108000"><img src="https://avatars.githubusercontent.com/u/8112024?v=4?s=100" width="100px;" alt="Rlok"/><br /><sub><b>Rlok</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=law108000" title="Code">💻</a></td>
|
||||||
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Moulyy"><img src="https://avatars.githubusercontent.com/u/115405804?v=4?s=100" width="100px;" alt="Moulyy"/><br /><sub><b>Moulyy</b></sub></a><br /><a href="https://github.com/keycloakify/keycloakify/commits?author=Moulyy" title="Code">💻</a></td>
|
||||||
</tr>
|
</tr>
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
@ -96,9 +123,58 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|||||||
|
|
||||||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
||||||
|
|
||||||
## Changelog highlights
|
# Changelog highlights
|
||||||
|
|
||||||
## 7.7
|
## 9.0
|
||||||
|
|
||||||
|
Bring back support for account themes in Keycloak v23 and up! [See issue](https://github.com/keycloakify/keycloakify/issues/389).
|
||||||
|
|
||||||
|
### Breaking changes
|
||||||
|
|
||||||
|
Very few. Check them out [here](https://docs.keycloakify.dev/migration-guides/v8-greater-than-v9).
|
||||||
|
|
||||||
|
## 8.0
|
||||||
|
|
||||||
|
- Much smaller .jar size. 70.2 MB -> 7.8 MB.
|
||||||
|
Keycloakify now detects which of the static resources from the default theme are actually used by your theme and only include those in the .jar.
|
||||||
|
- Build time: The first build is slowed but the subsequent build are faster. [Update your CI so that the cache is persisted across CI build](https://github.com/keycloakify/keycloakify-starter/commit/bc378d5afb67e796f520afbc348185f3e319d9d0).
|
||||||
|
|
||||||
|
### Breaking changes
|
||||||
|
|
||||||
|
There are very few breaking changes in this major version. [Check them out](https://docs.keycloakify.dev/migration-guides/v7-greater-than-v8).
|
||||||
|
|
||||||
|
## 7.15
|
||||||
|
|
||||||
|
- The i18n messages you defines in your theme are now also maid available to Keycloak.
|
||||||
|
In practice this mean that you can now customize the `kcContext.message.summary` that
|
||||||
|
display a general alert and the values returned by `kcContext.messagesPerField.get()` that
|
||||||
|
are used to display specific error on some field of the form.
|
||||||
|
[See video](https://youtu.be/D6tZcemReTI)
|
||||||
|
|
||||||
|
## 7.14
|
||||||
|
|
||||||
|
- Deprecate the `extraPages` build option. Keycloakify is now able to analyze your code to detect extra pages.
|
||||||
|
|
||||||
|
## 7.13
|
||||||
|
|
||||||
|
- Deprecate `customUserAttribute`, Keycloakify now analyze your code to predict field name usage. [See doc](https://docs.keycloakify.dev/build-options#customuserattributes).
|
||||||
|
It's now mandatory to [adopt the new directory structure](https://docs.keycloakify.dev/migration-guides/v6-greater-than-v7).
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
There is now an idiomatic way of achieving the same result. [Learn more](https://docs.keycloakify.dev/build-options#keycloakify.themeVariantNames).
|
||||||
|
|
||||||
|
## 7.9
|
||||||
|
|
||||||
|
- Separate script for copying the default theme static assets to the public directory.
|
||||||
|
Theses assets are only needed for testing your theme locally in Storybook or with a `mockPageId`.
|
||||||
|
You are now expected to have a `"prepare": "copy-keycloak-resources-to-public",` in your package.json scripts.
|
||||||
|
This script will create `public/keycloak-assets` when you run `yarn install` (If you are using another package manager
|
||||||
|
like `pnpm` makes sure that `"prepare"` is actually ran.)
|
||||||
|
[See the updated starter](https://github.com/keycloakify/keycloakify-starter/blob/94532fcf10bf8b19e0873be8575fd28a8958a806/package.json#L11). `public/keycloak-assets` shouldn't be tracked by GIT and is automatically ignored.
|
||||||
|
|
||||||
|
## 7.7
|
||||||
|
|
||||||
- Better storybook support, see [the starter project](https://github.com/keycloakify/keycloakify-starter).
|
- Better storybook support, see [the starter project](https://github.com/keycloakify/keycloakify-starter).
|
||||||
|
|
||||||
@ -182,79 +258,79 @@ Checkout [the migration guide](https://docs.keycloakify.dev/v5-to-v6)
|
|||||||
|
|
||||||
Fix `login-verify-email.ftl` page. [Before](https://user-images.githubusercontent.com/6702424/177436014-0bad22c4-5bfb-45bb-8fc9-dad65143cd0c.png) - [After](https://user-images.githubusercontent.com/6702424/177435797-ec5d7db3-84cf-49cb-8efc-3427a81f744e.png)
|
Fix `login-verify-email.ftl` page. [Before](https://user-images.githubusercontent.com/6702424/177436014-0bad22c4-5bfb-45bb-8fc9-dad65143cd0c.png) - [After](https://user-images.githubusercontent.com/6702424/177435797-ec5d7db3-84cf-49cb-8efc-3427a81f744e.png)
|
||||||
|
|
||||||
## v5.6.0
|
## 5.6.0
|
||||||
|
|
||||||
Add support for `login-config-totp.ftl` page [#127](https://github.com/keycloakify/keycloakify/pull/127).
|
Add support for `login-config-totp.ftl` page [#127](https://github.com/keycloakify/keycloakify/pull/127).
|
||||||
|
|
||||||
## v5.3.0
|
## 5.3.0
|
||||||
|
|
||||||
Rename `keycloak_theme_email` to `keycloak_email`.
|
Rename `keycloak_theme_email` to `keycloak_email`.
|
||||||
If you already had a `keycloak_theme_email` you should rename it `keycloak_email`.
|
If you already had a `keycloak_theme_email` you should rename it `keycloak_email`.
|
||||||
|
|
||||||
## v5.0.0
|
## 5.0.0
|
||||||
|
|
||||||
[Migration guide](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63)
|
[Migration guide](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63)
|
||||||
New i18n system.
|
New i18n system.
|
||||||
Import of terms and services have changed. [See example](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63).
|
Import of terms and services have changed. [See example](https://github.com/garronej/keycloakify-demo-app/blob/a5b6a50f24bc25e082931f5ad9ebf47492acd12a/src/index.tsx#L46-L63).
|
||||||
|
|
||||||
## v4.10.0
|
## 4.10.0
|
||||||
|
|
||||||
Add `login-idp-link-email.ftl` page [See PR](https://github.com/keycloakify/keycloakify/pull/92).
|
Add `login-idp-link-email.ftl` page [See PR](https://github.com/keycloakify/keycloakify/pull/92).
|
||||||
|
|
||||||
## v4.8.0
|
## 4.8.0
|
||||||
|
|
||||||
[Email template customization.](#email-template-customization)
|
[Email template customization.](#email-template-customization)
|
||||||
|
|
||||||
## v4.7.4
|
## 4.7.4
|
||||||
|
|
||||||
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
||||||
|
|
||||||
## v4.7.2
|
## 4.7.2
|
||||||
|
|
||||||
> WARNING: This is broken.
|
> WARNING: This is broken.
|
||||||
> Testing with local Keycloak container working with M1 Mac. Thanks to [@eduardosanzb](https://github.com/keycloakify/keycloakify/issues/43#issuecomment-975699658).
|
> Testing with local Keycloak container working with M1 Mac. Thanks to [@eduardosanzb](https://github.com/keycloakify/keycloakify/issues/43#issuecomment-975699658).
|
||||||
> Be aware: When running M1s you are testing with Keycloak v15 else the local container spun will be a Keycloak v16.1.0.
|
> Be aware: When running M1s you are testing with Keycloak v15 else the local container spun will be a Keycloak v16.1.0.
|
||||||
|
|
||||||
## v4.7.0
|
## 4.7.0
|
||||||
|
|
||||||
Register with user profile enabled: Out of the box `options` validator support.
|
Register with user profile enabled: Out of the box `options` validator support.
|
||||||
[Example](https://user-images.githubusercontent.com/6702424/158911163-81e6bbe8-feb0-4dc8-abff-de199d7a678e.mov)
|
[Example](https://user-images.githubusercontent.com/6702424/158911163-81e6bbe8-feb0-4dc8-abff-de199d7a678e.mov)
|
||||||
|
|
||||||
## v4.6.0
|
## 4.6.0
|
||||||
|
|
||||||
`tss-react` and `powerhooks` are no longer peer dependencies of `keycloakify`.
|
`tss-react` and `powerhooks` are no longer peer dependencies of `keycloakify`.
|
||||||
After updating Keycloakify you can remove `tss-react` and `powerhooks` from your dependencies if you don't use them explicitly.
|
After updating Keycloakify you can remove `tss-react` and `powerhooks` from your dependencies if you don't use them explicitly.
|
||||||
|
|
||||||
## v4.5.3
|
## 4.5.3
|
||||||
|
|
||||||
There is a new recommended way to setup highly customized theme. See [here](https://github.com/garronej/keycloakify-demo-app/blob/look_and_feel/src/KcApp/KcApp.tsx).
|
There is a new recommended way to setup highly customized theme. See [here](https://github.com/garronej/keycloakify-demo-app/blob/look_and_feel/src/KcApp/KcApp.tsx).
|
||||||
Unlike with [the previous recommended method](https://github.com/garronej/keycloakify-demo-app/blob/a51660578bea15fb3e506b8a2b78e1056c6d68bb/src/KcApp/KcApp.tsx),
|
Unlike with [the previous recommended method](https://github.com/garronej/keycloakify-demo-app/blob/a51660578bea15fb3e506b8a2b78e1056c6d68bb/src/KcApp/KcApp.tsx),
|
||||||
with this new method your theme wont break on minor Keycloakify update.
|
with this new method your theme wont break on minor Keycloakify update.
|
||||||
|
|
||||||
## v4.3.0
|
## 4.3.0
|
||||||
|
|
||||||
Feature [`login-update-password.ftl`](https://user-images.githubusercontent.com/6702424/147517600-6191cf72-93dd-437b-a35c-47180142063e.png).
|
Feature [`login-update-password.ftl`](https://user-images.githubusercontent.com/6702424/147517600-6191cf72-93dd-437b-a35c-47180142063e.png).
|
||||||
Every time a page is added it's a breaking change for non CSS-only theme.
|
Every time a page is added it's a breaking change for non CSS-only theme.
|
||||||
Change [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L17) and [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L37) to update.
|
Change [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L17) and [this](https://github.com/garronej/keycloakify-demo-app/blob/df664c13c77ce3c53ac7df0622d94d04e76d3f9f/src/KcApp/KcApp.tsx#L37) to update.
|
||||||
|
|
||||||
## v4
|
## 4
|
||||||
|
|
||||||
- Out of the box [frontend form validation](#user-profile-and-frontend-form-validation) 🥳
|
- Out of the box [frontend form validation](#user-profile-and-frontend-form-validation) 🥳
|
||||||
- Improvements (and breaking changes in `import { useKcMessage } from "keycloakify"`.
|
- Improvements (and breaking changes in `import { useKcMessage } from "keycloakify"`.
|
||||||
|
|
||||||
## v3
|
## 3
|
||||||
|
|
||||||
No breaking changes except that `@emotion/react`, [`tss-react`](https://www.npmjs.com/package/tss-react) and [`powerhooks`](https://www.npmjs.com/package/powerhooks) are now `peerDependencies` instead of being just dependencies.
|
No breaking changes except that `@emotion/react`, [`tss-react`](https://www.npmjs.com/package/tss-react) and [`powerhooks`](https://www.npmjs.com/package/powerhooks) are now `peerDependencies` instead of being just dependencies.
|
||||||
It's important to avoid problem when using `keycloakify` alongside [`mui`](https://mui.com) and
|
It's important to avoid problem when using `keycloakify` alongside [`mui`](https://mui.com) and
|
||||||
[when passing params from the app to the login page](https://github.com/keycloakify/keycloakify#implement-context-persistence-optional).
|
[when passing params from the app to the login page](https://github.com/keycloakify/keycloakify#implement-context-persistence-optional).
|
||||||
|
|
||||||
## v2.5
|
## 2.5
|
||||||
|
|
||||||
- Feature [Use advanced message](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
|
- Feature [Use advanced message](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/i18n/useKcMessage.tsx#L53-L66)
|
||||||
and [`messagesPerFields`](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
|
and [`messagesPerFields`](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/lib/getKcContext/KcContextBase.ts#L70-L75) (implementation [here](https://github.com/keycloakify/keycloakify/blob/59f106bf9e210b63b190826da2bf5f75fc8b7644/src/bin/build-keycloak-theme/generateFtl/common.ftl#L130-L189))
|
||||||
- Test container now uses Keycloak version `15.0.2`.
|
- Test container now uses Keycloak version `15.0.2`.
|
||||||
|
|
||||||
## v2
|
## 2
|
||||||
|
|
||||||
- It's now possible to implement custom `.ftl` pages.
|
- It's now possible to implement custom `.ftl` pages.
|
||||||
- Support for Keycloak plugins that introduce non standard ftl values.
|
- Support for Keycloak plugins that introduce non standard ftl values.
|
||||||
|
@ -1,91 +0,0 @@
|
|||||||
{
|
|
||||||
"allOf": [
|
|
||||||
{
|
|
||||||
"$ref": "https://json.schemastore.org/package.json"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"$ref": "keycloakifyPackageJsonSchema"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"$ref": "#/definitions/keycloakifyPackageJsonSchema",
|
|
||||||
"definitions": {
|
|
||||||
"keycloakifyPackageJsonSchema": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"version": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"homepage": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"keycloakify": {
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"extraPages": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"extraLoginPages": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"extraAccountPages": {
|
|
||||||
"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"
|
|
||||||
},
|
|
||||||
"customUserAttributes": {
|
|
||||||
"type": "array",
|
|
||||||
"items": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"themeName": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": ["name", "version"],
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema#"
|
|
||||||
}
|
|
33
package.json
33
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "keycloakify",
|
"name": "keycloakify",
|
||||||
"version": "7.7.2",
|
"version": "9.1.11",
|
||||||
"description": "Create Keycloak themes using React",
|
"description": "Create Keycloak themes using React",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@ -9,12 +9,11 @@
|
|||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/index.d.ts",
|
"types": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"prepare": "yarn generate-i18n-messages && yarn setup-keycloak-static-assets-for-storybook",
|
"prepare": "yarn generate-i18n-messages",
|
||||||
"build": "rimraf dist/ && tsc -p src/bin && tsc -p src && tsc-alias -p src/tsconfig.json && yarn grant-exec-perms && yarn copy-files dist/",
|
"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/",
|
||||||
"watch-in-starter": "yarn build && yarn link-in-starter && (concurrently \"tsc -p src -w\" \"tsc-alias -p src/tsconfig.json\" \"tsc -p src/bin -w\")",
|
|
||||||
"generate:json-schema": "ts-node scripts/generate-json-schema.ts",
|
"generate:json-schema": "ts-node scripts/generate-json-schema.ts",
|
||||||
"grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
|
"grant-exec-perms": "node dist/bin/tools/grant-exec-perms.js",
|
||||||
"copy-files": "copyfiles -u 1 src/**/*.ftl",
|
"copy-files": "copyfiles -u 1 src/**/*.ftl src/**/*.java",
|
||||||
"test": "yarn test:types && vitest run",
|
"test": "yarn test:types && vitest run",
|
||||||
"test:keycloakify-starter": "ts-node scripts/test-keycloakify-starter",
|
"test:keycloakify-starter": "ts-node scripts/test-keycloakify-starter",
|
||||||
"test:types": "tsc -p test/tsconfig.json --noEmit",
|
"test:types": "tsc -p test/tsconfig.json --noEmit",
|
||||||
@ -24,15 +23,17 @@
|
|||||||
"generate-i18n-messages": "ts-node --skipProject scripts/generate-i18n-messages.ts",
|
"generate-i18n-messages": "ts-node --skipProject scripts/generate-i18n-messages.ts",
|
||||||
"link-in-app": "ts-node --skipProject scripts/link-in-app.ts",
|
"link-in-app": "ts-node --skipProject scripts/link-in-app.ts",
|
||||||
"link-in-starter": "yarn link-in-app keycloakify-starter",
|
"link-in-starter": "yarn link-in-app keycloakify-starter",
|
||||||
"storybook": "start-storybook -p 6006",
|
"watch-in-starter": "yarn build && yarn link-in-starter && (concurrently \"tsc -p src -w\" \"tsc-alias -p src/tsconfig.json\" \"tsc -p src/bin -w\")",
|
||||||
"build-storybook": "build-storybook",
|
"copy-keycloak-resources-to-storybook-static": "PUBLIC_DIR_PATH=.storybook/static node dist/bin/copy-keycloak-resources-to-public.js",
|
||||||
"setup-keycloak-static-assets-for-storybook": "ts-node --skipProject scripts/setup-keycloak-static-assets-for-storybook.ts"
|
"storybook": "yarn build && yarn copy-keycloak-resources-to-storybook-static && start-storybook -p 6006",
|
||||||
|
"build-storybook": "yarn build && yarn copy-keycloak-resources-to-storybook-static && build-storybook"
|
||||||
},
|
},
|
||||||
"bin": {
|
"bin": {
|
||||||
"keycloakify": "dist/bin/keycloakify/index.js",
|
"copy-keycloak-resources-to-public": "dist/bin/copy-keycloak-resources-to-public.js",
|
||||||
"initialize-email-theme": "dist/bin/initialize-email-theme.js",
|
|
||||||
"download-builtin-keycloak-theme": "dist/bin/download-builtin-keycloak-theme.js",
|
"download-builtin-keycloak-theme": "dist/bin/download-builtin-keycloak-theme.js",
|
||||||
"eject-keycloak-page": "dist/bin/eject-keycloak-page.js"
|
"eject-keycloak-page": "dist/bin/eject-keycloak-page.js",
|
||||||
|
"initialize-email-theme": "dist/bin/initialize-email-theme.js",
|
||||||
|
"keycloakify": "dist/bin/keycloakify/index.js"
|
||||||
},
|
},
|
||||||
"lint-staged": {
|
"lint-staged": {
|
||||||
"*.{ts,tsx,json,md}": [
|
"*.{ts,tsx,json,md}": [
|
||||||
@ -68,6 +69,7 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@babel/core": "^7.0.0",
|
"@babel/core": "^7.0.0",
|
||||||
|
"@emotion/react": "^11.10.6",
|
||||||
"@storybook/addon-a11y": "^6.5.16",
|
"@storybook/addon-a11y": "^6.5.16",
|
||||||
"@storybook/addon-actions": "^6.5.13",
|
"@storybook/addon-actions": "^6.5.13",
|
||||||
"@storybook/addon-essentials": "^6.5.13",
|
"@storybook/addon-essentials": "^6.5.13",
|
||||||
@ -77,17 +79,20 @@
|
|||||||
"@storybook/manager-webpack5": "^6.5.13",
|
"@storybook/manager-webpack5": "^6.5.13",
|
||||||
"@storybook/react": "^6.5.13",
|
"@storybook/react": "^6.5.13",
|
||||||
"@storybook/testing-library": "^0.0.13",
|
"@storybook/testing-library": "^0.0.13",
|
||||||
|
"@types/babel__generator": "^7.6.4",
|
||||||
"@types/make-fetch-happen": "^10.0.1",
|
"@types/make-fetch-happen": "^10.0.1",
|
||||||
"@types/minimist": "^1.2.2",
|
"@types/minimist": "^1.2.2",
|
||||||
"@types/node": "^18.15.3",
|
"@types/node": "^18.15.3",
|
||||||
"@types/react": "^18.0.35",
|
"@types/react": "^18.0.35",
|
||||||
"@types/react-dom": "^18.0.11",
|
"@types/react-dom": "^18.0.11",
|
||||||
"@types/yauzl": "^2.10.0",
|
"@types/yauzl": "^2.10.0",
|
||||||
|
"@types/yazl": "^2.4.2",
|
||||||
"concurrently": "^8.0.1",
|
"concurrently": "^8.0.1",
|
||||||
"copyfiles": "^2.4.1",
|
"copyfiles": "^2.4.1",
|
||||||
"eslint-plugin-storybook": "^0.6.7",
|
"eslint-plugin-storybook": "^0.6.7",
|
||||||
"husky": "^4.3.8",
|
"husky": "^4.3.8",
|
||||||
"lint-staged": "^11.0.0",
|
"lint-staged": "^11.0.0",
|
||||||
|
"powerhooks": "^0.26.7",
|
||||||
"prettier": "^2.3.0",
|
"prettier": "^2.3.0",
|
||||||
"properties-parser": "^0.3.1",
|
"properties-parser": "^0.3.1",
|
||||||
"react": "^18.2.0",
|
"react": "^18.2.0",
|
||||||
@ -97,13 +102,16 @@
|
|||||||
"storybook-dark-mode": "^1.1.2",
|
"storybook-dark-mode": "^1.1.2",
|
||||||
"ts-node": "^10.9.1",
|
"ts-node": "^10.9.1",
|
||||||
"tsc-alias": "^1.8.3",
|
"tsc-alias": "^1.8.3",
|
||||||
|
"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"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@babel/generator": "^7.22.9",
|
||||||
|
"@babel/parser": "^7.22.7",
|
||||||
|
"@babel/types": "^7.22.5",
|
||||||
"@octokit/rest": "^18.12.0",
|
"@octokit/rest": "^18.12.0",
|
||||||
"@types/yazl": "^2.4.2",
|
|
||||||
"cheerio": "^1.0.0-rc.5",
|
"cheerio": "^1.0.0-rc.5",
|
||||||
"cli-select": "^1.1.2",
|
"cli-select": "^1.1.2",
|
||||||
"evt": "^2.4.18",
|
"evt": "^2.4.18",
|
||||||
@ -112,6 +120,7 @@
|
|||||||
"minimist": "^1.2.6",
|
"minimist": "^1.2.6",
|
||||||
"path-browserify": "^1.0.1",
|
"path-browserify": "^1.0.1",
|
||||||
"react-markdown": "^5.0.3",
|
"react-markdown": "^5.0.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",
|
||||||
|
@ -4,7 +4,6 @@ import { join as pathJoin, relative as pathRelative, dirname as pathDirname, sep
|
|||||||
import { crawl } from "../src/bin/tools/crawl";
|
import { crawl } from "../src/bin/tools/crawl";
|
||||||
import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../src/bin/download-builtin-keycloak-theme";
|
||||||
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
||||||
import { getCliOptions } from "../src/bin/tools/cliOptions";
|
|
||||||
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,
|
||||||
@ -13,11 +12,12 @@ import { getLogger } from "../src/bin/tools/logger";
|
|||||||
//@ts-ignore
|
//@ts-ignore
|
||||||
const propertiesParser = require("properties-parser");
|
const propertiesParser = require("properties-parser");
|
||||||
|
|
||||||
const { isSilent } = getCliOptions(process.argv.slice(2));
|
const isSilent = true;
|
||||||
|
|
||||||
const logger = getLogger({ isSilent });
|
const logger = getLogger({ isSilent });
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const keycloakVersion = "21.0.1";
|
const keycloakVersion = "23.0.4";
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
const tmpDirPath = pathJoin(getProjectRoot(), "tmp_xImOef9dOd44");
|
||||||
|
|
||||||
@ -26,7 +26,9 @@ async function main() {
|
|||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath,
|
||||||
isSilent
|
"buildOptions": {
|
||||||
|
"cacheDirPath": pathJoin(getProjectRoot(), "node_modules", ".cache", "keycloakify")
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
type Dictionary = { [idiomId: string]: string };
|
type Dictionary = { [idiomId: string]: string };
|
||||||
@ -37,7 +39,10 @@ async function main() {
|
|||||||
const baseThemeDirPath = pathJoin(tmpDirPath, "base");
|
const baseThemeDirPath = pathJoin(tmpDirPath, "base");
|
||||||
const re = new RegExp(`^([^\\${pathSep}]+)\\${pathSep}messages\\${pathSep}messages_([^.]+).properties$`);
|
const re = new RegExp(`^([^\\${pathSep}]+)\\${pathSep}messages\\${pathSep}messages_([^.]+).properties$`);
|
||||||
|
|
||||||
crawl(baseThemeDirPath).forEach(filePath => {
|
crawl({
|
||||||
|
"dirPath": baseThemeDirPath,
|
||||||
|
"returnedPathsType": "relative to dirPath"
|
||||||
|
}).forEach(filePath => {
|
||||||
const match = filePath.match(re);
|
const match = filePath.match(re);
|
||||||
|
|
||||||
if (match === null) {
|
if (match === null) {
|
||||||
|
@ -1,16 +0,0 @@
|
|||||||
import { downloadKeycloakStaticResources } from "../src/bin/keycloakify/generateTheme/downloadKeycloakStaticResources";
|
|
||||||
import { getProjectRoot } from "../src/bin/tools/getProjectRoot";
|
|
||||||
import { join as pathJoin } from "path";
|
|
||||||
import { mockTestingSubDirOfPublicDirBasename } from "../src/bin/mockTestingResourcesPath";
|
|
||||||
import { defaultKeycloakVersionDefaultAssets } from "../src/bin/keycloakify/BuildOptions";
|
|
||||||
|
|
||||||
(async () => {
|
|
||||||
await downloadKeycloakStaticResources({
|
|
||||||
"isSilent": false,
|
|
||||||
"keycloakVersion": defaultKeycloakVersionDefaultAssets,
|
|
||||||
"themeType": "login",
|
|
||||||
"themeDirPath": pathJoin(getProjectRoot(), ".storybook", "static", mockTestingSubDirOfPublicDirBasename)
|
|
||||||
});
|
|
||||||
|
|
||||||
console.log("Done");
|
|
||||||
})();
|
|
@ -17,10 +17,12 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
|
|
||||||
const { isReady } = usePrepareTemplate({
|
const { isReady } = usePrepareTemplate({
|
||||||
"doFetchDefaultThemeResources": doUseDefaultCss,
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
url,
|
"styles": [
|
||||||
"stylesCommon": ["node_modules/patternfly/dist/css/patternfly.min.css", "node_modules/patternfly/dist/css/patternfly-additions.min.css"],
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
"styles": ["css/account.css"],
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
"htmlClassName": undefined,
|
`${url.resourcesPath}/css/account.css`
|
||||||
|
],
|
||||||
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
"bodyClassName": clsx("admin-console", "user", getClassName("kcBodyClass"))
|
"bodyClassName": clsx("admin-console", "user", getClassName("kcBodyClass"))
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -60,7 +62,7 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
)}
|
)}
|
||||||
{referrer?.url !== undefined && (
|
{referrer?.url && (
|
||||||
<li>
|
<li>
|
||||||
<a href={referrer.url} id="referrer">
|
<a href={referrer.url} id="referrer">
|
||||||
{msg("backTo", referrer.name)}
|
{msg("backTo", referrer.name)}
|
||||||
|
@ -11,4 +11,4 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
children: ReactNode;
|
children: ReactNode;
|
||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey = "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
export type ClassKey = "kcHtmlClass" | "kcBodyClass" | "kcButtonClass" | "kcButtonPrimaryClass" | "kcButtonLargeClass" | "kcButtonDefaultClass";
|
||||||
|
@ -211,7 +211,9 @@ const keycloakifyExtraMessages = {
|
|||||||
"shouldBeDifferent": "{0} should be different to {1}",
|
"shouldBeDifferent": "{0} should be different to {1}",
|
||||||
"shouldMatchPattern": "Pattern should match: `/{0}/`",
|
"shouldMatchPattern": "Pattern should match: `/{0}/`",
|
||||||
"mustBeAnInteger": "Must be an integer",
|
"mustBeAnInteger": "Must be an integer",
|
||||||
"notAValidOption": "Not a valid option"
|
"notAValidOption": "Not a valid option",
|
||||||
|
"newPasswordSameAsOld": "New password must be different from the old one",
|
||||||
|
"passwordConfirmNotMatch": "Password confirmation does not match"
|
||||||
},
|
},
|
||||||
"fr": {
|
"fr": {
|
||||||
/* spell-checker: disable */
|
/* spell-checker: disable */
|
||||||
@ -223,7 +225,9 @@ const keycloakifyExtraMessages = {
|
|||||||
|
|
||||||
"logoutConfirmTitle": "Déconnexion",
|
"logoutConfirmTitle": "Déconnexion",
|
||||||
"logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
|
"logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
|
||||||
"doLogout": "Se déconnecter"
|
"doLogout": "Se déconnecter",
|
||||||
|
"newPasswordSameAsOld": "Le nouveau mot de passe doit être différent de l'ancien",
|
||||||
|
"passwordConfirmNotMatch": "La confirmation du mot de passe ne correspond pas"
|
||||||
/* spell-checker: enable */
|
/* spell-checker: enable */
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -4,6 +4,7 @@ export default Fallback;
|
|||||||
|
|
||||||
export { getKcContext } from "keycloakify/account/kcContext/getKcContext";
|
export { getKcContext } from "keycloakify/account/kcContext/getKcContext";
|
||||||
export { createGetKcContext } from "keycloakify/account/kcContext/createGetKcContext";
|
export { createGetKcContext } from "keycloakify/account/kcContext/createGetKcContext";
|
||||||
|
export type { AccountThemePageId as PageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
export { createUseI18n } from "keycloakify/account/i18n/i18n";
|
export { createUseI18n } from "keycloakify/account/i18n/i18n";
|
||||||
|
|
||||||
export type { PageProps } from "keycloakify/account/pages/PageProps";
|
export type { PageProps } from "keycloakify/account/pages/PageProps";
|
||||||
|
@ -1,12 +1,16 @@
|
|||||||
import type { AccountThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { AccountThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { Equals } from "tsafe";
|
import type { Equals } from "tsafe";
|
||||||
|
import { type ThemeType } from "keycloakify/bin/constants";
|
||||||
|
|
||||||
export type KcContext = KcContext.Password | KcContext.Account;
|
export type KcContext = KcContext.Password | KcContext.Account;
|
||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
|
themeVersion: string;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
|
themeType: "account";
|
||||||
|
themeName: string;
|
||||||
locale?: {
|
locale?: {
|
||||||
supported: {
|
supported: {
|
||||||
url: string;
|
url: string;
|
||||||
@ -26,6 +30,8 @@ export declare namespace KcContext {
|
|||||||
resourceUrl: string;
|
resourceUrl: string;
|
||||||
resourcesCommonPath: string;
|
resourcesCommonPath: string;
|
||||||
resourcesPath: string;
|
resourcesPath: string;
|
||||||
|
/** @deprecated, not present in recent keycloak version apparently, use kcContext.referrer instead */
|
||||||
|
referrerURI?: string;
|
||||||
getLogoutUrl: () => string;
|
getLogoutUrl: () => string;
|
||||||
};
|
};
|
||||||
features: {
|
features: {
|
||||||
@ -38,18 +44,44 @@ export declare namespace KcContext {
|
|||||||
internationalizationEnabled: boolean;
|
internationalizationEnabled: boolean;
|
||||||
userManagedAccessAllowed: boolean;
|
userManagedAccessAllowed: boolean;
|
||||||
};
|
};
|
||||||
|
// Present only if redirected to account page with ?referrer=xxx&referrer_uri=http...
|
||||||
message?: {
|
message?: {
|
||||||
type: "success" | "warning" | "error" | "info";
|
type: "success" | "warning" | "error" | "info";
|
||||||
summary: string;
|
summary: string;
|
||||||
};
|
};
|
||||||
referrer?: {
|
referrer?: {
|
||||||
url?: string;
|
url: string; // The url of the App
|
||||||
name: string;
|
name: string; // Client id
|
||||||
};
|
};
|
||||||
messagesPerField: {
|
messagesPerField: {
|
||||||
printIfExists: <T>(fieldName: string, x: T) => T | undefined;
|
/**
|
||||||
|
* Return text if message for given field exists. Useful eg. to add css styles for fields with message.
|
||||||
|
*
|
||||||
|
* @param fieldName to check for
|
||||||
|
* @param text to return
|
||||||
|
* @return text if message exists for given field, else undefined
|
||||||
|
*/
|
||||||
|
printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
|
||||||
|
/**
|
||||||
|
* Check if exists error message for given fields
|
||||||
|
*
|
||||||
|
* @param fields
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
existsError: (fieldName: string) => boolean;
|
existsError: (fieldName: string) => boolean;
|
||||||
|
/**
|
||||||
|
* Get message for given field.
|
||||||
|
*
|
||||||
|
* @param fieldName
|
||||||
|
* @return message text or empty string
|
||||||
|
*/
|
||||||
get: (fieldName: string) => string;
|
get: (fieldName: string) => string;
|
||||||
|
/**
|
||||||
|
* Check if message for given field exists
|
||||||
|
*
|
||||||
|
* @param field
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
exists: (fieldName: string) => boolean;
|
exists: (fieldName: string) => boolean;
|
||||||
};
|
};
|
||||||
account: {
|
account: {
|
||||||
@ -71,7 +103,6 @@ export declare namespace KcContext {
|
|||||||
export type Account = Common & {
|
export type Account = Common & {
|
||||||
pageId: "account.ftl";
|
pageId: "account.ftl";
|
||||||
url: {
|
url: {
|
||||||
referrerURI: string;
|
|
||||||
accountUrl: string;
|
accountUrl: string;
|
||||||
};
|
};
|
||||||
realm: {
|
realm: {
|
||||||
@ -82,4 +113,15 @@ export declare namespace KcContext {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
assert<Equals<KcContext["pageId"], AccountThemePageId>>();
|
{
|
||||||
|
type Got = KcContext["pageId"];
|
||||||
|
type Expected = AccountThemePageId;
|
||||||
|
|
||||||
|
type OnlyInGot = Exclude<Got, Expected>;
|
||||||
|
type OnlyInExpected = Exclude<Expected, Got>;
|
||||||
|
|
||||||
|
assert<Equals<OnlyInGot, never>>();
|
||||||
|
assert<Equals<OnlyInExpected, never>>();
|
||||||
|
}
|
||||||
|
|
||||||
|
assert<KcContext["themeType"] extends ThemeType ? true : false>();
|
||||||
|
@ -3,12 +3,9 @@ import { deepAssign } from "keycloakify/tools/deepAssign";
|
|||||||
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
||||||
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
import { pathBasename } from "keycloakify/tools/pathBasename";
|
|
||||||
import { mockTestingResourcesCommonPath } from "keycloakify/bin/mockTestingResourcesPath";
|
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
|
import { resources_common } from "keycloakify/bin/constants";
|
||||||
import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
|
import { kcContextMocks, kcContextCommonMock } from "keycloakify/account/kcContext/kcContextMocks";
|
||||||
import { id } from "tsafe/id";
|
|
||||||
import { accountThemePageIds } from "keycloakify/bin/keycloakify/generateFtl/pageId";
|
|
||||||
|
|
||||||
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>>[];
|
||||||
@ -30,13 +27,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
|
||||||
|
|
||||||
console.log(
|
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
||||||
[
|
|
||||||
`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`,
|
|
||||||
`If assets are missing make sure you have built your Keycloak theme at least once.`
|
|
||||||
].join(" "),
|
|
||||||
"background: red; color: yellow; font-size: medium"
|
|
||||||
);
|
|
||||||
|
|
||||||
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
||||||
|
|
||||||
@ -93,15 +84,11 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
if (id<readonly string[]>(accountThemePageIds).indexOf(realKcContext.pageId) < 0 && !("account" in realKcContext)) {
|
if (realKcContext.themeType !== "account") {
|
||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
realKcContext.url.resourcesCommonPath = pathJoin(realKcContext.url.resourcesPath, resources_common);
|
||||||
const { url } = realKcContext;
|
|
||||||
|
|
||||||
url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(mockTestingResourcesCommonPath));
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
@ -1,16 +1,21 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import { mockTestingResourcesCommonPath, mockTestingResourcesPath } from "keycloakify/bin/mockTestingResourcesPath";
|
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
import type { KcContext } from "./KcContext";
|
import type { KcContext } from "./KcContext";
|
||||||
|
|
||||||
const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
|
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
||||||
|
|
||||||
|
const resourcesPath = pathJoin(PUBLIC_URL, keycloak_resources, "account", "resources");
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
|
"themeVersion": "0.0.0",
|
||||||
"keycloakifyVersion": "0.0.0",
|
"keycloakifyVersion": "0.0.0",
|
||||||
|
"themeType": "account",
|
||||||
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
"resourcesPath": pathJoin(PUBLIC_URL, mockTestingResourcesPath),
|
resourcesPath,
|
||||||
"resourcesCommonPath": pathJoin(PUBLIC_URL, mockTestingResourcesCommonPath),
|
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
||||||
"resourceUrl": "#",
|
"resourceUrl": "#",
|
||||||
"accountUrl": "#",
|
"accountUrl": "#",
|
||||||
"applicationsUrl": "#",
|
"applicationsUrl": "#",
|
||||||
@ -130,10 +135,6 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
],
|
],
|
||||||
"currentLanguageTag": "en"
|
"currentLanguageTag": "en"
|
||||||
},
|
},
|
||||||
"message": {
|
|
||||||
"type": "success",
|
|
||||||
"summary": "This is a test message"
|
|
||||||
},
|
|
||||||
"features": {
|
"features": {
|
||||||
"authorization": true,
|
"authorization": true,
|
||||||
"identityFederation": true,
|
"identityFederation": true,
|
||||||
|
@ -3,6 +3,7 @@ import type { ClassKey } from "keycloakify/account/TemplateProps";
|
|||||||
|
|
||||||
export const { useGetClassName } = createUseClassName<ClassKey>({
|
export const { useGetClassName } = createUseClassName<ClassKey>({
|
||||||
"defaultClasses": {
|
"defaultClasses": {
|
||||||
|
"kcHtmlClass": undefined,
|
||||||
"kcBodyClass": undefined,
|
"kcBodyClass": undefined,
|
||||||
"kcButtonClass": "btn",
|
"kcButtonClass": "btn",
|
||||||
"kcButtonPrimaryClass": "btn-primary",
|
"kcButtonPrimaryClass": "btn-primary",
|
||||||
|
@ -4,7 +4,7 @@ import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
|||||||
import type { KcContext } from "../kcContext";
|
import type { KcContext } from "../kcContext";
|
||||||
import type { I18n } from "../i18n";
|
import type { I18n } from "../i18n";
|
||||||
|
|
||||||
export default function LogoutConfirm(props: PageProps<Extract<KcContext, { pageId: "account.ftl" }>, I18n>) {
|
export default function Account(props: PageProps<Extract<KcContext, { pageId: "account.ftl" }>, I18n>) {
|
||||||
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
|
|
||||||
const { getClassName } = useGetClassName({
|
const { getClassName } = useGetClassName({
|
||||||
@ -15,7 +15,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
const { url, realm, messagesPerField, stateChecker, account } = kcContext;
|
const { url, realm, messagesPerField, stateChecker, account, referrer } = kcContext;
|
||||||
|
|
||||||
const { msg } = i18n;
|
const { msg } = i18n;
|
||||||
|
|
||||||
@ -51,7 +51,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
id="username"
|
id="username"
|
||||||
name="username"
|
name="username"
|
||||||
disabled={!realm.editUsernameAllowed}
|
disabled={!realm.editUsernameAllowed}
|
||||||
value={account.username ?? ""}
|
defaultValue={account.username ?? ""}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@ -66,7 +66,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="text" className="form-control" id="email" name="email" autoFocus value={account.email ?? ""} />
|
<input type="text" className="form-control" id="email" name="email" autoFocus defaultValue={account.email ?? ""} />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -79,7 +79,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="text" className="form-control" id="firstName" name="firstName" value={account.firstName ?? ""} />
|
<input type="text" className="form-control" id="firstName" name="firstName" defaultValue={account.firstName ?? ""} />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -92,14 +92,14 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="text" className="form-control" id="lastName" name="lastName" value={account.lastName ?? ""} />
|
<input type="text" className="form-control" id="lastName" name="lastName" defaultValue={account.lastName ?? ""} />
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="form-group">
|
<div className="form-group">
|
||||||
<div id="kc-form-buttons" className="col-md-offset-2 col-md-10 submit">
|
<div id="kc-form-buttons" className="col-md-offset-2 col-md-10 submit">
|
||||||
<div>
|
<div>
|
||||||
{url.referrerURI !== undefined && <a href={url.referrerURI}>${msg("backToApplication")}</a>}
|
{referrer !== undefined && <a href={referrer?.url}>{msg("backToApplication")}</a>}
|
||||||
<button
|
<button
|
||||||
type="submit"
|
type="submit"
|
||||||
className={clsx(
|
className={clsx(
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import type { LazyExoticComponent } from "react";
|
|
||||||
import type { I18n } from "keycloakify/account/i18n";
|
import type { I18n } from "keycloakify/account/i18n";
|
||||||
import type { TemplateProps, ClassKey } from "keycloakify/account/TemplateProps";
|
import type { TemplateProps, ClassKey } from "keycloakify/account/TemplateProps";
|
||||||
|
import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
|
||||||
|
|
||||||
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
||||||
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
|
@ -1,10 +1,11 @@
|
|||||||
|
import { useState } from "react";
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
import type { PageProps } from "keycloakify/account/pages/PageProps";
|
||||||
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/account/lib/useGetClassName";
|
||||||
import type { KcContext } from "../kcContext";
|
import type { KcContext } from "../kcContext";
|
||||||
import type { I18n } from "../i18n";
|
import type { I18n } from "../i18n";
|
||||||
|
|
||||||
export default function LogoutConfirm(props: PageProps<Extract<KcContext, { pageId: "password.ftl" }>, I18n>) {
|
export default function Password(props: PageProps<Extract<KcContext, { pageId: "password.ftl" }>, I18n>) {
|
||||||
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
|
|
||||||
const { getClassName } = useGetClassName({
|
const { getClassName } = useGetClassName({
|
||||||
@ -17,10 +18,69 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
|
|
||||||
const { url, password, account, stateChecker } = kcContext;
|
const { url, password, account, stateChecker } = kcContext;
|
||||||
|
|
||||||
const { msg } = i18n;
|
const { msgStr, msg } = i18n;
|
||||||
|
|
||||||
|
const [currentPassword, setCurrentPassword] = useState("");
|
||||||
|
const [newPassword, setNewPassword] = useState("");
|
||||||
|
const [newPasswordConfirm, setNewPasswordConfirm] = useState("");
|
||||||
|
const [newPasswordError, setNewPasswordError] = useState("");
|
||||||
|
const [newPasswordConfirmError, setNewPasswordConfirmError] = useState("");
|
||||||
|
const [hasNewPasswordBlurred, setHasNewPasswordBlurred] = useState(false);
|
||||||
|
const [hasNewPasswordConfirmBlurred, setHasNewPasswordConfirmBlurred] = useState(false);
|
||||||
|
|
||||||
|
const checkNewPassword = (newPassword: string) => {
|
||||||
|
if (!password.passwordSet) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (newPassword === currentPassword) {
|
||||||
|
setNewPasswordError(msgStr("newPasswordSameAsOld"));
|
||||||
|
} else {
|
||||||
|
setNewPasswordError("");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const checkNewPasswordConfirm = (newPasswordConfirm: string) => {
|
||||||
|
if (newPasswordConfirm === "") {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (newPassword !== newPasswordConfirm) {
|
||||||
|
setNewPasswordConfirmError(msgStr("passwordConfirmNotMatch"));
|
||||||
|
} else {
|
||||||
|
setNewPasswordConfirmError("");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} active="password">
|
<Template
|
||||||
|
{...{
|
||||||
|
kcContext: {
|
||||||
|
...kcContext,
|
||||||
|
"message": (() => {
|
||||||
|
if (newPasswordError !== "") {
|
||||||
|
return {
|
||||||
|
"type": "error",
|
||||||
|
"summary": newPasswordError
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
if (newPasswordConfirmError !== "") {
|
||||||
|
return {
|
||||||
|
"type": "error",
|
||||||
|
"summary": newPasswordConfirmError
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return kcContext.message;
|
||||||
|
})()
|
||||||
|
},
|
||||||
|
i18n,
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
}}
|
||||||
|
active="password"
|
||||||
|
>
|
||||||
<div className="row">
|
<div className="row">
|
||||||
<div className="col-md-10">
|
<div className="col-md-10">
|
||||||
<h2>{msg("changePasswordHtmlTitle")}</h2>
|
<h2>{msg("changePasswordHtmlTitle")}</h2>
|
||||||
@ -48,9 +108,17 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
{msg("password")}
|
{msg("password")}
|
||||||
</label>
|
</label>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="password" className="form-control" id="password" name="password" autoFocus autoComplete="current-password" />
|
<input
|
||||||
|
type="password"
|
||||||
|
className="form-control"
|
||||||
|
id="password"
|
||||||
|
name="password"
|
||||||
|
autoFocus
|
||||||
|
autoComplete="current-password"
|
||||||
|
value={currentPassword}
|
||||||
|
onChange={event => setCurrentPassword(event.target.value)}
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
@ -63,9 +131,27 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
{msg("passwordNew")}
|
{msg("passwordNew")}
|
||||||
</label>
|
</label>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="password" className="form-control" id="password-new" name="password-new" autoComplete="new-password" />
|
<input
|
||||||
|
type="password"
|
||||||
|
className="form-control"
|
||||||
|
id="password-new"
|
||||||
|
name="password-new"
|
||||||
|
autoComplete="new-password"
|
||||||
|
value={newPassword}
|
||||||
|
onChange={event => {
|
||||||
|
const newPassword = event.target.value;
|
||||||
|
|
||||||
|
setNewPassword(newPassword);
|
||||||
|
if (hasNewPasswordBlurred) {
|
||||||
|
checkNewPassword(newPassword);
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
onBlur={() => {
|
||||||
|
setHasNewPasswordBlurred(true);
|
||||||
|
checkNewPassword(newPassword);
|
||||||
|
}}
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -77,7 +163,26 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="col-sm-10 col-md-10">
|
<div className="col-sm-10 col-md-10">
|
||||||
<input type="password" className="form-control" id="password-confirm" name="password-confirm" autoComplete="new-password" />
|
<input
|
||||||
|
type="password"
|
||||||
|
className="form-control"
|
||||||
|
id="password-confirm"
|
||||||
|
name="password-confirm"
|
||||||
|
autoComplete="new-password"
|
||||||
|
value={newPasswordConfirm}
|
||||||
|
onChange={event => {
|
||||||
|
const newPasswordConfirm = event.target.value;
|
||||||
|
|
||||||
|
setNewPasswordConfirm(newPasswordConfirm);
|
||||||
|
if (hasNewPasswordConfirmBlurred) {
|
||||||
|
checkNewPasswordConfirm(newPasswordConfirm);
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
onBlur={() => {
|
||||||
|
setHasNewPasswordConfirmBlurred(true);
|
||||||
|
checkNewPasswordConfirm(newPasswordConfirm);
|
||||||
|
}}
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@ -85,6 +190,7 @@ export default function LogoutConfirm(props: PageProps<Extract<KcContext, { page
|
|||||||
<div id="kc-form-buttons" className="col-md-offset-2 col-md-10 submit">
|
<div id="kc-form-buttons" className="col-md-offset-2 col-md-10 submit">
|
||||||
<div>
|
<div>
|
||||||
<button
|
<button
|
||||||
|
disabled={newPasswordError !== "" || newPasswordConfirmError !== ""}
|
||||||
type="submit"
|
type="submit"
|
||||||
className={clsx(
|
className={clsx(
|
||||||
getClassName("kcButtonClass"),
|
getClassName("kcButtonClass"),
|
||||||
|
9
src/bin/constants.ts
Normal file
9
src/bin/constants.ts
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
export const keycloak_resources = "keycloak-resources";
|
||||||
|
export const resources_common = "resources-common";
|
||||||
|
export const lastKeycloakVersionWithAccountV1 = "21.1.2";
|
||||||
|
|
||||||
|
export const themeTypes = ["login", "account"] as const;
|
||||||
|
export const retrocompatPostfix = "_retrocompat";
|
||||||
|
export const accountV1 = "account-v1";
|
||||||
|
|
||||||
|
export type ThemeType = (typeof themeTypes)[number];
|
50
src/bin/copy-keycloak-resources-to-public.ts
Normal file
50
src/bin/copy-keycloak-resources-to-public.ts
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
import { downloadKeycloakStaticResources } from "./keycloakify/generateTheme/downloadKeycloakStaticResources";
|
||||||
|
import { join as pathJoin, relative as pathRelative } from "path";
|
||||||
|
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
||||||
|
import { themeTypes, keycloak_resources, lastKeycloakVersionWithAccountV1 } from "./constants";
|
||||||
|
import * as fs from "fs";
|
||||||
|
|
||||||
|
(async () => {
|
||||||
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
|
const buildOptions = readBuildOptions({
|
||||||
|
reactAppRootDirPath,
|
||||||
|
"processArgv": process.argv.slice(2)
|
||||||
|
});
|
||||||
|
|
||||||
|
const reservedDirPath = pathJoin(buildOptions.publicDirPath, keycloak_resources);
|
||||||
|
|
||||||
|
for (const themeType of themeTypes) {
|
||||||
|
await downloadKeycloakStaticResources({
|
||||||
|
"keycloakVersion": (() => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "login":
|
||||||
|
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
||||||
|
case "account":
|
||||||
|
return lastKeycloakVersionWithAccountV1;
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
themeType,
|
||||||
|
"themeDirPath": reservedDirPath,
|
||||||
|
"usedResources": undefined,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
pathJoin(reservedDirPath, "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(buildOptions.publicDirPath, "keycloak-resources", ".gitignore"), Buffer.from("*", "utf8"));
|
||||||
|
|
||||||
|
console.log(`${pathRelative(reactAppRootDirPath, reservedDirPath)} directory created.`);
|
||||||
|
})();
|
@ -2,47 +2,112 @@
|
|||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin } from "path";
|
||||||
import { downloadAndUnzip } from "./tools/downloadAndUnzip";
|
import { downloadAndUnzip } from "./tools/downloadAndUnzip";
|
||||||
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
import { promptKeycloakVersion } from "./promptKeycloakVersion";
|
||||||
import { getCliOptions } from "./tools/cliOptions";
|
|
||||||
import { getLogger } from "./tools/logger";
|
import { getLogger } from "./tools/logger";
|
||||||
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
import { readBuildOptions } from "./keycloakify/BuildOptions";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { BuildOptions } from "./keycloakify/BuildOptions";
|
||||||
|
import * as child_process from "child_process";
|
||||||
|
import * as fs from "fs";
|
||||||
|
|
||||||
export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; isSilent: boolean }) {
|
export type BuildOptionsLike = {
|
||||||
const { keycloakVersion, destDirPath } = params;
|
cacheDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
await Promise.all(
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
["", "-community"].map(ext =>
|
|
||||||
downloadAndUnzip({
|
export async function downloadBuiltinKeycloakTheme(params: { keycloakVersion: string; destDirPath: string; buildOptions: BuildOptionsLike }) {
|
||||||
"destDirPath": destDirPath,
|
const { keycloakVersion, destDirPath, buildOptions } = params;
|
||||||
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
|
||||||
"pathOfDirToExtractInArchive": `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`
|
await downloadAndUnzip({
|
||||||
})
|
"doUseCache": true,
|
||||||
)
|
"cacheDirPath": buildOptions.cacheDirPath,
|
||||||
);
|
destDirPath,
|
||||||
|
"url": `https://github.com/keycloak/keycloak/archive/refs/tags/${keycloakVersion}.zip`,
|
||||||
|
"specificDirsToExtract": ["", "-community"].map(ext => `keycloak-${keycloakVersion}/themes/src/main/resources${ext}/theme`),
|
||||||
|
"preCacheTransform": {
|
||||||
|
"actionCacheId": "npm install and build",
|
||||||
|
"action": async ({ destDirPath }) => {
|
||||||
|
install_common_node_modules: {
|
||||||
|
const commonResourcesDirPath = pathJoin(destDirPath, "keycloak", "common", "resources");
|
||||||
|
|
||||||
|
if (!fs.existsSync(commonResourcesDirPath)) {
|
||||||
|
break install_common_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!fs.existsSync(pathJoin(commonResourcesDirPath, "package.json"))) {
|
||||||
|
break install_common_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (fs.existsSync(pathJoin(commonResourcesDirPath, "node_modules"))) {
|
||||||
|
break install_common_node_modules;
|
||||||
|
}
|
||||||
|
|
||||||
|
child_process.execSync("npm install --omit=dev", {
|
||||||
|
"cwd": commonResourcesDirPath,
|
||||||
|
"stdio": "ignore"
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
install_and_move_to_common_resources_generated_in_keycloak_v2: {
|
||||||
|
const accountV2DirSrcDirPath = pathJoin(destDirPath, "keycloak.v2", "account", "src");
|
||||||
|
|
||||||
|
if (!fs.existsSync(accountV2DirSrcDirPath)) {
|
||||||
|
break install_and_move_to_common_resources_generated_in_keycloak_v2;
|
||||||
|
}
|
||||||
|
|
||||||
|
const packageManager = fs.existsSync(pathJoin(accountV2DirSrcDirPath, "pnpm-lock.yaml")) ? "pnpm" : "npm";
|
||||||
|
|
||||||
|
if (packageManager === "pnpm") {
|
||||||
|
try {
|
||||||
|
child_process.execSync(`which pnpm`);
|
||||||
|
} catch {
|
||||||
|
console.log(`Installing pnpm globally`);
|
||||||
|
child_process.execSync(`npm install -g pnpm`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
child_process.execSync(`${packageManager} install`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
|
const packageJsonFilePath = pathJoin(accountV2DirSrcDirPath, "package.json");
|
||||||
|
|
||||||
|
const packageJsonRaw = fs.readFileSync(packageJsonFilePath);
|
||||||
|
|
||||||
|
const parsedPackageJson = JSON.parse(packageJsonRaw.toString("utf8"));
|
||||||
|
|
||||||
|
parsedPackageJson.scripts.build = parsedPackageJson.scripts.build
|
||||||
|
.replace(`${packageManager} run check-types`, "true")
|
||||||
|
.replace(`${packageManager} run babel`, "true");
|
||||||
|
|
||||||
|
fs.writeFileSync(packageJsonFilePath, Buffer.from(JSON.stringify(parsedPackageJson, null, 2), "utf8"));
|
||||||
|
|
||||||
|
child_process.execSync(`${packageManager} run build`, { "cwd": accountV2DirSrcDirPath, "stdio": "ignore" });
|
||||||
|
|
||||||
|
fs.writeFileSync(packageJsonFilePath, packageJsonRaw);
|
||||||
|
|
||||||
|
fs.rmSync(pathJoin(accountV2DirSrcDirPath, "node_modules"), { "recursive": true });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const { isSilent } = getCliOptions(process.argv.slice(2));
|
const buildOptions = readBuildOptions({
|
||||||
const logger = getLogger({ isSilent });
|
"reactAppRootDirPath": process.cwd(),
|
||||||
|
"processArgv": process.argv.slice(2)
|
||||||
|
});
|
||||||
|
|
||||||
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
const { keycloakVersion } = await promptKeycloakVersion();
|
const { keycloakVersion } = await promptKeycloakVersion();
|
||||||
|
|
||||||
const destDirPath = pathJoin(
|
const destDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme");
|
||||||
readBuildOptions({
|
|
||||||
"isSilent": true,
|
|
||||||
"isExternalAssetsCliParamProvided": false,
|
|
||||||
"projectDirPath": process.cwd()
|
|
||||||
}).keycloakifyBuildDirPath,
|
|
||||||
"src",
|
|
||||||
"main",
|
|
||||||
"resources",
|
|
||||||
"theme"
|
|
||||||
);
|
|
||||||
|
|
||||||
logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
|
logger.log(`Downloading builtins theme of Keycloak ${keycloakVersion} here ${destDirPath}`);
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
destDirPath,
|
destDirPath,
|
||||||
isSilent
|
buildOptions
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -2,14 +2,7 @@
|
|||||||
|
|
||||||
import { getProjectRoot } from "./tools/getProjectRoot";
|
import { getProjectRoot } from "./tools/getProjectRoot";
|
||||||
import cliSelect from "cli-select";
|
import cliSelect from "cli-select";
|
||||||
import {
|
import { loginThemePageIds, accountThemePageIds, type LoginThemePageId, type AccountThemePageId } from "./keycloakify/generateFtl";
|
||||||
loginThemePageIds,
|
|
||||||
accountThemePageIds,
|
|
||||||
type LoginThemePageId,
|
|
||||||
type AccountThemePageId,
|
|
||||||
themeTypes,
|
|
||||||
type ThemeType
|
|
||||||
} from "./keycloakify/generateFtl";
|
|
||||||
import { capitalize } from "tsafe/capitalize";
|
import { capitalize } from "tsafe/capitalize";
|
||||||
import { readFile, writeFile } from "fs/promises";
|
import { readFile, writeFile } from "fs/promises";
|
||||||
import { existsSync } from "fs";
|
import { existsSync } from "fs";
|
||||||
@ -17,10 +10,13 @@ import { join as pathJoin, relative as pathRelative } from "path";
|
|||||||
import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
|
import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
|
||||||
import { assert, Equals } from "tsafe/assert";
|
import { assert, Equals } from "tsafe/assert";
|
||||||
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
||||||
|
import { themeTypes, type ThemeType } from "./constants";
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
console.log("Select a theme type");
|
console.log("Select a theme type");
|
||||||
|
|
||||||
|
const reactAppRootDirPath = process.cwd();
|
||||||
|
|
||||||
const { value: themeType } = await cliSelect<ThemeType>({
|
const { value: themeType } = await cliSelect<ThemeType>({
|
||||||
"values": [...themeTypes]
|
"values": [...themeTypes]
|
||||||
}).catch(() => {
|
}).catch(() => {
|
||||||
@ -49,11 +45,7 @@ import { getThemeSrcDirPath } from "./getSrcDirPath";
|
|||||||
|
|
||||||
const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
|
const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
|
||||||
|
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ "projectDirPath": process.cwd() });
|
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
if (themeSrcDirPath === undefined) {
|
|
||||||
throw new Error("Couldn't locate your theme sources");
|
|
||||||
}
|
|
||||||
|
|
||||||
const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
|
const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
|
||||||
|
|
||||||
|
@ -2,42 +2,46 @@ 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";
|
||||||
|
|
||||||
const themeSrcDirBasename = "keycloak-theme";
|
const themeSrcDirBasenames = ["keycloak-theme", "keycloak_theme"];
|
||||||
|
|
||||||
export function getThemeSrcDirPath(params: { projectDirPath: string }) {
|
/** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
|
||||||
const { projectDirPath } = params;
|
export function getThemeSrcDirPath(params: { reactAppRootDirPath: string }) {
|
||||||
|
const { reactAppRootDirPath } = params;
|
||||||
|
|
||||||
const srcDirPath = pathJoin(projectDirPath, "src");
|
const srcDirPath = pathJoin(reactAppRootDirPath, "src");
|
||||||
|
|
||||||
const themeSrcDirPath: string | undefined = crawl(srcDirPath)
|
const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
|
||||||
.map(fileRelativePath => {
|
.map(fileRelativePath => {
|
||||||
const split = fileRelativePath.split(themeSrcDirBasename);
|
for (const themeSrcDirBasename of themeSrcDirBasenames) {
|
||||||
|
const split = fileRelativePath.split(themeSrcDirBasename);
|
||||||
if (split.length !== 2) {
|
if (split.length === 2) {
|
||||||
return undefined;
|
return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
return undefined;
|
||||||
return pathJoin(srcDirPath, split[0] + themeSrcDirBasename);
|
|
||||||
})
|
})
|
||||||
.filter(exclude(undefined))[0];
|
.filter(exclude(undefined))[0];
|
||||||
|
|
||||||
if (themeSrcDirPath === undefined) {
|
if (themeSrcDirPath !== undefined) {
|
||||||
if (fs.existsSync(pathJoin(srcDirPath, "login")) || fs.existsSync(pathJoin(srcDirPath, "account"))) {
|
return { themeSrcDirPath };
|
||||||
return { "themeSrcDirPath": srcDirPath };
|
|
||||||
}
|
|
||||||
return { "themeSrcDirPath": undefined };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return { themeSrcDirPath };
|
for (const themeType of [...themeTypes, "email"]) {
|
||||||
}
|
if (!fs.existsSync(pathJoin(srcDirPath, themeType))) {
|
||||||
|
continue;
|
||||||
export function getEmailThemeSrcDirPath(params: { projectDirPath: string }) {
|
}
|
||||||
const { projectDirPath } = params;
|
return { "themeSrcDirPath": srcDirPath };
|
||||||
|
}
|
||||||
const { themeSrcDirPath } = getThemeSrcDirPath({ projectDirPath });
|
|
||||||
|
console.error(
|
||||||
const emailThemeSrcDirPath = themeSrcDirPath === undefined ? undefined : pathJoin(themeSrcDirPath, "email");
|
[
|
||||||
|
"Can't locate your theme source directory. It should be either: ",
|
||||||
return { emailThemeSrcDirPath };
|
"src/ or src/keycloak-theme or src/keycloak_theme.",
|
||||||
|
"Example in the starter: https://github.com/keycloakify/keycloakify-starter/tree/main/src/keycloak-theme"
|
||||||
|
].join("\n")
|
||||||
|
);
|
||||||
|
|
||||||
|
process.exit(-1);
|
||||||
}
|
}
|
||||||
|
@ -4,24 +4,26 @@ 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 * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { getCliOptions } from "./tools/cliOptions";
|
|
||||||
import { getLogger } from "./tools/logger";
|
import { getLogger } from "./tools/logger";
|
||||||
import { getEmailThemeSrcDirPath } from "./getSrcDirPath";
|
import { getThemeSrcDirPath } from "./getSrcDirPath";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const { isSilent } = getCliOptions(process.argv.slice(2));
|
const reactAppRootDirPath = process.cwd();
|
||||||
const logger = getLogger({ isSilent });
|
|
||||||
|
|
||||||
const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({
|
const buildOptions = readBuildOptions({
|
||||||
"projectDirPath": process.cwd()
|
reactAppRootDirPath,
|
||||||
|
"processArgv": process.argv.slice(2)
|
||||||
});
|
});
|
||||||
|
|
||||||
if (emailThemeSrcDirPath === undefined) {
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
logger.warn("Couldn't locate your theme source directory");
|
|
||||||
|
|
||||||
process.exit(-1);
|
const { themeSrcDirPath } = getThemeSrcDirPath({
|
||||||
}
|
reactAppRootDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
|
|
||||||
if (fs.existsSync(emailThemeSrcDirPath)) {
|
if (fs.existsSync(emailThemeSrcDirPath)) {
|
||||||
logger.warn(`There is already a ${pathRelative(process.cwd(), emailThemeSrcDirPath)} directory in your project. Aborting.`);
|
logger.warn(`There is already a ${pathRelative(process.cwd(), emailThemeSrcDirPath)} directory in your project. Aborting.`);
|
||||||
@ -36,7 +38,7 @@ export async function main() {
|
|||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
||||||
isSilent
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
|
@ -1,228 +1,157 @@
|
|||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { id } from "tsafe/id";
|
|
||||||
import { parse as urlParse } from "url";
|
import { parse as urlParse } from "url";
|
||||||
import { typeGuard } from "tsafe/typeGuard";
|
import { getParsedPackageJson } from "./parsedPackageJson";
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { join as pathJoin } from "path";
|
||||||
import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
|
import parseArgv from "minimist";
|
||||||
import * as fs from "fs";
|
import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
|
||||||
import { join as pathJoin, sep as pathSep } from "path";
|
|
||||||
|
|
||||||
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
/** Consolidated build option gathered form CLI arguments and config in package.json */
|
||||||
export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets;
|
export type BuildOptions = {
|
||||||
|
isSilent: boolean;
|
||||||
|
themeVersion: string;
|
||||||
|
themeNames: string[];
|
||||||
|
extraThemeProperties: string[] | undefined;
|
||||||
|
groupId: string;
|
||||||
|
artifactId: string;
|
||||||
|
doCreateJar: boolean;
|
||||||
|
loginThemeResourcesFromKeycloakVersion: string;
|
||||||
|
reactAppRootDirPath: string;
|
||||||
|
/** Directory of your built react project. Defaults to {cwd}/build */
|
||||||
|
reactAppBuildDirPath: string;
|
||||||
|
/** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
publicDirPath: string;
|
||||||
|
cacheDirPath: string;
|
||||||
|
/** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
|
||||||
|
* In this case the urlPathname will be "/my-app/" */
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
doBuildRetrocompatAccountTheme: boolean;
|
||||||
|
};
|
||||||
|
|
||||||
export namespace BuildOptions {
|
export function readBuildOptions(params: { reactAppRootDirPath: string; processArgv: string[] }): BuildOptions {
|
||||||
export type Common = {
|
const { reactAppRootDirPath, processArgv } = params;
|
||||||
isSilent: boolean;
|
|
||||||
themeVersion: string;
|
|
||||||
themeName: string;
|
|
||||||
extraLoginPages: string[] | undefined;
|
|
||||||
extraAccountPages: string[] | undefined;
|
|
||||||
extraThemeProperties?: string[];
|
|
||||||
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;
|
|
||||||
customUserAttributes: string[];
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
const { isSilentCliParamProvided } = (() => {
|
||||||
isStandalone: true;
|
const argv = parseArgv(processArgv);
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
|
return {
|
||||||
|
"isSilentCliParamProvided": typeof argv["silent"] === "boolean" ? argv["silent"] : false
|
||||||
export namespace ExternalAssets {
|
|
||||||
export type CommonExternalAssets = Common & {
|
|
||||||
isStandalone: false;
|
|
||||||
};
|
};
|
||||||
|
})();
|
||||||
|
|
||||||
export type SameDomain = CommonExternalAssets & {
|
const parsedPackageJson = getParsedPackageJson({ reactAppRootDirPath });
|
||||||
areAppAndKeycloakServerSharingSameDomain: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type DifferentDomains = CommonExternalAssets & {
|
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
||||||
areAppAndKeycloakServerSharingSameDomain: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const defaultKeycloakVersionDefaultAssets = "11.0.3";
|
const { extraThemeProperties, groupId, artifactId, doCreateJar, loginThemeResourcesFromKeycloakVersion } = keycloakify ?? {};
|
||||||
|
|
||||||
export function readBuildOptions(params: { projectDirPath: string; isExternalAssetsCliParamProvided: boolean; isSilent: boolean }): BuildOptions {
|
const themeNames = (() => {
|
||||||
const { projectDirPath, isExternalAssetsCliParamProvided, isSilent } = params;
|
if (keycloakify.themeName === undefined) {
|
||||||
|
return [
|
||||||
const parsedPackageJson = getParsedPackageJson({ projectDirPath });
|
name
|
||||||
|
.replace(/^@(.*)/, "$1")
|
||||||
const url = (() => {
|
.split("/")
|
||||||
const { homepage } = parsedPackageJson;
|
.join("-")
|
||||||
|
];
|
||||||
let url: URL | undefined = undefined;
|
|
||||||
|
|
||||||
if (homepage !== undefined) {
|
|
||||||
url = new URL(homepage);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const CNAME = (() => {
|
if (typeof keycloakify.themeName === "string") {
|
||||||
const cnameFilePath = pathJoin(projectDirPath, "public", "CNAME");
|
return [keycloakify.themeName];
|
||||||
|
}
|
||||||
|
|
||||||
if (!fs.existsSync(cnameFilePath)) {
|
return keycloakify.themeName;
|
||||||
|
})();
|
||||||
|
|
||||||
|
return {
|
||||||
|
reactAppRootDirPath,
|
||||||
|
themeNames,
|
||||||
|
"doCreateJar": doCreateJar ?? true,
|
||||||
|
"artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeNames[0]}-keycloak-theme`,
|
||||||
|
"groupId": (() => {
|
||||||
|
const fallbackGroupId = `${themeNames[0]}.keycloak`;
|
||||||
|
|
||||||
|
return (
|
||||||
|
process.env.KEYCLOAKIFY_GROUP_ID ??
|
||||||
|
groupId ??
|
||||||
|
(!homepage
|
||||||
|
? fallbackGroupId
|
||||||
|
: urlParse(homepage)
|
||||||
|
.host?.replace(/:[0-9]+$/, "")
|
||||||
|
?.split(".")
|
||||||
|
.reverse()
|
||||||
|
.join(".") ?? fallbackGroupId) + ".keycloak"
|
||||||
|
);
|
||||||
|
})(),
|
||||||
|
"themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
|
||||||
|
extraThemeProperties,
|
||||||
|
"isSilent": isSilentCliParamProvided,
|
||||||
|
"loginThemeResourcesFromKeycloakVersion": loginThemeResourcesFromKeycloakVersion ?? "11.0.3",
|
||||||
|
"publicDirPath": (() => {
|
||||||
|
let { PUBLIC_DIR_PATH } = process.env;
|
||||||
|
|
||||||
|
if (PUBLIC_DIR_PATH !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": PUBLIC_DIR_PATH,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, "public");
|
||||||
|
})(),
|
||||||
|
"reactAppBuildDirPath": (() => {
|
||||||
|
const { reactAppBuildDirPath } = parsedPackageJson.keycloakify ?? {};
|
||||||
|
|
||||||
|
if (reactAppBuildDirPath !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": reactAppBuildDirPath,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, "build");
|
||||||
|
})(),
|
||||||
|
"keycloakifyBuildDirPath": (() => {
|
||||||
|
const { keycloakifyBuildDirPath } = parsedPackageJson.keycloakify ?? {};
|
||||||
|
|
||||||
|
if (keycloakifyBuildDirPath !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": keycloakifyBuildDirPath,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, "build_keycloak");
|
||||||
|
})(),
|
||||||
|
"cacheDirPath": pathJoin(
|
||||||
|
(() => {
|
||||||
|
let { XDG_CACHE_HOME } = process.env;
|
||||||
|
|
||||||
|
if (XDG_CACHE_HOME !== undefined) {
|
||||||
|
return getAbsoluteAndInOsFormatPath({
|
||||||
|
"pathIsh": XDG_CACHE_HOME,
|
||||||
|
"cwd": reactAppRootDirPath
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathJoin(reactAppRootDirPath, "node_modules", ".cache");
|
||||||
|
})(),
|
||||||
|
"keycloakify"
|
||||||
|
),
|
||||||
|
"urlPathname": (() => {
|
||||||
|
const { homepage } = parsedPackageJson;
|
||||||
|
|
||||||
|
let url: URL | undefined = undefined;
|
||||||
|
|
||||||
|
if (homepage !== undefined) {
|
||||||
|
url = new URL(homepage);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (url === undefined) {
|
||||||
return undefined;
|
return undefined;
|
||||||
}
|
}
|
||||||
|
|
||||||
return fs.readFileSync(cnameFilePath).toString("utf8");
|
const out = url.pathname.replace(/([^/])$/, "$1/");
|
||||||
})();
|
return out === "/" ? undefined : out;
|
||||||
|
})(),
|
||||||
if (CNAME !== undefined) {
|
"doBuildRetrocompatAccountTheme": parsedPackageJson.keycloakify?.doBuildRetrocompatAccountTheme ?? true
|
||||||
url = new URL(`https://${CNAME.replace(/\s+$/, "")}`);
|
};
|
||||||
}
|
|
||||||
|
|
||||||
if (url === undefined) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"origin": url.origin,
|
|
||||||
"pathname": (() => {
|
|
||||||
const out = url.pathname.replace(/([^/])$/, "$1/");
|
|
||||||
|
|
||||||
return out === "/" ? undefined : out;
|
|
||||||
})()
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
const common: BuildOptions.Common = (() => {
|
|
||||||
const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
|
|
||||||
|
|
||||||
const { extraPages, extraLoginPages, extraAccountPages, extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets } =
|
|
||||||
keycloakify ?? {};
|
|
||||||
|
|
||||||
const themeName =
|
|
||||||
keycloakify.themeName ??
|
|
||||||
name
|
|
||||||
.replace(/^@(.*)/, "$1")
|
|
||||||
.split("/")
|
|
||||||
.join("-");
|
|
||||||
|
|
||||||
return {
|
|
||||||
themeName,
|
|
||||||
"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",
|
|
||||||
"extraLoginPages": [...(extraPages ?? []), ...(extraLoginPages ?? [])],
|
|
||||||
extraAccountPages,
|
|
||||||
extraThemeProperties,
|
|
||||||
isSilent,
|
|
||||||
"keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? defaultKeycloakVersionDefaultAssets,
|
|
||||||
"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;
|
|
||||||
})(),
|
|
||||||
"customUserAttributes": keycloakify.customUserAttributes ?? []
|
|
||||||
};
|
|
||||||
})();
|
|
||||||
|
|
||||||
if (isExternalAssetsCliParamProvided) {
|
|
||||||
const commonExternalAssets = id<BuildOptions.ExternalAssets.CommonExternalAssets>({
|
|
||||||
...common,
|
|
||||||
"isStandalone": false
|
|
||||||
});
|
|
||||||
|
|
||||||
if (parsedPackageJson.keycloakify?.areAppAndKeycloakServerSharingSameDomain) {
|
|
||||||
return id<BuildOptions.ExternalAssets.SameDomain>({
|
|
||||||
...commonExternalAssets,
|
|
||||||
"areAppAndKeycloakServerSharingSameDomain": true
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
assert(
|
|
||||||
url !== undefined,
|
|
||||||
[
|
|
||||||
"Can't compile in external assets mode if we don't know where",
|
|
||||||
"the app will be hosted.",
|
|
||||||
"You should provide a homepage field in the package.json (or create a",
|
|
||||||
"public/CNAME file.",
|
|
||||||
"Alternatively, if your app and the Keycloak server are on the same domain, ",
|
|
||||||
"eg https://example.com is your app and https://example.com/auth is the keycloak",
|
|
||||||
'admin UI, you can set "keycloakify": { "areAppAndKeycloakServerSharingSameDomain": true }',
|
|
||||||
"in your package.json"
|
|
||||||
].join(" ")
|
|
||||||
);
|
|
||||||
|
|
||||||
return id<BuildOptions.ExternalAssets.DifferentDomains>({
|
|
||||||
...commonExternalAssets,
|
|
||||||
"areAppAndKeycloakServerSharingSameDomain": false,
|
|
||||||
"urlOrigin": url.origin,
|
|
||||||
"urlPathname": url.pathname
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return id<BuildOptions.Standalone>({
|
|
||||||
...common,
|
|
||||||
"isStandalone": true,
|
|
||||||
"urlPathname": url?.pathname
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
@ -8,13 +8,7 @@
|
|||||||
out["advancedMsg"]= function(){ throw new Error("use import { useKcMessage } from 'keycloakify'"); };
|
out["advancedMsg"]= function(){ throw new Error("use import { useKcMessage } from 'keycloakify'"); };
|
||||||
|
|
||||||
out["messagesPerField"]= {
|
out["messagesPerField"]= {
|
||||||
<#assign fieldNames = [
|
<#assign fieldNames = [ FIELD_NAMES_eKsIY4ZsZ4xeM ]>
|
||||||
"global", "userLabel", "username", "email", "firstName", "lastName", "password", "password-confirm",
|
|
||||||
"totp", "totpSecret", "SAMLRequest", "SAMLResponse", "relayState", "device_user_code", "code",
|
|
||||||
"password-new", "rememberMe", "login", "authenticationExecution", "cancel-aia", "clientDataJSON",
|
|
||||||
"authenticatorData", "signature", "credentialId", "userHandle", "error", "authn_use_chk", "authenticationExecution",
|
|
||||||
"isSetRetry", "try-again", "attestationObject", "publicKeyCredentialId", "authenticatorLabel"CUSTOM_USER_ATTRIBUTES_eKsIY4ZsZ4xeM
|
|
||||||
]>
|
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#if profile?? && profile.attributes?? && profile.attributes?is_enumerable>
|
<#if profile?? && profile.attributes?? && profile.attributes?is_enumerable>
|
||||||
@ -28,85 +22,374 @@
|
|||||||
<#recover>
|
<#recover>
|
||||||
</#attempt>
|
</#attempt>
|
||||||
|
|
||||||
"printIfExists": function (fieldName, x) {
|
"printIfExists": function (fieldName, text) {
|
||||||
<#if !messagesPerField?? >
|
|
||||||
return undefined;
|
<#if !messagesPerField?? || !(messagesPerField?is_hash)>
|
||||||
|
throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
|
||||||
<#else>
|
<#else>
|
||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
<#attempt>
|
|
||||||
<#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
|
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
||||||
return <#if messagesPerField.existsError('username', 'password')>x<#else>undefined</#if>;
|
<#if !messagesPerField.existsError??>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if !doExistMessageForUsernameOrPassword>
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
return <#if doExistMessageForUsernameOrPassword>text<#else>undefined</#if>;
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
return <#if messagesPerField.existsError('${fieldName}')>x<#else>undefined</#if>;
|
|
||||||
|
<#assign doExistMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistMessageForField>text<#else>undefined</#if>;
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
|
||||||
</#attempt>
|
<#else>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if doExistErrorOnUsernameOrPassword>
|
||||||
|
return text;
|
||||||
|
<#else>
|
||||||
|
|
||||||
|
<#assign doExistMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistMessageForField>text<#else>undefined</#if>;
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
<#else>
|
||||||
|
|
||||||
|
<#assign doExistMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistMessageForField>text<#else>undefined</#if>;
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
}
|
}
|
||||||
</#list>
|
</#list>
|
||||||
throw new Error("There is no " + fieldName + " field");
|
|
||||||
|
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
},
|
},
|
||||||
"existsError": function (fieldName) {
|
"existsError": function (fieldName) {
|
||||||
<#if !messagesPerField?? >
|
|
||||||
return false;
|
<#if !messagesPerField?? || !(messagesPerField?is_hash)>
|
||||||
|
throw new Error("You're not supposed to use messagesPerField.printIfExists in this page");
|
||||||
<#else>
|
<#else>
|
||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
<#attempt>
|
|
||||||
<#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
|
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
||||||
return <#if messagesPerField.existsError('username', 'password')>true<#else>false</#if>;
|
<#if !messagesPerField.existsError??>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if !doExistMessageForUsernameOrPassword>
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
return <#if messagesPerField.existsError('${fieldName}')>true<#else>false</#if>;
|
|
||||||
|
<#assign doExistMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistMessageForField>true<#else>false</#if>;
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
|
||||||
</#attempt>
|
<#else>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
|
||||||
|
|
||||||
|
<#else>
|
||||||
|
|
||||||
|
<#assign doExistErrorMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistErrorMessageForField = messagesPerField.existsError('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistErrorMessageForField>true<#else>false</#if>;
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
}
|
}
|
||||||
</#list>
|
</#list>
|
||||||
throw new Error("There is no " + fieldName + " field");
|
|
||||||
|
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
},
|
},
|
||||||
"get": function (fieldName) {
|
"get": function (fieldName) {
|
||||||
<#if !messagesPerField?? >
|
|
||||||
return '';
|
|
||||||
|
<#if !messagesPerField?? || !(messagesPerField?is_hash)>
|
||||||
|
throw new Error("You're not supposed to use messagesPerField.get in this page");
|
||||||
<#else>
|
<#else>
|
||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
<#attempt>
|
|
||||||
<#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
|
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
||||||
<#if messagesPerField.existsError('username', 'password')>
|
<#if !messagesPerField.existsError??>
|
||||||
return 'Invalid username or password.';
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if !doExistMessageForUsernameOrPassword>
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
|
<#if !doExistMessageForUsernameOrPassword>
|
||||||
|
return "";
|
||||||
|
<#else>
|
||||||
|
<#attempt>
|
||||||
|
return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
|
||||||
|
<#recover>
|
||||||
|
return "Invalid username or password.";
|
||||||
|
</#attempt>
|
||||||
|
</#if>
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
<#if messagesPerField.existsError('${fieldName}')>
|
|
||||||
|
<#attempt>
|
||||||
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
||||||
</#if>
|
<#recover>
|
||||||
|
return "invalid field";
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
|
||||||
</#attempt>
|
<#else>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if doExistErrorOnUsernameOrPassword>
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
return "${kcSanitize(msg('invalidUserMessage'))?no_esc}";
|
||||||
|
<#recover>
|
||||||
|
return "Invalid username or password.";
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#else>
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
||||||
|
<#recover>
|
||||||
|
return "";
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
<#else>
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
return "${messagesPerField.get('${fieldName}')?no_esc}";
|
||||||
|
<#recover>
|
||||||
|
return "invalid field";
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
}
|
}
|
||||||
</#list>
|
</#list>
|
||||||
throw new Error("There is no " + fieldName + " field");
|
|
||||||
|
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
},
|
},
|
||||||
"exists": function (fieldName) {
|
"exists": function (fieldName) {
|
||||||
<#if !messagesPerField?? >
|
|
||||||
return false;
|
<#if !messagesPerField?? || !(messagesPerField?is_hash)>
|
||||||
|
throw new Error("You're not supposed to use messagesPerField.exists in this page");
|
||||||
<#else>
|
<#else>
|
||||||
<#list fieldNames as fieldName>
|
<#list fieldNames as fieldName>
|
||||||
if(fieldName === "${fieldName}" ){
|
if(fieldName === "${fieldName}" ){
|
||||||
<#attempt>
|
|
||||||
<#if '${fieldName}' == 'username' || '${fieldName}' == 'password'>
|
<#-- https://github.com/keycloakify/keycloakify/pull/359 Compat with Keycloak prior v12 -->
|
||||||
return <#if messagesPerField.exists('username') || messagesPerField.exists('password')>true<#else>false</#if>;
|
<#if !messagesPerField.existsError??>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('username')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if !doExistMessageForUsernameOrPassword>
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = messagesPerField.exists('password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
return <#if doExistMessageForUsernameOrPassword>true<#else>false</#if>;
|
||||||
|
|
||||||
<#else>
|
<#else>
|
||||||
return <#if messagesPerField.exists('${fieldName}')>true<#else>false</#if>;
|
|
||||||
|
<#assign doExistMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistMessageForField>true<#else>false</#if>;
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
|
||||||
</#attempt>
|
<#else>
|
||||||
|
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/pull/218 -->
|
||||||
|
<#if ('${fieldName}' == 'username' || '${fieldName}' == 'password') && pageId != 'register.ftl' && pageId != 'register-user-profile.ftl'>
|
||||||
|
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = messagesPerField.existsError('username', 'password')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorOnUsernameOrPassword = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistErrorOnUsernameOrPassword>true<#else>false</#if>;
|
||||||
|
|
||||||
|
<#else>
|
||||||
|
|
||||||
|
<#assign doExistErrorMessageForField = "">
|
||||||
|
|
||||||
|
<#attempt>
|
||||||
|
<#assign doExistErrorMessageForField = messagesPerField.exists('${fieldName}')>
|
||||||
|
<#recover>
|
||||||
|
<#assign doExistErrorMessageForField = true>
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
return <#if doExistErrorMessageForField>true<#else>false</#if>;
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
|
</#if>
|
||||||
|
|
||||||
}
|
}
|
||||||
</#list>
|
</#list>
|
||||||
throw new Error("There is no " + fieldName + " field");
|
|
||||||
|
throw new Error(fieldName + "is probably runtime generated, see: https://docs.keycloakify.dev/limitations#field-names-cant-be-runtime-generated");
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -121,6 +404,8 @@
|
|||||||
|
|
||||||
out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
|
out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
|
||||||
out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
|
out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
|
||||||
|
out["themeType"] = "KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr";
|
||||||
|
out["themeName"] = "KEYCLOAKIFY_THEME_NAME_cXxKd3xEer";
|
||||||
out["pageId"] = "${pageId}";
|
out["pageId"] = "${pageId}";
|
||||||
|
|
||||||
return out;
|
return out;
|
||||||
@ -169,10 +454,15 @@
|
|||||||
<#-- https://github.com/keycloakify/keycloakify/pull/65#issuecomment-991896344 (reports with saml-post-form.ftl) -->
|
<#-- https://github.com/keycloakify/keycloakify/pull/65#issuecomment-991896344 (reports with saml-post-form.ftl) -->
|
||||||
<#-- https://github.com/keycloakify/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
|
<#-- https://github.com/keycloakify/keycloakify/issues/91#issue-1212319466 (reports with error.ftl and Kc18) -->
|
||||||
<#-- https://github.com/keycloakify/keycloakify/issues/109#issuecomment-1134610163 -->
|
<#-- https://github.com/keycloakify/keycloakify/issues/109#issuecomment-1134610163 -->
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/issues/357 -->
|
||||||
key == "loginAction" &&
|
key == "loginAction" &&
|
||||||
are_same_path(path, ["url"]) &&
|
are_same_path(path, ["url"]) &&
|
||||||
["saml-post-form.ftl", "error.ftl", "info.ftl"]?seq_contains(pageId) &&
|
["saml-post-form.ftl", "error.ftl", "info.ftl", "login-oauth-grant.ftl", "logout-confirm.ftl"]?seq_contains(pageId) &&
|
||||||
!(auth?has_content && auth.showTryAnotherWayLink())
|
!(auth?has_content && auth.showTryAnotherWayLink())
|
||||||
|
) || (
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/issues/362 -->
|
||||||
|
["secretData", "value"]?seq_contains(key) &&
|
||||||
|
are_same_path(path, [ "totp", "otpCredentials", "*" ])
|
||||||
) || (
|
) || (
|
||||||
["contextData", "idpConfig", "idp", "authenticationSession"]?seq_contains(key) &&
|
["contextData", "idpConfig", "idp", "authenticationSession"]?seq_contains(key) &&
|
||||||
are_same_path(path, ["brokerContext"]) &&
|
are_same_path(path, ["brokerContext"]) &&
|
||||||
@ -188,22 +478,27 @@
|
|||||||
"error.ftl" == pageId &&
|
"error.ftl" == pageId &&
|
||||||
are_same_path(path, ["realm"]) &&
|
are_same_path(path, ["realm"]) &&
|
||||||
!["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
|
!["name", "displayName", "displayNameHtml", "internationalizationEnabled", "registrationEmailAsUsername" ]?seq_contains(key)
|
||||||
|
) || (
|
||||||
|
"applications.ftl" == pageId &&
|
||||||
|
are_same_path(path, ["applications", "applications", "*", "client", "realm"])
|
||||||
|
) || (
|
||||||
|
"applications.ftl" == pageId &&
|
||||||
|
"masterAdminClient" == key
|
||||||
)
|
)
|
||||||
>
|
>
|
||||||
<#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
<#local out_seq += ["/*If you need '" + key + "' on " + pageId + ", please submit an issue to the Keycloakify repo*/"]>
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#if key == "attemptedUsername" && are_same_path(path, ["auth"])>
|
<#if pageId == "register.ftl" && key == "attemptedUsername" && are_same_path(path, ["auth"])>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#-- https://github.com/keycloak/keycloak/blob/3a2bf0c04bcde185e497aaa32d0bb7ab7520cf4a/themes/src/main/resources/theme/base/login/template.ftl#L63 -->
|
<#-- https://github.com/keycloak/keycloak/blob/3a2bf0c04bcde185e497aaa32d0bb7ab7520cf4a/themes/src/main/resources/theme/base/login/template.ftl#L63 -->
|
||||||
|
<#-- https://github.com/keycloakify/keycloakify/discussions/406 -->
|
||||||
<#if !(auth?has_content && auth.showUsername() && !auth.showResetCredentials())>
|
<#if !(auth?has_content && auth.showUsername() && !auth.showResetCredentials())>
|
||||||
<#continue>
|
<#continue>
|
||||||
</#if>
|
</#if>
|
||||||
<#recover>
|
<#recover>
|
||||||
</#attempt>
|
</#attempt>
|
||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
@ -336,6 +631,17 @@
|
|||||||
|
|
||||||
</#if>
|
</#if>
|
||||||
|
|
||||||
|
<#local isDate = "">
|
||||||
|
<#attempt>
|
||||||
|
<#local isDate = object?is_date_like>
|
||||||
|
<#recover>
|
||||||
|
<#return "ABORT: Can't test if it's a date">
|
||||||
|
</#attempt>
|
||||||
|
|
||||||
|
<#if isDate>
|
||||||
|
<#return '"' + object?datetime?iso_utc + '"'>
|
||||||
|
</#if>
|
||||||
|
|
||||||
<#attempt>
|
<#attempt>
|
||||||
<#return '"' + object?js_string + '"'>;
|
<#return '"' + object?js_string + '"'>;
|
||||||
<#recover>
|
<#recover>
|
||||||
|
@ -8,75 +8,47 @@ import { objectKeys } from "tsafe/objectKeys";
|
|||||||
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
|
||||||
export const themeTypes = ["login", "account"] as const;
|
export type BuildOptionsLike = {
|
||||||
|
themeVersion: string;
|
||||||
export type ThemeType = (typeof themeTypes)[number];
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
|
||||||
|
|
||||||
export namespace BuildOptionsLike {
|
|
||||||
export type Common = {
|
|
||||||
customUserAttributes: string[];
|
|
||||||
themeVersion: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
|
||||||
isStandalone: true;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
|
|
||||||
|
|
||||||
export namespace ExternalAssets {
|
|
||||||
export type CommonExternalAssets = {
|
|
||||||
isStandalone: false;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type SameDomain = Common &
|
|
||||||
CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type DifferentDomains = Common &
|
|
||||||
CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export function generateFtlFilesCodeFactory(params: {
|
export function generateFtlFilesCodeFactory(params: {
|
||||||
|
themeName: string;
|
||||||
indexHtmlCode: string;
|
indexHtmlCode: string;
|
||||||
//NOTE: Expected to be an empty object if external assets mode is enabled.
|
//NOTE: Expected to be an empty object if external assets mode is enabled.
|
||||||
cssGlobalsToDefine: Record<string, string>;
|
cssGlobalsToDefine: Record<string, string>;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
|
themeType: ThemeType;
|
||||||
|
fieldNames: string[];
|
||||||
}) {
|
}) {
|
||||||
const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion } = params;
|
const { themeName, cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
|
||||||
|
|
||||||
const $ = cheerio.load(indexHtmlCode);
|
const $ = cheerio.load(indexHtmlCode);
|
||||||
|
|
||||||
fix_imports_statements: {
|
fix_imports_statements: {
|
||||||
if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
|
|
||||||
break fix_imports_statements;
|
|
||||||
}
|
|
||||||
|
|
||||||
$("script:not([src])").each((...[, element]) => {
|
$("script:not([src])").each((...[, element]) => {
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
const jsCode = $(element).html();
|
||||||
"jsCode": $(element).html()!,
|
|
||||||
buildOptions
|
assert(jsCode !== null);
|
||||||
});
|
|
||||||
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({ jsCode });
|
||||||
|
|
||||||
$(element).text(fixedJsCode);
|
$(element).text(fixedJsCode);
|
||||||
});
|
});
|
||||||
|
|
||||||
$("style").each((...[, element]) => {
|
$("style").each((...[, element]) => {
|
||||||
|
const cssCode = $(element).html();
|
||||||
|
|
||||||
|
assert(cssCode !== null);
|
||||||
|
|
||||||
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
const { fixedCssCode } = replaceImportsInInlineCssCode({
|
||||||
"cssCode": $(element).html()!,
|
cssCode,
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -98,9 +70,7 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
|
|
||||||
$(element).attr(
|
$(element).attr(
|
||||||
attrName,
|
attrName,
|
||||||
buildOptions.isStandalone
|
href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
|
||||||
? href.replace(new RegExp(`^${(buildOptions.urlPathname ?? "/").replace(/\//g, "\\/")}`), "${url.resourcesPath}/build/")
|
|
||||||
: href.replace(/^\//, `${buildOptions.urlOrigin}/`)
|
|
||||||
);
|
);
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
@ -127,12 +97,11 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
.readFileSync(pathJoin(__dirname, "ftl_object_to_js_code_declaring_an_object.ftl"))
|
.readFileSync(pathJoin(__dirname, "ftl_object_to_js_code_declaring_an_object.ftl"))
|
||||||
.toString("utf8")
|
.toString("utf8")
|
||||||
.match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
|
.match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1]
|
||||||
.replace(
|
.replace("FIELD_NAMES_eKsIY4ZsZ4xeM", fieldNames.map(name => `"${name}"`).join(", "))
|
||||||
"CUSTOM_USER_ATTRIBUTES_eKsIY4ZsZ4xeM",
|
|
||||||
buildOptions.customUserAttributes.length === 0 ? "" : ", " + buildOptions.customUserAttributes.map(name => `"${name}"`).join(", ")
|
|
||||||
)
|
|
||||||
.replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
|
.replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
|
||||||
.replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion),
|
.replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
|
||||||
|
.replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
|
||||||
|
.replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName),
|
||||||
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
"<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
|
||||||
"<#if scripts??>",
|
"<#if scripts??>",
|
||||||
" <#list scripts as script>",
|
" <#list scripts as script>",
|
||||||
@ -152,6 +121,27 @@ export function generateFtlFilesCodeFactory(params: {
|
|||||||
].join("\n")
|
].join("\n")
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Remove part of the document marked as ignored.
|
||||||
|
{
|
||||||
|
const startTags = $('meta[name="keycloakify-ignore-start"]');
|
||||||
|
|
||||||
|
startTags.each((...[, startTag]) => {
|
||||||
|
const $startTag = $(startTag);
|
||||||
|
const $endTag = $startTag.nextAll('meta[name="keycloakify-ignore-end"]').first();
|
||||||
|
|
||||||
|
if ($endTag.length) {
|
||||||
|
let currentNode = $startTag.next();
|
||||||
|
while (currentNode.length && !currentNode.is($endTag)) {
|
||||||
|
currentNode.remove();
|
||||||
|
currentNode = $startTag.next();
|
||||||
|
}
|
||||||
|
|
||||||
|
$startTag.remove();
|
||||||
|
$endTag.remove();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
const partiallyFixedIndexHtmlCode = $.html();
|
const partiallyFixedIndexHtmlCode = $.html();
|
||||||
|
|
||||||
function generateFtlFilesCode(params: { pageId: string }): {
|
function generateFtlFilesCode(params: { pageId: string }): {
|
||||||
|
@ -10,6 +10,8 @@ export const loginThemePageIds = [
|
|||||||
"login-reset-password.ftl",
|
"login-reset-password.ftl",
|
||||||
"login-verify-email.ftl",
|
"login-verify-email.ftl",
|
||||||
"terms.ftl",
|
"terms.ftl",
|
||||||
|
"login-oauth2-device-verify-user-code.ftl",
|
||||||
|
"login-oauth-grant.ftl",
|
||||||
"login-otp.ftl",
|
"login-otp.ftl",
|
||||||
"login-update-profile.ftl",
|
"login-update-profile.ftl",
|
||||||
"login-update-password.ftl",
|
"login-update-password.ftl",
|
||||||
@ -21,7 +23,8 @@ export const loginThemePageIds = [
|
|||||||
"update-user-profile.ftl",
|
"update-user-profile.ftl",
|
||||||
"idp-review-user-profile.ftl",
|
"idp-review-user-profile.ftl",
|
||||||
"update-email.ftl",
|
"update-email.ftl",
|
||||||
"select-authenticator.ftl"
|
"select-authenticator.ftl",
|
||||||
|
"saml-post-form.ftl"
|
||||||
] as const;
|
] as const;
|
||||||
|
|
||||||
export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
|
export const accountThemePageIds = ["password.ftl", "account.ftl"] as const;
|
||||||
|
@ -1,88 +0,0 @@
|
|||||||
import * as fs from "fs";
|
|
||||||
import { join as pathJoin, dirname as pathDirname } from "path";
|
|
||||||
import { themeTypes } from "./generateFtl/generateFtl";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
import type { BuildOptions } from "./BuildOptions";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
|
||||||
themeName: string;
|
|
||||||
groupId: string;
|
|
||||||
artifactId?: string;
|
|
||||||
themeVersion: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function generateJavaStackFiles(params: {
|
|
||||||
keycloakThemeBuildingDirPath: string;
|
|
||||||
doBundlesEmailTemplate: boolean;
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
}): {
|
|
||||||
jarFilePath: string;
|
|
||||||
} {
|
|
||||||
const {
|
|
||||||
buildOptions: { groupId, themeName, themeVersion, artifactId },
|
|
||||||
keycloakThemeBuildingDirPath,
|
|
||||||
doBundlesEmailTemplate
|
|
||||||
} = 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": [
|
|
||||||
{
|
|
||||||
"name": themeName,
|
|
||||||
"types": [...themeTypes, ...(doBundlesEmailTemplate ? ["email"] : [])]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
|
||||||
null,
|
|
||||||
2
|
|
||||||
),
|
|
||||||
"utf8"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
return {
|
|
||||||
"jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${themeVersion}.jar`)
|
|
||||||
};
|
|
||||||
}
|
|
@ -0,0 +1,87 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin, dirname as pathDirname } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { Reflect } from "tsafe/Reflect";
|
||||||
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
|
import { resources_common, lastKeycloakVersionWithAccountV1, accountV1 } from "../../constants";
|
||||||
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
cacheDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
{
|
||||||
|
const buildOptions = Reflect<BuildOptions>();
|
||||||
|
|
||||||
|
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function bringInAccountV1(params: { buildOptions: BuildOptionsLike }) {
|
||||||
|
const { buildOptions } = params;
|
||||||
|
|
||||||
|
const builtinKeycloakThemeTmpDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "..", "tmp_yxdE2_builtin_keycloak_theme");
|
||||||
|
|
||||||
|
await downloadBuiltinKeycloakTheme({
|
||||||
|
"destDirPath": builtinKeycloakThemeTmpDirPath,
|
||||||
|
"keycloakVersion": lastKeycloakVersionWithAccountV1,
|
||||||
|
buildOptions
|
||||||
|
});
|
||||||
|
|
||||||
|
const accountV1DirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "theme", accountV1, "account");
|
||||||
|
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": pathJoin(builtinKeycloakThemeTmpDirPath, "base", "account"),
|
||||||
|
"destDirPath": accountV1DirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
const commonResourceFilePaths = [
|
||||||
|
"node_modules/patternfly/dist/css/patternfly.min.css",
|
||||||
|
"node_modules/patternfly/dist/css/patternfly-additions.min.css"
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const relativeFilePath of commonResourceFilePaths.map(path => pathJoin(...path.split("/")))) {
|
||||||
|
const destFilePath = pathJoin(accountV1DirPath, "resources", resources_common, relativeFilePath);
|
||||||
|
|
||||||
|
fs.mkdirSync(pathDirname(destFilePath), { "recursive": true });
|
||||||
|
|
||||||
|
fs.cpSync(pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "common", "resources", relativeFilePath), destFilePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
const resourceFilePaths = ["css/account.css"];
|
||||||
|
|
||||||
|
for (const relativeFilePath of resourceFilePaths.map(path => pathJoin(...path.split("/")))) {
|
||||||
|
const destFilePath = pathJoin(accountV1DirPath, "resources", relativeFilePath);
|
||||||
|
|
||||||
|
fs.mkdirSync(pathDirname(destFilePath), { "recursive": true });
|
||||||
|
|
||||||
|
fs.cpSync(pathJoin(builtinKeycloakThemeTmpDirPath, "keycloak", "account", "resources", relativeFilePath), destFilePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
fs.rmSync(builtinKeycloakThemeTmpDirPath, { "recursive": true });
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
pathJoin(accountV1DirPath, "theme.properties"),
|
||||||
|
Buffer.from(
|
||||||
|
[
|
||||||
|
"accountResourceProvider=account-v1",
|
||||||
|
"",
|
||||||
|
"locales=ar,ca,cs,da,de,en,es,fr,fi,hu,it,ja,lt,nl,no,pl,pt-BR,ru,sk,sv,tr,zh-CN",
|
||||||
|
"",
|
||||||
|
"styles=" + [...resourceFilePaths, ...commonResourceFilePaths.map(path => `resources_common/${path}`)].join(" "),
|
||||||
|
"",
|
||||||
|
"##### css classes for form buttons",
|
||||||
|
"# main class used for all buttons",
|
||||||
|
"kcButtonClass=btn",
|
||||||
|
"# classes defining priority of the button - primary or default (there is typically only one priority button for the form)",
|
||||||
|
"kcButtonPrimaryClass=btn-primary",
|
||||||
|
"kcButtonDefaultClass=btn-default",
|
||||||
|
"# classes defining size of the button",
|
||||||
|
"kcButtonLargeClass=btn-lg",
|
||||||
|
""
|
||||||
|
].join("\n"),
|
||||||
|
"utf8"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
@ -0,0 +1,140 @@
|
|||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin, dirname as pathDirname } from "path";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { Reflect } from "tsafe/Reflect";
|
||||||
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
|
import { type ThemeType, retrocompatPostfix, accountV1 } from "../../constants";
|
||||||
|
import { bringInAccountV1 } from "./bringInAccountV1";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
groupId: string;
|
||||||
|
artifactId: string;
|
||||||
|
themeVersion: string;
|
||||||
|
cacheDirPath: string;
|
||||||
|
keycloakifyBuildDirPath: string;
|
||||||
|
themeNames: string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
{
|
||||||
|
const buildOptions = Reflect<BuildOptions>();
|
||||||
|
|
||||||
|
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function generateJavaStackFiles(params: {
|
||||||
|
implementedThemeTypes: Record<ThemeType | "email", boolean>;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
|
}): Promise<{
|
||||||
|
jarFilePath: string;
|
||||||
|
}> {
|
||||||
|
const { implementedThemeTypes, buildOptions } = params;
|
||||||
|
|
||||||
|
{
|
||||||
|
const { pomFileCode } = (function generatePomFileCode(): {
|
||||||
|
pomFileCode: string;
|
||||||
|
} {
|
||||||
|
const pomFileCode = [
|
||||||
|
`<?xml version="1.0"?>`,
|
||||||
|
`<project xmlns="http://maven.apache.org/POM/4.0.0"`,
|
||||||
|
` xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`,
|
||||||
|
` xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">`,
|
||||||
|
` <modelVersion>4.0.0</modelVersion>`,
|
||||||
|
` <groupId>${buildOptions.groupId}</groupId>`,
|
||||||
|
` <artifactId>${buildOptions.artifactId}</artifactId>`,
|
||||||
|
` <version>${buildOptions.themeVersion}</version>`,
|
||||||
|
` <name>${buildOptions.artifactId}</name>`,
|
||||||
|
` <description />`,
|
||||||
|
` <packaging>jar</packaging>`,
|
||||||
|
` <properties>`,
|
||||||
|
` <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>`,
|
||||||
|
` </properties>`,
|
||||||
|
` <build>`,
|
||||||
|
` <plugins>`,
|
||||||
|
` <plugin>`,
|
||||||
|
` <groupId>org.apache.maven.plugins</groupId>`,
|
||||||
|
` <artifactId>maven-shade-plugin</artifactId>`,
|
||||||
|
` <version>3.5.1</version>`,
|
||||||
|
` <executions>`,
|
||||||
|
` <execution>`,
|
||||||
|
` <phase>package</phase>`,
|
||||||
|
` <goals>`,
|
||||||
|
` <goal>shade</goal>`,
|
||||||
|
` </goals>`,
|
||||||
|
` </execution>`,
|
||||||
|
` </executions>`,
|
||||||
|
` </plugin>`,
|
||||||
|
` </plugins>`,
|
||||||
|
` </build>`,
|
||||||
|
` <dependencies>`,
|
||||||
|
` <dependency>`,
|
||||||
|
` <groupId>io.phasetwo.keycloak</groupId>`,
|
||||||
|
` <artifactId>keycloak-account-v1</artifactId>`,
|
||||||
|
` <version>0.1</version>`,
|
||||||
|
` </dependency>`,
|
||||||
|
` </dependencies>`,
|
||||||
|
`</project>`
|
||||||
|
].join("\n");
|
||||||
|
|
||||||
|
return { pomFileCode };
|
||||||
|
})();
|
||||||
|
|
||||||
|
fs.writeFileSync(pathJoin(buildOptions.keycloakifyBuildDirPath, "pom.xml"), Buffer.from(pomFileCode, "utf8"));
|
||||||
|
}
|
||||||
|
|
||||||
|
if (implementedThemeTypes.account) {
|
||||||
|
await bringInAccountV1({ buildOptions });
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const themeManifestFilePath = pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources", "META-INF", "keycloak-themes.json");
|
||||||
|
|
||||||
|
try {
|
||||||
|
fs.mkdirSync(pathDirname(themeManifestFilePath));
|
||||||
|
} catch {}
|
||||||
|
|
||||||
|
fs.writeFileSync(
|
||||||
|
themeManifestFilePath,
|
||||||
|
Buffer.from(
|
||||||
|
JSON.stringify(
|
||||||
|
{
|
||||||
|
"themes": [
|
||||||
|
...(!implementedThemeTypes.account
|
||||||
|
? []
|
||||||
|
: [
|
||||||
|
{
|
||||||
|
"name": accountV1,
|
||||||
|
"types": ["account"]
|
||||||
|
}
|
||||||
|
]),
|
||||||
|
...buildOptions.themeNames
|
||||||
|
.map(themeName => [
|
||||||
|
{
|
||||||
|
"name": themeName,
|
||||||
|
"types": Object.entries(implementedThemeTypes)
|
||||||
|
.filter(([, isImplemented]) => isImplemented)
|
||||||
|
.map(([themeType]) => themeType)
|
||||||
|
},
|
||||||
|
...(!implementedThemeTypes.account
|
||||||
|
? []
|
||||||
|
: [
|
||||||
|
{
|
||||||
|
"name": `${themeName}${retrocompatPostfix}`,
|
||||||
|
"types": ["account"]
|
||||||
|
}
|
||||||
|
])
|
||||||
|
])
|
||||||
|
.flat()
|
||||||
|
]
|
||||||
|
},
|
||||||
|
null,
|
||||||
|
2
|
||||||
|
),
|
||||||
|
"utf8"
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"jarFilePath": pathJoin(buildOptions.keycloakifyBuildDirPath, "target", `${buildOptions.artifactId}-${buildOptions.themeVersion}.jar`)
|
||||||
|
};
|
||||||
|
}
|
1
src/bin/keycloakify/generateJavaStackFiles/index.ts
Normal file
1
src/bin/keycloakify/generateJavaStackFiles/index.ts
Normal file
@ -0,0 +1 @@
|
|||||||
|
export * from "./generateJavaStackFiles";
|
@ -1,11 +1,11 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin, relative as pathRelative, basename as pathBasename } from "path";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { Reflect } from "tsafe/Reflect";
|
import { Reflect } from "tsafe/Reflect";
|
||||||
import type { BuildOptions } from "./BuildOptions";
|
import type { BuildOptions } from "./BuildOptions";
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
themeName: string;
|
keycloakifyBuildDirPath: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
{
|
{
|
||||||
@ -19,39 +19,44 @@ generateStartKeycloakTestingContainer.basename = "start_keycloak_testing_contain
|
|||||||
const containerName = "keycloak-testing-container";
|
const containerName = "keycloak-testing-container";
|
||||||
|
|
||||||
/** Files for being able to run a hot reload keycloak container */
|
/** Files for being able to run a hot reload keycloak container */
|
||||||
export function generateStartKeycloakTestingContainer(params: {
|
export function generateStartKeycloakTestingContainer(params: { jarFilePath: string; keycloakVersion: string; buildOptions: BuildOptionsLike }) {
|
||||||
keycloakVersion: string;
|
const { jarFilePath, keycloakVersion, buildOptions } = params;
|
||||||
keycloakThemeBuildingDirPath: string;
|
|
||||||
buildOptions: BuildOptionsLike;
|
|
||||||
}) {
|
|
||||||
const {
|
|
||||||
keycloakThemeBuildingDirPath,
|
|
||||||
keycloakVersion,
|
|
||||||
buildOptions: { themeName }
|
|
||||||
} = params;
|
|
||||||
|
|
||||||
const keycloakThemePath = pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", themeName).replace(/\\/g, "/");
|
const themeRelativeDirPath = pathJoin("src", "main", "resources", "theme");
|
||||||
|
const themeDirPath = pathJoin(buildOptions.keycloakifyBuildDirPath, themeRelativeDirPath);
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename),
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename),
|
||||||
|
|
||||||
Buffer.from(
|
Buffer.from(
|
||||||
[
|
[
|
||||||
"#!/usr/bin/env bash",
|
"#!/usr/bin/env bash",
|
||||||
|
`# If you want to test with Keycloak version prior to 23 use the retrocompat-${pathBasename(jarFilePath)}`,
|
||||||
"",
|
"",
|
||||||
`docker rm ${containerName} || true`,
|
`docker rm ${containerName} || true`,
|
||||||
"",
|
"",
|
||||||
`cd "${keycloakThemeBuildingDirPath.replace(/\\/g, "/")}"`,
|
`cd "${buildOptions.keycloakifyBuildDirPath}"`,
|
||||||
"",
|
"",
|
||||||
"docker run \\",
|
"docker run \\",
|
||||||
" -p 8080:8080 \\",
|
" -p 8080:8080 \\",
|
||||||
` --name ${containerName} \\`,
|
` --name ${containerName} \\`,
|
||||||
" -e KEYCLOAK_ADMIN=admin \\",
|
" -e KEYCLOAK_ADMIN=admin \\",
|
||||||
" -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
|
" -e KEYCLOAK_ADMIN_PASSWORD=admin \\",
|
||||||
" -e JAVA_OPTS=-Dkeycloak.profile=preview \\",
|
` -v "${pathJoin(
|
||||||
` -v "${keycloakThemePath}":"/opt/keycloak/themes/${themeName}":rw \\`,
|
"$(pwd)",
|
||||||
|
pathRelative(buildOptions.keycloakifyBuildDirPath, jarFilePath)
|
||||||
|
)}":"/opt/keycloak/providers/${pathBasename(jarFilePath)}" \\`,
|
||||||
|
...fs
|
||||||
|
.readdirSync(themeDirPath)
|
||||||
|
.filter(name => fs.lstatSync(pathJoin(themeDirPath, name)).isDirectory())
|
||||||
|
.map(
|
||||||
|
themeName =>
|
||||||
|
` -v "${pathJoin("$(pwd)", themeRelativeDirPath, themeName).replace(
|
||||||
|
/\\/g,
|
||||||
|
"/"
|
||||||
|
)}":"/opt/keycloak/themes/${themeName}":rw \\`
|
||||||
|
),
|
||||||
` -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
|
` -it quay.io/keycloak/keycloak:${keycloakVersion} \\`,
|
||||||
` start-dev`,
|
` start-dev --features=declarative-user-profile`,
|
||||||
""
|
""
|
||||||
].join("\n"),
|
].join("\n"),
|
||||||
"utf8"
|
"utf8"
|
||||||
|
@ -1,37 +1,88 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin, relative as pathRelative } from "path";
|
import { join as pathJoin, dirname as pathDirname } from "path";
|
||||||
import type { ThemeType } from "../generateFtl";
|
|
||||||
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
import { downloadBuiltinKeycloakTheme } from "../../download-builtin-keycloak-theme";
|
||||||
import { mockTestingResourcesCommonPath, mockTestingResourcesPath, mockTestingSubDirOfPublicDirBasename } from "../../mockTestingResourcesPath";
|
import { resources_common, type ThemeType } from "../../constants";
|
||||||
|
import { BuildOptions } from "../BuildOptions";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import * as crypto from "crypto";
|
||||||
|
|
||||||
|
export type BuildOptionsLike = {
|
||||||
|
cacheDirPath: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function downloadKeycloakStaticResources(
|
export async function downloadKeycloakStaticResources(
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
params: {
|
params: {
|
||||||
themeType: ThemeType;
|
themeType: ThemeType;
|
||||||
themeDirPath: string;
|
themeDirPath: string;
|
||||||
isSilent: boolean;
|
|
||||||
keycloakVersion: string;
|
keycloakVersion: string;
|
||||||
|
usedResources: {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} | undefined;
|
||||||
|
buildOptions: BuildOptionsLike;
|
||||||
}
|
}
|
||||||
) {
|
) {
|
||||||
const { themeType, isSilent, themeDirPath, keycloakVersion } = params;
|
const { themeType, themeDirPath, keycloakVersion, buildOptions } = params;
|
||||||
|
|
||||||
const tmpDirPath = pathJoin(themeDirPath, "..", "tmp_suLeKsxId");
|
// NOTE: Hack for 427
|
||||||
|
const usedResources = (() => {
|
||||||
|
const { usedResources } = params;
|
||||||
|
|
||||||
|
if (usedResources === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
assert(usedResources !== undefined);
|
||||||
|
|
||||||
|
return {
|
||||||
|
"resourcesCommonDirPaths": usedResources.resourcesCommonFilePaths.map(filePath => {
|
||||||
|
{
|
||||||
|
const splitArg = "/dist/";
|
||||||
|
|
||||||
|
if (filePath.includes(splitArg)) {
|
||||||
|
return filePath.split(splitArg)[0] + splitArg;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathDirname(filePath);
|
||||||
|
})
|
||||||
|
};
|
||||||
|
})();
|
||||||
|
|
||||||
|
const tmpDirPath = pathJoin(
|
||||||
|
themeDirPath,
|
||||||
|
`tmp_suLeKsxId_${crypto.createHash("sha256").update(`${themeType}-${keycloakVersion}`).digest("hex").slice(0, 8)}`
|
||||||
|
);
|
||||||
|
|
||||||
await downloadBuiltinKeycloakTheme({
|
await downloadBuiltinKeycloakTheme({
|
||||||
keycloakVersion,
|
keycloakVersion,
|
||||||
"destDirPath": tmpDirPath,
|
"destDirPath": tmpDirPath,
|
||||||
isSilent
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
|
const resourcesPath = pathJoin(themeDirPath, themeType, "resources");
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", themeType, "resources"),
|
||||||
"destDirPath": pathJoin(themeDirPath, pathRelative(mockTestingSubDirOfPublicDirBasename, mockTestingResourcesPath))
|
"destDirPath": resourcesPath
|
||||||
});
|
});
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
"srcDirPath": pathJoin(tmpDirPath, "keycloak", "common", "resources"),
|
||||||
"destDirPath": pathJoin(themeDirPath, pathRelative(mockTestingSubDirOfPublicDirBasename, mockTestingResourcesCommonPath))
|
"destDirPath": pathJoin(resourcesPath, resources_common),
|
||||||
|
"transformSourceCode":
|
||||||
|
usedResources === undefined
|
||||||
|
? undefined
|
||||||
|
: ({ fileRelativePath, sourceCode }) => {
|
||||||
|
if (usedResources.resourcesCommonDirPaths.find(dirPath => fileRelativePath.startsWith(dirPath)) === undefined) {
|
||||||
|
return undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
fs.rmSync(tmpDirPath, { "recursive": true, "force": true });
|
||||||
|
179
src/bin/keycloakify/generateTheme/generateMessageProperties.ts
Normal file
179
src/bin/keycloakify/generateTheme/generateMessageProperties.ts
Normal file
@ -0,0 +1,179 @@
|
|||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
import { crawl } from "../../tools/crawl";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import { readFileSync } from "fs";
|
||||||
|
import { symToStr } from "tsafe/symToStr";
|
||||||
|
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
||||||
|
import * as recast from "recast";
|
||||||
|
import * as babelParser from "@babel/parser";
|
||||||
|
import babelGenerate from "@babel/generator";
|
||||||
|
import * as babelTypes from "@babel/types";
|
||||||
|
|
||||||
|
export function generateMessageProperties(params: {
|
||||||
|
themeSrcDirPath: string;
|
||||||
|
themeType: ThemeType;
|
||||||
|
}): { languageTag: string; propertiesFileSource: string }[] {
|
||||||
|
const { themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
|
let files = crawl({
|
||||||
|
"dirPath": pathJoin(themeSrcDirPath, themeType),
|
||||||
|
"returnedPathsType": "absolute"
|
||||||
|
});
|
||||||
|
|
||||||
|
files = files.filter(file => {
|
||||||
|
const regex = /\.(js|ts|tsx)$/;
|
||||||
|
return regex.test(file);
|
||||||
|
});
|
||||||
|
|
||||||
|
files = files.sort((a, b) => {
|
||||||
|
const regex = /\.i18n\.(ts|js|tsx)$/;
|
||||||
|
const aIsI18nFile = regex.test(a);
|
||||||
|
const bIsI18nFile = regex.test(b);
|
||||||
|
return aIsI18nFile === bIsI18nFile ? 0 : aIsI18nFile ? -1 : 1;
|
||||||
|
});
|
||||||
|
|
||||||
|
files = files.sort((a, b) => a.length - b.length);
|
||||||
|
|
||||||
|
files = files.filter(file => readFileSync(file).toString("utf8").includes("createUseI18n"));
|
||||||
|
|
||||||
|
if (files.length === 0) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
const extraMessages = files
|
||||||
|
.map(file => {
|
||||||
|
const root = recast.parse(readFileSync(file).toString("utf8"), {
|
||||||
|
"parser": {
|
||||||
|
"parse": (code: string) => babelParser.parse(code, { "sourceType": "module", "plugins": ["typescript"] }),
|
||||||
|
"generator": babelGenerate,
|
||||||
|
"types": babelTypes
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const codes: string[] = [];
|
||||||
|
|
||||||
|
recast.visit(root, {
|
||||||
|
"visitCallExpression": function (path) {
|
||||||
|
if (path.node.callee.type === "Identifier" && path.node.callee.name === "createUseI18n") {
|
||||||
|
codes.push(babelGenerate(path.node.arguments[0] as any).code);
|
||||||
|
}
|
||||||
|
this.traverse(path);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return codes;
|
||||||
|
})
|
||||||
|
.flat()
|
||||||
|
.map(code => {
|
||||||
|
let extraMessages: { [languageTag: string]: Record<string, string> } = {};
|
||||||
|
|
||||||
|
try {
|
||||||
|
eval(`${symToStr({ extraMessages })} = ${code}`);
|
||||||
|
} catch {
|
||||||
|
console.warn(
|
||||||
|
[
|
||||||
|
"WARNING: Make sure that the first argument of createUseI18n can be evaluated in a javascript",
|
||||||
|
"runtime where only the node globals are available.",
|
||||||
|
"This is important because we need to put your i18n messages in messages_*.properties files",
|
||||||
|
"or they won't be available server side.",
|
||||||
|
"\n",
|
||||||
|
"The following code could not be evaluated:",
|
||||||
|
"\n",
|
||||||
|
code
|
||||||
|
].join(" ")
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return extraMessages;
|
||||||
|
});
|
||||||
|
|
||||||
|
const languageTags = extraMessages
|
||||||
|
.map(extraMessage => Object.keys(extraMessage))
|
||||||
|
.flat()
|
||||||
|
.reduce(...removeDuplicates<string>());
|
||||||
|
|
||||||
|
const keyValueMapByLanguageTag: Record<string, Record<string, string>> = {};
|
||||||
|
|
||||||
|
for (const languageTag of languageTags) {
|
||||||
|
const keyValueMap: Record<string, string> = {};
|
||||||
|
|
||||||
|
for (const extraMessage of extraMessages) {
|
||||||
|
const keyValueMap_i = extraMessage[languageTag];
|
||||||
|
|
||||||
|
if (keyValueMap_i === undefined) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const [key, value] of Object.entries(keyValueMap_i)) {
|
||||||
|
if (keyValueMap[key] !== undefined) {
|
||||||
|
console.warn(
|
||||||
|
[
|
||||||
|
"WARNING: The following key is defined multiple times:",
|
||||||
|
"\n",
|
||||||
|
key,
|
||||||
|
"\n",
|
||||||
|
"The following value will be ignored:",
|
||||||
|
"\n",
|
||||||
|
value,
|
||||||
|
"\n",
|
||||||
|
"The following value was already defined:",
|
||||||
|
"\n",
|
||||||
|
keyValueMap[key]
|
||||||
|
].join(" ")
|
||||||
|
);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
keyValueMap[key] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
keyValueMapByLanguageTag[languageTag] = keyValueMap;
|
||||||
|
}
|
||||||
|
|
||||||
|
const out: { languageTag: string; propertiesFileSource: string }[] = [];
|
||||||
|
|
||||||
|
for (const [languageTag, keyValueMap] of Object.entries(keyValueMapByLanguageTag)) {
|
||||||
|
const propertiesFileSource = Object.entries(keyValueMap)
|
||||||
|
.map(([key, value]) => `${key}=${escapeString(value)}`)
|
||||||
|
.join("\n");
|
||||||
|
|
||||||
|
out.push({
|
||||||
|
languageTag,
|
||||||
|
"propertiesFileSource": ["# This file was generated by keycloakify", "", "parent=base", "", propertiesFileSource, ""].join("\n")
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert a JavaScript string to UTF-16 encoding
|
||||||
|
function toUTF16(codePoint: number): string {
|
||||||
|
if (codePoint <= 0xffff) {
|
||||||
|
// BMP character
|
||||||
|
return "\\u" + codePoint.toString(16).padStart(4, "0");
|
||||||
|
} else {
|
||||||
|
// Non-BMP character
|
||||||
|
codePoint -= 0x10000;
|
||||||
|
let highSurrogate = (codePoint >> 10) + 0xd800;
|
||||||
|
let lowSurrogate = (codePoint % 0x400) + 0xdc00;
|
||||||
|
return "\\u" + highSurrogate.toString(16).padStart(4, "0") + "\\u" + lowSurrogate.toString(16).padStart(4, "0");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Escapes special characters and converts unicode to UTF-16 encoding
|
||||||
|
function escapeString(str: string): string {
|
||||||
|
let escapedStr = "";
|
||||||
|
for (const char of [...str]) {
|
||||||
|
const codePoint = char.codePointAt(0);
|
||||||
|
if (!codePoint) continue;
|
||||||
|
if (char === "'") {
|
||||||
|
escapedStr += "''"; // double single quotes
|
||||||
|
} else if (codePoint > 0x7f) {
|
||||||
|
escapedStr += toUTF16(codePoint); // non-ascii characters
|
||||||
|
} else {
|
||||||
|
escapedStr += char;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return escapedStr;
|
||||||
|
}
|
@ -1,90 +1,80 @@
|
|||||||
import { transformCodebase } from "../../tools/transformCodebase";
|
import { transformCodebase } from "../../tools/transformCodebase";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { join as pathJoin } from "path";
|
import { join as pathJoin, basename as pathBasename, resolve as pathResolve } from "path";
|
||||||
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
import { replaceImportsFromStaticInJsCode } from "../replacers/replaceImportsFromStaticInJsCode";
|
||||||
import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
|
import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
|
||||||
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds, themeTypes, type ThemeType } from "../generateFtl";
|
import { generateFtlFilesCodeFactory, loginThemePageIds, accountThemePageIds } from "../generateFtl";
|
||||||
import { mockTestingSubDirOfPublicDirBasename } from "../../mockTestingResourcesPath";
|
import { themeTypes, type ThemeType, lastKeycloakVersionWithAccountV1, keycloak_resources, retrocompatPostfix, accountV1 } from "../../constants";
|
||||||
import { isInside } from "../../tools/isInside";
|
import { isInside } from "../../tools/isInside";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
|
import { downloadKeycloakStaticResources } from "./downloadKeycloakStaticResources";
|
||||||
|
import { readFieldNameUsage } from "./readFieldNameUsage";
|
||||||
|
import { readExtraPagesNames } from "./readExtraPageNames";
|
||||||
|
import { generateMessageProperties } from "./generateMessageProperties";
|
||||||
|
import { readStaticResourcesUsage } from "./readStaticResourcesUsage";
|
||||||
|
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
export type BuildOptionsLike = {
|
||||||
|
extraThemeProperties: string[] | undefined;
|
||||||
export namespace BuildOptionsLike {
|
themeVersion: string;
|
||||||
export type Common = {
|
loginThemeResourcesFromKeycloakVersion: string;
|
||||||
themeName: string;
|
urlPathname: string | undefined;
|
||||||
extraLoginPages?: string[];
|
keycloakifyBuildDirPath: string;
|
||||||
extraAccountPages?: string[];
|
reactAppBuildDirPath: string;
|
||||||
extraThemeProperties?: string[];
|
cacheDirPath: string;
|
||||||
isSilent: boolean;
|
doBuildRetrocompatAccountTheme: boolean;
|
||||||
customUserAttributes: string[];
|
};
|
||||||
themeVersion: string;
|
|
||||||
keycloakVersionDefaultAssets: string;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
|
||||||
isStandalone: true;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = ExternalAssets.SameDomain | ExternalAssets.DifferentDomains;
|
|
||||||
|
|
||||||
export namespace ExternalAssets {
|
|
||||||
export type CommonExternalAssets = Common & {
|
|
||||||
isStandalone: false;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type SameDomain = CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type DifferentDomains = CommonExternalAssets & {
|
|
||||||
areAppAndKeycloakServerSharingSameDomain: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
|
|
||||||
export async function generateTheme(params: {
|
export async function generateTheme(params: {
|
||||||
reactAppBuildDirPath: string;
|
themeName: string;
|
||||||
keycloakThemeBuildingDirPath: string;
|
themeSrcDirPath: string;
|
||||||
emailThemeSrcDirPath: string | undefined;
|
keycloakifySrcDirPath: string;
|
||||||
buildOptions: BuildOptionsLike;
|
buildOptions: BuildOptionsLike;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
}): Promise<{ doBundlesEmailTemplate: boolean }> {
|
}): Promise<void> {
|
||||||
const { reactAppBuildDirPath, keycloakThemeBuildingDirPath, emailThemeSrcDirPath, buildOptions, keycloakifyVersion } = params;
|
const { themeName, themeSrcDirPath, keycloakifySrcDirPath, buildOptions, keycloakifyVersion } = params;
|
||||||
|
|
||||||
const getThemeDirPath = (themeType: ThemeType | "email") =>
|
const getThemeTypeDirPath = (params: { themeType: ThemeType | "email"; isRetrocompat?: true }) => {
|
||||||
pathJoin(keycloakThemeBuildingDirPath, "src", "main", "resources", "theme", buildOptions.themeName, themeType);
|
const { themeType, isRetrocompat = false } = params;
|
||||||
|
return pathJoin(
|
||||||
|
buildOptions.keycloakifyBuildDirPath,
|
||||||
|
"src",
|
||||||
|
"main",
|
||||||
|
"resources",
|
||||||
|
"theme",
|
||||||
|
`${themeName}${isRetrocompat ? retrocompatPostfix : ""}`,
|
||||||
|
themeType
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
let allCssGlobalsToDefine: Record<string, string> = {};
|
let allCssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
let generateFtlFilesCode_glob: ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"] | undefined = undefined;
|
let generateFtlFilesCode_glob: ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"] | undefined = undefined;
|
||||||
|
|
||||||
for (const themeType of themeTypes) {
|
for (const themeType of themeTypes) {
|
||||||
const themeDirPath = getThemeDirPath(themeType);
|
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const themeTypeDirPath = getThemeTypeDirPath({ themeType });
|
||||||
|
|
||||||
copy_app_resources_to_theme_path: {
|
copy_app_resources_to_theme_path: {
|
||||||
const isFirstPass = themeType.indexOf(themeType) === 0;
|
const isFirstPass = themeType.indexOf(themeType) === 0;
|
||||||
|
|
||||||
if (!isFirstPass && !buildOptions.isStandalone) {
|
if (!isFirstPass) {
|
||||||
break copy_app_resources_to_theme_path;
|
break copy_app_resources_to_theme_path;
|
||||||
}
|
}
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"destDirPath": buildOptions.isStandalone ? pathJoin(themeDirPath, "resources", "build") : reactAppBuildDirPath,
|
"destDirPath": pathJoin(themeTypeDirPath, "resources", "build"),
|
||||||
"srcDirPath": reactAppBuildDirPath,
|
"srcDirPath": buildOptions.reactAppBuildDirPath,
|
||||||
"transformSourceCode": ({ filePath, sourceCode }) => {
|
"transformSourceCode": ({ filePath, sourceCode }) => {
|
||||||
//NOTE: Prevent cycles, excludes the folder we generated for debug in public/
|
//NOTE: Prevent cycles, excludes the folder we generated for debug in public/
|
||||||
if (
|
if (
|
||||||
buildOptions.isStandalone &&
|
|
||||||
isInside({
|
isInside({
|
||||||
"dirPath": pathJoin(reactAppBuildDirPath, mockTestingSubDirOfPublicDirBasename),
|
"dirPath": pathJoin(buildOptions.reactAppBuildDirPath, keycloak_resources),
|
||||||
filePath
|
filePath
|
||||||
})
|
})
|
||||||
) {
|
) {
|
||||||
@ -92,10 +82,6 @@ export async function generateTheme(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (/\.css?$/i.test(filePath)) {
|
if (/\.css?$/i.test(filePath)) {
|
||||||
if (!buildOptions.isStandalone) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
|
const { cssGlobalsToDefine, fixedCssCode } = replaceImportsInCssCode({
|
||||||
"cssCode": sourceCode.toString("utf8")
|
"cssCode": sourceCode.toString("utf8")
|
||||||
});
|
});
|
||||||
@ -115,37 +101,34 @@ export async function generateTheme(params: {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (/\.js?$/i.test(filePath)) {
|
if (/\.js?$/i.test(filePath)) {
|
||||||
if (!buildOptions.isStandalone && buildOptions.areAppAndKeycloakServerSharingSameDomain) {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
const { fixedJsCode } = replaceImportsFromStaticInJsCode({
|
||||||
"jsCode": sourceCode.toString("utf8"),
|
"jsCode": sourceCode.toString("utf8")
|
||||||
buildOptions
|
|
||||||
});
|
});
|
||||||
|
|
||||||
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
return { "modifiedSourceCode": Buffer.from(fixedJsCode, "utf8") };
|
||||||
}
|
}
|
||||||
|
|
||||||
return buildOptions.isStandalone ? { "modifiedSourceCode": sourceCode } : undefined;
|
return { "modifiedSourceCode": sourceCode };
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
const generateFtlFilesCode = (() => {
|
const generateFtlFilesCode =
|
||||||
if (generateFtlFilesCode_glob !== undefined) {
|
generateFtlFilesCode_glob !== undefined
|
||||||
return generateFtlFilesCode_glob;
|
? generateFtlFilesCode_glob
|
||||||
}
|
: generateFtlFilesCodeFactory({
|
||||||
|
themeName,
|
||||||
const { generateFtlFilesCode } = generateFtlFilesCodeFactory({
|
"indexHtmlCode": fs.readFileSync(pathJoin(buildOptions.reactAppBuildDirPath, "index.html")).toString("utf8"),
|
||||||
"indexHtmlCode": fs.readFileSync(pathJoin(reactAppBuildDirPath, "index.html")).toString("utf8"),
|
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
||||||
"cssGlobalsToDefine": allCssGlobalsToDefine,
|
buildOptions,
|
||||||
buildOptions,
|
keycloakifyVersion,
|
||||||
keycloakifyVersion
|
themeType,
|
||||||
});
|
"fieldNames": readFieldNameUsage({
|
||||||
|
keycloakifySrcDirPath,
|
||||||
return generateFtlFilesCode;
|
themeSrcDirPath,
|
||||||
})();
|
themeType
|
||||||
|
})
|
||||||
|
}).generateFtlFilesCode;
|
||||||
|
|
||||||
[
|
[
|
||||||
...(() => {
|
...(() => {
|
||||||
@ -156,72 +139,96 @@ export async function generateTheme(params: {
|
|||||||
return accountThemePageIds;
|
return accountThemePageIds;
|
||||||
}
|
}
|
||||||
})(),
|
})(),
|
||||||
...((() => {
|
...readExtraPagesNames({
|
||||||
switch (themeType) {
|
themeType,
|
||||||
case "login":
|
themeSrcDirPath
|
||||||
return buildOptions.extraLoginPages;
|
})
|
||||||
case "account":
|
|
||||||
return buildOptions.extraAccountPages;
|
|
||||||
}
|
|
||||||
})() ?? [])
|
|
||||||
].forEach(pageId => {
|
].forEach(pageId => {
|
||||||
const { ftlCode } = generateFtlFilesCode({ pageId });
|
const { ftlCode } = generateFtlFilesCode({ pageId });
|
||||||
|
|
||||||
fs.mkdirSync(themeDirPath, { "recursive": true });
|
fs.mkdirSync(themeTypeDirPath, { "recursive": true });
|
||||||
|
|
||||||
fs.writeFileSync(pathJoin(themeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
fs.writeFileSync(pathJoin(themeTypeDirPath, pageId), Buffer.from(ftlCode, "utf8"));
|
||||||
});
|
});
|
||||||
|
|
||||||
const downloadKeycloakStaticResources_configured = async (themeDirPath: string) =>
|
generateMessageProperties({
|
||||||
await downloadKeycloakStaticResources({
|
themeSrcDirPath,
|
||||||
"isSilent": buildOptions.isSilent,
|
themeType
|
||||||
"keycloakVersion": buildOptions.keycloakVersionDefaultAssets,
|
}).forEach(({ languageTag, propertiesFileSource }) => {
|
||||||
themeDirPath,
|
const messagesDirPath = pathJoin(themeTypeDirPath, "messages");
|
||||||
|
|
||||||
|
fs.mkdirSync(pathJoin(themeTypeDirPath, "messages"), { "recursive": true });
|
||||||
|
|
||||||
|
const propertiesFilePath = pathJoin(messagesDirPath, `messages_${languageTag}.properties`);
|
||||||
|
|
||||||
|
fs.writeFileSync(propertiesFilePath, Buffer.from(propertiesFileSource, "utf8"));
|
||||||
|
});
|
||||||
|
|
||||||
|
await downloadKeycloakStaticResources({
|
||||||
|
"keycloakVersion": (() => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "account":
|
||||||
|
return lastKeycloakVersionWithAccountV1;
|
||||||
|
case "login":
|
||||||
|
return buildOptions.loginThemeResourcesFromKeycloakVersion;
|
||||||
|
}
|
||||||
|
})(),
|
||||||
|
"themeDirPath": pathResolve(pathJoin(themeTypeDirPath, "..")),
|
||||||
|
themeType,
|
||||||
|
"usedResources": readStaticResourcesUsage({
|
||||||
|
keycloakifySrcDirPath,
|
||||||
|
themeSrcDirPath,
|
||||||
themeType
|
themeType
|
||||||
});
|
}),
|
||||||
|
buildOptions
|
||||||
await downloadKeycloakStaticResources_configured(themeDirPath);
|
});
|
||||||
|
|
||||||
{
|
|
||||||
const keycloakResourcesWithinPublicDirPath = pathJoin(reactAppBuildDirPath, "..", "public", mockTestingSubDirOfPublicDirBasename);
|
|
||||||
|
|
||||||
await downloadKeycloakStaticResources_configured(keycloakResourcesWithinPublicDirPath);
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
|
||||||
pathJoin(keycloakResourcesWithinPublicDirPath, "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(keycloakResourcesWithinPublicDirPath, ".gitignore"), Buffer.from("*", "utf8"));
|
|
||||||
}
|
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
pathJoin(themeDirPath, "theme.properties"),
|
pathJoin(themeTypeDirPath, "theme.properties"),
|
||||||
Buffer.from(["parent=keycloak", ...(buildOptions.extraThemeProperties ?? [])].join("\n\n"), "utf8")
|
Buffer.from(
|
||||||
|
[
|
||||||
|
`parent=${(() => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "account":
|
||||||
|
return accountV1;
|
||||||
|
case "login":
|
||||||
|
return "keycloak";
|
||||||
|
}
|
||||||
|
assert<Equals<typeof themeType, never>>(false);
|
||||||
|
})()}`,
|
||||||
|
...(buildOptions.extraThemeProperties ?? [])
|
||||||
|
].join("\n\n"),
|
||||||
|
"utf8"
|
||||||
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
if (themeType === "account" && buildOptions.doBuildRetrocompatAccountTheme) {
|
||||||
|
transformCodebase({
|
||||||
|
"srcDirPath": themeTypeDirPath,
|
||||||
|
"destDirPath": getThemeTypeDirPath({ themeType, "isRetrocompat": true }),
|
||||||
|
"transformSourceCode": ({ filePath, sourceCode }) => {
|
||||||
|
if (pathBasename(filePath) === "theme.properties") {
|
||||||
|
return {
|
||||||
|
"modifiedSourceCode": Buffer.from(sourceCode.toString("utf8").replace(`parent=${accountV1}`, "parent=keycloak"), "utf8")
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
return { "modifiedSourceCode": sourceCode };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
let doBundlesEmailTemplate: boolean;
|
|
||||||
|
|
||||||
email: {
|
email: {
|
||||||
if (emailThemeSrcDirPath === undefined) {
|
const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
|
||||||
doBundlesEmailTemplate = false;
|
|
||||||
|
if (!fs.existsSync(emailThemeSrcDirPath)) {
|
||||||
break email;
|
break email;
|
||||||
}
|
}
|
||||||
|
|
||||||
doBundlesEmailTemplate = true;
|
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": emailThemeSrcDirPath,
|
"srcDirPath": emailThemeSrcDirPath,
|
||||||
"destDirPath": getThemeDirPath("email")
|
"destDirPath": getThemeTypeDirPath({ "themeType": "email" })
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
return { doBundlesEmailTemplate };
|
|
||||||
}
|
}
|
||||||
|
39
src/bin/keycloakify/generateTheme/readExtraPageNames.ts
Normal file
39
src/bin/keycloakify/generateTheme/readExtraPageNames.ts
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
import { crawl } from "../../tools/crawl";
|
||||||
|
import { accountThemePageIds, loginThemePageIds } from "../generateFtl";
|
||||||
|
import { id } from "tsafe/id";
|
||||||
|
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
|
||||||
|
export function readExtraPagesNames(params: { themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
||||||
|
const { themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
|
const filePaths = crawl({
|
||||||
|
"dirPath": pathJoin(themeSrcDirPath, themeType),
|
||||||
|
"returnedPathsType": "absolute"
|
||||||
|
}).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
||||||
|
|
||||||
|
const candidateFilePaths = filePaths.filter(filePath => /kcContext\.[^.]+$/.test(filePath));
|
||||||
|
|
||||||
|
if (candidateFilePaths.length === 0) {
|
||||||
|
candidateFilePaths.push(...filePaths);
|
||||||
|
}
|
||||||
|
|
||||||
|
const extraPages: string[] = [];
|
||||||
|
|
||||||
|
for (const candidateFilPath of candidateFilePaths) {
|
||||||
|
const rawSourceFile = fs.readFileSync(candidateFilPath).toString("utf8");
|
||||||
|
|
||||||
|
extraPages.push(...Array.from(rawSourceFile.matchAll(/["']?pageId["']?\s*:\s*["']([^.]+.ftl)["']/g), m => m[1]));
|
||||||
|
}
|
||||||
|
|
||||||
|
return extraPages.reduce(...removeDuplicates<string>()).filter(pageId => {
|
||||||
|
switch (themeType) {
|
||||||
|
case "account":
|
||||||
|
return !id<readonly string[]>(accountThemePageIds).includes(pageId);
|
||||||
|
case "login":
|
||||||
|
return !id<readonly string[]>(loginThemePageIds).includes(pageId);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
32
src/bin/keycloakify/generateTheme/readFieldNameUsage.ts
Normal file
32
src/bin/keycloakify/generateTheme/readFieldNameUsage.ts
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
import { crawl } from "../../tools/crawl";
|
||||||
|
import { removeDuplicates } from "evt/tools/reducers/removeDuplicates";
|
||||||
|
import { join as pathJoin } from "path";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
|
||||||
|
/** Assumes the theme type exists */
|
||||||
|
export function readFieldNameUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): string[] {
|
||||||
|
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
|
const fieldNames: 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("messagesPerField")) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
fieldNames.push(
|
||||||
|
...Array.from(rawSourceFile.matchAll(/(?:(?:printIfExists)|(?:existsError)|(?:get)|(?:exists))\(\s*["']([^"']+)["']/g), m => m[1])
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const out = fieldNames.reduce(...removeDuplicates<string>());
|
||||||
|
|
||||||
|
return out;
|
||||||
|
}
|
@ -0,0 +1,76 @@
|
|||||||
|
import { crawl } from "../../tools/crawl";
|
||||||
|
import { join as pathJoin, sep as pathSep } from "path";
|
||||||
|
import * as fs from "fs";
|
||||||
|
import type { ThemeType } from "../../constants";
|
||||||
|
|
||||||
|
/** Assumes the theme type exists */
|
||||||
|
export function readStaticResourcesUsage(params: { keycloakifySrcDirPath: string; themeSrcDirPath: string; themeType: ThemeType }): {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} {
|
||||||
|
const { keycloakifySrcDirPath, themeSrcDirPath, themeType } = params;
|
||||||
|
|
||||||
|
const resourcesCommonFilePaths = new Set<string>();
|
||||||
|
|
||||||
|
for (const srcDirPath of [pathJoin(keycloakifySrcDirPath, themeType), pathJoin(themeSrcDirPath, themeType)]) {
|
||||||
|
const filePaths = crawl({ "dirPath": srcDirPath, "returnedPathsType": "absolute" }).filter(filePath => /\.(ts|tsx|js|jsx)$/.test(filePath));
|
||||||
|
|
||||||
|
for (const filePath of filePaths) {
|
||||||
|
const rawSourceFile = fs.readFileSync(filePath).toString("utf8");
|
||||||
|
|
||||||
|
if (!rawSourceFile.includes("resourcesCommonPath") && !rawSourceFile.includes("resourcesPath")) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const wrap = readPaths({ rawSourceFile });
|
||||||
|
|
||||||
|
wrap.resourcesCommonFilePaths.forEach(filePath => resourcesCommonFilePaths.add(filePath));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Exported for testing purpose */
|
||||||
|
export function readPaths(params: { rawSourceFile: string }): {
|
||||||
|
resourcesCommonFilePaths: string[];
|
||||||
|
} {
|
||||||
|
const { rawSourceFile } = params;
|
||||||
|
|
||||||
|
const resourcesCommonFilePaths = new Set<string>();
|
||||||
|
|
||||||
|
{
|
||||||
|
const regexp = new RegExp(`resourcesCommonPath\\s*}([^\`]+)\``, "g");
|
||||||
|
|
||||||
|
const matches = [...rawSourceFile.matchAll(regexp)];
|
||||||
|
|
||||||
|
for (const match of matches) {
|
||||||
|
const filePath = match[1];
|
||||||
|
|
||||||
|
resourcesCommonFilePaths.add(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
{
|
||||||
|
const regexp = new RegExp(`resourcesCommonPath\\s*[+,]\\s*["']([^"'\`]+)["'\`]`, "g");
|
||||||
|
|
||||||
|
const matches = [...rawSourceFile.matchAll(regexp)];
|
||||||
|
|
||||||
|
for (const match of matches) {
|
||||||
|
const filePath = match[1];
|
||||||
|
|
||||||
|
resourcesCommonFilePaths.add(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const normalizePath = (filePath: string) => {
|
||||||
|
filePath = filePath.startsWith("/") ? filePath.slice(1) : filePath;
|
||||||
|
filePath = filePath.replace(/\//g, pathSep);
|
||||||
|
return filePath;
|
||||||
|
};
|
||||||
|
|
||||||
|
return {
|
||||||
|
"resourcesCommonFilePaths": Array.from(resourcesCommonFilePaths).map(normalizePath)
|
||||||
|
};
|
||||||
|
}
|
@ -1,96 +1,106 @@
|
|||||||
import { generateTheme } from "./generateTheme";
|
import { generateTheme } from "./generateTheme";
|
||||||
import { generateJavaStackFiles } from "./generateJavaStackFiles";
|
import { generateJavaStackFiles } from "./generateJavaStackFiles";
|
||||||
import { join as pathJoin, relative as pathRelative, basename as pathBasename, sep as pathSep } from "path";
|
import { join as pathJoin, relative as pathRelative, basename as pathBasename, dirname as pathDirname, sep as pathSep } from "path";
|
||||||
import * as child_process from "child_process";
|
import * as child_process from "child_process";
|
||||||
import { generateStartKeycloakTestingContainer } from "./generateStartKeycloakTestingContainer";
|
import { generateStartKeycloakTestingContainer } from "./generateStartKeycloakTestingContainer";
|
||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import { readBuildOptions } from "./BuildOptions";
|
import { readBuildOptions } from "./BuildOptions";
|
||||||
import { getLogger } from "../tools/logger";
|
import { getLogger } from "../tools/logger";
|
||||||
import { getCliOptions } from "../tools/cliOptions";
|
|
||||||
import jar from "../tools/jar";
|
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { Equals } from "tsafe";
|
import { getThemeSrcDirPath } from "../getSrcDirPath";
|
||||||
import { getEmailThemeSrcDirPath } from "../getSrcDirPath";
|
|
||||||
import { getProjectRoot } from "../tools/getProjectRoot";
|
import { getProjectRoot } from "../tools/getProjectRoot";
|
||||||
|
import { objectKeys } from "tsafe/objectKeys";
|
||||||
|
|
||||||
export async function main() {
|
export async function main() {
|
||||||
const { isSilent, hasExternalAssets } = getCliOptions(process.argv.slice(2));
|
const reactAppRootDirPath = process.cwd();
|
||||||
const logger = getLogger({ isSilent });
|
|
||||||
logger.log("🔏 Building the keycloak theme...⌚");
|
|
||||||
|
|
||||||
const projectDirPath = process.cwd();
|
|
||||||
|
|
||||||
const buildOptions = readBuildOptions({
|
const buildOptions = readBuildOptions({
|
||||||
projectDirPath,
|
reactAppRootDirPath,
|
||||||
"isExternalAssetsCliParamProvided": hasExternalAssets,
|
"processArgv": process.argv.slice(2)
|
||||||
"isSilent": isSilent
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const { doBundlesEmailTemplate } = await generateTheme({
|
const logger = getLogger({ "isSilent": buildOptions.isSilent });
|
||||||
keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
|
logger.log("🔏 Building the keycloak theme...⌚");
|
||||||
"emailThemeSrcDirPath": (() => {
|
|
||||||
const { emailThemeSrcDirPath } = getEmailThemeSrcDirPath({ projectDirPath });
|
|
||||||
|
|
||||||
if (emailThemeSrcDirPath === undefined || !fs.existsSync(emailThemeSrcDirPath)) {
|
const keycloakifyDirPath = getProjectRoot();
|
||||||
return;
|
|
||||||
|
const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
|
||||||
|
|
||||||
|
for (const themeName of buildOptions.themeNames) {
|
||||||
|
await generateTheme({
|
||||||
|
themeName,
|
||||||
|
themeSrcDirPath,
|
||||||
|
"keycloakifySrcDirPath": pathJoin(keycloakifyDirPath, "src"),
|
||||||
|
buildOptions,
|
||||||
|
"keycloakifyVersion": (() => {
|
||||||
|
const version = JSON.parse(fs.readFileSync(pathJoin(keycloakifyDirPath, "package.json")).toString("utf8"))["version"];
|
||||||
|
|
||||||
|
assert(typeof version === "string");
|
||||||
|
|
||||||
|
return version;
|
||||||
|
})()
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const { jarFilePath } = await generateJavaStackFiles({
|
||||||
|
"implementedThemeTypes": (() => {
|
||||||
|
const implementedThemeTypes = {
|
||||||
|
"login": false,
|
||||||
|
"account": false,
|
||||||
|
"email": false
|
||||||
|
};
|
||||||
|
|
||||||
|
for (const themeType of objectKeys(implementedThemeTypes)) {
|
||||||
|
if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
implementedThemeTypes[themeType] = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
return emailThemeSrcDirPath;
|
return implementedThemeTypes;
|
||||||
})(),
|
})(),
|
||||||
"reactAppBuildDirPath": buildOptions.reactAppBuildDirPath,
|
|
||||||
buildOptions,
|
|
||||||
"keycloakifyVersion": (() => {
|
|
||||||
const version = JSON.parse(fs.readFileSync(pathJoin(getProjectRoot(), "package.json")).toString("utf8"))["version"];
|
|
||||||
|
|
||||||
assert(typeof version === "string");
|
|
||||||
|
|
||||||
return version;
|
|
||||||
})()
|
|
||||||
});
|
|
||||||
|
|
||||||
const { jarFilePath } = generateJavaStackFiles({
|
|
||||||
keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
|
|
||||||
doBundlesEmailTemplate,
|
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
switch (buildOptions.bundler) {
|
if (buildOptions.doCreateJar) {
|
||||||
case "none":
|
child_process.execSync("mvn clean install", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
||||||
logger.log("😱 Skipping bundling step, there will be no jar");
|
|
||||||
break;
|
const jarDirPath = pathDirname(jarFilePath);
|
||||||
case "keycloakify":
|
const retrocompatJarFilePath = pathJoin(jarDirPath, "retrocompat-" + pathBasename(jarFilePath));
|
||||||
logger.log("🫶 Let keycloakify do its thang");
|
|
||||||
await jar({
|
fs.renameSync(pathJoin(jarDirPath, "original-" + pathBasename(jarFilePath)), retrocompatJarFilePath);
|
||||||
"rootPath": pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources"),
|
|
||||||
"version": buildOptions.themeVersion,
|
fs.writeFileSync(
|
||||||
"groupId": buildOptions.groupId,
|
pathJoin(jarDirPath, "README.md"),
|
||||||
"artifactId": buildOptions.artifactId,
|
Buffer.from(
|
||||||
"targetPath": jarFilePath
|
[
|
||||||
});
|
`- The ${jarFilePath} is to be used in Keycloak 23 and up. `,
|
||||||
break;
|
`- The ${retrocompatJarFilePath} is to be used in Keycloak 21 and below.`,
|
||||||
case "mvn":
|
` Note that Keycloak 22 is only supported for login and email theme but not for account themes. `
|
||||||
logger.log("🫙 Run maven to deliver a jar");
|
].join("\n"),
|
||||||
child_process.execSync("mvn package", { "cwd": buildOptions.keycloakifyBuildDirPath });
|
"utf8"
|
||||||
break;
|
)
|
||||||
default:
|
);
|
||||||
assert<Equals<typeof buildOptions.bundler, never>>(false);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// We want, however, to test in a container running the latest Keycloak version
|
const containerKeycloakVersion = "23.0.0";
|
||||||
const containerKeycloakVersion = "20.0.1";
|
|
||||||
|
|
||||||
generateStartKeycloakTestingContainer({
|
generateStartKeycloakTestingContainer({
|
||||||
keycloakThemeBuildingDirPath: buildOptions.keycloakifyBuildDirPath,
|
|
||||||
"keycloakVersion": containerKeycloakVersion,
|
"keycloakVersion": containerKeycloakVersion,
|
||||||
|
jarFilePath,
|
||||||
buildOptions
|
buildOptions
|
||||||
});
|
});
|
||||||
|
|
||||||
logger.log(
|
logger.log(
|
||||||
[
|
[
|
||||||
"",
|
"",
|
||||||
`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(projectDirPath, jarFilePath)} 🚀`,
|
...(!buildOptions.doCreateJar
|
||||||
`It is to be placed in "/opt/keycloak/providers" in the container running a quay.io/keycloak/keycloak Docker image.`,
|
? []
|
||||||
"",
|
: [
|
||||||
|
`✅ Your keycloak theme has been generated and bundled into .${pathSep}${pathRelative(reactAppRootDirPath, jarFilePath)} 🚀`,
|
||||||
|
`It is to be placed in "/opt/keycloak/providers" in the container running a quay.io/keycloak/keycloak Docker image.`,
|
||||||
|
""
|
||||||
|
]),
|
||||||
//TODO: Restore when we find a good Helm chart for Keycloak.
|
//TODO: Restore when we find a good Helm chart for Keycloak.
|
||||||
//"Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:",
|
//"Using Helm (https://github.com/codecentric/helm-charts), edit to reflect:",
|
||||||
"",
|
"",
|
||||||
@ -123,7 +133,7 @@ export async function main() {
|
|||||||
`To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
|
`To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
|
||||||
"",
|
"",
|
||||||
`👉 $ .${pathSep}${pathRelative(
|
`👉 $ .${pathSep}${pathRelative(
|
||||||
projectDirPath,
|
reactAppRootDirPath,
|
||||||
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
pathJoin(buildOptions.keycloakifyBuildDirPath, generateStartKeycloakTestingContainer.basename)
|
||||||
)} 👈`,
|
)} 👈`,
|
||||||
"",
|
"",
|
||||||
@ -131,16 +141,18 @@ export async function main() {
|
|||||||
``,
|
``,
|
||||||
`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: 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: Realm settings -> Themes tab -> Account theme, select ${buildOptions.themeName} `,
|
`- Enable the Account theme (optional): Realm settings -> Themes tab -> Account theme: ${buildOptions.themeNames[0]}`,
|
||||||
`- Create a client id myclient`,
|
` Clients -> account -> Login theme: ${buildOptions.themeNames[0]}`,
|
||||||
` Root URL: https://www.keycloak.org/app/`,
|
`- 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)`,
|
||||||
` Valid redirect URIs: https://www.keycloak.org/app* http://localhost* (localhost is optional)`,
|
`- Create a client Clients -> Create -> Client ID: myclient`,
|
||||||
` Valid post logout redirect URIs: https://www.keycloak.org/app* http://localhost*`,
|
` Root URL: https://www.keycloak.org/app/`,
|
||||||
` Web origins: *`,
|
` Valid redirect URIs: https://www.keycloak.org/app* http://localhost* (localhost is optional)`,
|
||||||
` Login Theme: ${buildOptions.themeName}`,
|
` Valid post logout redirect URIs: https://www.keycloak.org/app* http://localhost*`,
|
||||||
` Save (button at the bottom of the page)`,
|
` Web origins: *`,
|
||||||
|
` Login Theme: ${buildOptions.themeNames[0]}`,
|
||||||
|
` 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`,
|
||||||
`- Got to 👉 http://localhost:8080/realms/myrealm/account 👈 to see your account theme`,
|
`- Got to 👉 http://localhost:8080/realms/myrealm/account 👈 to see your account theme`,
|
||||||
|
@ -4,27 +4,21 @@ import type { Equals } from "tsafe";
|
|||||||
import { z } from "zod";
|
import { z } from "zod";
|
||||||
import { pathJoin } from "../tools/pathJoin";
|
import { pathJoin } from "../tools/pathJoin";
|
||||||
|
|
||||||
export const bundlers = ["mvn", "keycloakify", "none"] as const;
|
|
||||||
export type Bundler = (typeof bundlers)[number];
|
|
||||||
export type ParsedPackageJson = {
|
export type ParsedPackageJson = {
|
||||||
name: string;
|
name: string;
|
||||||
version?: string;
|
version?: string;
|
||||||
homepage?: string;
|
homepage?: string;
|
||||||
keycloakify?: {
|
keycloakify?: {
|
||||||
/** @deprecated: use extraLoginPages instead */
|
|
||||||
extraPages?: string[];
|
|
||||||
extraLoginPages?: string[];
|
|
||||||
extraAccountPages?: string[];
|
|
||||||
extraThemeProperties?: string[];
|
extraThemeProperties?: string[];
|
||||||
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
areAppAndKeycloakServerSharingSameDomain?: boolean;
|
||||||
artifactId?: string;
|
artifactId?: string;
|
||||||
groupId?: string;
|
groupId?: string;
|
||||||
bundler?: Bundler;
|
doCreateJar?: boolean;
|
||||||
keycloakVersionDefaultAssets?: string;
|
loginThemeResourcesFromKeycloakVersion?: string;
|
||||||
reactAppBuildDirPath?: string;
|
reactAppBuildDirPath?: string;
|
||||||
keycloakifyBuildDirPath?: string;
|
keycloakifyBuildDirPath?: string;
|
||||||
customUserAttributes?: string[];
|
themeName?: string | string[];
|
||||||
themeName?: string;
|
doBuildRetrocompatAccountTheme?: boolean;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -34,19 +28,16 @@ export const zParsedPackageJson = z.object({
|
|||||||
"homepage": z.string().optional(),
|
"homepage": z.string().optional(),
|
||||||
"keycloakify": z
|
"keycloakify": z
|
||||||
.object({
|
.object({
|
||||||
"extraPages": z.array(z.string()).optional(),
|
|
||||||
"extraLoginPages": z.array(z.string()).optional(),
|
|
||||||
"extraAccountPages": z.array(z.string()).optional(),
|
|
||||||
"extraThemeProperties": z.array(z.string()).optional(),
|
"extraThemeProperties": z.array(z.string()).optional(),
|
||||||
"areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
|
"areAppAndKeycloakServerSharingSameDomain": z.boolean().optional(),
|
||||||
"artifactId": z.string().optional(),
|
"artifactId": z.string().optional(),
|
||||||
"groupId": z.string().optional(),
|
"groupId": z.string().optional(),
|
||||||
"bundler": z.enum(bundlers).optional(),
|
"doCreateJar": z.boolean().optional(),
|
||||||
"keycloakVersionDefaultAssets": z.string().optional(),
|
"loginThemeResourcesFromKeycloakVersion": z.string().optional(),
|
||||||
"reactAppBuildDirPath": z.string().optional(),
|
"reactAppBuildDirPath": z.string().optional(),
|
||||||
"keycloakifyBuildDirPath": z.string().optional(),
|
"keycloakifyBuildDirPath": z.string().optional(),
|
||||||
"customUserAttributes": z.array(z.string()).optional(),
|
"themeName": z.union([z.string(), z.array(z.string())]).optional(),
|
||||||
"themeName": z.string().optional()
|
"doBuildRetrocompatAccountTheme": z.boolean().optional()
|
||||||
})
|
})
|
||||||
.optional()
|
.optional()
|
||||||
});
|
});
|
||||||
@ -54,11 +45,11 @@ export const zParsedPackageJson = z.object({
|
|||||||
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
assert<Equals<ReturnType<(typeof zParsedPackageJson)["parse"]>, ParsedPackageJson>>();
|
||||||
|
|
||||||
let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
|
let parsedPackageJson: undefined | ReturnType<(typeof zParsedPackageJson)["parse"]>;
|
||||||
export function getParsedPackageJson(params: { projectDirPath: string }) {
|
export function getParsedPackageJson(params: { reactAppRootDirPath: string }) {
|
||||||
const { projectDirPath } = params;
|
const { reactAppRootDirPath } = params;
|
||||||
if (parsedPackageJson) {
|
if (parsedPackageJson) {
|
||||||
return parsedPackageJson;
|
return parsedPackageJson;
|
||||||
}
|
}
|
||||||
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(projectDirPath, "package.json")).toString("utf8")));
|
parsedPackageJson = zParsedPackageJson.parse(JSON.parse(fs.readFileSync(pathJoin(reactAppRootDirPath, "package.json")).toString("utf8")));
|
||||||
return parsedPackageJson;
|
return parsedPackageJson;
|
||||||
}
|
}
|
||||||
|
@ -1,31 +1,6 @@
|
|||||||
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
|
||||||
import { assert } from "tsafe/assert";
|
|
||||||
import { is } from "tsafe/is";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
export function replaceImportsFromStaticInJsCode(params: { jsCode: string }): { fixedJsCode: string } {
|
||||||
|
|
||||||
export namespace BuildOptionsLike {
|
|
||||||
export type Standalone = {
|
|
||||||
isStandalone: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = {
|
|
||||||
isStandalone: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert(!is<BuildOptions.ExternalAssets.CommonExternalAssets>(buildOptions));
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function replaceImportsFromStaticInJsCode(params: { jsCode: string; buildOptions: BuildOptionsLike }): { fixedJsCode: string } {
|
|
||||||
/*
|
/*
|
||||||
NOTE:
|
NOTE:
|
||||||
|
|
||||||
@ -38,48 +13,38 @@ export function replaceImportsFromStaticInJsCode(params: { jsCode: string; build
|
|||||||
will always run in keycloak context.
|
will always run in keycloak context.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
const { jsCode, buildOptions } = params;
|
const { jsCode } = params;
|
||||||
|
|
||||||
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
const getReplaceArgs = (language: "js" | "css"): Parameters<typeof String.prototype.replace> => [
|
||||||
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=function\\(([a-zA-Z]+)\\){return"static\\/${language}\\/"`, "g"),
|
new RegExp(`([a-zA-Z_]+)\\.([a-zA-Z]+)=(function\\(([a-z]+)\\){return|([a-z]+)=>)"static\\/${language}\\/"`, "g"),
|
||||||
(...[, n, u, e]) => `
|
(...[, n, u, matchedFunction, eForFunction]) => {
|
||||||
${n}[(function(){
|
const isArrowFunction = matchedFunction.includes("=>");
|
||||||
var pd= Object.getOwnPropertyDescriptor(${n}, "p");
|
const e = isArrowFunction ? matchedFunction.replace("=>", "").trim() : eForFunction;
|
||||||
|
|
||||||
|
return `
|
||||||
|
${n}[(function(){
|
||||||
|
var pd = Object.getOwnPropertyDescriptor(${n}, "p");
|
||||||
if( pd === undefined || pd.configurable ){
|
if( pd === undefined || pd.configurable ){
|
||||||
${
|
|
||||||
buildOptions.isStandalone
|
|
||||||
? `
|
|
||||||
Object.defineProperty(${n}, "p", {
|
|
||||||
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
|
||||||
set: function (){}
|
|
||||||
});
|
|
||||||
`
|
|
||||||
: `
|
|
||||||
var p= "";
|
|
||||||
Object.defineProperty(${n}, "p", {
|
Object.defineProperty(${n}, "p", {
|
||||||
get: function() { return "${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}/" : p; },
|
get: function() { return window.${ftlValuesGlobalName}.url.resourcesPath; },
|
||||||
set: function (value){ p = value;}
|
set: function() {}
|
||||||
});
|
});
|
||||||
`
|
|
||||||
}
|
}
|
||||||
}
|
return "${u}";
|
||||||
return "${u}";
|
})()] = ${isArrowFunction ? `${e} =>` : `function(${e}) { return `} "/build/static/${language}/"`
|
||||||
})()] = function(${e}) { return "${buildOptions.isStandalone ? "/build/" : ""}static/${language}/"`
|
.replace(/\s+/g, " ")
|
||||||
|
.trim();
|
||||||
|
}
|
||||||
];
|
];
|
||||||
|
|
||||||
const fixedJsCode = jsCode
|
const fixedJsCode = jsCode
|
||||||
.replace(...getReplaceArgs("js"))
|
.replace(...getReplaceArgs("js"))
|
||||||
.replace(...getReplaceArgs("css"))
|
.replace(...getReplaceArgs("css"))
|
||||||
.replace(/([a-zA-Z]+\.[a-zA-Z]+)\+"static\//g, (...[, group]) =>
|
.replace(/[a-zA-Z]+\.[a-zA-Z]+\+"static\//g, `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`)
|
||||||
buildOptions.isStandalone
|
|
||||||
? `window.${ftlValuesGlobalName}.url.resourcesPath + "/build/static/`
|
|
||||||
: `("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}/" : ${group}) + "static/`
|
|
||||||
)
|
|
||||||
//TODO: Write a test case for this
|
//TODO: Write a test case for this
|
||||||
.replace(/".chunk.css",([a-zA-Z])+=([a-zA-Z]+\.[a-zA-Z]+)\+([a-zA-Z]+),/, (...[, group1, group2, group3]) =>
|
.replace(
|
||||||
buildOptions.isStandalone
|
/".chunk.css",([a-zA-Z])+=[a-zA-Z]+\.[a-zA-Z]+\+([a-zA-Z]+),/,
|
||||||
? `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group3},`
|
(...[, group1, group2]) => `".chunk.css",${group1} = window.${ftlValuesGlobalName}.url.resourcesPath + "/build/" + ${group2},`
|
||||||
: `".chunk.css",${group1} = ("${ftlValuesGlobalName}" in window ? "${buildOptions.urlOrigin}/" : ${group2}) + ${group3},`
|
|
||||||
);
|
);
|
||||||
|
|
||||||
return { fixedJsCode };
|
return { fixedJsCode };
|
||||||
|
@ -1,20 +1,12 @@
|
|||||||
import * as crypto from "crypto";
|
import * as crypto from "crypto";
|
||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { is } from "tsafe/is";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = {
|
export type BuildOptionsLike = {
|
||||||
urlPathname: string | undefined;
|
urlPathname: string | undefined;
|
||||||
};
|
};
|
||||||
|
|
||||||
{
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert(!is<BuildOptions.ExternalAssets.CommonExternalAssets>(buildOptions));
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function replaceImportsInCssCode(params: { cssCode: string }): {
|
export function replaceImportsInCssCode(params: { cssCode: string }): {
|
||||||
fixedCssCode: string;
|
fixedCssCode: string;
|
||||||
@ -24,7 +16,7 @@ export function replaceImportsInCssCode(params: { cssCode: string }): {
|
|||||||
|
|
||||||
const cssGlobalsToDefine: Record<string, string> = {};
|
const cssGlobalsToDefine: Record<string, string> = {};
|
||||||
|
|
||||||
new Set(cssCode.match(/url\(["']?\/[^/][^)"']+["']?\)[^;}]*/g) ?? []).forEach(
|
new Set(cssCode.match(/url\(["']?\/[^/][^)"']+["']?\)[^;}]*?/g) ?? []).forEach(
|
||||||
match => (cssGlobalsToDefine["url" + crypto.createHash("sha256").update(match).digest("hex").substring(0, 15)] = match)
|
match => (cssGlobalsToDefine["url" + crypto.createHash("sha256").update(match).digest("hex").substring(0, 15)] = match)
|
||||||
);
|
);
|
||||||
|
|
||||||
|
@ -1,32 +1,11 @@
|
|||||||
import type { BuildOptions } from "../BuildOptions";
|
import type { BuildOptions } from "../BuildOptions";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import { is } from "tsafe/is";
|
|
||||||
import { Reflect } from "tsafe/Reflect";
|
|
||||||
|
|
||||||
export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.ExternalAssets;
|
export type BuildOptionsLike = {
|
||||||
|
urlPathname: string | undefined;
|
||||||
|
};
|
||||||
|
|
||||||
export namespace BuildOptionsLike {
|
assert<BuildOptions extends BuildOptionsLike ? true : false>();
|
||||||
export type Common = {
|
|
||||||
urlPathname: string | undefined;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type Standalone = Common & {
|
|
||||||
isStandalone: true;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type ExternalAssets = Common & {
|
|
||||||
isStandalone: false;
|
|
||||||
urlOrigin: string;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
{
|
|
||||||
const buildOptions = Reflect<BuildOptions>();
|
|
||||||
|
|
||||||
assert(!is<BuildOptions.ExternalAssets.CommonExternalAssets>(buildOptions));
|
|
||||||
|
|
||||||
assert<typeof buildOptions extends BuildOptionsLike ? true : false>();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOptions: BuildOptionsLike }): {
|
export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOptions: BuildOptionsLike }): {
|
||||||
fixedCssCode: string;
|
fixedCssCode: string;
|
||||||
@ -37,10 +16,7 @@ export function replaceImportsInInlineCssCode(params: { cssCode: string; buildOp
|
|||||||
buildOptions.urlPathname === undefined
|
buildOptions.urlPathname === undefined
|
||||||
? /url\(["']?\/([^/][^)"']+)["']?\)/g
|
? /url\(["']?\/([^/][^)"']+)["']?\)/g
|
||||||
: new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
|
: new RegExp(`url\\(["']?${buildOptions.urlPathname}([^)"']+)["']?\\)`, "g"),
|
||||||
(...[, group]) =>
|
(...[, group]) => `url(\${url.resourcesPath}/build/${group})`
|
||||||
`url(${
|
|
||||||
buildOptions.isStandalone ? "${url.resourcesPath}/build/" + group : buildOptions.urlOrigin + (buildOptions.urlPathname ?? "/") + group
|
|
||||||
})`
|
|
||||||
);
|
);
|
||||||
|
|
||||||
return { fixedCssCode };
|
return { fixedCssCode };
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
import { pathJoin } from "./tools/pathJoin";
|
|
||||||
|
|
||||||
export const mockTestingSubDirOfPublicDirBasename = "keycloak_static";
|
|
||||||
export const mockTestingResourcesPath = pathJoin(mockTestingSubDirOfPublicDirBasename, "resources");
|
|
||||||
export const mockTestingResourcesCommonPath = pathJoin(mockTestingResourcesPath, "resources_common");
|
|
@ -17,7 +17,7 @@ export async function promptKeycloakVersion() {
|
|||||||
return { getLatestsSemVersionedTag };
|
return { getLatestsSemVersionedTag };
|
||||||
})();
|
})();
|
||||||
|
|
||||||
console.log("Initialize the directory with email template from which keycloak version?");
|
console.log("Select Keycloak version?");
|
||||||
|
|
||||||
const tags = [
|
const tags = [
|
||||||
...(await getLatestsSemVersionedTag({
|
...(await getLatestsSemVersionedTag({
|
||||||
|
@ -1,15 +0,0 @@
|
|||||||
import parseArgv from "minimist";
|
|
||||||
|
|
||||||
export type CliOptions = {
|
|
||||||
isSilent: boolean;
|
|
||||||
hasExternalAssets: boolean;
|
|
||||||
};
|
|
||||||
|
|
||||||
export const getCliOptions = (processArgv: string[]): CliOptions => {
|
|
||||||
const argv = parseArgv(processArgv);
|
|
||||||
|
|
||||||
return {
|
|
||||||
isSilent: typeof argv["silent"] === "boolean" ? argv["silent"] : false,
|
|
||||||
hasExternalAssets: typeof argv["external-assets"] === "boolean" ? argv["external-assets"] : false
|
|
||||||
};
|
|
||||||
};
|
|
@ -1,27 +1,32 @@
|
|||||||
import * as fs from "fs";
|
import * as fs from "fs";
|
||||||
import * as path from "path";
|
import * as path from "path";
|
||||||
|
|
||||||
/** List all files in a given directory return paths relative to the dir_path */
|
const crawlRec = (dir_path: string, paths: string[]) => {
|
||||||
export const crawl = (() => {
|
for (const file_name of fs.readdirSync(dir_path)) {
|
||||||
const crawlRec = (dir_path: string, paths: string[]) => {
|
const file_path = path.join(dir_path, file_name);
|
||||||
for (const file_name of fs.readdirSync(dir_path)) {
|
|
||||||
const file_path = path.join(dir_path, file_name);
|
|
||||||
|
|
||||||
if (fs.lstatSync(file_path).isDirectory()) {
|
if (fs.lstatSync(file_path).isDirectory()) {
|
||||||
crawlRec(file_path, paths);
|
crawlRec(file_path, paths);
|
||||||
|
|
||||||
continue;
|
continue;
|
||||||
}
|
|
||||||
|
|
||||||
paths.push(file_path);
|
|
||||||
}
|
}
|
||||||
};
|
|
||||||
|
|
||||||
return function crawl(dir_path: string): string[] {
|
paths.push(file_path);
|
||||||
const paths: string[] = [];
|
}
|
||||||
|
};
|
||||||
|
|
||||||
crawlRec(dir_path, paths);
|
/** List all files in a given directory return paths relative to the dir_path */
|
||||||
|
export function crawl(params: { dirPath: string; returnedPathsType: "absolute" | "relative to dirPath" }): string[] {
|
||||||
|
const { dirPath, returnedPathsType } = params;
|
||||||
|
|
||||||
return paths.map(file_path => path.relative(dir_path, file_path));
|
const filePaths: string[] = [];
|
||||||
};
|
|
||||||
})();
|
crawlRec(dirPath, filePaths);
|
||||||
|
|
||||||
|
switch (returnedPathsType) {
|
||||||
|
case "absolute":
|
||||||
|
return filePaths;
|
||||||
|
case "relative to dirPath":
|
||||||
|
return filePaths.map(filePath => path.relative(dirPath, filePath));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@ -1,18 +1,55 @@
|
|||||||
import { exec as execCallback } from "child_process";
|
import { exec as execCallback } from "child_process";
|
||||||
import { createHash } from "crypto";
|
import { createHash } from "crypto";
|
||||||
import { mkdir, stat, writeFile } from "fs/promises";
|
import { mkdir, readFile, stat, writeFile, unlink, rm } from "fs/promises";
|
||||||
import fetch, { type FetchOptions } from "make-fetch-happen";
|
import fetch, { type FetchOptions } from "make-fetch-happen";
|
||||||
import { dirname as pathDirname, join as pathJoin } from "path";
|
import { dirname as pathDirname, join as pathJoin, resolve as pathResolve, sep as pathSep } from "path";
|
||||||
import { assert } from "tsafe";
|
import { assert } from "tsafe/assert";
|
||||||
import { promisify } from "util";
|
import { promisify } from "util";
|
||||||
import { getProjectRoot } from "./getProjectRoot";
|
|
||||||
import { transformCodebase } from "./transformCodebase";
|
import { transformCodebase } from "./transformCodebase";
|
||||||
import { unzip } from "./unzip";
|
import { unzip, zip } from "./unzip";
|
||||||
|
|
||||||
const exec = promisify(execCallback);
|
const exec = promisify(execCallback);
|
||||||
|
|
||||||
function hash(s: string) {
|
function generateFileNameFromURL(params: {
|
||||||
return createHash("sha256").update(s).digest("hex");
|
url: string;
|
||||||
|
preCacheTransform:
|
||||||
|
| {
|
||||||
|
actionCacheId: string;
|
||||||
|
actionFootprint: string;
|
||||||
|
}
|
||||||
|
| undefined;
|
||||||
|
}): string {
|
||||||
|
const { preCacheTransform } = params;
|
||||||
|
|
||||||
|
// Parse the URL
|
||||||
|
const url = new URL(params.url);
|
||||||
|
|
||||||
|
// Extract pathname and remove leading slashes
|
||||||
|
let fileName = url.pathname.replace(/^\//, "").replace(/\//g, "_");
|
||||||
|
|
||||||
|
// Optionally, add query parameters replacing special characters
|
||||||
|
if (url.search) {
|
||||||
|
fileName += url.search.replace(/[&=?]/g, "-");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace any characters that are not valid in filenames
|
||||||
|
fileName = fileName.replace(/[^a-zA-Z0-9-_]/g, "");
|
||||||
|
|
||||||
|
// Trim or pad the fileName to a specific length
|
||||||
|
fileName = fileName.substring(0, 50);
|
||||||
|
|
||||||
|
add_pre_cache_transform: {
|
||||||
|
if (preCacheTransform === undefined) {
|
||||||
|
break add_pre_cache_transform;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sanitize actionCacheId the same way as other components
|
||||||
|
const sanitizedActionCacheId = preCacheTransform.actionCacheId.replace(/[^a-zA-Z0-9-_]/g, "_");
|
||||||
|
|
||||||
|
fileName += `_${sanitizedActionCacheId}_${createHash("sha256").update(preCacheTransform.actionFootprint).digest("hex").substring(0, 5)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
return fileName;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function exists(path: string) {
|
async function exists(path: string) {
|
||||||
@ -25,46 +62,134 @@ async function exists(path: string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
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
|
* Get npm configuration as map
|
||||||
*/
|
*/
|
||||||
async function getNmpConfig(): Promise<Record<string, string>> {
|
async function getNmpConfig() {
|
||||||
const { stdout } = await exec("npm config get", { encoding: "utf8" });
|
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
|
return stdout
|
||||||
.split("\n")
|
.split("\n")
|
||||||
.filter(line => !line.startsWith(";"))
|
.filter(line => !line.startsWith(";"))
|
||||||
.map(line => line.trim())
|
.map(line => line.trim())
|
||||||
.map(line => line.split("=", 2))
|
.map(line => line.split("=", 2) as [string, string])
|
||||||
.reduce((cfg, [key, value]) => ({ ...cfg, [key]: value }), {});
|
.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 configuration from npm config files. Note that we don't care about
|
* 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.
|
* proxy config in env vars, because make-fetch-happen will do that for us.
|
||||||
*
|
*
|
||||||
* @returns proxy configuration
|
* @returns proxy configuration
|
||||||
*/
|
*/
|
||||||
async function getNpmProxyConfig(): Promise<Pick<FetchOptions, "proxy" | "noProxy">> {
|
async function getFetchOptions(): Promise<Pick<FetchOptions, "proxy" | "noProxy" | "strictSSL" | "ca" | "cert">> {
|
||||||
const cfg = await getNmpConfig();
|
const cfg = await getNmpConfig();
|
||||||
|
|
||||||
const proxy = cfg["https-proxy"] ?? cfg["proxy"];
|
const proxy = ensureSingleOrNone(cfg["https-proxy"] ?? cfg["proxy"]);
|
||||||
const noProxy = cfg["noproxy"] ?? cfg["no-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"]);
|
||||||
|
|
||||||
return { proxy, noProxy };
|
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; pathOfDirToExtractInArchive?: string }) {
|
export async function downloadAndUnzip(
|
||||||
const { url, destDirPath, pathOfDirToExtractInArchive } = params;
|
params: {
|
||||||
|
url: string;
|
||||||
|
destDirPath: string;
|
||||||
|
specificDirsToExtract?: string[];
|
||||||
|
preCacheTransform?: {
|
||||||
|
actionCacheId: string;
|
||||||
|
action: (params: { destDirPath: string }) => Promise<void>;
|
||||||
|
};
|
||||||
|
} & (
|
||||||
|
| {
|
||||||
|
doUseCache: true;
|
||||||
|
cacheDirPath: string;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
doUseCache: false;
|
||||||
|
}
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
const { url, destDirPath, specificDirsToExtract, preCacheTransform, ...rest } = params;
|
||||||
|
|
||||||
const downloadHash = hash(JSON.stringify({ url })).substring(0, 15);
|
const zipFileBasename = generateFileNameFromURL({
|
||||||
const projectRoot = getProjectRoot();
|
url,
|
||||||
const cacheRoot = process.env.XDG_CACHE_HOME ?? pathJoin(projectRoot, "node_modules", ".cache");
|
"preCacheTransform":
|
||||||
const zipFilePath = pathJoin(cacheRoot, "keycloakify", "zip", `_${downloadHash}.zip`);
|
preCacheTransform === undefined
|
||||||
const extractDirPath = pathJoin(cacheRoot, "keycloakify", "unzip", `_${downloadHash}`);
|
? undefined
|
||||||
|
: {
|
||||||
|
"actionCacheId": preCacheTransform.actionCacheId,
|
||||||
|
"actionFootprint": preCacheTransform.action.toString()
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const cacheDirPath = !rest.doUseCache ? `tmp_${Math.random().toString().slice(2, 12)}` : rest.cacheDirPath;
|
||||||
|
|
||||||
|
const zipFilePath = pathJoin(cacheDirPath, `${zipFileBasename}.zip`);
|
||||||
|
const extractDirPath = pathJoin(cacheDirPath, `tmp_unzip_${zipFileBasename}`);
|
||||||
|
|
||||||
if (!(await exists(zipFilePath))) {
|
if (!(await exists(zipFilePath))) {
|
||||||
const proxyOpts = await getNpmProxyConfig();
|
const opts = await getFetchOptions();
|
||||||
const response = await fetch(url, proxyOpts);
|
const response = await fetch(url, opts);
|
||||||
await mkdir(pathDirname(zipFilePath), { "recursive": true });
|
await mkdir(pathDirname(zipFilePath), { "recursive": true });
|
||||||
/**
|
/**
|
||||||
* The correct way to fix this is to upgrade node-fetch beyond 3.2.5
|
* The correct way to fix this is to upgrade node-fetch beyond 3.2.5
|
||||||
@ -76,12 +201,32 @@ export async function downloadAndUnzip(params: { url: string; destDirPath: strin
|
|||||||
response.body?.setMaxListeners(Number.MAX_VALUE);
|
response.body?.setMaxListeners(Number.MAX_VALUE);
|
||||||
assert(typeof response.body !== "undefined" && response.body != null);
|
assert(typeof response.body !== "undefined" && response.body != null);
|
||||||
await writeFile(zipFilePath, response.body);
|
await writeFile(zipFilePath, response.body);
|
||||||
|
|
||||||
|
if (specificDirsToExtract !== undefined || preCacheTransform !== undefined) {
|
||||||
|
await unzip(zipFilePath, extractDirPath, specificDirsToExtract);
|
||||||
|
|
||||||
|
await preCacheTransform?.action({
|
||||||
|
"destDirPath": extractDirPath
|
||||||
|
});
|
||||||
|
|
||||||
|
await unlink(zipFilePath);
|
||||||
|
|
||||||
|
await zip(extractDirPath, zipFilePath);
|
||||||
|
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
await unzip(zipFilePath, extractDirPath, pathOfDirToExtractInArchive);
|
await unzip(zipFilePath, extractDirPath);
|
||||||
|
|
||||||
transformCodebase({
|
transformCodebase({
|
||||||
"srcDirPath": extractDirPath,
|
"srcDirPath": extractDirPath,
|
||||||
"destDirPath": destDirPath
|
"destDirPath": destDirPath
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (!rest.doUseCache) {
|
||||||
|
await rm(cacheDirPath, { "recursive": true });
|
||||||
|
} else {
|
||||||
|
await rm(extractDirPath, { "recursive": true });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
15
src/bin/tools/getAbsoluteAndInOsFormatPath.ts
Normal file
15
src/bin/tools/getAbsoluteAndInOsFormatPath.ts
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
import { isAbsolute as pathIsAbsolute, sep as pathSep, join as pathJoin } from "path";
|
||||||
|
|
||||||
|
export function getAbsoluteAndInOsFormatPath(params: { pathIsh: string; cwd: string }): string {
|
||||||
|
const { pathIsh, cwd } = params;
|
||||||
|
|
||||||
|
let pathOut = pathIsh;
|
||||||
|
|
||||||
|
pathOut = pathOut.replace(/\//g, pathSep);
|
||||||
|
|
||||||
|
if (!pathIsAbsolute(pathOut)) {
|
||||||
|
pathOut = pathJoin(cwd, pathOut);
|
||||||
|
}
|
||||||
|
|
||||||
|
return pathOut;
|
||||||
|
}
|
@ -1,87 +0,0 @@
|
|||||||
import { dirname, relative, sep } 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 && !entry.fsPath.endsWith(sep)) {
|
|
||||||
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.
|
|
||||||
*/
|
|
||||||
export default async function jar({ groupId, artifactId, version, rootPath, targetPath }: JarArgs) {
|
|
||||||
await mkdir(dirname(targetPath), { recursive: true });
|
|
||||||
|
|
||||||
const asyncPathGeneratorFn = async function* (): ZipEntryGenerator {
|
|
||||||
for await (const fsPath of walk(rootPath)) {
|
|
||||||
const zipPath = relative(rootPath, fsPath).split(sep).join("/");
|
|
||||||
yield { fsPath, zipPath };
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
const zipFile = await jarStream({ groupId, artifactId, version, asyncPathGeneratorFn });
|
|
||||||
|
|
||||||
await new Promise<void>(async (resolve, reject) => {
|
|
||||||
zipFile.outputStream
|
|
||||||
.pipe(createWriteStream(targetPath, { encoding: "binary" }))
|
|
||||||
.on("close", () => resolve())
|
|
||||||
.on("error", e => reject(e));
|
|
||||||
});
|
|
||||||
}
|
|
@ -2,5 +2,5 @@ export function pathJoin(...path: string[]): string {
|
|||||||
return path
|
return path
|
||||||
.map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
|
.map((part, i) => (i === 0 ? part : part.replace(/^\/+/, "")))
|
||||||
.map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
|
.map((part, i) => (i === path.length - 1 ? part : part.replace(/\/+$/, "")))
|
||||||
.join("/");
|
.join(typeof process !== "undefined" && process.platform === "win32" ? "\\" : "/");
|
||||||
}
|
}
|
||||||
|
@ -3,7 +3,7 @@ import * as path from "path";
|
|||||||
import { crawl } from "./crawl";
|
import { crawl } from "./crawl";
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
|
|
||||||
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string }) =>
|
type TransformSourceCode = (params: { sourceCode: Buffer; filePath: string; fileRelativePath: string }) =>
|
||||||
| {
|
| {
|
||||||
modifiedSourceCode: Buffer;
|
modifiedSourceCode: Buffer;
|
||||||
newFileName?: string;
|
newFileName?: string;
|
||||||
@ -20,26 +20,27 @@ export function transformCodebase(params: { srcDirPath: string; destDirPath: str
|
|||||||
}))
|
}))
|
||||||
} = params;
|
} = params;
|
||||||
|
|
||||||
for (const file_relative_path of crawl(srcDirPath)) {
|
for (const fileRelativePath of crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })) {
|
||||||
const filePath = path.join(srcDirPath, file_relative_path);
|
const filePath = path.join(srcDirPath, fileRelativePath);
|
||||||
|
|
||||||
const transformSourceCodeResult = transformSourceCode({
|
const transformSourceCodeResult = transformSourceCode({
|
||||||
"sourceCode": fs.readFileSync(filePath),
|
"sourceCode": fs.readFileSync(filePath),
|
||||||
"filePath": path.join(srcDirPath, file_relative_path)
|
filePath,
|
||||||
|
fileRelativePath
|
||||||
});
|
});
|
||||||
|
|
||||||
if (transformSourceCodeResult === undefined) {
|
if (transformSourceCodeResult === undefined) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
fs.mkdirSync(path.dirname(path.join(destDirPath, file_relative_path)), {
|
fs.mkdirSync(path.dirname(path.join(destDirPath, fileRelativePath)), {
|
||||||
"recursive": true
|
"recursive": true
|
||||||
});
|
});
|
||||||
|
|
||||||
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
const { newFileName, modifiedSourceCode } = transformSourceCodeResult;
|
||||||
|
|
||||||
fs.writeFileSync(
|
fs.writeFileSync(
|
||||||
path.join(path.dirname(path.join(destDirPath, file_relative_path)), newFileName ?? path.basename(file_relative_path)),
|
path.join(path.dirname(path.join(destDirPath, fileRelativePath)), newFileName ?? path.basename(fileRelativePath)),
|
||||||
modifiedSourceCode
|
modifiedSourceCode
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
@ -9,7 +9,7 @@ function populateTemplate(strings: TemplateStringsArray, ...args: unknown[]) {
|
|||||||
if (strings[i]) {
|
if (strings[i]) {
|
||||||
chunks.push(strings[i]);
|
chunks.push(strings[i]);
|
||||||
// remember last indent of the string portion
|
// remember last indent of the string portion
|
||||||
lastStringLineLength = strings[i].split("\n").at(-1)?.length ?? 0;
|
lastStringLineLength = strings[i].split("\n").slice(-1)[0]?.length ?? 0;
|
||||||
}
|
}
|
||||||
if (args[i]) {
|
if (args[i]) {
|
||||||
// if the interpolation value has newlines, indent the interpolation values
|
// if the interpolation value has newlines, indent the interpolation values
|
||||||
|
@ -2,6 +2,7 @@ import fsp from "node:fs/promises";
|
|||||||
import fs from "fs";
|
import fs from "fs";
|
||||||
import path from "node:path";
|
import path from "node:path";
|
||||||
import yauzl from "yauzl";
|
import yauzl from "yauzl";
|
||||||
|
import yazl from "yazl";
|
||||||
import stream from "node:stream";
|
import stream from "node:stream";
|
||||||
import { promisify } from "node:util";
|
import { promisify } from "node:util";
|
||||||
|
|
||||||
@ -19,11 +20,16 @@ async function pathExists(path: string) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function unzip(file: string, targetFolder: string, unzipSubPath?: string) {
|
// Handlings of non posix path is not implemented correctly
|
||||||
// add trailing slash to unzipSubPath and targetFolder
|
// it work by coincidence. Don't have the time to fix but it should be fixed.
|
||||||
if (unzipSubPath && (!unzipSubPath.endsWith("/") || !unzipSubPath.endsWith("\\"))) {
|
export async function unzip(file: string, targetFolder: string, specificDirsToExtract?: string[]) {
|
||||||
unzipSubPath += "/";
|
specificDirsToExtract = specificDirsToExtract?.map(dirPath => {
|
||||||
}
|
if (!dirPath.endsWith("/") || !dirPath.endsWith("\\")) {
|
||||||
|
dirPath += "/";
|
||||||
|
}
|
||||||
|
|
||||||
|
return dirPath;
|
||||||
|
});
|
||||||
|
|
||||||
if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
|
if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
|
||||||
targetFolder += "/";
|
targetFolder += "/";
|
||||||
@ -42,15 +48,17 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
|
|||||||
zipfile.readEntry();
|
zipfile.readEntry();
|
||||||
|
|
||||||
zipfile.on("entry", async entry => {
|
zipfile.on("entry", async entry => {
|
||||||
if (unzipSubPath) {
|
if (specificDirsToExtract !== undefined) {
|
||||||
|
const dirPath = specificDirsToExtract.find(dirPath => entry.fileName.startsWith(dirPath));
|
||||||
|
|
||||||
// Skip files outside of the unzipSubPath
|
// Skip files outside of the unzipSubPath
|
||||||
if (!entry.fileName.startsWith(unzipSubPath)) {
|
if (dirPath === undefined) {
|
||||||
zipfile.readEntry();
|
zipfile.readEntry();
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove the unzipSubPath from the file name
|
// Remove the unzipSubPath from the file name
|
||||||
entry.fileName = entry.fileName.substring(unzipSubPath.length);
|
entry.fileName = entry.fileName.substring(dirPath.length);
|
||||||
}
|
}
|
||||||
|
|
||||||
const target = path.join(targetFolder, entry.fileName);
|
const target = path.join(targetFolder, entry.fileName);
|
||||||
@ -77,6 +85,8 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
await fsp.mkdir(path.dirname(target), { "recursive": true });
|
||||||
|
|
||||||
await pipeline(readStream, fs.createWriteStream(target));
|
await pipeline(readStream, fs.createWriteStream(target));
|
||||||
|
|
||||||
zipfile.readEntry();
|
zipfile.readEntry();
|
||||||
@ -90,3 +100,42 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
|
|||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// NOTE: This code was directly copied from ChatGPT and appears to function as expected.
|
||||||
|
// However, confidence in its complete accuracy and robustness is limited.
|
||||||
|
export async function zip(sourceFolder: string, targetZip: string) {
|
||||||
|
return new Promise<void>(async (resolve, reject) => {
|
||||||
|
const zipfile = new yazl.ZipFile();
|
||||||
|
const files: string[] = [];
|
||||||
|
|
||||||
|
// Recursive function to explore directories and their subdirectories
|
||||||
|
async function exploreDir(dir: string) {
|
||||||
|
const dirContent = await fsp.readdir(dir);
|
||||||
|
for (const file of dirContent) {
|
||||||
|
const filePath = path.join(dir, file);
|
||||||
|
const stat = await fsp.stat(filePath);
|
||||||
|
if (stat.isDirectory()) {
|
||||||
|
await exploreDir(filePath);
|
||||||
|
} else if (stat.isFile()) {
|
||||||
|
files.push(filePath);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Collecting all files to be zipped
|
||||||
|
await exploreDir(sourceFolder);
|
||||||
|
|
||||||
|
// Adding files to zip
|
||||||
|
for (const file of files) {
|
||||||
|
const relativePath = path.relative(sourceFolder, file);
|
||||||
|
zipfile.addFile(file, relativePath);
|
||||||
|
}
|
||||||
|
|
||||||
|
zipfile.outputStream
|
||||||
|
.pipe(fs.createWriteStream(targetZip))
|
||||||
|
.on("close", () => resolve())
|
||||||
|
.on("error", err => reject(err)); // Listen to error events
|
||||||
|
|
||||||
|
zipfile.end();
|
||||||
|
});
|
||||||
|
}
|
||||||
|
@ -1,19 +0,0 @@
|
|||||||
import { readdir } from "fs/promises";
|
|
||||||
import { resolve, sep } from "path";
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Asynchronously and recursively walk a directory tree, yielding every file and directory
|
|
||||||
* found. Directory paths will _always_ end with a path separator.
|
|
||||||
*
|
|
||||||
* @param root the starting directory
|
|
||||||
* @returns AsyncGenerator
|
|
||||||
*/
|
|
||||||
export default async function* walk(root: string): AsyncGenerator<string, void, unknown> {
|
|
||||||
for (const entry of await readdir(root, { withFileTypes: true })) {
|
|
||||||
const absolutePath = resolve(root, entry.name);
|
|
||||||
if (entry.isDirectory()) {
|
|
||||||
yield absolutePath.endsWith(sep) ? absolutePath : absolutePath + sep;
|
|
||||||
yield* walk(absolutePath);
|
|
||||||
} else yield absolutePath.endsWith(sep) ? absolutePath.substring(0, absolutePath.length - 1) : absolutePath;
|
|
||||||
}
|
|
||||||
}
|
|
@ -1,21 +1,15 @@
|
|||||||
import { useReducer, useEffect } from "react";
|
import { useReducer, useEffect } from "react";
|
||||||
import { headInsert } from "keycloakify/tools/headInsert";
|
import { headInsert } from "keycloakify/tools/headInsert";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
|
||||||
export function usePrepareTemplate(params: {
|
export function usePrepareTemplate(params: {
|
||||||
doFetchDefaultThemeResources: boolean;
|
doFetchDefaultThemeResources: boolean;
|
||||||
stylesCommon?: string[];
|
|
||||||
styles?: string[];
|
styles?: string[];
|
||||||
scripts?: string[];
|
scripts?: string[];
|
||||||
url: {
|
|
||||||
resourcesCommonPath: string;
|
|
||||||
resourcesPath: string;
|
|
||||||
};
|
|
||||||
htmlClassName: string | undefined;
|
htmlClassName: string | undefined;
|
||||||
bodyClassName: string | undefined;
|
bodyClassName: string | undefined;
|
||||||
}) {
|
}) {
|
||||||
const { doFetchDefaultThemeResources, stylesCommon = [], styles = [], url, scripts = [], htmlClassName, bodyClassName } = params;
|
const { doFetchDefaultThemeResources, styles = [], scripts = [], htmlClassName, bodyClassName } = params;
|
||||||
|
|
||||||
const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
|
const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
|
||||||
|
|
||||||
@ -29,38 +23,30 @@ export function usePrepareTemplate(params: {
|
|||||||
const removeArray: (() => void)[] = [];
|
const removeArray: (() => void)[] = [];
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const prLoadedArray: Promise<void>[] = [];
|
for (const style of [...styles].reverse()) {
|
||||||
|
const { prLoaded, remove } = headInsert({
|
||||||
[
|
"type": "css",
|
||||||
...stylesCommon.map(relativePath => pathJoin(url.resourcesCommonPath, relativePath)),
|
"position": "prepend",
|
||||||
...styles.map(relativePath => pathJoin(url.resourcesPath, relativePath))
|
"href": style
|
||||||
]
|
|
||||||
.reverse()
|
|
||||||
.forEach(href => {
|
|
||||||
const { prLoaded, remove } = headInsert({
|
|
||||||
"type": "css",
|
|
||||||
"position": "prepend",
|
|
||||||
href
|
|
||||||
});
|
|
||||||
|
|
||||||
removeArray.push(remove);
|
|
||||||
|
|
||||||
prLoadedArray.push(prLoaded);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
await Promise.all(prLoadedArray);
|
removeArray.push(remove);
|
||||||
|
|
||||||
if (isUnmounted) {
|
// TODO: Find a way to do that in parallel (without breaking the order)
|
||||||
return;
|
await prLoaded;
|
||||||
|
|
||||||
|
if (isUnmounted) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
setReady();
|
setReady();
|
||||||
})();
|
})();
|
||||||
|
|
||||||
scripts.forEach(relativePath => {
|
scripts.forEach(src => {
|
||||||
const { remove } = headInsert({
|
const { remove } = headInsert({
|
||||||
"type": "javascript",
|
"type": "javascript",
|
||||||
"src": pathJoin(url.resourcesPath, relativePath)
|
src
|
||||||
});
|
});
|
||||||
|
|
||||||
removeArray.push(remove);
|
removeArray.push(remove);
|
||||||
|
@ -12,6 +12,8 @@ const Error = lazy(() => import("keycloakify/login/pages/Error"));
|
|||||||
const LoginResetPassword = lazy(() => import("keycloakify/login/pages/LoginResetPassword"));
|
const LoginResetPassword = lazy(() => import("keycloakify/login/pages/LoginResetPassword"));
|
||||||
const LoginVerifyEmail = lazy(() => import("keycloakify/login/pages/LoginVerifyEmail"));
|
const LoginVerifyEmail = lazy(() => import("keycloakify/login/pages/LoginVerifyEmail"));
|
||||||
const Terms = lazy(() => import("keycloakify/login/pages/Terms"));
|
const Terms = lazy(() => import("keycloakify/login/pages/Terms"));
|
||||||
|
const LoginDeviceVerifyUserCode = lazy(() => import("keycloakify/login/pages/LoginDeviceVerifyUserCode"));
|
||||||
|
const LoginOauthGrant = lazy(() => import("keycloakify/login/pages/LoginOauthGrant"));
|
||||||
const LoginOtp = lazy(() => import("keycloakify/login/pages/LoginOtp"));
|
const LoginOtp = lazy(() => import("keycloakify/login/pages/LoginOtp"));
|
||||||
const LoginPassword = lazy(() => import("keycloakify/login/pages/LoginPassword"));
|
const LoginPassword = lazy(() => import("keycloakify/login/pages/LoginPassword"));
|
||||||
const LoginUsername = lazy(() => import("keycloakify/login/pages/LoginUsername"));
|
const LoginUsername = lazy(() => import("keycloakify/login/pages/LoginUsername"));
|
||||||
@ -27,6 +29,7 @@ const UpdateUserProfile = lazy(() => import("keycloakify/login/pages/UpdateUserP
|
|||||||
const IdpReviewUserProfile = lazy(() => import("keycloakify/login/pages/IdpReviewUserProfile"));
|
const IdpReviewUserProfile = lazy(() => import("keycloakify/login/pages/IdpReviewUserProfile"));
|
||||||
const UpdateEmail = lazy(() => import("keycloakify/login/pages/UpdateEmail"));
|
const UpdateEmail = lazy(() => import("keycloakify/login/pages/UpdateEmail"));
|
||||||
const SelectAuthenticator = lazy(() => import("keycloakify/login/pages/SelectAuthenticator"));
|
const SelectAuthenticator = lazy(() => import("keycloakify/login/pages/SelectAuthenticator"));
|
||||||
|
const SamlPostForm = lazy(() => import("keycloakify/login/pages/SamlPostForm"));
|
||||||
|
|
||||||
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
export default function Fallback(props: PageProps<KcContext, I18n>) {
|
||||||
const { kcContext, ...rest } = props;
|
const { kcContext, ...rest } = props;
|
||||||
@ -51,6 +54,10 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <LoginVerifyEmail kcContext={kcContext} {...rest} />;
|
return <LoginVerifyEmail kcContext={kcContext} {...rest} />;
|
||||||
case "terms.ftl":
|
case "terms.ftl":
|
||||||
return <Terms kcContext={kcContext} {...rest} />;
|
return <Terms kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-oauth2-device-verify-user-code.ftl":
|
||||||
|
return <LoginDeviceVerifyUserCode kcContext={kcContext} {...rest} />;
|
||||||
|
case "login-oauth-grant.ftl":
|
||||||
|
return <LoginOauthGrant kcContext={kcContext} {...rest} />;
|
||||||
case "login-otp.ftl":
|
case "login-otp.ftl":
|
||||||
return <LoginOtp kcContext={kcContext} {...rest} />;
|
return <LoginOtp kcContext={kcContext} {...rest} />;
|
||||||
case "login-username.ftl":
|
case "login-username.ftl":
|
||||||
@ -81,6 +88,8 @@ export default function Fallback(props: PageProps<KcContext, I18n>) {
|
|||||||
return <UpdateEmail kcContext={kcContext} {...rest} />;
|
return <UpdateEmail kcContext={kcContext} {...rest} />;
|
||||||
case "select-authenticator.ftl":
|
case "select-authenticator.ftl":
|
||||||
return <SelectAuthenticator kcContext={kcContext} {...rest} />;
|
return <SelectAuthenticator kcContext={kcContext} {...rest} />;
|
||||||
|
case "saml-post-form.ftl":
|
||||||
|
return <SamlPostForm kcContext={kcContext} {...rest} />;
|
||||||
}
|
}
|
||||||
assert<Equals<typeof kcContext, never>>(false);
|
assert<Equals<typeof kcContext, never>>(false);
|
||||||
})()}
|
})()}
|
||||||
|
@ -31,21 +31,22 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
|
|||||||
|
|
||||||
const { isReady } = usePrepareTemplate({
|
const { isReady } = usePrepareTemplate({
|
||||||
"doFetchDefaultThemeResources": doUseDefaultCss,
|
"doFetchDefaultThemeResources": doUseDefaultCss,
|
||||||
url,
|
"styles": [
|
||||||
"stylesCommon": [
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
|
||||||
"node_modules/patternfly/dist/css/patternfly.min.css",
|
`${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
|
||||||
"node_modules/patternfly/dist/css/patternfly-additions.min.css",
|
`${url.resourcesCommonPath}/lib/zocial/zocial.css`,
|
||||||
"lib/zocial/zocial.css"
|
`${url.resourcesPath}/css/login.css`
|
||||||
],
|
],
|
||||||
"styles": ["css/login.css"],
|
|
||||||
"htmlClassName": getClassName("kcHtmlClass"),
|
"htmlClassName": getClassName("kcHtmlClass"),
|
||||||
"bodyClassName": undefined
|
"bodyClassName": getClassName("kcBodyClass")
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!isReady) {
|
if (!isReady) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
document.title = i18n.msgStr("loginTitle", kcContext.realm.displayName);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={getClassName("kcLoginClass")}>
|
<div className={getClassName("kcLoginClass")}>
|
||||||
<div id="kc-header" className={getClassName("kcHeaderClass")}>
|
<div id="kc-header" className={getClassName("kcHeaderClass")}>
|
||||||
|
@ -21,6 +21,7 @@ export type TemplateProps<KcContext extends KcContext.Common, I18nExtended exten
|
|||||||
};
|
};
|
||||||
|
|
||||||
export type ClassKey =
|
export type ClassKey =
|
||||||
|
| "kcBodyClass"
|
||||||
| "kcHtmlClass"
|
| "kcHtmlClass"
|
||||||
| "kcLoginClass"
|
| "kcLoginClass"
|
||||||
| "kcHeaderClass"
|
| "kcHeaderClass"
|
||||||
@ -93,4 +94,6 @@ export type ClassKey =
|
|||||||
| "kcSelectOTPListItemClass"
|
| "kcSelectOTPListItemClass"
|
||||||
| "kcAuthenticatorOtpCircleClass"
|
| "kcAuthenticatorOtpCircleClass"
|
||||||
| "kcSelectOTPItemHeadingClass"
|
| "kcSelectOTPItemHeadingClass"
|
||||||
| "kcFormOptionsWrapperClass";
|
| "kcFormOptionsWrapperClass"
|
||||||
|
| "kcFormButtonsWrapperClass"
|
||||||
|
| "kcInputGroup";
|
||||||
|
@ -211,7 +211,8 @@ const keycloakifyExtraMessages = {
|
|||||||
"shouldBeDifferent": "{0} should be different to {1}",
|
"shouldBeDifferent": "{0} should be different to {1}",
|
||||||
"shouldMatchPattern": "Pattern should match: `/{0}/`",
|
"shouldMatchPattern": "Pattern should match: `/{0}/`",
|
||||||
"mustBeAnInteger": "Must be an integer",
|
"mustBeAnInteger": "Must be an integer",
|
||||||
"notAValidOption": "Not a valid option"
|
"notAValidOption": "Not a valid option",
|
||||||
|
"selectAnOption": "Select an option"
|
||||||
},
|
},
|
||||||
"fr": {
|
"fr": {
|
||||||
/* spell-checker: disable */
|
/* spell-checker: disable */
|
||||||
@ -223,7 +224,8 @@ const keycloakifyExtraMessages = {
|
|||||||
|
|
||||||
"logoutConfirmTitle": "Déconnexion",
|
"logoutConfirmTitle": "Déconnexion",
|
||||||
"logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
|
"logoutConfirmHeader": "Êtes-vous sûr(e) de vouloir vous déconnecter ?",
|
||||||
"doLogout": "Se déconnecter"
|
"doLogout": "Se déconnecter",
|
||||||
|
"selectAnOption": "Sélectionner une option"
|
||||||
/* spell-checker: enable */
|
/* spell-checker: enable */
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
@ -5,6 +5,7 @@ export default Fallback;
|
|||||||
export { useDownloadTerms } from "keycloakify/login/lib/useDownloadTerms";
|
export { useDownloadTerms } from "keycloakify/login/lib/useDownloadTerms";
|
||||||
export { getKcContext } from "keycloakify/login/kcContext/getKcContext";
|
export { getKcContext } from "keycloakify/login/kcContext/getKcContext";
|
||||||
export { createGetKcContext } from "keycloakify/login/kcContext/createGetKcContext";
|
export { createGetKcContext } from "keycloakify/login/kcContext/createGetKcContext";
|
||||||
|
export type { LoginThemePageId as PageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
export { createUseI18n } from "keycloakify/login/i18n/i18n";
|
export { createUseI18n } from "keycloakify/login/i18n/i18n";
|
||||||
|
|
||||||
export type { PageProps } from "keycloakify/login/pages/PageProps";
|
export type { PageProps } from "keycloakify/login/pages/PageProps";
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
|
import { type ThemeType } from "keycloakify/bin/constants";
|
||||||
import { assert } from "tsafe/assert";
|
import { assert } from "tsafe/assert";
|
||||||
import type { Equals } from "tsafe";
|
import type { Equals } from "tsafe";
|
||||||
import type { MessageKey } from "../i18n/i18n";
|
import type { MessageKey } from "../i18n/i18n";
|
||||||
@ -18,6 +19,8 @@ export type KcContext =
|
|||||||
| KcContext.LoginResetPassword
|
| KcContext.LoginResetPassword
|
||||||
| KcContext.LoginVerifyEmail
|
| KcContext.LoginVerifyEmail
|
||||||
| KcContext.Terms
|
| KcContext.Terms
|
||||||
|
| KcContext.LoginDeviceVerifyUserCode
|
||||||
|
| KcContext.LoginOauthGrant
|
||||||
| KcContext.LoginOtp
|
| KcContext.LoginOtp
|
||||||
| KcContext.LoginUsername
|
| KcContext.LoginUsername
|
||||||
| KcContext.WebauthnAuthenticate
|
| KcContext.WebauthnAuthenticate
|
||||||
@ -32,11 +35,15 @@ export type KcContext =
|
|||||||
| KcContext.UpdateUserProfile
|
| KcContext.UpdateUserProfile
|
||||||
| KcContext.IdpReviewUserProfile
|
| KcContext.IdpReviewUserProfile
|
||||||
| KcContext.UpdateEmail
|
| KcContext.UpdateEmail
|
||||||
| KcContext.SelectAuthenticator;
|
| KcContext.SelectAuthenticator
|
||||||
|
| KcContext.SamlPostForm;
|
||||||
|
|
||||||
export declare namespace KcContext {
|
export declare namespace KcContext {
|
||||||
export type Common = {
|
export type Common = {
|
||||||
|
themeVersion: string;
|
||||||
keycloakifyVersion: string;
|
keycloakifyVersion: string;
|
||||||
|
themeType: "login";
|
||||||
|
themeName: string;
|
||||||
url: {
|
url: {
|
||||||
loginAction: string;
|
loginAction: string;
|
||||||
resourcesPath: string;
|
resourcesPath: string;
|
||||||
@ -75,16 +82,52 @@ 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: {
|
||||||
printIfExists: <T>(fieldName: string, x: T) => T | undefined;
|
/**
|
||||||
|
* Return text if message for given field exists. Useful eg. to add css styles for fields with message.
|
||||||
|
*
|
||||||
|
* @param fieldName to check for
|
||||||
|
* @param text to return
|
||||||
|
* @return text if message exists for given field, else undefined
|
||||||
|
*/
|
||||||
|
printIfExists: <T extends string>(fieldName: string, text: T) => T | undefined;
|
||||||
|
/**
|
||||||
|
* Check if exists error message for given fields
|
||||||
|
*
|
||||||
|
* @param fields
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
existsError: (fieldName: string) => boolean;
|
existsError: (fieldName: string) => boolean;
|
||||||
|
/**
|
||||||
|
* Get message for given field.
|
||||||
|
*
|
||||||
|
* @param fieldName
|
||||||
|
* @return message text or empty string
|
||||||
|
*/
|
||||||
get: (fieldName: string) => string;
|
get: (fieldName: string) => string;
|
||||||
|
/**
|
||||||
|
* Check if message for given field exists
|
||||||
|
*
|
||||||
|
* @param field
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
exists: (fieldName: string) => boolean;
|
exists: (fieldName: string) => boolean;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type SamlPostForm = Common & {
|
||||||
|
pageId: "saml-post-form.ftl";
|
||||||
|
samlPost: {
|
||||||
|
url: string;
|
||||||
|
SAMLRequest?: string;
|
||||||
|
SAMLResponse?: string;
|
||||||
|
relayState?: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
export type Login = Common & {
|
export type Login = Common & {
|
||||||
pageId: "login.ftl";
|
pageId: "login.ftl";
|
||||||
url: {
|
url: {
|
||||||
@ -107,7 +150,7 @@ export declare namespace KcContext {
|
|||||||
rememberMe?: string;
|
rememberMe?: string;
|
||||||
password?: string;
|
password?: string;
|
||||||
};
|
};
|
||||||
usernameEditDisabled: boolean;
|
usernameHidden?: boolean;
|
||||||
social: {
|
social: {
|
||||||
displayInfo: boolean;
|
displayInfo: boolean;
|
||||||
providers?: {
|
providers?: {
|
||||||
@ -203,6 +246,27 @@ export declare namespace KcContext {
|
|||||||
pageId: "terms.ftl";
|
pageId: "terms.ftl";
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export type LoginDeviceVerifyUserCode = Common & {
|
||||||
|
pageId: "login-oauth2-device-verify-user-code.ftl";
|
||||||
|
url: {
|
||||||
|
oauth2DeviceVerificationAction: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
export type LoginOauthGrant = Common & {
|
||||||
|
pageId: "login-oauth-grant.ftl";
|
||||||
|
oauth: {
|
||||||
|
code: string;
|
||||||
|
client: string;
|
||||||
|
clientScopesRequested: {
|
||||||
|
consentScreenText: string;
|
||||||
|
}[];
|
||||||
|
};
|
||||||
|
url: {
|
||||||
|
oauthAction: string;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
export type LoginOtp = Common & {
|
export type LoginOtp = Common & {
|
||||||
pageId: "login-otp.ftl";
|
pageId: "login-otp.ftl";
|
||||||
otpLogin: {
|
otpLogin: {
|
||||||
@ -333,7 +397,6 @@ export declare namespace KcContext {
|
|||||||
totpSecretEncoded: string;
|
totpSecretEncoded: string;
|
||||||
qrUrl: string;
|
qrUrl: string;
|
||||||
policy: {
|
policy: {
|
||||||
supportedApplications: string[];
|
|
||||||
algorithm: "HmacSHA1" | "HmacSHA256" | "HmacSHA512";
|
algorithm: "HmacSHA1" | "HmacSHA256" | "HmacSHA512";
|
||||||
digits: number;
|
digits: number;
|
||||||
lookAheadWindow: number;
|
lookAheadWindow: number;
|
||||||
@ -347,6 +410,7 @@ export declare namespace KcContext {
|
|||||||
initialCounter: number;
|
initialCounter: number;
|
||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
supportedApplications: string[];
|
||||||
totpSecretQrCode: string;
|
totpSecretQrCode: string;
|
||||||
manualUrl: string;
|
manualUrl: string;
|
||||||
totpSecret: string;
|
totpSecret: string;
|
||||||
@ -543,4 +607,15 @@ export declare namespace Validators {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
assert<Equals<KcContext["pageId"], LoginThemePageId>>();
|
{
|
||||||
|
type Got = KcContext["pageId"];
|
||||||
|
type Expected = LoginThemePageId;
|
||||||
|
|
||||||
|
type OnlyInGot = Exclude<Got, Expected>;
|
||||||
|
type OnlyInExpected = Exclude<Expected, Got>;
|
||||||
|
|
||||||
|
assert<Equals<OnlyInGot, never>>();
|
||||||
|
assert<Equals<OnlyInExpected, never>>();
|
||||||
|
}
|
||||||
|
|
||||||
|
assert<KcContext["themeType"] extends ThemeType ? true : false>();
|
||||||
|
@ -8,10 +8,8 @@ import { assert } from "tsafe/assert";
|
|||||||
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
import type { ExtendKcContext } from "./getKcContextFromWindow";
|
||||||
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
import { getKcContextFromWindow } from "./getKcContextFromWindow";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
import { pathBasename } from "keycloakify/tools/pathBasename";
|
|
||||||
import { mockTestingResourcesCommonPath } from "keycloakify/bin/mockTestingResourcesPath";
|
|
||||||
import { symToStr } from "tsafe/symToStr";
|
import { symToStr } from "tsafe/symToStr";
|
||||||
import { loginThemePageIds } from "keycloakify/bin/keycloakify/generateFtl/pageId";
|
import { resources_common } from "keycloakify/bin/constants";
|
||||||
|
|
||||||
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
|
||||||
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
|
||||||
@ -33,13 +31,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
|
||||||
|
|
||||||
console.log(
|
console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
|
||||||
[
|
|
||||||
`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`,
|
|
||||||
`If assets are missing make sure you have built your Keycloak theme at least once.`
|
|
||||||
].join(" "),
|
|
||||||
"background: red; color: yellow; font-size: medium"
|
|
||||||
);
|
|
||||||
|
|
||||||
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
|
||||||
|
|
||||||
@ -151,15 +143,11 @@ export function createGetKcContext<KcContextExtension extends { pageId: string }
|
|||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
if (id<readonly string[]>(loginThemePageIds).indexOf(realKcContext.pageId) < 0 && !("login" in realKcContext)) {
|
if (realKcContext.themeType !== "login") {
|
||||||
return { "kcContext": undefined as any };
|
return { "kcContext": undefined as any };
|
||||||
}
|
}
|
||||||
|
|
||||||
{
|
realKcContext.url.resourcesCommonPath = pathJoin(realKcContext.url.resourcesPath, resources_common);
|
||||||
const { url } = realKcContext;
|
|
||||||
|
|
||||||
url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(mockTestingResourcesCommonPath));
|
|
||||||
}
|
|
||||||
|
|
||||||
return { "kcContext": realKcContext as any };
|
return { "kcContext": realKcContext as any };
|
||||||
}
|
}
|
||||||
|
@ -1,10 +1,10 @@
|
|||||||
import "minimal-polyfills/Object.fromEntries";
|
import "minimal-polyfills/Object.fromEntries";
|
||||||
import type { KcContext, Attribute } from "./KcContext";
|
import type { KcContext, Attribute } from "./KcContext";
|
||||||
import { mockTestingResourcesCommonPath, mockTestingResourcesPath } from "keycloakify/bin/mockTestingResourcesPath";
|
import { resources_common, keycloak_resources } from "keycloakify/bin/constants";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
||||||
import { id } from "tsafe/id";
|
import { id } from "tsafe/id";
|
||||||
|
import { assert, type Equals } from "tsafe/assert";
|
||||||
const PUBLIC_URL = process.env["PUBLIC_URL"] ?? "/";
|
import type { LoginThemePageId } from "keycloakify/bin/keycloakify/generateFtl";
|
||||||
|
|
||||||
const attributes: Attribute[] = [
|
const attributes: Attribute[] = [
|
||||||
{
|
{
|
||||||
@ -100,12 +100,19 @@ const attributes: Attribute[] = [
|
|||||||
|
|
||||||
const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
|
const attributesByName = Object.fromEntries(attributes.map(attribute => [attribute.name, attribute])) as any;
|
||||||
|
|
||||||
|
const PUBLIC_URL = (typeof process !== "object" ? undefined : process.env?.["PUBLIC_URL"]) || "/";
|
||||||
|
|
||||||
|
const resourcesPath = pathJoin(PUBLIC_URL, keycloak_resources, "login", "resources");
|
||||||
|
|
||||||
export const kcContextCommonMock: KcContext.Common = {
|
export const kcContextCommonMock: KcContext.Common = {
|
||||||
|
"themeVersion": "0.0.0",
|
||||||
"keycloakifyVersion": "0.0.0",
|
"keycloakifyVersion": "0.0.0",
|
||||||
|
"themeType": "login",
|
||||||
|
"themeName": "my-theme-name",
|
||||||
"url": {
|
"url": {
|
||||||
"loginAction": "#",
|
"loginAction": "#",
|
||||||
"resourcesPath": pathJoin(PUBLIC_URL, mockTestingResourcesPath),
|
resourcesPath,
|
||||||
"resourcesCommonPath": pathJoin(PUBLIC_URL, mockTestingResourcesCommonPath),
|
"resourcesCommonPath": pathJoin(resourcesPath, resources_common),
|
||||||
"loginRestartFlowUrl": "/auth/realms/myrealm/login-actions/restart?client_id=account&tab_id=HoAx28ja4xg",
|
"loginRestartFlowUrl": "/auth/realms/myrealm/login-actions/restart?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
"loginUrl": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg"
|
"loginUrl": "/auth/realms/myrealm/login-actions/authenticate?client_id=account&tab_id=HoAx28ja4xg"
|
||||||
},
|
},
|
||||||
@ -227,23 +234,22 @@ export const kcContextCommonMock: KcContext.Common = {
|
|||||||
"showTryAnotherWayLink": false
|
"showTryAnotherWayLink": false
|
||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp"
|
"clientId": "myApp",
|
||||||
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"scripts": [],
|
"scripts": [],
|
||||||
"message": {
|
|
||||||
"type": "success",
|
|
||||||
"summary": "This is a test message"
|
|
||||||
},
|
|
||||||
"isAppInitiatedAction": false
|
"isAppInitiatedAction": false
|
||||||
};
|
};
|
||||||
|
|
||||||
const loginUrl = {
|
const loginUrl = {
|
||||||
...kcContextCommonMock.url,
|
...kcContextCommonMock.url,
|
||||||
"loginResetCredentialsUrl": "/auth/realms/myrealm/login-actions/reset-credentials?client_id=account&tab_id=HoAx28ja4xg",
|
"loginResetCredentialsUrl": "/auth/realms/myrealm/login-actions/reset-credentials?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
"registrationUrl": "/auth/realms/myrealm/login-actions/registration?client_id=account&tab_id=HoAx28ja4xg"
|
"registrationUrl": "/auth/realms/myrealm/login-actions/registration?client_id=account&tab_id=HoAx28ja4xg",
|
||||||
|
"oauth2DeviceVerificationAction": "/auth/realms/myrealm/device",
|
||||||
|
"oauthAction": "/auth/realms/myrealm/login-actions/consent?client_id=account&tab_id=HoAx28ja4xg"
|
||||||
};
|
};
|
||||||
|
|
||||||
export const kcContextMocks: KcContext[] = [
|
export const kcContextMocks = [
|
||||||
id<KcContext.Login>({
|
id<KcContext.Login>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "login.ftl",
|
"pageId": "login.ftl",
|
||||||
@ -260,7 +266,7 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
"social": {
|
"social": {
|
||||||
"displayInfo": true
|
"displayInfo": true
|
||||||
},
|
},
|
||||||
"usernameEditDisabled": false,
|
"usernameHidden": false,
|
||||||
"login": {},
|
"login": {},
|
||||||
"registrationDisabled": false
|
"registrationDisabled": false
|
||||||
}),
|
}),
|
||||||
@ -309,7 +315,8 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
"actionUri": "#",
|
"actionUri": "#",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#"
|
"baseUrl": "#",
|
||||||
|
"attributes": {}
|
||||||
}
|
}
|
||||||
}),
|
}),
|
||||||
id<KcContext.Error>({
|
id<KcContext.Error>({
|
||||||
@ -317,7 +324,8 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
"pageId": "error.ftl",
|
"pageId": "error.ftl",
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#"
|
"baseUrl": "#",
|
||||||
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"message": {
|
"message": {
|
||||||
"type": "error",
|
"type": "error",
|
||||||
@ -344,6 +352,25 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "terms.ftl"
|
"pageId": "terms.ftl"
|
||||||
}),
|
}),
|
||||||
|
id<KcContext.LoginDeviceVerifyUserCode>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "login-oauth2-device-verify-user-code.ftl",
|
||||||
|
url: loginUrl
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginOauthGrant>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
"pageId": "login-oauth-grant.ftl",
|
||||||
|
oauth: {
|
||||||
|
code: "5-1N4CIzfi1aprIQjmylI-9e3spLCWW9i5d-GDcs-Sw",
|
||||||
|
clientScopesRequested: [
|
||||||
|
{ consentScreenText: "${profileScopeConsentText}" },
|
||||||
|
{ consentScreenText: "${rolesScopeConsentText}" },
|
||||||
|
{ consentScreenText: "${emailScopeConsentText}" }
|
||||||
|
],
|
||||||
|
client: "account"
|
||||||
|
},
|
||||||
|
url: loginUrl
|
||||||
|
}),
|
||||||
id<KcContext.LoginOtp>({
|
id<KcContext.LoginOtp>({
|
||||||
...kcContextCommonMock,
|
...kcContextCommonMock,
|
||||||
"pageId": "login-otp.ftl",
|
"pageId": "login-otp.ftl",
|
||||||
@ -453,8 +480,8 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
manualUrl: "#",
|
manualUrl: "#",
|
||||||
totpSecret: "G4nsI8lQagRMUchH8jEG",
|
totpSecret: "G4nsI8lQagRMUchH8jEG",
|
||||||
otpCredentials: [],
|
otpCredentials: [],
|
||||||
|
supportedApplications: ["FreeOTP", "Google Authenticator"],
|
||||||
policy: {
|
policy: {
|
||||||
supportedApplications: ["FreeOTP", "Google Authenticator"],
|
|
||||||
algorithm: "HmacSHA1",
|
algorithm: "HmacSHA1",
|
||||||
digits: 6,
|
digits: 6,
|
||||||
lookAheadWindow: 1,
|
lookAheadWindow: 1,
|
||||||
@ -472,7 +499,8 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
},
|
},
|
||||||
"client": {
|
"client": {
|
||||||
"clientId": "myApp",
|
"clientId": "myApp",
|
||||||
"baseUrl": "#"
|
"baseUrl": "#",
|
||||||
|
"attributes": {}
|
||||||
},
|
},
|
||||||
"logoutConfirm": { "code": "123", skipLink: false }
|
"logoutConfirm": { "code": "123", skipLink: false }
|
||||||
}),
|
}),
|
||||||
@ -519,5 +547,27 @@ export const kcContextMocks: KcContext[] = [
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.SamlPostForm>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
pageId: "saml-post-form.ftl",
|
||||||
|
"samlPost": {
|
||||||
|
"url": ""
|
||||||
|
}
|
||||||
|
}),
|
||||||
|
id<KcContext.LoginPageExpired>({
|
||||||
|
...kcContextCommonMock,
|
||||||
|
pageId: "login-page-expired.ftl"
|
||||||
})
|
})
|
||||||
];
|
];
|
||||||
|
|
||||||
|
{
|
||||||
|
type Got = (typeof kcContextMocks)[number]["pageId"];
|
||||||
|
type Expected = LoginThemePageId;
|
||||||
|
|
||||||
|
type OnlyInGot = Exclude<Got, Expected>;
|
||||||
|
type OnlyInExpected = Exclude<Expected, Got>;
|
||||||
|
|
||||||
|
assert<Equals<OnlyInGot, never>>();
|
||||||
|
assert<Equals<OnlyInExpected, never>>();
|
||||||
|
}
|
||||||
|
@ -25,16 +25,7 @@ export function useFormValidation(params: {
|
|||||||
passwordValidators?: Validators;
|
passwordValidators?: Validators;
|
||||||
i18n: I18n;
|
i18n: I18n;
|
||||||
}) {
|
}) {
|
||||||
const {
|
const { kcContext, passwordValidators = {}, i18n } = params;
|
||||||
kcContext,
|
|
||||||
passwordValidators = {
|
|
||||||
"length": {
|
|
||||||
"ignore.empty.value": true,
|
|
||||||
"min": "4"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
i18n
|
|
||||||
} = params;
|
|
||||||
|
|
||||||
const attributesWithPassword = useMemo(
|
const attributesWithPassword = useMemo(
|
||||||
() =>
|
() =>
|
||||||
@ -211,7 +202,7 @@ function useGetErrors(params: {
|
|||||||
const { value: defaultValue, validators } = attributes.find(attribute => attribute.name === name)!;
|
const { value: defaultValue, validators } = attributes.find(attribute => attribute.name === name)!;
|
||||||
|
|
||||||
block: {
|
block: {
|
||||||
if (defaultValue !== value) {
|
if ((defaultValue ?? "") !== value) {
|
||||||
break block;
|
break block;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -3,6 +3,7 @@ import type { ClassKey } from "keycloakify/login/TemplateProps";
|
|||||||
|
|
||||||
export const { useGetClassName } = createUseClassName<ClassKey>({
|
export const { useGetClassName } = createUseClassName<ClassKey>({
|
||||||
"defaultClasses": {
|
"defaultClasses": {
|
||||||
|
"kcBodyClass": undefined,
|
||||||
"kcHtmlClass": "login-pf",
|
"kcHtmlClass": "login-pf",
|
||||||
"kcLoginClass": "login-pf-page",
|
"kcLoginClass": "login-pf-page",
|
||||||
"kcContentWrapperClass": "row",
|
"kcContentWrapperClass": "row",
|
||||||
@ -44,6 +45,7 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
"kcInputClass": "form-control",
|
"kcInputClass": "form-control",
|
||||||
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text",
|
"kcInputErrorMessageClass": "pf-c-form__helper-text pf-m-error required kc-feedback-text",
|
||||||
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
"kcInputWrapperClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
|
"kcFormButtonsWrapperClass": undefined,
|
||||||
"kcFormOptionsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
"kcFormOptionsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
"kcFormButtonsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
"kcFormButtonsClass": "col-xs-12 col-sm-12 col-md-12 col-lg-12",
|
||||||
"kcFormSettingClass": "login-pf-settings",
|
"kcFormSettingClass": "login-pf-settings",
|
||||||
@ -65,6 +67,7 @@ export const { useGetClassName } = createUseClassName<ClassKey>({
|
|||||||
|
|
||||||
// css classes for input
|
// css classes for input
|
||||||
"kcInputLargeClass": "input-lg",
|
"kcInputLargeClass": "input-lg",
|
||||||
|
"kcInputGroup": "pf-c-input-group",
|
||||||
|
|
||||||
// css classes for form accessability
|
// css classes for form accessability
|
||||||
"kcSrOnlyClass": "sr-only",
|
"kcSrOnlyClass": "sr-only",
|
||||||
|
@ -8,7 +8,10 @@ export default function Info(props: PageProps<Extract<KcContext, { pageId: "info
|
|||||||
|
|
||||||
const { msgStr, msg } = i18n;
|
const { msgStr, msg } = i18n;
|
||||||
|
|
||||||
assert(kcContext.message !== undefined);
|
assert(
|
||||||
|
kcContext.message !== undefined,
|
||||||
|
"No message in kcContext.message, there will always be a message in production context, add it in your mock"
|
||||||
|
);
|
||||||
|
|
||||||
const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
|
const { messageHeader, message, requiredActions, skipLink, pageRedirectUri, actionUri, client } = kcContext;
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
|
|||||||
classes
|
classes
|
||||||
});
|
});
|
||||||
|
|
||||||
const { social, realm, url, usernameEditDisabled, login, auth, registrationDisabled } = kcContext;
|
const { social, realm, url, usernameHidden, login, auth, registrationDisabled } = kcContext;
|
||||||
|
|
||||||
const { msg, msgStr } = i18n;
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
@ -37,22 +37,18 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
|
|||||||
return (
|
return (
|
||||||
<Template
|
<Template
|
||||||
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
||||||
displayInfo={social.displayInfo}
|
displayInfo={realm.password && realm.registrationAllowed && !registrationDisabled}
|
||||||
displayWide={realm.password && social.providers !== undefined}
|
displayWide={realm.password && social.providers !== undefined}
|
||||||
headerNode={msg("doLogIn")}
|
headerNode={msg("doLogIn")}
|
||||||
infoNode={
|
infoNode={
|
||||||
realm.password &&
|
<div id="kc-registration">
|
||||||
realm.registrationAllowed &&
|
<span>
|
||||||
!registrationDisabled && (
|
{msg("noAccount")}
|
||||||
<div id="kc-registration">
|
<a tabIndex={6} href={url.registrationUrl}>
|
||||||
<span>
|
{msg("doRegister")}
|
||||||
{msg("noAccount")}
|
</a>
|
||||||
<a tabIndex={6} href={url.registrationUrl}>
|
</span>
|
||||||
{msg("doRegister")}
|
</div>
|
||||||
</a>
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
>
|
>
|
||||||
<div id="kc-form" className={clsx(realm.password && social.providers !== undefined && getClassName("kcContentWrapperClass"))}>
|
<div id="kc-form" className={clsx(realm.password && social.providers !== undefined && getClassName("kcContentWrapperClass"))}>
|
||||||
@ -66,40 +62,37 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
|
|||||||
{realm.password && (
|
{realm.password && (
|
||||||
<form id="kc-form-login" onSubmit={onSubmit} action={url.loginAction} method="post">
|
<form id="kc-form-login" onSubmit={onSubmit} action={url.loginAction} method="post">
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
{(() => {
|
{!usernameHidden &&
|
||||||
const label = !realm.loginWithEmailAllowed
|
(() => {
|
||||||
? "username"
|
const label = !realm.loginWithEmailAllowed
|
||||||
: realm.registrationEmailAsUsername
|
? "username"
|
||||||
? "email"
|
: realm.registrationEmailAsUsername
|
||||||
: "usernameOrEmail";
|
? "email"
|
||||||
|
: "usernameOrEmail";
|
||||||
|
|
||||||
const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
|
const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<>
|
<>
|
||||||
<label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
|
<label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
|
||||||
{msg(label)}
|
{msg(label)}
|
||||||
</label>
|
</label>
|
||||||
<input
|
<input
|
||||||
tabIndex={1}
|
tabIndex={1}
|
||||||
id={autoCompleteHelper}
|
id={autoCompleteHelper}
|
||||||
className={getClassName("kcInputClass")}
|
className={getClassName("kcInputClass")}
|
||||||
//NOTE: This is used by Google Chrome auto fill so we use it to tell
|
//NOTE: This is used by Google Chrome auto fill so we use it to tell
|
||||||
//the browser how to pre fill the form but before submit we put it back
|
//the browser how to pre fill the form but before submit we put it back
|
||||||
//to username because it is what keycloak expects.
|
//to username because it is what keycloak expects.
|
||||||
name={autoCompleteHelper}
|
name={autoCompleteHelper}
|
||||||
defaultValue={login.username ?? ""}
|
defaultValue={login.username ?? ""}
|
||||||
type="text"
|
type="text"
|
||||||
{...(usernameEditDisabled
|
autoFocus={true}
|
||||||
? { "disabled": true }
|
autoComplete="off"
|
||||||
: {
|
/>
|
||||||
"autoFocus": true,
|
</>
|
||||||
"autoComplete": "off"
|
);
|
||||||
})}
|
})()}
|
||||||
/>
|
|
||||||
</>
|
|
||||||
);
|
|
||||||
})()}
|
|
||||||
</div>
|
</div>
|
||||||
<div className={getClassName("kcFormGroupClass")}>
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
<label htmlFor="password" className={getClassName("kcLabelClass")}>
|
<label htmlFor="password" className={getClassName("kcLabelClass")}>
|
||||||
@ -116,7 +109,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
|
|||||||
</div>
|
</div>
|
||||||
<div className={clsx(getClassName("kcFormGroupClass"), getClassName("kcFormSettingClass"))}>
|
<div className={clsx(getClassName("kcFormGroupClass"), getClassName("kcFormSettingClass"))}>
|
||||||
<div id="kc-form-options">
|
<div id="kc-form-options">
|
||||||
{realm.rememberMe && !usernameEditDisabled && (
|
{realm.rememberMe && !usernameHidden && (
|
||||||
<div className="checkbox">
|
<div className="checkbox">
|
||||||
<label>
|
<label>
|
||||||
<input
|
<input
|
||||||
|
@ -3,6 +3,7 @@ import type { PageProps } from "keycloakify/login/pages/PageProps";
|
|||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
import type { KcContext } from "../kcContext";
|
import type { KcContext } from "../kcContext";
|
||||||
import type { I18n } from "../i18n";
|
import type { I18n } from "../i18n";
|
||||||
|
import { MessageKey } from "keycloakify/login/i18n/i18n";
|
||||||
|
|
||||||
export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pageId: "login-config-totp.ftl" }>, I18n>) {
|
export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pageId: "login-config-totp.ftl" }>, I18n>) {
|
||||||
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
@ -16,7 +17,7 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
|
|||||||
|
|
||||||
const { msg, msgStr } = i18n;
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
const algToKeyUriAlg: Record<KcContext.LoginConfigTotp["totp"]["policy"]["algorithm"], string> = {
|
const algToKeyUriAlg: Record<(typeof kcContext)["totp"]["policy"]["algorithm"], string> = {
|
||||||
"HmacSHA1": "SHA1",
|
"HmacSHA1": "SHA1",
|
||||||
"HmacSHA256": "SHA256",
|
"HmacSHA256": "SHA256",
|
||||||
"HmacSHA512": "SHA512"
|
"HmacSHA512": "SHA512"
|
||||||
@ -30,8 +31,8 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
|
|||||||
<p>{msg("loginTotpStep1")}</p>
|
<p>{msg("loginTotpStep1")}</p>
|
||||||
|
|
||||||
<ul id="kc-totp-supported-apps">
|
<ul id="kc-totp-supported-apps">
|
||||||
{totp.policy.supportedApplications.map(app => (
|
{totp.supportedApplications.map(app => (
|
||||||
<li>{app}</li>
|
<li>{msg(app as MessageKey)}</li>
|
||||||
))}
|
))}
|
||||||
</ul>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
@ -169,7 +170,7 @@ export default function LoginConfigTotp(props: PageProps<Extract<KcContext, { pa
|
|||||||
name="cancel-aia"
|
name="cancel-aia"
|
||||||
value="true"
|
value="true"
|
||||||
>
|
>
|
||||||
${msg("doCancel")}
|
{msg("doCancel")}
|
||||||
</button>
|
</button>
|
||||||
</>
|
</>
|
||||||
) : (
|
) : (
|
||||||
|
67
src/login/pages/LoginDeviceVerifyUserCode.tsx
Normal file
67
src/login/pages/LoginDeviceVerifyUserCode.tsx
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import { I18n } from "../i18n";
|
||||||
|
import { KcContext } from "../kcContext";
|
||||||
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
|
import { PageProps } from "./PageProps";
|
||||||
|
|
||||||
|
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth2-device-verify-user-code.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
||||||
|
const { url } = kcContext;
|
||||||
|
|
||||||
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("oauth2DeviceVerificationTitle")}>
|
||||||
|
<form
|
||||||
|
id="kc-user-verify-device-user-code-form"
|
||||||
|
className={getClassName("kcFormClass")}
|
||||||
|
action={url.oauth2DeviceVerificationAction}
|
||||||
|
method="post"
|
||||||
|
>
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div className={getClassName("kcLabelWrapperClass")}>
|
||||||
|
<label htmlFor="device-user-code" className={getClassName("kcLabelClass")}>
|
||||||
|
{msg("verifyOAuth2DeviceUserCode")}
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className={getClassName("kcInputWrapperClass")}>
|
||||||
|
<input
|
||||||
|
id="device-user-code"
|
||||||
|
name="device_user_code"
|
||||||
|
autoComplete="off"
|
||||||
|
type="text"
|
||||||
|
className={getClassName("kcInputClass")}
|
||||||
|
autoFocus
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div id="kc-form-options" className={getClassName("kcFormOptionsClass")}>
|
||||||
|
<div className={getClassName("kcFormOptionsWrapperClass")}></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="kc-form-buttons" className={getClassName("kcFormButtonsClass")}>
|
||||||
|
<div className={getClassName("kcFormButtonsWrapperClass")}>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonPrimaryClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doSubmit")}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
72
src/login/pages/LoginOauthGrant.tsx
Normal file
72
src/login/pages/LoginOauthGrant.tsx
Normal file
@ -0,0 +1,72 @@
|
|||||||
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
|
import { PageProps } from "./PageProps";
|
||||||
|
import { KcContext } from "../kcContext";
|
||||||
|
import { I18n } from "../i18n";
|
||||||
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
|
|
||||||
|
export default function LoginOauthGrant(props: PageProps<Extract<KcContext, { pageId: "login-oauth-grant.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, classes, Template } = props;
|
||||||
|
const { url, oauth, client } = kcContext;
|
||||||
|
|
||||||
|
const { msg, msgStr, advancedMsg, advancedMsgStr } = i18n;
|
||||||
|
|
||||||
|
const { getClassName } = useGetClassName({
|
||||||
|
doUseDefaultCss,
|
||||||
|
classes
|
||||||
|
});
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Template
|
||||||
|
{...{ kcContext, i18n, doUseDefaultCss, classes }}
|
||||||
|
headerNode={msg("oauthGrantTitle", client.name ? advancedMsgStr(client.name) : client.clientId)}
|
||||||
|
>
|
||||||
|
<div id="kc-oauth" className="content-area">
|
||||||
|
<h3>{msg("oauthGrantRequest")}</h3>
|
||||||
|
<ul>
|
||||||
|
{oauth.clientScopesRequested.map(clientScope => (
|
||||||
|
<li key={clientScope.consentScreenText}>
|
||||||
|
<span>{advancedMsg(clientScope.consentScreenText)}</span>
|
||||||
|
</li>
|
||||||
|
))}
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<form className="form-actions" action={url.oauthAction} method="POST">
|
||||||
|
<input type="hidden" name="code" value={oauth.code} />
|
||||||
|
<div className={getClassName("kcFormGroupClass")}>
|
||||||
|
<div id="kc-form-options">
|
||||||
|
<div className={getClassName("kcFormOptionsWrapperClass")}></div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div id="kc-form-buttons">
|
||||||
|
<div className={getClassName("kcFormButtonsWrapperClass")}>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonPrimaryClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
name="accept"
|
||||||
|
id="kc-login"
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doYes")}
|
||||||
|
/>
|
||||||
|
<input
|
||||||
|
className={clsx(
|
||||||
|
getClassName("kcButtonClass"),
|
||||||
|
getClassName("kcButtonDefaultClass"),
|
||||||
|
getClassName("kcButtonLargeClass")
|
||||||
|
)}
|
||||||
|
name="cancel"
|
||||||
|
id="kc-cancel"
|
||||||
|
type="submit"
|
||||||
|
value={msgStr("doNo")}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
<div className="clearfix"></div>
|
||||||
|
</div>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
@ -1,6 +1,5 @@
|
|||||||
import { useEffect } from "react";
|
import { useEffect } from "react";
|
||||||
import { headInsert } from "keycloakify/tools/headInsert";
|
import { headInsert } from "keycloakify/tools/headInsert";
|
||||||
import { pathJoin } from "keycloakify/bin/tools/pathJoin";
|
|
||||||
import { clsx } from "keycloakify/tools/clsx";
|
import { clsx } from "keycloakify/tools/clsx";
|
||||||
import type { PageProps } from "keycloakify/login/pages/PageProps";
|
import type { PageProps } from "keycloakify/login/pages/PageProps";
|
||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
@ -24,7 +23,7 @@ export default function LoginOtp(props: PageProps<Extract<KcContext, { pageId: "
|
|||||||
|
|
||||||
const { prLoaded, remove } = headInsert({
|
const { prLoaded, remove } = headInsert({
|
||||||
"type": "javascript",
|
"type": "javascript",
|
||||||
"src": pathJoin(kcContext.url.resourcesCommonPath, "node_modules/jquery/dist/jquery.min.js")
|
"src": `${kcContext.url.resourcesCommonPath}/node_modules/jquery/dist/jquery.min.js`
|
||||||
});
|
});
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
|
@ -123,7 +123,7 @@ export default function LoginUpdatePassword(props: PageProps<Extract<KcContext,
|
|||||||
getClassName("kcButtonLargeClass")
|
getClassName("kcButtonLargeClass")
|
||||||
)}
|
)}
|
||||||
type="submit"
|
type="submit"
|
||||||
defaultValue={msgStr("doSubmit")}
|
value={msgStr("doSubmit")}
|
||||||
/>
|
/>
|
||||||
)}
|
)}
|
||||||
</div>
|
</div>
|
||||||
|
@ -11,7 +11,7 @@ export default function LoginVerifyEmail(props: PageProps<Extract<KcContext, { p
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("emailVerifyTitle")}>
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("emailVerifyTitle")}>
|
||||||
<p className="instruction">{msg("emailVerifyInstruction1", user?.email)}</p>
|
<p className="instruction">{msg("emailVerifyInstruction1", user?.email ?? "")}</p>
|
||||||
<p className="instruction">
|
<p className="instruction">
|
||||||
{msg("emailVerifyInstruction2")}
|
{msg("emailVerifyInstruction2")}
|
||||||
<br />
|
<br />
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import type { LazyExoticComponent } from "react";
|
|
||||||
import type { I18n } from "keycloakify/login/i18n";
|
import type { I18n } from "keycloakify/login/i18n";
|
||||||
import { type TemplateProps, type ClassKey } from "keycloakify/login/TemplateProps";
|
import { type TemplateProps, type ClassKey } from "keycloakify/login/TemplateProps";
|
||||||
|
import type { LazyOrNot } from "keycloakify/tools/LazyOrNot";
|
||||||
|
|
||||||
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
export type PageProps<KcContext, I18nExtended extends I18n> = {
|
||||||
Template: LazyExoticComponent<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
Template: LazyOrNot<(props: TemplateProps<any, any>) => JSX.Element | null>;
|
||||||
kcContext: KcContext;
|
kcContext: KcContext;
|
||||||
i18n: I18nExtended;
|
i18n: I18nExtended;
|
||||||
doUseDefaultCss: boolean;
|
doUseDefaultCss: boolean;
|
||||||
|
@ -14,11 +14,13 @@ export default function RegisterUserProfile(props: PageProps<Extract<KcContext,
|
|||||||
classes
|
classes
|
||||||
});
|
});
|
||||||
|
|
||||||
const { url, messagesPerField, recaptchaRequired, recaptchaSiteKey } = kcContext;
|
const { url, messagesPerField, recaptchaRequired, recaptchaSiteKey, realm } = kcContext;
|
||||||
|
|
||||||
|
realm.registrationEmailAsUsername;
|
||||||
|
|
||||||
const { msg, msgStr } = i18n;
|
const { msg, msgStr } = i18n;
|
||||||
|
|
||||||
const [isFomSubmittable, setIsFomSubmittable] = useState(false);
|
const [isFormSubmittable, setIsFormSubmittable] = useState(false);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Template
|
<Template
|
||||||
@ -30,7 +32,7 @@ export default function RegisterUserProfile(props: PageProps<Extract<KcContext,
|
|||||||
<form id="kc-register-form" className={getClassName("kcFormClass")} action={url.registrationAction} method="post">
|
<form id="kc-register-form" className={getClassName("kcFormClass")} action={url.registrationAction} method="post">
|
||||||
<UserProfileFormFields
|
<UserProfileFormFields
|
||||||
kcContext={kcContext}
|
kcContext={kcContext}
|
||||||
onIsFormSubmittableValueChange={setIsFomSubmittable}
|
onIsFormSubmittableValueChange={setIsFormSubmittable}
|
||||||
i18n={i18n}
|
i18n={i18n}
|
||||||
getClassName={getClassName}
|
getClassName={getClassName}
|
||||||
/>
|
/>
|
||||||
@ -60,7 +62,7 @@ export default function RegisterUserProfile(props: PageProps<Extract<KcContext,
|
|||||||
)}
|
)}
|
||||||
type="submit"
|
type="submit"
|
||||||
value={msgStr("doRegister")}
|
value={msgStr("doRegister")}
|
||||||
disabled={!isFomSubmittable}
|
disabled={!isFormSubmittable}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
42
src/login/pages/SamlPostForm.tsx
Normal file
42
src/login/pages/SamlPostForm.tsx
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
import { useEffect, useState } from "react";
|
||||||
|
import type { PageProps } from "keycloakify/login/pages/PageProps";
|
||||||
|
import type { KcContext } from "../kcContext";
|
||||||
|
import type { I18n } from "../i18n";
|
||||||
|
|
||||||
|
export default function SamlPostForm(props: PageProps<Extract<KcContext, { pageId: "saml-post-form.ftl" }>, I18n>) {
|
||||||
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
|
|
||||||
|
const { msgStr, msg } = i18n;
|
||||||
|
|
||||||
|
const { samlPost } = kcContext;
|
||||||
|
|
||||||
|
const [htmlFormElement, setHtmlFormElement] = useState<HTMLFormElement | null>(null);
|
||||||
|
|
||||||
|
useEffect(() => {
|
||||||
|
if (htmlFormElement === null) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Storybook
|
||||||
|
if (samlPost.url === "") {
|
||||||
|
alert("In a real Keycloak the user would be redirected immediately");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
htmlFormElement.submit();
|
||||||
|
}, [htmlFormElement]);
|
||||||
|
return (
|
||||||
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} displayMessage={false} headerNode={msg("saml.post-form.title")}>
|
||||||
|
<p>{msg("saml.post-form.message")}</p>
|
||||||
|
<form name="saml-post-binding" method="post" action={samlPost.url} ref={setHtmlFormElement}>
|
||||||
|
{samlPost.SAMLRequest && <input type="hidden" name="SAMLRequest" value={samlPost.SAMLRequest} />}
|
||||||
|
{samlPost.SAMLResponse && <input type="hidden" name="SAMLResponse" value={samlPost.SAMLResponse} />}
|
||||||
|
{samlPost.relayState && <input type="hidden" name="RelayState" value={samlPost.relayState} />}
|
||||||
|
<noscript>
|
||||||
|
<p>{msg("saml.post-form.js-disabled")}</p>
|
||||||
|
<input type="submit" value={msgStr("doContinue")} />
|
||||||
|
</noscript>
|
||||||
|
</form>
|
||||||
|
</Template>
|
||||||
|
);
|
||||||
|
}
|
@ -7,6 +7,9 @@ import type { PageProps } from "keycloakify/login/pages/PageProps";
|
|||||||
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
|
||||||
import type { KcContext } from "../kcContext";
|
import type { KcContext } from "../kcContext";
|
||||||
import type { I18n } from "../i18n";
|
import type { I18n } from "../i18n";
|
||||||
|
import { assert } from "tsafe/assert";
|
||||||
|
import { is } from "tsafe/is";
|
||||||
|
import { typeGuard } from "tsafe/typeGuard";
|
||||||
|
|
||||||
export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext, { pageId: "webauthn-authenticate.ftl" }>, I18n>) {
|
export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext, { pageId: "webauthn-authenticate.ftl" }>, I18n>) {
|
||||||
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
const { kcContext, i18n, doUseDefaultCss, Template, classes } = props;
|
||||||
@ -21,10 +24,24 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
|
|||||||
const createTimeout = Number(kcContext.createTimeout);
|
const createTimeout = Number(kcContext.createTimeout);
|
||||||
const isUserIdentified = kcContext.isUserIdentified == "true";
|
const isUserIdentified = kcContext.isUserIdentified == "true";
|
||||||
|
|
||||||
|
const formElementRef = useRef<HTMLFormElement>(null);
|
||||||
|
|
||||||
const webAuthnAuthenticate = useConstCallback(async () => {
|
const webAuthnAuthenticate = useConstCallback(async () => {
|
||||||
if (!isUserIdentified) {
|
if (!isUserIdentified) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const submitForm = async (): Promise<void> => {
|
||||||
|
const formElement = formElementRef.current;
|
||||||
|
|
||||||
|
if (formElement === null) {
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 100));
|
||||||
|
return submitForm();
|
||||||
|
}
|
||||||
|
|
||||||
|
formElement.submit();
|
||||||
|
};
|
||||||
|
|
||||||
const allowCredentials = authenticators.authenticators.map(
|
const allowCredentials = authenticators.authenticators.map(
|
||||||
authenticator =>
|
authenticator =>
|
||||||
({
|
({
|
||||||
@ -57,30 +74,36 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
|
|||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const resultRaw = await navigator.credentials.get({ publicKey });
|
const result = await navigator.credentials.get({ publicKey });
|
||||||
if (!resultRaw || resultRaw.type != "public-key") return;
|
if (!result || result.type != "public-key") {
|
||||||
const result = resultRaw as PublicKeyCredential;
|
return;
|
||||||
if (!("authenticatorData" in result.response)) return;
|
}
|
||||||
const response = result.response as AuthenticatorAssertionResponse;
|
assert(is<PublicKeyCredential>(result));
|
||||||
|
if (!("authenticatorData" in result.response)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const response = result.response;
|
||||||
|
|
||||||
const clientDataJSON = response.clientDataJSON;
|
const clientDataJSON = response.clientDataJSON;
|
||||||
|
|
||||||
|
assert(
|
||||||
|
typeGuard<AuthenticatorAssertionResponse>(response, "signature" in response && response.authenticatorData instanceof ArrayBuffer),
|
||||||
|
"response not an AuthenticatorAssertionResponse"
|
||||||
|
);
|
||||||
|
|
||||||
const authenticatorData = response.authenticatorData;
|
const authenticatorData = response.authenticatorData;
|
||||||
const signature = response.signature;
|
const signature = response.signature;
|
||||||
|
|
||||||
setClientDataJSON(base64url.stringify(new Uint8Array(clientDataJSON), { pad: false }));
|
setClientDataJSON(base64url.stringify(new Uint8Array(clientDataJSON), { "pad": false }));
|
||||||
setAuthenticatorData(base64url.stringify(new Uint8Array(authenticatorData), { pad: false }));
|
setAuthenticatorData(base64url.stringify(new Uint8Array(authenticatorData), { "pad": false }));
|
||||||
setSignature(base64url.stringify(new Uint8Array(signature), { pad: false }));
|
setSignature(base64url.stringify(new Uint8Array(signature), { "pad": false }));
|
||||||
setCredentialId(result.id);
|
setCredentialId(result.id);
|
||||||
setUserHandle(base64url.stringify(new Uint8Array(response.userHandle!), { pad: false }));
|
setUserHandle(base64url.stringify(new Uint8Array(response.userHandle!), { "pad": false }));
|
||||||
submitForm();
|
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
setError(String(err));
|
setError(String(err));
|
||||||
submitForm();
|
|
||||||
}
|
}
|
||||||
});
|
|
||||||
|
|
||||||
const webAuthForm = useRef<HTMLFormElement>(null);
|
submitForm();
|
||||||
const submitForm = useConstCallback(() => {
|
|
||||||
webAuthForm.current!.submit();
|
|
||||||
});
|
});
|
||||||
|
|
||||||
const [clientDataJSON, setClientDataJSON] = useState("");
|
const [clientDataJSON, setClientDataJSON] = useState("");
|
||||||
@ -93,7 +116,7 @@ export default function WebauthnAuthenticate(props: PageProps<Extract<KcContext,
|
|||||||
return (
|
return (
|
||||||
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("webauthn-login-title")}>
|
<Template {...{ kcContext, i18n, doUseDefaultCss, classes }} headerNode={msg("webauthn-login-title")}>
|
||||||
<div id="kc-form-webauthn" className={getClassName("kcFormClass")}>
|
<div id="kc-form-webauthn" className={getClassName("kcFormClass")}>
|
||||||
<form id="webauth" action={url.loginAction} ref={webAuthForm} method="post">
|
<form id="webauth" action={url.loginAction} ref={formElementRef} method="post">
|
||||||
<input type="hidden" id="clientDataJSON" name="clientDataJSON" value={clientDataJSON} />
|
<input type="hidden" id="clientDataJSON" name="clientDataJSON" value={clientDataJSON} />
|
||||||
<input type="hidden" id="authenticatorData" name="authenticatorData" value={authenticatorData} />
|
<input type="hidden" id="authenticatorData" name="authenticatorData" value={authenticatorData} />
|
||||||
<input type="hidden" id="signature" name="signature" value={signature} />
|
<input type="hidden" id="signature" name="signature" value={signature} />
|
||||||
|
@ -17,7 +17,7 @@ export type UserProfileFormFieldsProps = {
|
|||||||
export function UserProfileFormFields(props: UserProfileFormFieldsProps) {
|
export function UserProfileFormFields(props: UserProfileFormFieldsProps) {
|
||||||
const { kcContext, onIsFormSubmittableValueChange, i18n, getClassName, BeforeField, AfterField } = props;
|
const { kcContext, onIsFormSubmittableValueChange, i18n, getClassName, BeforeField, AfterField } = props;
|
||||||
|
|
||||||
const { advancedMsg } = i18n;
|
const { advancedMsg, msg } = i18n;
|
||||||
|
|
||||||
const {
|
const {
|
||||||
formValidationState: { fieldStateByAttributeName, isFormSubmittable },
|
formValidationState: { fieldStateByAttributeName, isFormSubmittable },
|
||||||
@ -98,11 +98,16 @@ export function UserProfileFormFields(props: UserProfileFormFieldsProps) {
|
|||||||
}
|
}
|
||||||
value={value}
|
value={value}
|
||||||
>
|
>
|
||||||
{options.options.map(option => (
|
<>
|
||||||
<option key={option} value={option}>
|
<option value="" selected disabled hidden>
|
||||||
{option}
|
{msg("selectAnOption")}
|
||||||
</option>
|
</option>
|
||||||
))}
|
{options.options.map(option => (
|
||||||
|
<option key={option} value={option}>
|
||||||
|
{option}
|
||||||
|
</option>
|
||||||
|
))}
|
||||||
|
</>
|
||||||
</select>
|
</select>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
3
src/tools/LazyOrNot.ts
Normal file
3
src/tools/LazyOrNot.ts
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import type { LazyExoticComponent, ComponentType } from "react";
|
||||||
|
|
||||||
|
export type LazyOrNot<Component extends ComponentType<any>> = LazyExoticComponent<Component> | Component;
|
27
stories/account/KcApp.tsx
Normal file
27
stories/account/KcApp.tsx
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
import React, { lazy, Suspense } from "react";
|
||||||
|
import Fallback from "../../dist/account";
|
||||||
|
import type { KcContext } from "./kcContext";
|
||||||
|
import { useI18n } from "./i18n";
|
||||||
|
|
||||||
|
const DefaultTemplate = lazy(() => import("../../dist/account/Template"));
|
||||||
|
|
||||||
|
export default function KcApp(props: { kcContext: KcContext }) {
|
||||||
|
const { kcContext } = props;
|
||||||
|
|
||||||
|
const i18n = useI18n({ kcContext });
|
||||||
|
|
||||||
|
if (i18n === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Suspense>
|
||||||
|
{(() => {
|
||||||
|
switch (kcContext.pageId) {
|
||||||
|
default:
|
||||||
|
return <Fallback {...{ kcContext, i18n }} Template={DefaultTemplate} doUseDefaultCss={true} />;
|
||||||
|
}
|
||||||
|
})()}
|
||||||
|
</Suspense>
|
||||||
|
);
|
||||||
|
}
|
19
stories/account/createPageStory.tsx
Normal file
19
stories/account/createPageStory.tsx
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
import React from "react";
|
||||||
|
import { getKcContext, type KcContext } from "./kcContext";
|
||||||
|
import KcApp from "./KcApp";
|
||||||
|
import type { DeepPartial } from "../../dist/tools/DeepPartial";
|
||||||
|
|
||||||
|
export function createPageStory<PageId extends KcContext["pageId"]>(params: { pageId: PageId }) {
|
||||||
|
const { pageId } = params;
|
||||||
|
|
||||||
|
function PageStory(params: { kcContext?: DeepPartial<Extract<KcContext, { pageId: PageId }>> }) {
|
||||||
|
const { kcContext } = getKcContext({
|
||||||
|
mockPageId: pageId,
|
||||||
|
storyPartialKcContext: params.kcContext
|
||||||
|
});
|
||||||
|
|
||||||
|
return <KcApp kcContext={kcContext} />;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { PageStory };
|
||||||
|
}
|
5
stories/account/i18n.ts
Normal file
5
stories/account/i18n.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
import { createUseI18n } from "../../dist/account";
|
||||||
|
|
||||||
|
export const { useI18n } = createUseI18n({});
|
||||||
|
|
||||||
|
export type I18n = NonNullable<ReturnType<typeof useI18n>>;
|
7
stories/account/kcContext.ts
Normal file
7
stories/account/kcContext.ts
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
import { createGetKcContext } from "../../dist/account";
|
||||||
|
|
||||||
|
export const { getKcContext } = createGetKcContext();
|
||||||
|
|
||||||
|
const { kcContext } = getKcContext();
|
||||||
|
|
||||||
|
export type KcContext = NonNullable<typeof kcContext>;
|
24
stories/account/pages/Account.stories.tsx
Normal file
24
stories/account/pages/Account.stories.tsx
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
import React from "react";
|
||||||
|
import type { ComponentMeta } from "@storybook/react";
|
||||||
|
import { createPageStory } from "../createPageStory";
|
||||||
|
|
||||||
|
const pageId = "account.ftl";
|
||||||
|
|
||||||
|
const { PageStory } = createPageStory({ pageId });
|
||||||
|
|
||||||
|
const meta: ComponentMeta<any> = {
|
||||||
|
title: `account/${pageId}`,
|
||||||
|
component: PageStory,
|
||||||
|
parameters: {
|
||||||
|
viewMode: "story",
|
||||||
|
previewTabs: {
|
||||||
|
"storybook/docs/panel": {
|
||||||
|
hidden: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export default meta;
|
||||||
|
|
||||||
|
export const Default = () => <PageStory />;
|
32
stories/account/pages/Pasword.stories.tsx
Normal file
32
stories/account/pages/Pasword.stories.tsx
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
import React from "react";
|
||||||
|
import type { ComponentMeta } from "@storybook/react";
|
||||||
|
import { createPageStory } from "../createPageStory";
|
||||||
|
|
||||||
|
const pageId = "password.ftl";
|
||||||
|
|
||||||
|
const { PageStory } = createPageStory({ pageId });
|
||||||
|
|
||||||
|
const meta: ComponentMeta<any> = {
|
||||||
|
title: `account/${pageId}`,
|
||||||
|
component: PageStory,
|
||||||
|
parameters: {
|
||||||
|
viewMode: "story",
|
||||||
|
previewTabs: {
|
||||||
|
"storybook/docs/panel": {
|
||||||
|
hidden: true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
export default meta;
|
||||||
|
|
||||||
|
export const Default = () => <PageStory />;
|
||||||
|
|
||||||
|
export const WithMessage = () => (
|
||||||
|
<PageStory
|
||||||
|
kcContext={{
|
||||||
|
message: { type: "success", summary: "This is a test message" }
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
);
|
9
stories/global.d.ts
vendored
Normal file
9
stories/global.d.ts
vendored
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
declare module "*.png" {
|
||||||
|
const _default: string;
|
||||||
|
export default _default;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare module "*.md" {
|
||||||
|
const _default: string;
|
||||||
|
export default _default;
|
||||||
|
}
|
61
stories/intro/KeycloakifyRotatingLogo.tsx
Normal file
61
stories/intro/KeycloakifyRotatingLogo.tsx
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
import React from "react";
|
||||||
|
import { memo, useState } from "react";
|
||||||
|
import { useConstCallback } from "powerhooks";
|
||||||
|
import { keyframes } from "tss-react";
|
||||||
|
import keycloakifyLogoHeroMovingPngUrl from "./keycloakify-logo-hero-moving.png";
|
||||||
|
import keycloakifyLogoHeroStillPngUrl from "./keycloakify-logo-hero-still.png";
|
||||||
|
import { makeStyles } from "./tss";
|
||||||
|
|
||||||
|
export type Props = {
|
||||||
|
style?: React.CSSProperties;
|
||||||
|
id?: string;
|
||||||
|
onLoad?: () => void;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const KeycloakifyRotatingLogo = memo((props: Props) => {
|
||||||
|
const { id, style, onLoad: onLoadProp } = props;
|
||||||
|
|
||||||
|
const [isImageLoaded, setIsImageLoaded] = useState(false);
|
||||||
|
|
||||||
|
const onLoad = useConstCallback(() => {
|
||||||
|
setIsImageLoaded(true);
|
||||||
|
onLoadProp?.();
|
||||||
|
});
|
||||||
|
|
||||||
|
const { classes } = useStyles({
|
||||||
|
isImageLoaded
|
||||||
|
});
|
||||||
|
return (
|
||||||
|
<div id={id} className={classes.root} style={style}>
|
||||||
|
<img className={classes.rotatingImg} onLoad={onLoad} src={keycloakifyLogoHeroMovingPngUrl} alt={"Rotating react logo"} />
|
||||||
|
<img className={classes.stillImg} src={keycloakifyLogoHeroStillPngUrl} alt={"keyhole"} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
const useStyles = makeStyles<{ isImageLoaded: boolean }>({
|
||||||
|
"name": { KeycloakifyRotatingLogo }
|
||||||
|
})((_theme, { isImageLoaded }) => ({
|
||||||
|
"root": {
|
||||||
|
"position": "relative"
|
||||||
|
},
|
||||||
|
"rotatingImg": {
|
||||||
|
"animation": `${keyframes({
|
||||||
|
"from": {
|
||||||
|
"transform": "rotate(0deg)"
|
||||||
|
},
|
||||||
|
"to": {
|
||||||
|
"transform": "rotate(360deg)"
|
||||||
|
}
|
||||||
|
})} infinite 20s linear`,
|
||||||
|
"width": isImageLoaded ? "100%" : undefined,
|
||||||
|
"height": isImageLoaded ? "auto" : undefined
|
||||||
|
},
|
||||||
|
"stillImg": {
|
||||||
|
"position": "absolute",
|
||||||
|
"top": "0",
|
||||||
|
"left": "0",
|
||||||
|
"width": isImageLoaded ? "100%" : undefined,
|
||||||
|
"height": isImageLoaded ? "auto" : undefined
|
||||||
|
}
|
||||||
|
}));
|
@ -1,6 +1,5 @@
|
|||||||
import { Meta } from "@storybook/addon-docs";
|
import { Meta } from "@storybook/addon-docs";
|
||||||
import { useDarkMode } from "storybook-dark-mode";
|
import { KeycloakifyRotatingLogo } from "./KeycloakifyRotatingLogo";
|
||||||
import "./assets/fonts/WorkSans/font.css";
|
|
||||||
|
|
||||||
<Meta
|
<Meta
|
||||||
title="Introduction"
|
title="Introduction"
|
||||||
@ -16,13 +15,15 @@ import "./assets/fonts/WorkSans/font.css";
|
|||||||
/>
|
/>
|
||||||
|
|
||||||
<div style={{ "margin": "0 auto", "maxWidth": "700px", "textAlign": "center" }}>
|
<div style={{ "margin": "0 auto", "maxWidth": "700px", "textAlign": "center" }}>
|
||||||
<img src="preview.png" />
|
<div style={{ "display": "flex", "justifyContent": "center" }}>
|
||||||
|
<KeycloakifyRotatingLogo style={{ "width": 400 }} />
|
||||||
|
</div>
|
||||||
<h1><a href="#">Keycloakify </a> Storybook</h1>
|
<h1><a href="#">Keycloakify </a> Storybook</h1>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
This website showcases all the Keycloak user-facing pages that can be customized using Keycloakify.
|
This website showcases all the Keycloak user-facing pages that can be customized using Keycloakify.
|
||||||
The storybook serves as a comprehensive reference to help you determine which pages you would like to personalize.
|
The storybook serves as a comprehensive reference to help you determine which pages you would like to personalize.
|
||||||
Keep in mind that customizing the <code>Template</code> component alone will already cover 90% of your customization needs.
|
Keep in mind that customizing the <a href="https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/login/Template.tsx"><code>Template</code></a> component alone will already cover 90% of your customization needs.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
@ -31,4 +32,4 @@ Simply refer to <a href="https://docs.keycloakify.dev/limitations#i-have-establi
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
</div>
|
</div>
|
BIN
stories/intro/keycloakify-logo-hero-moving.png
Normal file
BIN
stories/intro/keycloakify-logo-hero-moving.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 95 KiB |
BIN
stories/intro/keycloakify-logo-hero-still.png
Normal file
BIN
stories/intro/keycloakify-logo-hero-still.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.9 KiB |
5
stories/intro/tss.ts
Normal file
5
stories/intro/tss.ts
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
import { createMakeAndWithStyles } from "tss-react";
|
||||||
|
|
||||||
|
export const { makeStyles, useStyles } = createMakeAndWithStyles({
|
||||||
|
"useTheme": () => ({})
|
||||||
|
});
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user