@singularsystems/neo-core 1.2.3 → 1.3.0

package/dist/AppServices/Config/ConfigService.d.ts

@@ -23,4 +23,6 @@ export declare class ConfigService implements IConfigService {
     fetchConfig(path?: string | undefined): AxiosPromise<any>;
     setConfig(configData: any): IConfigModel;
     static get isDevelopment(): boolean;
+    /** Throws the error if in development mode, otherwise logs it. */
+    static tryShowError(e: any): void;
 }

package/dist/AppServices/Config/ConfigService.js

@@ -61,6 +61,15 @@ var ConfigService = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /** Throws the error if in development mode, otherwise logs it. */
+    ConfigService.tryShowError = function (e) {
+        if (this.isDevelopment) {
+            throw e;
+        }
+        else {
+            console.error(e);
+        }
+    };
     ConfigService = __decorate([
         injectable(),
         __param(0, inject(NeoTypes.Config.ConfigModel.symbol)),

package/dist/Components/BootstrapTypes.d.ts

@@ -7,31 +7,21 @@ export type flexJustifyContent = "start" | "end" | "center" | "between";
 export type breakpoint = "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
 export type ElementOrText = any;
 export type BorderType = "standard" | "borderless" | "bordered";
-export interface IColumnWidthBreakpoints {
-    /** Number of columns to span when the screen is extra small or bigger */
-    xs?: columnWidth;
-    /** Number of columns to span when the screen is small or bigger */
-    sm?: columnWidth;
-    /** Number of columns to span when the screen is medium or bigger */
-    md?: columnWidth;
-    /** Number of columns to span when the screen is large or bigger */
-    lg?: columnWidth;
-    /** Number of columns to span when the screen is extra large or bigger */
-    xl?: columnWidth;
-    /** Number of columns to span when the screen is the largest size */
-    xxl?: columnWidth;
+export interface IBootstrapSizes<T> {
+    /** Extra small or bigger */
+    xs: T;
+    /** Small or bigger */
+    sm: T;
+    /** Medium or bigger */
+    md: T;
+    /** Large or bigger */
+    lg: T;
+    /** Extra large or bigger */
+    xl: T;
+    /** Largest size */
+    xxl: T;
 }
-export interface IColumnCountBreakpoints {
-    /** Number of columns to fit in a row when the screen is extra small or bigger */
-    xs?: columnCount;
-    /** Number of columns to fit in a row when the screen is small or bigger */
-    sm?: columnCount;
-    /** Number of columns to fit in a row when the screen is medium or bigger */
-    md?: columnCount;
-    /** Number of columns to fit in a row when the screen is large or bigger */
-    lg?: columnCount;
-    /** Number of columns to fit in a row when the screen is extra lage or bigger */
-    xl?: columnCount;
-    /** Number of columns to fit in a row when the screen is the largest size */
-    xxl?: columnCount;
+export interface IColumnWidthBreakpoints extends Partial<IBootstrapSizes<columnWidth>> {
+}
+export interface IColumnCountBreakpoints extends Partial<IBootstrapSizes<columnCount>> {
 }

package/dist/Data/Deserialiser.js

@@ -1,4 +1,4 @@
-import { TrackingState, SerialiseType, DataType, RelationType } from '../Model/Misc';
+import { TrackingState, SerialiseType, DataType, RelationType, RemoveItemBehavior } from '../Model/Misc';
 import { Utils } from '../Utils';
 import NumberUtils from "../NumberUtils";
 var Deserialiser = /** @class */ (function () {
@@ -73,9 +73,14 @@ var Deserialiser = /** @class */ (function () {
         }
         //create an index of the to objects
         var toIndex = {};
+        var list = to;
         var deletedItems = [];
-        for (var i = 0; i < to.length; i++) {
-            toIndex[to[i].entityIdentifier] = to[i];
+        for (var i = to.length - 1; i >= 0; i--) {
+            var item = to[i];
+            toIndex[item.entityIdentifier] = to[i];
+            if (item.isSelfDeleting) {
+                to.splice(i, 1);
+            }
         }
         if (this.options.removeOldItems) {
             to.length = 0;
@@ -115,7 +120,7 @@ var Deserialiser = /** @class */ (function () {
             if (deserialise)
                 this.deserialiseObject(fromItem, toItem, addToList);
             if (addToList || this.options.removeOldItems) {
-                if (fromItem.trackingState === TrackingState.Deleted) {
+                if (fromItem.trackingState === TrackingState.Deleted && list.removeItemBehavior === RemoveItemBehavior.Remove) {
                     deletedItems.push(toItem);
                 }
                 else {
@@ -126,7 +131,6 @@ var Deserialiser = /** @class */ (function () {
                 }
             }
         }
-        var list = to;
         if (list.deletedList) {
             list.clearDeletedList();
         }
@@ -248,6 +252,7 @@ var Deserialiser = /** @class */ (function () {
                 }
                 else if (from.trackingState === TrackingState.Deleted) {
                     toModel.isNew = false;
+                    toModel.isSelfDeleting = true;
                 }
                 else {
                     toModel.isSelfDirty = true;

package/dist/Data/Serialiser.js

@@ -90,7 +90,10 @@ var Serialiser = /** @class */ (function () {
         }
         //Set tracking state
         if (!this.options.suppressTrackingState && !isDictionary) {
-            if (from.isNew) {
+            if (from.isSelfDeleting) {
+                to.trackingState = TrackingState.Deleted;
+            }
+            else if (from.isNew) {
                 to.trackingState = TrackingState.Added;
             }
             else if (from.isSelfDirty) {

package/dist/Misc.d.ts

@@ -1,4 +1,4 @@
-export { DataType, RelationType, SerialiseType, TrackingState, IDisposable, IAutoRunner, IAutoRunnerOptions, TimeZoneFormat } from './Model/Misc';
+export { DataType, RelationType, SerialiseType, TrackingState, RemoveItemBehavior, IDisposable, IAutoRunner, IAutoRunnerOptions, TimeZoneFormat } from './Model/Misc';
 export { default as Globals } from './Globals';
 export { NumberFormat } from './NumberUtils';
 export { Settings } from './Settings';

package/dist/Misc.js

@@ -1,4 +1,4 @@
-export { DataType, RelationType, SerialiseType, TrackingState, TimeZoneFormat } from './Model/Misc';
+export { DataType, RelationType, SerialiseType, TrackingState, RemoveItemBehavior, TimeZoneFormat } from './Model/Misc';
 export { default as Globals } from './Globals';
 export { NumberFormat } from './NumberUtils';
 export { Settings } from './Settings';

package/dist/Model/IModelBase.d.ts

@@ -95,6 +95,8 @@ export interface IModelBaseInternal {
 export interface IModelBase extends INonObservableModelBase {
     entityIdentifier: string;
     isSelfDirty: boolean;
+    /** Indicates that this object has been marked for deletion. */
+    isSelfDeleting: boolean;
     isNew: boolean;
     readonly isSelfValid: boolean;
     readonly isValid: boolean;

package/dist/Model/List.d.ts

@@ -1,19 +1,27 @@
 import { ISerialiseOptions } from '../Data/Serialiser';
 import { PlainObject, PartialPlainObject, PlainTrackedObject, IMetaItem, ObjectFactory, IObjectFactoryOptions } from './IModelBase';
 import { IDeserialiseOptions } from '../Data/Deserialiser';
+import { RemoveItemBehavior } from "./Misc";
+interface IListCreationOptions {
+    itemFactory?: ObjectFactory;
+    onBeginRemove?: RemoveItemBehavior;
+}
 export default class List<T> extends Array<T> {
     attachedTo: object | null;
     childObjectType?: new () => T;
     itemFactory?: ObjectFactory;
+    removeItemBehavior?: RemoveItemBehavior;
     private _deletedList;
     get deletedList(): T[];
     get canDeserialise(): ObjectFactory | (new () => T) | undefined;
+    /** Returns the count of non deleted items. */
+    get activeLength(): number;
     private baseMethods;
     /**
      * 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);
+    constructor(childObjectType?: (new () => T) | IObjectFactoryOptions, options?: IListCreationOptions);
     /**
      * Copies the methods and properties from the prototype to the new instance.
      * This is needed because vue / mobx changes the prototype to its own.
@@ -55,7 +63,7 @@ export default class List<T> extends Array<T> {
     /**
      * Converts a plain javascript array into a neo model graph.
      */
-    static fromJSArray<T>(childType: new () => T, jsArray: PartialPlainObject<T>[], options?: IDeserialiseOptions): List<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;
     push(...items: T[]): any;
@@ -63,6 +71,16 @@ export default class List<T> extends Array<T> {
     private setParent;
     /** Creates a new item of type T, adds it to the array and returns the new item. */
     addNew(): T;
+    /**
+     * If `removeItemBehavior` is `MarkDeleted`, will toggle the value of `isSelfDeleting`.
+     * If `removeItemBehavior` is `Remove`, will remove the item from the array and add it to the deleted list.
+     */
+    toggleRemove(item: T): void;
+    /**
+     * If `removeItemBehavior` is `MarkDeleted`, will set `isSelfDeleting` to true.
+     * If `removeItemBehavior` is `Remove`, will remove the item from the array and add it to the deleted list.
+     */
+    beginRemove(item: T): void;
     /**
      * Removes an item from the array, and adds it to the deleted list. Deleted items will be included when calling toJSArray
      * @param item Item to remove
@@ -83,3 +101,4 @@ export default class List<T> extends Array<T> {
     /** Indicates that the model is dirty and valid and can be saved. */
     get readyToSave(): boolean;
 }
+export {};

package/dist/Model/List.js

@@ -3,21 +3,26 @@ import { JSFormatter } from '../Data/Serialiser';
 import { Utils } from '../Utils';
 import { ObservableValue } from './ObservableValue';
 import { NeoTypeInfo } from './NeoTypeInfo';
+import { RemoveItemBehavior } from "./Misc";
+import { Settings } from "../Settings";
 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) {
+    function List(childObjectType, options) {
+        var _a;
         var _this = _super.call(this) || this;
         _this._deletedList = new ObservableValue([]);
         if (typeof childObjectType === "function") {
             _this.childObjectType = childObjectType;
+            _this.itemFactory = options === null || options === void 0 ? void 0 : options.itemFactory;
         }
         else {
             _this.itemFactory = childObjectType === null || childObjectType === void 0 ? void 0 : childObjectType.itemFactory;
         }
+        _this.removeItemBehavior = (_a = options === null || options === void 0 ? void 0 : options.onBeginRemove) !== null && _a !== void 0 ? _a : Settings.list.removeItemBehavior;
         List.copyMethods(_this);
         return _this;
     }
@@ -35,6 +40,14 @@ var List = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(List.prototype, "activeLength", {
+        /** Returns the count of non deleted items. */
+        get: function () {
+            return this.sum(function (item) { return item.isSelfDeleting ? 0 : 1; });
+        },
+        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.
@@ -62,6 +75,7 @@ var List = /** @class */ (function (_super) {
     List.prototype.setupProxy = function (proxy, attachedTo) {
         proxy.childObjectType = this.childObjectType;
         proxy.itemFactory = this.itemFactory;
+        proxy.removeItemBehavior = this.removeItemBehavior;
         proxy._deletedList = new ObservableValue([]);
         proxy.attachedTo = attachedTo;
     };
@@ -90,9 +104,9 @@ var List = /** @class */ (function (_super) {
     /**
      * Converts a plain javascript array into a neo model graph.
      */
-    List.fromJSArray = function (childType, jsArray, options) {
-        var list = new List(childType);
-        list.set(jsArray, options);
+    List.fromJSArray = function (childType, jsArray, deserialiseOptions, listOptions) {
+        var list = new List(childType, listOptions);
+        list.set(jsArray, deserialiseOptions);
         return list;
     };
     /** Creates a new item of type T */
@@ -153,6 +167,30 @@ var List = /** @class */ (function (_super) {
         this.push(newItem);
         return newItem;
     };
+    /**
+     * If `removeItemBehavior` is `MarkDeleted`, will toggle the value of `isSelfDeleting`.
+     * If `removeItemBehavior` is `Remove`, will remove the item from the array and add it to the deleted list.
+     */
+    List.prototype.toggleRemove = function (item) {
+        if (item.isSelfDeleting) {
+            item.isSelfDeleting = false;
+        }
+        else {
+            this.beginRemove(item);
+        }
+    };
+    /**
+     * If `removeItemBehavior` is `MarkDeleted`, will set `isSelfDeleting` to true.
+     * If `removeItemBehavior` is `Remove`, will remove the item from the array and add it to the deleted list.
+     */
+    List.prototype.beginRemove = function (item) {
+        if (!item.isNew && this.removeItemBehavior === RemoveItemBehavior.MarkDeleted) {
+            item.isSelfDeleting = true;
+        }
+        else {
+            this.remove(item);
+        }
+    };
     /**
      * Removes an item from the array, and adds it to the deleted list. Deleted items will be included when calling toJSArray
      * @param item Item to remove
@@ -194,7 +232,8 @@ var List = /** @class */ (function (_super) {
         /** True if all items in the list are valid. */
         get: function () {
             for (var i = 0; i < this.length; i++) {
-                if (!this[i].isValid) {
+                var item = this[i];
+                if (!item.isValid) {
                     return false;
                 }
             }

package/dist/Model/Misc.d.ts

@@ -50,6 +50,12 @@ export declare enum TrackingState {
     Modified = 2,
     Deleted = 3
 }
+export declare enum RemoveItemBehavior {
+    /** Removes the item from the active items, and adds it to the deleted list. */
+    Remove = 1,
+    /** Leaves the item in the active list, and marks it as deleted. */
+    MarkDeleted = 2
+}
 export interface IDisposable {
     dispose(): void;
 }

package/dist/Model/Misc.js

@@ -57,3 +57,10 @@ export var TrackingState;
     TrackingState[TrackingState["Modified"] = 2] = "Modified";
     TrackingState[TrackingState["Deleted"] = 3] = "Deleted";
 })(TrackingState || (TrackingState = {}));
+export var RemoveItemBehavior;
+(function (RemoveItemBehavior) {
+    /** Removes the item from the active items, and adds it to the deleted list. */
+    RemoveItemBehavior[RemoveItemBehavior["Remove"] = 1] = "Remove";
+    /** Leaves the item in the active list, and marks it as deleted. */
+    RemoveItemBehavior[RemoveItemBehavior["MarkDeleted"] = 2] = "MarkDeleted";
+})(RemoveItemBehavior || (RemoveItemBehavior = {}));

package/dist/Model/ModelBase.d.ts

@@ -9,8 +9,9 @@ export default abstract class ModelBase extends BindableBase implements IModelBa
     validator: IModelValidator;
     isNew: boolean;
     isSelfDirty: boolean;
+    isSelfDeleting: boolean;
     /**
-     * Returns true if the object itself is dirty, or any of its children are dirty.
+     * Returns true if the object itself is dirty, or is being deleted. Then performs the same check recursively on all child objects and lists.
      * IsNew does not affect the value of IsDirty.
      */
     get isDirty(): boolean;

package/dist/Model/ModelBase.js

@@ -17,16 +17,17 @@ var ModelBase = /** @class */ (function (_super) {
         var _this = _super !== null && _super.apply(this, arguments) || this;
         _this.isNew = true;
         _this.isSelfDirty = true;
+        _this.isSelfDeleting = false;
         return _this;
     }
     Object.defineProperty(ModelBase.prototype, "isDirty", {
         /**
-         * Returns true if the object itself is dirty, or any of its children are dirty.
+         * Returns true if the object itself is dirty, or is being deleted. Then performs the same check recursively on all child objects and lists.
          * IsNew does not affect the value of IsDirty.
          */
         get: function () {
             return ModelTraverser.traverseItems(this, new ModelTraverser.BooleanRecursionState(false), function (item, state) {
-                if (item.isSelfDirty) {
+                if (item.isSelfDirty || item.isSelfDeleting) {
                     state.flag = true;
                     state.stop = true;
                 }
@@ -173,6 +174,10 @@ var ModelBase = /** @class */ (function (_super) {
         NoTracking(),
         __metadata("design:type", Object)
     ], ModelBase.prototype, "isSelfDirty", void 0);
+    __decorate([
+        NoTracking(),
+        __metadata("design:type", Object)
+    ], ModelBase.prototype, "isSelfDeleting", void 0);
     __decorate([
         Computed(false),
         __metadata("design:type", Object),

package/dist/Model/PropertyInfo.js

@@ -75,8 +75,11 @@ var PropertyInfo = /** @class */ (function () {
         return clone;
     };
     PropertyInfo.prototype.setPropertyType = function (propertyType) {
+        var _a;
         if (typeof propertyType === "function") {
-            if (!propertyType.prototype || propertyType.prototype.constructor.name === undefined) {
+            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 {

package/dist/Settings.d.ts

@@ -1,7 +1,7 @@
 import { ValidationDisplayMode } from './Validation/Misc';
 import { IButtonOptions } from './Components/ButtonOptions';
 import { BorderType } from "./Components/BootstrapTypes";
-import { DataType } from './Model/Misc';
+import { DataType, RemoveItemBehavior } from './Model/Misc';
 export declare const Settings: {
     bootstrap: {
         version: number;
@@ -16,6 +16,10 @@ export declare const Settings: {
         validationDisplayMode: ValidationDisplayMode;
         validationModalCloseButton: Partial<IButtonOptions> | false | undefined;
     };
+    list: {
+        /** Indicates how removing an item from a list should be handled. */
+        removeItemBehavior: RemoveItemBehavior;
+    };
     icons: {
         loadingIcon: any;
         errorIcon: any;
@@ -25,8 +29,9 @@ export declare const Settings: {
         collapsed: any;
         sortAsc: any;
         sortDesc: any;
-        /** Icon used in back buttons */
+        /** @deprecated Use `Settings.buttons.backButton` instead. */
         backIcon: any;
+        unDelete: any;
         shouldSuppress: (context: {
             icon: any;
             component: "button" | "card" | "tab";
@@ -70,6 +75,8 @@ export declare const Settings: {
          * Default styles to apply to buttons added to a button column.
          */
         buttonColumnButtons: IButtonOptions;
+        /** Allows overriding the tooltip shown when an item is marked for deletion. */
+        isDeletingTooltip: string;
     };
     modal: {
         /** Set to true if ModalUtils.showMessage() should show an accept button instead of close button. */
@@ -116,5 +123,6 @@ export declare const Settings: {
     buttons: {
         /** @deprecated Use `settings.icons.shouldSuppress` instead. */
         suppressIcons: boolean;
+        backButton: IButtonOptions;
     };
 };

package/dist/Settings.js

@@ -1,5 +1,5 @@
 import { ValidationDisplayMode } from './Validation/Misc';
-import { DataType } from './Model/Misc';
+import { DataType, RemoveItemBehavior } from './Model/Misc';
 export var Settings = {
     bootstrap: {
         version: 4,
@@ -14,6 +14,10 @@ export var Settings = {
         validationDisplayMode: ValidationDisplayMode.AfterBlur,
         validationModalCloseButton: undefined,
     },
+    list: {
+        /** Indicates how removing an item from a list should be handled. */
+        removeItemBehavior: RemoveItemBehavior.Remove,
+    },
     icons: {
         loadingIcon: "fa-circle-notch",
         errorIcon: "fa-exclamation-triangle",
@@ -23,8 +27,9 @@ export var Settings = {
         collapsed: "far-plus-square",
         sortAsc: "sort-up",
         sortDesc: "sort-down",
-        /** Icon used in back buttons */
+        /** @deprecated Use `Settings.buttons.backButton` instead. */
         backIcon: "arrow-left",
+        unDelete: "trash-restore",
         shouldSuppress: function (context) { return false; },
     },
     /** Grid default settings */
@@ -87,7 +92,9 @@ export var Settings = {
         /**
          * Default styles to apply to buttons added to a button column.
          */
-        buttonColumnButtons: {}
+        buttonColumnButtons: {},
+        /** Allows overriding the tooltip shown when an item is marked for deletion. */
+        isDeletingTooltip: "Item is marked for deletion, please click save.",
     },
     modal: {
         /** Set to true if ModalUtils.showMessage() should show an accept button instead of close button. */
@@ -143,5 +150,10 @@ export var Settings = {
     buttons: {
         /** @deprecated Use `settings.icons.shouldSuppress` instead. */
         suppressIcons: false,
+        backButton: {
+            isOutline: true,
+            icon: "arrow-left",
+            text: "Back",
+        },
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularsystems/neo-core",
-  "version": "1.2.3",
+  "version": "1.3.0",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -16,10 +16,10 @@
   "license": "ISC",
   "devDependencies": {
     "@types/jest": "29.5.14",
-    "@types/node": "22.13.4",
+    "@types/node": "22.15.30",
     "decimal.js-light": "2.5.1",
     "jest": "29.7.0",
-    "ts-jest": "29.2.5",
+    "ts-jest": "29.3.4",
     "typescript": "5.7.3"
   },
   "dependencies": {
@@ -33,5 +33,5 @@
     "axios": ">=1.4.0",
     "inversify": ">=5.0.1"
   },
-  "packageManager": "yarn@4.6.0"
+  "packageManager": "yarn@4.9.2"
 }