feat: oauth revamp + support for multiple grant types in oauth (#3885)

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

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

@@ -2,29 +2,32 @@ import { InferredEntity, createVersionedEntity } from "verzod"
 import { z } from "zod"
 import V1_VERSION from "./v/1"
 import V2_VERSION from "./v/2"
+import V3_VERSION from "./v/3"
 
 export { GQLHeader } from "./v/1"
 export {
-  HoppGQLAuth,
   HoppGQLAuthAPIKey,
   HoppGQLAuthBasic,
   HoppGQLAuthBearer,
   HoppGQLAuthNone,
-  HoppGQLAuthOAuth2,
   HoppGQLAuthInherit,
 } from "./v/2"
 
-export const GQL_REQ_SCHEMA_VERSION = 2
+export { HoppGQLAuth } from "./v/3"
+export { HoppGQLAuthOAuth2 } from "./v/3"
+
+export const GQL_REQ_SCHEMA_VERSION = 3
 
 const versionedObject = z.object({
   v: z.number(),
 })
 
 export const HoppGQLRequest = createVersionedEntity({
-  latestVersion: 2,
+  latestVersion: 3,
   versionMap: {
     1: V1_VERSION,
     2: V2_VERSION,
+    3: V3_VERSION,
   },
   getVersion(x) {
     const result = versionedObject.safeParse(x)

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

@@ -71,7 +71,7 @@ export const HoppGQLAuth = z
 
 export type HoppGQLAuth = z.infer<typeof HoppGQLAuth>
 
-const V2_SCHEMA = z.object({
+export const V2_SCHEMA = z.object({
   id: z.optional(z.string()),
   v: z.literal(2),
 

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

@@ -0,0 +1,77 @@
+import { z } from "zod"
+
+import { defineVersion } from "verzod"
+
+import { HoppRESTAuthOAuth2 } from "../../rest"
+import {
+  HoppGQLAuthAPIKey,
+  HoppGQLAuthBasic,
+  HoppGQLAuthBearer,
+  HoppGQLAuthInherit,
+  HoppGQLAuthNone,
+  V2_SCHEMA,
+} from "./2"
+
+export { HoppRESTAuthOAuth2 as HoppGQLAuthOAuth2 } from "../../rest"
+
+export type HoppGqlAuthOAuth2 = z.infer<typeof HoppRESTAuthOAuth2>
+
+export const HoppGQLAuth = z
+  .discriminatedUnion("authType", [
+    HoppGQLAuthNone,
+    HoppGQLAuthInherit,
+    HoppGQLAuthBasic,
+    HoppGQLAuthBearer,
+    HoppGQLAuthAPIKey,
+    HoppRESTAuthOAuth2, // both rest and gql have the same auth type for oauth2
+  ])
+  .and(
+    z.object({
+      authActive: z.boolean(),
+    })
+  )
+
+export type HoppGQLAuth = z.infer<typeof HoppGQLAuth>
+
+export const V3_SCHEMA = V2_SCHEMA.extend({
+  v: z.literal(3),
+  auth: HoppGQLAuth,
+})
+
+export default defineVersion({
+  initial: false,
+  schema: V3_SCHEMA,
+  up(old: z.infer<typeof V2_SCHEMA>) {
+    if (old.auth.authType === "oauth-2") {
+      const { token, accessTokenURL, scope, clientID, authURL } = old.auth
+
+      return {
+        ...old,
+        v: 3 as const,
+        auth: {
+          ...old.auth,
+          authType: "oauth-2" as const,
+          grantTypeInfo: {
+            grantType: "AUTHORIZATION_CODE" as const,
+            authEndpoint: authURL,
+            tokenEndpoint: accessTokenURL,
+            clientID: clientID,
+            clientSecret: "",
+            scopes: scope,
+            isPKCE: false,
+            token,
+          },
+          addTo: "HEADERS" as const,
+        },
+      }
+    }
+
+    return {
+      ...old,
+      v: 3 as const,
+      auth: {
+        ...old.auth,
+      },
+    }
+  },
+})