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

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

@@ -1,5 +1,5 @@
-/**
- * Removes stop (common) words from the query before executing it. RemoveStopWords 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 stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
- */
-export type RemoveStopWords = string[] | boolean;
+/**
+ * Removes stop (common) words from the query before executing it. RemoveStopWords 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 stop word functionality, ensuring that stop words are removed from consideration in a search. The languages supported here are either every language, or those set by queryLanguages. False: disables stop word functionality, allowing stop words to be taken into account in a search.
+ */
+export type RemoveStopWords = string[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

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

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

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

@@ -1,5 +1,5 @@
-/**
- * Selects a strategy to remove words from the query when it doesn\'t match any hits.
- */
-export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
+/**
+ * Selects a strategy to remove words from the query when it doesn\'t match any hits.
+ */
+export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

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

@@ -1,8 +1,8 @@
-import type { FacetOrdering } from './facetOrdering';
-/**
- * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
- */
-export type RenderingContent = {
-    facetOrdering?: FacetOrdering;
-};
+import type { FacetOrdering } from './facetOrdering';
+/**
+ * Content defining how the search interface should be rendered. Can be set via the settings for a default value and can be overridden via rules.
+ */
+export type RenderingContent = {
+    facetOrdering?: FacetOrdering;
+};
 //# sourceMappingURL=renderingContent.d.ts.map

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

@@ -1,7 +1,7 @@
-export type ReplaceSourceResponse = {
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+export type ReplaceSourceResponse = {
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=replaceSourceResponse.d.ts.map

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

@@ -1,30 +1,30 @@
-import type { Condition } from './condition';
-import type { Consequence } from './consequence';
-import type { TimeRange } from './timeRange';
-/**
- * Rule object.
- */
-export type Rule = {
-    /**
-     * Unique identifier of the object.
-     */
-    objectID: string;
-    /**
-     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
-     */
-    conditions?: Condition[];
-    consequence?: Consequence;
-    /**
-     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
-     */
-    description?: string;
-    /**
-     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
-     */
-    enabled?: boolean;
-    /**
-     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
-     */
-    validity?: TimeRange[];
-};
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { TimeRange } from './timeRange';
+/**
+ * Rule object.
+ */
+export type Rule = {
+    /**
+     * Unique identifier of the object.
+     */
+    objectID: string;
+    /**
+     * A list of conditions that should apply to activate a Rule. You can use up to 25 conditions per Rule.
+     */
+    conditions?: Condition[];
+    consequence?: Consequence;
+    /**
+     * This field is intended for Rule management purposes, in particular to ease searching for Rules and presenting them to human readers. It\'s not interpreted by the API.
+     */
+    description?: string;
+    /**
+     * Whether the Rule is enabled. Disabled Rules remain in the index, but aren\'t applied at query time.
+     */
+    enabled?: boolean;
+    /**
+     * By default, Rules are permanently valid. When validity periods are specified, the Rule applies only during those periods; it\'s ignored the rest of the time. The list must not be empty.
+     */
+    validity?: TimeRange[];
+};
 //# sourceMappingURL=rule.d.ts.map

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

@@ -1,12 +1,12 @@
-export type SaveObjectResponse = {
-    createdAt: string;
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * Unique identifier of the object.
-     */
-    objectID?: string;
-};
+export type SaveObjectResponse = {
+    createdAt: string;
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+    /**
+     * Unique identifier of the object.
+     */
+    objectID?: string;
+};
 //# sourceMappingURL=saveObjectResponse.d.ts.map

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

@@ -1,15 +1,15 @@
-export type SaveSynonymResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-    /**
-     * ObjectID of the inserted object.
-     */
-    id: string;
-};
+export type SaveSynonymResponse = {
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt: string;
+    /**
+     * ObjectID of the inserted object.
+     */
+    id: string;
+};
 //# sourceMappingURL=saveSynonymResponse.d.ts.map

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

@@ -1,2 +1,2 @@
-export type ScopeType = 'rules' | 'settings' | 'synonyms';
+export type ScopeType = 'rules' | 'settings' | 'synonyms';
 //# sourceMappingURL=scopeType.d.ts.map

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

@@ -1,22 +1,22 @@
-/**
- * The `searchDictionaryEntries` parameters.
- */
-export type SearchDictionaryEntriesParams = {
-    /**
-     * The text to search in the index.
-     */
-    query: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-    /**
-     * Language ISO code supported by the dictionary (e.g., \"en\" for English).
-     */
-    language?: string;
-};
+/**
+ * The `searchDictionaryEntries` parameters.
+ */
+export type SearchDictionaryEntriesParams = {
+    /**
+     * The text to search in the index.
+     */
+    query: string;
+    /**
+     * Specify the page to retrieve.
+     */
+    page?: number;
+    /**
+     * Set the number of hits per page.
+     */
+    hitsPerPage?: number;
+    /**
+     * Language ISO code supported by the dictionary (e.g., \"en\" for English).
+     */
+    language?: string;
+};
 //# sourceMappingURL=searchDictionaryEntriesParams.d.ts.map

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

@@ -1,15 +1,15 @@
-export type SearchForFacetValuesRequest = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: string;
-    /**
-     * Text to search inside the facet\'s values.
-     */
-    facetQuery?: 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;
-};
+export type SearchForFacetValuesRequest = {
+    /**
+     * Search parameters as URL-encoded query string.
+     */
+    params?: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: 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;
+};
 //# sourceMappingURL=searchForFacetValuesRequest.d.ts.map

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

@@ -1,5 +1,5 @@
-import type { FacetHits } from './facetHits';
-export type SearchForFacetValuesResponse = {
-    facetHits: FacetHits[];
-};
+import type { FacetHits } from './facetHits';
+export type SearchForFacetValuesResponse = {
+    facetHits: FacetHits[];
+};
 //# sourceMappingURL=searchForFacetValuesResponse.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchForFacetsOptions } from './searchForFacetsOptions';
-import type { SearchParams } from './searchParams';
-export type SearchForFacets = SearchForFacetsOptions & SearchParams;
+import type { SearchForFacetsOptions } from './searchForFacetsOptions';
+import type { SearchParams } from './searchParams';
+export type SearchForFacets = SearchForFacetsOptions & SearchParams;
 //# sourceMappingURL=searchForFacets.d.ts.map

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

@@ -1,21 +1,21 @@
-import type { SearchTypeFacet } from './searchTypeFacet';
-export type SearchForFacetsOptions = {
-    /**
-     * The `facet` name.
-     */
-    facet: string;
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    /**
-     * Text to search inside the facet\'s values.
-     */
-    facetQuery?: 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;
-    type: SearchTypeFacet;
-};
+import type { SearchTypeFacet } from './searchTypeFacet';
+export type SearchForFacetsOptions = {
+    /**
+     * The `facet` name.
+     */
+    facet: string;
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    /**
+     * Text to search inside the facet\'s values.
+     */
+    facetQuery?: 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;
+    type: SearchTypeFacet;
+};
 //# sourceMappingURL=searchForFacetsOptions.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchForHitsOptions } from './searchForHitsOptions';
-import type { SearchParams } from './searchParams';
-export type SearchForHits = SearchForHitsOptions & SearchParams;
+import type { SearchForHitsOptions } from './searchForHitsOptions';
+import type { SearchParams } from './searchParams';
+export type SearchForHits = SearchForHitsOptions & SearchParams;
 //# sourceMappingURL=searchForHits.d.ts.map

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

@@ -1,13 +1,13 @@
-import type { SearchTypeDefault } from './searchTypeDefault';
-export type SearchForHitsOptions = {
-    /**
-     * The Algolia index name.
-     */
-    indexName: string;
-    type?: SearchTypeDefault;
-} & {
-    facet?: never;
-    maxFacetHits?: never;
-    facetQuery?: never;
-};
+import type { SearchTypeDefault } from './searchTypeDefault';
+export type SearchForHitsOptions = {
+    /**
+     * The Algolia index name.
+     */
+    indexName: string;
+    type?: SearchTypeDefault;
+} & {
+    facet?: never;
+    maxFacetHits?: never;
+    facetQuery?: never;
+};
 //# sourceMappingURL=searchForHitsOptions.d.ts.map

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

@@ -1,5 +1,5 @@
-import type { Hit } from './hit';
-export type SearchHits<T = Record<string, any>> = {
-    hits: Array<Hit<T>>;
-};
+import type { Hit } from './hit';
+export type SearchHits<T = Record<string, any>> = {
+    hits: Array<Hit<T>>;
+};
 //# sourceMappingURL=searchHits.d.ts.map

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

@@ -1,7 +1,7 @@
-import type { SearchQuery } from './searchQuery';
-import type { SearchStrategy } from './searchStrategy';
-export type SearchMethodParams = {
-    requests: SearchQuery[];
-    strategy?: SearchStrategy;
-};
+import type { SearchQuery } from './searchQuery';
+import type { SearchStrategy } from './searchStrategy';
+export type SearchMethodParams = {
+    requests: SearchQuery[];
+    strategy?: SearchStrategy;
+};
 //# sourceMappingURL=searchMethodParams.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchParamsObject } from './searchParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export type SearchParams = SearchParamsObject | SearchParamsString;
+import type { SearchParamsObject } from './searchParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+export type SearchParams = SearchParamsObject | SearchParamsString;
 //# sourceMappingURL=searchParams.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { BaseSearchParams } from './baseSearchParams';
-import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
-export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
+import type { BaseSearchParams } from './baseSearchParams';
+import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

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

@@ -1,7 +1,7 @@
-export type SearchParamsQuery = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+export type SearchParamsQuery = {
+    /**
+     * The text to search in the index.
+     */
+    query?: string;
+};
 //# sourceMappingURL=searchParamsQuery.d.ts.map

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

@@ -1,7 +1,7 @@
-export type SearchParamsString = {
-    /**
-     * Search parameters as URL-encoded query string.
-     */
-    params?: string;
-};
+export type SearchParamsString = {
+    /**
+     * Search parameters as URL-encoded query string.
+     */
+    params?: string;
+};
 //# sourceMappingURL=searchParamsString.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { SearchForFacets } from './searchForFacets';
-import type { SearchForHits } from './searchForHits';
-export type SearchQuery = SearchForFacets | SearchForHits;
+import type { SearchForFacets } from './searchForFacets';
+import type { SearchForHits } from './searchForHits';
+export type SearchQuery = SearchForFacets | SearchForHits;
 //# sourceMappingURL=searchQuery.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { SearchHits } from './searchHits';
-export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+export type SearchResponse<T = Record<string, any>> = BaseSearchResponse & SearchHits<T>;
 //# sourceMappingURL=searchResponse.d.ts.map

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

@@ -1,5 +1,5 @@
-import type { SearchResponse } from './searchResponse';
-export type SearchResponses<T = Record<string, any>> = {
-    results: Array<SearchResponse<T>>;
-};
+import type { SearchResponse } from './searchResponse';
+export type SearchResponses<T = Record<string, any>> = {
+    results: Array<SearchResponse<T>>;
+};
 //# sourceMappingURL=searchResponses.d.ts.map

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

@@ -1,32 +1,32 @@
-import type { Anchoring } from './anchoring';
-/**
- * Parameters for the search.
- */
-export type SearchRulesParams = {
-    /**
-     * Full text query.
-     */
-    query?: string;
-    anchoring?: Anchoring;
-    /**
-     * Restricts matches to contextual rules with a specific context (exact match).
-     */
-    context?: string;
-    /**
-     * Requested page (zero-based).
-     */
-    page?: number;
-    /**
-     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
-     */
-    hitsPerPage?: number;
-    /**
-     * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
-     */
-    enabled?: boolean | null;
-    /**
-     * A mapping of requestOptions to send along with the request.
-     */
-    requestOptions?: Array<Record<string, any>>;
-};
+import type { Anchoring } from './anchoring';
+/**
+ * Parameters for the search.
+ */
+export type SearchRulesParams = {
+    /**
+     * Full text query.
+     */
+    query?: string;
+    anchoring?: Anchoring;
+    /**
+     * Restricts matches to contextual rules with a specific context (exact match).
+     */
+    context?: string;
+    /**
+     * Requested page (zero-based).
+     */
+    page?: number;
+    /**
+     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+     */
+    hitsPerPage?: number;
+    /**
+     * When specified, restricts matches to rules with a specific enabled status. When absent (default), all rules are retrieved, regardless of their enabled status.
+     */
+    enabled?: boolean | null;
+    /**
+     * A mapping of requestOptions to send along with the request.
+     */
+    requestOptions?: Array<Record<string, any>>;
+};
 //# sourceMappingURL=searchRulesParams.d.ts.map

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

@@ -1,20 +1,20 @@
-import type { Rule } from './rule';
-export type SearchRulesResponse = {
-    /**
-     * Fetched rules.
-     */
-    hits: Rule[];
-    /**
-     * Number of fetched rules.
-     */
-    nbHits: number;
-    /**
-     * Current page.
-     */
-    page: number;
-    /**
-     * Number of pages.
-     */
-    nbPages: number;
-};
+import type { Rule } from './rule';
+export type SearchRulesResponse = {
+    /**
+     * Fetched rules.
+     */
+    hits: Rule[];
+    /**
+     * Number of fetched rules.
+     */
+    nbHits: number;
+    /**
+     * Current page.
+     */
+    page: number;
+    /**
+     * Number of pages.
+     */
+    nbPages: number;
+};
 //# sourceMappingURL=searchRulesResponse.d.ts.map

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

@@ -1,2 +1,2 @@
-export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
+export type SearchStrategy = 'none' | 'stopIfEnoughMatches';
 //# sourceMappingURL=searchStrategy.d.ts.map

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

@@ -1,7 +1,7 @@
-export type SearchSynonymsParams = {
-    /**
-     * The text to search in the index.
-     */
-    query?: string;
-};
+export type SearchSynonymsParams = {
+    /**
+     * The text to search in the index.
+     */
+    query?: string;
+};
 //# sourceMappingURL=searchSynonymsParams.d.ts.map

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

@@ -1,12 +1,12 @@
-import type { SynonymHit } from './synonymHit';
-export type SearchSynonymsResponse = Record<string, any> & {
-    /**
-     * Array of synonym objects.
-     */
-    hits: SynonymHit[];
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+import type { SynonymHit } from './synonymHit';
+export type SearchSynonymsResponse = Record<string, any> & {
+    /**
+     * Array of synonym objects.
+     */
+    hits: SynonymHit[];
+    /**
+     * Number of hits that the search query matched.
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=searchSynonymsResponse.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export type SearchTypeDefault = 'default';
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeDefault = 'default';
 //# sourceMappingURL=searchTypeDefault.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Perform a search query with `default`, will search for facet values if `facet` is given.
- */
-export type SearchTypeFacet = 'facet';
+/**
+ * Perform a search query with `default`, will search for facet values if `facet` is given.
+ */
+export type SearchTypeFacet = 'facet';
 //# sourceMappingURL=searchTypeFacet.d.ts.map