fix: update types for picker:oauth:* events (#43)

googleworkspace · Feb 15, 2025 · 869690f · 869690f
1 parent 646d0e2
commit 869690f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -203,13 +203,13 @@ by using the component attributes mapped to the corresponding methods of
 
 #### Events
 
-| Name                    | Type                                       | Description                                                                                                                                            |
-| ----------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `picker:oauth:error`    | `google.accounts.oauth2.ClientConfigError` | Triggered when an error occurs in the OAuth flow. See the [error guide](https://developers.google.com/identity/oauth2/web/guides/error).               |
-| `picker:oauth:response` | `google.accounts.oauth2.ClientConfigError` | Triggered when an OAuth flow completes. See the [token model guide](https://developers.google.com/identity/oauth2/web/guides/use-token-model).         |
-| `picker:canceled`       | `google.picker.ResponseObject`             | Triggered when the user cancels the picker dialog. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject). |
-| `picker:picked`         | `google.picker.ResponseObject`             | Triggered when the user picks one or more items. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).   |
-| `picker:error`          | `google.picker.ResponseObject`             | Triggered when an error occurs. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).                    |
+| Name                    | Type                                                                             | Description                                                                                                                                                                                          |
+| ----------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `picker:oauth:error`    | `google.accounts.oauth2.ClientConfigError\|google.accounts.oauth2.TokenResponse` | Triggered when an error occurs in the OAuth flow. See the [error guide](https://developers.google.com/identity/oauth2/web/guides/error). Note that the `TokenResponse` object can have error fields. |
+| `picker:oauth:response` | `google.accounts.oauth2.TokenResponse`                                           | Triggered when an OAuth flow completes. See the [token model guide](https://developers.google.com/identity/oauth2/web/guides/use-token-model).                                                       |
+| `picker:canceled`       | `google.picker.ResponseObject`                                                   | Triggered when the user cancels the picker dialog. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).                                               |
+| `picker:picked`         | `google.picker.ResponseObject`                                                   | Triggered when the user picks one or more items. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).                                                 |
+| `picker:error`          | `google.picker.ResponseObject`                                                   | Triggered when an error occurs. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).                                                                  |
 
 #### Slots
 

diff --git a/custom-elements.json b/custom-elements.json
@@ -279,9 +279,9 @@
 						{
 							"name": "picker:oauth:error",
 							"type": {
-								"text": "google.accounts.oauth2.ClientConfigError"
+								"text": "google.accounts.oauth2.ClientConfigError|google.accounts.oauth2.TokenResponse"
 							},
-							"description": "Triggered when an error occurs in the OAuth flow. See the [error guide](https://developers.google.com/identity/oauth2/web/guides/error)."
+							"description": "Triggered when an error occurs in the OAuth flow. See the [error guide](https://developers.google.com/identity/oauth2/web/guides/error). Note that the `TokenResponse` object can have error fields."
 						},
 						{
 							"name": "picker:authenticated",
@@ -292,7 +292,7 @@
 						{
 							"name": "picker:oauth:response",
 							"type": {
-								"text": "google.accounts.oauth2.ClientConfigError"
+								"text": "google.accounts.oauth2.TokenResponse"
 							},
 							"description": "Triggered when an OAuth flow completes. See the [token model guide](https://developers.google.com/identity/oauth2/web/guides/use-token-model)."
 						},

diff --git a/src/drive-picker/drive-picker-element.ts b/src/drive-picker/drive-picker-element.ts
@@ -55,8 +55,8 @@ declare global {
  * @fires {google.picker.ResponseObject} picker:canceled - Triggered when the user cancels the picker dialog. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).
  * @fires {google.picker.ResponseObject} picker:picked - Triggered when the user picks one or more items. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).
  * @fires {google.picker.ResponseObject} picker:error - Triggered when an error occurs. See [`ResponseObject`](https://developers.google.com/drive/picker/reference/picker.responseobject).
- * @fires {google.accounts.oauth2.ClientConfigError} picker:oauth:error - Triggered when an error occurs in the OAuth flow. See the [error guide](https://developers.google.com/identity/oauth2/web/guides/error).
- * @fires {google.accounts.oauth2.ClientConfigError} picker:oauth:response - Triggered when an OAuth flow completes. See the [token model guide](https://developers.google.com/identity/oauth2/web/guides/use-token-model).
+ * @fires {google.accounts.oauth2.ClientConfigError|google.accounts.oauth2.TokenResponse} picker:oauth:error - Triggered when an error occurs in the OAuth flow. See the [error guide](https://developers.google.com/identity/oauth2/web/guides/error). Note that the `TokenResponse` object can have error fields.
+ * @fires {google.accounts.oauth2.TokenResponse} picker:oauth:response - Triggered when an OAuth flow completes. See the [token model guide](https://developers.google.com/identity/oauth2/web/guides/use-token-model).
  *
  * @slot - The default slot contains View elements to display in the picker.
  * Each View element should implement a property `view` of type