@firecms/core 3.0.0-alpha.15 → 3.0.0-alpha.17

package/dist/types/collections.d.ts

@@ -154,23 +154,16 @@ export interface EntityCollection<M extends Record<string, any> = any, Additiona
     initialSort?: [Extract<keyof M, string>, "asc" | "desc"];
     /**
      * Array of builders for rendering additional panels in an entity view.
-     * Useful if you need to render custom views
+     * Useful if you need to render custom views.
+     * You can either define the custom view inline or pass a reference to
+     * a custom view defined in the main configuration under `entityViews`
      */
-    views?: EntityCustomView<M>[];
+    entityViews?: (string | EntityCustomView<M>)[];
     /**
      * You can add additional fields to the collection view by implementing
      * an additional field delegate.
      */
     additionalFields?: AdditionalFieldDelegate<M, AdditionalKey, UserType>[];
-    /**
-     * DEPRECATED: Use `additionalFields` instead
-     *
-     * This prop will be removed in the final version
-     *
-     * You can add additional fields to the collection view by implementing
-     * an additional field delegate.
-     */
-    additionalColumns?: AdditionalFieldDelegate<M, AdditionalKey, UserType>[];
     /**
      * Default size of the rendered collection
      */
@@ -317,11 +310,6 @@ export interface AdditionalFieldDelegate<M extends Record<string, any> = any, Ad
      * Width of the generated column in pixels
      */
     width?: number;
-    /**
-     * DEPRECATED: Use `Builder` instead
-     * Builder for the content of the cell for this column
-     */
-    builder?: React.ComponentType<AdditionalFieldDelegateProps<M, UserType>>;
     /**
      * Builder for the content of the cell for this column
      */
