@algolia/client-search 4.9.1 → 4.10.2

package/dist/client-search.cjs.js

@@ -1231,6 +1231,7 @@ const ApiKeyACLEnum = {
     EditSettings: 'editSettings',
     ListIndexes: 'listIndexes',
     Logs: 'logs',
+    Personalization: 'personalization',
     Recommendation: 'recommendation',
     Search: 'search',
     SeeUnretrievableAttributes: 'seeUnretrievableAttributes',

package/dist/client-search.d.ts

@@ -52,7 +52,7 @@ export declare type AddApiKeyResponse = {
 
 export declare const ApiKeyACLEnum: Readonly<Record<string, ApiKeyACLType>>;
 
-export declare type ApiKeyACLType = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'listIndexes' | 'logs' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
+export declare type ApiKeyACLType = 'addObject' | 'analytics' | 'browse' | 'deleteIndex' | 'deleteObject' | 'editSettings' | 'listIndexes' | 'logs' | 'personalization' | 'recommendation' | 'search' | 'seeUnretrievableAttributes' | 'settings' | 'usage';
 
 export declare const assignUserID: (base: SearchClient) => (userID: string, clusterName: string, requestOptions?: RequestOptions | undefined) => Readonly<Promise<AssignUserIDResponse>>;
 
@@ -282,7 +282,12 @@ export declare type ConsequenceParams = {
      * Same syntax as automaticFacetFilters, but the engine treats the filters as optional.
      * Behaves like optionalFilters.
      */
-    readonly automaticOptionalFacetFilters?: readonly AutomaticFacetFilter[];
+    readonly automaticOptionalFacetFilters?: readonly AutomaticFacetFilter[] | readonly string[];
+    /**
+     * Content defining how the search interface should be rendered.
+     * A default value for this can be set via settings
+     */
+    readonly renderingContent?: Settings['renderingContent'];
 };
 
 export declare type ConsequencePromote = {
@@ -578,13 +583,13 @@ export declare const getApiKey: (base: SearchClient) => (apiKey: string, request
 
 export declare type GetApiKeyResponse = {
     /**
-     * A Unix timestamp used to define the expiration date of the API key.
+     * The api key value
      */
     value: string;
     /**
-     * Date of creation.
+     * Date of creation (Unix timestamp).
      */
-    createdAt: string;
+    createdAt: number;
     /**
      * List of permissions the key contains.
      */
@@ -1850,6 +1855,7 @@ export declare type SearchResponse<TObject = {}> = {
      * The relevancy threshold applied to search in a virtual index.
      */
     appliedRelevancyStrictness?: number;
+    renderingContent?: Settings['renderingContent'];
 };
 
 export declare const searchRules: (base: SearchIndex) => (query: string, requestOptions?: (RequestOptions & SearchRulesOptions) | undefined) => Readonly<Promise<SearchResponse<Rule>>>;
@@ -2236,6 +2242,44 @@ export declare type Settings = {
      * less relevant results.
      */
     readonly relevancyStrictness?: number;
+    /**
+     * Content defining how the search interface should be rendered.
+     * This is set via the settings for a default value and can be overridden via rules
+     */
+    readonly renderingContent?: {
+        /**
+         * defining how facets should be ordered
+         */
+        readonly facetOrdering?: {
+            /**
+             * the ordering of facets (widgets)
+             */
+            readonly facet?: {
+                /**
+                 * pinned order of facet lists
+                 */
+                readonly order?: readonly string[];
+            };
+            /**
+             * the ordering of facet values, within an individual list
+             */
+            readonly values?: {
+                readonly [facet: string]: {
+                    /**
+                     * pinned order of facet values
+                     */
+                    readonly order?: readonly string[];
+                    /**
+                     * How to display the remaining items.
+                     * - facet count (descending)
+                     * - alphabetical (ascending)
+                     * - hidden (show only pinned values)
+                     */
+                    readonly sortRemainingBy?: 'count' | 'alpha' | 'hidden';
+                };
+            };
+        };
+    };
 };
 
 declare type SharedMultipleQueriesQuery = {
@@ -2325,11 +2369,11 @@ export declare type TaskStatusResponse = {
 
 export declare type TimeRange = {
     /**
-     * DateTime with UTC offset for Serialization/Deserialization in unix timespam.
+     * DateTime with UTC offset for Serialization/Deserialization in unix timespan.
      */
     readonly from: number;
     /**
-     * DateTime with UTC offset for Serialization/Deserialization in unix timespam.
+     * DateTime with UTC offset for Serialization/Deserialization in unix timespan.
      */
     readonly until: number;
 };
@@ -2337,6 +2381,10 @@ export declare type TimeRange = {
 export declare const updateApiKey: (base: SearchClient) => (apiKey: string, requestOptions?: (UpdateApiKeyOptions & Pick<RequestOptions, string | number>) | undefined) => Readonly<WaitablePromise<UpdateApiKeyResponse>>;
 
 export declare type UpdateApiKeyOptions = {
+    /**
+     * List of permissions the key contains.
+     */
+    readonly acl?: readonly ApiKeyACLType[];
     /**
      * A Unix timestamp used to define the expiration date of the API key.
      */

package/dist/client-search.esm.js

@@ -1227,6 +1227,7 @@ const ApiKeyACLEnum = {
     EditSettings: 'editSettings',
     ListIndexes: 'listIndexes',
     Logs: 'logs',
+    Personalization: 'personalization',
     Recommendation: 'recommendation',
     Search: 'search',
     SeeUnretrievableAttributes: 'seeUnretrievableAttributes',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-search",
-  "version": "4.9.1",
+  "version": "4.10.2",
   "private": false,
   "repository": {
     "type": "git",
@@ -16,8 +16,8 @@
     "dist"
   ],
   "dependencies": {
-    "@algolia/client-common": "4.9.1",
-    "@algolia/requester-common": "4.9.1",
-    "@algolia/transporter": "4.9.1"
+    "@algolia/client-common": "4.10.2",
+    "@algolia/requester-common": "4.10.2",
+    "@algolia/transporter": "4.10.2"
   }
 }