feat: add header to the source object (#73)

Author: fabriciotav

Diff for: docs/api/ts-japi.errorserializer.defaultoptions.md

@@ -21,6 +21,7 @@ class ErrorSerializer {
       source: {
         pointer: string;
         parameter: undefined;
+        header: undefined;
       };
     };
     metaizers: {};

Diff for: docs/api/ts-japi.errorserializer.md

@@ -28,7 +28,7 @@ export default class ErrorSerializer<ErrorType>
 
 | Property                                                      | Modifiers           | Type                                                                                                                                                                                           | Description                                                        |
 | ------------------------------------------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
-| [defaultOptions](./ts-japi.errorserializer.defaultoptions.md) | <code>static</code> | { version: string; attributes: { id: string; status: string; code: string; title: string; detail: string; source: { pointer: string; parameter: undefined; }; }; metaizers: {}; linkers: {}; } | Default options. Can be edited to change default options globally. |
+| [defaultOptions](./ts-japi.errorserializer.defaultoptions.md) | <code>static</code> | { version: string; attributes: { id: string; status: string; code: string; title: string; detail: string; source: { pointer: string; parameter: undefined; header: undefined; }; }; metaizers: {}; linkers: {}; } | Default options. Can be edited to change default options globally. |
 
 ## Methods
 

Diff for: docs/api/ts-japi.japierror.md

@@ -25,7 +25,7 @@ export default class JapiError
 | [id?](./ts-japi.japierror.id.md)         |           | string                                                                               | <i>(Optional)</i> A unique identifier for this particular occurrence of the problem.                                                                                       |
 | [links?](./ts-japi.japierror.links.md)   |           | [Dictionary](./ts-japi.dictionary.md)&lt;Link \| [nullish](./ts-japi.nullish.md)&gt; | <i>(Optional)</i> A links object                                                                                                                                           |
 | [meta?](./ts-japi.japierror.meta.md)     |           | Meta                                                                                 | <i>(Optional)</i> A meta object containing non-standard meta information about the error.                                                                                  |
-| [source?](./ts-japi.japierror.source.md) |           | { pointer?: string; parameter?: string; }                                            | <i>(Optional)</i> An object containing references to the source of the error, optionally including any of the following members.                                           |
+| [source?](./ts-japi.japierror.source.md) |           | { pointer?: string; parameter?: string; header?: string; }                                            | <i>(Optional)</i> An object containing references to the source of the error, optionally including any of the following members.                                           |
 | [status?](./ts-japi.japierror.status.md) |           | string                                                                               | <i>(Optional)</i> The HTTP status code applicable to this problem, expressed as a string value.                                                                            |
 | [title?](./ts-japi.japierror.title.md)   |           | string                                                                               | <i>(Optional)</i> A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. |
 

Diff for: docs/api/ts-japi.japierror.source.md

@@ -14,6 +14,7 @@ class JapiError {
   source?: {
     pointer?: string;
     parameter?: string;
+    header?: string;
   };
 }
 ```

Diff for: src/classes/error-serializer.ts

@@ -28,6 +28,7 @@ export default class ErrorSerializer<ErrorType extends Dictionary<any>> {
       source: {
         pointer: 'location',
         parameter: undefined,
+        header: undefined,
       },
     },
     metaizers: {},
@@ -101,6 +102,9 @@ export default class ErrorSerializer<ErrorType extends Dictionary<any>> {
         if (attributes.source.parameter && e[attributes.source.parameter]) {
           eo.source.parameter = String(e[attributes.source.parameter]);
         }
+        if (attributes.source.header && e[attributes.source.header]) {
+          eo.source.header = String(e[attributes.source.header]);
+        }
         if (Object.keys(eo.source).length === 0) {
           delete eo.source;
         }

Diff for: src/interfaces/error-serializer.interface.ts

@@ -65,6 +65,14 @@ export interface ErrorSourceAttribute<T> {
    * @defaultValue `undefined`
    */
   parameter: keyof T;
+
+  /**
+   * A string indicating the name of a single request header which caused
+   * the error.
+   *
+   * @defaultValue `undefined`
+   */
+  header: keyof T;
 }
 
 export interface ErrorSerializerOptions<T extends Dictionary<any>> {

Diff for: src/interfaces/error.interface.ts

@@ -10,6 +10,12 @@ export interface ErrorSource {
    * A string indicating which URI query parameter caused the error.
    */
   parameter?: string;
+
+  /**
+   * A string indicating the name of a single request header which caused
+   * the error.
+   */
+  header?: string;
 }
 
 export interface ErrorOptions {

Diff for: src/models/error.model.ts

@@ -81,6 +81,12 @@ export default class JapiError {
      * A string indicating which URI query parameter caused the error.
      */
     parameter?: string;
+
+    /**
+     * A string indicating the name of a single request header which caused
+     * the error.
+     */
+    header?: string;
   };
 
   /**

Diff for: test/error-serializer.test.ts

@@ -15,6 +15,7 @@ class CustomForbiddenError extends JapiError {
       source: {
         pointer: 'perhaps/in/response/body',
         parameter: 'some-query-param',
+        header: 'some-header',
       },
     });
   }
@@ -40,6 +41,7 @@ describe('Error Serializer Tests', () => {
           source: {
             pointer: 'name',
             parameter: 'name',
+            header: 'name',
           },
         },
       },
@@ -51,7 +53,7 @@ describe('Error Serializer Tests', () => {
             code: 'Error',
             detail: 'This is a test.',
             id: 'Error',
-            source: { parameter: 'Error', pointer: 'Error' },
+            source: { header: 'Error', parameter: 'Error', pointer: 'Error' },
             status: 'Error',
             title: 'Error',
           },
@@ -102,6 +104,7 @@ describe('Error Serializer Tests', () => {
             source: {
               parameter: 'some-query-param',
               pointer: 'perhaps/in/response/body',
+              header: 'some-header',
             },
           },
         ],
@@ -110,15 +113,18 @@ describe('Error Serializer Tests', () => {
     ],
   ])('With Options %o', (options, ErrorType, expectedFrom) => {
     let PrimitiveErrorSerializer: ErrorSerializer<any>;
+
     it('should construct a ErrorSerializer', () => {
       expect(() => (PrimitiveErrorSerializer = new ErrorSerializer(options))).not.toThrow();
     });
+
     it('tests a ErrorSerializer on User ID %s', () => {
       // Get dummy data.
       const error = new ErrorType('This is a test.');
 
       // Testing methods
-      let document: ErrorDocument;
+      let document: ErrorDocument | undefined;
+
       expect(() => (document = PrimitiveErrorSerializer.serialize(error))).not.toThrow();
       expect(() => (document = PrimitiveErrorSerializer.serialize([error]))).not.toThrow();