@octanejs/tanstack-start 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+Copyright (c) 2026 Dominic Gannaway
+
+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/README.md

@@ -0,0 +1,52 @@
+# @octanejs/tanstack-start
+
+TanStack Start for Octane. This package owns the renderer integration needed
+for file-route generation, route code splitting, server functions, streaming
+SSR, hydration, and Vite development and production builds.
+
+It uses [`@octanejs/tanstack-router`](../tanstack-router) for the public router
+binding and published renderer-neutral TanStack core packages for shared Start
+and Router behavior. The Octane-specific generator, compiler, and Vite adapter
+live inside this package, so installing it does not require private workspace
+packages or preview release artifacts.
+
+## Vite setup
+
+```ts
+import { defineConfig } from 'vite';
+import { tanstackStart } from '@octanejs/tanstack-start/plugin/vite';
+
+export default defineConfig({
+  plugins: [tanstackStart()],
+});
+```
+
+The plugin installs Octane compilation before route analysis, generates TSRX
+file routes with imports from `@octanejs/tanstack-router`, compiles Start's
+environment-specific APIs, and configures the client and SSR Vite environments.
+
+Application code imports Start APIs from this package and router APIs from the
+Octane router binding:
+
+```ts
+import { createServerFn } from '@octanejs/tanstack-start';
+import { createFileRoute } from '@octanejs/tanstack-router';
+```
+
+## Public entries
+
+- `@octanejs/tanstack-start`
+- `@octanejs/tanstack-start/client`
+- `@octanejs/tanstack-start/server`
+- `@octanejs/tanstack-start/plugin/vite`
+- RPC and environment-marker entries used by the Start compiler
+- `@octanejs/tanstack-start/server-entry`
+
+The compiler and generator internals are implementation details and are not
+public package exports.
+
+## Upstream basis
+
+The renderer adapter is derived from TanStack Router pull request #7847 at
+snapshot `753f919e`, with repository-owned fixes for TSRX typing and Octane's
+native streamed HTML injection. See `THIRD_PARTY_NOTICES.md` for attribution.

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,11 @@
+# Third-party notices
+
+The Start compiler, route generator, router plugin, client runtime, and server
+runtime in this package are derived from TanStack Router pull request #7847,
+snapshot `753f919e`, and later Octane-specific fixes maintained in this
+repository. That work is copyright Tanner Linsley and TanStack contributors and
+is used under the MIT License shipped with this package.
+
+The native streaming path is adapted to Octane's `StreamOptions.injection` API
+so streamed router HTML is merged by the renderer rather than by a byte-level
+post-processing transform.

package/package.json

