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

package/dist/Model/ObservableProperty.js

@@ -1,41 +1,41 @@
-import { __decorate, __extends } from "tslib";
-import NeoModel from './NeoModel';
-import PropertyInfo from './PropertyInfo';
-import PropertyInstance from './PropertyInstance';
-import ModelBase from './ModelBase';
-import { RequiredRule } from '../Validation/Rules';
-import { Utils } from '../Utils';
-var ObservableModel = /** @class */ (function (_super) {
-    __extends(ObservableModel, _super);
-    function ObservableModel() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.value = null;
-        return _this;
-    }
-    ObservableModel = __decorate([
-        NeoModel
-    ], ObservableModel);
-    return ObservableModel;
-}(ModelBase));
-var ObservableProperty = /** @class */ (function () {
-    function ObservableProperty() {
-    }
-    /** Creates an observable property which can be used for binding. */
-    ObservableProperty.create = function (displayName, defaultValue, options, isRequired) {
-        var model = new ObservableModel();
-        model.value = defaultValue;
-        var propertyInfo = new PropertyInfo("value");
-        Utils.populatePartialWithDefaults(propertyInfo, options);
-        propertyInfo.displayName = displayName;
-        if (isRequired) {
-            propertyInfo.rules.push(new RequiredRule("{0} is required."));
-        }
-        return new PropertyInstance(model, propertyInfo);
-    };
-    /** Creates an observable property which can be used for binding. The value will be required when bound in an editor. */
-    ObservableProperty.required = function (displayName, defaultValue, options) {
-        return ObservableProperty.create(displayName, defaultValue, options, true);
-    };
-    return ObservableProperty;
-}());
-export { ObservableProperty };
+import { __decorate, __extends } from "tslib";
+import NeoModel from './NeoModel';
+import PropertyInfo from './PropertyInfo';
+import PropertyInstance from './PropertyInstance';
+import ModelBase from './ModelBase';
+import { RequiredRule } from '../Validation/Rules';
+import { Utils } from '../Utils';
+var ObservableModel = /** @class */ (function (_super) {
+    __extends(ObservableModel, _super);
+    function ObservableModel() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.value = null;
+        return _this;
+    }
+    ObservableModel = __decorate([
+        NeoModel
+    ], ObservableModel);
+    return ObservableModel;
+}(ModelBase));
+var ObservableProperty = /** @class */ (function () {
+    function ObservableProperty() {
+    }
+    /** Creates an observable property which can be used for binding. */
+    ObservableProperty.create = function (displayName, defaultValue, options, isRequired) {
+        var model = new ObservableModel();
+        model.value = defaultValue;
+        var propertyInfo = new PropertyInfo("value");
+        Utils.populatePartialWithDefaults(propertyInfo, options);
+        propertyInfo.displayName = displayName;
+        if (isRequired) {
+            propertyInfo.rules.push(new RequiredRule("{0} is required."));
+        }
+        return new PropertyInstance(model, propertyInfo);
+    };
+    /** Creates an observable property which can be used for binding. The value will be required when bound in an editor. */
+    ObservableProperty.required = function (displayName, defaultValue, options) {
+        return ObservableProperty.create(displayName, defaultValue, options, true);
+    };
+    return ObservableProperty;
+}());
+export { ObservableProperty };

package/dist/Model/ObservableValue.d.ts

@@ -1,9 +1,9 @@
-export interface IObservableValue<T> {
-    value: T;
-    peek: T;
-}
-export declare class ObservableValue<T> implements IObservableValue<T> {
-    value: T;
-    constructor(initialValue: T);
-    get peek(): T;
-}
+export interface IObservableValue<T> {
+    value: T;
+    peek: T;
+}
+export declare class ObservableValue<T> implements IObservableValue<T> {
+    value: T;
+    constructor(initialValue: T);
+    get peek(): T;
+}

package/dist/Model/ObservableValue.js

