one 1.1.5 → 1.1.269

package/src/getRoutes.ts

@@ -0,0 +1,640 @@
+import { getDefaultRenderMode } from './config'
+import {
+  matchArrayGroupName,
+  matchDeepDynamicRouteName,
+  matchDynamicName,
+  matchGroupName,
+  removeSupportedExtensions,
+} from './matchers'
+import type { DynamicConvention, RouteNode } from './Route'
+import { getPageExport } from './utils/getPageExport'
+import { requireResolve } from './utils/requireResolve'
+import type { One } from './vite/types'
+// import { Unmatched } from './views/Unmatched'
+
+export type Options = {
+  ignore?: RegExp[]
+  preserveApiRoutes?: boolean
+  ignoreRequireErrors?: boolean
+  ignoreEntryPoints?: boolean
+  /* Used to simplify testing for toEqual() comparison */
+  internal_stripLoadRoute?: boolean
+  /* Used to simplify by skipping the generated routes */
+  skipGenerated?: boolean
+  importMode?: 'sync'
+  platformRoutes?: boolean
+  platform?: string
+}
+
+type DirectoryNode = {
+  layout?: RouteNode[]
+  files: Map<string, RouteNode[]>
+  subdirectories: Map<string, DirectoryNode>
+}
+
+const validPlatforms = new Set(['android', 'ios', 'native', 'web'])
+
+/**
+ * Given a Metro context module, return an array of nested routes.
+ *
+ * This is a two step process:
+ *  1. Convert the RequireContext keys (file paths) into a directory tree.
+ *      - This should extrapolate array syntax into multiple routes
+ *      - Routes are given a specificity score
+ *  2. Flatten the directory tree into routes
+ *      - Routes in directories without _layout files are hoisted to the nearest _layout
+ *      - The name of the route is relative to the nearest _layout
+ *      - If multiple routes have the same name, the most specific route is used
+ */
+export function getRoutes(
+  contextModule: One.RouteContext,
+  options: Options = {}
+): RouteNode | null {
+  const directoryTree = getDirectoryTree(contextModule, options)
+
+  // If there are no routes
+  if (!directoryTree) {
+    return null
+  }
+
+  const rootNode = flattenDirectoryTreeToRoutes(directoryTree, options)
+
+  if (!options.ignoreEntryPoints) {
+    crawlAndAppendInitialRoutesAndEntryFiles(rootNode, options)
+  }
+
+  return rootNode
+}
+
+export function getExactRoutes(
+  contextModule: One.RouteContext,
+  options: Options = {}
+): RouteNode | null {
+  return getRoutes(contextModule, {
+    ...options,
+    skipGenerated: true,
+  })
+}
+
+/**
+ * Converts the One.RouteContext keys (file paths) into a directory tree.
+ */
+function getDirectoryTree(contextModule: One.RouteContext, options: Options) {
+  const importMode = options.importMode || process.env.One_ROUTER_IMPORT_MODE
+
+  const ignoreList: RegExp[] = [/^\.\/\+html\.[tj]sx?$/] // Ignore the top level ./+html file
+
+  if (options.ignore) {
+    ignoreList.push(...options.ignore)
+  }
+  if (!options.preserveApiRoutes) {
+    ignoreList.push(/\+api\.[tj]sx?$/)
+  }
+
+  const rootDirectory: DirectoryNode = {
+    files: new Map(),
+    subdirectories: new Map(),
+  }
+
+  let hasRoutes = false
+  let isValid = false
+
+  for (const filePath of contextModule.keys()) {
+    if (ignoreList.some((regex) => regex.test(filePath))) {
+      continue
+    }
+
+    isValid = true
+
+    const meta = getFileMeta(filePath, options)
+
+    // This is a file that should be ignored. e.g maybe it has an invalid platform?
+    if (meta.specificity < 0) {
+      continue
+    }
+
+    const type = meta.isLayout ? 'layout' : meta.renderMode || getDefaultRenderMode()
+
+    let node: RouteNode = {
+      type,
+
+      loadRoute() {
+        if (options.ignoreRequireErrors) {
+          try {
+            return contextModule(filePath)
+          } catch {
+            return {}
+          }
+        } else {
+          return contextModule(filePath)
+        }
+      },
+      contextKey: filePath,
+      route: '', // This is overwritten during hoisting based upon the _layout
+      dynamic: null,
+      children: [], // While we are building the directory tree, we don't know the node's children just yet. This is added during hoisting
+    }
+
+    if (process.env.NODE_ENV === 'development') {
+      // If the user has set the `One_ROUTER_IMPORT_MODE` to `sync` then we should
+      // filter the missing routes.
+      if (node.type !== 'api' && importMode === 'sync') {
+        if (!getPageExport(node.loadRoute())) {
+          continue
+        }
+      }
+    }
+
+    /**
+     * A single filepath may be extrapolated into multiple routes if it contains array syntax.
+     * Another way to thinking about is that a filepath node is present in multiple leaves of the directory tree.
+     */
+    for (const route of extrapolateGroups(meta.route)) {
+      // Traverse the directory tree to its leaf node, creating any missing directories along the way
+      const subdirectoryParts = route.split('/').slice(0, -1)
+
+      // Start at the root directory and traverse the path to the leaf directory
+      let directory = rootDirectory
+
+      for (const part of subdirectoryParts) {
+        let subDirectory = directory.subdirectories.get(part)
+
+        // Create any missing subdirectories
+        if (!subDirectory) {
+          subDirectory = {
+            files: new Map(),
+            subdirectories: new Map(),
+          }
+          directory.subdirectories.set(part, subDirectory)
+        }
+
+        directory = subDirectory
+      }
+
+      // Clone the node for this route
+      node = { ...node, route }
+
+      if (meta.isLayout) {
+        directory.layout ??= []
+        const existing = directory.layout[meta.specificity]
+        if (existing) {
+          // In production, use the first route found
+          if (process.env.NODE_ENV !== 'production') {
+            throw new Error(
+              `The layouts "${filePath}" and "${existing.contextKey}" conflict on the route "/${route}". Please remove or rename one of these files.`
+            )
+          }
+        } else {
+          node = getLayoutNode(node, options)
+          directory.layout[meta.specificity] = node
+        }
+      } else if (type === 'api') {
+        const fileKey = `${route}+api`
+        let nodes = directory.files.get(fileKey)
+
+        if (!nodes) {
+          nodes = []
+          directory.files.set(fileKey, nodes)
+        }
+
+        // API Routes have no specificity, they are always the first node
+        const existing = nodes[0]
+
+        if (existing) {
+          // In production, use the first route found
+          if (process.env.NODE_ENV !== 'production') {
+            throw new Error(
+              `The API route file "${filePath}" and "${existing.contextKey}" conflict on the route "/${route}". Please remove or rename one of these files.`
+            )
+          }
+        } else {
+          nodes[0] = node
+        }
+      } else {
+        let nodes = directory.files.get(route)
+
+        if (!nodes) {
+          nodes = []
+          directory.files.set(route, nodes)
+        }
+
+        /**
+         * If there is an existing node with the same specificity, then we have a conflict.
+         * NOTE(Platform Routes):
+         *    We cannot check for specificity conflicts here, as we haven't processed all the context keys yet!
+         *    This will be checked during hoisting, as well as enforcing that all routes have a non-platform route.
+         */
+        const existing = nodes[meta.specificity]
+        if (existing) {
+          // In production, use the first route found
+          if (process.env.NODE_ENV !== 'production') {
+            throw new Error(
+              `The route files "${filePath}" and "${existing.contextKey}" conflict on the route "/${route}". Please remove or rename one of these files.`
+            )
+          }
+        } else {
+          hasRoutes ||= true
+          nodes[meta.specificity] = node
+        }
+      }
+    }
+  }
+
+  // If there are no routes/layouts then we should display the tutorial.
+  if (!isValid) {
+    return null
+  }
+
+  /**
+   * If there are no top-level _layout, add a default _layout
+   * While this is a generated route, it will still be generated even if skipGenerated is true.
+   */
+  if (!rootDirectory.layout) {
+    rootDirectory.layout = [
+      {
+        type: 'layout',
+        loadRoute: () => ({
+          default: (require('./views/Navigator') as typeof import('./views/Navigator'))
+            .DefaultNavigator,
+        }),
+        // Generate a fake file name for the directory
+        contextKey: 'router/build/views/Navigator.js',
+        route: '',
+        generated: true,
+        dynamic: null,
+        children: [],
+      },
+    ]
+  }
+
+  // Only include the sitemap if there are routes.
+  if (!options.skipGenerated) {
+    if (hasRoutes) {
+      appendSitemapRoute(rootDirectory)
+    }
+    appendNotFoundRoute(rootDirectory)
+  }
+  return rootDirectory
+}
+
+/**
+ * Flatten the directory tree into routes, hoisting routes to the nearest _layout.
+ */
+function flattenDirectoryTreeToRoutes(
+  directory: DirectoryNode,
+  options: Options,
+  /* The nearest _layout file in the directory tree */
+  layout?: RouteNode,
+  /* Route names are relative to their layout */
+  pathToRemove = ''
+) {
+  /**
+   * This directory has a _layout file so it becomes the new target for hoisting routes.
+   */
+  if (directory.layout) {
+    const previousLayout = layout
+    layout = getMostSpecific(directory.layout)
+
+    // Add the new layout as a child of its parent
+    if (previousLayout) {
+      previousLayout.children.push(layout)
+    }
+
+    if (options.internal_stripLoadRoute) {
+      delete (layout as any).loadRoute
+    }
+
+    // `route` is the absolute pathname. We need to make this relative to the last _layout
+    const newRoute = layout.route.replace(pathToRemove, '')
+    pathToRemove = layout.route ? `${layout.route}/` : ''
+
+    // Now update this layout with the new relative route and dynamic conventions
+    layout.route = newRoute
+    layout.dynamic = generateDynamic(layout.route)
+  }
+
+  // This should never occur as there will always be a root layout, but it makes the type system happy
+  if (!layout) throw new Error('One Internal Error: No nearest layout')
+
+  for (const routes of directory.files.values()) {
+    // TODO(Platform Routes): We need to pick the most specific layout and ensure that all routes have a non-platform route.
+    const routeNode = getMostSpecific(routes)
+
+    // `route` is the absolute pathname. We need to make this relative to the nearest layout
+    routeNode.route = routeNode.route.replace(pathToRemove, '')
+    routeNode.dynamic = generateDynamic(routeNode.route)
+
+    if (options.internal_stripLoadRoute) {
+      delete (routeNode as any).loadRoute
+    }
+
+    layout.children.push(routeNode)
+  }
+
+  // Recursively flatten the subdirectories
+  for (const child of directory.subdirectories.values()) {
+    flattenDirectoryTreeToRoutes(child, options, layout, pathToRemove)
+  }
+
+  return layout
+}
+
+function getFileMeta(key: string, options: Options) {
+  // Remove the leading `./`
+  key = key.replace(/^\.\//, '')
+
+  const parts = key.split('/')
+  let route = removeSupportedExtensions(key)
+  const filename = parts[parts.length - 1]
+  const filenameWithoutExtensions = removeSupportedExtensions(filename)
+
+  const isLayout = filenameWithoutExtensions.startsWith('_layout')
+
+  const [_fullname, renderModeFound] = filename.match(/\+(api|ssg|ssr|spa)\.(\w+\.)?[jt]sx?$/) || []
+  const renderMode = renderModeFound as 'api' | One.RouteRenderMode | undefined
+
+  if (filenameWithoutExtensions.startsWith('(') && filenameWithoutExtensions.endsWith(')')) {
+    throw new Error(`Invalid route ./${key}. Routes cannot end with '(group)' syntax`)
+  }
+
+  // Nested routes cannot start with the '+' character, except for the '+not-found' route
+  if (
+    renderMode !== 'api' &&
+    filename.startsWith('+') &&
+    filenameWithoutExtensions !== '+not-found'
+  ) {
+    const renamedRoute = [...parts.slice(0, -1), filename.slice(1)].join('/')
+    throw new Error(
+      `Invalid route ./${key}. Route nodes cannot start with the '+' character. "Please rename to ${renamedRoute}"`
+    )
+  }
+
+  let specificity = 0
+
+  const platformExtension = filenameWithoutExtensions.split('.')[1]
+  const hasPlatformExtension = validPlatforms.has(platformExtension)
+  const usePlatformRoutes = options.platformRoutes ?? true
+
+  if (hasPlatformExtension) {
+    if (!usePlatformRoutes) {
+      // If the user has disabled platform routes, then we should ignore this file
+      specificity = -1
+    } else if (!options.platform) {
+      // If we don't have a platform, then we should ignore this file
+      // This used by typed routes, sitemap, etc
+      specificity = -1
+    } else if (platformExtension === options.platform) {
+      // If the platform extension is the same as the options.platform, then it is the most specific
+      specificity = 2
+    } else if (platformExtension === 'native' && options.platform !== 'web') {
+      // `native` is allow but isn't as specific as the platform
+      specificity = 1
+    } else if (platformExtension !== options.platform) {
+      // Somehow we have a platform extension that doesn't match the options.platform and it isn't native
+      // This is an invalid file and we will ignore it
+      specificity = -1
+    }
+
+    if (renderMode === 'api' && specificity !== 0) {
+      throw new Error(
+        `Api routes cannot have platform extensions. Please remove '.${platformExtension}' from './${key}'`
+      )
+    }
+
+    route = route.replace(new RegExp(`.${platformExtension}$`), '')
+  }
+
+  return {
+    route,
+    specificity,
+    isLayout,
+    renderMode,
+  }
+}
+
+function getMostSpecific(routes: RouteNode[]) {
+  const route = routes[routes.length - 1]
+
+  if (!routes[0]) {
+    throw new Error(
+      ` [one] The file ${route.contextKey} does not have a fallback sibling file without a platform extension in routes (${routes[0]}, ${routes.length}):\n${routes.map((r) => r.contextKey || 'NONE').join('\n')}.`
+    )
+  }
+
+  // This works even tho routes is holey array (e.g it might have index 0 and 2 but not 1)
+  // `.length` includes the holes in its count
+  return routes[routes.length - 1]
+}
+
+export function getIgnoreList(options?: Options) {
+  const ignore: RegExp[] = [/^\.\/\+html\.[tj]sx?$/, ...(options?.ignore ?? [])]
+  if (options?.preserveApiRoutes !== true) {
+    ignore.push(/\+api\.[tj]sx?$/)
+  }
+  return ignore
+}
+
+/**
+ * Generates a set of strings which have the router array syntax extrapolated.
+ *
+ * /(a,b)/(c,d)/e.tsx => new Set(['a/c/e.tsx', 'a/d/e.tsx', 'b/c/e.tsx', 'b/d/e.tsx'])
+ */
+export function extrapolateGroups(key: string, keys: Set<string> = new Set()): Set<string> {
+  const match = matchArrayGroupName(key)
+
+  if (!match) {
+    keys.add(key)
+    return keys
+  }
+  const groups = match.split(',')
+  const groupsSet = new Set(groups)
+
+  if (groupsSet.size !== groups.length) {
+    throw new Error(`Array syntax cannot contain duplicate group name "${groups}" in "${key}".`)
+  }
+
+  if (groups.length === 1) {
+    keys.add(key)
+    return keys
+  }
+
+  for (const group of groups) {
+    extrapolateGroups(key.replace(match, group.trim()), keys)
+  }
+
+  return keys
+}
+
+export function generateDynamic(path: string): DynamicConvention[] | null {
+  const dynamic = path
+    .split('/')
+    .map((part): DynamicConvention | null => {
+      if (part === '+not-found') {
+        return {
+          name: '+not-found',
+          deep: true,
+          notFound: true,
+        }
+      }
+
+      const deepDynamicName = matchDeepDynamicRouteName(part)
+      const dynamicName = deepDynamicName ?? matchDynamicName(part)
+
+      if (!dynamicName) return null
+      return { name: dynamicName, deep: !!deepDynamicName }
+    })
+    .filter((part): part is DynamicConvention => !!part)
+
+  return dynamic.length === 0 ? null : dynamic
+}
+
+// const resolve = (path) => new URL(path, import.meta.url).pathname
+
+function appendSitemapRoute(directory: DirectoryNode) {
+  if (!directory.files.has('_sitemap')) {
+    directory.files.set('_sitemap', [
+      {
+        loadRoute() {
+          // console.warn(`Loading sitemap`)
+          // const { Sitemap, getNavOptions } = require('./views/Sitemap')
+          // return { default: Sitemap, getNavOptions }
+          return { default: () => null, getNavOptions: () => {} }
+        },
+        route: '_sitemap',
+        type: 'ssg',
+        contextKey: '',
+        generated: true,
+        internal: true,
+        dynamic: null,
+        children: [],
+      },
+    ])
+  }
+}
+
+function appendNotFoundRoute(directory: DirectoryNode) {
+  if (!directory.files.has('+not-found')) {
+    directory.files.set('+not-found', [
+      {
+        loadRoute() {
+          console.warn(`Loading not found`)
+          return { default: () => null }
+        },
+        type: 'spa',
+        route: '+not-found',
+        contextKey: '',
+        generated: true,
+        internal: true,
+        dynamic: [{ name: '+not-found', deep: true, notFound: true }],
+        children: [],
+      },
+    ])
+  }
+}
+
+function getLayoutNode(node: RouteNode, options: Options) {
+  /**
+   * A file called `(a,b)/(c)/_layout.tsx` will generate two _layout routes: `(a)/(c)/_layout` and `(b)/(c)/_layout`.
+   * Each of these layouts will have a different initialRouteName based upon the first group name.
+   *
+   * So
+   */
+
+  // We may strip loadRoute during testing
+  const groupName = matchGroupName(node.route)
+  const childMatchingGroup = node.children.find((child) => {
+    return child.route.replace(/\/index$/, '') === groupName
+  })
+  let initialRouteName = childMatchingGroup?.route
+  // const loaded = node.loadRoute()
+  // if (loaded?.unstable_settings) {
+  //   // Allow unstable_settings={ initialRouteName: '...' } to override the default initial route name.
+  //   initialRouteName = loaded.unstable_settings.initialRouteName ?? initialRouteName
+
+  //   if (groupName) {
+  //     // Allow unstable_settings={ 'custom': { initialRouteName: '...' } } to override the less specific initial route name.
+  //     const groupSpecificInitialRouteName = loaded.unstable_settings?.[groupName]?.initialRouteName
+
+  //     initialRouteName = groupSpecificInitialRouteName ?? initialRouteName
+  //   }
+  // }
+
+  return {
+    ...node,
+    route: node.route.replace(/\/?_layout$/, ''),
+    children: [], // Each layout should have its own children
+    initialRouteName,
+  }
+}
+
+function crawlAndAppendInitialRoutesAndEntryFiles(
+  node: RouteNode,
+  options: Options,
+  entryPoints: string[] = []
+) {
+  if (node.type === 'spa' || node.type === 'ssg' || node.type === 'ssr') {
+    node.entryPoints = [...new Set([...entryPoints, node.contextKey])]
+  } else if (node.type === 'layout') {
+    if (!node.children) {
+      throw new Error(`Layout "${node.contextKey}" does not contain any child routes`)
+    }
+
+    // Every node below this layout will have it as an entryPoint
+    entryPoints = [...entryPoints, node.contextKey]
+
+    /**
+     * Calculate the initialRouteNode
+     *
+     * A file called `(a,b)/(c)/_layout.tsx` will generate two _layout routes: `(a)/(c)/_layout` and `(b)/(c)/_layout`.
+     * Each of these layouts will have a different initialRouteName based upon the first group.
+     */
+    const groupName = matchGroupName(node.route)
+    const childMatchingGroup = node.children.find((child) => {
+      return child.route.replace(/\/index$/, '') === groupName
+    })
+    let initialRouteName = childMatchingGroup?.route
+    // We may strip loadRoute during testing
+    if (!options.internal_stripLoadRoute) {
+      const loaded = node.loadRoute()
+      if (loaded?.unstable_settings) {
+        // Allow unstable_settings={ initialRouteName: '...' } to override the default initial route name.
+        initialRouteName = loaded.unstable_settings.initialRouteName ?? initialRouteName
+
+        if (groupName) {
+          // Allow unstable_settings={ 'custom': { initialRouteName: '...' } } to override the less specific initial route name.
+          const groupSpecificInitialRouteName =
+            loaded.unstable_settings?.[groupName]?.initialRouteName
+
+          initialRouteName = groupSpecificInitialRouteName ?? initialRouteName
+        }
+      }
+    }
+
+    if (initialRouteName) {
+      const initialRoute = node.children.find((child) => child.route === initialRouteName)
+      if (!initialRoute) {
+        const validInitialRoutes = node.children
+          .filter((child) => !child.generated)
+          .map((child) => `'${child.route}'`)
+          .join(', ')
+
+        if (groupName) {
+          throw new Error(
+            `Layout ${node.contextKey} has invalid initialRouteName '${initialRouteName}' for group '(${groupName})'. Valid options are: ${validInitialRoutes}`
+          )
+        }
+        throw new Error(
+          `Layout ${node.contextKey} has invalid initialRouteName '${initialRouteName}'. Valid options are: ${validInitialRoutes}`
+        )
+      }
+
+      // Navigators can add initialsRoutes into the history, so they need to be to be included in the entryPoints
+      node.initialRouteName = initialRouteName
+      entryPoints.push(initialRoute.contextKey)
+    }
+
+    for (const child of node.children) {
+      crawlAndAppendInitialRoutesAndEntryFiles(child, options, entryPoints)
+    }
+  }
+}

package/src/getURL.native.ts

@@ -0,0 +1,24 @@
+import getDevServer from 'react-native/Libraries/Core/Devtools/getDevServer'
+
+export function getURL() {
+  let url = process.env.ONE_SERVER_URL
+
+  if (__DEV__) {
+    // We'll be using the development server in development mode, but we still need to warn the user to set SERVER_URL for things to work in production.
+    if (!url) {
+      console.warn(
+        `The ONE_SERVER_URL environment variable is not set. While things will work in development mode as we'll be using your development server, you should still set ONE_SERVER_URL in your .env file for your production builds to work.`
+      )
+    }
+
+    const { url: devServerUrl } = getDevServer() as { url: string }
+    url = devServerUrl
+  }
+
+  if (!url) {
+    // Provide a dummy URL so things won't crash.
+    url = 'http://one-server.example.com'
+  }
+
+  return url.replace(/\/+$/, '') // remove trailing slash for consistency with web
+}

package/src/getURL.ts

@@ -0,0 +1,5 @@
+import { CLIENT_BASE_URL } from './router/constants'
+
+export function getURL() {
+  return process.env.ONE_SERVER_URL ?? CLIENT_BASE_URL
+}

package/src/head/Head.android.tsx

@@ -0,0 +1,8 @@
+import type { PropsWithChildren } from 'react'
+import { HeadModule } from './HeadModule'
+import type { HeadType } from './types'
+
+// @ts-ignore
+export const Head: HeadType = (props: PropsWithChildren) => null
+
+Object.assign(Head, HeadModule)