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

package/model/condition.ts

@@ -0,0 +1,19 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Anchoring } from './anchoring';
+
+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_-]+).
+   */
+  context?: string;
+};

package/model/consequence.ts

@@ -0,0 +1,28 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ConsequenceHide } from './consequenceHide';
+import type { ConsequenceParams } from './consequenceParams';
+import type { Promote } from './promote';
+
+/**
+ * Consequence of the Rule.
+ */
+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.
+   */
+  userData?: Record<string, any>;
+};

package/model/consequenceHide.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Unique identifier of the object to hide.
+ */
+export type ConsequenceHide = {
+  /**
+   * Unique identifier of the object.
+   */
+  objectID: string;
+};

package/model/consequenceParams.ts

@@ -0,0 +1,9 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+
+export type ConsequenceParams = BaseSearchParamsWithoutQuery &
+  IndexSettingsAsSearchParams &
+  Params;

package/model/consequenceQuery.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ConsequenceQueryObject } from './consequenceQueryObject';
+
+/**
+ * When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can\'t do both).
+ */
+export type ConsequenceQuery = ConsequenceQueryObject | string;

package/model/consequenceQueryObject.ts

@@ -0,0 +1,14 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Edit } from './edit';
+
+export type ConsequenceQueryObject = {
+  /**
+   * Words to remove.
+   */
+  remove?: string[];
+  /**
+   * Edits to apply.
+   */
+  edits?: Edit[];
+};

package/model/createdAtObject.ts

@@ -0,0 +1,8 @@
+// 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;
+};

package/model/createdAtResponse.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The response with a createdAt timestamp.
+ */
+export type CreatedAtResponse = {
+  /**
+   * Date of creation (ISO-8601 format).
+   */
+  createdAt: string;
+};

package/model/deleteApiKeyResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type DeleteApiKeyResponse = {
+  /**
+   * Date of deletion (ISO-8601 format).
+   */
+  deletedAt: string;
+};

package/model/deleteSourceResponse.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type DeleteSourceResponse = {
+  /**
+   * Date of deletion (ISO-8601 format).
+   */
+  deletedAt: string;
+};

package/model/deletedAtResponse.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The response with a taskID and a deletedAt timestamp.
+ */
+export type DeletedAtResponse = {
+  /**
+   * TaskID of the task to wait for.
+   */
+  taskID: number;
+  /**
+   * Date of deletion (ISO-8601 format).
+   */
+  deletedAt: string;
+};

package/model/dictionaryAction.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Actions to perform.
+ */
+export type DictionaryAction = 'addEntry' | 'deleteEntry';

package/model/dictionaryEntry.ts

@@ -0,0 +1,30 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { DictionaryEntryState } from './dictionaryEntryState';
+
+/**
+ * A dictionary entry.
+ */
+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/dictionaryEntryState.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The state of the dictionary entry.
+ */
+export type DictionaryEntryState = 'disabled' | 'enabled';

package/model/dictionaryLanguage.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Custom entries for a dictionary.
+ */
+export type DictionaryLanguage = {
+  /**
+   * When nbCustomEntries is set to 0, the user didn\'t customize the dictionary. The dictionary is still supported with standard, Algolia-provided entries.
+   */
+  nbCustomEntires?: number;
+};

package/model/dictionarySettingsParams.ts

@@ -0,0 +1,10 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { StandardEntries } from './standardEntries';
+
+/**
+ * Disable the builtin Algolia entries for a type of dictionary per language.
+ */
+export type DictionarySettingsParams = {
+  disableStandardEntries: StandardEntries;
+};

package/model/dictionaryType.ts

@@ -0,0 +1,3 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type DictionaryType = 'compounds' | 'plurals' | 'stopwords';

package/model/edit.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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.
+   */
+  insert?: string;
+};

package/model/editType.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/exactOnSingleWordQuery.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Controls how the exact ranking criterion is computed when the query contains only one word.
+ */
+export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';

package/model/facetFilters.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MixedSearchFilters } from './mixedSearchFilters';
+
+/**
+ * Filter hits by facet value.
+ */
+export type FacetFilters = MixedSearchFilters[] | string;

package/model/facetHits.ts

@@ -0,0 +1,16 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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.
+   */
+  count: number;
+};

package/model/facetOrdering.ts

@@ -0,0 +1,15 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Facets } from './facets';
+import type { Value } from './value';
+
+/**
+ * Defining how facets should be ordered.
+ */
+export type FacetOrdering = {
+  facets?: Facets;
+  /**
+   * The ordering of facet values, within an individual list.
+   */
+  values?: Record<string, Value>;
+};

package/model/facets.ts

@@ -0,0 +1,11 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The ordering of facets (widgets).
+ */
+export type Facets = {
+  /**
+   * Pinned order of facet lists.
+   */
+  order?: string[];
+};

package/model/facetsStats.ts

@@ -0,0 +1,20 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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.
+   */
+  sum?: number;
+};

package/model/fetchedIndex.ts

@@ -0,0 +1,48 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+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.
+   */
+  replicas?: string[];
+};

package/model/getDictionarySettingsResponse.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { StandardEntries } from './standardEntries';
+
+export type GetDictionarySettingsResponse = {
+  disableStandardEntries: StandardEntries;
+};

package/model/getLogsResponse.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { Log } from './log';
+
+export type GetLogsResponse = {
+  logs: Log[];
+};

package/model/getObjectsParams.ts

@@ -0,0 +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';
+
+/**
+ * The `getObjects` parameters.
+ */
+export type GetObjectsParams = {
+  requests?: MultipleGetObjectsParams[];
+};

package/model/getObjectsResponse.ts

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

package/model/getTaskResponse.ts

@@ -0,0 +1,7 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { TaskStatus } from './taskStatus';
+
+export type GetTaskResponse = {
+  status: TaskStatus;
+};

package/model/getTopUserIdsResponse.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { UserId } from './userId';
+
+/**
+ * Array of userIDs and clusters.
+ */
+export type GetTopUserIdsResponse = {
+  /**
+   * Mapping of cluster names to top users.
+   */
+  topUsers: Array<Record<string, UserId[]>>;
+};

package/model/hasPendingMappingsResponse.ts

@@ -0,0 +1,12 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type HasPendingMappingsResponse = {
+  /**
+   * If there is any clusters with pending mapping state.
+   */
+  pending: boolean;
+  /**
+   * Describe cluster pending (migrating, creating, deleting) mapping state.
+   */
+  clusters?: Record<string, string[]>;
+};

package/model/highlightResult.ts

@@ -0,0 +1,5 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { HighlightResultOption } from './highlightResultOption';
+
+export type HighlightResult = HighlightResultOption | HighlightResultOption[];

package/model/highlightResultOption.ts

@@ -0,0 +1,22 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { MatchLevel } from './matchLevel';
+
+/**
+ * Show highlighted section and words matched on a query.
+ */
+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.
+   */
+  fullyHighlighted?: boolean;
+};

package/model/hit.ts

@@ -0,0 +1,25 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { HighlightResult } from './highlightResult';
+import type { RankingInfo } from './rankingInfo';
+import type { SnippetResult } from './snippetResult';
+
+/**
+ * A single hit.
+ */
+export type Hit<T> = 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/ignorePlurals.ts

@@ -0,0 +1,6 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
+ */
+export type IgnorePlurals = string[] | boolean;