@singularsystems/neo-core 1.0.0-alpha.3 → 1.0.0-beta.0

package/dist/Model/EnumHelper.js

@@ -1,100 +1,104 @@
-import { StaticDataSource } from '../Data';
-var EnumDecorator = /** @class */ (function () {
-    function EnumDecorator(enumType) {
-        this.enumType = enumType;
-        enumType[EnumDecorator.enumDescriptorSymbol] = {};
-    }
-    /**
-     * Describe the enum item.
-     * @param enumItem Item you are describing.
-     * @param display Display name to use, e.g. for use in drop downs.
-     * @param description Additional description about the item.
-     * @param order Override sort order.
-     */
-    EnumDecorator.prototype.describe = function (enumItem, display, description, order) {
-        this.enumType[EnumDecorator.enumDescriptorSymbol][enumItem] = { display: display, description: description, order: order };
-    };
-    EnumDecorator.enumDescriptorSymbol = Symbol("Neo.EnumDescriptor");
-    return EnumDecorator;
-}());
-var EnumHelper = /** @class */ (function () {
-    function EnumHelper() {
-    }
-    /**
-     * Decorate an enum and it's items.
-     * @param enumType The enum.
-     * @param callback Callback decorator. E.g: e.describe(Enum.Item1, "Display Value")
-     */
-    EnumHelper.decorateEnum = function (enumType, callback) {
-        var helper = new EnumDecorator(enumType);
-        callback(helper);
-    };
-    /**
-     * Creates a static datasource from an Enum.
-     */
-    EnumHelper.asDatasource = function (enumType) {
-        return StaticDataSource.fromEnum(enumType);
-    };
-    /**
-     * Creates a list of IEnumItem from an enum, using the enum decorator data.
-     */
-    EnumHelper.asList = function (enumObject) {
-        var descriptorMap = enumObject[EnumDecorator.enumDescriptorSymbol] || {};
-        var keys = Object.keys(enumObject).filter(function (key) { return typeof enumObject[key] === "number"; });
-        var items = [];
-        if (keys.length === 0) {
-            // String enum type.
-            keys = Object.keys(enumObject);
-        }
-        var index = keys.length;
-        for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
-            var key = keys_1[_i];
-            var id = enumObject[key];
-            var name_1 = void 0, description = void 0;
-            var itemDescriptor = descriptorMap[id];
-            if (itemDescriptor) {
-                name_1 = itemDescriptor.display;
-                description = itemDescriptor.description;
-            }
-            else {
-                name_1 = key.readable();
-            }
-            items.push({ id: id, name: name_1, description: description, order: itemDescriptor && itemDescriptor.order !== undefined ? itemDescriptor.order : index });
-            index += 1;
-        }
-        return items.sortBy(function (c) { return c.order; }).map(function (item) { return ({ id: item.id, name: item.name, description: item.description }); });
-    };
-    /**
-     * Gets the metadata for an enum item.
-     * @param enumType Enum object. E.g. Status
-     * @param enumItem Enum item. E.g. Status.Pending
-     */
-    EnumHelper.getItemMetadata = function (enumType, enumItem) {
-        var descriptorMap = enumType[EnumDecorator.enumDescriptorSymbol] || {};
-        var itemDescriptor = descriptorMap[enumItem];
-        var name = enumType[enumItem];
-        if (!itemDescriptor) {
-            itemDescriptor = name ? { name: name, display: name.readable() } : { name: enumItem.toString(), display: enumItem.toString() };
-        }
-        else {
-            itemDescriptor.name = name;
-        }
-        return itemDescriptor;
-    };
-    /**
-     * Returns `true` if this item looks like an enum item.
-     *
-     * E.g. has an `id` and `name` property.
-     */
-    EnumHelper.isEnumItem = function (item) {
-        if (typeof item === "object") {
-            var properties = Object.getOwnPropertyNames(item);
-            if (properties.length <= 3 && properties.some(function (c) { return c === "id"; }) && properties.some(function (c) { return c === "name"; })) {
-                return true;
-            }
-        }
-        return false;
-    };
-    return EnumHelper;
-}());
-export { EnumHelper };
+import { StaticDataSource } from '../Data';
+var EnumDecorator = /** @class */ (function () {
+    function EnumDecorator(enumType) {
+        this.enumType = enumType;
+        // @ts-ignore
+        enumType[EnumDecorator.enumDescriptorSymbol] = {};
+    }
+    /**
+     * Describe the enum item.
+     * @param enumItem Item you are describing.
+     * @param display Display name to use, e.g. for use in drop downs.
+     * @param description Additional description about the item.
+     * @param order Override sort order.
+     */
+    EnumDecorator.prototype.describe = function (enumItem, display, description, order) {
+        // @ts-ignore
+        this.enumType[EnumDecorator.enumDescriptorSymbol][enumItem] = { display: display, description: description, order: order };
+    };
+    EnumDecorator.enumDescriptorSymbol = Symbol("Neo.EnumDescriptor");
+    return EnumDecorator;
+}());
+var EnumHelper = /** @class */ (function () {
+    function EnumHelper() {
+    }
+    /**
+     * Decorate an enum and it's items.
+     * @param enumType The enum.
+     * @param callback Callback decorator. E.g: e.describe(Enum.Item1, "Display Value")
+     */
+    EnumHelper.decorateEnum = function (enumType, callback) {
+        var helper = new EnumDecorator(enumType);
+        callback(helper);
+    };
+    /**
+     * Creates a static datasource from an Enum.
+     */
+    EnumHelper.asDatasource = function (enumType) {
+        return StaticDataSource.fromEnum(enumType);
+    };
+    /**
+     * Creates a list of IEnumItem from an enum, using the enum decorator data.
+     */
+    EnumHelper.asList = function (enumObject) {
+        var descriptorMap = enumObject[EnumDecorator.enumDescriptorSymbol] || {};
+        var keys = Object.keys(enumObject).filter(function (key) { return typeof enumObject[key] === "number"; });
+        var items = [];
+        if (keys.length === 0) {
+            // String enum type.
+            keys = Object.keys(enumObject);
+        }
+        var index = keys.length;
+        for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
+            var key = keys_1[_i];
+            var id = enumObject[key];
+            var name_1 = void 0, description = void 0;
+            var itemDescriptor = descriptorMap[id];
+            if (itemDescriptor) {
+                name_1 = itemDescriptor.display;
+                description = itemDescriptor.description;
+            }
+            else {
+                name_1 = key.readable();
+            }
+            items.push({ id: id, name: name_1, description: description, order: itemDescriptor && itemDescriptor.order !== undefined ? itemDescriptor.order : index });
+            index += 1;
+        }
+        return items.sortBy(function (c) { return c.order; }).map(function (item) { return ({ id: item.id, name: item.name, description: item.description }); });
+    };
+    /**
+     * Gets the metadata for an enum item.
+     * @param enumType Enum object. E.g. Status
+     * @param enumItem Enum item. E.g. Status.Pending
+     */
+    EnumHelper.getItemMetadata = function (enumType, enumItem) {
+        // @ts-ignore
+        var descriptorMap = enumType[EnumDecorator.enumDescriptorSymbol] || {};
+        var itemDescriptor = descriptorMap[enumItem];
+        // @ts-ignore
+        var name = enumType[enumItem];
+        if (!itemDescriptor) {
+            itemDescriptor = name ? { name: name, display: name.readable() } : { name: enumItem.toString(), display: enumItem.toString() };
+        }
+        else {
+            itemDescriptor.name = name;
+        }
+        return itemDescriptor;
+    };
+    /**
+     * Returns `true` if this item looks like an enum item.
+     *
+     * E.g. has an `id` and `name` property.
+     */
+    EnumHelper.isEnumItem = function (item) {
+        if (typeof item === "object") {
+            var properties = Object.getOwnPropertyNames(item);
+            if (properties.length <= 3 && properties.some(function (c) { return c === "id"; }) && properties.some(function (c) { return c === "name"; })) {
+                return true;
+            }
+        }
+        return false;
+    };
+    return EnumHelper;
+}());
+export { EnumHelper };

