@jbrowse/plugin-gff3 5.0.0-beta.8 → 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.
@@ -59,6 +59,6 @@ export default class Gff3Adapter extends BaseFeatureDataAdapter {
59
59
  }
60
60
  }
61
61
  observer.complete();
62
- }, opts.stopToken);
62
+ }, opts.signal);
63
63
  }
64
64
  }
@@ -17,18 +17,16 @@ export declare function normalizeSnapshot(snap: Record<string, unknown>): Record
17
17
  * ```
18
18
  */
19
19
  declare const Gff3Adapter: import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaType<{
20
- /**
21
- * #slot
22
- * location of the GFF3 file. May be gzipped; it is decompressed and parsed
23
- * in full on first use, so the file has to fit in memory.
24
- */
20
+ type: {
21
+ type: "string";
22
+ } & {
23
+ defaultValue: string;
24
+ };
25
25
  readonly gffLocation: {
26
- readonly type: "fileLocation";
27
- readonly defaultValue: {
28
- readonly uri: "/path/to/my.gff";
29
- readonly locationType: "UriLocation";
30
- };
26
+ type: "fileLocation";
27
+ } & {
28
+ defaultValue: unknown;
31
29
  };
32
- }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
30
+ }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>>>;
33
31
  export type Gff3AdapterConfig = Instance<typeof Gff3Adapter>;
34
32
  export default Gff3Adapter;
@@ -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 { 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 { doesIntersect2 } from '@jbrowse/core/util/range';
@@ -17,7 +16,6 @@ export default class Gff3TabixAdapter extends BaseFeatureDataAdapter {
17
16
  filehandle: openLocation(this.getConf('gffGzLocation'), this.pluginManager),
18
17
  ...openTabixIndexFilehandle(this.getConf(['index', 'location']), this.getConf(['index', 'indexType']), this.pluginManager),
19
18
  chunkCacheBudget: decompressedBytesBudget,
20
- bgzfWorkerPool: sharedBgzfWorkerPool(),
21
19
  });
22
20
  return {
23
21
  gff,
@@ -80,6 +78,6 @@ export default class Gff3TabixAdapter extends BaseFeatureDataAdapter {
80
78
  catch (e) {
81
79
  observer.error(e);
82
80
  }
83
- }, opts.stopToken);
81
+ }, opts.signal);
84
82
  }
85
83
  }
@@ -19,55 +19,37 @@ export declare function normalizeSnapshot(snap: Record<string, unknown>): Record
19
19
  */
20
20
  declare const Gff3TabixAdapter: 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 GFF3, sorted by position. Must be bgzip
29
- * rather than plain gzip, which tabix cannot index.
30
- */
31
29
  readonly gffGzLocation: {
32
- readonly type: "fileLocation";
33
- readonly defaultValue: {
34
- readonly uri: "/path/to/my.gff.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 Gff3TabixAdapter has to "redispatch" if it fetches a region and
57
- * features it finds inside that region extend outside the region we requested.
58
- * you can disable this for certain feature types to avoid fetching e.g. the
59
- * entire chromosome
60
- *
61
- * the defaults are the whole-sequence records the common GFF3 sources emit:
62
- * `region` (NCBI), `supercontig`/`scaffold` (Ensembl, for non-chromosomal
63
- * sequences), plus `chromosome` and `contig`. They span an entire reference
64
- * and have no children, so letting one expand the fetch would pull a whole
65
- * 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
- }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined>>;
53
+ }, import("@jbrowse/core/configuration/configurationSchema").ConfigurationSchemaOptions<undefined, undefined, true, import("@jbrowse/core/configuration").ConfigurationSchemaRequirement<Partial<Record<string, string[]>>, string>>>;
72
54
  export type Gff3TabixAdapterConfig = Instance<typeof Gff3TabixAdapter>;
73
55
  export default Gff3TabixAdapter;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jbrowse/plugin-gff3",
3
- "version": "5.0.0-beta.8",
3
+ "version": "5.0.0-beta.9",
4
4
  "type": "module",
5
5
  "description": "JBrowse 2 gff3.",
6
6
  "keywords": [
@@ -21,12 +21,12 @@
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
  "gff-nostream": "^5.4.0",
27
27
  "mobx": "^7.0.3",
28
28
  "rxjs": "^7.8.2",
29
- "@jbrowse/core": "^5.0.0-beta.8"
29
+ "@jbrowse/core": "^5.0.0-beta.9"
30
30
  },
31
31
  "publishConfig": {
32
32
  "access": "public"