@@ -1,26 +1,25 @@
-import { __decorate, __metadata } from "tslib";
-import NeoModel from './NeoModel';
-import { Observable } from './Decorators';
-import { Utils } from '../Utils';
-var ObservableValue = /** @class */ (function () {
-    function ObservableValue(initialValue) {
-        this.value = initialValue;
-    }
-    Object.defineProperty(ObservableValue.prototype, "peek", {
-        get: function () {
-            return Utils.peek(this, "value");
-        },
-        enumerable: false,
-        configurable: true
-    });
-    __decorate([
-        Observable(),
-        __metadata("design:type", Object)
-    ], ObservableValue.prototype, "value", void 0);
-    ObservableValue = __decorate([
-        NeoModel,
-        __metadata("design:paramtypes", [Object])
-    ], ObservableValue);
-    return ObservableValue;
-}());
-export { ObservableValue };
+import { __decorate, __metadata } from "tslib";
+import NeoModel from './NeoModel';
+import { Observable } from './Decorators';
+import { Utils } from '../Utils';
+export var ObservableValue = /** @class */ (function () {
+    function ObservableValue(initialValue) {
+        this.value = initialValue;
+    }
+    Object.defineProperty(ObservableValue.prototype, "peek", {
+        get: function () {
+            return Utils.peek(this, "value");
+        },
+        enumerable: false,
+        configurable: true
+    });
+    __decorate([
+        Observable(),
+        __metadata("design:type", Object)
+    ], ObservableValue.prototype, "value", void 0);
+    ObservableValue = __decorate([
+        NeoModel,
+        __metadata("design:paramtypes", [Object])
+    ], ObservableValue);
+    return ObservableValue;
+}());

package/dist/Model/PropertyInfo.d.ts

