@jbrowse/plugin-trix 2.1.6 → 2.2.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.
@@ -9,6 +9,11 @@ export default class TrixTextSearchAdapter extends BaseAdapter implements BaseTe
9
9
  trixJs: Trix;
10
10
  tracksNames?: string[];
11
11
  constructor(config: AnyConfigurationModel, getSubAdapter?: getSubAdapterType, pluginManager?: PluginManager);
12
+ /**
13
+ * Returns list of results
14
+ * @param args - search options/arguments include: search query
15
+ * limit of results to return, searchType...prefix | full | exact", etc.
16
+ */
12
17
  searchIndex(args: BaseArgs): Promise<BaseResult[]>;
13
18
  freeResources(): void;
14
19
  }
@@ -38,7 +38,7 @@ class TrixTextSearchAdapter extends BaseAdapter_1.BaseAdapter {
38
38
  }
39
39
  this.trixJs = new trix_1.default((0, io_1.openLocation)(ixxFilePath), (0, io_1.openLocation)(ixFilePath), 1500);
40
40
  }
41
- /*
41
+ /**
42
42
  * Returns list of results
43
43
  * @param args - search options/arguments include: search query
44
44
  * limit of results to return, searchType...prefix | full | exact", etc.
@@ -1,2 +1,2 @@
1
- declare const _default: import("@jbrowse/core/configuration").AnyConfigurationSchemaType;
2
- export default _default;
1
+ declare const TrixTextSearchAdapter: import("@jbrowse/core/configuration").AnyConfigurationSchemaType;
2
+ export default TrixTextSearchAdapter;
@@ -1,31 +1,57 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const configuration_1 = require("@jbrowse/core/configuration");
4
- exports.default = (0, configuration_1.ConfigurationSchema)('TrixTextSearchAdapter', {
4
+ /**
5
+ * #config TrixTextSearchAdapter
6
+ */
7
+ function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
8
+ const TrixTextSearchAdapter = (0, configuration_1.ConfigurationSchema)('TrixTextSearchAdapter', {
9
+ /**
10
+ * #slot
11
+ */
5
12
  ixFilePath: {
6
13
  type: 'fileLocation',
7
14
  defaultValue: { uri: 'out.ix', locationType: 'UriLocation' },
8
15
  description: 'the location of the trix ix file',
9
16
  },
17
+ /**
18
+ * #slot
19
+ */
10
20
  ixxFilePath: {
11
21
  type: 'fileLocation',
12
22
  defaultValue: { uri: 'out.ixx', locationType: 'UriLocation' },
13
23
  description: 'the location of the trix ixx file',
14
24
  },
25
+ /**
26
+ * #slot
27
+ */
15
28
  metaFilePath: {
16
29
  type: 'fileLocation',
17
30
  defaultValue: { uri: 'meta.json', locationType: 'UriLocation' },
18
31
  description: 'the location of the metadata json file for the trix index',
19
32
  },
33
+ /**
34
+ * #slot
35
+ */
20
36
  tracks: {
21
37
  type: 'stringArray',
22
38
  defaultValue: [],
23
39
  description: 'List of tracks covered by text search adapter',
24
40
  },
41
+ /**
42
+ * #slot
43
+ */
25
44
  assemblyNames: {
26
45
  type: 'stringArray',
27
46
  defaultValue: [],
28
47
  description: 'List of assemblies covered by text search adapter',
29
48
  },
30
- }, { explicitlyTyped: true, explicitIdentifier: 'textSearchAdapterId' });
49
+ }, {
50
+ explicitlyTyped: true,
51
+ /**
52
+ * #identifier
53
+ */
54
+ explicitIdentifier: 'textSearchAdapterId',
55
+ });
56
+ exports.default = TrixTextSearchAdapter;
31
57
  //# sourceMappingURL=configSchema.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/TrixTextSearchAdapter/configSchema.ts"],"names":[],"mappings":";;AAAA,+DAAiE;AAEjE,kBAAe,IAAA,mCAAmB,EAChC,uBAAuB,EACvB;IACE,UAAU,EAAE;QACV,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE;QAC5D,WAAW,EAAE,kCAAkC;KAChD;IACD,WAAW,EAAE;QACX,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE;QAC7D,WAAW,EAAE,mCAAmC;KACjD;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE;QAC/D,WAAW,EAAE,2DAA2D;KACzE;IACD,MAAM,EAAE;QACN,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,+CAA+C;KAC7D;IACD,aAAa,EAAE;QACb,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,mDAAmD;KACjE;CACF,EACD,EAAE,eAAe,EAAE,IAAI,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,CACrE,CAAA"}
