@singularsystems/neo-core 1.0.13 → 1.0.14

package/dist/Data/Deserialiser.js

@@ -63,7 +63,7 @@ var Deserialiser = /** @class */ (function () {
             }
         });
     };
-    Deserialiser.prototype.deserialiseArray = function (from, to, type) {
+    Deserialiser.prototype.deserialiseArray = function (from, to, type, itemFactory) {
         if (!to) {
             throw "Cannot deserialise array into a non initialised property.";
         }
@@ -99,7 +99,10 @@ var Deserialiser = /** @class */ (function () {
                     deserialise = false;
                 }
                 else {
-                    if (type) {
+                    if (itemFactory) {
+                        toItem = itemFactory(fromItem);
+                    }
+                    else if (type) {
                         toItem = new type();
                     }
                     else {
@@ -130,13 +133,14 @@ var Deserialiser = /** @class */ (function () {
             else {
                 var mustCreate = !to[key];
                 if (mustCreate) {
-                    to[key] = parentProperty.createValueInstance();
+                    to[key] = parentProperty.createValueInstance(fromItem);
                 }
                 this.deserialiseObject(fromItem, to[key], mustCreate);
             }
         }
     };
     Deserialiser.prototype.deserialiseObject = function (from, to, justCreated) {
+        var _a;
         if (!from || !to) {
             throw "From and to objects are required.";
         }
@@ -173,9 +177,9 @@ var Deserialiser = /** @class */ (function () {
                             }
                             else {
                                 if (fromValue instanceof Array && !propertyInfo.assignOnDeserialise) {
-                                    if (!to[key] || !(to[key] instanceof Array) || to[key].childObjectType) {
+                                    if (!to[key] || !(to[key] instanceof Array) || to[key].canDeserialise) {
                                         // Deserialise into full list.
-                                        this.deserialiseArray(fromValue, to[key], undefined);
+                                        this.deserialiseArray(fromValue, to[key], undefined, (_a = to[key]) === null || _a === void 0 ? void 0 : _a.itemFactory);
                                     }
                                     else {
                                         // Plain array
@@ -197,7 +201,7 @@ var Deserialiser = /** @class */ (function () {
                                         else {
                                             var mustCreate = !to[key];
                                             if (mustCreate) {
-                                                to[key] = propertyInfo.createValueInstance();
+                                                to[key] = propertyInfo.createValueInstance(fromValue);
                                             }
                                             this.deserialiseObject(fromValue, to[key], mustCreate);
                                         }

package/dist/Model/Decorators.d.ts

@@ -1,4 +1,5 @@
 import { SerialiseType, DataType, TimeZoneFormat } from './Misc';
+import { IObjectFactoryOptions } from './IModelBase';
 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;
@@ -20,10 +21,11 @@ export declare function Observable(isObservable?: boolean): (type: any, property
 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;
+export declare function ChildList(childType?: (new () => any) | (() => any) | IObjectFactoryOptions): (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 ChildObject(options: IObjectFactoryOptions, 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;
 /**

package/dist/Model/Decorators.js

@@ -85,7 +85,9 @@ export function Serialisation(serialisation) {
 export function ChildList(childType) {
     return function (type, propertyKey) {
         var pi = getOrAddPropertyInfo(type, propertyKey);
-        pi.setPropertyType(childType);
+        if (childType) {
+            pi.setPropertyType(childType);
+        }
         if (pi.relationType === RelationType.None) {
             pi.relationType = RelationType.ChildList;
             pi.propertyType = DataType.Array;

package/dist/Model/IModelBase.d.ts

@@ -101,4 +101,9 @@ export interface IModelBase extends INonObservableModelBase {
     readonly isDirty: boolean;
     readonly readyToSave: boolean;
 }
+export type ObjectFactory = (rawData: object) => object;
+export interface IObjectFactoryOptions {
+    /** Function that creates an instance of an object based on some input data. */
+    itemFactory: ObjectFactory;
+}
 export {};

package/dist/Model/List.d.ts

@@ -1,13 +1,19 @@
 import { ISerialiseOptions } from '../Data/Serialiser';
-import { PlainObject, PartialPlainObject, PlainTrackedObject, IMetaItem } from './IModelBase';
+import { PlainObject, PartialPlainObject, PlainTrackedObject, IMetaItem, ObjectFactory, IObjectFactoryOptions } from './IModelBase';
 import { IDeserialiseOptions } from '../Data/Deserialiser';
 export default class List<T> extends Array<T> {
-    childObjectType: (new () => T);
     attachedTo: object | null;
+    childObjectType?: new () => T;
+    itemFactory?: ObjectFactory;
     private _deletedList;
     get deletedList(): T[];
+    get canDeserialise(): ObjectFactory | (new () => T) | undefined;
     private baseMethods;
-    constructor(childObjectType: (new () => T));
+    /**
+     * Creates an instance of a list. A List is an array with the ability to auto create child instances, and track removed items.
+     * @param childObjectType Usually the type that the list contains. Can also pass in options for advanced usage.
+     */
+    constructor(childObjectType?: (new () => T) | IObjectFactoryOptions);
     /**
      * Copies the methods and properties from the prototype to the new instance.
      * This is needed because vue / mobx changes the prototype to its own.
@@ -69,7 +75,7 @@ export default class List<T> extends Array<T> {
     removeWithoutTracking(item: T): void;
     private removeItem;
     /** Returns a static meta object containing all the properties of the lists item type. */
-    getMetaItem(): IMetaItem;
+    getMetaItem(): IMetaItem | null;
     /** 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. */

package/dist/Model/List.js

@@ -5,10 +5,19 @@ import { ObservableValue } from './ObservableValue';
 import { NeoTypeInfo } from './NeoTypeInfo';
 var List = /** @class */ (function (_super) {
     __extends(List, _super);
+    /**
+     * Creates an instance of a list. A List is an array with the ability to auto create child instances, and track removed items.
+     * @param childObjectType Usually the type that the list contains. Can also pass in options for advanced usage.
+     */
     function List(childObjectType) {
         var _this = _super.call(this) || this;
-        _this.childObjectType = childObjectType;
         _this._deletedList = new ObservableValue([]);
+        if (typeof childObjectType === "function") {
+            _this.childObjectType = childObjectType;
+        }
+        else {
+            _this.itemFactory = childObjectType === null || childObjectType === void 0 ? void 0 : childObjectType.itemFactory;
+        }
         List.copyMethods(_this);
         return _this;
     }
@@ -19,6 +28,13 @@ var List = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(List.prototype, "canDeserialise", {
+        get: function () {
+            return this.itemFactory || this.childObjectType;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Copies the methods and properties from the prototype to the new instance.
      * This is needed because vue / mobx changes the prototype to its own.
@@ -80,6 +96,9 @@ var List = /** @class */ (function (_super) {
     };
     /** Creates a new item of type T */
     List.prototype.createChild = function () {
+        if (!this.childObjectType) {
+            throw "Cannot create child, type was not passed to constructor.";
+        }
         return new this.childObjectType();
     };
     List.prototype.push = function () {
@@ -89,7 +108,7 @@ var List = /** @class */ (function (_super) {
             items[_i] = arguments[_i];
         }
         items.forEach(function (item) {
-            if (!(item instanceof _this.childObjectType)) {
+            if (_this.childObjectType && !(item instanceof _this.childObjectType)) {
                 throw "Type error, cannot add item of type " + Utils.getTypeName(item.constructor) + " to list of type " + Utils.getTypeName(_this.childObjectType) + ".";
             }
             _this.setParent(item);
@@ -101,7 +120,7 @@ var List = /** @class */ (function (_super) {
     };
     List.prototype.setParent = function (item) {
         if (this.attachedTo) {
-            var itemConstructor = this.childObjectType.prototype.constructor;
+            var itemConstructor = item.constructor.prototype.constructor;
             // set the parent property
             if (itemConstructor.neo) {
                 var parentConstructor = this.attachedTo.constructor.prototype.constructor;
@@ -162,10 +181,13 @@ var List = /** @class */ (function (_super) {
         if (this.length) {
             return this[0];
         }
-        else {
+        else if (this.childObjectType) {
             var ctor = this.childObjectType.prototype.constructor;
             return NeoTypeInfo.ensureInitialised(ctor).metaItem;
         }
+        else {
+            return null;
+        }
     };
     Object.defineProperty(List.prototype, "isValid", {
         /** True if all items in the list are valid. */

package/dist/Model/ModelBase.d.ts

@@ -83,7 +83,7 @@ export default abstract class ModelBase extends BindableBase implements IModelBa
      * ```
      * protected static addBusinessRules(rules: ValidationRules<MyType>) {
      * ```  */
-    protected addBusinessRules(validationRules: ValidationRules<this>): void;
+    protected addBusinessRules(validationRules: ValidationRules<ModelBase>): void;
     /**
      * Add custom business rules for this type.
      */

package/dist/Model/ModelCreatorBase.js

@@ -61,11 +61,12 @@ var ModelCreatorBase = /** @class */ (function () {
         // @ts-ignore
         var propertyValue = instance[propertyInfo.propertyName];
         if (propertyValue) {
-            if (propertyValue.childObjectType) {
+            var list = propertyValue;
+            if (list.itemFactory || list.childObjectType) {
                 // This is a list.
                 if (propertyInfo.relationType != RelationType.ChildList) {
                     // add missing annotation
-                    propertyInfo = ChildList(propertyValue.childObjectType)(instance, propertyInfo.propertyName);
+                    propertyInfo = ChildList(list.itemFactory ? { itemFactory: list.itemFactory } : list.childObjectType)(instance, propertyInfo.propertyName);
                 }
             }
             else if (propertyValue instanceof ModelBase) {

package/dist/Model/NeoTypeInfo.d.ts

@@ -22,6 +22,7 @@ export declare class NeoTypeInfo {
     get inheritsBindableBase(): boolean;
     get inheritsModelBase(): boolean;
     get metaItem(): IMetaItem;
+    get typeName(): string;
     initialise(objectConstructor: NeoModelConstructor): void;
     private addPropertyInfo;
     getOrAddProperty(propertyName: string): PropertyInfo;

package/dist/Model/NeoTypeInfo.js

@@ -55,6 +55,13 @@ var NeoTypeInfo = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(NeoTypeInfo.prototype, "typeName", {
+        get: function () {
+            return this.objectConstructor.name;
+        },
+        enumerable: false,
+        configurable: true
+    });
     NeoTypeInfo.prototype.initialise = function (objectConstructor) {
         this.objectConstructor = objectConstructor;
     };

package/dist/Model/PropertyInfo.d.ts

@@ -1,6 +1,6 @@
 import { SerialiseType, RelationType, OnChangedOptions, DataType, TimeZoneFormat } from './Misc';
 import { Nullable } from '../Utils';
-import { INonObservableModelBase } from './IModelBase';
+import { INonObservableModelBase, IObjectFactoryOptions, ObjectFactory } from './IModelBase';
 import { Rule } from '../Validation/Rules';
 export type PropertyInfoMap = {
     [index: string]: PropertyInfo;
@@ -58,6 +58,8 @@ export default class PropertyInfo {
     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;
+    /** Object factory used for deserialisation. Set by ChildList / ChildObject decorators. */
+    itemFactory?: ObjectFactory;
     constructor(propertyName: string);
     /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
     get readableName(): string;
@@ -67,7 +69,7 @@ export default class PropertyInfo {
     get parent(): PropertyInfo | undefined;
     addAttributeRule(rule: Rule): void;
     clone(): PropertyInfo;
-    setPropertyType(propertyType: (() => any) | (new () => any)): void;
+    setPropertyType(propertyType: (() => any) | (new () => any) | IObjectFactoryOptions): void;
     /**
      * Gets the constructor function of the return type.
      * Returns null if the property has not been decorated with a ChildObject / Parent attribute.
@@ -78,6 +80,6 @@ export default class PropertyInfo {
      * Raises an error if the property has not been decorated with a ChildObject / Parent attribute.
      */
     get typeWithAssert(): new () => any;
-    createValueInstance(): any;
+    createValueInstance(data: any): any;
     setupFromInstance(instance: any): void;
 }

package/dist/Model/PropertyInfo.js

@@ -75,11 +75,16 @@ var PropertyInfo = /** @class */ (function () {
         return clone;
     };
     PropertyInfo.prototype.setPropertyType = function (propertyType) {
-        if (!propertyType.prototype || !propertyType.prototype.constructor.name) {
-            this.typeCallback = propertyType;
+        if (typeof propertyType === "function") {
+            if (!propertyType.prototype || !propertyType.prototype.constructor.name) {
+                this.typeCallback = propertyType;
+            }
+            else {
+                this._type = propertyType;
+            }
         }
         else {
-            this._type = propertyType;
+            this.itemFactory = propertyType.itemFactory;
         }
     };
     Object.defineProperty(PropertyInfo.prototype, "type", {
@@ -116,7 +121,10 @@ var PropertyInfo = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
-    PropertyInfo.prototype.createValueInstance = function () {
+    PropertyInfo.prototype.createValueInstance = function (data) {
+        if (this.itemFactory) {
+            return this.itemFactory(data);
+        }
         try {
             return new this.typeWithAssert();
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularsystems/neo-core",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@microsoft/signalr": "^6.0.1",
-    "axios": "1.6.7",
+    "axios": "1.7.4",
     "inversify": "^6.0.2",
     "reflect-metadata": "0.1.13",
     "tslib": "2.5.0"