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

package/dist/Model/BaseModels/AuditValues.js

@@ -1,48 +1,46 @@
-import { __decorate, __extends, __metadata } from "tslib";
-import ValueObject from '../ValueObject';
-import { Date as DateAttribute } from '../Decorators';
-import NeoModel from '../NeoModel';
-var AuditValuesBase = /** @class */ (function (_super) {
-    __extends(AuditValuesBase, _super);
-    function AuditValuesBase() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.createdBy = 0;
-        _this.createdOn = new Date();
-        _this.modifiedBy = 0;
-        _this.modifiedOn = new Date();
-        return _this;
-    }
-    // Client only properties / methods
-    AuditValuesBase.prototype.addBusinessRules = function (rules) {
-        _super.prototype.addBusinessRules.call(this, rules);
-    };
-    AuditValuesBase.prototype.toString = function () {
-        if (this.isNew) {
-            return "New audit values";
-        }
-        else {
-            return "Audit Values";
-        }
-    };
-    __decorate([
-        DateAttribute(),
-        __metadata("design:type", Date)
-    ], AuditValuesBase.prototype, "createdOn", void 0);
-    __decorate([
-        DateAttribute(),
-        __metadata("design:type", Date)
-    ], AuditValuesBase.prototype, "modifiedOn", void 0);
-    return AuditValuesBase;
-}(ValueObject));
-export { AuditValuesBase };
-var AuditValues = /** @class */ (function (_super) {
-    __extends(AuditValues, _super);
-    function AuditValues() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    AuditValues = __decorate([
-        NeoModel
-    ], AuditValues);
-    return AuditValues;
-}(AuditValuesBase));
-export { AuditValues };
+import { __decorate, __extends, __metadata } from "tslib";
+import ValueObject from '../ValueObject';
+import { Date as DateAttribute } from '../Decorators';
+import NeoModel from '../NeoModel';
+export var AuditValuesBase = /** @class */ (function (_super) {
+    __extends(AuditValuesBase, _super);
+    function AuditValuesBase() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.createdBy = 0;
+        _this.createdOn = new Date();
+        _this.modifiedBy = 0;
+        _this.modifiedOn = new Date();
+        return _this;
+    }
+    // Client only properties / methods
+    AuditValuesBase.prototype.addBusinessRules = function (rules) {
+        _super.prototype.addBusinessRules.call(this, rules);
+    };
+    AuditValuesBase.prototype.toString = function () {
+        if (this.isNew) {
+            return "New audit values";
+        }
+        else {
+            return "Audit Values";
+        }
+    };
+    __decorate([
+        DateAttribute(),
+        __metadata("design:type", Date)
+    ], AuditValuesBase.prototype, "createdOn", void 0);
+    __decorate([
+        DateAttribute(),
+        __metadata("design:type", Date)
+    ], AuditValuesBase.prototype, "modifiedOn", void 0);
+    return AuditValuesBase;
+}(ValueObject));
+export var AuditValues = /** @class */ (function (_super) {
+    __extends(AuditValues, _super);
+    function AuditValues() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    AuditValues = __decorate([
+        NeoModel
+    ], AuditValues);
+    return AuditValues;
+}(AuditValuesBase));

package/dist/Model/BaseModels/CriteriaBase.d.ts

@@ -1,16 +1,18 @@
-import { ModelFieldInfo } from "../ModelFieldInfo";
-import ValueObject from "../ValueObject";
-export declare abstract class CriteriaBase extends ValueObject {
-    /**
-     * Extra information about lookup fields in this object.
-     */
-    fieldInfo: {
-        [K in keyof this]?: ModelFieldInfo;
-    };
-    /**
-     * Initialise the fieldInfo dictionary for the passed in properties.
-     * This is only necessary if you need to bind to the ModelFieldInfo values.
-     * You must also call this.makeObservable(); instead of using the @NeoModel decorator.
-     */
-    protected initialiseFieldInfo(fields: (keyof this)[]): void;
-}
+import { IModelFieldInfoContainer, ModelFieldInfo } from "../ModelFieldInfo";
+import PropertyInfo from "../PropertyInfo";
+import ValueObject from "../ValueObject";
+export declare abstract class CriteriaBase extends ValueObject implements IModelFieldInfoContainer {
+    /**
+     * Extra information about lookup fields in this object.
+     */
+    fieldInfo: {
+        [K in keyof this]?: ModelFieldInfo;
+    };
+    /**
+     * Initialise the fieldInfo dictionary for the passed in properties.
+     * This is only necessary if you need to bind to the ModelFieldInfo values.
+     * You must also call this.makeObservable(); instead of using the @NeoModel decorator.
+     */
+    protected initialiseFieldInfo(fields: (keyof this)[]): void;
+    setModelFieldInfo(property: PropertyInfo, displayValue: string): ModelFieldInfo;
+}

