@finsemble/finsemble-ui 1.0.0-beta-5 → 1.0.0-beta-9

package/common/constants.d.ts

@@ -0,0 +1,106 @@
+export declare const WRAPPERS: {
+    EVENTS: string[];
+};
+export declare const APPLICATION_STATE_CHANNEL = "Finsemble.Application.State";
+export declare const SERVICE_INITIALIZING_CHANNEL = "Finsemble.ServiceManager.serviceInitializing";
+export declare const SERVICE_READY_CHANNEL = "Finsemble.ServiceManager.serviceReady";
+export declare const SERVICE_CLOSING_CHANNEL = "Finsemble.ServiceManager.serviceClosing";
+export declare const SERVICE_CLOSED_CHANNEL = "Finsemble.ServiceManager.serviceClosed";
+export declare const SERVICE_QUERY_READY_CHANNEL: (name: string) => string;
+export declare const CLIENT_SERVER_MAPPING: (name: string) => string;
+export declare const SERVICES_STATE_CHANNEL = "Finsemble.State.Services";
+export declare enum WINDOWSTATE {
+    NORMAL = 0,
+    MINIMIZED_WAS_NORMAL = 1,
+    MAXIMIZED = 2,
+    MINIMIZED_WAS_MAXIMIZED = 3,
+    TRANSITIONING = 4
+}
+export declare const SERVICE_START_CHANNEL = "Finsemble.Service.Start";
+export declare const SERVICE_STOP_CHANNEL = "Finsemble.Service.Stop";
+export declare const DOCKING: {
+    GROUP_UPDATE: string;
+    WORKSPACE_GROUP_UPDATE: string;
+    REQUEST_PUBLISH: string;
+};
+export declare const EVENT_INTERRUPT_CHANNEL = "Finsemble.Event.Interrupt";
+export declare const INTERRUPTIBLE_EVENTS: string[];
+export declare const WINDOW: {
+    DELAYABLE_EVENTS: string[];
+    CANCELABLE_EVENTS: string[];
+};
+export declare const WORKSPACE: {
+    DELAYABLE_EVENTS: string[];
+    CANCELABLE_EVENTS: string[];
+    CLEAN_SHUTDOWN: string;
+    UPDATE_PUBSUB: string;
+    STORAGE_TOPIC: string;
+    CACHE_STORAGE_TOPIC: string;
+    ALL_WORKSPACES: string;
+    ACTIVE_WORKSPACE: string;
+    LAST_USED_WORKSPACE_TOPIC: string;
+    LAST_USED_WORKSPACE_NAME: string;
+    LAST_USED_WORKSPACE: string;
+    INITIAL_WORKSPACE_PREFERENCE: string;
+    PUBLISH_REASONS: {
+        INIT: string;
+        LOAD_DATA_RETRIEVED: string;
+        LOAD_FINISHED: string;
+        WINDOW_REMOVED: string;
+        WINDOW_ADDED: string;
+        LOAD_STARTED: string;
+        WORKSPACE_REMOVED: string;
+        WORKSPACE_RENAMED: string;
+        SWITCHTO_TERMINATED: string;
+        NEW_WORKSPACE: string;
+        SAVE_AS: string;
+    };
+    API_CHANNELS: {
+        NEW_WORKSPACE: string;
+        SAVE: string;
+        RENAME: string;
+        SAVE_AS: string;
+        SWITCH_TO: string;
+        IMPORT: string;
+        EXPORT: string;
+        REMOVE: string;
+        SAVE_GLOBAL_DATA: string;
+        SAVE_VIEW_DATA: string;
+        GET_GLOBAL_DATA: string;
+        GET_VIEW_DATA: string;
+        GET_WORKSPACES: string;
+        GET_WORKSPACE_NAMES: string;
+        SET_WORKSPACE_ORDER: string;
+        GET_ACTIVE_WORKSPACE: string;
+        GET_ACTIVE_WORKSPACE_DIRTY: string;
+        GET_TEMPLATES: string;
+        IMPORT_TEMPLATE: string;
+        EXPORT_TEMPLATE: string;
+        REMOVE_TEMPLATE: string;
+        SET_WINDOW_STATE: string;
+        GET_WINDOW_STATE: string;
+        ADD_WINDOW: string;
+        REMOVE_WINDOW: string;
+    };
+    DEFAULT_WINDOW_PROPS: string[];
+    ADDITIONAL_WINDOW_PROPS: {
+        WebWindow: string[];
+        NativeWindow: string[];
+        StackedWindow: string[];
+    };
+};
+export declare const WINDOW_SERVICE_REQUESTS: {
+    REMOTE_FOCUS: string;
+    SET_ALWAYS_ON_TOP: string;
+    IS_ALWAYS_ON_TOP: string;
+};
+export declare const COMPONENT_STATE_STORAGE_TOPIC = "finsemble.componentStateStorage";
+export declare const HEARTBEAT_TIMEOUT_CHANNEL = "Finsemble.WindowService.HeartbeatTimeout";
+export declare const LAUNCHER_SERVICE: {
+    WINDOW_CLOSED: string;
+};
+export declare const MOVE_REASON: {
+    AERO_KEY: string;
+    SYSTEM_RESTORED: string;
+};
+//# sourceMappingURL=constants.d.ts.map

