devtools-protocol 0.0.1317765 → 0.0.1319565

Sign up to get free protection for your applications and to get access to all the features.
@@ -26244,6 +26244,15 @@
26244
26244
  "type": "string"
26245
26245
  }
26246
26246
  ]
26247
+ },
26248
+ {
26249
+ "id": "DisplayMode",
26250
+ "description": "If user prefers opening the app in browser or an app window.",
26251
+ "type": "string",
26252
+ "enum": [
26253
+ "standalone",
26254
+ "browser"
26255
+ ]
26247
26256
  }
26248
26257
  ],
26249
26258
  "commands": [
@@ -26289,7 +26298,7 @@
26289
26298
  },
26290
26299
  {
26291
26300
  "name": "uninstall",
26292
- "description": "Uninstals the given manifest_id and closes any opened app windows.",
26301
+ "description": "Uninstalls the given manifest_id and closes any opened app windows.",
26293
26302
  "parameters": [
26294
26303
  {
26295
26304
  "name": "manifestId",
@@ -26321,7 +26330,7 @@
26321
26330
  },
26322
26331
  {
26323
26332
  "name": "launchFilesInApp",
26324
- "description": "Opens one or more local files from an installed web app identified by its\nmanifestId. The web app needs to have file handlers registered to process\nthe files. The API returns one or more page Target.TargetIDs which can be\nused to attach to via Target.attachToTarget or similar APIs.\nIf some files in the parameters cannot be handled by the web app, they will\nbe ignored. If none of the files can be handled, this API returns an error.\nIf no files provided as the parameter, this API also returns an error.\n\nAccording to the definition of the file handlers in the manifest file, one\nTarget.TargetID may represent a page handling one or more files. The order\nof the returned Target.TargetIDs is not guaranteed.\n\nTODO(crbug.com/339454034): Check the existences of the input files.",
26333
+ "description": "Opens one or more local files from an installed web app identified by its\nmanifestId. The web app needs to have file handlers registered to process\nthe files. The API returns one or more page Target.TargetIDs which can be\nused to attach to via Target.attachToTarget or similar APIs.\nIf some files in the parameters cannot be handled by the web app, they will\nbe ignored. If none of the files can be handled, this API returns an error.\nIf no files are provided as the parameter, this API also returns an error.\n\nAccording to the definition of the file handlers in the manifest file, one\nTarget.TargetID may represent a page handling one or more files. The order\nof the returned Target.TargetIDs is not guaranteed.\n\nTODO(crbug.com/339454034): Check the existences of the input files.",
26325
26334
  "parameters": [
26326
26335
  {
26327
26336
  "name": "manifestId",
@@ -26348,11 +26357,32 @@
26348
26357
  },
26349
26358
  {
26350
26359
  "name": "openCurrentPageInApp",
26351
- "description": "Opens the current page in its web app identified by the manifest id, needs\nto be called on a page target. This function returns immediately without\nwaiting for the app finishing loading.",
26360
+ "description": "Opens the current page in its web app identified by the manifest id, needs\nto be called on a page target. This function returns immediately without\nwaiting for the app to finish loading.",
26361
+ "parameters": [
26362
+ {
26363
+ "name": "manifestId",
26364
+ "type": "string"
26365
+ }
26366
+ ]
26367
+ },
26368
+ {
26369
+ "name": "changeAppUserSettings",
26370
+ "description": "Changes user settings of the web app identified by its manifestId. If the\napp was not installed, this command returns an error. Unset parameters will\nbe ignored; unrecognized values will cause an error.\n\nUnlike the ones defined in the manifest files of the web apps, these\nsettings are provided by the browser and controlled by the users, they\nimpact the way the browser handling the web apps.\n\nSee the comment of each parameter.",
26352
26371
  "parameters": [
26353
26372
  {
26354
26373
  "name": "manifestId",
26355
26374
  "type": "string"
26375
+ },
26376
+ {
26377
+ "name": "linkCapturing",
26378
+ "description": "If user allows the links clicked on by the user in the app's scope, or\nextended scope if the manifest has scope extensions and the flags\n`DesktopPWAsLinkCapturingWithScopeExtensions` and\n`WebAppEnableScopeExtensions` are enabled.\n\nNote, the API does not support resetting the linkCapturing to the\ninitial value, uninstalling and installing the web app again will reset\nit.\n\nTODO(crbug.com/339453269): Setting this value on ChromeOS is not\nsupported yet.",
26379
+ "optional": true,
26380
+ "type": "boolean"
26381
+ },
26382
+ {
26383
+ "name": "displayMode",
26384
+ "optional": true,
26385
+ "$ref": "DisplayMode"
26356
26386
  }
26357
26387
  ]
26358
26388
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "devtools-protocol",
3
- "version": "0.0.1317765",
3
+ "version": "0.0.1319565",
4
4
  "description": "The Chrome DevTools Protocol JSON",
5
5
  "repository": "https://github.com/ChromeDevTools/devtools-protocol",
6
6
  "author": "The Chromium Authors",
@@ -12426,7 +12426,7 @@ experimental domain PWA
12426
12426
  # manifestId.
12427
12427
  optional string installUrlOrBundleUrl
12428
12428
 
12429
- # Uninstals the given manifest_id and closes any opened app windows.
12429
+ # Uninstalls the given manifest_id and closes any opened app windows.
12430
12430
  command uninstall
12431
12431
  parameters
12432
12432
  string manifestId
@@ -12448,7 +12448,7 @@ experimental domain PWA
12448
12448
  # used to attach to via Target.attachToTarget or similar APIs.
12449
12449
  # If some files in the parameters cannot be handled by the web app, they will
12450
12450
  # be ignored. If none of the files can be handled, this API returns an error.
12451
- # If no files provided as the parameter, this API also returns an error.
12451
+ # If no files are provided as the parameter, this API also returns an error.
12452
12452
  #
12453
12453
  # According to the definition of the file handlers in the manifest file, one
12454
12454
  # Target.TargetID may represent a page handling one or more files. The order
@@ -12465,7 +12465,39 @@ experimental domain PWA
12465
12465
 
12466
12466
  # Opens the current page in its web app identified by the manifest id, needs
12467
12467
  # to be called on a page target. This function returns immediately without
12468
- # waiting for the app finishing loading.
12468
+ # waiting for the app to finish loading.
12469
12469
  command openCurrentPageInApp
12470
12470
  parameters
12471
12471
  string manifestId
12472
+
12473
+ # If user prefers opening the app in browser or an app window.
12474
+ type DisplayMode extends string
12475
+ enum
12476
+ standalone
12477
+ browser
12478
+
12479
+ # Changes user settings of the web app identified by its manifestId. If the
12480
+ # app was not installed, this command returns an error. Unset parameters will
12481
+ # be ignored; unrecognized values will cause an error.
12482
+ #
12483
+ # Unlike the ones defined in the manifest files of the web apps, these
12484
+ # settings are provided by the browser and controlled by the users, they
12485
+ # impact the way the browser handling the web apps.
12486
+ #
12487
+ # See the comment of each parameter.
12488
+ command changeAppUserSettings
12489
+ parameters
12490
+ string manifestId
12491
+ # If user allows the links clicked on by the user in the app's scope, or
12492
+ # extended scope if the manifest has scope extensions and the flags
12493
+ # `DesktopPWAsLinkCapturingWithScopeExtensions` and
12494
+ # `WebAppEnableScopeExtensions` are enabled.
12495
+ #
12496
+ # Note, the API does not support resetting the linkCapturing to the
12497
+ # initial value, uninstalling and installing the web app again will reset
12498
+ # it.
12499
+ #
12500
+ # TODO(crbug.com/339453269): Setting this value on ChromeOS is not
12501
+ # supported yet.
12502
+ optional boolean linkCapturing
12503
+ optional DisplayMode displayMode
@@ -4988,7 +4988,7 @@ export namespace ProtocolMapping {
4988
4988
  returnType: void;
4989
4989
  };
4990
4990
  /**
4991
- * Uninstals the given manifest_id and closes any opened app windows.
4991
+ * Uninstalls the given manifest_id and closes any opened app windows.
4992
4992
  */
4993
4993
  'PWA.uninstall': {
4994
4994
  paramsType: [Protocol.PWA.UninstallRequest];
@@ -5010,7 +5010,7 @@ export namespace ProtocolMapping {
5010
5010
  * used to attach to via Target.attachToTarget or similar APIs.
5011
5011
  * If some files in the parameters cannot be handled by the web app, they will
5012
5012
  * be ignored. If none of the files can be handled, this API returns an error.
5013
- * If no files provided as the parameter, this API also returns an error.
5013
+ * If no files are provided as the parameter, this API also returns an error.
5014
5014
  *
5015
5015
  * According to the definition of the file handlers in the manifest file, one
5016
5016
  * Target.TargetID may represent a page handling one or more files. The order
@@ -5025,12 +5025,27 @@ export namespace ProtocolMapping {
5025
5025
  /**
5026
5026
  * Opens the current page in its web app identified by the manifest id, needs
5027
5027
  * to be called on a page target. This function returns immediately without
5028
- * waiting for the app finishing loading.
5028
+ * waiting for the app to finish loading.
5029
5029
  */
5030
5030
  'PWA.openCurrentPageInApp': {
5031
5031
  paramsType: [Protocol.PWA.OpenCurrentPageInAppRequest];
5032
5032
  returnType: void;
5033
5033
  };
5034
+ /**
5035
+ * Changes user settings of the web app identified by its manifestId. If the
5036
+ * app was not installed, this command returns an error. Unset parameters will
5037
+ * be ignored; unrecognized values will cause an error.
5038
+ *
5039
+ * Unlike the ones defined in the manifest files of the web apps, these
5040
+ * settings are provided by the browser and controlled by the users, they
5041
+ * impact the way the browser handling the web apps.
5042
+ *
5043
+ * See the comment of each parameter.
5044
+ */
5045
+ 'PWA.changeAppUserSettings': {
5046
+ paramsType: [Protocol.PWA.ChangeAppUserSettingsRequest];
5047
+ returnType: void;
5048
+ };
5034
5049
  }
5035
5050
  }
5036
5051
 
@@ -4260,7 +4260,7 @@ export namespace ProtocolProxyApi {
4260
4260
  install(params: Protocol.PWA.InstallRequest): Promise<void>;
4261
4261
 
4262
4262
  /**
4263
- * Uninstals the given manifest_id and closes any opened app windows.
4263
+ * Uninstalls the given manifest_id and closes any opened app windows.
4264
4264
  */
4265
4265
  uninstall(params: Protocol.PWA.UninstallRequest): Promise<void>;
4266
4266
 
@@ -4278,7 +4278,7 @@ export namespace ProtocolProxyApi {
4278
4278
  * used to attach to via Target.attachToTarget or similar APIs.
4279
4279
  * If some files in the parameters cannot be handled by the web app, they will
4280
4280
  * be ignored. If none of the files can be handled, this API returns an error.
4281
- * If no files provided as the parameter, this API also returns an error.
4281
+ * If no files are provided as the parameter, this API also returns an error.
4282
4282
  *
4283
4283
  * According to the definition of the file handlers in the manifest file, one
4284
4284
  * Target.TargetID may represent a page handling one or more files. The order
@@ -4291,10 +4291,23 @@ export namespace ProtocolProxyApi {
4291
4291
  /**
4292
4292
  * Opens the current page in its web app identified by the manifest id, needs
4293
4293
  * to be called on a page target. This function returns immediately without
4294
- * waiting for the app finishing loading.
4294
+ * waiting for the app to finish loading.
4295
4295
  */
4296
4296
  openCurrentPageInApp(params: Protocol.PWA.OpenCurrentPageInAppRequest): Promise<void>;
4297
4297
 
4298
+ /**
4299
+ * Changes user settings of the web app identified by its manifestId. If the
4300
+ * app was not installed, this command returns an error. Unset parameters will
4301
+ * be ignored; unrecognized values will cause an error.
4302
+ *
4303
+ * Unlike the ones defined in the manifest files of the web apps, these
4304
+ * settings are provided by the browser and controlled by the users, they
4305
+ * impact the way the browser handling the web apps.
4306
+ *
4307
+ * See the comment of each parameter.
4308
+ */
4309
+ changeAppUserSettings(params: Protocol.PWA.ChangeAppUserSettingsRequest): Promise<void>;
4310
+
4298
4311
  }
4299
4312
  }
4300
4313
 
@@ -4646,7 +4646,7 @@ export namespace ProtocolTestsProxyApi {
4646
4646
  install(params: Protocol.PWA.InstallRequest): Promise<{id: number, result: void, sessionId: string}>;
4647
4647
 
4648
4648
  /**
4649
- * Uninstals the given manifest_id and closes any opened app windows.
4649
+ * Uninstalls the given manifest_id and closes any opened app windows.
4650
4650
  */
4651
4651
  uninstall(params: Protocol.PWA.UninstallRequest): Promise<{id: number, result: void, sessionId: string}>;
4652
4652
 
@@ -4664,7 +4664,7 @@ export namespace ProtocolTestsProxyApi {
4664
4664
  * used to attach to via Target.attachToTarget or similar APIs.
4665
4665
  * If some files in the parameters cannot be handled by the web app, they will
4666
4666
  * be ignored. If none of the files can be handled, this API returns an error.
4667
- * If no files provided as the parameter, this API also returns an error.
4667
+ * If no files are provided as the parameter, this API also returns an error.
4668
4668
  *
4669
4669
  * According to the definition of the file handlers in the manifest file, one
4670
4670
  * Target.TargetID may represent a page handling one or more files. The order
@@ -4677,10 +4677,23 @@ export namespace ProtocolTestsProxyApi {
4677
4677
  /**
4678
4678
  * Opens the current page in its web app identified by the manifest id, needs
4679
4679
  * to be called on a page target. This function returns immediately without
4680
- * waiting for the app finishing loading.
4680
+ * waiting for the app to finish loading.
4681
4681
  */
4682
4682
  openCurrentPageInApp(params: Protocol.PWA.OpenCurrentPageInAppRequest): Promise<{id: number, result: void, sessionId: string}>;
4683
4683
 
4684
+ /**
4685
+ * Changes user settings of the web app identified by its manifestId. If the
4686
+ * app was not installed, this command returns an error. Unset parameters will
4687
+ * be ignored; unrecognized values will cause an error.
4688
+ *
4689
+ * Unlike the ones defined in the manifest files of the web apps, these
4690
+ * settings are provided by the browser and controlled by the users, they
4691
+ * impact the way the browser handling the web apps.
4692
+ *
4693
+ * See the comment of each parameter.
4694
+ */
4695
+ changeAppUserSettings(params: Protocol.PWA.ChangeAppUserSettingsRequest): Promise<{id: number, result: void, sessionId: string}>;
4696
+
4684
4697
  }
4685
4698
  }
4686
4699
 
@@ -18567,6 +18567,11 @@ export namespace Protocol {
18567
18567
  displayName: string;
18568
18568
  }
18569
18569
 
18570
+ /**
18571
+ * If user prefers opening the app in browser or an app window.
18572
+ */
18573
+ export type DisplayMode = ('standalone' | 'browser');
18574
+
18570
18575
  export interface GetOsAppStateRequest {
18571
18576
  /**
18572
18577
  * The id from the webapp's manifest file, commonly it's the url of the
@@ -18621,6 +18626,25 @@ export namespace Protocol {
18621
18626
  export interface OpenCurrentPageInAppRequest {
18622
18627
  manifestId: string;
18623
18628
  }
18629
+
18630
+ export interface ChangeAppUserSettingsRequest {
18631
+ manifestId: string;
18632
+ /**
18633
+ * If user allows the links clicked on by the user in the app's scope, or
18634
+ * extended scope if the manifest has scope extensions and the flags
18635
+ * `DesktopPWAsLinkCapturingWithScopeExtensions` and
18636
+ * `WebAppEnableScopeExtensions` are enabled.
18637
+ *
18638
+ * Note, the API does not support resetting the linkCapturing to the
18639
+ * initial value, uninstalling and installing the web app again will reset
18640
+ * it.
18641
+ *
18642
+ * TODO(crbug.com/339453269): Setting this value on ChromeOS is not
18643
+ * supported yet.
18644
+ */
18645
+ linkCapturing?: boolean;
18646
+ displayMode?: DisplayMode;
18647
+ }
18624
18648
  }
18625
18649
  }
18626
18650