1
+ {"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/TrixTextSearchAdapter/configSchema.ts"],"names":[],"mappings":";;AAAA,+DAAiE;AAEjE;;GAEG;AACH,SAAS,CAAC,KAAI,CAAC,CAAC,wDAAwD;AAExE,MAAM,qBAAqB,GAAG,IAAA,mCAAmB,EAC/C,uBAAuB,EACvB;IACE;;OAEG;IACH,UAAU,EAAE;QACV,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE;QAC5D,WAAW,EAAE,kCAAkC;KAChD;IACD;;OAEG;IACH,WAAW,EAAE;QACX,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE;QAC7D,WAAW,EAAE,mCAAmC;KACjD;IACD;;OAEG;IACH,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE;QAC/D,WAAW,EAAE,2DAA2D;KACzE;IACD;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,+CAA+C;KAC7D;IACD;;OAEG;IACH,aAAa,EAAE;QACb,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,mDAAmD;KACjE;CACF,EACD;IACE,eAAe,EAAE,IAAI;IACrB;;OAEG;IACH,kBAAkB,EAAE,qBAAqB;CAC1C,CACF,CAAA;AAED,kBAAe,qBAAqB,CAAA"}
@@ -9,6 +9,11 @@ export default class TrixTextSearchAdapter extends BaseAdapter implements BaseTe
9
9
  trixJs: Trix;
10
10
  tracksNames?: string[];
11
11
  constructor(config: AnyConfigurationModel, getSubAdapter?: getSubAdapterType, pluginManager?: PluginManager);
12
+ /**
13
+ * Returns list of results
14
+ * @param args - search options/arguments include: search query
15
+ * limit of results to return, searchType...prefix | full | exact", etc.
16
+ */
12
17
  searchIndex(args: BaseArgs): Promise<BaseResult[]>;
13
18
  freeResources(): void;
14
19
  }
@@ -33,7 +33,7 @@ export default class TrixTextSearchAdapter extends BaseAdapter {
33
33
  }
34
34
  this.trixJs = new Trix(openLocation(ixxFilePath), openLocation(ixFilePath), 1500);
35
35
  }
36
- /*
36
+ /**
37
37
  * Returns list of results
38
38
  * @param args - search options/arguments include: search query
39
39
  * limit of results to return, searchType...prefix | full | exact", etc.
@@ -1,2 +1,2 @@
1
- declare const _default: import("@jbrowse/core/configuration").AnyConfigurationSchemaType;
2
- export default _default;
1
+ declare const TrixTextSearchAdapter: import("@jbrowse/core/configuration").AnyConfigurationSchemaType;
2
+ export default TrixTextSearchAdapter;
@@ -1,29 +1,55 @@
1
1
  import { ConfigurationSchema } from '@jbrowse/core/configuration';
2
- export default ConfigurationSchema('TrixTextSearchAdapter', {
2
+ /**
3
+ * #config TrixTextSearchAdapter
4
+ */
5
+ function x() { } // eslint-disable-line @typescript-eslint/no-unused-vars
6
+ const TrixTextSearchAdapter = ConfigurationSchema('TrixTextSearchAdapter', {
7
+ /**
8
+ * #slot
9
+ */
3
10
  ixFilePath: {
4
11
  type: 'fileLocation',
5
12
  defaultValue: { uri: 'out.ix', locationType: 'UriLocation' },
6
13
  description: 'the location of the trix ix file',
7
14
  },
15
+ /**
16
+ * #slot
17
+ */
8
18
  ixxFilePath: {
9
19
  type: 'fileLocation',
10
20
  defaultValue: { uri: 'out.ixx', locationType: 'UriLocation' },
11
21
  description: 'the location of the trix ixx file',
12
22
  },
23
+ /**
24
+ * #slot
25
+ */
13
26
  metaFilePath: {
14
27
  type: 'fileLocation',
15
28
  defaultValue: { uri: 'meta.json', locationType: 'UriLocation' },
16
29
  description: 'the location of the metadata json file for the trix index',
17
30
  },
31
+ /**
32
+ * #slot
33
+ */
18
34
  tracks: {
19
35
  type: 'stringArray',
20
36
  defaultValue: [],
21
37
  description: 'List of tracks covered by text search adapter',
22
38
  },
39
+ /**
40
+ * #slot
41
+ */
23
42
  assemblyNames: {
24
43
  type: 'stringArray',
25
44
  defaultValue: [],
26
45
  description: 'List of assemblies covered by text search adapter',
27
46
  },
28
- }, { explicitlyTyped: true, explicitIdentifier: 'textSearchAdapterId' });
47
+ }, {
48
+ explicitlyTyped: true,
49
+ /**
50
+ * #identifier
51
+ */
52
+ explicitIdentifier: 'textSearchAdapterId',
53
+ });
54
+ export default TrixTextSearchAdapter;
29
55
  //# sourceMappingURL=configSchema.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/TrixTextSearchAdapter/configSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAEjE,eAAe,mBAAmB,CAChC,uBAAuB,EACvB;IACE,UAAU,EAAE;QACV,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE;QAC5D,WAAW,EAAE,kCAAkC;KAChD;IACD,WAAW,EAAE;QACX,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE;QAC7D,WAAW,EAAE,mCAAmC;KACjD;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE;QAC/D,WAAW,EAAE,2DAA2D;KACzE;IACD,MAAM,EAAE;QACN,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,+CAA+C;KAC7D;IACD,aAAa,EAAE;QACb,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,mDAAmD;KACjE;CACF,EACD,EAAE,eAAe,EAAE,IAAI,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,CACrE,CAAA"}
