@finsemble/finsemble-core 6.1.4 → 6.1.5

package/package.json

@@ -2,7 +2,7 @@
   "name": "@finsemble/finsemble-core",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
-  "version": "6.1.4",
+  "version": "6.1.5",
   "description": "Finsemble is an application framework providing infrastructure, services, and components for quickly building HTML5 multi-window financial desktop applications.",
   "scripts": {
     "do-audit": " improved-yarn-audit --min-severity high",

package/tsconfig.json

@@ -1,23 +1,23 @@
-{
-	"compilerOptions": {
-		"allowJs": false,
-		"allowSyntheticDefaultImports": true,
-		"emitDecoratorMetadata": true,
-		"esModuleInterop": true,
-		"experimentalDecorators": true,
-		"jsx": "react",
-		"module": "commonjs",
-		"lib": ["dom", "dom.iterable", "ES2020"],
-		"resolveJsonModule": true,
-		"target": "ES2020",
-		"noImplicitAny": false,
-		"strict": true
-	},
-	"include": ["src/**/*"],
-	"ts-node": {
-		"transpileOnly": true,
-		"compilerOptions": {
-			"target": "ES2017"
-		}
-	}
-}
+{
+	"compilerOptions": {
+		"allowJs": false,
+		"allowSyntheticDefaultImports": true,
+		"emitDecoratorMetadata": true,
+		"esModuleInterop": true,
+		"experimentalDecorators": true,
+		"jsx": "react",
+		"module": "commonjs",
+		"lib": ["dom", "dom.iterable", "ES2020"],
+		"resolveJsonModule": true,
+		"target": "ES2020",
+		"noImplicitAny": false,
+		"strict": true
+	},
+	"include": ["src/**/*"],
+	"ts-node": {
+		"transpileOnly": true,
+		"compilerOptions": {
+			"target": "ES2017"
+		}
+	}
+}

package/types/index.d.ts

@@ -6548,15 +6548,9 @@ declare module "common/workspace" {
     };
     /**
      * The data representation of the active workspace.
-     * Identical to the Workspace type, with the addition
-     * of the `guid` property.
+     * KW: Currently identical to the Workspace type after removal of the guid property
      */
-    export type ActiveWorkspace = Workspace & {
-        /** A string uniquely identifying this active workspace instance from
-         * all others.
-         */
-        guid: string;
-    };
+    export type ActiveWorkspace = Workspace;
 }
 declare module "common/events/PrivateFinsembleEvent" {
     class PrivateFinsembleEvent {
@@ -7514,32 +7508,6 @@ declare module "clients/storageClient" {
             key: string;
             topic: string;
         }, cb?: StandardCallback<string | Error, T>): Promise<T>;
-        /**
-         * Asynchronously updates provided key in storage by first retrieving the key
-         * then running a provided function on the result and re-saving its value.
-         * There’s no guarantees of consistency or atomicity
-         *
-         * @param params {any} Update storage params
-         * @param params.topic {string} The storage topic
-         * @param params.key {string} The storage key
-         * @param params.updateFn {Function} Function to run to determine the value to store
-         * @private
-         */
-        updateStorage(params: {
-            topic: string;
-            key: string;
-            updateFn: (x: any) => any;
-        }): Promise<unknown>;
-        /**
-         *
-         * @param params
-         * @private
-         */
-        updateStorage1(params: {
-            topic: string;
-            key: string;
-            updateFn: (x: any) => any;
-        }): Promise<unknown>;
         /**
          * Get all keys for the topic.
          * @param {Object} params
@@ -7637,6 +7605,31 @@ declare module "common/windowStorageManager" {
          */
         static _SC: import("clients/storageClient").StorageClient;
         static getWindowID: (win: FinsembleWindowData) => string;
+        /**
+         * Asynchronously updates provided key in storage by first retrieving the key
+         * then running a provided function on the result and re-saving its value.
+         * There’s no guarantees of consistency or atomicity
+         *
+         * @param params {any} Update storage params
+         * @param params.topic {string} The storage topic
+         * @param params.key {string} The storage key
+         * @param params.updateFn {Function} Function to run to determine the value to store
+         * @private
+         */
+        static updateStorage(params: {
+            topic: string;
+            key: string;
+            updateFn: (x: any) => any;
+        }): Promise<unknown>;
+        /**
+         * Rate limited updateStorage.
+         * @private
+         */
+        static updateStorage1(params: {
+            topic: string;
+            key: string;
+            updateFn: (x: any) => any;
+        }): Promise<unknown>;
         /**
          * Given a type, window, and workspace name, returns the correct storage topic and key
          * for the `windowData` or `componentState`.
@@ -7763,24 +7756,6 @@ declare module "clients/workspaceClient" {
         activeWorkspace: ActiveWorkspace | undefined;
         constructor(params: any);
         private _serviceResponseHandler;
-        /**
-         * Saves Data Globally to the Active Workspace (e.g. ComponentState, WindowList etc.)
-         * @param {object} params
-         * @param {string} params.field
-         * @param {object} params.value
-         * @param {FinsembleCallbackFunction} cb
-         */
-        private saveGlobalData;
-        /**
-         * Saves View Specific Data (e.g. ComponentState, WindowList etc.) to the Currently Active Workspace View or all Views
-         * When a window state changes, on
-         * @param {object} params
-         * @param {string} params.field
-         * @param {object} params.value
-         * @param {boolean} params.saveToAllViews
-         * @param {FinsembleCallbackFunction} cb
-         */
-        private saveViewData;
         /**
          * This provides the ability to listen to workspace events.
          * The load-requested event provides a way to merge data into the workspace prior to loading.
@@ -7897,10 +7872,19 @@ declare module "clients/workspaceClient" {
          */
         getWorkspaceActions(cb?: any): any;
         /**
-         * @private
-         *
          * Returns a list of workspace names
          *
+         * @example <caption>This function returns the list of all the workspace.</caption>
+         * FSBL.Clients.WorkspaceClient.getWorkspaceNames((err, response) => {
+         *   console.log(JSON.stringify(response, null, 2));
+         * });
+         *
+         * Output:
+         * [
+         *   "Default Workspace",
+         *   "Another workspace"
+         * ]
+         *
          * @param {function} cb The callback to be invoked after the method completes successfully.
          */
         getWorkspaceNames(cb?: any): Promise<unknown>;
@@ -8154,11 +8138,12 @@ declare module "clients/workspaceClient" {
         }) => void;
         /**
          * Initializes listeners and sets default data on the WorkspaceClient object.
+         *
          * @private
          */
         start(cb: any): Promise<void>;
     }
