@mdn/browser-compat-data 5.0.2 → 5.1.1

package/index.ts

@@ -5,5 +5,7 @@ import { CompatData } from "./types";
 
 import bcd from "./data.json";
 
-export default bcd as CompatData;
+// XXX The cast to "any" mitigates a TS definition issue. This is very bad practice and
+// should be fixed as soon as possible.
+export default bcd as any as CompatData;
 export * from "./types";

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.2","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.1.1","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

@@ -15,29 +15,29 @@ export type BrowserName = "chrome" | "chrome_android" | "deno" | "edge" | "firef
 export type VersionValue = string | boolean | null;
 
 /**
- * This interface was referenced by `Browsers`'s JSON-Schema
+ * This interface was referenced by `BrowserDataFile`'s JSON-Schema
  * via the `definition` "browsers".
  */
 export type Browsers = Record<BrowserName, BrowserStatement>;
 /**
- * This interface was referenced by `Browsers`'s JSON-Schema
+ * This interface was referenced by `BrowserDataFile`'s JSON-Schema
  * via the `definition` "browser_type".
  */
 export type BrowserType = "desktop" | "mobile" | "xr" | "server";
 /**
- * This interface was referenced by `Browsers`'s JSON-Schema
+ * This interface was referenced by `BrowserDataFile`'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
+ * This interface was referenced by `BrowserDataFile`'s JSON-Schema
  * via the `definition` "browser_status".
  */
 export type BrowserStatus = "retired" | "current" | "exclusive" | "beta" | "nightly" | "esr" | "planned";
 
 
 /**
- * This interface was referenced by `Browsers`'s JSON-Schema
+ * This interface was referenced by `BrowserDataFile`'s JSON-Schema
  * via the `definition` "browser_statement".
  */
 export interface BrowserStatement {
@@ -52,7 +52,7 @@ export interface BrowserStatement {
   /**
    * 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 disablle features.
    */
@@ -75,7 +75,7 @@ export interface BrowserStatement {
   releases: {[version: string]: ReleaseStatement};
 }
 /**
- * This interface was referenced by `Browsers`'s JSON-Schema
+ * This interface was referenced by `BrowserDataFile`'s JSON-Schema
  * via the `definition` "release_statement".
  */
 export interface ReleaseStatement {
@@ -103,52 +103,46 @@ export interface ReleaseStatement {
 
 
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema definition
+ * via the `patternProperty` "^(?!__compat)(?!webextensions)[a-zA-Z_0-9-$@]*$".
+ *
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
+ * via the `definition` "identifier".
+ */
+export type Identifier = {[key: string]: Identifier} & {__compat?: CompatStatement};
+/**
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "support_statement".
  */
 export type SupportStatement = SimpleSupportStatement | SimpleSupportStatement[];
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "support_block".
  */
-export type SupportBlock = Partial<Record<BrowserNames, SupportStatement>>;
+export type SupportBlock = Partial<Record<BrowserName, SupportStatement>>;
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "spec_url_value".
  */
 export type SpecUrlValue = string;
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "impl_url_value".
  */
 export type ImplUrlValue = string;
-
-
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema definition
- * via the `patternProperty` "^(?!__compat)(?!webextensions)[a-zA-Z_0-9-$@]*$".
- *
- * This interface was referenced by `CompatData`'s JSON-Schema
- * via the `definition` "identifier".
+ * This interface was referenced by `CompatDataFile`'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 interface Identifier extends Record<Omit<string, '__compat'>, Identifier> {
-  /**
-   * 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 type WebextensionsIdentifier = {[key: string]: Identifier} & {__compat?: CompatStatement};
+
+
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema definition
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema definition
  * via the `patternProperty` "^__compat$".
  *
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "compat_statement".
  */
 export interface CompatStatement {
@@ -164,6 +158,10 @@ export interface CompatStatement {
    * 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 path to the file that defines this feature in browser-compat-data, relative to the repository root. Useful for guiding potential contributors towards the correct file to edit. This is automatically generated at build time and should never manually be specified.
+   */
+  source_file?: 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.
    */
@@ -174,7 +172,7 @@ export interface CompatStatement {
   status?: StatusBlock;
 }
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "simple_support_statement".
  */
 export interface SimpleSupportStatement {
@@ -212,7 +210,7 @@ export interface SimpleSupportStatement {
   notes?: string | string[];
 }
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "flag_statement".
  */
 export interface FlagStatement {
@@ -230,7 +228,7 @@ export interface FlagStatement {
   value_to_set?: string;
 }
 /**
- * This interface was referenced by `CompatData`'s JSON-Schema
+ * This interface was referenced by `CompatDataFile`'s JSON-Schema
  * via the `definition` "status_block".
  */
 export interface StatusBlock {
@@ -247,21 +245,9 @@ export interface StatusBlock {
    */
   deprecated: boolean;
 }
-/**
- * This interface was referenced by `CompatData`'s JSON-Schema
- * via the `definition` "webextensions_identifier".
- */
-export interface WebextensionsIdentifier {
-  __compat?: CompatStatement;
-  /**
-   * This interface was referenced by `WebextensionsIdentifier`'s JSON-Schema definition
-   * via the `patternProperty` "^(?!__compat)[a-zA-Z_0-9-$@]*$".
-   */
-  [k: string]: Identifier;
-}
 
 
-export interface MetaBlock{
+export interface MetaBlock {
   version: string;
 }