@clerk/upgrade 0.0.1

package/dist/util/load-change.js

@@ -0,0 +1,31 @@
+import fs from 'fs';
+import path from 'path';
+import matter from 'gray-matter';
+import { fileURLToPath } from 'url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+export default function createLoader({
+  version,
+  baseUrl
+}) {
+  return function load(sdk, slugs) {
+    // 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 loadPath = fs.existsSync(sdkPath) ? sdkPath : sharedPath;
+      const content = fs.readFileSync(loadPath, 'utf8');
+      const parsed = matter(content);
+      const fm = parsed.data;
+      return {
+        title: fm.title,
+        matcher: new RegExp(fm.matcher, `g${fm.matcherFlags ? fm.matcherFlags : ''}`),
+        replaceWithString: fm.replaceWithString,
+        slug,
+        sdk: sdk,
+        content: parsed.content,
+        link: `${baseUrl}#${slug}`
+      };
+    });
+  };
+}

package/dist/util/step-sequencer.js

@@ -0,0 +1,31 @@
+import { useState } from 'react';
+
+// This was an attempt to write a function that would clean up the step-by-step
+// nature of the CLI but I couldn't get it working the way I wanted quick enough
+// so shelving it for now.
+export function createStepSequence() {
+  const [step, setStep] = useState(0);
+  const StepSequence = ({
+    children
+  }) => {
+    const stepToRender = [].concat(children).filter((_, idx) => {
+      return idx === step;
+    });
+    if (!stepToRender.length) return [];
+    if (stepToRender[0].props.condition === false) {
+      setStep(step + 1);
+    } else {
+      return stepToRender;
+    }
+  };
+  const Step = ({
+    condition,
+    children
+  }) => {
+    return children;
+  };
+  const nextStep = () => {
+    setStep(step + 1);
+  };
+  return [StepSequence, Step, nextStep];
+}

package/dist/util/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/versions/v5/backend/clerk-import.md

@@ -0,0 +1,15 @@
+---
+title: '`Clerk` -> `createClerkClient`'
+matcher: "import\\s+{[\\s\\S]*?Clerk[\\s\\S]*?}\\s+from\\s+['\"]@clerk/backend['\"]"
+matcherFlags: 'm'
+---
+
+The top level `Clerk` import was renamed to `createClerkClient`. This is just a name change and can be treated as a text replacement, no changes to the params or return types.
+
+```js
+// before
+import { Clerk } from '@clerk/backend';
+
+// after
+import { createClerkClient } from '@clerk/backend';
+```

package/dist/versions/v5/backend/clockskewinseconds.md

@@ -0,0 +1,7 @@
+---
+title: '`clockSkewInSeconds` -> `clockSkewInMs`'
+matcher: 'clockSkewInSeconds'
+replaceWithString: 'clockSkewInMs'
+---
+
+The value stayed the same, only the name changed.

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

