@wix/auto_sdk_blog_draft-posts 1.0.119 → 1.0.121
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 +104 -43
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +104 -43
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +104 -43
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +104 -43
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +104 -43
- package/build/internal/cjs/meta.d.ts +104 -43
- package/build/internal/es/index.typings.d.mts +104 -43
- package/build/internal/es/meta.d.mts +104 -43
- package/package.json +4 -4
|
@@ -3168,73 +3168,117 @@ declare enum ModerationStatusStatus {
|
|
|
3168
3168
|
/** @enumType */
|
|
3169
3169
|
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
3170
3170
|
/**
|
|
3171
|
-
* The SEO
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3171
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
3172
|
+
*
|
|
3173
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
3174
|
+
* field set must never change (see the file header). New writers use
|
|
3175
|
+
* `SeoSchemaV2`.
|
|
3176
|
+
*
|
|
3177
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
3178
|
+
* visible on the page itself. They override every other source of tags
|
|
3179
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
3174
3180
|
*/
|
|
3175
3181
|
interface SeoSchema {
|
|
3176
|
-
/**
|
|
3182
|
+
/**
|
|
3183
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
3184
|
+
* decided by the renderer, not by position in this list.
|
|
3185
|
+
*
|
|
3186
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
3187
|
+
* a bound added now could reject a page that is already stored.
|
|
3188
|
+
*/
|
|
3177
3189
|
tags?: Tag[];
|
|
3178
|
-
/** SEO
|
|
3190
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
3179
3191
|
settings?: Settings;
|
|
3180
3192
|
}
|
|
3193
|
+
/** A keyword term the user is targeting. */
|
|
3181
3194
|
interface Keyword {
|
|
3182
|
-
/**
|
|
3195
|
+
/**
|
|
3196
|
+
* The term itself, e.g. "trail running shoes".
|
|
3197
|
+
*
|
|
3198
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
3199
|
+
* already stored, and a bound added now could reject a record written
|
|
3200
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
3201
|
+
* on this field is accepted deliberately.
|
|
3202
|
+
*/
|
|
3183
3203
|
term?: string;
|
|
3184
|
-
/** Whether
|
|
3204
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
3185
3205
|
isMain?: boolean;
|
|
3186
3206
|
/**
|
|
3187
|
-
*
|
|
3207
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
3208
|
+
* attribution in BI. Opaque to the renderer.
|
|
3188
3209
|
* @maxLength 1000
|
|
3189
3210
|
*/
|
|
3190
3211
|
origin?: string | null;
|
|
3191
3212
|
}
|
|
3213
|
+
/**
|
|
3214
|
+
* One tag in the page's <head>.
|
|
3215
|
+
*
|
|
3216
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
3217
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
3218
|
+
* normalizes both shapes on READ.
|
|
3219
|
+
*/
|
|
3192
3220
|
interface Tag {
|
|
3193
3221
|
/**
|
|
3194
|
-
*
|
|
3195
|
-
*
|
|
3196
|
-
*
|
|
3197
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
3222
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
3223
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
3224
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
3198
3225
|
*
|
|
3199
|
-
* Which of these an API actually accepts depends on where the tag is being
|
|
3200
|
-
* list is not a blanket guarantee across every API that reuses
|
|
3201
|
-
* Tags in particular accepts only `meta` (see
|
|
3202
|
-
* `title`/`script`/`link` with a validation
|
|
3203
|
-
*
|
|
3204
|
-
*
|
|
3226
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
3227
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
3228
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
3229
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
3230
|
+
* error even though they appear here — check the field description of the
|
|
3231
|
+
* specific `tags`-typed field you are writing to.
|
|
3205
3232
|
*
|
|
3206
3233
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
3207
|
-
*
|
|
3208
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
3209
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
3210
|
-
* write through the site's Advanced/Custom Tags
|
|
3211
|
-
* omit `custom` (or set it to `false`).
|
|
3234
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
3235
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
3236
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
3237
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
3238
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
3239
|
+
*
|
|
3240
|
+
* No length limit: this field holds data written years ago by writers we
|
|
3241
|
+
* are not migrating. A constraint here could reject a record that is
|
|
3242
|
+
* already stored, which is exactly the promise this design makes.
|
|
3212
3243
|
*/
|
|
3213
3244
|
type?: string;
|
|
3214
3245
|
/**
|
|
3215
|
-
*
|
|
3216
|
-
*
|
|
3246
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
3247
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
3217
3248
|
*/
|
|
3218
3249
|
props?: Record<string, any> | null;
|
|
3219
|
-
/**
|
|
3250
|
+
/**
|
|
3251
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
3252
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
3253
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
3254
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
3255
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
3256
|
+
* page. See the design log for the full key-by-key mapping.
|
|
3257
|
+
*/
|
|
3220
3258
|
meta?: Record<string, any> | null;
|
|
3221
|
-
/**
|
|
3259
|
+
/**
|
|
3260
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
3261
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
3262
|
+
* `StructuredDataTag.json_ld`.
|
|
3263
|
+
* No length limit, for the same reason as `type` above.
|
|
3264
|
+
*/
|
|
3222
3265
|
children?: string;
|
|
3223
3266
|
/**
|
|
3224
3267
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
3225
3268
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
3226
3269
|
*
|
|
3227
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
3228
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
3229
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
3230
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
3231
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
3270
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
3271
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
3272
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
3273
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
3274
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
3232
3275
|
*
|
|
3233
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
3234
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
3235
|
-
* for site-wide structured data) unconditionally.
|
|
3236
|
-
* site-wide, every-page structured data
|
|
3237
|
-
* `script` tag through the Item
|
|
3276
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
3277
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
3278
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
3279
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
3280
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
3281
|
+
* SEO Tags API instead.
|
|
3238
3282
|
*
|
|
3239
3283
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
3240
3284
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -3247,22 +3291,39 @@ interface Tag {
|
|
|
3247
3291
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
3248
3292
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
3249
3293
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
3294
|
+
*
|
|
3295
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
3250
3296
|
*/
|
|
3251
3297
|
custom?: boolean;
|
|
3252
|
-
/**
|
|
3298
|
+
/**
|
|
3299
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
3300
|
+
*
|
|
3301
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
3302
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
3303
|
+
*/
|
|
3253
3304
|
disabled?: boolean;
|
|
3254
3305
|
}
|
|
3306
|
+
/** Page-level SEO settings that are not tags. */
|
|
3255
3307
|
interface Settings {
|
|
3256
3308
|
/**
|
|
3257
|
-
* Whether the
|
|
3309
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
3310
|
+
* its current one after a slug change.
|
|
3258
3311
|
*
|
|
3259
|
-
*
|
|
3260
|
-
*
|
|
3312
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
3313
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
3314
|
+
* renaming a stored boolean is not worth the migration.
|
|
3261
3315
|
*/
|
|
3262
3316
|
preventAutoRedirect?: boolean;
|
|
3263
3317
|
/**
|
|
3264
|
-
*
|
|
3265
|
-
*
|
|
3318
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
3319
|
+
* assistant and checklist; never rendered into <head>.
|
|
3320
|
+
*
|
|
3321
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
3322
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
3323
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
3324
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
3325
|
+
* something absurd.
|
|
3326
|
+
* @maxSize 20
|
|
3266
3327
|
*/
|
|
3267
3328
|
keywords?: Keyword[];
|
|
3268
3329
|
}
|
|
@@ -3209,73 +3209,117 @@ declare enum ModerationStatusStatus {
|
|
|
3209
3209
|
/** @enumType */
|
|
3210
3210
|
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
3211
3211
|
/**
|
|
3212
|
-
* The SEO
|
|
3213
|
-
*
|
|
3214
|
-
*
|
|
3212
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
3213
|
+
*
|
|
3214
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
3215
|
+
* field set must never change (see the file header). New writers use
|
|
3216
|
+
* `SeoSchemaV2`.
|
|
3217
|
+
*
|
|
3218
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
3219
|
+
* visible on the page itself. They override every other source of tags
|
|
3220
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
3215
3221
|
*/
|
|
3216
3222
|
interface SeoSchema {
|
|
3217
|
-
/**
|
|
3223
|
+
/**
|
|
3224
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
3225
|
+
* decided by the renderer, not by position in this list.
|
|
3226
|
+
*
|
|
3227
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
3228
|
+
* a bound added now could reject a page that is already stored.
|
|
3229
|
+
*/
|
|
3218
3230
|
tags?: Tag[];
|
|
3219
|
-
/** SEO
|
|
3231
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
3220
3232
|
settings?: Settings;
|
|
3221
3233
|
}
|
|
3234
|
+
/** A keyword term the user is targeting. */
|
|
3222
3235
|
interface Keyword {
|
|
3223
|
-
/**
|
|
3236
|
+
/**
|
|
3237
|
+
* The term itself, e.g. "trail running shoes".
|
|
3238
|
+
*
|
|
3239
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
3240
|
+
* already stored, and a bound added now could reject a record written
|
|
3241
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
3242
|
+
* on this field is accepted deliberately.
|
|
3243
|
+
*/
|
|
3224
3244
|
term?: string;
|
|
3225
|
-
/** Whether
|
|
3245
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
3226
3246
|
isMain?: boolean;
|
|
3227
3247
|
/**
|
|
3228
|
-
*
|
|
3248
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
3249
|
+
* attribution in BI. Opaque to the renderer.
|
|
3229
3250
|
* @maxLength 1000
|
|
3230
3251
|
*/
|
|
3231
3252
|
origin?: string | null;
|
|
3232
3253
|
}
|
|
3254
|
+
/**
|
|
3255
|
+
* One tag in the page's <head>.
|
|
3256
|
+
*
|
|
3257
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
3258
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
3259
|
+
* normalizes both shapes on READ.
|
|
3260
|
+
*/
|
|
3233
3261
|
interface Tag {
|
|
3234
3262
|
/**
|
|
3235
|
-
*
|
|
3236
|
-
*
|
|
3237
|
-
*
|
|
3238
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
3263
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
3264
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
3265
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
3239
3266
|
*
|
|
3240
|
-
* Which of these an API actually accepts depends on where the tag is being
|
|
3241
|
-
* list is not a blanket guarantee across every API that reuses
|
|
3242
|
-
* Tags in particular accepts only `meta` (see
|
|
3243
|
-
* `title`/`script`/`link` with a validation
|
|
3244
|
-
*
|
|
3245
|
-
*
|
|
3267
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
3268
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
3269
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
3270
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
3271
|
+
* error even though they appear here — check the field description of the
|
|
3272
|
+
* specific `tags`-typed field you are writing to.
|
|
3246
3273
|
*
|
|
3247
3274
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
3248
|
-
*
|
|
3249
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
3250
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
3251
|
-
* write through the site's Advanced/Custom Tags
|
|
3252
|
-
* omit `custom` (or set it to `false`).
|
|
3275
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
3276
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
3277
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
3278
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
3279
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
3280
|
+
*
|
|
3281
|
+
* No length limit: this field holds data written years ago by writers we
|
|
3282
|
+
* are not migrating. A constraint here could reject a record that is
|
|
3283
|
+
* already stored, which is exactly the promise this design makes.
|
|
3253
3284
|
*/
|
|
3254
3285
|
type?: string;
|
|
3255
3286
|
/**
|
|
3256
|
-
*
|
|
3257
|
-
*
|
|
3287
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
3288
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
3258
3289
|
*/
|
|
3259
3290
|
props?: Record<string, any> | null;
|
|
3260
|
-
/**
|
|
3291
|
+
/**
|
|
3292
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
3293
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
3294
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
3295
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
3296
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
3297
|
+
* page. See the design log for the full key-by-key mapping.
|
|
3298
|
+
*/
|
|
3261
3299
|
meta?: Record<string, any> | null;
|
|
3262
|
-
/**
|
|
3300
|
+
/**
|
|
3301
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
3302
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
3303
|
+
* `StructuredDataTag.json_ld`.
|
|
3304
|
+
* No length limit, for the same reason as `type` above.
|
|
3305
|
+
*/
|
|
3263
3306
|
children?: string;
|
|
3264
3307
|
/**
|
|
3265
3308
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
3266
3309
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
3267
3310
|
*
|
|
3268
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
3269
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
3270
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
3271
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
3272
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
3311
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
3312
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
3313
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
3314
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
3315
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
3273
3316
|
*
|
|
3274
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
3275
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
3276
|
-
* for site-wide structured data) unconditionally.
|
|
3277
|
-
* site-wide, every-page structured data
|
|
3278
|
-
* `script` tag through the Item
|
|
3317
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
3318
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
3319
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
3320
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
3321
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
3322
|
+
* SEO Tags API instead.
|
|
3279
3323
|
*
|
|
3280
3324
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
3281
3325
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -3288,22 +3332,39 @@ interface Tag {
|
|
|
3288
3332
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
3289
3333
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
3290
3334
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
3335
|
+
*
|
|
3336
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
3291
3337
|
*/
|
|
3292
3338
|
custom?: boolean;
|
|
3293
|
-
/**
|
|
3339
|
+
/**
|
|
3340
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
3341
|
+
*
|
|
3342
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
3343
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
3344
|
+
*/
|
|
3294
3345
|
disabled?: boolean;
|
|
3295
3346
|
}
|
|
3347
|
+
/** Page-level SEO settings that are not tags. */
|
|
3296
3348
|
interface Settings {
|
|
3297
3349
|
/**
|
|
3298
|
-
* Whether the
|
|
3350
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
3351
|
+
* its current one after a slug change.
|
|
3299
3352
|
*
|
|
3300
|
-
*
|
|
3301
|
-
*
|
|
3353
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
3354
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
3355
|
+
* renaming a stored boolean is not worth the migration.
|
|
3302
3356
|
*/
|
|
3303
3357
|
preventAutoRedirect?: boolean;
|
|
3304
3358
|
/**
|
|
3305
|
-
*
|
|
3306
|
-
*
|
|
3359
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
3360
|
+
* assistant and checklist; never rendered into <head>.
|
|
3361
|
+
*
|
|
3362
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
3363
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
3364
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
3365
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
3366
|
+
* something absurd.
|
|
3367
|
+
* @maxSize 20
|
|
3307
3368
|
*/
|
|
3308
3369
|
keywords?: Keyword[];
|
|
3309
3370
|
}
|
|
@@ -3168,73 +3168,117 @@ declare enum ModerationStatusStatus {
|
|
|
3168
3168
|
/** @enumType */
|
|
3169
3169
|
type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
|
|
3170
3170
|
/**
|
|
3171
|
-
* The SEO
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3171
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
3172
|
+
*
|
|
3173
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
3174
|
+
* field set must never change (see the file header). New writers use
|
|
3175
|
+
* `SeoSchemaV2`.
|
|
3176
|
+
*
|
|
3177
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
3178
|
+
* visible on the page itself. They override every other source of tags
|
|
3179
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
3174
3180
|
*/
|
|
3175
3181
|
interface SeoSchema {
|
|
3176
|
-
/**
|
|
3182
|
+
/**
|
|
3183
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
3184
|
+
* decided by the renderer, not by position in this list.
|
|
3185
|
+
*
|
|
3186
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
3187
|
+
* a bound added now could reject a page that is already stored.
|
|
3188
|
+
*/
|
|
3177
3189
|
tags?: Tag[];
|
|
3178
|
-
/** SEO
|
|
3190
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
3179
3191
|
settings?: Settings;
|
|
3180
3192
|
}
|
|
3193
|
+
/** A keyword term the user is targeting. */
|
|
3181
3194
|
interface Keyword {
|
|
3182
|
-
/**
|
|
3195
|
+
/**
|
|
3196
|
+
* The term itself, e.g. "trail running shoes".
|
|
3197
|
+
*
|
|
3198
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
3199
|
+
* already stored, and a bound added now could reject a record written
|
|
3200
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
3201
|
+
* on this field is accepted deliberately.
|
|
3202
|
+
*/
|
|
3183
3203
|
term?: string;
|
|
3184
|
-
/** Whether
|
|
3204
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
3185
3205
|
isMain?: boolean;
|
|
3186
3206
|
/**
|
|
3187
|
-
*
|
|
3207
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
3208
|
+
* attribution in BI. Opaque to the renderer.
|
|
3188
3209
|
* @maxLength 1000
|
|
3189
3210
|
*/
|
|
3190
3211
|
origin?: string | null;
|
|
3191
3212
|
}
|
|
3213
|
+
/**
|
|
3214
|
+
* One tag in the page's <head>.
|
|
3215
|
+
*
|
|
3216
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
3217
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
3218
|
+
* normalizes both shapes on READ.
|
|
3219
|
+
*/
|
|
3192
3220
|
interface Tag {
|
|
3193
3221
|
/**
|
|
3194
|
-
*
|
|
3195
|
-
*
|
|
3196
|
-
*
|
|
3197
|
-
* Supported values: `title`, `meta`, `script`, `link`.
|
|
3222
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
3223
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
3224
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
3198
3225
|
*
|
|
3199
|
-
* Which of these an API actually accepts depends on where the tag is being
|
|
3200
|
-
* list is not a blanket guarantee across every API that reuses
|
|
3201
|
-
* Tags in particular accepts only `meta` (see
|
|
3202
|
-
* `title`/`script`/`link` with a validation
|
|
3203
|
-
*
|
|
3204
|
-
*
|
|
3226
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
3227
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
3228
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
3229
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
3230
|
+
* error even though they appear here — check the field description of the
|
|
3231
|
+
* specific `tags`-typed field you are writing to.
|
|
3205
3232
|
*
|
|
3206
3233
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
3207
|
-
*
|
|
3208
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
3209
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
3210
|
-
* write through the site's Advanced/Custom Tags
|
|
3211
|
-
* omit `custom` (or set it to `false`).
|
|
3234
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
3235
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
3236
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
3237
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
3238
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
3239
|
+
*
|
|
3240
|
+
* No length limit: this field holds data written years ago by writers we
|
|
3241
|
+
* are not migrating. A constraint here could reject a record that is
|
|
3242
|
+
* already stored, which is exactly the promise this design makes.
|
|
3212
3243
|
*/
|
|
3213
3244
|
type?: string;
|
|
3214
3245
|
/**
|
|
3215
|
-
*
|
|
3216
|
-
*
|
|
3246
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
3247
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
3217
3248
|
*/
|
|
3218
3249
|
props?: Record<string, any> | null;
|
|
3219
|
-
/**
|
|
3250
|
+
/**
|
|
3251
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
3252
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
3253
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
3254
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
3255
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
3256
|
+
* page. See the design log for the full key-by-key mapping.
|
|
3257
|
+
*/
|
|
3220
3258
|
meta?: Record<string, any> | null;
|
|
3221
|
-
/**
|
|
3259
|
+
/**
|
|
3260
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
3261
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
3262
|
+
* `StructuredDataTag.json_ld`.
|
|
3263
|
+
* No length limit, for the same reason as `type` above.
|
|
3264
|
+
*/
|
|
3222
3265
|
children?: string;
|
|
3223
3266
|
/**
|
|
3224
3267
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
3225
3268
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
3226
3269
|
*
|
|
3227
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
3228
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
3229
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
3230
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
3231
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
3270
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
3271
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
3272
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
3273
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
3274
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
3232
3275
|
*
|
|
3233
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
3234
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
3235
|
-
* for site-wide structured data) unconditionally.
|
|
3236
|
-
* site-wide, every-page structured data
|
|
3237
|
-
* `script` tag through the Item
|
|
3276
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
3277
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
3278
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
3279
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
3280
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
3281
|
+
* SEO Tags API instead.
|
|
3238
3282
|
*
|
|
3239
3283
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
3240
3284
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -3247,22 +3291,39 @@ interface Tag {
|
|
|
3247
3291
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
3248
3292
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
3249
3293
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
3294
|
+
*
|
|
3295
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
3250
3296
|
*/
|
|
3251
3297
|
custom?: boolean;
|
|
3252
|
-
/**
|
|
3298
|
+
/**
|
|
3299
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
3300
|
+
*
|
|
3301
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
3302
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
3303
|
+
*/
|
|
3253
3304
|
disabled?: boolean;
|
|
3254
3305
|
}
|
|
3306
|
+
/** Page-level SEO settings that are not tags. */
|
|
3255
3307
|
interface Settings {
|
|
3256
3308
|
/**
|
|
3257
|
-
* Whether the
|
|
3309
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
3310
|
+
* its current one after a slug change.
|
|
3258
3311
|
*
|
|
3259
|
-
*
|
|
3260
|
-
*
|
|
3312
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
3313
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
3314
|
+
* renaming a stored boolean is not worth the migration.
|
|
3261
3315
|
*/
|
|
3262
3316
|
preventAutoRedirect?: boolean;
|
|
3263
3317
|
/**
|
|
3264
|
-
*
|
|
3265
|
-
*
|
|
3318
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
3319
|
+
* assistant and checklist; never rendered into <head>.
|
|
3320
|
+
*
|
|
3321
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
3322
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
3323
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
3324
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
3325
|
+
* something absurd.
|
|
3326
|
+
* @maxSize 20
|
|
3266
3327
|
*/
|
|
3267
3328
|
keywords?: Keyword[];
|
|
3268
3329
|
}
|