@@ -1,81 +1,83 @@
-import { SerialiseType, RelationType, OnChangedOptions, DataType, TimeZoneFormat } from './Misc';
-import { Nullable } from '../Utils';
-import { INonObservableModelBase } from './IModelBase';
-import { Rule } from '../Validation/Rules';
-export declare type PropertyInfoMap = {
-    [index: string]: PropertyInfo;
-};
-export declare type TransformStaticMetaType<T> = {
-    [P in Exclude<keyof T, keyof INonObservableModelBase>]: PropertyInfo;
-};
-export default class PropertyInfo {
-    propertyName: string;
-    private _parent?;
-    private _readableName;
-    private attributeRules;
-    /** The class type of child.*/
-    private _type?;
-    /** A function that returns the constructor of the property type. */
-    private typeCallback?;
-    /** Name to use on labels for this property */
-    displayName: string;
-    /** True if the property does not cause the object to become dirty. */
-    noTrack: boolean;
-    /**
-     * False if this is must not be converted to an observable.
-     * True when defining observables on types that don't extend ModelBase.
-     */
-    isObservable: Nullable<boolean>;
-    /** See SerialiseType */
-    serialise: SerialiseType;
-    timeZoneSerialisation: TimeZoneFormat;
-    /** Type of parent / child if this property is related to another model. 'type' property must be set if this is not 'none'. */
-    relationType: RelationType;
-    /** Data type of the property. */
-    propertyType: DataType;
-    /** This will change the default behaviour about how a control sets this properties value. */
-    allowNulls: boolean;
-    /** Options for the onChanged event */
-    onChangedOptions: OnChangedOptions;
-    /**
-     * Set if you want this value to be debounced when calling toQueryObjectAuto, or using the AutoRunner service.
-     * By default, strings or properties decorated with integer or float are debounced.
-     */
-    debounce: boolean | null;
-    /** True if this is a Vue / Mobx computed property. All getters become computed by default. */
-    isComputed: boolean | null;
-    /** True if this is a getter only property. */
-    isReadOnly: boolean;
-    /**
-     * JS property descriptor if this is a getter / setter.
-     */
-    descriptor?: PropertyDescriptor;
-    /** True if this has a sort value different to its actual value. E.g. drop down */
-    hasSortValue: boolean;
-    /** List of rules that display on this property. */
-    rules: Rule[];
-    /** Indicates that this property must be assigned to on de/serialisation. The de/serialiser will not try create a model instance of the object / array. */
-    assignOnDeserialise: boolean;
-    constructor(propertyName: string);
-    /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
-    get readableName(): string;
-    /**
-     * Property info with the same property name from the parent class.
-     */
-    get parent(): PropertyInfo | undefined;
-    addAttributeRule(rule: Rule): void;
-    clone(): PropertyInfo;
-    setPropertyType(propertyType: (() => any) | (new () => any)): void;
-    /**
-     * Gets the constructor function of the return type.
-     * Returns null if the property has not been decorated with a ChildObject / Parent attribute.
-     */
-    get type(): (new () => any) | null;
-    /**
-     * Gets the constructor function of the return type.
-     * Raises an error if the property has not been decorated with a ChildObject / Parent attribute.
-     */
-    get typeWithAssert(): new () => any;
-    createValueInstance(): any;
-    setupFromInstance(instance: any): void;
-}
+import { SerialiseType, RelationType, OnChangedOptions, DataType, TimeZoneFormat } from './Misc';
+import { Nullable } from '../Utils';
+import { INonObservableModelBase } from './IModelBase';
+import { Rule } from '../Validation/Rules';
+export type PropertyInfoMap = {
+    [index: string]: PropertyInfo;
+};
+export type TransformStaticMetaType<T> = {
+    [P in Exclude<keyof T, keyof INonObservableModelBase>]: PropertyInfo;
+};
+export default class PropertyInfo {
+    propertyName: string;
+    private _parent?;
+    private _readableName;
+    private attributeRules;
+    /** The class type of child.*/
+    private _type?;
+    /** A function that returns the constructor of the property type. */
+    private typeCallback?;
+    /** Name to use on labels for this property */
+    displayName: string;
+    /** True if the property does not cause the object to become dirty. */
+    noTrack: boolean;
+    /**
+     * False if this is must not be converted to an observable.
+     * True when defining observables on types that don't extend ModelBase.
+     */
+    isObservable: Nullable<boolean>;
+    /** See SerialiseType */
+    serialise: SerialiseType;
+    timeZoneSerialisation: TimeZoneFormat;
+    /** Type of parent / child if this property is related to another model. 'type' property must be set if this is not 'none'. */
+    relationType: RelationType;
+    /** Data type of the property. */
+    propertyType: DataType;
+    /** No of decimals to allow when binding to this property from a supporting ui component. If not specified, this will be determined from the format string. */
+    allowedDecimals?: number;
+    /** This will change the default behaviour about how a control sets this properties value. */
+    allowNulls: boolean;
+    /** Options for the onChanged event */
+    onChangedOptions: OnChangedOptions;
+    /**
+     * Set if you want this value to be debounced when calling toQueryObjectAuto, or using the AutoRunner service.
+     * By default, strings or properties decorated with integer or float are debounced.
+     */
+    debounce: boolean | null;
+    /** True if this is a Vue / Mobx computed property. All getters become computed by default. */
+    isComputed: boolean | null;
+    /** True if this is a getter only property. */
+    isReadOnly: boolean;
+    /**
+     * JS property descriptor if this is a getter / setter.
+     */
+    descriptor?: PropertyDescriptor;
+    /** True if this has a sort value different to its actual value. E.g. drop down */
+    hasSortValue: boolean;
+    /** List of rules that display on this property. */
+    rules: Rule[];
+    /** Indicates that this property must be assigned to on de/serialisation. The de/serialiser will not try create a model instance of the object / array. */
+    assignOnDeserialise: boolean;
+    constructor(propertyName: string);
+    /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
+    get readableName(): string;
+    /**
+     * Property info with the same property name from the parent class.
+     */
+    get parent(): PropertyInfo | undefined;
+    addAttributeRule(rule: Rule): void;
+    clone(): PropertyInfo;
+    setPropertyType(propertyType: (() => any) | (new () => any)): void;
+    /**
+     * Gets the constructor function of the return type.
+     * Returns null if the property has not been decorated with a ChildObject / Parent attribute.
+     */
+    get type(): (new () => any) | null;
+    /**
+     * Gets the constructor function of the return type.
+     * Raises an error if the property has not been decorated with a ChildObject / Parent attribute.
+     */
+    get typeWithAssert(): new () => any;
+    createValueInstance(): any;
+    setupFromInstance(instance: any): void;
+}

package/dist/Model/PropertyInfo.js

