@atlaskit/react-ufo 3.14.5 → 3.14.7

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

@@ -1,9 +1,30 @@
 import { type RevisionPayloadEntry } from '../../common/vc/types';
+import { SSRPlaceholderHandlers } from '../vc-observer/observers/ssr-placeholders';
 import { type SelectorConfig } from './get-element-name';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {
     selectorConfig?: SelectorConfig;
     isPostInteraction?: boolean;
+    SSRConfig?: {
+        enablePageLayoutPlaceholder?: boolean;
+        disableSizeAndPositionCheck?: {
+            v: boolean;
+            h: boolean;
+        };
+    };
+    ssrPlaceholderHandler?: SSRPlaceholderHandlers | null;
+};
+declare const SSRState: {
+    readonly normal: 1;
+    readonly waitingForFirstRender: 2;
+    readonly ignoring: 3;
+};
+type SSRStateType = (typeof SSRState)[keyof typeof SSRState];
+type SSRInclusiveState = {
+    state: SSRStateType;
+    reactRootElement: HTMLElement | null;
+    renderStop: number;
+    renderStart: number;
 };
 export default class VCObserverNew {
     private selectorConfig;
@@ -11,13 +32,22 @@ export default class VCObserverNew {
     private windowEventObserver;
     private entriesTimeline;
     private isPostInteraction;
+    private ssrPlaceholderHandler;
+    private ssr;
     constructor(config: VCObserverNewConfig);
     start({ startTime }: {
         startTime: DOMHighResTimeStamp;
     }): void;
     stop(): void;
+    setReactRootElement(element: HTMLElement): void;
+    setReactRootRenderStart(startTime?: number): void;
+    setReactRootRenderStop(stopTime?: number): void;
+    collectSSRPlaceholders(): void;
+    getSSRState(): SSRInclusiveState;
+    getSSRPlaceholderHandler(): SSRPlaceholderHandlers | null;
     addSSR(ssr: number): void;
     getVCResult(param: VCObserverGetVCResultParam): Promise<RevisionPayloadEntry[]>;
     private addStartEntry;
     private getElementName;
 }
+export {};

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

@@ -1,5 +1,5 @@
 import type { ObservedWindowEvent } from './window-event-observer';
-export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'layout-shift' | 'window:event' | 'unknown';
+export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'mutation:ssr-placeholder' | 'layout-shift' | 'window:event' | 'ssr-hydration' | 'unknown';
 export type ViewportEntryData = {
     readonly type: VCObserverEntryType;
     readonly elementName: string;

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

@@ -10,6 +10,8 @@ export type ViewPortObserverConstructorArgs = {
         readonly previousRect: DOMRectReadOnly | undefined;
         readonly mutationData?: MutationData | undefined | null;
     }): void;
+    getSSRState?: () => any;
+    getSSRPlaceholderHandler?: () => any;
 };
 export default class ViewportObserver {
     private intersectionObserver;
@@ -18,7 +20,9 @@ export default class ViewportObserver {
     private mapVisibleNodeRects;
     private onChange;
     private isStarted;
-    constructor({ onChange }: ViewPortObserverConstructorArgs);
+    private getSSRState?;
+    private getSSRPlaceholderHandler?;
+    constructor({ onChange, getSSRState, getSSRPlaceholderHandler, }: ViewPortObserverConstructorArgs);
     private handleIntersectionEntry;
     private handleChildListMutation;
     private handleAttributeMutation;

package/dist/types/vc/vc-observer-new/viewport-observer/mutation-observer/index.d.ts

@@ -9,8 +9,10 @@ export type CreateMutationObserverProps = {
         targets: Array<HTMLElement>;
     }) => void;
     onChildListMutation: (props: {
+        target: WeakRef<HTMLElement>;
         addedNodes: ReadonlyArray<WeakRef<HTMLElement>>;
         removedNodes: ReadonlyArray<WeakRef<HTMLElement>>;
+        timestamp: DOMHighResTimeStamp;
     }) => void;
 };
 declare function createMutationObserver({ onAttributeMutation, onChildListMutation, onMutationFinished, }: CreateMutationObserverProps): MutationObserver | null;

package/dist/types/vc/vc-observer-new/viewport-observer/utils/is-in-vc-ignore-if-no-layout-shift-marker.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if the element is in the VC ignore if no layout shift marker.
+ * @param element - The element to check.
+ * @returns True if the element has the data-vc-ignore-if-no-layout-shift attribute == 'true or its parent has it, false otherwise.
+ */
+export default function isInVCIgnoreIfNoLayoutShiftMarker(element: HTMLElement | null | undefined): boolean;

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

