baseline-browser-mapping 2.11.18

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:npm/baseline-browser-mapping@2.11.18
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/baseline-browser-mapping@2.11.18
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:ba7488cfcf5a63e30bb6ec739b5f59b77b5b59629f1cc4d6060663b0760b0602","constraints":{"executionContext":"node"},"contract":["getCompatibleVersions returns minimum browser versions supporting Baseline Widely available by default","getCompatibleVersions supports targetYear and widelyAvailableOnDate options","getCompatibleVersions includes all compatible versions and downstream browsers when configured","getCompatibleVersions validates mutually exclusive and invalid options","getAllVersions returns browser versions with Baseline support across array, object, and csv output formats","getAllVersions supports useSupports option to distinguish widely and newly available tiers","getTimeline groups baseline event timelines by date or by browser","_resetHasWarned resets internal warning state for stale data checks"],"goal":"verify pkg:npm/baseline-browser-mapping@2.11.18","kind":"HOW","packages":["pkg:npm/baseline-browser-mapping@2.11.18"],"schemaVersion":1},"contractCommand":["node","test/contract.js"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/baseline-browser-mapping@2.11.18"],"schemaVersion":1,"subject":"pkg:npm/baseline-browser-mapping@2.11.18","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-baseline-browser-mapping",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-baseline-browser-mapping",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "baseline-browser-mapping": "2.11.18"
      }
    },
    "node_modules/baseline-browser-mapping": {
      "version": "2.11.18",
      "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.11.18.tgz",
      "integrity": "sha512-1iEmLEYSiE1SeBoAfPo/Mnx3PzfzHUkDK61ASkCpuk3YXugYLH5DYK1SzqV55F8FMI6s0F+/tCP7Polz1QRjxw==",
      "license": "Apache-2.0",
      "bin": {
        "baseline-browser-mapping": "dist/cli.cjs"
      },
      "engines": {
        "node": ">=6.0.0"
      }
    }
  }
}

