@rebasepro/cms 0.17.3 → 0.18.0

package/src/hooks/navigation/useTopLevelNavigation.ts

@@ -1,273 +0,0 @@
-
-import type { AppView, UrlController, RebasePlugin, NavigationEntry, NavigationGroupMapping, NavigationResult, AdminCollection } from "@rebasepro/cms-types";
-import { useCallback, useMemo, useRef } from "react";
-import { deepEqual as equal } from "fast-equals";
-
-import { CollectionRegistryController } from "@rebasepro/types";
-import { CollectionRegistry } from "@rebasepro/common";
-
-import { computeNavigationGroups, getGroup, isBottomPinnedGroupName, NAVIGATION_ADMIN_GROUP_NAME, NAVIGATION_DEFAULT_GROUP_NAME } from "./utils";
-
-export type UseTopLevelNavigationProps = {
-    collections: AdminCollection[];
-    views: AppView[] | undefined;
-    adminViews: AppView[] | undefined;
-    plugins?: RebasePlugin[];
-    navigationGroupMappings?: NavigationGroupMapping[];
-    viewsOrder?: string[];
-    urlController: UrlController;
-    adminMode?: "cms" | "studio" | "settings";
-    collectionRegistryController: CollectionRegistryController & { collectionRegistryRef: React.MutableRefObject<CollectionRegistry> };
-};
-
-export type UseTopLevelNavigationResult = {
-    topLevelNavigation: NavigationResult | undefined;
-};
-
-/**
- * Hook that computes the top-level NavigationResult from resolved collections,
- * views, and admin views. Pure computation — no async, no effects.
- *
- * The `onNavigationEntriesUpdate` callback is embedded in the result for API
- * compatibility, but its reference is stable via useCallback.
- */
-export function useTopLevelNavigation(
-    props: UseTopLevelNavigationProps
-): UseTopLevelNavigationResult {
-
-    const {
-        collections,
-        views,
-        adminViews,
-        plugins,
-        navigationGroupMappings,
-        viewsOrder,
-        urlController,
-        adminMode,
-        collectionRegistryController
-    } = props;
-
-    const pluginGroups = useMemo(() => {
-        const allPluginGroups = plugins?.flatMap(plugin => plugin.hooks?.navigationEntries ? plugin.hooks.navigationEntries.map(e => e.name) : []) ?? [];
-        return [...new Set(allPluginGroups)];
-    }, [plugins]);
-
-    // Stable reference to the drag-and-drop update callback.
-    // We use a ref-based approach internally so the callback identity doesn't
-    // change when collections/views change (which would cause NavigationResult
-    // equality to always fail).
-    const onNavigationEntriesOrderUpdate = useCallback((entries: NavigationGroupMapping[]) => {
-        if (!plugins) {
-            return;
-        }
-        // remove all groups that have no entries
-        const filteredEntries = entries.filter(entry => entry.entries.length > 0);
-
-        // Persist to backend via plugins
-        if (plugins.some((plugin: RebasePlugin) => plugin.hooks?.onNavigationEntriesUpdate)) {
-            plugins.forEach((plugin: RebasePlugin) => {
-                if (plugin.hooks?.onNavigationEntriesUpdate) {
-                    plugin.hooks.onNavigationEntriesUpdate(filteredEntries);
-                }
-            });
-        }
-    }, [plugins]);
-
-    const topLevelNavigationRef = useRef<NavigationResult | undefined>(undefined);
-
-    const topLevelNavigation = useMemo(() => {
-        // Don't compute until we have collections and views resolved
-        if (!views && !adminViews && collections.length === 0) {
-            return undefined;
-        }
-
-        const finalNavigationGroupMappings: NavigationGroupMapping[] = computeNavigationGroups({
-            navigationGroupMappings,
-            collections,
-            views: views,
-            plugins
-        });
-
-        const allPluginNavigationEntries = finalNavigationGroupMappings.map((g) => g.entries).flat() ?? [];
-        const navigationEntriesOrder = ([...new Set(allPluginNavigationEntries)]);
-
-        let navigationEntries: NavigationEntry[] = [
-            ...(collections ?? []).reduce((acc, collection) => {
-                if (collection.hideFromNavigation) return acc;
-
-                const pathKey = collection.slug;
-                let groupName = getGroup(collection);
-
-                if (finalNavigationGroupMappings) {
-                    for (const pluginGroupDef of finalNavigationGroupMappings) {
-                        if (pluginGroupDef.entries.includes(pathKey)) {
-                            groupName = pluginGroupDef.name;
-                            break;
-                        }
-                    }
-                }
-
-                acc.push({
-                    id: `collection:${pathKey}`,
-                    url: urlController.buildUrlCollectionPath(pathKey),
-                    type: "collection",
-                    name: collection.name.trim(),
-                    slug: pathKey,
-                    collection,
-                    description: collection.description?.trim(),
-                    group: groupName ?? NAVIGATION_DEFAULT_GROUP_NAME
-                });
-                return acc;
-            }, [] as NavigationEntry[]),
-
-            ...(views ?? []).reduce((acc, view) => {
-                if (view.hideFromNavigation) return acc;
-
-                const pathKey = view.slug;
-                let groupName = getGroup(view);
-
-                if (finalNavigationGroupMappings) {
-                    for (const pluginGroupDef of finalNavigationGroupMappings) {
-                        if (pluginGroupDef.entries.includes(pathKey)) {
-                            groupName = pluginGroupDef.name;
-                            break;
-                        }
-                    }
-                }
-
-                const basePathKey = Array.isArray(pathKey) ? pathKey[0] : pathKey;
-                acc.push({
-                    id: `view:${pathKey}`,
-                    url: urlController.buildAppUrlPath(basePathKey),
-                    name: view.name.trim(),
-                    type: "view",
-                    slug: view.slug,
-                    view,
-                    description: view.description?.trim(),
-                    group: groupName ?? NAVIGATION_DEFAULT_GROUP_NAME
-                });
-                return acc;
-            }, [] as NavigationEntry[]),
-
-            ...(adminViews ?? []).reduce((acc, adminView) => {
-                if (adminView.hideFromNavigation) return acc;
-
-                const pathKey = adminView.slug;
-                let groupName = adminView.group?.trim() || NAVIGATION_ADMIN_GROUP_NAME;
-
-                if (finalNavigationGroupMappings) {
-                    for (const pluginGroupDef of finalNavigationGroupMappings) {
-                        if (pluginGroupDef.entries.includes(pathKey)) {
-                            groupName = pluginGroupDef.name;
-                            break;
-                        }
-                    }
-                }
-
-                acc.push({
-                    id: `admin:${pathKey}`,
-                    url: urlController.buildAppUrlPath(pathKey),
-                    name: adminView.name.trim(),
-                    type: "admin",
-                    slug: adminView.slug,
-                    view: adminView,
-                    description: adminView.description?.trim(),
-                    group: groupName
-                });
-                return acc;
-            }, [] as NavigationEntry[])
-        ];
-
-        // Groups that sink to the bottom. Two sources, because the string
-        // comparison predates the flag and apps depend on it: the names in
-        // `NAVIGATION_BOTTOM_GROUP_NAMES`, and any group holding a view that
-        // asked for it — which is the only one of the two that survives the
-        // group being renamed or translated.
-        const pinnedGroups = new Set<string>();
-        for (const view of [...(views ?? []), ...(adminViews ?? [])]) {
-            if (view.pinToBottom) pinnedGroups.add(getGroup(view));
-        }
-
-        const groupOrderValue = (groupName?: string): number =>
-            (isBottomPinnedGroupName(groupName) || (groupName !== undefined && pinnedGroups.has(groupName))) ? 1 : 0;
-
-        const usedViewsOrder = viewsOrder ?? navigationEntriesOrder;
-        navigationEntries = navigationEntries.sort((a, b) => {
-            // Primary: group priority (admin/settings last)
-            const groupDiff = groupOrderValue(a.group) - groupOrderValue(b.group);
-            if (groupDiff !== 0) return groupDiff;
-
-            // Secondary: explicit view order (if provided)
-            if (usedViewsOrder) {
-                const getSortPath = (navEntry: NavigationEntry) => typeof navEntry.slug === "string" ? navEntry.slug : navEntry.slug[0];
-                const aIndex = usedViewsOrder.indexOf(getSortPath(a));
-                const bIndex = usedViewsOrder.indexOf(getSortPath(b));
-                if (aIndex !== -1 || bIndex !== -1) {
-                    if (aIndex === -1) return 1;
-                    if (bIndex === -1) return -1;
-                    return aIndex - bIndex;
-                }
-            }
-
-            return 0;
-        });
-
-        const collectedGroupsFromEntries = navigationEntries
-            .map(e => e.group)
-            .filter(Boolean) as string[];
-
-        const groupsFromMappings = finalNavigationGroupMappings.map(g => g.name);
-        const additionalGroups = collectedGroupsFromEntries.filter(g => !groupsFromMappings.includes(g));
-
-        const allDefinedGroups = [
-            ...(pluginGroups ?? []),
-            ...groupsFromMappings,
-            ...additionalGroups
-        ];
-
-        const uniqueGroupsArray = [...new Set(allDefinedGroups)];
-        // Same rule the entry sort uses — read through `groupOrderValue` rather
-        // than repeated inline, so the drawer's group order and the entries
-        // inside it cannot disagree about which groups are last.
-        const lastGroups = uniqueGroupsArray.filter(g => groupOrderValue(g) === 1);
-        const otherGroups = uniqueGroupsArray.filter(g => groupOrderValue(g) === 0);
-        const uniqueGroups = [...otherGroups, ...lastGroups] as string[];
-
-        const computedTopLevelNav = {
-            allowDragAndDrop: plugins?.some((plugin: RebasePlugin) => plugin.hooks?.allowDragAndDrop) ?? false,
-            navigationEntries,
-            groups: uniqueGroups,
-            onNavigationEntriesUpdate: onNavigationEntriesOrderUpdate
-        };
-
-        // Cache the newly computed navigation result and return the cached reference
-        // if it is deeply equal to the previous one, to prevent reference churn.
-        const isNavEqual = topLevelNavigationRef.current &&
-            equal(topLevelNavigationRef.current.navigationEntries, computedTopLevelNav.navigationEntries) &&
-            equal(topLevelNavigationRef.current.groups, computedTopLevelNav.groups) &&
-            topLevelNavigationRef.current.allowDragAndDrop === computedTopLevelNav.allowDragAndDrop;
-
-        if (isNavEqual) {
-            return topLevelNavigationRef.current;
-        }
-
-        topLevelNavigationRef.current = computedTopLevelNav;
-        return computedTopLevelNav;
-    }, [
-        collections,
-        views,
-        adminViews,
-        navigationGroupMappings,
-        urlController.buildAppUrlPath,
-        urlController.buildUrlCollectionPath,
-        pluginGroups,
-        plugins,
-        adminMode,
-        viewsOrder,
-        onNavigationEntriesOrderUpdate
-    ]);
-
-    return useMemo(() => ({
-        topLevelNavigation
-    }), [topLevelNavigation]);
-}

