fix: move decodeCredential to account namespace

wavezync · Oct 30, 2022 · ede9fc2 · ede9fc2
1 parent 5466bc8
commit ede9fc2
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 53 deletions.
diff --git a/docs/helpers/account.md b/docs/helpers/account.md
@@ -30,3 +30,29 @@ idRevoke('1618033988749895', done => {
 ```
 
 - **See More**: [Docs](https://developers.google.com/identity/gsi/web/reference/js-reference#google.accounts.id.revoke)
+
+## decodeCredential()
+
+- **Type**
+
+```ts
+function decodeCredential(credential: string): DecodedGoogleUser;
+```
+
+- **Details**
+
+Helper method to decode the JWT token retrieved from the GoogleSignIn onSuccess response into a usable Object
+
+Google returns a jwt token encoded using base64url. This method will help you get a typed object to manipulate the data for your application.
+
+:::info
+This is not an official method exposed by google
+:::
+
+- **Example**
+
+<<< @/helpers/snippets/decodeJwt.vue
+
+**Output:**
+
+<<< @/helpers/snippets/jwtTokenExample.json
diff --git a/docs/helpers/oauth2.md b/docs/helpers/oauth2.md
@@ -101,25 +101,3 @@ revokeAccessToken("ACCESS TOKEN FROM GOOGLE", () => {
 ```
 
 - **See More**: [Docs](https://developers.google.com/identity/oauth2/web/reference/js-reference#google.accounts.oauth2.revoke)
-
-## decodeJWTToken()
-
-- **Type**
-
-```ts
-function decodeJWTToken(jwt: string): JwtToken;
-```
-
-- **Details**
-
-Helper method to decode the JWT token retrieved from the GoogleSignIn onSuccess response into a usable Object
-
-Google returns a jwt token encoded using base64url. This method will help you get a typed object to manipulate the data for your application.
-
-- **Example**
-
-<<< @/helpers/snippets/decodeJwt.vue
-
-**Output:**
-
-<<< @/helpers/snippets/jwtTokenExample.json
diff --git a/docs/helpers/snippets/decodeJwt.vue b/docs/helpers/snippets/decodeJwt.vue
@@ -5,7 +5,7 @@ import { GoogleSignInButton, decodeCredential } from "vue3-google-signin";
 const handleSignInSuccess = (response: CredentialResponse) => {
   const { credential } = response;
   const decodedCredential = decodeCredential(credential);
-  console.log("Credentials", decodedCredential);
+  console.log("User:", decodedCredential);
 };
 
 const handleSignInError = () => {

diff --git a/src/utils/account.ts b/src/utils/account.ts
@@ -1,4 +1,5 @@
 import type { RevocationCallback } from "@/interfaces/accounts";
+import type { DecodedGoogleUser } from "./types";
 
 /**
  * Helper method for [google.accounts.id.revoke](https://developers.google.com/identity/gsi/web/reference/js-reference#google.accounts.id.revoke)
@@ -13,3 +14,32 @@ export function idRevoke(hint: string, callback?: RevocationCallback) {
     callback?.(resp);
   });
 }
+
+/**
+ * Decode the credential token retrieved from the GoogleSignIn onSuccess response into a usable Object
+ *
+ * @param {string} credential
+ * @returns {DecodedGoogleUser}
+ */
+export function decodeCredential(credential: string): DecodedGoogleUser {
+  const base64Url = credential.split(".")[1];
+  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
+  const jsonPayload = decodeURIComponent(
+    window
+      .atob(base64)
+      .split("")
+      .map((c) => `%${("00" + c.charCodeAt(0).toString(16)).slice(-2)}`)
+      .join("")
+  );
+  const decodedToken = JSON.parse(jsonPayload);
+  return {
+    email: decodedToken.email,
+    email_verified: decodedToken.email_verified,
+    hd: decodedToken.hd,
+    family_name: decodedToken.family_name,
+    given_name: decodedToken.given_name,
+    name: decodedToken.name,
+    picture: decodedToken.picture,
+    id: decodedToken.sub,
+  };
+}
diff --git a/src/utils/oauth2.ts b/src/utils/oauth2.ts
@@ -1,5 +1,4 @@
 import type { CodeClientConfig, TokenResponse } from "@/interfaces/oauth2";
-import type { DecodedGoogleUser } from "./types";
 
 /**
  * Helper method for [google.accounts.oauth2.hasGrantedAllScopes](https://developers.google.com/identity/oauth2/web/reference/js-reference#google.accounts.oauth2.hasGrantedAllScopes)
@@ -115,32 +114,3 @@ export function buildCodeRequestRedirectUrl(
 
   return `${baseUrl}?${queryParams.toString()}`;
 }
-
-/**
- * Decode the credential token retrieved from the GoogleSignIn onSuccess response into a usable Object
- *
- * @param {string} credential
- * @returns {DecodedGoogleUser}
- */
-export function decodeCredential(credential: string): DecodedGoogleUser {
-  const base64Url = credential.split(".")[1];
-  const base64 = base64Url.replace(/-/g, "+").replace(/_/g, "/");
-  const jsonPayload = decodeURIComponent(
-    window
-      .atob(base64)
-      .split("")
-      .map((c) => `%${("00" + c.charCodeAt(0).toString(16)).slice(-2)}`)
-      .join("")
-  );
-  const decodedToken = JSON.parse(jsonPayload);
-  return {
-    email: decodedToken.email,
-    email_verified: decodedToken.email_verified,
-    hd: decodedToken.hd,
-    family_name: decodedToken.family_name,
-    given_name: decodedToken.given_name,
-    name: decodedToken.name,
-    picture: decodedToken.picture,
-    id: decodedToken.sub,
-  };
-}