@singularsystems/neo-core 0.10.67 → 0.10.70

package/dist/Model/Decorators.d.ts

@@ -4,9 +4,12 @@ export declare function Display(name: string): (type: any, propertyKey: string)
 export declare function Date(timeZoneSerialisation?: TimeZoneFormat): (type: any, propertyKey: string, descriptor?: PropertyDescriptor) => void;
 /** Indicates that this is an integer number property. Editors will be restricted to integer numeric input. */
 export declare function Integer(): (type: any, propertyKey: string) => void;
-/** Indicates that this is a float number property. Editors will be restricted to float numeric input. */
-export declare function Float(): (type: any, propertyKey: string) => void;
-/** Indicates that this is a decimal property. */
+/**
+ * Indicates that this is a float number property.
+ * Editors will be restricted to float numeric input.
+ * @param decimals No of decimals allowed when storing this value. Used when binding to this property from a supporting ui component. If not specified, this will be determined from the format string. */
+export declare function Float(decimals?: number): (type: any, propertyKey: string) => void;
+/** Indicates that this is a decimal property (decimal type from the decimal.js-light package). */
 export declare function Decimal(): (type: any, propertyKey: string) => void;
 /** Indicates that this is a nullable boolean property. */
 export declare function NullableBoolean(): (type: any, propertyKey: string) => void;

package/dist/Model/Decorators.js

@@ -24,13 +24,18 @@ export function Integer() {
         getOrAddPropertyInfo(type, propertyKey).propertyType = DataType.Int;
     };
 }
