Prepackage data into a single script file for easier imports (#81)

* Refactors methodology for including `web-features`, `@mdn/browser-compat-data` and `downstream-browsers.json` data away from using direct dependencies and imports and towards dev dependencies and a regularly updated data file which is compressed down substantially to improve speed.  Should result in fewer PRs needing approval and easier automation of data updates.
* Adds support for loading in browser contexts.
* Adds support for CommonJS using the `/legacy` export path.
* Adds tests using Jasmine
* Simplifies GitHub actions and removes Dependabot.
* Issues a warning if module hasn't been updated in >2 months.
* Use @notpushkin 's simplified compareVersions from #68
* README updates for new import options
* Updates `web-features` to 2.41.0 and `@mdn/browser-compat-data` to 6.0.29.

---------

Co-authored-by: @notpushkin

Author: tonypconway

.github/dependabot.yml

@@ -22,8 +22,8 @@ jobs:
       - name: Install environment
         run: npm ci
 
-      - name: Prepare for release
-        run: npm run prepare
+      - name: Build for release
+        run: npm run build
 
       - name: Publish new version to NPM
         id: publish-to-npm

.github/workflows/publish_on_tag.yml

@@ -0,0 +1,70 @@
+name: Refresh downstream-browsers.json
+
+on:
+  schedule:
+    - cron: "0 14 * * *"
+  workflow_dispatch:
+
+env:
+  package_dir: "/"
+
+jobs:
+  refresh-downstream-browsers-json:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "22"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install environment
+        run: npm ci
+
+      - name: check for BCD and web-features updates
+        id: update-bcd-and-web-features
+        run: npm run update-data-dependencies
+
+      - name: Run refresh-downstream.ts
+        if: steps.update-bcd-and-web-features.outcome == 'success'
+        id: refresh-downstream-script
+        run: npm run refresh-downstream ${{ secrets.USERAGENTSIOKEY }}
+
+      - name: Attempt to update data.js file
+        if: steps.refresh-downstream-script.outcome == 'success'
+        id: update-data-file
+        run: |
+          npm run update-data-file
+          prettier ./src/data/data.js --write
+
+      - name: Check for changes to ./src/data/data.js
+        if: steps.update-data-file.outcome == 'success'
+        id: check-data-changes
+        run: npm run check-data-changes -s >> $GITHUB_OUTPUT
+
+      - name: Run tests and linting
+        if: steps.check-data-changes.outputs.changes-available == 'TRUE'
+        id: lint-and-test
+        run: npm run test
+
+      - name: Push changes to main
+        if: steps.lint-and-test.outcome == 'success'
+        id: push-to-branch
+        run: |
+          echo "Data changes have occured, committing to main"
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add .
+          git commit -m "Browser or feature data changed"
+          git push origin
+
+      - name: Tag release for publishing
+        if: steps.push-to-branch.outcome == 'success'
+        id: tag-release
+        run: |
+          npm version patch -m "Patch to %s because browser or feature data changed"
+          git push && git push --tags

.github/workflows/refresh_data.yml

@@ -2,7 +2,7 @@ name: Refresh static resources
 
 on:
   schedule:
-    - cron: "0 16 * * *"
+    - cron: "0 15 * * *"
   workflow_dispatch:
 
 env:

.github/workflows/refresh_downstream.yml

@@ -2,36 +2,56 @@
 
 By the [W3C WebDX Community Group](https://www.w3.org/community/webdx/) and contributors.
 
-`baseline-browser-mapping` exposes arrays of browsers compatible with Baseline Widely available and specified Baseline year feature sets.
-You can use `baseline-browser-mapping` to help you determine minimum browser version support for your chosen Baseline feature set.
+`baseline-browser-mapping` provides:
 
-## Prerequisites
+- An `Array` of browsers compatible with Baseline Widely available and Baseline year feature sets via the [`getCompatibleVersions()` function](#get-baseline-widely-available-browser-versions-or-baseline-year-browser-versions).
+- An `Array`, `Object` or `CSV` as a string describing the Baseline feature set support of all browser versions included in the module's data set via the [`getAllVersions()` function](#get-data-for-all-browser-versions).
 
-To use this package, you'll need:
+You can use `baseline-browser-mapping` to help you determine minimum browser version support for your chosen Baseline feature set; or to analyse the level of support for different Baseline feature sets in your site's traffic by joining the data with your analytics data.
 
-- Node.js (a supported [current, active LTS, or maintenance LTS release](https://nodejs.org/en/about/previous-releases))
-
-## Install
+## Install for local development
 
 To install the package, run:
 
-`npm install --save baseline-browser-mapping`
+`npm install --save-dev baseline-browser-mapping`
 
-`baseline-browser-mapping` depends on `web-features` and `@mdn/browser-compat-data` for version selection. This package uses dependabot to automatically update both modules on all minor and patch version releases and is updated frequently. Consider adding a script to your `package.json` to update `basesline-browser-mapping` and using it as a build step:
+`baseline-browser-mapping` depends on `web-features` and `@mdn/browser-compat-data` for core browser version selection, but the data is pre-packaged and minified. This package checks for updates to those modules and the supported [downstream browsers](#downstream-browsers) on a daily basis and is updated frequently. Consider adding a script to your `package.json` to update `basesline-browser-mapping` and using it as part of your build process to ensure your data is as up to date as possible:
 
 ```javascript
 "scripts": [
-  "refresh-baseline-browser-mapping": "npm i --save baseline-browser-mapping@latest"
+  "refresh-baseline-browser-mapping": "npm i --save-dev baseline-browser-mapping@latest"
 ]
 ```
 
+If your installed version of `baseline-browser-mapping` is greater than 2 months old, you will receive a console warning advising you to update to the latest version.
+
+## Importing `baseline-browser-mapping`
+
+This module exposes two functions: `getCompatibleVersions()` and `getAllVersions()`, both which can be imported directly from `baseline-browser-mapping`:
+
+```javascript
+import { getCompatibleVersions, getAllVersions } from "baseline-browser-mapping";
+```
+
+If you want to load the script and data directly in a web page without hosting it yourself, consider using a CDN:
+
+```html
+<script type="module">
+  import { getCompatibleVersions, getAllVersions } from "https://cdn.jsdelivr.net/npm/baseline-browser-mapping";
+</script>
+```
+
+`baseline-browser-mapping` is packaged as an ES module by default. If you need to run it in a legacy environment that doesn't support ES modules, use the `/legacy` version:
+
+```javascript
+const { getCompatibleVersions, getAllVersions } = require("baseline-browser-mapping/legacy");
+```
+
 ## Get Baseline Widely available browser versions or Baseline year browser versions
 
 To get the current list of minimum browser versions compatible with Baseline Widely available features from the core browser set, call the `getCompatibleVersions()` function:
 
 ```javascript
-import { getCompatibleVersions } from "baseline-browser-mapping";
-
 getCompatibleVersions();
 ```
 
@@ -62,7 +82,7 @@ Executed on 7th March 2025, the above code returns the following browser version
 ```
 
 > [!NOTE]  
-> The minimum versions of each browser are not strictly the final release before the Widely available cutoff date of `TODAY - 30 MONTHS`. Some earlier versions will have supported the full Widely available feature set.
+> The minimum versions of each browser are not necessarily the final release before the Widely available cutoff date of `TODAY - 30 MONTHS`. Some earlier versions will have supported the full Widely available feature set.
 
 ### `getCompatibleVersions()` configuration options
 

.github/workflows/refresh_static.yml

@@ -0,0 +1,18 @@
+import newWithError from "eslint-plugin-new-with-error";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(tseslint.configs.base, {
+  plugins: { newWithError },
+  rules: {
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        caughtErrors: "none",
+      },
+    ],
+    "newWithError/new-with-error": "error",
+    "no-duplicate-imports": "error",
+    "no-throw-literal": "error",
+  },
+  files: ["**/*.ts"],
+});