Update README and tweak format of getAllVersions() outputs

Author: tonypconway

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

src/scripts/baseline-browser-versions.ts

@@ -48,14 +48,14 @@ type BrowserVersion = {
 
 interface AllBrowsersBrowserVersion extends BrowserVersion {
   year: number;
-  waCompatible: boolean;
+  wa_compatible: boolean;
 }
 
 type NestedBrowserVersions = {
   [browser: string]: {
     [version: string]: {
       year: number;
-      waCompatible: boolean;
+      wa_compatible: boolean;
       release_date?: string;
       engine?: string;
       engine_version?: string;
@@ -129,10 +129,10 @@ const compareVersions = (
   if (!incomingVersionStringMajor || !previousVersionStringMajor) {
     throw new Error(
       "One of these version strings is broken: " +
-        incomingVersionString +
-        " or " +
-        previousVersionString +
-        "",
+      incomingVersionString +
+      " or " +
+      previousVersionString +
+      "",
     );
   }
 
@@ -145,10 +145,10 @@ const compareVersions = (
   if (incomingVersionStringMinor) {
     if (
       parseInt(incomingVersionStringMajor) ==
-        parseInt(previousVersionStringMajor) &&
+      parseInt(previousVersionStringMajor) &&
       (!previousVersionStringMinor ||
         parseInt(incomingVersionStringMinor) >
-          parseInt(previousVersionStringMinor))
+        parseInt(previousVersionStringMinor))
     ) {
       return 1;
     }
@@ -525,12 +525,12 @@ export function getAllVersions(
             : thisBrowserAllVersions.slice(0, sliceIndex);
 
         subArray.forEach((version) => {
-          let isWaCompatible =
+          let iswa_compatible =
             compareVersions(version.version, waVersion) >= 0 ? true : false;
           outputArray.push({
             ...version,
             year: year - 1,
-            waCompatible: isWaCompatible,
+            wa_compatible: iswa_compatible,
           });
         });
 
@@ -555,7 +555,7 @@ export function getAllVersions(
         outputArray.push({
           ...version,
           year: correspondingChromiumVersion.year,
-          waCompatible: correspondingChromiumVersion.waCompatible,
+          wa_compatible: correspondingChromiumVersion.wa_compatible,
         });
       }
     });
@@ -581,7 +581,7 @@ export function getAllVersions(
       //@ts-ignore
       outputObject[version.browser][version.version] = {
         year: version.year,
-        waCompatible: version.waCompatible,
+        wa_compatible: version.wa_compatible,
         release_date: version.release_date,
         engine: version.engine,
         engine_version: version.engine_version,
@@ -592,19 +592,19 @@ export function getAllVersions(
   }
 
   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;