keycloakify 7.6.7 → 7.6.9

package/src/login/kcContext/getKcContext.ts

@@ -1,136 +1,19 @@
-import type { KcContext, Attribute } from "./KcContext";
-import { kcContextMocks, kcContextCommonMock } from "./kcContextMocks";
 import type { DeepPartial } from "keycloakify/tools/DeepPartial";
-import { deepAssign } from "keycloakify/tools/deepAssign";
-import { id } from "tsafe/id";
-import { exclude } from "tsafe/exclude";
-import { assert } from "tsafe/assert";
 import type { ExtendKcContext } from "./getKcContextFromWindow";
-import { getKcContextFromWindow } from "./getKcContextFromWindow";
-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 { loginThemePageIds } from "keycloakify/bin/keycloakify/generateFtl/pageId";
+import { createGetKcContext } from "./createGetKcContext";
 
+/** @deprecated: Use createGetKcContext instead */
 export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
 }): { kcContext: ExtendKcContext<KcContextExtension> | undefined } {
     const { mockPageId, mockData } = params ?? {};
 
-    const realKcContext = getKcContextFromWindow<KcContextExtension>();
+    const { getKcContext } = createGetKcContext<KcContextExtension>({
+        mockData
+    });
 
-    if (mockPageId !== undefined && realKcContext === undefined) {
-        //TODO maybe trow if no mock fo custom page
+    const { kcContext } = getKcContext({ mockPageId });
 
-        console.log(
-            [
-                `%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 partialKcContextCustomMock = mockData?.find(({ pageId }) => pageId === mockPageId);
-
-        if (kcContextDefaultMock === undefined && partialKcContextCustomMock === undefined) {
-            console.warn(
-                [
-                    `WARNING: You declared the non build in page ${mockPageId} but you didn't `,
-                    `provide mock data needed to debug the page outside of Keycloak as you are trying to do now.`,
-                    `Please check the documentation of the getKcContext function`
-                ].join("\n")
-            );
-        }
-
-        const kcContext: any = {};
-
-        deepAssign({
-            "target": kcContext,
-            "source": kcContextDefaultMock !== undefined ? kcContextDefaultMock : { "pageId": mockPageId, ...kcContextCommonMock }
-        });
-
-        if (partialKcContextCustomMock !== undefined) {
-            deepAssign({
-                "target": kcContext,
-                "source": partialKcContextCustomMock
-            });
-
-            if (
-                partialKcContextCustomMock.pageId === "register-user-profile.ftl" ||
-                partialKcContextCustomMock.pageId === "update-user-profile.ftl" ||
-                partialKcContextCustomMock.pageId === "idp-review-user-profile.ftl"
-            ) {
-                assert(
-                    kcContextDefaultMock?.pageId === "register-user-profile.ftl" ||
-                        kcContextDefaultMock?.pageId === "update-user-profile.ftl" ||
-                        kcContextDefaultMock?.pageId === "idp-review-user-profile.ftl"
-                );
-
-                const { attributes } = kcContextDefaultMock.profile;
-
-                id<KcContext.RegisterUserProfile>(kcContext).profile.attributes = [];
-                id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName = {};
-
-                const partialAttributes = [
-                    ...((partialKcContextCustomMock as DeepPartial<KcContext.RegisterUserProfile>).profile?.attributes ?? [])
-                ].filter(exclude(undefined));
-
-                attributes.forEach(attribute => {
-                    const partialAttribute = partialAttributes.find(({ name }) => name === attribute.name);
-
-                    const augmentedAttribute: Attribute = {} as any;
-
-                    deepAssign({
-                        "target": augmentedAttribute,
-                        "source": attribute
-                    });
-
-                    if (partialAttribute !== undefined) {
-                        partialAttributes.splice(partialAttributes.indexOf(partialAttribute), 1);
-
-                        deepAssign({
-                            "target": augmentedAttribute,
-                            "source": partialAttribute
-                        });
-                    }
-
-                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(augmentedAttribute);
-                    id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[augmentedAttribute.name] = augmentedAttribute;
-                });
-
-                partialAttributes
-                    .map(partialAttribute => ({ "validators": {}, ...partialAttribute }))
-                    .forEach(partialAttribute => {
-                        const { name } = partialAttribute;
-
-                        assert(name !== undefined, "If you define a mock attribute it must have at least a name");
-
-                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributes.push(partialAttribute as any);
-                        id<KcContext.RegisterUserProfile>(kcContext).profile.attributesByName[name] = partialAttribute as any;
-                    });
-            }
-        }
-
-        return { kcContext };
-    }
-
-    if (realKcContext === undefined) {
-        return { "kcContext": undefined };
-    }
-
-    if (id<readonly string[]>(loginThemePageIds).indexOf(realKcContext.pageId) < 0 && !("login" in realKcContext)) {
-        return { "kcContext": undefined };
-    }
-
-    {
-        const { url } = realKcContext;
-
-        url.resourcesCommonPath = pathJoin(url.resourcesPath, pathBasename(mockTestingResourcesCommonPath));
-    }
-
-    return { "kcContext": realKcContext };
+    return { kcContext };
 }