@firecms/core 3.0.0-canary.7 → 3.0.0-canary.8

package/README.md

@@ -82,7 +82,7 @@ data.
 
 ### ✨ Robust Forms
 
-![fields](https://firecms.co/img/post_editing.webp)
+![fields](https://firecms.co/img/form_editing.webp)
 
 When editing an entity, FireCMS offers a nested system of side dialogs for
 navigating through **subcollections** and accessing custom views (such as custom

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

@@ -15,7 +15,7 @@ import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionContro
  */
 export declare const EntityCollectionRowActions: ({ entity, collection, fullPath, width, frozen, isSelected, selectionEnabled, size, highlightEntity, onCollectionChange, unhighlightEntity, actions, hideId, selectionController, }: {
     entity: Entity<any>;
-    collection?: EntityCollection<any, import("../../types").User> | undefined;
+    collection?: EntityCollection<any, import("src/types/user").User> | undefined;
     fullPath?: string | undefined;
     width: number;
     frozen?: boolean | undefined;

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

@@ -1,4 +1,4 @@
-import React from "react";
+import { User } from "../../types";
 import { EntityCollectionTableProps } from "./EntityCollectionTableProps";
 /**
  * This component is in charge of rendering a collection table with a high
@@ -24,4 +24,4 @@ import { EntityCollectionTableProps } from "./EntityCollectionTableProps";
  * @see VirtualTable
  * @group Components
  */
-export declare const EntityCollectionTable: React.NamedExoticComponent<EntityCollectionTableProps<any>>;
+export declare const EntityCollectionTable: <M extends Record<string, any>, UserType extends User>({ forceFilter, actionsStart, actions, title, tableRowActionsBuilder, uniqueFieldValidator, getPropertyFor, onValueChange, selectionController, highlightedEntities, onEntityClick, onColumnResize, onSizeChanged, textSearchEnabled, hoverRow, inlineEditing, additionalFields, displayedColumnIds, defaultSize, properties, tableController, filterable, sortable, endAdornment, AddColumnComponent, AdditionalHeaderWidget, additionalIDHeaderWidget, emptyComponent, getIdColumnWidth, onTextSearchClick, textSearchLoading }: EntityCollectionTableProps<M>) => import("react/jsx-runtime").JSX.Element;

package/dist/components/EntityCollectionTable/PropertyTableCell.d.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { CMSType, Entity, ResolvedProperty } from "../../types";
 import { CustomFieldValidator } from "../../form/validation";
-export interface PropertyTableCellProps<T extends CMSType, M extends Record<string, any>> {
+export interface PropertyTableCellProps<T extends CMSType> {
     propertyKey: string;
     columnIndex: number;
     align: "right" | "left" | "center";
@@ -15,4 +15,4 @@ export interface PropertyTableCellProps<T extends CMSType, M extends Record<stri
     path: string;
     disabled: boolean;
 }
-export declare const PropertyTableCell: React.FunctionComponent<PropertyTableCellProps<any, any>>;
+export declare const PropertyTableCell: React.FunctionComponent<PropertyTableCellProps<any>>;

package/dist/components/EntityCollectionView/EntityCollectionView.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { Entity, EntityCollection, SelectionController } from "../../types";
+import { EntityCollection } from "../../types";
 /**
  * @group Components
  */
@@ -34,4 +34,3 @@ export type EntityCollectionViewProps<M extends Record<string, any>> = {
  * @group Components
  */
 export declare const EntityCollectionView: React.FunctionComponent<EntityCollectionViewProps<any>>;
-export declare function useSelectionController<M extends Record<string, any> = any>(onSelectionChange?: (entity: Entity<M>, selected: boolean) => void): SelectionController<M>;

package/dist/components/EntityCollectionView/useSelectionController.d.ts

@@ -0,0 +1,2 @@
+import { Entity, SelectionController } from "../../types";
+export declare function useSelectionController<M extends Record<string, any> = any>(onSelectionChange?: (entity: Entity<M>, selected: boolean) => void): SelectionController<M>;

package/dist/components/EntityPreview.d.ts

@@ -1,11 +1,29 @@
+import * as React from "react";
 import { Entity, EntityCollection } from "../types";
+import { PreviewSize } from "../preview";
+export type EntityPreviewProps = {
+    size: PreviewSize;
+    actions?: React.ReactNode;
+    collection?: EntityCollection;
+    hover?: boolean;
+    previewProperties?: string[];
+    disabled: undefined | boolean;
+    entity: Entity<any>;
+    includeEntityNavigation?: boolean;
+    onClick?: (e: React.SyntheticEvent) => void;
+};
 /**
- * @group Components
+ * This view is used to display a preview of an entity.
+ * It is used by default in reference fields and whenever a reference is displayed.
  */
-export interface EntityPreviewProps<M extends Record<string, any>> {
-    entity: Entity<M>;
-    collection: EntityCollection<M>;
-    path: string;
+export declare function EntityPreview({ actions, disabled, hover, collection: collectionProp, previewProperties, onClick, size, includeEntityNavigation, entity }: EntityPreviewProps): import("react/jsx-runtime").JSX.Element;
+type EntityPreviewContainerProps = {
+    children: React.ReactNode;
+    hover?: boolean;
+    size: PreviewSize;
     className?: string;
-}
-export declare function EntityPreview<M extends Record<string, any>>({ entity, collection, path, className }: EntityPreviewProps<M>): import("react/jsx-runtime").JSX.Element;
+    style?: React.CSSProperties;
+    onClick?: (e: React.SyntheticEvent) => void;
+};
+export declare const EntityPreviewContainer: React.FC<EntityPreviewContainerProps>;
+export {};

package/dist/components/EntityView.d.ts

@@ -0,0 +1,11 @@
+import { Entity, EntityCollection } from "../types";
+/**
+ * @group Components
+ */
+export interface EntityViewProps<M extends Record<string, any>> {
+    entity: Entity<M>;
+    collection: EntityCollection<M>;
+    path: string;
+    className?: string;
+}
+export declare function EntityView<M extends Record<string, any>>({ entity, collection, path, className }: EntityViewProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/FieldCaption.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+export declare function FieldCaption({ error, children }: {
+    error?: boolean;
+    children?: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/HomePage/NavigationCard.d.ts

@@ -0,0 +1,8 @@
+export type NavigationCardProps = {
+    name: string;
+    description?: string;
+    actions: React.ReactNode;
+    icon: React.ReactNode;
+    onClick?: () => void;
+};
+export declare function NavigationCard({ name, description, icon, actions, onClick, }: NavigationCardProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/HomePage/{NavigationCollectionCard.d.ts → NavigationCardBinding.d.ts}

@@ -1,7 +1,7 @@
 import { TopNavigationEntry } from "../../types";
 /**
  * This is the component used in the home page to render a card for each
- * collection.
+ * collection or view.
  * @group Components
  * @param view
  * @param path
@@ -12,6 +12,6 @@ import { TopNavigationEntry } from "../../types";
  * @param onClick
  * @constructor
  */
-export declare function NavigationCollectionCard({ view, path, collection, url, name, description, onClick }: TopNavigationEntry & {
+export declare function NavigationCardBinding({ path, collection, view, url, name, description, onClick, type }: TopNavigationEntry & {
     onClick?: () => void;
 }): import("react/jsx-runtime").JSX.Element;

package/dist/components/HomePage/SmallNavigationCard.d.ts

@@ -0,0 +1,6 @@
+export type SmallNavigationCardProps = {
+    name: string;
+    url: string;
+    icon: React.ReactElement;
+};
+export declare function SmallNavigationCard({ name, url, icon, }: SmallNavigationCardProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/HomePage/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./DefaultHomePage";
-export * from "./NavigationCollectionCard";
+export * from "./NavigationCardBinding";
 export * from "./NavigationGroup";
+export * from "./NavigationCard";
+export * from "./SmallNavigationCard";

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

@@ -207,7 +207,7 @@ export type VirtualTableSort = "asc" | "desc" | undefined;
 export type VirtualTableFilterValues<Key extends string> = Partial<Record<Key, [WhereFilterOp, any]>>;
 /**
  * Filter conditions in a `Query.where()` clause are specified using the
- * strings '<', '<=', '==', '>=', '>', 'array-contains', 'in', 'not-in', and 'array-contains-any'.
+ * strings `<`, `<=`, `==`, `>=`, `>`, `array-contains`, `in`, and `array-contains-any`.
  * @see Table
  * @group Models
  */

package/dist/components/index.d.ts

@@ -1,7 +1,7 @@
 export type { ErrorViewProps } from "./ErrorView";
 export { ErrorView } from "./ErrorView";
-export type { EntityPreviewProps } from "./EntityPreview";
-export { EntityPreview } from "./EntityPreview";
+export type { EntityViewProps } from "./EntityView";
+export { EntityView } from "./EntityView";
 export type { ReferenceSelectionInnerProps } from "./ReferenceTable/ReferenceSelectionTable";
 export { ReferenceSelectionTable } from "./ReferenceTable/ReferenceSelectionTable";
 export { CircularProgressCenter } from "./CircularProgressCenter";
@@ -10,6 +10,7 @@ export * from "./HomePage";
 export * from "./SelectableTable/SelectableTable";
 export * from "./EntityCollectionView/EntityCollectionView";
 export * from "./EntityCollectionView/EntityCollectionViewActions";
+export * from "./EntityCollectionView/useSelectionController";
 export * from "./PropertyConfigBadge";
 export * from "./EntityCollectionTable";
 export * from "./NotFoundPage";
@@ -21,3 +22,4 @@ export * from "./FireCMSAppBar";
 export * from "./ArrayContainer";
 export * from "./ReferenceWidget";
 export * from "./SearchIconsView";
+export * from "./FieldCaption";

package/dist/core/{EntityView.d.ts → EntityEditView.d.ts}

@@ -1,5 +1,5 @@
 import { Entity, EntityCollection, User } from "../types";
-export interface EntityViewProps<M extends Record<string, any>> {
+export interface EntityEditViewProps<M extends Record<string, any>> {
     path: string;
     collection: EntityCollection<M>;
     entityId?: string;
@@ -19,4 +19,4 @@ export interface EntityViewProps<M extends Record<string, any>> {
  * You probably don't want to use this view directly since it is bound to the
  * side panel. Instead, you might want to use {@link EntityForm} or {@link EntityCollectionView}
  */
-export declare function EntityView<M extends Record<string, any>, UserType extends User>({ path, entityId, selectedSubPath, copy, collection, parentCollectionIds, onValuesAreModified, formWidth, onUpdate, onClose }: EntityViewProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function EntityEditView<M extends Record<string, any>, UserType extends User>({ path, entityId, selectedSubPath, copy, collection, parentCollectionIds, onValuesAreModified, formWidth, onUpdate, onClose, }: EntityEditViewProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/core/SideEntityView.d.ts

@@ -1,6 +1,6 @@
-import { EntityViewProps } from "./EntityView";
 import { User } from "../types";
-export type SideEntityViewProps<M extends Record<string, any>> = EntityViewProps<M> & {
+import { EntityEditViewProps } from "./EntityEditView";
+export type SideEntityViewProps<M extends Record<string, any>> = EntityEditViewProps<M> & {
     formWidth?: number | string;
     onClose?: () => void;
 };

package/dist/form/EntityForm.d.ts

@@ -72,6 +72,6 @@ export type EntityFormSaveParams<M extends Record<string, any>> = {
  * @group Components
  */
 export declare const EntityForm: typeof EntityFormInternal;
-declare function EntityFormInternal<M extends Record<string, any>>({ status, path, collection: inputCollection, entity, onEntitySaveRequested, onDiscard, onModified, onValuesChanged, onIdChange, onFormContextChange, hideId, autoSave, onIdUpdateError }: EntityFormProps<M>): import("react/jsx-runtime").JSX.Element;
+declare function EntityFormInternal<M extends Record<string, any>>({ status, path, collection: inputCollection, entity, onEntitySaveRequested, onDiscard, onModified, onValuesChanged, onIdChange, onFormContextChange, hideId, autoSave, onIdUpdateError, }: EntityFormProps<M>): import("react/jsx-runtime").JSX.Element;
 export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;
 export {};

package/dist/form/components/StorageItemPreview.d.ts

@@ -1,4 +1,4 @@
-import { Entity, ResolvedStringProperty } from "../../types";
+import { Entity, EntityCollection, ResolvedStringProperty } from "../../types";
 import { PreviewSize } from "../../preview";
 interface StorageItemPreviewProps {
     name: string;
@@ -8,6 +8,7 @@ interface StorageItemPreviewProps {
     onRemove: (value: string) => void;
     size: PreviewSize;
     disabled: boolean;
+    collection: EntityCollection;
 }
-export declare function StorageItemPreview({ name, property, value, entity, onRemove, disabled, size }: StorageItemPreviewProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageItemPreview({ name, property, value, entity, onRemove, disabled, size, collection }: StorageItemPreviewProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/components/StorageUploadProgress.d.ts

@@ -7,4 +7,4 @@ export interface StorageUploadItemProps {
     imageSize: number;
     simple: boolean;
 }
-export declare function StorageUploadProgress({ storagePath, entry, metadata, onFileUploadComplete, imageSize, simple }: StorageUploadItemProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageUploadProgress({ storagePath, entry, metadata, onFileUploadComplete, imageSize, simple, }: StorageUploadItemProps): import("react/jsx-runtime").JSX.Element;

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

@@ -4,4 +4,4 @@ import { FieldProps } from "../../types";
  *
  * @group Form fields
  */
-export declare function KeyValueFieldBinding<T extends Record<string, any>>({ propertyKey, value, showError, error, disabled, property, setValue, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function KeyValueFieldBinding({ propertyKey, value, showError, error, disabled, property, setValue, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;

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

@@ -6,4 +6,4 @@ import { FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function MapFieldBinding<T extends Record<string, any>>({ propertyKey, value, showError, error, disabled, property, setValue, partOfBlock, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function MapFieldBinding({ propertyKey, value, showError, error, disabled, property, setValue, partOfBlock, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,4 @@
-import { Entity, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
+import { Entity, EntityCollection, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
 import { StorageFieldItem } from "../../util/useStorageUploadController";
 type StorageUploadFieldProps = FieldProps<string | string[]>;
 /**
@@ -8,9 +8,10 @@ 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, tableMode, 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[]>;
@@ -24,5 +25,5 @@ export interface StorageUploadProps {
     storagePathBuilder: (file: File) => string;
     onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, fileMetadata?: any) => Promise<void>;
 }
-export declare function StorageUpload({ property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, entity, storagePathBuilder }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
+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 {};

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

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

package/dist/form/validation.d.ts

@@ -21,5 +21,5 @@ interface PropertyContext<T extends CMSType> {
 }
 export declare function getYupEntitySchema<M extends Record<string, any>>(entityId: string, properties: ResolvedProperties<M>, customFieldValidator?: CustomFieldValidator): ObjectSchema<any>;
 export declare function mapPropertyToYup<T extends CMSType>(propertyContext: PropertyContext<T>): AnySchema<unknown>;
-export declare function getYupMapObjectSchema<M extends Record<string, any>>({ property, entityId, customFieldValidator, name }: PropertyContext<M>): ObjectSchema<any>;
+export declare function getYupMapObjectSchema({ property, entityId, customFieldValidator, name }: PropertyContext<Record<string, any>>): ObjectSchema<any>;
 export {};

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

@@ -1,6 +1,6 @@
-import { DataSource } from "../../types";
+import { DataSource, EntityCollection } from "../../types";
 /**
  * Use this hook to get the datasource being used
  * @group Hooks and utilities
  */
-export declare const useDataSource: () => DataSource;
+export declare const useDataSource: (collection?: EntityCollection) => DataSource;

package/dist/hooks/useBuildNavigationController.d.ts

@@ -1,10 +1,13 @@
-import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, User, UserConfigurationPersistence } from "../types";
+import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
 type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
     basePath?: string;
     baseCollectionPath?: string;
     authController: AuthController<UserType>;
     collections?: EC[] | EntityCollectionsBuilder<EC>;
+    collectionPermissions?: PermissionsBuilder;
     views?: CMSView[] | CMSViewsBuilder;
+    adminViews?: CMSView[] | CMSViewsBuilder;
+    viewsOrder?: string[];
     userConfigPersistence?: UserConfigurationPersistence;
     dataSourceDelegate: DataSourceDelegate;
     /**
@@ -16,6 +19,6 @@ type BuildNavigationContextProps<EC extends EntityCollection, UserType extends U
      */
     injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
 };
-export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>({ basePath, baseCollectionPath, authController, collections: collectionsProp, views: baseViews, userConfigPersistence, dataSourceDelegate, injectCollections }: BuildNavigationContextProps<EC, UserType>): NavigationController;
+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 {};

package/dist/hooks/useProjectLog.d.ts

@@ -1,4 +1,8 @@
 import { AuthController } 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 declare function useProjectLog(authController: AuthController): void;
+export type AccessResponse = {
+    blocked?: boolean;
+    message?: string;
+};
+export declare function useProjectLog(authController: AuthController): AccessResponse | null;

package/dist/hooks/useStorageSource.d.ts

@@ -1,6 +1,6 @@
-import { StorageSource } from "../types";
+import { EntityCollection, StorageSource } from "../types";
 /**
  * Use this hook to get the storage source being used
  * @group Hooks and utilities
  */
-export declare const useStorageSource: () => StorageSource;
+export declare const useStorageSource: (collection?: EntityCollection) => StorageSource;