@wix/wix-data-items-sdk 1.0.223 → 1.0.225

package/build/cjs/src/data-v2-data-item-items.universal.d.ts

@@ -12,11 +12,7 @@ import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggreg
  * existing ID in the collection. Meaning, `insert()` cannot overwrite an
  * existing item in the collection.
  *
- * Calling the `insert()` method triggers the `beforeInsert()` and
- * `afterInsert()` hooks if they have been defined.
- *
- * Use the `options` parameter to run `insert()` from backend code without
- * checking for permissions or without its registered hooks.
+ * Calling the `insert()` method triggers the [`beforeInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-insert) and [`afterInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-insert) hooks if they have been defined.
  *
  * When inserting an item into a collection that has a reference field, set the
  * value of the reference field to the referenced item's `_id` value or the entire referenced item object.
@@ -31,21 +27,15 @@ import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggreg
  *   added, the `_createdDate` and `_updatedDate` are the same.
  *
  * Any valid JavaScript object can be added as a property value. The `insert()`
- * method maintains the structure of the specified object. For example, objects that contain nested objects, Arrays, or Arrays with nested objects are all added to the collection as defined.
+ * method maintains the structure of the specified object. For example, objects that contain nested objects, arrays, or arrays with nested objects are all added to the collection as defined.
  *
- * The maximum size of an item that you can add to a collection is 500kb.
  *
  * > **Notes:**
