types: Make Data type-parameter optional in JsonRpcError

This is in order to provide backwards-compatibility with code implemented towards v5.0.0.
MetaMask · Aug 23, 2023 · aa42de1 · aa42de1
1 parent ab0ebca
commit aa42de1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/src/classes.ts b/src/classes.ts
@@ -5,7 +5,10 @@ import type {
 import { isPlainObject } from '@metamask/utils';
 import safeStringify from 'fast-safe-stringify';
 
-import type { DataWithOptionalCause } from './utils';
+import type {
+  DataWithOptionalCause,
+  OptionalDataWithOptionalCause,
+} from './utils';
 import { serializeCause } from './utils';
 
 export type { SerializedJsonRpcError };
@@ -16,7 +19,9 @@ export type { SerializedJsonRpcError };
  *
  * Permits any integer error code.
  */
-export class JsonRpcError<Data extends DataWithOptionalCause> extends Error {
+export class JsonRpcError<
+  Data extends OptionalDataWithOptionalCause,
+> extends Error {
   public code: number;
 
   public data?: Data;

diff --git a/src/utils.ts b/src/utils.ts
@@ -29,6 +29,14 @@ export type DataWithOptionalCause =
       cause: unknown;
     };
 
+/**
+ * A data object, that must be either:
+ *
+ * - A valid DataWithOptionalCause value.
+ * - undefined.
+ */
+export type OptionalDataWithOptionalCause = undefined | DataWithOptionalCause;
+
 const FALLBACK_ERROR_CODE = errorCodes.rpc.internal;
 const FALLBACK_MESSAGE =
   'Unspecified error message. This is a bug, please report it.';