@wix/auto_sdk_data_collections 1.0.69 → 1.0.71
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +7 -6
- package/build/cjs/index.js +0 -8
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +22 -30
- package/build/cjs/index.typings.js +0 -8
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +12 -23
- package/build/cjs/meta.js +0 -8
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +7 -6
- package/build/es/index.mjs +0 -8
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +22 -30
- package/build/es/index.typings.mjs +0 -8
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +12 -23
- package/build/es/meta.mjs +0 -8
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +7 -6
- package/build/internal/cjs/index.js +0 -8
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +22 -30
- package/build/internal/cjs/index.typings.js +0 -8
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +12 -23
- package/build/internal/cjs/meta.js +0 -8
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +7 -6
- package/build/internal/es/index.mjs +0 -8
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +22 -30
- package/build/internal/es/index.typings.mjs +0 -8
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +12 -23
- package/build/internal/es/meta.mjs +0 -8
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/es/meta.d.mts
CHANGED
|
@@ -4,7 +4,8 @@ import '@wix/sdk-types';
|
|
|
4
4
|
/** A data collection determines the structure of data to be stored in a database. */
|
|
5
5
|
interface DataCollection {
|
|
6
6
|
/**
|
|
7
|
-
* Collection ID. For example, `my-first-collection`.
|
|
7
|
+
* [Collection ID](https://dev.wix.com/docs/develop-websites-sdk/code-your-site/work-with-data/introduction/about-collections#collection-ids). For example, `my-first-collection`.
|
|
8
|
+
* For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
|
|
8
9
|
* @immutable
|
|
9
10
|
* @maxLength 256
|
|
10
11
|
*/
|
|
@@ -51,6 +52,7 @@ interface DataCollection {
|
|
|
51
52
|
displayField?: string | null;
|
|
52
53
|
/**
|
|
53
54
|
* Capabilities the collection supports.
|
|
55
|
+
* Capabilities are set by default. Values depend on the collection type.
|
|
54
56
|
* @readonly
|
|
55
57
|
*/
|
|
56
58
|
capabilities?: CollectionCapabilities;
|
|
@@ -123,7 +125,7 @@ interface CollectionCapabilities {
|
|
|
123
125
|
/**
|
|
124
126
|
* Data operations the collection supports. The listed operations can be performed on data the collection contains.
|
|
125
127
|
*
|
|
126
|
-
* > **Note**: The `PATCH` and `BULK_PATCH`
|
|
128
|
+
* > **Note**: The `PATCH` and `BULK_PATCH` operations aren't currently supported.
|
|
127
129
|
* @maxSize 100
|
|
128
130
|
*/
|
|
129
131
|
dataOperations?: DataOperationWithLiterals[];
|
|
@@ -287,7 +289,6 @@ interface EnumValues {
|
|
|
287
289
|
values?: string[];
|
|
288
290
|
}
|
|
289
291
|
declare enum Type {
|
|
290
|
-
UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
|
|
291
292
|
/** Plain-text string. */
|
|
292
293
|
TEXT = "TEXT",
|
|
293
294
|
/** Number. */
|
|
@@ -356,7 +357,7 @@ declare enum Type {
|
|
|
356
357
|
LEGACY_EXTERNAL_VIDEO = "LEGACY_EXTERNAL_VIDEO"
|
|
357
358
|
}
|
|
358
359
|
/** @enumType */
|
|
359
|
-
type TypeWithLiterals = Type | '
|
|
360
|
+
type TypeWithLiterals = Type | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'PAGE_LINK' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY' | 'LEGACY_TIME' | 'LEGACY_BOOK' | 'LEGACY_EXTERNAL_URL' | 'LEGACY_BROKEN_REFERENCE' | 'LEGACY_IMAGE' | 'LEGACY_COLOR' | 'LEGACY_EXTERNAL_VIDEO';
|
|
360
361
|
interface TypeMetadata extends TypeMetadataMetadataOneOf {
|
|
361
362
|
/** Metadata for a reference field. */
|
|
362
363
|
reference?: Reference;
|
|
@@ -460,8 +461,6 @@ interface CalculatorPatternOneOf {
|
|
|
460
461
|
urlizedOnlyPattern?: UrlizedOnlyPattern;
|
|
461
462
|
}
|
|
462
463
|
declare enum PageLinkType {
|
|
463
|
-
/** Default value. This value is unused. */
|
|
464
|
-
UNKNOWN_PAGE_LINK_TYPE = "UNKNOWN_PAGE_LINK_TYPE",
|
|
465
464
|
/**
|
|
466
465
|
* Page link with field substitution patterns stored in the data collection.
|
|
467
466
|
* Example: "path/{plainField}" where plainField can be any supported type.
|
|
@@ -477,7 +476,7 @@ declare enum PageLinkType {
|
|
|
477
476
|
ROUTER_DEFINED = "ROUTER_DEFINED"
|
|
478
477
|
}
|
|
479
478
|
/** @enumType */
|
|
480
|
-
type PageLinkTypeWithLiterals = PageLinkType | '
|
|
479
|
+
type PageLinkTypeWithLiterals = PageLinkType | 'COLLECTION_DEFINED' | 'ROUTER_DEFINED';
|
|
481
480
|
interface Reference {
|
|
482
481
|
/**
|
|
483
482
|
* Referenced collection ID.
|
|
@@ -806,8 +805,6 @@ interface Permissions {
|
|
|
806
805
|
read?: RoleWithLiterals;
|
|
807
806
|
}
|
|
808
807
|
declare enum Role {
|
|
809
|
-
/** Unknown role. */
|
|
810
|
-
UNKNOWN_ROLE = "UNKNOWN_ROLE",
|
|
811
808
|
/** Site administrator. */
|
|
812
809
|
ADMIN = "ADMIN",
|
|
813
810
|
/** Signed-in user who added content to this collection. */
|
|
@@ -818,7 +815,7 @@ declare enum Role {
|
|
|
818
815
|
ANYONE = "ANYONE"
|
|
819
816
|
}
|
|
820
817
|
/** @enumType */
|
|
821
|
-
type RoleWithLiterals = Role | '
|
|
818
|
+
type RoleWithLiterals = Role | 'ADMIN' | 'SITE_MEMBER_AUTHOR' | 'SITE_MEMBER' | 'ANYONE';
|
|
822
819
|
/** Plugins that extend collection functionality. */
|
|
823
820
|
interface Plugin extends PluginOptionsOneOf {
|
|
824
821
|
/**
|
|
@@ -858,21 +855,19 @@ interface PluginOptionsOneOf {
|
|
|
858
855
|
cmsOptions?: PluginCmsOptions;
|
|
859
856
|
}
|
|
860
857
|
declare enum Status {
|
|
861
|
-
UNKNOWN_PUBLISH_PLUGIN_STATUS = "UNKNOWN_PUBLISH_PLUGIN_STATUS",
|
|
862
858
|
PUBLISHED = "PUBLISHED",
|
|
863
859
|
DRAFT = "DRAFT"
|
|
864
860
|
}
|
|
865
861
|
/** @enumType */
|
|
866
|
-
type StatusWithLiterals = Status | '
|
|
862
|
+
type StatusWithLiterals = Status | 'PUBLISHED' | 'DRAFT';
|
|
867
863
|
declare enum Format {
|
|
868
|
-
UNKNOWN_URLIZED_PLUGIN_FORMAT = "UNKNOWN_URLIZED_PLUGIN_FORMAT",
|
|
869
864
|
/** Letters are converted to lower case and spaces are replaced with dashes before generating the encoded URL. */
|
|
870
865
|
ORIGINAL = "ORIGINAL",
|
|
871
866
|
/** No changes are made before generating the encoded URL. */
|
|
872
867
|
PLAIN = "PLAIN"
|
|
873
868
|
}
|
|
874
869
|
/** @enumType */
|
|
875
|
-
type FormatWithLiterals = Format | '
|
|
870
|
+
type FormatWithLiterals = Format | 'ORIGINAL' | 'PLAIN';
|
|
876
871
|
/** if CMS-defined sort is enabled and should be used in site */
|
|
877
872
|
interface SiteSort {
|
|
878
873
|
/**
|
|
@@ -882,8 +877,6 @@ interface SiteSort {
|
|
|
882
877
|
sort?: Sort[];
|
|
883
878
|
}
|
|
884
879
|
declare enum PluginType {
|
|
885
|
-
/** Unknown plugin type. */
|
|
886
|
-
UNKNOWN_PLUGIN_TYPE = "UNKNOWN_PLUGIN_TYPE",
|
|
887
880
|
/** 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. */
|
|
888
881
|
PUBLISH = "PUBLISH",
|
|
889
882
|
/** Ensures the collection can have one item at most. Can only be applied to a new collection. */
|
|
@@ -902,7 +895,7 @@ declare enum PluginType {
|
|
|
902
895
|
CMS = "CMS"
|
|
903
896
|
}
|
|
904
897
|
/** @enumType */
|
|
905
|
-
type PluginTypeWithLiterals = PluginType | '
|
|
898
|
+
type PluginTypeWithLiterals = PluginType | 'PUBLISH' | 'SINGLE_ITEM' | 'URLIZED' | 'GRIDAPPLESS' | 'MULTILINGUAL' | 'SHARED' | 'EDITABLE_PAGE_LINK' | 'CMS';
|
|
906
899
|
interface PublishPluginOptions {
|
|
907
900
|
/** Default status. */
|
|
908
901
|
defaultStatus?: StatusWithLiterals;
|
|
@@ -1026,8 +1019,6 @@ interface DataPermissions {
|
|
|
1026
1019
|
* Each level includes all levels below it (except UNDEFINED).
|
|
1027
1020
|
*/
|
|
1028
1021
|
declare enum AccessLevel {
|
|
1029
|
-
/** Not set. */
|
|
1030
|
-
UNDEFINED = "UNDEFINED",
|
|
1031
1022
|
/** Any subject, including visitors. */
|
|
1032
1023
|
ANYONE = "ANYONE",
|
|
1033
1024
|
/** Any signed-in user (both site members and collaborators). */
|
|
@@ -1040,7 +1031,7 @@ declare enum AccessLevel {
|
|
|
1040
1031
|
PRIVILEGED = "PRIVILEGED"
|
|
1041
1032
|
}
|
|
1042
1033
|
/** @enumType */
|
|
1043
|
-
type AccessLevelWithLiterals = AccessLevel | '
|
|
1034
|
+
type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
|
|
1044
1035
|
interface AllowedDataPermissions {
|
|
1045
1036
|
/** If data items read permitted */
|
|
1046
1037
|
itemRead?: boolean;
|
|
@@ -1607,8 +1598,6 @@ interface Failure {
|
|
|
1607
1598
|
itemId?: string | null;
|
|
1608
1599
|
}
|
|
1609
1600
|
declare enum IndexSource {
|
|
1610
|
-
/** Place holder. Never returned by the service. */
|
|
1611
|
-
UNKNOWN_INDEX_SOURCE = "UNKNOWN_INDEX_SOURCE",
|
|
1612
1601
|
/**
|
|
1613
1602
|
* Automatically created by Wix for all collections.
|
|
1614
1603
|
*
|
|
@@ -1628,7 +1617,7 @@ declare enum IndexSource {
|
|
|
1628
1617
|
AUTO = "AUTO"
|
|
1629
1618
|
}
|
|
1630
1619
|
/** @enumType */
|
|
1631
|
-
type IndexSourceWithLiterals = IndexSource | '
|
|
1620
|
+
type IndexSourceWithLiterals = IndexSource | 'SYSTEM' | 'USER' | 'AUTO';
|
|
1632
1621
|
interface CreateDataCollectionsSnapshotRequest {
|
|
1633
1622
|
}
|
|
1634
1623
|
interface CreateDataCollectionsSnapshotResponse {
|
package/build/es/meta.mjs
CHANGED
|
@@ -1247,7 +1247,6 @@ var CollectionOperation = /* @__PURE__ */ ((CollectionOperation2) => {
|
|
|
1247
1247
|
return CollectionOperation2;
|
|
1248
1248
|
})(CollectionOperation || {});
|
|
1249
1249
|
var Type = /* @__PURE__ */ ((Type2) => {
|
|
1250
|
-
Type2["UNKNOWN_FIELD_TYPE"] = "UNKNOWN_FIELD_TYPE";
|
|
1251
1250
|
Type2["TEXT"] = "TEXT";
|
|
1252
1251
|
Type2["NUMBER"] = "NUMBER";
|
|
1253
1252
|
Type2["DATE"] = "DATE";
|
|
@@ -1298,7 +1297,6 @@ var QueryOperator = /* @__PURE__ */ ((QueryOperator2) => {
|
|
|
1298
1297
|
return QueryOperator2;
|
|
1299
1298
|
})(QueryOperator || {});
|
|
1300
1299
|
var PageLinkType = /* @__PURE__ */ ((PageLinkType2) => {
|
|
1301
|
-
PageLinkType2["UNKNOWN_PAGE_LINK_TYPE"] = "UNKNOWN_PAGE_LINK_TYPE";
|
|
1302
1300
|
PageLinkType2["COLLECTION_DEFINED"] = "COLLECTION_DEFINED";
|
|
1303
1301
|
PageLinkType2["ROUTER_DEFINED"] = "ROUTER_DEFINED";
|
|
1304
1302
|
return PageLinkType2;
|
|
@@ -1314,7 +1312,6 @@ var Permission = /* @__PURE__ */ ((Permission2) => {
|
|
|
1314
1312
|
return Permission2;
|
|
1315
1313
|
})(Permission || {});
|
|
1316
1314
|
var Role = /* @__PURE__ */ ((Role2) => {
|
|
1317
|
-
Role2["UNKNOWN_ROLE"] = "UNKNOWN_ROLE";
|
|
1318
1315
|
Role2["ADMIN"] = "ADMIN";
|
|
1319
1316
|
Role2["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
|
|
1320
1317
|
Role2["SITE_MEMBER"] = "SITE_MEMBER";
|
|
@@ -1322,19 +1319,16 @@ var Role = /* @__PURE__ */ ((Role2) => {
|
|
|
1322
1319
|
return Role2;
|
|
1323
1320
|
})(Role || {});
|
|
1324
1321
|
var Status = /* @__PURE__ */ ((Status2) => {
|
|
1325
|
-
Status2["UNKNOWN_PUBLISH_PLUGIN_STATUS"] = "UNKNOWN_PUBLISH_PLUGIN_STATUS";
|
|
1326
1322
|
Status2["PUBLISHED"] = "PUBLISHED";
|
|
1327
1323
|
Status2["DRAFT"] = "DRAFT";
|
|
1328
1324
|
return Status2;
|
|
1329
1325
|
})(Status || {});
|
|
1330
1326
|
var Format = /* @__PURE__ */ ((Format2) => {
|
|
1331
|
-
Format2["UNKNOWN_URLIZED_PLUGIN_FORMAT"] = "UNKNOWN_URLIZED_PLUGIN_FORMAT";
|
|
1332
1327
|
Format2["ORIGINAL"] = "ORIGINAL";
|
|
1333
1328
|
Format2["PLAIN"] = "PLAIN";
|
|
1334
1329
|
return Format2;
|
|
1335
1330
|
})(Format || {});
|
|
1336
1331
|
var PluginType = /* @__PURE__ */ ((PluginType2) => {
|
|
1337
|
-
PluginType2["UNKNOWN_PLUGIN_TYPE"] = "UNKNOWN_PLUGIN_TYPE";
|
|
1338
1332
|
PluginType2["PUBLISH"] = "PUBLISH";
|
|
1339
1333
|
PluginType2["SINGLE_ITEM"] = "SINGLE_ITEM";
|
|
1340
1334
|
PluginType2["URLIZED"] = "URLIZED";
|
|
@@ -1351,7 +1345,6 @@ var PagingMode = /* @__PURE__ */ ((PagingMode2) => {
|
|
|
1351
1345
|
return PagingMode2;
|
|
1352
1346
|
})(PagingMode || {});
|
|
1353
1347
|
var AccessLevel = /* @__PURE__ */ ((AccessLevel2) => {
|
|
1354
|
-
AccessLevel2["UNDEFINED"] = "UNDEFINED";
|
|
1355
1348
|
AccessLevel2["ANYONE"] = "ANYONE";
|
|
1356
1349
|
AccessLevel2["SITE_MEMBER"] = "SITE_MEMBER";
|
|
1357
1350
|
AccessLevel2["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
|
|
@@ -1392,7 +1385,6 @@ var IndexStatus = /* @__PURE__ */ ((IndexStatus2) => {
|
|
|
1392
1385
|
return IndexStatus2;
|
|
1393
1386
|
})(IndexStatus || {});
|
|
1394
1387
|
var IndexSource = /* @__PURE__ */ ((IndexSource2) => {
|
|
1395
|
-
IndexSource2["UNKNOWN_INDEX_SOURCE"] = "UNKNOWN_INDEX_SOURCE";
|
|
1396
1388
|
IndexSource2["SYSTEM"] = "SYSTEM";
|
|
1397
1389
|
IndexSource2["USER"] = "USER";
|
|
1398
1390
|
IndexSource2["AUTO"] = "AUTO";
|