@clerk/upgrade 0.0.1

package/README.md

@@ -0,0 +1,25 @@
+# @clerk/upgrade
+
+A tool that helps with upgrading major versions of Clerk's SDKs.
+
+## Usage
+
+```bash
+npx @clerk/upgrade
+```
+
+## 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.
+
+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.
+
+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:
+
+```js
+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.

package/dist/app.js

@@ -0,0 +1,136 @@
+import React, { useState } from 'react';
+import { Text, Newline } from 'ink';
+import { Select, MultiSelect, TextInput } from '@inkjs/ui';
+import SDKS from './constants/sdks.js';
+import VERSIONS from './constants/versions.js';
+import Scan from './scan.js';
+import guessFrameworks from './util/guess-framework.js';
+import getClerkMajorVersion from './util/get-clerk-version.js';
+import Gradient from 'ink-gradient';
+import BigText from 'ink-big-text';
+export default function App({
+  _fromVersion,
+  _toVersion,
+  _sdk,
+  _dir = false,
+  _ignore = []
+}) {
+  const [sdks, setSdks] = useState(_sdk ? [_sdk] : []);
+  const [sdkGuesses, setSdkGuesses] = useState([]);
+  const [sdkGuessConfirmed, setSdkGuessConfirmed] = useState(false);
+  const [sdkGuessAttempted, setSdkGuessAttempted] = useState(false);
+  const [fromVersion, setFromVersion] = useState(_fromVersion);
+  const [fromVersionGuessAttempted, fromVersionSdkGuessAttempted] = useState(false);
+  const [toVersion, setToVersion] = useState(_toVersion);
+  const [dir, setDir] = useState(_dir);
+  const [ignore, setIgnore] = useState(_ignore);
+  const [configComplete, setConfigComplete] = useState(false);
+  const [configVerified, setConfigVerified] = useState(false);
+  let fromVersionGuess = false;
+
+  // We try to guess which SDK they are using
+  if (isEmpty(sdks) && isEmpty(sdkGuesses) && !sdkGuessAttempted) {
+    if (!dir) return setDir(process.cwd());
+    setSdkGuesses(guessFrameworks(dir)); // this is the suspect line
+    setSdkGuessAttempted(true);
+  }
+
+  // We try to guess which version of Clerk they are using
+  if (!fromVersion && !fromVersionGuess && !fromVersionGuessAttempted) {
+    fromVersionGuess = getClerkMajorVersion();
+    setFromVersionGuessAttempted(true);
+  }
+
+  // No support for v3 or below, sadly
+  if (parseInt(fromVersion) < 4) {
+    return /*#__PURE__*/React.createElement(Text, {
+      color: "red"
+    }, "We're so sorry, but this tool only supports migration from version 4 and above.");
+  }
+
+  // If they are trying to/from the same version, that's an error
+  if (parseInt(fromVersion) === parseInt(toVersion)) {
+    return /*#__PURE__*/React.createElement(Text, {
+      color: "red"
+    }, "You are already on version ", toVersion, ", so there's no need to migrate!");
+  }
+  return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Gradient, {
+    name: "vice"
+  }, /*#__PURE__*/React.createElement(BigText, {
+    text: "Clerk Upgrade",
+    font: "tiny"
+  })), !configComplete && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, /*#__PURE__*/React.createElement(Text, {
+    color: "blue"
+  }, "Hello friend!"), " We're excited to help you upgrade Clerk", fromVersion ? ` from v${fromVersion}` : '', toVersion ? ` to v${toVersion}` : '', ". Before we get started, a couple questions..."), /*#__PURE__*/React.createElement(Newline, null)), isEmpty(sdks) && !isEmpty(sdkGuesses) && !sdkGuessConfirmed && /*#__PURE__*/React.createElement(React.Fragment, null, sdkGuesses.length > 1 ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "It looks like you are using the following Clerk SDKs in your project:"), sdkGuesses.map(guess => /*#__PURE__*/React.createElement(Text, {
+    key: guess.value
+  }, '  ', "- ", guess.label)), /*#__PURE__*/React.createElement(Text, null, "Is that right?")) : /*#__PURE__*/React.createElement(Text, null, "It looks like you are using the \"", sdkGuesses[0].label, "\" Clerk SDK in your project. Is that right?"), /*#__PURE__*/React.createElement(Select, {
+    options: [{
+      label: 'yes',
+      value: 'yes'
+    }, {
+      label: 'no',
+      value: 'no'
+    }],
+    onChange: item => {
+      setSdkGuessConfirmed(true);
+      // if true, we were right so we set the sdk
+      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"
+  }, "(select with space bar, multiple can be selected, press enter when finished)"), /*#__PURE__*/React.createElement(MultiSelect, {
+    options: SDKS,
+    onSubmit: value => setSdks(value),
+    visibleOptionCount: SDKS.length
+  })), !isEmpty(sdks) > 0 && fromVersion && toVersion && !dir && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "Where would you like for us to scan for files in your project?"), /*#__PURE__*/React.createElement(Text, {
+    color: "gray"
+  }, "(globstar syntax supported)"), /*#__PURE__*/React.createElement(TextInput, {
+    defaultValue: "**/*",
+    onSubmit: val => setDir(val)
+  })), !isEmpty(sdks) && fromVersion && toVersion && dir && isEmpty(ignore) && !configComplete && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "Are there any files or directories you'd like to ignore? If so, you can add them below, separated by commas. We ignore \"node_modules\" and \".git\" by default."), /*#__PURE__*/React.createElement(Text, {
+    color: "gray"
+  }, "(globstar syntax supported)"), /*#__PURE__*/React.createElement(TextInput, {
+    placeholder: "docs/**, images/**",
+    defaultValue: ignore,
+    onSubmit: val => {
+      setIgnore(val.includes(',') ? val.split(/\s*,\s*/) : [].concat(val));
+      setConfigComplete(true);
+    }
+  })), configComplete && !configVerified && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Text, null, "Ok, here's our configuration:"), /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Text, null, "Clerk ", sdks.length > 1 ? 'SDKs' : 'SDK', " used:", /*#__PURE__*/React.createElement(Text, {
+    color: "green"
+  }, " ", sdks.toString())), /*#__PURE__*/React.createElement(Text, null, "Migrating from", /*#__PURE__*/React.createElement(Text, {
+    color: "green"
+  }, " v", fromVersion, " "), "to", /*#__PURE__*/React.createElement(Text, {
+    color: "green"
+  }, " v", toVersion)), /*#__PURE__*/React.createElement(Text, null, "Looking in the directory", /*#__PURE__*/React.createElement(Text, {
+    color: "green"
+  }, " ", dir, " "), ignore.length > 0 && /*#__PURE__*/React.createElement(React.Fragment, null, "and ignoring", /*#__PURE__*/React.createElement(Text, {
+    color: "green"
+  }, " ", ignore.join(', ')))), /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Text, null, "Does this look right?"), /*#__PURE__*/React.createElement(Select, {
+    options: [{
+      label: 'yes',
+      value: true
+    }, {
+      label: 'no - exit, and i will try again',
+      value: false
+    }],
+    onChange: value => {
+      if (!value) {
+        process.exit();
+      } else {
+        setConfigVerified(true);
+      }
+    }
+  })), configVerified && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Scan, {
+    fromVersion,
+    toVersion,
+    sdks,
+    dir,
+    ignore
+  })));
+}
+
+// small util to make the logic blocks easier to visually parse
+function isEmpty(arr) {
+  return !arr.length;
+}

package/dist/cli.js

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+import React from 'react';
+import { render } from 'ink';
+import meow from 'meow';
+import App from './app.js';
+import sdks from './constants/sdks.js';
+const cli = meow(`
+		Usage
+		  $ clerk-upgrade
+
+		Options
+			--from   Major version number you're upgrading from
+			--to     Major version number you're upgrading to
+			--sdk    Name of the SDK you're upgrading
+			--dir    Directory you'd like to scan for files
+			--ignore Any files or directories you'd like to ignore
+
+		Examples
+		  $ clerk-upgrade --from=4 --to=5 --sdk=nextjs --dir=src/**
+		  Hello, Jane
+	`, {
+  importMeta: import.meta,
+  flags: {
+    from: {
+      type: 'string',
+      default: '4'
+    },
+    to: {
+      type: 'string',
+      default: '5'
+    },
+    sdk: {
+      type: 'string',
+      choices: sdks.map(i => i.value)
+    },
+    dir: {
+      type: 'string'
+    },
+    ignore: {
+      type: 'string',
+      isMultiple: true
+    }
+  }
+});
+render( /*#__PURE__*/React.createElement(App, {
+  _fromVersion: cli.flags.from,
+  _toVersion: cli.flags.to,
+  _sdk: cli.flags.sdk,
+  _dir: cli.flags.dir
+}));

