@firecms/core 3.0.0-beta.1 → 3.0.0-beta.11

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,10 +4,24 @@ import { Entity } from "./entities";
 import { EntityCollection, SelectionController } from "./collections";
 import { User } from "./user";
 import { SideEntityController } from "./side_entity_controller";
-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.
      * Defaults to true
@@ -19,9 +33,9 @@ export type EntityAction<M extends object = any, UserType extends User = User> =
      */
     includeInForm?: boolean;
 };
-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/dist/types/entity_callbacks.d.ts

@@ -9,29 +9,29 @@ 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>): Promise<Entity<M>> | Entity<M>;
+    onFetch?(entityFetchProps: EntityOnFetchProps<M, USER>): Promise<Entity<M>> | Entity<M>;
     /**
      * Callback used when save is successful
      * @param entitySaveProps
      */
-    onSaveSuccess?(entitySaveProps: EntityOnSaveProps<M, UserType>): Promise<void> | void;
+    onSaveSuccess?(entitySaveProps: EntityOnSaveProps<M, USER>): Promise<void> | void;
     /**
      * Callback used when saving fails
      * @param entitySaveProps
      */
-    onSaveFailure?(entitySaveProps: EntityOnSaveFailureProps<M, UserType>): Promise<void> | void;
+    onSaveFailure?(entitySaveProps: EntityOnSaveFailureProps<M, USER>): Promise<void> | void;
     /**
      * Callback used before saving, you need to return the values that will get
      * saved. If you throw an error in this method the process stops, and an
      * error snackbar gets displayed.
      * @param entitySaveProps
      */
-    onPreSave?(entitySaveProps: EntityOnPreSaveProps<M, UserType>): Promise<Partial<EntityValues<M>>> | Partial<EntityValues<M>>;
+    onPreSave?(entitySaveProps: EntityOnPreSaveProps<M, USER>): Promise<Partial<EntityValues<M>>> | Partial<EntityValues<M>>;
     /**
      * Callback used after the entity is deleted.
      * If you throw an error in this method the process stops, and an
@@ -39,13 +39,13 @@ 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
      * to define the ID of a `new` entity based on the current values.
@@ -53,17 +53,17 @@ 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
  * @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>;
+    collection: EntityCollection<M, USER>;
     /**
      * Full path of the CMS where this collection is being fetched.
      * Might contain unresolved aliases.
@@ -76,27 +76,27 @@ 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;
 };
 /**
  * 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;
 };
 /**
  * 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
      */
@@ -129,13 +129,13 @@ 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
      */
@@ -155,7 +155,7 @@ export interface EntityOnDeleteProps<M extends Record<string, any> = any, UserTy
     /**
      * Context of the app status
      */
-    context: FireCMSContext;
+    context: FireCMSContext<USER>;
 }
 /**
  * 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;
+};

package/dist/types/export_import.d.ts

@@ -6,16 +6,16 @@ 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/dist/types/fields.d.ts

@@ -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
  * this interface as props.
@@ -17,10 +17,6 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
      * Current value of this field
      */
     value: T;
-    /**
-     * Initial value of this field
-     */
-    initialValue: T | undefined;
     /**
      * Set value of field directly
      */
@@ -35,53 +31,49 @@ 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.
      * Note that there might be an error (like an empty field that should be
      * 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
      */
@@ -93,29 +85,29 @@ 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;
 }
 /**
  * Context passed to custom fields
  * @group Form custom fields
  */
 export interface FormContext<M extends Record<string, any> = any> {
-    /**
-     * Collection of the entity being modified
-     */
-    collection: ResolvedEntityCollection<M>;
     /**
      * Current values of the entity
      */
-    values: EntityValues<M>;
-    /**
-     * Entity id, it can be null if it's a new entity
-     */
-    entityId?: string;
-    /**
-     * Path this entity is located at
-     */
-    path: string;
+    values: M;
     /**
      * Update the value of a field
      * @param key
@@ -124,9 +116,25 @@ export interface FormContext<M extends Record<string, any> = any> {
      */
     setFieldValue: (key: string, value: any, shouldValidate?: boolean) => void;
     /**
-     * Save the entity
+     * Save the entity.
+     */
+    save: (values: M) => void;
+    /**
+     * Collection of the entity being modified
+     */
+    collection?: ResolvedEntityCollection<M>;
+    /**
+     * Entity id, it can be null if it's a new entity
+     */
+    entityId: string;
+    /**
+     * Path this entity is located at
      */
-    save: (values: EntityValues<M>) => void;
+    path?: string;
+    /**
+     * This is the underlying formex controller that powers the form
+     */
+    formex: FormexController<M>;
 }
 /**
  * In case you need to render a field bound to a Property inside your
@@ -157,10 +165,6 @@ export interface PropertyFieldBindingProps<T extends CMSType, M extends Record<s
      * field is being edited
      */
     underlyingValueHasChanged?: boolean;
