@clerk/upgrade 0.1.1 → 0.2.1

package/dist/app.js

@@ -1,13 +1,12 @@
+import { MultiSelect, Select, TextInput } from '@inkjs/ui';
+import { Newline, Text } from 'ink';
+import BigText from 'ink-big-text';
+import Gradient from 'ink-gradient';
 import React, { useState } from 'react';
-import { Text, Newline } from 'ink';
-import { Select, MultiSelect, TextInput } from '@inkjs/ui';
 import SDKS from './constants/sdks.js';
-import VERSIONS from './constants/versions.js';
 import Scan from './scan.js';
-import guessFrameworks from './util/guess-framework.js';
 import getClerkMajorVersion from './util/get-clerk-version.js';
-import Gradient from 'ink-gradient';
-import BigText from 'ink-big-text';
+import guessFrameworks from './util/guess-framework.js';
 export default function App({
   _fromVersion,
   _toVersion,
@@ -15,7 +14,8 @@ export default function App({
   _dir = false,
   _ignore = [],
   _yolo = false,
-  noWarnings = false
+  noWarnings = false,
+  disableTelemetry = false
 }) {
   const [yolo, setYolo] = useState(_yolo);
   const [sdks, setSdks] = useState(_sdk ? [_sdk] : []);
@@ -23,12 +23,13 @@ export default function App({
   const [sdkGuessConfirmed, setSdkGuessConfirmed] = useState(false);
   const [sdkGuessAttempted, setSdkGuessAttempted] = useState(false);
   const [fromVersion, setFromVersion] = useState(_fromVersion);
-  const [fromVersionGuessAttempted, fromVersionSdkGuessAttempted] = useState(false);
+  const [fromVersionGuessAttempted, setFromVersionGuessAttempted] = useState(false);
   const [toVersion, setToVersion] = useState(_toVersion);
   const [dir, setDir] = useState(_dir);
   const [ignore, setIgnore] = useState(_ignore);
   const [configComplete, setConfigComplete] = useState(false);
   const [configVerified, setConfigVerified] = useState(false);
+  const [uuid, setUuid] = useState();
   let fromVersionGuess = false;
   if (yolo) {
     setSdks(SDKS.map(s => s.value));
@@ -38,7 +39,12 @@ export default function App({
   // We try to guess which SDK they are using
   if (isEmpty(sdks) && isEmpty(sdkGuesses) && !sdkGuessAttempted) {
     if (!dir) return setDir(process.cwd());
-    setSdkGuesses(guessFrameworks(dir)); // this is the suspect line
+    const {
+      guesses,
+      _uuid
+    } = guessFrameworks(dir, disableTelemetry);
+    setUuid(_uuid);
+    setSdkGuesses(guesses);
     setSdkGuessAttempted(true);
   }
 
@@ -128,14 +134,16 @@ export default function App({
         setConfigVerified(true);
       }
     }
-  })), configVerified && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Scan, {
+  })), configVerified && /*#__PURE__*/React.createElement(Scan, {
     fromVersion,
     toVersion,
     sdks,
     dir,
     ignore,
-    noWarnings
-  })));
+    noWarnings,
+    uuid,
+    disableTelemetry
+  }));
 }
 
 // small util to make the logic blocks easier to visually parse

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
-import React from 'react';
 import { render } from 'ink';
 import meow from 'meow';
+import React from 'react';
 import App from './app.js';
 import sdks from './constants/sdks.js';
 const cli = meow(`
@@ -9,12 +9,13 @@ 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
-			--noWarnings   Do not print warnings, only items that must be fixed
+			--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
+			--disableTelemetry Do not send anonymous usage telemetry
 
 		Examples
 		  $ clerk-upgrade --sdk=nextjs --dir=src/**
@@ -45,6 +46,9 @@ const cli = meow(`
     },
     noWarnings: {
       type: 'boolean'
+    },
+    disableTelemetry: {
+      type: 'boolean'
     }
   }
 });