package/dist/constants/sdks.js

@@ -0,0 +1,46 @@
+export default [{
+  label: '@clerk/nextjs',
+  value: 'nextjs'
+}, {
+  label: '@clerk/remix',
+  value: 'remix'
+}, {
+  label: 'gatsby-plugin-clerk',
+  value: 'gatsby'
+}, {
+  label: '@clerk/redwood',
+  value: 'redwood'
+}, {
+  label: '@clerk/react',
+  value: 'react'
+}, {
+  label: '@clerk/expo',
+  value: 'expo'
+}, {
+  label: '@clerk/fastify',
+  value: 'fastify'
+}, {
+  label: '@clerk/express',
+  value: 'express'
+}, {
+  label: '@clerk/clerk-js',
+  value: 'js'
+}, {
+  label: '@clerk/clerk-sdk-node',
+  value: 'node'
+}, {
+  label: '@clerk/backend',
+  value: 'backend'
+}, {
+  label: '@clerk/localizations',
+  value: 'localizations'
+}, {
+  label: '@clerk/shared',
+  value: 'shared'
+}, {
+  label: '@clerk/types',
+  value: 'types'
+}, {
+  label: '@clerk/chrome-extension',
+  value: 'chromeExtension'
+}];

package/dist/constants/versions.js

@@ -0,0 +1,7 @@
+export default [{
+  label: 'v5',
+  value: 5
+}, {
+  label: 'v4',
+  value: 4
+}];