@@ -0,0 +1,149 @@
+{
+  "name": "@octanejs/tanstack-start",
+  "version": "0.1.0",
+  "description": "TanStack Start for Octane, including file-route generation, server functions, SSR streaming, hydration, and Vite integration.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=22"
+  },
+  "octane": {
+    "hookSlots": {
+      "manual": [
+        "src"
+      ]
+    }
+  },
+  "author": {
+    "name": "Dominic Gannaway",
+    "email": "dg@domgan.com"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/octanejs/octane.git",
+    "directory": "packages/tanstack-start"
+  },
+  "main": "src/index.js",
+  "module": "src/index.js",
+  "types": "src/index.d.ts",
+  "files": [
+    "src",
+    "LICENSE",
+    "README.md",
+    "THIRD_PARTY_NOTICES.md"
+  ],
+  "imports": {
+    "#tanstack-start/package-names": "./src/package-names.js",
+    "#tanstack-start/router-generator": "./src/internal/router-generator/index.js",
+    "#tanstack-start/router-generator/*": "./src/internal/router-generator/*.js",
+    "#tanstack-start/router-plugin": "./src/internal/router-plugin/index.js",
+    "#tanstack-start/router-plugin/*": "./src/internal/router-plugin/*.js",
+    "#tanstack-start/plugin-core": "./src/internal/start-plugin-core/index.js",
+    "#tanstack-start/plugin-core/vite": "./src/internal/start-plugin-core/vite/index.js",
+    "#tanstack-start/plugin-core/*": "./src/internal/start-plugin-core/*.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./client": {
+      "types": "./src/client.d.ts",
+      "import": "./src/client.js",
+      "default": "./src/client.js"
+    },
+    "./server": {
+      "types": "./src/server.d.ts",
+      "import": "./src/server.js",
+      "default": "./src/server.js"
+    },
+    "./client-rpc": {
+      "types": "./src/client-rpc.d.ts",
+      "import": "./src/client-rpc.js",
+      "default": "./src/client-rpc.js"
+    },
+    "./server-rpc": {
+      "types": "./src/server-rpc.d.ts",
+      "import": "./src/server-rpc.js",
+      "default": "./src/server-rpc.js"
+    },
+    "./ssr-rpc": {
+      "types": "./src/ssr-rpc.d.ts",
+      "import": "./src/ssr-rpc.js",
+      "default": "./src/ssr-rpc.js"
+    },
+    "./server-only": {
+      "types": "./src/server-only.d.ts",
+      "import": "./src/server-only.js",
+      "default": "./src/server-only.js"
+    },
+    "./client-only": {
+      "types": "./src/client-only.d.ts",
+      "import": "./src/client-only.js",
+      "default": "./src/client-only.js"
+    },
+    "./plugin/vite": {
+      "types": "./src/plugin-vite.d.ts",
+      "import": "./src/plugin-vite.js",
+      "default": "./src/plugin-vite.js"
+    },
+    "./server-entry": {
+      "types": "./src/server-entry.d.ts",
+      "import": "./src/server-entry.js",
+      "default": "./src/server-entry.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@babel/code-frame": "7.27.1",
+    "@babel/core": "7.29.7",
+    "@babel/template": "^7.27.2",
+    "@babel/types": "^7.28.5",
+    "@tanstack/router-core": "1.171.15",
+    "@tanstack/router-utils": "1.162.2",
+    "@tanstack/start-client-core": "1.170.14",
+    "@tanstack/start-server-core": "1.169.17",
+    "@tanstack/virtual-file-routes": "1.162.0",
+    "chokidar": "^5.0.0",
+    "exsolve": "^1.0.7",
+    "jiti": "^2.7.0",
+    "lightningcss": "^1.32.0",
+    "magic-string": "^0.30.21",
+    "pathe": "^2.0.3",
+    "picomatch": "^4.0.3",
+    "prettier": "^3.8.4",
+    "seroval": "^1.5.4",
+    "source-map": "^0.7.6",
+    "srvx": "^0.11.9",
+    "tinyglobby": "^0.2.15",
+    "ufo": "^1.5.4",
+    "unplugin": "^3.0.0",
+    "vitefu": "^1.1.1",
+    "xmlbuilder2": "^4.0.3",
+    "zod": "^4.4.3",
+    "@octanejs/tanstack-router": "0.1.10"
+  },
+  "peerDependencies": {
+    "vite": ">=7.0.0",
+    "octane": "0.1.11"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "vite": "^8.0.16",
+    "vitest": "^4.1.9",
+    "octane": "0.1.11"
+  },
+  "scripts": {
+    "test": "cd ../.. && vitest run --project tanstack-start"
+  }
+}

package/src/client-only.d.ts

@@ -0,0 +1 @@
+export {};

package/src/client-rpc.d.ts

@@ -0,0 +1 @@
+export * from '@tanstack/start-client-core/client-rpc';

package/src/client-rpc.js

@@ -0,0 +1 @@
+export * from '@tanstack/start-client-core/client-rpc';

package/src/client.d.ts

@@ -0,0 +1,3 @@
+export { StartClient } from './runtime/client/StartClient.js';
+export type { StartClientProps } from './runtime/client/StartClient.js';
+export { hydrateStart } from './runtime/client/hydrateStart.js';

package/src/client.js

@@ -0,0 +1,2 @@
+export { StartClient } from './runtime/client/StartClient.js';
+export { hydrateStart } from './runtime/client/hydrateStart.js';

package/src/default-entry/client.js

@@ -0,0 +1,12 @@
+import { hydrateRoot, initializeHydrationEventCapture } from 'octane';
+import { StartClient, hydrateStart } from '../client.js';
+
+initializeHydrationEventCapture();
+
+hydrateStart().then((router) => {
+	const container = document.getElementById('__app');
+	if (!container) {
+		throw new Error('TanStack Start could not find the Octane hydration root.');
+	}
+	hydrateRoot(container, StartClient, { router });
+});

package/src/default-entry/server.js

@@ -0,0 +1,13 @@
+import { createStartHandler, defaultStreamHandler } from '../server.js';
+
+const fetch = createStartHandler(defaultStreamHandler);
+
+export function createServerEntry(entry) {
+	return {
+		async fetch(...args) {
+			return await entry.fetch(...args);
+		},
+	};
+}
+
+export default createServerEntry({ fetch });

package/src/default-entry/start.js

@@ -0,0 +1 @@
+export const startInstance = undefined;

package/src/default-entry-paths.d.ts

@@ -0,0 +1,5 @@
+export declare const octaneStartDefaultEntryPaths: {
+	client: string;
+	server: string;
+	start: string;
+};

package/src/default-entry-paths.js

