@clerk/upgrade 0.2.1 → 0.4.0

package/dist/versions/{v5 → core-2}/common/withsession-hof-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`withSession` function removed'
 matcher: "import\\s+{[\\s\\S]*?withSession[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
@@ -8,22 +9,22 @@ The `withSession` higher order function has been removed. If you would still lik
 
 ```js
 function withSession(Component, displayName) {
-	displayName = displayName || Component.displayName || Component.name || 'Component';
-	Component.displayName = displayName;
-	const HOC = props => {
-		const session = useSessionContext();
+  displayName = displayName || Component.displayName || Component.name || 'Component';
+  Component.displayName = displayName;
+  const HOC = props => {
+    const session = useSessionContext();
 
-		if (!session) return null;
+    if (!session) return null;
 
-		return (
-			<Component
-				{...props}
-				session={session}
-			/>
-		);
-	};
+    return (
+      <Component
+        {...props}
+        session={session}
+      />
+    );
+  };
 
-	HOC.displayName = `withSession(${displayName})`;
-	return HOC;
+  HOC.displayName = `withSession(${displayName})`;
+  return HOC;
 }
 ```

package/dist/versions/{v5 → core-2}/common/withsession-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`WithSession` component removed'
 matcher: "import\\s+{[\\s\\S]*?WithSession[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5 → core-2}/common/withuser-hof-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`withUser` function removed'
 matcher: "import\\s+{[\\s\\S]*?withUser[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
@@ -8,22 +9,22 @@ The `withUser` higher order function has been removed. If you would still like t
 
 ```js
 function withUser(Component, displayName) {
-	displayName = displayName || Component.displayName || Component.name || 'Component';
-	Component.displayName = displayName;
-	const HOC = props => {
-		const clerk = useUserContext();
+  displayName = displayName || Component.displayName || Component.name || 'Component';
+  Component.displayName = displayName;
+  const HOC = props => {
+    const clerk = useUserContext();
 
-		if (!user) return null;
+    if (!user) return null;
 
-		return (
-			<Component
-				{...props}
-				user={user}
-			/>
-		);
-	};
+    return (
+      <Component
+        {...props}
+        user={user}
+      />
+    );
+  };
 
-	HOC.displayName = `withUser(${displayName})`;
-	return HOC;
+  HOC.displayName = `withUser(${displayName})`;
+  return HOC;
 }
 ```

package/dist/versions/{v5 → core-2}/common/withuser-removed-2.md

@@ -1,11 +1,10 @@
 ---
 title: '`WithUser` component removed'
 matcher: "import\\s+{[\\s\\S]*?withUser[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+category: 'hof-removal'
 matcherFlags: 'm'
 ---
 
-<!-- why is this called withuser-removed-2 you may ask? if you remove the "-2", it doesn't load, depsite identical content. Truly, this is baffling -->
-
 The `WithUser` higher order component has been removed. If you would still like to use this function in the way its implemented, it can be created quickly using Clerk's [custom hooks](https://clerk.com/docs/references/react/overview). An example of how to do so is below:
 
 ```js

package/dist/versions/{v5 → core-2}/expo/apikey-to-publishable-key.md

@@ -1,5 +1,6 @@
 ---
 title: '`CLERK_FRONTEND_API` replaced by `CLERK_PUBLISHABLE_KEY`'
+category: 'deprecation-removal'
 matcher: 'CLERK_FRONTEND_API'
 ---
 

package/dist/versions/{v5 → core-2}/expo/clerkprovider-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as prop to `ClerkProvider`'
 matcher: "<ClerkProvider[\\s\\S]*?frontendApi=[\\s\\S]*?>"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5 → core-2}/fastify/clerkplugin-frontendapi.md

@@ -1,7 +1,8 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to clerkPlugin'
-matcher: "fastify\\.register\\(clerkPlugin,.*?{.*?frontendApi:.*?}\\)"
+matcher: "fastify\\.register\\(clerkPlugin,[\\s\\S]*?{[\\s\\S]*?frontendApi:[\\s\\S]*?}\\)"
 matcherFlags: 'm'
+category: 'deprecation-removal'
 ---
 
 The `frontendApi` argument passed to `clerkPlugin` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.

package/dist/versions/{v5 → core-2}/fastify/createclerkclient-apikey.md

@@ -2,6 +2,7 @@
 title: '`apiKey` -> `secretKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
 matcherFlags: 'm'
