algoliasearch 4.14.2 → 5.0.0-alpha.11

package/builds/browser.ts

@@ -0,0 +1,172 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type {
+  Region as AbtestingRegion,
+  AbtestingClient,
+} from '@algolia/client-abtesting/src/abtestingClient';
+import {
+  createAbtestingClient,
+  REGIONS as abtestingRegions,
+} from '@algolia/client-abtesting/src/abtestingClient';
+import type {
+  Region as AnalyticsRegion,
+  AnalyticsClient,
+} from '@algolia/client-analytics/src/analyticsClient';
+import {
+  createAnalyticsClient,
+  REGIONS as analyticsRegions,
+} from '@algolia/client-analytics/src/analyticsClient';
+import {
+  createMemoryCache,
+  createFallbackableCache,
+  createBrowserLocalStorageCache,
+  DEFAULT_CONNECT_TIMEOUT_BROWSER,
+  DEFAULT_READ_TIMEOUT_BROWSER,
+  DEFAULT_WRITE_TIMEOUT_BROWSER,
+} from '@algolia/client-common';
+import type {
+  CreateClientOptions,
+  ClientOptions,
+} from '@algolia/client-common';
+import {
+  createPersonalizationClient,
+  REGIONS as personalizationRegions,
+} from '@algolia/client-personalization/src/personalizationClient';
+import type {
+  Region as PersonalizationRegion,
+  PersonalizationClient,
+} from '@algolia/client-personalization/src/personalizationClient';
+import {
+  createSearchClient,
+  apiClientVersion as searchClientVersion,
+} from '@algolia/client-search/src/searchClient';
+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>;
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export function algoliasearch(
+  appId: string,
+  apiKey: string,
+  options?: ClientOptions
+) {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  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 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 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 initPersonalization(
+    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 {
+    ...createSearchClient(commonOptions),
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return this.transporter.algoliaAgent.value;
+    },
+    initAnalytics,
+    initPersonalization,
+    initAbtesting,
+  };
+}

package/builds/models.ts

@@ -0,0 +1,44 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type { ClientOptions } from '@algolia/client-common';
+import {
+  ErrorBase,
+  PutProps,
+  PostProps,
+  DelProps,
+  GetProps,
+} from '@algolia/client-search/model';
+
+export * from '@algolia/client-search/model';
+export * from '@algolia/client-personalization/model';
+export * from '@algolia/client-analytics/model';
+export * from '@algolia/client-abtesting/model';
+
+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 { ErrorBase, PutProps, PostProps, DelProps, GetProps };
+
+/**
+ * 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.
+   */
+  appId: string;
+  /**
+   * API key of the targeted app ID, defaults to the `algoliasearch` apiKey.
+   */
+  apiKey: string;
+  options: ClientOptions;
+}>;
+
+export type InitClientRegion<TRegion> = Partial<{
+  /**
+   * Available regions of the initialized client.
+   */
+  region: TRegion;
+}>;

package/builds/node.ts

@@ -0,0 +1,165 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import type {
+  Region as AbtestingRegion,
+  AbtestingClient,
+} from '@algolia/client-abtesting/src/abtestingClient';
+import {
+  createAbtestingClient,
+  REGIONS as abtestingRegions,
+} from '@algolia/client-abtesting/src/abtestingClient';
+import type {
+  Region as AnalyticsRegion,
+  AnalyticsClient,
+} from '@algolia/client-analytics/src/analyticsClient';
+import {
+  createAnalyticsClient,
+  REGIONS as analyticsRegions,
+} from '@algolia/client-analytics/src/analyticsClient';
+import {
+  DEFAULT_CONNECT_TIMEOUT_NODE,
+  DEFAULT_READ_TIMEOUT_NODE,
+  DEFAULT_WRITE_TIMEOUT_NODE,
+  createMemoryCache,
+  createNullCache,
+} from '@algolia/client-common';
+import type {
+  CreateClientOptions,
+  ClientOptions,
+} from '@algolia/client-common';
+import {
+  createPersonalizationClient,
+  REGIONS as personalizationRegions,
+} from '@algolia/client-personalization/src/personalizationClient';
+import type {
+  Region as PersonalizationRegion,
+  PersonalizationClient,
+} from '@algolia/client-personalization/src/personalizationClient';
+import {
+  createSearchClient,
+  apiClientVersion as searchClientVersion,
+} from '@algolia/client-search/src/searchClient';
+import { createHttpRequester } from '@algolia/requester-node-http';
+
+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?: ClientOptions
+) {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  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 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 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 initPersonalization(
+    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 {
+    ...createSearchClient(commonOptions),
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return this.transporter.algoliaAgent.value;
+    },
+    initAnalytics,
+    initPersonalization,
+    initAbtesting,
+  };
+}

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"}