@singularsystems/neo-core 1.0.0-beta.7 → 1.0.0-beta.9

package/dist/AppServices/Config/ConfigModel.d.ts

@@ -1,4 +1,4 @@
-export interface IConfigModel {
+export interface IConfigModelData {
     readonly baseUrl: string;
     /**
      * True by default if the NODE_ENV environment variable is "development".
@@ -8,6 +8,8 @@ export interface IConfigModel {
      * This must be specified in your config file to be set to true.
      */
     isTest: boolean;
+}
+export interface IConfigModel extends IConfigModelData {
     readonly isTestOrDevelopment: boolean;
     initialise(): void;
 }

package/dist/AppServices/Config/ConfigService.d.ts

@@ -1,15 +1,26 @@
-import { IConfigModel } from './ConfigModel';
+import { AxiosPromise } from "axios";
+import { IConfigModel, IConfigModelData } from './ConfigModel';
+import { IDbSet } from "../../IndexDb/IDbSet";
 export interface IConfigService {
     /**
-     * Load the config file from the specified path.
+     * Load and process the config file from the specified path.
      * Path will default to [baseUrl]/config.json
      * @param path Optional path.
+     * @param store Offline store to allow offline retrieval.
      */
-    loadConfig(path?: string): Promise<IConfigModel>;
+    loadConfig(path?: string, store?: IDbSet<IConfigModelData>): Promise<IConfigModel>;
+    /** Fetch the raw config data from the server. */
+    fetchConfig(path?: string): Promise<any>;
+    /**
+     * Sets the raw config data.
+     * Use this if `loadConfig` fails, and you have an offline copy of the config data. */
+    setConfig(configData: any): IConfigModel;
 }
 export declare class ConfigService implements IConfigService {
     private config;
     constructor(config: IConfigModel);
-    loadConfig(path?: string): Promise<IConfigModel>;
+    loadConfig(path?: string, store?: IDbSet<IConfigModelData>): Promise<IConfigModel>;
+    fetchConfig(path?: string | undefined): AxiosPromise<any>;
+    setConfig(configData: any): IConfigModel;
     static get isDevelopment(): boolean;
 }

package/dist/AppServices/Config/ConfigService.js

@@ -2,37 +2,58 @@ import { __awaiter, __decorate, __generator, __metadata, __param } from "tslib";
 import { injectable, inject } from 'inversify';
 import Axios from "axios";
 import NeoTypes from '../NeoTypes';
+import AxiosUtils from "../../AxiosUtils";
 export var ConfigService = /** @class */ (function () {
     function ConfigService(config) {
         this.config = config;
     }
-    ConfigService.prototype.loadConfig = function (path) {
+    ConfigService.prototype.loadConfig = function (path, store) {
         return __awaiter(this, void 0, void 0, function () {
-            var timestamp, response, error_1;
+            var configData, e_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        path = path !== null && path !== void 0 ? path : "".concat(this.config.baseUrl, "/config.json");
-                        _a.label = 1;
+                        _a.trys.push([0, 4, , 7]);
+                        return [4 /*yield*/, this.fetchConfig(path)];
                     case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        timestamp = new Date().getTime();
-                        return [4 /*yield*/, Axios.get("".concat(path, "?").concat(timestamp))];
+                        configData = (_a.sent()).data;
+                        if (!store) return [3 /*break*/, 3];
+                        return [4 /*yield*/, store.putAsync(configData, 1)];
                     case 2:
-                        response = _a.sent();
-                        // The raw parsed json objects properties are copied into the config model.
-                        // It is up to the config model to transform its properties if required (in the initialise method). 
-                        Object.assign(this.config, response.data);
-                        this.config.initialise();
-                        return [2 /*return*/, this.config];
-                    case 3:
-                        error_1 = _a.sent();
-                        throw new Error("ConfigService - Error loading configuration: ".concat(error_1));
-                    case 4: return [2 /*return*/];
+                        _a.sent();
+                        _a.label = 3;
+                    case 3: return [3 /*break*/, 7];
+                    case 4:
+                        e_1 = _a.sent();
+                        if (!(store && AxiosUtils.isNetworkError(e_1) && !window.navigator.onLine)) return [3 /*break*/, 6];
+                        return [4 /*yield*/, store.getAsync(1)];
+                    case 5:
+                        // get config from index db
+                        configData = _a.sent();
+                        _a.label = 6;
+                    case 6:
+                        if (!configData) {
+                            throw new Error("ConfigService - Error loading configuration: ".concat(e_1));
+                        }
+                        return [3 /*break*/, 7];
+                    case 7: return [2 /*return*/, this.setConfig(configData)];
                 }
             });
         });
     };
+    ConfigService.prototype.fetchConfig = function (path) {
+        path = path !== null && path !== void 0 ? path : "".concat(this.config.baseUrl, "/config.json");
+        // Fetch config with timestamp to prevent caching
+        var timestamp = new Date().getTime();
+        return Axios.get("".concat(path, "?").concat(timestamp));
+    };
+    ConfigService.prototype.setConfig = function (configData) {
+        // The raw parsed json objects properties are copied into the config model.
+        // It is up to the config model to transform its properties if required (in the initialise method). 
+        Object.assign(this.config, configData);
+        this.config.initialise();
+        return this.config;
+    };
     Object.defineProperty(ConfigService, "isDevelopment", {
         get: function () {
             return process.env.NODE_ENV === "development";

package/dist/AxiosUtils.d.ts

@@ -0,0 +1,27 @@
+import { AxiosError, AxiosPromise, AxiosResponse } from "axios";
+import { IErrorDetails } from "./Components/ErrorHandler";
+interface ISuccessResponse<TData> {
+    success: true;
+    data: TData;
+}
+interface IFailedResponse<TData> extends IErrorDetails<TData> {
+    success: false;
+}
+export default class AxiosUtils {
+    /**
+     * Awaits an axios promise and returns an object indicating success or failure.
+     * @param filter Only errors matching this filter will be caught.
+     */
+    static catchErrors<TData>(request: AxiosPromise<TData>, filter?: (r?: AxiosResponse) => boolean): Promise<ISuccessResponse<TData> | IFailedResponse<any>>;
+    /** Reads the properties of an axios error. */
+    static readError(e: AxiosError): Promise<IFailedResponse<any>>;
+    /**
+     * Checks if the error data is a blob object, and reads from it if that is the case.
+     */
+    static ensureAxiosErrorData(responseData: any): Promise<any>;
+    static isClientError(response?: AxiosResponse): boolean;
+    static isServerError(response?: AxiosResponse): boolean;
+    /** Returns true if the error was raised from axios, and is a network error. E.g. no response was received from the server. */
+    static isNetworkError(e: any): boolean;
+}
+export {};

package/dist/AxiosUtils.js

@@ -0,0 +1,104 @@
+import { __awaiter, __generator } from "tslib";
+import { isAxiosError } from "axios";
+var AxiosUtils = /** @class */ (function () {
+    function AxiosUtils() {
+    }
+    /**
+     * Awaits an axios promise and returns an object indicating success or failure.
+     * @param filter Only errors matching this filter will be caught.
+     */
+    AxiosUtils.catchErrors = function (request, filter) {
+        return __awaiter(this, void 0, void 0, function () {
+            var waited, e_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, request];
+                    case 1:
+                        waited = _a.sent();
+                        return [2 /*return*/, {
+                                data: waited.data,
+                                success: true,
+                            }];
+                    case 2:
+                        e_1 = _a.sent();
+                        if (isAxiosError(e_1)) {
+                            if (filter === undefined || filter(e_1.response)) {
+                                return [2 /*return*/, this.readError(e_1)];
+                            }
+                        }
+                        throw e_1;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /** Reads the properties of an axios error. */
+    AxiosUtils.readError = function (e) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var data, isServerError;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        data = (_a = e.response) === null || _a === void 0 ? void 0 : _a.data;
+                        if (!data) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.ensureAxiosErrorData(data)];
+                    case 1:
+                        data = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        isServerError = false;
+                        if ((_b = e.response) === null || _b === void 0 ? void 0 : _b.status) {
+                            isServerError = this.isServerError(e.response);
+                        }
+                        return [2 /*return*/, {
+                                success: false,
+                                isServerError: isServerError,
+                                isNetworkError: e.response === undefined,
+                                data: data,
+                                error: e,
+                            }];
+                }
+            });
+        });
+    };
+    /**
+     * Checks if the error data is a blob object, and reads from it if that is the case.
+     */
+    AxiosUtils.ensureAxiosErrorData = function (responseData) {
+        return __awaiter(this, void 0, void 0, function () {
+            var errorText;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!(responseData instanceof Blob)) return [3 /*break*/, 2];
+                        return [4 /*yield*/, responseData.text()];
+                    case 1:
+                        errorText = _a.sent();
+                        if (responseData.type.toLowerCase().includes('json')) {
+                            return [2 /*return*/, JSON.parse(errorText)];
+                        }
+                        else {
+                            return [2 /*return*/, errorText];
+                        }
+                        _a.label = 2;
+                    case 2: return [2 /*return*/, responseData];
+                }
+            });
+        });
+    };
+    AxiosUtils.isClientError = function (response) {
+        return response !== undefined && response.status >= 400 && response.status < 500;
+    };
+    AxiosUtils.isServerError = function (response) {
+        return response !== undefined && response.status >= 500 && response.status < 600;
+    };
+    /** Returns true if the error was raised from axios, and is a network error. E.g. no response was received from the server. */
+    AxiosUtils.isNetworkError = function (e) {
+        return isAxiosError(e) && e.response === undefined;
+    };
+    return AxiosUtils;
+}());
+export default AxiosUtils;

