@jbrowse/core 1.7.11 → 2.1.0

package/configuration/configurationSlot.js

@@ -1,352 +1,274 @@
 "use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = ConfigSlot;
-
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-
-var _mobxStateTree = require("mobx-state-tree");
-
-var _jexlStrings = require("../util/jexlStrings");
-
-var _mst = require("../util/types/mst");
-
+Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable @typescript-eslint/no-explicit-any */
-function
-  /* str */
-isValidColorString() {
-  // TODO: check all the crazy cases for whether it's a valid HTML/CSS color string
-  return true;
+const mobx_state_tree_1 = require("mobx-state-tree");
+const jexlStrings_1 = require("../util/jexlStrings");
+const mst_1 = require("../util/types/mst");
+function isValidColorString( /* str */) {
+    // TODO: check all the crazy cases for whether it's a valid HTML/CSS color string
+    return true;
 }
-
-var typeModels = {
-  stringArray: _mobxStateTree.types.array(_mobxStateTree.types.string),
-  stringArrayMap: _mobxStateTree.types.map(_mobxStateTree.types.array(_mobxStateTree.types.string)),
-  numberMap: _mobxStateTree.types.map(_mobxStateTree.types.number),
-  boolean: _mobxStateTree.types.boolean,
-  color: _mobxStateTree.types.refinement('Color', _mobxStateTree.types.string, isValidColorString),
-  integer: _mobxStateTree.types.integer,
-  number: _mobxStateTree.types.number,
-  string: _mobxStateTree.types.string,
-  text: _mobxStateTree.types.string,
-  fileLocation: _mst.FileLocation,
-  frozen: _mobxStateTree.types.frozen()
-}; // default values we use if the defaultValue is malformed or does not work
-
-var fallbackDefaults = {
-  stringArray: [],
-  stringArrayMap: {},
-  numberMap: {},
-  boolean: true,
-  color: 'black',
-  integer: 1,
-  number: 1,
-  string: '',
-  text: '',
-  fileLocation: {
-    uri: '/path/to/resource.txt',
-    locationType: 'UriLocation'
-  },
-  frozen: {}
+const typeModels = {
+    stringArray: mobx_state_tree_1.types.array(mobx_state_tree_1.types.string),
+    stringArrayMap: mobx_state_tree_1.types.map(mobx_state_tree_1.types.array(mobx_state_tree_1.types.string)),
+    numberMap: mobx_state_tree_1.types.map(mobx_state_tree_1.types.number),
+    boolean: mobx_state_tree_1.types.boolean,
+    color: mobx_state_tree_1.types.refinement('Color', mobx_state_tree_1.types.string, isValidColorString),
+    integer: mobx_state_tree_1.types.integer,
+    number: mobx_state_tree_1.types.number,
+    string: mobx_state_tree_1.types.string,
+    text: mobx_state_tree_1.types.string,
+    fileLocation: mst_1.FileLocation,
+    frozen: mobx_state_tree_1.types.frozen(),
 };
-
-var literalJSON = function literalJSON(self) {
-  return {
-    views: {
-      get valueJSON() {
-        return self.value;
-      }
-
-    }
-  };
+// default values we use if the defaultValue is malformed or does not work
+const fallbackDefaults = {
+    stringArray: [],
+    stringArrayMap: {},
+    numberMap: {},
+    boolean: true,
+    color: 'black',
+    integer: 1,
+    number: 1,
+    string: '',
+    text: '',
+    fileLocation: { uri: '/path/to/resource.txt', locationType: 'UriLocation' },
+    frozen: {},
 };
-
-var objectJSON = function objectJSON(self) {
-  return {
+const literalJSON = (self) => ({
     views: {
-      get valueJSON() {
-        return JSON.stringify(self.value);
-      }
-
-    }
-  };
-}; // custom actions for modifying the value models
-
-
-var typeModelExtensions = {
-  fileLocation: objectJSON,
-  number: literalJSON,
-  integer: literalJSON,
-  boolean: literalJSON,
-  frozen: objectJSON,
-  // special actions for working with stringArray slots
-  stringArray: function stringArray(self) {
-    return {
-      views: {
         get valueJSON() {
-          return JSON.stringify(self.value);
-        }
-
-      },
-      actions: {
-        add: function add(val) {
-          self.value.push(val);
-        },
-        removeAtIndex: function removeAtIndex(idx) {
-          self.value.splice(idx, 1);
+            return self.value;
         },
-        setAtIndex: function setAtIndex(idx, val) {
-          self.value[idx] = val;
-        }
-      }
-    };
-  },
-  stringArrayMap: function stringArrayMap(self) {
-    return {
-      views: {
+    },
+});
+const objectJSON = (self) => ({
+    views: {
         get valueJSON() {
-          return JSON.stringify(self.value);
-        }
-
-      },
-      actions: {
-        add: function add(key, val) {
-          self.value.set(key, val);
+            return JSON.stringify(self.value);
         },
-        remove: function remove(key) {
-          self.value.delete(key);
+    },
+});
+// custom actions for modifying the value models
+const typeModelExtensions = {
+    fileLocation: objectJSON,
+    number: literalJSON,
+    integer: literalJSON,
+    boolean: literalJSON,
+    frozen: objectJSON,
+    // special actions for working with stringArray slots
+    stringArray: (self) => ({
+        views: {
+            get valueJSON() {
+                return JSON.stringify(self.value);
+            },
         },
-        addToKey: function addToKey(key, val) {
-          var ar = self.value.get(key);
-
-          if (!ar) {
-            throw new Error("".concat(key, " not found"));
-          }
-
-          ar.push(val);
+        actions: {
+            add(val) {
+                self.value.push(val);
+            },
+            removeAtIndex(idx) {
+                self.value.splice(idx, 1);
+            },
+            setAtIndex(idx, val) {
+                self.value[idx] = val;
+            },
         },
-        removeAtKeyIndex: function removeAtKeyIndex(key, idx) {
-          var ar = self.value.get(key);
-
-          if (!ar) {
-            throw new Error("".concat(key, " not found"));
-          }
-
-          ar.splice(idx, 1);
+    }),
+    stringArrayMap: (self) => ({
+        views: {
+            get valueJSON() {
+                return JSON.stringify(self.value);
+            },
         },
-        setAtKeyIndex: function setAtKeyIndex(key, idx, val) {
-          var ar = self.value.get(key);
-
-          if (!ar) {
-            throw new Error("".concat(key, " not found"));
-          }
-
-          ar[idx] = val;
-        }
-      }
-    };
-  },
-  numberMap: function numberMap(self) {
-    return {
-      views: {
-        get valueJSON() {
-          return JSON.stringify(self.value);
-        }
-
-      },
-      actions: {
-        add: function add(key, val) {
-          self.value.set(key, val);
+        actions: {
+            add(key, val) {
+                self.value.set(key, val);
+            },
+            remove(key) {
+                self.value.delete(key);
+            },
+            addToKey(key, val) {
+                const ar = self.value.get(key);
+                if (!ar) {
+                    throw new Error(`${key} not found`);
+                }
+                ar.push(val);
+            },
+            removeAtKeyIndex(key, idx) {
+                const ar = self.value.get(key);
+                if (!ar) {
+                    throw new Error(`${key} not found`);
+                }
+                ar.splice(idx, 1);
+            },
+            setAtKeyIndex(key, idx, val) {
+                const ar = self.value.get(key);
+                if (!ar) {
+                    throw new Error(`${key} not found`);
+                }
+                ar[idx] = val;
+            },
         },
-        remove: function remove(key) {
-          self.value.delete(key);
-        }
-      }
-    };
-  }
-}; // const FunctionStringType = types.refinement(
+    }),
+    numberMap: (self) => ({
+        views: {
+            get valueJSON() {
+                return JSON.stringify(self.value);
+            },
+        },
+        actions: {
+            add(key, val) {
+                self.value.set(key, val);
+            },
+            remove(key) {
+                self.value.delete(key);
+            },
+        },
+    }),
+};
+// const FunctionStringType = types.refinement(
 //   'FunctionString',
 //   types.string,
 //   str => functionRegexp.test(str),
 // )
-
-var JexlStringType = _mobxStateTree.types.refinement('JexlString', _mobxStateTree.types.string, function (str) {
-  return str.startsWith('jexl:');
-});
-
+const JexlStringType = mobx_state_tree_1.types.refinement('JexlString', mobx_state_tree_1.types.string, str => str.startsWith('jexl:'));
 /**
  * builds a MST model for a configuration slot
  *
  * @param slotName -
  * @param  definition -
  */
-function ConfigSlot(slotName, _ref) {
-  var _ref$description = _ref.description,
-      description = _ref$description === void 0 ? '' : _ref$description,
-      model = _ref.model,
-      type = _ref.type,
-      defaultValue = _ref.defaultValue,
-      _ref$contextVariable = _ref.contextVariable,
-      contextVariable = _ref$contextVariable === void 0 ? [] : _ref$contextVariable;
-
-  if (!type) {
-    throw new Error('type name required');
-  }
-
-  if (!model) {
-    model = typeModels[type];
-  }
-
-  if (!model) {
-    throw new Error("no builtin config slot type \"".concat(type, "\", and no 'model' param provided"));
-  }
-
-  if (defaultValue === undefined) {
-    throw new Error("no 'defaultValue' provided");
-  } // if the `type` is something like `color`, then the model name
-  // here will be `ColorConfigSlot`
-
-
-  var configSlotModelName = "".concat(slotName.charAt(0).toUpperCase()).concat(slotName.slice(1), "ConfigSlot");
-
-  var slot = _mobxStateTree.types.model(configSlotModelName, {
-    name: _mobxStateTree.types.literal(slotName),
-    description: _mobxStateTree.types.literal(description),
-    type: _mobxStateTree.types.literal(type),
-    value: _mobxStateTree.types.optional(_mobxStateTree.types.union(JexlStringType, model), defaultValue)
-  }).volatile(function () {
-    return {
-      contextVariable: contextVariable
-    };
-  }).views(function (self) {
-    return {
-      get isCallback() {
-        return String(self.value).startsWith('jexl:');
-      }
-
-    };
-  }).views(function (self) {
-    return {
-      get expr() {
-        if (self.isCallback) {
-          // compile as jexl function
-          var _getEnv = (0, _mobxStateTree.getEnv)(self),
-              pluginManager = _getEnv.pluginManager;
-
-          if (!pluginManager && typeof jest === 'undefined') {
-            console.warn('no pluginManager detected on config env (if you dynamically instantiate a config, for example in renderProps for your display model, check that you add the env argument)');
-          }
-
-          return (0, _jexlStrings.stringToJexlExpression)(String(self.value), pluginManager === null || pluginManager === void 0 ? void 0 : pluginManager.jexl);
-        }
-
-        return {
-          evalSync: function evalSync() {
-            return self.value;
-          }
-        };
-      },
-
-      // JS representation of the value of this slot, suitable
-      // for embedding in either JSON or a JS function string.
-      // many of the data types override this in typeModelExtensions
-      get valueJSON() {
-        if (self.isCallback) {
-          return undefined;
-        }
-
-        function json(value) {
-          if (value && value.toJSON) {
-            return value.toJSON();
-          }
-
-          return "\"".concat(value, "\"");
-        }
-
-        return json(self.value);
-      }
-
-    };
-  }).preProcessSnapshot(function (val) {
-    return (0, _typeof2.default)(val) === 'object' && val.name === slotName ? val : {
-      name: slotName,
-      description: description,
-      type: type,
-      value: val
-    };
-  }).postProcessSnapshot(function (snap) {
-    if ((0, _typeof2.default)(snap.value) === 'object') {
-      return JSON.stringify(snap.value) !== JSON.stringify(defaultValue) ? snap.value : undefined;
+function ConfigSlot(slotName, { description = '', model, type, defaultValue, contextVariable = [], }) {
+    if (!type) {
+        throw new Error('type name required');
     }
-
-    return snap.value !== defaultValue ? snap.value : undefined;
-  }).actions(function (self) {
-    return {
-      set: function set(newVal) {
-        self.value = newVal;
-      },
-      reset: function reset() {
-        self.value = defaultValue;
-      },
-      convertToCallback: function convertToCallback() {
-        if (self.isCallback) {
-          return;
-        }
-
-        self.value = "jexl:".concat(self.valueJSON || "''");
-      },
-      convertToValue: function convertToValue() {
-        if (!self.isCallback) {
-          return;
-        } // try calling it with no arguments
-
-
-        try {
-          var funcResult = self.expr.evalSync();
-
-          if (funcResult !== undefined) {
-            self.value = funcResult;
-            return;
-          }
-        } catch (e) {
-          /* ignore */
-        }
-
-        self.value = defaultValue; // if it is still a callback (happens if the defaultValue is a callback),
-        // then use the last-resort fallback default
-        // if defaultValue has jexl: string, run this part
-
-        if (self.isCallback) {
-          if (!(type in fallbackDefaults)) {
-            throw new Error("no fallbackDefault defined for type ".concat(type));
-          }
-
-          self.value = fallbackDefaults[type];
+    if (!model) {
+        model = typeModels[type];
+    }
+    if (!model) {
+        throw new Error(`no builtin config slot type "${type}", and no 'model' param provided`);
+    }
+    if (defaultValue === undefined) {
+        throw new Error("no 'defaultValue' provided");
+    }
+    // if the `type` is something like `color`, then the model name
+    // here will be `ColorConfigSlot`
+    const configSlotModelName = `${slotName
+        .charAt(0)
+        .toUpperCase()}${slotName.slice(1)}ConfigSlot`;
+    let slot = mobx_state_tree_1.types
+        .model(configSlotModelName, {
+        name: mobx_state_tree_1.types.literal(slotName),
+        description: mobx_state_tree_1.types.literal(description),
+        type: mobx_state_tree_1.types.literal(type),
+        value: mobx_state_tree_1.types.optional(mobx_state_tree_1.types.union(JexlStringType, model), defaultValue),
+    })
+        .volatile(() => ({
+        contextVariable,
+    }))
+        .views(self => ({
+        get isCallback() {
+            return String(self.value).startsWith('jexl:');
+        },
+    }))
+        .views(self => ({
+        get expr() {
+            if (self.isCallback) {
+                // compile as jexl function
+                const { pluginManager } = (0, mobx_state_tree_1.getEnv)(self);
+                if (!pluginManager && typeof jest === 'undefined') {
+                    console.warn('no pluginManager detected on config env (if you dynamically instantiate a config, for example in renderProps for your display model, check that you add the env argument)');
+                }
+                return (0, jexlStrings_1.stringToJexlExpression)(String(self.value), pluginManager === null || pluginManager === void 0 ? void 0 : pluginManager.jexl);
+            }
+            return { evalSync: () => self.value };
+        },
+        // JS representation of the value of this slot, suitable
+        // for embedding in either JSON or a JS function string.
+        // many of the data types override this in typeModelExtensions
+        get valueJSON() {
+            if (self.isCallback) {
+                return undefined;
+            }
+            function json(value) {
+                if (value && value.toJSON) {
+                    return value.toJSON();
+                }
+                return `"${value}"`;
+            }
+            return json(self.value);
+        },
+    }))
+        .preProcessSnapshot(val => typeof val === 'object' && val.name === slotName
+        ? val
+        : {
+            name: slotName,
+            description,
+            type,
+            value: val,
+        })
+        .postProcessSnapshot(snap => {
+        if (typeof snap.value === 'object') {
+            return JSON.stringify(snap.value) !== JSON.stringify(defaultValue)
+                ? snap.value
+                : undefined;
         }
-      }
-    };
-  }); // if there are any type-specific extensions (views or actions)
-  //  to the slot, add those in
-
-
-  if (typeModelExtensions[type]) {
-    slot = slot.extend(typeModelExtensions[type]);
-  }
-
-  var completeModel = _mobxStateTree.types.optional(slot, {
-    name: slotName,
-    type: type,
-    description: description,
-    value: defaultValue
-  });
-
-  var m = completeModel;
-  Object.defineProperty(m, 'isJBrowseConfigurationSlot', {
-    value: true
-  });
-  return m;
-}
+        return snap.value !== defaultValue ? snap.value : undefined;
+    })
+        .actions(self => ({
+        set(newVal) {
+            self.value = newVal;
+        },
+        reset() {
+            self.value = defaultValue;
+        },
+        convertToCallback() {
+            if (self.isCallback) {
+                return;
+            }
+            self.value = `jexl:${self.valueJSON || "''"}`;
+        },
+        convertToValue() {
+            if (!self.isCallback) {
+                return;
+            }
+            // try calling it with no arguments
+            try {
+                const funcResult = self.expr.evalSync();
+                if (funcResult !== undefined) {
+                    self.value = funcResult;
+                    return;
+                }
+            }
+            catch (e) {
+                /* ignore */
+            }
+            self.value = defaultValue;
+            // if it is still a callback (happens if the defaultValue is a callback),
+            // then use the last-resort fallback default
+            // if defaultValue has jexl: string, run this part
+            if (self.isCallback) {
+                if (!(type in fallbackDefaults)) {
+                    throw new Error(`no fallbackDefault defined for type ${type}`);
+                }
+                self.value = fallbackDefaults[type];
+            }
+        },
+    }));
+    // if there are any type-specific extensions (views or actions)
+    //  to the slot, add those in
+    if (typeModelExtensions[type]) {
+        slot = slot.extend(typeModelExtensions[type]);
+    }
+    const completeModel = mobx_state_tree_1.types.optional(slot, {
+        name: slotName,
+        type,
+        description,
+        value: defaultValue,
+    });
+    const m = completeModel;
+    Object.defineProperty(m, 'isJBrowseConfigurationSlot', { value: true });
+    return m;
+}
+exports.default = ConfigSlot;

package/configuration/index.js

@@ -1,37 +1,21 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _exportNames = {
-  ConfigurationSchema: true,
-  ConfigurationReference: true
-};
-Object.defineProperty(exports, "ConfigurationReference", {
-  enumerable: true,
-  get: function get() {
-    return _configurationSchema.ConfigurationReference;
-  }
-});
-Object.defineProperty(exports, "ConfigurationSchema", {
-  enumerable: true,
-  get: function get() {
-    return _configurationSchema.ConfigurationSchema;
-  }
-});
-
-var _configurationSchema = require("./configurationSchema");
-
-var _util = require("./util");
-
-Object.keys(_util).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
-  if (key in exports && exports[key] === _util[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function get() {
-      return _util[key];
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-  });
-});
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationReference = exports.ConfigurationSchema = void 0;
+var configurationSchema_1 = require("./configurationSchema");
+Object.defineProperty(exports, "ConfigurationSchema", { enumerable: true, get: function () { return configurationSchema_1.ConfigurationSchema; } });
+Object.defineProperty(exports, "ConfigurationReference", { enumerable: true, get: function () { return configurationSchema_1.ConfigurationReference; } });
+__exportStar(require("./util"), exports);

package/configuration/util.d.ts

@@ -27,6 +27,6 @@ export declare function getConf(model: unknown, slotPath?: string[] | string | u
  */
 export declare function getTypeNamesFromExplicitlyTypedUnion(maybeUnionType: unknown): string[];
 export declare function isBareConfigurationSchemaType(thing: unknown): thing is AnyConfigurationSchemaType;
-export declare function isConfigurationSchemaType(thing: unknown): boolean;
+export declare function isConfigurationSchemaType(thing: unknown): thing is AnyConfigurationSchemaType;
 export declare function isConfigurationModel(thing: unknown): thing is AnyConfigurationModel;
 export declare function isConfigurationSlotType(thing: unknown): boolean;