algoliasearch 5.0.0-alpha.9 → 5.0.0-alpha.91

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

@@ -1 +1 @@
-{"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../../../client-search/model/tagFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,UAAU,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
+{"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../../../client-search/model/tagFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}

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

@@ -1,2 +1,5 @@
-export declare type TaskStatus = 'notPublished' | 'published';
+/**
+ * _published_ if the task has been processed, _notPublished_ otherwise.
+ */
+export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../../client-search/model/taskStatus.ts"],"names":[],"mappings":"AAEA,oBAAY,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}
+{"version":3,"file":"taskStatus.d.ts","sourceRoot":"","sources":["../../../../client-search/model/taskStatus.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,WAAW,CAAC"}

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

@@ -1,11 +1,11 @@
-export declare 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/timeRange.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../../client-search/model/timeRange.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"timeRange.d.ts","sourceRoot":"","sources":["../../../../client-search/model/timeRange.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

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 declare type TypoTolerance = TypoToleranceEnum | boolean;
+import type { TypoToleranceEnum } from './typoToleranceEnum';
+/**
+ * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ */
+export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"typoTolerance.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoTolerance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,oBAAY,aAAa,GAAG,iBAAiB,GAAG,OAAO,CAAC"}
+{"version":3,"file":"typoTolerance.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoTolerance.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,iBAAiB,GAAG,OAAO,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

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

@@ -1,11 +1,11 @@
-export declare type UpdateApiKeyResponse = {
-    /**
-     * The API key.
-     */
-    key: string;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+export type UpdateApiKeyResponse = {
+    /**
+     * API key.
+     */
+    key: string;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=updateApiKeyResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updateApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updateApiKeyResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,oBAAoB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"updateApiKeyResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updateApiKeyResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

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

@@ -1,14 +1,14 @@
-/**
- * The response with a taskID and an updatedAt timestamp.
- */
-export declare type UpdatedAtResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * Date of last update (ISO-8601 format).
-     */
-    updatedAt: string;
-};
+/**
+ * Response, taskID, and update timestamp.
+ */
+export type UpdatedAtResponse = {
+    /**
+     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     */
+    taskID: number;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+};
 //# sourceMappingURL=updatedAtResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updatedAtResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updatedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"updatedAtResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updatedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

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

@@ -1,18 +1,18 @@
-/**
- * The response with a taskID, an objectID and an updatedAt timestamp.
- */
-export declare 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;
-};
+/**
+ * Response, taskID, unique object identifier, and an update timestamp.
+ */
+export type UpdatedAtWithObjectIdResponse = {
+    /**
+     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     */
+    taskID?: number;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt?: string;
+    /**
+     * Unique object identifier.
+     */
+    objectID?: string;
+};
 //# sourceMappingURL=updatedAtWithObjectIdResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updatedAtWithObjectIdResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updatedAtWithObjectIdResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
+{"version":3,"file":"updatedAtWithObjectIdResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updatedAtWithObjectIdResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

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

@@ -1,15 +1,15 @@
-export declare 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 object identifier.
+     */
+    objectID: string;
+    /**
+     * Timestamp of the last update in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
+     */
+    updatedAt: string;
+    /**
+     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
+     */
+    taskID: number;
+};
 //# sourceMappingURL=updatedRuleResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"updatedRuleResponse.d.ts","sourceRoot":"","sources":["../../../../client-search/model/updatedRuleResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

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

@@ -1,12 +1,12 @@
-import type { HighlightResult } from './highlightResult';
-export declare 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/userHighlightResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../../../client-search/model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC9C,CAAC"}
+{"version":3,"file":"userHighlightResult.d.ts","sourceRoot":"","sources":["../../../../client-search/model/userHighlightResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC9C,CAAC"}

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

@@ -1,25 +1,25 @@
-import type { UserHighlightResult } from './userHighlightResult';
-export declare 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;
+    /**
+     * Cluster name.
+     */
+    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/userHit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userHit.d.ts","sourceRoot":"","sources":["../../../../client-search/model/userHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,gBAAgB,EAAE,mBAAmB,CAAC;CACvC,CAAC"}
+{"version":3,"file":"userHit.d.ts","sourceRoot":"","sources":["../../../../client-search/model/userHit.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,gBAAgB,EAAE,mBAAmB,CAAC;CACvC,CAAC"}

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

@@ -1,22 +1,22 @@
-/**
- * A userID.
- */
-export declare 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;
-};
+/**
+ * Unique user ID.
+ */
+export type UserId = {
+    /**
+     * UserID of the user.
+     */
+    userID: string;
+    /**
+     * Cluster to 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/userId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../client-search/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
+{"version":3,"file":"userId.d.ts","sourceRoot":"","sources":["../../../../client-search/model/userId.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

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

@@ -1,9 +1,9 @@
-import type { SortRemainingBy } from './sortRemainingBy';
-export declare 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

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

@@ -1 +1 @@
-{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../client-search/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../../client-search/model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}