feat: collection level headers and authorization (#3505)

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

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

@@ -1,33 +1,48 @@
-import { GQL_REQ_SCHEMA_VERSION, HoppGQLRequest, translateToGQLRequest } from "../graphql";
-import { HoppRESTRequest, translateToNewRequest } from "../rest";
+import { InferredEntity, createVersionedEntity } from "verzod"
 
-const CURRENT_COLL_SCHEMA_VER = 1
+import V1_VERSION from "./v/1"
+import V2_VERSION from "./v/2"
 
-type SupportedReqTypes =
-  | HoppRESTRequest
-  | HoppGQLRequest
+import { z } from "zod"
+import { translateToNewRequest } from "../rest"
+import { translateToGQLRequest } from "../graphql"
 
-export type HoppCollection<T extends SupportedReqTypes> = {
-  v: number
-  name: string
-  folders: HoppCollection<T>[]
-  requests: T[]
+const versionedObject = z.object({
+  // v is a stringified number
+  v: z.string().regex(/^\d+$/).transform(Number),
+})
 
-  id?: string // For Firestore ID data
-}
+export const HoppCollection = createVersionedEntity({
+  latestVersion: 2,
+  versionMap: {
+    1: V1_VERSION,
+    2: V2_VERSION,
+  },
+  getVersion(data) {
+    const versionCheck = versionedObject.safeParse(data)
+
+    if (versionCheck.success) return versionCheck.data.v
+
+    // For V1 we have to check the schema
+    const result = V1_VERSION.schema.safeParse(data)
+
+    return result.success ? 0 : null
+  },
+})
+
+export type HoppCollection = InferredEntity<typeof HoppCollection>
+
+export const CollectionSchemaVersion = 2
 
 /**
  * Generates a Collection object. This ignores the version number object
- * so it can be incremented independently without updating it everywhere
  * @param x The Collection Data
  * @returns The final collection
  */
-export function makeCollection<T extends SupportedReqTypes>(
-  x: Omit<HoppCollection<T>, "v">
-): HoppCollection<T> {
+export function makeCollection(x: Omit<HoppCollection, "v">): HoppCollection {
   return {
-    v: CURRENT_COLL_SCHEMA_VER,
-    ...x
+    v: CollectionSchemaVersion,
+    ...x,
   }
 }
 
@@ -36,20 +51,23 @@ export function makeCollection<T extends SupportedReqTypes>(
  * @param x The collection object to load
  * @returns The proper new collection format
  */
-export function translateToNewRESTCollection(
-  x: any
-): HoppCollection<HoppRESTRequest> {
-  if (x.v && x.v === 1) return x
+export function translateToNewRESTCollection(x: any): HoppCollection {
+  if (x.v && x.v === CollectionSchemaVersion) return x
 
   // Legacy
   const name = x.name ?? "Untitled"
   const folders = (x.folders ?? []).map(translateToNewRESTCollection)
   const requests = (x.requests ?? []).map(translateToNewRequest)
 
-  const obj = makeCollection<HoppRESTRequest>({
+  const auth = x.auth ?? { authType: "inherit", authActive: true }
+  const headers = x.headers ?? []
+
+  const obj = makeCollection({
     name,
     folders,
     requests,
+    auth,
+    headers,
   })
 
   if (x.id) obj.id = x.id
@@ -62,24 +80,26 @@ export function translateToNewRESTCollection(
  * @param x The collection object to load
  * @returns The proper new collection format
  */
-export function translateToNewGQLCollection(
-  x: any
-): HoppCollection<HoppGQLRequest> {
-  if (x.v && x.v === GQL_REQ_SCHEMA_VERSION) return x
+export function translateToNewGQLCollection(x: any): HoppCollection {
+  if (x.v && x.v === CollectionSchemaVersion) return x
 
   // Legacy
   const name = x.name ?? "Untitled"
   const folders = (x.folders ?? []).map(translateToNewGQLCollection)
   const requests = (x.requests ?? []).map(translateToGQLRequest)
 
-  const obj = makeCollection<HoppGQLRequest>({
+  const auth = x.auth ?? { authType: "inherit", authActive: true }
+  const headers = x.headers ?? []
+
+  const obj = makeCollection({
     name,
     folders,
     requests,
+    auth,
+    headers,
   })
 
   if (x.id) obj.id = x.id
 
   return obj
 }
-

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

@@ -0,0 +1,36 @@
+import { defineVersion, entityReference } from "verzod"
+import { z } from "zod"
+import { HoppRESTRequest } from "../../rest"
+import { HoppGQLRequest } from "../../graphql"
+
+const baseCollectionSchema = z.object({
+  v: z.literal(1),
+  id: z.optional(z.string()), // For Firestore ID data
+
+  name: z.string(),
+  requests: z.array(
+    z.lazy(() =>
+      z.union([
+        entityReference(HoppRESTRequest),
+        entityReference(HoppGQLRequest),
+      ])
+    )
+  ),
+})
+
+type Input = z.input<typeof baseCollectionSchema> & {
+  folders: Input[]
+}
+
+type Output = z.output<typeof baseCollectionSchema> & {
+  folders: Output[]
+}
+
+export const V1_SCHEMA: z.ZodType<Output, z.ZodTypeDef, Input> = baseCollectionSchema.extend({
+  folders: z.lazy(() => z.array(V1_SCHEMA)),
+})
+
+export default defineVersion({
+  initial: true,
+  schema: V1_SCHEMA,
+})

packages/hoppscotch-data/src/collection/v/2.ts

@@ -0,0 +1,57 @@
+import { defineVersion, entityReference } from "verzod"
+import { z } from "zod"
+import { HoppRESTRequest, HoppRESTAuth } from "../../rest"
+import { HoppGQLRequest, HoppGQLAuth, GQLHeader } from "../../graphql"
+import { V1_SCHEMA } from "./1"
+import { HoppRESTHeaders } from "../../rest/v/1"
+
+const baseCollectionSchema = z.object({
+  v: z.literal(2),
+  id: z.optional(z.string()), // For Firestore ID data
+
+  name: z.string(),
+  requests: z.array(
+    z.lazy(() =>
+      z.union([
+        entityReference(HoppRESTRequest),
+        entityReference(HoppGQLRequest),
+      ])
+    )
+  ),
+
+  auth: z.union([HoppRESTAuth, HoppGQLAuth]),
+  headers: z.union([HoppRESTHeaders, z.array(GQLHeader)]),
+})
+
+type Input = z.input<typeof baseCollectionSchema> & {
+  folders: Input[]
+}
+
+type Output = z.output<typeof baseCollectionSchema> & {
+  folders: Output[]
+}
+
+export const V2_SCHEMA: z.ZodType<Output, z.ZodTypeDef, Input> = baseCollectionSchema.extend({
+  folders: z.lazy(() => z.array(V2_SCHEMA)),
+})
+
+export default defineVersion({
+  initial: false,
+  schema: V2_SCHEMA,
+  up(old: z.infer<typeof V1_SCHEMA>) {
+    // @ts-expect-error
+    const result: z.infer<typeof V2_SCHEMA> = {
+      ...old,
+      v: 2,
+      auth: {
+        authActive: true,
+        authType: "inherit",
+      },
+      headers: [],
+    }
+
+    if (old.id) result.id = old.id
+
+    return result
+  },
+})