@atlaskit/react-ufo 3.12.4 → 3.13.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.
Files changed (109) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/create-experimental-interaction-metrics-payload/index.js +2 -1
  3. package/dist/cjs/create-payload/utils/get-vc-metrics.js +2 -1
  4. package/dist/cjs/vc/index.js +4 -2
  5. package/dist/cjs/vc/vc-observer/getVCRevisionDebugDetails.js +41 -0
  6. package/dist/cjs/vc/vc-observer/index.js +63 -33
  7. package/dist/cjs/vc/vc-observer/observers/index.js +3 -2
  8. package/dist/cjs/vc/vc-observer/observers/ssr-placeholders/index.js +38 -12
  9. package/dist/cjs/vc/vc-observer/observers/ssr-placeholders/ssr-scripts/collectSSRPlaceholderDimensions.js +9 -0
  10. package/dist/cjs/vc/vc-observer-new/index.js +13 -7
  11. package/dist/cjs/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js +211 -36
  12. package/dist/cjs/vc/vc-observer-new/metric-calculator/fy25_03/index.js +4 -4
  13. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.js +94 -4
  14. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.js +108 -0
  15. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/index.js +16 -57
  16. package/dist/cjs/vc/vc-observer-new/viewport-observer/index.js +15 -5
  17. package/dist/cjs/vc/vc-observer-new/viewport-observer/mutation-observer/index.js +3 -1
  18. package/dist/es2019/create-experimental-interaction-metrics-payload/index.js +2 -1
  19. package/dist/es2019/create-payload/utils/get-vc-metrics.js +1 -0
  20. package/dist/es2019/vc/index.js +4 -2
  21. package/dist/es2019/vc/vc-observer/getVCRevisionDebugDetails.js +32 -0
  22. package/dist/es2019/vc/vc-observer/index.js +36 -1
  23. package/dist/es2019/vc/vc-observer/observers/index.js +2 -1
  24. package/dist/es2019/vc/vc-observer/observers/ssr-placeholders/index.js +38 -13
  25. package/dist/es2019/vc/vc-observer/observers/ssr-placeholders/ssr-scripts/collectSSRPlaceholderDimensions.js +9 -1
  26. package/dist/es2019/vc/vc-observer-new/index.js +12 -6
  27. package/dist/es2019/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js +115 -17
  28. package/dist/es2019/vc/vc-observer-new/metric-calculator/fy25_03/index.js +4 -4
  29. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.js +44 -1
  30. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.js +75 -0
  31. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/index.js +2 -20
  32. package/dist/es2019/vc/vc-observer-new/viewport-observer/index.js +15 -5
  33. package/dist/es2019/vc/vc-observer-new/viewport-observer/mutation-observer/index.js +3 -1
  34. package/dist/esm/create-experimental-interaction-metrics-payload/index.js +2 -1
  35. package/dist/esm/create-payload/utils/get-vc-metrics.js +2 -1
  36. package/dist/esm/vc/index.js +4 -2
  37. package/dist/esm/vc/vc-observer/getVCRevisionDebugDetails.js +35 -0
  38. package/dist/esm/vc/vc-observer/index.js +63 -33
  39. package/dist/esm/vc/vc-observer/observers/index.js +3 -2
  40. package/dist/esm/vc/vc-observer/observers/ssr-placeholders/index.js +38 -12
  41. package/dist/esm/vc/vc-observer/observers/ssr-placeholders/ssr-scripts/collectSSRPlaceholderDimensions.js +9 -0
  42. package/dist/esm/vc/vc-observer-new/index.js +13 -7
  43. package/dist/esm/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js +211 -36
  44. package/dist/esm/vc/vc-observer-new/metric-calculator/fy25_03/index.js +4 -4
  45. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.js +94 -5
  46. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.js +106 -0
  47. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/index.js +2 -55
  48. package/dist/esm/vc/vc-observer-new/viewport-observer/index.js +15 -5
  49. package/dist/esm/vc/vc-observer-new/viewport-observer/mutation-observer/index.js +3 -1
  50. package/dist/types/config/index.d.ts +1 -0
  51. package/dist/types/vc/types.d.ts +2 -0
  52. package/dist/types/vc/vc-observer/getVCRevisionDebugDetails.d.ts +30 -0
  53. package/dist/types/vc/vc-observer/index.d.ts +1 -1
  54. package/dist/types/vc/vc-observer/observers/index.d.ts +3 -0
  55. package/dist/types/vc/vc-observer/observers/ssr-placeholders/index.d.ts +4 -1
  56. package/dist/types/vc/vc-observer/observers/ssr-placeholders/ssr-scripts/collectSSRPlaceholderDimensions.d.ts +1 -1
  57. package/dist/types/vc/vc-observer-new/index.d.ts +2 -0
  58. package/dist/types/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts +4 -1
  59. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.d.ts +5 -1
  60. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.d.ts +1 -0
  61. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/index.d.ts +2 -4
  62. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/types.d.ts +20 -2
  63. package/dist/types/vc/vc-observer-new/metric-calculator/types.d.ts +2 -0
  64. package/dist/types/vc/vc-observer-new/types.d.ts +5 -1
  65. package/dist/types/vc/vc-observer-new/viewport-observer/mutation-observer/index.d.ts +2 -0
  66. package/dist/types/vc/vc-observer-new/viewport-observer/types.d.ts +2 -0
  67. package/dist/types-ts4.5/config/index.d.ts +1 -0
  68. package/dist/types-ts4.5/vc/types.d.ts +2 -0
  69. package/dist/types-ts4.5/vc/vc-observer/getVCRevisionDebugDetails.d.ts +30 -0
  70. package/dist/types-ts4.5/vc/vc-observer/index.d.ts +1 -1
  71. package/dist/types-ts4.5/vc/vc-observer/observers/index.d.ts +3 -0
  72. package/dist/types-ts4.5/vc/vc-observer/observers/ssr-placeholders/index.d.ts +4 -1
  73. package/dist/types-ts4.5/vc/vc-observer/observers/ssr-placeholders/ssr-scripts/collectSSRPlaceholderDimensions.d.ts +1 -1
  74. package/dist/types-ts4.5/vc/vc-observer-new/index.d.ts +2 -0
  75. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts +4 -1
  76. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/index.d.ts +5 -1
  77. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/canvas-heatmap/test-with-debug-info.d.ts +1 -0
  78. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/index.d.ts +2 -4
  79. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/types.d.ts +20 -2
  80. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/types.d.ts +2 -0
  81. package/dist/types-ts4.5/vc/vc-observer-new/types.d.ts +5 -1
  82. package/dist/types-ts4.5/vc/vc-observer-new/viewport-observer/mutation-observer/index.d.ts +2 -0
  83. package/dist/types-ts4.5/vc/vc-observer-new/viewport-observer/types.d.ts +2 -0
  84. package/package.json +4 -1
  85. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.js +0 -367
  86. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/index.js +0 -398
  87. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/types.js +0 -5
  88. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/calc-union-area.js +0 -152
  89. package/dist/cjs/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/index.js +0 -108
  90. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.js +0 -248
  91. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/index.js +0 -263
  92. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/types.js +0 -1
  93. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/calc-union-area.js +0 -99
  94. package/dist/es2019/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/index.js +0 -60
  95. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.js +0 -361
  96. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/index.js +0 -391
  97. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/types.js +0 -1
  98. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/calc-union-area.js +0 -145
  99. package/dist/esm/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/index.js +0 -101
  100. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.d.ts +0 -39
  101. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/index.d.ts +0 -10
  102. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/types.d.ts +0 -43
  103. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/calc-union-area.d.ts +0 -12
  104. package/dist/types/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/index.d.ts +0 -25
  105. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/heatmap.d.ts +0 -39
  106. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/index.d.ts +0 -10
  107. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/heatmap/types.d.ts +0 -43
  108. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/calc-union-area.d.ts +0 -12
  109. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/percentile-calc/rect-sweeping-line/index.d.ts +0 -25
