@atlaskit/react-ufo 2.14.3 → 2.15.0

package/dist/esm/vc/vc-observer/revisions/fy25_01.js

@@ -0,0 +1,32 @@
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+import { FY24_01Classifier } from './fy24_01';
+export var FY25_01Classifier = /*#__PURE__*/function (_FY24_01Classifier) {
+  function FY25_01Classifier() {
+    var _this;
+    _classCallCheck(this, FY25_01Classifier);
+    _this = _callSuper(this, FY25_01Classifier);
+    _defineProperty(_this, "revision", 'fy25.01');
+    _defineProperty(_this, "types", ['attr']);
+    _defineProperty(_this, "filters", [{
+      name: 'not-visible',
+      filter: function filter(_ref) {
+        var type = _ref.type,
+          ignoreReason = _ref.ignoreReason;
+        return !(ignoreReason !== null && ignoreReason !== void 0 && ignoreReason.includes('not-visible'));
+      }
+    }]);
+    _defineProperty(_this, "removedFilters", []);
+    _this.mergeConfig();
+    return _this;
+  }
+  _inherits(FY25_01Classifier, _FY24_01Classifier);
+  return _createClass(FY25_01Classifier);
+}(FY24_01Classifier);
+export var revFY25_01Classifier = new FY25_01Classifier();

package/dist/esm/vc/vc-observer/revisions/revisions.js

@@ -0,0 +1,17 @@
+import { revFY24_01Classifier } from './fy24_01';
+import { revFY25_01Classifier } from './fy25_01';
+var Revisions = [{
+  name: 'fy24.01',
+  classifier: revFY24_01Classifier
+}, {
+  name: 'fy25.01',
+  classifier: revFY25_01Classifier
+}];
+var revisionResultCache = null;
+export var getRevisions = function getRevisions() {
+  if (revisionResultCache !== null) {
+    return revisionResultCache;
+  }
+  revisionResultCache = [].concat(Revisions);
+  return revisionResultCache;
+};

package/dist/esm/vc/vc-observer/revisions/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types/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/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/vc/vc-observer/heatmap/heatmap.d.ts

@@ -0,0 +1,75 @@
+import type { ComponentsLogType, MultiHeatmapPayload, VCEntryType, VCIgnoreReason, VCRatioType } from '../../../common/vc/types';
+import type { ObservedMutationType } from '../observers/types';
+import type { RevisionEntry } 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[];
+    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, ssr }: ProcessDataArgs): {
+        VC: {
+            [key: string]: number | null;
+        };
+        VCBox: {
+            [key: string]: Set<string> | null;
+        };
+        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,25 @@
+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[];
+    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,11 @@
+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;
+    }[];
+    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,5 @@
+import { ViewportUpdateClassifier } from './ViewportUpdateClassifier';
+export type RevisionEntry = {
+    name: string;
+    classifier: ViewportUpdateClassifier;
+};

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/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-ts4.5/vc/vc-observer/heatmap/heatmap.d.ts

@@ -0,0 +1,75 @@
+import type { ComponentsLogType, MultiHeatmapPayload, VCEntryType, VCIgnoreReason, VCRatioType } from '../../../common/vc/types';
+import type { ObservedMutationType } from '../observers/types';
+import type { RevisionEntry } 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[];
+    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, ssr }: ProcessDataArgs): {
+        VC: {
+            [key: string]: number | null;
+        };
+        VCBox: {
+            [key: string]: Set<string> | null;
+        };
+        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-ts4.5/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,17 @@ 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 +39,7 @@ export declare class VCObserver {
     arraySize: number;
     heatmap: number[][];
     heatmapNext: number[][];
+    multiHeatmap: MultiRevisionHeatmap | null;
     componentsLog: ComponentsLogType;
     vcRatios: VCRatioType;
     active: boolean;
@@ -80,6 +92,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-ts4.5/vc/vc-observer/revisions/ViewportUpdateClassifier.d.ts

@@ -0,0 +1,25 @@
+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[];
+    protected __combinedTypes: string[];
+    protected __combinedFilters: Filter[];
+    mergeConfig(): void;
+    classifyUpdate({ element, type, tags, ignoreReason }: ClassifyUpdateArgs): boolean;
+}
+export {};

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

@@ -0,0 +1,11 @@
+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;
+    }[];
+    constructor();
+}
+export declare const revFY24_01Classifier: FY24_01Classifier;

package/dist/types-ts4.5/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-ts4.5/vc/vc-observer/revisions/revisions.d.ts

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

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

@@ -0,0 +1,5 @@
+import { ViewportUpdateClassifier } from './ViewportUpdateClassifier';
+export type RevisionEntry = {
+    name: string;
+    classifier: ViewportUpdateClassifier;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "2.14.3",
+	"version": "2.15.0",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -75,7 +75,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/interaction-context": "^2.6.0",
-		"@atlaskit/platform-feature-flags": "^1.0.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0",
 		"bowser-ultralight": "^1.0.6",
@@ -151,8 +151,14 @@
 		"ufo-remove-vc-component-observations-after-ttai": {
 			"type": "boolean"
 		},
+		"ufo_vc_multiheatmap": {
+			"type": "boolean"
+		},
 		"ufo-calc-speed-index": {
 			"type": "boolean"
+		},
+		"platform-ufo-add-segment-use-effect": {
+			"type": "boolean"
 		}
 	}
 }