package/dist/Model/BaseModels/CriteriaBase.js

@@ -1,34 +1,45 @@
-import { __decorate, __extends, __metadata } from "tslib";
-import { Dictionary } from "../Decorators";
-import { ModelFieldInfo } from "../ModelFieldInfo";
-import ValueObject from "../ValueObject";
-var CriteriaBase = /** @class */ (function (_super) {
-    __extends(CriteriaBase, _super);
-    function CriteriaBase() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        /**
-         * Extra information about lookup fields in this object.
-         */
-        _this.fieldInfo = {};
-        return _this;
-    }
-    /**
-     * Initialise the fieldInfo dictionary for the passed in properties.
-     * This is only necessary if you need to bind to the ModelFieldInfo values.
-     * You must also call this.makeObservable(); instead of using the @NeoModel decorator.
-     */
-    CriteriaBase.prototype.initialiseFieldInfo = function (fields) {
-        for (var _i = 0, fields_1 = fields; _i < fields_1.length; _i++) {
-            var field = fields_1[_i];
-            if (!this.fieldInfo[field]) {
-                this.fieldInfo[field] = new ModelFieldInfo(this.meta[field].propertyInfo.readableName, "");
-            }
-        }
-    };
-    __decorate([
-        Dictionary(ModelFieldInfo),
-        __metadata("design:type", Object)
-    ], CriteriaBase.prototype, "fieldInfo", void 0);
-    return CriteriaBase;
-}(ValueObject));
-export { CriteriaBase };
+import { __decorate, __extends, __metadata } from "tslib";
+import { Dictionary } from "../Decorators";
+import { ModelFieldInfo } from "../ModelFieldInfo";
+import ValueObject from "../ValueObject";
+export var CriteriaBase = /** @class */ (function (_super) {
+    __extends(CriteriaBase, _super);
+    function CriteriaBase() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        /**
+         * Extra information about lookup fields in this object.
+         */
+        _this.fieldInfo = {};
+        return _this;
+    }
+    /**
+     * Initialise the fieldInfo dictionary for the passed in properties.
+     * This is only necessary if you need to bind to the ModelFieldInfo values.
+     * You must also call this.makeObservable(); instead of using the @NeoModel decorator.
+     */
+    CriteriaBase.prototype.initialiseFieldInfo = function (fields) {
+        for (var _i = 0, fields_1 = fields; _i < fields_1.length; _i++) {
+            var field = fields_1[_i];
+            if (!this.fieldInfo[field]) {
+                this.fieldInfo[field] = new ModelFieldInfo(this.meta[field].propertyInfo.readableName, "");
+            }
+        }
+    };
+    CriteriaBase.prototype.setModelFieldInfo = function (property, displayValue) {
+        var propertyName = property.propertyName;
+        var fieldInfo = this.fieldInfo[propertyName];
+        if (!fieldInfo) {
+            fieldInfo = new ModelFieldInfo(property.readableName, displayValue);
+            this.fieldInfo[propertyName] = fieldInfo;
+        }
+        else {
+            fieldInfo.valueString = displayValue;
+        }
+        return fieldInfo;
+    };
+    __decorate([
+        Dictionary(ModelFieldInfo),
+        __metadata("design:type", Object)
+    ], CriteriaBase.prototype, "fieldInfo", void 0);
+    return CriteriaBase;
+}(ValueObject));

package/dist/Model/BaseModels/FileDescriptorBase.d.ts

@@ -1,12 +1,12 @@
-import ModelBase from '../ModelBase';
-import { ValidationRules } from '../../Validation/ValidationRules';
-import { IFileDescriptor } from '../../Components/FileManager/IFileManagerOptions';
-export declare abstract class FileDescriptorBase<TKey extends string | number = number> extends ModelBase implements IFileDescriptor {
-    fileDescriptorId: TKey | null;
-    fileHash: string;
-    storageKey: string;
-    fileDataId: number | null;
-    fileName: string;
-    addBusinessRules(rules: ValidationRules<this>): void;
-    toString(): string;
-}
+import ModelBase from '../ModelBase';
+import { ValidationRules } from '../../Validation/ValidationRules';
+import { IFileDescriptor } from '../../Components/FileManager/IFileManagerOptions';
+export declare abstract class FileDescriptorBase<TKey extends string | number = number> extends ModelBase implements IFileDescriptor {
+    fileDescriptorId: TKey | null;
+    fileHash: string;
+    storageKey: string;
+    fileDataId: number | null;
+    fileName: string;
+    addBusinessRules(rules: ValidationRules<this>): void;
+    toString(): string;
+}

package/dist/Model/BaseModels/FileDescriptorBase.js

