@wix/ricos 11.25.0 → 11.26.0

package/dist/src/ricos-types/plugin-types.d.ts

@@ -82,6 +82,8 @@ export type AddButton = {
     shortcuts?: KeyboardShortcut[];
     /** The options this button's picker offers, when it opens one. */
     options?: PickerOption[];
+    /** Shows the translated `tooltip` as the button's visible label in the footer toolbar. */
+    showLabel?: boolean;
 };
 /**
  * Tooltip shown on a plugin toolbar button. Either a translation key (resolved

package/dist/src/ricos-types/ricos-types.d.ts

@@ -130,6 +130,11 @@ export interface EditorProps extends CommonProps {
     onLoad?: (editor: any) => void;
     autofocus?: FocusPosition;
     container?: HTMLElement | (() => HTMLElement | null);
+    /**
+     * The element the editor's popovers, menus and modals are rendered into, instead of `document.body`:
+     * a host's own layer, so they stack with its panels rather than over them.
+     */
+    portalContainer?: HTMLElement | (() => HTMLElement | null);
     content?: RichContent;
     keyboardShortcuts?: CustomizableKeyboardShortcut[];
     /**

package/dist/src/testkit.d.ts

@@ -168,6 +168,11 @@ export declare const createViewerTestkit: ({ getBase }: {
                 waitForElement: () => Promise<void>;
                 popover: import("./_shared/dropdown-modal/dropdown-modal-uni-driver").DropdownModalUniDriver;
             };
+            menu: {
+                waitForElement: () => Promise<void>;
+                popover: import("./_shared/dropdown-modal/dropdown-modal-uni-driver").DropdownModalUniDriver;
+                promptInput: ReturnType<typeof import("@wix/design-system/dist/testkit/unidriver").InputUniDriver>;
+            };
             integrations: {
                 captionTrigger: {
                     button: ReturnType<typeof import("@wix/design-system/dist/testkit/unidriver").IconButtonUniDriver>;
@@ -1579,6 +1584,11 @@ export declare const createEditorTestkit: ({ getBase }: {
                 waitForElement: () => Promise<void>;
                 popover: import("./_shared/dropdown-modal/dropdown-modal-uni-driver").DropdownModalUniDriver;
             };
+            menu: {
+                waitForElement: () => Promise<void>;
+                popover: import("./_shared/dropdown-modal/dropdown-modal-uni-driver").DropdownModalUniDriver;
+                promptInput: ReturnType<typeof import("@wix/design-system/dist/testkit/unidriver").InputUniDriver>;
+            };
             integrations: {
                 captionTrigger: {
                     button: ReturnType<typeof import("@wix/design-system/dist/testkit/unidriver").IconButtonUniDriver>;

package/dist/src/tiptap-editor/components/RicosTiptapEditor/core-configs.d.ts

@@ -16,7 +16,9 @@ export declare const coreConfigs: (import("../../../ricos-types/tiptap.js").Rico
 }, unknown> | import("../../../ricos-types/tiptap.js").RicosFunctionalExtension<{
     styles: import("../../../ricos-types/styles.js").AmbientStyles;
     converters: import("../../../converters.js").PmConverters;
-}, unknown> | import("../../../ricos-types/tiptap.js").RicosMarkExtension<any, any> | import("../../../ricos-types/tiptap.js").RicosMarkExtension<{
+}, {
+    documentStyle?: import("../../../schema.js").DocumentStyle;
+}> | import("../../../ricos-types/tiptap.js").RicosMarkExtension<any, any> | import("../../../ricos-types/tiptap.js").RicosMarkExtension<{
     HTMLAttributes: Record<string, string>;
     inclusive: boolean;
 }, unknown> | import("../../../ricos-types/tiptap.js").RicosNodeExtension<any, any> | import("../../../ricos-types/tiptap.js").RicosNodeExtension<unknown, unknown> | import("../../../ricos-types/tiptap.js").RicosNodeExtension<{

package/dist/src/tiptap-extensions/ricos-styles.d.ts

@@ -5,6 +5,24 @@ import type { AmbientStyles } from '../ricos-types/index.js';
 import type { CommandProps, Editor } from '../tiptap/core/index';
 import type { Node as ProseMirrorNode } from '../tiptap/pm/model';
 import type { EditorState } from '../tiptap/pm/state';
+import { Step, StepResult } from '../tiptap/pm/transform';
+export declare class SetDocAttrStep extends Step {
+    private key;
+    private value;
+    private prevValue;
+    constructor(key: string, value: $TSFixMe);
+    get stepType(): string;
+    apply(doc: $TSFixMe): StepResult;
+    invert(): SetDocAttrStep;
+    map(): this;
+    toJSON(): {
+        stepType: string;
+        key: string;
+        value: any;
+    };
+    static fromJSON(schema: $TSFixMe, json: $TSFixMe): SetDocAttrStep;
+    static register(): boolean;
+}
 declare module '../tiptap/core/index' {
     interface Commands<ReturnType> {
         styles: {
@@ -47,4 +65,6 @@ export declare const getLineHeightStyleBySelectedNode: ({ tiptapEditor, styles,
 export declare const ricosStyles: import("../ricos-types/index.js").RicosFunctionalExtension<{
     styles: AmbientStyles;
     converters: PmConverters;
-}, unknown>;
+}, {
+    documentStyle?: DocumentStyle;
+}>;

package/dist/src/wix-rich-content-common/Utils/fetch-editor-translations.d.ts

@@ -38,6 +38,7 @@ export declare const fetchEditorTranslations: (locale?: string) => Promise<{
         Layout_SettingsModal_Tab_Layout_Responsivness_Behaviour_Tooltip: string;
         ShapeSelectModalContent_Search_ErrorState_Title_Icons: string;
         SoundCloudUploadModal_Input_Placeholder: string;
+        AIPlugin_ToolbarButton_EditWithAI: string;
         LinkSettings_SitePages_StaticPage_EmptyState_Text2: string;
         Layout_SettingsModal_Tab_Design_Image_BackgroundScaling_Contain: string;
         QuickActionsPlugin_ActionTitle_Event: string;
@@ -76,6 +77,7 @@ export declare const fetchEditorTranslations: (locale?: string) => Promise<{
         ShortcutsSheet_CollapsibleList_SelectTheEntireList: string;
         LinkSettings_Sections_Empty_Text1: string;
         Media_Controls_Subtitle: string;
+        AIPlugin_InsertButton: string;
         TablePlugin_AI_CreateWithAI_Button: string;
         Embed_Vertical_Stores_EmptyState_NotInstalled_Title: string;
         HtmlPlugin_AiWidget_WidgetTypeSelector_ButtonLabel: string;
@@ -387,6 +389,7 @@ export declare const fetchEditorTranslations: (locale?: string) => Promise<{
         ShapeSelectModalContent_Search_EmptyState_Text: string;
         Layout_SettingsModal_Tab_Layout_VerticalMargin_Tooltip: string;
         AnimationPanel_Shape_Label: string;
+        AIPlugin_Menu_PromptInput_Submit_AriaLabel: string;
         ShortcutsSheet_Table_EnterExitASelectedCell: string;
         Media_Controls_Label: string;
         GiphyUploadModal_Search_Placeholder: string;
@@ -1135,6 +1138,7 @@ export declare const fetchEditorTranslations: (locale?: string) => Promise<{
         VideoUploadModal_Input_InvalidUrl: string;
         QuickActionsPlugin_ActionTitle_AdSense: string;
         TextColorButton_Tooltip: string;
+        AIPlugin_Menu_PromptInput_Placeholder: string;
         Embed_Vertical_Add_Button: string;
         Layout_SettingsModal_Tab_Layout_Responsivness_Breakpoint_Label: string;
         AnimationPanel_Delay_Label: string;
@@ -1188,6 +1192,7 @@ export declare const fetchEditorTranslations: (locale?: string) => Promise<{
         ShortcutsSheet_Table_DeleteSelectedColumnRow: string;
         AnimationPanel_Effect_Wink: string;
         Layout_SettingsModal_Tab_Design_Toggle_Image: string;
+        AIPlugin_ToolbarButton_CreateWithAI: string;
         SizeSmallButton_Tooltip: string;
         LinkSettings_Action_Save: string;
         QuickActionsPlugin_ActionTitle_TikTokVideo: string;
@@ -1347,6 +1352,7 @@ export declare const fetchEditorTranslations: (locale?: string) => Promise<{
         LinkSettings_SitePages_BlogPost_EmptyState_Text2: string;
         MapSettings_Location_Input_Placeholder: string;
         UploadVideo_Error_StorageExceeded_Visitor: string;
+        AIPlugin_Menu_Back_AriaLabel: string;
         LinkSettings_Sections_Empty_Text2: string;
         ShapeSelectModal_Header_Title_Graphics: string;
         BlockToolbar_Section_Embed_Anywhere: string;

package/generated/public.d.ts

@@ -1,3 +1,4 @@
+import type { Awareness } from 'y-protocols/awareness';
 import { BiLoggerFactory } from '@wix/wix-bi-logger-client';
 import { BiLoggerManager } from '@wix/wix-bi-logger-client';
 import type { Component } from 'react';
@@ -186,10 +187,83 @@ export declare type AiImageGeneration = {
     }) => Promise<AiGeneratedImage>;
 };
 
+export declare type AiMenuAction = {
+    type: 'action';
+    title: string;
+    icon?: IconComponent;
+    dataHook?: string;
+    onClick: (context: AiMenuContext) => void;
+};
+
+export declare type AiMenuConfig = {
+    /** Items of the "Create with AI" menu. Ricos adds none of its own. */
+    createItems?: AiMenuItem[];
+    /** Items of the "Edit with AI" menu, opened over a selection. Ricos adds none of its own. */
+    editItems?: AiMenuItem[];
+    onPromptSubmit?: (prompt: string, context: AiMenuContext) => AiMenuPromptSubmitResult;
+    /**
+     * Floats an "Edit with AI" button above a text selection, opening the `edit` menu.
+     *
+     * @default true
+     */
+    selectionButton?: boolean;
+    /**
+     * Adds a "Create with AI" button to the footer toolbar.
+     *
+     * @default false
+     */
+    footerButton?: boolean;
+};
+
+export declare type AiMenuContext = {
+    mode: AiMenuMode;
+    /** The selection the menu was opened over, empty in `create` mode. */
+    selection: RicosDocument;
+    /** `selection` as attribute-free HTML, e.g. to pass to a prompt. */
+    selectionHtml: string;
+    selectionText: string;
+};
+
+export declare type AiMenuItem = Prompt | AiMenuAction | AiMenuSubmenu | Section | Divider;
+
+/** `create` when there is nothing under the cursor to work on, `edit` when there is. */
+export declare type AiMenuMode = 'create' | 'edit';
+
+/**
+ * What the host does with a prompt typed into the menu's input: `stop` when it handled the
+ * prompt itself, `continue` to run it in the AI content modal.
+ */
+export declare type AiMenuPromptSubmitResult = 'continue' | 'stop';
+
+/**
+ * A row that opens its own list of items, e.g. "Change tone": in a flyout beside the menu on
+ * desktop, in place of the menu's rows on mobile.
+ */
+export declare type AiMenuSubmenu = {
+    type: 'submenu';
+    title: string;
+    icon?: IconComponent;
+    dataHook?: string;
+    items: AiMenuItem[];
+};
+
 declare interface AiPluginEditorConfig extends EditorPluginConfig {
     type: 'ai';
     configurePrompts?: (prompts: PromptsConfiguration) => PromptsConfiguration;
+    /**
+     * @deprecated Pass `menu` and configure `menu.createItems` instead.
+     */
     configureFlowSelectionItems?: (items: FlowSelectionItem[]) => FlowSelectionItem[];
+    /**
+     * Opts into the AI menu: host actions and prompts above an "Ask me anything…" input. The
+     * toolbar button (and, with `footerButton`, the footer toolbar) opens it as "Create with AI",
+     * as does `openModal({ type: 'AI_MENU' })` on the editor's ref;
+     * a button floating over a text selection opens it as "Edit with AI" and replaces the
+     * sparkle side button. The plugin's own AI quick actions are left out, as the menu's items
+     * are all the host's. Without it the plugin keeps its previous dropdowns, side button and
+     * quick actions.
+     */
+    menu?: AiMenuConfig;
     getGatewayBaseUrl?: () => string;
     appDefId?: string;
     enableImageCaptionExport?: boolean;
@@ -2146,6 +2220,11 @@ declare type CollaborationOptions = {
     yUndoOptions?: YUndoOpts;
 };
 
+declare type CollabUndoEntry = {
+    undo: () => void;
+    redo: () => void;
+};
+
 export declare const COLLAPSIBLE_LIST_TYPE = "wix-rich-content-plugin-collapsible-list";
 
 export declare type CollapsibleItemBodyNode = Identified & Styled & RichContainer & {
@@ -5587,6 +5666,7 @@ declare type InsertPluginButtons = {
     LAYOUT: 'Layout_InsertButton';
     TOC: 'TocPlugin_InsertButton';
     SMART_BLOCK: 'SmartBlock_InsertButton_Label';
+    AI: 'AIPlugin_InsertButton';
 };
 
 declare type InsertToolbarConfig = {
@@ -8825,7 +8905,12 @@ export declare const pluginCodeBlock: (config?: Omit<CodeBlockPluginEditorConfig
 
 export declare const pluginCodeBlockViewer: _ViewerPluginFactory;
 
-export declare const pluginCollab: (options?: CollaborationOptions) => EditorPluginOptions_2;
+export declare const pluginCollab: (options?: PluginCollabOptions) => EditorPluginOptions_2;
+
+export declare type PluginCollabOptions = CollaborationOptions & {
+    pushToUndoStack?: (entry: CollabUndoEntry) => void;
+    cursors?: PresenceOptions;
+};
 
 export declare const pluginCollapsibleList: (config?: Omit<CollapsibleListPluginEditorConfig, 'type'>) => CollapsibleListPluginEditorConfig;
 
@@ -9880,6 +9965,18 @@ declare type PollSettings = {
     resultsVisibility: string;
 };
 
+declare type PresenceIdentity = {
+    name?: string;
+    color?: string;
+};
+
+declare type PresenceOptions = {
+    awareness: Awareness;
+    user?: Required<PresenceIdentity>;
+    resolveUser?: (clientId: number) => PresenceIdentity | undefined;
+    subscribe?: (onChange: () => void) => (() => void) | void;
+};
+
 declare type Prompt = {
     type: 'prompt';
     title: string;
@@ -10297,9 +10394,11 @@ export declare interface RicosEditorAPI {
     /* Excluded from this release type: getEditorCommands */
     /** Returns the DOM element wrapping the editor's content-editable, if mounted. */
     getEditorContainer(): HTMLElement | undefined;
-    /** Opens a built-in modal (AI image generation, inline AI, keyboard shortcuts sheet, or AI widget). */
+    /** Opens a built-in modal (AI image generation, the AI menu, inline AI, keyboard shortcuts sheet, or AI widget). */
     openModal: (options: {
-        type: 'AI_IMAGE' | 'INLINE_AI' | 'SHORTCUTS_SHEET' | 'AI_WIDGET';
+        type: 'AI_IMAGE' | 'AI_MENU' | 'INLINE_AI' | 'SHORTCUTS_SHEET' | 'AI_WIDGET';
+        /** The element `AI_MENU` opens under, such as the host's own button. Defaults to the block at the cursor. */
+        referenceElement?: HTMLElement;
     }) => void;
     /**
      * Subscribe to the reactive button list for a toolbar. Re-runs on selection
@@ -10399,6 +10498,11 @@ export declare interface RicosEditorProps {
     autofocus?: FocusPosition;
     /** HTML element or factory function that returns the container element for rendering editor popovers and modals. */
     container?: HTMLElement | (() => HTMLElement | null);
+    /**
+     * The element the editor's popovers, menus and modals are rendered into, instead of `document.body`:
+     * a host's own layer, so they stack with its panels rather than over them.
+     */
+    portalContainer?: HTMLElement | (() => HTMLElement | null);
     /** Initial content for the editor. Only used during initialization — not a controlled value. */
     initialContent?: RicosDocument;
     /** Custom keyboard shortcuts to register with the editor. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/ricos",
-  "version": "11.25.0",
+  "version": "11.26.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Rich Content Team",
@@ -349,7 +349,7 @@
     "@wix/bi-logger-rce-data": "^1.33.0",
     "@wix/bi-logger-rich-editor": "^1.1867.0",
     "@wix/image": "^1.455.0",
-    "@wix/ricos-schema": "11.25.0",
+    "@wix/ricos-schema": "11.26.0",
     "@wix/web-bi-logger": "^2.1.32",
     "@wix/wix-bi-logger-client": "^1.0.6",
     "chokidar": "^4.0.1",
@@ -392,5 +392,5 @@
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0"
   },
-  "falconPackageHash": "c0bd8c81946ccb8a02bd15466ea8e4630a932837c1e1069c56205b4a"
+  "falconPackageHash": "8333b7fb7d2d099c710ae93c4b8e7ee1b3af3fa6b29c9e820b8e601c"
 }