From 88a4c9742823fc9f66d3ca66bb4d5b58a2323dda Mon Sep 17 00:00:00 2001
From: garronej
Date: Mon, 28 Jun 2021 05:30:09 +0200
Subject: [PATCH] Fix last bugs before relasing v2
---
README.md | 6 +++
src/lib/getKcContext/typeHelper.ts | 43 -------------------
...tingKey.d.ts => AndByDiscriminatingKey.ts} | 0
.../{DeepPartial.d.ts => DeepPartial.ts} | 0
4 files changed, 6 insertions(+), 43 deletions(-)
delete mode 100644 src/lib/getKcContext/typeHelper.ts
rename src/lib/tools/{AndByDiscriminatingKey.d.ts => AndByDiscriminatingKey.ts} (100%)
rename src/lib/tools/{DeepPartial.d.ts => DeepPartial.ts} (100%)
diff --git a/README.md b/README.md
index ab9c9e4a..8ac62422 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,12 @@
+**NEW in v2**
+- It's now possible to implement custom `.ftl` pages.
+- Support for Keycloak plugins that introduce non standard ftl values.
+ (Like for example [this plugin](https://github.com/micedre/keycloak-mail-whitelisting) that define `authorizedMailDomains` in `register.ftl`).
+
+**V2 is not yet documented, most users should stick with v1.x.x**
# Motivations
Keycloak provides [theme support](https://www.keycloak.org/docs/latest/server_development/#_themes) for web pages. This allows customizing the look and feel of end-user facing pages so they can be integrated with your applications.
diff --git a/src/lib/getKcContext/typeHelper.ts b/src/lib/getKcContext/typeHelper.ts
deleted file mode 100644
index 1df4dc46..00000000
--- a/src/lib/getKcContext/typeHelper.ts
+++ /dev/null
@@ -1,43 +0,0 @@
-
-
-
-import { KcContextBase } from "./KcContextBase";
-import type { AndByDiscriminatingKey } from "../tools/AndByDiscriminatingKey";
-
-
-export type ExtendsKcContextBase=
- AndByDiscriminatingKey<
- "pageId",
- KcContextExtended & KcContextBase.Common,
- KcContextBase
- >;
-
-type KcContextExtended =
- { pageId: "register.ftl"; authorizedMailDomains: string[]; } |
- { pageId: "my-extra-page-1.ftl"; } |
- { pageId: "my-extra-page-2.ftl"; someCustomValue: string; };
-
-const y: ExtendsKcContextBase = null as any;
-
-
-if (y.pageId === "register.ftl") {
-
- y.authorizedMailDomains;
-
- y.realm.displayName;
-
- y.register
-
-}
-
-if (y.pageId === "my-extra-page-1.ftl") {
- y.realm.displayName;
-}
-
-if (y.pageId === "my-extra-page-2.ftl") {
-
- y.realm
- y.someCustomValue
-
-}
-
diff --git a/src/lib/tools/AndByDiscriminatingKey.d.ts b/src/lib/tools/AndByDiscriminatingKey.ts
similarity index 100%
rename from src/lib/tools/AndByDiscriminatingKey.d.ts
rename to src/lib/tools/AndByDiscriminatingKey.ts
diff --git a/src/lib/tools/DeepPartial.d.ts b/src/lib/tools/DeepPartial.ts
similarity index 100%
rename from src/lib/tools/DeepPartial.d.ts
rename to src/lib/tools/DeepPartial.ts