-/** Indicates that this is a float number property. Editors will be restricted to float numeric input. */
-export function Float() {
+/**
+ * Indicates that this is a float number property.
+ * Editors will be restricted to float numeric input.
+ * @param decimals No of decimals allowed when storing this value. Used when binding to this property from a supporting ui component. If not specified, this will be determined from the format string. */
+export function Float(decimals) {
     return function (type, propertyKey) {
-        getOrAddPropertyInfo(type, propertyKey).propertyType = DataType.Float;
+        var propertyInfo = getOrAddPropertyInfo(type, propertyKey);
+        propertyInfo.propertyType = DataType.Float;
+        propertyInfo.allowedDecimals = decimals;
     };
 }
-/** Indicates that this is a decimal property. */
+/** Indicates that this is a decimal property (decimal type from the decimal.js-light package). */
 export function Decimal() {
     return function (type, propertyKey) {
         getOrAddPropertyInfo(type, propertyKey).propertyType = DataType.Decimal;

package/dist/Model/ModelBase.d.ts

@@ -83,6 +83,6 @@ export default abstract class ModelBase extends BindableBase implements IModelBa
      * Add custom business rules. Note, this will be called once per type and should be treated as static.
      */
     protected addBusinessRules(validationRules: ValidationRules<this>): void;
-    /** The server side full type name used to find this type. */
+    /** The server side type name used to find this type. Include the namespace if there is more than one type with the same name. */
     static typeName: string | null;
 }

package/dist/Model/ModelBase.js

@@ -147,7 +147,7 @@ var ModelBase = /** @class */ (function (_super) {
      */
     ModelBase.prototype.addBusinessRules = function (validationRules) {
     };
-    /** The server side full type name used to find this type. */
+    /** The server side type name used to find this type. Include the namespace if there is more than one type with the same name. */
     ModelBase.typeName = null;
     __decorate([
         NoTracking(SerialiseType.Never),

package/dist/Model/PropertyInfo.d.ts

@@ -33,6 +33,8 @@ export default class PropertyInfo {
     relationType: RelationType;
     /** Data type of the property. */
     propertyType: DataType;
+    /** No of decimals to allow when binding to this property from a supporting ui component. If not specified, this will be determined from the format string. */
+    allowedDecimals?: number;
     /** This will change the default behaviour about how a control sets this properties value. */
     allowNulls: boolean;
     /** Options for the onChanged event */

package/dist/Model/PropertyInstance.d.ts

@@ -37,7 +37,7 @@ export declare class PropertyAccessor implements IPropertyInstance {
     attachedTo: any;
     propertyInfo: PropertyInfo;
     private propertyName;
-    private constructor();
+    protected constructor(attachedTo: any, propertyInfo: PropertyInfo);
     sortValue: any;
     get uniqueID(): string;
     get validator(): IPropertyValidator;
@@ -46,3 +46,37 @@ export declare class PropertyAccessor implements IPropertyInstance {
     get peek(): any;
     static create<T>(model: T, property: keyof T): PropertyAccessor;
 }
+interface ITemporaryPropertyOptions<TValue> {
+    /** Name of the property. Should be a valid js property name. */
+    name?: string;
+    /** Label to show in editors using this property. */
+    label?: string;
+    /** On changed function if you want the property to be writable. */
+    onChanged?: (value: TValue) => void;
+}
+export declare class TemporaryProperty<TValue = any> extends PropertyAccessor {
+    private valueAccessor;
+    private onChanged?;
+    constructor(attachedTo: any, valueAccessor: () => TValue, options?: ITemporaryPropertyOptions<TValue>);
+    get value(): TValue;
+    set value(value: TValue);
+    get peek(): TValue;
+}
+/**
+ * Creates a temporary property if you need a neo editor to show a computed value, and cannot use the meta object on a neo model.
+ * The property should be attached to a component class instance, and the property should be passed as the editors `bind` prop.
+ *
+ * E.g.
+ * In component class:
+ * ```typescript
+ * this.myProperty = createProperty(this, ...);
+ * ```
+ * In render method:
+ * ```jsx
+ * <Neo.FormGroup bind={this.myProperty} />
+ * ```
+ * @param host The instance this property is stored on, usually `this`.
+ * @param valueAccessor Function that returns the property value.
+ */
+export declare function createProperty<TValue>(host: any, valueAccessor: () => TValue, options?: ITemporaryPropertyOptions<TValue>): TemporaryProperty<TValue>;
+export {};

package/dist/Model/PropertyInstance.js

@@ -1,3 +1,4 @@
+import { __extends } from "tslib";
 import { EmptyValidator } from '../Validation/Validators/IPropertyValidator';
 import PropertyInfo from './PropertyInfo';
 import { Utils } from '../Utils';
@@ -111,3 +112,60 @@ var PropertyAccessor = /** @class */ (function () {
     return PropertyAccessor;
 }());
 export { PropertyAccessor };
+var TemporaryProperty = /** @class */ (function (_super) {
+    __extends(TemporaryProperty, _super);
+    function TemporaryProperty(attachedTo, valueAccessor, options) {
+        var _this = this;
+        var _a, _b;
+        var propertyInfo = new PropertyInfo((_a = options === null || options === void 0 ? void 0 : options.name) !== null && _a !== void 0 ? _a : Utils.uuidv4());
+        propertyInfo.displayName = (_b = options === null || options === void 0 ? void 0 : options.label) !== null && _b !== void 0 ? _b : "";
+        propertyInfo.isReadOnly = (options === null || options === void 0 ? void 0 : options.onChanged) === undefined;
+        _this = _super.call(this, attachedTo, propertyInfo) || this;
+        _this.valueAccessor = valueAccessor;
+        _this.onChanged = options === null || options === void 0 ? void 0 : options.onChanged;
+        return _this;
+    }
+    Object.defineProperty(TemporaryProperty.prototype, "value", {
+        get: function () {
+            return this.valueAccessor();
+        },
+        set: function (value) {
+            if (this.onChanged) {
+                this.onChanged(value);
+            }
+            else {
+                throw Error("Cannot set value of temporary property ".concat(this.propertyInfo.propertyName));
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(TemporaryProperty.prototype, "peek", {
+        get: function () {
+            return this.value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return TemporaryProperty;
+}(PropertyAccessor));
+export { TemporaryProperty };
+/**
+ * Creates a temporary property if you need a neo editor to show a computed value, and cannot use the meta object on a neo model.
+ * The property should be attached to a component class instance, and the property should be passed as the editors `bind` prop.
+ *
+ * E.g.
+ * In component class:
+ * ```typescript
+ * this.myProperty = createProperty(this, ...);
+ * ```
+ * In render method:
+ * ```jsx
+ * <Neo.FormGroup bind={this.myProperty} />
+ * ```
+ * @param host The instance this property is stored on, usually `this`.
+ * @param valueAccessor Function that returns the property value.
+ */
+export function createProperty(host, valueAccessor, options) {
+    return new TemporaryProperty(host, valueAccessor, options);
+}

package/dist/Model/index.d.ts

@@ -1,12 +1,13 @@
 export { IBindableBase, IModelBase, NeoModelConstructor, PlainObject, PlainTrackedObject, PartialPlainObject, PartialPlainNonTrackedObject, TransformMetaType, IMakeBindableOptions } from './IModelBase';
 export { ILookupBase } from './LookupBase';
 export { IPropertyInstance, PropertyAccessor } from './PropertyInstance';
+import PropertyInfo from './PropertyInfo';
 export { IObservableValue, ObservableValue } from './ObservableValue';
 export { ObservableProperty } from './ObservableProperty';
 export { ISelectedItem } from './Misc';
 export { ModelFieldInfo, IModelFieldInfoContainer } from './ModelFieldInfo';
 import * as GraphTraverser from './ModelGraphTraverser';
-export { GraphTraverser };
+export { GraphTraverser, PropertyInfo };
 export { AuditValues, AuditValuesBase } from './BaseModels/AuditValues';
 export { FileDescriptorBase } from './BaseModels/FileDescriptorBase';
 export { ReasonedUserEvent } from './BaseModels/ReasonedUserEvent';

package/dist/Model/index.js

@@ -1,9 +1,10 @@
 export { PropertyAccessor } from './PropertyInstance';
+import PropertyInfo from './PropertyInfo';
 export { ObservableValue } from './ObservableValue';
 export { ObservableProperty } from './ObservableProperty';
 export { ModelFieldInfo } from './ModelFieldInfo';
 import * as GraphTraverser from './ModelGraphTraverser';
-export { GraphTraverser };
+export { GraphTraverser, PropertyInfo };
 // Base Models
 export { AuditValues, AuditValuesBase } from './BaseModels/AuditValues';
 export { FileDescriptorBase } from './BaseModels/FileDescriptorBase';

package/dist/NumberUtils.d.ts

@@ -16,26 +16,33 @@ export default class NumberUtils {
     /** If values typed into numeric editors should be divided by 100 when stored. */
     static transformPercent: boolean;
     static initialise(): void;
-    /** Gets a format string for the pre-defined number format. */
-    static getFormatString(format: NumberFormat, currencySymbol?: string): string;
+    /** Gets a format string for the pre-defined number format.
+     * @param displayDecimals No of decimals to display if using a decimals format.
+    */
+    static getFormatString(format: NumberFormat, currencySymbol?: string, displayDecimals?: number): string;
     /**
      * Formats a number into a string that can be parsed back to a number. E.g. without currency symbol or group separators
      * @param number js number
      * @param format Format string including group separators / currency symbol. This is used to get the number of decimal to display.
      * @param hasExternalPercentSymbol True if this is a percent, but the format string doesn't contain a % symbol.
+     * @param maxDecimals Max no of decimals supported by the value. For percentages this should be 2 more than the no of displayed decimals.
      */
-    static formatRaw(number: number, format: string, hasExternalPercentSymbol?: boolean): string;
+    static formatRaw(number: number, format: string, hasExternalPercentSymbol?: boolean, maxDecimals?: number): string;
     /**
      * Rounds a number, getting the precision from the format string
      * @param hasExternalPercentSymbol True if this is a percent, but the format string doesn't contain a % symbol.
      */
-    static roundUsingFormat<T extends number | Decimal>(number: T, formatString: string, hasExternalPercentSymbol?: boolean): T;
+    static roundUsingFormat(number: number, formatString: string, hasExternalPercentSymbol?: boolean): number;
+    /**
+     * Rounds a number to the nearest no of decimals.
+     */
+    static round<T extends number | Decimal>(number: T, decimals: number): T;
     /**
      * Returns the number of decimal places in a format string.
      * @param formatString Format string.
      * @param value Value if the negative format string is different to positive.
      */
-    static getDecimalPlaces<T extends number | Decimal>(formatString: string, value?: T): number;
+    static getDecimalPlaces(formatString: string, value?: number): number;
     private static getDecimalsFormatPart;
     /**
      * Converts a number to a string using the specified format.

package/dist/NumberUtils.js

@@ -24,9 +24,23 @@ var NumberUtils = /** @class */ (function () {
         NumberUtils.numberFormats[NumberFormat.CurrencyNoDecimals] = "_#,##0;(_#,##0)";
         NumberUtils.numberFormats[NumberFormat.CurrencyDecimals] = "_#,##0.00;(_#,##0.00)";
     };
-    /** Gets a format string for the pre-defined number format. */
-    NumberUtils.getFormatString = function (format, currencySymbol) {
+    /** Gets a format string for the pre-defined number format.
+     * @param displayDecimals No of decimals to display if using a decimals format.
+    */
+    NumberUtils.getFormatString = function (format, currencySymbol, displayDecimals) {
+        if (displayDecimals === void 0) { displayDecimals = 2; }
         var formatString = NumberUtils.numberFormats[format];
+        if ((format & 0x0100) === 0x0100) {
+            if (displayDecimals === 0) {
+                formatString = formatString.replace(/.00/g, "");
+            }
+            else if (displayDecimals === 1) {
+                formatString = formatString.replace(/.00/g, ".0");
+            }
+            else if (displayDecimals > 2) {
+                formatString = formatString.replace(/.00/g, ".00" + "#".repeat(displayDecimals - 2));
+            }
+        }
         return formatString.replace(/_/g, currencySymbol || NumberUtils.defaultCurrencySymbol);
     };
     /**
@@ -34,15 +48,19 @@ var NumberUtils = /** @class */ (function () {
      * @param number js number
      * @param format Format string including group separators / currency symbol. This is used to get the number of decimal to display.
      * @param hasExternalPercentSymbol True if this is a percent, but the format string doesn't contain a % symbol.
+     * @param maxDecimals Max no of decimals supported by the value. For percentages this should be 2 more than the no of displayed decimals.
      */
-    NumberUtils.formatRaw = function (number, format, hasExternalPercentSymbol) {
+    NumberUtils.formatRaw = function (number, format, hasExternalPercentSymbol, maxDecimals) {
         var parts = format.split(";");
         var isPercent = format.indexOf("%") >= 0 || hasExternalPercentSymbol;
         if (isPercent && NumberUtils.transformPercent) {
             number *= 100;
             isPercent = false; //Don't allow extra precision below.
+            if (maxDecimals !== undefined) {
+                maxDecimals -= 2;
+            }
         }
-        var positive = "#0" + NumberUtils.getDecimalsFormatPart(parts[0], isPercent), negative = "-#0" + NumberUtils.getDecimalsFormatPart(parts[1] ? parts[1] : parts[0], isPercent);
+        var positive = "#0" + NumberUtils.getDecimalsFormatPart(parts[0], isPercent, maxDecimals), negative = "-#0" + NumberUtils.getDecimalsFormatPart(parts[1] ? parts[1] : parts[0], isPercent, maxDecimals);
         return NumberUtils.format(number, positive + ";" + negative);
     };
     /**
@@ -54,6 +72,12 @@ var NumberUtils = /** @class */ (function () {
         if (formatString.indexOf("%") >= 0 || hasExternalPercentSymbol) {
             decimals += 2;
         }
+        return this.round(number, decimals);
+    };
+    /**
+     * Rounds a number to the nearest no of decimals.
+     */
+    NumberUtils.round = function (number, decimals) {
         if (number instanceof Globals.decimalType) {
             // Round away from zero.
             return number.toDecimalPlaces(decimals, Decimal.ROUND_HALF_UP);
@@ -82,16 +106,27 @@ var NumberUtils = /** @class */ (function () {
         }
         return 0;
     };
-    NumberUtils.getDecimalsFormatPart = function (formatString, isPercent) {
+    NumberUtils.getDecimalsFormatPart = function (formatString, isPercent, maxDecimals) {
         if (isPercent === void 0) { isPercent = false; }
-        if (formatString) {
-            var startIndex = formatString.indexOf(".");
-            var endIndex = Math.max(formatString.lastIndexOf("0"), formatString.lastIndexOf("#"));
-            if (startIndex >= 0 && endIndex > 0) {
-                return formatString.substring(startIndex, endIndex + 1) + (isPercent ? "##" : "");
+        var decimalsPart = "";
+        var startIndex = formatString.indexOf(".");
+        var endIndex = Math.max(formatString.lastIndexOf("0"), formatString.lastIndexOf("#"));
+        if (startIndex >= 0 && endIndex > 0) {
+            decimalsPart = formatString.substring(startIndex, endIndex + 1) + (isPercent ? "##" : "");
+        }
+        else {
+            decimalsPart = isPercent ? ".##" : "";
+        }
+        if (maxDecimals !== undefined && maxDecimals > 0) {
+            // If the format string has less decimals than maxDecimals, then add # characters on the end.
+            if (!decimalsPart) {
+                decimalsPart = ".";
+            }
+            if (decimalsPart.length - 1 < maxDecimals) {
+                decimalsPart += "#".repeat(maxDecimals - (decimalsPart.length - 1));
             }
         }
-        return "" + (isPercent ? ".##" : "");
+        return decimalsPart;
     };
     NumberUtils.format = function (number, format, currencySymbol) {
         if (number instanceof Globals.decimalType) {

package/dist/Validation/Validators/IModelValidator.d.ts

@@ -3,11 +3,15 @@ import { ValidationDisplayMode } from '../Misc';
 import { IInvalidObject } from './ModelValidator';
 import { IRule } from '../Rules';
 import { IRuleResult } from '../RuleContext';
+import { RuleSeverity } from '../ValidationState';
 export default interface IModelValidator {
+    /** Causes all errors to be displayed regardless of ValidationDisplayMode. */
     forceShowErrors: boolean;
-    isValid: boolean;
+    readonly isValid: boolean;
+    /** The max current severity of all rules in this object. */
+    readonly severity: RuleSeverity;
     /**
-     * Gets the broken rules for this object. If you need the summary for an object graph, use Validation.getValidationSummary()
+     * Gets the broken rules for this object (not it's children). If you need the summary for an object graph, use Validation.getValidationSummary()
      */
     getBrokenRules(): IInvalidObject;
     /**

package/dist/Validation/Validators/ModelValidator.d.ts

@@ -23,6 +23,7 @@ export default class ModelValidator implements IModelValidator {
     forceShowErrors: boolean;
     get ruleState(): ContainerValidationState;
     get isValid(): boolean;
+    get severity(): import("../ValidationState").RuleSeverity;
     private checkRules;
     /**
      * Gets the broken rules for this object. If you need the summary for an object graph, use Validation.getValidationSummary()

package/dist/Validation/Validators/ModelValidator.js

@@ -63,6 +63,13 @@ var ModelValidator = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ModelValidator.prototype, "severity", {
+        get: function () {
+            return this.ruleState.severity;
+        },
+        enumerable: false,
+        configurable: true
+    });
     ModelValidator.prototype.checkRules = function () {
         var _this = this;
         this._ruleState = new ContainerValidationState();

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import { EnumHelper } from './Model/EnumHelper';
 import { MenuUtils } from './Components/ContextMenu/MenuUtils';
 import FileUtils from "./FileUtils";
 import { runInTask } from './Components/TaskRunner/Decorators';
+import { createProperty } from "./Model/PropertyInstance";
 import * as Attributes from './Model/Decorators';
 import * as Rules from './Validation/Decorators';
 import * as AppServices from './AppServices';
@@ -28,7 +29,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 { runInTask, createProperty };
 export { default as ModelBase } from './Model/ModelBase';
 export { default as ValueObject } from './Model/ValueObject';
 export { LookupBase } from './Model/LookupBase';

package/dist/index.js

@@ -12,6 +12,7 @@ import { EnumHelper } from './Model/EnumHelper';
 import { MenuUtils } from './Components/ContextMenu/MenuUtils';
 import FileUtils from "./FileUtils";
 import { runInTask } from './Components/TaskRunner/Decorators';
+import { createProperty } from "./Model/PropertyInstance";
 // Namespaced exports from 1 file
 import * as Attributes from './Model/Decorators';
 import * as Rules from './Validation/Decorators';
@@ -34,7 +35,7 @@ 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 { runInTask, createProperty };
 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.67",
+  "version": "0.10.70",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",