@wix/auto_sdk_events_forms 1.0.124 → 1.0.126

package/build/es/index.typings.d.mts

@@ -1416,73 +1416,117 @@ interface SeoSettings {
     hidden?: boolean | null;
 }
 /**
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ * The SEO data for a single page or dynamic item, in the shape stored today.
+ *
+ * FROZEN. Existing server code maps onto this message field by field, so its
+ * field set must never change (see the file header). New writers use
+ * `SeoSchemaV2`.
+ *
+ * These tags are rendered into the <head> of the HTML document and are not
+ * visible on the page itself. They override every other source of tags
+ * (site defaults, vertical presets, patterns) for this page.
  */
 interface SeoSchema {
-    /** SEO tag information. */
+    /**
+     * The tags rendered into <head>, in no particular order. Render order is
+     * decided by the renderer, not by position in this list.
+     *
+     * No maxSize: this list is already populated by data written years ago, and
+     * a bound added now could reject a page that is already stored.
+     */
     tags?: Tag[];
-    /** SEO general settings. */
+    /** Page-level SEO settings that are not themselves tags. */
     settings?: Settings;
 }
+/** A keyword term the user is targeting. */
 interface Keyword {
-    /** Keyword value. */
+    /**
+     * The term itself, e.g. "trail running shoes".
+     *
+     * No maxLength, for the same reason as the legacy tag fields: keywords are
+     * already stored, and a bound added now could reject a record written
+     * before the bound existed. The flynt `missing-string-validations` warning
+     * on this field is accepted deliberately.
+     */
     term?: string;
-    /** Whether the keyword is the main focus keyword. */
+    /** Whether this is the page's primary focus keyword. At most one per page. */
     isMain?: boolean;
     /**
-     * The source that added the keyword terms to the SEO settings.
+     * Which surface added the term, e.g. a panel or a suggestion flow. Used for
+     * attribution in BI. Opaque to the renderer.
      * @maxLength 1000
      */
     origin?: string | null;
 }
+/**
+ * One tag in the page's <head>.
+ *
+ * Not deprecated, and with no removal date, deliberately: stored data is
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
+ * normalizes both shapes on READ.
+ */
 interface Tag {
     /**
-     * SEO tag type.
-     *
+     * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
+     * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
+     * the invalid combinations unrepresentable rather than merely discouraged.
      *
-     * Supported values: `title`, `meta`, `script`, `link`.
-     *
-     * Which of these an API actually accepts depends on where the tag is being set: this
-     * list is not a blanket guarantee across every API that reuses this message. Site SEO
-     * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
-     * `title`/`script`/`link` with a validation error even though they appear here —
-     * check the field description of the specific `tags`-typed field you're writing to
-     * for the types it actually supports and the error it returns.
+     * Which of these an API actually accepts depends on where the tag is being
+     * set: this list is not a blanket guarantee across every API that reuses
+     * this message. Site SEO Tags in particular accepts only `meta` (see
+     * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
+     * error even though they appear here — check the field description of the
+     * specific `tags`-typed field you are writing to.
      *
      * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
-     * `"application/ld+json"` carrying structured data) are supported only when
-     * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
-     * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
-     * write through the site's Advanced/Custom Tags list. To write structured data,
-     * omit `custom` (or set it to `false`).
+     * "application/ld+json" carrying structured data) are supported only when
+     * `custom` is unset or `false`. Setting `custom: true` on a `title` or
+     * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
+     * `custom: true` routes the write through the site's Advanced/Custom Tags
+     * list. To write structured data, omit `custom` (or set it to `false`).
+     *
+     * No length limit: this field holds data written years ago by writers we
+     * are not migrating. A constraint here could reject a record that is
+     * already stored, which is exactly the promise this design makes.
      */
     type?: string;
     /**
-     * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
-     * For example: `{"name": "description", "content": "the description itself"}`.
+     * Legacy. Was an untyped bag of HTML attributes.
+     * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
      */
     props?: Record<string, any> | null;
-    /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
+    /**
+     * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
+     * its contents are split by purpose: per-page structured-data state moves to
+     * StructuredDataTag, authorship to `written_by`, and render-time preset
+     * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
+     * stored document entirely — it belongs to the preset definition, not to the
+     * page. See the design log for the full key-by-key mapping.
+     */
     meta?: Record<string, any> | null;
-    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    /**
+     * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
+     * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
+     * `StructuredDataTag.json_ld`.
+     * No length limit, for the same reason as `type` above.
+     */
     children?: string;
     /**
      * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
      * i.e. an entry from the site's Advanced/Custom Tags list.
      *
-     * Setting this to `true` on a write restricts which `type` values are accepted
-     * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
-     * `script` tags (including JSON-LD structured data) must be sent with `custom`
-     * omitted or `false`; sending them with `custom: true` is rejected with
-     * `TAG_TYPE_NOT_ALLOWED`.
+     * Setting this to `true` on a write restricts which `type` values are
+     * accepted — the same restriction the Advanced/Custom Tags UI enforces.
+     * `title` and `script` tags (including JSON-LD structured data) must be sent
+     * with `custom` omitted or `false`; sending them with `custom: true` is
+     * rejected with `TAG_TYPE_NOT_ALLOWED`.
      *
-     * Note this is a separate restriction from Site SEO Tags' own type restriction on
-     * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
-     * for site-wide structured data) unconditionally. There is currently no way to set
-     * site-wide, every-page structured data through any of these APIs — write a per-page
-     * `script` tag through the Item SEO Tags API instead.
+     * Note this is a separate restriction from Site SEO Tags' own type
+     * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
+     * rejects `script` (e.g. for site-wide structured data) unconditionally.
+     * There is currently no way to set site-wide, every-page structured data
+     * through any of these APIs — write a per-page `script` tag through the Item
+     * SEO Tags API instead.
      *
      * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
      * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -1495,22 +1539,39 @@ interface Tag {
      * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
      * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
      * Pass `seoData` explicitly to resolve against a known set of tags.
+     *
+     * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
      */
     custom?: boolean;
-    /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
+    /**
+     * Whether the tag is excluded from the rendered <head>.
+     *
+     * A disabled tag is still stored, so the user can re-enable it and so a
+     * pattern-provided tag stays suppressed on this page. Default false.
+     */
     disabled?: boolean;
 }
