@wix/auto_sdk_online-programs_programs 1.0.42 → 1.0.43

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.
@@ -295,73 +295,117 @@ interface Seo {
295
295
  courseWorkload?: string;
296
296
  }
297
297
  /**
298
- * 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.
299
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
300
- * 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.
298
+ * The SEO data for a single page or dynamic item, in the shape stored today.
299
+ *
300
+ * FROZEN. Existing server code maps onto this message field by field, so its
301
+ * field set must never change (see the file header). New writers use
302
+ * `SeoSchemaV2`.
303
+ *
304
+ * These tags are rendered into the <head> of the HTML document and are not
305
+ * visible on the page itself. They override every other source of tags
306
+ * (site defaults, vertical presets, patterns) for this page.
301
307
  */
302
308
  interface SeoSchema {
303
- /** SEO tag information. */
309
+ /**
310
+ * The tags rendered into <head>, in no particular order. Render order is
311
+ * decided by the renderer, not by position in this list.
312
+ *
313
+ * No maxSize: this list is already populated by data written years ago, and
314
+ * a bound added now could reject a page that is already stored.
315
+ */
304
316
  tags?: Tag[];
305
- /** SEO general settings. */
317
+ /** Page-level SEO settings that are not themselves tags. */
306
318
  settings?: Settings;
307
319
  }
320
+ /** A keyword term the user is targeting. */
308
321
  interface Keyword {
309
- /** Keyword value. */
322
+ /**
323
+ * The term itself, e.g. "trail running shoes".
324
+ *
325
+ * No maxLength, for the same reason as the legacy tag fields: keywords are
326
+ * already stored, and a bound added now could reject a record written
327
+ * before the bound existed. The flynt `missing-string-validations` warning
328
+ * on this field is accepted deliberately.
329
+ */
310
330
  term?: string;
311
- /** Whether the keyword is the main focus keyword. */
331
+ /** Whether this is the page's primary focus keyword. At most one per page. */
312
332
  isMain?: boolean;
313
333
  /**
314
- * The source that added the keyword terms to the SEO settings.
334
+ * Which surface added the term, e.g. a panel or a suggestion flow. Used for
335
+ * attribution in BI. Opaque to the renderer.
315
336
  * @maxLength 1000
316
337
  */
317
338
  origin?: string | null;
318
339
  }
