@clerk/upgrade 0.3.0 → 0.4.1

package/dist/guide-generators/v5-guides/nextjs/intro.mdx

@@ -1,21 +0,0 @@
-# Upgrading Next.js from v4 to v5
-
-By the end of this guide, you’ll have successfully upgraded your Next.js project to use `@clerk/nextjs` v5. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations.
-
-Step-by-step instructions will lead you through the process. If you’re looking for a reference list of changes, check out the general [upgrading from v4 to v5 guide](/docs/upgrade-guides/upgrading-from-v4-to-v5).
-
-To aid you in this upgrade, Clerk built a CLI called [`@clerk/upgrade`](https://www.npmjs.com/package/@clerk/upgrade). Throughout this guide you'll see prompts to use the CLI which you can invoke directly in your terminal.
-
-<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
-```bash filename="terminal"
-npx @clerk/upgrade
-```
-
-```bash filename="terminal"
-yarn dlx @clerk/upgrade
-```
-
-```bash filename="terminal"
-pnpm dlx @clerk/upgrade
-```
-</CodeBlockTabs>

package/dist/guide-generators/v5-guides/nextjs/retheme-changes.mdx

@@ -1,10 +0,0 @@
-## Redesigned components
-
-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.
-
-<Callout type='info'>
-  If you are not customizing the appearance of your components, or using `localization`, you can skip this section. Otherwise, it's recommended to use our CLI (`npx @clerk/upgrade`) to scan for changes required as part of the component
-  redesign more quickly.
-</Callout>
-
-The sections below contain more info on each change made to the customization ids and localization keys for reference. Regardless of how thoroughly you have reviewed the following information, you should still take some time to manually look through each of your views to ensure that everything looks good.

package/dist/guide-generators/v5-guides/nextjs/version-requirements.mdx

@@ -1,34 +0,0 @@
-## Minimum version requirements
-
-We have updated some of our minumum version requirements for Node.js, React, and Next.js 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**
-
-`@clerk/nextjs` now requires 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 Next.js**
-
-`@clerk/nextjs` now requires you to use Next.js version `13.0.4` or later. Check out Next's upgrade guides for more guidance if you have not yet upgraded to Next.js 13:
-
-- [Upgrading from 12 to 13](https://nextjs.org/docs/pages/building-your-application/upgrading/version-13)
-- [Upgrading from 13 to 14](https://nextjs.org/docs/app/building-your-application/upgrading/version-14)

package/dist/guide-generators/v5-guides/node-setters-removals.mdx

@@ -1,34 +0,0 @@
-### 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/guide-generators/v5-guides/pagination-args.mdx

@@ -1,3 +0,0 @@
-#### 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/guide-generators/v5-guides/pagination-return.mdx

@@ -1,3 +0,0 @@
-#### 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/guide-generators/v5-guides/path-routing.mdx

@@ -1,50 +0,0 @@
-### 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/per-sdk.mdx

@@ -1,16 +0,0 @@
-## 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)

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

@@ -1,135 +0,0 @@
-## 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 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>
-
-## CLI Upgrade Helper
-
-As of this major version Clerk provides a `@clerk/upgrade` CLI tool that you can use to ease the upgrade. A CLI prompt will ask you a couple of questions, it will scan your codebase, and afterwards you'll get a list of changes you'll need to apply to your project, as well as the locations where they need to be applied. This should catch the vast majority of the changes needed for a successful upgrade to v5, and can save a lot of time reading through changes to things that aren't actually in your project.
-
-To run the CLI tool, navigate to your project and run it in the terminal:
-
-<CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
-  ```bash filename="terminal"
-  npx @clerk/upgrade
-  ```
-
-  ```bash filename="terminal"
-  yarn dlx @clerk/upgrade
-  ```
-
-  ```bash filename="terminal"
-  pnpm dlx @clerk/upgrade
-  ```
-</CodeBlockTabs>
-
-If you are having trouble with `npx`, it's also possible to install directly with `npm i @clerk/upgrade -g`, and can then be run with the `clerk-upgrade` command.

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

@@ -1,5 +0,0 @@
-### 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/redesigned-components.mdx

@@ -1,11 +0,0 @@
-## Redesigned components
-
-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.
-
-<Callout type='info'>
-  If you are not customizing the appearance of your components, or using `localization`, you can skip this section. If
-  you are, we recommend using our CLI (`npx @clerk/upgrade`) to scan for changes required as part of the component
-  redesign more quickly.
-</Callout>
-
-The sections below contain more info on each change made to the customization ids and localization keys for reference. Regardless of how thoroughly you have reviewed the following information, we still recommend that you ensure that you have taken some time to manually look through each of your views to ensure that everything looks good still.

package/dist/guide-generators/v5-guides/remix/index.js

@@ -1,15 +0,0 @@
-import { assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, markdown, sharedMarkdown, sharedMarkdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const cwd = 'v5-guides/remix';
-async function generate() {
-  const data = (await import(`../../../versions/v5/index.js`)).default;
-  return assembleContent({
-    data: data.remix,
-    cwd
-  }, [frontmatter({
-    title: 'Upgrading Remix from v4 to v5',
-    description: 'Learn how to upgrade from version 4 to version 5 of the Clerk Remix SDK.'
-  }), '# Upgrading `@clerk/remix` from v4 to v5', markdown('intro'), sharedMarkdown('prepare'), sharedMarkdown('node-version'), sharedMarkdown('react-version'), sharedMarkdownTemplate('update-v5', {
-    packageName: '@clerk/remix'
-  }), sharedMarkdown('cli'), '## Breaking Changes', singleItem('clerkerrorboundary-removed'), sharedMarkdown('redesign-preview'), deprecationRemovalsAndHousekeeping()]);
-}
-generate().then(writeToFile(cwd));

package/dist/guide-generators/v5-guides/remix/intro.mdx

@@ -1 +0,0 @@
-Version 5 of the Remix SDK ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, no more need to add a custom error boundary, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.