feat(tanstackstart): Refine initial API (getsentry#15574)

- Adds a config param to the build time wrapping so that TS doesn't
complain when people copy paste a docs snippet.
- Adds `wrapCreateRootRouteWithSentry` which will be used for
server->client tracing because we inject meta tags into the initial SSR
html.

Author: Luca Forstner

packages/tanstackstart/src/common/index.ts

@@ -14,3 +14,10 @@ export function sentryGlobalServerMiddlewareHandler() {
 export function wrapStreamHandlerWithSentry<H>(handler: H): H {
   return handler;
 }
+
+/**
+ * Wraps the create root route function with Sentry for server-client tracing with SSR.
+ */
+export function wrapCreateRootRouteWithSentry<F>(createRootRoute: F): F {
+  return createRootRoute;
+}

packages/tanstackstart/src/config/index.ts

@@ -1,6 +1,16 @@
 /**
  * Wraps a TanStack Start config.
  */
-export function wrapVinxiConfigWithSentry<C>(config: C): C {
+export function wrapVinxiConfigWithSentry<C>(
+  config: C,
+  // TODO: Expand this type in the future. Right now it is just so that TS doesn't complain for our users when they copy paste from the docs.
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  sentryBuildOptions: {
+    org?: string;
+    project?: string;
+    silent?: boolean;
+    authToken?: boolean;
+  } = {},
+): C {
   return config;
 }