@firecms/core 3.1.0-canary.1df3b2c → 3.1.0-canary.501d471

package/dist/internal/useRestoreScroll.d.ts

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

package/dist/locales/de.d.ts

@@ -0,0 +1,2 @@
+import { FireCMSTranslations } from "../types/translations";
+export declare const de: FireCMSTranslations;

package/dist/locales/en.d.ts

@@ -0,0 +1,10 @@
+import { FireCMSTranslations } from "../types/translations";
+/**
+ * English baseline translations for @firecms/core.
+ *
+ * This is the single source of truth for all default UI strings.
+ * Override any key via the `translations` prop on FireCMS entry-point components.
+ *
+ * @group Core
+ */
+export declare const en: FireCMSTranslations;

package/dist/locales/es.d.ts

@@ -0,0 +1,10 @@
+import { FireCMSTranslations } from "../types/translations";
+/**
+ * Spanish baseline translations for @firecms/core.
+ *
+ * This is the single source of truth for all default UI strings in Spanish.
+ * Override any key via the `translations` prop on FireCMS entry-point components.
+ *
+ * @group Core
+ */
+export declare const es: FireCMSTranslations;

package/dist/locales/fr.d.ts

@@ -0,0 +1,2 @@
+import { FireCMSTranslations } from "../types/translations";
+export declare const fr: FireCMSTranslations;

package/dist/locales/hi.d.ts

@@ -0,0 +1,2 @@
+import { FireCMSTranslations } from "../types/translations";
+export declare const hi: FireCMSTranslations;

package/dist/locales/it.d.ts

@@ -0,0 +1,2 @@
+import { FireCMSTranslations } from "../types/translations";
+export declare const it: FireCMSTranslations;

package/dist/locales/pt.d.ts

@@ -0,0 +1,7 @@
+import { FireCMSTranslations } from "../types/translations";
+/**
+ * Portuguese (pt) translations for @firecms/core.
+ *
+ * @group Core
+ */
+export declare const pt: FireCMSTranslations;

package/dist/types/analytics.d.ts

@@ -1 +1 @@
-export type CMSAnalyticsEvent = "entity_click" | "entity_click_from_reference" | "reference_selection_clear" | "reference_selection_toggle" | "reference_selected_single" | "reference_selection_new_entity" | "edit_entity_clicked" | "entity_edited" | "new_entity_click" | "new_entity_saved" | "copy_entity_click" | "entity_copied" | "single_delete_dialog_open" | "multiple_delete_dialog_open" | "single_entity_deleted" | "multiple_entities_deleted" | "drawer_navigate_to_home" | "drawer_navigate_to_collection" | "drawer_navigate_to_view" | "home_navigate_to_collection" | "home_favorite_navigate_to_collection" | "home_navigate_to_view" | "home_navigate_to_admin_view" | "home_favorite_navigate_to_view" | "home_move_card" | "home_move_group" | "home_drop_new_group" | "collection_inline_editing" | "unmapped_event";
+export type CMSAnalyticsEvent = "entity_click" | "entity_click_from_reference" | "reference_selection_clear" | "reference_selection_toggle" | "reference_selected_single" | "reference_selection_new_entity" | "edit_entity_clicked" | "entity_edited" | "new_entity_click" | "new_entity_saved" | "copy_entity_click" | "entity_copied" | "single_delete_dialog_open" | "multiple_delete_dialog_open" | "single_entity_deleted" | "multiple_entities_deleted" | "drawer_navigate_to_home" | "drawer_navigate_to_collection" | "drawer_navigate_to_view" | "home_navigate_to_collection" | "home_favorite_navigate_to_collection" | "home_navigate_to_view" | "home_navigate_to_admin_view" | "home_favorite_navigate_to_view" | "home_move_card" | "home_move_group" | "home_drop_new_group" | "collection_inline_editing" | "view_mode_changed" | "kanban_card_moved" | "kanban_column_reorder" | "kanban_property_changed" | "kanban_new_entity_in_column" | "kanban_backfill_order" | "card_view_entity_click" | "unmapped_event";

package/dist/types/collections.d.ts

@@ -142,6 +142,30 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      * the side dialog of an entity.
      */
     subcollections?: EntityCollection<any, any>[];
+    /**
+     * You can group subcollections and custom views into dropdown menus
+     * in the entity view tabs. Views listed in a group will be removed
+     * from the top-level tabs and shown under a single dropdown instead.
+     *
+     * @example
+     * ```tsx
+     * const productsCollection = buildCollection({
+     *     id: "products",
+     *     path: "products",
+     *     name: "Products",
+     *     properties: { ... },
+     *     subcollections: [localesCollection, reviewsCollection],
+     *     entityViews: [sampleView],
+     *     viewGroups: [
+     *         {
+     *             name: "Related data",
+     *             views: ["locales", "reviews", "sample_view"]
+     *         }
+     *     ]
+     * });
+     * ```
+     */
+    viewGroups?: ViewGroup[];
     /**
      * This interface defines all the callbacks that can be used when an entity
      * is being created, updated or deleted.
@@ -326,6 +350,14 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      * Defaults to "table".
      */
     defaultViewMode?: ViewMode;
