@clerk/upgrade 0.2.0 → 0.3.0

package/dist/guide-generators/v5-guides/shared/path-routing.mdx

@@ -0,0 +1,50 @@
+### Path routing is now the default
+
+On components like [`<SignIn />`](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used.
+
+In the latest version, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are:
+
+- `<SignIn />`
+- `<SignUp />`
+- `<UserProfile />`
+- `<CreateOrganization />`
+- `<OrganizationProfile />`
+
+Here's how you'd use the components going forward:
+
+```jsx
+<SignIn path="/sign-in" />
+<SignUp path="/sign-up" />
+<UserProfile path="/user-profile" />
+<CreateOrganization path="/create-org" />
+<OrganizationProfile path="/org-profile" />
+```
+
+If you don't define the `path` prop an error will be thrown. Of course, you can still use `routing="hash"` or `routing="virtual"`.
+
+```jsx
+<UserProfile routing="hash" />
+<OrganizationProfile routing="virtual" />
+```
+
+However, there are two exceptions to this behavior. If you're using `@clerk/nextjs` or `@clerk/remix`, you can set environment variables for `<SignIn />` and `<SignUp />`.
+
+<CodeBlockTabs options={["Next.js", "Remix"]}>
+```env filename=".env.local"
+NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
+NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
+```
+
+```env filename=".env"
+CLERK_SIGN_IN_URL=/sign-in
+CLERK_SIGN_UP_URL=/sign-up
+```
+</CodeBlockTabs>
+
+**Only** if you're using one of these two frameworks and defined both environment variables, you're able to use the `<SignIn />` and `<SignUp />` components without any props.
+
+```jsx
+// Only works for Next.js / Remix when environment variables are set
+<SignIn />
+<SignUp />
+```

package/dist/guide-generators/v5-guides/shared/prepare.mdx

@@ -0,0 +1,7 @@
+## Preparing to upgrade
+
+Before uprading, it's highly recommended that you update your Clerk SDKs to the latest v4 version. Some changes required for v5 can be applied incrementally to the latest v4, which should contribute to a smoother upgrading experience.
+
+After updating, look out for deprecation messages in your terminal and browser console. By resolving these deprecations you'll be able to skip many breaking changes for v5.
+
+Additionally, some of the minumum version requirements for some base dependencies have been updated such that versions that are no longer supported or are at end-of-life are no longer guaranteed to work correctly with Clerk.

package/dist/guide-generators/v5-guides/shared/react-version.mdx

@@ -0,0 +1,19 @@
+**Updating React**
+
+All react-dependent Clerk SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`.
+
+<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+    ```bash filename="terminal"
+    npm install react@latest react-dom@latest
+    ```
+
+    ```bash filename="terminal"
+    yarn add react@latest react-dom@latest
+    ```
+
+    ```bash filename="terminal"
+    pnpm add react@latest react-dom@latest
+    ```
+</CodeBlockTabs>
+
+If you are upgrading from React 17 or lower, make sure to [learn about how to upgrade your React version to 18](https://react.dev/blog/2022/03/08/react-18-upgrade-guide) as well.

package/dist/guide-generators/v5-guides/shared/redesign-preview.mdx

@@ -0,0 +1,5 @@
+### Component design adjustments
+
+The new version ships with improved design and UX across all of Clerk's [UI components](/docs/components/overview). If you have used the [`appearance` prop](/docs/components/customization/overview) or tokens for a [custom theme](/docs/components/customization/overview#create-a-custom-theme), you will likely need to make some adjustments to ensure your styling is still looking great. If you're using the [localization prop](/docs/components/customization/localization) you will likely need to make adjustments to account for added or removed localization keys.
+
+[More detail on these changes »](#redesigned-components)

package/dist/guide-generators/v5-guides/shared/update-v5.mdx

@@ -0,0 +1,17 @@
+## Updating to v5
+
+Whenever you feel ready, go ahead and install the latest beta version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. Some examples for how to unstall commonly used SDKs are below:
+
+<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+    ```bash filename="terminal"
+    npm install <%= packageName %>@beta
+    ```
+
+    ```bash filename="terminal"
+    yarn add <%= packageName %>@beta
+    ```
+
+    ```bash filename="terminal"
+    pnpm add <%= packageName %>@beta
+    ```
+</CodeBlockTabs>

package/dist/guide-generators/v5-guides/shared/upgrade-v5.mdx

@@ -0,0 +1,17 @@
+## Updating to v5
+
+Whenever you feel ready, go ahead and install the latest beta version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. Some examples for how to unstall commonly used SDKs are below:
+
+<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+    ```bash filename="terminal"
+    npm install <%= packageName %>@beta
+    ```
+
+    ```bash filename="terminal"
+    yarn add <%= packageName %>@beta
+    ```
+
+    ```bash filename="terminal"
+    pnpm add <%= packageName %>@beta
+    ```
+</CodeBlockTabs>

package/dist/scan.js

@@ -140,10 +140,12 @@ export default function Scan({
                 event: 'Clerk Migration Tool_CLI_Breaking Change Found',
                 properties: {
                   appId: `cmt_${uuid}`,
-                  title: item.title,
                   surface: 'Clerk Migration Tool',
                   location: 'CLI',
-                  instances: item.instances.length
+                  title: item.title,
+                  instances: item.instances.length,
+                  fromVersion,
+                  toVersion
                 },
                 timestamp: new Date().toISOString()
               };

package/dist/util/load-change.js

@@ -25,6 +25,7 @@ export default function createLoader({
         sdk: sdk,
         content: parsed.content,
         warning: fm.warning,
+        category: fm.category,
         link: `${baseUrl}#${slug}`
       };
     });

