@firecms/core 3.0.0-canary.8 → 3.0.0-canary.81

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,18 +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
- * @param buildReference
- * @param buildGeoPoint
- * @param buildDate
- * @param buildDelete
- * @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/useRestoreScroll.d.ts

@@ -2,5 +2,5 @@ import React from "react";
 export declare function useRestoreScroll(): {
     containerRef: React.RefObject<HTMLDivElement>;
     scroll: number;
-    direction: "down" | "up";
+    direction: "up" | "down";
 };

package/dist/preview/PropertyPreviewProps.d.ts

@@ -6,7 +6,7 @@ export type PreviewSize = "medium" | "small" | "tiny";
 /**
  * @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/ReferencePreview.d.ts

@@ -8,7 +8,8 @@ export type ReferencePreviewProps = {
     previewProperties?: string[];
     onClick?: (e: React.SyntheticEvent) => void;
     hover?: boolean;
-    allowEntityNavigation?: boolean;
+    includeEntityLink?: boolean;
+    includeId?: boolean;
 };
 /**
  * @group Preview components

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/auth.d.ts

@@ -1,16 +1,23 @@
 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, ExtraData extends any = any> = {
+export type AuthController<UserType extends User = any, ExtraData extends any = 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
@@ -25,7 +32,7 @@ export type AuthController<UserType extends User = User, ExtraData extends any =
     /**
      * Sign out
      */
-    signOut: () => void;
+    signOut: () => Promise<void>;
     /**
      * Error initializing the authentication
      */
@@ -45,3 +52,25 @@ export type AuthController<UserType extends User = User, ExtraData extends any =
     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

@@ -16,7 +16,7 @@ import { EntityOverrides } from "./entity_overrides";
  *
  * @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,
@@ -94,8 +94,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.
@@ -128,7 +132,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
@@ -253,7 +257,14 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * 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;
 }
 /**
  * Parameter passed to the `Actions` prop in the collection configuration.
@@ -382,7 +393,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;
 }
 /**
@@ -391,8 +402,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>>;
 };
 /**
@@ -445,7 +470,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,13 +1,14 @@
-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
@@ -145,6 +146,17 @@ 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 = {
     path: string;
@@ -241,22 +253,17 @@ export interface DataSourceDelegate {
      * @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;
     /**
      * Get the object to generate the current time in the datasource
      */
     currentTime(): any;
-    buildDate: (date: Date) => any;
-    buildDeleteFieldValue: () => any;
     delegateToCMSModel: (data: any) => any;
+    cmsToDelegateModel: (data: any) => any;
     setDateToMidnight: (input?: any) => any;
+    initTextSearch?: (props: {
+        context: FireCMSContext;
+        path: string;
+        collection: EntityCollection;
+        parentCollectionIds?: string[];
+    }) => Promise<boolean>;
 }

package/dist/types/entities.d.ts

@@ -31,7 +31,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
      */
@@ -56,3 +56,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

@@ -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/fields.d.ts

@@ -1,6 +1,6 @@
-import { EntityValues } from "./entities";
 import { CMSType, 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,9 +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
-     */
     /**
      * Set value of field directly
      */
@@ -34,24 +31,24 @@ 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
      */
@@ -59,32 +56,32 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
     /**
      * 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;
+    partOfArray?: boolean;
     /**
      * Is this field part of a block (oneOf array)
      */
-    partOfBlock: boolean;
+    partOfBlock?: boolean;
     /**
      * Is this field being rendered in the entity table popup
      */
-    tableMode: boolean;
+    tableMode?: boolean;
     /**
      * Should this field autofocus on mount
      */
-    autoFocus: boolean;
+    autoFocus?: boolean;
     /**
      * Additional properties set by the developer
      */
-    customProps: CustomProps;
+    customProps?: CustomProps;
     /**
      * Additional values related to the state of the form or the entity
      */
@@ -92,7 +89,7 @@ export interface FieldProps<T extends CMSType = any, CustomProps = any, M extend
     /**
      * Flag to indicate if this field should be disabled
      */
-    disabled: boolean;
+    disabled?: boolean;
 }
 /**
  * Context passed to custom fields
@@ -100,13 +97,24 @@ 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
+     */
+    setFieldValue: (key: string, value: any, shouldValidate?: boolean) => void;
+    /**
+     * Save the entity.
+     */
+    save: (values: M) => void;
+    /**
+     * Collection of the entity being modified
      */
