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

package/dist/Model/BindableBase.js

@@ -1,76 +1,82 @@
-import { __assign, __decorate, __metadata } from "tslib";
-import { NoTracking, Observable } from './Decorators';
-import { JSFormatter } from '../Data/Serialiser';
-import { ensureTypeInfo } from './NeoTypeInfo';
-import { Utils } from '../Utils';
-import { SerialiseType } from './Misc';
-var BindableBase = /** @class */ (function () {
-    function BindableBase() {
-        this.entityIdentifier = Utils.uuidv4();
-    }
-    /**
-     * Converts a plain javascript object graph to a neo model graph.
-     * Replaces child lists - Items in the child 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 toJSObject(includeClean = true)
-     * */
-    BindableBase.prototype.set = function (jsObject, options) {
-        JSFormatter.deserialise(jsObject, this, null, __assign({ removeOldItems: true }, options));
-    };
-    /**
-     * Copies the provided objects properties into this objects properties. Matches on name.
-     * Syncs child lists by default unless configured in the options argument.
-     */
-    BindableBase.prototype.mapFrom = function (object, options) {
-        JSFormatter.deserialise(object, this, null, __assign({ removeOldItems: true, isMap: true }, options));
-        return this;
-    };
-    /**
-     * Performs a deep clone on an object. Equivalent to Type.mapFrom(this).
-     */
-    BindableBase.prototype.clone = function () {
-        return this.constructor.mapFrom(this);
-    };
-    /**
-     * Called once a deserialise batch has completed.
-     */
-    BindableBase.prototype.onDeserialiseCompleted = function (wasCreated) {
-    };
-    /**
-     * Makes the model observable and creates its 'meta' object.
-     * Must be called in the constructor, preferably directly after the super() call.
-     * This method can be used as an alternative to the @NeoModel decorator.
-     */
-    BindableBase.prototype.makeObservable = function () {
-        // Ensure neo info is set
-        var ctor = this.constructor;
-        // Call this in case no property decorators were added
-        ensureTypeInfo(ctor);
-        ctor.neo.makeObservable(this);
-    };
-    /**
-     * Creates a new instance of this type, and deserialises the plain javascript object graph into it.
-     * @param jsObject Plain js object
-     */
-    BindableBase.fromJSObject = function (jsObject, options) {
-        var newItem = Utils.createInstance(this);
-        JSFormatter.deserialise(jsObject, newItem, null, __assign({ removeOldItems: true }, options), true);
-        return newItem;
-    };
-    BindableBase.mapFrom = function (object, options) {
-        var newItem = Utils.createInstance(this);
-        JSFormatter.deserialise(object, newItem, null, __assign({ removeOldItems: true, isMap: true }, options), true);
-        return newItem;
-    };
-    __decorate([
-        NoTracking(SerialiseType.Never),
-        Observable(false),
-        __metadata("design:type", Object)
-    ], BindableBase.prototype, "meta", void 0);
-    __decorate([
-        NoTracking(SerialiseType.Never),
-        __metadata("design:type", Object)
-    ], BindableBase.prototype, "entityIdentifier", void 0);
-    return BindableBase;
-}());
-export { BindableBase };
+import { __assign, __decorate, __metadata } from "tslib";
+import { NoTracking, Observable } from './Decorators';
+import { JSFormatter } from '../Data/Serialiser';
+import { NeoTypeInfo } from './NeoTypeInfo';
+import { Utils } from '../Utils';
+import { SerialiseType } from './Misc';
+export var BindableBase = /** @class */ (function () {
+    function BindableBase() {
+        this.entityIdentifier = Utils.uuidv4();
+    }
+    /**
+     * Converts a plain javascript object graph to a neo model graph.
+     * Replaces child lists - Items in the child 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 toJSObject(includeClean = true)
+     * */
+    BindableBase.prototype.set = function (jsObject, options) {
+        JSFormatter.deserialise(jsObject, this, null, __assign({ removeOldItems: true }, options));
+    };
+    /**
+     * Copies the provided objects properties into this objects properties. Matches on name.
+     * Syncs child lists by default unless configured in the options argument.
+     */
+    BindableBase.prototype.mapFrom = function (object, options) {
+        JSFormatter.deserialise(object, this, null, __assign({ removeOldItems: true, isMap: true }, options));
+        return this;
+    };
+    /**
+     * Performs a deep clone on an object. Equivalent to Type.mapFrom(this).
+     */
+    BindableBase.prototype.clone = function () {
+        return this.constructor.mapFrom(this);
+    };
+    /**
+     * Called once a deserialise batch has completed.
+     */
+    BindableBase.prototype.onDeserialiseCompleted = function (wasCreated) {
+    };
+    /**
+     * Makes the model observable and creates its 'meta' object.
+     * Must be called in the constructor, preferably directly after the super() call.
+     * This method can be used as an alternative to the @NeoModel decorator.
+     */
+    BindableBase.prototype.makeObservable = function (options) {
+        var _a;
+        options !== null && options !== void 0 ? options : (options = {});
+        (_a = options.makeObservable) !== null && _a !== void 0 ? _a : (options.makeObservable = true);
+        this.makeBindable(options);
+    };
+    /**
+     * Makes the model bindable (and observable if it inherits from ModelBase) by creating its 'meta' object.
+     * Must be called in the constructor, preferably directly after the super() call.
+     * This method can be used as an alternative to the @NeoModel decorator.
+     */
+    BindableBase.prototype.makeBindable = function (options) {
+        NeoTypeInfo.makeObservable(this, options);
+    };
+    /**
+     * Creates a new instance of this type, and deserialises the plain javascript object graph into it.
+     * @param jsObject Plain js object
+     */
+    BindableBase.fromJSObject = function (jsObject, options) {
+        var newItem = Utils.createInstance(this);
+        JSFormatter.deserialise(jsObject, newItem, null, __assign({ removeOldItems: true }, options), true);
+        return newItem;
+    };
+    BindableBase.mapFrom = function (object, options) {
+        var newItem = Utils.createInstance(this);
+        JSFormatter.deserialise(object, newItem, null, __assign({ removeOldItems: true, isMap: true }, options), true);
+        return newItem;
+    };
+    __decorate([
+        NoTracking(SerialiseType.Never),
+        Observable(false),
+        __metadata("design:type", Object)
+    ], BindableBase.prototype, "meta", void 0);
+    __decorate([
+        NoTracking(SerialiseType.Never),
+        __metadata("design:type", Object)
+    ], BindableBase.prototype, "entityIdentifier", void 0);
+    return BindableBase;
+}());