package/dist/util/text-generation.js

@@ -0,0 +1,29 @@
+import { readFileSync } from 'fs';
+import { parseInline } from 'marked';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+export function renderFrontmatter(obj) {
+  return `---
+${Object.keys(obj).map(k => `${k}: "${obj[k]}"`).join('\n')}
+---`;
+}
+export function renderMarkdown(p) {
+  return readFileSync(path.join(__dirname, p + '.mdx'), 'utf8').trim();
+}
+export function renderSingleItem(slug, data) {
+  const item = data.find(i => i.slug === slug);
+  return `#### ${item.title}
+
+${item.content.trim()}`;
+}
+export function renderAccordionForCategory(data, categories, options = {}) {
+  const items = data.filter(i => [].concat(categories).includes(i.category));
+  if (options.additionalItems) items.push(...[].concat(options.additionalItems));
+  return `<Accordion titles={[${items.map(i => `"${parseInline(i.title)}"`).join(', ')}]}>
+${items.map(i => `  <AccordionPanel>${indent('\n' + i.content.trim(), 4)}\n  </AccordionPanel>`).join('\n')}
+</Accordion>`;
+}
+function indent(str, numSpaces) {
+  return str.split('\n').map(l => `${' '.repeat(numSpaces)}${l}`).join('\n');
+}

package/dist/util/v5-guide/deprecation-removals.mdx

@@ -0,0 +1,7 @@
+As part of this major version, a number of previously deprecated props, arugments, methods, etc have been removed. Additionally there have been some changes to things that are only used internally, or only used very rarely. It's highly unlikely that any given app will encounter any of these items, but they are all breaking changes, so they have all been documented below.
+
+<Callout type='info'>
+  For this section more than any other one, please use the CLI upgrade tool (`npx @clerk/upgrade`). There
+  are a lot of changes, each of which are very unlikely to appear in your codebase, that would take a very long time to
+  look for manually.
+</Callout>

package/dist/util/v5-guide/generate.js

