@firecms/editor 3.0.0-beta.7 → 3.0.0-beta.9

package/LICENSE

@@ -3,12 +3,13 @@ Business Source License 1.1
 Parameters
 
 Licensor:             Firecms S.L.
-Licensed Work:        Firecms CMS packages: 
+Licensed Work:        Firecms CMS packages:
                       cli
                       collection_editor
                       collection_editor_firebase
                       data_enhancement
-                      data_import_export
+                      data_export
+                      data_export
                       editor
                       firecms_cloud
                       schema_inference

package/dist/components/index.d.ts

@@ -1,8 +1,5 @@
 export { useCurrentEditor as useEditor } from "@tiptap/react";
 export { type Editor } from "@tiptap/core";
 export type { JSONContent } from "@tiptap/react";
-export { EditorRoot } from "./editor";
 export { EditorBubble } from "./editor-bubble";
 export { EditorBubbleItem } from "./editor-bubble-item";
-export { EditorCommand } from "./editor-command";
-export { EditorCommandItem, EditorCommandEmpty } from "./editor-command-item";

package/dist/editor.d.ts

@@ -1,9 +1,19 @@
 import { type JSONContent } from "./components";
+import { EditorAIController } from "./types";
+export type FireCMSEditorTextSize = "sm" | "base" | "lg";
 export type FireCMSEditorProps = {
-    initialContent?: JSONContent | string;
+    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;
+    onDisabledAutocompleteClick?: () => void;
 };
-export declare const FireCMSEditor: ({ handleImageUpload, initialContent, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const FireCMSEditor: ({ content, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange, version, textSize, highlight, handleImageUpload, aiController, onDisabledAutocompleteClick }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/editor_extensions.d.ts

@@ -2,5 +2,6 @@ export declare const placeholder: import("@tiptap/core").Extension<import("@tipt
 export declare const tiptapLink: import("@tiptap/core").Mark<import("@tiptap/extension-link").LinkOptions, any>;
 export declare const taskList: import("@tiptap/core").Node<import("@tiptap/extension-task-list").TaskListOptions, any>;
 export declare const taskItem: import("@tiptap/core").Node<import("@tiptap/extension-task-item").TaskItemOptions, any>;
+export declare const markdownExtension: import("@tiptap/core").Extension<import("tiptap-markdown").MarkdownOptions, import("tiptap-markdown").MarkdownStorage>;
 export declare const horizontalRule: import("@tiptap/core").Node<import("@tiptap/extension-horizontal-rule").HorizontalRuleOptions, any>;
 export declare const starterKit: import("@tiptap/core").Extension<import("@tiptap/starter-kit").StarterKitOptions, any>;

package/dist/extensions/HighlightDecorationExtension.d.ts

@@ -0,0 +1,35 @@
+import { Extension } from "@tiptap/core";
+import { PluginKey } from "@tiptap/pm/state";
+import { DecorationSet } from "@tiptap/pm/view";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        highlightDecoration: {
+            toggleAutocompleteHighlight: (range?: {
+                from: number;
+                to: number;
+            }) => ReturnType;
+            removeAutocompleteHighlight: () => ReturnType;
+        };
+    }
+}
+export interface HighlightRange {
+    from: number;
+    to: number;
+}
+interface AutocompleteHighlightState {
+    highlight?: HighlightRange;
+    decorationSet?: DecorationSet;
+}
+export interface HighlightDecorationOptions {
+    pluginKey: PluginKey<AutocompleteHighlightState>;
+    highlight?: {
+        from: number;
+        to: number;
+    };
+}
+/**
+ * This plugin is used to highlight the current autocomplete suggestion.
+ * It allows to set a range and remove it.
+ */
+export declare const HighlightDecorationExtension: (initialHighlight?: HighlightRange) => Extension<HighlightDecorationOptions, any>;
+export {};

package/dist/extensions/Image.d.ts

@@ -1,4 +1,7 @@
-import { Plugin } from "prosemirror-state";
+import { EditorView } from "@tiptap/pm/view";
+import { Plugin, PluginKey } from "@tiptap/pm/state";
 export type UploadFn = (image: File) => Promise<string>;
-export declare const dropImagePlugin: (upload: UploadFn) => Plugin<any>;
-export declare const createImageExtension: (uploadFn: UploadFn) => import("@tiptap/core").Node<import("@tiptap/extension-image").ImageOptions, any>;
+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;
+export declare const createImageExtension: (dropImagePlugin: Plugin) => import("@tiptap/core").Node<import("@tiptap/extension-image").ImageOptions, any>;

package/dist/extensions/InlineAutocomplete.d.ts

@@ -0,0 +1,7 @@
+import { Node } from "@tiptap/core";
+export declare const AutocompleteExtension: Node<{
+    suggestionDebounce: number;
+}, {
+    getSuggestion: ((previousText: string, cb: (suggestion: string | null) => void) => void) | undefined;
+    suggestion: string | null;
+}>;

package/dist/extensions/TextLoadingDecorationExtension.d.ts

@@ -0,0 +1,18 @@
+import { PluginKey } from "prosemirror-state";
+import { DecorationSet } from "prosemirror-view";
+import { Extension } from "@tiptap/core";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        textLoadingDecoration: {
+            toggleLoadingDecoration: (loadingHtml?: string) => ReturnType;
+            removeLoadingDecoration: () => ReturnType;
+        };
+    }
+}
+export declare const loadingDecorationKey: PluginKey<LoadingDecorationState>;
+interface LoadingDecorationState {
+    decorationSet: DecorationSet;
+    hasDecoration: boolean;
+}
+declare const TextLoadingDecorationExtension: Extension<any, any>;
+export default TextLoadingDecorationExtension;

