@clerk/upgrade 0.3.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (464) hide show
  1. package/dist/app.js +2 -2
  2. package/dist/cli.js +4 -3
  3. package/dist/constants/sdks.js +4 -5
  4. package/dist/constants/versions.js +4 -4
  5. package/dist/guide-generators/{v5 → core-2}/backend/index.js +1 -1
  6. package/dist/guide-generators/{v5/expo → core-2/backend}/intro.mdx +2 -2
  7. package/dist/guide-generators/{v5/chromeExtension → core-2/chrome-extension}/index.js +3 -3
  8. package/dist/guide-generators/core-2/chrome-extension/intro.mdx +3 -0
  9. package/dist/guide-generators/{v5 → core-2}/expo/index.js +3 -2
  10. package/dist/guide-generators/core-2/expo/intro.mdx +3 -0
  11. package/dist/guide-generators/{v5 → core-2}/fastify/index.js +3 -2
  12. package/dist/guide-generators/{v5 → core-2}/fastify/intro.mdx +1 -1
  13. package/dist/guide-generators/{v5 → core-2}/gatsby/index.js +6 -5
  14. package/dist/guide-generators/core-2/gatsby/intro.mdx +3 -0
  15. package/dist/guide-generators/{v5 → core-2}/generate-all.sh +1 -1
  16. package/dist/guide-generators/{v5 → core-2}/js/index.js +3 -2
  17. package/dist/guide-generators/core-2/js/intro.mdx +3 -0
  18. package/dist/guide-generators/{v5 → core-2}/nextjs/import-changes.mdx +2 -2
  19. package/dist/guide-generators/{v5 → core-2}/nextjs/index.js +4 -3
  20. package/dist/guide-generators/core-2/nextjs/intro.mdx +3 -0
  21. package/dist/guide-generators/{v5-guides → core-2}/nextjs/middleware-changes.mdx +44 -66
  22. package/dist/guide-generators/{v5 → core-2}/node/index.js +3 -2
  23. package/dist/guide-generators/{v5 → core-2}/node/intro.mdx +1 -1
  24. package/dist/guide-generators/{v5 → core-2}/overview/index.js +3 -3
  25. package/dist/guide-generators/core-2/overview/intro.mdx +25 -0
  26. package/dist/guide-generators/{v5 → core-2}/react/index.js +3 -2
  27. package/dist/guide-generators/core-2/react/intro.mdx +3 -0
  28. package/dist/guide-generators/{v5 → core-2}/remix/index.js +3 -2
  29. package/dist/guide-generators/core-2/remix/intro.mdx +3 -0
  30. package/dist/guide-generators/{v5 → core-2}/retheme/index.js +7 -8
  31. package/dist/guide-generators/{v5 → core-2}/shared/cli.mdx +1 -1
  32. package/dist/guide-generators/{v5 → core-2}/shared/prepare.mdx +1 -1
  33. package/dist/{util/v5-guides → guide-generators/core-2/shared}/redesign-preview.mdx +1 -1
  34. package/dist/scan.js +1 -1
  35. package/dist/util/load-change.js +2 -2
  36. package/dist/versions/core-2/common/appearance-variables-breaking-changes.md +15 -0
  37. package/dist/versions/{v5 → core-2}/common/changed-localization-keys.md +17 -17
  38. package/dist/versions/core-2/common/new-localization-keys.md +115 -0
  39. package/dist/versions/{v5 → core-2}/common/removed-localization-keys.md +66 -42
  40. package/dist/versions/{v5 → core-2}/common/useorganization-invitationlist.md +5 -5
  41. package/dist/versions/{v5 → core-2}/common/useorganization-membershiplist.md +5 -5
  42. package/dist/versions/{v5 → core-2}/index.js +5 -5
  43. package/dist/versions/{v5 → core-2}/shared/useorganizationlist-organizationlist.md +2 -2
  44. package/package.json +1 -1
  45. package/dist/guide-generators/v5/backend/__output.mdx +0 -580
  46. package/dist/guide-generators/v5/backend/import-moves.mdx +0 -3
  47. package/dist/guide-generators/v5/backend/intro.mdx +0 -3
  48. package/dist/guide-generators/v5/chrome-extension/index.js +0 -19
  49. package/dist/guide-generators/v5/chrome-extension/intro.mdx +0 -3
  50. package/dist/guide-generators/v5/chromeExtension/__output.mdx +0 -409
  51. package/dist/guide-generators/v5/chromeExtension/intro.mdx +0 -3
  52. package/dist/guide-generators/v5/expo/__output.mdx +0 -455
  53. package/dist/guide-generators/v5/fastify/__output.mdx +0 -373
  54. package/dist/guide-generators/v5/gatsby/__output.mdx +0 -472
  55. package/dist/guide-generators/v5/gatsby/intro.mdx +0 -3
  56. package/dist/guide-generators/v5/generate-all.js +0 -0
  57. package/dist/guide-generators/v5/generate.js +0 -263
  58. package/dist/guide-generators/v5/intro.mdx +0 -15
  59. package/dist/guide-generators/v5/js/__output.mdx +0 -528
  60. package/dist/guide-generators/v5/js/intro.mdx +0 -3
  61. package/dist/guide-generators/v5/js/pagination-args.mdx +0 -3
  62. package/dist/guide-generators/v5/js/pagination-return.mdx +0 -3
  63. package/dist/guide-generators/v5/nextjs/__output.mdx +0 -1091
  64. package/dist/guide-generators/v5/nextjs/after-sign-x-handling.mdx +0 -10
  65. package/dist/guide-generators/v5/nextjs/deprecation-removals.mdx +0 -9
  66. package/dist/guide-generators/v5/nextjs/intro.mdx +0 -3
  67. package/dist/guide-generators/v5/nextjs/middleware-changes.mdx +0 -251
  68. package/dist/guide-generators/v5/nextjs/nextjs-versio.mdx +0 -34
  69. package/dist/guide-generators/v5/nextjs/retheme-changes.mdx +0 -10
  70. package/dist/guide-generators/v5/nextjs/version-requirements.mdx +0 -34
  71. package/dist/guide-generators/v5/node/__output.mdx +0 -511
  72. package/dist/guide-generators/v5/overview/__output.mdx +0 -37
  73. package/dist/guide-generators/v5/overview/intro.mdx +0 -31
  74. package/dist/guide-generators/v5/overview/per-sdk.mdx +0 -16
  75. package/dist/guide-generators/v5/per-sdk.mdx +0 -16
  76. package/dist/guide-generators/v5/prepare.mdx +0 -135
  77. package/dist/guide-generators/v5/react/__output.mdx +0 -679
  78. package/dist/guide-generators/v5/react/intro.mdx +0 -3
  79. package/dist/guide-generators/v5/redesigned-components.mdx +0 -11
  80. package/dist/guide-generators/v5/remix/__output.mdx +0 -401
  81. package/dist/guide-generators/v5/remix/intro.mdx +0 -3
  82. package/dist/guide-generators/v5/retheme/__output.mdx +0 -437
  83. package/dist/guide-generators/v5/shared/hof-removals.mdx +0 -3
  84. package/dist/guide-generators/v5/shared/node-setters-removals.mdx +0 -34
  85. package/dist/guide-generators/v5/shared/redesign-preview.mdx +0 -5
  86. package/dist/guide-generators/v5/shared/update-v5.mdx +0 -17
  87. package/dist/guide-generators/v5/single-page-old.js +0 -192
  88. package/dist/guide-generators/v5-guides/deprecation-removals.mdx +0 -7
  89. package/dist/guide-generators/v5-guides/generate.js +0 -263
  90. package/dist/guide-generators/v5-guides/hof-removals.mdx +0 -3
  91. package/dist/guide-generators/v5-guides/intro.mdx +0 -15
  92. package/dist/guide-generators/v5-guides/nextjs/after-sign-x-handling.mdx +0 -10
  93. package/dist/guide-generators/v5-guides/nextjs/deprecation-removals.mdx +0 -9
  94. package/dist/guide-generators/v5-guides/nextjs/import-changes.mdx +0 -98
  95. package/dist/guide-generators/v5-guides/nextjs/index.js +0 -80
  96. package/dist/guide-generators/v5-guides/nextjs/intro.mdx +0 -21
  97. package/dist/guide-generators/v5-guides/nextjs/retheme-changes.mdx +0 -10
  98. package/dist/guide-generators/v5-guides/nextjs/version-requirements.mdx +0 -34
  99. package/dist/guide-generators/v5-guides/node-setters-removals.mdx +0 -34
  100. package/dist/guide-generators/v5-guides/pagination-args.mdx +0 -3
  101. package/dist/guide-generators/v5-guides/pagination-return.mdx +0 -3
  102. package/dist/guide-generators/v5-guides/path-routing.mdx +0 -50
  103. package/dist/guide-generators/v5-guides/per-sdk.mdx +0 -16
  104. package/dist/guide-generators/v5-guides/prepare.mdx +0 -135
  105. package/dist/guide-generators/v5-guides/redesign-preview.mdx +0 -5
  106. package/dist/guide-generators/v5-guides/redesigned-components.mdx +0 -11
  107. package/dist/guide-generators/v5-guides/remix/index.js +0 -15
  108. package/dist/guide-generators/v5-guides/remix/intro.mdx +0 -1
  109. package/dist/guide-generators/v5-guides/remix/output.mdx +0 -362
  110. package/dist/guide-generators/v5-guides/shared/breaking-changes-intro.mdx +0 -0
  111. package/dist/guide-generators/v5-guides/shared/cli.mdx +0 -21
  112. package/dist/guide-generators/v5-guides/shared/deprecation-removals.mdx +0 -7
  113. package/dist/guide-generators/v5-guides/shared/hof-removals.mdx +0 -3
  114. package/dist/guide-generators/v5-guides/shared/node-setters-removals.mdx +0 -34
  115. package/dist/guide-generators/v5-guides/shared/node-version.mdx +0 -3
  116. package/dist/guide-generators/v5-guides/shared/pagination-args.mdx +0 -3
  117. package/dist/guide-generators/v5-guides/shared/pagination-return.mdx +0 -3
  118. package/dist/guide-generators/v5-guides/shared/path-routing.mdx +0 -50
  119. package/dist/guide-generators/v5-guides/shared/prepare.mdx +0 -7
  120. package/dist/guide-generators/v5-guides/shared/react-version.mdx +0 -19
  121. package/dist/guide-generators/v5-guides/shared/redesign-preview.mdx +0 -5
  122. package/dist/guide-generators/v5-guides/shared/update-v5.mdx +0 -17
  123. package/dist/guide-generators/v5-guides/shared/upgrade-v5.mdx +0 -17
  124. package/dist/util/generate-export-change.js +0 -7
  125. package/dist/util/generate-nextjs-migration-guide.js +0 -0
  126. package/dist/util/generate-nextjs-v5-migration-guide.js +0 -0
  127. package/dist/util/step-sequencer.js +0 -31
  128. package/dist/util/text-generation.js +0 -29
  129. package/dist/util/v5-guide/deprecation-removals.mdx +0 -7
  130. package/dist/util/v5-guide/generate.js +0 -200
  131. package/dist/util/v5-guide/getting-up-to-date.mdx +0 -114
  132. package/dist/util/v5-guide/hof-removals.mdx +0 -3
  133. package/dist/util/v5-guide/intro.mdx +0 -15
  134. package/dist/util/v5-guide/node-setters-removals.mdx +0 -34
  135. package/dist/util/v5-guide/pagination-args.mdx +0 -3
  136. package/dist/util/v5-guide/pagination-return.mdx +0 -3
  137. package/dist/util/v5-guide/path-routing.mdx +0 -50
  138. package/dist/util/v5-guide/per-sdk.mdx +0 -16
  139. package/dist/util/v5-guide/prepare.mdx +0 -135
  140. package/dist/util/v5-guide/redesign-preview.mdx +0 -5
  141. package/dist/util/v5-guide/redesigned-components.mdx +0 -11
  142. package/dist/util/v5-guide/remix.mdx +0 -0
  143. package/dist/util/v5-guides/deprecation-removals.mdx +0 -7
  144. package/dist/util/v5-guides/generate.js +0 -200
  145. package/dist/util/v5-guides/hof-removals.mdx +0 -3
  146. package/dist/util/v5-guides/intro.mdx +0 -15
  147. package/dist/util/v5-guides/nextjs/after-sign-x-handling.mdx +0 -10
  148. package/dist/util/v5-guides/nextjs/deprecation-removals.mdx +0 -9
  149. package/dist/util/v5-guides/nextjs/generate.js +0 -80
  150. package/dist/util/v5-guides/nextjs/import-changes.mdx +0 -98
  151. package/dist/util/v5-guides/nextjs/index.js +0 -0
  152. package/dist/util/v5-guides/nextjs/intro.mdx +0 -21
  153. package/dist/util/v5-guides/nextjs/middleware-changes.mdx +0 -251
  154. package/dist/util/v5-guides/nextjs/retheme-changes.mdx +0 -10
  155. package/dist/util/v5-guides/nextjs/version-requirements.mdx +0 -34
  156. package/dist/util/v5-guides/node-setters-removals.mdx +0 -34
  157. package/dist/util/v5-guides/pagination-args.mdx +0 -3
  158. package/dist/util/v5-guides/pagination-return.mdx +0 -3
  159. package/dist/util/v5-guides/path-routing.mdx +0 -50
  160. package/dist/util/v5-guides/per-sdk.mdx +0 -16
  161. package/dist/util/v5-guides/prepare.mdx +0 -135
  162. package/dist/util/v5-guides/redesigned-components.mdx +0 -11
  163. package/dist/util/v5-guides/remix/index.js +0 -5
  164. package/dist/util/v5-nextjs-guide/after-sign-x-handling.mdx +0 -10
  165. package/dist/util/v5-nextjs-guide/deprecation-removals.mdx +0 -9
  166. package/dist/util/v5-nextjs-guide/generate-nextjs-v5-migration-guide.js +0 -0
  167. package/dist/util/v5-nextjs-guide/generate.js +0 -80
  168. package/dist/util/v5-nextjs-guide/import-changes.mdx +0 -98
  169. package/dist/util/v5-nextjs-guide/intro.md +0 -0
  170. package/dist/util/v5-nextjs-guide/intro.mdx +0 -21
  171. package/dist/util/v5-nextjs-guide/middleware-changes.mdx +0 -251
  172. package/dist/util/v5-nextjs-guide/retheme-changes.mdx +0 -11
  173. package/dist/util/v5-nextjs-guide/version-requirements.mdx +0 -34
  174. package/dist/versions/v5/backend/clerkoptions-type.md +0 -0
  175. package/dist/versions/v5/backend/organization-logourl.md +0 -6
  176. package/dist/versions/v5/backend/organizationmembershippublicuserdata-profileimageurl.md +0 -6
  177. package/dist/versions/v5/backend/user-profileimageurl.md +0 -6
  178. package/dist/versions/v5/common/aftersigninurl-behavior-change-2.md +0 -8
  179. package/dist/versions/v5/common/aftersignouturl-behavior-change.md +0 -8
  180. package/dist/versions/v5/common/aftersignupurl-behavior-change.md +0 -8
  181. package/dist/versions/v5/common/appearance-organizationpreview-organizationswitcher.md +0 -9
  182. package/dist/versions/v5/common/externalaccount-picture.md +0 -7
  183. package/dist/versions/v5/common/externalaccountjson-avatarurl.md +0 -7
  184. package/dist/versions/v5/common/getorganizationinvitationlist-return-signature.md +0 -15
  185. package/dist/versions/v5/common/getorganizationinvitationlist-return-type-change.md +0 -17
  186. package/dist/versions/v5/common/getorganizationlist-return-signature.md +0 -15
  187. package/dist/versions/v5/common/getroles-pagination.md +0 -15
  188. package/dist/versions/v5/common/new-localization-keys.md +0 -134
  189. package/dist/versions/v5/common/user-getorganizationinvitations-arguments-chanaged.md +0 -16
  190. package/dist/versions/v5/common/user-getorganizationmemberships-arguments-chanaged.md +0 -16
  191. package/dist/versions/v5/common/user-getorganizationsuggestions-arguments-chanaged.md +0 -16
  192. package/dist/versions/v5/js/external-account-avatarurl.md +0 -7
  193. package/dist/versions/v5/js/organization-create-string.md +0 -12
  194. package/dist/versions/v5/js/organization-getdomains-arguments-change.md +0 -15
  195. package/dist/versions/v5/js/organization-getinvitations-arguments-changed.md +0 -15
  196. package/dist/versions/v5/js/organization-getmembershiprequests-arguments-changed.md +0 -15
  197. package/dist/versions/v5/js/organization-getmemberships-arguments-changed.md +0 -15
  198. package/dist/versions/v5/js/organization-getpendinginvitations.md +0 -11
  199. package/dist/versions/v5/js/organization-getroles-arguments-changed.md +0 -15
  200. package/dist/versions/v5/js/organization-logourl.md +0 -7
  201. package/dist/versions/v5/js/router-navigate-push-replace.md +0 -18
  202. package/dist/versions/v5/js/user-getorganizationinvitations-arguments-chanaged.md +0 -15
  203. package/dist/versions/v5/js/user-getorganizationmemberships-arguments-chanaged.md +0 -15
  204. package/dist/versions/v5/js/user-getorganizationsuggestions-arguments-chanaged.md +0 -15
  205. package/dist/versions/v5/js/user-update-password.md +0 -18
  206. package/dist/versions/v5/next/ismetamaskerror-import-change.md +0 -14
  207. package/dist/versions/v5/next/redirecttosignin-removed.md +0 -6
  208. package/dist/versions/v5/next/redirecttosignup-removed.md +0 -6
  209. package/dist/versions/v5/next/with-clerk-middleware-removed.md +0 -11
  210. package/dist/versions/v5/nextjs/api-url-value-change.md +0 -8
  211. package/dist/versions/v5/nextjs/auth-import-change.md +0 -14
  212. package/dist/versions/v5/nextjs/auth-middleware-deprecated.md +0 -50
  213. package/dist/versions/v5/nextjs/authmiddleware-apikey.md +0 -15
  214. package/dist/versions/v5/nextjs/authmiddleware-frontendapi.md +0 -15
  215. package/dist/versions/v5/nextjs/authmiddleware-import-change.md +0 -14
  216. package/dist/versions/v5/nextjs/buildclerkprops-import-change.md +0 -14
  217. package/dist/versions/v5/nextjs/clerk-import-change.md +0 -13
  218. package/dist/versions/v5/nextjs/clerk-js-version-next-public.md +0 -9
  219. package/dist/versions/v5/nextjs/constants-import-change.md +0 -14
  220. package/dist/versions/v5/nextjs/createauthenticaterequest-import-change.md +0 -14
  221. package/dist/versions/v5/nextjs/createclerkclient-apikey.md +0 -15
  222. package/dist/versions/v5/nextjs/createclerkclient-frontendapi.md +0 -15
  223. package/dist/versions/v5/nextjs/createisomorphicrequest-import-change.md +0 -14
  224. package/dist/versions/v5/nextjs/currentuser-import-change.md +0 -14
  225. package/dist/versions/v5/nextjs/decodejwt-import-change.md +0 -14
  226. package/dist/versions/v5/nextjs/emaillinkerrorcode-import-change.md +0 -14
  227. package/dist/versions/v5/nextjs/getauth-apikey.md +0 -13
  228. package/dist/versions/v5/nextjs/import-api-url.md +0 -8
  229. package/dist/versions/v5/nextjs/import-api-version.md +0 -8
  230. package/dist/versions/v5/nextjs/import-clerk-js-url.md +0 -8
  231. package/dist/versions/v5/nextjs/import-clerk-js-version.md +0 -8
  232. package/dist/versions/v5/nextjs/import-domain.md +0 -8
  233. package/dist/versions/v5/nextjs/import-is-satellite.md +0 -8
  234. package/dist/versions/v5/nextjs/import-nextjs-api.md +0 -21
  235. package/dist/versions/v5/nextjs/import-nextjs-app-beta.md +0 -11
  236. package/dist/versions/v5/nextjs/import-nextjs-edge-middleware.md +0 -7
  237. package/dist/versions/v5/nextjs/import-nextjs-edge-middlewarefiles.md +0 -7
  238. package/dist/versions/v5/nextjs/import-nextjs-ssr.md +0 -8
  239. package/dist/versions/v5/nextjs/import-proxy-url.md +0 -8
  240. package/dist/versions/v5/nextjs/import-publishable-key.md +0 -8
  241. package/dist/versions/v5/nextjs/import-secret-key.md +0 -8
  242. package/dist/versions/v5/nextjs/import-sign-in-url.md +0 -8
  243. package/dist/versions/v5/nextjs/import-sign-up-url.md +0 -8
  244. package/dist/versions/v5/nextjs/isclerkapiresponserror-import-change.md +0 -14
  245. package/dist/versions/v5/nextjs/isemaillinkerror-import-change.md +0 -14
  246. package/dist/versions/v5/nextjs/isknownerror-import-change.md +0 -14
  247. package/dist/versions/v5/nextjs/min-nextjs-version.md +0 -11
  248. package/dist/versions/v5/nextjs/multisessionappsupport-import-change.md +0 -14
  249. package/dist/versions/v5/nextjs/next-public-clerk-js-url.md +0 -7
  250. package/dist/versions/v5/nextjs/redirect-import-change.md +0 -14
  251. package/dist/versions/v5/nextjs/redirecttosignin-import-path.md +0 -13
  252. package/dist/versions/v5/nextjs/redirecttosignup-import-path.md +0 -13
  253. package/dist/versions/v5/nextjs/signjwt-import-change.md +0 -14
  254. package/dist/versions/v5/nextjs/verifyjwt-import-change.md +0 -14
  255. package/dist/versions/v5/nextjs/verifytoken-import-change.md +0 -14
  256. package/dist/versions/v5/react/router-navigate.md +0 -18
  257. /package/dist/guide-generators/{v5 → core-2}/backend/import-paths.mdx +0 -0
  258. /package/dist/guide-generators/{v5 → core-2}/nextjs/nextjs-version.mdx +0 -0
  259. /package/dist/guide-generators/{v5 → core-2}/node/node-setters-removals.mdx +0 -0
  260. /package/dist/guide-generators/{v5 → core-2}/react/hof-removals.mdx +0 -0
  261. /package/dist/guide-generators/{v5 → core-2}/retheme/intro.mdx +0 -0
  262. /package/dist/guide-generators/{v5 → core-2}/shared/after-sign-x-handling.mdx +0 -0
  263. /package/dist/guide-generators/{v5 → core-2}/shared/deprecation-removals.mdx +0 -0
  264. /package/dist/guide-generators/{v5 → core-2}/shared/image-url.mdx +0 -0
  265. /package/dist/guide-generators/{v5 → core-2}/shared/node-version.mdx +0 -0
  266. /package/dist/guide-generators/{v5 → core-2}/shared/orgs-claim.mdx +0 -0
  267. /package/dist/guide-generators/{v5 → core-2}/shared/pagination-args.mdx +0 -0
  268. /package/dist/guide-generators/{v5 → core-2}/shared/pagination-return.mdx +0 -0
  269. /package/dist/guide-generators/{v5 → core-2}/shared/path-routing.mdx +0 -0
  270. /package/dist/guide-generators/{v5 → core-2}/shared/react-version.mdx +0 -0
  271. /package/dist/guide-generators/{v5 → core-2}/shared/update-version.mdx +0 -0
  272. /package/dist/versions/{v5 → core-2}/backend/api-url-value-changed.md +0 -0
  273. /package/dist/versions/{v5 → core-2}/backend/authenticaterequest-params-change.md +0 -0
  274. /package/dist/versions/{v5 → core-2}/backend/buildrequesturl-removed.md +0 -0
  275. /package/dist/versions/{v5 → core-2}/backend/clerk-import.md +0 -0
  276. /package/dist/versions/{v5 → core-2}/backend/client-unstableoptions-removed.md +0 -0
  277. /package/dist/versions/{v5 → core-2}/backend/clockskewinseconds.md +0 -0
  278. /package/dist/versions/{v5 → core-2}/backend/constants-import-path-move.md +0 -0
  279. /package/dist/versions/{v5 → core-2}/backend/createauthenticaterequest-import-path-move.md +0 -0
  280. /package/dist/versions/{v5 → core-2}/backend/createclerkclient-apikey.md +0 -0
  281. /package/dist/versions/{v5 → core-2}/backend/createclerkclient-frontendapi.md +0 -0
  282. /package/dist/versions/{v5 → core-2}/backend/createemail-removed.md +0 -0
  283. /package/dist/versions/{v5 → core-2}/backend/createisomorphicrequest-import-path-move.md +0 -0
  284. /package/dist/versions/{v5 → core-2}/backend/createisomorphicrequest-removed.md +0 -0
  285. /package/dist/versions/{v5 → core-2}/backend/decodejwt-import-path-move.md +0 -0
  286. /package/dist/versions/{v5 → core-2}/backend/getorganizationmembershiplist-return-signature.md +0 -0
  287. /package/dist/versions/{v5 → core-2}/backend/getpendingorganizationinvitationlist.md +0 -0
  288. /package/dist/versions/{v5 → core-2}/backend/httpoptions-removed.md +0 -0
  289. /package/dist/versions/{v5 → core-2}/backend/membershiprole.md +0 -0
  290. /package/dist/versions/{v5 → core-2}/backend/organizationjson-logourl.md +0 -0
  291. /package/dist/versions/{v5 → core-2}/backend/organizationmembershippublicuserdatajson-profileimageurl.md +0 -0
  292. /package/dist/versions/{v5 → core-2}/backend/pkgversion.md +0 -0
  293. /package/dist/versions/{v5 → core-2}/backend/redirect-import-path-move.md +0 -0
  294. /package/dist/versions/{v5 → core-2}/backend/signjwt-import-path-move.md +0 -0
  295. /package/dist/versions/{v5 → core-2}/backend/signjwterror-import-move.md +0 -0
  296. /package/dist/versions/{v5 → core-2}/backend/tokenverificationerror-import-move.md +0 -0
  297. /package/dist/versions/{v5 → core-2}/backend/tokenverificationerroraction-import-move.md +0 -0
  298. /package/dist/versions/{v5 → core-2}/backend/tokenverificationerrorcode-import-move.md +0 -0
  299. /package/dist/versions/{v5 → core-2}/backend/tokenverificationerrorreason-import-move.md +0 -0
  300. /package/dist/versions/{v5 → core-2}/backend/userjson-profileimageurl.md +0 -0
  301. /package/dist/versions/{v5 → core-2}/backend/verifyjwt-import-path-move.md +0 -0
  302. /package/dist/versions/{v5/chromeExtension → core-2/chrome-extension}/clerkprovider-tokencache.md +0 -0
  303. /package/dist/versions/{v5 → core-2}/common/afterswitchorganizationurl.md +0 -0
  304. /package/dist/versions/{v5 → core-2}/common/alternativemethods-backlink.md +0 -0
  305. /package/dist/versions/{v5 → core-2}/common/api-key-to-secret-key.md +0 -0
  306. /package/dist/versions/{v5/backend → core-2/common}/appearance-organizationpreview-organizationswitcher.md +0 -0
  307. /package/dist/versions/{v5 → core-2}/common/button-to-organizationlistcreateorganizationactionbutton.md +0 -0
  308. /package/dist/versions/{v5 → core-2}/common/card-changes.md +0 -0
  309. /package/dist/versions/{v5 → core-2}/common/clerkprovider-frontendapi-2.md +0 -0
  310. /package/dist/versions/{v5 → core-2}/common/clerkprovideroptionswrapper-dropped.md +0 -0
  311. /package/dist/versions/{v5 → core-2}/common/connected-accounts-dropdown.md +0 -0
  312. /package/dist/versions/{v5 → core-2}/common/emaillinkerrorcode-import-change.md +0 -0
  313. /package/dist/versions/{v5 → core-2}/common/externalaccount-avatarurl.md +0 -0
  314. /package/dist/versions/{v5/backend → core-2/common}/externalaccount-picture.md +0 -0
  315. /package/dist/versions/{v5/backend → core-2/common}/externalaccountjson-avatarurl.md +0 -0
  316. /package/dist/versions/{v5 → core-2}/common/frontend-api-to-publishable-key.md +0 -0
  317. /package/dist/versions/{v5/backend → core-2/common}/getorganizationinvitationlist-return-signature.md +0 -0
  318. /package/dist/versions/{v5/backend → core-2/common}/getorganizationinvitationlist-return-type-change.md +0 -0
  319. /package/dist/versions/{v5/backend → core-2/common}/getorganizationlist-return-signature.md +0 -0
  320. /package/dist/versions/{v5 → core-2}/common/getorganizationlist-return-type-change.md +0 -0
  321. /package/dist/versions/{v5 → core-2}/common/getorganizationmembershiplist-return-type-change.md +0 -0
  322. /package/dist/versions/{v5 → core-2}/common/handlemagiclinkverification.md +0 -0
  323. /package/dist/versions/{v5 → core-2}/common/isclerkapiresponserror-import-change.md +0 -0
  324. /package/dist/versions/{v5 → core-2}/common/isemaillinkerror-import-change.md +0 -0
  325. /package/dist/versions/{v5 → core-2}/common/isknownerror-import-change.md +0 -0
  326. /package/dist/versions/{v5 → core-2}/common/ismagiclinkerror.md +0 -0
  327. /package/dist/versions/{v5 → core-2}/common/ismetamaskerror-import-change.md +0 -0
  328. /package/dist/versions/{v5 → core-2}/common/magiclinkerror.md +0 -0
  329. /package/dist/versions/{v5 → core-2}/common/magiclinkerrorcode.md +0 -0
  330. /package/dist/versions/{v5 → core-2}/common/mfa-dropdown.md +0 -0
  331. /package/dist/versions/{v5 → core-2}/common/min-react-version.md +0 -0
  332. /package/dist/versions/{v5 → core-2}/common/multisessionappsupport-import-change.md +0 -0
  333. /package/dist/versions/{v5 → core-2}/common/navigate-to-routerpush-routerreplace.md +0 -0
  334. /package/dist/versions/{v5 → core-2}/common/organization-create-string.md +0 -0
  335. /package/dist/versions/{v5 → core-2}/common/organization-getdomains-arguments-change.md +0 -0
  336. /package/dist/versions/{v5 → core-2}/common/organization-getinvitations-arguments-changed.md +0 -0
  337. /package/dist/versions/{v5 → core-2}/common/organization-getmembershiprequests-arguments-changed.md +0 -0
  338. /package/dist/versions/{v5 → core-2}/common/organization-getmemberships-arguments-changed.md +0 -0
  339. /package/dist/versions/{v5 → core-2}/common/organization-getpendinginvitations.md +0 -0
  340. /package/dist/versions/{v5 → core-2}/common/organization-getroles-arguments-changed.md +0 -0
  341. /package/dist/versions/{v5 → core-2}/common/organization-logourl.md +0 -0
  342. /package/dist/versions/{v5 → core-2}/common/organizationmembershippublicuserdata-profileimageurl.md +0 -0
  343. /package/dist/versions/{v5 → core-2}/common/organizationprofile-settings.md +0 -0
  344. /package/dist/versions/{v5 → core-2}/common/organizationswitcherpopoveractionbuttontext-removed.md +0 -0
  345. /package/dist/versions/{v5 → core-2}/common/remove-identitypreview-avatar.md +0 -0
  346. /package/dist/versions/{v5 → core-2}/common/remove-socialbuttonsblockbuttonarrow.md +0 -0
  347. /package/dist/versions/{v5 → core-2}/common/setsession.md +0 -0
  348. /package/dist/versions/{v5 → core-2}/common/signoutcallback-to-redirecturl.md +0 -0
  349. /package/dist/versions/{v5 → core-2}/common/usemagiclink.md +0 -0
  350. /package/dist/versions/{v5 → core-2}/common/useorganizations.md +0 -0
  351. /package/dist/versions/{v5 → core-2}/common/user-getorganizationinvitations-arguments-changed.md +0 -0
  352. /package/dist/versions/{v5 → core-2}/common/user-getorganizationmemberships-arguments-changed.md +0 -0
  353. /package/dist/versions/{v5 → core-2}/common/user-getorganizationsuggestions-arguments-changed.md +0 -0
  354. /package/dist/versions/{v5 → core-2}/common/user-profileimageurl.md +0 -0
  355. /package/dist/versions/{v5 → core-2}/common/user-update-password.md +0 -0
  356. /package/dist/versions/{v5 → core-2}/common/userbuttonpopoveractionbuttontext-removed.md +0 -0
  357. /package/dist/versions/{v5 → core-2}/common/userbuttontrigger-userbuttonbox-invert.md +0 -0
  358. /package/dist/versions/{v5 → core-2}/common/userprofile-prop.md +0 -0
  359. /package/dist/versions/{v5 → core-2}/common/userprofile-security.md +0 -0
  360. /package/dist/versions/{v5 → core-2}/common/withclerk-hof-removed.md +0 -0
  361. /package/dist/versions/{v5 → core-2}/common/withclerk-removed.md +0 -0
  362. /package/dist/versions/{v5 → core-2}/common/withsession-hof-removed.md +0 -0
  363. /package/dist/versions/{v5 → core-2}/common/withsession-removed.md +0 -0
  364. /package/dist/versions/{v5 → core-2}/common/withuser-hof-removed.md +0 -0
  365. /package/dist/versions/{v5 → core-2}/common/withuser-removed-2.md +0 -0
  366. /package/dist/versions/{v5 → core-2}/expo/apikey-to-publishable-key.md +0 -0
  367. /package/dist/versions/{v5 → core-2}/expo/clerkprovider-frontendapi.md +0 -0
  368. /package/dist/versions/{v5 → core-2}/fastify/api-url-value-change.md +0 -0
  369. /package/dist/versions/{v5 → core-2}/fastify/clerk-import-change.md +0 -0
  370. /package/dist/versions/{v5 → core-2}/fastify/clerkplugin-frontendapi.md +0 -0
  371. /package/dist/versions/{v5 → core-2}/fastify/createclerkclient-apikey.md +0 -0
  372. /package/dist/versions/{v5 → core-2}/fastify/createclerkclient-frontendapi.md +0 -0
  373. /package/dist/versions/{v5 → core-2}/gatsby/api-url-value-change.md +0 -0
  374. /package/dist/versions/{v5 → core-2}/gatsby/apikey-to-publishable-key.md +0 -0
  375. /package/dist/versions/{v5 → core-2}/gatsby/clerk-import-change.md +0 -0
  376. /package/dist/versions/{v5 → core-2}/gatsby/createclerkclient-apikey.md +0 -0
  377. /package/dist/versions/{v5 → core-2}/gatsby/createclerkclient-frontendapi.md +0 -0
  378. /package/dist/versions/{v5 → core-2}/gatsby/withserverauth-return-type.md +0 -0
  379. /package/dist/versions/{v5 → core-2}/js/clerk-isready-removed.md +0 -0
  380. /package/dist/versions/{v5 → core-2}/js/experimental-canusecaptcha.md +0 -0
  381. /package/dist/versions/{v5 → core-2}/js/experimental-captchasitekey.md +0 -0
  382. /package/dist/versions/{v5 → core-2}/js/experimental-captchaurl.md +0 -0
  383. /package/dist/versions/{v5 → core-2}/js/getorganizationmemberships.md +0 -0
  384. /package/dist/versions/{v5 → core-2}/js/lastorganizationinvitation-member.md +0 -0
  385. /package/dist/versions/{v5 → core-2}/js/redirecttohome.md +0 -0
  386. /package/dist/versions/{v5 → core-2}/js/signup-attemptweb3walletverification-generatedsignature.md +0 -0
  387. /package/dist/versions/{v5 → core-2}/js/unstable-invitationupdate.md +0 -0
  388. /package/dist/versions/{v5 → core-2}/js/unstable-membershipupdate.md +0 -0
  389. /package/dist/versions/{v5 → core-2}/js/user-createexternalaccount-redirecturl.md +0 -0
  390. /package/dist/versions/{v5 → core-2}/js/user-orgpublicdata-profileimageurl.md +0 -0
  391. /package/dist/versions/{v5/next → core-2/nextjs}/api-url-value-change.md +0 -0
  392. /package/dist/versions/{v5/next → core-2/nextjs}/auth-import-change.md +0 -0
  393. /package/dist/versions/{v5/next → core-2/nextjs}/auth-middleware-deprecated.md +0 -0
  394. /package/dist/versions/{v5/next → core-2/nextjs}/authmiddleware-apikey.md +0 -0
  395. /package/dist/versions/{v5/next → core-2/nextjs}/authmiddleware-frontendapi.md +0 -0
  396. /package/dist/versions/{v5/next → core-2/nextjs}/authmiddleware-import-change.md +0 -0
  397. /package/dist/versions/{v5/next → core-2/nextjs}/buildclerkprops-import-change.md +0 -0
  398. /package/dist/versions/{v5/next → core-2/nextjs}/clerk-import-change.md +0 -0
  399. /package/dist/versions/{v5/next → core-2/nextjs}/clerk-js-version-next-public.md +0 -0
  400. /package/dist/versions/{v5/next → core-2/nextjs}/constants-import-change.md +0 -0
  401. /package/dist/versions/{v5/next → core-2/nextjs}/createauthenticaterequest-import-change.md +0 -0
  402. /package/dist/versions/{v5/next → core-2/nextjs}/createclerkclient-apikey.md +0 -0
  403. /package/dist/versions/{v5/next → core-2/nextjs}/createclerkclient-frontendapi.md +0 -0
  404. /package/dist/versions/{v5/next → core-2/nextjs}/createisomorphicrequest-import-change.md +0 -0
  405. /package/dist/versions/{v5/next → core-2/nextjs}/currentuser-import-change.md +0 -0
  406. /package/dist/versions/{v5/next → core-2/nextjs}/decodejwt-import-change.md +0 -0
  407. /package/dist/versions/{v5/next → core-2/nextjs}/emaillinkerrorcode-import-change.md +0 -0
  408. /package/dist/versions/{v5/next → core-2/nextjs}/getauth-apikey.md +0 -0
  409. /package/dist/versions/{v5/next → core-2/nextjs}/import-api-url.md +0 -0
  410. /package/dist/versions/{v5/next → core-2/nextjs}/import-api-version.md +0 -0
  411. /package/dist/versions/{v5/next → core-2/nextjs}/import-clerk-js-url.md +0 -0
  412. /package/dist/versions/{v5/next → core-2/nextjs}/import-clerk-js-version.md +0 -0
  413. /package/dist/versions/{v5/next → core-2/nextjs}/import-domain.md +0 -0
  414. /package/dist/versions/{v5/next → core-2/nextjs}/import-is-satellite.md +0 -0
  415. /package/dist/versions/{v5/next → core-2/nextjs}/import-nextjs-api.md +0 -0
  416. /package/dist/versions/{v5/next → core-2/nextjs}/import-nextjs-app-beta.md +0 -0
  417. /package/dist/versions/{v5/next → core-2/nextjs}/import-nextjs-edge-middleware.md +0 -0
  418. /package/dist/versions/{v5/next → core-2/nextjs}/import-nextjs-edge-middlewarefiles.md +0 -0
  419. /package/dist/versions/{v5/next → core-2/nextjs}/import-nextjs-ssr.md +0 -0
  420. /package/dist/versions/{v5/next → core-2/nextjs}/import-proxy-url.md +0 -0
  421. /package/dist/versions/{v5/next → core-2/nextjs}/import-publishable-key.md +0 -0
  422. /package/dist/versions/{v5/next → core-2/nextjs}/import-secret-key.md +0 -0
  423. /package/dist/versions/{v5/next → core-2/nextjs}/import-sign-in-url.md +0 -0
  424. /package/dist/versions/{v5/next → core-2/nextjs}/import-sign-up-url.md +0 -0
  425. /package/dist/versions/{v5/next → core-2/nextjs}/isclerkapiresponserror-import-change.md +0 -0
  426. /package/dist/versions/{v5/next → core-2/nextjs}/isemaillinkerror-import-change.md +0 -0
  427. /package/dist/versions/{v5/next → core-2/nextjs}/isknownerror-import-change.md +0 -0
  428. /package/dist/versions/{v5/next → core-2/nextjs}/min-nextjs-version.md +0 -0
  429. /package/dist/versions/{v5/next → core-2/nextjs}/multisessionappsupport-import-change.md +0 -0
  430. /package/dist/versions/{v5/next → core-2/nextjs}/next-public-clerk-js-url.md +0 -0
  431. /package/dist/versions/{v5/next → core-2/nextjs}/redirect-import-change.md +0 -0
  432. /package/dist/versions/{v5/next → core-2/nextjs}/redirecttosignin-import-path.md +0 -0
  433. /package/dist/versions/{v5/next → core-2/nextjs}/redirecttosignup-import-path.md +0 -0
  434. /package/dist/versions/{v5/next → core-2/nextjs}/signjwt-import-change.md +0 -0
  435. /package/dist/versions/{v5/next → core-2/nextjs}/verifyjwt-import-change.md +0 -0
  436. /package/dist/versions/{v5/next → core-2/nextjs}/verifytoken-import-change.md +0 -0
  437. /package/dist/versions/{v5 → core-2}/nextjs/with-clerk-middleware-removed.md +0 -0
  438. /package/dist/versions/{v5 → core-2}/node/api-url-value-change.md +0 -0
  439. /package/dist/versions/{v5 → core-2}/node/cjs-esm-instance.md +0 -0
  440. /package/dist/versions/{v5 → core-2}/node/clerk-import-change.md +0 -0
  441. /package/dist/versions/{v5 → core-2}/node/clerkexpressrequireauth-apikey.md +0 -0
  442. /package/dist/versions/{v5 → core-2}/node/clerkexpressrequireauth-frontendapi.md +0 -0
  443. /package/dist/versions/{v5 → core-2}/node/clerkexpresswithauth-apikey.md +0 -0
  444. /package/dist/versions/{v5 → core-2}/node/clerkexpresswithauth-frontendapi.md +0 -0
  445. /package/dist/versions/{v5 → core-2}/node/createclerkclient-apikey.md +0 -0
  446. /package/dist/versions/{v5 → core-2}/node/createclerkclient-frontendapi.md +0 -0
  447. /package/dist/versions/{v5 → core-2}/node/createclerkexpressrequireauth-apikey.md +0 -0
  448. /package/dist/versions/{v5 → core-2}/node/createclerkexpressrequireauth-frontendapi.md +0 -0
  449. /package/dist/versions/{v5 → core-2}/node/createclerkexpresswithauth-apikey.md +0 -0
  450. /package/dist/versions/{v5 → core-2}/node/createclerkexpresswithauth-frontendapi.md +0 -0
  451. /package/dist/versions/{v5 → core-2}/node/legacyauthobject-removed.md +0 -0
  452. /package/dist/versions/{v5 → core-2}/node/setclerkapikey.md +0 -0
  453. /package/dist/versions/{v5 → core-2}/node/setclerkapiversion.md +0 -0
  454. /package/dist/versions/{v5 → core-2}/node/setclerkhttpoptions.md +0 -0
  455. /package/dist/versions/{v5 → core-2}/node/setclerkserverapiurl.md +0 -0
  456. /package/dist/versions/{v5 → core-2}/react/api-url-value-change.md +0 -0
  457. /package/dist/versions/{v5 → core-2}/remix/clerk-import-change.md +0 -0
  458. /package/dist/versions/{v5 → core-2}/remix/clerkerrorboundary-removed.md +0 -0
  459. /package/dist/versions/{v5 → core-2}/remix/createclerkclient-apikey.md +0 -0
  460. /package/dist/versions/{v5 → core-2}/remix/getauth-apikey.md +0 -0
  461. /package/dist/versions/{v5 → core-2}/remix/rootauthloader-apikey.md +0 -0
  462. /package/dist/versions/{v5 → core-2}/remix/rootauthloader-frontendapi.md +0 -0
  463. /package/dist/versions/{v5 → core-2}/shared/getrequesturl.md +0 -0
  464. /package/dist/versions/{v5 → core-2}/shared/organizationcontext.md +0 -0
