@firecms/core 3.0.0-canary.66 → 3.0.0-canary.68

package/dist/types/collections.d.ts

@@ -402,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/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/plugins.d.ts

@@ -161,8 +161,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

@@ -652,7 +652,7 @@ export interface UploadedFileContext {
     /**
      * Entity path. E.g. `products/PID/locales`
      */
-    path: string;
+    path?: string;
     /**
      * Values of the current entity
      */

package/dist/util/storage.d.ts

@@ -1,3 +1,24 @@
 import { EntityValues, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig, UploadedFileContext } from "../types";
-export declare function resolveFilenameString<M extends object>(input: string | ((context: UploadedFileContext) => Promise<string> | string), storage: StorageConfig, values: EntityValues<M>, entityId: string, path: string, property: ResolvedStringProperty | ResolvedArrayProperty<string[]>, file: File, propertyKey: string): Promise<string>;
-export declare function resolveStoragePathString<M extends object>(input: string | ((context: UploadedFileContext) => string), storage: StorageConfig, values: EntityValues<M>, entityId: string, path: string, property: ResolvedStringProperty | ResolvedArrayProperty<string[]>, file: File, propertyKey: string): string;
+interface ResolveFilenameStringParams<M extends object> {
+    input: string | ((context: UploadedFileContext) => (Promise<string> | string));
+    storage: StorageConfig;
+    values: EntityValues<M>;
+    entityId: string;
+    path?: string;
+    property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
+    file: File;
+    propertyKey: string;
+}
+export declare function resolveFilenameString<M extends object>({ input, storage, values, entityId, path, property, file, propertyKey }: ResolveFilenameStringParams<M>): Promise<string>;
+interface ResolveStoragePathStringParams<M extends object> {
+    input: string | ((context: UploadedFileContext) => string);
+    storage: StorageConfig;
+    values: EntityValues<M>;
+    entityId: string;
+    path?: string;
+    property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
+    file: File;
+    propertyKey: string;
+}
+export declare function resolveStoragePathString<M extends object>({ input, storage, values, entityId, path, property, file, propertyKey }: ResolveStoragePathStringParams<M>): string;
+export {};

package/dist/util/useStorageUploadController.d.ts

@@ -18,7 +18,7 @@ export declare function useStorageUploadController<M extends object>({ entityId,
     entityId: string;
     entityValues: EntityValues<M>;
     value: string | string[] | null;
-    path: string;
+    path?: string;
     propertyKey: string;
     property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
     storageSource: StorageSource;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@firecms/core",
     "type": "module",
-    "version": "3.0.0-canary.66",
+    "version": "3.0.0-canary.68",
     "description": "Awesome Firebase/Firestore-based headless open-source CMS",
     "funding": {
         "url": "https://github.com/sponsors/firecmsco"
@@ -46,8 +46,8 @@
         "./package.json": "./package.json"
     },
     "dependencies": {
-        "@firecms/formex": "^3.0.0-canary.66",
-        "@firecms/ui": "^3.0.0-canary.66",
+        "@firecms/formex": "^3.0.0-canary.68",
+        "@firecms/ui": "^3.0.0-canary.68",
         "@fontsource/jetbrains-mono": "^5.0.20",
         "@hello-pangea/dnd": "^16.6.0",
         "@radix-ui/react-portal": "^1.0.4",
@@ -111,7 +111,7 @@
         "dist",
         "src"
     ],
-    "gitHead": "12ca26d459381c77e4419e13a8170fc286c96a66",
+    "gitHead": "bfabbd17ea406b898443e03febe4a353c8af5eb4",
     "publishConfig": {
         "access": "public"
     },

package/src/components/EntityCollectionTable/internal/popup_field/PopupFormField.tsx

@@ -264,7 +264,8 @@ export function PopupFormFieldInternal<M extends Record<string, any>>({
         values,
         path,
         setFieldValue,
-        save: saveValue
+        save: saveValue,
+        formex
     };
 
     const property: ResolvedProperty<any> | undefined = propertyKey && getPropertyInPath(collection.properties, propertyKey as string);