+    /**
+     * Which view modes are available for this collection.
+     * Possible values: "table", "cards", "kanban".
+     * Defaults to all three: ["table", "cards", "kanban"].
+     * Note: "kanban" will only be available if the collection has at least
+     * one string property with enumValues defined, regardless of this setting.
+     */
+    enabledViews?: ViewMode[];
     /**
      * Configuration for Kanban board view mode.
      * When set, the Kanban view mode becomes available.
@@ -353,6 +385,20 @@ export interface KanbanConfig<M extends Record<string, any> = any> {
      */
     columnProperty: Extract<keyof M, string>;
 }
+/**
+ * You can group subcollections and custom views into dropdown menus in the entity view tabs.
+ * @group Collections
+ */
+export interface ViewGroup {
+    /**
+     * Name of the group
+     */
+    name: string;
+    /**
+     * Array of subcollection paths/ids or custom view keys
+     */
+    views: string[];
+}
 /**
  * View mode for displaying a collection.
  * @group Collections

package/dist/types/customization_controller.d.ts

@@ -35,7 +35,8 @@ export type CustomizationController = {
      */
     dateTimeFormat?: string;
     /**
-     * Locale of the CMS, currently only affecting dates
+     * Locale of the CMS.
+     * Affects date formatting.
      */
     locale?: Locale;
     /**

package/dist/types/firecms.d.ts

@@ -100,7 +100,8 @@ export type FireCMSProps<USER extends User> = {
      */
     dateTimeFormat?: string;
     /**
-     * Locale of the CMS, currently only affecting dates
+     * Locale of the CMS.
+     * Affects date formatting.
      */
     locale?: Locale;
     /**

package/dist/types/index.d.ts

@@ -28,3 +28,4 @@ export * from "./export_import";
 export * from "./modify_collections";
 export * from "./analytics_controller";
 export * from "./customization_controller";
+export * from "./translations";

package/dist/types/navigation.d.ts

@@ -212,11 +212,11 @@ export interface NavigationEntry {
     collection?: EntityCollection;
     view?: CMSView;
     description?: string;
-    group: string;
+    group: string | null;
 }
 export type NavigationResult = {
     allowDragAndDrop: boolean;
     navigationEntries: NavigationEntry[];
-    groups: string[];
+    groups: (string | null)[];
     onNavigationEntriesUpdate: (entries: NavigationGroupMapping[]) => void;
 };

package/dist/types/plugins.d.ts

@@ -23,6 +23,13 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
      * until the plugin is fully loaded.
      */
     loading?: boolean;
+    /**
+     * Override any FireCMS UI string, or provide translations for additional
+     * locales, specific for this plugin.
+     * Keys can be existing `FireCMSTranslations` keys, or new keys if using
+     * module augmentation.
+     */
+    i18n?: Record<string, Record<string, string>>;
     /**
      * You can use this prop to add higher order components to the CMS.
      * The components will be added to the root of the CMS, so any component
@@ -91,6 +98,18 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
         onNavigationEntriesUpdate?: (entries: NavigationGroupMapping[]) => void;
     };
     collectionView?: {
+        /**
+         * Custom component to render when a collection loading error occurs.
+         * If provided, this replaces the default error view in all collection view modes
+         * (table, card, kanban).
+         * Return `null` from the component to fall back to the default error view.
+         */
+        CollectionError?: React.ComponentType<{
+            path: string;
+            collection: EC;
+            parentCollectionIds?: string[];
+            error: Error;
+        }>;
         /**
          * Use this component to add custom actions to the entity collections
          * toolbar.
@@ -194,6 +213,10 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
          * Add custom actions to the top of the form
          */
         ActionsTop?: React.ComponentType<PluginFormActionProps<any, EC>>;
+        /**
+         * Add custom content above the entity title in the form view
+         */
+        BeforeTitle?: React.ComponentType<PluginFormActionProps<any, EC>>;
         fieldBuilder?: <T extends CMSType = CMSType>(props: PluginFieldBuilderParams<T, any, EC>) => React.ComponentType<FieldProps<T>> | null;
         fieldBuilderEnabled?: <T extends CMSType = CMSType>(props: PluginFieldBuilderParams<T>) => boolean;
     };

package/dist/types/properties.d.ts

@@ -125,6 +125,15 @@ export interface BaseProperty<T extends CMSType, CustomProps = any> {
      * @see https://jsonlogic.com/ for JSON Logic syntax
      */
     conditions?: PropertyConditions;
+    /**
+     * Set this property to true to provide the UX to explicitly set the value to `null`.
+     * Defaults to `false`.
+     */
+    nullable?: boolean;
+    /**
+     * @deprecated Use `nullable` instead.
+     */
+    clearable?: boolean;
 }
 /**
  * @group Entity properties
@@ -473,10 +482,6 @@ export interface NumberProperty extends BaseProperty<number> {
      * Rules for validating this property
      */
     validation?: NumberPropertyValidationSchema;
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
 }
 /**
  * @group Entity properties
@@ -569,10 +574,6 @@ export interface StringProperty extends BaseProperty<string> {
      * Rules for validating this property
      */
     validation?: StringPropertyValidationSchema;
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
     /**
      * You can use this property (a string) to behave as a reference to another
      * collection. The stored value is the ID of the entity in the

package/dist/types/storage.d.ts

@@ -7,6 +7,7 @@ export interface UploadFileProps {
     path?: string;
     metadata?: any;
     bucket?: string;
+    onProgress?: (progress: number) => void;
 }
 /**
  * @group Models