@clerk/upgrade 1.0.7 → 1.0.8-canary.v1e57618

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Clerk, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,10 +1,46 @@
+<p align="center">
+  <a href="https://clerk.com?utm_source=github&utm_medium=clerk_upgrade" target="_blank" rel="noopener noreferrer">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png">
+      <img src="https://images.clerk.com/static/logo-light-mode-400x400.png" height="64">
+    </picture>
+  </a>
+  <br />
+</p>
+
 # @clerk/upgrade
 
+<div align="center">
+
+[![Chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord)
+[![Clerk documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://clerk.com/docs?utm_source=github&utm_medium=clerk_upgrade)
+[![Follow on Twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev)
+
+[Changelog](https://github.com/clerk/javascript/blob/main/packages/upgrade/CHANGELOG.md)
+·
+[Report a Bug](https://github.com/clerk/javascript/issues/new?assignees=&labels=needs-triage&projects=&template=BUG_REPORT.yml)
+·
+[Request a Feature](https://feedback.clerk.com/roadmap)
+·
+[Ask a Question](https://github.com/clerk/javascript/discussions)
+
+</div>
+
+---
+
+## Overview
+
 A tool that helps with upgrading major versions of Clerk's SDKs.
 
-## Usage
+## Getting Started
+
+### Prerequisites
+
+- Node.js `>=18.17.0` or later
 
-```bash
+### Usage
+
+```sh
 npx @clerk/upgrade
 ```
 
@@ -12,7 +48,7 @@ npx @clerk/upgrade
 
 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.
 
-The main thing that this tool will miss is cases where _unusual import patterns_ are used in your codebase.As an example, if we made a breaking change to the `getAuth` function exported from `@clerk/nextjs`, we would likely look for something like `import { getAuth } from "@clerk/nextjs"` in order to detect whether you need to make some changes. If you were running your imports like `import * as ClerkNext from "@clerk/nextjs"`, you could use `getAuth` without us detecting it with our matcher.
+The main thing that this tool will miss is cases where _unusual import patterns_ are used in your codebase. As an example, if Clerk made a breaking change to the `getAuth` function exported from `@clerk/nextjs`, `@clerk/upgrade` would likely look for something like `import { getAuth } from "@clerk/nextjs"` in order to detect whether you need to make some changes. If you were using your imports like `import * as ClerkNext from "@clerk/nextjs"`, you could use `getAuth` without it detecting it with its matcher.
 
 It will also be very likely to miss if you bind a method on an object to a separate variable and call it from there, or pass a bound method through a function param. For example, something like this:
 
@@ -22,4 +58,30 @@ const updateUser = user.update.bind(user);
 updateUser({ username: 'foo' });
 ```
 
-Overall, there's a very good chance that this tool catches everything, but it's not a guarantee, so make sure that you also test your app before deploying, and that you have good e2e test coverage, which are good practices normally anyway, rather than blindly trusting that since the clerk upgrade tool was run, you are for sure covered.
+Overall, there's a very good chance that this tool catches everything, but it's not a guarantee. Make sure that you also test your app before deploying, and that you have good E2E test coverage.
+
+## Support
+
+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)
+
+## 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).
+
+## Security
+
+`@clerk/upgrade` follows good practices of security, but 100% security cannot be assured.
+
+`@clerk/upgrade` is provided **"as is"** without any **warranty**. Use at your own risk.
+
+_For more information and to report security issues, please refer to our [security documentation](https://github.com/clerk/javascript/blob/main/docs/SECURITY.md)._
+
+## License
+
+This project is licensed under the **MIT license**.
+
+See [LICENSE](https://github.com/clerk/javascript/blob/main/packages/upgrade/LICENSE) for more information.

package/dist/app.js

@@ -22,8 +22,11 @@ export default function App({
   const [sdkGuesses, setSdkGuesses] = useState([]);
   const [sdkGuessConfirmed, setSdkGuessConfirmed] = useState(false);
   const [sdkGuessAttempted, setSdkGuessAttempted] = useState(false);
+  // See comments below, can be enabled on next major
+  // eslint-disable-next-line no-unused-vars
   const [fromVersion, setFromVersion] = useState(_fromVersion);
   const [fromVersionGuessAttempted, setFromVersionGuessAttempted] = useState(false);
+  // eslint-disable-next-line no-unused-vars
   const [toVersion, setToVersion] = useState(_toVersion);
   const [dir, setDir] = useState(_dir);
   const [ignore, setIgnore] = useState(_ignore);
@@ -38,11 +41,17 @@ export default function App({
 
   // We try to guess which SDK they are using
   if (isEmpty(sdks) && isEmpty(sdkGuesses) && !sdkGuessAttempted) {
-    if (!dir) return setDir(process.cwd());
+    if (!dir) {
+      return setDir(process.cwd());
+    }
     const {
       guesses,
       _uuid
     } = guessFrameworks(dir, disableTelemetry);
+    console.log({
+      guesses,
+      _uuid
+    });
     setUuid(_uuid);
     setSdkGuesses(guesses);
     setSdkGuessAttempted(true);
@@ -87,7 +96,9 @@ export default function App({
     onChange: item => {
       setSdkGuessConfirmed(true);
       // if true, we were right so we set the sdk
-      if (item === 'yes') setSdks(sdkGuesses.map(guess => guess.value));
+      if (item === 'yes') {
+        setSdks(sdkGuesses.map(guess => guess.value));
+      }
     }
   })), isEmpty(sdks) && isEmpty(sdkGuesses) && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "Please select which Clerk SDK(s) you're using for your app:"), /*#__PURE__*/React.createElement(Text, {
     color: "gray"

package/dist/guide-generators/text-generation.js

@@ -65,7 +65,9 @@ export const accordionForCategory = partial((categories, options, {
 }) => {
   const items = filterCategories(data, categories);
   options ||= {};
-  if (options.additionalItems) items.push(...[].concat(options.additionalItems));
+  if (options.additionalItems) {
+    items.push(...[].concat(options.additionalItems));
+  }
   return `<Accordion titles={[${items.map(i => `"${parseInline(i.title)}"`).join(', ')}]}>
 ${items.map(i => `  <AccordionPanel>${indent('\n' + i.content.trim(), 4)}\n  </AccordionPanel>`).join('\n')}
 </Accordion>`;

package/dist/scan.js

@@ -53,7 +53,6 @@ export default function Scan({
     // common image files
     '**/*.(mp4|mkv|wmv|m4v|mov|avi|flv|webm|flac|mka|m4a|aac|ogg)+' // common video files
     );
-
     globby(convertPathToPattern(path.resolve(dir)), {
       ignore: ignore.filter(Boolean)
     }).then(files => {
@@ -65,7 +64,9 @@ export default function Scan({
   // ---------------------------
   // result = `results` set to format
   useEffect(() => {
-    if (!matchers || !files) return;
+    if (!matchers || !files) {
+      return;
+    }
     const allResults = {};
     Promise.all(
     // first we read all the files
@@ -86,17 +87,23 @@ export default function Scan({
           } else {
             matches = Array.from(content.matchAll(matcherConfig.matcher));
           }
-          if (matches.length < 1) return;
+          if (matches.length < 1) {
+            return;
+          }
 
           // for each match, add to `instances` array
           matches.map(match => {
-            if (noWarnings && matcherConfig.warning) return;
+            if (noWarnings && matcherConfig.warning) {
+              return;
+            }
 
             // create if not exists
-            if (!allResults[matcherConfig.title]) allResults[matcherConfig.title] = {
-              instances: [],
-              ...matcherConfig
-            };
+            if (!allResults[matcherConfig.title]) {
+              allResults[matcherConfig.title] = {
+                instances: [],
+                ...matcherConfig
+              };
+            }
             const position = indexToPosition(content, match.index, {
               oneBased: true
             });
@@ -105,7 +112,9 @@ export default function Scan({
             // when scanning for multiple SDKs, you can get a double match, this logic ensures you don't
             if (allResults[matcherConfig.title].instances.filter(i => {
               return i.position.line === position.line && i.position.column === position.column && i.file === fileRelative;
-            }).length > 0) return;
+            }).length > 0) {
+              return;
+            }
             allResults[matcherConfig.title].instances.push({
               sdk,
               position,
@@ -162,7 +171,7 @@ export default function Scan({
     }).catch(err => {
       console.error(err);
     });
-  }, [matchers, files, noWarnings]);
+  }, [matchers, files, noWarnings, disableTelemetry]);
   return complete ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
     color: "green"
   }, "\u2713 ", status), /*#__PURE__*/React.createElement(Newline, null), !!results.length && /*#__PURE__*/React.createElement(ExpandableList, {

package/dist/util/expandable-list.js

@@ -50,7 +50,9 @@ export default function ExpandableList({
   return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, {
     color: "blue"
   }, "Navigation Instructions:"), /*#__PURE__*/React.createElement(Text, null, "Navigate through items with \u2191 and \u2193 arrow keys. Expand the details of any item with space bar. \u2193 key on the last item goes to the next page, \u2191 on the first item goes to the previous page. To exit this interface, use \"control + c\"."), /*#__PURE__*/React.createElement(Newline, null), state.all.reduce((memo, item, idx) => {
-    if (idx < state.visible[0] || idx >= state.visible[1]) return memo;
+    if (idx < state.visible[0] || idx >= state.visible[1]) {
+      return memo;
+    }
     const locations = item.instances.map(instance => `${instance.file}:${instance.position.line}:${instance.position.column}`);
     const singleBorderStyle = {
       topLeft: ' ',

package/dist/util/guess-framework.js

@@ -1,10 +1,12 @@
-import { randomUUID } from 'crypto';
+import { createHash, randomUUID } from 'crypto';
 import fs from 'fs';
-import md5 from 'md5';
 import path from 'path';
 import { readPackageSync } from 'read-pkg';
 import tempDir from 'temp-dir';
 import SDKS from '../constants/sdks.js';
+function md5(data) {
+  return createHash('md5').update(data).digest('hex');
+}
 
 // Telemetry Note
 // --------------
@@ -41,10 +43,12 @@ export default function guessFrameworks(dir, disableTelemetry) {
   const _uuid = md5(JSON.stringify(pkg));
 
   // no guessing if there are no deps
-  if (!pkg.dependencies && !pkg.devDependencies) return {
-    guesses: [],
-    _uuid
-  };
+  if (!pkg.dependencies && !pkg.devDependencies) {
+    return {
+      guesses: [],
+      _uuid
+    };
+  }
   const deps = pkg.dependencies ? Object.keys(pkg.dependencies) : [];
   const devDeps = pkg.devDependencies ? Object.keys(pkg.devDependencies) : [];
   return {
@@ -53,10 +57,12 @@ export default function guessFrameworks(dir, disableTelemetry) {
       label,
       value
     }) => {
-      if (deps.includes(label) || devDeps.includes(label)) m.push({
-        label,
-        value
-      });
+      if (deps.includes(label) || devDeps.includes(label)) {
+        m.push({
+          label,
+          value
+        });
+      }
       return m;
     }, [])
   };

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

@@ -1,5 +1,5 @@
 ---
-title: '`GASTBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
+title: '`GATSBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
 category: 'deprecation-removal'
 matcher: 'GATSBY_CLERK_FRONTEND_API'
 ---

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

@@ -21,7 +21,6 @@ export default {
   'signup-attemptweb3walletverification-generatedsignature', 'redirecttohome', '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', 'clerk-isready-removed', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'externalaccount-avatarurl', 'organizationmembershippublicuserdata-profileimageurl', 'clerk-import'])),
   shared: load('shared', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'getrequesturl', 'organizationcontext', 'useorganizationlist-organizationlist' // shared outside this pkg?
   ]),
-
   'chrome-extension': load('chrome-extension', dedupeMerge(changesAffectingAll, jsChanges, ['clerkprovider-tokencache'])),
   localizations: load('localization', ['new-localization-keys', 'removed-localization-keys', 'changed-localization-keys']),
   backend: load('backend', dedupeMerge(changesAffectingAll, ['api-url-value-changed', 'verifyjwt-import-path-move', 'decodejwt-import-path-move', 'signjwt-import-path-move', 'constants-import-path-move', 'redirect-import-path-move', 'createauthenticaterequest-import-path-move', 'createisomorphicrequest-import-path-move', 'createclerkclient-frontendapi', 'authenticaterequest-params-change', 'clerk-import', 'externalaccount-picture', 'externalaccountjson-avatarurl', 'organizationjson-logourl', 'userjson-profileimageurl', 'organizationmembershippublicuserdata-profileimageurl', 'organizationmembershippublicuserdatajson-profileimageurl', 'clockskewinseconds', 'pkgversion', 'client-unstableoptions-removed', 'httpoptions-removed', 'createisomorphicrequest-removed', 'createemail-removed', 'signjwterror-import-move', 'tokenverificationerror-import-move', 'tokenverificationerroraction-import-move', 'tokenverificationerrorreason-import-move', 'membershiprole', 'getorganizationmembershiplist-return-signature', 'buildrequesturl-removed', 'createclerkclient-apikey', 'getclientlist-arguments', 'getsessionlist-arguments', 'members-count'])),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerk/upgrade",
-  "version": "1.0.7",
+  "version": "1.0.8-canary.v1e57618",
   "license": "MIT",
   "type": "module",
   "main": "dist/cli.js",
@@ -11,9 +11,16 @@
     "dist"
   ],
   "scripts": {
-    "build": "npm run clean && NODE_ENV=production babel --out-dir=dist source --copy-files",
+    "build": "npm run clean && NODE_ENV=production babel --out-dir=dist src --copy-files",
     "clean": "del-cli dist/*",
-    "dev": "babel --out-dir=dist --watch source --copy-files"
+    "dev": "babel --out-dir=dist --watch src --copy-files",
+    "lint": "eslint src/",
+    "lint:publint": "publint"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clerk/javascript.git",
+    "directory": "packages/upgrade"
   },
   "babel": {
     "presets": [
@@ -23,8 +30,8 @@
   "dependencies": {
     "@inkjs/ui": "^1.0.0",
     "@jescalan/ink-markdown": "^2.0.0",
-    "ejs": "3.1.9",
-    "globby": "^14.0.0",
+    "ejs": "3.1.10",
+    "globby": "^14.0.1",
     "gray-matter": "^4.0.3",
     "index-to-position": "^0.1.2",
     "ink": "^4.4.1",
@@ -32,17 +39,16 @@
     "ink-gradient": "^3.0.0",
     "ink-link": "^3.0.0",
     "marked": "^11.1.1",
-    "md5": "^2.3.0",
     "meow": "^11.0.0",
-    "react": "^18.2.0",
+    "react": "^18.3.1",
     "read-pkg": "^9.0.1",
     "semver-regex": "^4.0.5",
     "temp-dir": "^3.0.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.0",
-    "@babel/preset-react": "^7.18.6",
-    "chalk": "^5.2.0",
+    "@babel/cli": "^7.24.7",
+    "@babel/preset-react": "^7.24.7",
+    "chalk": "^5.3.0",
     "del-cli": "^5.1.0",
     "eslint-config-custom": "*"
   },