@clerk/upgrade 0.0.3 → 0.1.1

package/dist/app.js

@@ -13,8 +13,11 @@ export default function App({
   _toVersion,
   _sdk,
   _dir = false,
-  _ignore = []
+  _ignore = [],
+  _yolo = false,
+  noWarnings = false
 }) {
+  const [yolo, setYolo] = useState(_yolo);
   const [sdks, setSdks] = useState(_sdk ? [_sdk] : []);
   const [sdkGuesses, setSdkGuesses] = useState([]);
   const [sdkGuessConfirmed, setSdkGuessConfirmed] = useState(false);
@@ -27,6 +30,10 @@ export default function App({
   const [configComplete, setConfigComplete] = useState(false);
   const [configVerified, setConfigVerified] = useState(false);
   let fromVersionGuess = false;
+  if (yolo) {
+    setSdks(SDKS.map(s => s.value));
+    setYolo(false);
+  }
 
   // We try to guess which SDK they are using
   if (isEmpty(sdks) && isEmpty(sdkGuesses) && !sdkGuessAttempted) {
@@ -126,7 +133,8 @@ export default function App({
     toVersion,
     sdks,
     dir,
-    ignore
+    ignore,
+    noWarnings
   })));
 }
 

package/dist/cli.js

@@ -9,15 +9,15 @@ const cli = meow(`
 		  $ clerk-upgrade
 
 		Options
-			--from   Major version number you're upgrading from
-			--to     Major version number you're upgrading to
-			--sdk    Name of the SDK you're upgrading
-			--dir    Directory you'd like to scan for files
-			--ignore Any files or directories you'd like to ignore
+			--from         Major version number you're upgrading from
+			--to           Major version number you're upgrading to
+			--sdk          Name of the SDK you're upgrading
+			--dir          Directory you'd like to scan for files
+			--ignore       Any files or directories you'd like to ignore
+			--noWarnings   Do not print warnings, only items that must be fixed
 
 		Examples
-		  $ clerk-upgrade --from=4 --to=5 --sdk=nextjs --dir=src/**
-		  Hello, Jane
+		  $ clerk-upgrade --sdk=nextjs --dir=src/**
 	`, {
   importMeta: import.meta,
   flags: {
@@ -39,6 +39,12 @@ const cli = meow(`
     ignore: {
       type: 'string',
       isMultiple: true
+    },
+    yolo: {
+      type: 'boolean'
+    },
+    noWarnings: {
+      type: 'boolean'
     }
   }
 });
@@ -46,5 +52,9 @@ render( /*#__PURE__*/React.createElement(App, {
   _fromVersion: cli.flags.from,
   _toVersion: cli.flags.to,
   _sdk: cli.flags.sdk,
-  _dir: cli.flags.dir
-}));
+  _dir: cli.flags.dir,
+  _yolo: cli.flags.yolo,
+  noWarnings: cli.flags.noWarnings
+})
+// { debug: true }, if having issues with errors being swallowed, uncomment this
+);

package/dist/scan.js

@@ -11,7 +11,8 @@ export default function Scan({
   toVersion,
   sdks,
   dir,
-  ignore
+  ignore,
+  noWarnings
 }) {
   // NOTE: if the difference between fromVersion and toVersion is greater than 1
   // we need to do a little extra work here and import two matchers,
@@ -73,18 +74,29 @@ export default function Scan({
       // then we run each of the matchers against the file contents
       for (const sdk in matchers) {
         // returns [{ ...matcher, instances: [{sdk, file, position}]  }]
-        matchers[sdk].map(matcher => {
+        matchers[sdk].map(matcherConfig => {
           // run regex against file content, return array of matches
-          const matches = Array.from(content.matchAll(matcher.matcher));
+          // matcher can be an array or string
+          let matches = [];
+          if (Array.isArray(matcherConfig.matcher)) {
+            matcherConfig.matcher.map(m => {
+              matches = matches.concat(Array.from(content.matchAll(m)));
+            });
+          } else {
+            matches = Array.from(content.matchAll(matcherConfig.matcher));
+          }
           if (matches.length < 1) return;
 
           // for each match, add to `instances` array of a key, create if not exists
           matches.map(match => {
-            if (!allResults[matcher.title]) allResults[matcher.title] = {
+            if (noWarnings && matcherConfig.warning) return;
+            if (!allResults[matcherConfig.title]) allResults[matcherConfig.title] = {
               instances: [],
-              ...matcher
+              ...matcherConfig
             };
-            allResults[matcher.title].instances.push({
+
+            // TODO: there's a small bug where we can see multiple instances of the same position
+            allResults[matcherConfig.title].instances.push({
               sdk,
               file: path.relative(process.cwd(), file),
               position: indexToPosition(content, match.index, {
@@ -99,7 +111,7 @@ export default function Scan({
     })).then(() => {
       setResults([...results, ...Object.keys(allResults).map(k => allResults[k])]);
       setComplete(true);
-      if (results.length < 1) {
+      if (Object.keys(allResults).length < 1) {
         setStatus('It looks like you have nothing you need to change, upgrade away!');
       } else {
         setStatus('File scan complete. See results below!');

package/dist/util/expandable-list.js

@@ -59,9 +59,9 @@ export default function ExpandableList({
       borderColor: item.focused ? 'blue' : 'white',
       paddingX: 1,
       key: item.title
-    }, /*#__PURE__*/React.createElement(Markdown, null, item.title), locations.length > 1 ? /*#__PURE__*/React.createElement(Text, null, "Found ", locations.length, " instances, expand for detail") : /*#__PURE__*/React.createElement(Text, null, "Location: ", locations[0]), item.expanded && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Line, null), locations.length > 1 && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "Locations:"), locations.map(loc => /*#__PURE__*/React.createElement(Text, null, '  ', "- ", loc))), /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Markdown, null, item.content), /*#__PURE__*/React.createElement(Line, null), /*#__PURE__*/React.createElement(Link, {
-      url: item.link
-    }, /*#__PURE__*/React.createElement(Text, null, "Open in migration guide \xBB")))));
+    }, /*#__PURE__*/React.createElement(Markdown, null, item.title), locations.length > 1 ? /*#__PURE__*/React.createElement(Text, null, "Found ", locations.length, " instances, expand for detail") : /*#__PURE__*/React.createElement(Text, null, "Location: ", locations[0]), item.expanded && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Line, null), locations.length > 1 && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "Locations:"), locations.map(loc => /*#__PURE__*/React.createElement(Text, null, '  ', "- ", loc)), /*#__PURE__*/React.createElement(Line, null)), item.warning && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
+      color: "yellow"
+    }, "\u26A0\uFE0F This is a WARNING and will still match even if you corrected the issue or if no correction is necessary. To dismiss warnings, pass the `--noWarnings` flag to the CLI when running."), /*#__PURE__*/React.createElement(Line, null)), /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Markdown, null, item.content))));
     return memo;
   }, []), state.all.length > state.numberVisible && /*#__PURE__*/React.createElement(Text, null, "Showing ", state.visible[0] + 1, " - ", Math.min(state.visible[1], state.all.length), " of ", state.all.length));
 }

package/dist/util/generate-export-change.js

@@ -0,0 +1,10 @@
+import fs from 'fs';
+import path from 'path';
+
+// WIP, a util script used for quickly generating a large number of nearly identical change files
+const movedToServer = ['MultisessionAppSupport', 'auth', 'currentUser', 'authMiddleware',
+// deprecated
+'clerkMiddleware',
+// new
+'redirectToSignIn', 'redirectToSignUp', 'buildClerkProps', 'verifyToken', 'isClerkAPIResponseError', 'isEmailLinkError', 'isKnownError', 'isMetamaskError', 'EmailLinkErrorCode', 'withClerk', 'withSession', 'withUser', 'WithClerk', 'WithSession', 'WithUser'];
+const clerkBackendExports = ['createClerkClient', 'verifyToken'];

package/dist/util/guess-framework.js

@@ -1,9 +1,14 @@
 import { readPackageSync } from 'read-pkg';
 import SDKS from '../constants/sdks.js';
 export default function guessFrameworks(dir) {
-  const pkg = readPackageSync({
-    cwd: dir
-  });
+  let pkg;
+  try {
+    pkg = readPackageSync({
+      cwd: dir
+    });
+  } catch (err) {
+    return [];
+  }
 
   // no guessing if there are no deps
   if (!pkg.dependencies && !pkg.devDependencies) return [];

package/dist/util/load-change.js

@@ -19,11 +19,12 @@ export default function createLoader({
       const fm = parsed.data;
       return {
         title: fm.title,
-        matcher: new RegExp(fm.matcher, `g${fm.matcherFlags ? fm.matcherFlags : ''}`),
+        matcher: Array.isArray(fm.matcher) ? fm.matcher.map(m => new RegExp(m, `g${fm.matcherFlags ? fm.matcherFlags : ''}`)) : new RegExp(fm.matcher, `g${fm.matcherFlags ? fm.matcherFlags : ''}`),
         replaceWithString: fm.replaceWithString,
         slug,
         sdk: sdk,
         content: parsed.content,
+        warning: fm.warning,
         link: `${baseUrl}#${slug}`
       };
     });

package/dist/versions/v5/backend/api-url-value-changed.md

@@ -0,0 +1,7 @@
+---
+title: '`API_URL` value has changed'
+matcher: "API_URL[\\s\\S]*?from\\s+['\"]@clerk\\/backend\\/constants['\"]"
+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/backend/authenticaterequest-params-change.md

@@ -0,0 +1,12 @@
+---
+title: '`request` separated from `options` as params to `authenticateRequest`'
+warning: true
+matcher: "authenticateRequest\\("
+---
+
+There has been a change to the way the params of the `authenticateRequest` function are structured. The `request` param, formerly included in an `options` object, has been moved to stand on its own as the first param to the function, while the `options` object remains as the second param. Example below:
+
+```diff
+- clerkClient.authenticateRequest({ ...opts, request })
++ clerkClient.authenticateRequest(request, { ...opts })
+```

package/dist/versions/v5/backend/buildrequesturl-removed.md

@@ -0,0 +1,7 @@
+---
+title: '`buildRequestUrl` import removed'
+matcher: "import\\s+{[\\s\\S]*?buildRequestUrl[\\s\\S]*?}\\s+from\\s+['\"]@clerk\/backend['\"]"
+matcherFlags: 'm'
+---
+
+The `buildRequestUrl` import was intended for those building custom Clerk integrations for frameworks and has been removed in favor of other methods internally. If you were relying on this function and this is an issue, please [reach out to Clerk support](https://clerk.com/support).

package/dist/versions/v5/backend/clerk-import.md

@@ -1,6 +1,6 @@
 ---
 title: '`Clerk` -> `createClerkClient`'
-matcher: "import\\s+{[\\s\\S]*?Clerk[\\s\\S]*?}\\s+from\\s+['\"]@clerk/backend['\"]"
+matcher: "import\\s+{*[\\s\\S]*?Clerk[\\s\\S]*?}*\\s+from\\s+['\"]@clerk\\/backend['\"]"
 matcherFlags: 'm'
 ---
 
@@ -8,7 +8,7 @@ The top level `Clerk` import was renamed to `createClerkClient`. This is just a
 
 ```js
 // before
-import { Clerk } from '@clerk/backend';
+import Clerk from '@clerk/backend';
 
 // after
 import { createClerkClient } from '@clerk/backend';

package/dist/versions/v5/backend/client-unstableoptions-removed.md

@@ -0,0 +1,15 @@
+---
+title: '`clerkClient.__unstable_options` removed'
+matcher: "\\.__unstable_options"
+---
+
+The `clerkClient.__unstable_options` property was removed. Previously, you could use it to update the internal options. Instead, create a new ` clerkClient` instance using `createClerkClient` and pass the options in this way. For example:
+
+```diff
+  import { createClerkClient } from "@clerk/backend"
+
+  const clerkClient = createClerkClient({ secretKey: "old" })
+
+- clerkClient.__unstable_options.secretKey = "new"
++ const newClerkClient = createClerkClient({ secretKey: "new" })
+```

package/dist/versions/v5/backend/clockskewinseconds.md

@@ -1,7 +1,15 @@
 ---
 title: '`clockSkewInSeconds` -> `clockSkewInMs`'
-matcher: 'clockSkewInSeconds'
+matcher:
+  - "verifyJwt\\([\\s\\S]*?(clockSkewInSeconds):[\\s\\S]*?\\)"
+  - "verifyToken\\([\\s\\S]*?(clockSkewInSeconds):[\\s\\S]*?\\)"
+  - "authenticateRequest\\([\\s\\S]*?(clockSkewInSeconds):[\\s\\S]*?\\)"
+matcherFlags: 'm'
 replaceWithString: 'clockSkewInMs'
 ---
 
-The value stayed the same, only the name changed.
+The `clockSkewInSeconds` option has been renamed to `clockSkewInMs` in order to accurately reflect that its value is expected to be in milliseconds rather than seconds. The value does not need to change here, only the name. This change affects the following imports:
+
+- `verifyJwt`
+- `verifyToken`
+- `Clerk.authenticateRequest`

package/dist/versions/v5/backend/constants-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`constants` import moved to `@clerk/backend/internal`'
+matcher: "import\\s+{[\\s\\S]*?constants[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/internal'
+---
+
+The `constants` import path has changed from `@clerk/backend` to `@clerk/backend/internal`. You must update your import path in order for it to work correctly. Note that internal imports are not intended for usage and are outside the scope of semver. Example below of the fix that needs to be made:
+
+```diff
+- import { constants } from "@clerk/backend"
++ import { constants } from "@clerk/backend/internal"
+```

package/dist/versions/v5/backend/createauthenticaterequest-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`createAuthenticateRequest` import moved to `@clerk/backend/internal`'
+matcher: "import\\s+{[\\s\\S]*?createAuthenticateRequest[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/internal'
+---
+
+The `createAuthenticateRequest` import path has changed from `@clerk/backend` to `@clerk/backend/internal`. You must update your import path in order for it to work correctly. Note that internal imports are not intended for usage and are outside the scope of semver. Example below of the fix that needs to be made:
+
+```diff
+- import { createAuthenticateRequest } from "@clerk/backend"
++ import { createAuthenticateRequest } from "@clerk/backend/internal"
+```

package/dist/versions/v5/backend/createclerkclient-apikey.md

@@ -1,21 +1,18 @@
 ---
 title: '`apiKey` -> `secretKey` as param to createClerkClient'
-matcher: "[createClerkClient|Clerk]\\(\\s*{[\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+matcher: "(?:createClerkClient|Clerk)\\(\\s*{[\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
 matcherFlags: 'm'
 ---
 
 The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`. Also note that the import value has changed for creating a new Clerk client, which will be addressed by a separate line item if relevant to your codebase.
 
-```js
-// before
-import { Clerk } from '@clerk/backend';
+```diff
+- import { Clerk } from '@clerk/backend';
++ import { createClerkClient } from '@clerk/backend';
 
-const clerkClient = Clerk({ apiKey: '...' });
-clerkClient.authenticateRequest({ apiKey: '...' });
+- const clerkClient = Clerk({ apiKey: '...' });
++ const clerkClient = createClerkClient({ secretKey: '...' });
 
-// after
-import { createClerkClient } from '@clerk/backend';
-
-const clerkClient = createClerkClient({ secretKey: '...' });
-clerkClient.authenticateRequest({ secretKey: '...' });
+- clerkClient.authenticateRequest({ apiKey: '...' });
++ clerkClient.authenticateRequest({ secretKey: '...' });
 ```

package/dist/versions/v5/backend/createclerkclient-frontendapi.md

@@ -6,16 +6,13 @@ matcherFlags: 'm'
 
 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. Also note that the import value has changed for creating a new Clerk client, which will be addressed by a separate line item if relevant to your codebase.
 
-```js
-// before
-import { Clerk } from '@clerk/backend';
+```diff
+- import { Clerk } from '@clerk/backend';
++ import { createClerkClient } from '@clerk/backend';
 
-const clerkClient = Clerk({ frontendApi: '...' });
-clerkClient.authenticateRequest({ frontendApi: '...' });
+- const clerkClient = Clerk({ frontendApi: '...' });
++ const clerkClient = createClerkClient({ publishableKey: '...' });
 
-// after
-import { createClerkClient } from '@clerk/backend';
-
-const clerkClient = createClerkClient({ publishableKey: '...' });
-clerkClient.authenticateRequest({ publishableKey: '...' });
+- clerkClient.authenticateRequest({ frontendApi: '...' });
++ clerkClient.authenticateRequest({ publishableKey: '...' });
 ```

package/dist/versions/v5/backend/createemail-removed.md

@@ -0,0 +1,7 @@
+---
+title: '`createEmail` import removed'
+matcher: "import\\s+{[\\s\\S]*?createEmail[\\s\\S]*?}\\s+from\\s+['\"]@clerk\/backend['\"]"
+matcherFlags: 'm'
+---
+
+The `createEmail` import has been removed. There is no replacement at this time because we need to rethink how `createEmail` behaves and align it with the newer `sendSms` method. If this is an issue for your implementation, please contact [Clerk support](https://clerk.com/contact).

package/dist/versions/v5/backend/createisomorphicrequest-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`createIsomorphicRequest` import moved to `@clerk/backend/internal`'
+matcher: "import\\s+{[\\s\\S]*?createIsomorphicRequest[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/internal'
+---
+
+The `createIsomorphicRequest` import path has changed from `@clerk/backend` to `@clerk/backend/internal`. You must update your import path in order for it to work correctly. Note that internal imports are not intended for usage and are outside the scope of semver. Example below of the fix that needs to be made:
+
+```diff
+- import { createIsomorphicRequest } from "@clerk/backend"
++ import { createIsomorphicRequest } from "@clerk/backend/internal"
+```

package/dist/versions/v5/backend/createisomorphicrequest-removed.md

@@ -0,0 +1,13 @@
+---
+title: '`createIsomorphicRequest` import moved to `/internal`'
+matcher: "import\\s+{[\\s\\S]*?createIsomorphicRequest[\\s\\S]*?}\\s+from\\s+['\"]@clerk\/(backend)['\"]"
+replaceWithString: 'backend/internal'
+matcherFlags: 'm'
+---
+
+The `createIsomorphicRequest` import was intended for those building custom Clerk integrations for frameworks and has been moved to `@clerk/backend/internal` to reflect this. Please use caution when using internal imports as they are outside the bounds of semver.
+
+```diff
+- import { createIsomorphicRequest } from "@clerk/backend"
++ import { createIsomorphicRequest } from "@clerk/backend/internal"
+```

package/dist/versions/v5/backend/decodeJwt-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`decodeJwt` import moved to `@clerk/backend/tokens`'
+matcher: "import\\s+{[\\s\\S]*?decodeJwt[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/tokens'
+---
+
+The `decodeJwt` import path has changed from `@clerk/backend` to `@clerk/backend/tokens`. 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 { decodeJwt } from "@clerk/backend"
++ import { decodeJwt } from "@clerk/backend/tokens"
+```

package/dist/versions/v5/backend/externalaccount-picture.md

@@ -0,0 +1,6 @@
+---
+title: '`ExternalAccount.picture` -> `.imageUrl`'
+matcher: "\\.picture"
+---
+
+The `picture` property of any [`ExternalAcccount` object](https://clerk.com/docs/references/javascript/external-account) has been changed to `imageUrl`.

package/dist/versions/v5/backend/externalaccountjson-avatarurl.md

@@ -0,0 +1,6 @@
+---
+title: '`ExternalAccountJSON.avatar_url` -> `.imageUrl`'
+matcher: "\\.avatar_url"
+---
+
+The `avatarUrl` property of any `ExternalAcccountJSON` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/getorganizationinvitationlist-return-signature.md

@@ -0,0 +1,14 @@
+---
+title: '`Users.getOrganizationInvitationList` return signature changed'
+matcher: "\\.users\\.getOrganizationInvitationList\\("
+warning: true
+---
+
+The response payload of `Users.getOrganizationInvitationList` was changed as part of the v5 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:
+
+```diff
+- const data = await clerkClient.users.getOrganizationInvitationList()
++ const { data, totalCount } = await clerkClient.users.getOrganizationInvitationList()
+```

package/dist/versions/v5/backend/getorganizationlist-return-signature.md

@@ -0,0 +1,14 @@
+---
+title: '`Users.getOrganizationList` return signature changed'
+matcher: "\\.users\\.getOrganizationList\\("
+warning: true
+---
+
+The response payload of `Users.getOrganizationList` was changed as part of the v5 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:
+
+```diff
+- const data = await clerkClient.users.getOrganizationList()
++ const { data, totalCount } = await clerkClient.users.getOrganizationList()
+```

package/dist/versions/v5/backend/getorganizationmembershiplist-return-signature.md

@@ -0,0 +1,14 @@
+---
+title: '`Users.getOrganizationMembershipList` return signature changed'
+matcher: "\\.users\\.getOrganizationMembershipList\\("
+warning: true
+---
+
+The response payload of `Users.getOrganizationMembershipList` was changed as part of the v5 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:
+
+```diff
+- const data = await clerkClient.users.getOrganizationMembershipList()
++ const { data, totalCount } = await clerkClient.users.getOrganizationMembershipList()
+```

package/dist/versions/v5/backend/getpendingorganizationinvitationlist.md

@@ -1,12 +1,12 @@
 ---
-title: '`getPendingOrganizationInvitationList` -> `getOrganizationInvitationList`'
-matcher: 'getPendingOrganizationInvitationList'
+title: '`Organizations.getPendingOrganizationInvitationList` -> `getOrganizationInvitationList`'
+matcher: "\\.(getPendingOrganizationInvitationList)\\("
 replaceWithString: 'getOrganizationInvitationList'
 ---
 
-Use `getOrganizationInvitationList` with a `status` option instead.
+The `Organizations.getPendingOrganizationInvitationList` method has been removed. To match the same functionality, use `Organizations.getOrganizationInvitationList` and pass in `status` option as "pending" instead.
 
 ```diff
-- getPendingOrganizationInvitationList({ organizationId: "" })
-+ getOrganizationInvitationList({ organizationId: "", status: "pending" })
+- clerkClient.organizations.getPendingOrganizationInvitationList()
++ clerkClient.organizations.getOrganizationInvitationList({ status: "pending" })
 ```

package/dist/versions/v5/backend/httpoptions-removed.md

@@ -0,0 +1,15 @@
+---
+title: '`httpOptions` parameter removed'
+matcher: "\\([\\s\\S]*?httpOptions:\\s\\S]*?\\)"
+matcherFlags: 'm'
+---
+
+The `httpOptions` parameter was removed from the internal `buildRequest` function but it is used by most public facing APIs. Hence you were able to pass `httpOptions` to some functions which is not possible anymore. If you're currently relying on this functionality and wish to update, please reach out to Clerk's support.
+
+The internal change looks like this:
+
+```diff
+- const r = buildRequest({ httpsOptions: { headers: {} }})
++ const request = buildRequest()
++ request({ headerParams: {} })
+```

package/dist/versions/v5/backend/membershiprole.md

@@ -0,0 +1,21 @@
+---
+title: '`MembershipRole` type replaced by `OrganizationCustomRoleKey` type'
+matcher: "(?:\\.orgRole|\\.org_role)"
+---
+
+The `MembershipRole` type was replaced with `OrganizationCustomRoleKey` (related to [roles and permissions](https://clerk.com/docs/organizations/roles-permissions)). An example of where this type might be found:
+
+```js
+import { useAuth } from '@clerk/clerk-react';
+
+const { orgRole } = useAuth();
+```
+
+To support the existing roles `admin`, `basic_member`, and `guest_member` apply interface merging using the following snippet:
+
+```js
+interface ClerkAuthorization {
+  permission: ''
+  role: 'admin' | 'basic_member' | 'guest_member'
+}
+```

package/dist/versions/v5/backend/organization-logourl.md

@@ -0,0 +1,6 @@
+---
+title: '`Organization.logoUrl` -> `.imageUrl`'
+matcher: "\\.logoUrl"
+---
+
+The `logoUrl` property of any `Organization` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/organizationjson-logourl.md

@@ -0,0 +1,6 @@
+---
+title: '`OrganizationJSON.logo_url` -> `.imageUrl`'
+matcher: "\\.logo_url"
+---
+
+The `logo_url` property of any `OrganizationJSON` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/organizationmembershippublicuserdata-profileimageurl.md

@@ -0,0 +1,6 @@
+---
+title: '`OrganizationMembershipPublicUserData.profileImageUrl` -> `.imageUrl`'
+matcher: "\\.profileImageUrl"
+---
+
+The `profileImageUrl` property of any `OrganizationMembershipPublicUserData` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/organizationmembershippublicuserdatajson-profileimageurl.md

@@ -0,0 +1,6 @@
+---
+title: '`OrganizationMembershipPublicUserDataJSON.profile_image_url` -> `.imageUrl`'
+matcher: "\\.profile_image_url"
+---
+
+The `profile_image_url` property of any `OrganizationMembershipPublicUserDataJSON` object has been changed to `imageUrl`.

package/dist/versions/v5/backend/pkgversion.md

@@ -0,0 +1,15 @@
+---
+title: '`pkgVersion` -> `clerkJSVersion`'
+matcher:
+  - "loadInterstitialFromLocal\\([\\s\\S]*?pkgVersion:"
+  - "loadInterstitialFromBAPI\\([\\s\\S]*?pkgVersion:"
+  - "buildPublicInterstitialUrl\\([\\s\\S]*?pkgVersion:"
+matcherFlags: 'm'
+---
+
+The `pkgVersion` parameter was removed from the `loadInterstitialFromLocal`, `loadInterstitialFromBAPI`, and `buildPublicInterstitialUrl` functions. Use `clerkJSVersion` instead. Example:
+
+```diff
+- loadInterstitialFromLocal({ pkgVersion: "..." })
++ loadInterstitialFromLocal({ clerkJSVersion: "..." })
+```

package/dist/versions/v5/backend/redirect-import-path-move.md

@@ -0,0 +1,13 @@
+---
+title: '`redirect` import moved to `@clerk/backend/internal`'
+matcher: "import\\s+{[\\s\\S]*?redirect[\\s\\S]*?}\\s+from\\s+['\"]@clerk\\/(backend)['\"]"
+matcherFlags: 'm'
+replaceWithString: 'backend/internal'
+---
+
+The `redirect` import path has changed from `@clerk/backend` to `@clerk/backend/internal`. You must update your import path in order for it to work correctly. Note that internal imports are not intended for usage and are outside the scope of semver. Example below of the fix that needs to be made:
+
+```diff
+- import { redirect } from "@clerk/backend"
++ import { redirect } from "@clerk/backend/internal"
+```