algoliasearch 4.14.1 → 5.0.0-alpha.1

package/lite/model/highlightResultOption.ts

@@ -0,0 +1,22 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Show highlighted section and words matched on a query.
+ */
+export type HighlightResultOption = {
+  /**
+   * Markup text with occurrences highlighted.
+   */
+  value: string;
+  matchLevel: MatchLevel;
+  /**
+   * List of words from the query that matched the object.
+   */
+  matchedWords: string[];
+  /**
+   * Whether the entire attribute value is highlighted.
+   */
+  fullyHighlighted?: boolean;
+};

package/lite/model/hit.ts

@@ -0,0 +1,25 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+
+/**
+ * A single hit.
+ */
+export type Hit<T> = T & {
+  /**
+   * Unique identifier of the object.
+   */
+  objectID: string;
+  /**
+   * Show highlighted section and words matched on a query.
+   */
+  _highlightResult?: Record<string, HighlightResult>;
+  /**
+   * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+   */
+  _snippetResult?: Record<string, SnippetResult>;
+  _rankingInfo?: RankingInfo;
+  _distinctSeqID?: number;
+};

package/lite/model/ignorePlurals.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals 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 ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export type IgnorePlurals = string[] | boolean;

package/lite/model/index.ts

@@ -0,0 +1,106 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export * from './acl';
+export * from './action';
+export * from './addApiKeyResponse';
+export * from './advancedSyntaxFeatures';
+export * from './alternativesAsExact';
+export * from './anchoring';
+export * from './apiKey';
+export * from './aroundRadius';
+export * from './aroundRadiusAll';
+export * from './attributeOrBuiltInOperation';
+export * from './automaticFacetFilter';
+export * from './automaticFacetFilters';
+export * from './baseBrowseResponse';
+export * from './baseIndexSettings';
+export * from './baseSearchParams';
+export * from './baseSearchParamsWithoutQuery';
+export * from './baseSearchResponse';
+export * from './browseResponse';
+export * from './builtInOperation';
+export * from './builtInOperationType';
+export * from './condition';
+export * from './consequence';
+export * from './consequenceHide';
+export * from './consequenceParams';
+export * from './consequenceQuery';
+export * from './consequenceQueryObject';
+export * from './createdAtObject';
+export * from './dictionaryAction';
+export * from './dictionaryEntry';
+export * from './dictionaryEntryState';
+export * from './dictionaryLanguage';
+export * from './dictionaryType';
+export * from './edit';
+export * from './editType';
+export * from './errorBase';
+export * from './exactOnSingleWordQuery';
+export * from './facetFilters';
+export * from './facetOrdering';
+export * from './facets';
+export * from './facetsStats';
+export * from './fetchedIndex';
+export * from './highlightResult';
+export * from './highlightResultOption';
+export * from './hit';
+export * from './ignorePlurals';
+export * from './indexSettings';
+export * from './indexSettingsAsSearchParams';
+export * from './key';
+export * from './languages';
+export * from './listIndicesResponse';
+export * from './logType';
+export * from './matchLevel';
+export * from './matchedGeoLocation';
+export * from './mixedSearchFilters';
+export * from './numericFilters';
+export * from './operationType';
+export * from './optionalFilters';
+export * from './params';
+export * from './personalization';
+export * from './promote';
+export * from './promoteObjectID';
+export * from './promoteObjectIDs';
+export * from './queryType';
+export * from './rankingInfo';
+export * from './reRankingApplyFilter';
+export * from './removeStopWords';
+export * from './removeWordsIfNoResults';
+export * from './renderingContent';
+export * from './rule';
+export * from './scopeType';
+export * from './searchForFacets';
+export * from './searchForFacetsOptions';
+export * from './searchForHits';
+export * from './searchForHitsOptions';
+export * from './searchHits';
+export * from './searchMethodParams';
+export * from './searchParams';
+export * from './searchParamsObject';
+export * from './searchParamsQuery';
+export * from './searchParamsString';
+export * from './searchQuery';
+export * from './searchResponse';
+export * from './searchResponses';
+export * from './searchStrategy';
+export * from './searchSynonymsResponse';
+export * from './searchTypeDefault';
+export * from './searchTypeFacet';
+export * from './snippetResult';
+export * from './snippetResultOption';
+export * from './sortRemainingBy';
+export * from './source';
+export * from './standardEntries';
+export * from './synonymHit';
+export * from './synonymHitHighlightResult';
+export * from './synonymType';
+export * from './tagFilters';
+export * from './taskStatus';
+export * from './timeRange';
+export * from './typoTolerance';
+export * from './typoToleranceEnum';
+export * from './updatedRuleResponse';
+export * from './userId';
+export * from './value';
+export * from './clientMethodProps';

package/lite/model/indexSettings.ts

@@ -0,0 +1,9 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseIndexSettings } from './baseIndexSettings';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+
+/**
+ * The Algolia index settings.
+ */
+export type IndexSettings = BaseIndexSettings & IndexSettingsAsSearchParams;

package/lite/model/indexSettingsAsSearchParams.ts

