building

algolia-typescript-template/api-single.mustache

@@ -9,7 +9,7 @@ import { {{classname}} } from '{{filename}}';
 
 import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
 {{#hasAuthMethods}}
-import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
+import { HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
 {{/hasAuthMethods}}
 
 import { HttpError, RequestFile } from './apis';
@@ -131,7 +131,7 @@ export class {{classname}} {
         const path = '{{{path}}}'{{#pathParams}}
             .replace('{' + '{{baseName}}' + '}', encodeURIComponent(String({{paramName}}))){{/pathParams}};
         let headers: Headers = {};
-        let queryParams: Record<string, string> = {};
+        let queryParameters: Record<string, string> = {};
 {{#hasProduces}}
         const produces = [{{#produces}}'{{{mediaType}}}'{{^-last}}, {{/-last}}{{/produces}}];
         // give precedence to 'application/json'
@@ -154,7 +154,7 @@ export class {{classname}} {
 {{/allParams}}
 {{#queryParams}}
         if ({{paramName}} !== undefined) {
-            queryParams['{{baseName}}'] = ObjectSerializer.serialize({{paramName}}, "{{{dataType}}}");
+            queryParameters['{{baseName}}'] = ObjectSerializer.serialize({{paramName}}, "{{{dataType}}}");
         }
 
 {{/queryParams}}
@@ -165,14 +165,16 @@ export class {{classname}} {
 
         const request: Request = {
             method: '{{httpMethod}}',
-            url: path,
-            headers,
+            path,
 {{#bodyParam}}
             data: ObjectSerializer.serialize({{paramName}}, "{{{dataType}}}")
 {{/bodyParam}}
         };
 
-        const requestOptions: RequestOptions = {};
+        const requestOptions: RequestOptions = {
+          headers,
+          queryParameters
+        };
 
         let authenticationPromise = Promise.resolve();
 {{#authMethods}}
@@ -206,7 +208,7 @@ export class {{classname}} {
 
         await interceptorPromise;
 
-        return transporter.retryableRequest(request, requestOptions);
+        return this.transporter.retryableRequest(request, requestOptions);
     }
 {{/operation}}
 }

algolia-typescript-template/models.mustache

@@ -185,6 +185,7 @@ export interface Authentication {
     applyToRequest(requestOptions: RequestOptions): Promise<void> | void;
 }
 
+/*
 export class HttpBasicAuth implements Authentication {
     public username: string = '';
     public password: string = '';
@@ -194,7 +195,7 @@ export class HttpBasicAuth implements Authentication {
             username: this.username, password: this.password
         }
     }
-}
+}*/
 
 export class HttpBearerAuth implements Authentication {
     public accessToken: string | (() => string) = '';
@@ -217,7 +218,7 @@ export class ApiKeyAuth implements Authentication {
 
     applyToRequest(requestOptions: RequestOptions): void {
         if (this.location == "query") {
-            (<any>requestOptions.qs)[this.paramName] = this.apiKey;
+            requestOptions.queryParameters[this.paramName] = this.apiKey;
         } else if (this.location == "header" && requestOptions && requestOptions.headers) {
             requestOptions.headers[this.paramName] = this.apiKey;
         } else if (this.location == 'cookie' && requestOptions && requestOptions.headers) {

algolia-typescript-template/package.mustache

@@ -14,12 +14,8 @@
     "test": "yarn build && node dist/client.js"
   },
   "engines": {
-    "node": ">= 12.0.0",
-    "yarn": ">= 2.0.0"
-  },
-  "dependencies": {
-    "@types/request": "^2.48.7",
-    "request": "^2.81.0"
+    "node": ">= 16.0.0",
+    "yarn": ">= 3.0.0"
   },
   "devDependencies": {
     "@types/node": "^16.11.6",
@@ -29,4 +25,4 @@
   "publishConfig": {
     "registry": "{{npmRepository}}"
   }{{/npmRepository}}
-}
+}

algolia-typescript-template/tsconfig.mustache

@@ -14,7 +14,8 @@
     "declaration": true,
     "lib": ["dom", "es6", "es5", "dom.iterable", "scripthost"],
     "outDir": "dist",
-    "typeRoots": ["node_modules/@types"]
+    "typeRoots": ["node_modules/@types"],
+    "types": ["node"]
   },
   "include": ["client-search", "model", "api.ts"],
   "exclude": ["dist", "node_modules"]

complement/Requester.ts

@@ -10,6 +10,7 @@ export class Requester {
     this.httpAgent = new http.Agent({ keepAlive: true });
     this.httpsAgent = new https.Agent({ keepAlive: true });
   }
+
   async send(request: EndRequest): Promise<Response> {
     return new Promise((resolve) => {
       const url = new URL(request.url);

complement/Transporter.ts

@@ -6,6 +6,7 @@ import type {
   Timeouts,
   Response,
   Outcomes,
+  EndRequest,
 } from './types';
 import { MemoryCache } from './MemoryCache';
 import type { Cache } from './Cache';
@@ -137,7 +138,7 @@ export class Transporter {
         throw new RetryError(stackTrace);
       }
 
-      const payload = {
+      const payload: EndRequest = {
         data,
         headers,
         method,

complement/helpers.ts

@@ -78,9 +78,7 @@ export function deserializeSuccess<TObject>(response: Response): TObject {
   try {
     return JSON.parse(response.content);
   } catch (e) {
-    if (e instanceof Error) {
-      throw new DeserializationError(e.message, response);
-    }
+    throw new DeserializationError((e as Error).message, response);
   }
 }
 

complement/types.ts

@@ -24,7 +24,7 @@ export type RequestOptions = {
    * Custom query parameters for the request. This query parameters are
    * going to be merged the transporter query parameters.
    */
-  queryParameters?: Record<string, any>;
+  queryParameters: Record<string, any>;
   data?: Record<string, any>;
 };
 
@@ -34,7 +34,7 @@ export type EndRequest = {
   connectTimeout: number;
   responseTimeout: number;
   headers: Headers;
-  data: string;
+  data?: string;
 };
 
 export type Response = {

output/client-search/searchApi.ts

@@ -10,7 +10,7 @@ import { MultipleQueriesResponse } from '../model/multipleQueriesResponse';
 import { SaveObjectResponse } from '../model/saveObjectResponse';
 
 import { ObjectSerializer, Authentication, VoidAuth, Interceptor } from '../model/models';
-import { HttpBasicAuth, HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
+import { HttpBearerAuth, ApiKeyAuth, OAuth } from '../model/models';
 
 import { HttpError, RequestFile } from './apis';
 
@@ -86,7 +86,7 @@ export class SearchApi {
       encodeURIComponent(String(indexName))
     );
     let headers: Headers = {};
-    let queryParams: Record<string, string> = {};
+    let queryParameters: Record<string, string> = {};
     const produces = ['application/json'];
     // give precedence to 'application/json'
     if (produces.indexOf('application/json') >= 0) {
@@ -110,12 +110,14 @@ export class SearchApi {
 
     const request: Request = {
       method: 'POST',
-      url: path,
-      headers,
+      path,
       data: ObjectSerializer.serialize(batchObject, 'BatchObject'),
     };
 
-    const requestOptions: RequestOptions = {};
+    const requestOptions: RequestOptions = {
+      headers,
+      queryParameters,
+    };
 
     let authenticationPromise = Promise.resolve();
     if (this.authentications.apiKey.apiKey) {
@@ -139,7 +141,7 @@ export class SearchApi {
 
     await interceptorPromise;
 
-    return transporter.retryableRequest(request, requestOptions);
+    return this.transporter.retryableRequest(request, requestOptions);
   }
   /**
    *
@@ -152,7 +154,7 @@ export class SearchApi {
   ): Promise<{ response: http.IncomingMessage; body: MultipleQueriesResponse }> {
     const path = '/1/indexes/*/queries';
     let headers: Headers = {};
-    let queryParams: Record<string, string> = {};
+    let queryParameters: Record<string, string> = {};
     const produces = ['application/json'];
     // give precedence to 'application/json'
     if (produces.indexOf('application/json') >= 0) {
@@ -173,12 +175,14 @@ export class SearchApi {
 
     const request: Request = {
       method: 'POST',
-      url: path,
-      headers,
+      path,
       data: ObjectSerializer.serialize(multipleQueriesObject, 'MultipleQueriesObject'),
     };
 
-    const requestOptions: RequestOptions = {};
+    const requestOptions: RequestOptions = {
+      headers,
+      queryParameters,
+    };
 
     let authenticationPromise = Promise.resolve();
     if (this.authentications.apiKey.apiKey) {
@@ -202,7 +206,7 @@ export class SearchApi {
 
     await interceptorPromise;
 
-    return transporter.retryableRequest(request, requestOptions);
+    return this.transporter.retryableRequest(request, requestOptions);
   }
   /**
    * Add an object to the index, automatically assigning it an object ID
@@ -220,7 +224,7 @@ export class SearchApi {
       encodeURIComponent(String(indexName))
     );
     let headers: Headers = {};
-    let queryParams: Record<string, string> = {};
+    let queryParameters: Record<string, string> = {};
     const produces = ['application/json'];
     // give precedence to 'application/json'
     if (produces.indexOf('application/json') >= 0) {
@@ -248,12 +252,14 @@ export class SearchApi {
 
     const request: Request = {
       method: 'POST',
-      url: path,
-      headers,
+      path,
       data: ObjectSerializer.serialize(requestBody, '{ [key: string]: object; }'),
     };
 
-    const requestOptions: RequestOptions = {};
+    const requestOptions: RequestOptions = {
+      headers,
+      queryParameters,
+    };
 
     let authenticationPromise = Promise.resolve();
     if (this.authentications.apiKey.apiKey) {
@@ -277,6 +283,6 @@ export class SearchApi {
 
     await interceptorPromise;
 
-    return transporter.retryableRequest(request, requestOptions);
+    return this.transporter.retryableRequest(request, requestOptions);
   }
 }

output/complement

@@ -0,0 +1 @@
+/Users/pierre.millot/Documents/apiClients/api-client-automation-experiment/complement