@wix/wix-data-items-common 1.0.312 → 1.0.314

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.
Files changed (152) hide show
  1. package/dist/cjs/api/PipelineBuilder.js +0 -12
  2. package/dist/cjs/api/PipelineBuilder.js.map +1 -1
  3. package/dist/cjs/api/WixDataAggregateOptionsBuilder.js +27 -3
  4. package/dist/cjs/api/WixDataAggregateOptionsBuilder.js.map +1 -1
  5. package/dist/cjs/api/WixDataApi.js +38 -38
  6. package/dist/cjs/api/WixDataApi.js.map +1 -1
  7. package/dist/cjs/api/WixDataAsyncPatchByFilterOptionsBuilder.js +24 -3
  8. package/dist/cjs/api/WixDataAsyncPatchByFilterOptionsBuilder.js.map +1 -1
  9. package/dist/cjs/api/WixDataAsyncRemoveByFilterOptionsBuilder.js +23 -3
  10. package/dist/cjs/api/WixDataAsyncRemoveByFilterOptionsBuilder.js.map +1 -1
  11. package/dist/cjs/api/WixDataBulkInsertOptionsBuilder.js +22 -3
  12. package/dist/cjs/api/WixDataBulkInsertOptionsBuilder.js.map +1 -1
  13. package/dist/cjs/api/WixDataBulkPatchOptionsBuilder.js +21 -3
  14. package/dist/cjs/api/WixDataBulkPatchOptionsBuilder.js.map +1 -1
  15. package/dist/cjs/api/WixDataBulkRemoveOptionsBuilder.js +21 -3
  16. package/dist/cjs/api/WixDataBulkRemoveOptionsBuilder.js.map +1 -1
  17. package/dist/cjs/api/WixDataBulkSaveOptionsBuilder.js +20 -3
  18. package/dist/cjs/api/WixDataBulkSaveOptionsBuilder.js.map +1 -1
  19. package/dist/cjs/api/WixDataBulkUpdateOptionsBuilder.js +24 -3
  20. package/dist/cjs/api/WixDataBulkUpdateOptionsBuilder.js.map +1 -1
  21. package/dist/cjs/api/WixDataCountOptionsBuilder.js +24 -3
  22. package/dist/cjs/api/WixDataCountOptionsBuilder.js.map +1 -1
  23. package/dist/cjs/api/WixDataDistinctOptionsBuilder.js +25 -23
  24. package/dist/cjs/api/WixDataDistinctOptionsBuilder.js.map +1 -1
  25. package/dist/cjs/api/WixDataFieldModificationsBuilder.js +2 -1
  26. package/dist/cjs/api/WixDataFieldModificationsBuilder.js.map +1 -1
  27. package/dist/cjs/api/WixDataGetOptionsBuilder.js +27 -3
  28. package/dist/cjs/api/WixDataGetOptionsBuilder.js.map +1 -1
  29. package/dist/cjs/api/WixDataInsertOptionsBuilder.js +20 -3
  30. package/dist/cjs/api/WixDataInsertOptionsBuilder.js.map +1 -1
  31. package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js +25 -3
  32. package/dist/cjs/api/WixDataIsReferencedOptionsBuilder.js.map +1 -1
  33. package/dist/cjs/api/WixDataPatchOptionsBuilder.js +21 -3
  34. package/dist/cjs/api/WixDataPatchOptionsBuilder.js.map +1 -1
  35. package/dist/cjs/api/WixDataQueryBuilder.js +12 -7
  36. package/dist/cjs/api/WixDataQueryBuilder.js.map +1 -1
  37. package/dist/cjs/api/WixDataQueryOptionsBuilder.js +30 -3
  38. package/dist/cjs/api/WixDataQueryOptionsBuilder.js.map +1 -1
  39. package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js +32 -3
  40. package/dist/cjs/api/WixDataQueryReferencedItemsOptionsBuilder.js.map +1 -1
  41. package/dist/cjs/api/WixDataRemoveOptionsBuilder.js +25 -3
  42. package/dist/cjs/api/WixDataRemoveOptionsBuilder.js.map +1 -1
  43. package/dist/cjs/api/WixDataSaveOptionsBuilder.js +24 -3
  44. package/dist/cjs/api/WixDataSaveOptionsBuilder.js.map +1 -1
  45. package/dist/cjs/api/WixDataSearchBuilder.js +8 -9
  46. package/dist/cjs/api/WixDataSearchBuilder.js.map +1 -1
  47. package/dist/cjs/api/WixDataSearchOptionsBuilder.js +28 -3
  48. package/dist/cjs/api/WixDataSearchOptionsBuilder.js.map +1 -1
  49. package/dist/cjs/api/WixDataUpdateOptionsBuilder.js +25 -3
  50. package/dist/cjs/api/WixDataUpdateOptionsBuilder.js.map +1 -1
  51. package/dist/cjs/api/types.js.map +1 -1
  52. package/dist/esm/api/PipelineBuilder.js +0 -11
  53. package/dist/esm/api/PipelineBuilder.js.map +1 -1
  54. package/dist/esm/api/WixDataAggregateOptionsBuilder.js +20 -1
  55. package/dist/esm/api/WixDataAggregateOptionsBuilder.js.map +1 -1
  56. package/dist/esm/api/WixDataApi.js +38 -38
  57. package/dist/esm/api/WixDataApi.js.map +1 -1
  58. package/dist/esm/api/WixDataAsyncPatchByFilterOptionsBuilder.js +18 -1
  59. package/dist/esm/api/WixDataAsyncPatchByFilterOptionsBuilder.js.map +1 -1
  60. package/dist/esm/api/WixDataAsyncRemoveByFilterOptionsBuilder.js +17 -1
  61. package/dist/esm/api/WixDataAsyncRemoveByFilterOptionsBuilder.js.map +1 -1
  62. package/dist/esm/api/WixDataBulkInsertOptionsBuilder.js +16 -1
  63. package/dist/esm/api/WixDataBulkInsertOptionsBuilder.js.map +1 -1
  64. package/dist/esm/api/WixDataBulkPatchOptionsBuilder.js +14 -1
  65. package/dist/esm/api/WixDataBulkPatchOptionsBuilder.js.map +1 -1
  66. package/dist/esm/api/WixDataBulkRemoveOptionsBuilder.js +14 -1
  67. package/dist/esm/api/WixDataBulkRemoveOptionsBuilder.js.map +1 -1
  68. package/dist/esm/api/WixDataBulkSaveOptionsBuilder.js +14 -1
  69. package/dist/esm/api/WixDataBulkSaveOptionsBuilder.js.map +1 -1
  70. package/dist/esm/api/WixDataBulkUpdateOptionsBuilder.js +17 -1
  71. package/dist/esm/api/WixDataBulkUpdateOptionsBuilder.js.map +1 -1
  72. package/dist/esm/api/WixDataCountOptionsBuilder.js +17 -1
  73. package/dist/esm/api/WixDataCountOptionsBuilder.js.map +1 -1
  74. package/dist/esm/api/WixDataDistinctOptionsBuilder.js +18 -19
  75. package/dist/esm/api/WixDataDistinctOptionsBuilder.js.map +1 -1
  76. package/dist/esm/api/WixDataFieldModificationsBuilder.js +2 -1
  77. package/dist/esm/api/WixDataFieldModificationsBuilder.js.map +1 -1
  78. package/dist/esm/api/WixDataGetOptionsBuilder.js +19 -1
  79. package/dist/esm/api/WixDataGetOptionsBuilder.js.map +1 -1
  80. package/dist/esm/api/WixDataInsertOptionsBuilder.js +13 -1
  81. package/dist/esm/api/WixDataInsertOptionsBuilder.js.map +1 -1
  82. package/dist/esm/api/WixDataIsReferencedOptionsBuilder.js +19 -1
  83. package/dist/esm/api/WixDataIsReferencedOptionsBuilder.js.map +1 -1
  84. package/dist/esm/api/WixDataPatchOptionsBuilder.js +14 -1
  85. package/dist/esm/api/WixDataPatchOptionsBuilder.js.map +1 -1
  86. package/dist/esm/api/WixDataQueryBuilder.js +12 -7
  87. package/dist/esm/api/WixDataQueryBuilder.js.map +1 -1
  88. package/dist/esm/api/WixDataQueryOptionsBuilder.js +23 -1
  89. package/dist/esm/api/WixDataQueryOptionsBuilder.js.map +1 -1
  90. package/dist/esm/api/WixDataQueryReferencedItemsOptionsBuilder.js +25 -1
  91. package/dist/esm/api/WixDataQueryReferencedItemsOptionsBuilder.js.map +1 -1
  92. package/dist/esm/api/WixDataRemoveOptionsBuilder.js +18 -1
  93. package/dist/esm/api/WixDataRemoveOptionsBuilder.js.map +1 -1
  94. package/dist/esm/api/WixDataSaveOptionsBuilder.js +17 -1
  95. package/dist/esm/api/WixDataSaveOptionsBuilder.js.map +1 -1
  96. package/dist/esm/api/WixDataSearchBuilder.js +6 -6
  97. package/dist/esm/api/WixDataSearchBuilder.js.map +1 -1
  98. package/dist/esm/api/WixDataSearchOptionsBuilder.js +21 -1
  99. package/dist/esm/api/WixDataSearchOptionsBuilder.js.map +1 -1
  100. package/dist/esm/api/WixDataUpdateOptionsBuilder.js +18 -1
  101. package/dist/esm/api/WixDataUpdateOptionsBuilder.js.map +1 -1
  102. package/dist/types/api/PipelineBuilder.d.ts +0 -11
  103. package/dist/types/api/PipelineBuilder.d.ts.map +1 -1
  104. package/dist/types/api/WixDataAggregateOptionsBuilder.d.ts +43 -3
  105. package/dist/types/api/WixDataAggregateOptionsBuilder.d.ts.map +1 -1
  106. package/dist/types/api/WixDataAsyncPatchByFilterOptionsBuilder.d.ts +36 -3
  107. package/dist/types/api/WixDataAsyncPatchByFilterOptionsBuilder.d.ts.map +1 -1
  108. package/dist/types/api/WixDataAsyncRemoveByFilterOptionsBuilder.d.ts +35 -3
  109. package/dist/types/api/WixDataAsyncRemoveByFilterOptionsBuilder.d.ts.map +1 -1
  110. package/dist/types/api/WixDataBulkInsertOptionsBuilder.d.ts +41 -3
  111. package/dist/types/api/WixDataBulkInsertOptionsBuilder.d.ts.map +1 -1
  112. package/dist/types/api/WixDataBulkPatchOptionsBuilder.d.ts +36 -3
  113. package/dist/types/api/WixDataBulkPatchOptionsBuilder.d.ts.map +1 -1
  114. package/dist/types/api/WixDataBulkRemoveOptionsBuilder.d.ts +36 -3
  115. package/dist/types/api/WixDataBulkRemoveOptionsBuilder.d.ts.map +1 -1
  116. package/dist/types/api/WixDataBulkSaveOptionsBuilder.d.ts +35 -3
  117. package/dist/types/api/WixDataBulkSaveOptionsBuilder.d.ts.map +1 -1
  118. package/dist/types/api/WixDataBulkUpdateOptionsBuilder.d.ts +42 -3
  119. package/dist/types/api/WixDataBulkUpdateOptionsBuilder.d.ts.map +1 -1
  120. package/dist/types/api/WixDataCountOptionsBuilder.d.ts +48 -3
  121. package/dist/types/api/WixDataCountOptionsBuilder.d.ts.map +1 -1
  122. package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts +62 -8
  123. package/dist/types/api/WixDataDistinctOptionsBuilder.d.ts.map +1 -1
  124. package/dist/types/api/WixDataFieldModificationsBuilder.d.ts +1 -1
  125. package/dist/types/api/WixDataFieldModificationsBuilder.d.ts.map +1 -1
  126. package/dist/types/api/WixDataGetOptionsBuilder.d.ts +57 -3
  127. package/dist/types/api/WixDataGetOptionsBuilder.d.ts.map +1 -1
  128. package/dist/types/api/WixDataInsertOptionsBuilder.d.ts +39 -3
  129. package/dist/types/api/WixDataInsertOptionsBuilder.d.ts.map +1 -1
  130. package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts +31 -3
  131. package/dist/types/api/WixDataIsReferencedOptionsBuilder.d.ts.map +1 -1
  132. package/dist/types/api/WixDataPatchOptionsBuilder.d.ts +36 -3
  133. package/dist/types/api/WixDataPatchOptionsBuilder.d.ts.map +1 -1
  134. package/dist/types/api/WixDataQueryBuilder.d.ts +12 -7
  135. package/dist/types/api/WixDataQueryBuilder.d.ts.map +1 -1
  136. package/dist/types/api/WixDataQueryOptionsBuilder.d.ts +62 -3
  137. package/dist/types/api/WixDataQueryOptionsBuilder.d.ts.map +1 -1
  138. package/dist/types/api/WixDataQueryReferencedItemsOptionsBuilder.d.ts +63 -3
  139. package/dist/types/api/WixDataQueryReferencedItemsOptionsBuilder.d.ts.map +1 -1
  140. package/dist/types/api/WixDataRemoveOptionsBuilder.d.ts +40 -3
  141. package/dist/types/api/WixDataRemoveOptionsBuilder.d.ts.map +1 -1
  142. package/dist/types/api/WixDataSaveOptionsBuilder.d.ts +43 -3
  143. package/dist/types/api/WixDataSaveOptionsBuilder.d.ts.map +1 -1
  144. package/dist/types/api/WixDataSearchBuilder.d.ts +8 -9
  145. package/dist/types/api/WixDataSearchBuilder.d.ts.map +1 -1
  146. package/dist/types/api/WixDataSearchOptionsBuilder.d.ts +39 -3
  147. package/dist/types/api/WixDataSearchOptionsBuilder.d.ts.map +1 -1
  148. package/dist/types/api/WixDataUpdateOptionsBuilder.d.ts +47 -3
  149. package/dist/types/api/WixDataUpdateOptionsBuilder.d.ts.map +1 -1
  150. package/dist/types/api/types.d.ts +0 -16
  151. package/dist/types/api/types.d.ts.map +1 -1
  152. package/package.json +3 -3
