@multiplayer-app/session-recorder-react-native 0.0.1 → 1.0.0-beta.1

package/src/types/session-recorder.ts

@@ -1,423 +0,0 @@
-
-import { SessionType } from '@multiplayer-app/session-recorder-common'
-import { PropagateTraceHeaderCorsUrls } from '@opentelemetry/sdk-trace-web'
-import { Span } from '@opentelemetry/api'
-import type { ISession } from './session'
-
-export enum WidgetButtonPlacement {
-  topLeft = 'top-left',
-  topRight = 'top-right',
-  bottomLeft = 'bottom-left',
-  bottomRight = 'bottom-right',
-}
-
-export interface SessionRecorderOptions {
-  /**
-   * The API key used to authenticate with the session debugger service.
-   */
-  apiKey: string
-
-  /**
-   * The version of the application using the session debugger.
-   */
-  version: string
-
-  /**
-   * The name of the application being debugged.
-   */
-  application: string
-
-  /**
-   * The environment where the application is running (e.g., 'production', 'staging').
-   */
-  environment: string
-
-  /**
-   * (Optional) OTLP collector endpoint.
-   */
-  exporterEndpoint?: string
-
-  /**
-   * (Optional) Base URL for the API calls.
-   * This allows customization of the API endpoint for sending session data.
-   */
-  apiBaseUrl?: string
-
-  /**
-   * (Optional) An array of URLs or regular expressions that should be ignored by the session debugger.
-   * Any URL that partially matches any regex in this array will not be traced.
-   * Additionally, URLs that exactly match any string in the array will also be ignored.
-   */
-  ignoreUrls?: Array<string | RegExp>
-
-  /**
-   * (Optional) Determines where the record button should be placed on the screen.
-   * Possible values:
-   *  - 'top-left'
-   *  - 'top-right'
-   *  - 'bottom-left'
-   *  - 'bottom-right'
-   */
-  widgetButtonPlacement?: WidgetButtonPlacement
-
-  /**
-   * (Optional) Enables the continuous recording feature and UI.
-   * If false, the UI toggle is hidden and attempts to start a continuous
-   * session are ignored.
-   * @default true
-   */
-  showContinuousRecording?: boolean
-
-  /**
-   * (Optional) If false, the session recording widget will be hidden from the UI.
-   * Use this option if you want to enable session recording without a visible UI element.
-   * @default showWidget = true
-   */
-  showWidget?: boolean
-
-
-  /**
-   * (Optional) Trace ID Ratio for sampling
-   * @default 0.15
-   */
-  sampleTraceRatio?: number
-
-  /**
-   * (Optional) URLs or regex patterns for CORS trace header propagation
-   */
-  propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls
-
-  /**
-   * (Optional) If true, schematizes document span payload
-   * @default true
-   */
-  schemifyDocSpanPayload?: boolean
-
-  /**
-   * (Optional) Maximum size for capturing HTTP payload
-   * @default 100000
-   */
-  maxCapturingHttpPayloadSize?: number
-
-  /**
-   * (Optional) If true, uses post message fallback
-   * @default false
-   */
-  usePostMessageFallback?: boolean
-
-
-  /** If true, captures body in traces
-   *  @default true
-  */
-  captureBody?: boolean
-  /** If true, captures headers in traces
-   *  @default true
-  */
-  captureHeaders?: boolean
-
-  /**
-   * (Optional) Configuration for masking sensitive data in session recordings
-   * @default { maskAllInputs: true, isContentMaskingEnabled: true }
-   */
-  masking?: MaskingConfig
-
-  /**
-   * (Optional) Configuration for customizable UI text and labels
-   * @default See PopoverTextConfig defaults
-   */
-  widgetTextOverrides?: WidgetTextOverridesConfig
-
-
-  /** Whether to record gestures */
-  recordGestures?: boolean
-  /** Whether to record navigation */
-  recordNavigation?: boolean
-  /** Whether to record screen */
-  recordScreen?: boolean
-}
-
-/**
- * Interface for masking configuration
- */
-export interface MaskingConfig {
-  // Span masking
-  /** If true, enables masking for debug span payload in traces
-   *  @default true
-  */
-  isContentMaskingEnabled?: boolean;
-  /** Custom function for masking body in traces */
-  maskBody?: (payload: any, span: Span) => any;
-  /** Custom function for masking headers in traces */
-  maskHeaders?: (headers: any, span: any) => any;
-
-
-  /** List of body fields to mask in traces */
-  maskBodyFieldsList?: string[]
-  /** List of headers to mask in traces */
-  maskHeadersList?: string[]
-
-  /** List of headers to include in traces (if specified, only these headers will be captured) */
-  headersToInclude?: string[]
-  /** List of headers to exclude from traces */
-  headersToExclude?: string[]
-}
-
-/**
- * Base configuration interface with common properties
- */
-export interface BaseConfig {
-  /** API key for authentication */
-  apiKey: string
-  /** Base URL for the API calls */
-  apiBaseUrl: string
-  /** Base URL for the API calls */
-  exporterEndpoint: string
-  /** Whether to use post message fallback */
-  usePostMessageFallback?: boolean
-}
-
-/**
- * Configuration interface for the Tracer class
- */
-export type TracerReactNativeMasking = Pick<MaskingConfig, 'isContentMaskingEnabled' | 'maskBody' | 'maskHeaders' | 'maskBodyFieldsList' | 'maskHeadersList' | 'headersToInclude' | 'headersToExclude'>;
-
-export interface TracerReactNativeConfig extends BaseConfig {
-  /** Application name */
-  application: string
-  /** Application version */
-  version: string
-  /** Environment (e.g., 'production', 'staging') */
-  environment: string
-  /** URLs to ignore during tracing */
-  ignoreUrls: Array<string | RegExp>
-  /** Trace ID ratio for sampling */
-  sampleTraceRatio: number
-  /** URLs for CORS trace header propagation */
-  propagateTraceHeaderCorsUrls: PropagateTraceHeaderCorsUrls
-  /** Whether to schematize document span payload */
-  schemifyDocSpanPayload: boolean
-  /** Maximum size for capturing HTTP payload */
-  maxCapturingHttpPayloadSize: number
-  /** If true, captures body in traces
-   *  @default true
-  */
-  captureBody: boolean
-  /** If true, captures headers in traces
-   *  @default true
-  */
-  captureHeaders: boolean
-  /** Configuration for masking sensitive data in session recordings */
-  masking: TracerReactNativeMasking
-}
-
-/**
- * Configuration interface for the Recorder class
- */
-// export type RecorderMasking = Pick<MaskingConfig, 'maskAllInputs' | 'maskTextClass' | 'maskTextSelector' | 'maskInputOptions' | 'maskInput' | 'maskText' | 'maskConsoleEvent'>;
-
-export interface RecorderConfig extends BaseConfig {
-  /** Whether to record gestures */
-  recordGestures?: boolean
-  /** Whether to record navigation */
-  recordNavigation?: boolean
-  /** Whether to record screen */
-  recordScreen?: boolean
-}
-
-/**
- * Configuration interface for the SessionWidget class
- */
-export interface SessionWidgetConfig {
-  /** Whether to show the widget */
-  showWidget: boolean
-  /** Placement of the widget button */
-  widgetButtonPlacement: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
-  /** Whether continuous recording feature is enabled */
-  showContinuousRecording: boolean
-  /** Configuration for customizable UI text and labels */
-  widgetTextOverrides: WidgetTextOverridesConfig
-}
-
-/**
- * Interface for customizable widget text configuration
- */
-export interface WidgetTextOverridesConfig {
-  /** Title for the initial popover when continuous recording is enabled */
-  initialTitleWithContinuous?: string
-  /** Title for the initial popover when continuous recording is disabled */
-  initialTitleWithoutContinuous?: string
-  /** Description for the initial popover when continuous recording is enabled */
-  initialDescriptionWithContinuous?: string
-  /** Description for the initial popover when continuous recording is disabled */
-  initialDescriptionWithoutContinuous?: string
-  /** Label for the continuous recording toggle */
-  continuousRecordingLabel?: string
-  /** Text for the start recording button */
-  startRecordingButtonText?: string
-  /** Title for the final popover */
-  finalTitle?: string
-  /** Description for the final popover */
-  finalDescription?: string
-  /** Placeholder text for the comment textarea */
-  commentPlaceholder?: string
-  /** Text for the save button in final popover */
-  saveButtonText?: string
-  /** Text for the cancel button in final popover */
-  cancelButtonText?: string
-  /** Title for the continuous recording overlay */
-  continuousOverlayTitle?: string
-  /** Description for the continuous recording overlay */
-  continuousOverlayDescription?: string
-  /** Text for the save last snapshot button */
-  saveLastSnapshotButtonText?: string
-  /** Title for the submit session dialog */
-  submitDialogTitle?: string
-  /** Subtitle for the submit session dialog */
-  submitDialogSubtitle?: string
-  /** Label for the comment field in submit dialog */
-  submitDialogCommentLabel?: string
-  /** Placeholder for the comment field in submit dialog */
-  submitDialogCommentPlaceholder?: string
-  /** Text for the submit button in dialog */
-  submitDialogSubmitText?: string
-  /** Text for the cancel button in dialog */
-  submitDialogCancelText?: string
-}
-
-/**
- * Configuration interface for the ApiService class
- */
-export interface ApiServiceConfig extends BaseConfig { }
-
-export interface SessionRecorderConfigs extends Required<SessionRecorderOptions> { }
-
-export enum SessionState {
-  started = '2',
-  paused = '1',
-  stopped = '0',
-}
-
-export interface ISessionRecorder {
-  /**
-   * The current session ID
-   */
-  readonly sessionId: string | null
-
-  /**
-   * Whether continuous recording is enabled
-   */
-  readonly continuousRecording: boolean
-
-  /**
-   * The current debug session object
-   */
-  readonly session: ISession | null
-
-  /**
-   * The type of session (plain or continuous)
-   */
-  readonly sessionType: SessionType
-
-  /**
-   * The current state of the session
-   */
-  readonly sessionState: SessionState | null
-
-
-  /**
-   * Session attributes for additional context
-   */
-  readonly sessionAttributes: Record<string, any>
-
-  /**
-   * Current error message
-   */
-  error: string
-
-  /**
-   * The HTML button element for the session widget's recorder button
-   */
-  readonly sessionWidgetButtonElement: HTMLButtonElement
-
-  /**
-   * Initialize the session debugger with custom configurations
-   * @param configs - custom configurations for session debugger
-   */
-  init(configs: SessionRecorderOptions): void
-
-  /**
-   * Save the continuous recording session
-   * @returns Promise that resolves to the save response
-   */
-  save(): Promise<any>
-
-  /**
-   * Start a new session
-   * @param type - the type of session to start
-   * @param session - optional existing session to start
-   */
-  start(type?: SessionType, session?: ISession): void
-
-  /**
-   * Stop the current session with an optional comment
-   * @param comment - user-provided comment to include in session feedback metadata
-   */
-  stop(comment?: string): Promise<void>
-
-  /**
-   * Cancel the current session
-   */
-  cancel(): Promise<void>
-
-  /**
-   * Pause the current session
-   */
-  pause(): Promise<void>
-
-  /**
-   * Resume the current session
-   */
-  resume(): Promise<void>
-
-  /**
-   * Set the session metadata
-   * @param attributes - the attributes to set
-   */
-  setSessionAttributes(attributes: Record<string, any>): void
-
-  /**
-   * Set a custom click handler for the recording button
-   * @param handler - function that will be invoked when the button is clicked
-   */
-  set recordingButtonClickHandler(handler: () => boolean | void)
-}
-
-export type Breaker = {}
-
-export interface ScreenEvent {
-  screenName: string
-  timestamp: number
-  params?: Record<string, any>
-  type?: string
-  metadata?: Record<string, any>
-  dataUrl?: string
-}
-
-export interface GestureEvent {
-  type: string
-  timestamp: number
-  x?: number
-  y?: number
-  direction?: string
-  target?: string
-  coordinates?: { x: number; y: number }
-  metadata?: Record<string, any>
-}
-
-export interface NavigationEvent {
-  type: string
-  timestamp: number
-  routeName?: string
-  params?: Record<string, any>
-  metadata?: Record<string, any>
-}

