@singularsystems/neo-core 1.0.0-alpha.3 → 1.0.0-alpha.4

package/dist/Model/Misc.d.ts

@@ -1,81 +1,83 @@
-import { IDebounceOptions } from './IModelBase';
-export declare enum SerialiseType {
-    /** Property will always be serialised / deserialised */
-    Always = 0,
-    /**
-     * Property will only be deserialised on a full deserialise or when being mapped. E.g. using set() and not update(), or if the object is created during deserialisation.
-     * Use this on non mapped properties where the data will only be transferred on an initial get.
-    */
-    FullOnly = 1,
-    /** Property will be serialised when its value is not null. */
-    NotNull = 2,
-    /** Property will only be deserialised when being mapped. */
-    MappingOnly = 3,
-    /** Property will never be serialised / deserialised */
-    Never = 4
-}
-export declare enum TimeZoneFormat {
-    /** Date will be serialised as UTC with Z */
-    UTC = 1,
-    /** Date will be serialised without time zone info. */
-    None = 2
-}
-export declare enum RelationType {
-    None = 0,
-    ChildObject = 1,
-    ChildList = 2,
-    Parent = 3,
-    ValueObject = 4,
-    Dictionary = 5
-}
-export declare enum DataType {
-    String = 1,
-    Int = 2,
-    Float = 3,
-    Date = 4,
-    Object = 5,
-    Array = 6,
-    NullableBoolean = 7,
-    Decimal = 8
-}
-export declare class OnChangedOptions {
-    onChangedFn: (oldValue: any, newValue: any) => void;
-    requiresOldValue: boolean;
-    delayMs: number;
-    constructor(onChangedFn: (oldValue: any, newValue: any) => void, requiresOldValue: boolean, delayMs: number);
-}
-export declare enum TrackingState {
-    Unchanged = 0,
-    Added = 1,
-    Modified = 2,
-    Deleted = 3
-}
-export interface IDisposable {
-    dispose(): void;
-}
-export interface IAutoRunner extends IDisposable {
-    /** Dispose the auto runner. */
-    dispose(): void;
-    /** Cancels any pending callbacks. */
-    cancelPending(): void;
-}
-export interface IAutoRunnerOptions<T> extends IDebounceOptions {
-    /**
-     * True if child objects should be included in addition to value objects.
-     */
-    includeChildObjects?: boolean;
-    /**
-     * True if child lists should be included.
-     * Note: this will apply to items in child lists at this point in time.
-     * Removed items will still be observed, and items added to the list will not be observed.
-     */
-    includeChildLists?: boolean;
-    /**
-     * If specified, only these properties will be observed.
-     */
-    rootProperties?: (Extract<keyof T, string>)[];
-}
-export interface ISelectedItem {
-    id: number | string;
-    display: string;
-}
+import { IDebounceOptions } from './IModelBase';
+export declare enum SerialiseType {
+    /** Property will always be serialised / deserialised */
+    Always = 0,
+    /**
+     * Property will only be deserialised on a full deserialise or when being mapped. E.g. using set() and not update(), or if the object is created during deserialisation.
+     * Use this on non mapped properties where the data will only be transferred on an initial get.
+    */
+    FullOnly = 1,
+    /** Property will be serialised when its value is not null. */
+    NotNull = 2,
+    /** Property will only be deserialised when being mapped. */
+    MappingOnly = 3,
+    /** Property will never be serialised / deserialised */
+    Never = 4
+}
+export declare enum TimeZoneFormat {
+    /** Date will be serialised as UTC with Z */
+    UTC = 1,
+    /** Date will be serialised without time zone info. */
+    None = 2
+}
+export declare enum RelationType {
+    None = 0,
+    ChildObject = 1,
+    ChildList = 2,
+    Parent = 3,
+    ValueObject = 4,
+    Dictionary = 5
+}
+export declare enum DataType {
+    String = 1,
+    Int = 2,
+    Float = 3,
+    Date = 4,
+    Object = 5,
+    Array = 6,
+    NullableBoolean = 7,
+    Decimal = 8
+}
+export declare class OnChangedOptions {
+    onChangedFn: (oldValue: any, newValue: any) => void;
+    requiresOldValue: boolean;
+    delayMs: number;
+    constructor(onChangedFn: (oldValue: any, newValue: any) => void, requiresOldValue: boolean, delayMs: number);
+}
+export declare enum TrackingState {
+    Unchanged = 0,
+    Added = 1,
+    Modified = 2,
+    Deleted = 3
+}
+export interface IDisposable {
+    dispose(): void;
+}
+export interface IAutoRunner extends IDisposable {
+    /** Dispose the auto runner. */
+    dispose(): void;
+    /** Cancels any pending callbacks. */
+    cancelPending(): void;
+    /** Cancels any pending callbacks, and fires the callback immediately. */
+    fireImmediate(): void;
+}
+export interface IAutoRunnerOptions<T> extends IDebounceOptions {
+    /**
+     * True if child objects should be included in addition to value objects.
+     */
+    includeChildObjects?: boolean;
+    /**
+     * True if child lists should be included.
+     * Note: this will apply to items in child lists at this point in time.
+     * Removed items will still be observed, and items added to the list will not be observed.
+     */
+    includeChildLists?: boolean;
+    /**
+     * If specified, only these properties will be observed.
+     */
+    rootProperties?: (Extract<keyof T, string>)[];
+}
+export interface ISelectedItem {
+    id: number | string;
+    display: string;
+}

