feat(schemas): separate public from internal schema by caugner · Pull Request #29041 · mdn/browser-compat-data

caugner · 2026-02-13T10:39:40Z

Summary

Adds a public schema for data.json, separate from the internal browser/compat file schemas.

Test results and supporting details

There are two changes that are strictly speaking breaking:

The CompatStatement.source_file property is now required.
The BrowserStatement.upstream property is narrowed down to UpstreamBrowserName, a subset of BrowserName.

Before

/* 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 BrowserName = "bun" | "chrome" | "chrome_android" | "deno" | "edge" | "firefox" | "firefox_android" | "ie" | "nodejs" | "oculus" | "opera" | "opera_android" | "safari" | "safari_ios" | "samsunginternet_android" | "webview_android" | "webview_ios";

export type VersionValue = string | false;

/**
 * This interface was referenced by `BrowserDataFile`'s JSON-Schema
 * via the `definition` "browsers".
 */
export type Browsers = Record<BrowserName, BrowserStatement>;
/**
 * 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 `BrowserDataFile`'s JSON-Schema
 * via the `definition` "browser_engine".
 */
export type BrowserEngine = "Blink" | "EdgeHTML" | "Gecko" | "Presto" | "Trident" | "WebKit" | "V8";
/**
 * This interface was referenced by `BrowserDataFile`'s JSON-Schema
 * via the `definition` "browser_status".
 */
export type BrowserStatus = "retired" | "current" | "beta" | "nightly" | "esr" | "planned";


/**
 * This interface was referenced by `BrowserDataFile`'s JSON-Schema
 * via the `definition` "browser_statement".
 */
export interface BrowserStatement {
  /**
   * The browser brand name (e.g. Firefox, Firefox Android, Chrome, etc.).
   */
  name: string;
  /**
   * The platform the browser runs on (e.g. desktop, mobile, XR, or server engine).
   */
  type: BrowserType;
  /**
   * The upstream browser this browser derives from (e.g. Firefox Android is derived from Firefox, Edge is derived from Chrome).
   */
  upstream?: BrowserName;
  /**
   * The name of the browser's preview channel (e.g. 'Nightly' for Firefox or 'TP' for Safari).
   */
  preview_name?: string;
  /**
   * URL of the page where feature flags can be changed (e.g. 'about:config' for Firefox or 'chrome://flags' for Chrome).
   */
  pref_url?: string;
  /**
   * Whether the browser supports user-toggleable flags that enable or disable features.
   */
  accepts_flags: boolean;
  /**
   * Whether the browser supports extensions.
   */
  accepts_webextensions: boolean;
  /**
   * The known versions of this browser.
   */
  releases: {[version: string]: ReleaseStatement};
}
/**
 * This interface was referenced by `BrowserDataFile`'s JSON-Schema
 * via the `definition` "release_statement".
 */
export interface ReleaseStatement {
  /**
   * The date on which this version was released, formatted as `YYYY-MM-DD`.
   */
  release_date?: string;
  /**
   * A link to the release notes or changelog for a given release.
   */
  release_notes?: string;
  /**
   * A property indicating where in the lifetime cycle this release is in (e.g. current, retired, beta, nightly).
   */
  status: BrowserStatus;
  /**
   * Name of the browser's underlying engine.
   */
  engine?: BrowserEngine;
  /**
   * Version of the engine corresponding to the browser version.
   */
  engine_version?: string;
}


/**
 * 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};
/**
 * 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.
 */
export type SupportBlock = Partial<Record<BrowserName, SupportStatement>>;
/**
 * This interface was referenced by `CompatDataFile`'s JSON-Schema
 * via the `definition` "support_statement".
 */
export type SupportStatement =
  | SimpleSupportStatement
  | [SimpleSupportStatement, SimpleSupportStatement, ...SimpleSupportStatement[]];


