fix(js): add version to user agent (#105)

* fix: add version to user agent

* fix: user agent format

Author: Eunjae Lee

clients/algoliasearch-client-javascript/client-abtesting/src/abtestingApi.ts

@@ -12,6 +12,8 @@ import type { ABTestResponse } from '../model/aBTestResponse';
 import type { AddABTestsRequest } from '../model/addABTestsRequest';
 import type { ListABTestsResponse } from '../model/listABTestsResponse';
 
+export const version = '5.0.0';
+
 export class AbtestingApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -60,7 +62,7 @@ export class AbtestingApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/client-analytics/src/analyticsApi.ts

@@ -27,6 +27,8 @@ import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
 import type { GetTopSearchesResponseWithAnalytics } from '../model/getTopSearchesResponseWithAnalytics';
 import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
 
+export const version = '5.0.0';
+
 export class AnalyticsApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -75,7 +77,7 @@ export class AnalyticsApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/client-insights/src/insightsApi.ts

@@ -10,6 +10,8 @@ import type {
 import type { InsightEvents } from '../model/insightEvents';
 import type { PushEventsResponse } from '../model/pushEventsResponse';
 
+export const version = '5.0.0';
+
 export class InsightsApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -57,7 +59,7 @@ export class InsightsApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/client-personalization/src/personalizationApi.ts

@@ -12,6 +12,8 @@ import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
 import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
 import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
 
+export const version = '5.0.0';
+
 export class PersonalizationApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -60,7 +62,7 @@ export class PersonalizationApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/client-query-suggestions/src/querySuggestionsApi.ts

@@ -14,6 +14,8 @@ import type { QuerySuggestionsIndexWithIndexParam } from '../model/querySuggesti
 import type { Status } from '../model/status';
 import type { SucessResponse } from '../model/sucessResponse';
 
+export const version = '5.0.0';
+
 export class QuerySuggestionsApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -62,7 +64,7 @@ export class QuerySuggestionsApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/client-search/src/searchApi.ts

@@ -64,6 +64,8 @@ import type { UpdatedAtWithObjectIdResponse } from '../model/updatedAtWithObject
 import type { UpdatedRuleResponse } from '../model/updatedRuleResponse';
 import type { UserId } from '../model/userId';
 
+export const version = '5.0.0';
+
 export class SearchApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -111,7 +113,7 @@ export class SearchApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/client-sources/src/sourcesApi.ts

@@ -10,6 +10,8 @@ import type {
 import type { PostIngestUrlResponse } from '../model/postIngestUrlResponse';
 import type { PostURLJob } from '../model/postURLJob';
 
+export const version = '0.0.1';
+
 export class SourcesApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -58,7 +60,7 @@ export class SourcesApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (0.0.1)',
       timeouts: {
         connect: 2,
         read: 5,

clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts

@@ -10,6 +10,8 @@ import type {
 import type { GetRecommendations } from '../model/getRecommendations';
 import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
 
+export const version = '5.0.0';
+
 export class RecommendApi {
   protected authentications = {
     apiKey: 'Algolia-API-Key',
@@ -57,7 +59,7 @@ export class RecommendApi {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded',
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript (5.0.0)',
       timeouts: {
         connect: 2,
         read: 5,

openapitools.json

@@ -18,7 +18,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-search",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/client-search",
           "isSearchHost": true
@@ -39,7 +39,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/recommend",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/recommend",
           "isSearchHost": true
@@ -59,7 +59,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-personalization",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/client-personalization",
           "hasRegionalHost": true,
@@ -81,7 +81,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-analytics",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/client-analytics",
           "hasRegionalHost": true,
@@ -103,7 +103,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-insights",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/client-insights",
           "host": "insights"
@@ -123,7 +123,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-abtesting",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/client-abtesting",
           "hasRegionalHost": true,
@@ -145,7 +145,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-query-suggestions",
-          "npmVersion": "5.0.0",
+          "packageVersion": "5.0.0",
 
           "packageName": "@algolia/client-query-suggestions",
           "hasRegionalHost": true,
@@ -167,7 +167,7 @@
           "modelPropertyNaming": "original",
           "supportsES6": true,
           "npmName": "@algolia/client-sources",
-          "npmVersion": "0.0.1",
+          "packageVersion": "0.0.1",
 
           "packageName": "@algolia/client-sources",
           "hasRegionalHost": true,

templates/javascript/api-single.mustache

@@ -5,6 +5,8 @@ import type { Headers, Requester, Host, Request, RequestOptions } from '@algolia
 import { {{classname}} } from '{{filename}}';
 {{/imports}}
 
+export const version = '{{packageVersion}}';
+
 {{#operations}}
 {{#description}}
 /**
@@ -65,7 +67,7 @@ export class {{classname}} {
       baseHeaders: {
         'content-type': 'application/x-www-form-urlencoded'
       },
-      userAgent: 'Algolia for Javascript',
+      userAgent: 'Algolia for Javascript ({{packageVersion}})',
       timeouts: {
         connect: 2,
         read: 5,

templates/javascript/package.mustache

@@ -1,6 +1,6 @@
 {
   "name": "{{packageName}}",
-  "version": "{{npmVersion}}",
+  "version": "{{packageVersion}}",
   "description": "JavaScript client for {{packageName}}",
   "repository": "{{gitUserId}}/{{gitRepoId}}",
   "author": "Algolia",