@wix/wix-data-items-sdk 1.0.267 → 1.0.268
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/src/data-v2-data-item-items.public.d.ts +11 -16
- package/build/cjs/src/data-v2-data-item-items.public.js.map +1 -1
- package/build/cjs/src/data-v2-data-item-items.universal.d.ts +30 -11
- package/build/cjs/src/data-v2-data-item-items.universal.js +26 -4
- package/build/cjs/src/data-v2-data-item-items.universal.js.map +1 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/src/data-v2-data-item-items.public.d.ts +11 -16
- package/build/es/src/data-v2-data-item-items.public.js.map +1 -1
- package/build/es/src/data-v2-data-item-items.universal.d.ts +30 -11
- package/build/es/src/data-v2-data-item-items.universal.js +26 -4
- package/build/es/src/data-v2-data-item-items.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataItem } from './data-v2-data-item-items.universal';
|
|
3
|
-
import { WixDataOptions, WixDataUpdateOptions } from '@wix/wix-data-items-common';
|
|
2
|
+
import { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataItem, WixDataQueryReferencedOptions, WixDataOptions, WixDataUpdateOptions } from './data-v2-data-item-items.universal';
|
|
4
3
|
export declare const __metadata: {
|
|
5
4
|
PACKAGE_NAME: string;
|
|
6
5
|
};
|
|
@@ -10,23 +9,19 @@ export declare function save(httpClient: HttpClient): (dataCollectionId: string,
|
|
|
10
9
|
export declare function get(httpClient: HttpClient): (dataCollectionId: string, dataItemId: string, options?: WixDataReadWithProjectionOptions) => Promise<WixDataItem | null>;
|
|
11
10
|
export declare function remove(httpClient: HttpClient): (dataCollectionId: string, dataItemId: string, options?: WixDataOptions) => Promise<WixDataItem | null>;
|
|
12
11
|
export declare function truncate(httpClient: HttpClient): (dataCollectionId: string) => Promise<void>;
|
|
13
|
-
export declare function bulkInsert(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
14
|
-
export declare function bulkUpdate(httpClient: HttpClient): (dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
15
|
-
export declare function bulkSave(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
16
|
-
export declare function bulkRemove(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
12
|
+
export declare function bulkInsert(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
13
|
+
export declare function bulkUpdate(httpClient: HttpClient): (dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
14
|
+
export declare function bulkSave(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
15
|
+
export declare function bulkRemove(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
17
16
|
export declare function isReferenced(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string, options?: WixDataReadOptions) => Promise<boolean>;
|
|
18
17
|
export declare function insertReference(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[]) => Promise<void>;
|
|
19
18
|
export declare function removeReference(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[]) => Promise<void>;
|
|
20
19
|
export declare function replaceReferences(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[]) => Promise<void>;
|
|
21
|
-
export declare function query(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common").WixDataQuery;
|
|
22
|
-
export declare function patch(httpClient: HttpClient): (dataCollectionId: string, itemId: string) => import("@wix/wix-data-items-common").WixDataPatch;
|
|
23
|
-
export declare function bulkPatch(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[]) => import("@wix/wix-data-items-common").WixDataBulkPatch;
|
|
24
|
-
export declare function aggregate(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common").WixDataAggregate;
|
|
25
|
-
export declare function queryReferenced(httpClient: HttpClient): (dataCollectionId: string, holdingItem: WixDataItem | string, relationshipAttribute: string, options?:
|
|
26
|
-
|
|
27
|
-
skip?: number;
|
|
28
|
-
limit?: number;
|
|
29
|
-
}) => Promise<import("@wix/wix-data-items-common").WixDataResult<WixDataItem>>;
|
|
30
|
-
export declare function filter(httpClient: HttpClient): () => import("@wix/wix-data-items-common").WixDataFilter;
|
|
20
|
+
export declare function query(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common/dist/types/api/WixDataQuery").WixDataQuery;
|
|
21
|
+
export declare function patch(httpClient: HttpClient): (dataCollectionId: string, itemId: string) => import("@wix/wix-data-items-common/dist/types/api/WixDataPatch").WixDataPatch;
|
|
22
|
+
export declare function bulkPatch(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[]) => import("@wix/wix-data-items-common/dist/types/api/WixDataPatch").WixDataBulkPatch;
|
|
23
|
+
export declare function aggregate(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common/dist/types/api/WixDataAggregate").WixDataAggregate;
|
|
24
|
+
export declare function queryReferenced(httpClient: HttpClient): (dataCollectionId: string, holdingItem: WixDataItem | string, relationshipAttribute: string, options?: WixDataQueryReferencedOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/WixDataResult").WixDataResult<WixDataItem>>;
|
|
25
|
+
export declare function filter(httpClient: HttpClient): () => import("@wix/wix-data-items-common/dist/types/api/WixDataFilter").WixDataFilter;
|
|
31
26
|
export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, };
|
|
32
27
|
export { WixDataItem, WixDataBulkError, WixDataBulkResult, } from './data-v2-data-item-items.universal';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-data-item-items.public.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.public.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"data-v2-data-item-items.public.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.public.ts"],"names":[],"mappings":";;;AAgCA,wBAaC;AAED,wBAaC;AAED,oBAaC;AAED,kBAaC;AAED,wBAaC;AAED,4BAOC;AAED,gCAaC;AAED,gCAaC;AAED,4BAaC;AAED,gCAaC;AAED,oCAiBC;AAED,0CAeC;AAED,0CAeC;AAED,8CAeC;AAED,sBAOC;AAED,sBAQC;AAED,8BAQC;AAED,8BAOC;AAED,0CAeC;AAED,wBAMC;AAlTD,2FA2B4C;AAE/B,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAA;AAEvD,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CACL,gBAAwB,EACxB,QAA8B,EAC9B,OAA8B,EAC9B,EAAE,CACF,IAAA,0CAAe,EACb,gBAAgB,EAChB,QAAQ,EACR,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CACL,gBAAwB,EACxB,IAAiB,EACjB,OAA8B,EAC9B,EAAE,CACF,IAAA,0CAAe,EACb,gBAAgB,EAChB,IAAI,EACJ,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,IAAI,CAAC,UAAsB;IACzC,OAAO,CACL,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B,EAC9B,EAAE,CACF,IAAA,wCAAa,EACX,gBAAgB,EAChB,IAAI,EACJ,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,GAAG,CAAC,UAAsB;IACxC,OAAO,CACL,gBAAwB,EACxB,UAAkB,EAClB,OAA0C,EAC1C,EAAE,CACF,IAAA,uCAAY,EACV,gBAAgB,EAChB,UAAU,EACV,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,CACL,gBAAwB,EACxB,UAAkB,EAClB,OAAwB,EACxB,EAAE,CACF,IAAA,0CAAe,EACb,gBAAgB,EAChB,UAAU,EACV,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,IAAA,4CAAiB,EACf,gBAAgB;IAChB,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CACL,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB,EACxB,EAAE,CACF,IAAA,8CAAmB,EACjB,gBAAgB,EAChB,KAAK,EACL,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CACL,gBAAwB,EACxB,KAAoB,EACpB,OAAwB,EACxB,EAAE,CACF,IAAA,8CAAmB,EACjB,gBAAgB,EAChB,KAAK,EACL,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CACL,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB,EACxB,EAAE,CACF,IAAA,4CAAiB,EACf,gBAAgB,EAChB,KAAK,EACL,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CACL,gBAAwB,EACxB,OAAiB,EACjB,OAAwB,EACxB,EAAE,CACF,IAAA,8CAAmB,EACjB,gBAAgB,EAChB,OAAO,EACP,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAAoC,EACpC,OAA4B,EAC5B,EAAE,CACF,IAAA,gDAAqB,EACnB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,eAAe,CAAC,UAAsB;IACpD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAA+D,EAC/D,EAAE,CACF,IAAA,mDAAwB,EACtB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc;IACd,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,eAAe,CAAC,UAAsB;IACpD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAA+D,EAC/D,EAAE,CACF,IAAA,mDAAwB,EACtB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc;IACd,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAA+D,EAC/D,EAAE,CACF,IAAA,qDAA0B,EACxB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc;IACd,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,IAAA,yCAAc,EACZ,gBAAgB;IAChB,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,gBAAwB,EAAE,MAAc,EAAE,EAAE,CAClD,IAAA,yCAAc,EACZ,gBAAgB,EAChB,MAAM;IACN,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,OAAiB,EAAE,EAAE,CACrD,IAAA,6CAAkB,EAChB,gBAAgB,EAChB,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,IAAA,6CAAkB,EAChB,gBAAgB;IAChB,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,eAAe,CAAC,UAAsB;IACpD,OAAO,CACL,gBAAwB,EACxB,WAAiC,EACjC,qBAA6B,EAC7B,OAAuC,EACvC,EAAE,CACF,IAAA,mDAAwB,EACtB,gBAAgB,EAChB,WAAW,EACX,qBAAqB,EACrB,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,SAAgB,MAAM,CAAC,UAAsB;IAC3C,OAAO,GAAG,EAAE,CACV,IAAA,0CAAe;IACb,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggregate, WixDataBulkPatch, WixDataBulkResult, WixDataBulkError, WixDataItem, WixDataReadWithProjectionOptions, WixDataQuery, WixDataPatch, WixDataResult, QueryBase, WixDataFilter } from '@wix/wix-data-items-common';
|
|
1
|
+
import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggregate, WixDataBulkPatch, WixDataBulkResult, WixDataBulkError, WixDataItem, WixDataReadWithProjectionOptions, WixDataQuery, WixDataPatch, WixDataResult, QueryBase, WixDataFilter, WixDataQueryReferencedOptions } from '@wix/wix-data-items-common';
|
|
2
2
|
/**
|
|
3
3
|
* Adds an item to a collection.
|
|
4
4
|
*
|
|
@@ -483,26 +483,48 @@ export declare function removeReference(dataCollectionId: string, field: string,
|
|
|
483
483
|
*/
|
|
484
484
|
export declare function replaceReferences(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
485
485
|
/**
|
|
486
|
-
*
|
|
486
|
+
* Creates a patch to modify the specified item. Unlike [`update()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/update), data that isn't explicitly modified remains unchanged.
|
|
487
|
+
*
|
|
488
|
+
* The `patch()` method builds a patch to modify a data item in a specified collection. It returns a `WixDataPatch` object that contains the patch definition, which you can further refine by chaining [`WixDataPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/introduction) onto it. These methods allow you to clear, set, and and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
489
|
+
*
|
|
490
|
+
* Finally, to run the patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/run) as the last method.
|
|
491
|
+
*
|
|
492
|
+
* If an item is found in the specified collection with the specified ID, that item is patched. If the collection doesn't contain an item with that ID, the request fails.
|
|
493
|
+
*
|
|
494
|
+
* Calling the `patch()` 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.
|
|
495
|
+
*
|
|
496
|
+
* > **Notes**:
|
|
497
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
498
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
487
499
|
*
|
|
488
500
|
* @public
|
|
489
501
|
* @documentationMaturity preview
|
|
490
502
|
* @requiredField dataCollectionId
|
|
491
503
|
* @requiredField itemId
|
|
492
|
-
* @param dataCollectionId - ID of the collection
|
|
504
|
+
* @param dataCollectionId - ID of the collection that contains the item to patch.
|
|
493
505
|
* @param itemId - ID of the data item to patch.
|
|
494
506
|
* @permissionScope Write Data Items
|
|
495
507
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
496
508
|
*/
|
|
497
509
|
export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
|
|
498
510
|
/**
|
|
499
|
-
*
|
|
511
|
+
* Creates a bulk patch to modify the specified items. Unlike [`bulkUpdate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/bulk-update), data that isn't explicitly modified remains unchanged.
|
|
512
|
+
*
|
|
513
|
+
* The `bulkPatch()` method builds a bulk patch to modify multiple data items in a collection. It returns a `WixDataBulkPatch` object that contains the bulk patch definition, which you can further refine by chaining [`WixDataBulkPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/introduction) onto it. These methods allow you to clear, set, and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
514
|
+
*
|
|
515
|
+
* Finally, to run the bulk patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/run) as the last method.
|
|
516
|
+
*
|
|
517
|
+
* Calling the `bulkPatch()` 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 patched, if the hooks have been defined.
|
|
518
|
+
*
|
|
519
|
+
* > **Notes**:
|
|
520
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
521
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
500
522
|
*
|
|
501
523
|
* @public
|
|
502
524
|
* @documentationMaturity preview
|
|
503
525
|
* @requiredField dataCollectionId
|
|
504
526
|
* @requiredField itemIds
|
|
505
|
-
* @param dataCollectionId -
|
|
527
|
+
* @param dataCollectionId - ID of the collection that contains the items to patch.
|
|
506
528
|
* @param itemIds - IDs of the data items to patch.
|
|
507
529
|
* @permissionScope Write Data Items
|
|
508
530
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
@@ -595,11 +617,7 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
|
|
|
595
617
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
596
618
|
* @applicableIdentity APP
|
|
597
619
|
*/
|
|
598
|
-
export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?:
|
|
599
|
-
order?: 'asc' | 'desc';
|
|
600
|
-
skip?: number;
|
|
601
|
-
limit?: number;
|
|
602
|
-
}): Promise<WixDataResult>;
|
|
620
|
+
export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?: WixDataQueryReferencedOptions): Promise<WixDataResult>;
|
|
603
621
|
/**
|
|
604
622
|
* Creates a filter for queries and aggregations.
|
|
605
623
|
*
|
|
@@ -611,4 +629,5 @@ export declare function queryReferenced(dataCollectionId: string, referringItem:
|
|
|
611
629
|
* @documentationMaturity preview
|
|
612
630
|
*/
|
|
613
631
|
export declare function filter(): WixDataFilter;
|
|
614
|
-
export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, WixDataItem, WixDataBulkResult, WixDataBulkError, WixDataQuery, WixDataPatch, WixDataBulkPatch, WixDataAggregate, QueryBase, WixDataFilter, WixDataResult, };
|
|
632
|
+
export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, WixDataItem, WixDataBulkResult, WixDataBulkError, WixDataQuery, WixDataPatch, WixDataBulkPatch, WixDataAggregate, QueryBase, WixDataFilter, WixDataResult, WixDataQueryReferencedOptions, };
|
|
633
|
+
export { WixDataQueryOptions, WixDataAggregateOptions, } from '@wix/wix-data-items-common';
|
|
@@ -558,13 +558,25 @@ async function replaceReferences(dataCollectionId, field, referringItem, referen
|
|
|
558
558
|
return (0, wix_data_api_1.createWixData)(httpClient, sideEffects).replaceReferences(dataCollectionId, field, referringItem, referencedItem, options);
|
|
559
559
|
}
|
|
560
560
|
/**
|
|
561
|
-
*
|
|
561
|
+
* Creates a patch to modify the specified item. Unlike [`update()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/update), data that isn't explicitly modified remains unchanged.
|
|
562
|
+
*
|
|
563
|
+
* The `patch()` method builds a patch to modify a data item in a specified collection. It returns a `WixDataPatch` object that contains the patch definition, which you can further refine by chaining [`WixDataPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/introduction) onto it. These methods allow you to clear, set, and and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
564
|
+
*
|
|
565
|
+
* Finally, to run the patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/run) as the last method.
|
|
566
|
+
*
|
|
567
|
+
* If an item is found in the specified collection with the specified ID, that item is patched. If the collection doesn't contain an item with that ID, the request fails.
|
|
568
|
+
*
|
|
569
|
+
* Calling the `patch()` 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.
|
|
570
|
+
*
|
|
571
|
+
* > **Notes**:
|
|
572
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
573
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
562
574
|
*
|
|
563
575
|
* @public
|
|
564
576
|
* @documentationMaturity preview
|
|
565
577
|
* @requiredField dataCollectionId
|
|
566
578
|
* @requiredField itemId
|
|
567
|
-
* @param dataCollectionId - ID of the collection
|
|
579
|
+
* @param dataCollectionId - ID of the collection that contains the item to patch.
|
|
568
580
|
* @param itemId - ID of the data item to patch.
|
|
569
581
|
* @permissionScope Write Data Items
|
|
570
582
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
@@ -574,13 +586,23 @@ function patch(dataCollectionId, itemId) {
|
|
|
574
586
|
return (0, wix_data_api_1.createWixData)(httpClient, sideEffects).patch(dataCollectionId, itemId);
|
|
575
587
|
}
|
|
576
588
|
/**
|
|
577
|
-
*
|
|
589
|
+
* Creates a bulk patch to modify the specified items. Unlike [`bulkUpdate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/bulk-update), data that isn't explicitly modified remains unchanged.
|
|
590
|
+
*
|
|
591
|
+
* The `bulkPatch()` method builds a bulk patch to modify multiple data items in a collection. It returns a `WixDataBulkPatch` object that contains the bulk patch definition, which you can further refine by chaining [`WixDataBulkPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/introduction) onto it. These methods allow you to clear, set, and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
592
|
+
*
|
|
593
|
+
* Finally, to run the bulk patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/run) as the last method.
|
|
594
|
+
*
|
|
595
|
+
* Calling the `bulkPatch()` 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 patched, if the hooks have been defined.
|
|
596
|
+
*
|
|
597
|
+
* > **Notes**:
|
|
598
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
599
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
578
600
|
*
|
|
579
601
|
* @public
|
|
580
602
|
* @documentationMaturity preview
|
|
581
603
|
* @requiredField dataCollectionId
|
|
582
604
|
* @requiredField itemIds
|
|
583
|
-
* @param dataCollectionId -
|
|
605
|
+
* @param dataCollectionId - ID of the collection that contains the items to patch.
|
|
584
606
|
* @param itemIds - IDs of the data items to patch.
|
|
585
607
|
* @permissionScope Write Data Items
|
|
586
608
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":";;;AAoEA,wBAeC;AA6CD,wBAeC;AA2CD,oBAeC;AAkCD,kBAeC;AAyBD,wBAeC;AAmBD,4BAOC;AAmDD,gCAeC;AAgDD,gCAeC;AA8CD,4BAeC;AA4BD,gCAeC;AA0BD,oCAmBC;AA4BD,0CAgCC;AA0BD,0CAmBC;AA4BD,8CAmBC;AA0BD,sBAOC;AAwBD,8BAaC;AAkCD,sBAOC;AA0BD,8BAOC;AA+BD,0CAiBC;AAYD,wBAOC;AA57BD,iDAA8C;AAC9C,sEAgBmC;AAy7BjC,0FA57BA,iCAAS,OA47BA;AAv7BX;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACI,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACI,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAAiB,EACjB,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACI,KAAK,UAAU,IAAI,CACxB,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAChD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACI,KAAK,UAAU,GAAG,CACvB,gBAAwB,EACxB,MAAc,EACd,OAA0C;IAE1C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,GAAG,CAC/C,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,MAAc,EACd,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACI,KAAK,UAAU,QAAQ,CAAC,gBAAwB;IACrD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACI,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACI,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAAoB,EACpB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACI,KAAK,UAAU,QAAQ,CAC5B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CACpD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,OAAiB,EACjB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,OAAO,EACP,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,YAAY,CAChC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAAoC,EACpC,OAA4B;IAE5B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,YAAY,CACxD,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,aAAa,IAAI,SAAS;QAC1B,cAAc,IAAI,SAAS,EAC3B,CAAC;QACD,0FAA0F;QAC1F,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;IACH,CAAC;SAAM,CAAC;QACN,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACI,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACI,KAAK,UAAU,iBAAiB,CACrC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,iBAAiB,CAC7D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,KAAK,CAAC,gBAAwB,EAAE,MAAc;IAC5D,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,SAAS,CACvB,gBAAwB,EACxB,OAAiB;IAEjB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CACrD,gBAAgB,EAChB,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,SAAgB,KAAK,CAAC,gBAAwB;IAC5C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,SAAS,CAAC,gBAAwB;IAChD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACI,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,aAAmC,EACnC,KAAa,EACb,OAAuC;IAEvC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,aAAa,EACb,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,MAAM;IACpB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,IAAA,4BAAa,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAAA;AACtD,CAAC"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataItem } from './data-v2-data-item-items.universal';
|
|
3
|
-
import { WixDataOptions, WixDataUpdateOptions } from '@wix/wix-data-items-common';
|
|
2
|
+
import { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataItem, WixDataQueryReferencedOptions, WixDataOptions, WixDataUpdateOptions } from './data-v2-data-item-items.universal';
|
|
4
3
|
export declare const __metadata: {
|
|
5
4
|
PACKAGE_NAME: string;
|
|
6
5
|
};
|
|
@@ -10,23 +9,19 @@ export declare function save(httpClient: HttpClient): (dataCollectionId: string,
|
|
|
10
9
|
export declare function get(httpClient: HttpClient): (dataCollectionId: string, dataItemId: string, options?: WixDataReadWithProjectionOptions) => Promise<WixDataItem | null>;
|
|
11
10
|
export declare function remove(httpClient: HttpClient): (dataCollectionId: string, dataItemId: string, options?: WixDataOptions) => Promise<WixDataItem | null>;
|
|
12
11
|
export declare function truncate(httpClient: HttpClient): (dataCollectionId: string) => Promise<void>;
|
|
13
|
-
export declare function bulkInsert(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
14
|
-
export declare function bulkUpdate(httpClient: HttpClient): (dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
15
|
-
export declare function bulkSave(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
16
|
-
export declare function bulkRemove(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common").WixDataBulkResult>;
|
|
12
|
+
export declare function bulkInsert(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
13
|
+
export declare function bulkUpdate(httpClient: HttpClient): (dataCollectionId: string, items: WixDataItem[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
14
|
+
export declare function bulkSave(httpClient: HttpClient): (dataCollectionId: string, items: Partial<WixDataItem>[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
15
|
+
export declare function bulkRemove(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[], options?: WixDataOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/types").WixDataBulkResult>;
|
|
17
16
|
export declare function isReferenced(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string, options?: WixDataReadOptions) => Promise<boolean>;
|
|
18
17
|
export declare function insertReference(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[]) => Promise<void>;
|
|
19
18
|
export declare function removeReference(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[]) => Promise<void>;
|
|
20
19
|
export declare function replaceReferences(httpClient: HttpClient): (dataCollectionId: string, propertyName: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[]) => Promise<void>;
|
|
21
|
-
export declare function query(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common").WixDataQuery;
|
|
22
|
-
export declare function patch(httpClient: HttpClient): (dataCollectionId: string, itemId: string) => import("@wix/wix-data-items-common").WixDataPatch;
|
|
23
|
-
export declare function bulkPatch(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[]) => import("@wix/wix-data-items-common").WixDataBulkPatch;
|
|
24
|
-
export declare function aggregate(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common").WixDataAggregate;
|
|
25
|
-
export declare function queryReferenced(httpClient: HttpClient): (dataCollectionId: string, holdingItem: WixDataItem | string, relationshipAttribute: string, options?:
|
|
26
|
-
|
|
27
|
-
skip?: number;
|
|
28
|
-
limit?: number;
|
|
29
|
-
}) => Promise<import("@wix/wix-data-items-common").WixDataResult<WixDataItem>>;
|
|
30
|
-
export declare function filter(httpClient: HttpClient): () => import("@wix/wix-data-items-common").WixDataFilter;
|
|
20
|
+
export declare function query(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common/dist/types/api/WixDataQuery").WixDataQuery;
|
|
21
|
+
export declare function patch(httpClient: HttpClient): (dataCollectionId: string, itemId: string) => import("@wix/wix-data-items-common/dist/types/api/WixDataPatch").WixDataPatch;
|
|
22
|
+
export declare function bulkPatch(httpClient: HttpClient): (dataCollectionId: string, itemIds: string[]) => import("@wix/wix-data-items-common/dist/types/api/WixDataPatch").WixDataBulkPatch;
|
|
23
|
+
export declare function aggregate(httpClient: HttpClient): (dataCollectionId: string) => import("@wix/wix-data-items-common/dist/types/api/WixDataAggregate").WixDataAggregate;
|
|
24
|
+
export declare function queryReferenced(httpClient: HttpClient): (dataCollectionId: string, holdingItem: WixDataItem | string, relationshipAttribute: string, options?: WixDataQueryReferencedOptions) => Promise<import("@wix/wix-data-items-common/dist/types/api/WixDataResult").WixDataResult<WixDataItem>>;
|
|
25
|
+
export declare function filter(httpClient: HttpClient): () => import("@wix/wix-data-items-common/dist/types/api/WixDataFilter").WixDataFilter;
|
|
31
26
|
export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, };
|
|
32
27
|
export { WixDataItem, WixDataBulkError, WixDataBulkResult, } from './data-v2-data-item-items.universal';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-data-item-items.public.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,IAAI,eAAe,EACzB,MAAM,IAAI,eAAe,EACzB,IAAI,IAAI,aAAa,EACrB,GAAG,IAAI,YAAY,EACnB,MAAM,IAAI,eAAe,EACzB,QAAQ,IAAI,iBAAiB,EAC7B,UAAU,IAAI,mBAAmB,EACjC,UAAU,IAAI,mBAAmB,EACjC,QAAQ,IAAI,iBAAiB,EAC7B,UAAU,IAAI,mBAAmB,EACjC,YAAY,IAAI,qBAAqB,EACrC,eAAe,IAAI,wBAAwB,EAC3C,eAAe,IAAI,wBAAwB,EAC3C,iBAAiB,IAAI,0BAA0B,EAC/C,KAAK,IAAI,cAAc,EACvB,SAAS,IAAI,kBAAkB,EAC/B,KAAK,IAAI,cAAc,EACvB,SAAS,IAAI,kBAAkB,EAC/B,eAAe,IAAI,wBAAwB,EAC3C,MAAM,IAAI,eAAe,
|
|
1
|
+
{"version":3,"file":"data-v2-data-item-items.public.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.public.ts"],"names":[],"mappings":"AACA,OAAO,EACL,MAAM,IAAI,eAAe,EACzB,MAAM,IAAI,eAAe,EACzB,IAAI,IAAI,aAAa,EACrB,GAAG,IAAI,YAAY,EACnB,MAAM,IAAI,eAAe,EACzB,QAAQ,IAAI,iBAAiB,EAC7B,UAAU,IAAI,mBAAmB,EACjC,UAAU,IAAI,mBAAmB,EACjC,QAAQ,IAAI,iBAAiB,EAC7B,UAAU,IAAI,mBAAmB,EACjC,YAAY,IAAI,qBAAqB,EACrC,eAAe,IAAI,wBAAwB,EAC3C,eAAe,IAAI,wBAAwB,EAC3C,iBAAiB,IAAI,0BAA0B,EAC/C,KAAK,IAAI,cAAc,EACvB,SAAS,IAAI,kBAAkB,EAC/B,KAAK,IAAI,cAAc,EACvB,SAAS,IAAI,kBAAkB,EAC/B,eAAe,IAAI,wBAAwB,EAC3C,MAAM,IAAI,eAAe,GAO1B,MAAM,qCAAqC,CAAA;AAE5C,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,YAAY,EAAE,WAAW,EAAE,CAAA;AAEvD,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CACL,gBAAwB,EACxB,QAA8B,EAC9B,OAA8B,EAC9B,EAAE,CACF,eAAe,CACb,gBAAgB,EAChB,QAAQ,EACR,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CACL,gBAAwB,EACxB,IAAiB,EACjB,OAA8B,EAC9B,EAAE,CACF,eAAe,CACb,gBAAgB,EAChB,IAAI,EACJ,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,IAAI,CAAC,UAAsB;IACzC,OAAO,CACL,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B,EAC9B,EAAE,CACF,aAAa,CACX,gBAAgB,EAChB,IAAI,EACJ,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,UAAsB;IACxC,OAAO,CACL,gBAAwB,EACxB,UAAkB,EAClB,OAA0C,EAC1C,EAAE,CACF,YAAY,CACV,gBAAgB,EAChB,UAAU,EACV,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,CACL,gBAAwB,EACxB,UAAkB,EAClB,OAAwB,EACxB,EAAE,CACF,eAAe,CACb,gBAAgB,EAChB,UAAU,EACV,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,iBAAiB,CACf,gBAAgB;IAChB,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CACL,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB,EACxB,EAAE,CACF,mBAAmB,CACjB,gBAAgB,EAChB,KAAK,EACL,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CACL,gBAAwB,EACxB,KAAoB,EACpB,OAAwB,EACxB,EAAE,CACF,mBAAmB,CACjB,gBAAgB,EAChB,KAAK,EACL,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,UAAsB;IAC7C,OAAO,CACL,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB,EACxB,EAAE,CACF,iBAAiB,CACf,gBAAgB,EAChB,KAAK,EACL,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,UAAsB;IAC/C,OAAO,CACL,gBAAwB,EACxB,OAAiB,EACjB,OAAwB,EACxB,EAAE,CACF,mBAAmB,CACjB,gBAAgB,EAChB,OAAO,EACP,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAsB;IACjD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAAoC,EACpC,OAA4B,EAC5B,EAAE,CACF,qBAAqB,CACnB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAA+D,EAC/D,EAAE,CACF,wBAAwB,CACtB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc;IACd,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAA+D,EAC/D,EAAE,CACF,wBAAwB,CACtB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc;IACd,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CACL,gBAAwB,EACxB,YAAoB,EACpB,aAAmC,EACnC,cAA+D,EAC/D,EAAE,CACF,0BAA0B,CACxB,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc;IACd,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,cAAc,CACZ,gBAAgB;IAChB,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,UAAsB;IAC1C,OAAO,CAAC,gBAAwB,EAAE,MAAc,EAAE,EAAE,CAClD,cAAc,CACZ,gBAAgB,EAChB,MAAM;IACN,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,OAAiB,EAAE,EAAE,CACrD,kBAAkB,CAChB,gBAAgB,EAChB,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,UAAsB;IAC9C,OAAO,CAAC,gBAAwB,EAAE,EAAE,CAClC,kBAAkB,CAChB,gBAAgB;IAChB,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,UAAsB;IACpD,OAAO,CACL,gBAAwB,EACxB,WAAiC,EACjC,qBAA6B,EAC7B,OAAuC,EACvC,EAAE,CACF,wBAAwB,CACtB,gBAAgB,EAChB,WAAW,EACX,qBAAqB,EACrB,OAAO;IACP,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,UAAsB;IAC3C,OAAO,GAAG,EAAE,CACV,eAAe;IACb,mBAAmB;IACnB,EAAE,UAAU,EAAE,CACf,CAAA;AACL,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggregate, WixDataBulkPatch, WixDataBulkResult, WixDataBulkError, WixDataItem, WixDataReadWithProjectionOptions, WixDataQuery, WixDataPatch, WixDataResult, QueryBase, WixDataFilter } from '@wix/wix-data-items-common';
|
|
1
|
+
import { WixDataUpdateOptions, WixDataReadOptions, WixDataOptions, WixDataAggregate, WixDataBulkPatch, WixDataBulkResult, WixDataBulkError, WixDataItem, WixDataReadWithProjectionOptions, WixDataQuery, WixDataPatch, WixDataResult, QueryBase, WixDataFilter, WixDataQueryReferencedOptions } from '@wix/wix-data-items-common';
|
|
2
2
|
/**
|
|
3
3
|
* Adds an item to a collection.
|
|
4
4
|
*
|
|
@@ -483,26 +483,48 @@ export declare function removeReference(dataCollectionId: string, field: string,
|
|
|
483
483
|
*/
|
|
484
484
|
export declare function replaceReferences(dataCollectionId: string, field: string, referringItem: WixDataItem | string, referencedItem: WixDataItem | string | WixDataItem[] | string[], options?: WixDataOptions): Promise<void>;
|
|
485
485
|
/**
|
|
486
|
-
*
|
|
486
|
+
* Creates a patch to modify the specified item. Unlike [`update()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/update), data that isn't explicitly modified remains unchanged.
|
|
487
|
+
*
|
|
488
|
+
* The `patch()` method builds a patch to modify a data item in a specified collection. It returns a `WixDataPatch` object that contains the patch definition, which you can further refine by chaining [`WixDataPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/introduction) onto it. These methods allow you to clear, set, and and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
489
|
+
*
|
|
490
|
+
* Finally, to run the patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/run) as the last method.
|
|
491
|
+
*
|
|
492
|
+
* If an item is found in the specified collection with the specified ID, that item is patched. If the collection doesn't contain an item with that ID, the request fails.
|
|
493
|
+
*
|
|
494
|
+
* Calling the `patch()` 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.
|
|
495
|
+
*
|
|
496
|
+
* > **Notes**:
|
|
497
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
498
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
487
499
|
*
|
|
488
500
|
* @public
|
|
489
501
|
* @documentationMaturity preview
|
|
490
502
|
* @requiredField dataCollectionId
|
|
491
503
|
* @requiredField itemId
|
|
492
|
-
* @param dataCollectionId - ID of the collection
|
|
504
|
+
* @param dataCollectionId - ID of the collection that contains the item to patch.
|
|
493
505
|
* @param itemId - ID of the data item to patch.
|
|
494
506
|
* @permissionScope Write Data Items
|
|
495
507
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
496
508
|
*/
|
|
497
509
|
export declare function patch(dataCollectionId: string, itemId: string): WixDataPatch;
|
|
498
510
|
/**
|
|
499
|
-
*
|
|
511
|
+
* Creates a bulk patch to modify the specified items. Unlike [`bulkUpdate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/bulk-update), data that isn't explicitly modified remains unchanged.
|
|
512
|
+
*
|
|
513
|
+
* The `bulkPatch()` method builds a bulk patch to modify multiple data items in a collection. It returns a `WixDataBulkPatch` object that contains the bulk patch definition, which you can further refine by chaining [`WixDataBulkPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/introduction) onto it. These methods allow you to clear, set, and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
514
|
+
*
|
|
515
|
+
* Finally, to run the bulk patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/run) as the last method.
|
|
516
|
+
*
|
|
517
|
+
* Calling the `bulkPatch()` 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 patched, if the hooks have been defined.
|
|
518
|
+
*
|
|
519
|
+
* > **Notes**:
|
|
520
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
521
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
500
522
|
*
|
|
501
523
|
* @public
|
|
502
524
|
* @documentationMaturity preview
|
|
503
525
|
* @requiredField dataCollectionId
|
|
504
526
|
* @requiredField itemIds
|
|
505
|
-
* @param dataCollectionId -
|
|
527
|
+
* @param dataCollectionId - ID of the collection that contains the items to patch.
|
|
506
528
|
* @param itemIds - IDs of the data items to patch.
|
|
507
529
|
* @permissionScope Write Data Items
|
|
508
530
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
@@ -595,11 +617,7 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
|
|
|
595
617
|
* @permissionScopeId SCOPE.DC-DATA.READ
|
|
596
618
|
* @applicableIdentity APP
|
|
597
619
|
*/
|
|
598
|
-
export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?:
|
|
599
|
-
order?: 'asc' | 'desc';
|
|
600
|
-
skip?: number;
|
|
601
|
-
limit?: number;
|
|
602
|
-
}): Promise<WixDataResult>;
|
|
620
|
+
export declare function queryReferenced(dataCollectionId: string, referringItem: WixDataItem | string, field: string, options?: WixDataQueryReferencedOptions): Promise<WixDataResult>;
|
|
603
621
|
/**
|
|
604
622
|
* Creates a filter for queries and aggregations.
|
|
605
623
|
*
|
|
@@ -611,4 +629,5 @@ export declare function queryReferenced(dataCollectionId: string, referringItem:
|
|
|
611
629
|
* @documentationMaturity preview
|
|
612
630
|
*/
|
|
613
631
|
export declare function filter(): WixDataFilter;
|
|
614
|
-
export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, WixDataItem, WixDataBulkResult, WixDataBulkError, WixDataQuery, WixDataPatch, WixDataBulkPatch, WixDataAggregate, QueryBase, WixDataFilter, WixDataResult, };
|
|
632
|
+
export { WixDataReadOptions, WixDataReadWithProjectionOptions, WixDataOptions, WixDataUpdateOptions, WixDataItem, WixDataBulkResult, WixDataBulkError, WixDataQuery, WixDataPatch, WixDataBulkPatch, WixDataAggregate, QueryBase, WixDataFilter, WixDataResult, WixDataQueryReferencedOptions, };
|
|
633
|
+
export { WixDataQueryOptions, WixDataAggregateOptions, } from '@wix/wix-data-items-common';
|
|
@@ -534,13 +534,25 @@ export async function replaceReferences(dataCollectionId, field, referringItem,
|
|
|
534
534
|
return createWixData(httpClient, sideEffects).replaceReferences(dataCollectionId, field, referringItem, referencedItem, options);
|
|
535
535
|
}
|
|
536
536
|
/**
|
|
537
|
-
*
|
|
537
|
+
* Creates a patch to modify the specified item. Unlike [`update()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/update), data that isn't explicitly modified remains unchanged.
|
|
538
|
+
*
|
|
539
|
+
* The `patch()` method builds a patch to modify a data item in a specified collection. It returns a `WixDataPatch` object that contains the patch definition, which you can further refine by chaining [`WixDataPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/introduction) onto it. These methods allow you to clear, set, and and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
540
|
+
*
|
|
541
|
+
* Finally, to run the patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-patch/run) as the last method.
|
|
542
|
+
*
|
|
543
|
+
* If an item is found in the specified collection with the specified ID, that item is patched. If the collection doesn't contain an item with that ID, the request fails.
|
|
544
|
+
*
|
|
545
|
+
* Calling the `patch()` 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.
|
|
546
|
+
*
|
|
547
|
+
* > **Notes**:
|
|
548
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
549
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
538
550
|
*
|
|
539
551
|
* @public
|
|
540
552
|
* @documentationMaturity preview
|
|
541
553
|
* @requiredField dataCollectionId
|
|
542
554
|
* @requiredField itemId
|
|
543
|
-
* @param dataCollectionId - ID of the collection
|
|
555
|
+
* @param dataCollectionId - ID of the collection that contains the item to patch.
|
|
544
556
|
* @param itemId - ID of the data item to patch.
|
|
545
557
|
* @permissionScope Write Data Items
|
|
546
558
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
@@ -550,13 +562,23 @@ export function patch(dataCollectionId, itemId) {
|
|
|
550
562
|
return createWixData(httpClient, sideEffects).patch(dataCollectionId, itemId);
|
|
551
563
|
}
|
|
552
564
|
/**
|
|
553
|
-
*
|
|
565
|
+
* Creates a bulk patch to modify the specified items. Unlike [`bulkUpdate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/bulk-update), data that isn't explicitly modified remains unchanged.
|
|
566
|
+
*
|
|
567
|
+
* The `bulkPatch()` method builds a bulk patch to modify multiple data items in a collection. It returns a `WixDataBulkPatch` object that contains the bulk patch definition, which you can further refine by chaining [`WixDataBulkPatch` methods](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/introduction) onto it. These methods allow you to clear, set, and increment field values, as well as add or remove items from array fields. The methods are applied in the order in which they are chained.
|
|
568
|
+
*
|
|
569
|
+
* Finally, to run the bulk patch, chain [`run()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-bulk-patch/run) as the last method.
|
|
570
|
+
*
|
|
571
|
+
* Calling the `bulkPatch()` 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 patched, if the hooks have been defined.
|
|
572
|
+
*
|
|
573
|
+
* > **Notes**:
|
|
574
|
+
* > - When an item is patched, its `data._updatedDate` field is changed to the current date and time.
|
|
575
|
+
* > - You can only patch items in collections you have created. Items in [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code) cannot be patched.
|
|
554
576
|
*
|
|
555
577
|
* @public
|
|
556
578
|
* @documentationMaturity preview
|
|
557
579
|
* @requiredField dataCollectionId
|
|
558
580
|
* @requiredField itemIds
|
|
559
|
-
* @param dataCollectionId -
|
|
581
|
+
* @param dataCollectionId - ID of the collection that contains the items to patch.
|
|
560
582
|
* @param itemIds - IDs of the data items to patch.
|
|
561
583
|
* @permissionScope Write Data Items
|
|
562
584
|
* @permissionScopeId SCOPE.DC-DATA.WRITE
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAaL,SAAS,
|
|
1
|
+
{"version":3,"file":"data-v2-data-item-items.universal.js","sourceRoot":"","sources":["../../../src/data-v2-data-item-items.universal.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAaL,SAAS,GAGV,MAAM,4BAA4B,CAAA;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,IAAiB,EACjB,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,gBAAwB,EACxB,IAA0B,EAC1B,OAA8B;IAE9B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,IAAI,CAChD,gBAAgB,EAChB,IAAI,EACJ,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CACvB,gBAAwB,EACxB,MAAc,EACd,OAA0C;IAE1C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,GAAG,CAC/C,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,gBAAwB,EACxB,MAAc,EACd,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAClD,gBAAgB,EAChB,MAAM,EACN,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,gBAAwB;IACrD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAA;AAC1E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,KAAoB,EACpB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,gBAAwB,EACxB,KAA6B,EAC7B,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,QAAQ,CACpD,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,gBAAwB,EACxB,OAAiB,EACjB,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,UAAU,CACtD,gBAAgB,EAChB,OAAO,EACP,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAAoC,EACpC,OAA4B;IAE5B,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,YAAY,CACxD,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,IACE,OAAO,KAAK,KAAK,QAAQ;QACzB,aAAa,IAAI,SAAS;QAC1B,cAAc,IAAI,SAAS,EAC3B,CAAC;QACD,0FAA0F;QAC1F,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,OAAO,CACR,CAAA;IACH,CAAC;SAAM,CAAC;QACN,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,gBAAwB,EACxB,KAAa,EACb,aAAmC,EACnC,cAA+D,EAC/D,OAAwB;IAExB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,iBAAiB,CAC7D,gBAAgB,EAChB,KAAK,EACL,aAAa,EACb,cAAc,EACd,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,KAAK,CAAC,gBAAwB,EAAE,MAAc;IAC5D,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAA;AAC/E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,SAAS,CACvB,gBAAwB,EACxB,OAAiB;IAEjB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CACrD,gBAAgB,EAChB,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,UAAU,KAAK,CAAC,gBAAwB;IAC5C,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;AACvE,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,SAAS,CAAC,gBAAwB;IAChD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAA;AAC3E,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,gBAAwB,EACxB,aAAmC,EACnC,KAAa,EACb,OAAuC;IAEvC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,eAAe,CAC3D,gBAAgB,EAChB,aAAa,EACb,KAAK,EACL,OAAO,CACR,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,MAAM;IACpB,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAA;IAED,OAAO,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CAAA;AACtD,CAAC;AAED,OAAO,EAYL,SAAS,GAIV,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/wix-data-items-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.268",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Rimvydas Gimbutas",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@wix/sdk-runtime": "^0.3.35",
|
|
37
37
|
"@wix/sdk-types": "^1.13.4",
|
|
38
|
-
"@wix/wix-data-items-common": "1.0.
|
|
38
|
+
"@wix/wix-data-items-common": "1.0.99"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@eslint/js": "^9.14.0",
|
|
@@ -74,5 +74,5 @@
|
|
|
74
74
|
"wallaby": {
|
|
75
75
|
"autoDetect": true
|
|
76
76
|
},
|
|
77
|
-
"falconPackageHash": "
|
|
77
|
+
"falconPackageHash": "7b31d52629f6deefcfa8c85c3ad33f8179cf64061e1d8ad593b3c2ae"
|
|
78
78
|
}
|