core-js-compat 3.4.3 → 3.4.8

package/README.md

@@ -1,37 +1,73 @@
-[`core-js-compat` package](https://github.com/zloirock/core-js/packages/core-js-compat) contains data about the necessity of [`core-js`](https://github.com/zloirock/core-js) modules and API for getting a list of required core-js modules by browserslist query.
+[`core-js-compat` package](https://github.com/zloirock/core-js/tree/master/packages/core-js-compat) contains data about the necessity of [`core-js`](https://github.com/zloirock/core-js) modules and API for getting a list of required core-js modules by browserslist query.
 
 ```js
 const {
-  list,              // array of required modules
-  targets,           // object with targets for each module
+  list,                  // array of required modules
+  targets,               // object with targets for each module
 } = require('core-js-compat')({
-  targets: '> 2.5%', // browserslist query
-  filter: 'es.',     // optional filter - string-prefix, regexp or list of modules
+  targets: '> 2.5%',     // browserslist query, by default - all engines
+  filter: /^(es|web)\./, // optional filter - string-prefix, regexp or list of modules
+  version: '3.4',        // used `core-js` version, by default - the latest
 });
 
 console.log(targets);
 /* =>
 {
-  'es.symbol.description': { ios: '12.0-12.1' },
-  'es.array.reverse': { ios: '12.0-12.1' },
-  'es.string.replace': { firefox: '63', ios: '12.0-12.1' },
-  'es.string.trim': { ios: '12.0-12.1' },
-  'es.promise': { firefox: '63' },
-  'es.promise.finally': { firefox: '63' },
-  'es.array-buffer.slice': { ios: '12.0-12.1' },
-  'es.typed-array.int8-array': { ios: '12.0-12.1' },
-  'es.typed-array.uint8-array': { ios: '12.0-12.1' },
-  'es.typed-array.uint8-clamped-array': { ios: '12.0-12.1' },
-  'es.typed-array.int16-array': { ios: '12.0-12.1' },
-  'es.typed-array.uint16-array': { ios: '12.0-12.1' },
-  'es.typed-array.int32-array': { ios: '12.0-12.1' },
-  'es.typed-array.uint32-array': { ios: '12.0-12.1' },
-  'es.typed-array.float32-array': { ios: '12.0-12.1' },
-  'es.typed-array.float64-array': { ios: '12.0-12.1' },
-  'es.typed-array.from': { ios: '12.0-12.1' },
-  'es.typed-array.of': { ios: '12.0-12.1' }
+  'es.symbol.match-all': { ios: '12.2-12.4' },
+  'es.array.unscopables.flat': { ios: '12.2-12.4' },
+  'es.array.unscopables.flat-map': { ios: '12.2-12.4' },
+  'es.math.hypot': { chrome: '77' },
+  'es.promise.all-settled': { firefox: '69', ios: '12.2-12.4' },
+  'es.promise.finally': { ios: '12.2-12.4' },
+  'es.string.match-all': { chrome: '77', firefox: '69', ios: '12.2-12.4' },
+  'es.string.replace': { firefox: '69', ios: '12.2-12.4' },
+  'es.typed-array.float32-array': { ios: '12.2-12.4' },
+  'es.typed-array.float64-array': { ios: '12.2-12.4' },
+  'es.typed-array.int8-array': { ios: '12.2-12.4' },
+  'es.typed-array.int16-array': { ios: '12.2-12.4' },
+  'es.typed-array.int32-array': { ios: '12.2-12.4' },
+  'es.typed-array.uint8-array': { ios: '12.2-12.4' },
+  'es.typed-array.uint8-clamped-array': { ios: '12.2-12.4' },
+  'es.typed-array.uint16-array': { ios: '12.2-12.4' },
+  'es.typed-array.uint32-array': { ios: '12.2-12.4' },
+  'es.typed-array.from': { ios: '12.2-12.4' },
+  'es.typed-array.of': { ios: '12.2-12.4' },
+  'web.dom-collections.iterator': { ios: '12.2-12.4' },
+  'web.immediate': { chrome: '77', firefox: '69', ios: '12.2-12.4' },
+  'web.url': { ios: '12.2-12.4' },
+  'web.url.to-json': { ios: '12.2-12.4' },
+  'web.url-search-params': { ios: '12.2-12.4' }
 }
 */
 ```
 
+Additional API:
+
+```js
+// equals of of the method from the example above
+require('core-js-compat/compat')({ targets, filter, version }); // => { list: Array<ModuleName>, targets: { [ModuleName]: { [EngineName]: EngineVersion } } }
+// or
+require('core-js-compat').compat({ targets, filter, version }); // => { list: Array<ModuleName>, targets: { [ModuleName]: { [EngineName]: EngineVersion } } }
+
+// full compat data:
+require('core-js-compat/data'); // => { [ModuleName]: { [EngineName]: EngineVersion } }
+// or
+require('core-js-compat').data; // => { [ModuleName]: { [EngineName]: EngineVersion } }
+
+// map of modules by `core-js` entry points:
+require('core-js-compat/entries'); // => { [EntryPoint]: Array<ModuleName> }
+// or
+require('core-js-compat').entries; // => { [EntryPoint]: Array<ModuleName> }
+
+// full list of modules:
+require('core-js-compat/modules'); // => Array<ModuleName>
+// or
+require('core-js-compat').modules; // => Array<ModuleName>
+
+// the subset of modules which available in the passed `core-js` version:
+require('core-js-compat/get-modules-list-for-target-version')('3.3'); // => Array<ModuleName>
+// or
+require('core-js-compat').getModulesListForTargetVersion('3.3'); // => Array<ModuleName>
+```
+
 If you want to add new / update data about modules required for target engines, [follow this instruction](https://github.com/zloirock/core-js/blob/master/CONTRIBUTING.md#updating-core-js-compat-data).

package/compat.js

@@ -0,0 +1,104 @@
+'use strict';
+const browserslist = require('browserslist');
+const { compare, has, intersection } = require('./helpers');
+const data = require('./data');
+const getModulesListForTargetVersion = require('./get-modules-list-for-target-version');
+const modules = require('./modules');
+
+const mapping = new Map([
+  ['and_chr', 'chrome'],
+  ['and_ff', 'firefox'],
+  ['ie_mob', 'ie'],
+  ['ios_saf', 'ios'],
+  ['op_mob', 'opera_mobile'],
+]);
+
+const validTargets = new Set([
+  'android',
+  'chrome',
+  'edge',
+  'electron',
+  'firefox',
+  'ie',
+  'ios',
+  'node',
+  'opera',
+  'opera_mobile',
+  'phantom',
+  'safari',
+  'samsung',
+]);
+
+function normalizeBrowsersList(list) {
+  return list.map(it => {
+    let [engine, version] = it.split(' ');
+    if (mapping.has(engine)) {
+      engine = mapping.get(engine);
+    } else if (engine === 'android' && compare(version, '>', '4.4.4')) {
+      engine = 'chrome';
+    }
+    return [engine, version];
+  }).filter(([engine]) => validTargets.has(engine));
+}
+
+function reduceByMinVersion(list) {
+  const targets = new Map();
+  for (const [engine, version] of list) {
+    if (!targets.has(engine) || compare(version, '<=', targets.get(engine))) {
+      targets.set(engine, version);
+    }
+  }
+  return targets;
+}
+
+function checkModule(name, targets) {
+  if (!has(data, name)) throw new TypeError(`Incorrect module: ${ name }`);
+
+  const requirements = data[name];
+  const result = {
+    required: false,
+    targets: {},
+  };
+
+  for (const [engine, version] of targets) {
+    if (!has(requirements, engine) || compare(version, '<', requirements[engine])) {
+      result.required = true;
+      result.targets[engine] = version;
+    }
+  }
+
+  return result;
+}
+
+module.exports = function ({ targets, filter, version }) {
+  const list = browserslist(targets);
+  const engines = normalizeBrowsersList(list);
+  const reducedTargets = reduceByMinVersion(engines);
+
+  const result = {
+    list: [],
+    targets: {},
+  };
+
+  let $modules = Array.isArray(filter) ? filter : modules;
+
+  if (filter instanceof RegExp) {
+    $modules = $modules.filter(it => filter.test(it));
+  } else if (typeof filter == 'string') {
+    $modules = $modules.filter(it => it.startsWith(filter));
+  }
+
+  if (version) {
+    $modules = intersection($modules, getModulesListForTargetVersion(version));
+  }
+
+  for (const key of $modules) {
+    const check = checkModule(key, reducedTargets);
+    if (check.required) {
+      result.list.push(key);
+      result.targets[key] = check.targets;
+    }
+  }
+
+  return result;
+};