@jbrowse/core 2.17.0 → 2.18.0

package/assemblyManager/assemblyConfigSchema.js

@@ -1,86 +1,52 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const configuration_1 = require("../configuration");
-/**
- * #config BaseAssembly
- * #category assemblyManagement
- * This corresponds to the assemblies section of the config
- */
 function assemblyConfigSchema(pluginManager) {
     return (0, configuration_1.ConfigurationSchema)('BaseAssembly', {
-        /**
-         * #slot
-         * aliases are "reference name aliases" e.g. aliases for hg38 might be
-         * "GRCh38"
-         */
         aliases: {
             type: 'stringArray',
             defaultValue: [],
             description: 'Other possible names for the assembly',
         },
-        /**
-         * #slot
-         * sequence refers to a reference sequence track that has an adapter
-         * containing, importantly, a sequence adapter such as
-         * IndexedFastaAdapter
-         */
         sequence: pluginManager.getTrackType('ReferenceSequenceTrack')
             .configSchema,
-        /**
-         * #slot
-         */
         refNameColors: {
             type: 'stringArray',
             defaultValue: [],
             description: 'Define custom colors for each reference sequence. Will cycle through this list if there are not enough colors for every sequence.',
         },
         refNameAliases: (0, configuration_1.ConfigurationSchema)('RefNameAliases', {
-            /**
-             * #slot refNameAliases.adapter
-             * refNameAliases help resolve e.g. chr1 and 1 as the same entity the
-             * data for refNameAliases are fetched from an adapter, that is
-             * commonly a tsv like chromAliases.txt from UCSC or similar
-             */
             adapter: pluginManager.pluggableConfigSchemaType('adapter'),
         }, {
             preProcessSnapshot: snap => {
-                // allow refNameAliases to be unspecified
-                if (!snap.adapter) {
-                    return { adapter: { type: 'RefNameAliasAdapter' } };
-                }
-                return snap;
+                return !snap.adapter
+                    ? {
+                        adapter: {
+                            type: 'RefNameAliasAdapter',
+                        },
+                    }
+                    : snap;
             },
         }),
         cytobands: (0, configuration_1.ConfigurationSchema)('Cytoband', {
-            /**
-             * #slot cytobands.adapter
-             * cytoband data is fetched from an adapter, and can be displayed by
-             * a view type as ideograms
-             */
             adapter: pluginManager.pluggableConfigSchemaType('adapter'),
         }, {
             preProcessSnapshot: snap => {
-                // allow cytoBand to be unspecified
                 return !snap.adapter
-                    ? { adapter: { type: 'CytobandAdapter' } }
+                    ? {
+                        adapter: {
+                            type: 'CytobandAdapter',
+                        },
+                    }
                     : snap;
             },
         }),
-        /**
-         * #slot
-         */
         displayName: {
             type: 'string',
             defaultValue: '',
             description: 'A human readable display name for the assembly e.g. "Homo sapiens (hg38)" while the assembly name may just be "hg38"',
         },
     }, {
-        /**
-         * #identifier name
-         * the name acts as a unique identifier in the config, so it cannot be
-         * duplicated. it usually a short human readable "id" like hg38, but you
-         * can also optionally customize the assembly "displayName" config slot
-         */
         explicitIdentifier: 'name',
     });
 }

package/assemblyManager/assemblyManager.d.ts

@@ -1,19 +1,10 @@
-import { IAnyType } from 'mobx-state-tree';
-import { AnyConfigurationModel } from '../configuration';
-import { Assembly } from './assembly';
-import PluginManager from '../PluginManager';
-import RpcManager from '../rpc/RpcManager';
+import type { AnyConfigurationModel } from '../configuration';
+import type { Assembly } from './assembly';
+import type PluginManager from '../PluginManager';
+import type RpcManager from '../rpc/RpcManager';
+import type { IAnyType } from 'mobx-state-tree';
 type AdapterConf = Record<string, unknown>;