package/dist/scan.js

@@ -0,0 +1,103 @@
+import React, { useState, useEffect } from 'react';
+import { Text, Newline, Box } from 'ink';
+import { globby } from 'globby';
+import fs from 'fs/promises';
+import { ProgressBar } from '@inkjs/ui';
+import indexToPosition from 'index-to-position';
+import ExpandableList from './util/expandable-list.js';
+export default function Scan({
+  fromVersion,
+  toVersion,
+  sdks,
+  dir,
+  ignore
+}) {
+  // NOTE: if the difference between fromVersion and toVersion is greater than 1
+  // we need to do a little extra work here and import two matchers,
+  // sequence them after each other, and clearly mark which version migration
+  // applies to each log.
+  //
+  // This is not yet implemented though since the current state of the script
+  // only handles a single version.
+  const [status, setStatus] = useState('Initializing');
+  const [progress, setProgress] = useState(0);
+  const [complete, setComplete] = useState(false);
+  const [matchers, setMatchers] = useState();
+  const [files, setFiles] = useState();
+  const [results, setResults] = useState([]);
+
+  // Load matchers
+  // -------------
+  // result = `matchers` set to format:
+  // { sdkName: [{ title: 'x', matcher: /x/, slug: 'x', ... }] }
+  useEffect(() => {
+    setStatus(`Loading data for v${toVersion} migration`);
+    import(`./versions/v${toVersion}/index.js`).then(version => {
+      setMatchers(sdks.reduce((m, sdk) => {
+        m[sdk] = version.default[sdk];
+        return m;
+      }, {}));
+    });
+  }, [toVersion]);
+
+  // Get all files from the glob matcher
+  // -----------------------------------
+  // result = `files` set to format: ['/filename', '/other/filename']
+  useEffect(() => {
+    setStatus('Collecting files to scan');
+    ignore.push('node_modules/**', '**/node_modules/**', '.git/**', 'package.json', 'package-lock.json', 'yarn.lock', 'pnpm-lock.yaml');
+    globby(dir, {
+      ignore: [...ignore.filter(x => x)]
+    }).then(files => setFiles(files));
+  }, [dir, ignore]);
+
+  // Read files and scan regexes
+  // ---------------------------
+  // result = `results` set to format
+  //
+  useEffect(() => {
+    if (!matchers || !files) return;
+    Promise.all(
+    // first we read all the files
+    files.map(async (file, idx) => {
+      setStatus(`Scanning ${file}`);
+      setProgress(Math.ceil(idx / files.length * 100));
+      const content = await fs.readFile(file, 'utf8');
+
+      // then we run each of the matchers against the file contents
+      // TODO: combine results on the same match, add multiple file/positions
+      for (const sdk in matchers) {
+        matchers[sdk].map(matcher => {
+          const matches = content.matchAll(matcher.matcher);
+          if (!matches) return;
+          Array.from(matches).map(match => {
+            // TODO: index should be converted to line/col
+            results.push({
+              sdk,
+              file,
+              position: indexToPosition(content, match.index),
+              ...matcher
+            });
+            setResults(results);
+          });
+        });
+      }
+    })).then(() => {
+      setComplete(true);
+      if (results.length < 1) {
+        setStatus('It looks like you have nothing you need to change, upgrade away!');
+      } else {
+        setStatus('File scan complete. See results below!');
+      }
+    }).catch(err => {
+      console.error(err);
+    });
+  }, [matchers, files]);
+  return /*#__PURE__*/React.createElement(React.Fragment, null, complete ? /*#__PURE__*/React.createElement(Text, {
+    color: "green"
+  }, "\u2713 ", status) : /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(ProgressBar, {
+    value: progress
+  }), /*#__PURE__*/React.createElement(Text, null, status)), /*#__PURE__*/React.createElement(Newline, null), !!results.length && /*#__PURE__*/React.createElement(ExpandableList, {
+    items: results
+  }));
+}

