@wix/auto_sdk_events_forms 1.0.125 → 1.0.127

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.
@@ -1150,6 +1150,12 @@ interface TicketingConfig {
1150
1150
  * @max 30
1151
1151
  */
1152
1152
  reservationDurationInMinutes?: number | null;
1153
+ /**
1154
+ * Additional fees charged per order, in display order. Updating with this field in the
1155
+ * field mask replaces the whole list; an empty list clears it.
1156
+ * @maxSize 3
1157
+ */
1158
+ additionalFees?: AdditionalFeeConfig[];
1153
1159
  }
1154
1160
  interface TaxConfig {
1155
1161
  /** Tax application settings. */
@@ -1215,10 +1221,18 @@ declare enum CheckoutType {
1215
1221
  type CheckoutTypeWithLiterals = CheckoutType | 'EVENTS_APP' | 'ECOMM_PLATFORM';
1216
1222
  /** Additional fee configured on an event. Position in `additional_fees` is the display order. */
1217
1223
  interface AdditionalFeeConfig {
1224
+ /**
1225
+ * Fee name shown to buyers. Unique per event (case-insensitive).
1226
+ * @minLength 1
1227
+ * @maxLength 50
1228
+ */
1229
+ name?: string;
1230
+ /** Fee calculation formula. */
1231
+ formula?: AdditionalFeeFormula;
1218
1232
  }
1219
1233
  /**
1220
1234
  * Formula of an additional fee charged on top of ticket prices.
1221
- * Amounts are as displayed: net of tax under ADDED tax, gross under INCLUDED tax.
1235
+ * Amounts are as displayed: net of tax under ADDED_AT_CHECKOUT tax, gross under INCLUDED tax.
1222
1236
  */
1223
1237
  interface AdditionalFeeFormula extends AdditionalFeeFormulaCalculationOneOf {
1224
1238
  /**
@@ -1433,73 +1447,117 @@ interface SeoSettings {
1433
1447
  hidden?: boolean | null;
1434
1448
  }
1435
1449
  /**
1436
- * 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.
1437
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
1438
- * 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.
1450
+ * The SEO data for a single page or dynamic item, in the shape stored today.
1451
+ *
1452
+ * FROZEN. Existing server code maps onto this message field by field, so its
1453
+ * field set must never change (see the file header). New writers use
1454
+ * `SeoSchemaV2`.
1455
+ *
1456
+ * These tags are rendered into the <head> of the HTML document and are not
1457
+ * visible on the page itself. They override every other source of tags
1458
+ * (site defaults, vertical presets, patterns) for this page.
1439
1459
  */
1440
1460
  interface SeoSchema {
1441
- /** SEO tag information. */
1461
+ /**
1462
+ * The tags rendered into <head>, in no particular order. Render order is
1463
+ * decided by the renderer, not by position in this list.
1464
+ *
1465
+ * No maxSize: this list is already populated by data written years ago, and
1466
+ * a bound added now could reject a page that is already stored.
1467
+ */
1442
1468
  tags?: Tag[];
1443
- /** SEO general settings. */
1469
+ /** Page-level SEO settings that are not themselves tags. */
1444
1470
  settings?: Settings;
1445
1471
  }
1472
+ /** A keyword term the user is targeting. */
1446
1473
  interface Keyword {
1447
- /** Keyword value. */
1474
+ /**
1475
+ * The term itself, e.g. "trail running shoes".
1476
+ *
1477
+ * No maxLength, for the same reason as the legacy tag fields: keywords are
1478
+ * already stored, and a bound added now could reject a record written
1479
+ * before the bound existed. The flynt `missing-string-validations` warning
1480
+ * on this field is accepted deliberately.
1481
+ */
1448
1482
  term?: string;
1449
- /** Whether the keyword is the main focus keyword. */
1483
+ /** Whether this is the page's primary focus keyword. At most one per page. */
1450
1484
  isMain?: boolean;
1451
1485
  /**
1452
- * The source that added the keyword terms to the SEO settings.
1486
+ * Which surface added the term, e.g. a panel or a suggestion flow. Used for
1487
+ * attribution in BI. Opaque to the renderer.
1453
1488
  * @maxLength 1000
1454
1489
  */
1455
1490
  origin?: string | null;
1456
1491
  }
1492
+ /**
1493
+ * One tag in the page's <head>.
1494
+ *
1495
+ * Not deprecated, and with no removal date, deliberately: stored data is
1496
+ * never migrated, so this shape stays valid input forever. `seo-renderer`
1497
+ * normalizes both shapes on READ.
1498
+ */
1457
1499
  interface Tag {
1458
1500
  /**
1459
- * SEO tag type.
1460
- *
1501
+ * Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
1502
+ * The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
1503
+ * the invalid combinations unrepresentable rather than merely discouraged.
1461
1504
  *
1462
- * Supported values: `title`, `meta`, `script`, `link`.
1463
- *
1464
- * Which of these an API actually accepts depends on where the tag is being set: this
1465
- * list is not a blanket guarantee across every API that reuses this message. Site SEO
1466
- * Tags in particular accepts only `meta` (see `SiteSeoTags.tags`) and rejects
1467
- * `title`/`script`/`link` with a validation error even though they appear here —
1468
- * check the field description of the specific `tags`-typed field you're writing to
1469
- * for the types it actually supports and the error it returns.
1505
+ * Which of these an API actually accepts depends on where the tag is being
1506
+ * set: this list is not a blanket guarantee across every API that reuses
1507
+ * this message. Site SEO Tags in particular accepts only `meta` (see
1508
+ * `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
1509
+ * error even though they appear here — check the field description of the
1510
+ * specific `tags`-typed field you are writing to.
1470
1511
  *
1471
1512
  * Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
1472
- * `"application/ld+json"` carrying structured data) are supported only when
1473
- * `custom` is unset or `false`. Setting `custom: true` on a `title` or `script`
1474
- * tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because `custom: true` routes the
1475
- * write through the site's Advanced/Custom Tags list. To write structured data,
1476
- * omit `custom` (or set it to `false`).
1513
+ * "application/ld+json" carrying structured data) are supported only when
1514
+ * `custom` is unset or `false`. Setting `custom: true` on a `title` or
1515
+ * `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
1516
+ * `custom: true` routes the write through the site's Advanced/Custom Tags
1517
+ * list. To write structured data, omit `custom` (or set it to `false`).
1518
+ *
1519
+ * No length limit: this field holds data written years ago by writers we
1520
+ * are not migrating. A constraint here could reject a record that is
1521
+ * already stored, which is exactly the promise this design makes.
1477
1522
  */
1478
1523
  type?: string;
1479
1524
  /**
1480
- * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
1481
- * For example: `{"name": "description", "content": "the description itself"}`.
1525
+ * Legacy. Was an untyped bag of HTML attributes.
1526
+ * Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
1482
1527
  */
1483
1528
  props?: Record<string, any> | null;
1484
- /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
1529
+ /**
1530
+ * Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
1531
+ * its contents are split by purpose: per-page structured-data state moves to
1532
+ * StructuredDataTag, authorship to `written_by`, and render-time preset
1533
+ * logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
1534
+ * stored document entirely — it belongs to the preset definition, not to the
1535
+ * page. See the design log for the full key-by-key mapping.
1536
+ */
1485
1537
  meta?: Record<string, any> | null;
1486
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
1538
+ /**
1539
+ * Legacy. Was the tag's inner content, doubling as the JSON-LD payload
1540
+ * for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
1541
+ * `StructuredDataTag.json_ld`.
1542
+ * No length limit, for the same reason as `type` above.
1543
+ */
1487
1544
  children?: string;
1488
1545
  /**
1489
1546
  * Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
1490
1547
  * i.e. an entry from the site's Advanced/Custom Tags list.
1491
1548
  *
1492
- * Setting this to `true` on a write restricts which `type` values are accepted
1493
- * — the same restriction the Advanced/Custom Tags UI enforces. `title` and
1494
- * `script` tags (including JSON-LD structured data) must be sent with `custom`
1495
- * omitted or `false`; sending them with `custom: true` is rejected with
1496
- * `TAG_TYPE_NOT_ALLOWED`.
1549
+ * Setting this to `true` on a write restricts which `type` values are
1550
+ * accepted — the same restriction the Advanced/Custom Tags UI enforces.
1551
+ * `title` and `script` tags (including JSON-LD structured data) must be sent
1552
+ * with `custom` omitted or `false`; sending them with `custom: true` is
1553
+ * rejected with `TAG_TYPE_NOT_ALLOWED`.
1497
1554
  *
1498
- * Note this is a separate restriction from Site SEO Tags' own type restriction on
1499
- * `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags rejects `script` (e.g.
1500
- * for site-wide structured data) unconditionally. There is currently no way to set
1501
- * site-wide, every-page structured data through any of these APIs — write a per-page
1502
- * `script` tag through the Item SEO Tags API instead.
1555
+ * Note this is a separate restriction from Site SEO Tags' own type
1556
+ * restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
1557
+ * rejects `script` (e.g. for site-wide structured data) unconditionally.
1558
+ * There is currently no way to set site-wide, every-page structured data
1559
+ * through any of these APIs — write a per-page `script` tag through the Item
1560
+ * SEO Tags API instead.
1503
1561
  *
1504
1562
  * This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
1505
1563
  * (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
@@ -1512,22 +1570,39 @@ interface Tag {
1512
1570
  * or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
1513
1571
  * response entirely — there, `false` means this API could not tell, not that no custom tag exists.
1514
1572
  * Pass `seoData` explicitly to resolve against a known set of tags.
1573
+ *
1574
+ * `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
1515
1575
  */
1516
1576
  custom?: boolean;
1517
- /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
1577
+ /**
1578
+ * Whether the tag is excluded from the rendered <head>.
1579
+ *
1580
+ * A disabled tag is still stored, so the user can re-enable it and so a
1581
+ * pattern-provided tag stays suppressed on this page. Default false.
1582
+ */
1518
1583
  disabled?: boolean;
1519
1584
  }
1585
+ /** Page-level SEO settings that are not tags. */
1520
1586
  interface Settings {
1521
1587
  /**
1522
- * 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.
1588
+ * Whether to suppress the automatic redirect from this page's previous URL to
1589
+ * its current one after a slug change.
1523
1590
  *
1524
- *
1525
- * Default: `false` (automatical redirect is enabled).
1591
+ * Default false, meaning the redirect IS created. The field is named for the
1592
+ * exception rather than the rule, which reads backwards; kept as-is because
1593
+ * renaming a stored boolean is not worth the migration.
1526
1594
  */
1527
1595
  preventAutoRedirect?: boolean;
1528
1596
  /**
1529
- * User-selected keyword terms for a specific page.
1530
- * @maxSize 5
1597
+ * Keyword terms the user is targeting for this page. Used by the SEO
1598
+ * assistant and checklist; never rendered into <head>.
1599
+ *
1600
+ * 20 is a sanity bound, not the product limit. v1 declared 5 — the number
1601
+ * the panel happens to allow today — which is exactly the mistake we are
1602
+ * fixing for structured data. A product decision to allow 8 should not need
1603
+ * a proto release, so the panel owns that number and the proto only stops
1604
+ * something absurd.
1605
+ * @maxSize 20
1531
1606
  */
1532
1607
  keywords?: Keyword[];
1533
1608
  }