@jbrowse/core 5.0.0-beta.1 → 5.0.0-beta.2

package/esm/util/applyInitSettings.js

@@ -1,91 +0,0 @@
-import { applyPatch, getPropertyMembers } from '@jbrowse/mobx-state-tree';
-// Keys that are a view's identity or its plumbing rather than a setting. A
-// launch spec never gets to write these: `type` picks the view, `id` is passed
-// top-level so MST's optional identifier honors it, and `init` inside `init` is
-// the nesting mistake loadSessionSpec already reports.
-export const RESERVED_KEYS = ['id', 'type', 'init'];
-const RESERVED = new Set(RESERVED_KEYS);
-/**
- * Apply the plain-settings half of an `init` blob: every key naming a declared
- * MST property of `self` is written straight to it, and the caller handles only
- * the keys it names in `commands`.
- *
- * THE POINT IS THAT THERE IS NO PER-SETTING CODE. A view used to need a
- * hand-written `if (init.x !== undefined) self.setX(init.x)` arm per property,
- * so a new toggle worked from its menu the moment it was declared and was
- * dropped in silence from every authored surface — a session spec, a share
- * link, a config `defaultSession` — until someone remembered the second edit.
- * Nobody did: `drawLocationMarkers` shipped unauthorable, and DotplotView's
- * `alpha`/`drawCigar`/`lineWidth`/`lockAspectRatio` never had an arm at all.
- * Reading the property list off the model at runtime means declaring the
- * property IS declaring it authorable, including properties a composed mixin
- * brings in (colorBy, showColorLegend), and there is nothing left to keep in
- * sync.
- *
- * `commands` is what a launcher genuinely has to interpret: keys with no
- * property behind them (`loc`, `autoDiagonalize`), keys whose name collides
- * with a property meaning something else (a spec's `views` is a list of
- * assemblies to open; the model's `views` is the built rows), and keys with an
- * ordering constraint (`levelHeights` must land after the auto-scale pass).
- * Listing one is a decision to write code for it; everything else needs none.
- *
- * WRITTEN AS A PATCH, not through `setX`. Applying init is state restoration,
- * and the authority on that is MST: `applyPatch` validates each value against
- * the property's own type and touches nothing else, where `applySnapshot`
- * would rebuild the view's children. That it skips the setters is correct
- * rather than a shortcut — a session reload restores the same state from a
- * snapshot and calls no setters either, so a property needing a setter's side
- * effect to be correct is already broken on reload, and the effect belongs in a
- * reaction on the property.
- *
- * A value the property's type rejects is dropped and reported rather than
- * thrown: init blobs come from URLs, and one bad number should not cost the
- * reader the whole view.
- */
-export function applyInitSettings(self, 
-// `object` rather than a keyed record: an init blob's static type is the
-// view's own `ViewInit`, which has named members and no index signature — by
-// design, so a typo is a compile error there — and that is not assignable to
-// `Record<string, unknown>`. This reads it by enumeration anyway.
-init, { commands = [] } = {}) {
-    const report = { applied: [], unknown: [], invalid: [] };
-    if (!init) {
-        return report;
-    }
-    const skip = new Set(commands);
-    const { properties } = getPropertyMembers(self);
-    const patch = [];
-    for (const [key, value] of Object.entries(init)) {
-        if (skip.has(key) || RESERVED.has(key) || value === undefined) {
-            continue;
-        }
-        const propType = properties[key];
-        if (!propType) {
-            report.unknown.push(key);
-        }
-        else if (!propType.is(value)) {
-            report.invalid.push(key);
-        }
-        else {
-            patch.push({ op: 'replace', path: `/${key}`, value });
-            report.applied.push(key);
-        }
-    }
-    if (patch.length) {
-        applyPatch(self, patch);
-    }
-    return report;
-}
-/**
- * Say what `applyInitSettings` refused, naming the surface. Split from the
- * apply so a caller under test can assert the report without a console, and so
- * the two messages read the same wherever they come from.
- */
-export function warnInitSettings(surface, report) {
-    if (report.unknown.length) {
-        console.warn(`${surface} ignored unknown key(s): ${report.unknown.join(', ')}`);
-    }
-    if (report.invalid.length) {
-        console.warn(`${surface} ignored key(s) with an invalid value: ${report.invalid.join(', ')}`);
-    }
-}