package/dist/test.js

@@ -0,0 +1,100 @@
+import React, { useReducer, useMemo } from 'react';
+import { Text, Newline, useInput, Box, render } from 'ink';
+function ExpandableList({
+  items
+}) {
+  // add focused/expanded state on the set of items
+  const initialItems = useMemo(() => {
+    return items.map((i, idx) => {
+      i.focused = idx === 0 ? true : false;
+      i.expanded = false;
+      return i;
+    });
+  }, [items]);
+
+  // set up the focus/expanded state machine
+  const [state, dispatch] = useReducer(reducer, initialItems);
+
+  // this is what lets us respond to keyboard input
+  useInput((input, key) => {
+    if (key.downArrow) {
+      dispatch({
+        type: 'focus-next-option'
+      });
+    }
+    if (key.upArrow) {
+      dispatch({
+        type: 'focus-previous-option'
+      });
+    }
+    if (input === ' ') {
+      dispatch({
+        type: 'toggle-focused-option'
+      });
+    }
+  });
+
+  // and here's the actual markup we render for each list item!
+  return state.map(item => {
+    return /*#__PURE__*/React.createElement(Box, {
+      borderStyle: "round",
+      flexDirection: "column",
+      borderColor: item.focused ? 'blue' : 'white',
+      key: item.title
+    }, /*#__PURE__*/React.createElement(Text, {
+      bold: true
+    }, item.title), /*#__PURE__*/React.createElement(Text, null, "Location: ", result.file, ":", result.position.line, ":", result.position.column), item.expanded && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Text, {
+      color: "gray"
+    }, "changed in ", item.sdk, " SDK"), /*#__PURE__*/React.createElement(Link, {
+      url: item.link
+    }, /*#__PURE__*/React.createElement(Text, null, "Migration guide entry \xBB")), /*#__PURE__*/React.createElement(Text, null, item.content)));
+  });
+}
+
+// I'd like to recognize that this logic is kinda crazy, but it works 💖
+function reducer(state, action) {
+  // if the current item is focused and a next item exists
+  // un-focus it and tee up the next one to be focused
+  if (action.type === 'focus-next-option') {
+    let nextIdx;
+    return state.map((item, idx) => {
+      if (item.focused && state[idx + 1]) {
+        nextIdx = idx + 1;
+        item.focused = false;
+        return item;
+      }
+      if (idx === nextIdx) {
+        item.focused = true;
+        return item;
+      }
+      return item;
+    });
+  }
+
+  // if the next item is focused, focus this one and tee up the next one to be un-focused
+  if (action.type === 'focus-previous-option') {
+    let nextIdx;
+    return state.map((item, idx) => {
+      if (state[idx + 1]?.focused) {
+        item.focused = true;
+        nextIdx = idx + 1;
+        return item;
+      }
+      if (idx === nextIdx) {
+        item.focused = false;
+        return item;
+      }
+      return item;
+    });
+  }
+
+  // if the space bar is hit, toggle expand/contract on the currently focused item
+  if (action.type === 'toggle-focused-option') {
+    return state.map(item => {
+      if (item.focused) {
+        item.expanded = !item.expanded;
+      }
+      return item;
+    });
+  }
+}

