polyfill-library 3.107.1 → 3.110.1

package/tasks/buildsources/write-alias-file.js

@@ -1,33 +0,0 @@
-'use strict';
-
-const fs = require('graceful-fs');
-const path = require('path');
-const {
-	promisify
-} = require('util');
-
-const writeFile = promisify(fs.writeFile);
-
-/**
- * Write "aliases.json" to the output directory.
- *
- * @param {Array<Polyfill>} polyfills list of polyfills
- * @param {string} directory output directory location
- *
- * @throws When writing a valid JSON to the output directory fails.
- */
-module.exports = function writeAliasFile(polyfills, directory) {
-	const aliases = {};
-
-	for (const polyfill of polyfills) {
-		for (const alias of polyfill.aliases) {
-			if (aliases[alias]) {
-				aliases[alias] = [...aliases[alias], polyfill.name];
-			} else {
-				aliases[alias] = [polyfill.name];
-			}
-		}
-	}
-
-	return writeFile(path.join(directory, 'aliases.json'), JSON.stringify(aliases));
-}

package/tasks/buildsources.js

@@ -1,306 +0,0 @@
-'use strict';
-
-const fs = require('graceful-fs');
-const path = require('path');
-const uglify = require('uglify-js');
-const makeDirectory = require('mkdirp');
-const toposort = require('toposort');
-const {promisify} = require('util');
-const vm = require('vm');
-const spdxLicenses = require('spdx-licenses');
-const UA = require('@financial-times/polyfill-useragent-normaliser');
-const TOML = require('@iarna/toml');
-
-const writeFile = promisify(fs.writeFile);
-const readFile = promisify(fs.readFile);
-
-function validateSource(code, label) {
-	try {
-		new vm.Script(code);
-	}
-	catch (error) {
-		throw {
-			name: "Parse error",
-			message: `Error parsing source code for ${label}`,
-			error
-		};
-	}
-}
-
-function flattenPolyfillDirectories(directory) {
-	// Recursively discover all subfolders and produce a flattened list.
-	// Directories prefixed with '__' are not polyfill features and are not included.
-	let results = [];
-	for (const item of fs.readdirSync(directory)) {
-		const joined = path.join(directory, item);
-		if (fs.lstatSync(joined).isDirectory() && item.indexOf('__') !== 0) {
-			results = [...results, ...flattenPolyfillDirectories(joined), joined];
-		}
-	}
-	return results;
-}
-
-function checkForCircularDependencies(polyfills) {
-	const graph = [];
-
-	for (const polyfill of polyfills) {
-		for (const dependency of polyfill.dependencies) {
-			graph.push([dependency, polyfill.name]);
-		}
-	}
-
-	try {
-		toposort(graph);
-
-		return Promise.resolve();
-	}
-	catch (error) {
-		return Promise.reject('\nThere is a circle in the dependency graph.\nCheck the `dependencies` property of polyfill config files that have recently changed, and ensure that they do not form a circle of references.' + error);
-	}
-}
-
-function checkDependenciesExist(polyfills) {
-
-	for (const polyfill of polyfills) {
-		for (const dependency of polyfill.dependencies) {
-			if (!polyfills.some(function (polyfill) {
-				return dependency === polyfill.name;
-			})) {
-				return Promise.reject(`Polyfill ${polyfill.name} depends on ${dependency}, which does not exist within the polyfill-service. Recommended to either add the missing polyfill or remove the dependency.`);
-			}
-		}
-	}
-	return Promise.resolve();
-}
-
-function writeAliasFile(polyfills, directory) {
-	const aliases = {};
-
-	for (const polyfill of polyfills) {
-		for (const alias of polyfill.aliases) {
-			if (aliases[alias]) {
-				aliases[alias] = [...aliases[alias], polyfill.name];
-			} else {
-				aliases[alias] = [polyfill.name];
-			}
-		}
-	}
-
-	return writeFile(path.join(directory, 'aliases.json'), JSON.stringify(aliases));
-}
-
-class Polyfill {
-	constructor(absolute, relative) {
-		this.path = { absolute, relative };
-		this.name = relative.replace(/(\/|\\)/g, '.');
-		this.config = {};
-		this.sources = {};
-	}
-
-	get aliases() {
-		return ['all', ...(this.config.aliases || [])];
-	}
-
-	get dependencies() {
-		return this.config.dependencies || [];
-	}
-
-	get configPath() {
-		return path.join(this.path.absolute, 'config.toml');
-	}
-
-	get detectPath() {
-		return path.join(this.path.absolute, 'detect.js');
-	}
-
-	get sourcePath() {
-		return path.join(this.path.absolute, 'polyfill.js');
-	}
-
-	get hasConfigFile() {
-		return fs.existsSync(this.configPath);
-	}
-
-	updateConfig() {
-		this.config.size = this.sources.min.length;
-	}
-
-	loadConfig() {
-		return readFile(this.configPath)
-			.catch(error => {
-				throw {
-					name: "Invalid config",
-					message: `Unable to read config from ${this.configPath}`,
-					error
-				};
-			})
-			.then(data => {
-				this.config = TOML.parse(data);
-
-				// Each internal polyfill needs to target all supported browsers at all versions.
-				if (this.path.relative.startsWith('_')) {
-					const supportedBrowsers = Object.keys(UA.getBaselines()).sort((a, b) => a.localeCompare(b));
-					if (!supportedBrowsers.every(browser => this.config.browsers[browser] === "*")){
-						const browserSupport = {};
-						for (const browser of supportedBrowsers)  browserSupport[browser] = "*";
-						throw new Error("Internal polyfill called " + this.name + " is not targeting all supported browsers correctly. It should be: \n" + TOML.stringify(browserSupport));
-					}
-				}
-
-				this.config.detectSource = '';
-				this.config.baseDir = this.path.relative;
-
-				if ('licence' in this.config) {
-					throw new Error(`Incorrect spelling of license property in ${this.name}`);
-				}
-
-				this.config.hasTests = fs.existsSync(path.join(this.path.absolute, 'tests.js'));
-				this.config.isTestable = !('test' in this.config && 'ci' in this.config.test && this.config.test.ci === false);
-				this.config.isPublic = this.name.indexOf('_') !== 0;
-
-				if (fs.existsSync(this.detectPath)) {
-					this.config.detectSource = fs.readFileSync(this.detectPath, 'utf8').replace(/\s*$/, '') || '';
-					this.config.detectSource = this.minifyDetect(this.config.detectSource).min;
-					validateSource(`if (${this.config.detectSource}) true;`, `${this.name} feature detect from ${this.detectPath}`);
-				}
-			});
-	}
-
-	checkLicense() {
-		if ('license' in this.config) {
-			const license = spdxLicenses.spdx(this.config.license);
-			if (license) {
-				// We allow CC0-1.0 and WTFPL as they are GPL compatible.
-				// https://www.gnu.org/licenses/license-list.html#WTFPL
-				// https://www.gnu.org/licenses/license-list.en.html#CC0
-				if (this.config.license !== 'CC0-1.0' && this.config.license !== 'WTFPL' && !license.OSIApproved) {
-					throw new Error(`The license ${this.config.license} (${license.name}) is not OSI approved.`);
-				}
-			} else {
-					throw new Error(`The license ${this.config.license} is not on the SPDX list of licenses ( https://spdx.org/licenses/ ).`);
-			}
-		}
-	}
-
-	loadSources() {
-		return readFile(this.sourcePath, 'utf8')
-			.catch(error => {
-				throw {
-					name: "Invalid source",
-					message: `Unable to read source from ${this.sourcePath}`,
-					error
-				};
-			})
-			.then(raw => this.minifyPolyfill(raw))
-			.catch(error => {
-				throw {
-					message: `Error minifying ${this.name}`,
-					error
-				};
-			})
-			.then(this.removeSourceMaps)
-			.then(sources => {
-				this.sources = sources;
-			});
-	}
-
-	minifyPolyfill(source) {
-		const raw = `\n// ${this.name}\n${source}`;
-
-		if (this.config.build && this.config.build.minify === false) {
-			// skipping any validation or minification process since
-			// the raw source is supposed to be production ready.
-			// Add a line break in case the final line is a comment
-			return { raw: raw + '\n', min: source + '\n' };
-		}
-		else {
-			validateSource(source, `${this.name} from ${this.sourcePath}`);
-
-			const minified = uglify.minify(source, {
-				fromString: true,
-				compress: { screw_ie8: false, keep_fnames: true },
-				mangle: { screw_ie8: false },
-				output: { screw_ie8: false, beautify: false }
-			});
-
-			return { raw, min: minified.code };
-		}
-	}
-
-	minifyDetect(source) {
-		const raw = `\n// ${this.name}\n${source}`;
-
-		if (this.config.build && this.config.build.minify === false) {
-			// skipping any validation or minification process since
-			// the raw source is supposed to be production ready.
-			// Add a line break in case the final line is a comment
-			return { raw: raw + '\n', min: source + '\n' };
-		}
-		else {
-			validateSource(source, `${this.name} from ${this.sourcePath}`);
-
-			const minified = uglify.minify(source, {
-				fromString: true,
-				compress: { screw_ie8: false, expression: true, keep_fnames: true },
-				mangle: { screw_ie8: false },
-				output: { screw_ie8: false, beautify: false, semicolons: false }
-			});
-
-			return { raw, min: minified.code };
-		}
-	}
-
-	removeSourceMaps(source) {
-		const re = /^\/\/#\ssourceMappingURL(.+)$/gm;
-
-		return { raw: source.raw.replace(re, ''), min: source.min.replace(re, '') };
-	}
-
-	writeOutput(root) {
-		const destination = path.join(root, this.name);
-		const files = [
-				['meta.json', JSON.stringify(this.config)],
-				['raw.js', this.sources.raw],
-				['min.js', this.sources.min]
-			];
-
-		return makeDirectory(destination)
-			.then(() => Promise.all(files
-				.map(([name, contents]) => [path.join(destination, name), contents])
-				.map(([path, contents]) => writeFile(path, contents))));
-	}
-}
-
-const source = path.join(__dirname, '../polyfills');
-const destination = path.join(source, '__dist');
-
-console.log(`Writing compiled polyfill sources to ${destination}/...`);
-
-Promise.resolve()
-	.then(() => Promise.all(flattenPolyfillDirectories(source)
-		.map(absolute => new Polyfill(absolute, path.relative(source, absolute)))
-		.filter(polyfill => polyfill.hasConfigFile)
-		.map(polyfill => polyfill.loadConfig()
-			.then(() => polyfill.checkLicense())
-			.then(() => polyfill.loadSources())
-			.then(() => polyfill.updateConfig())
-			.then(() => polyfill)
-		)
-	))
-	.then(polyfills => checkForCircularDependencies(polyfills)
-		.then(() => checkDependenciesExist(polyfills))
-		.then(() => makeDirectory(destination))
-		.then(() => console.log('Waiting for files to be written to disk...'))
-		.then(() => writeAliasFile(polyfills, destination))
-		.then(() => Promise.all(
-			polyfills.map(polyfill => polyfill.writeOutput(destination))
-		))
-	)
-	.then(() => console.log('Sources built successfully'))
-	.catch(error => {
-		console.log(error);
-		console.log(JSON.stringify(error));
-		// eslint-disable-next-line unicorn/no-process-exit
-		process.exit(1);
-	})
-;

