migrate mozilla components into project

2024-09-07 08:49:38 +02:00
parent 10a49def87
commit 3b047b5d8a
67 changed files with 5840 additions and 0 deletions
@@ -0,0 +1,414 @@
+import 'package:pigeon/pigeon.dart';
+
+/// Translation options that map to the Gecko Translations Options.
+///
+/// @property downloadModel If the necessary models should be downloaded on request. If false, then
+/// the translation will not complete and throw an exception if the models are not already available.
+class TranslationOptions {
+  final bool downloadModel;
+
+  TranslationOptions({this.downloadModel = true});
+}
+
+/// Value type that represents the state of reader mode/view.
+class ReaderState {
+  /// Whether or not the current page can be transformed to
+  /// be displayed in a reader view.
+  final bool readerable;
+
+  /// Whether or not reader view is active.
+  final bool active;
+
+  /// Whether or not a readerable check is required for the
+  /// current page.
+  final bool checkRequired;
+
+  /// Whether or not a new connection to the reader view
+  /// content script is required.
+  final bool connectRequired;
+
+  /// The base URL of the reader view extension page.
+  final String? baseUrl;
+
+  /// The URL of the page currently displayed in reader view.
+  final String? activeUrl;
+
+  /// The vertical scroll position of the page currently
+  /// displayed in reader view.
+  final int? scrollY;
+
+  const ReaderState({
+    this.readerable = false,
+    this.active = false,
+    this.checkRequired = false,
+    this.connectRequired = false,
+    this.baseUrl,
+    this.activeUrl,
+    this.scrollY,
+  });
+}
+
+/// Details about the last playing media in this tab.
+class LastMediaAccessState {
+  /// [ContentState.url] when media started playing.
+  /// This is not the URL of the media but of the page when media started.
+  /// Defaults to "" (an empty String) if media hasn't started playing.
+  /// This value is only updated when media starts playing.
+  /// Can be used as a backup to [mediaSessionActive] for knowing the user is still on the same website
+  /// on which media was playing before media started playing in another tab.
+  final String lastMediaUrl;
+
+  /// The last time media started playing in the current web document.
+  /// Defaults to [0] if media hasn't started playing.
+  /// This value is only updated when media starts playing.
+  final int lastMediaAccess;
+
+  /// Whether or not the last accessed media is still active.
+  /// Can be used as a backup to [lastMediaUrl] on websites which allow media to continue playing
+  /// even when the users accesses another page (with another URL) in that same HTML document.
+  final bool mediaSessionActive;
+
+  const LastMediaAccessState({
+    this.lastMediaUrl = "",
+    this.lastMediaAccess = 0,
+    this.mediaSessionActive = false,
+  });
+}
+
+/// Represents a set of history metadata values that uniquely identify a record. Note that
+/// when recording observations, the same set of values may or may not cause a new record to be
+/// created, depending on the de-bouncing logic of the underlying storage i.e. recording history
+/// metadata observations with the exact same values may be combined into a single record.
+class HistoryMetadataKey {
+  /// A url of the page.
+  final String url;
+
+  /// An optional search term if this record was
+  /// created as part of a search by the user.
+  final String? searchTerm;
+
+  /// An optional url of the parent/referrer if
+  /// this record was created in response to a user opening
+  /// a page in a new tab.
+  final String? referrerUrl;
+
+  const HistoryMetadataKey({
+    required this.url,
+    this.searchTerm,
+    this.referrerUrl,
+  });
+}
+
+class PackageCategoryValue {
+  final int value;
+
+  const PackageCategoryValue(this.value);
+}
+
+/// Describes an external package.
+class ExternalPackage {
+  /// An Android package id.
+  final String packageId;
+
+  /// A [PackageCategory] as defined by the application.
+  final PackageCategoryValue category;
+
+  const ExternalPackage(this.packageId, this.category);
+}
+
+class LoadUrlFlagsValue {
+  final int value;
+
+  const LoadUrlFlagsValue(this.value);
+}
+
+class SourceValue {
+  final int id;
+  final ExternalPackage? caller;
+
+  const SourceValue(this.id, this.caller);
+}
+
+/// A tab that is no longer open and in the list of tabs, but that can be restored (recovered) at
+/// any time if it's combined with an [EngineSessionState] to form a [RecoverableTab].
+///
+/// The values of this data class are usually filled with the values of a [TabSessionState] when
+/// getting closed.
+class TabState {
+  /// Unique ID identifying this tab.
+  final String id;
+
+  /// The last URL of this tab.
+  final String url;
+
+  /// The unique ID of the parent tab if this tab was opened from another tab (e.g. via
+  /// the context menu).
+  final String? parentId;
+
+  /// The last title of this tab (or an empty String).
+  final String title;
+
+  /// The last used search terms, or an empty string if no
+  /// search was executed for this session.
+  final String searchTerm;
+
+  /// The context ID ("container") this tab used (or null).
+  final String? contextId;
+
+  /// The last [ReaderState] of the tab.
+  final ReaderState readerState;
+
+  /// The last time this tab was selected.
+  final int lastAccess;
+
+  /// Timestamp of the tab's creation.
+  final int createdAt;
+
+  /// Details about the last time was playing in this tab.
+  final LastMediaAccessState lastMediaAccessState;
+
+  /// If tab was private.
+  final bool private;
+
+  /// The last [HistoryMetadataKey] of the tab.
+  final HistoryMetadataKey? historyMetadata;
+
+  /// The last [Source] of the tab.
+  final SourceValue source;
+
+  /// The index the tab should be restored at.
+  final int index;
+
+  /// Whether the tab has form data.
+  final bool hasFormData;
+
+  TabState({
+    required this.id,
+    required this.url,
+    this.parentId,
+    this.title = "",
+    this.searchTerm = "",
+    this.contextId,
+    this.readerState = const ReaderState(),
+    this.lastAccess = 0,
+    this.createdAt = 0,
+    this.lastMediaAccessState = const LastMediaAccessState(),
+    this.private = false,
+    this.historyMetadata,
+    required this.source, //= Internal.none,
+    this.index = -1,
+    this.hasFormData = false,
+  });
+}
+
+/// A recoverable version of [TabState].
+class RecoverableTab {
+  /// The [EngineSessionState] needed for restoring the previous state of this tab.
+  final String? engineSessionStateJson;
+
+  /// A [TabState] instance containing basic tab state.
+  final TabState state;
+
+  const RecoverableTab({
+    this.engineSessionStateJson,
+    required this.state,
+  });
+}
+
+/// A restored browser state, read from disk.
+class RecoverableBrowserState {
+  /// The list of restored tabs.
+  final List<RecoverableTab?> tabs;
+
+  /// The ID of the selected tab in [tabs]. Or `null` if no selection was restored.
+  final String? selectedTabId;
+
+  const RecoverableBrowserState({
+    required this.tabs,
+    this.selectedTabId,
+  });
+}
+
+/// Indicates what location the tabs should be restored at
+enum RestoreLocation {
+  /// Restore tabs at the beginning of the tab list
+  beginning,
+
+  /// Restore tabs at the end of the tab list
+  end,
+
+  /// Restore tabs at a specific index in the tab list
+  atIndex,
+}
+
+@ConfigurePigeon(PigeonOptions(
+  dartOut: 'lib/src/pigeons/gecko.g.dart',
+  dartOptions: DartOptions(),
+  kotlinOut:
+      'android/src/main/kotlin/eu/lensai/flutter_mozilla_components/pigeons/Gecko.g.kt',
+  kotlinOptions: KotlinOptions(),
+  dartPackageName: 'flutter_mozilla_components',
+))
+@HostApi()
+abstract class GeckoBrowserApi {
+  void showNativeFragment();
+}
+
+@HostApi()
+abstract class GeckoSessionApi {
+  void loadUrl({
+    required String? tabId, //If null = current tab
+    required String url,
+    required LoadUrlFlagsValue flags, //== LoadUrlFlagsBuilder.NONE,
+    required Map<String, String>? additionalHeaders,
+  });
+
+  void loadData({
+    required String? tabId, //If null = current tab
+    required String data,
+    required String mimeType,
+    required String encoding,
+  });
+
+  void reload({
+    required String? tabId, //If null = current tab
+    required LoadUrlFlagsValue flags, //== LoadUrlFlagsBuilder.NONE,
+  });
+
+  void stopLoading({
+    required String? tabId, //If null = current tab
+  });
+
+  void goBack({
+    required String? tabId, //If null = current tab
+    required bool userInteraction,
+  });
+
+  void goForward({
+    required String? tabId, //If null = current tab
+    required bool userInteraction,
+  });
+
+  void goToHistoryIndex({
+    required int index,
+    required String? tabId, //If null = current tab
+  });
+
+  void requestDesktopSite({
+    required String? tabId, //If null = current tab
+    required bool enable,
+  });
+
+  void exitFullscreen({
+    required String? tabId, //If null = current tab
+  });
+
+  void saveToPdf({
+    required String? tabId, //If null = current tab
+  });
+
+  void printContent({
+    required String? tabId, //If null = current tab
+  });
+
+  void translate({
+    required String? tabId, //If null = current tab
+    required String fromLanguage,
+    required String toLanguage,
+    required TranslationOptions? options,
+  });
+
+  void translateRestore({
+    required String? tabId, //If null = current tab
+  });
+
+  void crashRecovery({
+    required List<String>? tabIds,
+  });
+
+  void purgeHistory();
+
+  void updateLastAccess({
+    required String? tabId, //If null = current tab
+    required int? lastAccess, //If null datetime.now
+  });
+}
+
+@HostApi()
+abstract class GeckoTabsApi {
+  void selectTab({required String tabId});
+
+  void removeTab({required String tabId});
+
+  String addTab({
+    required String url,
+    required bool selectTab,
+    required bool startLoading,
+    required String? parentId,
+    required LoadUrlFlagsValue flags,
+    required String? contextId,
+    //engineSession: EngineSession? = null,
+    required SourceValue source, //Internal.NewTab
+    //searchTerms: String = "",
+    required bool private,
+    required HistoryMetadataKey? historyMetadata,
+    //isSearch: Boolean = false,
+    //searchEngineName: String? = null,
+    required Map<String, String>? additionalHeaders,
+  });
+
+  void removeAllTabs({required bool recoverable});
+
+  void removeTabs({required List<String> ids});
+
+  void removeNormalTabs();
+
+  void removePrivateTabs();
+
+  void undo();
+
+  //restoreTabs invokes splitted
+  void restoreTabsByList({
+    required List<RecoverableTab> tabs,
+    required String? selectTabId,
+    required RestoreLocation restoreLocation,
+  });
+  void restoreTabsByBrowserState({
+    required RecoverableBrowserState state,
+    required RestoreLocation restoreLocation,
+  });
+  //The calls with engin storage for restore are not supported at the moment
+
+  //selectOrAddTab invokes splitted
+  /// Selects an already existing tab with the matching [HistoryMetadataKey] or otherwise
+  /// creates a new tab with the given [url].
+  String selectOrAddTabByHistory({
+    required String url,
+    required HistoryMetadataKey historyMetadata,
+  });
+
+  /// Selects an already existing tab displaying [url] or otherwise creates a new tab.
+  String selectOrAddTabByUrl({
+    required String url,
+    required bool private,
+    required SourceValue source, // = Internal.newTab,
+    required LoadUrlFlagsValue flags,
+    required bool ignoreFragment,
+  });
+
+  String duplicateTab({
+    required String? selectTabId,
+    required bool selectNewTab,
+  });
+
+  void moveTabs({
+    required List<String> tabIds,
+    required String targetTabId,
+    required bool placeAfter,
+  });
+
+  String migratePrivateTabUseCase({
+    required String tabId,
+    required String? alternativeUrl,
+  });
+}