@@ -29,7 +29,24 @@ class WixDataUpdateOptionsBuilderImpl {
29
29
  }
30
30
  /**
31
31
  * Creates a new WixData update options builder.
32
- * @internal
32
+ * @public
33
+ * @documentationMaturity preview
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * import { items, Filter, UpdateOptionsBuilder } from '@wix/data'
38
+ *
39
+ * const options = UpdateOptionsBuilder()
40
+ * .withSuppressHooks(true)
41
+ * .withCondition(Filter('status').eq('active'))
42
+ * .build()
43
+ *
44
+ * const updatedItem = await items.update<MyItem>(
45
+ * 'myCollection',
46
+ * { _id: 'myItemId', status: 'active' },
47
+ * options
48
+ * )
49
+ * ```
33
50
  */
34
51
  export const UpdateOptionsBuilder = () => new WixDataUpdateOptionsBuilderImpl();
35
52
  //# sourceMappingURL=WixDataUpdateOptionsBuilder.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataUpdateOptionsBuilder.js","sourceRoot":"","sources":["../../../src/api/WixDataUpdateOptionsBuilder.ts"],"names":[],"mappings":"AAsBA,MAAM,+BAA+B;IACnC,YAA6B,UAAgC,EAAE;QAAlC,YAAO,GAAP,OAAO,CAA2B;IAAG,CAAC;IAEnE,iBAAiB,CAAC,KAAc;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAA;IAC5C,CAAC;IAED,cAAc,CAAC,KAAc;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,qBAAqB,CAAC,KAAc;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC,CAAA;IAChD,CAAC;IAED,kBAAkB,CAAC,KAAc;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAA;IAC7C,CAAC;IAED,aAAa,CACX,KAAsD;QAEtD,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK;QACH,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;IAC5B,CAAC;IAEO,IAAI,CAAC,OAA6B;QACxC,OAAO,IAAI,+BAA+B,CAAC;YACzC,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAsC,GAAG,EAAE,CAC1E,IAAI,+BAA+B,EAAE,CAAA"}
