@firecms/core 3.0.0 → 3.1.0-canary.02232f4

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

@@ -42,4 +42,9 @@ export interface PropertyPreviewProps<T extends CMSType = any, CustomProps = any
      * This applies only to videos.
      */
     interactive?: boolean;
+    /**
+     * If true, image previews will fill their container completely.
+     * Only applies to image type properties.
+     */
+    fill?: boolean;
 }

package/dist/preview/components/DatePreview.d.ts

@@ -1,7 +1,17 @@
 import React from "react";
+export interface DatePreviewProps {
+    date: Date;
+    /**
+     * Display mode: "date" for date-only, "date_time" for date and time
+     */
+    mode?: "date" | "date_time";
+    /**
+     * IANA timezone identifier (e.g., "America/New_York")
+     * When specified, the date will be displayed in this timezone
+     */
+    timezone?: string;
+}
 /**
  * @group Preview components
  */
-export declare function DatePreview({ date }: {
-    date: Date;
-}): React.ReactElement;
+export declare function DatePreview({ date, mode, timezone }: DatePreviewProps): React.ReactElement;

package/dist/preview/components/ImagePreview.d.ts

@@ -5,8 +5,12 @@ import { PreviewSize } from "../PropertyPreviewProps";
 export interface ImagePreviewProps {
     size: PreviewSize;
     url: string;
+    /**
+     * If true, image fills its container completely with object-fit cover
+     */
+    fill?: boolean;
 }
 /**
  * @group Preview components
  */
-export declare function ImagePreview({ size, url }: ImagePreviewProps): import("react/jsx-runtime").JSX.Element;
+export declare function ImagePreview({ size, url, fill }: ImagePreviewProps): import("react/jsx-runtime").JSX.Element;

package/dist/preview/components/StorageThumbnail.d.ts

@@ -5,10 +5,11 @@ type StorageThumbnailProps = {
     storeUrl: boolean;
     size: PreviewSize;
     interactive?: boolean;
+    fill?: boolean;
 };
 /**
  * @group Preview components
  */
 export declare const StorageThumbnail: React.FunctionComponent<StorageThumbnailProps>;
-export declare function StorageThumbnailInternal({ storeUrl, interactive, storagePathOrDownloadUrl, size }: StorageThumbnailProps): import("react/jsx-runtime").JSX.Element | null;
+export declare function StorageThumbnailInternal({ storeUrl, interactive, storagePathOrDownloadUrl, size, fill }: StorageThumbnailProps): import("react/jsx-runtime").JSX.Element | null;
 export {};

package/dist/preview/components/UrlComponentPreview.d.ts

@@ -4,10 +4,11 @@ import { PreviewSize } from "../PropertyPreviewProps";
 /**
  * @group Preview components
  */
-export declare function UrlComponentPreview({ url, previewType, size, hint, interactive }: {
+export declare function UrlComponentPreview({ url, previewType, size, hint, interactive, fill }: {
     url: string;
     previewType?: PreviewType;
     size: PreviewSize;
     hint?: string;
     interactive?: boolean;
+    fill?: boolean;
 }): React.ReactElement;

package/dist/preview/property_previews/ArrayOfStorageComponentsPreview.d.ts

@@ -2,4 +2,4 @@ import { PropertyPreviewProps } from "../PropertyPreviewProps";
 /**
  * @group Preview components
  */
-export declare function ArrayOfStorageComponentsPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<any[]>): import("react/jsx-runtime").JSX.Element;
+export declare function ArrayOfStorageComponentsPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<any[]>): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/ArrayOfStringsPreview.d.ts

@@ -2,4 +2,4 @@ import { PropertyPreviewProps } from "../../preview";
 /**
  * @group Preview components
  */
-export declare function ArrayOfStringsPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<string[]>): import("react/jsx-runtime").JSX.Element;
+export declare function ArrayOfStringsPreview({ propertyKey, value, property: inputProperty, size }: PropertyPreviewProps<string[]>): import("react/jsx-runtime").JSX.Element | null;

package/dist/preview/property_previews/SkeletonPropertyComponent.d.ts

@@ -8,7 +8,7 @@ export interface SkeletonPropertyComponentProps {
  * @group Preview components
  */
 export declare function SkeletonPropertyComponent({ property, size }: SkeletonPropertyComponentProps): any;
-export declare function renderSkeletonImageThumbnail(size: PreviewSize): import("react/jsx-runtime").JSX.Element;
+export declare function renderSkeletonImageThumbnail(size: PreviewSize, fill?: boolean): import("react/jsx-runtime").JSX.Element;
 export declare function renderSkeletonText(index?: number, width?: number): import("react/jsx-runtime").JSX.Element;
 export declare function renderSkeletonCaptionText(index?: number): import("react/jsx-runtime").JSX.Element;
 export declare function renderSkeletonIcon(): import("react/jsx-runtime").JSX.Element;

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.
@@ -318,7 +342,68 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
      * Defaults to `manual_apply`.
      */
     localChangesBackup?: "manual_apply" | "auto_apply" | false;
+    /**
+     * Default view mode for displaying this collection.
+     * - "table": Display entities in a spreadsheet-like table (default)
+     * - "cards": Display entities as a grid of cards with thumbnails
+     * - "kanban": Display entities in a Kanban board grouped by a property
+     * 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.
+     */
+    kanban?: KanbanConfig<M>;
+    /**
+     * Property key to use for ordering items.
+     * Must reference a number property. When items are reordered,
+     * this property will be updated to reflect the new order using
+     * fractional indexing. Used by Kanban view for ordering within columns
+     * and can be used for general ordering purposes.
+     */
+    orderProperty?: Extract<keyof M, string>;
 }
