@types/chrome 0.0.174 → 0.0.178

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. chrome/README.md +1 -1
  2. chrome/index.d.ts +79 -31
  3. chrome/package.json +2 -2
chrome/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Chrome extension development (http://
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Wed, 29 Dec 2021 14:31:25 GMT
11
+ * Last updated: Fri, 04 Feb 2022 03:31:26 GMT
12
12
  * Dependencies: [@types/filesystem](https://npmjs.com/package/@types/filesystem), [@types/har-format](https://npmjs.com/package/@types/har-format)
13
13
  * Global values: `chrome`
14
14
 
chrome/index.d.ts CHANGED
@@ -497,7 +497,7 @@ declare namespace chrome.bookmarks {
497
497
  * Since Chrome 37.
498
498
  * Indicates the reason why this node is unmodifiable. The managed value indicates that this node was configured by the system administrator or by the custodian of a supervised user. Omitted if the node can be modified by the user and the extension (default).
499
499
  */
500
- unmodifiable?: any;
500
+ unmodifiable?: 'managed' | undefined;
501
501
  }
502
502
 
503
503
  export interface BookmarkRemoveInfo {
@@ -796,7 +796,7 @@ declare namespace chrome.browserAction {
796
796
 
797
797
  export interface TabIconDetails {
798
798
  /** Optional. Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}' */
799
- path?: any;
799
+ path?: string | { [index: string]: string } | undefined;
800
800
  /** Optional. Limits the change to when a particular tab is selected. Automatically resets when the tab is closed. */
801
801
  tabId?: number | undefined;
802
802
  /** Optional. Either an ImageData object or a dictionary {size -> ImageData} representing icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.imageData = foo' is equivalent to 'details.imageData = {'19': foo}' */
@@ -952,10 +952,10 @@ declare namespace chrome.browserAction {
952
952
  */
953
953
  declare namespace chrome.browsingData {
954
954
  export interface OriginTypes {
955
- /** Optional. Websites that have been installed as hosted applications (be careful!). */
956
- protectedWeb?: boolean | undefined;
957
955
  /** Optional. Extensions and packaged applications a user has installed (be _really_ careful!). */
958
956
  extension?: boolean | undefined;
957
+ /** Optional. Websites that have been installed as hosted applications (be careful!). */
958
+ protectedWeb?: boolean | undefined;
959
959
  /** Optional. Normal websites. */
960
960
  unprotectedWeb?: boolean | undefined;
961
961
  }
@@ -964,11 +964,25 @@ declare namespace chrome.browsingData {
964
964
  export interface RemovalOptions {
965
965
  /**
966
966
  * Optional.
967
- * Since Chrome 21.
968
- * An object whose properties specify which origin types ought to be cleared. If this object isn't specified, it defaults to clearing only "unprotected" origins. Please ensure that you really want to remove application data before adding 'protectedWeb' or 'extensions'.
967
+ * Since Chrome 74.
968
+ * When present, data for origins in this list is excluded from deletion. Can't be used together with origins. Only supported for cookies, storage and cache. Cookies are excluded for the whole registrable domain.
969
+ */
970
+ excludeOrigins?: string[] | undefined;
971
+ /**
972
+ * Optional.
973
+ * An object whose properties specify which origin types ought to be cleared. If this object isn't specified, it defaults to clearing only "unprotected" origins. Please ensure that you _really_ want to remove application data before adding 'protectedWeb' or 'extensions'.
969
974
  */
970
975
  originTypes?: OriginTypes | undefined;
971
- /** Optional. Remove data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the getTime method of the JavaScript Date object). If absent, defaults to 0 (which would remove all browsing data). */
976
+ /**
977
+ * Optional.
978
+ * Since Chrome 74.
979
+ * When present, only data for origins in this list is deleted. Only supported for cookies, storage and cache. Cookies are cleared for the whole registrable domain.
980
+ */
981
+ origins?: string[] | undefined;
982
+ /**
983
+ * Optional.
984
+ * Remove data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the {@link Date.getTime} method). If absent, defaults to 0 (which would remove all browsing data).
985
+ */
972
986
  since?: number | undefined;
973
987
  }
974
988
 
@@ -985,7 +999,12 @@ declare namespace chrome.browsingData {
985
999
  cookies?: boolean | undefined;
986
1000
  /** Optional. Stored passwords. */
987
1001
  passwords?: boolean | undefined;
988
- /** Optional. Server-bound certificates. */
1002
+ /**
1003
+ * @deprecated Deprecated since Chrome 76.
1004
+ * Support for server-bound certificates has been removed. This data type will be ignored.
1005
+ *
1006
+ * Optional. Server-bound certificates.
1007
+ */
989
1008
  serverBoundCertificates?: boolean | undefined;
990
1009
  /** Optional. The browser's download list. */
991
1010
  downloads?: boolean | undefined;
@@ -995,7 +1014,12 @@ declare namespace chrome.browsingData {
995
1014
  appcache?: boolean | undefined;
996
1015
  /** Optional. Websites' file systems. */
997
1016
  fileSystems?: boolean | undefined;
998
- /** Optional. Plugins' data. */
1017
+ /**
1018
+ * @deprecated Deprecated since Chrome 88.
1019
+ * Support for Flash has been removed. This data type will be ignored.
1020
+ *
1021
+ * Optional. Plugins' data.
1022
+ */
999
1023
  pluginData?: boolean | undefined;
1000
1024
  /** Optional. Websites' local storage data. */
1001
1025
  localStorage?: boolean | undefined;
@@ -1027,12 +1051,23 @@ declare namespace chrome.browsingData {
1027
1051
  */
1028
1052
  export function settings(callback: (result: SettingsCallback) => void): void;
1029
1053
  /**
1054
+ * @deprecated Deprecated since Chrome 88.
1055
+ * Support for Flash has been removed. This function has no effect.
1056
+ *
1030
1057
  * Clears plugins' data.
1031
1058
  * @param callback Called when plugins' data has been cleared.
1032
1059
  * If you specify the callback parameter, it should be a function that looks like this:
1033
1060
  * function() {...};
1034
1061
  */
1035
1062
  export function removePluginData(options: RemovalOptions, callback?: () => void): void;
1063
+ /**
1064
+ * Since Chrome 72.
1065
+ * Clears websites' service workers.
1066
+ * @param callback Called when the browser's service workers have been cleared.
1067
+ * If you specify the callback parameter, it should be a function that looks like this:
1068
+ * function() {...};
1069
+ */
1070
+ export function removeServiceWorkers(options: RemovalOptions, callback?: () => void): void;
1036
1071
  /**
1037
1072
  * Clears the browser's stored form data (autofill).
1038
1073
  * @param callback Called when the browser's form data has been cleared.
@@ -1174,11 +1209,13 @@ declare namespace chrome.contentSettings {
1174
1209
  scope?: ScopeEnum | undefined;
1175
1210
  }
1176
1211
 
1212
+ type DefaultContentSettingDetails = 'allow' | 'ask' | 'block' | 'detect_important_content' | 'session_only';
1213
+
1177
1214
  export interface SetDetails {
1178
1215
  /** Optional. The resource identifier for the content type. */
1179
1216
  resourceIdentifier?: ResourceIdentifier | undefined;
1180
1217
  /** The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values. */
1181
- setting: any;
1218
+ setting: DefaultContentSettingDetails;
1182
1219
  /** Optional. The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see Content Setting Patterns. */
1183
1220
  secondaryPattern?: string | undefined;
1184
1221
  /** Optional. Where to set the setting (default: regular). */
@@ -1252,7 +1289,7 @@ declare namespace chrome.contentSettings {
1252
1289
 
1253
1290
  export interface ReturnedDetails {
1254
1291
  /** The content setting. See the description of the individual ContentSetting objects for the possible values. */
1255
- setting: any;
1292
+ setting: DefaultContentSettingDetails;
1256
1293
  }
1257
1294
 
1258
1295
  export interface ContentSetting {
@@ -1284,54 +1321,67 @@ declare namespace chrome.contentSettings {
1284
1321
 
1285
1322
  export interface CookieContentSetting extends ContentSetting {
1286
1323
  set(details: CookieSetDetails, callback?: () => void): void;
1324
+ get(details: GetDetails, callback: (details: CookieSetDetails) => void): void;
1287
1325
  }
1288
1326
 
1289
1327
  export interface PopupsContentSetting extends ContentSetting {
1290
1328
  set(details: PopupsSetDetails, callback?: () => void): void;
1329
+ get(details: GetDetails, callback: (details: PopupsSetDetails) => void): void;
1291
1330
  }
1292
1331
 
1293
1332
  export interface JavascriptContentSetting extends ContentSetting {
1294
1333
  set(details: JavascriptSetDetails, callback?: () => void): void;
1334
+ get(details: GetDetails, callback: (details: JavascriptSetDetails) => void): void;
1295
1335
  }
1296
1336
 
1297
1337
  export interface NotificationsContentSetting extends ContentSetting {
1298
1338
  set(details: NotificationsSetDetails, callback?: () => void): void;
1339
+ get(details: GetDetails, callback: (details: NotificationsSetDetails) => void): void;
1299
1340
  }
1300
1341
 
1301
1342
  export interface PluginsContentSetting extends ContentSetting {
1302
1343
  set(details: PluginsSetDetails, callback?: () => void): void;
1344
+ get(details: GetDetails, callback: (details: PluginsSetDetails) => void): void;
1303
1345
  }
1304
1346
 
1305
1347
  export interface ImagesContentSetting extends ContentSetting {
1306
1348
  set(details: ImagesSetDetails, callback?: () => void): void;
1349
+ get(details: GetDetails, callback: (details: ImagesSetDetails) => void): void;
1307
1350
  }
1308
1351
 
1309
1352
  export interface LocationContentSetting extends ContentSetting {
1310
1353
  set(details: LocationSetDetails, callback?: () => void): void;
1354
+ get(details: GetDetails, callback: (details: LocationSetDetails) => void): void;
1311
1355
  }
1312
1356
 
1313
1357
  export interface FullscreenContentSetting extends ContentSetting {
1314
1358
  set(details: FullscreenSetDetails, callback?: () => void): void;
1359
+ get(details: GetDetails, callback: (details: FullscreenSetDetails) => void): void;
1315
1360
  }
1316
1361
 
1317
1362
  export interface MouselockContentSetting extends ContentSetting {
1318
1363
  set(details: MouselockSetDetails, callback?: () => void): void;
1364
+ get(details: GetDetails, callback: (details: MouselockSetDetails) => void): void;
1319
1365
  }
1320
1366
 
1321
1367
  export interface MicrophoneContentSetting extends ContentSetting {
1322
1368
  set(details: MicrophoneSetDetails, callback?: () => void): void;
1369
+ get(details: GetDetails, callback: (details: MicrophoneSetDetails) => void): void;
1323
1370
  }
1324
1371
 
1325
1372
  export interface CameraContentSetting extends ContentSetting {
1326
1373
  set(details: CameraSetDetails, callback?: () => void): void;
1374
+ get(details: GetDetails, callback: (details: CameraSetDetails) => void): void;
1327
1375
  }
1328
1376
 
1329
1377
  export interface PpapiBrokerContentSetting extends ContentSetting {
1330
1378
  set(details: PpapiBrokerSetDetails, callback?: () => void): void;
1379
+ get(details: GetDetails, callback: (details: PpapiBrokerSetDetails) => void): void;
1331
1380
  }
1332
1381
 
1333
1382
  export interface MultipleAutomaticDownloadsContentSetting extends ContentSetting {
1334
1383
  set(details: MultipleAutomaticDownloadsSetDetails, callback?: () => void): void;
1384
+ get(details: GetDetails, callback: (details: MultipleAutomaticDownloadsSetDetails) => void): void;
1335
1385
  }
1336
1386
 
1337
1387
  /** The only content type using resource identifiers is contentSettings.plugins. For more information, see Resource Identifiers. */
@@ -1577,7 +1627,7 @@ declare namespace chrome.contextMenus {
1577
1627
  */
1578
1628
  onclick?: ((info: OnClickData, tab: chrome.tabs.Tab) => void) | undefined;
1579
1629
  /** Optional. The ID of a parent menu item; this makes the item a child of a previously added item. */
1580
- parentId?: any;
1630
+ parentId?: number | string | undefined;
1581
1631
  /** Optional. The type of menu item. Defaults to 'normal' if not specified. */
1582
1632
  type?: ContextItemType | undefined;
1583
1633
  /**
@@ -2075,11 +2125,11 @@ declare namespace chrome.declarativeContent {
2075
2125
  declare namespace chrome.declarativeWebRequest {
2076
2126
  export interface HeaderFilter {
2077
2127
  nameEquals?: string | undefined;
2078
- valueContains?: any;
2128
+ valueContains?: string | string[] | undefined;
2079
2129
  nameSuffix?: string | undefined;
2080
2130
  valueSuffix?: string | undefined;
2081
2131
  valuePrefix?: string | undefined;
2082
- nameContains?: any;
2132
+ nameContains?: string | string[] | undefined;
2083
2133
  valueEquals?: string | undefined;
2084
2134
  namePrefix?: string | undefined;
2085
2135
  }
@@ -3183,7 +3233,7 @@ declare namespace chrome.events {
3183
3233
  /** Optional. Matches if the URL (without fragment identifier) ends with a specified string. Port numbers are stripped from the URL if they match the default port number. */
3184
3234
  urlSuffix?: string | undefined;
3185
3235
  /** Optional. Matches if the port of the URL is contained in any of the specified port lists. For example [80, 443, [1000, 1200]] matches all requests on port 80, 443 and in the range 1000-1200. */
3186
- ports?: any[] | undefined;
3236
+ ports?: (number | number[])[] | undefined;
3187
3237
  /**
3188
3238
  * Optional.
3189
3239
  * Since Chrome 28.
@@ -4285,7 +4335,7 @@ declare namespace chrome.i18n {
4285
4335
  * @param messageName The name of the message, as specified in the messages.json file.
4286
4336
  * @param substitutions Optional. Up to 9 substitution strings, if the message requires any.
4287
4337
  */
4288
- export function getMessage(messageName: string, substitutions?: any): string;
4338
+ export function getMessage(messageName: string, substitutions?: string | string[]): string;
4289
4339
  /**
4290
4340
  * Gets the browser UI language of the browser. This is different from i18n.getAcceptLanguages which returns the preferred user languages.
4291
4341
  * @since Chrome 35.
@@ -5699,7 +5749,7 @@ declare namespace chrome.pageAction {
5699
5749
  * Optional.
5700
5750
  * Either a relative image path or a dictionary {size -> relative image path} pointing to icon to be set. If the icon is specified as a dictionary, the actual image to be used is chosen depending on screen's pixel density. If the number of image pixels that fit into one screen space unit equals scale, then image with size scale * 19 will be selected. Initially only scales 1 and 2 will be supported. At least one image must be specified. Note that 'details.path = foo' is equivalent to 'details.imageData = {'19': foo}'
5701
5751
  */
5702
- path?: any;
5752
+ path?: string | { [index: string]: string } | undefined;
5703
5753
  }
5704
5754
 
5705
5755
  /**
@@ -5770,7 +5820,7 @@ declare namespace chrome.pageCapture {
5770
5820
  * function(binary mhtmlData) {...};
5771
5821
  * Parameter mhtmlData: The MHTML data as a Blob.
5772
5822
  */
5773
- export function saveAsMHTML(details: SaveDetails, callback: (mhtmlData: any) => void): void;
5823
+ export function saveAsMHTML(details: SaveDetails, callback: (mhtmlData?: Blob) => void): void;
5774
5824
  }
5775
5825
 
5776
5826
  ////////////////////
@@ -6762,8 +6812,7 @@ declare namespace chrome.runtime {
6762
6812
  icons?: ManifestIcons | undefined;
6763
6813
 
6764
6814
  // Optional
6765
- author?: any;
6766
- automation?: any;
6815
+ author?: string | undefined;
6767
6816
  background_page?: string | undefined;
6768
6817
  chrome_settings_overrides?: {
6769
6818
  homepage?: string | undefined;
@@ -6810,7 +6859,6 @@ declare namespace chrome.runtime {
6810
6859
  exclude_globs?: string[] | undefined;
6811
6860
  }[] | undefined;
6812
6861
  converted_from_user_script?: boolean | undefined;
6813
- copresence?: any;
6814
6862
  current_locale?: string | undefined;
6815
6863
  devtools_page?: string | undefined;
6816
6864
  event_rules?: {
@@ -6851,7 +6899,7 @@ declare namespace chrome.runtime {
6851
6899
  id?: string | undefined;
6852
6900
  description?: string | undefined;
6853
6901
  language?: string | undefined;
6854
- layouts?: any[] | undefined;
6902
+ layouts?: string[] | undefined;
6855
6903
  }[] | undefined;
6856
6904
  key?: string | undefined;
6857
6905
  minimum_chrome_version?: string | undefined;
@@ -6893,7 +6941,6 @@ declare namespace chrome.runtime {
6893
6941
  content_security_policy?: string | undefined;
6894
6942
  } | undefined;
6895
6943
  short_name?: string | undefined;
6896
- signature?: any;
6897
6944
  spellcheck?: {
6898
6945
  dictionary_language?: string | undefined;
6899
6946
  dictionary_locale?: string | undefined;
@@ -6903,7 +6950,6 @@ declare namespace chrome.runtime {
6903
6950
  storage?: {
6904
6951
  managed_schema: string;
6905
6952
  } | undefined;
6906
- system_indicator?: any;
6907
6953
  tts_engine?: {
6908
6954
  voices: {
6909
6955
  voice_name: string;
@@ -9835,6 +9881,8 @@ declare namespace chrome.ttsEngine {
9835
9881
  * @since Chrome 13.
9836
9882
  */
9837
9883
  declare namespace chrome.types {
9884
+ type settingsScope = 'regular' | 'regular_only' | 'incognito_persistent' | 'incognito_session_only' | undefined;
9885
+
9838
9886
  export interface ChromeSettingClearDetails {
9839
9887
  /**
9840
9888
  * Optional.
@@ -9844,7 +9892,7 @@ declare namespace chrome.types {
9844
9892
  * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
9845
9893
  * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
9846
9894
  */
9847
- scope?: string | undefined;
9895
+ scope?: settingsScope;
9848
9896
  }
9849
9897
 
9850
9898
  export interface ChromeSettingSetDetails extends ChromeSettingClearDetails {
@@ -9861,7 +9909,7 @@ declare namespace chrome.types {
9861
9909
  * • incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
9862
9910
  * • incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences).
9863
9911
  */
9864
- scope?: string | undefined;
9912
+ scope?: settingsScope;
9865
9913
  }
9866
9914
 
9867
9915
  export interface ChromeSettingGetDetails {
@@ -9882,7 +9930,7 @@ declare namespace chrome.types {
9882
9930
  * • controllable_by_this_extension: can be controlled by this extension
9883
9931
  * • controlled_by_this_extension: controlled by this extension
9884
9932
  */
9885
- levelOfControl: string;
9933
+ levelOfControl: 'not_controllable' | 'controlled_by_other_extensions' | 'controllable_by_this_extension' | 'controlled_by_this_extension';
9886
9934
  /** The value of the setting. */
9887
9935
  value: any;
9888
9936
  /**
@@ -10020,14 +10068,14 @@ declare namespace chrome.vpnProvider {
10020
10068
  declare namespace chrome.wallpaper {
10021
10069
  export interface WallpaperDetails {
10022
10070
  /** Optional. The jpeg or png encoded wallpaper image. */
10023
- data?: any;
10071
+ data?: ArrayBuffer | undefined;
10024
10072
  /** Optional. The URL of the wallpaper to be set. */
10025
10073
  url?: string | undefined;
10026
10074
  /**
10027
10075
  * The supported wallpaper layouts.
10028
10076
  * One of: "STRETCH", "CENTER", or "CENTER_CROPPED"
10029
10077
  */
10030
- layout: string;
10078
+ layout: 'STRETCH' | 'CENTER' | 'CENTER_CROPPED';
10031
10079
  /** The file name of the saved wallpaper. */
10032
10080
  filename: string;
10033
10081
  /** Optional. True if a 128x60 thumbnail should be generated. */
@@ -10039,7 +10087,7 @@ declare namespace chrome.wallpaper {
10039
10087
  * @param callback
10040
10088
  * Optional parameter thumbnail: The jpeg encoded wallpaper thumbnail. It is generated by resizing the wallpaper to 128x60.
10041
10089
  */
10042
- export function setWallpaper(details: WallpaperDetails, callback: (thumbnail: any) => void): void;
10090
+ export function setWallpaper(details: WallpaperDetails, callback: (thumbnail?: ArrayBuffer) => void): void;
10043
10091
  }
10044
10092
 
10045
10093
  ////////////////////
@@ -11210,7 +11258,7 @@ declare namespace chrome.declarativeNetRequest {
11210
11258
  * An ID of {@link chrome.tabs.TAB_ID_NONE} excludes requests which don't originate from a tab.
11211
11259
  * An empty list is not allowed. Only supported for session-scoped rules.
11212
11260
  */
11213
- tabIds?: number | undefined;
11261
+ tabIds?: number[] | undefined;
11214
11262
 
11215
11263
  /**
11216
11264
  * The pattern which is matched against the network request url.
chrome/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/chrome",
3
- "version": "0.0.174",
3
+ "version": "0.0.178",
4
4
  "description": "TypeScript definitions for Chrome extension development",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/chrome",
6
6
  "license": "MIT",
@@ -98,6 +98,6 @@
98
98
  "@types/filesystem": "*",
99
99
  "@types/har-format": "*"
100
100
  },
101
- "typesPublisherContentHash": "e556bbb8979fd7158aac7a70b91a206832698ccce08a8c72a5792d9b417ab06b",
101
+ "typesPublisherContentHash": "986bc801af162f902f7b811c231291ad71cc9e87873ffc738f31228ec34616f1",
102
102
  "typeScriptVersion": "3.8"
103
103
  }