From 307650aaea710cfde8bfe282b030f05a993ddf0f Mon Sep 17 00:00:00 2001
From: Joseph Garrone <joseph.garrone.gj@gmail.com>
Date: Sat, 6 Mar 2021 22:41:36 +0100
Subject: [PATCH] rename pageBasename by pageId

---
 .../generateFtl/error.ftl                     |  4 ++
 .../build-keycloak-theme/generateFtl/index.ts | 12 +++---
 .../generateKeycloakThemeResources.ts         |  6 +--
 src/lib/components/Error.tsx                  | 38 +++++++++++++++++++
 src/lib/components/Info.tsx                   |  2 +-
 src/lib/components/KcApp.tsx                  |  2 +-
 src/lib/components/Login.tsx                  |  2 +-
 src/lib/components/Register.tsx               |  2 +-
 src/lib/index.ts                              |  1 +
 src/lib/kcContext.ts                          | 23 ++++++-----
 10 files changed, 68 insertions(+), 24 deletions(-)
 create mode 100644 src/bin/build-keycloak-theme/generateFtl/error.ftl
 create mode 100644 src/lib/components/Error.tsx

diff --git a/src/bin/build-keycloak-theme/generateFtl/error.ftl b/src/bin/build-keycloak-theme/generateFtl/error.ftl
new file mode 100644
index 00000000..ae6e107f
--- /dev/null
+++ b/src/bin/build-keycloak-theme/generateFtl/error.ftl
@@ -0,0 +1,4 @@
+<script>const _= 
+{
+}
+</script>
\ No newline at end of file
diff --git a/src/bin/build-keycloak-theme/generateFtl/index.ts b/src/bin/build-keycloak-theme/generateFtl/index.ts
index 6480c209..b6155351 100644
--- a/src/bin/build-keycloak-theme/generateFtl/index.ts
+++ b/src/bin/build-keycloak-theme/generateFtl/index.ts
@@ -9,7 +9,9 @@ import fs from "fs";
 import { join as pathJoin } from "path";
 import { objectKeys } from "evt/tools/typeSafety/objectKeys";
 
