Add outline for LocalDriver

Author: garrettjstevens

packages/apollo-mst/src/ApolloAssembly.ts

@@ -2,15 +2,18 @@ import { type Instance, type SnapshotIn, types } from '@jbrowse/mobx-state-tree'
 
 import { ApolloRefSeq } from './ApolloRefSeq.js'
 
-export type BackendDriverType = 'CollaborationServerDriver'
+export type BackendDriverType = 'CollaborationServerDriver' | 'LocalDriver'
 
 export const ApolloAssembly = types
   .model('ApolloAssembly', {
     _id: types.identifier,
     refSeqs: types.map(ApolloRefSeq),
     comments: types.array(types.string),
     backendDriverType: types.optional(
-      types.enumeration('backendDriverType', ['CollaborationServerDriver']),
+      types.enumeration('backendDriverType', [
+        'CollaborationServerDriver',
+        'LocalDriver',
+      ]),
       'CollaborationServerDriver',
     ),
   })

packages/jbrowse-plugin-apollo/local.config.json

@@ -0,0 +1,68 @@
+{
+  "assemblies": [
+    {
+      "name": "volvox",
+      "sequence": {
+        "type": "ReferenceSequenceTrack",
+        "trackId": "volvox_refseq",
+        "adapter": {
+          "type": "TwoBitAdapter",
+          "twoBitLocation": {
+            "uri": "test_data/volvox.2bit",
+            "locationType": "UriLocation"
+          }
+        }
+      }
+    }
+  ],
+  "defaultSession": {
+    "name": "Apollo",
+    "views": [{ "type": "LinearGenomeView" }]
+  },
+  "tracks": [
+    {
+      "type": "ApolloTrack",
+      "trackId": "apollo_track_volvox",
+      "name": "Apollo Annotations",
+      "assemblyNames": ["volvox"]
+    },
+    {
+      "type": "FeatureTrack",
+      "trackId": "gff3tabix_genes",
+      "assemblyNames": ["volvox"],
+      "name": "GFF3Tabix genes",
+      "adapter": {
+        "type": "Gff3TabixAdapter",
+        "gffGzLocation": {
+          "uri": "test_data/volvox.sort.gff3.gz",
+          "locationType": "UriLocation"
+        },
+        "index": {
+          "location": {
+            "uri": "test_data/volvox.sort.gff3.gz.tbi",
+            "locationType": "UriLocation"
+          }
+        }
+      }
+    }
+  ],
+  "plugins": [
+    {
+      "name": "Apollo",
+      "url": "http://localhost:9000/dist/jbrowse-plugin-apollo.umd.development.js"
+    }
+  ],
+  "configuration": {
+    "ApolloPlugin": {
+      "ontologies": [
+        {
+          "name": "Sequence Ontology",
+          "source": {
+            "uri": "http://localhost:9000/test_data/so-v3.1.json",
+            "locationType": "UriLocation"
+          }
+        }
+      ]
+    }
+  }
+}

packages/jbrowse-plugin-apollo/src/BackendDrivers/LocalDriver.ts

@@ -0,0 +1,52 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/require-await */
+import type { Change } from '@apollo-annotation/common'
+import type {
+  AnnotationFeatureSnapshot,
+  CheckResultSnapshot,
+} from '@apollo-annotation/mst'
+import { ValidationResultSet } from '@apollo-annotation/shared'
+import type { Assembly } from '@jbrowse/core/assemblyManager/assembly'
+import type { Region } from '@jbrowse/core/util'
+
+import type { SubmitOpts } from '../ChangeManager'
+
+import { BackendDriver, type RefNameAliases } from './BackendDriver'
+
+export class LocalDriver extends BackendDriver {
+  async getFeatures(
+    region: Region,
+  ): Promise<[AnnotationFeatureSnapshot[], CheckResultSnapshot[]]> {
+    return [[], []]
+  }
+
+  async getSequence(region: Region): Promise<{ seq: string; refSeq: string }> {
+    return { seq: '', refSeq: '' }
+  }
+
+  async getRegions(assemblyName: string): Promise<Region[]> {
+    return []
+  }
+
+  getAssemblies(internetAccountConfigId?: string): Assembly[] {
+    return []
+  }
+
+  async getRefNameAliases(assemblyName: string): Promise<RefNameAliases[]> {
+    return []
+  }
+
+  async submitChange(
+    change: Change,
+    opts: SubmitOpts,
+  ): Promise<ValidationResultSet> {
+    return new ValidationResultSet()
+  }
+
+  async searchFeatures(
+    term: string,
+    assemblies: string[],
+  ): Promise<AnnotationFeatureSnapshot[]> {
+    return []
+  }
+}

packages/jbrowse-plugin-apollo/src/BackendDrivers/index.ts

@@ -1,2 +1,3 @@
 export * from './BackendDriver'
+export * from './LocalDriver'
 export * from './CollaborationServerDriver'

packages/jbrowse-plugin-apollo/src/session/ClientDataStore.ts

@@ -37,6 +37,7 @@ import {
   type ApolloInternetAccount,
   type BackendDriver,
   CollaborationServerDriver,
+  LocalDriver,
 } from '../BackendDrivers'
 import { ChangeManager } from '../ChangeManager'
 import {
@@ -159,6 +160,7 @@ export function clientDataStoreFactory(
       collaborationServerDriver: new CollaborationServerDriver(
         self as ClientDataStoreModel,
       ),
+      localDriver: new LocalDriver(self as ClientDataStoreModel),
     }))
     .actions((self) => ({
       afterCreate() {
@@ -243,6 +245,7 @@ export function clientDataStoreFactory(
         if (internetAccountConfigId) {
           return self.collaborationServerDriver
         }
+        return self.localDriver
       },
       getInternetAccount(assemblyName?: string, internetAccountId?: string) {
         if (!(assemblyName ?? internetAccountId)) {