package/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ;;CAEpB,CAAC;AACF,eAAO,MAAM,yBAAyB,gCAAgC,CAAC;AAGvE,eAAO,MAAM,4BAA4B,iDAAiD,CAAC;AAC3F,eAAO,MAAM,qBAAqB,0CAA0C,CAAC;AAC7E,eAAO,MAAM,uBAAuB,4CAA4C,CAAC;AACjF,eAAO,MAAM,sBAAsB,2CAA2C,CAAC;AAI/E,eAAO,MAAM,2BAA2B,SAAU,MAAM,WAAkD,CAAC;AAE3G,eAAO,MAAM,qBAAqB,SAAU,MAAM,WAejD,CAAC;AAGF,eAAO,MAAM,sBAAsB,6BAA6B,CAAC;AACjE,oBAAY,WAAW;IACtB,MAAM,IAAI;IACV,oBAAoB,IAAI;IACxB,SAAS,IAAI;IACb,uBAAuB,IAAI;IAC3B,aAAa,IAAI;CACjB;AAED,eAAO,MAAM,qBAAqB,4BAA4B,CAAC;AAC/D,eAAO,MAAM,oBAAoB,2BAA2B,CAAC;AAE7D,eAAO,MAAM,OAAO;;;;CAKnB,CAAC;AAGF,eAAO,MAAM,uBAAuB,8BAA8B,CAAC;AACnE,eAAO,MAAM,oBAAoB,UAA+E,CAAC;AAEjH,eAAO,MAAM,MAAM;;;CAGlB,CAAC;AAEF,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+GrB,CAAC;AAEF,eAAO,MAAM,uBAAuB;;;;CAInC,CAAC;AAEF,eAAO,MAAM,6BAA6B,oCAAoC,CAAC;AAE/E,eAAO,MAAM,yBAAyB,6CAA6C,CAAC;AAEpF,eAAO,MAAM,gBAAgB;;CAE5B,CAAC;AAEF,eAAO,MAAM,WAAW;;;CAGvB,CAAC"}

package/common/constants.js

