🤖 Merge PR DefinitelyTyped#72037 updated types for webextension-polyfill by @Lusito

Author: Lusito

types/webextension-polyfill/namespaces/activityLog.d.ts

@@ -88,7 +88,7 @@ export namespace ActivityLog {
     /**
      * Receives an activityItem for each logging event.
      */
-    interface onExtensionActivityEvent extends Events.Event<(details: OnExtensionActivityDetailsType) => void> {
+    interface OnExtensionActivityEvent extends Events.Event<(details: OnExtensionActivityDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -101,6 +101,6 @@ export namespace ActivityLog {
         /**
          * Receives an activityItem for each logging event.
          */
-        onExtensionActivity: onExtensionActivityEvent;
+        onExtensionActivity: OnExtensionActivityEvent;
     }
 }

types/webextension-polyfill/namespaces/proxy.d.ts

@@ -184,7 +184,7 @@ export namespace Proxy {
     /**
      * Fired when proxy data is needed for a request.
      */
-    interface onRequestEvent extends Events.Event<(details: OnRequestDetailsType) => void> {
+    interface OnRequestEvent extends Events.Event<(details: OnRequestDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -203,7 +203,7 @@ export namespace Proxy {
         /**
          * Fired when proxy data is needed for a request.
          */
-        onRequest: onRequestEvent;
+        onRequest: OnRequestEvent;
 
         /**
          * Notifies about errors caused by the invalid use of the proxy API.

types/webextension-polyfill/namespaces/runtime.d.ts

@@ -262,6 +262,30 @@ export namespace Runtime {
      */
     type OnPerformanceWarningSeverity = "low" | "medium" | "high";
 
+    /**
+     * The third parameter is a function to call (at most once) when you have a response.
+     * The argument should be any JSON-ifiable object. If you have more than one <code>onMessage</code>
+     * listener in the same document, then only one may send a response. <code>sendResponse</code>
+     * becomes invalid when the event listener returns, unless you return true from the event listener to indicate you wish to
+     * send a response asynchronously (this will keep the message channel open to the other end until <code>sendResponse</code>
+     * is called).
+     */
+    type OnMessageListenerCallback = (
+        message: unknown,
+        sender: MessageSender,
+        sendResponse: (response: unknown) => void,
+    ) => true;
+
+    /**
+     * The return value should be a promise of any JSON-ifiable object. If you have more than one <code>onMessage</code>
+     * listener in the same document, then only one may send a response.
+     */
+    type OnMessageListenerAsync = (message: unknown, sender: MessageSender) => Promise<unknown>;
+
+    type OnMessageListenerNoResponse = (message: unknown, sender: MessageSender) => void;
+
+    type OnMessageListener = OnMessageListenerCallback | OnMessageListenerAsync | OnMessageListenerNoResponse;
+
     /**
      * If an update is available, this contains more information about the available update.
      */
@@ -579,53 +603,18 @@ export namespace Runtime {
 
         /**
          * Fired when a message is sent from either an extension process or a content script.
-         *
-         * @param message Optional. The message sent by the calling script.
-         * @param sendResponse Function to call (at most once) when you have a response. This is an alternative to returning a
-         * Promise. The argument should be any JSON-ifiable object. If you have more than one <code>onMessage</code>
-         * listener in the same document, then only one may send a response. This function becomes invalid when the event listener
-         * returns, unless you return true from the event listener to indicate you wish to send a response asynchronously (this
-         * will keep the message channel open to the other end until <code>sendResponse</code> is called).
-         */
-        onMessage: Events.Event<
-            (
-                message: unknown,
-                sender: MessageSender,
-                sendResponse: (message: unknown) => void,
-            ) => Promise<unknown> | true | undefined
-        >;
+         */
+        onMessage: Events.Event<OnMessageListener>;
 
         /**
          * Fired when a message is sent from another extension/app. Cannot be used in a content script.
-         *
-         * @param message Optional. The message sent by the calling script.
-         * @param sendResponse Function to call (at most once) when you have a response. This is an alternative to returning a
-         * Promise. The argument should be any JSON-ifiable object. If you have more than one <code>onMessage</code>
-         * listener in the same document, then only one may send a response. This function becomes invalid when the event listener
-         * returns, unless you return true from the event listener to indicate you wish to send a response asynchronously (this
-         * will keep the message channel open to the other end until <code>sendResponse</code> is called).
-         */
-        onMessageExternal: Events.Event<
-            (
-                message: unknown,
-                sender: MessageSender,
-                sendResponse: (message: unknown) => void,
-            ) => Promise<unknown> | true | undefined
-        >;
+         */
+        onMessageExternal: Events.Event<OnMessageListener>;
 
         /**
          * Fired when a message is sent from a USER_SCRIPT world registered through the userScripts API.
-         *
-         * @param message Optional. The message sent by the calling script.
-         * @param sendResponse Function to call (at most once) when you have a response. The argument should be any JSON-ifiable
-         * object. If you have more than one <code>onMessage</code> listener in the same document,
-         * then only one may send a response. This function becomes invalid when the event listener returns,
-         * unless you return true from the event listener to indicate you wish to send a response asynchronously (this will keep
-         * the message channel open to the other end until <code>sendResponse</code> is called).
-         */
-        onUserScriptMessage: Events.Event<
-            (message: unknown, sender: MessageSender, sendResponse: () => void) => boolean | undefined
-        >;
+         */
+        onUserScriptMessage: Events.Event<OnMessageListener>;
 
         /**
          * Fired when a runtime performance issue is detected with the extension. Observe this event to be proactively notified of

types/webextension-polyfill/namespaces/tabs.d.ts

@@ -1052,7 +1052,7 @@ export namespace Tabs {
     /**
      * Fired when a tab is updated.
      */
-    interface onUpdatedEvent
+    interface OnUpdatedEvent
         extends Events.Event<(tabId: number, changeInfo: OnUpdatedChangeInfoType, tab: Tab) => void>
     {
         /**
@@ -1406,7 +1406,7 @@ export namespace Tabs {
         /**
          * Fired when a tab is updated.
          */
-        onUpdated: onUpdatedEvent;
+        onUpdated: OnUpdatedEvent;
 
         /**
          * Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved.

types/webextension-polyfill/namespaces/webNavigation.d.ts

@@ -350,7 +350,7 @@ export namespace WebNavigation {
     /**
      * Fired when a navigation is about to occur.
      */
-    interface onBeforeNavigateEvent extends Events.Event<(details: OnBeforeNavigateDetailsType) => void> {
+    interface OnBeforeNavigateEvent extends Events.Event<(details: OnBeforeNavigateDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -366,7 +366,7 @@ export namespace WebNavigation {
      * might still be downloading, but at least part of the document has been received from the server and the browser has
      * decided to switch to the new document.
      */
-    interface onCommittedEvent extends Events.Event<(details: OnCommittedDetailsType) => void> {
+    interface OnCommittedEvent extends Events.Event<(details: OnCommittedDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -380,7 +380,7 @@ export namespace WebNavigation {
     /**
      * Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.
      */
-    interface onDOMContentLoadedEvent extends Events.Event<(details: OnDOMContentLoadedDetailsType) => void> {
+    interface OnDOMContentLoadedEvent extends Events.Event<(details: OnDOMContentLoadedDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -394,7 +394,7 @@ export namespace WebNavigation {
     /**
      * Fired when a document, including the resources it refers to, is completely loaded and initialized.
      */
-    interface onCompletedEvent extends Events.Event<(details: OnCompletedDetailsType) => void> {
+    interface OnCompletedEvent extends Events.Event<(details: OnCompletedDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -409,7 +409,7 @@ export namespace WebNavigation {
      * Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred,
      * or the user aborted the navigation.
      */
-    interface onErrorOccurredEvent extends Events.Event<(details: OnErrorOccurredDetailsType) => void> {
+    interface OnErrorOccurredEvent extends Events.Event<(details: OnErrorOccurredDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -423,7 +423,7 @@ export namespace WebNavigation {
     /**
      * Fired when a new window, or a new tab in an existing window, is created to host a navigation.
      */
-    interface onCreatedNavigationTargetEvent
+    interface OnCreatedNavigationTargetEvent
         extends Events.Event<(details: OnCreatedNavigationTargetDetailsType) => void>
     {
         /**
@@ -439,7 +439,7 @@ export namespace WebNavigation {
     /**
      * Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.
      */
-    interface onReferenceFragmentUpdatedEvent
+    interface OnReferenceFragmentUpdatedEvent
         extends Events.Event<(details: OnReferenceFragmentUpdatedDetailsType) => void>
     {
         /**
@@ -458,7 +458,7 @@ export namespace WebNavigation {
     /**
      * Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.
      */
-    interface onHistoryStateUpdatedEvent extends Events.Event<(details: OnHistoryStateUpdatedDetailsType) => void> {
+    interface OnHistoryStateUpdatedEvent extends Events.Event<(details: OnHistoryStateUpdatedDetailsType) => void> {
         /**
          * Registers an event listener <em>callback</em> to an event.
          *
@@ -488,40 +488,40 @@ export namespace WebNavigation {
         /**
          * Fired when a navigation is about to occur.
          */
-        onBeforeNavigate: onBeforeNavigateEvent;
+        onBeforeNavigate: OnBeforeNavigateEvent;
 
         /**
          * Fired when a navigation is committed. The document (and the resources it refers to, such as images and subframes)
          * might still be downloading, but at least part of the document has been received from the server and the browser has
          * decided to switch to the new document.
          */
-        onCommitted: onCommittedEvent;
+        onCommitted: OnCommittedEvent;
 
         /**
          * Fired when the page's DOM is fully constructed, but the referenced resources may not finish loading.
          */
-        onDOMContentLoaded: onDOMContentLoadedEvent;
+        onDOMContentLoaded: OnDOMContentLoadedEvent;
 
         /**
          * Fired when a document, including the resources it refers to, is completely loaded and initialized.
          */
-        onCompleted: onCompletedEvent;
+        onCompleted: OnCompletedEvent;
 
         /**
          * Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred,
          * or the user aborted the navigation.
          */
-        onErrorOccurred: onErrorOccurredEvent;
+        onErrorOccurred: OnErrorOccurredEvent;
 
         /**
          * Fired when a new window, or a new tab in an existing window, is created to host a navigation.
          */
-        onCreatedNavigationTarget: onCreatedNavigationTargetEvent;
+        onCreatedNavigationTarget: OnCreatedNavigationTargetEvent;
 
         /**
          * Fired when the reference fragment of a frame was updated. All future events for that frame will use the updated URL.
          */
-        onReferenceFragmentUpdated: onReferenceFragmentUpdatedEvent;
+        onReferenceFragmentUpdated: OnReferenceFragmentUpdatedEvent;
 
         /**
          * Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.
@@ -531,6 +531,6 @@ export namespace WebNavigation {
         /**
          * Fired when the frame's history was updated to a new URL. All future events for that frame will use the updated URL.
          */
-        onHistoryStateUpdated: onHistoryStateUpdatedEvent;
+        onHistoryStateUpdated: OnHistoryStateUpdatedEvent;
     }
 }