@flourish/sdk 4.2.0 → 4.2.1

package/common/utils/data.js

@@ -1,279 +0,0 @@
-"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;
-const interpreter_1 = require("@flourish/interpreter");
-require("./polyfills");
-function extractData(data_binding, data_by_id, column_types_by_id, template_data_binding) {
-    var columns = [];
-    var data_table_ids = [];
-    var num_rows = 0;
-    var dataset = [];
-    var interpreters_by_id = {};
-    dataset.column_names = {};
-    dataset.metadata = {};
-    function getInterpretationIds(data_table_id, column_index) {
-        if (!interpreters_by_id[data_table_id])
-            return {};
-        var by_column_index = interpreters_by_id[data_table_id];
-        if (!by_column_index[column_index])
-            return {};
-        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);
-    }
-    for (var data_table_id in column_types_by_id) {
-        var lookup = {};
-        var column_types = column_types_by_id[data_table_id];
-        if (!column_types)
-            continue;
-        for (let i = 0; i < column_types.length; i++) {
-            const type_id = column_types[i].type_id;
-            const of_id = column_types[i].output_format_id;
-            const output_format_id = (!of_id || of_id === "auto") ? type_id : of_id;
-            lookup[column_types[i].index] = { type_id, output_format_id };
-        }
-        interpreters_by_id[data_table_id] = lookup;
-    }
-    for (var key in data_binding) {
-        if (data_binding[key] === null)
-            continue;
-        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.key = key;
-        if (!(b.data_table_id in data_by_id)) {
-            var data_by_id_keys = [];
-            for (var k in data_by_id)
-                data_by_id_keys.push(k);
-            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];
-        if (data_table.length == 0) {
-            console.warn("Empty data table");
-            continue;
-        }
-        if ("columns" in b && b.columns != null) {
-            var column_count = data_table[0].length;
-            b.columns = b.columns.filter(function (i) { return i < column_count; });
-            dataset.column_names[key] = b.columns.map(function (i) {
-                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) {
-                    return {
-                        type: type_id.split("$")[0],
-                        type_id,
-                        output_format_id: output_format_id
-                    };
-                }
-                return null;
-            });
-        }
-        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) {
-                dataset.metadata[key] = {
-                    type: type_id.split("$")[0],
-                    type_id,
-                    output_format_id: output_format_id
-                };
-            }
-        }
-        else {
-            throw new Error("Data binding includes no column(s) specification: " + JSON.stringify(b));
-        }
-        if (data_table_ids.indexOf(b.data_table_id) == -1) {
-            data_table_ids.push(b.data_table_id);
-            num_rows = Math.max(num_rows, data_table.length - 1);
-        }
-        columns.push(b);
-    }
-    function parse(b, column_index, string_value) {
-        if (!b.template_data_binding.data_type)
-            return string_value;
-        var interpreter = getInterpreter(b.data_table_id, column_index);
-        if (interpreter && interpreter.type == "number")
-            string_value = stripCommonFixes(string_value);
-        var result = interpreter ? interpreter.parse(string_value) : string_value;
-        // We require our marshalled data to be JSON-serialisable,
-        // therefore we convert NaNs to null here.
-        if (Number.isNaN(result))
-            result = null;
-        return result;
-    }
-    for (var i = 0; i < num_rows; i++) {
-        var o = {};
-        for (var j = 0; j < columns.length; j++) {
-            b = columns[j];
-            var table = data_by_id[b.data_table_id];
-            if (i + 1 >= table.length)
-                continue;
-            if ("columns" in b && b.columns != null) {
-                o[b.key] = b.columns
-                    .filter(function (c) { return c < table[i + 1].length; })
-                    .map(function (c) { return parse(b, c, table[i + 1][c]); });
-            }
-            else if ("column" in b && b.column != null) {
-                if (b.column >= table[i + 1].length)
-                    o[b.key] = parse(b, b.column, "");
-                else
-                    o[b.key] = parse(b, b.column, table[i + 1][b.column]);
-            }
-        }
-        dataset.push(o);
-    }
-    return dataset;
-}
-exports.extractData = extractData;
-function getColumnTypesForData(data) {
-    return transposeNestedArray(data)
-        .map(function (column, i) {
-        const sliced_column = getSlicedData(column);
-        const sample_size = 1000;
-        let sample_data;
-        if (sliced_column.length > (sample_size * 2))
-            sample_data = getRandomSeededSample(sliced_column, sample_size);
-        else
-            sample_data = sliced_column;
-        const type_id = interpretColumn(sample_data)[0].id;
-        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) {
-    if (column.length <= sample_size * 2)
-        return column;
-    const rng = mulberry32(column.length);
-    while (column.length > sample_size) {
-        const random_index = Math.floor(rng() * column.length);
-        column.splice(random_index, 1);
-    }
-    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;
-    return function () {
-        a |= 0;
-        a = a + 0x6D2B79F5 | 0;
-        var t = Math.imul(a ^ a >>> 15, 1 | a);
-        t = t + Math.imul(t ^ t >>> 7, 61 | t) ^ t;
-        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)) {
-            data.splice(i, 1);
-        }
-        else
-            break;
-    }
-    return data;
-}
-exports.trimTrailingEmptyRows = trimTrailingEmptyRows;
-function dropReturnCharacters(data) {
-    for (const row of data) {
-        for (let i = 0; i < row.length; i++) {
-            // Due to a bug in HoT, pasting long lines from Excel can lead to the addition of
-            // a newline character and a space *before* a space character.
-            // This leads to a pattern of new line character followed by two spaces.
-            // Here we identify that pattern and revert it.
-            row[i] = row[i].replace(/(\r\n|\n|\r) {2}/g, " ");
-        }
-    }
-    return data;
-}
-exports.dropReturnCharacters = dropReturnCharacters;
-/**
- * Takes an array of arrays (typically tabular data) and rewrites
- * it so that:
- *   - Any trailing empty rows are removed
- *   - Any cell that was not a string is stringified
- *   - Any leading or trailing whitespace of a cell is removed
- *
- * (The potentially modified table is returned to match the convention
- * used by functions this is replacing, although (TODO) I think it
- * would be more obvious that this function has side-effects if it
- * did not return the table and the calling code was changed.)
- *
- * @param {any[][]} data
- * @returns {string[][]}
- */
-function tidyTable(data) {
-    trimTrailingEmptyRows(data);
-    for (let row of data) {
-        for (let i = 0; i < row.length; i++) {
-            let value = row[i];
-            // Convert null or undefined values to the empty string
-            if (value == null)
-                value = "";
-            // If the value is not a string, convert it to one
-            if (typeof value !== "string") {
-                value = "" + value;
-            }
-            // Now value is a definitely a string, strip any leading
-            // or trailing whitespace.
-            row[i] = value.trim();
-        }
-    }
-    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;
-    var transposed_array = [];
-    for (var i = 0; i < n_outer; i++) {
-        var data = [];
-        for (var j = 0; j < n_inner; j++) {
-            data.push(nested_array[j][i]);
-        }
-        transposed_array.push(data);
-    }
-    return transposed_array;
-}
-exports.transposeNestedArray = transposeNestedArray;
-function getSlicedData(arr) {
-    const n = arr.length;
-    if (n > 100)
-        return arr.slice(10, n - 10);
-    if (n > 50)
-        return arr.slice(5, n - 5);
-    if (n > 30)
-        return arr.slice(4, n - 4);
-    if (n > 20)
-        return arr.slice(3, n - 3);
-    if (n > 10)
-        return arr.slice(2, n - 2);
-    if (n > 1)
-        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());
-    })
-        .map(stripCommonFixes);
-    return interpreter(idata);
-}
-exports.interpretColumn = interpretColumn;

