@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
package/build/cjs/schemas.js
CHANGED
|
@@ -53,10 +53,7 @@ var GetSeoPatternRequest = z.object({
|
|
|
53
53
|
).max(100),
|
|
54
54
|
options: z.object({
|
|
55
55
|
pageId: z.string().describe(
|
|
56
|
-
"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.
|
|
57
|
-
).max(200).optional().nullable(),
|
|
58
|
-
collectionName: z.string().describe(
|
|
59
|
-
"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`."
|
|
56
|
+
"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."
|
|
60
57
|
).max(200).optional().nullable()
|
|
61
58
|
}).optional()
|
|
62
59
|
});
|
|
@@ -66,10 +63,10 @@ var GetSeoPatternResponse = z.object({
|
|
|
66
63
|
"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}`."
|
|
67
64
|
).max(400).optional().nullable(),
|
|
68
65
|
pageType: z.string().describe(
|
|
69
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
66
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
70
67
|
).max(100).optional(),
|
|
71
68
|
pageId: z.string().describe(
|
|
72
|
-
"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.
|
|
69
|
+
"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."
|
|
73
70
|
).max(200).optional().nullable(),
|
|
74
71
|
pattern: z.object({
|
|
75
72
|
tags: z.array(
|
|
@@ -87,7 +84,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
87
84
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
88
85
|
).optional(),
|
|
89
86
|
custom: z.boolean().describe(
|
|
90
|
-
|
|
87
|
+
'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.'
|
|
91
88
|
).optional(),
|
|
92
89
|
disabled: z.boolean().describe(
|
|
93
90
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -95,7 +92,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
95
92
|
})
|
|
96
93
|
).max(100).optional()
|
|
97
94
|
}).describe(
|
|
98
|
-
"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.
|
|
95
|
+
"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."
|
|
99
96
|
).optional(),
|
|
100
97
|
defaultPattern: z.object({
|
|
101
98
|
tags: z.array(
|
|
@@ -113,7 +110,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
113
110
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
114
111
|
).optional(),
|
|
115
112
|
custom: z.boolean().describe(
|
|
116
|
-
|
|
113
|
+
'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.'
|
|
117
114
|
).optional(),
|
|
118
115
|
disabled: z.boolean().describe(
|
|
119
116
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -121,7 +118,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
121
118
|
})
|
|
122
119
|
).max(100).optional()
|
|
123
120
|
}).describe(
|
|
124
|
-
"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
|
|
121
|
+
"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."
|
|
125
122
|
).optional(),
|
|
126
123
|
source: z.enum([
|
|
127
124
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -139,7 +136,7 @@ var GetSeoPatternResponse = z.object({
|
|
|
139
136
|
"ORIGIN_MIGRATION",
|
|
140
137
|
"ORIGIN_AI"
|
|
141
138
|
]).describe(
|
|
142
|
-
"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\
|
|
139
|
+
"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."
|
|
143
140
|
).optional()
|
|
144
141
|
}).describe(
|
|
145
142
|
"The page type's pattern: the site's own pattern, the Wix default, and which of the\ntwo is in effect."
|
|
@@ -153,10 +150,10 @@ var ListSeoPatternsResponse = z.object({
|
|
|
153
150
|
"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}`."
|
|
154
151
|
).max(400).optional().nullable(),
|
|
155
152
|
pageType: z.string().describe(
|
|
156
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
153
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
157
154
|
).max(100).optional(),
|
|
158
155
|
pageId: z.string().describe(
|
|
159
|
-
"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.
|
|
156
|
+
"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."
|
|
160
157
|
).max(200).optional().nullable(),
|
|
161
158
|
pattern: z.object({
|
|
162
159
|
tags: z.array(
|
|
@@ -174,7 +171,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
174
171
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
175
172
|
).optional(),
|
|
176
173
|
custom: z.boolean().describe(
|
|
177
|
-
|
|
174
|
+
'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.'
|
|
178
175
|
).optional(),
|
|
179
176
|
disabled: z.boolean().describe(
|
|
180
177
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -182,7 +179,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
182
179
|
})
|
|
183
180
|
).max(100).optional()
|
|
184
181
|
}).describe(
|
|
185
|
-
"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.
|
|
182
|
+
"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."
|
|
186
183
|
).optional(),
|
|
187
184
|
defaultPattern: z.object({
|
|
188
185
|
tags: z.array(
|
|
@@ -200,7 +197,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
200
197
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
201
198
|
).optional(),
|
|
202
199
|
custom: z.boolean().describe(
|
|
203
|
-
|
|
200
|
+
'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.'
|
|
204
201
|
).optional(),
|
|
205
202
|
disabled: z.boolean().describe(
|
|
206
203
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -208,7 +205,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
208
205
|
})
|
|
209
206
|
).max(100).optional()
|
|
210
207
|
}).describe(
|
|
211
|
-
"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
|
|
208
|
+
"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."
|
|
212
209
|
).optional(),
|
|
213
210
|
source: z.enum([
|
|
214
211
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -226,7 +223,7 @@ var ListSeoPatternsResponse = z.object({
|
|
|
226
223
|
"ORIGIN_MIGRATION",
|
|
227
224
|
"ORIGIN_AI"
|
|
228
225
|
]).describe(
|
|
229
|
-
"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\
|
|
226
|
+
"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."
|
|
230
227
|
).optional()
|
|
231
228
|
})
|
|
232
229
|
).max(200).optional()
|
|
@@ -243,7 +240,7 @@ var ListSeoPatternVariablesResponse = z.object({
|
|
|
243
240
|
"Name of the variable, without the surrounding braces. For example, `product.name`,\nwhich a pattern references as `{{product.name}}`."
|
|
244
241
|
).max(200).optional(),
|
|
245
242
|
userVisible: z.boolean().describe(
|
|
246
|
-
"Whether
|
|
243
|
+
"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."
|
|
247
244
|
).optional()
|
|
248
245
|
})
|
|
249
246
|
).max(500).optional(),
|
|
@@ -253,24 +250,24 @@ var ListSeoPatternVariablesResponse = z.object({
|
|
|
253
250
|
"Name of the variable, without the surrounding braces. For example, `product.name`,\nwhich a pattern references as `{{product.name}}`."
|
|
254
251
|
).max(200).optional(),
|
|
255
252
|
userVisible: z.boolean().describe(
|
|
256
|
-
"Whether
|
|
253
|
+
"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."
|
|
257
254
|
).optional()
|
|
258
255
|
})
|
|
259
256
|
).max(500).optional()
|
|
260
257
|
});
|
|
261
258
|
var CreateSeoPatternRequest = z.object({
|
|
262
259
|
pageType: z.string().describe(
|
|
263
|
-
"Page type
|
|
260
|
+
"Page type to create a pattern for. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
264
261
|
).max(100),
|
|
265
262
|
seoPattern: z.object({
|
|
266
263
|
_id: z.string().describe(
|
|
267
264
|
"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}`."
|
|
268
265
|
).max(400).optional().nullable(),
|
|
269
266
|
pageType: z.string().describe(
|
|
270
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
267
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
271
268
|
).max(100).optional(),
|
|
272
269
|
pageId: z.string().describe(
|
|
273
|
-
"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.
|
|
270
|
+
"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."
|
|
274
271
|
).max(200).optional().nullable(),
|
|
275
272
|
pattern: z.object({
|
|
276
273
|
tags: z.array(
|
|
@@ -288,7 +285,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
288
285
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
289
286
|
).optional(),
|
|
290
287
|
custom: z.boolean().describe(
|
|
291
|
-
|
|
288
|
+
'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.'
|
|
292
289
|
).optional(),
|
|
293
290
|
disabled: z.boolean().describe(
|
|
294
291
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -296,7 +293,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
296
293
|
})
|
|
297
294
|
).max(100).optional()
|
|
298
295
|
}).describe(
|
|
299
|
-
"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.
|
|
296
|
+
"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."
|
|
300
297
|
).optional(),
|
|
301
298
|
defaultPattern: z.object({
|
|
302
299
|
tags: z.array(
|
|
@@ -314,7 +311,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
314
311
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
315
312
|
).optional(),
|
|
316
313
|
custom: z.boolean().describe(
|
|
317
|
-
|
|
314
|
+
'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.'
|
|
318
315
|
).optional(),
|
|
319
316
|
disabled: z.boolean().describe(
|
|
320
317
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -322,7 +319,7 @@ var CreateSeoPatternRequest = z.object({
|
|
|
322
319
|
})
|
|
323
320
|
).max(100).optional()
|
|
324
321
|
}).describe(
|
|
325
|
-
"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
|
|
322
|
+
"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."
|
|
326
323
|
).optional(),
|
|
327
324
|
source: z.enum([
|
|
328
325
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -347,10 +344,10 @@ var CreateSeoPatternResponse = z.object({
|
|
|
347
344
|
"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}`."
|
|
348
345
|
).max(400).optional().nullable(),
|
|
349
346
|
pageType: z.string().describe(
|
|
350
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
347
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
351
348
|
).max(100).optional(),
|
|
352
349
|
pageId: z.string().describe(
|
|
353
|
-
"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.
|
|
350
|
+
"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."
|
|
354
351
|
).max(200).optional().nullable(),
|
|
355
352
|
pattern: z.object({
|
|
356
353
|
tags: z.array(
|
|
@@ -368,7 +365,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
368
365
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
369
366
|
).optional(),
|
|
370
367
|
custom: z.boolean().describe(
|
|
371
|
-
|
|
368
|
+
'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.'
|
|
372
369
|
).optional(),
|
|
373
370
|
disabled: z.boolean().describe(
|
|
374
371
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -376,7 +373,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
376
373
|
})
|
|
377
374
|
).max(100).optional()
|
|
378
375
|
}).describe(
|
|
379
|
-
"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.
|
|
376
|
+
"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."
|
|
380
377
|
).optional(),
|
|
381
378
|
defaultPattern: z.object({
|
|
382
379
|
tags: z.array(
|
|
@@ -394,7 +391,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
394
391
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
395
392
|
).optional(),
|
|
396
393
|
custom: z.boolean().describe(
|
|
397
|
-
|
|
394
|
+
'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.'
|
|
398
395
|
).optional(),
|
|
399
396
|
disabled: z.boolean().describe(
|
|
400
397
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -402,7 +399,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
402
399
|
})
|
|
403
400
|
).max(100).optional()
|
|
404
401
|
}).describe(
|
|
405
|
-
"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
|
|
402
|
+
"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."
|
|
406
403
|
).optional(),
|
|
407
404
|
source: z.enum([
|
|
408
405
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -420,7 +417,7 @@ var CreateSeoPatternResponse = z.object({
|
|
|
420
417
|
"ORIGIN_MIGRATION",
|
|
421
418
|
"ORIGIN_AI"
|
|
422
419
|
]).describe(
|
|
423
|
-
"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\
|
|
420
|
+
"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."
|
|
424
421
|
).optional()
|
|
425
422
|
});
|
|
426
423
|
var SetSeoPatternRequest = z.object({
|
|
@@ -432,10 +429,10 @@ var SetSeoPatternRequest = z.object({
|
|
|
432
429
|
"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}`."
|
|
433
430
|
).max(400).optional().nullable(),
|
|
434
431
|
pageType: z.string().describe(
|
|
435
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
432
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
436
433
|
).max(100).optional(),
|
|
437
434
|
pageId: z.string().describe(
|
|
438
|
-
"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.
|
|
435
|
+
"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."
|
|
439
436
|
).max(200).optional().nullable(),
|
|
440
437
|
pattern: z.object({
|
|
441
438
|
tags: z.array(
|
|
@@ -453,7 +450,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
453
450
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
454
451
|
).optional(),
|
|
455
452
|
custom: z.boolean().describe(
|
|
456
|
-
|
|
453
|
+
'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.'
|
|
457
454
|
).optional(),
|
|
458
455
|
disabled: z.boolean().describe(
|
|
459
456
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -461,7 +458,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
461
458
|
})
|
|
462
459
|
).max(100).optional()
|
|
463
460
|
}).describe(
|
|
464
|
-
"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.
|
|
461
|
+
"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."
|
|
465
462
|
).optional(),
|
|
466
463
|
defaultPattern: z.object({
|
|
467
464
|
tags: z.array(
|
|
@@ -479,7 +476,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
479
476
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
480
477
|
).optional(),
|
|
481
478
|
custom: z.boolean().describe(
|
|
482
|
-
|
|
479
|
+
'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.'
|
|
483
480
|
).optional(),
|
|
484
481
|
disabled: z.boolean().describe(
|
|
485
482
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -487,7 +484,7 @@ var SetSeoPatternRequest = z.object({
|
|
|
487
484
|
})
|
|
488
485
|
).max(100).optional()
|
|
489
486
|
}).describe(
|
|
490
|
-
"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
|
|
487
|
+
"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."
|
|
491
488
|
).optional(),
|
|
492
489
|
source: z.enum([
|
|
493
490
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -507,14 +504,9 @@ var SetSeoPatternRequest = z.object({
|
|
|
507
504
|
"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."
|
|
508
505
|
),
|
|
509
506
|
options: z.object({
|
|
510
|
-
fieldMask: z.object({ paths: z.array(z.string()) }).describe(
|
|
511
|
-
"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`."
|
|
512
|
-
),
|
|
513
|
-
collectionName: z.string().describe(
|
|
514
|
-
"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`."
|
|
515
|
-
).max(200).optional().nullable(),
|
|
507
|
+
fieldMask: z.object({ paths: z.array(z.string()) }).describe("Fields to update.\n\nSupported properties: `pattern`"),
|
|
516
508
|
pageId: z.string().describe(
|
|
517
|
-
"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.
|
|
509
|
+
"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."
|
|
518
510
|
).max(200).optional().nullable()
|
|
519
511
|
})
|
|
520
512
|
});
|
|
@@ -524,10 +516,10 @@ var SetSeoPatternResponse = z.object({
|
|
|
524
516
|
"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}`."
|
|
525
517
|
).max(400).optional().nullable(),
|
|
526
518
|
pageType: z.string().describe(
|
|
527
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
519
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
528
520
|
).max(100).optional(),
|
|
529
521
|
pageId: z.string().describe(
|
|
530
|
-
"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.
|
|
522
|
+
"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."
|
|
531
523
|
).max(200).optional().nullable(),
|
|
532
524
|
pattern: z.object({
|
|
533
525
|
tags: z.array(
|
|
@@ -545,7 +537,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
545
537
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
546
538
|
).optional(),
|
|
547
539
|
custom: z.boolean().describe(
|
|
548
|
-
|
|
540
|
+
'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.'
|
|
549
541
|
).optional(),
|
|
550
542
|
disabled: z.boolean().describe(
|
|
551
543
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -553,7 +545,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
553
545
|
})
|
|
554
546
|
).max(100).optional()
|
|
555
547
|
}).describe(
|
|
556
|
-
"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.
|
|
548
|
+
"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."
|
|
557
549
|
).optional(),
|
|
558
550
|
defaultPattern: z.object({
|
|
559
551
|
tags: z.array(
|
|
@@ -571,7 +563,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
571
563
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
572
564
|
).optional(),
|
|
573
565
|
custom: z.boolean().describe(
|
|
574
|
-
|
|
566
|
+
'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.'
|
|
575
567
|
).optional(),
|
|
576
568
|
disabled: z.boolean().describe(
|
|
577
569
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -579,7 +571,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
579
571
|
})
|
|
580
572
|
).max(100).optional()
|
|
581
573
|
}).describe(
|
|
582
|
-
"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
|
|
574
|
+
"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."
|
|
583
575
|
).optional(),
|
|
584
576
|
source: z.enum([
|
|
585
577
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -597,7 +589,7 @@ var SetSeoPatternResponse = z.object({
|
|
|
597
589
|
"ORIGIN_MIGRATION",
|
|
598
590
|
"ORIGIN_AI"
|
|
599
591
|
]).describe(
|
|
600
|
-
"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\
|
|
592
|
+
"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."
|
|
601
593
|
).optional()
|
|
602
594
|
}).describe("The updated pattern.").optional()
|
|
603
595
|
});
|
|
@@ -606,11 +598,8 @@ var ResetSeoPatternToDefaultRequest = z.object({
|
|
|
606
598
|
"Page type whose pattern to reset. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
607
599
|
).max(100),
|
|
608
600
|
options: z.object({
|
|
609
|
-
collectionName: z.string().describe(
|
|
610
|
-
"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`."
|
|
611
|
-
).max(200).optional().nullable(),
|
|
612
601
|
pageId: z.string().describe(
|
|
613
|
-
"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.
|
|
602
|
+
"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."
|
|
614
603
|
).max(200).optional().nullable()
|
|
615
604
|
}).optional()
|
|
616
605
|
});
|
|
@@ -620,10 +609,10 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
620
609
|
"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}`."
|
|
621
610
|
).max(400).optional().nullable(),
|
|
622
611
|
pageType: z.string().describe(
|
|
623
|
-
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT
|
|
612
|
+
"Page type the pattern applies to. For example, `STATIC_PAGE`, `BLOG_POST`, or\n`STORES_PRODUCT`."
|
|
624
613
|
).max(100).optional(),
|
|
625
614
|
pageId: z.string().describe(
|
|
626
|
-
"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.
|
|
615
|
+
"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."
|
|
627
616
|
).max(200).optional().nullable(),
|
|
628
617
|
pattern: z.object({
|
|
629
618
|
tags: z.array(
|
|
@@ -641,7 +630,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
641
630
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
642
631
|
).optional(),
|
|
643
632
|
custom: z.boolean().describe(
|
|
644
|
-
|
|
633
|
+
'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.'
|
|
645
634
|
).optional(),
|
|
646
635
|
disabled: z.boolean().describe(
|
|
647
636
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -649,7 +638,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
649
638
|
})
|
|
650
639
|
).max(100).optional()
|
|
651
640
|
}).describe(
|
|
652
|
-
"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.
|
|
641
|
+
"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."
|
|
653
642
|
).optional(),
|
|
654
643
|
defaultPattern: z.object({
|
|
655
644
|
tags: z.array(
|
|
@@ -667,7 +656,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
667
656
|
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
668
657
|
).optional(),
|
|
669
658
|
custom: z.boolean().describe(
|
|
670
|
-
|
|
659
|
+
'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.'
|
|
671
660
|
).optional(),
|
|
672
661
|
disabled: z.boolean().describe(
|
|
673
662
|
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
@@ -675,7 +664,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
675
664
|
})
|
|
676
665
|
).max(100).optional()
|
|
677
666
|
}).describe(
|
|
678
|
-
"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
|
|
667
|
+
"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."
|
|
679
668
|
).optional(),
|
|
680
669
|
source: z.enum([
|
|
681
670
|
"PATTERN_SOURCE_UNSPECIFIED",
|
|
@@ -693,7 +682,7 @@ var ResetSeoPatternToDefaultResponse = z.object({
|
|
|
693
682
|
"ORIGIN_MIGRATION",
|
|
694
683
|
"ORIGIN_AI"
|
|
695
684
|
]).describe(
|
|
696
|
-
"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\
|
|
685
|
+
"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."
|
|
697
686
|
).optional()
|
|
698
687
|
}).describe(
|
|
699
688
|
"The page type after the reset: an empty `pattern`, and `source` of\n`PATTERN_SOURCE_DEFAULT`."
|