@wix/auto_sdk_seo_seo-patterns 1.0.0 → 1.0.2
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.d.ts +18 -36
- package/build/cjs/index.js +3 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +98 -128
- package/build/cjs/index.typings.js +3 -15
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +76 -60
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +0 -3
- package/build/cjs/schemas.js +54 -65
- package/build/cjs/schemas.js.map +1 -1
- package/build/es/index.d.mts +18 -36
- package/build/es/index.mjs +3 -15
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +98 -128
- package/build/es/index.typings.mjs +3 -15
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +76 -60
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +0 -3
- package/build/es/schemas.mjs +54 -65
- package/build/es/schemas.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +18 -36
- package/build/internal/cjs/index.js +3 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +107 -113
- package/build/internal/cjs/index.typings.js +3 -15
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +85 -45
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +0 -3
- package/build/internal/cjs/schemas.js +54 -65
- package/build/internal/cjs/schemas.js.map +1 -1
- package/build/internal/es/index.d.mts +18 -36
- package/build/internal/es/index.mjs +3 -15
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +107 -113
- package/build/internal/es/index.typings.mjs +3 -15
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +85 -45
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +0 -3
- package/build/internal/es/schemas.mjs +54 -65
- package/build/internal/es/schemas.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -6,10 +6,7 @@ var GetSeoPatternRequest = z.object({
|
|
|
6
6
|
).max(100),
|
|
7
7
|
options: z.object({
|
|
8
8
|
pageId: z.string().describe(
|
|
9
|
-
"ID of a single page built from a Wix Data collection, to retrieve the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
10
|
-
).max(200).optional().nullable(),
|
|
11
|
-
collectionName: z.string().describe(
|
|
12
|
-
"Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.\n\nTo address a single page built from a Wix Data collection, pass its `pageId`."
|
|
9
|
+
"ID of a single page built from a Wix Data collection, to retrieve the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
13
10
|
).max(200).optional().nullable()
|
|
14
11
|
}).optional()
|
|
15
12
|
});
|
|
@@ -19,10 +16,10 @@ var GetSeoPatternResponse = z.object({
|
|
|
19
16
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
20
17
|
).max(400).optional().nullable(),
|
|
21
18
|
pageType: z.string().describe(
|
|
22
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
19
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
23
20
|
).max(100).optional(),
|
|
24
21
|
pageId: z.string().describe(
|
|
25
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
22
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
26
23
|
).max(200).optional().nullable(),
|
|
27
24
|
pattern: z.object({
|
|
28
25
|
tags: z.array(
|
|
@@ -40,7 +37,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
40
37
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
41
38
|
).optional(),
|
|
42
39
|
custom: z.boolean().describe(
|
|
43
|
-
|
|
40
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
44
41
|
).optional(),
|
|
45
42
|
disabled: z.boolean().describe(
|
|
46
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."
|
|
@@ -48,7 +45,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
48
45
|
})
|
|
49
46
|
).max(100).optional()
|
|
50
47
|
}).describe(
|
|
51
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
48
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
52
49
|
).optional(),
|
|
53
50
|
defaultPattern: z.object({
|
|
54
51
|
tags: z.array(
|
|
@@ -66,7 +63,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
66
63
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
67
64
|
).optional(),
|
|
68
65
|
custom: z.boolean().describe(
|
|
69
|
-
|
|
66
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
70
67
|
).optional(),
|
|
71
68
|
disabled: z.boolean().describe(
|
|
72
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."
|
|
@@ -74,7 +71,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
74
71
|
})
|
|
75
72
|
).max(100).optional()
|
|
76
73
|
}).describe(
|
|
77
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
74
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
78
75
|
).optional(),
|
|
79
76
|
source: z.enum([
|
|
80
77
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -92,7 +89,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
92
89
|
"ORIGIN_MIGRATION",
|
|
93
90
|
"ORIGIN_AI"
|
|
94
91
|
]).describe(
|
|
95
|
-
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\
|
|
92
|
+
"What made the most recent change to the pattern, for example a Wix user or the site\nmigration flow. Derived from the caller, not from the request.\n\nReported only on the response to a write, and on the event the write emits. It isn't\nstored with the pattern, so Get SEO Pattern and List SEO Patterns always report\n`ORIGIN_UNSPECIFIED`, as does a write by a caller Wix doesn't identify as a specific\norigin."
|
|
96
93
|
).optional()
|
|
97
94
|
}).describe(
|
|
98
95
|
"The page type's pattern: the site's own pattern, the Wix default, and which of the\ntwo is in effect."
|
|
@@ -106,10 +103,10 @@ var ListSeoPatternsResponse = z.object({
|
|
|
106
103
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
107
104
|
).max(400).optional().nullable(),
|
|
108
105
|
pageType: z.string().describe(
|
|
109
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
106
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
110
107
|
).max(100).optional(),
|
|
111
108
|
pageId: z.string().describe(
|
|
112
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
109
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
113
110
|
).max(200).optional().nullable(),
|
|
114
111
|
pattern: z.object({
|
|
115
112
|
tags: z.array(
|
|
@@ -127,7 +124,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
127
124
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
128
125
|
).optional(),
|
|
129
126
|
custom: z.boolean().describe(
|
|
130
|
-
|
|
127
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
131
128
|
).optional(),
|
|
132
129
|
disabled: z.boolean().describe(
|
|
133
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."
|
|
@@ -135,7 +132,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
135
132
|
})
|
|
136
133
|
).max(100).optional()
|
|
137
134
|
}).describe(
|
|
138
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
135
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
139
136
|
).optional(),
|
|
140
137
|
defaultPattern: z.object({
|
|
141
138
|
tags: z.array(
|
|
@@ -153,7 +150,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
153
150
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
154
151
|
).optional(),
|
|
155
152
|
custom: z.boolean().describe(
|
|
156
|
-
|
|
153
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
157
154
|
).optional(),
|
|
158
155
|
disabled: z.boolean().describe(
|
|
159
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."
|
|
@@ -161,7 +158,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
161
158
|
})
|
|
162
159
|
).max(100).optional()
|
|
163
160
|
}).describe(
|
|
164
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
161
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
165
162
|
).optional(),
|
|
166
163
|
source: z.enum([
|
|
167
164
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -179,7 +176,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
179
176
|
"ORIGIN_MIGRATION",
|
|
180
177
|
"ORIGIN_AI"
|
|
181
178
|
]).describe(
|
|
182
|
-
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\
|
|
179
|
+
"What made the most recent change to the pattern, for example a Wix user or the site\nmigration flow. Derived from the caller, not from the request.\n\nReported only on the response to a write, and on the event the write emits. It isn't\nstored with the pattern, so Get SEO Pattern and List SEO Patterns always report\n`ORIGIN_UNSPECIFIED`, as does a write by a caller Wix doesn't identify as a specific\norigin."
|
|
183
180
|
).optional()
|
|
184
181
|
})
|
|
185
182
|
).max(200).optional()
|
|
@@ -196,7 +193,7 @@ var ListSeoPatternVariablesResponse = z.object({
|
|
|
196
193
|
"Name of the variable, without the surrounding braces. For example, `product.name`,\nwhich a pattern references as `{{product.name}}`."
|
|
197
194
|
).max(200).optional(),
|
|
198
195
|
userVisible: z.boolean().describe(
|
|
199
|
-
"Whether
|
|
196
|
+
"Whether the variable appears in the list shown to Wix users editing the pattern in the\ndashboard.\n\n`false` doesn't prevent a pattern from using the variable. It marks a variable that's\nkept out of the dashboard's list, typically because it's only meaningful in certain\ncases."
|
|
200
197
|
).optional()
|
|
201
198
|
})
|
|
202
199
|
).max(500).optional(),
|
|
@@ -206,24 +203,24 @@ var ListSeoPatternVariablesResponse = z.object({
|
|
|
206
203
|
"Name of the variable, without the surrounding braces. For example, `product.name`,\nwhich a pattern references as `{{product.name}}`."
|
|
207
204
|
).max(200).optional(),
|
|
208
205
|
userVisible: z.boolean().describe(
|
|
209
|
-
"Whether
|
|
206
|
+
"Whether the variable appears in the list shown to Wix users editing the pattern in the\ndashboard.\n\n`false` doesn't prevent a pattern from using the variable. It marks a variable that's\nkept out of the dashboard's list, typically because it's only meaningful in certain\ncases."
|
|
210
207
|
).optional()
|
|
211
208
|
})
|
|
212
209
|
).max(500).optional()
|
|
213
210
|
});
|
|
214
211
|
var CreateSeoPatternRequest = z.object({
|
|
215
212
|
pageType: z.string().describe(
|
|
216
|
-
"Page type
|
|
213
|
+
"Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
217
214
|
).max(100),
|
|
218
215
|
seoPattern: z.object({
|
|
219
216
|
_id: z.string().describe(
|
|
220
217
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
221
218
|
).max(400).optional().nullable(),
|
|
222
219
|
pageType: z.string().describe(
|
|
223
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
220
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
224
221
|
).max(100).optional(),
|
|
225
222
|
pageId: z.string().describe(
|
|
226
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
223
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
227
224
|
).max(200).optional().nullable(),
|
|
228
225
|
pattern: z.object({
|
|
229
226
|
tags: z.array(
|
|
@@ -241,7 +238,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
241
238
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
242
239
|
).optional(),
|
|
243
240
|
custom: z.boolean().describe(
|
|
244
|
-
|
|
241
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
245
242
|
).optional(),
|
|
246
243
|
disabled: z.boolean().describe(
|
|
247
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."
|
|
@@ -249,7 +246,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
249
246
|
})
|
|
250
247
|
).max(100).optional()
|
|
251
248
|
}).describe(
|
|
252
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
249
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
253
250
|
).optional(),
|
|
254
251
|
defaultPattern: z.object({
|
|
255
252
|
tags: z.array(
|
|
@@ -267,7 +264,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
267
264
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
268
265
|
).optional(),
|
|
269
266
|
custom: z.boolean().describe(
|
|
270
|
-
|
|
267
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
271
268
|
).optional(),
|
|
272
269
|
disabled: z.boolean().describe(
|
|
273
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."
|
|
@@ -275,7 +272,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
275
272
|
})
|
|
276
273
|
).max(100).optional()
|
|
277
274
|
}).describe(
|
|
278
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
275
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
279
276
|
).optional(),
|
|
280
277
|
source: z.enum([
|
|
281
278
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -300,10 +297,10 @@ var CreateSeoPatternResponse = z.object({
|
|
|
300
297
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
301
298
|
).max(400).optional().nullable(),
|
|
302
299
|
pageType: z.string().describe(
|
|
303
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
300
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
304
301
|
).max(100).optional(),
|
|
305
302
|
pageId: z.string().describe(
|
|
306
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
303
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
307
304
|
).max(200).optional().nullable(),
|
|
308
305
|
pattern: z.object({
|
|
309
306
|
tags: z.array(
|
|
@@ -321,7 +318,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
321
318
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
322
319
|
).optional(),
|
|
323
320
|
custom: z.boolean().describe(
|
|
324
|
-
|
|
321
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
325
322
|
).optional(),
|
|
326
323
|
disabled: z.boolean().describe(
|
|
327
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."
|
|
@@ -329,7 +326,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
329
326
|
})
|
|
330
327
|
).max(100).optional()
|
|
331
328
|
}).describe(
|
|
332
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
329
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
333
330
|
).optional(),
|
|
334
331
|
defaultPattern: z.object({
|
|
335
332
|
tags: z.array(
|
|
@@ -347,7 +344,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
347
344
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
348
345
|
).optional(),
|
|
349
346
|
custom: z.boolean().describe(
|
|
350
|
-
|
|
347
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
351
348
|
).optional(),
|
|
352
349
|
disabled: z.boolean().describe(
|
|
353
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."
|
|
@@ -355,7 +352,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
355
352
|
})
|
|
356
353
|
).max(100).optional()
|
|
357
354
|
}).describe(
|
|
358
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
355
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
359
356
|
).optional(),
|
|
360
357
|
source: z.enum([
|
|
361
358
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -373,7 +370,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
373
370
|
"ORIGIN_MIGRATION",
|
|
374
371
|
"ORIGIN_AI"
|
|
375
372
|
]).describe(
|
|
376
|
-
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\
|
|
373
|
+
"What made the most recent change to the pattern, for example a Wix user or the site\nmigration flow. Derived from the caller, not from the request.\n\nReported only on the response to a write, and on the event the write emits. It isn't\nstored with the pattern, so Get SEO Pattern and List SEO Patterns always report\n`ORIGIN_UNSPECIFIED`, as does a write by a caller Wix doesn't identify as a specific\norigin."
|
|
377
374
|
).optional()
|
|
378
375
|
});
|
|
379
376
|
var SetSeoPatternRequest = z.object({
|
|
@@ -385,10 +382,10 @@ var SetSeoPatternRequest = z.object({
|
|
|
385
382
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
386
383
|
).max(400).optional().nullable(),
|
|
387
384
|
pageType: z.string().describe(
|
|
388
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
385
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
389
386
|
).max(100).optional(),
|
|
390
387
|
pageId: z.string().describe(
|
|
391
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
388
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
392
389
|
).max(200).optional().nullable(),
|
|
393
390
|
pattern: z.object({
|
|
394
391
|
tags: z.array(
|
|
@@ -406,7 +403,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
406
403
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
407
404
|
).optional(),
|
|
408
405
|
custom: z.boolean().describe(
|
|
409
|
-
|
|
406
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
410
407
|
).optional(),
|
|
411
408
|
disabled: z.boolean().describe(
|
|
412
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."
|
|
@@ -414,7 +411,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
414
411
|
})
|
|
415
412
|
).max(100).optional()
|
|
416
413
|
}).describe(
|
|
417
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
414
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
418
415
|
).optional(),
|
|
419
416
|
defaultPattern: z.object({
|
|
420
417
|
tags: z.array(
|
|
@@ -432,7 +429,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
432
429
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
433
430
|
).optional(),
|
|
434
431
|
custom: z.boolean().describe(
|
|
435
|
-
|
|
432
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
436
433
|
).optional(),
|
|
437
434
|
disabled: z.boolean().describe(
|
|
438
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."
|
|
@@ -440,7 +437,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
440
437
|
})
|
|
441
438
|
).max(100).optional()
|
|
442
439
|
}).describe(
|
|
443
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
440
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
444
441
|
).optional(),
|
|
445
442
|
source: z.enum([
|
|
446
443
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -460,14 +457,9 @@ var SetSeoPatternRequest = z.object({
|
|
|
460
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."
|
|
461
458
|
),
|
|
462
459
|
options: z.object({
|
|
463
|
-
fieldMask: z.object({ paths: z.array(z.string()) }).describe(
|
|
464
|
-
"Fields to update.\n\nRequired, and must name only writable fields. An empty field mask, an unknown field,\nor a read-only field fails with `INVALID_FIELD_MASK`."
|
|
465
|
-
),
|
|
466
|
-
collectionName: z.string().describe(
|
|
467
|
-
"Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.\n\nTo address a single page built from a Wix Data collection, pass its `pageId`."
|
|
468
|
-
).max(200).optional().nullable(),
|
|
460
|
+
fieldMask: z.object({ paths: z.array(z.string()) }).describe("Fields to update.\n\nSupported properties: `pattern`"),
|
|
469
461
|
pageId: z.string().describe(
|
|
470
|
-
"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.
|
|
462
|
+
"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."
|
|
471
463
|
).max(200).optional().nullable()
|
|
472
464
|
})
|
|
473
465
|
});
|
|
@@ -477,10 +469,10 @@ var SetSeoPatternResponse = z.object({
|
|
|
477
469
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
478
470
|
).max(400).optional().nullable(),
|
|
479
471
|
pageType: z.string().describe(
|
|
480
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
472
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
481
473
|
).max(100).optional(),
|
|
482
474
|
pageId: z.string().describe(
|
|
483
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
475
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
484
476
|
).max(200).optional().nullable(),
|
|
485
477
|
pattern: z.object({
|
|
486
478
|
tags: z.array(
|
|
@@ -498,7 +490,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
498
490
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
499
491
|
).optional(),
|
|
500
492
|
custom: z.boolean().describe(
|
|
501
|
-
|
|
493
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
502
494
|
).optional(),
|
|
503
495
|
disabled: z.boolean().describe(
|
|
504
496
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -506,7 +498,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
506
498
|
})
|
|
507
499
|
).max(100).optional()
|
|
508
500
|
}).describe(
|
|
509
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
501
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
510
502
|
).optional(),
|
|
511
503
|
defaultPattern: z.object({
|
|
512
504
|
tags: z.array(
|
|
@@ -524,7 +516,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
524
516
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
525
517
|
).optional(),
|
|
526
518
|
custom: z.boolean().describe(
|
|
527
|
-
|
|
519
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
528
520
|
).optional(),
|
|
529
521
|
disabled: z.boolean().describe(
|
|
530
522
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -532,7 +524,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
532
524
|
})
|
|
533
525
|
).max(100).optional()
|
|
534
526
|
}).describe(
|
|
535
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
527
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
536
528
|
).optional(),
|
|
537
529
|
source: z.enum([
|
|
538
530
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -550,7 +542,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
550
542
|
"ORIGIN_MIGRATION",
|
|
551
543
|
"ORIGIN_AI"
|
|
552
544
|
]).describe(
|
|
553
|
-
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\
|
|
545
|
+
"What made the most recent change to the pattern, for example a Wix user or the site\nmigration flow. Derived from the caller, not from the request.\n\nReported only on the response to a write, and on the event the write emits. It isn't\nstored with the pattern, so Get SEO Pattern and List SEO Patterns always report\n`ORIGIN_UNSPECIFIED`, as does a write by a caller Wix doesn't identify as a specific\norigin."
|
|
554
546
|
).optional()
|
|
555
547
|
}).describe("The updated pattern.").optional()
|
|
556
548
|
});
|
|
@@ -559,11 +551,8 @@ var ResetSeoPatternToDefaultRequest = z.object({
|
|
|
559
551
|
"Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
560
552
|
).max(100),
|
|
561
553
|
options: z.object({
|
|
562
|
-
collectionName: z.string().describe(
|
|
563
|
-
"Not supported yet. Passing a value fails with `COLLECTION_NAME_NOT_SUPPORTED`.\n\nTo address a single page built from a Wix Data collection, pass its `pageId`."
|
|
564
|
-
).max(200).optional().nullable(),
|
|
565
554
|
pageId: z.string().describe(
|
|
566
|
-
"ID of a single page built from a Wix Data collection, to reset the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
555
|
+
"ID of a single page built from a Wix Data collection, to reset the pattern of that\npage alone.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
567
556
|
).max(200).optional().nullable()
|
|
568
557
|
}).optional()
|
|
569
558
|
});
|
|
@@ -573,10 +562,10 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
573
562
|
"SEO pattern ID, in the format `{pageType}`.\n\nFor a pattern that applies to a single page built from a Wix Data collection, the\nformat is `{pageType}:{pageId}`."
|
|
574
563
|
).max(400).optional().nullable(),
|
|
575
564
|
pageType: z.string().describe(
|
|
576
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
565
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
577
566
|
).max(100).optional(),
|
|
578
567
|
pageId: z.string().describe(
|
|
579
|
-
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type.
|
|
568
|
+
"ID of a single page built from a Wix Data collection, when the pattern applies to\nthat page alone rather than to the whole page type.\n\nSupported only for the `WIX_DATA_PAGE_ITEM` page type."
|
|
580
569
|
).max(200).optional().nullable(),
|
|
581
570
|
pattern: z.object({
|
|
582
571
|
tags: z.array(
|
|
@@ -594,7 +583,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
594
583
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
595
584
|
).optional(),
|
|
596
585
|
custom: z.boolean().describe(
|
|
597
|
-
|
|
586
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
598
587
|
).optional(),
|
|
599
588
|
disabled: z.boolean().describe(
|
|
600
589
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -602,7 +591,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
602
591
|
})
|
|
603
592
|
).max(100).optional()
|
|
604
593
|
}).describe(
|
|
605
|
-
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies.
|
|
594
|
+
"The site's own pattern for the page type, which takes precedence over the Wix\ndefault.\n\nEmpty when the site has no pattern of its own, in which case `defaultPattern`\napplies."
|
|
606
595
|
).optional(),
|
|
607
596
|
defaultPattern: z.object({
|
|
608
597
|
tags: z.array(
|
|
@@ -620,7 +609,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
620
609
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
621
610
|
).optional(),
|
|
622
611
|
custom: z.boolean().describe(
|
|
623
|
-
|
|
612
|
+
'Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).\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 custom tags saved on those pages are missing from the response entirely. For\nthose pages `false` therefore does not mean "not a custom tag" \u2014 it means this API could not tell.\nPass `seoData` explicitly to resolve against a known set of tags.'
|
|
624
613
|
).optional(),
|
|
625
614
|
disabled: z.boolean().describe(
|
|
626
615
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -628,7 +617,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
628
617
|
})
|
|
629
618
|
).max(100).optional()
|
|
630
619
|
}).describe(
|
|
631
|
-
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can
|
|
620
|
+
"The pattern Wix provides for the page type, which applies whenever the site has no\npattern of its own.\n\nAlways returned, so you can see what a reset would restore."
|
|
632
621
|
).optional(),
|
|
633
622
|
source: z.enum([
|
|
634
623
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -646,7 +635,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
646
635
|
"ORIGIN_MIGRATION",
|
|
647
636
|
"ORIGIN_AI"
|
|
648
637
|
]).describe(
|
|
649
|
-
"What made the most recent change to the pattern, for example a user or the site\nmigration flow. Derived from the caller, not from the request.\n\
|
|
638
|
+
"What made the most recent change to the pattern, for example a Wix user or the site\nmigration flow. Derived from the caller, not from the request.\n\nReported only on the response to a write, and on the event the write emits. It isn't\nstored with the pattern, so Get SEO Pattern and List SEO Patterns always report\n`ORIGIN_UNSPECIFIED`, as does a write by a caller Wix doesn't identify as a specific\norigin."
|
|
650
639
|
).optional()
|
|
651
640
|
}).describe(
|
|
652
641
|
"The page type after the reset: an empty `pattern`, and `source` of\n`PATTERN_SOURCE_DEFAULT`."
|