baseline-browser-mapping 2.2.0 → 2.2.2

package/README.md

@@ -216,7 +216,48 @@ Downstream browsers include the same properties as core browsers, as well as the
 
 #### `outputFormat`
 
-By default, this function returns an `Array` of `Objects` which can be manipulated in Javascript or output to JSON. To return a `String` in CSV format, set `outputFormat` to `csv`:
+By default, this function returns an `Array` of `Objects` which can be manipulated in Javascript or output to JSON.
+
+To return an `Object` that nests keys , set `outputFormat` to `object`:
+
+```javascript
+getAllVersions({
+  outputFormat: "object",
+});
+```
+
+In thise case, `getAllVersions()` returns a nested object with the browser [IDs listed below](#list-of-downstream-browsers) as keys, and versions as keys within them:
+
+```javascript
+{
+  "chrome": {
+    "53": {
+      "year": 2016,
+      "wa_compatible": false,
+      "release_date": "2016-09-07"
+    },
+    ...
+}
+```
+
+Downstream browsers will include extra fields for `engine` and `engine_versions`
+
+```javascript
+{
+  ...
+  "webview_android": {
+    "53": {
+      "year": 2016,
+      "waCompatible": false,
+      "release_date": "2016-09-07",
+      "engine": "Blink",
+      "engine_version": "53"
+    },
+  ...
+}
+```
+
+To return a `String` in CSV format, set `outputFormat` to `csv`:
 
 ```javascript
 getAllVersions({
@@ -227,7 +268,7 @@ 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","waCompatible","release_date","engine","engine_version"
+"browser","version","year","wa_compatible","release_date","engine","engine_version"
 "chrome","53","2016","false","2016-09-07","NULL","NULL"
 ...
 "ya_android","20.12","2020","false","2020-12-20","Blink","87"
@@ -237,6 +278,21 @@ getAllVersions({
 > [!NOTE]
 > The above example uses `"includeDownstreamBrowsers": true`
 
+### Static resources
+
+The outputs of `getAllVersions()` are available as JSON or CSV files generated on a daily basis and hosted on GitHub pages:
+
+- Core browsers only
+  - [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)
+- 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)
+
+These files are updated on a daily basis.
+
 ## Downstream browsers
 
 ### Limitations

package/dist/data/downstream-browsers.json

@@ -995,6 +995,12 @@
                     "engine_version": "100",
                     "status": "unknown",
                     "release_date": "2025-02-26"
+                },
+                "17.5": {
+                    "engine": "Blink",
+                    "engine_version": "100",
+                    "status": "unknown",
+                    "release_date": "2025-04-08"
                 }
             }
         },
@@ -1498,5 +1504,5 @@
             }
         }
     },
-    "lastUpdated": "2025-02-26T14:04:04.566Z"
+    "lastUpdated": "2025-04-09T14:12:33.205Z"
 }

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

@@ -7,8 +7,19 @@ type BrowserVersion = {
 };
 interface AllBrowsersBrowserVersion extends BrowserVersion {
     year: number;
-    waCompatible: boolean;
+    wa_compatible: boolean;
 }
+type NestedBrowserVersions = {
+    [browser: string]: {
+        [version: string]: {
+            year: number;
+            wa_compatible: boolean;
+            release_date?: string;
+            engine?: string;
+            engine_version?: string;
+        };
+    };
+};
 type Options = {
     /**
      * Whether to include only the minimum compatible browser versions or all compatible versions.
@@ -59,7 +70,7 @@ type AllVersionsOptions = {
  * Returns all browser versions known to this module with their level of Baseline support either as an `Array` or a `String` CSV.
  * Takes an object as an argument with two optional properties:
  * - `includeDownstreamBrowsers`: `true` (default) or `false`
- * - `outputFormat`: `array` (default) or `csv`
+ * - `outputFormat`: `array` (default), `object` or `csv`
  */
-export declare function getAllVersions(userOptions?: AllVersionsOptions): AllBrowsersBrowserVersion[] | string;
+export declare function getAllVersions(userOptions?: AllVersionsOptions): AllBrowsersBrowserVersion[] | NestedBrowserVersions | string;
 export {};

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

@@ -249,7 +249,7 @@ export function getCompatibleVersions(userOptions) {
     }
     // Sets a cutoff date for feature interoperability 30 months before the stated date
     if (options.widelyAvailableOnDate || options.targetYear === undefined) {
-        targetDate.setMonth(new Date().getMonth() - 30);
+        targetDate.setMonth(targetDate.getMonth() - 30);
     }
     let coreBrowserArray = getCoreVersionsByDate(targetDate, options.listAllCompatibleVersions);
     if (options.includeDownstreamBrowsers === false) {
@@ -266,7 +266,7 @@ export function getCompatibleVersions(userOptions) {
  * Returns all browser versions known to this module with their level of Baseline support either as an `Array` or a `String` CSV.
  * Takes an object as an argument with two optional properties:
  * - `includeDownstreamBrowsers`: `true` (default) or `false`
- * - `outputFormat`: `array` (default) or `csv`
+ * - `outputFormat`: `array` (default), `object` or `csv`
  */
 export function getAllVersions(userOptions) {
     let incomingOptions = userOptions ?? {};
@@ -312,11 +312,11 @@ export function getAllVersions(userOptions) {
                     ? thisBrowserAllVersions
                     : thisBrowserAllVersions.slice(0, sliceIndex);
                 subArray.forEach((version) => {
-                    let isWaCompatible = compareVersions(version.version, waVersion) >= 0 ? true : false;
+                    let iswa_compatible = compareVersions(version.version, waVersion) >= 0 ? true : false;
                     outputArray.push({
                         ...version,
                         year: year - 1,
-                        waCompatible: isWaCompatible,
+                        wa_compatible: iswa_compatible,
                     });
                 });
                 thisBrowserAllVersions = thisBrowserAllVersions.slice(sliceIndex, thisBrowserAllVersions.length);
@@ -332,7 +332,7 @@ export function getAllVersions(userOptions) {
                 outputArray.push({
                     ...version,
                     year: correspondingChromiumVersion.year,
-                    waCompatible: correspondingChromiumVersion.waCompatible,
+                    wa_compatible: correspondingChromiumVersion.wa_compatible,
                 });
             }
         });
@@ -348,19 +348,36 @@ export function getAllVersions(userOptions) {
             return compareVersions(a.version, b.version);
         }
     });
+    if (options.outputFormat === "object") {
+        const outputObject = {};
+        outputArray.forEach((version) => {
+            if (!outputObject[version.browser]) {
+                outputObject[version.browser] = {};
+            }
+            //@ts-ignore
+            outputObject[version.browser][version.version] = {
+                year: version.year,
+                wa_compatible: version.wa_compatible,
+                release_date: version.release_date,
+                engine: version.engine,
+                engine_version: version.engine_version,
+            };
+        });
+        return outputObject ?? {};
+    }
     if (options.outputFormat === "csv") {
-        let outputString = `"browser","version","year","waCompatible","release_date","engine","engine_version"`;
+        let outputString = `"browser","version","year","wa_compatible","release_date","engine","engine_version"`;
         outputArray.forEach((version) => {
             let outputs = {
                 browser: version.browser,
                 version: version.version,
                 year: version.year,
-                waCompatible: version.waCompatible,
+                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.waCompatible}","${outputs.release_date}","${outputs.engine}","${outputs.engine_version}"`;
+            outputString += `\n"${outputs.browser}","${outputs.version}","${outputs.year}","${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.0",
+  "version": "2.2.2",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": "./dist/index.js"
@@ -16,7 +16,8 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepare": "rm -rf dist; prettier . --write; tsc",
-    "refresh-downstream": "npx tsx scripts/refresh-downstream.ts"
+    "refresh-downstream": "npx tsx scripts/refresh-downstream.ts",
+    "refresh-static": "npx tsx scripts/refresh-static.ts"
   },
   "license": "Apache-2.0",
   "dependencies": {
@@ -28,5 +29,5 @@
     "prettier": "^3.5.3",
     "typescript": "^5.7.2"
   },
-  "repository": "web-platform-dx/baseline-browser-mapping"
+  "repository": "git+https://github.com/web-platform-dx/baseline-browser-mapping.git"
 }