@atlaskit/react-ufo 2.14.3 → 2.16.0

package/dist/types/experience-trace-id-context/index.d.ts

@@ -8,3 +8,4 @@ export declare const getActiveTraceHttpRequestHeaders: (_url: string) => {
     'X-B3-TraceId': string;
     'X-B3-SpanId': string;
 } | null;
+export declare const getActiveTraceAsQueryParams: (_url: string) => string | null;

package/dist/types/resource-timing/index.d.ts

@@ -1,4 +1,4 @@
-export type { ResourceTimings } from './common/types';
+export type { ResourceTiming, ResourceTimings } from './common/types';
 export { configure } from './common/utils/config';
 export { getResourceTimings } from './main';
 export { startResourceTimingBuffer } from './utils';

package/dist/types/vc/vc-observer/heatmap/heatmap.d.ts

@@ -0,0 +1,72 @@
+import type { ComponentsLogType, MultiHeatmapPayload, VCEntryType, VCIgnoreReason, VCRatioType } from '../../../common/vc/types';
+import type { ObservedMutationType } from '../observers/types';
+import type { RevisionEntry, VCCalculationMethodType } from '../revisions/types';
+type Viewport = {
+    w: number;
+    h: number;
+};
+type ArraySize = {
+    w: number;
+    h: number;
+};
+type HeatmapAttrs = {
+    viewport: Viewport;
+    revisions: RevisionEntry[];
+    arraySize?: ArraySize;
+    devToolsEnabled?: boolean;
+};
+type Heatmap = Uint32Array;
+type ProcessDataArgs = {
+    VCParts: number[];
+    VCCalculationMethods: VCCalculationMethodType[];
+    clean: boolean;
+    ssr?: number;
+};
+type PerRevision<T> = T[];
+export type ApplyChangesError = {
+    error: string;
+    time: number;
+};
+export type HandleUpdateArgs = {
+    time: number;
+    type: ObservedMutationType;
+    classification: boolean[];
+    intersectionRect: DOMRectReadOnly;
+    element: HTMLElement;
+    targetName: string;
+    ignoreReason?: VCIgnoreReason;
+    onError: (error: ApplyChangesError) => void;
+};
+export declare class MultiRevisionHeatmap {
+    viewport: Viewport;
+    arraySize: ArraySize;
+    revisions: RevisionEntry[];
+    heatmaps: Heatmap[];
+    devToolsEnabled: boolean;
+    vcRatios: PerRevision<VCRatioType>;
+    componentsLogs: PerRevision<ComponentsLogType>;
+    constructor({ viewport, revisions, arraySize, devToolsEnabled }: HeatmapAttrs);
+    handleUpdate({ time, type, classification, intersectionRect, element, targetName, ignoreReason, onError, }: HandleUpdateArgs): void;
+    getData(): {
+        heatmaps: Uint32Array[];
+    };
+    getPayloadShapedData(args: ProcessDataArgs): MultiHeatmapPayload;
+    processData({ VCParts, VCCalculationMethods, ssr }: ProcessDataArgs): {
+        VC: import("../revisions/types").VCType;
+        VCBox: import("../revisions/types").VCBoxType;
+        VCEntries: {
+            abs: number[][];
+            rel: VCEntryType[];
+        };
+        totalPainted: number;
+    }[];
+    private mapPixelsToHeatmap;
+    private getElementRatio;
+    private applyChangesToHeatMap;
+    private getIndex;
+    private getCleanHeatmap;
+    static makeVCReturnObj<T>(VCParts: number[]): {
+        [key: string]: T | null;
+    };
+}
+export {};

package/dist/types/vc/vc-observer/index.d.ts

@@ -1,5 +1,6 @@
 import { type UnbindFn } from 'bind-event-listener';
 import type { ComponentsLogType, VCAbortReason, VCAbortReasonType, VCEntryType, VCIgnoreReason, VCRatioType, VCRawDataType, VCResult } from '../../common/vc/types';
