package Torello.Browser.BrowserAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B>Reporting of performance timeline events, as specified in
 * https://w3c.github.io/performance-timeline/#dom-performanceobserver.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class PerformanceTimeline
{
    // No Pubic Constructors
    private PerformanceTimeline() { }



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * See https://github.com/WICG/LargestContentfulPaint and largest_contentful_paint.idl
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=PerformanceTimeline DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class LargestContentfulPaint
        extends BaseType<LargestContentfulPaint>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<PerformanceTimeline.LargestContentfulPaint> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                PerformanceTimeline$$LargestContentfulPaint$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number renderTime;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number loadTime;

        /** The number of pixels being painted. */
        public final Number size;

        /**
         * The id attribute of the element, if available.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String elementId;

        /**
         * The URL of the image (may be trimmed).
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String url;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Integer nodeId;

        /** Constructor.  Please review this class' fields for documentation. */
        public LargestContentfulPaint(
                ReadOnlyList<Boolean> isPresent, Number renderTime, Number loadTime, Number size,
                String elementId, String url, Integer nodeId
            )
        {
            super(singleton, Domains.PerformanceTimeline, "LargestContentfulPaint", 6);

            this.renderTime = renderTime;
            this.loadTime   = loadTime;
            this.size       = size;
            this.elementId  = elementId;
            this.url        = url;
            this.nodeId     = nodeId;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 6, "PerformanceTimeline.LargestContentfulPaint");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static LargestContentfulPaint fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<LargestContentfulPaint> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * See https://wicg.github.io/layout-instability/#sec-layout-shift and layout_shift.idl
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=PerformanceTimeline DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class LayoutShift
        extends BaseType<LayoutShift>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<PerformanceTimeline.LayoutShift> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                PerformanceTimeline$$LayoutShift$$.singleton;

        /** Score increment produced by this event. */
        public final Number value;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final boolean hadRecentInput;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number lastInputTime;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final PerformanceTimeline.LayoutShiftAttribution[] sources;

        /** Constructor.  Please review this class' fields for documentation. */
        public LayoutShift(
                ReadOnlyList<Boolean> isPresent, Number value, boolean hadRecentInput,
                Number lastInputTime, LayoutShiftAttribution[] sources
            )
        {
            super(singleton, Domains.PerformanceTimeline, "LayoutShift", 4);

            this.value          = value;
            this.hadRecentInput = hadRecentInput;
            this.lastInputTime  = lastInputTime;
            this.sources        = sources;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 4, "PerformanceTimeline.LayoutShift");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static LayoutShift fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<LayoutShift> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=PerformanceTimeline DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class LayoutShiftAttribution
        extends BaseType<LayoutShiftAttribution>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<PerformanceTimeline.LayoutShiftAttribution> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                PerformanceTimeline$$LayoutShiftAttribution$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOM.Rect previousRect;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOM.Rect currentRect;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Integer nodeId;

        /** Constructor.  Please review this class' fields for documentation. */
        public LayoutShiftAttribution(
                ReadOnlyList<Boolean> isPresent, DOM.Rect previousRect, DOM.Rect currentRect,
                Integer nodeId
            )
        {
            super(singleton, Domains.PerformanceTimeline, "LayoutShiftAttribution", 3);

            this.previousRect   = previousRect;
            this.currentRect    = currentRect;
            this.nodeId         = nodeId;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 3, "PerformanceTimeline.LayoutShiftAttribution");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static LayoutShiftAttribution fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<LayoutShiftAttribution> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=PerformanceTimeline DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class TimelineEvent
        extends BaseType<TimelineEvent>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<PerformanceTimeline.TimelineEvent> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                PerformanceTimeline$$TimelineEvent$$.singleton;

        /** Identifies the frame that this event is related to. Empty for non-frame targets. */
        public final String frameId;

        /**
         * The event type, as specified in https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
         * This determines which of the optional "details" fields is present.
         */
        public final String type;

        /** Name may be empty depending on the type. */
        public final String name;

        /** Time in seconds since Epoch, monotonically increasing within document lifetime. */
        public final Number time;

        /**
         * Event duration, if applicable.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Number duration;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final PerformanceTimeline.LargestContentfulPaint lcpDetails;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final PerformanceTimeline.LayoutShift layoutShiftDetails;

        /** Constructor.  Please review this class' fields for documentation. */
        public TimelineEvent(
                ReadOnlyList<Boolean> isPresent, String frameId, String type, String name,
                Number time, Number duration, LargestContentfulPaint lcpDetails,
                LayoutShift layoutShiftDetails
            )
        {
            super(singleton, Domains.PerformanceTimeline, "TimelineEvent", 7);

            this.frameId            = frameId;
            this.type               = type;
            this.name               = name;
            this.time               = time;
            this.duration           = duration;
            this.lcpDetails         = lcpDetails;
            this.layoutShiftDetails = layoutShiftDetails;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 7, "PerformanceTimeline.TimelineEvent");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static TimelineEvent fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<TimelineEvent> descriptor()
        { return singleton.descriptor(); }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Event Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Sent when a performance timeline event is added. See reportPerformanceTimeline method.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=PerformanceTimeline DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class timelineEventAdded
        extends BrowserEvent<timelineEventAdded>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<PerformanceTimeline.timelineEventAdded> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                PerformanceTimeline$$timelineEventAdded$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final PerformanceTimeline.TimelineEvent event;

        /** Constructor.  Please review this class' fields for documentation. */
        public timelineEventAdded(ReadOnlyList<Boolean> isPresent, TimelineEvent event)
        {
            super(singleton, Domains.PerformanceTimeline, "timelineEventAdded", 1);

            this.event = event;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "PerformanceTimeline.timelineEventAdded");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static timelineEventAdded fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<timelineEventAdded> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Previously buffered events would be reported before method returns.
     * See also: timelineEventAdded
     * 
     * @param eventTypes 
     * The types of event to report, as specified in
     * https://w3c.github.io/performance-timeline/#dom-performanceentry-entrytype
     * The specified filter overrides any previous filters, passing empty
     * filter disables recording.
     * Note that not all types exposed to the web platform are currently supported.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> enable(String[] eventTypes)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.STRING_ARRAY_1D, "eventTypes", false, "PerformanceTimeline.enable",
            (Object) eventTypes
        );

        return Script.NO_RET(Domains.PerformanceTimeline, "enable", requestJSON);
    }


}