@firecms/core 3.0.0-alpha.27 → 3.0.0-alpha.29

package/dist/components/Popover.d.ts

@@ -15,5 +15,7 @@ export interface PopoverProps {
     hideWhenDetached?: boolean;
     avoidCollisions?: boolean;
     enabled?: boolean;
+    modal?: boolean;
+    className?: string;
 }
-export declare function Popover({ trigger, children, open, onOpenChange, side, sideOffset, align, alignOffset, arrowPadding, sticky, hideWhenDetached, avoidCollisions, enabled }: PopoverProps): import("react/jsx-runtime").JSX.Element;
+export declare function Popover({ trigger, children, open, onOpenChange, side, sideOffset, align, alignOffset, arrowPadding, sticky, hideWhenDetached, avoidCollisions, enabled, modal, className }: PopoverProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/FireCMS.d.ts

@@ -1,4 +1,4 @@
-import { FireCMSProps, User } from "../types";
+import { EntityCollection, FireCMSProps, User } from "../types";
 /**
  * If you are using independent components of the CMS
  * you need to wrap them with this main component, so the internal hooks work.
@@ -12,4 +12,4 @@ import { FireCMSProps, User } from "../types";
  * @constructor
  * @category Core
  */
-export declare function FireCMS<UserType extends User>(props: FireCMSProps<UserType>): import("react/jsx-runtime").JSX.Element;
+export declare function FireCMS<UserType extends User, EC extends EntityCollection>(props: FireCMSProps<UserType, EC>): import("react/jsx-runtime").JSX.Element;

package/dist/core/builders.d.ts

@@ -1,11 +1,11 @@
-import { AdditionalFieldDelegate, ArrayProperty, BooleanProperty, CMSType, DateProperty, EntityCallbacks, EntityCollection, EnumValueConfig, EnumValues, FieldConfig, GeopointProperty, MapProperty, NumberProperty, PropertiesOrBuilders, PropertyBuilder, PropertyOrBuilder, ReferenceProperty, StringProperty, User } from "../types";
+import { AdditionalFieldDelegate, ArrayProperty, BooleanProperty, CMSType, DateProperty, EntityCallbacks, EntityCollection, EnumValueConfig, EnumValues, PropertyConfig, GeopointProperty, MapProperty, NumberProperty, PropertiesOrBuilders, PropertyBuilder, PropertyOrBuilder, ReferenceProperty, StringProperty, User } from "../types";
 /**
  * Identity function we use to defeat the type system of Typescript and build
  * collection views with all its properties
  * @param collection
  * @category Builder
  */
-export declare function buildCollection<M extends Record<string, any> = any, AdditionalKey extends string = string, UserType extends User = User>(collection: EntityCollection<M, AdditionalKey, UserType>): EntityCollection<M, AdditionalKey, UserType>;
+export declare function buildCollection<M extends Record<string, any> = any, UserType extends User = User>(collection: EntityCollection<M, UserType>): EntityCollection<M, UserType>;
 /**
  * Identity function we use to defeat the type system of Typescript and preserve
  * the property keys.
@@ -54,11 +54,11 @@ export declare function buildEntityCallbacks<M extends Record<string, any> = any
  * @param additionalFieldDelegate
  * @category Builder
  */
-export declare function buildAdditionalFieldDelegate<M extends Record<string, any>, AdditionalKey extends string = string, UserType extends User = User>(additionalFieldDelegate: AdditionalFieldDelegate<M, AdditionalKey, UserType>): AdditionalFieldDelegate<M, AdditionalKey, UserType>;
+export declare function buildAdditionalFieldDelegate<M extends Record<string, any>, UserType extends User = User>(additionalFieldDelegate: AdditionalFieldDelegate<M, UserType>): AdditionalFieldDelegate<M, UserType>;
 /**
  * Identity function we use to defeat the type system of Typescript and build
  * additional field delegates views with all its properties
- * @param fieldConfig
+ * @param propertyConfig
  * @category Builder
  */
-export declare function buildFieldConfig<T extends CMSType = CMSType>(fieldConfig: FieldConfig<T>): FieldConfig<T>;
+export declare function buildFieldConfig<T extends CMSType = CMSType>(propertyConfig: PropertyConfig<T>): PropertyConfig<T>;

package/dist/core/components/EntityCollectionTable/EntityCollectionTableProps.d.ts

@@ -11,7 +11,7 @@ export type OnColumnResizeParams = {
 /**
  * @category Collection components
  */
-export type EntityCollectionTableProps<M extends Record<string, any>, AdditionalKey extends string = string, UserType extends User = User> = {
+export type EntityCollectionTableProps<M extends Record<string, any>, UserType extends User = User> = {
     /**
      * Display these entities as selected
      */
@@ -76,7 +76,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, Additional
     forceFilter?: FilterValues<Extract<keyof M, string>>;
     textSearchEnabled?: boolean;
     inlineEditing?: boolean | ((entity: Entity<M>) => boolean);
-    additionalFields?: AdditionalFieldDelegate<M, AdditionalKey, UserType>[];
+    additionalFields?: AdditionalFieldDelegate<M, UserType>[];
     defaultSize?: CollectionSize;
     properties: ResolvedProperties<M>;
     getPropertyFor?: (props: GetPropertyForProps<M>) => ResolvedProperties<M>[string];
@@ -90,6 +90,8 @@ export type EntityCollectionTableProps<M extends Record<string, any>, Additional
     }) => React.ReactNode;
     AddColumnComponent?: React.ComponentType;
     additionalIDHeaderWidget?: React.ReactNode;
+    emptyComponent?: React.ReactNode;
+    getIdColumnWidth?: () => number;
 };
 export type GetPropertyForProps<M extends Record<string, any>> = {
     propertyKey: string;

package/dist/core/components/EntityCollectionTable/filters/ReferenceFilterField.d.ts

@@ -7,8 +7,8 @@ interface ReferenceFilterFieldProps {
     path?: string;
     title?: string;
     previewProperties?: string[];
-    popupOpen: boolean;
-    setPopupOpen: (open: boolean) => void;
+    hidden: boolean;
+    setHidden: (hidden: boolean) => void;
 }
-export declare function ReferenceFilterField({ name, value, setValue, isArray, path, title, previewProperties, setPopupOpen }: ReferenceFilterFieldProps): import("react/jsx-runtime").JSX.Element;
+export declare function ReferenceFilterField({ name, value, setValue, isArray, path, title, previewProperties, setHidden }: ReferenceFilterFieldProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/core/components/EntityCollectionTable/internal/EntityCollectionRowActions.d.ts

@@ -1,4 +1,5 @@
-import { CollectionSize, Entity } from "../../../../types";
+import React from "react";
+import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionController } from "../../../../types";
 /**
  *
  * @param entity
@@ -16,16 +17,19 @@ import { CollectionSize, Entity } from "../../../../types";
  *
  * @category Collection components
  */
-export declare function EntityCollectionRowActions<M extends Record<string, any>>({ entity, width, frozen, isSelected, selectionEnabled, size, toggleEntitySelection, onCopyClicked, onEditClicked, onDeleteClicked, hideId }: {
-    entity: Entity<M>;
+export declare const EntityCollectionRowActions: React.NamedExoticComponent<{
+    entity: Entity<any>;
+    collection?: EntityCollection<any, import("../../../../types").User> | undefined;
+    fullPath?: string | undefined;
     width: number;
-    frozen?: boolean;
+    frozen?: boolean | undefined;
     size: CollectionSize;
     isSelected: boolean;
-    selectionEnabled?: boolean;
-    toggleEntitySelection?: (selectedEntity: Entity<M>) => void;
-    onEditClicked?: (selectedEntity: Entity<M>) => void;
-    onCopyClicked?: (selectedEntity: Entity<M>) => void;
-    onDeleteClicked?: (selectedEntity: Entity<M>) => void;
-    hideId?: boolean;
-}): import("react/jsx-runtime").JSX.Element;
+    selectionEnabled?: boolean | undefined;
+    actions?: EntityAction[] | undefined;
+    hideId?: boolean | undefined;
+    onCollectionChange?: (() => void) | undefined;
+    selectionController?: SelectionController | undefined;
+    highlightEntity?: ((entity: Entity<any>) => void) | undefined;
+    unhighlightEntity?: ((entity: Entity<any>) => void) | undefined;
+}>;

package/dist/core/components/EntityCollectionTable/internal/default_entity_actions.d.ts

@@ -0,0 +1,5 @@
+import { EntityAction } from "../../../../types";
+export declare const editEntityAction: EntityAction;
+export declare const copyEntityAction: EntityAction;
+export declare const archiveEntityAction: EntityAction;
+export declare const deleteEntityAction: EntityAction;

package/dist/core/components/EntityCollectionTable/types.d.ts

@@ -1,40 +1,4 @@
-import { CollectionSize, Entity, EntityCollection, FireCMSContext, ResolvedProperty, SelectedCellProps, User } from "../../../types";
-export type EntityCollectionTableProviderProps<M extends Record<string, any>, AdditionalKey extends string, UserType extends User> = {
-    /**
-     * Absolute collection path
-     */
-    path: string;
-    /**
-     * Use to resolve the collection properties for specific path, entity id or values
-     */
-    collection: EntityCollection<M>;
-    /**
-     * List of entities that will be displayed on top, no matter the ordering.
-     * This is used for reference fields selection
-     */
-    entitiesDisplayedFirst?: Entity<M>[];
-    /**
-     * Callback when anywhere on the table is clicked
-     */
-    onEntityClick?(entity: Entity<M>): void;
-    /**
-     * Callback when the selected size of the table is changed
-     */
-    onSizeChanged?(size: CollectionSize): void;
-    /**
-     * Can the table be edited inline
-     */
-    inlineEditing: ((entity: Entity<any>) => boolean) | boolean;
-    /**
-     * Builder for creating the buttons in each row
-     * @param entity
-     * @param size
-     */
-    tableRowActionsBuilder?: ({ entity, size }: {
-        entity: Entity<M>;
-        size: CollectionSize;
-    }) => React.ReactNode;
-};
+import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../../types";
 export type EntityCollectionTableController<M extends Record<string, any>> = {
     selectedCell?: SelectedCellProps<any>;
     select: (cell?: SelectedCellProps<M>) => void;

package/dist/core/components/FieldConfigBadge.d.ts

@@ -1,4 +1,4 @@
-import { FieldConfig } from "../../types";
-export declare function FieldConfigBadge({ fieldConfig }: {
-    fieldConfig: FieldConfig | undefined;
+import { PropertyConfig } from "../../types";
+export declare function FieldConfigBadge({ propertyConfig }: {
+    propertyConfig: PropertyConfig | undefined;
 }): React.ReactNode;

package/dist/core/components/VirtualTable/VirtualTableHeader.d.ts

@@ -5,8 +5,8 @@ export type FilterFormFieldProps<CustomProps> = {
     filterValue: [VirtualTableWhereFilterOp, any] | undefined;
     setFilterValue: (filterValue?: [VirtualTableWhereFilterOp, any]) => void;
     column: VirtualTableColumn<CustomProps>;
-    popupOpen: boolean;
-    setPopupOpen: (open: boolean) => void;
+    hidden: boolean;
+    setHidden: (hidden: boolean) => void;
 };
 type VirtualTableHeaderProps<M extends Record<string, any>> = {
     resizeHandleRef: RefObject<HTMLDivElement>;

package/dist/core/components/VirtualTable/VirtualTableProps.d.ts

@@ -83,7 +83,7 @@ export interface VirtualTableProps<T extends Record<string, any>> {
     /**
      * Message displayed when there is no data
      */
-    emptyMessage?: string;
+    emptyComponent?: React.ReactNode;
     /**
      * Is the table in a loading state
      */

package/dist/core/contexts/DialogsProvider.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from "react";
+import { DialogsController } from "../../types/dialogs_controller";
+export declare const DialogsControllerContext: React.Context<DialogsController>;
+export declare const DialogsProvider: React.FC<PropsWithChildren<{}>>;

package/dist/core/form_field_configs.d.ts

@@ -1,6 +1,6 @@
-import { FieldConfig, Property, ResolvedProperty } from "../types";
+import { PropertyConfig, Property, ResolvedProperty } from "../types";
 export declare function isDefaultFieldConfigId(id: string): boolean;
-export declare const DEFAULT_FIELD_CONFIGS: Record<string, FieldConfig<any>>;
-export declare function getFieldConfig(property: Property | ResolvedProperty, customFields: Record<string, FieldConfig<any>>): FieldConfig | undefined;
+export declare const DEFAULT_FIELD_CONFIGS: Record<string, PropertyConfig<any>>;
+export declare function getFieldConfig(property: Property | ResolvedProperty, customFields: Record<string, PropertyConfig<any>>): PropertyConfig | undefined;
 export declare function getDefaultFieldId(property: Property | ResolvedProperty): "reference" | "date_time" | "email" | "url" | "group" | "switch" | "block" | "file_upload" | "repeat" | "select" | "text_field" | "multiline" | "markdown" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "multi_file_upload" | "multi_references" | "key_value" | "custom_array" | undefined;
 export declare function getFieldId(property: Property | ResolvedProperty): string | undefined;

package/dist/core/index.d.ts

@@ -12,6 +12,6 @@ export * from "./form_field_configs";
 export * from "./useBuildModeController";
 export * from "../components/util/useOutsideAlerter";
 export * from "./useBuildLocalConfigurationPersistence";
-export { SnackbarProvider } from "./contexts/SnackbarContext";
+export { SnackbarProvider } from "./contexts/SnackbarProvider";
 export { ModeControllerProvider } from "./contexts/ModeController";
 export * from "./contexts/AuthControllerContext";

package/dist/core/internal/useBuildNavigationContext.d.ts

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

package/dist/core/util/property_utils.d.ts

@@ -1,10 +1,10 @@
 import React from "react";
-import { EntityCollection, FieldConfig, PropertiesOrBuilders, PropertyOrBuilder, ResolvedProperty } from "../../types";
-export declare function isReferenceProperty(propertyOrBuilder: PropertyOrBuilder, fields: Record<string, FieldConfig>): boolean | null;
+import { EntityCollection, PropertyConfig, PropertiesOrBuilders, PropertyOrBuilder, ResolvedProperty } from "../../types";
+export declare function isReferenceProperty(propertyOrBuilder: PropertyOrBuilder, fields: Record<string, PropertyConfig>): boolean | null;
 export declare function getIdIcon(size: "small" | "medium" | "large"): React.ReactNode;
-export declare function getIconForWidget(widget: FieldConfig | undefined, size: "small" | "medium" | "large"): import("react/jsx-runtime").JSX.Element;
-export declare function getIconForProperty(property: PropertyOrBuilder | ResolvedProperty, size?: "small" | "medium" | "large", fields?: Record<string, FieldConfig>): React.ReactNode;
-export declare function getColorForProperty(property: PropertyOrBuilder, fields: Record<string, FieldConfig>): string;
+export declare function getIconForWidget(widget: PropertyConfig | undefined, size: "small" | "medium" | "large"): import("react/jsx-runtime").JSX.Element;
+export declare function getIconForProperty(property: PropertyOrBuilder | ResolvedProperty, size?: "small" | "medium" | "large", fields?: Record<string, PropertyConfig>): React.ReactNode;
+export declare function getColorForProperty(property: PropertyOrBuilder, fields: Record<string, PropertyConfig>): string;
 /**
  * Get a property in a property tree from a path like
  * `address.street`

package/dist/core/util/references.d.ts

@@ -1,2 +1,2 @@
-import { EntityCollection, FieldConfig } from "../../types";
-export declare function getReferencePreviewKeys(targetCollection: EntityCollection<any>, fields: Record<string, FieldConfig>, previewProperties?: string[], limit?: number): string[];
+import { EntityCollection, PropertyConfig } from "../../types";
+export declare function getReferencePreviewKeys(targetCollection: EntityCollection<any>, fields: Record<string, PropertyConfig>, previewProperties?: string[], limit?: number): string[];

package/dist/core/util/resolutions.d.ts

@@ -1,12 +1,12 @@
-import { ArrayProperty, CMSType, EntityCollection, EntityCustomView, EntityValues, EnumValueConfig, EnumValues, FieldConfig, NumberProperty, PropertiesOrBuilders, PropertyOrBuilder, ResolvedArrayProperty, ResolvedEntityCollection, ResolvedNumberProperty, ResolvedProperties, ResolvedProperty, ResolvedStringProperty, StringProperty, UserConfigurationPersistence } from "../../types";
+import { ArrayProperty, CMSType, EntityCollection, EntityCustomView, EntityValues, EnumValueConfig, EnumValues, PropertyConfig, NumberProperty, PropertiesOrBuilders, PropertyOrBuilder, ResolvedArrayProperty, ResolvedEntityCollection, ResolvedNumberProperty, ResolvedProperties, ResolvedProperty, ResolvedStringProperty, StringProperty, UserConfigurationPersistence } from "../../types";
 export declare const resolveCollection: <M extends Record<string, any>>({ collection, path, entityId, values, previousValues, userConfigPersistence, fields }: {
-    collection: EntityCollection<M, string, import("../../types").User> | ResolvedEntityCollection<M>;
+    collection: EntityCollection<M, import("../../types").User> | ResolvedEntityCollection<M>;
     path: string;
     entityId?: string | undefined;
     values?: Partial<M> | undefined;
     previousValues?: Partial<M> | undefined;
     userConfigPersistence?: UserConfigurationPersistence | undefined;
-    fields?: Record<string, FieldConfig> | undefined;
+    fields?: Record<string, PropertyConfig> | undefined;
 }) => ResolvedEntityCollection<M>;
 /**
  * Resolve property builders, enums and arrays.
@@ -24,7 +24,7 @@ export declare function resolveProperty<T extends CMSType = CMSType, M extends R
     entityId?: string;
     index?: number;
     fromBuilder?: boolean;
-    fields?: Record<string, FieldConfig<any>>;
+    fields?: Record<string, PropertyConfig<any>>;
 }): ResolvedProperty<T> | null;
 export declare function resolveArrayProperty<T extends any[], M>({ propertyKey, property, propertyValue, ...props }: {
     propertyKey?: string;
@@ -36,7 +36,7 @@ export declare function resolveArrayProperty<T extends any[], M>({ propertyKey,
     entityId?: string;
     index?: number;
     fromBuilder?: boolean;
-    fields?: Record<string, FieldConfig>;
+    fields?: Record<string, PropertyConfig>;
 }): ResolvedArrayProperty;
 /**
  * Resolve enums and arrays for properties
@@ -52,7 +52,7 @@ export declare function resolveProperties<M extends Record<string, any>>({ prope
     entityId?: string;
     index?: number;
     fromBuilder?: boolean;
-    fields?: Record<string, FieldConfig>;
+    fields?: Record<string, PropertyConfig>;
 }): ResolvedProperties<M>;
 /**
  * Resolve enum aliases for a string or number property

package/dist/hooks/index.d.ts

@@ -18,3 +18,4 @@ export * from "./useBreadcrumbsContext";
 export * from "./useLargeLayout";
 export * from "./useReferenceDialog";
 export * from "./useBrowserTitleAndIcon";
+export * from "./useBuildDataSource";

package/dist/hooks/useBuildDataSource.d.ts

@@ -0,0 +1,23 @@
+import { DataSource, DataSourceDelegate, EntityReference, GeoPoint, PropertyConfig } from "../types";
+/**
+ * Use this hook to build a {@link DataSource} based on Firestore
+ * @param firebaseApp
+ * @param textSearchController
+ * @param collectionRegistry
+ * @category Firebase
+ */
+export declare function useBuildDataSource({ delegate, customFields }: {
+    delegate: DataSourceDelegate;
+    customFields: Record<string, PropertyConfig>;
+}): DataSource;
+/**
+ * Recursive function that converts Firestore data types into CMS or plain
+ * JS types.
+ * FireCMS uses Javascript dates internally instead of Firestore timestamps.
+ * This makes it easier to interact with the rest of the libraries and
+ * bindings.
+ * Also, Firestore references are replaced with {@link EntityReference}
+ * @param data
+ * @category Firestore
+ */
+export declare function cmsToDelegateModel(data: any, buildReference: (reference: EntityReference) => any, buildGeoPoint: (geoPoint: GeoPoint) => any, buildDate: (date: Date) => any, buildDelete: () => any): any;

package/dist/hooks/useDialogsController.d.ts

@@ -0,0 +1,11 @@
+import { DialogsController } from "../types/dialogs_controller";
+/**
+ * Use this hook to open a dialog imperatively.
+ * Alternatively, you can use dialogs declaratively using the `Dialog` component.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @category Hooks and utilities
+ */
+export declare const useDialogsController: () => DialogsController;