feat(javascript): add addUserAgent method (#154)

algolia · Feb 22, 2022 · acdd483 · acdd483
1 parent 85f7e0b
commit acdd483
Show file tree

Hide file tree

Showing 30 changed files with 98 additions and 48 deletions.
diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/package.json b/clients/algoliasearch-client-javascript/packages/client-abtesting/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-abtesting",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-abtesting.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingApi.ts b/clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingApi.ts
@@ -28,9 +28,9 @@ function getDefaultHosts(region?: Region): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createAbtestingApi = (
+export function createAbtestingApi(
   options: CreateClientOptions & { region?: Region }
-) => {
+) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.region),
@@ -48,6 +48,10 @@ export const createAbtestingApi = (
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
    *
@@ -222,8 +226,15 @@ export const createAbtestingApi = (
     });
   }
 
-  return { addABTests, deleteABTest, getABTest, listABTests, stopABTest };
-};
+  return {
+    addUserAgent,
+    addABTests,
+    deleteABTest,
+    getABTest,
+    listABTests,
+    stopABTest,
+  };
+}
 
 export type AbtestingApi = ReturnType<typeof createAbtestingApi>;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/package.json b/clients/algoliasearch-client-javascript/packages/client-analytics/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-analytics",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-analytics.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsApi.ts b/clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsApi.ts
@@ -43,9 +43,9 @@ function getDefaultHosts(region?: Region): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createAnalyticsApi = (
+export function createAnalyticsApi(
   options: CreateClientOptions & { region?: Region }
-) => {
+) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.region),
@@ -63,6 +63,10 @@ export const createAnalyticsApi = (
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Returns the average click position. The endpoint returns a value for the complete given time range, as well as a value per day.
    *
@@ -1104,6 +1108,7 @@ export const createAnalyticsApi = (
   }
 
   return {
+    addUserAgent,
     getAverageClickPosition,
     getClickPositions,
     getClickThroughRate,
@@ -1122,7 +1127,7 @@ export const createAnalyticsApi = (
     getTopSearches,
     getUsersCount,
   };
-};
+}
 
 export type AnalyticsApi = ReturnType<typeof createAnalyticsApi>;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-common/package.json b/clients/algoliasearch-client-javascript/packages/client-common/package.json
@@ -4,7 +4,6 @@
   "description": "Common package for the Algolia JavaScript API client.",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "dist/client-common.cjs.node.js",
   "module": "dist/client-common.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/Transporter.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/Transporter.ts
@@ -33,7 +33,7 @@ export class Transporter {
   private baseHeaders: Headers;
   private baseQueryParameters: QueryParameters;
   private hostsCache: Cache;
-  private userAgent: UserAgent;
+  userAgent: UserAgent;
   private timeouts: Timeouts;
   private requester: Requester;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/package.json b/clients/algoliasearch-client-javascript/packages/client-insights/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-insights",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-insights.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsApi.ts b/clients/algoliasearch-client-javascript/packages/client-insights/src/insightsApi.ts
@@ -26,9 +26,9 @@ function getDefaultHosts(region?: Region): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createInsightsApi = (
+export function createInsightsApi(
   options: CreateClientOptions & { region?: Region }
-) => {
+) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.region),
@@ -46,6 +46,10 @@ export const createInsightsApi = (
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * This command pushes an array of events.
    *
@@ -83,7 +87,7 @@ export const createInsightsApi = (
     });
   }
 
-  return { pushEvents };
-};
+  return { addUserAgent, pushEvents };
+}
 
 export type InsightsApi = ReturnType<typeof createInsightsApi>;
diff --git a/clients/algoliasearch-client-javascript/packages/client-personalization/package.json b/clients/algoliasearch-client-javascript/packages/client-personalization/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-personalization",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-personalization.esm.node.js",

diff --git a/...algoliasearch-client-javascript/packages/client-personalization/src/personalizationApi.ts b/...algoliasearch-client-javascript/packages/client-personalization/src/personalizationApi.ts
@@ -26,9 +26,9 @@ function getDefaultHosts(region: Region): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createPersonalizationApi = (
+export function createPersonalizationApi(
   options: CreateClientOptions & { region: Region }
-) => {
+) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.region),
@@ -46,6 +46,10 @@ export const createPersonalizationApi = (
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means that if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours before for the deletion request to be fully processed.
    *
@@ -183,12 +187,13 @@ export const createPersonalizationApi = (
   }
 
   return {
+    addUserAgent,
     deleteUserProfile,
     getPersonalizationStrategy,
     getUserTokenProfile,
     setPersonalizationStrategy,
   };
-};
+}
 
 export type PersonalizationApi = ReturnType<typeof createPersonalizationApi>;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-predict/package.json b/clients/algoliasearch-client-javascript/packages/client-predict/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-predict",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-predict.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-predict/src/predictApi.ts b/clients/algoliasearch-client-javascript/packages/client-predict/src/predictApi.ts