@@ -1,22 +1,22 @@
-import { __extends } from "tslib";
-import ModelBase from '../ModelBase';
-var FileDescriptorBase = /** @class */ (function (_super) {
-    __extends(FileDescriptorBase, _super);
-    function FileDescriptorBase() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.fileDescriptorId = null;
-        _this.fileHash = "";
-        _this.storageKey = "";
-        _this.fileDataId = null;
-        _this.fileName = "";
-        return _this;
-    }
-    FileDescriptorBase.prototype.addBusinessRules = function (rules) {
-        _super.prototype.addBusinessRules.call(this, rules);
-    };
-    FileDescriptorBase.prototype.toString = function () {
-        return this.fileName && this.fileName.length > 0 ? this.fileName : "File Descriptor";
-    };
-    return FileDescriptorBase;
-}(ModelBase));
-export { FileDescriptorBase };
+import { __extends } from "tslib";
+import ModelBase from '../ModelBase';
+var FileDescriptorBase = /** @class */ (function (_super) {
+    __extends(FileDescriptorBase, _super);
+    function FileDescriptorBase() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.fileDescriptorId = null;
+        _this.fileHash = "";
+        _this.storageKey = "";
+        _this.fileDataId = null;
+        _this.fileName = "";
+        return _this;
+    }
+    FileDescriptorBase.prototype.addBusinessRules = function (rules) {
+        _super.prototype.addBusinessRules.call(this, rules);
+    };
+    FileDescriptorBase.prototype.toString = function () {
+        return this.fileName && this.fileName.length > 0 ? this.fileName : "File Descriptor";
+    };
+    return FileDescriptorBase;
+}(ModelBase));
+export { FileDescriptorBase };

package/dist/Model/BaseModels/ReasonedUserEvent.d.ts

@@ -1,4 +1,5 @@
-import { UserEventBase } from './UserEvent';
-export declare class ReasonedUserEvent extends UserEventBase {
-    reason: string;
-}
+import { UserEventBase } from './UserEvent';
+export declare class ReasonedUserEvent extends UserEventBase {
+    reason: string;
+    static None(): ReasonedUserEvent;
+}

package/dist/Model/BaseModels/ReasonedUserEvent.js

@@ -1,19 +1,23 @@
-import { __decorate, __extends, __metadata } from "tslib";
-import { UserEventBase } from './UserEvent';
-import NeoModel from '../NeoModel';
-import { StringLength } from '../../Validation/Decorators';
-var ReasonedUserEvent = /** @class */ (function (_super) {
-    __extends(ReasonedUserEvent, _super);
-    function ReasonedUserEvent() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    __decorate([
-        StringLength(255),
-        __metadata("design:type", String)
-    ], ReasonedUserEvent.prototype, "reason", void 0);
-    ReasonedUserEvent = __decorate([
-        NeoModel
-    ], ReasonedUserEvent);
-    return ReasonedUserEvent;
-}(UserEventBase));
-export { ReasonedUserEvent };
+import { __decorate, __extends, __metadata } from "tslib";
+import { UserEventBase } from './UserEvent';
+import NeoModel from '../NeoModel';
+import { StringLength } from '../../Validation/Decorators';
+export var ReasonedUserEvent = /** @class */ (function (_super) {
+    __extends(ReasonedUserEvent, _super);
+    function ReasonedUserEvent() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    ReasonedUserEvent_1 = ReasonedUserEvent;
+    ReasonedUserEvent.None = function () {
+        return new ReasonedUserEvent_1();
+    };
+    var ReasonedUserEvent_1;
+    __decorate([
+        StringLength(255),
+        __metadata("design:type", String)
+    ], ReasonedUserEvent.prototype, "reason", void 0);
+    ReasonedUserEvent = ReasonedUserEvent_1 = __decorate([
+        NeoModel
+    ], ReasonedUserEvent);
+    return ReasonedUserEvent;
+}(UserEventBase));

package/dist/Model/BaseModels/UserEvent.d.ts

@@ -1,8 +1,9 @@
-import ValueObject from '../ValueObject';
-export declare abstract class UserEventBase extends ValueObject {
-    by: number | null;
-    on: Date | null;
-    get isCompleted(): boolean;
-}
-export declare class UserEvent extends UserEventBase {
-}
+import ValueObject from '../ValueObject';
+export declare abstract class UserEventBase extends ValueObject {
+    by: number | null;
+    on: Date | null;
+    get isCompleted(): boolean;
+}
+export declare class UserEvent extends UserEventBase {
+    static None(): UserEvent;
+}

package/dist/Model/BaseModels/UserEvent.js

