@firecms/core 3.0.0-alpha.84 → 3.0.0-beta.10

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/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 = "medium" | "small" | "smallest";
 /**
  * @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: "smallest" | "small" | "medium";
     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/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,38 @@
 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<UserType 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;
+    /**
+     * Roles related to the logged user
+     */
+    roles?: Role[];
     /**
      * 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 +49,28 @@ export type AuthController<UserType extends User = User> = {
      * Has the user skipped the login process
      */
     loginSkipped: boolean;
+    extra: ExtraData;
+    setExtra: (extra: ExtraData) => void;
 };
+/**
+ * Implement this function to allow access to specific users.
+ * @group Hooks and utilities
+ */
+export type Authenticator<UserType extends User = User, Controller extends AuthController<UserType> = AuthController<UserType>> = (props: {
+    /**
+     * Logged-in user or null
+     */
+    user: UserType | null;
+    /**
+     * AuthController
+     */
+    authController: Controller;
+    /**
+     * 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, UserType 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;
     /**
@@ -65,6 +72,12 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * Set of properties that compose an entity
      */
     properties: PropertiesOrBuilders<M>;
+    /**
+     * 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;
     /**
      * Can this collection be edited by the end user.
      * Defaults to `true`.
@@ -87,8 +100,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> | `subcollection:${string}`)[];
     /**
      * If enabled, content is loaded in batches. If `false` all entities in the
      * collection are loaded.
@@ -121,7 +138,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, UserType>;
     /**
      * Builder for rendering additional components such as buttons in the
      * collection toolbar
@@ -241,6 +258,23 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      *
      */
     exportable?: boolean | ExportConfig<UserType>;
+    /**
+     * 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;
+    /**
+     * Default preview properties displayed when this collection is referenced to.
+     */
+    previewProperties?: string[];
 }
 /**
  * Parameter passed to the `Actions` prop in the collection configuration.
@@ -289,18 +323,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";
@@ -369,7 +402,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 +411,22 @@ 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 will be included in the
+     * bottom of the panel (save buttons, delete buttons, etc.)
+     */
+    includeActions?: boolean;
+    /**
+     * Builder for rendering the custom view
+     */
     Builder?: React.ComponentType<EntityCustomViewParams<M>>;
 };
 /**
@@ -432,7 +479,7 @@ 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;

package/dist/types/datasource.d.ts

@@ -1,18 +1,20 @@
-import { Entity, EntityReference, EntityStatus, EntityValues, GeoPoint } from "./entities";
+import { Entity, EntityStatus, EntityValues } from "./entities";
 import { EntityCollection, FilterValues } from "./collections";
 import { ResolvedEntityCollection } from "./resolved_entities";
+import { FireCMSContext } from "./firecms_context";
 /**
  * @group Datasource
  */
 export interface FetchEntityProps<M extends Record<string, any> = any> {
     path: string;
     entityId: string;
-    collection?: EntityCollection<M>;
+    collection?: EntityCollection<M, any>;
 }
 /**
  * @group Datasource
  */
 export type ListenEntityProps<M extends Record<string, any> = any> = FetchEntityProps<M> & {
+    databaseId?: string;
     onUpdate: (entity: Entity<M>) => void;
     onError?: (error: Error) => void;
 };
