algoliasearch 4.14.2 → 5.0.0-alpha.3

package/lite/src/liteClient.ts

@@ -0,0 +1,210 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+import {
+  createAuth,
+  createTransporter,
+  getAlgoliaAgent,
+  shuffle,
+} from '@algolia/client-common';
+import type {
+  CreateClientOptions,
+  Headers,
+  Host,
+  Request,
+  RequestOptions,
+  QueryParameters,
+} from '@algolia/client-common';
+
+import type {
+  PostProps,
+  LegacySearchMethodProps,
+} from '../model/clientMethodProps';
+import type { SearchMethodParams } from '../model/searchMethodParams';
+import type { SearchResponses } from '../model/searchResponses';
+
+export const apiClientVersion = '5.0.0-alpha.3';
+
+function getDefaultHosts(appId: string): Host[] {
+  return (
+    [
+      {
+        url: `${appId}-dsn.algolia.net`,
+        accept: 'read',
+        protocol: 'https',
+      },
+      {
+        url: `${appId}.algolia.net`,
+        accept: 'write',
+        protocol: 'https',
+      },
+    ] as Host[]
+  ).concat(
+    shuffle([
+      {
+        url: `${appId}-1.algolianet.com`,
+        accept: 'readWrite',
+        protocol: 'https',
+      },
+      {
+        url: `${appId}-2.algolianet.com`,
+        accept: 'readWrite',
+        protocol: 'https',
+      },
+      {
+        url: `${appId}-3.algolianet.com`,
+        accept: 'readWrite',
+        protocol: 'https',
+      },
+    ])
+  );
+}
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export function createLiteClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  ...options
+}: CreateClientOptions) {
+  const auth = createAuth(appIdOption, apiKeyOption, authMode);
+  const transporter = createTransporter({
+    hosts: getDefaultHosts(appIdOption),
+    ...options,
+    algoliaAgent: getAlgoliaAgent({
+      algoliaAgents,
+      client: 'Lite',
+      version: apiClientVersion,
+    }),
+    baseHeaders: {
+      'content-type': 'text/plain',
+      ...auth.headers(),
+      ...options.baseHeaders,
+    },
+    baseQueryParameters: {
+      ...auth.queryParameters(),
+      ...options.baseQueryParameters,
+    },
+  });
+
+  return {
+    transporter,
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    get _ua(): string {
+      return transporter.algoliaAgent.value;
+    },
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void {
+      transporter.algoliaAgent.add({ segment, version });
+    },
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param post - The post object.
+     * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
+     * @param post.parameters - Query parameters to be applied to the current query.
+     * @param post.body - The parameters to send with the custom request.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    post(
+      { path, parameters, body }: PostProps,
+      requestOptions?: RequestOptions
+    ): Promise<Record<string, any>> {
+      if (!path) {
+        throw new Error('Parameter `path` is required when calling `post`.');
+      }
+
+      const requestPath = '/1{path}'.replace('{path}', path);
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = parameters ? parameters : {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {},
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+
+    /**
+     * Perform a search operation targeting one or many indices.
+     *
+     * @summary Search multiple indices.
+     * @param searchMethodParams - The `search` requests and strategy.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    search<T>(
+      searchMethodParams: LegacySearchMethodProps | SearchMethodParams,
+      requestOptions?: RequestOptions
+    ): Promise<SearchResponses<T>> {
+      if (searchMethodParams && Array.isArray(searchMethodParams)) {
+        const newSignatureRequest: SearchMethodParams = {
+          requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+            if (legacyRequest.type === 'facet') {
+              return {
+                ...legacyRequest,
+                ...params,
+                type: 'facet',
+              };
+            }
+
+            return {
+              ...legacyRequest,
+              ...params,
+              facet: undefined,
+              maxFacetHits: undefined,
+              facetQuery: undefined,
+            };
+          }),
+        };
+
+        // eslint-disable-next-line no-param-reassign
+        searchMethodParams = newSignatureRequest;
+      }
+
+      if (!searchMethodParams) {
+        throw new Error(
+          'Parameter `searchMethodParams` is required when calling `search`.'
+        );
+      }
+
+      if (!searchMethodParams.requests) {
+        throw new Error(
+          'Parameter `searchMethodParams.requests` is required when calling `search`.'
+        );
+      }
+
+      const requestPath = '/1/indexes/*/queries';
+      const headers: Headers = {};
+      const queryParameters: QueryParameters = {};
+
+      const request: Request = {
+        method: 'POST',
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: searchMethodParams,
+        useReadTransporter: true,
+        cacheable: true,
+      };
+
+      return transporter.request(request, requestOptions);
+    },
+  };
+}
+
+/**
+ * The client type.
+ */
+export type LiteClient = ReturnType<typeof createLiteClient>;

package/lite.d.ts

@@ -1,3 +1,2 @@
-/* eslint-disable import/no-unresolved*/
-export * from './dist/algoliasearch-lite';
-export { default } from './dist/algoliasearch-lite';
+// eslint-disable-next-line import/no-unresolved
+export * from './dist/lite/lite/builds/node';

package/lite.js

@@ -1,2 +1,2 @@
-// eslint-disable-next-line functional/immutable-data, import/no-commonjs
-module.exports = require('./index');
+// eslint-disable-next-line import/no-commonjs,import/extensions
+module.exports = require('./dist/lite/lite.cjs.js');

package/package.json

@@ -1,43 +1,79 @@
 {
   "name": "algoliasearch",
-  "version": "4.14.2",
-  "private": false,
+  "version": "5.0.0-alpha.3",
   "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/algolia/algoliasearch-client-javascript.git"
-  },
+  "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
-  "sideEffects": false,
-  "main": "index.js",
+  "author": "Algolia",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "node": {
+        "import": "./dist/algoliasearch.esm.node.js",
+        "module": "./dist/algoliasearch.esm.node.js",
+        "require": "./dist/algoliasearch.cjs.js",
+        "default": "./dist/algoliasearch.cjs.js"
+      },
+      "browser": {
+        "umd": "./dist/algoliasearch.umd.js",
+        "module": "./dist/algoliasearch.esm.browser.js",
+        "import": "./dist/algoliasearch.esm.browser.js",
+        "default": "./dist/algoliasearch.umd.js"
+      }
+    },
+    "./lite": {
+      "types": "./lite.d.ts",
+      "node": {
+        "import": "./dist/lite/lite.esm.node.js",
+        "module": "./dist/lite/lite.esm.node.js",
+        "require": "./dist/lite/lite.cjs.js",
+        "default": "./dist/lite/lite.cjs.js"
+      },
+      "browser": {
+        "umd": "./dist/lite/lite.umd.js",
+        "module": "./dist/lite/lite.esm.browser.js",
+        "import": "./dist/lite/lite.esm.browser.js",
+        "default": "./dist/lite/lite.umd.js"
+      }
+    }
+  },
   "jsdelivr": "./dist/algoliasearch.umd.js",
   "unpkg": "./dist/algoliasearch.umd.js",
   "browser": {
     "./index.js": "./dist/algoliasearch.umd.js",
-    "./lite.js": "./dist/algoliasearch-lite.umd.js"
+    "./lite.js": "./dist/lite/lite.umd.js"
   },
   "types": "index.d.ts",
   "files": [
     "dist",
+    "builds",
     "index.js",
     "index.d.ts",
+    "lite",
     "lite.js",
     "lite.d.ts"
   ],
