chrome-types 0.1.44 → 0.1.45

package/index.d.ts

@@ -80,7 +80,7 @@ declare namespace browserAction {
 
 }
 
-// Generated on Wed Sep 29 2021 22:23:32 GMT+0000 (Coordinated Universal Time)
+// Generated on Thu Sep 30 2021 22:23:30 GMT+0000 (Coordinated Universal Time)
 
 
 declare namespace chrome {
@@ -5385,7 +5385,7 @@ declare namespace chrome {
      *
      * @since Chrome 91
      */
-    export type RequestMethod = "delete" | "get" | "head" | "options" | "patch" | "post" | "put";
+    export type RequestMethod = "connect" | "delete" | "get" | "head" | "options" | "patch" | "post" | "put";
 
     /**
      * This describes whether the request is first or third party to the frame in which it originated. A request is said to be first party if it has the same domain (eTLD+1) as the frame in which the request originated.
@@ -6645,6 +6645,15 @@ declare namespace chrome {
    */
   export namespace downloads {
 
+    /**
+     * Download a URL. If the URL uses the HTTP\[S\] protocol, then the request will include all cookies currently set for its hostname. If both `filename` and `saveAs` are specified, then the Save As dialog will be displayed, pre-populated with the specified `filename`. If the download started successfully, `callback` will be called with the new {@link DownloadItem}'s `downloadId`. If there was an error starting the download, then `callback` will be called with `downloadId=undefined` and {@link runtime.lastError} will contain a descriptive string. The error strings are not guaranteed to remain backwards compatible between releases. Extensions must not parse it.
+     *
+     * @param options What to download and how.
+     */
+    export function download(
+      options: DownloadOptions,
+    ): Promise<number>;
+
     /**
      * Download a URL. If the URL uses the HTTP\[S\] protocol, then the request will include all cookies currently set for its hostname. If both `filename` and `saveAs` are specified, then the Save As dialog will be displayed, pre-populated with the specified `filename`. If the download started successfully, `callback` will be called with the new {@link DownloadItem}'s `downloadId`. If there was an error starting the download, then `callback` will be called with `downloadId=undefined` and {@link runtime.lastError} will contain a descriptive string. The error strings are not guaranteed to remain backwards compatible between releases. Extensions must not parse it.
      *
@@ -6658,6 +6667,15 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Find {@link DownloadItem}. Set `query` to the empty object to get all {@link DownloadItem}. To get a specific {@link DownloadItem}, set only the `id` field. To page through a large number of items, set `orderBy: ['-startTime']`, set `limit` to the number of items per page, and set `startedAfter` to the `startTime` of the last item from the last page.
+     *
+     * @param query
+     */
+    export function search(
+      query: DownloadQuery,
+    ): Promise<DownloadItem[]>;
+
     /**
      * Find {@link DownloadItem}. Set `query` to the empty object to get all {@link DownloadItem}. To get a specific {@link DownloadItem}, set only the `id` field. To page through a large number of items, set `orderBy: ['-startTime']`, set `limit` to the number of items per page, and set `startedAfter` to the `startTime` of the last item from the last page.
      *
@@ -6671,6 +6689,15 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Pause the download. If the request was successful the download is in a paused state. Otherwise {@link runtime.lastError} contains an error message. The request will fail if the download is not active.
+     *
+     * @param downloadId The id of the download to pause.
+     */
+    export function pause(
+      downloadId: number,
+    ): Promise<void>;
+
     /**
      * Pause the download. If the request was successful the download is in a paused state. Otherwise {@link runtime.lastError} contains an error message. The request will fail if the download is not active.
      *
@@ -6682,6 +6709,15 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Resume a paused download. If the request was successful the download is in progress and unpaused. Otherwise {@link runtime.lastError} contains an error message. The request will fail if the download is not active.
+     *
+     * @param downloadId The id of the download to resume.
+     */
+    export function resume(
+      downloadId: number,
+    ): Promise<void>;
+
     /**
      * Resume a paused download. If the request was successful the download is in progress and unpaused. Otherwise {@link runtime.lastError} contains an error message. The request will fail if the download is not active.
      *
@@ -6693,6 +6729,15 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Cancel a download. When `callback` is run, the download is cancelled, completed, interrupted or doesn't exist anymore.
+     *
+     * @param downloadId The id of the download to cancel.
+     */
+    export function cancel(
+      downloadId: number,
+    ): Promise<void>;
+
     /**
      * Cancel a download. When `callback` is run, the download is cancelled, completed, interrupted or doesn't exist anymore.
      *
@@ -6704,6 +6749,17 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Retrieve an icon for the specified download. For new downloads, file icons are available after the {@link onCreated} event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform. The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, {@link runtime.lastError} will contain an error message.
+     *
+     * @param downloadId The identifier for the download.
+     * @param options
+     */
+    export function getFileIcon(
+      downloadId: number,
+      options?: GetFileIconOptions,
+    ): Promise<string>;
+
     /**
      * Retrieve an icon for the specified download. For new downloads, file icons are available after the {@link onCreated} event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the platform. The icon that is returned will therefore depend on a number of factors including state of the download, platform, registered file types and visual theme. If a file icon cannot be determined, {@link runtime.lastError} will contain an error message.
      *
@@ -6755,6 +6811,15 @@ declare namespace chrome {
      */
     export function showDefaultFolder(): void;
 
+    /**
+     * Erase matching {@link DownloadItem} from history without deleting the downloaded file. An {@link onErased} event will fire for each {@link DownloadItem} that matches `query`, then `callback` will be called.
+     *
+     * @param query
+     */
+    export function erase(
+      query: DownloadQuery,
+    ): Promise<number[]>;
+
     /**
      * Erase matching {@link DownloadItem} from history without deleting the downloaded file. An {@link onErased} event will fire for each {@link DownloadItem} that matches `query`, then `callback` will be called.
      *
@@ -6768,6 +6833,15 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Remove the downloaded file if it exists and the {@link DownloadItem} is complete; otherwise return an error through {@link runtime.lastError}.
+     *
+     * @param downloadId
+     */
+    export function removeFile(
+      downloadId: number,
+    ): Promise<void>;
+
     /**
      * Remove the downloaded file if it exists and the {@link DownloadItem} is complete; otherwise return an error through {@link runtime.lastError}.
      *
@@ -6779,6 +6853,15 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Prompt the user to accept a dangerous download. Can only be called from a visible context (tab, window, or page/browser action popup). Does not automatically accept dangerous downloads. If the download is accepted, then an {@link onChanged} event will fire, otherwise nothing will happen. When all the data is fetched into a temporary file and either the download is not dangerous or the danger has been accepted, then the temporary file is renamed to the target filename, the `state` changes to 'complete', and {@link onChanged} fires.
+     *
+     * @param downloadId The identifier for the {@link DownloadItem}.
+     */
+    export function acceptDanger(
+      downloadId: number,
+    ): Promise<void>;
+
     /**
      * Prompt the user to accept a dangerous download. Can only be called from a visible context (tab, window, or page/browser action popup). Does not automatically accept dangerous downloads. If the download is accepted, then an {@link onChanged} event will fire, otherwise nothing will happen. When all the data is fetched into a temporary file and either the download is not dangerous or the danger has been accepted, then the temporary file is renamed to the target filename, the `state` changes to 'complete', and {@link onChanged} fires.
      *
@@ -7440,6 +7523,11 @@ declare namespace chrome {
    */
   export namespace enterprise.hardwarePlatform {
 
+    /**
+     * Obtains the manufacturer and model for the hardware platform and, if the extension is authorized, returns it via `callback`.
+     */
+    export function getHardwarePlatformInfo(): Promise<HardwarePlatformInfo>;
+
     /**
      * Obtains the manufacturer and model for the hardware platform and, if the extension is authorized, returns it via `callback`.
      *
@@ -7468,6 +7556,11 @@ declare namespace chrome {
    */
   export namespace enterprise.networkingAttributes {
 
+    /**
+     * Retrieves the network details of the device's default network. If the user is not affiliated or the device is not connected to a network, {@link runtime.lastError} will be set with a failure reason.
+     */
+    export function getNetworkDetails(): Promise<NetworkDetails>;
+
     /**
      * Retrieves the network details of the device's default network. If the user is not affiliated or the device is not connected to a network, {@link runtime.lastError} will be set with a failure reason.
      *
@@ -8417,6 +8510,19 @@ declare namespace chrome {
    */
   export namespace fileSystemProvider {
 
+    /**
+     * Mounts a file system with the given `fileSystemId` and `displayName`. `displayName` will be shown in the left panel of the Files app. `displayName` can contain any characters including '/', but cannot be an empty string. `displayName` must be descriptive but doesn't have to be unique. The `fileSystemId` must not be an empty string.
+     *
+     * Depending on the type of the file system being mounted, the `source` option must be set appropriately.
+     *
+     * In case of an error, {@link runtime.lastError} will be set with a corresponding error code.
+     *
+     * @param options
+     */
+    export function mount(
+      options: MountOptions,
+    ): Promise<void>;
+
     /**
      * Mounts a file system with the given `fileSystemId` and `displayName`. `displayName` will be shown in the left panel of the Files app. `displayName` can contain any characters including '/', but cannot be an empty string. `displayName` must be descriptive but doesn't have to be unique. The `fileSystemId` must not be an empty string.
      *
@@ -8432,6 +8538,17 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Unmounts a file system with the given `fileSystemId`. It must be called after {@link onUnmountRequested} is invoked. Also, the providing extension can decide to perform unmounting if not requested (eg. in case of lost connection, or a file error).
+     *
+     * In case of an error, {@link runtime.lastError} will be set with a corresponding error code.
+     *
+     * @param options
+     */
+    export function unmount(
+      options: UnmountOptions,
+    ): Promise<void>;
+
     /**
      * Unmounts a file system with the given `fileSystemId`. It must be called after {@link onUnmountRequested} is invoked. Also, the providing extension can decide to perform unmounting if not requested (eg. in case of lost connection, or a file error).
      *
@@ -8445,6 +8562,11 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Returns all file systems mounted by the extension.
+     */
+    export function getAll(): Promise<FileSystemInfo[]>;
+
     /**
      * Returns all file systems mounted by the extension.
      *
@@ -8456,6 +8578,15 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Returns information about a file system with the passed `fileSystemId`.
+     *
+     * @param fileSystemId
+     */
+    export function get(
+      fileSystemId: string,
+    ): Promise<FileSystemInfo>;
+
     /**
      * Returns information about a file system with the passed `fileSystemId`.
      *
@@ -8469,6 +8600,25 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Notifies about changes in the watched directory at `observedPath` in `recursive` mode. If the file system is mounted with `supportsNofityTag`, then `tag` must be provided, and all changes since the last notification always reported, even if the system was shutdown. The last tag can be obtained with {@link getAll}.
+     *
+     * To use, the `file_system_provider.notify` manifest option must be set to true.
+     *
+     * Value of `tag` can be any string which is unique per call, so it's possible to identify the last registered notification. Eg. if the providing extension starts after a reboot, and the last registered notification's tag is equal to "123", then it should call {@link notify} for all changes which happened since the change tagged as "123". It cannot be an empty string.
+     *
+     * Not all providers are able to provide a tag, but if the file system has a changelog, then the tag can be eg. a change number, or a revision number.
+     *
+     * Note that if a parent directory is removed, then all descendant entries are also removed, and if they are watched, then the API must be notified about the fact. Also, if a directory is renamed, then all descendant entries are in fact removed, as there is no entry under their original paths anymore.
+     *
+     * In case of an error, {@link runtime.lastError} will be set will a corresponding error code.
+     *
+     * @param options
+     */
+    export function notify(
+      options: NotifyOptions,
+    ): Promise<void>;
+
     /**
      * Notifies about changes in the watched directory at `observedPath` in `recursive` mode. If the file system is mounted with `supportsNofityTag`, then `tag` must be provided, and all changes since the last notification always reported, even if the system was shutdown. The last tag can be obtained with {@link getAll}.
      *
@@ -9603,6 +9753,25 @@ declare namespace chrome {
    */
   export namespace fontSettings {
 
+    /**
+     * Clears the font set by this extension, if any.
+     *
+     * @param details
+     */
+    export function clearFont(
+      details: {
+        /**
+         * The script for which the font should be cleared. If omitted, the global script font setting is cleared.
+         */
+        script?: ScriptCode,
+
+        /**
+         * The generic font family for which the font should be cleared.
+         */
+        genericFamily: GenericFamily,
+      },
+    ): Promise<void>;
+
     /**
      * Clears the font set by this extension, if any.
      *
@@ -9624,6 +9793,35 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Gets the font for a given script and generic font family.
+     *
+     * @param details
+     */
+    export function getFont(
+      details: {
+        /**
+         * The script for which the font should be retrieved. If omitted, the font setting for the global script (script code "Zyyy") is retrieved.
+         */
+        script?: ScriptCode,
+
+        /**
+         * The generic font family for which the font should be retrieved.
+         */
+        genericFamily: GenericFamily,
+      },
+    ): Promise<{
+      /**
+       * The font ID. Rather than the literal font ID preference value, this may be the ID of the font that the system resolves the preference value to. So, fontId can differ from the font passed to `setFont`, if, for example, the font is not available on the system. The empty string signifies fallback to the global script font setting.
+       */
+      fontId: string,
+
+      /**
+       * The level of control this extension has over the setting.
+       */
+      levelOfControl: LevelOfControl,
+    }>;
+
     /**
      * Gets the font for a given script and generic font family.
      *
@@ -9657,6 +9855,30 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sets the font for a given script and generic font family.
+     *
+     * @param details
+     */
+    export function setFont(
+      details: {
+        /**
+         * The script code which the font should be set. If omitted, the font setting for the global script (script code "Zyyy") is set.
+         */
+        script?: ScriptCode,
+
+        /**
+         * The generic font family for which the font should be set.
+         */
+        genericFamily: GenericFamily,
+
+        /**
+         * The font ID. The empty string means to fallback to the global script font setting.
+         */
+        fontId: string,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the font for a given script and generic font family.
      *
@@ -9683,6 +9905,11 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Gets a list of fonts on the system.
+     */
+    export function getFontList(): Promise<FontName[]>;
+
     /**
      * Gets a list of fonts on the system.
      *
@@ -9694,6 +9921,15 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Clears the default font size set by this extension, if any.
+     *
+     * @param details This parameter is currently unused.
+     */
+    export function clearDefaultFontSize(
+      details?: {},
+    ): Promise<void>;
+
     /**
      * Clears the default font size set by this extension, if any.
      *
@@ -9705,6 +9941,25 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Gets the default font size.
+     *
+     * @param details This parameter is currently unused.
+     */
+    export function getDefaultFontSize(
+      details?: {},
+    ): Promise<{
+      /**
+       * The font size in pixels.
+       */
+      pixelSize: number,
+
+      /**
+       * The level of control this extension has over the setting.
+       */
+      levelOfControl: LevelOfControl,
+    }>;
+
     /**
      * Gets the default font size.
      *
@@ -9728,6 +9983,20 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sets the default font size.
+     *
+     * @param details
+     */
+    export function setDefaultFontSize(
+      details: {
+        /**
+         * The font size in pixels.
+         */
+        pixelSize: number,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the default font size.
      *
@@ -9744,6 +10013,15 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Clears the default fixed font size set by this extension, if any.
+     *
+     * @param details This parameter is currently unused.
+     */
+    export function clearDefaultFixedFontSize(
+      details?: {},
+    ): Promise<void>;
+
     /**
      * Clears the default fixed font size set by this extension, if any.
      *
@@ -9755,6 +10033,25 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Gets the default size for fixed width fonts.
+     *
+     * @param details This parameter is currently unused.
+     */
+    export function getDefaultFixedFontSize(
+      details?: {},
+    ): Promise<{
+      /**
+       * The font size in pixels.
+       */
+      pixelSize: number,
+
+      /**
+       * The level of control this extension has over the setting.
+       */
+      levelOfControl: LevelOfControl,
+    }>;
+
     /**
      * Gets the default size for fixed width fonts.
      *
@@ -9778,6 +10075,20 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sets the default size for fixed width fonts.
+     *
+     * @param details
+     */
+    export function setDefaultFixedFontSize(
+      details: {
+        /**
+         * The font size in pixels.
+         */
+        pixelSize: number,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the default size for fixed width fonts.
      *
@@ -9794,6 +10105,15 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Clears the minimum font size set by this extension, if any.
+     *
+     * @param details This parameter is currently unused.
+     */
+    export function clearMinimumFontSize(
+      details?: {},
+    ): Promise<void>;
+
     /**
      * Clears the minimum font size set by this extension, if any.
      *
@@ -9805,6 +10125,25 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Gets the minimum font size.
+     *
+     * @param details This parameter is currently unused.
+     */
+    export function getMinimumFontSize(
+      details?: {},
+    ): Promise<{
+      /**
+       * The font size in pixels.
+       */
+      pixelSize: number,
+
+      /**
+       * The level of control this extension has over the setting.
+       */
+      levelOfControl: LevelOfControl,
+    }>;
+
     /**
      * Gets the minimum font size.
      *
@@ -9828,6 +10167,20 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sets the minimum font size.
+     *
+     * @param details
+     */
+    export function setMinimumFontSize(
+      details: {
+        /**
+         * The font size in pixels.
+         */
+        pixelSize: number,
+      },
+    ): Promise<void>;
+
     /**
      * Sets the minimum font size.
      *

package/package.json

@@ -4,7 +4,7 @@
   "types": "index.d.ts",
   "type": "module",
   "name": "chrome-types",
-  "version": "0.1.44",
+  "version": "0.1.45",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/GoogleChrome/chrome-types.git"