baseline-browser-mapping 2.10.41 → 2.11.21

package/dist/types.d.ts

@@ -0,0 +1,121 @@
+export type BrowserVersion = {
+    browser: string;
+    version: string;
+    release_date?: string;
+    engine?: string;
+    engine_version?: string;
+};
+export type Options = {
+    /**
+     * Whether to include only the minimum compatible browser versions or all compatible versions.
+     * Defaults to `false`.
+     */
+    listAllCompatibleVersions?: boolean;
+    /**
+     * Whether to include browsers that use the same engines as a core Baseline browser.
+     * Defaults to `false`.
+     */
+    includeDownstreamBrowsers?: boolean;
+    /**
+     * Pass a date in the format 'YYYY-MM-DD' to get versions compatible with Widely available on the specified date.
+     * If left undefined and a `targetYear` is not passed, defaults to Widely available as of the current date.
+     * > NOTE: cannot be used with `targetYear`.
+     */
+    widelyAvailableOnDate?: string | number;
+    /**
+     * Pass a year between 2015 and the current year to get browser versions compatible with all
+     * Newly Available features as of the end of the year specified.
+     * > NOTE: cannot be used with `widelyAvailableOnDate`.
+     */
+    targetYear?: number;
+    /**
+     * Pass a boolean that determines whether KaiOS is included in browser mappings.  KaiOS implements
+     * the Gecko engine used in Firefox.  However, KaiOS also has a different interaction paradigm to
+     * other browsers and requires extra consideration beyond simple feature compatibility to provide
+     * an optimal user experience.  Defaults to `false`.
+     */
+    includeKaiOS?: boolean;
+    overrideLastUpdated?: number;
+    /**
+     * Pass a boolean to suppress the warning about stale data.
+     * Defaults to `false`.
+     */
+    suppressWarnings?: boolean;
+};
+export type AllVersionsOptions = {
+    /**
+     * Whether to return the output as a JavaScript `Array` (`"array"`), `Object` (`"object"`) or a CSV string (`"csv"`).
+     * Defaults to `"array"`.
+     */
+    outputFormat?: string;
+    /**
+     * Whether to include browsers that use the same engines as a core Baseline browser.
+     * Defaults to `false`.
+     */
+    includeDownstreamBrowsers?: boolean;
+    /**
+     * Whether to use the new "supports" property in place of "wa_compatible"
+     * Defaults to `false`
+     */
+    useSupports?: boolean;
+    /**
+     * Whether to include KaiOS in the output. KaiOS implements the Gecko engine used in Firefox.
+     * However, KaiOS also has a different interaction paradigm to other browsers and requires extra
+     * consideration beyond simple feature compatibility to provide an optimal user experience.
+     */
+    includeKaiOS?: boolean;
+    /**
+     * Pass a boolean to suppress the warning about old data.
+     * Defaults to `false`.
+     */
+    suppressWarnings?: boolean;
+};
+export interface AllBrowsersBrowserVersion extends BrowserVersion {
+    year: number | string;
+    supports?: string;
+    wa_compatible?: boolean;
+}
+export type NestedBrowserVersions = {
+    [browser: string]: {
+        [version: string]: AllBrowsersBrowserVersion;
+    };
+};
+export type TimelineOptions = {
+    /**
+     * Whether to return the timeline as a chronologically sorted array of events grouped by date ("date"),
+     * or as an object grouped by browser with their respective history of version changes ("browser").
+     * Defaults to "date".
+     */
+    groupBy?: "date" | "browser";
+    /**
+     * Whether to include all compatible browsers in each timeline event,
+     * or only the browsers that changed on that date.
+     * Only applicable when groupBy is "date".
+     * Defaults to `false`.
+     */
+    listAllBrowsers?: boolean;
+    /**
+     * Whether to include browsers that use the same engines as a core Baseline browser.
+     * Defaults to `false`.
+     */
+    includeDownstreamBrowsers?: boolean;
+    /**
+     * Whether to include KaiOS in the timeline.
+     * Defaults to `false`.
+     */
+    includeKaiOS?: boolean;
+};
+export type TimelineEvent = {
+    date: string;
+    browsers: BrowserVersion[];
+};
+export type BrowserTimelineEntry = {
+    date: string;
+    version: string;
+    release_date?: string;
+    engine?: string;
+    engine_version?: string;
+};
+export type BrowserTimeline = {
+    [browser: string]: BrowserTimelineEntry[];
+};

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare const compareVersions: (nextVersion: string, prevVersion: string) => 1 | 0 | -1;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "baseline-browser-mapping",
   "main": "./dist/index.cjs",
-  "version": "2.10.41",
+  "version": "2.11.21",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": {
@@ -40,16 +40,16 @@
     "build": "rm -rf dist; npx prettier . --write; rollup -c; rm -rf ./dist/scripts/expose-data.d.ts ./dist/cli.d.ts",
     "refresh-downstream": "npx tsx scripts/refresh-downstream.ts",
     "refresh-static": "npx tsx scripts/refresh-static.ts",
-    "update-data-file": "npx tsx scripts/update-data-file.ts; npx prettier ./src/data/data.js --write",
+    "update-timeline": "npx tsx scripts/create-timeline.ts; npx prettier ./src/data/timeline.js --write",
     "update-data-dependencies": "npm i @mdn/browser-compat-data@latest web-features@latest -D",
-    "check-data-changes": "git diff --name-only | grep -q '^src/data/data.js$' && echo 'changes-available=TRUE' || echo 'changes-available=FALSE'"
+    "check-timeline-changes": "git diff --name-only | grep -q '^src/data/timeline.js$' && echo 'changes-available=TRUE' || echo 'changes-available=FALSE'"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@mdn/browser-compat-data": "^8.0.4",
+    "@mdn/browser-compat-data": "^8.1.0",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.1.3",
-    "@types/node": "^22.15.17",
+    "@types/node": "^22.19.21",
     "eslint-plugin-new-with-error": "^5.0.0",
     "jasmine": "^5.8.0",
     "jasmine-browser-runner": "^3.0.0",
@@ -59,7 +59,7 @@
     "tslib": "^2.8.1",
     "typescript": "^5.7.2",
     "typescript-eslint": "^8.35.0",
-    "web-features": "^3.32.0"
+    "web-features": "^3.37.0"
   },
   "repository": {
     "type": "git",