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

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+
+
+# 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`.

package/README.md

@@ -2,6 +2,10 @@
 
 This project contains the core functionality of the neo client library. 
 
+## Building
+
+Run `yarn dlx @yarnpkg/sdks vscode` to enable typescript for yarn in vscode.
+
 ## Testing
 
 To debug the tests, you need to add the following to .vscode\launch.json

package/dist/AppServices/AppService.d.ts

@@ -19,6 +19,7 @@ export declare class AppService implements IAppService, IAppServiceRegistration
      * @param symbol Strongly typed service identifier.
      */
     get<T>(symbol: ServiceIdentifier<T>): T;
+    tryGet<T>(symbolOrSid: ServiceIdentifier<T> | symbol): T | null;
     /**
      * Register a module
      * @param module The module
@@ -43,4 +44,8 @@ export interface IAppService {
      * @param symbol Strongly typed service identifier.
      */
     get<T>(symbol: ServiceIdentifier<T>): T;
+    /** Gets a service from the container if registered, else null. */
+    tryGet<T>(symbol: symbol): T | null;
+    /** Gets a service from the container if registered, else null. */
+    tryGet<T>(serviceIdentifier: ServiceIdentifier<T>): T | null;
 }

package/dist/AppServices/AppService.js

@@ -1,3 +1,4 @@
+import { ServiceIdentifier } from './ServiceIdentifier';
 import { NeoContainer } from './NeoContainer';
 var AppService = /** @class */ (function () {
     /**
@@ -12,6 +13,15 @@ var AppService = /** @class */ (function () {
     AppService.prototype.get = function (symbolOrSid) {
         return this.container.get(symbolOrSid);
     };
+    AppService.prototype.tryGet = function (symbolOrSid) {
+        var symbol = (symbolOrSid instanceof ServiceIdentifier) ? symbolOrSid.symbol : symbolOrSid;
+        if (this.container.isBound(symbol)) {
+            return this.container.get(symbol);
+        }
+        else {
+            return null;
+        }
+    };
     /**
      * Register a module
      * @param module The module

package/dist/AppServices/Config/ConfigService.js

@@ -3,7 +3,7 @@ import { injectable, inject } from 'inversify';
 import Axios from "axios";
 import NeoTypes from '../NeoTypes';
 import AxiosUtils from "../../AxiosUtils";
-export var ConfigService = /** @class */ (function () {
+var ConfigService = /** @class */ (function () {
     function ConfigService(config) {
         this.config = config;
     }
@@ -68,3 +68,4 @@ export var ConfigService = /** @class */ (function () {
     ], ConfigService);
     return ConfigService;
 }());
+export { ConfigService };

package/dist/AppServices/NeoTypes.d.ts

@@ -19,6 +19,7 @@ import { IContextMenuState } from '../Components/ContextMenu/ContextMenu';
 import { INavigationHelper } from '../Routing/INavigationHelper';
 import { ILoginErrorHandler } from '../Security/ILoginErrorHandler';
 import { IDecimalService } from "../Numeric";
+import { IServerMessageSubscriber } from "../SignalR/IServerMessageSubscriber";
 declare const NeoTypes: {
     Axios: ServiceIdentifier<import("axios").AxiosStatic>;
     Config: {
@@ -27,6 +28,7 @@ declare const NeoTypes: {
     };
     Core: {
         AutoRunnerFactory: ServiceIdentifier<IAutoRunnerFactory>;
+        /** @deprecated Use Messaging.ConnectionManager */
         ConnectionManager: ServiceIdentifier<IConnectionManager>;
         DecimalService: ServiceIdentifier<IDecimalService<import("../Numeric").IDecimal>>;
         ModelCreator: ServiceIdentifier<IModelCreatorBase>;
@@ -34,6 +36,10 @@ declare const NeoTypes: {
     Localisation: {
         LocalisationService: ServiceIdentifier<ILocalisationService>;
     };
+    Messaging: {
+        ConnectionManager: ServiceIdentifier<IConnectionManager>;
+        ServerMessageSubscriber: ServiceIdentifier<IServerMessageSubscriber>;
+    };
     Routing: {
         MenuItemProvider: ServiceIdentifier<IMenuItemProvider<import("../Routing").IMenuRoute>>;
         NavigationHelper: ServiceIdentifier<INavigationHelper>;

package/dist/AppServices/NeoTypes.js

@@ -1,4 +1,5 @@
 import { ServiceIdentifier } from './ServiceIdentifier';
+var connectionManagerType = new ServiceIdentifier("Neo.ConnectionManager");
 // Neo Module Type Symbols
 var NeoTypes = {
     Axios: new ServiceIdentifier("Neo.Axios"),
@@ -8,13 +9,18 @@ var NeoTypes = {
     },
     Core: {
         AutoRunnerFactory: new ServiceIdentifier("Neo.AutoRunnerFactory"),
-        ConnectionManager: new ServiceIdentifier("Neo.ConnectionManager"),
+        /** @deprecated Use Messaging.ConnectionManager */
+        ConnectionManager: connectionManagerType,
         DecimalService: new ServiceIdentifier("Neo.DecimalService"),
         ModelCreator: new ServiceIdentifier("Neo.ModelCreator")
     },
     Localisation: {
         LocalisationService: new ServiceIdentifier("Neo.Localisation")
     },
+    Messaging: {
+        ConnectionManager: connectionManagerType,
+        ServerMessageSubscriber: new ServiceIdentifier("Neo.ServerMessageSubscriber"),
+    },
     Routing: {
         MenuItemProvider: new ServiceIdentifier("Neo.MenuItemProvider"),
         NavigationHelper: new ServiceIdentifier("Neo.NavigationHelper"),

package/dist/AppServices/ServiceIdentifier.js

@@ -1,7 +1,7 @@
 /**
  * Strongly typed identifier for a service.
  */
-export var ServiceIdentifier = /** @class */ (function () {
+var ServiceIdentifier = /** @class */ (function () {
     /**
      * Creates a service identifier.
      * @param name Name used for debugging, not required to be unique.
@@ -36,3 +36,4 @@ export var ServiceIdentifier = /** @class */ (function () {
     ServiceIdentifier.typeNames = new Set();
     return ServiceIdentifier;
 }());
+export { ServiceIdentifier };

package/dist/AxiosUtils.js

@@ -13,7 +13,7 @@ var AxiosUtils = /** @class */ (function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
+                        _a.trys.push([0, 2, , 5]);
                         return [4 /*yield*/, request];
                     case 1:
                         waited = _a.sent();
@@ -23,22 +23,21 @@ var AxiosUtils = /** @class */ (function () {
                             }];
                     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*/];
+                        if (!isAxiosError(e_1)) return [3 /*break*/, 4];
+                        if (!(filter === undefined || filter(e_1.response))) return [3 /*break*/, 4];
+                        return [4 /*yield*/, this.readError(e_1)];
+                    case 3: return [2 /*return*/, _a.sent()];
+                    case 4: throw e_1;
+                    case 5: 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;
+            var _a, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0:

package/dist/Components/ErrorHandler.d.ts

@@ -39,11 +39,7 @@ export declare enum ErrorDisplayType {
 }
 export declare class ErrorHandler implements IErrorHandler {
     private notifications;
-    private blobType;
-    constructor(notifications: INotificationHelper, blobType?: {
-        new (blobParts?: BlobPart[] | undefined, options?: BlobPropertyBag | undefined): Blob;
-        prototype: Blob;
-    });
+    constructor(notifications: INotificationHelper);
     showError(error: any, displayType: ErrorDisplayType): Promise<void>;
     parseError(error: any): Promise<IErrorDisplay>;
     protected getAxiosError(error: AxiosError, response?: AxiosResponse): Promise<IErrorDisplay>;

package/dist/Components/ErrorHandler.js

@@ -14,11 +14,9 @@ export var ErrorDisplayType;
     /** Do nothing, error will be re-thrown. */
     ErrorDisplayType[ErrorDisplayType["ThrowError"] = 2] = "ThrowError";
 })(ErrorDisplayType || (ErrorDisplayType = {}));
-export var ErrorHandler = /** @class */ (function () {
-    function ErrorHandler(notifications, blobType) {
-        if (blobType === void 0) { blobType = Blob; }
+var ErrorHandler = /** @class */ (function () {
+    function ErrorHandler(notifications) {
         this.notifications = notifications;
-        this.blobType = blobType;
     }
     ErrorHandler.prototype.showError = function (error, displayType) {
         return __awaiter(this, void 0, void 0, function () {
@@ -120,9 +118,9 @@ export var ErrorHandler = /** @class */ (function () {
      * @param error Axios error.
      */
     ErrorHandler.prototype.parseAxiosError = function (header, body, error) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
             var errorDisplay, rawErrorData_1, errorData_1;
+            var _a;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -186,7 +184,8 @@ export var ErrorHandler = /** @class */ (function () {
     ErrorHandler = __decorate([
         injectable(),
         __param(0, inject(NeoTypes.UI.GlobalNotifications.symbol)),
-        __metadata("design:paramtypes", [Object, Object])
+        __metadata("design:paramtypes", [Object])
     ], ErrorHandler);
     return ErrorHandler;
 }());
+export { ErrorHandler };

package/dist/Components/FileManager/FileManager.js

@@ -9,7 +9,7 @@ import { Settings } from '../../Settings';
 import { FileUploadBatch } from './FileUploadBatch';
 import NeoStrings from '../../Localisation/NeoStrings';
 var fileInputSymbol = Symbol("FileInput");
-export var FileManagerBase = /** @class */ (function () {
+var FileManagerBase = /** @class */ (function () {
     function FileManagerBase(uploadEndpointOrOptions, options) {
         this.currentUploads = [];
         if (uploadEndpointOrOptions === undefined || typeof uploadEndpointOrOptions === "string") {
@@ -97,9 +97,9 @@ export var FileManagerBase = /** @class */ (function () {
     /**
      * Checks if file extensions are allowed, then calls onFilesSelected, or uploadFiles
      */
-    FileManagerBase.prototype.processFiles = function (files, options) {
-        if (options === void 0) { options = {}; }
-        return __awaiter(this, void 0, void 0, function () {
+    FileManagerBase.prototype.processFiles = function (files_1) {
+        return __awaiter(this, arguments, void 0, function (files, options) {
+            if (options === void 0) { options = {}; }
             return __generator(this, function (_a) {
                 if (files.length > 1 && !this.allowMultiple) {
                     files = [Array.from(files)[0]];
@@ -252,6 +252,7 @@ export var FileManagerBase = /** @class */ (function () {
     ], FileManagerBase.prototype, "currentUploads", void 0);
     return FileManagerBase;
 }());
+export { FileManagerBase };
 var FileManager = /** @class */ (function (_super) {
     __extends(FileManager, _super);
     function FileManager() {

package/dist/Components/FileManager/FileUploadBatch.js

@@ -2,7 +2,7 @@ import { __decorate, __metadata } from "tslib";
 import { Utils } from "../../Utils";
 import NeoModel from "../../Model/NeoModel";
 import { Observable } from "../../Model/Decorators";
-export var FileUploadBatch = /** @class */ (function () {
+var FileUploadBatch = /** @class */ (function () {
     function FileUploadBatch(files) {
         this.recordIndex = {};
         this.key = Utils.uuidv4();
@@ -81,3 +81,4 @@ export var FileUploadBatch = /** @class */ (function () {
     ], FileUploadBatch);
     return FileUploadBatch;
 }());
+export { FileUploadBatch };

package/dist/Components/Notifications/Notification.js

@@ -2,7 +2,7 @@ import { __decorate, __metadata } from "tslib";
 import { Utils } from "../../Utils";
 import { Observable } from '../../Model/Decorators';
 import NeoModel from '../../Model/NeoModel';
-export var Notification = /** @class */ (function () {
+var Notification = /** @class */ (function () {
     function Notification(options, body) {
         this.options = options;
         this.body = body;
@@ -24,3 +24,4 @@ export var Notification = /** @class */ (function () {
     ], Notification);
     return Notification;
 }());
+export { Notification };

package/dist/Components/Notifications/NotificationHelper.js

@@ -3,7 +3,7 @@ import { Globals } from '../../Misc';
 import NeoTypes from '../../AppServices/NeoTypes';
 import { ModalUtils } from '../Modal/ModalUtils';
 import { injectable, inject } from 'inversify';
-export var NotificationHelper = /** @class */ (function () {
+var NotificationHelper = /** @class */ (function () {
     /**
      * Creates a new notification helper which can be bound to a ToastContainer / other alert ui component.
      * @param store Optional store which contains the notification message objects.
@@ -109,3 +109,4 @@ export var NotificationHelper = /** @class */ (function () {
     ], NotificationHelper);
     return NotificationHelper;
 }());
+export { NotificationHelper };

package/dist/Components/Notifications/NotificationStore.js

@@ -4,7 +4,7 @@ import { Notification } from './Notification';
 import { Observable } from '../../Model/Decorators';
 import NeoModel from '../../Model/NeoModel';
 import { injectable } from 'inversify';
-export var NotificationStore = /** @class */ (function () {
+var NotificationStore = /** @class */ (function () {
     function NotificationStore() {
         this.notifications = [];
     }
@@ -76,3 +76,4 @@ export var NotificationStore = /** @class */ (function () {
     ], NotificationStore);
     return NotificationStore;
 }());
+export { NotificationStore };

package/dist/Components/TaskRunner/ProgressState.js

@@ -1,7 +1,7 @@
 import { __decorate, __metadata } from "tslib";
 import NeoModel from '../../Model/NeoModel';
 import { Observable } from '../../Model/Decorators';
-export var ProgressState = /** @class */ (function () {
+var ProgressState = /** @class */ (function () {
     function ProgressState() {
         this._progress = 0;
         /** Animation state used by UI components. */
@@ -69,3 +69,4 @@ export var ProgressState = /** @class */ (function () {
     ], ProgressState);
     return ProgressState;
 }());
+export { ProgressState };

package/dist/Components/TaskRunner/TaskRunner.js

@@ -6,7 +6,7 @@ import { injectable, inject } from 'inversify';
 import { ErrorDisplayType } from '../ErrorHandler';
 import { NeoTypes } from '../../AppServices';
 import { ProgressState } from './ProgressState';
-export var TaskRunnerOptions = /** @class */ (function () {
+var TaskRunnerOptions = /** @class */ (function () {
     function TaskRunnerOptions(taskRunner) {
         this.taskRunner = taskRunner;
         /** Specifies how the task runner must handle errors that are raised by your code. */
@@ -42,6 +42,7 @@ export var TaskRunnerOptions = /** @class */ (function () {
     ], TaskRunnerOptions);
     return TaskRunnerOptions;
 }());
+export { TaskRunnerOptions };
 var WaitForTaskRunnerOptions = /** @class */ (function (_super) {
     __extends(WaitForTaskRunnerOptions, _super);
     function WaitForTaskRunnerOptions() {

package/dist/ConnectionManager.js

@@ -25,7 +25,7 @@ var ConnectionInfo = /** @class */ (function () {
     return ConnectionInfo;
 }());
 export { ConnectionInfo };
-export var ConnectionManager = /** @class */ (function () {
+var ConnectionManager = /** @class */ (function () {
     function ConnectionManager() {
         this._connections = new Map();
     }
@@ -58,3 +58,4 @@ export var ConnectionManager = /** @class */ (function () {
     ], ConnectionManager);
     return ConnectionManager;
 }());
+export { ConnectionManager };

package/dist/Data/ApiDataSource.d.ts

@@ -1,15 +1,9 @@
 import { AsyncDataSource, IAsyncDataSource } from './AsyncDataSource';
 import { AxiosPromise } from 'axios';
-import List from '../Model/List';
+import { PlainObject, IBindableBase } from "../Model/IModelBase";
+import { IDbSet } from "../IndexDb/IDbSet";
 export interface IApiDataSource<T> extends IAsyncDataSource<T> {
 }
-export declare class CallbackDataSource<T> extends AsyncDataSource<T> {
-    private callBack;
-    private defaultData;
-    constructor(callBack: () => Promise<any>, defaultData: T);
-    protected getDataAsync(): Promise<any>;
-    copy(): IAsyncDataSource<T>;
-}
 /**
  * Allows an api endpoint to be used directly by a consumer such as a drop down element.
  * If you need the data to be deserialised into a specific lookup model, use ApiClientLookupDataSource.
@@ -19,28 +13,33 @@ export declare class ApiClientDataSource<T> extends AsyncDataSource<T> implement
     private defaultData?;
     constructor(getMethod: () => AxiosPromise<T>, defaultData?: T | undefined);
     protected getDataAsync(): Promise<T>;
-    /** Provides a copy of this datasource, without any data. */
-    copy(): ApiClientDataSource<T>;
+}
+export declare abstract class ConvertingApiClientDataSource<T> extends AsyncDataSource<T> implements IApiDataSource<T> {
+    protected getMethod: () => AxiosPromise<any>;
+    private supportOffline;
+    constructor(getMethod: () => AxiosPromise<any>, defaultData: T, supportOffline: boolean);
+    protected abstract convertData(rawData: any): T;
+    protected abstract offlineGet(): Promise<any>;
+    protected abstract offlineStore(data: any): Promise<void>;
+    protected getDataAsync(): Promise<T>;
 }
 /**
  * Allows an api endpoint to be used directly by a consumer such as a drop down element.
  * Deserialises the json data returned by the api into a list of the specified lookup object.
  */
-export declare class ApiClientLookupDataSource<T> extends AsyncDataSource<T[]> implements IApiDataSource<T[]> {
-    private getMethod;
-    private deserialiseType?;
-    private defaultData?;
-    constructor(getMethod: () => AxiosPromise<any>, deserialiseType?: (new () => T) | undefined, defaultData?: T[] | undefined);
-    protected getDataAsync(): Promise<List<T>>;
-    /** Provides a copy of this datasource, without any data. */
-    copy(): ApiClientLookupDataSource<T>;
+export declare class ApiClientLookupDataSource<T extends IBindableBase> extends ConvertingApiClientDataSource<T[]> {
+    private deserialiseType;
+    private dbSet?;
+    constructor(getMethod: () => AxiosPromise<PlainObject<T>[]>, deserialiseType: (new () => T), defaultData?: T[], dbSet?: IDbSet<import("../Model/IModelBase").PlainObject<Exclude<keyof T, keyof import("../Model/IModelBase").IModelBase> & { [P_1 in keyof T]: T[P_1] extends Function ? never : P_1; }[keyof T] extends infer T_1 extends keyof T ? { [P in T_1]: T[P]; } : never>> | undefined);
+    protected offlineGet(): Promise<any>;
+    protected offlineStore(rawData: any): Promise<void>;
+    protected convertData(rawData: any): T[];
 }
-export declare class ApiDataSource<T> extends AsyncDataSource<T> implements IApiDataSource<T> {
-    private apiEndpoint;
-    private defaultData;
-    private axiosInstance;
-    constructor(apiEndpoint: string, defaultData: T, axiosInstance?: import("axios").AxiosStatic);
-    protected getDataAsync(): Promise<any>;
-    /** Provides a copy of this datasource, without any data. */
-    copy(): ApiDataSource<T>;
+export declare class ApiClientSingleLookupDataSource<T extends IBindableBase> extends ConvertingApiClientDataSource<T> {
+    private deserialiseType;
+    private dbSet?;
+    constructor(getMethod: () => AxiosPromise<PlainObject<T>>, deserialiseType: (new () => T), defaultData?: T, dbSet?: IDbSet<import("../Model/IModelBase").PlainObject<Exclude<keyof T, keyof import("../Model/IModelBase").IModelBase> & { [P_1 in keyof T]: T[P_1] extends Function ? never : P_1; }[keyof T] extends infer T_1 extends keyof T ? { [P in T_1]: T[P]; } : never>> | undefined);
+    protected offlineGet(): Promise<any>;
+    protected offlineStore(rawData: any): Promise<void>;
+    protected convertData(rawData: any): T;
 }