@genobank/biofs 3.17.3 → 3.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/benchmark.d.ts.map +1 -1
- package/dist/commands/benchmark.js +2 -1
- package/dist/commands/benchmark.js.map +1 -1
- package/dist/commands/consent.d.ts +10 -0
- package/dist/commands/consent.d.ts.map +1 -0
- package/dist/commands/consent.js +114 -0
- package/dist/commands/consent.js.map +1 -0
- package/dist/commands/duet.d.ts.map +1 -1
- package/dist/commands/duet.js +2 -1
- package/dist/commands/duet.js.map +1 -1
- package/dist/commands/fuse.d.ts.map +1 -1
- package/dist/commands/fuse.js +29 -7
- package/dist/commands/fuse.js.map +1 -1
- package/dist/commands/htsget.d.ts +6 -0
- package/dist/commands/htsget.d.ts.map +1 -1
- package/dist/commands/htsget.js +31 -6
- package/dist/commands/htsget.js.map +1 -1
- package/dist/commands/pipe.d.ts +4 -2
- package/dist/commands/pipe.d.ts.map +1 -1
- package/dist/commands/pipe.js +55 -50
- package/dist/commands/pipe.js.map +1 -1
- package/dist/commands/profile.d.ts +8 -0
- package/dist/commands/profile.d.ts.map +1 -0
- package/dist/commands/profile.js +193 -0
- package/dist/commands/profile.js.map +1 -0
- package/dist/commands/researcher/passport.d.ts +15 -0
- package/dist/commands/researcher/passport.d.ts.map +1 -0
- package/dist/commands/researcher/passport.js +98 -0
- package/dist/commands/researcher/passport.js.map +1 -0
- package/dist/commands/researcher/register.d.ts.map +1 -1
- package/dist/commands/researcher/register.js +4 -2
- package/dist/commands/researcher/register.js.map +1 -1
- package/dist/commands/room.d.ts +31 -0
- package/dist/commands/room.d.ts.map +1 -0
- package/dist/commands/room.js +486 -0
- package/dist/commands/room.js.map +1 -0
- package/dist/commands/stream.d.ts +7 -0
- package/dist/commands/stream.d.ts.map +1 -1
- package/dist/commands/stream.js +26 -41
- package/dist/commands/stream.js.map +1 -1
- package/dist/commands/tele.d.ts +42 -0
- package/dist/commands/tele.d.ts.map +1 -0
- package/dist/commands/tele.js +559 -0
- package/dist/commands/tele.js.map +1 -0
- package/dist/index.js +537 -7
- package/dist/index.js.map +1 -1
- package/dist/lib/config/paths.d.ts +6 -6
- package/dist/lib/config/paths.d.ts.map +1 -1
- package/dist/lib/config/paths.js +56 -17
- package/dist/lib/config/paths.js.map +1 -1
- package/dist/lib/htsget/client.d.ts +28 -5
- package/dist/lib/htsget/client.d.ts.map +1 -1
- package/dist/lib/htsget/client.js +96 -18
- package/dist/lib/htsget/client.js.map +1 -1
- package/dist/lib/tele/core.d.ts +71 -0
- package/dist/lib/tele/core.d.ts.map +1 -0
- package/dist/lib/tele/core.js +387 -0
- package/dist/lib/tele/core.js.map +1 -0
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../../src/lib/config/paths.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../../src/lib/config/paths.ts"],"names":[],"mappings":"AA+BA,wBAAgB,oBAAoB,IAAI,MAAM,CAM7C;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAc;IAErC,MAAM,CAAC,WAAW,IAAI,WAAW;IAOjC,qFAAqF;IACrF,MAAM,CAAC,aAAa,IAAI,IAAI;IAItB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAOxC,YAAY,IAAI,MAAM;IAItB,kBAAkB,IAAI,MAAM;IAI5B,aAAa,IAAI,MAAM;IAIvB,WAAW,IAAI,MAAM;IAIrB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAI1C,UAAU,IAAI,MAAM;IAIpB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAIxC,kBAAkB,IAAI,MAAM;IAI5B,wBAAwB,IAAI,MAAM;IAIlC,eAAe,IAAI,MAAM;CAG1B"}
|
package/dist/lib/config/paths.js
CHANGED
|
@@ -34,48 +34,87 @@ var __importStar = (this && this.__importStar) || (function () {
|
|
|
34
34
|
})();
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
36
|
exports.ConfigPaths = void 0;
|
|
37
|
+
exports.getActiveProfileName = getActiveProfileName;
|
|
37
38
|
const fs = __importStar(require("fs-extra"));
|
|
38
39
|
const path = __importStar(require("path"));
|
|
39
40
|
const constants_1 = require("./constants");
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
41
|
+
/**
|
|
42
|
+
* Resolve ~/.biofs (or a named profile under ~/.biofs/profiles/<name>).
|
|
43
|
+
*
|
|
44
|
+
* Dual-role E2E (patient vault vs researcher):
|
|
45
|
+
* BIOFS_PROFILE=patient → ~/.biofs/profiles/patient/
|
|
46
|
+
* BIOFS_PROFILE=researcher → ~/.biofs/profiles/researcher/
|
|
47
|
+
* BIOFS_HOME=/custom/path → overrides everything (absolute profile root)
|
|
48
|
+
*
|
|
49
|
+
* Default (no env) stays ~/.biofs for backward compatibility.
|
|
50
|
+
*/
|
|
51
|
+
function resolveConfigDir() {
|
|
52
|
+
if (process.env.BIOFS_HOME && process.env.BIOFS_HOME.trim()) {
|
|
53
|
+
return path.resolve(process.env.BIOFS_HOME.trim());
|
|
54
|
+
}
|
|
55
|
+
const base = path.join(constants_1.CONFIG.HOME_DIR, constants_1.CONFIG.CONFIG_DIR_NAME);
|
|
56
|
+
const profile = (process.env.BIOFS_PROFILE || '').trim();
|
|
57
|
+
if (profile) {
|
|
58
|
+
if (!/^[a-zA-Z0-9_-]{1,64}$/.test(profile)) {
|
|
59
|
+
throw new Error(`Invalid BIOFS_PROFILE "${profile}". Use letters, digits, _ or - only.`);
|
|
60
|
+
}
|
|
61
|
+
return path.join(base, 'profiles', profile);
|
|
47
62
|
}
|
|
63
|
+
return base;
|
|
64
|
+
}
|
|
65
|
+
function getActiveProfileName() {
|
|
66
|
+
if (process.env.BIOFS_HOME && process.env.BIOFS_HOME.trim()) {
|
|
67
|
+
return `home:${path.resolve(process.env.BIOFS_HOME.trim())}`;
|
|
68
|
+
}
|
|
69
|
+
const profile = (process.env.BIOFS_PROFILE || '').trim();
|
|
70
|
+
return profile || 'default';
|
|
71
|
+
}
|
|
72
|
+
class ConfigPaths {
|
|
48
73
|
static getInstance() {
|
|
49
74
|
if (!ConfigPaths.instance) {
|
|
50
75
|
ConfigPaths.instance = new ConfigPaths();
|
|
51
76
|
}
|
|
52
77
|
return ConfigPaths.instance;
|
|
53
78
|
}
|
|
79
|
+
/** Force re-bind after BIOFS_PROFILE changes in-process (rare; mostly for tests). */
|
|
80
|
+
static resetInstance() {
|
|
81
|
+
ConfigPaths.instance = new ConfigPaths();
|
|
82
|
+
}
|
|
54
83
|
async ensureDirectories() {
|
|
55
|
-
|
|
56
|
-
await fs.ensureDir(
|
|
57
|
-
await fs.ensureDir(this.
|
|
84
|
+
const configDir = this.getConfigDir();
|
|
85
|
+
await fs.ensureDir(configDir);
|
|
86
|
+
await fs.ensureDir(this.getCacheDir());
|
|
87
|
+
await fs.ensureDir(this.getLogsDir());
|
|
58
88
|
}
|
|
59
89
|
getConfigDir() {
|
|
60
|
-
return
|
|
90
|
+
return resolveConfigDir();
|
|
61
91
|
}
|
|
62
92
|
getCredentialsPath() {
|
|
63
|
-
return this.
|
|
93
|
+
return path.join(this.getConfigDir(), constants_1.CONFIG.CREDENTIALS_FILE);
|
|
64
94
|
}
|
|
65
95
|
getConfigPath() {
|
|
66
|
-
return this.
|
|
96
|
+
return path.join(this.getConfigDir(), constants_1.CONFIG.CONFIG_FILE);
|
|
67
97
|
}
|
|
68
98
|
getCacheDir() {
|
|
69
|
-
return this.
|
|
99
|
+
return path.join(this.getConfigDir(), 'cache');
|
|
70
100
|
}
|
|
71
101
|
getCacheFilePath(filename) {
|
|
72
|
-
return path.join(this.
|
|
102
|
+
return path.join(this.getCacheDir(), filename);
|
|
73
103
|
}
|
|
74
104
|
getLogsDir() {
|
|
75
|
-
return this.
|
|
105
|
+
return path.join(this.getConfigDir(), 'logs');
|
|
76
106
|
}
|
|
77
107
|
getLogFilePath(filename) {
|
|
78
|
-
return path.join(this.
|
|
108
|
+
return path.join(this.getLogsDir(), filename);
|
|
109
|
+
}
|
|
110
|
+
getRoomSessionPath() {
|
|
111
|
+
return path.join(this.getConfigDir(), 'active_room.json');
|
|
112
|
+
}
|
|
113
|
+
getResearcherProfilePath() {
|
|
114
|
+
return path.join(this.getConfigDir(), 'researcher.json');
|
|
115
|
+
}
|
|
116
|
+
getProfilesRoot() {
|
|
117
|
+
return path.join(constants_1.CONFIG.HOME_DIR, constants_1.CONFIG.CONFIG_DIR_NAME, 'profiles');
|
|
79
118
|
}
|
|
80
119
|
}
|
|
81
120
|
exports.ConfigPaths = ConfigPaths;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../../src/lib/config/paths.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"paths.js","sourceRoot":"","sources":["../../../src/lib/config/paths.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,oDAMC;AArCD,6CAA+B;AAC/B,2CAA6B;AAC7B,2CAAqC;AAErC;;;;;;;;;GASG;AACH,SAAS,gBAAgB;IACvB,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,kBAAM,CAAC,QAAQ,EAAE,kBAAM,CAAC,eAAe,CAAC,CAAC;IAChE,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,KAAK,CACb,0BAA0B,OAAO,sCAAsC,CACxE,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,oBAAoB;IAClC,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5D,OAAO,QAAQ,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;IAC/D,CAAC;IACD,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,OAAO,OAAO,IAAI,SAAS,CAAC;AAC9B,CAAC;AAED,MAAa,WAAW;IAGtB,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;YAC1B,WAAW,CAAC,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;QAC3C,CAAC;QACD,OAAO,WAAW,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED,qFAAqF;IACrF,MAAM,CAAC,aAAa;QAClB,WAAW,CAAC,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,iBAAiB;QACrB,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC9B,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACvC,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,YAAY;QACV,OAAO,gBAAgB,EAAE,CAAC;IAC5B,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,kBAAM,CAAC,gBAAgB,CAAC,CAAC;IACjE,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,kBAAM,CAAC,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED,gBAAgB,CAAC,QAAgB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,cAAc,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,kBAAkB,CAAC,CAAC;IAC5D,CAAC;IAED,wBAAwB;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,iBAAiB,CAAC,CAAC;IAC3D,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAM,CAAC,QAAQ,EAAE,kBAAM,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;IACxE,CAAC;CACF;AA7DD,kCA6DC"}
|
|
@@ -3,11 +3,13 @@
|
|
|
3
3
|
*
|
|
4
4
|
* Fetches a ticket (a JSON pointer to one or more byte-range URLs) from the
|
|
5
5
|
* htsget endpoint, then the caller is responsible for streaming those URLs
|
|
6
|
-
* in order. This keeps us aligned with bcftools/samtools/pysam which all
|
|
6
|
+
* in order. This keeps us aligned with bcftools/samtools/pysam/IGV which all
|
|
7
7
|
* speak htsget natively.
|
|
8
8
|
*
|
|
9
9
|
* See: https://samtools.github.io/hts-specs/htsget.html
|
|
10
10
|
*/
|
|
11
|
+
export declare const DEFAULT_HTSGET_URL: string;
|
|
12
|
+
export declare const USER_AGENT = "biofs/3.18.0 (+https://genobank.io; telebioinformatics)";
|
|
11
13
|
export type HtsgetKind = 'variants' | 'reads';
|
|
12
14
|
export interface HtsgetTicketUrl {
|
|
13
15
|
url: string;
|
|
@@ -42,13 +44,34 @@ export interface HtsgetServiceInfo {
|
|
|
42
44
|
export interface HtsgetClientOpts {
|
|
43
45
|
/** Base URL of htsget service. Default: https://htsget.genobank.app */
|
|
44
46
|
baseUrl?: string;
|
|
45
|
-
/** Optional override for query params (e.g. referenceName, start, end). */
|
|
47
|
+
/** Optional override for query params (e.g. referenceName, start, end, annotated). */
|
|
46
48
|
query?: Record<string, string | number | undefined>;
|
|
47
49
|
}
|
|
50
|
+
export interface GenomicRegion {
|
|
51
|
+
referenceName: string;
|
|
52
|
+
start?: number;
|
|
53
|
+
end?: number;
|
|
54
|
+
raw: string;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Parse regions like:
|
|
58
|
+
* chr17
|
|
59
|
+
* chr17:7661779
|
|
60
|
+
* chr17:7661779-7687538
|
|
61
|
+
* 17:7661779-7687538
|
|
62
|
+
*
|
|
63
|
+
* User coordinates are treated as 1-based inclusive (VCF/IGV style).
|
|
64
|
+
* htsget wants 0-based half-open; we convert start-=1 when start is set.
|
|
65
|
+
*/
|
|
66
|
+
export declare function parseGenomicRegion(region: string): GenomicRegion | null;
|
|
67
|
+
/** Guess `variants` vs `reads` from a filename or biocid. */
|
|
68
|
+
export declare function guessKindFromFilename(filename: string): HtsgetKind;
|
|
69
|
+
/** Whether this name is streamable via htsget reads/variants. */
|
|
70
|
+
export declare function streamableExtension(filename: string): boolean;
|
|
48
71
|
/** Fetch the GA4GH service-info JSON. No auth required. */
|
|
49
72
|
export declare function getServiceInfo(opts?: HtsgetClientOpts): Promise<HtsgetServiceInfo>;
|
|
50
|
-
/** Fetch a ticket. `id` is usually
|
|
73
|
+
/** Fetch a ticket. `id` is usually a filename / ip_id but can also be a full BioCID URL. */
|
|
51
74
|
export declare function getTicket(kind: HtsgetKind, id: string, signature: string, opts?: HtsgetClientOpts): Promise<HtsgetTicket>;
|
|
52
|
-
/**
|
|
53
|
-
export declare function
|
|
75
|
+
/** Build a bookmarkable ticket request URL (without Bearer; for debugging). */
|
|
76
|
+
export declare function buildTicketRequestUrl(kind: HtsgetKind, id: string, opts?: HtsgetClientOpts): string;
|
|
54
77
|
//# sourceMappingURL=client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/lib/htsget/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/lib/htsget/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,eAAO,MAAM,kBAAkB,QAAgE,CAAC;AAChG,eAAO,MAAM,UAAU,4DAA4D,CAAC;AAEpF,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,eAAe,EAAE,CAAC;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/D,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CACtD;AAED,MAAM,WAAW,gBAAgB;IAC/B,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sFAAsF;IACtF,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;CACrD;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;;;;GASG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,CAmBvE;AAED,6DAA6D;AAC7D,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAiBlE;AAED,iEAAiE;AACjE,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAgB7D;AAED,2DAA2D;AAC3D,wBAAsB,cAAc,CAAC,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAS5F;AAED,4FAA4F;AAC5F,wBAAsB,SAAS,CAC7B,IAAI,EAAE,UAAU,EAChB,EAAE,EAAE,MAAM,EACV,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,gBAAqB,GAC1B,OAAO,CAAC,YAAY,CAAC,CAuCvB;AAED,+EAA+E;AAC/E,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,UAAU,EAChB,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAqB,GAC1B,MAAM,CAaR"}
|
|
@@ -4,35 +4,104 @@
|
|
|
4
4
|
*
|
|
5
5
|
* Fetches a ticket (a JSON pointer to one or more byte-range URLs) from the
|
|
6
6
|
* htsget endpoint, then the caller is responsible for streaming those URLs
|
|
7
|
-
* in order. This keeps us aligned with bcftools/samtools/pysam which all
|
|
7
|
+
* in order. This keeps us aligned with bcftools/samtools/pysam/IGV which all
|
|
8
8
|
* speak htsget natively.
|
|
9
9
|
*
|
|
10
10
|
* See: https://samtools.github.io/hts-specs/htsget.html
|
|
11
11
|
*/
|
|
12
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
exports.USER_AGENT = exports.DEFAULT_HTSGET_URL = void 0;
|
|
14
|
+
exports.parseGenomicRegion = parseGenomicRegion;
|
|
15
|
+
exports.guessKindFromFilename = guessKindFromFilename;
|
|
16
|
+
exports.streamableExtension = streamableExtension;
|
|
13
17
|
exports.getServiceInfo = getServiceInfo;
|
|
14
18
|
exports.getTicket = getTicket;
|
|
15
|
-
exports.
|
|
16
|
-
|
|
17
|
-
|
|
19
|
+
exports.buildTicketRequestUrl = buildTicketRequestUrl;
|
|
20
|
+
exports.DEFAULT_HTSGET_URL = process.env.BIOFS_HTSGET_URL || 'https://htsget.genobank.app';
|
|
21
|
+
exports.USER_AGENT = 'biofs/3.18.0 (+https://genobank.io; telebioinformatics)';
|
|
22
|
+
/**
|
|
23
|
+
* Parse regions like:
|
|
24
|
+
* chr17
|
|
25
|
+
* chr17:7661779
|
|
26
|
+
* chr17:7661779-7687538
|
|
27
|
+
* 17:7661779-7687538
|
|
28
|
+
*
|
|
29
|
+
* User coordinates are treated as 1-based inclusive (VCF/IGV style).
|
|
30
|
+
* htsget wants 0-based half-open; we convert start-=1 when start is set.
|
|
31
|
+
*/
|
|
32
|
+
function parseGenomicRegion(region) {
|
|
33
|
+
const raw = (region || '').trim();
|
|
34
|
+
if (!raw)
|
|
35
|
+
return null;
|
|
36
|
+
// chr:start-end | chr:start | chr
|
|
37
|
+
const m = raw.match(/^([^:]+)(?::(\d+)(?:-(\d+))?)?$/);
|
|
38
|
+
if (!m)
|
|
39
|
+
return null;
|
|
40
|
+
const referenceName = m[1];
|
|
41
|
+
const start1 = m[2] !== undefined ? parseInt(m[2], 10) : undefined;
|
|
42
|
+
const end1 = m[3] !== undefined ? parseInt(m[3], 10) : undefined;
|
|
43
|
+
const out = { referenceName, raw };
|
|
44
|
+
if (start1 !== undefined && !Number.isNaN(start1)) {
|
|
45
|
+
// htsget: 0-based inclusive start
|
|
46
|
+
out.start = Math.max(0, start1 - 1);
|
|
47
|
+
}
|
|
48
|
+
if (end1 !== undefined && !Number.isNaN(end1)) {
|
|
49
|
+
// htsget: 0-based exclusive end ≈ 1-based inclusive end
|
|
50
|
+
out.end = end1;
|
|
51
|
+
}
|
|
52
|
+
return out;
|
|
53
|
+
}
|
|
54
|
+
/** Guess `variants` vs `reads` from a filename or biocid. */
|
|
55
|
+
function guessKindFromFilename(filename) {
|
|
56
|
+
const lower = filename.toLowerCase();
|
|
57
|
+
if (lower.endsWith('.bam') ||
|
|
58
|
+
lower.endsWith('.cram') ||
|
|
59
|
+
lower.endsWith('.sam') ||
|
|
60
|
+
lower.endsWith('.fastq') ||
|
|
61
|
+
lower.endsWith('.fastq.gz') ||
|
|
62
|
+
lower.endsWith('.fq') ||
|
|
63
|
+
lower.endsWith('.fq.gz') ||
|
|
64
|
+
lower.includes('/bam/') ||
|
|
65
|
+
lower.includes('/cram/') ||
|
|
66
|
+
lower.includes('/fastq/')) {
|
|
67
|
+
return 'reads';
|
|
68
|
+
}
|
|
69
|
+
return 'variants';
|
|
70
|
+
}
|
|
71
|
+
/** Whether this name is streamable via htsget reads/variants. */
|
|
72
|
+
function streamableExtension(filename) {
|
|
73
|
+
const lower = filename.toLowerCase();
|
|
74
|
+
return (lower.endsWith('.vcf') ||
|
|
75
|
+
lower.endsWith('.vcf.gz') ||
|
|
76
|
+
lower.endsWith('.bcf') ||
|
|
77
|
+
lower.endsWith('.g.vcf') ||
|
|
78
|
+
lower.endsWith('.g.vcf.gz') ||
|
|
79
|
+
lower.endsWith('.bam') ||
|
|
80
|
+
lower.endsWith('.cram') ||
|
|
81
|
+
lower.endsWith('.sam') ||
|
|
82
|
+
lower.endsWith('.fastq') ||
|
|
83
|
+
lower.endsWith('.fastq.gz') ||
|
|
84
|
+
lower.endsWith('.fq') ||
|
|
85
|
+
lower.endsWith('.fq.gz'));
|
|
86
|
+
}
|
|
18
87
|
/** Fetch the GA4GH service-info JSON. No auth required. */
|
|
19
88
|
async function getServiceInfo(opts = {}) {
|
|
20
|
-
const base = (opts.baseUrl || DEFAULT_HTSGET_URL).replace(/\/+$/, '');
|
|
89
|
+
const base = (opts.baseUrl || exports.DEFAULT_HTSGET_URL).replace(/\/+$/, '');
|
|
21
90
|
const res = await fetch(`${base}/service-info`, {
|
|
22
|
-
headers: { 'User-Agent': USER_AGENT, Accept: 'application/json' },
|
|
91
|
+
headers: { 'User-Agent': exports.USER_AGENT, Accept: 'application/json' },
|
|
23
92
|
});
|
|
24
93
|
if (!res.ok) {
|
|
25
94
|
throw new Error(`htsget service-info → HTTP ${res.status}`);
|
|
26
95
|
}
|
|
27
96
|
return (await res.json());
|
|
28
97
|
}
|
|
29
|
-
/** Fetch a ticket. `id` is usually
|
|
98
|
+
/** Fetch a ticket. `id` is usually a filename / ip_id but can also be a full BioCID URL. */
|
|
30
99
|
async function getTicket(kind, id, signature, opts = {}) {
|
|
31
|
-
const base = (opts.baseUrl || DEFAULT_HTSGET_URL).replace(/\/+$/, '');
|
|
100
|
+
const base = (opts.baseUrl || exports.DEFAULT_HTSGET_URL).replace(/\/+$/, '');
|
|
32
101
|
// If caller passed a full BioCID URL, pull the last segment as the id.
|
|
33
102
|
let cleanId = id;
|
|
34
|
-
if (id.startsWith('biocid://')) {
|
|
35
|
-
const parts = id.replace(/\/+$/, '').split('/');
|
|
103
|
+
if (id.startsWith('biocid://') || id.startsWith('Biocid:')) {
|
|
104
|
+
const parts = id.replace(/^Biocid:/i, 'biocid://').replace(/\/+$/, '').split('/');
|
|
36
105
|
cleanId = parts[parts.length - 1];
|
|
37
106
|
}
|
|
38
107
|
const qs = new URLSearchParams();
|
|
@@ -45,7 +114,7 @@ async function getTicket(kind, id, signature, opts = {}) {
|
|
|
45
114
|
const url = `${base}/${kind}/${encodeURIComponent(cleanId)}${qs.toString() ? '?' + qs.toString() : ''}`;
|
|
46
115
|
const res = await fetch(url, {
|
|
47
116
|
headers: {
|
|
48
|
-
'User-Agent': USER_AGENT,
|
|
117
|
+
'User-Agent': exports.USER_AGENT,
|
|
49
118
|
Accept: 'application/json',
|
|
50
119
|
Authorization: `Bearer ${signature}`,
|
|
51
120
|
},
|
|
@@ -58,7 +127,7 @@ async function getTicket(kind, id, signature, opts = {}) {
|
|
|
58
127
|
try {
|
|
59
128
|
parsed = JSON.parse(bodyText);
|
|
60
129
|
}
|
|
61
|
-
catch
|
|
130
|
+
catch {
|
|
62
131
|
throw new Error(`htsget ticket not JSON: ${bodyText.slice(0, 200)}`);
|
|
63
132
|
}
|
|
64
133
|
if (!parsed.htsget || !parsed.htsget.urls) {
|
|
@@ -66,11 +135,20 @@ async function getTicket(kind, id, signature, opts = {}) {
|
|
|
66
135
|
}
|
|
67
136
|
return parsed.htsget;
|
|
68
137
|
}
|
|
69
|
-
/**
|
|
70
|
-
function
|
|
71
|
-
const
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
138
|
+
/** Build a bookmarkable ticket request URL (without Bearer; for debugging). */
|
|
139
|
+
function buildTicketRequestUrl(kind, id, opts = {}) {
|
|
140
|
+
const base = (opts.baseUrl || exports.DEFAULT_HTSGET_URL).replace(/\/+$/, '');
|
|
141
|
+
let cleanId = id;
|
|
142
|
+
if (id.startsWith('biocid://')) {
|
|
143
|
+
cleanId = id.replace(/\/+$/, '').split('/').pop() || id;
|
|
144
|
+
}
|
|
145
|
+
const qs = new URLSearchParams();
|
|
146
|
+
if (opts.query) {
|
|
147
|
+
for (const [k, v] of Object.entries(opts.query)) {
|
|
148
|
+
if (v !== undefined && v !== null && v !== '')
|
|
149
|
+
qs.set(k, String(v));
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
return `${base}/${kind}/${encodeURIComponent(cleanId)}${qs.toString() ? '?' + qs.toString() : ''}`;
|
|
75
153
|
}
|
|
76
154
|
//# sourceMappingURL=client.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/lib/htsget/client.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/lib/htsget/client.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAsDH,gDAmBC;AAGD,sDAiBC;AAGD,kDAgBC;AAGD,wCASC;AAGD,8BA4CC;AAGD,sDAiBC;AA7LY,QAAA,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,IAAI,6BAA6B,CAAC;AACnF,QAAA,UAAU,GAAG,yDAAyD,CAAC;AAyCpF;;;;;;;;;GASG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC/C,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAClC,IAAI,CAAC,GAAG;QAAE,OAAO,IAAI,CAAC;IACtB,kCAAkC;IAClC,MAAM,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACvD,IAAI,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACpB,MAAM,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3B,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACjE,MAAM,GAAG,GAAkB,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC;IAClD,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QAClD,kCAAkC;QAClC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,wDAAwD;QACxD,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC;IACjB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,6DAA6D;AAC7D,SAAgB,qBAAqB,CAAC,QAAgB;IACpD,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACrC,IACE,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QACvB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxB,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC3B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QACrB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QACvB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxB,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,EACzB,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,iEAAiE;AACjE,SAAgB,mBAAmB,CAAC,QAAgB;IAClD,MAAM,KAAK,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACrC,OAAO,CACL,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxB,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC3B,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;QACvB,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC;QACtB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxB,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC3B,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC;QACrB,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACzB,CAAC;AACJ,CAAC;AAED,2DAA2D;AACpD,KAAK,UAAU,cAAc,CAAC,OAAyB,EAAE;IAC9D,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,0BAAkB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACtE,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,eAAe,EAAE;QAC9C,OAAO,EAAE,EAAE,YAAY,EAAE,kBAAU,EAAE,MAAM,EAAE,kBAAkB,EAAE;KAClE,CAAC,CAAC;IACH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAsB,CAAC;AACjD,CAAC;AAED,4FAA4F;AACrF,KAAK,UAAU,SAAS,CAC7B,IAAgB,EAChB,EAAU,EACV,SAAiB,EACjB,OAAyB,EAAE;IAE3B,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,0BAAkB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEtE,uEAAuE;IACvE,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3D,MAAM,KAAK,GAAG,EAAE,CAAC,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClF,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;IACjC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE;gBAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IACD,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,IAAI,IAAI,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAExG,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAC3B,OAAO,EAAE;YACP,YAAY,EAAE,kBAAU;YACxB,MAAM,EAAE,kBAAkB;YAC1B,aAAa,EAAE,UAAU,SAAS,EAAE;SACrC;KACF,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAClC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,IAAI,OAAO,WAAW,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/F,CAAC;IACD,IAAI,MAAiC,CAAC;IACtC,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAChC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,2BAA2B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;IACxE,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC;AAED,+EAA+E;AAC/E,SAAgB,qBAAqB,CACnC,IAAgB,EAChB,EAAU,EACV,OAAyB,EAAE;IAE3B,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,0BAAkB,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACtE,IAAI,OAAO,GAAG,EAAE,CAAC;IACjB,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;IAC1D,CAAC;IACD,MAAM,EAAE,GAAG,IAAI,eAAe,EAAE,CAAC;IACjC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE;gBAAE,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IACD,OAAO,GAAG,IAAI,IAAI,IAAI,IAAI,kBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACrG,CAAC"}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* TeleBioinformatics core — shared helpers for biofs stream / pipe / tele.
|
|
3
|
+
*
|
|
4
|
+
* Consent-gated bytes (htsget ticket → HTTP) pipe into local tools without
|
|
5
|
+
* writing vault objects to disk. Heavy compute stays Tier C (biofs annotate /
|
|
6
|
+
* skills); this module is Tier A (analyst laptop).
|
|
7
|
+
*/
|
|
8
|
+
import { ChildProcess } from 'child_process';
|
|
9
|
+
import { parseGenomicRegion, HtsgetKind, HtsgetTicket, DEFAULT_HTSGET_URL, USER_AGENT, streamableExtension } from '../htsget/client';
|
|
10
|
+
export type Layer = 'variants' | 'reads' | 'sequences' | 'unknown';
|
|
11
|
+
export interface TeleCommonOpts {
|
|
12
|
+
kind?: HtsgetKind;
|
|
13
|
+
quiet?: boolean;
|
|
14
|
+
htsgetUrl?: string;
|
|
15
|
+
annotated?: boolean;
|
|
16
|
+
/** Genomic region chr:start-end (forwarded to htsget + client filter when possible) */
|
|
17
|
+
region?: string;
|
|
18
|
+
referenceName?: string;
|
|
19
|
+
start?: number;
|
|
20
|
+
end?: number;
|
|
21
|
+
/** Force raw/byte stream (still via htsget inventory path) */
|
|
22
|
+
raw?: boolean;
|
|
23
|
+
}
|
|
24
|
+
export interface ResolvedTele {
|
|
25
|
+
id: string;
|
|
26
|
+
cleanId: string;
|
|
27
|
+
kind: HtsgetKind;
|
|
28
|
+
layer: Layer;
|
|
29
|
+
signature: string;
|
|
30
|
+
ticket: HtsgetTicket;
|
|
31
|
+
regionQuery: Record<string, string | number | undefined>;
|
|
32
|
+
filenameHint: string;
|
|
33
|
+
}
|
|
34
|
+
export declare function isQuiet(opts: {
|
|
35
|
+
quiet?: boolean;
|
|
36
|
+
}): boolean;
|
|
37
|
+
export declare function which(cmd: string): string | null;
|
|
38
|
+
export declare function requireTool(cmd: string, installHint: string): string;
|
|
39
|
+
export declare function layerFromId(id: string, kind: HtsgetKind): Layer;
|
|
40
|
+
export declare function buildRegionQuery(opts: TeleCommonOpts): Record<string, string | number | undefined>;
|
|
41
|
+
export declare function resolveTele(rawId: string, opts?: TeleCommonOpts): Promise<ResolvedTele>;
|
|
42
|
+
export declare function primaryUrl(ticket: HtsgetTicket): string;
|
|
43
|
+
/** Stream all ticket URLs to stdout (binary-safe). */
|
|
44
|
+
export declare function streamTicketToStdout(ticket: HtsgetTicket, opts?: {
|
|
45
|
+
quiet?: boolean;
|
|
46
|
+
}): void;
|
|
47
|
+
export declare function spawnCurl(url: string): ChildProcess;
|
|
48
|
+
/**
|
|
49
|
+
* curl | tool argv… with stdin from the stream.
|
|
50
|
+
* Resolves with the tool exit code.
|
|
51
|
+
*/
|
|
52
|
+
export declare function pipeUrlToCommand(url: string, command: string, args: string[], opts?: {
|
|
53
|
+
quiet?: boolean;
|
|
54
|
+
label?: string;
|
|
55
|
+
}): Promise<number>;
|
|
56
|
+
/** High-level: resolve id → ticket → pipe into local tool. */
|
|
57
|
+
export declare function telePipe(rawId: string, command: string, args: string[], opts?: TeleCommonOpts & {
|
|
58
|
+
label?: string;
|
|
59
|
+
}): Promise<number>;
|
|
60
|
+
export declare function teleStreamStdout(rawId: string, opts?: TeleCommonOpts): Promise<void>;
|
|
61
|
+
export declare const TOOL_CATALOG: Array<{
|
|
62
|
+
id: string;
|
|
63
|
+
tools: string[];
|
|
64
|
+
layer: Layer | 'any';
|
|
65
|
+
tier: 'A' | 'B' | 'C';
|
|
66
|
+
tele?: string;
|
|
67
|
+
note: string;
|
|
68
|
+
}>;
|
|
69
|
+
export declare function installHint(tool: string): string;
|
|
70
|
+
export { streamableExtension, parseGenomicRegion, DEFAULT_HTSGET_URL, USER_AGENT };
|
|
71
|
+
//# sourceMappingURL=core.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/lib/tele/core.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAoB,YAAY,EAAE,MAAM,eAAe,CAAC;AAI/D,OAAO,EAGL,kBAAkB,EAClB,UAAU,EACV,YAAY,EAEZ,kBAAkB,EAClB,UAAU,EACV,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAE1B,MAAM,MAAM,KAAK,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,CAAC;AAEnE,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uFAAuF;IACvF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,CAAC;IACzD,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAE1D;AAED,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAIhD;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAMpE;AAED,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,KAAK,CAwB/D;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC,CAelG;AAED,wBAAsB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,GAAE,cAAmB,GAAG,OAAO,CAAC,YAAY,CAAC,CA6DjG;AAED,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAGvD;AAED,sDAAsD;AACtD,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,IAAI,CAiB/F;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAMnD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,IAAI,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GAC7C,OAAO,CAAC,MAAM,CAAC,CA2BjB;AAED,8DAA8D;AAC9D,wBAAsB,QAAQ,CAC5B,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,IAAI,GAAE,cAAc,GAAG;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAO,GAC7C,OAAO,CAAC,MAAM,CAAC,CAOjB;AAED,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,MAAM,EACb,IAAI,GAAE,cAAmB,GACxB,OAAO,CAAC,IAAI,CAAC,CAGf;AAED,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC;IACrB,IAAI,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAyJA,CAAC;AAEF,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAWhD;AAED,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,UAAU,EAAE,CAAC"}
|