chrome/browser/resources/settings/site_settings/constants.ts

// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * All possible contentSettingsTypes that we currently support configuring in
 * the UI. Both top-level categories and content settings that represent
 * individual permissions under Site Details should appear here.
 * This should be kept in sync with the |kContentSettingsTypeGroupNames| array
 * in chrome/browser/ui/webui/settings/site_settings_helper.cc. See
 * chrome/browser/resources/settings/site_settings/site_settings_page_util
 * for translations.
 */

export enum ContentSettingsTypes {
  ADS = 'ads',
  ANTI_ABUSE = 'anti-abuse',
  AR = 'ar',
  AUTO_PICTURE_IN_PICTURE = 'auto-picture-in-picture',
  AUTOMATIC_DOWNLOADS = 'multiple-automatic-downloads',
  AUTOMATIC_FULLSCREEN = 'automatic-fullscreen',
  BACKGROUND_SYNC = 'background-sync',
  BLUETOOTH_DEVICES = 'bluetooth-devices',
  BLUETOOTH_SCANNING = 'bluetooth-scanning',
  CAMERA = 'media-stream-camera',
  CAPTURED_SURFACE_CONTROL = 'captured-surface-control',
  CLIPBOARD = 'clipboard',
  COOKIES = 'cookies',
  FEDERATED_IDENTITY_API = 'federated-identity-api',
  FILE_SYSTEM_WRITE = 'file-system-write',
  GEOLOCATION = 'location',
  HAND_TRACKING = 'hand-tracking',
  HID_DEVICES = 'hid-devices',
  IDLE_DETECTION = 'idle-detection',
  IMAGES = 'images',
  JAVASCRIPT = 'javascript',
  JAVASCRIPT_OPTIMIZER = 'javascript-optimizer',
  KEYBOARD_LOCK = 'keyboard-lock',
  LOCAL_FONTS = 'local-fonts',
  LOCAL_NETWORK_ACCESS = 'local-network-access',
  MIC = 'media-stream-mic',  // AKA Microphone.
  MIDI_DEVICES = 'midi-sysex',
  MIXEDSCRIPT = 'mixed-script',
  NOTIFICATIONS = 'notifications',
  PAYMENT_HANDLER = 'payment-handler',
  PERFORMANCE = 'performance',
  POINTER_LOCK = 'pointer-lock',
  POPUPS = 'popups',
  PRIVATE_NETWORK_DEVICES = 'private-network-devices',
  PROTECTED_CONTENT = 'protected-content',
  PROTOCOL_HANDLERS = 'register-protocol-handler',
  SENSORS = 'sensors',
  SERIAL_PORTS = 'serial-ports',
  SMART_CARD_READERS = 'smart-card-readers',
  SOUND = 'sound',
  STORAGE_ACCESS = 'storage-access',
  TRACKING_PROTECTION = 'tracking-protection',
  TOP_LEVEL_STORAGE_ACCESS = 'top-level-storage-access',
  USB_DEVICES = 'usb-devices',
  VR = 'vr',
  WEB_APP_INSTALLATION = 'web-app-installation',
  WINDOW_MANAGEMENT = 'window-management',
  ZOOM_LEVELS = 'zoom-levels',
  WEB_PRINTING = 'web-printing',

  // The following items are not in the C++ kContentSettingsTypeGroupNames, but
  // are used everywhere where ContentSettingsTypes is used in JS.
  PDF_DOCUMENTS = 'pdfDocuments',
  SITE_DATA = 'site-data',
  OFFER_WRITING_HELP = 'offer-writing-help',
}

/**
 * Contains the possible string values for a given ContentSettingsTypes.
 * This should be kept in sync with the |ContentSetting| enum in
 * components/content_settings/core/common/content_settings.h
 */
export enum ContentSetting {
  DEFAULT = 'default',
  ALLOW = 'allow',
  BLOCK = 'block',
  ASK = 'ask',
  SESSION_ONLY = 'session_only',
}

/**
 * All possible ChooserTypes that we currently support configuring in the UI.
 * This should be kept in sync with the |kChooserTypeGroupNames| array in
 * chrome/browser/ui/webui/settings/site_settings_helper.cc
 */
export enum ChooserType {
  NONE = '',
  USB_DEVICES = 'usb-devices-data',
  SERIAL_PORTS = 'serial-ports-data',
  HID_DEVICES = 'hid-devices-data',
  BLUETOOTH_DEVICES = 'bluetooth-devices-data',
  PRIVATE_NETWORK_DEVICES = 'private-network-devices-data',
  // <if expr="is_chromeos">
  SMART_CARD_READERS_DEVICES = 'smart-card-readers-data',
  // </if>
}

