baseline-browser-mapping 2.2.2 → 2.3.0

package/README.md

@@ -165,16 +165,34 @@ By default, this function returns an `Array` of `Objects` and excludes downstrea
 [
   ...
   {
-    browser: 'chrome_android', // Browser name
-    version: '68', // Browser version as a string
-    release_date: '2018-07-24', // Release date
-    year: 2019, //Baseline year feature set the version supports
-    waCompatible: false // Boolean indicating whether the version is compatible with Baseline Widely available
+    browser: "firefox_android", // Browser name
+    version: "125", // Browser version
+    release_date: "2024-04-16", // Release date
+    year: 2023, // Baseline year feature set the version supports
+    wa_compatible: true // Whether the browser version supports Widely available
   },
   ...
 ]
 ```
 
+### Understanding which browsers support Newly available features
+
+You may want to understand which recent browser versions support all Newly available features. You can replace the `wa_compatible` property with a `supports` property using the `useSupport` option:
+
+```javascript
+getAllVersions({
+  useSupports: true,
+});
+```
+
+The `supports` property has three possible values:
+
+- `year_only` for browser versions that do not support all Baseline Widely available Newly Available features.
+- `widely` for browser versions that support all Widely available features.
+- `newly` for browser versions that support all Newly available features.
+
+Browser versions that support all Newly available features also support all Widely available features.
+
 ### `getAllVersions()` Configuration options
 
 `getAllVersions()` accepts an `Object` as an argument with configuration options. The defaults are as follows:
@@ -202,13 +220,13 @@ Downstream browsers include the same properties as core browsers, as well as the
 [
   ...
   {
-    "browser": "samsunginternet_android",
-    "version": "18.0",
-    "release_date": "2022-08-08",
-    "engine": "Blink",
-    "engine_version": "99",
-    "year": 2021,
-    "waCompatible": false
+    browser: "samsunginternet_android",
+    version: "27.0",
+    release_date: "2024-11-06",
+    engine: "Blink",
+    engine_version: "125",
+    year: 2023,
+    supports: "widely"
   },
   ...
 ]
@@ -233,7 +251,7 @@ In thise case, `getAllVersions()` returns a nested object with the browser [IDs
   "chrome": {
     "53": {
       "year": 2016,
-      "wa_compatible": false,
+      "supports": "year_only",
       "release_date": "2016-09-07"
     },
     ...
@@ -248,7 +266,7 @@ Downstream browsers will include extra fields for `engine` and `engine_versions`
   "webview_android": {
     "53": {
       "year": 2016,
-      "waCompatible": false,
+      "supports": "year_only",
       "release_date": "2016-09-07",
       "engine": "Blink",
       "engine_version": "53"
@@ -268,10 +286,13 @@ getAllVersions({
 `getAllVersions` returns a `String` with a header row and comma-separated values for each browser version that you can write to a file or pass to another service. Core browsers will have "NULL" as the value for their `engine` and `engine_version`:
 
 ```csv
-"browser","version","year","wa_compatible","release_date","engine","engine_version"
-"chrome","53","2016","false","2016-09-07","NULL","NULL"
+"browser","version","year","supports","release_date","engine","engine_version"
+"chrome","53","2016","year_only","2016-09-07","NULL","NULL"
+...
+"firefox","135","2024","widely","2025-02-04","NULL","NULL"
+"firefox","136","2024","newly","2025-03-04","NULL","NULL"
 ...
