@clerk/upgrade 0.0.1 → 0.0.3

package/dist/scan.js

@@ -2,6 +2,7 @@ import React, { useState, useEffect } from 'react';
 import { Text, Newline, Box } from 'ink';
 import { globby } from 'globby';
 import fs from 'fs/promises';
+import path from 'path';
 import { ProgressBar } from '@inkjs/ui';
 import indexToPosition from 'index-to-position';
 import ExpandableList from './util/expandable-list.js';
@@ -45,10 +46,16 @@ export default function Scan({
   // result = `files` set to format: ['/filename', '/other/filename']
   useEffect(() => {
     setStatus('Collecting files to scan');
-    ignore.push('node_modules/**', '**/node_modules/**', '.git/**', 'package.json', 'package-lock.json', 'yarn.lock', 'pnpm-lock.yaml');
-    globby(dir, {
+    ignore.push('node_modules/**', '**/node_modules/**', '.git/**', 'package.json', '**/package.json', 'package-lock.json', '**/package-lock.json', 'yarn.lock', '**/yarn.lock', 'pnpm-lock.yaml', '**/pnpm-lock.yaml', '**/*.(png|webp|svg|gif|jpg|jpeg)+',
+    // common image files
+    '**/*.(mp4|mkv|wmv|m4v|mov|avi|flv|webm|flac|mka|m4a|aac|ogg)+' // common video files
+    );
+
+    globby(path.resolve(dir), {
       ignore: [...ignore.filter(x => x)]
-    }).then(files => setFiles(files));
+    }).then(files => {
+      setFiles(files);
+    });
   }, [dir, ignore]);
 
   // Read files and scan regexes
@@ -57,32 +64,40 @@ export default function Scan({
   //
   useEffect(() => {
     if (!matchers || !files) return;
+    const allResults = {};
     Promise.all(
     // first we read all the files
     files.map(async (file, idx) => {
-      setStatus(`Scanning ${file}`);
-      setProgress(Math.ceil(idx / files.length * 100));
       const content = await fs.readFile(file, 'utf8');
 
       // then we run each of the matchers against the file contents
-      // TODO: combine results on the same match, add multiple file/positions
       for (const sdk in matchers) {
+        // returns [{ ...matcher, instances: [{sdk, file, position}]  }]
         matchers[sdk].map(matcher => {
-          const matches = content.matchAll(matcher.matcher);
-          if (!matches) return;
-          Array.from(matches).map(match => {
-            // TODO: index should be converted to line/col
-            results.push({
-              sdk,
-              file,
-              position: indexToPosition(content, match.index),
+          // run regex against file content, return array of matches
+          const matches = Array.from(content.matchAll(matcher.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] = {
+              instances: [],
               ...matcher
+            };
+            allResults[matcher.title].instances.push({
+              sdk,
+              file: path.relative(process.cwd(), file),
+              position: indexToPosition(content, match.index, {
+                oneBased: true
+              })
             });
-            setResults(results);
           });
         });
       }
+      setStatus(`Scanning ${file}`);
+      setProgress(Math.ceil(idx / files.length * 100));
     })).then(() => {
+      setResults([...results, ...Object.keys(allResults).map(k => allResults[k])]);
       setComplete(true);
       if (results.length < 1) {
         setStatus('It looks like you have nothing you need to change, upgrade away!');
@@ -93,11 +108,11 @@ export default function Scan({
       console.error(err);
     });
   }, [matchers, files]);
-  return /*#__PURE__*/React.createElement(React.Fragment, null, complete ? /*#__PURE__*/React.createElement(Text, {
+  return /*#__PURE__*/React.createElement(React.Fragment, null, complete ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
     color: "green"
-  }, "\u2713 ", status) : /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(ProgressBar, {
-    value: progress
-  }), /*#__PURE__*/React.createElement(Text, null, status)), /*#__PURE__*/React.createElement(Newline, null), !!results.length && /*#__PURE__*/React.createElement(ExpandableList, {
+  }, "\u2713 ", status), /*#__PURE__*/React.createElement(Newline, null), !!results.length && /*#__PURE__*/React.createElement(ExpandableList, {
     items: results
-  }));
+  })) : /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(ProgressBar, {
+    value: progress
+  }), /*#__PURE__*/React.createElement(Text, null, status)));
 }

package/dist/util/expandable-list.js

@@ -1,7 +1,7 @@
 import React, { useReducer, useMemo } from 'react';
 import { Text, Newline, useInput, Box } from 'ink';
 import Link from 'ink-link';
-import Markdown from 'ink-markdown';
+import Markdown from '@jescalan/ink-markdown';
 
 // A listing of items which can be navigated with arrow keys and expanded/contracted
 // with space bar. Limits the number visible at a time to prevent rendering issues with
@@ -52,19 +52,25 @@ export default function ExpandableList({
     color: "blue"
   }, "Navigation Instructions:"), /*#__PURE__*/React.createElement(Text, null, "Navigate through items with \u2191 and \u2193 arrow keys. Expand the details of any item with space bar. \u2193 key on the last item goes to the next page, \u2191 on the first item goes to the previous page. To exit this interface, use \"control + c\"."), /*#__PURE__*/React.createElement(Newline, null), state.all.reduce((memo, item, idx) => {
     if (idx < state.visible[0] || idx >= state.visible[1]) return memo;
-    const loc = `${item.file}:${item.position.line}:${item.position.column}`;
+    const locations = item.instances.map(instance => `${instance.file}:${instance.position.line}:${instance.position.column}`);
     memo.push( /*#__PURE__*/React.createElement(Box, {
       borderStyle: item.focused ? 'double' : 'single',
       flexDirection: "column",
       borderColor: item.focused ? 'blue' : 'white',
       paddingX: 1,
-      key: loc
-    }, /*#__PURE__*/React.createElement(Markdown, null, item.title), /*#__PURE__*/React.createElement(Text, null, "Location: ", loc), item.expanded && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Markdown, null, item.content), /*#__PURE__*/React.createElement(Link, {
+      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, "See in migration guide \xBB")))));
+    }, /*#__PURE__*/React.createElement(Text, null, "Open in migration guide \xBB")))));
     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));
 }
