spitfirepm 1.10.87 → 1.20.91

package/dist/sfRESTClient.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="jquery" />
 import { GUID } from "./globals";
-import { IUCPermit, QueryFilters, Suggestion, UCPermitSet, UIDisplayConfig, UIDisplayPart } from "./SwaggerClients";
+import { IUCPermit, QueryFilters, SessionClient, Suggestion, UCPermitSet, UIDisplayConfig, UIDisplayPart } from "./SwaggerClients";
 import * as _SwaggerClientExports from "./SwaggerClients";
 export declare enum LoggingLevels {
     None = 0,
@@ -228,6 +228,10 @@ export declare class sfRestClient {
      * when true, a unique value is added to defeat cache
     */
     autoVary?: boolean | undefined): Promise<string | null>;
+    private _ThrottleDVRequests;
+    private _DVRequestQueue;
+    private _DVThrottledResolvers;
+    private _DVRequestTimerHandle;
     /**
      * Async Get Part Configuration Data given part name, doc type and context
     */
@@ -251,6 +255,12 @@ export declare class sfRestClient {
      *
     */
     PopQAInfo(forElement: JQuery<HTMLElement>, queryOptions?: QAInfoOptions, resolveKey?: (forElement: JQuery<HTMLElement>) => string, resolveValue?: (forElement: JQuery<HTMLElement>, queryOptions: QAInfoOptions) => string, onPostback?: (eventTarget: string, eventArgs: string) => void): JQuery<HTMLElement>;
+    /** checks with server up to 5 times a second.  promise resolves when task has ended or callback returns true;
+     * @param taskKey guid key for task
+     * @param sessionClient optional existing SessionClient
+     * @param progressCallback optional callback for when task status is not 200;  if this callback returns true, promise is resolved
+     */
+    WaitForTask(taskKey: GUID, sessionClient?: SessionClient, progressCallback?: (state: _SwaggerClientExports.HttpResponseJsonContent) => boolean): Promise<_SwaggerClientExports.HttpResponseJsonContent>;
     /**
      * Maps .NET placeholders (dn) to webix placeholders (dx)
      * Important: order matters (eg: dd must be remapped before d, or the d map would be used)

package/dist/sfRESTClient.js

@@ -7,7 +7,7 @@ const _SwaggerClientExports = require("./SwaggerClients");
 const $ = require("jquery");
 const BrowserExtensionChecker_1 = require("./BrowserExtensionChecker");
 //import {dialog}    from "jquery-ui";
-const ClientPackageVersion = "1.10.87";
+const ClientPackageVersion = "1.20.91";
 //export type GUID = string //& { isGuid: true };
 /* eslint-disable prefer-template */
 /* eslint-disable no-extend-native */
@@ -246,6 +246,10 @@ class sfRestClient {
             Login: 16384,
             DiagUtilities: 32768
         };
+        this._DVRequestQueue = [];
+        //private _DVThrottledResolvers1 : {[key:string]:(params:string)=>void; }
+        this._DVThrottledResolvers = new Map();
+        this._DVRequestTimerHandle = undefined;
         /**
          * Maps .NET placeholders (dn) to webix placeholders (dx)
          * Important: order matters (eg: dd must be remapped before d, or the d map would be used)
@@ -907,7 +911,6 @@ class sfRestClient {
      * when true, a unique value is added to defeat cache
     */
     autoVary) {
-        // future: finish support for dependsOn list
         var apiResultPromise;
         if (!keyValue)
             return new Promise((resolve) => resolve(""));
@@ -955,10 +958,13 @@ class sfRestClient {
             if (DependsOnSet[index] == "undefined")
                 DependsOnSet.pop();
         }
-        var DVFilters = new SwaggerClients_1.QueryFilters();
-        DVFilters.MatchingSeed = keyValue;
+        var DVFilters = new _SwaggerClientExports.DVRequest();
+        DVFilters.DVName = displayName;
+        DVFilters.MatchingValue = keyValue;
         DVFilters.DependsOn = DependsOnSet;
-        var apiResultPromise = api.getDisplayValueViaPost(displayName, "1", DVFilters);
+        DVFilters.RequestID = cacheKey;
+        //DVFilters.DataContext = "1";
+        var apiResultPromise = this._ThrottleDVRequests(api, DVFilters);
         if (apiResultPromise) {
             apiResultPromise.then((dvResult) => {
                 if (dvResult) {
@@ -971,6 +977,51 @@ class sfRestClient {
         this._CachedDVRequests.set(cacheKey, apiResultPromise);
         return apiResultPromise;
     }
+    _ThrottleDVRequests(api, dvRequest) {
+        var DVResultPromise;
+        var RESTClient = this;
+        if (sfRestClient._Options.LogLevel >= LoggingLevels.VerboseDebug)
+            console.log(`ThrottleDV(${dvRequest.DVName}:${dvRequest.MatchingValue}) with ${this._CachedDVRequests.size} pending `);
+        if (this._CachedDVRequests.size > 0) {
+            DVResultPromise = new Promise((resolvedTo) => {
+                if (!RESTClient._DVRequestTimerHandle) {
+                    if (sfRestClient._Options.LogLevel >= LoggingLevels.VerboseDebug)
+                        console.log(`ThrottleDV() created BatchDV  `);
+                    RESTClient._DVRequestTimerHandle = setTimeout(() => {
+                        var thisGroup = [];
+                        Object.assign(thisGroup, RESTClient._DVRequestQueue);
+                        RESTClient._DVRequestQueue = [];
+                        RESTClient._DVRequestTimerHandle = undefined;
+                        if (sfRestClient._Options.LogLevel >= LoggingLevels.VerboseDebug)
+                            console.log(`BatchDV() with ${thisGroup.length} in group `);
+                        api.getDisplayValueCollection(thisGroup).then(dvList => {
+                            if (sfRestClient._Options.LogLevel >= LoggingLevels.VerboseDebug)
+                                console.log(`BatchDV().THEN  `, dvList);
+                            if (dvList)
+                                dvList.forEach(element => {
+                                    if (element.value) {
+                                        var DVDonePromise = this._DVThrottledResolvers.get(element.value);
+                                        if (DVDonePromise) {
+                                            DVDonePromise(element.label);
+                                            this._DVThrottledResolvers.delete(element.value);
+                                        }
+                                        else
+                                            console.warn("Batch DV could not find element", element);
+                                    }
+                                    else
+                                        console.warn("Batch DV could not find cacheId", element);
+                                });
+                        });
+                    }, 321);
+                }
+                RESTClient._DVRequestQueue.push(dvRequest);
+                this._DVThrottledResolvers.set(dvRequest.RequestID, resolvedTo);
+            });
+        }
+        else
+            DVResultPromise = api.getDisplayableValue(dvRequest.DVName, dvRequest);
+        return DVResultPromise;
+    }
     /**
      * Async Get Part Configuration Data given part name, doc type and context
     */
@@ -1124,6 +1175,40 @@ class sfRestClient {
         // });
         return forElement;
     }
+    /** checks with server up to 5 times a second.  promise resolves when task has ended or callback returns true;
+     * @param taskKey guid key for task
+     * @param sessionClient optional existing SessionClient
+     * @param progressCallback optional callback for when task status is not 200;  if this callback returns true, promise is resolved
+     */
+    async WaitForTask(taskKey, sessionClient, progressCallback) {
+        if (!sessionClient)
+            sessionClient = new SwaggerClients_1.SessionClient();
+        var RESTClient = this;
+        if (sfRestClient._Options.TaskStatePollInterval < 200)
+            sfRestClient._Options.TaskStatePollInterval = 200;
+        return new Promise(async (result) => {
+            var taskResult, waitResult;
+            taskResult = new _SwaggerClientExports.HttpResponseJsonContent({ ThisStatus: 202 });
+            var aborted = false;
+            while (!aborted && taskResult.ThisStatus == 202) {
+                await new Promise(r => setTimeout(r, sfRestClient._Options.TaskStatePollInterval));
+                var taskCheck = sessionClient.getTaskState(taskKey).then(t => taskResult = t).catch(x => { taskResult = x; });
+                await taskCheck;
+                if (taskResult.ThisStatus == 202) {
+                    if (progressCallback) {
+                        if (progressCallback(taskResult)) {
+                            result(taskResult);
+                            aborted = true;
+                        }
+                    }
+                    else if (taskResult.ThisReason) {
+                        RESTClient.DisplayUserNotification(taskResult.ThisReason);
+                    }
+                }
+            }
+            result(taskResult);
+        });
+    }
     /**
      * Converts traditional .NET date formats to Webix formats
      * @param dotNetFormat something like d or m/d/yyyy
@@ -3949,7 +4034,8 @@ sfRestClient._Options = {
     PopupWindowViewUserVWS: { top: -1, left: -1, width: 1000, height: 605 },
     PopupWindowTop: 45,
     ProjectLegacyURL: '{0}/ProjectDetail.aspx?id={1}',
-    ProjectXBURL: '{0}/spax.html#!/main/projectDashboard?project={1}'
+    ProjectXBURL: '{0}/spax.html#!/main/projectDashboard?project={1}',
+    TaskStatePollInterval: 357
 };
 sfRestClient.GAPageHitSent = false; // !!! this needs work
 sfRestClient.GAMonitorSendFailed = false;