@clerk/upgrade 1.0.8 → 1.0.9

package/README.md

@@ -6,10 +6,9 @@
     </picture>
   </a>
   <br />
+  <h1 align="center">@clerk/upgrade</h1>
 </p>
 
-# @clerk/upgrade
-
 <div align="center">
 
 [![Chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord)
@@ -22,29 +21,29 @@
 ·
 [Request a Feature](https://feedback.clerk.com/roadmap)
 ·
-[Ask a Question](https://github.com/clerk/javascript/discussions)
+[Get help](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_upgrade)
 
 </div>
 
----
-
-## Overview
+## Getting Started
 
 A tool that helps with upgrading major versions of Clerk's SDKs.
 
-## Getting Started
-
 ### Prerequisites
 
 - Node.js `>=18.17.0` or later
 
-### Usage
+## Usage
+
+Navigate to the application you want to upgrade and run the following in your terminal:
 
 ```sh
 npx @clerk/upgrade
 ```
 
-## Caveats
+Fill out the questionnaire and the CLI will show you the required changes.
+
+### Caveats
 
 This tool uses regular expressions to scan for patterns that match breaking changes. This makes it run substantially faster and makes it more accessible for us at Clerk to author matchers for each breaking change, however it means that _we cannot gurarantee 100% accuracy of the results_. As such, it's important to treat this as a tool that can help you to complete your major version upgrades, rather than an automatic fix to all issues.
 
@@ -65,12 +64,11 @@ Overall, there's a very good chance that this tool catches everything, but it's
 You can get in touch with us in any of the following ways:
 
 - Join our official community [Discord server](https://clerk.com/discord)
-- Create a [GitHub Discussion](https://github.com/clerk/javascript/discussions)
-- Contact options listed on [our Support page](https://clerk.com/support?utm_source=github&utm_medium=clerk_upgrade)
+- On [our support page](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_upgrade)
 
 ## Contributing
 
-We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md).
+We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md) and [code of conduct](https://github.com/clerk/javascript/blob/main/docs/CODE_OF_CONDUCT.md).
 
 ## Security
 

package/dist/constants/sdks.js

@@ -4,9 +4,7 @@ export default [{
 }, {
   label: '@clerk/remix',
   value: 'remix'
-},
-// { label: 'gatsby-plugin-clerk', value: 'gatsby' },
-{
+}, {
   label: '@clerk/redwood',
   value: 'redwood'
 }, {

package/dist/guide-generators/core-2/generate-all.sh

@@ -7,7 +7,6 @@ node $SCRIPT_DIR/backend/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
 node $SCRIPT_DIR/js/index.js
 node $SCRIPT_DIR/nextjs/index.js
 node $SCRIPT_DIR/node/index.js

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

@@ -22,4 +22,4 @@ We expect upgrades to take less than 30 minutes, and are providing a CLI tool to
 - [JS](/docs/upgrade-guides/core-2/javascript)
 - [Chrome Extension](/docs/upgrade-guides/core-2/chrome-extension)
 
-Note that the `Gatsby`, `Go`, and `Ruby` SDKs do not yet have a Core 2 release ready - if you are using any of these SDKs there is nothing actionable right now.
+Note that the `Go`, and `Ruby` SDKs do not yet have a Core 2 release ready - if you are using any of these SDKs there is nothing actionable right now.

package/dist/versions/core-2/index.js

@@ -8,9 +8,6 @@ const jsChanges = ['setsession', 'organization-create-string', 'organization-get
 const reactChanges = ['magiclinkerrorcode', 'usemagiclink', 'ismagiclinkerror', 'magiclinkerror', 'handlemagiclinkverification', 'clerkprovider-frontendapi-2', 'navigate-to-routerpush-routerreplace', 'afterswitchorganizationurl', 'appearance-organizationpreview-organizationswitcher', 'useorganization-invitationlist', 'useorganization-membershiplist', 'useorganizations', 'userprofile-prop', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'withsession-removed', 'withclerk-removed', 'withuser-removed-2', 'withclerk-hof-removed', 'withsession-hof-removed', 'withuser-hof-removed', 'multisessionappsupport-import-change', 'clerkprovideroptionswrapper-dropped', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'min-react-version', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'];
 export default {
   nextjs: load('nextjs', dedupeMerge(changesAffectingAll, jsChanges, ['api-key-to-secret-key', 'frontend-api-to-publishable-key', 'with-clerk-middleware-removed', 'auth-middleware-deprecated', 'clerk-js-version-next-public', 'authmiddleware-apikey', 'authmiddleware-frontendapi', 'createclerkclient-apikey', 'createclerkclient-frontendapi', 'getauth-apikey', 'clerkprovider-frontendapi-2', 'import-nextjs-app-beta', 'import-nextjs-ssr', 'import-nextjs-edge-middleware', 'import-nextjs-edge-middlewarefiles', 'import-api-url', 'import-api-version', 'import-clerk-js-url', 'import-clerk-js-version', 'import-domain', 'import-is-satellite', 'import-proxy-url', 'import-publishable-key', 'import-secret-key', 'import-sign-in-url', 'import-sign-up-url', 'import-nextjs-api', 'api-url-value-change', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'multisessionappsupport-import-change', 'auth-import-change', 'currentuser-import-change', 'authmiddleware-import-change', 'buildclerkprops-import-change', 'verifytoken-import-change', 'verifyjwt-import-change', 'decodejwt-import-change', 'signjwt-import-change', 'constants-import-change', 'createauthenticaterequest-import-change', 'createisomorphicrequest-import-change', 'clerk-import-change', 'isclerkapiresponserror-import-change', 'isemaillinkerror-import-change', 'isknownerror-import-change', 'ismetamaskerror-import-change', 'withsession-removed', 'withclerk-removed', 'withuser-removed-2', 'withclerk-hof-removed', 'withsession-hof-removed', 'withuser-hof-removed', 'next-public-clerk-js-url', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'min-nextjs-version', 'redirecttosignin-import-path', 'redirecttosignup-import-path', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
-  // since we export clerk-react at the top level from the gatsby plugin
-  // if you're using gatsby, we also need to scan for the react changes
-  gatsby: load('gatsby', dedupeMerge(changesAffectingAll, reactChanges, jsChanges, ['api-key-to-secret-key', 'createclerkclient-apikey', 'apikey-to-publishable-key', 'createclerkclient-frontendapi', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'api-url-value-change', 'withserverauth-return-type', 'clerk-import-change'])),
   remix: load('remix', dedupeMerge(changesAffectingAll, jsChanges, ['clerkerrorboundary-removed', 'createclerkclient-apikey', 'rootauthloader-apikey', 'getauth-apikey', 'clerkprovider-frontendapi-2', 'rootauthloader-frontendapi', 'frontend-api-to-publishable-key', 'api-key-to-secret-key', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'clerk-import-change', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
   expo: load('expo', dedupeMerge(changesAffectingAll, jsChanges, ['apikey-to-publishable-key', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'organizationprofile-settings', 'userprofile-security', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),
   fastify: load('fastify', dedupeMerge(changesAffectingAll, ['api-key-to-secret-key', 'api-url-value-change', 'frontend-api-to-publishable-key', 'createclerkclient-apikey', 'createclerkclient-frontendapi', 'clerkplugin-frontendapi', 'clerk-import-change', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl'])),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerk/upgrade",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "license": "MIT",
   "type": "module",
   "main": "dist/cli.js",

package/dist/guide-generators/core-2/gatsby/index.js

@@ -1,25 +0,0 @@
-import { accordionForCategory, assembleContent, deprecationRemovalsAndHousekeeping, frontmatter, loadVersionChangeData, markdown, markdownTemplate, singleItem, writeToFile } from '../../text-generation.js';
-const version = 'core-2';
-const semverVersion = 'v5';
-const name = 'gatsby';
-const properName = 'Gatsby';
-const packageName = 'gatsby-plugin-clerk';
-const cwd = `${version}/${name}`;
-async function generate() {
-  const data = await loadVersionChangeData(version, name);
-  return assembleContent({
-    data,
-    cwd
-  }, [frontmatter({
-    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'
-  }), markdown('cli'), '## Breaking Changes', markdown('redesign-preview'), markdown('after-sign-x-handling'), singleItem('aftersignxurl-changes'), markdown('orgs-claim'), markdownTemplate('path-routing', {
-    packageName
-  }), markdown('image-url'), accordionForCategory('image-url'), deprecationRemovalsAndHousekeeping()]);
-}
-generate().then(writeToFile(cwd));

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

@@ -1,3 +0,0 @@
-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/versions/core-2/gatsby/api-url-value-change.md

@@ -1,8 +0,0 @@
----
-title: '`API_URL` value has changed'
-matcher: "import\\s+{[^}]*?[,\\s]API_URL[,\\s][\\s\\S]*?from\\s+['\"]gatsby-plugin-clerk\\/constants[\\s\\S]*?['\"]"
-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.

package/dist/versions/core-2/gatsby/apikey-to-publishable-key.md

@@ -1,7 +0,0 @@
----
-title: '`GATSBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
-category: 'deprecation-removal'
-matcher: 'GATSBY_CLERK_FRONTEND_API'
----
-
-If you are using a `GATSBY_CLERK_FRONTEND_API` environment variable, the name must be changed to `GATSBY_CLERK_PUBLISHABLE_KEY` instead. Note that the values are different as well, so this is not just a key replacement. You can find the publishable key in your Clerk dashboard. Make sure you do this in both your dev and production environments.

package/dist/versions/core-2/gatsby/clerk-import-change.md

@@ -1,12 +0,0 @@
----
-title: '`Clerk` -> `{ createClerkClient }`'
-matcher: "import\\s+{[^}]*?[,\\s]Clerk[,\\s][\\s\\S]*?from\\s+['\"]gatsby-plugin-clerk[\\s\\S]*?['\"]"
-matcherFlags: 'm'
----
-
-The `Clerk` default import has changed to `createClerkClient` and been moved to a named import rather than default. 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 Clerk from "gatsby-plugin-clerk"
-+ import { createClerkClient } from "gatsby-plugin-clerk"
-```

package/dist/versions/core-2/gatsby/createclerkclient-apikey.md

@@ -1,15 +0,0 @@
----
-title: '`apiKey` -> `secretKey` as param to createClerkClient'
-matcher: "createClerkClient\\([\\s\\S]*?apiKey:[\\s\\S]*?\\)"
-category: 'deprecation-removal'
-matcherFlags: 'm'
----
-
-The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`.
-
-```diff
-import { createClerkClient } from 'gatsby-plugin-clerk/api';
-
-- createClerkClient({ apiKey: '...' });
-+ createClerkClient({ secretKey: '...' });
-```

package/dist/versions/core-2/gatsby/createclerkclient-frontendapi.md

@@ -1,15 +0,0 @@
----
-title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
-matcher: "createClerkClient\\([\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
-category: 'deprecation-removal'
-matcherFlags: 'm'
----
-
-The `frontendApi` argument passed to `createClerkClient` must be changed to `publishableKey`. Note that the values of the two keys are different, so both keys and values need to be changed. You can find your application's publishable key in the Clerk dashboard.
-
-```diff
-import { createClerkClient } from 'gatsby-plugin-clerk/api';
-
-- createClerkClient({ frontendApi: '...' });
-+ createClerkClient({ publishableKey: '...' });
-```

package/dist/versions/core-2/gatsby/withserverauth-return-type.md

@@ -1,35 +0,0 @@
----
-title: '`withServerAuth` props.auth return type changed'
-matcher: "withServerAuth\\("
----
-
-When utilizing the `withServerAuth` helper in Gatsby, it expects a callback function that is called with props from Clerk internals. The `.auth` property on the returned object from the callback has seen a substantial change in its return type. Below is a code example of where the `auth` prop might be found:
-
-```js
-import { withServerAuth } from 'gatsby-plugin-clerk/ssr';
-
-export const getServerData: GetServerData<any> = withServerAuth(async props => {
-  return { props: { data: '...', auth: props.auth } };
-});
-```
-
-And here's a diff of the changes in the return type. The breaking change here specifically is that the property `auth.claims` was changed to `auth.sessionClaims`. Additionally, there is more information on the response that can be utilized if helpful.
-
-```diff
- // return type diff
- {
-   sessionId: string | null;
-   userId: string | null;
-   actor: ActJWTClaim | null;
-   getToken: ServerGetToken;
--  claims: ClerkJWTClaims | null;
-+  sessionClaims: JwtPayload;
-+  session: Session | undefined | null;
-+  user: User | undefined | null;
-+  orgId: string | undefined | null;
-+  orgRole: string | undefined | null;
-+  orgSlug: string | undefined | null;
-+  organization: Organization | undefined | null;
-+  debug: AuthObjectDebug;
- };
-```