@wix/wix-data-items-common 1.0.101 → 1.0.103
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.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":[],"sources":["../../../src/api/WixDataPatch.ts"],"sourcesContent":["import { WixDataItem, WixDataBulkResult, WixDataPatchOptions } from './types'\n\nexport interface FieldModification {\n fieldPath: string\n action:\n | 'SET_FIELD'\n | 'REMOVE_FIELD'\n | 'INCREMENT_FIELD'\n | 'APPEND_TO_ARRAY'\n | 'REMOVE_FROM_ARRAY'\n actionOptions?: any\n}\n\n/**\n * @builder\n */\nexport interface WixDataBulkPatch {\n /**\n * Refines a patch operation to increment the specified field by the specified value.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is
|
|
1
|
+
{"version":3,"names":[],"sources":["../../../src/api/WixDataPatch.ts"],"sourcesContent":["import { WixDataItem, WixDataBulkResult, WixDataPatchOptions } from './types'\n\nexport interface FieldModification {\n fieldPath: string\n action:\n | 'SET_FIELD'\n | 'REMOVE_FIELD'\n | 'INCREMENT_FIELD'\n | 'APPEND_TO_ARRAY'\n | 'REMOVE_FROM_ARRAY'\n actionOptions?: any\n}\n\n/**\n * @builder\n */\nexport interface WixDataBulkPatch {\n /**\n * Refines a patch operation to increment or decrement the specified field by the specified value. A positive value increases the field, while a negative value decreases it.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is incremented or decremented.\n * @requiredField field\n * @param by - Value by which to increment or decrement the specified field. You can specify positive or negative values.\n * @requiredField by\n * @returns Updated patch object.\n */\n incrementField(field: string, by: number): WixDataBulkPatch\n\n /**\n * Refines a patch operation to set the specified field to the specified value.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is set.\n * @requiredField field\n * @param value - Value to set for the specified field.\n * @requiredField value\n * @returns Updated patch object.\n */\n setField(field: string, value: any): WixDataBulkPatch\n\n /**\n * Refines a patch operation to append the specified value to the specified array field.\n * @public\n * @documentationMaturity preview\n * @param field - Array field to append the specified value to.\n * @requiredField field\n * @param value - Value to append to the specified array field.\n * @requiredField value\n * @returns Updated patch object.\n */\n appendToArray(field: string, value: any): WixDataBulkPatch\n\n /**\n * Refines a patch operation to remove the first instance of the specified value from the specified array field.\n * @public\n * @documentationMaturity preview\n * @param field - Array field to remove the specified value from.\n * @requiredField field\n * @param value - Value whose first instance is removed from the specified array field.\n * @requiredField value\n * @returns Updated patch object.\n */\n removeFromArray(field: string, value: any): WixDataBulkPatch\n\n /**\n * Refines a patch operation to clear the specified field.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is cleared.\n * @requiredField field\n * @returns Updated patch object.\n */\n removeField(field: string): WixDataBulkPatch\n\n /**\n * Runs the bulk patch operation and returns a Promise that resolves to information about the results.\n *\n * @public\n * @documentationMaturity preview\n * @returns Bulk operation results.\n */\n run(options?: WixDataPatchOptions): Promise<WixDataBulkResult>\n}\n\n/**\n * @builder\n */\nexport interface WixDataPatch {\n /**\n * Refines a patch operation to increment or decrement the specified field by the specified value. A positive value increases the field, while a negative value decreases it.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is incremented or decremented.\n * @requiredField field\n * @param by - Value by which to increase or decrease the specified field. You can specify positive or negative values.\n * @requiredField by\n * @returns Updated patch object.\n */\n incrementField(field: string, by: number): WixDataPatch\n\n /**\n * Refines a patch operation to set the specified field to the specified value.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is set.\n * @requiredField field\n * @param value - Value to set for the specified field.\n * @requiredField value\n * @returns Updated patch object.\n */\n setField(field: string, value: any): WixDataPatch\n\n /**\n * Refines a patch operation to append the specified value to the specified array field.\n * @public\n * @documentationMaturity preview\n * @param field - Array field to append the specified value to.\n * @requiredField field\n * @param value - Value to append to the specified array field.\n * @requiredField value\n * @returns Updated patch object.\n */\n appendToArray(field: string, value: any): WixDataPatch\n\n /**\n * Refines a patch operation to remove the first instance of the specified value from the specified array field.\n * @public\n * @documentationMaturity preview\n * @param field - Array field to remove the specified value from.\n * @requiredField field\n * @param value - Value whose first instance is removed from the specified array field.\n * @requiredField value\n * @returns Updated patch object.\n */\n removeFromArray(field: string, value: any): WixDataPatch\n\n /**\n * Refines a patch operation to clear the specified field.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is cleared.\n * @requiredField field\n * @returns Updated patch object.\n */\n removeField(field: string): WixDataPatch\n\n /**\n * Runs the patch operation and returns a Promise that resolves to the patched item and operation metadata.\n *\n * @public\n * @documentationMaturity preview\n * @returns Modified data item.\n */\n\n run(options?: WixDataPatchOptions): Promise<WixDataItem | null>\n}\n"],"mappings":""}
|
|
@@ -9,60 +9,60 @@ export interface FieldModification {
|
|
|
9
9
|
*/
|
|
10
10
|
export interface WixDataBulkPatch {
|
|
11
11
|
/**
|
|
12
|
-
* Refines a patch operation to increment the specified field by the specified value.
|
|
12
|
+
* Refines a patch operation to increment or decrement the specified field by the specified value. A positive value increases the field, while a negative value decreases it.
|
|
13
13
|
* @public
|
|
14
14
|
* @documentationMaturity preview
|
|
15
|
-
* @param field - Field whose value is
|
|
16
|
-
* @requiredField
|
|
17
|
-
* @param by - Value by which to increment the specified field. You can specify positive or negative values.
|
|
15
|
+
* @param field - Field whose value is incremented or decremented.
|
|
16
|
+
* @requiredField field
|
|
17
|
+
* @param by - Value by which to increment or decrement the specified field. You can specify positive or negative values.
|
|
18
18
|
* @requiredField by
|
|
19
|
-
* @returns Updated patch.
|
|
19
|
+
* @returns Updated patch object.
|
|
20
20
|
*/
|
|
21
|
-
incrementField(
|
|
21
|
+
incrementField(field: string, by: number): WixDataBulkPatch;
|
|
22
22
|
/**
|
|
23
23
|
* Refines a patch operation to set the specified field to the specified value.
|
|
24
24
|
* @public
|
|
25
25
|
* @documentationMaturity preview
|
|
26
26
|
* @param field - Field whose value is set.
|
|
27
|
-
* @requiredField
|
|
27
|
+
* @requiredField field
|
|
28
28
|
* @param value - Value to set for the specified field.
|
|
29
29
|
* @requiredField value
|
|
30
|
-
* @returns Updated patch.
|
|
30
|
+
* @returns Updated patch object.
|
|
31
31
|
*/
|
|
32
|
-
setField(
|
|
32
|
+
setField(field: string, value: any): WixDataBulkPatch;
|
|
33
33
|
/**
|
|
34
34
|
* Refines a patch operation to append the specified value to the specified array field.
|
|
35
35
|
* @public
|
|
36
36
|
* @documentationMaturity preview
|
|
37
37
|
* @param field - Array field to append the specified value to.
|
|
38
|
-
* @requiredField
|
|
38
|
+
* @requiredField field
|
|
39
39
|
* @param value - Value to append to the specified array field.
|
|
40
40
|
* @requiredField value
|
|
41
|
-
* @returns Updated patch.
|
|
41
|
+
* @returns Updated patch object.
|
|
42
42
|
*/
|
|
43
|
-
appendToArray(
|
|
43
|
+
appendToArray(field: string, value: any): WixDataBulkPatch;
|
|
44
44
|
/**
|
|
45
|
-
* Refines a patch operation to remove the specified value from the specified array field.
|
|
45
|
+
* Refines a patch operation to remove the first instance of the specified value from the specified array field.
|
|
46
46
|
* @public
|
|
47
47
|
* @documentationMaturity preview
|
|
48
48
|
* @param field - Array field to remove the specified value from.
|
|
49
|
-
* @requiredField
|
|
50
|
-
* @param value - Value
|
|
49
|
+
* @requiredField field
|
|
50
|
+
* @param value - Value whose first instance is removed from the specified array field.
|
|
51
51
|
* @requiredField value
|
|
52
|
-
* @returns Updated patch.
|
|
52
|
+
* @returns Updated patch object.
|
|
53
53
|
*/
|
|
54
|
-
removeFromArray(
|
|
54
|
+
removeFromArray(field: string, value: any): WixDataBulkPatch;
|
|
55
55
|
/**
|
|
56
56
|
* Refines a patch operation to clear the specified field.
|
|
57
57
|
* @public
|
|
58
58
|
* @documentationMaturity preview
|
|
59
59
|
* @param field - Field whose value is cleared.
|
|
60
|
-
* @requiredField
|
|
61
|
-
* @returns Updated patch.
|
|
60
|
+
* @requiredField field
|
|
61
|
+
* @returns Updated patch object.
|
|
62
62
|
*/
|
|
63
|
-
removeField(
|
|
63
|
+
removeField(field: string): WixDataBulkPatch;
|
|
64
64
|
/**
|
|
65
|
-
* Runs the bulk patch operation and returns a Promise that resolves to information about the
|
|
65
|
+
* Runs the bulk patch operation and returns a Promise that resolves to information about the results.
|
|
66
66
|
*
|
|
67
67
|
* @public
|
|
68
68
|
* @documentationMaturity preview
|
|
@@ -75,62 +75,60 @@ export interface WixDataBulkPatch {
|
|
|
75
75
|
*/
|
|
76
76
|
export interface WixDataPatch {
|
|
77
77
|
/**
|
|
78
|
-
* Refines a patch operation to increment the specified field by the specified value.
|
|
78
|
+
* Refines a patch operation to increment or decrement the specified field by the specified value. A positive value increases the field, while a negative value decreases it.
|
|
79
79
|
* @public
|
|
80
80
|
* @documentationMaturity preview
|
|
81
|
-
* @param field - Field whose value is
|
|
82
|
-
* @requiredField
|
|
83
|
-
* @param by - Value by which to
|
|
81
|
+
* @param field - Field whose value is incremented or decremented.
|
|
82
|
+
* @requiredField field
|
|
83
|
+
* @param by - Value by which to increase or decrease the specified field. You can specify positive or negative values.
|
|
84
84
|
* @requiredField by
|
|
85
|
-
* @returns Updated patch.
|
|
85
|
+
* @returns Updated patch object.
|
|
86
86
|
*/
|
|
87
|
-
incrementField(
|
|
87
|
+
incrementField(field: string, by: number): WixDataPatch;
|
|
88
88
|
/**
|
|
89
89
|
* Refines a patch operation to set the specified field to the specified value.
|
|
90
90
|
* @public
|
|
91
91
|
* @documentationMaturity preview
|
|
92
92
|
* @param field - Field whose value is set.
|
|
93
|
-
* @requiredField
|
|
93
|
+
* @requiredField field
|
|
94
94
|
* @param value - Value to set for the specified field.
|
|
95
95
|
* @requiredField value
|
|
96
|
-
* @returns Updated patch.
|
|
96
|
+
* @returns Updated patch object.
|
|
97
97
|
*/
|
|
98
|
-
setField(
|
|
98
|
+
setField(field: string, value: any): WixDataPatch;
|
|
99
99
|
/**
|
|
100
100
|
* Refines a patch operation to append the specified value to the specified array field.
|
|
101
101
|
* @public
|
|
102
102
|
* @documentationMaturity preview
|
|
103
103
|
* @param field - Array field to append the specified value to.
|
|
104
|
-
* @requiredField
|
|
104
|
+
* @requiredField field
|
|
105
105
|
* @param value - Value to append to the specified array field.
|
|
106
106
|
* @requiredField value
|
|
107
|
-
* @returns Updated patch.
|
|
107
|
+
* @returns Updated patch object.
|
|
108
108
|
*/
|
|
109
|
-
appendToArray(
|
|
109
|
+
appendToArray(field: string, value: any): WixDataPatch;
|
|
110
110
|
/**
|
|
111
|
-
* Refines a patch operation to remove the specified value from the specified array field.
|
|
111
|
+
* Refines a patch operation to remove the first instance of the specified value from the specified array field.
|
|
112
112
|
* @public
|
|
113
113
|
* @documentationMaturity preview
|
|
114
114
|
* @param field - Array field to remove the specified value from.
|
|
115
|
-
* @requiredField
|
|
116
|
-
* @param value - Value
|
|
115
|
+
* @requiredField field
|
|
116
|
+
* @param value - Value whose first instance is removed from the specified array field.
|
|
117
117
|
* @requiredField value
|
|
118
|
-
* @returns Updated patch.
|
|
118
|
+
* @returns Updated patch object.
|
|
119
119
|
*/
|
|
120
|
-
removeFromArray(
|
|
120
|
+
removeFromArray(field: string, value: any): WixDataPatch;
|
|
121
121
|
/**
|
|
122
122
|
* Refines a patch operation to clear the specified field.
|
|
123
123
|
* @public
|
|
124
124
|
* @documentationMaturity preview
|
|
125
125
|
* @param field - Field whose value is cleared.
|
|
126
|
-
* @requiredField
|
|
127
|
-
* @returns Updated patch.
|
|
126
|
+
* @requiredField field
|
|
127
|
+
* @returns Updated patch object.
|
|
128
128
|
*/
|
|
129
|
-
removeField(
|
|
129
|
+
removeField(field: string): WixDataPatch;
|
|
130
130
|
/**
|
|
131
|
-
* Runs the patch operation and returns the patched item.
|
|
132
|
-
*
|
|
133
|
-
* The `run()` method returns a Promise that resolves to the patched item and item metadata.
|
|
131
|
+
* Runs the patch operation and returns a Promise that resolves to the patched item and operation metadata.
|
|
134
132
|
*
|
|
135
133
|
* @public
|
|
136
134
|
* @documentationMaturity preview
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataPatch.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAE7E,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EACF,WAAW,GACX,cAAc,GACd,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,CAAA;IACvB,aAAa,CAAC,EAAE,GAAG,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;OASG;IACH,cAAc,CAAC,
|
|
1
|
+
{"version":3,"file":"WixDataPatch.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataPatch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAE7E,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EACF,WAAW,GACX,cAAc,GACd,iBAAiB,GACjB,iBAAiB,GACjB,mBAAmB,CAAA;IACvB,aAAa,CAAC,EAAE,GAAG,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE3D;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAErD;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAE1D;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,gBAAgB,CAAA;IAE5D;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAA;IAE5C;;;;;;OAMG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;CAC/D;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;OASG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,YAAY,CAAA;IAEvD;;;;;;;;;OASG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAEjD;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAEtD;;;;;;;;;OASG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,YAAY,CAAA;IAExD;;;;;;;OAOG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,CAAA;IAExC;;;;;;OAMG;IAEH,GAAG,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;CAChE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/wix-data-items-common",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.103",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Rimvydas Gimbutas",
|
|
@@ -85,5 +85,5 @@
|
|
|
85
85
|
"wallaby": {
|
|
86
86
|
"autoDetect": true
|
|
87
87
|
},
|
|
88
|
-
"falconPackageHash": "
|
|
88
|
+
"falconPackageHash": "9566561343e7a01c29e8c13109945a33d632786773516e06ae24b183"
|
|
89
89
|
}
|