Add OAuth utils #20
Merged
Add OAuth utils #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thomaslombart
force-pushed
the
f/oauth-util
branch
4 times, most recently
from
f0ba3f8 to
a6403b1
Compare
thomaslombart
force-pushed
the
f/oauth-util
branch
from
a6403b1 to
3348090
Compare
| }); | ||
| ``` | ||
|
|
||
| ## Example |
There was a problem hiding this comment.
let's put this above the ### properties
| const accessToken = await oauthService.authorize(); | ||
| ``` | ||
|
|
||
| ### Properties |
There was a problem hiding this comment.
Let's rename this to ## Built-in Services
| ##### Signature | ||
|
|
||
| ```ts | ||
| const asana: OAuthService |
There was a problem hiding this comment.
is this any useful? Could we replace it with a description like [OauthService](...) to authenticate with [Asana](...) with the correct links?
docs/utils-reference/oauth/README.md
Outdated
| @@ -0,0 +1,62 @@ | |||
| # OAuth | |||
|
|
|||
| Authenticating with OAuth in Raycast extensions is tedious. So we've built a set of utilities to make that task way easier. There's two part to our utilities: | |||
There was a problem hiding this comment.
Let's now blame Raycast, it's the case everywhere 😓
Suggested change
| Authenticating with OAuth in Raycast extensions is tedious. So we've built a set of utilities to make that task way easier. There's two part to our utilities: | |
| Dealing with OAuth can be tedious. So we've built a set of utilities to make that task way easier. There's two part to our utilities: |
docs/utils-reference/oauth/README.md
Outdated
|
|
||
| Authenticating with OAuth in Raycast extensions is tedious. So we've built a set of utilities to make that task way easier. There's two part to our utilities: | ||
|
|
||
| 1. Authenticating with the service using [OAuthService](utils-reference/oauth/OAuthService.md) and some third-party providers (e.g GitHub with `OAuthService.github`) |
There was a problem hiding this comment.
Suggested change
| 1. Authenticating with the service using [OAuthService](utils-reference/oauth/OAuthService.md) and some third-party providers (e.g GitHub with `OAuthService.github`) | |
| 1. Authenticating with the service using [OAuthService](utils-reference/oauth/OAuthService.md) or some built-in providers (e.g GitHub with `OAuthService.github`) |
| Returns the wrapped component if used in a `view` command or the wrapped function if used in a `no-view` command. | ||
|
|
||
| {% hint style="info" %} | ||
| Note that the access token isn't injected into the wrapped component props. Instead, it's been set as a global variable that you can get with `getAccessToken`. |
There was a problem hiding this comment.
let's add a link to the getAccessToken doc here
| export default withAccessToken({ authorize })(AuthorizedComponent); | ||
| ``` | ||
|
|
||
| Note that it also works for `no-view` commands as stated above: |
There was a problem hiding this comment.
let's use tabs like we do in other pages
| type OnAuthorizeParams = { | ||
| token: string; | ||
| type: OAuthType; | ||
| idToken: string | null; |
There was a problem hiding this comment.
Suggested change
| idToken: string | null; | |
| idToken: string | null; // only present if `options.client` has been provided |
src/icon/progress.ts
Outdated
| @@ -39,7 +39,7 @@ export function getProgressIcon( | |||
| color: Color | string = Color.Red, | |||
| options?: { background?: Color | string; backgroundOpacity?: number }, | |||
| ): Image.Asset { | |||
| const background = options?.background || (environment.appearance === "light" ? "black" : "white"); | |||
| const background = options?.background || (environment.theme === "light" ? "black" : "white"); | |||
| * ``` | ||
| * | ||
| * @param {object} options - Configuration options for the token acquisition. | ||
| * @param {() => Promise<string>} options.authorize - A function to retrieve an OAuth token. |
There was a problem hiding this comment.
let's add this doc to WithAccessTokenParameters as well
mathieudutour
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a set of OAuth utils to make it easier to authenticate with services in Raycast extensions. This PR introduces the following utils:
withAccessTokenalong withgetAccessTokento make it easy to fetch and get an authentication token in commands.OAuthServicealong with built-in providers (e.g GitHub, Linear, etc.) to make it easy to integrate with OAuth providers.