@wix/multilingual 1.0.36 → 1.0.38

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/multilingual",
3
- "version": "1.0.36",
3
+ "version": "1.0.38",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,11 +18,11 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/multilingual_entity-mapper": "1.0.10",
21
+ "@wix/multilingual_entity-mapper": "1.0.11",
22
22
  "@wix/multilingual_machine-translation": "1.0.26",
23
23
  "@wix/multilingual_site-translator": "1.0.12",
24
24
  "@wix/multilingual_translation-contents": "1.0.15",
25
- "@wix/multilingual_translation-published-contents": "1.0.3",
25
+ "@wix/multilingual_translation-published-contents": "1.0.4",
26
26
  "@wix/multilingual_translation-schemas": "1.0.13"
27
27
  },
28
28
  "devDependencies": {
@@ -48,5 +48,5 @@
48
48
  "fqdn": ""
49
49
  }
50
50
  },
51
- "falconPackageHash": "b35d9bc33c9271af41b5892df6a7235270499ddba0c79d888e6ae198"
51
+ "falconPackageHash": "397f35632bfffabd2d3e701e76e553c7e04d867d07fd1d7550f58394"
52
52
  }
@@ -60,6 +60,8 @@ interface Mapper {
60
60
  segment?: string | null;
61
61
  /** flag that indicate the removing a repeated field in main language should remove it in all languages */
62
62
  deleteRepeatedFields?: boolean | null;
63
+ /** Whether the entity can bt extended by Data Extensions */
64
+ extensible?: boolean | null;
63
65
  }
