@wix/wix-data-items-common 1.0.236 → 1.0.237

package/dist/types/api/stages/FilterStage.d.ts

@@ -19,20 +19,18 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     readonly invalidArguments: string[];
     /**
-     * Filters pipeline data to match items whose specified field value equals the specified value.
+     * Filters pipeline data to match items where the value of the specified field equals the specified value.
      *
-     * The `eq()` method refines this aggregate pipeline filter to only
-     * match items where the value of the specified field equals the specified `value`.
+     * The `eq()` method refines the filter to only match items where the value of the specified field equals the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type does not match the same number stored as a Number type.
+     * It only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a number.
      *
-     * Matching strings with `eq()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     * Matching strings with `eq()` is case sensitive, so `"text"` is not considered equal to `"Text"`.
      *
-     * If `field` points to a collection field of type array, `eq()` includes the item as long as at least one array element matches the specified `value`.
+     * If `field` points to a collection field of type array, `eq()` includes the item as long as at least one array element matches the specified value.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to compare with.
      * @requiredField value
@@ -40,21 +38,18 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     eq(field: string, value: any): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value does not equal the specified value.
+     * Filters pipeline data to match items where the value of the specified field does not equal the specified value.
      *
-     * The `ne()` method refines this aggregate pipeline filter to only
-     * match items where the value of the specified field does not equal the specified `value`.
+     * The `ne()` method refines the filter to only match items where the value of the specified field does not equal the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type is considered not equal to the same number stored as a Number type.
+     * It only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string is considered not equal to the same number stored as a number.
      *
-     * Matching strings with `ne()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     * Matching strings with `ne()` is case sensitive, so `"text"` is not considered equal to `"Text"`.
      *
-     * If the value of `field` is an array, `ne()` includes items
-     * in which none of the elements of the array match the specified `value`.
+     * If the value of `field` is an array, `ne()` matches items where none of the array's elements match the specified value.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to match.
      * @requiredField value
@@ -62,30 +57,22 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     ne(field: string, value: any): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value is greater than or equal to the specified
-     * value.
+     * Filters pipeline data to match items where the value of the specified field is greater than or equal to the specified value.
      *
-     * The `ge()` method refines this aggregate pipeline filter to only
-     * match items where the value of the specified field is greater than or
-     * equal to the specified `value`.
+     * The `ge()` method refines the filter to only match items where the value of the specified field is greater than or equal to the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type does not match the same number stored as a Number type.
+     * It only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a string.
      *
-     * If a field contains a number as a String, that value is compared
-     * alphabetically and not numerically. Items that do not have a value for the
-     * specified field are ranked lowest.
+     * If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
      * The following field types can be compared:
      * - Number: Compares numerically.
      * - Date: Compares JavaScript Date objects.
-     * - String: Compares lexicographically,
-     *   so `"abc"` is greater than or equal to `"ABC"` (because of the greater than),
-     *   but `"ABC"` is not greater than or equal to `"abc"`.
+     * - String: Compares lexicographically, so `"abc"` is greater than or equal to `"ABC"` (because of the greater than), but `"ABC"` is not greater than or equal to `"abc"`.
      * - Reference: Compares by the ID of the referenced item as a String.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to match.
      * @requiredField value
@@ -93,17 +80,13 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     ge(field: string, value: string | number | Date): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value is greater than the specified value.
+     * Filters pipeline data to match items where the value of the specified field is greater than the specified value.
      *
-     * The `gt()` method refines this aggregate pipeline filter to only match
-     * items where the value of the specified field is greater than the specified `value`.
+     * The `gt()` method refines the filter to only match items where the value of the specified field is greater than the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type does not match the same number stored as a Number type.
+     * It only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a string.
      *
-     * If a field contains a number as a String, that value is compared
-     * alphabetically and not numerically. Items that do not have a value for the
-     * specified field are ranked lowest.
+     * If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
      * The following field types can be compared:
      * - Number: Compares numerically.
@@ -112,38 +95,30 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      * - Reference: Compares by the ID of the referenced item as a String.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to match.
      * @requiredField value
-     * @returns An object with the filter definition, based on the supplied parameters.
+     * @returns Refined filter.
      */
     gt(field: string, value: string | number | Date): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value is less than or equal to the specified
