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

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

@@ -15,7 +15,7 @@ export interface WixDataAggregatePipelineStages {
     /**
      * Adds a filter stage to the aggregation pipeline.
      *
-     * The `filter()` method adds a pipeline stage that only processes items that match the specified criteria. You can configure the filter by chaining one or more [`filterStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/filter-stage/introduction) methods.
+     * The `filter()` method adds a pipeline stage that only processes items that match the specified criteria. You can configure the filter by chaining one or more [`FilterStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/filter-stage/introduction) methods.
      *
      * @public
      * @documentationMaturity preview
@@ -25,7 +25,7 @@ export interface WixDataAggregatePipelineStages {
     /**
      * Adds a project stage to the aggregation pipeline.
      *
-     * The `project()` method adds a pipeline stage that transforms items by including, excluding, or reshaping fields. You can configure the projection by chaining one or more [`projectStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/project-stage/introduction) methods.
+     * The `project()` method adds a pipeline stage that transforms items by including, excluding, or reshaping fields. You can configure the projection by chaining one or more [`ProjectStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/project-stage/introduction) methods.
      *
      * @public
      * @documentationMaturity preview
@@ -35,7 +35,7 @@ export interface WixDataAggregatePipelineStages {
     /**
      * Adds a group stage to the aggregation pipeline.
      *
-     * The `group()` method adds a pipeline stage that groups items by specified fields and calculates aggregate values. You can configure the grouping by chaining one or more [`groupStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/group-stage/introduction) methods.
+     * The `group()` method adds a pipeline stage that groups items by specified fields and calculates aggregate values. You can configure the grouping by chaining one or more [`GroupStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/group-stage/introduction) methods.
      *
      * @public
      * @documentationMaturity preview
@@ -49,7 +49,7 @@ export interface WixDataAggregatePipelineStages {
      *
      * @public
      * @documentationMaturity preview
-     * @param arrayFieldName - Key of the array field to unwind. Use dot notation to specify a nested array. For example, `user.products` or `product.colors`.
+     * @param arrayFieldName - Array field to unwind. Use dot notation to specify a nested array. For example, `user.products` or `product.colors`.
      *
      * 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 UnwindStage object.
@@ -58,7 +58,7 @@ export interface WixDataAggregatePipelineStages {
     /**
      * Adds a sort stage to the aggregation pipeline.
      *
-     * The `sort()` method adds a pipeline stage that sorts items by specified fields. You can configure the sorting by chaining one or more [`sortStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/sort-stage/introduction) methods.
+     * The `sort()` method adds a pipeline stage that sorts items by specified fields. You can configure the sorting by chaining one or more [`SortStage`](https://dev.wix.com/docs/sdk/backend-modules/data/items/sort-stage/introduction) methods.
      *
      * @public
      * @documentationMaturity preview
@@ -91,14 +91,22 @@ export interface WixDataAggregatePipelineStages {
     /**
      * Adds an objectToArray stage to the aggregation pipeline.
      *
-     * The `objectToArray()` method adds a pipeline stage that converts an object into an array. Each property becomes an array element containing its key and value, along with all other properties from the original object.
+     * The `objectToArray()` method adds a pipeline stage that converts an object into an array of objects with key-value pairs. Each property of the object becomes an element in the new array. Each element contains that property's key and value, as well as all other properties from the original object.
+     *
+     * For example, with a destination name of `variantInventory`, the object `{ "red": 10, "blue": 5, "green": 3 }` is transformed into the following array:
+     *
+     * `"variantInventory": [
+     *    { "k": "red", "v": 10 },
+     *    { "k": "blue", "v": 5 },
+     *    { "k": "green", "v": 3 }
+     * ]`.
      *
      * @public
      * @documentationMaturity preview
-     * @param objectFieldName - Key of the object field to convert to an array. Use dot notation to specify nested fields. For example, `user.name` or `product.price`.
+     * @param objectFieldName - Field to convert to an array. 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).
-     * @param destinationFieldName - Key of the new array to create in the result item.
+     * @param destinationFieldName - Field to create in the result item.
      *
      * 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 ObjectToArrayStage object.

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

@@ -1 +1 @@
-{"version":3,"file":"stages.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/stages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAoB,MAAM,gBAAgB,CAAA;AAC/D,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAA;AACzD,OAAO,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAiB,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAA;AACzD,OAAO,EAAE,SAAS,EAAiB,MAAM,aAAa,CAAA;AACtD,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EACL,kBAAkB,EAEnB,MAAM,sBAAsB,CAAA;AAE7B,eAAO,MAAM,MAAM,EAAE,8BAUpB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;;;;;OAQG;IACH,MAAM,IAAI,WAAW,CAAA;IAErB;;;;;;;;OAQG;IACH,OAAO,IAAI,YAAY,CAAA;IAEvB;;;;;;;;OAQG;IACH,KAAK,IAAI,UAAU,CAAA;IAEnB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,GAAG,WAAW,CAAA;IAE3C;;;;;;;;OAQG;IACH,IAAI,IAAI,SAAS,CAAA;IAEjB;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAA;IAEhC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9B;;;;;;;;;;;;;;OAcG;IACH,aAAa,CACX,eAAe,EAAE,MAAM,EACvB,oBAAoB,EAAE,MAAM,GAC3B,kBAAkB,CAAA;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAA;CACxB"}
+{"version":3,"file":"stages.d.ts","sourceRoot":"","sources":["../../../../src/api/stages/stages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAoB,MAAM,gBAAgB,CAAA;AAC/D,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAA;AACzD,OAAO,EAAE,WAAW,EAAmB,MAAM,eAAe,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAiB,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAA;AACzD,OAAO,EAAE,SAAS,EAAiB,MAAM,aAAa,CAAA;AACtD,OAAO,KAAK,QAAQ,MAAM,6BAA6B,CAAA;AACvD,OAAO,EACL,kBAAkB,EAEnB,MAAM,sBAAsB,CAAA;AAE7B,eAAO,MAAM,MAAM,EAAE,8BAUpB,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;;;;;OAQG;IACH,MAAM,IAAI,WAAW,CAAA;IAErB;;;;;;;;OAQG;IACH,OAAO,IAAI,YAAY,CAAA;IAEvB;;;;;;;;OAQG;IACH,KAAK,IAAI,UAAU,CAAA;IAEnB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,GAAG,WAAW,CAAA;IAE3C;;;;;;;;OAQG;IACH,IAAI,IAAI,SAAS,CAAA;IAEjB;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAA;IAEhC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa,CACX,eAAe,EAAE,MAAM,EACvB,oBAAoB,EAAE,MAAM,GAC3B,kBAAkB,CAAA;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAA;CACxB"}

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

@@ -31,7 +31,7 @@ export interface WixDataReadOptions extends WixDataOptions, WithAppOptions {
     language?: string;
     /**
      * When `true`, reads data from the primary database instance. This decreases performance but ensures data retrieved is
-     * up-to-date even immediately after an update. Learn more about [Wix Data and Eventual Consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency).
+     * up-to-date even immediately after an update. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency).
      */
     consistentRead?: boolean;
 }