/**
 * This interface was referenced by `CompatDataFile`'s JSON-Schema definition
 * via the `patternProperty` "^__compat$".
 *
 * This interface was referenced by `CompatDataFile`'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, string, ...string[]];
  /**
   * An optional array of strings allowing to assign tags to the feature.
   *
   * @minItems 1
   */
  tags?: [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;
  support: SupportBlock;
  status?: StatusBlock;
}
/**
 * An object containing information about the stability of the feature.
 */
export interface StatusBlock {
  /**
   * @deprecated
   * (This property is deprecated. Prefer using more well-defined stability calculations, such as Baseline, instead.) A boolean value. Usually, this value is true for single-implementer features and false for multiple-implementer features or single-implementer features that are not expected to change.
   */
  experimental: boolean;
  /**
   * A boolean value indicating whether the feature is part of an active specification or specification process.
   */
  standard_track: boolean;
  /**
   * 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;
}
/**
 * This interface was referenced by `CompatDataFile`'s JSON-Schema
 * via the `definition` "simple_support_statement".
 */
export interface SimpleSupportStatement {
  /**
   * A string (indicating which browser version added this feature), or the value false (indicating the feature is not supported).
   */
  version_added: VersionValue;
  /**
   * A string, indicating which browser version removed this feature.
   */
  version_removed?: string;
  /**
   * A string, indicating the last browser version that supported this feature. This is automatically generated.
   */
  version_last?: string;
  /**
   * A prefix to add to the sub-feature name (defaults to empty string). If applicable, leading and trailing '-' must be included.
   */
  prefix?: string;
  /**
   * 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 describing flags that must be configured for this browser to support this feature.
   *
   * @minItems 1
   */
  flags?: [FlagStatement, ...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.
   */
  impl_url?: string | [string, string, ...string[]];
  /**
   * 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?: true;
  /**
   * A string or array of strings containing additional information.
   */
  notes?: string | [string, string, ...string[]];
}
/**
 * This interface was referenced by `CompatDataFile`'s JSON-Schema
 * via the `definition` "flag_statement".
 */
export interface FlagStatement {
  /**
   * An enum that indicates the flag type.
   */
  type: "preference" | "runtime_flag";
  /**
   * A string giving the name of the flag or preference that must be configured.
   */
  name: string;
  /**
   * A string giving the value which the specified flag must be set to for this feature to work.
   */
  value_to_set?: string;
}


export interface MetaBlock {
  version: string;
  timestamp: string;
}

export interface CompatData {
  /**
   * Contains metadata for the current BCD information, such as the BCD version.
   */
  __meta: MetaBlock;

  /**
   * Contains data for each [Web API](https://developer.mozilla.org/docs/Web/API) interface.
   */
  api: Identifier;

  /**
   * Contains data for each known and tracked browser/engine.
   */
  browsers: Browsers;

  /**
   * Contains data for [CSS](https://developer.mozilla.org/docs/Web/CSS) properties, selectors, and at-rules.
   */
  css: Identifier;

  /**
   * Contains data for [HTML](https://developer.mozilla.org/docs/Web/HTML) elements, attributes, and global attributes.
   */
  html: Identifier;

  /**
   * Contains data for [HTTP](https://developer.mozilla.org/docs/Web/HTTP) headers, statuses, and methods.
   */
  http: Identifier;

  /**
   * Contains data for [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript) built-in Objects, statement, operators, and other ECMAScript language features.
   */
  javascript: Identifier;

  /**
   * Contains data for various manifests, such as the [Web Application Manifest](https://developer.mozilla.org/docs/Web/Progressive_web_apps/manifest).
   */
  manifests: Identifier;

  /**
   * Contains data for [MathML](https://developer.mozilla.org/docs/Web/MathML) elements, attributes, and global attributes.
   */
  mathml: Identifier;

  /**
   * Contains data for [Media types](https://developer.mozilla.org/docs/Web/HTTP/Guides/MIME_types).
   */
  mediatypes: Identifier;

  /**
   * Contains data for [SVG](https://developer.mozilla.org/docs/Web/SVG) elements, attributes, and global attributes.
   */
  svg: Identifier;

