Merge pull request #639 from Microsoft/ClipboardEventInit-try-2

Add Clipboard Interfaces to idlSources

Author: sandersn

baselines/dom.generated.d.ts

@@ -183,6 +183,10 @@ interface ClientQueryOptions {
     type?: ClientTypes;
 }
 
+interface ClipboardEventInit extends EventInit {
+    clipboardData?: DataTransfer | null;
+}
+
 interface CloseEventInit extends EventInit {
     code?: number;
     reason?: string;
@@ -3260,21 +3264,26 @@ declare var ClientRectList: {
     new(): ClientRectList;
 };
 
+interface Clipboard extends EventTarget {
+    readText(): Promise<string>;
+    writeText(data: string): Promise<void>;
+}
+
+declare var Clipboard: {
+    prototype: Clipboard;
+    new(): Clipboard;
+};
+
 /** The ClipboardEvent interface represents events providing information related to modification of the clipboard, that is cut, copy, and paste events. */
 interface ClipboardEvent extends Event {
-    readonly clipboardData: DataTransfer;
+    readonly clipboardData: DataTransfer | null;
 }
 
 declare var ClipboardEvent: {
     prototype: ClipboardEvent;
     new(type: string, eventInitDict?: ClipboardEventInit): ClipboardEvent;
 };
 
-interface ClipboardEventInit extends EventInit {
-    data?: string;
-    dataType?: string;
-}
-
 /** A CloseEvent is sent to clients using WebSockets when the connection is closed. This is delivered to the listener indicated by the WebSocket object's onclose attribute. */
 interface CloseEvent extends Event {
     readonly code: number;
@@ -10494,6 +10503,7 @@ declare var NavigationPreloadManager: {
 interface Navigator extends NavigatorID, NavigatorOnLine, NavigatorContentUtils, NavigatorStorageUtils, MSNavigatorDoNotTrack, MSFileSaver, NavigatorBeacon, NavigatorConcurrentHardware, NavigatorUserMedia, NavigatorLanguage, NavigatorStorage, NavigatorAutomationInformation {
     readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
     readonly authentication: WebAuthentication;
+    readonly clipboard: Clipboard;
     readonly cookieEnabled: boolean;
     readonly doNotTrack: string | null;
     gamepadInputEmulation: GamepadInputEmulationType;

inputfiles/addedTypes.json

@@ -832,26 +832,6 @@
                     }
                 }
             },
-            "ClipboardEventInit": {
-                "exposed": "Window",
-                "name": "ClipboardEventInit",
-                "extends": "EventInit",
-                "properties": {
-                    "property": {
-                        "data": {
-                            "name": "data",
-                            "override-type": "string",
-                            "required": 0
-                        },
-                        "dataType": {
-                            "name": "dataType",
-                            "override-type": "string",
-                            "required": 0
-                        }
-                    }
-                },
-                "no-interface-object": "1"
-            },
             "IDBArrayKey": {
                 "name": "IDBArrayKey",
                 "extends": "Array<IDBValidKey>",

inputfiles/idl/Clipboard.widl

@@ -0,0 +1,23 @@
+dictionary ClipboardEventInit : EventInit {
+  DataTransfer? clipboardData = null;
+};
+
+[Constructor(DOMString type, optional ClipboardEventInit eventInitDict), Exposed=Window]
+interface ClipboardEvent : Event {
+  readonly attribute DataTransfer? clipboardData;
+};
+
+partial interface Navigator {
+  [SecureContext, SameObject] readonly attribute Clipboard clipboard;
+};
+
+[SecureContext, Exposed=Window] interface Clipboard : EventTarget {
+  Promise<DataTransfer> read();
+  Promise<DOMString> readText();
+  Promise<void> write(DataTransfer data);
+  Promise<void> writeText(DOMString data);
+};
+
+dictionary ClipboardPermissionDescriptor : PermissionDescriptor {
+  boolean allowWithoutGesture = false;
+};

inputfiles/idlSources.json

@@ -1,4 +1,8 @@
 [
+    {
+        "url": "https://www.w3.org/TR/clipboard-apis/",
+        "title": "Clipboard"
+    },
     {
         "url": "https://compat.spec.whatwg.org/",
         "title": "Compatibility",

inputfiles/overridingTypes.json

@@ -1342,14 +1342,6 @@
                     }
                 }
             },
-            "ClipboardEvent": {
-                "name": "ClipboardEvent",
-                "constructor": {
-                    "override-signatures": [
-                        "new(type: string, eventInitDict?: ClipboardEventInit): ClipboardEvent"
-                    ]
-                }
-            },
             "Storage": {
                 "name": "Storage",
                 "methods": {

inputfiles/removedTypes.json

@@ -41,6 +41,14 @@
     },
     "interfaces": {
         "interface": {
+            "Clipboard": {
+                "methods": {
+                    "method": {
+                        "read": null,
+                        "write": null
+                    }
+                }
+            },
             "Console": {
                 "methods": {
                     "method": {