@gmod/tabix 1.5.0 → 1.5.3

package/esm/csi.js

@@ -0,0 +1,230 @@
+import Long from 'long';
+import { unzip } from '@gmod/bgzf-filehandle';
+import VirtualOffset, { fromBytes } from './virtualOffset';
+import Chunk from './chunk';
+import { longToNumber, optimizeChunks } from './util';
+import IndexFile from './indexFile';
+const CSI1_MAGIC = 21582659; // CSI\1
+const CSI2_MAGIC = 38359875; // CSI\2
+function lshift(num, bits) {
+    return num * 2 ** bits;
+}
+function rshift(num, bits) {
+    return Math.floor(num / 2 ** bits);
+}
+export default class CSI extends IndexFile {
+    constructor(args) {
+        super(args);
+        this.maxBinNumber = 0;
+        this.depth = 0;
+        this.minShift = 0;
+    }
+    async lineCount(refName, opts = {}) {
+        const indexData = await this.parse(opts);
+        if (!indexData) {
+            return -1;
+        }
+        const refId = indexData.refNameToId[refName];
+        const idx = indexData.indices[refId];
+        if (!idx) {
+            return -1;
+        }
+        const { stats } = indexData.indices[refId];
+        if (stats) {
+            return stats.lineCount;
+        }
+        return -1;
+    }
+    async indexCov() {
+        throw new Error('CSI indexes do not support indexcov');
+        return [];
+    }
+    parseAuxData(bytes, offset, auxLength) {
+        if (auxLength < 30) {
+            return {
+                refIdToName: [],
+                refNameToId: {},
+            };
+        }
+        const formatFlags = bytes.readInt32LE(offset);
+        const coordinateType = formatFlags & 0x10000 ? 'zero-based-half-open' : '1-based-closed';
+        const format = { 0: 'generic', 1: 'SAM', 2: 'VCF' }[formatFlags & 0xf];
+        if (!format) {
+            throw new Error(`invalid Tabix preset format flags ${formatFlags}`);
+        }
+        const columnNumbers = {
+            ref: bytes.readInt32LE(offset + 4),
+            start: bytes.readInt32LE(offset + 8),
+            end: bytes.readInt32LE(offset + 12),
+        };
+        const metaValue = bytes.readInt32LE(offset + 16);
+        const metaChar = metaValue ? String.fromCharCode(metaValue) : '';
+        const skipLines = bytes.readInt32LE(offset + 20);
+        const nameSectionLength = bytes.readInt32LE(offset + 24);
+        const { refIdToName, refNameToId } = this._parseNameBytes(bytes.slice(offset + 28, offset + 28 + nameSectionLength));
+        return {
+            refIdToName,
+            refNameToId,
+            skipLines,
+            metaChar,
+            columnNumbers,
+            format,
+            coordinateType,
+        };
+    }
+    _parseNameBytes(namesBytes) {
+        let currRefId = 0;
+        let currNameStart = 0;
+        const refIdToName = [];
+        const refNameToId = {};
+        for (let i = 0; i < namesBytes.length; i += 1) {
+            if (!namesBytes[i]) {
+                if (currNameStart < i) {
+                    let refName = namesBytes.toString('utf8', currNameStart, i);
+                    refName = this.renameRefSeq(refName);
+                    refIdToName[currRefId] = refName;
+                    refNameToId[refName] = currRefId;
+                }
+                currNameStart = i + 1;
+                currRefId += 1;
+            }
+        }
+        return { refNameToId, refIdToName };
+    }
+    // fetch and parse the index
+    async _parse(opts = {}) {
+        const bytes = await unzip((await this.filehandle.readFile(opts)));
+        // check TBI magic numbers
+        let csiVersion;
+        if (bytes.readUInt32LE(0) === CSI1_MAGIC) {
+            csiVersion = 1;
+        }
+        else if (bytes.readUInt32LE(0) === CSI2_MAGIC) {
+            csiVersion = 2;
+        }
+        else {
+            throw new Error('Not a CSI file');
+            // TODO: do we need to support big-endian CSI files?
+        }
+        this.minShift = bytes.readInt32LE(4);
+        this.depth = bytes.readInt32LE(8);
+        this.maxBinNumber = ((1 << ((this.depth + 1) * 3)) - 1) / 7;
+        const maxRefLength = 2 ** (this.minShift + this.depth * 3);
+        const auxLength = bytes.readInt32LE(12);
+        let aux = {
+            refIdToName: [],
+            refNameToId: {},
+        };
+        if (auxLength) {
+            aux = this.parseAuxData(bytes, 16, auxLength);
+        }
+        const refCount = bytes.readInt32LE(16 + auxLength);
+        // read the indexes for each reference sequence
+        let firstDataLine;
+        let currOffset = 16 + auxLength + 4;
+        const indices = new Array(refCount).fill(0).map(() => {
+            // the binning index
+            const binCount = bytes.readInt32LE(currOffset);
+            currOffset += 4;
+            const binIndex = {};
+            let stats; // < provided by parsing a pseudo-bin, if present
+            for (let j = 0; j < binCount; j += 1) {
+                const bin = bytes.readUInt32LE(currOffset);
+                if (bin > this.maxBinNumber) {
+                    // this is a fake bin that actually has stats information
+                    // about the reference sequence in it
+                    stats = this.parsePseudoBin(bytes, currOffset + 4);
+                    currOffset += 4 + 8 + 4 + 16 + 16;
+                }
+                else {
+                    const loffset = fromBytes(bytes, currOffset + 4);
+                    firstDataLine = this._findFirstData(firstDataLine, loffset);
+                    const chunkCount = bytes.readInt32LE(currOffset + 12);
+                    currOffset += 16;
+                    const chunks = new Array(chunkCount);
+                    for (let k = 0; k < chunkCount; k += 1) {
+                        const u = fromBytes(bytes, currOffset);
+                        const v = fromBytes(bytes, currOffset + 8);
+                        currOffset += 16;
+                        // this._findFirstData(data, u)
+                        chunks[k] = new Chunk(u, v, bin);
+                    }
+                    binIndex[bin] = chunks;
+                }
+            }
+            return { binIndex, stats };
+        });
+        return {
+            ...aux,
+            csi: true,
+            refCount,
+            maxBlockSize: 1 << 16,
+            firstDataLine,
+            csiVersion,
+            indices,
+            depth: this.depth,
+            maxBinNumber: this.maxBinNumber,
+            maxRefLength,
+        };
+    }
+    parsePseudoBin(bytes, offset) {
+        const lineCount = longToNumber(Long.fromBytesLE(Array.prototype.slice.call(bytes, offset + 28, offset + 36), true));
+        return { lineCount };
+    }
+    async blocksForRange(refName, min, max, opts = {}) {
+        if (min < 0) {
+            min = 0;
+        }
+        const indexData = await this.parse(opts);
+        if (!indexData) {
+            return [];
+        }
+        const refId = indexData.refNameToId[refName];
+        const ba = indexData.indices[refId];
+        if (!ba) {
+            return [];
+        }
+        // const { linearIndex, binIndex } = indexes
+        const overlappingBins = this.reg2bins(min, max); // List of bin #s that overlap min, max
+        const chunks = [];
+        // Find chunks in overlapping bins.  Leaf bins (< 4681) are not pruned
+        for (const [start, end] of overlappingBins) {
+            for (let bin = start; bin <= end; bin++) {
+                if (ba.binIndex[bin]) {
+                    const binChunks = ba.binIndex[bin];
+                    for (let c = 0; c < binChunks.length; ++c) {
+                        chunks.push(new Chunk(binChunks[c].minv, binChunks[c].maxv, bin));
+                    }
+                }
+            }
+        }
+        return optimizeChunks(chunks, new VirtualOffset(0, 0));
+    }
+    /**
+     * calculate the list of bins that may overlap with region [beg,end) (zero-based half-open)
+     */
+    reg2bins(beg, end) {
+        beg -= 1; // < convert to 1-based closed
+        if (beg < 1) {
+            beg = 1;
+        }
+        if (end > 2 ** 50) {
+            end = 2 ** 34;
+        } // 17 GiB ought to be enough for anybody
+        end -= 1;
+        let l = 0;
+        let t = 0;
+        let s = this.minShift + this.depth * 3;
+        const bins = [];
+        for (; l <= this.depth; s -= 3, t += lshift(1, l * 3), l += 1) {
+            const b = t + rshift(beg, s);
+            const e = t + rshift(end, s);
+            if (e - b + bins.length > this.maxBinNumber) {
+                throw new Error(`query ${beg}-${end} is too large for current binning scheme (shift ${this.minShift}, depth ${this.depth}), try a smaller query or a coarser index binning scheme`);
+            }
+            bins.push([b, e]);
+        }
+        return bins;
+    }
+}
+//# sourceMappingURL=csi.js.map