@@ -1,32 +1,36 @@
-import { __decorate, __extends } from "tslib";
-import ValueObject from '../ValueObject';
-import NeoModel from '../NeoModel';
-var UserEventBase = /** @class */ (function (_super) {
-    __extends(UserEventBase, _super);
-    function UserEventBase() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.by = null;
-        _this.on = null;
-        return _this;
-    }
-    Object.defineProperty(UserEventBase.prototype, "isCompleted", {
-        get: function () {
-            return !!this.on;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return UserEventBase;
-}(ValueObject));
-export { UserEventBase };
-var UserEvent = /** @class */ (function (_super) {
-    __extends(UserEvent, _super);
-    function UserEvent() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    UserEvent = __decorate([
-        NeoModel
-    ], UserEvent);
-    return UserEvent;
-}(UserEventBase));
-export { UserEvent };
+import { __decorate, __extends } from "tslib";
+import ValueObject from '../ValueObject';
+import NeoModel from '../NeoModel';
+var UserEventBase = /** @class */ (function (_super) {
+    __extends(UserEventBase, _super);
+    function UserEventBase() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.by = null;
+        _this.on = null;
+        return _this;
+    }
+    Object.defineProperty(UserEventBase.prototype, "isCompleted", {
+        get: function () {
+            return !!this.on;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return UserEventBase;
+}(ValueObject));
+export { UserEventBase };
+export var UserEvent = /** @class */ (function (_super) {
+    __extends(UserEvent, _super);
+    function UserEvent() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    UserEvent_1 = UserEvent;
+    UserEvent.None = function () {
+        return new UserEvent_1();
+    };
+    var UserEvent_1;
+    UserEvent = UserEvent_1 = __decorate([
+        NeoModel
+    ], UserEvent);
+    return UserEvent;
+}(UserEventBase));

package/dist/Model/BindableBase.d.ts

@@ -1,40 +1,46 @@
-import { TransformMetaType, PartialPlainObject, PlainFlatObject, PartialOrNull } from './IModelBase';
-import { NeoTypeInfo } from './NeoTypeInfo';
-import { IDeserialiseOptions } from '../Data/Deserialiser';
-export declare abstract class BindableBase {
-    meta: TransformMetaType<this>;
-    entityIdentifier: string;
-    /**
-     * 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)
-     * */
-    set(jsObject: PartialPlainObject<this>, options?: IDeserialiseOptions): void;
-    /**
-     * Copies the provided objects properties into this objects properties. Matches on name.
-     * Syncs child lists by default unless configured in the options argument.
-     */
-    mapFrom(object: PartialOrNull<PlainFlatObject<this>>, options?: IDeserialiseOptions): this;
-    /**
-     * Performs a deep clone on an object. Equivalent to Type.mapFrom(this).
-     */
-    clone(): this;
-    /**
-     * Called once a deserialise batch has completed.
-     */
-    protected onDeserialiseCompleted(wasCreated: boolean): void;
-    /**
-     * 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.
-     */
-    protected makeObservable(): void;
-    static neo: NeoTypeInfo;
-    /**
-     * Creates a new instance of this type, and deserialises the plain javascript object graph into it.
-     * @param jsObject Plain js object
-     */
-    static fromJSObject<T extends BindableBase>(jsObject: PartialPlainObject<T>, options?: IDeserialiseOptions): T;
-    static mapFrom<T extends BindableBase>(object: PartialOrNull<PlainFlatObject<T>>, options?: IDeserialiseOptions): T;
-}
+import { TransformMetaType, PartialPlainObject, PlainFlatObject, PartialOrNull, IMakeBindableOptions } from './IModelBase';
+import { NeoTypeInfo } from './NeoTypeInfo';
+import { IDeserialiseOptions } from '../Data/Deserialiser';
+export declare abstract class BindableBase {
+    meta: TransformMetaType<this>;
+    entityIdentifier: string;
+    /**
+     * 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)
+     * */
+    set(jsObject: PartialPlainObject<this>, options?: IDeserialiseOptions): void;
+    /**
+     * Copies the provided objects properties into this objects properties. Matches on name.
+     * Syncs child lists by default unless configured in the options argument.
+     */
+    mapFrom(object: PartialOrNull<PlainFlatObject<this>>, options?: IDeserialiseOptions): this;
+    /**
+     * Performs a deep clone on an object. Equivalent to Type.mapFrom(this).
+     */
+    clone(): this;
+    /**
+     * Called once a deserialise batch has completed.
+     */
+    protected onDeserialiseCompleted(wasCreated: boolean): void;
+    /**
+     * 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.
+     */
+    protected makeObservable(): void;
+    /**
+     * 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.
+     */
+    protected makeBindable(options?: IMakeBindableOptions): void;
+    static neo: NeoTypeInfo;
+    /**
+     * Creates a new instance of this type, and deserialises the plain javascript object graph into it.
+     * @param jsObject Plain js object
+     */
+    static fromJSObject<T extends BindableBase>(jsObject: PartialPlainObject<T>, options?: IDeserialiseOptions): T;
+    static mapFrom<T extends BindableBase>(object: PartialOrNull<PlainFlatObject<T>>, options?: IDeserialiseOptions): T;
+}