feat(browser): add LoaderSentry type

packages/browser/src/exports.ts

@@ -23,6 +23,7 @@ export type {
 } from '@sentry/core';
 
 export type { BrowserOptions } from './client';
+export type { LoaderSentry } from './loader';
 
 export {
   addEventProcessor,

packages/browser/src/loader.ts

@@ -0,0 +1,27 @@
+
+type LoaderApi = typeof import('@sentry/core') &
+  typeof import('./sdk') &
+  typeof import('./report-dialog');
+
+type VoidReturningFunction<T> = T extends (...args: infer Args) => unknown
+  ? (...args: Args) => void
+  : never;
+
+type LoaderQueuedMethod =
+  | 'init'
+  | 'addBreadcrumb'
+  | 'captureMessage'
+  | 'captureException'
+  | 'captureEvent'
+  | 'withScope'
+  | 'showReportDialog';
+
+/**
+ * The subset of the Sentry browser API supported by the CDN loader.
+ *
+ * Queued calls do not synchronously return the result of the underlying SDK
+ * method, so their return types are void.
+ */
+export type LoaderSentry = {
+  [Method in LoaderQueuedMethod]: VoidReturningFunction<LoaderApi[Method]>;
+} & Pick<LoaderApi, 'onLoad' | 'forceLoad'>;

packages/browser/test/loader.test-d.ts

@@ -0,0 +1,33 @@
+import { expectTypeOf, it, describe } from 'vitest';
+import type { LoaderSentry } from '../src/loader';
+
+describe('LoaderSentry', () => {
+  it('exposes the APIs supported by the loader', () => {
+    expectTypeOf<LoaderSentry>().toHaveProperty('init');
+    expectTypeOf<LoaderSentry>().toHaveProperty('addBreadcrumb');
+    expectTypeOf<LoaderSentry>().toHaveProperty('captureMessage');
+    expectTypeOf<LoaderSentry>().toHaveProperty('captureException');
+    expectTypeOf<LoaderSentry>().toHaveProperty('captureEvent');
+    expectTypeOf<LoaderSentry>().toHaveProperty('withScope');
+    expectTypeOf<LoaderSentry>().toHaveProperty('showReportDialog');
+    expectTypeOf<LoaderSentry>().toHaveProperty('onLoad');
+    expectTypeOf<LoaderSentry>().toHaveProperty('forceLoad');
+  });
+
+  it('does not expose unsupported APIs', () => {
+    expectTypeOf<LoaderSentry>().not.toHaveProperty('addIntegration');
+    expectTypeOf<LoaderSentry>().not.toHaveProperty('captureFeedback');
+    expectTypeOf<LoaderSentry>().not.toHaveProperty('flush');
+    expectTypeOf<LoaderSentry>().not.toHaveProperty('close');
+  });
+
+  it('uses void return types for queued methods', () => {
+    expectTypeOf<LoaderSentry['init']>().returns.toBeVoid();
+    expectTypeOf<LoaderSentry['addBreadcrumb']>().returns.toBeVoid();
+    expectTypeOf<LoaderSentry['captureMessage']>().returns.toBeVoid();
+    expectTypeOf<LoaderSentry['captureException']>().returns.toBeVoid();
+    expectTypeOf<LoaderSentry['captureEvent']>().returns.toBeVoid();
+    expectTypeOf<LoaderSentry['withScope']>().returns.toBeVoid();
+    expectTypeOf<LoaderSentry['showReportDialog']>().returns.toBeVoid();
+  });
+});

packages/browser/tsconfig.loader.test.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.test.json",
+  "include": ["test/loader.test-d.ts"]
+}

packages/browser/vite.config.ts

@@ -1,3 +1,4 @@
+
 import { defineConfig } from 'vitest/config';
 import baseConfig from '../../vite/vite.config';
 
@@ -9,5 +10,10 @@ export default defineConfig({
     fakeTimers: {
       toFake: ['setTimeout', 'clearTimeout', 'setInterval', 'clearInterval', 'setImmediate', 'clearImmediate', 'Date'],
     },
+    typecheck: {
+      enabled: true,
+      include: ['test/loader.test-d.ts'],
+      tsconfig: './tsconfig.loader.test.json',
+    },
   },
 });