@firecms/core 3.3.0-canary.d3242eb → 3.4.0-canary.00f9be5

package/src/hooks/useBuildNavigationController.tsx

@@ -1,6 +1,8 @@
-import { useCallback, useEffect, useRef, useState } from "react";
+import { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import equal from "react-fast-compare"
 import { useBlocker, useNavigate } from "react-router-dom";
+import { filterPausedPlugins, isProPaused } from "../core/pro_plugins";
+import { useLicenseStatus } from "./useLicenseStatus";
 
 import {
     AuthController,
@@ -22,11 +24,14 @@ import {
 } from "../types";
 import {
     applyPermissionsFunctionIfEmpty,
+    collectionSegmentsFrom,
+    fullPathToCollectionSegments,
     getCollectionByPathOrId,
     mergeDeep,
     removeFunctions,
     removeInitialAndTrailingSlashes,
     resolveCollectionPathIds,
+    resolveCollectionPathSegments,
     resolvePermissions
 } from "../util";
 import { getParentReferencesFromPath } from "../util/parent_references_from_path";
@@ -112,7 +117,7 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
         views: viewsProp,
         adminViews: adminViewsProp,
         viewsOrder,
-        plugins,
+        plugins: allPlugins,
         userConfigPersistence,
         dataSourceDelegate,
         disabled,
@@ -121,6 +126,27 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
 
     const navigate = useNavigate();
 
+    // While PRO is paused, PRO plugins contribute no collections, collection
+    // modifications, views or navigation entries. This hook runs above
+    // `FireCMS`, so the status arrives through the store `FireCMS` publishes to,
+    // and its arrival re-renders this hook, which resolves navigation again.
+    const licenseStatus = useLicenseStatus();
+    const proPaused = isProPaused(licenseStatus);
+    const plugins = useMemo(
+        () => filterPausedPlugins(allPlugins, licenseStatus),
+        [allPlugins, licenseStatus]
+    );
+
+    // Navigation resolves asynchronously, so a resolution started before the
+    // pause changed can finish after one started since. This ref holds the
+    // current pause so the older one is dropped instead of restoring what the
+    // paused plugins contributed. Declared before the effect that refreshes.
+    const proPausedRef = useRef(proPaused);
+    useEffect(() => {
+        proPausedRef.current = proPaused;
+    }, [proPaused]);
+    const resolvedProPausedRef = useRef<boolean | undefined>(undefined);
+
     const collectionsRef = useRef<EntityCollection[] | undefined>(undefined);
     const viewsRef = useRef<CMSView[] | undefined>(undefined);
     const adminViewsRef = useRef<CMSView[] | undefined>(undefined);
@@ -299,7 +325,7 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
             groups: uniqueGroups,
             onNavigationEntriesUpdate: onNavigationEntriesUpdateCallback!,
         };
-    }, [navigationGroupMappings, buildCMSUrlPath, buildUrlCollectionPath, pluginGroups]);
+    }, [navigationGroupMappings, buildCMSUrlPath, buildUrlCollectionPath, pluginGroups, plugins]);
 
     const onNavigationEntriesOrderUpdate = useCallback((entries: NavigationGroupMapping[]) => {
         if (!plugins) {
@@ -339,6 +365,8 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
 
         console.debug("Refreshing navigation");
 
+        const resolvingWhilePaused = proPaused;
+
         try {
 
             const [resolvedCollections = [], resolvedViews, resolvedAdminViews = []] = await Promise.all([
@@ -348,10 +376,21 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
             ]
             );
 
+            // Superseded: a newer resolution runs with the current pause.
+            if (resolvingWhilePaused !== proPausedRef.current)
+                return;
+
             const computedTopLevelNav = computeTopNavigation(resolvedCollections, resolvedViews, resolvedAdminViews, viewsOrder, undefined, onNavigationEntriesOrderUpdate);
 
-            let shouldUpdateTopLevelNav = false;
-            if (!areCollectionListsEqual(collectionsRef.current ?? [], resolvedCollections)) {
+            // When the pause changes, everything below is replaced, including
+            // what the comparisons ignore: they skip functions, and a plugin may
+            // have added only collection callbacks, or only regrouped entries.
+            const pauseChanged = resolvedProPausedRef.current !== undefined
+                && resolvedProPausedRef.current !== resolvingWhilePaused;
+            resolvedProPausedRef.current = resolvingWhilePaused;
+
+            let shouldUpdateTopLevelNav = pauseChanged;
+            if (pauseChanged || !areCollectionListsEqual(collectionsRef.current ?? [], resolvedCollections)) {
                 collectionsRef.current = resolvedCollections;
                 console.debug("Collections have changed", resolvedCollections);
                 shouldUpdateTopLevelNav = true;
@@ -360,7 +399,7 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
                 collectionsRef.current = resolvedCollections;
                 shouldUpdateTopLevelNav = true;
             }
-            if (!equal(viewsRef.current, resolvedViews)) {
+            if (pauseChanged || !equal(viewsRef.current, resolvedViews)) {
                 viewsRef.current = resolvedViews;
                 shouldUpdateTopLevelNav = true;
             }
@@ -397,6 +436,8 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
         viewsProp,
         adminViewsProp,
         computeTopNavigation,
+        plugins,
+        proPaused
     ]);
 
     useEffect(() => {
@@ -405,16 +446,21 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
 
     const getCollection = useCallback((
         idOrPath: string,
-        includeUserOverride = false
+        includeUserOverride = false,
+        pathSegments?: string[]
     ): EC | undefined => {
         const collections = collectionsRef.current;
         if (!collections)
             return undefined;
 
-        const baseCollection = getCollectionByPathOrId(removeInitialAndTrailingSlashes(idOrPath), collections);
+        const baseCollection = getCollectionByPathOrId(removeInitialAndTrailingSlashes(idOrPath), collections, pathSegments);
 
         const userOverride = includeUserOverride ? userConfigPersistence?.getCollectionConfig(idOrPath) : undefined;
-        const overriddenCollection = baseCollection ? mergeDeep(baseCollection, userOverride ?? {}) : undefined;
+        let overriddenCollection = baseCollection;
+        if (baseCollection && userOverride) {
+            const { properties, ...rest } = userOverride;
+            overriddenCollection = mergeDeep(baseCollection, rest);
+        }
 
         let result: Partial<EntityCollection> | undefined = overriddenCollection;
 
@@ -501,23 +547,33 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
         throw Error("Expected path starting with " + fullCollectionPath);
     }, [fullCollectionPath]);
 
-    const resolveIdsFrom = useCallback((path: string): string => {
+    const resolveIdsFrom = useCallback((path: string, pathSegments?: string[]): string => {
+        const collections = collectionsRef.current ?? [];
+        return resolveCollectionPathIds(path, collections, pathSegments);
+    }, []);
+
+    const resolveSegmentsFrom = useCallback((pathSegments: string[]): string[] => {
         const collections = collectionsRef.current ?? [];
-        return resolveCollectionPathIds(path, collections);
+        return resolveCollectionPathSegments(pathSegments, collections);
     }, []);
 
-    const getAllParentReferencesForPath = useCallback((path: string): EntityReference[] => {
+    const getAllParentReferencesForPath = useCallback((path: string, pathSegments?: string[]): EntityReference[] => {
         const collections = collectionsRef.current ?? [];
         return getParentReferencesFromPath({
             path,
+            pathSegments,
             collections
         });
     }, []);
 
-    const getParentCollectionIds = useCallback((path: string): string[] => {
+    const getParentCollectionIds = useCallback((path: string, pathSegments?: string[]): string[] => {
 
-        const strings = path.split("/");
-        const oddPathSegments = strings.filter((_, i) => i % 2 === 0);
+        // Positional filtering only picks out the collection segments while no entity id
+        // contains "/"; with one, every following segment shifts. Given the real boundaries
+        // the same rule applies correctly; without them this is the historical reading.
+        const oddPathSegments = pathSegments
+            ? collectionSegmentsFrom(pathSegments)
+            : fullPathToCollectionSegments(path);
         oddPathSegments.pop();
 
         const result: string[][] = [];
@@ -563,13 +619,16 @@ export function useBuildNavigationController<EC extends EntityCollection, USER e
         urlPathToDataPath,
         buildUrlCollectionPath,
         resolveIdsFrom,
+        resolveSegmentsFrom,
         topLevelNavigation,
         refreshNavigation,
         getParentReferencesFromPath: getAllParentReferencesForPath,
         getParentCollectionIds,
         convertIdsToPaths,
         navigate,
-        plugins
+        // All of them, paused or not: `FireCMS` sends every key to the license
+        // check and applies the same pause to what it renders.
+        plugins: allPlugins
     };
 }
 

package/src/hooks/useFireCMSContext.tsx

@@ -12,6 +12,7 @@ import { useCustomizationController } from "./useCustomizationController";
 import { useAnalyticsController } from "./useAnalyticsController";
 import React, { useEffect } from "react";
 import { useInternalUserManagementController } from "./useInternalUserManagementController";
+import { useLicenseStatus } from "./useLicenseStatus";
 
 /**
  * Hook to retrieve the {@link FireCMSContext}.
@@ -36,6 +37,7 @@ export const useFireCMSContext = <USER extends User = User, AuthControllerType e
     const customizationController = useCustomizationController();
     const analyticsController = useAnalyticsController();
     const userManagement = useInternalUserManagementController<USER>();
+    const licenseStatus = useLicenseStatus();
 
     const fireCMSContextRef = React.useRef<FireCMSContext<USER, AuthControllerType>>({
         authController,
@@ -49,7 +51,8 @@ export const useFireCMSContext = <USER extends User = User, AuthControllerType e
         dialogsController,
         customizationController,
         analyticsController,
-        userManagement
+        userManagement,
+        licenseStatus
     });
 
     useEffect(() => {
@@ -65,9 +68,10 @@ export const useFireCMSContext = <USER extends User = User, AuthControllerType e
             dialogsController,
             customizationController,
             analyticsController,
-            userManagement
+            userManagement,
+            licenseStatus
         };
-    }, [authController, dialogsController, navigation, sideDialogsController]);
+    }, [authController, dialogsController, navigation, sideDialogsController, licenseStatus]);
 
     return fireCMSContextRef.current;
 }

package/src/hooks/useLicenseStatus.tsx

@@ -0,0 +1,32 @@
+import { useContext, useSyncExternalStore } from "react";
+import { AccessResponse } from "../types";
+import {
+    getLicenseStatusSnapshot,
+    getServerLicenseStatusSnapshot,
+    LicenseStatusContext,
+    subscribeLicenseStatus
+} from "../contexts/LicenseStatusContext";
+
+/**
+ * The FireCMS license status of this project: whether PRO runs on a trial, is
+ * licensed, or is paused, plus the link to get a license.
+ *
+ * `null` until the license check answers, and when it is not sent at all
+ * (`telemetry={false}` without an `apiKey`). A response from an older server
+ * may lack `licenseState`; treat that as unknown. PRO features are paused when
+ * `blocked` is true; use `isProPaused(status)` for that check.
+ *
+ * Works inside `FireCMS` and also above it, e.g. in the component that calls
+ * `useBuildNavigationController`.
+ *
+ * @group Hooks and utilities
+ */
+export function useLicenseStatus(): AccessResponse | null {
+    const fromContext = useContext(LicenseStatusContext);
+    const published = useSyncExternalStore(
+        subscribeLicenseStatus,
+        getLicenseStatusSnapshot,
+        getServerLicenseStatusSnapshot
+    );
+    return fromContext !== undefined ? fromContext : published;
+}

package/src/hooks/useProjectLog.tsx

@@ -1,14 +1,10 @@
 import { useEffect, useRef, useState } from "react";
-import { AuthController, DataSourceDelegate, FireCMSPlugin } from "../types";
+import { AccessResponse, AuthController, DataSourceDelegate, FireCMSPlugin } from "../types";
+import { PRO_PLUGIN_KEYS } from "../core/pro_plugins";
 
 export const DEFAULT_SERVER_DEV = "https://api-kdoe6pj3qq-ey.a.run.app";
 export const DEFAULT_SERVER = "https://api.firecms.co";
 
-export type AccessResponse = {
-    blocked?: boolean;
-    message?: string;
-}
-
 async function makeRequest(authController: AuthController, dataSourceKey: string, pluginKeys: string[] | undefined, apiKey?: string): Promise<AccessResponse> {
     let idToken: string | null;
     try {
@@ -40,24 +36,46 @@ export interface UseProjectLogParams {
     apiKey?: string;
     authController: AuthController;
     dataSourceDelegate: DataSourceDelegate;
+    /**
+     * Every plugin the app mounts, before any are paused: the server decides
+     * from these keys whether the project needs a license.
+     */
     plugins?: FireCMSPlugin<any, any, any>[];
+    /**
+     * When false, no request is sent, unless the request is a license check:
+     * with an `apiKey`, or with a PRO plugin mounted, it is always sent.
+     */
+    telemetry?: boolean;
 }
 
 export function useProjectLog({
                                   authController,
                                   dataSourceDelegate,
                                   plugins,
-                                  apiKey
+                                  apiKey,
+                                  telemetry = true
                               }: UseProjectLogParams): AccessResponse | null {
     const [accessResponse, setAccessResponse] = useState<AccessResponse | null>(null);
     const accessedUserRef = useRef<string | null>(null);
     const dataSourceKey = dataSourceDelegate.key;
     const pluginKeys = plugins?.map(plugin => plugin.key);
+    // Opting out is for apps without PRO plugins. With one mounted, the
+    // request is what starts the trial and pauses PRO when it ends, so
+    // skipping it would unlock PRO for good.
+    const runsProPlugin = (pluginKeys ?? []).some(key => PRO_PLUGIN_KEYS.includes(key));
+    const enabled = Boolean(apiKey) || runsProPlugin || telemetry !== false;
     useEffect(() => {
+        if (!enabled) return;
         if (authController.user && authController.user.uid !== accessedUserRef.current && !authController.initialLoading) {
-            makeRequest(authController, dataSourceKey, pluginKeys, apiKey).then(setAccessResponse);
+            makeRequest(authController, dataSourceKey, pluginKeys, apiKey)
+                .then((response) => setAccessResponse(response && typeof response === "object" ? response : null))
+                .catch((error) => {
+                    // The check never gates the CMS, so a failed one only
+                    // leaves the license status unknown.
+                    console.debug("FireCMS license check failed", error);
+                });
             accessedUserRef.current = authController.user.uid;
         }
-    }, [authController, dataSourceKey, pluginKeys]);
+    }, [authController, dataSourceKey, pluginKeys, enabled]);
     return accessResponse;
 }

package/src/hooks/useResolvedNavigationFrom.tsx

@@ -80,12 +80,14 @@ export function resolveNavigationFrom<M extends Record<string, any>, USER extend
             if (entry.type === "collection") {
                 return Promise.resolve(entry);
             } else if (entry.type === "entity") {
-                const collection = navigation.getCollection(entry.path);
+                const collection = navigation.getCollection(entry.path, false, entry.pathSegments);
                 if (!collection) {
                     throw Error(`No collection defined in the navigation for the entity with path ${entry.path}`);
                 }
                 return dataSource.fetchEntity({
                     path: entry.path,
+                    // The navigation entry already knows the real segment boundaries.
+                    pathSegments: entry.pathSegments,
                     entityId: entry.entityId,
                     collection
                 })

package/src/hooks/useTranslation.ts

@@ -23,8 +23,10 @@ export function useTranslation() {
      * Also supports i18next interpolation variables, e.g.
      *   t("add_to_field", { fieldName: "Tags" })
      *   t("error_deleting", { message: err.message })
+     * Pass `count` as a number to pick a plural form (`key_one`, falling back
+     * to `key`); i18next ignores a string `count`.
      */
-    const typedT = (key: string, vars?: Record<string, string>): string =>
+    const typedT = (key: string, vars?: Record<string, string | number>): string =>
         t(key, vars) as string;
 
     return { t: typedT, i18n };

package/src/hooks/useValidateAuthenticator.tsx

@@ -74,6 +74,10 @@ export function useValidateAuthenticator<USER extends User = any>
 
         if (authenticator instanceof Function && delegateUser && !equal(checkedUserRef.current?.uid, delegateUser.uid)) {
             setAuthLoading(true);
+            // Reset the error of any previous authentication attempt. Otherwise, a
+            // rejected user would keep `canAccessMainView` to false for every user
+            // logging in afterwards, locking them out of the CMS until a page reload.
+            setNotAllowedError(false);
             try {
                 const allowed = await authenticator({
                     user: delegateUser,