chrome-devtools-frontend/front_end/core/sdk/AutofillModel.ts

Chrome DevTools UI

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

import * as Common from '../../core/common/common.js';
import type * as ProtocolProxyApi from '../../generated/protocol-proxy-api.js';
import type * as Protocol from '../../generated/protocol.js';
import * as Host from '../host/host.js';

import {SDKModel} from './SDKModel.js';
import {Capability, type Target} from './Target.js';

export class AutofillModel extends SDKModel<EventTypes> implements ProtocolProxyApi.AutofillDispatcher {
  readonly agent: ProtocolProxyApi.AutofillApi;
  #enabled?: boolean;
  #showTestAddressesInAutofillMenu: Common.Settings.Setting<boolean>;

  constructor(target: Target) {
    super(target);

    this.agent = target.autofillAgent();
    this.#showTestAddressesInAutofillMenu =
        Common.Settings.Settings.instance().createSetting('show-test-addresses-in-autofill-menu-on-event', false);
    this.#showTestAddressesInAutofillMenu.addChangeListener(this.#setTestAddresses, this);
    target.registerAutofillDispatcher(this);
    this.enable();
  }

  override dispose(): void {
    this.#showTestAddressesInAutofillMenu.removeChangeListener(this.#setTestAddresses, this);
    super.dispose();
  }

