Skip to content

Commit b3033fa

Browse files
(chore): handle build script warnings (#2170)
Co-authored-by: Nick Wylynko <[email protected]>
1 parent f702668 commit b3033fa

File tree

81 files changed

+182
-370
lines changed

Some content is hidden

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

81 files changed

+182
-370
lines changed

docs/_partials/clerk-middleware-options.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The `clerkMiddleware()` function accepts an optional object. The following optio
4646
- `organizationSyncOptions?`
4747
- <code>[OrganizationSyncOptions](#organization-sync-options) | undefined</code>
4848

49-
Used to activate a specific [organization](/docs/organizations/overview) or [personal account](/docs/organizations/organization-workspaces#organization-workspaces-in-the-clerk-dashboard:~:text=Personal%20account) based on URL path parameters. If there's a mismatch between the active organization in the session (e.g., as reported by [`auth()`](/docs/references/nextjs/auth)) and the organization indicated by the URL, the middleware will attempt to activate the organization specified in the URL.
49+
Used to activate a specific [organization](/docs/organizations/overview) or [personal account](/docs/organizations/organization-workspaces) based on URL path parameters. If there's a mismatch between the active organization in the session (e.g., as reported by [`auth()`](/docs/references/nextjs/auth)) and the organization indicated by the URL, the middleware will attempt to activate the organization specified in the URL.
5050

5151
---
5252

docs/_partials/custom-flows/email-link-verification.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
1. The `createEmailLinkFlow()` method is used to access the `startEmailLinkFlow()` method.
88
1. The `startEmailLinkFlow()` method is called with the `redirectUrl` parameter set to `/account/add-email/verify`. It sends an email with a verification link to the user. When the user visits the link, they are redirected to the URL that was provided.
99
1. On the `/account/add-email/verify` page, the [`useClerk()`](/docs/hooks/use-clerk) hook is used to get the `handleEmailLinkVerification()` method.
10-
1. The [`handleEmailLinkVerification()`](/docs/references/javascript/clerk/handle-navigation#handle-email-link-verification) method is called to verify the email address. Error handling is included to handle any errors that occur during the verification process.
10+
1. The [`handleEmailLinkVerification()`](/docs/references/javascript/clerk#handle-email-link-verification) method is called to verify the email address. Error handling is included to handle any errors that occur during the verification process.
1111

1212
<Tabs items={["Next.js"]}>
1313
<Tab>

docs/advanced-usage/clerk-idp.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Learn how to use Clerk as an Identity Provider to facilitate Single
44
---
55

66
> [!WARNING]
7-
> **This feature is not designed for handling authentication directly in your application.** To handle authentication _in your_ application, you can [configure one of the many social providers that Clerk offers](/docs/authentication/social-connections/overview#configuration), such as Google.
7+
> **This feature is not designed for handling authentication directly in your application.** To handle authentication _in your_ application, you can [configure one of the many social providers that Clerk offers](/docs/authentication/social-connections/overview#enable-a-social-connection), such as Google.
88
99
Clerk can be configured as an OAuth 2.0 and OpenID Connect (OIDC) Identity Provider (IdP) to facilitate Single Sign-On (SSO) with other clients that support the protocols. This feature allows users to authenticate to other applications using their Clerk credentials, enabling user information sharing between your Clerk application and OAuth clients.
1010

docs/advanced-usage/satellite-domains.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ To access authentication state from a satellite domain, users will be transparen
162162
163163
<Tabs items={["Next.js", "Remix"]}>
164164
<Tab>
165-
In a Next.js application, you must set the properties in the [`<ClerkProvider>`](/docs/components/clerk-provider) component _and_ in your [`clerkMiddleware()`](/docs/references/nextjs/clerk-middleware#clerk-middleware).
165+
In a Next.js application, you must set the properties in the [`<ClerkProvider>`](/docs/components/clerk-provider) component _and_ in your [`clerkMiddleware()`](/docs/references/nextjs/clerk-middleware).
166166

167167
- In the Next project associated with your primary domain, only the `signInUrl` prop needs to be configured as shown in the following example:
168168

docs/authentication/configuration/session-options.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -126,10 +126,10 @@ By default, signing out from a currently active account in a multi-session app w
126126

127127
If a sign-in URL is not set, signing out will navigate to Clerk's Account Portal `/sign-in/choose` page, allowing the user to choose which account to switch into.
128128

129-
If a sign-in URL is set, either through the [`signInUrl`](/docs/components/clerk-provider#properties:~:text=Name-,signInUrl,-Type) prop on `<ClerkProvider>` or the [`CLERK_SIGN_IN_URL` environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects), signing out will navigate to that URL's `/choose` route. For example, if `signInUrl` or `CLERK_SIGN_IN_URL` is set to `https://example.com/sign-in`, signing out of a multi-session app will navigate to `https://example.com/sign-in/choose`.
129+
If a sign-in URL is set, either through the [`signInUrl`](/docs/components/clerk-provider) prop on `<ClerkProvider>` or the [`CLERK_SIGN_IN_URL` environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects), signing out will navigate to that URL's `/choose` route. For example, if `signInUrl` or `CLERK_SIGN_IN_URL` is set to `https://example.com/sign-in`, signing out of a multi-session app will navigate to `https://example.com/sign-in/choose`.
130130

131131
<If sdk={["nextjs", "react", "expo", "react-router", "tanstack-react-start"]}>
132-
To redirect to a custom route, pass the [`afterMultiSessionSingleSignOutUrl`](/docs/components/clerk-provider#properties:~:text=afterMultiSessionSingleSignOutUrl) property to `<ClerkProvider>`.
132+
To redirect to a custom route, pass the [`afterMultiSessionSingleSignOutUrl`](/docs/components/clerk-provider#properties) property to `<ClerkProvider>`.
133133
</If>
134134

135135
## Customize session token

docs/authentication/configuration/sign-up-sign-in-options.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ To update your identifiers after your application has been created:
3434
1. In the Clerk Dashboard, navigate to the [**Email, phone, username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) page.
3535
1. In the **Contact information** section, you can select **Email address** and **Phone number** as identifiers. In the **Username** section, you can select **Username** as an identifier.
3636

37+
## Personal information
38+
39+
Personal information is extra information that you can collect from users during the sign-up process. Currently, the only personal information that you can collect is a first name and last name. By default, this information is not collected. To configure this feature:
40+
41+
1. In the Clerk Dashboard, navigate to the [**Email, phone, username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) page.
42+
1. In the **Personal information** section, enable **Name**. By default, providing a first name and last name is optional. To make it required, select the settings icon next to **Name** and enable **Required**.
43+
3744
## Authentication strategies
3845

3946
Authentication strategies are methods that users can use to sign up and sign in to your application.

docs/authentication/enterprise-connections/saml/custom-provider.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,15 @@ This guide shows you how to set up a SAML connection with a custom IdP in Clerk.
8686

8787
Mapping the claims in your IdP to the attributes in Clerk ensures that the data from your IdP is correctly mapped to the data in Clerk.
8888

89-
In the Clerk Dashboard, find the **Attribute mapping** section. Here, you are shown what properties on the [`User`](/docs/users/overview#user-object) object in Clerk are being mapped to the claims in your IdP.
89+
In the Clerk Dashboard, find the **Attribute mapping** section. Here, you are shown what properties on the [`User`](/docs/references/javascript/user) object in Clerk are being mapped to the claims in your IdP.
9090

9191
In your IdP dashboard, there should be a section where you can map the IdP's claims to the attributes in Clerk. For example, Google has a `Primary email` claim that needs to be mapped to Clerk's `mail` property. During SAML configuration in the Google dashboard, Google provides a section where these claims can be mapped.
9292

9393
If you have additional claims that you would like to map to Clerk that are not listed in the **Attribute mapping** section, you can do so by following the steps in the [Map other claims](#map-other-claims-optional) section.
9494

9595
### Map other claims (optional)
9696

97-
In Clerk, the [`User`](/docs/users/overview#user-object) object has a `publicMetadata` property that you can use to store additional information about your users.
97+
In Clerk, the [`User`](/docs/references/javascript/user) object has a `publicMetadata` property that you can use to store additional information about your users.
9898

9999
To map other claims from your IdP that do not have a direct mapping to Clerk attributes, you can map them to the `publicMetadata` property. To do this, prepend the Clerk claims with `public_metadata_` during the mapping process.
100100

docs/authentication/enterprise-connections/saml/google.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
9696

9797
### Map other claims (optional)
9898

99-
In Clerk, the [`User`](/docs/users/overview#user-object) object has a `publicMetadata` property that you can use to store additional information about your users.
99+
In Clerk, the [`User`](/docs/references/javascript/user) object has a `publicMetadata` property that you can use to store additional information about your users.
100100

101101
To map other claims from Google that don't have a direct mapping to Clerk attributes, you can map them to Clerk's `publicMetadata` property. To do this, prepend the Clerk claims with `public_metadata_` during the mapping process.
102102

docs/backend-requests/resources/session-tokens.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ You can also create custom tokens using a [JWT template](/docs/backend-requests/
4747

4848
The Clerk session token is stored in a cookie. All modern browsers [limit the maximum size of a cookie to 4kb](https://datatracker.ietf.org/doc/html/rfc2109#section-6.3). Exceeding this limit can have adverse effects, including a possible infinite redirect loop for users who exceed this size in Next.js applications.
4949

50-
A session token with the [default session claims](#default-session-claims) won't run into this issue, as this configuration produces a cookie significantly smaller than 4kb. However, this limitation becomes relevant when implementing a [custom session token](/docs/backend-requests/custom-session-token). In this case, it's recommended to move particularly large claims out of the token and fetch these using a separate API call from your backend.
50+
A session token with the [default session claims](#session-claims) won't run into this issue, as this configuration produces a cookie significantly smaller than 4kb. However, this limitation becomes relevant when implementing a [custom session token](/docs/backend-requests/custom-session-token). In this case, it's recommended to move particularly large claims out of the token and fetch these using a separate API call from your backend.
5151

5252
Claims to monitor for size limits:
5353

docs/components/authentication/sign-in.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ All props are optional.
8888
- `transferable`
8989
- `boolean`
9090

91-
Indicates whether or not sign in attempts are transferable to the sign up flow. Defaults to `true`. When set to `false`, prevents opaque sign ups when a user attempts to sign in via OAuth with an email that doesn't exist. See [OAuth account transfer flows](/docs/custom-flows/oauth-connections#o-auth-account-transfer-flows) for more information.
91+
Indicates whether or not sign in attempts are transferable to the sign up flow. Defaults to `true`. When set to `false`, prevents opaque sign ups when a user attempts to sign in via OAuth with an email that doesn't exist.
9292

9393
---
9494

docs/components/organization/organization-profile.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The `<OrganizationProfile />` component allows users to manage their organizatio
99

1010
This component's **General** tab displays the organization's information and the **Leave organization** button. Admins will be able to see the **Update profile** button, **Verified domains** section, and **Delete organization** button.
1111

12-
The **Members** tab shows the organization's members along with their join dates and roles. Admins will have the ability to invite a member, change a member's role, or remove them from the organization. Admins will have tabs within the **Members** tab to view the organization's [invitations](/docs/organizations/overview#organization-invitations) and [requests](/docs/organizations/overview#membership-requests).
12+
The **Members** tab shows the organization's members along with their join dates and roles. Admins will have the ability to invite a member, change a member's role, or remove them from the organization. Admins will have tabs within the **Members** tab to view the organization's [invitations](/docs/organizations/overview#organization-invitations) and [requests](/docs/organizations/verified-domains#membership-requests).
1313

1414
## Properties
1515

docs/custom-flows/email-links.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This guide demonstrates how to use Clerk's API to build a custom flow for handli
4848
1. The `SignUp` object is used to access the [`createEmailLinkFlow()`](/docs/references/javascript/types/email-address#create-email-link-flow) method.
4949
1. The `createEmailLinkFlow()` method is used to access the `startEmailLinkFlow()` method.
5050
1. The `startEmailLinkFlow()` method is called with the `redirectUrl` parameter set to `/sign-up/verify`. It sends an email with a verification link to the user. When the user visits the link, they are redirected to the URL that was provided.
51-
1. On the `/sign-up/verify` page, the [`useClerk()`](/docs/hooks/use-clerk) hook is used to get the [`handleEmailLinkVerification()`](/docs/references/javascript/clerk/handle-navigation#handle-email-link-verification) method.
51+
1. On the `/sign-up/verify` page, the [`useClerk()`](/docs/hooks/use-clerk) hook is used to get the [`handleEmailLinkVerification()`](/docs/references/javascript/clerk#handle-email-link-verification) method.
5252
1. The `handleEmailLinkVerification()` method is called to verify the email address. Error handling is included to handle any errors that occur during the verification process.
5353

5454
<Tabs items={["Next.js"]}>
@@ -277,7 +277,7 @@ This guide demonstrates how to use Clerk's API to build a custom flow for handli
277277
1. The `SignIn` object is used to access the [`createEmailLinkFlow()`](/docs/references/javascript/types/email-address#create-email-link-flow) method.
278278
1. The `createEmailLinkFlow()` method is used to access the `startEmailLinkFlow()` method.
279279
1. The `startEmailLinkFlow()` method is called with the `redirectUrl` parameter set to `/sign-in/verify`. It sends an email with a verification link to the user. When the user visits the link, they are redirected to the URL that was provided.
280-
1. On the `/sign-in/verify` page, the [`useClerk()`](/docs/hooks/use-clerk) hook is used to get the [`handleEmailLinkVerification()`](/docs/references/javascript/clerk/handle-navigation#handle-email-link-verification) method.
280+
1. On the `/sign-in/verify` page, the [`useClerk()`](/docs/hooks/use-clerk) hook is used to get the [`handleEmailLinkVerification()`](/docs/references/javascript/clerk#handle-email-link-verification) method.
281281
1. The `handleEmailLinkVerification()` method is called to verify the email address. Error handling is included to handle any errors that occur during the verification process.
282282

283283
<Tabs items={["Next.js"]}>

docs/custom-flows/error-handling.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ The following example uses the [email & password sign-in custom flow](/docs/cust
200200

201201
### User locked
202202

203-
If you have [account lockout](/docs/security/user-lock-guide) enabled on your instance and the user reaches the maximum allowed attempts ([see list of relevant actions here](/docs/security/user-lock-guide#related-actions)), you will receive an HTTP status of `403 (Forbidden)` and the following error payload:
203+
If you have [account lockout](/docs/security/user-lock-guide) enabled on your instance and the user reaches the maximum allowed attempts ([see list of relevant actions here](/docs/security/user-lock-guide#actions)), you will receive an HTTP status of `403 (Forbidden)` and the following error payload:
204204

205205
```json
206206
{

docs/custom-flows/manage-membership-requests.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to use the Clerk API to build a custom flow for managing
55

66
<Include src="_partials/custom-flows-callout" />
77

8-
This guide will demonstrate how to use the Clerk API to build a custom flow for managing [organization membership requests](/docs/organizations/overview#membership-requests).
8+
This guide will demonstrate how to use the Clerk API to build a custom flow for managing [organization membership requests](/docs/organizations/verified-domains#membership-requests).
99

1010
<Tabs items={["Next.js", "JavaScript"]}>
1111
<Tab>

docs/custom-flows/oauth-connections.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ You must configure your application instance through the Clerk Dashboard for the
7575
The following example:
7676

7777
1. Uses the [`useSSO()`](/docs/references/expo/use-sso) hook to access the `startSSOFlow()` method.
78-
1. Calls the `startSSOFlow()` method with the `strategy` param set to `oauth_google`, but you can use any of the [supported OAuth strategies](/docs/references/javascript/types/sso#oauth-strategy). The optional `redirect_url` param is also set in order to redirect the user once they finish the authentication flow.
78+
1. Calls the `startSSOFlow()` method with the `strategy` param set to `oauth_google`, but you can use any of the [supported OAuth strategies](/docs/references/javascript/types/sso#o-auth-strategy). The optional `redirect_url` param is also set in order to redirect the user once they finish the authentication flow.
7979
- If authentication is successful, the `setActive()` method is called to set the active session with the new `createdSessionId`.
8080
- If authentication is not successful, you can handle the missing requirements, such as MFA, using the [`signIn`](/docs/references/javascript/sign-in) or [`signUp`](/docs/references/javascript/sign-up) object returned from `startSSOFlow()`, depending on if the user is signing in or signing up. These objects include properties, like `status`, that can be used to determine the next steps. See the respective linked references for more information.
8181

docs/custom-flows/overview.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@ Sign-ins are initiated by creating a `SignIn` object on the current `Client`. If
8080
The following steps outline the sign-in process:
8181

8282
1. Initiate the sign-in process by collecting the user's authentication information and passing the appropriate parameters to the [`create()`](/docs/references/javascript/sign-in#create) method.
83-
1. Prepare the [first factor verification](/docs/references/javascript/sign-in#first-factor). Users must complete a first factor verification to prove their identity. This can be something like providing a password, an email link, a one-time code (OTP), a Web3 wallet address, or providing proof of their identity through an external social account (SSO/OAuth).
83+
1. Prepare the first factor verification. Users must complete a first factor verification to prove their identity. This can be something like providing a password, an email link, a one-time code (OTP), a Web3 wallet address, or providing proof of their identity through an external social account (SSO/OAuth).
8484
1. Attempt to complete the first factor verification.
85-
1. Optionally, if you have enabled [multi-factor](/docs/authentication/configuration/sign-up-sign-in-options) for your application, you will need to prepare the [second factor verification](/docs/references/javascript/sign-in#second-factor) for users who have set up 2FA for their account.
85+
1. Optionally, if you have enabled [multi-factor](/docs/authentication/configuration/sign-up-sign-in-options) for your application, you will need to prepare the second factor verification for users who have set up 2FA for their account.
8686
1. Attempt to complete the second factor verification.
8787
1. If verification is successful, set the newly created session as the active session by passing the `SignIn.createdSessionId` to the [`setActive()`](/docs/references/javascript/clerk#set-active) method on the `Clerk` object.
8888

0 commit comments

Comments
 (0)