@@ -22,7 +22,7 @@ function getDefaultHosts(): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createPredictApi = (options: CreateClientOptions) => {
+export function createPredictApi(options: CreateClientOptions) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(),
@@ -40,6 +40,10 @@ export const createPredictApi = (options: CreateClientOptions) => {
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Get predictions, properties (raw, computed or custom) and segments (computed or custom) for a user profile.
    *
@@ -83,8 +87,8 @@ export const createPredictApi = (options: CreateClientOptions) => {
     });
   }
 
-  return { fetchUserProfile };
-};
+  return { addUserAgent, fetchUserProfile };
+}
 
 export type PredictApi = ReturnType<typeof createPredictApi>;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json b/clients/algoliasearch-client-javascript/packages/client-query-suggestions/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-query-suggestions",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-query-suggestions.esm.node.js",

diff --git a/...oliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsApi.ts b/...oliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsApi.ts
@@ -28,9 +28,9 @@ function getDefaultHosts(region: Region): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createQuerySuggestionsApi = (
+export function createQuerySuggestionsApi(
   options: CreateClientOptions & { region: Region }
-) => {
+) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.region),
@@ -48,6 +48,10 @@ export const createQuerySuggestionsApi = (
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
    *
@@ -284,6 +288,7 @@ export const createQuerySuggestionsApi = (
   }
 
   return {
+    addUserAgent,
     createConfig,
     deleteConfig,
     getAllConfigs,
@@ -292,7 +297,7 @@ export const createQuerySuggestionsApi = (
     getLogFile,
     updateConfig,
   };
-};
+}
 
 export type QuerySuggestionsApi = ReturnType<typeof createQuerySuggestionsApi>;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-search/package.json b/clients/algoliasearch-client-javascript/packages/client-search/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-search",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-search.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-search/src/searchApi.ts b/clients/algoliasearch-client-javascript/packages/client-search/src/searchApi.ts
@@ -106,7 +106,7 @@ function getDefaultHosts(appId: string): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createSearchApi = (options: CreateClientOptions) => {
+export function createSearchApi(options: CreateClientOptions) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.appId),
@@ -124,6 +124,10 @@ export const createSearchApi = (options: CreateClientOptions) => {
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Add a new API Key with specific permissions/restrictions.
    *
@@ -2393,6 +2397,7 @@ export const createSearchApi = (options: CreateClientOptions) => {
   }
 
   return {
+    addUserAgent,
     addApiKey,
     addOrUpdateObject,
     appendSource,
@@ -2451,7 +2456,7 @@ export const createSearchApi = (options: CreateClientOptions) => {
     setSettings,
     updateApiKey,
   };
-};
+}
 
 export type SearchApi = ReturnType<typeof createSearchApi>;
 

diff --git a/clients/algoliasearch-client-javascript/packages/client-sources/package.json b/clients/algoliasearch-client-javascript/packages/client-sources/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/client-sources",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/client-sources.esm.node.js",

diff --git a/clients/algoliasearch-client-javascript/packages/client-sources/src/sourcesApi.ts b/clients/algoliasearch-client-javascript/packages/client-sources/src/sourcesApi.ts
@@ -24,9 +24,9 @@ function getDefaultHosts(region: Region): Host[] {
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export const createSourcesApi = (
+export function createSourcesApi(
   options: CreateClientOptions & { region: Region }
-) => {
+) {
   const auth = createAuth(options.appId, options.apiKey, options.authMode);
   const transporter = new Transporter({
     hosts: options?.hosts ?? getDefaultHosts(options.region),
@@ -44,6 +44,10 @@ export const createSourcesApi = (
     requester: options.requester,
   });
 
+  function addUserAgent(segment: string, version?: string): void {
+    transporter.userAgent.add({ segment, version });
+  }
+
   /**
    * Add an ingestion job that will fetch data from an URL.
    *
@@ -91,7 +95,7 @@ export const createSourcesApi = (
     });
   }
 
-  return { postIngestUrl };
-};
+  return { addUserAgent, postIngestUrl };
+}
 
 export type SourcesApi = ReturnType<typeof createSourcesApi>;
diff --git a/clients/algoliasearch-client-javascript/packages/recommend/package.json b/clients/algoliasearch-client-javascript/packages/recommend/package.json
@@ -4,7 +4,6 @@
   "description": "JavaScript client for @algolia/recommend",
   "repository": "algolia/algoliasearch-client-javascript",
   "author": "Algolia",
-  "private": true,
   "license": "MIT",
   "main": "index.js",
   "module": "dist/recommend.esm.node.js",