@wix/wix-data-items-sdk 1.0.147

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

@@ -0,0 +1,651 @@
+import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggregate, WixDataBulkPatch, WixDataBulkResult, WixDataBulkError, WixDataItem, WixDataReadWithProjectionOptions, WixDataQuery, WixDataPatch, WixDataResult, QueryBase, WixDataFilter } from '@wix/wix-data-items-common';
+/**
+ * Adds an item to a collection.
+ *
+ * An item can only be inserted into an existing collection. You can create a new collection using the
+ * Data Collections API.
+ *
+ * The `insert()` function returns a Promise that resolves to the inserted item
+ * after it has been added to the specified collection. The Promise is rejected
+ * if the current user does not have "create" permissions for the collection or
+ * the specified item includes an `_id` property whose value matches an
+ * existing ID in the collection. Meaning, `insert()` cannot overwrite an
+ * existing item in the collection.
+ *
+ * Calling the `insert()` function 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.
+ *
+ * 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.
+ *
+ * The `insert()` function adds the following properties and values to the item
+ * when it adds it to the collection:
+ * - `_id`: A unique identifier for an item in a collection, if the item
+ *   doesn't have one or has one that is `undefined`. You can optionally provide
+ *   your own ID. Once an ID is assigned to an item it cannot be changed.
+ * - `_createdDate`: The date the item was added to the collection.
+ * - `_updatedDate`: The date the item was modified. When the item is first
+ *   added, the `_createdDate` and `_updatedDate` are the same.
+ *
+ * Any valid JavaScript object can be added as a property value. The `insert()`
+ * function 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()` function will not run. To update or change an item in a
+ * >   Single Item Collection see the `update()` and `save()` functions.
+ * > - The `insert()` function does not support multi-reference fields. For
+ * >   multi-reference fields, use `insertReference()`.
+ * @public
+ * @param dataCollectionId - ID of the collection item belongs to.
+ * @param item - Data item to insert.
+ * @param options - An object containing options to use when processing this operation.
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField item
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function insert(dataCollectionId: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions): Promise<WixDataItem>;
+/**
+ * Updates an item in a collection.
+ *
+ * The `update()` function returns a Promise that resolves to the updated item from
+ * the specified collection. The Promise is rejected if the current user does not
+ * have update permissions for the collection.
+ *
+ * Calling the `update()` function triggers the `beforeUpdate()` and `afterUpdate()`
+ * hooks if they have been defined.
+ *
+ * > **Note:**
+ * > The specified item must include an `_id` property that already exists in
+ * > the collection.
+ *
+ * The `update()` function compares the `_id` property of the specified item
+ * with the `_id` property values of the items in the specified collection. If
+ * an item in the collection has that `_id` value, `update()` replaces the
+ * 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.
+ *
+ * Any valid JavaScript object can be used as a property value. The `update()`
+ * function 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.
+ *
+ * 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.
+ *
+ * The maximum size of an item that you can update in a collection is 500kb.
+ *
+ * > **Note:**
+ * > The update() function does not support multi-reference fields. For
+ * > multi-reference fields, use replaceReferences() or insertReference().
+ * @param dataCollectionId - ID of the collection item belongs to.
+ * @param item - Data item to update.
+ * @param options - An object containing options to use when processing this operation.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField item
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function update(dataCollectionId: string, item: WixDataItem, options?: WixDataUpdateOptions): Promise<WixDataItem>;
+/**
+ * Inserts or updates an item in a collection.
+ *
+ * The `save()` function returns a Promise that resolves to the inserted or
+ * updated item after it has been added or updated in the specified
+ * collection. The Promise is rejected if the current user does not have
+ * the necessary permissions for the collection.
+ *
+ * The `save()` function inserts or updates the specified item, depending on
+ * whether it already exists in the collection. It compares the `_id` property
+ * value of the specified item with the `_id` property values of the items in
+ * the specified collection. If an item in the collection has that `_id` value,
+ * `save()` uses `update()` to update the item in the collection, triggering
+ * the `beforeUpdate()` and `afterUpdate()` hooks if they have been defined.
+ * 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.
+ *
+ * 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()` function does not support multi-reference fields. For
+ * >   multi-reference fields, use `insertReference() `or `replaceReferences()`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField item
+ * @param dataCollectionId - ID of the collection item belongs to.
+ * @param item - Data item to save.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function save(dataCollectionId: string, item: Partial<WixDataItem>, options?: WixDataUpdateOptions): Promise<WixDataItem>;
+/**
+ * Retrieves an item from a collection.
+ *
+ * The `get()` function returns a Promise that resolves to the item with ID
+ * `itemId` from the specified collection, or `null` if the `itemId` is not
+ * found. The Promise is rejected if the current user does not have read
+ * permissions for the collection.
+ *
+ * If the specified collection contains reference fields, the ID of the
+ * referenced item is returned. To return the values of the referenced items
+ * use `query()` and `include()`.
+ *
+ * Calling the `get()` function 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.
+ *
+ * > **Notes:**
+ * > - When using the `query()` or `get()` functions 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()` function 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.
+ * @param dataCollectionId - ID of the collection item belongs to.
+ * @param itemId - ID of the data item to retrieve.
+ * @param options - An object containing options to use when processing this operation.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemId
+ * @requiredField dataCollectionId.
+ * @permissionScope Read Data Items
+ * @permissionScopeId SCOPE.DC-DATA.READ
+ * @returns Retrieved item.
+ */
+export declare function get(dataCollectionId: string, itemId: string, options?: WixDataReadWithProjectionOptions): Promise<WixDataItem | null>;
+/**
+ * Removes an item from a collection.
+ *
+ * The `remove()` function returns a Promise that resolves to the removed item
+ * after it has been removed from the specified collection. The Promise is
+ * rejected if the current user does not have "delete" permissions for the
+ * collection.
+ *
+ * Calling the `remove()` function triggers the `beforeRemove()` and
+ * `afterRemove()` 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()` function 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 item belongs to.
+ * @param itemId - ID of the item to remove.
+ * @param options - An object containing options to use when processing this operation.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField itemId
+ * @requiredField dataCollectionId
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function remove(dataCollectionId: string, itemId: string, options?: WixDataOptions): Promise<WixDataItem | null>;
+/**
+ * Removes all items from a collection.
+ *
+ * The `truncate()` function 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`.
+ *
+ * Calling the `truncate()` function 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.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @param dataCollectionId - ID of the collection to truncate.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function truncate(dataCollectionId: string): Promise<void>;
+/**
+ * Adds a number of items to a collection.
+ *
+ * The `bulkInsert()` function returns a Promise that resolves after the items
+ * 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 item in the collection.
+ *
+ * Calling the `bulkInsert()` function 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.
+ *
+ * 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
+ * entire referenced item object.
+ *
+ * The `bulkInsert()` function adds the following properties and values to the
+ * item when it adds it to the collection:
+ * - `_id`: A unique identifier for an item in a collection, if the item
+ *   doesn't have one or has one that is `undefined`. You can optionally
+ *   provide your own ID. Once an ID is assigned to an item it cannot be
+ *   changed.
+ * - `_createdDate`: The date the item was added to the collection.
+ * - `_updatedDate`: The date the item was modified. When the item is first
+ *   added, the `createdDate` and `updatedDate` are the same.
+ *
+ * Any valid JavaScript object can be added as a property value. The
+ * `bulkInsert()` function 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.
+ * > - Bulk operations are limited to 1000 items per function call.
+ * > - The `bulkInsert()` function is not supported for Single Item Collections.
+ * > - The `bulkInsert()` function does not support multi-reference fields. For
+ * >   multi-reference fields, use `insertReference()`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField items
+ * @param dataCollectionId - ID of the collection items belong to.
+ * @param items - Data items to insert.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function bulkInsert(dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions): Promise<WixDataBulkResult>;
+/**
+ * Updates a number of items in a collection.
+ *
+ * The `bulkUpdate()` function returns a Promise that resolves after the items
+ * have been updated in the specified collection. The Promise is rejected if
+ * the current user does not have update permissions for the collection. Items
+ * are skipped if they include an `_id` property whose value does not match an
+ * existing ID in the collection. Meaning, `bulkUpdate()` cannot add new items
+ * into the collection.
+ *
+ * Calling the `bulkUpdate()` function triggers the `beforeUpdate()` and
+ * `afterUpdate()` hooks for each item that is updated if the hooks have been
+ * defined.
+ *
+ * The `bulkUpdate()` function 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.
+ *
+ * Any valid JavaScript object can be used as a property value. The
+ * `bulkUpdate()` function 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.
+ *
+ * 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:**
+ * > - Bulk operations are limited to 1000 items per function call.
+ * > - The `bulkUpdate()` function is not supported for Single Item Collections.
+ * > - The `bulkUpdate()` function does not support multi-reference fields. For
+ * >   multi-reference fields, use `replaceReferences()` or `insertReference()`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField items
+ * @param dataCollectionId - ID of the collection items belong to.
+ * @param items - Data items to update.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function bulkUpdate(dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions): Promise<WixDataBulkResult>;
+/**
+ * Inserts or updates a number of items in a collection.
+ *
+ * The `bulkSave()` function returns a Promise that resolves after the items
+ * have been added or updated in the specified collection. The Promise is
+ * rejected if the current user does not have the necessary permissions for the
+ * collection.
+ *
+ * The `bulkSave()` function inserts or updates the specified items, depending
+ * on whether they already exist in the collection. It compares the `_id`
+ * property value of the specified items with the `_id` property values of the
+ * items in the specified collection.
+ *
+ * - If an item in the collection has the specified `_id` value, `bulkSave()`
+ *   uses `update()` to update the item in the collection, triggering the
+ *   `beforeUpdate()` and `afterUpdate()` hooks for that item if they have been
+ *   defined.
+ * - 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.
+ *
+ * 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.
+ * > - Bulk operations are limited to 1000 items per function call.
+ * > - The `bulkSave()` function is not supported for Single Item Collections.
+ * > - The `bulkSave()` function does not support multi-reference fields. For
+ * >   multi-reference fields, use `replaceReferences()` or
+ * >   `insertReference()`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField items
+ * @param dataCollectionId - ID of the collection items belong to.
+ * @param items - Data items to save.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function bulkSave(dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions): Promise<WixDataBulkResult>;
+/**
+ * Removes a number of items from a collection.
+ *
+ * The `bulkRemove()` function 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 will be deleted are those for which the current user is the
+ * owner. All other items will be skipped.
+ *
+ * Calling the `bulkRemove()` function triggers the `beforeRemove()` and
+ * `afterRemove()` hooks for each item that is deleted if the hooks have been
+ * defined.
+ *
+ * Use the options parameter to run `bulkRemove()` from backend code without
+ * checking for permissions or without its registered hooks.
+ *
+ * > **Notes:**
+ * > - The `bulkRemove()` function also clears multiple-item reference fields
+ * >   for items in collections referenced by the specified items. For example,
+ * >   suppose you have a **Movies** collection with an **Actors** field that
+ * >   contains multiple references to items in a **People** collection.
+ * >   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 function call.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField dataItemIds
+ * @param dataCollectionId - ID of the collection items belong to.
+ * @param itemIds - IDs of the items to remove. The array must contain at least one item. Passing an empty array returns an error.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function bulkRemove(dataCollectionId: string, itemIds: string[], options?: WixDataOptions): Promise<WixDataBulkResult>;
+/**
+ * Checks if a reference to the referenced item exists in the specified
+ * property of the referring item.
+ *
+ * The `isReferenced()` function returns a Promise that resolves to true if the
+ * referring item contains a reference to the referenced item in the specified
+ * property. The Promise is rejected if the current user does not have read
+ * permissions for the collection.
+ *
+ * Calling the `isReferenced()` function does not trigger any hooks.
+ *
+ * > **Note:** The `isReferenced()` function is not supported for Single Item
+ * > Collections.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField referencedItemId
+ * @requiredField referringItemFieldName
+ * @requiredField referringItemId
+ * @param dataCollectionId - ID of the collection containing the referring item.
+ * @param propertyName - Field to check for a reference to the item that may be referenced.
+ * @param referringItem - The referring item.
+ * @param referencedItem - Item that may be referenced.
+ * @param options - Options for checking whether a field contains a reference to an item.
+ * @permissionScope Read Data Items
+ * @permissionScopeId SCOPE.DC-DATA.READ
+ */
+export declare function isReferenced(dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string, options?: WixDataReadOptions): Promise<boolean>;
+/**
+ * Inserts a reference in the specified property.
+ *
+ * The `insertReference()` function returns a Promise that resolves when a
+ * reference to the referenced item(s) is added to the referring item in the
+ * specified property. The Promise is rejected if the current user does not
+ * have update permissions for the collection.
+ *
+ * Calling the `insertReference()` function does not trigger any hooks.
+ *
+ * > **Notes:**
+ * > - The `insertReference()` function only applies to multi-reference fields.
+ * > - The `insertReference()` function is not supported for Single Item
+ * >   Collections.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField propertyName
+ * @requiredField referringItem
+ * @requiredField referencedItem
+ * @param dataCollectionId - The ID of the collection that contains the referring item.
+ * @param propertyName - The property to insert the reference into.
+ * @param referringItem - The referring item or referring item's ID.
+ * @param referencedItem - The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function insertReference(dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
+/**
+ * Removes a reference from the specified property.
+ *
+ * The `removeReference()` function returns a Promise that resolves when a
+ * reference to the referenced item(s) is removed from the specified property
+ * in the referring item. The Promise is rejected if the current user does not
+ * have update permissions for the collection.
+ *
+ * Calling the `removeReference()` function does not trigger any hooks.
+ *
+ * > **Note:** The `removeReference()` function is not supported for Single
+ * > Item Collections.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField propertyName
+ * @requiredField referringItem
+ * @requiredField referencedItem
+ * @param dataCollectionId - The ID of the collection that contains the referring item.
+ * @param propertyName - The property to remove the reference from.
+ * @param referringItem - The referring item or referring item's ID.
+ * @param referencedItem - The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function removeReference(dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
+/**
+ * Replaces current references with references in the specified property.
+ *
+ * The `replaceReferences()` function returns a Promise that resolves when the
+ * item's current references in the specified property are removed and
+ * references to the referenced items are added in their place. The Promise is
+ * rejected if the current user does not have update permissions for the
+ * collection.
+ *
+ * Calling the `replaceReferences()` function does not trigger any hooks.
+ *
+ * > **Note:** The `replaceReferences()` function is not supported for Single
+ * > Item Collections.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField propertyName
+ * @requiredField referringItem
+ * @requiredField referencedItem
+ * @param dataCollectionId - The ID of the collection that contains the referring item.
+ * @param propertyName - The property to replaces the references in.
+ * @param referringItem - The referring item or referring item's ID.
+ * @param referencedItem - The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs.
+ * @param options - An object containing options to use when processing this operation.
+ * @permissionScope Write Data Items
+ * @permissionScopeId SCOPE.DC-DATA.WRITE
+ */
+export declare function replaceReferences(dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
+export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
+export declare function bulkPatch(dataCollectionId: string, itemIds: string[]): WixDataBulkPatch;
+/**
+ * Creates a query to retrieve items from a database collection.
+ *
+ * The `query()` function builds a query to retrieve data items from a collection and returns a `WixDataQueryBuilder` object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
+ *
+ * You can refine the query by chaining `WixDataQueryBuilder` functions onto the query. `WixDataQueryBuilder` functions enable you to sort, filter, and control the results that `query()` returns.
+ *
+ * The functions 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.
+ *
+ * If the collection that you are querying has references to other collections, by default the data from referenced collections is not retrieved. To get the data from referenced items, specify them using `include()` function.
+ *
+ * > **Note**: When calling `query()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
+ *
+ *
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @param dataCollectionId - The ID of the collection to run the query on.
+ * @permissionScope Read Data Items
+ * @permissionScopeId SCOPE.DC-DATA.READ
+ * @applicableIdentity APP
+ */
+export declare function query(dataCollectionId: string): WixDataQuery;
+/**
+ * Creates an aggregation on a data collection.
+ *
+ * The `aggregate()` function 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()` function.
+ *
+ * You can refine the aggregation by chaining `WixDataAggregate` functions on to the aggregate.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @param dataCollectionId - The ID of the collection to run the aggregation on.
+ * @permissionScope Read Data Items
+ * @permissionScopeId SCOPE.DC-DATA.READ
+ * @applicableIdentity APP
+ */
+export declare function aggregate(dataCollectionId: string): WixDataAggregate;
+/**
+ * Retrieves the full items referenced in the specified field of an item.
+ *
+ * Reference and multi-reference fields refer to items in different collections.
+ * Use this function to retrieve the full details of the referenced items themselves.
+ *
+ * For example, suppose you have a **Movies** collection with an **Actors** field that contains references to items in a **People** collection.
+ * Querying the **Movies** collection using `queryReferenced()` returns the relevant **People** items referenced in the **Actors** field of the specified **Movie** item.
+ * This gives you information from the **People** collection about each of the actors in the specified movie.
+ *
+ * > **Note**: When calling `queryReferenced()` following an update to your collection, the data retrieved may not contain the most recent changes. If you need the most up-to-date data, set `options.consistentRead` to `true`.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField dataCollectionId
+ * @requiredField holdingItem
+ * @requiredField relationshipAttribute
+ * @param dataCollectionId - The ID of the collection that contains the referring item.
+ * @param holdingItem - The referring item or referring item's ID.
+ * @param relationshipAttribute - The property that contains the references to the referenced items.
+ * @param options - Options for querying referenced data items.
+ * @permissionScope Read Data Items
+ * @permissionScopeId SCOPE.DC-DATA.READ
+ * @applicableIdentity APP
+ */
+export declare function queryReferenced(dataCollectionId: string, holdingItem: WixDataItem | string, relationshipAttribute: string, options?: WixDataReadWithProjectionOptions & {
+    order?: 'asc' | 'desc';
+    skip?: number;
+    limit?: number;
+}): Promise<WixDataResult>;
+/**
+ * Creates a filter to be used with queries and aggregations.
+ *
+ * The `filter()` function builds a filter to be applied to a query or an aggregation, and returns a `WixDataFilter` object.
+ * The returned object contains the filter definition and can be combined with query builder using `and()`, `or()` and `not()` functions.
+ *
+ * When working with Wix App Collections, check which fields can be used in a filter.
+ *
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function filter(): WixDataFilter;
+export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, WixDataItem, WixDataBulkResult, WixDataBulkError, WixDataQuery, WixDataPatch, WixDataAggregate, QueryBase, WixDataFilter, WixDataResult, };