keycloakify 10.0.0-rc.4 → 10.0.0-rc.40

package/src/lib/keycloakJsAdapter.ts

@@ -1,118 +0,0 @@
-export declare namespace keycloak_js {
-    export type KeycloakPromiseCallback<T> = (result: T) => void;
-    export class KeycloakPromise<TSuccess, TError> extends Promise<TSuccess> {
-        success(callback: KeycloakPromiseCallback<TSuccess>): KeycloakPromise<TSuccess, TError>;
-        error(callback: KeycloakPromiseCallback<TError>): KeycloakPromise<TSuccess, TError>;
-    }
-    export interface KeycloakAdapter {
-        login(options?: KeycloakLoginOptions): KeycloakPromise<void, void>;
-        logout(options?: KeycloakLogoutOptions): KeycloakPromise<void, void>;
-        register(options?: KeycloakLoginOptions): KeycloakPromise<void, void>;
-        accountManagement(): KeycloakPromise<void, void>;
-        redirectUri(options: { redirectUri: string }, encodeHash: boolean): string;
-    }
-    export interface KeycloakLogoutOptions {
-        redirectUri?: string;
-    }
-    export interface KeycloakLoginOptions {
-        scope?: string;
-        redirectUri?: string;
-        prompt?: "none" | "login";
-        action?: string;
-        maxAge?: number;
-        loginHint?: string;
-        idpHint?: string;
-        locale?: string;
-        cordovaOptions?: { [optionName: string]: string };
-    }
-
-    export type KeycloakInstance = Record<
-        "createLoginUrl" | "createLogoutUrl" | "createRegisterUrl",
-        (options: KeycloakLoginOptions | undefined) => string
-    > & {
-        createAccountUrl(): string;
-        redirectUri?: string;
-    };
-}
-
-/**
- * @deprecated: This will be removed in the next major version.
- * If you use this, please copy paste the code into your project.
- * Better yet migrate away from keycloak-js and use https://docs.oidc-spa.dev instead.
- *
- * NOTE: This is just a slightly modified version of the default adapter in keycloak-js
- * The goal here is just to be able to inject search param in url before keycloak redirect.
- * Our use case for it is to pass over the login screen the states of useGlobalState
- * namely isDarkModeEnabled, lgn...
- */
-export function createKeycloakAdapter(params: {
-    keycloakInstance: keycloak_js.KeycloakInstance;
-    transformUrlBeforeRedirect: (url: string) => string;
-    getRedirectMethod?: () => "overwrite location.href" | "location.replace";
-}): keycloak_js.KeycloakAdapter {
-    const { keycloakInstance, transformUrlBeforeRedirect, getRedirectMethod = () => "overwrite location.href" } = params;
-
-    const neverResolvingPromise: keycloak_js.KeycloakPromise<void, void> = Object.defineProperties(new Promise(() => {}), {
-        "success": { "value": () => {} },
-        "error": { "value": () => {} }
-    }) as any;
-
-    return {
-        "login": options => {
-            const newHref = transformUrlBeforeRedirect(keycloakInstance.createLoginUrl(options));
-            switch (getRedirectMethod()) {
-                case "location.replace":
-                    window.location.replace(newHref);
-                    break;
-                case "overwrite location.href":
-                    window.location.href = newHref;
-                    break;
-            }
-            return neverResolvingPromise;
-        },
-        "register": options => {
-            const newHref = transformUrlBeforeRedirect(keycloakInstance.createRegisterUrl(options));
-            switch (getRedirectMethod()) {
-                case "location.replace":
-                    window.location.replace(newHref);
-                    break;
-                case "overwrite location.href":
-                    window.location.href = newHref;
-                    break;
-            }
-
-            return neverResolvingPromise;
-        },
-        "logout": options => {
-            window.location.replace(transformUrlBeforeRedirect(keycloakInstance.createLogoutUrl(options)));
-            return neverResolvingPromise;
-        },
-        "accountManagement": () => {
-            const accountUrl = transformUrlBeforeRedirect(keycloakInstance.createAccountUrl());
-
-            if (accountUrl === "undefined") {
-                throw new Error("Not supported by the OIDC server");
-            }
-
-            switch (getRedirectMethod()) {
-                case "location.replace":
-                    window.location.replace(accountUrl);
-                    break;
-                case "overwrite location.href":
-                    window.location.href = accountUrl;
-                    break;
-            }
-
-            return neverResolvingPromise;
-        },
-        "redirectUri": options => {
-            if (options && options.redirectUri) {
-                return options.redirectUri;
-            } else if (keycloakInstance.redirectUri) {
-                return keycloakInstance.redirectUri;
-            } else {
-                return window.location.href;
-            }
-        }
-    };
-}

package/src/lib/useGetClassName.ts

@@ -1,18 +0,0 @@
-import { clsx } from "keycloakify/tools/clsx";
-import { useConstCallback } from "keycloakify/tools/useConstCallback";
-
-export function createUseClassName<ClassKey extends string>(params: { defaultClasses: Record<ClassKey, string | undefined> }) {
-    const { defaultClasses } = params;
-
-    function useGetClassName(params: { doUseDefaultCss: boolean; classes: Partial<Record<ClassKey, string>> | undefined }) {
-        const { classes, doUseDefaultCss } = params;
-
-        const getClassName = useConstCallback((classKey: ClassKey): string => {
-            return clsx(classKey, doUseDefaultCss ? defaultClasses[classKey] : undefined, classes?.[classKey]);
-        });
-
-        return { getClassName };
-    }
-
-    return { useGetClassName };
-}

