@singularsystems/neo-core 0.10.75 → 0.10.77

package/dist/Data/Paging/PageManager.d.ts

@@ -82,7 +82,7 @@ export interface IPageManager {
     /**
      * Refresh the data only if the page manager has initialised.
      */
-    invalidateData(taskRunner?: ITaskRunner): Promise<void>;
+    invalidateData(): void;
     /**
      * Refresh the data by calling the api endpoint with the current criteria.
      * This will not reset the page index, and will not update the total record count, therefore should only be called if your criteria has not changed since the last full fetch using refreshData().
@@ -101,6 +101,7 @@ export declare class PageManager<TCriteria extends ValueObject, TModel extends I
     private _totalRecords;
     private currentData;
     private initialFetchState;
+    private isInvalidated;
     /**
      * Gets or sets the criteria.
      */
@@ -125,6 +126,8 @@ export declare class PageManager<TCriteria extends ValueObject, TModel extends I
      * Called by the pager component on first display. Will fetch data if options.fetchInitial is set to true.
      */
     initialise(): void;
+    /** Called after a bound ui component has rendered. Used to refetch data if invalidateData() was called. */
+    afterRender(): void;
     /**
      * Refresh the data by calling the api endpoint with the current criteria.
      * Note: the page index will be reset to zero. Use this when your criteria has changed
@@ -133,9 +136,9 @@ export declare class PageManager<TCriteria extends ValueObject, TModel extends I
      */
     refreshData(getCount?: boolean, taskRunner?: ITaskRunner): Promise<void>;
     /**
-     * Refresh the data only if the page manager has initialised.
+     * Refresh the data only if the page manager has initialised, and is currently being rendered.
      */
-    invalidateData(taskRunner?: ITaskRunner): Promise<void>;
+    invalidateData(): void;
     /**
      * Refresh the data by calling the api endpoint with the current criteria.
      * This will not reset the page index, and will not update the total record count, therefore should only be called if your criteria has not changed since the last full fetch using refreshData().
@@ -144,6 +147,10 @@ export declare class PageManager<TCriteria extends ValueObject, TModel extends I
     refreshPage(taskRunner?: ITaskRunner): Promise<void>;
     private fetchAndSetData;
     setData(pageRecords: PartialPlainObject<TModel>[], totalRecords?: number): Promise<void>;
+    /**
+     * Adds an item to the current page, and increments the total record count.
+     */
+    addRecord(item: TModel | Model.PlainObject<TModel>): void;
     /**
      * Resets the page manager to its initial state and clears the current data.
      */

package/dist/Data/Paging/PageManager.js

@@ -16,6 +16,7 @@ var PageManager = /** @class */ (function (_super) {
         _this._totalRecords = -1;
         _this.currentData = new List(_this.modelType);
         _this.initialFetchState = "none";
+        _this.isInvalidated = false;
         _this.options = options || {};
         _this.allowSort = _this.options.allowSort !== false;
         _this.performsRemoteSorting = true;
@@ -59,6 +60,7 @@ var PageManager = /** @class */ (function (_super) {
             if (this.initialFetchState === "loading") {
                 return null;
             }
+            void this.isInvalidated;
             return this.initialFetchState === "complete";
         },
         enumerable: false,
@@ -126,10 +128,21 @@ var PageManager = /** @class */ (function (_super) {
     PageManager.prototype.initialise = function () {
         if (!this.hasInitialised) {
             this.hasInitialised = true;
+            this.isInvalidated = false;
             if (this.options.fetchInitial) {
                 this.refreshData(true, this.options.initialTaskRunner);
             }
         }
+        else {
+            this.afterRender();
+        }
+    };
+    /** Called after a bound ui component has rendered. Used to refetch data if invalidateData() was called. */
+    PageManager.prototype.afterRender = function () {
+        if (this.isInvalidated) {
+            this.isInvalidated = false;
+            this.refreshPage();
+        }
     };
     /**
      * Refresh the data by calling the api endpoint with the current criteria.
@@ -167,22 +180,12 @@ var PageManager = /** @class */ (function (_super) {
         });
     };
     /**
-     * Refresh the data only if the page manager has initialised.
+     * Refresh the data only if the page manager has initialised, and is currently being rendered.
      */
-    PageManager.prototype.invalidateData = function (taskRunner) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!this.hasInitialised) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.refreshData(true, taskRunner)];
-                    case 1:
-                        _a.sent();
-                        _a.label = 2;
-                    case 2: return [2 /*return*/];
-                }
-            });
-        });
+    PageManager.prototype.invalidateData = function () {
+        if (this.hasInitialised) {
+            this.isInvalidated = true;
+        }
     };
     /**
      * Refresh the data by calling the api endpoint with the current criteria.
@@ -254,6 +257,18 @@ var PageManager = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Adds an item to the current page, and increments the total record count.
+     */
+    PageManager.prototype.addRecord = function (item) {
+        this._totalRecords += 1;
+        if (item.meta) {
+            this.data.push(item);
+        }
+        else {
+            this.data.push(this.modelType.fromJSObject(item));
+        }
+    };
     /**
      * Resets the page manager to its initial state and clears the current data.
      */