@@ -24,7 +26,7 @@ export interface FetchCollectionProps<M extends Record<string, any> = any> {
     collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
     filter?: FilterValues<Extract<keyof M, string>>;
     limit?: number;
-    startAfter?: any[];
+    startAfter?: any;
     orderBy?: string;
     searchString?: string;
     order?: "desc" | "asc";
@@ -52,11 +54,11 @@ export interface SaveEntityProps<M extends Record<string, any> = any> {
  */
 export interface DeleteEntityProps<M extends Record<string, any> = any> {
     entity: Entity<M>;
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
 }
 /**
- * Implement this interface and pass it to a {@link FireCMS}
- * to connect it to your data source.
- * A Firestore implementation of this interface can be found in {@link useFirestoreDataSource}
+ * Component in charge of communicating with the data source.
+ * Usually you won't need to implement this interface, but a {@link DataSourceDelegate} instead.
  * @group Datasource
  */
 export interface DataSource {
@@ -121,30 +123,41 @@ export interface DataSource {
      * @param entity
      * @return was the whole deletion flow successful
      */
-    deleteEntity<M extends Record<string, any> = any>({ entity }: DeleteEntityProps<M>): Promise<void>;
+    deleteEntity<M extends Record<string, any> = any>({ entity, collection }: DeleteEntityProps<M>): Promise<void>;
     /**
      * Check if the given property is unique in the given collection
      * @param path Collection path
      * @param name of the property
      * @param value
-     * @param property
+     * @param collection
      * @param entityId
      * @return `true` if there are no other fields besides the given entity
      */
-    checkUniqueField(path: string, name: string, value: any, entityId?: string): Promise<boolean>;
+    checkUniqueField(path: string, name: string, value: any, entityId?: string, collection?: EntityCollection): Promise<boolean>;
     /**
      * Generate an id for a new entity
      */
-    generateEntityId(path: string): string;
+    generateEntityId(path: string, collection: EntityCollection): string;
     /**
      * Count the number of entities in a collection
      */
-    countEntities<M extends Record<string, any> = any>(props: FetchCollectionProps<M>): Promise<number>;
+    countEntities?<M extends Record<string, any> = any>(props: FetchCollectionProps<M>): Promise<number>;
     /**
      * Check if the given filter combination is valid
      * @param props
      */
     isFilterCombinationValid?(props: FilterCombinationValidProps): boolean;
+    /**
+     * Called when the user clicks on the search bar in a collection view.
+     * Useful for initializing a text search index.
+     * @param props
+     */
+    initTextSearch?: (props: {
+        context: FireCMSContext;
+        path: string;
+        collection: EntityCollection;
+        parentCollectionIds?: string[];
+    }) => Promise<boolean>;
 }
 export type FilterCombinationValidProps = {
     path: string;
@@ -152,14 +165,22 @@ export type FilterCombinationValidProps = {
     filterValues: FilterValues<any>;
     sortBy?: [string, "asc" | "desc"];
 };
-export type SaveEntityDelegateProps<M extends Record<string, any> = any> = Omit<SaveEntityProps<M>, "collection">;
-export type FetchCollectionDelegateProps<M extends Record<string, any> = any> = Omit<FetchCollectionProps<M>, "collection"> & {
-    isCollectionGroup?: boolean;
-};
-export type ListenCollectionDelegateProps<M extends Record<string, any> = any> = ListenCollectionProps<M> & {
-    isCollectionGroup?: boolean;
-};
+export type SaveEntityDelegateProps<M extends Record<string, any> = any> = SaveEntityProps<M>;
+export type FetchCollectionDelegateProps<M extends Record<string, any> = any> = FetchCollectionProps<M>;
+export type ListenCollectionDelegateProps<M extends Record<string, any> = any> = ListenCollectionProps<M>;
 export interface DataSourceDelegate {
+    /**
+     * Key that identifies this data source delegate
+     */
+    key: string;
+    /**
+     * If the data source has been initialised
+     */
+    initialised?: boolean;
+    /**
+     * If the user is authenticated to use the data source
+     */
+    authenticated?: boolean;
     /**
      * Fetch data from a collection
      * @param path
@@ -194,7 +215,7 @@ export interface DataSourceDelegate {
      * @param path
      * @param entityId
      */
-    fetchEntity<M extends Record<string, any> = any>({ path, entityId, }: Omit<FetchEntityProps<M>, "collection">): Promise<Entity<M> | undefined>;
+    fetchEntity<M extends Record<string, any> = any>({ path, entityId, }: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
     /**
      * Get realtime updates on one entity.
      * @param path
@@ -204,12 +225,12 @@ export interface DataSourceDelegate {
      * @param onError
      * @return Function to cancel subscription
      */
-    listenEntity?<M extends Record<string, any> = any>({ path, entityId, onUpdate, onError }: Omit<ListenEntityProps<M>, "collection">): () => void;
+    listenEntity?<M extends Record<string, any> = any>({ path, entityId, onUpdate, onError }: ListenEntityProps<M>): () => void;
     /**
      * Save entity to the specified path
      * @param path
-     * @param id
-     * @param collection
+     * @param entityId
+     * @param values
      * @param status
      */
     saveEntity<M extends Record<string, any> = any>({ path, entityId, values, status }: SaveEntityDelegateProps<M>): Promise<Entity<M>>;
@@ -225,38 +246,37 @@ export interface DataSourceDelegate {
      * @param name of the property
      * @param value
      * @param entityId
+     * @param collection
      * @return `true` if there are no other fields besides the given entity
      */
-    checkUniqueField(path: string, name: string, value: any, entityId?: string): Promise<boolean>;
+    checkUniqueField(path: string, name: string, value: any, entityId?: string, collection?: EntityCollection): Promise<boolean>;
     /**
      * Generate an id for a new entity
      */
-    generateEntityId(path: string): string;
+    generateEntityId(path: string, collection?: EntityCollection): string;
     /**
      * Count the number of entities in a collection
      */
-    countEntities<M extends Record<string, any> = any>(props: FetchCollectionDelegateProps<M>): Promise<number>;
+    countEntities?<M extends Record<string, any> = any>(props: FetchCollectionDelegateProps<M>): Promise<number>;
     /**
      * Check if the given filter combination is valid
      * @param props
      */
-    isFilterCombinationValid?(props: Omit<FilterCombinationValidProps, "collection">): boolean;
-    /**
-     * Convert a FireCMS reference to a reference that can be used by the datasource
-     * @param reference
-     */
-    buildReference: (reference: EntityReference) => any;
-    /**
-     * Convert a FireCMS GeoPoint to a GeoPoint that can be used by the datasource
-     * @param geoPoint
-     */
-    buildGeoPoint: (geoPoint: GeoPoint) => any;
+    isFilterCombinationValid?(props: Omit<FilterCombinationValidProps, "collection"> & {
+        databaseId?: string;
+    }): boolean;
     /**
      * Get the object to generate the current time in the datasource
      */
-    currentTime(): any;
-    buildDate: (date: Date) => any;
-    buildDeleteFieldValue: () => any;
+    currentTime?: () => any;
     delegateToCMSModel: (data: any) => any;
+    cmsToDelegateModel: (data: any) => any;
     setDateToMidnight: (input?: any) => any;
+    initTextSearch?: (props: {
+        context: FireCMSContext;
+        path: string;
+        databaseId?: string;
+        collection: EntityCollection;
+        parentCollectionIds?: string[];
+    }) => Promise<boolean>;
 }

package/dist/types/entities.d.ts

@@ -21,6 +21,7 @@ export interface Entity<M extends object> {
      * Current values
      */
     values: EntityValues<M>;
+    databaseId?: string;
 }
 /**
  * This type represents a record of key value pairs as described in an
@@ -31,7 +32,7 @@ export type EntityValues<M extends object> = M;
 /**
  * Class used to create a reference to an entity in a different path
  */
-export declare class EntityReference<M extends Record<string, any> = any> {
+export declare class EntityReference {
     /**
      * ID of the entity
      */
@@ -43,6 +44,7 @@ export declare class EntityReference<M extends Record<string, any> = any> {
     readonly path: string;
     constructor(id: string, path: string);
     get pathWithId(): string;
+    isEntityReference(): boolean;
 }
 export declare class GeoPoint {
     /**
@@ -55,3 +57,7 @@ export declare class GeoPoint {
     readonly longitude: number;
     constructor(latitude: number, longitude: number);
 }
+export declare class Vector {
+    readonly value: number[];
+    constructor(value: number[]);
+}

package/dist/types/entity_actions.d.ts

@@ -4,9 +4,23 @@ import { Entity } from "./entities";
 import { EntityCollection, SelectionController } from "./collections";
 import { User } from "./user";
 import { SideEntityController } from "./side_entity_controller";
+/**
+ * An entity action is a custom action that can be performed on an entity.
+ * They are displayed in the entity view and in the collection view.
+ */
 export type EntityAction<M extends object = any, UserType extends User = User> = {
+    /**
+     * Title of the action
+     */
     name: string;
+    /**
+     * Icon of the action
+     */
     icon?: React.ReactElement;
+    /**
+     * Callback when the action is clicked
+     * @param props
+     */
     onClick: (props: EntityActionClickProps<M, UserType>) => Promise<void> | void;
     /**
      * Show this action collapsed in the menu of the collection view.

package/dist/types/entity_callbacks.d.ts

@@ -53,7 +53,7 @@ export type EntityCallbacks<M extends Record<string, any> = any, UserType extend
      *
      * @param idUpdateProps
      */
-    onIdUpdate?(idUpdateProps: EntityIdUpdateProps<M>): string;
+    onIdUpdate?(idUpdateProps: EntityIdUpdateProps<M>): string | Promise<string>;
 };
 /**
  * Parameters passed to hooks when an entity is fetched
@@ -63,7 +63,7 @@ export interface EntityOnFetchProps<M extends Record<string, any> = any, UserTyp
     /**
      * Collection of the entity
      */
-    collection: EntityCollection<M>;
+    collection: EntityCollection<M, UserType>;
     /**
      * Full path of the CMS where this collection is being fetched.
      * Might contain unresolved aliases.
@@ -155,7 +155,7 @@ export interface EntityOnDeleteProps<M extends Record<string, any> = any, UserTy
     /**
      * Context of the app status
      */
-    context: FireCMSContext;
+    context: FireCMSContext<UserType>;
 }
 /**
  * Parameters passed to hooks when an entity is deleted

package/dist/types/entity_overrides.d.ts

@@ -0,0 +1,6 @@
+import { DataSourceDelegate } from "./datasource";
+import { StorageSource } from "./storage";
+export type EntityOverrides = {
+    dataSourceDelegate?: DataSourceDelegate;
+    storageSource?: StorageSource;
+};