@clerk/upgrade 0.3.0 → 0.4.0

package/dist/constants/sdks.js

@@ -4,10 +4,9 @@ export default [{
 }, {
   label: '@clerk/remix',
   value: 'remix'
-}, {
-  label: 'gatsby-plugin-clerk',
-  value: 'gatsby'
-}, {
+},
+// { label: 'gatsby-plugin-clerk', value: 'gatsby' },
+{
   label: '@clerk/redwood',
   value: 'redwood'
 }, {
@@ -42,5 +41,5 @@ export default [{
   value: 'types'
 }, {
   label: '@clerk/chrome-extension',
-  value: 'chromeExtension'
+  value: 'chrome-extension'
 }];

package/dist/guide-generators/{v5 → core-2}/backend/index.js

@@ -1,5 +1,5 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
 const name = 'backend';
 const properName = 'Backend';
 const packageName = '@clerk/backend';

package/dist/guide-generators/{v5/expo → core-2/backend}/intro.mdx

@@ -1,3 +1,3 @@
-Clerk's Core 2 release includes a new major version of the Expo SDK, v1. This release ships with an improved design and UX for its built-in components and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+Core 2 is included in the Backend SDK starting with version 1. This new version ships with a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
 
-By the end of this guide, you’ll have successfully upgraded your Expo project to use `@clerk/clerk-expo` v1. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations. Step-by-step instructions will lead you through the process.
+By the end of this guide, you’ll have successfully upgraded your Backend project to use `@clerk/backend` v1. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations. Step-by-step instructions will lead you through the process.

package/dist/guide-generators/{v5/chromeExtension → core-2/chrome-extension}/index.js

@@ -1,9 +1,9 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const version = 'v5';
-const name = 'chromeExtension';
+const version = 'core-2';
+const name = 'chrome-extension';
 const properName = 'Chrome Extension';
 const packageName = '@clerk/chrome-extension';
-const cwd = `${version}/chromeExtension`;
+const cwd = `${version}/${name}`;
 async function generate() {
   const data = await loadVersionChangeData(version, name);
   return assembleContent({

package/dist/guide-generators/core-2/chrome-extension/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the Chrome Extension SDK starting with version 1. This new version ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+
+By the end of this guide, you’ll have successfully upgraded your project to use `@clerk/chrome-extension` v1. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations. Step-by-step instructions will lead you through the process.

package/dist/guide-generators/{v5 → core-2}/expo/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v1';
 const name = 'expo';
 const properName = 'Expo';
 const packageName = '@clerk/clerk-expo';
@@ -13,7 +14,7 @@ async function generate() {
     title: `Upgrading ${properName} to Core 2`,
     description: `Learn how to upgrade Clerk's ${properName} SDK to the latest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
-    version: 'v1',
+    version: semverVersion,
     packageName
   }), markdown('node-version'), markdown('react-version'), markdownTemplate('update-version', {
     packageName

package/dist/guide-generators/core-2/expo/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the Expo SDK starting with version 1. This release ships with an improved design and UX for its built-in components and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+
+By the end of this guide, you’ll have successfully upgraded your Expo project to use `@clerk/clerk-expo` v1. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations. Step-by-step instructions will lead you through the process.

package/dist/guide-generators/{v5 → core-2}/fastify/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v1';
 const name = 'fastify';
 const properName = 'Fastify';
 const packageName = '@clerk/fastify';
@@ -13,7 +14,7 @@ async function generate() {
     title: `Upgrading ${properName} to Core 2`,
     description: `Learn how to upgrade Clerk's ${properName} SDK to the latest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
-    version: 'v1',
+    version: semverVersion,
     packageName
   }), markdown('node-version'), markdownTemplate('update-version', {
     packageName

package/dist/guide-generators/{v5 → core-2}/fastify/intro.mdx

@@ -1,3 +1,3 @@
-Clerk's Core 2 release includes a new major version of the Fastify SDK, v1. This release ships with a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+Core 2 is included in the Fastify SDK starting with version 1. This release ships with a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
 
 By the end of this guide, you’ll have successfully upgraded your Fastify project to use `@clerk/fastify` 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.

package/dist/guide-generators/{v5 → core-2}/gatsby/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v5';
 const name = 'gatsby';
 const properName = 'Gatsby';
 const packageName = 'gatsby-plugin-clerk';
@@ -10,10 +11,10 @@ async function generate() {
     data,
     cwd
   }, [frontmatter({
-    title: `Upgrading ${properName} from v4 to v5`,
-    description: `Learn how to upgrade Clerk's ${properName} SDK from v4 to v5.`
-  }), `# Upgrading \`${packageName}\` from v4 to v5`, markdown('intro'), markdownTemplate('prepare', {
-    version,
+    title: `Upgrading ${properName} to Core 2`,
+    description: `Learn how to upgrade Clerk's ${properName} SDK to the latest version`
+  }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
+    version: semverVersion,
     packageName
   }), markdown('node-version'), markdown('react-version'), markdownTemplate('update-version', {
     packageName: 'gatsby-plugin-clerk'

package/dist/guide-generators/core-2/gatsby/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the Gatsby SDK starting with version 5. This new version ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+
+By the end of this guide, you’ll have successfully upgraded your Gatsby project to use `gatsby-plugin-clerk` 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.

package/dist/guide-generators/{v5 → core-2}/generate-all.sh

@@ -4,7 +4,7 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
 
 node $SCRIPT_DIR/overview/index.js
 node $SCRIPT_DIR/backend/index.js
-node $SCRIPT_DIR/chromeExtension/index.js
+node $SCRIPT_DIR/chrome-extension/index.js
 node $SCRIPT_DIR/expo/index.js
 node $SCRIPT_DIR/fastify/index.js
 node $SCRIPT_DIR/gatsby/index.js

package/dist/guide-generators/{v5 → core-2}/js/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v5';
 const name = 'js';
 const properName = 'Javascript';
 const packageName = '@clerk/clerk-js';
@@ -13,7 +14,7 @@ async function generate() {
     title: `Upgrading ${properName} to Core 2`,
     description: `Learn how to upgrade Clerk's ${properName} SDK to the latest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
-    version,
+    version: semverVersion,
     packageName
   }), markdownTemplate('update-version', {
     packageName

package/dist/guide-generators/core-2/js/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the Javascript SDK starting with version 5. This new version ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+
+By the end of this guide, you'll have successfully upgraded your JS project to use `@clerk/clerk-js` 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.

package/dist/guide-generators/{v5 → core-2}/nextjs/import-changes.mdx

@@ -1,4 +1,4 @@
-## Changes to top-level exports
+### Changes to top-level exports
 
 As part of this release, some of the top-level exports of `@clerk/nextjs` have been changed in order to improve bundle size and tree-shaking efficiency. These changes have resulted in a ~75% reduction in build size for middleware bundles. However, you will likely need to make some changes to import paths as a result.
 
@@ -8,7 +8,7 @@ As part of this release, some of the top-level exports of `@clerk/nextjs` have b
 
 <Accordion titles={["@clerk/nextjs/server", "@clerk/nextjs/errors", "@clerk/nextjs/app-beta", "@clerk/nextjs/ssr", "@clerk/nextjs/edge-middleware", "@clerk/nextjs/edge-middlewarefiles", "@clerk/nextjs/api"]}>
   <AccordionPanel>
-    Previously these exports have been exported both from `@clerk/nextjs` and `@clerk/nextjs/server`. As of v5 they are only exported from the latter.
+    Previously these exports have been exported both from `@clerk/nextjs` and `@clerk/nextjs/server`. As of v5 they are only exported from the latter. Going forward, the expectation can be that any imports that are intended to run within react on the client side, will come from `@clerk/nextjs` and imports that are intended to run on the server, will come from `@clerk/nextjs/server`.
 
     ```diff
       import {

package/dist/guide-generators/{v5 → core-2}/nextjs/index.js

@@ -1,9 +1,10 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v5';
 const name = 'nextjs';
 const properName = 'Next.js';
 const packageName = '@clerk/nextjs';
-const cwd = 'v5/nextjs';
+const cwd = `${version}/${name}`;
 async function generate() {
   const data = await loadVersionChangeData(version, name);
   return assembleContent({
@@ -13,7 +14,7 @@ async function generate() {
     title: `Upgrading ${properName} to Core 2`,
     description: `Learn how to upgrade Clerk's ${properName} SDK to the latest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
-    version,
+    version: semverVersion,
     packageName
   }), markdown('node-version'), markdown('react-version'), markdown('nextjs-version'), markdownTemplate('update-version', {
     packageName

package/dist/guide-generators/core-2/nextjs/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the Next.js SDK starting with version 5.0.0. This new version ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, a substantially improved middleware import, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+
+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.

package/dist/guide-generators/{v5-guides → core-2}/nextjs/middleware-changes.mdx

@@ -1,74 +1,51 @@
-## New Middleware architecture
+### New Middleware architecture
 
-User and customer feedback about `authMiddleware()` has been clear in that Middleware logic was a often friction point. As such, in v5 you will find a completely new Middleware helper called [`clerkMiddleware()`](/docs/references/nextjs/clerk-middleware) that will hopefully alleviate all of the issues folks had with `authMiddleware()`.
+User and customer feedback about `authMiddleware()` has been clear in that Middleware logic was a often friction point. As such, in v5 you will find a completely new Middleware helper called [`clerkMiddleware()`](/docs/references/nextjs/clerk-middleware) that should alleviate the issues folks had with `authMiddleware()`.
 
 Additionally, there are now new helpers that enable controlling auth on a _per-page and/or per-layout basis_ when using App Router. While you can still configure which routes are protected via Middleware, the page-based protection strategy is what is now recommended, as the co-location of auth protection configuration with the code for the pages themselves results in a superior developer experience that adds clarity as you navigate your codebase.
 
-### Per-route auth config
+#### Per-route auth config
 
 Sometimes, code speaks louder than words. Let's get right into an example:
 
 <Tabs type="auth-protect-layout-page" items={["Layout", "Page"]}>
-<Tab>
-```ts filename="app/src/dashboard/layout.tsx"
-import { auth } from '@clerk/nextjs/server'
+  <Tab>
+    ```ts filename="app/src/dashboard/layout.tsx"
+    import { auth } from '@clerk/nextjs/server'
 
-export default async function DashboardLayout({ children }) {
-    auth().protect();
-    // 👆 This one line is all it takes - the layout and all its children
-    // will now redirect to your sign in page for un-authenticated users.
+    export default async function DashboardLayout({ children }) {
+        auth().protect();
+        // 👆 This one line is all it takes - the layout and all its children
+        // will now redirect to your sign in page for un-authenticated users.
 
-    return <>{children}</>
-
-}
+        return <>{children}</>
+    }
+    ```
 
-````
-</Tab>
-<Tab>
-```ts filename="app/src/dashboard/page.tsx"
-import { auth } from '@clerk/nextjs/server'
+  </Tab>
+  <Tab>
+    ```ts filename="app/src/dashboard/page.tsx"
+    import { auth } from '@clerk/nextjs/server'
 
-export default async function DashboardPage() {
-    auth().protect();
-    // 👆 This one line is all it takes - the layout and all its children
-    // will now redirect to your sign in page for un-authenticated users.
+    export default async function DashboardPage() {
+        auth().protect();
+        // 👆 This one line is all it takes - the layout and all its children
+        // will now redirect to your sign in page for un-authenticated users.
 
-    return <p>This page is now protected!</p>
-}
-````
+        return <p>This page is now protected!</p>
+    }
+    ```
 
-</Tab>
+  </Tab>
 </Tabs>
 
-In this example, we add `auth().protect()` to a layout, and like magic, that layout and all of it's children will be gated by auth. The same logic can be applied for pages.
-
-Want to get more specific with permission gating? Add the role you are gating as a param:
-
-```ts filename="app/src/admin/layout.tsx"
-import { auth } from '@clerk/nextjs/server';
-
-export default async function AdminLayout({ children }) {
-  auth().protect({ role: 'org:admin' });
-
-  return <>{children}</>;
-}
-```
-
-Note that in order for this to work, you will still need Middleware to be present, but it only requires the most minimal configuration:
-
-```ts filename="middleware.ts"
-import { clerkMiddleware } from '@clerk/nextjs/server';
+In this example, you add [`auth().protect()`](/docs/references/nextjs/auth#protect) to a layout and that layout and all of it's children will be gated by auth. The same logic can be applied for pages.
 
-export default clerkMiddleware();
-
-export const config = {
-  matcher: ['/((?!.*\\..*|_next).*)', '/', '/(api|trpc)(.*)'],
-};
-```
+For more details on route protection, check out the [route protection guide](/references/nextjs/route-protection).
 
 If you are using the pages router, per-route gating won't work. Instead, configure your auth gating via Middleware as described in the next section.
 
-### Middleware auth config
+#### Middleware auth config
 
 If you prefer to define your auth logic within the Middleware, you can still do this using the new `clerkMiddleware`. The primary change from the previous `authMiddleware()` is that `clerkMiddleware()` does not protect any routes by default, instead requiring the developer to add routes they would like to be protected by auth. This is a substantial contrast to the previous `authMiddleware()`, which protected all routes by default, requiring the developer to add exceptions. The API was also substantially simplified, and it has become easier to combine with other Middleware helpers smoothly as well.
 
@@ -78,7 +55,7 @@ Here's an example that replicates the auth protection scheme above, but entirely
 import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs/server';
 
 const isDashboardRoute = createRouteMatcher(['/dashboard(.*)']);
-const isAdminRoute = createRouteMatcher(['/admin']);
+const isAdminRoute = createRouteMatcher(['/admin(.*)']);
 
 export default clerkMiddleware((auth, req) => {
   // Restrict admin route to users with specific role
@@ -99,18 +76,18 @@ A couple things to note here:
 - With `clerkMiddleware`, you're defining the routes you want **to be protected**, rather than the routes you don't want to be protected.
 - You are able to use the same `auth().protect()` helpers that you can use within layouts/pages here in the Middleware.
 
-### Migrating to `clerkMiddleware()`
+#### Migrating to `clerkMiddleware()`
 
 Clerk strongly recommends migrating to the new `clerkMiddleware()` for an improved DX and access to all present and upcoming features, but also want to note that `authMiddleware()`, while deprecated, will continue to work in v5 and will not be removed until the next major version, so you do not _need_ to make any changes to your Middleware setup this version.
 
-The most basic migration will be updating the import and changing out the default export.
+The most basic migration will be updating the import and changing out the default export, then mirroring the previous behavior of protecting all routes as such:
 
 ```diff
 - import { authMiddleware } from "@clerk/nextjs"
 + import { clerkMiddleware } from '@clerk/nextjs/server'
 
 - export default authMiddleware()
-+ export default clerkMiddleware()
++ export default clerkMiddleware((auth) => auth().protect())
 
   export const config = {
     matcher: ["/((?!.*\\..*|_next).*)", "/", "/(api|trpc)(.*)"],
@@ -119,9 +96,9 @@ The most basic migration will be updating the import and changing out the defaul
 
 Of course, in most cases you'll have a more complicated setup than this. You can find some examples below for how to migrate a few common use cases. Be sure to review the [`clerkMiddleware()` documentation](/docs/references/nextjs/clerk-middleware) and [route protection guide](/docs/references/nextjs/route-protection) if your specific use case is not mentioned.
 
-<Accordion titles={["Making the index page public", "Protecting a single route path", "Combining with other Middlewares (like i18n)"]} heading="h4">
+<Accordion titles={["Protecting all routes except one or more public paths", "Protecting a single route path", "Combining with other Middlewares (like i18n)"]} heading="h4">
   <AccordionPanel>
-    By default, `clerkMiddleware()` treats all pages as public, so you no longer need to explcitly set `/` as public.
+    By default, `clerkMiddleware()` treats all pages as public unless explicitly protected. If you prefer for it to operate the other way around (all pages are protected unless explicitly made public), you can reverse the middleware logic in this way:
 
     Before:
 
@@ -129,7 +106,7 @@ Of course, in most cases you'll have a more complicated setup than this. You can
     import { authMiddleware } from "@clerk/nextjs"
 
     export default authMiddleware({
-      publicRoutes: ["/"],
+      publicRoutes: ["/", "/contact"],
     })
 
     export const config = {
@@ -145,7 +122,12 @@ Of course, in most cases you'll have a more complicated setup than this. You can
       createRouteMatcher
     } from "@clerk/nextjs/server"
 
-    export default clerkMiddleware()
+    const isPublicRoute = createRouteMatcher(["/", "/contact"])
+
+    export default clerkMiddleware((auth, req) => {
+      if (isPublicRoute(req)) return // if it's a public route, do nothing
+      auth().protect() // for any other route, require auth
+    })
 
     export const config = {
       matcher: ["/((?!.+\\.[\\w]+$|_next).*)", "/", "/(api|trpc)(.*)"],
@@ -154,7 +136,7 @@ Of course, in most cases you'll have a more complicated setup than this. You can
 
   </AccordionPanel>
   <AccordionPanel>
-    Having all routes public except everything under `/dashboard`.
+    An example can be seen below of code that ensures that all routes are public except everything under `/dashboard`.
 
     Before:
 
@@ -181,9 +163,7 @@ Of course, in most cases you'll have a more complicated setup than this. You can
     const isDashboardRoute = createRouteMatcher(["/dashboard(.*)"])
 
     export default clerkMiddleware((auth, request) => {
-      if (isDashboardRoute(request)) {
-        auth().protect()
-      }
+      if (isDashboardRoute(request)) auth().protect()
     })
 
     export const config = {
@@ -235,9 +215,7 @@ Of course, in most cases you'll have a more complicated setup than this. You can
     const isDashboardRoute = createRouteMatcher(["/dashboard(.*)"])
 
     export default clerkMiddleware((auth, request) => {
-      if (isDashboardRoute(request)) {
-        auth().protect()
-      }
+      if (isDashboardRoute(request)) auth().protect()
 
       return intlMiddleware(request)
     })

package/dist/guide-generators/{v5 → core-2}/node/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v5';
 const name = 'node';
 const properName = 'Node';
 const packageName = '@clerk/clerk-sdk-node';
@@ -13,7 +14,7 @@ async function generate() {
     title: `Upgrading ${properName} to Core 2`,
     description: `Learn how to upgrade Clerk's ${properName} SDK to the lastest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
-    version,
+    version: semverVersion,
     packageName
   }), markdown('node-version'), markdownTemplate('update-version', {
     packageName

package/dist/guide-generators/{v5 → core-2}/node/intro.mdx

@@ -1,3 +1,3 @@
-Clerk's Core 2 release includes a new major version of the Node SDK, v5. This new version ships with a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+Core 2 is included in the Node.js SDK starting with version 5. This new version ships with a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
 
 By the end of this guide, you’ll have successfully upgraded your Node project to use `@clerk/clerk-sdk-node` 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.

package/dist/guide-generators/{v5 → core-2}/overview/index.js

@@ -1,12 +1,12 @@
 import { assembleContent, frontmatter, markdown, writeToFile } from '../../text-generation.js';
-const cwd = 'v5/overview';
+const cwd = 'core-2/overview';
 async function generate() {
   return assembleContent({
     data: {},
     cwd
   }, [frontmatter({
-    title: `Upgrading from v4 to v5 core`,
-    description: `Learn how to upgrade from v4 to v5 core for Clerk's SDKs`
+    title: `Upgrading to Clerk Core 2`,
+    description: `Learn how to upgrade to the latest version of Clerk's SDKs`
   }), markdown('intro')]);
 }
 generate().then(writeToFile(cwd));

package/dist/guide-generators/core-2/overview/intro.mdx

@@ -0,0 +1,25 @@
+# Upgrading to Clerk Core 2
+
+In Febrary 2024, [we updated](https://clerk.com/changelog/2024-01-16) Clerk's SDKs to include Core 2. This new core includes:
+
+- 💅 Redesigned and improved component UIs.
+- 🔪 The 401 & "flash of white page" that was visible sometimes when syncing auth state was eliminated.
+- 🧹 A large number of smaller housekeeping changes, bugfixes, and improvements.
+- 📊 [Telemetry](/docs/telemetry) to allow us to better determine feature usage and priority (easy opt-out if you don't like this)
+
+## SDK Guides
+
+Core 2 brings both UI changes and breaking code changes, so each SDK has been updated to a new major version.
+We expect upgrades to take less than 30 minutes, and are providing a CLI tool to assist with the process. Please select your SDK below to get started:
+
+- [Next.js](/nextjs)
+- [Remix](/remix)
+- [Expo](/expo)
+- [Node](/node)
+- [Fastify](/fastify)
+- [React](/react)
+- [Backend](/backend)
+- [JS](/js)
+- [Chrome Extension](/chrome-extension)
+
+Note that the `Gastsby`, `Go`, and `Ruby` SDKs do not yet have a beta release ready - if you are using any of these SDKs there is nothing actionable right now.

package/dist/guide-generators/{v5 → core-2}/react/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v5';
 const name = 'react';
 const properName = 'React';
 const packageName = '@clerk/clerk-react';
@@ -14,7 +15,7 @@ async function generate() {
     description: `Learn how to upgrade Clerk's ${properName} SDK to the latest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
     packageName,
-    version
+    version: semverVersion
   }), markdown('node-version'), markdown('react-version'), markdownTemplate('update-version', {
     packageName
   }), markdown('cli'), '## Breaking Changes', markdown('redesign-preview'), markdown('after-sign-x-handling'), singleItem('navigate-to-routerpush-routerreplace'), markdown('orgs-claim'), markdownTemplate('path-routing', {

package/dist/guide-generators/core-2/react/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the React SDK starting with version 5. This new version ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a variety of smaller DX improvements and housekeeping items. Each of the potentially breaking changes are detailed in this guide, below.
+
+By the end of this guide, you’ll have successfully upgraded your React project to use `@clerk/clerk-react` 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.

package/dist/guide-generators/{v5 → core-2}/remix/index.js

@@ -1,5 +1,6 @@
 import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const version = 'v5';
+const version = 'core-2';
+const semverVersion = 'v4';
 const name = 'remix';
 const properName = 'Remix';
 const packageName = '@clerk/remix';
@@ -13,7 +14,7 @@ async function generate() {
     title: `Upgrading ${properName} to Core 2`,
     description: `Learn how to upgrade from the Clerk ${properName} SDK to the latest version.`
   }), `# Upgrading \`${packageName}\` to Core 2`, markdown('intro'), markdownTemplate('prepare', {
-    version: 'v4',
+    version: semverVersion,
     packageName
   }), markdown('node-version'), markdown('react-version'), markdownTemplate('update-version', {
     packageName

package/dist/guide-generators/core-2/remix/intro.mdx

@@ -0,0 +1,3 @@
+Core 2 is included in the Remix SDK starting with version 4. This new version 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.
+
+By the end of this guide, you’ll have successfully upgraded your Remix project to use `@clerk/remix` v4. You’ll learn how to update your dependencies, resolve breaking changes, and find deprecations. Step-by-step instructions will lead you through the process.

package/dist/guide-generators/{v5 → core-2}/retheme/index.js

@@ -1,24 +1,23 @@
 import { accordionForCategory, assembleContent, frontmatter, loadVersionChangeData, markdown, writeToFile } from '../../text-generation.js';
-const cwd = 'v5/retheme';
+const cwd = 'core-2/retheme';
 async function generate() {
-  const data = await loadVersionChangeData('v5', 'nextjs');
+  const data = await loadVersionChangeData('core-2', 'nextjs');
   const defaultsChangeItem = {
     title: 'Changes to default variables',
     content: `\nThe 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.\n`
+    - The default \`fontWeight\` values changed from \`{ normal: 400, medium: 500, bold: 600 }\` to \`{ normal: 400, medium: 500, semibold: 600, bold: 700 }\`.\n`
   };
   return assembleContent({
     data: data,
     cwd
   }, [frontmatter({
-    title: 'Redesigned Components in v5',
-    description: 'Learn how to handle changes as a result of redesigned components in Clerk version 5'
-  }), '# Redesigned Components in v5', markdown('intro'), '## Appearance Changes', accordionForCategory('appearance', {
-    additionalItems: defaultsChangeItem
+    title: 'Redesigned Components in Core 2',
+    description: 'Learn how to handle changes as a result of redesigned components in Clerk Core 2'
+  }), '# Redesigned Components in Core 2', markdown('intro'), '## Appearance Changes', accordionForCategory('appearance', {
+    additionalItems: [defaultsChangeItem]
   }), '## Localization Changes', accordionForCategory('localization')]);
 }
 generate().then(writeToFile(cwd));

package/dist/guide-generators/{v5 → core-2}/shared/cli.mdx

@@ -1,6 +1,6 @@
 ## CLI upgrade helper
 
-As of this release cycle, Clerk provides a `@clerk/upgrade` CLI tool that you can use to ease the upgrade. The tool will scan your codebase and produce a list of changes you'll need to apply to your project. It should catch the vast majority of the changes needed for a successful upgrade to Core 2. This can save you a lot of time reading through changes that don't apply to your project.
+Clerk now provides a `@clerk/upgrade` CLI tool that you can use to ease the upgrade process. The tool will scan your codebase and produce a list of changes you'll need to apply to your project. It should catch the vast majority of the changes needed for a successful upgrade to any SDK including Core 2. This can save you a lot of time reading through changes that don't apply to your project.
 
 To run the CLI tool, navigate to your project and run it in the terminal:
 

package/dist/guide-generators/{v5 → core-2}/shared/prepare.mdx

@@ -1,6 +1,6 @@
 ## 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.
+Before uprading, it's highly recommended that you update your Clerk SDKs to the latest Core 1 version (`npm i <%= packageName %>@<%= parseInt(version.substring(1)) - 1 %>`). Some changes required for Core 2 SDKs can be applied incrementally to the <%= 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

package/dist/{util/v5-guides → guide-generators/core-2/shared}/redesign-preview.mdx

@@ -2,4 +2,4 @@
 
 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)
+[More detail on these changes »](component-redesign)

package/dist/util/load-change.js

@@ -11,8 +11,8 @@ export default function createLoader({
     // Note: This could benefit perf-wise by being converted to async, but it would
     // make the code a decent amount more complex.
     return slugs.map(slug => {
-      const sdkPath = path.join(__dirname, '../versions', `v${version}`, sdk, `${slug}.md`);
-      const sharedPath = path.join(__dirname, '../versions', `v${version}`, 'common', `${slug}.md`);
+      const sdkPath = path.join(__dirname, '../versions', `${version}`, sdk, `${slug}.md`);
+      const sharedPath = path.join(__dirname, '../versions', `${version}`, 'common', `${slug}.md`);
       const loadPath = fs.existsSync(sdkPath) ? sdkPath : sharedPath;
       const content = fs.readFileSync(loadPath, 'utf8');
       const parsed = matter(content);

package/dist/versions/core-2/common/appearance-variables-breaking-changes.md

@@ -0,0 +1,15 @@
+---
+title: 'Breaking Changes to appearance variables'
+matcherFlags: 'm'
+category: 'appearance'
+matcher:
+  - "variables:\\s+{[\\s\\S]*?fontSmoothing:"
+  - "variables:\\s+{[\\s\\S]*?shadowShimmer:"
+  - "variables:\\s+{[\\s\\S]*?colorAlphaShade:"
+---
+
+Several appearance variables have been removed or renamed. If you were using these variables in your application, you will need to update your code to use the new variables.
+
+- The `fontSmoothing` variable has been removed.
+- The `shadowShimmer` variable has been removed.
+- The `colorAlphaShade` variable has been renamed to `colorNeutral`.