feat(javascript): generate abtesting v3 alpha client (generated)

algolia/api-clients-automation#4783

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

package.json

@@ -7,7 +7,7 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "lerna run build --skip-nx-cache --scope '@algolia/requester-testing' --scope '@algolia/logger-console' --scope 'algoliasearch' --scope '@algolia/client-composition' --scope '@algolia/composition' --scope '@algolia/advanced-personalization' --include-dependencies ",
+    "build": "lerna run build --skip-nx-cache --scope '@algolia/requester-testing' --scope '@algolia/logger-console' --scope 'algoliasearch' --scope '@algolia/client-composition' --scope '@algolia/composition' --scope '@algolia/advanced-personalization' --scope '@algolia/abtesting' --include-dependencies ",
     "clean": "lerna run clean",
     "release:publish": "tsc --project scripts/tsconfig.json && node scripts/dist/publish.js",
     "test": "lerna run test $*",

packages/abtesting/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-Present Algolia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/abtesting/README.md

@@ -0,0 +1,77 @@
+<p align="center">
+  <a href="https://www.algolia.com">
+    <img alt="Algolia for JavaScript" src="https://raw.githubusercontent.com/algolia/algoliasearch-client-common/master/banners/javascript.png" >
+  </a>
+
+  <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your JavaScript project</h4>
+
+  <p align="center">
+    <a href="https://npmjs.org/package/@algolia/abtesting"><img src="https://img.shields.io/npm/v/@algolia/abtesting.svg?style=flat-square" alt="NPM version"></img></a>
+    <a href="http://npm-stat.com/charts.html?package=@algolia/abtesting"><img src="https://img.shields.io/npm/dm/@algolia/abtesting.svg?style=flat-square" alt="NPM downloads"></a>
+    <a href="https://www.jsdelivr.com/package/npm/@algolia/abtesting"><img src="https://data.jsdelivr.com/v1/package/npm/@algolia/abtesting/badge" alt="jsDelivr Downloads"></img></a>
+    <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg?style=flat-square" alt="License"></a>
+  </p>
+</p>
+
+<p align="center">
+  <a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a>  •
+  <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
+  <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
+  <a href="https://github.com/algolia/algoliasearch-client-javascript/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/doc/libraries/javascript/v5/" target="_blank">FAQ</a>  •
+  <a href="https://alg.li/support" target="_blank">Support</a>
+</p>
+
+## ✨ Features
+
+- Thin & **minimal low-level HTTP client** to interact with Algolia's API
+- Works both on the **browser** and **node.js**
+- **UMD and ESM compatible**, you can use it with any module loader
+- Built with TypeScript
+
+## 💡 Getting Started
+
+> [!TIP]
+> This API client is already a dependency of [the algoliasearch client](https://www.npmjs.com/package/algoliasearch), you don't need to manually install `@algolia/abtesting` if you already have `algoliasearch` installed.
+
+To get started, you first need to install @algolia/abtesting (or any other available API client package).
+All of our clients comes with type definition, and are available for both browser and node environments.
+
+### With a package manager
+
+```bash
+yarn add @algolia/[email protected]
+# or
+npm install @algolia/[email protected]
+# or
+pnpm add @algolia/[email protected]
+```
+
+### Without a package manager
+
+Add the following JavaScript snippet to the <head> of your website:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@algolia/[email protected]/dist/builds/browser.umd.js"></script>
+```
+
+### Usage
+
+You can now import the Algolia API client in your project and play with it.
+
+```js
+import { abtestingClient } from '@algolia/abtesting';
+
+const client = abtestingClient('YOUR_APP_ID', 'YOUR_API_KEY');
+```
+
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/v5/methods/abtesting/)**.
+
+## ❓ Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/libraries/javascript/v5/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
+
+## 📄 License
+
+The Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE).

packages/abtesting/builds/browser.ts

@@ -0,0 +1,65 @@
+// 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 { createXhrRequester } from '@algolia/requester-browser-xhr';
+
+import {
+  createBrowserLocalStorageCache,
+  createFallbackableCache,
+  createMemoryCache,
+  createNullLogger,
+} from '@algolia/client-common';
+
+import type { ClientOptions } from '@algolia/client-common';
+
+import { apiClientVersion, createAbtestingClient } from '../src/abtestingClient';
+
+import type { Region } from '../src/abtestingClient';
+import { REGIONS } from '../src/abtestingClient';
+
+export type { Region, RegionOptions } from '../src/abtestingClient';
+
+export { apiClientVersion } from '../src/abtestingClient';
+
+export * from '../model';
+
+export function abtestingClient(
+  appId: string,
+  apiKey: string,
+  region?: Region | undefined,
+  options?: ClientOptions | undefined,
+): AbtestingClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+    throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+  }
+
+  return createAbtestingClient({
+    appId,
+    apiKey,
+    region,
+    timeouts: {
+      connect: 1000,
+      read: 2000,
+      write: 30000,
+    },
+    logger: createNullLogger(),
+    requester: createXhrRequester(),
+    algoliaAgents: [{ segment: 'Browser' }],
+    authMode: 'WithinQueryParameters',
+    responsesCache: createMemoryCache(),
+    requestsCache: createMemoryCache({ serializable: false }),
+    hostsCache: createFallbackableCache({
+      caches: [createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }), createMemoryCache()],
+    }),
+    ...options,
+  });
+}
+
+export type AbtestingClient = ReturnType<typeof createAbtestingClient>;

packages/abtesting/builds/fetch.ts

@@ -0,0 +1,58 @@
+// 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.
+
+export type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+
+import { createMemoryCache, createNullCache, createNullLogger } from '@algolia/client-common';
+import { createFetchRequester } from '@algolia/requester-fetch';
+
+import type { ClientOptions } from '@algolia/client-common';
+
+import { createAbtestingClient } from '../src/abtestingClient';
+
+import type { Region } from '../src/abtestingClient';
+import { REGIONS } from '../src/abtestingClient';
+
+export type { Region, RegionOptions } from '../src/abtestingClient';
+
+export { apiClientVersion } from '../src/abtestingClient';
+
+export * from '../model';
+
+export function abtestingClient(
+  appId: string,
+  apiKey: string,
+  region?: Region | undefined,
+  options?: ClientOptions | undefined,
+): AbtestingClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+    throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+  }
+
+  return {
+    ...createAbtestingClient({
+      appId,
+      apiKey,
+      region,
+      timeouts: {
+        connect: 2000,
+        read: 5000,
+        write: 30000,
+      },
+      logger: createNullLogger(),
+      requester: createFetchRequester(),
+      algoliaAgents: [{ segment: 'Fetch' }],
+      responsesCache: createNullCache(),
+      requestsCache: createNullCache(),
+      hostsCache: createMemoryCache(),
+      ...options,
+    }),
+  };
+}

packages/abtesting/builds/node.ts

@@ -0,0 +1,59 @@
+// 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.
+
+export type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+
+import { createHttpRequester } from '@algolia/requester-node-http';
+
+import { createMemoryCache, createNullCache, createNullLogger } from '@algolia/client-common';
+
+import type { ClientOptions } from '@algolia/client-common';
+
+import { createAbtestingClient } from '../src/abtestingClient';
+
+import type { Region } from '../src/abtestingClient';
+import { REGIONS } from '../src/abtestingClient';
+
+export type { Region, RegionOptions } from '../src/abtestingClient';
+
+export { apiClientVersion } from '../src/abtestingClient';
+
+export * from '../model';
+
+export function abtestingClient(
+  appId: string,
+  apiKey: string,
+  region?: Region | undefined,
+  options?: ClientOptions | undefined,
+): AbtestingClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+    throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+  }
+
+  return {
+    ...createAbtestingClient({
+      appId,
+      apiKey,
+      region,
+      timeouts: {
+        connect: 2000,
+        read: 5000,
+        write: 30000,
+      },
+      logger: createNullLogger(),
+      requester: createHttpRequester(),
+      algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+      responsesCache: createNullCache(),
+      requestsCache: createNullCache(),
+      hostsCache: createMemoryCache(),
+      ...options,
+    }),
+  };
+}

packages/abtesting/builds/worker.ts

@@ -0,0 +1,58 @@
+// 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.
+
+export type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+
+import { createMemoryCache, createNullCache, createNullLogger } from '@algolia/client-common';
+import { createFetchRequester } from '@algolia/requester-fetch';
+
+import type { ClientOptions } from '@algolia/client-common';
+
+import { createAbtestingClient } from '../src/abtestingClient';
+
+import type { Region } from '../src/abtestingClient';
+import { REGIONS } from '../src/abtestingClient';
+
+export type { Region, RegionOptions } from '../src/abtestingClient';
+
+export { apiClientVersion } from '../src/abtestingClient';
+
+export * from '../model';
+
+export function abtestingClient(
+  appId: string,
+  apiKey: string,
+  region?: Region | undefined,
+  options?: ClientOptions | undefined,
+): AbtestingClient {
+  if (!appId || typeof appId !== 'string') {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey || typeof apiKey !== 'string') {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+    throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+  }
+
+  return {
+    ...createAbtestingClient({
+      appId,
+      apiKey,
+      region,
+      timeouts: {
+        connect: 2000,
+        read: 5000,
+        write: 30000,
+      },
+      logger: createNullLogger(),
+      requester: createFetchRequester(),
+      algoliaAgents: [{ segment: 'Worker' }],
+      responsesCache: createNullCache(),
+      requestsCache: createNullCache(),
+      hostsCache: createMemoryCache(),
+      ...options,
+    }),
+  };
+}

packages/abtesting/index.d.ts

@@ -0,0 +1 @@
+export * from './dist/node';

packages/abtesting/index.js

@@ -0,0 +1 @@
+module.exports = require('./dist/builds/node.cjs');