algoliasearch 5.0.0-alpha.52 → 5.0.0-alpha.54

package/dist/lite/model/builtInOperation.d.ts

@@ -1,12 +1,12 @@
-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;
-};
+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;
+};
 //# sourceMappingURL=builtInOperation.d.ts.map

package/dist/lite/model/builtInOperationType.d.ts

@@ -1,5 +1,5 @@
-/**
- * The operation to apply on the attribute.
- */
-export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
+/**
+ * The operation to apply on the attribute.
+ */
+export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
 //# sourceMappingURL=builtInOperationType.d.ts.map

package/dist/lite/model/clientMethodProps.d.ts

@@ -1,49 +1,49 @@
-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[];
-export {};
+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[];
+export {};
 //# sourceMappingURL=clientMethodProps.d.ts.map

package/dist/lite/model/condition.d.ts

@@ -1,17 +1,17 @@
-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;
-};
+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;
+};
 //# sourceMappingURL=condition.d.ts.map

package/dist/lite/model/consequence.d.ts

@@ -1,26 +1,26 @@
-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>;
-};
+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>;
+};
 //# sourceMappingURL=consequence.d.ts.map

package/dist/lite/model/consequenceHide.d.ts

@@ -1,10 +1,10 @@
-/**
- * Unique identifier of the object to hide.
- */
-export type ConsequenceHide = {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-};
+/**
+ * Unique identifier of the object to hide.
+ */
+export type ConsequenceHide = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+};
 //# sourceMappingURL=consequenceHide.d.ts.map

package/dist/lite/model/consequenceParams.d.ts

@@ -1,5 +1,5 @@
-import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-import type { Params } from './params';
-export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
+import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+import type { Params } from './params';
+export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
 //# sourceMappingURL=consequenceParams.d.ts.map

package/dist/lite/model/consequenceQuery.d.ts

@@ -1,6 +1,6 @@
-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;
+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;
 //# sourceMappingURL=consequenceQuery.d.ts.map

package/dist/lite/model/consequenceQueryObject.d.ts

@@ -1,12 +1,12 @@
-import type { Edit } from './edit';
-export type ConsequenceQueryObject = {
-    /**
-     * Words to remove.
-     */
-    remove?: string[];
-    /**
-     * Edits to apply.
-     */
-    edits?: Edit[];
-};
+import type { Edit } from './edit';
+export type ConsequenceQueryObject = {
+    /**
+     * Words to remove.
+     */
+    remove?: string[];
+    /**
+     * Edits to apply.
+     */
+    edits?: Edit[];
+};
 //# sourceMappingURL=consequenceQueryObject.d.ts.map

package/dist/lite/model/cursor.d.ts

@@ -1,7 +1,7 @@
-export type Cursor = {
-    /**
-     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
-     */
-    cursor?: string;
-};
+export type Cursor = {
+    /**
+     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+     */
+    cursor?: string;
+};
 //# sourceMappingURL=cursor.d.ts.map

package/dist/lite/model/deleteByParams.d.ts

@@ -1,27 +1,27 @@
-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[];
-};
+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[];
+};
 //# sourceMappingURL=deleteByParams.d.ts.map

package/dist/lite/model/dictionaryAction.d.ts

@@ -1,5 +1,5 @@
-/**
- * Actions to perform.
- */
-export type DictionaryAction = 'addEntry' | 'deleteEntry';
+/**
+ * Actions to perform.
+ */
+export type DictionaryAction = 'addEntry' | 'deleteEntry';
 //# sourceMappingURL=dictionaryAction.d.ts.map

package/dist/lite/model/dictionaryEntry.d.ts

@@ -1,28 +1,28 @@
-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;
-};
+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;
+};
 //# sourceMappingURL=dictionaryEntry.d.ts.map

package/dist/lite/model/dictionaryEntryState.d.ts

@@ -1,5 +1,5 @@
-/**
- * The state of the dictionary entry.
- */
-export type DictionaryEntryState = 'disabled' | 'enabled';
+/**
+ * The state of the dictionary entry.
+ */
+export type DictionaryEntryState = 'disabled' | 'enabled';
 //# sourceMappingURL=dictionaryEntryState.d.ts.map

package/dist/lite/model/dictionaryLanguage.d.ts

@@ -1,10 +1,10 @@
-/**
- * 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;
-};
+/**
+ * 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;
+};
 //# sourceMappingURL=dictionaryLanguage.d.ts.map

package/dist/lite/model/dictionaryType.d.ts

@@ -1,2 +1,2 @@
-export type DictionaryType = 'compounds' | 'plurals' | 'stopwords';
+export type DictionaryType = 'compounds' | 'plurals' | 'stopwords';
 //# sourceMappingURL=dictionaryType.d.ts.map

package/dist/lite/model/distinct.d.ts

@@ -1,5 +1,5 @@
-/**
- * Enables de-duplication or grouping of results.
- */
-export type Distinct = boolean | number;
+/**
+ * Enables de-duplication or grouping of results.
+ */
+export type Distinct = boolean | number;
 //# sourceMappingURL=distinct.d.ts.map

package/dist/lite/model/edit.d.ts

@@ -1,13 +1,13 @@
-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;
-};
+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;
+};
 //# sourceMappingURL=edit.d.ts.map

package/dist/lite/model/editType.d.ts

@@ -1,5 +1,5 @@
-/**
- * Type of edit.
- */
-export type EditType = 'remove' | 'replace';
+/**
+ * Type of edit.
+ */
+export type EditType = 'remove' | 'replace';
 //# sourceMappingURL=editType.d.ts.map

package/dist/lite/model/errorBase.d.ts

@@ -1,7 +1,7 @@
-/**
- * Error.
- */
-export type ErrorBase = Record<string, any> & {
-    message?: string;
-};
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+    message?: string;
+};
 //# sourceMappingURL=errorBase.d.ts.map

package/dist/lite/model/exactOnSingleWordQuery.d.ts

@@ -1,5 +1,5 @@
-/**
- * Controls how the exact ranking criterion is computed when the query contains only one word.
- */
-export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
+/**
+ * Controls how the exact ranking criterion is computed when the query contains only one word.
+ */
+export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
 //# sourceMappingURL=exactOnSingleWordQuery.d.ts.map

package/dist/lite/model/facetFilters.d.ts

@@ -1,6 +1,6 @@
-import type { MixedSearchFilters } from './mixedSearchFilters';
-/**
- * Filter hits by facet value.
- */
-export type FacetFilters = MixedSearchFilters[] | string;
+import type { MixedSearchFilters } from './mixedSearchFilters';
+/**
+ * Filter hits by facet value.
+ */
+export type FacetFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=facetFilters.d.ts.map

package/dist/lite/model/facetOrdering.d.ts

@@ -1,13 +1,13 @@
-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>;
-};
+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>;
+};
 //# sourceMappingURL=facetOrdering.d.ts.map

package/dist/lite/model/facets.d.ts

@@ -1,10 +1,10 @@
-/**
- * The ordering of facets (widgets).
- */
-export type Facets = {
-    /**
-     * Pinned order of facet lists.
-     */
-    order?: string[];
-};
+/**
+ * The ordering of facets (widgets).
+ */
+export type Facets = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+};
 //# sourceMappingURL=facets.d.ts.map

package/dist/lite/model/facetsStats.d.ts

@@ -1,19 +1,19 @@
-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;
-};
+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;
+};
 //# sourceMappingURL=facetsStats.d.ts.map