@mdn/browser-compat-data 5.0.0 → 5.0.3

package/index.ts

@@ -1,7 +1,7 @@
 /* This file is a part of @mdn/browser-compat-data
  * See LICENSE file for more information. */
 
-import "./types";
+import { CompatData } from "./types";
 
 import bcd from "./data.json";
 

package/package.json

@@ -1 +1 @@
-{"main":"data.json","exports":{".":"./data.json","./forLegacyNode":"./legacynode.mjs"},"types":"index.ts","name":"@mdn/browser-compat-data","version":"5.0.0","description":"Browser compatibility data provided by MDN Web Docs","repository":{"type":"git","url":"git+https://github.com/mdn/browser-compat-data.git"},"keywords":["bcd","browser-compat-data","browser","compatibility","data","mdn","mozilla"],"author":"MDN Web Docs","license":"CC0-1.0","bugs":{"url":"https://github.com/mdn/browser-compat-data/issues"},"homepage":"https://github.com/mdn/browser-compat-data#readme"}
+{"main":"data.json","exports":{".":"./data.json","./forLegacyNode":"./legacynode.mjs"},"types":"index.ts","name":"@mdn/browser-compat-data","version":"5.0.3","description":"Browser compatibility data provided by MDN Web Docs","repository":{"type":"git","url":"git+https://github.com/mdn/browser-compat-data.git"},"keywords":["bcd","browser-compat-data","browser","compatibility","data","mdn","mozilla"],"author":"MDN Web Docs","license":"CC0-1.0","bugs":{"url":"https://github.com/mdn/browser-compat-data/issues"},"homepage":"https://github.com/mdn/browser-compat-data#readme"}

package/types.d.ts

@@ -1,409 +1,305 @@
 /* This file is a part of @mdn/browser-compat-data
  * See LICENSE file for more information. */
 
+/**
+* This file was automatically generated by json-schema-to-typescript.
+* DO NOT MODIFY IT BY HAND. Instead, modify the source schema files in
+* schemas/*, and run "npm run gentypes" to regenerate this file.
+*/
+
 /**
  * The names of the known browsers.
  */
-export type BrowserNames =
-  | 'chrome'
-  | 'chrome_android'
-  | 'deno'
-  | 'edge'
-  | 'firefox'
-  | 'firefox_android'
-  | 'ie'
-  | 'nodejs'
-  | 'oculus'
-  | 'opera'
-  | 'opera_android'
-  | 'safari'
-  | 'safari_ios'
-  | 'samsunginternet_android'
-  | 'webview_android';
+export type BrowserName = "chrome" | "chrome_android" | "deno" | "edge" | "firefox" | "firefox_android" | "ie" | "nodejs" | "oculus" | "opera" | "opera_android" | "safari" | "safari_ios" | "samsunginternet_android" | "webview_android";
 
-export type BrowserEngines =
-  | 'Blink'
-  | 'EdgeHTML'
-  | 'Gecko'
-  | 'Presto'
-  | 'Trident'
-  | 'WebKit'
-  | 'V8';
-
-export type BrowserTypes = 'desktop' | 'mobile' | 'xr' | 'server';
+export type VersionValue = string | boolean | null;
 
 /**
- * The browser namespace.
+ * This interface was referenced by `Browsers`'s JSON-Schema
+ * via the `definition` "browsers".
  */
