spitfirepm 23.9600.18 → 23.9700.2

package/README.md

@@ -25,6 +25,8 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
+23.9700.2   - ProcessDocumentType DataModel enriched
+23.9700.1   - GatherDependsOnValues() improved
 23.9600.18  - Project Program
 23.9600.17  - Improves Analytics opt out
 23.9600.15  - Improves ConfigController

package/dist/SwaggerClients.d.ts

@@ -1916,6 +1916,14 @@ export declare class DocumentToolsClient extends APIClientBase {
     private addDocDateWithCallbacks;
     private processAddDocDateWithCallbacks;
     protected processAddDocDate(xhr: any): DocDate | null | null;
+    /**
+     * Returns the dates for the specified document
+     * @param id Document Key
+     */
+    getDocDates(id: string): Promise<DocDate[] | null>;
+    private getDocDatesWithCallbacks;
+    private processGetDocDatesWithCallbacks;
+    protected processGetDocDates(xhr: any): DocDate[] | null | null;
     /**
      * Deletes a specific date from the specified document
      * @param id Document Key
@@ -1936,14 +1944,6 @@ export declare class DocumentToolsClient extends APIClientBase {
     private updateDocDatesWithCallbacks;
     private processUpdateDocDatesWithCallbacks;
     protected processUpdateDocDates(xhr: any): string | null;
-    /**
-     * Returns the dates for the specified document
-     * @param id Document Key
-     */
-    getDocDates(id: string): Promise<DocDate[] | null>;
-    private getDocDatesWithCallbacks;
-    private processGetDocDatesWithCallbacks;
-    protected processGetDocDates(xhr: any): DocDate[] | null | null;
     /**
      * Information about actions for the specified document
      * @param id Document Key
@@ -2363,7 +2363,7 @@ export declare class DocumentToolsClient extends APIClientBase {
     private processGetDocSessionWithCallbacks;
     protected processGetDocSession(xhr: any): string | null | null;
     /**
-     * Ends the Document Session
+     * Ends the Document Session (see also EndDocSessionViaPost)
      * @param id Document Key
      * @param sessionID cache key or session
      */
@@ -2395,6 +2395,15 @@ export declare class DocumentToolsClient extends APIClientBase {
     protected processPatchDocData(xhr: any): {
         [key: string]: number;
     } | null | null;
+    /**
+     * Ends the Document Session (sendBeacon-friendly POST)
+     * @param id Document Key
+     * @param sessionID cache key or session
+     */
+    endDocSessionViaPost(id: string, sessionID: string | null): Promise<HttpStatusCode>;
+    private endDocSessionViaPostWithCallbacks;
+    private processEndDocSessionViaPostWithCallbacks;
+    protected processEndDocSessionViaPost(xhr: any): HttpStatusCode | null;
     /**
      * Modifies the current exclusivity of this document session
      * @param id Document Key
@@ -2716,7 +2725,7 @@ export declare class ProjectToolsClient extends APIClientBase {
     /**
      * Returns programs in which the specified project is listed
      * @param projectID Full Project ID
-     * @param programList list of programs
+     * @param programList list of programs by ProgramKey, PgmPjtMapKey or Program ID
      */
     removeProjectPrograms(projectID: string | null, programList: string[]): Promise<ProjectPrograms[] | null>;
     private removeProjectProgramsWithCallbacks;
@@ -6603,10 +6612,19 @@ export interface ProcessDocumentType {
     MobileDashboard?: boolean;
     /** When True, shown on project dashboards */
     ProjectDashboard?: boolean;
-    /** When True, can create from project dashboard */
-    NewFromDashboard?: boolean;
+    /** When True, tracks compliance */
+    CheckCompliance?: boolean;
+    /** When True, can be sync'd to cloud storage (other rules apply)   */
+    CloudSync?: boolean;
     /** When True, is created from a parent document */
     CreateFromParent?: boolean;
+    /** When True, Document Numbers are sequenced across projects (PO,Work Posted, etc)
+When False, numbers start over on every project (See DocNumbering | StartDocNumber) */
+    CrossProjectNumbering?: boolean;
+    /** When True, can create from project dashboard */
+    NewFromDashboard?: boolean;
+    /** When True, Project is an optional field (Rare) */
+    ProjectIsOptional?: boolean;
     /** When True, uses an item register */
     UseItemRegister?: boolean;
     /** When True, is Site Active */

package/dist/SwaggerClients.js

@@ -17459,6 +17459,61 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
+    /**
+     * Returns the dates for the specified document
+     * @param id Document Key
+     */
+    getDocDates(id) {
+        return new Promise((resolve, reject) => {
+            this.getDocDatesWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    getDocDatesWithCallbacks(id, onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/document/{id}/dates";
+        if (id === undefined || id === null)
+            throw new globalThis.Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        url_ = url_.replace(/[?&]$/, "");
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "get",
+            dataType: "text",
+            headers: {
+                "Accept": "application/json"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processGetDocDatesWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processGetDocDatesWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processGetDocDatesWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetDocDates(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processGetDocDates(xhr) {
+        const status = xhr.status;
+        let _headers = {};
+        if (status === 200) {
+            const _responseText = xhr.responseText;
+            let result200 = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result200;
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = xhr.responseText;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return null;
+    }
     /**
      * Deletes a specific date from the specified document
      * @param id Document Key
@@ -17633,61 +17688,6 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
-    /**
-     * Returns the dates for the specified document
-     * @param id Document Key
-     */
-    getDocDates(id) {
-        return new Promise((resolve, reject) => {
-            this.getDocDatesWithCallbacks(id, (result) => resolve(result), (exception, _reason) => reject(exception));
-        });
-    }
-    getDocDatesWithCallbacks(id, onSuccess, onFail) {
-        let url_ = this.baseUrl + "/api/document/{id}/dates";
-        if (id === undefined || id === null)
-            throw new globalThis.Error("The parameter 'id' must be defined.");
-        url_ = url_.replace("{id}", encodeURIComponent("" + id));
-        url_ = url_.replace(/[?&]$/, "");
-        jQuery.ajax({
-            url: url_,
-            beforeSend: this.beforeSend,
-            type: "get",
-            dataType: "text",
-            headers: {
-                "Accept": "application/json"
-            }
-        }).done((_data, _textStatus, xhr) => {
-            this.processGetDocDatesWithCallbacks(url_, xhr, onSuccess, onFail);
-        }).fail((xhr) => {
-            this.processGetDocDatesWithCallbacks(url_, xhr, onSuccess, onFail);
-        });
-    }
-    processGetDocDatesWithCallbacks(_url, xhr, onSuccess, onFail) {
-        try {
-            let result = this.transformResult(_url, xhr, (xhr) => this.processGetDocDates(xhr));
-            if (onSuccess !== undefined)
-                onSuccess(result);
-        }
-        catch (e) {
-            if (onFail !== undefined)
-                onFail(e, "http_service_exception");
-        }
-    }
-    processGetDocDates(xhr) {
-        const status = xhr.status;
-        let _headers = {};
-        if (status === 200) {
-            const _responseText = xhr.responseText;
-            let result200 = null;
-            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return result200;
-        }
-        else if (status !== 200 && status !== 204) {
-            const _responseText = xhr.responseText;
-            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
-        }
-        return null;
-    }
     /**
      * Information about actions for the specified document
      * @param id Document Key
@@ -21645,7 +21645,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Ends the Document Session
+     * Ends the Document Session (see also EndDocSessionViaPost)
      * @param id Document Key
      * @param sessionID cache key or session
      */
@@ -21932,6 +21932,96 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
+    /**
+     * Ends the Document Session (sendBeacon-friendly POST)
+     * @param id Document Key
+     * @param sessionID cache key or session
+     */
+    endDocSessionViaPost(id, sessionID) {
+        return new Promise((resolve, reject) => {
+            this.endDocSessionViaPostWithCallbacks(id, sessionID, (result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    endDocSessionViaPostWithCallbacks(id, sessionID, onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/document/{id}/session/end?";
+        if (id === undefined || id === null)
+            throw new globalThis.Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (sessionID === undefined)
+            throw new globalThis.Error("The parameter 'sessionID' must be defined.");
+        else if (sessionID !== null)
+            url_ += "sessionID=" + encodeURIComponent("" + sessionID) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "post",
+            dataType: "text",
+            headers: {
+                "Accept": "application/json"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processEndDocSessionViaPostWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processEndDocSessionViaPostWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processEndDocSessionViaPostWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processEndDocSessionViaPost(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processEndDocSessionViaPost(xhr) {
+        const status = xhr.status;
+        let _headers = {};
+        if (status === 200) {
+            const _responseText = xhr.responseText;
+            let result200 = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result200;
+        }
+        else if (status === 401) {
+            const _responseText = xhr.responseText;
+            let result401 = null;
+            result401 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not currently authenticated or lacks authorization", status, _responseText, _headers, result401);
+        }
+        else if (status === 403) {
+            const _responseText = xhr.responseText;
+            let result403 = null;
+            result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not currently authenticated or lacks authorization", status, _responseText, _headers, result403);
+        }
+        else if (status === 404) {
+            const _responseText = xhr.responseText;
+            let result404 = null;
+            result404 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Document not found, or not accessible", status, _responseText, _headers, result404);
+        }
+        else if (status === 406) {
+            const _responseText = xhr.responseText;
+            let result406 = null;
+            result406 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Not currently authenticated or lacks authorization", status, _responseText, _headers, result406);
+        }
+        else if (status === 500) {
+            const _responseText = xhr.responseText;
+            let result500 = null;
+            result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("Unexpected failure", status, _responseText, _headers, result500);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = xhr.responseText;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return null;
+    }
     /**
      * Modifies the current exclusivity of this document session
      * @param id Document Key
@@ -24629,7 +24719,7 @@ class ProjectToolsClient extends APIClientBase_1.APIClientBase {
     /**
      * Returns programs in which the specified project is listed
      * @param projectID Full Project ID
-     * @param programList list of programs
+     * @param programList list of programs by ProgramKey, PgmPjtMapKey or Program ID
      */
     removeProjectPrograms(projectID, programList) {
         return new Promise((resolve, reject) => {