-     * value.
+     * Filters pipeline data to match items where the value of the specified field is less than or equal to the specified value.
      *
-     * The `le()` method refines this aggregate pipeline filter to only match
-     * items where the value of the specified field is less than or equal to the
-     * specified `value`.
+     * The `le()` method refines the filter to only match items where the value of the specified field is less than or equal to the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type does not match the same number stored as a Number type.
+     * It only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a string.
      *
-     * If a field contains a number as a String, that value is compared
-     * alphabetically and not numerically. Items that do not have a value for the
-     * specified field are ranked lowest.
+     * If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
      * The following field types can be compared:
      * - Number: Compares numerically.
      * - Date: Compares JavaScript Date objects.
-     * - String: Compares lexicographically,
-     *   so `"ABC"` is less than or equal to `"abc"` (because of the less than),
-     *   but `"abc"` is not less than or equal to `"ABC"`.
+     * - String: Compares lexicographically, so `"ABC"` is less than or equal to `"abc"` (because of the less than), but `"abc"` is not less than or equal to `"ABC"`.
      * - Reference: Compares by the ID of the referenced item as a String.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to match.
      * @requiredField value
@@ -151,17 +126,13 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     le(field: string, value: string | number | Date): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value is less than the specified value.
+     * Filters pipeline data to match items where the value of the specified field is less than the specified value.
      *
-     * The `lt()` method refines this aggregate pipeline filter to only match
-     * items where the value of the specified field is less than the specified `value`.
+     * The `lt()` method refines the filter to only match items where the value of the specified field is less than the specified value.
      *
-     * It only matches values of the same type. For example, a number value stored
-     * as a String type does not match the same number stored as a Number type.
+     * It only matches values of the same [data type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data). For example, a number value stored as a string does not match the same number stored as a string.
      *
-     * If a field contains a number as a String, that value is compared
-     * alphabetically and not numerically. Items that do not have a value for the
-     * specified field are ranked lowest.
+     * If a field contains a number as a string, that value is compared alphabetically and not numerically. Items that do not have a value for the specified field are ranked lowest.
      *
      * The following field types can be compared:
      * - Number: Compares numerically.
@@ -170,24 +141,24 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      * - Reference: Compares by the ID of the referenced item as a String.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to match.
      * @requiredField value
-     * @returns An object with the filter definition, based on the supplied parameters.
+     * @returns Refined filter.
      */
     lt(field: string, value: string | number | Date): FilterStage;
     /**
      * Filters pipeline data to match items whose specified field has any value.
      *
-     * The `isNotEmpty()` method refines this aggregate pipeline filter to only match items where the
+     * The `isNotEmpty()` method refines the aggregate pipeline filter to only match items where the
      * value of the specified field is not `null` or `undefined`.
      *
      * If the field contains any value at all for a given item, including the
      * empty string or an invalid value, that item will match the filter.
      * @public
      * @documentationMaturity preview
-     * @param field - Field in which to check for a value.
+     * @param field - Field to check for a value.
      * @requiredField field
      * @returns Refined filter.
      */
@@ -195,32 +166,25 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
     /**
      * Filters pipeline data to match items whose specified field does not exist or does not have any value.
      *
-     * The `isEmpty()` method refines this aggregate pipeline filter to only match items where the
-     * value of the specified field is `null` or `undefined` or the field does
-     * not exist.
+     * The `isEmpty()` method refines the aggregate pipeline filter to only match items where the value of the specified field is `null` or `undefined` or the field does not exist.
      *
-     * If the field contains any value at all for a given item, including the
-     * empty string or an invalid value, that item will match the filter.
+     * If the field contains any value at all for a given item, including an empty string or an invalid value, that item does not match the filter.
      * @public
      * @documentationMaturity preview
-     * @param field - Field in which to check for a value.
+     * @param field - Field to check for a value.
      * @requiredField field
-     * @returns An object representing the refined filter.
+     * @returns Refined filter.
      */
     isEmpty(field: string): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value starts with a specified string.
+     * Filters pipeline data to match items where the value of the specified field starts with a specified value.
      *