package/dist/Model/IAutoRunner.d.ts

@@ -1,5 +1,5 @@
-import { IModelBase } from './IModelBase';
-import { IAutoRunner, IAutoRunnerOptions } from './Misc';
-export interface IAutoRunnerFactory {
-    create<T extends IModelBase>(model: T, callback: (model: T) => void, options?: IAutoRunnerOptions<T>): IAutoRunner;
-}
+import { IModelBase } from './IModelBase';
+import { IAutoRunner, IAutoRunnerOptions } from './Misc';
+export interface IAutoRunnerFactory {
+    create<T extends IModelBase>(model: T, callback: (model: T) => void, options?: IAutoRunnerOptions<T>): IAutoRunner;
+}

package/dist/Model/IAutoRunner.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Model/IModelBase.d.ts

@@ -1,79 +1,101 @@
-import { NeoTypeInfo } from './NeoTypeInfo';
-import { IPropertyInstance } from './PropertyInstance';
-import IModelValidator from '../Validation/Validators/IModelValidator';
-import { ValidationRules } from '../Validation/ValidationRules';
-import { ISerialiseOptions } from '../Data/Serialiser';
-import { RemoveMethods, Omit } from '../Utils';
-import List from './List';
-import { Misc } from '../';
-export declare type ObservableKeys<T> = RemoveMethods<Omit<T, keyof INonObservableModelBase>>;
-export declare type TransformMetaType<T> = {
-    [P in keyof ObservableKeys<T>]: IPropertyInstance<T[P]>;
-};
-export interface IMetaItem {
-    [index: string]: any;
-    meta: {
-        [index: string]: IPropertyInstance;
-    };
-}
-declare type NoModelBase<T> = Pick<T, Exclude<keyof T, keyof IModelBase> & keyof RemoveMethods<T>>;
-declare type TransformLists<T> = {
-    [P in keyof T]: T[P] extends List<infer I> ? I[] : T[P];
-};
-declare type RemoveChildren<T> = Pick<T, {
-    [P in keyof T]: T[P] extends List<infer I> ? never : T[P] extends IModelBase ? never : P;
-}[keyof T]>;
-export declare type PartialOrNull<T> = {
-    [P in keyof T]?: T[P] | null;
-};
-export declare type PlainObject<T> = TransformLists<NoModelBase<T>>;
-export declare type PlainTrackedObject<T> = PlainObject<T> & {
-    trackingState?: Misc.TrackingState;
-    entityIdentifier?: string;
-};
-export declare type PlainFlatObject<T> = Pick<T, Exclude<keyof T, keyof IModelBase> & keyof RemoveMethods<T> & keyof RemoveChildren<T>>;
-export declare type PartialPlainObject<T> = Partial<PlainObject<T>> & {
-    meta?: never;
-};
-export declare type PartialPlainNonTrackedObject<T> = PartialPlainObject<T> & {
-    trackingState?: never;
-};
-export interface NeoModelConstructor extends Function {
-    neo: NeoTypeInfo;
-}
-export interface IDebounceOptions {
-    delayMs?: number;
-}
-export interface IBindableBase {
-    meta: {
-        [index: string]: IPropertyInstance;
-    };
-    set(jsObject: any): void;
-}
-export interface INonObservableModelBase extends IBindableBase {
-    isSuspended: boolean;
-    validator: IModelValidator;
-    markOld(recurse?: boolean): void;
-    toJSObject(options: ISerialiseOptions): PlainObject<this>;
-    update(jsObject: any): void;
-    toQueryObject(): PlainFlatObject<this>;
-    toQueryObjectAuto(callback: (queryObject: PlainFlatObject<this>) => void, options?: IDebounceOptions): Misc.IAutoRunner;
-    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions<this>): Misc.IAutoRunner;
-    /** Icon to display next to toString() text. */
-    getIcon(): string;
-}
-export interface IModelBaseInternal {
-    addBusinessRules(validationRules: ValidationRules<IModelBase>): void;
-    onDeserialiseCompleted(wasCreated: boolean): void;
-    canSerialise(shouldSerialise: boolean): boolean;
-}
-export interface IModelBase extends INonObservableModelBase {
-    entityIdentifier: string;
-    isSelfDirty: boolean;
-    isNew: boolean;
-    readonly isSelfValid: boolean;
-    readonly isValid: boolean;
-    readonly isDirty: boolean;
-    readonly readyToSave: boolean;
-}
-export {};
+import { NeoTypeInfo } from './NeoTypeInfo';
+import { IPropertyInstance } from './PropertyInstance';
+import IModelValidator from '../Validation/Validators/IModelValidator';
+import { ValidationRules } from '../Validation/ValidationRules';
+import { ISerialiseOptions } from '../Data/Serialiser';
+import { RemoveMethods, Omit } from '../Utils';
+import List from './List';
+import { Misc } from '../';
+export type ObservableKeys<T> = RemoveMethods<Omit<T, keyof INonObservableModelBase>>;
+export type TransformMetaType<T> = {
+    [P in keyof ObservableKeys<T>]: IPropertyInstance<T[P]>;
+};
+export interface IMetaItem {
+    [index: string]: any;
+    meta: {
+        [index: string]: IPropertyInstance;
+    };
+}
+type NoModelBase<T> = Pick<T, Exclude<keyof T, keyof IModelBase> & keyof RemoveMethods<T>>;
+type TransformLists<T> = {
+    [P in keyof T]: T[P] extends List<infer I> ? I[] : T[P];
+};
+type RemoveChildren<T> = Pick<T, {
+    [P in keyof T]: T[P] extends List<infer I> ? never : T[P] extends IModelBase ? never : P;
+}[keyof T]>;
+export type PartialOrNull<T> = {
+    [P in keyof T]?: T[P] | null;
+};
+/** Removes ModelBase properties (isNew, isDirty etc), removes methods, and changes list types to arrays. */
+export type PlainObject<T> = TransformLists<NoModelBase<T>>;
+/** PlainObject plus tracking state and entity identifier.  */
+export type PlainTrackedObject<T> = PlainObject<T> & {
+    trackingState?: Misc.TrackingState;
+    entityIdentifier?: string;
+};
+/** Plain object with no tracking state, and no lists. */
+export type PlainFlatObject<T> = Pick<T, Exclude<keyof T, keyof IModelBase> & keyof RemoveMethods<T> & keyof RemoveChildren<T>>;
+/** Plain object where the meta property is not allowed. Used to accept any Plain* object. */
+export type PartialPlainObject<T> = Partial<PlainObject<T>> & {
+    meta?: never;
+};
+/** Plain object where the meta and tracking state properties are not allowed. Used to accept PlainObject and PlainFlatObject. */
+export type PartialPlainNonTrackedObject<T> = PartialPlainObject<T> & {
+    trackingState?: never;
+};
+export interface NeoModelConstructor extends Function {
+    neo: NeoTypeInfo;
+}
+export interface IMakeBindableOptions {
+    /**
+     * Specifies whether properties should be observable
+     * * If this is `true`, all properties will be observable by default.
+     * * If `false` only properties decorated with @Attributes.Observable will be made observable.
+     * * If `undefined`, only types that inherit from `ModelBase` will be observable by default.
+     */
+    makeObservable?: boolean;
+    /**
+     * Specifies whether methods should be converted to mobx actions. This is `true` by default.
+     * Use `Attributes.Action()` to override this per methis. */
+    autoActions?: boolean;
+    /**
+     * If `true`, this instance will not be converted. In inheritence heirarchies, use this to ensure only the last derived type converts the instance.
+     */
+    skipConversion?: boolean;
+}
+export interface IDebounceOptions {
+    delayMs?: number;
+}
+export interface IBindableBase {
+    meta: {
+        [index: string]: IPropertyInstance;
+    };
+    set(jsObject: any): void;
+}
+export interface INonObservableModelBase extends IBindableBase {
+    isSuspended: boolean;
+    validator: IModelValidator;
+    markOld(recurse?: boolean): void;
+    toJSObject(options: ISerialiseOptions): PlainObject<this>;
+    update(jsObject: any): void;
+    toQueryObject(): PlainFlatObject<this>;
+    toQueryObjectAuto(callback: (queryObject: PlainFlatObject<this>) => void, options?: IDebounceOptions): Misc.IAutoRunner;
+    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions<this>): Misc.IAutoRunner;
+    /** Icon to display next to toString() text. */
+    getIcon(): string;
+}
+export interface IModelBaseInternal {
+    addBusinessRules(validationRules: ValidationRules<IModelBase>): void;
+    onDeserialiseCompleted(wasCreated: boolean): void;
+    canSerialise(shouldSerialise: boolean): boolean;
+}
+export interface IModelBase extends INonObservableModelBase {
+    entityIdentifier: string;
+    isSelfDirty: boolean;
+    isNew: boolean;
+    readonly isSelfValid: boolean;
+    readonly isValid: boolean;
+    readonly isDirty: boolean;
+    readonly readyToSave: boolean;
+}
+export {};

