Rewriting types

Author: andreiborza

packages/solidstart/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentry/solidstart",
-  "version": "8.11.0",
+  "version": "8.12.0",
   "description": "Official Sentry SDK for Solid Start",
   "repository": "git://github.com/getsentry/sentry-javascript.git",
   "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/solidstart",
@@ -10,36 +10,38 @@
     "node": ">=16"
   },
   "files": [
-    "cjs",
-    "esm",
-    "index.types.d.ts",
-    "solidrouter.types.d.ts",
-    "types-ts3.8"
+    "/build",
+    "/client",
+    "/server",
+    "/*.d.ts",
+    "/*.d.ts.map"
   ],
   "main": "build/cjs/index.server.js",
   "module": "build/esm/index.server.js",
   "browser": "build/esm/index.client.js",
-  "types": "build/index.types.d.ts",
+  "types": "build/types/index.types.d.ts",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "types": "./build/index.types.d.ts",
       "browser": {
+        "types": "./build/types/index.types.d.ts",
         "import": "./build/esm/index.client.js",
         "require": "./build/cjs/index.client.js"
       },
       "node": {
+        "types": "./build/types/index.types.d.ts",
         "import": "./build/esm/index.server.js",
         "require": "./build/cjs/index.server.js"
       }
     },
     "./solidrouter": {
-      "types": "./build/solidrouter.types.d.ts",
       "browser": {
+        "types": "./solidrouter.types.d.ts",
         "import": "./build/esm/solidrouter.client.js",
         "require": "./build/cjs/solidrouter.client.js"
       },
       "node": {
+        "types": "./solidrouter.types.d.ts",
         "import": "./build/esm/solidrouter.server.js",
         "require": "./build/cjs/solidrouter.server.js"
       }
@@ -58,12 +60,12 @@
     }
   },
   "dependencies": {
-    "@sentry/core": "8.11.0",
-    "@sentry/node": "8.11.0",
-    "@sentry/opentelemetry": "8.11.0",
-    "@sentry/solid": "8.11.0",
-    "@sentry/types": "8.11.0",
-    "@sentry/utils": "8.11.0",
+    "@sentry/core": "8.12.0",
+    "@sentry/node": "8.12.0",
+    "@sentry/opentelemetry": "8.12.0",
+    "@sentry/solid": "8.12.0",
+    "@sentry/types": "8.12.0",
+    "@sentry/utils": "8.12.0",
     "@sentry/vite-plugin": "2.19.0"
   },
   "devDependencies": {
@@ -72,7 +74,6 @@
     "@solidjs/testing-library": "0.8.5",
     "@testing-library/jest-dom": "^6.4.5",
     "@testing-library/user-event": "^14.5.2",
-    "solid-js": "^1.8.11",
     "vite-plugin-solid": "^2.8.2"
   },
   "scripts": {

packages/solidstart/rollup.npm.config.mjs

@@ -15,7 +15,7 @@ export default makeNPMConfigVariants(
     // prevent this internal nextjs code from ending up in our built package (this doesn't happen automatially because
     // the name doesn't match an SDK dependency)
     packageSpecificConfig: {
-      external: ['solid-js', '@sentry/solid/solidrouter'],
+      external: ['solid-js', '@sentry/solid', '@sentry/solid/solidrouter'],
     },
   }),
 );

packages/solidstart/src/index.types.ts

@@ -9,7 +9,7 @@ import type { Integration, Options, StackParser } from '@sentry/types';
 import type * as clientSdk from './client';
 import type * as serverSdk from './server';
 
-/** Initializes Sentry SvelteKit SDK */
+/** Initializes Sentry Solid Start SDK */
 export declare function init(options: Options | clientSdk.BrowserOptions | serverSdk.NodeOptions): void;
 
 export declare const linkedErrorsIntegration: typeof clientSdk.linkedErrorsIntegration;
@@ -19,8 +19,6 @@ export declare const getDefaultIntegrations: (options: Options) => Integration[]
 export declare const defaultStackParser: StackParser;
 
 export declare const getClient: typeof clientSdk.getClient;
-// eslint-disable-next-line deprecation/deprecation
-export declare const getCurrentHub: typeof clientSdk.getCurrentHub;
 
 export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
 export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;

packages/solidstart/src/server/solidrouter.ts

@@ -1,8 +1,14 @@
-import type { HashRouter, MemoryRouter, RouteSectionProps, StaticRouter } from '@solidjs/router';
-// import { useBeforeLeave, useLocation } from '@solidjs/router';
-import type { Router as BaseRouter } from '@solidjs/router/dist/routers/Router';
+import type { Integration } from '@sentry/types';
+import type {
+  HashRouter,
+  MemoryRouter,
+  RouteSectionProps,
+  Router as BaseRouter,
+  StaticRouter,
+} from '@solidjs/router';
+import { mergeProps, splitProps } from 'solid-js';
 import type { Component, JSX, ParentProps } from 'solid-js';
-import { createComponent, mergeProps, splitProps } from 'solid-js';
+import { createComponent } from 'solid-js/web';
 
 /** Pass-through component in case user didn't specify a root **/
 function SentryDefaultRoot(props: ParentProps): JSX.Element {
@@ -15,33 +21,23 @@ function SentryDefaultRoot(props: ParentProps): JSX.Element {
  */
 function withSentryRouterRoot(Root: Component<RouteSectionProps>): Component<RouteSectionProps> {
   const SentryRouterRoot = (props: RouteSectionProps): JSX.Element => {
-    // TODO: This is a rudimentary first version of handling navigation spans
-    // It does not
-    // - use query params
-    // - parameterize the route
-
-    // useBeforeLeave(({ to }: BeforeLeaveEventArgs) => {
-    //   `to` could be `-1` if the browser back-button was used
-    //   eslint-disable-next-line no-console
-    //   console.log('[server] useBeforeLeave', to.toString());
-    // });
-
-    // const location = useLocation();
-    // createEffect(() => {
-      // eslint-disable-next-line no-console
-      // console.log('[server] useLocation', location.pathname);
-    // });
-
     return createComponent(Root, props);
   };
 
   return SentryRouterRoot;
 }
 
 /**
- *
+ * A browser tracing integration that uses Solid Router to instrument navigations.
  */
-export function solidRouterBrowserTracingIntegration(): void {}
+export function solidRouterBrowserTracingIntegration(
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  options: any
+): Integration {
+  return {
+    name: 'solidRouterBrowserTracingIntegration',
+  }
+}
 
 type RouterType = typeof BaseRouter | typeof HashRouter | typeof MemoryRouter | typeof StaticRouter;
 

packages/solidstart/tsconfig.solidrouter-types.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.json",
+
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./"
+  },
+
+  "//": "Tehese types are built separately because it is for a subpath export, which has problems if it is not in the root",
+  "include": ["src/solidrouter.client.ts", "src/solidrouter.server.ts"],
+  "//": "Without this, we cannot output into the root dir",
+  "exclude": []
+}