@@ -0,0 +1,11 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const sourceDirectory = path.dirname(fileURLToPath(import.meta.url));
+const defaultEntryDirectory = path.resolve(sourceDirectory, 'default-entry');
+
+export const octaneStartDefaultEntryPaths = {
+	client: path.resolve(defaultEntryDirectory, 'client.js'),
+	server: path.resolve(defaultEntryDirectory, 'server.js'),
+	start: path.resolve(defaultEntryDirectory, 'start.js'),
+};

package/src/index.d.ts

@@ -0,0 +1,11 @@
+export { useServerFn } from './use-server-fn.js';
+export * from '@tanstack/start-client-core';
+export {
+	createClientOnlyFn,
+	createCsrfMiddleware,
+	createIsomorphicFn,
+	createMiddleware,
+	createServerFn,
+	createServerOnlyFn,
+	createStart,
+} from '@tanstack/start-client-core';

package/src/index.js

@@ -0,0 +1,22 @@
+import { useServerFn } from './use-server-fn.js';
+import {
+	createClientOnlyFn,
+	createCsrfMiddleware,
+	createIsomorphicFn,
+	createMiddleware,
+	createServerFn,
+	createServerOnlyFn,
+	createStart,
+} from '@tanstack/start-client-core';
+
+export * from '@tanstack/start-client-core';
+export {
+	createClientOnlyFn,
+	createCsrfMiddleware,
+	createIsomorphicFn,
+	createMiddleware,
+	createServerFn,
+	createServerOnlyFn,
+	createStart,
+	useServerFn,
+};

package/src/internal/README.md

@@ -0,0 +1,15 @@
+# Start integration internals
+
+These modules are the package-owned Router generator, Router Vite plugin, and
+Start compiler/Vite core used by the Octane adapter. They are derived from the
+TanStack framework-adapter snapshot identified in the package notice, with
+Octane package-name mapping and repository fixes applied.
+
+They are committed as executable ESM because `plugin/vite` must load from a
+published package in plain Node before an application build exists. Internal
+package-import aliases keep the three implementation layers private while
+allowing their original module boundaries to remain reviewable.
+
+When updating the upstream basis, preserve the local package-name helpers,
+TSRX source masking, compiler-before-router plugin order, native streaming
+injection, and focused integration tests.

package/src/internal/router-generator/config.d.ts

