algoliasearch 5.0.0-alpha.1 → 5.0.0-alpha.12

package/builds/browser.ts

@@ -24,7 +24,10 @@ import {
   DEFAULT_READ_TIMEOUT_BROWSER,
   DEFAULT_WRITE_TIMEOUT_BROWSER,
 } from '@algolia/client-common';
-import type { CreateClientOptions } from '@algolia/client-common';
+import type {
+  CreateClientOptions,
+  ClientOptions,
+} from '@algolia/client-common';
 import {
   createPersonalizationClient,
   REGIONS as personalizationRegions,
@@ -39,23 +42,22 @@ import {
 } from '@algolia/client-search/src/searchClient';
 import { createXhrRequester } from '@algolia/requester-browser-xhr';
 
-import type {
-  CommonInitOptions,
-  InitRegion,
-  CommonClientOptions,
-} from './models';
+import type { InitClientOptions, InitClientRegion } from './models';
 
 export * from './models';
 
 export const apiClientVersion = searchClientVersion;
 
+/**
+ * The client type.
+ */
 export type Algoliasearch = ReturnType<typeof algoliasearch>;
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function algoliasearch(
   appId: string,
   apiKey: string,
-  options?: CommonClientOptions
+  options?: ClientOptions
 ) {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
@@ -88,7 +90,7 @@ export function algoliasearch(
   };
 
   function initAnalytics(
-    initOptions: CommonInitOptions & InitRegion<AnalyticsRegion> = {}
+    initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
   ): AnalyticsClient {
     if (
       initOptions.region &&
@@ -110,7 +112,7 @@ export function algoliasearch(
   }
 
   function initAbtesting(
-    initOptions: CommonInitOptions & InitRegion<AbtestingRegion> = {}
+    initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}
   ): AbtestingClient {
     if (
       initOptions.region &&
@@ -132,19 +134,17 @@ export function algoliasearch(
   }
 
   function initPersonalization(
-    initOptions: CommonInitOptions & Required<InitRegion<PersonalizationRegion>>
+    initOptions: InitClientOptions &
+      Required<InitClientRegion<PersonalizationRegion>>
   ): PersonalizationClient {
-    if (!initOptions.region) {
-      throw new Error('`region` is missing.');
-    }
-
     if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !personalizationRegions.includes(initOptions.region))
+      !initOptions.region ||
+      (initOptions.region &&
+        (typeof initOptions.region !== 'string' ||
+          !personalizationRegions.includes(initOptions.region)))
     ) {
       throw new Error(
-        `\`region\` must be one of the following: ${personalizationRegions.join(
+        `\`region\` is required and must be one of the following: ${personalizationRegions.join(
           ', '
         )}`
       );

package/builds/models.ts

@@ -1,6 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { Host, Requester } from '@algolia/client-common';
+import type { ClientOptions } from '@algolia/client-common';
 import {
   ErrorBase,
   PutProps,
@@ -14,11 +14,17 @@ export * from '@algolia/client-personalization/model';
 export * from '@algolia/client-analytics/model';
 export * from '@algolia/client-abtesting/model';
 
-export { ErrorBase, PutProps, PostProps, DelProps, GetProps };
+export { SearchClient } from '@algolia/client-search';
+export { PersonalizationClient } from '@algolia/client-personalization';
+export { AnalyticsClient } from '@algolia/client-analytics';
+export { AbtestingClient } from '@algolia/client-abtesting';
 
-export type CommonClientOptions = { requester?: Requester; hosts?: Host[] };
+export { ErrorBase, PutProps, PostProps, DelProps, GetProps };
 
-export type CommonInitOptions = Partial<{
+/**
+ * Options forwarded to the client initialized via the `init` method.
+ */
+export type InitClientOptions = Partial<{
   /**
    * App to target with the initialized client, defaults to the `algoliasearch` appId.
    */
@@ -27,10 +33,10 @@ export type CommonInitOptions = Partial<{
    * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.
    */
   apiKey: string;
-  options: CommonClientOptions;
+  options: ClientOptions;
 }>;
 
-export type InitRegion<TRegion> = Partial<{
+export type InitClientRegion<TRegion> = Partial<{
   /**
    * Available regions of the initialized client.
    */

package/builds/node.ts

@@ -23,7 +23,10 @@ import {
   createMemoryCache,
   createNullCache,
 } from '@algolia/client-common';
-import type { CreateClientOptions } from '@algolia/client-common';
+import type {
+  CreateClientOptions,
+  ClientOptions,
+} from '@algolia/client-common';
 import {
   createPersonalizationClient,
   REGIONS as personalizationRegions,
@@ -38,23 +41,22 @@ import {
 } from '@algolia/client-search/src/searchClient';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
-import type {
-  CommonInitOptions,
-  InitRegion,
-  CommonClientOptions,
-} from './models';
+import type { InitClientOptions, InitClientRegion } from './models';
 
 export * from './models';
 
 export const apiClientVersion = searchClientVersion;
 
+/**
+ * The client type.
+ */
 export type Algoliasearch = ReturnType<typeof algoliasearch>;
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 export function algoliasearch(
   appId: string,
   apiKey: string,
-  options?: CommonClientOptions
+  options?: ClientOptions
 ) {
   if (!appId || typeof appId !== 'string') {
     throw new Error('`appId` is missing.');
@@ -81,7 +83,7 @@ export function algoliasearch(
   };
 
   function initAnalytics(
-    initOptions: CommonInitOptions & InitRegion<AnalyticsRegion> = {}
+    initOptions: InitClientOptions & InitClientRegion<AnalyticsRegion> = {}
   ): AnalyticsClient {
     if (
       initOptions.region &&
@@ -103,7 +105,7 @@ export function algoliasearch(
   }
 
   function initAbtesting(
-    initOptions: CommonInitOptions & InitRegion<AbtestingRegion> = {}
+    initOptions: InitClientOptions & InitClientRegion<AbtestingRegion> = {}
   ): AbtestingClient {
     if (
       initOptions.region &&
@@ -125,19 +127,17 @@ export function algoliasearch(
   }
 
   function initPersonalization(
-    initOptions: CommonInitOptions & Required<InitRegion<PersonalizationRegion>>
+    initOptions: InitClientOptions &
+      Required<InitClientRegion<PersonalizationRegion>>
   ): PersonalizationClient {
-    if (!initOptions.region) {
-      throw new Error('`region` is missing.');
-    }
-
     if (
-      initOptions.region &&
-      (typeof initOptions.region !== 'string' ||
-        !personalizationRegions.includes(initOptions.region))
+      !initOptions.region ||
+      (initOptions.region &&
+        (typeof initOptions.region !== 'string' ||
+          !personalizationRegions.includes(initOptions.region)))
     ) {
       throw new Error(
-        `\`region\` must be one of the following: ${personalizationRegions.join(
+        `\`region\` is required and must be one of the following: ${personalizationRegions.join(
           ', '
         )}`
       );

package/dist/algoliasearch/jest.config.d.ts

@@ -0,0 +1,4 @@
+import type { Config } from '@jest/types';
+declare const config: Config.InitialOptions;
+export default config;
+//# sourceMappingURL=jest.config.d.ts.map

package/dist/algoliasearch/jest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jest.config.d.ts","sourceRoot":"","sources":["../../jest.config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAE1C,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,cAKpB,CAAC;AAEF,eAAe,MAAM,CAAC"}