package/src/hooks/navigation/utils.ts

@@ -1,200 +0,0 @@
-
-import type { AppView, RebasePlugin, NavigationGroupMapping, AdminCollection } from "@rebasepro/cms-types";
-
-import { getSubcollections } from "@rebasepro/common";
-import { deepEqual as equal } from "fast-equals";
-
-export const NAVIGATION_DEFAULT_GROUP_NAME = "Views";
-export const NAVIGATION_ADMIN_GROUP_NAME = "Admin";
-
-/**
- * Group names that sink to the bottom of the drawer on their name alone.
- *
- * A magic string, and it stays one for compatibility: apps have been relying on
- * `group: "Settings"` landing last since before there was a flag, and taking it
- * away would silently reshuffle their navigation.
- *
- * It is a bad way to ask for the behaviour, though — it is invisible from the
- * `group?: string` type, and it is defeated by the most ordinary edit there is:
- * translating the label. `group: "Ajustes"` is the same group to a reader and a
- * different one to this comparison, so the ordering just quietly stops
- * happening. Set {@link AppView.pinToBottom} instead, which says so.
- */
-export const NAVIGATION_BOTTOM_GROUP_NAMES = ["Admin", "Settings"] as const;
-
-/** Whether a group sinks to the bottom by virtue of its name. @see NAVIGATION_BOTTOM_GROUP_NAMES */
-export function isBottomPinnedGroupName(groupName?: string): boolean {
-    return groupName !== undefined && (NAVIGATION_BOTTOM_GROUP_NAMES as readonly string[]).includes(groupName);
-}
-
-export function getGroup(collectionOrView: AdminCollection | AppView) {
-    const trimmed = collectionOrView.group?.trim();
-    if (!trimmed || trimmed === "") {
-        return NAVIGATION_DEFAULT_GROUP_NAME;
-    }
-    return trimmed;
-}
-
-export function computeNavigationGroups({
-    navigationGroupMappings,
-    collections,
-    views,
-    plugins
-}: {
-    navigationGroupMappings?: NavigationGroupMapping[],
-    collections?: AdminCollection[],
-    views?: AppView[],
-    plugins?: RebasePlugin[]
-}): NavigationGroupMapping[] {
-
-    // Deep clone the input groups upfront to avoid mutating the caller's data
-    let result = navigationGroupMappings
-        ? navigationGroupMappings.map(g => ({
-            name: g.name,
-            entries: [...g.entries],
-            ...(g.collapsedByDefault !== undefined && { collapsedByDefault: g.collapsedByDefault })
-        }))
-        : navigationGroupMappings;
-
-    // Merge plugin navigation entries
-    if (plugins) {
-        result = plugins.reduce((acc, plugin) => {
-            if (plugin.hooks?.navigationEntries) {
-                plugin.hooks.navigationEntries.forEach((entry) => {
-                    const {
-                        name,
-                        entries
-                    } = entry;
-                    const existingGroup = acc.find(g => g.name === name);
-                    if (existingGroup) {
-                        existingGroup.entries.push(...entries);
-                    } else {
-                        acc.push({
-                            name,
-                            entries: [...entries]
-                        });
-                    }
-                });
-
-            }
-            return acc;
-        }, result ?? []);
-    }
-
-    // Track all entries that are already assigned to groups
-    const assignedEntries = new Set<string>();
-    if (result) {
-        result.forEach(group => {
-            group.entries.forEach(entry => assignedEntries.add(entry));
-        });
-    }
-
-    // Find collections and views that are NOT in any persisted group
-    const unassignedGroupMap: Record<string, string[]> = {};
-
-    // Check collections
-    (collections ?? []).forEach(collection => {
-        if (collection.hideFromNavigation) return;
-        const entry = collection.slug;
-        if (!assignedEntries.has(entry)) {
-            const groupName = getGroup(collection);
-            if (!unassignedGroupMap[groupName]) unassignedGroupMap[groupName] = [];
-            unassignedGroupMap[groupName].push(entry);
-        }
-    });
-
-    // Check views
-    (views ?? []).forEach(view => {
-        if (view.hideFromNavigation) return;
-        const entry = Array.isArray(view.slug) ? view.slug[0] : view.slug;
-        if (!assignedEntries.has(entry)) {
-            const groupName = getGroup(view);
-            if (!unassignedGroupMap[groupName]) unassignedGroupMap[groupName] = [];
-            unassignedGroupMap[groupName].push(entry);
-        }
-    });
-
-    // Merge unassigned entries into existing groups or create new groups
-    Object.entries(unassignedGroupMap).forEach(([groupName, entries]) => {
-        if (result) {
-            const existingGroup = result.find(g => g.name === groupName);
-            if (existingGroup) {
-                existingGroup.entries.push(...entries);
-            } else {
-                result.push({
-                    name: groupName,
-                    entries
-                });
-            }
-        }
-    });
-
-    if (!result) {
-        // No persisted data at all - create from scratch
-        result = [];
-        const groupMap: Record<string, string[]> = {};
-
-        // Add collections
-        (collections ?? []).forEach(collection => {
-            if (collection.hideFromNavigation) return;
-            const name = getGroup(collection);
-            const entry = collection.slug;
-            if (!groupMap[name]) groupMap[name] = [];
-            groupMap[name].push(entry);
-        });
-
-        // Add views
-        (views ?? []).forEach(view => {
-            if (view.hideFromNavigation) return;
-            const name = getGroup(view);
-            const entry = Array.isArray(view.slug) ? view.slug[0] : view.slug;
-            if (!groupMap[name]) groupMap[name] = [];
-            groupMap[name].push(entry);
-        });
-
-        // Convert groupMap to result array
-        result = Object.entries(groupMap).map(([name, entries]) => ({
-            name,
-            entries
-        }));
-    }
-
-    // Remove duplicates in entries
-    result.forEach(group => {
-        group.entries = [...new Set(group.entries)];
-    });
-
-    return result;
-}
-
-export function areCollectionListsEqual(a: AdminCollection[], b: AdminCollection[], visitedSlugs: string[] = []) {
-    if (a.length !== b.length) {
-        return false;
-    }
-    const aCopy = [...a];
-    const bCopy = [...b];
-    const aSorted = aCopy.sort((x, y) => x.slug.localeCompare(y.slug));
-    const bSorted = bCopy.sort((x, y) => x.slug.localeCompare(y.slug));
-    return aSorted.every((value, index) => areCollectionsEqual(value, bSorted[index], visitedSlugs));
-}
-
-export function areCollectionsEqual(a: AdminCollection, b: AdminCollection, visitedSlugs: string[] = []) {
-    if (a.slug !== b.slug) {
-        return false;
-    }
-    if (visitedSlugs.includes(a.slug)) {
-        return true;
-    }
-    const newVisited = [...visitedSlugs, a.slug];
-
-    if (!areCollectionListsEqual(getSubcollections(a), getSubcollections(b), newVisited)) {
-        return false;
-    }
-    const restAWithoutFunctions = Object.fromEntries(
-        Object.entries(a).filter(([k, v]) => typeof v !== "function" && k !== "subcollections")
-    );
-    const restBWithoutFunctions = Object.fromEntries(
-        Object.entries(b).filter(([k, v]) => typeof v !== "function" && k !== "subcollections")
-    );
-    return equal(restAWithoutFunctions, restBWithoutFunctions);
-}