package/common/utils/json.d.ts

@@ -1,3 +0,0 @@
-export function safeStringify(obj: any): string | undefined;
-export function javaScriptStringify(v: any): any;
-export function stringifyPreparedData(data: any): string;

package/common/utils/json.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringifyPreparedData = exports.javaScriptStringify = exports.safeStringify = void 0;
-function escapeChar(c) {
-    var hex = c.charCodeAt(0).toString(16);
-    while (hex.length < 4)
-        hex = "0" + hex;
-    return "\\u" + hex;
-}
-// Stringify an object (etc.) in a form that can safely be inserted
-// into a <script> block in a web page.
-function safeStringify(obj) {
-    const raw = JSON.stringify(obj);
-    if (typeof raw === "undefined")
-        return undefined;
-    return raw.replace(/[\u2028\u2029<]/g, escapeChar);
-}
-exports.safeStringify = safeStringify;
-function javaScriptStringify(v) {
-    var type = typeof v;
-    if (v == null) {
-        // Catches both null and undefined
-        return "null";
-    }
-    else if (type === "number" || type === "boolean" || type === "bigint" || type === "string" || type === "symbol") {
-        return safeStringify(v);
-    }
-    if (Array.isArray(v)) {
-        return "[" + v.map(javaScriptStringify).join(",") + "]";
-    }
-    else if (v instanceof Date) {
-        return "new Date(" + v.getTime() + ")";
-    }
-    else if (Object.prototype.toString.call(v) === "[object Object]") {
-        return "{" + Object.keys(v).map(function (k) {
-            return safeStringify(k) + ":" + javaScriptStringify(v[k]);
-        }) + "}";
-    }
-    else {
-        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) + ")";
-}
-function stringifyPreparedData(data) {
-    var s = "{";
-    var first = true;
-    for (var dataset in data) {
-        if (first)
-            first = false;
-        else
-            s += ", ";
-        s += safeStringify(dataset) + ": " + stringifyDataset(data[dataset]);
-    }
-    s += "}";
-    return s;
-}
-exports.stringifyPreparedData = stringifyPreparedData;

package/common/utils/polyfills.js

