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

package/src/vite-plugin/vite-plugin.ts

@@ -1,69 +1,71 @@
 import { join as pathJoin, relative as pathRelative, sep as pathSep } from "path";
 import type { Plugin } from "vite";
-import * as fs from "fs";
 import {
-    resolvedViteConfigJsonBasename,
     nameOfTheGlobal,
     basenameOfTheKeycloakifyResourcesDir,
     keycloak_resources,
-    keycloakifyBuildOptionsForPostPostBuildScriptEnvName
-} from "../bin/constants";
-import type { ResolvedViteConfig } from "../bin/keycloakify/buildOptions/resolvedViteConfig";
-import { getCacheDirPath } from "../bin/keycloakify/buildOptions/getCacheDirPath";
+    vitePluginSubScriptEnvNames
+} from "../bin/shared/constants";
 import { id } from "tsafe/id";
 import { rm } from "../bin/tools/fs.rm";
-import { copyKeycloakResourcesToPublic } from "../bin/copy-keycloak-resources-to-public";
+import { copyKeycloakResourcesToPublic } from "../bin/shared/copyKeycloakResourcesToPublic";
 import { assert } from "tsafe/assert";
-import type { BuildOptions } from "../bin/keycloakify/buildOptions";
-import type { UserProvidedBuildOptions } from "../bin/keycloakify/buildOptions/UserProvidedBuildOptions";
+import {
+    getBuildContext,
+    type BuildContext,
+    type BuildOptions,
+    type ResolvedViteConfig
+} from "../bin/shared/buildContext";
 import MagicString from "magic-string";
+import { generateKcGenTs } from "../bin/shared/generateKcGenTs";
 
