@algolia/client-search 5.0.0-alpha.102 → 5.0.0-alpha.104

package/model/apiKeyOperation.ts

@@ -0,0 +1,3 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type ApiKeyOperation = 'add' | 'delete' | 'update';

package/model/baseSearchResponse.ts

@@ -131,4 +131,9 @@ export type BaseSearchResponse = Record<string, any> & {
    * Lets you store custom data in your indices.
    */
   userData?: any | null;
+
+  /**
+   * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+   */
+  queryID?: string;
 };

package/model/clientMethodProps.ts

@@ -2,11 +2,14 @@
 
 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';
 import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
+import type { BatchResponse } from './batchResponse';
 import type { BatchWriteParams } from './batchWriteParams';
 import type { BrowseParams } from './browseParams';
 import type { DeleteByParams } from './deleteByParams';
@@ -23,8 +26,10 @@ 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';
+import type { UpdatedAtResponse } from './updatedAtResponse';
 
 /**
  * Properties for the `addOrUpdateObject` method.
@@ -756,17 +761,82 @@ 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 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;
+};
+
+export type ReplaceAllObjectsResponse = {
+  /**
+   * The response of the `operationIndex` request for the `copy` operation.
+   */
+  copyOperationResponse: UpdatedAtResponse;
+
+  /**
+   * The response of the `batch` request(s).
+   */
+  batchResponses: BatchResponse[];
+
+  /**
+   * The response of the `operationIndex` request for the `move` operation.
+   */
+  moveOperationResponse: UpdatedAtResponse;
+};

package/model/index.ts

@@ -7,6 +7,7 @@ export * from './advancedSyntaxFeatures';
 export * from './alternativesAsExact';
 export * from './anchoring';
 export * from './apiKey';
+export * from './apiKeyOperation';
 export * from './aroundPrecision';
 export * from './aroundPrecisionFromValueInner';
 export * from './aroundRadius';
@@ -141,6 +142,7 @@ export * from './searchTypeDefault';
 export * from './searchTypeFacet';
 export * from './searchUserIdsParams';
 export * from './searchUserIdsResponse';
+export * from './securedAPIKeyRestrictions';
 export * from './semanticSearch';
 export * from './snippetResult';
 export * from './snippetResultOption';

package/model/securedAPIKeyRestrictions.ts

@@ -0,0 +1,32 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type SecuredAPIKeyRestrictions = {
+  searchParams?: SearchParamsObject;
+
+  /**
+   * Filters that apply to every search made with the secured API key. You can add extra filters at search time with the filters query parameter. For example, if you set the filter group:admin on your generated API key, and you add groups:press OR groups:visitors with the filters query parameter, your final search filter is equivalent to groups:admin AND (groups:press OR groups:visitors).
+   */
+  filters?: string;
+
+  /**
+   * Unix timestamp used to set the expiration date of the API key.
+   */
+  validUntil?: number;
+
+  /**
+   * Index names that can be queried.
+   */
+  restrictIndices?: string[];
+
+  /**
+   * IPv4 network allowed to use the generated key. Use this to protect against API key leaking and reuse. You can only provide a single source, but you can specify a range of IPs (for example, 192.168.1.0/24).
+   */
+  restrictSources?: string;
+
+  /**
+   * Unique user IP address. This can be useful when you want to impose a rate limit on specific users. By default, rate limits are set based on the IP address. This can become an issue when several users search from the same IP address. To avoid this, you can set a unique userToken for each user when generating their API key. This lets you restrict each user to a maximum number of API calls per hour, even if they share their IP with another user. Specifying the userToken in a secured API key is also a good security practice as it ensures users don\'t change it. Many features like Analytics, Personalization, and Dynamic Re-ranking rely on the authenticity of user identifiers. Setting the userToken at the API key level ensures that downstream services work as expected and prevents abuse.
+   */
+  userToken?: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "5.0.0-alpha.102",
+  "version": "5.0.0-alpha.104",
   "description": "JavaScript client for client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,12 +39,12 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.103",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.103",
-    "@algolia/requester-node-http": "5.0.0-alpha.103"
+    "@algolia/client-common": "5.0.0-alpha.105",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.105",
+    "@algolia/requester-node-http": "5.0.0-alpha.105"
   },
   "devDependencies": {
-    "@types/node": "20.11.19",
+    "@types/node": "20.11.20",
     "rollup": "4.12.0",
     "typescript": "5.3.3"
   },