@firecms/core 3.0.0-beta.10 → 3.0.0-beta.12

package/dist/form/field_bindings/MarkdownEditorFieldBinding.d.ts

@@ -7,5 +7,5 @@ interface MarkdownEditorFieldProps {
     };
     editorProps?: Partial<FireCMSEditorProps>;
 }
-export declare function MarkdownEditorFieldBinding({ property, propertyKey, value, setValue, includeDescription, showError, error, minimalistView, isSubmitting, context, customProps, }: FieldProps<string, MarkdownEditorFieldProps>): import("react/jsx-runtime").JSX.Element;
+export declare function MarkdownEditorFieldBinding({ property, propertyKey, value, setValue, includeDescription, showError, error, minimalistView, disabled: disabledProp, isSubmitting, context, customProps, }: FieldProps<string, MarkdownEditorFieldProps>): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/field_bindings/ReferenceFieldBinding.d.ts

@@ -1,4 +1,4 @@
-import { EntityReference, FieldProps } from "../../types";
+import { FieldProps } from "../../types";
 /**
  * Field that opens a reference selection dialog.
  *
@@ -6,4 +6,4 @@ import { EntityReference, FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function ReferenceFieldBinding<M extends Record<string, any>>(props: FieldProps<EntityReference>): import("react/jsx-runtime").JSX.Element;
+export declare function ReferenceFieldBinding(props: FieldProps): import("react/jsx-runtime").JSX.Element;

package/dist/form/field_bindings/RepeatFieldBinding.d.ts

@@ -7,4 +7,4 @@ import { FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function RepeatFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, setFieldValue, minimalistView, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function RepeatFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, setFieldValue, minimalistView: minimalistViewProp, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/form/field_bindings/SwitchFieldBinding.d.ts

@@ -1,4 +1,3 @@
-import React from "react";
 import { FieldProps } from "../../types";
 type SwitchFieldProps = FieldProps<boolean>;
 /**
@@ -8,5 +7,5 @@ type SwitchFieldProps = FieldProps<boolean>;
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare const SwitchFieldBinding: React.ForwardRefExoticComponent<SwitchFieldProps & React.RefAttributes<unknown>>;
+export declare const SwitchFieldBinding: ({ propertyKey, value, setValue, error, showError, autoFocus, disabled, size, property, includeDescription }: SwitchFieldProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/index.d.ts

@@ -1,19 +1,19 @@
-import { SelectFieldBinding } from "./field_bindings/SelectFieldBinding";
-import { MultiSelectFieldBinding } from "./field_bindings/MultiSelectFieldBinding";
-import { ArrayOfReferencesFieldBinding } from "./field_bindings/ArrayOfReferencesFieldBinding";
-import { StorageUploadFieldBinding } from "./field_bindings/StorageUploadFieldBinding";
-import { TextFieldBinding } from "./field_bindings/TextFieldBinding";
-import { SwitchFieldBinding } from "./field_bindings/SwitchFieldBinding";
-import { DateTimeFieldBinding } from "./field_bindings/DateTimeFieldBinding";
-import { ReferenceFieldBinding } from "./field_bindings/ReferenceFieldBinding";
-import { MapFieldBinding } from "./field_bindings/MapFieldBinding";
-import { KeyValueFieldBinding } from "./field_bindings/KeyValueFieldBinding";
-import { RepeatFieldBinding } from "./field_bindings/RepeatFieldBinding";
-import { BlockFieldBinding } from "./field_bindings/BlockFieldBinding";
-import { ReadOnlyFieldBinding } from "./field_bindings/ReadOnlyFieldBinding";
-import { MarkdownEditorFieldBinding } from "./field_bindings/MarkdownEditorFieldBinding";
-import { ArrayCustomShapedFieldBinding } from "./field_bindings/ArrayCustomShapedFieldBinding";
-export { ArrayCustomShapedFieldBinding, RepeatFieldBinding, MultiSelectFieldBinding, ArrayOfReferencesFieldBinding, BlockFieldBinding, DateTimeFieldBinding, ReadOnlyFieldBinding, MapFieldBinding, KeyValueFieldBinding, ReferenceFieldBinding, SelectFieldBinding, StorageUploadFieldBinding, SwitchFieldBinding, MarkdownEditorFieldBinding, TextFieldBinding };
+export * from "./EntityForm";
+export { SelectFieldBinding } from "./field_bindings/SelectFieldBinding";
+export { MultiSelectFieldBinding } from "./field_bindings/MultiSelectFieldBinding";
+export { ArrayOfReferencesFieldBinding } from "./field_bindings/ArrayOfReferencesFieldBinding";
+export { StorageUploadFieldBinding } from "./field_bindings/StorageUploadFieldBinding";
+export { TextFieldBinding } from "./field_bindings/TextFieldBinding";
+export { SwitchFieldBinding } from "./field_bindings/SwitchFieldBinding";
+export { DateTimeFieldBinding } from "./field_bindings/DateTimeFieldBinding";
+export { ReferenceFieldBinding } from "./field_bindings/ReferenceFieldBinding";
+export { MapFieldBinding } from "./field_bindings/MapFieldBinding";
+export { KeyValueFieldBinding } from "./field_bindings/KeyValueFieldBinding";
+export { RepeatFieldBinding } from "./field_bindings/RepeatFieldBinding";
+export { BlockFieldBinding } from "./field_bindings/BlockFieldBinding";
+export { ReadOnlyFieldBinding } from "./field_bindings/ReadOnlyFieldBinding";
+export { MarkdownEditorFieldBinding } from "./field_bindings/MarkdownEditorFieldBinding";
+export { ArrayCustomShapedFieldBinding } from "./field_bindings/ArrayCustomShapedFieldBinding";
 export * from "./components";
 export { PropertyFieldBinding } from "./PropertyFieldBinding";
 export * from "./useClearRestoreValue";

package/dist/hooks/data/delete.d.ts

@@ -2,8 +2,8 @@ import { DataSource, DeleteEntityProps, Entity, EntityCallbacks, FireCMSContext,
 /**
  * @group Hooks and utilities
  */