@@ -345,6 +360,10 @@ var PageManager = /** @class */ (function (_super) {
         Observable(),
         __metadata("design:type", String)
     ], PageManager.prototype, "initialFetchState", void 0);
+    __decorate([
+        Observable(),
+        __metadata("design:type", Object)
+    ], PageManager.prototype, "isInvalidated", void 0);
     PageManager = __decorate([
         NeoModel,
         __metadata("design:paramtypes", [Object, Function, Function, Object])

package/dist/Extensions.js

@@ -88,7 +88,12 @@ Array.prototype.sortBy = function (valueFnOrKey, direction, dataType) {
             }
         };
     }
-    return this.sort(comparer);
+    var array = this;
+    if (this.addNew) {
+        // Mobx6 doesn't allow the array to be sorted in place, must create a new one.
+        array = this.slice();
+    }
+    return array.sort(comparer);
 };
 Array.prototype.remove = function (item) {
     var index = this.indexOf(item);

package/dist/JsonSchema/ClassMetadata.d.ts

@@ -1,7 +1,8 @@
 import { PropertyMetadata } from './PropertyMetadata';
 import { IJsonObjectType } from './JsonSchemaTypes';
 import { ITypeCacheInternal } from './TypeCache';
-export declare class ClassMetadata {
+import { MetadataBase } from './MetadataBase';
+export declare class ClassMetadata extends MetadataBase {
     name: string;
     constructor(name: string);
     /**

package/dist/JsonSchema/ClassMetadata.js

@@ -1,31 +1,36 @@
+import { __extends } from "tslib";
 import { TypeMetadata } from './TypeMetadata';
 import { PropertyMetadata } from './PropertyMetadata';
-var ClassMetadata = /** @class */ (function () {
+import { MetadataBase } from './MetadataBase';
+var ClassMetadata = /** @class */ (function (_super) {
+    __extends(ClassMetadata, _super);
     function ClassMetadata(name) {
-        this.name = name;
+        var _this = _super.call(this) || this;
+        _this.name = name;
         /**
          * All properties.
          */
-        this.properties = [];
+        _this.properties = [];
         /**
          * Properties excluding child objects and lists.
          */
-        this.simpleProperties = [];
+        _this.simpleProperties = [];
         /**
          * Properties containing child object types.
          */
-        this.childObjectProperties = [];
+        _this.childObjectProperties = [];
         /**
          * Properties containing child list types.
          */
-        this.childListProperties = [];
+        _this.childListProperties = [];
+        return _this;
     }
     ClassMetadata.prototype.loadMetaData = function (schema, cache) {
+        _super.prototype.loadFromSchema.call(this, schema);
         for (var propertyKey in schema.properties) {
             var propertySchema = schema.properties[propertyKey];
             var propertyMetaData = new PropertyMetadata(propertyKey, TypeMetadata.create(propertySchema, cache));
-            propertyMetaData.title = propertySchema.title;
-            propertyMetaData.description = propertySchema.description;
+            propertyMetaData.loadFromSchema(propertySchema);
             if (propertyMetaData.type.basicType !== "unknown") {
                 this.properties.push(propertyMetaData);
                 if (propertyMetaData.type.basicType === "array") {
@@ -49,5 +54,5 @@ var ClassMetadata = /** @class */ (function () {
         return clone;
     };
     return ClassMetadata;
-}());
+}(MetadataBase));
 export { ClassMetadata };

package/dist/JsonSchema/MetadataBase.d.ts

@@ -0,0 +1,8 @@
+import { IJsonSchemaDescriptorType } from "./JsonSchemaTypes";
+export declare class MetadataBase {
+    title?: string;
+    description?: string;
+    ordinal?: number;
+    hidden?: boolean;
+    loadFromSchema(schema: IJsonSchemaDescriptorType): void;
+}

package/dist/JsonSchema/MetadataBase.js

@@ -0,0 +1,12 @@
+var MetadataBase = /** @class */ (function () {
+    function MetadataBase() {
+    }
+    MetadataBase.prototype.loadFromSchema = function (schema) {
+        this.title = schema.title;
+        this.description = schema.description;
+        this.ordinal = schema["x-ordinal"];
+        this.hidden = schema["x-hidden"];
+    };
+    return MetadataBase;
+}());
+export { MetadataBase };

package/dist/JsonSchema/PropertyMetadata.d.ts

@@ -1,8 +1,12 @@
+import { IJsonSchemaDescriptorType } from './JsonSchemaTypes';
+import { MetadataBase } from './MetadataBase';
 import { TypeMetadata } from './TypeMetadata';
-export declare class PropertyMetadata {
+export declare class PropertyMetadata extends MetadataBase {
     propertyName: string;
     type: TypeMetadata;
     constructor(propertyName: string, type: TypeMetadata);
-    title?: string;
-    description?: string;
+    formatString?: string;
+    width?: number;
+    hAlign?: "left" | "center" | "right";
+    loadFromSchema(schema: IJsonSchemaDescriptorType): void;
 }

package/dist/JsonSchema/PropertyMetadata.js

@@ -1,8 +1,19 @@
-var PropertyMetadata = /** @class */ (function () {
+import { __extends } from "tslib";
+import { MetadataBase } from './MetadataBase';
+var PropertyMetadata = /** @class */ (function (_super) {
+    __extends(PropertyMetadata, _super);
     function PropertyMetadata(propertyName, type) {
-        this.propertyName = propertyName;
-        this.type = type;
+        var _this = _super.call(this) || this;
+        _this.propertyName = propertyName;
+        _this.type = type;
+        return _this;
     }
+    PropertyMetadata.prototype.loadFromSchema = function (schema) {
+        _super.prototype.loadFromSchema.call(this, schema);
+        this.formatString = schema["x-formatString"];
+        this.width = schema["x-width"];
+        this.hAlign = schema["x-hAlign"];
+    };
     return PropertyMetadata;
-}());
+}(MetadataBase));
 export { PropertyMetadata };

package/dist/JsonSchema/TypeCache.js

@@ -20,6 +20,7 @@ var TypeCache = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    // This is an internal method used by TypeMetadata
     TypeCache.prototype.getOrAddType = function (name) {
         if (name.startsWith("#/definitions/")) {
             name = name.replace("#/definitions/", "");

package/dist/Model/BaseModels/UserEvent.js

@@ -1,5 +1,6 @@
-import { __decorate, __extends } from "tslib";
+import { __decorate, __extends, __metadata } from "tslib";
 import ValueObject from '../ValueObject';
+import { Date as DateAttribute } from '../Decorators';
 import NeoModel from '../NeoModel';
 var UserEventBase = /** @class */ (function (_super) {
     __extends(UserEventBase, _super);
@@ -16,6 +17,10 @@ var UserEventBase = /** @class */ (function (_super) {
         enumerable: false,
         configurable: true
     });
+    __decorate([
+        DateAttribute(),
+        __metadata("design:type", Object)
+    ], UserEventBase.prototype, "on", void 0);
     return UserEventBase;
 }(ValueObject));
 export { UserEventBase };

package/dist/Settings.d.ts

@@ -20,6 +20,8 @@ export declare const Settings: {
         collapsed: any;
         sortAsc: any;
         sortDesc: any;
+        /** Icon used in back buttons */
+        backIcon: any;
     };
     /** Grid default settings */
     grid: {

package/dist/Settings.js

@@ -19,6 +19,8 @@ export var Settings = {
         collapsed: "far-plus-square",
         sortAsc: "sort-up",
         sortDesc: "sort-down",
+        /** Icon used in back buttons */
+        backIcon: "arrow-left",
     },
     /** Grid default settings */
     grid: {

package/dist/Utils.d.ts

@@ -61,6 +61,10 @@ export declare class Utils {
      * Converts a string like 'user' to 'fa fa-user' or 'fa-user' to 'fa fa-user' or 'far-user' to 'far fa-user'
      */
     static getFontAwesomeClass(faString: string): string;
+    static getFontAwesomeIconProps(faString: string): {
+        name: string;
+        isSolid: boolean | undefined;
+    };
     /** Concatenates an array of strings together, putting spaces in-between them. */
     static joinWithSpaces(arg0?: string, ...args: (string | undefined)[]): string;
     /**

package/dist/Utils.js

@@ -115,15 +115,23 @@ var Utils = /** @class */ (function () {
      * Converts a string like 'user' to 'fa fa-user' or 'fa-user' to 'fa fa-user' or 'far-user' to 'far fa-user'
      */
     Utils.getFontAwesomeClass = function (faString) {
-        var isRegular = false;
+        var props = this.getFontAwesomeIconProps(faString);
+        return (props.isSolid === false ? 'far ' : (props.isSolid === true ? 'fas ' : 'fa ')) + 'fa-' + props.name;
+    };
+    Utils.getFontAwesomeIconProps = function (faString) {
+        var isSolid;
         if (faString.indexOf("fa-") === 0) {
             faString = faString.substring(3);
         }
         else if (faString.indexOf("far-") === 0) {
-            isRegular = true;
+            isSolid = false;
+            faString = faString.substring(4);
+        }
+        else if (faString.indexOf("fas-") === 0) {
+            isSolid = true;
             faString = faString.substring(4);
         }
-        return (isRegular ? 'far ' : 'fa ') + 'fa-' + faString;
+        return { name: faString, isSolid: isSolid };
     };
     /** Concatenates an array of strings together, putting spaces in-between them. */
     Utils.joinWithSpaces = function (arg0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularsystems/neo-core",
-  "version": "0.10.75",
+  "version": "0.10.77",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,7 +9,7 @@
   ],
   "scripts": {
     "build": "tsc",
-    "test": "jest"
+    "test": "jest --runInBand"
   },
   "author": "Singular Systems",
   "license": "ISC",
@@ -31,5 +31,6 @@
   "peerDependencies": {
     "axios": ">=0.21.1",
     "inversify": ">=5.0.1"
-  }
+  },
+  "packageManager": "yarn@3.6.1"
 }