+import { MultiRevisionHeatmap } from './heatmap/heatmap';
 import { Observers, type SelectorConfig } from './observers';
 type GetVCResultType = {
     start: number;
@@ -20,7 +21,7 @@ export declare class VCObserver {
     abortReason: VCAbortReasonType;
     outOfBoundaryInfo: string;
     /** config * */
-    static VCParts: string[];
+    static VCParts: readonly ["25", "50", "75", "80", "85", "90", "95", "98", "99"];
     viewport: {
         w: number;
         h: number;
@@ -28,6 +29,7 @@ export declare class VCObserver {
     arraySize: number;
     heatmap: number[][];
     heatmapNext: number[][];
+    multiHeatmap: MultiRevisionHeatmap | null;
     componentsLog: ComponentsLogType;
     vcRatios: VCRatioType;
     active: boolean;
@@ -80,6 +82,8 @@ export declare class VCObserver {
     setReactRootRenderStart(startTime?: number): void;
     setReactRootRenderStop(stopTime?: number): void;
     private handleUpdate;
+    private legacyHandleUpdate;
+    private onViewportChangeDetected;
     abortObservation(abortReason?: VCAbortReason): void;
     private setAbortReason;
     private resetState;

package/dist/types/vc/vc-observer/revisions/ViewportUpdateClassifier.d.ts

@@ -0,0 +1,30 @@
+import type { VCCalculationMethodArgs } from './types';
+export type FilterArgs = {
+    type: string;
+    tags?: string[];
+    ignoreReason?: string;
+};
+type Filter = {
+    name: string;
+    filter: (args: FilterArgs) => boolean;
+};
+type ClassifyUpdateArgs = {
+    element: HTMLElement;
+    type: string;
+    tags?: string[];
+    ignoreReason?: string;
+};
+export declare class ViewportUpdateClassifier {
+    types: string[];
+    filters: Filter[];
+    removedFilters: string[];
+    VCCalculationMethod(_: VCCalculationMethodArgs): {
+        VC: {};
+        VCBox: {};
+    };
+    protected __combinedTypes: string[];
+    protected __combinedFilters: Filter[];
+    mergeConfig(): void;
+    classifyUpdate({ element, type, tags, ignoreReason }: ClassifyUpdateArgs): boolean;
+}
+export {};

package/dist/types/vc/vc-observer/revisions/fy24_01.d.ts

@@ -0,0 +1,13 @@
+import type { VCCalculationMethodArgs, VCCalculationMethodReturn } from './types';
+import { type FilterArgs, ViewportUpdateClassifier } from './ViewportUpdateClassifier';
+export declare class FY24_01Classifier extends ViewportUpdateClassifier {
+    revision: string;
+    types: string[];
+    filters: {
+        name: string;
+        filter: ({ type, ignoreReason }: FilterArgs) => boolean;
+    }[];
+    VCCalculationMethod({ VCParts, entries, totalPainted, componentsLog, }: VCCalculationMethodArgs): VCCalculationMethodReturn;
+    constructor();
+}
+export declare const revFY24_01Classifier: FY24_01Classifier;

package/dist/types/vc/vc-observer/revisions/fy25_01.d.ts

@@ -0,0 +1,13 @@
+import { FY24_01Classifier } from './fy24_01';
+import { type FilterArgs } from './ViewportUpdateClassifier';
+export declare class FY25_01Classifier extends FY24_01Classifier {
+    revision: string;
+    types: string[];
+    filters: {
+        name: string;
+        filter: ({ type, ignoreReason }: FilterArgs) => boolean;
+    }[];
+    removedFilters: never[];
+    constructor();
+}
+export declare const revFY25_01Classifier: FY25_01Classifier;

package/dist/types/vc/vc-observer/revisions/revisions.d.ts

@@ -0,0 +1,2 @@
+import { type RevisionEntry } from './types';
+export declare const getRevisions: () => RevisionEntry[];

package/dist/types/vc/vc-observer/revisions/types.d.ts

@@ -0,0 +1,23 @@
+import type { ComponentsLogType } from '../../../common/vc/types';
+import { ViewportUpdateClassifier } from './ViewportUpdateClassifier';
+export type RevisionEntry = {
+    name: string;
+    classifier: ViewportUpdateClassifier;
+};
+export type VCType = {
+    [key: string]: number | null;
+};
+export type VCBoxType = {
+    [key: string]: null | Set<string>;
+};
+export type VCCalculationMethodArgs = {
+    VCParts: number[];
+    entries: number[][];
+    totalPainted: number;
+    componentsLog: ComponentsLogType;
+};
+export type VCCalculationMethodReturn = {
+    VC: VCType;
+    VCBox: VCBoxType;
+};
+export type VCCalculationMethodType = (args: VCCalculationMethodArgs) => VCCalculationMethodReturn;

package/dist/types-ts4.5/assets/index.d.ts

@@ -0,0 +1,25 @@
+import type { AssetsClassification, AssetsData, AssetsReporter } from '../common';
+import type { ResourceTiming, ResourceTimings } from '../resource-timing';
+export declare class CHRSummary {
+    bundles: {
+        mem: number;
+        disk: number;
+        net: number;
+    };
+    bundlesCount: number;
+    size: {
+        mem: number;
+        disk: number;
+        net: number;
+    };
+    sizeTotal: number;
+    add(asset: ResourceTiming): void;
+    static makePayload(summary: CHRSummary): AssetsReporter;
+}
+export declare class CHRReporter {
+    all: CHRSummary;
+    allAtlassian: CHRSummary;
+    preloaded: CHRSummary;
+    constructor();
+    get(resourceTimings: ResourceTimings, assetsClassification: AssetsClassification): AssetsData | null;
+}

package/dist/types-ts4.5/assets/utils.d.ts

@@ -0,0 +1,6 @@
+export declare const cacheableTypes: string[];
+export declare const MEMORY_KEY = "mem";
+export declare const DISK_KEY = "disk";
+export declare const NETWORK_KEY = "net";
+export declare const calculateTransferType: (type: string, duration: number, size: number | undefined) => "disk" | "mem" | "net" | null;
+export declare const round: (n: number) => number;

package/dist/types-ts4.5/common/assets/types.d.ts

@@ -0,0 +1,18 @@
+import type { ResourceTiming } from '../../resource-timing';
+export type AssetResourceEntry = {
+    label: string;
+    entry: ResourceTiming;
+};
+export type AssetsClassification = {
+    all: boolean;
+    allAtlassian: (entry: AssetResourceEntry) => boolean;
+    preloaded: (entry: AssetResourceEntry) => boolean;
+};
+export type AssetsReporter = {
+    size: number | null;
+    chr: number | null;
+    count: number;
+};
+export interface AssetsData {
+    [key: string]: AssetsReporter;
+}

package/dist/types-ts4.5/common/index.d.ts

@@ -1,3 +1,4 @@
+export type { AssetResourceEntry, AssetsClassification, AssetsData, AssetsReporter, } from './assets/types';
 export type { LifecycleMarkType, MarkType, SpanType, InteractionType, AbortReasonType, CustomTiming, HoldInfo, LoadProfilerEventInfo, ReactProfilerTiming, Span, Mark, InteractionError, RequestInfo, ApdexType, SegmentInfo, CustomData, HoldActive, Redirect, InteractionMetrics, EnhancedUFOInteractionContextType, BM3Event, PostInteractionLogOutput, LastInteractionFinishInfo, } from './common/types';
 /**
  * @deprecated Prefer import from @atlaskit/react-ufo/interaction-context

package/dist/types-ts4.5/common/vc/types.d.ts

@@ -1,4 +1,5 @@
 import type { UnbindFn } from 'bind-event-listener';
+import { MultiRevisionHeatmap } from '../../vc/vc-observer/heatmap/heatmap';
 export declare const AbortEvent: {
     readonly wheel: "wheel";
     readonly keydown: "keydown";
@@ -29,6 +30,7 @@ export type VCRawDataType = {
     oldDomUpdatesEnabled: boolean;
     devToolsEnabled: boolean;
     ratios: VCRatioType;
+    multiHeatmap: MultiRevisionHeatmap | null;
 };
 export type VCEntryType = {
     time: number;
@@ -49,7 +51,7 @@ export type VCResult = {
         h: number;
     } | {
         [key: string]: boolean | number | string[] | null | VCEntryType[];
-    };
+    } | MultiHeatmapPayload;
 };
 export type MetricsDevToolsTypes = {
     '75': number | null;
@@ -68,15 +70,19 @@ export type ExperimentalVCDevToolsOptions = {
 export type ComponentsLogType = {
     [timestamp: number]: ComponentsLogEntry[];
 };
+interface VCDebugInfo {
+    entries: VCEntryType[];
+    log: ComponentsLogType;
+    metrics: MetricsDevToolsTypes;
+    heatmap: number[][];
+    ratios: VCRatioType;
+    start: number;
+    stop: number;
+}
 declare global {
     interface Window {
-        __vc?: {
-            entries: VCEntryType[];
-            log: ComponentsLogType;
-            metrics: MetricsDevToolsTypes;
-            heatmap: number[][];
-            ratios: VCRatioType;
-        };
+        __vc?: VCDebugInfo;
+        __vcNext?: VCDebugInfo;
         __vcNotAvailableReason?: string;
         __SSR_PLACEHOLDERS_DIMENSIONS__?: {
             [key: string]: DOMRectReadOnly;
@@ -89,3 +95,16 @@ declare global {
         };
     }
 }
+type MultiHeatmapRevisionPayload = {
+    'metric:vc90': number | null;
+    revision: string;
+    clean: boolean;
+    vcDetails?: {
+        [key: string]: {
+            t: number;
+            e: string[];
+        };
+    };
+};
+export type MultiHeatmapPayload = MultiHeatmapRevisionPayload[];
+export {};

package/dist/types-ts4.5/config/index.d.ts

@@ -1,4 +1,4 @@
-import type { InteractionMetrics, InteractionType } from '../common';
+import type { AssetsClassification, InteractionMetrics, InteractionType } from '../common';
 export interface AdditionalData {
     [key: string]: null | string | number | boolean | undefined | AdditionalData | Record<string, AdditionalData> | Array<AdditionalData>;
 }
@@ -57,6 +57,7 @@ export type Config = {
         readonly getSSRTimings?: () => SSRTiming[];
         readonly getSSRDoneTime?: () => number | undefined;
     };
+    readonly assetsClassification?: AssetsClassification;
     readonly enableBetterPageVisibilityApi?: boolean;
     readonly vc?: {
         readonly enabled?: boolean;