1import versions from '~/public/static/constants/versions.json'; 2 3export function getRedirectPath(redirectPath: string): string { 4 // index.html is no longer a thing in our docs 5 if (pathIncludesIndexHtml(redirectPath)) { 6 redirectPath = redirectPath.replace('index.html', ''); 7 } 8 9 // Remove the .html extension if it is included in the path 10 if (pathIncludesHtmlExtension(redirectPath)) { 11 redirectPath = redirectPath.replace('.html', ''); 12 } 13 14 // Unsure why this is happening, but sometimes URLs end up with /null in 15 // the last path part 16 // https://docs.expo.dev/versions/latest/sdk/overview/null 17 if (endsInNull(redirectPath)) { 18 redirectPath = redirectPath.replace(/null$/, ''); 19 } 20 21 // Add a trailing slash if there is not one 22 if (redirectPath[redirectPath.length - 1] !== '/') { 23 redirectPath = `${redirectPath}/`; 24 } 25 26 // A list of pages we know are renamed and can redirect 27 if (RENAMED_PAGES[redirectPath]) { 28 redirectPath = RENAMED_PAGES[redirectPath]; 29 } 30 31 // Catch any unversioned paths which are also renamed 32 if (isVersionedPath(redirectPath)) { 33 const unversionedPath = removeVersionFromPath(redirectPath); 34 if (RENAMED_PAGES[unversionedPath]) { 35 redirectPath = RENAMED_PAGES[unversionedPath]; 36 } 37 } 38 39 // Check if the version is documented, replace it with latest if not 40 if (!isVersionDocumented(redirectPath)) { 41 redirectPath = replaceVersionWithLatest(redirectPath); 42 } 43 44 // Remove versioning from path if this section is no longer versioned 45 if (isVersionedPath(redirectPath) && !pathRequiresVersioning(redirectPath)) { 46 redirectPath = removeVersionFromPath(redirectPath); 47 } 48 49 // Catch any redirects to sdk paths without versions and send to the latest version 50 if (redirectPath.startsWith('/sdk/')) { 51 redirectPath = `/versions/latest${redirectPath}`; 52 } 53 54 // If a page is missing for react-native paths we redirect to react-native docs 55 if (redirectPath.match(/\/versions\/.*\/react-native\//)) { 56 const pathParts = redirectPath.split('/'); 57 const page = pathParts[pathParts.length - 2]; 58 redirectPath = `https://reactnative.dev/docs/${page}`; 59 } 60 61 // Remove version from path if the version is still supported, to redirect to the root 62 if (isVersionedPath(redirectPath) && isVersionDocumented(redirectPath)) { 63 redirectPath = `/versions/${getVersionFromPath(redirectPath)}/`; 64 } 65 66 return redirectPath; 67} 68 69function getVersionFromPath(path: string) { 70 const pathParts = path.split(/\//); 71 // eg: ["", "versions", "v32.0.0", ""] 72 return pathParts[2]; 73} 74 75// Filter unversioned and latest out, so we end up with v34, etc. 76const supportedVersions = versions.VERSIONS.filter(v => v.match(/^v/)); 77 78// Return true if the version is still included in documentation 79function isVersionDocumented(path: string) { 80 return supportedVersions.includes(getVersionFromPath(path)); 81} 82 83function pathIncludesHtmlExtension(path: string) { 84 return !!path.match(/\.html$/); 85} 86 87function pathIncludesIndexHtml(path: string) { 88 return !!path.match(/index\.html$/); 89} 90 91const VERSION_PART_PATTERN = `(latest|unversioned|v\\d+\\.\\d+.\\d+)`; 92const VERSIONED_PATH_PATTERN = `^\\/versions\\/${VERSION_PART_PATTERN}`; 93const SDK_PATH_PATTERN = `${VERSIONED_PATH_PATTERN}/sdk`; 94const REACT_NATIVE_PATH_PATTERN = `${VERSIONED_PATH_PATTERN}/react-native`; 95 96// Check if path is valid (matches /versions/some-valid-version-here/) 97function isVersionedPath(path: string) { 98 return !!path.match(new RegExp(VERSIONED_PATH_PATTERN)); 99} 100 101// Replace an unsupported SDK version with latest 102function replaceVersionWithLatest(path: string) { 103 return path.replace(new RegExp(VERSION_PART_PATTERN), 'latest'); 104} 105 106/** 107 * Determine if the path requires versioning, if not we can remove the versioned prefix from the path. 108 * The following paths require versioning: 109 * - `/versions/<version>/sdk/**`, pages within the Expo SDK docs. 110 * - `/versions/<version>/react-native/**`, pages within the React Native API docs. 111 * - `/versions/<version>/`, the index of a specific Expo SDK version. 112 * All other paths shouldn't require versioning, some of them are: 113 * - `/versions/<version>/workflow/expo-cli/, moved outside versioned folders. 114 * - `/versions/<version>/guides/assets/, moved outside versioned folders. 115 */ 116function pathRequiresVersioning(path: string) { 117 const isExpoSdkPage = path.match(new RegExp(SDK_PATH_PATTERN)); 118 const isExpoSdkIndexPage = path.match(new RegExp(VERSIONED_PATH_PATTERN + '/$')); 119 const isReactNativeApiPage = path.match(new RegExp(REACT_NATIVE_PATH_PATTERN)); 120 121 return isExpoSdkIndexPage || isExpoSdkPage || isReactNativeApiPage; 122} 123 124function removeVersionFromPath(path: string) { 125 return path.replace(new RegExp(VERSIONED_PATH_PATTERN), ''); 126} 127 128// Not sure why this happens but sometimes the URL ends in /null 129function endsInNull(path: string) { 130 return !!path.match(/\/null$/); 131} 132 133// Simple remapping of renamed pages, similar to in deploy.sh but in some cases, 134// for reasons I'm not totally clear on, those redirects do not work 135const RENAMED_PAGES: Record<string, string> = { 136 // Redirects after creating /home route 137 '/next-steps/additional-resources/': '/additional-resources/', 138 // TODO: (@aman) Uncomment the two lines below when we've removed third-party libraries from Reference 139 // '/versions/latest/sdk/safe-area-context/': '/home/develop/user-interface/safe-areas', 140 // '/versions/latest/sdk/async-storage/': '/home/develop/user-interface/store-data/#async-storage', 141 '/get-started/create-a-new-app/': '/get-started/create-a-project', 142 '/guides/config-plugins/': '/config-plugins/introduction/', 143 '/workflow/debugging/': '/debugging/runtime-issue/', 144 '/guides/userinterface/': '/ui-programming/user-interface-libraries/', 145 '/introduction/expo/': '/core-concepts/', 146 '/introduction/why-not-expo/': '/faq/#limitations', 147 '/introduction/faq/': '/faq/', 148 '/next-steps/community/': '/', 149 '/introduction/managed-vs-bare/': '/archive/managed-vs-bare/', 150 '/workflow/expo-go/': '/get-started/expo-go/', 151 '/guides/splash-screens/': '/develop/user-interface/splash-screen/', 152 '/guides/app-icons/': '/develop/user-interface/app-icons/', 153 '/guides/color-schemes/': '/develop/user-interface/color-themes/', 154 '/guides/using-custom-fonts/': '/develop/user-interface/fonts/', 155 '/development/introduction/': '/develop/development-builds/introduction/', 156 '/development/create-development-builds/': '/develop/development-builds/create-a-build/', 157 '/development/use-development-builds/': '/develop/development-builds/use-development-builds/', 158 '/development/development-workflows/': '/develop/development-builds/development-workflows/', 159 '/workflow/expo-cli/': '/more/expo-cli/', 160 '/versions/latest/workflow/expo-cli/': '/more/expo-cli/', 161 '/debugging/': '/debugging/runtime-issue/', 162 '/guides/testing-with-jest/': '/develop/unit-testing/', 163 '/workflow/glossary-of-terms/': '/more/glossary-of-terms/', 164 '/development/installation/': '/develop/development-builds/installation/', 165 '/get-started/errors/': '/debugging/errors-and-warnings/', 166 167 // Old redirects 168 '/introduction/project-lifecycle/': '/introduction/managed-vs-bare/', 169 '/versions/latest/sdk/': '/versions/latest/', 170 '/versions/latest/sdk/overview/': '/versions/latest/', 171 '/guides/building-standalone-apps/': '/archive/classic-updates/building-standalone-apps/', 172 '/distribution/building-standalone-apps/': '/archive/classic-updates/building-standalone-apps/', 173 '/guides/genymotion/': '/workflow/android-studio-emulator/', 174 '/workflow/upgrading-expo/': '/workflow/upgrading-expo-sdk-walkthrough/', 175 '/workflow/create-react-native-app/': '/more/glossary-of-terms/#create-react-native-app', 176 '/expokit/': '/archive/glossary/#expokit/', 177 178 // Development builds redirects 179 '/development/build/': '/development/create-development-builds/', 180 '/development/getting-started/': '/development/create-development-builds/', 181 '/development/troubleshooting/': '/development/introduction/', 182 '/development/upgrading/': '/development/introduction/', 183 '/development/extensions/': '/development/development-workflows/', 184 '/development/develop-your-project': '/development/use-development-builds', 185 186 // Consolidate workflow page 187 '/bare/customizing/': '/workflow/customizing/', 188 189 // Lots of old links pointing to guides when they have moved elsewhere 190 '/guides/configuration/': '/workflow/configuration/', 191 '/guides/expokit/': '/archive/glossary/#expokit/', 192 '/guides/publishing/': '/archive/classic-updates/publishing/', 193 '/workflow/publishing/': '/archive/classic-updates/publishing/', 194 '/guides/linking/': '/workflow/linking/', 195 '/guides/up-and-running/': '/get-started/installation/', 196 '/guides/debugging/': '/workflow/debugging/', 197 '/guides/logging/': '/workflow/logging/', 198 '/introduction/troubleshooting-proxies/': '/guides/troubleshooting-proxies/', 199 '/introduction/running-in-the-browser/': '/guides/running-in-the-browser/', 200 '/guides/using-electron/': 201 'https://dev.to/evanbacon/making-desktop-apps-with-electron-react-native-and-expo-5e36', 202 203 // Changes from redoing the getting started workflow, SDK35+ 204 '/workflow/up-and-running/': '/get-started/installation/', 205 '/introduction/additional-resources/': '/next-steps/additional-resources/', 206 '/introduction/already-used-react-native/': '/workflow/already-used-react-native/', 207 '/introduction/community/': '/next-steps/community/', 208 '/introduction/installation/': '/get-started/installation/', 209 '/versions/latest/overview/': '/versions/latest/', 210 '/versions/latest/introduction/installation/': '/get-started/installation/', 211 '/workflow/exploring-managed-workflow/': '/tutorial/introduction/', 212 '/introduction/walkthrough/': '/tutorial/introduction/', 213 214 // Move overview to index 215 '/versions/v37.0.0/sdk/overview/': '/versions/v37.0.0/', 216 217 // Errors and debugging is better suited for getting started than tutorial 218 '/tutorial/errors/': '/get-started/errors/', 219 220 // Redirects based on Next 9 upgrade (09/11/2020) 221 '/api/': '/versions/latest/', 222 223 // Redirect to expand Expo Accounts and permissions 224 '/guides/account-permissions/': '/accounts/personal/', 225 226 // Redirects based on Sentry reports 227 '/next-steps/installation/': '/get-started/installation/', 228 '/guides/release-channels/': '/archive/classic-updates/release-channels/', 229 '/guides/push-notifications/': '/push-notifications/overview/', 230 '/guides/using-fcm/': '/push-notifications/using-fcm/', 231 '/push-notifications/': '/push-notifications/overview/', 232 '/distribution/hosting-your-app/': '/distribution/publishing-websites/', 233 '/build-reference/how-tos/': '/build-reference/private-npm-packages/', 234 '/get-started/': '/get-started/installation/', 235 '/guides/detach/': '/archive/glossary/#detach', 236 237 // Renaming a submit section 238 '/submit/submit-ios': '/submit/ios/', 239 '/submit/submit-android': '/submit/android/', 240 241 // Fundamentals had too many things 242 '/workflow/linking/': '/guides/linking/', 243 '/workflow/how-expo-works/': '/workflow/already-used-react-native/#how-does-expo-work', 244 '/guides/how-expo-works/': '/workflow/already-used-react-native/#how-does-expo-work', 245 246 // Archive unused pages 247 '/guides/notification-channels/': '/archived/notification-channels/', 248 249 // Migrated FAQ pages 250 '/faq/image-background/': '/ui-programming/image-background/', 251 '/faq/react-native-styling-buttons/': '/ui-programming/react-native-styling-buttons/', 252 '/faq/react-native-version-mismatch/': '/troubleshooting/react-native-version-mismatch/', 253 '/faq/clear-cache-windows/': '/troubleshooting/clear-cache-windows/', 254 '/faq/clear-cache-macos-linux/': '/troubleshooting/clear-cache-macos-linux/', 255 '/faq/application-has-not-been-registered/': 256 '/troubleshooting/application-has-not-been-registered/', 257 258 // Permissions API is moved to guide 259 '/versions/v40.0.0/sdk/permissions/': '/guides/permissions/', 260 '/versions/v41.0.0/sdk/permissions/': '/guides/permissions/', 261 '/versions/v42.0.0/sdk/permissions/': '/guides/permissions/', 262 '/versions/v43.0.0/sdk/permissions/': '/guides/permissions/', 263 '/versions/latest/sdk/permissions/': '/guides/permissions/', 264 265 // Redirect Gatsby guide to index guides page 266 '/guides/using-gatsby/': '/guides/', 267 268 // Classic updates moved to archive 269 '/guides/configuring-ota-updates/': '/archive/classic-updates/getting-started/', 270 '/guides/configuring-updates/': '/archive/classic-updates/getting-started/', 271 '/distribution/release-channels/': '/archive/classic-updates/release-channels/', 272 '/distribution/advanced-release-channels/': '/archive/classic-updates/advanced-release-channels/', 273 '/distribution/optimizing-updates/': '/archive/classic-updates/optimizing-updates/', 274 '/eas-update/custom-updates-server/': '/distribution/custom-updates-server/', 275 '/guides/offline-support/': '/archive/classic-updates/offline-support/', 276 '/guides/preloading-and-caching-assets/': 277 '/archive/classic-updates/preloading-and-caching-assets/', 278 '/eas-update/bare-react-native/': '/bare/updating-your-app/', 279 '/worfkflow/publishing/': '/archive/classic-updates/publishing/', 280 '/classic/building-standalone-apps/': '/archive/classic-updates/building-standalone-apps/', 281 '/classic/turtle-cli/': '/archive/classic-updates/turtle-cli/', 282 '/archive/classic-updates/getting-started/': '/eas-update/getting-started/', 283 284 // Redirect bare guides to unified workflow guides 285 '/bare/using-libraries/': '/workflow/using-libraries/', 286 '/bare/exploring-bare-workflow/': '/bare/hello-world/', 287 '/bare/existing-apps/': '/bare/installing-expo-modules/', 288 '/bare/installing-unimodules/': '/bare/installing-expo-modules/', 289 '/bare/using-web/': '/workflow/web/', 290 '/guides/running-in-the-browser/': '/workflow/web/', 291 '/bare/unimodules-full-list/': '/bare/hello-world/', 292 293 // Consolidate distribution 294 '/distribution/security/': '/app-signing/security/', 295 '/distribution/uploading-apps/': '/submit/introduction/', 296 '/versions/latest/distribution/uploading-apps/': '/submit/introduction/', 297 298 // Deleted or removed guides 299 '/guides/setup-native-firebase/': '/guides/using-firebase/', 300 '/guides/using-clojurescript/': '/guides/', 301 302 // Redirects from old to new tutorial 303 '/tutorial/planning/': '/tutorial/introduction/', 304 '/tutorial/sharing/': '/tutorial/introduction/', 305 '/tutorial/text/': '/tutorial/introduction/', 306 307 // Redirects for removed /archived pages 308 '/archived/': '/archive/', 309 '/versions/latest/expokit/eject/': '/archive/glossary/#eject', 310 '/expokit/eject/': '/archive/glossary/#eject', 311 '/expokit/expokit/': '/archive/glossary/#expokit', 312 '/submit/classic-builds/': '/submit/introduction/', 313 '/archive/adhoc-builds/': '/develop/development-builds/introduction/', 314 315 // Redirects for removed API docs based on Sentry 316 '/versions/latest/sdk/facebook/': '/guides/authentication/', 317 '/versions/latest/sdk/taskmanager/': '/versions/latest/sdk/task-manager/', 318 '/versions/latest/sdk/videothumbnails/': '/versions/latest/sdk/video-thumbnails/', 319 '/versions/latest/sdk/appearance/': '/versions/latest/react-native/appearance/', 320 '/versions/latest/sdk/app-loading/': '/versions/latest/sdk/splash-screen/', 321 '/versions/latest/sdk/app-auth/': '/guides/authentication/', 322 '/versions/latest/sdk/google-sign-in/': '/guides/authentication/', 323 '/versions/latest/sdk/branch/': 324 'https://github.com/expo/config-plugins/tree/main/packages/react-native-branch', 325 '/versions/latest/sdk/appstate/': '/versions/latest/react-native/appstate/', 326 '/versions/latest/sdk/google/': '/guides/authentication/', 327 '/versions/latest/sdk/firebase-core/': '/guides/using-firebase/', 328 '/versions/latest/sdk/firebase-analytics/': '/guides/using-firebase/', 329 '/versions/latest/sdk/firebase-recaptcha/': '/guides/using-firebase/', 330 '/versions/latest/sdk/amplitude/': '/guides/using-analytics/', 331 '/versions/latest/sdk/util/': '/versions/latest/', 332 // Push notifications 333 '/push-notifications/using-fcm/': '/push-notifications/push-notifications-setup', 334 '/config/app/': '/workflow/configuration/', 335 '/versions/latest/sdk/settings/': '/versions/latest/', 336 '/archive/expokit/eject/': '/archive/glossary/#eject', 337 '/versions/latest/sdk/admob/': '/versions/latest/', 338 '/versions/latest/sdk/payments/': '/versions/latest/sdk/stripe/', 339 '/distribution/app-icons/': '/develop/user-interface/app-icons/', 340 '/guides/using-libraries/': '/workflow/using-libraries/', 341 '/tutorial/': '/tutorial/introduction/', 342 // Note (@aman): The following redirect is temporary until Guides section has an overview 343 '/guides/': '/workflow/customizing/', 344}; 345