  /**
   * Contains data for [WebAssembly](https://developer.mozilla.org/docs/WebAssembly) features.
   */
  webassembly: Identifier;

  /**
   * Contains data for [WebDriver](https://developer.mozilla.org/docs/Web/WebDriver) commands.
   */
  webdriver: Identifier;

  /**
   * Contains data for [WebExtensions](https://developer.mozilla.org/Add-ons/WebExtensions) JavaScript APIs and manifest keys.
   */
  webextensions: Identifier;
}

After

/* 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.
 */

export type Identifier = {__compat?: CompatStatement} & {[key: string]: Identifier};
/**
 * Data for each known and tracked browser/runtime.
 */
export type Browsers = Record<BrowserName, BrowserStatement>;
/**
 * Platform the browser runs on (e.g. desktop, mobile, XR, or server engine).
 */
export type BrowserType = "desktop" | "mobile" | "xr" | "server";
/**
 * Browser engine.
 */
export type BrowserEngine = "Blink" | "EdgeHTML" | "Gecko" | "Presto" | "Trident" | "WebKit" | "V8";
/**
 * Browser key (e.g. 'firefox', 'chrome_android', or 'webview_ios').
 */
export type BrowserName =
  | "bun"
  | "chrome"
  | "chrome_android"
  | "deno"
  | "edge"
  | "firefox"
  | "firefox_android"
  | "ie"
  | "nodejs"
  | "oculus"
  | "opera"
  | "opera_android"
  | "safari"
  | "safari_ios"
  | "samsunginternet_android"
  | "webview_android"
  | "webview_ios";
/**
 * Upstream browser key (e.g. 'firefox' or 'chrome_android').
 */
export type UpstreamBrowserName = "chrome" | "chrome_android" | "firefox" | "safari" | "safari_ios";
/**
 * Lifetime cycle status of a browser release (e.g. 'current', 'retired', 'beta', 'nightly').
 */
export type BrowserStatus = "retired" | "current" | "beta" | "nightly" | "esr" | "planned";
/**
 * A string (indicating which browser version added this feature), or the value false (indicating the feature is not supported).
 */
export type VersionValue = string | false;
export type SupportStatement =
  | SimpleSupportStatement
  | [SimpleSupportStatement, SimpleSupportStatement, ...SimpleSupportStatement[]];
/**
 * 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.
 */
export type SupportBlock = Partial<Record<BrowserName, SupportStatement>>;

/**
 * Shape of the `data.json` file in published BCD releases
 */
export interface CompatData {
  __meta: MetaBlock;
  api: Identifier;
  browsers: Browsers;
  css: Identifier;
  html: Identifier;
  http: Identifier;
  javascript: Identifier;
  manifests: Identifier;
  mathml: Identifier;
  mediatypes: Identifier;
  svg: Identifier;
  webassembly: Identifier;
  webdriver: Identifier;
  webextensions: Identifier;
}
/**
 * Metadata of the present BCD data.
 */
export interface MetaBlock {
  version: string;
  timestamp: string;
}
export interface BrowserStatement {
  /**
   * Name of the browser (e.g. 'Firefox', 'Firefox Android', 'Chrome', etc.).
   */
  name: string;
  type: BrowserType;
  upstream?: UpstreamBrowserName;
  /**
   * Name of the browser's preview channel (e.g. 'Nightly' for Firefox or 'TP' for Safari).
   */
  preview_name?: string;
  /**
   * URL of the page where feature flags can be changed (e.g. 'about:config' for Firefox or 'chrome://flags' for Chrome).
   */
  pref_url?: string;
  /**
   * Whether the browser supports user-toggleable flags that enable or disable features.
   */
  accepts_flags: boolean;
  /**
   * Whether the browser supports extensions.
   */
  accepts_webextensions: boolean;
  /**
   * The known versions of this browser.
   */
  releases: Record<string, ReleaseStatement>;
}
export interface ReleaseStatement {
  /**
   * The date on which this version was released, formatted as `YYYY-MM-DD`.
   */
  release_date?: string;
  /**
   * A link to the release notes or changelog for a given release.
   */
  release_notes?: string;
  status: BrowserStatus;
  engine?: BrowserEngine;
  /**
   * Version of the engine corresponding to the browser version.
   */
  engine_version?: string;
}
export interface SimpleSupportStatement {
  version_added: VersionValue;
  /**
   * A string, indicating which browser version removed this feature.
   */
  version_removed?: string;
  /**
   * A string, indicating the last browser version that supported this feature. This is automatically generated.
   */
  version_last?: string;
  /**
   * A prefix to add to the sub-feature name (defaults to empty string). If applicable, leading and trailing '-' must be included.
   */
  prefix?: string;
  /**
   * 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 describing flags that must be configured for this browser to support this feature.
   *
   * @minItems 1
   */
  flags?: [FlagStatement, ...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.
   */
  impl_url?: string | [string, string, ...string[]];
  /**
   * 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?: true;
  /**
   * A string or array of strings containing additional information.
   */
  notes?: string | [string, string, ...string[]];
}
export interface FlagStatement {
  /**
   * An enum that indicates the flag type.
   */
  type: "preference" | "runtime_flag";
  /**
   * A string giving the name of the flag or preference that must be configured.
   */
  name: string;
  /**
   * A string giving the value which the specified flag must be set to for this feature to work.
   */
  value_to_set?: string;
}
/**
 * An object containing information about the stability of the feature.
 */
export interface StatusBlock {
  /**
   * @deprecated
   * (This property is deprecated. Prefer using more well-defined stability calculations, such as Baseline, instead.) A boolean value. Usually, this value is true for single-implementer features and false for multiple-implementer features or single-implementer features that are not expected to change.
   */
  experimental: boolean;
  /**
   * A boolean value indicating whether the feature is part of an active specification or specification process.
   */
  standard_track: boolean;
  /**
   * 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;
}
/**
 * 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.
 */
export interface CompatStatement {
  /**
   * Human-readable description of the feature.
   */
  description?: string;
  /**
   * Link to the MDN reference page documenting the feature.
   */
  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, string, ...string[]];
  /**
   * An optional array of strings allowing to assign tags to the feature.
   *
   * @minItems 1
   */
  tags?: [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;
  support: SupportBlock;
  status?: StatusBlock;
}

diff

diff --git a/before.d.ts b/after.d.ts
index fd09440..6c45e5b 100644
--- a/before.d.ts
+++ b/after.d.ts
@@ -8,8 +8,7 @@
  */
 
