package Torello.Browser;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Java.Additional.*;
import Torello.Java.JSON.*;

import static Torello.Java.JSON.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=COPIEDJDK><B>This domain allows configuring virtual authenticators to test the WebAuthn
 * API.</B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class WebAuthn
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private WebAuthn () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : WebAuthn.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        parameterNames.put("enable", EMPTY_VEC_STR);

        parameterNames.put("disable", EMPTY_VEC_STR);

        v = new Vector<String>(1);
        parameterNames.put("addVirtualAuthenticator", v);
        Collections.addAll(v, new String[]
        { "options", });

        v = new Vector<String>(1);
        parameterNames.put("removeVirtualAuthenticator", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", });

        v = new Vector<String>(2);
        parameterNames.put("addCredential", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", "credential", });

        v = new Vector<String>(2);
        parameterNames.put("getCredential", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", "credentialId", });

        v = new Vector<String>(1);
        parameterNames.put("getCredentials", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", });

        v = new Vector<String>(2);
        parameterNames.put("removeCredential", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", "credentialId", });

        v = new Vector<String>(1);
        parameterNames.put("clearCredentials", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", });

        v = new Vector<String>(2);
        parameterNames.put("setUserVerified", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", "isUserVerified", });

        v = new Vector<String>(2);
        parameterNames.put("setAutomaticPresenceSimulation", v);
        Collections.addAll(v, new String[]
        { "authenticatorId", "enabled", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    // public static class AuthenticatorId => String
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static final String[] AuthenticatorProtocol =
    { "u2f", "ctap2", };
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static final String[] Ctap2Version =
    { "ctap2_0", "ctap2_1", };
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static final String[] AuthenticatorTransport =
    { "usb", "nfc", "ble", "cable", "internal", };
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class VirtualAuthenticatorOptions
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, true, false, true, true, true, true, true, true, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String protocol;
        
        /**
         * Defaults to ctap2_0. Ignored if |protocol| == u2f.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String ctap2Version;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String transport;
        
        /**
         * Defaults to false.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean hasResidentKey;
        
        /**
         * Defaults to false.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean hasUserVerification;
        
        /**
         * If set to true, the authenticator will support the largeBlob extension.
         * https://w3c.github.io/webauthn#largeBlob
         * Defaults to false.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean hasLargeBlob;
        
        /**
         * If set to true, the authenticator will support the credBlob extension.
         * https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
         * Defaults to false.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean hasCredBlob;
        
        /**
         * If set to true, tests of user presence will succeed immediately.
         * Otherwise, they will not be resolved. Defaults to true.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean automaticPresenceSimulation;
        
        /**
         * Sets whether User Verification succeeds or fails for an authenticator.
         * Defaults to false.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean isUserVerified;
        
        /**
         * Constructor
         *
         * @param protocol -
         * 
         * @param ctap2Version Defaults to ctap2_0. Ignored if |protocol| == u2f.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param transport -
         * 
         * @param hasResidentKey Defaults to false.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param hasUserVerification Defaults to false.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param hasLargeBlob 
         * If set to true, the authenticator will support the largeBlob extension.
         * https://w3c.github.io/webauthn#largeBlob
         * Defaults to false.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param hasCredBlob 
         * If set to true, the authenticator will support the credBlob extension.
         * https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
         * Defaults to false.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param automaticPresenceSimulation 
         * If set to true, tests of user presence will succeed immediately.
         * Otherwise, they will not be resolved. Defaults to true.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param isUserVerified 
         * Sets whether User Verification succeeds or fails for an authenticator.
         * Defaults to false.
         * <BR /><B>OPTIONAL</B>
         */
        public VirtualAuthenticatorOptions(
                String protocol, String ctap2Version, String transport, Boolean hasResidentKey, 
                Boolean hasUserVerification, Boolean hasLargeBlob, Boolean hasCredBlob, 
                Boolean automaticPresenceSimulation, Boolean isUserVerified
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (protocol == null)  BRDPC.throwNPE("protocol");
            if (transport == null) BRDPC.throwNPE("transport");
            
            // Exception-Check(s) to ensure that if any parameters which must adhere to a
            // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
            
            BRDPC.checkIAE("protocol", protocol, "WebAuthn.AuthenticatorProtocol", WebAuthn.AuthenticatorProtocol);
            BRDPC.checkIAE("ctap2Version", ctap2Version, "WebAuthn.Ctap2Version", WebAuthn.Ctap2Version);
            BRDPC.checkIAE("transport", transport, "WebAuthn.AuthenticatorTransport", WebAuthn.AuthenticatorTransport);
            
            this.protocol                     = protocol;
            this.ctap2Version                 = ctap2Version;
            this.transport                    = transport;
            this.hasResidentKey               = hasResidentKey;
            this.hasUserVerification          = hasUserVerification;
            this.hasLargeBlob                 = hasLargeBlob;
            this.hasCredBlob                  = hasCredBlob;
            this.automaticPresenceSimulation  = automaticPresenceSimulation;
            this.isUserVerified               = isUserVerified;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'VirtualAuthenticatorOptions'}.
         */
        public VirtualAuthenticatorOptions (JsonObject jo)
        {
            this.protocol                     = ReadJSON.getString(jo, "protocol", false, true);
            this.ctap2Version                 = ReadJSON.getString(jo, "ctap2Version", true, false);
            this.transport                    = ReadJSON.getString(jo, "transport", false, true);
            this.hasResidentKey               = ReadBoxedJSON.getBoolean(jo, "hasResidentKey", true);
            this.hasUserVerification          = ReadBoxedJSON.getBoolean(jo, "hasUserVerification", true);
            this.hasLargeBlob                 = ReadBoxedJSON.getBoolean(jo, "hasLargeBlob", true);
            this.hasCredBlob                  = ReadBoxedJSON.getBoolean(jo, "hasCredBlob", true);
            this.automaticPresenceSimulation  = ReadBoxedJSON.getBoolean(jo, "automaticPresenceSimulation", true);
            this.isUserVerified               = ReadBoxedJSON.getBoolean(jo, "isUserVerified", true);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            VirtualAuthenticatorOptions o = (VirtualAuthenticatorOptions) other;
        
            return
                    Objects.equals(this.protocol, o.protocol)
                &&  Objects.equals(this.ctap2Version, o.ctap2Version)
                &&  Objects.equals(this.transport, o.transport)
                &&  Objects.equals(this.hasResidentKey, o.hasResidentKey)
                &&  Objects.equals(this.hasUserVerification, o.hasUserVerification)
                &&  Objects.equals(this.hasLargeBlob, o.hasLargeBlob)
                &&  Objects.equals(this.hasCredBlob, o.hasCredBlob)
                &&  Objects.equals(this.automaticPresenceSimulation, o.automaticPresenceSimulation)
                &&  Objects.equals(this.isUserVerified, o.isUserVerified);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.protocol)
                +   Objects.hashCode(this.ctap2Version)
                +   Objects.hashCode(this.transport)
                +   Objects.hashCode(this.hasResidentKey)
                +   Objects.hashCode(this.hasUserVerification)
                +   Objects.hashCode(this.hasLargeBlob)
                +   Objects.hashCode(this.hasCredBlob)
                +   Objects.hashCode(this.automaticPresenceSimulation)
                +   Objects.hashCode(this.isUserVerified);
        }
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class Credential
        extends BaseType
        implements java.io.Serializable
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, true, false, true, false, true, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String credentialId;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final boolean isResidentCredential;
        
        /**
         * Relying Party ID the credential is scoped to. Must be set when adding a
         * credential.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String rpId;
        
        /** The ECDSA P-256 private key in PKCS#8 format. (Encoded as a base64 string when passed over JSON) */
        public final String privateKey;
        
        /**
         * An opaque byte sequence with a maximum size of 64 bytes mapping the
         * credential to a specific user. (Encoded as a base64 string when passed over JSON)
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String userHandle;
        
        /**
         * Signature counter. This is incremented by one for each successful
         * assertion.
         * See https://w3c.github.io/webauthn/#signature-counter
         */
        public final int signCount;
        
        /**
         * The large blob associated with the credential.
         * See https://w3c.github.io/webauthn/#sctn-large-blob-extension (Encoded as a base64 string when passed over JSON)
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String largeBlob;
        
        /**
         * Constructor
         *
         * @param credentialId -
         * 
         * @param isResidentCredential -
         * 
         * @param rpId 
         * Relying Party ID the credential is scoped to. Must be set when adding a
         * credential.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param privateKey The ECDSA P-256 private key in PKCS#8 format. (Encoded as a base64 string when passed over JSON)
         * 
         * @param userHandle 
         * An opaque byte sequence with a maximum size of 64 bytes mapping the
         * credential to a specific user. (Encoded as a base64 string when passed over JSON)
         * <BR /><B>OPTIONAL</B>
         * 
         * @param signCount 
         * Signature counter. This is incremented by one for each successful
         * assertion.
         * See https://w3c.github.io/webauthn/#signature-counter
         * 
         * @param largeBlob 
         * The large blob associated with the credential.
         * See https://w3c.github.io/webauthn/#sctn-large-blob-extension (Encoded as a base64 string when passed over JSON)
         * <BR /><B>OPTIONAL</B>
         */
        public Credential(
                String credentialId, boolean isResidentCredential, String rpId, String privateKey, 
                String userHandle, int signCount, String largeBlob
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (credentialId == null) BRDPC.throwNPE("credentialId");
            if (privateKey == null)   BRDPC.throwNPE("privateKey");
            
            this.credentialId          = credentialId;
            this.isResidentCredential  = isResidentCredential;
            this.rpId                  = rpId;
            this.privateKey            = privateKey;
            this.userHandle            = userHandle;
            this.signCount             = signCount;
            this.largeBlob             = largeBlob;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'Credential'}.
         */
        public Credential (JsonObject jo)
        {
            this.credentialId          = ReadJSON.getString(jo, "credentialId", false, true);
            this.isResidentCredential  = ReadPrimJSON.getBoolean(jo, "isResidentCredential");
            this.rpId                  = ReadJSON.getString(jo, "rpId", true, false);
            this.privateKey            = ReadJSON.getString(jo, "privateKey", false, true);
            this.userHandle            = ReadJSON.getString(jo, "userHandle", true, false);
            this.signCount             = ReadPrimJSON.getInt(jo, "signCount");
            this.largeBlob             = ReadJSON.getString(jo, "largeBlob", true, false);
        }
        
        
        /** Checks whether {@code 'this'} equals an input Java-{@code Object} */
        public boolean equals(Object other)
        {
            if (other == null)                       return false;
            if (other.getClass() != this.getClass()) return false;
        
            Credential o = (Credential) other;
        
            return
                    Objects.equals(this.credentialId, o.credentialId)
                &&  (this.isResidentCredential == o.isResidentCredential)
                &&  Objects.equals(this.rpId, o.rpId)
                &&  Objects.equals(this.privateKey, o.privateKey)
                &&  Objects.equals(this.userHandle, o.userHandle)
                &&  (this.signCount == o.signCount)
                &&  Objects.equals(this.largeBlob, o.largeBlob);
        }
        
        /** Generates a Hash-Code for {@code 'this'} instance */
        public int hashCode()
        {
            return
                    Objects.hashCode(this.credentialId)
                +   (this.isResidentCredential ? 1 : 0)
                +   Objects.hashCode(this.rpId)
                +   Objects.hashCode(this.privateKey)
                +   Objects.hashCode(this.userHandle)
                +   this.signCount
                +   Objects.hashCode(this.largeBlob);
        }
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Enable the WebAuthn domain and start intercepting credential storage and
     * retrieval with a virtual authenticator.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> enable()
    {
        final int          webSocketID = 44000000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("enable"),
            parameterNames.get("enable"),
            optionals, webSocketID,
            "WebAuthn.enable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Disable the WebAuthn domain.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> disable()
    {
        final int          webSocketID = 44001000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("disable"),
            parameterNames.get("disable"),
            optionals, webSocketID,
            "WebAuthn.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Creates and adds a virtual authenticator.
     * 
     * @param options -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * String&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>String (<B>authenticatorId</B></CODE>)
     *     <BR />-
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, String> addVirtualAuthenticator
        (WebAuthn.VirtualAuthenticatorOptions options)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (options == null) BRDPC.throwNPE("options");
        
        final int       webSocketID = 44002000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("addVirtualAuthenticator"),
            parameterNames.get("addVirtualAuthenticator"),
            optionals, webSocketID,
            "WebAuthn.addVirtualAuthenticator",
            options
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'String'
        Function<JsonObject, String> responseProcessor = (JsonObject jo) ->
            ReadJSON.getString(jo, "authenticatorId", false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Removes the given authenticator.
     * 
     * @param authenticatorId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> removeVirtualAuthenticator
        (String authenticatorId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        
        final int       webSocketID = 44003000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("removeVirtualAuthenticator"),
            parameterNames.get("removeVirtualAuthenticator"),
            optionals, webSocketID,
            "WebAuthn.removeVirtualAuthenticator",
            authenticatorId
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Adds the credential to the specified authenticator.
     * 
     * @param authenticatorId -
     * 
     * @param credential -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> addCredential
        (String authenticatorId, WebAuthn.Credential credential)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        if (credential == null)      BRDPC.throwNPE("credential");
        
        final int       webSocketID = 44004000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("addCredential"),
            parameterNames.get("addCredential"),
            optionals, webSocketID,
            "WebAuthn.addCredential",
            authenticatorId, credential
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Returns a single credential stored in the given virtual authenticator that
     * matches the credential ID.
     * 
     * @param authenticatorId -
     * 
     * @param credentialId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link WebAuthn.Credential}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link WebAuthn.Credential}&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link WebAuthn.Credential} (<B>credential</B></CODE>)
     *     <BR />-
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, WebAuthn.Credential> getCredential
        (String authenticatorId, String credentialId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        if (credentialId == null)    BRDPC.throwNPE("credentialId");
        
        final int       webSocketID = 44005000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getCredential"),
            parameterNames.get("getCredential"),
            optionals, webSocketID,
            "WebAuthn.getCredential",
            authenticatorId, credentialId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'WebAuthn.Credential'
        Function<JsonObject, WebAuthn.Credential> responseProcessor = (JsonObject jo) ->
            ReadJSON.getObject(jo, "credential", WebAuthn.Credential.class, false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Returns all the credentials stored in the given virtual authenticator.
     * 
     * @param authenticatorId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link WebAuthn.Credential}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link WebAuthn.Credential}[]&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link WebAuthn.Credential}[] (<B>credentials</B></CODE>)
     *     <BR />-
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, WebAuthn.Credential[]> getCredentials
        (String authenticatorId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        
        final int       webSocketID = 44006000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getCredentials"),
            parameterNames.get("getCredentials"),
            optionals, webSocketID,
            "WebAuthn.getCredentials",
            authenticatorId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'WebAuthn.Credential[]'
        Function<JsonObject, WebAuthn.Credential[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("credentials") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("credentials"), null, 0, WebAuthn.Credential[].class);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Removes a credential from the authenticator.
     * 
     * @param authenticatorId -
     * 
     * @param credentialId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> removeCredential
        (String authenticatorId, String credentialId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        if (credentialId == null)    BRDPC.throwNPE("credentialId");
        
        final int       webSocketID = 44007000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("removeCredential"),
            parameterNames.get("removeCredential"),
            optionals, webSocketID,
            "WebAuthn.removeCredential",
            authenticatorId, credentialId
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Clears all the credentials from the specified device.
     * 
     * @param authenticatorId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> clearCredentials(String authenticatorId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        
        final int       webSocketID = 44008000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("clearCredentials"),
            parameterNames.get("clearCredentials"),
            optionals, webSocketID,
            "WebAuthn.clearCredentials",
            authenticatorId
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Sets whether User Verification succeeds or fails for an authenticator.
     * The default is true.
     * 
     * @param authenticatorId -
     * 
     * @param isUserVerified -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> setUserVerified
        (String authenticatorId, boolean isUserVerified)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        
        final int       webSocketID = 44009000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("setUserVerified"),
            parameterNames.get("setUserVerified"),
            optionals, webSocketID,
            "WebAuthn.setUserVerified",
            authenticatorId, isUserVerified
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
     * The default is true.
     * 
     * @param authenticatorId -
     * 
     * @param enabled -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> setAutomaticPresenceSimulation
        (String authenticatorId, boolean enabled)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (authenticatorId == null) BRDPC.throwNPE("authenticatorId");
        
        final int       webSocketID = 44010000 + counter++;
        final boolean[] optionals   = { false, false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("setAutomaticPresenceSimulation"),
            parameterNames.get("setAutomaticPresenceSimulation"),
            optionals, webSocketID,
            "WebAuthn.setAutomaticPresenceSimulation",
            authenticatorId, enabled
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
}