@flourish/sdk 3.18.0 → 3.19.0

package/README.md

@@ -52,6 +52,7 @@ The main Flourish configuration file for your template. The top-level properties
 * `credits` Optional credits for data sources, map tiles, etc, in Markdown format
 * `image_download` Flag to indicate whether image snapshots work for the template (default is `true`)
 * `svg_download` Flag to indicate whether downloading a snapshot of template as SVG will work (default is `true`)
+* `is_premium` Flag to indicate that this is a premium template, meaning only particular feature bundles give access to it (default is `false`)
 
 Other properties are [settings](#settings), [data](#data), [build](#build), and [tour](#tour), which are described below.
 

package/RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+# 3.19.0
+* Add the `is_premium` top level property in template.yml to indicate that this is a premium template
+
+# 3.18.1
+* Addresses some technical debt.
+
 # 3.18.0
 * Support `tag` property in setting
 

package/bin/{flourish → flourish.js}

@@ -55,59 +55,48 @@ process.on("unhandledRejection", function(reason, p) {
 	throw reason;
 });
 
+const COMMANDS = [
+	"help",
+	"version",
+	"new",
+	"build",
+	"run",
+	"register",
+	"login",
+	"logout",
+	"whoami",
+	"assign-version-number",
+	"publish",
+	"delete",
+	"upgrade",
+	"list",
+	"history"
+];
+
 function main() {
 	const args = minimist(process.argv.slice(2), OPTS);
 
+	if (args._[0] === "is" && args._[1] === "the") {
+		return log.victory("Word!");
+	}
+
 	// minimist unhelpfully treats numeric strings as numbers;
 	// which means we have to turn them back into strings.
-	args._ = args._.map(x => "" + x);
-
-	let command = args._[0];
-
-	const server_opts = {
-		host: args.host,
-		user: args.user,
-		password: args.password,
-	};
+	args._ = args._.map(String);
 
+	let [command] = args._;
 	if (args.version) command = "version";
 	else if (args.help) command = "help";
 
-	switch (command) {
-		case "help":
-		case "version":
-
-		case "new":
-		case "build":
-		case "run":
-
-		case "register":
-		case "login":
-		case "logout":
-
-		case "whoami":
-
-		case "assign-version-number":
-		case "publish":
-		case "delete":
-		case "upgrade":
-		case "list":
-		case "history":
-			require("../lib/cmd/" + command)(args, server_opts);
-			break;
-
-		case "is":
-			if (args._[1] === "the") {
-				log.victory("Word!");
-				break;
-			}
-
-		default:
-			log.die("Unknown command '" + command + "'. Type 'flourish help' for help.");
+	if (!command) {
+		return log.die("No command specified. Type ‘flourish help’ for help.");
+	}
 
-		case undefined:
-			log.die("No command specified. Type ‘flourish help’ for help.");
+	if (!COMMANDS.includes(command)) {
+		return log.die(`Unknown command '${command}'. Type 'flourish help' for help.`);
 	}
+
+	require("../lib/cmd/" + command).command(args);
 }
 
 main();

package/lib/cmd/assign-version-number.js

@@ -5,7 +5,7 @@ const semver = require("@flourish/semver");
 const log = require("../log"),
       sdk = require("../sdk");
 
-function assign_version_number(args, server_opts) {
+exports.command = function assign_version_number(args) {
 	let template_id_promise, template_version;
 	if (args._.length == 2) {
 		// Assume the supplied argument is a version number, and try to get the id from the current directory
@@ -27,7 +27,7 @@ function assign_version_number(args, server_opts) {
 
 	template_id_promise.then(template_id => {
 		if (args.as) template_id = args.as + "/" + template_id;
-		return sdk.request(server_opts, "template/assign-version-number", { id: template_id, version: template_version })
+		return sdk.request(args, "template/assign-version-number", { id: template_id, version: template_version })
 		.then(() => {
 			log.success(`Assigned version number ${template_version} to template ${template_id}`);
 		});
@@ -36,14 +36,12 @@ function assign_version_number(args, server_opts) {
 		if (args.debug) log.die("Failed to assign version number", error.message, error.stack);
 		else log.die("Failed to assign version number", error.message);
 	});
-}
+};
 
-assign_version_number.help = `
+exports.help = `
 flourish assign-version-number [template-id] version
 
 Assign a version number to a template that does not have one yet.
 If template-id is omitted, uses the id of the template in the
 current directory.
 `;
-
-module.exports = assign_version_number;

package/lib/cmd/build.js

@@ -5,7 +5,7 @@ var fs = require("fs"),
     log = require("../log"),
     sdk = require("../sdk");
 
-function build(args) {
+exports.command = function build(args) {
 	const template_dir = ".";
 	if (!fs.existsSync("template.yml")) {
 		log.die("No template.yml file found in the current directory");
@@ -20,7 +20,7 @@ function build(args) {
 	}
 
 	sdk.buildRules(template_dir)
-		.then((rules) => {
+		.then(async rules => {
 			const script_by_key = new Map();
 			for (const rule of rules) script_by_key.set(rule.key, rule.script);
 
@@ -32,17 +32,15 @@ function build(args) {
 				scripts_to_run.push(script_by_key.get(key));
 			}
 
-			let p = Promise.resolve();
-			for (let script of scripts_to_run) {
-				p = p.then(() => sdk.runBuildCommand(template_dir, script, args.env));
+			for (const script of scripts_to_run) {
+				await sdk.runBuildCommand(template_dir, script, args.env);
 			}
-			return p;
 		})
 		.then(() => log.victory("Done!"))
 		.catch((error) => log.die("Failed to build template", error.message, error.stack));
-}
+};
 
-build.help = `
+exports.help = `
 flourish build [options] [build rules...]
 
 Build the template in the current directory.
@@ -61,5 +59,3 @@ Options:
 	Set the NODE_ENV environment variable to the specified value before running
 	the build script.
 `;
-
-module.exports = build;

package/lib/cmd/delete.js

@@ -3,7 +3,7 @@
 var log = require("../log"),
     sdk = require("../sdk");
 
-function _delete(args, server_opts) {
+exports.command = function _delete(args) {
 	let template_id = args._[1],
 	    template_version = args._[2];
 
@@ -14,7 +14,7 @@ function _delete(args, server_opts) {
 		template_id = args.as + "/" + template_id;
 	}
 
-	sdk.request(server_opts, "template/delete", { id: template_id, version: template_version, force: !!args.force })
+	sdk.request(args, "template/delete", { id: template_id, version: template_version, force: !!args.force })
 		.then(() => {
 			if (template_version) {
 				log.success(`Deleted template ${template_id} version ${template_version}`);
@@ -27,9 +27,9 @@ function _delete(args, server_opts) {
 			if (args.debug) log.die("Failed to delete template", error.message, error.stack);
 			else log.die("Failed to delete template", error.message);
 		});
-}
+};
 
-_delete.help = `
+exports.help = `
 flourish delete [--force] template_id version
 
 Deletes the specified template from the server, assuming it has previously
@@ -44,5 +44,3 @@ If the template is in use by users other than you, it will not be possible
 to delete it. If you have used it, you can pass the --force flag to delete
 the template and associated visualisations.
 `;
-
-module.exports = _delete;

package/lib/cmd/help.js

@@ -4,7 +4,7 @@ var path = require("path"),
 
     log = require("../log");
 
-function help(args) {
+exports.command = function help(args) {
 	const topic = args._[args._[0] === "help" ? 1 : 0] || "help";
 
 	if (topic.indexOf(path.sep) == -1
@@ -18,9 +18,9 @@ function help(args) {
 			log.die("No such help topic: " + topic);
 		}
 	}
-}
+};
 
-help.help = `
+exports.help = `
 Commands:
 	flourish assign-version-number [template id] version
 	flourish build [build rules...]
@@ -43,5 +43,3 @@ Type “flourish help [command]” for more on a particular command.
 To get started, use “flourish new” to create a new template and
 “flourish run” to run it.
 `;
-
-module.exports = help;

package/lib/cmd/history.js

@@ -9,7 +9,7 @@ function byVersion(a, b) {
 	return semver.cmp(semver.parse(a.version), semver.parse(b.version));
 }
 
-function history(args, server_opts) {
+exports.command = function history(args) {
 	const username_template_id = args._[1];
 	if (!username_template_id) {
 		log.die("Please specify a template id. E.g. flourish history my-template");
@@ -28,7 +28,7 @@ function history(args, server_opts) {
 	else if (username_template_id) {
 		template_id = username_template_id;
 	}
-	sdk.request(server_opts, "template/history", { username, id: template_id })
+	sdk.request(args, "template/history", { username, id: template_id })
 		.then((result) => {
 			const template_versions = result.sort(byVersion);
 
@@ -40,9 +40,9 @@ function history(args, server_opts) {
 			}
 		})
 		.catch((error) => log.die("Failed to list template history", error.message, error.stack));
-}
+};
 
-history.help = `
+exports.help = `
 flourish history [template id]
 
 List the version numbers of a published template.
@@ -55,5 +55,3 @@ With the --full option, prints all the template metadata in JSON format.
 
 This command requires you to be logged in to an account.
 `;
-
-module.exports = history;

package/lib/cmd/list.js

@@ -16,7 +16,7 @@ function byExternalIdAndVersion(a, b) {
 	return semver.cmp(semver.parse(a.version), semver.parse(b.version));
 }
 
-function list(args, server_opts) {
+exports.command = function list(args) {
 	const username_template_id = args._[1];
 	let username = args.as,
 	    template_id;
@@ -33,7 +33,7 @@ function list(args, server_opts) {
 	else if (username_template_id) {
 		template_id = username_template_id;
 	}
-	sdk.request(server_opts, "template/list", { username })
+	sdk.request(args, "template/list", { username })
 		.then((result) => {
 			let templates = result.templates;
 
@@ -55,9 +55,9 @@ function list(args, server_opts) {
 			}
 		})
 		.catch((error) => log.die("Failed to list templates", error.message, error.stack));
-}
+};
 
-list.help = `
+exports.help = `
 flourish list [template id]
 
 List the ids and versions of your published templates.
@@ -69,5 +69,3 @@ With the --full option, prints all the template metadata in JSON format.
 
 This command requires you to be logged in to an account.
 `;
-
-module.exports = list;

package/lib/cmd/login.js

@@ -7,7 +7,7 @@ var readline = require("readline"),
     log = require("../log"),
     sdk = require("../sdk");
 
-function login(args, server_opts) {
+exports.command = function login(args) {
 	function getEmail() {
 		return new Promise(function(resolve, reject) {
 			// If an email address was given on the command-line, use that
@@ -35,14 +35,14 @@ function login(args, server_opts) {
 	}
 
 	function login(email, password) {
-		return sdk.request(server_opts, "user/login", { email: email, password: password })
+		return sdk.request(args, "user/login", { email: email, password: password })
 			.then((response) => {
 				const sdk_token = response.sdk_token || response.api_token;
 				if (!sdk_token) {
 					log.die("Unexpected response from server", JSON.stringify(response));
 				}
 
-				sdk.setSdkToken(server_opts, sdk_token)
+				sdk.setSdkToken(args, sdk_token)
 					.then(() => log.victory("Logged in as " + email))
 					.catch((error) => log.die("Failed to save SDK token", error.message));
 			});
@@ -52,9 +52,9 @@ function login(args, server_opts) {
 		.then((email) => Promise.all([email, getPassword()]))
 		.then(([email, password]) => login(email, password))
 		.catch((error) => log.die("Unexpected error", error.message, error.stack));
-}
+};
 
-login.help = `
+exports.help = `
 flourish login [email_address]
 
 Log in to Flourish. You will be prompted for a password.
@@ -65,5 +65,3 @@ When you have logged in successfully, your access token will be recorded
 in the file .flourish_sdk in your HOME or USERPROFILE directory. Subsequent
 flourish commands will use this token to authenticate with the server.
 `;
-
-module.exports = login;

package/lib/cmd/logout.js

@@ -3,17 +3,15 @@
 var log = require("../log"),
     sdk = require("../sdk");
 
-function logout() {
+exports.command = function logout() {
 	sdk.deleteSdkTokens()
 		.then(() => log.victory("Deleted all SDK tokens"))
 		.catch((error) => log.die(error));
-}
+};
 
-logout.help = `
+exports.help = `
 flourish logout
 
 Deletes the .flourish_sdk file from your HOME or USERPROFILE directory. You
 will not be able to communicate with the server until you “flourish login”
 `;
-
-module.exports = logout;

package/lib/cmd/new.js

@@ -7,7 +7,7 @@ var cross_spawn = require("cross-spawn"),
 
     log = require("../log");
 
-function _new(args) {
+exports.command = function _new(args) {
 	const new_template_path = args._[1];
 	if (!new_template_path) {
 		log.die("Please specify a directory name for the new template. E.g. flourish new my_template");
@@ -46,9 +46,9 @@ function _new(args) {
 				"Try running it by hand");
 		}
 	});
-}
+};
 
-_new.help = `
+exports.help = `
 flourish new directory_name
 
 Creates a new skeleton Flourish template in the named directory,
@@ -58,5 +58,3 @@ The skeleton template has an example build configuration that uses
 Less to compile stylesheets and Rollup to bundle JavaScript code.
 You can run it in the SDK using “flourish run”.
 `;
-
-module.exports = _new;

package/lib/cmd/publish.js

@@ -48,6 +48,7 @@ function zipUpTemplate(template_dir, config) {
 				categories: config.categories,
 				joinable_data: config.joinable_data,
 				tour: JSON.stringify(config.tour),
+				is_premium: config.is_premium,
 			}), { name: "metadata.json" });
 			if (config.settings) zip.append(JSON.stringify(config.settings), { name: "settings.js" });
 			if (config.data) zip.append(JSON.stringify(config.data), { name: "data.json" });
@@ -110,7 +111,7 @@ async function uploadTemplate(server_opts, template_id, external_version, zip_fi
 	return sdk.request(server_opts, "template/publish", body);
 }
 
-function publish(args, server_opts) {
+exports.command = function publish(args) {
 	const template_dir = args._[1] || ".";
 
 	(args.build ? sdk.buildTemplate(template_dir, "production", "publish") : Promise.resolve())
@@ -139,11 +140,11 @@ function publish(args, server_opts) {
 			log.success("Preparing template with id " + template_id + " for upload.");
 
 			return zipUpTemplate(template_dir, config)
-				.then((zip_filename) => uploadTemplate(server_opts, template_id, external_version, zip_filename))
-				.then(() => sdk.request(server_opts, "user/whoami", {}))
+				.then((zip_filename) => uploadTemplate(args, template_id, external_version, zip_filename))
+				.then(() => sdk.request(args, "user/whoami", {}))
 				.then((user_info) => {
 					let protocol = "https";
-					if (server_opts.host.match(/^(localhost|127\.0\.0\.1|.*\.local)(:\d+)?$/)) {
+					if (args.host.match(/^(localhost|127\.0\.0\.1|.*\.local)(:\d+)?$/)) {
 						protocol = "http";
 					}
 
@@ -156,12 +157,12 @@ function publish(args, server_opts) {
 					}
 					if (!external_version) {
 						log.victory("Upload successful!",
-							`Your template is available at ${protocol}://${server_opts.host}/@${template_path}`);
+							`Your template is available at ${protocol}://${args.host}/@${template_path}`);
 					}
 					else {
 						const dt = new Date();
 						log.victory(`Uploaded version ${external_version} on ${dt.toDateString()} at ${dt.toTimeString()}`,
-							`Your template is available at ${protocol}://${server_opts.host}/@${template_path}/${external_version}`);
+							`Your template is available at ${protocol}://${args.host}/@${template_path}/${external_version}`);
 					}
 					warnings.forEach(warning => log.warn(warning));
 				});
@@ -170,9 +171,9 @@ function publish(args, server_opts) {
 			if (args.debug) log.die("Failed to upload template", error.message, error.stack);
 			else log.die("Failed to upload template", error.message);
 		});
-}
+};
 
-publish.help = `
+exports.help = `
 flourish publish [--patch] [--prerelease] [--release] [directory_name]
 
 Build and publish the template in the named directory, or in the current
@@ -192,5 +193,3 @@ Options:
 --release
 	Remove the prerelease tag before publishing.
 `;
-
-module.exports = publish;

package/lib/cmd/register.js

@@ -7,7 +7,7 @@ var readline = require("readline"),
     log = require("../log"),
     sdk = require("../sdk");
 
-function register(args, server_opts) {
+exports.command = function register(args) {
 	const questions = [
 		{ text: "Username: ", prop: "username" },
 		{ text: "Name: ", prop: "display_name" },
@@ -96,7 +96,7 @@ function register(args, server_opts) {
 	}
 
 	function register(answers) {
-		return sdk.request(server_opts, "user/register", answers)
+		return sdk.request(args, "user/register", answers)
 			.then((response) => {
 				const sdk_token = response.sdk_token || response.api_token;
 				if (!sdk_token) {
@@ -110,13 +110,13 @@ function register(args, server_opts) {
 		.then((answers) => Promise.all([answers, getPassword()]))
 		.then(([answers, password]) => Promise.all([answers, password, agreeTerms()]))
 		.then(([answers, password, _]) => register(Object.assign(answers, { password })))
-		.then((sdk_token) => sdk.setSdkToken(server_opts, sdk_token))
+		.then((sdk_token) => sdk.setSdkToken(args, sdk_token))
 
 		.then(() => log.victory("Account registered successfully!"))
 		.catch((error) => log.die(error.message));
-}
+};
 
-register.help = `
+exports.help = `
 flourish register
 
 Prompt for information and register an account with Flourish.
@@ -125,5 +125,3 @@ You will automatically be logged in to your new account.
 This account can be used on https://flourish.studio/ as well
 as in the SDK.
 `;
-
-module.exports = register;

package/lib/cmd/run.js

@@ -8,7 +8,7 @@ var fs = require("fs"),
 
     server = require("../../server");
 
-function run(args) {
+exports.command = function run(args) {
 	const template_dir = args._[1] || ".";
 	const port = +args.port;
 
@@ -61,9 +61,9 @@ function run(args) {
 				});
 		}
 	});
-}
+};
 
