make route prefixes have a single place where they are defined

apps/dotcom-worker/src/lib/TLDrawDurableObject.ts

@@ -2,7 +2,13 @@
 /// <reference types="@cloudflare/workers-types" />
 
 import { SupabaseClient } from '@supabase/supabase-js'
-import { ROOM_OPEN_MODE, type RoomOpenMode } from '@tldraw/dotcom-shared'
+import {
+	READ_ONLY_LEGACY_PREFIX,
+	READ_ONLY_PREFIX,
+	ROOM_OPEN_MODE,
+	ROOM_PREFIX,
+	type RoomOpenMode,
+} from '@tldraw/dotcom-shared'
 import {
 	DBLoadResultType,
 	RoomSnapshot,
@@ -91,22 +97,22 @@ export class TLDrawDurableObject extends TLServer {
 
 	readonly router = Router()
 		.get(
-			'/r/:roomId',
+			`${ROOM_PREFIX}/:roomId`,
 			(req) => this.extractDocumentInfoFromRequest(req, ROOM_OPEN_MODE.READ_WRITE),
 			(req) => this.onRequest(req)
 		)
 		.get(
-			'/v/:roomId',
+			`${READ_ONLY_LEGACY_PREFIX}/:roomId`,
 			(req) => this.extractDocumentInfoFromRequest(req, ROOM_OPEN_MODE.READ_ONLY_LEGACY),
 			(req) => this.onRequest(req)
 		)
 		.get(
-			'/ro/:roomId',
+			`${READ_ONLY_PREFIX}/:roomId`,
 			(req) => this.extractDocumentInfoFromRequest(req, ROOM_OPEN_MODE.READ_ONLY),
 			(req) => this.onRequest(req)
 		)
 		.post(
-			'/r/:roomId/restore',
+			`${ROOM_PREFIX}/:roomId/restore`,
 			(req) => this.extractDocumentInfoFromRequest(req, ROOM_OPEN_MODE.READ_WRITE),
 			(req) => this.onRestore(req)
 		)

apps/dotcom-worker/src/lib/routes/forwardRoomRequest.ts

@@ -1,3 +1,4 @@
+import { ROOM_PREFIX } from '@tldraw/dotcom-shared'
 import { IRequest } from 'itty-router'
 import { Environment } from '../types'
 import { fourOhFour } from '../utils/fourOhFour'
@@ -11,6 +12,6 @@ export async function forwardRoomRequest(request: IRequest, env: Environment): P
 	if (isRoomIdTooLong(roomId)) return roomIdIsTooLong()
 
 	// Set up the durable object for this room
-	const id = env.TLDR_DOC.idFromName(`/r/${roomId}`)
+	const id = env.TLDR_DOC.idFromName(`${ROOM_PREFIX}/${roomId}`)
 	return env.TLDR_DOC.get(id).fetch(request)
 }

apps/dotcom-worker/src/lib/routes/joinExistingRoom.ts

@@ -1,4 +1,4 @@
-import { RoomOpenMode } from '@tldraw/dotcom-shared'
+import { ROOM_PREFIX, RoomOpenMode } from '@tldraw/dotcom-shared'
 import { IRequest } from 'itty-router'
 import { Environment } from '../types'
 import { fourOhFour } from '../utils/fourOhFour'
@@ -17,7 +17,7 @@ export async function joinExistingRoom(
 	// This needs to be a websocket request!
 	if (request.headers.get('upgrade')?.toLowerCase() === 'websocket') {
 		// Set up the durable object for this room
-		const id = env.TLDR_DOC.idFromName(`/r/${roomId}`)
+		const id = env.TLDR_DOC.idFromName(`${ROOM_PREFIX}/${roomId}`)
 		return env.TLDR_DOC.get(id).fetch(request)
 	}
 

apps/dotcom-worker/src/lib/worker.ts

@@ -1,6 +1,11 @@
 /// <reference no-default-lib="true"/>
 /// <reference types="@cloudflare/workers-types" />
-import { ROOM_OPEN_MODE } from '@tldraw/dotcom-shared'
+import {
+	READ_ONLY_LEGACY_PREFIX,
+	READ_ONLY_PREFIX,
+	ROOM_OPEN_MODE,
+	ROOM_PREFIX,
+} from '@tldraw/dotcom-shared'
 import { Router, createCors } from 'itty-router'
 import { env } from 'process'
 import Toucan from 'toucan-js'
@@ -26,13 +31,19 @@ const router = Router()
 	.post('/new-room', createRoom)
 	.post('/snapshots', createRoomSnapshot)
 	.get('/snapshot/:roomId', getRoomSnapshot)
-	.get('/r/:roomId', (req, env) => joinExistingRoom(req, env, ROOM_OPEN_MODE.READ_WRITE))
+	.get(`${ROOM_PREFIX}/:roomId`, (req, env) =>
-	.get('/v/:roomId', (req, env) => joinExistingRoom(req, env, ROOM_OPEN_MODE.READ_ONLY_LEGACY))
+		joinExistingRoom(req, env, ROOM_OPEN_MODE.READ_WRITE)
-	.get('/ro/:roomId', (req, env) => joinExistingRoom(req, env, ROOM_OPEN_MODE.READ_ONLY))
+	)
-	.get('/r/:roomId/history', getRoomHistory)
+	.get(`${READ_ONLY_LEGACY_PREFIX}/:roomId`, (req, env) =>
-	.get('/r/:roomId/history/:timestamp', getRoomHistorySnapshot)
+		joinExistingRoom(req, env, ROOM_OPEN_MODE.READ_ONLY_LEGACY)
+	)
+	.get(`${READ_ONLY_PREFIX}/:roomId`, (req, env) =>
+		joinExistingRoom(req, env, ROOM_OPEN_MODE.READ_ONLY)
+	)
+	.get(`${ROOM_PREFIX}/:roomId/history`, getRoomHistory)
+	.get(`${ROOM_PREFIX}/:roomId/history/:timestamp`, getRoomHistorySnapshot)
 	.get('/readonly-slug/:roomId', getReadonlySlug)
-	.post('/r/:roomId/restore', forwardRoomRequest)
+	.post(`${ROOM_PREFIX}/:roomId/restore`, forwardRoomRequest)
 	.all('*', fourOhFour)
 
 const Worker = {

apps/dotcom/src/components/BoardHistorySnapshot/BoardHistorySnapshot.tsx

@@ -1,3 +1,4 @@
+import { ROOM_PREFIX } from '@tldraw/dotcom-shared'
 import { RoomSnapshot } from '@tldraw/tlsync'
 import { useCallback, useState } from 'react'
 import { Tldraw, createTLStore, defaultShapeUtils } from 'tldraw'
@@ -31,7 +32,7 @@ export function BoardHistorySnapshot({
 		const sure = window.confirm('Are you sure?')
 		if (!sure) return
 
-		const res = await fetch(`/api/r/${roomId}/restore`, {
+		const res = await fetch(`/api${ROOM_PREFIX}/${roomId}/restore`, {
 			method: 'POST',
 			headers: {
 				'Content-Type': 'application/json',

apps/dotcom/src/components/ShareMenu.tsx

@@ -2,6 +2,7 @@ import * as Popover from '@radix-ui/react-popover'
 import {
 	GetReadonlySlugResponseBody,
 	ROOM_OPEN_MODE,
+	ROOM_PREFIX,
 	RoomOpenModeToPath,
 } from '@tldraw/dotcom-shared'
 import React, { useEffect, useState } from 'react'
@@ -43,7 +44,7 @@ function isSharedReadonlyUrl(pathname: string) {
 }
 
 function isSharedReadWriteUrl(pathname: string) {
-	return pathname.startsWith('/r/')
+	return pathname.startsWith(`${ROOM_PREFIX}/`)
 }
 
 function getFreshShareState(): ShareState {

apps/dotcom/src/pages/history-snapshot.tsx

@@ -1,3 +1,4 @@
+import { ROOM_PREFIX } from '@tldraw/dotcom-shared'
 import { RoomSnapshot } from '@tldraw/tlsync'
 import '../../styles/globals.css'
 import { BoardHistorySnapshot } from '../components/BoardHistorySnapshot/BoardHistorySnapshot'
@@ -11,7 +12,7 @@ const { loader, useData } = defineLoader(async (args) => {
 
 	if (!roomId) return null
 
-	const result = await fetch(`/api/r/${roomId}/history/${timestamp}`, {
+	const result = await fetch(`/api${ROOM_PREFIX}/${roomId}/history/${timestamp}`, {
 		headers: {},
 	})
 	if (!result.ok) return null

apps/dotcom/src/pages/history.tsx

@@ -1,3 +1,4 @@
+import { ROOM_PREFIX } from '@tldraw/dotcom-shared'
 import { BoardHistoryLog } from '../components/BoardHistoryLog/BoardHistoryLog'
 import { ErrorPage } from '../components/ErrorPage/ErrorPage'
 import { IFrameProtector, ROOM_CONTEXT } from '../components/IFrameProtector'
@@ -8,7 +9,7 @@ const { loader, useData } = defineLoader(async (args) => {
 
 	if (!boardId) return null
 
-	const result = await fetch(`/api/r/${boardId}/history`, {
+	const result = await fetch(`/api${ROOM_PREFIX}/${boardId}/history`, {
 		headers: {},
 	})
 	if (!result.ok) return null

apps/dotcom/src/pages/new.tsx

@@ -1,4 +1,4 @@
-import { Snapshot } from '@tldraw/dotcom-shared'
+import { ROOM_PREFIX, Snapshot } from '@tldraw/dotcom-shared'
 import { schema } from '@tldraw/tlsync'
 import { Navigate } from 'react-router-dom'
 import '../../styles/globals.css'
@@ -36,5 +36,5 @@ export function Component() {
 				}}
 			/>
 		)
-	return <Navigate to={`/r/${data.slug}`} />
+	return <Navigate to={`${ROOM_PREFIX}/${data.slug}`} />
 }

apps/dotcom/src/routes.tsx

@@ -1,4 +1,5 @@
 import { captureException } from '@sentry/react'
+import { READ_ONLY_LEGACY_PREFIX, READ_ONLY_PREFIX, ROOM_PREFIX } from '@tldraw/dotcom-shared'
 import { useEffect } from 'react'
 import { createRoutesFromElements, Outlet, Route, useRouteError } from 'react-router-dom'
 import { DefaultErrorFallback } from './components/DefaultErrorFallback/DefaultErrorFallback'
@@ -29,17 +30,20 @@ export const router = createRoutesFromElements(
 	>
 		<Route errorElement={<DefaultErrorFallback />}>
 			<Route path="/" lazy={() => import('./pages/root')} />
-			<Route path="/r" lazy={() => import('./pages/new')} />
+			<Route path={ROOM_PREFIX} lazy={() => import('./pages/new')} />
 			<Route path="/new" lazy={() => import('./pages/new')} />
-			<Route path="/r/:roomId" lazy={() => import('./pages/public-multiplayer')} />
+			<Route path={`${ROOM_PREFIX}/:roomId`} lazy={() => import('./pages/public-multiplayer')} />
-			<Route path="/r/:boardId/history" lazy={() => import('./pages/history')} />
+			<Route path={`${ROOM_PREFIX}/:boardId/history`} lazy={() => import('./pages/history')} />
 			<Route
-				path="/r/:boardId/history/:timestamp"
+				path={`${ROOM_PREFIX}/:boardId/history/:timestamp`}
 				lazy={() => import('./pages/history-snapshot')}
 			/>
 			<Route path="/s/:roomId" lazy={() => import('./pages/public-snapshot')} />
-			<Route path="/v/:roomId" lazy={() => import('./pages/public-readonly-legacy')} />
+			<Route
-			<Route path="/ro/:roomId" lazy={() => import('./pages/public-readonly')} />
+				path={`${READ_ONLY_LEGACY_PREFIX}/:roomId`}
+				lazy={() => import('./pages/public-readonly-legacy')}
+			/>
+			<Route path={`${READ_ONLY_PREFIX}/:roomId`} lazy={() => import('./pages/public-readonly')} />
 		</Route>
 		<Route path="*" lazy={() => import('./pages/not-found')} />
 	</Route>

apps/dotcom/src/utils/sharing.ts

@@ -2,6 +2,7 @@ import {
 	CreateRoomRequestBody,
 	CreateSnapshotRequestBody,
 	CreateSnapshotResponseBody,
+	ROOM_PREFIX,
 	Snapshot,
 } from '@tldraw/dotcom-shared'
 import { useMemo } from 'react'
@@ -132,7 +133,7 @@ export function useSharing(): TLUiOverrides {
 
 							const query = getViewportUrlQuery(editor)
 							const origin = window.location.origin
-							const pathname = `/r/${response.slug}?${new URLSearchParams(query ?? {}).toString()}`
+							const pathname = `${ROOM_PREFIX}/${response.slug}?${new URLSearchParams(query ?? {}).toString()}`
 							if (runningInIFrame) {
 								window.open(`${origin}${pathname}`)
 							} else {

packages/dotcom-shared/src/index.ts

@@ -1,4 +1,11 @@
-export { ROOM_OPEN_MODE, RoomOpenModeToPath, type RoomOpenMode } from './routes'
+export {
+	READ_ONLY_LEGACY_PREFIX,
+	READ_ONLY_PREFIX,
+	ROOM_OPEN_MODE,
+	ROOM_PREFIX,
+	RoomOpenModeToPath,
+	type RoomOpenMode,
+} from './routes'
 export type {
 	CreateRoomRequestBody,
 	CreateSnapshotRequestBody,

packages/dotcom-shared/src/routes.ts

@@ -6,9 +6,16 @@ export const ROOM_OPEN_MODE = {
 } as const
 export type RoomOpenMode = (typeof ROOM_OPEN_MODE)[keyof typeof ROOM_OPEN_MODE]
 
+/** @public */
+export const READ_ONLY_PREFIX = '/ro'
+/** @public */
+export const READ_ONLY_LEGACY_PREFIX = '/v'
+/** @public */
+export const ROOM_PREFIX = '/r'
+
 /** @public */
 export const RoomOpenModeToPath: Record<RoomOpenMode, string> = {
-	[ROOM_OPEN_MODE.READ_ONLY]: 'ro',
+	[ROOM_OPEN_MODE.READ_ONLY]: READ_ONLY_PREFIX,
-	[ROOM_OPEN_MODE.READ_ONLY_LEGACY]: 'v',
+	[ROOM_OPEN_MODE.READ_ONLY_LEGACY]: READ_ONLY_LEGACY_PREFIX,
-	[ROOM_OPEN_MODE.READ_WRITE]: 'r',
+	[ROOM_OPEN_MODE.READ_WRITE]: ROOM_PREFIX,
 }