@jbrowse/plugin-spreadsheet-view 2.6.1

package/esm/SpreadsheetView/models/ImportWizard.js

@@ -0,0 +1,168 @@
+import { types, getParent } from 'mobx-state-tree';
+import { openLocation } from '@jbrowse/core/util/io';
+import { getSession, getEnv } from '@jbrowse/core/util';
+// 30MB
+const IMPORT_SIZE_LIMIT = 30000000;
+const fileTypes = ['CSV', 'TSV', 'VCF', 'BED', 'BEDPE', 'STAR-Fusion'];
+const fileTypeParsers = {
+    CSV: () => import('../importAdapters/ImportUtils').then(r => r.parseCsvBuffer),
+    TSV: () => import('../importAdapters/ImportUtils').then(r => r.parseTsvBuffer),
+    VCF: () => import('../importAdapters/VcfImport').then(r => r.parseVcfBuffer),
+    BED: () => import('../importAdapters/BedImport').then(r => r.parseBedBuffer),
+    BEDPE: () => import('../importAdapters/BedImport').then(r => r.parseBedPEBuffer),
+    'STAR-Fusion': () => import('../importAdapters/STARFusionImport').then(r => r.parseSTARFusionBuffer),
+};
+// regexp used to guess the type of a file or URL from its file extension
+const fileTypesRegexp = new RegExp(`\\.(${fileTypes.join('|')})(\\.gz)?$`, 'i');
+/**
+ * #stateModel SpreadsheetImportWizard
+ * #category view
+ */
+function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+const ImportWizard = types
+    .model('SpreadsheetImportWizard', {
+    /**
+     * #property
+     */
+    fileType: types.optional(types.enumeration(fileTypes), 'CSV'),
+    /**
+     * #property
+     */
+    hasColumnNameLine: true,
+    /**
+     * #property
+     */
+    columnNameLineNumber: 1,
+    /**
+     * #property
+     */
+    selectedAssemblyName: types.maybe(types.string),
+})
+    .volatile(() => ({
+    fileTypes,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    fileSource: undefined,
+    error: undefined,
+    loading: false,
+}))
+    .views(self => ({
+    get isReadyToOpen() {
+        return (!self.error &&
+            self.fileSource &&
+            (self.fileSource.blobId ||
+                self.fileSource.localPath ||
+                self.fileSource.uri));
+    },
+    get canCancel() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return getParent(self).readyToDisplay;
+    },
+    get fileName() {
+        return (self.fileSource.uri ||
+            self.fileSource.localPath ||
+            (self.fileSource.blobId && self.fileSource.name));
+    },
+    get requiresUnzip() {
+        return this.fileName.endsWith('gz');
+    },
+    isValidRefName(refName, assemblyName) {
+        const { assemblyManager } = getSession(self);
+        if (!assemblyName) {
+            return false;
+        }
+        return assemblyManager.isValidRefName(refName, assemblyName);
+    },
+}))
+    .actions(self => ({
+    setSelectedAssemblyName(s) {
+        self.selectedAssemblyName = s;
+    },
+    setFileSource(newSource) {
+        self.fileSource = newSource;
+        self.error = undefined;
+        if (self.fileSource) {
+            // try to autodetect the file type, ignore errors
+            const name = self.fileName;
+            if (name) {
+                const match = fileTypesRegexp.exec(name);
+                if (match && match[1]) {
+                    self.fileType =
+                        match[1] === 'tsv' && name.includes('star-fusion')
+                            ? 'STAR-Fusion'
+                            : match[1].toUpperCase();
+                }
+            }
+        }
+    },
+    toggleHasColumnNameLine() {
+        self.hasColumnNameLine = !self.hasColumnNameLine;
+    },
+    setColumnNameLineNumber(newnumber) {
+        if (newnumber > 0) {
+            self.columnNameLineNumber = newnumber;
+        }
+    },
+    setFileType(typeName) {
+        self.fileType = typeName;
+    },
+    setError(error) {
+        console.error(error);
+        self.loading = false;
+        self.error = error;
+    },
+    setLoaded() {
+        self.loading = false;
+        self.error = undefined;
+    },
+    cancelButton() {
+        self.error = undefined;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        getParent(self).setDisplayMode();
+    },
+    // fetch and parse the file, make a new Spreadsheet model for it,
+    // then set the parent to display it
+    async import(assemblyName) {
+        if (!self.fileSource) {
+            return;
+        }
+        if (self.loading) {
+            throw new Error('Cannot import, load already in progress');
+        }
+        self.selectedAssemblyName = assemblyName;
+        self.loading = true;
+        const type = self.fileType;
+        const typeParser = await fileTypeParsers[type]();
+        if (!typeParser) {
+            throw new Error(`cannot open files of type '${self.fileType}'`);
+        }
+        const { unzip } = await import('@gmod/bgzf-filehandle');
+        const { pluginManager } = getEnv(self);
+        const filehandle = openLocation(self.fileSource, pluginManager);
+        try {
+            const stat = await filehandle.stat();
+            if (stat.size > IMPORT_SIZE_LIMIT) {
+                throw new Error(`File is too big. Tabular files are limited to at most ${(IMPORT_SIZE_LIMIT / 1000).toLocaleString()}kb.`);
+            }
+        }
+        catch (e) {
+            // not required for stat to succeed to proceed, but it is helpful
+            console.warn(e);
+        }
+        try {
+            await filehandle
+                .readFile()
+                .then(buffer => (self.requiresUnzip ? unzip(buffer) : buffer))
+                .then(buffer => typeParser(buffer, self))
+                .then(spreadsheet => {
+                this.setLoaded();
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                getParent(self).displaySpreadsheet(spreadsheet);
+            });
+        }
+        catch (e) {
+            this.setError(e);
+        }
+    },
+}));
+export default ImportWizard;
+//# sourceMappingURL=ImportWizard.js.map