package/tasks/clean.js

@@ -1,39 +0,0 @@
-'use strict';
-
-const fs = require('graceful-fs');
-const path = require('path');
-const {promisify} = require('util');
-const glob = promisify(require('glob'));
-const TOML = require('@iarna/toml');
-const cwd = path.join(__dirname, '../');
-const globOptions = { cwd: cwd };
-const rimraf = require('rimraf');
-
-console.log('Cleaning polyfills...');
-glob('polyfills/**/config.toml', globOptions).then((files) => {
-	for (const config of files.map((source) => {
-		try {
-			return Object.assign({ src: source }, TOML.parse(fs.readFileSync(source, 'utf-8')));
-		} catch (error) {
-			throw new Error('Failed on ' + source + '. Error: ' + error);
-		}
-	})
-	.filter((config) => {
-		return 'install' in config;
-	})) {
-		if (config.install.clean && config.install.clean.length > 0) {
-			const polyfillOutputFolder = path.dirname(config.src);
-
-			for (const toClean of config.install.clean) {
-				console.log(' * Removing ' + path.join(path.dirname(config.src), toClean));
-				rimraf.sync(path.resolve(polyfillOutputFolder, toClean));
-			}
-		}
-	}
-}).then(() => {
-	console.log('Polyfills cleaned successfully');
-}).catch((error) => {
-	console.log(error);
-	// eslint-disable-next-line unicorn/no-process-exit
-	process.exit(1);
-});

