@wix/data 1.0.175 → 1.0.176

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/data",
-  "version": "1.0.175",
+  "version": "1.0.176",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,7 +22,7 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/data_collections": "1.0.61",
+    "@wix/data_collections": "1.0.62",
     "@wix/data_external-database": "1.0.27",
     "@wix/data_external-database-connections": "1.0.49",
     "@wix/data_indexes": "1.0.44",
@@ -51,5 +51,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "966c7b4d53d2c0c264b3bfa8c0690739df47389142229e60710f63b5"
+  "falconPackageHash": "1418048968a1f04acac2ba30fb27b66efe016a8aa45757d2e3f841e8"
 }

package/type-bundles/context.bundle.d.ts

@@ -1035,12 +1035,12 @@ interface DataCollection {
     /** Collection ID. For example, `my-first-collection`. May include a namespace. */
     _id?: string;
     /**
-     * Collection type. Indicates how the collection was created and is stored.
+     * Collection type. Indicates how the collection was created and how it is stored.
      * @readonly
      */
     collectionType?: CollectionType;
     /**
-     * ID of the app that defined this collection. For user-defined collections, this value is null.
+     * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
      * @readonly
      */
     ownerAppId?: string | null;
@@ -1054,17 +1054,17 @@ interface DataCollection {
     /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
     displayName?: string | null;
     /**
-     * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
+     * Default item sorting order when a query doesn't specify one.
      * @readonly
      */
     defaultDisplayOrder?: Sort;
     /**
      * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
-     * Empty for all data collections not owned by internal Wix apps.
+     * Empty for all data collections not owned by Wix apps.
      * @readonly
      */
     displayNamespace?: string | null;
-    /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
+    /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
@@ -1076,14 +1076,14 @@ interface DataCollection {
     /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
     permissions?: Permissions;
     /**
-     * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
+     * 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.
      * @readonly
      */
     revision?: string | null;
-    /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
+    /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
     plugins?: Plugin[];
     /**
-     * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
+     * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
      * @readonly
      */
     pagingModes?: PagingMode[];
@@ -1123,7 +1123,11 @@ declare enum Direction {
     DESC = "DESC"
 }
 interface CollectionCapabilities {
-    /** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
+    /**
+     * Data operations the collection supports. The listed operations can be performed on data the collection contains.
+     *
+     * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
+     */
     dataOperations?: DataOperation[];
     /** Collection operations supported. The listed operations can be performed on the collection itself. */
     collectionOperations?: CollectionOperation[];
@@ -1176,14 +1180,14 @@ interface Field$1 extends FieldRangeValidationsOneOf {
     arraySizeRange?: ArraySizeRange;
     /** Unique identifier for the field. For example, `firstName`. */
     key?: string;
-    /** Field's display name when shown in the CMS. For example, `First Name`. */
+    /** Field's display name when displayed in the CMS. For example, `First Name`. */
     displayName?: string | null;
     /** Field's data type. */
     type?: Type;
     /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
     typeMetadata?: TypeMetadata;
     /**
-     * Whether the field is a system field (created automatically).
+     * Whether the field is a system field.
      * @readonly
      */
     systemField?: boolean;
@@ -1192,9 +1196,9 @@ interface Field$1 extends FieldRangeValidationsOneOf {
      * @readonly
      */
     capabilities?: FieldCapabilities;
-    /** Indicates if field is encrypted. */
+    /** Whether the field is encrypted. */
     encrypted?: boolean;
-    /** Description of the field. */
+    /** Field description. */
     description?: string | null;
     plugin?: string | null;
     /**
@@ -1300,11 +1304,7 @@ interface FieldCapabilities {
      * Default: `false`
      */
     sortable?: boolean;
-    /**
-     * Query operators that can be used for this field.
-     *
-     * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
-     */
+    /** Query operators that can be used for this field. */
     queryOperators?: QueryOperator[];
 }
 declare enum QueryOperator {
@@ -1619,9 +1619,9 @@ interface AllowedDataPermissions {
     itemRemove?: boolean;
 }
 interface DataCollectionClonedEvent {
-    /** original instance collection is cloned from */
+    /** Instance ID of the collection from which the data is cloned. */
     originInstanceId?: string;
-    /** original collection ID, may be same as current one */
+    /** ID of the collection from which the data is cloned. */
     originId?: string;
 }
 interface DataCollectionChangedEvent {
@@ -2340,14 +2340,14 @@ interface UpdateDataCollectionSignature {
     /**
      * Updates a data collection.
      *
-     * A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
+     * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
      * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
      * Otherwise, the request fails.
      *
-     * When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
+     * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
      *
      * > **Note:**
-     * > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
+     * > 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
      * > aren't included in the updated collection details, their values are lost.
      * @param - Updated collection details. The existing collection is replaced with this version.
      * @param - Options for updating a data collection.

package/type-bundles/index.bundle.d.ts

@@ -1035,12 +1035,12 @@ interface DataCollection {
     /** Collection ID. For example, `my-first-collection`. May include a namespace. */
     _id?: string;
     /**
-     * Collection type. Indicates how the collection was created and is stored.
+     * Collection type. Indicates how the collection was created and how it is stored.
      * @readonly
      */
     collectionType?: CollectionType;
     /**
-     * ID of the app that defined this collection. For user-defined collections, this value is null.
+     * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
      * @readonly
      */
     ownerAppId?: string | null;
@@ -1054,17 +1054,17 @@ interface DataCollection {
     /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
     displayName?: string | null;
     /**
-     * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
+     * Default item sorting order when a query doesn't specify one.
      * @readonly
      */
     defaultDisplayOrder?: Sort;
     /**
      * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
-     * Empty for all data collections not owned by internal Wix apps.
+     * Empty for all data collections not owned by Wix apps.
      * @readonly
      */
     displayNamespace?: string | null;
-    /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
+    /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
@@ -1076,14 +1076,14 @@ interface DataCollection {
     /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
     permissions?: Permissions;
     /**
-     * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
+     * 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.
      * @readonly
      */
     revision?: string | null;
-    /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
+    /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
     plugins?: Plugin[];
     /**
-     * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
+     * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
      * @readonly
      */
     pagingModes?: PagingMode[];
@@ -1123,7 +1123,11 @@ declare enum Direction {
     DESC = "DESC"
 }
 interface CollectionCapabilities {
-    /** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
+    /**
+     * Data operations the collection supports. The listed operations can be performed on data the collection contains.
+     *
+     * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
+     */
     dataOperations?: DataOperation[];
     /** Collection operations supported. The listed operations can be performed on the collection itself. */
     collectionOperations?: CollectionOperation[];
@@ -1176,14 +1180,14 @@ interface Field$1 extends FieldRangeValidationsOneOf {
     arraySizeRange?: ArraySizeRange;
     /** Unique identifier for the field. For example, `firstName`. */
     key?: string;
-    /** Field's display name when shown in the CMS. For example, `First Name`. */
+    /** Field's display name when displayed in the CMS. For example, `First Name`. */
     displayName?: string | null;
     /** Field's data type. */
     type?: Type;
     /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
     typeMetadata?: TypeMetadata;
     /**
-     * Whether the field is a system field (created automatically).
+     * Whether the field is a system field.
      * @readonly
      */
     systemField?: boolean;
@@ -1192,9 +1196,9 @@ interface Field$1 extends FieldRangeValidationsOneOf {
      * @readonly
      */
     capabilities?: FieldCapabilities;
-    /** Indicates if field is encrypted. */
+    /** Whether the field is encrypted. */
     encrypted?: boolean;
-    /** Description of the field. */
+    /** Field description. */
     description?: string | null;
     plugin?: string | null;
     /**
@@ -1300,11 +1304,7 @@ interface FieldCapabilities {
      * Default: `false`
      */
     sortable?: boolean;
-    /**
-     * Query operators that can be used for this field.
-     *
-     * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
-     */
+    /** Query operators that can be used for this field. */
     queryOperators?: QueryOperator[];
 }
 declare enum QueryOperator {
@@ -1619,9 +1619,9 @@ interface AllowedDataPermissions {
     itemRemove?: boolean;
 }
 interface DataCollectionClonedEvent {
-    /** original instance collection is cloned from */
+    /** Instance ID of the collection from which the data is cloned. */
     originInstanceId?: string;
-    /** original collection ID, may be same as current one */
+    /** ID of the collection from which the data is cloned. */
     originId?: string;
 }
 interface DataCollectionChangedEvent {
@@ -2340,14 +2340,14 @@ interface UpdateDataCollectionSignature {
     /**
      * Updates a data collection.
      *
-     * A collection ID, revision number, permissions, and at least 1 field must be provided within `options.collection`.
+     * A collection ID, revision number, permissions, and at least 1 field must be provided within the `collection` body parameter.
      * If a collection with that ID exists, and if its current `revision` number matches the one provided, it is updated.
      * Otherwise, the request fails.
      *
-     * When a collection is updated, its `_updatedDate` property is changed to the current date and its `revision` property is incremented.
+     * When a collection is updated, its `updatedDate` property is changed to the current date and its `revision` property is incremented.
      *
      * > **Note:**
-     * > After a collection is updated, it only contains the properties included in the `updateDataCollection()` call. If the existing collection has properties with values and those properties
+     * > 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
      * > aren't included in the updated collection details, their values are lost.
      * @param - Updated collection details. The existing collection is replaced with this version.
      * @param - Options for updating a data collection.

package/type-bundles/meta.bundle.d.ts

@@ -478,12 +478,12 @@ interface DataCollection$1 {
     /** Collection ID. For example, `my-first-collection`. May include a namespace. */
     id?: string;
     /**
-     * Collection type. Indicates how the collection was created and is stored.
+     * Collection type. Indicates how the collection was created and how it is stored.
      * @readonly
      */
     collectionType?: CollectionType$1;
     /**
-     * ID of the app that defined this collection. For user-defined collections, this value is null.
+     * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
      * @readonly
      */
     ownerAppId?: string | null;
@@ -497,17 +497,17 @@ interface DataCollection$1 {
     /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
     displayName?: string | null;
     /**
-     * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
+     * Default item sorting order when a query doesn't specify one.
      * @readonly
      */
     defaultDisplayOrder?: Sort$1;
     /**
      * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
-     * Empty for all data collections not owned by internal Wix apps.
+     * Empty for all data collections not owned by Wix apps.
      * @readonly
      */
     displayNamespace?: string | null;
-    /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
+    /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
@@ -519,14 +519,14 @@ interface DataCollection$1 {
     /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
     permissions?: Permissions$1;
     /**
-     * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
+     * 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.
      * @readonly
      */
     revision?: string | null;
-    /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
+    /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
     plugins?: Plugin$1[];
     /**
-     * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
+     * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
      * @readonly
      */
     pagingModes?: PagingMode$1[];
@@ -623,14 +623,14 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
     arraySizeRange?: ArraySizeRange$1;
     /** Unique identifier for the field. For example, `firstName`. */
     key?: string;
-    /** Field's display name when shown in the CMS. For example, `First Name`. */
+    /** Field's display name when displayed in the CMS. For example, `First Name`. */
     displayName?: string | null;
     /** Field's data type. */
     type?: Type$1;
     /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
     typeMetadata?: TypeMetadata$1;
     /**
-     * Whether the field is a system field (created automatically).
+     * Whether the field is a system field.
      * @readonly
      */
     systemField?: boolean;
@@ -639,9 +639,9 @@ interface Field$3 extends FieldRangeValidationsOneOf$1 {
      * @readonly
      */
     capabilities?: FieldCapabilities$1;
-    /** Indicates if field is encrypted. */
+    /** Whether the field is encrypted. */
     encrypted?: boolean;
-    /** Description of the field. */
+    /** Field description. */
     description?: string | null;
     plugin?: string | null;
     /**
@@ -1299,12 +1299,12 @@ interface DataCollection {
     /** Collection ID. For example, `my-first-collection`. May include a namespace. */
     _id?: string;
     /**
-     * Collection type. Indicates how the collection was created and is stored.
+     * Collection type. Indicates how the collection was created and how it is stored.
      * @readonly
      */
     collectionType?: CollectionType;
     /**
-     * ID of the app that defined this collection. For user-defined collections, this value is null.
+     * ID of the app that defined this collection. For collections defined by Wix users, this value is null.
      * @readonly
      */
     ownerAppId?: string | null;
@@ -1318,17 +1318,17 @@ interface DataCollection {
     /** Collection's display name as shown in the CMS. For example, `My First Collection`. */
     displayName?: string | null;
     /**
-     * Indicates how the collection's items are sorted by default when a query doesn't specify an order.
+     * Default item sorting order when a query doesn't specify one.
      * @readonly
      */
     defaultDisplayOrder?: Sort;
     /**
      * UI-friendly namespace of the Wix app with which the data collection is associated, such as Stores or Bookings.
-     * Empty for all data collections not owned by internal Wix apps.
+     * Empty for all data collections not owned by Wix apps.
      * @readonly
      */
     displayNamespace?: string | null;
-    /** The field whose value the CMS displays to represent the collection item when referenced in a different collection. */
+    /** Field whose value the CMS displays to represent the collection item when referenced in a different collection. */
     displayField?: string | null;
     /**
      * Capabilities the collection supports.
@@ -1340,14 +1340,14 @@ interface DataCollection {
     /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
     permissions?: Permissions;
     /**
-     * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must pass the latest revision number.
+     * 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.
      * @readonly
      */
     revision?: string | null;
-    /** All plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
+    /** Plugins the collection uses. Plugins apply additional capabilities to the collection or extend its functionality. */
     plugins?: Plugin[];
     /**
-     * All paging modes the collection supports. In native collections, offset-based paging is supported by default.
+     * Paging modes the collection supports. In native collections, offset-based paging is supported by default.
      * @readonly
      */
     pagingModes?: PagingMode[];
@@ -1387,7 +1387,11 @@ declare enum Direction {
     DESC = "DESC"
 }
 interface CollectionCapabilities {
-    /** Data operations the collection supports. The listed operations can be performed on data the collection contains. */
+    /**
+     * Data operations the collection supports. The listed operations can be performed on data the collection contains.
+     *
+     * > **Note**: The `PATCH` and `BULK_PATCH` oeprations aren't currently supported.
+     */
     dataOperations?: DataOperation[];
     /** Collection operations supported. The listed operations can be performed on the collection itself. */
     collectionOperations?: CollectionOperation[];
@@ -1440,14 +1444,14 @@ interface Field$2 extends FieldRangeValidationsOneOf {
     arraySizeRange?: ArraySizeRange;
     /** Unique identifier for the field. For example, `firstName`. */
     key?: string;
-    /** Field's display name when shown in the CMS. For example, `First Name`. */
+    /** Field's display name when displayed in the CMS. For example, `First Name`. */
     displayName?: string | null;
     /** Field's data type. */
     type?: Type;
     /** Metadata for complex data types. This property only exists for references, multi-references, objects, and arrays. */
     typeMetadata?: TypeMetadata;
     /**
-     * Whether the field is a system field (created automatically).
+     * Whether the field is a system field.
      * @readonly
      */
     systemField?: boolean;
@@ -1456,9 +1460,9 @@ interface Field$2 extends FieldRangeValidationsOneOf {
      * @readonly
      */
     capabilities?: FieldCapabilities;
-    /** Indicates if field is encrypted. */
+    /** Whether the field is encrypted. */
     encrypted?: boolean;
-    /** Description of the field. */
+    /** Field description. */
     description?: string | null;
     plugin?: string | null;
     /**
@@ -1564,11 +1568,7 @@ interface FieldCapabilities {
      * Default: `false`
      */
     sortable?: boolean;
-    /**
-     * Query operators that can be used for this field.
-     *
-     * Supported values: `EQ`, `LT`, `GT`, `NE`, `LTE`, `GTE`, `STARTS_WITH`, `ENDS_WITH`, `CONTAINS`, `HAS_SOME`, `HAS_ALL`, `EXISTS`, `URLIZED`.
-     */
+    /** Query operators that can be used for this field. */
     queryOperators?: QueryOperator[];
 }
 declare enum QueryOperator {