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

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

package/model/multipleBatchResponse.ts

@@ -4,9 +4,10 @@ export type MultipleBatchResponse = {
   /**
    * List of tasksIDs per index.
    */
-  taskID?: Record<string, any>;
+  taskID: Record<string, number>;
+
   /**
    * List of objectID.
    */
-  objectIDs?: string[];
+  objectIDs: string[];
 };

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 };

package/model/searchHits.ts

@@ -2,6 +2,6 @@
 
 import type { Hit } from './hit';
 
-export type SearchHits<T> = {
+export type SearchHits<T = Record<string, any>> = {
   hits: Array<Hit<T>>;
 };

package/model/searchMethodParams.ts

@@ -5,5 +5,6 @@ import type { SearchStrategy } from './searchStrategy';
 
 export type SearchMethodParams = {
   requests: SearchQuery[];
+
   strategy?: SearchStrategy;
 };

package/model/searchResponse.ts

@@ -3,4 +3,5 @@
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
 
-export type SearchResponse<T> = BaseSearchResponse & SearchHits<T>;
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse &
+  SearchHits<T>;

package/model/searchResponses.ts

@@ -2,6 +2,6 @@
 
 import type { SearchResponse } from './searchResponse';
 
-export type SearchResponses<T> = {
+export type SearchResponses<T = Record<string, any>> = {
   results: Array<SearchResponse<T>>;
 };

package/model/searchRulesParams.ts

@@ -10,23 +10,29 @@ export type SearchRulesParams = {
    * Full text query.
    */
   query?: string;
+
   anchoring?: Anchoring;
+
   /**
    * Restricts matches to contextual rules with a specific context (exact match).
    */
   context?: string;
+
   /**
    * Requested page (zero-based).
    */
   page?: number;
+
   /**
    * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
    */
   hitsPerPage?: number;
+
   /**
    * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
    */
   enabled?: boolean;
+
   /**
    * A mapping of requestOptions to send along with the request.
    */

package/model/searchRulesResponse.ts

@@ -7,14 +7,17 @@ export type SearchRulesResponse = {
    * Fetched rules.
    */
   hits: Rule[];
+
   /**
    * Number of fetched rules.
    */
   nbHits: number;
+
   /**
    * Current page.
    */
   page: number;
+
   /**
    * Number of pages.
    */

package/model/searchSynonymsResponse.ts

@@ -7,6 +7,7 @@ export type SearchSynonymsResponse = Record<string, any> & {
    * Array of synonym objects.
    */
   hits: SynonymHit[];
+
   /**
    * Number of hits that the search query matched.
    */

package/model/searchUserIdsParams.ts

@@ -8,14 +8,17 @@ export type SearchUserIdsParams = {
    * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
    */
   query: string;
+
   /**
    * Name of the cluster.
    */
   clusterName?: string;
+
   /**
    * Specify the page to retrieve.
    */
   page?: number;
+
   /**
    * Set the number of hits per page.
    */

package/model/searchUserIdsResponse.ts

@@ -10,18 +10,22 @@ export type SearchUserIdsResponse = {
    * List of user object matching the query.
    */
   hits: UserHit[];
+
   /**
    * Number of hits that the search query matched.
    */
   nbHits: number;
+
   /**
    * Specify the page to retrieve.
    */
   page: number;
+
   /**
    * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
    */
   hitsPerPage: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */

package/model/snippetResultOption.ts

@@ -10,5 +10,6 @@ export type SnippetResultOption = {
    * Markup text with occurrences highlighted.
    */
   value: string;
+
   matchLevel: MatchLevel;
 };

package/model/source.ts

@@ -8,6 +8,7 @@ export type Source = {
    * The IP range of the source.
    */
   source: string;
+
   /**
    * The description of the source.
    */

package/model/standardEntries.ts

@@ -8,10 +8,12 @@ export type StandardEntries = {
    * Language ISO code.
    */
   plurals?: Record<string, boolean> | null;
+
   /**
    * Language ISO code.
    */
   stopwords?: Record<string, boolean> | null;
+
   /**
    * Language ISO code.
    */

package/model/synonymHit.ts

@@ -1,6 +1,5 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { SynonymHitHighlightResult } from './synonymHitHighlightResult';
 import type { SynonymType } from './synonymType';
 
 /**
@@ -11,30 +10,36 @@ export type SynonymHit = {
    * Unique identifier of the synonym object to be created or updated.
    */
   objectID: string;
+
   type: SynonymType;
+
   /**
    * Words or phrases to be considered equivalent.
    */
   synonyms?: string[];
+
   /**
    * Word or phrase to appear in query strings (for onewaysynonym).
    */
   input?: string;
+
   /**
    * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
    */
   word?: string;
+
   /**
    * Words to be matched in records.
    */
   corrections?: string[];
+
   /**
    * Token to be put inside records.
    */
   placeholder?: string;
+
   /**
    * List of query words that will match the token.
    */
   replacements?: string[];
-  _highlightResult?: SynonymHitHighlightResult;
 };

package/model/timeRange.ts

@@ -5,6 +5,7 @@ export type TimeRange = {
    * Lower bound of the time range (Unix timestamp).
    */
   from: number;
+
   /**
    * Upper bound of the time range (Unix timestamp).
    */

package/model/updateApiKeyResponse.ts

@@ -2,9 +2,10 @@
 
 export type UpdateApiKeyResponse = {
   /**
-   * Key string.
+   * The API key.
    */
   key: string;
+
   /**
    * Date of last update (ISO-8601 format).
    */

package/model/updatedAtResponse.ts

@@ -8,6 +8,7 @@ export type UpdatedAtResponse = {
    * TaskID of the task to wait for.
    */
   taskID: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */

package/model/updatedAtWithObjectIdResponse.ts

@@ -8,10 +8,12 @@ export type UpdatedAtWithObjectIdResponse = {
    * TaskID of the task to wait for.
    */
   taskID?: number;
+
   /**
    * Date of last update (ISO-8601 format).
    */
   updatedAt?: string;
+
   /**
    * Unique identifier of the object.
    */

package/model/updatedRuleResponse.ts

@@ -5,10 +5,12 @@ export type UpdatedRuleResponse = {
    * Unique identifier of the object.
    */
   objectID: string;
+
   /**
    * Date of last update (ISO-8601 format).
    */
   updatedAt: string;
+
   /**
    * TaskID of the task to wait for.
    */

package/model/userHighlightResult.ts

@@ -7,6 +7,7 @@ export type UserHighlightResult = {
    * Show highlighted section and words matched on a query.
    */
   userID: Record<string, HighlightResult>;
+
   /**
    * Show highlighted section and words matched on a query.
    */