@singularsystems/neo-core 0.10.49 → 0.10.52

package/dist/Components/ButtonOptions.d.ts

@@ -35,6 +35,11 @@ export interface IButtonOptions {
      * If the task runner provided is busy, the button's icon will change to a spinner, and the button will be disabled.
      */
     task?: ITaskRunner;
+    /**
+     * If true, the button's icon will change to a spinner, and the button will be disabled.
+     * If you are using a task runner, rather use the `task` prop.
+     */
+    isBusy?: boolean;
     /**
      * Adds a pulse animation to the button.
      */

package/dist/Components/ErrorHandler.d.ts

@@ -6,7 +6,10 @@ export interface IErrorDisplay {
     statusText?: string;
     body: any;
     data?: IErrorData;
+    /** True if this is a 500 type error from the server. */
     isServerError?: boolean;
+    /** Cancels displaying of the error. */
+    cancelDisplay?: boolean;
 }
 export interface IErrorData {
     errors: string[];

package/dist/Components/FileManager/FileManager.d.ts

@@ -17,7 +17,7 @@ export interface IFileManager<TOptions = IBaseFileManagerOptions> {
     /**
      * Checks if file extensions are allowed, then calls onFilesSelected, or uploadFiles.
      */
-    processFiles(files: FileList | File[], options?: IFileUploadOptions): void;
+    processFiles(files: FileList | File[], options?: IFileUploadOptions): Promise<any>;
     /**
      * Uploads files to the uploadEndpoint. Does not perform any checks on file extensions.
      */
@@ -43,14 +43,17 @@ export declare abstract class FileManagerBase<TOptions extends IBaseFileManagerO
     constructor(options: TOptions);
     get uploadEndpoint(): string | undefined;
     options: TOptions;
-    /** Shows a file dialog and then calls processFiles. */
+    /**
+     * Shows a file dialog and then calls processFiles.
+     * onFilesSelected will be called if you need to handle the event.
+     */
     showFileDialog(): void;
     /** Checks if the file extensions are allowed. Shows a modal if not. */
     validateFiles(files: FileList | File[]): boolean;
     /**
      * Checks if file extensions are allowed, then calls onFilesSelected, or uploadFiles
      */
-    processFiles(files: FileList | File[], options?: IFileUploadOptions): void;
+    processFiles(files: FileList | File[], options?: IFileUploadOptions): Promise<any>;
     /**
      * Uploads files to the uploadEndpoint. Does not perform any checks on file extensions.
      */

package/dist/Components/FileManager/FileManager.js

@@ -1,4 +1,4 @@
-import { __decorate, __extends, __metadata } from "tslib";
+import { __awaiter, __decorate, __extends, __generator, __metadata } from "tslib";
 import NeoModel from '../../Model/NeoModel';
 import { ModalUtils } from '../Modal/ModalUtils';
 import { Observable } from '../../Model/Decorators';
@@ -47,7 +47,10 @@ var FileManagerBase = /** @class */ (function () {
         enumerable: true,
         configurable: true
     });
-    /** Shows a file dialog and then calls processFiles. */
+    /**
+     * Shows a file dialog and then calls processFiles.
+     * onFilesSelected will be called if you need to handle the event.
+     */
     FileManagerBase.prototype.showFileDialog = function () {
         var fileInput = document.getElementById("neo-file-input");
         if (!fileInput) {
@@ -59,7 +62,9 @@ var FileManagerBase = /** @class */ (function () {
             fileInput.addEventListener("change", function (e) {
                 var fileManager = fileInput[fileInputSymbol];
                 if (fileInput.files) {
-                    fileManager.processFiles(fileInput.files, { handleErrors: !fileManager.options.taskRunner });
+                    fileManager.processFiles(fileInput.files, { handleErrors: !fileManager.options.taskRunner }).finally(function () {
+                        fileInput.value = "";
+                    });
                 }
             });
             document.body.appendChild(fileInput);
@@ -84,25 +89,30 @@ var FileManagerBase = /** @class */ (function () {
      */
     FileManagerBase.prototype.processFiles = function (files, options) {
         if (options === void 0) { options = {}; }
-        if (this.validateFiles(files)) {
-            if (this.options.onFilesSelected) {
-                this.options.onFilesSelected(files, this);
-            }
-            else if (this.uploadEndpoint) {
-                if (!options.additionalData && this.options.additionalData) {
-                    if (typeof this.options.additionalData === "function") {
-                        options.additionalData = this.options.additionalData();
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                if (this.validateFiles(files)) {
+                    if (this.options.onFilesSelected) {
+                        this.options.onFilesSelected(files, this);
+                    }
+                    else if (this.uploadEndpoint) {
+                        if (!options.additionalData && this.options.additionalData) {
+                            if (typeof this.options.additionalData === "function") {
+                                options.additionalData = this.options.additionalData();
+                            }
+                            else {
+                                options.additionalData = this.options.additionalData;
+                            }
+                        }
+                        return [2 /*return*/, this.uploadFiles(files, options)];
                     }
                     else {
-                        options.additionalData = this.options.additionalData;
+                        throw Error("You must specify at least one of uploadEndpoint, or onFilesSelected.");
                     }
                 }
-                this.uploadFiles(files, options);
-            }
-            else {
-                throw Error("You must specify at least one of uploadEndpoint, or onFilesSelected.");
-            }
-        }
+                return [2 /*return*/];
+            });
+        });
     };
     FileManagerBase.prototype.uploadFiles = function (files, options) {
         var _this = this;

package/dist/Components/TaskRunner/Decorators.d.ts

@@ -0,0 +1,6 @@
+import { TaskRunnerOptions } from './TaskRunner';
+/**
+ * Causes the method to be run in a `taskRunner.run` handler.
+ * @param options Task runner options.
+ */
+export declare function runInTask(options?: Partial<TaskRunnerOptions>): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;

package/dist/Components/TaskRunner/Decorators.js

@@ -0,0 +1,24 @@
+/**
+ * Causes the method to be run in a `taskRunner.run` handler.
+ * @param options Task runner options.
+ */
+export function runInTask(options) {
+    return function (target, propertyKey, descriptor) {
+        var originalFn = descriptor.value;
+        descriptor.value = function () {
+            var _this = this;
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            var taskRunner = this["taskRunner"];
+            if (!taskRunner) {
+                throw "@runInTask requires the instance to have a property called 'taskRunner'.";
+            }
+            return taskRunner.run(function (localOptions) {
+                Object.assign(localOptions, options);
+                return originalFn.apply(_this, args);
+            });
+        };
+    };
+}

package/dist/Components/TaskRunner/TaskRunner.d.ts

@@ -1,6 +1,6 @@
 import { variant } from '..';
 import { AxiosPromise } from 'axios';
-import { IErrorHandler, ErrorDisplayType } from '../ErrorHandler';
+import { IErrorHandler, ErrorDisplayType, IErrorDisplay } from '../ErrorHandler';
 import { ProgressState } from './ProgressState';
 declare type PromiseDictionary = {
     [index: string]: Promise<any>;
@@ -13,6 +13,12 @@ export declare class TaskRunnerOptions<T = any> {
     constructor(taskRunner: TaskRunner);
     /** Specifies how the task runner must handle errors that are raised by your code. */
     errorHandling: ErrorDisplayType;
+    /**
+     * Callback to run when an error occurs.
+     *
+     * Setting the `cancelDisplay` property will prevent the error being displayed by the task runner.
+     */
+    onError?: (errorInfo: IErrorDisplay) => void;
     /** Loading text to show in the loading bar */
     loadingText: string;
     variant: variant;
@@ -24,15 +30,17 @@ export declare class TaskRunnerOptions<T = any> {
     autoProgress: boolean;
     /**
      * If set, this value will be returned in a resolved promise if an error occurs.
-     * The error will still be displayed according to the errorHandling property.
+     *
+     * The error will still be displayed according to the `errorHandling` property.
      */
     defaultReturnValue: T;
     get progressState(): ProgressState;
 }
 export declare class WaitForTaskRunnerOptions<T = any> extends TaskRunnerOptions<T> {
     /**
-     * Set to true if you want to allow post requests when using waitFor.
-     * Usually posts will raise an error warning you use rather use TaskRunner.run(). Use this if the post method has no side effects.
+     * Set to true if you want to allow post requests when using `waitFor`.
+     *
+     * Usually posts will raise an error warning you use rather use `TaskRunner.run()`. Use this if the post method has no side effects.
      */
     allowPost: boolean;
 }
@@ -64,6 +72,7 @@ export interface ITaskRunner {
     waitForData<T>(task: AxiosPromise<T>, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<T>;
     /**
      * Accepts a dictionary of promises, and waits for all of them to resolve.
+     *
      * A dictionary with the same keys is returned with the results of each promise.
      */
     waitForAll<T extends PromiseDictionary>(promises: T, options?: Partial<WaitForTaskRunnerOptions<T>>): Promise<TransformPromises<T>>;

package/dist/Components/TaskRunner/TaskRunner.js

@@ -185,7 +185,14 @@ var TaskRunner = /** @class */ (function () {
                 resolve(value);
             })
                 .catch(function (e) {
-                if (options.errorHandling !== ErrorDisplayType.ThrowError) {
+                var _a;
+                var cancel = false;
+                if (options.onError !== undefined) {
+                    var errorInfo = _this.errorHandler.parseError(e);
+                    options.onError(errorInfo);
+                    cancel = (_a = errorInfo.cancelDisplay, (_a !== null && _a !== void 0 ? _a : false));
+                }
+                if (!cancel && options.errorHandling !== ErrorDisplayType.ThrowError) {
                     _this.errorHandler.showError(e, options.errorHandling);
                 }
                 if (options.defaultReturnValue === undefined) {

package/dist/Data/Serialiser.js

@@ -3,6 +3,7 @@ import { Deserialiser } from './Deserialiser';
 import ValueObject from '../Model/ValueObject';
 import DateUtils from '../Dates/DateUtils';
 import Globals from '../Globals';
+var referenceIdKey = Symbol("referenceId");
 var JSFormatter = /** @class */ (function () {
     function JSFormatter() {
     }
@@ -41,6 +42,7 @@ var Serialiser = /** @class */ (function () {
         if (options === void 0) { options = {}; }
         this.options = options;
         var to;
+        this.currentID = 1;
         if (fromObject instanceof Array) {
             to = [];
             this.serialiseArray(fromObject, to);
@@ -57,25 +59,33 @@ var Serialiser = /** @class */ (function () {
      */
     Serialiser.prototype.cleanUpObjects = function () {
         for (var id in this.objectRefs) {
-            delete this.objectRefs[id].from.__id;
+            var refInfo = this.objectRefs[id];
+            delete refInfo.from[referenceIdKey];
+            // Remove $id property if object is not referenced by anything.
+            if (!refInfo.isReferenced) {
+                delete refInfo.to.$id;
+            }
         }
+        this.objectRefs = {};
     };
     Serialiser.prototype.serialiseObject = function (from, to, isDictionary) {
         if (isDictionary === void 0) { isDictionary = false; }
         //check that this object hasnt already been serialised.
-        if (!from.__id) {
-            from.__id = this.currentID++;
+        var referenceId = from[referenceIdKey];
+        if (!referenceId) {
+            referenceId = this.currentID++;
+            from[referenceIdKey] = referenceId;
         }
-        var sid = (from.__id).toString();
-        var toReference = this.objectRefs[sid];
-        if (toReference) {
+        var referenceInfo = this.objectRefs[referenceId];
+        if (referenceInfo) {
             //already serialised this object
-            to.$ref = sid;
-            toReference.to.$id = sid;
+            referenceInfo.isReferenced = true;
+            to.$ref = referenceInfo.to.$id;
             return;
         }
         else {
-            this.objectRefs[from.__id] = { from: from, to: to };
+            this.objectRefs[referenceId] = { from: from, to: to };
+            to.$id = referenceId.toString();
         }
         //Set tracking state
         if (!this.options.suppressTrackingState && !isDictionary) {
@@ -115,7 +125,7 @@ var Serialiser = /** @class */ (function () {
                             }
                         }
                         else if (isChildObject && !propertyInfo.assignOnDeserialise) {
-                            if (!fromValue || (propertyInfo.relationType === RelationType.Parent && !fromValue.__id)) {
+                            if (!fromValue || (propertyInfo.relationType === RelationType.Parent && !fromValue[referenceIdKey])) {
                                 // Parents must only be included if they reference an already serialised object.
                                 // Otherwise serialising a leaf node will serialise up the tree and the entire graph will be serialised.
                             }

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

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

package/dist/Model/BaseModels/ReasonedUserEvent.js

@@ -7,11 +7,16 @@ var ReasonedUserEvent = /** @class */ (function (_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 = __decorate([
+    ReasonedUserEvent = ReasonedUserEvent_1 = __decorate([
         NeoModel
     ], ReasonedUserEvent);
     return ReasonedUserEvent;

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

@@ -5,4 +5,5 @@ export declare abstract class UserEventBase extends ValueObject {
     get isCompleted(): boolean;
 }
 export declare class UserEvent extends UserEventBase {
+    static None(): UserEvent;
 }

package/dist/Model/BaseModels/UserEvent.js

@@ -24,7 +24,12 @@ var UserEvent = /** @class */ (function (_super) {
     function UserEvent() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
-    UserEvent = __decorate([
+    UserEvent_1 = UserEvent;
+    UserEvent.None = function () {
+        return new UserEvent_1();
+    };
+    var UserEvent_1;
+    UserEvent = UserEvent_1 = __decorate([
         NeoModel
     ], UserEvent);
     return UserEvent;

package/dist/Model/EnumHelper.d.ts

@@ -2,6 +2,7 @@ import { StaticDataSource } from '../Data';
 export interface IEnumItem {
     id: number | string;
     name: string;
+    description?: string;
 }
 interface IEnumItemDescriptor {
     name: string;
@@ -43,5 +44,11 @@ export declare class EnumHelper {
      * @param enumItem Enum item. E.g. Status.Pending
      */
     static getItemMetadata<T>(enumType: T, enumItem: T[keyof T]): IEnumItemDescriptor;
+    /**
+     * Returns `true` if this item looks like an enum item.
+     *
+     * E.g. has an `id` and `name` property.
+     */
+    static isEnumItem(item: any): boolean;
 }
 export {};

package/dist/Model/EnumHelper.js

@@ -50,18 +50,19 @@ var EnumHelper = /** @class */ (function () {
         for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
             var key = keys_1[_i];
             var id = enumObject[key];
-            var name_1 = void 0;
+            var name_1 = void 0, description = void 0;
             var itemDescriptor = descriptorMap[id];
             if (itemDescriptor) {
                 name_1 = itemDescriptor.display;
+                description = itemDescriptor.description;
             }
             else {
                 name_1 = key.readable();
             }
-            items.push({ id: id, name: name_1, order: itemDescriptor && itemDescriptor.order !== undefined ? itemDescriptor.order : index });
+            items.push({ id: id, name: name_1, description: description, order: itemDescriptor && itemDescriptor.order !== undefined ? itemDescriptor.order : index });
             index += 1;
         }
-        return items.sortBy(function (c) { return c.order; }).map(function (item) { return ({ id: item.id, name: item.name }); });
+        return items.sortBy(function (c) { return c.order; }).map(function (item) { return ({ id: item.id, name: item.name, description: item.description }); });
     };
     /**
      * Gets the metadata for an enum item.
@@ -80,6 +81,20 @@ var EnumHelper = /** @class */ (function () {
         }
         return itemDescriptor;
     };
+    /**
+     * Returns `true` if this item looks like an enum item.
+     *
+     * E.g. has an `id` and `name` property.
+     */
+    EnumHelper.isEnumItem = function (item) {
+        if (typeof item === "object") {
+            var properties = Object.getOwnPropertyNames(item);
+            if (properties.length <= 3 && properties.some(function (c) { return c === "id"; }) && properties.some(function (c) { return c === "name"; })) {
+                return true;
+            }
+        }
+        return false;
+    };
     return EnumHelper;
 }());
 export { EnumHelper };

package/dist/Model/IAutoRunner.d.ts

@@ -1,5 +1,5 @@
 import { IModelBase } from './IModelBase';
 import { IAutoRunner, IAutoRunnerOptions } from './Misc';
 export interface IAutoRunnerFactory {
-    create<T extends IModelBase>(model: T, callback: (model: T) => void, options?: IAutoRunnerOptions): IAutoRunner;
+    create<T extends IModelBase>(model: T, callback: (model: T) => void, options?: IAutoRunnerOptions<T>): IAutoRunner;
 }

package/dist/Model/IModelBase.d.ts

@@ -58,7 +58,7 @@ export interface INonObservableModelBase extends IBindableBase {
     update(jsObject: any): void;
     toQueryObject(): PlainFlatObject<this>;
     toQueryObjectAuto(callback: (queryObject: PlainFlatObject<this>) => void, options?: IDebounceOptions): Misc.IAutoRunner;
-    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions): Misc.IAutoRunner;
+    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions<this>): Misc.IAutoRunner;
     /** Icon to display next to toString() text. */
     getIcon(): string;
 }

package/dist/Model/Misc.d.ts

@@ -59,7 +59,7 @@ export interface IAutoRunner extends IDisposable {
     /** Cancels any pending callbacks. */
     cancelPending(): void;
 }
-export interface IAutoRunnerOptions extends IDebounceOptions {
+export interface IAutoRunnerOptions<T> extends IDebounceOptions {
     /**
      * True if child objects should be included in addition to value objects.
      */
@@ -70,6 +70,10 @@ export interface IAutoRunnerOptions extends IDebounceOptions {
      * Removed items will still be observed, and items added to the list will not be observed.
      */
     includeChildLists?: boolean;
+    /**
+     * If specified, only these properties will be observed.
+     */
+    rootProperties?: (Extract<keyof T, string>)[];
 }
 export interface ISelectedItem {
     id: number | string;

package/dist/Model/ModelBase.d.ts

@@ -58,7 +58,7 @@ export default abstract class ModelBase extends BindableBase implements IModelBa
      * This is delayed for string and numeric properties.
      * You must call the disposer when you are done with this object.
      */
-    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions): Misc.IAutoRunner;
+    onAnyPropertyChanged(callback: () => void, options?: Misc.IAutoRunnerOptions<this>): Misc.IAutoRunner;
     /**
      * Converts a plain javascript object graph to a neo model graph.
      * Updates child lists - Items in the child list, but not in jsArray will remain in the list.

package/dist/index.d.ts

@@ -10,6 +10,7 @@ import { DebounceHelper } from './DebounceHelper';
 import { EnumHelper } from './Model/EnumHelper';
 import { MenuUtils } from './Components/ContextMenu/MenuUtils';
 import FileUtils from "./FileUtils";
+import { runInTask } from './Components/TaskRunner/Decorators';
 import * as Attributes from './Model/Decorators';
 import * as Rules from './Validation/Decorators';
 import * as AppServices from './AppServices';
@@ -27,6 +28,7 @@ import * as Validation from './Validation';
 import * as Views from './Views/IViewBase';
 declare const NotifyUtils: Components.INotificationHelper;
 export { AppServices, Attributes, Components, Data, DateUtils, DebounceHelper, EnumHelper, FileUtils, JsonSchema, Localisation, List, MenuUtils, Misc, ModalUtils, Model, NeoModel, Network, NotifyUtils, NumberUtils, Routing, Rules, Security, SignalR, StringUtils, Validation, Views, };
+export { runInTask };
 export { default as ModelBase } from './Model/ModelBase';
 export { default as ValueObject } from './Model/ValueObject';
 export { LookupBase } from './Model/LookupBase';

package/dist/index.js

@@ -11,6 +11,7 @@ import { DebounceHelper } from './DebounceHelper';
 import { EnumHelper } from './Model/EnumHelper';
 import { MenuUtils } from './Components/ContextMenu/MenuUtils';
 import FileUtils from "./FileUtils";
+import { runInTask } from './Components/TaskRunner/Decorators';
 // Namespaced exports from 1 file
 import * as Attributes from './Model/Decorators';
 import * as Rules from './Validation/Decorators';
@@ -30,7 +31,10 @@ import * as Validation from './Validation';
 import * as Views from './Views/IViewBase';
 import { NotificationHelper } from './Components/Notifications/NotificationHelper';
 var NotifyUtils = new NotificationHelper();
+// Types
 export { AppServices, Attributes, Components, Data, DateUtils, DebounceHelper, EnumHelper, FileUtils, JsonSchema, Localisation, List, MenuUtils, Misc, ModalUtils, Model, NeoModel, Network, NotifyUtils, NumberUtils, Routing, Rules, Security, SignalR, StringUtils, Validation, Views, };
+// Functions
+export { runInTask };
 export { default as ModelBase } from './Model/ModelBase';
 export { default as ValueObject } from './Model/ValueObject';
 export { LookupBase } from './Model/LookupBase';

package/package.json

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