keycloakify 4.8.0 → 4.8.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/README.md +8 -1
- package/bin/build-keycloak-theme/build-keycloak-theme.js +6 -3
- package/bin/build-keycloak-theme/build-keycloak-theme.js.map +1 -1
- package/bin/create-keycloak-theme-email-directory.d.ts +1 -0
- package/bin/create-keycloak-theme-email-directory.js +1 -0
- package/bin/create-keycloak-theme-email-directory.js.map +1 -1
- package/package.json +1 -1
- package/src/bin/build-keycloak-theme/build-keycloak-theme.ts +7 -3
- package/src/bin/create-keycloak-theme-email-directory.ts +2 -0
package/CHANGELOG.md
CHANGED
@@ -1,3 +1,16 @@
|
|
1
|
+
### **4.8.3** (2022-04-20)
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
### **4.8.2** (2022-04-20)
|
6
|
+
|
7
|
+
- Tell pepoles they can test with different keycloak version
|
8
|
+
|
9
|
+
### **4.8.1** (2022-04-20)
|
10
|
+
|
11
|
+
- Add missing shebang
|
12
|
+
- Add video demo for npx download-builtin-keycloak-theme
|
13
|
+
|
1
14
|
## **4.8.0** (2022-04-20)
|
2
15
|
|
3
16
|
- Document email template customization feature #9
|
package/README.md
CHANGED
@@ -25,7 +25,7 @@
|
|
25
25
|
</a>
|
26
26
|
</p>
|
27
27
|
|
28
|
-
> New with v4.
|
28
|
+
> New with v4.8.0: [Email template customization.](#email-template-customization)
|
29
29
|
|
30
30
|
<p align="center">
|
31
31
|
<i>Ultimately this build tool generates a Keycloak theme</i>
|
@@ -89,6 +89,7 @@ If you already have a Keycloak custom theme, it can be easily ported to Keycloak
|
|
89
89
|
- [Downloading builtin theme resource files](#downloading-builtin-theme-resource-files)
|
90
90
|
- [Email domain whitelist](#email-domain-whitelist)
|
91
91
|
- [Changelog highlights](#changelog-highlights)
|
92
|
+
- [v4.8.0](#v480)
|
92
93
|
- [v4.7.4](#v474)
|
93
94
|
- [v4.7.2](#v472)
|
94
95
|
- [v4.7.0](#v470)
|
@@ -493,6 +494,8 @@ This approach is a bit hacky as it doesn't provide type safety but it works.
|
|
493
494
|
Running `npx download-builtin-keycloak-theme` will let you download the themes that comes by default with
|
494
495
|
a Keycloak version of your choosing.
|
495
496
|
|
497
|
+
[Video demo](https://user-images.githubusercontent.com/6702424/164304458-934b0e1d-9de7-4bb4-8a1c-e06a70b1636a.mov)
|
498
|
+
|
496
499
|
# Email domain whitelist
|
497
500
|
|
498
501
|
NOTE: This have been kind of deprecated by [user attribute](#user-profile-and-frontend-form-validation) you could
|
@@ -503,6 +506,10 @@ and `kcRegisterContext["authorizedMailDomains"]` to validate on.
|
|
503
506
|
|
504
507
|
# Changelog highlights
|
505
508
|
|
509
|
+
## v4.8.0
|
510
|
+
|
511
|
+
[Email template customization.](#email-template-customization)
|
512
|
+
|
506
513
|
## v4.7.4
|
507
514
|
|
508
515
|
**M1 Mac** support (for testing locally with a dockerized Keycloak).
|
@@ -95,11 +95,12 @@ function main() {
|
|
95
95
|
child_process.execSync("mvn package", {
|
96
96
|
"cwd": exports.keycloakThemeBuildingDirPath,
|
97
97
|
});
|
98
|
+
//We want, however to test in a container running the latest Keycloak version
|
99
|
+
var containerKeycloakVersion = "17.0.1";
|
98
100
|
(0, generateStartKeycloakTestingContainer_1.generateStartKeycloakTestingContainer)({
|
99
101
|
keycloakThemeBuildingDirPath: exports.keycloakThemeBuildingDirPath,
|
100
102
|
themeName: themeName,
|
101
|
-
|
102
|
-
"keycloakVersion": "17.0.1",
|
103
|
+
"keycloakVersion": containerKeycloakVersion,
|
103
104
|
});
|
104
105
|
console.log([
|
105
106
|
"",
|
@@ -134,10 +135,12 @@ function main() {
|
|
134
135
|
" value: -Dkeycloak.profile=preview",
|
135
136
|
"",
|
136
137
|
"",
|
137
|
-
"To test your theme locally
|
138
|
+
"To test your theme locally you can spin up a Keycloak " + containerKeycloakVersion + " container image with the theme pre loaded by running:",
|
138
139
|
"",
|
139
140
|
"\uD83D\uDC49 $ ./" + (0, path_1.relative)(reactProjectDirPath, (0, path_1.join)(exports.keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer_1.generateStartKeycloakTestingContainer.basename)) + " \uD83D\uDC48",
|
140
141
|
"",
|
142
|
+
"Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags",
|
143
|
+
"",
|
141
144
|
"Once your container is up and running: ",
|
142
145
|
"- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
|
143
146
|
'- Create a realm named "myrealm"',
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"build-keycloak-theme.js","sourceRoot":"","sources":["../../src/bin/build-keycloak-theme/build-keycloak-theme.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mFAAkF;AAClF,mEAAkE;AAClE,6BAA4F;AAC5F,2DAA+C;AAC/C,iGAAgG;AAChG,2BAA0B;AAC1B,qCAAyB;AAQzB,IAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAE1C,IAAM,mBAAmB,GAAG,CAAA,MAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,0CAAE,WAAW,EAAE,MAAK,mBAAmB,CAAC;AAEnF,IAAM,iBAAiB,GAAsB,OAAO,CAAC,IAAA,WAAQ,EAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;AAEvF,QAAA,4BAA4B,GAAG,IAAA,WAAQ,EAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;AAC/E,QAAA,yBAAyB,GAAG,IAAA,WAAQ,EAAC,oCAA4B,EAAE,IAAI,EAAE,sBAAsB,CAAC,CAAC;AAE9G,SAAS,iBAAiB,CAAC,IAAY;IACnC,OAAO,IAAI;SACN,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC;SACvB,KAAK,CAAC,GAAG,CAAC;SACV,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC;AAED,SAAgB,IAAI;;IAChB,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;IAElD,IAAM,YAAY,GAAa,MAAA,MAAC,iBAAyB,CAAC,aAAa,CAAC,0CAAG,YAAY,CAAC,mCAAI,EAAE,CAAC;IAC/F,IAAM,oBAAoB,GAAa,MAAA,MAAC,iBAAyB,CAAC,aAAa,CAAC,0CAAG,sBAAsB,CAAC,mCAAI,EAAE,CAAC;IACjH,IAAM,SAAS,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAA,qBAAqB,GAAK,IAAA,+DAA8B,sBAC5D,4BAA4B,sCAAA,EAC5B,yBAAyB,mCAAA,EACzB,sBAAsB,EAAE,IAAA,WAAQ,EAAC,mBAAmB,EAAE,OAAO,CAAC,EAC9D,SAAS,WAAA,IACN,CAAC;QACA,IAAM,GAAG,GAAG,CAAC;YACD,IAAA,QAAQ,GAAK,iBAAiB,SAAtB,CAAuB;YAEvC,IAAI,QAAQ,KAAK,SAAS,EAAE;gBACxB,OAAO,IAAI,SAAG,CAAC,QAAQ,CAAC,CAAC;aAC5B;YAED,IAAM,aAAa,GAAG,IAAA,WAAQ,EAAC,mBAAmB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAEvE,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;gBAC9B,OAAO,IAAI,SAAG,CAAC,aAAW,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAG,CAAC,CAAC;aACpG;YAED,OAAO,SAAS,CAAC;QACrB,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO;YACH,aAAa,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;YAC/E,WAAW,EAAE,CAAC,mBAAmB;gBAC7B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,CAAC;oBACG,IAAI,GAAG,KAAK,SAAS,EAAE;wBACnB,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;wBACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;qBACpB;oBAED,OAAO,GAAG,CAAC,MAAM,CAAC;gBACtB,CAAC,CAAC,EAAE;SACb,CAAC;IACN,CAAC,CAAC,EAAE,KACJ,YAAY,cAAA,EACZ,oBAAoB,sBAAA;QACpB,mEAAmE;QACnE,+DAA+D;QAC/D,wDAAwD;QACxD,iBAAiB,EAAE,QAAQ,IAC7B,sBA1C2B,CA0C1B;IAEK,IAAA,WAAW,GAAK,IAAA,+CAAsB,EAAC;QAC3C,SAAS,EAAE,iBAAiB,CAAC,OAAO;QACpC,SAAS,WAAA;QACT,UAAU,EAAE,iBAAiB,CAAC,QAAQ;QACtC,4BAA4B,sCAAA;QAC5B,qBAAqB,uBAAA;KACxB,CAAC,YANiB,CAMhB;IAEH,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE;QAClC,KAAK,EAAE,oCAA4B;KACtC,CAAC,CAAC;IAEH,IAAA,6EAAqC,EAAC;QAClC,4BAA4B,sCAAA;QAC5B,SAAS,WAAA;QACT,
|
1
|
+
{"version":3,"file":"build-keycloak-theme.js","sourceRoot":"","sources":["../../src/bin/build-keycloak-theme/build-keycloak-theme.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mFAAkF;AAClF,mEAAkE;AAClE,6BAA4F;AAC5F,2DAA+C;AAC/C,iGAAgG;AAChG,2BAA0B;AAC1B,qCAAyB;AAQzB,IAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAE1C,IAAM,mBAAmB,GAAG,CAAA,MAAA,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,0CAAE,WAAW,EAAE,MAAK,mBAAmB,CAAC;AAEnF,IAAM,iBAAiB,GAAsB,OAAO,CAAC,IAAA,WAAQ,EAAC,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC;AAEvF,QAAA,4BAA4B,GAAG,IAAA,WAAQ,EAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;AAC/E,QAAA,yBAAyB,GAAG,IAAA,WAAQ,EAAC,oCAA4B,EAAE,IAAI,EAAE,sBAAsB,CAAC,CAAC;AAE9G,SAAS,iBAAiB,CAAC,IAAY;IACnC,OAAO,IAAI;SACN,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC;SACvB,KAAK,CAAC,GAAG,CAAC;SACV,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC;AAED,SAAgB,IAAI;;IAChB,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;IAElD,IAAM,YAAY,GAAa,MAAA,MAAC,iBAAyB,CAAC,aAAa,CAAC,0CAAG,YAAY,CAAC,mCAAI,EAAE,CAAC;IAC/F,IAAM,oBAAoB,GAAa,MAAA,MAAC,iBAAyB,CAAC,aAAa,CAAC,0CAAG,sBAAsB,CAAC,mCAAI,EAAE,CAAC;IACjH,IAAM,SAAS,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAA,qBAAqB,GAAK,IAAA,+DAA8B,sBAC5D,4BAA4B,sCAAA,EAC5B,yBAAyB,mCAAA,EACzB,sBAAsB,EAAE,IAAA,WAAQ,EAAC,mBAAmB,EAAE,OAAO,CAAC,EAC9D,SAAS,WAAA,IACN,CAAC;QACA,IAAM,GAAG,GAAG,CAAC;YACD,IAAA,QAAQ,GAAK,iBAAiB,SAAtB,CAAuB;YAEvC,IAAI,QAAQ,KAAK,SAAS,EAAE;gBACxB,OAAO,IAAI,SAAG,CAAC,QAAQ,CAAC,CAAC;aAC5B;YAED,IAAM,aAAa,GAAG,IAAA,WAAQ,EAAC,mBAAmB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;YAEvE,IAAI,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE;gBAC9B,OAAO,IAAI,SAAG,CAAC,aAAW,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAG,CAAC,CAAC;aACpG;YAED,OAAO,SAAS,CAAC;QACrB,CAAC,CAAC,EAAE,CAAC;QAEL,OAAO;YACH,aAAa,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC;YAC/E,WAAW,EAAE,CAAC,mBAAmB;gBAC7B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,CAAC;oBACG,IAAI,GAAG,KAAK,SAAS,EAAE;wBACnB,OAAO,CAAC,KAAK,CAAC,yDAAyD,CAAC,CAAC;wBACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;qBACpB;oBAED,OAAO,GAAG,CAAC,MAAM,CAAC;gBACtB,CAAC,CAAC,EAAE;SACb,CAAC;IACN,CAAC,CAAC,EAAE,KACJ,YAAY,cAAA,EACZ,oBAAoB,sBAAA;QACpB,mEAAmE;QACnE,+DAA+D;QAC/D,wDAAwD;QACxD,iBAAiB,EAAE,QAAQ,IAC7B,sBA1C2B,CA0C1B;IAEK,IAAA,WAAW,GAAK,IAAA,+CAAsB,EAAC;QAC3C,SAAS,EAAE,iBAAiB,CAAC,OAAO;QACpC,SAAS,WAAA;QACT,UAAU,EAAE,iBAAiB,CAAC,QAAQ;QACtC,4BAA4B,sCAAA;QAC5B,qBAAqB,uBAAA;KACxB,CAAC,YANiB,CAMhB;IAEH,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE;QAClC,KAAK,EAAE,oCAA4B;KACtC,CAAC,CAAC;IAEH,6EAA6E;IAC7E,IAAM,wBAAwB,GAAG,QAAQ,CAAC;IAE1C,IAAA,6EAAqC,EAAC;QAClC,4BAA4B,sCAAA;QAC5B,SAAS,WAAA;QACT,iBAAiB,EAAE,wBAAwB;KAC9C,CAAC,CAAC;IAEH,OAAO,CAAC,GAAG,CACP;QACI,EAAE;QACF,sEAA+D,IAAA,eAAY,EAAC,mBAAmB,EAAE,WAAW,CAAC,kBAAK;QAClH,8HAA4H;QAC5H,EAAE;QACF,2EAA2E;QAC3E,EAAE;QACF,cAAc;QACd,4BAA4B;QAC5B,oCAAoC;QACpC,kCAAkC;QAClC,yCAAyC;QACzC,oBAAoB;QACpB,kBAAkB;QAClB,iBAAiB;QACjB,kBAAkB;QAClB,gDAA8C,IAAA,eAAY,EAAC,WAAW,CAAC,4BAAuB,IAAA,eAAY,EAAC,WAAW,CAAG;QACzH,yBAAyB;QACzB,gCAAgC;QAChC,sCAAsC;QACtC,UAAU;QACV,8BAA8B;QAC9B,gCAAgC;QAChC,qEAAqE;QACrE,iBAAiB;QACjB,2BAA2B;QAC3B,oBAAoB;QACpB,+BAA+B;QAC/B,wBAAwB;QACxB,uBAAuB;QACvB,yCAAyC;QACzC,EAAE;QACF,EAAE;QACF,2DAAyD,wBAAwB,2DAAwD;QACzI,EAAE;QACF,sBAAU,IAAA,eAAY,EAAC,mBAAmB,EAAE,IAAA,WAAQ,EAAC,oCAA4B,EAAE,6EAAqC,CAAC,QAAQ,CAAC,CAAC,kBAAK;QACxI,EAAE;QACF,mJAAmJ;QACnJ,EAAE;QACF,yCAAyC;QACzC,iGAAiG;QACjG,kCAAkC;QAClC,oFAAoF;QACpF,2BAAyB,SAAS,sDAAmD;QACrF,iIAAyG;QACzG,EAAE;QACF,0DAA0D;QAC1D,EAAE;KACL,CAAC,IAAI,CAAC,IAAI,CAAC,CACf,CAAC;AACN,CAAC;AA3HD,oBA2HC"}
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"create-keycloak-theme-email-directory.js","sourceRoot":"","sources":["../src/bin/create-keycloak-theme-email-directory.ts"],"names":[],"mappings":"
|
1
|
+
{"version":3,"file":"create-keycloak-theme-email-directory.js","sourceRoot":"","sources":["../src/bin/create-keycloak-theme-email-directory.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,qFAAiF;AACjF,+DAAmE;AACnE,6BAAkE;AAClE,+DAA8D;AAC9D,iEAAgE;AAChE,qCAAyB;AAEzB,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IACzB,CAAC;;;;;oBACG,IAAI,EAAE,CAAC,UAAU,CAAC,gDAAyB,CAAC,EAAE;wBAC1C,OAAO,CAAC,GAAG,CAAC,0BAAwB,IAAA,eAAY,EAAC,gDAAyB,CAAC,0CAAuC,CAAC,CAAC;wBAEpH,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;qBACpB;oBAE2B,qBAAM,IAAA,6CAAqB,GAAE,EAAA;;oBAAjD,eAAe,GAAK,CAAA,SAA6B,CAAA,gBAAlC;oBAEjB,8BAA8B,GAAG,IAAA,WAAQ,EAAC,gDAAyB,EAAE,IAAI,EAAE,kCAAkC,CAAC,CAAC;oBAErH,IAAA,8DAA4B,EAAC;wBACzB,eAAe,iBAAA;wBACf,aAAa,EAAE,8BAA8B;qBAChD,CAAC,CAAC;oBAEH,IAAA,qCAAiB,EAAC;wBACd,YAAY,EAAE,IAAA,WAAQ,EAAC,8BAA8B,EAAE,MAAM,EAAE,OAAO,CAAC;wBACvE,aAAa,EAAE,gDAAyB;qBAC3C,CAAC,CAAC;oBAEH,OAAO,CAAC,GAAG,CAAC,OAAK,IAAA,eAAY,EAAC,gDAAyB,CAAC,4BAAyB,CAAC,CAAC;oBAEnF,EAAE,CAAC,MAAM,CAAC,8BAA8B,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;;;;SACnF,CAAC,EAAE,CAAC;CACR"}
|
package/package.json
CHANGED
@@ -91,11 +91,13 @@ export function main() {
|
|
91
91
|
"cwd": keycloakThemeBuildingDirPath,
|
92
92
|
});
|
93
93
|
|
94
|
+
//We want, however to test in a container running the latest Keycloak version
|
95
|
+
const containerKeycloakVersion = "17.0.1";
|
96
|
+
|
94
97
|
generateStartKeycloakTestingContainer({
|
95
98
|
keycloakThemeBuildingDirPath,
|
96
99
|
themeName,
|
97
|
-
|
98
|
-
"keycloakVersion": "17.0.1",
|
100
|
+
"keycloakVersion": containerKeycloakVersion,
|
99
101
|
});
|
100
102
|
|
101
103
|
console.log(
|
@@ -132,10 +134,12 @@ export function main() {
|
|
132
134
|
" value: -Dkeycloak.profile=preview",
|
133
135
|
"",
|
134
136
|
"",
|
135
|
-
|
137
|
+
`To test your theme locally you can spin up a Keycloak ${containerKeycloakVersion} container image with the theme pre loaded by running:`,
|
136
138
|
"",
|
137
139
|
`👉 $ ./${pathRelative(reactProjectDirPath, pathJoin(keycloakThemeBuildingDirPath, generateStartKeycloakTestingContainer.basename))} 👈`,
|
138
140
|
"",
|
141
|
+
"Test with different Keycloak versions by editing the .sh file. see available versions here: https://quay.io/repository/keycloak/keycloak?tab=tags",
|
142
|
+
"",
|
139
143
|
"Once your container is up and running: ",
|
140
144
|
"- Log into the admin console 👉 http://localhost:8080/admin username: admin, password: admin 👈",
|
141
145
|
'- Create a realm named "myrealm"',
|