v0.5

Author: p-h

build.gradle.kts

@@ -4,6 +4,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
     id("org.jetbrains.kotlin.jvm") version "1.4.32"
+    `maven-publish`
 }
 
 repositories {

declarations/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id("org.jetbrains.kotlin.js")
+    `maven-publish`
 }
 
 repositories {

declarations/src/main/kotlin/activityLog/activityLog.kt

@@ -0,0 +1,47 @@
+package activityLog
+
+import extensionTypes.Date
+import webextensions.Event
+
+/**
+ * The result of the call. */
+typealias Result = Any
+
+/**
+ * @param args A list of arguments passed to the call.
+ * @param result The result of the call.
+ * @param tabId The tab associated with this event if it is a tab or content script.
+ * @param url If the type is content_script, this is the url of the script that was injected.
+ */
+class Data(
+    var args: Array<dynamic>? = null,
+    var result: Result? = null,
+    var tabId: Int? = null,
+    var url: String? = null
+)
+
+/**
+ * @param timeStamp The date string when this call is triggered.
+ * @param type The type of log entry.  api_call is a function call made by the extension and
+        api_event is an event callback to the extension.  content_script is logged when a content
+        script is injected.
+ * @param viewType The type of view where the activity occurred.  Content scripts will not have a
+        viewType.
+ * @param name The name of the api call or event, or the script url if this is a content or user
+        script event.
+ */
+class Details(
+    var timeStamp: Date,
+    var type: String,
+    var viewType: String? = null,
+    var name: String,
+    var data: Data
+)
+
+external class ActivityLogNamespace {
+    /**
+     * Receives an activityItem for each logging event.
+     *
+     * @param details null */
+    val onExtensionActivity: Event<(details: Details) -> Unit>
+}

declarations/src/main/kotlin/bookmarks/bookmarks.kt

@@ -68,8 +68,7 @@ typealias IdOrIdList = Any
 /**
  * An object specifying properties and values to match when searching. Produces bookmarks matching
         all properties.
- * @param query A string of words and quoted phrases that are matched against bookmark URLs and
-        titles.
+ * @param query A string of words that are matched against bookmark URLs and titles.
  * @param url The URL of the bookmark; matches verbatim. Note that folders have no URL.
  * @param title The title of the bookmark; matches verbatim.
  */
@@ -80,10 +79,9 @@ class Query(
 )
 
 /**
- * Either a string of words and quoted phrases that are matched against bookmark URLs and titles, or
-        an object. If an object, the properties <code>query</code>, <code>url</code>, and
-        <code>title</code> may be specified and bookmarks matching all specified properties will be
-        produced. */
+ * Either a string of words that are matched against bookmark URLs and titles, or an object. If an
+        object, the properties <code>query</code>, <code>url</code>, and <code>title</code> may be
+        specified and bookmarks matching all specified properties will be produced. */
 typealias Query2 = Any
 
 class Destination(var parentId: String? = null, var index: Int? = null)

declarations/src/main/kotlin/browserAction/browserAction.kt

@@ -40,6 +40,16 @@ class ImageDataType() {
         with opaque red being <code>#FF0000</code> or <code>#F00</code>. */
 typealias ColorValue = Any
 
+/**
+ * Information sent when a browser action is clicked.
+ * @param modifiers An array of keyboard modifiers that were held while the menu item was clicked.
+ * @param button An integer value of button by which menu item was clicked.
+ */
+class OnClickData(
+    var modifiers: Array<String>,
+    var button: Int? = null
+)
+
 /**
  * The string the browser action should display when moused over. */
 typealias Title = Any
@@ -139,8 +149,9 @@ external class BrowserActionNamespace {
      * Fired when a browser action icon is clicked.  This event will not fire if the browser action
             has a popup.
      *
-     * @param tab null */
-    val onClicked: Event<(tab: Tab) -> Unit>
+     * @param tab null
+     * @param info null */
+    val onClicked: Event<(tab: Tab, info: OnClickData?) -> Unit>
 
     /**
      * Sets the title of the browser action. This shows up in the tooltip.

declarations/src/main/kotlin/browserSettings/browserSettings.kt

@@ -33,6 +33,11 @@ external class BrowserSettingsNamespace {
      */
     var contextMenuShowEvent: Setting
 
+    /**
+     * Returns whether the FTP protocol is enabled. Read-only.
+     */
+    var ftpProtocolEnabled: Setting
+
     /**
      * Returns the value of the overridden home page. Read-only.
      */
@@ -89,4 +94,16 @@ external class BrowserSettingsNamespace {
      * This setting controls whether the document's fonts are used.
      */
     var useDocumentFonts: Setting
+
+    /**
+     * This boolean setting controls whether zoom is applied to the full page or to text only.
+     */
+    var zoomFullPage: Setting
+
+    /**
+     * This boolean setting controls whether zoom is applied on a per-site basis or to the current
+            tab only. If privacy.resistFingerprinting is true, this setting has no effect and zoom
+            is applied to the current tab only.
+     */
+    var zoomSiteSpecific: Setting
 }

declarations/src/main/kotlin/browsingData/browsingData.kt

@@ -10,6 +10,7 @@ import kotlin.js.Promise
         object). If absent, defaults to 0 (which would remove all browsing data).
  * @param hostnames Only remove data associated with these hostnames (only applies to cookies and
         localStorage).
+ * @param cookieStoreId Only remove data associated with this specific cookieStoreId.
  * @param originTypes An object whose properties specify which origin types ought to be cleared. If
         this object isn't specified, it defaults to clearing only "unprotected" origins. Please
         ensure that you <em>really</em> want to remove application data before adding 'protectedWeb'
@@ -18,6 +19,7 @@ import kotlin.js.Promise
 class RemovalOptions(
     var since: Date? = null,
     var hostnames: Array<String>? = null,
+    var cookieStoreId: String? = null,
     var originTypes: OriginTypes? = null
 )
 

declarations/src/main/kotlin/captivePortal/captivePortal.kt

@@ -0,0 +1,45 @@
+package captivePortal
+
+import kotlin.js.Promise
+import types.Setting
+import webextensions.Event
+
+/**
+ * @param state The current captive portal state.
+ */
+class Details(
+    var state: String
+)
+
+external class CaptivePortalNamespace {
+    /**
+     * Fired when the captive portal state changes.
+     *
+     * @param details null */
+    val onStateChanged: Event<(details: Details) -> Unit>
+
+    /**
+     * This notification will be emitted when the captive portal service has determined that we can
+            connect to the internet. The service will pass either `captive` if there is an unlocked
+            captive portal present, or `clear` if no captive portal was detected.
+     *
+     * @param status null */
+    val onConnectivityAvailable: Event<(status: String) -> Unit>
+
+    /**
+     * Return the canonical captive-portal detection URL. Read-only.
+     */
+    var canonicalURL: Setting
+
+    /**
+     * Returns the current portal state, one of `unknown`, `not_captive`, `unlocked_portal`,
+            `locked_portal`.
+     */
+    fun getState(): Promise<Any>
+
+    /**
+     * Returns the time difference between NOW and the last time a request was completed in
+            milliseconds.
+     */
+    fun getLastChecked(): Promise<Any>
+}

declarations/src/main/kotlin/commands/commands.kt

@@ -1,7 +1,6 @@
 package commands
 
 import kotlin.js.Promise
-import manifest.KeyName
 import webextensions.Event
 
 /**
@@ -23,7 +22,7 @@ class Command(
 class Detail(
     var name: String,
     var description: String? = null,
-    var shortcut: KeyName? = null
+    var shortcut: String? = null
 )
 
 external class CommandsNamespace {

declarations/src/main/kotlin/devtools/devtools.kt

@@ -1,8 +1,9 @@
 package devtools
 
+import kotlin.Suppress
+import kotlin.js.Promise
 import manifest.ExtensionURL
 import webextensions.Event
-import kotlin.js.Promise
 
 /**
  * Set to undefined if the resource content was set successfully; describes error otherwise.
@@ -248,14 +249,14 @@ external class PanelsNamespace {
      */
     var themeName: String
 
-//    /**
-//     * Creates an extension panel.
-//     */
-//    fun create(
-//        title: String,
-//        iconPath: String,
-//        pagePath: ExtensionURL
-//    ): Promise<ExtensionPanel>
+    /**
+     * Creates an extension panel.
+     */
+    fun create(
+        title: String,
+        iconPath: String,
+        pagePath: ExtensionURL
+    ): Promise<ExtensionPanel>
 
     /**
      * Creates an extension panel.

declarations/src/main/kotlin/downloads/downloads.kt

@@ -50,7 +50,7 @@ class DownloadItem(
     var filename: String,
     var incognito: Boolean,
     var danger: DangerType,
-    var mime: String,
+    var mime: String? = null,
     var startTime: String,
     var endTime: String? = null,
     var estimatedEndTime: String? = null,
@@ -171,6 +171,8 @@ class Headers(
         <code>value</code> or <code>binaryValue</code>, restricted to those allowed by
         XMLHttpRequest.
  * @param body Post body.
+ * @param allowHttpErrors When this flag is set to <code>true</code>, then the browser will allow
+        downloads to proceed after encountering HTTP errors such as <code>404 Not Found</code>.
  */
 class Options(
     var url: String,
@@ -180,7 +182,8 @@ class Options(
     var saveAs: Boolean? = null,
     var method: String? = null,
     var headers: Array<Headers>? = null,
-    var body: String? = null
+    var body: String? = null,
+    var allowHttpErrors: Boolean? = null
 )
 
 /**

declarations/src/main/kotlin/extensionTypes/extensionTypes.kt

@@ -5,15 +5,20 @@ package extensionTypes
 typealias ImageFormat = String
 
 /**
- * Details about the format and quality of an image.
+ * Details about the format, quality, area and scale of the capture.
  * @param format The format of the resulting image.  Default is <code>"jpeg"</code>.
  * @param quality When format is <code>"jpeg"</code>, controls the quality of the resulting image. 
         This value is ignored for PNG images.  As quality is decreased, the resulting image will
         have more visual artifacts, and the number of bytes needed to store it will decrease.
+ * @param rect The area of the document to capture, in CSS pixels, relative to the page.  If
+        omitted, capture the visible viewport.
+ * @param scale The scale of the resulting image.  Defaults to <code>devicePixelRatio</code>.
  */
 class ImageDetails(
     var format: ImageFormat? = null,
-    var quality: Int? = null
+    var quality: Int? = null,
+    var rect: Rect? = null,
+    var scale: Float? = null
 )
 
 /**
@@ -62,4 +67,15 @@ typealias ExtensionFileOrCode = Any
  * A plain JSON value */
 typealias PlainJSONValue = Any
 
+/**
+ * The area of the document to capture, in CSS pixels, relative to the page.  If omitted, capture
+        the visible viewport.
+ */
+class Rect(
+    var x: Float,
+    var y: Float,
+    var width: Float,
+    var height: Float
+)
+
 external class ExtensionTypesNamespace

declarations/src/main/kotlin/geckoProfiler/geckoProfiler.kt

@@ -54,6 +54,12 @@ external class GeckoProfilerNamespace {
      */
     fun resume(): Promise<Any>
 
+    /**
+     * Gathers the profile data from the current profiling session, and writes it to disk. The
+            returned promise resolves to a path that locates the created file.
+     */
+    fun dumpProfileToFile(fileName: String): Promise<Any>
+
     /**
      * Gathers the profile data from the current profiling session.
      */
@@ -65,6 +71,12 @@ external class GeckoProfilerNamespace {
      */
     fun getProfileAsArrayBuffer(): Promise<Any>
 
+    /**
+     * Gathers the profile data from the current profiling session. The returned promise resolves to
+            an array buffer that contains a gzipped JSON string.
+     */
+    fun getProfileAsGzippedArrayBuffer(): Promise<Any>
+
     /**
      * Gets the debug symbols for a particular library.
      */