@@ -0,0 +1,21 @@
+---
+title: '`apiKey` -> `secretKey` as param to createClerkClient'
+matcher: "[createClerkClient|Clerk]\\(\\s*{[\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+matcherFlags: 'm'
+---
+
+The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`. Also note that the import value has changed for creating a new Clerk client, which will be addressed by a separate line item if relevant to your codebase.
+
+```js
+// before
+import { Clerk } from '@clerk/backend';
+
+const clerkClient = Clerk({ apiKey: '...' });
+clerkClient.authenticateRequest({ apiKey: '...' });
+
+// after
+import { createClerkClient } from '@clerk/backend';
+
+const clerkClient = createClerkClient({ secretKey: '...' });
+clerkClient.authenticateRequest({ secretKey: '...' });
+```

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

@@ -0,0 +1,21 @@
+---
+title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
+matcher: "[createClerkClient|Clerk]\\(\\s*{[\\s\\S]*?frontendApi:[\\s\\S]*?\\)"
+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. Also note that the import value has changed for creating a new Clerk client, which will be addressed by a separate line item if relevant to your codebase.
+
+```js
+// before
+import { Clerk } from '@clerk/backend';
+
+const clerkClient = Clerk({ frontendApi: '...' });
+clerkClient.authenticateRequest({ frontendApi: '...' });
+
+// after
+import { createClerkClient } from '@clerk/backend';
+
+const clerkClient = createClerkClient({ publishableKey: '...' });
+clerkClient.authenticateRequest({ publishableKey: '...' });
+```

package/dist/versions/v5/backend/getpendingorganizationinvitationlist.md

@@ -0,0 +1,12 @@
+---
+title: '`getPendingOrganizationInvitationList` -> `getOrganizationInvitationList`'
+matcher: 'getPendingOrganizationInvitationList'
+replaceWithString: 'getOrganizationInvitationList'
+---
+
+Use `getOrganizationInvitationList` with a `status` option instead.
+
+```diff
+- getPendingOrganizationInvitationList({ organizationId: "" })
++ getOrganizationInvitationList({ organizationId: "", status: "pending" })
+```

package/dist/versions/v5/chromeExtension/clerkprovider-tokencache.md

@@ -0,0 +1,26 @@
+---
+title: '`tokenCache` -> `storageCache` as `<ClerkProvider>` props'
+matcher: "<ClerkProvider[\\s\\S]*?tokenCache=[\\s\\S]*?>"
+matcherFlags: 'm'
+---
+
+The `tokenCache` prop has been renamed to `storageCache` in order to accomodate the new [WebSSO feature](https://github.com/clerk/javascript/pull/2277). With the prop change from `tokenCache` to `storageCache`, the interface has been expanded to allow for more flexibility. The new interface is as follows:
+
+```ts
+type StorageCache = {
+	createKey: (...keys: string[]) => string;
+	get: <T = any>(key: string) => Promise<T>;
+	remove: (key: string) => Promise<void>;
+	set: (key: string, value: string) => Promise<void>;
+};
+```
+
+And here's a full before/after example:
+
+```jsx
+// before
+<ClerkProvider tokenCache={/* ... */}>
+
+// after
+<ClerkProvider storageCache={/* ... */}>
+```

package/dist/versions/v5/common/api-key-to-secret-key.md

@@ -0,0 +1,6 @@
+---
+title: '`CLERK_API_KEY` replaced by `CLERK_SECRET_KEY`'
+matcher: '[^_]CLERK_API_KEY'
+---
+
+The `CLERK_API_KEY` environment variable was renamed to `CLERK_SECRET_KEY`. You can visit your [Clerk dashboard](https://dashboard.clerk.com/last-active?path=api-keys) to copy/paste the new keys after choosing your framework. Make sure to update this in all environments (e.g. dev, staging, production).

package/dist/versions/v5/common/clerkprovider-frontendapi.md

@@ -0,0 +1,7 @@
+---
+title: '`frontendApi` -> `publishableKey` as prop to `ClerkProvider`'
+matcher: "<ClerkProvider[\\s\\S]*?frontendApi=[\\s\\S]*?>"
+matcherFlags: 'm'
+---
+
+The `frontendApi` prop passed to `<ClerkProvider>` was renamed to `publishableKey`. **Note:** The values are different, so this is not just a key replacement. You can visit your [Clerk dashboard](https://dashboard.clerk.com/last-active?path=api-keys) to copy/paste the new keys after choosing your framework. Make sure to update this in all environments (e.g. dev, staging, production). [More information](/docs/deployments/overview#api-keys-and-environment-variables).

package/dist/versions/v5/common/frontend-api-to-publishable-key.md

@@ -0,0 +1,6 @@
+---
+title: '`CLERK_FRONTEND_API` replaced by `CLERK_PUBLISHABLE_KEY`'
+matcher: '[^_]CLERK_FRONTEND_API'
+---
+
+The `CLERK_FRONTEND_API` environment variable was renamed to `CLERK_PUBLISHABLE_KEY`. You can visit your [Clerk dashboard](https://dashboard.clerk.com/last-active?path=api-keys) to copy/paste the new keys after choosing your framework. Make sure to update this in all environments (e.g. dev, staging, production). **Note:** The values are different, so this is not just a key replacement. [More information](/docs/deployments/overview#api-keys-and-environment-variables).

package/dist/versions/v5/common/handlemagiclinkverification.md

@@ -0,0 +1,7 @@
+---
+title: '`handleMagicLinkVerification` -> `handleEmailLinkVerification`'
+matcher: 'handleMagicLinkVerification'
+replaceWithString: 'handleMagicLinkVerification'
+---
+
+Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects the functionality.

package/dist/versions/v5/common/ismagiclinkerror.md

@@ -0,0 +1,7 @@
+---
+title: '`isMagicLinkError` -> `isEmailLinkError`'
+matcher: 'isMagicLinkError'
+replaceWithString: 'isEmailLinkError'
+---
+
+Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects the functionality.

package/dist/versions/v5/common/magiclinkerror.md

@@ -0,0 +1,7 @@
+---
+title: '`MagicLinkError` -> `EmailLinkError`'
+matcher: 'MagicLinkError'
+replaceWithString: 'EmailLinkError'
+---
+
+Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects the functionality.

package/dist/versions/v5/common/magiclinkerrorcode.md

@@ -0,0 +1,7 @@
+---
+title: '`MagicLinkErrorCode` -> `EmailLinkErrorCode`'
+matcher: 'MagicLinkErrorCode'
+replaceWithString: 'EmailLinkErrorCode'
+---
+
+Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects the functionality.

package/dist/versions/v5/common/navigate-to-routerpush-routerreplace.md

@@ -0,0 +1,16 @@
+---
+title: '`navigate` prop replaced by `routerPush` and `routerReplace`'
+matcher: "<ClerkProvider[\\s\\S]*?navigate=[\\s\\S]*?>"
+matcherFlags: 'm'
+---
+
+The `navigate` prop on `<ClerkProvider>` allowed developers to override the default navigation behavior with a custom function. However, `navigate` was only able to push, not replace routes. The router is now able to do both, and as such, the props for `<ClerkProvider>` were updated. The `routerPush` and `routerReplace` props replace the old `navigate` prop.
+
+For more information on what push and replace mean in relation to the browser history api, check out the ["Working with the History API"](https://developer.mozilla.org/en-US/docs/Web/API/History_API/Working_with_the_History_API) docs.
+
+If you’d like to keep the same behavior as you had with the single `navigate` prop, pass the exact same function to both `routerPush` and `routerReplace`. For example:
+
+```diff
+- <ClerkProvider navigate={x => x} />
++ <ClerkProvider routerPush={x => x} routerReplace={x => x} />
+```

package/dist/versions/v5/common/setsession.md

@@ -0,0 +1,32 @@
+---
+title: '`setSession` -> `setActive`'
+matcher: 'setSession'
+---
+
+`setSession` should be replaced with `setActive`. The format of the parameters has changed slightly - `setActive` takes an object where `setSession` took params directly. The `setActive` function also can accept an `organization` param that is used to set the currently active organization. The return signature did not change. Read the [API documentation](/docs/references/javascript/clerk/session-methods#set-active) for more detail. This function should be expected to be returned from one of the following Clerk hooks: `useSessionList`, `useSignUp`, or `useSignIn`. Some migration examples:
+
+```diff
+- await setSession('sessionID', () => void)
++ await setActive({ session: 'sessionID',  beforeEmit: () => void })
+
+- await setSession(sessionObj)
++ await setActive({ session: sessionObj })
+
+- await setSession(sessionObj, () => void)
++ await setActive({ session: sessionObj,  beforeEmit: () => void })
+```
+
+`setActive` also supports setting an active organization:
+
+```js
+await setActive({
+  session: 'sessionID',
+  organization: 'orgID',
+  beforeEmit: () => void
+})
+await setActive({
+  session: sessionObj,
+  organization: orgObj,
+  beforeEmit: () => void
+})
+```

package/dist/versions/v5/common/usemagiclink.md

@@ -0,0 +1,7 @@
+---
+title: '`useMagicLink` -> `useEmailLink`'
+matcher: 'useMagicLink'
+replaceWithString: 'useEmailLink'
+---
+
+Across Clerk's documentation and codebases the term "magic link" was changed to "email link" as it more accurately reflects the functionality.

package/dist/versions/v5/expo/apikey-to-publishable-key.md

@@ -0,0 +1,6 @@
+---
+title: '`CLERK_FRONTEND_API` replaced by `CLERK_PUBLISHABLE_KEY`'
+matcher: '[^_]CLERK_FRONTEND_API'
+---
+
+If you are using a `CLERK_FRONTEND_API` environment variable, the name must be changed to `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/v5/expo/clerkprovider-frontendapi.md

