use generic for hook

Author: mydea

packages/core/test/lib/base.test.ts

@@ -1,4 +1,4 @@
-import type { Event, Span, Transaction } from '@sentry/types';
+import { Event, Span, Transaction, TransactionHook, EnvelopeHook, Envelope } from '@sentry/types';
 import { dsnToString, logger, SentryError, SyncPromise } from '@sentry/utils';
 
 import { Hub, makeSession, Scope } from '../../src';
@@ -1742,11 +1742,31 @@ describe('BaseClient', () => {
         traceId: '86f39e84263a4de99c326acab3bfe3bd',
       } as Transaction;
 
-      client?.on('startTransaction', (transaction: Transaction) => {
+      client?.on<TransactionHook>('startTransaction', (transaction: Transaction) => {
         expect(transaction).toEqual(mockTransaction);
       });
 
-      client?.emit('startTransaction', mockTransaction);
+      client?.emit<TransactionHook>('startTransaction', mockTransaction);
+    });
+
+    it('should call a beforeEnvelope hook', () => {
+      expect.assertions(1);
+
+      const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
+      const client = new TestClient(options);
+
+      const mockEnvelope = [
+        {
+          event_id: '12345',
+        },
+        {},
+      ] as Envelope;
+
+      client?.on<EnvelopeHook>('beforeEnvelope', (envelope: Envelope) => {
+        expect(envelope).toEqual(mockEnvelope);
+      });
+
+      client?.emit<EnvelopeHook>('beforeEnvelope', mockEnvelope);
     });
   });
 });

packages/types/src/client.ts

@@ -2,7 +2,7 @@ import type { EventDropReason } from './clientreport';
 import type { DataCategory } from './datacategory';
 import type { DsnComponents } from './dsn';
 import type { Event, EventHint } from './event';
-import type { EnvelopeHook, TransactionHook } from './hooks';
+import type { Hook } from './hooks';
 import type { Integration, IntegrationClass } from './integration';
 import type { ClientOptions } from './options';
 import type { Scope } from './scope';
@@ -155,22 +155,11 @@ export interface Client<O extends ClientOptions = ClientOptions> {
   /**
    * Register a callback for transaction start and finish.
    */
-  on?(hook: TransactionHook['name'], callback: TransactionHook['callback']): void;
-
-  /**
-   * Register a callback for envelope creation and sending.
-   */
-  on?(hook: EnvelopeHook['name'], callback: EnvelopeHook['callback']): void;
-
-  /**
-   * Fire a hook event for transaction start and finish. Expects to be given a transaction as the
-   * second argument.
-   */
-  emit?(hook: TransactionHook['name'], ...params: Parameters<TransactionHook['callback']>): void;
+  on?<HookType extends Hook>(hook: HookType['name'], callback: HookType['callback']): void;
 
   /*
    * Fire a hook event for envelope creation and sending. Expects to be given an envelope as the
    * second argument.
    */
-  emit?(hook: EnvelopeHook['name'], ...params: Parameters<EnvelopeHook['callback']>): void;
+  emit?<HookType extends Hook>(hook: HookType['name'], ...args: Parameters<HookType['callback']>): void;
 }