feat: secret variables in environments (#3779)

Co-authored-by: jamesgeorge007 <jamesgeorge998001@gmail.com>

packages/hoppscotch-common/src/helpers/import-export/export/environment.ts

@@ -12,8 +12,6 @@ const getEnvironmentJson = (
       ? cloneDeep(environmentObj.environment)
       : cloneDeep(environmentObj)
 
-  delete newEnvironment.id
-
   const environmentId =
     environmentIndex || environmentIndex === 0
       ? environmentIndex

packages/hoppscotch-common/src/helpers/import-export/import/hoppEnv.ts

@@ -1,22 +1,13 @@
-import * as TE from "fp-ts/TaskEither"
 import * as O from "fp-ts/Option"
+import * as TE from "fp-ts/TaskEither"
+import { entityReference } from "verzod"
 
-import { IMPORTER_INVALID_FILE_FORMAT } from "."
 import { safeParseJSON } from "~/helpers/functional/json"
+import { IMPORTER_INVALID_FILE_FORMAT } from "."
 
+import { Environment } from "@hoppscotch/data"
 import { z } from "zod"
 
-const hoppEnvSchema = z.object({
-  id: z.string().optional(),
-  name: z.string(),
-  variables: z.array(
-    z.object({
-      key: z.string(),
-      value: z.string(),
-    })
-  ),
-})
-
 export const hoppEnvImporter = (content: string) => {
   const parsedContent = safeParseJSON(content, true)
 
@@ -25,7 +16,9 @@ export const hoppEnvImporter = (content: string) => {
     return TE.left(IMPORTER_INVALID_FILE_FORMAT)
   }
 
-  const validationResult = z.array(hoppEnvSchema).safeParse(parsedContent.value)
+  const validationResult = z
+    .array(entityReference(Environment))
+    .safeParse(parsedContent.value)
 
   if (!validationResult.success) {
     return TE.left(IMPORTER_INVALID_FILE_FORMAT)

packages/hoppscotch-common/src/helpers/import-export/import/insomniaEnv.ts

@@ -4,8 +4,9 @@ import * as O from "fp-ts/Option"
 import { IMPORTER_INVALID_FILE_FORMAT } from "."
 
 import { z } from "zod"
-import { Environment } from "@hoppscotch/data"
+import { NonSecretEnvironment } from "@hoppscotch/data"
 import { safeParseJSONOrYAML } from "~/helpers/functional/yaml"
+import { uniqueId } from "lodash-es"
 
 const insomniaResourcesSchema = z.object({
   resources: z.array(
@@ -56,16 +57,18 @@ export const insomniaEnvImporter = (content: string) => {
       return { ...envResource, data: stringifiedData }
     })
 
-  const environments: Environment[] = []
+  const environments: NonSecretEnvironment[] = []
 
   insomniaEnvs.forEach((insomniaEnv) => {
     const parsedInsomniaEnv = insomniaEnvSchema.safeParse(insomniaEnv)
 
     if (parsedInsomniaEnv.success) {
-      const environment: Environment = {
+      const environment: NonSecretEnvironment = {
+        id: uniqueId(),
+        v: 1,
         name: parsedInsomniaEnv.data.name,
         variables: Object.entries(parsedInsomniaEnv.data.data).map(
-          ([key, value]) => ({ key, value })
+          ([key, value]) => ({ key, value, secret: false })
         ),
       }
 

packages/hoppscotch-common/src/helpers/import-export/import/postmanEnv.ts

@@ -6,6 +6,7 @@ import { safeParseJSON } from "~/helpers/functional/json"
 
 import { z } from "zod"
 import { Environment } from "@hoppscotch/data"
+import { uniqueId } from "lodash-es"
 
 const postmanEnvSchema = z.object({
   name: z.string(),
@@ -34,12 +35,14 @@ export const postmanEnvImporter = (content: string) => {
   const postmanEnv = validationResult.data
 
   const environment: Environment = {
+    id: uniqueId(),
+    v: 1,
     name: postmanEnv.name,
     variables: [],
   }
 
   postmanEnv.values.forEach(({ key, value }) =>
-    environment.variables.push({ key, value })
+    environment.variables.push({ key, value, secret: false })
   )
 
   return TE.right(environment)