Skip to content

Make view optional in the RUM common schema #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gh-worker-dd-mergequeue-cf854d merged 1 commit into from
Aug 5, 2026
Merged

Make view optional in the RUM common schema #421

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions lib/cjs/generated/rum.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export type RumActionEvent = CommonProperties & ViewContainerSchema & {
/**
* View properties
*/
readonly view?: {
readonly view: {
/**
* Is the action starting in the foreground (focus in browser)
*/
Expand Down Expand Up @@ -167,6 +167,9 @@ export type RumTransitionEvent = CommonProperties & {
* RUM event type
*/
readonly type: 'transition';
readonly view: {
[k: string]: unknown;
};
/**
* Stream properties
*/
Expand Down Expand Up @@ -447,7 +450,7 @@ export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewConta
/**
* View properties
*/
readonly view?: {
readonly view: {
/**
* Is the error starting in the foreground (focus in browser)
*/
Expand Down Expand Up @@ -494,6 +497,9 @@ export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewCo
* RUM event type
*/
readonly type: 'long_task';
readonly view: {
[k: string]: unknown;
};
/**
* Long Task properties
*/
Expand Down Expand Up @@ -624,6 +630,9 @@ export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewCo
* RUM event type
*/
readonly type: 'resource';
readonly view: {
[k: string]: unknown;
};
/**
* Resource properties
*/
Expand Down Expand Up @@ -881,6 +890,9 @@ export type RumViewUpdateEvent = ViewContainerSchema & StreamSchema & ViewProper
* RUM event type
*/
readonly type: 'view_update';
readonly view: {
[k: string]: unknown;
};
[k: string]: unknown;
};
export type RumVitalEvent = RumVitalDurationEvent | RumVitalOperationStepEvent | RumVitalAppLaunchEvent;
Expand Down Expand Up @@ -912,6 +924,9 @@ export type RumVitalEventCommonProperties = CommonProperties & ViewContainerSche
* RUM event type
*/
readonly type: 'vital';
readonly view: {
[k: string]: unknown;
};
/**
* Vital properties
*/
Expand Down Expand Up @@ -1073,7 +1088,7 @@ export interface CommonProperties {
/**
* View properties
*/
readonly view: {
readonly view?: {
/**
* UUID of the view
*/
Expand Down
21 changes: 18 additions & 3 deletions lib/esm/generated/rum.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ export type RumActionEvent = CommonProperties & ViewContainerSchema & {
/**
* View properties
*/
readonly view?: {
readonly view: {
/**
* Is the action starting in the foreground (focus in browser)
*/
Expand Down Expand Up @@ -167,6 +167,9 @@ export type RumTransitionEvent = CommonProperties & {
* RUM event type
*/
readonly type: 'transition';
readonly view: {
[k: string]: unknown;
};
/**
* Stream properties
*/
Expand Down Expand Up @@ -447,7 +450,7 @@ export type RumErrorEvent = CommonProperties & ActionChildProperties & ViewConta
/**
* View properties
*/
readonly view?: {
readonly view: {
/**
* Is the error starting in the foreground (focus in browser)
*/
Expand Down Expand Up @@ -494,6 +497,9 @@ export type RumLongTaskEvent = CommonProperties & ActionChildProperties & ViewCo
* RUM event type
*/
readonly type: 'long_task';
readonly view: {
[k: string]: unknown;
};
/**
* Long Task properties
*/
Expand Down Expand Up @@ -624,6 +630,9 @@ export type RumResourceEvent = CommonProperties & ActionChildProperties & ViewCo
* RUM event type
*/
readonly type: 'resource';
readonly view: {
[k: string]: unknown;
};
/**
* Resource properties
*/
Expand Down Expand Up @@ -881,6 +890,9 @@ export type RumViewUpdateEvent = ViewContainerSchema & StreamSchema & ViewProper
* RUM event type
*/
readonly type: 'view_update';
readonly view: {
[k: string]: unknown;
};
[k: string]: unknown;
};
export type RumVitalEvent = RumVitalDurationEvent | RumVitalOperationStepEvent | RumVitalAppLaunchEvent;
Expand Down Expand Up @@ -912,6 +924,9 @@ export type RumVitalEventCommonProperties = CommonProperties & ViewContainerSche
* RUM event type
*/
readonly type: 'vital';
readonly view: {
[k: string]: unknown;
};
/**
* Vital properties
*/
Expand Down Expand Up @@ -1073,7 +1088,7 @@ export interface CommonProperties {
/**
* View properties
*/
readonly view: {
readonly view?: {
/**
* UUID of the view
*/
Expand Down
2 changes: 1 addition & 1 deletion schemas/rum/_common-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"title": "CommonProperties",
"type": "object",
"description": "Schema of common properties of RUM events",
"required": ["date", "application", "session", "view", "_dd"],
"required": ["date", "application", "session", "_dd"],
"properties": {
"date": {
"type": "integer",
Expand Down
6 changes: 5 additions & 1 deletion schemas/rum/_vital-common-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@
"$ref": "_view-container-schema.json"
},
{
"required": ["type", "vital"],
"required": ["type", "view", "vital"],
"properties": {
"type": {
"type": "string",
"description": "RUM event type",
"const": "vital",
"readOnly": true
},
"view": {
"type": "object",
"readOnly": true
},
"vital": {
"type": "object",
"description": "Vital properties",
Expand Down
2 changes: 1 addition & 1 deletion schemas/rum/action-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"$ref": "_view-container-schema.json"
},
{
"required": ["type", "action"],
"required": ["type", "view", "action"],
"properties": {
"type": {
"type": "string",
Expand Down
2 changes: 1 addition & 1 deletion schemas/rum/error-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"$ref": "_view-container-schema.json"
},
{
"required": ["type", "error"],
"required": ["type", "view", "error"],
"properties": {
"type": {
"type": "string",
Expand Down
6 changes: 5 additions & 1 deletion schemas/rum/long_task-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,18 @@
"$ref": "_view-container-schema.json"
},
{
"required": ["type", "long_task"],
"required": ["type", "view", "long_task"],
"properties": {
"type": {
"type": "string",
"description": "RUM event type",
"const": "long_task",
"readOnly": true
},
"view": {
"type": "object",
"readOnly": true
},
"long_task": {
"type": "object",
"description": "Long Task properties",
Expand Down
6 changes: 5 additions & 1 deletion schemas/rum/resource-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,18 @@
"$ref": "_view-container-schema.json"
},
{
"required": ["type", "resource"],
"required": ["type", "view", "resource"],
"properties": {
"type": {
"type": "string",
"description": "RUM event type",
"const": "resource",
"readOnly": true
},
"view": {
"type": "object",
"readOnly": true
},
"resource": {
"type": "object",
"description": "Resource properties",
Expand Down
6 changes: 5 additions & 1 deletion schemas/rum/transition-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@
"$ref": "_common-schema.json"
},
{
"required": ["type", "transition", "stream"],
"required": ["type", "view", "transition", "stream"],
"properties": {
"type": {
"type": "string",
"description": "RUM event type",
"const": "transition",
"readOnly": true
},
"view": {
"type": "object",
"readOnly": true
},
"stream": {
"type": "object",
"description": "Stream properties",
Expand Down
6 changes: 5 additions & 1 deletion schemas/rum/view_update-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,17 @@
"$ref": "_common-schema.json"
},
{
"required": ["type"],
"required": ["type", "view"],
"properties": {
"type": {
"type": "string",
"description": "RUM event type",
"const": "view_update",
"readOnly": true
},
"view": {
"type": "object",
"readOnly": true
}
}
}
Expand Down
Loading