keycloakify 8.0.0-rc.3 → 9.0.0-rc.0

package/src/bin/eject-keycloak-page.ts

@@ -2,14 +2,7 @@
 
 import { getProjectRoot } from "./tools/getProjectRoot";
 import cliSelect from "cli-select";
-import {
-    loginThemePageIds,
-    accountThemePageIds,
-    type LoginThemePageId,
-    type AccountThemePageId,
-    themeTypes,
-    type ThemeType
-} from "./keycloakify/generateFtl";
+import { loginThemePageIds, accountThemePageIds, type LoginThemePageId, type AccountThemePageId } from "./keycloakify/generateFtl";
 import { capitalize } from "tsafe/capitalize";
 import { readFile, writeFile } from "fs/promises";
 import { existsSync } from "fs";
@@ -17,10 +10,13 @@ import { join as pathJoin, relative as pathRelative } from "path";
 import { kebabCaseToCamelCase } from "./tools/kebabCaseToSnakeCase";
 import { assert, Equals } from "tsafe/assert";
 import { getThemeSrcDirPath } from "./getSrcDirPath";
+import { themeTypes, type ThemeType } from "./constants";
 
 (async () => {
     console.log("Select a theme type");
 
+    const reactAppRootDirPath = process.cwd();
+
     const { value: themeType } = await cliSelect<ThemeType>({
         "values": [...themeTypes]
     }).catch(() => {
@@ -49,7 +45,7 @@ import { getThemeSrcDirPath } from "./getSrcDirPath";
 
     const pageBasename = capitalize(kebabCaseToCamelCase(pageId)).replace(/ftl$/, "tsx");
 
-    const { themeSrcDirPath } = getThemeSrcDirPath({ "projectDirPath": process.cwd() });
+    const { themeSrcDirPath } = getThemeSrcDirPath({ reactAppRootDirPath });
 
     const targetFilePath = pathJoin(themeSrcDirPath, themeType, "pages", pageBasename);
 

package/src/bin/getSrcDirPath.ts

@@ -2,15 +2,15 @@ import * as fs from "fs";
 import { exclude } from "tsafe";
 import { crawl } from "./tools/crawl";
 import { join as pathJoin } from "path";
-import { themeTypes } from "./keycloakify/generateFtl";
+import { themeTypes } from "./constants";
 
 const themeSrcDirBasename = "keycloak-theme";
 
 /** Can't catch error, if the directory isn't found, this function will just exit the process with an error message. */
-export function getThemeSrcDirPath(params: { projectDirPath: string }) {
-    const { projectDirPath } = params;
+export function getThemeSrcDirPath(params: { reactAppRootDirPath: string }) {
+    const { reactAppRootDirPath } = params;
 
-    const srcDirPath = pathJoin(projectDirPath, "src");
+    const srcDirPath = pathJoin(reactAppRootDirPath, "src");
 
     const themeSrcDirPath: string | undefined = crawl({ "dirPath": srcDirPath, "returnedPathsType": "relative to dirPath" })
         .map(fileRelativePath => {

package/src/bin/initialize-email-theme.ts

@@ -10,17 +10,17 @@ import { getLogger } from "./tools/logger";
 import { getThemeSrcDirPath } from "./getSrcDirPath";
 
 export async function main() {
-    const projectDirPath = process.cwd();
+    const reactAppRootDirPath = process.cwd();
 
-    const { isSilent } = readBuildOptions({
-        projectDirPath,
+    const buildOptions = readBuildOptions({
+        reactAppRootDirPath,
         "processArgv": process.argv.slice(2)
     });
 
-    const logger = getLogger({ isSilent });
+    const logger = getLogger({ "isSilent": buildOptions.isSilent });
 
     const { themeSrcDirPath } = getThemeSrcDirPath({
-        projectDirPath
+        reactAppRootDirPath
     });
 
     const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
@@ -36,9 +36,9 @@ export async function main() {
     const builtinKeycloakThemeTmpDirPath = pathJoin(emailThemeSrcDirPath, "..", "tmp_xIdP3_builtin_keycloak_theme");
 
     await downloadBuiltinKeycloakTheme({
-        projectDirPath,
         keycloakVersion,
-        "destDirPath": builtinKeycloakThemeTmpDirPath
+        "destDirPath": builtinKeycloakThemeTmpDirPath,
+        buildOptions
     });
 
     transformCodebase({

package/src/bin/keycloakify/BuildOptions.ts

@@ -1,34 +1,34 @@
-import { assert } from "tsafe/assert";
-import { id } from "tsafe/id";
 import { parse as urlParse } from "url";
-import { typeGuard } from "tsafe/typeGuard";
-import { symToStr } from "tsafe/symToStr";
-import { bundlers, getParsedPackageJson, type Bundler } from "./parsedPackageJson";
-import { join as pathJoin, sep as pathSep } from "path";
+import { getParsedPackageJson } from "./parsedPackageJson";
+import { join as pathJoin } from "path";
 import parseArgv from "minimist";
+import { getAbsoluteAndInOsFormatPath } from "../tools/getAbsoluteAndInOsFormatPath";
 
 /** Consolidated build option gathered form CLI arguments and config in package.json */
 export type BuildOptions = {
     isSilent: boolean;
     themeVersion: string;
-    themeName: string;
-    extraThemeNames: string[];
+    themeNames: string[];
     extraThemeProperties: string[] | undefined;
     groupId: string;
     artifactId: string;
-    bundler: Bundler;
-    keycloakVersionDefaultAssets: string;
+    doCreateJar: boolean;
+    loginThemeResourcesFromKeycloakVersion: string;
+    reactAppRootDirPath: string;
     /** Directory of your built react project. Defaults to {cwd}/build */
     reactAppBuildDirPath: string;
     /** Directory that keycloakify outputs to. Defaults to {cwd}/build_keycloak */
     keycloakifyBuildDirPath: string;
+    publicDirPath: string;
+    cacheDirPath: string;
     /** If your app is hosted under a subpath, it's the case in CRA if you have "homepage": "https://example.com/my-app" in your package.json
      * In this case the urlPathname will be "/my-app/" */
     urlPathname: string | undefined;
+    doBuildRetrocompatAccountTheme: boolean;
 };
 
-export function readBuildOptions(params: { projectDirPath: string; processArgv: string[] }): BuildOptions {
-    const { projectDirPath, processArgv } = params;
+export function readBuildOptions(params: { reactAppRootDirPath: string; processArgv: string[] }): BuildOptions {
+    const { reactAppRootDirPath, processArgv } = params;
 
     const { isSilentCliParamProvided } = (() => {
         const argv = parseArgv(processArgv);
@@ -38,35 +38,36 @@ export function readBuildOptions(params: { projectDirPath: string; processArgv:
         };
     })();
 
-    const parsedPackageJson = getParsedPackageJson({ projectDirPath });
+    const parsedPackageJson = getParsedPackageJson({ reactAppRootDirPath });
 
     const { name, keycloakify = {}, version, homepage } = parsedPackageJson;
 
-    const { extraThemeProperties, groupId, artifactId, bundler, keycloakVersionDefaultAssets, extraThemeNames = [] } = keycloakify ?? {};
+    const { extraThemeProperties, groupId, artifactId, doCreateJar, loginThemeResourcesFromKeycloakVersion } = keycloakify ?? {};
 
-    const themeName =
-        keycloakify.themeName ??
-        name
-            .replace(/^@(.*)/, "$1")
-            .split("/")
-            .join("-");
+    const themeNames = (() => {
+        if (keycloakify.themeName === undefined) {
+            return [
+                name
+                    .replace(/^@(.*)/, "$1")
+                    .split("/")
+                    .join("-")
+            ];
+        }
 
-    return {
-        themeName,
-        extraThemeNames,
-        "bundler": (() => {
-            const { KEYCLOAKIFY_BUNDLER } = process.env;
-
-            assert(
-                typeGuard<Bundler | undefined>(KEYCLOAKIFY_BUNDLER, [undefined, ...id<readonly string[]>(bundlers)].includes(KEYCLOAKIFY_BUNDLER)),
-                `${symToStr({ KEYCLOAKIFY_BUNDLER })} should be one of ${bundlers.join(", ")}`
-            );
+        if (typeof keycloakify.themeName === "string") {
+            return [keycloakify.themeName];
+        }
 
-            return KEYCLOAKIFY_BUNDLER ?? bundler ?? "keycloakify";
-        })(),
-        "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeName}-keycloak-theme`,
+        return keycloakify.themeName;
+    })();
+
+    return {
+        reactAppRootDirPath,
+        themeNames,
+        "doCreateJar": doCreateJar ?? true,
+        "artifactId": process.env.KEYCLOAKIFY_ARTIFACT_ID ?? artifactId ?? `${themeNames[0]}-keycloak-theme`,
         "groupId": (() => {
-            const fallbackGroupId = `${themeName}.keycloak`;
+            const fallbackGroupId = `${themeNames[0]}.keycloak`;
 
             return (
                 process.env.KEYCLOAKIFY_GROUP_ID ??
@@ -83,41 +84,58 @@ export function readBuildOptions(params: { projectDirPath: string; processArgv:
         "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
         extraThemeProperties,
         "isSilent": isSilentCliParamProvided,
-        "keycloakVersionDefaultAssets": keycloakVersionDefaultAssets ?? "11.0.3",
-        "reactAppBuildDirPath": (() => {
-            let { reactAppBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
-
-            if (reactAppBuildDirPath === undefined) {
-                return pathJoin(projectDirPath, "build");
+        "loginThemeResourcesFromKeycloakVersion": loginThemeResourcesFromKeycloakVersion ?? "11.0.3",
+        "publicDirPath": (() => {
+            let { PUBLIC_DIR_PATH } = process.env;
+
+            if (PUBLIC_DIR_PATH !== undefined) {
+                return getAbsoluteAndInOsFormatPath({
+                    "pathIsh": PUBLIC_DIR_PATH,
+                    "cwd": reactAppRootDirPath
+                });
             }
 
-            if (pathSep === "\\") {
-                reactAppBuildDirPath = reactAppBuildDirPath.replace(/\//g, pathSep);
-            }
+            return pathJoin(reactAppRootDirPath, "public");
+        })(),
+        "reactAppBuildDirPath": (() => {
+            const { reactAppBuildDirPath } = parsedPackageJson.keycloakify ?? {};
 
-            if (reactAppBuildDirPath.startsWith(`.${pathSep}`)) {
-                return pathJoin(projectDirPath, reactAppBuildDirPath);
+            if (reactAppBuildDirPath !== undefined) {
+                return getAbsoluteAndInOsFormatPath({
+                    "pathIsh": reactAppBuildDirPath,
+                    "cwd": reactAppRootDirPath
+                });
             }
 
-            return reactAppBuildDirPath;
+            return pathJoin(reactAppRootDirPath, "build");
         })(),
         "keycloakifyBuildDirPath": (() => {
-            let { keycloakifyBuildDirPath = undefined } = parsedPackageJson.keycloakify ?? {};
-
-            if (keycloakifyBuildDirPath === undefined) {
-                return pathJoin(projectDirPath, "build_keycloak");
-            }
-
-            if (pathSep === "\\") {
-                keycloakifyBuildDirPath = keycloakifyBuildDirPath.replace(/\//g, pathSep);
-            }
+            const { keycloakifyBuildDirPath } = parsedPackageJson.keycloakify ?? {};
 
-            if (keycloakifyBuildDirPath.startsWith(`.${pathSep}`)) {
-                return pathJoin(projectDirPath, keycloakifyBuildDirPath);
+            if (keycloakifyBuildDirPath !== undefined) {
+                return getAbsoluteAndInOsFormatPath({
+                    "pathIsh": keycloakifyBuildDirPath,
+                    "cwd": reactAppRootDirPath
+                });
             }
 
-            return keycloakifyBuildDirPath;
+            return pathJoin(reactAppRootDirPath, "build_keycloak");
         })(),
+        "cacheDirPath": pathJoin(
+            (() => {
+                let { XDG_CACHE_HOME } = process.env;
+
+                if (XDG_CACHE_HOME !== undefined) {
+                    return getAbsoluteAndInOsFormatPath({
+                        "pathIsh": XDG_CACHE_HOME,
+                        "cwd": reactAppRootDirPath
+                    });
+                }
+
+                return pathJoin(reactAppRootDirPath, "node_modules", ".cache");
+            })(),
+            "keycloakify"
+        ),
         "urlPathname": (() => {
             const { homepage } = parsedPackageJson;
 
@@ -133,6 +151,7 @@ export function readBuildOptions(params: { projectDirPath: string; processArgv:
 
             const out = url.pathname.replace(/([^/])$/, "$1/");
             return out === "/" ? undefined : out;
-        })()
+        })(),
+        "doBuildRetrocompatAccountTheme": parsedPackageJson.keycloakify?.doBuildRetrocompatAccountTheme ?? true
     };
 }

package/src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -8,13 +8,9 @@ import { objectKeys } from "tsafe/objectKeys";
 import { ftlValuesGlobalName } from "../ftlValuesGlobalName";
 import type { BuildOptions } from "../BuildOptions";
 import { assert } from "tsafe/assert";
-
-export const themeTypes = ["login", "account"] as const;
-
-export type ThemeType = (typeof themeTypes)[number];
+import type { ThemeType } from "../../constants";
 
 export type BuildOptionsLike = {
-    themeName: string;
     themeVersion: string;
     urlPathname: string | undefined;
 };
@@ -22,6 +18,7 @@ export type BuildOptionsLike = {
 assert<BuildOptions extends BuildOptionsLike ? true : false>();
 
 export function generateFtlFilesCodeFactory(params: {
+    themeName: string;
     indexHtmlCode: string;
     //NOTE: Expected to be an empty object if external assets mode is enabled.
     cssGlobalsToDefine: Record<string, string>;
@@ -30,7 +27,7 @@ export function generateFtlFilesCodeFactory(params: {
     themeType: ThemeType;
     fieldNames: string[];
 }) {
-    const { cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
+    const { themeName, cssGlobalsToDefine, indexHtmlCode, buildOptions, keycloakifyVersion, themeType, fieldNames } = params;
 
     const $ = cheerio.load(indexHtmlCode);
 
@@ -104,7 +101,7 @@ export function generateFtlFilesCodeFactory(params: {
             .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
             .replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion)
             .replace("KEYCLOAKIFY_THEME_TYPE_dExKd3xEdr", themeType)
-            .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", buildOptions.themeName),
+            .replace("KEYCLOAKIFY_THEME_NAME_cXxKd3xEer", themeName),
         "<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
             "<#if scripts??>",
             "    <#list scripts as script>",

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountPages.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.keycloak.forms.account;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public enum AccountPages {
+  ACCOUNT,
+  PASSWORD,
+  TOTP,
+  FEDERATED_IDENTITY,
+  LOG,
+  SESSIONS,
+  APPLICATIONS,
+  RESOURCES,
+  RESOURCE_DETAIL;
+}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountProvider.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.keycloak.forms.account;
+
+import jakarta.ws.rs.core.HttpHeaders;
+import jakarta.ws.rs.core.MultivaluedMap;
+import jakarta.ws.rs.core.Response;
+import jakarta.ws.rs.core.UriInfo;
+import java.util.List;
+import org.keycloak.events.Event;
+import org.keycloak.models.RealmModel;
+import org.keycloak.models.UserModel;
+import org.keycloak.models.UserSessionModel;
+import org.keycloak.models.utils.FormMessage;
+import org.keycloak.provider.Provider;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public interface AccountProvider extends Provider {
+
+  AccountProvider setUriInfo(UriInfo uriInfo);
+
+  AccountProvider setHttpHeaders(HttpHeaders httpHeaders);
+
+  Response createResponse(AccountPages page);
+
+  AccountProvider setError(Response.Status status, String message, Object... parameters);
+
+  AccountProvider setErrors(Response.Status status, List<FormMessage> messages);
+
+  AccountProvider setSuccess(String message, Object... parameters);
+
+  AccountProvider setWarning(String message, Object... parameters);
+
+  AccountProvider setUser(UserModel user);
+
+  AccountProvider setProfileFormData(MultivaluedMap<String, String> formData);
+
+  AccountProvider setRealm(RealmModel realm);
+
+  AccountProvider setReferrer(String[] referrer);
+
+  AccountProvider setEvents(List<Event> events);
+
+  AccountProvider setSessions(List<UserSessionModel> sessions);
+
+  AccountProvider setPasswordSet(boolean passwordSet);
+
+  AccountProvider setStateChecker(String stateChecker);
+
+  AccountProvider setIdTokenHint(String idTokenHint);
+
+  AccountProvider setFeatures(
+      boolean social,
+      boolean events,
+      boolean passwordUpdateSupported,
+      boolean authorizationSupported);
+
+  AccountProvider setAttribute(String key, String value);
+}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountProviderFactory.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.keycloak.forms.account;
+
+import org.keycloak.provider.ProviderFactory;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+public interface AccountProviderFactory extends ProviderFactory<AccountProvider> {}

package/src/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountSpi.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.keycloak.forms.account;
+
+import com.google.auto.service.AutoService;
+import org.keycloak.provider.Provider;
+import org.keycloak.provider.ProviderFactory;
+import org.keycloak.provider.Spi;
+
+/**
+ * @author <a href="mailto:sthorger@redhat.com">Stian Thorgersen</a>
+ */
+@AutoService(Spi.class)
+public class AccountSpi implements Spi {
+
+  @Override
+  public boolean isInternal() {
+    return true;
+  }
+
+  @Override
+  public String getName() {
+    return "account";
+  }
+
+  @Override
+  public Class<? extends Provider> getProviderClass() {
+    return AccountProvider.class;
+  }
+
+  @Override
+  public Class<? extends ProviderFactory> getProviderFactoryClass() {
+    return AccountProviderFactory.class;
+  }
+}