fix: improved definition types and added a missing callback function …

…in `TokenResponse` type (#199) * fix: improved definition types and added a missing callback function in TokenResponse type * chore: added patch update * fix: re export types --------- Co-authored-by: Alexandru Bereghici <abereghici@tripadvisor.com> Co-authored-by: Mo'men Sherif <momensherif.2019@gmail.com>
MomenSherif · Feb 23, 2023 · 934e58b · 934e58b · vercel · Feb 23, 2023
1 parent 4559cdb
commit 934e58b
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 60 deletions.
diff --git a/.changeset/friendly-colts-clap.md b/.changeset/friendly-colts-clap.md
@@ -0,0 +1,5 @@
+---
+'@react-oauth/google': patch
+---
+
+Improved definition types. Added missing error_callback function in TokenResponse type"
diff --git a/.changeset/old-years-try.md b/.changeset/old-years-try.md
diff --git a/.changeset/poor-beers-lie.md b/.changeset/poor-beers-lie.md
diff --git a/packages/@react-oauth/google/src/google-auth-window.d.ts b/packages/@react-oauth/google/src/google-auth-window.d.ts
@@ -1,43 +1,54 @@
-interface Window {
-  google?: {
-    accounts: {
-      id: {
-        initialize: (input: IdConfiguration) => void;
-        prompt: (momentListener?: MomentListener) => void;
-        renderButton: (
-          parent: HTMLElement,
-          options: GsiButtonConfiguration,
-        ) => void;
-        disableAutoSelect: () => void;
-        storeCredential: (
-          credential: { id: string; password: string },
-          callback?: () => void,
-        ) => void;
-        cancel: () => void;
-        onGoogleLibraryLoad: Function;
-        revoke: (accessToken: string, done: () => void) => void;
-      };
-      oauth2: {
-        initTokenClient: (config: TokenClientConfig) => {
-          requestAccessToken: (
-            overridableClientConfig?: OverridableTokenClientConfig,
+import {
+  IdConfiguration,
+  MomentListener,
+  GsiButtonConfiguration,
+  TokenClientConfig,
+  OverridableTokenClientConfig,
+  CodeClientConfig,
+  TokenResponse,
+} from './types';
+declare global {
+  interface Window {
+    google?: {
+      accounts: {
+        id: {
+          initialize: (input: IdConfiguration) => void;
+          prompt: (momentListener?: MomentListener) => void;
+          renderButton: (
+            parent: HTMLElement,
+            options: GsiButtonConfiguration,
+          ) => void;
+          disableAutoSelect: () => void;
+          storeCredential: (
+            credential: { id: string; password: string },
+            callback?: () => void,
           ) => void;
+          cancel: () => void;
+          onGoogleLibraryLoad: Function;
+          revoke: (accessToken: string, done: () => void) => void;
         };
-        initCodeClient: (config: CodeClientConfig) => {
-          requestCode: () => void;
+        oauth2: {
+          initTokenClient: (config: TokenClientConfig) => {
+            requestAccessToken: (
+              overridableClientConfig?: OverridableTokenClientConfig,
+            ) => void;
+          };
+          initCodeClient: (config: CodeClientConfig) => {
+            requestCode: () => void;
+          };
+          hasGrantedAnyScope: (
+            tokenResponse: TokenResponse,
+            firstScope: string,
+            ...restScopes: string[]
+          ) => boolean;
+          hasGrantedAllScopes: (
+            tokenResponse: TokenResponse,
+            firstScope: string,
+            ...restScopes: string[]
+          ) => boolean;
+          revoke: (accessToken: string, done?: () => void) => void;
         };
-        hasGrantedAnyScope: (
-          tokenResponse: TokenResponse,
-          firstScope: string,
-          ...restScopes: string[]
-        ) => boolean;
-        hasGrantedAllScopes: (
-          tokenResponse: TokenResponse,
-          firstScope: string,
-          ...restScopes: string[]
-        ) => boolean;
-        revoke: (accessToken: string, done?: () => void) => void;
       };
     };
-  };
+  }
 }
diff --git a/packages/@react-oauth/google/src/hooks/useGoogleLogin.ts b/packages/@react-oauth/google/src/hooks/useGoogleLogin.ts
@@ -8,18 +8,9 @@ import {
   CodeClientConfig,
   CodeResponse,
   OverridableTokenClientConfig,
+  NonOAuthError,
 } from '../types';
 
-export type NonOAuthError = {
-  /**
-   * Some non-OAuth errors, such as the popup window is failed to open;
-   * or closed before an OAuth response is returned.
-   * https://developers.google.com/identity/oauth2/web/reference/js-reference#TokenClientConfig
-   * https://developers.google.com/identity/oauth2/web/reference/js-reference#CodeClientConfig
-   */
-  type: 'popup_failed_to_open' | 'popup_closed' | 'unknown';
-};
-
 interface ImplicitFlowOptions
   extends Omit<TokenClientConfig, 'client_id' | 'scope' | 'callback'> {
   onSuccess?: (

diff --git a/packages/@react-oauth/google/src/types/index.ts b/packages/@react-oauth/google/src/types/index.ts
@@ -1,8 +1,8 @@
-type Context = 'signin' | 'signup' | 'use';
+export type Context = 'signin' | 'signup' | 'use';
 
-type UxMode = 'popup' | 'redirect';
+export type UxMode = 'popup' | 'redirect';
 
-type ErrorCode =
+export type ErrorCode =
   | 'invalid_request'
   | 'access_denied'
   | 'unauthorized_client'
@@ -160,6 +160,15 @@ export interface TokenResponse {
   error_uri?: string;
 }
 
+export type NonOAuthError = {
+  /**
+   * Some non-OAuth errors, such as the popup window is failed to open;
+   * or closed before an OAuth response is returned.
+   * https://developers.google.com/identity/oauth2/web/reference/js-reference#TokenClientConfig
+   * https://developers.google.com/identity/oauth2/web/reference/js-reference#CodeClientConfig
+   */
+  type: 'popup_failed_to_open' | 'popup_closed' | 'unknown';
+};
 export interface TokenClientConfig {
   /**
    *  The client ID for your application. You can find this value in the
@@ -180,6 +189,12 @@ export interface TokenClientConfig {
    */
   callback?: (response: TokenResponse) => void;
 
+  /**
+   * Optional. The JavaScript function that handles some non-OAuth errors,
+   * such as the popup window is failed to open; or closed before an OAuth response is returned.
+   */
+  error_callback?: (nonOAuthError: NonOAuthError) => void;
+
   /**
    * Optional, defaults to 'select_account'. A space-delimited, case-sensitive list of prompts to present the user
    */