@wix/ricos 10.110.0 → 10.112.0

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/node_caption.json

@@ -4,13 +4,13 @@
     "CaptionNode": {
       "metadata": {
         "examples": [],
-        "description": "Represents a caption container that can be attached to media elements like images. Captions support formatted text content and can be styled independently from their parent nodes."
+        "description": "Caption container to be attached to media elements, such as images. Captions support formatted text content and can be styled independently from their parent nodes."
       },
       "properties": {
         "type": {
           "enum": ["CAPTION"],
           "metadata": {
-            "description": "Node type. \n Value: `CAPTION`"
+            "description": "Node type. \n Must be `CAPTION`."
           }
         },
         "nodes": {
@@ -23,19 +23,19 @@
         "id": {
           "type": "string",
           "metadata": {
-            "description": "Caption node ID. The editor generates the ID automatically. If you're using the Ricos object in an API, you have to add this ID manually, if needed."
+            "description": "Caption [node ID](#node-ids)."
           }
         },
         "style": {
           "ref": "NodeStyle",
           "metadata": {
-            "description": "Defines the caption style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
+            "description": "Defines the caption styling, such as padding and background color. \n **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled."
           }
         },
         "captionData": {
           "ref": "CaptionData",
           "metadata": {
-            "description": "Caption options node."
+            "description": "Caption options."
           }
         }
       }
@@ -45,7 +45,7 @@
         "textStyle": {
           "ref": "TextStyle",
           "metadata": {
-            "description": "Styling for the caption text."
+            "description": "Caption text styling."
           }
         }
       }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/node_code_block.json

@@ -5,13 +5,13 @@
       "metadata": {
         "features": ["CODE_BLOCK"],
         "examples": ["code-block-multi-line", "code-block-syntax-highlighting"],
-        "description": "Used to present programming code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code."
+        "description": "Presents code snippets, markup, or other text-based content that should be displayed exactly as it appears, without any interpretation or formatting applied by the browser. When rendered, it is displayed as the code block with a monospaced font, preserving indentation, line breaks, and spacing as specified in the code."
       },
       "properties": {
         "type": {
           "enum": ["CODE_BLOCK"],
           "metadata": {
-            "description": "Node type. \n Value: `CODE_BLOCK`"
+            "description": "Node type. \n VMust be `CODE_BLOCK`."
           }
         }
       },
@@ -40,7 +40,7 @@
         "style": {
           "ref": "NodeStyle",
           "metadata": {
-            "description": "Defines the blockquote style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
+            "description": "Code block styling, such as padding and background color. \n **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled."
           }
         }
       }
@@ -50,7 +50,7 @@
         "textStyle": {
           "ref": "TextStyle",
           "metadata": {
-            "description": "Defines the text style, such as alignment and line height."
+            "description": "Defines the text styling, such as alignment and line height."
           }
         }
       }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/node_heading.json