-     * The `startsWith()` method refines this aggregate pipeline filter to
-     * only match items where the value of the specified field starts with the
-     * defined `string`. Matching with `startsWith()` is not case sensitive, so `"TEXT"` starts
-     * with `"tex"`.
+     * The `startsWith()` method refines the filter to only match items where the value of the specified field starts with the specified value. Matching with `startsWith()` is not case sensitive, so `"TEXT"` is considered to start with `"tex"`.
      *
-     * You can only use `startsWith()` with a field whose value is a String or Reference.
-     * When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings.
+     * You can only use `startsWith()` with a [field of type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) string or reference. When matching a field of type reference, `startsWith()` matches by the ID of the referenced item as a string.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with the `value` parameter.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to look for at the beginning of the specified field value.
      * @requiredField value
@@ -228,18 +192,14 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     startsWith(field: string, value: string): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value ends with a specified string.
+     * Filters pipeline data to match items where the value of the specified field ends with a specified value.
      *
-     * The `endsWith()` method refines this aggregate pipeline filter to only
-     * match items where the value of the specified field ends with the specified
-     * `string`. Matching with `endsWith()` is not case sensitive, so `"TEXT"` ends
-     * with `"ext"`.
+     * The `endsWith()` method refines the filter to only match items where the value of the specified field ends with the specified value. Matching with `endsWith()` is not case sensitive, so `"TEXT"` is considered to end with `"ext"`.
      *
-     * You can only use `endsWith()` with a field whose value is a String or Reference.
-     * When using a Reference, `endsWith()` matches by the ID of the referenced item as Strings.
+     * You can only use `endsWith()` with a [field of type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) string or reference. When matching a field of type reference, `endsWith()` matches by the ID of the referenced item as a string.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with the string.
+     * @param field - Field whose value is compared with the specified value.
      * @requiredField field
      * @param value - Value to look for at the end of the specified field value.
      * @requiredField value
@@ -247,42 +207,35 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     endsWith(field: string, value: string): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value contains the specified value.
+     * Filters pipeline data to match items where the value of the specified field contains the specified value.
      *
      * The `contains()` method refines the aggregate pipeline filter to only match items for which the value of the specified field contains the specified value. `contains()` is not case-sensitive, so the value `sunday` is considered to contain the value `Sun`.
      *
