Merge pull request #1081 from saschanaz/idl-mapper

Use bcd-idl-mapper

Author: Orta Therox

baselines/dom.generated.d.ts

@@ -2762,6 +2762,7 @@ interface CSSStyleDeclaration {
     captionSide: string;
     caretColor: string;
     clear: string;
+    /** @deprecated */
     clip: string;
     clipPath: string;
     clipRule: string;
@@ -2816,6 +2817,7 @@ interface CSSStyleDeclaration {
     fontStyle: string;
     fontSynthesis: string;
     fontVariant: string;
+    /** @deprecated */
     fontVariantAlternates: string;
     fontVariantCaps: string;
     fontVariantEastAsian: string;
@@ -3124,7 +3126,6 @@ interface CSSStyleDeclaration {
     webkitMaskBoxImageWidth: string;
     /** @deprecated */
     webkitMaskClip: string;
-    /** @deprecated */
     webkitMaskComposite: string;
     /** @deprecated */
     webkitMaskImage: string;
@@ -3142,15 +3143,9 @@ interface CSSStyleDeclaration {
     webkitPerspective: string;
     /** @deprecated */
     webkitPerspectiveOrigin: string;
-    /** @deprecated */
     webkitTextFillColor: string;
-    /** @deprecated */
-    webkitTextSizeAdjust: string;
-    /** @deprecated */
     webkitTextStroke: string;
-    /** @deprecated */
     webkitTextStrokeColor: string;
-    /** @deprecated */
     webkitTextStrokeWidth: string;
     /** @deprecated */
     webkitTransform: string;
@@ -17186,6 +17181,7 @@ interface WindowEventMap extends GlobalEventHandlersEventMap, WindowEventHandler
 /** A window containing a DOM document; the document property points to the DOM document loaded in that window. */
 interface Window extends EventTarget, AnimationFrameProvider, GlobalEventHandlers, WindowEventHandlers, WindowLocalStorage, WindowOrWorkerGlobalScope, WindowSessionStorage {
     HTMLDocument: Document;
+    readonly clientInformation: Navigator;
     /**
      * Returns true if the window has been closed, false otherwise.
      */
@@ -18246,6 +18242,7 @@ declare var Option: {
     new(text?: string, value?: string, defaultSelected?: boolean, selected?: boolean): HTMLOptionElement;
 };
 declare var HTMLDocument: Document;
+declare var clientInformation: Navigator;
 /**
  * Returns true if the window has been closed, false otherwise.
  */

package-lock.json

@@ -39,19 +39,20 @@
   "license": "Apache-2.0",
   "type": "module",
   "devDependencies": {
-    "@mdn/browser-compat-data": "^3.3.9",
-    "@types/jsdom": "^16.2.12",
-    "@types/node": "^15.14.1",
-    "@types/node-fetch": "^2.5.10",
-    "@types/webidl2": "^23.13.5",
-    "@typescript-eslint/eslint-plugin": "^4.28.1",
-    "@typescript-eslint/parser": "^4.28.1",
-    "@webref/css": "^2.0.2",
-    "@webref/elements": "^1.0.1",
-    "@webref/idl": "^2.2.6",
+    "@mdn/browser-compat-data": "^3.3.13",
+    "@types/jsdom": "^16.2.13",
+    "@types/node": "^16.4.8",
+    "@types/node-fetch": "^2.5.12",
+    "@types/webidl2": "^23.13.6",
+    "@typescript-eslint/eslint-plugin": "^4.28.5",
+    "@typescript-eslint/parser": "^4.28.5",
+    "@webref/css": "^2.0.5",
+    "@webref/elements": "^1.0.2",
+    "@webref/idl": "^2.2.9",
+    "bcd-idl-mapper": "^1.1.1",
     "cpx2": "^3.0.0",
     "danger": "^10.6.6",
-    "eslint": "^7.29.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
     "jsdom": "^16.6.0",

package.json

@@ -1,11 +1,9 @@
 import * as Browser from "./types";
-import bcd from "@mdn/browser-compat-data";
 import {
   CompatStatement,
   SimpleSupportStatement,
   SupportBlock,
 } from "@mdn/browser-compat-data/types";
-import { camelToHyphenCase } from "./utils/css.js";
 import { forceKeepAlive } from "./bcd/keep-alive.js";
 import { mapToBcdCompat } from "./bcd/mapper.js";
 import { hasStableImplementation } from "./bcd/stable.js";
@@ -53,37 +51,6 @@ function isSuitable(
 }
 
 export function getRemovalData(webidl: Browser.WebIdl): Browser.WebIdl {
-  const CSSStyleDeclarationKey = "CSSStyleDeclaration";
-
-  function shouldStyleBeRemoved(key: string) {
-    const hyphenCase = camelToHyphenCase(key);
-    const bcdCssItem = bcd.css.properties[hyphenCase];
-    if (
-      bcdCssItem &&
-      isSuitable(hyphenCase, bcdCssItem.__compat, CSSStyleDeclarationKey)
-    ) {
-      return false;
-    }
-    if (hyphenCase.startsWith("-webkit-")) {
-      const noPrefix = hyphenCase.slice(8);
-      const bcdWebKitItem = bcd.css.properties[noPrefix];
-      if (
-        bcdWebKitItem &&
-        isSuitable(
-          noPrefix,
-          bcdWebKitItem.__compat,
-          CSSStyleDeclarationKey,
-          "-webkit-"
-        )
-      ) {
-        return false;
-      }
-    } else if (forceKeepAlive[CSSStyleDeclarationKey]?.includes(key)) {
-      return false;
-    }
-    return true;
-  }
-
   return mapToBcdCompat(webidl, ({ key, parentKey, compat, mixin }) => {
     // Allow all mixins for now, but not their members
     // Ultimately expose.ts should be updated to check empty mixins
@@ -93,19 +60,15 @@ export function getRemovalData(webidl: Browser.WebIdl): Browser.WebIdl {
     if (isSuitable(key, compat, parentKey)) {
       return;
     }
-    if (parentKey === CSSStyleDeclarationKey && !shouldStyleBeRemoved(key)) {
-      return;
-    }
     return { exposed: "" };
   }) as Browser.WebIdl;
 }
 
 export function getDeprecationData(webidl: Browser.WebIdl): Browser.WebIdl {
-  const webkitExceptions = ["webkitLineClamp"];
-  return mapToBcdCompat(webidl, ({ key, compat, webkit }) => {
+  return mapToBcdCompat(webidl, ({ key, compat }) => {
     if (
       compat?.status?.deprecated ||
-      (!compat && webkit && !webkitExceptions.includes(key))
+      (compat?.status?.preferred_name && key.startsWith("webkit"))
     ) {
       return { deprecated: 1 };
     }

src/build/bcd.ts

@@ -3,44 +3,26 @@ export const forceKeepAlive: Record<string, string[]> = {
   // These should be filed to https://github.com/mdn/browser-compat-data/issues
   console: ["profile", "profileEnd", "timeStamp"],
   CSSStyleDeclaration: [
-    "alignContent",
-    "alignItems",
-    "alignSelf",
     "alignmentBaseline",
     "baselineShift",
-    "breakAfter",
-    "breakBefore",
-    "breakInside",
     "clipRule",
     "colorInterpolation",
     "colorInterpolationFilters",
-    "columnGap",
     "dominantBaseline",
     "fill",
     "fillOpacity",
     "fillRule",
     "floodColor",
     "floodOpacity",
     "fontSizeAdjust",
-    "fontVariantPosition",
-    "gap",
     "gridColumnGap",
     "gridGap",
     "gridRowGap",
-    "justifyContent",
-    "justifyItems",
-    "justifySelf",
     "lightingColor",
     "marker",
     "markerEnd",
     "markerMid",
     "markerStart",
-    "placeContent",
-    "placeItems",
-    "placeSelf",
-    "rotate",
-    "rowGap",
-    "scale",
     "shapeRendering",
     "stopColor",
     "stopOpacity",
@@ -53,21 +35,8 @@ export const forceKeepAlive: Record<string, string[]> = {
     "strokeOpacity",
     "strokeWidth",
     "textAnchor",
-    "translate",
-    "webkitAlignContent",
-    "webkitAlignItems",
-    "webkitAlignSelf",
-    "webkitJustifyContent",
-    "webkitMaskBoxImageOutset",
-    "webkitMaskBoxImageRepeat",
-    "webkitMaskBoxImageSlice",
-    "webkitMaskBoxImageSource",
-    "webkitMaskBoxImageWidth",
-    "wordWrap", // TODO: Support for alternative names
   ],
   DOMRect: ["x", "y", "width", "height"],
-  Document: ["charset", "inputEncoding"],
-  Element: ["webkitMatchesSelector"],
   Gamepad: ["hapticActuators"],
   GlobalEventHandlers: [
     "ontoggle",

src/build/bcd/keep-alive.ts

@@ -1,8 +1,13 @@
-import { CompatData, CompatStatement } from "@mdn/browser-compat-data/types";
+import {
+  CompatStatement,
+  Identifier,
+  SimpleSupportStatement,
+} from "bcd-idl-mapper";
+import api from "bcd-idl-mapper";
 import * as Browser from "../types";
 import { filterMapRecord, isEmptyRecord } from "../utils/record.js";
 import { mapDefined } from "../helpers.js";
-import resolveMixinSupportData from "./resolve-mixin.js";
+import { hasStableImplementation } from "./stable.js";
 
 interface DataToMap {
   key: string;
@@ -12,15 +17,47 @@ interface DataToMap {
   parentKey?: string;
 }
 
+function mergeCompatStatements(data?: Identifier): CompatStatement | undefined {
+  if (!data) {
+    return;
+  }
+  if (data?.__compat) {
+    return data.__compat;
+  }
+
+  // Some items have no top level __compat and instead have contexts with compat data for each
+
+  const statements = Object.values(data)
+    .map((d) => d.__compat)
+    .filter((n) => n) as CompatStatement[];
+
+  const base = Object.fromEntries(
+    Object.keys(statements[0].support).map((key) => {
+      return [key, [] as SimpleSupportStatement[]];
+    })
+  );
+
+  for (const statement of statements) {
+    for (const key of Object.keys(statement.support)) {
+      const support = statement.support[key];
+      if (support && hasStableImplementation(support)) {
+        base[key].push(...(Array.isArray(support) ? support : [support]));
+      }
+    }
+  }
+
+  return { ...statements[0], support: base };
+}
+
 function mapInterfaceLike(
   name: string,
   i: Browser.Interface,
-  bcdResolved: CompatData,
   mapper: (data: DataToMap) => any
 ) {
-  const intCompat = bcdResolved.api[name]?.__compat;
+  const data = i.mixin ? api.__mixins[name] : api[name];
+  const intCompat = data?.__compat;
   const mapped = mapper({ key: name, compat: intCompat, mixin: !!i.mixin });
-  if (!intCompat) {
+  if (!data) {
     if (mapped) {
       return { name: i.name, ...mapped };
     }
@@ -29,11 +66,10 @@ function mapInterfaceLike(
   const result = { ...mapped };
 
   const recordMapper = (key: string) => {
-    const compat = bcdResolved.api[name][key]?.__compat;
+    const compat = mergeCompatStatements(data[key]);
     return mapper({
       key,
       parentKey: name,
-      webkit: key.startsWith("webkit"),
       compat,
       mixin: !!i.mixin,
     });
@@ -55,14 +91,13 @@ export function mapToBcdCompat(
   webidl: Browser.WebIdl,
   mapper: (data: DataToMap) => any
 ): Browser.WebIdl | undefined {
-  const bcdResolved = resolveMixinSupportData(webidl);
   const map = (name: string, i: Browser.Interface) =>
-    mapInterfaceLike(name, i, bcdResolved, mapper);
+    mapInterfaceLike(name, i, mapper);
 
   const interfaces = filterMapRecord(webidl.interfaces?.interface, map);
   const mixins = filterMapRecord(webidl.mixins?.mixin, map);
   const namespaces = mapDefined(webidl.namespaces, (n) =>
-    mapInterfaceLike(n.name, n, bcdResolved, mapper)
+    mapInterfaceLike(n.name, n, mapper)
   );
   if (
     !isEmptyRecord(interfaces) ||