1
+ {"version":3,"file":"WixDataUpdateOptionsBuilder.js","sourceRoot":"","sources":["../../../src/api/WixDataUpdateOptionsBuilder.ts"],"names":[],"mappings":"AAiDA,MAAM,+BAA+B;IACnC,YAA6B,UAAgC,EAAE;QAAlC,YAAO,GAAP,OAAO,CAA2B;IAAG,CAAC;IAEnE,iBAAiB,CAAC,KAAc;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAA;IAC5C,CAAC;IAED,cAAc,CAAC,KAAc;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAA;IACzC,CAAC;IAED,qBAAqB,CAAC,KAAc;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,iBAAiB,EAAE,KAAK,EAAE,CAAC,CAAA;IAChD,CAAC;IAED,kBAAkB,CAAC,KAAc;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAA;IAC7C,CAAC;IAED,aAAa,CACX,KAAsD;QAEtD,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/C,CAAC;IAED,KAAK;QACH,OAAO,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;IAC5B,CAAC;IAEO,IAAI,CAAC,OAA6B;QACxC,OAAO,IAAI,+BAA+B,CAAC;YACzC,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,OAAO;SACX,CAAC,CAAA;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAsC,GAAG,EAAE,CAC1E,IAAI,+BAA+B,EAAE,CAAA"}
@@ -37,16 +37,5 @@ export interface PipelineBuilder {
37
37
  */
38
38
  build(): AggregationPipeline;
39
39
  }
