@firecms/core 3.0.0-canary.2 → 3.0.0-canary.200

package/dist/internal/useBuildDataSource.d.ts

@@ -1,4 +1,4 @@
-import { DataSource, DataSourceDelegate, EntityReference, GeoPoint, NavigationController, PropertyConfig } from "../types";
+import { DataSource, DataSourceDelegate, NavigationController, PropertyConfig } from "../types";
 /**
  * Use this hook to build a {@link DataSource} based on Firestore
  * @param firebaseApp
@@ -9,14 +9,3 @@ export declare function useBuildDataSource({ delegate, propertyConfigs, navigati
     propertyConfigs?: Record<string, PropertyConfig>;
     navigationController: NavigationController;
 }): 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
- * @group Firestore
- */
-export declare function cmsToDelegateModel(data: any, buildReference: (reference: EntityReference) => any, buildGeoPoint: (geoPoint: GeoPoint) => any, buildDate: (date: Date) => any, buildDelete: () => any): any;

package/dist/internal/useUnsavedChangesDialog.d.ts

@@ -1,14 +1,12 @@
-import React from "react";
+/**
+ * Custom hook to handle navigation blocking when there are unsaved changes.
+ *
+ * @param when - Indicates whether to block navigation.
+ * @param onSuccess - Callback invoked when navigation is confirmed.
+ * @returns An object containing the state of navigation blocking and handlers.
+ */
 export declare function useNavigationUnsavedChangesDialog(when: boolean, onSuccess: () => void): {
     navigationWasBlocked: boolean;
     handleCancel: () => void;
     handleOk: () => void;
 };
-export interface UnsavedChangesDialogProps {
-    open: boolean;
-    body?: React.ReactNode;
-    title?: string;
-    handleOk: () => void;
-    handleCancel: () => void;
-}
-export declare function UnsavedChangesDialog({ open, handleOk, handleCancel, body, title }: UnsavedChangesDialogProps): import("react/jsx-runtime").JSX.Element;

package/dist/preview/PropertyPreview.d.ts

@@ -4,4 +4,4 @@ import { PropertyPreviewProps } from "./PropertyPreviewProps";
 /**
  * @group Preview components
  */
-export declare const PropertyPreview: React.MemoExoticComponent<(<T extends CMSType>(props: PropertyPreviewProps<T, any, Record<string, any>>) => any)>;
+export declare const PropertyPreview: React.MemoExoticComponent<(<T extends CMSType>(props: PropertyPreviewProps<T>) => any)>;

package/dist/preview/PropertyPreviewProps.d.ts

@@ -2,11 +2,11 @@ import { CMSType, Property, ResolvedProperty } from "../types";
 /**
  * @group Preview components
  */
-export type PreviewSize = "medium" | "small" | "tiny";
+export type PreviewSize = "small" | "medium" | "large";
 /**
  * @group Preview components
  */
