@tanstack/virtual-file-routes 1.20.3-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/cjs/api.cjs

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function rootRoute(file, children) {
+  return {
+    type: "root",
+    file,
+    children
+  };
+}
+function index(file) {
+  return {
+    type: "index",
+    file
+  };
+}
+function layout(idOrFile, fileOrChildren, children) {
+  if (Array.isArray(fileOrChildren)) {
+    return {
+      type: "layout",
+      file: idOrFile,
+      children: fileOrChildren
+    };
+  } else {
+    return {
+      type: "layout",
+      id: idOrFile,
+      file: fileOrChildren,
+      children
+    };
+  }
+}
+function route(path, fileOrChildren, children) {
+  if (typeof fileOrChildren === "string") {
+    return {
+      type: "route",
+      file: fileOrChildren,
+      path,
+      children
+    };
+  }
+  return {
+    type: "route",
+    path,
+    children: fileOrChildren
+  };
+}
+function physical(pathPrefix, directory) {
+  return {
+    type: "physical",
+    directory,
+    pathPrefix
+  };
+}
+exports.index = index;
+exports.layout = layout;
+exports.physical = physical;
+exports.rootRoute = rootRoute;
+exports.route = route;
+//# sourceMappingURL=api.cjs.map

package/dist/cjs/api.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.cjs","sources":["../../src/api.ts"],"sourcesContent":["import type {\n  IndexRoute,\n  LayoutRoute,\n  PhysicalSubtree,\n  Route,\n  VirtualRootRoute,\n  VirtualRouteNode,\n} from './types'\n\nexport function rootRoute(\n  file: string,\n  children?: Array<VirtualRouteNode>,\n): VirtualRootRoute {\n  return {\n    type: 'root',\n    file,\n    children,\n  }\n}\n\nexport function index(file: string): IndexRoute {\n  return {\n    type: 'index',\n    file,\n  }\n}\n\nexport function layout(\n  file: string,\n  children: Array<VirtualRouteNode>,\n): LayoutRoute\nexport function layout(\n  id: string,\n  file: string,\n  children: Array<VirtualRouteNode>,\n): LayoutRoute\n\nexport function layout(\n  idOrFile: string,\n  fileOrChildren: string | Array<VirtualRouteNode>,\n  children?: Array<VirtualRouteNode>,\n): LayoutRoute {\n  if (Array.isArray(fileOrChildren)) {\n    return {\n      type: 'layout',\n      file: idOrFile,\n      children: fileOrChildren,\n    }\n  } else {\n    return {\n      type: 'layout',\n      id: idOrFile,\n      file: fileOrChildren,\n      children,\n    }\n  }\n}\n\nexport function route(path: string, children: Array<VirtualRouteNode>): Route\nexport function route(path: string, file: string): Route\nexport function route(\n  path: string,\n  file: string,\n  children: Array<VirtualRouteNode>,\n): Route\nexport function route(\n  path: string,\n  fileOrChildren: string | Array<VirtualRouteNode>,\n  children?: Array<VirtualRouteNode>,\n): Route {\n  if (typeof fileOrChildren === 'string') {\n    return {\n      type: 'route',\n      file: fileOrChildren,\n      path,\n      children,\n    }\n  }\n  return {\n    type: 'route',\n    path,\n    children: fileOrChildren,\n  }\n}\n\nexport function physical(\n  pathPrefix: string,\n  directory: string,\n): PhysicalSubtree {\n  return {\n    type: 'physical',\n    directory,\n    pathPrefix,\n  }\n}\n"],"names":[],"mappings":";;AASgB,SAAA,UACd,MACA,UACkB;AACX,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,MAAM,MAA0B;AACvC,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,EACF;AACF;AAYgB,SAAA,OACd,UACA,gBACA,UACa;AACT,MAAA,MAAM,QAAQ,cAAc,GAAG;AAC1B,WAAA;AAAA,MACL,MAAM;AAAA,MACN,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAAA,EAAA,OACK;AACE,WAAA;AAAA,MACL,MAAM;AAAA,MACN,IAAI;AAAA,MACJ,MAAM;AAAA,MACN;AAAA,IACF;AAAA,EAAA;AAEJ;AASgB,SAAA,MACd,MACA,gBACA,UACO;AACH,MAAA,OAAO,mBAAmB,UAAU;AAC/B,WAAA;AAAA,MACL,MAAM;AAAA,MACN,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IACF;AAAA,EAAA;AAEK,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA,UAAU;AAAA,EACZ;AACF;AAEgB,SAAA,SACd,YACA,WACiB;AACV,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACF;AACF;;;;;;"}