40
- /**
41
- * Builds an aggregation pipeline for use with [`aggregatePipeline()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate-pipeline).
42
- *
43
- * Configure the pipeline by calling `pipelineBuilder()` and chaining [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods. Then, specify the pipeline as the `pipeline` parameter when calling the [`aggregatePipeline()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate-pipeline) method.
44
- *
45
- * > **Note**: You can only build an aggregation pipeline for collections [created in the CMS](https://support.wix.com/en/article/cms-formerly-content-manager-creating-a-collection) or with the [Data Collections API](https://dev.wix.com/docs/sdk/backend-modules/data/collections/introduction). They cannot be used on [Wix app collections](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) or [external collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
46
- *
47
- * @public
48
- * @documentationMaturity preview
49
- * @returns PipelineBuilder object
50
- */
51
40
  export declare function pipelineBuilder(): PipelineBuilder;
52
41
  //# sourceMappingURL=PipelineBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"PipelineBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/PipelineBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,eAAe,CAAA;IAEpD;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,eAAe,CAAA;IAE1D;;;;;;;;OAQG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AA4BD;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,IAAI,eAAe,CAEjD"}
1
+ {"version":3,"file":"PipelineBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/PipelineBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEpE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,eAAe,CAAA;IAEpD;;;;;;;;;OASG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,eAAe,CAAA;IAE1D;;;;;;;;OAQG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AA4BD,wBAAgB,eAAe,IAAI,eAAe,CAEjD"}
@@ -1,18 +1,58 @@
1
1
  import type { WixDataAggregateOptions } from './types';
2
2
  /**
3
- * WixData aggregate options builder.
4
- * @internal
3
+ * Builder for aggregate options used by Wix Data aggregate operations.
4
+ *
5
+ * Use this builder to configure aggregation behavior such as language, consistent reads,
6
+ * and total counts.
7
+ * @public
8
+ * @builder
9
+ * @documentationMaturity preview
5
10
  */
6
11
  export interface WixDataAggregateOptionsBuilder {
12
+ /**
13
+ * Sets whether draft items are included in aggregation results.
14
+ * @internal
15
+ */
7
16
  withShowDrafts(value: boolean): WixDataAggregateOptionsBuilder;
17
+ /**
18
+ * Sets the language used for the aggregation.
19
+ */
8
20
  withLanguage(value: string): WixDataAggregateOptionsBuilder;
21
+ /**
22
+ * Sets whether the aggregation uses consistent read mode.
23
+ */
9
24
  withConsistentRead(value: boolean): WixDataAggregateOptionsBuilder;
25
+ /**
26
+ * Sets whether the total result count is returned with the aggregation response.
27
+ */
10
28
  withReturnTotalCount(value: boolean): WixDataAggregateOptionsBuilder;
29
+ /**
30
+ * Builds the aggregate options object.
31
+ */
11
32
  build(): WixDataAggregateOptions;
12
33
  }
13
34
  /**
14
35
  * Creates a new WixData aggregate options builder.
15
- * @internal
36
+ * @public
37
+ * @documentationMaturity preview
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * import { items, AggregateOptionsBuilder } from '@wix/data'
42
+ *
43
+ *
44
+ * const options = AggregateOptionsBuilder()
45
+ * .withLanguage('en')
46
+ * .withConsistentRead(true)
47
+ * .withReturnTotalCount(true)
48
+ * .build()
49
+ *
50
+ * const result = await items.aggregate<MyItem>(
51
+ * 'myCollection',
52
+ * {},
53
+ * options
54
+ * )
55
+ * ```
16
56
  */
17
57
  export declare const AggregateOptionsBuilder: () => WixDataAggregateOptionsBuilder;
18
58
  //# sourceMappingURL=WixDataAggregateOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataAggregateOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAggregateOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA;AAEtD;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IAC9D,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,8BAA8B,CAAA;IAC3D,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IAClE,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IACpE,KAAK,IAAI,uBAAuB,CAAA;CACjC;AAqCD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BACI,CAAA"}
1
+ {"version":3,"file":"WixDataAggregateOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAggregateOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAA;AAEtD;;;;;;;;GAQG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IAC9D;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,8BAA8B,CAAA;IAC3D;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IAClE;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IACpE;;OAEG;IACH,KAAK,IAAI,uBAAuB,CAAA;CACjC;AAqCD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BACI,CAAA"}
@@ -1,16 +1,49 @@
1
1
  import type { WixDataAsyncPatchByFilterOptions } from './types';
2
2
  /**
3
- * WixData async patch by filter options builder.
4
- * @internal
3
+ * Builder for async patch by filter options used by Wix Data async patch-by-filter operations.
4
+ *
5
+ * Use this builder to configure async patch behavior such as hooks suppression.
6
+ * @public
7
+ * @builder
8
+ * @documentationMaturity preview
5
9
  */
6
10
  export interface WixDataAsyncPatchByFilterOptionsBuilder {
11
+ /**
12
+ * Sets whether async patch hooks are suppressed.
13
+ *
14
+ * When `true`, the async patch runs without triggering hooks.
15
+ */
7
16
  withSuppressHooks(value: boolean): WixDataAsyncPatchByFilterOptionsBuilder;
17
+ /**
18
+ * Sets whether draft items are included when patching items asynchronously.
19
+ * @internal
20
+ */
8
21
  withShowDrafts(value: boolean): WixDataAsyncPatchByFilterOptionsBuilder;
22
+ /**
23
+ * Builds the async patch by filter options object.
24
+ */
9
25
  build(): WixDataAsyncPatchByFilterOptions;
10
26
  }
