@firecms/core 3.0.0-alpha.44 → 3.0.0-alpha.45

package/src/hooks/data/save.ts

@@ -1,4 +1,13 @@
-import { DataSource, Entity, EntityCallbacks, EntityValues, FireCMSContext, SaveEntityProps, User } from "../../types";
+import {
+    DataSource,
+    Entity,
+    EntityCallbacks,
+    EntityCollection,
+    EntityValues,
+    FireCMSContext,
+    SaveEntityProps,
+    User
+} from "../../types";
 import { useDataSource } from "./useDataSource";
 import { resolveCollection } from "../../util";
 
@@ -55,6 +64,7 @@ export async function saveEntityWithCallbacks<M extends Record<string, any>, Use
                                                                                                         onPreSaveHookError,
                                                                                                         onSaveSuccessHookError
                                                                                                     }: SaveEntityWithCallbacksProps<M> & {
+                                                                                                        collection: EntityCollection<M>,
                                                                                                         dataSource: DataSource,
                                                                                                         context: FireCMSContext<UserType>,
                                                                                                     }

package/src/hooks/data/useCollectionFetch.tsx

@@ -1,7 +1,7 @@
 import { useEffect, useState } from "react";
 import { Entity, EntityCollection, FilterValues, FireCMSContext, User } from "../../types";
 import { useDataSource } from "./useDataSource";
