@clerk/upgrade 0.2.0 → 0.3.0

package/dist/versions/v5/nextjs/import-sign-up-url.md

@@ -0,0 +1,8 @@
+---
+title: '`SIGN_UP_URL` constant removed'
+matcher: "import\\s+{[\\s\\S]*?SIGN_UP_URL[\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
+category: 'deprecation-removal'
+matcherFlags: 'm'
+---
+
+This deprecated constant has been removed as an export from `@clerk/nextjs`. Instead, set and use the `NEXT_PUBLIC_CLERK_SIGN_UP_URL` environment variable.

package/dist/versions/v5/nextjs/isclerkapiresponserror-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`isClerkAPIResponseError` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?isClerkAPIResponseError[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/errors'
+---
+
+The `isClerkAPIResponseError` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/errors`. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { isClerkAPIResponseError } from "@clerk/nextjs"
++ import { isClerkAPIResponseError } from "@clerk/nextjs/errors"
+```

package/dist/versions/v5/nextjs/isemaillinkerror-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`isEmailLinkError` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?isEmailLinkError[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/errors'
+---
+
+The `isEmailLinkError` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/errors`. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { isEmailLinkError } from "@clerk/nextjs"
++ import { isEmailLinkError } from "@clerk/nextjs/errors"
+```

package/dist/versions/v5/nextjs/isknownerror-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`isKnownError` import moved under `/errors`'
+matcher: "import\\s+{[\\s\\S]*?isKnownError[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/errors'
+---
+
+The `isKnownError` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/errors`. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { isKnownError } from "@clerk/nextjs"
++ import { isKnownError } from "@clerk/nextjs/errors"
+```

package/dist/versions/v5/nextjs/min-nextjs-version.md

@@ -0,0 +1,11 @@
+---
+title: 'Upgrade nextjs to v13 or higher'
+category: 'version'
+matcher: "dependencies\":\\s*{[\\s\\S]*?\"next\":\\s*\"(?:^|~|>|=|\\s)*(?:10|11|12)\\..*?"
+matcherFlags: 'm'
+---
+
+If you're using `@clerk/nextjs`, you will need to update your Next.js project to `13.0.4` or later. Check out Next's upgrade guides for help:
+
+- [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/versions/v5/nextjs/multisessionappsupport-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`MultiSessionAppSupport` import moved under `/internal`'
+matcher: "import\\s+{[\\s\\S]*?MultiSessionAppSupport[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+category: 'deprecation-removal'
+matcherFlags: 'm'
+replaceWithString: 'nextjs/internal'
+---
+
+The `MultiSessionAppSupport` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/internal`. You must update your import path in order for it to work correctly. Note that internal imports are not intended for usage and are outside the scope of semver. Example below of the fix that needs to be made:
+
+```diff
+- import { MultiSessionAppSupport } from "@clerk/nextjs"
++ import { MultiSessionAppSupport } from "@clerk/nextjs/internal"
+```

package/dist/versions/v5/nextjs/next-public-clerk-js-url.md

@@ -0,0 +1,7 @@
+---
+title: '`NEXT_PUBLIC_CLERK_JS` should be `NEXT_PUBLIC_CLERK_JS_URL`'
+category: 'deprecation-removal'
+matcher: 'NEXT_PUBLIC_CLERK_JS[^_]*$'
+---
+
+If you are using `NEXT_PUBLIC_CLERK_JS` as an environment variable, it should be changed to `NEXT_PUBLIC_CLERK_JS_URL` instead. This variable was renamed for consistency across public APIs. Make sure to also check your production host configuration when changing environment variable values.

package/dist/versions/v5/nextjs/redirect-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`redirect` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?[,\\s]redirect[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/server'
+---
+
+The `redirect` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { redirect } from "@clerk/nextjs"
++ import { redirect } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/nextjs/redirecttosignin-import-path.md

@@ -0,0 +1,13 @@
+---
+title: '`redirectToSignIn` import moved under `/server'
+matcher: "import\\s+{[\\s\\S]*?[,\\s]redirectToSignIn[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+category: 'top-level-imports'
+replaceWithString: 'nextjs/server'
+---
+
+The `redirectToSignIn` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { redirectToSignIn } from "@clerk/nextjs"
++ import { redirectToSignIn } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/nextjs/redirecttosignup-import-path.md

@@ -0,0 +1,13 @@
+---
+title: '`redirectToSignUp` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?[,\\s]redirectToSignUp[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+category: 'top-level-imports'
+replaceWithString: 'nextjs/server'
+---
+
+The `redirectToSignUp` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { redirectToSignUp } from "@clerk/nextjs"
++ import { redirectToSignUp } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/nextjs/signjwt-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`signJwt` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?signJwt[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/server'
+---
+
+The `signJwt` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { signJwt } from "@clerk/nextjs"
++ import { signJwt } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/nextjs/verifyjwt-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`verifyJwt` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?verifyJwt[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/server'
+---
+
+The `verifyJwt` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { verifyJwt } from "@clerk/nextjs"
++ import { verifyJwt } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/nextjs/verifytoken-import-change.md

@@ -0,0 +1,14 @@
+---
+title: '`verifyToken` import moved under `/server`'
+matcher: "import\\s+{[\\s\\S]*?verifyToken[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
+matcherFlags: 'm'
+category: 'top-level-imports'
+replaceWithString: 'nextjs/server'
+---
+
+The `verifyToken` import path has changed from `@clerk/nextjs` to `@clerk/nextjs/server`, as this is a helper that should be only used on the server side. You must update your import path in order for it to work correctly. Example below of the fix that needs to be made:
+
+```diff
+- import { verifyToken } from "@clerk/nextjs"
++ import { verifyToken } from "@clerk/nextjs/server"
+```

package/dist/versions/v5/nextjs/with-clerk-middleware-removed.md

@@ -0,0 +1,56 @@
+---
+title: '`withClerkMiddleware` removed'
+category: 'middleware'
+matcher: "withClerkMiddleware\\("
+---
+
+`withClerkMiddleware` has been deprecated and is now removed in v5. We recommend moving to `clerkMiddleware` instead. Please read the [clerkMiddleware guide](https://clerk.com/docs/references/nextjs/clerk-middleware) for more details. Here’s an example of how a simple middleware setup might look before and after.
+
+```js
+// Before: using withClerkMiddleware
+import { withClerkMiddleware } from '@clerk/nextjs/server';
+import { NextResponse } from 'next/server';
+import type { NextRequest } from 'next/server';
+
+const publicPaths = ['/', '/sign-in', '/sign-up'];
+
+const isPublic = (path: string) => {
+  return publicPaths.find(x => path.match(new RegExp(`^${x}$`.replace('*$', '($|/)'))));
+
+  if (isPublic(request.nextUrl.pathname)) {
+    return NextResponse.next();
+  }
+  const { userId } = getAuth(request);
+
+  if (!userId) {
+    const signInUrl = new URL('/sign-in', request.url);
+    signInUrl.searchParams.set('redirect_url', request.url);
+    return NextResponse.redirect(signInUrl);
+  }
+};
+
+export default withClerkMiddleware((req: NextRequest) => {
+  return NextResponse.next();
+});
+
+export const config = {
+  matcher: ['/((?!static|.*\\..*|_next|favicon.ico).*)', '/'],
+};
+```
+
+```js
+// After: using clerkMiddleware
+import { clerkMiddleware, createRouteMatcher } from '@clerk/nextjs';
+
+const isPublicRoute = createRouteMatcher(['/', '/sign-in', '/sign-up']);
+
+export default clerkMiddleware((auth, req) => {
+  if (isPublicRoute(req)) return;
+
+  auth().protect();
+});
+
+export const config = {
+  matcher: ['/((?!.+\\.[\\w]+$|_next).*)', '/', '/(api|trpc)(.*)'],
+};
+```

package/dist/versions/v5/node/cjs-esm-instance.md

@@ -1,6 +1,7 @@
 ---
 title: '`cjs/instance` and `esm/instance` imports no longer needed'
 matcher: "@clerk\\/clerk-sdk-node(\\/(?:cjs|esm)\\/instance)"
+category: 'cjs-esm-instance'
 replaceWithString: ''
 ---
 

package/dist/versions/v5/node/clerkexpressrequireauth-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to ClerkExpressRequireAuth'
 matcher: "ClerkExpressRequireAuth\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/clerkexpressrequireauth-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to ClerkExpressRequireAuth'
 matcher: "ClerkExpressRequireAuth\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/clerkexpresswithauth-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to ClerkExpressWithAuth'
 matcher: "ClerkExpressWithAuth\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/clerkexpresswithauth-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to ClerkExpressWithAuth'
 matcher: "ClerkExpressWithAuth\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/createclerkclient-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to createClerkClient'
 matcher: "createClerkClient\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/createclerkclient-frontendapi.md

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

package/dist/versions/v5/node/createclerkexpressrequireauth-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to createClerkExpressRequireAuth'
 matcher: "createClerkExpressRequireAuth\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/createclerkexpressrequireauth-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to createClerkExpressRequireAuth'
 matcher: "createClerkExpressRequireAuth\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/createclerkexpresswithauth-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as param to createClerkExpressWithAuth'
 matcher: "createClerkExpressWithAuth\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/createclerkexpresswithauth-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as param to createClerkExpressWithAuth'
 matcher: "createClerkExpressWithAuth\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/node/legacyauthobject-removed.md

@@ -3,7 +3,7 @@ title: '`LegacyAuthObject` type -> `AuthObject`'
 matcher: '(?:LegacyAuthObject|LooseAuthProp|StrictAuthProp)'
 ---
 
-We changed the values that our middleware adds to the `request` object after running. Previously it returned a `LegacyAuthObject` type, and now it returns an `AuthObject` type, the difference between the two types is as such:
+We changed the values that our middleware adds to the `request` object after running. Previously it returned a `LegacyAuthObject` type, and now it returns an `AuthObject` type, the difference between the two types is as such:
 
 ```diff
 - type LegacyAuthObject = {
@@ -14,7 +14,7 @@ We changed the values that our middleware adds to the `request` object after r
     getToken: ServerGetToken | null;
     debug: AuthObjectDebug | null;
 -   claims: JwtPayload | null;
--   sessionClaims: JwtPayload | null;
++   sessionClaims: JwtPayload | null;
 +   orgId: string | undefined | null;
 +   orgRole: OrganizationCustomRoleKey | undefined | null;
 +   orgSlug: string | undefined | null;
@@ -23,4 +23,4 @@ We changed the values that our middleware adds to the `request` object after r
   }
 ```
 
-If you were using the `claims` key on the request after running middleware, you will need to instead use `sessionClaims`. Additionally, if you were using the `LooseAuthProp` or `StrictAuthProp` exported types anywhere, note that these have been adjusted to fit the shape of the new middleware response typing.
+If you were using the `claims` key on the request after running middleware, you will need to instead use `sessionClaims`. Additionally, if you were using the `LooseAuthProp` or `StrictAuthProp` exported types anywhere, note that these have been adjusted to fit the shape of the new middleware response typing.

package/dist/versions/v5/node/setclerkapikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`setClerkApiKey` removed, pass `secretKey` to `createClerkClient` instead'
 matcher: "setClerkApiKey\\("
+category: 'setter-removal'
 ---
 
 Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail. Note that the name `apiKey` should now be `secretKey` as well.

package/dist/versions/v5/node/setclerkapiversion.md

@@ -1,6 +1,7 @@
 ---
 title: '`setClerkApiVersion` removed, pass options to `createClerkClient` instead'
 matcher: "setClerkApiVersion\\("
+category: 'setter-removal'
 ---
 
 Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail.

package/dist/versions/v5/node/setclerkhttpoptions.md

@@ -1,6 +1,7 @@
 ---
 title: '`setClerkHttpOptions` removed, pass options to `createClerkClient` instead'
 matcher: "setClerkHttpOptions\\("
+category: 'setter-removal'
 ---
 
 Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail.

package/dist/versions/v5/node/setclerkserverapiurl.md

@@ -1,6 +1,7 @@
 ---
 title: '`setClerkServerApiUrl` removed, pass options to `createClerkClient` instead'
 matcher: "setClerkServerApiUrl\\("
+category: 'setter-removal'
 ---
 
 Setters that change options on the singleton `clerkClient` instance have been removed. Instead, pass the option directly to `createClerkClient` - see [the documentation](https://clerk.com/docs/references/nodejs/overview#customizing-resources) for more detail.

package/dist/versions/v5/react/api-url-value-change.md

@@ -5,4 +5,4 @@ matcherFlags: 'm'
 warning: true
 ---
 
-- The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.
+The value of this export has changed from `https://api.clerk.dev` to `https://api.clerk.com`. If you were relying on the text content of this value not changing, you may need to make adjustments.

package/dist/versions/v5/remix/clerk-import-change.md

@@ -1,6 +1,7 @@
 ---
 title: '`Clerk` -> `{ createClerkClient }`'
 matcher: "import\\s+{[\\s\\S]*?[,\\s]Clerk[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/remix[\\s\\S]*?['\"]"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/remix/clerkerrorboundary-removed.md

@@ -1,6 +1,7 @@
 ---
 title: '`ClerkErrorBoundary` removed'
 matcher: "import\\s+{[\\s\\S]*?ClerkErrorBoundary[\\s\\S]*?from\\s+['\"]@clerk\\/remix[\\s\\S]*?['\"]"
+category: 'error-boundary-removed'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/remix/createclerkclient-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as argument to createClerkClient'
 matcher: "createClerkClient\\({[\\s\\S]*?apiKey:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/remix/getauth-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as argument to getAuth'
 matcher: "getAuth\\({[\\s\\S]*?apiKey:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/remix/rootauthloader-apikey.md

@@ -1,6 +1,7 @@
 ---
 title: '`apiKey` -> `secretKey` as argument to rootAuthLoader'
 matcher: "rootAuthLoader\\({[\\s\\S]*?apiKey:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/dist/versions/v5/remix/rootauthloader-frontendapi.md

@@ -1,6 +1,7 @@
 ---
 title: '`frontendApi` -> `publishableKey` as argument to rootAuthLoader'
 matcher: "rootAuthLoader\\({[\\s\\S]*?frontendApi:[\\s\\S]*?}\\)"
+category: 'deprecation-removal'
 matcherFlags: 'm'
 ---
 

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@clerk/upgrade",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "MIT",
   "type": "module",
   "main": "dist/cli.js",
-  "bin": "dist/cli.js",
+  "bin": {
+    "clerk-upgrade": "dist/cli.js"
+  },
   "files": [
     "dist"
   ],
@@ -21,6 +23,7 @@
   "dependencies": {
     "@inkjs/ui": "^1.0.0",
     "@jescalan/ink-markdown": "^2.0.0",
+    "ejs": "3.1.9",
     "globby": "^14.0.0",
     "gray-matter": "^4.0.3",
     "index-to-position": "^0.1.2",