@code-pushup/utils 0.103.0 → 0.105.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -44,7 +44,7 @@ export type EntryMeta = {
44
44
  properties?: DevToolsProperties;
45
45
  };
46
46
  /**
47
- * Styling options for track entries in DevTools.
47
+ * Styling options for track entries and marker in DevTools.
48
48
  * @property {DevToolsColor} [color] - rendered color of background and border, defaults to "primary"
49
49
  */
50
50
  export type TrackStyle = {
@@ -53,7 +53,7 @@ export type TrackStyle = {
53
53
  /**
54
54
  * Metadata for organizing track entries in DevTools.
55
55
  * @property {string} track - Name of the custom track
56
- * @property {string} [trackGroup] - Group for organizing tracks
56
+ * @property {string} [trackGroup] - Group for organizing tracks.
57
57
  */
58
58
  export type TrackMeta = {
59
59
  track: string;
@@ -88,6 +88,21 @@ export type WithErrorColor<T extends {
88
88
  }> = Omit<T, 'color'> & {
89
89
  color: 'error';
90
90
  };
91
+ /**
92
+ * Action color payload.
93
+ * @param color - The color of the action
94
+ * @returns The action color payload
95
+ */
96
+ export type ActionColorPayload = {
97
+ color?: DevToolsActionColor;
98
+ };
99
+ /**
100
+ * Action track payload.
101
+ * @param TrackEntryPayload - The track entry payload
102
+ * @param ActionColorPayload - The action color payload
103
+ * @returns The action track payload
104
+ */
105
+ export type ActionTrackEntryPayload = TrackEntryPayload & ActionColorPayload;
91
106
  /**
92
107
  * Utility type that adds an optional devtools payload property.
93
108
  */
@@ -126,3 +141,9 @@ export type MarkOptionsWithDevtools<T extends TrackEntryPayload | MarkerPayload>
126
141
  export type MeasureOptionsWithDevtools<T extends TrackEntryPayload> = {
127
142
  detail?: WithDevToolsPayload<T>;
128
143
  } & Omit<MeasureOptions, 'detail'>;
144
+ /**
145
+ * Detail object containing DevTools payload for user timing events.
146
+ * Extends WithDevToolsPayload to include track entry or marker payload.
147
+ * This can be used in trace event arguments to provide additional context in DevTools.
148
+ */
149
+ export type UserTimingDetail = WithDevToolsPayload<TrackEntryPayload | MarkerPayload>;
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=sink-source.types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"sink-source.types.js","sourceRoot":"","sources":["../../../src/lib/sink-source.types.ts"],"names":[],"mappings":""}