@@ -0,0 +1,181 @@
+export const WRAPPERS = {
+    EVENTS: ["title-changed", "bringToFront", "setBounds", "alwaysOnTop", "setOpacity"],
+};
+export const APPLICATION_STATE_CHANNEL = "Finsemble.Application.State";
+// These next four channels are used in service => service manager communication. The SM receives these messages and then pushes out state updates to the rest of the system.
+export const SERVICE_INITIALIZING_CHANNEL = "Finsemble.ServiceManager.serviceInitializing";
+export const SERVICE_READY_CHANNEL = "Finsemble.ServiceManager.serviceReady";
+export const SERVICE_CLOSING_CHANNEL = "Finsemble.ServiceManager.serviceClosing";
+export const SERVICE_CLOSED_CHANNEL = "Finsemble.ServiceManager.serviceClosed";
+// Naming to supports handshake betwwen each client and its corresponding service
+// Returns the handshake channel for a given service name
+export const SERVICE_QUERY_READY_CHANNEL = (name) => `Finsemble.ServiceManager.queryReady.${name}`;
+// Maps a client name to its corresponding service name.  Okay to not include all clients here -- if not here then handshake won't be done
+export const CLIENT_SERVER_MAPPING = (name) => {
+    const MAPPING = {
+        authenticationClient: "authenticationService",
+        configClient: "configService",
+        distributedStoreClient: "dataStoreService",
+        hotkeyClient: "hotkeysService",
+        linkerClient: "linkerService",
+        logger: "loggerService",
+        searchClient: "searchService",
+        storageClient: "storageService",
+        windowClient: "windowService",
+        workspaceClient: "workspaceService",
+    };
+    // returns undefined if there is no mapping
+    return MAPPING[name];
+};
+// This channel is where the aggregated state of all services is sent out on.
+export const SERVICES_STATE_CHANNEL = "Finsemble.State.Services";
+export var WINDOWSTATE;
+(function (WINDOWSTATE) {
+    WINDOWSTATE[WINDOWSTATE["NORMAL"] = 0] = "NORMAL";
+    WINDOWSTATE[WINDOWSTATE["MINIMIZED_WAS_NORMAL"] = 1] = "MINIMIZED_WAS_NORMAL";
+    WINDOWSTATE[WINDOWSTATE["MAXIMIZED"] = 2] = "MAXIMIZED";
+    WINDOWSTATE[WINDOWSTATE["MINIMIZED_WAS_MAXIMIZED"] = 3] = "MINIMIZED_WAS_MAXIMIZED";
+    WINDOWSTATE[WINDOWSTATE["TRANSITIONING"] = 4] = "TRANSITIONING";
+})(WINDOWSTATE || (WINDOWSTATE = {}));
+// These channels are to start and stop services dynamically.
+export const SERVICE_START_CHANNEL = "Finsemble.Service.Start";
+export const SERVICE_STOP_CHANNEL = "Finsemble.Service.Stop";
+export const DOCKING = {
+    GROUP_UPDATE: "DockingService.groupUpdate",
+    // For legacy reasons, this is named Workspace, even though it's generated by docking.
+    WORKSPACE_GROUP_UPDATE: "Finsemble.WorkspaceService.groupUpdate",
+    REQUEST_PUBLISH: "DockingService.requestGroupDataPublish",
+};
+// These channels are for interrupting events
+export const EVENT_INTERRUPT_CHANNEL = "Finsemble.Event.Interrupt";
+export const INTERRUPTIBLE_EVENTS = ["close-requested", "closed", "close-complete", "_container-close-handlers"];
+export const WINDOW = {
+    DELAYABLE_EVENTS: ["close-requested", "closed", "close-complete", "_container-close-handlers"],
+    CANCELABLE_EVENTS: ["close-requested"],
+};
+export const WORKSPACE = {
+    DELAYABLE_EVENTS: ["load-requested", "close-requested", "save-requested"],
+    CANCELABLE_EVENTS: ["close-requested"],
+    CLEAN_SHUTDOWN: "Finsemble.Workspace.cleanShutdown",
+    UPDATE_PUBSUB: "Finsemble.WorkspaceService.update",
+    STORAGE_TOPIC: "finsemble.workspace",
+    CACHE_STORAGE_TOPIC: "finsemble.workspace.cache",
+    ALL_WORKSPACES: "finsemble.allWorkspaces",
+    ACTIVE_WORKSPACE: "activeWorkspace",
+    // When we have the liberty of breaking API's, we should consolidate this topic.
+    LAST_USED_WORKSPACE_TOPIC: "finsemble",
+    LAST_USED_WORKSPACE_NAME: "finsemble.lastUsedWorkspace.name",
+    LAST_USED_WORKSPACE: "finsemble.lastUsedWorkspace",
+    INITIAL_WORKSPACE_PREFERENCE: "finsemble.initialWorkspace",
+    PUBLISH_REASONS: {
+        INIT: "workspace:initialization",
+        LOAD_DATA_RETRIEVED: "workspace:load:dataRetrieved",
+        LOAD_FINISHED: "workspace:load:finished",
+        WINDOW_REMOVED: "window:remove",
+        WINDOW_ADDED: "window:add",
+        LOAD_STARTED: "workspace:load:start",
+        WORKSPACE_REMOVED: "Workspace:remove",
+        WORKSPACE_RENAMED: "rename",
+        SWITCHTO_TERMINATED: "workspace:switchTo:terminated",
+        NEW_WORKSPACE: "new workspace",
+        SAVE_AS: "APPLICATION LIFECYCLE:WORKSPACE LIFECYCLE:SaveAs:Workspace:Save As",
+    },
+    API_CHANNELS: {
+        NEW_WORKSPACE: "Finsemble.Workspace.NewWorkspace",
+        SAVE: "Finsemble.Workspace.Save",
+        RENAME: "Finsemble.Workspace.Rename",
+        SAVE_AS: "Finsemble.Workspace.SaveAs",
+        SWITCH_TO: "Finsemble.Workspace.SwitchTo",
+        IMPORT: "Finsemble.Workspace.Import",
+        EXPORT: "Finsemble.Workspace.Export",
+        REMOVE: "Finsemble.Workspace.Remove",
+        SAVE_GLOBAL_DATA: "Finsemble.Workspace.SaveGlobalData",
+        SAVE_VIEW_DATA: "Finsemble.Workspace.SaveViewData",
+        GET_GLOBAL_DATA: "Finsemble.Workspace.GetGlobalData",
+        GET_VIEW_DATA: "Finsemble.Workspace.GetViewData",
+        GET_WORKSPACES: "Finsemble.Workspace.GetWorkspaces",
+        GET_WORKSPACE_NAMES: "Finsemble.Workspace.GetWorkspaceNames",
+        SET_WORKSPACE_ORDER: "Finsemble.Workspace.SetWorkspaceOrder",
+        GET_ACTIVE_WORKSPACE: "Finsemble.Workspace.GetActiveWorkspace",
+        GET_ACTIVE_WORKSPACE_DIRTY: "Finsemble.Workspace.GetActiveWorkspaceDirty",
+        GET_TEMPLATES: "Finsemble.Workspace.GetTemplates",
+        IMPORT_TEMPLATE: "Finsemble.Workspace.ImportTemplate",
+        EXPORT_TEMPLATE: "Finsemble.Workspace.ExportTemplate",
+        REMOVE_TEMPLATE: "Finsemble.Workspace.RemoveTemplate",
+        SET_WINDOW_STATE: "Finsemble.Workspace.SetWindowData",
+        GET_WINDOW_STATE: "Finsemble.Workspace.GetWindowData",
+        ADD_WINDOW: "WorkspaceService.addWindow",
+        REMOVE_WINDOW: "WorkspaceService.removeWindow",
+    },
+    DEFAULT_WINDOW_PROPS: [
+        "name",
+        "componentType",
+        "windowType",
+        "alwaysOnTop",
+        "autoShow",
+        "minWidth",
+        "minHeight",
+        "maxWidth",
+        "maxHeight",
+        "resizable",
+        "maximizable",
+        "minimizable",
+        "opacity",
+        "windowState",
+        // If these are not included, stacks don't position properly on workspace load (always stay at 0,0)
+        "left",
+        "top",
+        "width",
+        "height",
+        "right",
+        "bottom",
+        // If these are not included, welcome component (defaultPosition center) do not position properly on workspace load (always position center)
+        "defaultLeft",
+        "defaultTop",
+        "defaultWidth",
+        "defaultHeight",
+        "defaultRight",
+        "defaultBottom",
+        "monitorInfo",
+        "icon",
+        "cachedBounds",
+        "showTaskbarIcon",
+        "isEvergreen",
+        "launchGroupComponentData",
+        "allowAutoArrange",
+    ],
+    ADDITIONAL_WINDOW_PROPS: {
+        WebWindow: [
+            "url",
+            "fullscreen",
+            "frame",
+            "backgroundColor",
+            "transparent",
+            "waitForPageLoad",
+            "affinity",
+            "appUUID",
+        ],
+        NativeWindow: ["path", "alias", "arguments", "argumentsAsQueryString", "isWPF"],
+        StackedWindow: [
+            "childWindowIdentifiers",
+            "visibleWindowIdentifier",
+            // this third version of bounds is also required, otherwise stacks have errors and never become visible
+            "bounds",
+        ],
+    },
+};
+export const WINDOW_SERVICE_REQUESTS = {
+    REMOTE_FOCUS: "WindowService.remoteFocus",
+    SET_ALWAYS_ON_TOP: "WindowService-Request-setAlwaysOnTop",
+    IS_ALWAYS_ON_TOP: "WindowService-Request-isAlwaysOnTop",
+};
+export const COMPONENT_STATE_STORAGE_TOPIC = "finsemble.componentStateStorage";
+export const HEARTBEAT_TIMEOUT_CHANNEL = "Finsemble.WindowService.HeartbeatTimeout";
+export const LAUNCHER_SERVICE = {
+    WINDOW_CLOSED: "LauncherService.WindowClosed",
+};
+export const MOVE_REASON = {
+    AERO_KEY: "aero_key",
+    SYSTEM_RESTORED: "system_restored",
+};
+//# sourceMappingURL=constants.js.map

