feat: collection level headers and authorization (#3505)

Co-authored-by: Andrew Bastin <andrewbastin.k@gmail.com>

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

@@ -20,10 +20,12 @@ export {
   HoppRESTAuth,
   HoppRESTAuthAPIKey,
   HoppRESTAuthBasic,
+  HoppRESTAuthInherit,
   HoppRESTAuthBearer,
   HoppRESTAuthNone,
   HoppRESTAuthOAuth2,
   HoppRESTReqBody,
+  HoppRESTHeaders,
 } from "./v/1"
 
 const versionedObject = z.object({

packages/hoppscotch-data/src/rest/v/1.ts

@@ -3,27 +3,29 @@ import { z } from "zod"
 
 import { V0_SCHEMA } from "./0"
 
-export const FormDataKeyValue = z.object({
-  key: z.string(),
-  active: z.boolean()
-}).and(
-  z.union([
-    z.object({
-      isFile: z.literal(true),
-      value: z.array(z.instanceof(Blob).nullable())
-    }),
-    z.object({
-      isFile: z.literal(false),
-      value: z.string()
-    })
-  ])
-)
+export const FormDataKeyValue = z
+  .object({
+    key: z.string(),
+    active: z.boolean(),
+  })
+  .and(
+    z.union([
+      z.object({
+        isFile: z.literal(true),
+        value: z.array(z.instanceof(Blob).nullable()),
+      }),
+      z.object({
+        isFile: z.literal(false),
+        value: z.string(),
+      }),
+    ])
+  )
 
 export type FormDataKeyValue = z.infer<typeof FormDataKeyValue>
 
 export const HoppRESTReqBodyFormData = z.object({
   contentType: z.literal("multipart/form-data"),
-  body: z.array(FormDataKeyValue)
+  body: z.array(FormDataKeyValue),
 })
 
 export type HoppRESTReqBodyFormData = z.infer<typeof HoppRESTReqBodyFormData>
@@ -31,11 +33,11 @@ export type HoppRESTReqBodyFormData = z.infer<typeof HoppRESTReqBodyFormData>
 export const HoppRESTReqBody = z.union([
   z.object({
     contentType: z.literal(null),
-    body: z.literal(null).catch(null)
+    body: z.literal(null).catch(null),
   }),
   z.object({
     contentType: z.literal("multipart/form-data"),
-    body: z.array(FormDataKeyValue).catch([])
+    body: z.array(FormDataKeyValue).catch([]),
   }),
   z.object({
     contentType: z.union([
@@ -48,14 +50,14 @@ export const HoppRESTReqBody = z.union([
       z.literal("text/html"),
       z.literal("text/plain"),
     ]),
-    body: z.string().catch("")
-  })
+    body: z.string().catch(""),
+  }),
 ])
 
 export type HoppRESTReqBody = z.infer<typeof HoppRESTReqBody>
 
 export const HoppRESTAuthNone = z.object({
-  authType: z.literal("none")
+  authType: z.literal("none"),
 })
 
 export type HoppRESTAuthNone = z.infer<typeof HoppRESTAuthNone>
@@ -96,17 +98,26 @@ export const HoppRESTAuthAPIKey = z.object({
 
 export type HoppRESTAuthAPIKey = z.infer<typeof HoppRESTAuthAPIKey>
 
-export const HoppRESTAuth = z.discriminatedUnion("authType", [
-  HoppRESTAuthNone,
-  HoppRESTAuthBasic,
-  HoppRESTAuthBearer,
-  HoppRESTAuthOAuth2,
-  HoppRESTAuthAPIKey
-]).and(
-  z.object({
-    authActive: z.boolean(),
-  })
-)
+export const HoppRESTAuthInherit = z.object({
+  authType: z.literal("inherit"),
+})
+
+export type HoppRESTAuthInherit = z.infer<typeof HoppRESTAuthInherit>
+
+export const HoppRESTAuth = z
+  .discriminatedUnion("authType", [
+    HoppRESTAuthNone,
+    HoppRESTAuthInherit,
+    HoppRESTAuthBasic,
+    HoppRESTAuthBearer,
+    HoppRESTAuthOAuth2,
+    HoppRESTAuthAPIKey,
+  ])
+  .and(
+    z.object({
+      authActive: z.boolean(),
+    })
+  )
 
 export type HoppRESTAuth = z.infer<typeof HoppRESTAuth>
 
@@ -114,7 +125,7 @@ export const HoppRESTParams = z.array(
   z.object({
     key: z.string().catch(""),
     value: z.string().catch(""),
-    active: z.boolean().catch(true)
+    active: z.boolean().catch(true),
   })
 )
 
@@ -124,7 +135,7 @@ export const HoppRESTHeaders = z.array(
   z.object({
     key: z.string().catch(""),
     value: z.string().catch(""),
-    active: z.boolean().catch(true)
+    active: z.boolean().catch(true),
   })
 )
 
@@ -144,17 +155,21 @@ const V1_SCHEMA = z.object({
 
   auth: HoppRESTAuth,
 
-  body: HoppRESTReqBody
+  body: HoppRESTReqBody,
 })
 
-function parseRequestBody(x: z.infer<typeof V0_SCHEMA>): z.infer<typeof V1_SCHEMA>["body"] {
+function parseRequestBody(
+  x: z.infer<typeof V0_SCHEMA>
+): z.infer<typeof V1_SCHEMA>["body"] {
   return {
     contentType: "application/json",
     body: x.contentType === "application/json" ? x.rawParams ?? "" : "",
   }
 }
 
-export function parseOldAuth(x: z.infer<typeof V0_SCHEMA>): z.infer<typeof V1_SCHEMA>["auth"] {
+export function parseOldAuth(
+  x: z.infer<typeof V0_SCHEMA>
+): z.infer<typeof V1_SCHEMA>["auth"] {
   if (!x.auth || x.auth === "None")
     return {
       authType: "none",
@@ -183,7 +198,16 @@ export default defineVersion({
   initial: false,
   schema: V1_SCHEMA,
   up(old: z.infer<typeof V0_SCHEMA>) {
-    const { url, path, headers, params, name, method, preRequestScript, testScript } = old
+    const {
+      url,
+      path,
+      headers,
+      params,
+      name,
+      method,
+      preRequestScript,
+      testScript,
+    } = old
 
     const endpoint = `${url}${path}`
     const body = parseRequestBody(old)