package/tasks/create-new-polyfill.js

@@ -1,32 +0,0 @@
-"use strict";
-
-const fs = require("fs");
-const path = require("path");
-
-const newPolyfill = process.argv.slice(2)[0];
-
-const polyfillTemplateFolderPath = path.join(__dirname, './polyfill-templates');
-const configTemplate = fs.readFileSync(path.join(polyfillTemplateFolderPath, 'config.toml'), { encoding: 'utf-8'});
-const polyfillTemplate = fs.readFileSync(path.join(polyfillTemplateFolderPath, 'polyfill.js'), { encoding: 'utf-8'});
-const detectTemplate = fs.readFileSync(path.join(polyfillTemplateFolderPath, 'detect.js'), { encoding: 'utf-8'});
-const testsTemplate = fs.readFileSync(path.join(polyfillTemplateFolderPath, 'tests.js'), { encoding: 'utf-8'});
-
-const polyfillFolderPath = path.join(__dirname, "../polyfills/", dotToSlash(newPolyfill));
-fs.mkdirSync(polyfillFolderPath, {recursive: true});
-
-fs.writeFileSync(path.join(polyfillFolderPath, 'polyfill.js'), polyfillTemplate, {encoding: 'utf-8'});
-fs.writeFileSync(path.join(polyfillFolderPath, 'config.toml'), configTemplate, {encoding: 'utf-8'});
-fs.writeFileSync(path.join(polyfillFolderPath, 'detect.js'), detectTemplate, {encoding: 'utf-8'});
-fs.writeFileSync(path.join(polyfillFolderPath, 'tests.js'), testsTemplate.replace('REPLACE_ME', newPolyfill), {encoding: 'utf-8'});
-
-console.log(`Created a new polyfill template at ${polyfillFolderPath}. Woohoo!`);
-
-/**
- * Converts `.`s to `/`s
- *
- * @param {string} string The string to convert
- * @returns {string} The newly converted string
- */
-function dotToSlash(string) {
-	return string.replace(/\./g, '/');
-}