-export type Params = UserProvidedBuildOptions & {
-    postBuild?: (buildOptions: Omit<BuildOptions, "bundler">) => Promise<void>;
+export type Params = BuildOptions & {
+    postBuild?: (buildContext: Omit<BuildContext, "bundler">) => Promise<void>;
 };
 
 export function keycloakify(params?: Params) {
-    const { postBuild, ...userProvidedBuildOptions } = params ?? {};
+    const { postBuild, ...buildOptions } = params ?? {};
 
-    let reactAppRootDirPath: string | undefined = undefined;
+    let projectDirPath: string | undefined = undefined;
     let urlPathname: string | undefined = undefined;
     let buildDirPath: string | undefined = undefined;
     let command: "build" | "serve" | undefined = undefined;
     let shouldGenerateSourcemap: boolean | undefined = undefined;
 
     const plugin = {
-        "name": "keycloakify" as const,
-        "configResolved": async resolvedConfig => {
+        name: "keycloakify" as const,
+        configResolved: async resolvedConfig => {
             shouldGenerateSourcemap = resolvedConfig.build.sourcemap !== false;
 
-            run_post_build_script: {
-                const buildOptionJson = process.env[keycloakifyBuildOptionsForPostPostBuildScriptEnvName];
-
-                if (buildOptionJson === undefined) {
-                    break run_post_build_script;
-                }
+            run_post_build_script_case: {
+                const envValue =
+                    process.env[vitePluginSubScriptEnvNames.runPostBuildScript];
 
-                if (postBuild === undefined) {
-                    process.exit(0);
+                if (envValue === undefined) {
+                    break run_post_build_script_case;
                 }
 
-                const buildOptions: BuildOptions = JSON.parse(buildOptionJson);
+                const buildContext = JSON.parse(envValue) as BuildContext;
 
-                await postBuild(buildOptions);
+                await postBuild?.(buildContext);
 
                 process.exit(0);
             }
 
             command = resolvedConfig.command;
 
-            reactAppRootDirPath = resolvedConfig.root;
+            projectDirPath = resolvedConfig.root;
             urlPathname = (() => {
                 let out = resolvedConfig.env.BASE_URL;
 
-                if (out.startsWith(".") && command === "build" && resolvedConfig.envPrefix?.includes("STORYBOOK_") !== true) {
+                if (
+                    out.startsWith(".") &&
+                    command === "build" &&
+                    resolvedConfig.envPrefix?.includes("STORYBOOK_") !== true
+                ) {
                     throw new Error(
                         [
-                            `BASE_URL=${out} is not supported By Keycloakify. Use an absolute URL instead.`,
+                            `BASE_URL=${out} is not supported By Keycloakify. Use an absolute path instead.`,
                             `If this is a problem, please open an issue at https://github.com/keycloakify/keycloakify/issues/new`
                         ].join("\n")
                     );
@@ -84,39 +86,52 @@ export function keycloakify(params?: Params) {
                 return out;
             })();
 
-            buildDirPath = pathJoin(reactAppRootDirPath, resolvedConfig.build.outDir);
+            buildDirPath = pathJoin(projectDirPath, resolvedConfig.build.outDir);
 
-            const { cacheDirPath } = getCacheDirPath({
-                reactAppRootDirPath
-            });
+            resolve_vite_config_case: {
+                const envValue =
+                    process.env[vitePluginSubScriptEnvNames.resolveViteConfig];
 
-            if (!fs.existsSync(cacheDirPath)) {
-                fs.mkdirSync(cacheDirPath, { "recursive": true });
-            }
+                if (envValue === undefined) {
+                    break resolve_vite_config_case;
+                }
+
+                console.log(vitePluginSubScriptEnvNames.resolveViteConfig);
 
-            fs.writeFileSync(
-                pathJoin(cacheDirPath, resolvedViteConfigJsonBasename),
-                Buffer.from(
+                console.log(
                     JSON.stringify(
                         id<ResolvedViteConfig>({
-                            "publicDir": pathRelative(reactAppRootDirPath, resolvedConfig.publicDir),
-                            "assetsDir": resolvedConfig.build.assetsDir,
-                            "buildDir": resolvedConfig.build.outDir,
+                            publicDir: pathRelative(
+                                projectDirPath,
+                                resolvedConfig.publicDir
+                            ),
+                            assetsDir: resolvedConfig.build.assetsDir,
+                            buildDir: resolvedConfig.build.outDir,
                             urlPathname,
-                            userProvidedBuildOptions
-                        }),
-                        null,
-                        2
-                    ),
-                    "utf8"
-                )
-            );
+                            buildOptions
+                        })
+                    )
+                );
+
+                process.exit(0);
+            }
 
-            await copyKeycloakResourcesToPublic({
-                "processArgv": ["--project", reactAppRootDirPath]
+            const buildContext = getBuildContext({
+                cliCommandOptions: {
+                    projectDirPath
+                }
             });
+
+            await Promise.all([
+                copyKeycloakResourcesToPublic({
+                    buildContext
+                }),
+                generateKcGenTs({
+                    buildContext
+                })
+            ]);
         },
-        "transform": (code, id) => {
+        transform: (code, id) => {
             assert(command !== undefined);
             assert(shouldGenerateSourcemap !== undefined);
 
@@ -124,10 +139,12 @@ export function keycloakify(params?: Params) {
                 return;
             }
 
-            assert(reactAppRootDirPath !== undefined);
+            assert(projectDirPath !== undefined);
 
             {
-                const isWithinSourceDirectory = id.startsWith(pathJoin(reactAppRootDirPath, "src") + pathSep);
+                const isWithinSourceDirectory = id.startsWith(
+                    pathJoin(projectDirPath, "src") + pathSep
+                );
 
                 if (!isWithinSourceDirectory) {
                     return;
@@ -165,17 +182,17 @@ export function keycloakify(params?: Params) {
             }
 
             const map = transformedCode.generateMap({
-                "source": id,
-                "includeContent": true,
-                "hires": true
+                source: id,
+                includeContent: true,
+                hires: true
             });
 
             return {
-                "code": transformedCode.toString(),
-                "map": map.toString()
+                code: transformedCode.toString(),
+                map: map.toString()
             };
         },
-        "closeBundle": async () => {
+        closeBundle: async () => {
             assert(command !== undefined);
 
             if (command !== "build") {
@@ -184,7 +201,10 @@ export function keycloakify(params?: Params) {
 
             assert(buildDirPath !== undefined);
 
-            await rm(pathJoin(buildDirPath, keycloak_resources), { "recursive": true, "force": true });
+            await rm(pathJoin(buildDirPath, keycloak_resources), {
+                recursive: true,
+                force: true
+            });
         }
     } satisfies Plugin;
 

package/stories/account/pages/Account.stories.tsx

@@ -0,0 +1,18 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { createPageStory } from "../PageStory";
+
+const { PageStory } = createPageStory({ pageId: "account.ftl" });
+
+const meta = {
+    title: "account/account.ftl",
+    component: PageStory
+} satisfies Meta<typeof PageStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+    render: () => <PageStory />
+};

package/stories/account/pages/FederatedIdentity.stories.tsx

@@ -0,0 +1,38 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { createPageStory } from "../PageStory";
+
+const { PageStory } = createPageStory({ pageId: "federatedIdentity.ftl" });
+
+const meta = {
+    title: "account/federatedIdentity.ftl",
+    component: PageStory
+} satisfies Meta<typeof PageStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+    render: () => <PageStory />
+};
+
+export const NotConnected: Story = {
+    render: () => (
+        <PageStory
+            kcContext={{
+                pageId: "federatedIdentity.ftl",
+                federatedIdentity: {
+                    identities: [
+                        {
+                            providerId: "google",
+                            displayName: "keycloak-oidc",
+                            connected: false
+                        }
+                    ],
+                    removeLinkPossible: true
+                }
+            }}
+        />
+    )
+};

package/stories/account/pages/Log.stories.tsx

@@ -0,0 +1,356 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { createPageStory } from "../PageStory";
+
+const { PageStory } = createPageStory({
+    pageId: "log.ftl"
+});
+
+const meta = {
+    title: "account/log.ftl",
+    component: PageStory
+} satisfies Meta<typeof PageStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+    render: () => (
+        <PageStory
+            kcContext={{
+                log: {
+                    events: [
+                        {
+                            date: "2024-04-26T12:29:08Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T12:10:56Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T11:57:34Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [],
+                            event: "update totp"
+                        },
+                        {
+                            date: "2024-04-26T11:57:21Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [],
+                            event: "update totp"
+                        },
+                        {
+                            date: "2024-04-26T11:56:56Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [],
+                            event: "remove totp"
+                        },
+                        {
+                            date: "2024-04-26T11:56:55Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [],
+                            event: "remove totp"
+                        },
+                        {
+                            date: "2024-04-26T11:56:41Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [],
+                            event: "update totp"
+                        },
+                        {
+                            date: "2024-04-26T11:56:36Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [],
+                            event: "update totp"
+                        },
+                        {
+                            date: "2024-04-26T11:32:54Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:42:54Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:42:52Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:42:40Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:42:09Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "false",
+                                    key: "remember_me"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:24:17Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [],
+                            event: "logout"
+                        },
+                        {
+                            date: "2024-04-26T09:23:54Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:23:50Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:23:47Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:23:15Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [],
+                            event: "logout"
+                        },
+                        {
+                            date: "2024-04-26T09:23:06Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:22:53Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [],
+                            event: "logout"
+                        },
+                        {
+                            date: "2024-04-26T09:21:29Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "false",
+                                    key: "remember_me"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-26T09:17:32Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-18T11:19:09Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-18T11:18:50Z",
+                            ipAddress: "127.0.0.1",
+                            client: "keycloakify-frontend",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        },
+                        {
+                            date: "2024-04-18T11:18:24Z",
+                            ipAddress: "127.0.0.1",
+                            client: "account",
+                            details: [
+                                {
+                                    value: "openid-connect",
+                                    key: "auth_method"
+                                },
+                                {
+                                    value: "john.doe",
+                                    key: "username"
+                                }
+                            ],
+                            event: "login"
+                        }
+                    ]
+                }
+            }}
+        />
+    )
+};

package/stories/account/pages/Password.stories.tsx

@@ -0,0 +1,28 @@
+import React from "react";
+import type { Meta, StoryObj } from "@storybook/react";
+import { createPageStory } from "../PageStory";
+
+const { PageStory } = createPageStory({ pageId: "password.ftl" });
+
+const meta = {
+    title: "account/password.ftl",
+    component: PageStory
+} satisfies Meta<typeof PageStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+    render: () => <PageStory />
+};
+
+export const WithMessage: Story = {
+    render: () => (
+        <PageStory
+            kcContext={{
+                message: { type: "success", summary: "This is a test message" }
+            }}
+        />
+    )
+};