@@ -4,13 +4,13 @@
     "HeadingNode": {
       "metadata": {
         "examples": ["headings-all-sizes"],
-        "description": "Used to denote the heading or title of a section. Headings are hierarchical, with different levels indicating the relative importance of the heading in the content's structure. There are 6 levels of headings, where `1` is the highest level and `6` is the lowest."
+        "description": "Indicates a heading or title of a section. There are 6 levels of headings, with `1` being the most prominent and `6` being the least."
       },
       "properties": {
         "type": {
           "enum": ["HEADING"],
           "metadata": {
-            "description": "Node type. \n Value: `HEADING`"
+            "description": "Node type. \n Must be `HEADING`."
           }
         }
       },
@@ -33,7 +33,7 @@
         "style": {
           "ref": "NodeStyle",
           "metadata": {
-            "description": "Defines the heading style, such as padding and background color. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
+            "description": "Heading styling, such as padding and background color. \n **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled."
           }
         },
         "headingData": {
@@ -49,7 +49,7 @@
         "level": {
           "type": "int32",
           "metadata": {
-            "description": "Heading size from `1` to `6`, where `1` is the highest level and `6` is the lowest.",
+            "description": "Heading size. <br> Mi: `1` <br> Max: `6`",
             "validation": {
               "min": 1,
               "max": 6
@@ -59,13 +59,13 @@
         "textStyle": {
           "ref": "TextStyle",
           "metadata": {
-            "description": "Defines the heading text style, such as text alignment and line height."
+            "description": "Heading text styling, such as text alignment and line height."
           }
         },
         "indentation": {
           "type": "int32",
           "metadata": {
-            "description": "Heading margin from the left side. Possible values are from `1` to `4`. \n The indentation is measured in relative to the font size *em* units, by the following formula: **indentation * 1.5**. For example, if indentation is `2`, then margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
+            "description": "Heading margin from the left side. \n The indentation is measured relative to the font size *em* units by a ratio of 1.5. For example, if the indentation is `2`, then the margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
           }
         }
       }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/node_list.json

@@ -4,13 +4,13 @@
     "OrderedListNode": {
       "metadata": {
         "examples": ["orderedList"],
-        "description": "Presents a group of items in a sequentially numbered or lettered manner. Ordered lists are used to represent information that has a specific order or sequence."
+        "description": "Numbered list."
       },
       "properties": {
         "type": {
           "enum": ["ORDERED_LIST"],
           "metadata": {
-            "description": "Node type. \n Value: `ORDERED_LIST`"
+            "description": "Node type. \n Must be `ORDERED_LIST`."
           }
         },
         "nodes": {
@@ -52,19 +52,19 @@
           "type": "int32",
           "metadata": {
             "deprecated": true,
-            "description": "List margin from the left side. Possible values are from `1` to `4`. \n The indentation is measured in relative to the font size *em* units, by the following formula: **indentation * 1.5**. For example, if indentation is `2`, then margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
+            "description": "List margin from the left side. \n The indentation is measured relative to the font size *em* units by a ratio of 1.5. For example, if the indentation is `2`, then the margin is equal to **3em**. Therefore the margin is 3 times the size of the font."
           }
         },
         "offset": {
           "type": "int32",
           "metadata": {
-            "description": "An integer (ranging from 0 to 4) used to control the additional indentation level of an ordered or bulleted list node, beyond its original HTML-defined nesting. When offset is 0, the list node appears at its default nesting level; as the value increases from 1 to 4, the node is indented further, creating the visual impression of deeper nesting without altering the actual HTML structure."
+            "description": "Additional indentation of a list node. When offset is `0`, the list node appears at its default nesting level. Higher values cause increased indentation."
           }
         },
         "start": {
           "type": "int32",
           "metadata": {
-            "description": "An integer to start counting from for the list items, overriding the default start of 1."
+            "description": "Number at the top of the numbered list. <br> Default: `1`"
           }
         }
       }
@@ -72,13 +72,13 @@
     "BulletedListNode": {
       "metadata": {
         "examples": ["bulletedList"],
-        "description": "Presents a group of items in a visually organized manner, where each item is preceded by a bullet point. Bulleted lists are commonly used to present unordered information."
+        "description": "Bulleted list."
       },
       "properties": {
         "type": {
           "enum": ["BULLETED_LIST"],
           "metadata": {
-            "description": "Node type. \n Value: `BULLETED_LIST`"
+            "description": "Node type. \n Must be `BULLETED_LIST`."
           }
         },
         "nodes": {
@@ -125,7 +125,7 @@
         "offset": {
           "type": "int32",
           "metadata": {
-            "description": "An integer (ranging from 0 to 4) used to control the additional indentation level of an ordered or bulleted list node, beyond its original HTML-defined nesting. When `offset` is `0`, the list node appears at its default nesting level; as the value increases from 1 to 4, the node is indented further, creating the visual impression of deeper nesting without altering the actual HTML structure."
+            "description": "Additional indentation of a list node. When offset is `0`, the list node appears at its default nesting level. Higher values cause increased indentation."
           }
         }
       }
@@ -145,7 +145,7 @@
           "metadata": {
             "description": "Child nodes that the list item contains.",
             "pattern": {
-              "description": "A list item must start with a paragraph or heading, followed by any number of paragraphs, bulleted lists, or ordered lists.",
+              "description": "Must start with a paragraph or heading, followed by any number of paragraphs, bulleted lists, or ordered lists.",
               "value": "(PARAGRAPH|HEADING|IMAGE|VIDEO|GIF|GALLERY) (PARAGRAPH|BULLETED_LIST|ORDERED_LIST|HEADING|IMAGE|VIDEO|GIF|GALLERY)*"
             }
           }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/node_paragraph.json

@@ -3,14 +3,14 @@
   "definitions": {
     "ParagraphNode": {
       "metadata": {
-        "description": "Used to structure text content, providing a clear separation between different ideas or sections of text. They are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
+        "description": "Structures text content, providing a clear separation between different ideas or sections of text. Paragraphs are rendered with default styling that typically includes some space above and below the paragraph, making it visually distinct from the surrounding content.",
         "examples": ["paragraph"]
       },
       "properties": {
         "type": {
           "enum": ["PARAGRAPH"],
           "metadata": {
-            "description": "Node type. \n Value: `PARAGRAPH`"
+            "description": "Node type. \n Must be `PARAGRAPH`."
           }
         }
       },
@@ -33,7 +33,7 @@
         "style": {
           "ref": "NodeStyle",
           "metadata": {
-            "description": "Paragraphs vertical padding. \n **Note:** This node requires the [lineSpacing](#plugins) plugin for styling."
+            "description": "Vertical padding. \n **Note:** This node requires the [`lineSpacing`](https://dev.wix.com/docs/ricos/getting-started/introduction#plugins) plugin to be enabled."
           }
         },
         "paragraphData": {
@@ -48,19 +48,19 @@
       "optionalProperties": {
         "textStyle": {
           "ref": "TextStyle",
-          "metadata": { "description": "Styling for the paragraph text." }
+          "metadata": { "description": "Paragraph text styling." }
         },
         "indentation": {
           "type": "int32",
           "metadata": {
-            "description": "Paragraph margin from the left side. Possible values are from `1` to `4`. <br>Actual indentation is equal to **indentation * 40px**."
+            "description": "Paragraph margin from the left side. \n The indentation is measured relative to 40px. For example, if the indentation is `2`, then the margin is equal to **80px**."
           }
         },
         "level": {
           "type": "int32",
           "metadata": {
             "internal": true,
-            "description": "Paragraph level for future different paragraphs"
+            "description": "Paragraph level for future different paragraphs."
           }
         }
       }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/node_text.json

@@ -4,13 +4,13 @@
     "TextNode": {
       "metadata": {
         "examples": ["text"],
-        "description": "Text nodes hold the text itself (think `span` tag in HTML). The difference between `TextNode` and HTML `span` is that text nodes can't be nested and must contain non-empty string. Their appearance and behavior can be modified using [decorations](#decorations)."
+        "description": "Text nodes hold the text itself, similar to how `span` tags hold text in HTML. Text nodes can't be nested and must contain a non-empty string. Their appearance and behavior can be modified using [decorations](#decorations)."
       },
       "properties": {
         "type": {
           "enum": ["TEXT"],
           "metadata": {
-            "description": "Node type. \n Value: `TEXT`"
+            "description": "Node type. \n Must be `TEXT`."
           }
         },
         "textData": {
@@ -39,7 +39,7 @@
         "text": {
           "type": "string",
           "metadata": {
-            "description": "A piece of text, possibly enhanced with additional decorations. Must not be empty.",
+            "description": "Non-empty string to display as text.",
             "validation": {
               "minLength": 1
             }
@@ -52,7 +52,7 @@
             "ref": "Decoration"
           },
           "metadata": {
-            "description": "Text decoration options, such as font and text color. Each type of decoration must appear at most once in this array.",
+            "description": "Array of text [decorations](#decorations). A decoration can't appear twice in the array.",
             "validation": {
               "uniqueTags": true
             }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/plugin_app_embed.json

@@ -5,19 +5,19 @@
       "metadata": {
         "examples": ["app-embed-event", "app-embed-booking"],
         "features": ["APP_EMBED"],
-        "description": "Similar to `LinkPreviewNode`, this node is used to embed external content preview, but from Wix business solutions. You can embed previews from the Wix Bookings, Wix Stores and Wix Events apps."
+        "description": "Embeds an external content preview from Wix business solutions. For example, you can embed previews from the Wix Bookings, Wix Stores and Wix Events apps."
       },
       "properties": {
         "type": {
           "enum": ["APP_EMBED"],
           "metadata": {
-            "description": "Node type. \n Value: `APP_EMBED`"
+            "description": "Node type. \n Must be `APP_EMBED`."
           }
         },
         "appEmbedData": {
           "ref": "AppEmbedData",
           "metadata": {
-            "description": "Embedded Wix app details."
+            "description": "Embedded Wix app."
           }
         }
       },
@@ -44,13 +44,13 @@
     },
     "AppEmbedDataProduct": {
       "metadata": {
-        "description": "Wix Stores app. Embeds a particular product."
+        "description": "Embedded a product from Wix Stores."
       },
       "properties": {
         "type": {
           "enum": ["PRODUCT"],
           "metadata": {
-            "description": "Which Wix App to embed. Possible values: \n - `PRODUCT`: Wix Stores app. Embeds a particular product. \n - `EVENT`: Wix Events app. Embeds a particular event. \n - `BOOKINGS`: Wix Bookings app. Embeds a particular booking."
+            "description": "Must be `PRODUCT`."
           }
         },
         "name": {
@@ -90,11 +90,14 @@
     },
     "AppEmbedDataEvent": {
       "metadata": {
-        "description": "Wix Events app. Embeds a particular event."
+        "description": "Embeds an event from Wix Events."
       },
       "properties": {
         "type": {
-          "enum": ["EVENT"]
+          "enum": ["EVENT"],
+          "metadata": {
+            "description": "Must be `EVENT`."
+          }
         },
         "name": {
           "type": "string",
@@ -113,7 +116,7 @@
         "eventData": {
           "ref": "AppEmbedData_EventData",
           "metadata": {
-            "description": "Embedded Wix Events app content."
+            "description": "Embedded event content."
           }
         },
         "image": {
@@ -139,7 +142,7 @@
     },
     "AppEmbedDataBooking": {
       "metadata": {
-        "description": "Wix Bookings app. Embeds a particular booking."
+        "description": "Embeds a booking from Wix Bookings."
       },
       "properties": {
         "type": {
@@ -174,7 +177,7 @@
         "bookingData": {
           "ref": "AppEmbedData_BookingData",
           "metadata": {
-            "description": "Embedded Wix Bookings app content."
+            "description": "Embedded booking content."
           }
         },
         "imageSrc": {

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/plugin_audio.json

@@ -5,13 +5,13 @@
       "metadata": {
         "examples": ["audio-soundcloud"],
         "features": ["AUDIO"],
-        "description": "A multimedia node used to embed and play audio content directly in a webpage. When rendered, it is displayed as the audio player with the specified audio file (can be a platform such as Spotify or Soundloud, and Wix Media). Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio."
+        "description": "Embeds and plays audio content directly in a webpage. Users can interact with the controls to play, pause, rewind, and adjust the volume of the audio."
       },
       "properties": {
         "type": {
           "enum": ["AUDIO"],
           "metadata": {
-            "description": "Node type. \n Value: `AUDIO`"
+            "description": "Node type. \n Must be `AUDIO`."
           }
         }
       },
@@ -51,7 +51,7 @@
         },
         "disableDownload": {
           "metadata": {
-            "description": "Sets whether the audio download button is disabled. \n Default: `false`"
+            "description": "Whether the audio download button is disabled. \n Default: `false`"
           },
           "type": "boolean"
         },
@@ -75,7 +75,7 @@
         },
         "html": {
           "metadata": {
-            "description": "An HTML version of the audio node."
+            "description": "HTML version of the audio node."
           },
           "type": "string"
         }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/plugin_button.json

@@ -5,13 +5,13 @@
       "metadata": {
         "examples": ["button-link", "button-action", "button-styled"],
         "features": ["BUTTON"],
-        "description": "A node that is used to trigger an action when clicked or activated."
+        "description": "Button to trigger an action."
       },
       "properties": {
         "type": {
           "enum": ["BUTTON"],
           "metadata": {
-            "description": "Node type. \n Value: `BUTTON`"
+            "description": "Node type. \n Must be `BUTTON`"
           }
         },
         "buttonData": {
@@ -41,7 +41,7 @@
           "enum": ["LINK", "ACTION"],
           "metadata": {
             "emitEnum": "ButtonData_Type",
-            "description": "Button type. Possible values: <br> - `LINK`: When clicked, a user is redirected. <br> - `ACTION`: When clicked, performs an action."
+            "description": "Button type. Supported values: <br> - `LINK`: Redirects to a webpage. <br> - `ACTION`: Performs an action."
           }
         },
         "text": {
@@ -55,7 +55,7 @@
         "containerData": {
           "ref": "PluginContainerData",
           "metadata": {
-            "description": " Button container styling."
+            "description": "Button container styling."
           }
         },
         "styles": {
@@ -93,19 +93,19 @@
         "text": {
           "type": "string",
           "metadata": {
-            "description": "The text color in a hexadecimal value."
+            "description": "Text color as a hexadecimal value."
           }
         },
         "border": {
           "type": "string",
           "metadata": {
-            "description": "The border color in a hexadecimal value."
+            "description": "Border color as a hexadecimal value."
           }
         },
         "background": {
           "type": "string",
           "metadata": {
-            "description": "The background color in a hexadecimal value."
+            "description": "Background color as a hexadecimal value."
           }
         }
       }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/plugin_collapsible_list.json

@@ -5,13 +5,13 @@
       "metadata": {
         "examples": ["collapsible-list"],
         "features": ["COLLAPSIBLE_LIST"],
-        "description": "A list of items where each item can be expanded or collapsed to reveal or hide additional content associated with it."
+        "description": "List of items where each item can be expanded or collapsed."
       },
       "properties": {
         "type": {
           "enum": ["COLLAPSIBLE_LIST"],
           "metadata": {
-            "description": "Node type. \n Value: `COLLAPSIBLE_LIST`"
+            "description": "Node type. \n Must be `COLLAPSIBLE_LIST`"
           }
         },
         "nodes": {
@@ -53,27 +53,27 @@
         "expandOnlyOne": {
           "type": "boolean",
           "metadata": {
-            "description": "Whether only one item can be expanded at a time. \n Default: `false` "
+            "description": "Whether only one item can be expanded at a time. \n Default: `false`."
           }
         },
         "initialExpandedItems": {
           "enum": ["FIRST", "ALL", "NONE"],
           "metadata": {
             "metadata": { "emitEnum": "CollapsibleListData_InitialExpandedItems" },
-            "description": "Sets which items are automatically expanded after the page loads. Possible values: \n - `FIRST` \n - `ALL` \n - `NONE`"
+            "description": "Sets which items are automatically expanded after the page loads."
           }
         },
         "direction": {
           "enum": ["LTR", "RTL"],
           "metadata": {
             "emitEnum": "CollapsibleListData_Direction",
-            "description": "Direction of the text in the list. Possible values: \n - `LTR`: Left to right. \n - `RTL`: Right to left."
+            "description": "Direction of the text in the list. Supported values: \n - `LTR`: Left to right. \n - `RTL`: Right to left."
           }
         },
         "isQapageData": {
           "type": "boolean",
           "metadata": {
-            "description": "Whether the collapsible item will appear in search results as a FAQ."
+            "description": "Whether the collapsible item will appear in search results as an FAQ."
           }
         }
       }
@@ -83,7 +83,7 @@
         "type": {
           "enum": ["COLLAPSIBLE_ITEM"],
           "metadata": {
-            "description": "Node type. \n Value: `COLLAPSIBLE_ITEM`"
+            "description": "Node type. \n Must be `COLLAPSIBLE_ITEM`"
           }
         },
         "nodes": {
@@ -116,13 +116,13 @@
     },
     "CollapsibleItemTitleNode": {
       "metadata": {
-        "description": "Collapsible list item title node."
+        "description": "Collapsible list item title."
       },
       "properties": {
         "type": {
           "enum": ["COLLAPSIBLE_ITEM_TITLE"],
           "metadata": {
-            "description": "Node type. \n Value: `COLLAPSIBLE_ITEM_TITLE`"
+            "description": "Node type. \n Must be `COLLAPSIBLE_ITEM_TITLE`."
           }
         },
         "nodes": {
@@ -160,13 +160,13 @@
     },
     "CollapsibleItemBodyNode": {
       "metadata": {
-        "description": "Collapsible list item body node."
+        "description": "Collapsible list item body."
       },
       "properties": {
         "type": {
           "enum": ["COLLAPSIBLE_ITEM_BODY"],
           "metadata": {
-            "description": "Node type. \n Value: `COLLAPSIBLE_ITEM_BODY`"
+            "description": "Node type. \n Must be `COLLAPSIBLE_ITEM_BODY`."
           }
         },
         "nodes": {
@@ -216,7 +216,7 @@
           "PollNode",
           "HtmlNode"
         ],
-        "description": "Collapsible list item body node."
+        "description": "Collapsible list item body."
       }
     }
   }

package/dist/cjs/ricos-schema/next-schema/ricos-jtd/plugin_divider.json

@@ -5,13 +5,13 @@
       "metadata": {
         "examples": ["divider"],
         "features": ["DIVIDER"],
-        "description": "A visual node that is used to separate content sections in a page. When rendered, it is displayed as a horizontal line between the paragraphs, acting as a divider between them."
+        "description": "Horizontal line between different content."
       },
       "properties": {
         "type": {
           "enum": ["DIVIDER"],
           "metadata": {
-            "description": "Node type. \n Value: `DIVIDER`"
+            "description": "Node type. \n Must be `DIVIDER`."
           }
         }
       },
@@ -45,21 +45,21 @@
           "enum": ["SINGLE", "DOUBLE", "DASHED", "DOTTED"],
           "metadata": {
             "emitEnum": "DividerData_LineStyle",
-            "description": "Divider line style. Possible values: <br> - `SINGLE` <br> - `DOUBLE` <br> - `DASHED` <br> - `DOTTED`"
+            "description": "Divider line style."
           }
         },
         "width": {
           "enum": ["LARGE", "MEDIUM", "SMALL"],
           "metadata": {
             "emitEnum": "DividerData_Width",
-            "description": "Divider width. Possible values: <br> - `LARGE` <br> - `MEDIUM` <br> - `SMALL`"
+            "description": "Divider width."
           }
         },
         "alignment": {
           "enum": ["CENTER", "LEFT", "RIGHT"],
           "metadata": {
             "emitEnum": "DividerData_Alignment",
-            "description": "Divider alignment. Possible values: <br> - `CENTER` <br> - `LEFT` <br> - `RIGHT`"
+            "description": "Divider alignment."
           }
         }
       }