 /**
- * This interface was referenced by `BrowserDataFile`'s JSON-Schema
- * via the `definition` "browser_engine".
+ * Browser engine.
  */
 export type BrowserEngine =
   | "Blink"
@@ -20,7 +19,7 @@ export type BrowserEngine =
   | "WebKit"
   | "V8";
 /**
- * The names of the known browsers.
+ * Browser key (e.g. 'firefox', 'chrome_android', or 'webview_ios').
  */
 export type BrowserName =
   | "bun"
@@ -41,30 +40,19 @@ export type BrowserName =
   | "webview_android"
   | "webview_ios";
 /**
- * This interface was referenced by `BrowserDataFile`'s JSON-Schema
- * via the `definition` "browsers".
+ * Data for each known and tracked browser/runtime.
  */
 export type Browsers = Record<BrowserName, BrowserStatement>;
 
-/**
- * This interface was referenced by `BrowserDataFile`'s JSON-Schema
- * via the `definition` "browser_statement".
- */
 export interface BrowserStatement {
   /**
-   * The browser brand name (e.g. Firefox, Firefox Android, Chrome, etc.).
+   * Name of the browser (e.g. 'Firefox', 'Firefox Android', 'Chrome', etc.).
    */
   name: string;
-  /**
-   * The platform the browser runs on (e.g. desktop, mobile, XR, or server engine).
-   */
   type: BrowserType;
+  upstream?: UpstreamBrowserName;
   /**
-   * The upstream browser this browser derives from (e.g. Firefox Android is derived from Firefox, Edge is derived from Chrome).
-   */
-  upstream?: BrowserName;
-  /**
-   * The name of the browser's preview channel (e.g. 'Nightly' for Firefox or 'TP' for Safari).
+   * Name of the browser's preview channel (e.g. 'Nightly' for Firefox or 'TP' for Safari).
    */
   preview_name?: string;
   /**
@@ -82,11 +70,10 @@ export interface BrowserStatement {
   /**
    * The known versions of this browser.
    */
-  releases: { [version: string]: ReleaseStatement };
+  releases: Record<string, ReleaseStatement>;
 }
 /**
- * This interface was referenced by `BrowserDataFile`'s JSON-Schema
- * via the `definition` "browser_status".
+ * Lifetime cycle status of a browser release (e.g. 'current', 'retired', 'beta', 'nightly').
  */
 export type BrowserStatus =
   | "retired"
@@ -96,96 +83,45 @@ export type BrowserStatus =
   | "esr"
   | "planned";
 /**
- * This interface was referenced by `BrowserDataFile`'s JSON-Schema
- * via the `definition` "browser_type".
+ * Platform the browser runs on (e.g. desktop, mobile, XR, or server engine).
  */
 export type BrowserType = "desktop" | "mobile" | "xr" | "server";
 
+/**
+ * Shape of the `data.json` file in published BCD releases
+ */
 export interface CompatData {
-  /**
-   * Contains metadata for the current BCD information, such as the BCD version.
-   */
   __meta: MetaBlock;
-
-  /**
-   * Contains data for each [Web API](https://developer.mozilla.org/docs/Web/API) interface.
-   */
   api: Identifier;
-
-  /**
-   * Contains data for each known and tracked browser/engine.
-   */
   browsers: Browsers;
-
-  /**
-   * Contains data for [CSS](https://developer.mozilla.org/docs/Web/CSS) properties, selectors, and at-rules.
-   */
   css: Identifier;
-
-  /**
-   * Contains data for [HTML](https://developer.mozilla.org/docs/Web/HTML) elements, attributes, and global attributes.
-   */
   html: Identifier;
-
-  /**
-   * Contains data for [HTTP](https://developer.mozilla.org/docs/Web/HTTP) headers, statuses, and methods.
-   */
   http: Identifier;
-
-  /**
-   * Contains data for [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript) built-in Objects, statement, operators, and other ECMAScript language features.
-   */
   javascript: Identifier;
-
-  /**
-   * Contains data for various manifests, such as the [Web Application Manifest](https://developer.mozilla.org/docs/Web/Progressive_web_apps/manifest).
-   */
   manifests: Identifier;
-
-  /**
-   * Contains data for [MathML](https://developer.mozilla.org/docs/Web/MathML) elements, attributes, and global attributes.
-   */
   mathml: Identifier;
-
-  /**
-   * Contains data for [Media types](https://developer.mozilla.org/docs/Web/HTTP/Guides/MIME_types).
-   */
   mediatypes: Identifier;
-
-  /**
-   * Contains data for [SVG](https://developer.mozilla.org/docs/Web/SVG) elements, attributes, and global attributes.
-   */
   svg: Identifier;
-
-  /**
-   * Contains data for [WebAssembly](https://developer.mozilla.org/docs/WebAssembly) features.
-   */
   webassembly: Identifier;
-
-  /**
-   * Contains data for [WebDriver](https://developer.mozilla.org/docs/Web/WebDriver) commands.
-   */
   webdriver: Identifier;
-
-  /**
-   * Contains data for [WebExtensions](https://developer.mozilla.org/Add-ons/WebExtensions) JavaScript APIs and manifest keys.
-   */
   webextensions: Identifier;
 }
 /**
- * This interface was referenced by `CompatDataFile`'s JSON-Schema definition
- * via the `patternProperty` "^__compat$".
+ * 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.
  *
- * This interface was referenced by `CompatDataFile`'s JSON-Schema
- * via the `definition` "compat_statement".
+ * 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.
  */
 export interface CompatStatement {
   /**
-   * A string containing a human-readable description of the feature.
+   * 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.
+   * Link to the MDN reference page documenting the feature.
    */
   mdn_url?: string;
   /**
@@ -201,14 +137,10 @@ export interface CompatStatement {
   /**
    * 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;
+  source_file: string;
   support: SupportBlock;
   status?: StatusBlock;
 }
-/**
- * This interface was referenced by `CompatDataFile`'s JSON-Schema
- * via the `definition` "flag_statement".
- */
 export interface FlagStatement {
   /**
    * An enum that indicates the flag type.
@@ -223,25 +155,18 @@ export interface FlagStatement {
    */
   value_to_set?: string;
 }
-/**
- * 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;
+
+export type Identifier = { __compat?: CompatStatement } & {
+  [key: string]: Identifier;
 };
 
+/**
+ * Metadata of the present BCD data.
+ */
 export interface MetaBlock {
   version: string;
   timestamp: string;
 }
-/**
- * This interface was referenced by `BrowserDataFile`'s JSON-Schema
- * via the `definition` "release_statement".
- */
 export interface ReleaseStatement {
   /**
    * The date on which this version was released, formatted as `YYYY-MM-DD`.
@@ -251,27 +176,14 @@ export interface ReleaseStatement {
    * A link to the release notes or changelog for a given release.
    */
   release_notes?: string;
-  /**
-   * A property indicating where in the lifetime cycle this release is in (e.g. current, retired, beta, nightly).
-   */
   status: BrowserStatus;
-  /**
-   * Name of the browser's underlying engine.
-   */
   engine?: BrowserEngine;
   /**
    * Version of the engine corresponding to the browser version.
    */
   engine_version?: string;
 }
-/**
- * This interface was referenced by `CompatDataFile`'s JSON-Schema
- * via the `definition` "simple_support_statement".
- */
 export interface SimpleSupportStatement {
-  /**
-   * A string (indicating which browser version added this feature), or the value false (indicating the feature is not supported).
-   */
   version_added: VersionValue;
   /**
    * A string, indicating which browser version removed this feature.
@@ -330,10 +242,6 @@ export interface StatusBlock {
  * 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.
  */
 export type SupportBlock = Partial<Record<BrowserName, SupportStatement>>;
-/**
- * This interface was referenced by `CompatDataFile`'s JSON-Schema
- * via the `definition` "support_statement".
- */
 export type SupportStatement =
   | SimpleSupportStatement
   | [
@@ -341,5 +249,16 @@ export type SupportStatement =
       SimpleSupportStatement,
       ...SimpleSupportStatement[],
     ];
-
+/**
+ * Upstream browser key (e.g. 'firefox' or 'chrome_android').
+ */
+export type UpstreamBrowserName =
+  | "chrome"
+  | "chrome_android"
+  | "firefox"
+  | "safari"
+  | "safari_ios";
+/**
+ * A string (indicating which browser version added this feature), or the value false (indicating the feature is not supported).
+ */
 export type VersionValue = string | false;

Related issues

Fixes #29059.

github-actions · 2026-02-13T10:40:15Z

Tip: Review these changes grouped by change (recommended for most PRs), or grouped by feature (for large PRs).

Otherwise `ajv` rejects the value for not being a string.

- Avoid unnecessary `tsType`. - Avoid descriptions next to `$ref` (causes duplicate types). - Refine descriptions.

Compares build output between PR and base.

Same format as other two schema descriptions.

ddbeck

Partial review here, but I'm done for the day, so I'll leave it at that. There's plenty to chew on already though.

ddbeck · 2026-02-18T17:29:57Z

.github/workflows/test.yml

+      - name: Checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2


All of the name: additions are pretty pointless here. Not sure why any are in this PR.

ddbeck · 2026-02-18T17:31:15Z

.vscode/settings.json

    }
-  ]
+  ],
+  "typescript.tsdk": "node_modules/typescript/lib"


What is this for?

ddbeck · 2026-02-18T17:31:59Z

lint/fixer/common-errors.js