@@ -0,0 +1,161 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
+import type { AlternativesAsExact } from './alternativesAsExact';
+import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
+import type { IgnorePlurals } from './ignorePlurals';
+import type { QueryType } from './queryType';
+import type { RemoveStopWords } from './removeStopWords';
+import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
+import type { RenderingContent } from './renderingContent';
+import type { TypoTolerance } from './typoTolerance';
+
+export type IndexSettingsAsSearchParams = {
+  /**
+   * The complete list of attributes that will be used for faceting.
+   */
+  attributesForFaceting?: string[];
+  /**
+   * List of attributes that can\'t be retrieved at query time.
+   */
+  unretrievableAttributes?: string[];
+  /**
+   * This parameter controls which attributes to retrieve and which not to retrieve.
+   */
+  attributesToRetrieve?: string[];
+  /**
+   * Restricts a given query to look in only a subset of your searchable attributes.
+   */
+  restrictSearchableAttributes?: string[];
+  /**
+   * Controls how Algolia should sort your results.
+   */
+  ranking?: string[];
+  /**
+   * Specifies the custom ranking criterion.
+   */
+  customRanking?: string[];
+  /**
+   * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
+   */
+  relevancyStrictness?: number;
+  /**
+   * List of attributes to highlight.
+   */
+  attributesToHighlight?: string[];
+  /**
+   * List of attributes to snippet, with an optional maximum number of words to snippet.
+   */
+  attributesToSnippet?: string[];
+  /**
+   * The 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.
+   */
+  highlightPostTag?: string;
+  /**
+   * String used as an ellipsis indicator when a snippet is truncated.
+   */
+  snippetEllipsisText?: string;
+  /**
+   * Restrict highlighting and snippeting to items that matched the query.
+   */
+  restrictHighlightAndSnippetArrays?: boolean;
+  /**
+   * Set the 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.
+   */
+  minWordSizefor1Typo?: number;
+  /**
+   * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
+   */
+  minWordSizefor2Typos?: number;
+  typoTolerance?: TypoTolerance;
+  /**
+   * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
+   */
+  allowTyposOnNumericTokens?: boolean;
+  /**
+   * List of attributes on which you want to disable typo tolerance.
+   */
+  disableTypoToleranceOnAttributes?: string[];
+  ignorePlurals?: IgnorePlurals;
+  removeStopWords?: RemoveStopWords;
+  /**
+   * List of characters that the engine shouldn\'t automatically normalize.
+   */
+  keepDiacriticsOnCharacters?: string;
+  /**
+   * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
+   */
+  queryLanguages?: string[];
+  /**
+   * Splits compound words into their composing atoms in the query.
+   */
+  decompoundQuery?: boolean;
+  /**
+   * Whether Rules should be globally enabled.
+   */
+  enableRules?: boolean;
+  /**
+   * Enable the Personalization feature.
+   */
+  enablePersonalization?: boolean;
+  queryType?: QueryType;
+  removeWordsIfNoResults?: RemoveWordsIfNoResults;
+  /**
+   * Enables the advanced query syntax.
+   */
+  advancedSyntax?: boolean;
+  /**
+   * A list of words that should be considered as optional when found in the query.
+   */
+  optionalWords?: string[];
+  /**
+   * List of attributes on which you want to disable the exact ranking criterion.
+   */
+  disableExactOnAttributes?: string[];
+  exactOnSingleWordQuery?: ExactOnSingleWordQuery;
+  /**
+   * List of alternatives that should be considered an exact match by the exact ranking criterion.
+   */
+  alternativesAsExact?: AlternativesAsExact[];
+  /**
+   * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
+   */
+  advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
+  /**
+   * Enables de-duplication or grouping of results.
+   */
+  distinct?: number;
+  /**
+   * Whether to take into account an index\'s synonyms for a particular search.
+   */
+  synonyms?: boolean;
+  /**
+   * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
+   */
+  replaceSynonymsInHighlight?: boolean;
+  /**
+   * Precision of the proximity ranking criterion.
+   */
+  minProximity?: number;
+  /**
+   * Choose which fields to return in the API response. This parameters applies to 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.
+   */
+  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.
+   */
+  attributeCriteriaComputedByMinProximity?: boolean;
+  renderingContent?: RenderingContent;
+};

package/lite/model/key.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ApiKey } from './apiKey';
+import type { CreatedAtObject } from './createdAtObject';
+
+export type Key = ApiKey & CreatedAtObject;

package/lite/model/languages.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { DictionaryLanguage } from './dictionaryLanguage';
+
+/**
+ * A dictionary language.
+ */
+export type Languages = {
+  plurals: DictionaryLanguage | null;
+  stopwords: DictionaryLanguage | null;
+  compounds: DictionaryLanguage | null;
+};

package/lite/model/listIndicesResponse.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { FetchedIndex } from './fetchedIndex';
+
+export type ListIndicesResponse = {
+  /**
+   * List of the fetched indices.
+   */
+  items?: FetchedIndex[];
+  /**
+   * Number of pages.
+   */
+  nbPages?: number;
+};

package/lite/model/logType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type LogType = 'all' | 'build' | 'error' | 'query';