-"ya_android","20.12","2020","false","2020-12-20","Blink","87"
+"ya_android","20.12","2020","year_only","2020-12-20","Blink","87"
 ...
 ```
 
@@ -286,10 +307,18 @@ The outputs of `getAllVersions()` are available as JSON or CSV files generated o
   - [Array](https://web-platform-dx.github.io/baseline-browser-mapping/all_versions_array.json)
   - [Object](https://web-platform-dx.github.io/baseline-browser-mapping/all_versions_object.json)
   - [CSV](https://web-platform-dx.github.io/baseline-browser-mapping/all_versions.csv)
+    Core browsers only, with `supports` property
+  - [Array](https://web-platform-dx.github.io/baseline-browser-mapping/all_versions_array_with_supports.json)
+  - [Object](https://web-platform-dx.github.io/baseline-browser-mapping/all_versions_object_with_supports.json)
+  - [CSV](https://web-platform-dx.github.io/baseline-browser-mapping/all_versions_with_supports.csv)
 - Including downstream browsers
   - [Array](https://web-platform-dx.github.io/baseline-browser-mapping/with_downstream/all_versions_array.json)
   - [Object](https://web-platform-dx.github.io/baseline-browser-mapping/with_downstream/all_versions_object.json)
   - [CSV](https://web-platform-dx.github.io/baseline-browser-mapping/with_downstream/all_versions.csv)
+- Including downstream browsers with `supports` property
+  - [Array](https://web-platform-dx.github.io/baseline-browser-mapping/with_downstream/all_versions_array_with_supports.json)
+  - [Object](https://web-platform-dx.github.io/baseline-browser-mapping/with_downstream/all_versions_object_with_supports.json)
+  - [CSV](https://web-platform-dx.github.io/baseline-browser-mapping/with_downstream/all_versions_with_supports.csv)
 
 These files are updated on a daily basis.
 

package/dist/scripts/baseline-browser-versions.d.ts

@@ -7,17 +7,12 @@ type BrowserVersion = {
 };
 interface AllBrowsersBrowserVersion extends BrowserVersion {
     year: number;
-    wa_compatible: boolean;
+    supports?: string;
+    wa_compatible?: boolean;
 }
 type NestedBrowserVersions = {
     [browser: string]: {
-        [version: string]: {
-            year: number;
-            wa_compatible: boolean;
-            release_date?: string;
-            engine?: string;
-            engine_version?: string;
-        };
+        [version: string]: AllBrowsersBrowserVersion;
     };
 };
 type Options = {
@@ -65,6 +60,11 @@ type AllVersionsOptions = {
      * Defaults to `false`.
      */
     includeDownstreamBrowsers?: boolean;
+    /**
+     * Whether to use the new "supports" property in place of "wa_compatible"
+     * Defaults to `false`
+     */
+    useSupports?: boolean;
 };
 /**
  * Returns all browser versions known to this module with their level of Baseline support either as an `Array` or a `String` CSV.

package/dist/scripts/baseline-browser-versions.js

@@ -273,6 +273,7 @@ export function getAllVersions(userOptions) {
     let options = {
         outputFormat: incomingOptions.outputFormat ?? "array",
         includeDownstreamBrowsers: incomingOptions.includeDownstreamBrowsers ?? false,
+        useSupports: incomingOptions.useSupports ?? false,
     };
     let nextYear = new Date().getFullYear() + 1;
     const yearArray = [...Array(nextYear).keys()].slice(2016);
@@ -289,6 +290,15 @@ export function getAllVersions(userOptions) {
     waMinimumVersions.forEach((version) => {
         waObject[version.browser] = version;
     });
+    const thirtyMonthsFromToday = new Date();
+    thirtyMonthsFromToday.setMonth(thirtyMonthsFromToday.getMonth() + 30);
+    const naMinimumVersions = getCompatibleVersions({
+        widelyAvailableOnDate: thirtyMonthsFromToday.toISOString().slice(0, 10),
+    });
+    const naObject = {};
+    naMinimumVersions.forEach((version) => {
+        naObject[version.browser] = version;
+    });
     const allVersions = getCompatibleVersions({
         targetYear: 2016,
         listAllCompatibleVersions: true,
@@ -301,6 +311,7 @@ export function getAllVersions(userOptions) {
             return compareVersions(a.version, b.version);
         });
         let waVersion = waObject[browserName]?.version ?? "0";
+        let naVersion = naObject[browserName]?.version ?? "0";
         yearArray.forEach((year) => {
             if (yearMinimumVersions[year]) {
                 let minBrowserVersionInfo = yearMinimumVersions[year][browserName] ?? {
@@ -312,12 +323,30 @@ export function getAllVersions(userOptions) {
                     ? thisBrowserAllVersions
                     : thisBrowserAllVersions.slice(0, sliceIndex);
                 subArray.forEach((version) => {
-                    let iswa_compatible = compareVersions(version.version, waVersion) >= 0 ? true : false;
-                    outputArray.push({
+                    let isWaCcompatible = compareVersions(version.version, waVersion) >= 0 ? true : false;
+                    let isNaCompatible = compareVersions(version.version, naVersion) >= 0 ? true : false;
+                    let versionToPush = {
                         ...version,
                         year: year - 1,
-                        wa_compatible: iswa_compatible,
-                    });
+                    };
+                    if (options.useSupports) {
+                        let supports = "year_only";
+                        if (isWaCcompatible && isNaCompatible)
+                            supports = "newly";
+                        if (isWaCcompatible && !isNaCompatible)
+                            supports = "widely";
+                        versionToPush = {
+                            ...versionToPush,
+                            supports: supports,
+                        };
+                    }
+                    else {
+                        versionToPush = {
+                            ...versionToPush,
+                            wa_compatible: isWaCcompatible,
+                        };
+                    }
+                    outputArray.push(versionToPush);
                 });
                 thisBrowserAllVersions = thisBrowserAllVersions.slice(sliceIndex, thisBrowserAllVersions.length);
             }
@@ -329,11 +358,20 @@ export function getAllVersions(userOptions) {
             let correspondingChromiumVersion = outputArray.find((upstreamVersion) => upstreamVersion.browser === "chrome" &&
                 upstreamVersion.version === version.engine_version);
             if (correspondingChromiumVersion) {
-                outputArray.push({
-                    ...version,
-                    year: correspondingChromiumVersion.year,
-                    wa_compatible: correspondingChromiumVersion.wa_compatible,
-                });
+                if (options.useSupports) {
+                    outputArray.push({
+                        ...version,
+                        year: correspondingChromiumVersion.year,
+                        supports: correspondingChromiumVersion.supports,
+                    });
+                }
+                else {
+                    outputArray.push({
+                        ...version,
+                        year: correspondingChromiumVersion.year,
+                        wa_compatible: correspondingChromiumVersion.wa_compatible,
+                    });
+                }
             }
         });
     }
@@ -354,30 +392,43 @@ export function getAllVersions(userOptions) {
             if (!outputObject[version.browser]) {
                 outputObject[version.browser] = {};
             }
-            //@ts-ignore
-            outputObject[version.browser][version.version] = {
+            let versionToAdd = {
                 year: version.year,
-                wa_compatible: version.wa_compatible,
                 release_date: version.release_date,
                 engine: version.engine,
                 engine_version: version.engine_version,
             };
+            //@ts-ignore
+            outputObject[version.browser][version.version] = options.useSupports
+                ? { ...versionToAdd, supports: version.supports }
+                : { ...versionToAdd, wa_compatible: version.wa_compatible };
         });
         return outputObject ?? {};
     }
     if (options.outputFormat === "csv") {
-        let outputString = `"browser","version","year","wa_compatible","release_date","engine","engine_version"`;
+        let outputString = `"browser","version","year",` +
+            `"${options.useSupports ? "supports" : "wa_compatible"}",` +
+            `"release_date","engine","engine_version"`;
         outputArray.forEach((version) => {
             let outputs = {
                 browser: version.browser,
                 version: version.version,
                 year: version.year,
-                wa_compatible: version.wa_compatible,
                 release_date: version.release_date ?? "NULL",
                 engine: version.engine ?? "NULL",
                 engine_version: version.engine_version ?? "NULL",
             };
-            outputString += `\n"${outputs.browser}","${outputs.version}","${outputs.year}","${outputs.wa_compatible}","${outputs.release_date}","${outputs.engine}","${outputs.engine_version}"`;
+            outputs = options.useSupports
+                ? { ...outputs, supports: version.supports }
+                : { ...outputs, wa_compatible: version.wa_compatible };
+            outputString +=
+                `\n"${outputs.browser}","` +
+                    `${outputs.version}","` +
+                    `${outputs.year}","` +
+                    `${options.useSupports ? outputs.supports : outputs.wa_compatible}","` +
+                    `${outputs.release_date}","` +
+                    `${outputs.engine}","` +
+                    `${outputs.engine_version}"`;
         });
         return outputString;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "baseline-browser-mapping",
-  "version": "2.2.2",
+  "version": "2.3.0",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": "./dist/index.js"
@@ -21,11 +21,11 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@mdn/browser-compat-data": "^6.0.1",
-    "web-features": "^2.31.0"
+    "@mdn/browser-compat-data": "^6.0.9",
+    "web-features": "^2.34.1"
   },
   "devDependencies": {
-    "@types/node": "^22.13.5",
+    "@types/node": "^22.15.3",
     "prettier": "^3.5.3",
     "typescript": "^5.7.2"
   },