11
27
  /**
12
28
  * Creates a new WixData async patch by filter options builder.
13
- * @internal
29
+ * @public
30
+ * @documentationMaturity preview
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * import { items, AsyncPatchByFilterOptionsBuilder } from '@wix/data'
35
+ *
36
+ * const options = AsyncPatchByFilterOptionsBuilder()
37
+ * .withSuppressHooks(true)
38
+ * .build()
39
+ *
40
+ * const job = await items.asyncPatchByFilter(
41
+ * 'myCollection',
42
+ * { archived: false },
43
+ * [],
44
+ * options
45
+ * )
46
+ * ```
14
47
  */
15
48
  export declare const AsyncPatchByFilterOptionsBuilder: () => WixDataAsyncPatchByFilterOptionsBuilder;
16
49
  //# sourceMappingURL=WixDataAsyncPatchByFilterOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataAsyncPatchByFilterOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAsyncPatchByFilterOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,SAAS,CAAA;AAE/D;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IACtD,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,uCAAuC,CAAA;IAC1E,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,uCAAuC,CAAA;IACvE,KAAK,IAAI,gCAAgC,CAAA;CAC1C;AAiCD;;;GAGG;AACH,eAAO,MAAM,gCAAgC,EAAE,MAAM,uCACI,CAAA"}
1
+ {"version":3,"file":"WixDataAsyncPatchByFilterOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAsyncPatchByFilterOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,SAAS,CAAA;AAE/D;;;;;;;GAOG;AACH,MAAM,WAAW,uCAAuC;IACtD;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,uCAAuC,CAAA;IAC1E;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,uCAAuC,CAAA;IACvE;;OAEG;IACH,KAAK,IAAI,gCAAgC,CAAA;CAC1C;AAiCD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,gCAAgC,EAAE,MAAM,uCACI,CAAA"}
@@ -1,16 +1,48 @@
1
1
  import type { WixDataAsyncRemoveByFilterOptions } from './types';
2
2
  /**
3
- * WixData async remove by filter options builder.
4
- * @internal
3
+ * Builder for async remove by filter options used by Wix Data async remove-by-filter operations.
4
+ *
5
+ * Use this builder to configure async remove behavior such as hooks suppression.
6
+ * @public
7
+ * @builder
8
+ * @documentationMaturity preview
5
9
  */
6
10
  export interface WixDataAsyncRemoveByFilterOptionsBuilder {
11
+ /**
12
+ * Sets whether async remove hooks are suppressed.
13
+ *
14
+ * When `true`, the async remove runs without triggering hooks.
15
+ */
7
16
  withSuppressHooks(value: boolean): WixDataAsyncRemoveByFilterOptionsBuilder;
17
+ /**
18
+ * Sets whether draft items are included when removing items asynchronously.
19
+ * @internal
20
+ */
8
21
  withShowDrafts(value: boolean): WixDataAsyncRemoveByFilterOptionsBuilder;
22
+ /**
23
+ * Builds the async remove by filter options object.
24
+ */
9
25
  build(): WixDataAsyncRemoveByFilterOptions;
10
26
  }
11
27
  /**
12
28
  * Creates a new WixData async remove by filter options builder.
13
- * @internal
29
+ * @public
30
+ * @documentationMaturity preview
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * import { items, AsyncRemoveByFilterOptionsBuilder } from '@wix/data'
35
+ *
36
+ * const options = AsyncRemoveByFilterOptionsBuilder()
37
+ * .withSuppressHooks(true)
38
+ * .build()
39
+ *
40
+ * const job = await items.asyncRemoveByFilter(
41
+ * 'myCollection',
42
+ * { archived: true },
43
+ * options
44
+ * )
45
+ * ```
14
46
  */
15
47
  export declare const AsyncRemoveByFilterOptionsBuilder: () => WixDataAsyncRemoveByFilterOptionsBuilder;
16
48
  //# sourceMappingURL=WixDataAsyncRemoveByFilterOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataAsyncRemoveByFilterOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAsyncRemoveByFilterOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAA;AAEhE;;;GAGG;AACH,MAAM,WAAW,wCAAwC;IACvD,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,wCAAwC,CAAA;IAC3E,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,wCAAwC,CAAA;IACxE,KAAK,IAAI,iCAAiC,CAAA;CAC3C;AAiCD;;;GAGG;AACH,eAAO,MAAM,iCAAiC,EAAE,MAAM,wCACI,CAAA"}
1
+ {"version":3,"file":"WixDataAsyncRemoveByFilterOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataAsyncRemoveByFilterOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAA;AAEhE;;;;;;;GAOG;AACH,MAAM,WAAW,wCAAwC;IACvD;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,wCAAwC,CAAA;IAC3E;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,wCAAwC,CAAA;IACxE;;OAEG;IACH,KAAK,IAAI,iCAAiC,CAAA;CAC3C;AAiCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iCAAiC,EAAE,MAAM,wCACI,CAAA"}
@@ -1,18 +1,56 @@
1
1
  import type { WixDataBulkInsertOptions } from './types';
2
2
  /**
3
- * WixData bulk insert options builder.
4
- * @internal
3
+ * Builder for bulk insert options used by Wix Data bulk insert operations.
4
+ *
5
+ * Use this builder to configure bulk insert behavior such as hooks suppression.
6
+ * @public
7
+ * @builder
8
+ * @documentationMaturity preview
5
9
  */
6
10
  export interface WixDataBulkInsertOptionsBuilder {
11
+ /**
12
+ * Sets whether bulk insert hooks are suppressed.
13
+ *
14
+ * When `true`, the bulk insert runs without triggering hooks.
15
+ */
7
16
  withSuppressHooks(value: boolean): WixDataBulkInsertOptionsBuilder;
17
+ /**
18
+ * Sets whether draft items are included when inserting items in bulk.
19
+ * @internal
20
+ */
8
21
  withShowDrafts(value: boolean): WixDataBulkInsertOptionsBuilder;
22
+ /**
23
+ * Sets whether referenced items are saved when inserting items in bulk.
24
+ */
9
25
  withSaveReferences(value: boolean): WixDataBulkInsertOptionsBuilder;
26
+ /**
27
+ * Sets whether existing items can be overridden during the bulk insert operation.
28
+ * @internal
29
+ */
10
30
  withOverrideExisting(value: boolean): WixDataBulkInsertOptionsBuilder;
31
+ /**
32
+ * Builds the bulk insert options object.
33
+ */
11
34
  build(): WixDataBulkInsertOptions;
12
35
  }