  #setTestAddresses(): void {
    void this.agent.invoke_setAddresses(
        {
          addresses: this.#showTestAddressesInAutofillMenu.get() ?
              [
                {
                  fields: [
                    {name: 'ADDRESS_HOME_COUNTRY', value: 'US'},
                    {name: 'NAME_FULL', value: 'Jon Stewart Doe'},
                    {name: 'NAME_FIRST', value: 'Jon'},
                    {name: 'NAME_MIDDLE', value: 'Stewart'},
                    {name: 'NAME_LAST', value: 'Doe'},
                    {name: 'COMPANY_NAME', value: 'Fake Company'},
                    {name: 'ADDRESS_HOME_LINE1', value: '1600 Fake Street'},
                    {name: 'ADDRESS_HOME_LINE2', value: 'Apartment 1'},
                    {name: 'ADDRESS_HOME_ZIP', value: '94043'},
                    {name: 'ADDRESS_HOME_CITY', value: 'Mountain View'},
                    {name: 'ADDRESS_HOME_STATE', value: 'CA'},
                    {name: 'EMAIL_ADDRESS', value: 'test@example.us'},
                    {name: 'PHONE_HOME_WHOLE_NUMBER', value: '+16019521325'},
                  ],
                },
                {
                  fields: [
                    {name: 'ADDRESS_HOME_COUNTRY', value: 'BR'},
                    {name: 'NAME_FULL', value: 'João Souza Silva'},
                    {name: 'NAME_FIRST', value: 'João'},
                    {name: 'NAME_LAST', value: 'Souza Silva'},
                    {name: 'NAME_LAST_FIRST', value: 'Souza'},
                    {name: 'NAME_LAST_SECOND', value: 'Silva'},
                    {name: 'COMPANY_NAME', value: 'Empresa Falsa'},
                    {name: 'ADDRESS_HOME_STREET_ADDRESS', value: 'Rua Inexistente, 2000\nAndar 2, Apartamento 1'},
                    {name: 'ADDRESS_HOME_STREET_LOCATION', value: 'Rua Inexistente, 2000'},
                    {name: 'ADDRESS_HOME_STREET_NAME', value: 'Rua Inexistente'},
                    {name: 'ADDRESS_HOME_HOUSE_NUMBER', value: '2000'},
                    {name: 'ADDRESS_HOME_SUBPREMISE', value: 'Andar 2, Apartamento 1'},
                    {name: 'ADDRESS_HOME_APT_NUM', value: '1'},
                    {name: 'ADDRESS_HOME_FLOOR', value: '2'},
                    {name: 'ADDRESS_HOME_APT', value: 'Apartamento 1'},
                    {name: 'ADDRESS_HOME_APT_TYPE', value: 'Apartamento'},
                    {name: 'ADDRESS_HOME_APT_NUM', value: '1'},
                    {name: 'ADDRESS_HOME_DEPENDENT_LOCALITY', value: 'Santa Efigênia'},
                    {name: 'ADDRESS_HOME_LANDMARK', value: 'Próximo à estação Santa Efigênia'},
                    {name: 'ADDRESS_HOME_OVERFLOW', value: 'Andar 2, Apartamento 1'},
                    {name: 'ADDRESS_HOME_ZIP', value: '30260-080'},
                    {name: 'ADDRESS_HOME_CITY', value: 'Belo Horizonte'},
                    {name: 'ADDRESS_HOME_STATE', value: 'MG'},
                    {name: 'EMAIL_ADDRESS', value: 'teste@exemplo.us'},
                    {name: 'PHONE_HOME_WHOLE_NUMBER', value: '+553121286800'},
                  ],
                },
                {
                  fields: [
                    {name: 'ADDRESS_HOME_COUNTRY', value: 'MX'},
                    {name: 'NAME_FULL', value: 'Juan Francisco García Flores'},
                    {name: 'NAME_FIRST', value: 'Juan Francisco'},
                    {name: 'NAME_LAST', value: 'García Flores'},
                    {name: 'NAME_LAST_FIRST', value: 'García'},
                    {name: 'NAME_LAST_SECOND', value: 'Flores'},
                    {name: 'COMPANY_NAME', value: 'Empresa Falsa'},
                    {
                      name: 'ADDRESS_HOME_STREET_ADDRESS',
                      value:
                          'C. Falsa 445\nPiso 2, Apartamento 1\nEntre calle Volcán y calle Montes Blancos, cerca de la estación de metro',
                    },
                    {name: 'ADDRESS_HOME_STREET_LOCATION', value: 'C. Falsa 445'},
                    {name: 'ADDRESS_HOME_STREET_NAME', value: 'C. Falsa'},
                    {name: 'ADDRESS_HOME_HOUSE_NUMBER', value: '445'},
                    {name: 'ADDRESS_HOME_SUBPREMISE', value: 'Piso 2, Apartamento 1'},
                    {name: 'ADDRESS_HOME_FLOOR', value: '2'},
                    {name: 'ADDRESS_HOME_APT', value: 'Apartamento 1'},
                    {name: 'ADDRESS_HOME_APT_TYPE', value: 'Apartamento'},
                    {name: 'ADDRESS_HOME_APT_NUM', value: '1'},
                    {name: 'ADDRESS_HOME_DEPENDENT_LOCALITY', value: 'Lomas de Chapultepec'},
                    {
                      name: 'ADDRESS_HOME_OVERFLOW',
                      value: 'Entre calle Volcán y calle Montes Celestes, cerca de la estación de metro',
                    },
                    {
                      name: 'ADDRESS_HOME_BETWEEN_STREETS_OR_LANDMARK',
                      value: 'Entre calle Volcán y calle Montes Blancos, cerca de la estación de metro',
                    },
                    {name: 'ADDRESS_HOME_LANDMARK', value: 'Cerca de la estación de metro'},
                    {name: 'ADDRESS_HOME_BETWEEN_STREETS', value: 'Entre calle Volcán y calle Montes Blancos'},
                    {name: 'ADDRESS_HOME_BETWEEN_STREETS_1', value: 'calle Volcán'},
                    {name: 'ADDRESS_HOME_BETWEEN_STREETS_2', value: 'calle Montes Blancos'},
                    {name: 'ADDRESS_HOME_ADMIN_LEVEL2', value: 'Miguel Hidalgo'},
                    {name: 'ADDRESS_HOME_ZIP', value: '11001'},
                    {name: 'ADDRESS_HOME_CITY', value: 'Ciudad de México'},
                    {name: 'ADDRESS_HOME_STATE', value: 'Distrito Federal'},
                    {name: 'EMAIL_ADDRESS', value: 'ejemplo@ejemplo.mx'},
                    {name: 'PHONE_HOME_WHOLE_NUMBER', value: '+525553428400'},
                  ],
                },
                {
                  fields: [
                    {name: 'ADDRESS_HOME_COUNTRY', value: 'DE'},
                    {name: 'NAME_FULL', value: 'Gottfried Wilhelm Leibniz'},
                    {name: 'NAME_FIRST', value: 'Gottfried'},
                    {name: 'NAME_MIDDLE', value: 'Wilhelm'},
                    {name: 'NAME_LAST', value: 'Leibniz'},
                    {name: 'COMPANY_NAME', value: 'Erfundenes Unternehmen'},
                    {name: 'ADDRESS_HOME_LINE1', value: 'Erfundene Straße 33'},
                    {name: 'ADDRESS_HOME_LINE2', value: 'Wohnung 1'},
                    {name: 'ADDRESS_HOME_ZIP', value: '80732'},
                    {name: 'ADDRESS_HOME_CITY', value: 'München'},
                    {name: 'EMAIL_ADDRESS', value: 'test@beispiel.de'},
                    {name: 'PHONE_HOME_WHOLE_NUMBER', value: '+4930303986300'},
                  ],
                },
              ] :
              [],
        });
  }

  enable(): void {
    if (this.#enabled || Host.InspectorFrontendHost.isUnderTest()) {
      return;
    }
    void this.agent.invoke_enable();
    this.#setTestAddresses();
    this.#enabled = true;
  }

  disable(): void {
    if (!this.#enabled || Host.InspectorFrontendHost.isUnderTest()) {
      return;
    }
    this.#enabled = false;
    void this.agent.invoke_disable();
  }

  addressFormFilled(addressFormFilledEvent: Protocol.Autofill.AddressFormFilledEvent): void {
    this.dispatchEventToListeners(Events.ADDRESS_FORM_FILLED, {autofillModel: this, event: addressFormFilledEvent});
  }
}

SDKModel.register(AutofillModel, {capabilities: Capability.DOM, autostart: true});

export const enum Events {
  ADDRESS_FORM_FILLED = 'AddressFormFilled',
}

export interface AddressFormFilledEvent {
  autofillModel: AutofillModel;
  event: Protocol.Autofill.AddressFormFilledEvent;
}

export interface EventTypes {
  [Events.ADDRESS_FORM_FILLED]: AddressFormFilledEvent;
}