@@ -1,43 +0,0 @@
1
- import type { VCObserverEntryType } from '../../../types';
2
- /**
3
- * Represents a rectangular area in the heatmap.
4
- */
5
- export type HeatmapRect = {
6
- left: number;
7
- top: number;
8
- right: number;
9
- bottom: number;
10
- };
11
- export type HeatmapSource = VCObserverEntryType | 'mutation:parent-mounted' | 'mutation:node-replacement';
12
- export type HeatmapEntryData = {
13
- time: DOMHighResTimeStamp;
14
- elementName: string | null;
15
- rect: HeatmapRect | null;
16
- source: HeatmapSource | null;
17
- ratio: number | null;
18
- };
19
- export type HeatmapEntry = {
20
- head: HeatmapEntryData | null;
21
- previousEntries: Array<HeatmapEntryData>;
22
- };
23
- export type Viewport = {
24
- width: number;
25
- height: number;
26
- };
27
- export type HeatmapOptions = {
28
- viewport: Viewport;
29
- heatmapSize: number;
30
- };
31
- export type DOMSelector = string;
32
- export type HeatmapCheckpointMetrics = {
33
- [checkpoint: string]: {
34
- /**
35
- * Time when this checkpoint reached
36
- */
37
- t: DOMHighResTimeStamp;
38
- /**
39
- * A collection of DOM Selector that are part of the checkpoint
40
- */
41
- e: DOMSelector[];
42
- };
43
- };
@@ -1,12 +0,0 @@
1
- /**
2
- * Calculate the union areas of all rectangles using Sweep Line Algorithm
3
- *
4
- * Reference:
5
- * https://en.wikipedia.org/wiki/Sweep_line_algorithm
6
- * https://www.hackerearth.com/practice/math/geometry/line-sweep-technique/tutorial/#:~:text=A%20sweep%20line%20is%20an,order%20to%20discretize%20the%20sweep.
7
- *
8
- * @param rectangles
9
- * @returns
10
- */
11
- declare function calculateUnionArea(rectangles: DOMRect[]): number;
12
- export default calculateUnionArea;
@@ -1,25 +0,0 @@
1
- import type { VCObserverEntry } from '../../../types';
2
- export type DOMSelector = string;
3
- export type Viewport = {
4
- width: number;
5
- height: number;
6
- };
7
- export type CheckpointMetrics = {
8
- [checkpoint: string]: {
9
- /**
10
- * Time when this checkpoint reached
11
- */
12
- t: DOMHighResTimeStamp;
13
- /**
14
- * A collection of DOM Selector that are part of the checkpoint
15
- */
16
- e: DOMSelector[];
17
- };
18
- };
19
- declare function calculateTTVCPercentiles({ orderedEntries, viewport, percentiles, startTime, }: {
20
- orderedEntries: ReadonlyArray<VCObserverEntry>;
21
- viewport: Viewport;
22
- percentiles: number[];
23
- startTime: DOMHighResTimeStamp;
24
- }): Promise<CheckpointMetrics>;
25
- export default calculateTTVCPercentiles;
@@ -1,39 +0,0 @@
1
- import type { VCObserverEntry } from '../../../types';
2
- import type { HeatmapCheckpointMetrics, HeatmapEntry, HeatmapOptions } from './types';
3
- export default class Heatmap {
4
- private viewport;
5
- /**
6
- * Heatmap Width
7
- */
8
- private width;
9
- /**
10
- * Heatmap Height
11
- */
12
- private height;
13
- /**
14
- * Heatmap Area (width * height)
15
- */
16
- private heatmapAreaSize;
17
- private scaleX;
18
- private scaleY;
19
- private map;
20
- constructor({ viewport, heatmapSize }: HeatmapOptions);
21
- getHeatmap(): HeatmapEntry[][];
22
- private getCell;
23
- /**
24
- * Map Dom Rect to Heatmap Rect, rounded up to occupy full cell.
25
- * @param rect DOM Rect
26
- * @returns
27
- */
28
- private mapDOMRectToHeatmap;
29
- /**
30
- * Calculate the ratio of a HeatmapRect compared to the full heatmap
31
- *
32
- * This function determines what fraction of the heatmap is covered by the given heatmap rectangle.
33
- *
34
- * @param rect
35
- */
36
- private getRatio;
37
- applyEntriesToHeatmap(entries: ReadonlyArray<VCObserverEntry>): Promise<void>;
38
- getVCPercentMetrics(vcPercentCheckpoint: number[]): Promise<HeatmapCheckpointMetrics>;
39
- }
@@ -1,10 +0,0 @@
1
- import type { RevisionPayloadVCDetails } from '../../../../../common/vc/types';
2
- import type { VCObserverEntry } from '../../../types';
3
- import type { Viewport } from './types';
4
- declare function calculateTTVCPercentiles({ orderedEntries, viewport, percentiles, startTime, }: {
5
- orderedEntries: ReadonlyArray<VCObserverEntry>;
6
- viewport: Viewport;
7
- percentiles: number[];
8
- startTime: DOMHighResTimeStamp;
9
- }): Promise<RevisionPayloadVCDetails>;
10
- export default calculateTTVCPercentiles;
@@ -1,43 +0,0 @@
1
- import type { VCObserverEntryType } from '../../../types';
2
- /**
3
- * Represents a rectangular area in the heatmap.
4
- */
5
- export type HeatmapRect = {
6
- left: number;
7
- top: number;
8
- right: number;
9
- bottom: number;
10
- };
11
- export type HeatmapSource = VCObserverEntryType | 'mutation:parent-mounted' | 'mutation:node-replacement';
12
- export type HeatmapEntryData = {
13
- time: DOMHighResTimeStamp;
14
- elementName: string | null;
15
- rect: HeatmapRect | null;
16
- source: HeatmapSource | null;
17
- ratio: number | null;
18
- };
19
- export type HeatmapEntry = {
20
- head: HeatmapEntryData | null;
21
- previousEntries: Array<HeatmapEntryData>;
22
- };
23
- export type Viewport = {
24
- width: number;
25
- height: number;
26
- };
27
- export type HeatmapOptions = {
28
- viewport: Viewport;
29
- heatmapSize: number;
30
- };
31
- export type DOMSelector = string;
32
- export type HeatmapCheckpointMetrics = {
33
- [checkpoint: string]: {
34
- /**
35
- * Time when this checkpoint reached
36
- */
37
- t: DOMHighResTimeStamp;
38
- /**
39
- * A collection of DOM Selector that are part of the checkpoint
40
- */
41
- e: DOMSelector[];
42
- };
43
- };
@@ -1,12 +0,0 @@
1
- /**
2
- * Calculate the union areas of all rectangles using Sweep Line Algorithm
3
- *
4
- * Reference:
5
- * https://en.wikipedia.org/wiki/Sweep_line_algorithm
6
- * https://www.hackerearth.com/practice/math/geometry/line-sweep-technique/tutorial/#:~:text=A%20sweep%20line%20is%20an,order%20to%20discretize%20the%20sweep.
7
- *
8
- * @param rectangles
9
- * @returns
10
- */
11
- declare function calculateUnionArea(rectangles: DOMRect[]): number;
12
- export default calculateUnionArea;
@@ -1,25 +0,0 @@
1
- import type { VCObserverEntry } from '../../../types';
2
- export type DOMSelector = string;
3
- export type Viewport = {
4
- width: number;
5
- height: number;
6
- };
7
- export type CheckpointMetrics = {
8
- [checkpoint: string]: {
9
- /**
10
- * Time when this checkpoint reached
11
- */
12
- t: DOMHighResTimeStamp;
13
- /**
14
- * A collection of DOM Selector that are part of the checkpoint
15
- */
16
- e: DOMSelector[];
17
- };
18
- };
19
- declare function calculateTTVCPercentiles({ orderedEntries, viewport, percentiles, startTime, }: {
20
- orderedEntries: ReadonlyArray<VCObserverEntry>;
21
- viewport: Viewport;
22
- percentiles: number[];
23
- startTime: DOMHighResTimeStamp;
24
- }): Promise<CheckpointMetrics>;
25
- export default calculateTTVCPercentiles;