13
36
  /**
14
37
  * Creates a new WixData bulk insert options builder.
15
- * @internal
38
+ * @public
39
+ * @documentationMaturity preview
40
+ *
41
+ * @example
42
+ * ```ts
43
+ * import { items, BulkInsertOptionsBuilder } from '@wix/data'
44
+ *
45
+ * const options = BulkInsertOptionsBuilder()
46
+ * .withSuppressHooks(true)
47
+ * .build()
48
+ *
49
+ * const result = await items.bulkInsert('myCollection', [
50
+ * { name: 'First item' },
51
+ * { name: 'Second item' },
52
+ * ], options)
53
+ * ```
16
54
  */
17
55
  export declare const BulkInsertOptionsBuilder: () => WixDataBulkInsertOptionsBuilder;
18
56
  //# sourceMappingURL=WixDataBulkInsertOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataBulkInsertOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkInsertOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAEvD;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAClE,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAC/D,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IACnE,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IACrE,KAAK,IAAI,wBAAwB,CAAA;CAClC;AAuCD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,+BACI,CAAA"}
1
+ {"version":3,"file":"WixDataBulkInsertOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkInsertOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAEvD;;;;;;;GAOG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAClE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAC/D;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IACnE;;;OAGG;IACH,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IACrE;;OAEG;IACH,KAAK,IAAI,wBAAwB,CAAA;CAClC;AAuCD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,+BACI,CAAA"}
@@ -2,18 +2,51 @@ import type { FilterExpression } from '@wix/sdk-types';
2
2
  import type { WixDataItem, WixDataQuerySpec } from './types';
3
3
  import type { WixDataBulkPatchOptions } from './WixDataPatch';
4
4
  /**
5
- * WixData bulk patch options builder.
6
- * @internal
5
+ * Builder for bulk patch options used by Wix Data bulk patch operations.
6
+ *
7
+ * Use this builder to configure bulk patch behavior such as hooks suppression,
8
+ * and conditional patching.
9
+ * @public
10
+ * @builder
11
+ * @documentationMaturity preview
7
12
  */
8
13
  export interface WixDataBulkPatchOptionsBuilder {
14
+ /**
15
+ * Sets whether bulk patch hooks are suppressed.
16
+ *
17
+ * When `true`, the bulk patch runs without triggering hooks.
18
+ */
9
19
  withSuppressHooks(value: boolean): WixDataBulkPatchOptionsBuilder;
20
+ /**
21
+ * Sets whether draft items are included when patching items in bulk.
22
+ * @internal
23
+ */
10
24
  withShowDrafts(value: boolean): WixDataBulkPatchOptionsBuilder;
25
+ /**
26
+ * Sets the condition that determines which items are patched.
27
+ */
11
28
  withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataBulkPatchOptionsBuilder;
29
+ /**
30
+ * Builds the bulk patch options object.
31
+ */
12
32
  build(): WixDataBulkPatchOptions;
13
33
  }
14
34
  /**
15
35
  * Creates a new WixData bulk patch options builder.
16
- * @internal
36
+ * @public
37
+ * @documentationMaturity preview
38
+ *
39
+ * @example
40
+ * ```ts
41
+ * import { items, BulkPatchOptionsBuilder, Filter } from '@wix/data'
42
+ *
43
+ * const options = BulkPatchOptionsBuilder()
44
+ * .withSuppressHooks(true)
45
+ * .withCondition(Filter('status').eq('active'))
46
+ * .build()
47
+ *
48
+ * const result = await items.bulkPatch('myCollection', ['item-1', 'item-2'], [], options)
49
+ * ```
17
50
  */
18
51
  export declare const BulkPatchOptionsBuilder: () => WixDataBulkPatchOptionsBuilder;
19
52
  //# sourceMappingURL=WixDataBulkPatchOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataBulkPatchOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkPatchOptionsBuilder.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,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAE7D;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IACjE,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IAC9D,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,8BAA8B,CAAA;IACjC,KAAK,IAAI,uBAAuB,CAAA;CACjC;AAqCD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BACI,CAAA"}
1
+ {"version":3,"file":"WixDataBulkPatchOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkPatchOptionsBuilder.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,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAE7D;;;;;;;;GAQG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IACjE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,8BAA8B,CAAA;IAC9D;;OAEG;IACH,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,8BAA8B,CAAA;IACjC;;OAEG;IACH,KAAK,IAAI,uBAAuB,CAAA;CACjC;AAqCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,uBAAuB,EAAE,MAAM,8BACI,CAAA"}
@@ -1,18 +1,51 @@
1
1
  import type { FilterExpression } from '@wix/sdk-types';
2
2
  import type { WixDataBulkRemoveOptions, WixDataItem, WixDataQuerySpec } from './types';
3
3
  /**
4
- * WixData bulk remove options builder.
5
- * @internal
4
+ * Builder for bulk remove options used by Wix Data bulk remove operations.
5
+ *
6
+ * Use this builder to configure bulk remove behavior such as hooks suppression,
7
+ * and conditional removal.
8
+ * @public
9
+ * @builder
10
+ * @documentationMaturity preview
6
11
  */