@@ -0,0 +1,200 @@
+import { renderAccordionForCategory, renderFrontmatter, renderMarkdown, renderSingleItem } from '../text-generation.js';
+async function generate() {
+  const data = (await import(`../../versions/v5/index.js`)).default;
+  let output = '';
+  output += renderFrontmatter({
+    title: 'Upgrading from v4 to v5',
+    description: 'Learn how to upgrade from version 4 to version 5 of the Clerk JavaScript libraries.'
+  });
+  output += '\n\n';
+  output += renderMarkdown('v5-guide/intro');
+  output += '\n\n';
+  output += renderMarkdown('v5-guide/prepare');
+  output += '\n\n';
+  output += renderMarkdown('v5-guide/per-sdk');
+  output += '\n\n';
+
+  // ------------------------------------------------------------
+
+  output += '### Remix';
+  output += '\n\n';
+
+  // Error boundary removal
+  output += renderSingleItem('clerkerrorboundary-removed', data.remix);
+  output += '\n\n';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.remix);
+
+  // ------------------------------------------------------------
+
+  // TODO: I'm not sure we're actually releasing the gatsby changes in v5, should double check this
+  output += '### Gatsby';
+  output += '\n\n';
+
+  // withServerAuth type change
+  output += renderSingleItem('withserverauth-return-type', data.gatsby);
+  output += '\n\n';
+
+  // error import path changes
+  // TODO: need to figure out how widely this applies ⚠️
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.gatsby);
+
+  // ------------------------------------------------------------
+
+  output += '### Expo';
+  output += '\n\n';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.expo);
+
+  // ------------------------------------------------------------
+
+  output += '### Fastify';
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.fastify);
+
+  // ------------------------------------------------------------
+
+  output += '### Node';
+  output += '\n\n';
+
+  // TODO: plans to deprecate this package in favor of backend/express - maybe?
+
+  // cjs/esm imports
+  output += renderSingleItem('cjs-esm-instance', data.node);
+  output += '\n\n';
+
+  // createClerkClient options instead of setter methods
+  output += renderMarkdown('v5-guide/node-setters-removals');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.node);
+
+  // ------------------------------------------------------------
+
+  output += '### React';
+  output += '\n\n';
+
+  // path routing (TODO: this should be linked to from other react SDKs)
+  output += renderMarkdown('v5-guide/path-routing');
+  output += '\n\n';
+
+  // routerPush/routerReplace
+  output += renderSingleItem('navigate-to-routerpush-routerreplace', data.react);
+  output += '\n\n';
+
+  // useOrganizationsList
+  output += renderSingleItem('useorganizations', data.react);
+  output += '\n\n';
+
+  // HOF removals (TODO: this applies to all react sdks, should be shared section)
+  output += renderMarkdown('v5-guide/hof-removals');
+  output += '\n\n';
+  output += renderAccordionForCategory(data.react, 'hof-removal');
+  output += '\n\n';
+
+  // error import paths
+  // TODO: applies to all sdks, make a shared section
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.react);
+
+  // ------------------------------------------------------------
+
+  output += '### Javascript';
+  output += '\n\n';
+
+  // pagination params
+  output += renderMarkdown('v5-guide/pagination-args');
+  output += '\n\n';
+  output += renderAccordionForCategory(data.js, 'pagination-args');
+  output += '\n\n';
+
+  // data/totalCount return values
+  output += renderMarkdown('v5-guide/pagination-return');
+  output += '\n\n';
+  output += renderAccordionForCategory(data.js, 'pagination-return');
+  output += '\n\n';
+
+  // ------------------------------------------------------------
+
+  output += '### Backend';
+  output += '\n\n';
+
+  // ------------------------------------------------------------
+
+  output += '### Chrome Extension';
+  output += '\n\n';
+
+  // ------------------------------------------------------------
+
+  // Component redesign, shared section
+  output += renderMarkdown('v5-guide/redesigned-components');
+  output += '\n\n';
+
+  // This is a guide-specific item, no matcher for this
+  // TODO: add a way to have this be a normal change item but not run in the CLI
+  const defaultsChangeItem = {
+    title: 'Changes to default variables',
+    content: `The default values of some [appearance variables](/docs/components/customization/variables) have changed which may impact your UI (if you are not already overriding them).
+
+    - The default \`colorPrimary\` value changed from \`#103FEF\` to \`#2F3037\`. As the new color is a dark grey, the \`colorPrimary\` of the dark theme was changed to \`#FFFFFF\`.
+    - The default \`fontSize\` value changed from \`1rem\` to \`0.8125rem\`
+    - The default \`fontWeight\` values changed from \`{ normal: 400, medium: 500, bold: 600 }\` to \`{ normal: 400, medium: 500, bold: 700 }\`
+    - Previously, the default value for \`fontSmoothing\` was \`auto\`. This value is now unset. If you want to pass a custom value to it, you can still do so.`
+  };
+  output += '#### Appearance changes';
+  output += '\n\n';
+  output += renderAccordionForCategory(data.nextjs, 'appearance', {
+    additionalItems: [defaultsChangeItem]
+  });
+  output += '\n\n';
+  output += '#### Localization changes';
+  output += '\n\n';
+  output += renderAccordionForCategory(data.nextjs, 'localization');
+  output += '\n\n';
+  return output;
+}
+generate().then(console.log);
+
+// This is used the same way for all SDKs, so this fn prevents tons of repetition
+function renderDeprecationRemovalsAndHousekeeping(data) {
+  let output = '';
+  output += '## Deprecation removals & housekeeping';
+  output += '\n\n';
+  output += renderMarkdown('v5-guide/deprecation-removals');
+  output += '\n\n';
+  output += '### Deprecation removals';
+  output += '\n\n';
+  output += renderMarkdown('v5-guide/deprecation-removals');
+  output += '\n\n';
+  output += renderAccordionForCategory(data, 'deprecation-removal');
+  output += '\n\n';
+  output += '### Other Breaking Changes';
+  output += '\n\n';
+  output += renderAccordionForCategory(data, [undefined, 'hof-removal', 'pagination-return', 'pagination-args', 'error-imports']);
+  output += '\n\n';
+  return output;
+}

