@firecms/core 3.0.0-3.0.0-beta.4.pre.1.0

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

@@ -0,0 +1,36 @@
+import React from "react";
+import { EntityCollection } from "../../types";
+/**
+ * @group Components
+ */
+export type EntityCollectionViewProps<M extends Record<string, any>> = {
+    fullPath: string;
+    parentCollectionIds?: string[];
+    isSubCollection?: boolean;
+    className?: string;
+} & EntityCollection<M>;
+/**
+ * This component is in charge of binding a datasource path with an {@link EntityCollection}
+ * where it's configuration is defined. It includes an infinite scrolling table
+ * and a 'Add' new entities button,
+ *
+ * This component is the default one used for displaying entity collections
+ * and is in charge of generating all the specific actions and customization
+ * of the lower level {@link EntityCollectionTable}
+ *
+ * Please **note** that you only need to use this component if you are building
+ * a custom view. If you just need to create a default view you can do it
+ * exclusively with config options.
+ *
+ * If you need a lower level implementation with more granular options, you
+ * can use {@link EntityCollectionTable}.
+ *
+ * If you need a generic table that is not bound to the datasource or entities and
+ * properties at all, you can check {@link VirtualTable}
+ *
+ * @param fullPath
+ * @param collection
+ * @constructor
+ * @group Components
+ */
+export declare const EntityCollectionView: React.FunctionComponent<EntityCollectionViewProps<any>>;

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

@@ -0,0 +1,14 @@
+import { EntityCollection, EntityTableController, SelectionController } from "../../types";
+export type EntityCollectionViewActionsProps<M extends Record<string, any>> = {
+    collection: EntityCollection<M>;
+    path: string;
+    relativePath: string;
+    parentCollectionIds: string[];
+    selectionEnabled: boolean;
+    onNewClick: () => void;
+    onMultipleDeleteClick: () => void;
+    selectionController: SelectionController<M>;
+    tableController: EntityTableController<M>;
+    collectionEntitiesCount: number;
+};
+export declare function EntityCollectionViewActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, onNewClick, onMultipleDeleteClick, selectionEnabled, path, selectionController, tableController, collectionEntitiesCount }: EntityCollectionViewActionsProps<M>): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +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;
+};
+/**
+ * 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 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;
+    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/ErrorBoundary.d.ts

@@ -0,0 +1,11 @@
+import React, { ErrorInfo, PropsWithChildren } from "react";
+export declare class ErrorBoundary extends React.Component<PropsWithChildren<Record<string, unknown>>, {
+    error: Error | null;
+}> {
+    constructor(props: any);
+    static getDerivedStateFromError(error: Error): {
+        error: Error;
+    };
+    componentDidCatch(error: Error, errorInfo: ErrorInfo): void;
+    render(): string | number | boolean | Iterable<React.ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
+}

package/dist/components/ErrorTooltip.d.ts

@@ -0,0 +1,2 @@
+import { TooltipProps } from "@firecms/ui";
+export declare function ErrorTooltip(props: TooltipProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/ErrorView.d.ts

@@ -0,0 +1,19 @@
+import React from "react";
+/**
+ * @group Components
+ */
+export interface ErrorViewProps {
+    title?: string;
+    error: Error | React.ReactElement | string;
+    tooltip?: string;
+}
+/**
+ * Generic error view. Displayed for example when an unexpected value comes
+ * from the datasource in a collection view.
+ * @param title
+ * @param error
+ * @param tooltip
+ * @constructor
+ * @group Components
+ */
+export declare function ErrorView({ title, error, tooltip }: ErrorViewProps): React.ReactElement;

package/dist/components/FieldCaption.d.ts

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

package/dist/components/FireCMSAppBar.d.ts