package/dist/cjs/api.d.cts

@@ -0,0 +1,9 @@
+import { IndexRoute, LayoutRoute, PhysicalSubtree, Route, VirtualRootRoute, VirtualRouteNode } from './types.cjs';
+export declare function rootRoute(file: string, children?: Array<VirtualRouteNode>): VirtualRootRoute;
+export declare function index(file: string): IndexRoute;
+export declare function layout(file: string, children: Array<VirtualRouteNode>): LayoutRoute;
+export declare function layout(id: string, file: string, children: Array<VirtualRouteNode>): LayoutRoute;
+export declare function route(path: string, children: Array<VirtualRouteNode>): Route;
+export declare function route(path: string, file: string): Route;
+export declare function route(path: string, file: string, children: Array<VirtualRouteNode>): Route;
+export declare function physical(pathPrefix: string, directory: string): PhysicalSubtree;

package/dist/cjs/defineConfig.cjs

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+function defineVirtualSubtreeConfig(config) {
+  return config;
+}
+exports.defineVirtualSubtreeConfig = defineVirtualSubtreeConfig;
+//# sourceMappingURL=defineConfig.cjs.map

package/dist/cjs/defineConfig.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineConfig.cjs","sources":["../../src/defineConfig.ts"],"sourcesContent":["import type { VirtualRouteNode } from './types'\n\n// this is adapted from vite/src/node/config.ts\n\nexport type ConfigFnObject<TConfig> = () => TConfig\nexport type ConfigFnPromise<TConfig> = () => Promise<TConfig>\nexport type ConfigFn<TConfig> = () => TConfig | Promise<TConfig>\n\nexport type ConfigExport<TConfig> =\n  | TConfig\n  | Promise<TConfig>\n  | ConfigFnObject<TConfig>\n  | ConfigFnPromise<TConfig>\n  | ConfigFn<TConfig>\n\nexport type VirtualRouteSubtreeConfig = Array<VirtualRouteNode>\n\n/**\n * Type helper to make it easier to use __virtual.ts\n * accepts a direct {@link VirtualRouteSubtreeConfig} object, or a function that returns it.\n */\nexport function defineVirtualSubtreeConfig(\n  config: VirtualRouteSubtreeConfig,\n): VirtualRouteSubtreeConfig\nexport function defineVirtualSubtreeConfig(\n  config: Promise<VirtualRouteSubtreeConfig>,\n): Promise<VirtualRouteSubtreeConfig>\nexport function defineVirtualSubtreeConfig(\n  config: ConfigFnObject<VirtualRouteSubtreeConfig>,\n): ConfigFnObject<VirtualRouteSubtreeConfig>\nexport function defineVirtualSubtreeConfig(\n  config: ConfigExport<VirtualRouteSubtreeConfig>,\n): ConfigExport<VirtualRouteSubtreeConfig>\nexport function defineVirtualSubtreeConfig(\n  config: ConfigExport<VirtualRouteSubtreeConfig>,\n): ConfigExport<VirtualRouteSubtreeConfig> {\n  return config\n}\n"],"names":[],"mappings":";;AAiCO,SAAS,2BACd,QACyC;AAClC,SAAA;AACT;;"}

package/dist/cjs/defineConfig.d.cts

