Merge pull request #487 from saschanaz/orientation

Add Screen Orientation types

Author: mhegazy

Diff for: baselines/dom.generated.d.ts

@@ -13760,14 +13760,11 @@ interface Screen extends EventTarget {
     readonly logicalYDPI: number;
     readonly msOrientation: string;
     onmsorientationchange: ((this: Screen, ev: Event) => any) | null;
+    readonly orientation: ScreenOrientation;
     readonly pixelDepth: number;
     readonly systemXDPI: number;
     readonly systemYDPI: number;
     readonly width: number;
-    lockOrientation(orientations: OrientationLockType | OrientationLockType[]): boolean;
-    msLockOrientation(orientations: string | string[]): boolean;
-    msUnlockOrientation(): void;
-    unlockOrientation(): void;
     addEventListener<K extends keyof ScreenEventMap>(type: K, listener: (this: Screen, ev: ScreenEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
     addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
     removeEventListener<K extends keyof ScreenEventMap>(type: K, listener: (this: Screen, ev: ScreenEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
@@ -13779,6 +13776,27 @@ declare var Screen: {
     new(): Screen;
 };
 
+interface ScreenOrientationEventMap {
+    "change": Event;
+}
+
+interface ScreenOrientation extends EventTarget {
+    readonly angle: number;
+    onchange: ((this: ScreenOrientation, ev: Event) => any) | null;
+    readonly type: OrientationType;
+    lock(orientation: OrientationLockType): Promise<void>;
+    unlock(): void;
+    addEventListener<K extends keyof ScreenOrientationEventMap>(type: K, listener: (this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+    removeEventListener<K extends keyof ScreenOrientationEventMap>(type: K, listener: (this: ScreenOrientation, ev: ScreenOrientationEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+    removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+}
+
+declare var ScreenOrientation: {
+    prototype: ScreenOrientation;
+    new(): ScreenOrientation;
+};
+
 interface ScriptProcessorNodeEventMap {
     "audioprocess": AudioProcessingEvent;
 }
@@ -17143,7 +17161,6 @@ type ScrollLogicalPosition = "start" | "center" | "end" | "nearest";
 type MouseWheelEvent = WheelEvent;
 type ScrollRestoration = "auto" | "manual";
 type InsertPosition = "beforebegin" | "afterbegin" | "beforeend" | "afterend";
-type OrientationLockType = "any" | "natural" | "portrait" | "landscape" | "portrait-primary" | "portrait-secondary" | "landscape-primary"| "landscape-secondary";
 type IDBValidKey = number | string | Date | BufferSource | IDBArrayKey;
 type AlgorithmIdentifier = string | Algorithm;
 type MutationRecordType = "attributes" | "characterData" | "childList";
@@ -17225,6 +17242,8 @@ type NavigationReason = "up" | "down" | "left" | "right";
 type NavigationType = "navigate" | "reload" | "back_forward" | "prerender";
 type NotificationDirection = "auto" | "ltr" | "rtl";
 type NotificationPermission = "default" | "denied" | "granted";
+type OrientationLockType = "any" | "natural" | "landscape" | "portrait" | "portrait-primary" | "portrait-secondary" | "landscape-primary" | "landscape-secondary";
+type OrientationType = "portrait-primary" | "portrait-secondary" | "landscape-primary" | "landscape-secondary";
 type OscillatorType = "sine" | "square" | "sawtooth" | "triangle" | "custom";
 type OverSampleType = "none" | "2x" | "4x";
 type PanningModelType = "equalpower" | "HRTF";

Diff for: inputfiles/addedTypes.json

@@ -2123,25 +2123,6 @@
                 },
                 "no-interface-object": "1"
             },
-            "Screen": {
-                "name": "Screen",
-                "methods": {
-                    "method": {
-                        "lockOrientation": {
-                            "name": "lockOrientation",
-                            "override-signatures": [
-                                "lockOrientation(orientations: OrientationLockType | OrientationLockType[]): boolean"
-                            ]
-                        },
-                        "unlockOrientation": {
-                            "name": "unlockOrientation",
-                            "override-signatures": [
-                                "unlockOrientation(): void"
-                            ]
-                        }
-                    }
-                }
-            },
             "HTMLTableDataCellElement": {
                 "name": "HTMLTableDataCellElement",
                 "extends": "HTMLTableCellElement",
@@ -2384,10 +2365,6 @@
                 "override-type": "Headers | string[][] | Record<string, string>",
                 "new-type": "HeadersInit"
             },
-            {
-                "override-type": "\"any\" | \"natural\" | \"portrait\" | \"landscape\" | \"portrait-primary\" | \"portrait-secondary\" | \"landscape-primary\"| \"landscape-secondary\"",
-                "new-type": "OrientationLockType"
-            },
             {
                 "override-type": "number | string | Date | BufferSource | IDBArrayKey",
                 "new-type": "IDBValidKey"

Diff for: inputfiles/idl/Screen Orientation.widl

@@ -0,0 +1,31 @@
+partial interface Screen {
+    [SameObject]
+    readonly attribute ScreenOrientation orientation;
+};
+
+[Exposed=Window]
+interface ScreenOrientation : EventTarget {
+    Promise<void> lock(OrientationLockType orientation);
+    void          unlock();
+    readonly attribute OrientationType type;
+    readonly attribute unsigned short  angle;
+             attribute EventHandler    onchange;
+};
+
+enum OrientationType {
+    "portrait-primary",
+    "portrait-secondary",
+    "landscape-primary",
+    "landscape-secondary"
+};
+
+enum OrientationLockType {
+    "any",
+    "natural",
+    "landscape",
+    "portrait",
+    "portrait-primary",
+    "portrait-secondary",
+    "landscape-primary",
+    "landscape-secondary"
+};

Diff for: inputfiles/idlSources.json

@@ -80,6 +80,10 @@
         "url": "https://w3c.github.io/resource-timing/",
         "title": "Resource Timing"
     },
+    {
+        "url": "https://www.w3.org/TR/screen-orientation/",
+        "title": "Screen Orientation"
+    },
     {
         "url": "https://w3c.github.io/ServiceWorker/",
         "title": "Service Workers"

Diff for: inputfiles/removedTypes.json

@@ -40,6 +40,14 @@
             },
             "MediaQueryListListener": null,
             "MSStreamReader": null,
+            "Screen": {
+                "methods": {
+                    "method": {
+                        "msLockOrientation": null,
+                        "msUnlockOrientation": null
+                    }
+                }
+            },
             "StorageEvent": {
                 "methods": {
                     "method": {
@@ -93,4 +101,4 @@
             "new-type": "ArrayBufferView"
         }]
     }
-}
+}