Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat(tanstackstart): Add `@sentry/tanstackstart-react` package and make `@sentry/tanstackstart` package a utility package by lforst · Pull Request #15629 · getsentry/sentry-javascript · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .craft.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,9 @@ targets:
- name: npm
id: '@sentry/tanstackstart'
includeNames: /^sentry-tanstackstart-\d.*\.tgz$/
- name: npm
id: '@sentry/tanstackstart-react'
includeNames: /^sentry-tanstackstart-react-\d.*\.tgz$/
- name: npm
id: '@sentry/gatsby'
includeNames: /^sentry-gatsby-\d.*\.tgz$/
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ body:
- '@sentry/solidstart'
- '@sentry/svelte'
- '@sentry/sveltekit'
- '@sentry/tanstackstart-react'
- '@sentry/vue'
- '@sentry/wasm'
- Sentry Browser Loader
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,6 +60,7 @@ package. Please refer to the README and instructions of those SDKs for more deta
- [`@sentry/nestjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nestjs): SDK for NestJS
- [`@sentry/nextjs`](https://github.com/getsentry/sentry-javascript/tree/master/packages/nextjs): SDK for Next.js
- [`@sentry/remix`](https://github.com/getsentry/sentry-javascript/tree/master/packages/remix): SDK for Remix
- [`@sentry/tanstackstart-react`](https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react): SDK for TanStack Start React
- [`@sentry/aws-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/aws-serverless): SDK
for AWS Lambda Functions
- [`@sentry/google-cloud-serverless`](https://github.com/getsentry/sentry-javascript/tree/master/packages/google-cloud-serverless):
Expand Down
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/verdaccio-config/config.yaml
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,12 @@ packages:
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/tanstackstart-react':
access: $all
publish: $all
unpublish: $all
# proxy: npmjs # Don't proxy for E2E tests!

'@sentry/types':
access: $all
publish: $all
Expand Down
6 changes: 6 additions & 0 deletions docs/new-sdk-release-checklist.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,12 @@ differ slightly for other SDKs depending on how they are structured and how they
- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that
your package is added to the integration test apps' `"resolutions"` field in their `package.json`s.

- [ ] Add the new package to the "root" README inside the repository.

- [ ] Add the new package to the GitHub Issue bug template.

- [ ] Create label inside the GitHub repo named "Package: foobar".

## Cutting the Release

When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@
"packages/svelte",
"packages/sveltekit",
"packages/tanstackstart",
"packages/tanstackstart-react",
"packages/types",
"packages/typescript",
"packages/vercel-edge",
Expand Down
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/.eslintrc.js
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
module.exports = {
env: {
browser: true,
node: true,
},
parserOptions: {
jsx: true,
},
extends: ['../../.eslintrc.js'],
};
21 changes: 21 additions & 0 deletions packages/tanstackstart-react/LICENSE
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 Functional Software, Inc. dba Sentry

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.
52 changes: 52 additions & 0 deletions packages/tanstackstart-react/README.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
<p align="center">
<a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
<img src="https://sentry-brand.storage.googleapis.com/sentry-wordmark-dark-280x84.png" alt="Sentry" width="280" height="84">
</a>
</p>

# Official Sentry SDK for TanStack Start React (Alpha)

[![npm version](https://img.shields.io/npm/v/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dm](https://img.shields.io/npm/dm/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)
[![npm dt](https://img.shields.io/npm/dt/@sentry/tanstackstart-react.svg)](https://www.npmjs.com/package/@sentry/tanstackstart-react)

> NOTICE: This package is in alpha state and may be subject to breaking changes.

## Getting Started

This SDK does not have docs yet. Stay tuned.

## Compatibility

The minimum supported version of TanStack Start is `1.111.12`.

## Custom Usage

To set context information or to send manual events, you can use `@sentry/tanstackstart-react` as follows:

```ts
import * as Sentry from '@sentry/tanstackstart-react';

// Set user information, as well as tags and further extras
Sentry.setTag('user_mode', 'admin');
Sentry.setUser({ id: '4711' });
Sentry.setContext('application_area', { location: 'checkout' });

// Add a breadcrumb for future events
Sentry.addBreadcrumb({
message: '"Add to cart" clicked',
// ...
});

// Capture exceptions or messages
Sentry.captureException(new Error('Oh no.'));
Sentry.captureMessage('Hello, world!');
```

## Links

<!-- - [Official SDK Docs](https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/) -->

- [Sentry.io](https://sentry.io/?utm_source=github&utm_medium=npm_tanstackstartreact)
- [Sentry Discord Server](https://discord.gg/Ww9hbqr)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sentry)
86 changes: 86 additions & 0 deletions packages/tanstackstart-react/package.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
{
"name": "@sentry/tanstackstart-react",
"version": "9.5.0",
"description": "Official Sentry SDK for TanStack Start React",
"repository": "git://github.com/getsentry/sentry-javascript.git",
"homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/tanstackstart-react",
"author": "Sentry",
"license": "MIT",
"engines": {
"node": ">=18"
},
"main": "build/cjs/index.server.js",
"module": "build/esm/index.server.js",
"types": "build/types/index.types.d.ts",
"files": [
"/build"
],
"exports": {
"./package.json": "./package.json",
".": {
"types": "./build/types/index.types.d.ts",
"browser": {
"import": "./build/esm/index.client.js",
"require": "./build/cjs/index.client.js"
},
"node": {
"import": "./build/esm/index.server.js",
"require": "./build/cjs/index.server.js"
}
},
"./import": {
"import": {
"default": "./build/import-hook.mjs"
}
},
"./loader": {
"import": {
"default": "./build/loader-hook.mjs"
}
}
},
"typesVersions": {
"<5.0": {
"build/npm/types/index.d.ts": [
"build/npm/types-ts3.8/index.d.ts"
]
}
},
"publishConfig": {
"access": "public"
},
"dependencies": {
"@opentelemetry/api": "^1.9.0",
"@opentelemetry/semantic-conventions": "^1.30.0",
"@sentry-internal/browser-utils": "9.5.0",
"@sentry/core": "9.5.0",
"@sentry/node": "9.5.0",
"@sentry/opentelemetry": "9.5.0",
"@sentry/react": "9.5.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
"build:dev": "yarn build",
"build:transpile": "rollup -c rollup.npm.config.mjs",
"build:types": "run-s build:types:core build:types:downlevel",
"build:types:core": "tsc -p tsconfig.types.json",
"build:types:downlevel": "yarn downlevel-dts build/types build/types-ts3.8 --to ts3.8",
"build:watch": "run-p build:transpile:watch build:types:watch",
"build:dev:watch": "yarn build:watch",
"build:transpile:watch": "nodemon --ext ts --watch src scripts/buildRollup.ts",
"build:types:watch": "tsc -p tsconfig.types.json --watch",
"build:tarball": "npm pack",
"circularDepCheck": "madge --circular src/index.client.ts && madge --circular src/index.server.ts && madge --circular src/index.types.ts",
"clean": "rimraf build coverage sentry-tanstackstart-react-*.tgz",
"fix": "eslint . --format stylish --fix",
"lint": "eslint . --format stylish",
"test": "yarn test:unit",
"test:unit": "vitest run",
"test:watch": "vitest --watch",
"yalc:publish": "yalc publish --push --sig"
},
"volta": {
"extends": "../../package.json"
},
"sideEffects": false
}
10 changes: 10 additions & 0 deletions packages/tanstackstart-react/rollup.npm.config.mjs
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
import { makeBaseNPMConfig, makeNPMConfigVariants, makeOtelLoaders } from '@sentry-internal/rollup-utils';

export default [
...makeNPMConfigVariants(
makeBaseNPMConfig({
entrypoints: ['src/index.server.ts', 'src/index.client.ts', 'src/client/index.ts', 'src/server/index.ts'],
}),
),
...makeOtelLoaders('./build', 'sentry-node'),
];
1 change: 1 addition & 0 deletions packages/tanstackstart-react/src/client/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
export * from '@sentry/react';
23 changes: 23 additions & 0 deletions packages/tanstackstart-react/src/common/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
/**
* A middleware handler that can be passed to TanStack Start's `createMiddleware().server(...)` method as [global middleware](https://tanstack.com/start/latest/docs/framework/react/middleware#global-middleware) for instrumenting server functions.
*/
export function sentryGlobalServerMiddlewareHandler() {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return function <T>(server: { next: (...args: any[]) => T }): T {
return server.next();
};
}

/**
* Wraps a TanStack Start stream handler with Sentry instrumentation that can be passed to `createStartHandler(...)`.
*/
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;
}
16 changes: 16 additions & 0 deletions packages/tanstackstart-react/src/config/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
/**
* Wraps a TanStack Start config.
*/
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;
}
2 changes: 2 additions & 0 deletions packages/tanstackstart-react/src/index.client.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
export * from './client';
export * from './common';
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/src/index.server.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
export * from './config';
export * from './server';
export * from './common';
27 changes: 27 additions & 0 deletions packages/tanstackstart-react/src/index.types.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
// We export everything from both the client part of the SDK and from the server part. Some of the exports collide,
// which is not allowed, unless we redefine the colliding exports in this file - which we do below.
export * from './config';
export * from './client';
export * from './server';
export * from './common';

import type { Client, Integration, Options, StackParser } from '@sentry/core';

import type * as clientSdk from './client';
import type * as serverSdk from './server';

/** Initializes Sentry TanStack Start SDK */
export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): Client | undefined;

export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
export declare const contextLinesIntegration: typeof clientSdk.contextLinesIntegration;

export declare const getDefaultIntegrations: (options: Options) => Integration[];
export declare const defaultStackParser: StackParser;

export declare function getSentryRelease(fallback?: string): string | undefined;

export declare const ErrorBoundary: typeof clientSdk.ErrorBoundary;
export declare const createReduxEnhancer: typeof clientSdk.createReduxEnhancer;
export declare const showReportDialog: typeof clientSdk.showReportDialog;
export declare const withErrorBoundary: typeof clientSdk.withErrorBoundary;
42 changes: 42 additions & 0 deletions packages/tanstackstart-react/src/server/index.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
export * from '@sentry/node';

/**
* A passthrough error boundary for the server that doesn't depend on any react. Error boundaries don't catch SSR errors
* so they should simply be a passthrough.
*/
export const ErrorBoundary = (props: React.PropsWithChildren<unknown>): React.ReactNode => {
if (!props.children) {
return null;
}

if (typeof props.children === 'function') {
return (props.children as () => React.ReactNode)();
}

return props.children;
};

/**
* A passthrough redux enhancer for the server that doesn't depend on anything from the `@sentry/react` package.
*/
export function createReduxEnhancer() {
return (createStore: unknown) => createStore;
}

/**
* A passthrough error boundary wrapper for the server that doesn't depend on any react. Error boundaries don't catch
* SSR errors so they should simply be a passthrough.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withErrorBoundary<P extends Record<string, any>>(
WrappedComponent: React.ComponentType<P>,
): React.FC<P> {
return WrappedComponent as React.FC<P>;
}

/**
* Just a passthrough since we're on the server and showing the report dialog on the server doesn't make any sense.
*/
export function showReportDialog(): void {
return;
}
7 changes: 7 additions & 0 deletions packages/tanstackstart-react/test/temp.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
import { describe, it, expect } from 'vitest';

describe('Basic test suite', () => {
it('should pass', () => {
expect(true).toBe(true);
});
});
3 changes: 3 additions & 0 deletions packages/tanstackstart-react/test/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
{
"extends": "../tsconfig.test.json"
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "../../tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"lib": ["es2018", "es2020.string"],
"module": "Node16"
}
}
8 changes: 8 additions & 0 deletions packages/tanstackstart-react/tsconfig.test.json
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
{
"extends": "./tsconfig.json",
"include": ["test/**/*", "vite.config.ts"],
"compilerOptions": {
"types": ["node"],
"lib": ["DOM", "ESNext"]
}
}
Loading