package/dist/util/expandable-list.js

@@ -0,0 +1,143 @@
+import React, { useReducer, useMemo } from 'react';
+import { Text, Newline, useInput, Box } from 'ink';
+import Link from 'ink-link';
+import Markdown from 'ink-markdown';
+
+// A listing of items which can be navigated with arrow keys and expanded/contracted
+// with space bar. Limits the number visible at a time to prevent rendering issues with
+// super long lists
+export default function ExpandableList({
+  items,
+  numberVisible = 10
+}) {
+  // set up our little state machine
+  const [state, dispatch] = useReducer(reducer, items, items => {
+    // add focused/expanded state on the set of items
+    const all = items.map((i, idx) => {
+      i.focused = idx === 0 ? true : false;
+      i.expanded = false;
+      return i;
+    });
+
+    // start idx, end idx
+    const visible = [0, numberVisible];
+    return {
+      numberVisible,
+      all,
+      visible
+    };
+  });
+
+  // this is what lets us respond to keyboard input
+  useInput((input, key) => {
+    if (key.downArrow) {
+      dispatch({
+        type: 'focus-next-option'
+      });
+    }
+    if (key.upArrow) {
+      dispatch({
+        type: 'focus-previous-option'
+      });
+    }
+    if (input === ' ') {
+      dispatch({
+        type: 'toggle-focused-option'
+      });
+    }
+  });
+
+  // and here's the actual markup we render for each list item!
+  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;
+    const loc = `${item.file}:${item.position.line}:${item.position.column}`;
+    memo.push( /*#__PURE__*/React.createElement(Box, {
+      borderStyle: item.focused ? 'double' : 'single',
+      flexDirection: "column",
+      borderColor: item.focused ? 'blue' : 'white',
+      paddingX: 1,
+      key: loc
+    }, /*#__PURE__*/React.createElement(Markdown, null, item.title), /*#__PURE__*/React.createElement(Text, null, "Location: ", loc), item.expanded && /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Newline, null), /*#__PURE__*/React.createElement(Markdown, null, item.content), /*#__PURE__*/React.createElement(Link, {
+      url: item.link
+    }, /*#__PURE__*/React.createElement(Text, null, "See in migration guide \xBB")))));
+    return memo;
+  }, []), state.all.length > state.numberVisible && /*#__PURE__*/React.createElement(Text, null, "Showing ", state.visible[0] + 1, " - ", Math.min(state.visible[1], state.all.length), " of ", state.all.length));
+}
+
+// I'd like to recognize that this logic is kinda crazy, but it works 💖
+function reducer(state, action) {
+  if (action.type === 'focus-next-option') {
+    let nextIdx;
+
+    // if the current item is focused and a next item exists
+    // un-focus it and tee up the next one to be focused
+    const all = state.all.map((item, idx) => {
+      if (item.focused && state.all[idx + 1]) {
+        nextIdx = idx + 1;
+        item.focused = false;
+        return item;
+      }
+      if (idx === nextIdx) {
+        item.focused = true;
+        return item;
+      }
+      return item;
+    });
+
+    // if we're scrolling past the last item in the list, shift the visible window
+    let visible = state.visible;
+    if (nextIdx >= state.visible[1]) {
+      visible = [state.visible[0] + state.numberVisible, state.visible[1] + state.numberVisible];
+    }
+    return {
+      all,
+      visible,
+      numberVisible: state.numberVisible
+    };
+  }
+  if (action.type === 'focus-previous-option') {
+    let nextIdx;
+
+    // if the next item is focused, focus this one and tee up the next one to be un-focused
+    const all = state.all.map((item, idx) => {
+      if (state.all[idx + 1]?.focused) {
+        item.focused = true;
+        nextIdx = idx + 1;
+        return item;
+      }
+      if (idx === nextIdx) {
+        item.focused = false;
+        return item;
+      }
+      return item;
+    });
+
+    // if we're scrolling to before the first item in the list, shift the visible window
+    let visible = state.visible;
+    if (nextIdx - 1 < state.visible[0]) {
+      visible = [state.visible[0] - state.numberVisible, state.visible[1] - state.numberVisible];
+    }
+    return {
+      all,
+      visible,
+      numberVisible: state.numberVisible
+    };
+  }
+
+  // if the space bar is hit, toggle expand/contract on the currently focused item
+  if (action.type === 'toggle-focused-option') {
+    const all = state.all.map(item => {
+      if (item.focused) {
+        item.expanded = !item.expanded;
+      }
+      return item;
+    });
+    return {
+      all,
+      visible: state.visible,
+      numberVisible: state.numberVisible
+    };
+  }
+}

