@wix/wix-data-items-common 1.0.318 → 1.0.320
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/WixDataAggregateOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataAggregateOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataAsyncPatchByFilterOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataAsyncPatchByFilterOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataAsyncRemoveByFilterOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataAsyncRemoveByFilterOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkInsertOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataBulkInsertOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkPatchOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataBulkPatchOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkRemoveOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataBulkRemoveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkSaveOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataBulkSaveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataBulkUpdateOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataBulkUpdateOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataCountOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataCountOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataDistinctOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataDistinctOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataFieldModificationsBuilder.js +2 -2
- package/dist/cjs/api/WixDataFieldModificationsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataGetOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataGetOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataInsertOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataInsertOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataPatchOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataPatchOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataQueryBuilder.js +4 -4
- package/dist/cjs/api/WixDataQueryBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataQueryOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataQueryOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataRemoveOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataRemoveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataSaveOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataSaveOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataSearchBuilder.js +4 -4
- package/dist/cjs/api/WixDataSearchBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataSearchOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataSearchOptionsBuilder.js.map +1 -1
- package/dist/cjs/api/WixDataUpdateOptionsBuilder.js +3 -3
- package/dist/cjs/api/WixDataUpdateOptionsBuilder.js.map +1 -1
- package/dist/esm/api/WixDataAggregateOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataAsyncPatchByFilterOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataAsyncRemoveByFilterOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataBulkInsertOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataBulkPatchOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataBulkRemoveOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataBulkSaveOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataBulkUpdateOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataCountOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataDistinctOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataFieldModificationsBuilder.js +2 -2
- package/dist/esm/api/WixDataGetOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataInsertOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataIsReferencedOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataPatchOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataQueryBuilder.js +4 -4
- package/dist/esm/api/WixDataQueryOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataQueryReferencedItemsOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataRemoveOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataSaveOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataSearchBuilder.js +3 -3
- package/dist/esm/api/WixDataSearchOptionsBuilder.js +2 -2
- package/dist/esm/api/WixDataUpdateOptionsBuilder.js +2 -2
- package/dist/types/api/WixDataAggregateOptionsBuilder.d.ts +5 -5
- package/dist/types/api/WixDataAsyncPatchByFilterOptionsBuilder.d.ts +5 -5
- package/dist/types/api/WixDataAsyncRemoveByFilterOptionsBuilder.d.ts +5 -5
- package/dist/types/api/WixDataBulkInsertOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataBulkPatchOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataBulkRemoveOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataBulkSaveOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataBulkUpdateOptionsBuilder.d.ts +7 -7
- package/dist/types/api/WixDataCountOptionsBuilder.d.ts +5 -5
- package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataFieldModificationsBuilder.d.ts +2 -2
- package/dist/types/api/WixDataGetOptionsBuilder.d.ts +5 -5
- package/dist/types/api/WixDataInsertOptionsBuilder.d.ts +7 -7
- package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts +3 -3
- package/dist/types/api/WixDataPatchOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataQueryBuilder.d.ts +4 -4
- package/dist/types/api/WixDataQueryOptionsBuilder.d.ts +7 -7
- package/dist/types/api/WixDataQueryReferencedItemsOptionsBuilder.d.ts +5 -5
- package/dist/types/api/WixDataRemoveOptionsBuilder.d.ts +6 -6
- package/dist/types/api/WixDataSaveOptionsBuilder.d.ts +7 -7
- package/dist/types/api/WixDataSearchBuilder.d.ts +4 -4
- package/dist/types/api/WixDataSearchOptionsBuilder.d.ts +4 -4
- package/dist/types/api/WixDataUpdateOptionsBuilder.d.ts +8 -8
- package/package.json +3 -3
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { FilterExpression } from '@wix/sdk-types';
|
|
2
2
|
import type { WixDataBulkUpdateOptions, WixDataItem, WixDataQuerySpec } from './types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Options builder for bulk update operations.
|
|
5
5
|
*
|
|
6
6
|
* Use this builder to configure bulk update behavior such as hooks suppression,
|
|
7
7
|
* reference saving, and conditional updates.
|
|
@@ -11,22 +11,22 @@ import type { WixDataBulkUpdateOptions, WixDataItem, WixDataQuerySpec } from './
|
|
|
11
11
|
*/
|
|
12
12
|
export interface WixDataBulkUpdateOptionsBuilder {
|
|
13
13
|
/**
|
|
14
|
-
* Sets whether update hooks
|
|
14
|
+
* Sets whether to suppress update hooks.
|
|
15
15
|
*
|
|
16
16
|
* When `true`, the bulk update runs without triggering hooks.
|
|
17
17
|
*/
|
|
18
18
|
withSuppressHooks(value: boolean): WixDataBulkUpdateOptionsBuilder;
|
|
19
19
|
/**
|
|
20
|
-
* Sets whether draft items
|
|
20
|
+
* Sets whether to include draft items when updating items in bulk.
|
|
21
21
|
* @internal
|
|
22
22
|
*/
|
|
23
23
|
withShowDrafts(value: boolean): WixDataBulkUpdateOptionsBuilder;
|
|
24
24
|
/**
|
|
25
|
-
* Sets whether referenced items
|
|
25
|
+
* Sets whether to save referenced items when updating items in bulk.
|
|
26
26
|
*/
|
|
27
27
|
withSaveReferences(value: boolean): WixDataBulkUpdateOptionsBuilder;
|
|
28
28
|
/**
|
|
29
|
-
* Sets the condition that determines which items
|
|
29
|
+
* Sets the condition that determines which items to update.
|
|
30
30
|
*/
|
|
31
31
|
withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataBulkUpdateOptionsBuilder;
|
|
32
32
|
/**
|
|
@@ -35,12 +35,12 @@ export interface WixDataBulkUpdateOptionsBuilder {
|
|
|
35
35
|
build(): WixDataBulkUpdateOptions;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* Creates a new
|
|
38
|
+
* Creates a new bulk update options builder.
|
|
39
39
|
* @public
|
|
40
40
|
* @documentationMaturity preview
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
|
-
* ```ts
|
|
43
|
+
* ```ts title="Create a bulk update options builder"
|
|
44
44
|
* import { items, BulkUpdateOptionsBuilder, Filter } from '@wix/data'
|
|
45
45
|
*
|
|
46
46
|
* const options = BulkUpdateOptionsBuilder()
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { FilterExpression } from '@wix/sdk-types';
|
|
2
2
|
import type { WixDataCountOptions, WixDataItem, WixDataQuerySpec } from './types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Options builder for count operations.
|
|
5
5
|
*
|
|
6
6
|
* Use this builder to configure count behavior such as hooks suppression,
|
|
7
7
|
* app-specific options, language, consistency, and filters.
|
|
@@ -11,13 +11,13 @@ import type { WixDataCountOptions, WixDataItem, WixDataQuerySpec } from './types
|
|
|
11
11
|
*/
|
|
12
12
|
export interface WixDataCountOptionsBuilder {
|
|
13
13
|
/**
|
|
14
|
-
* Sets whether count hooks
|
|
14
|
+
* Sets whether to suppress count hooks.
|
|
15
15
|
*
|
|
16
16
|
* When `true`, the count runs without triggering hooks.
|
|
17
17
|
*/
|
|
18
18
|
withSuppressHooks(value: boolean): WixDataCountOptionsBuilder;
|
|
19
19
|
/**
|
|
20
|
-
* Sets whether draft items
|
|
20
|
+
* Sets whether to include draft items when counting items.
|
|
21
21
|
* @internal
|
|
22
22
|
*/
|
|
23
23
|
withShowDrafts(value: boolean): WixDataCountOptionsBuilder;
|
|
@@ -43,12 +43,12 @@ export interface WixDataCountOptionsBuilder {
|
|
|
43
43
|
build(): WixDataCountOptions;
|
|
44
44
|
}
|
|
45
45
|
/**
|
|
46
|
-
* Creates a new
|
|
46
|
+
* Creates a new count options builder.
|
|
47
47
|
* @public
|
|
48
48
|
* @documentationMaturity preview
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
|
-
* ```ts
|
|
51
|
+
* ```ts title="Create a count options builder"
|
|
52
52
|
* import { items, CountOptionsBuilder } from '@wix/data'
|
|
53
53
|
*
|
|
54
54
|
* const options = CountOptionsBuilder()
|
|
@@ -2,7 +2,7 @@ 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
|
-
*
|
|
5
|
+
* Options builder for distinct operations.
|
|
6
6
|
*
|
|
7
7
|
* Use this builder to configure distinct behavior such as language, consistency,
|
|
8
8
|
* filters, ordering, and paging.
|
|
@@ -12,13 +12,13 @@ import type { SortOrder } from '../types/data-item-types';
|
|
|
12
12
|
*/
|
|
13
13
|
export interface WixDataDistinctOptionsBuilder {
|
|
14
14
|
/**
|
|
15
|
-
* Sets whether distinct hooks
|
|
15
|
+
* Sets whether to suppress distinct hooks.
|
|
16
16
|
*
|
|
17
17
|
* When `true`, the distinct operation runs without triggering hooks.
|
|
18
18
|
*/
|
|
19
19
|
withSuppressHooks(value: boolean): WixDataDistinctOptionsBuilder;
|
|
20
20
|
/**
|
|
21
|
-
* Sets whether draft items
|
|
21
|
+
* Sets whether to include draft items when retrieving distinct values.
|
|
22
22
|
* @internal
|
|
23
23
|
*/
|
|
24
24
|
withShowDrafts(value: boolean): WixDataDistinctOptionsBuilder;
|
|
@@ -36,7 +36,7 @@ export interface WixDataDistinctOptionsBuilder {
|
|
|
36
36
|
*/
|
|
37
37
|
withConsistentRead(value: boolean): WixDataDistinctOptionsBuilder;
|
|
38
38
|
/**
|
|
39
|
-
* Sets whether the total count
|
|
39
|
+
* Sets whether to return the total count with the distinct results.
|
|
40
40
|
*/
|
|
41
41
|
withReturnTotalCount(value: boolean): WixDataDistinctOptionsBuilder;
|
|
42
42
|
/**
|
|
@@ -67,12 +67,12 @@ export interface WixDataDistinctOptionsBuilder {
|
|
|
67
67
|
build(): WixDataDistinctOptions;
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* Creates a new
|
|
70
|
+
* Creates a new distinct options builder.
|
|
71
71
|
* @public
|
|
72
72
|
* @documentationMaturity preview
|
|
73
73
|
*
|
|
74
74
|
* @example
|
|
75
|
-
* ```ts
|
|
75
|
+
* ```ts title="Create a distinct options builder"
|
|
76
76
|
* import { items, DistinctOptionsBuilder } from '@wix/data'
|
|
77
77
|
*
|
|
78
78
|
* const options = DistinctOptionsBuilder()
|
|
@@ -67,11 +67,11 @@ export interface WixDataFieldModificationsBuilder extends FieldModificationsBuil
|
|
|
67
67
|
build(): FieldModification[];
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* Creates a new
|
|
70
|
+
* Creates a new field modifications builder.
|
|
71
71
|
* @internal
|
|
72
72
|
*
|
|
73
73
|
* @example
|
|
74
|
-
* ```ts
|
|
74
|
+
* ```ts title="Create field modifications"
|
|
75
75
|
* import { FieldModificationsBuilder } from '@wix/data'
|
|
76
76
|
*
|
|
77
77
|
* const fieldModifications = FieldModificationsBuilder()
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WixDataGetOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Options builder for get operations.
|
|
4
4
|
*
|
|
5
5
|
* Use this builder to configure get behavior such as hooks suppression,
|
|
6
6
|
* app-specific options, language, consistency, selected
|
|
@@ -11,13 +11,13 @@ import type { WixDataGetOptions } from './types';
|
|
|
11
11
|
*/
|
|
12
12
|
export interface WixDataGetOptionsBuilder {
|
|
13
13
|
/**
|
|
14
|
-
* Sets whether get hooks
|
|
14
|
+
* Sets whether to suppress get hooks.
|
|
15
15
|
*
|
|
16
16
|
* When `true`, the get operation runs without triggering hooks.
|
|
17
17
|
*/
|
|
18
18
|
withSuppressHooks(value: boolean): WixDataGetOptionsBuilder;
|
|
19
19
|
/**
|
|
20
|
-
* Sets whether draft items
|
|
20
|
+
* Sets whether to include draft items when retrieving an item.
|
|
21
21
|
* @internal
|
|
22
22
|
*/
|
|
23
23
|
withShowDrafts(value: boolean): WixDataGetOptionsBuilder;
|
|
@@ -54,12 +54,12 @@ export interface WixDataGetOptionsBuilder {
|
|
|
54
54
|
build(): WixDataGetOptions;
|
|
55
55
|
}
|
|
56
56
|
/**
|
|
57
|
-
* Creates a new
|
|
57
|
+
* Creates a new get options builder.
|
|
58
58
|
* @public
|
|
59
59
|
* @documentationMaturity preview
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
|
-
* ```ts
|
|
62
|
+
* ```ts title="Create a get options builder"
|
|
63
63
|
* import { items, GetOptionsBuilder } from '@wix/data'
|
|
64
64
|
*
|
|
65
65
|
* const options = GetOptionsBuilder()
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WixDataInsertOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Options builder for insert operations.
|
|
4
4
|
*
|
|
5
5
|
* Use this builder to configure insert behavior such as hooks suppression,
|
|
6
6
|
* and reference handling.
|
|
@@ -10,23 +10,23 @@ import type { WixDataInsertOptions } from './types';
|
|
|
10
10
|
*/
|
|
11
11
|
export interface WixDataInsertOptionsBuilder {
|
|
12
12
|
/**
|
|
13
|
-
* Sets whether insert hooks
|
|
13
|
+
* Sets whether to suppress insert hooks.
|
|
14
14
|
*
|
|
15
15
|
* When `true`, the insert runs without triggering hooks.
|
|
16
16
|
*/
|
|
17
17
|
withSuppressHooks(value: boolean): WixDataInsertOptionsBuilder;
|
|
18
18
|
/**
|
|
19
|
-
* Sets whether draft items
|
|
19
|
+
* Sets whether to include draft items when inserting an item.
|
|
20
20
|
* @internal
|
|
21
21
|
*/
|
|
22
22
|
withShowDrafts(value: boolean): WixDataInsertOptionsBuilder;
|
|
23
23
|
/**
|
|
24
|
-
* Sets whether
|
|
24
|
+
* Sets whether to include references when inserting an item.
|
|
25
25
|
* @internal
|
|
26
26
|
*/
|
|
27
27
|
withIncludeReferences(value: boolean): WixDataInsertOptionsBuilder;
|
|
28
28
|
/**
|
|
29
|
-
* Sets whether referenced items
|
|
29
|
+
* Sets whether to save referenced items when inserting an item.
|
|
30
30
|
*/
|
|
31
31
|
withSaveReferences(value: boolean): WixDataInsertOptionsBuilder;
|
|
32
32
|
/**
|
|
@@ -35,12 +35,12 @@ export interface WixDataInsertOptionsBuilder {
|
|
|
35
35
|
build(): WixDataInsertOptions;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* Creates a new
|
|
38
|
+
* Creates a new insert options builder.
|
|
39
39
|
* @public
|
|
40
40
|
* @documentationMaturity preview
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
|
-
* ```ts
|
|
43
|
+
* ```ts title="Create an insert options builder"
|
|
44
44
|
* import { items, InsertOptionsBuilder } from '@wix/data'
|
|
45
45
|
*
|
|
46
46
|
* const options = InsertOptionsBuilder()
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WixDataIsReferencedOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Options builder for isReferenced operations.
|
|
4
4
|
*
|
|
5
5
|
* Use this builder to configure whether the reference check uses a consistent read.
|
|
6
6
|
* @public
|
|
@@ -18,12 +18,12 @@ export interface WixDataIsReferencedOptionsBuilder {
|
|
|
18
18
|
build(): WixDataIsReferencedOptions;
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
|
-
* Creates a new
|
|
21
|
+
* Creates a new isReferenced options builder.
|
|
22
22
|
* @public
|
|
23
23
|
* @documentationMaturity preview
|
|
24
24
|
*
|
|
25
25
|
* @example
|
|
26
|
-
* ```ts
|
|
26
|
+
* ```ts title="Create an isReferenced options builder"
|
|
27
27
|
* import { items, IsReferencedOptionsBuilder } from '@wix/data'
|
|
28
28
|
*
|
|
29
29
|
* const options = IsReferencedOptionsBuilder()
|
|
@@ -2,7 +2,7 @@ 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
|
-
*
|
|
5
|
+
* Options builder for patch operations.
|
|
6
6
|
*
|
|
7
7
|
* Use this builder to configure patch behavior such as hooks suppression,
|
|
8
8
|
* and conditional patching.
|
|
@@ -12,18 +12,18 @@ import type { WixDataPatchOptions } from './WixDataPatch';
|
|
|
12
12
|
*/
|
|
13
13
|
export interface WixDataPatchOptionsBuilder {
|
|
14
14
|
/**
|
|
15
|
-
* Sets whether patch hooks
|
|
15
|
+
* Sets whether to suppress patch hooks.
|
|
16
16
|
*
|
|
17
17
|
* When `true`, the patch runs without triggering hooks.
|
|
18
18
|
*/
|
|
19
19
|
withSuppressHooks(value: boolean): WixDataPatchOptionsBuilder;
|
|
20
20
|
/**
|
|
21
|
-
* Sets whether draft items
|
|
21
|
+
* Sets whether to include draft items when patching an item.
|
|
22
22
|
* @internal
|
|
23
23
|
*/
|
|
24
24
|
withShowDrafts(value: boolean): WixDataPatchOptionsBuilder;
|
|
25
25
|
/**
|
|
26
|
-
* Sets the condition that determines whether the item
|
|
26
|
+
* Sets the condition that determines whether to patch the item.
|
|
27
27
|
*/
|
|
28
28
|
withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataPatchOptionsBuilder;
|
|
29
29
|
/**
|
|
@@ -32,12 +32,12 @@ export interface WixDataPatchOptionsBuilder {
|
|
|
32
32
|
build(): WixDataPatchOptions;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
|
-
* Creates a new
|
|
35
|
+
* Creates a new patch options builder.
|
|
36
36
|
* @public
|
|
37
37
|
* @documentationMaturity preview
|
|
38
38
|
*
|
|
39
39
|
* @example
|
|
40
|
-
* ```ts
|
|
40
|
+
* ```ts title="Create a patch options builder"
|
|
41
41
|
* import { items, PatchOptionsBuilder, Filter } from '@wix/data'
|
|
42
42
|
*
|
|
43
43
|
* const options = PatchOptionsBuilder()
|
|
@@ -6,12 +6,12 @@ import { WixDataQueryRequest, WixDataQuerySpec, WixDataItem } from './types';
|
|
|
6
6
|
*/
|
|
7
7
|
export type WixDataQueryBuilder = SDKQueryBuilder<WixDataItem, WixDataQuerySpec, WixDataQueryRequest>;
|
|
8
8
|
/**
|
|
9
|
-
* Creates a new
|
|
9
|
+
* Creates a new query builder.
|
|
10
10
|
* @public
|
|
11
11
|
* @documentationMaturity preview
|
|
12
12
|
*
|
|
13
13
|
* @example
|
|
14
|
-
* ```ts
|
|
14
|
+
* ```ts title="Build a query"
|
|
15
15
|
* import { items, QueryBuilder, Filter, Sort } from '@wix/data'
|
|
16
16
|
*
|
|
17
17
|
* const request = QueryBuilder()
|
|
@@ -35,7 +35,7 @@ export declare const QueryBuilder: () => WixDataQueryBuilder;
|
|
|
35
35
|
* @documentationMaturity preview
|
|
36
36
|
*
|
|
37
37
|
* @example
|
|
38
|
-
* ```ts
|
|
38
|
+
* ```ts title="Create filter expressions"
|
|
39
39
|
* import { Filter } from '@wix/data'
|
|
40
40
|
*
|
|
41
41
|
* // Simple field filter
|
|
@@ -64,7 +64,7 @@ export declare const Filter: FilterFactory<WixDataItem, WixDataQuerySpec>;
|
|
|
64
64
|
* @documentationMaturity preview
|
|
65
65
|
*
|
|
66
66
|
* @example
|
|
67
|
-
* ```ts
|
|
67
|
+
* ```ts title="Create sort expressions"
|
|
68
68
|
* import { Sort, QueryBuilder } from '@wix/data'
|
|
69
69
|
*
|
|
70
70
|
* // Descending sort
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WixDataQueryOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Options builder for query operations.
|
|
4
4
|
*
|
|
5
5
|
* Use this builder to configure query behavior such as hooks suppression,
|
|
6
6
|
* language, reference inclusion, and field groups.
|
|
@@ -10,13 +10,13 @@ import type { WixDataQueryOptions } from './types';
|
|
|
10
10
|
*/
|
|
11
11
|
export interface WixDataQueryOptionsBuilder {
|
|
12
12
|
/**
|
|
13
|
-
* Sets whether query hooks
|
|
13
|
+
* Sets whether to suppress query hooks.
|
|
14
14
|
*
|
|
15
15
|
* When `true`, the query runs without triggering hooks.
|
|
16
16
|
*/
|
|
17
17
|
withSuppressHooks(value: boolean): WixDataQueryOptionsBuilder;
|
|
18
18
|
/**
|
|
19
|
-
* Sets whether draft items
|
|
19
|
+
* Sets whether to include draft items in query results.
|
|
20
20
|
* @internal
|
|
21
21
|
*/
|
|
22
22
|
withShowDrafts(value: boolean): WixDataQueryOptionsBuilder;
|
|
@@ -35,14 +35,14 @@ export interface WixDataQueryOptionsBuilder {
|
|
|
35
35
|
/**
|
|
36
36
|
* Includes referenced items for the specified reference fields.
|
|
37
37
|
*
|
|
38
|
-
* Use `limit` to cap how many referenced items
|
|
38
|
+
* Use `limit` to cap how many referenced items each field returns.
|
|
39
39
|
*/
|
|
40
40
|
withIncludeReferences(value: {
|
|
41
41
|
field: string;
|
|
42
42
|
limit?: number;
|
|
43
43
|
}[]): WixDataQueryOptionsBuilder;
|
|
44
44
|
/**
|
|
45
|
-
* Sets whether the total result count
|
|
45
|
+
* Sets whether to return the total result count with the query response.
|
|
46
46
|
*/
|
|
47
47
|
withReturnTotalCount(value: boolean): WixDataQueryOptionsBuilder;
|
|
48
48
|
/**
|
|
@@ -55,12 +55,12 @@ export interface WixDataQueryOptionsBuilder {
|
|
|
55
55
|
build(): WixDataQueryOptions;
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* Creates a new
|
|
58
|
+
* Creates a new query options builder.
|
|
59
59
|
* @public
|
|
60
60
|
* @documentationMaturity preview
|
|
61
61
|
*
|
|
62
62
|
* @example
|
|
63
|
-
* ```ts
|
|
63
|
+
* ```ts title="Create a query options builder"
|
|
64
64
|
* import { items, QueryOptionsBuilder } from '@wix/data'
|
|
65
65
|
*
|
|
66
66
|
* const options = QueryOptionsBuilder()
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { SortOrder } from '../types/data-item-types';
|
|
2
2
|
import type { WixDataQueryReferencedItemsOptions } from './types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Options builder for query referenced items operations.
|
|
5
5
|
*
|
|
6
6
|
* Use this builder to configure referenced item query behavior such as language,
|
|
7
7
|
* selected fields, sort order and paging.
|
|
@@ -11,7 +11,7 @@ import type { WixDataQueryReferencedItemsOptions } from './types';
|
|
|
11
11
|
*/
|
|
12
12
|
export interface WixDataQueryReferencedItemsOptionsBuilder {
|
|
13
13
|
/**
|
|
14
|
-
* Sets whether draft items
|
|
14
|
+
* Sets whether to include draft items in query results.
|
|
15
15
|
* @internal
|
|
16
16
|
*/
|
|
17
17
|
withShowDrafts(value: boolean): WixDataQueryReferencedItemsOptionsBuilder;
|
|
@@ -28,7 +28,7 @@ export interface WixDataQueryReferencedItemsOptionsBuilder {
|
|
|
28
28
|
*/
|
|
29
29
|
withConsistentRead(value: boolean): WixDataQueryReferencedItemsOptionsBuilder;
|
|
30
30
|
/**
|
|
31
|
-
* Sets whether the total result count
|
|
31
|
+
* Sets whether to return the total result count with the query response.
|
|
32
32
|
*/
|
|
33
33
|
withReturnTotalCount(value: boolean): WixDataQueryReferencedItemsOptionsBuilder;
|
|
34
34
|
/**
|
|
@@ -59,12 +59,12 @@ export interface WixDataQueryReferencedItemsOptionsBuilder {
|
|
|
59
59
|
build(): WixDataQueryReferencedItemsOptions;
|
|
60
60
|
}
|
|
61
61
|
/**
|
|
62
|
-
* Creates a new
|
|
62
|
+
* Creates a new query referenced items options builder.
|
|
63
63
|
* @public
|
|
64
64
|
* @documentationMaturity preview
|
|
65
65
|
*
|
|
66
66
|
* @example
|
|
67
|
-
* ```ts
|
|
67
|
+
* ```ts title="Create a query referenced items options builder"
|
|
68
68
|
* import { items, QueryReferencedItemsOptionsBuilder } from '@wix/data'
|
|
69
69
|
*
|
|
70
70
|
* const options = QueryReferencedItemsOptionsBuilder()
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { FilterExpression } from '@wix/sdk-types';
|
|
2
2
|
import type { WixDataItem, WixDataQuerySpec, WixDataRemoveOptions } from './types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Options builder for remove operations.
|
|
5
5
|
*
|
|
6
6
|
* Use this builder to configure remove behavior such as hooks suppression,
|
|
7
7
|
* and conditional removal.
|
|
@@ -11,18 +11,18 @@ import type { WixDataItem, WixDataQuerySpec, WixDataRemoveOptions } from './type
|
|
|
11
11
|
*/
|
|
12
12
|
export interface WixDataRemoveOptionsBuilder {
|
|
13
13
|
/**
|
|
14
|
-
* Sets whether remove hooks
|
|
14
|
+
* Sets whether to suppress remove hooks.
|
|
15
15
|
*
|
|
16
16
|
* When `true`, the remove operation runs without triggering hooks.
|
|
17
17
|
*/
|
|
18
18
|
withSuppressHooks(value: boolean): WixDataRemoveOptionsBuilder;
|
|
19
19
|
/**
|
|
20
|
-
* Sets whether draft items
|
|
20
|
+
* Sets whether to include draft items when removing items.
|
|
21
21
|
* @internal
|
|
22
22
|
*/
|
|
23
23
|
withShowDrafts(value: boolean): WixDataRemoveOptionsBuilder;
|
|
24
24
|
/**
|
|
25
|
-
* Removes the item only when the specified condition
|
|
25
|
+
* Removes the item only when it matches the specified condition.
|
|
26
26
|
*/
|
|
27
27
|
withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataRemoveOptionsBuilder;
|
|
28
28
|
/**
|
|
@@ -31,12 +31,12 @@ export interface WixDataRemoveOptionsBuilder {
|
|
|
31
31
|
build(): WixDataRemoveOptions;
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
|
-
* Creates a new
|
|
34
|
+
* Creates a new remove options builder.
|
|
35
35
|
* @public
|
|
36
36
|
* @documentationMaturity preview
|
|
37
37
|
*
|
|
38
38
|
* @example
|
|
39
|
-
* ```ts
|
|
39
|
+
* ```ts title="Create a remove options builder"
|
|
40
40
|
* import { items, Filter, RemoveOptionsBuilder } from '@wix/data'
|
|
41
41
|
*
|
|
42
42
|
* const options = RemoveOptionsBuilder()
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WixDataSaveOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Options builder for save operations.
|
|
4
4
|
*
|
|
5
5
|
* Use this builder to configure save behavior such as hooks suppression,
|
|
6
6
|
* and saving reference values.
|
|
@@ -10,23 +10,23 @@ import type { WixDataSaveOptions } from './types';
|
|
|
10
10
|
*/
|
|
11
11
|
export interface WixDataSaveOptionsBuilder {
|
|
12
12
|
/**
|
|
13
|
-
* Sets whether save hooks
|
|
13
|
+
* Sets whether to suppress save hooks.
|
|
14
14
|
*
|
|
15
15
|
* When `true`, the save operation runs without triggering hooks.
|
|
16
16
|
*/
|
|
17
17
|
withSuppressHooks(value: boolean): WixDataSaveOptionsBuilder;
|
|
18
18
|
/**
|
|
19
|
-
* Sets whether draft items
|
|
19
|
+
* Sets whether to include draft items when saving items.
|
|
20
20
|
* @internal
|
|
21
21
|
*/
|
|
22
22
|
withShowDrafts(value: boolean): WixDataSaveOptionsBuilder;
|
|
23
23
|
/**
|
|
24
|
-
* Sets whether referenced items
|
|
24
|
+
* Sets whether to include referenced items in the save response.
|
|
25
25
|
* @internal
|
|
26
26
|
*/
|
|
27
27
|
withIncludeReferences(value: boolean): WixDataSaveOptionsBuilder;
|
|
28
28
|
/**
|
|
29
|
-
* Sets whether reference values
|
|
29
|
+
* Sets whether to save reference values from the data item.
|
|
30
30
|
*/
|
|
31
31
|
withSaveReferences(value: boolean): WixDataSaveOptionsBuilder;
|
|
32
32
|
/**
|
|
@@ -35,12 +35,12 @@ export interface WixDataSaveOptionsBuilder {
|
|
|
35
35
|
build(): WixDataSaveOptions;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* Creates a new
|
|
38
|
+
* Creates a new save options builder.
|
|
39
39
|
* @public
|
|
40
40
|
* @documentationMaturity preview
|
|
41
41
|
*
|
|
42
42
|
* @example
|
|
43
|
-
* ```ts
|
|
43
|
+
* ```ts title="Create a save options builder"
|
|
44
44
|
* import { items, SaveOptionsBuilder } from '@wix/data'
|
|
45
45
|
*
|
|
46
46
|
* const options = SaveOptionsBuilder()
|
|
@@ -15,16 +15,16 @@ interface WixDataSearchSpec extends SearchSpec {
|
|
|
15
15
|
}
|
|
16
16
|
type WixDataSearchRequest = SearchRequest<WixDataItem, WixDataSearchSpec>;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
18
|
+
* Search builder.
|
|
19
19
|
* @public
|
|
20
20
|
*/
|
|
21
21
|
export type WixDataSearchBuilder = Omit<SDKSearchBuilder<WixDataItem, WixDataSearchSpec, WixDataSearchRequest>, 'withAggregation' | 'withTimeZone'>;
|
|
22
22
|
/**
|
|
23
|
-
* Creates a new
|
|
23
|
+
* Creates a new search builder.
|
|
24
24
|
* @public
|
|
25
25
|
*
|
|
26
26
|
* @example
|
|
27
|
-
* ```ts
|
|
27
|
+
* ```ts title="Build a search"
|
|
28
28
|
* import { items, SearchBuilder, SearchParams, Filter } from '@wix/data'
|
|
29
29
|
*
|
|
30
30
|
* const request = SearchBuilder()
|
|
@@ -42,7 +42,7 @@ export declare const SearchBuilder: () => WixDataSearchBuilder;
|
|
|
42
42
|
* @public
|
|
43
43
|
*
|
|
44
44
|
* @example
|
|
45
|
-
* ```ts
|
|
45
|
+
* ```ts title="Create search parameters"
|
|
46
46
|
* import { SearchParams } from '@wix/data'
|
|
47
47
|
* // Simple expression
|
|
48
48
|
* SearchParams.expression('search text')
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { WixDataSearchOptions } from './types';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Options builder for search operations.
|
|
4
4
|
*
|
|
5
5
|
* Use this builder to configure search behavior such as translation language
|
|
6
6
|
* and reference inclusion.
|
|
@@ -16,7 +16,7 @@ export interface WixDataSearchOptionsBuilder {
|
|
|
16
16
|
/**
|
|
17
17
|
* Includes referenced items for the specified reference fields.
|
|
18
18
|
*
|
|
19
|
-
* Use `limit` to cap how many referenced items
|
|
19
|
+
* Use `limit` to cap how many referenced items each field returns.
|
|
20
20
|
*/
|
|
21
21
|
withIncludeReferences(value: {
|
|
22
22
|
field: string;
|
|
@@ -28,12 +28,12 @@ export interface WixDataSearchOptionsBuilder {
|
|
|
28
28
|
build(): WixDataSearchOptions;
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
* Creates a new
|
|
31
|
+
* Creates a new search options builder.
|
|
32
32
|
* @public
|
|
33
33
|
* @documentationMaturity preview
|
|
34
34
|
*
|
|
35
35
|
* @example
|
|
36
|
-
* ```ts
|
|
36
|
+
* ```ts title="Create a search options builder"
|
|
37
37
|
* import { items, SearchBuilder, SearchOptionsBuilder, SearchParams } from '@wix/data'
|
|
38
38
|
*
|
|
39
39
|
* const searchRequest = SearchBuilder()
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { FilterExpression } from '@wix/sdk-types';
|
|
2
2
|
import type { WixDataItem, WixDataQuerySpec, WixDataUpdateOptions } from './types';
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Options builder for update operations.
|
|
5
5
|
*
|
|
6
6
|
* Use this builder to configure update behavior such as hooks suppression,
|
|
7
7
|
* reference handling, and conditional updates.
|
|
@@ -11,27 +11,27 @@ import type { WixDataItem, WixDataQuerySpec, WixDataUpdateOptions } from './type
|
|
|
11
11
|
*/
|
|
12
12
|
export interface WixDataUpdateOptionsBuilder {
|
|
13
13
|
/**
|
|
14
|
-
* Sets whether update hooks
|
|
14
|
+
* Sets whether to suppress update hooks.
|
|
15
15
|
*
|
|
16
16
|
* When `true`, the update operation runs without triggering hooks.
|
|
17
17
|
*/
|
|
18
18
|
withSuppressHooks(value: boolean): WixDataUpdateOptionsBuilder;
|
|
19
19
|
/**
|
|
20
|
-
* Sets whether draft items
|
|
20
|
+
* Sets whether to include draft items when updating items.
|
|
21
21
|
* @internal
|
|
22
22
|
*/
|
|
23
23
|
withShowDrafts(value: boolean): WixDataUpdateOptionsBuilder;
|
|
24
24
|
/**
|
|
25
|
-
* Sets whether referenced items
|
|
25
|
+
* Sets whether to include referenced items in the update response.
|
|
26
26
|
* @internal
|
|
27
27
|
*/
|
|
28
28
|
withIncludeReferences(value: boolean): WixDataUpdateOptionsBuilder;
|
|
29
29
|
/**
|
|
30
|
-
* Sets whether reference values
|
|
30
|
+
* Sets whether to save reference values from the data item.
|
|
31
31
|
*/
|
|
32
32
|
withSaveReferences(value: boolean): WixDataUpdateOptionsBuilder;
|
|
33
33
|
/**
|
|
34
|
-
* Updates the item only when the specified condition
|
|
34
|
+
* Updates the item only when it matches the specified condition.
|
|
35
35
|
*/
|
|
36
36
|
withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataUpdateOptionsBuilder;
|
|
37
37
|
/**
|
|
@@ -40,12 +40,12 @@ export interface WixDataUpdateOptionsBuilder {
|
|
|
40
40
|
build(): WixDataUpdateOptions;
|
|
41
41
|
}
|
|
42
42
|
/**
|
|
43
|
-
* Creates a new
|
|
43
|
+
* Creates a new update options builder.
|
|
44
44
|
* @public
|
|
45
45
|
* @documentationMaturity preview
|
|
46
46
|
*
|
|
47
47
|
* @example
|
|
48
|
-
* ```ts
|
|
48
|
+
* ```ts title="Create an update options builder"
|
|
49
49
|
* import { items, Filter, UpdateOptionsBuilder } from '@wix/data'
|
|
50
50
|
*
|
|
51
51
|
* const options = UpdateOptionsBuilder()
|