@rebasepro/cms 0.17.3 → 0.18.0

package/src/hooks/navigation/useAsyncResolver.ts

@@ -1,100 +0,0 @@
-import { useCallback, useEffect, useRef, useState, useMemo } from "react";
-
-export type UseAsyncResolverResult<T> = {
-    data: T;
-    loading: boolean;
-    error: Error | undefined;
-    refresh: () => void;
-};
-
-/**
- * Generic hook that resolves an async value with loading/error/refresh
- * state management, cancellation on unmount or deps change, and
- * ref-based change detection to prevent unnecessary state updates.
- *
- * Extracted from the common pattern in useResolvedCollections and
- * useResolvedViews.
- */
-export function useAsyncResolver<T>({
-    resolver,
-    initialValue,
-    isEqual,
-    deps,
-    disabled,
-}: {
-    /** Async function that resolves the data */
-    resolver: () => Promise<T>;
-    /** Initial value before first resolution */
-    initialValue: T;
-    /** Equality check to prevent unnecessary state updates */
-    isEqual: (a: T, b: T) => boolean;
-    /** Effect dependencies — when these change, resolver re-runs */
-    deps: React.DependencyList;
-    /** When true, skip resolution */
-    disabled?: boolean;
-}): UseAsyncResolverResult<T> {
-
-    const [data, setData] = useState<T>(initialValue);
-    const [loading, setLoading] = useState(true);
-    const [error, setError] = useState<Error | undefined>(undefined);
-    const [refreshTrigger, setRefreshTrigger] = useState(0);
-
-    const refresh = useCallback(() => {
-        setRefreshTrigger(prev => prev + 1);
-    }, []);
-
-    // Ref for change detection — avoids state updates when data hasn't changed
-    const dataRef = useRef<T>(initialValue);
-
-    // Store resolver in a ref so we always call the latest version
-    // without adding it to effect deps (it's typically a new closure each render)
-    const resolverRef = useRef(resolver);
-    resolverRef.current = resolver;
-
-    // Same for isEqual
-    const isEqualRef = useRef(isEqual);
-    isEqualRef.current = isEqual;
-
-    useEffect(() => {
-        if (disabled) return;
-
-        let cancelled = false;
-
-        (async () => {
-            try {
-                const result = await resolverRef.current();
-
-                if (cancelled) return;
-
-                // Only update state if data actually changed
-                if (!isEqualRef.current(dataRef.current, result)) {
-                    dataRef.current = result;
-                    setData(result);
-                }
-
-                setError(undefined);
-            } catch (e) {
-                if (!cancelled) {
-                    console.error(e);
-                    setError(e as Error);
-                }
-            } finally {
-                if (!cancelled) {
-                    setLoading(false);
-                }
-            }
-        })();
-
-        return () => {
-            cancelled = true;
-        };
-        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, [...deps, refreshTrigger, disabled]);
-
-    return useMemo(() => ({
-        data,
-        loading,
-        error,
-        refresh
-    }), [data, loading, error, refresh]);
-}

package/src/hooks/navigation/useBuildCollectionRegistryController.tsx

@@ -1,218 +0,0 @@
-import type { DataSourceDefinition } from "@rebasepro/types";
-import { useCallback, useEffect, useRef, useState, useMemo } from "react";
-import { CollectionRegistry, getSubcollections } from "@rebasepro/common";
-import { getParentReferencesFromPath as commonGetParentReferencesFromPath, removeInitialAndTrailingSlashes } from "@rebasepro/app";
-import { EntityReference, CollectionRegistryController } from "@rebasepro/types";
-import { UserConfigurationPersistence, resolveAdminCollection, AdminCollection } from "@rebasepro/cms-types";
-import { mergeDeep } from "@rebasepro/utils";
-
-export function useBuildCollectionRegistryController(props: {
-    userConfigPersistence?: UserConfigurationPersistence,
-    dataSources?: Record<string, DataSourceDefinition>
-}): CollectionRegistryController & {
-    collectionRegistryRef: React.MutableRefObject<CollectionRegistry>;
-} {
-    const { userConfigPersistence, dataSources } = props;
-    const collectionRegistryRef = useRef<CollectionRegistry>(new CollectionRegistry(undefined, dataSources));
-    // Keep the registry's data sources in sync (used to resolve engine during
-    // normalization). Applied synchronously before the async registration
-    // effect in useResolvedCollections runs.
-    if (dataSources) collectionRegistryRef.current.setDataSources(dataSources);
-    const [initialised, setInitialised] = useState(false);
-
-    const getCollection = useCallback((
-        slugOrPath: string,
-        includeUserOverride = false
-    ): AdminCollection | undefined => {
-
-        const registry = collectionRegistryRef.current;
-
-        const cleanedPath = removeInitialAndTrailingSlashes(slugOrPath);
-        if (!cleanedPath) return undefined;
-
-        const pathSegments = cleanedPath.split("/");
-
-        let collectionPath = pathSegments.join("/");
-        // If the path has an even number of segments, it points to a entity, so we get the parent collection
-        if (pathSegments.length > 0 && pathSegments.length % 2 === 0) {
-            collectionPath = pathSegments.slice(0, -1).join("/");
-        }
-
-        if (!collectionPath) return undefined;
-
-        let collection: AdminCollection | undefined;
-
-        // An exact slug match first, because a slug is allowed to contain
-        // slashes and several drivers need it to: a Firestore collection
-        // partitioned by locale is declared as `content/de-DE/podcasts`, and
-        // that string is its *name*, not a path to walk.
-        //
-        // Without this, such a slug went straight to `resolvePathToCollections`,
-        // which reads any `a/b/c` as collection/entity/subcollection, looked for
-        // a root collection called `content`, found none and threw — and the
-        // catch below turned that into `undefined`. `RebaseRoute` renders
-        // `null` for an unresolved collection, so the whole view came out blank
-        // with nothing in the console above `debug`. Thirty-five collections in
-        // one app were unreachable that way.
-        // `collectionPath`, not `cleanedPath`: an even segment count means the
-        // path ends at a record, and the id has already been trimmed off above.
-        // Matching the raw path instead would only ever hit for a collection
-        // route, leaving `content/de-DE/podcasts/abc123` back on the walker.
-        collection = registry.get(collectionPath) as AdminCollection | undefined;
-
-        if (!collection) {
-            try {
-                collection = registry.resolvePathToCollections(collectionPath).finalCollection;
-            } catch (e) {
-                // Warn, not debug. An unresolved collection ends as a route with
-                // nothing in it, and at `debug` there was no way to tell that
-                // from a collection that legitimately has no rows.
-                console.warn(`[rebase] Could not resolve a collection for "${collectionPath}"`, e);
-                return undefined;
-            }
-        }
-
-        if (!collection) {
-            return undefined;
-        }
-
-        const userOverride = includeUserOverride ? userConfigPersistence?.getCollectionConfig(slugOrPath) : undefined;
-        const overriddenCollection = collection ? mergeDeep(collection, userOverride ?? {}) : undefined;
-
-        if (!overriddenCollection) return undefined;
-
-        let result: Partial<AdminCollection> | undefined = overriddenCollection;
-        const subcollections = "subcollections" in overriddenCollection ? overriddenCollection.subcollections : undefined;
-        const callbacks = overriddenCollection.callbacks;
-        result = {
-            ...result,
-            callbacks: result?.callbacks ?? callbacks
-        };
-        // Preserve subcollections if they exist
-        if (subcollections && "subcollections" in result) {
-            (result as Record<string, unknown>).subcollections = (result as Record<string, unknown>).subcollections ?? subcollections;
-        }
-
-        // Flatten the admin block: everything downstream of here is the panel's
-        // view model, not the authoring shape. Applied after the user-override
-        // merge so an override of a presentation field still wins.
-        return resolveAdminCollection({ ...overriddenCollection,
-...result } as AdminCollection);
-
-    }, [userConfigPersistence]);
-
-    const getRawCollection = useCallback((slugOrPath: string): AdminCollection | undefined => {
-        const registry = collectionRegistryRef.current;
-        if (registry === undefined) return undefined;
-
-        const cleanedPath = removeInitialAndTrailingSlashes(slugOrPath);
-        if (!cleanedPath) return undefined;
-
-        const pathSegments = cleanedPath.split("/");
-
-        return registry.getRaw(pathSegments.join("/")) as AdminCollection | undefined;
-    }, []);
-
-    const getParentReferencesFromPath = useCallback((path: string): EntityReference[] => {
-        const registry = collectionRegistryRef.current;
-        if (!registry) {
-            return [];
-        }
-        const cleanedPath = removeInitialAndTrailingSlashes(path);
-        const pathSegments = cleanedPath.split("/");
-
-        return commonGetParentReferencesFromPath({
-            path: pathSegments.join("/"),
-            collections: registry.getCollections()
-        });
-    }, []);
-
-    const getParentCollectionSlugs = useCallback((path: string): string[] => {
-        const registry = collectionRegistryRef.current;
-        if (!registry) {
-            return [];
-        }
-        const cleanedPath = removeInitialAndTrailingSlashes(path);
-        const strings = cleanedPath.split("/");
-        const oddPathSegments = strings.filter((_, i) => i % 2 === 0);
-        oddPathSegments.pop();
-
-        const result: string[][] = [];
-
-        for (let i = 1; i <= oddPathSegments.length; i++) {
-            result.push(oddPathSegments.slice(0, i));
-        }
-
-        const getCollectionFromPaths = (pathSegments: string[]): AdminCollection | undefined => {
-            if (!pathSegments?.length) return undefined;
-            const testPath = pathSegments.reduce((acc, segment, idx) => {
-                if (idx === 0) return segment;
-                return `${acc}/fake_id/${segment}`;
-            }, "");
-            try {
-                return registry.resolvePathToCollections(testPath).finalCollection;
-            } catch (e) {
-                return undefined;
-            }
-        };
-
-        return result.map(r => getCollectionFromPaths(r)?.slug).filter(Boolean) as string[];
-    }, []);
-
-    const getParentEntityIds = useCallback((path: string): string[] => {
-        const cleanedPath = removeInitialAndTrailingSlashes(path);
-        const strings = cleanedPath.split("/");
-        const evenPathSegments = strings.filter((_, i) => i % 2 !== 0);
-        if (strings.length % 2 === 0) {
-            evenPathSegments.pop();
-        }
-        return evenPathSegments;
-    }, []);
-
-    const convertIdsToPaths = useCallback((ids: string[]): string[] => {
-        const registry = collectionRegistryRef.current;
-        if (!registry) return [];
-        let currentCollections: AdminCollection[] = registry.getCollections();
-        const paths: string[] = [];
-        for (let i = 0; i < ids.length; i++) {
-            const id = ids[i];
-            const collection: AdminCollection | undefined = currentCollections.find(c => c.slug === id);
-            if (!collection)
-                throw Error(`Collection with id ${id} not found`);
-            paths.push(collection.slug);
-            currentCollections = getSubcollections(collection) ?? [];
-        }
-        return paths;
-    }, []);
-
-    const collections = collectionRegistryRef.current.getCollections().map(resolveAdminCollection);
-
-    // Determine initialised automatically based on whether collections exist,
-    // though the NavigationStateController also plays a role in overall init
-    useEffect(() => {
-        if (!initialised && collections.length > 0) {
-            setInitialised(true);
-        }
-    }, [initialised, collections.length]);
-
-    return useMemo(() => ({
-        collections,
-        initialised,
-        getCollection,
-        getRawCollection,
-        getParentReferencesFromPath,
-        getParentCollectionSlugs,
-        getParentEntityIds,
-        convertIdsToPaths,
-        collectionRegistryRef
-    }), [
-        collections,
-        initialised,
-        getCollection,
-        getRawCollection,
-        getParentReferencesFromPath,
-        getParentCollectionSlugs,
-        getParentEntityIds,
-        convertIdsToPaths
-    ]);
-}

package/src/hooks/navigation/useBuildNavigationStateController.tsx

@@ -1,134 +0,0 @@
-
-import type { AppView, NavigationResult, RebasePlugin, NavigationStateController, UrlController, NavigationGroupMapping, AdminCollection } from "@rebasepro/cms-types";
-import { useCallback, useMemo, useRef } from "react";
-
-import { RebaseData, CollectionRegistryController, User } from "@rebasepro/types";
-import { AuthController } from "@rebasepro/cms-types";
-import type { EffectiveRoleController } from "@rebasepro/types";
-import type { CollectionConfigsBuilder, AppViewsBuilder } from "@rebasepro/cms-types";
-import { CollectionRegistry } from "@rebasepro/common";
-
-import { useResolvedCollections } from "./useResolvedCollections";
-import { useResolvedViews } from "./useResolvedViews";
-import { useTopLevelNavigation } from "./useTopLevelNavigation";
-
-export type BuildNavigationStateProps<EC extends AdminCollection, USER extends User> = {
-    authController: AuthController<USER>;
-    collections?: EC[] | CollectionConfigsBuilder<EC>;
-    views?: AppView[] | AppViewsBuilder;
-    adminViews?: AppView[] | AppViewsBuilder;
-    data: RebaseData;
-    plugins?: RebasePlugin[];
-    navigationGroupMappings?: NavigationGroupMapping[];
-    disabled?: boolean;
-    viewsOrder?: string[];
-    collectionRegistryController: CollectionRegistryController<EC> & { collectionRegistryRef: React.MutableRefObject<CollectionRegistry> };
-    urlController: UrlController;
-    adminMode?: "cms" | "studio" | "settings";
-    effectiveRoleController?: EffectiveRoleController;
-
-};
-
-/**
- * Main hook that resolves collections, views, and admin views into a
- * NavigationStateController. This is a thin composition of three focused hooks:
- *
- * - useResolvedCollections: resolves collection props and registers with CollectionRegistry
- * - useResolvedViews: resolves view/admin view props
- * - useTopLevelNavigation: computes the NavigationResult from resolved data
- *
- * The NavigationStateController type is preserved as a public API.
- */
-export function useBuildNavigationStateController<EC extends AdminCollection, USER extends User>(
-    props: BuildNavigationStateProps<EC, USER>
-): NavigationStateController {
-
-    const {
-        authController,
-        collections: collectionsProp,
-        views: viewsProp,
-        adminViews: adminViewsProp,
-        viewsOrder,
-        plugins,
-        data,
-        disabled,
-        navigationGroupMappings,
-        collectionRegistryController,
-        urlController,
-        adminMode = "cms",
-        effectiveRoleController
-    } = props;
-
-    const {
-        collections,
-        loading: collectionsLoading,
-        error: collectionsError,
-        refresh: refreshCollections
-    } = useResolvedCollections({
-        authController,
-        collections: collectionsProp,
-        data,
-        plugins,
-        disabled,
-        collectionRegistryController
-    });
-
-    const {
-        views,
-        adminViews,
-        loading: viewsLoading,
-        error: viewsError,
-        refresh: refreshViews
-    } = useResolvedViews({
-        authController,
-        views: viewsProp,
-        adminViews: adminViewsProp,
-        data,
-        plugins,
-        adminMode,
-        effectiveRoleController
-    });
-
-    // Step 3: Compute top-level navigation (pure derived state)
-    const { topLevelNavigation } = useTopLevelNavigation({
-        collections,
-        views,
-        adminViews,
-        plugins,
-        navigationGroupMappings,
-        viewsOrder,
-        urlController,
-        adminMode,
-        collectionRegistryController
-    });
-
-    // Expose a combined refresh function with microtask batching
-    const pendingRefreshRef = useRef(false);
-    const refreshNavigation = useCallback(() => {
-        if (pendingRefreshRef.current) return;
-        pendingRefreshRef.current = true;
-        queueMicrotask(() => {
-            pendingRefreshRef.current = false;
-            refreshCollections();
-            refreshViews();
-        });
-    }, [refreshCollections, refreshViews]);
-
-    return useMemo(() => ({
-        views,
-        adminViews,
-        topLevelNavigation,
-        loading: collectionsLoading || viewsLoading,
-        navigationLoadingError: collectionsError ?? viewsError,
-        refreshNavigation
-    }), [
-        views,
-        adminViews,
-        topLevelNavigation,
-        collectionsLoading,
-        viewsLoading,
-        collectionsError,
-        viewsError,
-        refreshNavigation
-    ]);
-}

package/src/hooks/navigation/useBuildUrlController.tsx

@@ -1,66 +0,0 @@
-import type { UrlController, NavigateOptions } from "@rebasepro/cms-types";
-import { useCallback, useMemo } from "react";
-import { removeInitialAndTrailingSlashes, resolveCollectionPathIds } from "@rebasepro/app";
-import { CollectionRegistryController } from "@rebasepro/types";
-import { useNavigate } from "react-router";
-
-export function useBuildUrlController(props: {
-    basePath: string,
-    baseCollectionPath: string,
-    collectionRegistryController: CollectionRegistryController
-}): UrlController {
-
-    const { basePath, baseCollectionPath, collectionRegistryController } = props;
-    const navigate = useNavigate();
-
-    const homeUrl = basePath === "/" ? "/" : `/${removeInitialAndTrailingSlashes(basePath)}`;
-
-    const buildUrlCollectionPath = useCallback((path: string): string => {
-        const fullPath = basePath === "/" ? `${baseCollectionPath}/${path}` : `${basePath}${baseCollectionPath}/${path}`;
-        return fullPath.replace(/\/\//g, "/");
-    }, [basePath, baseCollectionPath]);
-
-    const buildAppUrlPath = useCallback((path: string): string => {
-        const fullPath = basePath === "/" ? `/${path}` : `${basePath}/${path}`;
-        return fullPath.replace(/\/\//g, "/");
-    }, [basePath]);
-
-    const urlPathToDataPath = useCallback((cmsPath: string): string => {
-        let path = cmsPath;
-        if (basePath !== "/" && path.startsWith(basePath)) {
-            path = path.replace(basePath, "");
-        }
-        if (path.startsWith(baseCollectionPath)) {
-            path = path.replace(baseCollectionPath, "");
-        }
-        return removeInitialAndTrailingSlashes(path);
-    }, [basePath, baseCollectionPath]);
-
-    const isUrlCollectionPath = useCallback((urlPath: string): boolean => {
-        let path = urlPath;
-        if (basePath !== "/" && path.startsWith(basePath)) {
-            path = path.replace(basePath, "");
-        }
-        return path === baseCollectionPath || path.startsWith(baseCollectionPath + "/");
-    }, [basePath, baseCollectionPath]);
-
-    const resolveDatabasePathsFrom = useCallback((path: string): string => {
-        return resolveCollectionPathIds(path, collectionRegistryController.collections ?? []);
-    }, [collectionRegistryController]);
-
-    const navigateTo = useCallback((to: string, options?: NavigateOptions) => {
-        navigate(to, options);
-    }, [navigate]);
-
-    return useMemo(() => ({
-        basePath,
-        baseCollectionPath,
-        urlPathToDataPath,
-        homeUrl,
-        isUrlCollectionPath,
-        buildUrlCollectionPath,
-        buildAppUrlPath,
-        resolveDatabasePathsFrom,
-        navigate: navigateTo
-    }), [basePath, baseCollectionPath, urlPathToDataPath, homeUrl, isUrlCollectionPath, buildUrlCollectionPath, buildAppUrlPath, resolveDatabasePathsFrom, navigateTo]);
-}