feat: add function to safely generate rest request that maintains type contracts

packages/hoppscotch-data/src/rest/index.ts

@@ -1,3 +1,4 @@
+import cloneDeep from "lodash/cloneDeep"
 import { ValidContentTypes } from "./content-types"
 import { HoppRESTAuth } from "./HoppRESTAuth"
 
@@ -56,6 +57,57 @@ export interface HoppRESTRequest {
   body: HoppRESTReqBody
 }
 
+/**
+ * Safely tries to extract REST Request data from an unknown value.
+ * If we fail to detect certain bits, we just resolve it to the default value
+ * @param x The value to extract REST Request data from
+ * @param defaultReq The default REST Request to source from
+ */
+export function safelyExtractRESTRequest(
+  x: unknown,
+  defaultReq: HoppRESTRequest
+): HoppRESTRequest {
+  const req = cloneDeep(defaultReq)
+
+  // TODO: A cleaner way to do this ?
+  if (!!x && typeof x === "object") {
+    if (x.hasOwnProperty("v") && typeof x.v === "string")
+      req.v = x.v
+
+    if (x.hasOwnProperty("id") && typeof x.id === "string")
+      req.id = x.id
+
+    if (x.hasOwnProperty("name") && typeof x.name === "string")
+      req.name = x.name
+
+    if (x.hasOwnProperty("method") && typeof x.method === "string")
+      req.method = x.method
+
+    if (x.hasOwnProperty("endpoint") && typeof x.endpoint === "string")
+      req.endpoint = x.endpoint
+
+    if (x.hasOwnProperty("preRequestScript") && typeof x.preRequestScript === "string")
+      req.preRequestScript = x.preRequestScript
+
+    if (x.hasOwnProperty("testScript") && typeof x.testScript === "string")
+      req.testScript = x.testScript
+
+    if (x.hasOwnProperty("body") && typeof x.body === "object" && !!x.body)
+      req.body = x.body as any // TODO: Deep nested checks
+
+    if (x.hasOwnProperty("auth") && typeof x.auth === "object" && !!x.auth)
+      req.auth = x.auth as any // TODO: Deep nested checks
+
+    if (x.hasOwnProperty("params") && Array.isArray(x.params))
+      req.params = x.params // TODO: Deep nested checks
+
+    if (x.hasOwnProperty("headers") && Array.isArray(x.headers))
+      req.headers = x.headers // TODO: Deep nested checks
+  }
+
+  return req
+}
+
 export function makeRESTRequest(
   x: Omit<HoppRESTRequest, "v">
 ): HoppRESTRequest {

packages/hoppscotch-data/src/type-utils.d.ts

@@ -0,0 +1,3 @@
+interface Object {
+  hasOwnProperty<K extends PropertyKey>(key: K): this is Record<K, unknown>;
+}