feat: description field for request parameters and headers (#4187)

* feat: key-value component added for reuse

* chore: inspection result added

* chore: add `HoppRESTRequest` schema `v7`

* feat: add `description` for field for REST request headers

* feat: add `description` for field for GraphQL request headers

* fix: synchronization logic b/w bulk edit context and the default view

- Add `HoppGQLRequest` schema `v6`.
- Fix pre-existing issue with changes in bulk edit context not immediately reflecting in the default GQL request headers view.

* feat: support importing `description` fields from external sources

* test: fix failing tests

* chore: include description field for computed headers

Headers computed based on authorization info & inherited entries.

* feat: add `description` field for headers at the collection level

Add `HoppCollection` schema `v3`.

* test: fix failing tests

* ci: update tests workflow target branch trigger

* chore: cleanup

* chore: cleanup

* chore: rely on type inference

---------

Co-authored-by: jamesgeorge007 <25279263+jamesgeorge007@users.noreply.github.com>
Co-authored-by: nivedin <nivedinp@gmail.com>

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

@@ -5,33 +5,35 @@ import V2_VERSION from "./v/2"
 import V3_VERSION from "./v/3"
 import V4_VERSION from "./v/4"
 import V5_VERSION from "./v/5"
+import V6_VERSION from "./v/6"
 
-export { GQLHeader } from "./v/1"
 export {
   HoppGQLAuthBasic,
   HoppGQLAuthBearer,
-  HoppGQLAuthNone,
   HoppGQLAuthInherit,
+  HoppGQLAuthNone,
 } from "./v/2"
+export { GQLHeader } from "./v/6"
 
-export { HoppGQLAuthOAuth2, HoppGQLAuth } from "./v/5"
+export { HoppGQLAuth, HoppGQLAuthOAuth2 } from "./v/5"
 
 export { HoppGQLAuthAPIKey } from "./v/4"
 
-export const GQL_REQ_SCHEMA_VERSION = 5
+export const GQL_REQ_SCHEMA_VERSION = 6
 
 const versionedObject = z.object({
   v: z.number(),
 })
 
 export const HoppGQLRequest = createVersionedEntity({
-  latestVersion: 5,
+  latestVersion: 6,
   versionMap: {
     1: V1_VERSION,
     2: V2_VERSION,
     3: V3_VERSION,
     4: V4_VERSION,
     5: V5_VERSION,
+    6: V6_VERSION,
   },
   getVersion(x) {
     const result = versionedObject.safeParse(x)

packages/hoppscotch-data/src/graphql/v/6.ts

@@ -0,0 +1,37 @@
+import { defineVersion } from "verzod"
+import { z } from "zod"
+
+import { V5_SCHEMA } from "./5"
+
+export const GQLHeader = z.object({
+  key: z.string().catch(""),
+  value: z.string().catch(""),
+  active: z.boolean().catch(true),
+  description: z.string().catch(""),
+})
+
+export type GQLHeader = z.infer<typeof GQLHeader>
+
+export const V6_SCHEMA = V5_SCHEMA.extend({
+  v: z.literal(6),
+  headers: z.array(GQLHeader).catch([]),
+})
+
+export default defineVersion({
+  schema: V6_SCHEMA,
+  initial: false,
+  up(old: z.infer<typeof V6_SCHEMA>) {
+    const headers = old.headers.map((header) => {
+      return {
+        ...header,
+        description: "",
+      }
+    })
+
+    return {
+      ...old,
+      v: 6 as const,
+      headers,
+    }
+  },
+})