File: autofill_ai_client.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (91 lines) | stat: -rw-r--r-- 3,887 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_AI_CORE_BROWSER_AUTOFILL_AI_CLIENT_H_
#define COMPONENTS_AUTOFILL_AI_CORE_BROWSER_AUTOFILL_AI_CLIENT_H_

#include <optional>

#include "base/functional/callback_forward.h"
#include "components/autofill/core/browser/data_manager/autofill_ai/entity_data_manager.h"
#include "components/autofill/core/browser/foundations/autofill_client.h"
#include "components/autofill/core/browser/integrators/autofill_ai/autofill_ai_delegate.h"
#include "components/autofill/core/common/unique_ids.h"
#include "components/optimization_guide/core/model_quality/model_quality_logs_uploader_service.h"

namespace autofill_ai {

class AutofillAiModelExecutor;
class AutofillAiManager;

// An interface for embedder actions, e.g. Chrome on Desktop.
//
// A client should be created only if
// `AutofillAiIsPlatformAndEnterprisePolicyEligible()`. However,
// `AutofillAiIsPlatformAndEnterprisePolicyEligible()` is not necessarily a
// constant over the lifetime of the client. For example, the user may disable
// Autofill in the settings while the client is alive.
class AutofillAiClient {
 public:
  // Contains the result of a user interaction with the save/update AutofillAi
  // prompt.
  struct SaveOrUpdatePromptResult final {
    SaveOrUpdatePromptResult();
    SaveOrUpdatePromptResult(bool did_user_decline,
                             std::optional<autofill::EntityInstance> entity);
    SaveOrUpdatePromptResult(const SaveOrUpdatePromptResult&);
    SaveOrUpdatePromptResult(SaveOrUpdatePromptResult&&);
    SaveOrUpdatePromptResult& operator=(const SaveOrUpdatePromptResult&);
    SaveOrUpdatePromptResult& operator=(SaveOrUpdatePromptResult&&);
    ~SaveOrUpdatePromptResult();

    // Whether the user explicitly declined the dialog.
    bool did_user_decline = false;

    // Non-empty iff the prompt was accepted.
    std::optional<autofill::EntityInstance> entity;
  };
  using SaveOrUpdatePromptResultCallback =
      base::OnceCallback<void(SaveOrUpdatePromptResult result)>;

  virtual ~AutofillAiClient() = default;

  // Returns the AutofillClient that is scoped to the same object (e.g., tab) as
  // this AutofillAiClient.
  virtual autofill::AutofillClient& GetAutofillClient() = 0;
  const autofill::AutofillClient& GetAutofillClient() const {
    return const_cast<const autofill::AutofillClient&>(
        const_cast<AutofillAiClient*>(this)->GetAutofillClient());
  }

  // Returns the `AutofillAiManager` associated with this
  // client.
  virtual AutofillAiManager& GetManager() = 0;

  // Returns a pointer to the current profile's `autofill::EntityDataManager`.
  // Can be `nullptr` if `features::kAutofillAiWithDataSchema` is disabled.
  virtual autofill::EntityDataManager* GetEntityDataManager() = 0;

  // Returns a pointer to a `FormStructure` for the corresponding `form_id`
  // from the Autofill cache. Can be a `nullptr` when the structure was not
  // found or if the driver is not available.
  virtual autofill::FormStructure* GetCachedFormStructure(
      const autofill::FormGlobalId& form_id) = 0;

  // Returns the service used in order to log metrics into MQLS.
  virtual optimization_guide::ModelQualityLogsUploaderService*
  GetMqlsUploadService() = 0;

  // Shows a bubble asking whether the user wants to save or update Autofill AI
  // data. `old_entity` is present in the update cases. It is used to give users
  // a better understanding of what was updated.
  virtual void ShowSaveOrUpdateBubble(
      autofill::EntityInstance new_entity,
      std::optional<autofill::EntityInstance> old_entity,
      SaveOrUpdatePromptResultCallback save_prompt_acceptance_callback) = 0;
};

}  // namespace autofill_ai

#endif  // COMPONENTS_AUTOFILL_AI_CORE_BROWSER_AUTOFILL_AI_CLIENT_H_