package/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/common/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,QAAQ,GAAG;IACvB,MAAM,EAAE,CAAC,eAAe,EAAE,cAAc,EAAE,WAAW,EAAE,aAAa,EAAE,YAAY,CAAC;CACnF,CAAC;AACF,MAAM,CAAC,MAAM,yBAAyB,GAAG,6BAA6B,CAAC;AAEvE,6KAA6K;AAC7K,MAAM,CAAC,MAAM,4BAA4B,GAAG,8CAA8C,CAAC;AAC3F,MAAM,CAAC,MAAM,qBAAqB,GAAG,uCAAuC,CAAC;AAC7E,MAAM,CAAC,MAAM,uBAAuB,GAAG,yCAAyC,CAAC;AACjF,MAAM,CAAC,MAAM,sBAAsB,GAAG,wCAAwC,CAAC;AAE/E,iFAAiF;AACjF,yDAAyD;AACzD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,uCAAuC,IAAI,EAAE,CAAC;AAC3G,0IAA0I;AAC1I,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,IAAY,EAAE,EAAE;IACrD,MAAM,OAAO,GAA8B;QAC1C,oBAAoB,EAAE,uBAAuB;QAC7C,YAAY,EAAE,eAAe;QAC7B,sBAAsB,EAAE,kBAAkB;QAC1C,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,eAAe;QAC7B,MAAM,EAAE,eAAe;QACvB,YAAY,EAAE,eAAe;QAC7B,aAAa,EAAE,gBAAgB;QAC/B,YAAY,EAAE,eAAe;QAC7B,eAAe,EAAE,kBAAkB;KACnC,CAAC;IACF,2CAA2C;IAC3C,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,6EAA6E;AAC7E,MAAM,CAAC,MAAM,sBAAsB,GAAG,0BAA0B,CAAC;AACjE,MAAM,CAAN,IAAY,WAMX;AAND,WAAY,WAAW;IACtB,iDAAU,CAAA;IACV,6EAAwB,CAAA;IACxB,uDAAa,CAAA;IACb,mFAA2B,CAAA;IAC3B,+DAAiB,CAAA;AAClB,CAAC,EANW,WAAW,KAAX,WAAW,QAMtB;AACD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAC/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,wBAAwB,CAAC;AAE7D,MAAM,CAAC,MAAM,OAAO,GAAG;IACtB,YAAY,EAAE,4BAA4B;IAC1C,sFAAsF;IACtF,sBAAsB,EAAE,wCAAwC;IAChE,eAAe,EAAE,wCAAwC;CACzD,CAAC;AAEF,6CAA6C;AAC7C,MAAM,CAAC,MAAM,uBAAuB,GAAG,2BAA2B,CAAC;AACnE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,iBAAiB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,2BAA2B,CAAC,CAAC;AAEjH,MAAM,CAAC,MAAM,MAAM,GAAG;IACrB,gBAAgB,EAAE,CAAC,iBAAiB,EAAE,QAAQ,EAAE,gBAAgB,EAAE,2BAA2B,CAAC;IAC9F,iBAAiB,EAAE,CAAC,iBAAiB,CAAC;CACtC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG;IACxB,gBAAgB,EAAE,CAAC,gBAAgB,EAAE,iBAAiB,EAAE,gBAAgB,CAAC;IACzE,iBAAiB,EAAE,CAAC,iBAAiB,CAAC;IAEtC,cAAc,EAAE,mCAAmC;IACnD,aAAa,EAAE,mCAAmC;IAClD,aAAa,EAAE,qBAAqB;IACpC,mBAAmB,EAAE,2BAA2B;IAChD,cAAc,EAAE,yBAAyB;IACzC,gBAAgB,EAAE,iBAAiB;IACnC,gFAAgF;IAChF,yBAAyB,EAAE,WAAW;IACtC,wBAAwB,EAAE,kCAAkC;IAC5D,mBAAmB,EAAE,6BAA6B;IAClD,4BAA4B,EAAE,4BAA4B;IAC1D,eAAe,EAAE;QAChB,IAAI,EAAE,0BAA0B;QAChC,mBAAmB,EAAE,8BAA8B;QACnD,aAAa,EAAE,yBAAyB;QACxC,cAAc,EAAE,eAAe;QAC/B,YAAY,EAAE,YAAY;QAC1B,YAAY,EAAE,sBAAsB;QACpC,iBAAiB,EAAE,kBAAkB;QACrC,iBAAiB,EAAE,QAAQ;QAC3B,mBAAmB,EAAE,+BAA+B;QACpD,aAAa,EAAE,eAAe;QAC9B,OAAO,EAAE,oEAAoE;KAC7E;IACD,YAAY,EAAE;QACb,aAAa,EAAE,kCAAkC;QACjD,IAAI,EAAE,0BAA0B;QAChC,MAAM,EAAE,4BAA4B;QACpC,OAAO,EAAE,4BAA4B;QACrC,SAAS,EAAE,8BAA8B;QACzC,MAAM,EAAE,4BAA4B;QACpC,MAAM,EAAE,4BAA4B;QACpC,MAAM,EAAE,4BAA4B;QACpC,gBAAgB,EAAE,oCAAoC;QACtD,cAAc,EAAE,kCAAkC;QAClD,eAAe,EAAE,mCAAmC;QACpD,aAAa,EAAE,iCAAiC;QAChD,cAAc,EAAE,mCAAmC;QACnD,mBAAmB,EAAE,uCAAuC;QAC5D,mBAAmB,EAAE,uCAAuC;QAC5D,oBAAoB,EAAE,wCAAwC;QAC9D,0BAA0B,EAAE,6CAA6C;QACzE,aAAa,EAAE,kCAAkC;QACjD,eAAe,EAAE,oCAAoC;QACrD,eAAe,EAAE,oCAAoC;QACrD,eAAe,EAAE,oCAAoC;QACrD,gBAAgB,EAAE,mCAAmC;QACrD,gBAAgB,EAAE,mCAAmC;QACrD,UAAU,EAAE,4BAA4B;QACxC,aAAa,EAAE,+BAA+B;KAC9C;IACD,oBAAoB,EAAE;QACrB,MAAM;QACN,eAAe;QACf,YAAY;QACZ,aAAa;QACb,UAAU;QACV,UAAU;QACV,WAAW;QACX,UAAU;QACV,WAAW;QACX,WAAW;QACX,aAAa;QACb,aAAa;QACb,SAAS;QACT,aAAa;QACb,mGAAmG;QACnG,MAAM;QACN,KAAK;QACL,OAAO;QACP,QAAQ;QACR,OAAO;QACP,QAAQ;QACR,4IAA4I;QAC5I,aAAa;QACb,YAAY;QACZ,cAAc;QACd,eAAe;QACf,cAAc;QACd,eAAe;QACf,aAAa;QACb,MAAM;QACN,cAAc;QACd,iBAAiB;QACjB,aAAa;QACb,0BAA0B;QAC1B,kBAAkB;KAClB;IACD,uBAAuB,EAAE;QACxB,SAAS,EAAE;YACV,KAAK;YACL,YAAY;YACZ,OAAO;YACP,iBAAiB;YACjB,aAAa;YACb,iBAAiB;YACjB,UAAU;YACV,SAAS;SACT;QACD,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,OAAO,CAAC;QAC/E,aAAa,EAAE;YACd,wBAAwB;YACxB,yBAAyB;YACzB,uGAAuG;YACvG,QAAQ;SACR;KACD;CACD,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACtC,YAAY,EAAE,2BAA2B;IACzC,iBAAiB,EAAE,sCAAsC;IACzD,gBAAgB,EAAE,qCAAqC;CACvD,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,iCAAiC,CAAC;AAE/E,MAAM,CAAC,MAAM,yBAAyB,GAAG,0CAA0C,CAAC;AAEpF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B,aAAa,EAAE,8BAA8B;CAC7C,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,QAAQ,EAAE,UAAU;IACpB,eAAe,EAAE,iBAAiB;CAClC,CAAC"}