package/dist/Model/Misc.js

@@ -1,59 +1,59 @@
-export var SerialiseType;
-(function (SerialiseType) {
-    /** Property will always be serialised / deserialised */
-    SerialiseType[SerialiseType["Always"] = 0] = "Always";
-    /**
-     * Property will only be deserialised on a full deserialise or when being mapped. E.g. using set() and not update(), or if the object is created during deserialisation.
-     * Use this on non mapped properties where the data will only be transferred on an initial get.
-    */
-    SerialiseType[SerialiseType["FullOnly"] = 1] = "FullOnly";
-    /** Property will be serialised when its value is not null. */
-    SerialiseType[SerialiseType["NotNull"] = 2] = "NotNull";
-    /** Property will only be deserialised when being mapped. */
-    SerialiseType[SerialiseType["MappingOnly"] = 3] = "MappingOnly";
-    /** Property will never be serialised / deserialised */
-    SerialiseType[SerialiseType["Never"] = 4] = "Never";
-})(SerialiseType || (SerialiseType = {}));
-export var TimeZoneFormat;
-(function (TimeZoneFormat) {
-    /** Date will be serialised as UTC with Z */
-    TimeZoneFormat[TimeZoneFormat["UTC"] = 1] = "UTC";
-    /** Date will be serialised without time zone info. */
-    TimeZoneFormat[TimeZoneFormat["None"] = 2] = "None";
-})(TimeZoneFormat || (TimeZoneFormat = {}));
-export var RelationType;
-(function (RelationType) {
-    RelationType[RelationType["None"] = 0] = "None";
-    RelationType[RelationType["ChildObject"] = 1] = "ChildObject";
-    RelationType[RelationType["ChildList"] = 2] = "ChildList";
-    RelationType[RelationType["Parent"] = 3] = "Parent";
-    RelationType[RelationType["ValueObject"] = 4] = "ValueObject";
-    RelationType[RelationType["Dictionary"] = 5] = "Dictionary";
-})(RelationType || (RelationType = {}));
-export var DataType;
-(function (DataType) {
-    DataType[DataType["String"] = 1] = "String";
-    DataType[DataType["Int"] = 2] = "Int";
-    DataType[DataType["Float"] = 3] = "Float";
-    DataType[DataType["Date"] = 4] = "Date";
-    DataType[DataType["Object"] = 5] = "Object";
-    DataType[DataType["Array"] = 6] = "Array";
-    DataType[DataType["NullableBoolean"] = 7] = "NullableBoolean";
-    DataType[DataType["Decimal"] = 8] = "Decimal";
-})(DataType || (DataType = {}));
-var OnChangedOptions = /** @class */ (function () {
-    function OnChangedOptions(onChangedFn, requiresOldValue, delayMs) {
-        this.onChangedFn = onChangedFn;
-        this.requiresOldValue = requiresOldValue;
-        this.delayMs = delayMs;
-    }
-    return OnChangedOptions;
-}());
-export { OnChangedOptions };
-export var TrackingState;
-(function (TrackingState) {
-    TrackingState[TrackingState["Unchanged"] = 0] = "Unchanged";
-    TrackingState[TrackingState["Added"] = 1] = "Added";
-    TrackingState[TrackingState["Modified"] = 2] = "Modified";
-    TrackingState[TrackingState["Deleted"] = 3] = "Deleted";
-})(TrackingState || (TrackingState = {}));
+export var SerialiseType;
+(function (SerialiseType) {
+    /** Property will always be serialised / deserialised */
+    SerialiseType[SerialiseType["Always"] = 0] = "Always";
+    /**
+     * Property will only be deserialised on a full deserialise or when being mapped. E.g. using set() and not update(), or if the object is created during deserialisation.
+     * Use this on non mapped properties where the data will only be transferred on an initial get.
+    */
+    SerialiseType[SerialiseType["FullOnly"] = 1] = "FullOnly";
+    /** Property will be serialised when its value is not null. */
+    SerialiseType[SerialiseType["NotNull"] = 2] = "NotNull";
+    /** Property will only be deserialised when being mapped. */
+    SerialiseType[SerialiseType["MappingOnly"] = 3] = "MappingOnly";
+    /** Property will never be serialised / deserialised */
+    SerialiseType[SerialiseType["Never"] = 4] = "Never";
+})(SerialiseType || (SerialiseType = {}));
+export var TimeZoneFormat;
+(function (TimeZoneFormat) {
+    /** Date will be serialised as UTC with Z */
+    TimeZoneFormat[TimeZoneFormat["UTC"] = 1] = "UTC";
+    /** Date will be serialised without time zone info. */
+    TimeZoneFormat[TimeZoneFormat["None"] = 2] = "None";
+})(TimeZoneFormat || (TimeZoneFormat = {}));
+export var RelationType;
+(function (RelationType) {
+    RelationType[RelationType["None"] = 0] = "None";
+    RelationType[RelationType["ChildObject"] = 1] = "ChildObject";
+    RelationType[RelationType["ChildList"] = 2] = "ChildList";
+    RelationType[RelationType["Parent"] = 3] = "Parent";
+    RelationType[RelationType["ValueObject"] = 4] = "ValueObject";
+    RelationType[RelationType["Dictionary"] = 5] = "Dictionary";
+})(RelationType || (RelationType = {}));
+export var DataType;
+(function (DataType) {
+    DataType[DataType["String"] = 1] = "String";
+    DataType[DataType["Int"] = 2] = "Int";
+    DataType[DataType["Float"] = 3] = "Float";
+    DataType[DataType["Date"] = 4] = "Date";
+    DataType[DataType["Object"] = 5] = "Object";
+    DataType[DataType["Array"] = 6] = "Array";
+    DataType[DataType["NullableBoolean"] = 7] = "NullableBoolean";
+    DataType[DataType["Decimal"] = 8] = "Decimal";
+})(DataType || (DataType = {}));
+var OnChangedOptions = /** @class */ (function () {
+    function OnChangedOptions(onChangedFn, requiresOldValue, delayMs) {
+        this.onChangedFn = onChangedFn;
+        this.requiresOldValue = requiresOldValue;
+        this.delayMs = delayMs;
+    }
+    return OnChangedOptions;
+}());
+export { OnChangedOptions };
+export var TrackingState;
+(function (TrackingState) {
+    TrackingState[TrackingState["Unchanged"] = 0] = "Unchanged";
+    TrackingState[TrackingState["Added"] = 1] = "Added";
+    TrackingState[TrackingState["Modified"] = 2] = "Modified";
+    TrackingState[TrackingState["Deleted"] = 3] = "Deleted";
+})(TrackingState || (TrackingState = {}));

