@firecms/core 3.0.0-beta.6 → 3.0.0-beta.8

package/dist/preview/PropertyPreviewProps.d.ts

@@ -37,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

@@ -32,7 +32,7 @@ export type AuthController<UserType extends User = any, ExtraData extends any =
     /**
      * Sign out
      */
-    signOut: () => void;
+    signOut: () => Promise<void>;
     /**
      * Error initializing the authentication
      */

package/dist/types/collections.d.ts

@@ -99,7 +99,7 @@ export interface EntityCollection<M extends Record<string, any> = any, UserType
      * `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.
@@ -257,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.
@@ -395,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>>;
 };
 /**

package/dist/types/datasource.d.ts

@@ -1,6 +1,7 @@
 import { Entity, EntityStatus, EntityValues } from "./entities";
 import { EntityCollection, FilterValues } from "./collections";
 import { ResolvedEntityCollection } from "./resolved_entities";
+import { FireCMSContext } from "./firecms_context";
 /**
  * @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,14 +253,6 @@ 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
-     */
-    /**
-     * Convert a FireCMS GeoPoint to a GeoPoint that can be used by the datasource
-     * @param geoPoint
-     */
     /**
      * Get the object to generate the current time in the datasource
      */
@@ -256,4 +260,10 @@ export interface DataSourceDelegate {
     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/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/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/navigation.d.ts

@@ -47,9 +47,9 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
      * Get the collection configuration for a given path.
      * The collection is resolved from the given path or alias.
      */
-    getCollection: (pathOrId: 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: (ids: string[]) => EC | undefined;
     /**

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";
@@ -80,6 +80,12 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
         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;
@@ -103,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.
@@ -112,6 +119,7 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
             fullPath: string;
             parentCollectionIds: string[];
             collection: EC;
+            tableController: EntityTableController;
         }>;
     };
     form?: {
@@ -161,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>;

package/dist/types/properties.d.ts

@@ -97,7 +97,7 @@ export interface BaseProperty<T extends CMSType, CustomProps = any> {
     /**
      * This value will be set by default for new entities.
      */
-    defaultValue?: T;
+    defaultValue?: T | null;
     /**
      * Should this property be editable. If set to true, the user will be able to modify the property and
      * save the new config. The saved config will then become the source of truth.
@@ -474,6 +474,14 @@ export interface ReferenceProperty extends BaseProperty<EntityReference> {
      * specified values are considered.
      */
     previewProperties?: string[];
+    /**
+     * Should the reference include the ID of the entity. Defaults to `true`
+     */
+    includeId?: boolean;
+    /**
+     * Should the reference include a link to the entity (open the entity details). Defaults to `true`
+     */
+    includeEntityLink?: boolean;
 }
 /**
  * Rules to validate any property. Some properties have specific rules
@@ -620,6 +628,11 @@ export type StorageConfig = {
      * after it has been resolved.
      */
     postProcess?: (pathOrUrl: string) => Promise<string>;
+    /**
+     * You can use this prop in order to provide a custom preview URL.
+     * Useful when the file's path is different from the original field value
+     */
+    previewUrl?: (fileName: string) => string;
 };
 /**
  * @group Entity properties
@@ -644,7 +657,7 @@ export interface UploadedFileContext {
     /**
      * Entity path. E.g. `products/PID/locales`
      */
-    path: string;
+    path?: string;
     /**
      * Values of the current entity
      */