algoliasearch 4.13.1 → 5.0.0-alpha.1

package/lite/model/baseSearchParamsWithoutQuery.ts

@@ -0,0 +1,125 @@
+// 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 { OptionalFilters } from './optionalFilters';
+import type { ReRankingApplyFilter } from './reRankingApplyFilter';
+import type { TagFilters } from './tagFilters';
+
+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/lite/model/baseSearchResponse.ts

@@ -0,0 +1,104 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { FacetsStats } from './facetsStats';
+import type { RenderingContent } from './renderingContent';
+
+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.
+   */
+  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, string>>;
+  /**
+   * 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/lite/model/browseResponse.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 { BaseBrowseResponse } from './baseBrowseResponse';
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+
+export type BrowseResponse<T> = BaseBrowseResponse &
+  BaseSearchResponse &
+  SearchHits<T>;

package/lite/model/builtInOperation.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 { BuiltInOperationType } from './builtInOperationType';
+
+/**
+ * To update an attribute without pushing the entire record, you can use these built-in operations.
+ */
+export type BuiltInOperation = {
+  _operation: BuiltInOperationType;
+  /**
+   * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+   */
+  value: string;
+};

package/lite/model/builtInOperationType.ts

@@ -0,0 +1,13 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+/**
+ * The operation to apply on the attribute.
+ */
+export type BuiltInOperationType =
+  | 'Add'
+  | 'AddUnique'
+  | 'Decrement'
+  | 'Increment'
+  | 'IncrementFrom'
+  | 'IncrementSet'
+  | 'Remove';

package/lite/model/clientMethodProps.ts

@@ -0,0 +1,55 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParamsObject } from './searchParamsObject';
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to be applied to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * The parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchParams = {
+  params?: SearchParamsObject;
+};
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
+
+/**
+ * In v4, the search parameters are wrapped in a `params` parameter.
+ *
+ * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
+ */
+type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
+
+type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
+
+/**
+ * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
+ *
+ * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
+ */
+export type LegacySearchMethodProps = LegacySearchQuery[];

package/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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/lite/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[];