+const Line = () => /*#__PURE__*/React.createElement(Box, {
+  borderStyle: "single",
+  borderRight: false,
+  borderLeft: false,
+  borderBottom: false
+});
 
 // I'd like to recognize that this logic is kinda crazy, but it works 💖
 function reducer(state, action) {
@@ -134,6 +140,7 @@ function reducer(state, action) {
       }
       return item;
     });
+    console.log(''); // this is strange but seems to solve a rendering bug
     return {
       all,
       visible: state.visible,

package/dist/versions/v5/common/afterswitchorganizationurl.md

@@ -0,0 +1,15 @@
+---
+title: '`afterSwitchOrganizationUrl` -> `afterSelectOrganizationUrl` in `OrganizationSwitcher`'
+matcher: '<OrganizationSwitcher.*?(afterSwitchOrganizationUrl)=.*?>'
+replaceWithString: 'afterSelectOrganizationUrl'
+---
+
+The `afterSwitchOrganizationUrl` prop on the `<OrganizationSwitcher />` component has been renamed to `afterSelectOrganizationUrl`. This is a quick and simple rename.
+
+```js
+// before
+<OrganizationSwitcher afterSwitchOrganizationUrl='...' />
+
+// after
+<OrganizationSwitcher afterSelectOrganizationUrl='...' />
+```

package/dist/versions/v5/common/appearance-organizationpreview-organizationswitcher.md

@@ -0,0 +1,8 @@
+---
+title: '`elements.organizationPreview__organizationSwitcher` -> `elements.organizationPreview__organizationSwitcherTrigger` in `<OrganizationSwitcher />` appearance prop'
+matcher: "<OrganizationSwitcher[\\s\\S]*?appearance={\\s*{\\s*elements:\\s*{\\s*(organizationPreview__organizationSwitcher)[\\s\\S]*?>"
+matcherFlags: 'm'
+replaceWithString: 'organizationPreview__organizationSwitcherTrigger'
+---
+
+If you are using `organizationPreview__organizationSwitcher` as an [appearance prop](https://clerk.com/docs/components/customization/overview#appearance-prop) value to the [`<OrganizationSwitcher />` component](https://clerk.com/docs/references/javascript/clerk/organization-switcher#organization-switcher-component), it must be updated to `organizationPreview__organizationSwitcherTrigger` instead. This is a simple text replacement. However, it should be noted that component designs have been updated as part of v5, so you may need to make adjustments to any appearance prop customizations that have been implemented as a whole.

package/dist/versions/v5/common/useorganization-invitationlist.md

@@ -0,0 +1,25 @@
+---
+title: '`invitationList` -> `invitations` as param to `useOrganizations`'
+matcher: "useOrganizations\\(\\s*{\\.*?invitationList:"
+matcherFlags: 'm'
+---
+
+The `invitationList` param to the `useOrganizations` hook has been replaced by `invitations`. This param also has a slightly different way of working, examples included below. Note also that `useOrganizations` is deprecated and should be updated to `useOrganization` instead.
+
+```js
+// before
+const { invitationList } = useOrganization({
+	invitationList: { limit: 10, offset: 1 },
+});
+
+// after
+const { invitations } = useOrganization({
+	invitations: {
+		initialPage: 1,
+		pageSize: 10,
+	},
+});
+
+// you can also simply return all invitations
+const { invitations } = useOrganization({ invitations: true });
+```

package/dist/versions/v5/common/useorganization-membershiplist.md

@@ -0,0 +1,24 @@
+---
+title: '`membershipList` -> `members` as param to `useOrganization`'
+matcher: "useOrganizations\\(\\s*{\\.*?membershipList:"
+---
+
+The `membershipList` param from the `useOrganization` hook has been removed. Instead, [use the `memberships` param](https://clerk.com/docs/references/react/use-organization#parameters). Examples of each can be seen here:
+
+```js
+// before
+const { membershipList } = useOrganization({
+	membershipList: { limit: 10, offset: 1 },
+});
+
+// after
+const { memberships } = useOrganization({
+	memberships: {
+		initialPage: 1,
+		pageSize: 10,
+	},
+});
+
+// you can also simply return all memberships
+const { memberships } = useOrganization({ memberships: true });
+```

package/dist/versions/v5/common/useorganizations.md

@@ -0,0 +1,26 @@
+---
+title: '`useOrganizations` -> `useOrganizationList`'
+matcher: "useOrganizations\\("
+---
+
+Any place where `useOrganizations` is used should be switched to [`useOrganizationList`](https://clerk.com/docs/references/react/use-organization-list) or [`useOrganization`](https://clerk.com/docs/references/react/use-organization) instead. The return signature has also changed, so take note of this when making the upgrade.
+
+```js
+// before: useOrganizations return values
+{
+    isLoaded: boolean,
+    createOrganization: clerk.createOrganization,
+    getOrganizationMemberships: clerk.getOrganizationMemberships,
+    getOrganization: clerk.getOrganization,
+}
+
+// after: useOrganizationList return values
+{
+    isLoaded: boolean,
+    createOrganization: clerk.createOrganization,
+    userMemberships: PaginatedResourcesWithDefault<...> | PaginatedResources<...>,
+    userInvitations: PaginatedResourcesWithDefault<...> | PaginatedResources<...>,
+    userSuggestions: PaginatedResourcesWithDefault<...> | PaginatedResources<...>,
+    setActive: clerk.setActive,
+}
+```

package/dist/versions/v5/common/userprofile-prop.md

@@ -0,0 +1,7 @@
+---
+title: '`userProfile` -> `userProfileProps` for `UserButton`'
+matcher: '<UserButton.*?(userProfile)=.*?>'
+replaceWithString: 'userProfileProps'
+---
+
+The `userProfile` prop on [the `UserButton` component](https://clerk.com/docs/references/javascript/clerk/user-button#user-button-component) has been changed to `userProfileProps`. This is purely a name change, none of the values need to be updated

package/dist/versions/v5/index.js

@@ -3,7 +3,7 @@ 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', 'setsession', 'navigate-to-routerpush-routerreplace', 'afterswitchorganizationurl', 'appearance-organizationpreview-organizationswitcher', 'useorganization-invitationlist', 'useorganization-membershiplist', 'useorganizations', 'userprofile-prop'];
 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']),
   // since we export clerk-react at the top level from the gatsby plugin
@@ -19,23 +19,15 @@ 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']),
+  'signup-attemptweb3walletverification-generatedsignature', 'redirecttohome']),
   shared: load('shared', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'buildrequesturl', 'organizationcontext', 'useorganizationlist-organizationlist' // shared outside this pkg?
   ]),
 

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/next/import-api-url.md

@@ -1,6 +1,6 @@
 ---
 title: '`API_URL` constant removed'
-matcher: "API_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?API_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-api-version.md

@@ -1,6 +1,6 @@
 ---
 title: '`API_VERSION` constant removed'
-matcher: "API_VERSION[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?API_VERSION[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-clerk-js-url.md

@@ -1,6 +1,6 @@
 ---
 title: '`CLERK_JS_URL` constant removed'
-matcher: "CLERK_JS_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?CLERK_JS_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

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

@@ -1,6 +1,6 @@
 ---
 title: '`CLERK_JS_VERSION` constant removed'
-matcher: "CLERK_JS_VERSION[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?CLERK_JS_VERSION[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-domain.md

@@ -1,6 +1,6 @@
 ---
 title: '`DOMAIN` constant removed'
-matcher: "DOMAIN[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?DOMAIN[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-is-satellite.md

@@ -1,6 +1,6 @@
 ---
 title: '`IS_SATELLITE` constant removed'
-matcher: "IS_SATELLITE[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?IS_SATELLITE[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-proxy-url.md

@@ -1,6 +1,6 @@
 ---
 title: '`PROXY_URL` constant removed'
-matcher: "PROXY_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?PROXY_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-publishable-key.md

@@ -1,6 +1,6 @@
 ---
 title: '`PUBLISHABLE_KEY` constant removed'
-matcher: "PUBLISHABLE_KEY[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?PUBLISHABLE_KEY[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-secret-key.md

@@ -1,6 +1,6 @@
 ---
 title: '`SECRET_KEY` constant removed'
-matcher: "SECRET_KEY[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?SECRET_KEY[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-sign-in-url.md

@@ -1,6 +1,6 @@
 ---
 title: '`SIGN_IN_URL` constant removed'
-matcher: "SIGN_IN_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?SIGN_IN_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/next/import-sign-up-url.md

@@ -1,6 +1,6 @@
 ---
 title: '`SIGN_UP_URL` constant removed'
-matcher: "SIGN_UP_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+matcher: "import\\s+{[\\s\\S]*?SIGN_UP_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
 ---
 
 This deprecated constant has been removed as an export from `@clerk/nextjs`. We recommend setting the `NEXT_PUBLIC_CLERK_SIGN_UP_URL` environment variable and using this instead.

package/dist/versions/v5/react/afterswitchorganizationurl.md

@@ -0,0 +1,15 @@
+---
+title: '`afterSwitchOrganizationUrl` -> `afterSelectOrganizationUrl` in `OrganizationSwitcher`'
+matcher: '<OrganizationSwitcher.*?(afterSwitchOrganizationUrl)=.*?>'
+replaceWithString: 'afterSelectOrganizationUrl'
+---
+
+The `afterSwitchOrganizationUrl` prop on the `<OrganizationSwitcher />` component has been renamed to `afterSelectOrganizationUrl`. This is a quick and simple rename.
+
+```js
+// before
+<OrganizationSwitcher afterSwitchOrganizationUrl='...' />
+
+// after
+<OrganizationSwitcher afterSelectOrganizationUrl='...' />
+```

package/dist/versions/v5/react/appearance-organizationpreview-organizationswitcher.md

@@ -0,0 +1,8 @@
+---
+title: '`elements.organizationPreview__organizationSwitcher` -> `elements.organizationPreview__organizationSwitcherTrigger` in `<OrganizationSwitcher />` appearance prop'
+matcher: "<OrganizationSwitcher[\\s\\S]*?appearance={\\s*{\\s*elements:\\s*{\\s*(organizationPreview__organizationSwitcher)[\\s\\S]*?>"
+matcherFlags: 'm'
+replaceWithString: 'organizationPreview__organizationSwitcherTrigger'
+---
+
+If you are using `organizationPreview__organizationSwitcher` as an [appearance prop](https://clerk.com/docs/components/customization/overview#appearance-prop) value to the [`<OrganizationSwitcher />` component](https://clerk.com/docs/references/javascript/clerk/organization-switcher#organization-switcher-component), it must be updated to `organizationPreview__organizationSwitcherTrigger` instead. This is a simple text replacement. However, it should be noted that component designs have been updated as part of v5, so you may need to make adjustments to any appearance prop customizations that have been implemented as a whole.

package/dist/versions/v5/react/useorganization-invitationlist.md

@@ -0,0 +1,25 @@
+---
+title: '`invitationList` -> `invitations` as param to `useOrganizations`'
+matcher: "useOrganizations\\(\\s*{\\.*?invitationList:"
+matcherFlags: 'm'
+---
+
+The `invitationList` param to the `useOrganizations` hook has been replaced by `invitations`. This param also has a slightly different way of working, examples included below. Note also that `useOrganizations` is deprecated and should be updated to `useOrganization` instead.
+
+```js
+// before
+const { invitationList } = useOrganization({
+	invitationList: { limit: 10, offset: 1 },
+});
+
+// after
+const { invitations } = useOrganization({
+	invitations: {
+		initialPage: 1,
+		pageSize: 10,
+	},
+});
+
+// you can also simply return all invitations
+const { invitations } = useOrganization({ invitations: true });
+```

package/dist/versions/v5/react/useorganization-membershiplist.md

@@ -0,0 +1,24 @@
+---
+title: '`membershipList` -> `members` as param to `useOrganization`'
+matcher: "useOrganizations\\(\\s*{\\.*?membershipList:"
+---
+
+The `membershipList` param from the `useOrganization` hook has been removed. Instead, [use the `memberships` param](https://clerk.com/docs/references/react/use-organization#parameters). Examples of each can be seen here:
+
+```js
+// before
+const { membershipList } = useOrganization({
+	membershipList: { limit: 10, offset: 1 },
+});
+
+// after
+const { memberships } = useOrganization({
+	memberships: {
+		initialPage: 1,
+		pageSize: 10,
+	},
+});
+
+// you can also simply return all memberships
+const { memberships } = useOrganization({ memberships: true });
+```

package/dist/versions/v5/react/useorganizations.md

@@ -0,0 +1,26 @@
+---
+title: '`useOrganizations` -> `useOrganizationList`'
+matcher: "useOrganizations\\("
+---
+
+Any place where `useOrganizations` is used should be switched to [`useOrganizationList`](https://clerk.com/docs/references/react/use-organization-list) or [`useOrganization`](https://clerk.com/docs/references/react/use-organization) instead. The return signature has also changed, so take note of this when making the upgrade.
+
+```js
+// before: useOrganizations return values
+{
+    isLoaded: boolean,
+    createOrganization: clerk.createOrganization,
+    getOrganizationMemberships: clerk.getOrganizationMemberships,
+    getOrganization: clerk.getOrganization,
+}
+
+// after: useOrganizationList return values
+{
+    isLoaded: boolean,
+    createOrganization: clerk.createOrganization,
+    userMemberships: PaginatedResourcesWithDefault<...> | PaginatedResources<...>,
+    userInvitations: PaginatedResourcesWithDefault<...> | PaginatedResources<...>,
+    userSuggestions: PaginatedResourcesWithDefault<...> | PaginatedResources<...>,
+    setActive: clerk.setActive,
+}
+```

package/dist/versions/v5/react/userprofile-prop.md

@@ -0,0 +1,7 @@
+---
+title: '`userProfile` -> `userProfileProps` for `UserButton`'
+matcher: '<UserButton.*?(userProfile)=.*?>'
+replaceWithString: 'userProfileProps'
+---
+
+The `userProfile` prop on [the `UserButton` component](https://clerk.com/docs/references/javascript/clerk/user-button#user-button-component) has been changed to `userProfileProps`. This is purely a name change, none of the values need to be updated

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@clerk/upgrade",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"license": "MIT",
 	"type": "module",
 	"bin": "dist/cli.js",
@@ -27,6 +27,7 @@
 	},
 	"dependencies": {
 		"@inkjs/ui": "^1.0.0",
+		"@jescalan/ink-markdown": "^2.0.0",
 		"globby": "^14.0.0",
 		"gray-matter": "^4.0.3",
 		"index-to-position": "^0.1.2",
@@ -34,7 +35,6 @@
 		"ink-big-text": "^2.0.0",
 		"ink-gradient": "^3.0.0",
 		"ink-link": "^3.0.0",
-		"ink-markdown": "jescalan/ink-markdown#release",
 		"marked": "^11.1.1",
 		"meow": "^11.0.0",
 		"react": "^18.2.0",