@wix/auto_sdk_events_forms 1.0.124 → 1.0.126
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 +5 -5
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +118 -55
- package/build/cjs/index.typings.js +5 -5
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +118 -55
- package/build/cjs/meta.js +5 -5
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs +5 -5
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +118 -55
- package/build/es/index.typings.mjs +5 -5
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +118 -55
- package/build/es/meta.mjs +5 -5
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +118 -55
- package/build/internal/cjs/meta.d.ts +118 -55
- package/build/internal/es/index.typings.d.mts +118 -55
- package/build/internal/es/meta.d.mts +118 -55
- package/package.json +4 -4
package/build/es/meta.d.mts
CHANGED
|
@@ -1433,73 +1433,117 @@ interface SeoSettings {
|
|
|
1433
1433
|
hidden?: boolean | null;
|
|
1434
1434
|
}
|
|
1435
1435
|
/**
|
|
1436
|
-
* The SEO
|
|
1437
|
-
*
|
|
1438
|
-
*
|
|
1436
|
+
* The SEO data for a single page or dynamic item, in the shape stored today.
|
|
1437
|
+
*
|
|
1438
|
+
* FROZEN. Existing server code maps onto this message field by field, so its
|
|
1439
|
+
* field set must never change (see the file header). New writers use
|
|
1440
|
+
* `SeoSchemaV2`.
|
|
1441
|
+
*
|
|
1442
|
+
* These tags are rendered into the <head> of the HTML document and are not
|
|
1443
|
+
* visible on the page itself. They override every other source of tags
|
|
1444
|
+
* (site defaults, vertical presets, patterns) for this page.
|
|
1439
1445
|
*/
|
|
1440
1446
|
interface SeoSchema {
|
|
1441
|
-
/**
|
|
1447
|
+
/**
|
|
1448
|
+
* The tags rendered into <head>, in no particular order. Render order is
|
|
1449
|
+
* decided by the renderer, not by position in this list.
|
|
1450
|
+
*
|
|
1451
|
+
* No maxSize: this list is already populated by data written years ago, and
|
|
1452
|
+
* a bound added now could reject a page that is already stored.
|
|
1453
|
+
*/
|
|
1442
1454
|
tags?: Tag[];
|
|
1443
|
-
/** SEO
|
|
1455
|
+
/** Page-level SEO settings that are not themselves tags. */
|
|
1444
1456
|
settings?: Settings;
|
|
1445
1457
|
}
|
|
1458
|
+
/** A keyword term the user is targeting. */
|
|
1446
1459
|
interface Keyword {
|
|
1447
|
-
/**
|
|
1460
|
+
/**
|
|
1461
|
+
* The term itself, e.g. "trail running shoes".
|
|
1462
|
+
*
|
|
1463
|
+
* No maxLength, for the same reason as the legacy tag fields: keywords are
|
|
1464
|
+
* already stored, and a bound added now could reject a record written
|
|
1465
|
+
* before the bound existed. The flynt `missing-string-validations` warning
|
|
1466
|
+
* on this field is accepted deliberately.
|
|
1467
|
+
*/
|
|
1448
1468
|
term?: string;
|
|
1449
|
-
/** Whether
|
|
1469
|
+
/** Whether this is the page's primary focus keyword. At most one per page. */
|
|
1450
1470
|
isMain?: boolean;
|
|
1451
1471
|
/**
|
|
1452
|
-
*
|
|
1472
|
+
* Which surface added the term, e.g. a panel or a suggestion flow. Used for
|
|
1473
|
+
* attribution in BI. Opaque to the renderer.
|
|
1453
1474
|
* @maxLength 1000
|
|
1454
1475
|
*/
|
|
1455
1476
|
origin?: string | null;
|
|
1456
1477
|
}
|
|
1478
|
+
/**
|
|
1479
|
+
* One tag in the page's <head>.
|
|
1480
|
+
*
|
|
1481
|
+
* Not deprecated, and with no removal date, deliberately: stored data is
|
|
1482
|
+
* never migrated, so this shape stays valid input forever. `seo-renderer`
|
|
1483
|
+
* normalizes both shapes on READ.
|
|
1484
|
+
*/
|
|
1457
1485
|
interface Tag {
|
|
1458
1486
|
/**
|
|
1459
|
-
*
|
|
1460
|
-
*
|
|
1487
|
+
* Legacy. Was a free-form string: "title" | "meta" | "script" | "link".
|
|
1488
|
+
* The typed replacement is the `kind` oneof on `SeoSchemaV2.Tag`, which makes
|
|
1489
|
+
* the invalid combinations unrepresentable rather than merely discouraged.
|
|
1461
1490
|
*
|
|
1462
|
-
*
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1465
|
-
*
|
|
1466
|
-
*
|
|
1467
|
-
* `
|
|
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.
|
|
1491
|
+
* Which of these an API actually accepts depends on where the tag is being
|
|
1492
|
+
* set: this list is not a blanket guarantee across every API that reuses
|
|
1493
|
+
* this message. Site SEO Tags in particular accepts only `meta` (see
|
|
1494
|
+
* `SiteSeoTags.tags`) and rejects `title`/`script`/`link` with a validation
|
|
1495
|
+
* error even though they appear here — check the field description of the
|
|
1496
|
+
* specific `tags`-typed field you are writing to.
|
|
1470
1497
|
*
|
|
1471
1498
|
* Limitation: `title` and `script` (e.g. a `script` tag with `props.type`
|
|
1472
|
-
*
|
|
1473
|
-
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
1474
|
-
* tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
1475
|
-
* write through the site's Advanced/Custom Tags
|
|
1476
|
-
* omit `custom` (or set it to `false`).
|
|
1499
|
+
* "application/ld+json" carrying structured data) are supported only when
|
|
1500
|
+
* `custom` is unset or `false`. Setting `custom: true` on a `title` or
|
|
1501
|
+
* `script` tag is rejected with `TAG_TYPE_NOT_ALLOWED`, because
|
|
1502
|
+
* `custom: true` routes the write through the site's Advanced/Custom Tags
|
|
1503
|
+
* list. To write structured data, omit `custom` (or set it to `false`).
|
|
1504
|
+
*
|
|
1505
|
+
* No length limit: this field holds data written years ago by writers we
|
|
1506
|
+
* are not migrating. A constraint here could reject a record that is
|
|
1507
|
+
* already stored, which is exactly the promise this design makes.
|
|
1477
1508
|
*/
|
|
1478
1509
|
type?: string;
|
|
1479
1510
|
/**
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1511
|
+
* Legacy. Was an untyped bag of HTML attributes.
|
|
1512
|
+
* Typed replacement: `SeoSchemaV2.TitleTag` / `MetaTag` / `LinkTag`.
|
|
1482
1513
|
*/
|
|
1483
1514
|
props?: Record<string, any> | null;
|
|
1484
|
-
/**
|
|
1515
|
+
/**
|
|
1516
|
+
* Legacy. Was an untyped bag of 16 mixed-purpose keys. In `SeoSchemaV2`
|
|
1517
|
+
* its contents are split by purpose: per-page structured-data state moves to
|
|
1518
|
+
* StructuredDataTag, authorship to `written_by`, and render-time preset
|
|
1519
|
+
* logic (variants, enabledByExperiment, removeSchemaIf*) moved out of the
|
|
1520
|
+
* stored document entirely — it belongs to the preset definition, not to the
|
|
1521
|
+
* page. See the design log for the full key-by-key mapping.
|
|
1522
|
+
*/
|
|
1485
1523
|
meta?: Record<string, any> | null;
|
|
1486
|
-
/**
|
|
1524
|
+
/**
|
|
1525
|
+
* Legacy. Was the tag's inner content, doubling as the JSON-LD payload
|
|
1526
|
+
* for script tags. Typed replacement: `SeoSchemaV2.TitleTag.text` and
|
|
1527
|
+
* `StructuredDataTag.json_ld`.
|
|
1528
|
+
* No length limit, for the same reason as `type` above.
|
|
1529
|
+
*/
|
|
1487
1530
|
children?: string;
|
|
1488
1531
|
/**
|
|
1489
1532
|
* Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages) —
|
|
1490
1533
|
* i.e. an entry from the site's Advanced/Custom Tags list.
|
|
1491
1534
|
*
|
|
1492
|
-
* Setting this to `true` on a write restricts which `type` values are
|
|
1493
|
-
* — the same restriction the Advanced/Custom Tags UI enforces.
|
|
1494
|
-
* `script` tags (including JSON-LD structured data) must be sent
|
|
1495
|
-
* omitted or `false`; sending them with `custom: true` is
|
|
1496
|
-
* `TAG_TYPE_NOT_ALLOWED`.
|
|
1535
|
+
* Setting this to `true` on a write restricts which `type` values are
|
|
1536
|
+
* accepted — the same restriction the Advanced/Custom Tags UI enforces.
|
|
1537
|
+
* `title` and `script` tags (including JSON-LD structured data) must be sent
|
|
1538
|
+
* with `custom` omitted or `false`; sending them with `custom: true` is
|
|
1539
|
+
* rejected with `TAG_TYPE_NOT_ALLOWED`.
|
|
1497
1540
|
*
|
|
1498
|
-
* Note this is a separate restriction from Site SEO Tags' own type
|
|
1499
|
-
* `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
1500
|
-
* for site-wide structured data) unconditionally.
|
|
1501
|
-
* site-wide, every-page structured data
|
|
1502
|
-
* `script` tag through the Item
|
|
1541
|
+
* Note this is a separate restriction from Site SEO Tags' own type
|
|
1542
|
+
* restriction on `SiteSeoTags.tags`: even with `custom` unset, Site SEO Tags
|
|
1543
|
+
* rejects `script` (e.g. for site-wide structured data) unconditionally.
|
|
1544
|
+
* There is currently no way to set site-wide, every-page structured data
|
|
1545
|
+
* through any of these APIs — write a per-page `script` tag through the Item
|
|
1546
|
+
* SEO Tags API instead.
|
|
1503
1547
|
*
|
|
1504
1548
|
* This flag is scoped to that feature only. It is NOT an indicator of whether a standard tag
|
|
1505
1549
|
* (`title`, `description`, Open Graph, etc.) reflects a manually configured value versus a computed
|
|
@@ -1512,22 +1556,39 @@ interface Tag {
|
|
|
1512
1556
|
* or Wix Studio pages, so even genuine Advanced/Custom Tags saved on those pages are missing from the
|
|
1513
1557
|
* response entirely — there, `false` means this API could not tell, not that no custom tag exists.
|
|
1514
1558
|
* Pass `seoData` explicitly to resolve against a known set of tags.
|
|
1559
|
+
*
|
|
1560
|
+
* `SeoSchemaV2.Tag` expresses this as `written_by = USER_CUSTOM`.
|
|
1515
1561
|
*/
|
|
1516
1562
|
custom?: boolean;
|
|
1517
|
-
/**
|
|
1563
|
+
/**
|
|
1564
|
+
* Whether the tag is excluded from the rendered <head>.
|
|
1565
|
+
*
|
|
1566
|
+
* A disabled tag is still stored, so the user can re-enable it and so a
|
|
1567
|
+
* pattern-provided tag stays suppressed on this page. Default false.
|
|
1568
|
+
*/
|
|
1518
1569
|
disabled?: boolean;
|
|
1519
1570
|
}
|
|
1571
|
+
/** Page-level SEO settings that are not tags. */
|
|
1520
1572
|
interface Settings {
|
|
1521
1573
|
/**
|
|
1522
|
-
* Whether the
|
|
1523
|
-
*
|
|
1574
|
+
* Whether to suppress the automatic redirect from this page's previous URL to
|
|
1575
|
+
* its current one after a slug change.
|
|
1524
1576
|
*
|
|
1525
|
-
* Default
|
|
1577
|
+
* Default false, meaning the redirect IS created. The field is named for the
|
|
1578
|
+
* exception rather than the rule, which reads backwards; kept as-is because
|
|
1579
|
+
* renaming a stored boolean is not worth the migration.
|
|
1526
1580
|
*/
|
|
1527
1581
|
preventAutoRedirect?: boolean;
|
|
1528
1582
|
/**
|
|
1529
|
-
*
|
|
1530
|
-
*
|
|
1583
|
+
* Keyword terms the user is targeting for this page. Used by the SEO
|
|
1584
|
+
* assistant and checklist; never rendered into <head>.
|
|
1585
|
+
*
|
|
1586
|
+
* 20 is a sanity bound, not the product limit. v1 declared 5 — the number
|
|
1587
|
+
* the panel happens to allow today — which is exactly the mistake we are
|
|
1588
|
+
* fixing for structured data. A product decision to allow 8 should not need
|
|
1589
|
+
* a proto release, so the panel owns that number and the proto only stops
|
|
1590
|
+
* something absurd.
|
|
1591
|
+
* @maxSize 20
|
|
1531
1592
|
*/
|
|
1532
1593
|
keywords?: Keyword[];
|
|
1533
1594
|
}
|
|
@@ -2310,6 +2371,8 @@ interface TextStyle {
|
|
|
2310
2371
|
textAlignment?: TextAlignmentWithLiterals;
|
|
2311
2372
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
2312
2373
|
lineHeight?: string | null;
|
|
2374
|
+
/** Font size of an empty block: it sizes the empty line, its list marker and the text typed into it. Ignored on a block with text, which is sized by its text's `FONT_SIZE` decorations. */
|
|
2375
|
+
fontSize?: FontSizeData;
|
|
2313
2376
|
}
|
|
2314
2377
|
declare enum TextAlignment {
|
|
2315
2378
|
/** browser default, eqivalent to `initial` */
|
|
@@ -2325,6 +2388,18 @@ declare enum TextAlignment {
|
|
|
2325
2388
|
}
|
|
2326
2389
|
/** @enumType */
|
|
2327
2390
|
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
2391
|
+
interface FontSizeData {
|
|
2392
|
+
/** The units used for the font size. */
|
|
2393
|
+
unit?: FontTypeWithLiterals;
|
|
2394
|
+
/** Font size value. */
|
|
2395
|
+
value?: number | null;
|
|
2396
|
+
}
|
|
2397
|
+
declare enum FontType {
|
|
2398
|
+
PX = "PX",
|
|
2399
|
+
EM = "EM"
|
|
2400
|
+
}
|
|
2401
|
+
/** @enumType */
|
|
2402
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2328
2403
|
interface DividerData {
|
|
2329
2404
|
/** Styling for the divider's container. */
|
|
2330
2405
|
containerData?: PluginContainerData;
|
|
@@ -3189,18 +3264,6 @@ interface MentionData {
|
|
|
3189
3264
|
/** The kind of entity the mention refers to. Any value is accepted, and it's usually used to mark a mention as a group mention (for example, `group`). When empty, the mention refers to a member. */
|
|
3190
3265
|
type?: string | null;
|
|
3191
3266
|
}
|
|
3192
|
-
interface FontSizeData {
|
|
3193
|
-
/** The units used for the font size. */
|
|
3194
|
-
unit?: FontTypeWithLiterals;
|
|
3195
|
-
/** Font size value. */
|
|
3196
|
-
value?: number | null;
|
|
3197
|
-
}
|
|
3198
|
-
declare enum FontType {
|
|
3199
|
-
PX = "PX",
|
|
3200
|
-
EM = "EM"
|
|
3201
|
-
}
|
|
3202
|
-
/** @enumType */
|
|
3203
|
-
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
3204
3267
|
interface SpoilerData {
|
|
3205
3268
|
/** Spoiler ID. */
|
|
3206
3269
|
id?: string | null;
|
package/build/es/meta.mjs
CHANGED
|
@@ -869,6 +869,11 @@ var TextAlignment = /* @__PURE__ */ ((TextAlignment2) => {
|
|
|
869
869
|
TextAlignment2["JUSTIFY"] = "JUSTIFY";
|
|
870
870
|
return TextAlignment2;
|
|
871
871
|
})(TextAlignment || {});
|
|
872
|
+
var FontType = /* @__PURE__ */ ((FontType2) => {
|
|
873
|
+
FontType2["PX"] = "PX";
|
|
874
|
+
FontType2["EM"] = "EM";
|
|
875
|
+
return FontType2;
|
|
876
|
+
})(FontType || {});
|
|
872
877
|
var LineCap = /* @__PURE__ */ ((LineCap2) => {
|
|
873
878
|
LineCap2["SQUARE"] = "SQUARE";
|
|
874
879
|
LineCap2["ROUND"] = "ROUND";
|
|
@@ -1006,11 +1011,6 @@ var ColorDataBackgroundType = /* @__PURE__ */ ((ColorDataBackgroundType2) => {
|
|
|
1006
1011
|
ColorDataBackgroundType2["GRADIENT"] = "GRADIENT";
|
|
1007
1012
|
return ColorDataBackgroundType2;
|
|
1008
1013
|
})(ColorDataBackgroundType || {});
|
|
1009
|
-
var FontType = /* @__PURE__ */ ((FontType2) => {
|
|
1010
|
-
FontType2["PX"] = "PX";
|
|
1011
|
-
FontType2["EM"] = "EM";
|
|
1012
|
-
return FontType2;
|
|
1013
|
-
})(FontType || {});
|
|
1014
1014
|
var Variant = /* @__PURE__ */ ((Variant2) => {
|
|
1015
1015
|
Variant2["UNDERLINE"] = "UNDERLINE";
|
|
1016
1016
|
Variant2["BOX"] = "BOX";
|