Skip to content

Commit a9f781e

Browse files
alexisintechalexisintech
authored
Merge branch 'core-3' into nikos/user4475-udpate-docs-with-decorateurl
2 parents c7a70ee + e5a6830 commit a9f781e

File tree

102 files changed

+2192
-452
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+2192
-452
lines changed

‎.github/pull_request_template.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,26 @@
44

55
-
66

7-
### What does this solve?
7+
### What does this solve? What changed?
88

9-
<!-- Why does this change need to happen? Include any links to Slack discussions, Linear comments, etc. -->
9+
<!--
10+
PLEASE FILL OUT WITH AS MUCH CONTEXT AS POSSIBLE
11+
Why does this change need to happen?
12+
How does this PR solve that problem you mentioned above?
13+
Describe your changes. Link relevant source code PR (from clerk/javascript, clerk/clerk, etc.)
14+
-->
1015

1116
-
1217

13-
### What changed?
18+
### Deadline
1419

15-
<!-- How does this PR solve that problem you mentioned above? Describe your changes. -->
20+
<!--
21+
DO NOT LEAVE EMPTY.
22+
When do you need this PR reviewed/shipped by? If no deadline, write something like "No rush".
23+
-->
1624

1725
-
1826

19-
<!--
20-
### Deadline
27+
### Other resources
2128

22-
When do you need this PR reviewed/shipped by?
23-
Optional - uncomment if needed. If not provided, we will prioritize it ourselves.
24-
-->
29+
<!-- Link relevant Linear tickets, Slack discussions, etc. -->

‎clerk-typedoc/backend/oauth-access-token.mdx‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
The Backend `OauthAccessToken` object holds information about an OAuth access token associated with a user that has previously authenticated with a particular OAuth provider.
2+
3+
## Properties
4+
5+
| Property | Type | Description |
6+
| -------------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| <a id="expiresat"></a> `expiresAt?` | `number` | The date when the access token expires. |
8+
| <a id="externalaccountid"></a> `externalAccountId` | `string` | The ID of the external account associated with this token. |
9+
| <a id="idtoken"></a> `idToken?` | `string` | The user's OIDC ID Token, if available. This token contains user identity information as a JWT and is returned when the provider supports [OpenID Connect (OIDC)](/docs/guides/configure/auth-strategies/oauth/overview). Not all OAuth providers implement OIDC, so this field may be `undefined` for some providers. |
10+
| <a id="label"></a> `label` | `string` | A descriptive label to differentiate multiple access tokens of the same user for the same provider. |
11+
| <a id="provider"></a> `provider` | `string` | The OAuth provider (e.g., `google`, `github`). |
12+
| <a id="publicmetadata"></a> `publicMetadata` | `Record`\<`string`, `unknown`\> | Metadata that can be read from the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. |
13+
| <a id="scopes"></a> `scopes?` | <code>string[]</code> | The scopes granted for this access token. |
14+
| <a id="token"></a> `token` | `string` | The OAuth access token. |
15+
| <a id="tokensecret"></a> `tokenSecret?` | `string` | The token secret, if applicable (e.g., for OAuth 1.0 providers). |

‎contributing/CONTRIBUTING.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ The structure of the PR should be:
102102

103103
- **Title**: Summarize the change you made, using an active voice. E.g. "Fix broken "Home" link on sidenav"
104104
- If there is an issue that this PR is meant to resolve, the titles will probably be the same.
105-
- **Description ("Leave a comment")**: Describe what the concern was and summarize how you solved it.
105+
- **Description**: GitHub PRs are our source of truth, so descriptions should include as much relevant context as possible. Aim to be as detailed as possible (see [example](https://github.com/clerk/clerk-docs/pull/3003)).
106+
- If the PR is a result of a new feature or update, include links to the relevant source code PRs in their respective repos (e.g. `clerk/javascript`) and clearly explain the behavior before —> now. If they are `clerk/dashboard` changes, include screenshots/videos showing the before —> now updates. If this context already exists in the source code PR (`clerk/javascript`, `clerk/dashboard`, `clerk/clerk`, etc.), then just copy it over to the `clerk-docs` PR description, or vice-versa (if it’s in `clerk-docs` PR description, add it to the source code PR description). Writing up context shouldn’t be too hard - AI is very much your friend here!
107+
- The **Deadline** should always be filled out, even if the date is tentative/flexible. Try to provide a reasonable exact date so that it's trackable in the PR description. If there's truly no rush on it, write something like "No rush".
106108

107109
## Preview your changes
108110

‎docs/_partials/auth-object-table.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ The `Auth` object is available on the `request` object in server contexts. Some
1010
| Express | [`req.auth`](/docs/reference/express/overview) |
1111
| React Router | [`getAuth()`](/docs/reference/react-router/get-auth) |
1212
| Remix | [`getAuth()`](/docs/reference/remix/overview#get-auth) |
13-
| Tanstack React Start | [`auth()`](/docs/reference/tanstack-react-start/auth) |
13+
| TanStack React Start | [`auth()`](/docs/reference/tanstack-react-start/auth) |
1414
| Other | `request.auth` |

‎docs/_partials/authenticate-req.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Tabs items={["Next.js", "Astro", "Express", "JS Backend SDK", "React Router", "Tanstack React Start"]}>
1+
<Tabs items={["Next.js", "Astro", "Express", "JS Backend SDK", "React Router", "TanStack React Start"]}>
22
<Tab>
33
```tsx {{ filename: 'app/api/example/route.ts' }}
44
import { clerkClient } from '@clerk/nextjs/server'

‎docs/_partials/create-invitation.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Tabs items={["Next.js", "Astro", "Express", "React Router", "Tanstack React Start"]}>
1+
<Tabs items={["Next.js", "Astro", "Express", "React Router", "TanStack React Start"]}>
22
<Tab>
33
```ts {{ filename: 'app/api/example/route.ts' }}
44
import { clerkClient } from '@clerk/nextjs/server'

‎docs/_partials/create-user.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Tabs items={["Next.js", "Astro", "Express", "React Router", "Tanstack React Start"]}>
1+
<Tabs items={["Next.js", "Astro", "Express", "React Router", "TanStack React Start"]}>
22
<Tab>
33
```ts {{ filename: 'app/api/example/route.ts' }}
44
import { auth, clerkClient } from '@clerk/nextjs/server'

0 commit comments

Comments
 (0)