feat: extend IConvertibleToPartialErrorInfo with detail field.

- Adds field to the Partial error info interface and sanity checks the type.

Author: splindsay-92

src/common/lib/types/errorinfo.ts

@@ -26,12 +26,14 @@ export interface IConvertibleToErrorInfo {
   message: string;
   code: number;
   statusCode: number;
+  detail?: Record<string, string>;
 }
 
 export interface IConvertibleToPartialErrorInfo {
   message: string;
   code: number | null;
   statusCode?: number;
+  detail?: Record<string, string>;
 }
 
 export default class ErrorInfo extends Error implements IPartialErrorInfo, API.ErrorInfo {
@@ -57,11 +59,11 @@ export default class ErrorInfo extends Error implements IPartialErrorInfo, API.E
   }
 
   static fromValues(values: IConvertibleToErrorInfo): ErrorInfo {
-    const { message, code, statusCode } = values;
-    if (typeof message !== 'string' || typeof code !== 'number' || typeof statusCode !== 'number') {
+    const { message, code, statusCode, detail } = values;
+    if (typeof message !== 'string' || typeof code !== 'number' || typeof statusCode !== 'number' || (!Utils.isNil(detail) && typeof detail !== 'object')) {
       throw new Error('ErrorInfo.fromValues(): invalid values: ' + Platform.Config.inspect(values));
     }
-    const result = Object.assign(new ErrorInfo(message, code, statusCode), values);
+    const result = Object.assign(new ErrorInfo(message, code, statusCode, undefined, detail), values);
     if (result.code && !result.href) {
       result.href = 'https://help.ably.io/error/' + result.code;
     }
@@ -76,30 +78,32 @@ export class PartialErrorInfo extends Error implements IPartialErrorInfo {
   href?: string;
   detail?: Record<string, string>;
 
-  constructor(message: string, code: number | null, statusCode?: number, cause?: ErrorInfo | PartialErrorInfo) {
+  constructor(message: string, code: number | null, statusCode?: number, cause?: ErrorInfo | PartialErrorInfo, detail?: Record<string, string>) {
     super(message);
     if (typeof Object.setPrototypeOf !== 'undefined') {
       Object.setPrototypeOf(this, PartialErrorInfo.prototype);
     }
     this.code = code;
     this.statusCode = statusCode;
     this.cause = cause;
+    this.detail = detail;
   }
 
   toString(): string {
     return toString(this);
   }
 
   static fromValues(values: IConvertibleToPartialErrorInfo): PartialErrorInfo {
-    const { message, code, statusCode } = values;
+    const { message, code, statusCode, detail } = values;
     if (
       typeof message !== 'string' ||
       (!Utils.isNil(code) && typeof code !== 'number') ||
-      (!Utils.isNil(statusCode) && typeof statusCode !== 'number')
+      (!Utils.isNil(statusCode) && typeof statusCode !== 'number') ||
+      (!Utils.isNil(detail) && typeof detail !== 'object')
     ) {
       throw new Error('PartialErrorInfo.fromValues(): invalid values: ' + Platform.Config.inspect(values));
     }
-    const result = Object.assign(new PartialErrorInfo(message, code, statusCode), values);
+    const result = Object.assign(new PartialErrorInfo(message, code, statusCode, undefined, detail), values);
     if (result.code && !result.href) {
       result.href = 'https://help.ably.io/error/' + result.code;
     }