package/esm/SpreadsheetView/models/ImportWizard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImportWizard.js","sourceRoot":"","sources":["../../../src/SpreadsheetView/models/ImportWizard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAY,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO;AACP,MAAM,iBAAiB,GAAG,QAAU,CAAA;AAEpC,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAC,CAAA;AACtE,MAAM,eAAe,GAAG;IACtB,GAAG,EAAE,GAAG,EAAE,CACR,MAAM,CAAC,+BAA+B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;IACrE,GAAG,EAAE,GAAG,EAAE,CACR,MAAM,CAAC,+BAA+B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;IACrE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;IAC5E,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC;IAC5E,KAAK,EAAE,GAAG,EAAE,CACV,MAAM,CAAC,6BAA6B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC;IACrE,aAAa,EAAE,GAAG,EAAE,CAClB,MAAM,CAAC,oCAAoC,CAAC,CAAC,IAAI,CAC/C,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAC7B;CACJ,CAAA;AACD,yEAAyE;AACzE,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC,OAAO,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;AAE/E;;;GAGG;AACH,SAAS,CAAC,KAAI,CAAC,CAAC,wDAAwD;AAExE,MAAM,YAAY,GAAG,KAAK;KACvB,KAAK,CAAC,yBAAyB,EAAE;IAChC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC;IAC7D;;OAEG;IACH,iBAAiB,EAAE,IAAI;IACvB;;OAEG;IACH,oBAAoB,EAAE,CAAC;IACvB;;OAEG;IACH,oBAAoB,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;CAChD,CAAC;KACD,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;IACf,SAAS;IACT,8DAA8D;IAC9D,UAAU,EAAE,SAAgB;IAC5B,KAAK,EAAE,SAAoB;IAC3B,OAAO,EAAE,KAAK;CACf,CAAC,CAAC;KACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,IAAI,aAAa;QACf,OAAO,CACL,CAAC,IAAI,CAAC,KAAK;YACX,IAAI,CAAC,UAAU;YACf,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM;gBACrB,IAAI,CAAC,UAAU,CAAC,SAAS;gBACzB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CACvB,CAAA;IACH,CAAC;IACD,IAAI,SAAS;QACX,8DAA8D;QAC9D,OAAO,SAAS,CAAM,IAAI,CAAC,CAAC,cAAc,CAAA;IAC5C,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,GAAG;YACnB,IAAI,CAAC,UAAU,CAAC,SAAS;YACzB,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CACjD,CAAA;IACH,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,cAAc,CAAC,OAAe,EAAE,YAAqB;QACnD,MAAM,EAAE,eAAe,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;QAC5C,IAAI,CAAC,YAAY,EAAE;YACjB,OAAO,KAAK,CAAA;SACb;QACD,OAAO,eAAe,CAAC,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;IAC9D,CAAC;CACF,CAAC,CAAC;KACF,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,uBAAuB,CAAC,CAAS;QAC/B,IAAI,CAAC,oBAAoB,GAAG,CAAC,CAAA;IAC/B,CAAC;IACD,aAAa,CAAC,SAAkB;QAC9B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;QAC3B,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;QAEtB,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,iDAAiD;YACjD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAA;YAE1B,IAAI,IAAI,EAAE;gBACR,MAAM,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACxC,IAAI,KAAK,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;oBACrB,IAAI,CAAC,QAAQ;wBACX,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;4BAChD,CAAC,CAAC,aAAa;4BACf,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;iBAC7B;aACF;SACF;IACH,CAAC;IAED,uBAAuB;QACrB,IAAI,CAAC,iBAAiB,GAAG,CAAC,IAAI,CAAC,iBAAiB,CAAA;IAClD,CAAC;IAED,uBAAuB,CAAC,SAAiB;QACvC,IAAI,SAAS,GAAG,CAAC,EAAE;YACjB,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAA;SACtC;IACH,CAAC;IAED,WAAW,CAAC,QAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;IAED,QAAQ,CAAC,KAAc;QACrB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACpB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;IACpB,CAAC;IAED,SAAS;QACP,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;IACxB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,KAAK,GAAG,SAAS,CAAA;QACtB,8DAA8D;QAC9D,SAAS,CAAM,IAAI,CAAC,CAAC,cAAc,EAAE,CAAA;IACvC,CAAC;IAED,iEAAiE;IACjE,oCAAoC;IACpC,KAAK,CAAC,MAAM,CAAC,YAAoB;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAM;SACP;QAED,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;SAC3D;QAED,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAA;QACxC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,QAAwC,CAAA;QAC1D,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,EAAE,CAAA;QAChD,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;SAChE;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAA;QACvD,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QACtC,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAA;QAC/D,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,CAAA;YACpC,IAAI,IAAI,CAAC,IAAI,GAAG,iBAAiB,EAAE;gBACjC,MAAM,IAAI,KAAK,CACb,yDAAyD,CACvD,iBAAiB,GAAG,IAAI,CACzB,CAAC,cAAc,EAAE,KAAK,CACxB,CAAA;aACF;SACF;QAAC,OAAO,CAAC,EAAE;YACV,iEAAiE;YACjE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SAChB;QAED,IAAI;YACF,MAAM,UAAU;iBACb,QAAQ,EAAE;iBACV,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;iBAC7D,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;iBACxC,IAAI,CAAC,WAAW,CAAC,EAAE;gBAClB,IAAI,CAAC,SAAS,EAAE,CAAA;gBAChB,8DAA8D;gBAC9D,SAAS,CAAM,IAAI,CAAC,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;YACtD,CAAC,CAAC,CAAA;SACL;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;SACjB;IACH,CAAC;CACF,CAAC,CAAC,CAAA;AAKL,eAAe,YAAY,CAAA"}

