@wix/auto_sdk_data_collections 1.0.83 → 1.0.85

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +1 -1
  2. package/build/cjs/index.js +8 -8
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +27 -23
  5. package/build/cjs/index.typings.js +8 -8
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +27 -19
  8. package/build/cjs/meta.js +8 -8
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +1 -1
  11. package/build/es/index.mjs +8 -8
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +27 -23
  14. package/build/es/index.typings.mjs +8 -8
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +27 -19
  17. package/build/es/meta.mjs +8 -8
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +1 -1
  20. package/build/internal/cjs/index.js +8 -8
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +27 -23
  23. package/build/internal/cjs/index.typings.js +8 -8
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +27 -19
  26. package/build/internal/cjs/meta.js +8 -8
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +1 -1
  29. package/build/internal/es/index.mjs +8 -8
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +27 -23
  32. package/build/internal/es/index.typings.mjs +8 -8
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +27 -19
  35. package/build/internal/es/meta.mjs +8 -8
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -883,6 +883,32 @@ interface SiteSort {
883
883
  */
884
884
  sort?: Sort[];
885
885
  }
886
+ /**
887
+ * Describes who can perform certain actions.
888
+ * Each level includes all levels below it (except UNDEFINED).
889
+ */
890
+ declare enum AccessLevel {
891
+ /** Any subject, including visitors. */
892
+ ANYONE = "ANYONE",
893
+ /** Any signed-in user (both site members and collaborators). */
894
+ SITE_MEMBER = "SITE_MEMBER",
895
+ /** Any signed-in user, but site members only have access to own items. */
896
+ SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
897
+ /** Site collaborator that has a role with CMS Access permission. */
898
+ CMS_EDITOR = "CMS_EDITOR",
899
+ /** CMS administrators and users or roles granted with special access. */
900
+ PRIVILEGED = "PRIVILEGED"
901
+ }
902
+ /** @enumType */
903
+ type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
904
+ interface DraftPermissions {
905
+ }
906
+ interface AllowedDraftPermissions {
907
+ /** If manage_drafts is permitted for the caller. */
908
+ manageDrafts?: boolean;
909
+ /** If manage_publish_status is permitted for the caller. */
910
+ managePublishStatus?: boolean;
911
+ }
886
912
  declare enum PluginType {
887
913
  /** 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
914
  PUBLISH = "PUBLISH",
@@ -1130,24 +1156,6 @@ interface DataPermissions {
1130
1156
  */
1131
1157
  itemRemove?: AccessLevelWithLiterals;
1132
1158
  }
