@singularsystems/neo-core 0.10.78 → 0.10.80

package/dist/Components/ErrorHandler.js

@@ -2,6 +2,7 @@ import { __awaiter, __decorate, __generator, __metadata, __param } from "tslib";
 import { injectable, inject } from 'inversify';
 import { ModalUtils } from './Modal/ModalUtils';
 import NeoTypes from '../AppServices/NeoTypes';
+import NeoStrings from '../Localisation/NeoStrings';
 export var ErrorDisplayType;
 (function (ErrorDisplayType) {
     /** Show the error text in a modal. */
@@ -94,16 +95,16 @@ var ErrorHandler = /** @class */ (function () {
         });
     };
     ErrorHandler.prototype.get400Error = function (error) {
-        return this.parseAxiosError("Invalid data", "Cannot continue due to the following validation errors:", error);
+        return this.parseAxiosError(NeoStrings.errors.invalidDataTitle, NeoStrings.errors.invalidDataBody, error);
     };
     ErrorHandler.prototype.get401Error = function (error) {
-        return this.parseAxiosError("Not authenticated", "You are not logged in. Please reload the page to login again.", error);
+        return this.parseAxiosError(NeoStrings.errors.notAuthenticatedTitle, NeoStrings.errors.notAuthenticatedBody, error);
     };
     ErrorHandler.prototype.get403Error = function (error) {
-        return this.parseAxiosError("Unauthorised", "You do not have access to perform this operation.", error);
+        return this.parseAxiosError(NeoStrings.errors.unAuthorisedTitle, NeoStrings.errors.unAuthorisedBody, error);
     };
     ErrorHandler.prototype.get409Error = function (error) {
-        return this.parseAxiosError("Concurrency error", "Someone else modified the record before you saved it. Please reload it and try again.", error);
+        return this.parseAxiosError(NeoStrings.errors.concurrencyTitle, NeoStrings.errors.concurrencyBody, error);
     };
     /**
      * Parses an axios response into an IErrorDisplay object.
@@ -180,7 +181,7 @@ var ErrorHandler = /** @class */ (function () {
     };
     ErrorHandler.prototype.getGeneralError = function (error) {
         var errorDescription = error.message ? error.message : error;
-        return { header: "Error", body: errorDescription };
+        return { header: NeoStrings.errors.generalTitle, body: errorDescription };
     };
     ErrorHandler.prototype.displayError = function (displayType, error, errorDisplay) {
         if (error instanceof Error) {

package/dist/Components/FileManager/FileManager.js

@@ -7,6 +7,7 @@ import { NeoTypes } from '../../AppServices';
 import { ErrorDisplayType } from '../ErrorHandler';
 import { Settings } from '../../Settings';
 import { FileUploadBatch } from './FileUploadBatch';
+import NeoStrings from '../../Localisation/NeoStrings';
 var fileInputSymbol = Symbol("FileInput");
 var FileManagerBase = /** @class */ (function () {
     function FileManagerBase(uploadEndpointOrOptions, options) {
@@ -87,7 +88,7 @@ var FileManagerBase = /** @class */ (function () {
             return true;
         }
         else {
-            ModalUtils.showMessage("File Upload", "File extension: " + checkResult.extension + " is not allowed.");
+            ModalUtils.showMessage(NeoStrings.fileManager.uploadErrorTitle, NeoStrings.fileManager.uploadErrorBody.format(checkResult.extension));
             return false;
         }
     };

package/dist/Components/Modal/ModalUtils.js

@@ -1,5 +1,8 @@
+import { __assign } from "tslib";
 import Globals from '../../Globals';
 import { NeoTypes } from '../../AppServices';
+import { Settings } from '../../Settings';
+import NeoStrings from '../../Localisation/NeoStrings';
 export var ModalResult;
 (function (ModalResult) {
     ModalResult[ModalResult["Yes"] = 1] = "Yes";
@@ -12,7 +15,16 @@ var ModalHelpers = /** @class */ (function () {
     ModalHelpers.prototype.showMessage = function (title, message, resultValue) {
         var _this = this;
         return new Promise(function (resolve, reject) {
-            _this.showModal(title, message, { onClose: resolve, closeButton: { text: "Ok", onClick: function () { return resultValue ? resolve(resultValue) : resolve(); } } });
+            var button = { text: NeoStrings.modals.ok, onClick: function () { return resultValue ? resolve(resultValue) : resolve(); } };
+            var options = { onClose: resolve };
+            if (Settings.modal.okIsAccept) {
+                options.acceptButton = button;
+                options.closeButton = false;
+            }
+            else {
+                options.closeButton = button;
+            }
+            _this.showModal(title, message, options);
         });
     };
     /**
@@ -47,8 +59,8 @@ var ModalHelpers = /** @class */ (function () {
             _this.showModal(title, message, {
                 onClose: function () { return resolve(ModalResult.No); },
                 showCancelButton: allowCancel,
-                acceptButton: { text: "Yes", onClick: onAccept },
-                closeButton: { text: "No", onClick: function () { return resolve(ModalResult.No); } }
+                acceptButton: { text: NeoStrings.modals.yes, onClick: onAccept },
+                closeButton: { text: NeoStrings.modals.no, onClick: function () { return resolve(ModalResult.No); } }
             });
         });
     };
@@ -64,9 +76,9 @@ var ModalHelpers = /** @class */ (function () {
         return new Promise(function (resolve, reject) {
             _this.showModal(title, message, {
                 onClose: function () { return resolve(ModalResult.Cancel); },
-                acceptButton: { text: "Ok", onClick: function () { return resolve(ModalResult.Yes); } },
-                closeButton: { text: "Cancel", variant: "light", onClick: function () { return resolve(ModalResult.Cancel); } },
-                formProps: { model: model }
+                acceptButton: { text: NeoStrings.modals.ok, onClick: function () { return resolve(ModalResult.Yes); } },
+                closeButton: __assign(__assign({}, Settings.modal.cancelButton), { text: NeoStrings.modals.cancel, onClick: function () { return resolve(ModalResult.Cancel); } }),
+                formProps: { model: model },
             });
         });
     };
@@ -88,9 +100,9 @@ var ModalHelpers = /** @class */ (function () {
             _this.showModal(title, message, {
                 onClose: function () { return resolve(ModalResult.Cancel); },
                 buttons: [
-                    { text: "Yes", variant: "primary", onClick: onAccept },
-                    { text: "No", variant: "secondary", onClick: function () { return resolve(ModalResult.No); } },
-                    { text: "Cancel", variant: "light", onClick: function () { return resolve(ModalResult.Cancel); } }
+                    __assign(__assign({}, Settings.modal.acceptButton), { text: NeoStrings.modals.yes, onClick: onAccept }),
+                    __assign(__assign({}, Settings.modal.closeButton), { text: NeoStrings.modals.no, onClick: function () { return resolve(ModalResult.No); } }),
+                    __assign(__assign({}, Settings.modal.cancelButton), { text: NeoStrings.modals.cancel, onClick: function () { return resolve(ModalResult.Cancel); } })
                 ]
             });
         });

package/dist/DebounceHelper.d.ts

@@ -26,10 +26,13 @@ export declare class DebounceHelper<T = void, TState = any> {
      * @param state State to pass to debounced method as an array of values for each time debounce was called.
      */
     static debounce<T = any, TState = any>(syncInstance: any, callback: (state: TState[]) => T | Promise<T>, delayMs: number, state?: TState): Promise<IDebounceResult<T>>;
+    static hasPending(syncInstance: any): boolean;
     /** Cancels pending execution of the callback. Pending promise will be resolved with cancelled: true. */
     static cancelPending<TState = any>(syncInstance: any): TState[];
     /** Fires the latest callback immediately. Pending promise from execute() will also be resolved with the return value of the callback. */
     static executeImmediate(syncInstance: any): Promise<void>;
+    /** Indicates that there is a pending execution. */
+    get hasPending(): boolean;
     /**
      * Waits the interval defined in the constructor, then executes the callback.
      * The callback will not execute if execute is called again within the interval.

package/dist/DebounceHelper.js

@@ -32,6 +32,15 @@ var DebounceHelper = /** @class */ (function () {
         helper.delayMs = delayMs;
         return helper.execute(state);
     };
+    DebounceHelper.hasPending = function (syncInstance) {
+        var helper = syncInstance[stateSymbol];
+        if (helper) {
+            return helper.hasPending;
+        }
+        else {
+            return false;
+        }
+    };
     /** Cancels pending execution of the callback. Pending promise will be resolved with cancelled: true. */
     DebounceHelper.cancelPending = function (syncInstance) {
         var helper = syncInstance[stateSymbol];
@@ -52,6 +61,14 @@ var DebounceHelper = /** @class */ (function () {
             return Promise.resolve();
         }
     };
+    Object.defineProperty(DebounceHelper.prototype, "hasPending", {
+        /** Indicates that there is a pending execution. */
+        get: function () {
+            return this.currentResolver !== undefined;
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Waits the interval defined in the constructor, then executes the callback.
      * The callback will not execute if execute is called again within the interval.

package/dist/Localisation/NeoStrings.d.ts

@@ -0,0 +1,40 @@
+declare const NeoStrings: {
+    errors: {
+        concurrencyTitle: string;
+        concurrencyBody: string;
+        generalTitle: string;
+        invalidDataTitle: string;
+        invalidDataBody: string;
+        notAuthenticatedTitle: string;
+        notAuthenticatedBody: string;
+        unAuthorisedTitle: string;
+        unAuthorisedBody: string;
+    };
+    fileManager: {
+        uploadErrorTitle: string;
+        /** {0} is the extension of the file */
+        uploadErrorBody: string;
+    };
+    modals: {
+        cancel: string;
+        no: string;
+        ok: string;
+        yes: string;
+    };
+    validation: {
+        /** Default text to display for built in rules. */
+        rules: {
+            /** {0} is the field name */
+            required: string;
+            /** {0} is the current value */
+            emailAddress: string;
+            /** {0} is the field name */
+            regExp: string;
+            /** Displayed when the string is too short */
+            stringLengthLessThan: string;
+            /** Displayed when the string is too long */
+            stringLengthMoreThan: string;
+        };
+    };
+};
+export default NeoStrings;

package/dist/Localisation/NeoStrings.js

@@ -0,0 +1,40 @@
+var NeoStrings = {
+    errors: {
+        concurrencyTitle: "Concurrency error",
+        concurrencyBody: "Someone else modified the record before you saved it. Please reload it and try again.",
+        generalTitle: "Error",
+        invalidDataTitle: "Invalid data",
+        invalidDataBody: "Cannot continue due to the following validation errors:",
+        notAuthenticatedTitle: "Not authenticated",
+        notAuthenticatedBody: "You are not logged in. Please reload the page to login again.",
+        unAuthorisedTitle: "Unauthorised",
+        unAuthorisedBody: "You do not have access to perform this operation."
+    },
+    fileManager: {
+        uploadErrorTitle: "File upload error",
+        /** {0} is the extension of the file */
+        uploadErrorBody: "File extension: {0} is not allowed."
+    },
+    modals: {
+        cancel: "Cancel",
+        no: "No",
+        ok: "Ok",
+        yes: "Yes",
+    },
+    validation: {
+        /** Default text to display for built in rules. */
+        rules: {
+            /** {0} is the field name */
+            required: "{0} is required",
+            /** {0} is the current value */
+            emailAddress: "{0} is not a valid email address",
+            /** {0} is the field name */
+            regExp: "{0} is in an invalid format",
+            /** Displayed when the string is too short */
+            stringLengthLessThan: "{0} cannot be less than {1} characters in length",
+            /** Displayed when the string is too long */
+            stringLengthMoreThan: "{0} cannot be more than {1} characters in length"
+        }
+    }
+};
+export default NeoStrings;

package/dist/Model/Misc.d.ts

@@ -54,10 +54,12 @@ export interface IDisposable {
     dispose(): void;
 }
 export interface IAutoRunner extends IDisposable {
+    /** Indicates whether there are any pending callbacks. */
+    readonly hasPending: boolean;
     /** Dispose the auto runner. */
     dispose(): void;
-    /** Cancels any pending callbacks. */
-    cancelPending(): void;
+    /** Cancels any pending callbacks. Returns true if there were any pending callbacks. */
+    cancelPending(): boolean;
     /** Cancels any pending callbacks, and fires the callback immediately. */
     fireImmediate(): void;
 }

package/dist/Model/ObservableProperty.js

@@ -25,7 +25,7 @@ var ObservableProperty = /** @class */ (function () {
         var model = new ObservableModel();
         model.value = defaultValue;
         var propertyInfo = new PropertyInfo("value");
-        Utils.populatePartialWithDefaults(propertyInfo, options);
+        Utils.populatePartialWithDefaults(propertyInfo, options, true);
         propertyInfo.displayName = displayName;
         if (isRequired) {
             propertyInfo.rules.push(new RequiredRule("{0} is required."));

package/dist/Settings.d.ts

@@ -49,8 +49,13 @@ export declare const Settings: {
         useStickyHeaders: boolean;
     };
     modal: {
+        /** Set to true if ModalUtils.showMessage() should show an accept button instead of close button. */
+        okIsAccept: boolean;
         acceptButton: IButtonOptions;
+        /** Settings for close button shown in footer. */
         closeButton: IButtonOptions;
+        /** Settings for cancel button shown in footer. */
+        cancelButton: IButtonOptions;
     };
     pager: {
         firstText: string;

package/dist/Settings.js

@@ -72,14 +72,22 @@ export var Settings = {
         useStickyHeaders: false,
     },
     modal: {
+        /** Set to true if ModalUtils.showMessage() should show an accept button instead of close button. */
+        okIsAccept: false,
         acceptButton: {
             text: "Ok",
             variant: "primary"
         },
+        /** Settings for close button shown in footer. */
         closeButton: {
             text: "Close",
             variant: "secondary"
         },
+        /** Settings for cancel button shown in footer. */
+        cancelButton: {
+            variant: "light",
+            isOutline: false,
+        },
     },
     pager: {
         firstText: "«",

package/dist/Utils.d.ts

@@ -55,8 +55,9 @@ export declare class Utils {
      * Completes a partially populated object using defaults specified in the defaults parameter.
      * @param partial Partially populated object
      * @param defaults Defaults object.
+     * @param force True if the properties in `partial` must be set even if they have a value.
      */
-    static populatePartialWithDefaults<T>(partial: Partial<T> | undefined, defaults: T): T;
+    static populatePartialWithDefaults<T>(partial: Partial<T> | undefined, defaults: T, force?: boolean): T;
     /**
      * Converts a string like 'user' to 'fa fa-user' or 'fa-user' to 'fa fa-user' or 'far-user' to 'far fa-user'
      */

package/dist/Utils.js

@@ -101,12 +101,14 @@ var Utils = /** @class */ (function () {
      * Completes a partially populated object using defaults specified in the defaults parameter.
      * @param partial Partially populated object
      * @param defaults Defaults object.
+     * @param force True if the properties in `partial` must be set even if they have a value.
      */
-    Utils.populatePartialWithDefaults = function (partial, defaults) {
+    Utils.populatePartialWithDefaults = function (partial, defaults, force) {
+        if (force === void 0) { force = false; }
         if (!partial)
             partial = {};
         for (var key in defaults) {
-            if (!partial[key])
+            if (force || !partial[key])
                 partial[key] = defaults[key];
         }
         return partial;

package/dist/Validation/Decorators.js

@@ -1,12 +1,13 @@
 import { __assign } from "tslib";
 import * as Rules from './Rules';
 import { ensureTypeInfo } from '../Model/NeoTypeInfo';
+import NeoStrings from '../Localisation/NeoStrings';
 function addRuleToType(type, propertyName, rule) {
     ensureTypeInfo(type.constructor).neo.addAttributeRule(propertyName, rule);
 }
 export function Required(errorTextOrOptions) {
     return function (type, propertyKey) {
-        var options = { errorText: "{0} is required", allowZero: false };
+        var options = { errorText: NeoStrings.validation.rules.required, allowZero: false };
         if (errorTextOrOptions !== undefined) {
             if (typeof errorTextOrOptions === "string") {
                 options.errorText = errorTextOrOptions;
@@ -20,16 +21,14 @@ export function Required(errorTextOrOptions) {
     };
 }
 export function EmailAddress(errorText) {
-    if (errorText === void 0) { errorText = "{0} is not a valid email address"; }
     return function (type, propertyKey) {
-        var emailAddressRule = new Rules.EmailAddressRule(errorText);
+        var emailAddressRule = new Rules.EmailAddressRule(errorText !== null && errorText !== void 0 ? errorText : NeoStrings.validation.rules.emailAddress);
         addRuleToType(type, propertyKey, emailAddressRule);
     };
 }
 export function RegExp(expression, errorText) {
-    if (errorText === void 0) { errorText = "{0} is in an invalid format"; }
     return function (type, propertyKey) {
-        var regExpRule = new Rules.RegExpRule(expression, errorText);
+        var regExpRule = new Rules.RegExpRule(expression, errorText !== null && errorText !== void 0 ? errorText : NeoStrings.validation.rules.regExp);
         addRuleToType(type, propertyKey, regExpRule);
     };
 }

package/dist/Validation/Rules.js

@@ -1,6 +1,7 @@
 import { __extends } from "tslib";
 import { RuleSeverity } from './ValidationState';
 import { Utils } from '../Utils';
+import NeoStrings from '../Localisation/NeoStrings';
 var Rule = /** @class */ (function () {
     function Rule() {
         this.ruleId = Utils.uuidv4();
@@ -40,12 +41,12 @@ var StringLengthRule = /** @class */ (function (_super) {
         var errorTextValue = this.errorText;
         if (this.minLength && (!value || value.length < this.minLength)) {
             if (!errorTextValue)
-                errorTextValue = "{0} cannot be less than {1} characters in length";
+                errorTextValue = NeoStrings.validation.rules.stringLengthLessThan;
             context.addError(errorTextValue.format(propertyInstance.propertyInfo.readableName, this.minLength.toString(), this.maxLength.toString()));
         }
         else if (value && value.length > this.maxLength) {
             if (!errorTextValue)
-                errorTextValue = "{0} cannot be more than {1} characters in length";
+                errorTextValue = NeoStrings.validation.rules.stringLengthMoreThan;
             context.addError(errorTextValue.format(propertyInstance.propertyInfo.readableName, this.maxLength.toString()));
         }
     };

package/dist/index.d.ts

@@ -12,6 +12,7 @@ import { MenuUtils } from './Components/ContextMenu/MenuUtils';
 import FileUtils from "./FileUtils";
 import { runInTask } from './Components/TaskRunner/Decorators';
 import { createProperty } from "./Model/PropertyInstance";
+import NeoStrings from "./Localisation/NeoStrings";
 import * as Attributes from './Model/Decorators';
 import * as Rules from './Validation/Decorators';
 import * as AppServices from './AppServices';
@@ -28,7 +29,7 @@ import * as SignalR from './SignalR';
 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 { AppServices, Attributes, Components, Data, DateUtils, DebounceHelper, EnumHelper, FileUtils, JsonSchema, Localisation, List, MenuUtils, Misc, ModalUtils, Model, NeoModel, NeoStrings, Network, NotifyUtils, NumberUtils, Routing, Rules, Security, SignalR, StringUtils, Validation, Views, };
 export { runInTask, createProperty };
 export { default as ModelBase } from './Model/ModelBase';
 export { default as ValueObject } from './Model/ValueObject';

package/dist/index.js

@@ -13,6 +13,7 @@ import { MenuUtils } from './Components/ContextMenu/MenuUtils';
 import FileUtils from "./FileUtils";
 import { runInTask } from './Components/TaskRunner/Decorators';
 import { createProperty } from "./Model/PropertyInstance";
+import NeoStrings from "./Localisation/NeoStrings";
 // Namespaced exports from 1 file
 import * as Attributes from './Model/Decorators';
 import * as Rules from './Validation/Decorators';
@@ -33,7 +34,7 @@ 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, };
+export { AppServices, Attributes, Components, Data, DateUtils, DebounceHelper, EnumHelper, FileUtils, JsonSchema, Localisation, List, MenuUtils, Misc, ModalUtils, Model, NeoModel, NeoStrings, Network, NotifyUtils, NumberUtils, Routing, Rules, Security, SignalR, StringUtils, Validation, Views, };
 // Functions
 export { runInTask, createProperty };
 export { default as ModelBase } from './Model/ModelBase';

package/package.json

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

package/CHANGELOG.md

@@ -1,15 +0,0 @@
-
-
-# Breaking changes
-
-## 0.10.65 (6 March 2023)
-
-* `IErrorHandler` now requires the return type to be `Promise<IErrorDisplay>` instead of `IErrorDisplay`.
-* Most of the protected methods in `ErrorHandler` have been changed to `async`.
-* These changes were required in order to be able to read errors from axios blob responses.
-
-# Change Log
-
-## 0.10.65 (6 March 2023)
-
-* Fixed error handler not parsing axios responses when response type is `blob`.