+category: 'deprecation-removal'
 ---
 
 The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`.

package/dist/versions/{v5 → core-2}/fastify/createclerkclient-frontendapi.md

@@ -2,6 +2,7 @@
 title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
 matcherFlags: 'm'
+category: 'deprecation-removal'
 ---
 
 The `frontendApi` argument passed to `createClerkClient` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.

package/dist/versions/core-2/gatsby/api-url-value-change.md

@@ -0,0 +1,8 @@
+---
+title: '`API_URL` value has changed'
+matcher: "import\\s+{[\\s\\S]*?[,\\s]API_URL[,\\s][\\s\\S]*?from\\s+['\"]gatsby-plugin-clerk\\/constants[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+warning: true
+---
+
+The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.

package/dist/versions/{v5 → core-2}/gatsby/apikey-to-publishable-key.md

@@ -1,5 +1,6 @@
 ---
 title: '`GASTBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
+category: 'deprecation-removal'
 matcher: 'GATSBY_CLERK_FRONTEND_API'
 ---
 

package/dist/versions/{v5 → core-2}/gatsby/createclerkclient-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5 → core-2}/gatsby/createclerkclient-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/core-2/gatsby/withserverauth-return-type.md

@@ -0,0 +1,35 @@
+---
+title: '`withServerAuth` props.auth return type changed'
+matcher: "withServerAuth\\("
+---
+
+When utilizing the `withServerAuth` helper in Gatsby, it expects a callback function that is called with props from Clerk internals. The `.auth` property on the returned object from the callback has seen a substantial change in its return type. Below is a code example of where the `auth` prop might be found:
+
+```js
+import { withServerAuth } from 'gatsby-plugin-clerk/ssr';
+
+export const getServerData: GetServerData<any> = withServerAuth(async props => {
+  return { props: { data: '...', auth: props.auth } };
+});
+```
+
+And here's a diff of the changes in the return type. The breaking change here specifically is that the property `auth.claims` was changed to `auth.sessionClaims`. Additionally, there is more information on the response that can be utilized if helpful.
+
+```diff
+ // return type diff
+ {
+   sessionId: string | null;
+   userId: string | null;
+   actor: ActJWTClaim | null;
+   getToken: ServerGetToken;
+-  claims: ClerkJWTClaims | null;
++  sessionClaims: JwtPayload;
++  session: Session | undefined | null;
++  user: User | undefined | null;
++  orgId: string | undefined | null;
++  orgRole: string | undefined | null;
++  orgSlug: string | undefined | null;
++  organization: Organization | undefined | null;
++  debug: AuthObjectDebug;
+ };
+```

package/dist/versions/core-2/index.js

