@wix/data 1.0.168 → 1.0.170
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/context.js +1 -0
- package/build/cjs/context.js.map +1 -0
- package/build/cjs/index.js +1 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/meta.js +1 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/service-plugins-context.js +1 -0
- package/build/cjs/service-plugins-context.js.map +1 -0
- package/build/cjs/service-plugins.js +1 -0
- package/build/cjs/service-plugins.js.map +1 -0
- package/build/es/context.js +1 -0
- package/build/es/context.js.map +1 -0
- package/build/es/index.js +1 -0
- package/build/es/index.js.map +1 -0
- package/build/es/meta.js +1 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/service-plugins-context.js +1 -0
- package/build/es/service-plugins-context.js.map +1 -0
- package/build/es/service-plugins.js +1 -0
- package/build/es/service-plugins.js.map +1 -0
- package/package.json +10 -7
- package/type-bundles/context.bundle.d.ts +22 -55
- package/type-bundles/index.bundle.d.ts +22 -55
- package/type-bundles/meta.bundle.d.ts +44 -98
package/build/cjs/context.js
CHANGED
|
@@ -28,3 +28,4 @@ exports.externalDatabaseConnections = __importStar(require("@wix/data_external-d
|
|
|
28
28
|
exports.collections = __importStar(require("@wix/data_collections/context"));
|
|
29
29
|
exports.items = __importStar(require("@wix/data_items/context"));
|
|
30
30
|
exports.indexes = __importStar(require("@wix/data_indexes/context"));
|
|
31
|
+
//# sourceMappingURL=context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+GAA+F;AAC/F,6EAA6D;AAC7D,iEAAiD;AACjD,qEAAqD"}
|
package/build/cjs/index.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qGAAuF;AAK9E,kEAA2B;AAJpC,mEAAqD;AAIf,kCAAW;AAHjD,uDAAyC;AAGU,sBAAK;AAFxD,2DAA6C;AAEa,0BAAO"}
|
package/build/cjs/meta.js
CHANGED
|
@@ -28,3 +28,4 @@ exports.externalDatabaseConnections = __importStar(require("@wix/data_external-d
|
|
|
28
28
|
exports.collections = __importStar(require("@wix/data_collections/meta"));
|
|
29
29
|
exports.items = __importStar(require("@wix/data_items/meta"));
|
|
30
30
|
exports.indexes = __importStar(require("@wix/data_indexes/meta"));
|
|
31
|
+
//# sourceMappingURL=meta.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4GAA4F;AAC5F,0EAA0D;AAC1D,8DAA8C;AAC9C,kEAAkD"}
|
|
@@ -25,3 +25,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
26
|
exports.externalDatabase = void 0;
|
|
27
27
|
exports.externalDatabase = __importStar(require("@wix/data_external-database/context"));
|
|
28
|
+
//# sourceMappingURL=service-plugins-context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wFAAwE"}
|
|
@@ -25,3 +25,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
26
|
exports.externalDatabase = void 0;
|
|
27
27
|
exports.externalDatabase = __importStar(require("@wix/data_external-database"));
|
|
28
|
+
//# sourceMappingURL=service-plugins.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gFAAgE"}
|
package/build/es/context.js
CHANGED
|
@@ -2,3 +2,4 @@ export * as externalDatabaseConnections from '@wix/data_external-database-connec
|
|
|
2
2
|
export * as collections from '@wix/data_collections/context';
|
|
3
3
|
export * as items from '@wix/data_items/context';
|
|
4
4
|
export * as indexes from '@wix/data_indexes/context';
|
|
5
|
+
//# sourceMappingURL=context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"context.js","sourceRoot":"","sources":["../../context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,2BAA2B,MAAM,iDAAiD,CAAC;AAC/F,OAAO,KAAK,WAAW,MAAM,+BAA+B,CAAC;AAC7D,OAAO,KAAK,KAAK,MAAM,yBAAyB,CAAC;AACjD,OAAO,KAAK,OAAO,MAAM,2BAA2B,CAAC"}
|
package/build/es/index.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,2BAA2B,MAAM,yCAAyC,CAAC;AACvF,OAAO,KAAK,WAAW,MAAM,uBAAuB,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,iBAAiB,CAAC;AACzC,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,2BAA2B,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC"}
|
package/build/es/meta.js
CHANGED
|
@@ -2,3 +2,4 @@ export * as externalDatabaseConnections from '@wix/data_external-database-connec
|
|
|
2
2
|
export * as collections from '@wix/data_collections/meta';
|
|
3
3
|
export * as items from '@wix/data_items/meta';
|
|
4
4
|
export * as indexes from '@wix/data_indexes/meta';
|
|
5
|
+
//# sourceMappingURL=meta.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,2BAA2B,MAAM,8CAA8C,CAAC;AAC5F,OAAO,KAAK,WAAW,MAAM,4BAA4B,CAAC;AAC1D,OAAO,KAAK,KAAK,MAAM,sBAAsB,CAAC;AAC9C,OAAO,KAAK,OAAO,MAAM,wBAAwB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service-plugins-context.js","sourceRoot":"","sources":["../../service-plugins-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,qCAAqC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"service-plugins.js","sourceRoot":"","sources":["../../service-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,6BAA6B,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/data",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.170",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
8
|
+
"keywords": [
|
|
9
|
+
"wix-sdk-module=backend,page,public"
|
|
10
|
+
],
|
|
8
11
|
"sideEffects": false,
|
|
9
12
|
"module": "build/es/index.js",
|
|
10
13
|
"main": "build/cjs/index.js",
|
|
@@ -19,11 +22,11 @@
|
|
|
19
22
|
"service-plugins"
|
|
20
23
|
],
|
|
21
24
|
"dependencies": {
|
|
22
|
-
"@wix/data_collections": "1.0.
|
|
23
|
-
"@wix/data_external-database": "1.0.
|
|
24
|
-
"@wix/data_external-database-connections": "1.0.
|
|
25
|
-
"@wix/data_indexes": "1.0.
|
|
26
|
-
"@wix/data_items": "1.0.
|
|
25
|
+
"@wix/data_collections": "1.0.59",
|
|
26
|
+
"@wix/data_external-database": "1.0.26",
|
|
27
|
+
"@wix/data_external-database-connections": "1.0.48",
|
|
28
|
+
"@wix/data_indexes": "1.0.42",
|
|
29
|
+
"@wix/data_items": "1.0.59"
|
|
27
30
|
},
|
|
28
31
|
"devDependencies": {
|
|
29
32
|
"glob": "^10.4.1",
|
|
@@ -48,5 +51,5 @@
|
|
|
48
51
|
"fqdn": ""
|
|
49
52
|
}
|
|
50
53
|
},
|
|
51
|
-
"falconPackageHash": "
|
|
54
|
+
"falconPackageHash": "e130d4536874f6a357a42bc68fd95fae1b6c5cb6c13a193825c1eeb1"
|
|
52
55
|
}
|
|
@@ -1036,11 +1036,6 @@ interface DataCollection {
|
|
|
1036
1036
|
_id?: string;
|
|
1037
1037
|
/**
|
|
1038
1038
|
* Collection type. Indicates how the collection was created and is stored.
|
|
1039
|
-
*
|
|
1040
|
-
* * `NATIVE`: User-created collection.
|
|
1041
|
-
* * `WIX_APP`: [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.
|
|
1042
|
-
* * `BLOCKS_APP`: Collection created by a Wix Blocks app.
|
|
1043
|
-
* * `EXTERNAL`: Collection located in externally connected storage.
|
|
1044
1039
|
* @readonly
|
|
1045
1040
|
*/
|
|
1046
1041
|
collectionType?: CollectionType;
|
|
@@ -1130,11 +1125,7 @@ declare enum Direction {
|
|
|
1130
1125
|
interface CollectionCapabilities {
|
|
1131
1126
|
/** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
|
|
1132
1127
|
dataOperations?: DataOperation[];
|
|
1133
|
-
/**
|
|
1134
|
-
* Collection operations supported. The listed operations can be performed on the collection itself.
|
|
1135
|
-
* + `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.
|
|
1136
|
-
* + `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted.
|
|
1137
|
-
*/
|
|
1128
|
+
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
1138
1129
|
collectionOperations?: CollectionOperation[];
|
|
1139
1130
|
/** Maximum number of indexes for the collection. */
|
|
1140
1131
|
indexLimits?: IndexLimits;
|
|
@@ -1163,9 +1154,9 @@ declare enum DataOperation {
|
|
|
1163
1154
|
BULK_PATCH = "BULK_PATCH"
|
|
1164
1155
|
}
|
|
1165
1156
|
declare enum CollectionOperation {
|
|
1166
|
-
/**
|
|
1157
|
+
/** Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed. */
|
|
1167
1158
|
UPDATE = "UPDATE",
|
|
1168
|
-
/**
|
|
1159
|
+
/** Allows deleting the entire collection. If not included, the collection can't be deleted. */
|
|
1169
1160
|
REMOVE = "REMOVE"
|
|
1170
1161
|
}
|
|
1171
1162
|
interface IndexLimits {
|
|
@@ -1447,6 +1438,7 @@ interface FieldPluginOptionsOneOf {
|
|
|
1447
1438
|
cmsOptions?: CmsOptions;
|
|
1448
1439
|
}
|
|
1449
1440
|
declare enum FieldPluginType {
|
|
1441
|
+
/** Uknown plugin type. */
|
|
1450
1442
|
UNKNOWN = "UNKNOWN",
|
|
1451
1443
|
/** CMS-related field attributes */
|
|
1452
1444
|
CMS = "CMS"
|
|
@@ -1472,7 +1464,7 @@ interface Permissions {
|
|
|
1472
1464
|
read?: Role;
|
|
1473
1465
|
}
|
|
1474
1466
|
declare enum Role {
|
|
1475
|
-
/** Unknown. */
|
|
1467
|
+
/** Unknown role. */
|
|
1476
1468
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
1477
1469
|
/** Site administrator. */
|
|
1478
1470
|
ADMIN = "ADMIN",
|
|
@@ -1499,15 +1491,7 @@ interface Plugin extends PluginOptionsOneOf {
|
|
|
1499
1491
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
1500
1492
|
/** Options for the CMS plugin. */
|
|
1501
1493
|
cmsOptions?: PluginCmsOptions;
|
|
1502
|
-
/**
|
|
1503
|
-
* Plugin types. The following plugins are supported:
|
|
1504
|
-
*
|
|
1505
|
-
* * `PUBLISH`: Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors.
|
|
1506
|
-
* * `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.
|
|
1507
|
-
* * `URLIZED`: Generates item URLs for collections used by dynamic pages.
|
|
1508
|
-
* * `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
|
|
1509
|
-
* * `CMS`: Contains CMS-related collection attributes
|
|
1510
|
-
*/
|
|
1494
|
+
/** Plugin types. */
|
|
1511
1495
|
type?: PluginType;
|
|
1512
1496
|
}
|
|
1513
1497
|
/** @oneof */
|
|
@@ -1535,7 +1519,9 @@ declare enum Status$1 {
|
|
|
1535
1519
|
}
|
|
1536
1520
|
declare enum Format {
|
|
1537
1521
|
UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
|
|
1522
|
+
/** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
|
|
1538
1523
|
ORIGINAL = "ORIGINAL",
|
|
1524
|
+
/** No changes are made before generating the encoded URL. */
|
|
1539
1525
|
PLAIN = "PLAIN"
|
|
1540
1526
|
}
|
|
1541
1527
|
/** if CMS-defined sort is enabled and should be used in site */
|
|
@@ -1556,11 +1542,11 @@ declare enum PluginType {
|
|
|
1556
1542
|
GRIDAPPLESS = "GRIDAPPLESS",
|
|
1557
1543
|
/** Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). */
|
|
1558
1544
|
MULTILINGUAL = "MULTILINGUAL",
|
|
1559
|
-
/** Indicates that collection is shared with current site */
|
|
1545
|
+
/** Indicates that collection is shared with current site. */
|
|
1560
1546
|
SHARED = "SHARED",
|
|
1561
|
-
/** Indicates that page link fields are persisted and can be updated */
|
|
1547
|
+
/** Indicates that page link fields are persisted and can be updated. */
|
|
1562
1548
|
EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
|
|
1563
|
-
/** CMS-specific collection properties */
|
|
1549
|
+
/** CMS-specific collection properties. */
|
|
1564
1550
|
CMS = "CMS"
|
|
1565
1551
|
}
|
|
1566
1552
|
interface PublishPluginOptions$1 {
|
|
@@ -1572,12 +1558,7 @@ interface SingleItemPluginOptions {
|
|
|
1572
1558
|
singleItemId?: string;
|
|
1573
1559
|
}
|
|
1574
1560
|
interface UrlizedPluginOptions {
|
|
1575
|
-
/**
|
|
1576
|
-
* Encoding method for generating a URL in ASCII characters.
|
|
1577
|
-
*
|
|
1578
|
-
* * `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.
|
|
1579
|
-
* * `PLAIN`: No changes are made before generating the encoded URL.
|
|
1580
|
-
*/
|
|
1561
|
+
/** Encoding method for generating a URL in ASCII characters. */
|
|
1581
1562
|
format?: Format;
|
|
1582
1563
|
}
|
|
1583
1564
|
interface MultilingualOptions {
|
|
@@ -1614,17 +1595,17 @@ interface DataPermissions {
|
|
|
1614
1595
|
* Each level includes all levels below it (except UNDEFINED).
|
|
1615
1596
|
*/
|
|
1616
1597
|
declare enum AccessLevel {
|
|
1617
|
-
/** Not set */
|
|
1598
|
+
/** Not set. */
|
|
1618
1599
|
UNDEFINED = "UNDEFINED",
|
|
1619
|
-
/** Any subject, including visitors */
|
|
1600
|
+
/** Any subject, including visitors. */
|
|
1620
1601
|
ANYONE = "ANYONE",
|
|
1621
|
-
/** Any signed-in user (both site members and collaborators) */
|
|
1602
|
+
/** Any signed-in user (both site members and collaborators). */
|
|
1622
1603
|
SITE_MEMBER = "SITE_MEMBER",
|
|
1623
|
-
/** Any signed-in user, but site members only have access to own items */
|
|
1604
|
+
/** Any signed-in user, but site members only have access to own items. */
|
|
1624
1605
|
SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
|
|
1625
|
-
/** Site collaborator that has a role with CMS Access permission */
|
|
1606
|
+
/** Site collaborator that has a role with CMS Access permission. */
|
|
1626
1607
|
CMS_EDITOR = "CMS_EDITOR",
|
|
1627
|
-
/** CMS administrators and users or roles granted with special access */
|
|
1608
|
+
/** CMS administrators and users or roles granted with special access. */
|
|
1628
1609
|
PRIVILEGED = "PRIVILEGED"
|
|
1629
1610
|
}
|
|
1630
1611
|
interface AllowedDataPermissions {
|
|
@@ -1889,12 +1870,6 @@ interface Index$1 {
|
|
|
1889
1870
|
fields?: IndexField[];
|
|
1890
1871
|
/**
|
|
1891
1872
|
* Current status of the index.
|
|
1892
|
-
* - `BUILDING`: Index creation is in progress.
|
|
1893
|
-
* - `ACTIVE`: Index has been successfully created and can be used in queries.
|
|
1894
|
-
* - `DROPPING`: Index is in the process of being dropped.
|
|
1895
|
-
* - `DROPPED`: Index has been dropped successfully.
|
|
1896
|
-
* - `FAILED`: Index creation has failed.
|
|
1897
|
-
* - `INVALID`: Index contains incorrectly indexed data.
|
|
1898
1873
|
* @readonly
|
|
1899
1874
|
*/
|
|
1900
1875
|
status?: IndexStatus;
|
|
@@ -2721,19 +2696,17 @@ interface SaveDataItemRequest {
|
|
|
2721
2696
|
publishPluginOptions?: DataPublishPluginOptions;
|
|
2722
2697
|
}
|
|
2723
2698
|
interface SaveDataItemResponse {
|
|
2724
|
-
/**
|
|
2725
|
-
* The action carried out for the item.
|
|
2726
|
-
*
|
|
2727
|
-
* + `INSERTED`: A new item was added to the collection.
|
|
2728
|
-
* + `UPDATED`: An existing item in the collection was updated.
|
|
2729
|
-
*/
|
|
2699
|
+
/** The action carried out for the item. */
|
|
2730
2700
|
action?: Action;
|
|
2731
2701
|
/** Inserted or updated data item. */
|
|
2732
2702
|
dataItem?: DataItem;
|
|
2733
2703
|
}
|
|
2734
2704
|
declare enum Action {
|
|
2705
|
+
/** Undefined action. */
|
|
2735
2706
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
2707
|
+
/** A new item was added to the collection. */
|
|
2736
2708
|
INSERTED = "INSERTED",
|
|
2709
|
+
/** An existing item in the collection was updated. */
|
|
2737
2710
|
UPDATED = "UPDATED"
|
|
2738
2711
|
}
|
|
2739
2712
|
interface GetDataItemRequest {
|
|
@@ -4978,12 +4951,6 @@ interface Index {
|
|
|
4978
4951
|
fields?: Field[];
|
|
4979
4952
|
/**
|
|
4980
4953
|
* Current status of the index.
|
|
4981
|
-
* - `BUILDING`: Index creation is in progress.
|
|
4982
|
-
* - `ACTIVE`: Index has been successfully created and can be used in queries.
|
|
4983
|
-
* - `DROPPING`: Index is in the process of being dropped.
|
|
4984
|
-
* - `DROPPED`: Index has been dropped successfully.
|
|
4985
|
-
* - `FAILED`: Index creation has failed.
|
|
4986
|
-
* - `INVALID`: Index contains incorrectly indexed data.
|
|
4987
4954
|
* @readonly
|
|
4988
4955
|
*/
|
|
4989
4956
|
status?: Status;
|
|
@@ -1036,11 +1036,6 @@ interface DataCollection {
|
|
|
1036
1036
|
_id?: string;
|
|
1037
1037
|
/**
|
|
1038
1038
|
* Collection type. Indicates how the collection was created and is stored.
|
|
1039
|
-
*
|
|
1040
|
-
* * `NATIVE`: User-created collection.
|
|
1041
|
-
* * `WIX_APP`: [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.
|
|
1042
|
-
* * `BLOCKS_APP`: Collection created by a Wix Blocks app.
|
|
1043
|
-
* * `EXTERNAL`: Collection located in externally connected storage.
|
|
1044
1039
|
* @readonly
|
|
1045
1040
|
*/
|
|
1046
1041
|
collectionType?: CollectionType;
|
|
@@ -1130,11 +1125,7 @@ declare enum Direction {
|
|
|
1130
1125
|
interface CollectionCapabilities {
|
|
1131
1126
|
/** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
|
|
1132
1127
|
dataOperations?: DataOperation[];
|
|
1133
|
-
/**
|
|
1134
|
-
* Collection operations supported. The listed operations can be performed on the collection itself.
|
|
1135
|
-
* + `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.
|
|
1136
|
-
* + `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted.
|
|
1137
|
-
*/
|
|
1128
|
+
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
1138
1129
|
collectionOperations?: CollectionOperation[];
|
|
1139
1130
|
/** Maximum number of indexes for the collection. */
|
|
1140
1131
|
indexLimits?: IndexLimits;
|
|
@@ -1163,9 +1154,9 @@ declare enum DataOperation {
|
|
|
1163
1154
|
BULK_PATCH = "BULK_PATCH"
|
|
1164
1155
|
}
|
|
1165
1156
|
declare enum CollectionOperation {
|
|
1166
|
-
/**
|
|
1157
|
+
/** Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed. */
|
|
1167
1158
|
UPDATE = "UPDATE",
|
|
1168
|
-
/**
|
|
1159
|
+
/** Allows deleting the entire collection. If not included, the collection can't be deleted. */
|
|
1169
1160
|
REMOVE = "REMOVE"
|
|
1170
1161
|
}
|
|
1171
1162
|
interface IndexLimits {
|
|
@@ -1447,6 +1438,7 @@ interface FieldPluginOptionsOneOf {
|
|
|
1447
1438
|
cmsOptions?: CmsOptions;
|
|
1448
1439
|
}
|
|
1449
1440
|
declare enum FieldPluginType {
|
|
1441
|
+
/** Uknown plugin type. */
|
|
1450
1442
|
UNKNOWN = "UNKNOWN",
|
|
1451
1443
|
/** CMS-related field attributes */
|
|
1452
1444
|
CMS = "CMS"
|
|
@@ -1472,7 +1464,7 @@ interface Permissions {
|
|
|
1472
1464
|
read?: Role;
|
|
1473
1465
|
}
|
|
1474
1466
|
declare enum Role {
|
|
1475
|
-
/** Unknown. */
|
|
1467
|
+
/** Unknown role. */
|
|
1476
1468
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
1477
1469
|
/** Site administrator. */
|
|
1478
1470
|
ADMIN = "ADMIN",
|
|
@@ -1499,15 +1491,7 @@ interface Plugin extends PluginOptionsOneOf {
|
|
|
1499
1491
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
1500
1492
|
/** Options for the CMS plugin. */
|
|
1501
1493
|
cmsOptions?: PluginCmsOptions;
|
|
1502
|
-
/**
|
|
1503
|
-
* Plugin types. The following plugins are supported:
|
|
1504
|
-
*
|
|
1505
|
-
* * `PUBLISH`: Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors.
|
|
1506
|
-
* * `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.
|
|
1507
|
-
* * `URLIZED`: Generates item URLs for collections used by dynamic pages.
|
|
1508
|
-
* * `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
|
|
1509
|
-
* * `CMS`: Contains CMS-related collection attributes
|
|
1510
|
-
*/
|
|
1494
|
+
/** Plugin types. */
|
|
1511
1495
|
type?: PluginType;
|
|
1512
1496
|
}
|
|
1513
1497
|
/** @oneof */
|
|
@@ -1535,7 +1519,9 @@ declare enum Status$1 {
|
|
|
1535
1519
|
}
|
|
1536
1520
|
declare enum Format {
|
|
1537
1521
|
UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
|
|
1522
|
+
/** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
|
|
1538
1523
|
ORIGINAL = "ORIGINAL",
|
|
1524
|
+
/** No changes are made before generating the encoded URL. */
|
|
1539
1525
|
PLAIN = "PLAIN"
|
|
1540
1526
|
}
|
|
1541
1527
|
/** if CMS-defined sort is enabled and should be used in site */
|
|
@@ -1556,11 +1542,11 @@ declare enum PluginType {
|
|
|
1556
1542
|
GRIDAPPLESS = "GRIDAPPLESS",
|
|
1557
1543
|
/** Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). */
|
|
1558
1544
|
MULTILINGUAL = "MULTILINGUAL",
|
|
1559
|
-
/** Indicates that collection is shared with current site */
|
|
1545
|
+
/** Indicates that collection is shared with current site. */
|
|
1560
1546
|
SHARED = "SHARED",
|
|
1561
|
-
/** Indicates that page link fields are persisted and can be updated */
|
|
1547
|
+
/** Indicates that page link fields are persisted and can be updated. */
|
|
1562
1548
|
EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
|
|
1563
|
-
/** CMS-specific collection properties */
|
|
1549
|
+
/** CMS-specific collection properties. */
|
|
1564
1550
|
CMS = "CMS"
|
|
1565
1551
|
}
|
|
1566
1552
|
interface PublishPluginOptions$1 {
|
|
@@ -1572,12 +1558,7 @@ interface SingleItemPluginOptions {
|
|
|
1572
1558
|
singleItemId?: string;
|
|
1573
1559
|
}
|
|
1574
1560
|
interface UrlizedPluginOptions {
|
|
1575
|
-
/**
|
|
1576
|
-
* Encoding method for generating a URL in ASCII characters.
|
|
1577
|
-
*
|
|
1578
|
-
* * `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.
|
|
1579
|
-
* * `PLAIN`: No changes are made before generating the encoded URL.
|
|
1580
|
-
*/
|
|
1561
|
+
/** Encoding method for generating a URL in ASCII characters. */
|
|
1581
1562
|
format?: Format;
|
|
1582
1563
|
}
|
|
1583
1564
|
interface MultilingualOptions {
|
|
@@ -1614,17 +1595,17 @@ interface DataPermissions {
|
|
|
1614
1595
|
* Each level includes all levels below it (except UNDEFINED).
|
|
1615
1596
|
*/
|
|
1616
1597
|
declare enum AccessLevel {
|
|
1617
|
-
/** Not set */
|
|
1598
|
+
/** Not set. */
|
|
1618
1599
|
UNDEFINED = "UNDEFINED",
|
|
1619
|
-
/** Any subject, including visitors */
|
|
1600
|
+
/** Any subject, including visitors. */
|
|
1620
1601
|
ANYONE = "ANYONE",
|
|
1621
|
-
/** Any signed-in user (both site members and collaborators) */
|
|
1602
|
+
/** Any signed-in user (both site members and collaborators). */
|
|
1622
1603
|
SITE_MEMBER = "SITE_MEMBER",
|
|
1623
|
-
/** Any signed-in user, but site members only have access to own items */
|
|
1604
|
+
/** Any signed-in user, but site members only have access to own items. */
|
|
1624
1605
|
SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
|
|
1625
|
-
/** Site collaborator that has a role with CMS Access permission */
|
|
1606
|
+
/** Site collaborator that has a role with CMS Access permission. */
|
|
1626
1607
|
CMS_EDITOR = "CMS_EDITOR",
|
|
1627
|
-
/** CMS administrators and users or roles granted with special access */
|
|
1608
|
+
/** CMS administrators and users or roles granted with special access. */
|
|
1628
1609
|
PRIVILEGED = "PRIVILEGED"
|
|
1629
1610
|
}
|
|
1630
1611
|
interface AllowedDataPermissions {
|
|
@@ -1889,12 +1870,6 @@ interface Index$1 {
|
|
|
1889
1870
|
fields?: IndexField[];
|
|
1890
1871
|
/**
|
|
1891
1872
|
* Current status of the index.
|
|
1892
|
-
* - `BUILDING`: Index creation is in progress.
|
|
1893
|
-
* - `ACTIVE`: Index has been successfully created and can be used in queries.
|
|
1894
|
-
* - `DROPPING`: Index is in the process of being dropped.
|
|
1895
|
-
* - `DROPPED`: Index has been dropped successfully.
|
|
1896
|
-
* - `FAILED`: Index creation has failed.
|
|
1897
|
-
* - `INVALID`: Index contains incorrectly indexed data.
|
|
1898
1873
|
* @readonly
|
|
1899
1874
|
*/
|
|
1900
1875
|
status?: IndexStatus;
|
|
@@ -2721,19 +2696,17 @@ interface SaveDataItemRequest {
|
|
|
2721
2696
|
publishPluginOptions?: DataPublishPluginOptions;
|
|
2722
2697
|
}
|
|
2723
2698
|
interface SaveDataItemResponse {
|
|
2724
|
-
/**
|
|
2725
|
-
* The action carried out for the item.
|
|
2726
|
-
*
|
|
2727
|
-
* + `INSERTED`: A new item was added to the collection.
|
|
2728
|
-
* + `UPDATED`: An existing item in the collection was updated.
|
|
2729
|
-
*/
|
|
2699
|
+
/** The action carried out for the item. */
|
|
2730
2700
|
action?: Action;
|
|
2731
2701
|
/** Inserted or updated data item. */
|
|
2732
2702
|
dataItem?: DataItem;
|
|
2733
2703
|
}
|
|
2734
2704
|
declare enum Action {
|
|
2705
|
+
/** Undefined action. */
|
|
2735
2706
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
2707
|
+
/** A new item was added to the collection. */
|
|
2736
2708
|
INSERTED = "INSERTED",
|
|
2709
|
+
/** An existing item in the collection was updated. */
|
|
2737
2710
|
UPDATED = "UPDATED"
|
|
2738
2711
|
}
|
|
2739
2712
|
interface GetDataItemRequest {
|
|
@@ -4978,12 +4951,6 @@ interface Index {
|
|
|
4978
4951
|
fields?: Field[];
|
|
4979
4952
|
/**
|
|
4980
4953
|
* Current status of the index.
|
|
4981
|
-
* - `BUILDING`: Index creation is in progress.
|
|
4982
|
-
* - `ACTIVE`: Index has been successfully created and can be used in queries.
|
|
4983
|
-
* - `DROPPING`: Index is in the process of being dropped.
|
|
4984
|
-
* - `DROPPED`: Index has been dropped successfully.
|
|
4985
|
-
* - `FAILED`: Index creation has failed.
|
|
4986
|
-
* - `INVALID`: Index contains incorrectly indexed data.
|
|
4987
4954
|
* @readonly
|
|
4988
4955
|
*/
|
|
4989
4956
|
status?: Status;
|
|
@@ -479,11 +479,6 @@ interface DataCollection$1 {
|
|
|
479
479
|
id?: string;
|
|
480
480
|
/**
|
|
481
481
|
* Collection type. Indicates how the collection was created and is stored.
|
|
482
|
-
*
|
|
483
|
-
* * `NATIVE`: User-created collection.
|
|
484
|
-
* * `WIX_APP`: [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.
|
|
485
|
-
* * `BLOCKS_APP`: Collection created by a Wix Blocks app.
|
|
486
|
-
* * `EXTERNAL`: Collection located in externally connected storage.
|
|
487
482
|
* @readonly
|
|
488
483
|
*/
|
|
489
484
|
collectionType?: CollectionType$1;
|
|
@@ -577,11 +572,7 @@ interface CollectionCapabilities$1 {
|
|
|
577
572
|
* > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
|
|
578
573
|
*/
|
|
579
574
|
dataOperations?: DataOperation$1[];
|
|
580
|
-
/**
|
|
581
|
-
* Collection operations supported. The listed operations can be performed on the collection itself.
|
|
582
|
-
* + `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.
|
|
583
|
-
* + `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted.
|
|
584
|
-
*/
|
|
575
|
+
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
585
576
|
collectionOperations?: CollectionOperation$1[];
|
|
586
577
|
/** Maximum number of indexes for the collection. */
|
|
587
578
|
indexLimits?: IndexLimits$1;
|
|
@@ -610,9 +601,9 @@ declare enum DataOperation$1 {
|
|
|
610
601
|
BULK_PATCH = "BULK_PATCH"
|
|
611
602
|
}
|
|
612
603
|
declare enum CollectionOperation$1 {
|
|
613
|
-
/**
|
|
604
|
+
/** Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed. */
|
|
614
605
|
UPDATE = "UPDATE",
|
|
615
|
-
/**
|
|
606
|
+
/** Allows deleting the entire collection. If not included, the collection can't be deleted. */
|
|
616
607
|
REMOVE = "REMOVE"
|
|
617
608
|
}
|
|
618
609
|
interface IndexLimits$1 {
|
|
@@ -890,6 +881,7 @@ interface FieldPluginOptionsOneOf$1 {
|
|
|
890
881
|
cmsOptions?: CmsOptions$1;
|
|
891
882
|
}
|
|
892
883
|
declare enum FieldPluginType$1 {
|
|
884
|
+
/** Uknown plugin type. */
|
|
893
885
|
UNKNOWN = "UNKNOWN",
|
|
894
886
|
/** CMS-related field attributes */
|
|
895
887
|
CMS = "CMS"
|
|
@@ -915,7 +907,7 @@ interface Permissions$1 {
|
|
|
915
907
|
read?: Role$1;
|
|
916
908
|
}
|
|
917
909
|
declare enum Role$1 {
|
|
918
|
-
/** Unknown. */
|
|
910
|
+
/** Unknown role. */
|
|
919
911
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
920
912
|
/** Site administrator. */
|
|
921
913
|
ADMIN = "ADMIN",
|
|
@@ -942,15 +934,7 @@ interface Plugin$1 extends PluginOptionsOneOf$1 {
|
|
|
942
934
|
editablePageLinkOptions?: PageLinkPluginOptions$1;
|
|
943
935
|
/** Options for the CMS plugin. */
|
|
944
936
|
cmsOptions?: PluginCmsOptions$1;
|
|
945
|
-
/**
|
|
946
|
-
* Plugin types. The following plugins are supported:
|
|
947
|
-
*
|
|
948
|
-
* * `PUBLISH`: Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors.
|
|
949
|
-
* * `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.
|
|
950
|
-
* * `URLIZED`: Generates item URLs for collections used by dynamic pages.
|
|
951
|
-
* * `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
|
|
952
|
-
* * `CMS`: Contains CMS-related collection attributes
|
|
953
|
-
*/
|
|
937
|
+
/** Plugin types. */
|
|
954
938
|
type?: PluginType$1;
|
|
955
939
|
}
|
|
956
940
|
/** @oneof */
|
|
@@ -978,7 +962,9 @@ declare enum Status$3 {
|
|
|
978
962
|
}
|
|
979
963
|
declare enum Format$1 {
|
|
980
964
|
UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
|
|
965
|
+
/** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
|
|
981
966
|
ORIGINAL = "ORIGINAL",
|
|
967
|
+
/** No changes are made before generating the encoded URL. */
|
|
982
968
|
PLAIN = "PLAIN"
|
|
983
969
|
}
|
|
984
970
|
/** if CMS-defined sort is enabled and should be used in site */
|
|
@@ -999,11 +985,11 @@ declare enum PluginType$1 {
|
|
|
999
985
|
GRIDAPPLESS = "GRIDAPPLESS",
|
|
1000
986
|
/** Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). */
|
|
1001
987
|
MULTILINGUAL = "MULTILINGUAL",
|
|
1002
|
-
/** Indicates that collection is shared with current site */
|
|
988
|
+
/** Indicates that collection is shared with current site. */
|
|
1003
989
|
SHARED = "SHARED",
|
|
1004
|
-
/** Indicates that page link fields are persisted and can be updated */
|
|
990
|
+
/** Indicates that page link fields are persisted and can be updated. */
|
|
1005
991
|
EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
|
|
1006
|
-
/** CMS-specific collection properties */
|
|
992
|
+
/** CMS-specific collection properties. */
|
|
1007
993
|
CMS = "CMS"
|
|
1008
994
|
}
|
|
1009
995
|
interface PublishPluginOptions$1 {
|
|
@@ -1015,12 +1001,7 @@ interface SingleItemPluginOptions$1 {
|
|
|
1015
1001
|
singleItemId?: string;
|
|
1016
1002
|
}
|
|
1017
1003
|
interface UrlizedPluginOptions$1 {
|
|
1018
|
-
/**
|
|
1019
|
-
* Encoding method for generating a URL in ASCII characters.
|
|
1020
|
-
*
|
|
1021
|
-
* * `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.
|
|
1022
|
-
* * `PLAIN`: No changes are made before generating the encoded URL.
|
|
1023
|
-
*/
|
|
1004
|
+
/** Encoding method for generating a URL in ASCII characters. */
|
|
1024
1005
|
format?: Format$1;
|
|
1025
1006
|
}
|
|
1026
1007
|
interface MultilingualOptions$1 {
|
|
@@ -1046,17 +1027,17 @@ declare enum PagingMode$1 {
|
|
|
1046
1027
|
* Each level includes all levels below it (except UNDEFINED).
|
|
1047
1028
|
*/
|
|
1048
1029
|
declare enum AccessLevel$1 {
|
|
1049
|
-
/** Not set */
|
|
1030
|
+
/** Not set. */
|
|
1050
1031
|
UNDEFINED = "UNDEFINED",
|
|
1051
|
-
/** Any subject, including visitors */
|
|
1032
|
+
/** Any subject, including visitors. */
|
|
1052
1033
|
ANYONE = "ANYONE",
|
|
1053
|
-
/** Any signed-in user (both site members and collaborators) */
|
|
1034
|
+
/** Any signed-in user (both site members and collaborators). */
|
|
1054
1035
|
SITE_MEMBER = "SITE_MEMBER",
|
|
1055
|
-
/** Any signed-in user, but site members only have access to own items */
|
|
1036
|
+
/** Any signed-in user, but site members only have access to own items. */
|
|
1056
1037
|
SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
|
|
1057
|
-
/** Site collaborator that has a role with CMS Access permission */
|
|
1038
|
+
/** Site collaborator that has a role with CMS Access permission. */
|
|
1058
1039
|
CMS_EDITOR = "CMS_EDITOR",
|
|
1059
|
-
/** CMS administrators and users or roles granted with special access */
|
|
1040
|
+
/** CMS administrators and users or roles granted with special access. */
|
|
1060
1041
|
PRIVILEGED = "PRIVILEGED"
|
|
1061
1042
|
}
|
|
1062
1043
|
interface CreateDataCollectionRequest$1 {
|
|
@@ -1319,11 +1300,6 @@ interface DataCollection {
|
|
|
1319
1300
|
_id?: string;
|
|
1320
1301
|
/**
|
|
1321
1302
|
* Collection type. Indicates how the collection was created and is stored.
|
|
1322
|
-
*
|
|
1323
|
-
* * `NATIVE`: User-created collection.
|
|
1324
|
-
* * `WIX_APP`: [Collection](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-collections) created by a Wix app, including [starter collections](https://support.wix.com/en/article/velo-working-with-wix-app-collections-and-code#what-are-wix-app-starter-collections) created when a Wix app is installed.
|
|
1325
|
-
* * `BLOCKS_APP`: Collection created by a Wix Blocks app.
|
|
1326
|
-
* * `EXTERNAL`: Collection located in externally connected storage.
|
|
1327
1303
|
* @readonly
|
|
1328
1304
|
*/
|
|
1329
1305
|
collectionType?: CollectionType;
|
|
@@ -1413,11 +1389,7 @@ declare enum Direction {
|
|
|
1413
1389
|
interface CollectionCapabilities {
|
|
1414
1390
|
/** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
|
|
1415
1391
|
dataOperations?: DataOperation[];
|
|
1416
|
-
/**
|
|
1417
|
-
* Collection operations supported. The listed operations can be performed on the collection itself.
|
|
1418
|
-
* + `UPDATE`: Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed.
|
|
1419
|
-
* + `REMOVE`: Allows deleting the entire collection. If not included, the collection can't be deleted.
|
|
1420
|
-
*/
|
|
1392
|
+
/** Collection operations supported. The listed operations can be performed on the collection itself. */
|
|
1421
1393
|
collectionOperations?: CollectionOperation[];
|
|
1422
1394
|
/** Maximum number of indexes for the collection. */
|
|
1423
1395
|
indexLimits?: IndexLimits;
|
|
@@ -1446,9 +1418,9 @@ declare enum DataOperation {
|
|
|
1446
1418
|
BULK_PATCH = "BULK_PATCH"
|
|
1447
1419
|
}
|
|
1448
1420
|
declare enum CollectionOperation {
|
|
1449
|
-
/**
|
|
1421
|
+
/** Allows updating the collection's structure, for example adding, updating, or deleting fields. If not included, the collection's structure can't be changed. */
|
|
1450
1422
|
UPDATE = "UPDATE",
|
|
1451
|
-
/**
|
|
1423
|
+
/** Allows deleting the entire collection. If not included, the collection can't be deleted. */
|
|
1452
1424
|
REMOVE = "REMOVE"
|
|
1453
1425
|
}
|
|
1454
1426
|
interface IndexLimits {
|
|
@@ -1730,6 +1702,7 @@ interface FieldPluginOptionsOneOf {
|
|
|
1730
1702
|
cmsOptions?: CmsOptions;
|
|
1731
1703
|
}
|
|
1732
1704
|
declare enum FieldPluginType {
|
|
1705
|
+
/** Uknown plugin type. */
|
|
1733
1706
|
UNKNOWN = "UNKNOWN",
|
|
1734
1707
|
/** CMS-related field attributes */
|
|
1735
1708
|
CMS = "CMS"
|
|
@@ -1755,7 +1728,7 @@ interface Permissions {
|
|
|
1755
1728
|
read?: Role;
|
|
1756
1729
|
}
|
|
1757
1730
|
declare enum Role {
|
|
1758
|
-
/** Unknown. */
|
|
1731
|
+
/** Unknown role. */
|
|
1759
1732
|
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
1760
1733
|
/** Site administrator. */
|
|
1761
1734
|
ADMIN = "ADMIN",
|
|
@@ -1782,15 +1755,7 @@ interface Plugin extends PluginOptionsOneOf {
|
|
|
1782
1755
|
editablePageLinkOptions?: PageLinkPluginOptions;
|
|
1783
1756
|
/** Options for the CMS plugin. */
|
|
1784
1757
|
cmsOptions?: PluginCmsOptions;
|
|
1785
|
-
/**
|
|
1786
|
-
* Plugin types. The following plugins are supported:
|
|
1787
|
-
*
|
|
1788
|
-
* * `PUBLISH`: Allows items to be marked as either draft or published. For each item you can set a publishing time when the item will become visible to site visitors.
|
|
1789
|
-
* * `SINGLE_ITEM`: Ensures the collection can have one item at most. Can only be applied to a new collection.
|
|
1790
|
-
* * `URLIZED`: Generates item URLs for collections used by dynamic pages.
|
|
1791
|
-
* * `MULTILINGUAL`: Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
|
|
1792
|
-
* * `CMS`: Contains CMS-related collection attributes
|
|
1793
|
-
*/
|
|
1758
|
+
/** Plugin types. */
|
|
1794
1759
|
type?: PluginType;
|
|
1795
1760
|
}
|
|
1796
1761
|
/** @oneof */
|
|
@@ -1818,7 +1783,9 @@ declare enum Status$2 {
|
|
|
1818
1783
|
}
|
|
1819
1784
|
declare enum Format {
|
|
1820
1785
|
UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
|
|
1786
|
+
/** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
|
|
1821
1787
|
ORIGINAL = "ORIGINAL",
|
|
1788
|
+
/** No changes are made before generating the encoded URL. */
|
|
1822
1789
|
PLAIN = "PLAIN"
|
|
1823
1790
|
}
|
|
1824
1791
|
/** if CMS-defined sort is enabled and should be used in site */
|
|
@@ -1839,11 +1806,11 @@ declare enum PluginType {
|
|
|
1839
1806
|
GRIDAPPLESS = "GRIDAPPLESS",
|
|
1840
1807
|
/** Indicates that the collection is translatable. This allows you to manage translation for selected fields using [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). */
|
|
1841
1808
|
MULTILINGUAL = "MULTILINGUAL",
|
|
1842
|
-
/** Indicates that collection is shared with current site */
|
|
1809
|
+
/** Indicates that collection is shared with current site. */
|
|
1843
1810
|
SHARED = "SHARED",
|
|
1844
|
-
/** Indicates that page link fields are persisted and can be updated */
|
|
1811
|
+
/** Indicates that page link fields are persisted and can be updated. */
|
|
1845
1812
|
EDITABLE_PAGE_LINK = "EDITABLE_PAGE_LINK",
|
|
1846
|
-
/** CMS-specific collection properties */
|
|
1813
|
+
/** CMS-specific collection properties. */
|
|
1847
1814
|
CMS = "CMS"
|
|
1848
1815
|
}
|
|
1849
1816
|
interface PublishPluginOptions {
|
|
@@ -1855,12 +1822,7 @@ interface SingleItemPluginOptions {
|
|
|
1855
1822
|
singleItemId?: string;
|
|
1856
1823
|
}
|
|
1857
1824
|
interface UrlizedPluginOptions {
|
|
1858
|
-
/**
|
|
1859
|
-
* Encoding method for generating a URL in ASCII characters.
|
|
1860
|
-
*
|
|
1861
|
-
* * `ORIGINAL`: Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL.
|
|
1862
|
-
* * `PLAIN`: No changes are made before generating the encoded URL.
|
|
1863
|
-
*/
|
|
1825
|
+
/** Encoding method for generating a URL in ASCII characters. */
|
|
1864
1826
|
format?: Format;
|
|
1865
1827
|
}
|
|
1866
1828
|
interface MultilingualOptions {
|
|
@@ -1886,17 +1848,17 @@ declare enum PagingMode {
|
|
|
1886
1848
|
* Each level includes all levels below it (except UNDEFINED).
|
|
1887
1849
|
*/
|
|
1888
1850
|
declare enum AccessLevel {
|
|
1889
|
-
/** Not set */
|
|
1851
|
+
/** Not set. */
|
|
1890
1852
|
UNDEFINED = "UNDEFINED",
|
|
1891
|
-
/** Any subject, including visitors */
|
|
1853
|
+
/** Any subject, including visitors. */
|
|
1892
1854
|
ANYONE = "ANYONE",
|
|
1893
|
-
/** Any signed-in user (both site members and collaborators) */
|
|
1855
|
+
/** Any signed-in user (both site members and collaborators). */
|
|
1894
1856
|
SITE_MEMBER = "SITE_MEMBER",
|
|
1895
|
-
/** Any signed-in user, but site members only have access to own items */
|
|
1857
|
+
/** Any signed-in user, but site members only have access to own items. */
|
|
1896
1858
|
SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
|
|
1897
|
-
/** Site collaborator that has a role with CMS Access permission */
|
|
1859
|
+
/** Site collaborator that has a role with CMS Access permission. */
|
|
1898
1860
|
CMS_EDITOR = "CMS_EDITOR",
|
|
1899
|
-
/** CMS administrators and users or roles granted with special access */
|
|
1861
|
+
/** CMS administrators and users or roles granted with special access. */
|
|
1900
1862
|
PRIVILEGED = "PRIVILEGED"
|
|
1901
1863
|
}
|
|
1902
1864
|
interface CreateDataCollectionRequest {
|
|
@@ -2309,19 +2271,17 @@ interface SaveDataItemRequest$1 {
|
|
|
2309
2271
|
publishPluginOptions?: DataPublishPluginOptions$1;
|
|
2310
2272
|
}
|
|
2311
2273
|
interface SaveDataItemResponse$1 {
|
|
2312
|
-
/**
|
|
2313
|
-
* The action carried out for the item.
|
|
2314
|
-
*
|
|
2315
|
-
* + `INSERTED`: A new item was added to the collection.
|
|
2316
|
-
* + `UPDATED`: An existing item in the collection was updated.
|
|
2317
|
-
*/
|
|
2274
|
+
/** The action carried out for the item. */
|
|
2318
2275
|
action?: Action$1;
|
|
2319
2276
|
/** Inserted or updated data item. */
|
|
2320
2277
|
dataItem?: DataItem$1;
|
|
2321
2278
|
}
|
|
2322
2279
|
declare enum Action$1 {
|
|
2280
|
+
/** Undefined action. */
|
|
2323
2281
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
2282
|
+
/** A new item was added to the collection. */
|
|
2324
2283
|
INSERTED = "INSERTED",
|
|
2284
|
+
/** An existing item in the collection was updated. */
|
|
2325
2285
|
UPDATED = "UPDATED"
|
|
2326
2286
|
}
|
|
2327
2287
|
interface GetDataItemRequest$1 {
|
|
@@ -3353,19 +3313,17 @@ interface SaveDataItemRequest {
|
|
|
3353
3313
|
publishPluginOptions?: DataPublishPluginOptions;
|
|
3354
3314
|
}
|
|
3355
3315
|
interface SaveDataItemResponse {
|
|
3356
|
-
/**
|
|
3357
|
-
* The action carried out for the item.
|
|
3358
|
-
*
|
|
3359
|
-
* + `INSERTED`: A new item was added to the collection.
|
|
3360
|
-
* + `UPDATED`: An existing item in the collection was updated.
|
|
3361
|
-
*/
|
|
3316
|
+
/** The action carried out for the item. */
|
|
3362
3317
|
action?: Action;
|
|
3363
3318
|
/** Inserted or updated data item. */
|
|
3364
3319
|
dataItem?: DataItem;
|
|
3365
3320
|
}
|
|
3366
3321
|
declare enum Action {
|
|
3322
|
+
/** Undefined action. */
|
|
3367
3323
|
UNKNOWN_ACTION = "UNKNOWN_ACTION",
|
|
3324
|
+
/** A new item was added to the collection. */
|
|
3368
3325
|
INSERTED = "INSERTED",
|
|
3326
|
+
/** An existing item in the collection was updated. */
|
|
3369
3327
|
UPDATED = "UPDATED"
|
|
3370
3328
|
}
|
|
3371
3329
|
interface GetDataItemRequest {
|
|
@@ -4346,12 +4304,6 @@ interface Index$1 {
|
|
|
4346
4304
|
fields?: Field$1[];
|
|
4347
4305
|
/**
|
|
4348
4306
|
* Current status of the index.
|
|
4349
|
-
* - `BUILDING`: Index creation is in progress.
|
|
4350
|
-
* - `ACTIVE`: Index has been successfully created and can be used in queries.
|
|
4351
|
-
* - `DROPPING`: Index is in the process of being dropped.
|
|
4352
|
-
* - `DROPPED`: Index has been dropped successfully.
|
|
4353
|
-
* - `FAILED`: Index creation has failed.
|
|
4354
|
-
* - `INVALID`: Index contains incorrectly indexed data.
|
|
4355
4307
|
* @readonly
|
|
4356
4308
|
*/
|
|
4357
4309
|
status?: Status$1;
|
|
@@ -4506,12 +4458,6 @@ interface Index {
|
|
|
4506
4458
|
fields?: Field[];
|
|
4507
4459
|
/**
|
|
4508
4460
|
* Current status of the index.
|
|
4509
|
-
* - `BUILDING`: Index creation is in progress.
|
|
4510
|
-
* - `ACTIVE`: Index has been successfully created and can be used in queries.
|
|
4511
|
-
* - `DROPPING`: Index is in the process of being dropped.
|
|
4512
|
-
* - `DROPPED`: Index has been dropped successfully.
|
|
4513
|
-
* - `FAILED`: Index creation has failed.
|
|
4514
|
-
* - `INVALID`: Index contains incorrectly indexed data.
|
|
4515
4461
|
* @readonly
|
|
4516
4462
|
*/
|
|
4517
4463
|
status?: Status;
|