chore(TypeScript): avoid ts-ignore (#1190)

* chore(TypeScript): avoid ts-ignore

- addMethods with `as`
- updateApiKey with type guard
- browseRules & browseSynonyms with `as any` (the key exists, but isn't supposed to be shown to the user, thus isn't in the type

* any & use returned type directly

for some reason if you do let x = something, you can't change the type anymore in a reassignment, except if you return directly, since that makes a new type

* fix typo

Author: Haroenv

packages/client-common/src/__tests__/TestSuite.ts

@@ -41,7 +41,7 @@ export class TestSuite {
     appIdEnv: string = 'ALGOLIA_APPLICATION_ID_1',
     apiKeyEnv: string = 'ALGOLIA_ADMIN_KEY_1'
   ) {
-    let client = this.algoliasearch(`${process.env[appIdEnv]}`, `${process.env[apiKeyEnv]}`);
+    const client = this.algoliasearch(`${process.env[appIdEnv]}`, `${process.env[apiKeyEnv]}`);
 
     // To ensure `Consistency` during the Common Test Suite, we
     // force the transporter to work with a single host in the
@@ -59,8 +59,7 @@ export class TestSuite {
     };
 
     if (testing.isBrowserLite()) {
-      // @ts-ignore
-      client = addMethods(client, {
+      return addMethods(client, {
         multipleBatch,
         multipleGetObjects,
       });
@@ -77,11 +76,10 @@ export class TestSuite {
   }
 
   public makeIndex(indexName?: string) {
-    let index = this.makeSearchClient().initIndex(indexName || this.makeIndexName());
+    const index = this.makeSearchClient().initIndex(indexName || this.makeIndexName());
 
     if (testing.isBrowserLite()) {
-      // @ts-ignore
-      index = addMethods(index, {
+      return addMethods(index, {
         saveObjects,
         setSettings,
         delete: deleteIndex,

packages/client-common/src/helpers.ts

@@ -13,27 +13,30 @@ export function shuffle<TData>(array: TData[]): TData[] {
   return array;
 }
 
-export function addMethods<
-  TBase,
-  TMethods extends {
-    readonly [key: string]: (base: TBase) => (...args: any) => any;
-  }
->(
+type Methods<TBase> = {
+  // eslint-disable-next-line functional/prefer-readonly-type
+  readonly [key: string]: (base: TBase) => (...args: any[]) => any;
+};
+
+type AddedMethods<TBase, TMethods extends Methods<TBase>> = TBase &
+  {
+    [TKey in keyof TMethods extends string ? keyof TMethods : never]: ReturnType<TMethods[TKey]>;
+  };
+
+export function addMethods<TBase extends {}, TMethods extends Methods<TBase>>(
   base: TBase,
   methods?: TMethods
-): TBase &
-  {
-    // eslint-disable-next-line @typescript-eslint/generic-type-naming
-    [key in keyof TMethods extends string ? keyof TMethods : never]: ReturnType<TMethods[key]>;
-  } {
-  Object.keys(methods !== undefined ? methods : {}).forEach(key => {
-    // @ts-ignore
+): AddedMethods<TBase, TMethods> {
+  if (!methods) {
+    return base as AddedMethods<TBase, TMethods>;
+  }
+
+  Object.keys(methods).forEach(key => {
     // eslint-disable-next-line functional/immutable-data, no-param-reassign
-    base[key] = methods[key](base);
+    (base as any)[key] = methods[key](base);
   });
 
-  // @ts-ignore
-  return base;
+  return base as AddedMethods<TBase, TMethods>;
 }
 
 export function encode(format: string, ...args: readonly any[]): string {

packages/client-search/src/methods/client/updateApiKey.ts

@@ -35,17 +35,16 @@ export const updateApiKey = (base: SearchClient) => {
       'description',
       'maxQueriesPerIPPerHour',
       'maxHitsPerQuery',
-    ];
+    ] as const;
 
     const hasChanged = (getApiKeyResponse: GetApiKeyResponse): boolean => {
       return Object.keys(updatedFields)
-        .filter(updatedField => apiKeyFields.indexOf(updatedField) !== -1)
+        .filter(
+          (updatedField: any): updatedField is typeof apiKeyFields[number] =>
+            apiKeyFields.indexOf(updatedField) !== -1
+        )
         .every(updatedField => {
-          return (
-            // @ts-ignore
-
-            getApiKeyResponse[updatedField] === updatedFields[updatedField]
-          );
+          return getApiKeyResponse[updatedField] === updatedFields[updatedField];
         });
     };
 

packages/client-search/src/methods/index/browseRules.ts

@@ -28,9 +28,8 @@ export const browseRules = (base: SearchIndex) => {
             return {
               ...response,
               hits: response.hits.map(rule => {
-                // @ts-ignore
                 // eslint-disable-next-line functional/immutable-data,no-param-reassign
-                delete rule._highlightResult;
+                delete (rule as any)._highlightResult;
 
                 return rule;
               }),

packages/client-search/src/methods/index/browseSynonyms.ts

@@ -28,9 +28,8 @@ export const browseSynonyms = (base: SearchIndex) => {
             return {
               ...response,
               hits: response.hits.map(synonym => {
-                // @ts-ignore
                 // eslint-disable-next-line functional/immutable-data,no-param-reassign
-                delete synonym._highlightResult;
+                delete (synonym as any)._highlightResult;
 
                 return synonym;
               }),

packages/client-search/src/types/GetApiKeyResponse.ts

@@ -42,6 +42,13 @@ export type GetApiKeyResponse = {
    */
   referers?: string[];
 
+  /**
+   * IPv4 network allowed to use the generated key.
+   * This is used for more protection against API key leaking and reuse.
+   * Note that you can only provide a single source, but you can specify a range of IPs (e.g., 192.168.1.0/24).
+   */
+  restrictSources?: string;
+
   /**
    * Specify the list of query parameters. You can force the query parameters for a query using the url string format.
    */