Refactor RUM Vital event schema to only allow app_launch Vital to have optional view

Author: thomas-lebeau

lib/cjs/generated/rum.d.ts

@@ -1232,34 +1232,22 @@ export declare type RumViewEvent = CommonProperties & ViewContainerSchema & Stre
 /**
  * Schema of all properties of a Vital event
  */
-export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
+export declare type RumVitalEvent = (CommonProperties & ViewContainerSchema & VitalCommonInternalProperties & {
     /**
      * RUM event type
      */
     readonly type: 'vital';
-    readonly vital: DurationProperties | AppLaunchProperties | FeatureOperationProperties;
+    readonly vital: DurationProperties | FeatureOperationProperties;
+    [k: string]: unknown;
+}) | (CommonProperties & ViewContainerSchema & VitalCommonInternalProperties & {
     /**
-     * Internal properties
+     * RUM event type
      */
-    readonly _dd?: {
-        /**
-         * Internal vital properties
-         */
-        readonly vital?: {
-            /**
-             * Whether the value of the vital is computed by the SDK (as opposed to directly provided by the customer)
-             */
-            readonly computed_value?: boolean;
-            [k: string]: unknown;
-        };
-        /**
-         * Profiling context
-         */
-        profiling?: ProfilingInternalContextSchema;
-        [k: string]: unknown;
-    };
+    readonly type: 'vital';
+    readonly vital: AppLaunchProperties;
+    readonly view?: View;
     [k: string]: unknown;
-};
+});
 /**
  * Duration properties of a Vital event
  */
@@ -1292,6 +1280,28 @@ export declare type VitalCommonProperties = {
     readonly description?: string;
     [k: string]: unknown;
 };
+/**
+ * Schema for a feature operation.
+ */
+export declare type FeatureOperationProperties = VitalCommonProperties & {
+    /**
+     * Type of the vital.
+     */
+    readonly type: 'operation_step';
+    /**
+     * Optional key to distinguish between multiple operations of the same name running in parallel (e.g., 'photo_upload' with keys 'profile_pic' vs 'cover')
+     */
+    readonly operation_key?: string;
+    /**
+     * Type of the step that triggered the vital, if applicable
+     */
+    readonly step_type?: 'start' | 'update' | 'retry' | 'end';
+    /**
+     * Reason for the failure of the step, if applicable
+     */
+    readonly failure_reason?: 'error' | 'abandoned' | 'other';
+    [k: string]: unknown;
+};
 /**
  * Schema for app launch metrics.
  */
@@ -1322,28 +1332,6 @@ export declare type AppLaunchProperties = VitalCommonProperties & {
     readonly has_saved_instance_state_bundle?: boolean;
     [k: string]: unknown;
 };
-/**
- * Schema for a feature operation.
- */
-export declare type FeatureOperationProperties = VitalCommonProperties & {
-    /**
-     * Type of the vital.
-     */
-    readonly type: 'operation_step';
-    /**
-     * Optional key to distinguish between multiple operations of the same name running in parallel (e.g., 'photo_upload' with keys 'profile_pic' vs 'cover')
-     */
-    readonly operation_key?: string;
-    /**
-     * Type of the step that triggered the vital, if applicable
-     */
-    readonly step_type?: 'start' | 'update' | 'retry' | 'end';
-    /**
-     * Reason for the failure of the step, if applicable
-     */
-    readonly failure_reason?: 'error' | 'abandoned' | 'other';
-    [k: string]: unknown;
-};
 /**
  * Schema of common properties of RUM events
  */
@@ -1408,28 +1396,7 @@ export interface CommonProperties {
      * The source of this event
      */
     readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform';
-    /**
-     * View properties
-     */
-    readonly view?: {
-        /**
-         * UUID of the view
-         */
-        readonly id: string;
-        /**
-         * URL that linked to the initial view of the page
-         */
-        referrer?: string;
-        /**
-         * URL of the view
-         */
-        url: string;
-        /**
-         * User defined name of the view
-         */
-        name?: string;
-        [k: string]: unknown;
-    };
+    readonly view?: View;
     /**
      * User properties
      */
@@ -1686,6 +1653,28 @@ export interface CommonProperties {
     };
     [k: string]: unknown;
 }
+/**
+ * View properties
+ */
+export interface View {
+    /**
+     * UUID of the view
+     */
+    readonly id: string;
+    /**
+     * URL that linked to the initial view of the page
+     */
+    referrer?: string;
+    /**
+     * URL of the view
+     */
+    url: string;
+    /**
+     * User defined name of the view
+     */
+    name?: string;
+    [k: string]: unknown;
+}
 /**
  * View Container schema for views that are nested (webviews in mobile)
  */
@@ -2043,3 +2032,29 @@ export interface ViewAccessibilityProperties {
     readonly rtl_enabled?: boolean;
     [k: string]: unknown;
 }
