@code-pushup/utils 0.103.0 → 0.104.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.103.0",
+  "version": "0.104.0",
   "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/utils#readme",
@@ -27,7 +27,7 @@
     "node": ">=17.0.0"
   },
   "dependencies": {
-    "@code-pushup/models": "0.103.0",
+    "@code-pushup/models": "0.104.0",
     "ansis": "^3.3.0",
     "build-md": "^0.4.2",
     "bundle-require": "^5.1.0",

package/src/lib/performance-observer.d.ts

@@ -1,5 +1,5 @@
 import { type PerformanceEntry } from 'node:perf_hooks';
-import type { Buffered, Encoder, Observer, Sink } from './sink-source.types.js';
+import type { Buffered, Encoder, Observer, Sink } from './sink-source.type';
 export declare const DEFAULT_FLUSH_THRESHOLD = 20;
 export type PerformanceObserverOptions<T> = {
     sink: Sink<T, unknown>;

package/src/lib/sink-source.type.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sink-source.type.js.map

package/src/lib/sink-source.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sink-source.type.js","sourceRoot":"","sources":["../../../src/lib/sink-source.type.ts"],"names":[],"mappings":""}

package/src/lib/user-timing-extensibility-api-utils.d.ts

@@ -1,11 +1,44 @@
-import type { DevToolsColor, DevToolsProperties, MarkOptionsWithDevtools, MarkerPayload, MeasureOptionsWithDevtools, TrackEntryPayload } from './user-timing-extensibility-api.type.js';
-export declare function mergePropertiesWithOverwrite(baseProperties: DevToolsProperties | undefined, overrideProperties?: DevToolsProperties | undefined): [string, string | number | boolean | object | undefined][];
+import type { ActionTrackEntryPayload, DevToolsColor, DevToolsProperties, EntryMeta, MarkOptionsWithDevtools, MarkerPayload, MeasureOptionsWithDevtools, TrackEntryPayload } from './user-timing-extensibility-api.type.js';
+/**
+ * Merges DevTools properties with override priority.
+ * @param baseProperties - Base properties array
+ * @param overrideProperties - Override properties array
+ * @returns Merged properties array
+ */
+export declare function mergePropertiesWithOverwrite<const T extends DevToolsProperties, const U extends DevToolsProperties>(baseProperties: T, overrideProperties: U): (T[number] | U[number])[];
+export declare function mergePropertiesWithOverwrite<const T extends DevToolsProperties>(baseProperties: T): T;
+/**
+ * Creates a marker payload with default data type.
+ * @param options - Marker options excluding dataType
+ * @returns Complete marker payload
+ * @example
+ * const payload = markerPayload({
+ *   color: 'primary',
+ *   tooltipText: 'User action completed',
+ *   properties: [['action', 'save'], ['duration', 150]]
+ * });
+ * // { dataType: 'marker', color: 'primary', tooltipText: 'User action completed', ... }
+ */
 export declare function markerPayload(options?: Omit<MarkerPayload, 'dataType'>): {
     color?: DevToolsColor;
     tooltipText?: string;
     properties?: DevToolsProperties;
     dataType: "marker";
 };
+/**
+ * Creates a track entry payload with default data type.
+ * @param options - Track entry options excluding dataType
+ * @returns Complete track entry payload
+ * @example
+ * const payload = trackEntryPayload({
+ *   track: 'user-interactions',
+ *   trackGroup: 'frontend',
+ *   color: 'secondary',
+ *   tooltipText: 'Button click processed',
+ *   properties: [['element', 'save-button'], ['response-time', 200]]
+ * });
+ * // { dataType: 'track-entry', track: 'user-interactions', ... }
+ */
 export declare function trackEntryPayload(options: Omit<TrackEntryPayload, 'dataType'>): {
     color?: DevToolsColor | undefined;
     tooltipText?: string | undefined;
@@ -14,59 +47,273 @@ export declare function trackEntryPayload(options: Omit<TrackEntryPayload, 'data
     dataType: "track-entry";
     track: string;
 };
+/**
+ * Creates an error marker payload with red color.
+ * @param options - Marker options excluding dataType and color
+ * @returns Error marker payload
+ */
 export declare function markerErrorPayload<T extends DevToolsColor>(options?: Omit<MarkerPayload, 'dataType' | 'color'>): {
     tooltipText?: string;
     properties?: DevToolsProperties;
     dataType: "marker";
     color: T;
 };
-export declare function trackEntryErrorPayload<T extends string, C extends DevToolsColor>(options: Omit<TrackEntryPayload, 'color' | 'dataType'> & {
+/**
+ * Creates an error track entry payload with red color.
+ * @param options - Track entry options excluding color and dataType
+ * @returns Error track entry payload
+ */
+export declare function trackEntryErrorPayload<T extends string>(options: Omit<TrackEntryPayload, 'color' | 'dataType'> & {
     track: T;
-    color?: C;
 }): {
     tooltipText?: string | undefined;
     properties?: DevToolsProperties | undefined;
     trackGroup?: string | undefined;
     dataType: "track-entry";
-    color: DevToolsColor;
+    color: "error";
     track: T;
 };
+/**
+ * Converts an error to DevTools properties array.
+ * @param e - Error object or value
+ * @returns Array of error properties for DevTools
+ */
 export declare function errorToDevToolsProperties(e: unknown): (["Error Type", string] | ["Error Message", string])[];
+/**
+ * Converts an error to entry metadata for DevTools.
+ * @param e - Error object or value
+ * @param options - Additional metadata options
+ * @returns Entry metadata with error properties
+ */
 export declare function errorToEntryMeta(e: unknown, options?: {
     tooltipText?: string;
     properties?: DevToolsProperties;
 }): {
     tooltipText?: string | undefined;
-    properties: [string, string | number | boolean | object | undefined][];
+    properties: ([key: string, value: string | number | boolean | object | undefined] | ["Error Type", string] | ["Error Message", string])[];
 };
+/**
+ * Converts an error to a track entry payload with error styling.
+ * @param error - Error object or value
+ * @param detail - Track entry details excluding color and dataType
+ * @returns Error track entry payload
+ */
 export declare function errorToTrackEntryPayload<T extends string>(error: unknown, detail: Omit<TrackEntryPayload, 'color' | 'dataType'> & {
     track: T;
 }): {
     tooltipText?: string | undefined;
-    properties: [string, string | number | boolean | object | undefined][];
+    properties: ([key: string, value: string | number | boolean | object | undefined] | ["Error Type", string] | ["Error Message", string])[];
     track: T;
     trackGroup?: string | undefined;
     dataType: "track-entry";
     color: "error";
 };
+/**
+ * Converts an error to a marker payload with error styling.
+ * @param error - Error object or value
+ * @param detail - Marker details excluding color and dataType
+ * @returns Error marker payload
+ */
 export declare function errorToMarkerPayload(error: unknown, detail?: Omit<MarkerPayload, 'color' | 'dataType'>): {
     tooltipText?: string | undefined;
-    properties: [string, string | number | boolean | object | undefined][];
+    properties: ([key: string, value: string | number | boolean | object | undefined] | ["Error Type", string] | ["Error Message", string])[];
     dataType: "marker";
     color: "error";
 };
 /**
- * asOptions wraps a DevTools payload into the `detail` property of User Timing entry options.
- *
+ * Converts DevTools payload to performance API options format.
+ * @param devtools - DevTools payload or null
+ * @returns Performance API options with DevTools detail
  * @example
- * profiler.mark('mark', asOptions({
- *   dataType: 'marker',
- *   color: 'error',
- *   tooltipText: 'This is a marker',
- *   properties: [
- *     ['str', 'This is a detail property']
- *   ],
- * }));
+ * const marker = markerPayload({ color: 'primary', tooltipText: 'Start' });
+ * performance.mark('start', asOptions(marker));
+ *
+ * const trackEntry = trackEntryPayload({ track: 'operations', color: 'tertiary' });
+ * performance.measure('operation', {
+ *   start: 'start',
+ *   end: 'end',
+ *   ...asOptions(trackEntry)
+ * });
  */
 export declare function asOptions<T extends MarkerPayload>(devtools?: T | null): MarkOptionsWithDevtools<T>;
 export declare function asOptions<T extends TrackEntryPayload>(devtools?: T | null): MeasureOptionsWithDevtools<T>;
+/**
+ * Generates start, end, and measure names for performance tracking.
+ * @param base - Base name for the measurement
+ * @returns Object with startName, endName, and measureName
+ */
+export type Names<N extends string> = {
+    startName: `${N}:start`;
+    endName: `${N}:end`;
+    measureName: N;
+};
+/**
+ * Generates start, end, and measure names for performance tracking.
+ * @param base - Base name for the measurement
+ * @param prefix - Optional prefix for names
+ * @returns Object with startName, endName, and measureName
+ */
+export declare function getNames<T extends string>(base: T): Names<T>;
+export declare function getNames<T extends string, P extends string>(base: T, prefix?: P): Names<`${P}:${T}`>;
+/**
+ * Removes undefined from a type, effectively filtering out undefined values.
+ */
+type Defined<T> = T extends undefined ? never : T;
+/**
+ * Merges two objects with the specified overwrite semantics:
+ * - If B[K] is undefined → keep A[K]
+ * - If B[K] is defined → overwrite with Defined<B[K]>
+ * - Keys only in A → keep A[K]
+ * - Keys only in B → take Defined<B[K]>
+ */
+type MergeDefined<A, B> = {
+    [K in keyof A | keyof B]: K extends keyof B ? Defined<B[K]> extends never ? K extends keyof A ? A[K] : never : Defined<B[K]> : K extends keyof A ? A[K] : never;
+};
+/**
+ * Recursively merges an array of objects using MergeDefined semantics.
+ * The first element is the base type, subsequent elements only overwrite with defined values.
+ */
+type MergeResult<P extends readonly unknown[]> = P extends readonly [
+    infer A,
+    ...infer R
+] ? MergeDefined<A & {}, MergeResult<R>> : object;
+/**
+ * Merges multiple DevTools payloads into a single payload.
+ * The first payload establishes the base type, subsequent payloads only overwrite with defined values.
+ * @param parts - Array of payloads where first is complete and rest are partial
+ * @returns Merged payload with combined properties
+ * @example
+ * const payload = mergeDevtoolsPayload(
+ *   trackEntryPayload({ track: 'user-interactions', color: 'secondary' }),
+ *   { color: 'primary', tooltipText: 'User action completed' },
+ * );
+ * // { track: 'user-interactions', color: 'primary', tooltipText: 'User action completed' }
+ */
+export declare function mergeDevtoolsPayload<const P extends readonly [
+    TrackEntryPayload | MarkerPayload,
+    ...Partial<TrackEntryPayload | MarkerPayload>[]
+]>(...parts: P): MergeResult<P> & {
+    properties?: DevToolsProperties;
+};
+/**
+ * Sets up tracks with default values merged into each track.
+ * This helps to avoid repetition when defining multiple tracks with common properties.
+ * @param defaults - Default action track configuration
+ * @param tracks - Track configurations to merge with defaults
+ * @returns Record with merged track configurations
+ */
+export declare function setupTracks<const T extends Record<string, Partial<ActionTrackEntryPayload>>, const D extends ActionTrackEntryPayload>(defaults: D, tracks: T): Record<keyof T, MergeDefined<D & {}, MergeDefined<T[keyof T] & {}, object>> & {
+    properties?: DevToolsProperties;
+}>;
+/**
+ * Options for customizing measurement behavior and callbacks.
+ * Extends partial ActionTrackEntryPayload to allow overriding default track properties.
+ */
+export type MeasureOptions = Partial<ActionTrackEntryPayload> & {
+    /**
+     * Callback invoked when measurement completes successfully.
+     * @param result - The successful result value
+     * @returns Additional DevTools properties to merge for success state
+     */
+    success?: (result: unknown) => Partial<ActionTrackEntryPayload>;
+    /**
+     * Callback invoked when measurement fails with an error.
+     * @param error - The error that occurred
+     * @returns Additional DevTools properties to merge for error state
+     */
+    error?: (error: unknown) => Partial<ActionTrackEntryPayload>;
+};
+/**
+ * Configuration for creating a measurement context.
+ * Defines default behavior and appearance for all measurements in this context.
+ */
+export type MeasureCtxOptions = ActionTrackEntryPayload & {
+    /**
+     * Optional prefix for all measurement names to avoid conflicts.
+     * @example "api:" results in names like "api:request:start"
+     */
+    prefix?: string;
+} & {
+    /**
+     * Global error handler for all measurements in this context.
+     * Applied to all error states in addition to per-measurement error callbacks.
+     * @param error - The error that occurred
+     * @returns Additional DevTools metadata for error display
+     */
+    error?: (error: unknown) => EntryMeta;
+};
+/**
+ * Creates a measurement context for tracking performance events with consistent DevTools visualization.
+ *
+ * This function returns a higher-order function that generates measurement controllers for individual events.
+ * Each measurement creates start/end marks and a final measure in Chrome DevTools Performance panel.
+ *
+ * @param cfg - Configuration defining default track properties, optional prefix, and global error handling
+ * @returns Function that creates measurement controllers for specific events
+ * @example
+ * // Basic usage with defaults
+ * const measure = measureCtx({
+ *   track: 'api-calls',
+ *   color: 'secondary',
+ *   trackGroup: 'backend'
+ * });
+ *
+ * const { start, success, error } = measure('fetch-user');
+ * start(); // Creates "fetch-user:start" mark
+ * // ... async operation ...
+ * success({ userCount: 42 }); // Creates "fetch-user:end" mark and "fetch-user" measure
+ * @example
+ * // Advanced usage with callbacks and error handling
+ * const measure = measureCtx({
+ *   track: 'user-actions',
+ *   color: 'primary',
+ *   error: (err) => ({
+ *     properties: [['error-type', err.name], ['error-message', err.message]]
+ *   })
+ * });
+ *
+ * const { start, success, error } = measure('save-form', {
+ *   success: (result) => ({
+ *     properties: [['items-saved', result.count]],
+ *     tooltipText: `Saved ${result.count} items successfully`
+ *   }),
+ *   error: (err) => ({
+ *     properties: [['validation-errors', err.errors?.length ?? 0]]
+ *   })
+ * });
+ *
+ * start();
+ * try {
+ *   const result = await saveFormData(formData);
+ *   success(result);
+ * } catch (err) {
+ *   error(err); // Applies both global and specific error metadata
+ * }
+ * @example
+ * // onetime config of defaults
+ * const apiMeasure = measureCtx({
+ *   prefix: 'http:',
+ *   track: 'api',
+ * });
+ *
+ * const { start, success, error } = apiMeasure('login');
+ *
+ * start();
+ * try {
+ *   const result = myWork();
+ *   success(result);
+ *   return result;
+ * } catch(err) {
+ *   error(err)
+ * }
+ * @returns Object with measurement control methods:
+ * - `start()`: Marks the beginning of the measurement
+ * - `success(result?)`: Completes successful measurement with optional result metadata
+ * - `error(error)`: Completes failed measurement with error metadata
+ */
+export declare function measureCtx(cfg: MeasureCtxOptions): (event: string, opt?: MeasureOptions) => {
+    start: () => import("perf_hooks").PerformanceMark;
+    success: (r: unknown) => void;
+    error: (err: unknown) => void;
+};
+export {};

package/src/lib/user-timing-extensibility-api-utils.js

@@ -1,16 +1,42 @@
+import { performance } from 'node:perf_hooks';
+import { objectFromEntries, objectToEntries } from './transform.js';
 const dataTypeTrackEntry = 'track-entry';
 const dataTypeMarker = 'marker';
 export function mergePropertiesWithOverwrite(baseProperties, overrideProperties) {
-    return [
-        ...new Map([...(baseProperties ?? []), ...(overrideProperties ?? [])]),
-    ];
+    return [...new Map([...baseProperties, ...(overrideProperties ?? [])])];
 }
+/**
+ * Creates a marker payload with default data type.
+ * @param options - Marker options excluding dataType
+ * @returns Complete marker payload
+ * @example
+ * const payload = markerPayload({
+ *   color: 'primary',
+ *   tooltipText: 'User action completed',
+ *   properties: [['action', 'save'], ['duration', 150]]
+ * });
+ * // { dataType: 'marker', color: 'primary', tooltipText: 'User action completed', ... }
+ */
 export function markerPayload(options) {
     return {
         dataType: dataTypeMarker,
         ...options,
     };
 }
+/**
+ * Creates a track entry payload with default data type.
+ * @param options - Track entry options excluding dataType
+ * @returns Complete track entry payload
+ * @example
+ * const payload = trackEntryPayload({
+ *   track: 'user-interactions',
+ *   trackGroup: 'frontend',
+ *   color: 'secondary',
+ *   tooltipText: 'Button click processed',
+ *   properties: [['element', 'save-button'], ['response-time', 200]]
+ * });
+ * // { dataType: 'track-entry', track: 'user-interactions', ... }
+ */
 export function trackEntryPayload(options) {
     const { track, ...rest } = options;
     return {
@@ -19,6 +45,11 @@ export function trackEntryPayload(options) {
         ...rest,
     };
 }
+/**
+ * Creates an error marker payload with red color.
+ * @param options - Marker options excluding dataType and color
+ * @returns Error marker payload
+ */
 export function markerErrorPayload(options) {
     return {
         dataType: dataTypeMarker,
@@ -26,15 +57,25 @@ export function markerErrorPayload(options) {
         ...options,
     };
 }
+/**
+ * Creates an error track entry payload with red color.
+ * @param options - Track entry options excluding color and dataType
+ * @returns Error track entry payload
+ */
 export function trackEntryErrorPayload(options) {
-    const { track, color = 'error', ...restOptions } = options;
+    const { track, ...restOptions } = options;
     return {
         dataType: dataTypeTrackEntry,
-        color,
+        color: 'error',
         track,
         ...restOptions,
     };
 }
+/**
+ * Converts an error to DevTools properties array.
+ * @param e - Error object or value
+ * @returns Array of error properties for DevTools
+ */
 export function errorToDevToolsProperties(e) {
     const name = e instanceof Error ? e.name : 'UnknownError';
     const message = e instanceof Error ? e.message : String(e);
@@ -43,14 +84,26 @@ export function errorToDevToolsProperties(e) {
         ['Error Message', message],
     ];
 }
+/**
+ * Converts an error to entry metadata for DevTools.
+ * @param e - Error object or value
+ * @param options - Additional metadata options
+ * @returns Entry metadata with error properties
+ */
 export function errorToEntryMeta(e, options) {
     const { properties, tooltipText } = options ?? {};
-    const props = mergePropertiesWithOverwrite(errorToDevToolsProperties(e), properties);
+    const props = mergePropertiesWithOverwrite(errorToDevToolsProperties(e), properties ?? []);
     return {
         properties: props,
         ...(tooltipText ? { tooltipText } : {}),
     };
 }
+/**
+ * Converts an error to a track entry payload with error styling.
+ * @param error - Error object or value
+ * @param detail - Track entry details excluding color and dataType
+ * @returns Error track entry payload
+ */
 export function errorToTrackEntryPayload(error, detail) {
     const { properties, tooltipText, ...trackPayload } = detail;
     return {
@@ -63,6 +116,12 @@ export function errorToTrackEntryPayload(error, detail) {
         }),
     };
 }
+/**
+ * Converts an error to a marker payload with error styling.
+ * @param error - Error object or value
+ * @param detail - Marker details excluding color and dataType
+ * @returns Error marker payload
+ */
 export function errorToMarkerPayload(error, detail) {
     const { properties, tooltipText } = detail ?? {};
     return {
@@ -75,6 +134,162 @@ export function errorToMarkerPayload(error, detail) {
     };
 }
 export function asOptions(devtools) {
-    return devtools == null ? { detail: {} } : { detail: { devtools } };
+    if (devtools == null) {
+        return { detail: {} };
+    }
+    return { detail: { devtools } };
+}
+export function getNames(base, prefix) {
+    const n = prefix ? `${prefix}:${base}` : base;
+    return {
+        startName: `${n}:start`,
+        endName: `${n}:end`,
+        measureName: n,
+    };
+}
+/**
+ * Merges multiple DevTools payloads into a single payload.
+ * The first payload establishes the base type, subsequent payloads only overwrite with defined values.
+ * @param parts - Array of payloads where first is complete and rest are partial
+ * @returns Merged payload with combined properties
+ * @example
+ * const payload = mergeDevtoolsPayload(
+ *   trackEntryPayload({ track: 'user-interactions', color: 'secondary' }),
+ *   { color: 'primary', tooltipText: 'User action completed' },
+ * );
+ * // { track: 'user-interactions', color: 'primary', tooltipText: 'User action completed' }
+ */
+export function mergeDevtoolsPayload(...parts) {
+    return parts.reduce((acc, cur) => ({
+        ...acc,
+        ...cur,
+        ...(cur.properties || acc.properties
+            ? {
+                properties: mergePropertiesWithOverwrite(acc.properties ?? [], cur.properties ?? []),
+            }
+            : {}),
+    }), 
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
+    {});
+}
+/**
+ * Sets up tracks with default values merged into each track.
+ * This helps to avoid repetition when defining multiple tracks with common properties.
+ * @param defaults - Default action track configuration
+ * @param tracks - Track configurations to merge with defaults
+ * @returns Record with merged track configurations
+ */
+export function setupTracks(defaults, tracks) {
+    return objectFromEntries(objectToEntries(tracks).map(([key, track]) => [
+        key,
+        mergeDevtoolsPayload(defaults, track),
+    ]));
+}
+/**
+ * This is a helper function used to ensure that the marks used to create a measure do not contain UI interaction properties.
+ * @param devtools - The devtools payload to convert to mark options.
+ * @returns The mark options without dataType, tooltipText and properties.
+ */
+function toMarkMeasureOpts(devtools) {
+    const { dataType: _, tooltipText: __, properties: ___, ...markDevtools } = devtools;
+    return { detail: { devtools: markDevtools } };
+}
+/**
+ * Creates a measurement context for tracking performance events with consistent DevTools visualization.
+ *
+ * This function returns a higher-order function that generates measurement controllers for individual events.
+ * Each measurement creates start/end marks and a final measure in Chrome DevTools Performance panel.
+ *
+ * @param cfg - Configuration defining default track properties, optional prefix, and global error handling
+ * @returns Function that creates measurement controllers for specific events
+ * @example
+ * // Basic usage with defaults
+ * const measure = measureCtx({
+ *   track: 'api-calls',
+ *   color: 'secondary',
+ *   trackGroup: 'backend'
+ * });
+ *
+ * const { start, success, error } = measure('fetch-user');
+ * start(); // Creates "fetch-user:start" mark
+ * // ... async operation ...
+ * success({ userCount: 42 }); // Creates "fetch-user:end" mark and "fetch-user" measure
+ * @example
+ * // Advanced usage with callbacks and error handling
+ * const measure = measureCtx({
+ *   track: 'user-actions',
+ *   color: 'primary',
+ *   error: (err) => ({
+ *     properties: [['error-type', err.name], ['error-message', err.message]]
+ *   })
+ * });
+ *
+ * const { start, success, error } = measure('save-form', {
+ *   success: (result) => ({
+ *     properties: [['items-saved', result.count]],
+ *     tooltipText: `Saved ${result.count} items successfully`
+ *   }),
+ *   error: (err) => ({
+ *     properties: [['validation-errors', err.errors?.length ?? 0]]
+ *   })
+ * });
+ *
+ * start();
+ * try {
+ *   const result = await saveFormData(formData);
+ *   success(result);
+ * } catch (err) {
+ *   error(err); // Applies both global and specific error metadata
+ * }
+ * @example
+ * // onetime config of defaults
+ * const apiMeasure = measureCtx({
+ *   prefix: 'http:',
+ *   track: 'api',
+ * });
+ *
+ * const { start, success, error } = apiMeasure('login');
+ *
+ * start();
+ * try {
+ *   const result = myWork();
+ *   success(result);
+ *   return result;
+ * } catch(err) {
+ *   error(err)
+ * }
+ * @returns Object with measurement control methods:
+ * - `start()`: Marks the beginning of the measurement
+ * - `success(result?)`: Completes successful measurement with optional result metadata
+ * - `error(error)`: Completes failed measurement with error metadata
+ */
+export function measureCtx(cfg) {
+    const { prefix, error: globalErr, ...defaults } = cfg;
+    return (event, opt) => {
+        const { success, error, ...measurePayload } = opt ?? {};
+        const merged = mergeDevtoolsPayload(defaults, measurePayload);
+        const { startName: s, endName: e, measureName: m, } = getNames(event, prefix);
+        return {
+            start: () => performance.mark(s, toMarkMeasureOpts(merged)),
+            success: (r) => {
+                const successPayload = mergeDevtoolsPayload(merged, success?.(r) ?? {});
+                performance.mark(e, toMarkMeasureOpts(successPayload));
+                performance.measure(m, {
+                    start: s,
+                    end: e,
+                    ...asOptions(successPayload),
+                });
+            },
+            error: (err) => {
+                const errorPayload = mergeDevtoolsPayload({ ...merged, color: 'error' }, errorToEntryMeta(err), globalErr?.(err) ?? {}, error?.(err) ?? {});
+                performance.mark(e, toMarkMeasureOpts(errorPayload));
+                performance.measure(m, {
+                    start: s,
+                    end: e,
+                    ...asOptions(errorPayload),
+                });
+            },
+        };
+    };
 }
 //# sourceMappingURL=user-timing-extensibility-api-utils.js.map

package/src/lib/user-timing-extensibility-api-utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"user-timing-extensibility-api-utils.js","sourceRoot":"","sources":["../../../src/lib/user-timing-extensibility-api-utils.ts"],"names":[],"mappings":"AAWA,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAEhC,MAAM,UAAU,4BAA4B,CAC1C,cAA8C,EAC9C,kBAAmD;IAEnD,OAAO;QACL,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,cAAc,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC,CAAC;KAC1C,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAyC;IACrE,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,GAAG,OAAO;KACa,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,OAA4C;IAE5C,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IACnC,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,KAAK;QACL,GAAG,IAAI;KACoB,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,OAAmD;IAEnD,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,KAAK,EAAE,OAAY;QACnB,GAAG,OAAO;KACa,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,sBAAsB,CAIpC,OAGC;IAED,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAgB,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IACpE,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,KAAK;QACL,KAAK;QACL,GAAG,WAAW;KACa,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,CAAU;IAClD,MAAM,IAAI,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;IAC1D,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3D,OAAO;QACL,CAAC,YAAqB,EAAE,IAAI,CAAC;QAC7B,CAAC,eAAwB,EAAE,OAAO,CAAC;KACP,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,CAAU,EACV,OAGC;IAED,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAClD,MAAM,KAAK,GAAG,4BAA4B,CACxC,yBAAyB,CAAC,CAAC,CAAC,EAC5B,UAAU,CACX,CAAC;IACF,OAAO;QACL,UAAU,EAAE,KAAK;QACjB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpB,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,KAAc,EACd,MAEC;IAED,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;IAC5D,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,KAAK,EAAE,OAAgB;QACvB,GAAG,YAAY;QACf,GAAG,gBAAgB,CAAC,KAAK,EAAE;YACzB,UAAU;YACV,WAAW;SACZ,CAAC;KACyB,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,KAAc,EACd,MAAkD;IAElD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;IACjD,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,KAAK,EAAE,OAAgB;QACvB,GAAG,gBAAgB,CAAC,KAAK,EAAE;YACzB,UAAU;YACV,WAAW;SACZ,CAAC;KACqB,CAAC;AAC5B,CAAC;AAqBD,MAAM,UAAU,SAAS,CACvB,QAAmB;IAInB,OAAO,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;AACtE,CAAC"}
+{"version":3,"file":"user-timing-extensibility-api-utils.js","sourceRoot":"","sources":["../../../src/lib/user-timing-extensibility-api-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAapE,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,cAAc,GAAG,QAAQ,CAAC;AAehC,MAAM,UAAU,4BAA4B,CAC1C,cAAkC,EAClC,kBAAuC;IAEvC,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,cAAc,EAAE,GAAG,CAAC,kBAAkB,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAAC,OAAyC;IACrE,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,GAAG,OAAO;KACa,CAAC;AAC5B,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAA4C;IAE5C,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IACnC,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,KAAK;QACL,GAAG,IAAI;KACoB,CAAC;AAChC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAmD;IAEnD,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,KAAK,EAAE,OAAY;QACnB,GAAG,OAAO;KACa,CAAC;AAC5B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAEC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;IAC1C,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,KAAK,EAAE,OAAgB;QACvB,KAAK;QACL,GAAG,WAAW;KACa,CAAC;AAChC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,CAAU;IAClD,MAAM,IAAI,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;IAC1D,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3D,OAAO;QACL,CAAC,YAAqB,EAAE,IAAI,CAAC;QAC7B,CAAC,eAAwB,EAAE,OAAO,CAAC;KACP,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,CAAU,EACV,OAGC;IAED,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAClD,MAAM,KAAK,GAAG,4BAA4B,CACxC,yBAAyB,CAAC,CAAC,CAAC,EAC5B,UAAU,IAAI,EAAE,CACjB,CAAC;IACF,OAAO;QACL,UAAU,EAAE,KAAK;QACjB,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpB,CAAC;AACxB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACtC,KAAc,EACd,MAEC;IAED,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;IAC5D,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,KAAK,EAAE,OAAgB;QACvB,GAAG,YAAY;QACf,GAAG,gBAAgB,CAAC,KAAK,EAAE;YACzB,UAAU;YACV,WAAW;SACZ,CAAC;KACyB,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,KAAc,EACd,MAAkD;IAElD,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;IACjD,OAAO;QACL,QAAQ,EAAE,cAAc;QACxB,KAAK,EAAE,OAAgB;QACvB,GAAG,gBAAgB,CAAC,KAAK,EAAE;YACzB,UAAU;YACV,WAAW;SACZ,CAAC;KACqB,CAAC;AAC5B,CAAC;AAuBD,MAAM,UAAU,SAAS,CACvB,QAAmB;IAInB,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACrB,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACxB,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,CAAC;AAClC,CAAC;AAwBD,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,MAAe;IACpD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9C,OAAO;QACL,SAAS,EAAE,GAAG,CAAC,QAAQ;QACvB,OAAO,EAAE,GAAG,CAAC,MAAM;QACnB,WAAW,EAAE,CAAC;KACN,CAAC;AACb,CAAC;AAqCD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,oBAAoB,CAKlC,GAAG,KAAQ;IACX,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACb,GAAG,GAAG;QACN,GAAG,GAAG;QACN,GAAG,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU;YAClC,CAAC,CAAC;gBACE,UAAU,EAAE,4BAA4B,CACtC,GAAG,CAAC,UAAU,IAAI,EAAE,EACpB,GAAG,CAAC,UAAU,IAAI,EAAE,CACrB;aACF;YACH,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;IACF,yEAAyE;IACzE,EAA0D,CAC3D,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAGzB,QAAW,EAAE,MAAS;IACtB,OAAO,iBAAiB,CACtB,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QAC5C,GAAG;QACH,oBAAoB,CAAC,QAAQ,EAAE,KAAK,CAAC;KACtC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAA8B,QAAW;IACjE,MAAM,EACJ,QAAQ,EAAE,CAAC,EACX,WAAW,EAAE,EAAE,EACf,UAAU,EAAE,GAAG,EACf,GAAG,YAAY,EAChB,GAAG,QAAQ,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,CAAC;AAChD,CAAC;AAwCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AAEH,MAAM,UAAU,UAAU,CAAC,GAAsB;IAC/C,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,GAAG,GAAG,CAAC;IAEtD,OAAO,CAAC,KAAa,EAAE,GAAoB,EAAE,EAAE;QAC7C,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,cAAc,EAAE,GAAG,GAAG,IAAI,EAAE,CAAC;QACxD,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC9D,MAAM,EACJ,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,CAAC,EACV,WAAW,EAAE,CAAC,GACf,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAE5B,OAAO;YACL,KAAK,EAAE,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;YAE3D,OAAO,EAAE,CAAC,CAAU,EAAE,EAAE;gBACtB,MAAM,cAAc,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxE,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC;gBACvD,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE;oBACrB,KAAK,EAAE,CAAC;oBACR,GAAG,EAAE,CAAC;oBACN,GAAG,SAAS,CAAC,cAAc,CAAC;iBAC7B,CAAC,CAAC;YACL,CAAC;YAED,KAAK,EAAE,CAAC,GAAY,EAAE,EAAE;gBACtB,MAAM,YAAY,GAAG,oBAAoB,CACvC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAC7B,gBAAgB,CAAC,GAAG,CAAC,EACrB,SAAS,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,EACtB,KAAK,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CACnB,CAAC;gBACF,WAAW,CAAC,IAAI,CAAC,CAAC,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;gBACrD,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE;oBACrB,KAAK,EAAE,CAAC;oBACR,GAAG,EAAE,CAAC;oBACN,GAAG,SAAS,CAAC,YAAY,CAAC;iBAC3B,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/src/lib/user-timing-extensibility-api.type.d.ts

@@ -44,7 +44,7 @@ export type EntryMeta = {
     properties?: DevToolsProperties;
 };
 /**
- * Styling options for track entries in DevTools.
+ * Styling options for track entries and marker in DevTools.
  * @property {DevToolsColor} [color] - rendered color of background and border, defaults to "primary"
  */
 export type TrackStyle = {
@@ -53,7 +53,7 @@ export type TrackStyle = {
 /**
  * Metadata for organizing track entries in DevTools.
  * @property {string} track - Name of the custom track
- * @property {string} [trackGroup] - Group for organizing tracks
+ * @property {string} [trackGroup] - Group for organizing tracks.
  */
 export type TrackMeta = {
     track: string;
@@ -88,6 +88,21 @@ export type WithErrorColor<T extends {
 }> = Omit<T, 'color'> & {
     color: 'error';
 };
+/**
+ * Action color payload.
+ * @param color - The color of the action
+ * @returns The action color payload
+ */
+export type ActionColorPayload = {
+    color?: DevToolsActionColor;
+};
+/**
+ * Action track payload.
+ * @param TrackEntryPayload - The track entry payload
+ * @param ActionColorPayload - The action color payload
+ * @returns The action track payload
+ */
+export type ActionTrackEntryPayload = TrackEntryPayload & ActionColorPayload;
 /**
  * Utility type that adds an optional devtools payload property.
  */

package/src/lib/sink-source.types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=sink-source.types.js.map

package/src/lib/sink-source.types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sink-source.types.js","sourceRoot":"","sources":["../../../src/lib/sink-source.types.ts"],"names":[],"mappings":""}