340
+ /**
341
+ * One tag in the page's <head>.
342
+ *
343
+ * Not deprecated, and with no removal date, deliberately: stored data is
344
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
345
+ * normalizes both shapes on READ.
346
+ */
319
347
  interface Tag {
320
348
  /**
321
- * SEO tag type.
322
- *
323
- *
324
- * Supported values: `title`, `meta`, `script`, `link`.
349
+ * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
350
+ * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
351
+ * the invalid combinations unrepresentable rather than merely discouraged.
325
352
  *
326
- * Which of these an API actually accepts depends on where the tag is being set: this
327
- * list is not a blanket guarantee across every API that reuses this message. Site SEO
328
- * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
329
- * `title`/`script`/`link` with a validation error even though they appear here —
330
- * check the field description of the specific `tags`-typed field you're writing to
331
- * for the types it actually supports and the error it returns.
353
+ * Which of these an API actually accepts depends on where the tag is being
354
+ * set: this list is not a blanket guarantee across every API that reuses
355
+ * this message. Site SEO Tags in particular accepts only `meta` (see
356
+ * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
357
+ * error even though they appear here — check the field description of the
358
+ * specific `tags`-typed field you are writing to.
332
359
  *
333
360
  * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
334
- * `"application/ld+json"` carrying structured data) are supported only when
335
- * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
336
- * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
337
- * write through the site's Advanced/Custom Tags list. To write structured data,
338
- * omit `custom` (or set it to `false`).
361
+ * "application/ld+json" carrying structured data) are supported only when
362
+ * `custom` is unset or `false`. Setting `custom: true` on a `title` or
363
+ * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
364
+ * `custom: true` routes the write through the site's Advanced/Custom Tags
365
+ * list. To write structured data, omit `custom` (or set it to `false`).
366
+ *
367
+ * No length limit: this field holds data written years ago by writers we
368
+ * are not migrating. A constraint here could reject a record that is
369
+ * already stored, which is exactly the promise this design makes.
339
370
  */
340
371
  type?: string;
341
372
  /**
342
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
343
- * For example: `{"name": "description", "content": "the description itself"}`.
373
+ * Legacy. Was an untyped bag of HTML attributes.
374
+ * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
344
375
  */
345
376
  props?: Record<string, any> | null;
346
- /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
377
+ /**
378
+ * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
379
+ * its contents are split by purpose: per-page structured-data state moves to
380
+ * StructuredDataTag, authorship to `written_by`, and render-time preset
381
+ * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
382
+ * stored document entirely — it belongs to the preset definition, not to the
383
+ * page. See the design log for the full key-by-key mapping.
384
+ */
347
385
  meta?: Record<string, any> | null;
348
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
386
+ /**
387
+ * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
388
+ * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
389
+ * `StructuredDataTag.json_ld`.
390
+ * No length limit, for the same reason as `type` above.
391
+ */
349
392
  children?: string;
350
393
  /**
351
394
  * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
352
395
  * i.e. an entry from the site's Advanced/Custom Tags list.
353
396
  *
354
- * Setting this to `true` on a write restricts which `type` values are accepted
355
- * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
356
- * `script` tags (including JSON-LD structured data) must be sent with `custom`
357
- * omitted or `false`; sending them with `custom: true` is rejected with
358
- * `TAG_TYPE_NOT_ALLOWED`.
397
+ * Setting this to `true` on a write restricts which `type` values are
398
+ * accepted — the same restriction the Advanced/Custom Tags UI enforces.
399
+ * `title` and `script` tags (including JSON-LD structured data) must be sent
400
+ * with `custom` omitted or `false`; sending them with `custom: true` is
401
+ * rejected with `TAG_TYPE_NOT_ALLOWED`.
359
402
  *
360
- * Note this is a separate restriction from Site SEO Tags' own type restriction on
361
- * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
362
- * for site-wide structured data) unconditionally. There is currently no way to set
363
- * site-wide, every-page structured data through any of these APIs — write a per-page
364
- * `script` tag through the Item SEO Tags API instead.
403
+ * Note this is a separate restriction from Site SEO Tags' own type
404
+ * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
405
+ * rejects `script` (e.g. for site-wide structured data) unconditionally.
406
+ * There is currently no way to set site-wide, every-page structured data
407
+ * through any of these APIs — write a per-page `script` tag through the Item
408
+ * SEO Tags API instead.
365
409
  *
366
410
  * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
367
411
  * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -374,22 +418,39 @@ interface Tag {
374
418
  * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
375
419
  * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
376
420
  * Pass `seoData` explicitly to resolve against a known set of tags.
421
+ *
422
+ * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
377
423
  */
378
424
  custom?: boolean;
379
- /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
425
+ /**
426
+ * Whether the tag is excluded from the rendered <head>.
427
+ *
428
+ * A disabled tag is still stored, so the user can re-enable it and so a
429
+ * pattern-provided tag stays suppressed on this page. Default false.
430
+ */
380
431
  disabled?: boolean;
381
432
  }
433
+ /** Page-level SEO settings that are not tags. */
382
434
  interface Settings {
383
435
  /**
384
- * 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.
436
+ * Whether to suppress the automatic redirect from this page's previous URL to
437
+ * its current one after a slug change.
385
438
  *
386
- *
387
- * Default: `false` (automatical redirect is enabled).
439
+ * Default false, meaning the redirect IS created. The field is named for the
440
+ * exception rather than the rule, which reads backwards; kept as-is because
441
+ * renaming a stored boolean is not worth the migration.
388
442
  */
389
443
  preventAutoRedirect?: boolean;
390
444
  /**
391
- * User-selected keyword terms for a specific page.
392
- * @maxSize 5
445
+ * Keyword terms the user is targeting for this page. Used by the SEO
446
+ * assistant and checklist; never rendered into <head>.
447
+ *
448
+ * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
449
+ * the panel happens to allow today — which is exactly the mistake we are
450
+ * fixing for structured data. A product decision to allow 8 should not need
451
+ * a proto release, so the panel owns that number and the proto only stops
452
+ * something absurd.
453
+ * @maxSize 20
393
454
  */
394
455
  keywords?: Keyword[];
395
456
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_online-programs_programs",
3
- "version": "1.0.42",
3
+ "version": "1.0.43",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -29,8 +29,8 @@
29
29
  "service-plugins"
30
30
  ],
31
31
  "dependencies": {
32
- "@wix/sdk-runtime": "^1.0.24",
33
- "@wix/sdk-types": "^1.17.11"
32
+ "@wix/sdk-runtime": "^1.0.28",
33
+ "@wix/sdk-types": "^1.17.12"
34
34
  },
35
35
  "devDependencies": {
36
36
  "tsup": "^8.4.0",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.online_programs.v3.program"
51
51
  }
52
52
  },
53
- "falconPackageHash": "7c92f64347d7bf2ab6c2cfd557a4cd753280debd3b751926dca3e8d9"
53
+ "falconPackageHash": "f46ce83b64b98e4ed440499cd2532594e628722c6c0f8b1c8cdb34e3"
54
54
  }