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

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

@@ -1,22 +1,22 @@
-/**
- * OK.
- */
-export type SearchUserIdsParams = {
-    /**
-     * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
-     */
-    query: string;
-    /**
-     * Name of the cluster.
-     */
-    clusterName?: string;
-    /**
-     * Specify the page to retrieve.
-     */
-    page?: number;
-    /**
-     * Set the number of hits per page.
-     */
-    hitsPerPage?: number;
-};
+/**
+ * OK.
+ */
+export type SearchUserIdsParams = {
+    /**
+     * Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users.
+     */
+    query: string;
+    /**
+     * Name of the cluster.
+     */
+    clusterName?: string;
+    /**
+     * Specify the page to retrieve.
+     */
+    page?: number;
+    /**
+     * Set the number of hits per page.
+     */
+    hitsPerPage?: number;
+};
 //# sourceMappingURL=searchUserIdsParams.d.ts.map

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

@@ -1,27 +1,27 @@
-import type { UserHit } from './userHit';
-/**
- * UserIDs data.
- */
-export type SearchUserIdsResponse = {
-    /**
-     * List of user object matching the query.
-     */
-    hits: UserHit[];
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-    /**
-     * Specify the page to retrieve.
-     */
-    page: number;
-    /**
-     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
-     */
-    hitsPerPage: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+import type { UserHit } from './userHit';
+/**
+ * UserIDs data.
+ */
+export type SearchUserIdsResponse = {
+    /**
+     * List of user object matching the query.
+     */
+    hits: UserHit[];
+    /**
+     * Number of hits that the search query matched.
+     */
+    nbHits: number;
+    /**
+     * Specify the page to retrieve.
+     */
+    page: number;
+    /**
+     * Maximum number of hits in a page. Minimum is 1, maximum is 1000.
+     */
+    hitsPerPage: number;
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=searchUserIdsResponse.d.ts.map

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

@@ -1,3 +1,3 @@
-import type { SnippetResultOption } from './snippetResultOption';
-export type SnippetResult = SnippetResultOption | SnippetResultOption[];
+import type { SnippetResultOption } from './snippetResultOption';
+export type SnippetResult = SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

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

@@ -1,12 +1,12 @@
-import type { MatchLevel } from './matchLevel';
-/**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
- */
-export type SnippetResultOption = {
-    /**
-     * Markup text with occurrences highlighted.
-     */
-    value: string;
-    matchLevel: MatchLevel;
-};
+import type { MatchLevel } from './matchLevel';
+/**
+ * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ */
+export type SnippetResultOption = {
+    /**
+     * Markup text with occurrences highlighted.
+     */
+    value: string;
+    matchLevel: MatchLevel;
+};
 //# sourceMappingURL=snippetResultOption.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
- */
-export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
+/**
+ * How to display the remaining items.   - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ */
+export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

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

@@ -1,14 +1,14 @@
-/**
- * The source.
- */
-export type Source = {
-    /**
-     * The IP range of the source.
-     */
-    source: string;
-    /**
-     * The description of the source.
-     */
-    description?: string;
-};
+/**
+ * The source.
+ */
+export type Source = {
+    /**
+     * The IP range of the source.
+     */
+    source: string;
+    /**
+     * The description of the source.
+     */
+    description?: string;
+};
 //# sourceMappingURL=source.d.ts.map

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

@@ -1,18 +1,18 @@
-/**
- * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
- */
-export type StandardEntries = {
-    /**
-     * Language ISO code.
-     */
-    plurals?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    stopwords?: Record<string, boolean> | null;
-    /**
-     * Language ISO code.
-     */
-    compounds?: Record<string, boolean> | null;
-};
+/**
+ * Map of language ISO code supported by the dictionary (e.g., \"en\" for English) to a boolean value.
+ */
+export type StandardEntries = {
+    /**
+     * Language ISO code.
+     */
+    plurals?: Record<string, boolean> | null;
+    /**
+     * Language ISO code.
+     */
+    stopwords?: Record<string, boolean> | null;
+    /**
+     * Language ISO code.
+     */
+    compounds?: Record<string, boolean> | null;
+};
 //# sourceMappingURL=standardEntries.d.ts.map

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

@@ -1,36 +1,36 @@
-import type { SynonymType } from './synonymType';
-/**
- * Synonym object.
- */
-export type SynonymHit = {
-    /**
-     * Unique identifier of the synonym object to be created or updated.
-     */
-    objectID: string;
-    type: SynonymType;
-    /**
-     * Words or phrases to be considered equivalent.
-     */
-    synonyms?: string[];
-    /**
-     * Word or phrase to appear in query strings (for onewaysynonym).
-     */
-    input?: string;
-    /**
-     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
-     */
-    word?: string;
-    /**
-     * Words to be matched in records.
-     */
-    corrections?: string[];
-    /**
-     * Token to be put inside records.
-     */
-    placeholder?: string;
-    /**
-     * List of query words that will match the token.
-     */
-    replacements?: string[];
-};
+import type { SynonymType } from './synonymType';
+/**
+ * Synonym object.
+ */
+export type SynonymHit = {
+    /**
+     * Unique identifier of the synonym object to be created or updated.
+     */
+    objectID: string;
+    type: SynonymType;
+    /**
+     * Words or phrases to be considered equivalent.
+     */
+    synonyms?: string[];
+    /**
+     * Word or phrase to appear in query strings (for onewaysynonym).
+     */
+    input?: string;
+    /**
+     * Word or phrase to appear in query strings (for altcorrection1 and altcorrection2).
+     */
+    word?: string;
+    /**
+     * Words to be matched in records.
+     */
+    corrections?: string[];
+    /**
+     * Token to be put inside records.
+     */
+    placeholder?: string;
+    /**
+     * List of query words that will match the token.
+     */
+    replacements?: string[];
+};
 //# sourceMappingURL=synonymHit.d.ts.map

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

@@ -1,5 +1,5 @@
-/**
- * Type of the synonym object.
- */
-export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
+/**
+ * Type of the synonym object.
+ */
+export type SynonymType = 'altcorrection1' | 'altcorrection2' | 'onewaysynonym' | 'placeholder' | 'synonym';
 //# sourceMappingURL=synonymType.d.ts.map

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

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

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

@@ -1,2 +1,2 @@
-export type TaskStatus = 'notPublished' | 'published';
+export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

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

@@ -1,11 +1,11 @@
-export type TimeRange = {
-    /**
-     * Lower bound of the time range (Unix timestamp).
-     */
-    from: number;
-    /**
-     * Upper bound of the time range (Unix timestamp).
-     */
-    until: number;
-};
+export type TimeRange = {
+    /**
+     * Lower bound of the time range (Unix timestamp).
+     */
+    from: number;
+    /**
+     * Upper bound of the time range (Unix timestamp).
+     */
+    until: number;
+};
 //# sourceMappingURL=timeRange.d.ts.map

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

@@ -1,6 +1,6 @@
-import type { TypoToleranceEnum } from './typoToleranceEnum';
-/**
- * Controls whether typo tolerance is enabled and how it is applied.
- */
-export type TypoTolerance = TypoToleranceEnum | boolean;
+import type { TypoToleranceEnum } from './typoToleranceEnum';
+/**
+ * Controls whether typo tolerance is enabled and how it is applied.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

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

@@ -1,2 +1,2 @@
-export type TypoToleranceEnum = 'min' | 'strict';
+export type TypoToleranceEnum = 'min' | 'strict';
 //# sourceMappingURL=typoToleranceEnum.d.ts.map

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

@@ -1,11 +1,11 @@
-export type UpdateApiKeyResponse = {
-    /**
-     * The API key.
-     */
-    key: string;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+export type UpdateApiKeyResponse = {
+    /**
+     * The API key.
+     */
+    key: string;
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=updateApiKeyResponse.d.ts.map

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

@@ -1,14 +1,14 @@
-/**
- * The response with a taskID and an updatedAt timestamp.
- */
-export type UpdatedAtResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+/**
+ * The response with a taskID and an updatedAt timestamp.
+ */
+export type UpdatedAtResponse = {
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=updatedAtResponse.d.ts.map

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

@@ -1,18 +1,18 @@
-/**
- * The response with a taskID, an objectID and an updatedAt timestamp.
- */
-export type UpdatedAtWithObjectIdResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID?: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt?: string;
-    /**
-     * Unique identifier of the object.
-     */
-    objectID?: string;
-};
+/**
+ * The response with a taskID, an objectID and an updatedAt timestamp.
+ */
+export type UpdatedAtWithObjectIdResponse = {
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID?: number;
+    /**
+     * Date of last update (ISO-8601 format).
+     */
+    updatedAt?: string;
+    /**
+     * Unique identifier of the object.
+     */
+    objectID?: string;
+};
 //# sourceMappingURL=updatedAtWithObjectIdResponse.d.ts.map

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

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

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

@@ -1,12 +1,12 @@
-import type { HighlightResult } from './highlightResult';
-export type UserHighlightResult = {
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    userID: Record<string, HighlightResult>;
-    /**
-     * Show highlighted section and words matched on a query.
-     */
-    clusterName: Record<string, HighlightResult>;
-};
+import type { HighlightResult } from './highlightResult';
+export type UserHighlightResult = {
+    /**
+     * Show highlighted section and words matched on a query.
+     */
+    userID: Record<string, HighlightResult>;
+    /**
+     * Show highlighted section and words matched on a query.
+     */
+    clusterName: Record<string, HighlightResult>;
+};
 //# sourceMappingURL=userHighlightResult.d.ts.map

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

@@ -1,25 +1,25 @@
-import type { UserHighlightResult } from './userHighlightResult';
-export type UserHit = {
-    /**
-     * UserID of the user.
-     */
-    userID: string;
-    /**
-     * Name of the cluster.
-     */
-    clusterName: string;
-    /**
-     * Number of records in the cluster.
-     */
-    nbRecords: number;
-    /**
-     * Data size taken by all the users assigned to the cluster.
-     */
-    dataSize: number;
-    /**
-     * UserID of the requested user. Same as userID.
-     */
-    objectID: string;
-    _highlightResult: UserHighlightResult;
-};
+import type { UserHighlightResult } from './userHighlightResult';
+export type UserHit = {
+    /**
+     * UserID of the user.
+     */
+    userID: string;
+    /**
+     * Name of the cluster.
+     */
+    clusterName: string;
+    /**
+     * Number of records in the cluster.
+     */
+    nbRecords: number;
+    /**
+     * Data size taken by all the users assigned to the cluster.
+     */
+    dataSize: number;
+    /**
+     * UserID of the requested user. Same as userID.
+     */
+    objectID: string;
+    _highlightResult: UserHighlightResult;
+};
 //# sourceMappingURL=userHit.d.ts.map

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

@@ -1,22 +1,22 @@
-/**
- * A userID.
- */
-export type UserId = {
-    /**
-     * UserID of the user.
-     */
-    userID: string;
-    /**
-     * Cluster on which the user is assigned.
-     */
-    clusterName: string;
-    /**
-     * Number of records belonging to the user.
-     */
-    nbRecords: number;
-    /**
-     * Data size used by the user.
-     */
-    dataSize: number;
-};
+/**
+ * A userID.
+ */
+export type UserId = {
+    /**
+     * UserID of the user.
+     */
+    userID: string;
+    /**
+     * Cluster on which the user is assigned.
+     */
+    clusterName: string;
+    /**
+     * Number of records belonging to the user.
+     */
+    nbRecords: number;
+    /**
+     * Data size used by the user.
+     */
+    dataSize: number;
+};
 //# sourceMappingURL=userId.d.ts.map

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

@@ -1,9 +1,9 @@
-import type { SortRemainingBy } from './sortRemainingBy';
-export type Value = {
-    /**
-     * Pinned order of facet lists.
-     */
-    order?: string[];
-    sortRemainingBy?: SortRemainingBy;
-};
+import type { SortRemainingBy } from './sortRemainingBy';
+export type Value = {
+    /**
+     * Pinned order of facet lists.
+     */
+    order?: string[];
+    sortRemainingBy?: SortRemainingBy;
+};
 //# sourceMappingURL=value.d.ts.map