-export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, UserType extends User = User> = DeleteEntityProps<M> & {
-    callbacks?: EntityCallbacks<M, UserType>;
+export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, USER extends User = User> = DeleteEntityProps<M> & {
+    callbacks?: EntityCallbacks<M, USER>;
     onDeleteSuccess?: (entity: Entity<M>) => void;
     onDeleteFailure?: (entity: Entity<M>, e: Error) => void;
     onPreDeleteHookError?: (entity: Entity<M>, e: Error) => void;
@@ -30,8 +30,8 @@ export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, UserTy
  * @param context
  * @group Hooks and utilities
  */
-export declare function deleteEntityWithCallbacks<M extends Record<string, any>, UserType extends User>({ dataSource, entity, collection, callbacks, onDeleteSuccess, onDeleteFailure, onPreDeleteHookError, onDeleteSuccessHookError, context }: DeleteEntityWithCallbacksProps<M> & {
+export declare function deleteEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ dataSource, entity, collection, callbacks, onDeleteSuccess, onDeleteFailure, onPreDeleteHookError, onDeleteSuccessHookError, context }: DeleteEntityWithCallbacksProps<M> & {
     collection: ResolvedEntityCollection<M>;
     dataSource: DataSource;
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }): Promise<boolean>;

package/dist/hooks/data/save.d.ts

@@ -34,8 +34,8 @@ export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEn
  * @see useDataSource
  * @group Hooks and utilities
  */
-export declare function saveEntityWithCallbacks<M extends Record<string, any>, UserType extends User>({ collection, path, entityId, values, previousValues, status, dataSource, context, onSaveSuccess, onSaveFailure, onPreSaveHookError, onSaveSuccessHookError }: SaveEntityWithCallbacksProps<M> & {
-    collection: EntityCollection<M, UserType>;
+export declare function saveEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ collection, path, entityId, values, previousValues, status, dataSource, context, onSaveSuccess, onSaveFailure, onPreSaveHookError, onSaveSuccessHookError }: SaveEntityWithCallbacksProps<M> & {
+    collection: EntityCollection<M, USER>;
     dataSource: DataSource;
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }): Promise<void>;

package/dist/hooks/data/useCollectionFetch.d.ts

@@ -47,4 +47,4 @@ export interface CollectionFetchResult<M extends Record<string, any>> {
  * @param searchString
  * @group Hooks and utilities
  */
-export declare function useCollectionFetch<M extends Record<string, any>, UserType extends User>({ path: inputPath, collection, filterValues, sortBy, itemCount, searchString }: CollectionFetchProps<M>): CollectionFetchResult<M>;
+export declare function useCollectionFetch<M extends Record<string, any>, USER extends User>({ path: inputPath, collection, filterValues, sortBy, itemCount, searchString }: CollectionFetchProps<M>): CollectionFetchResult<M>;

package/dist/hooks/data/useEntityFetch.d.ts

@@ -2,10 +2,11 @@ import { Entity, EntityCollection, User } from "../../types";
 /**
  * @group Hooks and utilities
  */
-export interface EntityFetchProps<M extends Record<string, any>, UserType extends User = User> {
+export interface EntityFetchProps<M extends Record<string, any>, USER extends User = User> {
     path: string;
     entityId?: string;
-    collection: EntityCollection<M, UserType>;
+    databaseId?: string;
+    collection: EntityCollection<M, USER>;
     useCache?: boolean;
 }
 /**
@@ -25,4 +26,4 @@ export interface EntityFetchResult<M extends Record<string, any>> {
  * @param useCache
  * @group Hooks and utilities
  */
-export declare function useEntityFetch<M extends Record<string, any>, UserType extends User>({ path: inputPath, entityId, collection, useCache }: EntityFetchProps<M, UserType>): EntityFetchResult<M>;
+export declare function useEntityFetch<M extends Record<string, any>, USER extends User>({ path: inputPath, entityId, collection, databaseId, useCache }: EntityFetchProps<M, USER>): EntityFetchResult<M>;

package/dist/hooks/useAuthController.d.ts

@@ -8,4 +8,4 @@ import { AuthController, User } from "../types";
  * @see AuthController
  * @group Hooks and utilities
  */
-export declare const useAuthController: <UserType extends User = User, AuthControllerType extends AuthController<UserType> = AuthController<UserType>>() => AuthControllerType;
+export declare const useAuthController: <USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>>() => AuthControllerType;

package/dist/hooks/useBreadcrumbsController.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @group Hooks and utilities
+ */
+export interface BreadcrumbsController {
+    breadcrumbs: BreadcrumbEntry[];
+    set: (props: {
+        breadcrumbs: BreadcrumbEntry[];
+    }) => void;
+}
+/**
+ * @group Hooks and utilities
+ */
+export interface BreadcrumbEntry {
+    title: string;
+    url: string;
+}
+/**
+ * Hook to retrieve the BreadcrumbsController.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @see BreadcrumbsController
+ * @group Hooks and utilities
+ */
+export declare const useBreadcrumbsController: () => BreadcrumbsController;

package/dist/hooks/useBuildNavigationController.d.ts

@@ -1,8 +1,8 @@
 import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
-export type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+export type BuildNavigationContextProps<EC extends EntityCollection, USER extends User> = {
     basePath?: string;
     baseCollectionPath?: string;
-    authController: AuthController<UserType>;
+    authController: AuthController<USER>;
     collections?: EC[] | EntityCollectionsBuilder<EC>;
     collectionPermissions?: PermissionsBuilder;
     views?: CMSView[] | CMSViewsBuilder;
@@ -18,6 +18,9 @@ export type BuildNavigationContextProps<EC extends EntityCollection, UserType ex
      * @param collections
      */
     injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
+    /**
+     * If true, the navigation logic will not be updated until this flag is false
+     */
+    disabled?: boolean;
 };
-export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>(props: BuildNavigationContextProps<EC, UserType>): NavigationController;
-export declare function getSidePanelKey(path: string, entityId?: string): string;
+export declare function useBuildNavigationController<EC extends EntityCollection, USER extends User>(props: BuildNavigationContextProps<EC, USER>): NavigationController;

package/dist/hooks/useFireCMSContext.d.ts

@@ -8,4 +8,4 @@ import { AuthController, FireCMSContext, User } from "../types";
  * @see FireCMSContext
  * @group Hooks and utilities
  */
-export declare const useFireCMSContext: <UserType extends User = User, AuthControllerType extends AuthController<UserType> = AuthController<UserType>>() => FireCMSContext<UserType, AuthControllerType>;
+export declare const useFireCMSContext: <USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>>() => FireCMSContext<USER, AuthControllerType>;

package/dist/hooks/useModeController.d.ts

@@ -4,8 +4,7 @@
  */
 export interface ModeController {
     mode: "light" | "dark";
-    setMode: (mode: "light" | "dark") => void;
-    toggleMode: () => void;
+    setMode: (mode: "light" | "dark" | "system") => void;
 }
 /**
  * Hook to retrieve the current mode ("light" | "dark"), and `setMode`

package/dist/hooks/useResolvedNavigationFrom.d.ts

@@ -44,9 +44,9 @@ interface ResolvedNavigationEntityCustom<M extends Record<string, any>> {
  * @param context
  * @group Hooks and utilities
  */
-export declare function resolveNavigationFrom<M extends Record<string, any>, UserType extends User>({ path, context }: {
+export declare function resolveNavigationFrom<M extends Record<string, any>, USER extends User>({ path, context }: {
     path: string;
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }): Promise<ResolvedNavigationEntry<M>[]>;
 /**
  * @group Hooks and utilities
@@ -68,5 +68,5 @@ export interface NavigationFrom<M extends Record<string, any>> {
  * in any React component that lives under `FireCMS`
  * @group Hooks and utilities
  */
-export declare function useResolvedNavigationFrom<M extends Record<string, any>, UserType extends User>({ path }: NavigationFromProps): NavigationFrom<M>;
+export declare function useResolvedNavigationFrom<M extends Record<string, any>, USER extends User>({ path }: NavigationFromProps): NavigationFrom<M>;
 export {};

package/dist/hooks/useValidateAuthenticator.d.ts

@@ -7,10 +7,10 @@ import { AuthController, Authenticator, DataSourceDelegate, StorageSource, User
  * @param storageSource
  * @param dataSourceDelegate
  */
-export declare function useValidateAuthenticator<UserType extends User = User, Controller extends AuthController<UserType> = AuthController<UserType>>({ disabled, authController, authenticator, storageSource, dataSourceDelegate }: {
+export declare function useValidateAuthenticator<USER extends User = any>({ disabled, authController, authenticator, storageSource, dataSourceDelegate }: {
     disabled?: boolean;
-    authController: Controller;
-    authenticator?: boolean | Authenticator<UserType, Controller>;
+    authController: AuthController<USER>;
+    authenticator?: boolean | Authenticator<USER>;
     dataSourceDelegate: DataSourceDelegate;
     storageSource: StorageSource;
 }): {