algoliasearch 5.0.0-alpha.53 → 5.0.0-alpha.54

package/dist/client-search/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/client-search/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/client-search/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/client-search/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/client-search/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/client-search/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/client-search/model/createdAtResponse.d.ts

@@ -1,10 +1,10 @@
-/**
- * The response with a createdAt timestamp.
- */
-export type CreatedAtResponse = {
-    /**
-     * Date of creation (ISO-8601 format).
-     */
-    createdAt: string;
-};
+/**
+ * The response with a createdAt timestamp.
+ */
+export type CreatedAtResponse = {
+    /**
+     * Date of creation (ISO-8601 format).
+     */
+    createdAt: string;
+};
 //# sourceMappingURL=createdAtResponse.d.ts.map

package/dist/client-search/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/client-search/model/deleteApiKeyResponse.d.ts

@@ -1,7 +1,7 @@
-export type DeleteApiKeyResponse = {
-    /**
-     * Date of deletion (ISO-8601 format).
-     */
-    deletedAt: string;
-};
+export type DeleteApiKeyResponse = {
+    /**
+     * Date of deletion (ISO-8601 format).
+     */
+    deletedAt: string;
+};
 //# sourceMappingURL=deleteApiKeyResponse.d.ts.map

package/dist/client-search/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/client-search/model/deleteSourceResponse.d.ts

@@ -1,7 +1,7 @@
-export type DeleteSourceResponse = {
-    /**
-     * Date of deletion (ISO-8601 format).
-     */
-    deletedAt: string;
-};
+export type DeleteSourceResponse = {
+    /**
+     * Date of deletion (ISO-8601 format).
+     */
+    deletedAt: string;
+};
 //# sourceMappingURL=deleteSourceResponse.d.ts.map

package/dist/client-search/model/deletedAtResponse.d.ts

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

package/dist/client-search/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/client-search/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/client-search/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/client-search/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/client-search/model/dictionarySettingsParams.d.ts

@@ -1,8 +1,8 @@
-import type { StandardEntries } from './standardEntries';
-/**
- * Disable the builtin Algolia entries for a type of dictionary per language.
- */
-export type DictionarySettingsParams = {
-    disableStandardEntries: StandardEntries;
-};
+import type { StandardEntries } from './standardEntries';
+/**
+ * Disable the builtin Algolia entries for a type of dictionary per language.
+ */
+export type DictionarySettingsParams = {
+    disableStandardEntries: StandardEntries;
+};
 //# sourceMappingURL=dictionarySettingsParams.d.ts.map

package/dist/client-search/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/client-search/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/client-search/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/client-search/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/client-search/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/client-search/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/client-search/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/client-search/model/facetHits.d.ts

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

package/dist/client-search/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/client-search/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/client-search/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