spitfirepm 23.9000.4 → 23.9000.6

package/dist/sfRESTClient.d.ts

@@ -145,9 +145,18 @@ declare class PartStorageData {
      * @param context
      * @param usingCfg if supplied, stored, otherwise resolved
      * @returns
+     * @see RegisterRestoredCFG
      */
     static PartStorageDataFactory(client: sfRestClient, partName: string, forDocType: GUID | undefined, forProject: GUID | undefined, context: string | undefined, usingCfg?: UIDisplayPart): PartStorageData;
-    static PartStorageDataLookupFactory(client: sfRestClient, lookupName: string): PartStorageData;
+    /**
+     *
+     * @param client
+     * @param lookupName
+     * @param usingCfg
+     * @returns
+     * @see RegisterRestoredLookupCFG
+     */
+    static PartStorageDataLookupFactory(client: sfRestClient, lookupName: string, usingCfg?: UIDisplayPart): PartStorageData;
     static GetPartContextKey(partName: string, forDocType: GUID | undefined, forProject: GUID | undefined, context: string | undefined): PartContextKey;
     GetDataModelBuildContextKey(): string;
     protected constructor(client: sfRestClient, partName: string, forDocType: GUID | undefined, forProject: GUID | undefined, context: string | undefined);
@@ -426,6 +435,14 @@ export declare class sfRestClient {
      * @see GetPartCFG
      */
     RegisterRestoredCFG(partName: string, forDocType?: GUID, forProject?: string, partContext?: string, recoveredCFG?: UIDisplayPart): UIDisplayPart;
+    /**
+        * Tell the cfg manager about a lookup that was recovered from local storage
+        * @param lookupName
+        * @param recoveredCFG  NOT optional, you are responsible for it being current
+        * @returns  the cfg object
+        * @see GetPartCFG
+        */
+    RegisterRestoredLookupCFG(lookupName: string, recoveredCFG: UIDisplayPart): UIDisplayPart;
     /**
      * Async Get of Lookup column configuration data
      * @param lookupName name of required Lookup
@@ -540,7 +557,9 @@ export declare class sfRestClient {
     protected static _SessionClientGetWCC: _SessionClientGetWCCShare | null;
     protected static _SessionClientGetUCFKMap: JQueryXHR | null;
     private static _MakeFakeWCC;
-    /** applies changes to connection properties */
+    /** applies changes to connection properties
+     * @see SharePageContext
+    */
     UpdateWCCData(newWCC: WCCData): WCCData;
     /**
      * For each passed URI, If page does not already have a matching SCRIPT element, adds one

package/dist/sfRESTClient.js

@@ -8,7 +8,7 @@ const BrowserExtensionChecker_1 = require("./BrowserExtensionChecker");
 const RESTClientBase = require("./APIClientBase"); // avoid conflict with same in SwaggerClient when loaded by classic UI
 const string_extensions_1 = require("./string.extensions");
 //import {dialog}    from "jquery-ui";
-const ClientPackageVersion = "23.9000.4";
+const ClientPackageVersion = "23.9000.6";
 // originally modified for typescript and linter requirements by Uladzislau Kumakou of XB Software
 var LoggingLevels;
 (function (LoggingLevels) {
@@ -76,6 +76,7 @@ class PartStorageData {
      * @param context
      * @param usingCfg if supplied, stored, otherwise resolved
      * @returns
+     * @see RegisterRestoredCFG
      */
     static PartStorageDataFactory(client, partName, forDocType, forProject, context, usingCfg) {
         if (!forProject)
@@ -110,13 +111,28 @@ class PartStorageData {
         }
         return thisPart;
     }
-    static PartStorageDataLookupFactory(client, lookupName) {
+    /**
+     *
+     * @param client
+     * @param lookupName
+     * @param usingCfg
+     * @returns
+     * @see RegisterRestoredLookupCFG
+     */
+    static PartStorageDataLookupFactory(client, lookupName, usingCfg) {
         var ReferenceKey = PartStorageData.GetPartContextKey(lookupName, "lookup", "lookup", "lookup");
         var thisPart;
         if (PartStorageData._LoadedParts.has(ReferenceKey))
             thisPart = PartStorageData._LoadedParts.get(ReferenceKey);
         else {
             thisPart = new PartStorageData(client, lookupName, "lookup", "lookup", "lookup");
+            if (usingCfg && usingCfg.PartName === lookupName) {
+                thisPart._InitializationResultPromise = new Promise((preloaded) => {
+                    thisPart.CFG = usingCfg;
+                    preloaded(usingCfg);
+                });
+                return thisPart;
+            }
             var api = new SwaggerClients_1.UICFGClient(PartStorageData._SiteURL);
             thisPart._InitializationResultPromise = api.getLookupDisplay(lookupName);
             if (thisPart._InitializationResultPromise) {
@@ -1020,6 +1036,19 @@ class sfRestClient {
         const thisPart = PartStorageData.PartStorageDataFactory(this, partName, forDocType, forProject, partContext, recoveredCFG);
         return recoveredCFG;
     }
+    /**
+        * Tell the cfg manager about a lookup that was recovered from local storage
+        * @param lookupName
+        * @param recoveredCFG  NOT optional, you are responsible for it being current
+        * @returns  the cfg object
+        * @see GetPartCFG
+        */
+    RegisterRestoredLookupCFG(lookupName, recoveredCFG) {
+        if (!recoveredCFG)
+            throw new Error(`RegisterRestoredCFG(${lookupName}) requires recoveredCFG object `);
+        const thisPart = PartStorageData.PartStorageDataLookupFactory(this, lookupName, recoveredCFG);
+        return recoveredCFG;
+    }
     /**
      * Async Get of Lookup column configuration data
      * @param lookupName name of required Lookup
@@ -1880,17 +1909,18 @@ class sfRestClient {
                 sfRestClient.RecentDocumentList = [new _SwaggerClientExports.MenuAction()];
                 sfRestClient.RecentDocumentList[0].Enabled = false;
                 sfRestClient.RecentDocumentList[0].ItemText = ' (still loading...)';
-                api.getRecentDocs()
-                    .then((recentList) => {
-                    if (recentList)
-                        sfRestClient.RecentDocumentList = recentList;
-                    else
-                        sfRestClient.RecentDocumentList[0].ItemText = 'Documents will appear here as you open them';
-                })
-                    .catch((reason) => {
-                    console.warn('LoadUserSessionInfo().getRecentDocs()', reason);
-                    sfRestClient.RecentDocumentList[0].ItemText = 'None available';
-                });
+                if (!RESTClient.IsDocumentPage())
+                    api.getRecentDocs()
+                        .then((recentList) => {
+                        if (recentList)
+                            sfRestClient.RecentDocumentList = recentList;
+                        else
+                            sfRestClient.RecentDocumentList[0].ItemText = 'Documents will appear here as you open them';
+                    })
+                        .catch((reason) => {
+                        console.warn('LoadUserSessionInfo().getRecentDocs()', reason);
+                        sfRestClient.RecentDocumentList[0].ItemText = 'None available';
+                    });
             }
             if (!apiResult)
                 console.warn("LoadUserSessionInfo failed to getWCC");
@@ -1946,7 +1976,9 @@ class sfRestClient {
         FakeWCC.UserKey = "00000000-0000-0000-0000-000000000000";
         return FakeWCC;
     }
-    /** applies changes to connection properties */
+    /** applies changes to connection properties
+     * @see SharePageContext
+    */
     UpdateWCCData(newWCC) {
         var RESTClient = this;
         var ChangeList = new Map();
@@ -2346,7 +2378,7 @@ class sfRestClient {
         var RESTClient = this;
         RESTClient.heartbeat();
         return new Promise((resolve) => {
-            if (self.name === "Dashboard") {
+            if (self.name.sfStartsWithCI("Dashboard")) {
                 resolve(self);
                 return;
             }
@@ -2770,7 +2802,7 @@ class sfRestClient {
         return ((!this.IsDocumentPage()) || (sfRestClient._WCC.DataLockFlag >= "2"));
     }
     static IsPowerUXPage() {
-        return location.hash.startsWith("#!") || location.pathname === "/powerux/";
+        return location.hash.startsWith("#!") || location.pathname === "/wx/";
     }
     IsPowerUXPage() {
         return sfRestClient.IsPowerUXPage();
@@ -5149,23 +5181,23 @@ class sfRestClient {
                     return;
                 }
                 if (!sfRestClient.IsPowerUXPage()) {
-                    if (top?.sfClient.IsProjectPage()) {
+                    if (RESTClient.IsProjectPage()) {
                         top?.refreshPartbyName('ProjDocSummary', 'refresh', 'afterDocumentSaved');
                         top?.refreshPartbyName('ProjTypedDocList', 'SlctDocType', dtk);
                     }
-                    else if (top?.sfClient.IsHomeDashboardPage()) {
+                    else if (RESTClient.IsHomeDashboardPage()) {
                         top?.refreshPartbyName('actionitems', 'refresh', 'afterDocumentSaved');
                     }
                 }
             };
             sfHub.client.addRecentDocument = function (dmk, title) {
                 // this event updates the recent Document list
-                top?.sfClient.UpdateRecentDocumentList(dmk, title);
+                RESTClient.UpdateRecentDocumentList(dmk, title);
             };
             sfHub.client.nowViewingDocument = function (target, loginSessionKey, request) {
                 var RequestForWindowMatches = request.match(sfHub.client.ForWindowRX);
                 console.log(`${new Date().toSFLogTimeString()} sfPMSHub: Signal.nowViewingDocument from ${loginSessionKey} to [${target}]:${request} Req4Window:${RequestForWindowMatches} `);
-                if (top?.sfClient.GetPageContextValue("LoginSessionKey") !== loginSessionKey) {
+                if (RESTClient.GetPageContextValue("LoginSessionKey") !== loginSessionKey) {
                     var HubEvent = jQuery.Event("sfPMSHubSignal.nowViewingDocument");
                     $("body").trigger(HubEvent, [target, loginSessionKey, request]);
                     if (HubEvent.isDefaultPrevented())
@@ -5493,6 +5525,8 @@ class sfRestClient {
                 return;
             }
             const isDocumentPage = RESTClient.IsDocumentPage();
+            const isPowerUXPage = sfRestClient.IsPowerUXPage();
+            const isMainView = !isDocumentPage && isPowerUXPage && (location.hash.includes("/main/"));
             const docSessionkey = RESTClient.GetPageContextValue("DocSessionKey");
             const docKey = RESTClient.GetPagePK();
             const hasDocSessionkey = (docSessionkey && docSessionkey !== RESTClient.EmptyKey);
@@ -5516,7 +5550,7 @@ class sfRestClient {
             sfRestClient.PageServerPingAttempts++;
             if (hasWebsocketConnection)
                 top.sfPMSHub.server.sessionAlive();
-            if (RESTClient.IsDocumentPage() && sfRestClient.IsPowerUXPage()) {
+            if (isDocumentPage && isPowerUXPage) {
                 try {
                     let $DocUI = RESTClient.GetPowerUXDocumentUI();
                     let DocModel = RESTClient.GetPageDocumentModel();
@@ -5657,6 +5691,29 @@ class sfRestClient {
                     // how to recover??
                 }
             }
+            else if (isMainView) {
+                if (top.name !== "Dashboard") {
+                    const bc = new BroadcastChannel("sfAuth");
+                    const assertMe = setTimeout(() => {
+                        console.log('Asserting this is main Dashboard...');
+                        top.name = "Dashboard";
+                    }, 1234);
+                    bc.onmessage = function (event) {
+                        // we never receive our own broadcast 
+                        const eventMessage = event.data;
+                        console.log(`BroadcastChannel.pingServer:${eventMessage.event}`, event);
+                        if (eventMessage.event === "PongWindowByName") { //PingWindowByName
+                            if (eventMessage.context === "Dashboard") {
+                                // this means there is already a dashboard
+                                console.log('Pong from Dashboard...');
+                                clearTimeout(assertMe);
+                            }
+                        }
+                    }; // BroadcastChannel message handling --------- ^^
+                    bc.postMessage({ event: "PingWindowByName", context: "Dashboard", payload: false });
+                    // we either get a response or take over as Dashboard
+                }
+            }
             self.sfPMSHub.server.dashboardHeartbeat(pdsKey, sfRestClient.PageNotificationCount)
                 .then(async (responseText) => {
                 if (responseText > "") {