fix(typescript): fixes and improvements to typings for better stability

Author: dalisoft

src/extractors/scopes.ts

@@ -1,4 +1,6 @@
-export default (line: string): string[] => {
+import { BlockMode } from '../../types/interfaces';
+
+export default (line: string): ['request' | 'req', BlockMode, string?] => {
   const matches = [];
   const cases = {
     SCOPE: 0,
@@ -105,5 +107,5 @@ export default (line: string): string[] => {
     matches.push(rebuild);
   }
 
-  return matches;
+  return matches as ['request' | 'req', BlockMode, string?];
 };

src/finders/request/body.ts

@@ -23,7 +23,8 @@ export default function requestModeBodyFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'body'
       };
     }
     if (_key.includes('getBodyField(')) {
@@ -34,7 +35,8 @@ export default function requestModeBodyFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'body'
       };
     }
     if (_key === 'body' && extracted[1].charAt(0) === '{') {
@@ -50,15 +52,17 @@ export default function requestModeBodyFinder(
         link,
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'body'
       };
     }
     if (_key === 'body') {
       return {
         link: extracted[1],
         linked: false,
         line_index: index,
-        key: '*'
+        key: '*',
+        mode: 'body'
       };
     }
   }

src/finders/request/cookies.ts

@@ -23,7 +23,8 @@ export default function requestModeCookiesFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'cookies'
       };
     }
     if (_key.includes('cookie(')) {
@@ -34,7 +35,8 @@ export default function requestModeCookiesFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'cookies'
       };
     }
     if (_key === 'cookies' && extracted[1].charAt(0) === '{') {
@@ -50,15 +52,17 @@ export default function requestModeCookiesFinder(
         link,
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'cookies'
       };
     }
     if (_key === 'cookies') {
       return {
         link: extracted[1],
         linked: false,
         line_index: index,
-        key: '*'
+        key: '*',
+        mode: 'cookies'
       };
     }
   }

src/finders/request/headers.ts

@@ -23,7 +23,8 @@ export default function requestModeHeadersFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'headers'
       };
     }
     if (_key.includes('header(')) {
@@ -34,7 +35,8 @@ export default function requestModeHeadersFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'headers'
       };
     }
     if (_key.includes('getHeader(')) {
@@ -54,15 +56,17 @@ export default function requestModeHeadersFinder(
         link,
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'headers'
       };
     }
     if (_key === 'headers') {
       return {
         link: extracted[1],
         linked: false,
         line_index: index,
-        key: '*'
+        key: '*',
+        mode: 'headers'
       };
     }
   }

src/finders/request/index.ts

@@ -31,62 +31,44 @@ export default function caseRequestModeFinder(
         linked: false,
         line_index: index,
         key: _skey,
-        mode: _key as any
+        mode: _key
       };
     }
 
     // Headers matching
     res = requestModeHeadersFinder(_, _key, line, index);
     if (res !== undefined) {
-      if (res !== null) {
-        res.mode = 'headers';
-      }
       return res;
     }
 
     // Cookies matching
     res = requestModeCookiesFinder(_, _key, line, index);
     if (res !== undefined) {
-      if (res !== null) {
-        res.mode = 'cookies';
-      }
       return res;
     }
 
     // Params matching
     res = requestModeParamsFinder(_, _key, line, index);
 
     if (res !== undefined) {
-      if (res !== null) {
-        res.mode = 'params';
-      }
       return res;
     }
 
     // Params matching
     res = requestModeQueryFinder(_, _key, line, index);
     if (res !== undefined) {
-      if (res !== null) {
-        res.mode = 'query';
-      }
       return res;
     }
 
     // Body matching
     res = requestModeBodyFinder(_, _key, line, index);
     if (res !== undefined) {
-      if (res !== null) {
-        res.mode = 'body';
-      }
       return res;
     }
 
     // Method matching
     res = requestMethodFinder(_, _key, line, index);
     if (res !== undefined) {
-      if (res !== null) {
-        res.mode = 'property';
-      }
       return res;
     }
   } else {
@@ -100,7 +82,6 @@ export default function caseRequestModeFinder(
       index
     );
     if (res) {
-      res.mode = 'property';
       return res;
     }
   }

src/finders/request/params.ts

@@ -23,7 +23,8 @@ export default function requestModeParamsFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'params'
       };
     }
     if (_key.includes('param(')) {
@@ -34,7 +35,8 @@ export default function requestModeParamsFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'params'
       };
     }
     if (_key.includes('getParameter(')) {
@@ -54,15 +56,17 @@ export default function requestModeParamsFinder(
         link,
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'params'
       };
     }
     if (_key === 'params') {
       return {
         link: extracted[1],
         linked: false,
         line_index: index,
-        key: '*'
+        key: '*',
+        mode: 'params'
       };
     }
   }

src/finders/request/property.ts

@@ -23,7 +23,8 @@ export default function requestMethodFinder(
       link: extracted[1],
       linked: false,
       line_index: index,
-      key: _key
+      key: _key,
+      mode: 'property'
     };
   }
   if (_key.includes('getMethod(') || _key.includes('getUrl(')) {
@@ -46,15 +47,17 @@ export default function requestMethodFinder(
       link,
       linked: false,
       line_index: index,
-      key
+      key,
+      mode: 'property'
     };
   }
   if (_key.endsWith('req') || _key.endsWith('request')) {
     return {
       link: extracted[1],
       linked: false,
       line_index: index,
-      key: '*'
+      key: '*',
+      mode: 'property'
     };
   }
 

src/finders/request/query.ts

@@ -23,7 +23,8 @@ export default function requestModeQueryFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'query'
       };
     }
     if (_key.includes('getQuery(')) {
@@ -34,7 +35,8 @@ export default function requestModeQueryFinder(
         link: extracted[1],
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'query'
       };
     }
     if (_key === 'query' && extracted[1].charAt(0) === '{') {
@@ -50,15 +52,17 @@ export default function requestModeQueryFinder(
         link,
         linked: false,
         line_index: index,
-        key
+        key,
+        mode: 'query'
       };
     }
     if (_key === 'query') {
       return {
         link: extracted[1],
         linked: false,
         line_index: index,
-        key: '*'
+        key: '*',
+        mode: 'query'
       };
     }
   }

types/interfaces.d.ts

@@ -1,7 +1,9 @@
+export type BlockMode ='headers' | 'cookies' | 'params' | 'query' | 'body' | 'property'
+
 export interface IBlock {
   link: string;
   linked: boolean;
   line_index: number;
   key: string | '*';
-  mode?: 'headers' | 'cookies' | 'params' | 'query' | 'body' | 'property';
+  mode: BlockMode;
 }