@@ -54,7 +58,8 @@ render( /*#__PURE__*/React.createElement(App, {
   _sdk: cli.flags.sdk,
   _dir: cli.flags.dir,
   _yolo: cli.flags.yolo,
-  noWarnings: cli.flags.noWarnings
+  noWarnings: cli.flags.noWarnings,
+  disableTelemetry: cli.flags.disableTelemetry
 })
 // { debug: true }, if having issues with errors being swallowed, uncomment this
 );

package/dist/scan.js

@@ -1,10 +1,10 @@
-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 fs from 'fs/promises';
+import { globby } from 'globby';
 import indexToPosition from 'index-to-position';
+import { Newline, Text } from 'ink';
+import path from 'path';
+import React, { useEffect, useState } from 'react';
 import ExpandableList from './util/expandable-list.js';
 export default function Scan({
   fromVersion,
@@ -12,7 +12,9 @@ export default function Scan({
   sdks,
   dir,
   ignore,
-  noWarnings
+  noWarnings,
+  uuid,
+  disableTelemetry
 }) {
   // 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,
@@ -40,7 +42,7 @@ export default function Scan({
         return m;
       }, {}));
     });
-  }, [toVersion]);
+  }, [toVersion, sdks]);
 
   // Get all files from the glob matcher
   // -----------------------------------
@@ -62,7 +64,6 @@ export default function Scan({
   // Read files and scan regexes
   // ---------------------------
   // result = `results` set to format
-  //
   useEffect(() => {
     if (!matchers || !files) return;
     const allResults = {};
@@ -87,21 +88,28 @@ export default function Scan({
           }
           if (matches.length < 1) return;
 
-          // for each match, add to `instances` array of a key, create if not exists
+          // for each match, add to `instances` array
           matches.map(match => {
             if (noWarnings && matcherConfig.warning) return;
+
+            // create if not exists
             if (!allResults[matcherConfig.title]) allResults[matcherConfig.title] = {
               instances: [],
               ...matcherConfig
             };
+            const position = indexToPosition(content, match.index, {
+              oneBased: true
+            });
+            const fileRelative = path.relative(process.cwd(), file);
 
-            // TODO: there's a small bug where we can see multiple instances of the same position
+            // when scanning for multiple SDKs, you can get a double match, this logic ensures you don't
+            if (allResults[matcherConfig.title].instances.filter(i => {
+              return i.position.line === position.line && i.position.column === position.column && i.file === fileRelative;
+            }).length > 0) return;
             allResults[matcherConfig.title].instances.push({
               sdk,
-              file: path.relative(process.cwd(), file),
-              position: indexToPosition(content, match.index, {
-                oneBased: true
-              })
+              position,
+              file: fileRelative
             });
           });
         });
@@ -109,7 +117,42 @@ export default function Scan({
       setStatus(`Scanning ${file}`);
       setProgress(Math.ceil(idx / files.length * 100));
     })).then(() => {
-      setResults([...results, ...Object.keys(allResults).map(k => allResults[k])]);
+      const newResults = [...results, ...Object.keys(allResults).map(k => allResults[k])];
+      setResults(newResults);
+
+      // Anonymously track how many instances of each breaking change item were encountered.
+      // This only tracks the name of the breaking change found, and how many instances of it
+      // were found. It does not send any part of the scanned codebase or any PII.
+      // It is used internally to help us understand what the most common sticking points are
+      // for our users so we can appropriate prioritize support/guidance/docs around them.
+      if (!disableTelemetry) {
+        fetch('https://api.segment.io/v1/batch', {
+          method: 'POST',
+          headers: {
+            Authorization: `Basic ${Buffer.from('5TkC1SM87VX2JRJcIGBBmL7sHLRWaIvc:').toString('base64')}`,
+            'Content-Type': 'application/json'
+          },
+          body: JSON.stringify({
+            batch: newResults.map(item => {
+              return {
+                type: 'track',
+                userId: 'clerk-upgrade-tool',
+                event: 'Clerk Migration Tool_CLI_Breaking Change Found',
+                properties: {
+                  appId: `cmt_${uuid}`,
+                  surface: 'Clerk Migration Tool',
+                  location: 'CLI',
+                  title: item.title,
+                  instances: item.instances.length,
+                  fromVersion,
+                  toVersion
+                },
+                timestamp: new Date().toISOString()
+              };
+            })
+          })
+        });
+      }
       setComplete(true);
       if (Object.keys(allResults).length < 1) {
         setStatus('It looks like you have nothing you need to change, upgrade away!');
@@ -119,12 +162,12 @@ export default function Scan({
     }).catch(err => {
       console.error(err);
     });
-  }, [matchers, files]);
-  return /*#__PURE__*/React.createElement(React.Fragment, null, complete ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
+  }, [matchers, files, noWarnings]);
+  return complete ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
     color: "green"
   }, "\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)));
+  }), /*#__PURE__*/React.createElement(Text, null, status));
 }

