@firecms/core 3.1.0 → 3.2.0-canary.4c3b8f2

package/dist/components/EntityCollectionView/CollectionDataErrorBanner.d.ts

@@ -0,0 +1,4 @@
+export declare function CollectionDataErrorBanner({ error, onRetry }: {
+    error?: Error;
+    onRetry?: () => void;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/ErrorBoundary.d.ts

@@ -1,9 +1,11 @@
 import React, { ErrorInfo, PropsWithChildren } from "react";
 export declare class ErrorBoundary extends React.Component<PropsWithChildren<Record<string, unknown>>, {
-    error: Error | null;
+    hasError: boolean;
+    error?: Error;
 }> {
     constructor(props: any);
     static getDerivedStateFromError(error: Error): {
+        hasError: boolean;
         error: Error;
     };
     componentDidCatch(error: Error, errorInfo: ErrorInfo): void;

package/dist/components/HomePage/DefaultHomePage.d.ts

@@ -1,5 +1,4 @@
 import React from "react";
-export declare const DEFAULT_GROUP_NAME = "Views";
 export declare const ADMIN_GROUP_NAME = "Admin";
 export declare function DefaultHomePage({ additionalActions, additionalChildrenStart, additionalChildrenEnd }: {
     additionalActions?: React.ReactNode;

package/dist/components/LanguageToggle.d.ts

@@ -0,0 +1 @@
+export declare function LanguageToggle(): import("react/jsx-runtime").JSX.Element;

package/dist/components/UnsavedChangesDialog.d.ts

@@ -1,3 +1,4 @@
+import React from "react";
 export interface UnsavedChangesDialogProps {
     open: boolean;
     body?: React.ReactNode;

package/dist/components/index.d.ts

@@ -29,3 +29,4 @@ export * from "./SearchIconsView";
 export * from "./FieldCaption";
 export * from "./EntityPreview";
 export * from "./AIIcon";
+export * from "./LanguageToggle";

package/dist/core/DrawerNavigationGroup.d.ts

@@ -2,9 +2,9 @@ import React from "react";
 import { NavigationEntry } from "../types";
 export interface DrawerNavigationGroupProps {
     /**
-     * Group name to display in header
+     * Group name to display in header. When null, uses the translated default group name.
      */
-    group: string;
+    group: string | null;
     /**
      * Navigation entries in this group
      */

package/dist/editor/components/SlashCommandMenu.d.ts

@@ -0,0 +1,6 @@
+import { EditorAIController } from "../types";
+import { UploadFn } from "../extensions/Image";
+export declare const SlashCommandMenu: ({ upload, aiController }: {
+    upload: UploadFn;
+    aiController?: EditorAIController;
+}) => import("react/jsx-runtime").JSX.Element | null;

package/dist/editor/components/editor-bubble-item.d.ts

@@ -0,0 +1,8 @@
+import { type ReactNode } from "react";
+interface EditorBubbleItemProps {
+    children: ReactNode;
+    asChild?: boolean;
+    onSelect?: () => void;
+}
+export declare const EditorBubbleItem: import("react").ForwardRefExoticComponent<EditorBubbleItemProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onSelect"> & import("react").RefAttributes<HTMLDivElement>>;
+export default EditorBubbleItem;

package/dist/editor/components/editor-bubble.d.ts

@@ -0,0 +1,8 @@
+import { type ReactNode } from "react";
+export interface EditorBubbleProps {
+    children: ReactNode;
+    options?: any;
+    className?: string;
+}
+export declare const EditorBubble: import("react").ForwardRefExoticComponent<EditorBubbleProps & import("react").RefAttributes<HTMLDivElement>>;
+export default EditorBubble;

package/dist/editor/components/image-bubble.d.ts

@@ -0,0 +1,5 @@
+export interface ImageBubbleProps {
+    options?: any;
+    className?: string;
+}
+export declare const ImageBubble: import("react").ForwardRefExoticComponent<ImageBubbleProps & import("react").RefAttributes<HTMLDivElement>>;

package/dist/editor/components/index.d.ts

@@ -0,0 +1,16 @@
+export { EditorBubble } from "./editor-bubble";
+export { EditorBubbleItem } from "./editor-bubble-item";
+export { SlashCommandMenu } from "./SlashCommandMenu";
+export { ImageBubble } from "./image-bubble";
+export { TableBubble } from "./table-bubble";
+export type JSONContent = {
+    type?: string;
+    attrs?: Record<string, any>;
+    content?: JSONContent[];
+    marks?: {
+        type: string;
+        attrs?: Record<string, any>;
+    }[];
+    text?: string;
+    [key: string]: any;
+};

package/dist/editor/components/table-bubble.d.ts

@@ -0,0 +1,5 @@
+export interface TableBubbleProps {
+    options?: any;
+    className?: string;
+}
+export declare const TableBubble: import("react").ForwardRefExoticComponent<TableBubbleProps & import("react").RefAttributes<HTMLDivElement>>;

package/dist/editor/editor.d.ts

@@ -0,0 +1,30 @@
+import React from "react";
+import { type JSONContent } from "./components";
+import { EditorAIController } from "./types";
+export type CustomEditorComponent = {
+    name: string;
+    component: React.FC;
+};
+export interface MarkdownEditorConfig {
+    html?: boolean;
+    transformPastedText?: boolean;
+}
+export type FireCMSEditorTextSize = "sm" | "base" | "lg";
+export type FireCMSEditorProps = {
+    content?: JSONContent | string;
+    onMarkdownContentChange?: (content: string) => void;
+    onJsonContentChange?: (content: JSONContent | null) => void;
+    onHtmlContentChange?: (content: string) => void;
+    handleImageUpload: (file: File) => Promise<string>;
+    version?: number;
+    textSize?: FireCMSEditorTextSize;
+    highlight?: {
+        from: number;
+        to: number;
+    };
+    aiController?: EditorAIController;
+    customComponents?: CustomEditorComponent[];
+    disabled?: boolean;
+    markdownConfig?: MarkdownEditorConfig;
+};
+export declare const FireCMSEditor: ({ content, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange, version, textSize, highlight, handleImageUpload, aiController, disabled, markdownConfig }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/editor/extensions/HighlightDecorationExtension.d.ts

@@ -0,0 +1,24 @@
+import { Plugin, PluginKey, Transaction, EditorState } from "prosemirror-state";
+import { DecorationSet } from "prosemirror-view";
+export interface HighlightRange {
+    from: number;
+    to: number;
+}
+interface AutocompleteHighlightState {
+    highlight?: HighlightRange;
+    decorationSet?: DecorationSet;
+}
+export declare const highlightDecorationKey: PluginKey<AutocompleteHighlightState>;
+/**
+ * Commands to toggle the highlight
+ */
+export declare const highlightCommands: {
+    toggleAutocompleteHighlight: (range?: HighlightRange) => (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+    removeAutocompleteHighlight: () => (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
+};
+/**
+ * This plugin is used to highlight the current autocomplete suggestion.
+ * It allows to set a range and remove it.
+ */
+export declare const highlightDecorationPlugin: (initialHighlight?: HighlightRange) => Plugin<AutocompleteHighlightState>;
+export {};

package/dist/editor/extensions/Image/index.d.ts

@@ -0,0 +1,6 @@
+import { EditorView } from "prosemirror-view";
+import { Plugin, PluginKey } from "prosemirror-state";
+export type UploadFn = (image: File) => Promise<string>;
+export declare function onFileRead(view: EditorView, readerEvent: ProgressEvent<FileReader>, pos: number, upload: UploadFn, image: File): Promise<void>;
+export declare const ImagePluginKey: PluginKey<any>;
+export declare const createDropImagePlugin: (upload: UploadFn) => Plugin;

package/dist/editor/extensions/Image.d.ts

@@ -0,0 +1,6 @@
+import { EditorView } from "prosemirror-view";
+import { Plugin, PluginKey } from "prosemirror-state";
+export type UploadFn = (image: File) => Promise<string>;
+export declare function onFileRead(view: EditorView, readerEvent: ProgressEvent<FileReader>, pos: number, upload: UploadFn, image: File): Promise<void>;
+export declare const ImagePluginKey: PluginKey<any>;
+export declare const createDropImagePlugin: (upload: UploadFn) => Plugin;

package/dist/editor/extensions/TextLoadingDecorationExtension.d.ts

@@ -0,0 +1,16 @@
+import { Plugin, PluginKey, Transaction, EditorState } from "prosemirror-state";
+import { DecorationSet } from "prosemirror-view";
+export declare const loadingDecorationKey: PluginKey<LoadingDecorationState>;
+interface LoadingDecorationState {
+    decorationSet: DecorationSet;
+    hasDecoration: boolean;
+}
+export declare const textLoadingCommands: {
+    toggleLoadingDecoration: (state: EditorState, dispatch: ((tr: Transaction) => void) | undefined, loadingHtml?: string) => boolean;
+    removeLoadingDecoration: (state: EditorState, dispatch: ((tr: Transaction) => void) | undefined) => boolean;
+};
+/**
+ * This plugin is used to display streaming content from an LLM.
+ */
+export declare const textLoadingDecorationPlugin: () => Plugin<LoadingDecorationState>;
+export {};

package/dist/editor/extensions/clipboard.d.ts

@@ -0,0 +1,7 @@
+import { Slice } from "prosemirror-model";
+import { EditorView } from "prosemirror-view";
+export declare function serializeForClipboard(view: EditorView, slice: Slice): {
+    dom: HTMLDivElement;
+    text: string;
+    slice: Slice;
+};

package/dist/editor/extensions/custom-keymap.d.ts

@@ -0,0 +1 @@
+export declare const customKeymapPlugin: () => import("prosemirror-state").Plugin<any>;

package/dist/editor/extensions/drag-and-drop.d.ts

@@ -0,0 +1,9 @@
+import { Plugin } from "prosemirror-state";
+export interface DragHandleOptions {
+    /**
+     * The width of the drag handle
+     */
+    dragHandleWidth: number;
+}
+export declare function dragHandlePlugin(options?: DragHandleOptions): Plugin<any>;
+export declare function globalDragDropPlugin(): Plugin<any>;

package/dist/editor/hooks/useProseMirror.d.ts

@@ -0,0 +1,13 @@
+import { EditorState } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+interface UseProseMirrorProps {
+    initialContent?: string | any;
+    editable?: boolean;
+    handleImageUpload?: (file: File) => Promise<string>;
+}
+export declare function useProseMirror({ initialContent, editable, handleImageUpload }: UseProseMirrorProps): {
+    state: EditorState;
+    view: EditorView | null;
+    editorRef: import("react").RefObject<HTMLDivElement | null>;
+};
+export {};

package/dist/editor/hooks/useProseMirrorContext.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { EditorState } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+export interface ProseMirrorContextType {
+    state: EditorState | null;
+    view: EditorView | null;
+}
+export declare const ProseMirrorContext: React.Context<ProseMirrorContextType>;
+export declare const useProseMirrorContext: () => ProseMirrorContextType;

package/dist/editor/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./editor";
+export * from "./types";

package/dist/editor/markdown.d.ts

@@ -0,0 +1,5 @@
+import { MarkdownParser, MarkdownSerializer } from "prosemirror-markdown";
+export declare const markdownParser: MarkdownParser;
+export declare const markdownSerializer: MarkdownSerializer;
+export declare const parser: MarkdownParser;
+export declare const serializer: MarkdownSerializer;

package/dist/editor/nodeViews/ImageComponent.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { ReactNodeViewProps } from "./ReactNodeView";
+export declare const ImageComponent: React.FC<ReactNodeViewProps>;

package/dist/editor/nodeViews/ReactNodeView.d.ts

@@ -0,0 +1,29 @@
+import React from "react";
+import { Node as ProseMirrorNode } from "prosemirror-model";
+import { EditorView, NodeView } from "prosemirror-view";
+export interface ReactNodeViewProps {
+    node: ProseMirrorNode;
+    view: EditorView;
+    getPos: () => number | undefined;
+}
+export type ReactNodeViewComponent = React.FC<ReactNodeViewProps>;
+/**
+ * A utility class that implements the ProseMirror NodeView interface but delegates rendering
+ * to a React component.
+ * Note: This uses createRoot, so it does not automatically inherit React Contexts.
+ * If contexts are needed, wrap them manually or use a portal-based approach instead.
+ */
+export declare class ReactNodeView implements NodeView {
+    node: ProseMirrorNode;
+    view: EditorView;
+    getPos: () => number | undefined;
+    dom: HTMLElement;
+    contentDOM?: HTMLElement;
+    private root;
+    private Component;
+    constructor(node: ProseMirrorNode, view: EditorView, getPos: () => number | undefined, Component: ReactNodeViewComponent, as?: string, className?: string, contentDOMElement?: HTMLElement);
+    private render;
+    update(node: ProseMirrorNode): boolean;
+    destroy(): void;
+    ignoreMutation(mutation: any): boolean;
+}

package/dist/editor/nodeViews/TaskItemComponent.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { ReactNodeViewProps } from "./ReactNodeView";
+export declare const TaskItemComponent: React.FC<ReactNodeViewProps>;

package/dist/editor/nodeViews/index.d.ts

@@ -0,0 +1,6 @@
+import { Node as ProseMirrorNode } from "prosemirror-model";
+import { EditorView, NodeView } from "prosemirror-view";
+export declare const nodeViews: {
+    task_item: (node: ProseMirrorNode, view: EditorView, getPos: () => number | undefined) => NodeView;
+    image: (node: ProseMirrorNode, view: EditorView, getPos: () => number | undefined) => NodeView;
+};

package/dist/editor/plugins/index.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from "prosemirror-state";
+export declare const corePlugins: Plugin[];

package/dist/editor/plugins/inputrules.d.ts

@@ -0,0 +1,6 @@
+export declare const markdownInputRules: import("prosemirror-state").Plugin<{
+    transform: import("prosemirror-state").Transaction;
+    from: number;
+    to: number;
+    text: string;
+} | null>;

package/dist/editor/plugins/placeholderPlugin.d.ts

@@ -0,0 +1,3 @@
+import { Plugin, PluginKey } from "prosemirror-state";
+export declare const placeholderPluginKey: PluginKey<any>;
+export declare function placeholderPlugin(text: string): Plugin<any>;

package/dist/editor/plugins/slashCommandPlugin.d.ts

@@ -0,0 +1,12 @@
+import { Plugin, PluginKey } from "prosemirror-state";
+export declare const SlashCommandPluginKey: PluginKey<any>;
+export interface SlashCommandState {
+    active: boolean;
+    range?: {
+        from: number;
+        to: number;
+    };
+    query?: string;
+    dismissed?: boolean;
+}
+export declare function slashCommandPlugin(): Plugin<SlashCommandState>;

package/dist/editor/schema.d.ts

@@ -0,0 +1,2 @@
+import { Schema } from "prosemirror-model";
+export declare const schema: Schema<string, string>;

package/dist/editor/selectors/color-selector.d.ts

@@ -0,0 +1,10 @@
+export interface BubbleColorMenuItem {
+    name: string;
+    color: string;
+}
+interface ColorSelectorProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+}
+export declare const ColorSelector: ({ open, onOpenChange }: ColorSelectorProps) => import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/editor/selectors/link-selector.d.ts

@@ -0,0 +1,8 @@
+export declare function isValidUrl(url: string): boolean;
+export declare function getUrlFromString(str: string): string | null;
+interface LinkSelectorProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+}
+export declare const LinkSelector: ({ open, onOpenChange }: LinkSelectorProps) => import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/editor/selectors/node-selector.d.ts

@@ -0,0 +1,15 @@
+import { EditorState, Transaction } from "prosemirror-state";
+export type SelectorItem = {
+    name: string;
+    labelKey: string;
+    icon: React.ElementType;
+    command: (state: EditorState, dispatch: (tr: Transaction) => void) => void;
+    isActive: (state: EditorState) => boolean;
+};
+interface NodeSelectorProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    portalContainer: HTMLElement | null;
+}
+export declare const NodeSelector: ({ open, onOpenChange, portalContainer }: NodeSelectorProps) => import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/editor/selectors/text-buttons.d.ts

@@ -0,0 +1 @@
+export declare const TextButtons: () => import("react/jsx-runtime").JSX.Element | null;

package/dist/editor/types.d.ts

@@ -0,0 +1,5 @@
+import { JSONContent } from "./components";
+export type { JSONContent };
+export type EditorAIController = {
+    autocomplete: (textBefore: string, textAfter: string, onUpdate: (delta: string) => void) => Promise<string>;
+};

package/dist/editor/useProseMirror.d.ts

@@ -0,0 +1,16 @@
+import { EditorState, Plugin } from "prosemirror-state";
+import { EditorView } from "prosemirror-view";
+export interface UseProseMirrorOptions {
+    content?: any;
+    plugins?: Plugin[];
+    editable?: boolean;
+    onMarkdownContentChange?: (content: string) => void;
+    onJsonContentChange?: (content: any | null) => void;
+    onHtmlContentChange?: (content: string) => void;
+    version?: number;
+}
+export declare function useProseMirror(options: UseProseMirrorOptions): {
+    mountRef: import("react").RefObject<HTMLDivElement | null>;
+    view: EditorView | null;
+    editorState: EditorState | null;
+};

package/dist/editor/utils/prosemirror-utils.d.ts

@@ -0,0 +1,6 @@
+import { EditorState } from "prosemirror-state";
+export declare function isMarkActive(state: EditorState, type: any): boolean;
+export declare function isNodeActive(state: EditorState, type: any, attrs?: any): boolean;
+export declare function getMarkAttributes(state: EditorState, type: any): any;
+export declare function setMark(type: any, attrs?: any): (state: EditorState, dispatch?: (tr: any) => void) => boolean;
+export declare function unsetMark(type: any): (state: EditorState, dispatch?: (tr: any) => void) => boolean;

package/dist/editor/utils/remove_classes.d.ts

@@ -0,0 +1 @@
+export declare function removeClassesFromJson(jsonObj: any): any;

package/dist/editor/utils/useDebouncedCallback.d.ts

@@ -0,0 +1 @@
+export declare function useDebouncedCallback<T>(value: T, callback: () => void, immediate: boolean, timeoutMs?: number): void;

package/dist/form/field_bindings/MarkdownEditorFieldBinding.d.ts

@@ -1,5 +1,5 @@
 import { FieldProps } from "../../index";
-import { FireCMSEditorProps } from "@firecms/editor";
+import { FireCMSEditorProps } from "../../editor";
 interface MarkdownEditorFieldProps {
     highlight?: {
         from: number;

package/dist/hooks/index.d.ts

@@ -24,3 +24,4 @@ export * from "./useBuildNavigationController";
 export * from "./useBuildLocalConfigurationPersistence";
 export * from "./useBuildModeController";
 export * from "./useValidateAuthenticator";
+export * from "./useTranslation";

package/dist/hooks/useBuildNavigationController.d.ts

@@ -1,5 +1,4 @@
 import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, FireCMSPlugin, NavigationController, NavigationGroupMapping, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
-export declare const NAVIGATION_DEFAULT_GROUP_NAME = "Views";
 export declare const NAVIGATION_ADMIN_GROUP_NAME = "Admin";
 export type BuildNavigationContextProps<EC extends EntityCollection, USER extends User> = {
     /**

package/dist/hooks/useCollapsedGroups.d.ts

@@ -6,7 +6,7 @@
  * @param groupNames - Array of group names to track
  * @param namespace - Namespace for localStorage key (e.g., "home", "drawer") to allow independent state
  */
-export declare function useCollapsedGroups(groupNames: string[], namespace?: string): {
-    isGroupCollapsed: (name: string) => boolean;
-    toggleGroupCollapsed: (name: string) => void;
+export declare function useCollapsedGroups(groupNames: (string | null)[], namespace?: string): {
+    isGroupCollapsed: (name?: string | null) => boolean;
+    toggleGroupCollapsed: (name?: string | null) => void;
 };

package/dist/hooks/useTranslation.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Internal hook for translating FireCMS UI strings.
+ *
+ * Uses the `firecms_core` i18next namespace that is initialised by
+ * `FireCMSi18nProvider`. Do NOT use `react-i18next` directly in internal
+ * components — always go through this hook so the namespace is consistent.
+ *
+ * @example
+ * const { t } = useTranslation();
+ * <Button>{t("save")}</Button>
+ *
+ * @internal
+ */
+export declare function useTranslation(): {
+    t: (key: string, vars?: Record<string, string>) => string;
+    i18n: import("i18next").i18n;
+};

package/dist/i18n/FireCMSi18nProvider.d.ts

@@ -0,0 +1,33 @@
+import { PropsWithChildren } from "react";
+import { FireCMSTranslations } from "../types/translations";
+export declare const FIRECMS_LOCALE_STORAGE_KEY = "firecms_locale";
+/** DeepPartial helper — allows partial overrides at any nesting level */
+type DeepPartial<T> = T extends object ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : T;
+export interface FireCMSi18nProviderProps {
+    /** BCP-47 locale tag, e.g. "en", "es", "fr". Defaults to "en". */
+    locale?: string;
+    /**
+     * Override or extend any FireCMS UI string, keyed by locale.
+     *
+     * @example
+     * translations={{
+     *   en: { save: "Publish" },
+     *   es: { save: "Publicar", discard: "Descartar" }
+     * }}
+     */
+    translations?: {
+        [locale: string]: DeepPartial<FireCMSTranslations>;
+    };
+}
+/**
+ * Initialises a dedicated i18next instance for FireCMS's internal UI strings.
+ *
+ * This instance is isolated from any app-level i18next configuration the
+ * consumer may have. Mount this at the top of the FireCMS component tree.
+ *
+ * @internal
+ */
+export declare function FireCMSi18nProvider({ locale, translations, children }: PropsWithChildren<FireCMSi18nProviderProps>): import("react/jsx-runtime").JSX.Element | null;
+export {};

package/dist/index.d.ts

@@ -7,3 +7,7 @@ export * from "./hooks";
 export * from "./components";
 export * from "./util";
 export * from "./contexts";
+export * from "./i18n/FireCMSi18nProvider";
+export * from "./locales/en";
+export * from "./locales/es";
+export * from "./editor";