-    var workspaceClient: WorkspaceClient;
+    let workspaceClient: WorkspaceClient;
     export default workspaceClient;
 }
 declare module "services/window/Launcher/WrapManager" {

package/types/index.tsbuildinfo

@@ -1 +1 @@
-{"bundle":{"commonSourceDirectory":"../src","sourceFiles":["../src/typedefs/FDC3/api/AppMetadata.ts","../src/typedefs/FDC3/api/IntentMetadata.ts","../src/typedefs/FDC3/api/AppIntent.ts","../src/typedefs/FDC3/context/ContextTypes.ts","../src/typedefs/FDC3/api/Types.ts","../src/typedefs/FDC3/api/DisplayMetadata.ts","../src/typedefs/FDC3/api/Listener.ts","../src/typedefs/FDC3/api/Channel.ts","../src/typedefs/FDC3/api/IntentResolution.ts","../src/typedefs/FDC3/api/ImplementationMetadata.ts","../src/typedefs/FDC3/api/DesktopAgent.ts","../src/typedefs/FDC3/api/Errors.ts","../src/typedefs/FDC3/api/Methods.ts","../src/typedefs/FDC3/context/ContextType.ts","../src/typedefs/FDC3/intents/Intents.ts","../src/typedefs/FDC3/index.ts","../src/services/window/Common/types.ts","../src/common/redux/actionIdMapper.ts","../src/services/Interop/types.ts","../src/clients/Interop/types.ts","../src/clients/IRouterClient.ts","../src/clients/Startup/types.ts","../src/fin.ts","../src/common/Globals.ts","../src/common/Singleton.ts","../src/clients/Startup/Startup.ts","../src/common/system.ts","../src/clients/ILogger.ts","../src/clients/ICentralLogger.ts","../src/clients/localLogger.ts","../src/clients/logger.ts","../src/common/routerTransport.ts","../src/clients/routerClientConstructor.ts","../src/clients/routerClientInstance.ts","../src/common/util.ts","../src/common/constants.ts","../src/common/events/FinsembleEvent.ts","../src/common/events/PublicEventManager.ts","../src/common/disentangledUtils.ts","../src/common/window/FinsembleView.ts","../src/common/window/FinsembleWindow.ts","../src/clients/Interop/InteropAdmin.ts","../src/common/redux/types.ts","../src/common/redux/remoteReduxEnhancer.ts","../src/common/redux/createReducer.ts","../src/common/redux/index.ts","../src/services/systemManager/_types.ts","../src/services/systemManager/_constants.ts","../src/services/systemManager/common.ts","../src/common/systemManagerClient.ts","../src/common/dependencyManager.ts","../src/clients/baseClient.ts","../src/clients/configClient.ts","../src/common/FinsembleWindowData.ts","../src/common/workspace.ts","../src/common/events/PrivateFinsembleEvent.ts","../src/common/events/PrivateEventManager.ts","../src/clients/StoreModel.ts","../src/clients/distributedStoreClient.ts","../src/services/window/WindowAbstractions/BaseWindow.ts","../src/clients/storageClient.ts","../src/common/windowStorageManager.ts","../src/clients/workspaceClient.ts","../src/services/window/Launcher/WrapManager.ts","../src/services/window/Common/Pools/ObjectPool.ts","../src/services/window/Common/Pools/WindowPool.ts","../src/services/window/Common/Pools/PoolSingletons.ts","../src/services/window/Splintering/SplinterAgentSlave.ts","../src/services/window/Common/publishWrapState.ts","../src/services/window/Launcher/createSplinterAndInject.ts","../src/services/window/Launcher/LauncherDefaults.ts","../src/services/window/Common/spawnUtils.ts","../src/services/window/Launcher/componentConfigUtils.ts","../src/services/window/Launcher/launcher.ts","../src/clients/authenticationClient.ts","../src/clients/hotkeysClient.ts","../src/clients/windowClient.ts","../src/clients/launcherClient.ts","../src/clients/linkerClient.ts","../src/clients/dragAndDropClient.ts","../src/clients/dialogManagerClient.ts","../src/clients/searchClient.ts","../src/common/notifications/definitions/IFilter.ts","../src/common/notifications/definitions/IAction.ts","../src/common/notifications/definitions/IPerformedAction.ts","../src/common/notifications/definitions/Meta.ts","../src/common/notifications/definitions/INotification.ts","../src/common/notifications/definitions/ISubscription.ts","../src/common/notifications/definitions/IMuteFilter.ts","../src/common/notifications/definitions/Callbacks.ts","../src/common/notifications/definitions/INotificationHistoryOptions.ts","../src/common/notifications/definitions/INotificationClient.ts","../src/common/notifications/definitions/ActionTypes.ts","../src/common/notifications/definitions/Notification.ts","../src/common/notifications/definitions/Subscription.ts","../src/common/notifications/definitions/Action.ts","../src/common/notifications/definitions/Filter.ts","../src/clients/notificationClient.ts","../src/clients/smartDesktopClient.ts","../src/index.ts"],"dts":{"sections":[{"pos":0,"end":30,"kind":"type","data":"node"},{"pos":32,"end":577935,"kind":"text"}]}},"version":"4.3.5"}
+{"bundle":{"commonSourceDirectory":"../src","sourceFiles":["../src/typedefs/FDC3/api/AppMetadata.ts","../src/typedefs/FDC3/api/IntentMetadata.ts","../src/typedefs/FDC3/api/AppIntent.ts","../src/typedefs/FDC3/context/ContextTypes.ts","../src/typedefs/FDC3/api/Types.ts","../src/typedefs/FDC3/api/DisplayMetadata.ts","../src/typedefs/FDC3/api/Listener.ts","../src/typedefs/FDC3/api/Channel.ts","../src/typedefs/FDC3/api/IntentResolution.ts","../src/typedefs/FDC3/api/ImplementationMetadata.ts","../src/typedefs/FDC3/api/DesktopAgent.ts","../src/typedefs/FDC3/api/Errors.ts","../src/typedefs/FDC3/api/Methods.ts","../src/typedefs/FDC3/context/ContextType.ts","../src/typedefs/FDC3/intents/Intents.ts","../src/typedefs/FDC3/index.ts","../src/services/window/Common/types.ts","../src/common/redux/actionIdMapper.ts","../src/services/Interop/types.ts","../src/clients/Interop/types.ts","../src/clients/IRouterClient.ts","../src/clients/Startup/types.ts","../src/fin.ts","../src/common/Globals.ts","../src/common/Singleton.ts","../src/clients/Startup/Startup.ts","../src/common/system.ts","../src/clients/ILogger.ts","../src/clients/ICentralLogger.ts","../src/clients/localLogger.ts","../src/clients/logger.ts","../src/common/routerTransport.ts","../src/clients/routerClientConstructor.ts","../src/clients/routerClientInstance.ts","../src/common/util.ts","../src/common/constants.ts","../src/common/events/FinsembleEvent.ts","../src/common/events/PublicEventManager.ts","../src/common/disentangledUtils.ts","../src/common/window/FinsembleView.ts","../src/common/window/FinsembleWindow.ts","../src/clients/Interop/InteropAdmin.ts","../src/common/redux/types.ts","../src/common/redux/remoteReduxEnhancer.ts","../src/common/redux/createReducer.ts","../src/common/redux/index.ts","../src/services/systemManager/_types.ts","../src/services/systemManager/_constants.ts","../src/services/systemManager/common.ts","../src/common/systemManagerClient.ts","../src/common/dependencyManager.ts","../src/clients/baseClient.ts","../src/clients/configClient.ts","../src/common/FinsembleWindowData.ts","../src/common/workspace.ts","../src/common/events/PrivateFinsembleEvent.ts","../src/common/events/PrivateEventManager.ts","../src/clients/StoreModel.ts","../src/clients/distributedStoreClient.ts","../src/services/window/WindowAbstractions/BaseWindow.ts","../src/clients/storageClient.ts","../src/common/windowStorageManager.ts","../src/clients/workspaceClient.ts","../src/services/window/Launcher/WrapManager.ts","../src/services/window/Common/Pools/ObjectPool.ts","../src/services/window/Common/Pools/WindowPool.ts","../src/services/window/Common/Pools/PoolSingletons.ts","../src/services/window/Splintering/SplinterAgentSlave.ts","../src/services/window/Common/publishWrapState.ts","../src/services/window/Launcher/createSplinterAndInject.ts","../src/services/window/Launcher/LauncherDefaults.ts","../src/services/window/Common/spawnUtils.ts","../src/services/window/Launcher/componentConfigUtils.ts","../src/services/window/Launcher/launcher.ts","../src/clients/authenticationClient.ts","../src/clients/hotkeysClient.ts","../src/clients/windowClient.ts","../src/clients/launcherClient.ts","../src/clients/linkerClient.ts","../src/clients/dragAndDropClient.ts","../src/clients/dialogManagerClient.ts","../src/clients/searchClient.ts","../src/common/notifications/definitions/IFilter.ts","../src/common/notifications/definitions/IAction.ts","../src/common/notifications/definitions/IPerformedAction.ts","../src/common/notifications/definitions/Meta.ts","../src/common/notifications/definitions/INotification.ts","../src/common/notifications/definitions/ISubscription.ts","../src/common/notifications/definitions/IMuteFilter.ts","../src/common/notifications/definitions/Callbacks.ts","../src/common/notifications/definitions/INotificationHistoryOptions.ts","../src/common/notifications/definitions/INotificationClient.ts","../src/common/notifications/definitions/ActionTypes.ts","../src/common/notifications/definitions/Notification.ts","../src/common/notifications/definitions/Subscription.ts","../src/common/notifications/definitions/Action.ts","../src/common/notifications/definitions/Filter.ts","../src/clients/notificationClient.ts","../src/clients/smartDesktopClient.ts","../src/index.ts"],"dts":{"sections":[{"pos":0,"end":30,"kind":"type","data":"node"},{"pos":32,"end":577402,"kind":"text"}]}},"version":"4.3.5"}

package/types.tsconfig.json

@@ -1,15 +1,15 @@
-{
-	"compilerOptions": {
-		"declaration": true,
-		"lib": ["dom", "es2015", "es2016.array.include", "dom.iterable", "es2017"],
-		"incremental": true,
-		"module": "commonjs",
-		"experimentalDecorators": true,
-		"emitDecoratorMetadata": true,
-		"emitDeclarationOnly": true,
-		"esModuleInterop": true,
-		"outFile": "./types/index",
-		"target": "ES2020"
-	},
-	"include": ["src/index.ts"]
-}
+{
+	"compilerOptions": {
+		"declaration": true,
+		"lib": ["dom", "es2015", "es2016.array.include", "dom.iterable", "es2017"],
+		"incremental": true,
+		"module": "commonjs",
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+		"emitDeclarationOnly": true,
+		"esModuleInterop": true,
+		"outFile": "./types/index",
+		"target": "ES2020"
+	},
+	"include": ["src/index.ts"]
+}