@@ -7,6 +7,7 @@ declare global {
 export declare class VCObserverWrapper implements VCObserverInterface {
     private oldVCObserver;
     private newVCObserver;
+    private ssrPlaceholderHandler;
     constructor(opts?: VCObserverOptions);
     private processSsrAbortListeners;
     start({ startTime, experienceKey }: {
@@ -19,6 +20,7 @@ export declare class VCObserverWrapper implements VCObserverInterface {
     setSSRElement(element: HTMLElement): void;
     setReactRootRenderStart(startTime: number): void;
     setReactRootRenderStop(stopTime: number): void;
+    collectSSRPlaceholders(): void;
 }
 export declare function isEnvironmentSupported(): boolean;
 export declare function getVCObserver(opts?: VCObserverOptions): VCObserverInterface;

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

@@ -30,6 +30,7 @@ export type VCObserverOptions = {
         v: boolean;
         h: boolean;
     };
+    ssrPlaceholderHandler?: any;
 };
 export interface VCObserverInterface {
     start(startArg: {
@@ -42,4 +43,5 @@ export interface VCObserverInterface {
     setSSRElement(element: HTMLElement): void;
     setReactRootRenderStart(startTime?: number): void;
     setReactRootRenderStop(stopTime?: number): void;
+    collectSSRPlaceholders?(): void;
 }

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

@@ -84,6 +84,7 @@ export declare class VCObserver implements VCObserverInterface {
     setSSRElement(element: HTMLElement): void;
     setReactRootRenderStart(startTime?: number): void;
     setReactRootRenderStop(stopTime?: number): void;
+    collectSSRPlaceholders(): void;
     private handleUpdate;
     private setAbortReason;
     private resetState;

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

@@ -1,3 +1,4 @@
+import { SSRPlaceholderHandlers } from './ssr-placeholders';
 import type { BrowserObservers, Callback } from './types';
 export type { ObservedMutationType } from './types';
 export type SelectorConfig = {
@@ -16,6 +17,7 @@ type ConstructorOptions = {
             h: boolean;
         };
     };
+    ssrPlaceholderHandler?: SSRPlaceholderHandlers | null;
 };
 export declare class Observers implements BrowserObservers {
     private intersectionObserver;

package/dist/types-ts4.5/vc/vc-observer/observers/ssr-placeholders/index.d.ts

@@ -25,6 +25,12 @@ export declare class SSRPlaceholderHandlers {
     private getPlaceholderId;
     private getPlaceholderReplacementId;
     clear(): void;
+    private collectPlaceholdersInternal;
+    /**
+     * Added this method to be utilised for testing purposes.
+     * In production it collection placeholder should only happens on constructor
+     */
+    collectExistingPlaceholders(): void;
     isPlaceholder(element: HTMLElement): boolean;
     isPlaceholderReplacement(element: HTMLElement): boolean;
     isPlaceholderIgnored(element: HTMLElement): boolean;

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

@@ -1,9 +1,30 @@
 import { type RevisionPayloadEntry } from '../../common/vc/types';
+import { SSRPlaceholderHandlers } from '../vc-observer/observers/ssr-placeholders';
 import { type SelectorConfig } from './get-element-name';
 import type { VCObserverGetVCResultParam } from './types';
 export type VCObserverNewConfig = {
     selectorConfig?: SelectorConfig;
     isPostInteraction?: boolean;
+    SSRConfig?: {
+        enablePageLayoutPlaceholder?: boolean;
+        disableSizeAndPositionCheck?: {
+            v: boolean;
+            h: boolean;
+        };
+    };
+    ssrPlaceholderHandler?: SSRPlaceholderHandlers | null;
+};
+declare const SSRState: {
+    readonly normal: 1;
+    readonly waitingForFirstRender: 2;
+    readonly ignoring: 3;
+};
+type SSRStateType = (typeof SSRState)[keyof typeof SSRState];
+type SSRInclusiveState = {
+    state: SSRStateType;
+    reactRootElement: HTMLElement | null;
+    renderStop: number;
+    renderStart: number;
 };
 export default class VCObserverNew {
     private selectorConfig;
@@ -11,13 +32,22 @@ export default class VCObserverNew {
     private windowEventObserver;
     private entriesTimeline;
     private isPostInteraction;
+    private ssrPlaceholderHandler;
+    private ssr;
     constructor(config: VCObserverNewConfig);
     start({ startTime }: {
         startTime: DOMHighResTimeStamp;
     }): void;
     stop(): void;
+    setReactRootElement(element: HTMLElement): void;
+    setReactRootRenderStart(startTime?: number): void;
+    setReactRootRenderStop(stopTime?: number): void;
+    collectSSRPlaceholders(): void;
+    getSSRState(): SSRInclusiveState;
+    getSSRPlaceholderHandler(): SSRPlaceholderHandlers | null;
     addSSR(ssr: number): void;
     getVCResult(param: VCObserverGetVCResultParam): Promise<RevisionPayloadEntry[]>;
     private addStartEntry;
     private getElementName;
 }
+export {};

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

@@ -1,5 +1,5 @@
 import type { ObservedWindowEvent } from './window-event-observer';
-export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'layout-shift' | 'window:event' | 'unknown';
+export type VCObserverEntryType = 'mutation:child-element' | 'mutation:remount' | 'mutation:element' | 'mutation:element-replacement' | 'mutation:attribute:no-layout-shift' | 'mutation:attribute:non-visual-style' | 'mutation:attribute' | 'mutation:media' | 'mutation:rll-placeholder' | 'mutation:third-party-element' | 'mutation:ssr-placeholder' | 'layout-shift' | 'window:event' | 'ssr-hydration' | 'unknown';
 export type ViewportEntryData = {
     readonly type: VCObserverEntryType;
     readonly elementName: string;

package/dist/types-ts4.5/vc/vc-observer-new/viewport-observer/index.d.ts

@@ -10,6 +10,8 @@ export type ViewPortObserverConstructorArgs = {
         readonly previousRect: DOMRectReadOnly | undefined;
         readonly mutationData?: MutationData | undefined | null;
     }): void;
+    getSSRState?: () => any;
+    getSSRPlaceholderHandler?: () => any;
 };
 export default class ViewportObserver {
     private intersectionObserver;
@@ -18,7 +20,9 @@ export default class ViewportObserver {
     private mapVisibleNodeRects;
     private onChange;
     private isStarted;
-    constructor({ onChange }: ViewPortObserverConstructorArgs);
+    private getSSRState?;
+    private getSSRPlaceholderHandler?;
+    constructor({ onChange, getSSRState, getSSRPlaceholderHandler, }: ViewPortObserverConstructorArgs);
     private handleIntersectionEntry;
     private handleChildListMutation;
     private handleAttributeMutation;

package/dist/types-ts4.5/vc/vc-observer-new/viewport-observer/mutation-observer/index.d.ts

@@ -9,8 +9,10 @@ export type CreateMutationObserverProps = {
         targets: Array<HTMLElement>;
     }) => void;
     onChildListMutation: (props: {
+        target: WeakRef<HTMLElement>;
         addedNodes: ReadonlyArray<WeakRef<HTMLElement>>;
         removedNodes: ReadonlyArray<WeakRef<HTMLElement>>;
+        timestamp: DOMHighResTimeStamp;
     }) => void;
 };
 declare function createMutationObserver({ onAttributeMutation, onChildListMutation, onMutationFinished, }: CreateMutationObserverProps): MutationObserver | null;

package/dist/types-ts4.5/vc/vc-observer-new/viewport-observer/utils/is-in-vc-ignore-if-no-layout-shift-marker.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Check if the element is in the VC ignore if no layout shift marker.
+ * @param element - The element to check.
+ * @returns True if the element has the data-vc-ignore-if-no-layout-shift attribute == 'true or its parent has it, false otherwise.
+ */
+export default function isInVCIgnoreIfNoLayoutShiftMarker(element: HTMLElement | null | undefined): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "3.14.5",
+	"version": "3.14.7",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -8,8 +8,7 @@
 		"registry": "https://registry.npmjs.org/"
 	},
 	"atlassian": {
-		"team": "UIP Frontend Observability",
-		"runReact18": true
+		"team": "UIP Frontend Observability"
 	},
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
 	"main": "dist/cjs/index.js",
@@ -205,6 +204,12 @@
 		},
 		"platform_ufo_add_type_for_3p_segments": {
 			"type": "boolean"
+		},
+		"platform_vc_ignore_no_ls_mutation_marker": {
+			"type": "boolean"
+		},
+		"platform_ufo_vc_v3_ssr_placeholder": {
+			"type": "boolean"
 		}
 	}
 }