@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.
@@ -3119,73 +3119,117 @@ declare enum ModerationStatusStatus {
3119
3119
  /** @enumType */
3120
3120
  type ModerationStatusStatusWithLiterals = ModerationStatusStatus | 'UNKNOWN' | 'APPROVED' | 'REJECTED';
3121
3121
  /**
3122
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
3123
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
3124
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
3122
+ * The SEO data for a single page or dynamic item, in the shape stored today.
3123
+ *
3124
+ * FROZEN. Existing server code maps onto this message field by field, so its
3125
+ * field set must never change (see the file header). New writers use
3126
+ * `SeoSchemaV2`.
3127
+ *
3128
+ * These tags are rendered into the <head> of the HTML document and are not
3129
+ * visible on the page itself. They override every other source of tags
3130
+ * (site defaults, vertical presets, patterns) for this page.
3125
3131
  */
3126
3132
  interface SeoSchema {
3127
- /** SEO tag information. */
3133
+ /**
3134
+ * The tags rendered into <head>, in no particular order. Render order is
3135
+ * decided by the renderer, not by position in this list.
3136
+ *
3137
+ * No maxSize: this list is already populated by data written years ago, and
3138
+ * a bound added now could reject a page that is already stored.
3139
+ */
3128
3140
  tags?: Tag[];
3129
- /** SEO general settings. */
3141
+ /** Page-level SEO settings that are not themselves tags. */
3130
3142
  settings?: Settings;
3131
3143
  }
3144
+ /** A keyword term the user is targeting. */
3132
3145
  interface Keyword {
3133
- /** Keyword value. */
3146
+ /**
3147
+ * The term itself, e.g. "trail running shoes".
3148
+ *
3149
+ * No maxLength, for the same reason as the legacy tag fields: keywords are
3150
+ * already stored, and a bound added now could reject a record written
3151
+ * before the bound existed. The flynt `missing-string-validations` warning
3152
+ * on this field is accepted deliberately.
3153
+ */
3134
3154
  term?: string;
3135
- /** Whether the keyword is the main focus keyword. */
3155
+ /** Whether this is the page's primary focus keyword. At most one per page. */
3136
3156
  isMain?: boolean;
3137
3157
  /**
3138
- * The source that added the keyword terms to the SEO settings.
3158
+ * Which surface added the term, e.g. a panel or a suggestion flow. Used for
3159
+ * attribution in BI. Opaque to the renderer.
3139
3160
  * @maxLength 1000
3140
3161
  */
3141
3162
  origin?: string | null;
3142
3163
  }
3164
+ /**
3165
+ * One tag in the page's <head>.
3166
+ *
3167
+ * Not deprecated, and with no removal date, deliberately: stored data is
3168
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
3169
+ * normalizes both shapes on READ.
3170
+ */
3143
3171
  interface Tag {
3144
3172
  /**
3145
- * SEO tag type.
3146
- *
3147
- *
3148
- * Supported values: `title`, `meta`, `script`, `link`.
3173
+ * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
3174
+ * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
3175
+ * the invalid combinations unrepresentable rather than merely discouraged.
3149
3176
  *
3150
- * Which of these an API actually accepts depends on where the tag is being set: this
3151
- * list is not a blanket guarantee across every API that reuses this message. Site SEO
3152
- * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
3153
- * `title`/`script`/`link` with a validation error even though they appear here —
3154
- * check the field description of the specific `tags`-typed field you're writing to
3155
- * for the types it actually supports and the error it returns.
3177
+ * Which of these an API actually accepts depends on where the tag is being
3178
+ * set: this list is not a blanket guarantee across every API that reuses
3179
+ * this message. Site SEO Tags in particular accepts only `meta` (see
3180
+ * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
3181
+ * error even though they appear here — check the field description of the
3182
+ * specific `tags`-typed field you are writing to.
3156
3183
  *
3157
3184
  * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
3158
- * `"application/ld+json"` carrying structured data) are supported only when
3159
- * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
3160
- * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
3161
- * write through the site's Advanced/Custom Tags list. To write structured data,
3162
- * omit `custom` (or set it to `false`).
3185
+ * "application/ld+json" carrying structured data) are supported only when
3186
+ * `custom` is unset or `false`. Setting `custom: true` on a `title` or
3187
+ * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
3188
+ * `custom: true` routes the write through the site's Advanced/Custom Tags
3189
+ * list. To write structured data, omit `custom` (or set it to `false`).
3190
+ *
3191
+ * No length limit: this field holds data written years ago by writers we
3192
+ * are not migrating. A constraint here could reject a record that is
3193
+ * already stored, which is exactly the promise this design makes.
3163
3194
  */
3164
3195
  type?: string;
3165
3196
  /**
3166
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
3167
- * For example: `{"name": "description", "content": "the description itself"}`.
3197
+ * Legacy. Was an untyped bag of HTML attributes.
3198
+ * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
3168
3199
  */
3169
3200
  props?: Record<string, any> | null;
3170
- /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
3201
+ /**
3202
+ * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
3203
+ * its contents are split by purpose: per-page structured-data state moves to
3204
+ * StructuredDataTag, authorship to `written_by`, and render-time preset
3205
+ * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
3206
+ * stored document entirely — it belongs to the preset definition, not to the
3207
+ * page. See the design log for the full key-by-key mapping.
3208
+ */
3171
3209
  meta?: Record<string, any> | null;
3172
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
3210
+ /**
3211
+ * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
3212
+ * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
3213
+ * `StructuredDataTag.json_ld`.
3214
+ * No length limit, for the same reason as `type` above.
3215
+ */
3173
3216
  children?: string;
3174
3217
  /**
3175
3218
  * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
3176
3219
  * i.e. an entry from the site's Advanced/Custom Tags list.
3177
3220
  *
3178
- * Setting this to `true` on a write restricts which `type` values are accepted
3179
- * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
3180
- * `script` tags (including JSON-LD structured data) must be sent with `custom`
3181
- * omitted or `false`; sending them with `custom: true` is rejected with
3182
- * `TAG_TYPE_NOT_ALLOWED`.
3221
+ * Setting this to `true` on a write restricts which `type` values are
3222
+ * accepted — the same restriction the Advanced/Custom Tags UI enforces.
3223
+ * `title` and `script` tags (including JSON-LD structured data) must be sent
3224
+ * with `custom` omitted or `false`; sending them with `custom: true` is
3225
+ * rejected with `TAG_TYPE_NOT_ALLOWED`.
3183
3226
  *
3184
- * Note this is a separate restriction from Site SEO Tags' own type restriction on
3185
- * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
3186
- * for site-wide structured data) unconditionally. There is currently no way to set
3187
- * site-wide, every-page structured data through any of these APIs — write a per-page
3188
- * `script` tag through the Item SEO Tags API instead.
3227
+ * Note this is a separate restriction from Site SEO Tags' own type
3228
+ * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
3229
+ * rejects `script` (e.g. for site-wide structured data) unconditionally.
3230
+ * There is currently no way to set site-wide, every-page structured data
3231
+ * through any of these APIs — write a per-page `script` tag through the Item
3232
+ * SEO Tags API instead.
3189
3233
  *
3190
3234
  * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
3191
3235
  * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -3198,22 +3242,39 @@ interface Tag {
3198
3242
  * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
3199
3243
  * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
3200
3244
  * Pass `seoData` explicitly to resolve against a known set of tags.
3245
+ *
3246
+ * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
3201
3247
  */
3202
3248
  custom?: boolean;
3203
- /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
3249
+ /**
3250
+ * Whether the tag is excluded from the rendered <head>.
3251
+ *
3252
+ * A disabled tag is still stored, so the user can re-enable it and so a
3253
+ * pattern-provided tag stays suppressed on this page. Default false.
3254
+ */
3204
3255
  disabled?: boolean;
3205
3256
  }
3257
+ /** Page-level SEO settings that are not tags. */
3206
3258
  interface Settings {
3207
3259
  /**
3208
- * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
3260
+ * Whether to suppress the automatic redirect from this page's previous URL to
3261
+ * its current one after a slug change.
3209
3262
  *
3210
- *
3211
- * Default: `false` (automatical redirect is enabled).
3263
+ * Default false, meaning the redirect IS created. The field is named for the
3264
+ * exception rather than the rule, which reads backwards; kept as-is because
3265
+ * renaming a stored boolean is not worth the migration.
3212
3266
  */
3213
3267
  preventAutoRedirect?: boolean;
3214
3268
  /**
3215
- * User-selected keyword terms for a specific page.
3216
- * @maxSize 5
3269
+ * Keyword terms the user is targeting for this page. Used by the SEO
3270
+ * assistant and checklist; never rendered into <head>.
3271
+ *
3272
+ * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
3273
+ * the panel happens to allow today — which is exactly the mistake we are
3274
+ * fixing for structured data. A product decision to allow 8 should not need
3275
+ * a proto release, so the panel owns that number and the proto only stops
3276
+ * something absurd.
3277
+ * @maxSize 20
3217
3278
  */
3218
3279
  keywords?: Keyword[];
3219
3280
  }