@jbrowse/embedded-core 4.3.0 → 5.0.0-beta.10

package/esm/EmbeddedSessionMixin.js

@@ -0,0 +1,61 @@
+import { getParent, types } from '@jbrowse/mobx-state-tree';
+import { BaseSessionModel, ConnectionManagementSessionMixin, DrawerWidgetSessionMixin, ReferenceManagementSessionMixin, TrackMenuSessionMixin, } from '@jbrowse/product-core';
+import { EmbeddedSessionThemeMixin } from './EmbeddedSessionThemeMixin.js';
+/**
+ * #stateModel EmbeddedSessionMixin
+ * Everything the two single-view embedded products' sessions
+ * (react-linear-genome-view, react-circular-genome-view) share: the mixin set
+ * they compose and the three getters that read the root model. The twin of
+ * {@link createEmbeddedRootModel} one level down.
+ *
+ * Each product composes this mixin. A factory taking the product's view type
+ * and tracks mixin as parameters does not typecheck usefully:
+ * `types.compose`'s overloads are declared over `IModelType<P, O, FC, FS>`, so
+ * a model passed as a naked type parameter gives nothing to infer those four
+ * from, and `session.view` becomes `any` at every embedder call site with no
+ * type error. Passing only concrete types to `compose` keeps the products'
+ * views typed.
+ *
+ * Each product therefore declares its tracks mixin, `view` prop, and the
+ * `views`/`addView`/`removeView` members that read `self.view`, because those
+ * members need its concrete view type.
+ */
+export function EmbeddedSessionMixin(pluginManager) {
+    return types
+        .compose(BaseSessionModel(pluginManager), DrawerWidgetSessionMixin(pluginManager), ConnectionManagementSessionMixin(pluginManager), 
+    // ReferenceManagementSessionMixin and either tracks mixin share no
+    // members, so their order relative to each other is not load-bearing
+    ReferenceManagementSessionMixin(pluginManager), TrackMenuSessionMixin(pluginManager), EmbeddedSessionThemeMixin(pluginManager))
+        .views(self => ({
+        /**
+         * #getter
+         * An embedded view is drawn with no title bar above it, so its menu lives
+         * in the view's own controls.
+         */
+        get viewTitleBars() {
+            return false;
+        },
+        /**
+         * #getter
+         */
+        get version() {
+            return getParent(self).version;
+        },
+        /**
+         * #getter
+         */
+        // `assemblies` and `connections` are intentionally omitted:
+        // BaseSessionModel and ConnectionManagementSessionMixin already resolve
+        // them through `self.jbrowse` (= root.config), so re-declaring here would
+        // just duplicate the base getters with looser types
+        get assemblyNames() {
+            return getParent(self).config.assemblyNames;
+        },
+        /**
+         * #getter
+         */
+        get assemblyManager() {
+            return getParent(self).assemblyManager;
+        },
+    }));
+}