@clerk/upgrade 0.0.2 → 0.1.0

package/dist/versions/v5/common/withclerk-hof-removed.md

@@ -0,0 +1,29 @@
+---
+title: '`withClerk` function removed'
+matcher: "import\\s+{[\\s\\S]*?withClerk[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+---
+
+The `withClerk` higher order function 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
+function withClerk(Component, displayName) {
+	displayName = displayName || Component.displayName || Component.name || 'Component';
+	Component.displayName = displayName;
+	const HOC = props => {
+		const clerk = useIsomorphicClerkContext();
+
+		if (!clerk.loaded) return null;
+
+		return (
+			<Component
+				{...props}
+				clerk={clerk}
+			/>
+		);
+	};
+
+	HOC.displayName = `withClerk(${displayName})`;
+	return HOC;
+}
+```

package/dist/versions/v5/common/withclerk-removed.md

@@ -0,0 +1,16 @@
+---
+title: '`WithClerk` component removed'
+matcher: "import\\s+{[\\s\\S]*?WithClerk[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+---
+
+The `WithClerk` 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
+export const WithClerk = ({ children }) => {
+  const clerk = useClerk();
+  if (typeof children !== 'function') throw new Error();
+
+  return {children(clerk)};
+};
+```

package/dist/versions/v5/common/withsession-hof-removed.md

@@ -0,0 +1,29 @@
+---
+title: '`withSession` function removed'
+matcher: "import\\s+{[\\s\\S]*?withSession[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+---
+
+The `withSession` higher order function 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
+function withSession(Component, displayName) {
+	displayName = displayName || Component.displayName || Component.name || 'Component';
+	Component.displayName = displayName;
+	const HOC = props => {
+		const session = useSessionContext();
+
+		if (!session) return null;
+
+		return (
+			<Component
+				{...props}
+				session={session}
+			/>
+		);
+	};
+
+	HOC.displayName = `withSession(${displayName})`;
+	return HOC;
+}
+```

package/dist/versions/v5/common/withsession-removed.md

@@ -0,0 +1,16 @@
+---
+title: '`WithSession` component removed'
+matcher: "import\\s+{[\\s\\S]*?WithSession[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+---
+
+The `WithSession` 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
+export const WithSession = ({ children }) => {
+  const session = useSession();
+  if (typeof children !== 'function') throw new Error();
+
+  return {children(session)};
+};
+```

package/dist/versions/v5/common/withuser-hof-removed.md

@@ -0,0 +1,29 @@
+---
+title: '`withUser` function removed'
+matcher: "import\\s+{[\\s\\S]*?withUser[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+---
+
+The `withUser` higher order function 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
+function withUser(Component, displayName) {
+	displayName = displayName || Component.displayName || Component.name || 'Component';
+	Component.displayName = displayName;
+	const HOC = props => {
+		const clerk = useUserContext();
+
+		if (!user) return null;
+
+		return (
+			<Component
+				{...props}
+				user={user}
+			/>
+		);
+	};
+
+	HOC.displayName = `withUser(${displayName})`;
+	return HOC;
+}
+```

package/dist/versions/v5/common/withuser-removed-2.md

@@ -0,0 +1,18 @@
+---
+title: '`WithUser` component removed'
+matcher: "import\\s+{[\\s\\S]*?withUser[\\s\\S]*?from\\s+['\"]@clerk\\/(?:nextjs|clerk-react)[\\s\\S]*?['\"]"
+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
+export const WithUser = ({ children }) => {
+  const user = useUser();
+  if (typeof children !== 'function') throw new Error();
+
+  return {children(user)};
+};
+```

package/dist/versions/v5/common/withuser-removed.md

@@ -0,0 +1,16 @@
+---
+title: '`WithUser` component removed'
+matcher: 'foobar'
+matcherFlags: 'm'
+---
+
+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
+export const WithUser = ({ children }) => {
+  const user = useUser();
+  if (typeof children !== 'function') throw new Error();
+
+  return {children(user)};
+};
+```

package/dist/versions/v5/expo/apikey-to-publishable-key.md

@@ -1,6 +1,6 @@
 ---
 title: '`CLERK_FRONTEND_API` replaced by `CLERK_PUBLISHABLE_KEY`'
-matcher: '[^_]CLERK_FRONTEND_API'
+matcher: 'CLERK_FRONTEND_API'
 ---
 
 If you are using a `CLERK_FRONTEND_API` environment variable, the name must be changed to `CLERK_PUBLISHABLE_KEY` instead. Note that the values are different as well, so this is not just a key replacement. You can find the publishable key in your Clerk dashboard. Make sure you do this in both your dev and production environments.

package/dist/versions/v5/gatsby/apikey-to-publishable-key.md

@@ -1,6 +1,6 @@
 ---
 title: '`GASTBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
