@wix/wix-data-items-common 1.0.312 → 1.0.313
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/dist/cjs/api/PipelineBuilder.js +0 -12
- package/dist/cjs/api/PipelineBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataAggregateOptionsBuilder.js +27 -3
- package/dist/cjs/api/WixDataAggregateOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataApi.js +38 -38
- package/dist/cjs/api/WixDataApi.js.map +1 -1
- package/dist/cjs/api/WixDataAsyncPatchByFilterOptionsBuilder.js +24 -3
- package/dist/cjs/api/WixDataAsyncPatchByFilterOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataAsyncRemoveByFilterOptionsBuilder.js +23 -3
- package/dist/cjs/api/WixDataAsyncRemoveByFilterOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkInsertOptionsBuilder.js +22 -3
- package/dist/cjs/api/WixDataBulkInsertOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkPatchOptionsBuilder.js +21 -3
- package/dist/cjs/api/WixDataBulkPatchOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkRemoveOptionsBuilder.js +21 -3
- package/dist/cjs/api/WixDataBulkRemoveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkSaveOptionsBuilder.js +20 -3
- package/dist/cjs/api/WixDataBulkSaveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkUpdateOptionsBuilder.js +24 -3
- package/dist/cjs/api/WixDataBulkUpdateOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataCountOptionsBuilder.js +24 -3
- package/dist/cjs/api/WixDataCountOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataDistinctOptionsBuilder.js +25 -23
- package/dist/cjs/api/WixDataDistinctOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataFieldModificationsBuilder.js +2 -1
- package/dist/cjs/api/WixDataFieldModificationsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataGetOptionsBuilder.js +27 -3
- package/dist/cjs/api/WixDataGetOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataInsertOptionsBuilder.js +20 -3
- package/dist/cjs/api/WixDataInsertOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js +25 -3
- package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataPatchOptionsBuilder.js +21 -3
- package/dist/cjs/api/WixDataPatchOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataQueryBuilder.js +12 -7
- package/dist/cjs/api/WixDataQueryBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataQueryOptionsBuilder.js +30 -3
- package/dist/cjs/api/WixDataQueryOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js +32 -3
- package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataRemoveOptionsBuilder.js +25 -3
- package/dist/cjs/api/WixDataRemoveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataSaveOptionsBuilder.js +24 -3
- package/dist/cjs/api/WixDataSaveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataSearchBuilder.js +8 -9
- package/dist/cjs/api/WixDataSearchBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataSearchOptionsBuilder.js +28 -3
- package/dist/cjs/api/WixDataSearchOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataUpdateOptionsBuilder.js +25 -3
- package/dist/cjs/api/WixDataUpdateOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/types.js.map +1 -1
- package/dist/esm/api/PipelineBuilder.js +0 -11
- package/dist/esm/api/PipelineBuilder.js.map +1 -1
- package/dist/esm/api/WixDataAggregateOptionsBuilder.js +20 -1
- package/dist/esm/api/WixDataAggregateOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataApi.js +38 -38
- package/dist/esm/api/WixDataApi.js.map +1 -1
- package/dist/esm/api/WixDataAsyncPatchByFilterOptionsBuilder.js +18 -1
- package/dist/esm/api/WixDataAsyncPatchByFilterOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataAsyncRemoveByFilterOptionsBuilder.js +17 -1
- package/dist/esm/api/WixDataAsyncRemoveByFilterOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataBulkInsertOptionsBuilder.js +16 -1
- package/dist/esm/api/WixDataBulkInsertOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataBulkPatchOptionsBuilder.js +14 -1
- package/dist/esm/api/WixDataBulkPatchOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataBulkRemoveOptionsBuilder.js +14 -1
- package/dist/esm/api/WixDataBulkRemoveOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataBulkSaveOptionsBuilder.js +14 -1
- package/dist/esm/api/WixDataBulkSaveOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataBulkUpdateOptionsBuilder.js +17 -1
- package/dist/esm/api/WixDataBulkUpdateOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataCountOptionsBuilder.js +17 -1
- package/dist/esm/api/WixDataCountOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataDistinctOptionsBuilder.js +18 -19
- package/dist/esm/api/WixDataDistinctOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataFieldModificationsBuilder.js +2 -1
- package/dist/esm/api/WixDataFieldModificationsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataGetOptionsBuilder.js +19 -1
- package/dist/esm/api/WixDataGetOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataInsertOptionsBuilder.js +13 -1
- package/dist/esm/api/WixDataInsertOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataIsReferencedOptionsBuilder.js +19 -1
- package/dist/esm/api/WixDataIsReferencedOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataPatchOptionsBuilder.js +14 -1
- package/dist/esm/api/WixDataPatchOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataQueryBuilder.js +12 -7
- package/dist/esm/api/WixDataQueryBuilder.js.map +1 -1
- package/dist/esm/api/WixDataQueryOptionsBuilder.js +23 -1
- package/dist/esm/api/WixDataQueryOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataQueryReferencedItemsOptionsBuilder.js +25 -1
- package/dist/esm/api/WixDataQueryReferencedItemsOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataRemoveOptionsBuilder.js +18 -1
- package/dist/esm/api/WixDataRemoveOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataSaveOptionsBuilder.js +17 -1
- package/dist/esm/api/WixDataSaveOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataSearchBuilder.js +6 -6
- package/dist/esm/api/WixDataSearchBuilder.js.map +1 -1
- package/dist/esm/api/WixDataSearchOptionsBuilder.js +21 -1
- package/dist/esm/api/WixDataSearchOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataUpdateOptionsBuilder.js +18 -1
- package/dist/esm/api/WixDataUpdateOptionsBuilder.js.map +1 -1
- package/dist/types/api/PipelineBuilder.d.ts +0 -11
- package/dist/types/api/PipelineBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataAggregateOptionsBuilder.d.ts +43 -3
- package/dist/types/api/WixDataAggregateOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataAsyncPatchByFilterOptionsBuilder.d.ts +36 -3
- package/dist/types/api/WixDataAsyncPatchByFilterOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataAsyncRemoveByFilterOptionsBuilder.d.ts +35 -3
- package/dist/types/api/WixDataAsyncRemoveByFilterOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataBulkInsertOptionsBuilder.d.ts +41 -3
- package/dist/types/api/WixDataBulkInsertOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataBulkPatchOptionsBuilder.d.ts +36 -3
- package/dist/types/api/WixDataBulkPatchOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataBulkRemoveOptionsBuilder.d.ts +36 -3
- package/dist/types/api/WixDataBulkRemoveOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataBulkSaveOptionsBuilder.d.ts +35 -3
- package/dist/types/api/WixDataBulkSaveOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataBulkUpdateOptionsBuilder.d.ts +42 -3
- package/dist/types/api/WixDataBulkUpdateOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataCountOptionsBuilder.d.ts +48 -3
- package/dist/types/api/WixDataCountOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts +62 -8
- package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataFieldModificationsBuilder.d.ts +1 -1
- package/dist/types/api/WixDataFieldModificationsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataGetOptionsBuilder.d.ts +57 -3
- package/dist/types/api/WixDataGetOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataInsertOptionsBuilder.d.ts +39 -3
- package/dist/types/api/WixDataInsertOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts +31 -3
- package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataPatchOptionsBuilder.d.ts +36 -3
- package/dist/types/api/WixDataPatchOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataQueryBuilder.d.ts +12 -7
- package/dist/types/api/WixDataQueryBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataQueryOptionsBuilder.d.ts +62 -3
- package/dist/types/api/WixDataQueryOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataQueryReferencedItemsOptionsBuilder.d.ts +63 -3
- package/dist/types/api/WixDataQueryReferencedItemsOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataRemoveOptionsBuilder.d.ts +40 -3
- package/dist/types/api/WixDataRemoveOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataSaveOptionsBuilder.d.ts +43 -3
- package/dist/types/api/WixDataSaveOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataSearchBuilder.d.ts +8 -9
- package/dist/types/api/WixDataSearchBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataSearchOptionsBuilder.d.ts +39 -3
- package/dist/types/api/WixDataSearchOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/WixDataUpdateOptionsBuilder.d.ts +47 -3
- package/dist/types/api/WixDataUpdateOptionsBuilder.d.ts.map +1 -1
- package/dist/types/api/types.d.ts +0 -16
- package/dist/types/api/types.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -2,36 +2,90 @@ import type { FilterExpression } from '@wix/sdk-types';
|
|
|
2
2
|
import type { WixDataDistinctOptions, WixDataItem, WixDataQuerySpec } from './types';
|
|
3
3
|
import type { SortOrder } from '../types/data-item-types';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* Builder for distinct options used by Wix Data distinct operations.
|
|
6
|
+
*
|
|
7
|
+
* Use this builder to configure distinct behavior such as language, consistency,
|
|
8
|
+
* filters, ordering, and paging.
|
|
9
|
+
* @public
|
|
10
|
+
* @builder
|
|
11
|
+
* @documentationMaturity preview
|
|
7
12
|
*/
|
|
8
13
|
export interface WixDataDistinctOptionsBuilder {
|
|
14
|
+
/**
|
|
15
|
+
* Sets whether distinct hooks are suppressed.
|
|
16
|
+
*
|
|
17
|
+
* When `true`, the distinct operation runs without triggering hooks.
|
|
18
|
+
*/
|
|
9
19
|
withSuppressHooks(value: boolean): WixDataDistinctOptionsBuilder;
|
|
20
|
+
/**
|
|
21
|
+
* Sets whether draft items are included when retrieving distinct values.
|
|
22
|
+
* @internal
|
|
23
|
+
*/
|
|
10
24
|
withShowDrafts(value: boolean): WixDataDistinctOptionsBuilder;
|
|
25
|
+
/**
|
|
26
|
+
* Sets app-specific options for the distinct operation.
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
11
29
|
withAppOptions(value: Record<string, any>): WixDataDistinctOptionsBuilder;
|
|
30
|
+
/**
|
|
31
|
+
* Sets the language used for the distinct operation.
|
|
32
|
+
*/
|
|
12
33
|
withLanguage(value: string): WixDataDistinctOptionsBuilder;
|
|
34
|
+
/**
|
|
35
|
+
* Sets whether the distinct operation uses a consistent read.
|
|
36
|
+
*/
|
|
13
37
|
withConsistentRead(value: boolean): WixDataDistinctOptionsBuilder;
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
}[]): WixDataDistinctOptionsBuilder;
|
|
38
|
+
/**
|
|
39
|
+
* Sets whether the total count is returned with the distinct results.
|
|
40
|
+
*/
|
|
18
41
|
withReturnTotalCount(value: boolean): WixDataDistinctOptionsBuilder;
|
|
19
|
-
|
|
42
|
+
/**
|
|
43
|
+
* Sets the filter used to retrieve distinct values.
|
|
44
|
+
*/
|
|
20
45
|
withFilter(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataDistinctOptionsBuilder;
|
|
46
|
+
/**
|
|
47
|
+
* Sets the sort order for the distinct results.
|
|
48
|
+
*/
|
|
21
49
|
withOrder(value: SortOrder): WixDataDistinctOptionsBuilder;
|
|
50
|
+
/**
|
|
51
|
+
* Sets offset-based paging for the distinct results.
|
|
52
|
+
*/
|
|
22
53
|
withPaging(value: {
|
|
23
54
|
limit?: number;
|
|
24
55
|
offset?: number;
|
|
25
56
|
}): WixDataDistinctOptionsBuilder;
|
|
57
|
+
/**
|
|
58
|
+
* Sets cursor-based paging for the distinct results.
|
|
59
|
+
*/
|
|
26
60
|
withCursorPaging(value: {
|
|
27
61
|
cursor?: string;
|
|
28
62
|
limit?: number;
|
|
29
63
|
}): WixDataDistinctOptionsBuilder;
|
|
64
|
+
/**
|
|
65
|
+
* Builds the distinct options object.
|
|
66
|
+
*/
|
|
30
67
|
build(): WixDataDistinctOptions;
|
|
31
68
|
}
|
|
32
69
|
/**
|
|
33
70
|
* Creates a new WixData distinct options builder.
|
|
34
|
-
* @
|
|
71
|
+
* @public
|
|
72
|
+
* @documentationMaturity preview
|
|
73
|
+
*
|
|
74
|
+
* @example
|
|
75
|
+
* ```ts
|
|
76
|
+
* import { items, DistinctOptionsBuilder } from '@wix/data'
|
|
77
|
+
*
|
|
78
|
+
* const options = DistinctOptionsBuilder()
|
|
79
|
+
* .withLanguage('en')
|
|
80
|
+
* .withConsistentRead(true)
|
|
81
|
+
* .withReturnTotalCount(true)
|
|
82
|
+
* .withFilter(Filter('status').eq('active'))
|
|
83
|
+
* .withOrder([{ fieldName: 'status', order: 'asc' }])
|
|
84
|
+
* .withPaging({ limit: 10, offset: 5 })
|
|
85
|
+
* .build()
|
|
86
|
+
*
|
|
87
|
+
* const result = await items.distinct('myCollection', 'status', options)
|
|
88
|
+
* ```
|
|
35
89
|
*/
|
|
36
90
|
export declare const DistinctOptionsBuilder: () => WixDataDistinctOptionsBuilder;
|
|
37
91
|
//# sourceMappingURL=WixDataDistinctOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataDistinctOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataDistinctOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,sBAAsB,EACtB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEzD
|
|
1
|
+
{"version":3,"file":"WixDataDistinctOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataDistinctOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,sBAAsB,EACtB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEzD;;;;;;;;GAQG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAChE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAC7D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,6BAA6B,CAAA;IACzE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,6BAA6B,CAAA;IAC1D;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACjE;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACnE;;OAEG;IACH,UAAU,CACR,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,6BAA6B,CAAA;IAChC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,6BAA6B,CAAA;IAC1D;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,6BAA6B,CAAA;IACjC;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE;QACtB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,GAAG,6BAA6B,CAAA;IACjC;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAA;CAChC;AA4ED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,6BACF,CAAA"}
|
|
@@ -72,7 +72,7 @@ export interface WixDataFieldModificationsBuilder extends FieldModificationsBuil
|
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
74
|
* ```ts
|
|
75
|
-
* import { FieldModificationsBuilder } from '@wix/
|
|
75
|
+
* import { FieldModificationsBuilder } from '@wix/data'
|
|
76
76
|
*
|
|
77
77
|
* const fieldModifications = FieldModificationsBuilder()
|
|
78
78
|
* .setField('title', 'Updated title')
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataFieldModificationsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFieldModificationsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAG5D;;;GAGG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI;IAC7C;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEzC;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEhD;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gCACf,SAAQ,yBAAyB,CAAC,gCAAgC,CAAC;IACnE,mDAAmD;IACnD,KAAK,IAAI,iBAAiB,EAAE,CAAA;CAC7B;AA+BD;;;;;;;;;;;;;;;;;GAiBG;
|
|
1
|
+
{"version":3,"file":"WixDataFieldModificationsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataFieldModificationsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAG5D;;;GAGG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI;IAC7C;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/C;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEzC;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEhD;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,gCACf,SAAQ,yBAAyB,CAAC,gCAAgC,CAAC;IACnE,mDAAmD;IACnD,KAAK,IAAI,iBAAiB,EAAE,CAAA;CAC7B;AA+BD;;;;;;;;;;;;;;;;;GAiBG;AAEH,eAAO,MAAM,yBAAyB,EAAE,MAAM,gCACI,CAAA"}
|
|
@@ -1,25 +1,79 @@
|
|
|
1
1
|
import type { WixDataGetOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* Builder for get options used by Wix Data get operations.
|
|
4
|
+
*
|
|
5
|
+
* Use this builder to configure get behavior such as hooks suppression,
|
|
6
|
+
* app-specific options, language, consistency, selected
|
|
7
|
+
* fields, references, and field groups.
|
|
8
|
+
* @public
|
|
9
|
+
* @builder
|
|
10
|
+
* @documentationMaturity preview
|
|
5
11
|
*/
|
|
6
12
|
export interface WixDataGetOptionsBuilder {
|
|
13
|
+
/**
|
|
14
|
+
* Sets whether get hooks are suppressed.
|
|
15
|
+
*
|
|
16
|
+
* When `true`, the get operation runs without triggering hooks.
|
|
17
|
+
*/
|
|
7
18
|
withSuppressHooks(value: boolean): WixDataGetOptionsBuilder;
|
|
19
|
+
/**
|
|
20
|
+
* Sets whether draft items are included when retrieving an item.
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
8
23
|
withShowDrafts(value: boolean): WixDataGetOptionsBuilder;
|
|
24
|
+
/**
|
|
25
|
+
* Sets app-specific options for the get operation.
|
|
26
|
+
*/
|
|
9
27
|
withAppOptions(value: Record<string, any>): WixDataGetOptionsBuilder;
|
|
28
|
+
/**
|
|
29
|
+
* Sets the language used for the get operation.
|
|
30
|
+
*/
|
|
10
31
|
withLanguage(value: string): WixDataGetOptionsBuilder;
|
|
32
|
+
/**
|
|
33
|
+
* Sets whether the get operation uses a consistent read.
|
|
34
|
+
*/
|
|
11
35
|
withConsistentRead(value: boolean): WixDataGetOptionsBuilder;
|
|
36
|
+
/**
|
|
37
|
+
* Sets the fields to include in the returned item.
|
|
38
|
+
*/
|
|
12
39
|
withFields(...value: string[]): WixDataGetOptionsBuilder;
|
|
40
|
+
/**
|
|
41
|
+
* Sets referenced fields to include in the returned item.
|
|
42
|
+
*/
|
|
13
43
|
withIncludeReferences(value: {
|
|
14
44
|
field: string;
|
|
15
45
|
limit?: number;
|
|
16
46
|
}[]): WixDataGetOptionsBuilder;
|
|
47
|
+
/**
|
|
48
|
+
* Sets the field groups to include in the returned item.
|
|
49
|
+
*/
|
|
17
50
|
withIncludeFieldGroups(...value: string[]): WixDataGetOptionsBuilder;
|
|
51
|
+
/**
|
|
52
|
+
* Builds the get options object.
|
|
53
|
+
*/
|
|
18
54
|
build(): WixDataGetOptions;
|
|
19
55
|
}
|
|
20
56
|
/**
|
|
21
57
|
* Creates a new WixData get options builder.
|
|
22
|
-
* @
|
|
58
|
+
* @public
|
|
59
|
+
* @documentationMaturity preview
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* ```ts
|
|
63
|
+
* import { items, GetOptionsBuilder } from '@wix/data'
|
|
64
|
+
*
|
|
65
|
+
* const options = GetOptionsBuilder()
|
|
66
|
+
* .withSuppressHooks(true)
|
|
67
|
+
* .withAppOptions({ key: 'value' })
|
|
68
|
+
* .withLanguage('es')
|
|
69
|
+
* .withConsistentRead(true)
|
|
70
|
+
* .withFields('_id', 'foo')
|
|
71
|
+
* .withIncludeReferences([{ field: 'author', limit: 1 }])
|
|
72
|
+
* .withIncludeFieldGroups('group-a')
|
|
73
|
+
* .build()
|
|
74
|
+
*
|
|
75
|
+
* const item = await items.get('myCollection', 'someId', options)
|
|
76
|
+
* ```
|
|
23
77
|
*/
|
|
24
78
|
export declare const GetOptionsBuilder: () => WixDataGetOptionsBuilder;
|
|
25
79
|
//# sourceMappingURL=WixDataGetOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataGetOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataGetOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD
|
|
1
|
+
{"version":3,"file":"WixDataGetOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataGetOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAEhD;;;;;;;;;GASG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC3D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IACxD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,wBAAwB,CAAA;IACpE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,wBAAwB,CAAA;IACrD;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,wBAAwB,CAAA;IAC5D;;OAEG;IACH,UAAU,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACxD;;OAEG;IACH,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,wBAAwB,CAAA;IAC3B;;OAEG;IACH,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,wBAAwB,CAAA;IACpE;;OAEG;IACH,KAAK,IAAI,iBAAiB,CAAA;CAC3B;AAuED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,iBAAiB,EAAE,MAAM,wBACF,CAAA"}
|
|
@@ -1,18 +1,54 @@
|
|
|
1
1
|
import type { WixDataInsertOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* Builder for insert options used by Wix Data insert operations.
|
|
4
|
+
*
|
|
5
|
+
* Use this builder to configure insert behavior such as hooks suppression,
|
|
6
|
+
* and reference handling.
|
|
7
|
+
* @public
|
|
8
|
+
* @builder
|
|
9
|
+
* @documentationMaturity preview
|
|
5
10
|
*/
|
|
6
11
|
export interface WixDataInsertOptionsBuilder {
|
|
12
|
+
/**
|
|
13
|
+
* Sets whether insert hooks are suppressed.
|
|
14
|
+
*
|
|
15
|
+
* When `true`, the insert runs without triggering hooks.
|
|
16
|
+
*/
|
|
7
17
|
withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder;
|
|
18
|
+
/**
|
|
19
|
+
* Sets whether draft items are included when inserting an item.
|
|
20
|
+
* @internal
|
|
21
|
+
*/
|
|
8
22
|
withShowDrafts(value: boolean): WixDataInsertOptionsBuilder;
|
|
23
|
+
/**
|
|
24
|
+
* Sets whether references are included when inserting an item.
|
|
25
|
+
* @internal
|
|
26
|
+
*/
|
|
9
27
|
withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder;
|
|
28
|
+
/**
|
|
29
|
+
* Sets whether referenced items are saved when inserting an item.
|
|
30
|
+
*/
|
|
10
31
|
withSaveReferences(value: boolean): WixDataInsertOptionsBuilder;
|
|
32
|
+
/**
|
|
33
|
+
* Builds the insert options object.
|
|
34
|
+
*/
|
|
11
35
|
build(): WixDataInsertOptions;
|
|
12
36
|
}
|
|
13
37
|
/**
|
|
14
38
|
* Creates a new WixData insert options builder.
|
|
15
|
-
* @
|
|
39
|
+
* @public
|
|
40
|
+
* @documentationMaturity preview
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* import { items, InsertOptionsBuilder } from '@wix/data'
|
|
45
|
+
*
|
|
46
|
+
* const options = InsertOptionsBuilder()
|
|
47
|
+
* .withSuppressHooks(true)
|
|
48
|
+
* .build()
|
|
49
|
+
*
|
|
50
|
+
* const item = await items.insert('myCollection', { foo: 'bar' }, options)
|
|
51
|
+
* ```
|
|
16
52
|
*/
|
|
17
53
|
export declare const InsertOptionsBuilder: () => WixDataInsertOptionsBuilder;
|
|
18
54
|
//# sourceMappingURL=WixDataInsertOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataInsertOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataInsertOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD
|
|
1
|
+
{"version":3,"file":"WixDataInsertOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataInsertOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAEnD;;;;;;;;GAQG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC9D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC3D;;;OAGG;IACH,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAClE;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,2BAA2B,CAAA;IAC/D;;OAEG;IACH,KAAK,IAAI,oBAAoB,CAAA;CAC9B;AAiCD;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,2BACF,CAAA"}
|
|
@@ -1,15 +1,43 @@
|
|
|
1
1
|
import type { WixDataIsReferencedOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* Builder for isReferenced options used by Wix Data isReferenced operations.
|
|
4
|
+
*
|
|
5
|
+
* Use this builder to configure whether the reference check uses a consistent read.
|
|
6
|
+
* @public
|
|
7
|
+
* @builder
|
|
8
|
+
* @documentationMaturity preview
|
|
5
9
|
*/
|
|
6
10
|
export interface WixDataIsReferencedOptionsBuilder {
|
|
11
|
+
/**
|
|
12
|
+
* Sets whether the reference check uses a consistent read.
|
|
13
|
+
*/
|
|
7
14
|
withConsistentRead(value: boolean): WixDataIsReferencedOptionsBuilder;
|
|
15
|
+
/**
|
|
16
|
+
* Builds the isReferenced options object.
|
|
17
|
+
*/
|
|
8
18
|
build(): WixDataIsReferencedOptions;
|
|
9
19
|
}
|
|
10
20
|
/**
|
|
11
21
|
* Creates a new WixData isReferenced options builder.
|
|
12
|
-
* @
|
|
22
|
+
* @public
|
|
23
|
+
* @documentationMaturity preview
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
* ```ts
|
|
27
|
+
* import { items, IsReferencedOptionsBuilder } from '@wix/data'
|
|
28
|
+
*
|
|
29
|
+
* const options = IsReferencedOptionsBuilder()
|
|
30
|
+
* .withConsistentRead(true)
|
|
31
|
+
* .build()
|
|
32
|
+
*
|
|
33
|
+
* const isReferenced = await items.isReferenced(
|
|
34
|
+
* 'myCollection',
|
|
35
|
+
* 'someField',
|
|
36
|
+
* 'referringItemId',
|
|
37
|
+
* 'referencedItemId',
|
|
38
|
+
* options
|
|
39
|
+
* )
|
|
40
|
+
* ```
|
|
13
41
|
*/
|
|
14
42
|
export declare const IsReferencedOptionsBuilder: () => WixDataIsReferencedOptionsBuilder;
|
|
15
43
|
//# sourceMappingURL=WixDataIsReferencedOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataIsReferencedOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataIsReferencedOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEzD
|
|
1
|
+
{"version":3,"file":"WixDataIsReferencedOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataIsReferencedOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAEzD;;;;;;;GAOG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,iCAAiC,CAAA;IACrE;;OAEG;IACH,KAAK,IAAI,0BAA0B,CAAA;CACpC;AA2BD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,0BAA0B,EAAE,MAAM,iCACI,CAAA"}
|
|
@@ -2,18 +2,51 @@ import type { FilterExpression } from '@wix/sdk-types';
|
|
|
2
2
|
import type { WixDataItem, WixDataQuerySpec } from './types';
|
|
3
3
|
import type { WixDataPatchOptions } from './WixDataPatch';
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
5
|
+
* Builder for patch options used by Wix Data patch operations.
|
|
6
|
+
*
|
|
7
|
+
* Use this builder to configure patch behavior such as hooks suppression,
|
|
8
|
+
* and conditional patching.
|
|
9
|
+
* @public
|
|
10
|
+
* @builder
|
|
11
|
+
* @documentationMaturity preview
|
|
7
12
|
*/
|
|
8
13
|
export interface WixDataPatchOptionsBuilder {
|
|
14
|
+
/**
|
|
15
|
+
* Sets whether patch hooks are suppressed.
|
|
16
|
+
*
|
|
17
|
+
* When `true`, the patch runs without triggering hooks.
|
|
18
|
+
*/
|
|
9
19
|
withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder;
|
|
20
|
+
/**
|
|
21
|
+
* Sets whether draft items are included when patching an item.
|
|
22
|
+
* @internal
|
|
23
|
+
*/
|
|
10
24
|
withShowDrafts(value: boolean): WixDataPatchOptionsBuilder;
|
|
25
|
+
/**
|
|
26
|
+
* Sets the condition that determines whether the item is patched.
|
|
27
|
+
*/
|
|
11
28
|
withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataPatchOptionsBuilder;
|
|
29
|
+
/**
|
|
30
|
+
* Builds the patch options object.
|
|
31
|
+
*/
|
|
12
32
|
build(): WixDataPatchOptions;
|
|
13
33
|
}
|
|
14
34
|
/**
|
|
15
35
|
* Creates a new WixData patch options builder.
|
|
16
|
-
* @
|
|
36
|
+
* @public
|
|
37
|
+
* @documentationMaturity preview
|
|
38
|
+
*
|
|
39
|
+
* @example
|
|
40
|
+
* ```ts
|
|
41
|
+
* import { items, PatchOptionsBuilder, Filter } from '@wix/data'
|
|
42
|
+
*
|
|
43
|
+
* const options = PatchOptionsBuilder()
|
|
44
|
+
* .withSuppressHooks(true)
|
|
45
|
+
* .withCondition(Filter('status').eq('active'))
|
|
46
|
+
* .build()
|
|
47
|
+
*
|
|
48
|
+
* const item = await items.patch('myCollection', 'someId', option)
|
|
49
|
+
* ```
|
|
17
50
|
*/
|
|
18
51
|
export declare const PatchOptionsBuilder: () => WixDataPatchOptionsBuilder;
|
|
19
52
|
//# sourceMappingURL=WixDataPatchOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataPatchOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatchOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEzD
|
|
1
|
+
{"version":3,"file":"WixDataPatchOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatchOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAC5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEzD;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D;;OAEG;IACH,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,0BAA0B,CAAA;IAC7B;;OAEG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAiCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}
|
|
@@ -7,11 +7,12 @@ import { WixDataQueryRequest, WixDataQuerySpec, WixDataItem } from './types';
|
|
|
7
7
|
export type WixDataQueryBuilder = SDKQueryBuilder<WixDataItem, WixDataQuerySpec, WixDataQueryRequest>;
|
|
8
8
|
/**
|
|
9
9
|
* Creates a new WixData query builder.
|
|
10
|
-
* @
|
|
10
|
+
* @public
|
|
11
|
+
* @documentationMaturity preview
|
|
11
12
|
*
|
|
12
13
|
* @example
|
|
13
14
|
* ```ts
|
|
14
|
-
* import { QueryBuilder, Filter, Sort } from '@wix/
|
|
15
|
+
* import { items, QueryBuilder, Filter, Sort } from '@wix/data'
|
|
15
16
|
*
|
|
16
17
|
* const request = QueryBuilder()
|
|
17
18
|
* .withFilter(
|
|
@@ -24,17 +25,19 @@ export type WixDataQueryBuilder = SDKQueryBuilder<WixDataItem, WixDataQuerySpec,
|
|
|
24
25
|
* .withPaging({ limit: 10, offset: 0 })
|
|
25
26
|
* .build()
|
|
26
27
|
*
|
|
27
|
-
* const result = await
|
|
28
|
+
* const result = await items.query<MyItem>('myCollection', request)
|
|
28
29
|
* ```
|
|
29
30
|
*/
|
|
30
31
|
export declare const QueryBuilder: () => WixDataQueryBuilder;
|
|
31
32
|
/**
|
|
32
33
|
* Filter factory for creating filter expressions.
|
|
33
|
-
*
|
|
34
|
-
* @
|
|
34
|
+
* @public
|
|
35
|
+
* @documentationMaturity preview
|
|
35
36
|
*
|
|
36
37
|
* @example
|
|
37
38
|
* ```ts
|
|
39
|
+
* import { Filter } from '@wix/data'
|
|
40
|
+
*
|
|
38
41
|
* // Simple field filter
|
|
39
42
|
* Filter('status').eq('active')
|
|
40
43
|
*
|
|
@@ -57,11 +60,13 @@ export declare const QueryBuilder: () => WixDataQueryBuilder;
|
|
|
57
60
|
export declare const Filter: FilterFactory<WixDataItem, WixDataQuerySpec>;
|
|
58
61
|
/**
|
|
59
62
|
* Sort factory for creating sort expressions.
|
|
60
|
-
*
|
|
61
|
-
* @
|
|
63
|
+
* @public
|
|
64
|
+
* @documentationMaturity preview
|
|
62
65
|
*
|
|
63
66
|
* @example
|
|
64
67
|
* ```ts
|
|
68
|
+
* import { Sort, QueryBuilder } from '@wix/data'
|
|
69
|
+
*
|
|
65
70
|
* // Descending sort
|
|
66
71
|
* Sort('amount').desc()
|
|
67
72
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataQueryBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryBuilder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,IAAI,eAAe,EAC/B,aAAa,EACb,WAAW,EACZ,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAS5E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAC/C,WAAW,EACX,gBAAgB,EAChB,mBAAmB,CACpB,CAAA;AAED
|
|
1
|
+
{"version":3,"file":"WixDataQueryBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryBuilder.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,IAAI,eAAe,EAC/B,aAAa,EACb,WAAW,EACZ,MAAM,gBAAgB,CAAA;AACvB,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAS5E;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAC/C,WAAW,EACX,gBAAgB,EAChB,mBAAmB,CACpB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,mBACJ,CAAA;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,MAAM,EAAE,aAAa,CAAC,WAAW,EAAE,gBAAgB,CACzC,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI,EAAE,WAAW,CAAC,gBAAgB,CAAuB,CAAA;AAGtE,YAAY,EACV,gBAAgB,EAChB,cAAc,EACd,SAAS,GACV,MAAM,gBAAgB,CAAA"}
|
|
@@ -1,25 +1,84 @@
|
|
|
1
1
|
import type { WixDataQueryOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
4
|
-
*
|
|
3
|
+
* Builder for query options used by Wix Data query operations.
|
|
4
|
+
*
|
|
5
|
+
* Use this builder to configure query behavior such as hooks suppression,
|
|
6
|
+
* language, reference inclusion, and field groups.
|
|
7
|
+
* @public
|
|
8
|
+
* @builder
|
|
9
|
+
* @documentationMaturity preview
|
|
5
10
|
*/
|
|
6
11
|
export interface WixDataQueryOptionsBuilder {
|
|
12
|
+
/**
|
|
13
|
+
* Sets whether query hooks are suppressed.
|
|
14
|
+
*
|
|
15
|
+
* When `true`, the query runs without triggering hooks.
|
|
16
|
+
*/
|
|
7
17
|
withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder;
|
|
18
|
+
/**
|
|
19
|
+
* Sets whether draft items are included in query results.
|
|
20
|
+
* @internal
|
|
21
|
+
*/
|
|
8
22
|
withShowDrafts(value: boolean): WixDataQueryOptionsBuilder;
|
|
23
|
+
/**
|
|
24
|
+
* Sets app-specific query options.
|
|
25
|
+
*/
|
|
9
26
|
withAppOptions(value: Record<string, any>): WixDataQueryOptionsBuilder;
|
|
27
|
+
/**
|
|
28
|
+
* Sets the language used for the query.
|
|
29
|
+
*/
|
|
10
30
|
withLanguage(value: string): WixDataQueryOptionsBuilder;
|
|
31
|
+
/**
|
|
32
|
+
* Sets whether the query uses consistent read mode.
|
|
33
|
+
*/
|
|
11
34
|
withConsistentRead(value: boolean): WixDataQueryOptionsBuilder;
|
|
35
|
+
/**
|
|
36
|
+
* Includes referenced items for the specified reference fields.
|
|
37
|
+
*
|
|
38
|
+
* Use `limit` to cap how many referenced items are returned per field.
|
|
39
|
+
*/
|
|
12
40
|
withIncludeReferences(value: {
|
|
13
41
|
field: string;
|
|
14
42
|
limit?: number;
|
|
15
43
|
}[]): WixDataQueryOptionsBuilder;
|
|
44
|
+
/**
|
|
45
|
+
* Sets whether the total result count is returned with the query response.
|
|
46
|
+
*/
|
|
16
47
|
withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder;
|
|
48
|
+
/**
|
|
49
|
+
* Includes the specified field groups in the query results.
|
|
50
|
+
*/
|
|
17
51
|
withIncludeFieldGroups(...value: string[]): WixDataQueryOptionsBuilder;
|
|
52
|
+
/**
|
|
53
|
+
* Builds the query options object.
|
|
54
|
+
*/
|
|
18
55
|
build(): WixDataQueryOptions;
|
|
19
56
|
}
|
|
20
57
|
/**
|
|
21
58
|
* Creates a new WixData query options builder.
|
|
22
|
-
* @
|
|
59
|
+
* @public
|
|
60
|
+
* @documentationMaturity preview
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* import { items, QueryOptionsBuilder } from '@wix/data'
|
|
65
|
+
*
|
|
66
|
+
* const options = QueryOptionsBuilder()
|
|
67
|
+
* .withSuppressHooks(true)
|
|
68
|
+
* .withAppOptions({ key: 'value' })
|
|
69
|
+
* .withLanguage('en')
|
|
70
|
+
* .withConsistentRead(true)
|
|
71
|
+
* .withIncludeReferences([{ field: 'author', limit: 3 }])
|
|
72
|
+
* .withReturnTotalCount(true)
|
|
73
|
+
* .withIncludeFieldGroups('seo', 'details')
|
|
74
|
+
* .build()
|
|
75
|
+
*
|
|
76
|
+
* const result = await items.query<MyItem>(
|
|
77
|
+
* 'myCollection',
|
|
78
|
+
* {},
|
|
79
|
+
* options
|
|
80
|
+
* )
|
|
81
|
+
* ```
|
|
23
82
|
*/
|
|
24
83
|
export declare const QueryOptionsBuilder: () => WixDataQueryOptionsBuilder;
|
|
25
84
|
//# sourceMappingURL=WixDataQueryOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataQueryOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD
|
|
1
|
+
{"version":3,"file":"WixDataQueryOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,0BAA0B,CAAA;IACtE;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,0BAA0B,CAAA;IACvD;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC9D;;;;OAIG;IACH,qBAAqB,CACnB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,GACzC,0BAA0B,CAAA;IAC7B;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAChE;;OAEG;IACH,sBAAsB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,0BAA0B,CAAA;IACtE;;OAEG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAsED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}
|
|
@@ -1,30 +1,90 @@
|
|
|
1
1
|
import type { SortOrder } from '../types/data-item-types';
|
|
2
2
|
import type { WixDataQueryReferencedItemsOptions } from './types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
4
|
+
* Builder for query referenced items options used by Wix Data query referenced items operations.
|
|
5
|
+
*
|
|
6
|
+
* Use this builder to configure referenced item query behavior such as language,
|
|
7
|
+
* selected fields, sort order and paging.
|
|
8
|
+
* @public
|
|
9
|
+
* @builder
|
|
10
|
+
* @documentationMaturity preview
|
|
6
11
|
*/
|
|
7
12
|
export interface WixDataQueryReferencedItemsOptionsBuilder {
|
|
13
|
+
/**
|
|
14
|
+
* Sets whether draft items are included in query results.
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
8
17
|
withShowDrafts(value: boolean): WixDataQueryReferencedItemsOptionsBuilder;
|
|
18
|
+
/**
|
|
19
|
+
* Sets app-specific query options.
|
|
20
|
+
*/
|
|
9
21
|
withAppOptions(value: Record<string, any>): WixDataQueryReferencedItemsOptionsBuilder;
|
|
22
|
+
/**
|
|
23
|
+
* Sets the language used for the query.
|
|
24
|
+
*/
|
|
10
25
|
withLanguage(value: string): WixDataQueryReferencedItemsOptionsBuilder;
|
|
26
|
+
/**
|
|
27
|
+
* Sets whether the query uses consistent read mode.
|
|
28
|
+
*/
|
|
11
29
|
withConsistentRead(value: boolean): WixDataQueryReferencedItemsOptionsBuilder;
|
|
30
|
+
/**
|
|
31
|
+
* Sets whether the total result count is returned with the query response.
|
|
32
|
+
*/
|
|
12
33
|
withReturnTotalCount(value: boolean): WixDataQueryReferencedItemsOptionsBuilder;
|
|
34
|
+
/**
|
|
35
|
+
* Sets the fields returned for each referenced item.
|
|
36
|
+
*/
|
|
13
37
|
withFields(...value: string[]): WixDataQueryReferencedItemsOptionsBuilder;
|
|
38
|
+
/**
|
|
39
|
+
* Sets the sort order of the query results.
|
|
40
|
+
*/
|
|
14
41
|
withOrder(value: SortOrder): WixDataQueryReferencedItemsOptionsBuilder;
|
|
42
|
+
/**
|
|
43
|
+
* Sets offset-based paging options.
|
|
44
|
+
*/
|
|
15
45
|
withPaging(value: {
|
|
16
46
|
limit?: number;
|
|
17
47
|
offset?: number;
|
|
18
48
|
}): WixDataQueryReferencedItemsOptionsBuilder;
|
|
49
|
+
/**
|
|
50
|
+
* Sets cursor-based paging options.
|
|
51
|
+
*/
|
|
19
52
|
withCursorPaging(value: {
|
|
20
53
|
cursor?: string;
|
|
21
54
|
limit?: number;
|
|
22
55
|
}): WixDataQueryReferencedItemsOptionsBuilder;
|
|
56
|
+
/**
|
|
57
|
+
* Builds the query referenced items options object.
|
|
58
|
+
*/
|
|
23
59
|
build(): WixDataQueryReferencedItemsOptions;
|
|
24
60
|
}
|
|
25
61
|
/**
|
|
26
62
|
* Creates a new WixData query referenced items options builder.
|
|
27
|
-
* @
|
|
63
|
+
* @public
|
|
64
|
+
* @documentationMaturity preview
|
|
65
|
+
*
|
|
66
|
+
* @example
|
|
67
|
+
* ```ts
|
|
68
|
+
* import { items, QueryReferencedItemsOptionsBuilder } from '@wix/data'
|
|
69
|
+
*
|
|
70
|
+
* const options = QueryReferencedItemsOptionsBuilder()
|
|
71
|
+
* .withAppOptions({ key: 'value' })
|
|
72
|
+
* .withLanguage('en')
|
|
73
|
+
* .withConsistentRead(true)
|
|
74
|
+
* .withReturnTotalCount(true)
|
|
75
|
+
* .withFields('_id', 'title')
|
|
76
|
+
* .withOrder('ASC')
|
|
77
|
+
* .withPaging({ limit: 10, offset: 0 })
|
|
78
|
+
* .withCursorPaging({ cursor: 'eyJpZCI6IjEyMyJ9', limit: 10 })
|
|
79
|
+
* .build()
|
|
80
|
+
*
|
|
81
|
+
* const result = await items.queryReferencedItems<MyItem>(
|
|
82
|
+
* 'myCollection',
|
|
83
|
+
* 'myItemId',
|
|
84
|
+
* 'relatedItems',
|
|
85
|
+
* options
|
|
86
|
+
* )
|
|
87
|
+
* ```
|
|
28
88
|
*/
|
|
29
89
|
export declare const QueryReferencedItemsOptionsBuilder: () => WixDataQueryReferencedItemsOptionsBuilder;
|
|
30
90
|
//# sourceMappingURL=WixDataQueryReferencedItemsOptionsBuilder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataQueryReferencedItemsOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryReferencedItemsOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,SAAS,CAAA;AAEjE
|
|
1
|
+
{"version":3,"file":"WixDataQueryReferencedItemsOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataQueryReferencedItemsOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,SAAS,CAAA;AAEjE;;;;;;;;GAQG;AACH,MAAM,WAAW,yCAAyC;IACxD;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,yCAAyC,CAAA;IACzE;;OAEG;IACH,cAAc,CACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACzB,yCAAyC,CAAA;IAC5C;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,yCAAyC,CAAA;IACtE;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,yCAAyC,CAAA;IAC7E;;OAEG;IACH,oBAAoB,CAClB,KAAK,EAAE,OAAO,GACb,yCAAyC,CAAA;IAC5C;;OAEG;IACH,UAAU,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,yCAAyC,CAAA;IACzE;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,yCAAyC,CAAA;IACtE;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,yCAAyC,CAAA;IAC7C;;OAEG;IACH,gBAAgB,CAAC,KAAK,EAAE;QACtB,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,GAAG,yCAAyC,CAAA;IAC7C;;OAEG;IACH,KAAK,IAAI,kCAAkC,CAAA;CAC5C;AAiFD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,kCAAkC,EAAE,MAAM,yCACI,CAAA"}
|