-     * You can use `contains()` with a field whose type is a string or a reference. However, for fields whose type is reference, `contains()` matches by the ID of the referenced item as a string. Instead, use the [`eq()`](https://dev.wix.com/docs/sdk/backend-modules/data/wix-data-items-sdk-1-0-0/wix-data-filter/eq) method.
+     * You can use `contains()` with a [field of type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data) string or reference. For fields of type reference, `contains()` matches by the ID of the referenced item as a string. To match by other data types, use the [`eq()`](https://dev.wix.com/docs/sdk/backend-modules/data/wix-data-items-sdk-1-0-0/wix-data-filter/eq) method.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with the provided value.
+     * @param field - Field whose value is matched with the specified value.
      * @requiredField field
-     * @param value - Value to locate in the specified field value.
+     * @param value - Value to locate in the specified field.
      * @requiredField value
      * @returns Refined filter.
      */
     contains(field: string, value: string): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value equals any of the specified `values`
-     * parameters.
+     * Filters pipeline data to match items where the value of the specified field equals any of the specified values.
      *
-     * The `hasSome()` method refines this aggregate pipeline filter to
-     * only match items where the value of the specified field equals any of
-     * the specified values.
+     * The `hasSome()` method refines the filter to only match items where the value of the specified field contains any of the specified values.
      *
-     * Matching strings with `hasSome()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     * Matching strings with `hasSome()` is case sensitive, so `"text"` is not considered equal to `"Text"`.
      *
-     * If the value of the specified field is an array, `hasSome()` will match
-     * if any of the elements of that array match any of the specified values.
+     * If the value of the specified field is an array, `hasSome()` matches items where any of the array's elements match any of the specified values.
      *
-     * If the specified field contains multiple references, pass item IDs in the
-     * `value` field. In such a case, `hasSome()` will match if any of the
-     * multiple references match any of the specified ID values.
+     * If the specified field contains multiple references, specify their item IDs. In such a case, `hasSome()` matches if any of the references match any of the specified ID values.
      *
-     * You can specify a list of values to match by providing an array of
-     * String, Number, or Date types as the `value` parameters.
+     * You can specify a list of values to match by providing an array of strings, numbers, or dates.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `value`.
+     * @param field - Field whose value is compared with the specified values.
      * @requiredField field
      * @param values - Values to match.
      * @requiredField values
@@ -296,28 +249,22 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     hasSome(field: string, values: Comparable[]): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field values equals all of the specified `value`
-     * parameters.
+     * Filters pipeline data to match items where the values of the specified field equal all of the specified values.
      *
-     * The `hasAll()` method refines this aggregate pipeline filter to
-     * only match items where the value of the specified field equals all of
-     * the specified values.
+     * The `hasAll()` method refines the filter to only match items where the value of the specified field equals all of the specified values.
      *
-     * Matching strings with `hasAll()` is case sensitive, so `"text"` is not equal to `"Text"`.
+     * Matching strings with `hasAll()` is case sensitive, so `"text"` is not considered equal to `"Text"`.
      *
-     * If the value of the specified field is an array, `hasAll()` will match
-     * if there is a match in the elements of that array for all of the specified
-     * values.
+     * If the value of the specified field is an array, `hasAll()` matches items where all the elements of that array match all of the specified values.
      *
-     * You can specify a list of values to match by providing an array of
-     * String, Number, or Date types as the `value` parameters.
+     * You can specify a list of values to match by providing an array of strings, numbers, or dates.
      * @public
      * @documentationMaturity preview
-     * @param field - Field whose value is compared with `values`.
+     * @param field - Field whose value is compared with the specified values.
      * @requiredField field
      * @param values - Values to match.
      * @requiredField values
-     * @returns An object representing the refined filter.
+     * @returns Refined filter.
      */
     hasAll(field: string, ...values: Comparable[]): FilterStage;
     /**
@@ -397,9 +344,9 @@ export interface FilterStage extends PipelineStage, WithFilter<FilterStage> {
      */
     not(filter: FilterStage): FilterStage;
     /**
-     * Filters pipeline data to match items whose specified field value is within the defined range.
+     * Filters pipeline data to match items where the value of the specified field is within the defined range.
      *
-     * The `between()` method refines this aggregate pipeline filter to match items for which the value of the specified field is greater than or equal to `rangeStart` and less than `rangeEnd`. The method only compares values of [the same type](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-type).
+     * The `between()` method refines the filter to match items for which the value of the specified field is greater than or equal to `rangeStart` and less than `rangeEnd`. The method only compares values of [the same type](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data).
      *
      * The following types can be compared:
      * - Number: Compared numerically.

package/dist/types/api/stages/FilterStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FilterStage.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/FilterStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;AAExC;;;;;GAKG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC;IACzE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,WAAW,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,WAAW,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEtC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAErD;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEnD;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAE5D;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAEzD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAE3D;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAExD;;;;;;;;;;;;;;;OAeG;IACH,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IAErC;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAC/B,WAAW,CAAA;CACf;AAED,qBAAa,eACX,SAAQ,SAAS,CAAC,eAAe,CACjC,YAAW,WAAW;gBAEV,MAAM,CAAC,EAAE;QACnB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,aAAa,CAAC,EAAE,yBAAyB,CAAA;KAC1C;IAOD,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,eAAe;IAO5C,IAAI,gBAAgB,IAAI,MAAM,EAAE,CAE/B;IAED,eAAe;IACf,KAAK,IAAI,QAAQ,CAAC,KAAK;CAGxB"}
+{"version":3,"file":"FilterStage.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/FilterStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACxC,OAAO,EAAE,yBAAyB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;AAExC;;;;;GAKG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC;IACzE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAEnC;;;;;;;;;;;;;;;;;OAiBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,WAAW,CAAA;IAE1C;;;;;;;;;;;;;;;;;OAiBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,WAAW,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,CAAA;IAE7D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEtC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAErD;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEnD;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,WAAW,CAAA;IAEnD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAE5D;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAEzD;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAE3D;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,WAAW,CAAA;IAExD;;;;;;;;;;;;;;;OAeG;IACH,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IAErC;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAAA;IAErC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAC/B,WAAW,CAAA;CACf;AAED,qBAAa,eACX,SAAQ,SAAS,CAAC,eAAe,CACjC,YAAW,WAAW;gBAEV,MAAM,CAAC,EAAE;QACnB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,aAAa,CAAC,EAAE,yBAAyB,CAAA;KAC1C;IAOD,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,eAAe;IAO5C,IAAI,gBAAgB,IAAI,MAAM,EAAE,CAE/B;IAED,eAAe;IACf,KAAK,IAAI,QAAQ,CAAC,KAAK;CAGxB"}

package/dist/types/api/stages/GroupStage.d.ts

@@ -10,9 +10,9 @@ export interface GroupStage extends PipelineStage {
      *
      * The `by()` method configures the aggregation pipeline to group items for which the specified `expression` resolves to the same value. The `key` and resolved `expression` determine the result item's unique `_id` property.
      *
-     * > **Note**: When `by()` is not called or when called with no parameters, all items are placed in a single group.
+     * > **Note**: When `by()` is not called or when it is called with no parameters, all items are placed in a single group.
      *
-     * @param expression - Expression to determine the grouping value. Items with matching values are grouped together.
+     * @param expression - Expression to determine the grouping value. Items with matching values are grouped together. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
      * @param key - Name of the field in the result that contains the grouping value.
      * @returns GroupStage object.
      */
@@ -24,8 +24,8 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to calculate the group's total sum. Expression must resolve to a number.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to calculate the group's total sum. Expression must resolve to a number. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -38,8 +38,8 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to calculate the group's average value. The expression must resolve to a number.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to calculate the group's average value. The expression must resolve to a number. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -52,8 +52,8 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to find the group's minimum value. Expression must resolve to a comparable value, such as a number or string.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to find the group's minimum value. Expression must resolve to a comparable value, such as a number or string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -66,8 +66,8 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to find the group's maximum value. Expression must resolve to a comparable value, such as a number or string.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to find the group's maximum value. Expression must resolve to a comparable value, such as a number or string. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -80,7 +80,7 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -93,8 +93,8 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to find the first item in the group.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to find the first item in the group. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -107,8 +107,8 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to find the last item in the group.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to find the last item in the group. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns GroupStage object.
@@ -121,11 +121,10 @@ export interface GroupStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to collect items into an array.
-     * @param resultFieldName - Field key in the output item to store the result in.
+     * @param expression - Expression to collect items into an array. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to store the result in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
-  
      * @returns GroupStage object.
      */
     push(expression: Expression, resultFieldName: string): GroupStage;
@@ -143,7 +142,9 @@ export declare class GroupStageImpl implements GroupStage {
     last(expression: Expression, resultFieldName: string): GroupStage;
     push(expression: Expression, resultFieldName: string): GroupStage;
     private addAccumulator;
-    /** @private */
+    /**
+     * @internal
+     */
     build(): apiTypes.Stage;
 }
 //# sourceMappingURL=GroupStage.d.ts.map

package/dist/types/api/stages/GroupStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GroupStage.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/GroupStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C;;;;;;;;;;OAUG;IACH,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;IACnD;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAC1C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAClE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IACjE;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;CAClE;AAED,qBAAa,cAAe,YAAW,UAAU;IAC/C,OAAO,CAAC,GAAG,CAAW;IACtB,OAAO,CAAC,YAAY,CAAoB;IAExC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU;IAKnD,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,KAAK,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU;IAQ1C,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIlE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIjE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIjE,OAAO,CAAC,cAAc;IAStB,eAAe;IACf,KAAK,IAAI,QAAQ,CAAC,KAAK;CAgBxB"}
+{"version":3,"file":"GroupStage.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/GroupStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAyB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C;;;;;;;;;;OAUG;IACH,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;IACnD;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAChE;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAC1C;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IAClE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;IACjE;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU,CAAA;CAClE;AAED,qBAAa,cAAe,YAAW,UAAU;IAC/C,OAAO,CAAC,GAAG,CAAW;IACtB,OAAO,CAAC,YAAY,CAAoB;IAExC,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU;IAKnD,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIhE,KAAK,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU;IAQ1C,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIlE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIjE,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,UAAU;IAIjE,OAAO,CAAC,cAAc;IAStB;;OAEG;IACH,KAAK,IAAI,QAAQ,CAAC,KAAK;CAgBxB"}

package/dist/types/api/stages/ProjectStage.d.ts

@@ -16,7 +16,7 @@ export interface ProjectStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param fieldNames - Key of the field to include in the result. Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
+     * @param fieldNames - Fields to include in the result. Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns ProjectStage object.
@@ -29,20 +29,19 @@ export interface ProjectStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param fieldNames - Key of the field to exclude from the result. Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
+     * @param fieldNames - Fields to exclude from the result. Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns ProjectStage object.
      */
     exclude(...fieldNames: string[]): ProjectStage;
     /**
-     * Reshapes a new field based on the specified expression.
-     * The field used by the expression is not included in the result.
+     * Reshapes a new field based on the specified expression. The result does not include the field used in the expression. For example, reshaping `basePrice` to add `tax` results in a new field `totalPrice` that does not include `basePrice` or `tax`.
      *
      * @public
      * @documentationMaturity preview
-     * @param expression - Expression to resolve. The result of the expression becomes the value of the new field.
-     * @param resultFieldName - Key of the field to create in the result.
+     * @param expression - Expression to resolve. The result of the expression becomes the value of the new field. Learn more about using [expressions in aggregation pipelines](https://dev.wix.com/docs/sdk/backend-modules/data/items/wix-data-aggregate-pipeline-expressions/introduction).
+     * @param resultFieldName - Field to create in the result.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns ProjectStage object.
@@ -54,7 +53,7 @@ export interface ProjectStage extends PipelineStage {
      * @public
      * @documentationMaturity preview
      * @param stage - Projected stage to nest.
-     * @param resultFieldName - Key of the field in which to nest the projected stage.
+     * @param resultFieldName - Field to nest the projected stage in.
      *
      * Learn more about [field keys](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-id-velo-by-wix-only).
      * @returns ProjectStage object.

package/dist/types/api/stages/ProjectStage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ProjectStage.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/ProjectStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAA;IACxB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAC9C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAC9C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY,CAAA;IACtE;;;;;;;;;;OAUG;IACH,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY,CAAA;CAC1E;AAED,qBAAa,gBAAiB,YAAW,YAAY;IACnD,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAK;IAE7B,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY;IAO9C,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY;IAO9C,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY;IAKtE,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY;IAIzE,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,wBAAwB;IAQhC,eAAe;IACf,KAAK,IAAI,QAAQ,CAAC,KAAK;CAGxB"}
+{"version":3,"file":"ProjectStage.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/ProjectStage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AACtD,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAA;IACxB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAC9C;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY,CAAA;IAC9C;;;;;;;;;;OAUG;IACH,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY,CAAA;IACtE;;;;;;;;;;OAUG;IACH,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY,CAAA;CAC1E;AAED,qBAAa,gBAAiB,YAAW,YAAY;IACnD,MAAM,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAK;IAE7B,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY;IAO9C,OAAO,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE,GAAG,YAAY;IAO9C,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY;IAKtE,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,GAAG,YAAY;IAIzE,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,wBAAwB;IAQhC,eAAe;IACf,KAAK,IAAI,QAAQ,CAAC,KAAK;CAGxB"}

package/dist/types/api/stages/SortStage.d.ts

@@ -19,7 +19,7 @@ export interface SortStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param fields - Fields used in the sort.
+     * @param fields - Fields to sort by.
      * @returns SortStage object.
      */
     ascending(...fields: string[]): SortStage;
@@ -38,7 +38,7 @@ export interface SortStage extends PipelineStage {
      *
      * @public
      * @documentationMaturity preview
-     * @param fields - Fields used in the sort.
+     * @param fields - Fields to sort by.
      * @returns SortStage object.
      */
     descending(...fields: string[]): SortStage;