@wix/wix-data-items-common 1.0.161 → 1.0.162
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":[],"sources":["../../../src/api/WixDataSearch.ts"],"sourcesContent":["import { WixDataResult } from './WixDataResult'\nimport { WixDataReadOptions } from './types'\nimport { WixDataFilter } from './WixDataFilter'\n\n/**\n * @builder\n * Represents a search operation to be performed on a Wix Data collection.\n * Allows for building complex search requests by specifying search expressions, modes, filters, sorting, and pagination.\n */\nexport interface WixDataSearch {\n /**\n * Specifies the text to search for in the collection.\n *\n * The `expression()` method sets the search query. Search terms are separated by whitespace.\n *\n * @param queryText - Text to search for across all fields in the collection.\n * @returns Current WixDataSearch object for method chaining.\n */\n expression(queryText: string): WixDataSearch\n\n /**\n * Enables fuzzy search for approximate text matching.\n *\n * The `fuzzy()` method enables fuzzy search, which allows for approximate matches of the search expression. When fuzzy search is enabled, the search will return results that closely match the search expression even if they don't exactly match.\n *\n * @returns The current WixDataSearch instance for method chaining.\n */\n fuzzy(): WixDataSearch\n\n /**\n * Sets the search mode to **AND** for expression terms.\n *\n * When in **AND** mode, all specified search term or filter conditions must be present for an item to be included in the results. For example, with expression \"red car\" in AND mode, only items that include both \"red\" and \"car\" are included in the results.\n *\n * @returns Current WixDataSearch object.\n */\n andMode(): WixDataSearch\n\n /**\n * Sets the search mode to **OR** for expression terms.\n *\n * When in **OR** mode, an item is included in the results if it contains any of the specified search terms in the expression.\n *\n * For example, with expression \"red car\" in **OR** mode, items that include either \"red\" or \"car\" (or both) are included in the results.\n *\n * @returns Current WixDataSearch object.\n */\n orMode(): WixDataSearch\n\n /**\n * Runs the search operation.\n *\n * The `run()` method searches the collection for the specified expression. It returns a Promise that resolves to a `WixDataResult` that contains the matching items and search metadata.\n *\n * Search operations are [eventually consistent](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency) and may not reflect recent changes.\n * @param options - Configuration options for building the search operation.\n * @returns A Promise that resolves to a WixDataResult containing the matching items and search metadata.\n */\n run(options?: WixDataReadOptions): Promise<WixDataResult>\n\n /**\n * Sorts search results by the specified fields in descending order.\n *\n * The `descending()` method refines the search to sort results in descending order of the specified fields.\n * If you specify more than one field, `descending()` sorts the results in descending order by each field in the order they are listed.\n *\n * You can sort the following types:\n * - **Number**: Sorts numerically.\n * - **Date**: Sorts by date and time.\n * - **String**: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\n * - **Reference**: Compares by the ID of the referenced item as a String.\n *\n * If a property contains a number as a String, that value is sorted alphabetically and not numerically.\n * Items that do not have a value for the specified sort property are ranked lowest.\n *\n * @public\n * @documentationMaturity preview\n * @param fields - Fields by which to sort results in descending order.\n * @requiredField fields\n * @returns The current WixDataSearch instance, refined with the specified sort order.\n */\n descending(...fields: string[]): WixDataSearch\n /**\n * @param fields - An array of fields to sort by in descending order.\n * @returns The current WixDataSearch instance, refined with the specified sort order.\n */\n descending(fields: string[]): WixDataSearch\n /**\n * @param fields - Fields used in the sort.\n * @returns The current WixDataSearch instance, refined with the specified sort order.\n */\n descending(...fields: any): WixDataSearch\n\n /**\n * Sorts search results by the specified fields in ascending order.\n *\n * The `ascending()` method refines the search to sort results in ascending order of the specified fields.\n * If you specify more than one field, `ascending()` sorts the results in ascending order by each field in the order they are listed.\n *\n * You can sort the following types:\n * - **Number**: Sorts numerically.\n * - **Date**: Sorts by date and time.\n * - **String**: Sorts lexicographically, so `\"abc\"` comes after `\"XYZ\"`.\n * - **Reference**: Compares by the ID of the referenced item as a String.\n *\n * If a property contains a number as a String, that value is sorted alphabetically and not numerically.\n * Items that do not have a value for the specified sort property are ranked lowest.\n *\n * @public\n * @documentationMaturity preview\n * @param fields - Fields by which to sort results in ascending order.\n * @requiredField fields\n * @returns The current WixDataSearch instance, refined with the specified sort order.\n */\n ascending(...fields: string[]): WixDataSearch\n /**\n * @param fields - An array of fields to sort by in ascending order.\n * @returns The current WixDataSearch instance, refined with the specified sort order.\n */\n ascending(fields: string[]): WixDataSearch\n /**\n * @param fields - Fields used in the sort.\n * @returns The current WixDataSearch instance, refined with the specified sort order.\n */\n ascending(...fields: any): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value equals the specified value.\n *\n * The `eq()` method refines the search to only match items where the value of the specified field equals the specified `value`. The method 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.\n *\n * Matching strings with `eq()` is case-sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the field contains an array, `eq()` matches the item if at least one array element equals the specified `value`.\n *\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to match.\n * @requiredField value\n * @returns Current WixDataSearch object, refined with the equality filter.\n */\n eq(field: string, value: any): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value does not equal the specified value.\n *\n * The `ne()` method refines this search to only\n * match items where the value of the specified property does not equal the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type is considered not equal to the same number stored as a Number type.\n *\n * Matching strings with `ne()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the value of the `field` property is an array, `ne()` includes items\n * in which none of the elements of the array match the specified `value`.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to not match.\n * @requiredField value\n * @returns The current WixDataSearch instance, refined with the inequality filter.\n */\n ne(field: string, value: any): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value is greater than or equal to the specified\n * value.\n *\n * The `ge()` method refines this search to only\n * match items where the value of the specified property is greater than or\n * equal to the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a property contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified property are ranked lowest.\n *\n * The following types of properties can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically,\n * so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\n * but `\"ABC\"` is not greater than or equal to `\"abc\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns The current WixDataSearch instance, refined with the 'greater than or equal' filter.\n */\n ge(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value is greater than the specified value.\n *\n * The `gt()` method refines this search to only match\n * items where the value of the specified property is greater than the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a property contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified property are ranked lowest.\n *\n * The following types of properties can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns The current WixDataSearch instance, refined with the 'greater than' filter.\n */\n gt(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value is less than or equal to the specified\n * value.\n *\n * The `le()` method refines this search to only match\n * items where the value of the specified property is less than or equal to the\n * specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a property contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified property are ranked lowest.\n *\n * The following types of properties can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically,\n * so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\n * but `\"abc\"` is not less than or equal to `\"ABC\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns The current WixDataSearch instance, refined with the 'less than or equal' filter.\n */\n le(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value is less than the specified value.\n *\n * The `lt()` method refines this search to only match\n * items where the value of the specified property is less than the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a property contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified property are ranked lowest.\n *\n * The following types of properties can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns The current WixDataSearch instance, refined with the 'less than' filter.\n */\n lt(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property has any value (is not null or undefined).\n *\n * The `isNotEmpty()` method refines this search to only match items where the\n * value of the specified property is not `null` or `undefined`.\n *\n * If the property contains any value at all for a given item, including the\n * empty string or an invalid value, that item will match the search filter.\n * @public\n * @documentationMaturity preview\n * @param field - Field in which to check for a non-empty value.\n * @requiredField field\n * @returns The current WixDataSearch instance, refined with the 'is not empty' filter.\n */\n isNotEmpty(field: string): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property does not exist or does not have any value (is null or undefined).\n *\n * The `isEmpty()` method refines this search to only match items where the\n * value of the specified property is `null` or `undefined` or the property does\n * not exist.\n *\n * If the property contains any value at all for a given item, including the\n * empty string or an invalid value, that item will not match the search filter.\n * @public\n * @documentationMaturity preview\n * @param field - Field in which to check for an empty or non-existent value.\n * @requiredField field\n * @returns The current WixDataSearch instance, refined with the 'is empty' filter.\n */\n isEmpty(field: string): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value starts with a specified string.\n *\n * The `startsWith()` method refines this search to\n * only match items where the value of the specified property starts with the\n * defined `string`. Matching with `startsWith()` is case-sensitive, so `\"TEXT\"` does not start\n * with `\"tex\"`.\n *\n * You can only use `startsWith()` with a property whose value is a String or Reference.\n * When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with the `value` parameter.\n * @requiredField field\n * @param value - String to look for at the beginning of the specified property value.\n * @requiredField value\n * @returns The current `WixDataSearch` instance, refined with the 'starts with' filter.\n */\n startsWith(field: string, value: string): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value equals any of the specified values.\n *\n * The `hasSome()` method refines the search to only match items where the value of the specified field equals any of the specified values.\n *\n * Matching strings with `hasSome()` is case-sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the specified field contains an array, `hasSome()` matches if any of the elements in that array match any of the specified values.\n *\n * If the specified field contains multiple references, pass item IDs as the values. `hasSome()` matches if any of the multiple references match any of the specified ID values.\n *\n * You can specify multiple values to match by providing an array of String, Number, or Date types as the `value` parameters.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param values - Values to match.\n * @requiredField values\n * @returns The current WixDataSearch instance, refined with the 'has some' filter.\n */\n hasSome(field: string, ...values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Overload for `hasSome()`. Refines a search to match items whose specified property value equals any of the specified values.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with the provided values.\n * @requiredField field\n * @param values - An array of values to match.\n * @requiredField values\n * @returns The current WixDataSearch instance, refined with the 'has some' filter.\n */\n hasSome(field: string, values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property values equals all of the specified `value`\n * parameters.\n *\n * The `hasAll()` method refines this search to\n * only match items where the value of the specified property equals all of\n * the specified values.\n *\n * Matching strings with `hasAll()` is case sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the value of the specified property is an array, `hasAll()` will match\n * if there is a match in the elements of that array for all of the specified\n * values.\n *\n * You can specify a list of values to match by providing an array of\n * String, Number, or Date types as the `value` parameters.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param values - Values to match. All specified values must be present.\n * @requiredField values\n * @returns The current WixDataSearch instance, refined with the 'has all' filter.\n */\n hasAll(field: string, ...values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Overload for `hasAll()`. Refines a search to match items whose specified property values equals all of the specified values.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with the provided values.\n * @requiredField field\n * @param values - An array of values to match. All values in the array must be present.\n * @requiredField values\n * @returns The current WixDataSearch instance, refined with the 'has all' filter.\n */\n hasAll(field: string, values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Adds an `or` condition to the search filter.\n *\n * The `or()` method adds an inclusive `or` condition to this search filter. The search returns all the items that match the filter as defined up to the `or()` method, the items that match the filter passed to the `or()` method, and the items that match both.\n *\n * > **Note**: The `or()` method is designed to work with 2 or more filters. Used on its own, it might produce unexpected results.\n * @public\n * @documentationMaturity preview\n * @param filter - Filter to add to the initial filter as an `or` condition.\n * @requiredField filter\n * @returns The current WixDataSearch instance, refined with the 'or' condition.\n */\n or(filter: WixDataFilter): WixDataSearch\n\n /**\n * Adds an `and` condition to the search filter.\n *\n * The `and()` method adds an `and` condition to the search filter. A search with an `and` returns all the items that match the filter as defined up to the `and()` method, as well as the filter passed to the `and()` method.\n *\n * When chaining multiple filter methods to a search, an `and` condition is often assumed by default. For example, this search returns results whose status is active **and** age is greater than 25:\n *\n * ```javascript\n * items.search(\"myCollection\").expression(\"some text\").eq(\"status\", \"active\").gt(\"age\", 25);\n * ```\n *\n * The `and()` method is needed when performing compound filters. For example, the final search in this set of operations returns results whose status is either pending or rejected **and** age is either less than 25 or greater than 65:\n *\n * ```javascript\n * let statusFilter = items.filter().eq(\"status\", \"pending\").or(items.filter().eq(\"status\", \"rejected\"));\n *\n * let ageFilter = items.filter().lt(\"age\", 25).or(items.filter().gt(\"age\", 65));\n *\n * let finalSearch = items.search(\"myCollection\").expression(\"some text\").and(statusFilter).and(ageFilter);\n * ```\n *\n * > **Note**: The `and()` method is designed to work with 2 or more filters.\n *\n * @public\n * @documentationMaturity preview\n * @param filter - Filter to add to the initial search filter as an `and` condition.\n * @requiredField filter\n * @returns The current WixDataSearch instance, refined with the 'and' condition.\n */\n and(filter: WixDataFilter): WixDataSearch\n\n /**\n * Adds a `not` condition to the search filter.\n *\n * The `not()` method adds a `not` condition to the search filter. A search with a `not` returns all the items that match the filter as defined up to the `not()` method and don't match the filter passed to the `not()` method.\n *\n * If the search filter only contains a `not()` method, it returns all the items that don't match the filter specified to the method.\n *\n * @public\n * @documentationMaturity preview\n * @param filter - Filter to add to the initial filter as a `not` condition.\n * @requiredField filter\n * @returns The current WixDataSearch instance, refined with the 'not' condition.\n */\n not(filter: WixDataFilter): WixDataSearch\n\n /**\n * Refines a search to match items whose specified property value is within a specified range.\n *\n * The `between()` method refines this search to only match items where the value of the specified property is\n * greater than or equal to `rangeStart` and less than `rangeEnd`.\n *\n * It only matches values of the same type. For example, a number value stored as a String type does not match the\n * same number stored as a Number type.\n *\n * If a property contains a number as a String, that value is compared alphabetically and not numerically. Items\n * that do not have a value for the specified property are ranked lowest.\n *\n * The following types of properties can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically, so\n * - `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\n * - `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with rangeStart and rangeEnd.\n * @requiredField field\n * @param rangeStart - Starting value of the range to match (inclusive).\n * @requiredField rangeStart\n * @param rangeEnd - Ending value of the range to match (exclusive).\n * @requiredField rangeEnd\n * @returns The current WixDataSearch instance, refined with the 'between' filter.\n */\n between(\n field: string,\n rangeStart: string | number | Date,\n rangeEnd: string | number | Date\n ): WixDataSearch\n\n /**\n * Lists the fields to return in a search's results.\n *\n * The `fields()` method specifies which fields to return in the search results.\n *\n * You can use `include()` in conjunction with `fields()` to get referenced items.\n *\n * When `fields()` receives an empty or invalid property, the search behaves as follows:\n * - When no fields are specified, the search returns all fields.\n * - When multiple fields are specified but some are invalid, invalid fields are ignored and valid fields are returned.\n * - When only invalid fields are specified, only the default `_id` field is returned.\n * @public\n * @documentationMaturity preview\n * @param fields - Properties to return.\n * @requiredField fields\n * @returns The current `WixDataSearch` instance, configured to return specified fields.\n */\n fields(...fields: string[]): WixDataSearch\n\n /**\n * Limits the number of items the search returns.\n *\n * The `limit()` method defines the number of results a search returns in each\n * page. Only one page of results is retrieved at a time. The `next()`\n * and `prev()` methods of the `WixDataResult` object are used to\n * navigate the pages of a search result.\n *\n * By default, `limit` is set to `100`.\n *\n * The maximum value that `limit()` can accept is `1000`.\n *\n * @public\n * @documentationMaturity preview\n * @param limitNumber - Number of items to return, which is also the `pageSize` of the results object.\n * @requiredField limitNumber\n * @returns The current `WixDataSearch` instance, refined with the specified limit.\n */\n limit(limitNumber: number): WixDataSearch\n\n /**\n * Sets the number of items to skip before returning search results.\n *\n * The `skip()` method defines the number of results to skip in the search\n * results before returning new search results.\n *\n * For example, if your search matches 50 items, but\n * you set `skip` to 10, the results returned will skip the first 10 items\n * that match and return the 11th through 50th items.\n *\n * By default, `skip` is set to 0.\n * @public\n * @documentationMaturity preview\n * @param skipCount - Number of items to skip in the search results before returning the results.\n * @requiredField skipCount\n * @returns The current `WixDataSearch` instance, refined with the specified skip count.\n */\n skip(skipCount: number): WixDataSearch\n\n /**\n * Includes referenced items for the specified properties in a search's results.\n *\n * The `include()` method refines a search so that the items returned in the\n * search's results include the full referenced items for the specified properties.\n *\n * For example, suppose you have a **books** collection with an **author**\n * field that references an **authors** collection. Searching the **books**\n * collection with an `include(\"author\")` returns the relevant book items\n * and each item will include the full referenced author item in the book's\n * `author` property.\n *\n * When searching a collection that contains a reference field without using the\n * `include()` method:\n * - Single reference field: returned items contain only the ID of the\n * referenced item, and not the full referenced items.\n * - Multiple reference field: returned items do not contain the multiple\n * reference field at all.\n *\n * When including a property with multiple references, the following limitations\n * apply:\n * - Only one property with multiple references can be included.\n * - The search will return an error if more than 50 items are returned, regardless\n * of any search limit set using the `limit()` method.\n * - Each returned item can include up to 50 referenced items. If there are more\n * than 50 referenced items, only 50 are returned when the search is run\n * and the `partialIncludes` property of the returned `WixDataResult` is `true`.\n *\n * > **Note:** The `include()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).\n *\n * @public\n * @documentationMaturity preview\n * @param fields - Fields for which to include referenced items.\n * @requiredField fields\n * @returns The current `WixDataSearch` instance, configured to include referenced items.\n */\n include(...fields: string[]): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified property in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field - Field for which to include referenced items.\n * @param limit - Optional limit for the number of referenced items to include (behavior may vary).\n * @returns The current `WixDataSearch` instance.\n */\n include(field: string, limit?: number): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified properties in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field for which to include referenced items.\n * @param field2 - Second field for which to include referenced items.\n * @param limit - Optional limit for the number of referenced items to include (behavior may vary).\n * @returns The current `WixDataSearch` instance.\n */\n include(field1: string, field2: string, limit?: number): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified properties in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field.\n * @param field2 - Second field.\n * @param field3 - Third field.\n * @param limit - Optional limit.\n * @returns The current `WixDataSearch` instance.\n */\n include(\n field1: string,\n field2: string,\n field3: string,\n limit?: number\n ): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified properties in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field.\n * @param field2 - Second field.\n * @param field3 - Third field.\n * @param field4 - Fourth field.\n * @param limit - Optional limit.\n * @returns The current `WixDataSearch` instance.\n */\n include(\n field1: string,\n field2: string,\n field3: string,\n field4: string,\n limit?: number\n ): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified properties in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field.\n * @param field2 - Second field.\n * @param field3 - Third field.\n * @param field4 - Fourth field.\n * @param field5 - Fifth field.\n * @param limit - Optional limit.\n * @returns The current `WixDataSearch` instance.\n */\n include(\n field1: string,\n field2: string,\n field3: string,\n field4: string,\n field5: string,\n limit?: number\n ): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified properties in a search's results.\n * Allows specifying multiple field names and an optional limit.\n * @public\n * @documentationMaturity preview\n * @param fieldNamesAndLimit - An array of field names, optionally followed by a limit number.\n * @returns The current `WixDataSearch` instance.\n */\n include(...fieldNamesAndLimit: [...string[], number]): WixDataSearch\n}\n"],"mappings":"","ignoreList":[]}
|
|
1
|
+
{"version":3,"names":[],"sources":["../../../src/api/WixDataSearch.ts"],"sourcesContent":["import { WixDataResult } from './WixDataResult'\nimport { WixDataReadOptions } from './types'\nimport { WixDataFilter } from './WixDataFilter'\n\n/**\n * @builder\n * Represents a search operation to be performed on a Wix Data collection.\n * Allows for building complex search requests by specifying search expressions, modes, filters, sorting, and pagination.\n */\nexport interface WixDataSearch {\n /**\n * Specifies the text to search for in the collection.\n *\n * The `expression()` method sets the search query. Search terms are separated by whitespace.\n *\n * @param queryText - Text to search for in the collection.\n * @returns Refined WixDataSearch object.\n */\n expression(queryText: string): WixDataSearch\n\n /**\n * Enables fuzzy search for approximate text matching.\n *\n * The `fuzzy()` method enables fuzzy search. This allows for approximate matches that closely resemble the search expression even if they don't match exactly.\n *\n * @returns Refined WixDataSearch object.\n */\n fuzzy(): WixDataSearch\n\n /**\n * Sets the search mode to **AND** for expression terms.\n *\n * When in **AND** mode, an item must include all specified search terms, and meet all filter conditions, to be included in the results. For example, the search expression \"red car\" in **AND** mode only retrieves items that include both \"red\" and \"car\".\n *\n * @returns Refined WixDataSearch object.\n */\n andMode(): WixDataSearch\n\n /**\n * Sets the search mode to **OR** for expression terms.\n *\n * When in **OR** mode, an item must include at least one of the specified search terms to be included in the results. For example, the search expression \"red car\" in **OR** mode retrieves items that include \"red\", \"car\", or both.\n *\n * @returns Refined WixDataSearch object.\n */\n orMode(): WixDataSearch\n\n /**\n * Runs the search operation.\n *\n * The `run()` method searches the collection for the specified expression. It returns a Promise that resolves to a `WixDataResult` that contains the matching items and search metadata.\n *\n * Search operations are [eventually consistent](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency) and may not reflect recent changes.\n * @param options - Configuration options for building the search operation.\n * @returns Promise that resolves to a WixDataResult containing the matching items and search metadata.\n */\n run(options?: WixDataReadOptions): Promise<WixDataResult>\n\n /**\n * Sorts search results by the specified fields in descending order.\n *\n * The `descending()` method refines the search to sort results in descending order of the specified fields.\n * If you specify more than one field, `descending()` sorts the results in descending order by each field in the order they are listed.\n *\n * You can sort the following types:\n * - **Number**: Sorts numerically.\n * - **Date**: Sorts by date and time.\n * - **String**: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\n * - **Reference**: Compares by the ID of the referenced item as a String.\n *\n * If a field contains a number as a String, that value is sorted alphabetically and not numerically.\n * Items that do not have a value for the specified sort field are ranked lowest.\n *\n * @public\n * @documentationMaturity preview\n * @param fields - Fields by which to sort results in descending order.\n * @requiredField fields\n * @returns Refined WixDataSearch object.\n */\n descending(...fields: string[]): WixDataSearch\n /**\n * @param fields - Array of fields to sort by in descending order.\n * @returns Refined WixDataSearch object.\n */\n descending(fields: string[]): WixDataSearch\n /**\n * @param fields - Fields used in the sort.\n * @returns Refined WixDataSearch object.\n */\n descending(...fields: any): WixDataSearch\n\n /**\n * Sorts search results by the specified fields in ascending order.\n *\n * The `ascending()` method refines the search to sort results in ascending order of the specified fields.\n * If you specify more than one field, `ascending()` sorts the results in ascending order by each field in the order they are listed.\n *\n * You can sort the following types:\n * - **Number**: Sorts numerically.\n * - **Date**: Sorts by date and time.\n * - **String**: Sorts lexicographically, so `\"abc\"` comes before `\"XYZ\"`.\n * - **Reference**: Compares by the ID of the referenced item as a String.\n *\n * If a field contains a number as a String, that value is sorted alphabetically and not numerically.\n * Items that do not have a value for the specified sort field are ranked lowest.\n *\n * @public\n * @documentationMaturity preview\n * @param fields - Fields by which to sort results in ascending order.\n * @requiredField fields\n * @returns Refined WixDataSearch object.\n */\n ascending(...fields: string[]): WixDataSearch\n /**\n * @param fields - Array of fields to sort by in ascending order.\n * @returns Refined WixDataSearch object.\n */\n ascending(fields: string[]): WixDataSearch\n /**\n * @param fields - Fields used in the sort.\n * @returns Refined WixDataSearch object.\n */\n ascending(...fields: any): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value equals the specified value.\n *\n * The `eq()` method refines the search 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.\n *\n * Matching strings with `eq()` is case-sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the field contains an array, `eq()` matches the item if at least one array element equals the specified `value`.\n *\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to match.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n eq(field: string, value: any): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value does not equal the specified value.\n *\n * The `ne()` method refines this search to only\n * match items where the value of the specified field does not equal the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type is considered not equal to the same number stored as a Number type.\n *\n * Matching strings with `ne()` is case-sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the value of `field` is an array, `ne()` includes items in which none of the elements of the array match the specified `value`.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to not match.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n ne(field: string, value: any): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value is greater than or equal to the specified\n * value.\n *\n * The `ge()` method refines this search to only\n * match items where the value of the specified field is greater than or\n * equal to the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a field contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified field are ranked lowest.\n *\n * The following types of fields can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically,\n * so `\"abc\"` is greater than or equal to `\"ABC\"` (because of the greater than),\n * but `\"ABC\"` is not greater than or equal to `\"abc\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n ge(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value is greater than the specified value.\n *\n * The `gt()` method refines this search to only match items where the value of the specified field is greater than the specified `value`.\n *\n * 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.\n *\n * 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.\n *\n * The following types of fields can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically, so `\"text\"` is greater than `\"Text\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n gt(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value is less than or equal to the specified\n * value.\n *\n * The `le()` method refines this search to only match\n * items where the value of the specified field is less than or equal to the\n * specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a field contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified field are ranked lowest.\n *\n * The following types of fields can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically,\n * so `\"ABC\"` is less than or equal to `\"abc\"` (because of the less than),\n * but `\"abc\"` is not less than or equal to `\"ABC\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n le(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value is less than the specified value.\n *\n * The `lt()` method refines this search to only match\n * items where the value of the specified field is less than the specified `value`.\n *\n * It only matches values of the same type. For example, a number value stored\n * as a String type does not match the same number stored as a Number type.\n *\n * If a field contains a number as a String, that value is compared\n * alphabetically and not numerically. Items that do not have a value for the\n * specified field are ranked lowest.\n *\n * The following types of fields can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically, so `\"Text\"` is less than `\"text\"`.\n * - Reference: Compares by the ID of the referenced item as a String.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `value`.\n * @requiredField field\n * @param value - Value to compare against.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n lt(field: string, value: string | number | Date): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field has any value (is not null or undefined).\n *\n * The `isNotEmpty()` method refines this search to only match items where the\n * value of the specified field is not `null` or `undefined`.\n *\n * If the field contains any value at all for a given item, including the\n * empty string or an invalid value, that item will match the search filter.\n * @public\n * @documentationMaturity preview\n * @param field - Field in which to check for a non-empty value.\n * @requiredField field\n * @returns Refined WixDataSearch object.\n */\n isNotEmpty(field: string): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field does not exist or does not have any value (is null or undefined).\n *\n * The `isEmpty()` method refines this search to only match items where the\n * value of the specified field is `null` or `undefined` or the field does\n * not exist.\n *\n * If the field contains any value at all for a given item, including the\n * empty string or an invalid value, that item will not match the search filter.\n * @public\n * @documentationMaturity preview\n * @param field - Field in which to check for an empty or non-existent value.\n * @requiredField field\n * @returns Refined WixDataSearch object.\n */\n isEmpty(field: string): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value starts with a specified string.\n *\n * The `startsWith()` method refines this search to only match items where the value of the specified field starts with the specified `string`. Matching with `startsWith()` is case-sensitive, so searching for `\"Sun\"` does not retrieve an item that contains the text `\"sunshine\"`.\n *\n * You can only use `startsWith()` with a field whose value is a String or Reference.\n * When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with the `value` parameter.\n * @requiredField field\n * @param value - String to look for at the beginning of the specified field value.\n * @requiredField value\n * @returns Refined WixDataSearch object.\n */\n startsWith(field: string, value: string): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value equals any of the specified values.\n *\n * The `hasSome()` method refines the search to only match items where the value of the specified field equals any of the specified values.\n *\n * Matching strings with `hasSome()` is case-sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the specified field contains an array, `hasSome()` matches if any of the elements in that array match any of the specified values.\n *\n * If the specified field contains multiple references, pass item IDs as the values. `hasSome()` matches if any of the multiple references match any of the specified ID values.\n *\n * You can specify multiple values to match by providing an array of String, Number, or Date types as the `values` parameters.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `values`.\n * @requiredField field\n * @param values - Values to match.\n * @requiredField values\n * @returns Refined WixDataSearch object.\n */\n hasSome(field: string, ...values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Overload for `hasSome()`. Refines a search to match items whose specified field value equals any of the specified values.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with the provided values.\n * @requiredField field\n * @param values - An array of values to match.\n * @requiredField values\n * @returns Refined WixDataSearch object.\n */\n hasSome(field: string, values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value equals all of the specified values.\n *\n * The `hasAll()` method refines this search to\n * only match items where the value of the specified field equals all of\n * the specified values.\n *\n * Matching strings with `hasAll()` is case-sensitive, so `\"text\"` is not equal to `\"Text\"`.\n *\n * If the value of the specified field is an array, `hasAll()` will match\n * if there is a match in the elements of that array for all of the specified\n * values.\n *\n * You can specify a list of values to match by providing an array of\n * String, Number, or Date types as the `values` parameters.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with `values`.\n * @requiredField field\n * @param values - Values to match. All specified values must be present.\n * @requiredField values\n * @returns Refined WixDataSearch object.\n */\n hasAll(field: string, ...values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Overload for `hasAll()`. Refines a search to match items whose specified field values equals all of the specified values.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with the provided values.\n * @requiredField field\n * @param values - Array of values to match. All values in the array must be present.\n * @requiredField values\n * @returns Refined WixDataSearch object.\n */\n hasAll(field: string, values: string[] | number[] | Date[]): WixDataSearch\n\n /**\n * Adds an `or` condition to the search filter.\n *\n * The `or()` method adds an inclusive `or` condition to this search filter. The search returns all the items that match the filter as defined up to the `or()` method, the items that match the filter passed to the `or()` method, and the items that match both.\n *\n * > **Note**: The `or()` method is designed to work with 2 or more filters. Used on its own, it might produce unexpected results.\n * @public\n * @documentationMaturity preview\n * @param filter - Filter to add to the initial filter as an `or` condition.\n * @requiredField filter\n * @returns Refined WixDataSearch object.\n */\n or(filter: WixDataFilter): WixDataSearch\n\n /**\n * Adds an `and` condition to the search filter.\n *\n * The `and()` method adds an `and` condition to the search filter. A search with an `and` returns all the items that match the filter as defined up to the `and()` method, as well as the filter passed to the `and()` method.\n *\n * When chaining multiple filter methods to a search, an `and` condition is often assumed by default. For example, this search returns results whose status is active **and** age is greater than 25:\n *\n * ```javascript\n * items.search(\"myCollection\").expression(\"some text\").eq(\"status\", \"active\").gt(\"age\", 25);\n * ```\n *\n * The `and()` method is needed when performing compound filters. For example, the final search in this set of operations returns results whose status is either pending or rejected **and** age is either less than 25 or greater than 65:\n *\n * ```javascript\n * let statusFilter = items.filter().eq(\"status\", \"pending\").or(items.filter().eq(\"status\", \"rejected\"));\n *\n * let ageFilter = items.filter().lt(\"age\", 25).or(items.filter().gt(\"age\", 65));\n *\n * let finalSearch = items.search(\"myCollection\").expression(\"some text\").and(statusFilter).and(ageFilter);\n * ```\n *\n * > **Note**: The `and()` method is designed to work with 2 or more filters.\n *\n * @public\n * @documentationMaturity preview\n * @param filter - Filter to add to the initial search filter as an `and` condition.\n * @requiredField filter\n * @returns Refined WixDataSearch object.\n */\n and(filter: WixDataFilter): WixDataSearch\n\n /**\n * Adds a `not` condition to the search filter.\n *\n * The `not()` method adds a `not` condition to the search filter. A search with a `not` returns all the items that match the filter as defined up to the `not()` method and don't match the filter passed to the `not()` method.\n *\n * If the search filter only contains a `not()` method, it returns all the items that don't match the filter specified to the method.\n *\n * @public\n * @documentationMaturity preview\n * @param filter - Filter to add to the initial filter as a `not` condition.\n * @requiredField filter\n * @returns Refined WixDataSearch object.\n */\n not(filter: WixDataFilter): WixDataSearch\n\n /**\n * Refines a search to match items whose specified field value is within a specified range.\n *\n * The `between()` method refines this search to only match items where the value of the specified field is\n * greater than or equal to `rangeStart` and less than `rangeEnd`.\n *\n * It only matches values of the same type. For example, a number value stored as a String type does not match the\n * same number stored as a Number type.\n *\n * If a field contains a number as a String, that value is compared alphabetically and not numerically. Items\n * that do not have a value for the specified field are ranked lowest.\n *\n * The following types of fields can be compared:\n * - Number: Compares numerically.\n * - Date: Compares JavaScript Date objects.\n * - String: Compares lexicographically, so\n * - `\"A\"` and `\"M\"` are between `\"A\"` and `\"Z\"`, but `\"a\"`, `\"m\"`, `\"z\"` and `\"Z\"` are not.\n * - `\"A\"`, `\"M\"`, `\"Z\"`, and `\"a\"` are between `\"A\"` and `\"z\"`, but `\"z\"` is not.\n * @public\n * @documentationMaturity preview\n * @param field - Field whose value is compared with rangeStart and rangeEnd.\n * @requiredField field\n * @param rangeStart - Starting value of the range to match (inclusive).\n * @requiredField rangeStart\n * @param rangeEnd - Ending value of the range to match (exclusive).\n * @requiredField rangeEnd\n * @returns Refined WixDataSearch object.\n */\n between(\n field: string,\n rangeStart: string | number | Date,\n rangeEnd: string | number | Date\n ): WixDataSearch\n\n /**\n * Lists the fields to return in a search's results.\n *\n * The `fields()` method specifies which fields to return in the search results.\n *\n * You can use `include()` in conjunction with `fields()` to get referenced items.\n *\n * When `fields()` receives an empty or invalid field, the search behaves as follows:\n * - When no fields are specified, the search returns all fields.\n * - When multiple fields are specified but some are invalid, invalid fields are ignored and valid fields are returned.\n * - When only invalid fields are specified, only the default `_id` field is returned.\n * @public\n * @documentationMaturity preview\n * @param fields - Fields to return.\n * @requiredField fields\n * @returns Refined WixDataSearch object.\n */\n fields(...fields: string[]): WixDataSearch\n\n /**\n * Limits the number of items the search returns.\n *\n * The `limit()` method defines the number of results a search returns in each\n * page. Only one page of results is retrieved at a time. The `next()`\n * and `prev()` methods of the `WixDataResult` object are used to\n * navigate the pages of a search result.\n *\n * By default, `limit` is set to `100`.\n *\n * The maximum value that `limit()` can accept is `1000`.\n *\n * @public\n * @documentationMaturity preview\n * @param limitNumber - Number of items to return, which is also the `pageSize` of the results object.\n * @requiredField limitNumber\n * @returns Refined WixDataSearch object.\n */\n limit(limitNumber: number): WixDataSearch\n\n /**\n * Sets the number of items to skip before returning search results.\n *\n * The `skip()` method defines the number of results to skip in the search\n * results before returning new search results.\n *\n * For example, if your search matches 50 items, but\n * you set `skip` to 10, the results returned will skip the first 10 items\n * that match and return the 11th through 50th items.\n *\n * By default, `skip` is set to 0.\n * @public\n * @documentationMaturity preview\n * @param skipCount - Number of items to skip in the search results before returning the results.\n * @requiredField skipCount\n * @returns Refined WixDataSearch object.\n */\n skip(skipCount: number): WixDataSearch\n\n /**\n * Includes referenced items for the specified fields in a search's results.\n *\n * The `include()` method refines a search so that the items returned in the\n * search's results include the full referenced items for the specified fields.\n *\n * For example, suppose you have a **books** collection with an **author** field that references an **authors** collection. Searching the **books** collection with an `include(\"author\")` returns the relevant book items and each item will include the full referenced author item in the book's `author` field.\n *\n * When searching a collection that contains a reference field without using the\n * `include()` method:\n * - Single reference field: returned items contain only the ID of the\n * referenced item, and not the full referenced items.\n * - Multiple reference field: returned items do not contain the multiple\n * reference field at all.\n *\n * When including a field with multiple references, the following limitations\n * apply:\n * - Only one field with multiple references can be included.\n * - The search will return an error if more than 50 items are returned, regardless\n * of any search limit set using the `limit()` method.\n * - Each returned item can include up to 50 referenced items. If there are more\n * than 50 referenced items, only 50 are returned when the search is run\n * and the `partialIncludes` field of the returned `WixDataResult` is `true`.\n *\n * > **Note:** The `include()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).\n *\n * @public\n * @documentationMaturity preview\n * @param fields - Fields for which to include referenced items.\n * @requiredField fields\n * @returns Refined WixDataSearch object.\n */\n include(...fields: string[]): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified field in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field - Field for which to include referenced items.\n * @param limit - Optional limit for the number of referenced items to include (behavior may vary).\n * @returns Refined WixDataSearch object.\n */\n include(field: string, limit?: number): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified fields in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field for which to include referenced items.\n * @param field2 - Second field for which to include referenced items.\n * @param limit - Optional limit for the number of referenced items to include (behavior may vary).\n * @returns Refined WixDataSearch object.\n */\n include(field1: string, field2: string, limit?: number): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified fields in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field.\n * @param field2 - Second field.\n * @param field3 - Third field.\n * @param limit - Optional limit.\n * @returns Refined WixDataSearch object.\n */\n include(\n field1: string,\n field2: string,\n field3: string,\n limit?: number\n ): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified fields in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field.\n * @param field2 - Second field.\n * @param field3 - Third field.\n * @param field4 - Fourth field.\n * @param limit - Optional limit.\n * @returns Refined WixDataSearch object.\n */\n include(\n field1: string,\n field2: string,\n field3: string,\n field4: string,\n limit?: number\n ): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified fields in a search's results.\n * @public\n * @documentationMaturity preview\n * @param field1 - First field.\n * @param field2 - Second field.\n * @param field3 - Third field.\n * @param field4 - Fourth field.\n * @param field5 - Fifth field.\n * @param limit - Optional limit.\n * @returns Refined WixDataSearch object.\n */\n include(\n field1: string,\n field2: string,\n field3: string,\n field4: string,\n field5: string,\n limit?: number\n ): WixDataSearch\n\n /**\n * Overload for `include()`. Includes referenced items for the specified fields in a search's results.\n * Allows specifying multiple field names and an optional limit.\n * @public\n * @documentationMaturity preview\n * @param fieldNamesAndLimit - Array of field names, optionally followed by a limit number.\n * @returns Refined WixDataSearch object.\n */\n include(...fieldNamesAndLimit: [...string[], number]): WixDataSearch\n}\n"],"mappings":"","ignoreList":[]}
|
|
@@ -12,34 +12,32 @@ export interface WixDataSearch {
|
|
|
12
12
|
*
|
|
13
13
|
* The `expression()` method sets the search query. Search terms are separated by whitespace.
|
|
14
14
|
*
|
|
15
|
-
* @param queryText - Text to search for
|
|
16
|
-
* @returns
|
|
15
|
+
* @param queryText - Text to search for in the collection.
|
|
16
|
+
* @returns Refined WixDataSearch object.
|
|
17
17
|
*/
|
|
18
18
|
expression(queryText: string): WixDataSearch;
|
|
19
19
|
/**
|
|
20
20
|
* Enables fuzzy search for approximate text matching.
|
|
21
21
|
*
|
|
22
|
-
* The `fuzzy()` method enables fuzzy search
|
|
22
|
+
* The `fuzzy()` method enables fuzzy search. This allows for approximate matches that closely resemble the search expression even if they don't match exactly.
|
|
23
23
|
*
|
|
24
|
-
* @returns
|
|
24
|
+
* @returns Refined WixDataSearch object.
|
|
25
25
|
*/
|
|
26
26
|
fuzzy(): WixDataSearch;
|
|
27
27
|
/**
|
|
28
28
|
* Sets the search mode to **AND** for expression terms.
|
|
29
29
|
*
|
|
30
|
-
* When in **AND** mode,
|
|
30
|
+
* When in **AND** mode, an item must include all specified search terms, and meet all filter conditions, to be included in the results. For example, the search expression "red car" in **AND** mode only retrieves items that include both "red" and "car".
|
|
31
31
|
*
|
|
32
|
-
* @returns
|
|
32
|
+
* @returns Refined WixDataSearch object.
|
|
33
33
|
*/
|
|
34
34
|
andMode(): WixDataSearch;
|
|
35
35
|
/**
|
|
36
36
|
* Sets the search mode to **OR** for expression terms.
|
|
37
37
|
*
|
|
38
|
-
* When in **OR** mode, an item
|
|
38
|
+
* When in **OR** mode, an item must include at least one of the specified search terms to be included in the results. For example, the search expression "red car" in **OR** mode retrieves items that include "red", "car", or both.
|
|
39
39
|
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* @returns Current WixDataSearch object.
|
|
40
|
+
* @returns Refined WixDataSearch object.
|
|
43
41
|
*/
|
|
44
42
|
orMode(): WixDataSearch;
|
|
45
43
|
/**
|
|
@@ -49,7 +47,7 @@ export interface WixDataSearch {
|
|
|
49
47
|
*
|
|
50
48
|
* Search operations are [eventually consistent](https://dev.wix.com/docs/sdk/backend-modules/data/eventual-consistency) and may not reflect recent changes.
|
|
51
49
|
* @param options - Configuration options for building the search operation.
|
|
52
|
-
* @returns
|
|
50
|
+
* @returns Promise that resolves to a WixDataResult containing the matching items and search metadata.
|
|
53
51
|
*/
|
|
54
52
|
run(options?: WixDataReadOptions): Promise<WixDataResult>;
|
|
55
53
|
/**
|
|
@@ -64,24 +62,24 @@ export interface WixDataSearch {
|
|
|
64
62
|
* - **String**: Sorts lexicographically, so `"abc"` comes before `"XYZ"`.
|
|
65
63
|
* - **Reference**: Compares by the ID of the referenced item as a String.
|
|
66
64
|
*
|
|
67
|
-
* If a
|
|
68
|
-
* Items that do not have a value for the specified sort
|
|
65
|
+
* If a field contains a number as a String, that value is sorted alphabetically and not numerically.
|
|
66
|
+
* Items that do not have a value for the specified sort field are ranked lowest.
|
|
69
67
|
*
|
|
70
68
|
* @public
|
|
71
69
|
* @documentationMaturity preview
|
|
72
70
|
* @param fields - Fields by which to sort results in descending order.
|
|
73
71
|
* @requiredField fields
|
|
74
|
-
* @returns
|
|
72
|
+
* @returns Refined WixDataSearch object.
|
|
75
73
|
*/
|
|
76
74
|
descending(...fields: string[]): WixDataSearch;
|
|
77
75
|
/**
|
|
78
|
-
* @param fields -
|
|
79
|
-
* @returns
|
|
76
|
+
* @param fields - Array of fields to sort by in descending order.
|
|
77
|
+
* @returns Refined WixDataSearch object.
|
|
80
78
|
*/
|
|
81
79
|
descending(fields: string[]): WixDataSearch;
|
|
82
80
|
/**
|
|
83
81
|
* @param fields - Fields used in the sort.
|
|
84
|
-
* @returns
|
|
82
|
+
* @returns Refined WixDataSearch object.
|
|
85
83
|
*/
|
|
86
84
|
descending(...fields: any): WixDataSearch;
|
|
87
85
|
/**
|
|
@@ -93,33 +91,33 @@ export interface WixDataSearch {
|
|
|
93
91
|
* You can sort the following types:
|
|
94
92
|
* - **Number**: Sorts numerically.
|
|
95
93
|
* - **Date**: Sorts by date and time.
|
|
96
|
-
* - **String**: Sorts lexicographically, so `"abc"` comes
|
|
94
|
+
* - **String**: Sorts lexicographically, so `"abc"` comes before `"XYZ"`.
|
|
97
95
|
* - **Reference**: Compares by the ID of the referenced item as a String.
|
|
98
96
|
*
|
|
99
|
-
* If a
|
|
100
|
-
* Items that do not have a value for the specified sort
|
|
97
|
+
* If a field contains a number as a String, that value is sorted alphabetically and not numerically.
|
|
98
|
+
* Items that do not have a value for the specified sort field are ranked lowest.
|
|
101
99
|
*
|
|
102
100
|
* @public
|
|
103
101
|
* @documentationMaturity preview
|
|
104
102
|
* @param fields - Fields by which to sort results in ascending order.
|
|
105
103
|
* @requiredField fields
|
|
106
|
-
* @returns
|
|
104
|
+
* @returns Refined WixDataSearch object.
|
|
107
105
|
*/
|
|
108
106
|
ascending(...fields: string[]): WixDataSearch;
|
|
109
107
|
/**
|
|
110
|
-
* @param fields -
|
|
111
|
-
* @returns
|
|
108
|
+
* @param fields - Array of fields to sort by in ascending order.
|
|
109
|
+
* @returns Refined WixDataSearch object.
|
|
112
110
|
*/
|
|
113
111
|
ascending(fields: string[]): WixDataSearch;
|
|
114
112
|
/**
|
|
115
113
|
* @param fields - Fields used in the sort.
|
|
116
|
-
* @returns
|
|
114
|
+
* @returns Refined WixDataSearch object.
|
|
117
115
|
*/
|
|
118
116
|
ascending(...fields: any): WixDataSearch;
|
|
119
117
|
/**
|
|
120
118
|
* Refines a search to match items whose specified field value equals the specified value.
|
|
121
119
|
*
|
|
122
|
-
* The `eq()` method refines the search to only match items where the value of the specified field equals the specified `value`.
|
|
120
|
+
* The `eq()` method refines the search 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.
|
|
123
121
|
*
|
|
124
122
|
* Matching strings with `eq()` is case-sensitive, so `"text"` is not equal to `"Text"`.
|
|
125
123
|
*
|
|
@@ -131,47 +129,46 @@ export interface WixDataSearch {
|
|
|
131
129
|
* @requiredField field
|
|
132
130
|
* @param value - Value to match.
|
|
133
131
|
* @requiredField value
|
|
134
|
-
* @returns
|
|
132
|
+
* @returns Refined WixDataSearch object.
|
|
135
133
|
*/
|
|
136
134
|
eq(field: string, value: any): WixDataSearch;
|
|
137
135
|
/**
|
|
138
|
-
* Refines a search to match items whose specified
|
|
136
|
+
* Refines a search to match items whose specified field value does not equal the specified value.
|
|
139
137
|
*
|
|
140
138
|
* The `ne()` method refines this search to only
|
|
141
|
-
* match items where the value of the specified
|
|
139
|
+
* match items where the value of the specified field does not equal the specified `value`.
|
|
142
140
|
*
|
|
143
141
|
* It only matches values of the same type. For example, a number value stored
|
|
144
142
|
* as a String type is considered not equal to the same number stored as a Number type.
|
|
145
143
|
*
|
|
146
|
-
* Matching strings with `ne()` is case
|
|
144
|
+
* Matching strings with `ne()` is case-sensitive, so `"text"` is not equal to `"Text"`.
|
|
147
145
|
*
|
|
148
|
-
* If the value of
|
|
149
|
-
* in which none of the elements of the array match the specified `value`.
|
|
146
|
+
* If the value of `field` is an array, `ne()` includes items in which none of the elements of the array match the specified `value`.
|
|
150
147
|
* @public
|
|
151
148
|
* @documentationMaturity preview
|
|
152
149
|
* @param field - Field whose value is compared with `value`.
|
|
153
150
|
* @requiredField field
|
|
154
151
|
* @param value - Value to not match.
|
|
155
152
|
* @requiredField value
|
|
156
|
-
* @returns
|
|
153
|
+
* @returns Refined WixDataSearch object.
|
|
157
154
|
*/
|
|
158
155
|
ne(field: string, value: any): WixDataSearch;
|
|
159
156
|
/**
|
|
160
|
-
* Refines a search to match items whose specified
|
|
157
|
+
* Refines a search to match items whose specified field value is greater than or equal to the specified
|
|
161
158
|
* value.
|
|
162
159
|
*
|
|
163
160
|
* The `ge()` method refines this search to only
|
|
164
|
-
* match items where the value of the specified
|
|
161
|
+
* match items where the value of the specified field is greater than or
|
|
165
162
|
* equal to the specified `value`.
|
|
166
163
|
*
|
|
167
164
|
* It only matches values of the same type. For example, a number value stored
|
|
168
165
|
* as a String type does not match the same number stored as a Number type.
|
|
169
166
|
*
|
|
170
|
-
* If a
|
|
167
|
+
* If a field contains a number as a String, that value is compared
|
|
171
168
|
* alphabetically and not numerically. Items that do not have a value for the
|
|
172
|
-
* specified
|
|
169
|
+
* specified field are ranked lowest.
|
|
173
170
|
*
|
|
174
|
-
* The following types of
|
|
171
|
+
* The following types of fields can be compared:
|
|
175
172
|
* - Number: Compares numerically.
|
|
176
173
|
* - Date: Compares JavaScript Date objects.
|
|
177
174
|
* - String: Compares lexicographically,
|
|
@@ -184,52 +181,48 @@ export interface WixDataSearch {
|
|
|
184
181
|
* @requiredField field
|
|
185
182
|
* @param value - Value to compare against.
|
|
186
183
|
* @requiredField value
|
|
187
|
-
* @returns
|
|
184
|
+
* @returns Refined WixDataSearch object.
|
|
188
185
|
*/
|
|
189
186
|
ge(field: string, value: string | number | Date): WixDataSearch;
|
|
190
187
|
/**
|
|
191
|
-
* Refines a search to match items whose specified
|
|
188
|
+
* Refines a search to match items whose specified field value is greater than the specified value.
|
|
192
189
|
*
|
|
193
|
-
* The `gt()` method refines this search to only match
|
|
194
|
-
* items where the value of the specified property is greater than the specified `value`.
|
|
190
|
+
* The `gt()` method refines this search to only match items where the value of the specified field is greater than the specified `value`.
|
|
195
191
|
*
|
|
196
|
-
* It only matches values of the same type. For example, a number value stored
|
|
197
|
-
* as a String type does not match the same number stored as a Number type.
|
|
192
|
+
* 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.
|
|
198
193
|
*
|
|
199
|
-
* If a
|
|
200
|
-
* alphabetically and not numerically. Items that do not have a value for the
|
|
201
|
-
* specified property are ranked lowest.
|
|
194
|
+
* 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.
|
|
202
195
|
*
|
|
203
|
-
* The following types of
|
|
196
|
+
* The following types of fields can be compared:
|
|
204
197
|
* - Number: Compares numerically.
|
|
205
198
|
* - Date: Compares JavaScript Date objects.
|
|
206
199
|
* - String: Compares lexicographically, so `"text"` is greater than `"Text"`.
|
|
207
200
|
* - Reference: Compares by the ID of the referenced item as a String.
|
|
208
201
|
* @public
|
|
209
202
|
* @documentationMaturity preview
|
|
210
|
-
* @param field -
|
|
203
|
+
* @param field - field whose value is compared with `value`.
|
|
211
204
|
* @requiredField field
|
|
212
205
|
* @param value - Value to compare against.
|
|
213
206
|
* @requiredField value
|
|
214
|
-
* @returns
|
|
207
|
+
* @returns Refined WixDataSearch object.
|
|
215
208
|
*/
|
|
216
209
|
gt(field: string, value: string | number | Date): WixDataSearch;
|
|
217
210
|
/**
|
|
218
|
-
* Refines a search to match items whose specified
|
|
211
|
+
* Refines a search to match items whose specified field value is less than or equal to the specified
|
|
219
212
|
* value.
|
|
220
213
|
*
|
|
221
214
|
* The `le()` method refines this search to only match
|
|
222
|
-
* items where the value of the specified
|
|
215
|
+
* items where the value of the specified field is less than or equal to the
|
|
223
216
|
* specified `value`.
|
|
224
217
|
*
|
|
225
218
|
* It only matches values of the same type. For example, a number value stored
|
|
226
219
|
* as a String type does not match the same number stored as a Number type.
|
|
227
220
|
*
|
|
228
|
-
* If a
|
|
221
|
+
* If a field contains a number as a String, that value is compared
|
|
229
222
|
* alphabetically and not numerically. Items that do not have a value for the
|
|
230
|
-
* specified
|
|
223
|
+
* specified field are ranked lowest.
|
|
231
224
|
*
|
|
232
|
-
* The following types of
|
|
225
|
+
* The following types of fields can be compared:
|
|
233
226
|
* - Number: Compares numerically.
|
|
234
227
|
* - Date: Compares JavaScript Date objects.
|
|
235
228
|
* - String: Compares lexicographically,
|
|
@@ -242,23 +235,23 @@ export interface WixDataSearch {
|
|
|
242
235
|
* @requiredField field
|
|
243
236
|
* @param value - Value to compare against.
|
|
244
237
|
* @requiredField value
|
|
245
|
-
* @returns
|
|
238
|
+
* @returns Refined WixDataSearch object.
|
|
246
239
|
*/
|
|
247
240
|
le(field: string, value: string | number | Date): WixDataSearch;
|
|
248
241
|
/**
|
|
249
|
-
* Refines a search to match items whose specified
|
|
242
|
+
* Refines a search to match items whose specified field value is less than the specified value.
|
|
250
243
|
*
|
|
251
244
|
* The `lt()` method refines this search to only match
|
|
252
|
-
* items where the value of the specified
|
|
245
|
+
* items where the value of the specified field is less than the specified `value`.
|
|
253
246
|
*
|
|
254
247
|
* It only matches values of the same type. For example, a number value stored
|
|
255
248
|
* as a String type does not match the same number stored as a Number type.
|
|
256
249
|
*
|
|
257
|
-
* If a
|
|
250
|
+
* If a field contains a number as a String, that value is compared
|
|
258
251
|
* alphabetically and not numerically. Items that do not have a value for the
|
|
259
|
-
* specified
|
|
252
|
+
* specified field are ranked lowest.
|
|
260
253
|
*
|
|
261
|
-
* The following types of
|
|
254
|
+
* The following types of fields can be compared:
|
|
262
255
|
* - Number: Compares numerically.
|
|
263
256
|
* - Date: Compares JavaScript Date objects.
|
|
264
257
|
* - String: Compares lexicographically, so `"Text"` is less than `"text"`.
|
|
@@ -269,57 +262,54 @@ export interface WixDataSearch {
|
|
|
269
262
|
* @requiredField field
|
|
270
263
|
* @param value - Value to compare against.
|
|
271
264
|
* @requiredField value
|
|
272
|
-
* @returns
|
|
265
|
+
* @returns Refined WixDataSearch object.
|
|
273
266
|
*/
|
|
274
267
|
lt(field: string, value: string | number | Date): WixDataSearch;
|
|
275
268
|
/**
|
|
276
|
-
* Refines a search to match items whose specified
|
|
269
|
+
* Refines a search to match items whose specified field has any value (is not null or undefined).
|
|
277
270
|
*
|
|
278
271
|
* The `isNotEmpty()` method refines this search to only match items where the
|
|
279
|
-
* value of the specified
|
|
272
|
+
* value of the specified field is not `null` or `undefined`.
|
|
280
273
|
*
|
|
281
|
-
* If the
|
|
274
|
+
* If the field contains any value at all for a given item, including the
|
|
282
275
|
* empty string or an invalid value, that item will match the search filter.
|
|
283
276
|
* @public
|
|
284
277
|
* @documentationMaturity preview
|
|
285
278
|
* @param field - Field in which to check for a non-empty value.
|
|
286
279
|
* @requiredField field
|
|
287
|
-
* @returns
|
|
280
|
+
* @returns Refined WixDataSearch object.
|
|
288
281
|
*/
|
|
289
282
|
isNotEmpty(field: string): WixDataSearch;
|
|
290
283
|
/**
|
|
291
|
-
* Refines a search to match items whose specified
|
|
284
|
+
* Refines a search to match items whose specified field does not exist or does not have any value (is null or undefined).
|
|
292
285
|
*
|
|
293
286
|
* The `isEmpty()` method refines this search to only match items where the
|
|
294
|
-
* value of the specified
|
|
287
|
+
* value of the specified field is `null` or `undefined` or the field does
|
|
295
288
|
* not exist.
|
|
296
289
|
*
|
|
297
|
-
* If the
|
|
290
|
+
* If the field contains any value at all for a given item, including the
|
|
298
291
|
* empty string or an invalid value, that item will not match the search filter.
|
|
299
292
|
* @public
|
|
300
293
|
* @documentationMaturity preview
|
|
301
294
|
* @param field - Field in which to check for an empty or non-existent value.
|
|
302
295
|
* @requiredField field
|
|
303
|
-
* @returns
|
|
296
|
+
* @returns Refined WixDataSearch object.
|
|
304
297
|
*/
|
|
305
298
|
isEmpty(field: string): WixDataSearch;
|
|
306
299
|
/**
|
|
307
|
-
* Refines a search to match items whose specified
|
|
300
|
+
* Refines a search to match items whose specified field value starts with a specified string.
|
|
308
301
|
*
|
|
309
|
-
* The `startsWith()` method refines this search to
|
|
310
|
-
* only match items where the value of the specified property starts with the
|
|
311
|
-
* defined `string`. Matching with `startsWith()` is case-sensitive, so `"TEXT"` does not start
|
|
312
|
-
* with `"tex"`.
|
|
302
|
+
* The `startsWith()` method refines this search to only match items where the value of the specified field starts with the specified `string`. Matching with `startsWith()` is case-sensitive, so searching for `"Sun"` does not retrieve an item that contains the text `"sunshine"`.
|
|
313
303
|
*
|
|
314
|
-
* You can only use `startsWith()` with a
|
|
304
|
+
* You can only use `startsWith()` with a field whose value is a String or Reference.
|
|
315
305
|
* When using a Reference, `startsWith()` matches by the ID of the referenced item as Strings.
|
|
316
306
|
* @public
|
|
317
307
|
* @documentationMaturity preview
|
|
318
308
|
* @param field - Field whose value is compared with the `value` parameter.
|
|
319
309
|
* @requiredField field
|
|
320
|
-
* @param value - String to look for at the beginning of the specified
|
|
310
|
+
* @param value - String to look for at the beginning of the specified field value.
|
|
321
311
|
* @requiredField value
|
|
322
|
-
* @returns
|
|
312
|
+
* @returns Refined WixDataSearch object.
|
|
323
313
|
*/
|
|
324
314
|
startsWith(field: string, value: string): WixDataSearch;
|
|
325
315
|
/**
|
|
@@ -333,61 +323,60 @@ export interface WixDataSearch {
|
|
|
333
323
|
*
|
|
334
324
|
* If the specified field contains multiple references, pass item IDs as the values. `hasSome()` matches if any of the multiple references match any of the specified ID values.
|
|
335
325
|
*
|
|
336
|
-
* You can specify multiple values to match by providing an array of String, Number, or Date types as the `
|
|
326
|
+
* You can specify multiple values to match by providing an array of String, Number, or Date types as the `values` parameters.
|
|
337
327
|
* @public
|
|
338
328
|
* @documentationMaturity preview
|
|
339
|
-
* @param field - Field whose value is compared with `
|
|
329
|
+
* @param field - Field whose value is compared with `values`.
|
|
340
330
|
* @requiredField field
|
|
341
331
|
* @param values - Values to match.
|
|
342
332
|
* @requiredField values
|
|
343
|
-
* @returns
|
|
333
|
+
* @returns Refined WixDataSearch object.
|
|
344
334
|
*/
|
|
345
335
|
hasSome(field: string, ...values: string[] | number[] | Date[]): WixDataSearch;
|
|
346
336
|
/**
|
|
347
|
-
* Overload for `hasSome()`. Refines a search to match items whose specified
|
|
337
|
+
* Overload for `hasSome()`. Refines a search to match items whose specified field value equals any of the specified values.
|
|
348
338
|
* @public
|
|
349
339
|
* @documentationMaturity preview
|
|
350
340
|
* @param field - Field whose value is compared with the provided values.
|
|
351
341
|
* @requiredField field
|
|
352
342
|
* @param values - An array of values to match.
|
|
353
343
|
* @requiredField values
|
|
354
|
-
* @returns
|
|
344
|
+
* @returns Refined WixDataSearch object.
|
|
355
345
|
*/
|
|
356
346
|
hasSome(field: string, values: string[] | number[] | Date[]): WixDataSearch;
|
|
357
347
|
/**
|
|
358
|
-
* Refines a search to match items whose specified
|
|
359
|
-
* parameters.
|
|
348
|
+
* Refines a search to match items whose specified field value equals all of the specified values.
|
|
360
349
|
*
|
|
361
350
|
* The `hasAll()` method refines this search to
|
|
362
|
-
* only match items where the value of the specified
|
|
351
|
+
* only match items where the value of the specified field equals all of
|
|
363
352
|
* the specified values.
|
|
364
353
|
*
|
|
365
|
-
* Matching strings with `hasAll()` is case
|
|
354
|
+
* Matching strings with `hasAll()` is case-sensitive, so `"text"` is not equal to `"Text"`.
|
|
366
355
|
*
|
|
367
|
-
* If the value of the specified
|
|
356
|
+
* If the value of the specified field is an array, `hasAll()` will match
|
|
368
357
|
* if there is a match in the elements of that array for all of the specified
|
|
369
358
|
* values.
|
|
370
359
|
*
|
|
371
360
|
* You can specify a list of values to match by providing an array of
|
|
372
|
-
* String, Number, or Date types as the `
|
|
361
|
+
* String, Number, or Date types as the `values` parameters.
|
|
373
362
|
* @public
|
|
374
363
|
* @documentationMaturity preview
|
|
375
|
-
* @param field - Field whose value is compared with `
|
|
364
|
+
* @param field - Field whose value is compared with `values`.
|
|
376
365
|
* @requiredField field
|
|
377
366
|
* @param values - Values to match. All specified values must be present.
|
|
378
367
|
* @requiredField values
|
|
379
|
-
* @returns
|
|
368
|
+
* @returns Refined WixDataSearch object.
|
|
380
369
|
*/
|
|
381
370
|
hasAll(field: string, ...values: string[] | number[] | Date[]): WixDataSearch;
|
|
382
371
|
/**
|
|
383
|
-
* Overload for `hasAll()`. Refines a search to match items whose specified
|
|
372
|
+
* Overload for `hasAll()`. Refines a search to match items whose specified field values equals all of the specified values.
|
|
384
373
|
* @public
|
|
385
374
|
* @documentationMaturity preview
|
|
386
375
|
* @param field - Field whose value is compared with the provided values.
|
|
387
376
|
* @requiredField field
|
|
388
|
-
* @param values -
|
|
377
|
+
* @param values - Array of values to match. All values in the array must be present.
|
|
389
378
|
* @requiredField values
|
|
390
|
-
* @returns
|
|
379
|
+
* @returns Refined WixDataSearch object.
|
|
391
380
|
*/
|
|
392
381
|
hasAll(field: string, values: string[] | number[] | Date[]): WixDataSearch;
|
|
393
382
|
/**
|
|
@@ -400,7 +389,7 @@ export interface WixDataSearch {
|
|
|
400
389
|
* @documentationMaturity preview
|
|
401
390
|
* @param filter - Filter to add to the initial filter as an `or` condition.
|
|
402
391
|
* @requiredField filter
|
|
403
|
-
* @returns
|
|
392
|
+
* @returns Refined WixDataSearch object.
|
|
404
393
|
*/
|
|
405
394
|
or(filter: WixDataFilter): WixDataSearch;
|
|
406
395
|
/**
|
|
@@ -430,7 +419,7 @@ export interface WixDataSearch {
|
|
|
430
419
|
* @documentationMaturity preview
|
|
431
420
|
* @param filter - Filter to add to the initial search filter as an `and` condition.
|
|
432
421
|
* @requiredField filter
|
|
433
|
-
* @returns
|
|
422
|
+
* @returns Refined WixDataSearch object.
|
|
434
423
|
*/
|
|
435
424
|
and(filter: WixDataFilter): WixDataSearch;
|
|
436
425
|
/**
|
|
@@ -444,22 +433,22 @@ export interface WixDataSearch {
|
|
|
444
433
|
* @documentationMaturity preview
|
|
445
434
|
* @param filter - Filter to add to the initial filter as a `not` condition.
|
|
446
435
|
* @requiredField filter
|
|
447
|
-
* @returns
|
|
436
|
+
* @returns Refined WixDataSearch object.
|
|
448
437
|
*/
|
|
449
438
|
not(filter: WixDataFilter): WixDataSearch;
|
|
450
439
|
/**
|
|
451
|
-
* Refines a search to match items whose specified
|
|
440
|
+
* Refines a search to match items whose specified field value is within a specified range.
|
|
452
441
|
*
|
|
453
|
-
* The `between()` method refines this search to only match items where the value of the specified
|
|
442
|
+
* The `between()` method refines this search to only match items where the value of the specified field is
|
|
454
443
|
* greater than or equal to `rangeStart` and less than `rangeEnd`.
|
|
455
444
|
*
|
|
456
445
|
* It only matches values of the same type. For example, a number value stored as a String type does not match the
|
|
457
446
|
* same number stored as a Number type.
|
|
458
447
|
*
|
|
459
|
-
* If a
|
|
460
|
-
* that do not have a value for the specified
|
|
448
|
+
* If a field contains a number as a String, that value is compared alphabetically and not numerically. Items
|
|
449
|
+
* that do not have a value for the specified field are ranked lowest.
|
|
461
450
|
*
|
|
462
|
-
* The following types of
|
|
451
|
+
* The following types of fields can be compared:
|
|
463
452
|
* - Number: Compares numerically.
|
|
464
453
|
* - Date: Compares JavaScript Date objects.
|
|
465
454
|
* - String: Compares lexicographically, so
|
|
@@ -473,7 +462,7 @@ export interface WixDataSearch {
|
|
|
473
462
|
* @requiredField rangeStart
|
|
474
463
|
* @param rangeEnd - Ending value of the range to match (exclusive).
|
|
475
464
|
* @requiredField rangeEnd
|
|
476
|
-
* @returns
|
|
465
|
+
* @returns Refined WixDataSearch object.
|
|
477
466
|
*/
|
|
478
467
|
between(field: string, rangeStart: string | number | Date, rangeEnd: string | number | Date): WixDataSearch;
|
|
479
468
|
/**
|
|
@@ -483,15 +472,15 @@ export interface WixDataSearch {
|
|
|
483
472
|
*
|
|
484
473
|
* You can use `include()` in conjunction with `fields()` to get referenced items.
|
|
485
474
|
*
|
|
486
|
-
* When `fields()` receives an empty or invalid
|
|
475
|
+
* When `fields()` receives an empty or invalid field, the search behaves as follows:
|
|
487
476
|
* - When no fields are specified, the search returns all fields.
|
|
488
477
|
* - When multiple fields are specified but some are invalid, invalid fields are ignored and valid fields are returned.
|
|
489
478
|
* - When only invalid fields are specified, only the default `_id` field is returned.
|
|
490
479
|
* @public
|
|
491
480
|
* @documentationMaturity preview
|
|
492
|
-
* @param fields -
|
|
481
|
+
* @param fields - Fields to return.
|
|
493
482
|
* @requiredField fields
|
|
494
|
-
* @returns
|
|
483
|
+
* @returns Refined WixDataSearch object.
|
|
495
484
|
*/
|
|
496
485
|
fields(...fields: string[]): WixDataSearch;
|
|
497
486
|
/**
|
|
@@ -510,7 +499,7 @@ export interface WixDataSearch {
|
|
|
510
499
|
* @documentationMaturity preview
|
|
511
500
|
* @param limitNumber - Number of items to return, which is also the `pageSize` of the results object.
|
|
512
501
|
* @requiredField limitNumber
|
|
513
|
-
* @returns
|
|
502
|
+
* @returns Refined WixDataSearch object.
|
|
514
503
|
*/
|
|
515
504
|
limit(limitNumber: number): WixDataSearch;
|
|
516
505
|
/**
|
|
@@ -528,20 +517,16 @@ export interface WixDataSearch {
|
|
|
528
517
|
* @documentationMaturity preview
|
|
529
518
|
* @param skipCount - Number of items to skip in the search results before returning the results.
|
|
530
519
|
* @requiredField skipCount
|
|
531
|
-
* @returns
|
|
520
|
+
* @returns Refined WixDataSearch object.
|
|
532
521
|
*/
|
|
533
522
|
skip(skipCount: number): WixDataSearch;
|
|
534
523
|
/**
|
|
535
|
-
* Includes referenced items for the specified
|
|
524
|
+
* Includes referenced items for the specified fields in a search's results.
|
|
536
525
|
*
|
|
537
526
|
* The `include()` method refines a search so that the items returned in the
|
|
538
|
-
* search's results include the full referenced items for the specified
|
|
527
|
+
* search's results include the full referenced items for the specified fields.
|
|
539
528
|
*
|
|
540
|
-
* For example, suppose you have a **books** collection with an **author**
|
|
541
|
-
* field that references an **authors** collection. Searching the **books**
|
|
542
|
-
* collection with an `include("author")` returns the relevant book items
|
|
543
|
-
* and each item will include the full referenced author item in the book's
|
|
544
|
-
* `author` property.
|
|
529
|
+
* For example, suppose you have a **books** collection with an **author** field that references an **authors** collection. Searching the **books** collection with an `include("author")` returns the relevant book items and each item will include the full referenced author item in the book's `author` field.
|
|
545
530
|
*
|
|
546
531
|
* When searching a collection that contains a reference field without using the
|
|
547
532
|
* `include()` method:
|
|
@@ -550,14 +535,14 @@ export interface WixDataSearch {
|
|
|
550
535
|
* - Multiple reference field: returned items do not contain the multiple
|
|
551
536
|
* reference field at all.
|
|
552
537
|
*
|
|
553
|
-
* When including a
|
|
538
|
+
* When including a field with multiple references, the following limitations
|
|
554
539
|
* apply:
|
|
555
|
-
* - Only one
|
|
540
|
+
* - Only one field with multiple references can be included.
|
|
556
541
|
* - The search will return an error if more than 50 items are returned, regardless
|
|
557
542
|
* of any search limit set using the `limit()` method.
|
|
558
543
|
* - Each returned item can include up to 50 referenced items. If there are more
|
|
559
544
|
* than 50 referenced items, only 50 are returned when the search is run
|
|
560
|
-
* and the `partialIncludes`
|
|
545
|
+
* and the `partialIncludes` field of the returned `WixDataResult` is `true`.
|
|
561
546
|
*
|
|
562
547
|
* > **Note:** The `include()` method is not supported for [single-item collections](https://support.wix.com/en/article/cms-adding-and-setting-up-a-single-item-collection).
|
|
563
548
|
*
|
|
@@ -565,41 +550,41 @@ export interface WixDataSearch {
|
|
|
565
550
|
* @documentationMaturity preview
|
|
566
551
|
* @param fields - Fields for which to include referenced items.
|
|
567
552
|
* @requiredField fields
|
|
568
|
-
* @returns
|
|
553
|
+
* @returns Refined WixDataSearch object.
|
|
569
554
|
*/
|
|
570
555
|
include(...fields: string[]): WixDataSearch;
|
|
571
556
|
/**
|
|
572
|
-
* Overload for `include()`. Includes referenced items for the specified
|
|
557
|
+
* Overload for `include()`. Includes referenced items for the specified field in a search's results.
|
|
573
558
|
* @public
|
|
574
559
|
* @documentationMaturity preview
|
|
575
560
|
* @param field - Field for which to include referenced items.
|
|
576
561
|
* @param limit - Optional limit for the number of referenced items to include (behavior may vary).
|
|
577
|
-
* @returns
|
|
562
|
+
* @returns Refined WixDataSearch object.
|
|
578
563
|
*/
|
|
579
564
|
include(field: string, limit?: number): WixDataSearch;
|
|
580
565
|
/**
|
|
581
|
-
* Overload for `include()`. Includes referenced items for the specified
|
|
566
|
+
* Overload for `include()`. Includes referenced items for the specified fields in a search's results.
|
|
582
567
|
* @public
|
|
583
568
|
* @documentationMaturity preview
|
|
584
569
|
* @param field1 - First field for which to include referenced items.
|
|
585
570
|
* @param field2 - Second field for which to include referenced items.
|
|
586
571
|
* @param limit - Optional limit for the number of referenced items to include (behavior may vary).
|
|
587
|
-
* @returns
|
|
572
|
+
* @returns Refined WixDataSearch object.
|
|
588
573
|
*/
|
|
589
574
|
include(field1: string, field2: string, limit?: number): WixDataSearch;
|
|
590
575
|
/**
|
|
591
|
-
* Overload for `include()`. Includes referenced items for the specified
|
|
576
|
+
* Overload for `include()`. Includes referenced items for the specified fields in a search's results.
|
|
592
577
|
* @public
|
|
593
578
|
* @documentationMaturity preview
|
|
594
579
|
* @param field1 - First field.
|
|
595
580
|
* @param field2 - Second field.
|
|
596
581
|
* @param field3 - Third field.
|
|
597
582
|
* @param limit - Optional limit.
|
|
598
|
-
* @returns
|
|
583
|
+
* @returns Refined WixDataSearch object.
|
|
599
584
|
*/
|
|
600
585
|
include(field1: string, field2: string, field3: string, limit?: number): WixDataSearch;
|
|
601
586
|
/**
|
|
602
|
-
* Overload for `include()`. Includes referenced items for the specified
|
|
587
|
+
* Overload for `include()`. Includes referenced items for the specified fields in a search's results.
|
|
603
588
|
* @public
|
|
604
589
|
* @documentationMaturity preview
|
|
605
590
|
* @param field1 - First field.
|
|
@@ -607,11 +592,11 @@ export interface WixDataSearch {
|
|
|
607
592
|
* @param field3 - Third field.
|
|
608
593
|
* @param field4 - Fourth field.
|
|
609
594
|
* @param limit - Optional limit.
|
|
610
|
-
* @returns
|
|
595
|
+
* @returns Refined WixDataSearch object.
|
|
611
596
|
*/
|
|
612
597
|
include(field1: string, field2: string, field3: string, field4: string, limit?: number): WixDataSearch;
|
|
613
598
|
/**
|
|
614
|
-
* Overload for `include()`. Includes referenced items for the specified
|
|
599
|
+
* Overload for `include()`. Includes referenced items for the specified fields in a search's results.
|
|
615
600
|
* @public
|
|
616
601
|
* @documentationMaturity preview
|
|
617
602
|
* @param field1 - First field.
|
|
@@ -620,16 +605,16 @@ export interface WixDataSearch {
|
|
|
620
605
|
* @param field4 - Fourth field.
|
|
621
606
|
* @param field5 - Fifth field.
|
|
622
607
|
* @param limit - Optional limit.
|
|
623
|
-
* @returns
|
|
608
|
+
* @returns Refined WixDataSearch object.
|
|
624
609
|
*/
|
|
625
610
|
include(field1: string, field2: string, field3: string, field4: string, field5: string, limit?: number): WixDataSearch;
|
|
626
611
|
/**
|
|
627
|
-
* Overload for `include()`. Includes referenced items for the specified
|
|
612
|
+
* Overload for `include()`. Includes referenced items for the specified fields in a search's results.
|
|
628
613
|
* Allows specifying multiple field names and an optional limit.
|
|
629
614
|
* @public
|
|
630
615
|
* @documentationMaturity preview
|
|
631
|
-
* @param fieldNamesAndLimit -
|
|
632
|
-
* @returns
|
|
616
|
+
* @param fieldNamesAndLimit - Array of field names, optionally followed by a limit number.
|
|
617
|
+
* @returns Refined WixDataSearch object.
|
|
633
618
|
*/
|
|
634
619
|
include(...fieldNamesAndLimit: [...string[], number]): WixDataSearch;
|
|
635
620
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"WixDataSearch.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataSearch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAAA;IAE5C;;;;;;OAMG;IACH,KAAK,IAAI,aAAa,CAAA;IAEtB;;;;;;OAMG;IACH,OAAO,IAAI,aAAa,CAAA;IAExB
|
|
1
|
+
{"version":3,"file":"WixDataSearch.d.ts","sourceRoot":"","sources":["../../../src/api/WixDataSearch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;OAOG;IACH,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAAA;IAE5C;;;;;;OAMG;IACH,KAAK,IAAI,aAAa,CAAA;IAEtB;;;;;;OAMG;IACH,OAAO,IAAI,aAAa,CAAA;IAExB;;;;;;OAMG;IACH,MAAM,IAAI,aAAa,CAAA;IAEvB;;;;;;;;OAQG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAEzD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAA;IAC9C;;;OAGG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAA;IAC3C;;;OAGG;IACH,UAAU,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAA;IAC7C;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAA;IAC1C;;;OAGG;IACH,SAAS,CAAC,GAAG,MAAM,EAAE,GAAG,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;;;OAgBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,aAAa,CAAA;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,aAAa,CAAA;IAE/D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAErC;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAAA;IAEvD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE9E;;;;;;;;;OASG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE3E;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE7E;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,aAAa,CAAA;IAE1E;;;;;;;;;;;OAWG;IACH,EAAE,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CACL,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,EAClC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAC/B,aAAa,CAAA;IAEhB;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAA;IAE1C;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,WAAW,EAAE,MAAM,GAAG,aAAa,CAAA;IAEzC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAAA;IAEtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,OAAO,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,GAAG,aAAa,CAAA;IAE3C;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAErD;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IAEtE;;;;;;;;;OASG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,aAAa,CAAA;IAEhB;;;;;;;;;;OAUG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,aAAa,CAAA;IAEhB;;;;;;;;;;;OAWG;IACH,OAAO,CACL,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACb,aAAa,CAAA;IAEhB;;;;;;;OAOG;IACH,OAAO,CAAC,GAAG,kBAAkB,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,MAAM,CAAC,GAAG,aAAa,CAAA;CACrE"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/wix-data-items-common",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.162",
|
|
4
4
|
"license": "UNLICENSED",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Rimvydas Gimbutas",
|
|
@@ -85,5 +85,5 @@
|
|
|
85
85
|
"wallaby": {
|
|
86
86
|
"autoDetect": true
|
|
87
87
|
},
|
|
88
|
-
"falconPackageHash": "
|
|
88
|
+
"falconPackageHash": "3bf14352d7a7f1ecab4a8739435139f4e5100c598b90f8464670d225"
|
|
89
89
|
}
|