package/esm/csi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csi.js","sourceRoot":"","sources":["../src/csi.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAA;AACvB,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAA;AAE7C,OAAO,aAAa,EAAE,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAErD,OAAO,SAAsB,MAAM,aAAa,CAAA;AAEhD,MAAM,UAAU,GAAG,QAAQ,CAAA,CAAC,QAAQ;AACpC,MAAM,UAAU,GAAG,QAAQ,CAAA,CAAC,QAAQ;AAEpC,SAAS,MAAM,CAAC,GAAW,EAAE,IAAY;IACvC,OAAO,GAAG,GAAG,CAAC,IAAI,IAAI,CAAA;AACxB,CAAC;AACD,SAAS,MAAM,CAAC,GAAW,EAAE,IAAY;IACvC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,CAAA;AACpC,CAAC;AAED,MAAM,CAAC,OAAO,OAAO,GAAI,SAAQ,SAAS;IAIxC,YAAY,IAAS;QACnB,KAAK,CAAC,IAAI,CAAC,CAAA;QACX,IAAI,CAAC,YAAY,GAAG,CAAC,CAAA;QACrB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAA;QACd,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;IACnB,CAAC;IACD,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,OAAgB,EAAE;QACjD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,CAAC,CAAC,CAAA;SACV;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC5C,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,CAAC,CAAC,CAAA;SACV;QACD,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC1C,IAAI,KAAK,EAAE;YACT,OAAO,KAAK,CAAC,SAAS,CAAA;SACvB;QACD,OAAO,CAAC,CAAC,CAAA;IACX,CAAC;IACD,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACtD,OAAO,EAAE,CAAA;IACX,CAAC;IAED,YAAY,CAAC,KAAa,EAAE,MAAc,EAAE,SAAiB;QAC3D,IAAI,SAAS,GAAG,EAAE,EAAE;YAClB,OAAO;gBACL,WAAW,EAAE,EAAE;gBACf,WAAW,EAAE,EAAE;aAChB,CAAA;SACF;QAED,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC7C,MAAM,cAAc,GAClB,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,gBAAgB,CAAA;QACnE,MAAM,MAAM,GACV,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAGnC,CAAC,WAAW,GAAG,GAAG,CAAC,CAAA;QACpB,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,qCAAqC,WAAW,EAAE,CAAC,CAAA;SACpE;QACD,MAAM,aAAa,GAAG;YACpB,GAAG,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YAClC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;YACpC,GAAG,EAAE,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,EAAE,CAAC;SACpC,CAAA;QACD,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;QAChD,MAAM,QAAQ,GAAG,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QAChE,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;QAChD,MAAM,iBAAiB,GAAG,KAAK,CAAC,WAAW,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;QAExD,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,eAAe,CACvD,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,GAAG,iBAAiB,CAAC,CAC1D,CAAA;QAED,OAAO;YACL,WAAW;YACX,WAAW;YACX,SAAS;YACT,QAAQ;YACR,aAAa;YACb,MAAM;YACN,cAAc;SACf,CAAA;IACH,CAAC;IAED,eAAe,CAAC,UAAkB;QAChC,IAAI,SAAS,GAAG,CAAC,CAAA;QACjB,IAAI,aAAa,GAAG,CAAC,CAAA;QACrB,MAAM,WAAW,GAAG,EAAE,CAAA;QACtB,MAAM,WAAW,GAA8B,EAAE,CAAA;QACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;YAC7C,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;gBAClB,IAAI,aAAa,GAAG,CAAC,EAAE;oBACrB,IAAI,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAA;oBAC3D,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;oBACpC,WAAW,CAAC,SAAS,CAAC,GAAG,OAAO,CAAA;oBAChC,WAAW,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;iBACjC;gBACD,aAAa,GAAG,CAAC,GAAG,CAAC,CAAA;gBACrB,SAAS,IAAI,CAAC,CAAA;aACf;SACF;QACD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;IACrC,CAAC;IAED,4BAA4B;IAE5B,KAAK,CAAC,MAAM,CAAC,OAAgB,EAAE;QAC7B,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAW,CAAC,CAAA;QAE3E,0BAA0B;QAC1B,IAAI,UAAU,CAAA;QACd,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;YACxC,UAAU,GAAG,CAAC,CAAA;SACf;aAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;YAC/C,UAAU,GAAG,CAAC,CAAA;SACf;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;YACjC,oDAAoD;SACrD;QAED,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QACjC,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;QAC3D,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAA;QAE1D,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;QACvC,IAAI,GAAG,GAGH;YACF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,EAAE;SAChB,CAAA;QACD,IAAI,SAAS,EAAE;YACb,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,EAAE,SAAS,CAAC,CAAA;SAC9C;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,EAAE,GAAG,SAAS,CAAC,CAAA;QAElD,+CAA+C;QAC/C,IAAI,aAAwC,CAAA;QAC5C,IAAI,UAAU,GAAG,EAAE,GAAG,SAAS,GAAG,CAAC,CAAA;QACnC,MAAM,OAAO,GAAG,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE;YACnD,oBAAoB;YACpB,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA;YAC9C,UAAU,IAAI,CAAC,CAAA;YACf,MAAM,QAAQ,GAA+B,EAAE,CAAA;YAC/C,IAAI,KAAK,CAAA,CAAC,iDAAiD;YAC3D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE;gBACpC,MAAM,GAAG,GAAG,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;gBAC1C,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,EAAE;oBAC3B,yDAAyD;oBACzD,qCAAqC;oBACrC,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC,CAAA;oBAClD,UAAU,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,CAAA;iBAClC;qBAAM;oBACL,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC,CAAA;oBAChD,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;oBAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,WAAW,CAAC,UAAU,GAAG,EAAE,CAAC,CAAA;oBACrD,UAAU,IAAI,EAAE,CAAA;oBAChB,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,UAAU,CAAC,CAAA;oBACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE;wBACtC,MAAM,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;wBACtC,MAAM,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,CAAC,CAAC,CAAA;wBAC1C,UAAU,IAAI,EAAE,CAAA;wBAChB,+BAA+B;wBAC/B,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA;qBACjC;oBACD,QAAQ,CAAC,GAAG,CAAC,GAAG,MAAM,CAAA;iBACvB;aACF;YAED,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,OAAO;YACL,GAAG,GAAG;YACN,GAAG,EAAE,IAAI;YACT,QAAQ;YACR,YAAY,EAAE,CAAC,IAAI,EAAE;YACrB,aAAa;YACb,UAAU;YACV,OAAO;YACP,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY;SACb,CAAA;IACH,CAAC;IAED,cAAc,CAAC,KAAa,EAAE,MAAc;QAC1C,MAAM,SAAS,GAAG,YAAY,CAC5B,IAAI,CAAC,WAAW,CACd,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,MAAM,GAAG,EAAE,CAAC,EAC3D,IAAI,CACL,CACF,CAAA;QACD,OAAO,EAAE,SAAS,EAAE,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,OAAe,EACf,GAAW,EACX,GAAW,EACX,OAAgB,EAAE;QAElB,IAAI,GAAG,GAAG,CAAC,EAAE;YACX,GAAG,GAAG,CAAC,CAAA;SACR;QAED,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACxC,IAAI,CAAC,SAAS,EAAE;YACd,OAAO,EAAE,CAAA;SACV;QACD,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC5C,MAAM,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnC,IAAI,CAAC,EAAE,EAAE;YACP,OAAO,EAAE,CAAA;SACV;QAED,4CAA4C;QAE5C,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA,CAAC,uCAAuC;QACvF,MAAM,MAAM,GAAY,EAAE,CAAA;QAE1B,sEAAsE;QACtE,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,eAAe,EAAE;YAC1C,KAAK,IAAI,GAAG,GAAG,KAAK,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,EAAE;gBACvC,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBACpB,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;oBAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;wBACzC,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAA;qBAClE;iBACF;aACF;SACF;QAED,OAAO,cAAc,CAAC,MAAM,EAAE,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACxD,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,GAAW,EAAE,GAAW;QAC/B,GAAG,IAAI,CAAC,CAAA,CAAC,8BAA8B;QACvC,IAAI,GAAG,GAAG,CAAC,EAAE;YACX,GAAG,GAAG,CAAC,CAAA;SACR;QACD,IAAI,GAAG,GAAG,CAAC,IAAI,EAAE,EAAE;YACjB,GAAG,GAAG,CAAC,IAAI,EAAE,CAAA;SACd,CAAC,wCAAwC;QAC1C,GAAG,IAAI,CAAC,CAAA;QACR,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,IAAI,CAAC,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAA;QACtC,MAAM,IAAI,GAAG,EAAE,CAAA;QACf,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;YAC7D,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;YAC5B,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,YAAY,EAAE;gBAC3C,MAAM,IAAI,KAAK,CACb,SAAS,GAAG,IAAI,GAAG,mDAAmD,IAAI,CAAC,QAAQ,WAAW,IAAI,CAAC,KAAK,0DAA0D,CACnK,CAAA;aACF;YACD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;SAClB;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF"}