package/dist/Model/ModelBase.d.ts

@@ -1,86 +1,88 @@
-import IModelValidator from '../Validation/Validators/IModelValidator';
-import { IModelBase, PlainObject, PartialPlainObject, PlainTrackedObject, PlainFlatObject, IDebounceOptions } from './IModelBase';
-import { ISerialiseOptions } from '../Data/Serialiser';
-import { ValidationRules } from '../Validation/ValidationRules';
-import { BindableBase } from './BindableBase';
-import { Misc } from '../';
-export default abstract class ModelBase extends BindableBase implements IModelBase {
-    isSuspended: boolean;
-    validator: IModelValidator;
-    isNew: boolean;
-    isSelfDirty: boolean;
-    /**
-     * Returns true if the object itself is dirty, or any of its children are dirty.
-     * IsNew does not affect the value of IsDirty.
-     */
-    get isDirty(): boolean;
-    get isSelfValid(): boolean;
-    get isValid(): boolean;
-    /**
-     * Indicates that the model is dirty and valid and can be saved.
-     */
-    get readyToSave(): boolean;
-    /** Recursively sets isSelfDirty, and isNew to false on this object and its children. */
-    markOld(recurse?: boolean): void;
-    /**
-     * Converts the neo model to a plain javascript object, including child objects and lists.
-     * @param options Serialisation options.
-     */
-    toJSObject(options: ISerialiseOptions & {
-        suppressTrackingState: true;
-    }): PlainObject<this>;
-    /**
-     * Converts the neo model to a plain javascript object, including child objects and lists.
-     * @param options Serialisation options.
-     */
-    toJSObject(options: ISerialiseOptions & {
-        suppressTrackingState?: false;
-    }): PlainTrackedObject<this>;
-    /**
-     * Converts the neo model to a plain javascript object, including child objects and lists.
-     */
-    toJSObject(): PlainTrackedObject<this>;
-    /**
-     * Converts the model into a plain javascript object for use with Utils.getQueryString.
-     * Child objects, child lists and tracking state are ignored.
-     */
-    toQueryObject(): PlainFlatObject<this>;
-    /**
-     * Passes you a query object every time one of the models properties change.
-     * This is delayed for string and numeric properties.
-     * You must call the disposer when you are done with this object.
-     * @param instance Model instance.
-     * @param callback Callback to run accepting a query object.
-     */
-    toQueryObjectAuto(callback: (queryObject: PlainFlatObject<this>) => void, options?: IDebounceOptions): Misc.IAutoRunner;
-    /**
-     * Runs the provided callback whenever any of values of the properties on this object, it's value objects, or child objects (if specified) change.
-     * This is delayed for string and numeric properties.
-     * You must call the disposer when you are done with this object.
-     */
-    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions<this>): Misc.IAutoRunner;
-    /**
-     * Converts a plain javascript object graph to a neo model graph.
-     * Updates child lists - Items in the child list, but not in jsArray will remain in the list.
-     * If you need to replace child lists with the jsArrays, use set() instead.
-     * This will generally be used after calling toJSObject(includeClean = false)
-     * */
-    update(jsObject: PartialPlainObject<this>): void;
-    /**
-     * Performs a deep clone on an object, cloning all nested objects including their entity identifiers.
-     */
-    cloneWithIdentity(): this;
-    /**
-     * Icon to display next to toString() text.
-     */
-    getIcon(): string;
-    /**
-     * Indicates whether or not this object should be serialised.
-     * @param shouldSerialise The value determined by the serialiser.
-     */
-    protected canSerialise(shouldSerialise: boolean): boolean;
-    /**
-     * Add custom business rules. Note, this will be called once per type and should be treated as static.
-     */
-    protected addBusinessRules(validationRules: ValidationRules<this>): void;
-}
+import IModelValidator from '../Validation/Validators/IModelValidator';
+import { IModelBase, PlainObject, PartialPlainObject, PlainTrackedObject, PlainFlatObject, IDebounceOptions } from './IModelBase';
+import { ISerialiseOptions } from '../Data/Serialiser';
+import { ValidationRules } from '../Validation/ValidationRules';
+import { BindableBase } from './BindableBase';
+import { Misc } from '../';
+export default abstract class ModelBase extends BindableBase implements IModelBase {
+    isSuspended: boolean;
+    validator: IModelValidator;
+    isNew: boolean;
+    isSelfDirty: boolean;
+    /**
+     * Returns true if the object itself is dirty, or any of its children are dirty.
+     * IsNew does not affect the value of IsDirty.
+     */
+    get isDirty(): boolean;
+    get isSelfValid(): boolean;
+    get isValid(): boolean;
+    /**
+     * Indicates that the model is dirty and valid and can be saved.
+     */
+    get readyToSave(): boolean;
+    /** Recursively sets isSelfDirty, and isNew to false on this object and its children. */
+    markOld(recurse?: boolean): void;
+    /**
+     * Converts the neo model to a plain javascript object, including child objects and lists.
+     * @param options Serialisation options.
+     */
+    toJSObject(options: ISerialiseOptions & {
+        suppressTrackingState: true;
+    }): PlainObject<this>;
+    /**
+     * Converts the neo model to a plain javascript object, including child objects and lists.
+     * @param options Serialisation options.
+     */
+    toJSObject(options: ISerialiseOptions & {
+        suppressTrackingState?: false;
+    }): PlainTrackedObject<this>;
+    /**
+     * Converts the neo model to a plain javascript object, including child objects and lists.
+     */
+    toJSObject(): PlainTrackedObject<this>;
+    /**
+     * Converts the model into a plain javascript object for use with Utils.getQueryString.
+     * Child objects, child lists and tracking state are ignored.
+     */
+    toQueryObject(): PlainFlatObject<this>;
+    /**
+     * Passes you a query object every time one of the models properties change.
+     * This is delayed for string and numeric properties.
+     * You must call the disposer when you are done with this object.
+     * @param instance Model instance.
+     * @param callback Callback to run accepting a query object.
+     */
+    toQueryObjectAuto(callback: (queryObject: PlainFlatObject<this>) => void, options?: IDebounceOptions): Misc.IAutoRunner;
+    /**
+     * Runs the provided callback whenever any of values of the properties on this object, it's value objects, or child objects (if specified) change.
+     * This is delayed for string and numeric properties.
+     * You must call the disposer when you are done with this object.
+     */
+    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions<this>): Misc.IAutoRunner;
+    /**
+     * Converts a plain javascript object graph to a neo model graph.
+     * Updates child lists - Items in the child list, but not in jsArray will remain in the list.
+     * If you need to replace child lists with the jsArrays, use set() instead.
+     * This will generally be used after calling toJSObject(includeClean = false)
+     * */
+    update(jsObject: PartialPlainObject<this>): void;
+    /**
+     * Performs a deep clone on an object, cloning all nested objects including their entity identifiers.
+     */
+    cloneWithIdentity(): this;
+    /**
+     * Icon to display next to toString() text.
+     */
+    getIcon(): string;
+    /**
+     * Indicates whether or not this object should be serialised.
+     * @param shouldSerialise The value determined by the serialiser.
+     */
+    protected canSerialise(shouldSerialise: boolean): boolean;
+    /**
+     * Add custom business rules. Note, this will be called once per type and should be treated as static.
+     */
+    protected addBusinessRules(validationRules: ValidationRules<this>): void;
+    /** The server side type name used to find this type. Include the namespace if there is more than one type with the same name. */
+    static typeName: string | null;
+}