package/lite/model/matchLevel.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Indicates how well the attribute matched the search query.
+ */
+export type MatchLevel = 'full' | 'none' | 'partial';

package/lite/model/matchedGeoLocation.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type MatchedGeoLocation = {
+  /**
+   * Latitude of the matched location.
+   */
+  lat?: number;
+  /**
+   * Longitude of the matched location.
+   */
+  lng?: number;
+  /**
+   * Distance between the matched location and the search location (in meters).
+   */
+  distance?: number;
+};

package/lite/model/mixedSearchFilters.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type MixedSearchFilters = string[] | string;

package/lite/model/numericFilters.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * Filter on numeric attributes.
+ */
+export type NumericFilters = MixedSearchFilters[] | string;

package/lite/model/operationType.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Type of operation to perform (move or copy).
+ */
+export type OperationType = 'copy' | 'move';

package/lite/model/optionalFilters.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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.
+ */
+export type OptionalFilters = MixedSearchFilters[] | string;

package/lite/model/params.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AutomaticFacetFilters } from './automaticFacetFilters';
+import type { ConsequenceQuery } from './consequenceQuery';
+import type { RenderingContent } from './renderingContent';
+
+/**
+ * Additional search parameters. Any valid search parameter is allowed.
+ */
+export type Params = {
+  query?: ConsequenceQuery;
+  automaticFacetFilters?: AutomaticFacetFilters;
+  automaticOptionalFacetFilters?: AutomaticFacetFilters;
+  renderingContent?: RenderingContent;
+};

package/lite/model/personalization.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type Personalization = {
+  /**
+   * The score of the filters.
+   */
+  filtersScore?: number;
+  /**
+   * The score of the ranking.
+   */
+  rankingScore?: number;
+  /**
+   * The score of the event.
+   */
+  score?: number;
+};

package/lite/model/promote.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { PromoteObjectID } from './promoteObjectID';
+import type { PromoteObjectIDs } from './promoteObjectIDs';
+
+export type Promote = PromoteObjectID | PromoteObjectIDs;

package/lite/model/promoteObjectID.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Single objectID to promote as hits.
+ */
+export type PromoteObjectID = {
+  /**
+   * Unique identifier of the object 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.
+   */
+  position: number;
+};

package/lite/model/promoteObjectIDs.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Multiple objectIDs to promote as hits.
+ */
+export type PromoteObjectIDs = {
+  /**
+   * Array of unique identifiers of the objects 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.
+   */
+  position: number;
+};

package/lite/model/queryType.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Controls if and how query words are interpreted as prefixes.
+ */
+export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';

package/lite/model/rankingInfo.ts

@@ -0,0 +1,53 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchedGeoLocation } from './matchedGeoLocation';
+import type { Personalization } from './personalization';
+
+export type RankingInfo = {
+  /**
+   * This field is reserved for advanced usage.
+   */
+  filters: number;
+  /**
+   * Position of the most important matched attribute in the attributes to index list.
+   */
+  firstMatchedWord: number;
+  /**
+   * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
+   */
+  geoDistance: number;
+  /**
+   * Precision used when computing the geo distance, in meters.
+   */
+  geoPrecision?: number;
+  matchedGeoLocation?: MatchedGeoLocation;
+  personalization?: Personalization;
+  /**
+   * Number of exactly matched words.
+   */
+  nbExactWords: number;
+  /**
+   * Number of typos encountered when matching the record.
+   */
+  nbTypos: number;
+  /**
+   * Present and set to true if a Rule promoted the hit.
+   */
+  promoted: boolean;
+  /**
+   * When the query contains more than one word, the sum of the distances between matched words (in meters).
+   */
+  proximityDistance?: number;
+  /**
+   * Custom ranking for the object, expressed as a single integer value.
+   */
+  userScore: number;
+  /**
+   * Number of matched words, including prefixes and typos.
+   */
+  words: number;
+  /**
+   * Wether the record are promoted by the re-ranking strategy.
+   */
+  promotedByReRanking?: boolean;
+};

package/lite/model/reRankingApplyFilter.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
+ */
+export type ReRankingApplyFilter = MixedSearchFilters[] | string;

package/lite/model/removeStopWords.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * 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.
+ */
+export type RemoveStopWords = string[] | boolean;

package/lite/model/removeWordsIfNoResults.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults =
+  | 'allOptional'
+  | 'firstWords'
+  | 'lastWords'
+  | 'none';

package/lite/model/renderingContent.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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.
+ */
+export type RenderingContent = {
+  facetOrdering?: FacetOrdering;
+};

package/lite/model/rule.ts

@@ -0,0 +1,32 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+
+/**
+ * Rule object.
+ */
+export type Rule = {
+  /**
+   * Unique identifier of the object.
+   */
+  objectID: string;
+  /**
+   * A list of conditions that should apply 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?: string;
+  /**
+   * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'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.
+   */
+  validity?: TimeRange[];
+};

package/lite/model/scopeType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type ScopeType = 'rules' | 'settings' | 'synonyms';

package/lite/model/searchForFacets.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+
+export type SearchForFacets = SearchForFacetsOptions & SearchParams;