+/**
+ * Configuration for Kanban board view mode.
+ * @group Collections
+ */
+export interface KanbanConfig<M extends Record<string, any> = any> {
+    /**
+     * Property key to use for Kanban board columns.
+     * Must reference a string property with enumValues defined.
+     * Entities will be grouped into columns based on this property's value.
+     * The column order is determined by the order of enumValues in the property.
+     */
+    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
+ */
+export type ViewMode = "table" | "cards" | "kanban";
 /**
  * Parameter passed to the `Actions` prop in the collection configuration.
  * The component will receive this prop when it is rendered in the collection
@@ -359,9 +444,10 @@ export interface CollectionActionsProps<M extends Record<string, any> = any, USE
      */
     context: FireCMSContext<USER>;
     /**
-     * Count of the entities in this collection
+     * Count of the entities in this collection.
+     * undefined means the count is still loading.
      */
-    collectionEntitiesCount: number;
+    collectionEntitiesCount?: number;
 }
 /**
  * Use this controller to retrieve the selected entities or modify them in

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

@@ -267,7 +267,6 @@ export interface DataSourceDelegate {
     currentTime?: () => any;
     delegateToCMSModel: (data: any) => any;
     cmsToDelegateModel: (data: any) => any;
-    setDateToMidnight: (input?: any) => any;
     initTextSearch?: (props: {
         context: FireCMSContext;
         path: string;

package/dist/types/entities.d.ts

@@ -48,6 +48,7 @@ export declare class EntityReference {
     readonly databaseId?: string;
     constructor(id: string, path: string, databaseId?: string);
     get pathWithId(): string;
+    get pathWithIdAndDatabase(): string;
     isEntityReference(): boolean;
 }
 export declare class GeoPoint {

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

@@ -6,7 +6,7 @@ import { FieldProps, FormContext } from "./fields";
 import { CMSType, Property } from "./properties";
 import { EntityStatus } from "./entities";
 import { ResolvedProperty } from "./resolved_entities";
-import { NavigationGroupMapping } from "./navigation";
+import { NavigationGroupMapping, CMSView } from "./navigation";
 import { InternalUserManagement } from "./internal_user_management";
 /**
  * Interface used to define plugins for FireCMS.
@@ -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
@@ -39,6 +46,11 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
         props?: PROPS;
     };
     userManagement?: InternalUserManagement;
+    /**
+     * Views to be automatically added to the navigation.
+     * These views will be merged with the views provided to useBuildNavigationController.
+     */
+    views?: CMSView[];
     homePage?: {
         /**
          * Additional actions to be rendered in the home page, close to the search bar.
@@ -86,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.
@@ -135,6 +159,46 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
             collection: EC;
             tableController: EntityTableController;
         }>;
+        /**
+         * Callback called when columns are reordered via drag and drop.
+         * Used by plugins to persist the new column order.
+         */
+        onColumnsReorder?: (props: {
+            fullPath: string;
+            parentCollectionIds: string[];
+            collection: EC;
+            newPropertiesOrder: string[];
+        }) => void;
+        /**
+         * Callback called when Kanban board columns are reordered via drag and drop.
+         * Used by plugins to persist the new Kanban column order.
+         */
+        onKanbanColumnsReorder?: (props: {
+            fullPath: string;
+            parentCollectionIds: string[];
+            collection: EC;
+            kanbanColumnProperty: string;
+            newColumnsOrder: string[];
+        }) => void;
+        /**
+         * Component to render when Kanban view is missing configuration.
+         * Used to provide a CTA to open the collection editor to configure Kanban.
+         */
+        KanbanSetupComponent?: React.ComponentType<{
+            collection: EC;
+            fullPath: string;
+            parentCollectionIds: string[];
+        }>;
+        /**
+         * Component to render an "Add Column" button at the end of the Kanban board.
+         * Used to allow adding new enum values to the column property.
+         */
+        AddKanbanColumnComponent?: React.ComponentType<{
+            collection: EC;
+            fullPath: string;
+            parentCollectionIds: string[];
+            columnProperty: string;
+        }>;
     };
     form?: {
         provider?: {
@@ -149,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;
     };