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

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/{baseBrowseResponse.ts → cursor.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 BaseBrowseResponse = {
+export type Cursor = {
   /**
    * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
    */
-  cursor: string;
+  cursor?: string;
 };

package/model/deleteByParams.ts

@@ -0,0 +1,36 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { AroundRadius } from './aroundRadius';
+import type { FacetFilters } from './facetFilters';
+import type { NumericFilters } from './numericFilters';
+import type { TagFilters } from './tagFilters';
+
+export type DeleteByParams = {
+  facetFilters?: FacetFilters;
+
+  /**
+   * Filter the query with numeric, facet and/or tag filters.
+   */
+  filters?: string;
+
+  numericFilters?: NumericFilters;
+
+  tagFilters?: TagFilters;
+
+  /**
+   * Search for entries around a central geolocation, enabling a geo search within a circular area.
+   */
+  aroundLatLng?: string;
+
+  aroundRadius?: AroundRadius;
+
+  /**
+   * Search inside a rectangular area (in geo coordinates).
+   */
+  insideBoundingBox?: number[];
+
+  /**
+   * Search inside a polygon (in geo coordinates).
+   */
+  insidePolygon?: number[];
+};

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.
    */

package/model/facetsStats.ts

@@ -5,14 +5,17 @@ export type FacetsStats = {
    * The minimum value in the result set.
    */
   min?: number;
+
   /**
    * The maximum value in the result set.
    */
   max?: number;
+
   /**
    * The average facet value in the result set.
    */
   avg?: number;
+
   /**
    * The sum of all values in the result set.
    */

package/model/fetchedIndex.ts

@@ -5,42 +5,52 @@ export type FetchedIndex = {
    * Index name.
    */
   name: string;
+
   /**
    * Index creation date. An empty string means that the index has no records.
    */
   createdAt: string;
+
   /**
    * Date of last update (ISO-8601 format).
    */
   updatedAt: string;
+
   /**
    * Number of records contained in the index.
    */
   entries: number;
+
   /**
    * Number of bytes of the index in minified format.
    */
   dataSize: number;
+
   /**
    * Number of bytes of the index binary file.
    */
   fileSize: number;
+
   /**
    * Last build time.
    */
   lastBuildTimeS: number;
+
   /**
    * Number of pending indexing operations. This value is deprecated and should not be used.
    */
   numberOfPendingTask?: number;
+
   /**
    * A boolean which says whether the index has pending tasks. This value is deprecated and should not be used.
    */
   pendingTask: boolean;
+
   /**
    * Only present if the index is a replica. Contains the name of the related primary index.
    */
   primary?: string;
+
   /**
    * Only present if the index is a primary index with replicas. Contains the names of all linked replicas.
    */

package/model/{key.ts → getApiKeyResponse.ts}

@@ -1,6 +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';
+import type { BaseGetApiKeyResponse } from './baseGetApiKeyResponse';
 
-export type Key = ApiKey & CreatedAtObject;
+export type GetApiKeyResponse = ApiKey & BaseGetApiKeyResponse;

package/model/getObjectsParams.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 { MultipleGetObjectsParams } from './multipleGetObjectsParams';
+import type { GetObjectsRequest } from './getObjectsRequest';
 
 /**
  * The `getObjects` parameters.
  */
 export type GetObjectsParams = {
-  requests?: MultipleGetObjectsParams[];
+  requests: GetObjectsRequest[];
 };

package/model/{multipleGetObjectsParams.ts → getObjectsRequest.ts}

@@ -3,15 +3,17 @@
 /**
  * GetObjects operation on an index.
  */
-export type MultipleGetObjectsParams = {
+export type GetObjectsRequest = {
   /**
    * List of attributes to retrieve. By default, all retrievable attributes are returned.
    */
   attributesToRetrieve?: string[];
+
   /**
    * ID of the object within that index.
    */
   objectID: string;
+
   /**
    * Name of the index containing the object.
    */

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

@@ -10,10 +10,10 @@ export * from './apiKey';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './assignUserIdParams';
-export * from './attributeOrBuiltInOperation';
+export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
-export * from './baseBrowseResponse';
+export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
 export * from './baseSearchParamsWithoutQuery';
@@ -21,11 +21,12 @@ 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';
+export * from './browseParams';
+export * from './browseParamsObject';
 export * from './browseResponse';
 export * from './builtInOperation';
 export * from './builtInOperationType';
@@ -35,9 +36,10 @@ export * from './consequenceHide';
 export * from './consequenceParams';
 export * from './consequenceQuery';
 export * from './consequenceQueryObject';
-export * from './createdAtObject';
 export * from './createdAtResponse';
+export * from './cursor';
 export * from './deleteApiKeyResponse';
+export * from './deleteByParams';
 export * from './deleteSourceResponse';
 export * from './deletedAtResponse';
 export * from './dictionaryAction';
@@ -46,6 +48,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';
@@ -56,9 +59,11 @@ export * from './facetOrdering';
 export * from './facets';
 export * from './facetsStats';
 export * from './fetchedIndex';
+export * from './getApiKeyResponse';
 export * from './getDictionarySettingsResponse';
 export * from './getLogsResponse';
 export * from './getObjectsParams';
+export * from './getObjectsRequest';
 export * from './getObjectsResponse';
 export * from './getTaskResponse';
 export * from './getTopUserIdsResponse';
@@ -69,7 +74,6 @@ export * from './hit';
 export * from './ignorePlurals';
 export * from './indexSettings';
 export * from './indexSettingsAsSearchParams';
-export * from './key';
 export * from './languages';
 export * from './listApiKeysResponse';
 export * from './listClustersResponse';
@@ -81,9 +85,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';
@@ -136,7 +139,6 @@ export * from './sortRemainingBy';
 export * from './source';
 export * from './standardEntries';
 export * from './synonymHit';
-export * from './synonymHitHighlightResult';
 export * from './synonymType';
 export * from './tagFilters';
 export * from './taskStatus';

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[];
+
+  distinct?: Distinct;
+
   /**
-   * Enables de-duplication or grouping of results.
+   * Name of the de-duplication attribute to be used with the distinct feature.
    */
-  distinct?: number;
+  attributeForDistinct?: string;
+
   /**
    * 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/listApiKeysResponse.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 { Key } from './key';
+import type { GetApiKeyResponse } from './getApiKeyResponse';
 
 export type ListApiKeysResponse = {
   /**
    * List of api keys.
    */
-  keys: Key[];
+  keys: GetApiKeyResponse[];
 };

package/model/listIndicesResponse.ts

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