@wix/wix-data-items-sdk 1.0.414 → 1.0.416

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 (5) hide show
  1. package/build/cjs/src/data-v2-data-item-items.universal.d.ts +3 -3
  2. package/build/cjs/src/data-v2-data-item-items.universal.js +3 -3
  3. package/build/es/src/data-v2-data-item-items.universal.d.ts +3 -3
  4. package/build/es/src/data-v2-data-item-items.universal.js +3 -3
  5. package/package.json +5 -5
package/build/cjs/src/data-v2-data-item-items.universal.d.ts CHANGED
@@ -644,15 +644,15 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
644
644
  *
645
645
  * Aggregations enable you to perform advanced data calculations, transformations, and groupings. While [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate) allows you to perform basic aggregations, `aggregatePipeline()` allows you to perform advanced aggregations sequentially in stages, with each stage transforming the results of the previous stage.
646
646
  *
647
- * The `aggregatePipeline()` method receives the collection ID and an array of pipeline stages as arguments and returns a `WixDataAggregatePipeline` object.
647
+ * To call the `aggregatePipeline()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages, configure paging, and build the pipeline.
648
648
  *
649
- * The method directly executes the pipeline and returns an object containing the aggregated results and pagination information.
649
+ * The method directly runs the pipeline and returns the aggregated results and pagination information.
650
650
  *
651
651
  * @public
652
652
  * @documentationMaturity preview
653
653
  * @requiredField dataCollectionId
654
654
  * @param dataCollectionId - ID of the collection to run the aggregation pipeline on.
655
- * @param pipeline - Aggregation pipeline with data processing stages and paging configuration.
655
+ * @param pipeline - Aggregation pipeline with data processing stages and paging configuration. Call [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) to build the pipeline.
656
656
  * @param options - Options for running the aggregation pipeline.
657
657
  * @permissionScope Read Data Items
658
658
  * @permissionScopeId SCOPE.DC-DATA.READ
package/build/cjs/src/data-v2-data-item-items.universal.js CHANGED
@@ -753,15 +753,15 @@ function aggregate(dataCollectionId) {
753
753
  *
754
754
  * Aggregations enable you to perform advanced data calculations, transformations, and groupings. While [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate) allows you to perform basic aggregations, `aggregatePipeline()` allows you to perform advanced aggregations sequentially in stages, with each stage transforming the results of the previous stage.
755
755
  *
756
- * The `aggregatePipeline()` method receives the collection ID and an array of pipeline stages as arguments and returns a `WixDataAggregatePipeline` object.
756
+ * To call the `aggregatePipeline()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages, configure paging, and build the pipeline.
757
757
  *
758
- * The method directly executes the pipeline and returns an object containing the aggregated results and pagination information.
758
+ * The method directly runs the pipeline and returns the aggregated results and pagination information.
759
759
  *
760
760
  * @public
761
761
  * @documentationMaturity preview
762
762
  * @requiredField dataCollectionId
763
763
  * @param dataCollectionId - ID of the collection to run the aggregation pipeline on.
764
- * @param pipeline - Aggregation pipeline with data processing stages and paging configuration.
764
+ * @param pipeline - Aggregation pipeline with data processing stages and paging configuration. Call [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) to build the pipeline.
765
765
  * @param options - Options for running the aggregation pipeline.
766
766
  * @permissionScope Read Data Items
767
767
  * @permissionScopeId SCOPE.DC-DATA.READ
package/build/es/src/data-v2-data-item-items.universal.d.ts CHANGED
@@ -644,15 +644,15 @@ export declare function aggregate(dataCollectionId: string): WixDataAggregate;
644
644
  *
645
645
  * Aggregations enable you to perform advanced data calculations, transformations, and groupings. While [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate) allows you to perform basic aggregations, `aggregatePipeline()` allows you to perform advanced aggregations sequentially in stages, with each stage transforming the results of the previous stage.
646
646
  *
