ref(types): Upstream replay envelope types

Author: mydea

packages/replay/src/util/createReplayEnvelope.ts

@@ -1,30 +1,27 @@
-import { Envelope, ReplayEvent, ReplayRecordingData } from '@sentry/types';
+import { ReplayEnvelope, ReplayEvent, ReplayRecordingData } from '@sentry/types';
 import { createEnvelope } from '@sentry/utils';
 
 import { REPLAY_SDK_INFO } from '../constants';
 
 export function createReplayEnvelope(
   replayId: string,
   replayEvent: ReplayEvent,
-  payloadWithSequence: ReplayRecordingData,
-): Envelope {
-  return createEnvelope(
+  recordingData: ReplayRecordingData,
+): ReplayEnvelope {
+  return createEnvelope<ReplayEnvelope>(
     {
       event_id: replayId,
       sent_at: new Date().toISOString(),
       sdk: REPLAY_SDK_INFO,
     },
     [
-      // @ts-ignore New types
       [{ type: 'replay_event' }, replayEvent],
       [
         {
-          // @ts-ignore setting envelope
           type: 'replay_recording',
-          length: payloadWithSequence.length,
+          length: recordingData.length,
         },
-        // @ts-ignore: Type 'string' is not assignable to type 'ClientReport'.ts(2322)
-        payloadWithSequence,
+        recordingData,
       ],
     ],
   );

packages/types/src/datacategory.ts

@@ -19,4 +19,7 @@ export type DataCategory =
   // SDK internal event, like client_reports
   | 'internal'
   // Profile event type
-  | 'profile';
+  | 'profile'
+  // Replay event types
+  | 'replay_event'
+  | 'replay_recording';

packages/types/src/envelope.ts

@@ -1,6 +1,7 @@
 import { ClientReport } from './clientreport';
 import { DsnComponents } from './dsn';
 import { Event } from './event';
+import { ReplayEvent, ReplayRecordingData } from './replay';
 import { SdkInfo } from './sdkinfo';
 import { Session, SessionAggregates } from './session';
 import { Transaction } from './transaction';
@@ -27,7 +28,9 @@ export type EnvelopeItemType =
   | 'transaction'
   | 'attachment'
   | 'event'
-  | 'profile';
+  | 'profile'
+  | 'replay_event'
+  | 'replay_recording';
 
 export type BaseEnvelopeHeaders = {
   [key: string]: unknown;
@@ -62,6 +65,8 @@ type UserFeedbackItemHeaders = { type: 'user_report' };
 type SessionItemHeaders = { type: 'session' };
 type SessionAggregatesItemHeaders = { type: 'sessions' };
 type ClientReportItemHeaders = { type: 'client_report' };
+type ReplayEventItemHeaders = { type: 'replay_event' };
+type ReplayRecordingItemHeaders = { type: 'replay_recording'; length: number };
 
 export type EventItem = BaseEnvelopeItem<EventItemHeaders, Event>;
 export type AttachmentItem = BaseEnvelopeItem<AttachmentItemHeaders, string | Uint8Array>;
@@ -70,14 +75,18 @@ export type SessionItem =
   | BaseEnvelopeItem<SessionItemHeaders, Session>
   | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
 export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;
+type ReplayEventItem = BaseEnvelopeItem<ReplayEventItemHeaders, ReplayEvent>;
+type ReplayRecordingItem = BaseEnvelopeItem<ReplayRecordingItemHeaders, ReplayRecordingData>;
 
 export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
 type SessionEnvelopeHeaders = { sent_at: string };
 type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
+type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
 
 export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem>;
 export type SessionEnvelope = BaseEnvelope<SessionEnvelopeHeaders, SessionItem>;
 export type ClientReportEnvelope = BaseEnvelope<ClientReportEnvelopeHeaders, ClientReportItem>;
+export type ReplayEnvelope = [ReplayEnvelopeHeaders, [ReplayEventItem, ReplayRecordingItem]];
 
-export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope;
+export type Envelope = EventEnvelope | SessionEnvelope | ClientReportEnvelope | ReplayEnvelope;
 export type EnvelopeItem = Envelope[1][number];

packages/types/src/index.ts

@@ -19,6 +19,7 @@ export type {
   EventEnvelope,
   EventEnvelopeHeaders,
   EventItem,
+  ReplayEnvelope,
   SessionEnvelope,
   SessionItem,
   UserFeedbackItem,

packages/utils/src/envelope.ts

@@ -134,6 +134,8 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
   client_report: 'internal',
   user_report: 'default',
   profile: 'profile',
+  replay_event: 'replay_event',
+  replay_recording: 'replay_recording',
 };
 
 /**