7
12
  export interface WixDataBulkRemoveOptionsBuilder {
13
+ /**
14
+ * Sets whether bulk remove hooks are suppressed.
15
+ *
16
+ * When `true`, the bulk remove runs without triggering hooks.
17
+ */
8
18
  withSuppressHooks(value: boolean): WixDataBulkRemoveOptionsBuilder;
19
+ /**
20
+ * Sets whether draft items are included when removing items in bulk.
21
+ * @internal
22
+ */
9
23
  withShowDrafts(value: boolean): WixDataBulkRemoveOptionsBuilder;
24
+ /**
25
+ * Sets the condition that determines which items are removed.
26
+ */
10
27
  withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataBulkRemoveOptionsBuilder;
28
+ /**
29
+ * Builds the bulk remove options object.
30
+ */
11
31
  build(): WixDataBulkRemoveOptions;
12
32
  }
13
33
  /**
14
34
  * Creates a new WixData bulk remove options builder.
15
- * @internal
35
+ * @public
36
+ * @documentationMaturity preview
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * import { items, BulkRemoveOptionsBuilder, Filter } from '@wix/data'
41
+ *
42
+ * const options = BulkRemoveOptionsBuilder()
43
+ * .withSuppressHooks(true)
44
+ * .withCondition(Filter('status').eq('active'))
45
+ * .build()
46
+ *
47
+ * const result = await items.bulkRemove('myCollection', ['item-1', 'item-2'], options)
48
+ * ```
16
49
  */
17
50
  export declare const BulkRemoveOptionsBuilder: () => WixDataBulkRemoveOptionsBuilder;
18
51
  //# sourceMappingURL=WixDataBulkRemoveOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataBulkRemoveOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkRemoveOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAClE,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAC/D,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,+BAA+B,CAAA;IAClC,KAAK,IAAI,wBAAwB,CAAA;CAClC;AAqCD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,+BACI,CAAA"}
1
+ {"version":3,"file":"WixDataBulkRemoveOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkRemoveOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAClE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAC/D;;OAEG;IACH,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,+BAA+B,CAAA;IAClC;;OAEG;IACH,KAAK,IAAI,wBAAwB,CAAA;CAClC;AAqCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,+BACI,CAAA"}
@@ -1,17 +1,49 @@
1
1
  import type { WixDataBulkSaveOptions } from './types';
2
2
  /**
3
- * WixData bulk save options builder.
4
- * @internal
3
+ * Builder for bulk save options used by Wix Data bulk save operations.
4
+ *
5
+ * Use this builder to configure bulk save behavior such as hooks suppression and reference saving.
6
+ * @public
7
+ * @builder
8
+ * @documentationMaturity preview
5
9
  */
6
10
  export interface WixDataBulkSaveOptionsBuilder {
11
+ /**
12
+ * Sets whether hooks are suppressed.
13
+ *
14
+ * When `true`, the bulk save runs without triggering hooks.
15
+ */
7
16
  withSuppressHooks(value: boolean): WixDataBulkSaveOptionsBuilder;
17
+ /**
18
+ * Sets whether draft items are included when saving items in bulk.
19
+ * @internal
20
+ */
8
21
  withShowDrafts(value: boolean): WixDataBulkSaveOptionsBuilder;
22
+ /**
23
+ * Sets whether referenced items are saved when saving items in bulk.
24
+ */
9
25
  withSaveReferences(value: boolean): WixDataBulkSaveOptionsBuilder;
26
+ /**
27
+ * Builds the bulk save options object.
28
+ */
10
29
  build(): WixDataBulkSaveOptions;
11
30
  }
12
31
  /**
13
32
  * Creates a new WixData bulk save options builder.
14
- * @internal
33
+ * @public
34
+ * @documentationMaturity preview
35
+ *
36
+ * @example
37
+ * ```ts
38
+ * import { items, BulkSaveOptionsBuilder } from '@wix/data'
39
+ *
40
+ * const options = BulkSaveOptionsBuilder()
41
+ * .withSuppressHooks(true)
42
+ * .withSaveReferences(true)
43
+ * .build()
44
+ *
45
+ * const result = await items.bulkSave('myCollection', [{ _id: 'foo', references: ['ref1', 'ref2'] }], options)
46
+ * ```
15
47
  */
16
48
  export declare const BulkSaveOptionsBuilder: () => WixDataBulkSaveOptionsBuilder;
17
49
  //# sourceMappingURL=WixDataBulkSaveOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataBulkSaveOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkSaveOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAErD;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAChE,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IAC7D,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACjE,KAAK,IAAI,sBAAsB,CAAA;CAChC;AAiCD;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,6BACF,CAAA"}
1
+ {"version":3,"file":"WixDataBulkSaveOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkSaveOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAErD;;;;;;;GAOG;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;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,6BAA6B,CAAA;IACjE;;OAEG;IACH,KAAK,IAAI,sBAAsB,CAAA;CAChC;AAiCD;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,sBAAsB,EAAE,MAAM,6BACF,CAAA"}
@@ -1,19 +1,58 @@
1
1
  import type { FilterExpression } from '@wix/sdk-types';
2
2
  import type { WixDataBulkUpdateOptions, WixDataItem, WixDataQuerySpec } from './types';
3
3
  /**
4
- * WixData bulk update options builder.
5
- * @internal
4
+ * Builder for bulk update options used by Wix Data bulk update operations.
5
+ *
6
+ * Use this builder to configure bulk update behavior such as hooks suppression,
7
+ * reference saving, and conditional updates.
8
+ * @public
9
+ * @builder
10
+ * @documentationMaturity preview
6
11
  */