@@ -0,0 +1,14 @@
+import { VirtualRouteNode } from './types.cjs';
+export type ConfigFnObject<TConfig> = () => TConfig;
+export type ConfigFnPromise<TConfig> = () => Promise<TConfig>;
+export type ConfigFn<TConfig> = () => TConfig | Promise<TConfig>;
+export type ConfigExport<TConfig> = TConfig | Promise<TConfig> | ConfigFnObject<TConfig> | ConfigFnPromise<TConfig> | ConfigFn<TConfig>;
+export type VirtualRouteSubtreeConfig = Array<VirtualRouteNode>;
+/**
+ * Type helper to make it easier to use __virtual.ts
+ * accepts a direct {@link VirtualRouteSubtreeConfig} object, or a function that returns it.
+ */
+export declare function defineVirtualSubtreeConfig(config: VirtualRouteSubtreeConfig): VirtualRouteSubtreeConfig;
+export declare function defineVirtualSubtreeConfig(config: Promise<VirtualRouteSubtreeConfig>): Promise<VirtualRouteSubtreeConfig>;
+export declare function defineVirtualSubtreeConfig(config: ConfigFnObject<VirtualRouteSubtreeConfig>): ConfigFnObject<VirtualRouteSubtreeConfig>;
+export declare function defineVirtualSubtreeConfig(config: ConfigExport<VirtualRouteSubtreeConfig>): ConfigExport<VirtualRouteSubtreeConfig>;

package/dist/cjs/index.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api = require("./api.cjs");
+const defineConfig = require("./defineConfig.cjs");
+exports.index = api.index;
+exports.layout = api.layout;
+exports.physical = api.physical;
+exports.rootRoute = api.rootRoute;
+exports.route = api.route;
+exports.defineVirtualSubtreeConfig = defineConfig.defineVirtualSubtreeConfig;
+//# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/cjs/index.d.cts

@@ -0,0 +1,4 @@
+export { rootRoute, index, route, layout, physical } from './api.cjs';
+export type { LayoutRoute, Route, IndexRoute, PhysicalSubtree, VirtualRootRoute, VirtualRouteNode, } from './types.cjs';
+export { defineVirtualSubtreeConfig } from './defineConfig.cjs';
+export type { ConfigExport, ConfigFn, ConfigFnObject, ConfigFnPromise, VirtualRouteSubtreeConfig, } from './defineConfig.cjs';

package/dist/cjs/types.d.cts

@@ -0,0 +1,27 @@
+export type IndexRoute = {
+    type: 'index';
+    file: string;
+};
+export type LayoutRoute = {
+    type: 'layout';
+    id?: string;
+    file: string;
+    children?: Array<VirtualRouteNode>;
+};
+export type PhysicalSubtree = {
+    type: 'physical';
+    directory: string;
+    pathPrefix: string;
+};
+export type Route = {
+    type: 'route';
+    file?: string;
+    path: string;
+    children?: Array<VirtualRouteNode>;
+};
+export type VirtualRouteNode = IndexRoute | LayoutRoute | Route | PhysicalSubtree;
+export type VirtualRootRoute = {
+    type: 'root';
+    file: string;
+    children?: Array<VirtualRouteNode>;
+};

package/dist/esm/api.d.ts

@@ -0,0 +1,9 @@
+import { IndexRoute, LayoutRoute, PhysicalSubtree, Route, VirtualRootRoute, VirtualRouteNode } from './types.js';
+export declare function rootRoute(file: string, children?: Array<VirtualRouteNode>): VirtualRootRoute;
+export declare function index(file: string): IndexRoute;
+export declare function layout(file: string, children: Array<VirtualRouteNode>): LayoutRoute;
+export declare function layout(id: string, file: string, children: Array<VirtualRouteNode>): LayoutRoute;
+export declare function route(path: string, children: Array<VirtualRouteNode>): Route;
+export declare function route(path: string, file: string): Route;
+export declare function route(path: string, file: string, children: Array<VirtualRouteNode>): Route;
+export declare function physical(pathPrefix: string, directory: string): PhysicalSubtree;

package/dist/esm/api.js