@@ -1,7 +0,0 @@
1
- As part of this major version, a number of previously deprecated props, arugments, methods, etc have been removed. Additionally there have been some changes to things that are only used internally, or only used very rarely. It's highly unlikely that any given app will encounter any of these items, but they are all breaking changes, so they have all been documented below.
2
-
3
- <Callout type='info'>
4
- For this section more than any other one, please use the CLI upgrade tool (`npx @clerk/upgrade`). There
5
- are a lot of changes, each of which are very unlikely to appear in your codebase, that would take a very long time to
6
- look for manually.
7
- </Callout>
@@ -1,200 +0,0 @@
1
- import { renderAccordionForCategory, renderFrontmatter, renderMarkdown, renderSingleItem } from '../text-generation.js';
2
- async function generate() {
3
- const data = (await import(`../../versions/v5/index.js`)).default;
4
- let output = '';
5
- output += renderFrontmatter({
6
- title: 'Upgrading from v4 to v5',
7
- description: 'Learn how to upgrade from version 4 to version 5 of the Clerk JavaScript libraries.'
8
- });
9
- output += '\n\n';
10
- output += renderMarkdown('v5-guide/intro');
11
- output += '\n\n';
12
- output += renderMarkdown('v5-guide/prepare');
13
- output += '\n\n';
14
- output += renderMarkdown('v5-guide/per-sdk');
15
- output += '\n\n';
16
-
17
- // ------------------------------------------------------------
18
-
19
- output += '### Remix';
20
- output += '\n\n';
21
-
22
- // Error boundary removal
23
- output += renderSingleItem('clerkerrorboundary-removed', data.remix);
24
- output += '\n\n';
25
-
26
- // Components redesigned
27
- output += renderMarkdown('v5-guide/redesign-preview');
28
- output += '\n\n';
29
-
30
- // Deprecation removals & housekeeping
31
- output += renderDeprecationRemovalsAndHousekeeping(data.remix);
32
-
33
- // ------------------------------------------------------------
34
-
35
- // TODO: I'm not sure we're actually releasing the gatsby changes in v5, should double check this
36
- output += '### Gatsby';
37
- output += '\n\n';
38
-
39
- // withServerAuth type change
40
- output += renderSingleItem('withserverauth-return-type', data.gatsby);
41
- output += '\n\n';
42
-
43
- // error import path changes
44
- // TODO: need to figure out how widely this applies ⚠️
45
-
46
- // Components redesigned
47
- output += renderMarkdown('v5-guide/redesign-preview');
48
- output += '\n\n';
49
-
50
- // Deprecation removals & housekeeping
51
- output += renderDeprecationRemovalsAndHousekeeping(data.gatsby);
52
-
53
- // ------------------------------------------------------------
54
-
55
- output += '### Expo';
56
- output += '\n\n';
57
-
58
- // Components redesigned
59
- output += renderMarkdown('v5-guide/redesign-preview');
60
- output += '\n\n';
61
-
62
- // Deprecation removals & housekeeping
63
- output += renderDeprecationRemovalsAndHousekeeping(data.expo);
64
-
65
- // ------------------------------------------------------------
66
-
67
- output += '### Fastify';
68
- output += '\n\n';
69
-
70
- // Deprecation removals & housekeeping
71
- output += renderDeprecationRemovalsAndHousekeeping(data.fastify);
72
-
73
- // ------------------------------------------------------------
74
-
75
- output += '### Node';
76
- output += '\n\n';
77
-
78
- // TODO: plans to deprecate this package in favor of backend/express - maybe?
79
-
80
- // cjs/esm imports
81
- output += renderSingleItem('cjs-esm-instance', data.node);
82
- output += '\n\n';
83
-
84
- // createClerkClient options instead of setter methods
85
- output += renderMarkdown('v5-guide/node-setters-removals');
86
- output += '\n\n';
87
-
88
- // Deprecation removals & housekeeping
89
- output += renderDeprecationRemovalsAndHousekeeping(data.node);
90
-
91
- // ------------------------------------------------------------
92
-
93
- output += '### React';
94
- output += '\n\n';
95
-
96
- // path routing (TODO: this should be linked to from other react SDKs)
97
- output += renderMarkdown('v5-guide/path-routing');
98
- output += '\n\n';
99
-
100
- // routerPush/routerReplace
101
- output += renderSingleItem('navigate-to-routerpush-routerreplace', data.react);
102
- output += '\n\n';
103
-
104
- // useOrganizationsList
105
- output += renderSingleItem('useorganizations', data.react);
106
- output += '\n\n';
107
-
108
- // HOF removals (TODO: this applies to all react sdks, should be shared section)
109
- output += renderMarkdown('v5-guide/hof-removals');
110
- output += '\n\n';
111
- output += renderAccordionForCategory(data.react, 'hof-removal');
112
- output += '\n\n';
113
-
114
- // error import paths
115
- // TODO: applies to all sdks, make a shared section
116
-
117
- // Components redesigned
118
- output += renderMarkdown('v5-guide/redesign-preview');
119
- output += '\n\n';
120
-
121
- // Deprecation removals & housekeeping
122
- output += renderDeprecationRemovalsAndHousekeeping(data.react);
123
-
124
- // ------------------------------------------------------------
125
-
126
- output += '### Javascript';
127
- output += '\n\n';
128
-
129
- // pagination params
130
- output += renderMarkdown('v5-guide/pagination-args');
131
- output += '\n\n';
132
- output += renderAccordionForCategory(data.js, 'pagination-args');
133
- output += '\n\n';
134
-
135
- // data/totalCount return values
136
- output += renderMarkdown('v5-guide/pagination-return');
137
- output += '\n\n';
138
- output += renderAccordionForCategory(data.js, 'pagination-return');
139
- output += '\n\n';
140
-
141
- // ------------------------------------------------------------
142
-
143
- output += '### Backend';
144
- output += '\n\n';
145
-
146
- // ------------------------------------------------------------
147
-
148
- output += '### Chrome Extension';
149
- output += '\n\n';
150
-
151
- // ------------------------------------------------------------
152
-
153
- // Component redesign, shared section
154
- output += renderMarkdown('v5-guide/redesigned-components');
155
- output += '\n\n';
156
-
157
- // This is a guide-specific item, no matcher for this
158
- // TODO: add a way to have this be a normal change item but not run in the CLI
159
- const defaultsChangeItem = {
160
- title: 'Changes to default variables',
161
- content: `The default values of some [appearance variables](/docs/components/customization/variables) have changed which may impact your UI (if you are not already overriding them).
162
-
163
- - The default \`colorPrimary\` value changed from \`#103FEF\` to \`#2F3037\`. As the new color is a dark grey, the \`colorPrimary\` of the dark theme was changed to \`#FFFFFF\`.
164
- - The default \`fontSize\` value changed from \`1rem\` to \`0.8125rem\`
165
- - The default \`fontWeight\` values changed from \`{ normal: 400, medium: 500, bold: 600 }\` to \`{ normal: 400, medium: 500, bold: 700 }\`
166
- - Previously, the default value for \`fontSmoothing\` was \`auto\`. This value is now unset. If you want to pass a custom value to it, you can still do so.`
167
- };
168
- output += '#### Appearance changes';
169
- output += '\n\n';
170
- output += renderAccordionForCategory(data.nextjs, 'appearance', {
171
- additionalItems: [defaultsChangeItem]
172
- });
173
- output += '\n\n';
174
- output += '#### Localization changes';
175
- output += '\n\n';
176
- output += renderAccordionForCategory(data.nextjs, 'localization');
177
- output += '\n\n';
178
- return output;
179
- }
180
- generate().then(console.log);
181
-
182
- // This is used the same way for all SDKs, so this fn prevents tons of repetition
183
- function renderDeprecationRemovalsAndHousekeeping(data) {
184
- let output = '';
185
- output += '## Deprecation removals & housekeeping';
186
- output += '\n\n';
187
- output += renderMarkdown('v5-guide/deprecation-removals');
188
- output += '\n\n';
189
- output += '### Deprecation removals';
190
- output += '\n\n';
191
- output += renderMarkdown('v5-guide/deprecation-removals');
192
- output += '\n\n';
193
- output += renderAccordionForCategory(data, 'deprecation-removal');
194
- output += '\n\n';
195
- output += '### Other Breaking Changes';
196
- output += '\n\n';
197
- output += renderAccordionForCategory(data, [undefined, 'hof-removal', 'pagination-return', 'pagination-args', 'error-imports']);
198
- output += '\n\n';
199
- return output;
200
- }
@@ -1,114 +0,0 @@
1
- ## Preparing to upgrade
2
-
3
- Before uprading, Clerk highly recommends updating your clerk SDKs to the latest v4 version. Some changes required for v5 can be applied incrementally to the latest v4, which should contribute to a smoother upgrading experience.
4
-
5
- After updating, look out for deprecation messages in your terminal and browser console. By resolving these deprecations you'll be able to skip many breaking changes for v5.
6
-
7
- Some of the minumum version requirements for Node.js, React, and Next.js have been updated such that versions that are no longer supported or are at end-of-life are no longer guaranteed to work correctly with Clerk. Please take a moment to check your dependencies and ensure you are up to date!
8
-
9
- #### Updating Node.js
10
-
11
- You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 entered EOL (End of life) status so it's time to bump the required version for `@clerk/nextjs`, too. You can check your Node.js version by running `node -v` in your terminal. Learn more about how to [update and install Node.js](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs).
12
-
13
- #### Updating React
14
-
15
- All react-dependent SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`.
16
-
17
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
18
- ```bash filename="terminal"
19
- npm install react@latest react-dom@latest
20
- ```
21
-
22
- ```bash filename="terminal"
23
- yarn add react@latest react-dom@latest
24
- ```
25
-
26
- ```bash filename="terminal"
27
- pnpm add react@latest react-dom@latest
28
- ```
29
-
30
- </CodeBlockTabs>
31
-
32
- If you are upgrading from React 17 or lower, make sure to [learn about how to upgrade your React version to 18](https://react.dev/blog/2022/03/08/react-18-upgrade-guide) as well.
33
-
34
- ## Updating to v5
35
-
36
- Whenever you feel ready, go ahead and install the latest beta version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. Some examples for how to unstall commonly used SDKs are below:
37
-
38
- <Tabs type="v4-to-v5-sdk" items={["Next.js", "React", "Remix", "JavaScript", "Node.js"]}>
39
- <Tab>
40
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
41
- ```bash filename="terminal"
42
- npm install @clerk/nextjs@beta
43
- ```
44
-
45
- ```bash filename="terminal"
46
- yarn add @clerk/nextjs@beta
47
- ```
48
-
49
- ```bash filename="terminal"
50
- pnpm add @clerk/nextjs@beta
51
- ```
52
- </CodeBlockTabs>
53
- </Tab>
54
- <Tab>
55
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
56
- ```bash filename="terminal"
57
- npm install @clerk/clerk-react@beta
58
- ```
59
-
60
- ```bash filename="terminal"
61
- yarn add @clerk/clerk-react@beta
62
- ```
63
-
64
- ```bash filename="terminal"
65
- pnpm add @clerk/clerk-react@beta
66
- ```
67
- </CodeBlockTabs>
68
- </Tab>
69
- <Tab>
70
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
71
- ```bash filename="terminal"
72
- npm install @clerk/remix@beta
73
- ```
74
-
75
- ```bash filename="terminal"
76
- yarn add @clerk/remix@beta
77
- ```
78
-
79
- ```bash filename="terminal"
80
- pnpm add @clerk/remix@beta
81
- ```
82
- </CodeBlockTabs>
83
- </Tab>
84
- <Tab>
85
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
86
- ```bash filename="terminal"
87
- npm install @clerk/clerk-js@beta
88
- ```
89
-
90
- ```bash filename="terminal"
91
- yarn add @clerk/clerk-js@beta
92
- ```
93
-
94
- ```bash filename="terminal"
95
- pnpm add @clerk/clerk-js@beta
96
- ```
97
- </CodeBlockTabs>
98
- </Tab>
99
- <Tab>
100
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
101
- ```bash filename="terminal"
102
- npm install @clerk/clerk-sdk-node@beta
103
- ```
104
-
105
- ```bash filename="terminal"
106
- yarn add @clerk/clerk-sdk-node@beta
107
- ```
108
-
109
- ```bash filename="terminal"
110
- pnpm add @clerk/clerk-sdk-node@beta
111
- ```
112
- </CodeBlockTabs>
113
- </Tab>
114
- </Tabs>
@@ -1,3 +0,0 @@
1
- ### Some higher-order functions and components removed
2
-
3
- A set of higher-order functions and components that are easily replicated with userland code and were rarely used have been removed. Each of them are listed below, along with code snippets with which they can be reproduced if need be.
@@ -1,15 +0,0 @@
1
- # Upgrading from v4 to v5
2
-
3
- Clerk's SDKs include React, Next.js, Remix, Expo, Redwood, and others. This guide helps you with uprading to the next major version of your SDK.
4
-
5
- Version 5 ships with an improved design and UX for its built-in components, no "flash of white page" when authenticating, and a new middleware for Next.js which defaults to not protecting any routes. Along with these highly requested features some smaller DX improvements and housekeeping items made its way into the release. If you want to know everything that's new, read the [v5 announcement post](https://clerk.com/changelog/2024-01-16).
6
-
7
- <Callout type="info" >
8
- Version 5/v5 refers to the [`@clerk/clerk-js`](https://www.npmjs.com/package/@clerk/clerk-js) package version. However, other SDKs like `@clerk/backend` or `@clerk/clerk-expo` are versioned independently (and would upgrade from v1 to v2). To make this page easier to read for instances of general advice only v5 is mentioned. You can think of v4 as the previous major of your SDK and v5 as the current in those cases.
9
- </Callout>
10
-
11
- If you're curious about Clerk's approach to versioning and support, head to the [long term support](/docs/upgrade-guides/long-term-support) document. Version 5 includes [potentially breaking changes](#breaking-changes), as well as the removal of [previously deprecated features](#previously-deprecated-features).
12
-
13
- For most users we expect a smooth upgrade path as only a couple of changes will be required: [Update dependencies](#update-dependencies), run the `@clerk/upgrade` CLI, [update Clerk](#update-clerk), and handle any [breaking changes](#breaking-changes).
14
-
15
- If you're using **Next.js**, you can read a more streamlined [Upgrading Next.js from v4 to v5](/docs/upgrade-guides/upgrading-nextjs-from-v4-to-v5) guide.
@@ -1,34 +0,0 @@
1
- ### Clerk client setters removed in favor of `createClerkClient` options
2
-
3
- The following setter methods have been removed in the lastest version. If you were using any of these functions, their functionality can be replaced by instead passing the correponding option to `createClerkClient`.
4
-
5
- - `setClerkApiVersion`
6
- - `setClerkHttpOptions`
7
- - `setClerkServerApiUrl`
8
- - `setClerkApiKey`
9
-
10
- Code example:
11
-
12
- ```diff
13
- import {
14
- clerkClient,
15
- - setClerkApiKey,
16
- - setClerkApiVersion,
17
- - setClerkHttpOptions,
18
- - setClerkServerApiUrl
19
- } from "@clerk/clerk-sdk-node"
20
-
21
- - setClerkApiKey("...")
22
- - setClerkApiVersion("...")
23
- - setClerkHttpOptions("...")
24
- - setClerkServerApiUrl("...")
25
-
26
- const clerkClient = createClerkClient({
27
- + secretKey: "..."
28
- + apiVersion: "..."
29
- + httpOptions: "..."
30
- + serverApiUrl: "..."
31
- })
32
-
33
- await clerkClient.users.getUser(userId);
34
- ```
@@ -1,3 +0,0 @@
1
- #### Changes to pagination arguments for some functions
2
-
3
- There were some changes made to pagination-related arguments passed into functions, in order to make it more clear how to control paginated results. See each function impacted by these changes below:
@@ -1,3 +0,0 @@
1
- #### Changes to some function return signatures
2
-
3
- There have been changes to return signatures for some functions. Since Clerk's API responses are paginated, the `totalCount` property is helpful in determining the total number of items in the response easily. This change also aligns the response shape with what is returned from the Clerk backend API. Each impacted function is listed below, along with code examples:
@@ -1,50 +0,0 @@
1
- ### Path routing is now the default
2
-
3
- On components like [`<SignIn />`](/docs/components/authentication/sign-in) you can define the props `routing` and `path`. `routing` can be set to `'hash' | 'path' | 'virtual'` and describes the routing strategy that should be used. `path` defines where the component is mounted when `routing="path"` is used.
4
-
5
- In the latest version, the **default** `routing` strategy has become `'path'`. Unless you change the `routing` prop, you'll need to define the `path` prop. The affected components are:
6
-
7
- - `<SignIn />`
8
- - `<SignUp />`
9
- - `<UserProfile />`
10
- - `<CreateOrganization />`
11
- - `<OrganizationProfile />`
12
-
13
- Here's how you'd use the components going forward:
14
-
15
- ```jsx
16
- <SignIn path="/sign-in" />
17
- <SignUp path="/sign-up" />
18
- <UserProfile path="/user-profile" />
19
- <CreateOrganization path="/create-org" />
20
- <OrganizationProfile path="/org-profile" />
21
- ```
22
-
23
- If you don't define the `path` prop an error will be thrown. Of course, you can still use `routing="hash"` or `routing="virtual"`.
24
-
25
- ```jsx
26
- <UserProfile routing="hash" />
27
- <OrganizationProfile routing="virtual" />
28
- ```
29
-
30
- However, there are two exceptions to this behavior. If you're using `@clerk/nextjs` or `@clerk/remix`, you can set environment variables for `<SignIn />` and `<SignUp />`.
31
-
32
- <CodeBlockTabs options={["Next.js", "Remix"]}>
33
- ```env filename=".env.local"
34
- NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
35
- NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
36
- ```
37
-
38
- ```env filename=".env"
39
- CLERK_SIGN_IN_URL=/sign-in
40
- CLERK_SIGN_UP_URL=/sign-up
41
- ```
42
- </CodeBlockTabs>
43
-
44
- **Only** if you're using one of these two frameworks and defined both environment variables, you're able to use the `<SignIn />` and `<SignUp />` components without any props.
45
-
46
- ```jsx
47
- // Only works for Next.js / Remix when environment variables are set
48
- <SignIn />
49
- <SignUp />
50
- ```
@@ -1,16 +0,0 @@
1
- ## SDK Guides
2
-
3
- Select the SDK(s) you are using for your project from the list below to read through a summary of all the breaking changes:
4
-
5
- > Note: I want a prettier selection component here, in it's absence for now there's a list
6
-
7
- - [Next.js](upgrading-nextjs-from-v4-to-v5)
8
- - [Remix](#remix)
9
- - [Expo](#expo)
10
- - [Gatsby](#gatsby)
11
- - [Backend](#backend)
12
- - [Node](#node)
13
- - [Fastify](#fastify)
14
- - [React](#react)
15
- - [JS](#js)
16
- - [Chrome Extension](#chrome-extension)
@@ -1,135 +0,0 @@
1
- ## Preparing to upgrade
2
-
3
- Before uprading, it's highly recommended that you update your Clerk SDKs to the latest v4 version. Some changes required for v5 can be applied incrementally to the latest v4, which should contribute to a smoother upgrading experience.
4
-
5
- After updating, look out for deprecation messages in your terminal and browser console. By resolving these deprecations you'll be able to skip many breaking changes for v5.
6
-
7
- Additionally, some of the minumum version requirements for Node.js, React, and Next.js have been updated such that versions that are no longer supported or are at end-of-life are no longer guaranteed to work correctly with Clerk. Please take a moment to check your dependencies and ensure you are up to date!
8
-
9
- #### Updating Node.js
10
-
11
- You need to have Node.js `18.17.0` or later installed. Last year, Node.js 16 entered EOL (End of life) status so it's time to bump the required version for `@clerk/nextjs`, too. You can check your Node.js version by running `node -v` in your terminal. Learn more about how to [update and install Node.js](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs).
12
-
13
- #### Updating React
14
-
15
- All react-dependent SDKs now require you to use React 18 or higher. You can update your project by installing the latest version of `react` and `react-dom`.
16
-
17
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
18
- ```bash filename="terminal"
19
- npm install react@latest react-dom@latest
20
- ```
21
-
22
- ```bash filename="terminal"
23
- yarn add react@latest react-dom@latest
24
- ```
25
-
26
- ```bash filename="terminal"
27
- pnpm add react@latest react-dom@latest
28
- ```
29
- </CodeBlockTabs>
30
-
31
- If you are upgrading from React 17 or lower, make sure to [learn about how to upgrade your React version to 18](https://react.dev/blog/2022/03/08/react-18-upgrade-guide) as well.
32
-
33
- ## Updating to v5
34
-
35
- Whenever you feel ready, go ahead and install the latest beta version of any Clerk SDKs you are using. Make sure that you are prepared to patch some breaking changes before your app will work properly, however. Some examples for how to unstall commonly used SDKs are below:
36
-
37
- <Tabs type="v4-to-v5-sdk" items={["Next.js", "React", "Remix", "JavaScript", "Node.js"]}>
38
- <Tab>
39
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
40
- ```bash filename="terminal"
41
- npm install @clerk/nextjs@beta
42
- ```
43
-
44
- ```bash filename="terminal"
45
- yarn add @clerk/nextjs@beta
46
- ```
47
-
48
- ```bash filename="terminal"
49
- pnpm add @clerk/nextjs@beta
50
- ```
51
- </CodeBlockTabs>
52
- </Tab>
53
- <Tab>
54
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
55
- ```bash filename="terminal"
56
- npm install @clerk/clerk-react@beta
57
- ```
58
-
59
- ```bash filename="terminal"
60
- yarn add @clerk/clerk-react@beta
61
- ```
62
-
63
- ```bash filename="terminal"
64
- pnpm add @clerk/clerk-react@beta
65
- ```
66
- </CodeBlockTabs>
67
- </Tab>
68
- <Tab>
69
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
70
- ```bash filename="terminal"
71
- npm install @clerk/remix@beta
72
- ```
73
-
74
- ```bash filename="terminal"
75
- yarn add @clerk/remix@beta
76
- ```
77
-
78
- ```bash filename="terminal"
79
- pnpm add @clerk/remix@beta
80
- ```
81
- </CodeBlockTabs>
82
- </Tab>
83
- <Tab>
84
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
85
- ```bash filename="terminal"
86
- npm install @clerk/clerk-js@beta
87
- ```
88
-
89
- ```bash filename="terminal"
90
- yarn add @clerk/clerk-js@beta
91
- ```
92
-
93
- ```bash filename="terminal"
94
- pnpm add @clerk/clerk-js@beta
95
- ```
96
- </CodeBlockTabs>
97
- </Tab>
98
- <Tab>
99
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
100
- ```bash filename="terminal"
101
- npm install @clerk/clerk-sdk-node@beta
102
- ```
103
-
104
- ```bash filename="terminal"
105
- yarn add @clerk/clerk-sdk-node@beta
106
- ```
107
-
108
- ```bash filename="terminal"
109
- pnpm add @clerk/clerk-sdk-node@beta
110
- ```
111
- </CodeBlockTabs>
112
- </Tab>
113
- </Tabs>
114
-
115
- ## CLI Upgrade Helper
116
-
117
- As of this major version Clerk provides a `@clerk/upgrade` CLI tool that you can use to ease the upgrade. A CLI prompt will ask you a couple of questions, it will scan your codebase, and afterwards you'll get a list of changes you'll need to apply to your project, as well as the locations where they need to be applied. This should catch the vast majority of the changes needed for a successful upgrade to v5, and can save a lot of time reading through changes to things that aren't actually in your project.
118
-
119
- To run the CLI tool, navigate to your project and run it in the terminal:
120
-
121
- <CodeBlockTabs type="installer" options={["npm", "yarn", "pnpm"]}>
122
- ```bash filename="terminal"
123
- npx @clerk/upgrade
124
- ```
125
-
126
- ```bash filename="terminal"
127
- yarn dlx @clerk/upgrade
128
- ```
129
-
130
- ```bash filename="terminal"
131
- pnpm dlx @clerk/upgrade
132
- ```
133
- </CodeBlockTabs>
134
-
135
- If you are having trouble with `npx`, it's also possible to install directly with `npm i @clerk/upgrade -g`, and can then be run with the `clerk-upgrade` command.
@@ -1,5 +0,0 @@
1
- ### Component design adjustments
2
-
3
- The new version ships with improved design and UX across all of Clerk's [UI components](/docs/components/overview). If you have used the [`appearance` prop](/docs/components/customization/overview) or tokens for a [custom theme](/docs/components/customization/overview#create-a-custom-theme), you will likely need to make some adjustments to ensure your styling is still looking great. If you're using the [localization prop](/docs/components/customization/localization) you will likely need to make adjustments to account for added or removed localization keys.
4
-
5
- [More detail on these changes &raquo;](#redesigned-components)
@@ -1,11 +0,0 @@
1
- ## Redesigned components
2
-
3
- The new version ships with improved design and UX across all of Clerk's [UI components](/docs/components/overview). If you have used the [`appearance` prop](/docs/components/customization/overview) or tokens for a [custom theme](/docs/components/customization/overview#create-a-custom-theme), you will likely need to make some adjustments to ensure your styling is still looking great. If you're using the [localization prop](/docs/components/customization/localization) you will likely need to make adjustments to account for added or removed localization keys.
4
-
5
- <Callout type='info'>
6
- If you are not customizing the appearance of your components, or using `localization`, you can skip this section. If
7
- you are, we recommend using our CLI (`npx @clerk/upgrade`) to scan for changes required as part of the component
8
- redesign more quickly.
9
- </Callout>
10
-
11
- The sections below contain more info on each change made to the customization ids and localization keys for reference. Regardless of how thoroughly you have reviewed the following information, we still recommend that you ensure that you have taken some time to manually look through each of your views to ensure that everything looks good still.
File without changes
@@ -1,7 +0,0 @@
1
- As part of this major version, a number of previously deprecated props, arugments, methods, etc have been removed. Additionally there have been some changes to things that are only used internally, or only used very rarely. It's highly unlikely that any given app will encounter any of these items, but they are all breaking changes, so they have all been documented below.
2
-
3
- <Callout type='info'>
4
- For this section more than any other one, please use the CLI upgrade tool (`npx @clerk/upgrade`). There
5
- are a lot of changes, each of which are very unlikely to appear in your codebase, that would take a very long time to
6
- look for manually.
7
- </Callout>