@clerk/upgrade 0.2.1 → 0.4.0

package/dist/versions/v5/index.js

@@ -1,44 +0,0 @@
-import createLoader from '../../util/load-change.js';
-const load = createLoader({
-  version: '5',
-  baseUrl: 'https://clerk.com/docs/upgrade-guides/v5'
-});
-const reactChangesList = ['magiclinkerrorcode', 'usemagiclink', 'ismagiclinkerror', 'magiclinkerror', 'handlemagiclinkverification', 'clerkprovider-frontendapi-2', 'setsession', 'navigate-to-routerpush-routerreplace', 'afterswitchorganizationurl', 'appearance-organizationpreview-organizationswitcher', 'useorganization-invitationlist', 'useorganization-membershiplist', 'useorganizations', 'userprofile-prop', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', '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', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'min-react-version', 'getorganizationlist-return-type-change', 'getorganizationinvitationlist-return-type-change', 'getorganizationmembershiplist-return-type-change', 'organization-getroles-arguments-changed', 'organization-getmemberships-arguments-changed', 'organization-getdomains-arguments-change', 'organization-getinvitations-arguments-changed', 'organization-getmembershiprequests-arguments-changed', 'user-getorganizationinvitations-arguments-chanaged', 'user-getorganizationsuggestions-arguments-chanaged', 'user-getorganizationmemberships-arguments-chanaged'];
-export default {
-  nextjs: load('next', ['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', 'setsession', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', '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', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'min-nextjs-version', 'redirecttosignin-import-path', 'redirecttosignup-import-path', 'getorganizationlist-return-type-change', 'getorganizationinvitationlist-return-type-change', 'getorganizationmembershiplist-return-type-change', 'organization-getroles-arguments-changed', 'organization-getmemberships-arguments-changed', 'organization-getdomains-arguments-change', 'organization-getinvitations-arguments-changed', 'organization-getmembershiprequests-arguments-changed', 'user-getorganizationinvitations-arguments-chanaged', 'user-getorganizationsuggestions-arguments-chanaged', 'user-getorganizationmemberships-arguments-chanaged']),
-  // 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(reactChangesList, ['api-key-to-secret-key', 'createclerkclient-apikey', 'apikey-to-publishable-key', 'createclerkclient-frontendapi', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'setsession', 'api-url-value-change', 'withserverauth-return-type', 'clerk-import-change'])),
-  remix: load('remix', ['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', 'setsession', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'clerk-import-change', 'getorganizationlist-return-type-change', 'getorganizationinvitationlist-return-type-change', 'getorganizationmembershiplist-return-type-change', 'organization-getroles-arguments-changed', 'organization-getmemberships-arguments-changed', 'organization-getdomains-arguments-change', 'organization-getinvitations-arguments-changed', 'organization-getmembershiprequests-arguments-changed', 'user-getorganizationinvitations-arguments-chanaged', 'user-getorganizationsuggestions-arguments-chanaged', 'user-getorganizationmemberships-arguments-chanaged']),
-  expo: load('expo', ['apikey-to-publishable-key', 'ismagiclinkerror', 'usemagiclink', 'magiclinkerrorcode', 'setsession', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl', 'getorganizationlist-return-type-change', 'getorganizationinvitationlist-return-type-change', 'getorganizationmembershiplist-return-type-change']),
-  fastify: load('fastify', ['api-key-to-secret-key', 'api-url-value-change', 'frontend-api-to-publishable-key', 'createclerkclient-apikey', 'createclerkclient-frontendapi', 'clerkplugin-frontendapi', 'clerk-import-change']),
-  node: load('node', ['api-key-to-secret-key', 'api-url-value-change', 'frontend-api-to-publishable-key', 'clerkexpressrequireauth-apikey', 'clerkexpresswithauth-apikey', 'createclerkclient-apikey', 'createclerkexpressrequireauth-apikey', 'createclerkexpresswithauth-apikey', 'createclerkclient-frontendapi', 'createclerkexpressrequireauth-frontendapi', 'clerkexpressrequireauth-frontendapi', 'createclerkexpresswithauth-frontendapi', 'clerkexpresswithauth-frontendapi', 'setclerkapikey', 'setclerkapiversion', 'setclerkhttpoptions', 'setclerkserverapiurl', 'cjs-esm-instance', 'legacyauthobject-removed', 'clerk-import-change']),
-  react: load('react', reactChangesList),
-  js: load('js', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'handlemagiclinkverification', 'external-account-avatarurl',
-  // shared w/ all
-  'organization-logourl',
-  // shared w/ all
-  'user-orgpublicdata-profileimageurl',
-  // shared w/ all
-  'setsession', 'user-update-password',
-  // shared w/ all
-  'experimental-canusecaptcha', 'experimental-captchaurl', 'experimental-captchasitekey', 'getorganizationmemberships', 'lastorganizationinvitation-member', 'unstable-invitationupdate', 'unstable-membershipupdate', 'organization-create-string',
-  // maybe shared with all?
-  'organization-getpendinginvitations',
-  // maybe shared with all?
-  'user-createexternalaccount-redirecturl',
-  // maybe shared with all?
-  'signup-attemptweb3walletverification-generatedsignature', 'redirecttohome', 'organizationprofile-settings', 'userprofile-security', 'mfa-dropdown', 'connected-accounts-dropdown', 'userbuttonpopoveractionbuttontext-removed', 'userbuttontrigger-userbuttonbox-invert', 'organizationswitcherpopoveractionbuttontext-removed', 'card-changes', 'alternativemethods-backlink', 'button-to-organizationlistcreateorganizationactionbutton', 'remove-socialbuttonsblockbuttonarrow', 'remove-identitypreview-avatar', 'organization-getroles-arguments-changed', 'organization-getdomains-arguments-change', 'organization-getmembershiprequests-arguments-changed', 'organization-getmemberships-arguments-changed', 'organization-getinvitations-arguments-changed', 'user-getorganizationinvitations-arguments-chanaged', 'user-getorganizationsuggestions-arguments-chanaged', 'user-getorganizationmemberships-arguments-chanaged', 'aftersignouturl-behavior-change', 'aftersigninurl-behavior-change-2', 'aftersignupurl-behavior-change', 'clerk-isready-removed', 'new-localization-keys', 'removed-localization-keys', 'changed-localization-keys', 'signoutcallback-to-redirecturl']),
-  shared: load('shared', ['magiclinkerror', 'ismagiclinkerror', 'magiclinkerrorcode', 'usemagiclink', 'getrequesturl', 'organizationcontext', 'useorganizationlist-organizationlist' // shared outside this pkg?
-  ]),
-
-  chromeExtension: load('chromeExtension', ['clerkprovider-tokencache']),
-  localizations: load('localization', ['new-localization-keys', 'removed-localization-keys', 'changed-localization-keys']),
-  backend: load('backend', ['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', 'organization-logourl', 'organizationjson-logourl', 'user-profileimageurl', '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', 'getorganizationlist-return-signature', 'getorganizationinvitationlist-return-signature', 'buildrequesturl-removed']),
-  types: [],
-  redwood: [],
-  express: []
-};
-function dedupeMerge(arr1, arr2) {
-  return [...new Set(arr1.concat(arr2))];
-}

package/dist/versions/v5/js/organization-getmemberships-arguments-changed.md

@@ -1,15 +0,0 @@
----
-title: '`Organization.getMemberships` arguments changed'
-matcher: "\\.getMemberships\\("
----
-
-There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
-
-```diff
-  const { data } = await organization.getMemberships({
--   limit: 10,
-+   pageSize: 10,
--   offset: 10,
-+   initialPage: 2,
-  })
-```

package/dist/versions/v5/js/organization-getroles-arguments-changed.md

@@ -1,15 +0,0 @@
----
-title: '`Organization.getRoles` arguments changed'
-matcher: "\\.getRoles\\("
----
-
-There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
-
-```diff
-  const { data } = await organization.getRoles({
--   limit: 10,
-+   pageSize: 10,
--   offset: 10,
-+   initialPage: 2,
-  })
-```

package/dist/versions/v5/js/redirecttohome.md

@@ -1,13 +0,0 @@
----
-title: '`Clerk.redirectToHome()` removed'
-matcher: "Clerk.redirectToHome\\("
----
-
-The `Clerk.redirectToHome` method has been removed. If you are looking for a generic replacement for this method, you can instead use `window.Clerk.redirectToAfterSignUp()` or `window.Clerk.redirectAfterSignIn()`.
-
-To set the `afterSignUpUrl` or `afterSignInUrl`, you can:
-
-    - [pass the desired values into ClerkProvider](https://clerk.com/docs/components/clerk-provider#properties)
-    - if using nextjs SDK, set with `NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL` or `NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL`
-    - if using remix SDK, set with `CLERK_AFTER_SIGN_IN_URL` or `CLERK_AFTER_SIGN_UP_URL`
-    - If not using a react-based SDK, they can be passed into `Clerk.load` as such: `Clerk.load({ afterSignUpUrl: 'x', afterSignInUrl: 'y' })`

package/dist/versions/v5/js/router-navigate-push-replace.md

@@ -1,18 +0,0 @@
----
-title: '`navigate` argument to `Clerk.load` replaced by `routerPush` and `routerReplace`'
-matcher: "Clerk\\.load\\([\\s\\S]*?navigate:[\\s\\S]*?\\)"
-matcherFlags: 'm'
----
-
-The `navigate` option allowed developers to override the default navigation behavior with a custom function. However, navigate was only able to push, not replace routes. We have now added the capability for the router to push or replace, and as such, updated `Clerk.load` so that it can handle either depending on the circumstance.
-
-Two new arguments have been added to options that can be passed to `Clerk.load` that replace the single `navigate` argument, and can be used to override the default navigation behavior for either a push or replace navigation. For more information on what push and replace mean in relation to the browser history api, [check out these wonderful MDN docs](https://developer.mozilla.org/en-US/docs/Web/API/History_API/Working_with_the_History_API).
-
-If you’d like to keep the same behavior as you had with the single `navigate` argument, pass the exact same function to as both the `routerPush` and `routerReplace` arguments and the behavior will be identical. For example:
-
-```diff
-- Clerk.load({ navigate: x => x })
-+ Clerk.load({ routerPush: x => x, routerReplace: x => x })
-```
-
-However, you now have the option to differentiate behavior based on whether the navigation will be a push or replace.

package/dist/versions/v5/js/user-getorganizationinvitations-arguments-chanaged.md

@@ -1,15 +0,0 @@
----
-title: '`User.getOrganizationInvitations` arguments changed'
-matcher: "\\.getOrganizationInvitations\\("
----
-
-There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
-
-```diff
-  const { data } = await user.getOrganizationInvitations({
--   limit: 10,
-+   pageSize: 10,
--   offset: 10,
-+   initialPage: 2,
-  })
-```

package/dist/versions/v5/js/user-getorganizationmemberships-arguments-chanaged.md

@@ -1,15 +0,0 @@
----
-title: '`User.getOrganizationMemberships` arguments changed'
-matcher: "\\.getOrganizationMemberships\\("
----
-
-There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
-
-```diff
-  const { data } = await user.getOrganizationMemberships({
--   limit: 10,
-+   pageSize: 10,
--   offset: 10,
-+   initialPage: 2,
-  })
-```

package/dist/versions/v5/js/user-getorganizationsuggestions-arguments-chanaged.md

@@ -1,15 +0,0 @@
----
-title: '`User.getOrganizationSuggestions` arguments changed'
-matcher: "\\.getOrganizationSuggestions\\("
----
-
-There have been a couple changes to the pagination arguments that can be passed into this function - `limit` has been renamed to `pageSize`, and `offset` has been renamed to `initialPage`. This will help to make it more clear and simple to reason about pagination control. Example of how changes might look below:
-
-```diff
-  const { data } = await user.getOrganizationSuggestions({
--   limit: 10,
-+   pageSize: 10,
--   offset: 10,
-+   initialPage: 2,
-  })
-```

package/dist/versions/v5/next/ismetamaskerror-import-change.md

@@ -1,13 +0,0 @@
----
-title: '`isMetamaskError` import moved under `/errors`'
-matcher: "import\\s+{[\\s\\S]*?isMetamaskError[\\s\\S]*?from\\s+['\"]@clerk\\/(nextjs)[\\s\\S]*?['\"]"
-matcherFlags: 'm'
-replaceWithString: 'nextjs/errors'
----
-
-The `isMetamaskError` 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 { isMetamaskError } from "@clerk/nextjs"
-+ import { isMetamaskError } from "@clerk/nextjs/errors"
-```

package/dist/versions/v5/next/redirecttosignin-removed.md

@@ -1,6 +0,0 @@
----
-title: '`redirectToSignIn` import removed'
-matcher: "import\\s+{[\\s\\S]*?[,\\s]redirectToSignIn[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
----
-
-We have removed the top level `redirectToSignIn` import, because X. Instead, you can use Y.

package/dist/versions/v5/next/redirecttosignup-removed.md

@@ -1,6 +0,0 @@
----
-title: '`redirectToSignUp` import removed'
-matcher: "import\\s+{[\\s\\S]*?[,\\s]redirectToSignUp[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/nextjs[\\s\\S]*?['\"]"
----
-
-We have removed the top level `redirectToSignUp` import, because X. Instead, you can use Y.

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

@@ -1,10 +0,0 @@
----
-title: '`withClerkMiddleware` removed'
-matcher: "withClerkMiddleware\\("
----
-
-`withClerkMiddleware` has been deprecated and is now removed in v5. We recommend moving to `clerkMiddleware` instead. Here’s an example of how the code would look before and after:
-
-```js
-// TODO
-```

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

@@ -1,8 +0,0 @@
----
-title: '`API_URL` value has changed'
-matcher: "import\\s+{[\\s\\S]*?[,\\s]API_URL[,\\s][\\s\\S]*?from\\s+['\"]@clerk\\/clerk-react[\\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/v5/react/router-navigate.md

@@ -1,18 +0,0 @@
----
-title: '`navigate` prop to `ClerkProvider` 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. We have now added the capability for the router to push or replace, and as such, upgraded the provider prop so that it can handle either depending on the circumstance.
-
-Two new props have been added to `ClerkProvider` that replace the single `navigate` prop, and can be used to override the default navigation behavior for either a push or replace navigation. For more information on what push and replace mean in relation to the browser history api, [check out these wonderful MDN docs](https://developer.mozilla.org/en-US/docs/Web/API/History_API/Working_with_the_History_API).
-
-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` and the behavior will be identical. For example:
-
-```diff
-- <ClerkProvider navigate={ x => x } />
-+ <ClerkProvider routerPush={ x => x } routerReplace={ x => x } />
-```
-
-However, you now have the option to differentiate behavior based on whether the navigation will be a push or replace.