third_party/closure_compiler/externs/passwords_private.js

// Copyright 2017 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.

// This file was generated by:
//   tools/json_schema_compiler/compiler.py.
// NOTE: The format of types has changed. 'FooType' is now
//   'chrome.passwordsPrivate.FooType'.
// Please run the closure compiler before committing changes.
// See https://chromium.googlesource.com/chromium/src/+/master/docs/closure_compilation.md

/** @fileoverview Externs generated from namespace: passwordsPrivate */

/**
 * @const
 */
chrome.passwordsPrivate = {};

/**
 * @enum {string}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-ExportProgressStatus
 */
chrome.passwordsPrivate.ExportProgressStatus = {
  NOT_STARTED: 'NOT_STARTED',
  IN_PROGRESS: 'IN_PROGRESS',
  SUCCEEDED: 'SUCCEEDED',
  FAILED_CANCELLED: 'FAILED_CANCELLED',
  FAILED_WRITE_FAILED: 'FAILED_WRITE_FAILED',
};

/**
 * @typedef {{
 *   origin: string,
 *   shown: string,
 *   link: string
 * }}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-UrlCollection
 */
chrome.passwordsPrivate.UrlCollection;

/**
 * @typedef {{
 *   urls: !chrome.passwordsPrivate.UrlCollection,
 *   username: string
 * }}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-LoginPair
 */
chrome.passwordsPrivate.LoginPair;

/**
 * @typedef {{
 *   loginPair: !chrome.passwordsPrivate.LoginPair,
 *   numCharactersInPassword: number,
 *   federationText: (string|undefined),
 *   index: number
 * }}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-PasswordUiEntry
 */
chrome.passwordsPrivate.PasswordUiEntry;

/**
 * @typedef {{
 *   index: number,
 *   plaintextPassword: string
 * }}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-PlaintextPasswordEventParameters
 */
chrome.passwordsPrivate.PlaintextPasswordEventParameters;

/**
 * @typedef {{
 *   urls: !chrome.passwordsPrivate.UrlCollection,
 *   index: number
 * }}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-ExceptionEntry
 */
chrome.passwordsPrivate.ExceptionEntry;

/**
 * @typedef {{
 *   status: !chrome.passwordsPrivate.ExportProgressStatus,
 *   message: (string|undefined),
 * }}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#type-PasswordExportProgress
 */
chrome.passwordsPrivate.PasswordExportProgress;

/**
 * Removes the saved password corresponding to |loginPair|. If no saved password
 * for this pair exists, this function is a no-op.
 * @param {number} index The index for the password entry being removed.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-removeSavedPassword
 */
chrome.passwordsPrivate.removeSavedPassword = function(index) {};

/**
 * Removes the saved password exception corresponding to |exceptionUrl|. If no
 * exception with this URL exists, this function is a no-op.
 * @param {number} index The index for the exception url entry being removed.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-removePasswordException
 */
chrome.passwordsPrivate.removePasswordException = function(index) {};

/**
 * Undoes the last removal of a saved password or exception.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-undoRemoveSavedPasswordOrException
 */
chrome.passwordsPrivate.undoRemoveSavedPasswordOrException = function() {};

/**
 * Returns the plaintext password corresponding to |index|. Note that on some
 * operating systems, this call may result in an OS-level reauthentication. Once
 * the password has been fetched, it will be returned via the
 * onPlaintextPasswordRetrieved event. TODO(hcarmona): Investigate using a
 * callback for consistency.
 * @param {number} index The index for the password entry being being retrieved.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-requestPlaintextPassword
 */
chrome.passwordsPrivate.requestPlaintextPassword = function(index) {};

/**
 * Returns the list of saved passwords.
 * @param {function(!Array<!chrome.passwordsPrivate.PasswordUiEntry>):void}
 *     callback Called with the list of saved passwords.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-getSavedPasswordList
 */
chrome.passwordsPrivate.getSavedPasswordList = function(callback) {};

/**
 * Returns the list of password exceptions.
 * @param {function(!Array<!chrome.passwordsPrivate.ExceptionEntry>):void}
 *     callback Called with the list of password exceptions.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-getPasswordExceptionList
 */
chrome.passwordsPrivate.getPasswordExceptionList = function(callback) {};

/**
 * Triggers the Password Manager password import functionality.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-importPasswords
 */
chrome.passwordsPrivate.importPasswords = function() {};

/**
 * Triggers the Password Manager password export functionality.
 * @param {function():void}
 *     callback Called with no error, if the new export request was accepted and
 *         started. If rejected, <code>chrome.runtime.lastError</code> will be
 *         set to 'in-progress'.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-exportPasswords
 */
chrome.passwordsPrivate.exportPasswords = function(callback) {};

/**
 * Triggers the cancelling of a password export flow.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-cancelExportPasswords
 */
chrome.passwordsPrivate.cancelExportPasswords = function() {};

/**
 * Triggers the Password Manager password export status query functionality.
 * @param {function(!chrome.passwordsPrivate.ExportProgressStatus):void}
 *     callback Called with the status of the current export.
 * @see https://developer.chrome.com/extensions/passwordsPrivate#method-requestExportProgressStatus
 */
chrome.passwordsPrivate.requestExportProgressStatus = function(callback) {};

/**
 * Fired when the saved passwords list has changed, meaning that an entry has
 * been added or removed.
 * @type {!ChromeEvent}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#event-onSavedPasswordsListChanged
 */
chrome.passwordsPrivate.onSavedPasswordsListChanged;

/**
 * Fired when the password exceptions list has changed, meaning that an entry
 * has been added or removed.
 * @type {!ChromeEvent}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#event-onPasswordExceptionsListChanged
 */
chrome.passwordsPrivate.onPasswordExceptionsListChanged;

/**
 * Fired when a plaintext password has been fetched in response to a call to
 * chrome.passwordsPrivate.requestPlaintextPassword().
 * @type {!ChromeEvent}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#event-onPlaintextPasswordRetrieved
 */
chrome.passwordsPrivate.onPlaintextPasswordRetrieved;


/**
 * Fired when status of the export has progressed.
 * @type {!ChromeEvent}
 * @see https://developer.chrome.com/extensions/passwordsPrivate#event-onPasswordsExportCompleted
 */
chrome.passwordsPrivate.onPasswordsFileExportProgress;