@@ -0,0 +1,59 @@
+function rootRoute(file, children) {
+  return {
+    type: "root",
+    file,
+    children
+  };
+}
+function index(file) {
+  return {
+    type: "index",
+    file
+  };
+}
+function layout(idOrFile, fileOrChildren, children) {
+  if (Array.isArray(fileOrChildren)) {
+    return {
+      type: "layout",
+      file: idOrFile,
+      children: fileOrChildren
+    };
+  } else {
+    return {
+      type: "layout",
+      id: idOrFile,
+      file: fileOrChildren,
+      children
+    };
+  }
+}
+function route(path, fileOrChildren, children) {
+  if (typeof fileOrChildren === "string") {
+    return {
+      type: "route",
+      file: fileOrChildren,
+      path,
+      children
+    };
+  }
+  return {
+    type: "route",
+    path,
+    children: fileOrChildren
+  };
+}
+function physical(pathPrefix, directory) {
+  return {
+    type: "physical",
+    directory,
+    pathPrefix
+  };
+}
+export {
+  index,
+  layout,
+  physical,
+  rootRoute,
+  route
+};
+//# sourceMappingURL=api.js.map

package/dist/esm/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sources":["../../src/api.ts"],"sourcesContent":["import type {\n  IndexRoute,\n  LayoutRoute,\n  PhysicalSubtree,\n  Route,\n  VirtualRootRoute,\n  VirtualRouteNode,\n} from './types'\n\nexport function rootRoute(\n  file: string,\n  children?: Array<VirtualRouteNode>,\n): VirtualRootRoute {\n  return {\n    type: 'root',\n    file,\n    children,\n  }\n}\n\nexport function index(file: string): IndexRoute {\n  return {\n    type: 'index',\n    file,\n  }\n}\n\nexport function layout(\n  file: string,\n  children: Array<VirtualRouteNode>,\n): LayoutRoute\nexport function layout(\n  id: string,\n  file: string,\n  children: Array<VirtualRouteNode>,\n): LayoutRoute\n\nexport function layout(\n  idOrFile: string,\n  fileOrChildren: string | Array<VirtualRouteNode>,\n  children?: Array<VirtualRouteNode>,\n): LayoutRoute {\n  if (Array.isArray(fileOrChildren)) {\n    return {\n      type: 'layout',\n      file: idOrFile,\n      children: fileOrChildren,\n    }\n  } else {\n    return {\n      type: 'layout',\n      id: idOrFile,\n      file: fileOrChildren,\n      children,\n    }\n  }\n}\n\nexport function route(path: string, children: Array<VirtualRouteNode>): Route\nexport function route(path: string, file: string): Route\nexport function route(\n  path: string,\n  file: string,\n  children: Array<VirtualRouteNode>,\n): Route\nexport function route(\n  path: string,\n  fileOrChildren: string | Array<VirtualRouteNode>,\n  children?: Array<VirtualRouteNode>,\n): Route {\n  if (typeof fileOrChildren === 'string') {\n    return {\n      type: 'route',\n      file: fileOrChildren,\n      path,\n      children,\n    }\n  }\n  return {\n    type: 'route',\n    path,\n    children: fileOrChildren,\n  }\n}\n\nexport function physical(\n  pathPrefix: string,\n  directory: string,\n): PhysicalSubtree {\n  return {\n    type: 'physical',\n    directory,\n    pathPrefix,\n  }\n}\n"],"names":[],"mappings":"AASgB,SAAA,UACd,MACA,UACkB;AACX,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACF;AACF;AAEO,SAAS,MAAM,MAA0B;AACvC,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,EACF;AACF;AAYgB,SAAA,OACd,UACA,gBACA,UACa;AACT,MAAA,MAAM,QAAQ,cAAc,GAAG;AAC1B,WAAA;AAAA,MACL,MAAM;AAAA,MACN,MAAM;AAAA,MACN,UAAU;AAAA,IACZ;AAAA,EAAA,OACK;AACE,WAAA;AAAA,MACL,MAAM;AAAA,MACN,IAAI;AAAA,MACJ,MAAM;AAAA,MACN;AAAA,IACF;AAAA,EAAA;AAEJ;AASgB,SAAA,MACd,MACA,gBACA,UACO;AACH,MAAA,OAAO,mBAAmB,UAAU;AAC/B,WAAA;AAAA,MACL,MAAM;AAAA,MACN,MAAM;AAAA,MACN;AAAA,MACA;AAAA,IACF;AAAA,EAAA;AAEK,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA,UAAU;AAAA,EACZ;AACF;AAEgB,SAAA,SACd,YACA,WACiB;AACV,SAAA;AAAA,IACL,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACF;AACF;"}