647
- * The `aggregatePipeline()` method receives the collection ID and an array of pipeline stages as arguments and returns a `WixDataAggregatePipeline` object.
647
+ * To call the `aggregatePipeline()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages, configure paging, and build the pipeline.
648
648
  *
649
- * The method directly executes the pipeline and returns an object containing the aggregated results and pagination information.
649
+ * The method directly runs the pipeline and returns the aggregated results and pagination information.
650
650
  *
651
651
  * @public
652
652
  * @documentationMaturity preview
653
653
  * @requiredField dataCollectionId
654
654
  * @param dataCollectionId - ID of the collection to run the aggregation pipeline on.
655
- * @param pipeline - Aggregation pipeline with data processing stages and paging configuration.
655
+ * @param pipeline - Aggregation pipeline with data processing stages and paging configuration. Call [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) to build the pipeline.
656
656
  * @param options - Options for running the aggregation pipeline.
657
657
  * @permissionScope Read Data Items
658
658
  * @permissionScopeId SCOPE.DC-DATA.READ
package/build/es/src/data-v2-data-item-items.universal.js CHANGED
@@ -709,15 +709,15 @@ export function aggregate(dataCollectionId) {
709
709
  *
710
710
  * Aggregations enable you to perform advanced data calculations, transformations, and groupings. While [`aggregate()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/aggregate) allows you to perform basic aggregations, `aggregatePipeline()` allows you to perform advanced aggregations sequentially in stages, with each stage transforming the results of the previous stage.
711
711
  *
712
- * The `aggregatePipeline()` method receives the collection ID and an array of pipeline stages as arguments and returns a `WixDataAggregatePipeline` object.
712
+ * To call the `aggregatePipeline()` method, specify the collection ID and an aggregation pipeline. To build the pipeline, call the [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) method and chain [`PipelineBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder/introduction) methods to add stages, configure paging, and build the pipeline.
713
713
  *
714
- * The method directly executes the pipeline and returns an object containing the aggregated results and pagination information.
714
+ * The method directly runs the pipeline and returns the aggregated results and pagination information.
715
715
  *
716
716
  * @public
717
717
  * @documentationMaturity preview
718
718
  * @requiredField dataCollectionId
719
719
  * @param dataCollectionId - ID of the collection to run the aggregation pipeline on.
720
- * @param pipeline - Aggregation pipeline with data processing stages and paging configuration.
720
+ * @param pipeline - Aggregation pipeline with data processing stages and paging configuration. Call [`pipelineBuilder()`](https://dev.wix.com/docs/sdk/backend-modules/data/items/pipeline-builder) to build the pipeline.
721
721
  * @param options - Options for running the aggregation pipeline.
722
722
  * @permissionScope Read Data Items
723
723
  * @permissionScopeId SCOPE.DC-DATA.READ
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/wix-data-items-sdk",
3
- "version": "1.0.414",
3
+ "version": "1.0.416",
4
4
  "license": "UNLICENSED",
5
5
  "author": {
6
6
  "name": "Rimvydas Gimbutas",
@@ -35,13 +35,13 @@
35
35
  "dependencies": {
36
36
  "@wix/sdk-runtime": "^0.3.62",
37
37
  "@wix/sdk-types": "^1.13.41",
38
- "@wix/wix-data-items-common": "1.0.222"
38
+ "@wix/wix-data-items-common": "1.0.224"
39
39
  },
40
40
  "devDependencies": {
41
41
  "@eslint/js": "^9.33.0",
42
42
  "@types/fs-extra": "^11.0.4",
43
43
  "@types/jest": "^29.5.14",
44
- "@types/node": "^18.19.122",
44
+ "@types/node": "^18.19.123",
45
45
  "@wix/docs-ts-model": "^1.49.0",
46
46
  "@wix/sdk": "^1.15.27",
47
47
  "eslint": "^9.33.0",
@@ -51,7 +51,7 @@
51
51
  "prettier": "^3.6.2",
52
52
  "ts-jest": "^29.4.1",
53
53
  "typescript": "^5.9.2",
54
- "typescript-eslint": "^8.39.0"
54
+ "typescript-eslint": "^8.39.1"
55
55
  },
56
56
  "wix": {
57
57
  "artifact": {
@@ -79,5 +79,5 @@
79
79
  "wallaby": {
80
80
  "autoDetect": true
81
81
  },
82
- "falconPackageHash": "0309deb8d899351eec8acbe1c01ef0d2cbbadf96fd45ed97ad180e90"
82
+ "falconPackageHash": "f21f0589976b2d268869f815c5f1e938e141e247ac0640667ff8b72a"
83
83
  }