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

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

@@ -0,0 +1,214 @@
+import React from "react";
+import { WhereFilterOp } from "../../types";
+import { FilterFormFieldProps } from "./VirtualTableHeader";
+export type OnRowClickParams<T extends Record<string, any>> = {
+    rowData: T;
+    rowIndex: number;
+    event: React.SyntheticEvent;
+};
+/**
+ * @see Table
+ * @group Components
+ */
+export interface VirtualTableProps<T extends Record<string, any>> {
+    /**
+     * Array of arbitrary data
+     */
+    data?: T[];
+    /**
+     * Properties displayed in this collection. If this property is not set
+     * every property is displayed, you can filter
+     */
+    columns: VirtualTableColumn[];
+    /**
+     * Custom cell renderer
+     * The renderer receives props `{ cellData, columns, column, columnIndex, rowData, rowIndex, container, isScrolling }`
+     */
+    cellRenderer: React.ComponentType<CellRendererParams<T>>;
+    /**
+     * If enabled, content is loaded in batch
+     */
+    paginationEnabled?: boolean;
+    /**
+     * Set this callback if you want to support some combinations
+     * of filter combinations only.
+     * @param filterValues
+     * @param sortBy
+     */
+    checkFilterCombination?: (filterValues: VirtualTableFilterValues<Extract<keyof T, string>>, sortBy?: [string, "asc" | "desc"]) => boolean;
+    /**
+     * A callback function when scrolling the table to near the end
+     */
+    onEndReached?: () => void;
+    /**
+     * When the pagination should be reset. E.g. the filters or sorting
+     * has been reset.
+     */
+    onResetPagination?: () => void;
+    /**
+     * Callback when a row is clicked
+     */
+    onRowClick?: (props: OnRowClickParams<T>) => void;
+    /**
+     * Callback when a column is resized
+     */
+    onColumnResize?: (params: OnVirtualTableColumnResizeParams) => void;
+    /**
+     * Size of the table
+     */
+    size?: VirtualTableSize;
+    /**
+     * In case this table should have some filters set by default
+     */
+    filter?: VirtualTableFilterValues<any>;
+    /**
+     * Callback used when filters are updated
+     * @param filter
+     */
+    onFilterUpdate?: (filter?: VirtualTableFilterValues<any> | undefined) => void;
+    /**
+     * Default sort applied to this collection
+     */
+    sortBy?: [string, "asc" | "desc"];
+    /**
+     * Callback used when sorting is updated
+     * @param sortBy
+     */
+    onSortByUpdate?: (sortBy?: [string, "asc" | "desc"]) => void;
+    /**
+     * If there is an error loading data you can pass it here, so it gets
+     * displayed instead of the content
+     */
+    error?: Error;
+    /**
+     * Message displayed when there is no data
+     */
+    emptyComponent?: React.ReactNode;
+    /**
+     * Is the table in a loading state
+     */
+    loading?: boolean;
+    /**
+     * Should apply a different style when hovering
+     */
+    hoverRow?: boolean;
+    /**
+     * Apply a custom class name to the row
+     * @param rowData
+     */
+    rowClassName?: (rowData: T) => string | undefined;
+    /**
+     * Callback to create a filter field, displayed in the header as a dropdown
+     * @param props
+     */
+    createFilterField?: (props: FilterFormFieldProps<any>) => React.ReactNode;
+    /**
+     * Class name applied to the table
+     */
+    className?: string;
+    /**
+     * Component rendered at the end of the table, after scroll
+     */
+    endAdornment?: React.ReactNode;
+    /**
+     * If adding this callback, a button to add a new column is displayed.
+     * @param column
+     */
+    AddColumnComponent?: React.ComponentType;
+}
+export type CellRendererParams<T extends any = any> = {
+    column: VirtualTableColumn;
+    columns: VirtualTableColumn[];
+    columnIndex: number;
+    rowData?: T;
+    rowIndex: number;
+    width: number;
+    isScrolling?: boolean;
+};
+/**
+ * @see Table
+ * @group Components
+ */
+export interface VirtualTableColumn<CustomProps extends any = any> {
+    /**
+     * Data key for the cell value, could be "a.b.c"
+     */
+    key: string;
+    /**
+     * The width of the column, gutter width is not included
+     */
+    width: number;
+    /**
+     * Label displayed in the header
+     */
+    title?: string;
+    /**
+     * This column is frozen to the left
+     */
+    frozen?: boolean;
+    /**
+     * How is the
+     */
+    headerAlign?: "left" | "center" | "right";
+    /**
+     * Icon displayed in the header
+     */
+    icon?: React.ReactNode;
+    /**
+     *
+     */
+    filter?: boolean;
+    /**
+     * Alignment of the column cell
+     */
+    align?: "left" | "right" | "center";
+    /**
+     * Whether the column is sortable, defaults to false
+     */
+    sortable?: boolean;
+    /**
+     * Can it be resized
+     */
+    resizable?: boolean;
+    /**
+     * Custom props passed to the cell renderer
+     */
+    custom?: CustomProps;
+    /**
+     * Additional children to be rendered in the header when hovering
+     */
+    AdditionalHeaderWidget?: (props: {
+        onHover: boolean;
+    }) => React.ReactNode;
+}
+/**
+ * @see Table
+ * @group Collection components
+ */
+export type OnVirtualTableColumnResizeParams = {
+    width: number;
+    key: string;
+    column: VirtualTableColumn;
+};
+/**
+ * @see Table
+ * @group Components
+ */
+export type VirtualTableSize = "xs" | "s" | "m" | "l" | "xl";
+/**
+ * @see Table
+ * @group Components
+ */
+export type VirtualTableSort = "asc" | "desc" | undefined;
+/**
+ * @see Table
+ * @group Components
+ */
+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`, and `array-contains-any`.
+ * @see Table
+ * @group Models
+ */
+export type VirtualTableWhereFilterOp = "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";

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

@@ -0,0 +1,3 @@
+import React from "react";
+import { VirtualTableRowProps } from "./types";
+export declare const VirtualTableRow: React.NamedExoticComponent<VirtualTableRowProps<any>>;

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

@@ -0,0 +1,2 @@
+import { VirtualTableSize } from "./VirtualTableProps";
+export declare function getRowHeight(size: VirtualTableSize): number;

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

@@ -0,0 +1,11 @@
+import React from "react";
+export declare function VirtualTableDateField(props: {
+    name: string;
+    error: Error | undefined;
+    mode?: "date" | "date_time";
+    internalValue: Date | undefined | null;
+    updateValue: (newValue: (Date | null)) => void;
+    focused: boolean;
+    disabled: boolean;
+    onBlur?: React.FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,8 @@
+export declare function VirtualTableInput(props: {
+    error: Error | undefined;
+    value: string;
+    multiline: boolean;
+    focused: boolean;
+    disabled: boolean;
+    updateValue: (newValue: (string | null)) => void;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,8 @@
+export declare function VirtualTableNumberInput(props: {
+    error: Error | undefined;
+    value: number;
+    align: "right" | "left" | "center";
+    updateValue: (newValue: (number | null)) => void;
+    focused: boolean;
+    disabled: boolean;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,15 @@
+import { EnumValueConfig } from "../../../types";
+import React from "react";
+export declare function VirtualTableSelect(props: {
+    name: string;
+    enumValues: EnumValueConfig[];
+    error: Error | undefined;
+    multiple: boolean;
+    disabled: boolean;
+    small: boolean;
+    internalValue: string | number | string[] | number[] | undefined;
+    valueType: "string" | "number";
+    updateValue: (newValue: (string | number | string[] | number[] | null)) => void;
+    focused: boolean;
+    onBlur?: React.FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,7 @@
+export declare function VirtualTableSwitch(props: {
+    error: Error | undefined;
+    internalValue?: boolean;
+    focused: boolean;
+    disabled: boolean;
+    updateValue: (newValue: (boolean | null)) => void;
+}): import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,2 @@
+export { VirtualTable } from "./VirtualTable";
+export * from "./VirtualTableProps";

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

@@ -0,0 +1,34 @@
+import React from "react";
+import { CellRendererParams, OnRowClickParams, OnVirtualTableColumnResizeParams, VirtualTableColumn, VirtualTableFilterValues, VirtualTableSize, VirtualTableWhereFilterOp } from "./VirtualTableProps";
+import { FilterFormFieldProps } from "./VirtualTableHeader";
+export type VirtualTableRowProps<T> = {
+    style: any;
+    size: VirtualTableSize;
+    rowData: T;
+    rowIndex: number;
+    onRowClick?: (props: OnRowClickParams<any>) => void;
+    children: React.ReactNode[];
+    columns: VirtualTableColumn[];
+    hoverRow?: boolean;
+    rowClassName?: (rowData: T) => string | undefined;
+};
+export type VirtualTableContextProps<T extends any> = {
+    data?: T[];
+    size?: VirtualTableSize;
+    columns: VirtualTableColumn[];
+    cellRenderer: React.ComponentType<CellRendererParams<T>>;
+    currentSort: "asc" | "desc" | undefined;
+    filter?: VirtualTableFilterValues<any>;
+    onRowClick?: (props: OnRowClickParams<any>) => void;
+    onColumnSort: (key: string) => any;
+    onColumnResize: (params: OnVirtualTableColumnResizeParams) => void;
+    onColumnResizeEnd: (params: OnVirtualTableColumnResizeParams) => void;
+    onFilterUpdate: (column: VirtualTableColumn, filterForProperty?: [VirtualTableWhereFilterOp, any]) => void;
+    sortByProperty?: string;
+    customView?: React.ReactNode;
+    hoverRow: boolean;
+    createFilterField?: (props: FilterFormFieldProps<any>) => React.ReactNode;
+    rowClassName?: (rowData: T) => string | undefined;
+    endAdornment?: React.ReactNode;
+    AddColumnComponent?: React.ComponentType;
+};

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

@@ -0,0 +1,5 @@
+export * from "./types";
+export * from "./useDebouncedData";
+export * from "./useColumnsIds";
+export * from "./useDataSourceEntityCollectionTableController";
+export * from "./useTableSearchHelper";

package/dist/components/common/types.d.ts

@@ -0,0 +1,60 @@
+import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../types";
+export type EntityCollectionTableController<M extends Record<string, any>> = {
+    /**
+     * This cell is displayed as selected
+     */
+    selectedCell?: SelectedCellProps<any>;
+    /**
+     * Select a table cell
+     * @param cell
+     */
+    select: (cell?: SelectedCellProps<M>) => void;
+    /**
+     * The cell that is displayed as a popup view.
+     * @param cell
+     */
+    setPopupCell?: (cell?: SelectedCellProps<M>) => void;
+    /**
+     * Callback used when the value of a cell has changed.
+     * @param params
+     */
+    onValueChange?: (params: OnCellValueChangeParams<any, M>) => void;
+    /**
+     * Size of the elements in the collection
+     */
+    size: CollectionSize;
+};
+/**
+ * Props passed in a callback when the content of a cell in a table has been edited
+ * @group Collection components
+ */
+export interface OnCellValueChangeParams<T = any, M extends Record<string, any> = any> {
+    value: T;
+    propertyKey: string;
+    entity: Entity<M>;
+    onValueUpdated: () => void;
+    setError: (e: Error) => void;
+    fullPath: string;
+    context: FireCMSContext;
+}
+/**
+ * @group Collection components
+ */
+export type UniqueFieldValidator = (props: {
+    name: string;
+    value: any;
+    property: ResolvedProperty;
+    entityId?: string;
+}) => Promise<boolean>;
+/**
+ * Callback when a cell has changed in a table
+ * @group Collection components
+ */
+export type OnCellValueChange<T, M extends Record<string, any>> = (params: OnCellValueChangeParams<T, M>) => Promise<void> | void;
+/**
+ * @group Collection components
+ */
+export type OnColumnResizeParams = {
+    width: number;
+    key: string;
+};

package/dist/components/common/useColumnsIds.d.ts

@@ -0,0 +1,4 @@
+import { ResolvedEntityCollection, ResolvedProperty } from "../../types";
+import { PropertyColumnConfig } from "../EntityCollectionTable/EntityCollectionTableProps";
+export declare function useColumnIds<M extends Record<string, any>>(collection: ResolvedEntityCollection<M>, includeSubcollections: boolean): PropertyColumnConfig[];
+export declare function getColumnKeysForProperty(property: ResolvedProperty, key: string, disabled?: boolean): PropertyColumnConfig[];

package/dist/components/common/useDataSourceEntityCollectionTableController.d.ts

@@ -0,0 +1,32 @@
+import { Entity, EntityCollection, EntityTableController, FilterValues, User } from "../../types";
+export type DataSourceEntityCollectionTableControllerProps<M extends Record<string, any> = any> = {
+    /**
+     * Full path where the data of this table is located
+     */
+    fullPath: string;
+    /**
+     * The collection that is represented by this config.
+     */
+    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>[];
+    lastDeleteTimestamp?: number;
+    forceFilter?: FilterValues<string>;
+};
+/**
+ * Use this hook to build a controller for the {@link EntityCollectionTable}.
+ * This controller is bound to data in a path in your specified datasource.
+ *
+ * Note that you can build your own hook returning a {@link EntityTableController}
+ * if you would like to display different data.
+ *
+ * @param fullPath
+ * @param collection
+ * @param entitiesDisplayedFirst
+ * @param lastDeleteTimestamp
+ * @param forceFilterFromProps
+ */
+export declare function useDataSourceEntityCollectionTableController<M extends Record<string, any> = any, UserType extends User = User>({ fullPath, collection, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps, }: DataSourceEntityCollectionTableControllerProps<M>): EntityTableController<M>;

package/dist/components/common/useDebouncedData.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hack to prevent data updates for incomplete callbacks from Firestore
+ * triggers.
+ * If any deps change, the update is immediate
+ * @param data
+ * @param deps
+ * @param timeoutMs
+ */
+export declare function useDebouncedData<T>(data: T[], deps: any, timeoutMs?: number): T[];

package/dist/components/common/useTableSearchHelper.d.ts

@@ -0,0 +1,12 @@
+import { EntityCollection } from "../../types";
+export interface UseTableSearchHelperParams<M extends Record<string, any>> {
+    collection: EntityCollection<M>;
+    fullPath: string;
+    parentCollectionIds?: string[];
+}
+export declare function useTableSearchHelper<M extends Record<string, any>>({ collection, fullPath, parentCollectionIds }: UseTableSearchHelperParams<M>): {
+    textSearchLoading: boolean;
+    textSearchInitialised: boolean;
+    onTextSearchClick: (() => void) | undefined;
+    textSearchEnabled: boolean;
+};

package/dist/components/index.d.ts

@@ -0,0 +1,25 @@
+export type { ErrorViewProps } from "./ErrorView";
+export { ErrorView } from "./ErrorView";
+export type { EntityViewProps } from "./EntityView";
+export { EntityView } from "./EntityView";
+export type { ReferenceSelectionInnerProps } from "./ReferenceTable/ReferenceSelectionTable";
+export { ReferenceSelectionTable } from "./ReferenceTable/ReferenceSelectionTable";
+export { CircularProgressCenter } from "./CircularProgressCenter";
+export * from "./common";
+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";
+export * from "./VirtualTable";
+export * from "./ErrorBoundary";
+export * from "./DeleteConfirmationDialog";
+export * from "./FireCMSLogo";
+export * from "./FireCMSAppBar";
+export * from "./ArrayContainer";
+export * from "./ReferenceWidget";
+export * from "./SearchIconsView";
+export * from "./FieldCaption";

package/dist/contexts/AnalyticsContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { AnalyticsController } from "../types";
+export declare const AnalyticsContext: React.Context<AnalyticsController>;

package/dist/contexts/AuthControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { AuthController } from "../types";
+export declare const AuthControllerContext: React.Context<AuthController>;

package/dist/contexts/CustomizationControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { CustomizationController } from "../types/customization_controller";
+export declare const CustomizationControllerContext: React.Context<CustomizationController>;

package/dist/contexts/DataSourceContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { DataSource } from "../types";
+export declare const DataSourceContext: React.Context<DataSource>;

package/dist/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/contexts/ModeController.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { ModeController } from "../hooks";
+export declare const ModeControllerContext: React.Context<ModeController>;
+export declare const ModeControllerProvider: React.Provider<ModeController>;

package/dist/contexts/NavigationContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { NavigationController } from "../types";
+export declare const NavigationContext: React.Context<NavigationController>;

package/dist/contexts/SideDialogsControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { SideDialogsController } from "../types";
+export declare const SideDialogsControllerContext: React.Context<SideDialogsController>;

package/dist/contexts/SideEntityControllerContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { SideEntityController } from "../types";
+export declare const SideEntityControllerContext: React.Context<SideEntityController>;

package/dist/contexts/SnackbarProvider.d.ts

@@ -0,0 +1,2 @@
+import React, { PropsWithChildren } from "react";
+export declare const SnackbarProvider: React.FC<PropsWithChildren<{}>>;

package/dist/contexts/StorageSourceContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { StorageSource } from "../types";
+export declare const StorageSourceContext: React.Context<StorageSource>;

package/dist/contexts/UserConfigurationPersistenceContext.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { UserConfigurationPersistence } from "../types";
+export declare const UserConfigurationPersistenceContext: React.Context<UserConfigurationPersistence | undefined>;

package/dist/contexts/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./SnackbarProvider";
+export * from "./ModeController";
+export * from "./AuthControllerContext";

package/dist/core/Drawer.d.ts

@@ -0,0 +1,23 @@
+import React from "react";
+/**
+ * Props used in case you need to override the default drawer
+ * @group Core
+ */
+export type DrawerProps<T = {}> = T & {
+    hovered: boolean;
+    drawerOpen: boolean;
+    closeDrawer: () => any;
+};
+/**
+ * Default drawer used in the CMS
+ * @group Core
+ */
+export declare function Drawer({ hovered, drawerOpen, closeDrawer }: DrawerProps): import("react/jsx-runtime").JSX.Element;
+export declare function DrawerNavigationItem({ name, icon, drawerOpen, tooltipsOpen, url, onClick }: {
+    icon: React.ReactElement;
+    name: string;
+    tooltipsOpen: boolean;
+    drawerOpen: boolean;
+    url: string;
+    onClick?: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/EntityEditView.d.ts

@@ -0,0 +1,22 @@
+import { Entity, EntityCollection, User } from "../types";
+export interface EntityEditViewProps<M extends Record<string, any>> {
+    path: string;
+    collection: EntityCollection<M>;
+    entityId?: string;
+    copy?: boolean;
+    selectedSubPath?: string;
+    parentCollectionIds: string[];
+    formWidth?: number | string;
+    onValuesAreModified: (modified: boolean) => void;
+    onUpdate?: (params: {
+        entity: Entity<any>;
+    }) => void;
+    onClose?: () => void;
+}
+/**
+ * This is the default view that is used as the content of a side panel when
+ * an entity is opened.
+ * 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 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/EntitySidePanel.d.ts

@@ -0,0 +1,10 @@
+import { EntitySidePanelProps } from "../types";
+/**
+ * This is the component in charge of rendering the side dialog used
+ * for editing entities. Use the {@link useSideEntityController} to open
+ * and control the dialogs.
+ * This component needs a parent {@link FireCMS}
+ * {@link useSideEntityController}
+ * @group Components
+ */
+export declare function EntitySidePanel(props: EntitySidePanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/core/FireCMS.d.ts

@@ -0,0 +1,14 @@
+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.
+ *
+ * This is the main component of FireCMS. It acts as the provider of all the
+ * internal contexts and hooks.
+ *
+ * You only need to use this component if you are building a custom app.
+ *
+ * @constructor
+ * @group Core
+ */
+export declare function FireCMS<UserType extends User, EC extends EntityCollection>(props: FireCMSProps<UserType, EC>): import("react/jsx-runtime").JSX.Element;

package/dist/core/NavigationRoutes.d.ts

@@ -0,0 +1,21 @@
+import React from "react";
+/**
+ * @group Components
+ */
+export type NavigationRoutesProps = {
+    /**
+     * In case you need to override the home page
+     */
+    HomePage?: React.ComponentType;
+    customRoutes?: React.ReactNode[];
+};
+/**
+ * This component is in charge of rendering
+ * all the related routes (entity collection root views, custom views
+ * or the home route) related to a {@link NavigationController}.
+ * This component needs a parent {@link FireCMS}
+ *
+ * @constructor
+ * @group Components
+ */
+export declare const NavigationRoutes: React.NamedExoticComponent<NavigationRoutesProps>;