build: enforce strict checking in tsconfig.json

packages/authentication-adapters/src/compositeAuthenticationAdapter.ts

@@ -131,6 +131,10 @@ function findMatchingAuth<T extends string>(
   return securityRequirements.find(
     (andRequirements) =>
       Object.keys(andRequirements).every(
+        // @ts-ignore TODO: REMOVE THIS COMMENT. DO NOT COPY.
+        // THIS WAS ONLY FOR MIGRATING UNCHECKED CODE TO STRICT TYPE CHECKING.
+        // As for the actual compiler error, TS does not support generic keys with the `in` operator.
+        // https://github.com/microsoft/TypeScript/issues/21732#issuecomment-1423655000
         (key) => key in providerConfig && providerConfig[key]
       ) && Object.values(andRequirements).every((value) => value)
   );
@@ -145,7 +149,11 @@ function getHttpInterceptorsForAuths<T extends string>(
 ): Array<HttpInterceptorInterface<RequestOptions | undefined>> {
   return Object.entries(matchingRequirements).map(
     ([authProvider, authParam]) => {
+      // @ts-ignore TODO: REMOVE THIS COMMENT. DO NOT COPY.
+      // THIS WAS ONLY FOR MIGRATING UNCHECKED CODE TO STRICT TYPE CHECKING.
       if (providerConfig[authProvider] !== undefined) {
+        // @ts-ignore TODO: REMOVE THIS COMMENT. DO NOT COPY.
+        // THIS WAS ONLY FOR MIGRATING UNCHECKED CODE TO STRICT TYPE CHECKING.
         return providerConfig[authProvider](authParam);
       } else {
         return passThroughInterceptor;

packages/authentication-adapters/test/accessTokenAdapter.test.ts

@@ -26,7 +26,7 @@ describe('test access token authentication scheme', () => {
     const authenticationProvider = accessTokenAuthenticationProvider(config);
     const handler = authenticationProvider(true);
     const interceptor = [handler];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -51,7 +51,7 @@ describe('test access token authentication scheme', () => {
     const authenticationProvider = accessTokenAuthenticationProvider(config);
     const handler = authenticationProvider(false);
     const interceptor = [handler];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);

packages/authentication-adapters/test/basicAuthenticationAdapter.test.ts

@@ -59,7 +59,7 @@ describe('test basic authentication scheme', () => {
       );
       const handler = authenticationProvider(enableAuthentication);
       const interceptor = [handler];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);

packages/authentication-adapters/test/compositeAuthenticationAdapter.test.ts

@@ -74,7 +74,7 @@ describe('test composite authentication adapter with false or empty security req
     const securityRequirements = false;
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -91,10 +91,10 @@ describe('test composite authentication adapter with false or empty security req
         method: 'GET',
         url: 'http://apimatic.hopto.org:3000/test/requestBuilder',
       };
-      const securityRequirements = [];
+      const securityRequirements: any[] = [];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -143,7 +143,7 @@ describe('test composite authentication adapter with missing credentials object
     const securityRequirements = [{ apiKey: true }, { apiHeader: true }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -181,7 +181,7 @@ describe('test composite authentication adapter with missing credentials object
     const securityRequirements = [{ apiKey: true }, { apiHeader: true }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -220,7 +220,7 @@ describe('test composite authentication adapter with missing credentials object
       const securityRequirements = [{ apiKey: false }, { apiHeader: true }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -263,7 +263,7 @@ describe('test composite authentication adapter with missing credentials object
     const securityRequirements = [{ apiKey: true }, { apiHeader: false }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -299,7 +299,7 @@ describe('test composite authentication adapter with missing credentials object
       const securityRequirements = [{ apiKey: false }, { apiHeader: false }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -342,7 +342,7 @@ describe('test composite authentication adapter with missing credentials object
       const securityRequirements = [{ apiKey: true, apiHeader: true }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -387,7 +387,7 @@ describe('test composite authentication adapter with missing credentials object
       const securityRequirements = [{ apiKey: true, apiHeader: false }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -432,7 +432,7 @@ describe('test composite authentication adapter with missing credentials object
       const securityRequirements = [{ apiKey: false, apiHeader: true }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -473,7 +473,7 @@ describe('test composite authentication adapter with missing credentials object
       const securityRequirements = [{ apiKey: false, apiHeader: false }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -563,7 +563,7 @@ describe('test composite authentication adapter with security requirements combi
     const securityRequirements = [{ accessToken: true }, { basicAuth: true }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -582,7 +582,7 @@ describe('test composite authentication adapter with security requirements combi
     const securityRequirements = [{ accessToken: true }, { basicAuth: false }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -601,7 +601,7 @@ describe('test composite authentication adapter with security requirements combi
     const securityRequirements = [{ accessToken: false }, { basicAuth: true }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -625,7 +625,7 @@ describe('test composite authentication adapter with security requirements combi
       ];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -648,7 +648,7 @@ describe('test composite authentication adapter with security requirements combi
       const securityRequirements = [{ accessToken: false, basicAuth: true }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -672,7 +672,7 @@ describe('test composite authentication adapter with security requirements combi
     const securityRequirements = [{ accessToken: true, basicAuth: true }];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -695,7 +695,7 @@ describe('test composite authentication adapter with security requirements combi
       const securityRequirements = [{ accessToken: true, basicAuth: false }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -721,7 +721,7 @@ describe('test composite authentication adapter with security requirements combi
     ];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -750,7 +750,7 @@ describe('test composite authentication adapter with security requirements combi
     ];
     const provider = compositeAuthenticationProvider(authConfig);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);
@@ -769,7 +769,7 @@ describe('test composite authentication adapter with security requirements combi
       const securityRequirements = [{ oAuthACG: true, oAuthCCG: true }];
       const provider = compositeAuthenticationProvider(authConfig);
       const interceptor = [provider(securityRequirements)];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);
@@ -811,7 +811,7 @@ describe('test composite authentication adapter with security requirements combi
     const securityRequirements = [{ oAuthACG: true }, { oAuthCCG: true }];
     const provider = compositeAuthenticationProvider(auth1Config);
     const interceptor = [provider(securityRequirements)];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);

packages/authentication-adapters/test/customHeaderAuthenticationAdapter.test.ts

@@ -63,7 +63,7 @@ describe('test custom header authentication scheme', () => {
       );
       const handler = authenticationProvider(enableAuthentication);
       const interceptor = [handler];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);

packages/authentication-adapters/test/customQueryAuthenticationAdapter.test.ts

@@ -62,7 +62,7 @@ describe('test custom query authentication scheme', () => {
       );
       const handler = authenticationProvider(enableAuthentication);
       const interceptor = [handler];
-      const client = async (req) => {
+      const client = async (req: HttpRequest) => {
         return { request: req, response };
       };
       const executor = callHttpInterceptors(interceptor, client);

packages/authentication-adapters/test/noAuthenticationAdapter.test.ts

@@ -18,7 +18,7 @@ describe('test access token authentication scheme', () => {
   it('should test access token auth with enabled authentication', async () => {
     const handler = noneAuthenticationProvider();
     const interceptor = [handler];
-    const client = async (req) => {
+    const client = async (req: HttpRequest) => {
       return { request: req, response };
     };
     const executor = callHttpInterceptors(interceptor, client);

packages/core/src/http/httpInterceptor.ts

@@ -14,5 +14,7 @@ export function callHttpInterceptors<T>(
   client: HttpCallExecutor<T>
 ): HttpCallExecutor<T> {
   return (request, options) =>
+    // @ts-ignore TODO: REMOVE THIS COMMENT. DO NOT COPY.
+    // THIS WAS ONLY FOR MIGRATING UNCHECKED CODE TO STRICT TYPE CHECKING.
     combineHttpInterceptors(interceptors)(request, options, client);
 }

packages/core/src/http/requestBuilder.ts

@@ -175,10 +175,13 @@ export interface RequestBuilder<BaseUrlParamType, AuthParams> {
   ): RequestBuilder<BaseUrlParamType, AuthParams>;
   paginate<TItem, TPagedResponse>(
     createPagedIterable: (
-      req: this,
+      req: RequestBuilder<BaseUrlParamType, AuthParams>,
       updater: (
-        req: this
-      ) => (pointer: string | null, setter: (value: any) => any) => this
+        req: RequestBuilder<BaseUrlParamType, AuthParams>
+      ) => (
+        pointer: string | null,
+        setter: (value: any) => any
+      ) => RequestBuilder<BaseUrlParamType, AuthParams>
     ) => PagedAsyncIterable<TItem, TPagedResponse>
   ): PagedAsyncIterable<TItem, TPagedResponse>;
   call(requestOptions?: RequestOptions): Promise<ApiResponse<void>>;
@@ -555,10 +558,13 @@ export class DefaultRequestBuilder<BaseUrlParamType, AuthParams>
   }
   public paginate<TItem, TPagedResponse>(
     createPagedIterable: (
-      req: this,
+      req: RequestBuilder<BaseUrlParamType, AuthParams>,
       updater: (
-        req: this
-      ) => (pointer: string | null, setter: (value: any) => any) => this
+        req: RequestBuilder<BaseUrlParamType, AuthParams>
+      ) => (
+        pointer: string | null,
+        setter: (value: any) => any
+      ) => RequestBuilder<BaseUrlParamType, AuthParams>
     ) => PagedAsyncIterable<TItem, TPagedResponse>
   ): PagedAsyncIterable<TItem, TPagedResponse> {
     return createPagedIterable(this, (req) =>

packages/core/test/http/apiLogger.test.ts

@@ -9,7 +9,10 @@ import { callHttpInterceptors } from '../../src/http/httpInterceptor';
 import { NullLogger } from '../../src/logger/nullLogger';
 import { mergeLoggingOptions } from '../../src/logger/defaultLoggingConfiguration';
 
-let loggerSpy;
+let loggerSpy: jest.SpyInstance<
+  void,
+  [message?: any, ...optionalParams: any[]]
+>;
 beforeEach(() => {
   // Reset the spy on console.log() before each test
   loggerSpy = jest.spyOn(console, 'log').mockImplementation();
@@ -304,7 +307,11 @@ describe('APILogger with NullLogging', () => {
 
 function mockInterceptor(loggingOpt: LoggingOptions) {
   const apiLogger = new ApiLogger(loggingOpt);
-  return async (req, options, next) => {
+  return async (
+    req: HttpRequest,
+    options: any,
+    next: (arg0: any, arg1: any) => any
+  ) => {
     apiLogger.logRequest(req);
     const context = await next(req, options);
     apiLogger.logResponse(context.response);
@@ -344,14 +351,18 @@ function mockResponse(): HttpResponse {
 }
 
 async function mockClient(loggingOpts: LoggingOptions) {
-  const client = async (req) => {
+  const client = async (req: HttpRequest) => {
     return { request: req, response: mockResponse() };
   };
   const executor = callHttpInterceptors([mockInterceptor(loggingOpts)], client);
   return await executor(mockRequest(), undefined);
 }
 
-function expectLogsToBeLogged(logSpy, expectedConsoleLogs, index = 0) {
+function expectLogsToBeLogged(
+  logSpy: jest.SpyInstance<void, [message?: any, ...optionalParams: any[]]>,
+  expectedConsoleLogs: string | any[],
+  index = 0
+) {
   for (let i = index; i < expectedConsoleLogs.length; i++) {
     expect(logSpy.mock.calls[i][0]).toEqual(expectedConsoleLogs[i]);
   }