@singularsystems/neo-core 1.0.0-alpha.2 → 1.0.0-alpha.4

package/dist/Model/PropertyInstance.d.ts

@@ -1,48 +1,84 @@
-import { IModelBase } from './IModelBase';
-import { IPropertyValidator } from '../Validation/Validators/IPropertyValidator';
-import PropertyInfo from './PropertyInfo';
-import { IObservableValue } from './ObservableValue';
-export declare type PropertyInstanceMap = {
-    [index: string]: IPropertyInstance;
-};
-export interface IPropertyInstance<T = any> extends IObservableValue<T> {
-    attachedTo: IModelBase;
-    propertyInfo: PropertyInfo;
-    validator: IPropertyValidator;
-    sortValue: any;
-    uniqueID: string;
-}
-export default class PropertyInstance implements IPropertyInstance {
-    propertyInfo: PropertyInfo;
-    private isObservable;
-    constructor(attachedTo: IModelBase | null, propertyInfo: PropertyInfo, isObservable?: boolean);
-    attachedTo: IModelBase;
-    propertyName: string;
-    /** Previous value for use in onChanged. This will only be set on the first property change. */
-    previousValue: any;
-    get value(): any;
-    set value(newVal: any);
-    /** Sort value if different to the property's actual value. E.g. dates / drop down */
-    sortValue: any;
-    get uniqueID(): string;
-    /** Gets the value of the property without registering a dependency */
-    get peek(): any;
-    private _validator;
-    get validator(): IPropertyValidator;
-}
-/**
- * Allows a property declared on a non model base class to be wrapped, and passed as a bind property.
- */
-export declare class PropertyAccessor implements IPropertyInstance {
-    attachedTo: any;
-    propertyInfo: PropertyInfo;
-    private propertyName;
-    private constructor();
-    sortValue: any;
-    get uniqueID(): string;
-    get validator(): IPropertyValidator;
-    get value(): any;
-    set value(newVal: any);
-    get peek(): any;
-    static create<T>(model: T, property: keyof T): PropertyAccessor;
-}
+import { IModelBase } from './IModelBase';
+import { IPropertyValidator } from '../Validation/Validators/IPropertyValidator';
+import PropertyInfo from './PropertyInfo';
+import { IObservableValue } from './ObservableValue';
+export type PropertyInstanceMap = {
+    [index: string]: IPropertyInstance;
+};
+export interface IPropertyInstance<T = any> extends IObservableValue<T> {
+    attachedTo: IModelBase;
+    propertyInfo: PropertyInfo;
+    validator: IPropertyValidator;
+    sortValue: any;
+    uniqueID: string;
+}
+export default class PropertyInstance implements IPropertyInstance {
+    propertyInfo: PropertyInfo;
+    private isObservable;
+    constructor(attachedTo: IModelBase | null, propertyInfo: PropertyInfo, isObservable?: boolean);
+    attachedTo: IModelBase & {
+        [key: string]: any;
+    };
+    propertyName: string;
+    /** Previous value for use in onChanged. This will only be set on the first property change. */
+    previousValue: any;
+    get value(): any;
+    set value(newVal: any);
+    /** Sort value if different to the property's actual value. E.g. dates / drop down */
+    sortValue: any;
+    get uniqueID(): string;
+    /** Gets the value of the property without registering a dependency */
+    get peek(): any;
+    private _validator;
+    get validator(): IPropertyValidator;
+}
+/**
+ * Allows a property declared on a non model base class to be wrapped, and passed as a bind property.
+ */
+export declare class PropertyAccessor implements IPropertyInstance {
+    attachedTo: any;
+    propertyInfo: PropertyInfo;
+    private propertyName;
+    protected constructor(attachedTo: any, propertyInfo: PropertyInfo);
+    sortValue: any;
+    get uniqueID(): string;
+    get validator(): IPropertyValidator;
+    get value(): any;
+    set value(newVal: any);
+    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,113 +1,173 @@
-import { EmptyValidator } from '../Validation/Validators/IPropertyValidator';
-import PropertyInfo from './PropertyInfo';
-import { Utils } from '../Utils';
-var PropertyInstance = /** @class */ (function () {
-    function PropertyInstance(attachedTo, propertyInfo, isObservable) {
-        if (isObservable === void 0) { isObservable = true; }
-        this.propertyInfo = propertyInfo;
-        this.isObservable = isObservable;
-        if (attachedTo)
-            this.attachedTo = attachedTo;
-        this.propertyName = propertyInfo.propertyName;
-        if (!isObservable) {
-            this._validator = EmptyValidator;
-        }
-    }
-    Object.defineProperty(PropertyInstance.prototype, "value", {
-        get: function () {
-            return this.attachedTo[this.propertyName];
-        },
-        set: function (newVal) {
-            this.attachedTo[this.propertyName] = newVal;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyInstance.prototype, "uniqueID", {
-        get: function () {
-            return (this.attachedTo ? (this.attachedTo.entityIdentifier + "!") : "") + this.propertyName;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyInstance.prototype, "peek", {
-        /** Gets the value of the property without registering a dependency */
-        get: function () {
-            if (this.isObservable) {
-                return Utils.peek(this.attachedTo, this.propertyName);
-            }
-            else {
-                return this.value;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyInstance.prototype, "validator", {
-        get: function () {
-            if (!this._validator) {
-                if (this.propertyInfo.rules.length) {
-                    this._validator = this.attachedTo.validator.createPropertyValidator(this);
-                }
-                else {
-                    this._validator = EmptyValidator;
-                }
-            }
-            return this._validator;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return PropertyInstance;
-}());
-export default PropertyInstance;
-var uniqueIdSymbol = Symbol("uniqueId");
-/**
- * Allows a property declared on a non model base class to be wrapped, and passed as a bind property.
- */
-var PropertyAccessor = /** @class */ (function () {
-    function PropertyAccessor(attachedTo, propertyInfo) {
-        this.attachedTo = attachedTo;
-        this.propertyInfo = propertyInfo;
-        this.propertyName = propertyInfo.propertyName;
-    }
-    Object.defineProperty(PropertyAccessor.prototype, "uniqueID", {
-        get: function () {
-            return this.attachedTo[uniqueIdSymbol] + "!" + this.propertyName;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyAccessor.prototype, "validator", {
-        get: function () {
-            return EmptyValidator;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyAccessor.prototype, "value", {
-        get: function () {
-            return this.attachedTo[this.propertyName];
-        },
-        set: function (newVal) {
-            this.attachedTo[this.propertyName] = newVal;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(PropertyAccessor.prototype, "peek", {
-        get: function () {
-            return this.attachedTo[this.propertyName];
-        },
-        enumerable: false,
-        configurable: true
-    });
-    PropertyAccessor.create = function (model, property) {
-        if (!model[uniqueIdSymbol]) {
-            model[uniqueIdSymbol] = Utils.uuidv4();
-        }
-        return new PropertyAccessor(model, new PropertyInfo(property));
-    };
-    return PropertyAccessor;
-}());
-export { PropertyAccessor };
+import { __extends } from "tslib";
+import { EmptyValidator } from '../Validation/Validators/IPropertyValidator';
+import PropertyInfo from './PropertyInfo';
+import { Utils } from '../Utils';
+var PropertyInstance = /** @class */ (function () {
+    function PropertyInstance(attachedTo, propertyInfo, isObservable) {
+        if (isObservable === void 0) { isObservable = true; }
+        this.propertyInfo = propertyInfo;
+        this.isObservable = isObservable;
+        if (attachedTo)
+            this.attachedTo = attachedTo;
+        this.propertyName = propertyInfo.propertyName;
+        if (!isObservable) {
+            this._validator = EmptyValidator;
+        }
+    }
+    Object.defineProperty(PropertyInstance.prototype, "value", {
+        get: function () {
+            return this.attachedTo[this.propertyName];
+        },
+        set: function (newVal) {
+            this.attachedTo[this.propertyName] = newVal;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyInstance.prototype, "uniqueID", {
+        get: function () {
+            return (this.attachedTo ? (this.attachedTo.entityIdentifier + "!") : "") + this.propertyName;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyInstance.prototype, "peek", {
+        /** Gets the value of the property without registering a dependency */
+        get: function () {
+            if (this.isObservable) {
+                return Utils.peek(this.attachedTo, this.propertyName);
+            }
+            else {
+                return this.value;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyInstance.prototype, "validator", {
+        get: function () {
+            if (!this._validator) {
+                if (this.propertyInfo.rules.length) {
+                    this._validator = this.attachedTo.validator.createPropertyValidator(this);
+                }
+                else {
+                    this._validator = EmptyValidator;
+                }
+            }
+            return this._validator;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return PropertyInstance;
+}());
+export default PropertyInstance;
+var uniqueIdSymbol = Symbol("uniqueId");
+/**
+ * Allows a property declared on a non model base class to be wrapped, and passed as a bind property.
+ */
+var PropertyAccessor = /** @class */ (function () {
+    function PropertyAccessor(attachedTo, propertyInfo) {
+        this.attachedTo = attachedTo;
+        this.propertyInfo = propertyInfo;
+        this.propertyName = propertyInfo.propertyName;
+    }
+    Object.defineProperty(PropertyAccessor.prototype, "uniqueID", {
+        get: function () {
+            return this.attachedTo[uniqueIdSymbol] + "!" + this.propertyName;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyAccessor.prototype, "validator", {
+        get: function () {
+            return EmptyValidator;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyAccessor.prototype, "value", {
+        get: function () {
+            return this.attachedTo[this.propertyName];
+        },
+        set: function (newVal) {
+            this.attachedTo[this.propertyName] = newVal;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PropertyAccessor.prototype, "peek", {
+        get: function () {
+            return this.attachedTo[this.propertyName];
+        },
+        enumerable: false,
+        configurable: true
+    });
+    PropertyAccessor.create = function (model, property) {
+        // @ts-ignore
+        if (!model[uniqueIdSymbol]) {
+            // @ts-ignore
+            model[uniqueIdSymbol] = Utils.uuidv4();
+        }
+        return new PropertyAccessor(model, new PropertyInfo(property));
+    };
+    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/ValueObject.d.ts

@@ -1,3 +1,3 @@
-import ModelBase from './ModelBase';
-export default class ValueObject extends ModelBase {
-}
+import ModelBase from './ModelBase';
+export default class ValueObject extends ModelBase {
+}

package/dist/Model/ValueObject.js

@@ -1,10 +1,10 @@
-import { __extends } from "tslib";
-import ModelBase from './ModelBase';
-var ValueObject = /** @class */ (function (_super) {
-    __extends(ValueObject, _super);
-    function ValueObject() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return ValueObject;
-}(ModelBase));
-export default ValueObject;
+import { __extends } from "tslib";
+import ModelBase from './ModelBase';
+var ValueObject = /** @class */ (function (_super) {
+    __extends(ValueObject, _super);
+    function ValueObject() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return ValueObject;
+}(ModelBase));
+export default ValueObject;

package/dist/Model/index.d.ts

@@ -1,14 +1,15 @@
-export { IBindableBase, IModelBase, NeoModelConstructor, PlainObject, PlainTrackedObject, PartialPlainObject, PartialPlainNonTrackedObject, TransformMetaType } from './IModelBase';
-export { ILookupBase } from './LookupBase';
-export { IPropertyInstance, PropertyAccessor } from './PropertyInstance';
-export { IObservableValue, ObservableValue } from './ObservableValue';
-export { ObservableProperty } from './ObservableProperty';
-export { ISelectedItem } from './Misc';
-export { ModelFieldInfo } from './ModelFieldInfo';
-import * as GraphTraverser from './ModelGraphTraverser';
-export { GraphTraverser };
-export { AuditValues, AuditValuesBase } from './BaseModels/AuditValues';
-export { FileDescriptorBase } from './BaseModels/FileDescriptorBase';
-export { ReasonedUserEvent } from './BaseModels/ReasonedUserEvent';
-export { UserEventBase, UserEvent } from './BaseModels/UserEvent';
-export { CriteriaBase } from './BaseModels/CriteriaBase';
+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, PropertyInfo };
+export { AuditValues, AuditValuesBase } from './BaseModels/AuditValues';
+export { FileDescriptorBase } from './BaseModels/FileDescriptorBase';
+export { ReasonedUserEvent } from './BaseModels/ReasonedUserEvent';
+export { UserEventBase, UserEvent } from './BaseModels/UserEvent';
+export { CriteriaBase } from './BaseModels/CriteriaBase';

package/dist/Model/index.js

@@ -1,12 +1,13 @@
-export { PropertyAccessor } from './PropertyInstance';
-export { ObservableValue } from './ObservableValue';
-export { ObservableProperty } from './ObservableProperty';
-export { ModelFieldInfo } from './ModelFieldInfo';
-import * as GraphTraverser from './ModelGraphTraverser';
-export { GraphTraverser };
-// Base Models
-export { AuditValues, AuditValuesBase } from './BaseModels/AuditValues';
-export { FileDescriptorBase } from './BaseModels/FileDescriptorBase';
-export { ReasonedUserEvent } from './BaseModels/ReasonedUserEvent';
-export { UserEventBase, UserEvent } from './BaseModels/UserEvent';
-export { CriteriaBase } from './BaseModels/CriteriaBase';
+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, PropertyInfo };
+// Base Models
+export { AuditValues, AuditValuesBase } from './BaseModels/AuditValues';
+export { FileDescriptorBase } from './BaseModels/FileDescriptorBase';
+export { ReasonedUserEvent } from './BaseModels/ReasonedUserEvent';
+export { UserEventBase, UserEvent } from './BaseModels/UserEvent';
+export { CriteriaBase } from './BaseModels/CriteriaBase';

package/dist/NumberUtils.d.ts

@@ -1,49 +1,63 @@
-import Decimal from "decimal.js-light";
-import { IPropertyInstance } from "./Model";
-export declare enum NumberFormat {
-    None = 0,
-    NoDecimals = 4096,
-    Decimals = 4352,
-    PercentNoDecimals = 4112,
-    PercentDecimals = 4368,
-    CurrencyNoDecimals = 4097,
-    CurrencyDecimals = 4353
-}
-export default class NumberUtils {
-    static thousandsSeparator: string;
-    static defaultCurrencySymbol: string;
-    static numberFormats: {};
-    /** 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;
-    /**
-     * 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.
-     */
-    static formatRaw(number: number, format: string, hasExternalPercentSymbol?: boolean): 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;
-    private static getDecimals;
-    /**
-     * Converts a number to a string using the specified format.
-     * E.g. #,##0.00;(#,##0.00)
-     */
-    static format(number: number | Decimal, formatString: string): string;
-    /**
-     * Converts a number to a string using the specified format.
-     */
-    static format(number: number | Decimal, format: NumberFormat, currencySymbol?: string): string;
-    /**
-     * Converts the properties value to a string based on the float / integer decorator.
-     */
-    static format(property: IPropertyInstance<number | Decimal>): string;
-    private static formatUsingEnum;
-    private static formatInternal;
-}
+import Decimal from "decimal.js-light";
+import { IPropertyInstance } from "./Model";
+export declare enum NumberFormat {
+    None = 0,
+    NoDecimals = 4096,
+    Decimals = 4352,
+    PercentNoDecimals = 4112,
+    PercentDecimals = 4368,
+    CurrencyNoDecimals = 4097,
+    CurrencyDecimals = 4353
+}
+export default class NumberUtils {
+    static thousandsSeparator: string;
+    static defaultCurrencySymbol: string;
+    static numberFormats: {
+        [key in NumberFormat]: string;
+    };
+    /** If values typed into numeric editors should be divided by 100 when stored. */
+    static transformPercent: boolean;
+    /** 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, 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(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(formatString: string, value?: number): number;
+    private static getDecimalsFormatPart;
+    /**
+     * Converts a number to a string using the specified format.
+     * E.g. #,##0.00;(#,##0.00)
+     */
+    static format(number: number | Decimal, formatString: string): string;
+    /**
+     * Converts a number to a string using the specified format.
+     */
+    static format(number: number | Decimal, format: NumberFormat, currencySymbol?: string): string;
+    /**
+     * Converts the properties value to a string based on the float / integer decorator.
+     */
+    static format(property: IPropertyInstance<number | Decimal>): string;
+    private static formatUsingEnum;
+    private static formatInternal;
+}