64
66
  interface MapperField {
65
67
  /** The field FQN */
@@ -523,26 +525,27 @@ declare namespace context$5 {
523
525
  /** Represents a content of an entity with its published translations */
524
526
  interface PublishedContent {
525
527
  /**
526
- * Content ID.
528
+ * Pubished content ID.
527
529
  * @readonly
528
530
  */
529
531
  _id?: string | null;
530
- /** Schema key of the content. */
532
+ /** Schema key of the published content. */
531
533
  schemaKey?: SchemaKey$1;
532
534
  /**
533
- * Unique identifier that represents a specific entity under the schema key
535
+ * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
534
536
  * @readonly
535
537
  */
536
538
  entityId?: string;
537
539
  /**
538
- * Indicates the locale of this content
540
+ * Published content locale.
539
541
  * @readonly
540
542
  */
541
543
  locale?: string;
542
- /** List of fields localized in the given locale */
544
+ /** List of fields that have been translated and published for the given locale. */
543
545
  fields?: PublishedContentField[];
544
- /** Optional field for the ID of the parent of this entity. */
546
+ /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
545
547
  parentEntityId?: string | null;
548
+ /** Custom field data for the published content object. */
546
549
  extendedFields?: ExtendedFields;
547
550
  }
548
551
  interface SchemaKey$1 {
@@ -551,9 +554,14 @@ interface SchemaKey$1 {
551
554
  * @readonly
552
555
  */
553
556
  appId?: string;
554
- /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
557
+ /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
555
558
  entityType?: string;
556
- /** Scope schema is defined in (Global/Site) */
559
+ /**
560
+ * Scope of the translation schema.
561
+ * Supported values:
562
+ * + `GLOBAL`: A global schema for all sites.
563
+ * + `SITE`: A custom schema for a specific site.
564
+ */
557
565
  scope?: SchemaScope$1;
558
566
  }
559
567
  declare enum SchemaScope$1 {
@@ -575,11 +583,11 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
575
583
  /** Document media item */
576
584
  document?: string;
577
585
  /**
578
- * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
586
+ * Unique string identifier that links a specific content field to its corresponding field in the schema.
579
587
  * @readonly
580
588
  */
581
589
  schemaFieldKey?: string;
582
- /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
590
+ /** For repeated fields. Contains the IDs of the messages linked to this field. */
583
591
  sequenceIds?: string[];
584
592
  }
585
593
  /** @oneof */
@@ -1854,7 +1862,7 @@ interface GetPublishedContentResponse {
1854
1862
  publishedContent?: PublishedContent;
1855
1863
  }
1856
1864
  interface QueryPublishedContentRequest {
1857
- /** The query to filter the published content */
1865
+ /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
1858
1866
  query: CursorQuery$2;
1859
1867
  }
1860
1868
  interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
@@ -1908,9 +1916,9 @@ interface CursorPaging$2 {
1908
1916
  cursor?: string | null;
1909
1917
  }
1910
1918
  interface QueryPublishedContentResponse {
1911
- /** The published content */
1919
+ /** The published translation content. */
1912
1920
  publishedContent?: PublishedContent[];
1913
- /** Paging information */
1921
+ /** Details on the paged set of results returned. */
1914
1922
  pagingMetadata?: CursorPagingMetadata$2;
1915
1923
  }
1916
1924
  interface CursorPagingMetadata$2 {
@@ -60,6 +60,8 @@ interface Mapper {
60
60
  segment?: string | null;
61
61
  /** flag that indicate the removing a repeated field in main language should remove it in all languages */
62
62
  deleteRepeatedFields?: boolean | null;
63
+ /** Whether the entity can bt extended by Data Extensions */
64
+ extensible?: boolean | null;
63
65
  }
64
66
  interface MapperField {
65
67
  /** The field FQN */
@@ -523,26 +525,27 @@ declare namespace index_d$5 {
523
525
  /** Represents a content of an entity with its published translations */
524
526
  interface PublishedContent {
525
527
  /**
526
- * Content ID.
528
+ * Pubished content ID.
527
529
  * @readonly
528
530
  */
529
531
  _id?: string | null;
530
- /** Schema key of the content. */
532
+ /** Schema key of the published content. */
531
533
  schemaKey?: SchemaKey$1;
532
534
  /**
533
- * Unique identifier that represents a specific entity under the schema key
535
+ * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
534
536
  * @readonly
535
537
  */
536
538
  entityId?: string;
537
539
  /**
538
- * Indicates the locale of this content
540
+ * Published content locale.
539
541
  * @readonly
540
542
  */
541
543
  locale?: string;
542
- /** List of fields localized in the given locale */
544
+ /** List of fields that have been translated and published for the given locale. */
543
545
  fields?: PublishedContentField[];
544
- /** Optional field for the ID of the parent of this entity. */
546
+ /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
545
547
  parentEntityId?: string | null;
548
+ /** Custom field data for the published content object. */
546
549
  extendedFields?: ExtendedFields;
547
550
  }
548
551
  interface SchemaKey$1 {
@@ -551,9 +554,14 @@ interface SchemaKey$1 {
551
554
  * @readonly
552
555
  */
553
556
  appId?: string;
554
- /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
557
+ /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
555
558
  entityType?: string;
556
- /** Scope schema is defined in (Global/Site) */
559
+ /**
560
+ * Scope of the translation schema.
561
+ * Supported values:
562
+ * + `GLOBAL`: A global schema for all sites.
563
+ * + `SITE`: A custom schema for a specific site.
564
+ */
557
565
  scope?: SchemaScope$1;
558
566
  }
559
567
  declare enum SchemaScope$1 {
@@ -575,11 +583,11 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
575
583
  /** Document media item */
576
584
  document?: string;
577
585
  /**
578
- * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
586
+ * Unique string identifier that links a specific content field to its corresponding field in the schema.
579
587
  * @readonly
580
588
  */
581
589
  schemaFieldKey?: string;
582
- /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
590
+ /** For repeated fields. Contains the IDs of the messages linked to this field. */
583
591
  sequenceIds?: string[];
584
592
  }
585
593
  /** @oneof */
@@ -1854,7 +1862,7 @@ interface GetPublishedContentResponse {
1854
1862
  publishedContent?: PublishedContent;
1855
1863
  }
1856
1864
  interface QueryPublishedContentRequest {
1857
- /** The query to filter the published content */
1865
+ /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
1858
1866
  query: CursorQuery$2;
1859
1867
  }
1860
1868
  interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
@@ -1908,9 +1916,9 @@ interface CursorPaging$2 {
1908
1916
  cursor?: string | null;
1909
1917
  }
1910
1918
  interface QueryPublishedContentResponse {
1911
- /** The published content */
1919
+ /** The published translation content. */
1912
1920
  publishedContent?: PublishedContent[];
1913
- /** Paging information */
1921
+ /** Details on the paged set of results returned. */
1914
1922
  pagingMetadata?: CursorPagingMetadata$2;
1915
1923
  }
1916
1924
  interface CursorPagingMetadata$2 {
@@ -40,26 +40,27 @@ declare namespace meta$5 {
40
40
  /** Represents a content of an entity with its published translations */
41
41
  interface PublishedContent$1 {
42
42
  /**
43
- * Content ID.
43
+ * Pubished content ID.
44
44
  * @readonly
45
45
  */
46
46
  id?: string | null;
47
- /** Schema key of the content. */
47
+ /** Schema key of the published content. */
48
48
  schemaKey?: SchemaKey$3;
49
49
  /**
50
- * Unique identifier that represents a specific entity under the schema key
50
+ * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
51
51
  * @readonly
52
52
  */
53
53
  entityId?: string;
54
54
  /**
55
- * Indicates the locale of this content
55
+ * Published content locale.
56
56
  * @readonly
57
57
  */
58
58
  locale?: string;
59
- /** List of fields localized in the given locale */
59
+ /** List of fields that have been translated and published for the given locale. */
60
60
  fields?: PublishedContentField$1[];
61
- /** Optional field for the ID of the parent of this entity. */
61
+ /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
62
62
  parentEntityId?: string | null;
63
+ /** Custom field data for the published content object. */
63
64
  extendedFields?: ExtendedFields$1;
64
65
  }
65
66
  interface SchemaKey$3 {
@@ -68,9 +69,14 @@ interface SchemaKey$3 {
68
69
  * @readonly
69
70
  */
70
71
  appId?: string;
71
- /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
72
+ /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
72
73
  entityType?: string;
73
- /** Scope schema is defined in (Global/Site) */
74
+ /**
75
+ * Scope of the translation schema.
76
+ * Supported values:
77
+ * + `GLOBAL`: A global schema for all sites.
78
+ * + `SITE`: A custom schema for a specific site.
79
+ */
74
80
  scope?: SchemaScope$3;
75
81
  }
76
82
  declare enum SchemaScope$3 {
@@ -92,11 +98,11 @@ interface PublishedContentField$1 extends PublishedContentFieldValueOneOf$1 {
92
98
  /** Document media item */
93
99
  document?: Document$1;
94
100
  /**
95
- * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
101
+ * Unique string identifier that links a specific content field to its corresponding field in the schema.
96
102
  * @readonly
97
103
  */
98
104
  schemaFieldKey?: string;
99
- /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
105
+ /** For repeated fields. Contains the IDs of the messages linked to this field. */
100
106
  sequenceIds?: string[];
101
107
  }
102
108
  /** @oneof */
@@ -1389,7 +1395,7 @@ interface ExtendedFields$1 {
1389
1395
  namespaces?: Record<string, Record<string, any>>;
1390
1396
  }
1391
1397
  interface QueryPublishedContentRequest$1 {
1392
- /** The query to filter the published content */
1398
+ /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
1393
1399
  query: CursorQuery$5;
1394
1400
  }
1395
1401
  interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
@@ -1443,9 +1449,9 @@ interface CursorPaging$5 {
1443
1449
  cursor?: string | null;
1444
1450
  }
1445
1451
  interface QueryPublishedContentResponse$1 {
1446
- /** The published content */
1452
+ /** The published translation content. */
1447
1453
  publishedContent?: PublishedContent$1[];
1448
- /** Paging information */
1454
+ /** Details on the paged set of results returned. */
1449
1455
  pagingMetadata?: CursorPagingMetadata$5;
1450
1456
  }
1451
1457
  interface CursorPagingMetadata$5 {
@@ -1760,26 +1766,27 @@ interface QueryPublishedContentResponseNonNullableFields$1 {
1760
1766
  /** Represents a content of an entity with its published translations */
1761
1767
  interface PublishedContent {
1762
1768
  /**
1763
- * Content ID.
1769
+ * Pubished content ID.
1764
1770
  * @readonly
1765
1771
  */
1766
1772
  _id?: string | null;
1767
- /** Schema key of the content. */
1773
+ /** Schema key of the published content. */
1768
1774
  schemaKey?: SchemaKey$2;
1769
1775
  /**
1770
- * Unique identifier that represents a specific entity under the schema key
1776
+ * A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`.
1771
1777
  * @readonly
1772
1778
  */
1773
1779
  entityId?: string;
1774
1780
  /**
1775
- * Indicates the locale of this content
1781
+ * Published content locale.
1776
1782
  * @readonly
1777
1783
  */
1778
1784
  locale?: string;
1779
- /** List of fields localized in the given locale */
1785
+ /** List of fields that have been translated and published for the given locale. */
1780
1786
  fields?: PublishedContentField[];
1781
- /** Optional field for the ID of the parent of this entity. */
1787
+ /** A reference to the parent content defined by the app developer. For example, if the content is a menu item, this property would link to the content of the menu it belongs to. */
1782
1788
  parentEntityId?: string | null;
1789
+ /** Custom field data for the published content object. */
1783
1790
  extendedFields?: ExtendedFields;
1784
1791
  }
1785
1792
  interface SchemaKey$2 {
@@ -1788,9 +1795,14 @@ interface SchemaKey$2 {
1788
1795
  * @readonly
1789
1796
  */
1790
1797
  appId?: string;
1791
- /** Unique name defined by the creator app, used to distinguish between different entities in the the app domain. */
1798
+ /** A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the `entityType` can be `'blog-posts'`. */
1792
1799
  entityType?: string;
1793
- /** Scope schema is defined in (Global/Site) */
1800
+ /**
1801
+ * Scope of the translation schema.
1802
+ * Supported values:
1803
+ * + `GLOBAL`: A global schema for all sites.
1804
+ * + `SITE`: A custom schema for a specific site.
1805
+ */
1794
1806
  scope?: SchemaScope$2;
1795
1807
  }
1796
1808
  declare enum SchemaScope$2 {
@@ -1812,11 +1824,11 @@ interface PublishedContentField extends PublishedContentFieldValueOneOf {
1812
1824
  /** Document media item */
1813
1825
  document?: string;
1814
1826
  /**
1815
- * The corresponding field key in the schema in a clean format (nothing between the parenthesis)
1827
+ * Unique string identifier that links a specific content field to its corresponding field in the schema.
1816
1828
  * @readonly
1817
1829
  */
1818
1830
  schemaFieldKey?: string;
1819
- /** In case of a repeated field, this will hold the IDs of the messages drilling down to this field. */
1831
+ /** For repeated fields. Contains the IDs of the messages linked to this field. */
1820
1832
  sequenceIds?: string[];
1821
1833
  }
1822
1834
  /** @oneof */
@@ -3054,7 +3066,7 @@ interface ExtendedFields {
3054
3066
  namespaces?: Record<string, Record<string, any>>;
3055
3067
  }
3056
3068
  interface QueryPublishedContentRequest {
3057
- /** The query to filter the published content */
3069
+ /** Query options. Note that some query filters are required. See the API description for a list of required filters. */
3058
3070
  query: CursorQuery$4;
3059
3071
  }
3060
3072
  interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
@@ -3108,9 +3120,9 @@ interface CursorPaging$4 {
3108
3120
  cursor?: string | null;
3109
3121
  }
3110
3122
  interface QueryPublishedContentResponse {
3111
- /** The published content */
3123
+ /** The published translation content. */
3112
3124
  publishedContent?: PublishedContent[];
3113
- /** Paging information */
3125
+ /** Details on the paged set of results returned. */
3114
3126
  pagingMetadata?: CursorPagingMetadata$4;
3115
3127
  }
3116
3128
  interface CursorPagingMetadata$4 {