-export interface Browsers
-  extends Record<BrowserNames, BrowserStatement>,
-    Record<string, BrowserStatement> {}
+export type Browsers = Record<BrowserName, BrowserStatement>;
+/**
+ * This interface was referenced by `Browsers`'s JSON-Schema
+ * via the `definition` "browser_type".
+ */
+export type BrowserType = "desktop" | "mobile" | "xr" | "server";
+/**
+ * This interface was referenced by `Browsers`'s JSON-Schema
+ * via the `definition` "browser_engine".
+ */
+export type BrowserEngine = "Blink" | "EdgeHTML" | "Gecko" | "Presto" | "Trident" | "WebKit" | "V8";
+/**
+ * This interface was referenced by `Browsers`'s JSON-Schema
+ * via the `definition` "browser_status".
+ */
+export type BrowserStatus = "retired" | "current" | "exclusive" | "beta" | "nightly" | "esr" | "planned";
+
 
 /**
- * A browser statement.
+ * This interface was referenced by `Browsers`'s JSON-Schema
+ * via the `definition` "browser_statement".
  */
 export interface BrowserStatement {
   /**
-   * The browser brand name, for example:
-   * `"Firefox"`, `"Firefox Android"`, `"Safari"`, `"iOS Safari"`, etc.
+   * The browser brand name (e.g. Firefox, Firefox Android, Chrome, etc.).
    */
   name: string;
-
   /**
-   * The platform the browser runs on, for example:
-   * `"desktop"`, `"mobile"`, `"server"`, etc.
+   * The platform the browser runs on (e.g. desktop, mobile, XR, or server engine).
    */
-  type: BrowserTypes;
-
+  type: BrowserType;
   /**
-   * The upstream browser
+   * The upstream browser this browser derives from (e.g. Firefox Android is derived from Firefox, Edge is derived from Chrome).
    */
-  upstream?: string;
-
+  upstream?: BrowserName;
   /**
-   * Whether the browser supports flags to enable or disable features.
+   * Whether the browser supports flags to enable or disablle features.
    */
   accepts_flags?: boolean;
-
   /**
    * Whether the browser supports extensions.
    */
   accepts_webextensions?: boolean;
-
   /**
-   * An optional string containing the URL of the page where feature flags can be changed
-   * (e.g. `"about:config"` for Firefox or `"chrome://flags"` for Chrome).
+   * URL of the page where feature flags can be changed (e.g. 'about:config' for Firefox or 'chrome://flags' for Chrome).
    */
   pref_url?: string;
-
   /**
-   * The preview browser's name, for example:
-   * `"Nightly"`, `"Canary"`, `"TP"`, etc.
+   * The name of the browser's preview channel (e.g. 'Nightly' for Firefox or 'TP' for Safari).
    */
-  preview_name: string;
-
+  preview_name?: string;
   /**
    * The known versions of this browser.
    */
-  releases: {
-    [version: string]: ReleaseStatement;
-  };
+  releases: {[version: string]: ReleaseStatement};
 }
-
 /**
- * The data about this version.
+ * This interface was referenced by `Browsers`'s JSON-Schema
+ * via the `definition` "release_statement".
  */
 export interface ReleaseStatement {
   /**
-   * The date on which this version was released.
-   *
-   * Formatted as `YYYY-MM-DD`.
+   * The date on which this version was released, formatted as `YYYY-MM-DD`.
    */
   release_date?: string;
-
   /**
-   * The URL of the release notes.
+   * A link to the release notes or changelog for a given release.
    */
   release_notes?: string;
-
   /**
    * Name of the browser's underlying engine.
    */
-  engine?: BrowserEngines;
-
+  engine?: BrowserEngine;
   /**
    * Version of the engine corresponding to the browser version.
    */
   engine_version?: string;
-
   /**
-   * A property indicating where in the lifetime cycle this release is in.
-   *
-   * It's an enum accepting these values:
-   * - `retired`: This release is no longer supported (EOL).
-   * - `current`: This release is the official latest release.
-   * - `exclusive`: This is an exclusive release (for example on a flagship device),
-   *   not generally available.
-   * - `beta`: This release will the next official release.
-   * - `nightly`: This release is the current alpha / experimental release
-   *   (like Firefox Nightly, Chrome Canary).
-   * - `esr`: This release is an Extended Support Release.
-   * - `planned`: This release is planned in the future.
-   */
-  status:
-    | 'retired'
-    | 'current'
-    | 'limited'
-    | 'beta'
-    | 'nightly'
-    | 'esr'
-    | 'planned';
+   * A property indicating where in the lifetime cycle this release is in (e.g. current, retired, beta, nightly).
+   */
+  status: BrowserStatus;
 }
 
+
 /**
- * The `support_statement` object describes the support provided
- * by a single browser type for the given sub-feature.
+ * This interface was referenced by `CompatData`'s JSON-Schema definition
+ * via the `patternProperty` "^(?!__compat)(?!webextensions)[a-zA-Z_0-9-$@]*$".
  *
- * It is an array of `simple_support_statement` objects, but if there
- * is only one of them, the array must be omitted.
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "identifier".
  */
