fix(types): restore type for process.sentry and improve $sentry types (#534)

Author: rchl

package.json

@@ -76,7 +76,8 @@
     "jest": "29.5.0",
     "nuxt": "2.16.3",
     "playwright-chromium": "1.32.0",
-    "release-it": "15.9.1",
+    "release-it": "15.9.3",
+    "sass": "^1.60.0",
     "sentry-testkit": "5.0.5",
     "ts-jest": "29.0.5",
     "ts-node": "10.9.1",

src/hooks.ts

@@ -153,9 +153,9 @@ export async function initializeServerSentry (nuxt: Nuxt, moduleOptions: ModuleC
       await import('@sentry/tracing')
       sentryHandlerProxy.tracingHandler = Sentry.Handlers.tracingHandler()
     }
-  }
 
-  process.sentry = Sentry
+    process.sentry = Sentry.getCurrentHub().getClient() as Sentry.NodeClient
+  }
 }
 
 export async function shutdownServerSentry (): Promise<void> {

src/options.ts

@@ -253,8 +253,10 @@ export async function resolveServerOptions (nuxt: Nuxt, moduleOptions: ModuleCon
           const opt = options.serverIntegrations[name]
           try {
             if (isServerDefaultIntegration(name)) {
+              // @ts-expect-error Some integrations don't take arguments but it doesn't hurt to pass one.
               return Object.keys(opt as Record<string, unknown>).length ? new ServerIntegrations[name](opt) : new ServerIntegrations[name]()
             } else if (isServerPlugabbleIntegration(name)) {
+              // @ts-expect-error Some integrations don't take arguments but it doesn't hurt to pass one.
               // eslint-disable-next-line import/namespace
               return Object.keys(opt as Record<string, unknown>).length ? new PluggableIntegrations[name](opt) : new PluggableIntegrations[name]()
             } else {

src/types/extend.d.ts

@@ -1,36 +1,36 @@
 import 'vue'
 import 'vuex'
 import '@nuxt/types'
-import * as SentryTypes from '@sentry/core'
+import { Client } from '@sentry/types'
 import { DeepPartialModuleConfiguration } from './configuration'
 
 export type ModulePublicRuntimeConfig = Pick<DeepPartialModuleConfiguration, 'config' | 'clientConfig' | 'serverConfig'>
 
 // add type to Vue context
 declare module 'vue/types/vue' {
   interface Vue {
-    readonly $sentry: typeof SentryTypes
+    readonly $sentry: Client
     $sentryLoad(): Promise<void>
-    $sentryReady(): Promise<typeof SentryTypes>
+    $sentryReady(): Promise<Client>
   }
 }
 
 // App Context and NuxtAppOptions
 declare module '@nuxt/types' {
   interface Context {
-    readonly $sentry: typeof SentryTypes
+    readonly $sentry: Client
     $sentryLoad(): Promise<void>
-    $sentryReady(): Promise<typeof SentryTypes>
+    $sentryReady(): Promise<Client>
   }
 
   interface NuxtOptions {
     sentry?: DeepPartialModuleConfiguration
   }
 
   interface NuxtAppOptions {
-    readonly $sentry: typeof SentryTypes
+    readonly $sentry: Client
     $sentryLoad(): Promise<void>
-    $sentryReady(): Promise<typeof SentryTypes>
+    $sentryReady(): Promise<Client>
   }
 }
 
@@ -43,8 +43,16 @@ declare module '@nuxt/types/config/runtime' {
 // add types for Vuex Store
 declare module 'vuex/types' {
   interface Store<S> {
-    readonly $sentry: typeof SentryTypes
+    readonly $sentry: Client
     $sentryLoad(): Promise<void>
-    $sentryReady(): Promise<typeof SentryTypes>
+    $sentryReady(): Promise<Client>
+  }
+}
+
+declare global {
+  namespace NodeJS {
+    interface Process {
+      sentry: Client
+    }
   }
 }

src/types/index.d.ts

@@ -1,6 +1,5 @@
 import { DeepPartialModuleConfiguration, ModuleConfiguration } from './configuration'
 import { ModulePublicRuntimeConfig } from './extend'
-import './node'
 
 type ModuleOptions = DeepPartialModuleConfiguration