package/esm/index.d.ts

@@ -0,0 +1,4 @@
+import TabixIndexedFile from './tabixIndexedFile';
+import TBI from './tbi';
+import CSI from './csi';
+export { TabixIndexedFile, TBI, CSI };

package/esm/index.js

@@ -0,0 +1,5 @@
+import TabixIndexedFile from './tabixIndexedFile';
+import TBI from './tbi';
+import CSI from './csi';
+export { TabixIndexedFile, TBI, CSI };
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,gBAAgB,MAAM,oBAAoB,CAAA;AACjD,OAAO,GAAG,MAAM,OAAO,CAAA;AACvB,OAAO,GAAG,MAAM,OAAO,CAAA;AAEvB,OAAO,EAAE,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAA"}

package/esm/indexFile.d.ts

@@ -0,0 +1,32 @@
+import { GenericFilehandle } from 'generic-filehandle';
+import VirtualOffset from './virtualOffset';
+import Chunk from './chunk';
+export interface Options {
+    [key: string]: unknown;
+    signal?: AbortSignal;
+}
+export default abstract class IndexFile {
+    filehandle: GenericFilehandle;
+    renameRefSeq: (arg0: string) => string;
+    private _parseCache;
+    /**
+     * @param {filehandle} filehandle
+     * @param {function} [renameRefSeqs]
+     */
+    constructor({ filehandle, renameRefSeqs, }: {
+        filehandle: GenericFilehandle;
+        renameRefSeqs?: (a: string) => string;
+    });
+    abstract lineCount(refName: string, args: Options): Promise<number>;
+    protected abstract _parse(opts: Options): Promise<{
+        refNameToId: {
+            [key: string]: number;
+        };
+        refIdToName: string[];
+    }>;
+    getMetadata(opts?: Options): Promise<any>;
+    abstract blocksForRange(refName: string, start: number, end: number, opts: Options): Promise<Chunk[]>;
+    _findFirstData(currentFdl: VirtualOffset | undefined, virtualOffset: VirtualOffset): VirtualOffset;
+    parse(opts?: Options): Promise<any>;
+    hasRefSeq(seqId: number, opts?: Options): Promise<boolean>;
+}