-export type SupportStatement =
-  | SimpleSupportStatement
-  | SimpleSupportStatement[];
+export type Identifier = {[key: string]: Identifier} & {__compat?: CompatStatement};
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "support_statement".
+ */
+export type SupportStatement = SimpleSupportStatement | SimpleSupportStatement[];
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "support_block".
+ */
+export type SupportBlock = Partial<Record<BrowserName, SupportStatement>>;
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "spec_url_value".
+ */
+export type SpecUrlValue = string;
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "impl_url_value".
+ */
+export type ImplUrlValue = string;
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "webextensions_identifier".
+ * THIS INTERFACE SHOULD NOT BE USED AND MAY BE REMOVED AT ANY TIME; USE THE "Identifier" INTERFACE INSTEAD.
+ */
+export type WebextensionsIdentifier = {[key: string]: Identifier} & {__compat?: CompatStatement};
 
-export type VersionValue = string | boolean | null;
 
 /**
- * The `simple_support_statement` object is the core object containing the compatibility information for a browser.
+ * This interface was referenced by `CompatData`'s JSON-Schema definition
+ * via the `patternProperty` "^__compat$".
+ *
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "compat_statement".
+ */
+export interface CompatStatement {
+  /**
+   * A string containing a human-readable description of the feature.
+   */
+  description?: string;
+  /**
+   * A URL that points to an MDN reference page documenting the feature. The URL should be language-agnostic.
+   */
+  mdn_url?: string;
+  /**
+   * An optional URL or array of URLs, each of which is for a specific part of a specification in which this feature is defined. Each URL must contain a fragment identifier.
+   */
+  spec_url?: string | string[];
+  /**
+   * The data for the support of each browser, containing a `support_statement` object for each browser identifier with information about versions, prefixes, or alternate names, as well as notes.
+   */
+  support: SupportBlock;
+  /**
+   * An object containing information about the stability of the feature.
+   */
+  status?: StatusBlock;
+}
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "simple_support_statement".
  */
 export interface SimpleSupportStatement {
-  /** The version indicating when a sub-feature has been added (and is therefore supported).
-   *
-   * The `boolean` values indicate that a sub-feature is supported
-   * (`true`, with the additional meaning that it is unknown in which version support was added)
-   * or not supported (`false`).
-   *
-   * A value of `null` indicates that support information is entirely unknown.
+  /**
+   * A string (indicating which browser version added this feature), the value true (indicating support added in an unknown version), the value false (indicating the feature is not supported), or the value null (indicating support is unknown).
    */
   version_added: VersionValue;
-
   /**
-   * Contains a string with the version number the sub-feature was
-   * removed in. It may also be a `boolean` value of (`true` or `false`),
-   * or the `null` value.
-   *
-   * Default values:
-   * - If `version_added` is set to `true`, `false`, or a string,
-   *   `version_removed` defaults to `false`.
-   * - if `version_added` is set to `null`, the default value
-   *   of `version_removed` is also `null`.
+   * A string, indicating which browser version removed this feature, or the value true, indicating that the feature was removed in an unknown version.
    */
   version_removed?: VersionValue;
-
   /**
-   * A prefix to add to the sub-feature name (defaults to empty string).
-   *
-   * Only non-standard vendor prefixes are permitted.
-   *
-   * Note that leading and trailing `-` must be included.
+   * A prefix to add to the sub-feature name (defaults to empty string). If applicable, leading and trailing '-' must be included.
    */
   prefix?: string;
-
   /**
-   * In some cases features are named entirely differently and not just prefixed,
-   * or the prefix is an official non-vendor prefix.
-   *
-   * (eg. the official `grid-` prefixed aliases for the CSS `*-gap` properties).
+   * An alternative name for the feature, for cases where a feature is implemented under an entirely different name and not just prefixed.
    */
   alternative_name?: string;
-
   /**
-   * An optional array of objects indicating what kind of flags must be set for this feature to work.
-   * Usually this array will have one item, but there are cases where two or more flags can be required to activate a feature.
+   * An optional array of objects describing flags that must be configured for this browser to support this feature.
    */
-  flags?: {
-    /**
-     * An enum that indicates the flag type:
-     * - `preference` a flag the user can set (like in `about:config` in Firefox).
-     * - `runtime_flag` a flag to be set before starting the browser.
-     */
-    type: 'preference' | 'runtime_flag';
-
-    /**
-     * A `string` representing the flag or preference to modify.
-     */
-    name: string;
-
-    /**
-     * Property representing the actual value to set the flag to.
-     *
-     * It is a string, that may be converted to the right type
-     * (that is `true` or `false` for a `boolean` value, or `4` for a `number` value).
-     *
-     * It doesn't need to be enclosed in `<code>` tags.
-     */
-    value_to_set?: string;
-  }[];
-
+  flags?: FlagStatement[];
   /**
-   * An optional changeset/commit URL for the revision which implemented the feature in the source code, or the URL to the bug tracking the implementation, for the associated browser; e.g. a https://trac.webkit.org/changeset/
-   * https://hg.mozilla.org/mozilla-central/rev/, or https://crrev.com/ URL.
+   * An optional changeset/commit URL for the revision which implemented the feature in the source code, or the URL to the bug tracking the implementation, for the associated browser.
    */
-  impl_url?: string;
-
+  impl_url?: string | string[];
   /**
-   * A `boolean` value indicating whether or not the implementation of the sub-feature follows
-   * the current specification closely enough to not create major interoperability problems.
-   *
-   * It defaults to `false` (no interoperability problem expected).
-   *
-   * If set to `true`, it is recommended to add a note indicating how it diverges from
-   * the standard (implements an old version of the standard, for example).
+   * A boolean value indicating whether or not the implementation of the sub-feature deviates from the specification in a way that may cause compatibility problems. It defaults to false (no interoperability problems expected). If set to true, it is recommended that you add a note explaining how it diverges from the standard (such as that it implements an old version of the standard, for example).
    */
-  partial_implementation?: boolean;
-
+  partial_implementation?: true;
   /**
-   * An `array` of zero or more strings containing
-   * additional information. If there is only one entry in the array,
-   * the array must be omitted.
-   *
-   * The `<code>` and `<a>` HTML elements can be used.
+   * A string or array of strings containing additional information.
    */
   notes?: string | string[];
 }
