chrome-types 0.1.206 → 0.1.207

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Thu Jun 15 2023 22:28:37 GMT+0000 (Coordinated Universal Time)
-// Built at 26b7cebb1faf03567f8383e851819d2e63c91e9e
+// Generated on Tue Jun 20 2023 22:30:02 GMT+0000 (Coordinated Universal Time)
+// Built at 02414af8e71af39ab91eaedd45e18bc09437d537
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -14335,6 +14335,17 @@ declare namespace chrome {
       },
     ) => void>;
 
+    /**
+     * Registers the application with FCM. The registration ID will be returned by the `callback`. If `register` is called again with the same list of `senderIds`, the same registration ID will be returned.
+     *
+     * @chrome-returns-extra since Pending
+     * @param senderIds A list of server IDs that are allowed to send messages to the application. It should contain at least one and no more than 100 sender IDs.
+     */
+    export function register(
+
+      senderIds: string[],
+    ): Promise<string>;
+
     /**
      * Registers the application with FCM. The registration ID will be returned by the `callback`. If `register` is called again with the same list of `senderIds`, the same registration ID will be returned.
      *
@@ -14348,11 +14359,18 @@ declare namespace chrome {
       /**
        * @param registrationId A registration ID assigned to the application by the FCM.
        */
-      callback: (
+      callback?: (
         registrationId: string,
       ) => void,
     ): void;
 
+    /**
+     * Unregisters the application from FCM.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function unregister(): Promise<void>;
+
     /**
      * Unregisters the application from FCM.
      *
@@ -14360,9 +14378,41 @@ declare namespace chrome {
      */
     export function unregister(
 
-      callback: () => void,
+      callback?: () => void,
     ): void;
 
+    /**
+     * Sends a message according to its contents.
+     *
+     * @chrome-returns-extra since Pending
+     * @param message A message to send to the other party via FCM.
+     */
+    export function send(
+
+      message: {
+
+        /**
+         * The ID of the server to send the message to as assigned by [Google API Console](https://console.cloud.google.com/apis/dashboard).
+         */
+        destinationId: string,
+
+        /**
+         * The ID of the message. It must be unique for each message in scope of the applications. See the [Cloud Messaging documentation](https://firebase.google.com/docs/cloud-messaging/js/client) for advice for picking and handling an ID.
+         */
+        messageId: string,
+
+        /**
+         * Time-to-live of the message in seconds. If it is not possible to send the message within that time, an onSendError event will be raised. A time-to-live of 0 indicates that the message should be sent immediately or fail if it's not possible. The default value of time-to-live is 86,400 seconds (1 day) and the maximum value is 2,419,200 seconds (28 days).
+         */
+        timeToLive?: number,
+
+        /**
+         * Message data to send to the server. Case-insensitive `goog.` and `google`, as well as case-sensitive `collapse_key` are disallowed as key prefixes. Sum of all key/value pairs should not exceed {@link gcm.MAX_MESSAGE_SIZE}.
+         */
+        data: {[name: string]: string},
+      },
+    ): Promise<string>;
+
     /**
      * Sends a message according to its contents.
      *
@@ -14397,7 +14447,7 @@ declare namespace chrome {
       /**
        * @param messageId The ID of the message that the callback was issued for.
        */
-      callback: (
+      callback?: (
         messageId: string,
       ) => void,
     ): void;
