@wix/auto_sdk_seo_seo-patterns 1.0.7 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +21 -0
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +17 -0
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.js +31 -29
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +21 -0
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +17 -0
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.mjs +31 -29
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +21 -0
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +17 -0
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.js +31 -29
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +21 -0
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +17 -0
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.mjs +31 -29
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/schemas.mjs
CHANGED
|
@@ -25,7 +25,7 @@ var GetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
25
25
|
tags: z.array(
|
|
26
26
|
z.object({
|
|
27
27
|
type: z.string().describe(
|
|
28
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
28
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
29
29
|
).optional(),
|
|
30
30
|
props: z.record(z.string(), z.any()).describe(
|
|
31
31
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -37,7 +37,7 @@ var GetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
37
37
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
38
38
|
).optional(),
|
|
39
39
|
custom: z.boolean().describe(
|
|
40
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
40
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
41
41
|
).optional(),
|
|
42
42
|
disabled: z.boolean().describe(
|
|
43
43
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -51,7 +51,7 @@ var GetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
51
51
|
tags: z.array(
|
|
52
52
|
z.object({
|
|
53
53
|
type: z.string().describe(
|
|
54
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
54
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
55
55
|
).optional(),
|
|
56
56
|
props: z.record(z.string(), z.any()).describe(
|
|
57
57
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -63,7 +63,7 @@ var GetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
63
63
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
64
64
|
).optional(),
|
|
65
65
|
custom: z.boolean().describe(
|
|
66
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
66
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
67
67
|
).optional(),
|
|
68
68
|
disabled: z.boolean().describe(
|
|
69
69
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -112,7 +112,7 @@ var ListSeoPatternsResponse = /* @__PURE__ */ z.object({
|
|
|
112
112
|
tags: z.array(
|
|
113
113
|
z.object({
|
|
114
114
|
type: z.string().describe(
|
|
115
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
115
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
116
116
|
).optional(),
|
|
117
117
|
props: z.record(z.string(), z.any()).describe(
|
|
118
118
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -124,7 +124,7 @@ var ListSeoPatternsResponse = /* @__PURE__ */ z.object({
|
|
|
124
124
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
125
125
|
).optional(),
|
|
126
126
|
custom: z.boolean().describe(
|
|
127
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
127
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
128
128
|
).optional(),
|
|
129
129
|
disabled: z.boolean().describe(
|
|
130
130
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -138,7 +138,7 @@ var ListSeoPatternsResponse = /* @__PURE__ */ z.object({
|
|
|
138
138
|
tags: z.array(
|
|
139
139
|
z.object({
|
|
140
140
|
type: z.string().describe(
|
|
141
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
141
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
142
142
|
).optional(),
|
|
143
143
|
props: z.record(z.string(), z.any()).describe(
|
|
144
144
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -150,7 +150,7 @@ var ListSeoPatternsResponse = /* @__PURE__ */ z.object({
|
|
|
150
150
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
151
151
|
).optional(),
|
|
152
152
|
custom: z.boolean().describe(
|
|
153
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
153
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
154
154
|
).optional(),
|
|
155
155
|
disabled: z.boolean().describe(
|
|
156
156
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -226,7 +226,7 @@ var CreateSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
226
226
|
tags: z.array(
|
|
227
227
|
z.object({
|
|
228
228
|
type: z.string().describe(
|
|
229
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
229
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
230
230
|
).optional(),
|
|
231
231
|
props: z.record(z.string(), z.any()).describe(
|
|
232
232
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -238,7 +238,7 @@ var CreateSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
238
238
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
239
239
|
).optional(),
|
|
240
240
|
custom: z.boolean().describe(
|
|
241
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
241
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
242
242
|
).optional(),
|
|
243
243
|
disabled: z.boolean().describe(
|
|
244
244
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -252,7 +252,7 @@ var CreateSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
252
252
|
tags: z.array(
|
|
253
253
|
z.object({
|
|
254
254
|
type: z.string().describe(
|
|
255
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
255
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
256
256
|
).optional(),
|
|
257
257
|
props: z.record(z.string(), z.any()).describe(
|
|
258
258
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -264,7 +264,7 @@ var CreateSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
264
264
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
265
265
|
).optional(),
|
|
266
266
|
custom: z.boolean().describe(
|
|
267
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
267
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
268
268
|
).optional(),
|
|
269
269
|
disabled: z.boolean().describe(
|
|
270
270
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -306,7 +306,7 @@ var CreateSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
306
306
|
tags: z.array(
|
|
307
307
|
z.object({
|
|
308
308
|
type: z.string().describe(
|
|
309
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
309
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
310
310
|
).optional(),
|
|
311
311
|
props: z.record(z.string(), z.any()).describe(
|
|
312
312
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -318,7 +318,7 @@ var CreateSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
318
318
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
319
319
|
).optional(),
|
|
320
320
|
custom: z.boolean().describe(
|
|
321
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
321
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
322
322
|
).optional(),
|
|
323
323
|
disabled: z.boolean().describe(
|
|
324
324
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -332,7 +332,7 @@ var CreateSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
332
332
|
tags: z.array(
|
|
333
333
|
z.object({
|
|
334
334
|
type: z.string().describe(
|
|
335
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
335
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
336
336
|
).optional(),
|
|
337
337
|
props: z.record(z.string(), z.any()).describe(
|
|
338
338
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -344,7 +344,7 @@ var CreateSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
344
344
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
345
345
|
).optional(),
|
|
346
346
|
custom: z.boolean().describe(
|
|
347
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
347
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
348
348
|
).optional(),
|
|
349
349
|
disabled: z.boolean().describe(
|
|
350
350
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -391,7 +391,7 @@ var SetSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
391
391
|
tags: z.array(
|
|
392
392
|
z.object({
|
|
393
393
|
type: z.string().describe(
|
|
394
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
394
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
395
395
|
).optional(),
|
|
396
396
|
props: z.record(z.string(), z.any()).describe(
|
|
397
397
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -403,7 +403,7 @@ var SetSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
403
403
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
404
404
|
).optional(),
|
|
405
405
|
custom: z.boolean().describe(
|
|
406
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
406
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
407
407
|
).optional(),
|
|
408
408
|
disabled: z.boolean().describe(
|
|
409
409
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -417,7 +417,7 @@ var SetSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
417
417
|
tags: z.array(
|
|
418
418
|
z.object({
|
|
419
419
|
type: z.string().describe(
|
|
420
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
420
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
421
421
|
).optional(),
|
|
422
422
|
props: z.record(z.string(), z.any()).describe(
|
|
423
423
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -429,7 +429,7 @@ var SetSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
429
429
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
430
430
|
).optional(),
|
|
431
431
|
custom: z.boolean().describe(
|
|
432
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
432
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
433
433
|
).optional(),
|
|
434
434
|
disabled: z.boolean().describe(
|
|
435
435
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -457,7 +457,9 @@ var SetSeoPatternRequest = /* @__PURE__ */ z.object({
|
|
|
457
457
|
"Pattern to set for the page type.\n\n`pattern` is the only writable field, and setting it replaces the page type's tag\ntemplates in full. Sending an empty pattern clears it, which returns the page type to\nits Wix default."
|
|
458
458
|
),
|
|
459
459
|
options: z.object({
|
|
460
|
-
fieldMask: z.object({ paths: z.array(z.string()) }).describe(
|
|
460
|
+
fieldMask: z.object({ paths: z.array(z.string()) }).describe(
|
|
461
|
+
'Fields to update.\n\nSupported properties: `pattern`\n\nOver REST, send the mask as a comma-separated string, for example\n`"fieldMask": "pattern"`. The JavaScript SDK takes an array of strings\ninstead, for example `fieldMask: ["pattern"]`.'
|
|
462
|
+
),
|
|
461
463
|
pageId: z.string().describe(
|
|
462
464
|
"ID of a single page built from a Wix Data collection, to change the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
463
465
|
).max(200).optional().nullable()
|
|
@@ -478,7 +480,7 @@ var SetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
478
480
|
tags: z.array(
|
|
479
481
|
z.object({
|
|
480
482
|
type: z.string().describe(
|
|
481
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
483
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
482
484
|
).optional(),
|
|
483
485
|
props: z.record(z.string(), z.any()).describe(
|
|
484
486
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -490,7 +492,7 @@ var SetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
490
492
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
491
493
|
).optional(),
|
|
492
494
|
custom: z.boolean().describe(
|
|
493
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
495
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
494
496
|
).optional(),
|
|
495
497
|
disabled: z.boolean().describe(
|
|
496
498
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -504,7 +506,7 @@ var SetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
504
506
|
tags: z.array(
|
|
505
507
|
z.object({
|
|
506
508
|
type: z.string().describe(
|
|
507
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
509
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
508
510
|
).optional(),
|
|
509
511
|
props: z.record(z.string(), z.any()).describe(
|
|
510
512
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -516,7 +518,7 @@ var SetSeoPatternResponse = /* @__PURE__ */ z.object({
|
|
|
516
518
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
517
519
|
).optional(),
|
|
518
520
|
custom: z.boolean().describe(
|
|
519
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
521
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
520
522
|
).optional(),
|
|
521
523
|
disabled: z.boolean().describe(
|
|
522
524
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -571,7 +573,7 @@ var ResetSeoPatternToDefaultResponse = /* @__PURE__ */ z.object({
|
|
|
571
573
|
tags: z.array(
|
|
572
574
|
z.object({
|
|
573
575
|
type: z.string().describe(
|
|
574
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
576
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
575
577
|
).optional(),
|
|
576
578
|
props: z.record(z.string(), z.any()).describe(
|
|
577
579
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -583,7 +585,7 @@ var ResetSeoPatternToDefaultResponse = /* @__PURE__ */ z.object({
|
|
|
583
585
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
584
586
|
).optional(),
|
|
585
587
|
custom: z.boolean().describe(
|
|
586
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
588
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
587
589
|
).optional(),
|
|
588
590
|
disabled: z.boolean().describe(
|
|
589
591
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -597,7 +599,7 @@ var ResetSeoPatternToDefaultResponse = /* @__PURE__ */ z.object({
|
|
|
597
599
|
tags: z.array(
|
|
598
600
|
z.object({
|
|
599
601
|
type: z.string().describe(
|
|
600
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns."
|
|
602
|
+
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`.\n\nWhich of these an API actually accepts depends on where the tag is being set: this\nlist is not a blanket guarantee across every API that reuses this message. Site SEO\nTags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects\n`title`/`script`/`link` with a validation error even though they appear here \u2014\ncheck the field description of the specific `tags`-typed field you're writing to\nfor the types it actually supports and the error it returns.\n\nLimitation: `title` and `script` (e.g. a `script` tag with `props.type`\n`\"application/ld+json\"` carrying structured data) are supported only when\n`custom` is unset or `false`. Setting `custom: true` on a `title` or `script`\ntag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the\nwrite through the site's Advanced/Custom Tags list. To write structured data,\nomit `custom` (or set it to `false`)."
|
|
601
603
|
).optional(),
|
|
602
604
|
props: z.record(z.string(), z.any()).describe(
|
|
603
605
|
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
@@ -609,7 +611,7 @@ var ResetSeoPatternToDefaultResponse = /* @__PURE__ */ z.object({
|
|
|
609
611
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
610
612
|
).optional(),
|
|
611
613
|
custom: z.boolean().describe(
|
|
612
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
614
|
+
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) \u2014\ni.e. an entry from the site's Advanced/Custom Tags list.\n\nSetting this to `true` on a write restricts which `type` values are accepted\n\u2014 the same restriction the Advanced/Custom Tags UI enforces. `title` and\n`script` tags (including JSON-LD structured data) must be sent with `custom`\nomitted or `false`; sending them with `custom: true` is rejected with\n`TAG_TYPE_NOT_ALLOWED`.\n\nNote this is a separate restriction from Site SEO Tags' own type restriction on\n`SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.\nfor site-wide structured data) unconditionally. There is currently no way to set\nsite-wide, every-page structured data through any of these APIs \u2014 write a per-page\n`script` tag through the Item SEO Tags API instead.\n\nThis flag is scoped to that feature only. It is NOT an indicator of whether a standard tag\n(`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed\ndefault/pattern \u2014 standard tags always resolve with `custom: false`, even when their content comes\nfrom a page's manually saved SEO title/description override. Don't use this field to verify whether\na live page reflects a manual per-page SEO edit.\n\nLimitation: when `ResolveStaticPageSeoTags` is called without `seoData`, the per-page SEO data is read\nonly from the Vibe/Wix-managed-headless override store. That store holds nothing for classic Wix Editor\nor Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the\nresponse entirely \u2014 there, `false` means this API could not tell, not that no custom tag exists.\nPass `seoData` explicitly to resolve against a known set of tags."
|
|
613
615
|
).optional(),
|
|
614
616
|
disabled: z.boolean().describe(
|
|
615
617
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|