@jbrowse/plugin-legacy-jbrowse 1.7.11 → 2.0.0

package/esm/JBrowse1Connection/jb1ConfigLoad.js

@@ -0,0 +1,281 @@
+import { openLocation } from '@jbrowse/core/util/io';
+import { parseJB1Json, parseJB1Conf, regularizeConf } from './jb1ConfigParse';
+import { clone, deepUpdate, fillTemplate } from './util';
+function isUriLocation(location) {
+    return location.uri !== undefined;
+}
+function isLocalPathLocation(location) {
+    return location.localPath !== undefined;
+}
+export async function fetchJb1(dataRoot = { uri: '', locationType: 'UriLocation' }, baseConfig = {
+    include: ['{dataRoot}/trackList.json', '{dataRoot}/tracks.conf'],
+}, baseConfigRoot = { uri: '', locationType: 'UriLocation' }) {
+    const protocol = 'uri' in dataRoot ? 'uri' : 'localPath';
+    const dataRootReg = JSON.parse(JSON.stringify(dataRoot));
+    let dataRootLocation = '';
+    if (isUriLocation(dataRoot)) {
+        dataRootLocation = dataRoot.uri;
+    }
+    if (isLocalPathLocation(dataRoot)) {
+        dataRootLocation = dataRoot.localPath;
+    }
+    if (dataRootLocation.endsWith('/')) {
+        dataRootReg[protocol] = dataRootLocation.slice(0, dataRootLocation.length - 1);
+    }
+    if ((isUriLocation(baseConfigRoot) && baseConfigRoot.uri) ||
+        (isLocalPathLocation(baseConfigRoot) && baseConfigRoot.localPath)) {
+        const baseProtocol = 'uri' in baseConfigRoot ? 'uri' : 'localPath';
+        let baseConfigLocation = '';
+        if (isUriLocation(baseConfigRoot)) {
+            baseConfigLocation = baseConfigRoot.uri;
+        }
+        if (isLocalPathLocation(baseConfigRoot)) {
+            baseConfigLocation = baseConfigRoot.localPath;
+        }
+        if (baseConfigLocation.endsWith('/')) {
+            baseConfigLocation = baseConfigLocation.slice(0, baseConfigLocation.length - 1);
+        }
+        let newConfig = {};
+        for (const conf of ['jbrowse.conf', 'jbrowse_conf.json']) {
+            let fetchedConfig = null;
+            try {
+                // @ts-ignore
+                fetchedConfig = await fetchConfigFile({
+                    [baseProtocol]: `${baseConfigLocation}/${conf}`,
+                });
+            }
+            catch (error) {
+                console.error(`tried to access ${baseConfigLocation}/${conf}, but failed`);
+            }
+            newConfig = mergeConfigs(newConfig, fetchedConfig) || {};
+        }
+        if (dataRootReg[protocol]) {
+            newConfig.dataRoot = dataRootReg[protocol];
+        }
+        return createFinalConfig(newConfig);
+    }
+    const newConfig = regularizeConf(baseConfig, window.location.href);
+    if (dataRootReg[protocol]) {
+        newConfig.dataRoot = dataRootReg[protocol];
+    }
+    return createFinalConfig(newConfig);
+}
+export async function createFinalConfig(baseConfig, defaults = configDefaults) {
+    const configWithDefaults = deepUpdate(clone(defaults), baseConfig);
+    let finalConfig = await loadIncludes(configWithDefaults);
+    finalConfig = mergeConfigs(finalConfig, baseConfig) || finalConfig;
+    fillTemplates(finalConfig, finalConfig);
+    validateConfig(finalConfig);
+    return finalConfig;
+}
+export async function fetchConfigFile(location) {
+    const result = await openLocation(location).readFile('utf8');
+    if (isUriLocation(location)) {
+        return parseJb1(result, location.uri);
+    }
+    if (isLocalPathLocation(location)) {
+        return parseJb1(result, location.localPath);
+    }
+    return parseJb1(result);
+}
+export function parseJb1(config, url = '') {
+    if (config.trim().startsWith('{')) {
+        return parseJB1Json(config, url);
+    }
+    return parseJB1Conf(config, url);
+}
+/**
+ * Merges config object b into a. Properties in b override those in a.
+ */
+function mergeConfigs(a, b) {
+    if (b === null) {
+        return null;
+    }
+    if (a === null) {
+        a = {};
+    }
+    for (const prop of Object.keys(b)) {
+        if (prop === 'tracks' && prop in a) {
+            const aTracks = a[prop] || [];
+            const bTracks = b[prop] || [];
+            if (Array.isArray(aTracks) && Array.isArray(bTracks)) {
+                a[prop] = mergeTrackConfigs(aTracks || [], bTracks || []);
+            }
+            else {
+                throw new Error(`Track config has not been properly regularized: ${aTracks} ${bTracks}`);
+            }
+        }
+        else if (!noRecursiveMerge(prop) &&
+            prop in a &&
+            // @ts-ignore
+            typeof b[prop] === 'object' &&
+            // @ts-ignore
+            typeof a[prop] === 'object') {
+            // @ts-ignore
+            a[prop] = deepUpdate(a[prop], b[prop]);
+        }
+        else if (prop === 'dataRoot') {
+            if (a[prop] === undefined ||
+                (a[prop] === 'data' && b[prop] !== undefined)) {
+                a[prop] = b[prop];
+            }
+            // @ts-ignore
+        }
+        else if (a[prop] === undefined || b[prop] !== undefined) {
+            // @ts-ignore
+            a[prop] = b[prop];
+        }
+    }
+    return a;
+}
+/**
+ * Special-case merging of two `tracks` configuration arrays.
+ */
+function mergeTrackConfigs(a, b) {
+    if (!b.length) {
+        return a;
+    }
+    // index the tracks in `a` by track label
+    const aTracks = {};
+    a.forEach((t, i) => {
+        t.index = i;
+        aTracks[t.label] = t;
+    });
+    b.forEach((bT) => {
+        const aT = aTracks[bT.label];
+        if (aT) {
+            mergeConfigs(aT, bT);
+        }
+        else {
+            a.push(bT);
+        }
+    });
+    return a;
+}
+/**
+ * Recursively fetch, parse, and merge all the includes in the given config
+ * object.  Calls the callback with the resulting configuration when finished.
+ * @param inputConfig - Config to load includes into
+ */
+async function loadIncludes(inputConfig) {
+    inputConfig = clone(inputConfig);
+    async function loadRecur(config, upstreamConf) {
+        const sourceUrl = config.sourceUrl || config.baseUrl;
+        if (!sourceUrl) {
+            throw new Error(`Could not determine source URL: ${JSON.stringify(config)}`);
+        }
+        const newUpstreamConf = mergeConfigs(clone(upstreamConf), config);
+        if (!newUpstreamConf) {
+            throw new Error('Problem merging configs');
+        }
+        const includes = fillTemplates(regularizeIncludes(config.include || []), newUpstreamConf);
+        delete config.include;
+        const loads = includes.map(async (include) => {
+            include.cacheBuster = inputConfig.cacheBuster;
+            const includedData = await fetchConfigFile({
+                uri: new URL(include.url, sourceUrl).href,
+                locationType: 'UriLocation',
+            });
+            return loadRecur(includedData, newUpstreamConf);
+        });
+        const includedDataObjects = await Promise.all(loads);
+        includedDataObjects.forEach((includedData) => {
+            config = mergeConfigs(config, includedData) || config;
+        });
+        return config;
+    }
+    return loadRecur(inputConfig, {});
+}
+function regularizeIncludes(includes) {
+    if (!includes) {
+        return [];
+    }
+    // coerce include to an array
+    if (!Array.isArray(includes)) {
+        includes = [includes];
+    }
+    return includes.map((include) => {
+        // coerce bare strings in the includes to URLs
+        if (typeof include === 'string') {
+            include = { url: include };
+        }
+        // set defaults for format and version
+        if (!('format' in include)) {
+            include.format = include.url.endsWith('.conf') ? 'conf' : 'JB_json';
+        }
+        if (include.format === 'JB_json' && !('version' in include)) {
+            include.version = 1;
+        }
+        return include;
+    });
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any,@typescript-eslint/no-unnecessary-type-constraint
+function fillTemplates(subconfig, config) {
+    if (!subconfig) {
+        return subconfig;
+    }
+    if (Array.isArray(subconfig)) {
+        for (let i = 0; i < subconfig.length; i += 1) {
+            subconfig[i] = fillTemplates(subconfig[i], config);
+        }
+    }
+    else if (typeof subconfig === 'object') {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const sub = subconfig;
+        for (const name of Object.keys(sub)) {
+            sub[name] = fillTemplates(sub[name], config);
+        }
+    }
+    else if (typeof subconfig === 'string') {
+        // @ts-ignore
+        return fillTemplate(subconfig, config);
+    }
+    return subconfig;
+}
+/**
+ * list of config properties that should not be recursively merged
+ * @param propName - name of config property
+ */
+function noRecursiveMerge(propName) {
+    return propName === 'datasets';
+}
+const configDefaults = {
+    tracks: [],
+    containerID: 'GenomeBrowser',
+    dataRoot: 'data',
+    show_tracklist: true,
+    show_nav: true,
+    show_menu: true,
+    show_overview: true,
+    show_fullviewlink: true,
+    update_browser_title: true,
+    updateBrowserURL: true,
+    refSeqs: '{dataRoot}/seq/refSeqs.json',
+    include: ['jbrowse.conf', 'jbrowse_conf.json'],
+    nameUrl: '{dataRoot}/names/root.json',
+    datasets: {
+        _DEFAULT_EXAMPLES: true,
+        volvox: { url: '?data=sample_data/json/volvox', name: 'Volvox Example' },
+        modencode: {
+            url: '?data=sample_data/json/modencode',
+            name: 'MODEncode Example',
+        },
+        yeast: { url: '?data=sample_data/json/yeast', name: 'Yeast Example' },
+    },
+    highlightSearchedRegions: false,
+    highResolutionMode: 'auto',
+};
+/**
+ * Examine the loaded and merged configuration for errors.  Throws
+ * exceptions if it finds anything amiss.
+ * @returns nothing meaningful
+ */
+function validateConfig(config) {
+    if (!config.tracks) {
+        config.tracks = [];
+    }
+    if (!config.baseUrl) {
+        throw new Error('Must provide a `baseUrl` in configuration');
+    }
+}
+//# sourceMappingURL=jb1ConfigLoad.js.map

package/esm/JBrowse1Connection/jb1ConfigLoad.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jb1ConfigLoad.js","sourceRoot":"","sources":["../../src/JBrowse1Connection/jb1ConfigLoad.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAC7E,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAUxD,SAAS,aAAa,CAAC,QAAoB;IACzC,OAAQ,QAAwB,CAAC,GAAG,KAAK,SAAS,CAAA;AACpD,CAAC;AAED,SAAS,mBAAmB,CAC1B,QAAoB;IAEpB,OAAQ,QAA8B,CAAC,SAAS,KAAK,SAAS,CAAA;AAChE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,WAAuB,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE,EAC/D,aAAqB;IACnB,OAAO,EAAE,CAAC,2BAA2B,EAAE,wBAAwB,CAAC;CACjE,EACD,iBAA6B,EAAE,GAAG,EAAE,EAAE,EAAE,YAAY,EAAE,aAAa,EAAE;IAErE,MAAM,QAAQ,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAA;IACxD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;IACxD,IAAI,gBAAgB,GAAG,EAAE,CAAA;IACzB,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;QAC3B,gBAAgB,GAAG,QAAQ,CAAC,GAAG,CAAA;KAChC;IACD,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE;QACjC,gBAAgB,GAAG,QAAQ,CAAC,SAAS,CAAA;KACtC;IACD,IAAI,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClC,WAAW,CAAC,QAAQ,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAC5C,CAAC,EACD,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAC5B,CAAA;KACF;IACD,IACE,CAAC,aAAa,CAAC,cAAc,CAAC,IAAI,cAAc,CAAC,GAAG,CAAC;QACrD,CAAC,mBAAmB,CAAC,cAAc,CAAC,IAAI,cAAc,CAAC,SAAS,CAAC,EACjE;QACA,MAAM,YAAY,GAAG,KAAK,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAA;QAClE,IAAI,kBAAkB,GAAG,EAAE,CAAA;QAC3B,IAAI,aAAa,CAAC,cAAc,CAAC,EAAE;YACjC,kBAAkB,GAAG,cAAc,CAAC,GAAG,CAAA;SACxC;QACD,IAAI,mBAAmB,CAAC,cAAc,CAAC,EAAE;YACvC,kBAAkB,GAAG,cAAc,CAAC,SAAS,CAAA;SAC9C;QACD,IAAI,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACpC,kBAAkB,GAAG,kBAAkB,CAAC,KAAK,CAC3C,CAAC,EACD,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAC9B,CAAA;SACF;QACD,IAAI,SAAS,GAAW,EAAE,CAAA;QAC1B,KAAK,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,mBAAmB,CAAC,EAAE;YACxD,IAAI,aAAa,GAAG,IAAI,CAAA;YACxB,IAAI;gBACF,aAAa;gBACb,aAAa,GAAG,MAAM,eAAe,CAAC;oBACpC,CAAC,YAAY,CAAC,EAAE,GAAG,kBAAkB,IAAI,IAAI,EAAE;iBAChD,CAAC,CAAA;aACH;YAAC,OAAO,KAAK,EAAE;gBACd,OAAO,CAAC,KAAK,CACX,mBAAmB,kBAAkB,IAAI,IAAI,cAAc,CAC5D,CAAA;aACF;YACD,SAAS,GAAG,YAAY,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE,CAAA;SACzD;QACD,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;YACzB,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;SAC3C;QACD,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAA;KACpC;IACD,MAAM,SAAS,GAAG,cAAc,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAClE,IAAI,WAAW,CAAC,QAAQ,CAAC,EAAE;QACzB,SAAS,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAA;KAC3C;IACD,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAA;AACrC,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAkB,EAClB,QAAQ,GAAG,cAAc;IAEzB,MAAM,kBAAkB,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,UAAU,CAAC,CAAA;IAClE,IAAI,WAAW,GAAG,MAAM,YAAY,CAAC,kBAAkB,CAAC,CAAA;IACxD,WAAW,GAAG,YAAY,CAAC,WAAW,EAAE,UAAU,CAAC,IAAI,WAAW,CAAA;IAClE,aAAa,CAAC,WAAW,EAAE,WAAW,CAAC,CAAA;IACvC,cAAc,CAAC,WAAW,CAAC,CAAA;IAC3B,OAAO,WAAW,CAAA;AACpB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,QAAoB;IACxD,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC5D,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE;QAC3B,OAAO,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA;KACtC;IACD,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE;QACjC,OAAO,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;KAC5C;IACD,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAA;AACzB,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAc,EAAE,GAAG,GAAG,EAAE;IAC/C,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACjC,OAAO,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KACjC;IACD,OAAO,YAAY,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;AAClC,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,CAAgB,EAAE,CAAgB;IACtD,IAAI,CAAC,KAAK,IAAI,EAAE;QACd,OAAO,IAAI,CAAA;KACZ;IAED,IAAI,CAAC,KAAK,IAAI,EAAE;QACd,CAAC,GAAG,EAAE,CAAA;KACP;IAED,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;QACjC,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,IAAI,CAAC,EAAE;YAClC,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;YAC7B,MAAM,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;YAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;gBACpD,CAAC,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,OAAO,IAAI,EAAE,EAAE,OAAO,IAAI,EAAE,CAAC,CAAA;aAC1D;iBAAM;gBACL,MAAM,IAAI,KAAK,CACb,mDAAmD,OAAO,IAAI,OAAO,EAAE,CACxE,CAAA;aACF;SACF;aAAM,IACL,CAAC,gBAAgB,CAAC,IAAI,CAAC;YACvB,IAAI,IAAI,CAAC;YACT,aAAa;YACb,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ;YAC3B,aAAa;YACb,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ,EAC3B;YACA,aAAa;YACb,CAAC,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;SACvC;aAAM,IAAI,IAAI,KAAK,UAAU,EAAE;YAC9B,IACE,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS;gBACrB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,EAC7C;gBACA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAA;aAClB;YACD,aAAa;SACd;aAAM,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE;YACzD,aAAa;YACb,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAA;SAClB;KACF;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,CAAU,EAAE,CAAU;IAC/C,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE;QACb,OAAO,CAAC,CAAA;KACT;IAED,yCAAyC;IACzC,MAAM,OAAO,GAA0B,EAAE,CAAA;IACzC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAQ,EAAE;QACvB,CAAC,CAAC,KAAK,GAAG,CAAC,CAAA;QACX,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAQ,EAAE;QACrB,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;QAC5B,IAAI,EAAE,EAAE;YACN,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;SACrB;aAAM;YACL,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;SACX;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,CAAC,CAAA;AACV,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,YAAY,CAAC,WAAmB;IAC7C,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,CAAA;IAEhC,KAAK,UAAU,SAAS,CACtB,MAAc,EACd,YAAoB;QAEpB,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,OAAO,CAAA;QACpD,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,KAAK,CACb,mCAAmC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAC5D,CAAA;SACF;QACD,MAAM,eAAe,GAAG,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,CAAA;QACjE,IAAI,CAAC,eAAe,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QACD,MAAM,QAAQ,GAAG,aAAa,CAC5B,kBAAkB,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EACxC,eAAe,CAChB,CAAA;QACD,OAAO,MAAM,CAAC,OAAO,CAAA;QAErB,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAmB,EAAE;YAC5D,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC,WAAW,CAAA;YAC7C,MAAM,YAAY,GAAG,MAAM,eAAe,CAAC;gBACzC,GAAG,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,IAAI;gBACzC,YAAY,EAAE,aAAa;aAC5B,CAAC,CAAA;YACF,OAAO,SAAS,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QACF,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACpD,mBAAmB,CAAC,OAAO,CAAC,CAAC,YAAY,EAAQ,EAAE;YACjD,MAAM,GAAG,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,IAAI,MAAM,CAAA;QACvD,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,CAAA;IACf,CAAC;IAED,OAAO,SAAS,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;AACnC,CAAC;AAED,SAAS,kBAAkB,CACzB,QAAwD;IAExD,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,EAAE,CAAA;KACV;IAED,6BAA6B;IAC7B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC5B,QAAQ,GAAG,CAAC,QAAQ,CAAC,CAAA;KACtB;IAED,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAW,EAAE;QACvC,8CAA8C;QAC9C,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,OAAO,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,CAAA;SAC3B;QAED,sCAAsC;QACtC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC,EAAE;YAC1B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAA;SACpE;QACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,SAAS,IAAI,OAAO,CAAC,EAAE;YAC3D,OAAO,CAAC,OAAO,GAAG,CAAC,CAAA;SACpB;QACD,OAAO,OAAO,CAAA;IAChB,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,gHAAgH;AAChH,SAAS,aAAa,CAAgB,SAAY,EAAE,MAAc;IAChE,IAAI,CAAC,SAAS,EAAE;QACd,OAAO,SAAS,CAAA;KACjB;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC5C,SAAS,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;SACnD;KACF;SAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACxC,8DAA8D;QAC9D,MAAM,GAAG,GAAG,SAAgC,CAAA;QAC5C,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YACnC,GAAG,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;SAC7C;KACF;SAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;QACxC,aAAa;QACb,OAAO,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAA;KACvC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,QAAgB;IACxC,OAAO,QAAQ,KAAK,UAAU,CAAA;AAChC,CAAC;AAED,MAAM,cAAc,GAAG;IACrB,MAAM,EAAE,EAAE;IAEV,WAAW,EAAE,eAAe;IAC5B,QAAQ,EAAE,MAAM;IAChB,cAAc,EAAE,IAAI;IACpB,QAAQ,EAAE,IAAI;IACd,SAAS,EAAE,IAAI;IACf,aAAa,EAAE,IAAI;IACnB,iBAAiB,EAAE,IAAI;IACvB,oBAAoB,EAAE,IAAI;IAC1B,gBAAgB,EAAE,IAAI;IAEtB,OAAO,EAAE,6BAA6B;IACtC,OAAO,EAAE,CAAC,cAAc,EAAE,mBAAmB,CAAC;IAC9C,OAAO,EAAE,4BAA4B;IAErC,QAAQ,EAAE;QACR,iBAAiB,EAAE,IAAI;QACvB,MAAM,EAAE,EAAE,GAAG,EAAE,+BAA+B,EAAE,IAAI,EAAE,gBAAgB,EAAE;QACxE,SAAS,EAAE;YACT,GAAG,EAAE,kCAAkC;YACvC,IAAI,EAAE,mBAAmB;SAC1B;QACD,KAAK,EAAE,EAAE,GAAG,EAAE,8BAA8B,EAAE,IAAI,EAAE,eAAe,EAAE;KACtE;IAED,wBAAwB,EAAE,KAAK;IAC/B,kBAAkB,EAAE,MAAM;CAC3B,CAAA;AAED;;;;GAIG;AACH,SAAS,cAAc,CAAC,MAAc;IACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,MAAM,CAAC,MAAM,GAAG,EAAE,CAAA;KACnB;IACD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;KAC7D;AACH,CAAC"}

package/esm/JBrowse1Connection/jb1ConfigParse.d.ts

@@ -0,0 +1,11 @@
+import { Config } from './types';
+export declare function parseJB1Json(config: Config | string, url: string): Config;
+export declare function parseJB1Conf(config: string, url: string): Config;
+/**
+ * Applies defaults and any other necessary tweaks to the loaded configuration.
+ * @param conf - the object containing the configuration, which it modifies
+ * in-place
+ * @param url - URL of the config file
+ * @returns the same object it was passed
+ */
+export declare function regularizeConf(conf: Config, url: string): Config;

package/esm/JBrowse1Connection/jb1ConfigParse.js

@@ -0,0 +1,377 @@
+/* eslint no-cond-assign: ["error", "except-parens"] */
+import getValue from 'get-value';
+import setValue from 'set-value';
+import { objectHash } from '@jbrowse/core/util';
+import { isSource, isTrack } from './util';
+export function parseJB1Json(config, url) {
+    if (typeof config === 'string') {
+        let parsedConf;
+        try {
+            parsedConf = JSON.parse(config);
+        }
+        catch (error) {
+            throw new Error(`${error} when parsing configuration.`);
+        }
+        return regularizeConf(parsedConf, url);
+    }
+    return regularizeConf(config, url);
+}
+export function parseJB1Conf(config, url) {
+    let parsedConf;
+    try {
+        parsedConf = parse(config, url);
+    }
+    catch (error) {
+        throw new Error(`${error} when parsing configuration.`);
+    }
+    return regularizeConf(parsedConf, url);
+}
+function isAlwaysArray(varName) {
+    if (varName === 'include') {
+        return true;
+    }
+    return false;
+}
+function parse(text, url) {
+    let section = [];
+    let keyPath;
+    let operation;
+    let value;
+    const data = { tracks: {} };
+    let lineNumber;
+    function recordVal() {
+        if (value !== undefined) {
+            let parsedValue;
+            try {
+                // parse json
+                const match = value.match(/^json:(.+)/i);
+                if (match) {
+                    parsedValue = JSON.parse(match[1]);
+                }
+                // parse numbers if it looks numeric
+                else if (/^[+-]?[\d.,]+([eE][-+]?\d+)?$/.test(value)) {
+                    parsedValue = parseFloat(value.replace(/,/g, ''));
+                }
+                else {
+                    parsedValue = value;
+                }
+                if (!keyPath) {
+                    throw new Error(`Error parsing in section ${section.join(' - ')}`);
+                }
+                const path = section.concat(keyPath).join('.');
+                if (operation === '+=') {
+                    let existing = getValue(data, path);
+                    if (existing) {
+                        if (!Array.isArray(existing)) {
+                            existing = [existing];
+                        }
+                    }
+                    else {
+                        existing = [];
+                    }
+                    existing.push(parsedValue);
+                    parsedValue = existing;
+                }
+                if (parsedValue === 'true') {
+                    parsedValue = true;
+                }
+                if (parsedValue === 'false') {
+                    parsedValue = false;
+                }
+                setValue(data, path, parsedValue);
+            }
+            catch (e) {
+                throw new Error(`syntax error${url ? ` in ${url}` : ''}${lineNumber ? ` at line ${lineNumber - 1}` : ''}`);
+            }
+        }
+    }
+    text.split('\n').forEach((textLine, i) => {
+        lineNumber = i + 1;
+        const line = textLine.replace(/^\s*#.+/, '');
+        // new section
+        let match;
+        if ((match = line.match(/^\s*\[([^\]]+)/))) {
+            // new section
+            recordVal();
+            keyPath = undefined;
+            value = undefined;
+            section = match[1].trim().split(/\s*\.\s*/);
+            if (section.length === 1 && section[0].toLowerCase() === 'general') {
+                section = [];
+            }
+        }
+        // new value
+        else if ((match = line.match(value === undefined ? /^([^+=]+)(\+?=)(.*)/ : /^(\S[^+=]+)(\+?=)(.*)/))) {
+            recordVal();
+            keyPath = match[1].trim().split(/\s*\.\s*/);
+            [, , operation] = match;
+            if (isAlwaysArray(section.concat(keyPath).join('.'))) {
+                operation = '+=';
+            }
+            value = match[3].trim();
+        }
+        // add to existing array value
+        else if (keyPath !== undefined &&
+            (match = line.match(/^\s{0,4}\+\s*(.+)/))) {
+            recordVal();
+            operation = '+=';
+            value = match[1].trim();
+        }
+        // add to existing value
+        else if (value !== undefined && (match = line.match(/^\s+(\S.*)/))) {
+            value += value.length ? ` ${match[1].trim()}` : match[1].trim();
+        }
+        // done with last value
+        else {
+            recordVal();
+            keyPath = undefined;
+            value = undefined;
+        }
+    });
+    recordVal();
+    return data;
+}
+/**
+ * Applies defaults and any other necessary tweaks to the loaded configuration.
+ * @param conf - the object containing the configuration, which it modifies
+ * in-place
+ * @param url - URL of the config file
+ * @returns the same object it was passed
+ */
+export function regularizeConf(conf, url) {
+    // if tracks is not an array, convert it to one
+    if (conf.tracks && !Array.isArray(conf.tracks)) {
+        // if it's a single track config, wrap it in an arrayref
+        if (isTrack(conf.tracks)) {
+            conf.tracks = [conf.tracks];
+        }
+        // otherwise, coerce it to an array
+        else {
+            const tracks = [];
+            for (const label of Object.keys(conf.tracks)) {
+                const track = conf.tracks[label];
+                if (isTrack(track)) {
+                    tracks.push(track);
+                }
+                else {
+                    tracks.push({ label, ...track });
+                }
+            }
+            conf.tracks = tracks;
+        }
+    }
+    // regularize trackMetadata.sources
+    const meta = conf.trackMetadata;
+    if (meta && meta.sources) {
+        // if it's a single source config, wrap it in an arrayref
+        if (typeof meta.sources === 'string') {
+            meta.sources = [meta.sources];
+        }
+        if (isSource(meta.sources)) {
+            meta.sources = [meta.sources];
+        }
+        if (!Array.isArray(meta.sources)) {
+            const sources = [];
+            for (const name of Object.keys(meta.sources)) {
+                const source = meta.sources[name];
+                if (!('name' in source)) {
+                    source.name = name;
+                }
+                sources.push(source);
+            }
+            meta.sources = sources;
+        }
+        // coerce any string source defs to be URLs, and try to detect their types
+        meta.sources = meta.sources.map((sourceDef) => {
+            if (typeof sourceDef === 'string') {
+                const newSourceDef = { url: sourceDef };
+                const typeMatch = sourceDef.match(/\.(\w+)$/);
+                if (typeMatch) {
+                    newSourceDef.type = typeMatch[1].toLowerCase();
+                }
+                return newSourceDef;
+            }
+            return sourceDef;
+        });
+    }
+    conf.sourceUrl = conf.sourceUrl || url;
+    if (conf.sourceUrl.startsWith('/')) {
+        conf.sourceUrl = new URL(conf.sourceUrl, window.location.href).href;
+    }
+    conf.baseUrl = conf.baseUrl || new URL('.', conf.sourceUrl).href;
+    if (conf.baseUrl.length && !conf.baseUrl.endsWith('/')) {
+        conf.baseUrl += '/';
+    }
+    if (conf.sourceUrl) {
+        // set a default baseUrl in each of the track and store confs, and the names
+        // conf, if needed
+        const addBase = [];
+        if (conf.tracks) {
+            addBase.push(...conf.tracks);
+        }
+        if (conf.stores) {
+            addBase.push(...Object.values(conf.stores));
+        }
+        if (conf.names) {
+            addBase.push(conf.names);
+        }
+        addBase.forEach((t) => {
+            if (!t.baseUrl) {
+                t.baseUrl = conf.baseUrl || '/';
+            }
+        });
+        // resolve the refSeqs and nameUrl if present
+        if (conf.refSeqs && typeof conf.refSeqs === 'string') {
+            conf.refSeqs = new URL(conf.refSeqs, conf.sourceUrl).href;
+        }
+        if (conf.nameUrl) {
+            conf.nameUrl = new URL(conf.nameUrl, conf.sourceUrl).href;
+        }
+    }
+    conf.stores = conf.stores || {};
+    (conf.tracks || []).forEach((trackConfig) => {
+        // if there is a `config` subpart, just copy its keys in to the top-level
+        // config
+        if (trackConfig.config) {
+            const c = trackConfig.config;
+            delete trackConfig.config;
+            trackConfig = { ...c, ...trackConfig };
+        }
+        // skip if it's a new-style track def
+        if (trackConfig.store) {
+            return;
+        }
+        let trackClassName;
+        if (trackConfig.type === 'FeatureTrack') {
+            trackClassName = 'JBrowse/View/Track/HTMLFeatures';
+        }
+        else if (trackConfig.type === 'ImageTrack') {
+            trackClassName = 'JBrowse/View/Track/FixedImage';
+        }
+        else if (trackConfig.type === 'ImageTrack.Wiggle') {
+            trackClassName = 'JBrowse/View/Track/FixedImage/Wiggle';
+        }
+        else if (trackConfig.type === 'SequenceTrack') {
+            trackClassName = 'JBrowse/View/Track/Sequence';
+        }
+        else {
+            trackClassName = regularizeClass('JBrowse/View/Track', trackConfig.type);
+        }
+        trackConfig.type = trackClassName;
+        synthesizeTrackStoreConfig(conf, trackConfig);
+        if (trackConfig.histograms) {
+            if (!trackConfig.histograms.baseUrl) {
+                trackConfig.histograms.baseUrl = trackConfig.baseUrl;
+            }
+            synthesizeTrackStoreConfig(conf, trackConfig.histograms);
+        }
+    });
+    return conf;
+}
+/**
+ * prefix class name with `root` if it contains no slashes
+ * @param root - Prefix root
+ * @param className - class name
+ */
+function regularizeClass(root, className) {
+    if (!className) {
+        return '';
+    }
+    if (!className.includes('/')) {
+        className = `${root}/${className}`;
+    }
+    className = className.replace(/^\//, '');
+    return className;
+}
+function guessStoreClass(trackConfig, urlTemplate) {
+    if (!trackConfig) {
+        return '';
+    }
+    if (trackConfig.type && trackConfig.type.includes('/FixedImage')) {
+        return `JBrowse/Store/TiledImage/Fixed${trackConfig.backendVersion === 0 ? '_v0' : ''}`;
+    }
+    if (/\.jsonz?$/i.test(urlTemplate)) {
+        return `JBrowse/Store/SeqFeature/NCList${trackConfig.backendVersion === 0 ? '_v0' : ''}`;
+    }
+    if (/\.bam$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/BAM';
+    }
+    if (/\.cram$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/CRAM';
+    }
+    if (/\.gff3?$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/GFF3';
+    }
+    if (/\.bed$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/BED';
+    }
+    if (/\.vcf.b?gz$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/VCFTabix';
+    }
+    if (/\.gff3?.b?gz$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/GFF3Tabix';
+    }
+    if (/\.bed.b?gz$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/BEDTabix';
+    }
+    if (/\.(bw|bigwig)$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/BigWig';
+    }
+    if (/\.(bb|bigbed)$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/BigBed';
+    }
+    if (/\.(fa|fasta)$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/IndexedFasta';
+    }
+    if (/\.(fa|fasta)\.b?gz$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/BgzipIndexedFasta';
+    }
+    if (/\.2bit$/i.test(urlTemplate)) {
+        return 'JBrowse/Store/SeqFeature/TwoBit';
+    }
+    if (trackConfig.type && trackConfig.type.endsWith('/Sequence')) {
+        return 'JBrowse/Store/Sequence/StaticChunked';
+    }
+    return '';
+}
+function synthesizeTrackStoreConfig(mainConf, trackConfig) {
+    // figure out what data store class to use with the track, applying some
+    // defaults if it is not explicit in the configuration
+    const { urlTemplate = '' } = trackConfig;
+    let storeClass;
+    if (trackConfig.storeClass) {
+        storeClass = regularizeClass('JBrowse/Store', trackConfig.storeClass);
+    }
+    else {
+        storeClass = guessStoreClass(trackConfig, urlTemplate);
+    }
+    if (!storeClass) {
+        console.warn(`Unable to determine an appropriate data store to use with track '${trackConfig.label}', please explicitly specify a storeClass in the configuration.`);
+        return;
+    }
+    // synthesize a separate store conf
+    const storeConf = { ...trackConfig, type: storeClass };
+    // if this is the first sequence store we see, and we have no refseqs store
+    // defined explicitly, make this the refseqs store.
+    if ((storeClass === 'JBrowse/Store/Sequence/StaticChunked' ||
+        storeClass === 'JBrowse/Store/Sequence/IndexedFasta' ||
+        storeClass === 'JBrowse/Store/SeqFeature/IndexedFasta' ||
+        storeClass === 'JBrowse/Store/SeqFeature/BgzipIndexedFasta' ||
+        storeClass === 'JBrowse/Store/SeqFeature/TwoBit' ||
+        storeClass === 'JBrowse/Store/Sequence/TwoBit' ||
+        trackConfig.useAsRefSeqStore) &&
+        !(mainConf.stores && mainConf.stores.refseqs)) {
+        storeConf.name = 'refseqs';
+    }
+    else {
+        storeConf.name = `store${objectHash(storeConf)}`;
+    }
+    // record it
+    if (!mainConf.stores) {
+        mainConf.stores = {};
+    }
+    mainConf.stores[storeConf.name] = storeConf;
+    // connect it to the track conf
+    trackConfig.store = storeConf.name;
+}
+//# sourceMappingURL=jb1ConfigParse.js.map