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;

import Torello.Browser.BrowserAPI.NestedHelpers.Commands.FedCm$$Commands;


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

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

/**
 * <SPAN CLASS=COPIEDJDK><B>This domain allows interacting with the FedCM dialog.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class FedCm
{
    // No Pubic Constructors
    private FedCm() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Enumerated String Constants Lists
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * The URLs that each account has
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> AccountUrlType = new ReadOnlyArrayList<>
        (String.class, "PrivacyPolicy", "TermsOfService");

    /**
     * The buttons on the FedCM dialog.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> DialogButton = new ReadOnlyArrayList<>
        (String.class, "ConfirmIdpLoginContinue", "ErrorGotIt", "ErrorMoreDetails");

    /**
     * The types of FedCM dialogs.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> DialogType = new ReadOnlyArrayList<>
        (String.class, "AccountChooser", "AutoReauthn", "ConfirmIdpLogin", "Error");

    /**
     * Whether this is a sign-up or sign-in action for this account, i.e.
     * whether this account has ever been used to sign in to this RP before.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> LoginState = new ReadOnlyArrayList<>
        (String.class, "SignIn", "SignUp");



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


    /**
     * Corresponds to IdentityRequestAccount
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=FedCm DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class Account
        extends BaseType<Account>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String accountId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String email;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String name;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String givenName;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String pictureUrl;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String idpConfigUrl;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String idpLoginUrl;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <EMBED CLASS='external-html' DATA-D=FedCm DATA-C=LoginState DATA-F=loginState DATA-FILE-ID=CDP.EL2>
         * @see BaseType#enumStrList(String)
         */
        public final String loginState;

        /**
         * These two are only set if the loginState is signUp
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String termsOfServiceUrl;

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

        /** Constructor.  Please review this class' fields for documentation. */
        public Account(
                ReadOnlyList<Boolean> isPresent, String accountId, String email, String name,
                String givenName, String pictureUrl, String idpConfigUrl, String idpLoginUrl,
                String loginState, String termsOfServiceUrl, String privacyPolicyUrl
            )
        {
            super(singleton, Domains.FedCm, "Account", 10);

            this.accountId          = accountId;
            this.email              = email;
            this.name               = name;
            this.givenName          = givenName;
            this.pictureUrl         = pictureUrl;
            this.idpConfigUrl       = idpConfigUrl;
            this.idpLoginUrl        = idpLoginUrl;
            this.loginState         = loginState;
            this.termsOfServiceUrl  = termsOfServiceUrl;
            this.privacyPolicyUrl   = privacyPolicyUrl;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 10, "FedCm.Account");
        }

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

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


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


    /**
     * Triggered when a dialog is closed, either by user action, JS abort,
     * or a command below.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=FedCm DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class dialogClosed
        extends BrowserEvent<dialogClosed>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String dialogId;

        /** Constructor.  Please review this class' fields for documentation. */
        public dialogClosed(ReadOnlyList<Boolean> isPresent, String dialogId)
        {
            super(singleton, Domains.FedCm, "dialogClosed", 1);

            this.dialogId = dialogId;

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

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

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

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

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String dialogId;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <EMBED CLASS='external-html' DATA-D=FedCm DATA-C=DialogType DATA-F=dialogType DATA-FILE-ID=CDP.EL2>
         * @see BaseType#enumStrList(String)
         */
        public final String dialogType;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final FedCm.Account[] accounts;

        /**
         * These exist primarily so that the caller can verify the
         * RP context was used appropriately.
         */
        public final String title;

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

        /** Constructor.  Please review this class' fields for documentation. */
        public dialogShown(
                ReadOnlyList<Boolean> isPresent, String dialogId, String dialogType,
                Account[] accounts, String title, String subtitle
            )
        {
            super(singleton, Domains.FedCm, "dialogShown", 5);

            this.dialogId   = dialogId;
            this.dialogType = dialogType;
            this.accounts   = accounts;
            this.title      = title;
            this.subtitle   = subtitle;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 5, "FedCm.dialogShown");
        }

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

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




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


    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param dialogId -
     * 
     * @param dialogButton -
     * 
     * @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> clickDialogButton(String dialogId, String dialogButton)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            FedCm$$Commands.clickDialogButton$$, "FedCm.clickDialogButton",
            dialogId, dialogButton
        );

        return Script.NO_RET(Domains.FedCm, "clickDialogButton", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @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> disable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"FedCm.disable\"}";

        return Script.NO_RET(Domains.FedCm, "disable", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param dialogId -
     * 
     * @param triggerCooldown -
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @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> dismissDialog(String dialogId, Boolean triggerCooldown)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            FedCm$$Commands.dismissDialog$$, "FedCm.dismissDialog",
            dialogId, triggerCooldown
        );

        return Script.NO_RET(Domains.FedCm, "dismissDialog", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param disableRejectionDelay 
     * Allows callers to disable the promise rejection delay that would
     * normally happen, if this is unimportant to what's being tested.
     * (step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @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(Boolean disableRejectionDelay)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.BOXED_BOOLEAN, "disableRejectionDelay", true, "FedCm.enable",
            disableRejectionDelay
        );

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

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param dialogId -
     * 
     * @param accountIndex -
     * 
     * @param accountUrlType -
     * 
     * @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> openUrl(String dialogId, int accountIndex, String accountUrlType)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            FedCm$$Commands.openUrl$$, "FedCm.openUrl",
            dialogId, accountIndex, accountUrlType
        );

        return Script.NO_RET(Domains.FedCm, "openUrl", requestJSON);
    }

    /**
     * Resets the cooldown time, if any, to allow the next FedCM call to show
     * a dialog even if one was recently dismissed by the user.
     * 
     * @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> resetCooldown()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"FedCm.resetCooldown\"}";

        return Script.NO_RET(Domains.FedCm, "resetCooldown", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param dialogId -
     * 
     * @param accountIndex -
     * 
     * @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> selectAccount(String dialogId, int accountIndex)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            FedCm$$Commands.selectAccount$$, "FedCm.selectAccount",
            dialogId, accountIndex
        );

        return Script.NO_RET(Domains.FedCm, "selectAccount", requestJSON);
    }


}