@firecms/core 3.0.0-canary.11 → 3.0.0-canary.111

package/src/hooks/useBuildNavigationController.tsx

@@ -19,7 +19,7 @@ import {
 import {
     applyPermissionsFunctionIfEmpty,
     getCollectionByPathOrId,
-    mergeDeep,
+    mergeDeep, removeFunctions,
     removeInitialAndTrailingSlashes,
     resolveCollectionPathIds,
     resolvePermissions
@@ -29,7 +29,7 @@ import { getParentReferencesFromPath } from "../util/parent_references_from_path
 const DEFAULT_BASE_PATH = "/";
 const DEFAULT_COLLECTION_PATH = "/c";
 
-type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+export type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
     basePath?: string,
     baseCollectionPath?: string,
     authController: AuthController<UserType>;
@@ -130,6 +130,30 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
                 .filter(Boolean) as TopNavigationEntry[]
         ];
 
+        // Sort by group, entries with group "Admin" will go last, and second to last will be the group "Views"
+        navigationEntries = navigationEntries.sort((a, b) => {
+            if (a.group !== "Views" && a.group !== "Admin" && (b.group === "Views" || b.group === "Admin")) {
+                return -1;
+            }
+            if (b.group !== "Views" && b.group !== "Admin" && (a.group === "Views" || a.group === "Admin")) {
+                return 1;
+            }
+            if (a.group === "Admin" && b.group !== "Admin") {
+                return 1;
+            }
+            if (a.group !== "Admin" && b.group === "Admin") {
+                return -1;
+            }
+            if (a.group === "Views" && b.group !== "Views") {
+                return -1;
+            }
+            if (a.group !== "Views" && b.group === "Views") {
+                return 1;
+            }
+            return 0;
+
+        });
+
         if (viewsOrder) {
             navigationEntries = navigationEntries.sort((a, b) => {
                 const aIndex = viewsOrder.indexOf(a.path);
@@ -163,32 +187,51 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
         if (authController.initialLoading)
             return;
 
+        console.debug("Refreshing navigation");
+
         try {
-            console.debug("Refreshing navigation")
+
             const [resolvedCollections = [], resolvedViews, resolvedAdminViews = []] = await Promise.all([
                     resolveCollections(collectionsProp, collectionPermissions, authController, dataSourceDelegate, injectCollections),
                     resolveCMSViews(viewsProp, authController, dataSourceDelegate),
                     resolveCMSViews(adminViewsProp, authController, dataSourceDelegate)
                 ]
             );
-            if (
-                !equal(collectionsRef.current, resolvedCollections) ||
-                !equal(viewsRef.current, resolvedViews) ||
-                !equal(adminViewsRef.current, resolvedAdminViews) ||
-                !equal(topLevelNavigation, computeTopNavigation(resolvedCollections, resolvedViews, resolvedAdminViews, viewsOrder))
-            ) {
+
+            let shouldUpdateTopLevelNav = false;
+            if (!areCollectionListsEqual(collectionsRef.current ?? [], resolvedCollections)) {
+                console.log("Collections need to be updated");
+                collectionsRef.current = resolvedCollections;
+                shouldUpdateTopLevelNav = true;
+            }
+            if (collectionsRef.current === undefined) {
                 collectionsRef.current = resolvedCollections;
+                shouldUpdateTopLevelNav = true;
+            }
+            if (!equal(viewsRef.current, resolvedViews)) {
+                console.log("Views need to be updated");
                 viewsRef.current = resolvedViews;
+                shouldUpdateTopLevelNav = true;
+            }
+            if (!equal(adminViewsRef.current, resolvedAdminViews)) {
+                console.log("Admin views need to be updated");
                 adminViewsRef.current = resolvedAdminViews;
-                setTopLevelNavigation(computeTopNavigation(resolvedCollections ?? [], resolvedViews, resolvedAdminViews, viewsOrder));
+                shouldUpdateTopLevelNav = true;
+            }
+
+            const computedTopLevelNav = computeTopNavigation(resolvedCollections, resolvedViews, resolvedAdminViews, viewsOrder);
+            if (shouldUpdateTopLevelNav && !equal(topLevelNavigation, computedTopLevelNav)) {
+                setTopLevelNavigation(computedTopLevelNav);
             }
         } catch (e) {
             console.error(e);
             setNavigationLoadingError(e as any);
         }
 
-        setNavigationLoading(false);
-        setInitialised(true);
+        if (navigationLoading)
+            setNavigationLoading(false);
+        if (!initialised)
+            setInitialised(true);
 
     }, [
         collectionsProp,
@@ -205,9 +248,8 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
         refreshNavigation();
     }, [refreshNavigation]);
 
-    const getCollection = useCallback(<EC extends EntityCollection>(
+    const getCollection = useCallback((
         idOrPath: string,
-        entityId?: string,
         includeUserOverride = false
     ): EC | undefined => {
         const collections = collectionsRef.current;
@@ -217,8 +259,7 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
         const baseCollection = getCollectionByPathOrId(removeInitialAndTrailingSlashes(idOrPath), collections);
 
         const userOverride = includeUserOverride ? userConfigPersistence?.getCollectionConfig(idOrPath) : undefined;
-
-        const overriddenCollection = baseCollection ? mergeDeep(baseCollection, userOverride) : undefined;
+        const overriddenCollection = baseCollection ? mergeDeep(baseCollection, userOverride ?? {}) : undefined;
 
         let result: Partial<EntityCollection> | undefined = overriddenCollection;
 
@@ -238,17 +279,14 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
 
         return { ...overriddenCollection, ...result } as EC;
 
-    }, [
-        basePath,
-        baseCollectionPath,
-    ]);
+    }, [userConfigPersistence]);
 
     const getCollectionFromPaths = useCallback(<EC extends EntityCollection>(pathSegments: string[]): EC | undefined => {
 
         const collections = collectionsRef.current;
+        if (collections === undefined)
+            throw Error("getCollectionFromPaths: Collections have not been initialised yet");
         let currentCollections: EntityCollection[] | undefined = [...(collections ?? [])];
-        if (!currentCollections)
-            throw Error("Collections have not been initialised yet");
 
         for (let i = 0; i < pathSegments.length; i++) {
             const pathSegment = pathSegments[i];
@@ -267,9 +305,9 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
     const getCollectionFromIds = useCallback(<EC extends EntityCollection>(ids: string[]): EC | undefined => {
 
         const collections = collectionsRef.current;
+        if (collections === undefined)
+            throw Error("getCollectionFromIds: Collections have not been initialised yet");
         let currentCollections: EntityCollection[] | undefined = [...(collections ?? [])];
-        if (!currentCollections)
-            throw Error("Collections have not been initialised yet");
 
         for (let i = 0; i < ids.length; i++) {
             const id = ids[i];
@@ -305,9 +343,7 @@ export function useBuildNavigationController<EC extends EntityCollection, UserTy
         []);
 
     const resolveAliasesFrom = useCallback((path: string): string => {
-        const collections = collectionsRef.current;
-        if (!collections)
-            throw Error("Collections have not been initialised yet");
+        const collections = collectionsRef.current ?? [];
         return resolveCollectionPathIds(path, collections);
     }, []);
 
@@ -410,7 +446,7 @@ async function resolveCollections(collections: undefined | EntityCollection[] |
                                   collectionPermissions: PermissionsBuilder | undefined,
                                   authController: AuthController,
                                   dataSource: DataSourceDelegate,
-                                  injectCollections?: (collections: EntityCollection[]) => EntityCollection[]) {
+                                  injectCollections?: (collections: EntityCollection[]) => EntityCollection[]): Promise<EntityCollection[]> {
     let resolvedCollections: EntityCollection[] = [];
     if (typeof collections === "function") {
         resolvedCollections = await collections({
@@ -422,14 +458,14 @@ async function resolveCollections(collections: undefined | EntityCollection[] |
         resolvedCollections = collections;
     }
 
-    resolvedCollections = applyPermissionsFunctionIfEmpty(resolvedCollections, collectionPermissions);
-
-    resolvedCollections = filterOutNotAllowedCollections(resolvedCollections, authController);
-
     if (injectCollections) {
         resolvedCollections = injectCollections(resolvedCollections ?? []);
     }
 
+    resolvedCollections = applyPermissionsFunctionIfEmpty(resolvedCollections, collectionPermissions);
+
+    resolvedCollections = filterOutNotAllowedCollections(resolvedCollections, authController);
+
     return resolvedCollections;
 }
 
@@ -454,3 +490,29 @@ function getGroup(collectionOrView: EntityCollection<any, any> | CMSView) {
     }
     return trimmed ?? "Views";
 }
+
+function areCollectionListsEqual(a: EntityCollection[], b: EntityCollection[]) {
+    if (a.length !== b.length) {
+        return false;
+    }
+    const aCopy = [...a];
+    const bCopy = [...b];
+    const aSorted = aCopy.sort((x, y) => x.id.localeCompare(y.id));
+    const bSorted = bCopy.sort((x, y) => x.id.localeCompare(y.id));
+    return aSorted.every((value, index) => areCollectionsEqual(value, bSorted[index]));
+}
+
+function areCollectionsEqual(a: EntityCollection, b: EntityCollection) {
+    const {
+        subcollections: subcollectionsA,
+        ...restA
+    } = a;
+    const {
+        subcollections: subcollectionsB,
+        ...restB
+    } = b;
+    if (!areCollectionListsEqual(subcollectionsA ?? [], subcollectionsB ?? [])) {
+        return false;
+    }
+    return equal(removeFunctions(restA), removeFunctions(restB));
+}

package/src/hooks/useProjectLog.tsx

@@ -1,5 +1,5 @@
 import { useEffect, useRef, useState } from "react";
-import { AuthController, FireCMSPlugin } from "../types";
+import { AuthController, DataSourceDelegate, FireCMSPlugin } from "../types";
 
 export const DEFAULT_SERVER_DEV = "https://api-kdoe6pj3qq-ey.a.run.app";
 export const DEFAULT_SERVER = "https://api-drplyi3b6q-ey.a.run.app";
@@ -9,17 +9,26 @@ export type AccessResponse = {
     message?: string;
 }
 
-async function makeRequest(authController: AuthController, pluginKeys: string | undefined) {
-    const firebaseToken = await authController.getAuthToken();
+async function makeRequest(authController: AuthController, dataSourceKey: string, pluginKeys: string[] | undefined) {
+    let idToken: string | null;
+    try {
+        idToken = await authController.getAuthToken();
+    } catch (e) {
+        idToken = null;
+    }
     return fetch(DEFAULT_SERVER + "/access_log",
         {
             // mode: "no-cors",
             method: "POST",
             headers: {
                 "Content-Type": "application/json",
-                Authorization: `Basic ${firebaseToken}`,
+                Authorization: `Basic ${idToken}`
             },
-            body: JSON.stringify({ plugins: pluginKeys })
+            body: JSON.stringify({
+                email: authController.user?.email ?? null,
+                datasource: dataSourceKey,
+                plugins: pluginKeys
+            })
         })
         .then(async (res) => {
             return res.json();
@@ -27,15 +36,17 @@ async function makeRequest(authController: AuthController, pluginKeys: string |
 }
 
 export function useProjectLog(authController: AuthController,
+                              dataSourceDelegate: DataSourceDelegate,
                               plugins?: FireCMSPlugin<any, any, any>[]): AccessResponse | null {
     const [accessResponse, setAccessResponse] = useState<AccessResponse | null>(null);
     const accessedUserRef = useRef<string | null>(null);
-    const pluginKeys = plugins?.map(plugin => plugin.key).join(",");
+    const dataSourceKey = dataSourceDelegate.key;
+    const pluginKeys = plugins?.map(plugin => plugin.key);
     useEffect(() => {
         if (authController.user && authController.user.uid !== accessedUserRef.current && !authController.initialLoading) {
-            makeRequest(authController, pluginKeys).then(setAccessResponse);
+            makeRequest(authController, dataSourceKey, pluginKeys).then(setAccessResponse);
             accessedUserRef.current = authController.user.uid;
         }
-    }, [authController]);
+    }, [authController, dataSourceKey, pluginKeys]);
     return accessResponse;
 }

package/src/hooks/useResolvedNavigationFrom.tsx

@@ -80,7 +80,7 @@ export function resolveNavigationFrom<M extends Record<string, any>, UserType ex
             if (entry.type === "collection") {
                 return Promise.resolve(entry);
             } else if (entry.type === "entity") {
-                const collection = navigation.getCollection(entry.path, entry.entityId);
+                const collection = navigation.getCollection(entry.path);
                 if (!collection) {
                     throw Error(`No collection defined in the navigation for the entity with path ${entry.path}`);
                 }

package/src/hooks/useValidateAuthenticator.tsx

@@ -1,43 +1,38 @@
 import { useCallback, useEffect, useRef, useState } from "react";
 import equal from "react-fast-compare";
 
-import { AppCheckTokenResult, AuthController, Authenticator, DataSourceDelegate, StorageSource, User } from "../index";
+import { AuthController, Authenticator, DataSourceDelegate, StorageSource, User } from "../index";
 
 /**
  * This hook is used internally for validating an authenticator.
  *
  * @param authController
  * @param authentication
- * @param getAppCheckToken
- * @param appCheckForceRefresh
  * @param storageSource
- * @param dataSource
+ * @param dataSourceDelegate
  */
-export function useValidateAuthenticator<UserType extends User = User, Controller extends AuthController<UserType> = AuthController<UserType>>({
-                                                                           disabled,
-                                                                           authController,
-                                                                           authentication,
-                                                                           getAppCheckToken,
-                                                                           appCheckForceRefresh = false,
-                                                                           storageSource,
-                                                                           dataSourceDelegate
-                                                                       }:
-                                                                           {
-                                                                               disabled?: boolean,
-                                                                               authController: Controller,
-                                                                               authentication?: boolean | Authenticator<UserType, Controller>,
-                                                                               getAppCheckToken?: (forceRefresh: boolean) => Promise<AppCheckTokenResult> | undefined,
-                                                                               appCheckForceRefresh?: boolean,
-                                                                               dataSourceDelegate: DataSourceDelegate;
-                                                                               storageSource: StorageSource;
-                                                                           }): {
+export function useValidateAuthenticator<UserType extends User = User, Controller extends AuthController<UserType> = AuthController<UserType>>
+({
+     disabled,
+     authController,
+     authenticator,
+     storageSource,
+     dataSourceDelegate
+ }:
+     {
+         disabled?: boolean,
+         authController: Controller,
+         authenticator?: boolean | Authenticator<UserType, Controller>,
+         dataSourceDelegate: DataSourceDelegate;
+         storageSource: StorageSource;
+     }): {
     canAccessMainView: boolean,
     authLoading: boolean,
     notAllowedError: any,
     authVerified: boolean,
 } {
 
-    const authenticationEnabled = Boolean(authentication);
+    const authenticationEnabled = Boolean(authenticator);
 
     const [authLoading, setAuthLoading] = useState<boolean>(authenticationEnabled);
     const [notAllowedError, setNotAllowedError] = useState<any>(false);
@@ -76,26 +71,11 @@ export function useValidateAuthenticator<UserType extends User = User, Controlle
         }
 
         const delegateUser = authController.user;
-        console.debug("Checking authentication for user", delegateUser);
 
-        if (getAppCheckToken) {
-            try {
-                if (!await getAppCheckToken(appCheckForceRefresh)) {
-                    setNotAllowedError("App Check failed.");
-                    authController.signOut();
-                } else {
-                    console.debug("App Check success.");
-                }
-            } catch (e: any) {
-                setNotAllowedError(e.message);
-                authController.signOut();
-            }
-        }
-
-        if (authentication instanceof Function && delegateUser && !equal(checkedUserRef.current?.uid, delegateUser.uid)) {
+        if (authenticator instanceof Function && delegateUser && !equal(checkedUserRef.current?.uid, delegateUser.uid)) {
             setAuthLoading(true);
             try {
-                const allowed = await authentication({
+                const allowed = await authenticator({
                     user: delegateUser,
                     authController,
                     dataSourceDelegate,
@@ -120,7 +100,7 @@ export function useValidateAuthenticator<UserType extends User = User, Controlle
             setAuthVerified(true);
         }
 
-    }, [disabled, authController, authentication, getAppCheckToken, appCheckForceRefresh, dataSourceDelegate, storageSource]);
+    }, [disabled, authController, authenticator, dataSourceDelegate, storageSource]);
 
     useEffect(() => {
         checkAuthentication();

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./core";
+export * from "./app";
 export * from "./types";
 export * from "./form";
 export * from "./preview";