@algolia/client-search 5.0.0-alpha.2 → 5.0.0-alpha.3

package/model/getObjectsResponse.ts

@@ -1,8 +1,8 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-export type GetObjectsResponse = {
+export type GetObjectsResponse<T = Record<string, any>> = {
   /**
    * List of results fetched.
    */
-  results?: Array<Record<string, any>>;
+  results: T[];
 };

package/model/hasPendingMappingsResponse.ts

@@ -5,6 +5,7 @@ export type HasPendingMappingsResponse = {
    * If there is any clusters with pending mapping state.
    */
   pending: boolean;
+
   /**
    * Describe cluster pending (migrating, creating, deleting) mapping state.
    */

package/model/highlightResultOption.ts

@@ -10,11 +10,14 @@ 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.
    */

package/model/hit.ts

@@ -7,19 +7,23 @@ import type { SnippetResult } from './snippetResult';
 /**
  * A single hit.
  */
-export type Hit<T> = T & {
+export type Hit<T = Record<string, any>> = 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/model/index.ts

@@ -21,8 +21,8 @@ export * from './baseSearchResponse';
 export * from './batchAssignUserIdsParams';
 export * from './batchDictionaryEntriesParams';
 export * from './batchDictionaryEntriesRequest';
-export * from './batchOperation';
 export * from './batchParams';
+export * from './batchRequest';
 export * from './batchResponse';
 export * from './batchWriteParams';
 export * from './browseRequest';
@@ -46,6 +46,7 @@ export * from './dictionaryEntryState';
 export * from './dictionaryLanguage';
 export * from './dictionarySettingsParams';
 export * from './dictionaryType';
+export * from './distinct';
 export * from './edit';
 export * from './editType';
 export * from './errorBase';
@@ -59,6 +60,7 @@ export * from './fetchedIndex';
 export * from './getDictionarySettingsResponse';
 export * from './getLogsResponse';
 export * from './getObjectsParams';
+export * from './getObjectsRequest';
 export * from './getObjectsResponse';
 export * from './getTaskResponse';
 export * from './getTopUserIdsResponse';
@@ -81,9 +83,8 @@ export * from './logType';
 export * from './matchLevel';
 export * from './matchedGeoLocation';
 export * from './mixedSearchFilters';
-export * from './multipleBatchOperation';
+export * from './multipleBatchRequest';
 export * from './multipleBatchResponse';
-export * from './multipleGetObjectsParams';
 export * from './numericFilters';
 export * from './operationIndexParams';
 export * from './operationType';

package/model/indexSettingsAsSearchParams.ts

@@ -2,6 +2,7 @@
 
 import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
 import type { AlternativesAsExact } from './alternativesAsExact';
+import type { Distinct } from './distinct';
 import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
 import type { IgnorePlurals } from './ignorePlurals';
 import type { QueryType } from './queryType';
@@ -15,147 +16,185 @@ 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;
+
+  distinct?: Distinct;
+
   /**
    * 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/model/languages.ts

@@ -7,6 +7,8 @@ import type { DictionaryLanguage } from './dictionaryLanguage';
  */
 export type Languages = {
   plurals: DictionaryLanguage | null;
+
   stopwords: DictionaryLanguage | null;
+
   compounds: DictionaryLanguage | null;
 };

package/model/listIndicesResponse.ts

@@ -6,7 +6,8 @@ export type ListIndicesResponse = {
   /**
    * List of the fetched indices.
    */
-  items?: FetchedIndex[];
+  items: FetchedIndex[];
+
   /**
    * Number of pages.
    */

package/model/log.ts

@@ -7,58 +7,72 @@ export type Log = {
    * Timestamp in ISO-8601 format.
    */
   timestamp: string;
+
   /**
    * HTTP method of the performed request.
    */
   method: string;
+
   /**
    * HTTP response code.
    */
   answer_code: string;
+
   /**
    * Request body. Truncated after 1000 characters.
    */
   query_body: string;
+
   /**
    * Answer body. Truncated after 1000 characters.
    */
   answer: string;
+
   /**
    * Request URL.
    */
   url: string;
+
   /**
    * IP of the client which performed the request.
    */
   ip: string;
+
   /**
    * Request Headers (API Key is obfuscated).
    */
   query_headers: string;
+
   /**
    * SHA1 signature of the log entry.
    */
   sha1: string;
+
   /**
    * Number of API calls.
    */
   nb_api_calls: string;
+
   /**
    * Processing time for the query. It doesn\'t include network time.
    */
   processing_time_ms: string;
+
   /**
    * Index targeted by the query.
    */
   index?: string;
+
   /**
    * Query parameters sent with the request.
    */
   query_params?: string;
+
   /**
    * Number of hits returned for the query.
    */
   query_nb_hits?: string;
+
   /**
    * Array of all performed queries for the given request.
    */

package/model/logQuery.ts

@@ -5,10 +5,12 @@ export type LogQuery = {
    * Index targeted by the query.
    */
   index_name?: string;
+
   /**
    * User identifier.
    */
   user_token?: string;
+
   /**
    * QueryID for the given query.
    */

package/model/matchedGeoLocation.ts

@@ -5,10 +5,12 @@ 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).
    */

package/model/{multipleBatchOperation.ts → multipleBatchRequest.ts}

@@ -2,12 +2,14 @@
 
 import type { Action } from './action';
 
-export type MultipleBatchOperation = {
+export type MultipleBatchRequest = {
   action?: Action;
+
   /**
    * Arguments to the operation (depends on the type of the operation).
    */
   body?: Record<string, any>;
+
   /**
    * Index to target for this operation.
    */

package/model/multipleBatchResponse.ts

@@ -5,6 +5,7 @@ export type MultipleBatchResponse = {
    * List of tasksIDs per index.
    */
   taskID?: Record<string, any>;
+
   /**
    * List of objectID.
    */

package/model/operationIndexParams.ts

@@ -5,10 +5,12 @@ import type { ScopeType } from './scopeType';
 
 export type OperationIndexParams = {
   operation: OperationType;
+
   /**
    * The Algolia index name.
    */
   destination: string;
+
   /**
    * Scope of the data to copy. When absent, a full copy is performed. When present, only the selected scopes are copied.
    */

package/model/params.ts

@@ -9,7 +9,10 @@ import type { RenderingContent } from './renderingContent';
  */
 export type Params = {
   query?: ConsequenceQuery;
+
   automaticFacetFilters?: AutomaticFacetFilters;
+
   automaticOptionalFacetFilters?: AutomaticFacetFilters;
+
   renderingContent?: RenderingContent;
 };

package/model/personalization.ts

@@ -5,10 +5,12 @@ export type Personalization = {
    * The score of the filters.
    */
   filtersScore?: number;
+
   /**
    * The score of the ranking.
    */
   rankingScore?: number;
+
   /**
    * The score of the event.
    */

package/model/promoteObjectID.ts

@@ -8,6 +8,7 @@ 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.
    */

package/model/promoteObjectIDs.ts

@@ -8,6 +8,7 @@ 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.
    */

package/model/rankingInfo.ts

@@ -8,44 +8,56 @@ 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.
    */

package/model/rule.ts

@@ -12,19 +12,24 @@ 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.
    */

package/model/saveObjectResponse.ts

@@ -1,11 +1,13 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
 export type SaveObjectResponse = {
-  createdAt?: string;
+  createdAt: string;
+
   /**
    * TaskID of the task to wait for.
    */
-  taskID?: number;
+  taskID: number;
+
   /**
    * Unique identifier of the object.
    */

package/model/saveSynonymResponse.ts

@@ -5,10 +5,12 @@ export type SaveSynonymResponse = {
    * TaskID of the task to wait for.
    */
   taskID: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */
   updatedAt: string;
+
   /**
    * ObjectID of the inserted object.
    */

package/model/searchDictionaryEntriesParams.ts

@@ -8,14 +8,17 @@ export type SearchDictionaryEntriesParams = {
    * The text to search in the index.
    */
   query: string;
+
   /**
    * Specify the page to retrieve.
    */
   page?: number;
+
   /**
    * Set the number of hits per page.
    */
   hitsPerPage?: number;
+
   /**
    * Language ISO code supported by the dictionary (e.g., \"en\" for English).
    */

package/model/searchForFacetValuesRequest.ts

@@ -5,10 +5,12 @@ export type SearchForFacetValuesRequest = {
    * Search parameters as URL-encoded query string.
    */
   params?: string;
+
   /**
    * Text to search inside the facet\'s values.
    */
   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.
    */

package/model/searchForFacetsOptions.ts

@@ -7,17 +7,21 @@ export type SearchForFacetsOptions = {
    * The `facet` name.
    */
   facet: string;
+
   /**
    * The Algolia index name.
    */
   indexName: string;
+
   /**
    * Text to search inside the facet\'s values.
    */
   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.
    */
   maxFacetHits?: number;
+
   type: SearchTypeFacet;
 };

package/model/searchForHitsOptions.ts

@@ -7,5 +7,6 @@ export type SearchForHitsOptions = {
    * The Algolia index name.
    */
   indexName: string;
+
   type?: SearchTypeDefault;
 } & { facet?: never; maxFacetHits?: never; facetQuery?: never };