package/dist/esm/defineConfig.d.ts

@@ -0,0 +1,14 @@
+import { VirtualRouteNode } from './types.js';
+export type ConfigFnObject<TConfig> = () => TConfig;
+export type ConfigFnPromise<TConfig> = () => Promise<TConfig>;
+export type ConfigFn<TConfig> = () => TConfig | Promise<TConfig>;
+export type ConfigExport<TConfig> = TConfig | Promise<TConfig> | ConfigFnObject<TConfig> | ConfigFnPromise<TConfig> | ConfigFn<TConfig>;
+export type VirtualRouteSubtreeConfig = Array<VirtualRouteNode>;
+/**
+ * Type helper to make it easier to use __virtual.ts
+ * accepts a direct {@link VirtualRouteSubtreeConfig} object, or a function that returns it.
+ */
+export declare function defineVirtualSubtreeConfig(config: VirtualRouteSubtreeConfig): VirtualRouteSubtreeConfig;
+export declare function defineVirtualSubtreeConfig(config: Promise<VirtualRouteSubtreeConfig>): Promise<VirtualRouteSubtreeConfig>;
+export declare function defineVirtualSubtreeConfig(config: ConfigFnObject<VirtualRouteSubtreeConfig>): ConfigFnObject<VirtualRouteSubtreeConfig>;
+export declare function defineVirtualSubtreeConfig(config: ConfigExport<VirtualRouteSubtreeConfig>): ConfigExport<VirtualRouteSubtreeConfig>;

package/dist/esm/defineConfig.js

@@ -0,0 +1,7 @@
+function defineVirtualSubtreeConfig(config) {
+  return config;
+}
+export {
+  defineVirtualSubtreeConfig
+};
+//# sourceMappingURL=defineConfig.js.map

package/dist/esm/defineConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineConfig.js","sources":["../../src/defineConfig.ts"],"sourcesContent":["import type { VirtualRouteNode } from './types'\n\n// this is adapted from vite/src/node/config.ts\n\nexport type ConfigFnObject<TConfig> = () => TConfig\nexport type ConfigFnPromise<TConfig> = () => Promise<TConfig>\nexport type ConfigFn<TConfig> = () => TConfig | Promise<TConfig>\n\nexport type ConfigExport<TConfig> =\n  | TConfig\n  | Promise<TConfig>\n  | ConfigFnObject<TConfig>\n  | ConfigFnPromise<TConfig>\n  | ConfigFn<TConfig>\n\nexport type VirtualRouteSubtreeConfig = Array<VirtualRouteNode>\n\n/**\n * Type helper to make it easier to use __virtual.ts\n * accepts a direct {@link VirtualRouteSubtreeConfig} object, or a function that returns it.\n */\nexport function defineVirtualSubtreeConfig(\n  config: VirtualRouteSubtreeConfig,\n): VirtualRouteSubtreeConfig\nexport function defineVirtualSubtreeConfig(\n  config: Promise<VirtualRouteSubtreeConfig>,\n): Promise<VirtualRouteSubtreeConfig>\nexport function defineVirtualSubtreeConfig(\n  config: ConfigFnObject<VirtualRouteSubtreeConfig>,\n): ConfigFnObject<VirtualRouteSubtreeConfig>\nexport function defineVirtualSubtreeConfig(\n  config: ConfigExport<VirtualRouteSubtreeConfig>,\n): ConfigExport<VirtualRouteSubtreeConfig>\nexport function defineVirtualSubtreeConfig(\n  config: ConfigExport<VirtualRouteSubtreeConfig>,\n): ConfigExport<VirtualRouteSubtreeConfig> {\n  return config\n}\n"],"names":[],"mappings":"AAiCO,SAAS,2BACd,QACyC;AAClC,SAAA;AACT;"}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+export { rootRoute, index, route, layout, physical } from './api.js';
+export type { LayoutRoute, Route, IndexRoute, PhysicalSubtree, VirtualRootRoute, VirtualRouteNode, } from './types.js';
+export { defineVirtualSubtreeConfig } from './defineConfig.js';
+export type { ConfigExport, ConfigFn, ConfigFnObject, ConfigFnPromise, VirtualRouteSubtreeConfig, } from './defineConfig.js';

