Accept more than just Matrix API error details

As long as the error details payload is extensible, let drivers put more
data in them than just the key for Matrix API error responses.

Author: AndrewFerr

src/ClientWidgetApi.ts

@@ -833,11 +833,11 @@ export class ClientWidgetApi extends EventEmitter {
     }
 
     private handleDriverError(e: unknown, request: IWidgetApiRequest, message: string) {
-        const matrixApiError = this.driver.processError(e);
+        const errorDetails = this.driver.processError(e);
         this.transport.reply<IWidgetApiErrorResponseData>(request, {
             error: {
                 message,
-                ...(matrixApiError && { matrix_api_error: { ...matrixApiError } }),
+                ...errorDetails,
             },
         });
     }

src/driver/WidgetDriver.ts

@@ -19,10 +19,10 @@ import {
     IOpenIDCredentials,
     OpenIDRequestState,
     SimpleObservable,
-    IMatrixApiError,
     IRoomEvent,
     IRoomAccountData,
     ITurnServer,
+    IWidgetApiErrorResponseDataDetails,
     UpdateDelayedEventAction,
 } from "..";
 
@@ -361,13 +361,12 @@ export abstract class WidgetDriver {
     }
 
     /**
-     * Expresses an error thrown by a Matrix API request made by this driver
-     * in a format compatible with the Widget API.
+     * Expresses an error thrown by this driver in a format compatible with the Widget API.
      * @param error The error to handle.
-     * @returns The error expressed as a {@link IMatrixApiError},
+     * @returns The error expressed as a {@link IWidgetApiErrorResponseDataDetails},
      * or undefined if it cannot be expressed as one.
      */
-    public processError(error: unknown): IMatrixApiError | undefined {
+    public processError(error: unknown): IWidgetApiErrorResponseDataDetails | undefined {
         return undefined;
     }
 }

test/ClientWidgetApi-test.ts

@@ -36,6 +36,7 @@ import {
     ISendEventFromWidgetActionRequest,
     IUpdateDelayedEventFromWidgetActionRequest,
     IUploadFileActionFromWidgetActionRequest,
+    IWidgetApiErrorResponseDataDetails,
     UpdateDelayedEventAction,
 } from '../src';
 import { IGetMediaConfigActionFromWidgetActionRequest } from '../src/interfaces/GetMediaConfigAction';
@@ -70,15 +71,17 @@ class CustomMatrixError extends Error {
     }
 }
 
-function processCustomMatrixError(e: unknown): IMatrixApiError | undefined {
+function processCustomMatrixError(e: unknown): IWidgetApiErrorResponseDataDetails | undefined {
     return e instanceof CustomMatrixError ? {
-        http_status: e.httpStatus,
-        http_headers: {},
-        url: '',
-        response: {
-            errcode: e.name,
-            error: e.message,
-            ...e.data,
+        matrix_api_error: {
+            http_status: e.httpStatus,
+            http_headers: {},
+            url: '',
+            response: {
+                errcode: e.name,
+                error: e.message,
+                ...e.data,
+            },
         },
     } : undefined;
 }