keycloakify 7.16.0-rc.1 → 8.0.0-rc.0

package/src/bin/tools/unzip.ts

@@ -2,6 +2,7 @@ import fsp from "node:fs/promises";
 import fs from "fs";
 import path from "node:path";
 import yauzl from "yauzl";
+import yazl from "yazl";
 import stream from "node:stream";
 import { promisify } from "node:util";
 
@@ -19,11 +20,16 @@ async function pathExists(path: string) {
     }
 }
 
-export async function unzip(file: string, targetFolder: string, unzipSubPath?: string) {
-    // add trailing slash to unzipSubPath and targetFolder
-    if (unzipSubPath && (!unzipSubPath.endsWith("/") || !unzipSubPath.endsWith("\\"))) {
-        unzipSubPath += "/";
-    }
+// Handlings of non posix path is not implemented correctly
+// it work by coincidence. Don't have the time to fix but it should be fixed.
+export async function unzip(file: string, targetFolder: string, specificDirsToExtract?: string[]) {
+    specificDirsToExtract = specificDirsToExtract?.map(dirPath => {
+        if (!dirPath.endsWith("/") || !dirPath.endsWith("\\")) {
+            dirPath += "/";
+        }
+
+        return dirPath;
+    });
 
     if (!targetFolder.endsWith("/") || !targetFolder.endsWith("\\")) {
         targetFolder += "/";
@@ -42,15 +48,17 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
             zipfile.readEntry();
 
             zipfile.on("entry", async entry => {
-                if (unzipSubPath) {
+                if (specificDirsToExtract !== undefined) {
+                    const dirPath = specificDirsToExtract.find(dirPath => entry.fileName.startsWith(dirPath));
+
                     // Skip files outside of the unzipSubPath
-                    if (!entry.fileName.startsWith(unzipSubPath)) {
+                    if (dirPath === undefined) {
                         zipfile.readEntry();
                         return;
                     }
 
                     // Remove the unzipSubPath from the file name
-                    entry.fileName = entry.fileName.substring(unzipSubPath.length);
+                    entry.fileName = entry.fileName.substring(dirPath.length);
                 }
 
                 const target = path.join(targetFolder, entry.fileName);
@@ -77,6 +85,8 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
                         return;
                     }
 
+                    await fsp.mkdir(path.dirname(target), { "recursive": true });
+
                     await pipeline(readStream, fs.createWriteStream(target));
 
                     zipfile.readEntry();
@@ -90,3 +100,42 @@ export async function unzip(file: string, targetFolder: string, unzipSubPath?: s
         });
     });
 }
+
+// NOTE: This code was directly copied from ChatGPT and appears to function as expected.
+// However, confidence in its complete accuracy and robustness is limited.
+export async function zip(sourceFolder: string, targetZip: string) {
+    return new Promise<void>(async (resolve, reject) => {
+        const zipfile = new yazl.ZipFile();
+        const files: string[] = [];
+
+        // Recursive function to explore directories and their subdirectories
+        async function exploreDir(dir: string) {
+            const dirContent = await fsp.readdir(dir);
+            for (const file of dirContent) {
+                const filePath = path.join(dir, file);
+                const stat = await fsp.stat(filePath);
+                if (stat.isDirectory()) {
+                    await exploreDir(filePath);
+                } else if (stat.isFile()) {
+                    files.push(filePath);
+                }
+            }
+        }
+
+        // Collecting all files to be zipped
+        await exploreDir(sourceFolder);
+
+        // Adding files to zip
+        for (const file of files) {
+            const relativePath = path.relative(sourceFolder, file);
+            zipfile.addFile(file, relativePath);
+        }
+
+        zipfile.outputStream
+            .pipe(fs.createWriteStream(targetZip))
+            .on("close", () => resolve())
+            .on("error", err => reject(err)); // Listen to error events
+
+        zipfile.end();
+    });
+}

package/src/lib/usePrepareTemplate.ts

@@ -1,21 +1,15 @@
 import { useReducer, useEffect } from "react";
 import { headInsert } from "keycloakify/tools/headInsert";
-import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { clsx } from "keycloakify/tools/clsx";
 
 export function usePrepareTemplate(params: {
     doFetchDefaultThemeResources: boolean;
-    stylesCommon?: string[];
     styles?: string[];
     scripts?: string[];
-    url: {
-        resourcesCommonPath: string;
-        resourcesPath: string;
-    };
     htmlClassName: string | undefined;
     bodyClassName: string | undefined;
 }) {
-    const { doFetchDefaultThemeResources, stylesCommon = [], styles = [], url, scripts = [], htmlClassName, bodyClassName } = params;
+    const { doFetchDefaultThemeResources, styles = [], scripts = [], htmlClassName, bodyClassName } = params;
 
     const [isReady, setReady] = useReducer(() => true, !doFetchDefaultThemeResources);
 
@@ -31,23 +25,18 @@ export function usePrepareTemplate(params: {
         (async () => {
             const prLoadedArray: Promise<void>[] = [];
 
-            [
-                ...stylesCommon.map(relativePath => pathJoin(url.resourcesCommonPath, relativePath)),
-                ...styles.map(relativePath => pathJoin(url.resourcesPath, relativePath))
-            ]
-                .reverse()
-                .forEach(href => {
-                    const { prLoaded, remove } = headInsert({
-                        "type": "css",
-                        "position": "prepend",
-                        href
-                    });
-
-                    removeArray.push(remove);
-
-                    prLoadedArray.push(prLoaded);
+            styles.reverse().forEach(href => {
+                const { prLoaded, remove } = headInsert({
+                    "type": "css",
+                    "position": "prepend",
+                    href
                 });
 
+                removeArray.push(remove);
+
+                prLoadedArray.push(prLoaded);
+            });
+
             await Promise.all(prLoadedArray);
 
             if (isUnmounted) {
@@ -57,10 +46,10 @@ export function usePrepareTemplate(params: {
             setReady();
         })();
 
-        scripts.forEach(relativePath => {
+        scripts.forEach(src => {
             const { remove } = headInsert({
                 "type": "javascript",
-                "src": pathJoin(url.resourcesPath, relativePath)
+                src
             });
 
             removeArray.push(remove);

package/src/login/Template.tsx

@@ -31,13 +31,12 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
 
     const { isReady } = usePrepareTemplate({
         "doFetchDefaultThemeResources": doUseDefaultCss,
-        url,
-        "stylesCommon": [
-            "node_modules/patternfly/dist/css/patternfly.min.css",
-            "node_modules/patternfly/dist/css/patternfly-additions.min.css",
-            "lib/zocial/zocial.css"
+        "styles": [
+            `${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly.min.css`,
+            `${url.resourcesCommonPath}/node_modules/patternfly/dist/css/patternfly-additions.min.css`,
+            `${url.resourcesCommonPath}/lib/zocial/zocial.css`,
+            `${url.resourcesPath}/css/login.css`
         ],
-        "styles": ["css/login.css"],
         "htmlClassName": getClassName("kcHtmlClass"),
         "bodyClassName": undefined
     });

package/src/login/kcContext/KcContext.ts

@@ -145,7 +145,7 @@ export declare namespace KcContext {
             rememberMe?: string;
             password?: string;
         };
-        usernameEditDisabled: boolean;
+        usernameHidden?: boolean;
         social: {
             displayInfo: boolean;
             providers?: {

package/src/login/kcContext/kcContextMocks.ts

@@ -234,10 +234,6 @@ export const kcContextCommonMock: KcContext.Common = {
         "clientId": "myApp"
     },
     "scripts": [],
-    "message": {
-        "type": "success",
-        "summary": "This is a test message"
-    },
     "isAppInitiatedAction": false
 };
 
@@ -264,7 +260,7 @@ export const kcContextMocks = [
         "social": {
             "displayInfo": true
         },
-        "usernameEditDisabled": false,
+        "usernameHidden": false,
         "login": {},
         "registrationDisabled": false
     }),

package/src/login/pages/Login.tsx

@@ -14,7 +14,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
         classes
     });
 
-    const { social, realm, url, usernameEditDisabled, login, auth, registrationDisabled } = kcContext;
+    const { social, realm, url, usernameHidden, login, auth, registrationDisabled } = kcContext;
 
     const { msg, msgStr } = i18n;
 
@@ -66,40 +66,37 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                     {realm.password && (
                         <form id="kc-form-login" onSubmit={onSubmit} action={url.loginAction} method="post">
                             <div className={getClassName("kcFormGroupClass")}>
-                                {(() => {
-                                    const label = !realm.loginWithEmailAllowed
-                                        ? "username"
-                                        : realm.registrationEmailAsUsername
-                                        ? "email"
-                                        : "usernameOrEmail";
+                                {!usernameHidden &&
+                                    (() => {
+                                        const label = !realm.loginWithEmailAllowed
+                                            ? "username"
+                                            : realm.registrationEmailAsUsername
+                                            ? "email"
+                                            : "usernameOrEmail";
 
-                                    const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
+                                        const autoCompleteHelper: typeof label = label === "usernameOrEmail" ? "username" : label;
 
-                                    return (
-                                        <>
-                                            <label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
-                                                {msg(label)}
-                                            </label>
-                                            <input
-                                                tabIndex={1}
-                                                id={autoCompleteHelper}
-                                                className={getClassName("kcInputClass")}
-                                                //NOTE: This is used by Google Chrome auto fill so we use it to tell
-                                                //the browser how to pre fill the form but before submit we put it back
-                                                //to username because it is what keycloak expects.
-                                                name={autoCompleteHelper}
-                                                defaultValue={login.username ?? ""}
-                                                type="text"
-                                                {...(usernameEditDisabled
-                                                    ? { "disabled": true }
-                                                    : {
-                                                          "autoFocus": true,
-                                                          "autoComplete": "off"
-                                                      })}
-                                            />
-                                        </>
-                                    );
-                                })()}
+                                        return (
+                                            <>
+                                                <label htmlFor={autoCompleteHelper} className={getClassName("kcLabelClass")}>
+                                                    {msg(label)}
+                                                </label>
+                                                <input
+                                                    tabIndex={1}
+                                                    id={autoCompleteHelper}
+                                                    className={getClassName("kcInputClass")}
+                                                    //NOTE: This is used by Google Chrome auto fill so we use it to tell
+                                                    //the browser how to pre fill the form but before submit we put it back
+                                                    //to username because it is what keycloak expects.
+                                                    name={autoCompleteHelper}
+                                                    defaultValue={login.username ?? ""}
+                                                    type="text"
+                                                    autoFocus={true}
+                                                    autoComplete="off"
+                                                />
+                                            </>
+                                        );
+                                    })()}
                             </div>
                             <div className={getClassName("kcFormGroupClass")}>
                                 <label htmlFor="password" className={getClassName("kcLabelClass")}>
@@ -116,7 +113,7 @@ export default function Login(props: PageProps<Extract<KcContext, { pageId: "log
                             </div>
                             <div className={clsx(getClassName("kcFormGroupClass"), getClassName("kcFormSettingClass"))}>
                                 <div id="kc-form-options">
-                                    {realm.rememberMe && !usernameEditDisabled && (
+                                    {realm.rememberMe && !usernameHidden && (
                                         <div className="checkbox">
                                             <label>
                                                 <input

package/src/login/pages/LoginOtp.tsx

@@ -1,6 +1,5 @@
 import { useEffect } from "react";
 import { headInsert } from "keycloakify/tools/headInsert";
-import { pathJoin } from "keycloakify/bin/tools/pathJoin";
 import { clsx } from "keycloakify/tools/clsx";
 import type { PageProps } from "keycloakify/login/pages/PageProps";
 import { useGetClassName } from "keycloakify/login/lib/useGetClassName";
@@ -24,7 +23,7 @@ export default function LoginOtp(props: PageProps<Extract<KcContext, { pageId: "
 
         const { prLoaded, remove } = headInsert({
             "type": "javascript",
-            "src": pathJoin(kcContext.url.resourcesCommonPath, "node_modules/jquery/dist/jquery.min.js")
+            "src": `${kcContext.url.resourcesCommonPath}/node_modules/jquery/dist/jquery.min.js`
         });
 
         (async () => {

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

@@ -1,33 +0,0 @@
-/*
- * 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/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountProvider.java

@@ -1,76 +0,0 @@
-/*
- * 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/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountProviderFactory.java

@@ -1,25 +0,0 @@
-/*
- * 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/bin/keycloakify/generateJavaStackFiles/account-v1-java/forms/account/AccountSpi.java

@@ -1,50 +0,0 @@
-/*
- * 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;
-  }
-}