@wix/auto_sdk_seo_seo-patterns 1.0.11 → 1.0.13

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

@@ -105,52 +105,75 @@ interface SeoPatternBlob {
      */
     tags?: Tag[];
 }
+/**
+ * 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
@@ -163,9 +186,16 @@ 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;
 }
 /** Which pattern is in effect for a page type. */

package/build/internal/es/meta.d.mts

@@ -106,52 +106,75 @@ interface SeoPatternBlob {
      */
     tags?: Tag[];
 }
+/**
+ * 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
@@ -164,9 +187,16 @@ 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;
 }
 /** Which pattern is in effect for a page type. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_seo_seo-patterns",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -29,7 +29,7 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/sdk-runtime": "^1.0.24",
+    "@wix/sdk-runtime": "^1.0.28",
     "@wix/sdk-types": "^1.17.11"
   },
   "devDependencies": {
@@ -50,5 +50,5 @@
       "fqdn": "wix.promote.seo.v1.seo_pattern"
     }
   },
-  "falconPackageHash": "f2ce1864bad6391e8c0be3e4b50078a04ae3d8408643af266b43eb44"
+  "falconPackageHash": "7bca712697f62897894fb5d008fb0eaa1a70f8f234de7645f2c27136"
 }