baseline-browser-mapping 0.2.1 → 0.2.3

package/README.md

@@ -14,14 +14,22 @@ The browser versions in this module come from two different sources:
 
 MDN `browser-compat-data` is an authoritative source of information for the browsers it contains. The release dates for the Baseline core browser set and the mapping of downstream browsers to Chromium versions should be considered accurate.
 
-Browser mappings from useragents.io are provided on a best effort basis. They assume that browser vendors are accurately stating the Chromium version they have implemented.
+> **Note**
+> At present, the selection criteria for core browser versions compatible with a given feature set is: the final version of each browser prior to the cut off date for that feature set. In the case of Widely Available, this is 30 months in the past and in the case of Baseline years, this is the end of the year specified. In future, when the `web-features` repository is data complete, it should be possible to determine if earlier browser versions support the specified feature set.
 
-> **TODO** Add details on how downstream mappings were created and are updated once script and action are in place and tested in @tonypconway 's fork.
+Browser mappings from useragents.io are provided on a best effort basis. They assume that browser vendors are accurately stating the Chromium version they have implemented. The initial set of version mappings was derived from a bulk export in November 2024. This version was iterated over with a Regex match looking for a major Chrome version and a corresponding version of the browser in question, e.g.:
 
-Unfortunately, useragents.io does not have "first seen" dates prior to June 2020. However, these browsers' Baseline compatibility is determined by their Chromium version, so their release dates are more informative than critical.
+`Mozilla/5.0 (Linux; U; Android 10; en-US; STK-L21 Build/HUAWEISTK-L21) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/100.0.4896.58 UCBrowser/13.8.2.1324 Mobile Safari/537.36`
 
-> **Note**
-> At present, the selection criteria for core browser versions compatible with a given feature set is: the final version of each browser prior to the cut off date for that feature set. In the case of Widely Available, this is 30 months in the past and in the case of Baseline years, this is the end of the year specified. In future, when the `web-features` repository is data complete, it should be possible to determine if earlier browser versions support the specified feature set.
+Shows UC Browse Mobile 13.8 implementing Chromium 100, and:
+
+`Mozilla/5.0 (Linux; arm_64; Android 11; Redmi Note 8 Pro) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.6613.123 YaBrowser/24.10.2.123.00 SA/3 Mobile Safari/537.36`
+
+Shows Yandex Browser Mobile 24.10 implementing Chromium 128. The Chromium version from this string is mapped to the main Chrome version from MDN `browser-compat-data`.
+
+> **Note** Where possible, approximate release dates have been included based on useragents.io "first seen" data. However, useragents.io does not have "first seen" dates prior to June 2020. However, these browsers' Baseline compatibility is determined by their Chromium version, so their release dates are more informative than critical.
+
+This data is updated on a daily basis using a [script](https://github.com/web-platform-dx/web-features/tree/main/scripts/refresh-downstream.ts) triggered by a GitHub [action](https://github.com/web-platform-dx/web-features/tree/main/.github/workflows/refresh_downstream.yml). Useragents.io provides a private API for this module which exposes the last 7 days of newly seen user agents for the currently tracked browsers. If a new major version of one of the tracked browsers is encountered with a Chromium version that meets or exceeds the previous latest version of that browser, it is added to the [src/data/downstream-browsers.json](src/data/downstream-browsers.json) file with the date it was first seen by useragents.io as its release date.
 
 ## Prerequisites
 
@@ -44,20 +52,14 @@ Updating this module and `@mdn/browser-compat-data` regularly is recommended to
 
 ## Usage
 
-### Import the module
-
-First, import the module:
-
-```javascript
-import baselineBrowserMapping from "baseline-browser-mapping";
-```
-
 ### Get Baseline Widely Available browser versions
 
 To get the current list of minimum browser versions compatible with Baseline Widely Available features from the core browser set, call the `getMinimumWidelyAvailable` method:
 
 ```javascript
-baselineBrowserMapping.getMinimumWidelyAvailable();
+import { getMinimumWidelyAvailable } from "baseline-browser-mapping";
+
+getMinimumWidelyAvailable();
 ```
 
 Executed on 29th November 2024, the above code returns the final version of each core browser released on or before 24th May 2022 i.e. 30 months before the date of execution:
@@ -116,10 +118,12 @@ Executed on 29th November 2024, the above code returns the final version of each
 ];
 ```
 
-If you need a list of _all_ compatible versions, you can call:
+If you need a list of _all_ compatible versions, you can import and call:
 
 ```javascript