7
12
  export interface WixDataBulkUpdateOptionsBuilder {
13
+ /**
14
+ * Sets whether update hooks are suppressed.
15
+ *
16
+ * When `true`, the bulk update runs without triggering hooks.
17
+ */
8
18
  withSuppressHooks(value: boolean): WixDataBulkUpdateOptionsBuilder;
19
+ /**
20
+ * Sets whether draft items are included when updating items in bulk.
21
+ * @internal
22
+ */
9
23
  withShowDrafts(value: boolean): WixDataBulkUpdateOptionsBuilder;
24
+ /**
25
+ * Sets whether referenced items are saved when updating items in bulk.
26
+ */
10
27
  withSaveReferences(value: boolean): WixDataBulkUpdateOptionsBuilder;
28
+ /**
29
+ * Sets the condition that determines which items are updated.
30
+ */
11
31
  withCondition(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataBulkUpdateOptionsBuilder;
32
+ /**
33
+ * Builds the bulk update options object.
34
+ */
12
35
  build(): WixDataBulkUpdateOptions;
13
36
  }
14
37
  /**
15
38
  * Creates a new WixData bulk update options builder.
16
- * @internal
39
+ * @public
40
+ * @documentationMaturity preview
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * import { items, BulkUpdateOptionsBuilder, Filter } from '@wix/data'
45
+ *
46
+ * const options = BulkUpdateOptionsBuilder()
47
+ * .withSuppressHooks(true)
48
+ * .withCondition(Filter('status').eq('active'))
49
+ * .build()
50
+ *
51
+ * const result = await items.bulkUpdate('myCollection', [
52
+ * { _id: 'foo', title: 'Updated' },
53
+ * { _id: 'bar', title: 'Updated' },
54
+ * ], options)
55
+ * ```
17
56
  */
18
57
  export declare const BulkUpdateOptionsBuilder: () => WixDataBulkUpdateOptionsBuilder;
19
58
  //# sourceMappingURL=WixDataBulkUpdateOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataBulkUpdateOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkUpdateOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAClE,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAC/D,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IACnE,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,+BAA+B,CAAA;IAClC,KAAK,IAAI,wBAAwB,CAAA;CAClC;AAyCD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,+BACI,CAAA"}
1
+ {"version":3,"file":"WixDataBulkUpdateOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataBulkUpdateOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,wBAAwB,EACxB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;GAQG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAClE;;;OAGG;IACH,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IAC/D;;OAEG;IACH,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,+BAA+B,CAAA;IACnE;;OAEG;IACH,aAAa,CACX,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,+BAA+B,CAAA;IAClC;;OAEG;IACH,KAAK,IAAI,wBAAwB,CAAA;CAClC;AAyCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,wBAAwB,EAAE,MAAM,+BACI,CAAA"}
@@ -1,21 +1,66 @@
1
1
  import type { FilterExpression } from '@wix/sdk-types';
2
2
  import type { WixDataCountOptions, WixDataItem, WixDataQuerySpec } from './types';
3
3
  /**
4
- * WixData count options builder.
5
- * @internal
4
+ * Builder for count options used by Wix Data count operations.
5
+ *
6
+ * Use this builder to configure count behavior such as hooks suppression,
7
+ * app-specific options, language, consistency, and filters.
8
+ * @public
9
+ * @builder
10
+ * @documentationMaturity preview
6
11
  */
7
12
  export interface WixDataCountOptionsBuilder {
13
+ /**
14
+ * Sets whether count hooks are suppressed.
15
+ *
16
+ * When `true`, the count runs without triggering hooks.
17
+ */
8
18
  withSuppressHooks(value: boolean): WixDataCountOptionsBuilder;
19
+ /**
20
+ * Sets whether draft items are included when counting items.
21
+ * @internal
22
+ */
9
23
  withShowDrafts(value: boolean): WixDataCountOptionsBuilder;
24
+ /**
25
+ * Sets app-specific options for the count operation.
26
+ */
10
27
  withAppOptions(value: Record<string, any>): WixDataCountOptionsBuilder;
28
+ /**
29
+ * Sets the language used for the count operation.
30
+ */
11
31
  withLanguage(value: string): WixDataCountOptionsBuilder;
32
+ /**
33
+ * Sets whether the count uses a consistent read.
34
+ */
12
35
  withConsistentRead(value: boolean): WixDataCountOptionsBuilder;
36
+ /**
37
+ * Sets the filter used to count matching items.
38
+ */
13
39
  withFilter(value: FilterExpression<WixDataItem, WixDataQuerySpec>): WixDataCountOptionsBuilder;
40
+ /**
41
+ * Builds the count options object.
42
+ */
14
43
  build(): WixDataCountOptions;
15
44
  }
16
45
  /**
17
46
  * Creates a new WixData count options builder.
18
- * @internal
47
+ * @public
48
+ * @documentationMaturity preview
49
+ *
50
+ * @example
51
+ * ```ts
52
+ * import { items, CountOptionsBuilder } from '@wix/data'
53
+ *
54
+ * const options = CountOptionsBuilder()
55
+ * .withSuppressHooks(true)
56
+ * .withAppOptions({ key: 'value' })
57
+ * .withLanguage('en')
58
+ * .withConsistentRead(true)
59
+ * .withFilter(Filter('status').eq('active'))
60
+ * .build()
61
+ *
62
+ * const total = await items.count('myCollection', options)
63
+ * ```
19
64
  */
20
65
  export declare const CountOptionsBuilder: () => WixDataCountOptionsBuilder;
21
66
  //# sourceMappingURL=WixDataCountOptionsBuilder.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"WixDataCountOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataCountOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC7D,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC1D,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,0BAA0B,CAAA;IACtE,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,0BAA0B,CAAA;IACvD,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,0BAA0B,CAAA;IAC9D,UAAU,CACR,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,0BAA0B,CAAA;IAC7B,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAgDD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}
1
+ {"version":3,"file":"WixDataCountOptionsBuilder.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataCountOptionsBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AACtD,OAAO,KAAK,EACV,mBAAmB,EACnB,WAAW,EACX,gBAAgB,EACjB,MAAM,SAAS,CAAA;AAEhB;;;;;;;;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;;OAEG;IACH,UAAU,CACR,KAAK,EAAE,gBAAgB,CAAC,WAAW,EAAE,gBAAgB,CAAC,GACrD,0BAA0B,CAAA;IAC7B;;OAEG;IACH,KAAK,IAAI,mBAAmB,CAAA;CAC7B;AAgDD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,0BACF,CAAA"}