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

package/dist/Validation/DisplayHelper.js

@@ -1,104 +1,104 @@
-import { RuleSeverity } from './ValidationState';
-import { Utils } from '../Utils';
-var ValidationDisplayInfo = /** @class */ (function () {
-    function ValidationDisplayInfo() {
-        this.additionalClassName = "";
-        this.iconClass = "";
-        this.errorText = "";
-        this.asyncBusyText = "";
-        this.warningText = "";
-        this.infoText = "";
-        this.severity = RuleSeverity.None;
-        this.variant = "light";
-    }
-    Object.defineProperty(ValidationDisplayInfo.prototype, "displayText", {
-        get: function () {
-            switch (this.severity) {
-                case RuleSeverity.Error: return this.errorText;
-                case RuleSeverity.AsyncBusy: return this.asyncBusyText;
-                case RuleSeverity.Warning: return this.warningText;
-                case RuleSeverity.Info: return this.infoText;
-            }
-            return "";
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(ValidationDisplayInfo.prototype, "editorClassName", {
-        get: function () {
-            if (this.severity != RuleSeverity.None) {
-                return "is-invalid " + this.additionalClassName;
-            }
-            return "";
-        },
-        enumerable: false,
-        configurable: true
-    });
-    ValidationDisplayInfo.prototype.applyToDom = function (elementProps, addTooltip) {
-        if (this.severity) {
-            elementProps["className"] = Utils.joinWithSpaces(elementProps["className"], this.editorClassName);
-            if (addTooltip) {
-                elementProps["data-tip"] = this.displayText;
-                elementProps["data-tip-class"] = this.additionalClassName;
-            }
-        }
-    };
-    return ValidationDisplayInfo;
-}());
-export { ValidationDisplayInfo };
-var ValidationDisplayHelper = /** @class */ (function () {
-    function ValidationDisplayHelper() {
-    }
-    ValidationDisplayHelper.getDisplayInfo = function (ruleState, canDisplayAll) {
-        var displayInfo = new ValidationDisplayInfo();
-        displayInfo.severity = canDisplayAll ? ruleState.severity : ruleState.forceDisplaySeverity;
-        if (displayInfo.severity != RuleSeverity.None) {
-            var allRules = ruleState.brokenRules;
-            if (allRules === undefined) {
-                allRules = [ruleState];
-            }
-            allRules.forEach(function (rule) {
-                if (displayInfo.severity == RuleSeverity.Info)
-                    displayInfo.infoText = ValidationDisplayHelper.join(displayInfo.infoText, rule.messages);
-                if (displayInfo.severity == RuleSeverity.Warning)
-                    displayInfo.warningText = ValidationDisplayHelper.join(displayInfo.warningText, rule.warnings);
-                if (displayInfo.severity == RuleSeverity.Error)
-                    displayInfo.errorText = ValidationDisplayHelper.join(displayInfo.errorText, rule.errors);
-                if (displayInfo.severity == RuleSeverity.AsyncBusy && rule.asyncBusyText) {
-                    displayInfo.asyncBusyText = ValidationDisplayHelper.join(displayInfo.asyncBusyText, [rule.asyncBusyText]);
-                }
-            });
-            switch (displayInfo.severity) {
-                case RuleSeverity.Error:
-                    displayInfo.additionalClassName = "error";
-                    displayInfo.iconClass = "fa fa-exclamation-triangle";
-                    displayInfo.variant = "danger";
-                    break;
-                case RuleSeverity.AsyncBusy:
-                    displayInfo.additionalClassName = "busy";
-                    displayInfo.iconClass = "spinner-grow";
-                    displayInfo.variant = "info";
-                    break;
-                case RuleSeverity.Warning:
-                    displayInfo.additionalClassName = "warning";
-                    displayInfo.iconClass = "fa fa-exclamation-triangle";
-                    displayInfo.variant = "warning";
-                    break;
-                case RuleSeverity.Info:
-                    displayInfo.additionalClassName = "info";
-                    displayInfo.iconClass = "fa fa-exclamation-circle";
-                    displayInfo.variant = "info";
-                    break;
-            }
-        }
-        return displayInfo;
-    };
-    ValidationDisplayHelper.join = function (initialString, list) {
-        for (var i = 0; i < list.length; i++) {
-            initialString += (initialString == "" ? "" : initialString.endsWith(".") ? " " : ". ") + list[i];
-        }
-        return initialString;
-    };
-    return ValidationDisplayHelper;
-}());
-export default ValidationDisplayHelper;
+import { RuleSeverity } from './ValidationState';
+import { Utils } from '../Utils';
+import { Settings } from '../Settings';
+var ValidationDisplayInfo = /** @class */ (function () {
+    function ValidationDisplayInfo() {
+        this.additionalClassName = "";
+        this.errorText = "";
+        this.asyncBusyText = "";
+        this.warningText = "";
+        this.infoText = "";
+        this.severity = RuleSeverity.None;
+        this.variant = "light";
+    }
+    Object.defineProperty(ValidationDisplayInfo.prototype, "displayText", {
+        get: function () {
+            switch (this.severity) {
+                case RuleSeverity.Error: return this.errorText;
+                case RuleSeverity.AsyncBusy: return this.asyncBusyText;
+                case RuleSeverity.Warning: return this.warningText;
+                case RuleSeverity.Info: return this.infoText;
+            }
+            return "";
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ValidationDisplayInfo.prototype, "editorClassName", {
+        get: function () {
+            if (this.severity != RuleSeverity.None) {
+                return "is-invalid " + this.additionalClassName;
+            }
+            return "";
+        },
+        enumerable: false,
+        configurable: true
+    });
+    ValidationDisplayInfo.prototype.applyToDom = function (elementProps, addTooltip) {
+        if (this.severity) {
+            elementProps.className = Utils.joinWithSpaces(elementProps.className, this.editorClassName);
+            if (addTooltip) {
+                elementProps["data-tip"] = this.displayText;
+                elementProps["data-tip-class"] = this.additionalClassName;
+            }
+        }
+    };
+    return ValidationDisplayInfo;
+}());
+export { ValidationDisplayInfo };
+var ValidationDisplayHelper = /** @class */ (function () {
+    function ValidationDisplayHelper() {
+    }
+    ValidationDisplayHelper.getDisplayInfo = function (ruleState, canDisplayAll) {
+        var displayInfo = new ValidationDisplayInfo();
+        displayInfo.severity = canDisplayAll ? ruleState.severity : ruleState.forceDisplaySeverity;
+        if (displayInfo.severity != RuleSeverity.None) {
+            var allRules = ruleState.brokenRules;
+            if (allRules === undefined) {
+                allRules = [ruleState];
+            }
+            allRules.forEach(function (rule) {
+                if (displayInfo.severity == RuleSeverity.Info)
+                    displayInfo.infoText = ValidationDisplayHelper.join(displayInfo.infoText, rule.messages);
+                if (displayInfo.severity == RuleSeverity.Warning)
+                    displayInfo.warningText = ValidationDisplayHelper.join(displayInfo.warningText, rule.warnings);
+                if (displayInfo.severity == RuleSeverity.Error)
+                    displayInfo.errorText = ValidationDisplayHelper.join(displayInfo.errorText, rule.errors);
+                if (displayInfo.severity == RuleSeverity.AsyncBusy && rule.asyncBusyText) {
+                    displayInfo.asyncBusyText = ValidationDisplayHelper.join(displayInfo.asyncBusyText, [rule.asyncBusyText]);
+                }
+            });
+            switch (displayInfo.severity) {
+                case RuleSeverity.Error:
+                    displayInfo.additionalClassName = "error";
+                    displayInfo.icon = Settings.icons.errorIcon;
+                    displayInfo.variant = "danger";
+                    break;
+                case RuleSeverity.AsyncBusy:
+                    displayInfo.additionalClassName = "busy";
+                    displayInfo.icon = Settings.icons.loadingIcon;
+                    displayInfo.variant = "info";
+                    break;
+                case RuleSeverity.Warning:
+                    displayInfo.additionalClassName = "warning";
+                    displayInfo.icon = Settings.icons.warningIcon;
+                    displayInfo.variant = "warning";
+                    break;
+                case RuleSeverity.Info:
+                    displayInfo.additionalClassName = "info";
+                    displayInfo.icon = Settings.icons.infoIcon;
+                    displayInfo.variant = "info";
+                    break;
+            }
+        }
+        return displayInfo;
+    };
+    ValidationDisplayHelper.join = function (initialString, list) {
+        for (var i = 0; i < list.length; i++) {
+            initialString += (initialString == "" ? "" : initialString.endsWith(".") ? " " : ". ") + list[i];
+        }
+        return initialString;
+    };
+    return ValidationDisplayHelper;
+}());
+export default ValidationDisplayHelper;

package/dist/Validation/Misc.d.ts

@@ -1,10 +1,10 @@
-export declare enum ValidationDisplayMode {
-    /** errors will display immediately if the properties are not valid. */
-    Always = 1,
-    /** errors will only display after the element loses focus. */
-    AfterBlur = 2,
-    /** errors will only be displayed once forceShowErrors is set to true on the model. */
-    AfterSubmit = 3,
-    /** errors will not be shown. */
-    Never = 4
-}
+export declare enum ValidationDisplayMode {
+    /** errors will display immediately if the properties are not valid. */
+    Always = 1,
+    /** errors will only display after the element loses focus. */
+    AfterBlur = 2,
+    /** errors will only be displayed once forceShowErrors is set to true on the model. */
+    AfterSubmit = 3,
+    /** errors will not be shown. */
+    Never = 4
+}

package/dist/Validation/Misc.js

@@ -1,11 +1,11 @@
-export var ValidationDisplayMode;
-(function (ValidationDisplayMode) {
-    /** errors will display immediately if the properties are not valid. */
-    ValidationDisplayMode[ValidationDisplayMode["Always"] = 1] = "Always";
-    /** errors will only display after the element loses focus. */
-    ValidationDisplayMode[ValidationDisplayMode["AfterBlur"] = 2] = "AfterBlur";
-    /** errors will only be displayed once forceShowErrors is set to true on the model. */
-    ValidationDisplayMode[ValidationDisplayMode["AfterSubmit"] = 3] = "AfterSubmit";
-    /** errors will not be shown. */
-    ValidationDisplayMode[ValidationDisplayMode["Never"] = 4] = "Never";
-})(ValidationDisplayMode || (ValidationDisplayMode = {}));
+export var ValidationDisplayMode;
+(function (ValidationDisplayMode) {
+    /** errors will display immediately if the properties are not valid. */
+    ValidationDisplayMode[ValidationDisplayMode["Always"] = 1] = "Always";
+    /** errors will only display after the element loses focus. */
+    ValidationDisplayMode[ValidationDisplayMode["AfterBlur"] = 2] = "AfterBlur";
+    /** errors will only be displayed once forceShowErrors is set to true on the model. */
+    ValidationDisplayMode[ValidationDisplayMode["AfterSubmit"] = 3] = "AfterSubmit";
+    /** errors will not be shown. */
+    ValidationDisplayMode[ValidationDisplayMode["Never"] = 4] = "Never";
+})(ValidationDisplayMode || (ValidationDisplayMode = {}));

package/dist/Validation/ModelProxy.d.ts

@@ -1,20 +1,20 @@
-import { IModelBase } from '../Model/IModelBase';
-import PropertyInfo from '../Model/PropertyInfo';
-import { CustomRule } from './Rules';
-/**
- * Acts as a proxy for a model in order to tell which properties of the model were accessed during the invocation of a rule.
- */
-export default class ModelProxy {
-    accessedProperties: Map<string, PropertyInfo>;
-    private defaultPropertyInstance;
-    constructor(instance: IModelBase);
-    /**
-     * Invokes checkRule on the provided rule, and monitors which properties were accessed.
-     * The accessed properties are returned as a propertyInfo array.
-     * This technique will not always extract all properties.
-     *   E.g. Given: (Property1 !== "" && Property1 === Property2)
-     *        Property2 will not be extracted if Property1's default value is an empty string.
-     * Any exceptions thrown will be caught silently.
-     */
-    tryExtractProperties(rule: CustomRule<IModelBase>): PropertyInfo[];
-}
+import { IModelBase } from '../Model/IModelBase';
+import PropertyInfo from '../Model/PropertyInfo';
+import { CustomRule } from './Rules';
+/**
+ * Acts as a proxy for a model in order to tell which properties of the model were accessed during the invocation of a rule.
+ */
+export default class ModelProxy {
+    accessedProperties: Map<string, PropertyInfo>;
+    private defaultPropertyInstance;
+    constructor(instance: IModelBase);
+    /**
+     * Invokes checkRule on the provided rule, and monitors which properties were accessed.
+     * The accessed properties are returned as a propertyInfo array.
+     * This technique will not always extract all properties.
+     *   E.g. Given: (Property1 !== "" && Property1 === Property2)
+     *        Property2 will not be extracted if Property1's default value is an empty string.
+     * Any exceptions thrown will be caught silently.
+     */
+    tryExtractProperties(rule: CustomRule<IModelBase>): PropertyInfo[];
+}

package/dist/Validation/ModelProxy.js

@@ -1,46 +1,46 @@
-import PropertyInfo from '../Model/PropertyInfo';
-import PropertyInstance from '../Model/PropertyInstance';
-import { RuleContext } from './RuleContext';
-/**
- * Acts as a proxy for a model in order to tell which properties of the model were accessed during the invocation of a rule.
- */
-var ModelProxy = /** @class */ (function () {
-    function ModelProxy(instance) {
-        var _this = this;
-        this.accessedProperties = new Map();
-        this.defaultPropertyInstance = new PropertyInstance(this, new PropertyInfo(""), false);
-        var _loop_1 = function (propertyName) {
-            Object.defineProperty(this_1, propertyName, {
-                get: function () {
-                    _this.accessedProperties.set(propertyName, instance.constructor.neo.meta[propertyName].propertyInfo);
-                    return instance.meta[propertyName].peek();
-                }
-            });
-        };
-        var this_1 = this;
-        for (var _i = 0, _a = Object.getOwnPropertyNames(instance); _i < _a.length; _i++) {
-            var propertyName = _a[_i];
-            _loop_1(propertyName);
-        }
-    }
-    /**
-     * Invokes checkRule on the provided rule, and monitors which properties were accessed.
-     * The accessed properties are returned as a propertyInfo array.
-     * This technique will not always extract all properties.
-     *   E.g. Given: (Property1 !== "" && Property1 === Property2)
-     *        Property2 will not be extracted if Property1's default value is an empty string.
-     * Any exceptions thrown will be caught silently.
-     */
-    ModelProxy.prototype.tryExtractProperties = function (rule) {
-        this.accessedProperties.clear();
-        var context = new RuleContext(null);
-        try {
-            rule.checkRule(this.defaultPropertyInstance, context);
-        }
-        catch (e) {
-        }
-        return Array.from(this.accessedProperties.values());
-    };
-    return ModelProxy;
-}());
-export default ModelProxy;
+import PropertyInfo from '../Model/PropertyInfo';
+import PropertyInstance from '../Model/PropertyInstance';
+import { RuleContext } from './RuleContext';
+/**
+ * Acts as a proxy for a model in order to tell which properties of the model were accessed during the invocation of a rule.
+ */
+var ModelProxy = /** @class */ (function () {
+    function ModelProxy(instance) {
+        var _this = this;
+        this.accessedProperties = new Map();
+        this.defaultPropertyInstance = new PropertyInstance(this, new PropertyInfo(""), false);
+        var _loop_1 = function (propertyName) {
+            Object.defineProperty(this_1, propertyName, {
+                get: function () {
+                    _this.accessedProperties.set(propertyName, instance.constructor.neo.meta[propertyName].propertyInfo);
+                    return instance.meta[propertyName].peek();
+                }
+            });
+        };
+        var this_1 = this;
+        for (var _i = 0, _a = Object.getOwnPropertyNames(instance); _i < _a.length; _i++) {
+            var propertyName = _a[_i];
+            _loop_1(propertyName);
+        }
+    }
+    /**
+     * Invokes checkRule on the provided rule, and monitors which properties were accessed.
+     * The accessed properties are returned as a propertyInfo array.
+     * This technique will not always extract all properties.
+     *   E.g. Given: (Property1 !== "" && Property1 === Property2)
+     *        Property2 will not be extracted if Property1's default value is an empty string.
+     * Any exceptions thrown will be caught silently.
+     */
+    ModelProxy.prototype.tryExtractProperties = function (rule) {
+        this.accessedProperties.clear();
+        var context = new RuleContext(null);
+        try {
+            rule.checkRule(this.defaultPropertyInstance, context);
+        }
+        catch (e) {
+        }
+        return Array.from(this.accessedProperties.values());
+    };
+    return ModelProxy;
+}());
+export default ModelProxy;

package/dist/Validation/RuleContext.d.ts

@@ -1,86 +1,86 @@
-import { ValidationState, IValidationState } from './ValidationState';
-import RuleValidator from './Validators/RuleValidator';
-export declare enum AsyncStage {
-    None = 0,
-    Debounce = 1,
-    Busy = 2,
-    Completing = 3
-}
-interface IRuleContextBase {
-    /**
-     * Adds an error, causing the object to be invalid.
-     * @param errorText The error message to display
-     * @param forceDisplay True if the error message must display even if the control is still focused.
-     */
-    addError(errorText: string, forceDisplay?: boolean): void;
-    /**
-     * Adds a warning. This will not cause the object to be invalid.
-     * @param forceDisplay True if the warning message must display even if the control is still focused.
-     * */
-    addWarning(warningText: string, forceDisplay?: boolean): void;
-    /**
-     * Adds an information message. This is the lowest severity
-     * @param forceDisplay True if the message must display even if the control is still focused.
-     * */
-    addMessage(message: string, forceDisplay?: boolean): void;
-}
-export interface IRuleContext extends IRuleContextBase {
-    /**
-     * Indicates that this object is validating. It will not be valid until endAsync is called in the provided callback.
-     * @param loadingText Text to display until endAsync is called.
-     * @param onReady Callback function where the async action must be called from.
-     * @param options See options properties.
-     */
-    beginAsync(loadingText: string, onReady: (asyncContext: IAsyncRuleContext) => void, options?: IAsyncRuleOptions): void;
-}
-export interface IRuleResult extends IValidationState {
-    asyncBusyText: string;
-    errors: Array<string>;
-    warnings: Array<string>;
-    messages: Array<string>;
-    readonly hasDetail: boolean;
-}
-export interface IAsyncRuleContext extends IRuleContextBase {
-    /**
-     * Call this once an async operation has completed, and you have added errors / warnings.
-     */
-    endAsync(): void;
-}
-export declare class RuleContextBase extends ValidationState implements IRuleContextBase {
-    protected ruleValidator: RuleValidator;
-    asyncBusyText: string;
-    errors: Array<string>;
-    warnings: Array<string>;
-    messages: Array<string>;
-    constructor(ruleValidator: RuleValidator);
-    addError(errorText: string, forceDisplay?: boolean): void;
-    addWarning(warningText: string, forceDisplay?: boolean): void;
-    addMessage(message: string, forceDisplay?: boolean): void;
-    merge(ruleState: RuleContextBase, includeMessages: boolean): void;
-    get hasDetail(): boolean;
-}
-interface IAsyncRuleOptions {
-    /** The async rule will only be executed after the property has not changed for this many milliseconds. */
-    delayMs?: number;
-    /** True if the loading text must display even if the control is still focused. */
-    forceDisplay?: boolean;
-    /** True if the async rule must be executed even if the object is clean. */
-    checkWhenClean?: boolean;
-}
-export declare class RuleContext extends RuleContextBase implements IRuleContext, IRuleResult {
-    /**
-     * Indicates that this object is validating.
-     * It will not be valid until endAsync is called in the provided callback.
-     * Async / await, or returning a promise can also be used as an alternative to using endAsync.
-     * @param loadingText Text to display until endAsync is called.
-     * @param onReady Callback function where the async action must be called from.
-     * @param options See options properties.
-     */
-    beginAsync(loadingText: string, onReady: (asyncContext: IAsyncRuleContext) => void | Promise<any>, options?: IAsyncRuleOptions): void;
-}
-export declare class AsyncRuleContext extends RuleContextBase implements IAsyncRuleContext {
-    private initiator;
-    constructor(initiator: RuleContext, ruleValidator: RuleValidator);
-    endAsync(): void;
-}
-export {};
+import { ValidationState, IValidationState } from './ValidationState';
+import RuleValidator from './Validators/RuleValidator';
+export declare enum AsyncStage {
+    None = 0,
+    Debounce = 1,
+    Busy = 2,
+    Completing = 3
+}
+interface IRuleContextBase {
+    /**
+     * Adds an error, causing the object to be invalid.
+     * @param errorText The error message to display
+     * @param forceDisplay True if the error message must display even if the control is still focused.
+     */
+    addError(errorText: string, forceDisplay?: boolean): void;
+    /**
+     * Adds a warning. This will not cause the object to be invalid.
+     * @param forceDisplay True if the warning message must display even if the control is still focused.
+     * */
+    addWarning(warningText: string, forceDisplay?: boolean): void;
+    /**
+     * Adds an information message. This is the lowest severity
+     * @param forceDisplay True if the message must display even if the control is still focused.
+     * */
+    addMessage(message: string, forceDisplay?: boolean): void;
+}
+export interface IRuleContext extends IRuleContextBase {
+    /**
+     * Indicates that this object is validating. It will not be valid until endAsync is called in the provided callback.
+     * @param loadingText Text to display until endAsync is called.
+     * @param onReady Callback function where the async action must be called from.
+     * @param options See options properties.
+     */
+    beginAsync(loadingText: string, onReady: (asyncContext: IAsyncRuleContext) => void, options?: IAsyncRuleOptions): void;
+}
+export interface IRuleResult extends IValidationState {
+    asyncBusyText: string;
+    errors: Array<string>;
+    warnings: Array<string>;
+    messages: Array<string>;
+    readonly hasDetail: boolean;
+}
+export interface IAsyncRuleContext extends IRuleContextBase {
+    /**
+     * Call this once an async operation has completed, and you have added errors / warnings.
+     */
+    endAsync(): void;
+}
+export declare class RuleContextBase extends ValidationState implements IRuleContextBase {
+    protected ruleValidator: RuleValidator;
+    asyncBusyText: string;
+    errors: Array<string>;
+    warnings: Array<string>;
+    messages: Array<string>;
+    constructor(ruleValidator: RuleValidator);
+    addError(errorText: string, forceDisplay?: boolean): void;
+    addWarning(warningText: string, forceDisplay?: boolean): void;
+    addMessage(message: string, forceDisplay?: boolean): void;
+    merge(ruleState: RuleContextBase, includeMessages: boolean): void;
+    get hasDetail(): boolean;
+}
+interface IAsyncRuleOptions {
+    /** The async rule will only be executed after the property has not changed for this many milliseconds. */
+    delayMs?: number;
+    /** True if the loading text must display even if the control is still focused. */
+    forceDisplay?: boolean;
+    /** True if the async rule must be executed even if the object is clean. */
+    checkWhenClean?: boolean;
+}
+export declare class RuleContext extends RuleContextBase implements IRuleContext, IRuleResult {
+    /**
+     * Indicates that this object is validating.
+     * It will not be valid until endAsync is called in the provided callback.
+     * Async / await, or returning a promise can also be used as an alternative to using endAsync.
+     * @param loadingText Text to display until endAsync is called.
+     * @param onReady Callback function where the async action must be called from.
+     * @param options See options properties.
+     */
+    beginAsync(loadingText: string, onReady: (asyncContext: IAsyncRuleContext) => void | Promise<any>, options?: IAsyncRuleOptions): void;
+}
+export declare class AsyncRuleContext extends RuleContextBase implements IAsyncRuleContext {
+    private initiator;
+    constructor(initiator: RuleContext, ruleValidator: RuleValidator);
+    endAsync(): void;
+}
+export {};