package/esm/SpreadsheetView/models/Row.d.ts

@@ -0,0 +1,17 @@
+declare const RowModel: import("mobx-state-tree").IModelType<{
+    id: import("mobx-state-tree").ISimpleType<string>;
+    cells: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        text: import("mobx-state-tree").ISimpleType<string>;
+        extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+    }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+    isSelected: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+}, {
+    toggleSelect(): void;
+    unSelect(): void;
+    select(): void;
+    setExtendedData(data: unknown): void;
+} & {
+    readonly cellsWithDerived: any;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export default RowModel;

package/esm/SpreadsheetView/models/Row.js

@@ -0,0 +1,44 @@
+import { types, getParent } from 'mobx-state-tree';
+const CellModel = types.model('SpreadsheetCell', {
+    text: types.string,
+    extendedData: types.maybe(types.frozen()),
+});
+const RowModel = types
+    .model('SpreadsheetRow', {
+    id: types.identifier,
+    cells: types.array(CellModel),
+    extendedData: types.maybe(types.frozen()),
+    isSelected: false,
+})
+    .actions(self => ({
+    toggleSelect() {
+        self.isSelected = !self.isSelected;
+    },
+    unSelect() {
+        self.isSelected = false;
+    },
+    select() {
+        self.isSelected = true;
+    },
+    setExtendedData(data) {
+        self.extendedData = data;
+    },
+}))
+    .views(self => ({
+    get cellsWithDerived() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const { columns } = getParent(self, 3);
+        let i = 0;
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return columns.map((column) => {
+            if (column.isDerived) {
+                return column.expr.evalSync({
+                    row: self,
+                });
+            }
+            return self.cells[i++];
+        });
+    },
+}));
+export default RowModel;
+//# sourceMappingURL=Row.js.map

