algoliasearch 5.2.4 → 5.3.0

package/builds/browser.ts

@@ -5,34 +5,27 @@ 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,
-  DEFAULT_WRITE_TIMEOUT_BROWSER,
-  createBrowserLocalStorageCache,
-  createFallbackableCache,
-  createMemoryCache,
-} from '@algolia/client-common';
 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 { SearchClient } from '@algolia/client-search';
+import { searchClient } from '@algolia/client-search';
 import type { RecommendClient } from '@algolia/recommend';
 import { recommendClient } from '@algolia/recommend';
-import { createXhrRequester } from '@algolia/requester-browser-xhr';
 
 import type { InitClientOptions, InitClientRegion } from './models';
 
 export * from './models';
 
-export const apiClientVersion = searchClientVersion;
-
-/**
- * The client type.
- */
-export type Algoliasearch = ReturnType<typeof algoliasearch>;
+export type Algoliasearch = SearchClient & {
+  initRecommend: (initOptions: InitClientOptions) => RecommendClient;
+  initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
+  initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
+  initPersonalization: (
+    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
+  ) => PersonalizationClient;
+};
 
-// 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): Algoliasearch {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
@@ -41,65 +34,45 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
     throw new Error('`apiKey` is missing.');
   }
 
-  function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {
-    return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
-  }
-
-  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 {
-    return abtestingClient(
-      initOptions.appId || appId,
-      initOptions.apiKey || apiKey,
-      initOptions.region,
-      initOptions.options,
-    );
-  }
-
-  function initPersonalization(
-    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
-  ): PersonalizationClient {
-    return personalizationClient(
-      initOptions.appId || appId,
-      initOptions.apiKey || apiKey,
-      initOptions.region,
-      initOptions.options,
-    );
-  }
-
   return {
-    ...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,
-    }),
+    ...searchClient(appId, apiKey, options),
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return this.transporter.algoliaAgent.value;
     },
-    initAbtesting,
-    initAnalytics,
-    initPersonalization,
-    initRecommend,
+    initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => {
+      return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
+    },
+
+    initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient => {
+      return analyticsClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
+
+    initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient => {
+      return abtestingClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
+
+    initPersonalization: (
+      initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
+    ): PersonalizationClient => {
+      return personalizationClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
   };
 }

package/builds/models.ts

@@ -1,7 +1,9 @@
 // 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 { Region as AbTestingRegion } from '@algolia/client-abtesting';
+import type { Region as AnalyticsRegion } from '@algolia/client-analytics';
 import type { ClientOptions } from '@algolia/client-common';
-import {
+import type {
   AdvancedSyntaxFeatures,
   AlternativesAsExact,
   Anchoring,
@@ -74,19 +76,16 @@ import {
   TypoTolerance,
   TypoToleranceEnum,
   Value,
-} from '@algolia/client-search/model';
+} from '@algolia/client-search';
+import { apiClientVersion } from '@algolia/client-search';
 
-export * from '@algolia/client-search/model';
-export * from '@algolia/recommend/model';
-export * from '@algolia/client-personalization/model';
-export * from '@algolia/client-analytics/model';
-export * from '@algolia/client-abtesting/model';
+type Region = AbTestingRegion | AnalyticsRegion;
 
-export { SearchClient } from '@algolia/client-search';
-export { RecommendClient } from '@algolia/recommend';
-export { PersonalizationClient } from '@algolia/client-personalization';
-export { AnalyticsClient } from '@algolia/client-analytics';
-export { AbtestingClient } from '@algolia/client-abtesting';
+export * from '@algolia/client-search';
+export * from '@algolia/recommend';
+export * from '@algolia/client-personalization';
+export * from '@algolia/client-analytics';
+export * from '@algolia/client-abtesting';
 
 export {
   AdvancedSyntaxFeatures,
@@ -161,6 +160,10 @@ export {
   TypoTolerance,
   TypoToleranceEnum,
   Value,
+  AnalyticsRegion,
+  AbTestingRegion,
+  Region,
+  apiClientVersion,
 };
 
 /**

package/builds/node.ts

@@ -1,45 +1,31 @@
 // 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 'node:crypto';
-
 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,
-  DEFAULT_WRITE_TIMEOUT_NODE,
-  createMemoryCache,
-  createNullCache,
-  serializeQueryParameters,
-} from '@algolia/client-common';
 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 { SearchClient } from '@algolia/client-search';
+import { searchClient } from '@algolia/client-search';
 import type { RecommendClient } from '@algolia/recommend';
 import { recommendClient } from '@algolia/recommend';
-import { createHttpRequester } from '@algolia/requester-node-http';
 
-import type {
-  InitClientOptions,
-  InitClientRegion,
-  GenerateSecuredApiKeyOptions,
-  GetSecuredApiKeyRemainingValidityOptions,
-} from './models';
+import type { InitClientOptions, InitClientRegion } from './models';
 
 export * from './models';
 
-export const apiClientVersion = searchClientVersion;
-
-/**
- * The client type.
- */
-export type Algoliasearch = ReturnType<typeof algoliasearch>;
+export type Algoliasearch = SearchClient & {
+  initRecommend: (initOptions: InitClientOptions) => RecommendClient;
+  initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion>) => AnalyticsClient;
+  initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion>) => AbtestingClient;
+  initPersonalization: (
+    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
+  ) => PersonalizationClient;
+};
 
-// 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): Algoliasearch {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
   }