package/dist/extensions/_image-resizer.d.ts

@@ -1,2 +1 @@
-/// <reference types="react" />
 export declare const ImageResizer: () => JSX.Element | null;

package/dist/extensions/index.d.ts

@@ -7,5 +7,4 @@ import { InputRule } from "@tiptap/core";
 declare const PlaceholderExtension: import("@tiptap/core").Extension<import("@tiptap/extension-placeholder").PlaceholderOptions, any>;
 declare const Horizontal: import("@tiptap/core").Node<import("@tiptap/extension-horizontal-rule").HorizontalRuleOptions, any>;
 export { PlaceholderExtension as Placeholder, StarterKit, Horizontal as HorizontalRule, TiptapLink, TiptapImage, TaskItem, TaskList, InputRule, };
-export * from "./slash-command";
 export { getPrevText } from "../utils/utils";

package/dist/extensions/slashCommand.d.ts

@@ -0,0 +1,92 @@
+import React, { ReactNode } from "react";
+import { Editor, Node, Range } from "@tiptap/react";
+import { DOMOutputSpec, Node as ProseMirrorNode } from "@tiptap/pm/model";
+import { PluginKey } from "@tiptap/pm/state";
+import { SuggestionOptions } from "@tiptap/suggestion";
+import { UploadFn } from "./Image";
+import { EditorAIController } from "../types";
+export interface CommandNodeAttrs {
+    /**
+     * The identifier for the selected item that was mentioned, stored as a `data-id`
+     * attribute.
+     */
+    id: string | null;
+    /**
+     * The label to be rendered by the editor as the displayed text for this mentioned
+     * item, if provided. Stored as a `data-label` attribute. See `renderLabel`.
+     */
+    label?: string | null;
+}
+export type CommandOptions<SuggestionItem = any, Attrs extends Record<string, any> = CommandNodeAttrs> = {
+    /**
+     * The HTML attributes for a command node.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * A function to render the label of a command.
+     * @deprecated use renderText and renderHTML instead
+     * @param props The render props
+     * @returns The label
+     * @example ({ options, node }) => `${options.suggestion.char}${node.attrs.label ?? node.attrs.id}`
+     */
+    renderLabel?: (props: {
+        options: CommandOptions<SuggestionItem, Attrs>;
+        node: ProseMirrorNode;
+    }) => string;
+    /**
+     * A function to render the text of a command.
+     * @param props The render props
+     * @returns The text
+     * @example ({ options, node }) => `${options.suggestion.char}${node.attrs.label ?? node.attrs.id}`
+     */
+    renderText: (props: {
+        options: CommandOptions<SuggestionItem, Attrs>;
+        node: ProseMirrorNode;
+    }) => string;
+    /**
+     * A function to render the HTML of a command.
+     * @param props The render props
+     * @returns The HTML as a ProseMirror DOM Output Spec
+     * @example ({ options, node }) => ['span', { 'data-type': 'command' }, `${options.suggestion.char}${node.attrs.label ?? node.attrs.id}`]
+     */
+    renderHTML: (props: {
+        options: CommandOptions<SuggestionItem, Attrs>;
+        node: ProseMirrorNode;
+    }) => DOMOutputSpec;
+    /**
+     * Whether to delete the trigger character with backspace.
+     * @default false
+     */
+    deleteTriggerWithBackspace: boolean;
+    /**
+     * The suggestion options.
+     * @default {}
+     * @example { char: '@', pluginKey: CommandPluginKey, command: ({ editor, range, props }) => { ... } }
+     */
+    suggestion: Omit<SuggestionOptions<SuggestionItem, Attrs>, "editor">;
+};
+/**
+ * The plugin key for the command plugin.
+ * @default 'command'
+ */
+export declare const CommandPluginKey: PluginKey<any>;
+export declare const SlashCommand: Node<CommandOptions<any, CommandNodeAttrs>, any>;
+export interface SuggestionItem {
+    title: string;
+    description: string;
+    icon: ReactNode;
+    searchTerms?: string[];
+    command?: (props: {
+        editor: Editor;
+        range: Range;
+        upload: UploadFn;
+        aiController?: EditorAIController;
+    }) => void;
+}
+export declare const suggestion: (ref: React.MutableRefObject<any>, { upload, onDisabledAutocompleteClick, aiController }: {
+    upload: UploadFn;
+    onDisabledAutocompleteClick?: () => void;
+    aiController?: EditorAIController;
+}) => Omit<SuggestionOptions<SuggestionItem, any>, "editor">;