package/esm/SpreadsheetView/models/Row.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Row.js","sourceRoot":"","sources":["../../../src/SpreadsheetView/models/Row.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAElD,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,iBAAiB,EAAE;IAC/C,IAAI,EAAE,KAAK,CAAC,MAAM;IAClB,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;CAC1C,CAAC,CAAA;AAEF,MAAM,QAAQ,GAAG,KAAK;KACnB,KAAK,CAAC,gBAAgB,EAAE;IACvB,EAAE,EAAE,KAAK,CAAC,UAAU;IACpB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;IAC7B,YAAY,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACzC,UAAU,EAAE,KAAK;CAClB,CAAC;KACD,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,YAAY;QACV,IAAI,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,UAAU,CAAA;IACpC,CAAC;IACD,QAAQ;QACN,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;IACzB,CAAC;IACD,MAAM;QACJ,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;IACxB,CAAC;IACD,eAAe,CAAC,IAAa;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;IAC1B,CAAC;CACF,CAAC,CAAC;KACF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,IAAI,gBAAgB;QAClB,8DAA8D;QAC9D,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAM,IAAI,EAAE,CAAC,CAAC,CAAA;QAC3C,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,8DAA8D;QAC9D,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAyC,EAAE,EAAE;YAC/D,IAAI,MAAM,CAAC,SAAS,EAAE;gBACpB,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;oBAC1B,GAAG,EAAE,IAAI;iBACV,CAAC,CAAA;aACH;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;IACJ,CAAC;CACF,CAAC,CAAC,CAAA;AAEL,eAAe,QAAQ,CAAA"}

package/esm/SpreadsheetView/models/Spreadsheet.d.ts