-    values: EntityValues<M>;
+    collection?: ResolvedEntityCollection<M>;
     /**
      * Entity id, it can be null if it's a new entity
      */
@@ -114,18 +122,11 @@ export interface FormContext<M extends Record<string, any> = any> {
     /**
      * Path this entity is located at
      */
-    path: string;
-    /**
-     * Update the value of a field
-     * @param key
-     * @param value
-     * @param shouldValidate
-     */
-    setFieldValue: (key: string, value: any, shouldValidate?: boolean) => void;
+    path?: string;
     /**
-     * Save the entity
+     * This is the underlying formex controller that powers the form
      */
-    save: (values: EntityValues<M>) => void;
+    formex: FormexController<M>;
 }
 /**
  * In case you need to render a field bound to a Property inside your

package/dist/types/index.d.ts

@@ -22,7 +22,7 @@ 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

@@ -6,7 +6,7 @@ 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.
@@ -47,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
      */

package/dist/types/plugins.d.ts

@@ -1,6 +1,6 @@
 import React, { PropsWithChildren } from "react";
 import { FireCMSContext } from "./firecms_context";
-import { CollectionActionsProps, EntityCollection } from "./collections";
+import { CollectionActionsProps, EntityCollection, EntityTableController } from "./collections";
 import { User } from "./user";
 import { FieldProps, FormContext } from "./fields";
 import { CMSType, Property } from "./properties";
@@ -11,11 +11,11 @@ import { ResolvedProperty } from "./resolved_entities";
  * NOTE: This is a work in progress and the API is not stable yet.
  * @group Core
  */
-export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollection = EntityCollection, COL_ACTIONS_PROPS = any> = {
+export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollection = EntityCollection, COL_ACTIONS_PROPS = any, COL_ACTIONS_START__PROPS = any> = {
     /**
-     * Name of the plugin
+     * Key of the plugin. This is used to identify the plugin in the CMS.
      */
-    name: string;
+    key: string;
     /**
      * If this flag is set to true, no content will be shown in the CMS
      * until the plugin is fully loaded.
@@ -78,6 +78,14 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
          */
         CollectionActions?: React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_PROPS> | React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_PROPS>[];
         collectionActionsProps?: COL_ACTIONS_PROPS;
+        CollectionActionsStart?: React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_START__PROPS> | React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_START__PROPS>[];
+        collectionActionsStartProps?: COL_ACTIONS_START__PROPS;
+        blockSearch?: (props: {
+            context: FireCMSContext;
+            path: string;
+            collection: EC;
+            parentCollectionIds?: string[];
+        }) => boolean;
         showTextSearchBar?: (props: {
             context: FireCMSContext;
             path: string;
@@ -101,6 +109,7 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
             parentCollectionIds: string[];
             onHover: boolean;
             collection: EC;
+            tableController: EntityTableController;
         }>;
         /**
          * If you add this callback to your plugin, an add button will be added to the collection table.
@@ -110,6 +119,7 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
             fullPath: string;
             parentCollectionIds: string[];
             collection: EC;
+            tableController: EntityTableController;
         }>;
     };
     form?: {
@@ -159,8 +169,8 @@ export type PluginFieldBuilderParams<T extends CMSType = CMSType, M extends Reco
     property: Property<T> | ResolvedProperty<T>;
     Field: React.ComponentType<FieldProps<T, any, M>>;
     plugin: FireCMSPlugin;
-    path: string;
-    collection: EC;
+    path?: string;
+    collection?: EC;
 };
 export interface PluginGenericProps<UserType extends User = User> {
     context: FireCMSContext<UserType>;