-matcher: '[^_]GATSBY_CLERK_FRONTEND_API'
+matcher: 'GATSBY_CLERK_FRONTEND_API'
 ---
 
 If you are using a `GATSBY_CLERK_FRONTEND_API` environment variable, the name must be changed to `GATSBY_CLERK_PUBLISHABLE_KEY` instead. Note that the values are different as well, so this is not just a key replacement. You can find the publishable key in your Clerk dashboard. Make sure you do this in both your dev and production environments.

package/dist/versions/v5/index.js

@@ -3,15 +3,16 @@ const load = createLoader({
   version: '5',
   baseUrl: 'https://clerk.com/docs/upgrade-guides/v5'
 });
-const reactChangesList = ['magiclinkerrorcode', 'usemagiclink', 'ismagiclinkerror', 'magiclinkerror', 'handlemagiclinkverification', 'clerkprovider-frontendapi', 'setsession', 'navigate-to-routerpush-routerreplace'];
+const reactChangesList = ['magiclinkerrorcode', 'usemagiclink', 'ismagiclinkerror', 'magiclinkerror', 'handlemagiclinkverification', 'clerkprovider-frontendapi-2', 'setsession', 'navigate-to-routerpush-routerreplace', 'afterswitchorganizationurl', 'appearance-organizationpreview-organizationswitcher', 'useorganization-invitationlist', 'useorganization-membershiplist', 'useorganizations', 'userprofile-prop', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', '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', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl'];
 export default {
-  nextjs: load('next', ['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', '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', 'setsession']),
+  nextjs: load('next', ['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', 'setsession', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', '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', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl']),
   // 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(reactChangesList, ['api-key-to-secret-key', 'createclerkclient-apikey', 'apikey-to-publishable-key', 'createclerkclient-frontendapi', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'setsession', 'api-url-value-change', 'withserverauth-return-type'])),
-  expo: load('expo', ['apikey-to-publishable-key', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'setsession']),
+  remix: load('remix', ['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', 'setsession', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl']),
+  expo: load('expo', ['apikey-to-publishable-key', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'setsession', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl']),
   fastify: load('fastify', ['api-key-to-secret-key', 'api-url-value-change', 'frontend-api-to-publishable-key', 'createclerkclient-apikey', 'createclerkclient-frontendapi', 'clerkplugin-frontendapi']),
-  node: load('node', ['package-rename', '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']),
+  node: load('node', ['package-rename', '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']),
   react: load('react', reactChangesList),
   js: load('js', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'handlemagiclinkverification', 'external-account-avatarurl',
   // shared w/ all
@@ -19,45 +20,25 @@ export default {
   // shared w/ all
   'user-orgpublicdata-profileimageurl',
   // shared w/ all
-  'useorganizations', 'userprofile-prop', 'setsession', 'user-update-password',
-  // shared w/ all
-  'afterswitchorganizationurl',
+  'setsession', 'user-update-password',
   // shared w/ all
   'experimental-canusecaptcha', 'experimental-captchaurl', 'experimental-captchasitekey', 'getorganizationmemberships', 'lastorganizationinvitation-member', 'unstable-invitationupdate', 'unstable-membershipupdate', 'organization-create-string',
   // maybe shared with all?
   'organization-getpendinginvitations',
   // maybe shared with all?
-  'useorganization-invitationlist',
-  // maybe shared with all?
-  'useorganization-membershiplist',
-  // maybe shared with all?
   'user-createexternalaccount-redirecturl',
   // maybe shared with all?
-  'signup-attemptweb3walletverification-generatedsignature', 'appearance-organizationpreview-organizationswitcher',
-  // shared w/ all
-  'redirecttohome']),
-  shared: load('shared', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'buildrequesturl', 'organizationcontext', 'useorganizationlist-organizationlist' // shared outside this pkg?
+  'signup-attemptweb3walletverification-generatedsignature', 'redirecttohome', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'organization-getroles-arguments-changed', 'organization-getdomains-arguments-change', 'organization-getmembershiprequests-arguments-changed', 'organization-getmemberships-arguments-changed', 'organization-getinvitations-arguments-changed', 'user-getorganizationinvitations-arguments-chanaged', 'user-getorganizationsuggestions-arguments-chanaged', 'user-getorganizationmemberships-arguments-chanaged', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'clerk-isready-removed', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl']),
+  shared: load('shared', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'getrequesturl', 'organizationcontext', 'useorganizationlist-organizationlist' // shared outside this pkg?
   ]),
 
   chromeExtension: load('chromeExtension', ['clerkprovider-tokencache']),
-  localizations: [],
+  localizations: load('localization', ['new-localization-keys', 'removed-localization-keys', 'changed-localization-keys']),
+  backend: load('backend', ['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', 'organization-logourl', 'organizationjson-logourl', 'user-profileimageurl', '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', 'getorganizationlist-return-signature', 'getorganizationinvitationlist-return-signature']),
   types: [],
-  backend: []
-  // backend: load('backend', [
-  // 	'createclerkclient-frontendapi',
-  // 	'clerk-import',
-  // 	'externalaccount-picture',
-  // 	'externalaccountjson-avatarurl',
-  // 	'organization-logourl',
-  // 	'organizationjson-logourl',
-  // 	'user-profileimageurl',
-  // 	'userjson-profileimageurl',
-  // 	'organizationmembershippublicuserdata-profileimageurl',
-  // 	'organizationmembershippublicuserdatajson-profileimageurl',
-  // 	'clockskewinseconds',
-  // ]),
+  redwood: [],
+  express: []
 };
-
 function dedupeMerge(arr1, arr2) {
   return [...new Set(arr1.concat(arr2))];
 }

package/dist/versions/v5/js/aftersigninout-behavior-change.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignOutUrl` prop behavior change'
+matcher: 'afterSignOutUrl='
+warning: true
+---
+
+The default value of `afterSignOutUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://docs-preview-605.clerkpreview.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/js/aftersigninouturl-behavior-change.md

@@ -0,0 +1,7 @@
+---
+title: '`afterSignOutUrl` prop behavior change'
+matcher: 'afterSignOutUrl='
+warning: true
+---
+
+The default value of `afterSignOutUrl` has been changed to `/`. The URLs defined in your `Dashboard > Account Portal > Redirects` section will no longer affect these values. Read the [Customizing your Account Portal redirects](https://docs-preview-605.clerkpreview.com/docs/account-portal/custom-redirects) guide to learn how to override these defaults.

package/dist/versions/v5/js/clerk-isready-removed.md

@@ -0,0 +1,6 @@
+---
+title: '`Clerk.isReady()` removed'
+matcher: "Clerk\\.isReady\\("
+---
+
+We have removed the `Clerk.isReady()` function - instead, please use the `Clerk.loaded` property to check whether Clerk has completed loading.

package/dist/versions/v5/js/lastorganizationinvitation-member.md

@@ -1,6 +1,6 @@
 ---
 title: '`lastOrganizationInvitation` and `lastOrganizationMember` dropped from event emitter'
-matcher: "[\\.lastOrganizationInvitation|\\.lastOrganizationMember]"
+matcher: "(?:\\.lastOrganizationInvitation|\\.lastOrganizationMember)"
 ---
 
 If you are using [`Clerk.addListener`](https://clerk.com/docs/references/javascript/clerk/clerk#add-listener) or `OrganizationContext` and utilizing either the `lastOrganizationInvitation` and/or `lastOrganizationMember` emitted events, these properties have been removed, as they were only relevant for internal use. We are not providing a way to backfill this functionality at the moment. If you are using it and this is an issue for you, please [reach out to Clerk support](https://clerk.com/support) and we can find a way to resolve the issue!

package/dist/versions/v5/js/organization-getdomains-arguments-change.md

@@ -0,0 +1,20 @@
+---
+title: '`Organization.getDomains` arguments changed'
+matcher: "\\.getDomains\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.organization.getDomains({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/organization-getinvitations-arguments-changed.md

@@ -0,0 +1,20 @@
+---
+title: '`Organization.getInvitations` arguments changed'
+matcher: "\\.getInvitations\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.organization.getInvitations({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/organization-getmembershiprequests-arguments-changed.md

@@ -0,0 +1,20 @@
+---
+title: '`Organization.getMembershipRequests` arguments changed'
+matcher: "\\.getMembershipRequests\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.organization.getMembershipRequests({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/organization-getmemberships-arguments-changed.md

@@ -0,0 +1,20 @@
+---
+title: '`Organization.getMemberships` arguments changed'
+matcher: "\\.getMemberships\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.organization.getMemberships({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/organization-getroles-arguments-changed.md

@@ -0,0 +1,20 @@
+---
+title: '`Organization.getRoles` arguments changed'
+matcher: "\\.getRoles\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.organization.getRoles({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/user-getorganizationinvitations-arguments-chanaged.md

@@ -0,0 +1,20 @@
+---
+title: '`User.getOrganizationInvitations` arguments changed'
+matcher: "\\.getOrganizationInvitations\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.user.getOrganizationInvitations({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/user-getorganizationmemberships-arguments-chanaged.md

@@ -0,0 +1,20 @@
+---
+title: '`User.getOrganizationMemberships` arguments changed'
+matcher: "\\.getOrganizationMemberships\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.user.getOrganizationMemberships({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/js/user-getorganizationsuggestions-arguments-chanaged.md

@@ -0,0 +1,20 @@
+---
+title: '`User.getOrganizationSuggestions` arguments changed'
+matcher: "\\.getOrganizationSuggestions\\("
+---
+
+There 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:
+
+```diff
+  import Clerk from "@clerk/clerk-js"
+
+  const clerk = new Clerk()
+  await clerk.load()
+
+  const { data: orgs } = await clerk.user.getOrganizationSuggestions({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

package/dist/versions/v5/next/api-url-value-change.md

@@ -1,6 +1,7 @@
 ---
 title: '`API_URL` value has changed'
 matcher: "API_URL[\\s\\S]+?from\\s+['\"]@clerk\\/nextjs\\/server['\"]"
+matcherFlags: 'm'
 ---
 
 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/next/auth-import-change.md

@@ -0,0 +1,13 @@
+---
+title: '`auth` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?auth[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'nextjs/server'
+---
+
+The `auth` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { auth } from "@clerk/nextjs"
++ import { auth } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/next/auth-middleware-deprecated.md

@@ -1,10 +1,49 @@
 ---
 title: '`authMiddleware` deprecated'
-matcher: "import\\s+{[\\s\\S]*?authMiddleware[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/nextjs.*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?authMiddleware[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+warning: true
 ---
 
-`authMiddleware` is now deprecated, and we recommend instead using `clerkMiddleware`. Here’s how code could look before and after migration:
+The [`authMiddleware`](https://clerk.com/docs/references/nextjs/auth-middleware) API from `@clerk/nextjs` has been marked as deprecated. We highly recommend using [`clerkMiddleware`](https://clerk.com/docs/references/nextjs/clerk-middleware) going forward. `clerkMiddleware` protects no routes by default and you need to add your individual routes you want to opt into protection. Here's an example of having all routes public except for everything under `/dashboard`.
 
-```js
-// TODO
+For more documentation on the new `clerkMiddleware` function, check out [our official docs](https://clerk.com/docs/references/nextjs/clerk-middleware)!
+
+**Before:**
+
+```ts
+// middleware.ts
+
+import { authMiddleware } from '@clerk/nextjs';
+
+export default authMiddleware({
+	publicRoutes: req => !req.url.includes('/dashboard'),
+});
+
+export const config = {
+	matcher: ['/((?!.+\\.[\\w]+$|_next)._)', '/', '/(api|trpc)(._)'],
+};
+```
+
+**After:**
+
+```ts
+// middleware.ts
+
+import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server';
+import { NextResponse } from 'next/server';
+
+const isProtectedRoute = createRouteMatcher(['/dashboard(.*)']);
+
+export default clerkMiddleware((auth, request) => {
+	if (isProtectedRoute(request)) {
+		auth().protect();
+	}
+
+	return NextResponse.next();
+});
+
+export const config = {
+	matcher: ['/((?!.+\\.[\\w]+$|_next)._)', '/', '/(api|trpc)(._)'],
+};
 ```

package/dist/versions/v5/next/authmiddleware-import-change.md

@@ -0,0 +1,13 @@
+---
+title: '`authMiddleware` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?authMiddleware[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'nextjs/server'
+---
+
+The `authMiddleware` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Note as well that `authMiddleware` is deprecated as of this release, and we recommend [using `clerkMiddleware` instead](https://clerk.com/docs/references/nextjs/clerk-middleware). Example below of the fix that needs to be made:
+
+```diff
+- import { authMiddleware } from "@clerk/nextjs"
++ import { authMiddleware } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/next/buildclerkprops-import-change.md

@@ -0,0 +1,13 @@
+---
+title: '`buildClerkProps` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?buildClerkProps[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'nextjs/server'
+---
+
+The `buildClerkProps` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { buildClerkProps } from "@clerk/nextjs"
++ import { buildClerkProps } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/next/clerk-import-change.md

@@ -0,0 +1,12 @@
+---
+title: '`Clerk` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?[,\\s]Clerk[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+---
+
+The `Clerk` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Note as well that the `Clerk` export has changed to `createClerkClient` as part of the v5 changes. Example below of the fix that needs to be made:
+
+```diff
+- import { Clerk } from "@clerk/nextjs"
++ import { createClerkClient } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/next/clerk-js-version-next-public.md

@@ -1,6 +1,6 @@
 ---
 title: '`CLERK_JS_VERSION` should be `NEXT_PUBLIC_CLERK_JS_VERSION`'
-matcher: '[^_]CLERK_JS_VERSION'
+matcher: '^[^_]*CLERK_JS_VERSION'
 ---
 
 If you are using `CLERK_JS_VERSION` as an environment variable, it should be changed to `NEXT_PUBLIC_CLERK_JS_VERSION` instead.

package/dist/versions/v5/next/constants-import-change.md

@@ -0,0 +1,13 @@
+---
+title: '`constants` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?constants[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+replaceWithString: 'nextjs/server'
+---
+
+The `constants` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { constants } from "@clerk/nextjs"
++ import { constants } from "@clerk/nextjs/server"
+```