package/src/hooks/useAdminContext.tsx

@@ -1,83 +0,0 @@
-import { useMemo } from "react";
-import { useRebaseContext } from "@rebasepro/app";
-import type {
-    User
-} from "@rebasepro/types";
-import type {
-    AuthController,
-    RebaseContext,
-    SideDialogsController,
-    SidePanelController
-} from "@rebasepro/cms-types";
-import type {
-    CollectionRegistryController
-} from "@rebasepro/types";
-import type {
-    NavigationStateController,
-    UrlController
-} from "@rebasepro/cms-types";
-import { useSidePanel } from "./useSidePanel";
-import { useSideDialogsController } from "./useSideDialogsController";
-import {
-    useUrlController,
-    useNavigationStateController,
-    useCollectionRegistryController
-} from "./navigation/contexts";
-
-/**
- * The admin context extends the core RebaseContext with admin-specific
- * controllers that are only available inside the admin routing tree.
- *
- * Use {@link useAdminContext} to obtain an instance.
- * @group Hooks and utilities
- */
-export type AdminContext<
-    DB = Record<string, unknown>,
-    USER extends User = User,
-    AuthControllerType extends AuthController<USER> = AuthController<USER>
-> = RebaseContext<USER, AuthControllerType> & {
-    sidePanelController: SidePanelController;
-    sideDialogsController: SideDialogsController;
-    urlController: UrlController;
-    navigationStateController: NavigationStateController;
-    collectionRegistryController: CollectionRegistryController<DB>;
-};
-
-/**
- * Hook that builds a fully-populated admin context by combining the
- * core {@link RebaseContext} with admin-specific controllers.
- *
- * Use this instead of `useRebaseContext()` in admin components that
- * need to pass context to entity action callbacks, plugin slots,
- * or any consumer that expects admin controllers on the context object.
- *
- * @group Hooks and utilities
- */
-export function useAdminContext<
-    DB = Record<string, unknown>,
-    USER extends User = User,
-    AuthControllerType extends AuthController<USER> = AuthController<USER>
->(): AdminContext<DB, USER, AuthControllerType> {
-    const baseContext = useRebaseContext<USER, AuthControllerType>();
-    const sidePanelController = useSidePanel();
-    const sideDialogsController = useSideDialogsController();
-    const urlController = useUrlController();
-    const navigationStateController = useNavigationStateController();
-    const collectionRegistryController = useCollectionRegistryController<DB>();
-
-    return useMemo(() => ({
-        ...baseContext,
-        sidePanelController,
-        sideDialogsController,
-        urlController,
-        navigationStateController,
-        collectionRegistryController
-    }), [
-        baseContext,
-        sidePanelController,
-        sideDialogsController,
-        urlController,
-        navigationStateController,
-        collectionRegistryController
-    ]);
-}

package/src/hooks/useBreadcrumbsController.tsx

@@ -1,17 +0,0 @@
-import { useContext } from "react";
-import { BreadcrumbContext } from "../contexts/BreacrumbsContext";
-import { BreadcrumbEntry, BreadcrumbsController } from "@rebasepro/cms-types";
-
-export type { BreadcrumbEntry, BreadcrumbsController };
-
-
-/**
- * Hook to retrieve the BreadcrumbsController.
- *
- * Consider that in order to use this hook you need to have a parent
- * `Rebase`
- *
- * @see BreadcrumbsController
- * @group Hooks and utilities
- */
-export const useBreadcrumbsController = (): BreadcrumbsController => useContext(BreadcrumbContext);