-baselineBrowserMapping.getAllWidelyAvailable();
+import { getMinimumWidelyAvailable } from "baseline-browser-mapping";
+
+getAllWidelyAvailable();
 ```
 
 ### Get Baseline Widely Available compatible browser versions as of a specific date
@@ -127,17 +131,37 @@ baselineBrowserMapping.getAllWidelyAvailable();
 To get the minimum browser versions that supported Baseline Widely Available on a specific date, call `getMinimumWidelyAvailableOnDate` or `geAllWidelyAvailableOnDate`, passing the desired date in the format `YYYY-MM-DD`:
 
 ```javascript
-baselineBrowserMapping.getMinimumWidelyAvailableOnDate("2021-03-19");
+import { getMinimumWidelyAvailableOnDate } from "baseline-browser-mapping";
+
+getMinimumWidelyAvailableOnDate("2021-03-19");
 ```
 
 This would return the final version of each core browser released on or before 19th September 2018 i.e. 30 months before 19th March 2021.
 
+If you need a list of _all_ compatible versions, you can import and call:
+
+```javascript
+import { getAllWidelyAvailableOnDate } from "baseline-browser-mapping";
+
+getAllWidelyAvailableOnDate("2021-03-19");
+```
+
 ### Get Baseline year compatible browser versions
 
 To get the list of browser versions that support a particular year's Baseline feature set, call `getMinimumByYear` or `getAllByYear` passing the desired year in the format YYYY:
 
 ```javascript
-baselineBrowserMapping.getMinimumByYear("2020");
+import { getMinimumByYear } from "baseline-browser-mapping";
+
+getMinimumByYear("2020");
+```
+
+If you need a list of _all_ compatible versions, you can import and call:
+
+```javascript
+import { getAllByYear } from "baseline-browser-mapping";
+
+getAllByYear("2020");
 ```
 
 ### Including downstreambrowsers
@@ -145,11 +169,11 @@ baselineBrowserMapping.getMinimumByYear("2020");
 Each of the methods above can take an optional final boolean parameter `includeDownstream`. The default for this in all functions is `false`. To include downstream browsers, pass `true` as the final parameter when you call the function:
 
 ```javascript
-baselineBrowserMapping.getAllWidelyAvailable(true)
+getAllWidelyAvailable(true)
 
-baselineBrowserMapping.getMinimumWidelyAvailableOnDate('2021-03-19' true)
+getMinimumWidelyAvailableOnDate('2021-03-19' true)
 
-baselineBrowserMapping.getMinimumByYear('2020', true)
+getMinimumByYear('2020', true)
 ```
 
 Passing `true` will include the appropriate versions of the browsers listed as "Core" = `false` below.
@@ -170,11 +194,11 @@ Passing `true` will include the appropriate versions of the browsers listed as "
 | Samsung Internet      | `samsunginternet_android` | `false` | MDN `browser-compat-data` |
 | WebView Android       | `webview_android`         | `false` | MDN `browser-compat-data` |
 | QQ Browser Mobile     | `qq_android`              | `false` | useragents.io             |
-| UC Browser Mobile     | `UC_android`              | `false` | useragents.io             |
+| UC Browser Mobile     | `uc_android`              | `false` | useragents.io             |
 | Yandex Browser Mobile | `ya_android`              | `false` | useragents.io             |
 
 > **Note**
-> All the non-core browsers currently included implement Chromium. Their inclusion in any of the above functions is based on the Baseline feature set supported by the Chromium version they implement, not their release date.
+> All the non-core browsers currently included implement Chromium. Their inclusion in any of the above methods is based on the Baseline feature set supported by the Chromium version they implement, not their release date.
 
 ## Helping out and getting help
 

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

@@ -118,7 +118,7 @@ const getDownstreamBrowsers = (inputArray = [], minOnly = true) => {
             if (versionData.engine != "Blink") {
                 return false;
             }
-            if (compareVersions(versionData.engine_version, minimumChromeVersion) == 0) {
+            if (parseInt(versionData.engine_version) < parseInt(minimumChromeVersion)) {
                 return false;
             }
             return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "baseline-browser-mapping",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": "./dist/index.js"