chrome-types 0.1.223 → 0.1.225

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/_all.d.ts +179 -49
  2. package/index.d.ts +157 -27
  3. package/package.json +2 -2
package/_all.d.ts CHANGED
@@ -14,8 +14,8 @@
14
14
  * limitations under the License.
15
15
  */
16
16
 
17
- // Generated on Tue Aug 15 2023 22:32:57 GMT+0000 (Coordinated Universal Time)
18
- // Built at 805a5a4b71b6902844392777181234f012fca060
17
+ // Generated on Mon Aug 21 2023 13:07:06 GMT+0000 (Coordinated Universal Time)
18
+ // Built at 8e2cf1aa296431da9cb31e9ab935b3e37801ee10
19
19
 
20
20
  // Includes all types, including MV2 + Platform Apps APIs.
21
21
 
@@ -1894,7 +1894,7 @@ declare namespace chrome {
1894
1894
  /**
1895
1895
  * Gets a list of audio devices filtered based on `filter`.
1896
1896
  *
1897
- * @chrome-returns-extra since Pending
1897
+ * @chrome-returns-extra since Chrome 116
1898
1898
  * @param filter Device properties by which to filter the list of returned audio devices. If the filter is not set or set to `{}`, returned device list will contain all available audio devices.
1899
1899
  */
1900
1900
  export function getDevices(
@@ -1920,7 +1920,7 @@ declare namespace chrome {
1920
1920
  /**
1921
1921
  * Sets lists of active input and/or output devices.
1922
1922
  *
1923
- * @chrome-returns-extra since Pending
1923
+ * @chrome-returns-extra since Chrome 116
1924
1924
  * @param ids
1925
1925
 
1926
1926
  Specifies IDs of devices that should be active. If either the input or output list is not set, devices in that category are unaffected.
@@ -1951,7 +1951,7 @@ declare namespace chrome {
1951
1951
  /**
1952
1952
  * Sets the properties for the input or output device.
1953
1953
  *
1954
- * @chrome-returns-extra since Pending
1954
+ * @chrome-returns-extra since Chrome 116
1955
1955
  */
1956
1956
  export function setProperties(
1957
1957
 
@@ -1975,7 +1975,7 @@ declare namespace chrome {
1975
1975
  /**
1976
1976
  * Gets the system-wide mute state for the specified stream type.
1977
1977
  *
1978
- * @chrome-returns-extra since Pending
1978
+ * @chrome-returns-extra since Chrome 116
1979
1979
  * @param streamType Stream type for which mute state should be fetched.
1980
1980
  */
1981
1981
  export function getMute(
@@ -2001,7 +2001,7 @@ declare namespace chrome {
2001
2001
  /**
2002
2002
  * Sets mute state for a stream type. The mute state will apply to all audio devices with the specified audio stream type.
2003
2003
  *
2004
- * @chrome-returns-extra since Pending
2004
+ * @chrome-returns-extra since Chrome 116
2005
2005
  * @param streamType Stream type for which mute state should be set.
2006
2006
  * @param isMuted New mute value.
2007
2007
  */
@@ -4566,7 +4566,7 @@ declare namespace chrome {
4566
4566
  /**
4567
4567
  * Sets the icon for the browser action. The icon can be specified as the path to an image file, as the pixel data from a canvas element, or as a dictionary of one of those. Either the `path` or the `imageData` property must be specified.
4568
4568
  *
4569
- * @chrome-returns-extra since Pending
4569
+ * @chrome-returns-extra since Chrome 116
4570
4570
  */
4571
4571
  export function setIcon(
4572
4572
 
@@ -8543,6 +8543,56 @@ declare namespace chrome {
8543
8543
  ) => void,
8544
8544
  ): void;
8545
8545
 
8546
+ /**
8547
+ * Disables and enables individual static rules in a {@link Ruleset}. Changes to rules belonging to a disabled {@link Ruleset} will take effect the next time that it becomes enabled.
8548
+ *
8549
+ * @since Pending
8550
+ */
8551
+ export function updateStaticRules(
8552
+
8553
+ options: UpdateStaticRulesOptions,
8554
+ ): Promise<void>;
8555
+
8556
+ /**
8557
+ * Disables and enables individual static rules in a {@link Ruleset}. Changes to rules belonging to a disabled {@link Ruleset} will take effect the next time that it becomes enabled.
8558
+ *
8559
+ * @param callback Called once the update is complete. In case of an error, {@link runtime.lastError} will be set and no change will be made to the enabled static rules.
8560
+ * @since Pending
8561
+ */
8562
+ export function updateStaticRules(
8563
+
8564
+ options: UpdateStaticRulesOptions,
8565
+
8566
+ callback?: () => void,
8567
+ ): void;
8568
+
8569
+ /**
8570
+ * Returns the list of static rules in the given {@link Ruleset} that are currently disabled.
8571
+ *
8572
+ * @param options Specifies the ruleset to query.
8573
+ * @since Pending
8574
+ */
8575
+ export function getDisabledRuleIds(
8576
+
8577
+ options: GetDisabledRuleIdsOptions,
8578
+ ): Promise<number[]>;
8579
+
8580
+ /**
8581
+ * Returns the list of static rules in the given {@link Ruleset} that are currently disabled.
8582
+ *
8583
+ * @param options Specifies the ruleset to query.
8584
+ * @param callback Called with a list of ids that correspond to the disabled rules in that ruleset.
8585
+ * @since Pending
8586
+ */
8587
+ export function getDisabledRuleIds(
8588
+
8589
+ options: GetDisabledRuleIdsOptions,
8590
+
8591
+ callback?: (
8592
+ disabledRuleIds: number[],
8593
+ ) => void,
8594
+ ): void;
8595
+
8546
8596
  /**
8547
8597
  * Returns all rules matched for the extension. Callers can optionally filter the list of matched rules by specifying a `filter`. This method is only available to extensions with the `declarativeNetRequestFeedback` permission or having the `activeTab` permission granted for the `tabId` specified in `filter`. Note: Rules not associated with an active document that were matched more than five minutes ago will not be returned.
8548
8598
  *
@@ -14468,7 +14518,7 @@ declare namespace chrome {
14468
14518
  /**
14469
14519
  * 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.
14470
14520
  *
14471
- * @chrome-returns-extra since Pending
14521
+ * @chrome-returns-extra since Chrome 116
14472
14522
  * @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.
14473
14523
  */
14474
14524
  export function register(
@@ -14497,7 +14547,7 @@ declare namespace chrome {
14497
14547
  /**
14498
14548
  * Unregisters the application from FCM.
14499
14549
  *
14500
- * @chrome-returns-extra since Pending
14550
+ * @chrome-returns-extra since Chrome 116
14501
14551
  */
14502
14552
  export function unregister(): Promise<void>;
14503
14553
 
@@ -14514,7 +14564,7 @@ declare namespace chrome {
14514
14564
  /**
14515
14565
  * Sends a message according to its contents.
14516
14566
  *
14517
- * @chrome-returns-extra since Pending
14567
+ * @chrome-returns-extra since Chrome 116
14518
14568
  * @param message A message to send to the other party via FCM.
14519
14569
  */
14520
14570
  export function send(
@@ -15742,7 +15792,7 @@ declare namespace chrome {
15742
15792
  /**
15743
15793
  * Returns "locked" if the system is locked, "idle" if the user has not generated any input for a specified number of seconds, or "active" otherwise.
15744
15794
  *
15745
- * @chrome-returns-extra since Pending
15795
+ * @chrome-returns-extra since Chrome 116
15746
15796
  * @param detectionIntervalInSeconds The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected.
15747
15797
  */
15748
15798
  export function queryState(
@@ -15777,7 +15827,7 @@ declare namespace chrome {
15777
15827
  /**
15778
15828
  * Gets the time, in seconds, it takes until the screen is locked automatically while idle. Returns a zero duration if the screen is never locked automatically. Currently supported on Chrome OS only.
15779
15829
  *
15780
- * @chrome-returns-extra since Pending
15830
+ * @chrome-returns-extra since Chrome 116
15781
15831
  * @since Chrome 73
15782
15832
  * @chrome-platform chromeos
15783
15833
  * @chrome-platform lacros
@@ -18188,7 +18238,7 @@ declare namespace chrome {
18188
18238
  /**
18189
18239
  * Get the media galleries configured in this user agent. If none are configured or available, the callback will receive an empty array.
18190
18240
  *
18191
- * @chrome-returns-extra since Pending
18241
+ * @chrome-returns-extra since Chrome 116
18192
18242
  */
18193
18243
  export function getMediaFileSystems(
18194
18244
 
@@ -18229,7 +18279,7 @@ declare namespace chrome {
18229
18279
  /**
18230
18280
  * Gets the media-specific metadata for a media file. This should work for files in media galleries as well as other DOM filesystems.
18231
18281
  *
18232
- * @chrome-returns-extra since Pending
18282
+ * @chrome-returns-extra since Chrome 116
18233
18283
  */
18234
18284
  export function getMetadata(
18235
18285
 
@@ -18255,7 +18305,7 @@ declare namespace chrome {
18255
18305
  /**
18256
18306
  * Adds a gallery watch for the gallery with the specified gallery ID. The given callback is then fired with a success or failure result.
18257
18307
  *
18258
- * @chrome-returns-extra since Pending
18308
+ * @chrome-returns-extra since Chrome 116
18259
18309
  */
18260
18310
  export function addGalleryWatch(
18261
18311
 
@@ -20334,7 +20384,7 @@ declare namespace chrome {
20334
20384
  /**
20335
20385
  * Creates and displays a notification.
20336
20386
  *
20337
- * @chrome-returns-extra since Pending
20387
+ * @chrome-returns-extra since Chrome 116
20338
20388
  * @param notificationId
20339
20389
 
20340
20390
  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.
@@ -20352,7 +20402,7 @@ declare namespace chrome {
20352
20402
  /**
20353
20403
  * Creates and displays a notification.
20354
20404
  *
20355
- * @chrome-returns-extra since Pending
20405
+ * @chrome-returns-extra since Chrome 116
20356
20406
  * @param options Contents of the notification.
20357
20407
  */
20358
20408
  export function create(
@@ -20408,7 +20458,7 @@ declare namespace chrome {
20408
20458
  /**
20409
20459
  * Updates an existing notification.
20410
20460
  *
20411
- * @chrome-returns-extra since Pending
20461
+ * @chrome-returns-extra since Chrome 116
20412
20462
  * @param notificationId The id of the notification to be updated. This is returned by {@link notifications.create} method.
20413
20463
  * @param options Contents of the notification to update to.
20414
20464
  */
@@ -20444,7 +20494,7 @@ declare namespace chrome {
20444
20494
  /**
20445
20495
  * Clears the specified notification.
20446
20496
  *
20447
- * @chrome-returns-extra since Pending
20497
+ * @chrome-returns-extra since Chrome 116
20448
20498
  * @param notificationId The id of the notification to be cleared. This is returned by {@link notifications.create} method.
20449
20499
  */
20450
20500
  export function clear(
@@ -20474,7 +20524,7 @@ declare namespace chrome {
20474
20524
  /**
20475
20525
  * Retrieves all the notifications of this app or extension.
20476
20526
  *
20477
- * @chrome-returns-extra since Pending
20527
+ * @chrome-returns-extra since Chrome 116
20478
20528
  */
20479
20529
  export function getAll(): Promise<{[name: string]: any}>;
20480
20530
 
@@ -20493,7 +20543,7 @@ declare namespace chrome {
20493
20543
  /**
20494
20544
  * Retrieves whether the user has enabled notifications from this app or extension.
20495
20545
  *
20496
- * @chrome-returns-extra since Pending
20546
+ * @chrome-returns-extra since Chrome 116
20497
20547
  */
20498
20548
  export function getPermissionLevel(): Promise<PermissionLevel>;
20499
20549
 
@@ -21028,7 +21078,7 @@ declare namespace chrome {
21028
21078
  /**
21029
21079
  * Saves the content of the tab with given id as MHTML.
21030
21080
  *
21031
- * @chrome-returns-extra since Pending
21081
+ * @chrome-returns-extra since Chrome 116
21032
21082
  */
21033
21083
  export function saveAsMHTML(
21034
21084
 
@@ -23489,7 +23539,7 @@ declare namespace chrome {
23489
23539
  * Fetches information about active contexts associated with this extension
23490
23540
  *
23491
23541
  * @param filter A filter to find matching contexts. A context matches if it matches all specified fields in the filter. Any unspecified field in the filter matches all contexts.
23492
- * @since Pending
23542
+ * @since Chrome 116
23493
23543
  * @chrome-min-manifest MV3
23494
23544
  */
23495
23545
  export function getContexts(
@@ -23502,7 +23552,7 @@ declare namespace chrome {
23502
23552
  *
23503
23553
  * @param filter A filter to find matching contexts. A context matches if it matches all specified fields in the filter. Any unspecified field in the filter matches all contexts.
23504
23554
  * @param callback Invoked with the matching contexts, if any.
23505
- * @since Pending
23555
+ * @since Chrome 116
23506
23556
  * @chrome-min-manifest MV3
23507
23557
  */
23508
23558
  export function getContexts(
@@ -24777,7 +24827,7 @@ declare namespace chrome {
24777
24827
  }
24778
24828
 
24779
24829
  /**
24780
- * @since Pending
24830
+ * @since Chrome 116
24781
24831
  */
24782
24832
  export interface OpenOptions {
24783
24833
 
@@ -24884,7 +24934,7 @@ declare namespace chrome {
24884
24934
  * Opens the side panel for the extension. This may only be called in response to a user action.
24885
24935
  *
24886
24936
  * @param options Specifies the context in which to open the side panel.
24887
- * @since Pending
24937
+ * @since Chrome 116
24888
24938
  */
24889
24939
  export function open(
24890
24940
 
@@ -24896,7 +24946,7 @@ declare namespace chrome {
24896
24946
  *
24897
24947
  * @param options Specifies the context in which to open the side panel.
24898
24948
  * @param callback Called when the side panel has been opened.
24899
- * @since Pending
24949
+ * @since Chrome 116
24900
24950
  */
24901
24951
  export function open(
24902
24952
 
@@ -28389,7 +28439,7 @@ declare namespace chrome {
28389
28439
  /**
28390
28440
  * Returns a list of tabs that have requested capture or are being captured, i.e. status != stopped and status != error. This allows extensions to inform the user that there is an existing tab capture that would prevent a new tab capture from succeeding (or to prevent redundant requests for the same tab).
28391
28441
  *
28392
- * @chrome-returns-extra since Pending
28442
+ * @chrome-returns-extra since Chrome 116
28393
28443
  */
28394
28444
  export function getCapturedTabs(): Promise<CaptureInfo[]>;
28395
28445
 
@@ -28408,7 +28458,7 @@ declare namespace chrome {
28408
28458
  /**
28409
28459
  * Creates a stream ID to capture the target tab. Similar to chrome.tabCapture.capture() method, but returns a media stream ID, instead of a media stream, to the consumer tab.
28410
28460
  *
28411
- * @chrome-returns-extra since Pending
28461
+ * @chrome-returns-extra since Chrome 116
28412
28462
  * @since Chrome 71
28413
28463
  */
28414
28464
  export function getMediaStreamId(
@@ -31870,7 +31920,7 @@ declare namespace chrome {
31870
31920
  /**
31871
31921
  * Enumerates connected USB devices.
31872
31922
  *
31873
- * @chrome-returns-extra since Pending
31923
+ * @chrome-returns-extra since Chrome 116
31874
31924
  * @param options The properties to search for on target devices.
31875
31925
  */
31876
31926
  export function getDevices(
@@ -31895,7 +31945,7 @@ declare namespace chrome {
31895
31945
  /**
31896
31946
  * Presents a device picker to the user and returns the {@link Device}s selected. If the user cancels the picker devices will be empty. A user gesture is required for the dialog to display. Without a user gesture, the callback will run as though the user cancelled.
31897
31947
  *
31898
- * @chrome-returns-extra since Pending
31948
+ * @chrome-returns-extra since Chrome 116
31899
31949
  * @param options Configuration of the device picker dialog box.
31900
31950
  */
31901
31951
  export function getUserSelectedDevices(
@@ -31921,7 +31971,7 @@ declare namespace chrome {
31921
31971
  /**
31922
31972
  * Returns the full set of device configuration descriptors.
31923
31973
  *
31924
- * @chrome-returns-extra since Pending
31974
+ * @chrome-returns-extra since Chrome 116
31925
31975
  * @param device The {@link Device} to fetch descriptors from.
31926
31976
  * @since Chrome 47
31927
31977
  */
@@ -31948,7 +31998,7 @@ declare namespace chrome {
31948
31998
  /**
31949
31999
  * Requests access from the permission broker to a device claimed by Chrome OS if the given interface on the device is not claimed.
31950
32000
  *
31951
- * @chrome-returns-extra since Pending
32001
+ * @chrome-returns-extra since Chrome 116
31952
32002
  * @param device The {@link Device} to request access to.
31953
32003
  * @param interfaceId The particular interface requested.
31954
32004
  * @deprecated This function was Chrome OS specific and calling it on other platforms would fail. This operation is now implicitly performed as part of {@link openDevice} and this function will return `true` on all platforms.
@@ -31981,7 +32031,7 @@ declare namespace chrome {
31981
32031
  /**
31982
32032
  * Opens a USB device returned by {@link getDevices}.
31983
32033
  *
31984
- * @chrome-returns-extra since Pending
32034
+ * @chrome-returns-extra since Chrome 116
31985
32035
  * @param device The {@link Device} to open.
31986
32036
  */
31987
32037
  export function openDevice(
@@ -32010,7 +32060,7 @@ declare namespace chrome {
32010
32060
  *
32011
32061
  * Calling this method is equivalent to calling {@link getDevices} followed by {@link openDevice} for each device.
32012
32062
  *
32013
- * @chrome-returns-extra since Pending
32063
+ * @chrome-returns-extra since Chrome 116
32014
32064
  * @param options The properties to search for on target devices.
32015
32065
  */
32016
32066
  export function findDevices(
@@ -32039,7 +32089,7 @@ declare namespace chrome {
32039
32089
  /**
32040
32090
  * Closes a connection handle. Invoking operations on a handle after it has been closed is a safe operation but causes no action to be taken.
32041
32091
  *
32042
- * @chrome-returns-extra since Pending
32092
+ * @chrome-returns-extra since Chrome 116
32043
32093
  * @param handle The {@link ConnectionHandle} to close.
32044
32094
  */
32045
32095
  export function closeDevice(
@@ -32064,7 +32114,7 @@ declare namespace chrome {
32064
32114
  *
32065
32115
  * This function effectively resets the device by selecting one of the device's available configurations. Only configuration values greater than `0` are valid however some buggy devices have a working configuration `0` and so this value is allowed.
32066
32116
  *
32067
- * @chrome-returns-extra since Pending
32117
+ * @chrome-returns-extra since Chrome 116
32068
32118
  * @param handle An open connection to the device.
32069
32119
  */
32070
32120
  export function setConfiguration(
@@ -32093,7 +32143,7 @@ declare namespace chrome {
32093
32143
  /**
32094
32144
  * Gets the configuration descriptor for the currently selected configuration.
32095
32145
  *
32096
- * @chrome-returns-extra since Pending
32146
+ * @chrome-returns-extra since Chrome 116
32097
32147
  * @param handle An open connection to the device.
32098
32148
  */
32099
32149
  export function getConfiguration(
@@ -32118,7 +32168,7 @@ declare namespace chrome {
32118
32168
  /**
32119
32169
  * Lists all interfaces on a USB device.
32120
32170
  *
32121
- * @chrome-returns-extra since Pending
32171
+ * @chrome-returns-extra since Chrome 116
32122
32172
  * @param handle An open connection to the device.
32123
32173
  */
32124
32174
  export function listInterfaces(
@@ -32145,7 +32195,7 @@ declare namespace chrome {
32145
32195
  *
32146
32196
  * {@link releaseInterface} should be called when the interface is no longer needed.
32147
32197
  *
32148
- * @chrome-returns-extra since Pending
32198
+ * @chrome-returns-extra since Chrome 116
32149
32199
  * @param handle An open connection to the device.
32150
32200
  * @param interfaceNumber The interface to be claimed.
32151
32201
  */
@@ -32176,7 +32226,7 @@ declare namespace chrome {
32176
32226
  /**
32177
32227
  * Releases a claimed interface.
32178
32228
  *
32179
- * @chrome-returns-extra since Pending
32229
+ * @chrome-returns-extra since Chrome 116
32180
32230
  * @param handle An open connection to the device.
32181
32231
  * @param interfaceNumber The interface to be released.
32182
32232
  */
@@ -32205,7 +32255,7 @@ declare namespace chrome {
32205
32255
  /**
32206
32256
  * Selects an alternate setting on a previously claimed interface.
32207
32257
  *
32208
- * @chrome-returns-extra since Pending
32258
+ * @chrome-returns-extra since Chrome 116
32209
32259
  * @param handle An open connection to the device where this interface has been claimed.
32210
32260
  * @param interfaceNumber The interface to configure.
32211
32261
  * @param alternateSetting The alternate setting to configure.
@@ -32242,7 +32292,7 @@ declare namespace chrome {
32242
32292
  *
32243
32293
  * Control transfers refer to either the device, an interface or an endpoint. Transfers to an interface or endpoint require the interface to be claimed.
32244
32294
  *
32245
- * @chrome-returns-extra since Pending
32295
+ * @chrome-returns-extra since Chrome 116
32246
32296
  * @param handle An open connection to the device.
32247
32297
  */
32248
32298
  export function controlTransfer(
@@ -32273,7 +32323,7 @@ declare namespace chrome {
32273
32323
  /**
32274
32324
  * Performs a bulk transfer on the specified device.
32275
32325
  *
32276
- * @chrome-returns-extra since Pending
32326
+ * @chrome-returns-extra since Chrome 116
32277
32327
  * @param handle An open connection to the device.
32278
32328
  * @param transferInfo The transfer parameters.
32279
32329
  */
@@ -32304,7 +32354,7 @@ declare namespace chrome {
32304
32354
  /**
32305
32355
  * Performs an interrupt transfer on the specified device.
32306
32356
  *
32307
- * @chrome-returns-extra since Pending
32357
+ * @chrome-returns-extra since Chrome 116
32308
32358
  * @param handle An open connection to the device.
32309
32359
  * @param transferInfo The transfer parameters.
32310
32360
  */
@@ -32335,7 +32385,7 @@ declare namespace chrome {
32335
32385
  /**
32336
32386
  * Performs an isochronous transfer on the specific device.
32337
32387
  *
32338
- * @chrome-returns-extra since Pending
32388
+ * @chrome-returns-extra since Chrome 116
32339
32389
  * @param handle An open connection to the device.
32340
32390
  */
32341
32391
  export function isochronousTransfer(
@@ -32364,7 +32414,7 @@ declare namespace chrome {
32364
32414
  /**
32365
32415
  * 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.
32366
32416
  *
32367
- * @chrome-returns-extra since Pending
32417
+ * @chrome-returns-extra since Chrome 116
32368
32418
  * @param handle A connection handle to reset.
32369
32419
  */
32370
32420
  export function resetDevice(
@@ -32387,6 +32437,86 @@ declare namespace chrome {
32387
32437
  ): void;
32388
32438
  }
32389
32439
 
32440
+ /**
32441
+ * Use the `userScripts` API to execute user scripts in the User Scripts context.
32442
+ *
32443
+ * @alpha
32444
+ * @chrome-permission userScripts
32445
+ * @chrome-channel trunk
32446
+ * @chrome-min-manifest MV3
32447
+ */
32448
+ export namespace userScripts {
32449
+
32450
+ export interface ScriptSource {
32451
+
32452
+ /**
32453
+ * A string containing the JavaScript code to inject. Exactly one of `file` or `code` must be specified.
32454
+ */
32455
+ code?: string;
32456
+
32457
+ /**
32458
+ * The path of the JavaScript file to inject relative to the extension's root directory. Exactly one of `file` or `code` must be specified.
32459
+ */
32460
+ file?: string;
32461
+ }
32462
+
32463
+ export interface RegisteredUserScript {
32464
+
32465
+ /**
32466
+ * If true, it will inject into all frames, even if the frame is not the top-most frame in the tab. Each frame is checked independently for URL requirements; it will not inject into child frames if the URL requirements are not met. Defaults to false, meaning that only the top frame is matched.
32467
+ */
32468
+ allFrames?: boolean;
32469
+
32470
+ /**
32471
+ * Excludes pages that this content script would otherwise be injected into. See [Match Patterns](https://developer.chrome.com/docs/extensions/match_patterns) for more details on the syntax of these strings.
32472
+ */
32473
+ excludeMatches?: string[];
32474
+
32475
+ /**
32476
+ * The ID of the user script specified in the API call. This property must not start with a '\_' as it's reserved as a prefix for generated script IDs.
32477
+ */
32478
+ id: string;
32479
+
32480
+ /**
32481
+ * The list of ScriptSource objects defining sources of scripts to be injected into matching pages.
32482
+ */
32483
+ js: ScriptSource[];
32484
+
32485
+ /**
32486
+ * Specifies which pages this content script will be injected into. See [Match Patterns](https://developer.chrome.com/docs/extensions/match_patterns) for more details on the syntax of these strings.
32487
+ */
32488
+ matches?: string[];
32489
+
32490
+ /**
32491
+ * Specifies when JavaScript files are injected into the web page. The preferred and default value is `document_idle`.
32492
+ */
32493
+ runAt?: extensionTypes.RunAt;
32494
+ }
32495
+
32496
+ /**
32497
+ * Registers one or more user scripts for this extension.
32498
+ *
32499
+ * @param scripts Contains a list of user scripts to be registered.
32500
+ */
32501
+ export function register(
32502
+
32503
+ scripts: RegisteredUserScript[],
32504
+ ): Promise<void>;
32505
+
32506
+ /**
32507
+ * Registers one or more user scripts for this extension.
32508
+ *
32509
+ * @param scripts Contains a list of user scripts to be registered.
32510
+ * @param callback Called once scripts have been fully registered or if an error has ocurred.
32511
+ */
32512
+ export function register(
32513
+
32514
+ scripts: RegisteredUserScript[],
32515
+
32516
+ callback?: () => void,
32517
+ ): void;
32518
+ }
32519
+
32390
32520
  /**
32391
32521
  * The `chrome.virtualKeyboard` API is a kiosk only API used to configure virtual keyboard layout and behavior in kiosk sessions.
32392
32522
  *
@@ -35225,7 +35355,7 @@ declare namespace chrome {
35225
35355
  /**
35226
35356
  * Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.
35227
35357
  *
35228
- * @chrome-returns-extra since Pending
35358
+ * @chrome-returns-extra since Chrome 116
35229
35359
  */
35230
35360
  export function handlerBehaviorChanged(): Promise<void>;
35231
35361
 
package/index.d.ts CHANGED
@@ -14,8 +14,8 @@
14
14
  * limitations under the License.
15
15
  */
16
16
 
17
- // Generated on Tue Aug 15 2023 22:32:50 GMT+0000 (Coordinated Universal Time)
18
- // Built at 805a5a4b71b6902844392777181234f012fca060
17
+ // Generated on Mon Aug 21 2023 13:07:01 GMT+0000 (Coordinated Universal Time)
18
+ // Built at 8e2cf1aa296431da9cb31e9ab935b3e37801ee10
19
19
 
20
20
  // Includes MV3+ APIs only.
21
21
 
@@ -1128,7 +1128,7 @@ declare namespace chrome {
1128
1128
  /**
1129
1129
  * Gets a list of audio devices filtered based on `filter`.
1130
1130
  *
1131
- * @chrome-returns-extra since Pending
1131
+ * @chrome-returns-extra since Chrome 116
1132
1132
  * @param filter Device properties by which to filter the list of returned audio devices. If the filter is not set or set to `{}`, returned device list will contain all available audio devices.
1133
1133
  */
1134
1134
  export function getDevices(
@@ -1154,7 +1154,7 @@ declare namespace chrome {
1154
1154
  /**
1155
1155
  * Sets lists of active input and/or output devices.
1156
1156
  *
1157
- * @chrome-returns-extra since Pending
1157
+ * @chrome-returns-extra since Chrome 116
1158
1158
  * @param ids
1159
1159
 
1160
1160
  Specifies IDs of devices that should be active. If either the input or output list is not set, devices in that category are unaffected.
@@ -1185,7 +1185,7 @@ declare namespace chrome {
1185
1185
  /**
1186
1186
  * Sets the properties for the input or output device.
1187
1187
  *
1188
- * @chrome-returns-extra since Pending
1188
+ * @chrome-returns-extra since Chrome 116
1189
1189
  */
1190
1190
  export function setProperties(
1191
1191
 
@@ -1209,7 +1209,7 @@ declare namespace chrome {
1209
1209
  /**
1210
1210
  * Gets the system-wide mute state for the specified stream type.
1211
1211
  *
1212
- * @chrome-returns-extra since Pending
1212
+ * @chrome-returns-extra since Chrome 116
1213
1213
  * @param streamType Stream type for which mute state should be fetched.
1214
1214
  */
1215
1215
  export function getMute(
@@ -1235,7 +1235,7 @@ declare namespace chrome {
1235
1235
  /**
1236
1236
  * Sets mute state for a stream type. The mute state will apply to all audio devices with the specified audio stream type.
1237
1237
  *
1238
- * @chrome-returns-extra since Pending
1238
+ * @chrome-returns-extra since Chrome 116
1239
1239
  * @param streamType Stream type for which mute state should be set.
1240
1240
  * @param isMuted New mute value.
1241
1241
  */
@@ -5289,6 +5289,56 @@ declare namespace chrome {
5289
5289
  ) => void,
5290
5290
  ): void;
5291
5291
 
5292
+ /**
5293
+ * Disables and enables individual static rules in a {@link Ruleset}. Changes to rules belonging to a disabled {@link Ruleset} will take effect the next time that it becomes enabled.
5294
+ *
5295
+ * @since Pending
5296
+ */
5297
+ export function updateStaticRules(
5298
+
5299
+ options: UpdateStaticRulesOptions,
5300
+ ): Promise<void>;
5301
+
5302
+ /**
5303
+ * Disables and enables individual static rules in a {@link Ruleset}. Changes to rules belonging to a disabled {@link Ruleset} will take effect the next time that it becomes enabled.
5304
+ *
5305
+ * @param callback Called once the update is complete. In case of an error, {@link runtime.lastError} will be set and no change will be made to the enabled static rules.
5306
+ * @since Pending
5307
+ */
5308
+ export function updateStaticRules(
5309
+
5310
+ options: UpdateStaticRulesOptions,
5311
+
5312
+ callback?: () => void,
5313
+ ): void;
5314
+
5315
+ /**
5316
+ * Returns the list of static rules in the given {@link Ruleset} that are currently disabled.
5317
+ *
5318
+ * @param options Specifies the ruleset to query.
5319
+ * @since Pending
5320
+ */
5321
+ export function getDisabledRuleIds(
5322
+
5323
+ options: GetDisabledRuleIdsOptions,
5324
+ ): Promise<number[]>;
5325
+
5326
+ /**
5327
+ * Returns the list of static rules in the given {@link Ruleset} that are currently disabled.
5328
+ *
5329
+ * @param options Specifies the ruleset to query.
5330
+ * @param callback Called with a list of ids that correspond to the disabled rules in that ruleset.
5331
+ * @since Pending
5332
+ */
5333
+ export function getDisabledRuleIds(
5334
+
5335
+ options: GetDisabledRuleIdsOptions,
5336
+
5337
+ callback?: (
5338
+ disabledRuleIds: number[],
5339
+ ) => void,
5340
+ ): void;
5341
+
5292
5342
  /**
5293
5343
  * Returns all rules matched for the extension. Callers can optionally filter the list of matched rules by specifying a `filter`. This method is only available to extensions with the `declarativeNetRequestFeedback` permission or having the `activeTab` permission granted for the `tabId` specified in `filter`. Note: Rules not associated with an active document that were matched more than five minutes ago will not be returned.
5294
5344
  *
@@ -10180,7 +10230,7 @@ declare namespace chrome {
10180
10230
  /**
10181
10231
  * 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.
10182
10232
  *
10183
- * @chrome-returns-extra since Pending
10233
+ * @chrome-returns-extra since Chrome 116
10184
10234
  * @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.
10185
10235
  */
10186
10236
  export function register(
@@ -10209,7 +10259,7 @@ declare namespace chrome {
10209
10259
  /**
10210
10260
  * Unregisters the application from FCM.
10211
10261
  *
10212
- * @chrome-returns-extra since Pending
10262
+ * @chrome-returns-extra since Chrome 116
10213
10263
  */
10214
10264
  export function unregister(): Promise<void>;
10215
10265
 
@@ -10226,7 +10276,7 @@ declare namespace chrome {
10226
10276
  /**
10227
10277
  * Sends a message according to its contents.
10228
10278
  *
10229
- * @chrome-returns-extra since Pending
10279
+ * @chrome-returns-extra since Chrome 116
10230
10280
  * @param message A message to send to the other party via FCM.
10231
10281
  */
10232
10282
  export function send(
@@ -11103,7 +11153,7 @@ declare namespace chrome {
11103
11153
  /**
11104
11154
  * Returns "locked" if the system is locked, "idle" if the user has not generated any input for a specified number of seconds, or "active" otherwise.
11105
11155
  *
11106
- * @chrome-returns-extra since Pending
11156
+ * @chrome-returns-extra since Chrome 116
11107
11157
  * @param detectionIntervalInSeconds The system is considered idle if detectionIntervalInSeconds seconds have elapsed since the last user input detected.
11108
11158
  */
11109
11159
  export function queryState(
@@ -11138,7 +11188,7 @@ declare namespace chrome {
11138
11188
  /**
11139
11189
  * Gets the time, in seconds, it takes until the screen is locked automatically while idle. Returns a zero duration if the screen is never locked automatically. Currently supported on Chrome OS only.
11140
11190
  *
11141
- * @chrome-returns-extra since Pending
11191
+ * @chrome-returns-extra since Chrome 116
11142
11192
  * @since Chrome 73
11143
11193
  * @chrome-platform chromeos
11144
11194
  * @chrome-platform lacros
@@ -15378,7 +15428,7 @@ declare namespace chrome {
15378
15428
  /**
15379
15429
  * Creates and displays a notification.
15380
15430
  *
15381
- * @chrome-returns-extra since Pending
15431
+ * @chrome-returns-extra since Chrome 116
15382
15432
  * @param notificationId
15383
15433
 
15384
15434
  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.
@@ -15396,7 +15446,7 @@ declare namespace chrome {
15396
15446
  /**
15397
15447
  * Creates and displays a notification.
15398
15448
  *
15399
- * @chrome-returns-extra since Pending
15449
+ * @chrome-returns-extra since Chrome 116
15400
15450
  * @param options Contents of the notification.
15401
15451
  */
15402
15452
  export function create(
@@ -15452,7 +15502,7 @@ declare namespace chrome {
15452
15502
  /**
15453
15503
  * Updates an existing notification.
15454
15504
  *
15455
- * @chrome-returns-extra since Pending
15505
+ * @chrome-returns-extra since Chrome 116
15456
15506
  * @param notificationId The id of the notification to be updated. This is returned by {@link notifications.create} method.
15457
15507
  * @param options Contents of the notification to update to.
15458
15508
  */
@@ -15488,7 +15538,7 @@ declare namespace chrome {
15488
15538
  /**
15489
15539
  * Clears the specified notification.
15490
15540
  *
15491
- * @chrome-returns-extra since Pending
15541
+ * @chrome-returns-extra since Chrome 116
15492
15542
  * @param notificationId The id of the notification to be cleared. This is returned by {@link notifications.create} method.
15493
15543
  */
15494
15544
  export function clear(
@@ -15518,7 +15568,7 @@ declare namespace chrome {
15518
15568
  /**
15519
15569
  * Retrieves all the notifications of this app or extension.
15520
15570
  *
15521
- * @chrome-returns-extra since Pending
15571
+ * @chrome-returns-extra since Chrome 116
15522
15572
  */
15523
15573
  export function getAll(): Promise<{[name: string]: any}>;
15524
15574
 
@@ -15537,7 +15587,7 @@ declare namespace chrome {
15537
15587
  /**
15538
15588
  * Retrieves whether the user has enabled notifications from this app or extension.
15539
15589
  *
15540
- * @chrome-returns-extra since Pending
15590
+ * @chrome-returns-extra since Chrome 116
15541
15591
  */
15542
15592
  export function getPermissionLevel(): Promise<PermissionLevel>;
15543
15593
 
@@ -15792,7 +15842,7 @@ declare namespace chrome {
15792
15842
  /**
15793
15843
  * Saves the content of the tab with given id as MHTML.
15794
15844
  *
15795
- * @chrome-returns-extra since Pending
15845
+ * @chrome-returns-extra since Chrome 116
15796
15846
  */
15797
15847
  export function saveAsMHTML(
15798
15848
 
@@ -18242,7 +18292,7 @@ declare namespace chrome {
18242
18292
  * Fetches information about active contexts associated with this extension
18243
18293
  *
18244
18294
  * @param filter A filter to find matching contexts. A context matches if it matches all specified fields in the filter. Any unspecified field in the filter matches all contexts.
18245
- * @since Pending
18295
+ * @since Chrome 116
18246
18296
  * @chrome-min-manifest MV3
18247
18297
  */
18248
18298
  export function getContexts(
@@ -18255,7 +18305,7 @@ declare namespace chrome {
18255
18305
  *
18256
18306
  * @param filter A filter to find matching contexts. A context matches if it matches all specified fields in the filter. Any unspecified field in the filter matches all contexts.
18257
18307
  * @param callback Invoked with the matching contexts, if any.
18258
- * @since Pending
18308
+ * @since Chrome 116
18259
18309
  * @chrome-min-manifest MV3
18260
18310
  */
18261
18311
  export function getContexts(
@@ -18916,7 +18966,7 @@ declare namespace chrome {
18916
18966
  }
18917
18967
 
18918
18968
  /**
18919
- * @since Pending
18969
+ * @since Chrome 116
18920
18970
  */
18921
18971
  export interface OpenOptions {
18922
18972
 
@@ -19023,7 +19073,7 @@ declare namespace chrome {
19023
19073
  * Opens the side panel for the extension. This may only be called in response to a user action.
19024
19074
  *
19025
19075
  * @param options Specifies the context in which to open the side panel.
19026
- * @since Pending
19076
+ * @since Chrome 116
19027
19077
  */
19028
19078
  export function open(
19029
19079
 
@@ -19035,7 +19085,7 @@ declare namespace chrome {
19035
19085
  *
19036
19086
  * @param options Specifies the context in which to open the side panel.
19037
19087
  * @param callback Called when the side panel has been opened.
19038
- * @since Pending
19088
+ * @since Chrome 116
19039
19089
  */
19040
19090
  export function open(
19041
19091
 
@@ -21652,7 +21702,7 @@ declare namespace chrome {
21652
21702
  /**
21653
21703
  * Returns a list of tabs that have requested capture or are being captured, i.e. status != stopped and status != error. This allows extensions to inform the user that there is an existing tab capture that would prevent a new tab capture from succeeding (or to prevent redundant requests for the same tab).
21654
21704
  *
21655
- * @chrome-returns-extra since Pending
21705
+ * @chrome-returns-extra since Chrome 116
21656
21706
  */
21657
21707
  export function getCapturedTabs(): Promise<CaptureInfo[]>;
21658
21708
 
@@ -21671,7 +21721,7 @@ declare namespace chrome {
21671
21721
  /**
21672
21722
  * Creates a stream ID to capture the target tab. Similar to chrome.tabCapture.capture() method, but returns a media stream ID, instead of a media stream, to the consumer tab.
21673
21723
  *
21674
- * @chrome-returns-extra since Pending
21724
+ * @chrome-returns-extra since Chrome 116
21675
21725
  * @since Chrome 71
21676
21726
  */
21677
21727
  export function getMediaStreamId(
@@ -25259,6 +25309,86 @@ declare namespace chrome {
25259
25309
  ): void;
25260
25310
  }
25261
25311
 
25312
+ /**
25313
+ * Use the `userScripts` API to execute user scripts in the User Scripts context.
25314
+ *
25315
+ * @alpha
25316
+ * @chrome-permission userScripts
25317
+ * @chrome-channel trunk
25318
+ * @chrome-min-manifest MV3
25319
+ */
25320
+ export namespace userScripts {
25321
+
25322
+ export interface ScriptSource {
25323
+
25324
+ /**
25325
+ * A string containing the JavaScript code to inject. Exactly one of `file` or `code` must be specified.
25326
+ */
25327
+ code?: string;
25328
+
25329
+ /**
25330
+ * The path of the JavaScript file to inject relative to the extension's root directory. Exactly one of `file` or `code` must be specified.
25331
+ */
25332
+ file?: string;
25333
+ }
25334
+
25335
+ export interface RegisteredUserScript {
25336
+
25337
+ /**
25338
+ * If true, it will inject into all frames, even if the frame is not the top-most frame in the tab. Each frame is checked independently for URL requirements; it will not inject into child frames if the URL requirements are not met. Defaults to false, meaning that only the top frame is matched.
25339
+ */
25340
+ allFrames?: boolean;
25341
+
25342
+ /**
25343
+ * Excludes pages that this content script would otherwise be injected into. See [Match Patterns](https://developer.chrome.com/docs/extensions/match_patterns) for more details on the syntax of these strings.
25344
+ */
25345
+ excludeMatches?: string[];
25346
+
25347
+ /**
25348
+ * The ID of the user script specified in the API call. This property must not start with a '\_' as it's reserved as a prefix for generated script IDs.
25349
+ */
25350
+ id: string;
25351
+
25352
+ /**
25353
+ * The list of ScriptSource objects defining sources of scripts to be injected into matching pages.
25354
+ */
25355
+ js: ScriptSource[];
25356
+
25357
+ /**
25358
+ * Specifies which pages this content script will be injected into. See [Match Patterns](https://developer.chrome.com/docs/extensions/match_patterns) for more details on the syntax of these strings.
25359
+ */
25360
+ matches?: string[];
25361
+
25362
+ /**
25363
+ * Specifies when JavaScript files are injected into the web page. The preferred and default value is `document_idle`.
25364
+ */
25365
+ runAt?: extensionTypes.RunAt;
25366
+ }
25367
+
25368
+ /**
25369
+ * Registers one or more user scripts for this extension.
25370
+ *
25371
+ * @param scripts Contains a list of user scripts to be registered.
25372
+ */
25373
+ export function register(
25374
+
25375
+ scripts: RegisteredUserScript[],
25376
+ ): Promise<void>;
25377
+
25378
+ /**
25379
+ * Registers one or more user scripts for this extension.
25380
+ *
25381
+ * @param scripts Contains a list of user scripts to be registered.
25382
+ * @param callback Called once scripts have been fully registered or if an error has ocurred.
25383
+ */
25384
+ export function register(
25385
+
25386
+ scripts: RegisteredUserScript[],
25387
+
25388
+ callback?: () => void,
25389
+ ): void;
25390
+ }
25391
+
25262
25392
  /**
25263
25393
  * The `chrome.virtualKeyboard` API is a kiosk only API used to configure virtual keyboard layout and behavior in kiosk sessions.
25264
25394
  *
@@ -28094,7 +28224,7 @@ declare namespace chrome {
28094
28224
  /**
28095
28225
  * Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.
28096
28226
  *
28097
- * @chrome-returns-extra since Pending
28227
+ * @chrome-returns-extra since Chrome 116
28098
28228
  */
28099
28229
  export function handlerBehaviorChanged(): Promise<void>;
28100
28230
 
package/package.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "type": "module",
6
6
  "name": "chrome-types",
7
7
  "config": {
8
- "build-hash": "33da048ef2f51094"
8
+ "build-hash": "c716e7b0ba2370ae"
9
9
  },
10
10
  "repository": {
11
11
  "type": "git",
@@ -16,5 +16,5 @@
16
16
  "url": "https://github.com/GoogleChrome/chrome-types/issues"
17
17
  },
18
18
  "homepage": "https://github.com/GoogleChrome/chrome-types",
19
- "version": "0.1.223"
19
+ "version": "0.1.225"
20
20
  }