package/dist/Components/ErrorHandler.d.ts

@@ -1,13 +1,19 @@
 import { AxiosError, AxiosResponse } from 'axios';
 import { INotificationHelper } from './Notifications/INotificationHelper';
-export interface IErrorDisplay {
-    header: string;
+export interface IErrorDetails<TData> {
     statusCode?: number;
     statusText?: string;
-    body: any;
-    data?: IErrorData;
+    data?: TData;
     /** True if this is a 500 type error from the server. */
     isServerError?: boolean;
+    /** True if the server could not be reached. */
+    isNetworkError?: boolean;
+    /** Original axios error. */
+    error: AxiosError;
+}
+export interface IErrorDisplay extends IErrorDetails<IErrorData> {
+    header: string;
+    body: any;
     /** Cancels displaying of the error. */
     cancelDisplay?: boolean;
 }
@@ -52,11 +58,7 @@ export declare class ErrorHandler implements IErrorHandler {
      * @param error Axios error.
      */
     parseAxiosError(header: string, body: string, error: AxiosError): Promise<IErrorDisplay>;
-    /**
-     * Checks if the error data is a blob object, and reads from it if that is the case.
-     */
-    protected ensureAxiosErrorData(responseData: any): Promise<any>;
-    protected getGeneralError(error: any): IErrorDisplay;
+    protected getGeneralError(error: AxiosError): IErrorDisplay;
     protected displayError(displayType: ErrorDisplayType, error: any, errorDisplay: IErrorDisplay): void;
     protected displayModal(error: any, errorDisplay: IErrorDisplay): void;
     protected displayNotification(error: any, errorDisplay: IErrorDisplay): void;

package/dist/Components/ErrorHandler.js

@@ -1,8 +1,10 @@
 import { __awaiter, __decorate, __generator, __metadata, __param } from "tslib";
 import { injectable, inject } from 'inversify';
+import { isAxiosError } from 'axios';
 import { ModalUtils } from './Modal/ModalUtils';
 import NeoTypes from '../AppServices/NeoTypes';
 import NeoStrings from '../Localisation/NeoStrings';
+import AxiosUtils from "../AxiosUtils";
 export var ErrorDisplayType;
 (function (ErrorDisplayType) {
     /** Show the error text in a modal. */
@@ -41,7 +43,7 @@ export var ErrorHandler = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (!error.isAxiosError) return [3 /*break*/, 2];
+                        if (!isAxiosError(error)) return [3 /*break*/, 2];
                         return [4 /*yield*/, this.getAxiosError(error, error.response)];
                     case 1: return [2 /*return*/, _a.sent()];
                     case 2: return [2 /*return*/, this.getGeneralError(error)];
@@ -90,6 +92,7 @@ export var ErrorHandler = /** @class */ (function () {
                         errorDisplay = this.getGeneralError(error);
                         // Add status code of -1 to differentiate network errors from code exceptions.
                         errorDisplay.statusCode = -1;
+                        errorDisplay.isNetworkError = true;
                         _b.label = 13;
                     case 13: return [2 /*return*/, errorDisplay];
                 }
@@ -97,7 +100,9 @@ export var ErrorHandler = /** @class */ (function () {
         });
     };
     ErrorHandler.prototype.get400Error = function (error) {
-        return this.parseAxiosError(NeoStrings.errors.invalidDataTitle, NeoStrings.errors.invalidDataBody, error);
+        var _a;
+        var isGet = ((_a = error.response) === null || _a === void 0 ? void 0 : _a.config.method) === "get";
+        return this.parseAxiosError(NeoStrings.errors.invalidDataTitle, isGet ? NeoStrings.errors.invalidDataBodyGet : NeoStrings.errors.invalidDataBody, error);
     };
     ErrorHandler.prototype.get401Error = function (error) {
         return this.parseAxiosError(NeoStrings.errors.notAuthenticatedTitle, NeoStrings.errors.notAuthenticatedBody, error);
@@ -121,9 +126,9 @@ export var ErrorHandler = /** @class */ (function () {
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        errorDisplay = { header: header, body: body, statusText: error.message, statusCode: (_a = error.response) === null || _a === void 0 ? void 0 : _a.status };
+                        errorDisplay = { header: header, body: body, statusText: error.message, statusCode: (_a = error.response) === null || _a === void 0 ? void 0 : _a.status, error: error };
                         if (!error.response.data) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this.ensureAxiosErrorData(error.response.data)];
+                        return [4 /*yield*/, AxiosUtils.ensureAxiosErrorData(error.response.data)];
                     case 1:
                         rawErrorData_1 = _b.sent();
                         if (rawErrorData_1.title) {
@@ -156,34 +161,9 @@ export var ErrorHandler = /** @class */ (function () {
             });
         });
     };
-    /**
-     * Checks if the error data is a blob object, and reads from it if that is the case.
-     */
-    ErrorHandler.prototype.ensureAxiosErrorData = function (responseData) {
-        return __awaiter(this, void 0, void 0, function () {
-            var errorText;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (!(responseData instanceof this.blobType)) return [3 /*break*/, 2];
-                        return [4 /*yield*/, responseData.text()];
-                    case 1:
-                        errorText = _a.sent();
-                        if (responseData.type.toLowerCase().includes('json')) {
-                            return [2 /*return*/, JSON.parse(errorText)];
-                        }
-                        else {
-                            return [2 /*return*/, errorText];
-                        }
-                        _a.label = 2;
-                    case 2: return [2 /*return*/, responseData];
-                }
-            });
-        });
-    };
     ErrorHandler.prototype.getGeneralError = function (error) {
         var errorDescription = error.message ? error.message : error;
-        return { header: NeoStrings.errors.generalTitle, body: errorDescription };
+        return { header: NeoStrings.errors.generalTitle, body: errorDescription, error: error };
     };
     ErrorHandler.prototype.displayError = function (displayType, error, errorDisplay) {
         if (error instanceof Error) {

package/dist/IndexDb/IDbSet.d.ts

@@ -0,0 +1,9 @@
+/** Represents a table in a data store. */
+export interface IDbSet<T> {
+    /** Gets the first item matching the key, or key range. */
+    getAsync(key: IDBValidKey | IDBKeyRange): Promise<T | undefined>;
+    /** Adds or updates an item. */
+    putAsync(value: T, keyValue?: IDBValidKey): Promise<void>;
+    /** Adds or updates multiple items in a transaction. */
+    putAsync(value: T[]): Promise<void>;
+}

package/dist/IndexDb/IDbSet.js

@@ -0,0 +1 @@
+export {};

package/dist/Localisation/NeoStrings.d.ts

@@ -4,7 +4,10 @@ declare const NeoStrings: {
         concurrencyBody: string;
         generalTitle: string;
         invalidDataTitle: string;
+        /** 400 error for non get requests */
         invalidDataBody: string;
+        /** 400 error for get requests */
+        invalidDataBodyGet: string;
         notAuthenticatedTitle: string;
         notAuthenticatedBody: string;
         unAuthorisedTitle: string;

package/dist/Localisation/NeoStrings.js

@@ -4,7 +4,10 @@ var NeoStrings = {
         concurrencyBody: "Someone else modified the record before you saved it. Please reload it and try again.",
         generalTitle: "Error",
         invalidDataTitle: "Invalid data",
+        /** 400 error for non get requests */
         invalidDataBody: "Cannot continue due to the following validation errors:",
+        /** 400 error for get requests */
+        invalidDataBodyGet: "Incorrect data was provided.",
         notAuthenticatedTitle: "Not authenticated",
         notAuthenticatedBody: "You are not logged in. Please reload the page to login again.",
         unAuthorisedTitle: "Unauthorised",

package/dist/Model/Decorators.d.ts

@@ -43,8 +43,8 @@ export declare function OnChanged<T>(callback: (target: T) => (oldValue: any, ne
 export declare function Debounce(value?: boolean): (type: any, propertyKey: string) => void;
 /** Converts a getter into a computed. Note, when using NeoModel you do not need to do this. */
 export declare function Computed(isComputed?: boolean): (type: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
-/** Specifies whether a method is a mobx action. By default all methods are actions.
- * Use this decorator to suppress this behaviour (by passing in false), or change the default behaviour in the makeObservable options passed to makeObservable. */
+/** Specifies whether a method is a mobx action.
+ * Change the default behaviour at a class level in the makeObservable options passed to makeObservable. */
 export declare function Action(isAction?: boolean): (type: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
 /** Sets this property as the display member to be used in drop downs / radio lists etc. */
 export declare function DisplayMember(): (type: any, propertyKey: string) => void;

package/dist/Model/Decorators.js

@@ -173,9 +173,10 @@ export function Computed(isComputed) {
         ensureTypeInfo(type.constructor).neo.addComputed(propertyKey, descriptor, isComputed);
     };
 }
-/** Specifies whether a method is a mobx action. By default all methods are actions.
- * Use this decorator to suppress this behaviour (by passing in false), or change the default behaviour in the makeObservable options passed to makeObservable. */
+/** Specifies whether a method is a mobx action.
+ * Change the default behaviour at a class level in the makeObservable options passed to makeObservable. */
 export function Action(isAction) {
+    if (isAction === void 0) { isAction = true; }
     return function (type, propertyKey, descriptor) {
         ensureTypeInfo(type.constructor).neo.addMethod(propertyKey).isAction = isAction;
     };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import "reflect-metadata";
 import './Extensions';
+import AxiosUtils from "./AxiosUtils";
 import List from './Model/List';
 import NeoModel from './Model/NeoModel';
 import DateUtils from './Dates/DateUtils';
@@ -30,7 +31,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, NeoStrings, Network, NotifyUtils, Numeric, NumberUtils, Routing, Rules, Security, SignalR, StringUtils, Validation, Views, };
+export { AxiosUtils, AppServices, Attributes, Components, Data, DateUtils, DebounceHelper, EnumHelper, FileUtils, JsonSchema, Localisation, List, MenuUtils, Misc, ModalUtils, Model, NeoModel, NeoStrings, Network, NotifyUtils, Numeric, 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

@@ -1,6 +1,7 @@
 import "reflect-metadata";
 import './Extensions';
 // Individual exports
+import AxiosUtils from "./AxiosUtils";
 import List from './Model/List';
 import NeoModel from './Model/NeoModel';
 import DateUtils from './Dates/DateUtils';
@@ -35,7 +36,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, NeoStrings, Network, NotifyUtils, Numeric, NumberUtils, Routing, Rules, Security, SignalR, StringUtils, Validation, Views, };
+export { AxiosUtils, AppServices, Attributes, Components, Data, DateUtils, DebounceHelper, EnumHelper, FileUtils, JsonSchema, Localisation, List, MenuUtils, Misc, ModalUtils, Model, NeoModel, NeoStrings, Network, NotifyUtils, Numeric, 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": "1.0.0-beta.7",
+  "version": "1.0.0-beta.9",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",