+  "scripts": {
+    "clean": "rm -rf ./dist",
+    "test": "jest"
+  },
   "dependencies": {
-    "@algolia/cache-browser-local-storage": "4.14.2",
-    "@algolia/cache-common": "4.14.2",
-    "@algolia/cache-in-memory": "4.14.2",
-    "@algolia/client-account": "4.14.2",
-    "@algolia/client-analytics": "4.14.2",
-    "@algolia/client-common": "4.14.2",
-    "@algolia/client-personalization": "4.14.2",
-    "@algolia/client-search": "4.14.2",
-    "@algolia/logger-common": "4.14.2",
-    "@algolia/logger-console": "4.14.2",
-    "@algolia/requester-browser-xhr": "4.14.2",
-    "@algolia/requester-common": "4.14.2",
-    "@algolia/requester-node-http": "4.14.2",
-    "@algolia/transporter": "4.14.2"
+    "@algolia/client-abtesting": "5.0.0-alpha.3",
+    "@algolia/client-analytics": "5.0.0-alpha.3",
+    "@algolia/client-common": "5.0.0-alpha.3",
+    "@algolia/client-personalization": "5.0.0-alpha.3",
+    "@algolia/client-search": "5.0.0-alpha.3",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.3",
+    "@algolia/requester-node-http": "5.0.0-alpha.3"
+  },
+  "devDependencies": {
+    "@types/jest": "28.1.6",
+    "@types/node": "16.11.45",
+    "jest": "28.1.3",
+    "ts-jest": "28.0.7",
+    "typescript": "4.7.4"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
   }
 }