-/**
- * #stateModel AssemblyManager
- */
 declare function assemblyManagerFactory(conf: IAnyType, pm: PluginManager): import("mobx-state-tree").IModelType<{
-    /**
-     * #property
-     * this is automatically managed by an autorun which looks in the parent
-     * session.assemblies, session.sessionAssemblies, and
-     * session.temporaryAssemblies
-     */
     assemblies: import("mobx-state-tree").IArrayType<import("mobx-state-tree").IModelType<{
         configuration: import("mobx-state-tree").IMaybe<import("mobx-state-tree").IReferenceType<IAnyType>>;
     }, {
@@ -228,9 +219,6 @@ declare function assemblyManagerFactory(conf: IAnyType, pm: PluginManager): impo
         }>;
     }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>>;
 } & {
-    /**
-     * #method
-     */
     get(asmName: string): ({
         configuration: any;
     } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
@@ -372,23 +360,10 @@ declare function assemblyManagerFactory(conf: IAnyType, pm: PluginManager): impo
             [x: string]: string;
         }>;
     }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>) | undefined;
-    /**
-     * #getter
-     */
     readonly assemblyNamesList: any[];
-    /**
-     * #getter
-     * looks at jbrowse.assemblies, session.sessionAssemblies, and
-     * session.temporaryAssemblies to load from
-     */
     readonly assemblyList: AnyConfigurationModel[];
     readonly rpcManager: RpcManager;
 } & {
-    /**
-     * #method
-     * use this method instead of assemblyManager.get(assemblyName)
-     * to get an assembly with regions loaded
-     */
     waitForAssembly(assemblyName: string): Promise<({
         configuration: any;
     } & import("mobx-state-tree/dist/internal").NonEmptyObject & {
@@ -530,47 +505,22 @@ declare function assemblyManagerFactory(conf: IAnyType, pm: PluginManager): impo
             [x: string]: string;
         }>;
     }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>>) | undefined>;
-    /**
-     * #method
-     */
     getRefNameMapForAdapter(adapterConf: AdapterConf, assemblyName: string | undefined, opts: {
-        signal?: AbortSignal;
+        stopToken?: string;
         sessionId: string;
     }): Promise<{
         [x: string]: string;
     } | undefined>;
-    /**
-     * #method
-     */
     getReverseRefNameMapForAdapter(adapterConf: AdapterConf, assemblyName: string | undefined, opts: {
-        signal?: AbortSignal;
+        stopToken?: string;
         sessionId: string;
     }): Promise<{
         [x: string]: string;
     } | undefined>;
-    /**
-     * #method
-     */
     isValidRefName(refName: string, assemblyName: string): boolean;
 } & {
     afterAttach(): void;
-    /**
-     * #action
-     * private: you would generally want to add to manipulate
-     * jbrowse.assemblies, session.sessionAssemblies, or
-     * session.temporaryAssemblies instead of using this directly
-     */
     removeAssembly(asm: Assembly): void;
-    /**
-     * #action
-     * private: you would generally want to add to manipulate
-     * jbrowse.assemblies, session.sessionAssemblies, or
-     * session.temporaryAssemblies instead of using this directly
-     *
-     * this can take an active instance of an assembly, in which case it is
-     * referred to, or it can take an identifier e.g. assembly name, which is
-     * used as a reference. snapshots cannot be used
-     */
     addAssembly(configuration: any): void;
 }, import("mobx-state-tree")._NotCustomized, import("mobx-state-tree")._NotCustomized>;
 export default assemblyManagerFactory;

package/assemblyManager/assemblyManager.js

@@ -3,24 +3,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const mobx_state_tree_1 = require("mobx-state-tree");
 const mobx_1 = require("mobx");
-// locals
-const util_1 = require("../util");
+const mobx_state_tree_1 = require("mobx-state-tree");
 const configuration_1 = require("../configuration");
+const util_1 = require("../util");
 const assembly_1 = __importDefault(require("./assembly"));
