algoliasearch 5.0.0-alpha.105 → 5.0.0-alpha.107

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

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

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

@@ -1,10 +1,10 @@
 export type TimeRange = {
     /**
-     * Lower bound of the time range (Unix timestamp).
+     * When the rule should start to be active, in Unix epoch time.
      */
     from: number;
     /**
-     * Upper bound of the time range (Unix timestamp).
+     * When the rule should stop to be active, in Unix epoch time.
      */
     until: number;
 };

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

@@ -1,6 +1,6 @@
 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.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

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

@@ -1,2 +1,5 @@
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 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,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../../../client-search/model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

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

@@ -3,7 +3,7 @@
  */
 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`.
+     * 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](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID: number;
     /**

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

@@ -3,7 +3,7 @@
  */
 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`.
+     * 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](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID?: number;
     /**
@@ -11,7 +11,7 @@ export type UpdatedAtWithObjectIdResponse = {
      */
     updatedAt?: string;
     /**
-     * Unique object identifier.
+     * Unique record identifier.
      */
     objectID?: string;
 };

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

@@ -1,6 +1,6 @@
 export type UpdatedRuleResponse = {
     /**
-     * Unique object identifier.
+     * Unique identifier of a rule object.
      */
     objectID: string;
     /**
@@ -8,7 +8,7 @@ export type UpdatedRuleResponse = {
      */
     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`.
+     * 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](#tag/Indices/operation/getTask) and this `taskID`.
      */
     taskID: number;
 };

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

@@ -1,7 +1,7 @@
 import type { UserHighlightResult } from './userHighlightResult';
 export type UserHit = {
     /**
-     * UserID of the user.
+     * User ID.
      */
     userID: string;
     /**

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

@@ -3,7 +3,7 @@
  */
 export type UserId = {
     /**
-     * UserID of the user.
+     * User ID.
      */
     userID: string;
     /**

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

@@ -1,7 +1,7 @@
 import type { SortRemainingBy } from './sortRemainingBy';
 export type Value = {
     /**
-     * Pinned order of facet lists.
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
     order?: string[];
     sortRemainingBy?: SortRemainingBy;