Upgrading @clerk/chrome-extension to Core 2
Core 2 is included in the Chrome Extension SDK starting with version 1. This new version ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
By the end of this guide, you’ll have successfully upgraded your project to use @clerk/chrome-extension v1. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations. Step-by-step instructions will lead you through the process.
Preparing to upgrade
Before upgrading, it's highly recommended that you update your Clerk SDKs to the latest Core 1 version (npm i @clerk/chrome-extension@0). Some changes required for Core 2 SDKs can be applied incrementally to the v1 release, which should contribute to a smoother upgrading experience. After updating, look out for deprecation messages in your terminal and browser console. By resolving these deprecations you'll be able to skip many breaking changes from Core 2.
Additionally, some of the minimum version requirements for some base dependencies have been updated such that versions that are no longer supported or are at end-of-life are no longer guaranteed to work correctly with Clerk.
Updating Node.js
You need to have Node.js 18.17.0 or later installed. Last year, Node.js 16 entered EOL (End of life) status, so support for this version has been removed across Clerk SDKs. You can check your Node.js version by running node -v in your terminal. Learn more about how to update and install Node.js.
Updating React
All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of react and react-dom.
npm install react@latest react-dom@latestyarn add react@latest react-dom@latestpnpm add react@latest react-dom@latestIf you are upgrading from React 17 or lower, make sure to learn about how to upgrade your React version to 18 as well.
Updating to Core 2
Whenever you feel ready, go ahead and install the latest version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. The commands below demonstrate how to install the latest version.
npm install @clerk/chrome-extensionyarn add @clerk/chrome-extensionpnpm add @clerk/chrome-extensionCLI upgrade helper
Clerk now provides a @clerk/upgrade CLI tool that you can use to ease the upgrade process. The tool will scan your codebase and produce a list of changes you'll need to apply to your project. It should catch the vast majority of the changes needed for a successful upgrade to any SDK including Core 2. This can save you a lot of time reading through changes that don't apply to your project.
To run the CLI tool, navigate to your project and run it in the terminal:
npx @clerk/upgradeyarn dlx @clerk/upgradepnpm dlx @clerk/upgradeIf you are having trouble with npx, it's also possible to install directly with npm i @clerk/upgrade -g, and can then be run with the clerk-upgrade command.
Breaking Changes
tokenCache -> storageCache as <ClerkProvider> props
The tokenCache prop has been renamed to storageCache in order to accommodate the new WebSSO feature. With the prop change from tokenCache to storageCache, the interface has been expanded to allow for more flexibility. The new interface is as follows:
type StorageCache = {
createKey: (...keys: string[]) => string
get: <T = any>(key: string) => Promise<T>
remove: (key: string) => Promise<void>
set: (key: string, value: string) => Promise<void>
}And here's a full before/after example:
<ClerkProvider tokenCache={/* ... */}>
<ClerkProvider storageCache={/* ... */}>Component design adjustments
The new version ships with improved design and UX across all of Clerk's UI components. If you have used the appearance prop or tokens for a custom theme, you will likely need to make some adjustments to ensure your styling is still looking great. If you're using the localization prop you will likely need to make adjustments to account for added or removed localization keys.
More detail on these changes »
After sign up/in/out default value change
Defining redirect URLs for after sign up, in, and/or out via the Clerk dashboard has been removed in Core 2. In your Clerk dashboard, under "paths", there is a section called "Component paths", where URLs could be defined that had a deprecation warning. In Core 2, this functionality has been removed, and specifying redirect paths via the dashboard will no longer work. If you need to pass a redirect URL for after sign in/up/out, there are a few different ways this can be done, from environment variables to middleware to supplying them directly to the relevant components.
As part of this change, the default URL for each of these props has been set to /, so if you are passing / explicitly to any one of the above props, that line is no longer necessary and can be removed.
<UserButton afterSignOutUrl="/" />
<UserButton />Removed: orgs claim on JWT
In the previous version of Clerk's SDKs, if you decode the session token that Clerk returns from the server, you'll currently find an orgs claim on it. It lists all the orgs associated with the given user. Now, Clerk returns the org_id, org_slug, and org_role of the active organization.
The orgs claim was part of the JwtPayload. Here are a few examples of where the JwtPayload could be found.
Next.js
import { getAuth } from '@clerk/nextjs/server'
const claims: JwtPayload = getAuth(request).sessionClaims
import { getAuth } from '@clerk/ssr.server'
const claims: JwtPayload = (await getAuth(request)).sessionClaimsFastify
import { getAuth } from '@clerk/fastify'
const claims: JwtPayload = (await getAuth(request)).sessionClaims@clerk/backend
import { createClerkClient } from '@clerk/backend'
const clerkClient = createClerkClient({ secretKey: '' })
const requestState = await clerkClient.authenticateRequest(request, { publishableKey: '' })
const claims: JwtPayload = requestState.toAuth().sessionClaims@clerk/clerk-sdk-node
import { clerkClient } from '@clerk/clerk-sdk-node'
router.use((...args) => clerkClient.expressRequireAuth()(...args))
router.get('/me', async (req, reply: Response) => {
return reply.json({ auth: req.auth })
})If you would like to have your JWT return all of the user's organizations, you can create a custom JWT template in your dashboard. Add { "orgs": "user.organizations" } to it.
Path routing is now the default
On components like <SignIn /> you can define the props routing and path. routing can be set to 'hash' | 'path' | 'virtual' and describes the routing strategy that should be used. path defines where the component is mounted when routing="path" is used. Learn more about Clerk routing.
In Core 2, the default routing strategy has become 'path'. Unless you change the routing prop, you'll need to define the path prop. The affected components are:
<SignIn /><SignUp /><UserProfile /><CreateOrganization /><OrganizationProfile />
Here's how you'd use the components going forward:
<SignIn path="/sign-in" />
<SignUp path="/sign-up" />
<UserProfile path="/user-profile" />
<CreateOrganization path="/create-org" />
<OrganizationProfile path="/org-profile" />If you don't define the path prop an error will be thrown. Of course, you can still use routing="hash" or routing="virtual".
<UserProfile routing="hash" />
<OrganizationProfile routing="virtual" />Image URL Name Consolidation
There are a number of Clerk primitives that contain images, and previously they each had different property names, like avatarUrl, logoUrl, profileImageUrl, etc. In order to promote consistency and make it simpler for developers to know where to find associated images, all image properties are now named imageUrl. See the list below for all affected classes:
Organization.logoUrl -> Organization.imageUrl
Organization.logoUrl -> Organization.imageUrlThe logoUrl property of any Organization object has been changed to imageUrl.
User.profileImageUrl -> .imageUrl
User.profileImageUrl -> .imageUrlThe profileImageUrl property of any User object has been changed to imageUrl.
Deprecation removals & housekeeping
As part of this major version, a number of previously deprecated props, arguments, methods, etc. have been removed. Additionally there have been some changes to things that are only used internally, or only used very rarely. It's highly unlikely that any given app will encounter any of these items, but they are all breaking changes, so they have all been documented below.
User.update({ password: 'x' }) -> User.updatePassword('x')
User.update({ password: 'x' }) -> User.updatePassword('x')If you are updating a user's password via the User.update method, it must be changed to User.updatePassword instead. This method will require the current password as well as the desired new password. We made this update to improve the security of password changes. Example below:
user.update({ password: 'foo' })
user.updatePassword({
currentPassword: 'bar',
newPassword: 'foo',
signOutOfOtherSessions: true,
})Organization.getRoles arguments changed
Organization.getRoles arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await organization.getRoles({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})Organization.getMemberships arguments changed
Organization.getMemberships arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await organization.getMemberships({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})Organization.getDomains arguments changed
Organization.getDomains arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await organization.getDomains({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})Organization.getInvitations arguments changed
Organization.getInvitations arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await organization.getInvitations({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})Organization.getMembershipRequests arguments changed
Organization.getMembershipRequests arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await organization.getMembershipRequests({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})User.getOrganizationInvitations arguments changed
User.getOrganizationInvitations arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await user.getOrganizationInvitations({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})User.getOrganizationSuggestions arguments changed
User.getOrganizationSuggestions arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await user.getOrganizationSuggestions({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})User.getOrganizationMemberships arguments changed
User.getOrganizationMemberships arguments changedThere have been a couple changes to the pagination arguments that can be passed into this function - limit has been renamed to pageSize, and offset has been renamed to initialPage. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
const { data } = await user.getOrganizationMemberships({
limit: 10,
pageSize: 10,
offset: 10,
initialPage: 2,
})Users.getOrganizationMembershipList return signature changed
Users.getOrganizationMembershipList return signature changedThe response payload of Users.getOrganizationMembershipList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.users.getOrganizationMembershipList()
const { data, totalCount } = await clerkClient.users.getOrganizationMembershipList()Users.getOrganizationInvitationList return signature changed
Users.getOrganizationInvitationList return signature changedThe response payload of Users.getOrganizationInvitationList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.users.getOrganizationInvitationList()
const { data, totalCount } = await clerkClient.users.getOrganizationInvitationList()Organizations.getOrganizationInvitationList return type changed
Organizations.getOrganizationInvitationList return type changedThe return type for this function was previously [Items] but has now been updated to { data: [Items], totalCount: number }. Since Clerk's API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:
const data = await clerkClient.organizations.getOrganizationInvitationList({
organizationId: '...',
})
data.forEach(() => {})
data.data.forEach(() => {})User.getOrganizationMembershipList return type changed
User.getOrganizationMembershipList return type changedThe return type for this function was previously [Items] but has now been updated to { data: [Items], totalCount: number }. Since Clerk's API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:
const { user } = useUser()
const membershipList = user.getOrganizationMembershipList()
membershipList.forEach(() => {})
membershipList.data.forEach(() => {})Users.getOrganizationList return signature changed
Users.getOrganizationList return signature changedThe response payload of Users.getOrganizationList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.users.getOrganizationList()
const { data, totalCount } = await clerkClient.users.getOrganizationList()Organization.getOrganizationList return type changed
Organization.getOrganizationList return type changedThe return type for this function was previously [Items] but has now been updated to { data: [Items], totalCount: number }. Since Clerk's API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:
const { organization } = useOrganization()
const orgList = organization.getOrganizationList()
orgList.forEach(() => {})
orgList.data.forEach(() => {})Invitations.getInvitationList return signature changed
Invitations.getInvitationList return signature changedThe response payload of Invitations.getInvitationList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.invitations.getInvitationList()
const { data, totalCount } = await clerkClient.invitations.getInvitationList()Sessions.getSessionList return signature changed
Sessions.getSessionList return signature changedThe response payload of Sessions.getSessionList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.sessions.getSessionList()
const { data, totalCount } = await clerkClient.sessions.getSessionList()Users.getUserList return signature changed
Users.getUserList return signature changedThe response payload of Users.getUserList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.users.getUserList()
const { data, totalCount } = await clerkClient.users.getUserList()AllowlistIdentifiers.getAllowlistIdentifierList return signature changed
AllowlistIdentifiers.getAllowlistIdentifierList return signature changedThe response payload of AllowlistIdentifiers.getAllowlistIdentifierList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.allowlistIdentifiers.getAllowlistIdentifierList()
const { data, totalCount } = await clerkClient.allowlistIdentifiers.getAllowlistIdentifierList()Clients.getClientList return signature changed
Clients.getClientList return signature changedThe response payload of Clients.getClientList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.clients.getClientList()
const { data, totalCount } = await clerkClient.allowlistIdentifiers.getClientList()RedirectUrls.getRedirectUrlList return signature changed
RedirectUrls.getRedirectUrlList return signature changedThe response payload of RedirectUrls.getRedirectUrlList was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.redirectUrls.getRedirectUrlList()
const { data, totalCount } = await clerkClient.redirectUrls.getRedirectUrlList()Users.getUserOauthAccessToken return signature changed
Users.getUserOauthAccessToken return signature changedThe response payload of Users.getUserOauthAccessToken was changed as part of the core 2 release. Rather than directly returning data, the return signature is now { data, totalCount }. Since backend API responses are paginated, the totalCount property is helpful in determining the total number of items in the response easily, and this change in the backend SDK aligns the response shape with what the backend API returns directly.
Here's an example of how the response shape would change with this modification:
const data = await clerkClient.users.getUserOauthAccessToken()
const { data, totalCount } = await clerkClient.users.getUserOauthAccessToken()setSession -> setActive
setSession -> setActivesetSession should be replaced with setActive. The format of the parameters has changed slightly - setActive takes an object where setSession took params directly. The setActive function also can accept an organization param that is used to set the currently active organization. The return signature did not change. Read the API documentation for more detail. This function should be expected to be returned from one of the following Clerk hooks: useSessionList, useSignUp, or useSignIn. Some migration examples:
await setSession('sessionID', () => void)
await setActive({ session: 'sessionID', beforeEmit: () => void })
await setSession(sessionObj)
await setActive({ session: sessionObj })
await setSession(sessionObj, () => void)
await setActive({ session: sessionObj, beforeEmit: () => void })setActive also supports setting an active organization:
await setActive({
session: 'sessionID',
organization: 'orgID',
beforeEmit: () => void,
})
await setActive({
session: sessionObj,
organization: orgObj,
beforeEmit: () => void,
})Organization.create('x') -> Organization.create({ name: 'x' })
Organization.create('x') -> Organization.create({ name: 'x' })Passing a string as an argument to Organization.create is no longer possible - instead, pass an object with the name property.
Organization.create('...')
Organization.create({ name: '...' })Organization.getPendingInvitations() -> Organization.getInvitations({ status: 'pending' })
Organization.getPendingInvitations() -> Organization.getInvitations({ status: 'pending' })The Organization.getPendingInvitations() method has been removed. You can use Organization.getInvitations instead.
Organization.getPendingInvitations()
Organization.getInvitations({ status: 'pending' })Feedback
Last updated on