algoliasearch 5.0.0-alpha.73 → 5.0.0-alpha.76

package/dist/lite/model/indexSettingsAsSearchParams.d.ts

@@ -12,43 +12,43 @@ import type { RenderingContent } from './renderingContent';
 import type { TypoTolerance } from './typoTolerance';
 export type IndexSettingsAsSearchParams = {
     /**
-     * The complete list of attributes that will be used for faceting.
+     * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/) and the [modifiers](https://www.algolia.com/doc/api-reference/api-parameters/attributesForFaceting/#modifiers) that can be applied: `filterOnly`, `searchable`, and `afterDistinct`.
      */
     attributesForFaceting?: string[];
     /**
-     * This parameter controls which attributes to retrieve and which not to retrieve.
+     * Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. By default, the response includes all attributes.
      */
     attributesToRetrieve?: string[];
     /**
-     * Restricts a given query to look in only a subset of your searchable attributes.
+     * Restricts a query to only look at a subset of your [searchable attributes](https://www.algolia.com/doc/guides/managing-results/must-do/searchable-attributes/).
      */
     restrictSearchableAttributes?: string[];
     /**
-     * Controls how Algolia should sort your results.
+     * Determines the order in which Algolia [returns your results](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/).
      */
     ranking?: string[];
     /**
-     * Specifies the custom ranking criterion.
+     * Specifies the [Custom ranking criterion](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Use the `asc` and `desc` modifiers to specify the ranking order: ascending or descending.
      */
     customRanking?: string[];
     /**
-     * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
+     * Relevancy threshold below which less relevant results aren\'t included in the results.
      */
     relevancyStrictness?: number;
     /**
-     * List of attributes to highlight.
+     * Attributes to highlight. Strings that match the search query in the attributes are highlighted by surrounding them with HTML tags (`highlightPreTag` and `highlightPostTag`).
      */
     attributesToHighlight?: string[];
     /**
-     * List of attributes to snippet, with an optional maximum number of words to snippet.
+     * Attributes to _snippet_. \'Snippeting\' is shortening the attribute to a certain number of words. If not specified, the attribute is shortened to the 10 words around the matching string but you can specify the number. For example: `body:20`.
      */
     attributesToSnippet?: string[];
     /**
-     * The HTML string to insert before the highlighted parts in all highlight and snippet results.
+     * HTML string to insert before the highlighted parts in all highlight and snippet results.
      */
     highlightPreTag?: string;
     /**
-     * The HTML string to insert after the highlighted parts in all highlight and snippet results.
+     * HTML string to insert after the highlighted parts in all highlight and snippet results.
      */
     highlightPostTag?: string;
     /**
@@ -60,15 +60,15 @@ export type IndexSettingsAsSearchParams = {
      */
     restrictHighlightAndSnippetArrays?: boolean;
     /**
-     * Set the number of hits per page.
+     * Number of hits per page.
      */
     hitsPerPage?: number;
     /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
+     * Minimum number of characters a word in the query string must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
      */
     minWordSizefor1Typo?: number;
     /**
-     * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
+     * Minimum number of characters a word in the query string must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
      */
     minWordSizefor2Typos?: number;
     typoTolerance?: TypoTolerance;
@@ -77,29 +77,29 @@ export type IndexSettingsAsSearchParams = {
      */
     allowTyposOnNumericTokens?: boolean;
     /**
-     * List of attributes on which you want to disable typo tolerance.
+     * Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
      */
     disableTypoToleranceOnAttributes?: string[];
     ignorePlurals?: IgnorePlurals;
     removeStopWords?: RemoveStopWords;
     /**
-     * List of characters that the engine shouldn\'t automatically normalize.
+     * Characters that the engine shouldn\'t automatically [normalize](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
      */
     keepDiacriticsOnCharacters?: string;
     /**
-     * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+     * Sets your user\'s search language. This adjusts language-specific settings and features such as `ignorePlurals`, `removeStopWords`, and [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) word detection.
      */
     queryLanguages?: string[];
     /**
-     * Splits compound words into their composing atoms in the query.
+     * [Splits compound words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words) into their component word parts in the query.
      */
     decompoundQuery?: boolean;
     /**
-     * Whether Rules should be globally enabled.
+     * Incidates whether [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/) are enabled.
      */
     enableRules?: boolean;
     /**
-     * Enable the Personalization feature.
+     * Incidates whether [Personalization](https://www.algolia.com/doc/guides/personalization/what-is-personalization/) is enabled.
      */
     enablePersonalization?: boolean;
     queryType?: QueryType;
@@ -107,33 +107,33 @@ export type IndexSettingsAsSearchParams = {
     mode?: Mode;
     semanticSearch?: IndexSettingsAsSearchParamsSemanticSearch;
     /**
-     * Enables the advanced query syntax.
+     * Enables the [advanced query syntax](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#advanced-syntax).
      */
     advancedSyntax?: boolean;
     /**
-     * A list of words that should be considered as optional when found in the query.
+     * Words which should be considered [optional](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words) when found in a query.
      */
     optionalWords?: string[];
     /**
-     * List of attributes on which you want to disable the exact ranking criterion.
+     * Attributes for which you want to [turn off the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
      */
     disableExactOnAttributes?: string[];
     exactOnSingleWordQuery?: ExactOnSingleWordQuery;
     /**
-     * List of alternatives that should be considered an exact match by the exact ranking criterion.
+     * Alternatives that should be considered an exact match by [the exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
      */
     alternativesAsExact?: AlternativesAsExact[];
     /**
-     * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+     * Allows you to specify which advanced syntax features are active when `advancedSyntax` is enabled.
      */
     advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
     /**
-     * Enriches the API’s response with meta-information as to how the query was processed.
+     * Enriches the API\'s response with information about how the query was processed.
      */
     explain?: string[];
     distinct?: Distinct;
     /**
-     * Name of the de-duplication attribute to be used with the distinct feature.
+     * Name of the deduplication attribute to be used with Algolia\'s [_distinct_ feature](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature).
      */
     attributeForDistinct?: string;
     /**
@@ -145,19 +145,19 @@ export type IndexSettingsAsSearchParams = {
      */
     replaceSynonymsInHighlight?: boolean;
     /**
-     * Precision of the proximity ranking criterion.
+     * Precision of the [proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity).
      */
     minProximity?: number;
     /**
-     * Choose which fields to return in the API response. This parameters applies to search and browse queries.
+     * Attributes to include in the API response for search and browse queries.
      */
     responseFields?: string[];
     /**
-     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+     * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
     maxFacetHits?: number;
     /**
-     * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
+     * When the [Attribute criterion is ranked above Proximity](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute-and-proximity-combinations) in your ranking formula, Proximity is used to select which searchable attribute is matched in the Attribute ranking stage.
      */
     attributeCriteriaComputedByMinProximity?: boolean;
     renderingContent?: RenderingContent;

package/dist/lite/model/indexSettingsAsSearchParamsSemanticSearch.d.ts

@@ -1,9 +1,9 @@
 /**
- * The settings relevant for configuration of the semantic search engine. These settings are only used when the mode is set to \'neuralSearch\'.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
  */
 export type IndexSettingsAsSearchParamsSemanticSearch = {
     /**
-     * When null, the current index / replica group will be used as the event source.
+     * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
      */
     eventSources?: string[] | null;
 };

package/dist/lite/model/languages.d.ts

@@ -1,6 +1,6 @@
 import type { DictionaryLanguage } from './dictionaryLanguage';
 /**
- * A dictionary language.
+ * Dictionary language.
  */
 export type Languages = {
     plurals: DictionaryLanguage | null;

package/dist/lite/model/listIndicesResponse.d.ts

@@ -1,7 +1,7 @@
 import type { FetchedIndex } from './fetchedIndex';
 export type ListIndicesResponse = {
     /**
-     * List of the fetched indices.
+     * All indices in your Algolia application.
      */
     items: FetchedIndex[];
     /**

package/dist/lite/model/mode.d.ts

@@ -1,5 +1,5 @@
 /**
- * The search mode that the index will use to query for results.
+ * Search mode the index will use to query for results.
  */
 export type Mode = 'keywordSearch' | 'neuralSearch';
 //# sourceMappingURL=mode.d.ts.map

package/dist/lite/model/numericFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Filter on numeric attributes.
+ * [Filter on numeric attributes](https://www.algolia.com/doc/api-reference/api-parameters/numericFilters/).
  */
 export type NumericFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=numericFilters.d.ts.map

package/dist/lite/model/operationType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Type of operation to perform (move or copy).
+ * Operation to perform (_move_ or _copy_).
  */
 export type OperationType = 'copy' | 'move';
 //# sourceMappingURL=operationType.d.ts.map

package/dist/lite/model/optionalFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
+ * Create filters to boost or demote records.   Records that match the filter are ranked higher for positive and lower for negative optional filters. In contrast to regular filters, records that don\'t match the optional filter are still included in the results, only their ranking is affected.
  */
 export type OptionalFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=optionalFilters.d.ts.map

package/dist/lite/model/params.d.ts

@@ -2,7 +2,7 @@ import type { AutomaticFacetFilters } from './automaticFacetFilters';
 import type { ConsequenceQuery } from './consequenceQuery';
 import type { RenderingContent } from './renderingContent';
 /**
- * Additional search parameters. Any valid search parameter is allowed.
+ * Additional search parameters.
  */
 export type Params = {
     query?: ConsequenceQuery;

package/dist/lite/model/promoteObjectID.d.ts

@@ -1,13 +1,13 @@
 /**
- * Single objectID to promote as hits.
+ * Record to promote.
  */
 export type PromoteObjectID = {
     /**
-     * Unique identifier of the object to promote.
+     * Unique identifier of the record to promote.
      */
     objectID: string;
     /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
      */
     position: number;
 };

package/dist/lite/model/promoteObjectIDs.d.ts

@@ -1,13 +1,13 @@
 /**
- * Multiple objectIDs to promote as hits.
+ * Records to promote.
  */
 export type PromoteObjectIDs = {
     /**
-     * Array of unique identifiers of the objects to promote.
+     * Unique identifiers of the records to promote.
      */
     objectIDs: string[];
     /**
-     * The position to promote the objects to (zero-based). If you pass objectIDs, the objects are placed at this position as a group. For example, if you pass four objectIDs to position 0, the objects take the first four positions.
+     * The position to promote the records to. If you pass objectIDs, the records are placed at this position as a group. For example, if you pronmote four objectIDs to position 0, the records take the first four positions.
      */
     position: number;
 };

package/dist/lite/model/queryType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Controls if and how query words are interpreted as prefixes.
+ * Determines how query words are [interpreted as prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
  */
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

package/dist/lite/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/lite/model/redirectRuleIndexMetadata.d.ts

@@ -13,7 +13,7 @@ export type RedirectRuleIndexMetadata = {
      */
     reason: string;
     /**
-     * Status for the redirect rule.
+     * Redirect rule status.
      */
     succeed: boolean;
     data: RedirectRuleIndexMetadataData;

package/dist/lite/model/redirectRuleIndexMetadataData.d.ts

@@ -1,5 +1,5 @@
 /**
- * Data for the redirect rule.
+ * Redirect rule data.
  */
 export type RedirectRuleIndexMetadataData = {
     ruleObjectID: string;

package/dist/lite/model/removeStopWords.d.ts

@@ -1,5 +1,5 @@
 /**
- * Removes stop (common) words from the query before executing it. RemoveStopWords is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
  */
 export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

package/dist/lite/model/removeWordsIfNoResults.d.ts

@@ -1,5 +1,5 @@
 /**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
  */
 export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

package/dist/lite/model/renderingContent.d.ts

@@ -1,6 +1,6 @@
 import type { FacetOrdering } from './facetOrdering';
 /**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
  */
 export type RenderingContent = {
     facetOrdering?: FacetOrdering;

package/dist/lite/model/rule.d.ts

@@ -6,24 +6,24 @@ import type { TimeRange } from './timeRange';
  */
 export type Rule = {
     /**
-     * Unique identifier of the object.
+     * Unique identifier for a rule object.
      */
     objectID: string;
     /**
-     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+     * [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
      */
     conditions?: Condition[];
     consequence?: Consequence;
     /**
-     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
      */
     description?: string;
     /**
-     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
      */
     enabled?: boolean;
     /**
-     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+     * If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
      */
     validity?: TimeRange[];
 };

package/dist/lite/model/searchForFacetValuesResponse.d.ts

@@ -0,0 +1,5 @@
+import type { FacetHits } from './facetHits';
+export type SearchForFacetValuesResponse = {
+    facetHits: FacetHits[];
+};
+//# sourceMappingURL=searchForFacetValuesResponse.d.ts.map

package/dist/lite/model/searchForFacetValuesResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchForFacetValuesResponse.d.ts","sourceRoot":"","sources":["../../../lite/model/searchForFacetValuesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,4BAA4B,GAAG;IACzC,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB,CAAC"}

package/dist/lite/model/searchForFacetsOptions.d.ts

@@ -1,11 +1,11 @@
 import type { SearchTypeFacet } from './searchTypeFacet';
 export type SearchForFacetsOptions = {
     /**
-     * The `facet` name.
+     * Facet name.
      */
     facet: string;
     /**
-     * The Algolia index name.
+     * Algolia index name.
      */
     indexName: string;
     /**
@@ -13,7 +13,7 @@ export type SearchForFacetsOptions = {
      */
     facetQuery?: string;
     /**
-     * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
+     * Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
      */
     maxFacetHits?: number;
     type: SearchTypeFacet;

package/dist/lite/model/searchForHitsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { SearchTypeDefault } from './searchTypeDefault';
 export type SearchForHitsOptions = {
     /**
-     * The Algolia index name.
+     * Algolia index name.
      */
     indexName: string;
     type?: SearchTypeDefault;

package/dist/lite/model/searchParamsQuery.d.ts

@@ -1,6 +1,6 @@
 export type SearchParamsQuery = {
     /**
-     * The text to search in the index.
+     * Text to search for in an index.
      */
     query?: string;
 };

package/dist/lite/model/searchParamsString.d.ts

@@ -1,6 +1,6 @@
 export type SearchParamsString = {
     /**
-     * Search parameters as URL-encoded query string.
+     * Search parameters as a URL-encoded query string.
      */
     params?: string;
 };

package/dist/lite/model/searchResponses.d.ts

@@ -1,5 +1,5 @@
-import type { SearchResponse } from './searchResponse';
+import type { SearchResult } from './searchResult';
 export type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResponse<T>>;
+    results: Array<SearchResult<T>>;
 };
 //# sourceMappingURL=searchResponses.d.ts.map

package/dist/lite/model/searchResponses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CACnC,CAAC"}
+{"version":3,"file":"searchResponses.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResponses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD,OAAO,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC;CACjC,CAAC"}

package/dist/lite/model/searchResult.d.ts

@@ -0,0 +1,4 @@
+import type { SearchForFacetValuesResponse } from './searchForFacetValuesResponse';
+import type { SearchResponse } from './searchResponse';
+export type SearchResult<T = Record<string, any>> = SearchForFacetValuesResponse | SearchResponse<T>;
+//# sourceMappingURL=searchResult.d.ts.map

package/dist/lite/model/searchResult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchResult.d.ts","sourceRoot":"","sources":["../../../lite/model/searchResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC5C,4BAA4B,GAC5B,cAAc,CAAC,CAAC,CAAC,CAAC"}

package/dist/lite/model/searchStrategy.d.ts

@@ -1,2 +1,5 @@
+/**
+ * - `none`: executes all queries. - `stopIfEnoughMatches`: executes queries one by one, stopping further query execution as soon as a query matches at least the `hitsPerPage` number of results.
+ */
 export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

package/dist/lite/model/searchStrategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchStrategy.d.ts","sourceRoot":"","sources":["../../../lite/model/searchStrategy.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,qBAAqB,CAAC"}
+{"version":3,"file":"searchStrategy.d.ts","sourceRoot":"","sources":["../../../lite/model/searchStrategy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,qBAAqB,CAAC"}

package/dist/lite/model/searchSynonymsResponse.d.ts

@@ -1,11 +1,11 @@
 import type { SynonymHit } from './synonymHit';
 export type SearchSynonymsResponse = Record<string, any> & {
     /**
-     * Array of synonym objects.
+     * Synonym objects.
      */
     hits: SynonymHit[];
     /**
-     * Number of hits that the search query matched.
+     * Number of hits the search query matched.
      */
     nbHits: number;
 };

package/dist/lite/model/searchTypeDefault.d.ts

@@ -1,5 +1,5 @@
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeDefault = 'default';
 //# sourceMappingURL=searchTypeDefault.d.ts.map

package/dist/lite/model/searchTypeFacet.d.ts

@@ -1,5 +1,5 @@
 /**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
+ * - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
  */
 export type SearchTypeFacet = 'facet';
 //# sourceMappingURL=searchTypeFacet.d.ts.map

package/dist/lite/model/snippetResultOption.d.ts

@@ -4,7 +4,7 @@ import type { MatchLevel } from './matchLevel';
  */
 export type SnippetResultOption = {
     /**
-     * Markup text with occurrences highlighted.
+     * Markup text with `facetQuery` matches highlighted.
      */
     value: string;
     matchLevel: MatchLevel;

package/dist/lite/model/sortRemainingBy.d.ts

@@ -1,5 +1,5 @@
 /**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/lite/model/source.d.ts

@@ -1,13 +1,13 @@
 /**
- * The source.
+ * Source.
  */
 export type Source = {
     /**
-     * The IP range of the source.
+     * IP address range of the source.
      */
     source: string;
     /**
-     * The description of the source.
+     * Source description.
      */
     description?: string;
 };

package/dist/lite/model/standardEntries.d.ts

@@ -1,17 +1,17 @@
 /**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ * Key-value pairs of [supported language ISO codes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and boolean values.
  */
 export type StandardEntries = {
     /**
-     * Language ISO code.
+     * Key-value pair of a language ISO code and a boolean value.
      */
     plurals?: Record<string, boolean> | null;
     /**
-     * Language ISO code.
+     * Key-value pair of a language ISO code and a boolean value.
      */
     stopwords?: Record<string, boolean> | null;
     /**
-     * Language ISO code.
+     * Key-value pair of a language ISO code and a boolean value.
      */
     compounds?: Record<string, boolean> | null;
 };