package/dist/util/generate-changelog.js

@@ -0,0 +1,28 @@
+import SDKS from '../constants/sdks.js';
+import { parseInline } from 'marked';
+const VERSION = 'v5';
+async function generate() {
+  let output = '';
+  output += `# Clerk SDKs ${VERSION} Changelog\n\n`;
+  output += `Below is a listing of all the changes made to Clerk SDKs in ${VERSION} - each section describes the changes to one SDK. Note that some changes may be repeated between different SDKs.\n\n`;
+  const data = (await import(`../versions/${VERSION}/index.js`)).default;
+  for (let sdk in data) {
+    output += `### ${getSdkName(sdk)}\n\n---\n\n`;
+    data[sdk].map(entry => {
+      // Note: make sure to add a custom anchor link here to match the cli output
+      // anchor should be `entry.slug`
+      output += `<details>
+<summary>${parseInline(entry.title)}</summary>
+                
+Regex matcher: \`${entry.matcher}\`
+
+${entry.content}
+</details>\n\n`;
+    });
+  }
+  return output;
+}
+generate().then(console.log);
+function getSdkName(val) {
+  return SDKS.find(sdk => val === sdk.value).label;
+}

package/dist/util/get-clerk-version.js

@@ -0,0 +1,7 @@
+import { readPackageSync } from 'read-pkg';
+import semverRegex from 'semver-regex';
+export default function getClerkMajorVersion() {
+  const pkg = readPackageSync();
+  const clerk = pkg.dependencies.clerk;
+  return clerk ? semverRegex.exec(clerk)[0][0] : false;
+}

package/dist/util/guess-framework.js

@@ -0,0 +1,22 @@
+import { readPackageSync } from 'read-pkg';
+import SDKS from '../constants/sdks.js';
+export default function guessFrameworks(dir) {
+  const pkg = readPackageSync({
+    cwd: dir
+  });
+
+  // no guessing if there are no deps
+  if (!pkg.dependencies && !pkg.devDependencies) return [];
+  const deps = pkg.dependencies ? Object.keys(pkg.dependencies) : [];
+  const devDeps = pkg.devDependencies ? Object.keys(pkg.devDependencies) : [];
+  return SDKS.reduce((m, {
+    label,
+    value
+  }) => {
+    if (deps.includes(label) || devDeps.includes(label)) m.push({
+      label,
+      value
+    });
+    return m;
+  }, []);
+}