-    /**
-     * Is this field being rendered in a table
-     */
-    tableMode?: boolean;
     /**
      * Is this field part of an array
      */
@@ -168,7 +172,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
      * in table mode, it makes sense to put the focus on the only field rendered.
@@ -178,4 +182,21 @@ 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;
 }

package/dist/types/firecms.d.ts

@@ -3,7 +3,7 @@ import { User } from "./user";
 import { AuthController } from "./auth";
 import { DataSourceDelegate } from "./datasource";
 import { EntityCollection, EntityCustomView } from "./collections";
-import { CMSView } from "./navigation";
+import { CMSView, NavigationController } from "./navigation";
 import { FireCMSContext } from "./firecms_context";
 import { PropertyConfig } from "./property_config";
 import { Locale } from "./locales";
@@ -44,7 +44,7 @@ export type CMSViewsBuilder = (params: {
 /**
  * @group Models
  */
-export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
+export type FireCMSProps<USER extends User, EC extends EntityCollection> = {
     /**
      * Use this function to return the components you want to render under
      * FireCMS
@@ -63,23 +63,20 @@ export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
         loading: boolean;
     }) => React.ReactNode;
     /**
-     * List of the mapped collections in the CMS.
-     * Each entry relates to a collection in the root database.
-     * Each of the navigation entries in this field
-     * generates an entry in the main menu.
+     * If you have a custom API key, you can use it here.
      */
-    collections?: EC[] | EntityCollectionsBuilder<EC>;
-    /**
-     * Custom additional views created by the developer, added to the main
-     * navigation
-     */
-    views?: CMSView[] | CMSViewsBuilder;
+    apiKey?: string;
     /**
      * Record of custom form fields to be used in the CMS.
      * You can use the key to reference the custom field in
      * the `propertyConfig` prop of a property in a collection.
      */
     propertyConfigs?: Record<string, PropertyConfig>;
+    /**
+     * This controller is in charge of the navigation of the CMS.
+     * It is in charge of resolving the collection and entity paths.
+     */
+    navigationController: NavigationController;
     /**
      * List of additional custom views for entities.
      * You can use the key to reference the custom view in
@@ -108,19 +105,7 @@ export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
     /**
      * Delegate for implementing your auth operations.
      */
-    authController: AuthController<UserType>;
-    /**
-     * Path under the navigation routes of the CMS will be created. Defaults to `/`.
-     * Internally FireCMS uses `react-router` to create the routes, the base path is attached to the
-     * `BrowserRouter` component. If you are using FireCMS in a subpath of your website, you can use
-     * this prop to specify the base path.
-     */
-    basePath?: string;
-    /**
-     * Path under the collection routes of the CMS will be created.
-     * Defaults to `/c`.
-     */
-    baseCollectionPath?: string;
+    authController: AuthController<USER>;
     /**
      * Use this controller to access the configuration that is stored locally,
      * and not defined in code

package/dist/types/firecms_context.d.ts

@@ -17,7 +17,7 @@ import { AnalyticsController } from "./analytics_controller";
  * @group Hooks and utilities
  * @see useFireCMSContext
  */
-export type FireCMSContext<UserType extends User = User, AuthControllerType extends AuthController<UserType> = AuthController<UserType>> = {
+export type FireCMSContext<USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>> = {
     /**
      * Connector to your database, e.g. your Firestore database
      */

package/dist/types/index.d.ts

@@ -17,11 +17,12 @@ export * from "./side_entity_controller";
 export * from "./side_dialogs_controller";
 export * from "./firecms_context";
 export * from "./entity_callbacks";
+export * from "./entity_overrides";
 export * from "./local_config_persistence";
 export * from "./plugins";
 export * from "./analytics";
 export * from "./firecms";
-export * from "./appcheck";
+export * from "./roles";
 export * from "./export_import";
 export * from "./modify_collections";
 export * from "./analytics_controller";

package/dist/types/navigation.d.ts

@@ -1,3 +1,4 @@
+import React from "react";
 import { EntityCollection } from "./collections";
 import { EntityReference } from "./entities";
 /**
@@ -5,19 +6,24 @@ import { EntityReference } from "./entities";
  * attributes.
  * @group Models
  */
-export type NavigationController = {
+export type NavigationController<EC extends EntityCollection = EntityCollection<any>> = {
     /**
      * List of the mapped collections in the CMS.
      * Each entry relates to a collection in the root database.
      * Each of the navigation entries in this field
      * generates an entry in the main menu.
      */
-    collections: EntityCollection[];
+    collections?: EntityCollection[];
     /**
      * Custom additional views created by the developer, added to the main
      * navigation
      */
-    views: CMSView[];
+    views?: CMSView[];
+    /**
+     * Custom additional views created by the developer, added to the admin
+     * navigation
+     */
+    adminViews?: CMSView[];
     /**
      * Configuration for the views that should be displayed at the top
      * level of the navigation (e.g. in the home page or the navigation
@@ -41,15 +47,15 @@ export type NavigationController = {
      * Get the collection configuration for a given path.
      * The collection is resolved from the given path or alias.
      */
-    getCollection: <EC extends EntityCollection = EntityCollection<any>>(pathOrAlias: string, entityId?: string, includeUserOverride?: boolean) => EC | undefined;
+    getCollection: (pathOrId: string, includeUserOverride?: boolean) => EC | undefined;
     /**
-     * Get the collection configuration from its parent path segments.
+     * Get the collection configuration from its parent ids.
      */
-    getCollectionFromIds: <EC extends EntityCollection = EntityCollection<any>>(ids: string[]) => EC | undefined;
+    getCollectionFromIds: (ids: string[]) => EC | undefined;
     /**
      * Get the collection configuration from its parent path segments.
      */
-    getCollectionFromPaths: <EC extends EntityCollection = EntityCollection<any>>(pathSegments: string[]) => EC | undefined;
+    getCollectionFromPaths: (pathSegments: string[]) => EC | undefined;
     /**
      * Default path under the navigation routes of the CMS will be created
      */
@@ -95,12 +101,6 @@ export type NavigationController = {
      * @param pathWithAliases
      */
     resolveAliasesFrom: (pathWithAliases: string) => string;
-    /**
-     * Location used as the base for routes.
-     * This is the location that will be used underneath, when the url changes while
-     * opening a side dialog
-     */
-    baseLocation: string;
     /**
      * Call this method to recalculate the navigation
      */
@@ -144,6 +144,7 @@ export interface CMSView {
      * You can use any of the icons in the Material specs:
      * https://fonts.google.com/icons
      * e.g. 'account_tree' or 'person'
+     * Find all the icons in https://firecms.co/docs/icons
      */
     icon?: string;
     /**
@@ -159,6 +160,7 @@ export interface CMSView {
     /**
      * Optional field used to group top level navigation entries under a
      * navigation view.
+     * This prop is ignored for admin views.
      */
     group?: string;
 }
@@ -166,11 +168,11 @@ export interface TopNavigationEntry {
     url: string;
     name: string;
     path: string;
-    type: "collection" | "view";
+    type: "collection" | "view" | "admin";
     collection?: EntityCollection;
-    view: CMSView;
+    view?: CMSView;
     description?: string;
-    group?: string;
+    group: string;
 }
 export type TopNavigationResult = {
     navigationEntries: TopNavigationEntry[];

package/dist/types/permissions.d.ts

@@ -30,7 +30,7 @@ export interface Permissions {
  * Props passed to a {@link PermissionsBuilder}
  * @group Models
  */
-export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCollection, UserType extends User = User, M extends object = InferCollectionType<EC>> {
+export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCollection, USER extends User = User, M extends object = InferCollectionType<EC>> {
     /**
      * Entity being edited, might be null in some cases, when the operation
      * refers to the collection.
@@ -38,6 +38,10 @@ export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCol
      * in a collection, the entity will be null.
      */
     entity: Entity<M> | null;
+    /**
+     * Path of the collection e.g. 'products/12345/locales'
+     */
+    path: string;
     /**
      * Path segments of the collection e.g. ['products', 'locales']
      */
@@ -45,7 +49,7 @@ export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCol
     /**
      * Logged in user
      */
-    user: UserType | null;
+    user: USER | null;
     /**
      * Collection these permissions apply to
      */
@@ -53,11 +57,11 @@ export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCol
     /**
      * Auth controller
      */
-    authController: AuthController<UserType>;
+    authController: AuthController<USER>;
 }
 /**
  * Builder used to assign permissions to entities,
  * based on the logged user or collection.
  * @group Models
  */
-export type PermissionsBuilder<EC extends EntityCollection = EntityCollection, UserType extends User = User, M extends object = InferCollectionType<EC>> = (({ pathSegments, user, collection, authController }: PermissionsBuilderProps<EC, UserType, M>) => Permissions);
+export type PermissionsBuilder<EC extends EntityCollection = EntityCollection, USER extends User = User, M extends object = InferCollectionType<EC>> = (({ pathSegments, user, collection, authController }: PermissionsBuilderProps<EC, USER, M>) => Permissions | undefined);