@clerk/upgrade 0.2.0 → 0.3.0

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

@@ -0,0 +1,57 @@
+### 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" />
+```
+
+<% if (['@clerk/nextjs', '@clerk/remix'].includes(packageName)) { %>
+For the <%= packageName %> SDK, you can set environment variables for the sign up/in URLs and avoid needing to explicitly pass the path to the `<SignIn />` and `<SignUp />` components.
+
+<% if (packageName === '@clerk/nextjs') { %>
+
+```env filename=".env.local"
+NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
+NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
+```
+
+<% } %>
+<% if (packageName === '@clerk/remix') { %>
+
+```env filename=".env"
+CLERK_SIGN_IN_URL=/sign-in
+CLERK_SIGN_UP_URL=/sign-up
+```
+
+<% } %>
+
+If you have defined both environment variables, you're able to use the `<SignIn />` and `<SignUp />` components without any props, as such:
+
+```jsx
+<SignIn />
+<SignUp />
+```
+
+<% } %>

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

@@ -0,0 +1,10 @@
+## Preparing to upgrade
+
+Before uprading, it's highly recommended that you update your Clerk SDKs to the latest Core 1 version (`npm i <%= packageName %>@core-1`). Some changes required for Core 2 can be applied incrementally to the latest <%= version %> release, 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 from Core 2.
+
+<Callout>
+  Note that Core 2 is currently in beta, while we field feedback and ensure stability. Deploying beta versions to
+  production is not recommended and should be done at your own risk.
+</Callout>
+
+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/shared/react-version.mdx

@@ -0,0 +1,20 @@
+**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/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 »](/components-redesigned)

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

@@ -0,0 +1,17 @@
+## Updating to Core 2 Beta
+
+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. The commands below demonstrate how to install the latest beta.
+
+<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/shared/update-version.mdx

@@ -0,0 +1,18 @@
+## Updating to Core 2 Beta
+
+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. The commands below demonstrate how to install the latest beta.
+
+<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/single-page-old.js

@@ -0,0 +1,192 @@
+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';
+
+  // ------------------------------------------------------------
+
+  // 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';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.gatsby);
+
+  // Shared sections:
+  // - path routing
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  output += '### Expo';
+  output += '\n\n';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.expo);
+
+  // Shared sections:
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  output += '### Fastify';
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.fastify);
+
+  // Shared sections:
+  // - org claim removed
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  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);
+
+  // Shared sections:
+  // - org claim removed
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  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';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.react);
+
+  // Shared sections:
+  // - path routing?
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  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';
+
+  // imageUrl changes
+
+  // createOrganization args
+
+  // attemptweb3wallet
+
+  // afterSignXUrl changes
+
+  // Deprecation removals & housekeeping
+
+  // Shared sections:
+  // - path routing?
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+
+  // ------------------------------------------------------------
+
+  output += '### Backend';
+  output += '\n\n';
+
+  // buildrequesturl, createisomorphicrequest, createEmail removed
+
+  // clockskewinms
+
+  // error api import move
+
+  // membershiprole -> organizationcustomrolekey
+
+  // orgs claim dropped
+
+  // Deprecation removals & housekeeping
+
+  // ------------------------------------------------------------
+
+  output += '### Chrome Extension';
+  output += '\n\n';
+
+  // token cache change
+
+  return output;
+}
+generate().then(console.log);

package/dist/guide-generators/v5-guides/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/guide-generators/v5-guides/generate.js

@@ -0,0 +1,263 @@
+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);
+
+  // Shared sections:
+  // - path routing
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  // 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';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.gatsby);
+
+  // Shared sections:
+  // - path routing
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  output += '### Expo';
+  output += '\n\n';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.expo);
+
+  // Shared sections:
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  output += '### Fastify';
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.fastify);
+
+  // Shared sections:
+  // - org claim removed
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  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);
+
+  // Shared sections:
+  // - org claim removed
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  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';
+
+  // Components redesigned
+  output += renderMarkdown('v5-guide/redesign-preview');
+  output += '\n\n';
+
+  // Deprecation removals & housekeeping
+  output += renderDeprecationRemovalsAndHousekeeping(data.react);
+
+  // Shared sections:
+  // - path routing?
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+  // - hof removals
+  // - imageUrl changes
+
+  // ------------------------------------------------------------
+
+  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';
+
+  // imageUrl changes
+
+  // createOrganization args
+
+  // attemptweb3wallet
+
+  // afterSignXUrl changes
+
+  // Deprecation removals & housekeeping
+
+  // Shared sections:
+  // - path routing?
+  // - org claim removed
+  // - afterSignX changes
+  // - error import changes
+
+  // ------------------------------------------------------------
+
+  output += '### Backend';
+  output += '\n\n';
+
+  // buildrequesturl, createisomorphicrequest, createEmail removed
+
+  // clockskewinms
+
+  // error api import move
+
+  // membershiprole -> organizationcustomrolekey
+
+  // orgs claim dropped
+
+  // Deprecation removals & housekeeping
+
+  // ------------------------------------------------------------
+
+  output += '### Chrome Extension';
+  output += '\n\n';
+
+  // token cache change
+
+  // ------------------------------------------------------------
+
+  // 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/guide-generators/v5-guides/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/guide-generators/v5-guides/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/guide-generators/v5-guides/nextjs/after-sign-x-handling.mdx

@@ -0,0 +1,10 @@
+## After sign up/in/out URL handling
+
+Defining redirect URLs for after sign up, in, and/or out via the Clerk dashboard has been removed in v5. In your Clerk dashboard, under "paths", there is a section called "Component paths", where URLs could be defined that had a deprecation warning. In v5, this functionality has been removed, and specifying redirect paths via the dashboard will no longer work. If you need to pass a redirect URL for after sign in/up/out, there are [a few different ways this can be done](https://clerk.com/docs/account-portal/custom-redirects), from environment variables to middleware to supplying them directly to the relevant components.
+
+As part of this change, the default URL for each of these props has been set to `/`, so if you are passing `/` explicitly to any one of the above props, that line is no longer necessary and can be removed.
+
+```diff
+- <UserButton afterSignOutUrl='/' />
++ <UserButton />
+```

package/dist/guide-generators/v5-guides/nextjs/deprecation-removals.mdx

@@ -0,0 +1,9 @@
+## Deprecation removals & housekeeping
+
+As part of this major version, a large 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>