@@ -0,0 +1,17 @@
+---
+title: '`frontendApi` -> `publishableKey` as prop to `ClerkProvider`'
+matcher: "<ClerkProvider[\\s\\S]*?frontendApi=[\\s\\S]*?>"
+matcherFlags: 'm'
+---
+
+The `frontendApi` prop passed to `ClerkProvider` must be changed to `publishableKey`. The value also must be updated to be a publishable key rather than a frontend API key, [here’s more information on how to do this](TODO)
+
+```js
+import { ClerkProvider } from '@clerk/clerk-expo';
+
+// before
+<ClerkProvider frontendApi='...' />
+
+// after
+<ClerkProvider publishableKey='...' />
+```

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

@@ -0,0 +1,6 @@
+---
+title: '`API_URL` value has changed'
+matcher: "API_URL.*?from\\s['\"]@clerk\\/fastify\\/constants['\"]"
+---
+
+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/fastify/clerkplugin-frontendapi.md

@@ -0,0 +1,17 @@
+---
+title: '`frontendApi` -> `publishableKey` as param to clerkPlugin'
+matcher: "fastify\\.register\\(clerkPlugin,.*?{.*?frontendApi:.*?}\\)"
+matcherFlags: 'm'
+---
+
+The `frontendApi` argument passed to `clerkPlugin` 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.
+
+```js
+import { clerkPlugin } from '@clerk/fastify';
+
+// before
+fastify.register(clerkPlugin, { frontendApi: '...' });
+
+// after
+fastify.register(clerkPlugin, { publishableKey: '...' });
+```

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