package/common/dependencyManager.d.ts

@@ -0,0 +1,172 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+declare type StartupDependencyParams = {
+    callback: Function;
+    dependencies: string[];
+    whoAmI?: string;
+};
+/**
+ * Small class to hold on to dependencies and callbacks. Also emits a timeout event that the startupManager is listening for. When it times out, the startupManager catches the event and generates a message that includes all of the offline clients and services. It then causes this class to emit an  err event that the baseService is listening for. This arrangement is set up for a couple of reasons.
+ * 1. I can't use the logger in here because the logger uses the startupManager, and there'd be a circular dependency.
+ * 2. FSBLDependencyManager is a singleton, and there can be multiple services living in a single window. I didn't want them all to log that they were offline if they weren't (e.g., if I'd put the emitter on the StartupManager instead of this class).
+ */
+declare class StartupDependency extends EventEmitter {
+    startupTimer?: number | null;
+    callback: Function;
+    dependencies: string[];
+    whoAmI: string;
+    constructor(params: StartupDependencyParams);
+    /**
+     * Removes the startup timer (because the dependency was resolved within the allotted time);
+     */
+    clearStartupTimer(): void;
+    /**
+     * If the dependency hasn't resolved within STARTUP_TIMEOUT_DURATION, emit a timeout event that the StartupManager can catch.
+     */
+    setStartupTimer(): void;
+}
+/**
+ * @private
+ */
+declare class StartupManager {
+    onlineClients: string[];
+    onlineServices: string[] | undefined;
+    dependencies: object;
+    AuthorizationCompleted: boolean | undefined;
+    startupTimers: object;
+    startupTimerFired: boolean;
+    servicesAreAllOnline: object;
+    clientsAreAllOnline: object;
+    /**
+     * @private
+     */
+    constructor();
+    /**
+     * This function and `checkDependencies` are the most important parts of this class. This function accepts a FinsembleDependency object and a callback to be invoked when all required dependencies are ready.
+     *
+     * @param {FinsembleDependency} dependencies
+     * @param {any} callback
+     * @memberof StartupManager
+     */
+    waitFor(dependencies: any, callback: any, whoAmI?: string): StartupDependency;
+    /**
+     * This method generates a helpful error message giving possible reasons for why the service is offline. After the message is generated, it emits an event on the dependency that's passed in as a parameter. The BaseService is listening for this event, and logs the error message to the central logger.
+     * @param {Dependency} dependency
+     */
+    onDependencyTimeout(dependency: StartupDependency): void;
+    /**
+     * This function loops through all of the registered dependencies and checks to see if the conditions have been met. If so, it invokes the callback and removes the reference to the dependency.
+     *
+     * @memberof StartupManager
+     */
+    checkDependencies(): void;
+    getOfflineClients(): never[];
+    /**
+     * Iterates through required client list, returns false if any required client is offline.
+     *
+     * @param {any} clientList
+
+     * @memberof StartupManager
+     */
+    checkClients(clientList: any): any;
+    /**
+     *
+     *
+     * @param {any} clientName
+
+     * @memberof StartupManager
+     */
+    setClientOnline(clientName: any): void;
+    /**
+     * Returns the array of online clients.
+     *
+
+     * @memberof StartupManager
+     */
+    getOnlineClients(): string[];
+    /**
+     * Method to make sure that `this` is correct when the callbacks are invoked.
+     *
+     * @memberof StartupManager
+     */
+    bindCorrectContext(): void;
+}
+/**
+ * @private
+ */
+declare class ShutdownManager {
+    offlineServices: string[];
+    dependencies: object;
+    /**
+     * @private
+     */
+    constructor();
+    /**
+     * This function and `checkDependencies` are the most important parts of this class. This function accepts a FinsembleDependency object and a callback to be invoked when all required dependencies are ready.
+     *
+     * @param {FinsembleDependency} dependencies
+     * @param {any} callback
+     * @memberof StartupManager
+     */
+    waitFor(dependencies: any, callback: any): void;
+    /**
+     * This function loops through all of the registered dependencies and checks to see if the conditions have been met. If so, it invokes the callback and removes the reference to the dependency.
+     *
+     * @memberof ShutdownDependencies
+     */
+    checkDependencies(): void;
+    /**
+     * Iterates through required service list, returns false if any required service is offline.
+     *
+     * @param {any} serviceList
+
+     * @memberof ShutdownManager
+     */
+    checkServices(serviceList: any): any;
+    setServiceOffline(service: any): void;
+}
+/**
+ * This class handles FSBL client/service dependency management. Given a list of services and/or clients, it will invoke a callback when all dependencies are ready.
+ *
+ * The constructor is exported for the system mananger's shutDownManager so that class isn't constructed until right time in the starup process.
+ * Otherwise, this class is used as a singleton thoughout the rest of the system.
+ *
+ * @private
+ * @class FSBLDependencyManager
+ */
+export declare class FSBLDependencyManager extends EventEmitter {
+    /**
+     * Binds context, and listens for services to come online.
+     * Creates an instance of FSBLDependencyManager.
+     * @private
+     * @memberof FSBLDependencyManager
+     */
+    startup: StartupManager;
+    shutdown: ShutdownManager;
+    AuthorizationCompleted: any;
+    RouterClient: any;
+    name: any;
+    constructor();
+    /**
+     * Method to make sure that `this` is correct when the callbacks are invoked.
+     *
+     * @memberof StartupManager
+     */
+    bindCorrectContext(): void;
+    setClientOnline(client: any): void;
+    onServiceStateChange(data: any): void;
+    /**
+     * Listens on the router for services to come online. The first subscriber gets the activeServices as of object instantiation. The 2nd subscriber listens for services to come online after the object is created. We should consider make this all one subscriber, though I see the advantage of having this setup.
+     *
+     */
+    listenForServices(): void;
+    onAuthorizationCompleted(callback: any): void;
+}
+/**
+ * This class handles FSBL client/service dependency management. Given a list of services and/or clients, it will invoke a callback when all dependencies are ready. This is a singleton.
+ * @private
+ * @class FSBLDependencyManager
+ */
+export declare const FSBLDependencyManagerSingleton: FSBLDependencyManager;
+export default FSBLDependencyManagerSingleton;
+//# sourceMappingURL=dependencyManager.d.ts.map

