@algolia/client-search 5.0.0-alpha.99 → 5.0.0-beta.10

package/model/clientMethodProps.ts

@@ -2,7 +2,9 @@
 
 import type { CreateIterablePromise } from '@algolia/client-common';
 
+import type { Action } from './action';
 import type { ApiKey } from './apiKey';
+import type { ApiKeyOperation } from './apiKeyOperation';
 import type { AssignUserIdParams } from './assignUserIdParams';
 import type { AttributeToUpdate } from './attributeToUpdate';
 import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
@@ -23,6 +25,7 @@ import type { SearchParams } from './searchParams';
 import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchRulesParams } from './searchRulesParams';
 import type { SearchSynonymsParams } from './searchSynonymsParams';
+import type { SecuredApiKeyRestrictions } from './securedApiKeyRestrictions';
 import type { Source } from './source';
 import type { SynonymHit } from './synonymHit';
 
@@ -31,15 +34,15 @@ import type { SynonymHit } from './synonymHit';
  */
 export type AddOrUpdateObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Algolia record.
+   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, any>;
 };
@@ -49,7 +52,7 @@ export type AddOrUpdateObjectProps = {
  */
 export type AssignUserIdProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   xAlgoliaUserID: string;
   assignUserIdParams: AssignUserIdParams;
@@ -60,7 +63,7 @@ export type AssignUserIdProps = {
  */
 export type BatchProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   batchWriteParams: BatchWriteParams;
@@ -71,7 +74,7 @@ export type BatchProps = {
  */
 export type BatchAssignUserIdsProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   xAlgoliaUserID: string;
   batchAssignUserIdsParams: BatchAssignUserIdsParams;
@@ -82,7 +85,7 @@ export type BatchAssignUserIdsProps = {
  */
 export type BatchDictionaryEntriesProps = {
   /**
-   * Dictionary to search in.
+   * Dictionary type in which to search.
    */
   dictionaryName: DictionaryType;
   batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
@@ -93,7 +96,7 @@ export type BatchDictionaryEntriesProps = {
  */
 export type BrowseProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   browseParams?: BrowseParams;
@@ -104,7 +107,7 @@ export type BrowseProps = {
  */
 export type ClearObjectsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -114,11 +117,11 @@ export type ClearObjectsProps = {
  */
 export type ClearRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -128,11 +131,11 @@ export type ClearRulesProps = {
  */
 export type ClearSynonymsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -216,7 +219,7 @@ export type DeleteApiKeyProps = {
  */
 export type DeleteByProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   deleteByParams: DeleteByParams;
@@ -227,7 +230,7 @@ export type DeleteByProps = {
  */
 export type DeleteIndexProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -237,11 +240,11 @@ export type DeleteIndexProps = {
  */
 export type DeleteObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
 };
@@ -251,7 +254,7 @@ export type DeleteObjectProps = {
  */
 export type DeleteRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -259,7 +262,7 @@ export type DeleteRuleProps = {
    */
   objectID: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -279,7 +282,7 @@ export type DeleteSourceProps = {
  */
 export type DeleteSynonymProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -287,7 +290,7 @@ export type DeleteSynonymProps = {
    */
   objectID: string;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -302,12 +305,22 @@ export type GetApiKeyProps = {
   key: string;
 };
 
+/**
+ * Properties for the `getAppTask` method.
+ */
+export type GetAppTaskProps = {
+  /**
+   * Unique task identifier.
+   */
+  taskID: number;
+};
+
 /**
  * Properties for the `getLogs` method.
  */
 export type GetLogsProps = {
   /**
-   * First log entry to retrieve. Sorted by decreasing date with 0 being the most recent.
+   * First log entry to retrieve. The most recent entries are listed first.
    */
   offset?: number;
   /**
@@ -315,11 +328,11 @@ export type GetLogsProps = {
    */
   length?: number;
   /**
-   * Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices.
+   * Index for which to retrieve log entries. By default, log entries are retrieved for all indices.
    */
   indexName?: string;
   /**
-   * Type of log entries to retrieve. When omitted, all log entries are retrieved.
+   * Type of log entries to retrieve. By default, all log entries are retrieved.
    */
   type?: LogType;
 };
@@ -329,15 +342,15 @@ export type GetLogsProps = {
  */
 export type GetObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won\'t be retrieved unless the request is authenticated with the admin API key.
+   * Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned.  `objectID` is always retrieved.  Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
    */
   attributesToRetrieve?: string[];
 };
@@ -347,7 +360,7 @@ export type GetObjectProps = {
  */
 export type GetRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -361,7 +374,7 @@ export type GetRuleProps = {
  */
 export type GetSettingsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -371,7 +384,7 @@ export type GetSettingsProps = {
  */
 export type GetSynonymProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -385,7 +398,7 @@ export type GetSynonymProps = {
  */
 export type GetTaskProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -399,7 +412,7 @@ export type GetTaskProps = {
  */
 export type GetUserIdProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   userID: string;
 };
@@ -409,7 +422,7 @@ export type GetUserIdProps = {
  */
 export type HasPendingMappingsProps = {
   /**
-   * Indicates whether to include the cluster\'s pending mapping state in the response.
+   * Whether to include the cluster\'s pending mapping state in the response.
    */
   getClusters?: boolean;
 };
@@ -419,11 +432,11 @@ export type HasPendingMappingsProps = {
  */
 export type ListIndicesProps = {
   /**
-   * Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
+   * Requested page of the API response. If `null`, the API response is not paginated.
    */
   page?: number;
   /**
-   * Maximum number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 };
@@ -433,11 +446,11 @@ export type ListIndicesProps = {
  */
 export type ListUserIdsProps = {
   /**
-   * Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
+   * Requested page of the API response. If `null`, the API response is not paginated.
    */
   page?: number;
   /**
-   * Maximum number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 };
@@ -447,7 +460,7 @@ export type ListUserIdsProps = {
  */
 export type OperationIndexProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   operationIndexParams: OperationIndexParams;
@@ -458,19 +471,19 @@ export type OperationIndexProps = {
  */
 export type PartialUpdateObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique record (object) identifier.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Object with attributes to update.
+   * Attributes with their values.
    */
   attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
-   * Indicates whether to create a new record if it doesn\'t exist yet.
+   * Whether to create a new record if it doesn\'t exist.
    */
   createIfNotExists?: boolean;
 };
@@ -480,7 +493,7 @@ export type PartialUpdateObjectProps = {
  */
 export type RemoveUserIdProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   userID: string;
 };
@@ -510,11 +523,11 @@ export type RestoreApiKeyProps = {
  */
 export type SaveObjectProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * The Algolia record.
+   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, any>;
 };
@@ -524,7 +537,7 @@ export type SaveObjectProps = {
  */
 export type SaveRuleProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -533,7 +546,7 @@ export type SaveRuleProps = {
   objectID: string;
   rule: Rule;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -543,16 +556,16 @@ export type SaveRuleProps = {
  */
 export type SaveRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   rules: Rule[];
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * Indicates whether existing rules should be deleted before adding this batch.
+   * Whether existing rules should be deleted before adding this batch.
    */
   clearExistingRules?: boolean;
 };
@@ -562,7 +575,7 @@ export type SaveRulesProps = {
  */
 export type SaveSynonymProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -571,7 +584,7 @@ export type SaveSynonymProps = {
   objectID: string;
   synonymHit: SynonymHit;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -581,16 +594,16 @@ export type SaveSynonymProps = {
  */
 export type SaveSynonymsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   synonymHit: SynonymHit[];
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * Indicates whether to replace all synonyms in the index with the ones sent with this request.
+   * Whether to replace all synonyms in the index with the ones sent with this request.
    */
   replaceExistingSynonyms?: boolean;
 };
@@ -632,7 +645,7 @@ export type LegacySearchMethodProps = LegacySearchQuery[];
  */
 export type SearchDictionaryEntriesProps = {
   /**
-   * Dictionary to search in.
+   * Dictionary type in which to search.
    */
   dictionaryName: DictionaryType;
   searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
@@ -643,11 +656,11 @@ export type SearchDictionaryEntriesProps = {
  */
 export type SearchForFacetValuesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Facet name.
+   * Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
    */
   facetName: string;
   searchForFacetValuesRequest?: SearchForFacetValuesRequest;
@@ -658,7 +671,7 @@ export type SearchForFacetValuesProps = {
  */
 export type SearchRulesProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   searchRulesParams?: SearchRulesParams;
@@ -669,7 +682,7 @@ export type SearchRulesProps = {
  */
 export type SearchSingleIndexProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   searchParams?: SearchParams;
@@ -680,7 +693,7 @@ export type SearchSingleIndexProps = {
  */
 export type SearchSynonymsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
@@ -694,12 +707,12 @@ export type SearchSynonymsProps = {
  */
 export type SetSettingsProps = {
   /**
-   * Index on which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   indexSettings: IndexSettings;
   /**
-   * Indicates whether changed index settings are forwarded to the replica indices.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -735,17 +748,20 @@ type WaitForOptions = Partial<{
   timeout: (retryCount: number) => number;
 }>;
 
-export type WaitForTaskOptions = WaitForOptions & {
-  /**
-   * The `indexName` where the operation was performed.
-   */
-  indexName: string;
+export type WaitForAppTaskOptions = WaitForOptions & {
   /**
    * The `taskID` returned by the method response.
    */
   taskID: number;
 };
 
+export type WaitForTaskOptions = WaitForAppTaskOptions & {
+  /**
+   * The `indexName` where the operation was performed.
+   */
+  indexName: string;
+};
+
 export type WaitForApiKeyOptions = WaitForOptions & {
   /**
    * The API Key.
@@ -756,17 +772,87 @@ export type WaitForApiKeyOptions = WaitForOptions & {
         /**
          * The operation that has been performed, used to compute the stop condition.
          */
-        operation: 'add' | 'delete';
+        operation: Extract<ApiKeyOperation, 'add' | 'delete'>;
         apiKey?: never;
       }
     | {
         /**
          * The operation that has been performed, used to compute the stop condition.
          */
-        operation: 'update';
+        operation: Extract<ApiKeyOperation, 'update'>;
         /**
          * The updated fields, used to compute the stop condition.
          */
         apiKey: Partial<ApiKey>;
       }
   );
+
+export type GenerateSecuredApiKeyOptions = {
+  /**
+   * The base API key from which to generate the new secured one.
+   */
+  parentApiKey: string;
+
+  /**
+   * A set of properties defining the restrictions of the secured API key.
+   */
+  restrictions?: SecuredApiKeyRestrictions;
+};
+
+export type GetSecuredApiKeyRemainingValidityOptions = {
+  /**
+   * The secured API key generated with the `generateSecuredApiKey` method.
+   */
+  securedApiKey: string;
+};
+
+export type DeleteObjectsOptions = Pick<ChunkedBatchOptions, 'indexName'> & {
+  /**
+   * The objectIDs to delete.
+   */
+  objectIDs: string[];
+};
+
+export type PartialUpdateObjectsOptions = Pick<
+  ChunkedBatchOptions,
+  'indexName' | 'objects'
+> & {
+  /**
+   *To be provided if non-existing objects are passed, otherwise, the call will fail.
+   */
+  createIfNotExists?: boolean;
+};
+
+export type SaveObjectsOptions = Pick<
+  ChunkedBatchOptions,
+  'indexName' | 'objects'
+>;
+
+export type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
+  /**
+   * The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
+   */
+  action?: Action;
+
+  /**
+   * Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+   */
+  waitForTasks?: boolean;
+};
+
+export type ReplaceAllObjectsOptions = {
+  /**
+   * The `indexName` to replace `objects` in.
+   */
+  indexName: string;
+
+  /**
+   * The array of `objects` to store in the given Algolia `indexName`.
+   */
+  objects: Array<Record<string, any>>;
+
+  /**
+   * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+   */
+  batchSize?: number;
+};

package/model/condition.ts

@@ -4,19 +4,24 @@ import type { Anchoring } from './anchoring';
 
 export type Condition = {
   /**
-   * Query pattern syntax.
+   * Query pattern that triggers the rule.  You can use either a literal string, or a special pattern `{facet:ATTRIBUTE}`, where `ATTRIBUTE` is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with `pattern: {facet:genre}`, the rule is triggered when users search for a genre, such as \"comedy\".
    */
   pattern?: string;
 
   anchoring?: Anchoring;
 
   /**
-   * Whether the pattern matches on plurals, synonyms, and typos.
+   * Whether the pattern should match plurals, synonyms, and typos.
    */
   alternatives?: boolean;
 
   /**
-   * Rule context format: [A-Za-z0-9_-]+).
+   * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
    */
   context?: string;
+
+  /**
+   * Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
+   */
+  filters?: string;
 };

package/model/consequence.ts

@@ -5,28 +5,28 @@ import type { ConsequenceParams } from './consequenceParams';
 import type { Promote } from './promote';
 
 /**
- * [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences) of a rule.
+ * Effect of the rule.  For more information, see [Consequences](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#consequences).
  */
 export type Consequence = {
   params?: ConsequenceParams;
 
   /**
-   * Records to promote.
+   * Records you want to pin to a specific position in the search results.  You can promote up to 300 records, either individually, or as groups of up to 100 records each.
    */
   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.
+   * Whether promoted records must match an active filter for the consequence to be applied.  This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the `color: red` attribute, and the user filters the search for `color: blue`, the \"red\" record won\'t be shown.
    */
   filterPromotes?: boolean;
 
   /**
-   * Records to hide. By default, you can hide up to 50 records per rule.
+   * Records you want to hide from the search results.
    */
   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.
+   * A JSON object with custom data that will be appended to the `userData` array in the response. This object isn\'t interpreted by the API and is limited to 1 kB of minified JSON.
    */
   userData?: any | null;
 };