-
-export type Identifier = PrimaryIdentifier & IdentifierMeta;
-
-export interface PrimaryIdentifier
-  extends Record<Exclude<string, '__compat'>, Identifier> {}
-
-interface IdentifierMeta {
-  /**
-   * A feature is described by an identifier containing the `__compat` property.
-   *
-   * In other words, identifiers without `__compat` aren't necessarily features,
-   * but help to nest the features properly.
-   *
-   * When an identifier has a `__compat` block, it represents its basic support,
-   * indicating that a minimal implementation of a functionality is included.
-   *
-   * What it represents exactly depends of the evolution of the feature over time,
-   * both in terms of specifications and of browser support.
-   */
-  __compat?: CompatStatement;
-}
-
-export interface CompatStatement {
-  /**
-   * A string containing a human-readable description of the feature.
-   *
-   * It is intended to be used as a caption or title and should be kept short.
-   *
-   * The `<code>` and `<a>` HTML elements can be used.
-   */
-  description?: string;
-
+/**
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "flag_statement".
+ */
+export interface FlagStatement {
   /**
-   * URL which points to a MDN reference page documenting the feature.
-   *
-   * It needs to be a valid URL, and should be the language-⁠neutral URL
-   * (e.g. use `https⁠://developer.mozilla.org/docs/Web/CSS/text-⁠align`
-   * instead of `https⁠://developer.mozilla.org/en-⁠US/docs/Web/CSS/text-⁠align`).
+   * An enum that indicates the flag type.
    */
-  mdn_url?: string;
-
+  type: "preference" | "runtime_flag";
   /**
-   * Each `__compat` object contains support information.
-   *
-   * For each browser identifier, it contains a `support_statement` object with
-   * information about versions, prefixes, or alternate names, as well as notes.
+   * A string giving the name of the flag or preference that must be configured.
    */
-  support: SupportBlock;
-
+  name: string;
   /**
-   * An object containing information about the stability of the feature:
-   *
-   * Is it a functionality that is standard? Is it stable?
-   * Has it been deprecated and shouldn't be used anymore?
+   * A string giving the value which the specified flag must be set to for this feature to work.
    */
-  status?: StatusBlock;
+  value_to_set?: string;
 }
-
-export interface SupportBlock
-  extends Partial<Record<BrowserNames, SupportStatement>>,
-    Partial<Record<string, SupportStatement>> {}
-
 /**
- * The status property contains information about stability of the feature.
+ * This interface was referenced by `CompatData`'s JSON-Schema
+ * via the `definition` "status_block".
  */
 export interface StatusBlock {
   /**
-   * `boolean` value that indicates this functionality is
-   * intended to be an addition to the Web platform. Some features are added to
-   * conduct tests.
-   *
-   * Set to `false`, it means the functionality is mature, and no
-   * significant incompatible changes are expected in the future.
+   * A boolean value that indicates whether this functionality is intended to be an addition to the Web platform. Set to false, it means the functionality is mature, and no significant incompatible changes are expected in the future.
    */
   experimental: boolean;
-
   /**
-   * `boolean` value indicating if the feature is part
-   * of an active specification or specification process.
+   * A boolean value indicating whether the feature is part of an active specification or specification process.
    */
   standard_track: boolean;
-
   /**
-   * `boolean` value that indicates if the feature is no longer recommended.
-   *
-   * It might be removed in the future or might only be kept for compatibility purposes.
-   * Avoid using this functionality.
+   * A boolean value that indicates whether the feature is no longer recommended. It might be removed in the future or might only be kept for compatibility purposes. Avoid using this functionality.
    */
   deprecated: boolean;
 }
 
-export type CompatData = CompatDataBrowsers & CompatDataIdentifiers;
 
-interface CompatDataBrowsers {
+export interface MetaBlock {
+  version: string;
+}
+
+export interface CompatData {
+  /**
+   * Contains metadata for the current BCD information, such as the BCD version.
+   */
+  __meta: MetaBlock;
+
   /**
-   * Contains data for each known browser.
+   * Contains data for each [Web API](https://developer.mozilla.org/docs/Web/API) interface.
    */
-  browsers: Browsers;
-}
+  api: Identifier;
 
-interface CompatDataIdentifiers
-  extends Record<Exclude<string, 'browsers'>, PrimaryIdentifier> {
   /**
-   * Contains data for each [Web API](https://developer.mozilla.org/docs/Web/API)
-   * interface.
+   * Contains data for each known and tracked browser/engine.
    */
-  api: PrimaryIdentifier;
+  browsers: Browsers;
 
   /**
-   * Contains data for [CSS](https://developer.mozilla.org/docs/Web/CSS)
-   * properties, selectors, and at-rules.
+   * Contains data for [CSS](https://developer.mozilla.org/docs/Web/CSS) properties, selectors, and at-rules.
    */
-  css: PrimaryIdentifier;
+  css: Identifier;
 
   /**
-   * Contains data for [HTML](https://developer.mozilla.org/docs/Web/HTML)
-   * elements, attributes, and global attributes.
+   * Contains data for [HTML](https://developer.mozilla.org/docs/Web/HTML) elements, attributes, and global attributes.
    */
-  html: PrimaryIdentifier;
+  html: Identifier;
 
   /**
-   * Contains data for [HTTP](https://developer.mozilla.org/docs/Web/HTTP)
-   * headers, statuses, and methods.
+   * Contains data for [HTTP](https://developer.mozilla.org/docs/Web/HTTP) headers, statuses, and methods.
    */
-  http: PrimaryIdentifier;
+  http: Identifier;
 
   /**
-   * Contains data for [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript)
-   * built-in Objects, statement, operators, and other ECMAScript language features.
+   * Contains data for [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript) built-in Objects, statement, operators, and other ECMAScript language features.
    */
-  javascript: PrimaryIdentifier;
+  javascript: Identifier;
 
   /**
-   * Contains data for [MathML](https://developer.mozilla.org/docs/Web/MathML)
-   * elements, attributes, and global attributes.
+   * Contains data for [MathML](https://developer.mozilla.org/docs/Web/MathML) elements, attributes, and global attributes.
    */
-  mathml: PrimaryIdentifier;
+  mathml: Identifier;
 
   /**
-   * Contains data for [SVG](https://developer.mozilla.org/docs/Web/SVG)
-   * elements, attributes, and global attributes.
+   * Contains data for [SVG](https://developer.mozilla.org/docs/Web/SVG) elements, attributes, and global attributes.
    */
-  svg: PrimaryIdentifier;
+  svg: Identifier;
 
   /**
-   * Contains data for [WebDriver](https://developer.mozilla.org/docs/Web/WebDriver)
-   * commands.
+   * Contains data for [WebDriver](https://developer.mozilla.org/docs/Web/WebDriver) commands.
    */
-  webdriver: PrimaryIdentifier;
+  webdriver: Identifier;
 
   /**
-   * Contains data for [WebExtensions](https://developer.mozilla.org/Add-ons/WebExtensions)
-   * JavaScript APIs and manifest keys.
+   * Contains data for [WebExtensions](https://developer.mozilla.org/Add-ons/WebExtensions) JavaScript APIs and manifest keys.
    */
-  webextensions: PrimaryIdentifier;
+  webextensions: Identifier;
 }