@@ -0,0 +1,255 @@
+import { z } from 'zod';
+import { GeneratorPlugin } from './plugin/types.js';
+declare const tokenJsonRegexSchema: z.ZodObject<
+	{
+		regex: z.ZodString;
+		flags: z.ZodOptional<z.ZodString>;
+	},
+	z.core.$strip
+>;
+declare const tokenMatcherSchema: z.ZodUnion<
+	readonly [
+		z.ZodString,
+		z.ZodCustom<RegExp, RegExp>,
+		z.ZodObject<
+			{
+				regex: z.ZodString;
+				flags: z.ZodOptional<z.ZodString>;
+			},
+			z.core.$strip
+		>,
+	]
+>;
+export type TokenMatcherJson = string | z.infer<typeof tokenJsonRegexSchema>;
+export type TokenMatcher = z.infer<typeof tokenMatcherSchema>;
+export declare const routerFrameworks: readonly ['react', 'solid', 'vue', 'octane'];
+export declare const baseConfigSchema: z.ZodObject<
+	{
+		target: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodEnum<{
+					vue: 'vue';
+					react: 'react';
+					solid: 'solid';
+					octane: 'octane';
+				}>
+			>
+		>;
+		virtualRouteConfig: z.ZodOptional<
+			z.ZodUnion<
+				[
+					z.ZodType<
+						import('@tanstack/virtual-file-routes').VirtualRootRoute,
+						unknown,
+						z.core.$ZodTypeInternals<
+							import('@tanstack/virtual-file-routes').VirtualRootRoute,
+							unknown
+						>
+					>,
+					z.ZodString,
+				]
+			>
+		>;
+		routeFilePrefix: z.ZodOptional<z.ZodString>;
+		routeFileIgnorePrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+		routeFileIgnorePattern: z.ZodOptional<z.ZodString>;
+		routesDirectory: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+		quoteStyle: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodEnum<{
+					single: 'single';
+					double: 'double';
+				}>
+			>
+		>;
+		semicolons: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+		disableLogging: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+		routeTreeFileHeader: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+		indexToken: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodUnion<
+					readonly [
+						z.ZodString,
+						z.ZodCustom<RegExp, RegExp>,
+						z.ZodObject<
+							{
+								regex: z.ZodString;
+								flags: z.ZodOptional<z.ZodString>;
+							},
+							z.core.$strip
+						>,
+					]
+				>
+			>
+		>;
+		routeToken: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodUnion<
+					readonly [
+						z.ZodString,
+						z.ZodCustom<RegExp, RegExp>,
+						z.ZodObject<
+							{
+								regex: z.ZodString;
+								flags: z.ZodOptional<z.ZodString>;
+							},
+							z.core.$strip
+						>,
+					]
+				>
+			>
+		>;
+		pathParamsAllowedCharacters: z.ZodOptional<
+			z.ZodArray<
+				z.ZodEnum<{
+					':': ':';
+					$: '$';
+					';': ';';
+					'@': '@';
+					'&': '&';
+					'=': '=';
+					'+': '+';
+					',': ',';
+				}>
+			>
+		>;
+	},
+	z.core.$strip
+>;
+export type BaseConfig = z.infer<typeof baseConfigSchema>;
+export declare const configSchema: z.ZodObject<
+	{
+		target: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodEnum<{
+					vue: 'vue';
+					react: 'react';
+					solid: 'solid';
+					octane: 'octane';
+				}>
+			>
+		>;
+		virtualRouteConfig: z.ZodOptional<
+			z.ZodUnion<
+				[
+					z.ZodType<
+						import('@tanstack/virtual-file-routes').VirtualRootRoute,
+						unknown,
+						z.core.$ZodTypeInternals<
+							import('@tanstack/virtual-file-routes').VirtualRootRoute,
+							unknown
+						>
+					>,
+					z.ZodString,
+				]
+			>
+		>;
+		routeFilePrefix: z.ZodOptional<z.ZodString>;
+		routeFileIgnorePrefix: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+		routeFileIgnorePattern: z.ZodOptional<z.ZodString>;
+		routesDirectory: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+		quoteStyle: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodEnum<{
+					single: 'single';
+					double: 'double';
+				}>
+			>
+		>;
+		semicolons: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+		disableLogging: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+		routeTreeFileHeader: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+		indexToken: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodUnion<
+					readonly [
+						z.ZodString,
+						z.ZodCustom<RegExp, RegExp>,
+						z.ZodObject<
+							{
+								regex: z.ZodString;
+								flags: z.ZodOptional<z.ZodString>;
+							},
+							z.core.$strip
+						>,
+					]
+				>
+			>
+		>;
+		routeToken: z.ZodDefault<
+			z.ZodOptional<
+				z.ZodUnion<
+					readonly [
+						z.ZodString,
+						z.ZodCustom<RegExp, RegExp>,
+						z.ZodObject<
+							{
+								regex: z.ZodString;
+								flags: z.ZodOptional<z.ZodString>;
+							},
+							z.core.$strip
+						>,
+					]
+				>
+			>
+		>;
+		pathParamsAllowedCharacters: z.ZodOptional<
+			z.ZodArray<
+				z.ZodEnum<{
+					':': ':';
+					$: '$';
+					';': ';';
+					'@': '@';
+					'&': '&';
+					'=': '=';
+					'+': '+';
+					',': ',';
+				}>
+			>
+		>;
+		generatedRouteTree: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+		disableTypes: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+		addExtensions: z.ZodPipe<
+			z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>,
+			z.ZodTransform<string | boolean, string | boolean>
+		>;
+		enableRouteTreeFormatting: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+		routeTreeFileFooter: z.ZodOptional<
+			z.ZodUnion<
+				readonly [
+					z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString>>>,
+					z.ZodCustom<() => Array<string>, () => Array<string>>,
+				]
+			>
+		>;
+		autoCodeSplitting: z.ZodOptional<z.ZodBoolean>;
+		customScaffolding: z.ZodOptional<
+			z.ZodObject<
+				{
+					routeTemplate: z.ZodOptional<z.ZodString>;
+					lazyRouteTemplate: z.ZodOptional<z.ZodString>;
+				},
+				z.core.$strip
+			>
+		>;
+		experimental: z.ZodOptional<
+			z.ZodObject<
+				{
+					enableCodeSplitting: z.ZodOptional<z.ZodBoolean>;
+				},
+				z.core.$strip
+			>
+		>;
+		plugins: z.ZodOptional<z.ZodArray<z.ZodCustom<GeneratorPlugin, GeneratorPlugin>>>;
+		tmpDir: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+		importRoutesUsingAbsolutePaths: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+	},
+	z.core.$strip
+>;
+export type Config = z.infer<typeof configSchema>;
+type ResolveParams = {
+	configDirectory: string;
+};
+export declare function resolveConfigPath({ configDirectory }: ResolveParams): string;
+export declare function getConfig(inlineConfig?: Partial<Config>, configDirectory?: string): Config;
+export {};