-export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any, M extends Record<string, any> = Record<string, any>> {
+export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any> {
     /**
      * Name of the property
      */
@@ -19,9 +19,6 @@ export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any
      * Property this display is related to
      */
     property: Property<T> | ResolvedProperty<T>;
-    /**
-     * Click handler
-     */
     /**
      * Desired size of the preview, depending on the context.
      */
@@ -40,4 +37,9 @@ export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any
      * Additional properties set by the developer
      */
     customProps?: CustomProps;
+    /**
+     * If the preview should be interactive or not.
+     * This applies only to videos.
+     */
+    interactive?: boolean;
 }

package/dist/preview/components/BooleanPreview.d.ts

@@ -1,7 +1,11 @@
 import React from "react";
+import { PreviewSize } from "../PropertyPreviewProps";
+import { Property } from "../../types";
 /**
  * @group Preview components
  */
-export declare function BooleanPreview({ value }: {
+export declare function BooleanPreview({ value, size, property }: {
     value: boolean;
+    size: PreviewSize;
+    property: Property;
 }): React.ReactElement;

package/dist/preview/components/EnumValuesChip.d.ts

@@ -3,7 +3,7 @@ import { EnumValues } from "../../types";
 export interface EnumValuesChipProps {
     enumValues?: EnumValues;
     enumKey: string | number;
-    size: "small" | "medium";
+    size: "small" | "medium" | "large";
     className?: string;
     children?: React.ReactNode;
 }

package/dist/preview/components/ReferencePreview.d.ts

@@ -7,16 +7,11 @@ export type ReferencePreviewProps = {
     size: PreviewSize;
     previewProperties?: string[];
     onClick?: (e: React.SyntheticEvent) => void;
-    onHover?: boolean;
-    allowEntityNavigation?: boolean;
+    hover?: boolean;
+    includeEntityLink?: boolean;
+    includeId?: boolean;
 };
 /**
  * @group Preview components
  */
-export declare const ReferencePreview: React.FunctionComponent<ReferencePreviewProps>;
-export declare function ReferencePreviewContainer({ children, onHover, size, onClick }: {
-    children: React.ReactNode;
-    onHover?: boolean;
-    size: PreviewSize;
-    onClick?: (e: React.SyntheticEvent) => void;
-}): import("react/jsx-runtime").JSX.Element;
+export declare const ReferencePreview: (props: ReferencePreviewProps) => import("react/jsx-runtime").JSX.Element;

package/dist/preview/components/StorageThumbnail.d.ts

@@ -4,10 +4,11 @@ type StorageThumbnailProps = {
     storagePathOrDownloadUrl: string;
     storeUrl: boolean;
     size: PreviewSize;
+    interactive?: boolean;
 };
 /**
  * @group Preview components
  */
 export declare const StorageThumbnail: React.FunctionComponent<StorageThumbnailProps>;
-export declare function StorageThumbnailInternal({ storeUrl, storagePathOrDownloadUrl, size }: StorageThumbnailProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function StorageThumbnailInternal({ storeUrl, interactive, storagePathOrDownloadUrl, size }: StorageThumbnailProps): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/preview/components/UrlComponentPreview.d.ts

@@ -4,9 +4,10 @@ import { PreviewSize } from "../PropertyPreviewProps";
 /**
  * @group Preview components
  */
-export declare function UrlComponentPreview({ url, previewType, size, hint }: {
+export declare function UrlComponentPreview({ url, previewType, size, hint, interactive }: {
     url: string;
     previewType?: PreviewType;
     size: PreviewSize;
     hint?: string;
+    interactive?: boolean;
 }): React.ReactElement;

package/dist/preview/util.d.ts

@@ -1,7 +1,7 @@
 import { CollectionSize } from "../types";
 import { PreviewSize } from "./PropertyPreviewProps";
-export declare const TINY_THUMBNAIL = 40;
-export declare const SMALL_THUMBNAIL = 100;
-export declare const REGULAR_THUMBNAIL = 200;
+export declare const SMALL_THUMBNAIL = 40;
+export declare const MEDIUM_THUMBNAIL = 100;
+export declare const LARGE_THUMBNAIL = 200;
 export declare function getThumbnailMeasure(size: PreviewSize): number;
 export declare function getPreviewSizeFrom(size: CollectionSize): PreviewSize;

package/dist/routes/CustomCMSRoute.d.ts

@@ -0,0 +1,4 @@
+import { CMSView } from "../types";
+export declare function CustomCMSRoute({ cmsView }: {
+    cmsView: CMSView;
+}): import("react").ReactNode;

package/dist/routes/FireCMSRoute.d.ts

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

package/dist/routes/HomePageRoute.d.ts

@@ -0,0 +1,3 @@
+export declare function HomePageRoute({ children }: {
+    children: React.ReactNode;
+}): import("react").ReactNode;

package/dist/types/analytics.d.ts

@@ -1 +1 @@
-export type CMSAnalyticsEvent = "entity_click" | "entity_click_from_reference" | "reference_selection_clear" | "reference_selection_toggle" | "reference_selected_single" | "reference_selection_new_entity" | "edit_entity_clicked" | "entity_edited" | "new_entity_click" | "new_entity_saved" | "copy_entity_click" | "entity_copied" | "single_delete_dialog_open" | "multiple_delete_dialog_open" | "single_entity_deleted" | "multiple_entities_deleted" | "drawer_navigate_to_home" | "drawer_navigate_to_collection" | "drawer_navigate_to_view" | "home_navigate_to_collection" | "home_favorite_navigate_to_collection" | "home_navigate_to_view" | "home_favorite_navigate_to_view" | "collection_inline_editing" | "unmapped_event";
+export type CMSAnalyticsEvent = "entity_click" | "entity_click_from_reference" | "reference_selection_clear" | "reference_selection_toggle" | "reference_selected_single" | "reference_selection_new_entity" | "edit_entity_clicked" | "entity_edited" | "new_entity_click" | "new_entity_saved" | "copy_entity_click" | "entity_copied" | "single_delete_dialog_open" | "multiple_delete_dialog_open" | "single_entity_deleted" | "multiple_entities_deleted" | "drawer_navigate_to_home" | "drawer_navigate_to_collection" | "drawer_navigate_to_view" | "home_navigate_to_collection" | "home_favorite_navigate_to_collection" | "home_navigate_to_view" | "home_navigate_to_admin_view" | "home_favorite_navigate_to_view" | "collection_inline_editing" | "unmapped_event";

package/dist/types/auth.d.ts

@@ -1,26 +1,34 @@
 import { User } from "./user";
+import { Role } from "./roles";
+import { DataSourceDelegate } from "./datasource";
+import { StorageSource } from "./storage";
 /**
  * Controller for retrieving the logged user or performing auth related operations.
  * Note that if you are implementing your AuthController, you probably will want
  * to do it as the result of a hook.
  * @group Hooks and utilities
  */
-export type AuthController<UserType extends User = User> = {
+export type AuthController<USER extends User = any, ExtraData = any> = {
     /**
      * The user currently logged in
      * The values can be: the user object, null if they skipped login
      */
-    user: UserType | null;
+    user: USER | null;
     /**
      * Initial loading flag. It is used not to display the login screen
      * when the app first loads, and it has not been checked whether the user
      * is logged in or not.
      */
     initialLoading?: boolean;
+    /**
+     * Loading flag. It is used to display a loading screen when the user is
+     * logging in or out.
+     */
+    authLoading: boolean;
     /**
      * Sign out
      */
-    signOut: () => void;
+    signOut: () => Promise<void>;
     /**
      * Error initializing the authentication
      */
@@ -37,4 +45,30 @@ export type AuthController<UserType extends User = User> = {
      * Has the user skipped the login process
      */
     loginSkipped: boolean;
+    extra: ExtraData;
+    setExtra: (extra: ExtraData) => void;
+    setUser?: (user: USER | null) => void;
+    setUserRoles?: (roles: Role[]) => void;
 };
+/**
+ * Implement this function to allow access to specific users.
+ * @group Hooks and utilities
+ */
+export type Authenticator<USER extends User = User> = (props: {
+    /**
+     * Logged-in user or null
+     */
+    user: USER | null;
+    /**
+     * AuthController
+     */
+    authController: AuthController<USER>;
+    /**
+     * Connector to your database, e.g. your Firestore database
+     */
+    dataSourceDelegate: DataSourceDelegate;
+    /**
+     * Used storage implementation
+     */
+    storageSource: StorageSource;
+}) => boolean | Promise<boolean>;

package/dist/types/collections.d.ts

@@ -8,6 +8,7 @@ import { EnumValues, PropertiesOrBuilders } from "./properties";
 import { FormContext } from "./fields";
 import { EntityAction } from "./entity_actions";
 import { ExportConfig } from "./export_import";
+import { EntityOverrides } from "./entity_overrides";
 /**
  * This interface represents a view that includes a collection of entities.
  * It can be in the root level of the configuration, defining the main
@@ -15,7 +16,7 @@ import { ExportConfig } from "./export_import";
  *
  * @group Models
  */
-export interface EntityCollection<M extends Record<string, any> = any, UserType extends User = User> {
+export interface EntityCollection<M extends Record<string, any> = any, USER extends User = any> {
     /**
      * You can set an alias that will be used internally instead of the `path`.
      * The `alias` value will be used to determine the URL of the collection,
@@ -43,6 +44,11 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * This path also determines the URL in FireCMS, unless an alias is specified
      */
     path: string;
+    /**
+     * Optional database id of this collection. If not specified, the default
+     * database id will be used.
+     */
+    databaseId?: string;
     /**
      * If this collection is a top level navigation entry, you can set this
      * property to `true` to indicate that this collection is a collection group.
@@ -52,7 +58,8 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * Icon key to use in this collection.
      * You can use any of the icons in the Material specs:
      * https://fonts.google.com/icons
-     * e.g. 'account_tree' or 'person'
+     * e.g. 'account_tree' or 'person'.
+     * Find all the icons in https://firecms.co/docs/icons
      */
     icon?: string;
     /**
@@ -66,11 +73,20 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      */
     properties: PropertiesOrBuilders<M>;
     /**
-     * Can this collection be edited by the end user.
-     * Defaults to `true`.
-     * Keep in mind that you can also set this prop to individual properties.
+     * Default preview properties displayed when this collection is referenced to.
      */
-    editable?: boolean;
+    previewProperties?: string[];
+    /**
+     * Title property of the entity. This is the property that will be used
+     * as the title in entity related views and references.
+     * If not specified, the first property simple text property will be used.
+     */
+    titleProperty?: keyof M;
+    /**
+     * When editing an entity, you can choose to open the entity in a side dialog
+     * or in a full screen dialog. Defaults to `full_screen`.
+     */
+    openEntityMode?: "side_panel" | "full_screen";
     /**
      * Order in which the properties are displayed.
      * If you are specifying your collection as code, the order is the same as the
@@ -87,8 +103,12 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      *       `subcollection:`. e.g. `subcollection:orders`.
      *     - If you are using a collection group, you will also have an
      *       additional `collectionGroupParent` column.
+     * You can use this prop to hide some properties from the table view.
+     * Note that if you set this prop, other ways to hide fields, like
+     * `hidden` in the property definition,will be ignored.
+     * `propertiesOrder` has precedence over `hidden`.
      */
-    propertiesOrder?: Extract<keyof M, string>[];
+    propertiesOrder?: (Extract<keyof M, string> | string | `subcollection:${string}` | "collectionGroupParent")[];
     /**
      * If enabled, content is loaded in batches. If `false` all entities in the
      * collection are loaded.
@@ -105,7 +125,7 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * Permissions the logged-in user can perform on this collection.
      * If not specified everything defaults to `true`.
      */
-    permissions?: Permissions | PermissionsBuilder<EntityCollection, UserType, M>;
+    permissions?: Permissions | PermissionsBuilder<EntityCollection, USER, M>;
     /**
      * Are the entities in this collection selectable. Defaults to `true`
      */
@@ -121,7 +141,7 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * is being created, updated or deleted.
      * Useful for adding your own logic or blocking the execution of the operation.
      */
-    callbacks?: EntityCallbacks<M>;
+    callbacks?: EntityCallbacks<M, USER>;
     /**
      * Builder for rendering additional components such as buttons in the
      * collection toolbar
@@ -150,7 +170,7 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * }
      * ```
      */
-    entityActions?: EntityAction<M, UserType>[];
+    entityActions?: EntityAction<M, USER>[];
     /**
      * Pass your own selection controller if you want to control selected
      * entities externally.
@@ -195,7 +215,7 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * You can add additional fields to the collection view by implementing
      * an additional field delegate.
      */
-    additionalFields?: AdditionalFieldDelegate<M, UserType>[];
+    additionalFields?: AdditionalFieldDelegate<M, USER>[];
     /**
      * Default size of the rendered collection
      */
@@ -240,7 +260,27 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
     /**
      *
      */
-    exportable?: boolean | ExportConfig<UserType>;
+    exportable?: boolean | ExportConfig<USER>;
+    /**
+     * User id of the owner of this collection. This is used only by plugins, or if you
+     * are writing custom code
+     */
+    ownerId?: string;
+    /**
+     * Overrides for the entity view, like the data source or the storage source.
+     */
+    overrides?: EntityOverrides;
+    /**
+     * Width of the side dialog (in pixels) when opening an entity in this collection.
+     */
+    sideDialogWidth?: number | string;
+    /**
+     * Can this collection configuration be edited by the end user.
+     * Defaults to `true`.
+     * Keep in mind that you can also set this prop to individual properties.
+     * This prop has only effect if you are using the collection editor.
+     */
+    editable?: boolean;
 }
 /**
  * Parameter passed to the `Actions` prop in the collection configuration.
@@ -249,7 +289,7 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
  *
  * @group Models
  */
-export interface CollectionActionsProps<M extends Record<string, any> = any, UserType extends User = User, EC extends EntityCollection<M> = EntityCollection<M>> {
+export interface CollectionActionsProps<M extends Record<string, any> = any, USER extends User = User, EC extends EntityCollection<M> = EntityCollection<M>> {
     /**
      * Full collection path of this entity. This is the full path, like
      * `users/1234/addresses`
@@ -280,7 +320,7 @@ export interface CollectionActionsProps<M extends Record<string, any> = any, Use
     /**
      * Context of the app status
      */
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
     /**
      * Count of the entities in this collection
      */
@@ -289,18 +329,17 @@ export interface CollectionActionsProps<M extends Record<string, any> = any, Use
 /**
  * Use this controller to retrieve the selected entities or modify them in
  * an {@link EntityCollection}
- * If you want to pass a `SelectionController` to
  * @group Models
  */
 export type SelectionController<M extends Record<string, any> = any> = {
     selectedEntities: Entity<M>[];
     setSelectedEntities: Dispatch<SetStateAction<Entity<M>[]>>;
     isEntitySelected: (entity: Entity<M>) => boolean;
-    toggleEntitySelection: (entity: Entity<M>) => void;
+    toggleEntitySelection: (entity: Entity<M>, newSelectedState?: boolean) => void;
 };
 /**
  * Filter conditions in a `Query.where()` clause are specified using the
- * strings '<', '<=', '==', '>=', '>', 'array-contains', 'in', and 'array-contains-any'.
+ * strings `<`, `<=`, `==`, `>=`, `>`, `array-contains`, `in`, and `array-contains-any`.
  * @group Models
  */
 export type WhereFilterOp = "<" | "<=" | "==" | "!=" | ">=" | ">" | "array-contains" | "in" | "not-in" | "array-contains-any";
@@ -324,16 +363,16 @@ export type FilterCombination<Key extends string> = Partial<Record<Key, "asc" |
  * @group Models
  */
 export type CollectionSize = "xs" | "s" | "m" | "l" | "xl";
-export type AdditionalFieldDelegateProps<M extends Record<string, any> = any, UserType extends User = User> = {
+export type AdditionalFieldDelegateProps<M extends Record<string, any> = any, USER extends User = User> = {
     entity: Entity<M>;
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 };
 /**
  * Use this interface for adding additional fields to entity collection views.
  * If you need to do some async loading you can use {@link AsyncPreviewComponent}
  * @group Models
  */
-export interface AdditionalFieldDelegate<M extends Record<string, any> = any, UserType extends User = User> {
+export interface AdditionalFieldDelegate<M extends Record<string, any> = any, USER extends User = User> {
     /**
      * ID of this column. You can use this id in the `properties` field of the
      * collection in any order you want
@@ -350,7 +389,7 @@ export interface AdditionalFieldDelegate<M extends Record<string, any> = any, Us
     /**
      * Builder for the content of the cell for this column
      */
-    Builder?: React.ComponentType<AdditionalFieldDelegateProps<M, UserType>>;
+    Builder?: React.ComponentType<AdditionalFieldDelegateProps<M, USER>>;
     /**
      * If this column needs to update dynamically based on other properties,
      * you can define an array of keys as strings with the
@@ -369,7 +408,7 @@ export interface AdditionalFieldDelegate<M extends Record<string, any> = any, Us
      */
     value?: (props: {
         entity: Entity<M>;
-        context: FireCMSContext;
+        context: FireCMSContext<any>;
     }) => string | number | Promise<string | number> | undefined;
 }
 /**
@@ -378,8 +417,24 @@ export interface AdditionalFieldDelegate<M extends Record<string, any> = any, Us
  * @group Models
  */
 export type EntityCustomView<M extends Record<string, any> = any> = {
+    /**
+     * Key of this custom view.
+     */
     key: string;
+    /**
+     * Name of this custom view.
+     */
     name: string;
+    /**
+     * If set to true, the actions of the entity (save, discard,delete) will be
+     * included in the view. By default the actions are located in the right or bottom,
+     * based on the screen size. You can force the actions to be located at the bottom
+     * by setting this prop to "bottom".
+     */
+    includeActions?: boolean | "bottom";
+    /**
+     * Builder for rendering the custom view
+     */
     Builder?: React.ComponentType<EntityCustomViewParams<M>>;
 };
 /**
@@ -432,12 +487,18 @@ export type EntityTableController<M extends Record<string, any> = any> = {
     filterValues?: FilterValues<Extract<keyof M, string>>;
     setFilterValues?: (filterValues: FilterValues<Extract<keyof M, string>>) => void;
     sortBy?: [Extract<keyof M, string>, "asc" | "desc"];
-    setSortBy?: (sortBy: [Extract<keyof M, string>, "asc" | "desc"]) => void;
+    setSortBy?: (sortBy?: [Extract<keyof M, string>, "asc" | "desc"]) => void;
     searchString?: string;
     setSearchString?: (searchString?: string) => void;
     clearFilter?: () => void;
     itemCount?: number;
     setItemCount?: (itemCount: number) => void;
+    initialScroll?: number;
+    onScroll?: (props: {
+        scrollDirection: "forward" | "backward";
+        scrollOffset: number;
+        scrollUpdateWasRequested: boolean;
+    }) => void;
     paginationEnabled?: boolean;
     pageSize?: number;
     checkFilterCombination?: (filterValues: FilterValues<any>, sortBy?: [string, "asc" | "desc"]) => boolean;
@@ -450,5 +511,6 @@ export type SelectedCellProps<M extends Record<string, any>> = {
     cellRect: DOMRect;
     width: number;
     height: number;
-    entity: Entity<M>;
+    entityPath: string;
+    entityId: string;
 };