+/** Page-level SEO settings that are not tags. */
 interface Settings {
     /**
-     * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
-     *
+     * Whether to suppress the automatic redirect from this page's previous URL to
+     * its current one after a slug change.
      *
-     * Default: `false` (automatical redirect is enabled).
+     * Default false, meaning the redirect IS created. The field is named for the
+     * exception rather than the rule, which reads backwards; kept as-is because
+     * renaming a stored boolean is not worth the migration.
      */
     preventAutoRedirect?: boolean;
     /**
-     * User-selected keyword terms for a specific page.
-     * @maxSize 5
+     * Keyword terms the user is targeting for this page. Used by the SEO
+     * assistant and checklist; never rendered into <head>.
+     *
+     * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
+     * the panel happens to allow today — which is exactly the mistake we are
+     * fixing for structured data. A product decision to allow 8 should not need
+     * a proto release, so the panel owns that number and the proto only stops
+     * something absurd.
+     * @maxSize 20
      */
     keywords?: Keyword[];
 }
@@ -2293,6 +2354,8 @@ interface TextStyle {
     textAlignment?: TextAlignmentWithLiterals;
     /** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
     lineHeight?: string | null;
+    /** Font size of an empty block: it sizes the empty line, its list marker and the text typed into it. Ignored on a block with text, which is sized by its text's `FONT_SIZE` decorations. */
+    fontSize?: FontSizeData;
 }
 declare enum TextAlignment {
     /** browser default, eqivalent to `initial` */
@@ -2308,6 +2371,18 @@ declare enum TextAlignment {
 }
 /** @enumType */
 type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
+interface FontSizeData {
+    /** The units used for the font size. */
+    unit?: FontTypeWithLiterals;
+    /** Font size value. */
+    value?: number | null;
+}
+declare enum FontType {
+    PX = "PX",
+    EM = "EM"
+}
+/** @enumType */
+type FontTypeWithLiterals = FontType | 'PX' | 'EM';
 interface DividerData {
     /** Styling for the divider's container. */
     containerData?: PluginContainerData;
@@ -3172,18 +3247,6 @@ interface MentionData {
     /** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
     type?: string | null;
 }
-interface FontSizeData {
-    /** The units used for the font size. */
-    unit?: FontTypeWithLiterals;
-    /** Font size value. */
-    value?: number | null;
-}
-declare enum FontType {
-    PX = "PX",
-    EM = "EM"
-}
-/** @enumType */
-type FontTypeWithLiterals = FontType | 'PX' | 'EM';
 interface SpoilerData {
     /** Spoiler ID. */
     id?: string | null;

package/build/es/index.typings.mjs

@@ -876,6 +876,11 @@ var TextAlignment = /* @__PURE__ */ ((TextAlignment2) => {
   TextAlignment2["JUSTIFY"] = "JUSTIFY";
   return TextAlignment2;
 })(TextAlignment || {});
+var FontType = /* @__PURE__ */ ((FontType2) => {
+  FontType2["PX"] = "PX";
+  FontType2["EM"] = "EM";
+  return FontType2;
+})(FontType || {});
 var LineCap = /* @__PURE__ */ ((LineCap2) => {
   LineCap2["SQUARE"] = "SQUARE";
   LineCap2["ROUND"] = "ROUND";
@@ -1013,11 +1018,6 @@ var ColorDataBackgroundType = /* @__PURE__ */ ((ColorDataBackgroundType2) => {
   ColorDataBackgroundType2["GRADIENT"] = "GRADIENT";
   return ColorDataBackgroundType2;
 })(ColorDataBackgroundType || {});
-var FontType = /* @__PURE__ */ ((FontType2) => {
-  FontType2["PX"] = "PX";
-  FontType2["EM"] = "EM";
-  return FontType2;
-})(FontType || {});
 var Variant = /* @__PURE__ */ ((Variant2) => {
   Variant2["UNDERLINE"] = "UNDERLINE";
   Variant2["BOX"] = "BOX";