Implement a mechanism to overload kcContext

src/test/bin/generateKeycloakThemeResources.ts

@@ -1,6 +1,6 @@
 
 import { join as pathJoin } from "path";
-import { generateKeycloakThemeResources } from "../bin/build-keycloak-theme/generateKeycloakThemeResources";
+import { generateKeycloakThemeResources } from "../../bin/build-keycloak-theme/generateKeycloakThemeResources";
 import {
     setupSampleReactProject,
     sampleReactProjectDirPath

src/test/bin/index.ts

@@ -6,7 +6,7 @@ import {
 } from "./setupSampleReactProject";
 import * as st from "scripting-tools";
 import { join as pathJoin } from "path";
-import { getProjectRoot } from "../bin/tools/getProjectRoot";
+import { getProjectRoot } from "../../bin/tools/getProjectRoot";
 
 setupSampleReactProject();
 

src/test/bin/replaceImportFromStatic.ts

@@ -3,7 +3,7 @@ import {
     replaceImportsFromStaticInJsCode,
     replaceImportsInCssCode,
     generateCssCodeToDefineGlobals
-} from "../bin/build-keycloak-theme/replaceImportFromStatic";
+} from "../../bin/build-keycloak-theme/replaceImportFromStatic";
 
 const { fixedJsCode } = replaceImportsFromStaticInJsCode({
     "jsCode": `

src/test/bin/setupSampleReactProject.ts

@@ -1,7 +1,7 @@
 
-import { getProjectRoot } from "../bin/tools/getProjectRoot";
+import { getProjectRoot } from "../../bin/tools/getProjectRoot";
 import { join as pathJoin } from "path";
-import { downloadAndUnzip } from "../bin/tools/downloadAndUnzip";
+import { downloadAndUnzip } from "../../bin/tools/downloadAndUnzip";
 
 export const sampleReactProjectDirPath = pathJoin(getProjectRoot(), "sample_react_project");
 

src/test/lib/getKcContext.ts

@@ -0,0 +1,207 @@
+
+import { getKcContext } from "../../lib/getKcContext";
+import type { KcContextBase } from "../../lib/getKcContext";
+import type { ExtendsKcContextBase } from "../../lib/getKcContext/getKcContext";
+import { same } from "evt/tools/inDepth";
+import { doExtends } from "tsafe/doExtends";
+import { assert } from "tsafe/assert";
+import { kcContextMocks, kcContextCommonMock } from "../../lib/getKcContext/kcContextMocks";
+import { deepClone } from "../../lib/tools/deepClone";
+import type { Any } from "ts-toolbelt";
+
+
+const authorizedMailDomains = [
+	"example.com",
+	"another-example.com",
+	"*.yet-another-example.com",
+	"*.example.com",
+	"hello-world.com"
+];
+
+const displayName = "this is an overwritten common value";
+
+const aNonStandardValue = "a non standard value";
+
+type KcContextExtended = {
+	pageId: "register.ftl";
+	authorizedMailDomains: string[];
+} | {
+	pageId: "my-extra-page-1.ftl";
+} | {
+	pageId: "my-extra-page-2.ftl";
+	aNonStandardValue: string;
+};
+
+function getKcContextProxy(
+	params: {
+		mockPageId: ExtendsKcContextBase<KcContextExtended>["pageId"];
+	}
+) {
+
+	const { mockPageId } = params;
+
+	const { kcContext } = getKcContext<KcContextExtended>({
+		mockPageId,
+		"mockData": [
+			{
+				"pageId": "login.ftl",
+				"realm": { displayName }
+			},
+			{
+				"pageId": "register.ftl",
+				authorizedMailDomains
+			},
+			{
+				"pageId": "my-extra-page-2.ftl",
+				aNonStandardValue
+			}
+		]
+	});
+
+	return { kcContext };
+
+}
+
+{
+
+	const pageId= "login.ftl";
+
+	const { kcContext } = getKcContextProxy({ "mockPageId": pageId });
+
+	//@ts-expect-error
+	doExtends<Any.Equals<typeof kcContext, any>, 1>();
+
+	assert(kcContext?.pageId === pageId);
+
+	doExtends<typeof kcContext, KcContextBase.Login>();
+
+	assert(same(
+		//NOTE: deepClone for printIfExists or other functions...
+		deepClone(kcContext),
+		(() => {
+
+			const mock = deepClone(kcContextMocks.find(({ pageId: pageId_i }) => pageId_i === pageId)!);
+
+			mock.realm.displayName = displayName;
+
+			return mock;
+
+		})()
+	));
+
+	console.log(`PASS ${pageId}`);
+
+}
+
+{
+	const pageId = "register.ftl";
+
+	const { kcContext } = getKcContextProxy({ "mockPageId": pageId });
+
+	//@ts-expect-error
+	doExtends<Any.Equals<typeof kcContext, any>, 1>();
+
+	assert(kcContext?.pageId === pageId);
+
+	doExtends<typeof kcContext, KcContextBase.Register>();
+
+	assert(same(
+		deepClone(kcContext),
+		(() => {
+
+			const mock = deepClone(kcContextMocks.find(({ pageId: pageId_i }) => pageId_i === pageId)!);
+
+			Object.assign(mock, { authorizedMailDomains });
+
+			return mock;
+
+		})()
+	));
+
+	console.log(`PASS ${pageId}`);
+	
+}
+
+{
+
+	const pageId  = "my-extra-page-2.ftl";
+
+	const { kcContext } = getKcContextProxy({ "mockPageId": pageId });
+
+	//@ts-expect-error
+	doExtends<Any.Equals<typeof kcContext, any>, 1>();
+
+	assert(kcContext?.pageId === pageId);
+
+	//@ts-expect-error
+	doExtends<typeof kcContext, KcContextBase>();
+
+	doExtends<typeof kcContext, KcContextBase.Common>();
+
+	assert(same(
+		deepClone(kcContext),
+		(() => {
+
+			const mock = deepClone(kcContextCommonMock);
+
+			Object.assign(mock, { pageId, aNonStandardValue });
+
+			return mock;
+
+		})()
+	));
+
+	console.log(`PASS ${pageId}`);
+
+}
+
+{
+
+	const pageId  = "my-extra-page-1.ftl";
+
+	console.log("We expect a warning here =>");
+
+	const { kcContext } = getKcContextProxy({ "mockPageId": pageId });
+
+	//@ts-expect-error
+	doExtends<Any.Equals<typeof kcContext, any>, 1>();
+
+	assert(kcContext?.pageId === pageId);
+
+	//@ts-expect-error
+	doExtends<typeof kcContext, KcContextBase>();
+
+	doExtends<typeof kcContext, KcContextBase.Common>();
+
+	assert(same(
+		deepClone(kcContext),
+		(() => {
+
+			const mock = deepClone(kcContextCommonMock);
+
+			Object.assign(mock, { pageId });
+
+			return mock;
+
+		})()
+	));
+
+	console.log(`PASS ${pageId}`);
+
+}
+
+{
+	const { kcContext } = getKcContext();
+
+	//@ts-expect-error
+	doExtends<Any.Equals<typeof kcContext, any>, 1>();
+
+	doExtends<typeof kcContext, KcContextBase | undefined>();
+
+}
+
+
+
+
+
+

src/test/lib/index.ts

@@ -0,0 +1,2 @@
+
+import "./getKcContext";

src/test/lib/tools/AndByDiscriminatingKey.type.ts

@@ -0,0 +1,91 @@
+
+import { AndByDiscriminatingKey } from "../../../lib/tools/AndByDiscriminatingKey";
+import { doExtends } from "tsafe/doExtends";
+
+type Base =
+	{ pageId: "a"; onlyA: string; } |
+	{ pageId: "b"; onlyB: string; } |
+	{ pageId: "only base"; onlyBase: string; };
+
+type Extension =
+	{ pageId: "a"; onlyExtA: string; } |
+	{ pageId: "b"; onlyExtB: string; } |
+	{ pageId: "only ext"; onlyExt: string; };
+
+type Got = AndByDiscriminatingKey<"pageId", Extension, Base>;
+
+type Expected =
+	{ pageId: "a"; onlyA: string; onlyExtA: string; } |
+	{ pageId: "b"; onlyB: string; onlyExtB: string; } |
+	{ pageId: "only base"; onlyBase: string; } |
+	{ pageId: "only ext"; onlyExt: string; };
+
+doExtends<Got, Expected>();
+doExtends<Expected, Got>();
+
+const x: Got = null as any;
+
+if (x.pageId === "a") {
+
+	x.onlyA;
+	x.onlyExtA;
+
+	//@ts-expect-error
+	x.onlyB;
+
+	//@ts-expect-error
+	x.onlyBase;
+
+	//@ts-expect-error
+	x.onlyExt;
+
+}
+
+
+if (x.pageId === "b") {
+
+	x.onlyB;
+	x.onlyExtB;
+
+	//@ts-expect-error
+	x.onlyA;
+
+	//@ts-expect-error
+	x.onlyBase;
+
+	//@ts-expect-error
+	x.onlyExt;
+
+}
+
+if (x.pageId === "only base") {
+
+	x.onlyBase;
+
+	//@ts-expect-error
+	x.onlyA;
+
+	//@ts-expect-error
+	x.onlyB;
+
+	//@ts-expect-error
+	x.onlyExt;
+
+}
+
+if (x.pageId === "only ext") {
+
+	x.onlyExt;
+
+
+	//@ts-expect-error
+	x.onlyA;
+
+	//@ts-expect-error
+	x.onlyB;
+
+	//@ts-expect-error
+	x.onlyBase;
+
+}
+