package/esm/indexFile.js

@@ -0,0 +1,40 @@
+import AbortablePromiseCache from 'abortable-promise-cache';
+import QuickLRU from 'quick-lru';
+export default class IndexFile {
+    /**
+     * @param {filehandle} filehandle
+     * @param {function} [renameRefSeqs]
+     */
+    constructor({ filehandle, renameRefSeqs = (n) => n, }) {
+        this.filehandle = filehandle;
+        this.renameRefSeq = renameRefSeqs;
+    }
+    async getMetadata(opts = {}) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { indices, ...rest } = await this.parse(opts);
+        return rest;
+    }
+    _findFirstData(currentFdl, virtualOffset) {
+        if (currentFdl) {
+            return currentFdl.compareTo(virtualOffset) > 0
+                ? virtualOffset
+                : currentFdl;
+        }
+        else {
+            return virtualOffset;
+        }
+    }
+    async parse(opts = {}) {
+        if (!this._parseCache) {
+            this._parseCache = new AbortablePromiseCache({
+                cache: new QuickLRU({ maxSize: 1 }),
+                fill: () => this._parse(opts),
+            });
+        }
+        return this._parseCache.get('index', null, undefined);
+    }
+    async hasRefSeq(seqId, opts = {}) {
+        return !!((await this.parse(opts)).indices[seqId] || {}).binIndex;
+    }
+}
+//# sourceMappingURL=indexFile.js.map

