feat(javascript): provide algoliasearch package (#158)

algolia · Feb 23, 2022 · c06f890 · c06f890
1 parent d5c6bf8
commit c06f890
Show file tree

Hide file tree

Showing 14 changed files with 357 additions and 10 deletions.
diff --git a/.github/actions/cache/action.yml b/.github/actions/cache/action.yml
@@ -36,6 +36,13 @@ runs:
         path: /home/runner/work/api-clients-automation/api-clients-automation/clients/algoliasearch-client-javascript/packages/requester-browser-xhr/dist
         key: ${{ runner.os }}-${{ env.CACHE_VERSION }}-js-requester-browser-xhr-${{ hashFiles('clients/algoliasearch-client-javascript/packages/requester-browser-xhr/**') }}
 
+    - name: Restore built JavaScript algoliasearch client
+      if: ${{ inputs.job == 'cts' }}
+      uses: actions/cache@v2
+      with:
+        path: /home/runner/work/api-clients-automation/api-clients-automation/clients/algoliasearch-client-javascript/packages/algoliasearch/dist
+        key: ${{ runner.os }}-${{ env.CACHE_VERSION }}-js-algoliasearch-${{ hashFiles('clients/algoliasearch-client-javascript/packages/algoliasearch/**') }}
+
     - name: Restore built JavaScript search client
       if: ${{ inputs.job == 'cts' }}
       uses: actions/cache@v2

diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -76,6 +76,7 @@ jobs:
           - client-common
           - requester-browser-xhr
           - requester-node-http
+          - algoliasearch
     steps:
       - uses: actions/checkout@v2
 

diff --git a/clients/algoliasearch-client-javascript/bundlesize.config.json b/clients/algoliasearch-client-javascript/bundlesize.config.json
@@ -1,5 +1,9 @@
 {
   "files": [
+    {
+      "path": "packages/algoliasearch/dist/algoliasearch.umd.browser.js",
+      "maxSize": "6.25KB"
+    },
     {
       "path": "packages/client-abtesting/dist/client-abtesting.umd.browser.js",
       "maxSize": "3.25KB"
@@ -14,7 +18,7 @@
     },
     {
       "path": "packages/client-personalization/dist/client-personalization.umd.browser.js",
-      "maxSize": "3.00KB"
+      "maxSize": "3.25KB"
     },
     {
       "path": "packages/client-query-suggestions/dist/client-query-suggestions.umd.browser.js",

diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/browser.ts
@@ -0,0 +1,84 @@
+import type {
+  AnalyticsApi,
+  Region as AnalyticsRegion,
+} from '@algolia/client-analytics/src/analyticsApi';
+import { createAnalyticsApi } from '@algolia/client-analytics/src/analyticsApi';
+import type {
+  CreateClientOptions,
+  Host,
+  Requester,
+} from '@algolia/client-common';
+import type {
+  PersonalizationApi,
+  Region as PersonalizationRegion,
+} from '@algolia/client-personalization/src/personalizationApi';
+import { createPersonalizationApi } from '@algolia/client-personalization/src/personalizationApi';
+import { createSearchApi } from '@algolia/client-search/src/searchApi';
+import { createXhrRequester } from '@algolia/requester-browser-xhr';
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export function algoliasearch(
+  appId: string,
+  apiKey: string,
+  options?: { requester?: Requester; hosts?: Host[] }
+) {
+  if (!appId) {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey) {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  const commonOptions: Omit<CreateClientOptions, 'apiKey' | 'appId'> = {
+    timeouts: {
+      connect: 1,
+      read: 2,
+      write: 30,
+    },
+    requester: options?.requester ?? createXhrRequester(),
+    userAgents: [{ segment: 'Browser' }],
+    authMode: 'WithinQueryParameters',
+    ...options,
+  };
+
+  function initAnalytics(
+    analyticsAppId: string,
+    analyticsApiKey: string,
+    region?: AnalyticsRegion,
+    analyticsOptions?: { requester?: Requester; hosts?: Host[] }
+  ): AnalyticsApi {
+    return createAnalyticsApi({
+      appId: analyticsAppId,
+      apiKey: analyticsApiKey,
+      region,
+      ...analyticsOptions,
+      ...commonOptions,
+    });
+  }
+
+  function initPersonalization(
+    personalizationAppId: string,
+    personalizationApiKey: string,
+    region: PersonalizationRegion,
+    personalizationOptions?: { requester?: Requester; hosts?: Host[] }
+  ): PersonalizationApi {
+    if (!region) {
+      throw new Error('`region` is missing.');
+    }
+
+    return createPersonalizationApi({
+      appId: personalizationAppId,
+      apiKey: personalizationApiKey,
+      region,
+      ...personalizationOptions,
+      ...commonOptions,
+    });
+  }
+
+  return {
+    ...createSearchApi({ appId, apiKey, ...commonOptions }),
+    initAnalytics,
+    initPersonalization,
+  };
+}
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/builds/node.ts
@@ -0,0 +1,83 @@
+import type {
+  AnalyticsApi,
+  Region as AnalyticsRegion,
+} from '@algolia/client-analytics/src/analyticsApi';
+import { createAnalyticsApi } from '@algolia/client-analytics/src/analyticsApi';
+import type {
+  CreateClientOptions,
+  Host,
+  Requester,
+} from '@algolia/client-common';
+import type {
+  PersonalizationApi,
+  Region as PersonalizationRegion,
+} from '@algolia/client-personalization/src/personalizationApi';
+import { createPersonalizationApi } from '@algolia/client-personalization/src/personalizationApi';
+import { createSearchApi } from '@algolia/client-search/src/searchApi';
+import { createHttpRequester } from '@algolia/requester-node-http';
+
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+export function algoliasearch(
+  appId: string,
+  apiKey: string,
+  options?: { requester?: Requester; hosts?: Host[] }
+) {
+  if (!appId) {
+    throw new Error('`appId` is missing.');
+  }
+
+  if (!apiKey) {
+    throw new Error('`apiKey` is missing.');
+  }
+
+  const commonOptions: Omit<CreateClientOptions, 'apiKey' | 'appId'> = {
+    timeouts: {
+      connect: 2,
+      read: 5,
+      write: 30,
+    },
+    requester: options?.requester ?? createHttpRequester(),
+    userAgents: [{ segment: 'Node.js', version: process.versions.node }],
+    ...options,
+  };
+
+  function initAnalytics(
+    analyticsAppId: string,
+    analyticsApiKey: string,
+    region?: AnalyticsRegion,
+    analyticsOptions?: { requester?: Requester; hosts?: Host[] }
+  ): AnalyticsApi {
+    return createAnalyticsApi({
+      appId: analyticsAppId,
+      apiKey: analyticsApiKey,
+      region,
+      ...analyticsOptions,
+      ...commonOptions,
+    });
+  }
+
+  function initPersonalization(
+    personalizationAppId: string,
+    personalizationApiKey: string,
+    region: PersonalizationRegion,
+    personalizationOptions?: { requester?: Requester; hosts?: Host[] }
+  ): PersonalizationApi {
+    if (!region) {
+      throw new Error('`region` is missing.');
+    }
+
+    return createPersonalizationApi({
+      appId: personalizationAppId,
+      apiKey: personalizationApiKey,
+      region,
+      ...personalizationOptions,
+      ...commonOptions,
+    });
+  }
+
+  return {
+    ...createSearchApi({ appId, apiKey, ...commonOptions }),
+    initAnalytics,
+    initPersonalization,
+  };
+}
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/index.d.ts b/clients/algoliasearch-client-javascript/packages/algoliasearch/index.d.ts
@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-unresolved
+export * from './dist/algoliasearch/builds/node';
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/index.js b/clients/algoliasearch-client-javascript/packages/algoliasearch/index.js
@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-commonjs,import/extensions
+module.exports = require('./dist/algoliasearch.cjs.node.js');
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/package.json b/clients/algoliasearch-client-javascript/packages/algoliasearch/package.json
@@ -0,0 +1,35 @@
+{
+  "name": "algoliasearch",
+  "version": "5.0.0",
+  "description": "A fully-featured and blazing-fast JavaScript API client to interact with Algolia API.",
+  "repository": "algolia/algoliasearch-client-javascript",
+  "author": "Algolia",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "dist/algoliasearch.esm.node.js",
+  "types": "index.d.ts",
+  "jsdelivr": "dist/algoliasearch.umd.browser.js",
+  "unpkg": "dist/algoliasearch.umd.browser.js",
+  "browser": {
+    "./index.js": "./dist/algoliasearch.cjs.browser.js",
+    "./lite.js": "./dist/algoliasearch-lite.cjs.browser.js"
+  },
+  "scripts": {
+    "clean": "rm -rf ./dist"
+  },
+  "engines": {
+    "node": "^14.0.0"
+  },
+  "dependencies": {
+    "@algolia/client-analytics": "5.0.0",
+    "@algolia/client-common": "5.0.0",
+    "@algolia/client-personalization": "5.0.0",
+    "@algolia/client-search": "5.0.0",
+    "@algolia/requester-browser-xhr": "5.0.0",
+    "@algolia/requester-node-http": "5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.11",
+    "typescript": "4.5.4"
+  }
+}
diff --git a/clients/algoliasearch-client-javascript/packages/algoliasearch/tsconfig.json b/clients/algoliasearch-client-javascript/packages/algoliasearch/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "include": ["builds/node.ts", "builds/browser.ts"],
+  "exclude": ["dist", "node_modules"]
+}
diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/types/CreateClient.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/types/CreateClient.ts
@@ -1,12 +1,13 @@
 import type { Host } from './Host';
+import type { Requester } from './Requester';
 import type { Timeouts, UserAgentOptions } from './Transporter';
 
 export type AuthMode = 'WithinHeaders' | 'WithinQueryParameters';
 
 export type CreateClientOptions = {
   appId: string;
   apiKey: string;
-  requester: any;
+  requester: Requester;
   timeouts: Timeouts;
   userAgents: UserAgentOptions[];
   hosts?: Host[];

diff --git a/clients/algoliasearch-client-javascript/rollup.config.js b/clients/algoliasearch-client-javascript/rollup.config.js
@@ -45,7 +45,9 @@ function createBundlers({ output, clientPath }) {
 }
 
 function getAvailableClients() {
-  const availableClients = [];
+  // We default `algoliasearch` as it's not a generated client, but an aggregation of
+  // multiple clients.
+  const availableClients = ['algoliasearch'];
   const generators = Object.entries(
     generatorConfig['generator-cli'].generators
   );
@@ -112,15 +114,19 @@ function initPackagesConfig() {
   }
 
   return availableClients.flatMap((packageName) => {
+    const isAlgoliasearchClient = packageName.startsWith('algoliasearch');
     const commonConfig = {
       package: packageName,
-      name: `@algolia/${packageName}`,
+      name: isAlgoliasearchClient ? packageName : `@algolia/${packageName}`,
       output: packageName,
-      dependencies: [
-        '@algolia/client-common',
-        '@algolia/requester-browser-xhr',
-        '@algolia/requester-node-http',
-      ],
+      dependencies: isAlgoliasearchClient
+        ? [
+            '@algolia/client-analytics',
+            '@algolia/client-common',
+            '@algolia/client-personalization',
+            '@algolia/client-search',
+          ]
+        : ['@algolia/client-common'],
       external: [],
     };
     const browserFormats = ['umd-browser', 'esm-browser', 'cjs-browser'];
@@ -132,13 +138,21 @@ function initPackagesConfig() {
         input: 'builds/browser.ts',
         formats: browserFormats,
         external: ['dom'],
+        dependencies: [
+          ...commonConfig.dependencies,
+          '@algolia/requester-browser-xhr',
+        ],
         globals: {
           [packageName]: packageName,
         },
       },
       {
         ...commonConfig,
         input: 'builds/node.ts',
+        dependencies: [
+          ...commonConfig.dependencies,
+          '@algolia/requester-node-http',
+        ],
         formats: nodeFormats,
       },
     ];