@apollo-annotation/shared 0.3.5 → 0.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo-annotation/shared",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "main": "./dist/index.js",
   "scripts": {
     "build": "yarn clean && tsc --build",
@@ -10,9 +10,9 @@
     "test:ci": "NODE_V8_COVERAGE=./coverage glob -c \"tsx --test --test-reporter spec --experimental-test-coverage \" \"**/*.test.ts\""
   },
   "dependencies": {
-    "@apollo-annotation/common": "^0.3.5",
-    "@apollo-annotation/mst": "^0.3.5",
-    "@apollo-annotation/schemas": "^0.3.5",
+    "@apollo-annotation/common": "^0.3.6",
+    "@apollo-annotation/mst": "^0.3.6",
+    "@apollo-annotation/schemas": "^0.3.6",
     "@gmod/gff": "1.2.0",
     "@gmod/indexedfasta": "^2.0.4",
     "@jbrowse/core": "^3.0.1",

package/src/Changes/AddAssemblyAndFeaturesFromFileChange.ts

@@ -1,13 +1,13 @@
 /* eslint-disable @typescript-eslint/require-await */
 
 import {
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedAssemblySpecificChange,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedAssemblySpecificChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { GFF3Feature } from '@gmod/gff'
+import { type GFF3Feature } from '@gmod/gff'
 
 import { FromFileBaseChange } from './FromFileBaseChange'
 

package/src/Changes/AddAssemblyFromExternalChange.ts

@@ -4,11 +4,11 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
   AssemblySpecificChange,
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedAssemblySpecificChange,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedAssemblySpecificChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 import { BgzipIndexedFasta, IndexedFasta } from '@gmod/indexedfasta'
 import { RemoteFile } from 'generic-filehandle'

package/src/Changes/AddAssemblyFromFileChange.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
 /* eslint-disable @typescript-eslint/require-await */
 import {
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedAssemblySpecificChange,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedAssemblySpecificChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 import { BgzipIndexedFasta } from '@gmod/indexedfasta'
 

package/src/Changes/AddFeatureChange.ts

@@ -3,14 +3,14 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
+import { type AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
 
 import { DeleteFeatureChange } from './DeleteFeatureChange'
 

package/src/Changes/AddFeaturesFromFileChange.ts

@@ -1,12 +1,12 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedAssemblySpecificChange,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedAssemblySpecificChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { GFF3Feature } from '@gmod/gff'
+import { type GFF3Feature } from '@gmod/gff'
 
 import { FromFileBaseChange } from './FromFileBaseChange'
 

package/src/Changes/AddRefSeqAliasesChange.ts

@@ -1,11 +1,11 @@
 import {
   AssemblySpecificChange,
-  Change,
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedAssemblySpecificChange,
-  ServerDataStore,
+  type Change,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedAssemblySpecificChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 import { getSession } from '@jbrowse/core/util'
 

package/src/Changes/DeleteAssemblyChange.ts

@@ -4,10 +4,10 @@
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 import {
   AssemblySpecificChange,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedAssemblySpecificChange,
-  ServerDataStore,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedAssemblySpecificChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 import { getSession } from '@jbrowse/core/util'
 

package/src/Changes/DeleteFeatureChange.ts

@@ -2,15 +2,15 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
-import { Feature } from '@apollo-annotation/schemas'
+import { type AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
+import { type Feature } from '@apollo-annotation/schemas'
 
 import { AddFeatureChange } from './AddFeatureChange'
 

package/src/Changes/DeleteUserChange.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
   Change,
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedChange,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 
 export interface SerializedDeleteUserChangeBase extends SerializedChange {

package/src/Changes/FeatureAttributeChange.ts

@@ -2,14 +2,14 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { Feature, FeatureDocument } from '@apollo-annotation/schemas'
+import { type Feature, type FeatureDocument } from '@apollo-annotation/schemas'
 
 interface SerializedFeatureAttributeChangeBase extends SerializedFeatureChange {
   typeName: 'FeatureAttributeChange'

package/src/Changes/FromFileBaseChange.ts

@@ -5,10 +5,13 @@
 /* eslint-disable @typescript-eslint/no-unsafe-argument */
 import {
   AssemblySpecificChange,
-  ServerDataStore,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { FileDocument, RefSeqDocument } from '@apollo-annotation/schemas'
-import { GFF3Feature } from '@gmod/gff'
+import {
+  type FileDocument,
+  type RefSeqDocument,
+} from '@apollo-annotation/schemas'
+import { type GFF3Feature } from '@gmod/gff'
 
 import { gff3ToAnnotationFeature } from '../GFF3'
 

package/src/Changes/ImportJBrowseConfigChange.ts

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
   Change,
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 
 interface JBrowseAssembly {

package/src/Changes/LocationEndChange.ts

@@ -2,14 +2,14 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { Feature, FeatureDocument } from '@apollo-annotation/schemas'
+import { type Feature, type FeatureDocument } from '@apollo-annotation/schemas'
 
 interface SerializedLocationEndChangeBase extends SerializedFeatureChange {
   typeName: 'LocationEndChange'

package/src/Changes/LocationStartChange.ts

@@ -2,14 +2,14 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { Feature, FeatureDocument } from '@apollo-annotation/schemas'
+import { type Feature, type FeatureDocument } from '@apollo-annotation/schemas'
 
 interface SerializedLocationStartChangeBase extends SerializedFeatureChange {
   typeName: 'LocationStartChange'

package/src/Changes/StrandChange.ts

@@ -2,14 +2,14 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { Feature, FeatureDocument } from '@apollo-annotation/schemas'
+import { type Feature, type FeatureDocument } from '@apollo-annotation/schemas'
 
 interface SerializedStrandChangeBase extends SerializedFeatureChange {
   typeName: 'StrandChange'

package/src/Changes/TypeChange.ts

@@ -2,14 +2,14 @@
 /* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 import {
-  ChangeOptions,
-  ClientDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
   FeatureChange,
-  LocalGFF3DataStore,
-  SerializedFeatureChange,
-  ServerDataStore,
+  type LocalGFF3DataStore,
+  type SerializedFeatureChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
-import { Feature, FeatureDocument } from '@apollo-annotation/schemas'
+import { type Feature, type FeatureDocument } from '@apollo-annotation/schemas'
 
 interface SerializedTypeChangeBase extends SerializedFeatureChange {
   typeName: 'TypeChange'

package/src/Changes/UserChange.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
   Change,
-  ChangeOptions,
-  ClientDataStore,
-  LocalGFF3DataStore,
-  SerializedChange,
-  ServerDataStore,
+  type ChangeOptions,
+  type ClientDataStore,
+  type LocalGFF3DataStore,
+  type SerializedChange,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 
 export interface SerializedUserChangeBase extends SerializedChange {

package/src/Checks/CDSCheck.ts

@@ -1,7 +1,7 @@
 import { Check } from '@apollo-annotation/common'
 import {
-  AnnotationFeatureSnapshot,
-  CheckResultSnapshot,
+  type AnnotationFeatureSnapshot,
+  type CheckResultSnapshot,
 } from '@apollo-annotation/mst'
 import { intersection2 } from '@jbrowse/core/util'
 import ObjectID from 'bson-objectid'

package/src/GFF3/annotationFeatureToGFF3.test.ts

@@ -1,10 +1,12 @@
 /* eslint-disable prefer-destructuring */
 /* eslint-disable @typescript-eslint/no-floating-promises */
 import { describe, it } from 'node:test'
+
+import { type AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
 import { assert } from 'chai'
-import { readAnnotationFeatureSnapshot } from './gff3ToAnnotationFeature.test'
+
 import { annotationFeatureToGFF3 } from './annotationFeatureToGFF3'
-import { AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
+import { readAnnotationFeatureSnapshot } from './gff3ToAnnotationFeature.test'
 
 describe('annotationFeatureToGFF3', () => {
   it('Test mandatory columns', () => {

package/src/GFF3/annotationFeatureToGFF3.ts

@@ -1,11 +1,11 @@
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 
 import {
-  AnnotationFeatureSnapshot,
-  TranscriptPartLocation,
-  TranscriptPartNonCoding,
+  type AnnotationFeatureSnapshot,
+  type TranscriptPartLocation,
+  type TranscriptPartNonCoding,
 } from '@apollo-annotation/mst'
-import { GFF3Feature } from '@gmod/gff'
+import { type GFF3Feature } from '@gmod/gff'
 import { intersection2 } from '@jbrowse/core/util'
 
 export function annotationFeatureToGFF3(

package/src/GFF3/gff3ToAnnotationFeature.test.ts

@@ -1,13 +1,13 @@
 /* eslint-disable @typescript-eslint/no-floating-promises */
-import { describe, it } from 'node:test'
 import { readFileSync } from 'node:fs'
+import { describe, it } from 'node:test'
 
-import gff, { GFF3Feature } from '@gmod/gff'
+import { type AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
+import gff, { type GFF3Feature } from '@gmod/gff'
 import { assert, use } from 'chai'
 import chaiExclude from 'chai-exclude'
 
 import { gff3ToAnnotationFeature } from './gff3ToAnnotationFeature'
-import { AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
 
 use(chaiExclude)
 

package/src/GFF3/gff3ToAnnotationFeature.ts

@@ -1,5 +1,5 @@
-import { AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
-import { GFF3Feature, GFF3FeatureLineWithRefs } from '@gmod/gff'
+import { type AnnotationFeatureSnapshot } from '@apollo-annotation/mst'
+import { type GFF3Feature, type GFF3FeatureLineWithRefs } from '@gmod/gff'
 import { doesIntersect2 } from '@jbrowse/core/util'
 import ObjectID from 'bson-objectid'
 

package/src/GFF3/gffReservedKeys.ts

@@ -59,3 +59,28 @@ export const internalToGFF: Record<GFFInternalAttribute, GFFReservedAttribute> =
     gff_ontology_term: 'Ontology_term',
     gff_is_circular: 'Is_circular',
   }
+
+export function isGFFInternalAttribute(
+  attribute: string,
+): attribute is GFFInternalAttribute {
+  return attribute in internalToGFF
+}
+
+export type GFFColumn = 'score' | 'source'
+export type GFFColumnInternal = 'gff_score' | 'gff_source'
+export const gffColumnToInternal: Record<GFFColumn, GFFColumnInternal> = {
+  score: 'gff_score',
+  source: 'gff_source',
+}
+export function isGFFColumn(attribute: string): attribute is GFFColumn {
+  return attribute in gffColumnToInternal
+}
+export const gffInternalToColumn: Record<GFFColumnInternal, GFFColumn> = {
+  gff_score: 'score',
+  gff_source: 'source',
+}
+export function isGFFColumnInternal(
+  column: string,
+): column is GFFColumnInternal {
+  return column in gffInternalToColumn
+}

package/src/Messages.ts

@@ -1,5 +1,5 @@
-import { SerializedChange } from '@apollo-annotation/common'
-import { CheckResultSnapshot } from '@apollo-annotation/mst'
+import { type SerializedChange } from '@apollo-annotation/common'
+import { type CheckResultSnapshot } from '@apollo-annotation/mst'
 
 interface BaseMessage {
   channel: string

package/src/Operations/GetAssembliesOperation.ts

@@ -1,9 +1,9 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
-  LocalGFF3DataStore,
+  type LocalGFF3DataStore,
   Operation,
-  SerializedOperation,
-  ServerDataStore,
+  type SerializedOperation,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 
 interface SerializedGetAssembliesOperation extends SerializedOperation {

package/src/Operations/GetFeaturesOperation.ts

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/require-await */
 import {
-  LocalGFF3DataStore,
+  type LocalGFF3DataStore,
   Operation,
-  OperationOptions,
-  SerializedOperation,
-  ServerDataStore,
+  type OperationOptions,
+  type SerializedOperation,
+  type ServerDataStore,
 } from '@apollo-annotation/common'
 
 interface SerializedGetFeaturesOperation extends SerializedOperation {

package/src/Validations/CoreValidation.ts

@@ -1,9 +1,10 @@
 /* eslint-disable @typescript-eslint/require-await */
-import { Change } from '@apollo-annotation/common'
+import { type Change } from '@apollo-annotation/common'
+
+import { type TypeChange } from '../Changes'
 
-import { TypeChange } from '../Changes'
-import soSequenceTypes from './soSequenceTypes'
 import { Validation } from './Validation'
+import soSequenceTypes from './soSequenceTypes'
 
 export function isTypeChange(thing: Change): thing is TypeChange {
   return 'oldType' in thing && 'newType' in thing

package/src/Validations/ParentChildValidation.ts

@@ -1,16 +1,17 @@
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 /* eslint-disable @typescript-eslint/restrict-template-expressions */
-import { Change } from '@apollo-annotation/common'
-import { Feature, FeatureDocument } from '@apollo-annotation/schemas'
-import { ClientSession, Model } from 'mongoose'
+import { type Change } from '@apollo-annotation/common'
+import { type Feature, type FeatureDocument } from '@apollo-annotation/schemas'
+import { type ClientSession, type Model } from 'mongoose'
 
 import {
-  LocationEndChange,
-  LocationStartChange,
+  type LocationEndChange,
+  type LocationStartChange,
   isLocationEndChange,
   isLocationStartChange,
 } from '../Changes'
-import { Validation, ValidationResult } from './Validation'
+
+import { Validation, type ValidationResult } from './Validation'
 
 export class ParentChildValidation extends Validation {
   name = 'ParentChildValidation' as const

package/src/Validations/Validation.ts

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/no-unnecessary-condition */
 /* eslint-disable @typescript-eslint/require-await */
-import { Change, ClientDataStore } from '@apollo-annotation/common'
-import { FeatureDocument } from '@apollo-annotation/schemas'
-import type { ExecutionContext } from '@nestjs/common'
-import type { Reflector } from '@nestjs/core'
-import { ClientSession, Model } from 'mongoose'
+import { type Change, type ClientDataStore } from '@apollo-annotation/common'
+import { type FeatureDocument } from '@apollo-annotation/schemas'
+import { type ExecutionContext } from '@nestjs/common'
+import { type Reflector } from '@nestjs/core'
+import { type ClientSession, type Model } from 'mongoose'
 
 export interface Context {
   context: ExecutionContext

package/src/Validations/ValidationSet.ts

@@ -1,8 +1,12 @@
-import { Change, ClientDataStore } from '@apollo-annotation/common'
-import { FeatureDocument } from '@apollo-annotation/schemas'
-import { ClientSession, Model } from 'mongoose'
+import { type Change, type ClientDataStore } from '@apollo-annotation/common'
+import { type FeatureDocument } from '@apollo-annotation/schemas'
+import { type ClientSession, type Model } from 'mongoose'
 
-import { Context, Validation, ValidationResult } from './Validation'
+import {
+  type Context,
+  type Validation,
+  type ValidationResult,
+} from './Validation'
 
 export class ValidationResultSet {
   results: ValidationResult[] = []

package/test_data/example01.json

@@ -30,7 +30,7 @@
           "refSeq": "chr1",
           "type": "exon",
           "min": 1049,
-          "max": 1500,
+          "max": 1499,
           "strand": 1,
           "attributes": {
             "gff_id": ["exon10002"]
@@ -100,7 +100,7 @@
           "refSeq": "chr1",
           "type": "exon",
           "min": 1049,
-          "max": 1500,
+          "max": 1499,
           "strand": 1,
           "attributes": {
             "gff_id": ["exon10002"]
@@ -159,7 +159,7 @@
           "refSeq": "chr1",
           "type": "exon",
           "min": 1299,
-          "max": 1500,
+          "max": 1499,
           "strand": 1,
           "attributes": {
             "gff_id": ["exon10001"]

package/test_data/example02.json

@@ -19,7 +19,7 @@
           "refSeq": "chr1",
           "type": "exon",
           "min": 11049,
-          "max": 11500,
+          "max": 11499,
           "strand": 1,
           "attributes": {
             "gff_id": ["exon20001"]
@@ -89,7 +89,7 @@
           "refSeq": "chr1",
           "type": "exon",
           "min": 11049,
-          "max": 11500,
+          "max": 11499,
           "strand": 1,
           "attributes": {
             "gff_id": ["exon20002"]
@@ -148,7 +148,7 @@
           "refSeq": "chr1",
           "type": "exon",
           "min": 11299,
-          "max": 11500,
+          "max": 11499,
           "strand": 1,
           "attributes": {
             "gff_id": ["exon20003"]