- * > - If an item's `_id` property value is set to `null` or an empty string,
- *     an error is thrown.
- * > - When creating a Single Item Collection, an item with the system field
- * >   `_id` is pre-inserted into the collection. Single Item Collections may
- * >   contain only one item.
- * > - If there is a pre-existing item in a Single Item Collection, the
- * >   `insert()` method will not run. To update or change an item in a
- * >   Single Item Collection see the `update()` and `save()` methods.
- * > - The `insert()` method does not support multi-reference fields. For
- * >   multi-reference fields, use `insertReference()`.
+ * > - The maximum size of an item that you can add to a collection is 500kb.
+ * > - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.
+ * > - When creating a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection), an item with the system field `_id` is pre-inserted into the collection. [Single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection) may contain only one item.
+ * > - If there is a pre-existing item in a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection), the `insert()` method will not run. To update or change an item in a single-item collection see the `update()` and `save()` methods.
+ * > - The `insert()` method does not support multi-reference fields. For  multi-reference fields, use `insertReference()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `insert()` fails and issues an error.
  * @public
  * @param dataCollectionId - ID of the collection item belongs to.
@@ -65,8 +55,7 @@ export declare function insert(dataCollectionId: string, item: Partial<WixDataIt
  * the specified collection. The Promise is rejected if the current user does not
  * have update permissions for the collection.
  *
- * Calling the `update()` method triggers the `beforeUpdate()` and `afterUpdate()`
- * hooks if they have been defined.
+ * Calling the `update()` method triggers the [`beforeUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-update) and [`afterUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-update) hooks if they have been defined.
  *
  * The `update()` method compares the `_id` property of the specified item
  * with the `_id` property values of the items in the specified collection. If
@@ -78,12 +67,9 @@ export declare function insert(dataCollectionId: string, item: Partial<WixDataIt
  *
  * Any valid JavaScript object can be used as a property value. The `update()`
  * method maintains the structure of the specified object. For example,
- * objects that contain nested objects, Arrays, or Arrays with nested objects
+ * objects that contain nested objects, arrays, or arrays with nested objects
  * are all added to the collection as defined.
  *
- * Use the `options` parameter to run `update()` from backend code without
- * checking for permissions or without its registered hooks.
- *
  * When updating an item in a collection that has a reference field, set the
  * value of the reference field to the referenced item's `_id` value or the
  * entire referenced item object.
@@ -123,24 +109,20 @@ export declare function update(dataCollectionId: string, item: WixDataItem, opti
  * If none of the items in the collection contain that `_id` value, the
  * specified item does not have an `_id` property, or if the specified item's
  * id property is `undefined`, `save()` uses `insert()` to add the specified
- * item to the collection. This triggers the `beforeInsert()` and
- * `afterInsert()` hooks if they have been defined.
+ * item to the collection. This triggers the [`beforeInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-insert) and
+ * [`afterInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-insert) hooks if they have been defined.
  *
- * Use the `options` parameter to run `save()` from backend code without
- * checking for permissions or without its registered hooks.
  *
  * When saving an item to a collection that has a reference field, set the
  * value of the reference field to the referenced item's `_id` value or the
  * entire referenced item object.
  *
- * The maximum size of an item that you can save to a collection is 500kb.
- *
  * > **Notes:**
- * > - If an item's `_id` property value is set to null or an empty string, an
- * >   error is thrown.
- * > - The `save()` method does not support multi-reference fields. For
- * >   multi-reference fields, use `insertReference() `or `replaceReferences()`.
+ * > - The maximum size of an item that you can save to a collection is 500kb.
+ * > - If an item's `_id` property value is set to null or an empty string, an error is thrown.
+ * > - The `save()` method does not support multi-reference fields. For multi-reference fields, use `insertReference() `or `replaceReferences()`.
  * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `save()` fails and issues an error.
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -164,23 +146,14 @@ export declare function save(dataCollectionId: string, item: Partial<WixDataItem
  * referenced item is returned. To return the values of the referenced items
  * use `query()` and `include()`.
  *
- * If the `get()` method is passed the ID of a hidden item, it returns null.
+ * If the `get()` method is passed the ID of [a hidden item](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection), it returns null.
  *
- * Calling the `get()` method triggers the `beforeGet()` and `afterGet()`
- * hooks if they have been defined.
- *
- * Use the `options` parameter to run `get()` from backend code without
- * checking for permissions or without its registered hooks.
+ * Calling the `get()` method triggers the [`beforeGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-get) and [`afterGet()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-get) hooks if they have been defined.
  *
  * > **Notes:**
- * > - When using the `query()` or `get()` methods or another data retrieval
- * >   method following a change to your database collection, the data
- * >   retrieved may not contain your most recent changes. See Wix-data and
- * >   Eventual Consistency for more information. To solve this problem, you
- * >   can use the `setTimeout()` method to delay retrieving data following
- * >   any changes to your database collection.
- * > - An `itemId` is required to retrieve an item even from a single-item
- * >   collection.
+ * > - When using the `query()` or `get()` methods or another data retrieval method immediately following a change to your database collection, the data retrieved may not contain your most recent changes. Learn more about [Wix Data and Eventual Consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). To solve this, you can use the `setTimeout()` method to delay retrieving data following any changes to your database collection.
+ * > - An `itemId` is required to retrieve an item even from a [single-item collection](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+ *
  * @param dataCollectionId - ID of the collection item belongs to.
  * @param itemId - ID of the data item to retrieve.
  * @param options - Options to use when processing this operation.
@@ -201,19 +174,11 @@ export declare function get(dataCollectionId: string, itemId: string, options?:
  * rejected if the current user does not have "delete" permissions for the
  * collection.
  *
- * Calling the `remove()` method triggers the `beforeRemove()` and
- * `afterRemove()` hooks if they have been defined.
+ * Calling the `remove()` method triggers the [`beforeRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-remove) and [`afterRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-remove) hooks if they have been defined.
  *
- * Use the `options` parameter to run `remove()` from backend code without
- * checking for permissions or without its registered hooks.
  *
- * > **Notes:**
- * > The `remove()` method also clears multiple-item reference fields for
- * > items in collections referenced by the specified item. For example,
- * > suppose you have a **Movies** collection with an **Actors** field that
- * > contains multiple references to items in a **People** collection. Removing
- * > an item in the **Movies** collection also clears the data in the
- * > corresponding multiple-item reference fields in the **People** collection.
+ * > **Note:** The `remove()` method also clears multiple-item reference fields for items in collections referenced by the specified item. For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references to items in a **People** collection. Removing an item in the **Movies** collection also clears the data in the corresponding multiple-item reference fields in the **People** collection.
+ *
  * @param dataCollectionId - ID of the collection that contains the item.
  * @param itemId - ID of the item to remove.
  * @param options - Object containing options to use when processing this operation.
@@ -231,19 +196,10 @@ export declare function remove(dataCollectionId: string, itemId: string, options
  * The `truncate()` method returns a Promise that resolves after all items
  * have been removed from the specified collection.
  *
- * `truncate()` runs when at least one of the following is true:
- * - The current user is the site owner.
- * - The request is performed in backend code with a `suppressAuth` options
- * value of `true`.
+ * `truncate()` runs when the current user is the site owner, or when the method is called with [elevated permissions](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-elevated-permissions).
  *
- * Calling the `truncate()` method does not trigger any hooks.
+ * > **Note:** `truncate()` also clears multiple-item reference fields in collections referenced by the specified collection. For example, suppose you have a **Movies** collection with an **Actors** field that contains multiple references to items in a People collection. Truncating the **Movies** collection also clears the data in the corresponding multiple-item reference field in the People collection.
  *
- * > **Note:** `truncate()` also clears multiple-item reference fields in
- * > collections referenced by the specified collection. For example, suppose you
- * > have a **Movies** collection with an **Actors** field that contains multiple
- * > references to items in a People collection. Truncating the **Movies**
- * > collection also clears the data in the corresponding multiple-item reference
- * > field in the People collection.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -259,15 +215,10 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
  * have been added to the specified collection. The Promise is rejected if the
  * current user does not have "create" permissions for the collection. Items
  * are skipped if they include an `_id` property whose value matches an
- * existing ID in the collection. Meaning, `bulkInsert()` cannot overwrite an
+ * existing ID in the collection. This means that `bulkInsert()` cannot overwrite an
  * existing item in the collection.
  *
- * Calling the `bulkInsert()` method triggers the `beforeInsert()` and
- * `afterInsert()` hooks for each item that is inserted if the hooks have been
- * defined.
- *
- * Use the options parameter to run `bulkInsert()` from backend code without
- * checking for permissions or without its registered hooks.
+ * Calling the `bulkInsert()` method triggers the [`beforeInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-insert) and [`afterInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-insert) events for each item that is inserted, if these events have been defined.
  *
  * When inserting items into a collection that has a reference field, set the
  * values of the reference fields to the referenced item's `_id` value or the
@@ -285,19 +236,17 @@ export declare function truncate(dataCollectionId: string): Promise<void>;
  *
  * Any valid JavaScript object can be added as a property value. The
  * `bulkInsert()` method maintains the structure of the specified object. For
- * example, objects that contain nested objects, Arrays, or Arrays with nested
+ * example, objects that contain nested objects, arrays, or arrays with nested
  * objects are all added to the collection as defined.
  *
- * The maximum size of an item that you can add to a collection is 500kb.
  *
  * > **Notes:**
- * > - If an item's `_id` property value is set to `null` or an empty string,
- * >   an error is thrown.
+ * > - The maximum size of an item that you can add to a collection is 500kb.
+ * > - If an item's `_id` property value is set to `null` or an empty string, an error is thrown.
  * > - Bulk operations are limited to 1000 items per method call.
- * > - The `bulkInsert()` method is not supported for Single Item Collections.
- * > - The `bulkInsert()` method does not support multi-reference fields. For
- * >   multi-reference fields, use `insertReference()`.
- * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling bulkInsert() fails and issues an error.
+ * > - The `bulkInsert()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+ * > - The `bulkInsert()` method does not support multi-reference fields. For multi-reference fields, use `insertReference()`.
+ * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkInsert()` fails and issues an error.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -319,39 +268,32 @@ export declare function bulkInsert(dataCollectionId: string, items: Partial<WixD
  * existing ID in the collection. Meaning, `bulkUpdate()` cannot add new items
  * into the collection.
  *
- * Calling the `bulkUpdate()` method triggers the `beforeUpdate()` and
- * `afterUpdate()` hooks for each item that is updated if the hooks have been
- * defined.
+ * Calling the `bulkUpdate()` method triggers the [`beforeUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-udpate) and [`afterUpdate()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-update) hooks for each item that is updated if the hooks have been defined.
  *
- * The `bulkUpdate()` method compares the `_id` property of the specified
- * items with the `_id` property values of the items in the specified
- * collection.
+ * The `bulkUpdate()` method compares the `_id` property of the specified items with the `_id` property values of the items in the specified collection.
  *
  * > **Warning:**
- * >  If an existing item in the specified collection matches the `_id` of the specified item, `bulkUpdate()` replaces the existing item's property values with the ones in the specified item. **If the existing item had properties with values and those properties were not included in the specified item, the values in those properties are lost.**
- * >
- * > The item's `_updatedDate` property is also updated to the current date.
+ * > If an existing item in the specified collection matches the `_id` of the specified item, `bulkUpdate()` replaces the existing item's property values with the ones in the specified item. If the existing item had properties with values and those properties are not included in the specified item, the values in those properties are lost.
+ *
+ * The item's `_updatedDate` property is also updated to the current date.
  *
  * Any valid JavaScript object can be used as a property value. The
  * `bulkUpdate()` method maintains the structure of the specified object. For
- * example, objects that contain nested objects, Arrays, or Arrays with nested
+ * example, objects that contain nested objects, arrays, or arrays with nested
  * objects are all added to the collection as defined.
  *
- * Use the options parameter to run `bulkUpdate()` from backend code without
- * checking for permissions or without its registered hooks.
  *
  * When updating items in a collection that has a reference field, set the
  * values of the reference field to the referenced item's `_id` value or the
  * entire referenced item object.
  *
- * The maximum size of an item that you can update in a collection is 500kb.
- *
  * > **Notes:**
+ * > - The maximum size of an item that you can update in a collection is 500kb.
  * > - Bulk operations are limited to 1000 items per method call.
- * > - The `bulkUpdate()` method is not supported for Single Item Collections.
- * > - The `bulkUpdate()` method does not support multi-reference fields. For
- * >   multi-reference fields, use `replaceReferences()` or `insertReference()`.
- * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling bulkUpdate() fails and issues an error.
+ * > - The `bulkUpdate()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+ * > - The `bulkUpdate()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`.
+ * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkUpdate()` fails and issues an error.
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -383,27 +325,20 @@ export declare function bulkUpdate(dataCollectionId: string, items: WixDataItem[
  * - If none of the items in the collection contain that `_id` value, the
  *   specified item does not have an `_id` property, or if the specified item's
  *   `_id` property is `undefined`, `bulkSave()` uses `insert()` to add the
- *   specified item into the collection. This triggers the `beforeInsert()` and
- *   `afterInsert()` hooks for that item if they have been defined.
- *
- * Use the `options` parameter to run `bulkSave()` from backend code without
- * checking for permissions or without its registered hooks.
+ *   specified item into the collection. This triggers the [`beforeInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-insert) and [`afterInsert()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-insert) hooks for that item if they have been defined.
  *
  * When saving items to a collection that has a reference field, set the values
  * of the reference fields to the referenced item's `_id` value or the entire
  * referenced item object.
  *
- * The maximum size of an item that you can save to a collection is 500kb.
- *
  * > **Notes:**
- * > - If an item's `_id` property value is set to null or an empty string, an
- * >   error is thrown.
+ * > - The maximum size of an item that you can save to a collection is 500kb.
+ * > - If an item's `_id` property value is set to null or an empty string, an error is thrown.
  * > - Bulk operations are limited to 1000 items per method call.
- * > - The `bulkSave()` method is not supported for Single Item Collections.
- * > - The `bulkSave()` method does not support multi-reference fields. For
- * >   multi-reference fields, use `replaceReferences()` or
- * >   `insertReference()`.
- * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling bulkSave() fails and issues an error.
+ * > - The `bulkSave()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+ * > - The `bulkSave()` method does not support multi-reference fields. For multi-reference fields, use `replaceReferences()` or `insertReference()`.
+ * > - [Translatable collections](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content) do not allow insertion and modification of items when working in a non-primary language. For example, if a collection's primary language is English, and the site visitor is viewing the site in French, calling `bulkSave()` fails and issues an error.
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -418,19 +353,9 @@ export declare function bulkSave(dataCollectionId: string, items: Partial<WixDat
 /**
  * Removes a number of items from a collection.
  *
- * The `bulkRemove()` method returns a Promise that resolves after the items
- * have been removed from the specified collection. The Promise is rejected if
- * the current user does not have "delete" permissions for the collection. If
- * the delete permissions for the collection are set to Site member author, the
- * only items that are deleted are those for which the current user is the
- * owner. All other items are skipped.
- *
- * Calling the `bulkRemove()` method triggers the `beforeRemove()` and
- * `afterRemove()` hooks for each item that is deleted if the hooks have been
- * defined.
+ * The `bulkRemove()` method returns a Promise that resolves after the items have been removed from the specified collection. The Promise is rejected if the current user does not have "delete" permissions for the collection. If the delete permissions for the collection are assigned to [**Item's creator**](https://support.wix.com/en/article/cms-collection-permissions-overview#set-custom-permissions-for-more-access-control), the only items that are deleted are those for which the current user is the owner. All other items are skipped.
  *
- * Use the options parameter to run `bulkRemove()` from backend code without
- * checking for permissions or without its registered hooks.
+ * Calling the `bulkRemove()` method triggers the [`beforeRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/before-remove) and [`afterRemove()`](https://dev.wix.com/docs/velo/api-reference/wix-data/hooks/after-remove) hooks for each item that is deleted if the hooks have been defined.
  *
  * > **Notes:**
  * > - The `bulkRemove()` method also clears multiple-item reference fields
@@ -440,6 +365,7 @@ export declare function bulkSave(dataCollectionId: string, items: Partial<WixDat
  * >   Removing items in the **Movies** collection also clears the data in the
  * >   corresponding multiple-item reference fields in the People collection.
  * > - Bulk operations are limited to 1000 items per method call.
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -456,10 +382,8 @@ export declare function bulkRemove(dataCollectionId: string, itemIds: string[],
  *
  * The `isReferenced()` method returns a Promise that resolves to true if the referring item contains a reference to the referenced item in the specified field. The Promise is rejected if the current user does not have read permissions for the collection.
  *
- * Calling the `isReferenced()` method does not trigger any hooks.
+ * > **Note:** The `isReferenced()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
  *
- * > **Note:** The `isReferenced()` method is not supported for Single Item
- * > Collections.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -486,8 +410,6 @@ export declare function isReferenced(dataCollectionId: string, field: string, re
  * specified property. The Promise is rejected if the current user does not
  * have update permissions for the collection.
  *
- * Calling the `insertReference()` method does not trigger any hooks.
- *
  * > **Notes:**
  * > - The `insertReference()` method only applies to multi-reference fields.
  * > - The `insertReference()` method is not supported for Single Item
@@ -515,10 +437,8 @@ export declare function insertReference(dataCollectionId: string, field: string,
  * in the referring item. The Promise is rejected if the current user does not
  * have update permissions for the collection.
  *
- * Calling the `removeReference()` method does not trigger any hooks.
+ * > **Note:** The `removeReference()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
  *
- * > **Note:** The `removeReference()` method is not supported for Single
- * > Item Collections.
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -543,10 +463,9 @@ export declare function removeReference(dataCollectionId: string, field: string,
  * rejected if the current user does not have update permissions for the
  * collection.
  *
- * Calling the `replaceReferences()` method does not trigger any hooks.
  *
- * > **Note:** The `replaceReferences()` method is not supported for Single
- * > Item Collections.
+ * > **Note:** The `replaceReferences()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -567,31 +486,25 @@ export declare function bulkPatch(dataCollectionId: string, itemIds: string[]):
 /**
  * Creates a query to retrieve items from a database collection.
  *
- * The `query()` method builds a query to retrieve data items from a collection and returns a `WixDataQuery` object, which contains the query definition.
- *
- * You can refine the query by chaining `WixDataQuery` methods onto the query. `WixDataQuery` methods enable you to sort, filter, and control the results that `query()` returns.
+ * The `query()` method builds a query to retrieve data items from a collection and returns a `WixDataQuery` object, which contains the query definition. You can refine the query by chaining [`WixDataQuery` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/introduction) onto the query. `WixDataQuery` methods enable you to sort, filter, and control the query results.
  *
- * To set the query options, use the `options` parameter in the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/find) or [`distinct()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/distinct) methods.
+ * The methods chained to `query()` are applied in the order they are called. For example, if you sort by an `age` field in ascending order and then by a `name` field in descending order, the results are sorted first by the age of the items. If there are multiple results with the same age, they are further sorted by name in descending order, per age value.
  *
- * The methods that are chained to `query()` are applied in the order they are called. For example, if you sort on an `age` field in ascending order and then on a `name` field in descending order, the results are sorted first by the age of the items and then, if there are multiple results with the same age, the items are sorted by name in descending order, per age value.
+ * Finally, to run the query, chain [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/find) or [`distinct()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/distinct) as the last method.
  *
  * The `query()` method runs with the following `WixDataQuery` defaults that you can override:
- * - `skip`: 0
- * - `limit`: 50
+ * - `skip`: `0`
+ * - `limit`: `50`
  * - `descending`: by `_createdDate`
- * - `include`: none
- *
- * If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To retrieve data from the referenced items, specify them using the `include()` method.
+ * - `include`: `none`
  *
  * > **Notes**:
- * > - When calling `query()` following an update to your collection, the data retrieved might not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
- * > - Items marked as hidden are not retrieved.
- *
- * When working with Wix app collections, queried fields must have the following permissions:
- * - Connect to data
- * - Can use in dynamic page URLs
- * - Can be sorted and filtered
- * - Read-only: Check which fields can be used in a query.
+ * > - When calling `query()` immediately following an update to your collection, the data retrieved might not contain the most recent changes. If you need the most up-to-date data, set the `options.consistentRead` parameter of the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/find) or [`distinct()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-query/distinct) methods to `true`. Learn more about [Wix Data and Eventual Consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency).
+ * > - Items marked [in the CMS as hidden](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection) are not retrieved.
+ * > - If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To retrieve data from the referenced items, specify them using the `include()` method.
+ * > - When querying [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), make sure the fields you use to refine your query support the intended operations. Learn more about [querying by Wix app collection fields](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
+ *
+ *
  * @public
  * @documentationMaturity preview
  * @requiredField dataCollectionId
@@ -607,16 +520,15 @@ export declare function query(dataCollectionId: string): WixDataQuery;
  * The `aggregate()` method builds an aggregation on the specified collection and returns a `WixDataAggregate` object.
  *
  * An aggregation enables you to perform certain calculations on your collection data, or on groups of items that you define, to retrieve meaningful summaries.
- * You can also add paging, filtering, and sorting preferences to your aggregation to retrieve exactly what you need.
  *
- * The returned object contains the aggregate definition which is typically used to run the aggregation using the `run()` method.
+ * You can also add paging, filtering, and sorting preferences to your aggregation by chaining [`WixDataAggregate`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-aggregate/introduction) methods. The returned object contains the aggregate definition.
  *
- * You can refine the aggregation by chaining `WixDataAggregate` methods on to the aggregate.
+ * Finally, to run the aggregation, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items-new/wix-data-aggregate/run) as the last method.
  *
  * The `aggregate()` method runs with the following defaults that you can override:
  *
- *  + `skip` - 0
- *  + `limit`- 50
+ *  + `skip`: `0`
+ *  + `limit`: `50`
  *
  * @public
  * @documentationMaturity preview
@@ -637,10 +549,9 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
  * The `queryReferenced()` method returns a Promise that resolves to the full items referenced in the specified property of the item from the specified collection. The Promise is rejected if the current user does not have read permissions for the specified collection or the collection containing the referenced items.
  *
  * > **Notes**:
- * > - Calling `queryReferenced()` does not trigger any hooks.
  * > - You can only call `queryReferenced()` for [multi-reference fields](https://support.wix.com/en/article/about-referencing-multiple-items-in-one-field).
  * > - This method does not support [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
- * > - When calling `queryReferenced()` following an update to your collection, the data retrieved [may not contain the most recent changes](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). If you need the most up-to-date data, set `options.consistentRead` to `true`.
+ * > - When calling `queryReferenced()` immediately following an update to your collection, the data retrieved [may not contain the most recent changes](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency). If you need the most up-to-date data, set `options.consistentRead` to `true`.
  *
  * Learn more about [querying items that reference other items](https://support.wix.com/en/article/including-referenced-data-when-filtering).
  * @public
@@ -666,7 +577,7 @@ export declare function queryReferenced(dataCollectionId: string, referringItem:
  *
  * The `filter()` method builds a filter to be applied to a query or an aggregation. It returns a `WixDataFilter` object, which can be used with other filter methods such as `and()`, `or()` and `not()`, to create complex filter definitions.
  *
- * When working with [Wix app collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections), check which fields can be used in a filter.
+ * When working with [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), check which fields can be used in a filter.
  *
  * @public
  * @documentationMaturity preview