package/esm/indexFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexFile.js","sourceRoot":"","sources":["../src/indexFile.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,yBAAyB,CAAA;AAC3D,OAAO,QAAQ,MAAM,WAAW,CAAA;AAWhC,MAAM,CAAC,OAAO,OAAgB,SAAS;IAKrC;;;OAGG;IACH,YAAY,EACV,UAAU,EACV,aAAa,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,GAIjC;QACC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,YAAY,GAAG,aAAa,CAAA;IACnC,CAAC;IASM,KAAK,CAAC,WAAW,CAAC,OAAgB,EAAE;QACzC,6DAA6D;QAC7D,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACnD,OAAO,IAAI,CAAA;IACb,CAAC;IASD,cAAc,CACZ,UAAqC,EACrC,aAA4B;QAE5B,IAAI,UAAU,EAAE;YACd,OAAO,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC;gBAC5C,CAAC,CAAC,aAAa;gBACf,CAAC,CAAC,UAAU,CAAA;SACf;aAAM;YACL,OAAO,aAAa,CAAA;SACrB;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,OAAgB,EAAE;QAC5B,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACrB,IAAI,CAAC,WAAW,GAAG,IAAI,qBAAqB,CAAC;gBAC3C,KAAK,EAAE,IAAI,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;gBACnC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;aAC9B,CAAC,CAAA;SACH;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAA;IACvD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,OAAgB,EAAE;QAC/C,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAA;IACnE,CAAC;CACF"}

