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

package/model/addApiKeyResponse.ts

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

package/model/apiKey.ts

@@ -10,30 +10,37 @@ export type ApiKey = {
    * Set of permissions associated with the key.
    */
   acl: Acl[];
+
   /**
    * A comment used to identify a key more easily in the dashboard. It is not interpreted by the API.
    */
   description?: string;
+
   /**
    * Restrict this new API key to a list of indices or index patterns. If the list is empty, all indices are allowed.
    */
   indexes?: string[];
+
   /**
    * Maximum number of hits this API key can retrieve in one query. If zero, no limit is enforced.
    */
   maxHitsPerQuery?: number;
+
   /**
    * Maximum number of API calls per hour allowed from a given IP address or a user token.
    */
   maxQueriesPerIPPerHour?: number;
+
   /**
    * URL-encoded query string. Force some query parameters to be applied for each query made with this API key.
    */
   queryParameters?: string;
+
   /**
    * Restrict this new API key to specific referers. If empty or blank, defaults to all referers.
    */
   referers?: string[];
+
   /**
    * Validity limit for this key in seconds. The key will automatically be removed after this period of time.
    */

package/model/{attributeOrBuiltInOperation.ts → attributeToUpdate.ts}

@@ -2,4 +2,4 @@
 
 import type { BuiltInOperation } from './builtInOperation';
 
-export type AttributeOrBuiltInOperation = BuiltInOperation | string;
+export type AttributeToUpdate = BuiltInOperation | string;

package/model/automaticFacetFilter.ts

@@ -8,10 +8,12 @@ export type AutomaticFacetFilter = {
    * Attribute to filter on. This must match a facet placeholder in the Rule\'s pattern.
    */
   facet: string;
+
   /**
    * Score for the filter. Typically used for optional or disjunctive filters.
    */
   score?: number;
+
   /**
    * Whether the filter is disjunctive (true) or conjunctive (false).
    */

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,72 @@ export type BaseIndexSettings = {
    * Creates replicas, exact copies of an index.
    */
   replicas?: string[];
+
   /**
    * Set the maximum number of hits accessible via pagination.
    */
   paginationLimitedTo?: number;
+
+  /**
+   * List of attributes that can\'t be retrieved at query time.
+   */
+  unretrievableAttributes?: string[];
+
   /**
    * 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;
+  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,10 +2,11 @@
 
 import type { Action } from './action';
 
-export type BatchOperation = {
-  action?: Action;
+export type BatchRequest = {
+  action: Action;
+
   /**
    * Arguments to the operation (depends on the type of the operation).
    */
-  body?: Record<string, any>;
+  body: Record<string, any>;
 };

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/browseParams.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 { BrowseParamsObject } from './browseParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+
+export type BrowseParams = BrowseParamsObject | SearchParamsString;

package/model/browseParamsObject.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 { Cursor } from './cursor';
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type BrowseParamsObject = Cursor & SearchParamsObject;

package/model/browseResponse.ts

@@ -1,9 +1,9 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { BaseBrowseResponse } from './baseBrowseResponse';
 import type { BaseSearchResponse } from './baseSearchResponse';
+import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
-export type BrowseResponse<T> = BaseBrowseResponse &
-  BaseSearchResponse &
+export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
+  Cursor &
   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,17 @@
 // 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 { BrowseParams } from './browseParams';
+import type { DeleteByParams } from './deleteByParams';
 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';
@@ -98,7 +97,7 @@ export type BrowseProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  browseRequest?: BrowseRequest;
+  browseParams?: BrowseParams;
 };
 
 /**
@@ -171,7 +170,7 @@ export type DeleteByProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchParams: SearchParams;
+  deleteByParams: DeleteByParams;
 };
 
 /**
@@ -428,11 +427,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 +543,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 +658,7 @@ export type SearchRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchRulesParams: SearchRulesParams;
+  searchRulesParams?: SearchRulesParams;
 };
 
 /**
@@ -727,12 +724,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 +755,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_-]+).
    */