package/dist/esm/index.js

@@ -0,0 +1,11 @@
+import { index, layout, physical, rootRoute, route } from "./api.js";
+import { defineVirtualSubtreeConfig } from "./defineConfig.js";
+export {
+  defineVirtualSubtreeConfig,
+  index,
+  layout,
+  physical,
+  rootRoute,
+  route
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}

package/dist/esm/types.d.ts

@@ -0,0 +1,27 @@
+export type IndexRoute = {
+    type: 'index';
+    file: string;
+};
+export type LayoutRoute = {
+    type: 'layout';
+    id?: string;
+    file: string;
+    children?: Array<VirtualRouteNode>;
+};
+export type PhysicalSubtree = {
+    type: 'physical';
+    directory: string;
+    pathPrefix: string;
+};
+export type Route = {
+    type: 'route';
+    file?: string;
+    path: string;
+    children?: Array<VirtualRouteNode>;
+};
+export type VirtualRouteNode = IndexRoute | LayoutRoute | Route | PhysicalSubtree;
+export type VirtualRootRoute = {
+    type: 'root';
+    file: string;
+    children?: Array<VirtualRouteNode>;
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@tanstack/virtual-file-routes",
+  "version": "1.20.3-alpha.1",
+  "description": "Modern and scalable routing for React applications",
+  "author": "Tanner Linsley",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TanStack/router.git",
+    "directory": "packages/virtual-file-routes"
+  },
+  "homepage": "https://tanstack.com/router",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/tannerlinsley"
+  },
+  "keywords": [
+    "react",
+    "location",
+    "router",
+    "routing",
+    "async",
+    "async router",
+    "typescript"
+  ],
+  "type": "module",
+  "types": "dist/esm/index.d.ts",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.cts",
+        "default": "./dist/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "src"
+  ],
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {}
+}

package/src/api.ts

@@ -0,0 +1,95 @@
+import type {
+  IndexRoute,
+  LayoutRoute,
+  PhysicalSubtree,
+  Route,
+  VirtualRootRoute,
+  VirtualRouteNode,
+} from './types'
+
+export function rootRoute(
+  file: string,
+  children?: Array<VirtualRouteNode>,
+): VirtualRootRoute {
+  return {
+    type: 'root',
+    file,
+    children,
+  }
+}
+
+export function index(file: string): IndexRoute {
+  return {
+    type: 'index',
+    file,
+  }
+}
+
+export function layout(
+  file: string,
+  children: Array<VirtualRouteNode>,
+): LayoutRoute
+export function layout(
+  id: string,
+  file: string,
+  children: Array<VirtualRouteNode>,
+): LayoutRoute
+
+export function layout(
+  idOrFile: string,
+  fileOrChildren: string | Array<VirtualRouteNode>,
+  children?: Array<VirtualRouteNode>,
+): LayoutRoute {
+  if (Array.isArray(fileOrChildren)) {
+    return {
+      type: 'layout',
+      file: idOrFile,
+      children: fileOrChildren,
+    }
+  } else {
+    return {
+      type: 'layout',
+      id: idOrFile,
+      file: fileOrChildren,
+      children,
+    }
+  }
+}
+
+export function route(path: string, children: Array<VirtualRouteNode>): Route
+export function route(path: string, file: string): Route
+export function route(
+  path: string,
+  file: string,
+  children: Array<VirtualRouteNode>,
+): Route
+export function route(
+  path: string,
+  fileOrChildren: string | Array<VirtualRouteNode>,
+  children?: Array<VirtualRouteNode>,
+): Route {
+  if (typeof fileOrChildren === 'string') {
+    return {
+      type: 'route',
+      file: fileOrChildren,
+      path,
+      children,
+    }
+  }
+  return {
+    type: 'route',
+    path,
+    children: fileOrChildren,
+  }
+}
+
+export function physical(
+  pathPrefix: string,
+  directory: string,
+): PhysicalSubtree {
+  return {
+    type: 'physical',
+    directory,
+    pathPrefix,
+  }
+}