package/common/dependencyManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencyManager.d.ts","sourceRoot":"","sources":["../../../src/common/dependencyManager.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAStC,aAAK,uBAAuB,GAAG;IAC9B,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAMF;;;;GAIG;AACH,cAAM,iBAAkB,SAAQ,YAAY;IAC3C,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,QAAQ,EAAE,QAAQ,CAAC;IAEnB,YAAY,EAAE,MAAM,EAAE,CAAC;IAEvB,MAAM,EAAE,MAAM,CAAC;gBAEH,MAAM,EAAE,uBAAuB;IAU3C;;OAEG;IACH,iBAAiB;IAQjB;;OAEG;IACH,eAAe;CASf;AAYD;;GAEG;AACH,cAAM,cAAc;IACnB,aAAa,EAAE,MAAM,EAAE,CAAC;IAExB,cAAc,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IAErC,YAAY,EAAE,MAAM,CAAC;IAErB,sBAAsB,EAAE,OAAO,GAAG,SAAS,CAAC;IAE5C,aAAa,EAAE,MAAM,CAAC;IAEtB,iBAAiB,EAAE,OAAO,CAAC;IAE3B,oBAAoB,EAAE,MAAM,CAAM;IAElC,mBAAmB,EAAE,MAAM,CAAM;IAEjC;;OAEG;;IASH;;;;;;OAMG;IACH,OAAO,CAAC,YAAY,KAAA,EAAE,QAAQ,KAAA,EAAE,MAAM,CAAC,EAAE,MAAM;IA2B/C;;;OAGG;IACH,mBAAmB,CAAC,UAAU,EAAE,iBAAiB;IAiBjD;;;;OAIG;IACH,iBAAiB;IAmBjB,iBAAiB;IAUjB;;;;;;OAMG;IACH,YAAY,CAAC,UAAU,KAAA;IAIvB;;;;;;OAMG;IACH,eAAe,CAAC,UAAU,KAAA;IAmC1B;;;;;OAKG;IACH,gBAAgB;IAIhB;;;;OAIG;IACH,kBAAkB;CAOlB;AACD;;GAEG;AACH,cAAM,eAAe;IACpB,eAAe,EAAE,MAAM,EAAE,CAAC;IAE1B,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;;IAOH;;;;;;OAMG;IACH,OAAO,CAAC,YAAY,KAAA,EAAE,QAAQ,KAAA;IAa9B;;;;OAIG;IACH,iBAAiB;IAsBjB;;;;;;OAMG;IACH,aAAa,CAAC,WAAW,KAAA;IAIzB,iBAAiB,CAAC,OAAO,KAAA;CAMzB;AAED;;;;;;;;GAQG;AACH,qBAAa,qBAAsB,SAAQ,YAAY;IACtD;;;;;OAKG;IACH,OAAO,EAAE,cAAc,CAAC;IAExB,QAAQ,EAAE,eAAe,CAAC;IAE1B,sBAAsB,MAAC;IAEvB,YAAY,MAAC;IAEb,IAAI,MAAC;;IAaL;;;;OAIG;IACH,kBAAkB;IAKlB,eAAe,CAAC,MAAM,KAAA;IAOtB,oBAAoB,CAAC,IAAI,KAAA;IAWzB;;;OAGG;IACH,iBAAiB;IAoCjB,wBAAwB,CAAC,QAAQ,KAAA;CAOjC;AACD;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,EAAE,qBAAmD,CAAC;AACjG,eAAe,8BAA8B,CAAC"}