package/dist/util/v5-guide/getting-up-to-date.mdx

@@ -0,0 +1,114 @@
+## Preparing to upgrade
+
+Before uprading, Clerk highly recommends updating your clerk SDKs to the latest v4 version. Some changes required for v5 can be applied incrementally to the latest v4, which should contribute to a smoother upgrading experience.
+
+After updating, look out for deprecation messages in your terminal and browser console. By resolving these deprecations you'll be able to skip many breaking changes for v5.
+
+Some of the minumum version requirements for Node.js, React, and Next.js have been updated such that versions that are no longer supported or are at end-of-life are no longer guaranteed to work correctly with Clerk. Please take a moment to check your dependencies and ensure you are up to date!
+
+#### Updating Node.js
+
+You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 entered EOL (End of life) status so it's time to bump the required version for `@clerk/nextjs`, too. You can check your Node.js version by running `node -v` in your terminal. Learn more about how to [update and install Node.js](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs).
+
+#### Updating React
+
+All react-dependent SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`.
+
+<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+    ```bash filename="terminal"
+    npm install react@latest react-dom@latest
+    ```
+
+    ```bash filename="terminal"
+    yarn add react@latest react-dom@latest
+    ```
+
+    ```bash filename="terminal"
+    pnpm add react@latest react-dom@latest
+    ```
+
+</CodeBlockTabs>
+
+If you are upgrading from React 17 or lower, make sure to [learn about how to upgrade your React version to 18](https://react.dev/blog/2022/03/08/react-18-upgrade-guide) as well.
+
+## Updating to v5
+
+Whenever you feel ready, go ahead and install the latest beta version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. Some examples for how to unstall commonly used SDKs are below:
+
+<Tabs type="v4-to-v5-sdk" items={["Next.js", "React", "Remix", "JavaScript", "Node.js"]}>
+  <Tab>
+    <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+      ```bash filename="terminal"
+      npm install @clerk/nextjs@beta
+      ```
+
+      ```bash filename="terminal"
+      yarn add @clerk/nextjs@beta
+      ```
+
+      ```bash filename="terminal"
+      pnpm add @clerk/nextjs@beta
+      ```
+    </CodeBlockTabs>
+  </Tab>
+  <Tab>
+    <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+      ```bash filename="terminal"
+      npm install @clerk/clerk-react@beta
+      ```
+
+      ```bash filename="terminal"
+      yarn add @clerk/clerk-react@beta
+      ```
+
+      ```bash filename="terminal"
+      pnpm add @clerk/clerk-react@beta
+      ```
+    </CodeBlockTabs>
+  </Tab>
+  <Tab>
+    <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+      ```bash filename="terminal"
+      npm install @clerk/remix@beta
+      ```
+
+      ```bash filename="terminal"
+      yarn add @clerk/remix@beta
+      ```
+
+      ```bash filename="terminal"
+      pnpm add @clerk/remix@beta
+      ```
+    </CodeBlockTabs>
+  </Tab>
+  <Tab>
+    <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+      ```bash filename="terminal"
+      npm install @clerk/clerk-js@beta
+      ```
+
+      ```bash filename="terminal"
+      yarn add @clerk/clerk-js@beta
+      ```
+
+      ```bash filename="terminal"
+      pnpm add @clerk/clerk-js@beta
+      ```
+    </CodeBlockTabs>
+  </Tab>
+  <Tab>
+    <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
+      ```bash filename="terminal"
+      npm install @clerk/clerk-sdk-node@beta
+      ```
+
+      ```bash filename="terminal"
+      yarn add @clerk/clerk-sdk-node@beta
+      ```
+
+      ```bash filename="terminal"
+      pnpm add @clerk/clerk-sdk-node@beta
+      ```
+    </CodeBlockTabs>
+  </Tab>
+</Tabs>

package/dist/util/v5-guide/hof-removals.mdx

@@ -0,0 +1,3 @@
+### Some higher-order functions and components removed
+
+A set of higher-order functions and components that are easily replicated with userland code and were rarely used have been removed. Each of them are listed below, along with code snippets with which they can be reproduced if need be.

package/dist/util/v5-guide/intro.mdx

@@ -0,0 +1,15 @@
+# Upgrading from v4 to v5
+
+Clerk's SDKs include React, Next.js, Remix, Expo, Redwood, and others. This guide helps you with uprading to the next major version of your SDK.
+
+Version 5 ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a new middleware for Next.js which defaults to not protecting any routes. Along with these highly requested features some smaller DX improvements and housekeeping items made its way into the release. If you want to know everything that's new, read the [v5 announcement post](https://clerk.com/changelog/2024-01-16).
+
+<Callout type="info" >
+  Version 5/v5 refers to the [`@clerk/clerk-js`](https://www.npmjs.com/package/@clerk/clerk-js) package version. However, other SDKs like `@clerk/backend` or `@clerk/clerk-expo` are versioned independently (and would upgrade from v1 to v2). To make this page easier to read for instances of general advice only v5 is mentioned. You can think of v4 as the previous major of your SDK and v5 as the current in those cases.
+</Callout>
+
+If you're curious about Clerk's approach to versioning and support, head to the [long term support](/docs/upgrade-guides/long-term-support) document. Version 5 includes [potentially breaking changes](#breaking-changes), as well as the removal of [previously deprecated features](#previously-deprecated-features).
+
+For most users we expect a smooth upgrade path as only a couple of changes will be required: [Update dependencies](#update-dependencies), run the `@clerk/upgrade` CLI, [update Clerk](#update-clerk), and handle any [breaking changes](#breaking-changes).
+
+If you're using **Next.js**, you can read a more streamlined [Upgrading Next.js from v4 to v5](/docs/upgrade-guides/upgrading-nextjs-from-v4-to-v5) guide.

package/dist/util/v5-guide/node-setters-removals.mdx

@@ -0,0 +1,34 @@
+### Clerk client setters removed in favor of `createClerkClient` options
+
+The following setter methods have been removed in the lastest version. If you were using any of these functions, their functionality can be replaced by instead passing the correponding option to `createClerkClient`.
+
+- `setClerkApiVersion`
+- `setClerkHttpOptions`
+- `setClerkServerApiUrl`
+- `setClerkApiKey`
+
+Code example:
+
+```diff
+  import {
+     clerkClient,
+-    setClerkApiKey,
+-    setClerkApiVersion,
+-    setClerkHttpOptions,
+-    setClerkServerApiUrl
+} from "@clerk/clerk-sdk-node"
+ 
+- setClerkApiKey("...")
+- setClerkApiVersion("...")
+- setClerkHttpOptions("...")
+- setClerkServerApiUrl("...")
+
+  const clerkClient = createClerkClient({
++     secretKey: "..."
++     apiVersion: "..."
++     httpOptions: "..."
++     serverApiUrl: "..."
+  })
+
+  await clerkClient.users.getUser(userId);
+```

package/dist/util/v5-guide/pagination-args.mdx

@@ -0,0 +1,3 @@
+#### Changes to pagination arguments for some functions
+
+There were some changes made to pagination-related arguments passed into functions, in order to make it more clear how to control paginated results. See each function impacted by these changes below:

package/dist/util/v5-guide/pagination-return.mdx

@@ -0,0 +1,3 @@
+#### Changes to some function return signatures
+
+There have been changes to return signatures for some functions. Since Clerk's API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily. This change also aligns the response shape with what is returned from the Clerk backend API. Each impacted function is listed below, along with code examples:

package/dist/util/v5-guide/path-routing.mdx

@@ -0,0 +1,50 @@
+### Path routing is now the default
+
+On components like [`<SignIn />`](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used.
+
+In the latest version, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are:
+
+- `<SignIn />`
+- `<SignUp />`
+- `<UserProfile />`
+- `<CreateOrganization />`
+- `<OrganizationProfile />`
+
+Here's how you'd use the components going forward:
+
+```jsx
+<SignIn path="/sign-in" />
+<SignUp path="/sign-up" />
+<UserProfile path="/user-profile" />
+<CreateOrganization path="/create-org" />
+<OrganizationProfile path="/org-profile" />
+```
+
+If you don't define the `path` prop an error will be thrown. Of course, you can still use `routing="hash"` or `routing="virtual"`.
+
+```jsx
+<UserProfile routing="hash" />
+<OrganizationProfile routing="virtual" />
+```
+
+However, there are two exceptions to this behavior. If you're using `@clerk/nextjs` or `@clerk/remix`, you can set environment variables for `<SignIn />` and `<SignUp />`.
+
+<CodeBlockTabs options={["Next.js", "Remix"]}>
+```env filename=".env.local"
+NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
+NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
+```
+
+```env filename=".env"
+CLERK_SIGN_IN_URL=/sign-in
+CLERK_SIGN_UP_URL=/sign-up
+```
+</CodeBlockTabs>
+
+**Only** if you're using one of these two frameworks and defined both environment variables, you're able to use the `<SignIn />` and `<SignUp />` components without any props.
+
+```jsx
+// Only works for Next.js / Remix when environment variables are set
+<SignIn />
+<SignUp />
+```

package/dist/util/v5-guide/per-sdk.mdx

@@ -0,0 +1,16 @@
+## SDK Guides
+
+Select the SDK(s) you are using for your project from the list below to read through a summary of all the breaking changes:
+
+> Note: I want a prettier selection component here, in it's absence for now there's a list
+
+- [Next.js](upgrading-nextjs-from-v4-to-v5)
+- [Remix](#remix)
+- [Expo](#expo)
+- [Gatsby](#gatsby)
+- [Backend](#backend)
+- [Node](#node)
+- [Fastify](#fastify)
+- [React](#react)
+- [JS](#js)
+- [Chrome Extension](#chrome-extension)