@singularsystems/neo-core 1.3.5 → 1.3.6

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Neo core changelog
 
+## Version 1.3.6 (18 Nov 2025)
+
+- Deserialiser
+    - Fixed plain arrays not deserialising when marked with `ChildList` attribute.
+
 ## Version 1.3.5 (30 Oct 2025)
 
 - PageManager

package/dist/Components/Modal/ModalOptions.d.ts

@@ -37,6 +37,10 @@ export default interface IModalOptions extends IModalOptionsBase {
     onClose: (event: any) => void;
     children: any;
 }
+export interface ICodeModalOptions extends IModalOptions {
+    /** Indicates that this modal was created using ModalUtils. */
+    isCodeModal: true;
+}
 export interface IModalOptionsAuto extends IModalOptionsBase {
     /**
      * Controls the visibility of the modal.

package/dist/Components/Modal/ModalStore.d.ts

@@ -1,17 +1,17 @@
-import IModalOptions from './ModalOptions';
+import IModalOptions, { ICodeModalOptions } from './ModalOptions';
 export interface IModalStore {
     modals: CodeModal[];
     addModal(title: string, message: any, modalOptions: Partial<IModalOptions>): ICodeModal;
     removeModal(modal: CodeModal): void;
 }
 /**
- * Represents a list of modal components added programatically.
+ * Represents a list of modal components added programmatically.
  * Modals will be removed from the list when they are closed by the user, and the animation has been complete.
  * A modal container will render modals based on the information in this list
  */
 export default class ModalStore implements IModalStore {
     modals: CodeModal[];
-    addModal(title: string, message: any, modalOptions: Partial<IModalOptions>): ICodeModal;
+    addModal(title: string, message: any, modalOptions: Partial<ICodeModalOptions>): ICodeModal;
     removeModal(modal: CodeModal): void;
 }
 export interface ICodeModal {
@@ -22,8 +22,8 @@ export interface ICodeModal {
 declare class CodeModal implements ICodeModal {
     private store;
     content: any;
-    options: IModalOptions;
-    constructor(store: IModalStore, content: any, options: IModalOptions);
+    options: ICodeModalOptions;
+    constructor(store: IModalStore, content: any, options: ICodeModalOptions);
     interceptClick(onClick?: (e: any) => void): (e: any) => void;
     id: string;
     close(): void;

package/dist/Components/Modal/ModalStore.js

@@ -5,7 +5,7 @@ import { Settings } from '../../Settings';
 import { Utils } from '../../Utils';
 import { injectable } from 'inversify';
 /**
- * Represents a list of modal components added programatically.
+ * Represents a list of modal components added programmatically.
  * Modals will be removed from the list when they are closed by the user, and the animation has been complete.
  * A modal container will render modals based on the information in this list
  */
@@ -14,6 +14,7 @@ var ModalStore = /** @class */ (function () {
         this.modals = [];
     }
     ModalStore.prototype.addModal = function (title, message, modalOptions) {
+        modalOptions.isCodeModal = true;
         modalOptions.title = title;
         modalOptions.show = true;
         var codeModal = new CodeModal(this, message, modalOptions);

package/dist/Data/Deserialiser.d.ts

@@ -1,4 +1,4 @@
-import { IModelBase, IBindableBase } from '../Model/IModelBase';
+import { IBindableBase, ItemConstructor } from '../Model/IModelBase';
 import { PropertyInfoMap } from '../Model/PropertyInfo';
 interface IMapOptions {
     includeEntityIdentifiers?: boolean;
@@ -32,7 +32,7 @@ export declare class Deserialiser {
      * Called after an object has been deserialised. Object tracking should be re-enabled here.
      */
     protected endObjectDeserialise(object: any, wasCreated: boolean): void;
-    deserialise(from: object, to: IBindableBase | IBindableBase[], rootType?: new () => IModelBase, options?: IDeserialiseOptions, justCreated?: boolean): void;
+    deserialise(from: object, to: IBindableBase | IBindableBase[], itemConstructor?: ItemConstructor, options?: IDeserialiseOptions, justCreated?: boolean): void;
     private cleanUp;
     private deserialiseArray;
     private deserialiseDictionary;

package/dist/Data/Deserialiser.js

@@ -1,3 +1,4 @@
+import { createItemInstance, disambiguateItemConstructor } from '../Model/IModelBase';
 import { TrackingState, SerialiseType, DataType, RelationType, RemoveItemBehavior } from '../Model/Misc';
 import { Utils } from '../Utils';
 import NumberUtils from "../NumberUtils";
@@ -30,7 +31,7 @@ var Deserialiser = /** @class */ (function () {
             object.onDeserialiseCompleted(wasCreated);
         }
     };
-    Deserialiser.prototype.deserialise = function (from, to, rootType, options, justCreated) {
+    Deserialiser.prototype.deserialise = function (from, to, itemConstructor, options, justCreated) {
         var _this = this;
         if (options === void 0) { options = {}; }
         if (justCreated === void 0) { justCreated = false; }
@@ -40,7 +41,7 @@ var Deserialiser = /** @class */ (function () {
         try {
             Utils.batchUpdate(function () {
                 if (from instanceof Array) {
-                    _this.deserialiseArray(from, to, rootType);
+                    _this.deserialiseArray(from, to, itemConstructor ? disambiguateItemConstructor(itemConstructor) : undefined);
                 }
                 else {
                     _this.deserialiseObject(from, to, justCreated);
@@ -63,7 +64,7 @@ var Deserialiser = /** @class */ (function () {
             }
         });
     };
-    Deserialiser.prototype.deserialiseArray = function (from, to, type, itemFactory) {
+    Deserialiser.prototype.deserialiseArray = function (from, to, itemConstructorOptions) {
         var _a;
         if (!to) {
             throw "Cannot deserialise array into a non initialised property.";
@@ -106,14 +107,11 @@ var Deserialiser = /** @class */ (function () {
                     deserialise = false;
                 }
                 else {
-                    if (itemFactory) {
-                        toItem = itemFactory(fromItem);
-                    }
-                    else if (type) {
-                        toItem = new type();
+                    if (itemConstructorOptions) {
+                        toItem = createItemInstance(itemConstructorOptions, fromItem);
                     }
                     else {
-                        toItem = to.createChild();
+                        toItem = to.createChild(fromItem);
                     }
                 }
             }
@@ -134,7 +132,7 @@ var Deserialiser = /** @class */ (function () {
         if (list.deletedList) {
             list.clearDeletedList();
         }
-        if (deletedItems) {
+        if (deletedItems.length > 0) {
             (_a = list.deletedList).push.apply(_a, deletedItems);
         }
     };
@@ -154,7 +152,6 @@ var Deserialiser = /** @class */ (function () {
         }
     };
     Deserialiser.prototype.deserialiseObject = function (from, to, justCreated) {
-        var _a;
         if (!from || !to) {
             throw "From and to objects are required.";
         }
@@ -192,8 +189,12 @@ var Deserialiser = /** @class */ (function () {
                             else {
                                 if (fromValue instanceof Array && !propertyInfo.assignOnDeserialise) {
                                     if (!to[key] || !(to[key] instanceof Array) || to[key].canDeserialise) {
-                                        // Deserialise into full list.
-                                        this.deserialiseArray(fromValue, to[key], undefined, (_a = to[key]) === null || _a === void 0 ? void 0 : _a.itemFactory);
+                                        // Deserialise into full list / array.
+                                        if (!to[key] && propertyInfo.relationType === RelationType.ChildList) {
+                                            // If the property is null, assume it is an array, not a list.
+                                            to[key] = [];
+                                        }
+                                        this.deserialiseArray(fromValue, to[key], propertyInfo.itemConstructorOptions);
                                     }
                                     else {
                                         // Plain array

package/dist/Model/Decorators.d.ts

@@ -1,5 +1,5 @@
 import { SerialiseType, DataType, TimeZoneFormat } from './Misc';
-import { IObjectFactoryOptions } from './IModelBase';
+import { IObjectFactoryOptions, ItemConstructor } 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;
@@ -21,7 +21,7 @@ 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?: (new () => any) | (() => any) | IObjectFactoryOptions): (type: any, propertyKey: string) => any;
+export declare function ChildList(childType?: ItemConstructor): (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;

package/dist/Model/IModelBase.d.ts

@@ -107,7 +107,15 @@ export interface IModelBaseStatic {
     new (): IModelBase;
     typeName: string;
 }
-export type ObjectFactory = (rawData: object) => object;
+export type ItemConstructor<T = any> = (new () => T) | (() => T) | IObjectFactoryOptions;
+export type ItemConstructorOptions = {
+    type?: new () => any;
+    typeCallback?: () => any;
+    itemFactory?: ObjectFactory;
+};
+export declare function disambiguateItemConstructor(factory: ItemConstructor): ItemConstructorOptions;
+export declare function createItemInstance(options: ItemConstructorOptions, rawData: object): object;
+export type ObjectFactory = (rawData?: object) => object;
 export interface IObjectFactoryOptions {
     /** Function that creates an instance of an object based on some input data. */
     itemFactory: ObjectFactory;

package/dist/Model/IModelBase.js

@@ -1 +1,26 @@
-export {};
+export function disambiguateItemConstructor(factory) {
+    var _a;
+    if (typeof factory === "function") {
+        var constructor = (_a = factory.prototype) === null || _a === void 0 ? void 0 : _a.constructor;
+        // Anonymous functions have a constructor name of "" or undefined.
+        if ((constructor === null || constructor === void 0 ? void 0 : constructor.neo) === undefined && (!factory.prototype || !(constructor === null || constructor === void 0 ? void 0 : constructor.name))) {
+            return { typeCallback: factory };
+        }
+        else {
+            return { type: factory };
+        }
+    }
+    else {
+        return { itemFactory: factory.itemFactory };
+    }
+}
+export function createItemInstance(options, rawData) {
+    var _a;
+    if (options.itemFactory) {
+        return options.itemFactory(rawData);
+    }
+    else {
+        var type = (_a = options.type) !== null && _a !== void 0 ? _a : options.typeCallback();
+        return new type();
+    }
+}

package/dist/Model/List.d.ts

@@ -67,7 +67,7 @@ export default class List<T> extends Array<T> {
      */
     static fromJSArray<T>(childType: new () => T, jsArray: PartialPlainObject<T>[], deserialiseOptions?: IDeserialiseOptions, listOptions?: IListCreationOptions): List<T>;
     /** Creates a new item of type T */
-    createChild(): T;
+    createChild(data?: object): T;
     push(...items: T[]): any;
     clearDeletedList(): void;
     private setParent;

package/dist/Model/List.js

@@ -118,11 +118,16 @@ var List = /** @class */ (function (_super) {
         return list;
     };
     /** Creates a new item of type T */
-    List.prototype.createChild = function () {
-        if (!this.childObjectType) {
+    List.prototype.createChild = function (data) {
+        if (this.itemFactory) {
+            return this.itemFactory(data);
+        }
+        else if (this.childObjectType) {
+            return new this.childObjectType();
+        }
+        else {
             throw "Cannot create child, type was not passed to constructor.";
         }
-        return new this.childObjectType();
     };
     List.prototype.push = function () {
         var _this = this;

package/dist/Model/PropertyInfo.d.ts

@@ -1,6 +1,6 @@
 import { SerialiseType, RelationType, OnChangedOptions, DataType, TimeZoneFormat } from './Misc';
 import { Nullable } from '../Utils';
-import { INonObservableModelBase, IObjectFactoryOptions, ObjectFactory } from './IModelBase';
+import { INonObservableModelBase, ItemConstructor, ItemConstructorOptions, ObjectFactory } from './IModelBase';
 import { Rule } from '../Validation/Rules';
 export type PropertyInfoMap = {
     [index: string]: PropertyInfo;
@@ -13,10 +13,6 @@ export default class PropertyInfo {
     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. */
@@ -59,7 +55,8 @@ export default class PropertyInfo {
     /** 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;
+    get itemFactory(): ObjectFactory | undefined;
+    itemConstructorOptions?: ItemConstructorOptions;
     constructor(propertyName: string);
     /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
     get readableName(): string;
@@ -69,7 +66,7 @@ export default class PropertyInfo {
     get parent(): PropertyInfo | undefined;
     addAttributeRule(rule: Rule): void;
     clone(): PropertyInfo;
-    setPropertyType(propertyType: (() => any) | (new () => any) | IObjectFactoryOptions): void;
+    setPropertyType(propertyType: ItemConstructor): void;
     /**
      * Gets the constructor function of the return type.
      * Returns null if the property has not been decorated with a ChildObject / Parent attribute.

package/dist/Model/PropertyInfo.js

@@ -1,5 +1,6 @@
 import { __spreadArray } from "tslib";
 import { SerialiseType, RelationType, DataType } from './Misc';
+import { disambiguateItemConstructor } from './IModelBase';
 import NumberUtils from "../NumberUtils";
 var PropertyInfo = /** @class */ (function () {
     function PropertyInfo(propertyName) {
@@ -32,6 +33,15 @@ var PropertyInfo = /** @class */ (function () {
         /** 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, "itemFactory", {
+        /** Object factory used for deserialisation. Set by ChildList / ChildObject decorators. */
+        get: function () {
+            var _a;
+            return (_a = this.itemConstructorOptions) === null || _a === void 0 ? void 0 : _a.itemFactory;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(PropertyInfo.prototype, "readableName", {
         /** Gets the readable name of the property. Uses string.readable if Display decorator was not specified. */
         get: function () {
@@ -75,20 +85,7 @@ var PropertyInfo = /** @class */ (function () {
         return clone;
     };
     PropertyInfo.prototype.setPropertyType = function (propertyType) {
-        var _a;
-        if (typeof propertyType === "function") {
-            var constructor = (_a = propertyType.prototype) === null || _a === void 0 ? void 0 : _a.constructor;
-            // Anonymous functions have a constructor name of "" or undefined.
-            if ((constructor === null || constructor === void 0 ? void 0 : constructor.neo) === undefined && (!propertyType.prototype || !(constructor === null || constructor === void 0 ? void 0 : constructor.name))) {
-                this.typeCallback = propertyType;
-            }
-            else {
-                this._type = propertyType;
-            }
-        }
-        else {
-            this.itemFactory = propertyType.itemFactory;
-        }
+        this.itemConstructorOptions = disambiguateItemConstructor(propertyType);
     };
     Object.defineProperty(PropertyInfo.prototype, "type", {
         /**
@@ -96,11 +93,12 @@ var PropertyInfo = /** @class */ (function () {
          * Returns null if the property has not been decorated with a ChildObject / Parent attribute.
          */
         get: function () {
-            if (this.typeCallback !== undefined) {
-                return this.typeCallback();
+            var _a, _b;
+            if (((_a = this.itemConstructorOptions) === null || _a === void 0 ? void 0 : _a.typeCallback) !== undefined) {
+                return this.itemConstructorOptions.typeCallback();
             }
-            else if (this._type) {
-                return this._type;
+            else if ((_b = this.itemConstructorOptions) === null || _b === void 0 ? void 0 : _b.type) {
+                return this.itemConstructorOptions.type;
             }
             else {
                 return null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularsystems/neo-core",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",