@atlaskit/react-ufo 4.6.0 → 4.6.2

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 (29) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/create-post-interaction-log-payload/get-late-mutations.js +15 -3
  3. package/dist/cjs/create-post-interaction-log-payload/index.js +2 -1
  4. package/dist/cjs/hidden-timing/index.js +11 -7
  5. package/dist/cjs/vc/vc-observer-new/index.js +74 -11
  6. package/dist/cjs/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js +101 -60
  7. package/dist/es2019/create-post-interaction-log-payload/get-late-mutations.js +12 -3
  8. package/dist/es2019/create-post-interaction-log-payload/index.js +2 -1
  9. package/dist/es2019/hidden-timing/index.js +11 -7
  10. package/dist/es2019/vc/vc-observer-new/index.js +67 -10
  11. package/dist/es2019/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js +42 -11
  12. package/dist/esm/create-post-interaction-log-payload/get-late-mutations.js +15 -3
  13. package/dist/esm/create-post-interaction-log-payload/index.js +2 -1
  14. package/dist/esm/hidden-timing/index.js +11 -7
  15. package/dist/esm/vc/vc-observer-new/index.js +74 -11
  16. package/dist/esm/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.js +101 -60
  17. package/dist/types/common/react-ufo-payload-schema.d.ts +2 -0
  18. package/dist/types/common/vc/types.d.ts +7 -0
  19. package/dist/types/create-post-interaction-log-payload/get-late-mutations.d.ts +2 -2
  20. package/dist/types/vc/vc-observer/getVCRevisionDebugDetails.d.ts +1 -1
  21. package/dist/types/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts +1 -0
  22. package/dist/types/vc/vc-observer-new/types.d.ts +5 -0
  23. package/dist/types-ts4.5/common/react-ufo-payload-schema.d.ts +2 -0
  24. package/dist/types-ts4.5/common/vc/types.d.ts +7 -0
  25. package/dist/types-ts4.5/create-post-interaction-log-payload/get-late-mutations.d.ts +2 -2
  26. package/dist/types-ts4.5/vc/vc-observer/getVCRevisionDebugDetails.d.ts +1 -1
  27. package/dist/types-ts4.5/vc/vc-observer-new/metric-calculator/abstract-base-vc-calculator.d.ts +1 -0
  28. package/dist/types-ts4.5/vc/vc-observer-new/types.d.ts +5 -0
  29. package/package.json +7 -4