package/README.md

@@ -1,82 +0,0 @@
-<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/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>
-  </p>
-</p>
-
-<p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/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/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 compatible**, you can use it with any module loader
-- Built with TypeScript
-
-## 💡 Getting Started
-
-First, install Algolia JavaScript API Client via the [npm](https://www.npmjs.com/get-npm) package manager:
-
-```bash
-npm install algoliasearch
-```
-
-Then, create objects on your index:
-
-```js
-const algoliasearch = require("algoliasearch");
-
-const client = algoliasearch("YourApplicationID", "YourAdminAPIKey");
-const index = client.initIndex("your_index_name");
-
-const objects = [
-  {
-    objectID: 1,
-    name: "Foo"
-  }
-];
-
-index
-  .saveObjects(objects)
-  .then(({ objectIDs }) => {
-    console.log(objectIDs);
-  })
-  .catch(err => {
-    console.log(err);
-  });
-```
-
-Finally, let's actually search using the `search` method:
-
-```js
-index
-  .search("Fo")
-  .then(({ hits }) => {
-    console.log(hits);
-  })
-  .catch(err => {
-    console.log(err);
-  });
-```
-
-For full documentation, visit the **[online documentation](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
-
-## 📄 License
-
-Algolia JavaScript API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

package/dist/algoliasearch-lite.d.ts

@@ -1,49 +0,0 @@
-import { ClientTransporterOptions } from '@algolia/client-common';
-import { FindAnswersOptions } from '@algolia/client-search';
-import { FindAnswersResponse } from '@algolia/client-search';
-import { MultipleQueriesOptions } from '@algolia/client-search';
-import { MultipleQueriesQuery } from '@algolia/client-search';
-import { MultipleQueriesResponse } from '@algolia/client-search';
-import { Request } from '@algolia/transporter';
-import { RequestOptions } from '@algolia/transporter';
-import { SearchClient as SearchClient_2 } from '@algolia/client-search';
-import { SearchClientOptions } from '@algolia/client-search';
-import { SearchForFacetValuesQueryParams } from '@algolia/client-search';
-import { SearchForFacetValuesResponse } from '@algolia/client-search';
-import { SearchIndex as SearchIndex_2 } from '@algolia/client-search';
-import { SearchOptions } from '@algolia/client-search';
-import { SearchResponse } from '@algolia/client-search';
-
-declare function algoliasearch(appId: string, apiKey: string, options?: AlgoliaSearchOptions): SearchClient;
-
-declare namespace algoliasearch {
-    var version: string;
-}
-export default algoliasearch;
-
-export declare type AlgoliaSearchOptions = Partial<ClientTransporterOptions> & WithoutCredentials<SearchClientOptions>;
-
-declare type Credentials = {
-    readonly appId: string;
-    readonly apiKey: string;
-};
-
-export declare type SearchClient = SearchClient_2 & {
-    readonly initIndex: (indexName: string) => SearchIndex;
-    readonly search: <TObject>(queries: readonly MultipleQueriesQuery[], requestOptions?: RequestOptions & MultipleQueriesOptions) => Readonly<Promise<MultipleQueriesResponse<TObject>>>;
-    readonly searchForFacetValues: (queries: ReadonlyArray<{
-        readonly indexName: string;
-        readonly params: SearchForFacetValuesQueryParams & SearchOptions;
-    }>, requestOptions?: RequestOptions) => Readonly<Promise<readonly SearchForFacetValuesResponse[]>>;
-    readonly customRequest: <TResponse>(request: Request, requestOptions?: RequestOptions) => Readonly<Promise<TResponse>>;
-};
-
-export declare type SearchIndex = SearchIndex_2 & {
-    readonly search: <TObject>(query: string, requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<SearchResponse<TObject>>>;
-    readonly searchForFacetValues: (facetName: string, facetQuery: string, requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<SearchForFacetValuesResponse>>;
-    readonly findAnswers: <TObject>(query: string, queryLanguages: readonly string[], requestOptions?: RequestOptions & FindAnswersOptions) => Readonly<Promise<FindAnswersResponse<TObject>>>;
-};
-
-export declare type WithoutCredentials<TClientOptions extends Credentials> = Omit<TClientOptions, keyof Credentials>;
-
-export { }