-import { useNavigationContext } from "../useNavigationContext";
+import { useNavigationController } from "../useNavigationController";
 import { useFireCMSContext } from "../useFireCMSContext";
 
 /**
@@ -71,9 +71,9 @@ export function useCollectionFetch<M extends Record<string, any>, UserType exten
     }: CollectionFetchProps<M>): CollectionFetchResult<M> {
 
     const dataSource = useDataSource();
-    const navigationContext = useNavigationContext();
+    const navigationController = useNavigationController();
 
-    const path = navigationContext.resolveAliasesFrom(inputPath);
+    const path = navigationController.resolveAliasesFrom(inputPath);
 
     const sortByProperty = sortBy ? sortBy[0] : undefined;
     const currentSort = sortBy ? sortBy[1] : undefined;

package/src/hooks/data/useEntityFetch.tsx

@@ -1,7 +1,7 @@
 import { useEffect, useState } from "react";
 import { Entity, EntityCollection, FireCMSContext, User } from "../../types";
 import { useDataSource } from "./useDataSource";
-import { useNavigationContext } from "../useNavigationContext";
+import { useNavigationController } from "../useNavigationController";
 import { useFireCMSContext } from "../useFireCMSContext";
 
 /**
@@ -44,9 +44,9 @@ export function useEntityFetch<M extends Record<string, any>, UserType extends U
     }: EntityFetchProps<M>): EntityFetchResult<M> {
 
     const dataSource = useDataSource();
-    const navigationContext = useNavigationContext();
+    const navigationController = useNavigationController();
 
-    const path = navigationContext.resolveAliasesFrom(inputPath);
+    const path = navigationController.resolveAliasesFrom(inputPath);
 
     const context: FireCMSContext<UserType> = useFireCMSContext();
 

package/src/hooks/index.tsx

@@ -5,7 +5,7 @@ export * from "./data/save";
 export * from "./data/delete";
 
 export * from "../form/useClearRestoreValue";
-export * from "./useNavigationContext";
+export * from "./useNavigationController";
 
 export * from "./useResolvedNavigationFrom";
 
@@ -23,3 +23,4 @@ export * from "./useLargeLayout";
 export * from "./useReferenceDialog";
 export * from "./useBrowserTitleAndIcon";
 export * from "./useBuildDataSource";
+export * from "./useBuildNavigationController";

package/src/hooks/useBuildDataSource.ts

@@ -13,6 +13,7 @@ import {
     GeoPoint,
     ListenCollectionProps,
     ListenEntityProps,
+    NavigationController,
     PropertyConfig,
     ResolvedProperties,
     SaveEntityProps
@@ -26,10 +27,12 @@ import { resolveCollection, updateDateAutoValues } from "../util";
  */
 export function useBuildDataSource({
                                        delegate,
-                                       propertyConfigs
+                                       propertyConfigs,
+                                       navigationController
                                    }: {
     delegate: DataSourceDelegate,
     propertyConfigs?: Record<string, PropertyConfig>;
+    navigationController: NavigationController;
 }): DataSource {
 
     return {
@@ -50,7 +53,7 @@ export function useBuildDataSource({
          */
         fetchCollection: useCallback(<M extends Record<string, any>>({
                                                                          path,
-                                                                         collection,
+                                                                         collection: collectionProp,
                                                                          filter,
                                                                          limit,
                                                                          startAfter,
@@ -60,6 +63,7 @@ export function useBuildDataSource({
                                                                      }: FetchCollectionProps<M>
         ): Promise<Entity<M>[]> => {
 
+            const collection = collectionProp ?? navigationController.getCollection(path);
             return delegate.fetchCollection<M>({
                 path,
                 filter,
@@ -92,7 +96,7 @@ export function useBuildDataSource({
             ? useCallback(<M extends Record<string, any>>(
                 {
                     path,
-                    collection,
+                    collection: collectionProp,
                     filter,
                     limit,
                     startAfter,
@@ -104,7 +108,8 @@ export function useBuildDataSource({
                 }: ListenCollectionProps<M>
             ): () => void => {
 
-                const isCollectionGroup = Boolean(collection.collectionGroup) ?? false;
+                const collection = collectionProp ?? navigationController.getCollection(path);
+                const isCollectionGroup = Boolean(collection?.collectionGroup) ?? false;
                 if (!delegate.listenCollection)
                     throw Error("useBuildDataSource delegate not initialised");
 
@@ -186,18 +191,22 @@ export function useBuildDataSource({
                 path,
                 entityId,
                 values,
-                collection,
+                collection: collectionProp,
                 status
             }: SaveEntityProps<M>): Promise<Entity<M>> => {
 
-            const resolvedCollection = resolveCollection<M>({
-                collection,
-                path,
-                entityId,
-                fields: propertyConfigs
-            });
+            const collection = collectionProp ?? navigationController.getCollection(path);
 
-            const properties: ResolvedProperties<M> = resolvedCollection.properties;
+            const resolvedCollection = collection
+                ? resolveCollection<M>({
+                    collection,
+                    path,
+                    entityId,
+                    fields: propertyConfigs
+                })
+                : undefined;
+
+            const properties: ResolvedProperties<M> | undefined = resolvedCollection?.properties;
 
             const firestoreValues = cmsToDelegateModel(
                 values,
@@ -206,14 +215,16 @@ export function useBuildDataSource({
                 delegate.buildDate,
                 delegate.buildDeleteFieldValue
             );
-            const updatedFirestoreValues: EntityValues<M> = updateDateAutoValues(
-                {
-                    inputValues: firestoreValues,
-                    properties,
-                    status,
-                    timestampNowValue: delegate.currentTime(),
-                    setDateToMidnight: delegate.setDateToMidnight
-                });
+            const updatedFirestoreValues: EntityValues<M> = properties
+                ? updateDateAutoValues(
+                    {
+                        inputValues: firestoreValues,
+                        properties,
+                        status,
+                        timestampNowValue: delegate.currentTime(),
+                        setDateToMidnight: delegate.setDateToMidnight
+                    })
+                : firestoreValues;
 
             console.debug("Saving entity", path, entityId, updatedFirestoreValues);
 
@@ -242,7 +253,7 @@ export function useBuildDataSource({
                 entity
             }: DeleteEntityProps<M>
         ): Promise<void> => {
-            return delegate.deleteEntity({entity});
+            return delegate.deleteEntity({ entity });
         }, [delegate.deleteEntity]),
 
         /**
@@ -265,7 +276,7 @@ export function useBuildDataSource({
         }, [delegate.checkUniqueField]),
 
         generateEntityId: useCallback((path: string): string => {
-            return delegate.generateEntityId(path, );
+            return delegate.generateEntityId(path,);
         }, [delegate.generateEntityId]),
 
         countEntities: useCallback(async ({

package/src/{internal/useBuildNavigationContext.tsx → hooks/useBuildNavigationController.tsx}

@@ -5,12 +5,12 @@ import {
     AuthController,
     CMSView,
     CMSViewsBuilder,
-    DataSource,
+    DataSource, DataSourceDelegate,
     EntityCollection,
     EntityCollectionsBuilder,
     EntityReference,
     FireCMSPlugin,
-    NavigationContext,
+    NavigationController,
     TopNavigationEntry,
     TopNavigationResult,
     User,
@@ -25,27 +25,30 @@ import {
 } from "../util";
 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> = {
-    basePath: string,
-    baseCollectionPath: string,
+    basePath?: string,
+    baseCollectionPath?: string,
     authController: AuthController<UserType>;
     collections?: EC[] | EntityCollectionsBuilder<EC>;
     views?: CMSView[] | CMSViewsBuilder;
     userConfigPersistence?: UserConfigurationPersistence;
     plugins?: FireCMSPlugin[];
-    dataSource: DataSource;
+    dataSource: DataSourceDelegate;
 };
 
-export function useBuildNavigationContext<EC extends EntityCollection, UserType extends User>({
-                                                                                                                 basePath,
-                                                                                                                 baseCollectionPath,
-                                                                                                                 authController,
-                                                                                                                 collections: baseCollections,
-                                                                                                                 views: baseViews,
-                                                                                                                 userConfigPersistence,
-                                                                                                                 plugins,
-                                                                                                                 dataSource
-                                                                                                             }: BuildNavigationContextProps<EC, UserType>): NavigationContext {
+export function useBuildNavigationController<EC extends EntityCollection, UserType extends User>({
+                                                                                                     basePath = DEFAULT_BASE_PATH,
+                                                                                                     baseCollectionPath = DEFAULT_COLLECTION_PATH,
+                                                                                                     authController,
+                                                                                                     collections: baseCollections,
+                                                                                                     views: baseViews,
+                                                                                                     userConfigPersistence,
+                                                                                                     plugins,
+                                                                                                     dataSource
+                                                                                                 }: BuildNavigationContextProps<EC, UserType>): NavigationController {
 
     const location = useLocation();
 
@@ -288,7 +291,7 @@ function filterOutNotAllowedCollections(resolvedCollections: EntityCollection[],
         });
 }
 
-async function resolveCollections(collections: undefined | EntityCollection[] | EntityCollectionsBuilder<any>, authController: AuthController, dataSource: DataSource, plugins?: FireCMSPlugin[]) {
+async function resolveCollections(collections: undefined | EntityCollection[] | EntityCollectionsBuilder<any>, authController: AuthController, dataSource: DataSourceDelegate, plugins?: FireCMSPlugin[]) {
     let resolvedCollections: EntityCollection[] = [];
     if (typeof collections === "function") {
         resolvedCollections = await collections({
@@ -312,7 +315,7 @@ async function resolveCollections(collections: undefined | EntityCollection[] |
     return resolvedCollections;
 }
 
-async function resolveCMSViews(baseViews: CMSView[] | CMSViewsBuilder | undefined, authController: AuthController, dataSource: DataSource) {
+async function resolveCMSViews(baseViews: CMSView[] | CMSViewsBuilder | undefined, authController: AuthController, dataSource: DataSourceDelegate) {
     let resolvedViews: CMSView[] = [];
     if (typeof baseViews === "function") {
         resolvedViews = await baseViews({

package/src/hooks/useFireCMSContext.tsx

@@ -2,7 +2,7 @@ import { createContext, useContext } from "react";
 import { AuthController, FireCMSContext, User } from "../types";
 import { useAuthController } from "./useAuthController";
 import { useSideDialogsController } from "./useSideDialogsController";
-import { useNavigationContext } from "./useNavigationContext";
+import { useNavigationController } from "./useNavigationController";
 import { useSideEntityController } from "./useSideEntityController";
 import { useDataSource } from "./data/useDataSource";
 import { useStorageSource } from "./useStorageSource";
@@ -27,7 +27,7 @@ export const useFireCMSContext = <UserType extends User = User, AuthControllerTy
     const authController = useAuthController<UserType, AuthControllerType>();
     const sideDialogsController = useSideDialogsController();
     const sideEntityController = useSideEntityController();
-    const navigation = useNavigationContext();
+    const navigation = useNavigationController();
     const dataSource = useDataSource();
     const storageSource = useStorageSource();
     const snackbarController = useSnackbarController();

package/src/hooks/{useNavigationContext.tsx → useNavigationController.tsx}

@@ -1,6 +1,6 @@
 import { useContext } from "react";
-import { NavigationContext } from "../types";
-import { NavigationContextInstance } from "../contexts/NavigationContext";
+import { NavigationController } from "../types";
+import { NavigationContext } from "../contexts/NavigationContext";
 
 /**
  * Use this hook to get the navigation of the app.
@@ -9,4 +9,4 @@ import { NavigationContextInstance } from "../contexts/NavigationContext";
  *
  * @group Hooks and utilities
  */
-export const useNavigationContext = (): NavigationContext => useContext(NavigationContextInstance);
+export const useNavigationController = (): NavigationController => useContext(NavigationContext);

package/src/hooks/useReferenceDialog.tsx

@@ -1,7 +1,7 @@
 import { useSideDialogsController } from "./useSideDialogsController";
 import { ReferenceSelectionInner, ReferenceSelectionInnerProps } from "../components";
 import { useCallback } from "react";
-import { useNavigationContext } from "./useNavigationContext";
+import { useNavigationController } from "./useNavigationController";
 
 /**
  * This hook is used to open a side dialog that allows the selection
@@ -18,7 +18,7 @@ export function useReferenceDialog<M extends Record<string, any>>(referenceDialo
     onClose?: () => void;
 }): { open: () => void; close: () => void } {
 
-    const navigation = useNavigationContext();
+    const navigation = useNavigationController();
     const sideDialogsController = useSideDialogsController();
 
     const open = useCallback(() => {

package/src/internal/useBuildSideEntityController.tsx

@@ -2,7 +2,7 @@ import { useCallback, useEffect, useRef } from "react";
 import {
     EntityCollection,
     EntitySidePanelProps,
-    NavigationContext,
+    NavigationController,
     SideDialogPanelProps,
     SideDialogsController,
     SideEntityController
@@ -23,7 +23,7 @@ export function getEntityViewWidth(props: EntitySidePanelProps<any>, small: bool
     return !mainViewSelected ? `calc(${ADDITIONAL_TAB_WIDTH} + ${resolvedWidth ?? FORM_CONTAINER_WIDTH})` : resolvedWidth ?? FORM_CONTAINER_WIDTH
 }
 
-export const useBuildSideEntityController = (navigation: NavigationContext,
+export const useBuildSideEntityController = (navigation: NavigationController,
                                              sideDialogsController: SideDialogsController): SideEntityController => {
 
     const location = useLocation();
@@ -142,7 +142,7 @@ export function buildSidePanelsFromUrl(path: string, collections: EntityCollecti
     return sidePanels;
 }
 
-const propsToSidePanel = (props: EntitySidePanelProps<any>, navigation: NavigationContext, smallLayout: boolean): SideDialogPanelProps => {
+const propsToSidePanel = (props: EntitySidePanelProps<any>, navigation: NavigationController, smallLayout: boolean): SideDialogPanelProps => {
 
     const collectionPath = removeInitialAndTrailingSlashes(props.path);
     const newPath = props.entityId

package/src/preview/components/ReferencePreview.tsx

@@ -4,7 +4,7 @@ import { useMemo } from "react";
 import { Entity, EntityCollection, EntityReference, ResolvedProperty } from "../../types";
 
 import { getReferencePreviewKeys, getValueInPath, resolveCollection } from "../../util";
-import { useEntityFetch, useFireCMSContext, useNavigationContext, useSideEntityController } from "../../hooks";
+import { useEntityFetch, useFireCMSContext, useNavigationController, useSideEntityController } from "../../hooks";
 import { PropertyPreview } from "../PropertyPreview";
 import { PreviewSize } from "../PropertyPreviewProps";
 import { SkeletonPropertyComponent } from "../property_previews/SkeletonPropertyComponent";
@@ -61,9 +61,9 @@ function ReferencePreviewInternal<M extends Record<string, any>>({
                                                                  }: ReferencePreviewProps) {
 
     const context = useFireCMSContext();
-    const navigationContext = useNavigationContext();
+    const navigationController = useNavigationController();
 
-    const collection = navigationContext.getCollection<EntityCollection<M>>(reference.path);
+    const collection = navigationController.getCollection<EntityCollection<M>>(reference.path);
     if (!collection) {
         if (context.components?.missingReference) {
             return <context.components.missingReference path={reference.path}/>;

package/src/types/datasource.ts

@@ -8,7 +8,7 @@ import { ResolvedEntityCollection } from "./resolved_entities";
 export interface FetchEntityProps<M extends Record<string, any> = any> {
     path: string;
     entityId: string;
-    collection: EntityCollection<M>
+    collection?: EntityCollection<M>
 }
 
 /**
@@ -26,7 +26,7 @@ export type ListenEntityProps<M extends Record<string, any> = any> =
  */
 export interface FetchCollectionProps<M extends Record<string, any> = any> {
     path: string;
-    collection: EntityCollection<M> | ResolvedEntityCollection<M>;
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
     filter?: FilterValues<Extract<keyof M, string>>,
     limit?: number;
     startAfter?: any[];
@@ -53,7 +53,7 @@ export interface SaveEntityProps<M extends Record<string, any> = any> {
     values: Partial<EntityValues<M>>;
     entityId?: string; // can be empty for new entities
     previousValues?: Partial<EntityValues<M>>;
-    collection: EntityCollection<M> | ResolvedEntityCollection<M>;
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
     status: EntityStatus;
 }
 

package/src/types/firecms.tsx

@@ -1,9 +1,9 @@
 import React from "react";
 import { User } from "./user";
 import { AuthController } from "./auth";
-import { DataSource } from "./datasource";
+import { DataSource, DataSourceDelegate } from "./datasource";
 import { EntityCollection, EntityCustomView } from "./collections";
-import { CMSView } from "./navigation";
+import { CMSView, NavigationController } from "./navigation";
 import { FireCMSContext } from "./firecms_context";
 import { PropertyConfig } from "./property_config";
 import { Locale } from "./locales";
@@ -26,7 +26,7 @@ import { CMSAnalyticsEvent } from "./analytics";
 export type EntityCollectionsBuilder<EC extends EntityCollection = EntityCollection> = (params: {
     user: User | null,
     authController: AuthController,
-    dataSource: DataSource
+    dataSource: DataSourceDelegate
 }) => EC[] | Promise<EC[]>;
 
 /**
@@ -41,7 +41,7 @@ export type EntityCollectionsBuilder<EC extends EntityCollection = EntityCollect
 export type CMSViewsBuilder = (params: {
     user: User | null,
     authController: AuthController,
-    dataSource: DataSource
+    dataSource: DataSourceDelegate
 }) => CMSView[] | Promise<CMSView[]>;
 
 /**
@@ -67,20 +67,6 @@ export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
         loading: boolean;
     }) => React.ReactNode;
 
-    /**
-     * List of the mapped collections in the CMS.
-     * Each entry relates to a collection in the root database.
-     * Each of the navigation entries in this field
-     * generates an entry in the main menu.
-     */
-    collections?: EC[] | EntityCollectionsBuilder<EC>;
-
-    /**
-     * Custom additional views created by the developer, added to the main
-     * navigation
-     */
-    views?: CMSView[] | CMSViewsBuilder;
-
     /**
      * Record of custom form fields to be used in the CMS.
      * You can use the key to reference the custom field in
@@ -125,18 +111,10 @@ export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
     authController: AuthController<UserType>;
 
     /**
-     * Path under the navigation routes of the CMS will be created. Defaults to `/`.
-     * Internally FireCMS uses `react-router` to create the routes, the base path is attached to the
-     * `BrowserRouter` component. If you are using FireCMS in a subpath of your website, you can use
-     * this prop to specify the base path.
+     * Controller in charge of managing the collections and views of the CMS.
+     * @see {@link useBuildNavigationController}
      */
-    basePath?: string;
-
-    /**
-     * Path under the collection routes of the CMS will be created.
-     * Defaults to `/c`.
-     */
-    baseCollectionPath?: string;
+    navigationController: NavigationController;
 
     /**
      * Use this controller to access the configuration that is stored locally,
@@ -172,4 +150,6 @@ export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
 
     }
 
+
+
 };

package/src/types/firecms_context.tsx

@@ -1,7 +1,7 @@
 import { Locale } from "./locales";
 import { DataSource } from "./datasource";
 import { StorageSource } from "./storage";
-import { NavigationContext } from "./navigation";
+import { NavigationController } from "./navigation";
 import { SideEntityController } from "./side_entity_controller";
 import { AuthController } from "./auth";
 import { EntityLinkBuilder } from "./entity_link_builder";
@@ -50,7 +50,7 @@ export type FireCMSContext<UserType extends User = User, AuthControllerType exte
      * attributes.
      * @see useNavigation
      */
-    navigation: NavigationContext;
+    navigation: NavigationController;
 
     /**
      * Controller to open the side dialog displaying entity forms

package/src/types/navigation.ts

@@ -2,11 +2,11 @@ import { EntityCollection } from "./collections";
 import { EntityReference } from "./entities";
 
 /**
- * Context that includes the resolved navigation and utility methods and
+ * Controller that includes the resolved navigation and utility methods and
  * attributes.
  * @group Models
  */
-export type NavigationContext = {
+export type NavigationController = {
 
     /**
      * List of the mapped collections in the CMS.

package/dist/internal/useBuildNavigationContext.d.ts

@@ -1,14 +0,0 @@
-import { AuthController, CMSView, CMSViewsBuilder, DataSource, EntityCollection, EntityCollectionsBuilder, FireCMSPlugin, NavigationContext, User, UserConfigurationPersistence } from "../types";
-type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
-    basePath: string;
-    baseCollectionPath: string;
-    authController: AuthController<UserType>;
-    collections?: EC[] | EntityCollectionsBuilder<EC>;
-    views?: CMSView[] | CMSViewsBuilder;
-    userConfigPersistence?: UserConfigurationPersistence;
-    plugins?: FireCMSPlugin[];
-    dataSource: DataSource;
-};
-export declare function useBuildNavigationContext<EC extends EntityCollection, UserType extends User>({ basePath, baseCollectionPath, authController, collections: baseCollections, views: baseViews, userConfigPersistence, plugins, dataSource }: BuildNavigationContextProps<EC, UserType>): NavigationContext;
-export declare function getSidePanelKey(path: string, entityId?: string): string;
-export {};