@@ -14,6 +14,12 @@ export type VCAbortReasonType = {
14
14
  export type VCRatioType = {
15
15
  [elementName: string]: number;
16
16
  };
17
+ export type VCLabelStacks = {
18
+ [elementName: string]: {
19
+ segment: string;
20
+ labelStack: string;
21
+ };
22
+ };
17
23
  export type VCRawDataType = {
18
24
  abortReasonInfo: string | null;
19
25
  abortReason: VCAbortReasonType;
@@ -114,6 +120,7 @@ export type RevisionPayloadEntry = {
114
120
  clean: boolean;
115
121
  vcDetails?: RevisionPayloadVCDetails;
116
122
  ratios?: VCRatioType;
123
+ labelStacks?: VCLabelStacks;
117
124
  abortReason?: VCAbortReason | null;
118
125
  abortTimestamp?: number;
119
126
  displayContentsOccurrence?: number;
@@ -1,5 +1,5 @@
1
1
  import type { LastInteractionFinishInfo } from '../common';
2
2
  import type { LateMutation } from '../common/react-ufo-payload-schema';
3
- import type { RevisionPayloadVCDetails } from '../common/vc/types';
4
- declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios?: Record<string, number>): LateMutation[];
3
+ import type { RevisionPayloadVCDetails, VCLabelStacks } from '../common/vc/types';
4
+ declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, labelStacks: VCLabelStacks | undefined, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios?: Record<string, number>): LateMutation[];
5
5
  export default getLateMutations;
@@ -17,7 +17,7 @@ export type VCLogEntry = {
17
17
  export interface VCRevisionDebugDetails {
18
18
  revision: string;
19
19
  isClean: boolean;
20
- abortReason?: VCAbortReason | null;
20
+ abortReason?: string | null;
21
21
  abortTimestamp?: number;
22
22
  vcLogs: VCLogEntry[];
23
23
  interactionId?: string;
@@ -23,6 +23,7 @@ export default abstract class AbstractVCCalculatorBase implements VCCalculator {
23
23
  * Calculate ratios for each element based on their viewport coverage.
24
24
  */
25
25
  private calculateRatios;
26
+ private getLabelStacks;
26
27
  private calculateWithDebugInfo;
27
28
  calculate({ startTime, stopTime, orderedEntries, interactionId, isPostInteraction, include3p, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
28
29
  }
@@ -9,6 +9,11 @@ export type ViewportEntryData = {
9
9
  readonly attributeName?: string | null | undefined;
10
10
  readonly oldValue?: string | null | undefined;
11
11
  readonly newValue?: string | null | undefined;
12
+ readonly labelStacks?: VCObserverLabelStacks;
13
+ };
14
+ export type VCObserverLabelStacks = {
15
+ segment: string;
16
+ labelStack: string;
12
17
  };
13
18
  export type WindowEventEntryData = {
14
19
  readonly type: VCObserverEntryType;
@@ -203,6 +203,8 @@ export type LateMutation = {
203
203
  time: number;
204
204
  element: string;
205
205
  viewportHeatmapPercentage: number;
206
+ segment?: string;
207
+ labelStack?: string;
206
208
  };
207
209
  export type PostInteractionLogPayload = {
208
210
  actionSubject: 'experience';
@@ -14,6 +14,12 @@ export type VCAbortReasonType = {
14
14
  export type VCRatioType = {
15
15
  [elementName: string]: number;
16
16
  };
17
+ export type VCLabelStacks = {
18
+ [elementName: string]: {
19
+ segment: string;
20
+ labelStack: string;
21
+ };
22
+ };
17
23
  export type VCRawDataType = {
18
24
  abortReasonInfo: string | null;
19
25
  abortReason: VCAbortReasonType;
@@ -114,6 +120,7 @@ export type RevisionPayloadEntry = {
114
120
  clean: boolean;
115
121
  vcDetails?: RevisionPayloadVCDetails;
116
122
  ratios?: VCRatioType;
123
+ labelStacks?: VCLabelStacks;
117
124
  abortReason?: VCAbortReason | null;
118
125
  abortTimestamp?: number;
119
126
  displayContentsOccurrence?: number;
@@ -1,5 +1,5 @@
1
1
  import type { LastInteractionFinishInfo } from '../common';
2
2
  import type { LateMutation } from '../common/react-ufo-payload-schema';
3
- import type { RevisionPayloadVCDetails } from '../common/vc/types';
4
- declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios?: Record<string, number>): LateMutation[];
3
+ import type { RevisionPayloadVCDetails, VCLabelStacks } from '../common/vc/types';
4
+ declare function getLateMutations(vcDetails: RevisionPayloadVCDetails, labelStacks: VCLabelStacks | undefined, lastInteractionFinish: LastInteractionFinishInfo, postInteractionFinishVCRatios?: Record<string, number>): LateMutation[];
5
5
  export default getLateMutations;
@@ -17,7 +17,7 @@ export type VCLogEntry = {
17
17
  export interface VCRevisionDebugDetails {
18
18
  revision: string;
19
19
  isClean: boolean;
20
- abortReason?: VCAbortReason | null;
20
+ abortReason?: string | null;
21
21
  abortTimestamp?: number;
22
22
  vcLogs: VCLogEntry[];
23
23
  interactionId?: string;
@@ -23,6 +23,7 @@ export default abstract class AbstractVCCalculatorBase implements VCCalculator {
23
23
  * Calculate ratios for each element based on their viewport coverage.
24
24
  */
25
25
  private calculateRatios;
26
+ private getLabelStacks;
26
27
  private calculateWithDebugInfo;
27
28
  calculate({ startTime, stopTime, orderedEntries, interactionId, isPostInteraction, include3p, }: VCCalculatorParam): Promise<RevisionPayloadEntry | undefined>;
28
29
  }
@@ -9,6 +9,11 @@ export type ViewportEntryData = {
9
9
  readonly attributeName?: string | null | undefined;
10
10
  readonly oldValue?: string | null | undefined;
11
11
  readonly newValue?: string | null | undefined;
12
+ readonly labelStacks?: VCObserverLabelStacks;
13
+ };
14
+ export type VCObserverLabelStacks = {
15
+ segment: string;
16
+ labelStack: string;
12
17
  };
13
18
  export type WindowEventEntryData = {
14
19
  readonly type: VCObserverEntryType;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/react-ufo",
3
- "version": "4.6.0",
3
+ "version": "4.6.2",
4
4
  "description": "Parts of React UFO that are publicly available",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -120,6 +120,9 @@
120
120
  "platform_ufo_enable_interactivity_jsm": {
121
121
  "type": "boolean"
122
122
  },
123
+ "platform_ufo_unify_abort_status_in_ttvc_debug_data": {
124
+ "type": "boolean"
125
+ },
123
126
  "platform_ufo_exclude_3p_elements_from_ttai": {
124
127
  "type": "boolean"
125
128
  },
@@ -138,9 +141,6 @@
138
141
  "platform_ufo_ssr_placeholder_resolution_ttvc_v3": {
139
142
  "type": "boolean"
140
143
  },
141
- "platform_ufo_send_vc_100": {
142
- "type": "boolean"
143
- },
144
144
  "platform_ufo_display_content_resolution_ttvc_v3": {
145
145
  "type": "boolean"
146
146
  },
@@ -155,6 +155,9 @@
155
155
  },
156
156
  "platform_ufo_display_content_track_occurrence": {
157
157
  "type": "boolean"
158
+ },
159
+ "platform_ufo_enable_late_mutation_label_stacks": {
160
+ "type": "boolean"
158
161
  }
159
162
  }
160
163
  }