@@ -0,0 +1,17 @@
+---
+title: '`apiKey` -> `secretKey` as param to createClerkClient'
+matcher: "createClerkClient\\({.*?apiKey:.*?}\\)"
+matcherFlags: 'm'
+---
+
+The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`.
+
+```js
+import { createClerkClient } from '@clerk/fastify';
+
+// before
+createClerkClient({ apiKey: '...' });
+
+// after
+createClerkClient({ secretKey: '...' });
+```

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

@@ -0,0 +1,17 @@
+---
+title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
+matcher: "createClerkClient\\({.*?frontendApi:.*?}\\)"
+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.
+
+```js
+import { createClerkClient } from '@clerk/fastify';
+
+// before
+createClerkClient({ frontendApi: '...' });
+
+// after
+createClerkClient({ publishableKey: '...' });
+```

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

@@ -0,0 +1,6 @@
+---
+title: '`API_URL` value has changed'
+matcher: "API_URL.*?from\\s['\"]gatsby-plugin-clerk\\/constants['\"]"
+---
+
+- 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/gatsby/apikey-to-publishable-key.md

@@ -0,0 +1,6 @@
+---
+title: '`GASTBY_CLERK_FRONTEND_API` replaced by `GATSBY_CLERK_PUBLISHABLE_KEY`'
+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/v5/gatsby/createclerkclient-apikey.md

@@ -0,0 +1,17 @@
+---
+title: '`apiKey` -> `secretKey` as param to createClerkClient'
+matcher: "createClerkClient\\({.*?apiKey:.*?}\\)"
+matcherFlags: 'm'
+---
+
+The `apiKey` argument passed to `createClerkClient` must be changed to `secretKey`.
+
+```js
+import { createClerkClient } from 'gatsby-plugin-clerk/api';
+
+// before
+createClerkClient({ apiKey: '...' });
+
+// after
+createClerkClient({ secretKey: '...' });
+```

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

@@ -0,0 +1,17 @@
+---
+title: '`frontendApi` -> `publishableKey` as param to createClerkClient'
+matcher: "createClerkClient\\({.*?frontendApi:.*?}\\)"
+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.
+
+```js
+import { createClerkClient } from 'gatsby-plugin-clerk/api';
+
+// before
+createClerkClient({ frontendApi: '...' });
+
+// after
+createClerkClient({ publishableKey: '...' });
+```

package/dist/versions/v5/gatsby/withserverauth-return-type.md

@@ -0,0 +1,43 @@
+---
+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. Note specifically that the property `auth.claims` was changed to `auth.sessionClaims` in addition to the other typing changes. A full example of how this looks and how the types differ can be seen below:
+
+```js
+import { withServerAuth } from 'gatsby-plugin-clerk/ssr';
+
+export const getServerData: GetServerData<any> = withServerAuth(async props => {
+	return { props: { data: '1', auth: props.auth } };
+});
+// props.auth : v4 exported type
+/*
+{
+  sessionId: string | null;
+  userId: string | null;
+  actor: ActJWTClaim | null;
+  getToken: ServerGetToken;
+  claims: ClerkJWTClaims | null;
+};
+*/
+
+// props.auth : v5 exported type
+/*
+{
+  sessionClaims: JwtPayload;
+  sessionId: string | null;
+  session: Session | undefined | null;
+  actor: ActClaim | undefined | null;
+  userId: string | null;
+  user: User | undefined | null;
+  orgId: string | undefined | null;
+  orgRole: string | undefined | null;
+  orgSlug: string | undefined | null;
+  organization: Organization | undefined | null;
+  getToken: ServerGetToken;
+  experimental__has: experimental__CheckAuthorizationWithoutPermission;
+  debug: AuthObjectDebug;
+};
+*/
+```