@firecms/core 3.0.0-canary.18 → 3.0.0-canary.180

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

@@ -8,5 +8,5 @@ type SelectProps<T extends EnumType> = FieldProps<T>;
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function SelectFieldBinding<T extends EnumType>({ propertyKey, value, setValue, error, showError, disabled, autoFocus, touched, property, includeDescription }: SelectProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function SelectFieldBinding<T extends EnumType>({ propertyKey, value, setValue, error, showError, disabled, autoFocus, touched, property, includeDescription, size }: SelectProps<T>): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,4 +1,4 @@
-import { Entity, EntityCollection, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
+import { FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
 import { StorageFieldItem } from "../../util/useStorageUploadController";
 type StorageUploadFieldProps = FieldProps<string | string[]>;
 /**
@@ -8,10 +8,9 @@ type StorageUploadFieldProps = FieldProps<string | string[]>;
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function StorageUploadFieldBinding({ propertyKey, value, setValue, error, showError, autoFocus, tableMode, property, includeDescription, context, isSubmitting, }: StorageUploadFieldProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageUploadFieldBinding({ propertyKey, value, setValue, error, showError, autoFocus, minimalistView, property, includeDescription, context, isSubmitting, }: StorageUploadFieldProps): import("react/jsx-runtime").JSX.Element;
 export interface StorageUploadProps {
     value: StorageFieldItem[];
-    collection: EntityCollection;
     setInternalValue: (v: StorageFieldItem[]) => void;
     name: string;
     property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
@@ -19,11 +18,10 @@ export interface StorageUploadProps {
     multipleFilesSupported: boolean;
     autoFocus: boolean;
     disabled: boolean;
-    entity: Entity<any>;
     storage: StorageConfig;
     onFilesAdded: (acceptedFiles: File[]) => void;
     storagePathBuilder: (file: File) => string;
     onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, fileMetadata?: any) => Promise<void>;
 }
-export declare function StorageUpload({ collection, property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, entity, storagePathBuilder, }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageUpload({ property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, storagePathBuilder, }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
 export {};

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/field_bindings/TextFieldBinding.d.ts

@@ -8,5 +8,5 @@ interface TextFieldBindingProps<T extends string | number> extends FieldProps<T>
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function TextFieldBinding<T extends string | number>({ context, propertyKey, value, setValue, error, showError, disabled, autoFocus, property, includeDescription, }: TextFieldBindingProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function TextFieldBinding<T extends string | number>({ propertyKey, value, setValue, error, showError, disabled, autoFocus, property, includeDescription, size }: TextFieldBindingProps<T>): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/index.d.ts

@@ -1,5 +1,5 @@
 import { SelectFieldBinding } from "./field_bindings/SelectFieldBinding";
-import { MultiSelectBinding } from "./field_bindings/MultiSelectBinding";
+import { MultiSelectFieldBinding } from "./field_bindings/MultiSelectFieldBinding";
 import { ArrayOfReferencesFieldBinding } from "./field_bindings/ArrayOfReferencesFieldBinding";
 import { StorageUploadFieldBinding } from "./field_bindings/StorageUploadFieldBinding";
 import { TextFieldBinding } from "./field_bindings/TextFieldBinding";
@@ -11,11 +11,9 @@ 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 { MarkdownFieldBinding } from "./field_bindings/MarkdownFieldBinding";
+import { MarkdownEditorFieldBinding } from "./field_bindings/MarkdownEditorFieldBinding";
 import { ArrayCustomShapedFieldBinding } from "./field_bindings/ArrayCustomShapedFieldBinding";
-export { ArrayCustomShapedFieldBinding, RepeatFieldBinding, MultiSelectBinding, ArrayOfReferencesFieldBinding, BlockFieldBinding, DateTimeFieldBinding, ReadOnlyFieldBinding, MapFieldBinding, KeyValueFieldBinding, ReferenceFieldBinding, SelectFieldBinding, StorageUploadFieldBinding, SwitchFieldBinding, MarkdownFieldBinding, TextFieldBinding };
+export { ArrayCustomShapedFieldBinding, RepeatFieldBinding, MultiSelectFieldBinding, ArrayOfReferencesFieldBinding, BlockFieldBinding, DateTimeFieldBinding, ReadOnlyFieldBinding, MapFieldBinding, KeyValueFieldBinding, ReferenceFieldBinding, SelectFieldBinding, StorageUploadFieldBinding, SwitchFieldBinding, MarkdownEditorFieldBinding, TextFieldBinding };
 export * from "./components";
-export type { EntityFormProps } from "./EntityForm";
-export { EntityForm } from "./EntityForm";
 export { PropertyFieldBinding } from "./PropertyFieldBinding";
 export * from "./useClearRestoreValue";

package/dist/form/useClearRestoreValue.d.ts

@@ -1,4 +1,4 @@
-import { CMSType, ResolvedProperty } from "../types";
+import { CMSType, Property, ResolvedProperty } from "../types";
 /**
  * Hook we use to restore a value after it has been cleared
  * @param property
@@ -7,7 +7,7 @@ import { CMSType, ResolvedProperty } from "../types";
  * @ignore
  */
 export declare function useClearRestoreValue<T extends CMSType>({ property, value, setValue }: {
-    property: ResolvedProperty<T>;
+    property: Property<T> | ResolvedProperty<T>;
     value: T;
     setValue: (value: T | null, shouldValidate?: boolean) => void;
 }): void;

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

@@ -1,9 +1,8 @@
-import { DataSource, Entity, EntityCallbacks, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
+import { DataSource, Entity, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
 /**
  * @group Hooks and utilities
  */
 export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEntityProps<M> & {
-    callbacks?: EntityCallbacks<M>;
     onSaveSuccess?: (updatedEntity: Entity<M>) => void;
     onSaveFailure?: (e: Error) => void;
     onPreSaveHookError?: (e: Error) => void;
@@ -35,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/index.d.ts

@@ -7,6 +7,7 @@ export * from "./useNavigationController";
 export * from "./useResolvedNavigationFrom";
 export * from "./useStorageSource";
 export * from "./useAuthController";
+export * from "./useDialogsController";
 export * from "./useSideDialogsController";
 export * from "./useSideEntityController";
 export * from "./useFireCMSContext";

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";
-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;
@@ -19,6 +19,4 @@ type BuildNavigationContextProps<EC extends EntityCollection, UserType extends U
      */
     injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
 };
-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 {};
+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/useProjectLog.d.ts

@@ -1,8 +1,14 @@
-import { AuthController, FireCMSPlugin } from "../types";
+import { AuthController, DataSourceDelegate, FireCMSPlugin } from "../types";
 export declare const DEFAULT_SERVER_DEV = "https://api-kdoe6pj3qq-ey.a.run.app";
 export declare const DEFAULT_SERVER = "https://api-drplyi3b6q-ey.a.run.app";
 export type AccessResponse = {
     blocked?: boolean;
     message?: string;
 };
-export declare function useProjectLog(authController: AuthController, plugins?: FireCMSPlugin<any, any, any>[]): AccessResponse | null;
+export interface UseProjectLogParams {
+    apiKey?: string;
+    authController: AuthController;
+    dataSourceDelegate: DataSourceDelegate;
+    plugins?: FireCMSPlugin<any, any, any>[];
+}
+export declare function useProjectLog({ authController, dataSourceDelegate, plugins, apiKey }: UseProjectLogParams): AccessResponse | null;

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

@@ -1,20 +1,16 @@
-import { AppCheckTokenResult, AuthController, Authenticator, DataSourceDelegate, StorageSource, User } from "../index";
+import { AuthController, Authenticator, DataSourceDelegate, StorageSource, User } from "../index";
 /**
  * This hook is used internally for validating an authenticator.
  *
  * @param authController
  * @param authentication
- * @param getAppCheckToken
- * @param appCheckForceRefresh
  * @param storageSource
  * @param dataSourceDelegate
  */
-export declare function useValidateAuthenticator<UserType extends User = User, Controller extends AuthController<UserType> = AuthController<UserType>>({ disabled, authController, authenticator, getAppCheckToken, appCheckForceRefresh, storageSource, dataSourceDelegate }: {
+export declare function useValidateAuthenticator<USER extends User = any>({ disabled, authController, authenticator, storageSource, dataSourceDelegate }: {
     disabled?: boolean;
-    authController: Controller;
-    authenticator?: boolean | Authenticator<UserType, Controller>;
-    getAppCheckToken?: (forceRefresh: boolean) => Promise<AppCheckTokenResult> | undefined;
-    appCheckForceRefresh?: boolean;
+    authController: AuthController<USER>;
+    authenticator?: boolean | Authenticator<USER>;
     dataSourceDelegate: DataSourceDelegate;
     storageSource: StorageSource;
 }): {

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./core";
+export * from "./app";
 export * from "./types";
 export * from "./form";
 export * from "./preview";