package/src/login/kcContext/createGetKcContext.ts

@@ -1,159 +0,0 @@
-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 { isStorybook } from "keycloakify/lib/isStorybook";
-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 { symToStr } from "tsafe/symToStr";
-
-export function createGetKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
-    mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];
-    mockProperties?: Record<string, string>;
-}) {
-    const { mockData, mockProperties } = params ?? {};
-
-    function getKcContext<PageId extends ExtendKcContext<KcContextExtension>["pageId"] | undefined = undefined>(params?: {
-        mockPageId?: PageId;
-        storyPartialKcContext?: DeepPartial<Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>>;
-    }): {
-        kcContext: PageId extends undefined
-            ? ExtendKcContext<KcContextExtension> | undefined
-            : Extract<ExtendKcContext<KcContextExtension>, { pageId: PageId }>;
-    } {
-        const { mockPageId, storyPartialKcContext } = params ?? {};
-
-        const realKcContext = getKcContextFromWindow<KcContextExtension>();
-
-        if (mockPageId !== undefined && realKcContext === undefined) {
-            //TODO maybe trow if no mock fo custom page
-
-            warn_that_mock_is_enbaled: {
-                if (isStorybook) {
-                    break warn_that_mock_is_enbaled;
-                }
-
-                console.log(`%cKeycloakify: ${symToStr({ mockPageId })} set to ${mockPageId}.`, "background: red; color: yellow; font-size: medium");
-            }
-
-            const kcContextDefaultMock = kcContextMocks.find(({ pageId }) => pageId === mockPageId);
-
-            const partialKcContextCustomMock = (() => {
-                const out: DeepPartial<ExtendKcContext<KcContextExtension>> = {};
-
-                const mockDataPick = mockData?.find(({ pageId }) => pageId === mockPageId);
-
-                if (mockDataPick !== undefined) {
-                    deepAssign({
-                        "target": out,
-                        "source": mockDataPick
-                    });
-                }
-
-                if (storyPartialKcContext !== undefined) {
-                    deepAssign({
-                        "target": out,
-                        "source": storyPartialKcContext
-                    });
-                }
-
-                return Object.keys(out).length === 0 ? undefined : out;
-            })();
-
-            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 ("profile" in partialKcContextCustomMock) {
-                    assert(kcContextDefaultMock !== undefined && "profile" in kcContextDefaultMock);
-
-                    const { attributes } = kcContextDefaultMock.profile;
-
-                    id<KcContext.Register>(kcContext).profile.attributes = [];
-                    id<KcContext.Register>(kcContext).profile.attributesByName = {};
-
-                    const partialAttributes = [...((partialKcContextCustomMock as DeepPartial<KcContext.Register>).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.Register>(kcContext).profile.attributes.push(augmentedAttribute);
-                        id<KcContext.Register>(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.Register>(kcContext).profile.attributes.push(partialAttribute as any);
-                            id<KcContext.Register>(kcContext).profile.attributesByName[name] = partialAttribute as any;
-                        });
-                }
-            }
-
-            if (mockProperties !== undefined) {
-                deepAssign({
-                    "target": kcContext.properties,
-                    "source": mockProperties
-                });
-            }
-
-            return { kcContext };
-        }
-
-        if (realKcContext === undefined) {
-            return { "kcContext": undefined as any };
-        }
-
-        if (realKcContext.themeType !== "login") {
-            return { "kcContext": undefined as any };
-        }
-
-        return { "kcContext": realKcContext as any };
-    }
-
-    return { getKcContext };
-}

package/src/login/kcContext/getKcContext.ts

@@ -1,21 +0,0 @@
-import type { DeepPartial } from "keycloakify/tools/DeepPartial";
-import type { ExtendKcContext } from "./getKcContextFromWindow";
-import { createGetKcContext } from "./createGetKcContext";
-
-/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier
- *  See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts
- */
-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 { getKcContext } = createGetKcContext<KcContextExtension>({
-        mockData
-    });
-
-    const { kcContext } = getKcContext({ mockPageId });
-
-    return { kcContext };
-}

package/src/login/kcContext/getKcContextFromWindow.ts

@@ -1,11 +0,0 @@
-import type { KcContext } from "./KcContext";
-import type { AndByDiscriminatingKey } from "keycloakify/tools/AndByDiscriminatingKey";
-import { nameOfTheGlobal } from "keycloakify/bin/constants";
-
-export type ExtendKcContext<KcContextExtension extends { pageId: string }> = [KcContextExtension] extends [never]
-    ? KcContext
-    : AndByDiscriminatingKey<"pageId", KcContextExtension & KcContext.Common, KcContext>;
-
-export function getKcContextFromWindow<KcContextExtension extends { pageId: string } = never>(): ExtendKcContext<KcContextExtension> | undefined {
-    return typeof window === "undefined" ? undefined : (window as any)[nameOfTheGlobal];
-}

package/src/login/kcContext/index.ts

@@ -1 +0,0 @@
-export type { KcContext } from "./KcContext";