-function loadFtlFile(ftlFileBasename: "template.ftl" | "login.ftl" | "register.ftl" | "info.ftl") {
+export type PageId =  "login.ftl" | "register.ftl" | "info.ftl" | "error.ftl";
+
+function loadFtlFile(ftlFileBasename: PageId | "template.ftl") {
     return fs.readFileSync(pathJoin(__dirname, ftlFileBasename))
         .toString("utf8")
         .match(/^<script>const _=((?:.|\n)+)<\/script>[\n]?$/)![1];
@@ -98,16 +100,16 @@ export function generateFtlFilesCodeFactory(
 
     function generateFtlFilesCode(
         params: {
-            pageBasename: "login.ftl" | "register.ftl" | "info.ftl"
+            pageId: PageId;
         }
     ): { ftlCode: string; } {
 
-        const { pageBasename } = params;
+        const { pageId } = params;
 
         const $ = cheerio.load(partiallyFixedIndexHtmlCode);
 
         const ftlPlaceholders = {
-            '{ "x": "kxOlLqMeOed9sdLdIdOxd444" }': loadFtlFile(pageBasename),
+            '{ "x": "kxOlLqMeOed9sdLdIdOxd444" }': loadFtlFile(pageId),
             ...ftlCommonPlaceholders
         };
 
@@ -117,7 +119,7 @@ export function generateFtlFilesCodeFactory(
                 '<script>',
                 '',
                 `    window.${ftlValuesGlobalName} = Object.assign(`,
-                `        { "pageBasename": "${pageBasename}" },`,
+                `        { "pageId": "${pageId}" },`,
                 `        ${objectKeys(ftlPlaceholders)[0]}`,
                 '    );',
                 '',
diff --git a/src/bin/build-keycloak-theme/generateKeycloakThemeResources.ts b/src/bin/build-keycloak-theme/generateKeycloakThemeResources.ts
index da1907e2..e46bde13 100644
--- a/src/bin/build-keycloak-theme/generateKeycloakThemeResources.ts
+++ b/src/bin/build-keycloak-theme/generateKeycloakThemeResources.ts
@@ -70,12 +70,12 @@ export function generateKeycloakThemeResources(
         ).toString("utf8")
     });
 
-    (["login.ftl", "register.ftl"] as const).forEach(pageBasename => {
+    (["login.ftl", "register.ftl"] as const).forEach(pageId => {
 
-        const { ftlCode } = generateFtlFilesCode({ pageBasename });
+        const { ftlCode } = generateFtlFilesCode({ pageId });
 
         fs.writeFileSync(
-            pathJoin(themeDirPath, pageBasename),
+            pathJoin(themeDirPath, pageId),
             Buffer.from(ftlCode, "utf8")
         )
 
diff --git a/src/lib/components/Error.tsx b/src/lib/components/Error.tsx
new file mode 100644
index 00000000..337c924f
--- /dev/null
+++ b/src/lib/components/Error.tsx
@@ -0,0 +1,38 @@
+
+import { memo } from "react";
+import { Template } from "./Template";
+import type { KcProps } from "./KcProps";
+import { assert } from "../tools/assert";
+import { kcContext } from "../kcContext";
+import { useKcTranslation } from "../i18n/useKcTranslation";
+
+export const Error = memo((props: KcProps) => {
+
+    const { t } = useKcTranslation();
+
+    assert(
+        kcContext !== undefined &&
+        kcContext.pageId === "error.ftl" &&
+        kcContext.message !== undefined
+    );
+
+    const { message, client } = kcContext;
+
+    return (
+        <Template
+            {...props}
+            displayMessage={false}
+            headerNode={t("errorTitle")}
+            formNode={
+        <div id="kc-error-message">
+            <p className="instruction">{message.summary}</p>
+            <#if client?? && client.baseUrl?has_content>
+                <p><a id="backToApplication" href="${client.baseUrl}">${kcSanitize(msg("backToApplication"))?no_esc}</a></p>
+            </#if>
+        </div>
+            }
+        />
+    );
+});
+
+
diff --git a/src/lib/components/Info.tsx b/src/lib/components/Info.tsx
index ee06ce54..8d7c32ca 100644
--- a/src/lib/components/Info.tsx
+++ b/src/lib/components/Info.tsx
@@ -12,7 +12,7 @@ export const Info = memo((props: KcProps) => {
 
     assert(
         kcContext !== undefined &&
-        kcContext.pageBasename === "info.ftl" &&
+        kcContext.pageId === "info.ftl" &&
         kcContext.message !== undefined
     );
 
diff --git a/src/lib/components/KcApp.tsx b/src/lib/components/KcApp.tsx
index 6e95e6af..11a712cf 100644
--- a/src/lib/components/KcApp.tsx
+++ b/src/lib/components/KcApp.tsx
@@ -12,7 +12,7 @@ export const KcApp = memo((props: KcProps) => {
 
     assert(kcContext !== undefined, "App is not currently served by a Keycloak server");
 
-    switch (kcContext.pageBasename) {
+    switch (kcContext.pageId) {
         case "login.ftl": return <Login {...props} />;
         case "register.ftl": return <Register {...props} />;
         case "info.ftl": return <Info {...props} />;
diff --git a/src/lib/components/Login.tsx b/src/lib/components/Login.tsx
index 24a9e810..ed01a8f4 100644
--- a/src/lib/components/Login.tsx
+++ b/src/lib/components/Login.tsx
@@ -14,7 +14,7 @@ export const Login = memo((props: KcProps) => {
 
     assert(
         kcContext !== undefined &&
-        kcContext.pageBasename === "login.ftl"
+        kcContext.pageId === "login.ftl"
     );
 
     const {
diff --git a/src/lib/components/Register.tsx b/src/lib/components/Register.tsx
index 49aecc1b..bdb0f0b9 100644
--- a/src/lib/components/Register.tsx
+++ b/src/lib/components/Register.tsx
@@ -12,7 +12,7 @@ export const Register = memo((props: KcProps) => {
 
     assert(
         kcContext !== undefined &&
-        kcContext.pageBasename === "register.ftl"
+        kcContext.pageId === "register.ftl"
     );
 
     const {
diff --git a/src/lib/index.ts b/src/lib/index.ts
index 6ddb0202..eba9e4c1 100644
--- a/src/lib/index.ts
+++ b/src/lib/index.ts
@@ -9,5 +9,6 @@ export * from "./components/Login";
 export * from "./components/Template";
 export * from "./components/KcApp";
 export * from "./components/Info";
+export * from "./components/Error";
 
 export * from "./tools/assert";
\ No newline at end of file
diff --git a/src/lib/kcContext.ts b/src/lib/kcContext.ts
index b5154e2a..357c1ac9 100644
--- a/src/lib/kcContext.ts
+++ b/src/lib/kcContext.ts
@@ -1,6 +1,6 @@
 
 import { ftlValuesGlobalName } from "../bin/build-keycloak-theme/ftlValuesGlobalName";
-import type { generateFtlFilesCodeFactory } from "../bin/build-keycloak-theme/generateFtl";
+import type { PageId } from "../bin/build-keycloak-theme/generateFtl";
 import { id } from "evt/tools/typeSafety/id";
 import type { KcLanguageTag } from "./i18n/KcLanguageTag";
 import { doExtends } from "evt/tools/typeSafety/doExtends";
@@ -10,7 +10,7 @@ import type { LanguageLabel } from "./i18n/KcLanguageTag";
 type ExtractAfterStartingWith<Prefix extends string, StrEnum> = 
     StrEnum extends `${Prefix}${infer U}` ? U : never;
 
-export type KcContext = KcContext.Login | KcContext.Register | KcContext.Info;
+export type KcContext = KcContext.Login | KcContext.Register | KcContext.Info | KcContext.Error;
 export declare namespace KcContext {
 
     export type Template = {
@@ -55,7 +55,7 @@ export declare namespace KcContext {
     };
 
     export type Login = Template & {
-        pageBasename: "login.ftl";
+        pageId: "login.ftl";
         url: {
             loginResetCredentialsUrl: string;
             registrationUrl: string;
@@ -87,7 +87,7 @@ export declare namespace KcContext {
     };
 
     export type Register = Template & {
-        pageBasename: "register.ftl";
+        pageId: "register.ftl";
         url: {
             registrationAction: string;
         };
@@ -120,7 +120,7 @@ export declare namespace KcContext {
     };
 
     export type Info = Template & {
-        pageBasename: "info.ftl";
+        pageId: "info.ftl";
         messageHeader?: string;
         requiredActions?: ExtractAfterStartingWith<"requiredAction.",MessageKey>[];
         skipLink: boolean;
@@ -131,14 +131,13 @@ export declare namespace KcContext {
         }
     };
 
+    export type Error = Template & {
+        pageId: "error.ftl"
+    };
+
 }
 
-{
-    type T = KcContext["pageBasename"];
-    type U = Parameters<ReturnType<typeof generateFtlFilesCodeFactory>["generateFtlFilesCode"]>[0]["pageBasename"];
-
-    doExtends<T, U>();
-    doExtends<U, T>();
-}
+doExtends<KcContext["pageId"], PageId>();
+doExtends<PageId, KcContext["pageId"]>();
 
 export const kcContext = id<KcContext | undefined>((window as any)[ftlValuesGlobalName]);