@jbrowse/plugin-gtf 5.0.0-beta.7 → 5.0.0-beta.9

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.
@@ -54,6 +54,6 @@ export default class GtfAdapter extends BaseFeatureDataAdapter {
54
54
  catch (e) {
55
55
  observer.error(e);
56
56
  }
57
- }, opts.stopToken);
57
+ }, opts.signal);
58
58
  }
59
59
  }
@@ -18,25 +18,21 @@ export declare function normalizeSnapshot(snap: Record<string, unknown>): Record
18
18
  * ```
19
19
  */
20
20
  declare const GtfAdapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
21
- /**
22
- * #slot
23
- */
21
+ type: {
22
+ type: "string";
23
+ } & {
24
+ defaultValue: string;
25
+ };
24
26
  readonly gtfLocation: {
25
- readonly type: "fileLocation";
26
- readonly description: "path to gtf file, also allows for gzipped gtf";
27
- readonly defaultValue: {
28
- readonly uri: "/path/to/my.gtf";
29
- readonly locationType: "UriLocation";
30
- };
27
+ type: "fileLocation";
28
+ } & {
29
+ defaultValue: unknown;
31
30
  };
32
- /**
33
- * #slot
34
- */
35
31
  readonly aggregateField: {
36
- readonly type: "string";
37
- readonly description: "attribute naming the parent gene that transcripts are aggregated into. transcripts are grouped by gene_id where the file has one (gene names are not unique within a reference), so this is the gene label, and the grouping key only for files with no gene_id";
38
- readonly defaultValue: "gene_name";
32
+ type: "string";
33
+ } & {
34
+ defaultValue: string;
39
35
  };
40
- }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
36
+ }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>>>;
41
37
  export type GtfAdapterConfig = Instance<typeof GtfAdapter>;
42
38
  export default GtfAdapter;
@@ -1,7 +1,6 @@
1
1
  import { TabixIndexedFile } from '@gmod/tabix';
2
2
  import { BaseFeatureDataAdapter, cachedSetup, } from '@jbrowse/core/data_adapters/BaseAdapter';
3
3
  import { SimpleFeature, downloadStatus } from '@jbrowse/core/util';
4
- import { sharedBgzfWorkerPool } from '@jbrowse/core/util/bgzfWorkerPool';
5
4
  import { decompressedBytesBudget } from '@jbrowse/core/util/cacheBudgets';
6
5
  import { openLocation, openTabixIndexFilehandle } from '@jbrowse/core/util/io';
7
6
  import { ObservableCreate } from '@jbrowse/core/util/rxjs';
@@ -15,7 +14,6 @@ export default class GtfTabixAdapter extends BaseFeatureDataAdapter {
15
14
  filehandle: openLocation(this.getConf('gtfGzLocation'), this.pluginManager),
16
15
  ...openTabixIndexFilehandle(this.getConf(['index', 'location']), this.getConf(['index', 'indexType']), this.pluginManager),
17
16
  chunkCacheBudget: decompressedBytesBudget,
18
- bgzfWorkerPool: sharedBgzfWorkerPool(),
19
17
  });
20
18
  return {
21
19
  gtf,
@@ -74,6 +72,6 @@ export default class GtfTabixAdapter extends BaseFeatureDataAdapter {
74
72
  catch (e) {
75
73
  observer.error(e);
76
74
  }
77
- }, opts.stopToken);
75
+ }, opts.signal);
78
76
  }
79
77
  }
@@ -19,63 +19,42 @@ export declare function normalizeSnapshot(snap: Record<string, unknown>): Record
19
19
  */
20
20
  declare const GtfTabixAdapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
21
21
  readonly densityAdapter: {
22
- readonly type: 'frozen';
23
- readonly defaultValue: null;
24
- readonly description: 'optional quantitative sub-adapter (e.g. a BigWigAdapter over a features-per-bin bigWig) drawn as a density band where the region is too large to fetch features; null disables it';
22
+ type: "maybeFrozen";
23
+ };
24
+ type: {
25
+ type: "string";
26
+ } & {
27
+ defaultValue: string;
25
28
  };
26
- /**
27
- * #slot
28
- * location of the bgzip-compressed GTF, sorted by position. Must be bgzip
29
- * rather than plain gzip, which tabix cannot index.
30
- */
31
29
  readonly gtfGzLocation: {
32
- readonly type: "fileLocation";
33
- readonly defaultValue: {
34
- readonly uri: "/path/to/my.gtf.gz";
35
- readonly locationType: "UriLocation";
36
- };
30
+ type: "fileLocation";
31
+ } & {
32
+ defaultValue: unknown;
37
33
  };
38
34
  readonly index: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
39
35
  readonly indexType: {
40
- readonly model: import("@jbrowse/mobx-state-tree").ISimpleType<"CSI" | "TBI">;
41
- readonly type: 'stringEnum';
42
- readonly defaultValue: 'TBI';
43
- readonly description: '`TBI` is the usual `tabix` output. `CSI` is required for a reference longer than 512 Mb, which TBI cannot address.';
36
+ type: "stringEnum";
37
+ } & {
38
+ model: import("@jbrowse/mobx-state-tree").ISimpleType<"CSI" | "TBI">;
39
+ } & {
40
+ defaultValue: string;
44
41
  };
45
42
  readonly location: {
46
- readonly type: 'fileLocation';
47
- readonly defaultValue: {
48
- readonly uri: '/path/to/my.gz.tbi';
49
- readonly locationType: 'UriLocation';
50
- };
51
- readonly description: 'location of the tabix index. Only needed when it is not named `<file>.tbi`, which is what the `uri` shorthand assumes — a `.csi` beside the file is reached with `csi: true` rather than by spelling this out.';
43
+ type: "fileLocation";
44
+ } & {
45
+ defaultValue: unknown;
52
46
  };
53
- }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
54
- /**
55
- * #slot
56
- * the GtfTabixAdapter has to "redispatch" if it fetches a region and
57
- * features it finds inside that region extend outside the region we
58
- * requested. you can disable this for certain feature types to avoid
59
- * fetching e.g. the entire chromosome
60
- *
61
- * the defaults are the whole-sequence records the common annotation sources
62
- * emit: `region` (NCBI), `supercontig`/`scaffold` (Ensembl, for
63
- * non-chromosomal sequences), plus `chromosome` and `contig`. They span an
64
- * entire reference and have no children, so letting one expand the fetch
65
- * would pull a whole chromosome to gain nothing
66
- */
47
+ }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, undefined, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>>>;
67
48
  readonly dontRedispatch: {
68
- readonly type: "stringArray";
69
- readonly defaultValue: readonly ["chromosome", "region", "contig", "supercontig", "scaffold"];
49
+ type: "stringArray";
50
+ } & {
51
+ defaultValue: unknown;
70
52
  };
71
- /**
72
- * #slot
73
- */
74
53
  readonly aggregateField: {
75
- readonly type: "string";
76
- readonly description: "attribute naming the parent gene that transcripts are aggregated into. transcripts are grouped by gene_id where the file has one (gene names are not unique within a reference), so this is the gene label, and the grouping key only for files with no gene_id";
77
- readonly defaultValue: "gene_name";
54
+ type: "string";
55
+ } & {
56
+ defaultValue: string;
78
57
  };
79
- }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
58
+ }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>>>;
80
59
  export type GtfTabixAdapterConfig = Instance<typeof GtfTabixAdapter>;
81
60
  export default GtfTabixAdapter;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jbrowse/plugin-gtf",
3
- "version": "5.0.0-beta.7",
3
+ "version": "5.0.0-beta.9",
4
4
  "type": "module",
5
5
  "description": "JBrowse 2 gtf feature adapter",
6
6
  "keywords": [
@@ -21,10 +21,10 @@
21
21
  "esm"
22
22
  ],
23
23
  "dependencies": {
24
- "@gmod/tabix": "^3.8.2",
25
- "@jbrowse/mobx-state-tree": "^6.5.1",
24
+ "@gmod/tabix": "^3.8.3",
25
+ "@jbrowse/mobx-state-tree": "^6.5.2",
26
26
  "rxjs": "^7.8.2",
27
- "@jbrowse/core": "^5.0.0-beta.7"
27
+ "@jbrowse/core": "^5.0.0-beta.9"
28
28
  },
29
29
  "peerDependencies": {
30
30
  "react": ">=19.0.0"