@firecms/editor 3.0.0-canary.23 → 3.0.0-canary.231

package/LICENSE

@@ -1,21 +1,114 @@
-MIT License
-
-Copyright (c) 2023 FireCMS
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Firecms S.L.
+Licensed Work:        Firecms CMS packages:
+                      cli
+                      collection_editor
+                      collection_editor_firebase
+                      data_enhancement
+                      data_export
+                      data_export
+                      editor
+                      firecms_cloud
+                      schema_inference
+                      user_management
+
+                      The Licensed Work is (c) 2024 Firecms S.L
+Additional Use Grant: You may make use of the Licensed Work, provided that
+                      you may not use the Licensed Work for a CMS Data Enhancement
+                      Service.
+
+                      A “CMS package” is a commercial offering that
+                      allows third parties (other than your employees and
+                      contractors) to access the functionality of the
+                      Licensed Work by using software to extend the base features of
+                      content management system controlled by such third parties.
+
+Change Date:         Four years from the date the Licensed Work is published.
+
+Change License:      MIT
+
+For information about alternative licensing arrangements for the Software,
+please visit: https://firecms.co
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

package/dist/SampleCustomComponent.d.ts

@@ -0,0 +1,10 @@
+import React from "react";
+import { Editor } from "@tiptap/react";
+import { Node as ProseMirrorNode } from "prosemirror-model";
+export interface CustomBlockComponentProps {
+    node: ProseMirrorNode;
+    updateAttributes: (attrs: Record<string, any>) => void;
+    getPos: () => number;
+    editor: Editor;
+}
+export declare const CustomComponent: React.FC<CustomBlockComponentProps>;

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,25 @@
+import React from "react";
 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;
+    customComponents?: CustomEditorComponent[];
+    disabled?: boolean;
 };
-export declare const FireCMSEditor: ({ handleImageUpload, initialContent, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element | null;
+export type CustomEditorComponent = {
+    name: string;
+    component: React.FC;
+};
+export declare const FireCMSEditor: ({ content, onJsonContentChange, onHtmlContentChange, onMarkdownContentChange, version, textSize, highlight, handleImageUpload, aiController, disabled }: FireCMSEditorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/editor_extensions.d.ts

@@ -3,4 +3,10 @@ export declare const tiptapLink: import("@tiptap/core").Mark<import("@tiptap/ext
 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 horizontalRule: import("@tiptap/core").Node<import("@tiptap/extension-horizontal-rule").HorizontalRuleOptions, any>;
+export declare const bulletList: import("@tiptap/core").Node<import("@tiptap/extension-bullet-list").BulletListOptions, any>;
+export declare const orderedList: import("@tiptap/core").Node<import("@tiptap/extension-ordered-list").OrderedListOptions, any>;
+export declare const listItem: import("@tiptap/core").Node<import("@tiptap/extension-list-item").ListItemOptions, any>;
+export declare const blockquote: import("@tiptap/core").Node<import("@tiptap/extension-blockquote").BlockquoteOptions, any>;
+export declare const codeBlock: import("@tiptap/core").Node<import("@tiptap/extension-code-block").CodeBlockOptions, any>;
+export declare const code: import("@tiptap/core").Mark<import("@tiptap/extension-code").CodeOptions, any>;
 export declare const starterKit: import("@tiptap/core").Extension<import("@tiptap/starter-kit").StarterKitOptions, any>;

package/dist/extensions/CustomBlockComponent.d.ts

@@ -0,0 +1,7 @@
+import { Node, NodeViewProps } from "@tiptap/core";
+export type CustomBlockComponentProps = NodeViewProps;
+export interface CustomBlockOptions {
+    component: React.ComponentType<CustomBlockComponentProps> | null;
+    delimiter?: string;
+}
+export declare const CustomBlock: Node<CustomBlockOptions, 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

@@ -6,6 +6,5 @@ import { TaskList } from "@tiptap/extension-task-list";
 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 { PlaceholderExtension as Placeholder, StarterKit, Horizontal as HorizontalRule, TiptapLink, TiptapImage, TaskItem, TaskList, InputRule };
 export { getPrevText } from "../utils/utils";

package/dist/extensions/slashCommand.d.ts

@@ -0,0 +1,91 @@
+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, aiController }: {
+    upload: UploadFn;
+    aiController?: EditorAIController;
+}) => Omit<SuggestionOptions<SuggestionItem, any>, "editor">;