package/dist/Model/IModelBase.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Model/IModelCreatorBase.d.ts

@@ -1,9 +1,9 @@
-import { NeoTypeInfo } from './NeoTypeInfo';
-import { NeoModelConstructor } from './IModelBase';
-export default interface IModelCreatorBase {
-    shouldInitialiseAllMembers: boolean;
-    initialise(typeInfo: NeoTypeInfo, originalConstructor: NeoModelConstructor): void;
-    isBindableBase(type: NeoModelConstructor): boolean;
-    isModelBase(type: NeoModelConstructor): boolean;
-    convertInstance(instance: {}): {};
-}
+import { NeoTypeInfo } from './NeoTypeInfo';
+import { IMakeBindableOptions, NeoModelConstructor } from './IModelBase';
+export default interface IModelCreatorBase {
+    shouldInitialiseAllMembers: boolean;
+    initialise(typeInfo: NeoTypeInfo, originalConstructor: NeoModelConstructor): void;
+    isBindableBase(type: NeoModelConstructor): boolean;
+    isModelBase(type: NeoModelConstructor): boolean;
+    convertInstance(instance: {}, options: IMakeBindableOptions): {};
+}

package/dist/Model/IModelCreatorBase.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/Model/List.d.ts

@@ -1,77 +1,79 @@
-import { ISerialiseOptions } from '../Data/Serialiser';
-import { PlainObject, PartialPlainObject, PlainTrackedObject, IMetaItem } from './IModelBase';
-import { IDeserialiseOptions } from '../Data/Deserialiser';
-export default class List<T> extends Array<T> {
-    childObjectType: (new () => T);
-    attachedTo: object | null;
-    private _deletedList;
-    get deletedList(): T[];
-    private baseMethods;
-    constructor(childObjectType: (new () => T));
-    /**
-     * Copies the methods and properties from the prototype to the new instance.
-     * This is needed because vue / mobx changes the prototype to its own.
-     */
-    static copyMethods(toInstance: any): void;
-    setupProxy(proxy: any, attachedTo: any): void;
-    /**
-     * Converts the neo models to plain javascript objects without tracking state.
-     * @param options Serialisation options.
-     * */
-    toJSArray(options?: ISerialiseOptions & {
-        suppressTrackingState: true;
-    }): Array<PlainObject<T>>;
-    /**
-     * Converts the neo models to plain javascript objects.
-     * @param options Serialisation options.
-     * */
-    toJSArray(options?: ISerialiseOptions & {
-        suppressTrackingState?: false;
-    }): Array<PlainTrackedObject<T>>;
-    /**
-     * Converts the neo models to plain javascript objects.
-     * */
-    toJSArray(): Array<PlainTrackedObject<T>>;
-    /**
-     * Converts a plain javascript Array to a neo model graph.
-     * Replaces a list - Items in the list, but not in jsArray will be removed.
-     * If you need missing items to remain, use update() instead.
-     * This will generally be used after calling toJSArray(includeClean = true)
-     * */
-    set(jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): void;
-    /**
-     * Converts a plain javascript Array to a neo model graph.
-     * Updates a list - Items in the list, but not in jsArray will remain in the list.
-     * If you need to replace the List with jsArray, use set() instead.
-     * This will generally be used after calling toJSArray(includeClean = false)
-     * */
-    update(jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): void;
-    /**
-     * Converts a plain javascript array into a neo model graph.
-     */
-    static fromJSArray<T>(childType: new () => T, jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): List<T>;
-    /** Creates a new item of type T */
-    createChild(): T;
-    push(...items: T[]): any;
-    clearDeletedList(): void;
-    private setParent;
-    /** Creates a new item of type T, adds it to the array and returns the new item. */
-    addNew(): T;
-    /**
-     * Removes an item from the array, and adds it to the deleted list. Deleted items will be included when calling toJSArray
-     * @param item Item to remove
-     */
-    remove(item: T): void;
-    /**
-     * Removes an item from the array without adding it to the deleted list.
-     * @param item Item to remove
-     */
-    removeWithoutTracking(item: T): void;
-    private removeItem;
-    /** Returns a static meta object containing all the properties of the lists item type. */
-    getMetaItem(): IMetaItem;
-    /** True if all items in the list are valid. */
-    get isValid(): boolean;
-    /** True if any item in the list is dirty, or the list contains any deleted items. */
-    get isDirty(): boolean;
-}
+import { ISerialiseOptions } from '../Data/Serialiser';
+import { PlainObject, PartialPlainObject, PlainTrackedObject, IMetaItem } from './IModelBase';
+import { IDeserialiseOptions } from '../Data/Deserialiser';
+export default class List<T> extends Array<T> {
+    childObjectType: (new () => T);
+    attachedTo: object | null;
+    private _deletedList;
+    get deletedList(): T[];
+    private baseMethods;
+    constructor(childObjectType: (new () => T));
+    /**
+     * Copies the methods and properties from the prototype to the new instance.
+     * This is needed because vue / mobx changes the prototype to its own.
+     */
+    static copyMethods(toInstance: any): void;
+    setupProxy(proxy: any, attachedTo: any): void;
+    /**
+     * Converts the neo models to plain javascript objects without tracking state.
+     * @param options Serialisation options.
+     * */
+    toJSArray(options?: ISerialiseOptions & {
+        suppressTrackingState: true;
+    }): Array<PlainObject<T>>;
+    /**
+     * Converts the neo models to plain javascript objects.
+     * @param options Serialisation options.
+     * */
+    toJSArray(options?: ISerialiseOptions & {
+        suppressTrackingState?: false;
+    }): Array<PlainTrackedObject<T>>;
+    /**
+     * Converts the neo models to plain javascript objects.
+     * */
+    toJSArray(): Array<PlainTrackedObject<T>>;
+    /**
+     * Converts a plain javascript Array to a neo model graph.
+     * Replaces a list - Items in the list, but not in jsArray will be removed.
+     * If you need missing items to remain, use update() instead.
+     * This will generally be used after calling toJSArray(includeClean = true)
+     * */
+    set(jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): void;
+    /**
+     * Converts a plain javascript Array to a neo model graph.
+     * Updates a list - Items in the list, but not in jsArray will remain in the list.
+     * If you need to replace the List with jsArray, use set() instead.
+     * This will generally be used after calling toJSArray(includeClean = false)
+     * */
+    update(jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): void;
+    /**
+     * Converts a plain javascript array into a neo model graph.
+     */
+    static fromJSArray<T>(childType: new () => T, jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): List<T>;
+    /** Creates a new item of type T */
+    createChild(): T;
+    push(...items: T[]): any;
+    clearDeletedList(): void;
+    private setParent;
+    /** Creates a new item of type T, adds it to the array and returns the new item. */
+    addNew(): T;
+    /**
+     * Removes an item from the array, and adds it to the deleted list. Deleted items will be included when calling toJSArray
+     * @param item Item to remove
+     */
+    remove(item: T): void;
+    /**
+     * Removes an item from the array without adding it to the deleted list.
+     * @param item Item to remove
+     */
+    removeWithoutTracking(item: T): void;
+    private removeItem;
+    /** Returns a static meta object containing all the properties of the lists item type. */
+    getMetaItem(): IMetaItem;
+    /** True if all items in the list are valid. */
+    get isValid(): boolean;
+    /** True if any item in the list is dirty, or the list contains any deleted items. */
+    get isDirty(): boolean;
+    /** Indicates that the model is dirty and valid and can be saved. */
+    get readyToSave(): boolean;
+}