package/src/types/session.ts

@@ -1,65 +0,0 @@
-import { SessionType } from '@multiplayer-app/session-recorder-common'
-
-export interface IResourceAttributes {
-  browserInfo?: string,
-  cookiesEnabled?: string,
-  deviceInfo?: string,
-  hardwareConcurrency?: number,
-  osInfo?: string,
-  pixelRatio?: number,
-  screenSize?: string,
-  packageVersion?: string,
-  [key: string]: any
-}
-
-export interface ISessionAttributes {
-  userEmail?: string
-  userId?: string,
-  userName?: string,
-  accountId?: string,
-  accountName?: string,
-  [key: string]: any
-}
-
-export interface ISessionView {
-  _id: string
-  name: string
-  components?: string[]
-}
-
-export interface ISession {
-  _id: string
-  shortId: string
-  workspace: string
-  project: string
-  continuousDebugSession?: string
-  creationType: SessionType
-  name: string
-  startedAt: string | Date
-  stoppedAt: string | Date
-  durationInSeconds?: number
-  createdAt: string | Date
-  updatedAt: string | Date
-  tags: any[]
-
-  resourceAttributes?: IResourceAttributes
-  sessionAttributes?: ISessionAttributes
-  views: ISessionView[]
-  starred: boolean
-  starredItems: string[]
-  s3Files: {
-    _id?: string
-    bucket: string
-    key: string
-    dataType: DebugSessionDataType
-    url?: string
-  }[]
-  finishedS3Transfer?: boolean
-  tempApiKey?: string
-}
-
-export enum DebugSessionDataType {
-  OTLP_TRACES = 'OTLP_TRACES',
-  OTLP_LOGS = 'OTLP_LOGS',
-  RRWEB_EVENTS = 'RRWEB_EVENTS',
-}

package/src/utils/app-metadata.ts

@@ -1,31 +0,0 @@
-/**
- * Auto-generated app metadata
- * This file is generated at build time to provide app metadata without developer intervention
- */
-
-// This file is automatically generated by the build process
-// It extracts metadata from app.json, app.config.js, or package.json
-
-export interface AppMetadata {
-  name?: string
-  version?: string
-  bundleId?: string
-  buildNumber?: string
-  displayName?: string
-}
-
-// Auto-detected values from project configuration files
-export const APP_METADATA: AppMetadata = {
-  name: "@multiplayer-app/session-recorder-react-native",
-  version: "0.0.1",
-  bundleId: undefined,
-  buildNumber: undefined,
-  displayName: undefined,
-}
-
-/**
- * Get auto-detected app metadata
- */
-export function getAutoDetectedAppMetadata(): AppMetadata {
-  return { ...APP_METADATA }
-}

package/src/utils/index.ts

@@ -1,8 +0,0 @@
-// Export all utility functions
-export * from './platform'
-export * from './session'
-export * from './time'
-export * from './type-utils'
-export * from './request-utils'
-export * from './rrweb-events'
-export * from './logger'