baseline-browser-mapping 2.5.9 → 2.6.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "baseline-browser-mapping",
   "main": "./dist/index.js",
-  "version": "2.5.9",
+  "version": "2.6.1",
   "description": "A library for obtaining browser versions with their maximum supported Baseline feature set and Widely Available status.",
   "exports": {
     ".": {
@@ -16,19 +16,22 @@
   },
   "files": [
     "dist/*",
+    "!dist/scripts/*",
     "LICENSE.txt",
-    "README.md",
-    "CONTRIBUTING.md"
+    "README.md"
   ],
   "types": "./dist/index.d.ts",
   "type": "module",
+  "bin": {
+    "baseline-browser-mapping": "./dist/cli.js"
+  },
   "scripts": {
     "test:format": "npx prettier --check .",
     "test:lint": "npx eslint .",
     "test:bcb": "mkdir test-bcb && cd test-bcb && npm init -y && npm i ../../baseline-browser-mapping browserslist browserslist-config-baseline &&jq '. += {\"browserslist\":[\"extends browserslist-config-baseline\"]}' package.json >p && mv p package.json && npx browserslist && cd ../ && rm -rf test-bcb",
     "test:jasmine": "npx jasmine",
     "test": "npm run build && rm -rf test-bcb && npm run test:format && npm run test:lint && npx jasmine && npm run test:bcb",
-    "build": "rm -rf dist; npx prettier . --write; rollup -c",
+    "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",

package/CONTRIBUTING.md

@@ -1,21 +0,0 @@
-# Contributing to `baseline-browser-mapping`
-
-## Bugs
-
-If you find a functional bug in `baseline-browser-mapping`, please create an issue in this repository. Any detail you can include, including as console errors, expected and actual output, is welcome. If you've already figured out how to solve the issue, please create a PR.
-
-## Downstream browser data accuracy and completeness
-
-The data for [Chromium downstream browsers](/README.md#limitations) not included in `@mdn/browser-compat-data` is provided on a best effort basis in [`src/data/downstream-browsers.json`](src/data/downstream-browsers.json). If you have an accurate source for the Chromium versions implemented by the browsers already in this module (UC Mobile, QQ Mobile, Yandex Browser), or if you have data for a browser not included in this module, we welcome issues or PRs to discuss including that data.
-
-## Working with `baseline-browser-mapping` locally
-
-To work with `baseline-browser-mapping` locally, clone this repository and install its dependencies:
-
-```bash
-git clone https://github.com/web-platform-dx/baseline-browser-mapping
-cd baseline-browser-mapping
-npm install
-```
-
-If you make changes to the code, make sure to run `nmp run prepare` before you test your changes from another package.

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

@@ -1,76 +0,0 @@
-type BrowserVersion = {
-    browser: string;
-    version: string;
-    release_date?: string;
-    engine?: string;
-    engine_version?: string;
-};
-interface AllBrowsersBrowserVersion extends BrowserVersion {
-    year: number | string;
-    supports?: string;
-    wa_compatible?: boolean;
-}
-type NestedBrowserVersions = {
-    [browser: string]: {
-        [version: string]: AllBrowsersBrowserVersion;
-    };
-};
-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;
-};
-/**
- * Returns browser versions compatible with specified Baseline targets.
- * Defaults to returning the minimum versions of the core browser set that support Baseline Widely available.
- * Takes an optional configuraation object `Object` with four optional properties:
- * - `listAllCompatibleVersions`: `false` (default) or `false`
- * - `includeDownstreamBrowsers`: `false` (default) or `false`
- * - `widelyAvailableOnDate`: date in format `YYYY-MM-DD`
- * - `targetYear`: year in format `YYYY`
- */
-export declare function getCompatibleVersions(userOptions?: Options): BrowserVersion[];
-type AllVersionsOptions = {
-    /**
-     * Whether to return the output as a Javascript `Array` (`array`) 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;
-};
-/**
- * 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), `object` or `csv`
- */
-export declare function getAllVersions(userOptions?: AllVersionsOptions): AllBrowsersBrowserVersion[] | NestedBrowserVersions | string;
-export {};

package/dist/scripts/expose-data.d.ts

@@ -1,34 +0,0 @@
-type FeatureKeyed = {
-    id: string;
-    status: {
-        baseline_low_date: string;
-        support: {
-            [key: string]: string;
-        };
-    };
-};
-type BrowserVersionKeyed = {
-    version: string;
-    release_date: string | undefined;
-    status: string | undefined;
-    engine: string | undefined;
-    engine_version: string | undefined;
-};
-declare const features: {
-    [key: string]: FeatureKeyed;
-};
-declare const bcdBrowsers: {
-    [browser: string]: {
-        releases: {
-            [key: string]: BrowserVersionKeyed;
-        };
-    };
-};
-declare const otherBrowsers: {
-    [browser: string]: {
-        releases: {
-            [key: string]: BrowserVersionKeyed;
-        };
-    };
-};
-export { features, bcdBrowsers, otherBrowsers };