package/dist/Model/Decorators.d.ts

@@ -1,44 +1,50 @@
-import { SerialiseType, DataType, TimeZoneFormat } from './Misc';
-export declare function Display(name: string): (type: any, propertyKey: string) => void;
-/** Indicates that this is a date property. Json strings will be converted to date objects on deserialisation. */
-export declare function Date(timeZoneSerialisation?: TimeZoneFormat): (type: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
-/** Indicates that this is an integer number property. Editors will be restricted to integer numeric input. */
-export declare function Integer(): (type: any, propertyKey: string) => void;
-/** Indicates that this is a float number property. Editors will be restricted to float numeric input. */
-export declare function Float(): (type: any, propertyKey: string) => void;
-/** Indicates that this is a decimal property. */
-export declare function Decimal(): (type: any, propertyKey: string) => void;
-/** Indicates that this is a nullable boolean property. */
-export declare function NullableBoolean(): (type: any, propertyKey: string) => void;
-/** Indicates that this property accepts nulls from user input controls that do not normally accept nulls. E.g. numeric editors. */
-export declare function Nullable(dataType?: DataType): (type: any, propertyKey: string) => void;
-export declare function Observable(isObservable?: boolean): (type: any, propertyKey: string) => void;
-/** Indicates that changes to this property will not cause the object to become dirty. It will also not be serialised */
-export declare function NoTracking(serialisation?: SerialiseType): (type: any, propertyKey: string) => void;
-export declare function Serialisation(serialisation: SerialiseType): (type: any, propertyKey: string) => void;
-/** Indicates that this is a list property, and specifies the item type. This is not required if the list is initialised with a value. */
-export declare function ChildList(childType: any): (type: any, propertyKey: string) => any;
-/** Indicates that this is a child object property, and specifies the child type. This is not required if the property is initialised with a value. */
-export declare function ChildObject(childType: new () => any, isValueObject?: boolean): Function;
-export declare function ChildObject(childType: () => any, isValueObject?: boolean): Function;
-export declare function Dictionary(valueType: any): (type: any, propertyKey: string) => any;
-export declare function Parent(parentType: () => any): (type: any, propertyKey: string) => void;
-/**
- * Indicates that this property must be assigned to on deserialisation. The deserialiser will not try create a model instance of the object / array.
- */
-export declare function Raw(): (type: any, propertyKey: string) => void;
-/** Registers an onChanged event handler for changes to this property
- * @param requiresOldValue Set to true if this property is not tracked and you need the old value.
- * @param delayMs Number in milliseconds that can be used to debounce the callback function
-*/
-export declare function OnChanged<T>(callback: (target: T) => (oldValue: any, newValue: any) => void, requiresOldValue?: boolean, delayMs?: number): (type: T, propertyKey: string) => void;
-/**
- * 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.
- * @param value Override the default value.
- */
-export declare function Debounce(value?: boolean): (type: any, propertyKey: string) => void;
-/** Converts a getter into a computed. Note, when using NeoModel you do not need to do this. */
-export declare function Computed(isComputed?: boolean): (type: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/** Sets this property as the display member to be used in drop downs / radio lists etc. */
-export declare function DisplayMember(): (type: any, propertyKey: string) => void;
+import { SerialiseType, DataType, TimeZoneFormat } from './Misc';
+export declare function Display(name: string): (type: any, propertyKey: string) => void;
+/** Indicates that this is a date property. Json strings will be converted to date objects on deserialisation. */
+export declare function Date(timeZoneSerialisation?: TimeZoneFormat): (type: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
+/** Indicates that this is an integer number property. Editors will be restricted to integer numeric input. */
+export declare function Integer(): (type: any, propertyKey: string) => void;
+/**
+ * Indicates that this is a float number property.
+ * Editors will be restricted to float numeric input.
+ * @param decimals No of decimals allowed when storing this value. Used when binding to this property from a supporting ui component. If not specified, this will be determined from the format string. */
+export declare function Float(decimals?: number): (type: any, propertyKey: string) => void;
+/** Indicates that this is a decimal property (decimal type from the decimal.js-light package). */
+export declare function Decimal(): (type: any, propertyKey: string) => void;
+/** Indicates that this is a nullable boolean property. */
+export declare function NullableBoolean(): (type: any, propertyKey: string) => void;
+/** Indicates that this property accepts nulls from user input controls that do not normally accept nulls. E.g. numeric editors. */
+export declare function Nullable(dataType?: DataType): (type: any, propertyKey: string) => void;
+export declare function Observable(isObservable?: boolean): (type: any, propertyKey: string) => void;
+/** Indicates that changes to this property will not cause the object to become dirty. It will also not be serialised */
+export declare function NoTracking(serialisation?: SerialiseType): (type: any, propertyKey: string) => void;
+export declare function Serialisation(serialisation: SerialiseType): (type: any, propertyKey: string) => void;
+/** Indicates that this is a list property, and specifies the item type. This is not required if the list is initialised with a value. */
+export declare function ChildList(childType: any): (type: any, propertyKey: string) => any;
+/** Indicates that this is a child object property, and specifies the child type. This is not required if the property is initialised with a value. */
+export declare function ChildObject(childType: new () => any, isValueObject?: boolean): Function;
+export declare function ChildObject(childType: () => any, isValueObject?: boolean): Function;
+export declare function Dictionary(valueType: any): (type: any, propertyKey: string) => any;
+export declare function Parent(parentType: () => any): (type: any, propertyKey: string) => void;
+/**
+ * Indicates that this property must be assigned to on deserialisation. The deserialiser will not try create a model instance of the object / array.
+ */
+export declare function Raw(): (type: any, propertyKey: string) => void;
+/** Registers an onChanged event handler for changes to this property
+ * @param requiresOldValue Set to true if this property is not tracked and you need the old value.
+ * @param delayMs Number in milliseconds that can be used to debounce the callback function
+*/
+export declare function OnChanged<T>(callback: (target: T) => (oldValue: any, newValue: any) => void, requiresOldValue?: boolean, delayMs?: number): (type: T, propertyKey: string) => void;
+/**
+ * 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.
+ * @param value Override the default value.
+ */
+export declare function Debounce(value?: boolean): (type: any, propertyKey: string) => void;
+/** Converts a getter into a computed. Note, when using NeoModel you do not need to do this. */
+export declare function Computed(isComputed?: boolean): (type: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/** Specifies whether a method is a mobx action. By default all methods are actions.
+ * Use this decorator to suppress this behaviour (by passing in false), or change the default behaviour in the makeObservable options passed to makeObservable. */
+export declare function Action(isAction?: boolean): (type: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+/** Sets this property as the display member to be used in drop downs / radio lists etc. */
+export declare function DisplayMember(): (type: any, propertyKey: string) => void;