@firecms/core 3.0.0-canary.16 → 3.0.0-canary.160

package/src/types/datasource.ts

@@ -1,6 +1,7 @@
-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
@@ -17,6 +18,7 @@ export interface FetchEntityProps<M extends Record<string, any> = any> {
 export type ListenEntityProps<M extends Record<string, any> = any> =
     FetchEntityProps<M>
     & {
+    databaseId?: string;
     onUpdate: (entity: Entity<M>) => void,
     onError?: (error: Error) => void,
 }
@@ -62,12 +64,12 @@ 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 {
@@ -181,7 +183,8 @@ export interface DataSource {
      */
     deleteEntity<M extends Record<string, any> = any>(
         {
-            entity
+            entity,
+            collection
         }: DeleteEntityProps<M>
     ): Promise<void>;
 
@@ -190,7 +193,7 @@ export interface DataSource {
      * @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
      */
@@ -198,13 +201,14 @@ export interface DataSource {
         path: string,
         name: string,
         value: any,
-        entityId?: string
+        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
@@ -216,6 +220,19 @@ export interface DataSource {
      * @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 = {
@@ -225,21 +242,24 @@ export type FilterCombinationValidProps = {
     sortBy?: [string, "asc" | "desc"];
 };
 
-export type SaveEntityDelegateProps<M extends Record<string, any> = any> = Omit<SaveEntityProps<M>, "collection">;
+export type SaveEntityDelegateProps<M extends Record<string, any> = any> = SaveEntityProps<M>;
 
-export type FetchCollectionDelegateProps<M extends Record<string, any> = any> =
-    Omit<FetchCollectionProps<M>, "collection">
-    & {
-    isCollectionGroup?: boolean
-};
+export type FetchCollectionDelegateProps<M extends Record<string, any> = any> = FetchCollectionProps<M>;
 
-export type ListenCollectionDelegateProps<M extends Record<string, any> = any> =
-    ListenCollectionProps<M>
-    & {
-    isCollectionGroup?: boolean;
-};
+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;
+
     /**
      * Fetch data from a collection
      * @param path
@@ -297,7 +317,7 @@ export interface DataSourceDelegate {
     fetchEntity<M extends Record<string, any> = any>({
                                                          path,
                                                          entityId,
-                                                     }: Omit<FetchEntityProps<M>, "collection">): Promise<Entity<M> | undefined>;
+                                                     }: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
 
     /**
      * Get realtime updates on one entity.
@@ -313,13 +333,13 @@ export interface DataSourceDelegate {
                                                            entityId,
                                                            onUpdate,
                                                            onError
-                                                       }: Omit<ListenEntityProps<M>, "collection">): () => void;
+                                                       }: 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>({
@@ -342,14 +362,15 @@ 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
@@ -360,30 +381,26 @@ export interface DataSourceDelegate {
      * 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/src/types/entities.ts

@@ -25,6 +25,8 @@ export interface Entity<M extends object> {
      * Current values
      */
     values: EntityValues<M>;
+
+    databaseId?: string;
 }
 
 /**
@@ -37,7 +39,7 @@ export type EntityValues<M extends object> = M;
 /**
  * Class used to create a reference to an entity in a different path
  */
-export class EntityReference<M extends Record<string, any> = any> {
+export class EntityReference {
     /**
      * ID of the entity
      */
@@ -78,3 +80,11 @@ export class GeoPoint {
         this.longitude = longitude;
     }
 }
+
+export class Vector {
+    readonly value: number[];
+
+    constructor(value: number[]) {
+        this.value = value;
+    }
+}

package/src/types/entity_actions.tsx

@@ -4,12 +4,27 @@ import { Entity } from "./entities";
 import { EntityCollection, SelectionController } from "./collections";
 import { User } from "./user";
 import { SideEntityController } from "./side_entity_controller";
-import { EntityOverrides } from "./entity_overrides";
 
-export type EntityAction<M extends object = any, UserType extends User = User> = {
+/**
+ * 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, USER extends User = User> = {
+    /**
+     * Title of the action
+     */
     name: string;
+
+    /**
+     * Icon of the action
+     */
     icon?: React.ReactElement;
-    onClick: (props: EntityActionClickProps<M, UserType>) => Promise<void> | void;
+
+    /**
+     * Callback when the action is clicked
+     * @param props
+     */
+    onClick: (props: EntityActionClickProps<M, USER>) => Promise<void> | void;
 
     /**
      * Show this action collapsed in the menu of the collection view.
@@ -25,11 +40,9 @@ export type EntityAction<M extends object = any, UserType extends User = User> =
 
 }
 
-
-
-export type EntityActionClickProps<M extends object, UserType extends User = User> = {
+export type EntityActionClickProps<M extends object, USER extends User = User> = {
     entity: Entity<M>;
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
     fullPath?: string;
     collection?: EntityCollection<M>;
     selectionController?: SelectionController;

package/src/types/entity_callbacks.ts

@@ -10,27 +10,27 @@ import { User } from "./user";
  * Useful for adding your own logic or blocking the execution of the operation.
  * @group Models
  */
-export type EntityCallbacks<M extends Record<string, any> = any, UserType extends User = User> = {
+export type EntityCallbacks<M extends Record<string, any> = any, USER extends User = User> = {
 
     /**
      * Callback used after fetching data
      * @param entityFetchProps
      */
-    onFetch?(entityFetchProps: EntityOnFetchProps<M, UserType>)
+    onFetch?(entityFetchProps: EntityOnFetchProps<M, USER>)
         : Promise<Entity<M>> | Entity<M>;
 
     /**
      * Callback used when save is successful
      * @param entitySaveProps
      */
-    onSaveSuccess?(entitySaveProps: EntityOnSaveProps<M, UserType>)
+    onSaveSuccess?(entitySaveProps: EntityOnSaveProps<M, USER>)
         : Promise<void> | void;
 
     /**
      * Callback used when saving fails
      * @param entitySaveProps
      */
-    onSaveFailure?(entitySaveProps: EntityOnSaveFailureProps<M, UserType>)
+    onSaveFailure?(entitySaveProps: EntityOnSaveFailureProps<M, USER>)
         : Promise<void> | void;
 
     /**
@@ -39,7 +39,7 @@ export type EntityCallbacks<M extends Record<string, any> = any, UserType extend
      * error snackbar gets displayed.
      * @param entitySaveProps
      */
-    onPreSave?(entitySaveProps: EntityOnPreSaveProps<M, UserType>)
+    onPreSave?(entitySaveProps: EntityOnPreSaveProps<M, USER>)
         : Promise<Partial<EntityValues<M>>> | Partial<EntityValues<M>>;
 
     /**
@@ -49,14 +49,14 @@ export type EntityCallbacks<M extends Record<string, any> = any, UserType extend
      *
      * @param entityDeleteProps
      */
-    onPreDelete?(entityDeleteProps: EntityOnDeleteProps<M, UserType>): void;
+    onPreDelete?(entityDeleteProps: EntityOnDeleteProps<M, USER>): void;
 
     /**
      * Callback used after the entity is deleted.
      *
      * @param entityDeleteProps
      */
-    onDelete?(entityDeleteProps: EntityOnDeleteProps<M, UserType>): void;
+    onDelete?(entityDeleteProps: EntityOnDeleteProps<M, USER>): void;
 
     /**
      * Callback fired when any value in the form changes. You can use it
@@ -73,12 +73,12 @@ export type EntityCallbacks<M extends Record<string, any> = any, UserType extend
  * Parameters passed to hooks when an entity is fetched
  * @group Models
  */
-export interface EntityOnFetchProps<M extends Record<string, any> = any, UserType extends User = User> {
+export interface EntityOnFetchProps<M extends Record<string, any> = any, USER extends User = User> {
 
     /**
      * Collection of the entity
      */
-    collection: EntityCollection<M, UserType>;
+    collection: EntityCollection<M, USER>;
 
     /**
      * Full path of the CMS where this collection is being fetched.
@@ -94,15 +94,15 @@ export interface EntityOnFetchProps<M extends Record<string, any> = any, UserTyp
     /**
      * Context of the app status
      */
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }
 
 /**
  * Parameters passed to hooks before an entity is saved
  * @group Models
  */
-export type EntityOnPreSaveProps<M extends Record<string, any> = any, UserType extends User = User> =
-    Omit<EntityOnSaveProps<M, UserType>, "entityId">
+export type EntityOnPreSaveProps<M extends Record<string, any> = any, USER extends User = User> =
+    Omit<EntityOnSaveProps<M, USER>, "entityId">
     & {
     entityId?: string;
 }
@@ -110,8 +110,8 @@ export type EntityOnPreSaveProps<M extends Record<string, any> = any, UserType e
  * Parameters passed to hooks before an entity is saved
  * @group Models
  */
-export type EntityOnSaveFailureProps<M extends Record<string, any> = any, UserType extends User = User> =
-    Omit<EntityOnSaveProps<M, UserType>, "entityId">
+export type EntityOnSaveFailureProps<M extends Record<string, any> = any, USER extends User = User> =
+    Omit<EntityOnSaveProps<M, USER>, "entityId">
     & {
     entityId?: string;
 }
@@ -120,7 +120,7 @@ export type EntityOnSaveFailureProps<M extends Record<string, any> = any, UserTy
  * Parameters passed to hooks when an entity is saved
  * @group Models
  */
-export interface EntityOnSaveProps<M extends Record<string, any> = any, UserType extends User = User> {
+export interface EntityOnSaveProps<M extends Record<string, any> = any, USER extends User = User> {
 
     /**
      * Resolved collection of the entity
@@ -161,14 +161,14 @@ export interface EntityOnSaveProps<M extends Record<string, any> = any, UserType
     /**
      * Context of the app status
      */
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }
 
 /**
  * Parameters passed to hooks when an entity is deleted
  * @group Models
  */
-export interface EntityOnDeleteProps<M extends Record<string, any> = any, UserType extends User = User> {
+export interface EntityOnDeleteProps<M extends Record<string, any> = any, USER extends User = User> {
 
     /**
      * collection of the entity being deleted
@@ -193,7 +193,7 @@ export interface EntityOnDeleteProps<M extends Record<string, any> = any, UserTy
     /**
      * Context of the app status
      */
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }
 
 /**

package/src/types/entity_overrides.tsx

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

package/src/types/export_import.ts

@@ -7,20 +7,20 @@ import { FireCMSContext } from "./firecms_context";
  * exports
  * @group Models
  */
-export interface ExportConfig<UserType extends User = User> {
-    additionalFields: ExportMappingFunction<UserType> [];
+export interface ExportConfig<USER extends User = User> {
+    additionalFields: ExportMappingFunction<USER> [];
 }
 
 /**
  * @group Models
  */
-export interface ExportMappingFunction<UserType extends User = User> {
+export interface ExportMappingFunction<USER extends User = User> {
     key: string;
     builder: ({
                   entity,
                   context
               }: {
         entity: Entity<any>,
-        context: FireCMSContext<UserType>
+        context: FireCMSContext<USER>
     }) => Promise<string> | string;
 }

package/src/types/fields.tsx

@@ -1,6 +1,6 @@
-import { EntityValues } from "./entities";
-import { CMSType, PropertyOrBuilder } from "./properties";
+import { CMSType, Property, PropertyOrBuilder } from "./properties";
 import { ResolvedEntityCollection, ResolvedProperty } from "./resolved_entities";
+import { FormexController } from "@firecms/formex";
 
 /**
  * When building a custom field you need to create a React component that takes
@@ -21,11 +21,6 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
      */
     value: T;
 
-    /**
-     * Initial value of this field
-     */
-    // initialValue: T | undefined;
-
     /**
      * Set value of field directly
      */
@@ -42,7 +37,7 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
     /**
      * Is the form currently submitting
      */
-    isSubmitting: boolean;
+    isSubmitting?: boolean;
 
     /**
      * Should this field show the error indicator.
@@ -50,55 +45,50 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
      * filled) but we don't want to show the error until the user has tried
      * saving.
      */
-    showError: boolean;
+    showError?: boolean;
 
     /**
      * Is there an error in this field. The error field has the same shape as
      * the field, replacing values with a string containing the error.
      * It takes the value `null` if there is no error
      */
-    error: any | null;
+    error?: any | null;
 
     /**
      * Has this field been touched
      */
-    touched: boolean;
+    touched?: boolean;
 
     /**
      * Property related to this field
      */
-    property: ResolvedProperty<T>;
+    property: Property<T> | ResolvedProperty<T>;
 
     /**
      * Should this field include a description
      */
-    includeDescription: boolean;
+    includeDescription?: boolean;
 
     /**
      * Flag to indicate that the underlying value has been updated in the
      * datasource
      */
-    underlyingValueHasChanged: boolean;
+    underlyingValueHasChanged?: boolean;
 
     /**
      * Is this field part of an array
      */
-    partOfArray: boolean;
-
-    /**
-     * Is this field part of a block (oneOf array)
-     */
-    partOfBlock: boolean;
+    partOfArray?: boolean;
 
     /**
-     * Is this field being rendered in the entity table popup
+     * Should this field render with the minimal amount of UI elements
      */
-    tableMode: boolean;
+    minimalistView?: boolean;
 
     /**
      * Should this field autofocus on mount
      */
-    autoFocus: boolean;
+    autoFocus?: boolean;
 
     /**
      * Additional properties set by the developer
@@ -113,7 +103,21 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
     /**
      * Flag to indicate if this field should be disabled
      */
-    disabled: boolean;
+    disabled?: boolean;
+
+    /**
+     * Size of the field
+     */
+    size?: "small" | "medium" | "large";
+
+    /**
+     * Some properties might change internal state (like expanding a panel).
+     * This function should be called when the internal state changes.
+     * This is used to preserve state in array containers.
+     *
+     * @param property
+     */
+    onPropertyChange?: (property: Partial<Property<any>>) => void;
 
 }
 
@@ -124,37 +128,42 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
 export interface FormContext<M extends Record<string, any> = any> {
 
     /**
-     * Collection of the entity being modified
+     * Current values of the entity
      */
-    collection: ResolvedEntityCollection<M>;
+    values: M;
 
     /**
-     * Current values of the entity
+     * Update the value of a field
+     * @param key
+     * @param value
+     * @param shouldValidate
      */
-    values: EntityValues<M>;
+    setFieldValue: (key: string, value: any, shouldValidate?: boolean) => void;
 
     /**
-     * Entity id, it can be null if it's a new entity
+     * Save the entity.
      */
-    entityId?: string;
+    save: (values: M) => void;
 
     /**
-     * Path this entity is located at
+     * Collection of the entity being modified
      */
-    path: string;
+    collection?: ResolvedEntityCollection<M>;
 
     /**
-     * Update the value of a field
-     * @param key
-     * @param value
-     * @param shouldValidate
+     * Entity id, it can be null if it's a new entity
      */
-    setFieldValue: (key: string, value: any, shouldValidate?: boolean) => void;
+    entityId: string;
+
+    /**
+     * Path this entity is located at
+     */
+    path?: string;
 
     /**
-     * Save the entity
+     * This is the underlying formex controller that powers the form
      */
-    save: (values: EntityValues<M>) => void;
+    formex: FormexController<M>;
 }
 
 /**
@@ -192,11 +201,6 @@ export interface PropertyFieldBindingProps<T extends CMSType, M extends Record<s
      */
     underlyingValueHasChanged?: boolean;
 
-    /**
-     * Is this field being rendered in a table
-     */
-    tableMode?: boolean;
-
     /**
      * Is this field part of an array
      */
@@ -205,7 +209,7 @@ export interface PropertyFieldBindingProps<T extends CMSType, M extends Record<s
     /**
      * Is this field part of a block (oneOf array)
      */
-    partOfBlock?: boolean;
+    minimalistView?: boolean;
 
     /**
      * Should the field take focus when rendered. When opening the popup view
@@ -217,4 +221,24 @@ export interface PropertyFieldBindingProps<T extends CMSType, M extends Record<s
      * Should this field be disabled
      */
     disabled?: boolean;
+
+    /**
+     * Index of the field in the array.
+     * Only used when the field is part of an array.
+     */
+    index?: number;
+
+    /**
+     * The size of the field
+     */
+    size?: "small" | "medium" | "large",
+
+    /**
+     * Some properties might change internal state (like expanding a panel).
+     * This function should be called when the internal state changes.
+     * This is used to preserve state in array containers.
+     *
+     * @param property
+     */
+    onPropertyChange?: (property: Partial<Property<any>>) => void;
 }