@@ -0,0 +1,256 @@
+/// <reference types="react" />
+import { SnapshotIn, Instance } from 'mobx-state-tree';
+import RowModel from './Row';
+type Row = Instance<typeof RowModel>;
+type RowMenuPosition = {
+    anchorEl: Element;
+    rowNumber: string;
+} | null;
+declare const Spreadsheet: import("mobx-state-tree").IModelType<{
+    rowSet: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IModelType<{
+        isLoaded: import("mobx-state-tree").ISimpleType<true>;
+        rows: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").ISimpleType<string>;
+            cells: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+            extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            isSelected: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        }, {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    }, {
+        readonly count: number;
+        readonly passingFiltersCount: number;
+        readonly selectedCount: number;
+        readonly selectedAndPassingFiltersCount: number;
+        readonly sortedRows: ({
+            id: string;
+            cells: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>>;
+            extendedData: any;
+            isSelected: boolean;
+        } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").ISimpleType<string>;
+            cells: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+            extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            isSelected: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        }, {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>)[];
+        readonly selectedRows: ({
+            id: string;
+            cells: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>>;
+            extendedData: any;
+            isSelected: boolean;
+        } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").ISimpleType<string>;
+            cells: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+            extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            isSelected: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        }, {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>)[];
+        readonly selectedFilteredRows: ({
+            id: string;
+            cells: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>>;
+            extendedData: any;
+            isSelected: boolean;
+        } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").ISimpleType<string>;
+            cells: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+            extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            isSelected: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        }, {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>)[];
+        readonly sortedFilteredRows: ({
+            id: string;
+            cells: import("mobx-state-tree").IMSTArray<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>> & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>>;
+            extendedData: any;
+            isSelected: boolean;
+        } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        } & import("mobx-state-tree").IStateTreeNode<import("mobx-state-tree").IModelType<{
+            id: import("mobx-state-tree").ISimpleType<string>;
+            cells: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+                text: import("mobx-state-tree").ISimpleType<string>;
+                extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            }, {}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+            extendedData: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IType<any, any, any>>;
+            isSelected: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        }, {
+            toggleSelect(): void;
+            unSelect(): void;
+            select(): void;
+            setExtendedData(data: unknown): void;
+        } & {
+            readonly cellsWithDerived: any;
+        }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>)[]; /**
+         * #property
+         */
+    } & {
+        unselectAll(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>, [undefined]>;
+    columns: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        name: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+        dataType: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IAnyType, [undefined]>;
+        isDerived: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+        derivationFunctionText: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+    }, {
+        readonly expr: any;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    columnDisplayOrder: import("mobx-state-tree").IArrayType<import("mobx-state-tree").ISimpleType<number>>;
+    hasColumnNames: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    sortColumns: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
+        columnNumber: import("mobx-state-tree").ISimpleType<number>;
+        descending: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    }, {
+        switchDirection(): void;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>;
+    assemblyName: import("mobx-state-tree").IMaybe<import("mobx-state-tree").ISimpleType<string>>;
+}, {
+    defaultDataType: import("mobx-state-tree").IModelType<{
+        type: import("mobx-state-tree").ISimpleType<string>;
+    }, {
+        DataCellReactComponent: import("react").FC<any> | null;
+        FilterModelType: any;
+        displayName: string;
+        categoryName: string | undefined;
+    } & {
+        compare: any;
+        readonly hasFilter: boolean;
+    }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+    rowMenuPosition: RowMenuPosition;
+    isLoaded: boolean;
+} & {
+    /**
+     * #getter
+     */
+    readonly initialized: boolean | undefined;
+    /**
+     * #getter
+     */
+    readonly hideRowSelection: any;
+    /**
+     * #getter
+     * list of data type names to be made available in the column
+     * dropdown menu
+     */
+    readonly dataTypeChoices: {
+        typeName: "LocString" | "Text" | "LocRef" | "Number" | "LocStart" | "LocEnd";
+        displayName: string;
+        categoryName: string | undefined;
+    }[];
+    /**
+     * #method
+     */
+    rowSortingComparisonFunction(rowA: Row, rowB: Row): any;
+} & {
+    afterAttach(): void;
+    /**
+     * #action
+     */
+    setLoaded(flag: boolean): void;
+    /**
+     * #action
+     */
+    setRowMenuPosition(newPosition: RowMenuPosition): void;
+    /**
+     * #action
+     */
+    setSortColumns(newSort: readonly import("mobx-state-tree").ModelCreationType<import("mobx-state-tree/dist/internal").ExtractCFromProps<{
+        columnNumber: import("mobx-state-tree").ISimpleType<number>;
+        descending: import("mobx-state-tree").IType<boolean | undefined, boolean, boolean>;
+    }>>[]): void;
+    /**
+     * #action
+     */
+    setColumnType(columnNumber: number, newTypeName: string): void;
+    /**
+     * #action
+     */
+    unselectAll(): void;
+}, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
+export type SpreadsheetStateModel = typeof Spreadsheet;
+export type SpreadsheetModel = Instance<SpreadsheetStateModel>;
+export default Spreadsheet;

package/esm/SpreadsheetView/models/Spreadsheet.js

@@ -0,0 +1,171 @@
+import { stringToJexlExpression } from '@jbrowse/core/util/jexlStrings';
+import { getSession, getEnv } from '@jbrowse/core/util';
+import { autorun } from 'mobx';
+import { addDisposer, types, getParent, } from 'mobx-state-tree';
+// locals
+import { ColumnTypes, AnyColumnType } from './ColumnDataTypes';
+import StaticRowSetModel from './StaticRowSet';
+const ColumnDefinition = types
+    .model('ColumnDefinition', {
+    name: types.maybe(types.string),
+    dataType: types.optional(AnyColumnType, () => ({
+        type: 'Text',
+    })),
+    // set to true if column is derived from other columns
+    // if the column is derived, each cell will have a
+    // `derivationFunction` that is called to get its value
+    isDerived: false,
+    // if this cell is derived from other cells, execute this function to get
+    // the value
+    derivationFunctionText: types.maybe(types.string),
+})
+    .views(self => ({
+    get expr() {
+        if (self.isDerived) {
+            // compile this as a jexl expression
+            return stringToJexlExpression(String(self.derivationFunctionText), getEnv(self).pluginManager.jexl);
+        }
+        return undefined;
+    },
+}));
+/**
+ * #stateModel SpreadsheetViewSpreadsheet
+ * #category view
+ */
+function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
+const Spreadsheet = types
+    .model('Spreadsheet', {
+    /**
+     * #property
+     */
+    rowSet: types.optional(StaticRowSetModel, () => StaticRowSetModel.create()),
+    /**
+     * #property
+     */
+    columns: types.array(ColumnDefinition),
+    /**
+     * #property
+     */
+    columnDisplayOrder: types.array(types.number),
+    /**
+     * #property
+     */
+    hasColumnNames: false,
+    /**
+     * #property
+     */
+    sortColumns: types.array(types
+        .model('SortColumns', {
+        columnNumber: types.number,
+        descending: false,
+    })
+        .actions(self => ({
+        switchDirection() {
+            self.descending = !self.descending;
+        },
+    }))),
+    assemblyName: types.maybe(types.string),
+})
+    .volatile(() => ({
+    defaultDataType: ColumnTypes.Text,
+    rowMenuPosition: null,
+    isLoaded: false,
+}))
+    .views(self => ({
+    /**
+     * #getter
+     */
+    get initialized() {
+        var _a;
+        const session = getSession(self);
+        const name = self.assemblyName;
+        return name ? (_a = session.assemblyManager.get(name)) === null || _a === void 0 ? void 0 : _a.initialized : false;
+    },
+    /**
+     * #getter
+     */
+    get hideRowSelection() {
+        // just delegates to parent
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        return getParent(self).hideRowSelection;
+    },
+    /**
+     * #getter
+     * list of data type names to be made available in the column
+     * dropdown menu
+     */
+    get dataTypeChoices() {
+        const typeNames = Object.keys(ColumnTypes);
+        return typeNames.map(typeName => {
+            const dataType = ColumnTypes[typeName].create({ type: typeName });
+            const { displayName, categoryName } = dataType;
+            return { typeName, displayName, categoryName };
+        });
+    },
+    /**
+     * #method
+     */
+    rowSortingComparisonFunction(rowA, rowB) {
+        for (let i = 0; i < self.sortColumns.length; i += 1) {
+            const { columnNumber, descending } = self.sortColumns[i];
+            const { dataType } = self.columns[columnNumber];
+            const result = dataType.compare(rowA.cellsWithDerived[columnNumber], rowB.cellsWithDerived[columnNumber]);
+            if (result) {
+                return descending ? -result : result;
+            }
+        }
+        return 0;
+    },
+}))
+    .actions(self => ({
+    afterAttach() {
+        addDisposer(self, autorun(async () => {
+            const session = getSession(self);
+            const { assemblyManager } = session;
+            try {
+                if (self.assemblyName) {
+                    await assemblyManager.waitForAssembly(self.assemblyName);
+                    this.setLoaded(true);
+                }
+            }
+            catch (error) {
+                session.notify(`failed to load assembly ${self.assemblyName} ${error}`, 'error');
+            }
+        }));
+    },
+    /**
+     * #action
+     */
+    setLoaded(flag) {
+        self.isLoaded = flag;
+    },
+    /**
+     * #action
+     */
+    setRowMenuPosition(newPosition) {
+        self.rowMenuPosition = newPosition;
+    },
+    /**
+     * #action
+     */
+    setSortColumns(newSort) {
+        if (newSort) {
+            // @ts-expect-error
+            self.sortColumns = newSort;
+        }
+    },
+    /**
+     * #action
+     */
+    setColumnType(columnNumber, newTypeName) {
+        self.columns[columnNumber].dataType = { type: newTypeName };
+    },
+    /**
+     * #action
+     */
+    unselectAll() {
+        return self.rowSet.unselectAll();
+    },
+}));
+export default Spreadsheet;
+//# sourceMappingURL=Spreadsheet.js.map