package/esm/tabixIndexedFile.d.ts

@@ -0,0 +1,118 @@
+/// <reference types="node" />
+import { GenericFilehandle } from 'generic-filehandle';
+import { Options } from './indexFile';
+import Chunk from './chunk';
+declare type GetLinesCallback = (line: string, fileOffset: number) => void;
+interface GetLinesOpts {
+    [key: string]: unknown;
+    signal?: AbortSignal;
+    lineCallback: GetLinesCallback;
+}
+export default class TabixIndexedFile {
+    private filehandle;
+    private index;
+    private chunkSizeLimit;
+    private renameRefSeq;
+    private chunkCache;
+    /**
+     * @param {object} args
+     * @param {string} [args.path]
+     * @param {filehandle} [args.filehandle]
+     * @param {string} [args.tbiPath]
+     * @param {filehandle} [args.tbiFilehandle]
+     * @param {string} [args.csiPath]
+     * @param {filehandle} [args.csiFilehandle]
+     * @param {chunkSizeLimit} default 50MiB
+     * @param {function} [args.renameRefSeqs] optional function with sig `string => string` to transform
+     * reference sequence names for the purpose of indexing and querying. note that the data that is returned is
+     * not altered, just the names of the reference sequences that are used for querying.
+     * @param {number} [args.chunkCacheSize] maximum size in bytes of the chunk cache. default 5MB
+     * @param {number} [args.blockCacheSize] maximum size in bytes of the block cache. default 5MB
+     */
+    constructor({ path, filehandle, tbiPath, tbiFilehandle, csiPath, csiFilehandle, chunkSizeLimit, renameRefSeqs, chunkCacheSize, }: {
+        path?: string;
+        filehandle?: GenericFilehandle;
+        tbiPath?: string;
+        tbiFilehandle?: GenericFilehandle;
+        csiPath?: string;
+        csiFilehandle?: GenericFilehandle;
+        chunkSizeLimit?: number;
+        renameRefSeqs?: (n: string) => string;
+        chunkCacheSize?: number;
+    });
+    /**
+     * @param {string} refName name of the reference sequence
+     * @param {number} start start of the region (in 0-based half-open coordinates)
+     * @param {number} end end of the region (in 0-based half-open coordinates)
+     * @param {function|object} lineCallback callback called for each line in the region. can also pass a object param containing obj.lineCallback, obj.signal, etc
+     * @returns {Promise} resolved when the whole read is finished, rejected on error
+     */
+    getLines(refName: string, start: number, end: number, opts: GetLinesOpts | GetLinesCallback): Promise<void>;
+    getMetadata(opts?: Options): Promise<any>;
+    /**
+     * get a buffer containing the "header" region of
+     * the file, which are the bytes up to the first
+     * non-meta line
+     *
+     * @returns {Promise} for a buffer
+     */
+    getHeaderBuffer(opts?: Options): Promise<Buffer>;
+    /**
+     * get a string containing the "header" region of the
+     * file, is the portion up to the first non-meta line
+     *
+     * @returns {Promise} for a string
+     */
+    getHeader(opts?: Options): Promise<string>;
+    /**
+     * get an array of reference sequence names, in the order in which
+     * they occur in the file.
+     *
+     * reference sequence renaming is not applied to these names.
+     *
+     * @returns {Promise} for an array of string sequence names
+     */
+    getReferenceSequenceNames(opts?: Options): Promise<any>;
+    /**
+     * @param {object} metadata metadata object from the parsed index,
+     * containing columnNumbers, metaChar, and format
+     * @param {string} regionRefName
+     * @param {number} regionStart region start coordinate (0-based-half-open)
+     * @param {number} regionEnd region end coordinate (0-based-half-open)
+     * @param {array[string]} line
+     * @returns {object} like `{startCoordinate, overlaps}`. overlaps is boolean,
+     * true if line is a data line that overlaps the given region
+     */
+    checkLine({ columnNumbers, metaChar, coordinateType, format, }: {
+        columnNumbers: {
+            ref: number;
+            start: number;
+            end: number;
+        };
+        metaChar: string;
+        coordinateType: string;
+        format: string;
+    }, regionRefName: string, regionStart: number, regionEnd: number, line: string): {
+        overlaps: boolean;
+        startCoordinate?: undefined;
+    } | {
+        startCoordinate: number;
+        overlaps: boolean;
+    };
+    _getVcfEnd(startCoordinate: number, refSeq: string, info: any): number;
+    /**
+     * return the approximate number of data lines in the given reference sequence
+     * @param {string} refSeq reference sequence name
+     * @returns {Promise} for number of data lines present on that reference sequence
+     */
+    lineCount(refName: string, opts?: Options): Promise<number>;
+    _readRegion(position: number, compressedSize: number, opts?: Options): Promise<Buffer>;
+    /**
+     * read and uncompress the data in a chunk (composed of one or more
+     * contiguous bgzip blocks) of the file
+     * @param {Chunk} chunk
+     * @returns {Promise} for a string chunk of the file
+     */
+    readChunk(chunk: Chunk, opts?: Options): Promise<any>;
+}
+export {};