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