package/src/defineConfig.ts

@@ -0,0 +1,38 @@
+import type { VirtualRouteNode } from './types'
+
+// this is adapted from vite/src/node/config.ts
+
+export type ConfigFnObject<TConfig> = () => TConfig
+export type ConfigFnPromise<TConfig> = () => Promise<TConfig>
+export type ConfigFn<TConfig> = () => TConfig | Promise<TConfig>
+
+export type ConfigExport<TConfig> =
+  | TConfig
+  | Promise<TConfig>
+  | ConfigFnObject<TConfig>
+  | ConfigFnPromise<TConfig>
+  | ConfigFn<TConfig>
+
+export type VirtualRouteSubtreeConfig = Array<VirtualRouteNode>
+
+/**
+ * Type helper to make it easier to use __virtual.ts
+ * accepts a direct {@link VirtualRouteSubtreeConfig} object, or a function that returns it.
+ */
+export function defineVirtualSubtreeConfig(
+  config: VirtualRouteSubtreeConfig,
+): VirtualRouteSubtreeConfig
+export function defineVirtualSubtreeConfig(
+  config: Promise<VirtualRouteSubtreeConfig>,
+): Promise<VirtualRouteSubtreeConfig>
+export function defineVirtualSubtreeConfig(
+  config: ConfigFnObject<VirtualRouteSubtreeConfig>,
+): ConfigFnObject<VirtualRouteSubtreeConfig>
+export function defineVirtualSubtreeConfig(
+  config: ConfigExport<VirtualRouteSubtreeConfig>,
+): ConfigExport<VirtualRouteSubtreeConfig>
+export function defineVirtualSubtreeConfig(
+  config: ConfigExport<VirtualRouteSubtreeConfig>,
+): ConfigExport<VirtualRouteSubtreeConfig> {
+  return config
+}

package/src/index.ts

@@ -0,0 +1,18 @@
+export { rootRoute, index, route, layout, physical } from './api'
+export type {
+  LayoutRoute,
+  Route,
+  IndexRoute,
+  PhysicalSubtree,
+  VirtualRootRoute,
+  VirtualRouteNode,
+} from './types'
+
+export { defineVirtualSubtreeConfig } from './defineConfig'
+export type {
+  ConfigExport,
+  ConfigFn,
+  ConfigFnObject,
+  ConfigFnPromise,
+  VirtualRouteSubtreeConfig,
+} from './defineConfig'

package/src/types.ts

@@ -0,0 +1,35 @@
+export type IndexRoute = {
+  type: 'index'
+  file: string
+}
+
+export type LayoutRoute = {
+  type: 'layout'
+  id?: string
+  file: string
+  children?: Array<VirtualRouteNode>
+}
+
+export type PhysicalSubtree = {
+  type: 'physical'
+  directory: string
+  pathPrefix: string
+}
+
+export type Route = {
+  type: 'route'
+  file?: string
+  path: string
+  children?: Array<VirtualRouteNode>
+}
+export type VirtualRouteNode =
+  | IndexRoute
+  | LayoutRoute
+  | Route
+  | PhysicalSubtree
+
+export type VirtualRootRoute = {
+  type: 'root'
+  file: string
+  children?: Array<VirtualRouteNode>
+}