package/tasks/polyfill-templates/config.toml

@@ -1,67 +0,0 @@
-#### Aliases
-# An alias is another name for the polyfill that can be used when requesting a bundle.
-# For example, the alias `es5` is used to replicate an ECMAScript 5 environment.
-aliases = []
-
-#### Dependencies
-# List any web platform features that you use in your polyfill.
-# For example:
-# dependencies = [
-#    "Object.defineProperty"
-# ]
-dependencies = []
-
-#### Specification Link
-# The url which is where the specification for the feature exists.
-# For example the specification for String.prototype.replaceAll is https://tc39.es/ecma262/#sec-string.prototype.replaceall
-spec = ""
-
-#### Documentation Link
-# The url which is where the documentation for the feature exists, this is usually a link to MDN.
-# For example the documentation for String.prototype.replaceAll is https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replaceAll
-docs = ""
-
-#### License
-# The license this code has been given. All code authored within the polyfill-library itself is MIT.
-# Third-party code can use any license which is listed on https://opensource.org/licenses
-license = ""
-
-#### Browser compatibility
-# List what browsers require the polyfill.
-# You can check the related Mozilla Developer Network (MDN) page for the compatibility, they also have their browser compatibility data on GitHub.
-# For example: [MDN nextElementSibling browser support](https://github.com/mdn/browser-compat-data/blob/master/api/NonDocumentTypeChildNode.json#L99-L149)
-# Browsers that can be listed:
-# - android
-# - bb
-# - chrome
-# - edge
-# - edge_mob
-# - firefox
-# - ios_chr
-# - ios_saf
-# - ie
-# - ie_mob
-# - opera
-# - op_mini
-# - safari
-# - firefox_mob
-# - samsung_mob
-# The browser list uses a form of semantic versioning to indicate which browser requires polyfilling.
-# If all versions of a browser require the polyfill you can use the wildcard asterisk (*):
-# For specific versions you can specify a number, for example if a polyfill is required in Internet Explorer 8 and below you can use "<9"
-[browsers]
-android = "*"
-bb = "*"
-chrome = "*"
-edge = "*"
-edge_mob = "*"
-firefox = "*"
-ios_chr = "*"
-ios_saf = "*"
-ie = "*"
-ie_mob = "*"
-opera = "*"
-op_mini = "*"
-safari = "*"
-firefox_mob = "*"
-samsung_mob = "*"