package/dist/util/expandable-list.js

@@ -1,7 +1,6 @@
-import React, { useReducer, useMemo } from 'react';
-import { Text, Newline, useInput, Box } from 'ink';
-import Link from 'ink-link';
 import Markdown from '@jescalan/ink-markdown';
+import { Box, Newline, Text, useInput } from 'ink';
+import React, { useReducer } from 'react';
 
 // 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
@@ -59,7 +58,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(Line, null)), item.warning && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
+    }, /*#__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, {
+      key: loc
+    }, '  ', "- ", 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;

package/dist/util/generate-changelog.js

@@ -1,5 +1,5 @@
-import SDKS from '../constants/sdks.js';
 import { parseInline } from 'marked';
+import SDKS from '../constants/sdks.js';
 const VERSION = 'v5';
 async function generate() {
   let output = '';

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

@@ -1,6 +1,3 @@
-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

package/dist/util/guess-framework.js

@@ -1,27 +1,63 @@
+import { randomUUID } from 'crypto';
+import fs from 'fs';
+import md5 from 'md5';
+import path from 'path';
 import { readPackageSync } from 'read-pkg';
+import tempDir from 'temp-dir';
 import SDKS from '../constants/sdks.js';
-export default function guessFrameworks(dir) {
+
+// Telemetry Note
+// --------------
+// We collect fully anonymous telemetry as part of this tool. The only data we send is which
+// breaking changes were detected in your app scan. This data helps us to know what the most often
+// encountered issues are so that we can prioritize documentation and support for these areas.
+// We do not send any information from your source code or any PII as part of the telemetry.
+
+export default function guessFrameworks(dir, disableTelemetry) {
   let pkg;
   try {
     pkg = readPackageSync({
       cwd: dir
     });
   } catch (err) {
-    return [];
+    const tmpPath = path.join(tempDir, 'clerk-upgrade-uuid');
+    let uuid;
+    if (!disableTelemetry) {
+      // if there's no package.json, create a uuid in tempfile so that multiple runs on the same app can be consolidated
+      if (fs.existsSync(tmpPath)) {
+        uuid = fs.readFileSync(tmpPath, 'utf8');
+      } else {
+        uuid = randomUUID();
+        fs.writeFileSync(tmpPath, uuid);
+      }
+    }
+    return {
+      guesses: [],
+      _uuid: uuid
+    };
   }
 
+  // if there is a package.json
+  const _uuid = md5(pkg);
+
   // no guessing if there are no deps
-  if (!pkg.dependencies && !pkg.devDependencies) return [];
+  if (!pkg.dependencies && !pkg.devDependencies) return {
+    guesses: [],
+    _uuid
+  };
   const deps = pkg.dependencies ? Object.keys(pkg.dependencies) : [];
   const devDeps = pkg.devDependencies ? Object.keys(pkg.devDependencies) : [];
-  return SDKS.reduce((m, {
-    label,
-    value
-  }) => {
-    if (deps.includes(label) || devDeps.includes(label)) m.push({
+  return {
+    _uuid,
+    guesses: SDKS.reduce((m, {
       label,
       value
-    });
-    return m;
-  }, []);
+    }) => {
+      if (deps.includes(label) || devDeps.includes(label)) m.push({
+        label,
+        value
+      });
+      return m;
+    }, [])
+  };
 }

package/dist/util/load-change.js

@@ -1,6 +1,6 @@
 import fs from 'fs';
-import path from 'path';
 import matter from 'gray-matter';
+import path from 'path';
 import { fileURLToPath } from 'url';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 export default function createLoader({

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

@@ -2,6 +2,7 @@
 title: '`API_URL` value has changed'
 matcher: "API_URL[\\s\\S]*?from\\s+['\"]@clerk\\/backend\\/constants['\"]"
 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/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/createclerkclient-frontendapi.md

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

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

@@ -1,9 +1,9 @@
 ---
 title: '`pkgVersion` -> `clerkJSVersion`'
 matcher:
-  - "loadInterstitialFromLocal\\([\\s\\S]*?pkgVersion:"
-  - "loadInterstitialFromBAPI\\([\\s\\S]*?pkgVersion:"
-  - "buildPublicInterstitialUrl\\([\\s\\S]*?pkgVersion:"
+  - "loadInterstitialFromLocal\\([\\s\\S]*?pkgVersion:[\\s\\S]*?\\)"
+  - "loadInterstitialFromBAPI\\([\\s\\S]*?pkgVersion:[\\s\\S]*?\\)"
+  - "buildPublicInterstitialUrl\\([\\s\\S]*?pkgVersion:[\\s\\S]*?\\)"
 matcherFlags: 'm'
 ---
 

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

@@ -7,10 +7,7 @@ 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='...' />
+```diff
+- <OrganizationSwitcher afterSwitchOrganizationUrl='...' />
++ <OrganizationSwitcher afterSelectOrganizationUrl='...' />
 ```

package/dist/versions/v5/common/getorganizationinvitationlist-return-type-change.md

@@ -0,0 +1,14 @@
+---
+title: '`Organization.getOrganizationInvitationList()` return type changed'
+matcher: "\\.getOrganizationInvitationList\\("
+---
+
+The return type for this function was previously `[Items]` but has now been updated to `{ data: [Items], totalCount: number }`. Since Clerk's API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:
+
+```diff
+  const { organization } = useOrganization()
+  const inviteList = organization.getOrganizationInvitationList()
+
+- inviteList.forEach(() => {})
++ inviteList.data.forEach(() => {})
+```

package/dist/versions/v5/common/getorganizationlist-return-type-change.md

@@ -0,0 +1,14 @@
+---
+title: '`Organization.getOrganizationList()` return type changed'
+matcher: "\\.getOrganizationList\\("
+---
+
+The return type for this function was previously `[Items]` but has now been updated to `{ data: [Items], totalCount: number }`. Since Clerk's API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:
+
+```diff
+  const { organization } = useOrganization()
+  const orgList = organization.getOrganizationList()
+
+- orgList.forEach(() => {})
++ orgList.data.forEach(() => {})
+```

package/dist/versions/v5/common/getorganizationmembershiplist-return-type-change.md

@@ -0,0 +1,14 @@
+---
+title: '`User.getOrganizationMembershipList()` return type changed'
+matcher: "\\.getOrganizationMembershipList\\("
+---
+
+The return type for this function was previously `[Items]` but has now been updated to `{ data: [Items], totalCount: number }`. Since Clerk's API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily. A before/after code example can be seen below:
+
+```diff
+  const { user } = useUser()
+  const membershipList = user.getOrganizationMembershipList()
+
+- membershipList.forEach(() => {})
++ membershipList.data.forEach(() => {})
+```

package/dist/versions/v5/common/getroles-pagination.md

@@ -0,0 +1,15 @@
+---
+title: 'Pagination parameters changed for `Organization.getRoles()`'
+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
+  const { data } = await organization.getRoles({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

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

@@ -4,4 +4,4 @@ matcher: 'handleMagicLinkVerification'
 replaceWithString: 'handleMagicLinkVerification'
 ---
 
-Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects the functionality.
+Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects functionality.

package/dist/versions/v5/common/min-react-version.md

@@ -0,0 +1,6 @@
+---
+title: 'Upgrade react to v18 or higher'
+matcher: "dependencies\":\\s*{[\\s\\S]*?\"react\":\\s*\"(?:^|~|>|=|\\s)*(?:12|13|14|15|16|17)\\..*?"
+---
+
+If you're using `react`, you will need to update your Next.js project to `v18` or later to ensure that the latest version of Clerk's SDKs work properly.

package/dist/versions/v5/common/navigate-to-routerpush-routerreplace.md

@@ -1,16 +1,18 @@
 ---
-title: '`navigate` prop replaced by `routerPush` and `routerReplace`'
+title: '`navigate` prop to `ClerkProvider` replaced by `routerPush` and `routerReplace`'
 matcher: "<ClerkProvider[\\s\\S]*?navigate=[\\s\\S]*?>"
 matcherFlags: 'm'
 ---
 
-The `navigate` prop on `<ClerkProvider>` allowed developers to override the default navigation behavior with a custom function. However, `navigate` was only able to push, not replace routes. The router is now able to do both, and as such, the props for `<ClerkProvider>` were updated. The `routerPush` and `routerReplace` props replace the old `navigate` prop.
+The `navigate` prop on ClerkProvider allowed developers to override the default navigation behavior with a custom function. However, navigate was only able to push, not replace routes. We have now added the capability for the router to push or replace, and as such, upgraded the provider prop so that it can handle either depending on the circumstance.
 
-For more information on what push and replace mean in relation to the browser history api, check out the ["Working with the History API"](https://developer.mozilla.org/en-US/docs/Web/API/History_API/Working_with_the_History_API) docs.
+Two new props have been added to `ClerkProvider` that replace the single `navigate` prop, and can be used to override the default navigation behavior for either a push or replace navigation. For more information on what push and replace mean in relation to the browser history api, [check out these wonderful MDN docs](https://developer.mozilla.org/en-US/docs/Web/API/History_API/Working_with_the_History_API).
 
-If you’d like to keep the same behavior as you had with the single `navigate` prop, pass the exact same function to both `routerPush` and `routerReplace`. For example:
+If you’d like to keep the same behavior as you had with the single `navigate` prop, pass the exact same function to both `routerPush` and `routerReplace` and the behavior will be identical. For example:
 
 ```diff
-- <ClerkProvider navigate={x => x} />
-+ <ClerkProvider routerPush={x => x} routerReplace={x => x} />
+- <ClerkProvider navigate={ x => x } />
++ <ClerkProvider routerPush={ x => x } routerReplace={ x => x } />
 ```
+
+However, you now have the option to differentiate behavior based on whether the navigation will be a push or replace.

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

@@ -6,12 +6,7 @@ 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({
+  const { data } = await organization.getDomains({
 -   limit: 10,
 +   pageSize: 10,
 -   offset: 10,

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

@@ -0,0 +1,15 @@
+---
+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
+  const { data } = await organization.getInvitations({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

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

@@ -6,12 +6,7 @@ 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({
+  const { data } = await organization.getMembershipRequests({
 -   limit: 10,
 +   pageSize: 10,
 -   offset: 10,

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

@@ -0,0 +1,15 @@
+---
+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
+  const { data } = await organization.getMemberships({
+-   limit: 10,
++   pageSize: 10,
+-   offset: 10,
++   initialPage: 2,
+  })
+```

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

@@ -6,12 +6,7 @@ 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({
+  const { data } = await organization.getRoles({
 -   limit: 10,
 +   pageSize: 10,
 -   offset: 10,

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

@@ -24,6 +24,7 @@ await setActive({
   organization: 'orgID',
   beforeEmit: () => void
 })
+
 await setActive({
   session: sessionObj,
   organization: orgObj,