@@ -50,7 +50,7 @@ export interface WixDataAggregateOptions extends WixDataQueryOptions {
 }
 export interface WixDataQueryOptions extends WixDataReadOptions {
     /**
-     * When `true`, the query result include a `totalCount` and `totalPages` properties containing the totals of items
+     * When `true`, the query results include a `totalCount` and `totalPages` properties containing the totals of items
      * matching query. Requesting total count slows down the query.
      *
      * Default: `false`

package/dist/types/filter/WithFilter.d.ts

@@ -20,8 +20,8 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * The `eq()` function refines this filter to only
      * match items where the value of the specified property 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.
+     * The method 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 number does not match the same number stored as a string.
      *
      * Matching strings with `eq()` is case sensitive, so `"text"` is not equal to `"Text"`.
      *
@@ -42,8 +42,8 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * The `ne()` function refines this filter to only
      * match items where the value of the specified property 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.
+     * The method 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 number is considered not equal to the same number stored as a string.
      *
      * Matching strings with `ne()` is case sensitive, so `"text"` is not equal to `"Text"`.
      *
@@ -66,8 +66,8 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * match items where the value of the specified property 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.
+     * The method 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 number does not match the same number stored as a string.
      *
      * If a property contains a number as a String, that value will be compared
      * alphabetically and not numerically. Items that do not have a value for the
@@ -100,8 +100,8 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * The `gt()` function refines this filter to only match
      * items where the value of the specified property 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.
+     * The method 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 number does not match the same number stored as a string.
      *
      * If a property contains a number as a String, that value will be compared
      * alphabetically and not numerically. Items that do not have a value for the
@@ -129,8 +129,8 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * items where the value of the specified property 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.
+     * The method 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 number does not match the same number stored as a string.
      *
      * If a property contains a number as a String, that value will be compared
      * alphabetically and not numerically. Items that do not have a value for the
@@ -163,8 +163,8 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * The `lt()` function refines this filter to only match
      * items where the value of the specified property 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.
+     * The method 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 number does not match the same number stored as a string.
      *
      * If a property contains a number as a String, that value will be compared
      * alphabetically and not numerically. Items that do not have a value for the
@@ -216,37 +216,29 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      */
     isEmpty(field: string): Self;
     /**
-     * Refines a query or filter to match items whose specified property value starts with a specified string.
+     * Refines a query or filter to match items where the value of the specified field starts with a specified value.
      *
-     * The `startsWith()` function refines this filter to
-     * only match items where the value of the specified property starts with the
-     * defined `string`. Matching with `startsWith()` is not case sensitive, so `"TEXT"` starts
-     * with `"tex"`.
+     * The `startsWith()` function refines this 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 property 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 - Property whose value will be compared with the `value` parameter.
+     * @param field - Field whose value will be compared with the specified value.
      * @requiredField field
-     * @param value - String to look for at the beginning of the specified property value.
+     * @param value - String to look for at the beginning of the specified field value.
      * @requiredField value
      * @returns `WixDataQuery` object representing the refined query.
      */
     startsWith(field: string, value: string): Self;
     /**
-     * Refines a query or filter to match items whose specified property value ends with a specified string.
+     * Refines a query or filter to match items where the value of the specified field ends with a specified value.
      *
-     * The `endsWith()` function refines this filter to only
-     * match items where the value of the specified property ends with the specified
-     * `string`. Matching with `endsWith()` is not case sensitive, so `"TEXT"` ends
-     * with `"ext"`.
+     * The `endsWith()` function refines this 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 property 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 - Property whose value will be compared with the string.
+     * @param field - Field whose value will be compared with the specified value.
      * @requiredField field
      * @param value - String to look for at the end of the specified property value.
      * @requiredField value
@@ -254,17 +246,11 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      */
     endsWith(field: string, value: string): Self;
     /**
-     * Refines a query or filter to match items whose specified property value contains a specified string.
+     * Refines a query or filter to match items whose specified property value contains a specified value.
      *
-     * The `contains()` function refines this filter to
-     * only match items where the value of the specified property contains the
-     * specified `string`. Matching with `contains()` is not case sensitive, so
-     * `"text"` does contain `"Tex"`.
+     * The `contains()` method refines the filter to only match items where the value of the specified property contains the specified value. Matching with `contains()` is not case sensitive, so `"text"` is considered to contain `"Tex"`.
      *
-     * You can use `contains()` with a property whose value is a String or a Reference.
-     * For properties of type reference it is recommended that you use the [`eq()`](#eq)
-     * function instead of `contains()`. With properties that are References, `contains()`
-     * matches by the ID of the referenced item as a String.
+     * 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.
      * @public
      * @documentationMaturity preview
      * @param field - The property whose value will be compared with the string.
@@ -442,11 +428,9 @@ export default interface WithFilter<Self extends WithFilter<Self>> {
      * The `between()` function refines this query to only match items where the value of the specified property is
      * greater than or equal to `rangeStart` and less than `rangeEnd`.
      *
-     * 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.
+     * The method 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 number does not match the same number stored as a string.
      *
-     * If a property contains a number as a String, that value will be compared alphabetically and not numerically. Items
-     * that do not have a value for the specified property are ranked lowest.
+     * If a property contains a number as a string, that value will be compared alphabetically and not numerically. Items that do not have a value for the specified property are ranked lowest.
      *
      * The following types of properties can be compared:
      * - Number: Compares numerically.

package/dist/types/filter/WithFilter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WithFilter.d.ts","sourceRoot":"","sources":["../../../src/filter/WithFilter.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;AAExC;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC,IAAI,SAAS,UAAU,CAAC,IAAI,CAAC;IAC/D;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAExC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;OAGG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;OAGG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;;;;;;;;;;;;;;;;OAiBG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAErD;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAElD;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAEhD;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAE7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAEpD;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAEjD;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAA;CAC/E"}
+{"version":3,"file":"WithFilter.d.ts","sourceRoot":"","sources":["../../../src/filter/WithFilter.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;AAExC;;;GAGG;AACH,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC,IAAI,SAAS,UAAU,CAAC,IAAI,CAAC;IAC/D;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAExC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;OAGG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;OAGG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IAE1C;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5B;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAErD;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAElD;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAEhD;;;OAGG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAE7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAEpD;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAEjD;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,CAAA;CAC/E"}

package/dist/types/types/data-item-types.d.ts

@@ -1945,7 +1945,7 @@ export interface Push {
 }
 export interface Include {
     /**
-     * Key of the field to include in the result.
+     * Field 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).
      * @maxLength 1000
@@ -1954,7 +1954,7 @@ export interface Include {
 }
 export interface Exclude {
     /**
-     * Key of the field to exclude from the result.
+     * Field 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).
      * @maxLength 1000
@@ -1963,7 +1963,7 @@ export interface Exclude {
 }
 export interface Reshape {
     /**
-     * Key of the field to create in the result item.
+     * Field to create in the result item.
      *
      * 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).
      * @maxLength 1000
@@ -2034,7 +2034,7 @@ export interface Accumulator extends AccumulatorExpressionOneOf {
     /** Collects values from all items in the group into an array. */
     push?: Push;
     /**
-     * Key of the field to create in the output item to contain the aggregation result.
+     * Field to create in the output item to contain the aggregation result.
      * @maxLength 1000
      */
     resultFieldName?: string;
@@ -2062,7 +2062,7 @@ export interface Stage extends StageStageOneOf {
     /**
      * Aggregation filter. Only collection items that match the filter are processed.
      *
-     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
      *
      * > **Note:** The values you provide for each filter field must adhere to that field's data type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
      */
@@ -2099,7 +2099,7 @@ export interface StageStageOneOf {
     /**
      * Aggregation filter. Only collection items that match the filter are processed.
      *
-     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+     * Learn more about [filters in API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
      *
      * > **Note:** The values you provide for each filter field must adhere to that field's data type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/wix-data-items-common",
-  "version": "1.0.236",
+  "version": "1.0.237",
   "license": "UNLICENSED",
   "author": {
     "name": "Rimvydas Gimbutas",
@@ -85,5 +85,5 @@
   "wallaby": {
     "autoDetect": true
   },
-  "falconPackageHash": "b2a04c9ac0a24b07008d5ec9d3118c30260172778ba48f9fb0077691"
+  "falconPackageHash": "5330829ce834e54252381de59f0d66e3e035a5f13fecae065f1d9952"
 }