@wix/ricos 11.24.1 → 11.26.0

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';
@@ -168,16 +169,108 @@ declare type AddTextMethod<T> = {
     }) => RichContent_2;
 };
 
+export declare type AiGeneratedImage = {
+    url: string;
+    id: string;
+    altText?: string;
+    width?: number;
+    height?: number;
+};
+
+export declare type AiImageGeneration = {
+    getInitialPrompt?: (selection: string) => string;
+    generateImage: (options: {
+        prompt: string;
+        selection: string;
+        imageStyle: ImageStyle;
+        signal: AbortSignal;
+    }) => 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;
     enableImageAltTextExport?: boolean;
     showToolbarButtonText?: boolean;
     enableImageGeneration?: boolean;
+    imageGeneration?: AiImageGeneration;
     selectParentNodeOnToolbarClick?: boolean;
 }
 
@@ -2127,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 & {
@@ -5192,6 +5290,20 @@ declare type IdOrUrl = {
     url: string;
 };
 
+declare const IMAGE_STYLES: {
+    NONE: string;
+    DIGITAL_ART: string;
+    REALISM: string;
+    ANIME: string;
+    CINEMATIC: string;
+    THREE_DIMENSIONAL: string;
+    CARTOON: string;
+    PACKSHOT_STUDIO: string;
+    NEON: string;
+    COMICS: string;
+    BLACK_AND_WHITE_DRAWING: string;
+};
+
 export declare const IMAGE_TYPE = "wix-draft-plugin-image";
 
 declare const IMAGE_TYPE_LEGACY = "IMAGE";
@@ -5467,6 +5579,8 @@ declare const ImageScaling: {
     readonly COVER: 'COVER';
 };
 
+declare type ImageStyle = keyof typeof IMAGE_STYLES;
+
 export declare const INDENT_TYPE = "wix-rich-content-plugin-indent";
 
 declare interface IndentPluginEditorConfig extends EditorPluginConfig {
@@ -5552,6 +5666,7 @@ declare type InsertPluginButtons = {
     LAYOUT: 'Layout_InsertButton';
     TOC: 'TocPlugin_InsertButton';
     SMART_BLOCK: 'SmartBlock_InsertButton_Label';
+    AI: 'AIPlugin_InsertButton';
 };
 
 declare type InsertToolbarConfig = {
@@ -8790,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;
 
@@ -9845,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;
@@ -10262,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
@@ -10364,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.24.1",
+  "version": "11.26.0",
   "license": "UNLICENSED",
   "author": {
     "name": "Rich Content Team",
@@ -170,7 +170,7 @@
   "scripts": {
     "build": "node --run clean && node --run build:prebuild && concurrently --kill-others-on-fail -n esbuild,types -c green.bold,blue.bold \"node --run build:esbuild\" \"node --run build:tsc && node --run build:api && node --run build:docs\"",
     "build:docs": "node src/api-docs-gen/scripts/api-doc-to-md-script.ts",
-    "build:dev": "NODE_ENV=development yarn build",
+    "build:dev": "NODE_ENV=development pnpm run build",
     "build:tsc": "echo 'Building TSC..' && tsc --emitDeclarationOnly --declarationMap false && tsc-alias --inputglob 'd.{mts,cts,ts,tsx}'",
     "build:tsc:watch": "tsc --emitDeclarationOnly --watch --preserveWatchOutput & tsc-alias --watch",
     "build:tsc:no-emit": "tsc --noEmit",
@@ -185,20 +185,20 @@
     "build:esbuild": "node ./esbuild.build.mts",
     "build:esbuild:watch": "node ./esbuild.watch.mts",
     "build:api": "api-extractor run --config api-extractor.json --local && api-extractor run --config api-extractor-content.json --local && node scripts/externalize-schema-types.ts",
-    "start": "run watch",
-    "dev": "run watch",
+    "start": "pnpm run watch",
+    "dev": "pnpm run watch",
     "clean": "rm -rf dist/",
     "lint": "oxlint src/**/*.{js,jsx,ts,tsx,d.ts}",
-    "lint:fix": "run lint --fix",
+    "lint:fix": "pnpm run lint --fix",
     "format": "oxfmt src/**/*.{js,jsx,ts,tsx,d.ts}",
-    "format:check": "run format --check",
+    "format:check": "pnpm run format --check",
     "test": "vitest run",
     "test:debug": "vitest --inspect-brk --no-file-parallelism run",
     "test:watch": "vitest",
     "test:types": "tsc --ignoreConfig --skipLibCheck --noEmit src/ricos-schema/next-schema/test-against-proto.ts",
-    "test:docs": "git diff --quiet ./src/ricos-schema || { echo 'Detected uncommitted changes in ricos-schema after build - did you forget to rebuild localy?'; git diff ./src/ricos-schema; exit 1; }",
-    "test:internal-fixtures": "git diff --quiet HEAD -- ./src/internal-fixtures/registry.ts ./src/internal-fixtures/content-slug.d.ts || { echo 'Detected uncommitted changes in the generated internal fixture files after build - did you forget to regenerate locally?'; git diff HEAD -- ./src/internal-fixtures/registry.ts ./src/internal-fixtures/content-slug.d.ts; exit 1; }",
-    "test:api": "git diff --quiet ./generated/public.d.ts ./generated/public-content.d.ts || { echo 'Detected uncommitted changes in ricos Typescript API in generated/*.d.ts after build - did you forget to rebuild localy?'; git diff ./generated/public.d.ts ./generated/public-content.d.ts; exit 1; }",
+    "test:docs": "git diff --quiet ./src/ricos-schema || (echo 'Detected uncommitted changes in ricos-schema after build - did you forget to rebuild localy?'; git diff ./src/ricos-schema; exit 1)",
+    "test:internal-fixtures": "git diff --quiet HEAD -- ./src/internal-fixtures/registry.ts ./src/internal-fixtures/content-slug.d.ts || (echo 'Detected uncommitted changes in the generated internal fixture files after build - did you forget to regenerate locally?'; git diff HEAD -- ./src/internal-fixtures/registry.ts ./src/internal-fixtures/content-slug.d.ts; exit 1)",
+    "test:api": "git diff --quiet ./generated/public.d.ts ./generated/public-content.d.ts || (echo 'Detected uncommitted changes in ricos Typescript API in generated/*.d.ts after build - did you forget to rebuild localy?'; git diff ./generated/public.d.ts ./generated/public-content.d.ts; exit 1)",
     "verify:consumer-graph": "node scripts/verify-consumer-graph.ts",
     "verify:viewer-graph": "node scripts/verify-viewer-graph.ts",
     "verify:dist-json": "node scripts/verify-dist-json.ts",
@@ -206,8 +206,8 @@
     "verify:pack": "node scripts/verify-pack.ts",
     "viPreview": "vitest-preview",
     "knip": "knip",
-    "watch:all": "concurrently \"yarn build:esbuild:watch --all\" \"yarn build:tsc:watch\" -c \"green.bold,blue.bold\" -n \"esbuild,tsc\"",
-    "watch": "concurrently \"yarn build:esbuild:watch --all\" \"yarn build:tsc:watch\" -c \"green.bold,blue.bold\" -n \"esbuild,tsc\"",
+    "watch:all": "concurrently \"pnpm run build:esbuild:watch --all\" \"pnpm run build:tsc:watch\" -c \"green.bold,blue.bold\" -n \"esbuild,tsc\"",
+    "watch": "concurrently \"pnpm run build:esbuild:watch --all\" \"pnpm run build:tsc:watch\" -c \"green.bold,blue.bold\" -n \"esbuild,tsc\"",
     "generate-translation-keys": "babel-cli",
     "generate-internal-fixtures-registry": "node scripts/generate-internal-fixtures-registry.ts && oxfmt src/internal-fixtures/registry.ts src/internal-fixtures/content-slug.d.ts"
   },
@@ -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.24.1",
+    "@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": "744d0d500e1316adfe37ea782ae6f516222e462c6b4439f2a1800d34"
+  "falconPackageHash": "8333b7fb7d2d099c710ae93c4b8e7ee1b3af3fa6b29c9e820b8e601c"
 }