@flourish/sdk 3.17.3 → 3.20.0

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";

package/lib/cmd/upgrade/index.js

@@ -9,8 +9,8 @@ const upgrades = [
 	require("./4-remove-autoheight-config"),
 ];
 
-function runUpgrade(upgrade, template_dir) {
-	log.info("Running: " + upgrade.title);
+function runUpgrade({ upgrade, title }, template_dir) {
+	log.info("Running: " + title);
 
 	return upgrade(template_dir)
 		.then((upgraded) => {
@@ -34,7 +34,7 @@ function runUpgrades(template_dir, num_run=0) {
 		.then(() => runUpgrades(template_dir, num_run));
 }
 
-function upgrade(args) {
+exports.command = function upgrade(args) {
 	const template_dir = args._[1] || ".";
 	runUpgrades(template_dir)
 		.then((num_upgrades) => {
@@ -47,9 +47,9 @@ function upgrade(args) {
 			if (args.debug) log.problem("Upgrade failed", error.message, error.stack);
 			else log.problem("Upgrade failed", error.message);
 		});
-}
+};
 
-upgrade.help = `
+exports.help = `
 flourish upgrade [template_directory]
 
 Upgrade the template in template_directory, or in the current directory if no
@@ -58,5 +58,3 @@ Flourish.
 
 This is only needed when incompatible changes have been made to Flourish.
 `;
-
-module.exports = upgrade;

package/lib/cmd/version.js

@@ -1,19 +1,11 @@
 "use strict";
 
-var log = require("../log"),
-    sdk = require("../sdk");
+var sdk = require("../sdk");
 
-function version(args) {
-	sdk.getSdkVersion()
-		.then((version_number) => console.log(version_number))
-		.catch((error) => {
-			if (args.debug) log.die("Failed to get SDK version number", error.message, error.stack);
-			else log.die("Failed to get SDK version number", error.message);
-		});
-}
+exports.command = function version() {
+	console.log(sdk.SDK_VERSION);
+};
 
-version.help = `
+exports.help = `
 Prints the version number of the Flourish SDK.
 `;
-
-module.exports = version;

package/lib/cmd/whoami.js

@@ -3,8 +3,8 @@
 var log = require("../log"),
     sdk = require("../sdk");
 
-function whoami(args, server_opts) {
-	sdk.request(server_opts, "user/whoami", {})
+exports.command = function whoami(args) {
+	sdk.request(args, "user/whoami", {})
 		.then((user_info) => {
 			if (args.full) {
 				console.log(JSON.stringify(user_info, null, 4));
@@ -14,14 +14,12 @@ function whoami(args, server_opts) {
 			}
 		})
 		.catch((error) => log.die("Unexpected error", error.message, error.stack));
-}
+};
 
-whoami.help = `
+exports.help = `
 flourish [--full] whoami
 
 With no options, prints the username of the currently logged-in account.
 
 With the --full option, prints all the account metadata in JSON format.
 `;
-
-module.exports = whoami;

package/lib/sdk.js

@@ -19,27 +19,8 @@ const fs = require("fs"),
 const sdk_tokens_file = path.join(process.env.HOME || process.env.USERPROFILE, ".flourish_sdk");
 
 const YAML_DUMP_OPTS = { flowLevel: 4 };
-
-const package_json_filename = path.join(__dirname, "..", "package.json");
-var sdk_version = null;
-function getSdkVersion() {
-	if (sdk_version) return Promise.resolve(sdk_version);
-	return new Promise(function(resolve, reject) {
-		fs.readFile(package_json_filename, "utf8", function(error, package_json) {
-			if (error) return reject(error);
-			const package_object = JSON.parse(package_json);
-			resolve(sdk_version = package_object.version);
-		});
-	});
-}
-
-function getSDKMajorVersion() {
-	return getSdkVersion()
-		.then((sdk_version) => {
-			const version_tuple = sdk_version.split(".").map((x) => parseInt(x));
-			return version_tuple[0];
-		});
-}
+const SDK_VERSION = require("../package.json").version;
+const SDK_MAJOR_VERSION = semver.parse(SDK_VERSION)[0];
 
 function getSdkToken(server_opts) {
 	return new Promise(function(resolve, reject) {
@@ -110,7 +91,6 @@ async function request(server_opts, method, data) {
 		}
 	}
 
-	const sdk_version = await getSdkVersion();
 	const protocol = server_opts.host.match(/^(localhost|127\.0\.0\.1|.*\.local)(:\d+)?$/) ? "http:" : "https:";
 	const url = `${protocol}//${server_opts.host}/api/v1/${method}`;
 	const options = { method: data ? "POST" : "GET" };
@@ -120,12 +100,12 @@ async function request(server_opts, method, data) {
 			if (sdk_token) {
 				data.append("sdk_token", sdk_token);
 			}
-			data.append("sdk_version", sdk_version);
+			data.append("sdk_version", SDK_VERSION);
 			options.headers = data.getHeaders();
 			options.body = data;
 		}
 		else {
-			options.body = JSON.stringify({ ...data, sdk_token, sdk_version });
+			options.body = JSON.stringify({ ...data, sdk_token, sdk_version: SDK_VERSION });
 			options.headers = { "content-type": "application/json" };
 		}
 	}
@@ -345,33 +325,45 @@ async function resolveImports(config, template_dir) {
 			qualifyNames(imported_settings, setting.property);
 			if ("overrides" in setting) {
 				setting.overrides.forEach(function(override) {
-					const properties = Array.isArray(override.property) ? override.property : [override.property];
+					const use_tags = override.tag;
+					let settings_to_target = [];
+					if (use_tags) settings_to_target = Array.isArray(override.tag) ? override.tag : [override.tag];
+					else settings_to_target = Array.isArray(override.property) ? override.property : [override.property];
 					const method = override.method || "replace";
-					for (let property of properties) {
-						const s = imported_settings.find(function(setting) { return setting.property === property; });
-						if (!s) continue;
+					for (let target of settings_to_target) {
+						const settings_to_override = imported_settings.filter(function(setting) {
+							if (use_tags) {
+								if (!setting.tag) return false;
+								const setting_tags = Array.isArray(setting.tag) ? setting.tag : [setting.tag];
+								return setting_tags.includes(target);
+							}
+							return setting.property === target;
+						});
+						if (!settings_to_override.length) continue;
 						for (let name in override) {
-							if (name === "property" || name === "method") continue;
-							if (method === "extend") {
-								if (["show_if", "hide_if"].includes(name) && typeof override[name] === "boolean") {
-									throw new Error(`Cannot extend a ${name} with Boolean value for property ${s.property}`);
-								}
-								let extendee = s[name];
-								if (extendee === undefined) {
-									if (name === "show_if" && s.hide_if !== undefined) {
-										throw new Error(`Cannot extend a show_if when hide_if defined for property ${s.property}`);
+							for (const s of settings_to_override) {
+								if (name === "property" || name === "tag" || name === "method") continue;
+								if (method === "extend") {
+									if (["show_if", "hide_if"].includes(name) && typeof override[name] === "boolean") {
+										throw new Error(`Cannot extend a ${name} with Boolean value for property ${s.property}`);
 									}
-									else if (name === "hide_if" && s.show_if !== undefined) {
-										throw new Error(`Cannot extend a hide_if when show_if defined for property ${s.property}`);
+									let extendee = s[name];
+									if (extendee === undefined) {
+										if (name === "show_if" && s.hide_if !== undefined) {
+											throw new Error(`Cannot extend a show_if when hide_if defined for property ${s.property}`);
+										}
+										else if (name === "hide_if" && s.show_if !== undefined) {
+											throw new Error(`Cannot extend a hide_if when show_if defined for property ${s.property}`);
+										}
+										extendee = {};
 									}
-									extendee = {};
+									s[name] = extendItem(extendee, override[name]);
+								}
+								else {
+									s[name] = override[name];
+									if (name === "show_if" && s.hide_if) delete s.hide_if;
+									else if (name === "hide_if" && s.show_if) delete s.show_if;
 								}
-								s[name] = extendItem(extendee, override[name]);
-							}
-							else {
-								s[name] = override[name];
-								if (name === "show_if" && s.hide_if) delete s.hide_if;
-								else if (name === "hide_if" && s.show_if) delete s.show_if;
 							}
 						}
 					}
@@ -528,18 +520,15 @@ function writePackageJson(template_dir, json) {
 }
 
 function checkTemplateVersion(template_dir) {
-	return Promise.all([
-		readConfig(template_dir),
-		getSDKMajorVersion(),
-	]).then(([config, sdk_major_version]) => {
+	return readConfig(template_dir).then(config => {
 		const template_sdk_version = config.sdk_version;
 		if (!template_sdk_version) {
 			throw new Error("Template does not specify an sdk_version");
 		}
-		if (template_sdk_version < sdk_major_version) {
+		if (template_sdk_version < SDK_MAJOR_VERSION) {
 			throw new Error("This template was built for an older version of Flourish. Try running 'flourish upgrade'");
 		}
-		if (template_sdk_version > sdk_major_version) {
+		if (template_sdk_version > SDK_MAJOR_VERSION) {
 			throw new Error("This template was built for an newer version of Flourish than you have. Try updating the SDK.");
 		}
 	});
@@ -559,7 +548,7 @@ const TEMPLATE_SPECIAL = new Set([
 ]);
 
 module.exports = {
-	checkTemplateVersion, getSdkVersion, getSDKMajorVersion,
+	checkTemplateVersion,
 
 	getSdkToken, setSdkToken, deleteSdkTokens,
 	request,
@@ -567,5 +556,5 @@ module.exports = {
 	readConfig, readAndValidateConfig, writeConfig, buildRules,
 	incrementPrereleaseTag, removePrereleaseTag, incrementPatchVersion,
 
-	TEMPLATE_SPECIAL_FILES, TEMPLATE_SPECIAL_DIRECTORIES, TEMPLATE_SPECIAL,
+	TEMPLATE_SPECIAL_FILES, TEMPLATE_SPECIAL_DIRECTORIES, TEMPLATE_SPECIAL, SDK_VERSION, SDK_MAJOR_VERSION
 };