{
  "name": "sample-baseline-browser-mapping",
  "version": "1.0.0",
  "description": "Clean-room verification sample for baseline-browser-mapping",
  "main": "src/index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "baseline-browser-mapping": "2.11.18"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/baseline-browser-mapping@2.11.18",
  "kind": "HOW",
  "packages": [
    "pkg:npm/baseline-browser-mapping@2.11.18"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

const {
  getCompatibleVersions,
  getAllVersions,
  getTimeline,
  _resetHasWarned
} = require('baseline-browser-mapping');

/**
 * Retrieve browser versions compatible with Baseline specifications.
 *
 * @param {import('baseline-browser-mapping').Options} [options]
 * @returns {import('baseline-browser-mapping').BrowserVersion[]}
 */
function queryCompatibleVersions(options) {
  return getCompatibleVersions(options);
}

/**
 * Retrieve all known browser versions with their Baseline compatibility status.
 *
 * @param {import('baseline-browser-mapping').AllVersionsOptions} [options]
 * @returns {any}
 */
function queryAllVersions(options) {
  return getAllVersions(options);
}

/**
 * Retrieve the Baseline timeline events grouped by date or browser.
 *
 * @param {import('baseline-browser-mapping').TimelineOptions} [options]
 * @returns {any}
 */
function queryTimeline(options) {
  return getTimeline(options);
}

/**
 * Reset internal warning state for stale data notices.
 */
function resetWarnings() {
  _resetHasWarned();
}

module.exports = {
  queryCompatibleVersions,
  queryAllVersions,
  queryTimeline,
  resetWarnings
};

const assert = require('node:assert/strict');
const {
  getCompatibleVersions,
  getAllVersions,
  getTimeline,
  _resetHasWarned
} = require('baseline-browser-mapping');
const {
  queryCompatibleVersions,
  queryAllVersions,
  queryTimeline,
  resetWarnings
} = require('../src/index.js');

// Suppress stale data warnings in test environment
process.env.BASELINE_BROWSER_MAPPING_IGNORE_OLD_DATA = 'true';

// 1. getCompatibleVersions returns minimum browser versions supporting Baseline Widely available by default
{
  const versions = getCompatibleVersions();
  assert(Array.isArray(versions));
  assert(versions.length > 0);

  const browserNames = versions.map((item) => item.browser);
  assert(browserNames.includes('chrome'));
  assert(browserNames.includes('edge'));
  assert(browserNames.includes('firefox'));
  assert(browserNames.includes('safari'));

  for (const item of versions) {
    assert(typeof item.browser === 'string');
    assert(typeof item.version === 'string');
    assert(typeof item.release_date === 'string');
  }

  // Wrapper check
  const wrappedVersions = queryCompatibleVersions();
  assert.deepEqual(wrappedVersions, versions);
}

// 2. getCompatibleVersions supports targetYear and widelyAvailableOnDate options
{
  const forYear = getCompatibleVersions({ targetYear: 2022 });
  assert(Array.isArray(forYear));
  assert(forYear.length > 0);
  const chrome2022 = forYear.find((v) => v.browser === 'chrome');
  assert(chrome2022);
  assert.equal(typeof chrome2022.version, 'string');

  const forDate = getCompatibleVersions({ widelyAvailableOnDate: '2023-01-01' });
  assert(Array.isArray(forDate));
  assert(forDate.length > 0);
  const safariDate = forDate.find((v) => v.browser === 'safari');
  assert(safariDate);
  assert.equal(typeof safariDate.version, 'string');
}

// 3. getCompatibleVersions includes all compatible versions and downstream browsers when configured
{
  const allVersions = getCompatibleVersions({
    listAllCompatibleVersions: true,
    includeDownstreamBrowsers: true
  });
  assert(Array.isArray(allVersions));
  assert(allVersions.length > 10);

  const downstream = allVersions.filter((v) => v.engine !== undefined);
  assert(downstream.length > 0);

  const operaEntry = downstream.find((v) => v.browser === 'opera');
  assert(operaEntry);
  assert.equal(operaEntry.engine, 'Blink');
}

// 4. getCompatibleVersions validates mutually exclusive and invalid options
{
  // Mutual exclusion between targetYear and widelyAvailableOnDate
  assert.throws(
    () => {
      getCompatibleVersions({
        targetYear: 2022,
        widelyAvailableOnDate: '2022-01-01'
      });
    },
    /cannot use targetYear and widelyAvailableOnDate at the same time/
  );

  // KaiOS requires downstream browsers
  assert.throws(
    () => {
      getCompatibleVersions({
        includeKaiOS: true,
        includeDownstreamBrowsers: false
      });
    },
    /KaiOS is a downstream browser/
  );

  // Years before 2002 are rejected
  assert.throws(
    () => {
      getCompatibleVersions({ targetYear: 1999 });
    },
    /None of the browsers in the core set were released before 2002/
  );
}

// 5. getAllVersions returns browser versions with Baseline support across array, object, and csv output formats
{
  // Array format (default)
  const arr = getAllVersions({ outputFormat: 'array' });
  assert(Array.isArray(arr));
  assert(arr.length > 0);
  assert('year' in arr[0]);
  assert('wa_compatible' in arr[0]);

  // Object format
  const obj = getAllVersions({ outputFormat: 'object' });
  assert(typeof obj === 'object' && !Array.isArray(obj));
  assert('chrome' in obj);
  assert(typeof obj.chrome === 'object');

  // CSV format
  const csv = getAllVersions({ outputFormat: 'csv' });
  assert(typeof csv === 'string');
  assert(
    csv.startsWith(
      '"browser","version","year","wa_compatible","release_date","engine","engine_version"'
    )
  );

  // Wrapper check
  const wrappedArr = queryAllVersions({ outputFormat: 'array' });
  assert.deepEqual(wrappedArr, arr);
}

// 6. getAllVersions supports useSupports option to distinguish widely and newly available tiers
{
  const arrWithSupports = getAllVersions({ useSupports: true });
  assert(Array.isArray(arrWithSupports));
  const entryWithTier = arrWithSupports.find((v) => 'supports' in v);
  assert(entryWithTier);
  assert(['widely', 'newly'].includes(entryWithTier.supports));
}

// 7. getTimeline groups baseline event timelines by date or by browser
{
  // Grouped by date (default)
  const byDate = getTimeline({ groupBy: 'date' });
  assert(Array.isArray(byDate));
  assert(byDate.length > 0);
  assert(typeof byDate[0].date === 'string');
  assert(Array.isArray(byDate[0].browsers));

  // Grouped by browser
  const byBrowser = getTimeline({ groupBy: 'browser' });
  assert(typeof byBrowser === 'object' && !Array.isArray(byBrowser));
  assert('chrome' in byBrowser);
  assert(Array.isArray(byBrowser.chrome));
  assert(typeof byBrowser.chrome[0].date === 'string');
  assert(typeof byBrowser.chrome[0].version === 'string');

  // Wrapper check
  const wrappedByDate = queryTimeline({ groupBy: 'date' });
  assert.deepEqual(wrappedByDate, byDate);
}

// 8. _resetHasWarned resets internal warning state for stale data checks
{
  assert.doesNotThrow(() => {
    _resetHasWarned();
  });
  assert.doesNotThrow(() => {
    resetWarnings();
  });
}

console.log('All contract assertions passed successfully.');