@@ -409,8 +397,7 @@ export type TableController<M extends Record<string, any> = any> = {
     setPopupCell?: (popupCell?: SelectedCellProps<M>) => void;
 };
 export type SelectedCellProps<M extends Record<string, any>> = {
-    propertyKey: keyof M;
-    columnIndex: number;
+    propertyKey: Extract<keyof M, string>;
     cellRect: DOMRect;
     width: number;
     height: number;

package/dist/types/field_config.d.ts

@@ -1,36 +1,34 @@
-import { CMSType, DataType, PropertyOrBuilder } from "./properties";
-import { FieldProps } from "./fields";
+import React from "react";
+import { CMSType, PropertyOrBuilder } from "./properties";
 /**
  * This is the configuration object for the field component generated for a
  * property.
  * These configs are generated by default for the properties defined in your
- * collections' configuration, but you can define your own to be used
+ * collections' configuration, but you can define your own to be used.
  */
 export type FieldConfig<T extends CMSType = any> = {
+    /**
+     * Key used to identify this field type.
+     */
+    key: string;
     /**
      * Name of this field type.
      * This is not the name of the property.
      */
     name: string;
     /**
-     * Data type related to this field.
-     */
-    dataType: DataType;
-    /**
-     * You can define a custom Field component to be used for this field.
-     * Your custom Field is responsible for rendering the property value
-     * and updating it when the user changes it.
+     * Default config for the property.
+     * This property or builder will be used as the base values for the resulting property.
+     * You can also use a builder function to generate the base property.
+     * You can use a builder function to generate the property based on the values or the path.
+     * You can also define a custom Field as a React component to be used for this property.
      */
-    Field?: React.ComponentType<FieldProps<T>>;
+    property: PropertyOrBuilder<T>;
     /**
-     * You can define a default config for the property.
-     * Whenever this field is used, this property or builder will be used as
-     * the base values for the resulting property.
-     * Any props that are defined in the property will override the
-     * ones specified in `baseProperty`.
-     * You can also use a builder function to generate the base property.
+     * Optional icon to be used in the field selector.
+     * Use a 24x24 component, in order not to break the layout.
+     * Any FireCMS icon can be used.
      */
-    defaultProperty?: PropertyOrBuilder<T>;
     Icon?: React.ComponentType;
     /**
      * CSS color, used only in some plugins like the field selector.

package/dist/types/firecms.d.ts

@@ -1,7 +1,7 @@
 import { User } from "./user";
 import { AuthController } from "./auth";
 import { DataSource } from "./datasource";
-import { EntityCollection } from "./collections";
+import { EntityCollection, EntityCustomView } from "./collections";
 import { CMSView } from "./navigation";
 import { FireCMSContext } from "./firecms_context";
 import { FieldConfig } from "./field_config";
@@ -79,6 +79,14 @@ export type FireCMSProps<UserType extends User> = {
      * the `fieldConfig` prop of a property in a collection.
      */
     fields?: Record<string, FieldConfig>;
+    /**
+     * List of additional custom views for entities.
+     * You can use the key to reference the custom view in
+     * the `entityViews` prop of a collection.
+     *
+     * You can also define an entity view from the UI.
+     */
+    entityViews?: EntityCustomView[];
     /**
      * Format of the dates in the CMS.
      * Defaults to 'MMMM dd, yyyy, HH:mm:ss'

package/dist/types/firecms_context.d.ts

@@ -12,6 +12,7 @@ import { SideDialogsController } from "./side_dialogs_controller";
 import { FireCMSPlugin } from "./plugins";
 import { CMSAnalyticsEvent } from "./analytics";
 import { FieldConfig } from "./field_config";
+import { EntityCustomView } from "./collections";
 /**
  * Context that includes the internal controllers and contexts used by the app.
  * Some controllers and context included in this context can be accessed
@@ -83,4 +84,12 @@ export type FireCMSContext<UserType extends User = User, AuthControllerType exte
      * the `fieldConfig` prop of a property in a collection.
      */
     fields: Record<string, FieldConfig>;
+    /**
+     * List of additional custom views for entities.
+     * You can use the key to reference the custom view in
+     * the `entityViews` prop of a collection.
+     *
+     * You can also define an entity view from the UI.
+     */
+    entityViews?: EntityCustomView[];
 };

package/dist/types/plugins.d.ts

@@ -2,7 +2,6 @@ import React, { PropsWithChildren } from "react";
 import { FireCMSContext } from "./firecms_context";
 import { CollectionActionsProps, EntityCollection } from "./collections";
 import { User } from "./user";
-import { FieldConfigId } from "./field_config";
 import { FieldProps, FormContext } from "./fields";
 import { CMSType, Property } from "./properties";
 import { EntityStatus } from "./entities";
@@ -62,6 +61,7 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any> = {
         props?: PROPS;
     };
     homePage?: {
+        additionalChildrenStart?: React.ReactNode;
         /**
          * Use this component to add custom actions to the navigation card
          * in the home page.
@@ -117,7 +117,7 @@ export interface PluginFormActionProps<UserType extends User = User> {
     currentEntityId?: string;
 }
 export type PluginFieldBuilderParams<T extends CMSType = CMSType, M extends Record<string, any> = any> = {
-    fieldConfigId: FieldConfigId;
+    fieldConfigId: string;
     propertyKey: string;
     property: Property<T> | ResolvedProperty<T>;
     Field: React.ComponentType<FieldProps<T, any, M>>;

package/dist/types/properties.d.ts

@@ -1,3 +1,4 @@
+import React from "react";
 import { FieldProps } from "./fields";
 import { PropertyPreviewProps } from "../preview";
 import { ChipColorKey, ChipColorScheme } from "./colors";
@@ -97,6 +98,11 @@ export interface BaseProperty<T extends CMSType, CustomProps = any> {
      * This value will be set by default for new entities.
      */
     defaultValue?: T;
+    /**
+     * 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.
+     */
+    editable?: boolean;
 }
 /**
  * @category Entity properties

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@firecms/core",
-    "version": "3.0.0-alpha.15",
+    "version": "3.0.0-alpha.17",
     "description": "Awesome Firebase/Firestore-based headless open-source CMS",
     "funding": {
         "url": "https://github.com/sponsors/firecmsco"
@@ -20,11 +20,6 @@
             "import": "./dist/index.es.js",
             "require": "./dist/index.umd.js",
             "types": "./dist/index.d.ts"
-        },
-        "./components": {
-            "import": "./dist/components/index.es.js",
-            "require": "./dist/components/index.umd.js",
-            "types": "./dist/components/index.d.ts"
         }
     },
     "keywords": [
@@ -52,7 +47,7 @@
         "@fontsource/ibm-plex-mono": "^5.0.8",
         "@fontsource/roboto": "^5.0.8",
         "@hello-pangea/dnd": "^16.3.0",
-        "@material-design-icons/font": "latest",
+        "@material-design-icons/font": "^0.14.13",
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-collapsible": "^1.0.3",
         "@radix-ui/react-dialog": "^1.0.5",
@@ -135,7 +130,7 @@
     "files": [
         "dist"
     ],
-    "gitHead": "f94cd1f1f796c317827ca3afdbcf504a40647986",
+    "gitHead": "3a2be58e39f08f1c1fe0d993acfab648e0513c53",
     "publishConfig": {
         "access": "public"
     }

package/dist/core/components/EntityCollectionTable/useCollectionTableController.d.ts

@@ -1,13 +0,0 @@
-import { Entity, EntityCollection, FilterValues, TableController, User } from "../../../types";
-export type CollectionTableControllerProps<M extends Record<string, any> = any> = {
-    fullPath: string;
-    collection: EntityCollection<M>;
-    /**
-     * List of entities that will be displayed on top, no matter the ordering.
-     * This is used for reference fields selection
-     */
-    entitiesDisplayedFirst?: Entity<M>[];
-    lastDeleteTimestamp?: number;
-    forceFilter?: FilterValues<string>;
-};
-export declare function useCollectionTableController<M extends Record<string, any> = any, UserType extends User = User>({ fullPath, collection, entitiesDisplayedFirst, lastDeleteTimestamp, forceFilter: forceFilterFromProps }: CollectionTableControllerProps<M>): TableController<M>;