package/tasks/polyfill-templates/detect.js

@@ -1 +0,0 @@
-true /* This needs to be an expression which evaluates to true if the feature exists */

package/tasks/polyfill-templates/polyfill.js

@@ -1,6 +0,0 @@
-/* global self */
-// eslint-disable-next-line no-unused-vars
-(function (global) {
-	// Place all polyfill code within this function.
-
-}(self));

package/tasks/polyfill-templates/tests.js

@@ -1,5 +0,0 @@
-/* eslint-env mocha, browser */
-// eslint-disable-next-line no-unused-vars
-/* globals proclaim */
-
-describe('REPLACE_ME', function () {});

package/tasks/updatesources.js

@@ -1,68 +0,0 @@
-'use strict';
-
-const fs = require('graceful-fs');
-const path = require('path');
-const {promisify} = require('util');
-const glob = promisify(require('glob'));
-const TOML = require('@iarna/toml');
-const cwd = path.join(__dirname, '../');
-const globOptions = { cwd: cwd };
-
-const loadSource = polyfillPaths => {
-	return polyfillPaths.map(p => fs.readFileSync(p)).join('');
-};
-
-const installPolyfill = config => {
-	const polyfillOutputFolder = path.dirname(config.src);
-	const polyfillOutputPath = path.join(polyfillOutputFolder, 'polyfill.js');
-	const polyfillAlreadyExists = fs.existsSync(polyfillOutputPath);
-
-	const polyfillSourcePaths = (config.install.paths || [''])
-		.map(p => require.resolve(path.join(config.install.module, p)))
-	;
-	const newPolyfill = loadSource(polyfillSourcePaths);
-
-	const logPrefix = path.basename(polyfillOutputFolder) + ': ';
-	if (polyfillAlreadyExists) {
-		const currentPolyfill = fs.readFileSync(polyfillOutputPath, 'utf-8');
-		if (newPolyfill === currentPolyfill) {
-			console.log(logPrefix + 'No change');
-			return;
-		} else {
-			console.log(logPrefix + 'Polyfill updated, replacing old version');
-			fs.unlinkSync(polyfillOutputPath);
-		}
-	} else {
-		console.log(logPrefix + 'New polyfill');
-	}
-
-	polyfillSourcePaths.map(p => console.log('  from '+path.relative(cwd, p)));
-	fs.writeFileSync(polyfillOutputPath, newPolyfill);
-
-	if (config.install.postinstall) {
-		console.log(' * Running module-specific update task ' + config.install.postinstall);
-		require(path.resolve(polyfillOutputFolder, config.install.postinstall));
-	}
-};
-
-console.log('Updating third-party polyfills...');
-glob('polyfills/**/config.toml', globOptions)
-	.then(files => {
-		for (const toml of files
-			.map(source => {
-				try {
-					return Object.assign({ src: source }, TOML.parse(fs.readFileSync(source, 'utf-8')));
-				} catch (error) {
-					throw new Error('Failed on ' + source + '. Error: ' + error);
-				}
-			})
-			.filter(config => 'install' in config))  installPolyfill(toml);
-
-	})
-	.then(() => console.log('Polyfills updated successfully'))
-	.catch(error => {
-		console.log(error);
-		// eslint-disable-next-line unicorn/no-process-exit
-		process.exit(1);
-	})
-;

package/test/.eslintrc.js

@@ -1,10 +0,0 @@
-"use stirct";
-
-module.exports = {
-	env: {
-		commonjs: true,
-		es6: true,
-		mocha: true,
-		node: true
-	}
-};

package/test/end-to-end/generating-bundles.test.js

@@ -1,29 +0,0 @@
-
-'use strict';
-
-const assert = require('proclaim');
-const polyfillLibrary = require('../..');
-
-describe("polyfill-library", function () {
-	this.timeout(30000);
-
-	it('should produce same output for same bundle', async () => {
-		const bundle1 = await polyfillLibrary.getPolyfillString({
-			features: {
-				all: {}
-			},
-			uaString: 'other/0.0.0',
-			unknown: 'polyfill'
-		});
-
-		const bundle2 = await polyfillLibrary.getPolyfillString({
-			features: {
-				all: {}
-			},
-			uaString: 'other/0.0.0',
-			unknown: 'polyfill'
-		});
-
-		assert.deepStrictEqual(bundle1, bundle2);
-	});
-});