@@ -1,137 +1,137 @@
-import { __spreadArray } from "tslib";
-import { SerialiseType, RelationType, DataType } from './Misc';
-import Globals from '../Globals';
-var PropertyInfo = /** @class */ (function () {
-    function PropertyInfo(propertyName) {
-        this.propertyName = propertyName;
-        this.attributeRules = [];
-        /** Name to use on labels for this property */
-        this.displayName = "";
-        // TODO: noTrack and Observable should be combined and use an enum?
-        /** True if the property does not cause the object to become dirty. */
-        this.noTrack = false;
-        /**
-         * False if this is must not be converted to an observable.
-         * True when defining observables on types that don't extend ModelBase.
-         */
-        this.isObservable = null;
-        /** See SerialiseType */
-        this.serialise = SerialiseType.Always;
-        /** Type of parent / child if this property is related to another model. 'type' property must be set if this is not 'none'. */
-        this.relationType = RelationType.None;
-        /** Data type of the property. */
-        this.propertyType = DataType.String;
-        /**
-         * Set if you want this value to be debounced when calling toQueryObjectAuto, or using the AutoRunner service.
-         * By default, strings or properties decorated with integer or float are debounced.
-         */
-        this.debounce = null;
-        /** True if this is a Vue / Mobx computed property. All getters become computed by default. */
-        this.isComputed = null;
-        /** List of rules that display on this property. */
-        this.rules = [];
-        /** Indicates that this property must be assigned to on de/serialisation. The de/serialiser will not try create a model instance of the object / array. */
-        this.assignOnDeserialise = false;
-    }
-    Object.defineProperty(PropertyInfo.prototype, "readableName", {
-        /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
-        get: function () {
-            if (!this._readableName) {
-                if (this.displayName) {
-                    this._readableName = this.displayName;
-                }
-                else {
-                    this._readableName = this.propertyName.readable();
-                }
-            }
-            return this._readableName;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyInfo.prototype, "parent", {
-        /**
-         * Property info with the same property name from the parent class.
-         */
-        get: function () {
-            return this._parent;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    PropertyInfo.prototype.addAttributeRule = function (rule) {
-        this.rules.push(rule);
-        this.attributeRules.push(rule);
-    };
-    PropertyInfo.prototype.clone = function () {
-        var _a;
-        var clone = new PropertyInfo(this.propertyName);
-        for (var _i = 0, _b = Object.getOwnPropertyNames(this); _i < _b.length; _i++) {
-            var propertyKey = _b[_i];
-            clone[propertyKey] = this[propertyKey];
-        }
-        (_a = clone.rules).splice.apply(_a, __spreadArray([0, clone.rules.length], clone.attributeRules, false));
-        clone._parent = this;
-        return clone;
-    };
-    PropertyInfo.prototype.setPropertyType = function (propertyType) {
-        if (!propertyType.prototype || !propertyType.prototype.constructor.name) {
-            this.typeCallback = propertyType;
-        }
-        else {
-            this._type = propertyType;
-        }
-    };
-    Object.defineProperty(PropertyInfo.prototype, "type", {
-        /**
-         * Gets the constructor function of the return type.
-         * Returns null if the property has not been decorated with a ChildObject / Parent attribute.
-         */
-        get: function () {
-            if (this.typeCallback !== undefined) {
-                return this.typeCallback();
-            }
-            else if (this._type) {
-                return this._type;
-            }
-            else {
-                return null;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyInfo.prototype, "typeWithAssert", {
-        /**
-         * Gets the constructor function of the return type.
-         * Raises an error if the property has not been decorated with a ChildObject / Parent attribute.
-         */
-        get: function () {
-            var type = this.type;
-            if (!type) {
-                throw "".concat(this.propertyName, " has no property type defined. Make sure it is decorated with @Attributes.ChildObject.");
-            }
-            return type;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    PropertyInfo.prototype.createValueInstance = function () {
-        try {
-            return new this.typeWithAssert();
-        }
-        catch (error) {
-            throw "Cannot create instance of property ".concat(this.propertyName, ": ").concat(error);
-        }
-    };
-    PropertyInfo.prototype.setupFromInstance = function (instance) {
-        var value = instance[this.propertyName];
-        if (value) {
-            if (value instanceof Globals.decimalType) {
-                this.propertyType = DataType.Decimal;
-            }
-        }
-    };
-    return PropertyInfo;
-}());
-export default PropertyInfo;
+import { __spreadArray } from "tslib";
+import { SerialiseType, RelationType, DataType } from './Misc';
+import Globals from '../Globals';
+var PropertyInfo = /** @class */ (function () {
+    function PropertyInfo(propertyName) {
+        this.propertyName = propertyName;
+        this.attributeRules = [];
+        /** Name to use on labels for this property */
+        this.displayName = "";
+        /** True if the property does not cause the object to become dirty. */
+        this.noTrack = false;
+        /**
+         * False if this is must not be converted to an observable.
+         * True when defining observables on types that don't extend ModelBase.
+         */
+        this.isObservable = null;
+        /** See SerialiseType */
+        this.serialise = SerialiseType.Always;
+        /** Type of parent / child if this property is related to another model. 'type' property must be set if this is not 'none'. */
+        this.relationType = RelationType.None;
+        /** Data type of the property. */
+        this.propertyType = DataType.String;
+        /**
+         * Set if you want this value to be debounced when calling toQueryObjectAuto, or using the AutoRunner service.
+         * By default, strings or properties decorated with integer or float are debounced.
+         */
+        this.debounce = null;
+        /** True if this is a Vue / Mobx computed property. All getters become computed by default. */
+        this.isComputed = null;
+        /** List of rules that display on this property. */
+        this.rules = [];
+        /** Indicates that this property must be assigned to on de/serialisation. The de/serialiser will not try create a model instance of the object / array. */
+        this.assignOnDeserialise = false;
+    }
+    Object.defineProperty(PropertyInfo.prototype, "readableName", {
+        /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
+        get: function () {
+            if (!this._readableName) {
+                if (this.displayName) {
+                    this._readableName = this.displayName;
+                }
+                else {
+                    this._readableName = this.propertyName.readable();
+                }
+            }
+            return this._readableName;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyInfo.prototype, "parent", {
+        /**
+         * Property info with the same property name from the parent class.
+         */
+        get: function () {
+            return this._parent;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    PropertyInfo.prototype.addAttributeRule = function (rule) {
+        this.rules.push(rule);
+        this.attributeRules.push(rule);
+    };
+    PropertyInfo.prototype.clone = function () {
+        var _a;
+        var clone = new PropertyInfo(this.propertyName);
+        for (var _i = 0, _b = Object.getOwnPropertyNames(this); _i < _b.length; _i++) {
+            var propertyKey = _b[_i];
+            // @ts-ignore
+            clone[propertyKey] = this[propertyKey];
+        }
+        (_a = clone.rules).splice.apply(_a, __spreadArray([0, clone.rules.length], clone.attributeRules, false));
+        clone._parent = this;
+        return clone;
+    };
+    PropertyInfo.prototype.setPropertyType = function (propertyType) {
+        if (!propertyType.prototype || !propertyType.prototype.constructor.name) {
+            this.typeCallback = propertyType;
+        }
+        else {
+            this._type = propertyType;
+        }
+    };
+    Object.defineProperty(PropertyInfo.prototype, "type", {
+        /**
+         * Gets the constructor function of the return type.
+         * Returns null if the property has not been decorated with a ChildObject / Parent attribute.
+         */
+        get: function () {
+            if (this.typeCallback !== undefined) {
+                return this.typeCallback();
+            }
+            else if (this._type) {
+                return this._type;
+            }
+            else {
+                return null;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyInfo.prototype, "typeWithAssert", {
+        /**
+         * Gets the constructor function of the return type.
+         * Raises an error if the property has not been decorated with a ChildObject / Parent attribute.
+         */
+        get: function () {
+            var type = this.type;
+            if (!type) {
+                throw "".concat(this.propertyName, " has no property type defined. Make sure it is decorated with @Attributes.ChildObject.");
+            }
+            return type;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    PropertyInfo.prototype.createValueInstance = function () {
+        try {
+            return new this.typeWithAssert();
+        }
+        catch (error) {
+            throw "Cannot create instance of property ".concat(this.propertyName, ": ").concat(error);
+        }
+    };
+    PropertyInfo.prototype.setupFromInstance = function (instance) {
+        var value = instance[this.propertyName];
+        if (value) {
+            if (value instanceof Globals.decimalType) {
+                this.propertyType = DataType.Decimal;
+            }
+        }
+    };
+    return PropertyInfo;
+}());
+export default PropertyInfo;