@@ -0,0 +1,34 @@
+import createLoader from '../../util/load-change.js';
+const load = createLoader({
+  version: 'core-2',
+  baseUrl: 'https://clerk.com/docs/upgrade-guides/core-2'
+});
+const changesAffectingAll = ['organization-getroles-arguments-changed', 'organization-getmemberships-arguments-changed', 'organization-getdomains-arguments-change', 'organization-getinvitations-arguments-changed', 'organization-getmembershiprequests-arguments-changed', 'user-getorganizationinvitations-arguments-changed', 'user-getorganizationsuggestions-arguments-changed', 'user-getorganizationmemberships-arguments-changed', 'getorganizationinvitationlist-return-signature', 'getorganizationinvitationlist-return-type-change', 'getorganizationmembershiplist-return-type-change', 'getorganizationlist-return-signature', 'getorganizationlist-return-type-change', 'organization-logourl', 'user-profileimageurl', 'user-update-password'];
+const jsChanges = ['setsession', 'organization-create-string', 'organization-getpendinginvitations', 'mfa-dropdown', 'appearance-variables-breaking-changes'];
+const reactChanges = ['magiclinkerrorcode', 'usemagiclink', 'ismagiclinkerror', 'magiclinkerror', 'handlemagiclinkverification', 'clerkprovider-frontendapi-2', 'navigate-to-routerpush-routerreplace', 'afterswitchorganizationurl', 'appearance-organizationpreview-organizationswitcher', 'useorganization-invitationlist', 'useorganization-membershiplist', 'useorganizations', 'userprofile-prop', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'withsession-removed', 'withclerk-removed', 'withuser-removed-2', 'withclerk-hof-removed', 'withsession-hof-removed', 'withuser-hof-removed', 'multisessionappsupport-import-change', 'clerkprovideroptionswrapper-dropped', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'min-react-version', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'];
+export default {
+  nextjs: load('nextjs', dedupeMerge(changesAffectingAll, jsChanges, ['api-key-to-secret-key', 'frontend-api-to-publishable-key', 'with-clerk-middleware-removed', 'auth-middleware-deprecated', 'clerk-js-version-next-public', 'authmiddleware-apikey', 'authmiddleware-frontendapi', 'createclerkclient-apikey', 'createclerkclient-frontendapi', 'getauth-apikey', 'clerkprovider-frontendapi-2', 'import-nextjs-app-beta', 'import-nextjs-ssr', 'import-nextjs-edge-middleware', 'import-nextjs-edge-middlewarefiles', 'import-api-url', 'import-api-version', 'import-clerk-js-url', 'import-clerk-js-version', 'import-domain', 'import-is-satellite', 'import-proxy-url', 'import-publishable-key', 'import-secret-key', 'import-sign-in-url', 'import-sign-up-url', 'import-nextjs-api', 'api-url-value-change', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'multisessionappsupport-import-change', 'auth-import-change', 'currentuser-import-change', 'authmiddleware-import-change', 'buildclerkprops-import-change', 'verifytoken-import-change', 'verifyjwt-import-change', 'decodejwt-import-change', 'signjwt-import-change', 'constants-import-change', 'createauthenticaterequest-import-change', 'createisomorphicrequest-import-change', 'clerk-import-change', 'isclerkapiresponserror-import-change', 'isemaillinkerror-import-change', 'isknownerror-import-change', 'ismetamaskerror-import-change', 'withsession-removed', 'withclerk-removed', 'withuser-removed-2', 'withclerk-hof-removed', 'withsession-hof-removed', 'withuser-hof-removed', 'next-public-clerk-js-url', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'min-nextjs-version', 'redirecttosignin-import-path', 'redirecttosignup-import-path', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
+  // since we export clerk-react at the top level from the gatsby plugin
+  // if you're using gatsby, we also need to scan for the react changes
+  gatsby: load('gatsby', dedupeMerge(changesAffectingAll, reactChanges, jsChanges, ['api-key-to-secret-key', 'createclerkclient-apikey', 'apikey-to-publishable-key', 'createclerkclient-frontendapi', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'api-url-value-change', 'withserverauth-return-type', 'clerk-import-change'])),
+  remix: load('remix', dedupeMerge(changesAffectingAll, jsChanges, ['clerkerrorboundary-removed', 'createclerkclient-apikey', 'rootauthloader-apikey', 'getauth-apikey', 'clerkprovider-frontendapi-2', 'rootauthloader-frontendapi', 'frontend-api-to-publishable-key', 'api-key-to-secret-key', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'clerk-import-change', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
+  expo: load('expo', dedupeMerge(changesAffectingAll, jsChanges, ['apikey-to-publishable-key', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
+  fastify: load('fastify', dedupeMerge(changesAffectingAll, ['api-key-to-secret-key', 'api-url-value-change', 'frontend-api-to-publishable-key', 'createclerkclient-apikey', 'createclerkclient-frontendapi', 'clerkplugin-frontendapi', 'clerk-import-change', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
+  node: load('node', dedupeMerge(changesAffectingAll, ['api-key-to-secret-key', 'api-url-value-change', 'frontend-api-to-publishable-key', 'clerkexpressrequireauth-apikey', 'clerkexpresswithauth-apikey', 'createclerkclient-apikey', 'createclerkexpressrequireauth-apikey', 'createclerkexpresswithauth-apikey', 'createclerkclient-frontendapi', 'createclerkexpressrequireauth-frontendapi', 'clerkexpressrequireauth-frontendapi', 'createclerkexpresswithauth-frontendapi', 'clerkexpresswithauth-frontendapi', 'setclerkapikey', 'setclerkapiversion', 'setclerkhttpoptions', 'setclerkserverapiurl', 'cjs-esm-instance', 'legacyauthobject-removed', 'clerk-import-change', 'organizationmembershippublicuserdata-profileimageurl', 'externalaccount-picture'])),
+  react: load('react', dedupeMerge(changesAffectingAll, reactChanges, jsChanges)),
+  js: load('js', dedupeMerge(changesAffectingAll, jsChanges, ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'handlemagiclinkverification', 'user-orgpublicdata-profileimageurl', 'experimental-canusecaptcha', 'experimental-captchaurl', 'experimental-captchasitekey', 'getorganizationmemberships', 'lastorganizationinvitation-member', 'unstable-invitationupdate', 'unstable-membershipupdate', 'user-createexternalaccount-redirecturl',
+  // maybe shared with all?
+  'signup-attemptweb3walletverification-generatedsignature', 'redirecttohome', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'clerk-isready-removed', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
+  shared: load('shared', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'getrequesturl', 'organizationcontext', 'useorganizationlist-organizationlist' // shared outside this pkg?
+  ]),
+
+  'chrome-extension': load('chrome-extension', dedupeMerge(changesAffectingAll, jsChanges, ['clerkprovider-tokencache'])),
+  localizations: load('localization', ['new-localization-keys', 'removed-localization-keys', 'changed-localization-keys']),
+  backend: load('backend', dedupeMerge(changesAffectingAll, ['api-url-value-changed', 'verifyjwt-import-path-move', 'decodejwt-import-path-move', 'signjwt-import-path-move', 'constants-import-path-move', 'redirect-import-path-move', 'createauthenticaterequest-import-path-move', 'createisomorphicrequest-import-path-move', 'createclerkclient-frontendapi', 'authenticaterequest-params-change', 'clerk-import', 'externalaccount-picture', 'externalaccountjson-avatarurl', 'organizationjson-logourl', 'userjson-profileimageurl', 'organizationmembershippublicuserdata-profileimageurl', 'organizationmembershippublicuserdatajson-profileimageurl', 'clockskewinseconds', 'pkgversion', 'client-unstableoptions-removed', 'httpoptions-removed', 'createisomorphicrequest-removed', 'createemail-removed', 'signjwterror-import-move', 'tokenverificationerror-import-move', 'tokenverificationerroraction-import-move', 'tokenverificationerrorreason-import-move', 'membershiprole', 'getorganizationmembershiplist-return-signature', 'buildrequesturl-removed', 'createclerkclient-apikey'])),
+  types: [],
+  redwood: [],
+  express: []
+};
+function dedupeMerge(...arrays) {
+  return [...new Set(arrays.flat())];
+}

package/dist/versions/{v5 → core-2}/js/experimental-canusecaptcha.md

@@ -1,5 +1,6 @@
 ---
 title: '`Clerk.experimental_canUseCaptcha` property removed'
+category: 'deprecation-removal'
 matcher: 'experimental_canUseCaptcha'
 ---
 

package/dist/versions/{v5 → core-2}/js/experimental-captchasitekey.md

@@ -1,5 +1,6 @@
 ---
 title: '`Clerk.experimental_captchaSiteKey` property removed'
+category: 'deprecation-removal'
 matcher: 'experimental_captchaSiteKey'
 ---
 

package/dist/versions/{v5 → core-2}/js/experimental-captchaurl.md

@@ -1,5 +1,6 @@
 ---
 title: '`Clerk.experimental_captchaURL` property removed'
+category: 'deprecation-removal'
 matcher: 'experimental_captchaURL'
 ---
 

package/dist/versions/{v5 → core-2}/js/getorganizationmemberships.md

@@ -5,10 +5,7 @@ matcher: "Clerk.getOrganizationMemberships\\("
 
 The `getOrganizationMemberships` [method on the `Clerk` class](https://clerk.com/docs/references/javascript/clerk/clerk#organization) has been removed. Instead, use `getOrganizationMemberships` on a user instance.
 
-```js
-// before
-Clerk.getOrganizationMemberships();
-
-// after
-user.getOrganizationMemberships();
+```diff
+- Clerk.getOrganizationMemberships();
++ user.getOrganizationMemberships();
 ```

package/dist/versions/core-2/js/redirecttohome.md

@@ -0,0 +1,13 @@
+---
+title: '`Clerk.redirectToHome()` removed'
+matcher: "Clerk.redirectToHome\\("
+---
+
+The `Clerk.redirectToHome` method has been removed. If you are looking for a generic replacement for this method, you can instead use `window.Clerk.redirectToAfterSignUp()` or `window.Clerk.redirectAfterSignIn()`.
+
+To set the `afterSignUpUrl` or `afterSignInUrl`, you can:
+
+- If not using a react-based SDK, pass the values into `Clerk.load` as such: `Clerk.load({ afterSignUpUrl: 'x', afterSignInUrl: 'y' })`
+- If using a react-based SDK, [pass the desired values into ClerkProvider](https://clerk.com/docs/components/clerk-provider#properties)
+- If using the Next.js SDK, set with `NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL` or `NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL`
+- If using remix SDK, set with `CLERK_AFTER_SIGN_IN_URL` or `CLERK_AFTER_SIGN_UP_URL`

package/dist/versions/{v5 → core-2}/js/signup-attemptweb3walletverification-generatedsignature.md

@@ -1,6 +1,7 @@
 ---
-title: '`generatedSignature` -> `signature` as param of Signup.attemptWeb3WalletVerification()'
+title: '`generatedSignature` -> `signature` as param of `Signup.attemptWeb3WalletVerification`'
 matcher: "attemptWeb3WalletVerification\\([\\s\\S]*?generatedSignature:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 
@@ -9,7 +10,7 @@ The `generatedSignature` param to [`Signup.attemptWeb3WalletVerification()`](htt
 ```js
 // before
 s.attemptWeb3WalletVerification({
-	generatedSignature: async () => 'signatureString',
+  generatedSignature: async () => 'signatureString',
 });
 
 // after

package/dist/versions/{v5 → core-2}/js/unstable-invitationupdate.md

@@ -1,5 +1,6 @@
 ---
 title: '`Clerk.__unstable__invitationUpdate` removed'
+category: 'deprecation-removal'
 matcher: '__unstable__invitationUpdate'
 ---
 

package/dist/versions/{v5 → core-2}/js/unstable-membershipupdate.md

@@ -1,5 +1,6 @@
 ---
 title: '`Clerk.__unstable__membershipUpdate` removed'
+category: 'deprecation-removal'
 matcher: '__unstable__membershipUpdate'
 ---
 

package/dist/versions/{v5 → core-2}/js/user-createexternalaccount-redirecturl.md

@@ -1,6 +1,7 @@
 ---
 title: '`redirect_url` -> `redirectUrl` as param of `User.createExternalAccount`'
 matcher: "createExternalAccount\\(\\s*{[\\s\\S]*?(redirect_url):[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 replaceWithString: 'redirectUrl'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/auth-import-change.md

@@ -2,6 +2,7 @@
 title: '`auth` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?[,\\s]auth[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/auth-middleware-deprecated.md

@@ -1,6 +1,7 @@
 ---
 title: '`authMiddleware` deprecated'
 matcher: "import\\s+{[\\s\\S]*?authMiddleware[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+category: 'middleware'
 matcherFlags: 'm'
 warning: true
 ---
@@ -17,11 +18,11 @@ For more documentation on the new `clerkMiddleware` function, check out [our off
 import { authMiddleware } from '@clerk/nextjs';
 
 export default authMiddleware({
-	publicRoutes: req => !req.url.includes('/dashboard'),
+  publicRoutes: req => !req.url.includes('/dashboard'),
 });
 
 export const config = {
-	matcher: ['/((?!.+\\.[\\w]+$|_next)._)', '/', '/(api|trpc)(._)'],
+  matcher: ['/((?!.+\\.[\\w]+$|_next)._)', '/', '/(api|trpc)(._)'],
 };
 ```
 
@@ -36,14 +37,14 @@ import { NextResponse } from 'next/server';
 const isProtectedRoute = createRouteMatcher(['/dashboard(.*)']);
 
 export default clerkMiddleware((auth, request) => {
-	if (isProtectedRoute(request)) {
-		auth().protect();
-	}
+  if (isProtectedRoute(request)) {
+    auth().protect();
+  }
 
-	return NextResponse.next();
+  return NextResponse.next();
 });
 
 export const config = {
-	matcher: ['/((?!.+\\.[\\w]+$|_next)._)', '/', '/(api|trpc)(._)'],
+  matcher: ['/((?!.+\\.[\\w]+$|_next)._)', '/', '/(api|trpc)(._)'],
 };
 ```

package/dist/versions/{v5/next → core-2/nextjs}/authmiddleware-apikey.md

@@ -1,17 +1,15 @@
 ---
-title: '`apiKey` -> `secretKey` as param to authMiddleware'
+title: '`apiKey` -> `secretKey` as param to `authMiddleware`'
 matcher: "authMiddleware\\({[\\s\\S]*?apiKey:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 
 The `apiKey` argument passed to `authMiddleware` must be changed to `secretKey`.
 
-```js
+```diff
 import { authMiddleware } from '@clerk/nextjs';
 
-// before
-authMiddleware({ apiKey: '...' });
-
-// after
-authMiddleware({ secretKey: '...' });
+- authMiddleware({ apiKey: '...' });
++ authMiddleware({ secretKey: '...' });
 ```

package/dist/versions/{v5/next → core-2/nextjs}/authmiddleware-frontendapi.md

@@ -1,6 +1,7 @@
 ---
-title: '`frontendApi` -> `publishableKey` as param to authMiddleware'
+title: '`frontendApi` -> `publishableKey` as param to `authMiddleware`'
 matcher: "authMiddleware\\({[\\s\\S]*?frontendApi:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/authmiddleware-import-change.md

@@ -2,6 +2,7 @@
 title: '`authMiddleware` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?authMiddleware[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/buildclerkprops-import-change.md

@@ -2,6 +2,7 @@
 title: '`buildClerkProps` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?buildClerkProps[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/clerk-import-change.md

@@ -1,6 +1,7 @@
 ---
 title: '`Clerk` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?[,\\s]Clerk[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+category: 'top-level-imports'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/clerk-js-version-next-public.md

@@ -1,5 +1,6 @@
 ---
 title: '`CLERK_JS_VERSION` should be `NEXT_PUBLIC_CLERK_JS_VERSION`'
+category: 'deprecation-removal'
 matcher: '^[^_]*CLERK_JS_VERSION'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/constants-import-change.md

@@ -1,7 +1,8 @@
 ---
 title: '`constants` import moved under `/server`'
-matcher: "import\\s+{[\\s\\S]*?[,\\s]constants[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?constants[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/createauthenticaterequest-import-change.md

@@ -2,6 +2,7 @@
 title: '`createAuthenticateRequest` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?createAuthenticateRequest[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/createclerkclient-apikey.md

@@ -1,6 +1,7 @@
 ---
-title: '`apiKey` -> `secretKey` as param to createClerkClient'
+title: '`apiKey` -> `secretKey` as param to `createClerkClient`'
 matcher: "createClerkClient\\({[\\s\\S]*?apiKey:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/createclerkclient-frontendapi.md

@@ -1,6 +1,7 @@
 ---
-title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
+title: '`frontendApi` -> `publishableKey` as param to `createClerkClient`'
 matcher: "createClerkClient\\({[\\s\\S]*?frontendApi:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/createisomorphicrequest-import-change.md

@@ -2,6 +2,7 @@
 title: '`createIsomorphicRequest` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?createIsomorphicRequest[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/currentuser-import-change.md

@@ -2,6 +2,7 @@
 title: '`currentUser` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?currentUser[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/decodejwt-import-change.md

@@ -2,6 +2,7 @@
 title: '`decodeJwt` import moved under `/server`'
 matcher: "import\\s+{[\\s\\S]*?decodeJwt[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/server'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/emaillinkerrorcode-import-change.md

@@ -2,6 +2,7 @@
 title: '`EmailLinkErrorCode` import moved under `/errors`'
 matcher: "import\\s+{[\\s\\S]*?EmailLinkErrorCode[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
 matcherFlags: 'm'
+category: 'top-level-imports'
 replaceWithString: 'nextjs/errors'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/getauth-apikey.md

@@ -1,6 +1,7 @@
 ---
-title: '`apiKey` -> `secretKey` as param to getAuth'
+title: '`apiKey` -> `secretKey` as param to `getAuth`'
 matcher: "getAuth\\({[\\s\\S]*?apiKey:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/{v5/next → core-2/nextjs}/import-api-url.md

@@ -1,7 +1,8 @@
 ---
 title: '`API_URL` constant removed'
 matcher: "import\\s+{[\\s\\S]*?API_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 
-This deprecated constant has been removed as an export from `@clerk/nextjs`. We recommend setting the `CLERK_API_URL` environment variable and using this instead.
+This deprecated constant has been removed as an export from `@clerk/nextjs`. Instead, set and use the `CLERK_API_URL` environment variable.

package/dist/versions/{v5/next → core-2/nextjs}/import-api-version.md

@@ -1,7 +1,8 @@
 ---
 title: '`API_VERSION` constant removed'
 matcher: "import\\s+{[\\s\\S]*?API_VERSION[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 
-This deprecated constant has been removed as an export from `@clerk/nextjs`. We recommend setting the `CLERK_API_VERSION` environment variable and using this instead.
+This deprecated constant has been removed as an export from `@clerk/nextjs`. Instead, set and use the `CLERK_API_VERSION` environment variable.

package/dist/versions/{v5/next → core-2/nextjs}/import-clerk-js-url.md

@@ -1,7 +1,8 @@
 ---
 title: '`CLERK_JS_URL` constant removed'
 matcher: "import\\s+{[\\s\\S]*?CLERK_JS_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 
-This deprecated constant has been removed as an export from `@clerk/nextjs`. We recommend setting the `NEXT_PUBLIC_CLERK_JS` environment variable and using this instead.
+This deprecated constant has been removed as an export from `@clerk/nextjs`. Instead, set and use the `NEXT_PUBLIC_CLERK_JS` environment variable.