vFace Web

npm install ./vface-web.tgz

import { VFaceWeb } from "vface-web";
let vface = new VFaceWeb({
    // Other options are documented in the 
    // "Additional Constructor Options" section.
    licence: "licence_string"
});

let authenticate_promise = vface.authenticateGetTemplate();

let enroll_promise = vface.enroll();

vface.authenticateGetTemplate().then(value => {
    alert(`Got template! It's got a length of: ${value.length}!`);
}).catch(reason => {
    alert(`Failed to get template! ${JSON.stringify(reason)}`);
});

let authenticate_promise = vface.authenticateGetTemplate({
  config: {
    liveness: false,
    liveness_factor: 49
  }
});

let json_config_string = "{}";
let enrol_promise = vface.enroll({
  config: {
    liveness: true,
    with_export: true
  }
});

let vface = new VFaceWeb({
    additional_css: ".vface {--accent-color: hotpink; }"
});

vface.uiZoo();

/** VFace licence string. */
licence?: string | Promise<string>;

/** Optional URL for vface-web-worker.js 
 * 
 * The library will discover the correct path for this file in most 
 * circumstances.  This only needs to be set if that discovery doesn't 
 * work. */
worker_url?: string | Promise<string>;

/** Optional URL for vface_web_runtime.wasm 
 * 
 * The library will discover the correct path for this file in most 
 * circumstances.  This only needs to be set if that discovery doesn't 
 * work. */
wasm_url?: string | Promise<string>;

/** Optional URL for vface_web_runtime_simd.wasm 
 * 
 * The library will discover the correct path for this file in most 
 * circumstances.  This only needs to be set if that discovery doesn't 
 * work. */
wasm_simd_url?: string | Promise<string>;

/** Specifies the level of logging emitted by the library.
 * 
 * Ordered by least verbose to most verbose. */
log_level?: "silence" | "error" | "warning" | "log" | "verbose";

/** Specifies the UI to extend all the way to the edges of the page,
 * rather than appearing in a floating box. */
ui_full_bleed?: boolean;

/** The VFace UI is normally injected into a shadow DOM; this option
 * causes it to be injected into the regular DOM. */
ui_no_shadow_dom?: boolean;

/** Override specific localisation tokens 
 * 
 * The library has built-in localisations for English, Spanish and 
 * French, which will be selected automatically based on the user's 
 * browser language. Those localisations can be overriden on a
 * per-token basis using this option.
*/
localisation?: { [Key in LocalisationToken]: string };

/** Used to disable the functionality for selecting a camera. */
disable_camera_select?: boolean;

/** Additional CSS which will be appended after the built-in styling.
 * This allows the styling of the UI to be customised.
 * Use {@link IVFaceWeb.uiZoo} to test that custom styling appears 
 * correctly for all possible UI states.
*/
additional_css?: string;

/** Allows the remember camera functionality to be switched on or off. 
 * Defaults to `true`
 * 
 * The remember camera functionality uses local storage to remember the 
 * user's preferences for camera selection.
 */
remember_camera?: boolean;

interface Config {
    liveness?: boolean;
    liveness_factor?: number;
    packDevData?: boolean;
    with_export?: boolean;
}

interface CommonOptions {
    /** Configuration options */
    config?: Config;
}

export interface EnrollOptions extends CommonOptions {
}

export interface AuthOptions extends CommonOptions {
}

export interface IVFaceWeb {
    /** Presents the VFace Web UI to enroll (generate an enrollment
     * template for) a user.
     * @returns A promise which resolves with a string containing a 
     * data: URL for the template.
     * Rejects with a {@link VFaceError}  */
    enroll(options?: EnrollOptions): Promise<string>;

    /** Presents the VFace Web UI to generate an authentication
     * template for a user.
     * @returns A promise which resolves with a string containing a
     * data: URL for the template.
     * Rejects with a {@link VFaceError}  */
    authenticateGetTemplate(options?: AuthOptions): Promise<string>;

    /** Presents the VFace Web UI to authenticate a user.
     * 
     * !!! NOTE: Only available if the VFace Web build includes the 
     * matching model, which is *not* the default.
     * 
     * @returns A promise which resolves to true if the user matches 
     * the provided enrollment template.
     * 
     * Rejects with a {@link VFaceError} */
    authenticate(template: string | Promise<string>, options?: AuthOptions): Promise<boolean>;

    /** Set the licence for the VFace library, if it wasn't set in the 
     * constructor */
    setLicence(licence: string | Promise<string>): Promise<void>;

    /** Get the version number of VFace Web. */
    version(): string;

    /** Get the git commit id that this version of VFace Web was built 
     * from. */
    git_version(): string;

    /** Displays the UI zoo, which randomly cycles through many
     * possible states for the VFace Web UI.
     *
     * This is to verify that the UI is styled correctly, especially
     * when using the `additional_css` option in the constructor.
     * @returns A dummy promise, to match the return types of the
     * enroll and authenticate functions. */
    uiZoo(): Promise<string>;
}