algoliasearch 5.1.1 → 5.2.2

package/README.md

@@ -9,7 +9,7 @@
     <a href="https://npmjs.org/package/algoliasearch"><img src="https://img.shields.io/npm/v/algoliasearch.svg?style=flat-square" alt="NPM version"></img></a>
     <a href="http://npm-stat.com/charts.html?package=algoliasearch"><img src="https://img.shields.io/npm/dm/algoliasearch.svg?style=flat-square" alt="NPM downloads"></a>
     <a href="https://www.jsdelivr.com/package/npm/algoliasearch"><img src="https://data.jsdelivr.com/v1/package/npm/algoliasearch/badge" alt="jsDelivr Downloads"></img></a>
-    <a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
+    <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
   </p>
 </p>
 

package/builds/browser.ts

@@ -1,17 +1,10 @@
 // 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 { AbtestingClient } from '@algolia/client-abtesting';
-import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
-import {
-  createAbtestingClient,
-  REGIONS as abtestingRegions,
-} from '@algolia/client-abtesting/src/abtestingClient';
-import type { AnalyticsClient } from '@algolia/client-analytics';
-import {
-  createAnalyticsClient,
-  REGIONS as analyticsRegions,
-} from '@algolia/client-analytics/src/analyticsClient';
-import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
+import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
+import { abtestingClient } from '@algolia/client-abtesting';
+import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
+import { analyticsClient } from '@algolia/client-analytics';
+import type { ClientOptions } from '@algolia/client-common';
 import {
   DEFAULT_CONNECT_TIMEOUT_BROWSER,
   DEFAULT_READ_TIMEOUT_BROWSER,
@@ -20,22 +13,11 @@ import {
   createFallbackableCache,
   createMemoryCache,
 } from '@algolia/client-common';
-import type {
-  ClientOptions,
-  CreateClientOptions,
-} from '@algolia/client-common';
-import type { PersonalizationClient } from '@algolia/client-personalization';
-import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
-import {
-  createPersonalizationClient,
-  REGIONS as personalizationRegions,
-} from '@algolia/client-personalization/src/personalizationClient';
-import {
-  createSearchClient,
-  apiClientVersion as searchClientVersion,
-} from '@algolia/client-search/src/searchClient';
+import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
+import { personalizationClient } from '@algolia/client-personalization';
+import { searchClient, apiClientVersion as searchClientVersion } from '@algolia/client-search';
 import type { RecommendClient } from '@algolia/recommend';
-import { createRecommendClient } from '@algolia/recommend/src/recommendClient';
+import { recommendClient } from '@algolia/recommend';
 import { createXhrRequester } from '@algolia/requester-browser-xhr';
 
 import type { InitClientOptions, InitClientRegion } from './models';
@@ -50,11 +32,7 @@ export const apiClientVersion = searchClientVersion;
 export type Algoliasearch = ReturnType<typeof algoliasearch>;
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function algoliasearch(
-  appId: string,
-  apiKey: string,
-  options?: ClientOptions
-) {
+export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions) {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
@@ -62,100 +40,57 @@ export function algoliasearch(
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
-  const commonOptions: CreateClientOptions = {
-    apiKey,
-    appId,
-    timeouts: {
-      connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
-      read: DEFAULT_READ_TIMEOUT_BROWSER,
-      write: DEFAULT_WRITE_TIMEOUT_BROWSER,
-    },
-    requester: createXhrRequester(),
-    algoliaAgents: [{ segment: 'Browser' }],
-    authMode: 'WithinQueryParameters',
-    responsesCache: createMemoryCache(),
-    requestsCache: createMemoryCache({ serializable: false }),
-    hostsCache: createFallbackableCache({
-      caches: [
-        createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
-        createMemoryCache(),
-      ],
-    }),
-    ...options,
-  };
 
   function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {
-    return createRecommendClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+    return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
   }
 
-  function initAnalytics(
-    initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
-  ): AnalyticsClient {
-    if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !analyticsRegions.includes(initOptions.region))
-    ) {
-      throw new Error(
-        `\`region\` must be one of the following: ${analyticsRegions.join(', ')}`
-      );
-    }
-
-    return createAnalyticsClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+  function initAnalytics(initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient {
+    return analyticsClient(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options,
+    );
   }
 
-  function initAbtesting(
-    initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}
-  ): AbtestingClient {
-    if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !abtestingRegions.includes(initOptions.region))
-    ) {
-      throw new Error(
-        `\`region\` must be one of the following: ${abtestingRegions.join(', ')}`
-      );
-    }
-
-    return createAbtestingClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+  function initAbtesting(initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient {
+    return abtestingClient(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options,
+    );
   }
 
   function initPersonalization(
-    initOptions: InitClientOptions &
-      Required<InitClientRegion<PersonalizationRegion>>
+    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
   ): PersonalizationClient {
-    if (
-      !initOptions.region ||
-      (initOptions.region &&
-        (typeof initOptions.region !== 'string' ||
-          !personalizationRegions.includes(initOptions.region)))
-    ) {
-      throw new Error(
-        `\`region\` is required and must be one of the following: ${personalizationRegions.join(', ')}`
-      );
-    }
-
-    return createPersonalizationClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+    return personalizationClient(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options,
+    );
   }
 
   return {
-    ...createSearchClient(commonOptions),
+    ...searchClient(appId, apiKey, {
+      timeouts: {
+        connect: DEFAULT_CONNECT_TIMEOUT_BROWSER,
+        read: DEFAULT_READ_TIMEOUT_BROWSER,
+        write: DEFAULT_WRITE_TIMEOUT_BROWSER,
+      },
+      requester: createXhrRequester(),
+      algoliaAgents: [{ segment: 'Browser' }],
+      authMode: 'WithinQueryParameters',
+      responsesCache: createMemoryCache(),
+      requestsCache: createMemoryCache({ serializable: false }),
+      hostsCache: createFallbackableCache({
+        caches: [createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }), createMemoryCache()],
+      }),
+      ...options,
+    }),
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */

package/builds/models.ts

@@ -33,7 +33,7 @@ import {
   FacetFilters,
   FacetOrdering,
   Facets,
-  FacetsStats,
+  FacetStats,
   HighlightResult,
   HighlightResultOption,
   IgnorePlurals,
@@ -119,7 +119,7 @@ export {
   FacetFilters,
   FacetOrdering,
   Facets,
-  FacetsStats,
+  FacetStats,
   HighlightResult,
   HighlightResultOption,
   IgnorePlurals,

package/builds/node.ts

@@ -1,19 +1,12 @@
 // 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 { createHmac } from 'crypto';
+import { createHmac } from 'node:crypto';
 
-import type { AbtestingClient } from '@algolia/client-abtesting';
-import type { Region as AbtestingRegion } from '@algolia/client-abtesting/src/abtestingClient';
-import {
-  createAbtestingClient,
-  REGIONS as abtestingRegions,
-} from '@algolia/client-abtesting/src/abtestingClient';
-import type { AnalyticsClient } from '@algolia/client-analytics';
-import {
-  createAnalyticsClient,
-  REGIONS as analyticsRegions,
-} from '@algolia/client-analytics/src/analyticsClient';
-import type { Region as AnalyticsRegion } from '@algolia/client-analytics/src/analyticsClient';
+import type { AbtestingClient, Region as AbtestingRegion } from '@algolia/client-abtesting';
+import { abtestingClient } from '@algolia/client-abtesting';
+import type { AnalyticsClient, Region as AnalyticsRegion } from '@algolia/client-analytics';
+import { analyticsClient } from '@algolia/client-analytics';
+import type { ClientOptions } from '@algolia/client-common';
 import {
   DEFAULT_CONNECT_TIMEOUT_NODE,
   DEFAULT_READ_TIMEOUT_NODE,
@@ -22,22 +15,11 @@ import {
   createNullCache,
   serializeQueryParameters,
 } from '@algolia/client-common';
-import type {
-  ClientOptions,
-  CreateClientOptions,
-} from '@algolia/client-common';
-import type { PersonalizationClient } from '@algolia/client-personalization';
-import type { Region as PersonalizationRegion } from '@algolia/client-personalization/src/personalizationClient';
-import {
-  createPersonalizationClient,
-  REGIONS as personalizationRegions,
-} from '@algolia/client-personalization/src/personalizationClient';
-import {
-  createSearchClient,
-  apiClientVersion as searchClientVersion,
-} from '@algolia/client-search/src/searchClient';
+import type { PersonalizationClient, Region as PersonalizationRegion } from '@algolia/client-personalization';
+import { personalizationClient } from '@algolia/client-personalization';
+import { searchClient, apiClientVersion as searchClientVersion } from '@algolia/client-search';
 import type { RecommendClient } from '@algolia/recommend';
-import { createRecommendClient } from '@algolia/recommend/src/recommendClient';
+import { recommendClient } from '@algolia/recommend';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 import type {
@@ -57,11 +39,7 @@ export const apiClientVersion = searchClientVersion;
 export type Algoliasearch = ReturnType<typeof algoliasearch>;
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function algoliasearch(
-  appId: string,
-  apiKey: string,
-  options?: ClientOptions
-) {
+export function algoliasearch(appId: string, apiKey: string, options?: ClientOptions) {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
@@ -69,94 +47,54 @@ export function algoliasearch(
   if (!apiKey || typeof apiKey !== 'string') {
     throw new Error('`apiKey` is missing.');
   }
-  const commonOptions: CreateClientOptions = {
-    apiKey,
-    appId,
-    timeouts: {
-      connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-      read: DEFAULT_READ_TIMEOUT_NODE,
-      write: DEFAULT_WRITE_TIMEOUT_NODE,
-    },
-    requester: createHttpRequester(),
-    algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-    responsesCache: createNullCache(),
-    requestsCache: createNullCache(),
-    hostsCache: createMemoryCache(),
-    ...options,
-  };
 
   function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {
-    return createRecommendClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+    return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
   }
 
-  function initAnalytics(
-    initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
-  ): AnalyticsClient {
-    if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !analyticsRegions.includes(initOptions.region))
-    ) {
-      throw new Error(
-        `\`region\` must be one of the following: ${analyticsRegions.join(', ')}`
-      );
-    }
-
-    return createAnalyticsClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+  function initAnalytics(initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient {
+    return analyticsClient(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options,
+    );
   }
 
-  function initAbtesting(
-    initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}
-  ): AbtestingClient {
-    if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !abtestingRegions.includes(initOptions.region))
-    ) {
-      throw new Error(
-        `\`region\` must be one of the following: ${abtestingRegions.join(', ')}`
-      );
-    }
-
-    return createAbtestingClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+  function initAbtesting(initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient {
+    return abtestingClient(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options,
+    );
   }
 
   function initPersonalization(
-    initOptions: InitClientOptions &
-      Required<InitClientRegion<PersonalizationRegion>>
+    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
   ): PersonalizationClient {
-    if (
-      !initOptions.region ||
-      (initOptions.region &&
-        (typeof initOptions.region !== 'string' ||
-          !personalizationRegions.includes(initOptions.region)))
-    ) {
-      throw new Error(
-        `\`region\` is required and must be one of the following: ${personalizationRegions.join(', ')}`
-      );
-    }
-
-    return createPersonalizationClient({
-      ...commonOptions,
-      ...initOptions.options,
-      ...initOptions,
-    });
+    return personalizationClient(
+      initOptions.appId || appId,
+      initOptions.apiKey || apiKey,
+      initOptions.region,
+      initOptions.options,
+    );
   }
 
   return {
-    ...createSearchClient(commonOptions),
+    ...searchClient(appId, apiKey, {
+      timeouts: {
+        connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+        read: DEFAULT_READ_TIMEOUT_NODE,
+        write: DEFAULT_WRITE_TIMEOUT_NODE,
+      },
+      requester: createHttpRequester(),
+      algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+      responsesCache: createNullCache(),
+      requestsCache: createNullCache(),
+      hostsCache: createMemoryCache(),
+      ...options,
+    }),
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
@@ -175,10 +113,7 @@ export function algoliasearch(
      * @param generateSecuredApiKey.parentApiKey - The base API key from which to generate the new secured one.
      * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
      */
-    generateSecuredApiKey({
-      parentApiKey,
-      restrictions = {},
-    }: GenerateSecuredApiKeyOptions): string {
+    generateSecuredApiKey({ parentApiKey, restrictions = {} }: GenerateSecuredApiKeyOptions): string {
       let mergedRestrictions = restrictions;
       if (restrictions.searchParams) {
         // merge searchParams with the root restrictions
@@ -198,14 +133,12 @@ export function algoliasearch(
             acc[key] = (mergedRestrictions as any)[key];
             return acc;
           },
-          {} as Record<string, unknown>
+          {} as Record<string, unknown>,
         );
 
       const queryParameters = serializeQueryParameters(mergedRestrictions);
       return Buffer.from(
-        createHmac('sha256', parentApiKey)
-          .update(queryParameters)
-          .digest('hex') + queryParameters
+        createHmac('sha256', parentApiKey).update(queryParameters).digest('hex') + queryParameters,
       ).toString('base64');
     },
 
@@ -216,12 +149,8 @@ export function algoliasearch(
      * @param getSecuredApiKeyRemainingValidity - The `getSecuredApiKeyRemainingValidity` object.
      * @param getSecuredApiKeyRemainingValidity.securedApiKey - The secured API key generated with the `generateSecuredApiKey` method.
      */
-    getSecuredApiKeyRemainingValidity({
-      securedApiKey,
-    }: GetSecuredApiKeyRemainingValidityOptions): number {
-      const decodedString = Buffer.from(securedApiKey, 'base64').toString(
-        'ascii'
-      );
+    getSecuredApiKeyRemainingValidity({ securedApiKey }: GetSecuredApiKeyRemainingValidityOptions): number {
+      const decodedString = Buffer.from(securedApiKey, 'base64').toString('ascii');
       const regex = /validUntil=(\d+)/;
       const match = decodedString.match(regex);