fix(types): Optional JSON params where undefined is not valid (#134)

* fix(types): Optional JSON params where undefined is not valid * Reduce type duplication by excluding `undefined` --------- Co-authored-by: Maarten Zuidhoorn <[email protected]>
MetaMask · Aug 31, 2023 · e8cad2f · e8cad2f
1 parent 58b1611
commit e8cad2f
Showing 1 changed file with 10 additions and 12 deletions.
diff --git a/src/json.ts b/src/json.ts
@@ -13,7 +13,6 @@ import {
   nullable,
   number,
   object,
-  omit,
   optional,
   record,
   string,
@@ -178,36 +177,35 @@ export type JsonRpcError = OptionalField<
 >;
 
 export const JsonRpcParamsStruct: Struct<Json[] | Record<string, Json>, null> =
-  optional(union([record(string(), JsonStruct), array(JsonStruct)])) as any;
+  union([record(string(), JsonStruct), array(JsonStruct)]);
 
 export type JsonRpcParams = Json[] | Record<string, Json>;
 
 export const JsonRpcRequestStruct = object({
   id: JsonRpcIdStruct,
   jsonrpc: JsonRpcVersionStruct,
   method: string(),
-  params: JsonRpcParamsStruct,
+  params: optional(JsonRpcParamsStruct),
 });
 
 export type InferWithParams<
   Type extends Struct<any>,
   Params extends JsonRpcParams,
-> = Omit<Infer<Type>, 'params'> &
-  (keyof Params extends undefined
-    ? {
-        params?: Params;
-      }
-    : {
-        params: Params;
-      });
+> = Omit<Infer<Type>, 'params'> & {
+  params?: Exclude<Params, undefined>;
+};
 
 /**
  * A JSON-RPC request object.
  */
 export type JsonRpcRequest<Params extends JsonRpcParams = JsonRpcParams> =
   InferWithParams<typeof JsonRpcRequestStruct, Params>;
 
-export const JsonRpcNotificationStruct = omit(JsonRpcRequestStruct, ['id']);
+export const JsonRpcNotificationStruct = object({
+  jsonrpc: JsonRpcVersionStruct,
+  method: string(),
+  params: optional(JsonRpcParamsStruct),
+});
 
 /**
  * A JSON-RPC notification object.