@jbrowse/mobx-state-tree 5.10.0 → 5.10.2

package/README.md

@@ -24,3 +24,4 @@ Fork of mobx-state-tree v5.4.2 for use in jbrowse
 - replaced `unique symbol` phantom properties (`$emptyObject`, `$stateTreeNodeType`) with
   exported string-keyed brand interfaces (`$EmptyObjectBrand`, `$__mstStateTreeNodeType__`),
   fixing tsgo TS4058/TS4023 errors when MST types propagate into exported function return types
+- add reflection api getChildType

package/dist/index.d.ts

@@ -1501,6 +1501,8 @@ declare function snapshotProcessor<IT extends IAnyType, CustomC = _NotCustomized
 /** @hidden */
 interface IMapType<IT extends IAnyType> extends IType<IKeyValueMap<IT["CreationType"]> | undefined, IKeyValueMap<IT["SnapshotType"]>, IMSTMap<IT>> {
     hooks(hooks: IHooksGetter<IMSTMap<IT>>): IMapType<IT>;
+    /** the value type of the map */
+    getChildType(): IAnyType;
 }
 /** @hidden */
 interface IMSTMap<IT extends IAnyType> {
@@ -1583,6 +1585,8 @@ interface IMSTArray<IT extends IAnyType> extends IObservableArray<IT["Type"]> {
 /** @hidden */
 interface IArrayType<IT extends IAnyType> extends IType<readonly IT["CreationType"][] | undefined, IT["SnapshotType"][], IMSTArray<IT>> {
     hooks(hooks: IHooksGetter<IMSTArray<IAnyType>>): IArrayType<IT>;
+    /** the element type of the array */
+    getChildType(): IAnyType;
 }
 /**
  * `types.array` - Creates an index based collection type who's children are all of a uniform declared type.
@@ -1858,6 +1862,19 @@ declare function union(dispatchOrType: UnionOptions | IAnyType, ...otherTypes: I
  * @returns
  */
 declare function isUnionType<IT extends IAnyType>(type: IT): type is IT;
+/**
+ * Returns the member types of a union.
+ *
+ * Wrapper types (`optional`, `refinement`, `late`) inherit the union flag from
+ * the type they wrap, so `isUnionType` is true for e.g. an optional-of-union,
+ * but their `getSubTypes()` reports the single wrapped type rather than the
+ * union's members. This drills through those wrappers until the union's member
+ * array surfaces.
+ *
+ * @param type a type for which `isUnionType` is true
+ * @returns the array of member types of the underlying union
+ */
+declare function getUnionSubtypes(type: IAnyType): IAnyType[];
 
 /** @hidden */
 type ValidOptionalValue = string | boolean | number | null | undefined;
@@ -1867,6 +1884,7 @@ type ValidOptionalValues = [ValidOptionalValue, ...ValidOptionalValue[]];
 type OptionalDefaultValueOrFunction<IT extends IAnyType> = IT["CreationType"] | IT["SnapshotType"] | (() => ExtractCSTWithSTN<IT>);
 /** @hidden */
 interface IOptionalIType<IT extends IAnyType, OptionalVals extends ValidOptionalValues> extends IType<IT["CreationType"] | OptionalVals[number], IT["SnapshotType"], IT["TypeWithoutSTN"]> {
+    getDefaultInstanceOrSnapshot(): IT["CreationType"] | IT["SnapshotType"];
 }
 declare function optional<IT extends IAnyType>(type: IT, defaultValueOrFunction: OptionalDefaultValueOrFunction<IT>): IOptionalIType<IT, [undefined]>;
 declare function optional<IT extends IAnyType, OptionalVals extends ValidOptionalValues>(type: IT, defaultValueOrFunction: OptionalDefaultValueOrFunction<IT>, optionalValues: OptionalVals): IOptionalIType<IT, OptionalVals>;
@@ -2130,5 +2148,5 @@ declare const types: {
     resilient: typeof resilient;
 };
 
-export { addDisposer, addMiddleware, applyAction, applyPatch, applySnapshot, cast, castFlowReturn, castToReferenceSnapshot, castToSnapshot, clone, createActionTrackingMiddleware, createActionTrackingMiddleware2, decorate, destroy, detach, escapeJsonPath, flow, getChildType, getEnv, getIdentifier, getLivelinessChecking, getMembers, getNodeId, getParent, getParentOfType, getPath, getPathParts, getPropertyMembers, getRelativePath, getRoot, getRunningActionContext, getSnapshot, getType, hasParent, hasParentOfType, isActionContextChildOf, isActionContextThisOrChildOf, isAlive, isArrayType, isFrozenType, isIdentifierType, isLateType, isLiteralType, isMapType, isModelType, isOptionalType, isPrimitiveType, isProtected, isReferenceType, isRefinementType, isRoot, isStateTreeNode, isType, isUnionType, isValidReference, joinJsonPath, onAction, onPatch, onSnapshot, process, protect, recordActions, recordPatches, resolveIdentifier, resolvePath, setDevMode, setLivelinessChecking, setLivelynessChecking, splitJsonPath, types as t, toGenerator, toGeneratorFunction, tryReference, tryResolve, typecheck, types, unescapeJsonPath, unprotect, walk };
+export { addDisposer, addMiddleware, applyAction, applyPatch, applySnapshot, cast, castFlowReturn, castToReferenceSnapshot, castToSnapshot, clone, createActionTrackingMiddleware, createActionTrackingMiddleware2, decorate, destroy, detach, escapeJsonPath, flow, getChildType, getEnv, getIdentifier, getLivelinessChecking, getMembers, getNodeId, getParent, getParentOfType, getPath, getPathParts, getPropertyMembers, getRelativePath, getRoot, getRunningActionContext, getSnapshot, getType, getUnionSubtypes, hasParent, hasParentOfType, isActionContextChildOf, isActionContextThisOrChildOf, isAlive, isArrayType, isFrozenType, isIdentifierType, isLateType, isLiteralType, isMapType, isModelType, isOptionalType, isPrimitiveType, isProtected, isReferenceType, isRefinementType, isRoot, isStateTreeNode, isType, isUnionType, isValidReference, joinJsonPath, onAction, onPatch, onSnapshot, process, protect, recordActions, recordPatches, resolveIdentifier, resolvePath, setDevMode, setLivelinessChecking, setLivelynessChecking, splitJsonPath, types as t, toGenerator, toGeneratorFunction, tryReference, tryResolve, typecheck, types, unescapeJsonPath, unprotect, walk };
 export type { $EmptyObjectBrand, CustomTypeOptions, IActionContext, IActionRecorder, IActionTrackingMiddleware2Call, IActionTrackingMiddleware2Hooks, IActionTrackingMiddlewareHooks, IAnyComplexType, IAnyModelType, IAnyStateTreeNode, IAnyType, IArrayType, IComplexType, IDisposer, IJsonPatch, IMSTArray, IMSTMap, IMapType, IMaybe, IMaybeIType, IMaybeNull, IMiddlewareEvent, IMiddlewareEventType, IMiddlewareHandler, IModelReflectionData, IModelReflectionPropertiesData, IModelType, IOptionalIType, IPatchRecorder, IReferenceType, IReversibleJsonPatch, ISerializedActionCall, ISimpleType, ISnapshotProcessor, ISnapshotProcessors, IStateTreeNode, IType, ITypeUnion, Instance, LivelinessMode, LivelynessMode, ModelActions, ModelCreationType, ModelCreationType2, ModelInstanceType, ModelInstanceTypeProps, ModelPrimitive, ModelProperties, ModelPropertiesDeclaration, ModelPropertiesDeclarationToProperties, ModelSnapshotType, ModelSnapshotType2, OnReferenceInvalidated, OnReferenceInvalidatedEvent, OptionalDefaultValueOrFunction, ReferenceIdentifier, ReferenceOptions, ReferenceOptionsGetSet, ReferenceOptionsOnInvalidated, SnapshotIn, SnapshotOrInstance, SnapshotOut, TypeOfValue, TypeOrStateTreeNodeToStateTreeNode, UnionOptions, UnionStringArray, ValidOptionalValue, ValidOptionalValues, _CustomCSProcessor, _CustomJoin, _CustomOrOther, _NotCustomized };

package/dist/mobx-state-tree.cjs

@@ -5747,6 +5747,33 @@ function union(optionsOrType, ...otherTypes) {
 function isUnionType(type) {
     return (type.flags & TypeFlags.Union) > 0;
 }
+/**
+ * Returns the member types of a union.
+ *
+ * Wrapper types (`optional`, `refinement`, `late`) inherit the union flag from
+ * the type they wrap, so `isUnionType` is true for e.g. an optional-of-union,
+ * but their `getSubTypes()` reports the single wrapped type rather than the
+ * union's members. This drills through those wrappers until the union's member
+ * array surfaces.
+ *
+ * @param type a type for which `isUnionType` is true
+ * @returns the array of member types of the underlying union
+ */
+function getUnionSubtypes(type) {
+    if (!isUnionType(type)) {
+        throw fail("expected a union type");
+    }
+    let subtypes = type.getSubTypes();
+    while (typeof subtypes === "object" &&
+        subtypes !== null &&
+        !Array.isArray(subtypes)) {
+        subtypes = subtypes.getSubTypes();
+    }
+    if (!Array.isArray(subtypes)) {
+        throw fail("could not extract subtypes from union type");
+    }
+    return subtypes;
+}
 
 /**
  * @hidden
@@ -6956,6 +6983,7 @@ exports.getRoot = getRoot;
 exports.getRunningActionContext = getRunningActionContext;
 exports.getSnapshot = getSnapshot;
 exports.getType = getType;
+exports.getUnionSubtypes = getUnionSubtypes;
 exports.hasParent = hasParent;
 exports.hasParentOfType = hasParentOfType;
 exports.isActionContextChildOf = isActionContextChildOf;