 * - Replaces `browser: { version_added: "mirror" }` with `browser: "mirror"`
 * - Wraps `browser: false` with `browser: `{ version_added: false }`
- * @param {CompatStatement} compat The compat statement to fix
+ * @param {Pick<InternalCompatStatement, "support">} compat The compat statement to fix


Suggested change

* @param {Pick<InternalCompatStatement, "support">} compat The compat statement to fix

* @param {Pick<InternalCompatStatement, "support">} compat The support block to fix

ddbeck · 2026-02-18T17:36:47Z

lint/fixer/status.test.js

 import { fixStatusValue } from './status.js';

-/** @type {{ name: string; input: TestValue; output: TestValue }[]} */
+/** @type {{ name: string; input: *; output: * }[]} */


Eh, why go any here? Why not use the new types?

ddbeck · 2026-02-18T17:46:43Z

index.js

-export default await load(...dataFolders);
+/** @type {InternalCompatData} */
+const bcd = await load(...dataFolders);
+
+export default bcd;
+
+/** @type {Browsers} */
+export const browsers = bcd.browsers;


I don't understand this change. Can you explain this?

ddbeck · 2026-02-18T18:42:03Z

schemas/public.schema.json

+        },
+        "flags": {
+          "type": "array",
+          "description": "An optional array of objects describing flags that must be configured for this browser to support this feature.",


Suggested change

"description": "An optional array of objects describing flags that must be configured for this browser to support this feature.",

"description": "Array of objects describing flags that must be configured for this browser to support this feature",

ddbeck · 2026-02-18T18:43:35Z

schemas/public.schema.json

+              }
+            }
+          ],
+          "description": "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.",


Suggested change

"description": "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.",

"description": "A version control URL for the revision which implemented the feature or a bug URL for tracking implementation",

ddbeck · 2026-02-18T18:45:58Z

schemas/public.schema.json

+          "errorMessage": {
+            "pattern": "impl_url must be a link to a browser commit or bug URL. URLs must be in shortened form (ex. bugs.chromium.org -> crbug.com). Note: `npm run fix` may resolve these issues."
+          }


I don't believe this is a JSON Schema field and I don't think we should bother public consumers with text about internal tools.

ddbeck · 2026-02-18T18:49:58Z

schemas/public.schema.json

+        },
+        "partial_implementation": {
+          "const": true,
+          "description": "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)."


This is very long. Another approach here (though one that requires a bit of work elsewhere) would be to break this up into title and description.

Other things:

It shouldn't default to anything. It should be optional and never any value but true

Avoid putting internal guidance into the public schema

Suggested change

"description": "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)."

"description": "Set if implementation of the subfeature is notably incomplete or broken."

ddbeck · 2026-02-18T18:52:20Z

schemas/public.schema.json

+      "dependencies": {
+        "partial_implementation": {
+          "if": {
+            "properties": { "partial_implementation": { "const": true } }
+          },
+          "then": { "required": ["notes"] }
+        },
+        "version_removed": {
+          "required": ["version_last"]
+        }


This is not real JSON Schema. Why did you write this? Who did you expect to consume this data?

caugner mentioned this pull request Feb 13, 2026

ci(test): add diff-build job #29042

Open

caugner force-pushed the public-schema branch from d706910 to 16892e6 Compare February 13, 2026 13:31

github-actions bot added linter Issues or pull requests regarding the tests / linter of the JSON files. bulk_update An update to a mass amount of data, or scripts/linters related to such changes size:xl [PR only] >1000 LoC changed and removed size:l [PR only] 101-1000 LoC changed labels Feb 13, 2026

caugner added 19 commits February 14, 2026 00:38

feat(schemas): add public schema

a59af28

chore(scripts/build): validate with public schema

b94173e

fix(scripts/build): convert Date to string explicitly

6e38d63

Otherwise `ajv` rejects the value for not being a string.

fix(schemas/browsers): restore "maxProperties"

5141563

fix(schemas): remove version_last from internal schema

6aab32a

fix(schemas): remove "mirror" from public schema

58bc695

chore(schemas): rename internal types that differ

02512b2

chore(scripts/generate-types): use public schema

e87f7f8

chore(schemas): refine public schema

e6ec3f1

- Avoid unnecessary `tsType`. - Avoid descriptions next to `$ref` (causes duplicate types). - Refine descriptions.

ci(test): add diff-build job

3625d24

Compares build output between PR and base.

ci(test): add step names

9c40066

fix(scripts/generate-types): generate internal types as well

bd382c9

chore(scripts/build): use new public type

02fe4a2

chore: fix internal type usages

212d293

chore(vscode): use TS version from workspace

4869566

chore(schemas): refine browsers schema

b9028b7

fix(generate-types): keep types.d.ts for internal types

8048401

fix(schemas): remove source_file from internal schema

46185f4

chore(types): remove manual types

b737787

caugner added 4 commits February 14, 2026 00:38

fix(schemas): refine internal schema

252bb46

chore: fix internal schema usage

02c1290

chore: fix ESLint errors

154e7fb

fixup! chore(schemas): refine public schema

fe10aa9

caugner force-pushed the public-schema branch from 225c0dd to fe10aa9 Compare February 13, 2026 23:40

caugner added 7 commits February 14, 2026 00:42

fixup! chore: fix internal type usages

2a320b4

fixup! fixup! chore: fix internal type usages

6d3341f

Merge branch 'main' into public-schema

5444400

chore(schemas): make SupportBlock partial

bbffdde

fix(schemas): replace patternProperties on root

0133009

fix(schemas): use intersection type

6fce3da

chore(schemas): prefer Record over index type

eb86b1a

caugner changed the title ~~feat(schemas): add public schema~~ feat(schemas): separate public from internal schema Feb 16, 2026

caugner marked this pull request as ready for review February 16, 2026 19:59

caugner requested review from a team as code owners February 16, 2026 19:59

caugner requested a review from LeoMcA February 16, 2026 19:59

caugner added 4 commits February 17, 2026 09:39

fixup! fix(generate-types): keep types.d.ts for internal types

4c78d36

refactor: rename types/{types => internal}.d.ts

613889f

chore(schemas): sync existing docs

a78207a

fixup! fix(schemas): refine internal schema

57f2f8c

github-actions bot added the docs Issues or pull requests regarding the documentation of this project. label Feb 17, 2026

caugner added 2 commits February 17, 2026 16:35

docs(schemas): describe public schema

5bb0dc4

Same format as other two schema descriptions.

docs(schemas): sync internal schema docs

a64f7d6

caugner added the semver-major-bump A change that is potentially breaking for consumers label Feb 17, 2026

chore(scripts/generate-types): clean up old types

c43fb41

ddbeck requested changes Feb 18, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(schemas): separate public from internal schema#29041

feat(schemas): separate public from internal schema#29041
caugner wants to merge 37 commits intomainfrom
public-schema

caugner commented Feb 13, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 13, 2026 •

edited

Loading

Uh oh!

ddbeck left a comment

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

ddbeck Feb 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

		- name: Checkout
		uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

	* @param {Pick<InternalCompatStatement, "support">} compat The compat statement to fix
	* @param {Pick<InternalCompatStatement, "support">} compat The support block to fix

	"description": "An optional array of objects describing flags that must be configured for this browser to support this feature.",
	"description": "Array of objects describing flags that must be configured for this browser to support this feature",

	"description": "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.",
	"description": "A version control URL for the revision which implemented the feature or a bug URL for tracking implementation",

Conversation

caugner commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test results and supporting details

Related issues

Uh oh!

github-actions bot commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ddbeck left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

caugner commented Feb 13, 2026 •

edited

Loading

github-actions bot commented Feb 13, 2026 •

edited

Loading