/**
 * Possible preference settings for the profile.cookie_controls_mode pref.
 * This should be kept in sync with the |CookieControlsMode| enum in
 * components/content_settings/core/browser/cookie_settings.h
 */
// LINT.IfChange(CookieControlsMode)
export enum CookieControlsMode {
  OFF = 0,
  BLOCK_THIRD_PARTY = 1,
  INCOGNITO_ONLY = 2,
  LIMITED = 3,
}
// LINT.ThenChange(//tools/metrics/histograms/metadata/privacy/enums.xml:CookieControlsMode, //components/content_settings/core/browser/cookie_settings.h:CookieControlsMode)

/**
 * Contains the possible sources of a ContentSetting.
 * This should be kept in sync with the |SiteSettingSource| enum in
 * chrome/browser/ui/webui/settings/site_settings_helper.h
 */
export enum SiteSettingSource {
  ADS_FILTER_BLACKLIST = 'ads-filter-blacklist',
  ALLOWLIST = 'allowlist',
  DEFAULT = 'default',
  EMBARGO = 'embargo',
  EXTENSION = 'extension',
  HOSTED_APP = 'HostedApp',
  INSECURE_ORIGIN = 'insecure-origin',
  KILL_SWITCH = 'kill-switch',
  POLICY = 'policy',
  PREFERENCE = 'preference',
}

/**
 * Enumeration of states for the notification and geolocation default setting
 * generated pref. Must be kept in sync with the SettingsState enum in:
 * chrome/browser/content_settings/generated_permission_prompting_behavior_pref.h
 */
export enum SettingsState {
  LOUD = 0,
  QUIET = 1,
  CPSS = 2,
  BLOCK = 3,
}

/**
 * Enumeration of states for the Javascript optimizer default setting generated
 * pref. Must be kept in sync with the JavascriptOptimizerSetting enum in:
 * chrome/browser/content_settings/generated_javascript_optimizer_pref.h
 */
// LINT.IfChange(JavascriptOptimizerSetting)
export enum JavascriptOptimizerSetting {
  BLOCKED = 0,
  ALLOWED = 1,
  BLOCKED_FOR_UNFAMILIAR_SITES = 2,
}
// LINT.ThenChange(//chrome/browser/content_settings/generated_javascript_optimizer_pref.h:JavascriptOptimizerSetting)

/**
 * An invalid subtype value.
 */
export const INVALID_CATEGORY_SUBTYPE: string = '';

/**
 * Contains the possible record action types.
 * This should be kept in sync with the |AllSitesAction2| enum in
 * chrome/browser/ui/webui/settings/site_settings_handler.cc
 */
export enum AllSitesAction2 {
  LOAD_PAGE = 0,
  RESET_SITE_GROUP_PERMISSIONS = 1,
  RESET_ORIGIN_PERMISSIONS = 2,
  CLEAR_ALL_DATA = 3,
  CLEAR_SITE_GROUP_DATA = 4,
  CLEAR_ORIGIN_DATA = 5,
  ENTER_SITE_DETAILS = 6,
  REMOVE_SITE_GROUP = 7,
  REMOVE_ORIGIN = 8,
  REMOVE_ORIGIN_PARTITIONED = 9,
  FILTER_BY_FPS_OWNER = 10,
  DELETE_FOR_ENTIRE_FPS = 11,
}

/**
 * Contains the possible sort methods.
 */
export enum SortMethod {
  NAME = 'name',
  MOST_VISITED = 'most-visited',
  STORAGE = 'data-stored',
}

/**
 * Contains types of dialogs on the AllSites page,
 * used for logging userActions.
 */
export enum AllSitesDialog {
  CLEAR_DATA = 'ClearData',
  RESET_PERMISSIONS = 'ResetPermissions',
}

/**
 * String representation of the wildcard used for universal
 * match for SiteExceptions.
 */
export const SITE_EXCEPTION_WILDCARD: string = '*';

/**
 * Types of cookies exceptions based on the use of wildcard in the patterns:
 * - THIRD_PARTY: primary pattern is wildcard (third-party exception).
 * - SITE_DATA: primary pattern is set, secondary pattern is wildcard (site data
 * exceptions) or is set (only possible via extensions API).
 * - COMBINED: any pattern combination can be used.
 */
export enum CookiesExceptionType {
  THIRD_PARTY = 'third-party',
  SITE_DATA = 'site-data',
  COMBINED = 'combined',
}