-run.help = `
+exports.help = `
 flourish run [-o|--open] [--no-build] [--port=1685] [directory_name]
 
 Builds the template and runs the SDK server. If directory_name is omitted it
@@ -88,5 +88,3 @@ Options:
 --no-build
 	Skip the build process
 `;
-
-module.exports = run;

package/lib/cmd/upgrade/1-convert-config-to-yaml.js

@@ -48,7 +48,7 @@ function deleteIfExists(file_path) {
 	});
 }
 
-function upgrade(template_dir) {
+exports.upgrade = function upgrade(template_dir) {
 	function loadSettings() {
 		return loadFile([template_dir, "settings.js"], {})
 			.then((contents) => {
@@ -78,16 +78,15 @@ function upgrade(template_dir) {
 		return Promise.all([
 			loadMetadata(),
 			loadSettings(),
-			loadTemplateDataBindings(),
-			sdk.getSDKMajorVersion(),
+			loadTemplateDataBindings()
 		])
-		.then(([metadata, settings, data_bindings, sdk_version]) => {
+		.then(([metadata, settings, data_bindings]) => {
 			const o = {
 				id: metadata.id,
 				name: metadata.name,
 				author: metadata.author,
 
-				sdk_version,
+				sdk_version: sdk.SDK_MAJOR_VERSION,
 
 				settings: settings
 			};
@@ -127,7 +126,6 @@ function upgrade(template_dir) {
 			.then(() => resolve(true), reject);
 		});
 	});
-}
+};
 
-upgrade.title = "Convert configuration files to YAML format";
-module.exports = upgrade;
+exports.title = "Convert configuration files to YAML format";

package/lib/cmd/upgrade/2-convert-index-html.js

@@ -15,7 +15,7 @@ function convert(html) {
 	});
 }
 
-function upgrade(template_dir) {
+exports.upgrade = function upgrade(template_dir) {
 	return new Promise(function(resolve, reject) {
 		fs.stat(template_dir, function(error, stat) {
 			if (error) reject(new Error(`Could not access ${template_dir}: ${error.message}`));
@@ -38,7 +38,6 @@ function upgrade(template_dir) {
 			});
 		});
 	});
-}
+};
 
-upgrade.title = "Convert index.html to mustache-free format";
-module.exports = upgrade;
+exports.title = "Convert index.html to mustache-free format";

package/lib/cmd/upgrade/3-add-build-config.js

@@ -15,7 +15,7 @@ function addBuildRules(config) {
 	return config;
 }
 
-function upgrade(template_dir) {
+exports.upgrade = function upgrade(template_dir) {
 	return new Promise(function(resolve, reject) {
 		fs.stat(template_dir, function(error, stat) {
 			if (error) reject(new Error(`Could not access ${template_dir}: ${error.message}`));
@@ -30,7 +30,6 @@ function upgrade(template_dir) {
 				.then(resolve, reject);
 		});
 	});
-}
+};
 
-upgrade.title = "Add build rules to template.yml";
-module.exports = upgrade;
+exports.title = "Add build rules to template.yml";

package/lib/cmd/upgrade/4-remove-autoheight-config.js

@@ -3,7 +3,7 @@
 var fs = require("fs"),
     sdk = require("../../sdk");
 
-function upgrade(template_dir) {
+exports.upgrade = function upgrade(template_dir) {
 	return new Promise(function(resolve, reject) {
 		fs.stat(template_dir, function(error, stat) {
 			if (error) return reject(new Error(`Could not access ${template_dir}: ${error.message}`));
@@ -20,7 +20,6 @@ function upgrade(template_dir) {
 				.then(resolve, reject);
 		});
 	});
-}
+};
 
-upgrade.title = "Remove autoheight config from template.yml";
-module.exports = upgrade;
+exports.title = "Remove autoheight config from template.yml";