@algolia/client-personalization 5.27.0 → 5.29.0

package/dist/worker.d.ts

@@ -82,7 +82,7 @@ type SetPersonalizationStrategyResponse = {
  */
 type CustomDeleteProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -90,14 +90,14 @@ type CustomDeleteProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customGet` method.
  */
 type CustomGetProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -105,14 +105,14 @@ type CustomGetProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customPost` method.
  */
 type CustomPostProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -120,18 +120,18 @@ type CustomPostProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `customPut` method.
  */
 type CustomPutProps = {
     /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
+     * Path of the endpoint, for example `1/newFeature`.
      */
     path: string;
     /**
@@ -139,11 +139,11 @@ type CustomPutProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `deleteUserProfile` method.
@@ -164,7 +164,7 @@ type GetUserTokenProfileProps = {
     userToken: string;
 };
 
-declare const apiClientVersion = "5.27.0";
+declare const apiClientVersion = "5.29.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -194,7 +194,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      * @param segment - The algolia agent (user-agent) segment to add.
      * @param version - The version of the agent.
      */
-    addAlgoliaAgent(segment: string, version?: string): void;
+    addAlgoliaAgent(segment: string, version?: string | undefined): void;
     /**
      * Helper method to switch the API key used to authenticate the requests.
      *
@@ -207,7 +207,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
-     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -215,7 +215,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customGet - The customGet object.
-     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -223,7 +223,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPost - The customPost object.
-     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPost.parameters - Query parameters to apply to the current query.
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -232,7 +232,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customPut - The customPut object.
-     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
      * @param customPut.parameters - Query parameters to apply to the current query.
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -255,7 +255,7 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
      *  - recommendation
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
+    getPersonalizationStrategy(requestOptions?: RequestOptions | undefined): Promise<PersonalizationStrategyParams>;
     /**
      * Retrieves a user profile and their affinities for different facets.
      *
@@ -281,11 +281,11 @@ declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKe
  * Error.
  */
 type ErrorBase = Record<string, any> & {
-    message?: string;
+    message?: string | undefined;
 };
 
 type PersonalizationClient = ReturnType<typeof createPersonalizationClient>;
 
-declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): PersonalizationClient;
+declare function personalizationClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): PersonalizationClient;
 
 export { type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteUserProfileProps, type DeleteUserProfileResponse, type ErrorBase, type EventType, type EventsScoring, type FacetsScoring, type GetUserTokenProfileProps, type GetUserTokenResponse, type PersonalizationClient, type PersonalizationStrategyParams, type Region, type RegionOptions, type SetPersonalizationStrategyResponse, apiClientVersion, personalizationClient };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "5.27.0",
+  "version": "5.29.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/algolia/algoliasearch-client-javascript.git"
@@ -49,14 +49,14 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "@algolia/client-common": "5.27.0",
-    "@algolia/requester-browser-xhr": "5.27.0",
-    "@algolia/requester-fetch": "5.27.0",
-    "@algolia/requester-node-http": "5.27.0"
+    "@algolia/client-common": "5.29.0",
+    "@algolia/requester-browser-xhr": "5.29.0",
+    "@algolia/requester-fetch": "5.29.0",
+    "@algolia/requester-node-http": "5.29.0"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "0.18.1",
-    "@types/node": "22.15.29",
+    "@arethetypeswrong/cli": "0.18.2",
+    "@types/node": "22.15.31",
     "publint": "0.3.12",
     "rollup": "4.41.0",
     "tsup": "8.5.0",