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.Autofill$$Commands;


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

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

/**
 * <SPAN CLASS=COPIEDJDK><B>Defines commands and events for Autofill.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class Autofill
{
    // No Pubic Constructors
    private Autofill() { }


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


    /**
     * Specified whether a filled field was done so by using the html autocomplete attribute or autofill heuristics.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> FillingStrategy = new ReadOnlyArrayList<>
        (String.class, "autocompleteAttribute", "autofillInferred");



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


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

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

        /** fields and values defining an address. */
        public final Autofill.AddressField[] fields;

        /** Constructor.  Please review this class' fields for documentation. */
        public Address(ReadOnlyList<Boolean> isPresent, AddressField[] fields)
        {
            super(singleton, Domains.Autofill, "Address", 1);

            this.fields = fields;

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

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

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

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

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

        /** address field name, for example GIVEN_NAME. */
        public final String name;

        /** address field value, for example Jon Doe. */
        public final String value;

        /** Constructor.  Please review this class' fields for documentation. */
        public AddressField(ReadOnlyList<Boolean> isPresent, String name, String value)
        {
            super(singleton, Domains.Autofill, "AddressField", 2);

            this.name   = name;
            this.value  = value;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Autofill.AddressField");
        }

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

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

    /**
     * A list of address fields.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Autofill DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class AddressFields
        extends BaseType<AddressFields>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Autofill.AddressField[] fields;

        /** Constructor.  Please review this class' fields for documentation. */
        public AddressFields(ReadOnlyList<Boolean> isPresent, AddressField[] fields)
        {
            super(singleton, Domains.Autofill, "AddressFields", 1);

            this.fields = fields;

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

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

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

    /**
     * Defines how an address can be displayed like in chrome://settings/addresses.
     * Address UI is a two dimensional array, each inner array is an "address information line", and when rendered in a UI surface should be displayed as such.
     * The following address UI for instance:
     * [[{name: "GIVE_NAME", value: "Jon"}, {name: "FAMILY_NAME", value: "Doe"}], [{name: "CITY", value: "Munich"}, {name: "ZIP", value: "81456"}]]
     * should allow the receiver to render:
     * Jon Doe
     * Munich 81456
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Autofill DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class AddressUI
        extends BaseType<AddressUI>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** A two dimension array containing the representation of values from an address profile. */
        public final Autofill.AddressFields[] addressFields;

        /** Constructor.  Please review this class' fields for documentation. */
        public AddressUI(ReadOnlyList<Boolean> isPresent, AddressFields[] addressFields)
        {
            super(singleton, Domains.Autofill, "AddressUI", 1);

            this.addressFields = addressFields;

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

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

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

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

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

        /** 16-digit credit card number. */
        public final String number;

        /** Name of the credit card owner. */
        public final String name;

        /** 2-digit expiry month. */
        public final String expiryMonth;

        /** 4-digit expiry year. */
        public final String expiryYear;

        /** 3-digit card verification code. */
        public final String cvc;

        /** Constructor.  Please review this class' fields for documentation. */
        public CreditCard(
                ReadOnlyList<Boolean> isPresent, String number, String name, String expiryMonth,
                String expiryYear, String cvc
            )
        {
            super(singleton, Domains.Autofill, "CreditCard", 5);

            this.number         = number;
            this.name           = name;
            this.expiryMonth    = expiryMonth;
            this.expiryYear     = expiryYear;
            this.cvc            = cvc;

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

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

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

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

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

        /** The type of the field, e.g text, password etc. */
        public final String htmlType;

        /** the html id */
        public final String id;

        /** the html name */
        public final String name;

        /** the field value */
        public final String value;

        /** The actual field type, e.g FAMILY_NAME */
        public final String autofillType;

        /**
         * The filling strategy
         * <EMBED CLASS='external-html' DATA-D=Autofill DATA-C=FillingStrategy DATA-F=fillingStrategy DATA-FILE-ID=CDP.EL2>
         * @see BaseType#enumStrList(String)
         */
        public final String fillingStrategy;

        /** The frame the field belongs to */
        public final String frameId;

        /** The form field's DOM node */
        public final int fieldId;

        /** Constructor.  Please review this class' fields for documentation. */
        public FilledField(
                ReadOnlyList<Boolean> isPresent, String htmlType, String id, String name,
                String value, String autofillType, String fillingStrategy, String frameId,
                int fieldId
            )
        {
            super(singleton, Domains.Autofill, "FilledField", 8);

            this.htmlType           = htmlType;
            this.id                 = id;
            this.name               = name;
            this.value              = value;
            this.autofillType       = autofillType;
            this.fillingStrategy    = fillingStrategy;
            this.frameId            = frameId;
            this.fieldId            = fieldId;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 8, "Autofill.FilledField");
        }

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

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


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


    /**
     * Emitted when an address form is filled.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Autofill DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class addressFormFilled
        extends BrowserEvent<addressFormFilled>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** Information about the fields that were filled */
        public final Autofill.FilledField[] filledFields;

        /**
         * An UI representation of the address used to fill the form.
         * Consists of a 2D array where each child represents an address/profile line.
         */
        public final Autofill.AddressUI addressUi;

        /** Constructor.  Please review this class' fields for documentation. */
        public addressFormFilled
            (ReadOnlyList<Boolean> isPresent, FilledField[] filledFields, AddressUI addressUi)
        {
            super(singleton, Domains.Autofill, "addressFormFilled", 2);

            this.filledFields   = filledFields;
            this.addressUi      = addressUi;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Autofill.addressFormFilled");
        }

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

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




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


    /**
     * Disables autofill domain notifications.
     * 
     * @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\":\"Autofill.disable\"}";

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

    /**
     * Enables autofill domain notifications.
     * 
     * @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()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Autofill.enable\"}";

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

    /**
     * Set addresses so that developers can verify their forms implementation.
     * 
     * @param addresses -
     * 
     * @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> setAddresses(Address[] addresses)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.CDP_TYPE_ARRAY_1D, "addresses", false, "Autofill.setAddresses", (Object)
            addresses
        );

        return Script.NO_RET(Domains.Autofill, "setAddresses", requestJSON);
    }

    /**
     * Trigger autofill on a form identified by the fieldId.
     * If the field and related form cannot be autofilled, returns an error.
     * 
     * @param fieldId Identifies a field that serves as an anchor for autofill.
     * 
     * @param frameId Identifies the frame that field belongs to.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param card Credit card information to fill out the form. Credit card data is not saved.
     * 
     * @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> trigger(int fieldId, String frameId, CreditCard card)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            Autofill$$Commands.trigger$$, "Autofill.trigger",
            fieldId, frameId, card
        );

        return Script.NO_RET(Domains.Autofill, "trigger", requestJSON);
    }


}