-/**
- * #stateModel AssemblyManager
- */
 function assemblyManagerFactory(conf, pm) {
     return mobx_state_tree_1.types
         .model({
-        /**
-         * #property
-         * this is automatically managed by an autorun which looks in the parent
-         * session.assemblies, session.sessionAssemblies, and
-         * session.temporaryAssemblies
-         */
         assemblies: mobx_state_tree_1.types.array((0, assembly_1.default)(conf, pm)),
     })
         .views(self => ({
@@ -35,26 +25,13 @@ function assemblyManagerFactory(conf, pm) {
         },
     }))
         .views(self => ({
-        /**
-         * #method
-         */
         get(asmName) {
             return self.assemblyNameMap[asmName];
         },
-        /**
-         * #getter
-         */
         get assemblyNamesList() {
             return this.assemblyList.map(asm => asm.name);
         },
-        /**
-         * #getter
-         * looks at jbrowse.assemblies, session.sessionAssemblies, and
-         * session.temporaryAssemblies to load from
-         */
         get assemblyList() {
-            // name is the explicit identifier and can be accessed without getConf,
-            // hence the union with {name:string}
             const { jbrowse: { assemblies }, session: { sessionAssemblies = [], temporaryAssemblies = [] } = {}, } = (0, mobx_state_tree_1.getParent)(self);
             return [
                 ...assemblies,
@@ -67,11 +44,6 @@ function assemblyManagerFactory(conf, pm) {
         },
     }))
         .views(self => ({
-        /**
-         * #method
-         * use this method instead of assemblyManager.get(assemblyName)
-         * to get an assembly with regions loaded
-         */
         async waitForAssembly(assemblyName) {
             if (!assemblyName) {
                 throw new Error('no assembly name supplied to waitForAssembly');
@@ -83,7 +55,6 @@ function assemblyManagerFactory(conf, pm) {
                     assembly = self.get(assemblyName);
                 }
                 catch (e) {
-                    // ignore
                 }
             }
             if (!assembly) {
@@ -92,14 +63,10 @@ function assemblyManagerFactory(conf, pm) {
             await assembly.load();
             await (0, util_1.when)(() => !!(assembly.regions && assembly.refNameAliases) || !!assembly.error);
             if (assembly.error) {
-                // eslint-disable-next-line @typescript-eslint/only-throw-error
                 throw assembly.error;
             }
             return assembly;
         },
-        /**
-         * #method
-         */
         async getRefNameMapForAdapter(adapterConf, assemblyName, opts) {
             if (assemblyName) {
                 const asm = await this.waitForAssembly(assemblyName);
@@ -107,9 +74,6 @@ function assemblyManagerFactory(conf, pm) {
             }
             return {};
         },
-        /**
-         * #method
-         */
         async getReverseRefNameMapForAdapter(adapterConf, assemblyName, opts) {
             if (assemblyName) {
                 const asm = await this.waitForAssembly(assemblyName);
@@ -117,9 +81,6 @@ function assemblyManagerFactory(conf, pm) {
             }
             return {};
         },
-        /**
-         * #method
-         */
         isValidRefName(refName, assemblyName) {
             const assembly = self.get(assemblyName);
             if (assembly) {
@@ -144,25 +105,9 @@ function assemblyManagerFactory(conf, pm) {
                 }
             }, { fireImmediately: true, name: 'assemblyManagerAfterAttach' }));
         },
-        /**
-         * #action
-         * private: you would generally want to add to manipulate
-         * jbrowse.assemblies, session.sessionAssemblies, or
-         * session.temporaryAssemblies instead of using this directly
-         */
         removeAssembly(asm) {
             self.assemblies.remove(asm);
         },
-        /**
-         * #action
-         * private: you would generally want to add to manipulate
-         * jbrowse.assemblies, session.sessionAssemblies, or
-         * session.temporaryAssemblies instead of using this directly
-         *
-         * this can take an active instance of an assembly, in which case it is
-         * referred to, or it can take an identifier e.g. assembly name, which is
-         * used as a reference. snapshots cannot be used
-         */
         addAssembly(configuration) {
             self.assemblies.push({ configuration });
         },

package/configuration/configurationSchema.d.ts

@@ -1,7 +1,7 @@
-import { IAnyType } from 'mobx-state-tree';
-import { ConfigSlotDefinition } from './configurationSlot';
-import { AnyConfigurationSchemaType } from './types';
-export type { AnyConfigurationSchemaType, AnyConfigurationModel, AnyConfigurationSlot, AnyConfigurationSlotType, } from './types';
+import type { ConfigSlotDefinition } from './configurationSlot';
+import type { AnyConfigurationSchemaType } from './types';
+import type { IAnyType } from 'mobx-state-tree';
+export type { AnyConfigurationModel, AnyConfigurationSchemaType, AnyConfigurationSlot, AnyConfigurationSlotType, } from './types';
 export interface ConfigurationSchemaDefinition {
     [n: string]: ConfigSlotDefinition | ConfigurationSchemaDefinition | string | number | IAnyType;
 }

package/configuration/configurationSchema.js

@@ -6,9 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationSchema = ConfigurationSchema;
 exports.ConfigurationReference = ConfigurationReference;
 const mobx_state_tree_1 = require("mobx-state-tree");
-const mst_1 = require("../util/types/mst");
 const configurationSlot_1 = __importDefault(require("./configurationSlot"));
 const util_1 = require("./util");
+const mst_1 = require("../util/types/mst");
 function isEmptyObject(thing) {
     return (typeof thing === 'object' &&
         !Array.isArray(thing) &&
@@ -23,8 +23,6 @@ function preprocessConfigurationSchemaArguments(modelName, inputSchemaDefinition
     if (typeof modelName !== 'string') {
         throw new Error('first arg must be string name of the model that this config schema goes with');
     }
-    // if we have a base configuration schema that we are
-    // extending, grab the slot definitions from that
     let schemaDefinition = inputSchemaDefinition;
     let options = inputOptions;
     if ((_a = inputOptions.baseConfiguration) === null || _a === void 0 ? void 0 : _a.jbrowseSchemaDefinition) {
@@ -41,7 +39,6 @@ function preprocessConfigurationSchemaArguments(modelName, inputSchemaDefinition
     return { schemaDefinition, options };
 }
 function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
-    // now assemble the MST model of the configuration schema
     const modelDefinition = {};
     let identifier;
     if (options.explicitlyTyped) {
@@ -81,8 +78,6 @@ function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
     Object.entries(schemaDefinition).forEach(([slotName, slotDefinition]) => {
         if (((0, mobx_state_tree_1.isType)(slotDefinition) && (0, mobx_state_tree_1.isLateType)(slotDefinition)) ||
             (0, util_1.isConfigurationSchemaType)(slotDefinition)) {
-            // this is either an MST late() type (which we assume to be a sub-configuration),
-            // or an actual sub-configuration
             modelDefinition[slotName] = slotDefinition;
         }
         else if (typeof slotDefinition === 'string' ||
@@ -90,7 +85,6 @@ function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
             volatileConstants[slotName] = slotDefinition;
         }
         else if (typeof slotDefinition === 'object') {
-            // this is a slot definition
             if (!slotDefinition.type) {
                 throw new Error(`no type set for config slot ${modelName}.${slotName}`);
             }
@@ -120,7 +114,7 @@ function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
         },
     }));
     if (Object.keys(volatileConstants).length) {
-        completeModel = completeModel.volatile(( /* self */) => volatileConstants);
+        completeModel = completeModel.volatile(() => volatileConstants);
     }
     if (options.actions) {
         completeModel = completeModel.actions(options.actions);
@@ -139,7 +133,6 @@ function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
     completeModel = completeModel.postProcessSnapshot(snap => {
         const newSnap = {};
         let matchesDefault = true;
-        // let keyCount = 0
         for (const [key, value] of Object.entries(snap)) {
             if (matchesDefault) {
                 if (typeof defaultSnap[key] === 'object' && typeof value === 'object') {
@@ -155,7 +148,6 @@ function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
                 volatileConstants[key] === undefined &&
                 !isEmptyObject(value) &&
                 !isEmptyArray(value)) {
-                // keyCount += 1
                 newSnap[key] = value;
             }
         }
@@ -172,15 +164,11 @@ function makeConfigurationSchemaModel(modelName, schemaDefinition, options) {
 function ConfigurationSchema(modelName, inputSchemaDefinition, inputOptions) {
     const { schemaDefinition, options } = preprocessConfigurationSchemaArguments(modelName, inputSchemaDefinition, inputOptions);
     const schemaType = makeConfigurationSchemaModel(modelName, schemaDefinition, options);
-    // saving a couple of jbrowse-specific things in the type object. hope nobody gets mad.
     schemaType.isJBrowseConfigurationSchema = true;
     schemaType.jbrowseSchemaDefinition = schemaDefinition;
     schemaType.jbrowseSchemaOptions = options;
     return schemaType;
 }
 function ConfigurationReference(schemaType) {
-    // we cast this to SCHEMATYPE, because the reference *should* behave just
-    // like the object it points to. It won't be undefined (this is a
-    // `reference`, not a `safeReference`)
     return mobx_state_tree_1.types.union(mobx_state_tree_1.types.reference(schemaType), schemaType);
 }

package/configuration/configurationSlot.d.ts

@@ -1,22 +1,11 @@
-import { IAnyModelType, IAnyComplexType } from 'mobx-state-tree';
+import type { IAnyComplexType, IAnyModelType } from 'mobx-state-tree';
 export interface ConfigSlotDefinition {
-    /** human-readable description of the slot's meaning */
     description?: string;
-    /** custom base MST model for the slot's value */
     model?: IAnyModelType | IAnyComplexType;
-    /** name of the type of slot, e.g. "string", "number", "stringArray" */
     type: string;
-    /** default value of the slot */
     defaultValue: any;
-    /** parameter names of the function callback */
     contextVariable?: string[];
 }
-/**
- * builds a MST model for a configuration slot
- *
- * @param slotName -
- * @param  definition -
- */
 export default function ConfigSlot(slotName: string, { description, model, type, defaultValue, contextVariable, }: ConfigSlotDefinition): import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IModelType<{
     name: import("mobx-state-tree").ISimpleType<string>;
     description: import("mobx-state-tree").ISimpleType<string>;

package/configuration/configurationSlot.js

@@ -2,11 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = ConfigSlot;
 const mobx_state_tree_1 = require("mobx-state-tree");
+const util_1 = require("../util");
 const jexlStrings_1 = require("../util/jexlStrings");
 const mst_1 = require("../util/types/mst");
-const util_1 = require("../util");
-function isValidColorString( /* str */) {
-    // TODO: check all the crazy cases for whether it's a valid HTML/CSS color string
+function isValidColorString() {
     return true;
 }
 const typeModels = {
@@ -22,7 +21,6 @@ const typeModels = {
     fileLocation: mst_1.FileLocation,
     frozen: mobx_state_tree_1.types.frozen(),
 };
-// default values we use if the defaultValue is malformed or does not work
 const fallbackDefaults = {
     stringArray: [],
     stringArrayMap: {},
@@ -50,14 +48,12 @@ const objectJSON = (self) => ({
         },
     },
 });
-// custom actions for modifying the value models
 const typeModelExtensions = {
     fileLocation: objectJSON,
     number: literalJSON,
     integer: literalJSON,
     boolean: literalJSON,
     frozen: objectJSON,
-    // special actions for working with stringArray slots
     stringArray: (self) => ({
         views: {
             get valueJSON() {
@@ -128,21 +124,10 @@ const typeModelExtensions = {
         },
     }),
 };
-// const FunctionStringType = types.refinement(
-//   'FunctionString',
-//   types.string,
-//   str => functionRegexp.test(str),
-// )
 const JexlStringType = mobx_state_tree_1.types.refinement('JexlString', mobx_state_tree_1.types.string, str => str.startsWith('jexl:'));
 function json(value) {
     return (value === null || value === void 0 ? void 0 : value.toJSON) ? value.toJSON() : `"${value}"`;
 }
-/**
- * builds a MST model for a configuration slot
- *
- * @param slotName -
- * @param  definition -
- */
 function ConfigSlot(slotName, { description = '', model, type, defaultValue, contextVariable = [], }) {
     if (!type) {
         throw new Error('type name required');
@@ -156,8 +141,6 @@ function ConfigSlot(slotName, { description = '', model, type, defaultValue, con
     if (defaultValue === undefined) {
         throw new Error("no 'defaultValue' provided");
     }
-    // if the `type` is something like `color`, then the model name
-    // here will be `ColorConfigSlot`
     const configSlotModelName = `${slotName
         .charAt(0)
         .toUpperCase()}${slotName.slice(1)}ConfigSlot`;
@@ -179,20 +162,14 @@ function ConfigSlot(slotName, { description = '', model, type, defaultValue, con
         .views(self => ({
         get expr() {
             if (self.isCallback) {
-                // compile as jexl function
                 const { pluginManager } = (0, util_1.getEnv)(self);
-                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
                 if (!pluginManager && typeof jest === 'undefined') {
                     console.warn('no pluginManager detected on config env (if you dynamically instantiate a config, for example in renderProps for your display model, check that you add the env argument)');
                 }
-                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
                 return (0, jexlStrings_1.stringToJexlExpression)(String(self.value), pluginManager === null || pluginManager === void 0 ? void 0 : pluginManager.jexl);
             }
             return { evalSync: () => self.value };
         },
-        // JS representation of the value of this slot, suitable
-        // for embedding in either JSON or a JS function string.
-        // many of the data types override this in typeModelExtensions
         get valueJSON() {
             if (self.isCallback) {
                 return undefined;
@@ -233,7 +210,6 @@ function ConfigSlot(slotName, { description = '', model, type, defaultValue, con
             if (!self.isCallback) {
                 return;
             }
-            // try calling it with no arguments
             try {
                 const funcResult = self.expr.evalSync();
                 if (funcResult !== undefined) {
@@ -242,20 +218,14 @@ function ConfigSlot(slotName, { description = '', model, type, defaultValue, con
                 }
             }
             catch (e) {
-                /* ignore */
             }
             self.value = defaultValue;
-            // if it is still a callback (happens if the defaultValue is a
-            // callback), then use the last-resort fallback default
-            // if defaultValue has jexl: string, run this part
             if (!(type in fallbackDefaults)) {
                 throw new Error(`no fallbackDefault defined for type ${type}`);
             }
             self.value = fallbackDefaults[type];
         },
     }));
-    // if there are any type-specific extensions (views or actions)
-    //  to the slot, add those in
     if (typeModelExtensions[type]) {
         slot = slot.extend(typeModelExtensions[type]);
     }

package/configuration/index.d.ts

@@ -1,3 +1,3 @@
-export { ConfigurationSchema, ConfigurationReference, } from './configurationSchema';
-export type { AnyConfigurationSchemaType, AnyConfigurationModel, AnyConfigurationSlot, AnyConfigurationSlotType, AnyConfiguration, } from './types';
+export { ConfigurationReference, ConfigurationSchema, } from './configurationSchema';
+export type { AnyConfiguration, AnyConfigurationModel, AnyConfigurationSchemaType, AnyConfigurationSlot, AnyConfigurationSlotType, } from './types';
 export * from './util';

package/configuration/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigurationReference = exports.ConfigurationSchema = void 0;
+exports.ConfigurationSchema = exports.ConfigurationReference = void 0;
 var configurationSchema_1 = require("./configurationSchema");
-Object.defineProperty(exports, "ConfigurationSchema", { enumerable: true, get: function () { return configurationSchema_1.ConfigurationSchema; } });
 Object.defineProperty(exports, "ConfigurationReference", { enumerable: true, get: function () { return configurationSchema_1.ConfigurationReference; } });
+Object.defineProperty(exports, "ConfigurationSchema", { enumerable: true, get: function () { return configurationSchema_1.ConfigurationSchema; } });
 __exportStar(require("./util"), exports);

package/configuration/types.d.ts

@@ -1,6 +1,6 @@
-import type { IStateTreeNode, Instance, SnapshotOut } from 'mobx-state-tree';
-import type { ConfigurationSchemaType, ConfigurationSchemaOptions } from './configurationSchema';
+import type { ConfigurationSchemaOptions, ConfigurationSchemaType } from './configurationSchema';
 import type ConfigSlot from './configurationSlot';
+import type { IStateTreeNode, Instance, SnapshotOut } from 'mobx-state-tree';
 export type GetOptions<SCHEMA> = SCHEMA extends ConfigurationSchemaType<any, infer OPTIONS> ? OPTIONS : never;
 export type GetBase<SCHEMA> = SCHEMA extends undefined ? never : GetOptions<SCHEMA> extends ConfigurationSchemaOptions<undefined, any> ? undefined : GetOptions<SCHEMA> extends ConfigurationSchemaOptions<infer BASE extends AnyConfigurationSchemaType, any> ? BASE : never;
 export type GetExplicitIdentifier<SCHEMA> = GetOptions<SCHEMA> extends ConfigurationSchemaOptions<any, infer EXPLICIT_IDENTIFIER extends string> ? EXPLICIT_IDENTIFIER : never;
@@ -10,6 +10,5 @@ export type AnyConfigurationSchemaType = ConfigurationSchemaType<any, any>;
 export type AnyConfigurationModel = Instance<AnyConfigurationSchemaType>;
 export type AnyConfigurationSlotType = ReturnType<typeof ConfigSlot>;
 export type AnyConfigurationSlot = Instance<AnyConfigurationSlotType>;
-/** any configuration model, or snapshot thereof */
 export type AnyConfiguration = AnyConfigurationModel | SnapshotOut<AnyConfigurationModel>;
 export type ConfigurationModel<SCHEMA extends AnyConfigurationSchemaType> = Instance<SCHEMA>;

package/configuration/util.d.ts

@@ -1,32 +1,8 @@
-import { AnyConfigurationModel, AnyConfigurationSchemaType, ConfigurationSlotName, ConfigurationSchemaForModel } from './types';
-/**
- * given a configuration model (an instance of a ConfigurationSchema),
- * read the configuration variable at the given path
- *
- * @param model - instance of ConfigurationSchema
- * @param slotPaths - array of paths to read
- * @param args - extra arguments e.g. for a feature callback,
- *  will be sent to each of the slotNames
- */
+import type { AnyConfigurationModel, AnyConfigurationSchemaType, ConfigurationSchemaForModel, ConfigurationSlotName } from './types';
 export declare function readConfObject<CONFMODEL extends AnyConfigurationModel>(confObject: CONFMODEL, slotPath?: ConfigurationSlotName<ConfigurationSchemaForModel<CONFMODEL>> | string[], args?: Record<string, unknown>): any;
-/**
- * helper method for readConfObject, reads the config from a mst model
- *
- * @param model - object containing a 'configuration' member
- * @param slotPaths - array of paths to read
- * @param args - extra arguments e.g. for a feature callback,
- *   will be sent to each of the slotNames
- */
 export declare function getConf<CONFMODEL extends AnyConfigurationModel>(model: {
     configuration: CONFMODEL;
 }, slotPath?: Parameters<typeof readConfObject<CONFMODEL>>[1], args?: Parameters<typeof readConfObject<CONFMODEL>>[2]): any;
-/**
- * given a union of explicitly typed configuration schema types,
- * extract an array of the type names contained in the union
- *
- * @param unionType -
- * @returns Array of type names contained in the union
- */
 export declare function getTypeNamesFromExplicitlyTypedUnion(maybeUnionType: unknown): string[];
 export declare function isBareConfigurationSchemaType(thing: unknown): thing is AnyConfigurationSchemaType;
 export declare function isConfigurationSchemaType(thing: unknown): thing is AnyConfigurationSchemaType;