+/**
+ * Common internal properties for vital events
+ */
+export interface VitalCommonInternalProperties {
+    /**
+     * Internal properties
+     */
+    readonly _dd?: {
+        /**
+         * Internal vital properties
+         */
+        readonly vital?: {
+            /**
+             * Whether the value of the vital is computed by the SDK (as opposed to directly provided by the customer)
+             */
+            readonly computed_value?: boolean;
+            [k: string]: unknown;
+        };
+        /**
+         * Profiling context
+         */
+        profiling?: ProfilingInternalContextSchema;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}

lib/esm/generated/rum.d.ts

@@ -1232,34 +1232,22 @@ export declare type RumViewEvent = CommonProperties & ViewContainerSchema & Stre
 /**
  * Schema of all properties of a Vital event
  */
-export declare type RumVitalEvent = CommonProperties & ViewContainerSchema & {
+export declare type RumVitalEvent = (CommonProperties & ViewContainerSchema & VitalCommonInternalProperties & {
     /**
      * RUM event type
      */
     readonly type: 'vital';
-    readonly vital: DurationProperties | AppLaunchProperties | FeatureOperationProperties;
+    readonly vital: DurationProperties | FeatureOperationProperties;
+    [k: string]: unknown;
+}) | (CommonProperties & ViewContainerSchema & VitalCommonInternalProperties & {
     /**
-     * Internal properties
+     * RUM event type
      */
-    readonly _dd?: {
-        /**
-         * Internal vital properties
-         */
-        readonly vital?: {
-            /**
-             * Whether the value of the vital is computed by the SDK (as opposed to directly provided by the customer)
-             */
-            readonly computed_value?: boolean;
-            [k: string]: unknown;
-        };
-        /**
-         * Profiling context
-         */
-        profiling?: ProfilingInternalContextSchema;
-        [k: string]: unknown;
-    };
+    readonly type: 'vital';
+    readonly vital: AppLaunchProperties;
+    readonly view?: View;
     [k: string]: unknown;
-};
+});
 /**
  * Duration properties of a Vital event
  */
@@ -1292,6 +1280,28 @@ export declare type VitalCommonProperties = {
     readonly description?: string;
     [k: string]: unknown;
 };
+/**
+ * Schema for a feature operation.
+ */
+export declare type FeatureOperationProperties = VitalCommonProperties & {
+    /**
+     * Type of the vital.
+     */
+    readonly type: 'operation_step';
+    /**
+     * Optional key to distinguish between multiple operations of the same name running in parallel (e.g., 'photo_upload' with keys 'profile_pic' vs 'cover')
+     */
+    readonly operation_key?: string;
+    /**
+     * Type of the step that triggered the vital, if applicable
+     */
+    readonly step_type?: 'start' | 'update' | 'retry' | 'end';
+    /**
+     * Reason for the failure of the step, if applicable
+     */
+    readonly failure_reason?: 'error' | 'abandoned' | 'other';
+    [k: string]: unknown;
+};
 /**
  * Schema for app launch metrics.
  */
@@ -1322,28 +1332,6 @@ export declare type AppLaunchProperties = VitalCommonProperties & {
     readonly has_saved_instance_state_bundle?: boolean;
     [k: string]: unknown;
 };
-/**
- * Schema for a feature operation.
- */
-export declare type FeatureOperationProperties = VitalCommonProperties & {
-    /**
-     * Type of the vital.
-     */
-    readonly type: 'operation_step';
-    /**
-     * Optional key to distinguish between multiple operations of the same name running in parallel (e.g., 'photo_upload' with keys 'profile_pic' vs 'cover')
-     */
-    readonly operation_key?: string;
-    /**
-     * Type of the step that triggered the vital, if applicable
-     */
-    readonly step_type?: 'start' | 'update' | 'retry' | 'end';
-    /**
-     * Reason for the failure of the step, if applicable
-     */
-    readonly failure_reason?: 'error' | 'abandoned' | 'other';
-    [k: string]: unknown;
-};
 /**
  * Schema of common properties of RUM events
  */
@@ -1408,28 +1396,7 @@ export interface CommonProperties {
      * The source of this event
      */
     readonly source?: 'android' | 'ios' | 'browser' | 'flutter' | 'react-native' | 'roku' | 'unity' | 'kotlin-multiplatform';
-    /**
-     * View properties
-     */
-    readonly view?: {
-        /**
-         * UUID of the view
-         */
-        readonly id: string;
-        /**
-         * URL that linked to the initial view of the page
-         */
-        referrer?: string;
-        /**
-         * URL of the view
-         */
-        url: string;
-        /**
-         * User defined name of the view
-         */
-        name?: string;
-        [k: string]: unknown;
-    };
+    readonly view?: View;
     /**
      * User properties
      */
@@ -1686,6 +1653,28 @@ export interface CommonProperties {
     };
     [k: string]: unknown;
 }
+/**
+ * View properties
+ */
+export interface View {
+    /**
+     * UUID of the view
+     */
+    readonly id: string;
+    /**
+     * URL that linked to the initial view of the page
+     */
+    referrer?: string;
+    /**
+     * URL of the view
+     */
+    url: string;
+    /**
+     * User defined name of the view
+     */
+    name?: string;
+    [k: string]: unknown;
+}
 /**
  * View Container schema for views that are nested (webviews in mobile)
  */
@@ -2043,3 +2032,29 @@ export interface ViewAccessibilityProperties {
     readonly rtl_enabled?: boolean;
     [k: string]: unknown;
 }
+/**
+ * Common internal properties for vital events
+ */
+export interface VitalCommonInternalProperties {
+    /**
+     * Internal properties
+     */
+    readonly _dd?: {
+        /**
+         * Internal vital properties
+         */
+        readonly vital?: {
+            /**
+             * Whether the value of the vital is computed by the SDK (as opposed to directly provided by the customer)
+             */
+            readonly computed_value?: boolean;
+            [k: string]: unknown;
+        };
+        /**
+         * Profiling context
+         */
+        profiling?: ProfilingInternalContextSchema;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}