@@ -0,0 +1,26 @@
+import React from "react";
+import { User } from "../types";
+export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
+    title: string;
+    /**
+     * A component that gets rendered on the upper side of the main toolbar
+     */
+    endAdornment?: React.ReactNode;
+    startAdornment?: React.ReactNode;
+    dropDownActions?: React.ReactNode;
+    includeDrawer?: boolean;
+    drawerOpen: boolean;
+    className?: string;
+    style?: React.CSSProperties;
+    user?: User;
+} & ADDITIONAL_PROPS;
+/**
+ * This component renders the main app bar of FireCMS.
+ * You will likely not need to use this component directly.
+ *
+ * @param title
+ * @param toolbarExtraWidget
+ * @param drawerOpen
+ * @constructor
+ */
+export declare const FireCMSAppBar: ({ title, endAdornment, startAdornment, drawerOpen, dropDownActions, includeDrawer, className, style, user: userProp }: FireCMSAppBarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/FireCMSLogo.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+export declare function FireCMSLogo({ width, height, className, style }: {
+    width?: string;
+    height?: string;
+    className?: string;
+    style?: React.CSSProperties;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,21 @@
+import React from "react";
+/**
+ * Default entry view for the CMS. This component renders navigation cards
+ * for each collection defined in the navigation.
+ * @constructor
+ * @group Components
+ */
+export declare function DefaultHomePage({ additionalActions, additionalChildrenStart, additionalChildrenEnd }: {
+    /**
+     * Additional actions to be rendered in the home page, close to the search bar.
+     */
+    additionalActions?: React.ReactNode;
+    /**
+     * Additional children to be rendered in the beginning of the home page.
+     */
+    additionalChildrenStart?: React.ReactNode;
+    /**
+     * Additional children to be rendered at the end of the home page.
+     */
+    additionalChildrenEnd?: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,3 @@
+export declare function FavouritesView({ hidden }: {
+    hidden: boolean;
+}): 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/NavigationCardBinding.d.ts

@@ -0,0 +1,17 @@
+import { TopNavigationEntry } from "../../types";
+/**
+ * This is the component used in the home page to render a card for each
+ * collection or view.
+ * @group Components
+ * @param view
+ * @param path
+ * @param collection
+ * @param url
+ * @param name
+ * @param description
+ * @param onClick
+ * @constructor
+ */
+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/NavigationGroup.d.ts

@@ -0,0 +1,4 @@
+import { PropsWithChildren } from "react";
+export declare function NavigationGroup({ children, group }: PropsWithChildren<{
+    group: string | undefined;
+}>): 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

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

package/dist/components/NotFoundPage.d.ts

@@ -0,0 +1 @@
+export declare function NotFoundPage(): import("react/jsx-runtime").JSX.Element;

package/dist/components/PropertyConfigBadge.d.ts

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

package/dist/components/PropertyIdCopyTooltipContent.d.ts

@@ -0,0 +1,3 @@
+export declare function PropertyIdCopyTooltipContent({ propertyId }: {
+    propertyId: string;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/ReferenceTable/ReferenceSelectionTable.d.ts

@@ -0,0 +1,58 @@
+import React from "react";
+import { Entity, EntityCollection, FilterValues } from "../../types";
+/**
+ * @group Components
+ */
+export interface ReferenceSelectionInnerProps<M extends Record<string, any>> {
+    /**
+     * Allow multiple selection of values
+     */
+    multiselect?: boolean;
+    /**
+     * Entity collection config
+     */
+    collection?: EntityCollection<M>;
+    /**
+     * Absolute path of the collection.
+     * May be not set if this hook is being used in a component and the path is
+     * dynamic. If not set, the dialog won't open.
+     */
+    path: string;
+    /**
+     * If you are opening the dialog for the first time, you can select some
+     * entity ids to be displayed first.
+     */
+    selectedEntityIds?: string[];
+    /**
+     * If `multiselect` is set to `false`, you will get the selected entity
+     * in this callback.
+     * @param entity
+     * @callback
+     */
+    onSingleEntitySelected?(entity: Entity<any> | null): void;
+    /**
+     * If `multiselect` is set to `true`, you will get the selected entities
+     * in this callback.
+     * @param entities
+     * @callback
+     */
+    onMultipleEntitiesSelected?(entities: Entity<any>[]): void;
+    /**
+     * Allow selection of entities that pass the given filter only.
+     */
+    forceFilter?: FilterValues<string>;
+    /**
+     * Use this description to indicate the user what to do in this dialog.
+     */
+    description?: React.ReactNode;
+    /**
+     * Maximum number of entities that can be selected.
+     */
+    maxSelection?: number;
+}
+/**
+ * This component allows to select entities from a given collection.
+ * You probably want to open this dialog as a side view using {@link useReferenceDialog}
+ * @group Components
+ */
+export declare function ReferenceSelectionTable<M extends Record<string, any>>({ onSingleEntitySelected, onMultipleEntitiesSelected, multiselect, collection, path: pathInput, selectedEntityIds: selectedEntityIdsProp, description, forceFilter, maxSelection, }: ReferenceSelectionInnerProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/ReferenceWidget.d.ts

@@ -0,0 +1,28 @@
+import { Entity, EntityReference, FilterValues } from "../types";
+import { PreviewSize } from "../preview";
+export type ReferenceWidgetProps<M extends Record<string, any>> = {
+    name?: string;
+    multiselect?: boolean;
+    value: EntityReference | EntityReference[] | null;
+    onReferenceSelected?: (params: {
+        reference: EntityReference | null;
+        entity: Entity<M> | null;
+    }) => void;
+    onMultipleReferenceSelected?: (params: {
+        references: EntityReference[] | null;
+        entities: Entity<M>[] | null;
+    }) => void;
+    path: string;
+    disabled?: boolean;
+    previewProperties?: string[];
+    /**
+     * Allow selection of entities that pass the given filter only.
+     */
+    forceFilter?: FilterValues<string>;
+    size: PreviewSize;
+    className?: string;
+};
+/**
+ * This field allows selecting reference/s.
+ */
+export declare function ReferenceWidget<M extends Record<string, any>>({ name, multiselect, path, disabled, value, onReferenceSelected, onMultipleReferenceSelected, previewProperties, forceFilter, size, className }: ReferenceWidgetProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/SearchIconsView.d.ts

@@ -0,0 +1,5 @@
+export interface SearchIconsProps {
+    selectedIcon?: string;
+    onIconSelected?: (icon: string) => void;
+}
+export declare function SearchIconsView({ selectedIcon, onIconSelected }: SearchIconsProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/SelectableTable/SelectableTable.d.ts

@@ -0,0 +1,75 @@
+import React from "react";
+import { CollectionSize, Entity, EntityTableController, FilterValues } from "../../types";
+import { CellRendererParams, VirtualTableColumn } from "../VirtualTable";
+import { OnCellValueChange, OnColumnResizeParams } from "../common/types";
+export type SelectableTableProps<M extends Record<string, any>> = {
+    /**
+     * Callback when a cell value changes.
+     */
+    onValueChange?: OnCellValueChange<any, M>;
+    columns: VirtualTableColumn[];
+    cellRenderer: React.ComponentType<CellRendererParams<Entity<M>>>;
+    /**
+     * Builder for creating the buttons in each row
+     * @param entity
+     * @param size
+     */
+    tableRowActionsBuilder?: (params: {
+        entity: Entity<M>;
+        size: CollectionSize;
+        width: number;
+        frozen?: boolean;
+    }) => React.ReactNode;
+    /**
+     * Callback when anywhere on the table is clicked
+     */
+    onEntityClick?(entity: Entity<M>): void;
+    /**
+     * Callback when a column is resized
+     */
+    onColumnResize?(params: OnColumnResizeParams): void;
+    /**
+     * Should apply a different style to a row when hovering
+     */
+    hoverRow?: boolean;
+    /**
+     * Controller holding the logic for the table
+     * {@link useDataSourceEntityCollectionTableController}
+     * {@link EntityTableController}
+     */
+    tableController: EntityTableController<M>;
+    filterable?: boolean;
+    sortable?: boolean;
+    inlineEditing?: boolean;
+    forceFilter?: FilterValues<keyof M extends string ? keyof M : never>;
+    highlightedRow?: (data: Entity<M>) => boolean;
+    size?: CollectionSize;
+    emptyComponent?: React.ReactNode;
+    endAdornment?: React.ReactNode;
+    AddColumnComponent?: React.ComponentType;
+};
+/**
+ * This component is in charge of rendering a collection table with a high
+ * degree of customization.
+ *
+ * This component is used internally by {@link EntityCollectionView} and
+ * {@link useReferenceDialog}
+ *
+ * Please note that you only need to use this component if you are building
+ * a custom view. If you just need to create a default view you can do it
+ * exclusively with config options.
+ *
+ * If you want to bind a {@link EntityCollection} to a table with the default
+ * options you see in collections in the top level navigation, you can
+ * check {@link EntityCollectionView}.
+ *
+ * The data displayed in the table is managed by a {@link EntityTableController}.
+ * You can build the default, bound to a path in the datasource, by using the hook
+ * {@link useDataSourceEntityCollectionTableController}
+ *
+ * @see EntityCollectionTableProps
+ * @see EntityCollectionView
+ * @see VirtualTable
+ * @group Components
+ */
+export declare const SelectableTable: React.NamedExoticComponent<SelectableTableProps<any>>;

package/dist/components/SelectableTable/SelectableTableContext.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { EntityCollectionTableController } from "../common/types";
+export declare const SelectableTableContext: React.Context<EntityCollectionTableController<any>>;
+export declare const useSelectableTableController: () => EntityCollectionTableController<any>;

package/dist/components/SelectableTable/filters/BooleanFilterField.d.ts

@@ -0,0 +1,9 @@
+import { VirtualTableWhereFilterOp } from "../../VirtualTable";
+interface BooleanFieldProps {
+    name: string;
+    value?: [op: VirtualTableWhereFilterOp, fieldValue: any];
+    setValue: (value?: [op: VirtualTableWhereFilterOp, newValue: any]) => void;
+    title?: string;
+}
+export declare function BooleanFilterField({ name, title, value, setValue }: BooleanFieldProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/SelectableTable/filters/DateTimeFilterField.d.ts

@@ -0,0 +1,11 @@
+import { VirtualTableWhereFilterOp } from "../../VirtualTable";
+interface DateTimeFilterFieldProps {
+    name: string;
+    mode?: "date" | "date_time";
+    value?: [op: VirtualTableWhereFilterOp, fieldValue: any];
+    setValue: (value?: [op: VirtualTableWhereFilterOp, newValue: any]) => void;
+    isArray?: boolean;
+    title?: string;
+}
+export declare function DateTimeFilterField({ name, isArray, mode, value, setValue, title }: DateTimeFilterFieldProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/SelectableTable/filters/ReferenceFilterField.d.ts

@@ -0,0 +1,14 @@
+import { VirtualTableWhereFilterOp } from "../../VirtualTable";
+interface ReferenceFilterFieldProps {
+    name: string;
+    value?: [op: VirtualTableWhereFilterOp, fieldValue: any];
+    setValue: (filterValue?: [VirtualTableWhereFilterOp, any]) => void;
+    isArray?: boolean;
+    path?: string;
+    title?: string;
+    previewProperties?: string[];
+    hidden: boolean;
+    setHidden: (hidden: boolean) => void;
+}
+export declare function ReferenceFilterField({ name, value, setValue, isArray, path, title, previewProperties, setHidden }: ReferenceFilterFieldProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/SelectableTable/filters/StringNumberFilterField.d.ts

@@ -0,0 +1,13 @@
+import { VirtualTableWhereFilterOp } from "../../VirtualTable";
+import { EnumValueConfig } from "../../../types";
+interface StringNumberFilterFieldProps {
+    name: string;
+    dataType: "string" | "number";
+    value?: [op: VirtualTableWhereFilterOp, fieldValue: any];
+    setValue: (value?: [op: VirtualTableWhereFilterOp, newValue: any]) => void;
+    isArray?: boolean;
+    enumValues?: EnumValueConfig[];
+    title?: string;
+}
+export declare function StringNumberFilterField({ name, value, setValue, dataType, isArray, enumValues, title }: StringNumberFilterFieldProps): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -0,0 +1,11 @@
+import React from "react";
+import { VirtualTableProps } from "./VirtualTableProps";
+/**
+ * This is a Table component that allows displaying arbitrary data, not
+ * necessarily related to entities or properties. It is the component
+ * that powers the entity collections but has a generic API, so it
+ * can be reused.
+ *
+ * @group Components
+ */
+export declare const VirtualTable: React.NamedExoticComponent<VirtualTableProps<any>>;

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

@@ -0,0 +1,14 @@
+import React from "react";
+import { CellRendererParams, VirtualTableColumn } from "./VirtualTableProps";
+type VirtualTableCellProps<T extends any> = {
+    dataKey: string;
+    column: VirtualTableColumn;
+    columns: VirtualTableColumn[];
+    rowData: any;
+    cellData: any;
+    rowIndex: any;
+    columnIndex: number;
+    cellRenderer: React.ComponentType<CellRendererParams<T>>;
+};
+export declare const VirtualTableCell: React.NamedExoticComponent<VirtualTableCellProps<any>>;
+export {};

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

@@ -0,0 +1,27 @@
+import React, { RefObject } from "react";
+import { VirtualTableColumn, VirtualTableSort, VirtualTableWhereFilterOp } from "./VirtualTableProps";
+export type FilterFormFieldProps<CustomProps> = {
+    id: React.Key;
+    filterValue: [VirtualTableWhereFilterOp, any] | undefined;
+    setFilterValue: (filterValue?: [VirtualTableWhereFilterOp, any]) => void;
+    column: VirtualTableColumn<CustomProps>;
+    hidden: boolean;
+    setHidden: (hidden: boolean) => void;
+};
+type VirtualTableHeaderProps<M extends Record<string, any>> = {
+    resizeHandleRef: RefObject<HTMLDivElement>;
+    columnIndex: number;
+    isResizingIndex: number;
+    column: VirtualTableColumn<any>;
+    onColumnSort: (key: Extract<keyof M, string>) => void;
+    filter?: [VirtualTableWhereFilterOp, any];
+    sort: VirtualTableSort;
+    onFilterUpdate: (column: VirtualTableColumn, filterForProperty?: [VirtualTableWhereFilterOp, any]) => void;
+    onClickResizeColumn?: (columnIndex: number, column: VirtualTableColumn) => void;
+    createFilterField?: (props: FilterFormFieldProps<any>) => React.ReactNode;
+    AdditionalHeaderWidget?: (props: {
+        onHover: boolean;
+    }) => React.ReactNode;
+};
+export declare const VirtualTableHeader: React.FunctionComponent<VirtualTableHeaderProps<any>>;
+export {};

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

@@ -0,0 +1,2 @@
+import { VirtualTableContextProps } from "./types";
+export declare const VirtualTableHeaderRow: ({ columns, currentSort, onColumnSort, onFilterUpdate, sortByProperty, filter, onColumnResize, onColumnResizeEnd, createFilterField, AddColumnComponent }: VirtualTableContextProps<any>) => import("react/jsx-runtime").JSX.Element;