@@ -1,30 +0,0 @@
-"use strict";
-// Polyfills for IE11 and Edge
-// Add findIndex method to Array
-// https://tc39.github.io/ecma262/#sec-array.prototype.findindex
-if (!Array.prototype.findIndex) {
-    Object.defineProperty(Array.prototype, "findIndex", {
-        value: function (predicate) {
-            if (this == null) {
-                throw new TypeError("this is null or not defined");
-            }
-            var o = Object(this);
-            var len = o.length >>> 0;
-            if (typeof predicate !== "function") {
-                throw new TypeError("predicate must be a function");
-            }
-            var this_arg = arguments[1];
-            var k = 0;
-            while (k < len) {
-                var k_value = o[k];
-                if (predicate.call(this_arg, k_value, k, o)) {
-                    return k;
-                }
-                k++;
-            }
-            return -1;
-        },
-        configurable: true,
-        writable: true
-    });
-}

package/common/utils/state.d.ts

@@ -1,7 +0,0 @@
-export function isObject(x: any): boolean;
-export function flatten(o: any, keys: any, result: any): any;
-export function unflatten(o: any): {};
-export function merge(dest: any, source: any): any;
-export function deepCopyObject(obj: any): any;
-export function deepEqual(a: any, b: any): boolean | undefined;
-export function getStateChanges(state1: any, state2: any): {};

package/common/utils/state.js

@@ -1,144 +0,0 @@
-"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;
-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 }  },
-    "a.b": { c: 2, d: 3 },
-    "a.b.c": 2,
-    "a.b.d": 3
-  }
- */
-function flatten(o, keys, result) {
-    if (!keys)
-        keys = [];
-    if (!result)
-        result = {};
-    for (var k in o) {
-        keys.push(k);
-        if (typeof o[k] === "object") {
-            flatten(o[k], keys, result);
-        }
-        result[keys.join(".")] = o[k];
-        keys.pop();
-    }
-    return result;
-}
-exports.flatten = flatten;
-// { "a.b.c": 2, "a.b.d":3 } → { a: { b: { c: 2, d: 3 } } }
-function unflatten(o) {
-    var r = {};
-    for (var k in o) {
-        var t = r;
-        for (var i = k.indexOf("."), p = 0; i >= 0; i = k.indexOf(".", p = i + 1)) {
-            var s = k.substring(p, i);
-            if (!(s in t))
-                t[s] = {};
-            t = t[s];
-        }
-        t[k.substring(p)] = o[k]; // Assign the actual value to the appropriate nested object
-    }
-    return r;
-}
-exports.unflatten = unflatten;
-function merge(dest, source) {
-    for (var prop in source) {
-        if (isObject(dest[prop]) && isObject(source[prop])) {
-            merge(dest[prop], source[prop]);
-        }
-        else {
-            dest[prop] = source[prop];
-        }
-    }
-    return dest;
-}
-exports.merge = merge;
-function deepCopyObject(obj) {
-    if (obj == null)
-        return obj;
-    var copy = {};
-    for (var k in obj) {
-        if (Array.isArray(obj[k])) {
-            copy[k] = obj[k].slice();
-        }
-        else if (isObject(obj[k])) {
-            copy[k] = deepCopyObject(obj[k]);
-        }
-        else {
-            copy[k] = obj[k];
-        }
-    }
-    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.
-//
-// An edge case implied by the above:
-//   { a: 1, b: undefined } counts as equal to { a: 1 }
-//
-// This is used to compare the slide state to the preview
-// state, to see if the state has been changed by user interaction.
-function deepEqual(a, b) {
-    if (typeof a !== typeof b)
-        return false;
-    switch (typeof a) {
-        case "string":
-        case "boolean":
-            return a === b;
-        case "number":
-            if (isNaN(a) && isNaN(b))
-                return true;
-            return a === b;
-        case "object":
-            if (a === null)
-                return (b === null);
-            if (Array.isArray(a)) {
-                if (!Array.isArray(b))
-                    return false;
-                if (a.length != b.length)
-                    return false;
-                for (var i = 0; i < a.length; i++) {
-                    if (!deepEqual(a[i], b[i]))
-                        return false;
-                }
-                return true;
-            }
-            if (b === null)
-                return false;
-            var k;
-            for (k in a) {
-                if (!deepEqual(a[k], b[k]))
-                    return false;
-            }
-            for (k in b) {
-                if (!(k in a) && typeof b[k] !== "undefined")
-                    return false;
-            }
-            return true;
-        case "undefined":
-            return typeof b === "undefined";
-    }
-}
-exports.deepEqual = deepEqual;
-function getStateChanges(state1, state2) {
-    var diff = {};
-    for (var name in state2) {
-        if (!state1.hasOwnProperty(name) || !deepEqual(state1[name], state2[name])) {
-            if (isObject(state1[name]) && isObject(state2[name])) {
-                diff[name] = getStateChanges(state1[name], state2[name]);
-            }
-            else {
-                diff[name] = state2[name];
-            }
-        }
-    }
-    return diff;
-}
-exports.getStateChanges = getStateChanges;