/**
 * Namespace: browser.privacy.websites
 * Generated from Mozilla sources. Do not manually edit!
 *
 * Use the <code>browser.privacy</code> API to control usage of the features in the browser that can affect a user's
 * privacy.
 * Permissions: "privacy"
 *
 * Comments found in source JSON schema files:
 * Copyright (c) 2012 The Chromium Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */
import { Types } from "./types";

export namespace PrivacyWebsites {
    /**
     * The mode for tracking protection.
     */
    type TrackingProtectionModeOption = "always" | "never" | "private_browsing";

    /**
     * The settings for cookies.
     */
    interface CookieConfig {
        /**
         * The type of cookies to allow.
         * Optional.
         */
        behavior?: CookieConfigBehaviorEnum;

        /**
         * Whether to create all cookies as nonPersistent (i.e., session) cookies.
         * Optional.
         */
        nonPersistentCookies?: boolean;
    }

    /**
     * The type of cookies to allow.
     */
    type CookieConfigBehaviorEnum =
        | "allow_all"
        | "reject_all"
        | "reject_third_party"
        | "allow_visited"
        | "reject_trackers"
        | "reject_trackers_and_partition_foreign";

    interface Static {
        /**
         * If enabled, the browser sends auditing pings when requested by a website (<code>&lt;a ping&gt;</code>).
         * The value of this preference is of type boolean, and the default value is <code>true</code>.
         */
        hyperlinkAuditingEnabled: Types.Setting;

        /**
         * If enabled, the browser sends <code>referer</code> headers with your requests. Yes,
         * the name of this preference doesn't match the misspelled header. No, we're not going to change it.
         * The value of this preference is of type boolean, and the default value is <code>true</code>.
         */
        referrersEnabled: Types.Setting;

        /**
         * If enabled, the browser attempts to appear similar to other users by reporting generic information to websites.
         * This can prevent websites from uniquely identifying users. Examples of data that is spoofed include number of CPU cores,
         * precision of JavaScript timers, the local timezone, and disabling features such as GamePad support,
         * and the WebSpeech and Navigator APIs. The value of this preference is of type boolean, and the default value is <code>
         * false</code>.
         */
        resistFingerprinting: Types.Setting;

        /**
         * If enabled, the browser will associate all data (including cookies, HSTS data, cached images, and more)
         * for any third party domains with the domain in the address bar. This prevents third party trackers from using directly
         * stored information to identify you across different websites, but may break websites where you login with a third party
         * account (such as a Facebook or Google login.) The value of this preference is of type boolean,
         * and the default value is <code>false</code>.
         */
        firstPartyIsolate: Types.Setting;

        /**
         * Allow users to specify the mode for tracking protection. This setting's value is of type TrackingProtectionModeOption,
         * defaulting to <code>private_browsing_only</code>.
         */
        trackingProtectionMode: Types.Setting;

        /**
         * Allow users to specify the default settings for allowing cookies, as well as whether all cookies should be created as
         * non-persistent cookies. This setting's value is of type CookieConfig.
         */
        cookieConfig: Types.Setting;
    }
}