refactor(types): put headers into a single type for reuse

nfroidure · Dec 19, 2020 · b06da51 · b06da51
1 parent 78298d9
commit b06da51
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 16 deletions.
diff --git a/packages/whook-http-router/src/validation.ts b/packages/whook-http-router/src/validation.ts
@@ -10,6 +10,7 @@ import type { OpenAPIV3 } from 'openapi-types';
 import type {
   DereferencedParameterObject,
   WhookOperation,
+  WhookHeaders,
 } from '@whook/http-transaction';
 import { parseReentrantNumber, parseBoolean } from 'strict-qs';
 
@@ -362,8 +363,8 @@ export function _validateParameter(
 
 export function filterHeaders(
   parameters: DereferencedParameterObject[],
-  headers: Record<string, string | string[]>,
-): Record<string, string | string[]> {
+  headers: WhookHeaders,
+): WhookHeaders {
   return (parameters || [])
     .filter((parameter) => 'header' === parameter.in)
     .reduce((filteredHeaders, parameter) => {
@@ -379,7 +380,7 @@ export function castParameters<
   T = boolean | boolean[] | string | string[] | number | number[]
 >(
   parameters: DereferencedParameterObject[],
-  values: Record<string, string | string[]>,
+  values: WhookHeaders,
 ): Record<string, T> {
   return (parameters || []).reduce((filteredValues, parameter) => {
     const parameterName =

diff --git a/packages/whook-http-transaction/src/index.ts b/packages/whook-http-transaction/src/index.ts
@@ -69,10 +69,9 @@ export type WhookOperation<
   'x-whook'?: T;
 };
 
-export type WhookRequest<
-  H = Record<string, string | string[]>,
-  B = JsonValue | Readable
-> = {
+export type WhookHeaders = Record<string, string | string[]>;
+
+export type WhookRequest<H = WhookHeaders, B = JsonValue | Readable> = {
   url: string;
   method: string;
   headers: H;
@@ -81,7 +80,7 @@ export type WhookRequest<
 
 export type WhookResponse<
   S = number,
-  H = Record<string, string | string[]>,
+  H = WhookHeaders,
   B = JsonValue | Readable
 > = {
   status: S;

diff --git a/packages/whook-http-transaction/src/services/obfuscator.ts b/packages/whook-http-transaction/src/services/obfuscator.ts
@@ -1,5 +1,7 @@
 import { autoService } from 'knifecycle';
 import type { LogService } from 'common-services';
+import type { JsonValue } from 'type-fest';
+import type { WhookHeaders } from '..';
 
 export type SensibleValueDescriptor = {
   name: string;
@@ -18,10 +20,11 @@ export type ObfuscatorDependencies = {
 } & ObfuscatorConfig;
 export type ObfuscatorService = {
   obfuscate: (secret: string) => string;
-  obfuscateSensibleProps: (propValue: any, propName?: string) => any;
-  obfuscateSensibleHeaders: (
-    headers: Record<string, string | string[]>,
-  ) => Record<string, string | string[]>;
+  obfuscateSensibleProps: (
+    propValue: JsonValue,
+    propName?: string,
+  ) => JsonValue;
+  obfuscateSensibleHeaders: (headers: WhookHeaders) => WhookHeaders;
 };
 
 export default autoService(initObfuscator);
@@ -160,9 +163,7 @@ async function initObfuscator({
       : obfuscate(value);
   }
 
-  function obfuscateSensibleHeaders(
-    headers: Record<string, string | string[]>,
-  ): Record<string, string | string[]> {
+  function obfuscateSensibleHeaders(headers: WhookHeaders): WhookHeaders {
     return Object.keys(headers).reduce((finalHeaders, headerName) => {
       const sensibleHeader = SENSIBLE_HEADERS.find(
         (sensibleHeader) =>
@@ -181,7 +182,10 @@ async function initObfuscator({
     }, {});
   }
 
-  function obfuscateSensibleProps(propValue: any, propName = '_') {
+  function obfuscateSensibleProps(
+    propValue: JsonValue,
+    propName = '_',
+  ): JsonValue {
     if (propValue instanceof Array) {
       return propValue.map((value) => obfuscateSensibleProps(value, propName));
     } else if (typeof propValue === 'object' && propValue !== null) {

diff --git a/packages/whook/src/index.ts b/packages/whook/src/index.ts
@@ -91,6 +91,7 @@ import type {
 import type {
   WhookOperation,
   WhookRequest,
+  WhookHeaders,
   WhookResponse,
   WhookHandler,
   WhookHandlerFunction,
@@ -131,6 +132,7 @@ export type {
   WhookConfig,
   WhookOperation,
   WhookRequest,
+  WhookHeaders,
   WhookResponse,
   WhookHandler,
   WhookHandlerFunction,