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

package/model/baseGetApiKeyResponse.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type BaseGetApiKeyResponse = {
+  /**
+   * The API key.
+   */
+  value?: string;
+
+  /**
+   * Time of the event expressed in milliseconds since the Unix epoch.
+   */
+  createdAt: number;
+};

package/model/baseIndexSettings.ts

@@ -5,54 +5,67 @@ export type BaseIndexSettings = {
    * Creates replicas, exact copies of an index.
    */
   replicas?: string[];
+
   /**
    * Set the maximum number of hits accessible via pagination.
    */
   paginationLimitedTo?: number;
+
   /**
    * A list of words for which you want to turn off typo tolerance.
    */
   disableTypoToleranceOnWords?: string[];
+
   /**
    * Specify on which attributes in your index Algolia should apply Japanese transliteration to make words indexed in Katakana or Kanji searchable in Hiragana.
    */
   attributesToTransliterate?: string[];
+
   /**
    * List of attributes on which to do a decomposition of camel case words.
    */
   camelCaseAttributes?: string[];
+
   /**
    * Specify on which attributes in your index Algolia should apply word segmentation, also known as decompounding.
    */
   decompoundedAttributes?: Record<string, any>;
+
   /**
    * Sets the languages at the index level for language-specific processing such as tokenization and normalization.
    */
   indexLanguages?: string[];
+
   /**
    * List of attributes on which you want to disable prefix matching.
    */
   disablePrefixOnAttributes?: string[];
+
   /**
    * Enables compression of large integer arrays.
    */
   allowCompressionOfIntegerArray?: boolean;
+
   /**
    * List of numeric attributes that can be used as numerical filters.
    */
   numericAttributesForFiltering?: string[];
+
   /**
    * Control which separators are indexed.
    */
   separatorsToIndex?: string;
+
   /**
    * The complete list of attributes used for searching.
    */
   searchableAttributes?: string[];
+
   /**
    * Lets you store custom data in your indices.
    */
   userData?: Record<string, any>;
+
   /**
    * Overrides Algolia\'s default normalization.
    */

package/model/baseSearchParamsWithoutQuery.ts

@@ -12,114 +12,146 @@ export type BaseSearchParamsWithoutQuery = {
    * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
    */
   similarQuery?: string;
+
   /**
    * Filter the query with numeric, facet and/or tag filters.
    */
   filters?: string;
+
   facetFilters?: FacetFilters;
+
   optionalFilters?: OptionalFilters;
+
   numericFilters?: NumericFilters;
+
   tagFilters?: TagFilters;
+
   /**
    * Determines how to calculate the total score for filtering.
    */
   sumOrFiltersScores?: boolean;
+
   /**
    * Retrieve facets and their facet values.
    */
   facets?: string[];
+
   /**
    * Maximum number of facet values to return for each facet during a regular search.
    */
   maxValuesPerFacet?: number;
+
   /**
    * Force faceting to be applied after de-duplication (via the Distinct setting).
    */
   facetingAfterDistinct?: boolean;
+
   /**
    * Controls how facet values are fetched.
    */
   sortFacetValuesBy?: string;
+
   /**
    * Specify the page to retrieve.
    */
   page?: number;
+
   /**
    * Specify the offset of the first hit to return.
    */
   offset?: number;
+
   /**
    * Set the number of hits to retrieve (used only with offset).
    */
   length?: number;
+
   /**
    * Search for entries around a central geolocation, enabling a geo search within a circular area.
    */
   aroundLatLng?: string;
+
   /**
    * Search for entries around a given location automatically computed from the requester\'s IP address.
    */
   aroundLatLngViaIP?: boolean;
+
   aroundRadius?: AroundRadius;
+
   /**
    * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
    */
   aroundPrecision?: number;
+
   /**
    * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
    */
   minimumAroundRadius?: number;
+
   /**
    * Search inside a rectangular area (in geo coordinates).
    */
   insideBoundingBox?: number[];
+
   /**
    * Search inside a polygon (in geo coordinates).
    */
   insidePolygon?: number[];
+
   /**
    * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
    */
   naturalLanguages?: string[];
+
   /**
    * Enables contextual rules.
    */
   ruleContexts?: string[];
+
   /**
    * Define the impact of the Personalization feature.
    */
   personalizationImpact?: number;
+
   /**
    * Associates a certain user token with the current search.
    */
   userToken?: string;
+
   /**
    * Retrieve detailed ranking information.
    */
   getRankingInfo?: boolean;
+
   /**
    * Enable the Click Analytics feature.
    */
   clickAnalytics?: boolean;
+
   /**
    * Whether the current query will be taken into account in the Analytics.
    */
   analytics?: boolean;
+
   /**
    * List of tags to apply to the query for analytics purposes.
    */
   analyticsTags?: string[];
+
   /**
    * Whether to include or exclude a query from the processing-time percentile computation.
    */
   percentileComputation?: boolean;
+
   /**
    * Whether this search should participate in running AB tests.
    */
   enableABTest?: boolean;
+
   /**
    * Whether this search should use AI Re-Ranking.
    */
   enableReRanking?: boolean;
+
   reRankingApplyFilter?: ReRankingApplyFilter | null;
 };

package/model/baseSearchResponse.ts

@@ -8,97 +8,121 @@ export type BaseSearchResponse = {
    * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
    */
   abTestID?: number;
+
   /**
    * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
    */
   abTestVariantID?: number;
+
   /**
    * The computed geo location.
    */
   aroundLatLng?: string;
+
   /**
    * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
    */
   automaticRadius?: string;
+
   /**
    * Whether the facet count is exhaustive or approximate.
    */
   exhaustiveFacetsCount?: boolean;
+
   /**
    * Indicate if the nbHits count was exhaustive or approximate.
    */
   exhaustiveNbHits: boolean;
+
   /**
    * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
    */
   exhaustiveTypo: boolean;
+
   /**
    * A mapping of each facet name to the corresponding facet counts.
    */
   facets?: Record<string, Record<string, number>>;
+
   /**
    * Statistics for numerical facets.
    */
   facets_stats?: Record<string, FacetsStats>;
+
   /**
    * Set the number of hits per page.
    */
   hitsPerPage: number;
+
   /**
    * Index name used for the query.
    */
   index?: string;
+
   /**
    * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
    */
   indexUsed?: string;
+
   /**
    * Used to return warnings about the query.
    */
   message?: string;
+
   /**
    * Number of hits that the search query matched.
    */
   nbHits: number;
+
   /**
    * Number of pages available for the current query.
    */
   nbPages: number;
+
   /**
    * The number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
+
   /**
    * Specify the page to retrieve.
    */
   page: number;
+
   /**
    * A url-encoded string of all search parameters.
    */
   params: string;
+
   /**
    * The query string that will be searched, after normalization.
    */
   parsedQuery?: string;
+
   /**
    * Time the server took to process the request, in milliseconds.
    */
   processingTimeMS: number;
+
   /**
    * The text to search in the index.
    */
   query: string;
+
   /**
    * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
    */
   queryAfterRemoval?: string;
+
   /**
    * Actual host name of the server that processed the request.
    */
   serverUsed?: string;
+
   /**
    * Lets you store custom data in your indices.
    */
   userData?: Record<string, any>;
+
   renderingContent?: RenderingContent;
 };

package/model/batchAssignUserIdsParams.ts

@@ -8,6 +8,7 @@ export type BatchAssignUserIdsParams = {
    * Name of the cluster.
    */
   cluster: string;
+
   /**
    * UserIDs to assign. Note you cannot move users with this method.
    */

package/model/batchDictionaryEntriesParams.ts

@@ -10,6 +10,7 @@ export type BatchDictionaryEntriesParams = {
    * When `true`, start the batch by removing all the custom entries from the dictionary.
    */
   clearExistingDictionaryEntries?: boolean;
+
   /**
    * List of operations to batch. Each operation is described by an `action` and a `body`.
    */

package/model/batchDictionaryEntriesRequest.ts

@@ -5,5 +5,6 @@ import type { DictionaryEntry } from './dictionaryEntry';
 
 export type BatchDictionaryEntriesRequest = {
   action: DictionaryAction;
+
   body: DictionaryEntry;
 };

package/model/batchParams.ts

@@ -1,10 +1,10 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { MultipleBatchOperation } from './multipleBatchOperation';
+import type { MultipleBatchRequest } from './multipleBatchRequest';
 
 /**
  * The `multipleBatch` parameters.
  */
 export type BatchParams = {
-  requests?: MultipleBatchOperation[];
+  requests: MultipleBatchRequest[];
 };

package/model/{batchOperation.ts → batchRequest.ts}

@@ -2,8 +2,9 @@
 
 import type { Action } from './action';
 
-export type BatchOperation = {
+export type BatchRequest = {
   action?: Action;
+
   /**
    * Arguments to the operation (depends on the type of the operation).
    */

package/model/batchResponse.ts

@@ -5,6 +5,7 @@ export type BatchResponse = {
    * TaskID of the task to wait for.
    */
   taskID: number;
+
   /**
    * List of objectID.
    */

package/model/batchWriteParams.ts

@@ -1,10 +1,10 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { BatchOperation } from './batchOperation';
+import type { BatchRequest } from './batchRequest';
 
 /**
  * The `batch` parameters.
  */
 export type BatchWriteParams = {
-  requests?: BatchOperation[];
+  requests?: BatchRequest[];
 };

package/model/browseRequest.ts

@@ -5,6 +5,7 @@ export type BrowseRequest = {
    * Search parameters as URL-encoded query string.
    */
   params?: string;
+
   /**
    * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
    */

package/model/browseResponse.ts

@@ -4,6 +4,6 @@ import type { BaseBrowseResponse } from './baseBrowseResponse';
 import type { BaseSearchResponse } from './baseSearchResponse';
 import type { SearchHits } from './searchHits';
 
-export type BrowseResponse<T> = BaseBrowseResponse &
+export type BrowseResponse<T = Record<string, any>> = BaseBrowseResponse &
   BaseSearchResponse &
   SearchHits<T>;

package/model/builtInOperation.ts

@@ -7,6 +7,7 @@ import type { BuiltInOperationType } from './builtInOperationType';
  */
 export type BuiltInOperation = {
   _operation: BuiltInOperationType;
+
   /**
    * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
    */

package/model/clientMethodProps.ts

@@ -1,18 +1,16 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { CreateRetryablePromiseOptions } from '@algolia/client-common';
+import type { CreateIterablePromise } from '@algolia/client-common';
 
 import type { ApiKey } from './apiKey';
 import type { AssignUserIdParams } from './assignUserIdParams';
-import type { AttributeOrBuiltInOperation } from './attributeOrBuiltInOperation';
+import type { AttributeToUpdate } from './attributeToUpdate';
 import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
 import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
 import type { BatchWriteParams } from './batchWriteParams';
 import type { BrowseRequest } from './browseRequest';
 import type { DictionaryType } from './dictionaryType';
-import type { GetTaskResponse } from './getTaskResponse';
 import type { IndexSettings } from './indexSettings';
-import type { Key } from './key';
 import type { LogType } from './logType';
 import type { OperationIndexParams } from './operationIndexParams';
 import type { Rule } from './rule';
@@ -428,11 +426,9 @@ export type PartialUpdateObjectProps = {
    */
   objectID: string;
   /**
-   * List of attributes to update.
+   * Map of attribute(s) to update.
    */
-  attributeOrBuiltInOperation: Array<
-    Record<string, AttributeOrBuiltInOperation>
-  >;
+  attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
    * Creates the record if it does not exist yet.
    */
@@ -546,7 +542,7 @@ export type SaveRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  rule: Rule[];
+  rules: Rule[];
   /**
    * When true, changes are also propagated to replicas of the given indexName.
    */
@@ -661,7 +657,7 @@ export type SearchRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchRulesParams: SearchRulesParams;
+  searchRulesParams?: SearchRulesParams;
 };
 
 /**
@@ -727,12 +723,27 @@ export type UpdateApiKeyProps = {
   apiKey: ApiKey;
 };
 
-type WaitForOptions<T> = Omit<
-  CreateRetryablePromiseOptions<T>,
-  'func' | 'validate'
->;
+/**
+ * The `browseObjects`, `browseRules`, `browseSynonyms` options.
+ */
+export type BrowseOptions<T> = Partial<
+  Pick<CreateIterablePromise<T>, 'validate'>
+> &
+  Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
+
+type WaitForOptions = Partial<{
+  /**
+   * The maximum number of retries. 50 by default.
+   */
+  maxRetries: number;
+
+  /**
+   * The function to decide how long to wait between retries.
+   */
+  timeout: (retryCount: number) => number;
+}>;
 
-export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
+export type WaitForTaskOptions = WaitForOptions & {
   /**
    * The `indexName` where the operation was performed.
    */
@@ -743,7 +754,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<Key> & {
+export type WaitForApiKeyOptions = WaitForOptions & {
   /**
    * The API Key.
    */

package/model/condition.ts

@@ -7,11 +7,14 @@ export type Condition = {
    * Query pattern syntax.
    */
   pattern?: string;
+
   anchoring?: Anchoring;
+
   /**
    * Whether the pattern matches on plurals, synonyms, and typos.
    */
   alternatives?: boolean;
+
   /**
    * Rule context format: [A-Za-z0-9_-]+).
    */

package/model/consequence.ts

@@ -9,18 +9,22 @@ import type { Promote } from './promote';
  */
 export type Consequence = {
   params?: ConsequenceParams;
+
   /**
    * Objects to promote as hits.
    */
   promote?: Promote[];
+
   /**
    * Only use in combination with the promote consequence. When true, promoted results will be restricted to match the filters of the current search. When false, the promoted results will show up regardless of the filters.
    */
   filterPromotes?: boolean;
+
   /**
    * Objects to hide from hits. Each object must contain an objectID field. By default, you can hide up to 50 items per rule.
    */
   hide?: ConsequenceHide[];
+
   /**
    * Custom JSON object that will be appended to the userData array in the response. This object isn\'t interpreted by the API. It\'s limited to 1kB of minified JSON.
    */

package/model/consequenceQueryObject.ts

@@ -7,6 +7,7 @@ export type ConsequenceQueryObject = {
    * Words to remove.
    */
   remove?: string[];
+
   /**
    * Edits to apply.
    */

package/model/deletedAtResponse.ts

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

package/model/dictionaryEntry.ts

@@ -10,21 +10,26 @@ export type DictionaryEntry = Record<string, any> & {
    * Unique identifier of the object.
    */
   objectID: string;
+
   /**
    * Language ISO code supported by the dictionary (e.g., \"en\" for English).
    */
   language: string;
+
   /**
    * The word of the dictionary entry.
    */
   word?: string;
+
   /**
    * The words of the dictionary entry.
    */
   words?: string[];
+
   /**
    * A decomposition of the word of the dictionary entry.
    */
   decomposition?: string[];
+
   state?: DictionaryEntryState;
 };

package/model/{createdAtObject.ts → distinct.ts}

@@ -1,8 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-export type CreatedAtObject = {
-  /**
-   * Date of creation (ISO-8601 format).
-   */
-  createdAt: string;
-};
+/**
+ * Enables de-duplication or grouping of results.
+ */
+export type Distinct = boolean | number;

package/model/edit.ts

@@ -4,10 +4,12 @@ import type { EditType } from './editType';
 
 export type Edit = {
   type?: EditType;
+
   /**
    * Text or patterns to remove from the query string.
    */
   delete?: string;
+
   /**
    * Text that should be inserted in place of the removed text inside the query string.
    */

package/model/facetHits.ts

@@ -5,10 +5,12 @@ export type FacetHits = {
    * Raw value of the facet.
    */
   value: string;
+
   /**
    * Markup text with occurrences highlighted.
    */
   highlighted: string;
+
   /**
    * How many objects contain this facet value. This takes into account the extra search parameters specified in the query. Like for a regular search query, the counts may not be exhaustive.
    */

package/model/facetOrdering.ts

@@ -8,6 +8,7 @@ import type { Value } from './value';
  */
 export type FacetOrdering = {
   facets?: Facets;
+
   /**
    * The ordering of facet values, within an individual list.
    */