@wix/data 1.0.175 → 1.0.177
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/data",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.177",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -22,8 +22,8 @@
|
|
|
22
22
|
"service-plugins"
|
|
23
23
|
],
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@wix/data_collections": "1.0.
|
|
26
|
-
"@wix/data_external-database": "1.0.
|
|
25
|
+
"@wix/data_collections": "1.0.63",
|
|
26
|
+
"@wix/data_external-database": "1.0.28",
|
|
27
27
|
"@wix/data_external-database-connections": "1.0.49",
|
|
28
28
|
"@wix/data_indexes": "1.0.44",
|
|
29
29
|
"@wix/data_items": "1.0.60"
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"fqdn": ""
|
|
52
52
|
}
|
|
53
53
|
},
|
|
54
|
-
"falconPackageHash": "
|
|
54
|
+
"falconPackageHash": "df9e931145e0b9111788204776f401b7f560f0fa75299cab02f07bb6"
|
|
55
55
|
}
|
|
@@ -1035,12 +1035,12 @@ interface DataCollection {
|
|
|
1035
1035
|
/** Collection ID. For example, `my-first-collection`. May include a namespace. */
|
|
1036
1036
|
_id?: string;
|
|
1037
1037
|
/**
|
|
1038
|
-
* Collection type. Indicates how the collection was created and is stored.
|
|
1038
|
+
* Collection type. Indicates how the collection was created and how it is stored.
|
|
1039
1039
|
* @readonly
|
|
1040
1040
|
*/
|
|
1041
1041
|
collectionType?: CollectionType;
|
|
1042
1042
|
/**
|
|
1043
|
-
* ID of the app that defined this collection. For
|
|
1043
|
+
* ID of the app that defined this collection. For collections defined by Wix users, this value is null.
|
|
1044
1044
|
* @readonly
|
|
1045
1045
|
*/
|
|
1046
1046
|
ownerAppId?: string | null;
|
|
@@ -1054,17 +1054,17 @@ interface DataCollection {
|
|
|
1054
1054
|
/** Collection's display name as shown in the CMS. For example, `My First Collection`. */
|
|
1055
1055
|
displayName?: string | null;
|
|
1056
1056
|
/**
|
|
1057
|
-
*
|
|
1057
|
+
* Default item sorting order when a query doesn't specify one.
|
|
1058
1058
|
* @readonly
|
|
1059
1059
|
*/
|
|
1060
1060
|
defaultDisplayOrder?: Sort;
|
|
1061
1061
|
/**
|
|
1062
1062
|
* UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
|
|
1063
|
-
* Empty for all data collections not owned by
|
|
1063
|
+
* Empty for all data collections not owned by Wix apps.
|
|
1064
1064
|
* @readonly
|
|
1065
1065
|
*/
|
|
1066
1066
|
displayNamespace?: string | null;
|
|
1067
|
-
/**
|
|
1067
|
+
/** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
|
|
1068
1068
|
displayField?: string | null;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* Capabilities the collection supports.
|
|
@@ -1076,14 +1076,14 @@ interface DataCollection {
|
|
|
1076
1076
|
/** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
|
|
1077
1077
|
permissions?: Permissions;
|
|
1078
1078
|
/**
|
|
1079
|
-
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must
|
|
1079
|
+
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
|
|
1080
1080
|
* @readonly
|
|
1081
1081
|
*/
|
|
1082
1082
|
revision?: string | null;
|
|
1083
|
-
/**
|
|
1083
|
+
/** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
|
|
1084
1084
|
plugins?: Plugin[];
|
|
1085
1085
|
/**
|
|
1086
|
-
*
|
|
1086
|
+
* Paging modes the collection supports. In native collections, offset-based paging is supported by default.
|
|
1087
1087
|
* @readonly
|
|
1088
1088
|
*/
|
|
1089
1089
|
pagingModes?: PagingMode[];
|
|
@@ -1123,7 +1123,11 @@ declare enum Direction {
|
|
|
1123
1123
|
DESC = "DESC"
|
|
1124
1124
|
}
|
|
1125
1125
|
interface CollectionCapabilities {
|
|
1126
|
-
/**
|
|
1126
|
+
/**
|
|
1127
|
+
* Data operations the collection supports. The listed operations can be performed on data the collection contains.
|
|
1128
|
+
*
|
|
1129
|
+
* > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
|
|
1130
|
+
*/
|
|
1127
1131
|
dataOperations?: DataOperation[];
|
|
1128
1132
|
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
1129
1133
|
collectionOperations?: CollectionOperation[];
|
|
@@ -1176,14 +1180,14 @@ interface Field$1 extends FieldRangeValidationsOneOf {
|
|
|
1176
1180
|
arraySizeRange?: ArraySizeRange;
|
|
1177
1181
|
/** Unique identifier for the field. For example, `firstName`. */
|
|
1178
1182
|
key?: string;
|
|
1179
|
-
/** Field's display name when
|
|
1183
|
+
/** Field's display name when displayed in the CMS. For example, `First Name`. */
|
|
1180
1184
|
displayName?: string | null;
|
|
1181
1185
|
/** Field's data type. */
|
|
1182
1186
|
type?: Type;
|
|
1183
1187
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
1184
1188
|
typeMetadata?: TypeMetadata;
|
|
1185
1189
|
/**
|
|
1186
|
-
* Whether the field is a system field
|
|
1190
|
+
* Whether the field is a system field.
|
|
1187
1191
|
* @readonly
|
|
1188
1192
|
*/
|
|
1189
1193
|
systemField?: boolean;
|
|
@@ -1192,11 +1196,10 @@ interface Field$1 extends FieldRangeValidationsOneOf {
|
|
|
1192
1196
|
* @readonly
|
|
1193
1197
|
*/
|
|
1194
1198
|
capabilities?: FieldCapabilities;
|
|
1195
|
-
/**
|
|
1199
|
+
/** Whether the field is encrypted. */
|
|
1196
1200
|
encrypted?: boolean;
|
|
1197
|
-
/**
|
|
1201
|
+
/** Field description. */
|
|
1198
1202
|
description?: string | null;
|
|
1199
|
-
plugin?: string | null;
|
|
1200
1203
|
/**
|
|
1201
1204
|
* Whether the field is read-only. A read-only field can't be changed.
|
|
1202
1205
|
*
|
|
@@ -1300,11 +1303,7 @@ interface FieldCapabilities {
|
|
|
1300
1303
|
* Default: `false`
|
|
1301
1304
|
*/
|
|
1302
1305
|
sortable?: boolean;
|
|
1303
|
-
/**
|
|
1304
|
-
* Query operators that can be used for this field.
|
|
1305
|
-
*
|
|
1306
|
-
* Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
|
|
1307
|
-
*/
|
|
1306
|
+
/** Query operators that can be used for this field. */
|
|
1308
1307
|
queryOperators?: QueryOperator[];
|
|
1309
1308
|
}
|
|
1310
1309
|
declare enum QueryOperator {
|
|
@@ -1619,9 +1618,9 @@ interface AllowedDataPermissions {
|
|
|
1619
1618
|
itemRemove?: boolean;
|
|
1620
1619
|
}
|
|
1621
1620
|
interface DataCollectionClonedEvent {
|
|
1622
|
-
/**
|
|
1621
|
+
/** Instance ID of the collection from which the data is cloned. */
|
|
1623
1622
|
originInstanceId?: string;
|
|
1624
|
-
/**
|
|
1623
|
+
/** ID of the collection from which the data is cloned. */
|
|
1625
1624
|
originId?: string;
|
|
1626
1625
|
}
|
|
1627
1626
|
interface DataCollectionChangedEvent {
|
|
@@ -2340,14 +2339,14 @@ interface UpdateDataCollectionSignature {
|
|
|
2340
2339
|
/**
|
|
2341
2340
|
* Updates a data collection.
|
|
2342
2341
|
*
|
|
2343
|
-
* A collection ID, revision number, permissions, and at least 1 field must be provided within `
|
|
2342
|
+
* A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
|
|
2344
2343
|
* If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
|
|
2345
2344
|
* Otherwise, the request fails.
|
|
2346
2345
|
*
|
|
2347
|
-
* When a collection is updated, its `
|
|
2346
|
+
* When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
|
|
2348
2347
|
*
|
|
2349
2348
|
* > **Note:**
|
|
2350
|
-
* > After a collection is updated, it only contains the properties included in the
|
|
2349
|
+
* > After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties
|
|
2351
2350
|
* > aren't included in the updated collection details, their values are lost.
|
|
2352
2351
|
* @param - Updated collection details. The existing collection is replaced with this version.
|
|
2353
2352
|
* @param - Options for updating a data collection.
|
|
@@ -1035,12 +1035,12 @@ interface DataCollection {
|
|
|
1035
1035
|
/** Collection ID. For example, `my-first-collection`. May include a namespace. */
|
|
1036
1036
|
_id?: string;
|
|
1037
1037
|
/**
|
|
1038
|
-
* Collection type. Indicates how the collection was created and is stored.
|
|
1038
|
+
* Collection type. Indicates how the collection was created and how it is stored.
|
|
1039
1039
|
* @readonly
|
|
1040
1040
|
*/
|
|
1041
1041
|
collectionType?: CollectionType;
|
|
1042
1042
|
/**
|
|
1043
|
-
* ID of the app that defined this collection. For
|
|
1043
|
+
* ID of the app that defined this collection. For collections defined by Wix users, this value is null.
|
|
1044
1044
|
* @readonly
|
|
1045
1045
|
*/
|
|
1046
1046
|
ownerAppId?: string | null;
|
|
@@ -1054,17 +1054,17 @@ interface DataCollection {
|
|
|
1054
1054
|
/** Collection's display name as shown in the CMS. For example, `My First Collection`. */
|
|
1055
1055
|
displayName?: string | null;
|
|
1056
1056
|
/**
|
|
1057
|
-
*
|
|
1057
|
+
* Default item sorting order when a query doesn't specify one.
|
|
1058
1058
|
* @readonly
|
|
1059
1059
|
*/
|
|
1060
1060
|
defaultDisplayOrder?: Sort;
|
|
1061
1061
|
/**
|
|
1062
1062
|
* UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
|
|
1063
|
-
* Empty for all data collections not owned by
|
|
1063
|
+
* Empty for all data collections not owned by Wix apps.
|
|
1064
1064
|
* @readonly
|
|
1065
1065
|
*/
|
|
1066
1066
|
displayNamespace?: string | null;
|
|
1067
|
-
/**
|
|
1067
|
+
/** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
|
|
1068
1068
|
displayField?: string | null;
|
|
1069
1069
|
/**
|
|
1070
1070
|
* Capabilities the collection supports.
|
|
@@ -1076,14 +1076,14 @@ interface DataCollection {
|
|
|
1076
1076
|
/** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
|
|
1077
1077
|
permissions?: Permissions;
|
|
1078
1078
|
/**
|
|
1079
|
-
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must
|
|
1079
|
+
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
|
|
1080
1080
|
* @readonly
|
|
1081
1081
|
*/
|
|
1082
1082
|
revision?: string | null;
|
|
1083
|
-
/**
|
|
1083
|
+
/** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
|
|
1084
1084
|
plugins?: Plugin[];
|
|
1085
1085
|
/**
|
|
1086
|
-
*
|
|
1086
|
+
* Paging modes the collection supports. In native collections, offset-based paging is supported by default.
|
|
1087
1087
|
* @readonly
|
|
1088
1088
|
*/
|
|
1089
1089
|
pagingModes?: PagingMode[];
|
|
@@ -1123,7 +1123,11 @@ declare enum Direction {
|
|
|
1123
1123
|
DESC = "DESC"
|
|
1124
1124
|
}
|
|
1125
1125
|
interface CollectionCapabilities {
|
|
1126
|
-
/**
|
|
1126
|
+
/**
|
|
1127
|
+
* Data operations the collection supports. The listed operations can be performed on data the collection contains.
|
|
1128
|
+
*
|
|
1129
|
+
* > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
|
|
1130
|
+
*/
|
|
1127
1131
|
dataOperations?: DataOperation[];
|
|
1128
1132
|
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
1129
1133
|
collectionOperations?: CollectionOperation[];
|
|
@@ -1176,14 +1180,14 @@ interface Field$1 extends FieldRangeValidationsOneOf {
|
|
|
1176
1180
|
arraySizeRange?: ArraySizeRange;
|
|
1177
1181
|
/** Unique identifier for the field. For example, `firstName`. */
|
|
1178
1182
|
key?: string;
|
|
1179
|
-
/** Field's display name when
|
|
1183
|
+
/** Field's display name when displayed in the CMS. For example, `First Name`. */
|
|
1180
1184
|
displayName?: string | null;
|
|
1181
1185
|
/** Field's data type. */
|
|
1182
1186
|
type?: Type;
|
|
1183
1187
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
1184
1188
|
typeMetadata?: TypeMetadata;
|
|
1185
1189
|
/**
|
|
1186
|
-
* Whether the field is a system field
|
|
1190
|
+
* Whether the field is a system field.
|
|
1187
1191
|
* @readonly
|
|
1188
1192
|
*/
|
|
1189
1193
|
systemField?: boolean;
|
|
@@ -1192,11 +1196,10 @@ interface Field$1 extends FieldRangeValidationsOneOf {
|
|
|
1192
1196
|
* @readonly
|
|
1193
1197
|
*/
|
|
1194
1198
|
capabilities?: FieldCapabilities;
|
|
1195
|
-
/**
|
|
1199
|
+
/** Whether the field is encrypted. */
|
|
1196
1200
|
encrypted?: boolean;
|
|
1197
|
-
/**
|
|
1201
|
+
/** Field description. */
|
|
1198
1202
|
description?: string | null;
|
|
1199
|
-
plugin?: string | null;
|
|
1200
1203
|
/**
|
|
1201
1204
|
* Whether the field is read-only. A read-only field can't be changed.
|
|
1202
1205
|
*
|
|
@@ -1300,11 +1303,7 @@ interface FieldCapabilities {
|
|
|
1300
1303
|
* Default: `false`
|
|
1301
1304
|
*/
|
|
1302
1305
|
sortable?: boolean;
|
|
1303
|
-
/**
|
|
1304
|
-
* Query operators that can be used for this field.
|
|
1305
|
-
*
|
|
1306
|
-
* Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
|
|
1307
|
-
*/
|
|
1306
|
+
/** Query operators that can be used for this field. */
|
|
1308
1307
|
queryOperators?: QueryOperator[];
|
|
1309
1308
|
}
|
|
1310
1309
|
declare enum QueryOperator {
|
|
@@ -1619,9 +1618,9 @@ interface AllowedDataPermissions {
|
|
|
1619
1618
|
itemRemove?: boolean;
|
|
1620
1619
|
}
|
|
1621
1620
|
interface DataCollectionClonedEvent {
|
|
1622
|
-
/**
|
|
1621
|
+
/** Instance ID of the collection from which the data is cloned. */
|
|
1623
1622
|
originInstanceId?: string;
|
|
1624
|
-
/**
|
|
1623
|
+
/** ID of the collection from which the data is cloned. */
|
|
1625
1624
|
originId?: string;
|
|
1626
1625
|
}
|
|
1627
1626
|
interface DataCollectionChangedEvent {
|
|
@@ -2340,14 +2339,14 @@ interface UpdateDataCollectionSignature {
|
|
|
2340
2339
|
/**
|
|
2341
2340
|
* Updates a data collection.
|
|
2342
2341
|
*
|
|
2343
|
-
* A collection ID, revision number, permissions, and at least 1 field must be provided within `
|
|
2342
|
+
* A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
|
|
2344
2343
|
* If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
|
|
2345
2344
|
* Otherwise, the request fails.
|
|
2346
2345
|
*
|
|
2347
|
-
* When a collection is updated, its `
|
|
2346
|
+
* When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
|
|
2348
2347
|
*
|
|
2349
2348
|
* > **Note:**
|
|
2350
|
-
* > After a collection is updated, it only contains the properties included in the
|
|
2349
|
+
* > After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties
|
|
2351
2350
|
* > aren't included in the updated collection details, their values are lost.
|
|
2352
2351
|
* @param - Updated collection details. The existing collection is replaced with this version.
|
|
2353
2352
|
* @param - Options for updating a data collection.
|
|
@@ -478,12 +478,12 @@ interface DataCollection$1 {
|
|
|
478
478
|
/** Collection ID. For example, `my-first-collection`. May include a namespace. */
|
|
479
479
|
id?: string;
|
|
480
480
|
/**
|
|
481
|
-
* Collection type. Indicates how the collection was created and is stored.
|
|
481
|
+
* Collection type. Indicates how the collection was created and how it is stored.
|
|
482
482
|
* @readonly
|
|
483
483
|
*/
|
|
484
484
|
collectionType?: CollectionType$1;
|
|
485
485
|
/**
|
|
486
|
-
* ID of the app that defined this collection. For
|
|
486
|
+
* ID of the app that defined this collection. For collections defined by Wix users, this value is null.
|
|
487
487
|
* @readonly
|
|
488
488
|
*/
|
|
489
489
|
ownerAppId?: string | null;
|
|
@@ -497,17 +497,17 @@ interface DataCollection$1 {
|
|
|
497
497
|
/** Collection's display name as shown in the CMS. For example, `My First Collection`. */
|
|
498
498
|
displayName?: string | null;
|
|
499
499
|
/**
|
|
500
|
-
*
|
|
500
|
+
* Default item sorting order when a query doesn't specify one.
|
|
501
501
|
* @readonly
|
|
502
502
|
*/
|
|
503
503
|
defaultDisplayOrder?: Sort$1;
|
|
504
504
|
/**
|
|
505
505
|
* UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
|
|
506
|
-
* Empty for all data collections not owned by
|
|
506
|
+
* Empty for all data collections not owned by Wix apps.
|
|
507
507
|
* @readonly
|
|
508
508
|
*/
|
|
509
509
|
displayNamespace?: string | null;
|
|
510
|
-
/**
|
|
510
|
+
/** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
|
|
511
511
|
displayField?: string | null;
|
|
512
512
|
/**
|
|
513
513
|
* Capabilities the collection supports.
|
|
@@ -519,14 +519,14 @@ interface DataCollection$1 {
|
|
|
519
519
|
/** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
|
|
520
520
|
permissions?: Permissions$1;
|
|
521
521
|
/**
|
|
522
|
-
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must
|
|
522
|
+
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
|
|
523
523
|
* @readonly
|
|
524
524
|
*/
|
|
525
525
|
revision?: string | null;
|
|
526
|
-
/**
|
|
526
|
+
/** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
|
|
527
527
|
plugins?: Plugin$1[];
|
|
528
528
|
/**
|
|
529
|
-
*
|
|
529
|
+
* Paging modes the collection supports. In native collections, offset-based paging is supported by default.
|
|
530
530
|
* @readonly
|
|
531
531
|
*/
|
|
532
532
|
pagingModes?: PagingMode$1[];
|
|
@@ -623,14 +623,14 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
|
|
|
623
623
|
arraySizeRange?: ArraySizeRange$1;
|
|
624
624
|
/** Unique identifier for the field. For example, `firstName`. */
|
|
625
625
|
key?: string;
|
|
626
|
-
/** Field's display name when
|
|
626
|
+
/** Field's display name when displayed in the CMS. For example, `First Name`. */
|
|
627
627
|
displayName?: string | null;
|
|
628
628
|
/** Field's data type. */
|
|
629
629
|
type?: Type$1;
|
|
630
630
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
631
631
|
typeMetadata?: TypeMetadata$1;
|
|
632
632
|
/**
|
|
633
|
-
* Whether the field is a system field
|
|
633
|
+
* Whether the field is a system field.
|
|
634
634
|
* @readonly
|
|
635
635
|
*/
|
|
636
636
|
systemField?: boolean;
|
|
@@ -639,11 +639,10 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
|
|
|
639
639
|
* @readonly
|
|
640
640
|
*/
|
|
641
641
|
capabilities?: FieldCapabilities$1;
|
|
642
|
-
/**
|
|
642
|
+
/** Whether the field is encrypted. */
|
|
643
643
|
encrypted?: boolean;
|
|
644
|
-
/**
|
|
644
|
+
/** Field description. */
|
|
645
645
|
description?: string | null;
|
|
646
|
-
plugin?: string | null;
|
|
647
646
|
/**
|
|
648
647
|
* Whether the field is read-only. A read-only field can't be changed.
|
|
649
648
|
*
|
|
@@ -1299,12 +1298,12 @@ interface DataCollection {
|
|
|
1299
1298
|
/** Collection ID. For example, `my-first-collection`. May include a namespace. */
|
|
1300
1299
|
_id?: string;
|
|
1301
1300
|
/**
|
|
1302
|
-
* Collection type. Indicates how the collection was created and is stored.
|
|
1301
|
+
* Collection type. Indicates how the collection was created and how it is stored.
|
|
1303
1302
|
* @readonly
|
|
1304
1303
|
*/
|
|
1305
1304
|
collectionType?: CollectionType;
|
|
1306
1305
|
/**
|
|
1307
|
-
* ID of the app that defined this collection. For
|
|
1306
|
+
* ID of the app that defined this collection. For collections defined by Wix users, this value is null.
|
|
1308
1307
|
* @readonly
|
|
1309
1308
|
*/
|
|
1310
1309
|
ownerAppId?: string | null;
|
|
@@ -1318,17 +1317,17 @@ interface DataCollection {
|
|
|
1318
1317
|
/** Collection's display name as shown in the CMS. For example, `My First Collection`. */
|
|
1319
1318
|
displayName?: string | null;
|
|
1320
1319
|
/**
|
|
1321
|
-
*
|
|
1320
|
+
* Default item sorting order when a query doesn't specify one.
|
|
1322
1321
|
* @readonly
|
|
1323
1322
|
*/
|
|
1324
1323
|
defaultDisplayOrder?: Sort;
|
|
1325
1324
|
/**
|
|
1326
1325
|
* UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
|
|
1327
|
-
* Empty for all data collections not owned by
|
|
1326
|
+
* Empty for all data collections not owned by Wix apps.
|
|
1328
1327
|
* @readonly
|
|
1329
1328
|
*/
|
|
1330
1329
|
displayNamespace?: string | null;
|
|
1331
|
-
/**
|
|
1330
|
+
/** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
|
|
1332
1331
|
displayField?: string | null;
|
|
1333
1332
|
/**
|
|
1334
1333
|
* Capabilities the collection supports.
|
|
@@ -1340,14 +1339,14 @@ interface DataCollection {
|
|
|
1340
1339
|
/** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
|
|
1341
1340
|
permissions?: Permissions;
|
|
1342
1341
|
/**
|
|
1343
|
-
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must
|
|
1342
|
+
* Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
|
|
1344
1343
|
* @readonly
|
|
1345
1344
|
*/
|
|
1346
1345
|
revision?: string | null;
|
|
1347
|
-
/**
|
|
1346
|
+
/** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
|
|
1348
1347
|
plugins?: Plugin[];
|
|
1349
1348
|
/**
|
|
1350
|
-
*
|
|
1349
|
+
* Paging modes the collection supports. In native collections, offset-based paging is supported by default.
|
|
1351
1350
|
* @readonly
|
|
1352
1351
|
*/
|
|
1353
1352
|
pagingModes?: PagingMode[];
|
|
@@ -1387,7 +1386,11 @@ declare enum Direction {
|
|
|
1387
1386
|
DESC = "DESC"
|
|
1388
1387
|
}
|
|
1389
1388
|
interface CollectionCapabilities {
|
|
1390
|
-
/**
|
|
1389
|
+
/**
|
|
1390
|
+
* Data operations the collection supports. The listed operations can be performed on data the collection contains.
|
|
1391
|
+
*
|
|
1392
|
+
* > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
|
|
1393
|
+
*/
|
|
1391
1394
|
dataOperations?: DataOperation[];
|
|
1392
1395
|
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
1393
1396
|
collectionOperations?: CollectionOperation[];
|
|
@@ -1440,14 +1443,14 @@ interface Field$2 extends FieldRangeValidationsOneOf {
|
|
|
1440
1443
|
arraySizeRange?: ArraySizeRange;
|
|
1441
1444
|
/** Unique identifier for the field. For example, `firstName`. */
|
|
1442
1445
|
key?: string;
|
|
1443
|
-
/** Field's display name when
|
|
1446
|
+
/** Field's display name when displayed in the CMS. For example, `First Name`. */
|
|
1444
1447
|
displayName?: string | null;
|
|
1445
1448
|
/** Field's data type. */
|
|
1446
1449
|
type?: Type;
|
|
1447
1450
|
/** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
|
|
1448
1451
|
typeMetadata?: TypeMetadata;
|
|
1449
1452
|
/**
|
|
1450
|
-
* Whether the field is a system field
|
|
1453
|
+
* Whether the field is a system field.
|
|
1451
1454
|
* @readonly
|
|
1452
1455
|
*/
|
|
1453
1456
|
systemField?: boolean;
|
|
@@ -1456,11 +1459,10 @@ interface Field$2 extends FieldRangeValidationsOneOf {
|
|
|
1456
1459
|
* @readonly
|
|
1457
1460
|
*/
|
|
1458
1461
|
capabilities?: FieldCapabilities;
|
|
1459
|
-
/**
|
|
1462
|
+
/** Whether the field is encrypted. */
|
|
1460
1463
|
encrypted?: boolean;
|
|
1461
|
-
/**
|
|
1464
|
+
/** Field description. */
|
|
1462
1465
|
description?: string | null;
|
|
1463
|
-
plugin?: string | null;
|
|
1464
1466
|
/**
|
|
1465
1467
|
* Whether the field is read-only. A read-only field can't be changed.
|
|
1466
1468
|
*
|
|
@@ -1564,11 +1566,7 @@ interface FieldCapabilities {
|
|
|
1564
1566
|
* Default: `false`
|
|
1565
1567
|
*/
|
|
1566
1568
|
sortable?: boolean;
|
|
1567
|
-
/**
|
|
1568
|
-
* Query operators that can be used for this field.
|
|
1569
|
-
*
|
|
1570
|
-
* Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
|
|
1571
|
-
*/
|
|
1569
|
+
/** Query operators that can be used for this field. */
|
|
1572
1570
|
queryOperators?: QueryOperator[];
|
|
1573
1571
|
}
|
|
1574
1572
|
declare enum QueryOperator {
|
|
@@ -847,7 +847,7 @@ declare class ItemAlreadyExistsWixError extends Error {
|
|
|
847
847
|
/** @hidden */
|
|
848
848
|
spiErrorData: object;
|
|
849
849
|
data: ItemAlreadyExistsError;
|
|
850
|
-
constructor(data
|
|
850
|
+
constructor(data?: ItemAlreadyExistsError);
|
|
851
851
|
/** @hidden */
|
|
852
852
|
static readonly __type = "wix_spi_error";
|
|
853
853
|
}
|
|
@@ -867,7 +867,7 @@ declare class ItemNotFoundWixError extends Error {
|
|
|
867
867
|
/** @hidden */
|
|
868
868
|
spiErrorData: object;
|
|
869
869
|
data: ItemNotFoundError;
|
|
870
|
-
constructor(data
|
|
870
|
+
constructor(data?: ItemNotFoundError);
|
|
871
871
|
/** @hidden */
|
|
872
872
|
static readonly __type = "wix_spi_error";
|
|
873
873
|
}
|
|
@@ -887,7 +887,7 @@ declare class CollectionAlreadyExistsWixError extends Error {
|
|
|
887
887
|
/** @hidden */
|
|
888
888
|
spiErrorData: object;
|
|
889
889
|
data: CollectionAlreadyExistsError;
|
|
890
|
-
constructor(data
|
|
890
|
+
constructor(data?: CollectionAlreadyExistsError);
|
|
891
891
|
/** @hidden */
|
|
892
892
|
static readonly __type = "wix_spi_error";
|
|
893
893
|
}
|
|
@@ -907,7 +907,7 @@ declare class CollectionNotFoundWixError extends Error {
|
|
|
907
907
|
/** @hidden */
|
|
908
908
|
spiErrorData: object;
|
|
909
909
|
data: CollectionNotFoundError;
|
|
910
|
-
constructor(data
|
|
910
|
+
constructor(data?: CollectionNotFoundError);
|
|
911
911
|
/** @hidden */
|
|
912
912
|
static readonly __type = "wix_spi_error";
|
|
913
913
|
}
|
|
@@ -927,7 +927,7 @@ declare class ReferenceAlreadyExistsWixError extends Error {
|
|
|
927
927
|
/** @hidden */
|
|
928
928
|
spiErrorData: object;
|
|
929
929
|
data: ReferenceAlreadyExistsError;
|
|
930
|
-
constructor(data
|
|
930
|
+
constructor(data?: ReferenceAlreadyExistsError);
|
|
931
931
|
/** @hidden */
|
|
932
932
|
static readonly __type = "wix_spi_error";
|
|
933
933
|
}
|
|
@@ -947,7 +947,7 @@ declare class ReferenceNotFoundWixError extends Error {
|
|
|
947
947
|
/** @hidden */
|
|
948
948
|
spiErrorData: object;
|
|
949
949
|
data: ReferenceNotFoundError;
|
|
950
|
-
constructor(data
|
|
950
|
+
constructor(data?: ReferenceNotFoundError);
|
|
951
951
|
/** @hidden */
|
|
952
952
|
static readonly __type = "wix_spi_error";
|
|
953
953
|
}
|
|
@@ -967,7 +967,7 @@ declare class ValidationWixError extends Error {
|
|
|
967
967
|
/** @hidden */
|
|
968
968
|
spiErrorData: object;
|
|
969
969
|
data: ValidationError;
|
|
970
|
-
constructor(data
|
|
970
|
+
constructor(data?: ValidationError);
|
|
971
971
|
/** @hidden */
|
|
972
972
|
static readonly __type = "wix_spi_error";
|
|
973
973
|
}
|
|
@@ -987,7 +987,7 @@ declare class CollectionChangeNotSupportedWixError extends Error {
|
|
|
987
987
|
/** @hidden */
|
|
988
988
|
spiErrorData: object;
|
|
989
989
|
data: CollectionChangeNotSupported;
|
|
990
|
-
constructor(data
|
|
990
|
+
constructor(data?: CollectionChangeNotSupported);
|
|
991
991
|
/** @hidden */
|
|
992
992
|
static readonly __type = "wix_spi_error";
|
|
993
993
|
}
|
|
@@ -1027,7 +1027,7 @@ declare class ItemAlreadyExistsWixError extends Error {
|
|
|
1027
1027
|
/** @hidden */
|
|
1028
1028
|
spiErrorData: object;
|
|
1029
1029
|
data: ItemAlreadyExistsError;
|
|
1030
|
-
constructor(data
|
|
1030
|
+
constructor(data?: ItemAlreadyExistsError);
|
|
1031
1031
|
/** @hidden */
|
|
1032
1032
|
static readonly __type = "wix_spi_error";
|
|
1033
1033
|
}
|
|
@@ -1047,7 +1047,7 @@ declare class ItemNotFoundWixError extends Error {
|
|
|
1047
1047
|
/** @hidden */
|
|
1048
1048
|
spiErrorData: object;
|
|
1049
1049
|
data: ItemNotFoundError;
|
|
1050
|
-
constructor(data
|
|
1050
|
+
constructor(data?: ItemNotFoundError);
|
|
1051
1051
|
/** @hidden */
|
|
1052
1052
|
static readonly __type = "wix_spi_error";
|
|
1053
1053
|
}
|
|
@@ -1067,7 +1067,7 @@ declare class CollectionAlreadyExistsWixError extends Error {
|
|
|
1067
1067
|
/** @hidden */
|
|
1068
1068
|
spiErrorData: object;
|
|
1069
1069
|
data: CollectionAlreadyExistsError;
|
|
1070
|
-
constructor(data
|
|
1070
|
+
constructor(data?: CollectionAlreadyExistsError);
|
|
1071
1071
|
/** @hidden */
|
|
1072
1072
|
static readonly __type = "wix_spi_error";
|
|
1073
1073
|
}
|
|
@@ -1087,7 +1087,7 @@ declare class CollectionNotFoundWixError extends Error {
|
|
|
1087
1087
|
/** @hidden */
|
|
1088
1088
|
spiErrorData: object;
|
|
1089
1089
|
data: CollectionNotFoundError;
|
|
1090
|
-
constructor(data
|
|
1090
|
+
constructor(data?: CollectionNotFoundError);
|
|
1091
1091
|
/** @hidden */
|
|
1092
1092
|
static readonly __type = "wix_spi_error";
|
|
1093
1093
|
}
|
|
@@ -1107,7 +1107,7 @@ declare class ReferenceAlreadyExistsWixError extends Error {
|
|
|
1107
1107
|
/** @hidden */
|
|
1108
1108
|
spiErrorData: object;
|
|
1109
1109
|
data: ReferenceAlreadyExistsError;
|
|
1110
|
-
constructor(data
|
|
1110
|
+
constructor(data?: ReferenceAlreadyExistsError);
|
|
1111
1111
|
/** @hidden */
|
|
1112
1112
|
static readonly __type = "wix_spi_error";
|
|
1113
1113
|
}
|
|
@@ -1127,7 +1127,7 @@ declare class ReferenceNotFoundWixError extends Error {
|
|
|
1127
1127
|
/** @hidden */
|
|
1128
1128
|
spiErrorData: object;
|
|
1129
1129
|
data: ReferenceNotFoundError;
|
|
1130
|
-
constructor(data
|
|
1130
|
+
constructor(data?: ReferenceNotFoundError);
|
|
1131
1131
|
/** @hidden */
|
|
1132
1132
|
static readonly __type = "wix_spi_error";
|
|
1133
1133
|
}
|
|
@@ -1147,7 +1147,7 @@ declare class ValidationWixError extends Error {
|
|
|
1147
1147
|
/** @hidden */
|
|
1148
1148
|
spiErrorData: object;
|
|
1149
1149
|
data: ValidationError;
|
|
1150
|
-
constructor(data
|
|
1150
|
+
constructor(data?: ValidationError);
|
|
1151
1151
|
/** @hidden */
|
|
1152
1152
|
static readonly __type = "wix_spi_error";
|
|
1153
1153
|
}
|
|
@@ -1167,7 +1167,7 @@ declare class CollectionChangeNotSupportedWixError extends Error {
|
|
|
1167
1167
|
/** @hidden */
|
|
1168
1168
|
spiErrorData: object;
|
|
1169
1169
|
data: CollectionChangeNotSupported;
|
|
1170
|
-
constructor(data
|
|
1170
|
+
constructor(data?: CollectionChangeNotSupported);
|
|
1171
1171
|
/** @hidden */
|
|
1172
1172
|
static readonly __type = "wix_spi_error";
|
|
1173
1173
|
}
|