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

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

@@ -1,4 +1,4 @@
-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
@@ -58,7 +58,7 @@ export declare function buildAdditionalFieldDelegate<M extends Record<string, an
 /**
  * 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/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/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/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/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,4 +1,4 @@
-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>;
     path: string;
@@ -6,7 +6,7 @@ export declare const resolveCollection: <M extends Record<string, any>>({ collec
     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;