add Feedback types

Author: billyvg

packages/types/src/datacategory.ts

@@ -24,5 +24,7 @@ export type DataCategory =
   | 'profile'
   // Check-in event (monitor)
   | 'monitor'
+  // Feedback type event (v2)
+  | 'feedback'
   // Unknown data category
   | 'unknown';

packages/types/src/envelope.ts

@@ -2,6 +2,7 @@ import type { SerializedCheckIn } from './checkin';
 import type { ClientReport } from './clientreport';
 import type { DsnComponents } from './dsn';
 import type { Event } from './event';
+import type { FeedbackEvent } from './feedback';
 import type { ReplayEvent, ReplayRecordingData } from './replay';
 import type { SdkInfo } from './sdkinfo';
 import type { SerializedSession, Session, SessionAggregates } from './session';
@@ -26,6 +27,7 @@ export type DynamicSamplingContext = {
 export type EnvelopeItemType =
   | 'client_report'
   | 'user_report'
+  | 'feedback'
   | 'session'
   | 'sessions'
   | 'transaction'
@@ -57,7 +59,7 @@ type BaseEnvelope<EnvelopeHeader, Item> = [
 ];
 
 type EventItemHeaders = {
-  type: 'event' | 'transaction' | 'profile';
+  type: 'event' | 'transaction' | 'profile' | 'feedback';
 };
 type AttachmentItemHeaders = {
   type: 'attachment';
@@ -67,6 +69,7 @@ type AttachmentItemHeaders = {
   attachment_type?: string;
 };
 type UserFeedbackItemHeaders = { type: 'user_report' };
+type FeedbackItemHeaders = { type: 'feedback' };
 type SessionItemHeaders = { type: 'session' };
 type SessionAggregatesItemHeaders = { type: 'sessions' };
 type ClientReportItemHeaders = { type: 'client_report' };
@@ -87,6 +90,7 @@ export type CheckInItem = BaseEnvelopeItem<CheckInItemHeaders, SerializedCheckIn
 type ReplayEventItem = BaseEnvelopeItem<ReplayEventItemHeaders, ReplayEvent>;
 type ReplayRecordingItem = BaseEnvelopeItem<ReplayRecordingItemHeaders, ReplayRecordingData>;
 export type StatsdItem = BaseEnvelopeItem<StatsdItemHeaders, string>;
+export type FeedbackItem = BaseEnvelopeItem<FeedbackItemHeaders, FeedbackEvent>;
 
 export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: DynamicSamplingContext };
 type SessionEnvelopeHeaders = { sent_at: string };
@@ -95,7 +99,10 @@ type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
 type ReplayEnvelopeHeaders = BaseEnvelopeHeaders;
 type StatsdEnvelopeHeaders = BaseEnvelopeHeaders;
 
-export type EventEnvelope = BaseEnvelope<EventEnvelopeHeaders, EventItem | AttachmentItem | UserFeedbackItem>;
+export type EventEnvelope = BaseEnvelope<
+  EventEnvelopeHeaders,
+  EventItem | AttachmentItem | UserFeedbackItem | FeedbackItem
+>;
 export type SessionEnvelope = BaseEnvelope<SessionEnvelopeHeaders, SessionItem>;
 export type ClientReportEnvelope = BaseEnvelope<ClientReportEnvelopeHeaders, ClientReportItem>;
 export type ReplayEnvelope = [ReplayEnvelopeHeaders, [ReplayEventItem, ReplayRecordingItem]];

packages/types/src/event.ts

@@ -61,7 +61,7 @@ export interface Event {
  * Note that `ErrorEvent`s do not have a type (hence its undefined),
  * while all other events are required to have one.
  */
-export type EventType = 'transaction' | 'profile' | 'replay_event' | undefined;
+export type EventType = 'transaction' | 'profile' | 'replay_event' | 'feedback' | undefined;
 
 export interface ErrorEvent extends Event {
   type: undefined;

packages/types/src/feedback.ts

@@ -0,0 +1,20 @@
+import type { Event } from './event';
+
+export interface FeedbackContext extends Record<string, unknown> {
+  message: string;
+  contact_email?: string;
+  name?: string;
+  replay_id?: string;
+  url?: string;
+}
+
+/**
+ * NOTE: These types are still considered Alpha and subject to change.
+ * @hidden
+ */
+export interface FeedbackEvent extends Event {
+  type: 'feedback';
+  contexts: Event['contexts'] & {
+    feedback: FeedbackContext;
+  };
+}

packages/types/src/index.ts

@@ -36,6 +36,7 @@ export type {
   EventEnvelopeHeaders,
   EventItem,
   ReplayEnvelope,
+  FeedbackItem,
   SessionEnvelope,
   SessionItem,
   UserFeedbackItem,
@@ -69,6 +70,7 @@ export type {
   Profile,
 } from './profiling';
 export type { ReplayEvent, ReplayRecordingData, ReplayRecordingMode } from './replay';
+export type {FeedbackEvent} from './feedback';
 export type { QueryParams, Request, SanitizedRequestData } from './request';
 export type { Runtime } from './runtime';
 export type { CaptureContext, Scope, ScopeContext } from './scope';

packages/utils/src/envelope.ts

@@ -208,6 +208,7 @@ const ITEM_TYPE_TO_DATA_CATEGORY_MAP: Record<EnvelopeItemType, DataCategory> = {
   replay_event: 'replay',
   replay_recording: 'replay',
   check_in: 'monitor',
+  feedback: 'feedback',
   // TODO: This is a temporary workaround until we have a proper data category for metrics
   statsd: 'unknown',
 };