@flourish/sdk 5.0.0 → 5.1.0

package/common/utils/data.js

@@ -1,16 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.interpretColumn = exports.getSlicedData = exports.transposeNestedArray = exports.stripCommonFixes = exports.tidyTable = exports.dropReturnCharacters = exports.trimTrailingEmptyRows = exports.mulberry32 = exports.getRandomSeededSample = exports.getColumnTypesForData = exports.extractData = void 0;
+exports.createInterpreter = void 0;
+exports.extractData = extractData;
+exports.getColumnTypesForData = getColumnTypesForData;
+exports.getRandomSeededSample = getRandomSeededSample;
+exports.mulberry32 = mulberry32;
+exports.trimTrailingEmptyRows = trimTrailingEmptyRows;
+exports.dropReturnCharacters = dropReturnCharacters;
+exports.tidyTable = tidyTable;
+exports.stripCommonFixes = stripCommonFixes;
+exports.transposeNestedArray = transposeNestedArray;
+exports.getSlicedData = getSlicedData;
+exports.interpretColumn = interpretColumn;
+exports.sortDataTables = sortDataTables;
 const interpreter_1 = require("@flourish/interpreter");
 require("./polyfills");
-function extractData(data_binding, data_by_id, column_types_by_id, template_data_binding) {
+var interpreter_2 = require("@flourish/interpreter");
+Object.defineProperty(exports, "createInterpreter", { enumerable: true, get: function () { return interpreter_2.createInterpreter; } });
+function getLatestDataTimestamps(data_table_timestamps) {
+    const timestamps = {};
+    const date_values = data_table_timestamps.map(t => t.last_updated?.getTime()).filter(Boolean);
+    if (date_values.length) {
+        const latest_date = Math.max(...date_values);
+        timestamps.last_updated = new Date(latest_date);
+    }
+    return timestamps;
+}
+function extractData(data_binding, data_by_id, column_types_by_id, template_data_bindings, timestamps) {
     var columns = [];
     var data_table_ids = [];
     var num_rows = 0;
-    var dataset = [];
+    var dataset = Object.assign([], { column_names: {}, metadata: {}, timestamps: {} });
     var interpreters_by_id = {};
-    dataset.column_names = {};
-    dataset.metadata = {};
     function getInterpretationIds(data_table_id, column_index) {
         if (!interpreters_by_id[data_table_id])
             return {};
@@ -20,9 +41,10 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
         return by_column_index[column_index];
     }
     function getInterpreter(data_table_id, column_index) {
-        const { type_id } = getInterpretationIds(data_table_id, column_index);
-        if (type_id)
-            return interpreter_1.createInterpreter.getInterpretation(type_id);
+        const interpretation_ids = getInterpretationIds(data_table_id, column_index);
+        if ("type_id" in interpretation_ids) {
+            return interpreter_1.createInterpreter.getInterpretation(interpretation_ids.type_id);
+        }
     }
     for (var data_table_id in column_types_by_id) {
         var lookup = {};
@@ -43,7 +65,7 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
         if (data_binding[key].columns === undefined && data_binding[key].column === undefined)
             continue;
         var b = data_binding[key];
-        b.template_data_binding = template_data_binding[key];
+        b.template_data_binding = template_data_bindings[key];
         b.key = key;
         if (!(b.data_table_id in data_by_id)) {
             var data_by_id_keys = [];
@@ -52,7 +74,10 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
             console.error("Data table id " + b.data_table_id + " not in " + JSON.stringify(data_by_id_keys));
             continue;
         }
-        var data_table = data_by_id[b.data_table_id];
+        const data_table = data_by_id[b.data_table_id];
+        if (data_table == null) {
+            throw new Error(`[BUG] The data from the data table with ID ${b.data_table_id} was missing`);
+        }
         if (data_table.length == 0) {
             console.warn("Empty data table");
             continue;
@@ -64,8 +89,9 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
                 return data_table[0][i];
             });
             dataset.metadata[key] = b.columns.map(function (i) {
-                const { type_id, output_format_id } = getInterpretationIds(b.data_table_id, i);
-                if (type_id) {
+                const interpretation_ids = getInterpretationIds(b.data_table_id, i);
+                if ("type_id" in interpretation_ids) {
+                    const { type_id, output_format_id } = interpretation_ids;
                     return {
                         type: type_id.split("$")[0],
                         type_id,
@@ -77,8 +103,9 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
         }
         else if ("column" in b && b.column != null) {
             dataset.column_names[key] = data_table[0][b.column];
-            const { type_id, output_format_id } = getInterpretationIds(b.data_table_id, b.column);
-            if (type_id) {
+            const interpretation_ids = getInterpretationIds(b.data_table_id, b.column);
+            if ("type_id" in interpretation_ids) {
+                const { type_id, output_format_id } = interpretation_ids;
                 dataset.metadata[key] = {
                     type: type_id.split("$")[0],
                     type_id,
@@ -95,8 +122,11 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
         }
         columns.push(b);
     }
+    // gets the latest timestamp info across all data tables which are linked to by the bindings for this dataset
+    // (this is typically only a single data table)\
+    dataset.timestamps = getLatestDataTimestamps(data_table_ids.map(id => timestamps.per_data_table[id]));
     function parse(b, column_index, string_value) {
-        if (!b.template_data_binding.data_type)
+        if (!b.template_data_binding?.data_type)
             return string_value;
         var interpreter = getInterpreter(b.data_table_id, column_index);
         if (interpreter && interpreter.type == "number")
@@ -112,9 +142,14 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
         var o = {};
         for (var j = 0; j < columns.length; j++) {
             b = columns[j];
-            var table = data_by_id[b.data_table_id];
+            const table = data_by_id[b.data_table_id];
+            if (table == null) {
+                throw new Error(`[BUG] The data from the data table with ID ${b.data_table_id} was missing`);
+            }
             if (i + 1 >= table.length)
                 continue;
+            if (b.key == null)
+                throw new Error(`BUG: 'key' was ${b.key} in ${b}`);
             if ("columns" in b && b.columns != null) {
                 o[b.key] = b.columns
                     .filter(function (c) { return c < table[i + 1].length; })
@@ -131,7 +166,6 @@ function extractData(data_binding, data_by_id, column_types_by_id, template_data
     }
     return dataset;
 }
-exports.extractData = extractData;
 function getColumnTypesForData(data) {
     return transposeNestedArray(data)
         .map(function (column, i) {
@@ -146,7 +180,6 @@ function getColumnTypesForData(data) {
         return { type_id: type_id, index: i, output_format_id: type_id };
     });
 }
-exports.getColumnTypesForData = getColumnTypesForData;
 // Returns a random seeded sample of column values based on the column length.
 // The sample is consistent and will update if the length of column changes.
 function getRandomSeededSample(column, sample_size) {
@@ -159,7 +192,6 @@ function getRandomSeededSample(column, sample_size) {
     }
     return column;
 }
-exports.getRandomSeededSample = getRandomSeededSample;
 // Seeded RNG implementation taken from https://github.com/bryc/code/blob/master/jshash/PRNGs.md#mulberry32
 function mulberry32(seed) {
     let a = seed;
@@ -171,7 +203,6 @@ function mulberry32(seed) {
         return ((t ^ t >>> 14) >>> 0) / 4294967296;
     };
 }
-exports.mulberry32 = mulberry32;
 function trimTrailingEmptyRows(data) {
     for (var i = data.length; i-- > 1;) {
         if (!data[i] || !data[i].length || (Array.isArray(data[i]) && data[i].findIndex(function (col) { return col !== null && col !== ""; }) == -1)) {
@@ -182,7 +213,6 @@ function trimTrailingEmptyRows(data) {
     }
     return data;
 }
-exports.trimTrailingEmptyRows = trimTrailingEmptyRows;
 function dropReturnCharacters(data) {
     for (const row of data) {
         for (let i = 0; i < row.length; i++) {
@@ -195,7 +225,6 @@ function dropReturnCharacters(data) {
     }
     return data;
 }
-exports.dropReturnCharacters = dropReturnCharacters;
 /**
  * Takes an array of arrays (typically tabular data) and rewrites
  * it so that:
@@ -223,21 +252,24 @@ function tidyTable(data) {
             if (typeof value !== "string") {
                 value = "" + value;
             }
+            if (typeof value !== "string") {
+                throw new Error("BUG: somehow value was not a string");
+            }
             // Now value is a definitely a string, strip any leading
             // or trailing whitespace.
             row[i] = value.trim();
         }
     }
+    // TypeScript can't infer that the returned data is definitely all
+    // strings so use a cast.
     return data;
 }
-exports.tidyTable = tidyTable;
 var ERROR_STRINGS = ["#DIV/0", "#N/A", "#NAME?", "#NULL!", "#NUM!", "#REF!", "#VALUE!", "#ERROR!"];
 var interpreter = (0, interpreter_1.createInterpreter)().nMax(Infinity).nFailingValues(8).failureFraction(0.1);
 function stripCommonFixes(str) {
     str = str || "";
     return str.replace(/[€£$￥%º]/g, "");
 }
-exports.stripCommonFixes = stripCommonFixes;
 function transposeNestedArray(nested_array) {
     var n_inner = nested_array.length;
     var n_outer = n_inner > 0 ? nested_array[0].length : 0;
@@ -251,7 +283,6 @@ function transposeNestedArray(nested_array) {
     }
     return transposed_array;
 }
-exports.transposeNestedArray = transposeNestedArray;
 function getSlicedData(arr) {
     const n = arr.length;
     if (n > 100)
@@ -268,7 +299,6 @@ function getSlicedData(arr) {
         return arr.slice(1, n);
     return arr.slice(0, 1);
 }
-exports.getSlicedData = getSlicedData;
 function interpretColumn(arr) {
     var idata = arr.filter(function (d) {
         return d && !ERROR_STRINGS.includes(d.trim());
@@ -276,4 +306,31 @@ function interpretColumn(arr) {
         .map(stripCommonFixes);
     return interpreter(idata);
 }
-exports.interpretColumn = interpretColumn;
+function sortDataTables(data_tables, data_bindings) {
+    // Sort data tables to match order in the template data bindings
+    if (!data_bindings || !data_bindings.length)
+        return;
+    if (!data_tables || !data_tables.length)
+        return;
+    var table_names = [];
+    data_bindings.forEach(function (data_binding) {
+        if (typeof data_binding === "string")
+            return;
+        let column;
+        if ("column" in data_binding) {
+            column = data_binding.column;
+        }
+        else if ("columns" in data_binding) {
+            column = data_binding.columns;
+        }
+        if (column) {
+            var table_name = column.match(/^(?:[^:]|:[^:])*/);
+            if (table_name && table_names.indexOf(table_name[0]) == -1)
+                table_names.push(table_name[0]);
+        }
+    });
+    return data_tables.sort(function (dt1, dt2) {
+        var i = table_names.indexOf(dt1.name), j = table_names.indexOf(dt2.name);
+        return (i == -1 ? Infinity : i) < (j == -1 ? Infinity : j) ? -1 : 1;
+    });
+}

package/common/utils/json.d.ts

@@ -1,3 +1,6 @@
-export function safeStringify(obj: any): string | undefined;
-export function javaScriptStringify(v: any): any;
-export function stringifyPreparedData(data: any): string;
+import { DatasetType } from "./types";
+export declare function safeStringify(obj: unknown): string | undefined;
+export declare function javaScriptStringify(v: unknown): string | undefined;
+export declare function stringifyPreparedData(data: {
+    [dataset: string]: DatasetType;
+}): string;

package/common/utils/json.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringifyPreparedData = exports.javaScriptStringify = exports.safeStringify = void 0;
+exports.safeStringify = safeStringify;
+exports.javaScriptStringify = javaScriptStringify;
+exports.stringifyPreparedData = stringifyPreparedData;
 function escapeChar(c) {
     var hex = c.charCodeAt(0).toString(16);
     while (hex.length < 4)
@@ -15,7 +17,6 @@ function safeStringify(obj) {
         return undefined;
     return raw.replace(/[\u2028\u2029<]/g, escapeChar);
 }
-exports.safeStringify = safeStringify;
 function javaScriptStringify(v) {
     var type = typeof v;
     if (v == null) {
@@ -40,9 +41,8 @@ function javaScriptStringify(v) {
         throw new Error("javaScriptStringify couldn't handle " + type + " object: " + v);
     }
 }
-exports.javaScriptStringify = javaScriptStringify;
 function stringifyDataset(dataset) {
-    return "(function(array, column_names, metadata){ array.column_names = column_names; array.metadata = metadata; return array; })(" + javaScriptStringify(dataset) + ", " + safeStringify(dataset.column_names) + ", " + safeStringify(dataset.metadata) + ")";
+    return "(function(array, column_names, metadata, timestamps){ array.column_names = column_names; array.metadata = metadata; array.timestamps = timestamps; return array; })(" + javaScriptStringify(dataset) + ", " + safeStringify(dataset.column_names) + ", " + safeStringify(dataset.metadata) + ", " + javaScriptStringify(dataset.timestamps) + ")";
 }
 function stringifyPreparedData(data) {
     var s = "{";
@@ -57,4 +57,3 @@ function stringifyPreparedData(data) {
     s += "}";
     return s;
 }
-exports.stringifyPreparedData = stringifyPreparedData;

package/common/utils/state.js

@@ -1,11 +1,16 @@
 "use strict";
 /* This file is used by the story player, and must be IE-compatible */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStateChanges = exports.deepEqual = exports.deepCopyObject = exports.merge = exports.unflatten = exports.flatten = exports.isObject = void 0;
+exports.isObject = isObject;
+exports.flatten = flatten;
+exports.unflatten = unflatten;
+exports.merge = merge;
+exports.deepCopyObject = deepCopyObject;
+exports.deepEqual = deepEqual;
+exports.getStateChanges = getStateChanges;
 function isObject(x) {
     return !Array.isArray(x) && typeof x === "object" && x != null;
 }
-exports.isObject = isObject;
 /* Example: { a: { b: { c: 2, d: 3 } } } ↦
    {
     "a": { b: { c: 2, d: 3 }  },
@@ -29,7 +34,6 @@ function flatten(o, keys, result) {
     }
     return result;
 }
-exports.flatten = flatten;
 // { "a.b.c": 2, "a.b.d":3 } → { a: { b: { c: 2, d: 3 } } }
 function unflatten(o) {
     var r = {};
@@ -45,7 +49,6 @@ function unflatten(o) {
     }
     return r;
 }
-exports.unflatten = unflatten;
 function merge(dest, source) {
     for (var prop in source) {
         if (isObject(dest[prop]) && isObject(source[prop])) {
@@ -57,7 +60,6 @@ function merge(dest, source) {
     }
     return dest;
 }
-exports.merge = merge;
 function deepCopyObject(obj) {
     if (obj == null)
         return obj;
@@ -75,7 +77,6 @@ function deepCopyObject(obj) {
     }
     return copy;
 }
-exports.deepCopyObject = deepCopyObject;
 // Simple deep equality test for JSON-definable objects
 // The idea is that two objects test equal if they would
 // JSON.stringify to the same thing, modulo key ordering.
@@ -126,7 +127,6 @@ function deepEqual(a, b) {
             return typeof b === "undefined";
     }
 }
-exports.deepEqual = deepEqual;
 function getStateChanges(state1, state2) {
     var diff = {};
     for (var name in state2) {
@@ -141,4 +141,3 @@ function getStateChanges(state1, state2) {
     }
     return diff;
 }
-exports.getStateChanges = getStateChanges;

package/common/utils/types.d.ts

@@ -0,0 +1,63 @@
+type ColumnTypeInMetadata = {
+    type: string;
+    type_id: string;
+    output_format_id: string;
+};
+export type DatasetType = Record<string, unknown>[] & {
+    column_names: {
+        [data_binding_key: string]: string | string[];
+    };
+    metadata: {
+        [data_binding_key: string]: ColumnTypeInMetadata | (ColumnTypeInMetadata | null)[];
+    };
+    timestamps: {
+        last_updated?: Date;
+    };
+};
+export type DataBinding = {
+    data_table_id: number;
+} & ({
+    column: number;
+    columns?: null;
+} | {
+    column?: null;
+    columns: number[];
+});
+export type DataBindings = Record<string, DataBinding>;
+export type TemplateDataBinding = {
+    dataset: string;
+    key: string;
+    name?: string;
+    type?: string;
+    description?: string;
+    data_type?: string[];
+    assignment?: {
+        can_rebind?: boolean;
+        min_columns?: number;
+        max_columns?: number;
+        hints: Record<string, unknown>;
+    };
+    optional?: boolean;
+} & ({
+    column: string;
+} | {
+    columns: string;
+});
+export type KeyToTemplateDataBinding = {
+    [key: string]: TemplateDataBinding;
+};
+export type DatasetToKeyToTemplateDataBinding = {
+    [dataset: string]: KeyToTemplateDataBinding;
+};
+export type ColumnType = {
+    index: number;
+    type_id: string;
+    output_format_id: string;
+};
+export type ColumnTypesById = {
+    [data_table_id: string]: ColumnType[];
+};
+export type NullableColumnTypesById = {
+    [data_table_id: string]: ColumnType[] | null;
+};
+export {};

package/common/utils/types.js

@@ -0,0 +1,3 @@
+"use strict";
+// Data binding types:
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cmd/logout.js

@@ -3,15 +3,27 @@
 var log = require("../log"),
     sdk = require("../sdk");
 
-exports.command = function logout() {
-	sdk.deleteSdkTokens()
-		.then(() => log.victory("Deleted all SDK tokens"))
-		.catch((error) => log.die(error));
+exports.command = async function logout(server_opts) {
+	try {
+		await sdk.request(server_opts, "user/logout", {}, { exit_on_failure: false });
+	}
+	catch (e) {
+		log.warn("Failed to revoke SDK Token. Your token may not correspond to a valid active user session.");
+	}
+
+	// Delete token from local file
+	try {
+		await sdk.deleteSdkToken(server_opts.host);
+		log.victory("Deleted SDK token.");
+	}
+	catch (e) {
+		log.die(e);
+	}
 };
 
 exports.help = `
 flourish logout
 
-Deletes the .flourish_sdk file from your HOME or USERPROFILE directory. You
+Revokes the active user token and deletes it from the .flourish_sdk file from your HOME or USERPROFILE directory. You
 will not be able to communicate with the server until you “flourish login”
 `;

package/lib/sdk.js

@@ -61,6 +61,36 @@ function setSdkToken(server_opts, sdk_token) {
 	});
 }
 
+function deleteSdkToken(host) {
+	return new Promise(function(resolve) {
+		if (host == null) {
+			log.die("No host specified");
+		}
+		fs.readFile(sdk_tokens_file, function(error, body) {
+			if (error) log.die(`Failed to read ${sdk_tokens_file}`, error.message);
+
+			let sdk_tokens;
+			try {
+				sdk_tokens = JSON.parse(body);
+			}
+			catch (error) {
+				log.die(`Failed to parse ${sdk_tokens_file}`, "Remove it and try again");
+			}
+
+			delete sdk_tokens[host];
+			fs.writeFile(sdk_tokens_file, JSON.stringify(sdk_tokens), { mode: 0o600 }, function(error) {
+				if (error) log.die(`Failed to save ${sdk_tokens_file}`, error.message);
+				resolve();
+			});
+		});
+	});
+}
+
+/**
+ * Deletes all SDK tokens
+ * this will delete the .flourish_sdk file from the user's home directory
+ * which clears all tokens across all configured hosts
+ */
 function deleteSdkTokens() {
 	return new Promise(function(resolve, reject) {
 		fs.unlink(sdk_tokens_file, function(error) {
@@ -72,10 +102,10 @@ function deleteSdkTokens() {
 
 const AUTHENTICATED_REQUEST_METHODS = new Set([
 	"template/assign-version-number", "template/publish", "template/delete", "template/list", "template/history",
-	"user/whoami"
+	"user/whoami", "user/logout"
 ]);
 
-async function request(server_opts, method, data) {
+async function request(server_opts, method, data, config = { exit_on_failure: true }) {
 	const fetch = await import("node-fetch");
 	let sdk_token;
 
@@ -119,7 +149,12 @@ async function request(server_opts, method, data) {
 		res = await fetch.default(url, options);
 	}
 	catch (e) {
-		log.die(e);
+		if (config.exit_on_failure) {
+			log.die(e);
+		}
+		else {
+			throw e;
+		}
 	}
 
 	let text;
@@ -130,7 +165,12 @@ async function request(server_opts, method, data) {
 		text = await res.text();
 	}
 	catch (error) {
-		log.die("Failed to get response from server", error);
+		if (config.exit_on_failure) {
+			log.die("Failed to get response from server", error);
+		}
+		else {
+			throw error;
+		}
 	}
 
 	let body;
@@ -139,7 +179,10 @@ async function request(server_opts, method, data) {
 		body = JSON.parse(text);
 	}
 	catch (error) {
-		log.die("Failed to parse response body", res.status, error, text);
+		if (config.exit_on_failure) {
+			log.die("Failed to parse response body", res.status, error, text);
+		}
+		else throw error;
 	}
 
 	if (res.ok) {
@@ -147,7 +190,12 @@ async function request(server_opts, method, data) {
 	}
 
 	if (body.error) {
-		log.die("Error from server", res.status, body.error.message);
+		if (config.exit_on_failure) {
+			log.die("Error from server", res.status, body.error.message);
+		}
+		else {
+			throw body.error;
+		}
 	}
 
 	log.die("Server error", res.status, JSON.stringify(body));
@@ -588,7 +636,7 @@ const TEMPLATE_SPECIAL = new Set([
 module.exports = {
 	checkTemplateVersion,
 
-	getSdkToken, setSdkToken, deleteSdkTokens,
+	getSdkToken, setSdkToken, deleteSdkTokens, deleteSdkToken,
 	request,
 	runBuildCommand, buildTemplate,
 	readConfig, readAndValidateConfig, writeConfig, buildRules,