1
+ {"version":3,"file":"configSchema.js","sourceRoot":"","sources":["../../src/TrixTextSearchAdapter/configSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAA;AAEjE;;GAEG;AACH,SAAS,CAAC,KAAI,CAAC,CAAC,wDAAwD;AAExE,MAAM,qBAAqB,GAAG,mBAAmB,CAC/C,uBAAuB,EACvB;IACE;;OAEG;IACH,UAAU,EAAE;QACV,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,YAAY,EAAE,aAAa,EAAE;QAC5D,WAAW,EAAE,kCAAkC;KAChD;IACD;;OAEG;IACH,WAAW,EAAE;QACX,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE;QAC7D,WAAW,EAAE,mCAAmC;KACjD;IACD;;OAEG;IACH,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE;QAC/D,WAAW,EAAE,2DAA2D;KACzE;IACD;;OAEG;IACH,MAAM,EAAE;QACN,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,+CAA+C;KAC7D;IACD;;OAEG;IACH,aAAa,EAAE;QACb,IAAI,EAAE,aAAa;QACnB,YAAY,EAAE,EAAE;QAChB,WAAW,EAAE,mDAAmD;KACjE;CACF,EACD;IACE,eAAe,EAAE,IAAI;IACrB;;OAEG;IACH,kBAAkB,EAAE,qBAAqB;CAC1C,CACF,CAAA;AAED,eAAe,qBAAqB,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jbrowse/plugin-trix",
3
- "version": "2.1.6",
3
+ "version": "2.2.0",
4
4
  "description": "JBrowse 2 trix text search adapter",
5
5
  "keywords": [
6
6
  "jbrowse",
@@ -54,5 +54,5 @@
54
54
  "distModule": "esm/index.js",
55
55
  "srcModule": "src/index.ts",
56
56
  "module": "esm/index.js",
57
- "gitHead": "df810d2a4f057adcd8f5345d54972508fba007a7"
57
+ "gitHead": "cf31db8d833117f8822510340664fb3f045975cb"
58
58
  }
@@ -62,7 +62,7 @@ export default class TrixTextSearchAdapter
62
62
  )
63
63
  }
64
64
 
65
- /*
65
+ /**
66
66
  * Returns list of results
67
67
  * @param args - search options/arguments include: search query
68
68
  * limit of results to return, searchType...prefix | full | exact", etc.
@@ -1,33 +1,61 @@
1
1
  import { ConfigurationSchema } from '@jbrowse/core/configuration'
2
2
 
3
- export default ConfigurationSchema(
3
+ /**
4
+ * #config TrixTextSearchAdapter
5
+ */
6
+ function x() {} // eslint-disable-line @typescript-eslint/no-unused-vars
7
+
8
+ const TrixTextSearchAdapter = ConfigurationSchema(
4
9
  'TrixTextSearchAdapter',
5
10
  {
11
+ /**
12
+ * #slot
13
+ */
6
14
  ixFilePath: {
7
15
  type: 'fileLocation',
8
16
  defaultValue: { uri: 'out.ix', locationType: 'UriLocation' },
9
17
  description: 'the location of the trix ix file',
10
18
  },
19
+ /**
20
+ * #slot
21
+ */
11
22
  ixxFilePath: {
12
23
  type: 'fileLocation',
13
24
  defaultValue: { uri: 'out.ixx', locationType: 'UriLocation' },
14
25
  description: 'the location of the trix ixx file',
15
26
  },
27
+ /**
28
+ * #slot
29
+ */
16
30
  metaFilePath: {
17
31
  type: 'fileLocation',
18
32
  defaultValue: { uri: 'meta.json', locationType: 'UriLocation' },
19
33
  description: 'the location of the metadata json file for the trix index',
20
34
  },
35
+ /**
36
+ * #slot
37
+ */
21
38
  tracks: {
22
39
  type: 'stringArray',
23
40
  defaultValue: [],
24
41
  description: 'List of tracks covered by text search adapter',
25
42
  },
43
+ /**
44
+ * #slot
45
+ */
26
46
  assemblyNames: {
27
47
  type: 'stringArray',
28
48
  defaultValue: [],
29
49
  description: 'List of assemblies covered by text search adapter',
30
50
  },
31
51
  },
32
- { explicitlyTyped: true, explicitIdentifier: 'textSearchAdapterId' },
52
+ {
53
+ explicitlyTyped: true,
54
+ /**
55
+ * #identifier
56
+ */
57
+ explicitIdentifier: 'textSearchAdapterId',
58
+ },
33
59
  )
60
+
61
+ export default TrixTextSearchAdapter