@@ -17970,22 +18020,22 @@ declare namespace chrome {
 
     /**
      * Get the media galleries configured in this user agent. If none are configured or available, the callback will receive an empty array.
+     *
+     * @chrome-returns-extra since Pending
      */
     export function getMediaFileSystems(
 
-      details: MediaFileSystemsDetails,
-
-      callback: (
-        mediaFileSystems: DOMFileSystem[],
-      ) => void,
-    ): void;
+      details?: MediaFileSystemsDetails,
+    ): Promise<DOMFileSystem[]>;
 
     /**
      * Get the media galleries configured in this user agent. If none are configured or available, the callback will receive an empty array.
      */
     export function getMediaFileSystems(
 
-      callback: (
+      details?: MediaFileSystemsDetails,
+
+      callback?: (
         mediaFileSystems: DOMFileSystem[],
       ) => void,
     ): void;
@@ -18011,17 +18061,15 @@ declare namespace chrome {
 
     /**
      * Gets the media-specific metadata for a media file. This should work for files in media galleries as well as other DOM filesystems.
+     *
+     * @chrome-returns-extra since Pending
      */
     export function getMetadata(
 
       mediaFile: Blob,
 
-      options: MediaMetadataOptions,
-
-      callback: (
-        metadata: MediaMetadata,
-      ) => void,
-    ): void;
+      options?: MediaMetadataOptions,
+    ): Promise<MediaMetadata>;
 
     /**
      * Gets the media-specific metadata for a media file. This should work for files in media galleries as well as other DOM filesystems.
@@ -18030,19 +18078,31 @@ declare namespace chrome {
 
       mediaFile: Blob,
 
-      callback: (
+      options?: MediaMetadataOptions,
+
+      callback?: (
         metadata: MediaMetadata,
       ) => void,
     ): void;
 
     /**
      * Adds a gallery watch for the gallery with the specified gallery ID. The given callback is then fired with a success or failure result.
+     *
+     * @chrome-returns-extra since Pending
      */
     export function addGalleryWatch(
 
       galleryId: string,
+    ): Promise<AddGalleryWatchResult>;
 
-      callback: (
+    /**
+     * Adds a gallery watch for the gallery with the specified gallery ID. The given callback is then fired with a success or failure result.
+     */
+    export function addGalleryWatch(
+
+      galleryId: string,
+
+      callback?: (
         result: AddGalleryWatchResult,
       ) => void,
     ): void;
@@ -20104,6 +20164,35 @@ declare namespace chrome {
      */
     export const onShowSettings: events.Event<() => void>;
 
+    /**
+     * Creates and displays a notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param notificationId
+
+    Identifier of the notification. If not set or empty, an ID will automatically be generated. If it matches an existing notification, this method first clears that notification before proceeding with the create operation. The identifier may not be longer than 500 characters.
+
+    The `notificationId` parameter is required before Chrome 42.
+     * @param options Contents of the notification.
+     */
+    export function create(
+
+      notificationId: string,
+
+      options: NotificationOptions,
+    ): Promise<string>;
+
+    /**
+     * Creates and displays a notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param options Contents of the notification.
+     */
+    export function create(
+
+      options: NotificationOptions,
+    ): Promise<string>;
+
     /**
      * Creates and displays a notification.
      *
@@ -20149,6 +20238,20 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Updates an existing notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param notificationId The id of the notification to be updated. This is returned by {@link notifications.create} method.
+     * @param options Contents of the notification to update to.
+     */
+    export function update(
+
+      notificationId: string,
+
+      options: NotificationOptions,
+    ): Promise<boolean>;
+
     /**
      * Updates an existing notification.
      *
@@ -20171,6 +20274,17 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Clears the specified notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param notificationId The id of the notification to be cleared. This is returned by {@link notifications.create} method.
+     */
+    export function clear(
+
+      notificationId: string,
+    ): Promise<boolean>;
+
     /**
      * Clears the specified notification.
      *
@@ -20190,6 +20304,13 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Retrieves all the notifications of this app or extension.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getAll(): Promise<{[name: string]: any}>;
+
     /**
      * Retrieves all the notifications of this app or extension.
      *
@@ -20197,11 +20318,18 @@ declare namespace chrome {
      */
     export function getAll(
 
-      callback: (
+      callback?: (
         notifications: {[name: string]: any},
       ) => void,
     ): void;
 
+    /**
+     * Retrieves whether the user has enabled notifications from this app or extension.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getPermissionLevel(): Promise<PermissionLevel>;
+
     /**
      * Retrieves whether the user has enabled notifications from this app or extension.
      *
@@ -20209,7 +20337,7 @@ declare namespace chrome {
      */
     export function getPermissionLevel(
 
-      callback: (
+      callback?: (
         level: PermissionLevel,
       ) => void,
     ): void;
@@ -31591,13 +31719,24 @@ declare namespace chrome {
     /**
      * Tries to reset the USB device. If the reset fails, the given connection handle will be closed and the USB device will appear to be disconnected then reconnected. In this case {@link getDevices} or {@link findDevices} must be called again to acquire the device.
      *
+     * @chrome-returns-extra since Pending
      * @param handle A connection handle to reset.
      */
     export function resetDevice(
 
       handle: ConnectionHandle,
+    ): Promise<boolean>;
 
-      callback: (
+    /**
+     * Tries to reset the USB device. If the reset fails, the given connection handle will be closed and the USB device will appear to be disconnected then reconnected. In this case {@link getDevices} or {@link findDevices} must be called again to acquire the device.
+     *
+     * @param handle A connection handle to reset.
+     */
+    export function resetDevice(
+
+      handle: ConnectionHandle,
+
+      callback?: (
         success: boolean,
       ) => void,
     ): void;

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Thu Jun 15 2023 22:28:32 GMT+0000 (Coordinated Universal Time)
-// Built at 26b7cebb1faf03567f8383e851819d2e63c91e9e
+// Generated on Tue Jun 20 2023 22:29:56 GMT+0000 (Coordinated Universal Time)
+// Built at 02414af8e71af39ab91eaedd45e18bc09437d537
 
 // Includes MV3+ APIs only.
 
@@ -10133,6 +10133,17 @@ declare namespace chrome {
       },
     ) => void>;
 
+    /**
+     * Registers the application with FCM. The registration ID will be returned by the `callback`. If `register` is called again with the same list of `senderIds`, the same registration ID will be returned.
+     *
+     * @chrome-returns-extra since Pending
+     * @param senderIds A list of server IDs that are allowed to send messages to the application. It should contain at least one and no more than 100 sender IDs.
+     */
+    export function register(
+
+      senderIds: string[],
+    ): Promise<string>;
+
     /**
      * Registers the application with FCM. The registration ID will be returned by the `callback`. If `register` is called again with the same list of `senderIds`, the same registration ID will be returned.
      *
@@ -10146,11 +10157,18 @@ declare namespace chrome {
       /**
        * @param registrationId A registration ID assigned to the application by the FCM.
        */
-      callback: (
+      callback?: (
         registrationId: string,
       ) => void,
     ): void;
 
+    /**
+     * Unregisters the application from FCM.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function unregister(): Promise<void>;
+
     /**
      * Unregisters the application from FCM.
      *
@@ -10158,9 +10176,41 @@ declare namespace chrome {
      */
     export function unregister(
 
-      callback: () => void,
+      callback?: () => void,
     ): void;
 
+    /**
+     * Sends a message according to its contents.
+     *
+     * @chrome-returns-extra since Pending
+     * @param message A message to send to the other party via FCM.
+     */
+    export function send(
+
+      message: {
+
+        /**
+         * The ID of the server to send the message to as assigned by [Google API Console](https://console.cloud.google.com/apis/dashboard).
+         */
+        destinationId: string,
+
+        /**
+         * The ID of the message. It must be unique for each message in scope of the applications. See the [Cloud Messaging documentation](https://firebase.google.com/docs/cloud-messaging/js/client) for advice for picking and handling an ID.
+         */
+        messageId: string,
+
+        /**
+         * Time-to-live of the message in seconds. If it is not possible to send the message within that time, an onSendError event will be raised. A time-to-live of 0 indicates that the message should be sent immediately or fail if it's not possible. The default value of time-to-live is 86,400 seconds (1 day) and the maximum value is 2,419,200 seconds (28 days).
+         */
+        timeToLive?: number,
+
+        /**
+         * Message data to send to the server. Case-insensitive `goog.` and `google`, as well as case-sensitive `collapse_key` are disallowed as key prefixes. Sum of all key/value pairs should not exceed {@link gcm.MAX_MESSAGE_SIZE}.
+         */
+        data: {[name: string]: string},
+      },
+    ): Promise<string>;
+
     /**
      * Sends a message according to its contents.
      *
@@ -10195,7 +10245,7 @@ declare namespace chrome {
       /**
        * @param messageId The ID of the message that the callback was issued for.
        */
-      callback: (
+      callback?: (
         messageId: string,
       ) => void,
     ): void;
@@ -15281,6 +15331,35 @@ declare namespace chrome {
      */
     export const onShowSettings: events.Event<() => void>;
 
+    /**
+     * Creates and displays a notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param notificationId
+
+    Identifier of the notification. If not set or empty, an ID will automatically be generated. If it matches an existing notification, this method first clears that notification before proceeding with the create operation. The identifier may not be longer than 500 characters.
+
+    The `notificationId` parameter is required before Chrome 42.
+     * @param options Contents of the notification.
+     */
+    export function create(
+
+      notificationId: string,
+
+      options: NotificationOptions,
+    ): Promise<string>;
+
+    /**
+     * Creates and displays a notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param options Contents of the notification.
+     */
+    export function create(
+
+      options: NotificationOptions,
+    ): Promise<string>;
+
     /**
      * Creates and displays a notification.
      *
@@ -15326,6 +15405,20 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Updates an existing notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param notificationId The id of the notification to be updated. This is returned by {@link notifications.create} method.
+     * @param options Contents of the notification to update to.
+     */
+    export function update(
+
+      notificationId: string,
+
+      options: NotificationOptions,
+    ): Promise<boolean>;
+
     /**
      * Updates an existing notification.
      *
@@ -15348,6 +15441,17 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Clears the specified notification.
+     *
+     * @chrome-returns-extra since Pending
+     * @param notificationId The id of the notification to be cleared. This is returned by {@link notifications.create} method.
+     */
+    export function clear(
+
+      notificationId: string,
+    ): Promise<boolean>;
+
     /**
      * Clears the specified notification.
      *
@@ -15367,6 +15471,13 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Retrieves all the notifications of this app or extension.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getAll(): Promise<{[name: string]: any}>;
+
     /**
      * Retrieves all the notifications of this app or extension.
      *
@@ -15374,11 +15485,18 @@ declare namespace chrome {
      */
     export function getAll(
 
-      callback: (
+      callback?: (
         notifications: {[name: string]: any},
       ) => void,
     ): void;
 
+    /**
+     * Retrieves whether the user has enabled notifications from this app or extension.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function getPermissionLevel(): Promise<PermissionLevel>;
+
     /**
      * Retrieves whether the user has enabled notifications from this app or extension.
      *
@@ -15386,7 +15504,7 @@ declare namespace chrome {
      */
     export function getPermissionLevel(
 
-      callback: (
+      callback?: (
         level: PermissionLevel,
       ) => void,
     ): void;
@@ -24803,8 +24921,18 @@ declare namespace chrome {
     export function resetDevice(
 
       handle: ConnectionHandle,
+    ): Promise<boolean>;
 
-      callback: (
+    /**
+     * Tries to reset the USB device. If the reset fails, the given connection handle will be closed and the USB device will appear to be disconnected then reconnected. In this case {@link getDevices} or {@link findDevices} must be called again to acquire the device.
+     *
+     * @param handle A connection handle to reset.
+     */
+    export function resetDevice(
+
+      handle: ConnectionHandle,
+
+      callback?: (
         success: boolean,
       ) => void,
     ): void;

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "e821a8ef452e479e"
+    "build-hash": "0edf70fe9e89c745"
   },
   "repository": {
     "type": "git",
@@ -16,5 +16,5 @@
     "url": "https://github.com/GoogleChrome/chrome-types/issues"
   },
   "homepage": "https://github.com/GoogleChrome/chrome-types",
-  "version": "0.1.206"
+  "version": "0.1.207"
 }