@@ -48,117 +34,45 @@ export function algoliasearch(appId: string, apiKey: string, options?: ClientOpt
     throw new Error('`apiKey` is missing.');
   }
 
-  function initRecommend(initOptions: InitClientOptions = {}): RecommendClient {
-    return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
-  }
-
-  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 {
-    return abtestingClient(
-      initOptions.appId || appId,
-      initOptions.apiKey || apiKey,
-      initOptions.region,
-      initOptions.options,
-    );
-  }
-
-  function initPersonalization(
-    initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
-  ): PersonalizationClient {
-    return personalizationClient(
-      initOptions.appId || appId,
-      initOptions.apiKey || apiKey,
-      initOptions.region,
-      initOptions.options,
-    );
-  }
-
   return {
-    ...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,
-    }),
+    ...searchClient(appId, apiKey, options),
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return this.transporter.algoliaAgent.value;
     },
-    initAbtesting,
-    initAnalytics,
-    initPersonalization,
-    initRecommend,
-    /**
-     * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-     *
-     * @summary Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
-     * @param generateSecuredApiKey - The `generateSecuredApiKey` object.
-     * @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 {
-      let mergedRestrictions = restrictions;
-      if (restrictions.searchParams) {
-        // merge searchParams with the root restrictions
-        mergedRestrictions = {
-          ...restrictions,
-          ...restrictions.searchParams,
-        };
-
-        delete mergedRestrictions.searchParams;
-      }
-
-      mergedRestrictions = Object.keys(mergedRestrictions)
-        .sort()
-        .reduce(
-          (acc, key) => {
-            // eslint-disable-next-line no-param-reassign
-            acc[key] = (mergedRestrictions as any)[key];
-            return acc;
-          },
-          {} as Record<string, unknown>,
-        );
-
-      const queryParameters = serializeQueryParameters(mergedRestrictions);
-      return Buffer.from(
-        createHmac('sha256', parentApiKey).update(queryParameters).digest('hex') + queryParameters,
-      ).toString('base64');
+    initRecommend: (initOptions: InitClientOptions = {}): RecommendClient => {
+      return recommendClient(initOptions.appId || appId, initOptions.apiKey || apiKey, initOptions.options);
     },
 
-    /**
-     * Helper: Retrieves the remaining validity of the previous generated `securedApiKey`, the `ValidUntil` parameter must have been provided.
-     *
-     * @summary Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `ValidUntil` parameter must have been provided.
-     * @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');
-      const regex = /validUntil=(\d+)/;
-      const match = decodedString.match(regex);
+    initAnalytics: (initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}): AnalyticsClient => {
+      return analyticsClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
 
-      if (match === null) {
-        throw new Error('validUntil not found in given secured api key.');
-      }
+    initAbtesting: (initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}): AbtestingClient => {
+      return abtestingClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
+    },
 
-      return parseInt(match[1], 10) - Math.round(new Date().getTime() / 1000);
+    initPersonalization: (
+      initOptions: InitClientOptions & Required<InitClientRegion<PersonalizationRegion>>,
+    ): PersonalizationClient => {
+      return personalizationClient(
+        initOptions.appId || appId,
+        initOptions.apiKey || apiKey,
+        initOptions.region,
+        initOptions.options,
+      );
     },
   };
 }