feat: add extended support for versioned entities in the CLI (#3912)

packages/hoppscotch-cli/src/utils/checks.ts

@@ -1,5 +1,3 @@
-import { HoppCollection, isHoppRESTRequest } from "@hoppscotch/data";
-import * as A from "fp-ts/Array";
 import { CommanderError } from "commander";
 import { HoppCLIError, HoppErrnoException } from "../types/errors";
 
@@ -14,48 +12,6 @@ export const hasProperty = <P extends PropertyKey>(
   prop: P
 ): target is Record<P, unknown> => prop in target;
 
-/**
- * Typeguard to check valid Hoppscotch REST Collection.
- * @param param The object to be checked.
- * @returns True, if unknown parameter is valid Hoppscotch REST Collection;
- * False, otherwise.
- */
-export const isRESTCollection = (param: unknown): param is HoppCollection => {
-  if (!!param && typeof param === "object") {
-    if (!hasProperty(param, "v") || typeof param.v !== "number") {
-      return false;
-    }
-    if (!hasProperty(param, "name") || typeof param.name !== "string") {
-      return false;
-    }
-    if (hasProperty(param, "id") && typeof param.id !== "string") {
-      return false;
-    }
-    if (!hasProperty(param, "requests") || !Array.isArray(param.requests)) {
-      return false;
-    } else {
-      // Checks each requests array to be valid HoppRESTRequest.
-      const checkRequests = A.every(isHoppRESTRequest)(param.requests);
-      if (!checkRequests) {
-        return false;
-      }
-    }
-    if (!hasProperty(param, "folders") || !Array.isArray(param.folders)) {
-      return false;
-    } else {
-      // Checks each folder to be valid REST collection.
-      const checkFolders = A.every(isRESTCollection)(param.folders);
-      if (!checkFolders) {
-        return false;
-      }
-    }
-
-    return true;
-  }
-
-  return false;
-};
-
 /**
  * Checks if given error data is of type HoppCLIError, based on existence
  * of code property.

packages/hoppscotch-cli/src/utils/mutators.ts

@@ -1,8 +1,11 @@
+import { HoppCollection, HoppRESTRequest } from "@hoppscotch/data";
 import fs from "fs/promises";
-import { FormDataEntry } from "../types/request";
+import { entityReference } from "verzod";
+import { z } from "zod";
+
 import { error } from "../types/errors";
-import { isRESTCollection, isHoppErrnoException } from "./checks";
-import { HoppCollection } from "@hoppscotch/data";
+import { FormDataEntry } from "../types/request";
+import { isHoppErrnoException } from "./checks";
 
 /**
  * Parses array of FormDataEntry to FormData.
@@ -67,7 +70,11 @@ export async function parseCollectionData(
     ? contents
     : [contents];
 
-  if (maybeArrayOfCollections.some((x) => !isRESTCollection(x))) {
+  const collectionSchemaParsedResult = z
+    .array(entityReference(HoppCollection))
+    .safeParse(maybeArrayOfCollections);
+
+  if (!collectionSchemaParsedResult.success) {
     throw error({
       code: "MALFORMED_COLLECTION",
       path,
@@ -75,5 +82,22 @@ export async function parseCollectionData(
     });
   }
 
-  return maybeArrayOfCollections as HoppCollection[];
+  return collectionSchemaParsedResult.data.map((collection) => {
+    const requestSchemaParsedResult = z
+      .array(entityReference(HoppRESTRequest))
+      .safeParse(collection.requests);
+
+    if (!requestSchemaParsedResult.success) {
+      throw error({
+        code: "MALFORMED_COLLECTION",
+        path,
+        data: "Please check the collection data.",
+      });
+    }
+
+    return {
+      ...collection,
+      requests: requestSchemaParsedResult.data,
+    };
+  });
 }