1133
- /**
1134
- * Describes who can perform certain actions.
1135
- * Each level includes all levels below it (except UNDEFINED).
1136
- */
1137
- declare enum AccessLevel {
1138
- /** Any subject, including visitors. */
1139
- ANYONE = "ANYONE",
1140
- /** Any signed-in user (both site members and collaborators). */
1141
- SITE_MEMBER = "SITE_MEMBER",
1142
- /** Any signed-in user, but site members only have access to own items. */
1143
- SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
1144
- /** Site collaborator that has a role with CMS Access permission. */
1145
- CMS_EDITOR = "CMS_EDITOR",
1146
- /** CMS administrators and users or roles granted with special access. */
1147
- PRIVILEGED = "PRIVILEGED"
1148
- }
1149
- /** @enumType */
1150
- type AccessLevelWithLiterals = AccessLevel | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
1151
1159
  interface AllowedDataPermissions {
1152
1160
  /** If data items read permitted */
1153
1161
  itemRead?: boolean;
@@ -2158,7 +2166,6 @@ declare function deleteDataCollection(dataCollectionId: string): Promise<void>;
2158
2166
  * @param _id - [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`.
2159
2167
  * For [app collections](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/wix-app-collections/introduction), use `AppName/CollectionName`.
2160
2168
  * @public
2161
- * @documentationMaturity preview
2162
2169
  * @requiredField _id
2163
2170
  * @requiredField dataCollection
2164
2171
  * @permissionId WIX_DATA.UPDATE_COLLECTION
@@ -2327,7 +2334,6 @@ interface DeleteDataCollectionFieldOptions {
2327
2334
  * If a plugin of the same type already exists in the collection, this operation fails.
2328
2335
  * @param dataCollectionId - ID of the data collection to update.
2329
2336
  * @public
2330
- * @documentationMaturity preview
2331
2337
  * @requiredField dataCollectionId
2332
2338
  * @requiredField options
2333
2339
  * @requiredField options.plugin
@@ -2350,7 +2356,6 @@ interface AddDataCollectionPluginOptions {
2350
2356
  * Removing a plugin disables its functionality for the collection.
2351
2357
  * @param dataCollectionId - ID of the data collection to update.
2352
2358
  * @public
2353
- * @documentationMaturity preview
2354
2359
  * @requiredField dataCollectionId
2355
2360
  * @requiredField options
2356
2361
  * @requiredField options.pluginType
@@ -2372,7 +2377,6 @@ interface DeleteDataCollectionPluginOptions {
2372
2377
  * @param dataCollectionId - ID of the data collection to update.
2373
2378
  * @param field - Field to update.
2374
2379
  * @public
2375
- * @documentationMaturity preview
2376
2380
  * @requiredField dataCollectionId
2377
2381
  * @requiredField field
2378
2382
  * @permissionId WIX_DATA.UPDATE_COLLECTION_FIELD
@@ -2381,4 +2385,4 @@ interface DeleteDataCollectionPluginOptions {
2381
2385
  */
2382
2386
  declare function patchDataCollectionField(dataCollectionId: string, field: Field): Promise<NonNullablePaths<PatchDataCollectionFieldResponse, `dataCollection._id` | `dataCollection.collectionType` | `dataCollection.defaultDisplayOrder.fieldKey` | `dataCollection.defaultDisplayOrder.direction` | `dataCollection.capabilities.dataOperations` | `dataCollection.capabilities.collectionOperations` | `dataCollection.capabilities.indexLimits.regular` | `dataCollection.capabilities.indexLimits.unique` | `dataCollection.capabilities.indexLimits.total` | `dataCollection.fields` | `dataCollection.fields.${number}.key` | `dataCollection.fields.${number}.type` | `dataCollection.fields.${number}.typeMetadata.reference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencedCollectionId` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingFieldKey` | `dataCollection.fields.${number}.typeMetadata.multiReference.referencingDisplayName` | `dataCollection.fields.${number}.typeMetadata.array.elementType` | `dataCollection.fields.${number}.systemField` | `dataCollection.fields.${number}.capabilities.sortable` | `dataCollection.fields.${number}.encrypted` | `dataCollection.fields.${number}.condition.permission` | `dataCollection.permissions.insert` | `dataCollection.permissions.update` | `dataCollection.permissions.remove` | `dataCollection.permissions.read` | `dataCollection.plugins` | `dataCollection.plugins.${number}.publishOptions.defaultStatus` | `dataCollection.plugins.${number}.singleItemOptions.singleItemId` | `dataCollection.plugins.${number}.urlizedOptions.format` | `dataCollection.plugins.${number}.editablePageLinkOptions.isPersisted` | `dataCollection.plugins.${number}.editablePageLinkOptions.isMutable` | `dataCollection.plugins.${number}.type` | `dataCollection.pagingModes`, 7>>;
2383
2387
 
2384
- export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type Address, type AllowedDataPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CategoryFieldOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, type DraftItemsPluginOptions, type DraftItemsPluginOptionsPairedCollectionOneOf, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type PermissionsUpdate, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StrictModeUpdate, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, updateDataCollection, updateDataCollectionField };
2388
+ export { AccessLevel, type AccessLevelWithLiterals, type AccountInfo, type ActionEvent, type AddDataCollectionPluginOptions, type AddDataCollectionPluginRequest, type AddDataCollectionPluginResponse, type Address, type AllowedDataPermissions, type AllowedDraftPermissions, type AppOptions, type ApplicationError, type ArrayDocument, type ArraySizeRange, type ArrayString, type Audio, type BulkGetDataCollectionsPageBySnapshotsRequest, type BulkGetDataCollectionsPageBySnapshotsRequestTenantModeOptionsOneOf, type BulkGetDataCollectionsPageBySnapshotsResponse, type BulkGetDataCollectionsRequest, type BulkGetDataCollectionsResponse, type Calculator, type CalculatorPatternOneOf, type CatalogOptions, type CategoryFieldOptions, type CmsOptions, type CollectionCapabilities, type CollectionDefinition, CollectionOperation, type CollectionOperationWithLiterals, CollectionType, type CollectionTypeWithLiterals, type CreateAppCollectionsSnapshotRequest, type CreateAppCollectionsSnapshotResponse, type CreateDataCollectionFieldOptions, type CreateDataCollectionFieldRequest, type CreateDataCollectionFieldResponse, type CreateDataCollectionRequest, type CreateDataCollectionResponse, type CreateDataCollectionsSnapshotRequest, type CreateDataCollectionsSnapshotResponse, type CreateMigratedCollectionsSnapshotRequest, type CreateMigratedCollectionsSnapshotResponse, type DataCollection, type DataCollectionChangedEvent, type DataCollectionClonedEvent, type DataCollectionEvictedEvent, DataOperation, type DataOperationWithLiterals, type DataPermissions, type Datetime, type DatetimeDefaultValueOneOf, type DatetimeMaxDateOneOf, type DatetimeMinDateOneOf, type DeleteDataCollectionFieldOptions, type DeleteDataCollectionFieldRequest, type DeleteDataCollectionFieldResponse, type DeleteDataCollectionPluginOptions, type DeleteDataCollectionPluginRequest, type DeleteDataCollectionPluginResponse, type DeleteDataCollectionRequest, type DeleteDataCollectionResponse, type DeleteDataCollectionsSnapshotRequest, type DeleteDataCollectionsSnapshotResponse, type Destination, Direction, type DirectionWithLiterals, type Document, type DomainEvent, type DomainEventBodyOneOf, type DraftItemsPluginOptions, type DraftItemsPluginOptionsPairedCollectionOneOf, type DraftPermissions, type Email, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EnumValues, type FailedCollection, type Failure, type Field, type FieldCapabilities, type FieldCondition, type FieldPlugin, type FieldPluginOptionsOneOf, FieldPluginType, type FieldPluginTypeWithLiterals, type FieldRangeValidationsOneOf, type FieldUpdate, type FieldsPattern, Format, type FormatWithLiterals, type GetDataCollectionOptions, type GetDataCollectionRequest, type GetDataCollectionResponse, type IdentificationData, type IdentificationDataIdOneOf, type Image, type Index, type IndexField, type IndexLimits, type IndexQuotaLimits, IndexSource, type IndexSourceWithLiterals, IndexStatus, type IndexStatusWithLiterals, type LegacyColor, type ListDataCollectionsOptions, type ListDataCollectionsRequest, type ListDataCollectionsResponse, type MediaGallery, type MessageEnvelope, type MultiReference, type MultilingualOptions, type NumberRange, type ObjectField, Order, type OrderWithLiterals, type PageLink, type PageLinkPluginOptions, PageLinkType, type PageLinkTypeWithLiterals, type Paging, type PagingMetadataV2, PagingMode, type PagingModeWithLiterals, type PatchDataCollection, type PatchDataCollectionFieldRequest, type PatchDataCollectionFieldResponse, type PatchDataCollectionRequest, type PatchDataCollectionResponse, Permission, type PermissionWithLiterals, type Permissions, type PermissionsUpdate, type Plugin, type PluginCmsOptions, type PluginOptionsOneOf, PluginType, type PluginTypeWithLiterals, type PluginUpdate, type PublishPluginOptions, QueryOperator, type QueryOperatorWithLiterals, type Reference, type RestorationCollection, type RestoreDataCollectionRequest, type RestoreDataCollectionResponse, type RestoreDataCollectionsFromSnapshotRequest, type RestoreDataCollectionsFromSnapshotResponse, type RestoreInfo, type RichContent, type RichText, Role, type RoleWithLiterals, Segment, type SegmentWithLiterals, type SingleItemPluginOptions, type SiteSort, type Slug, type SnapshotCollection, type Sort, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, type StrictModeUpdate, type StringLengthRange, TenantMode, type TenantModeWithLiterals, type Text, type TextValidation, type TextValidationOneOf, type Time, Type, type TypeMetadata, type TypeMetadataMetadataOneOf, type TypeWithLiterals, type UpdateDataCollectionFieldOptions, type UpdateDataCollectionFieldRequest, type UpdateDataCollectionFieldResponse, type UpdateDataCollectionRequest, type UpdateDataCollectionResponse, type UpdateDataPermissionsRequest, type UpdateDataPermissionsResponse, type Url, type UrlizedOnlyPattern, type UrlizedPluginOptions, type Video, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type _Array, type _Boolean, type _Date, type _DateDefaultValueOneOf, type _DateMaxDateOneOf, type _DateMinDateOneOf, type _Number, type _Object, addDataCollectionPlugin, createDataCollection, createDataCollectionField, deleteDataCollection, deleteDataCollectionField, deleteDataCollectionPlugin, getDataCollection, listDataCollections, patchDataCollection, patchDataCollectionField, updateDataCollection, updateDataCollectionField };
@@ -1396,6 +1396,14 @@ var Format = /* @__PURE__ */ ((Format2) => {
1396
1396
  Format2["PLAIN"] = "PLAIN";
1397
1397
  return Format2;
1398
1398
  })(Format || {});
1399
+ var AccessLevel = /* @__PURE__ */ ((AccessLevel2) => {
1400
+ AccessLevel2["ANYONE"] = "ANYONE";
1401
+ AccessLevel2["SITE_MEMBER"] = "SITE_MEMBER";
1402
+ AccessLevel2["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
1403
+ AccessLevel2["CMS_EDITOR"] = "CMS_EDITOR";
1404
+ AccessLevel2["PRIVILEGED"] = "PRIVILEGED";
1405
+ return AccessLevel2;
1406
+ })(AccessLevel || {});
1399
1407
  var PluginType = /* @__PURE__ */ ((PluginType2) => {
1400
1408
  PluginType2["PUBLISH"] = "PUBLISH";
1401
1409
  PluginType2["SINGLE_ITEM"] = "SINGLE_ITEM";
@@ -1412,14 +1420,6 @@ var PagingMode = /* @__PURE__ */ ((PagingMode2) => {
1412
1420
  PagingMode2["CURSOR"] = "CURSOR";
1413
1421
  return PagingMode2;
1414
1422
  })(PagingMode || {});
1415
- var AccessLevel = /* @__PURE__ */ ((AccessLevel2) => {
1416
- AccessLevel2["ANYONE"] = "ANYONE";
1417
- AccessLevel2["SITE_MEMBER"] = "SITE_MEMBER";
1418
- AccessLevel2["SITE_MEMBER_AUTHOR"] = "SITE_MEMBER_AUTHOR";
1419
- AccessLevel2["CMS_EDITOR"] = "CMS_EDITOR";
1420
- AccessLevel2["PRIVILEGED"] = "PRIVILEGED";
1421
- return AccessLevel2;
1422
- })(AccessLevel || {});
1423
1423
  var Segment = /* @__PURE__ */ ((Segment2) => {
1424
1424
  Segment2["UNKNOWN_SEGMENT"] = "UNKNOWN_SEGMENT";
1425
1425
  Segment2["PUBLIC"] = "PUBLIC";