spitfirepm 23.9700.5 → 23.9700.7

package/README.md

@@ -25,6 +25,8 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
+23.9700.7   - GetDV method clarifications
+23.9700.6   - Audit History Model enhanced
 23.9700.5   - Lookup Editor Endpoints
 23.9700.2   - ProcessDocumentType DataModel enriched
 23.9700.1   - GatherDependsOnValues() improved

package/dist/SwaggerClients.d.ts

@@ -240,7 +240,7 @@ export declare class LookupClient extends APIClientBase {
     /**
      * Returns list of prior values for this field
      * @param dataMember Name of table
-     * @param dataField Name of field
+     * @param dataField Name of field; use zero for all fields
      * @param rowKey PK identifier of specific record
      * @param sinceWhen (optional) Optional date since when data should be returned
      */
@@ -560,6 +560,14 @@ export declare class CatalogClient extends APIClientBase {
     private deleteFileWithCallbacks;
     private processDeleteFileWithCallbacks;
     protected processDeleteFile(xhr: any): any | null;
+    /**
+     * Returns a site helper script, stylesheet or image held in the catalog
+     * @param assetPath Path below /zPublicHTML, eg js/XTSDocHelper.js
+     */
+    getPublicAsset(assetPath: string | null): Promise<any>;
+    private getPublicAssetWithCallbacks;
+    private processGetPublicAssetWithCallbacks;
+    protected processGetPublicAsset(xhr: any): any | null;
     /**
      * Returns a background task ID and initiates a task to build a PDF of all documents enumerated in the exportRequest
      * @param exportRequest Specifics for export requested
@@ -3682,25 +3690,21 @@ export declare class XTSClient extends APIClientBase {
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(baseUrl?: string);
     /**
-     * Requests the document be requeued for cloud sync
+     * Requests the document's cloud folder be requeued for an inbound scan
      * @param fileKey (optional)
-     * @return Request enqueued
+     * @return Scan queued - XTSCloudRequeue reported Updated
      */
     cloudSyncDocPUT(id: string, fileKey?: string | null | undefined): Promise<string>;
     private cloudSyncDocPUTWithCallbacks;
     private processCloudSyncDocPUTWithCallbacks;
     protected processCloudSyncDocPUT(xhr: any): string | null;
     /**
-     * Requests information about the document related to cloud storage
+     * Returns cloud storage information for a document's published folder
      */
-    cloudSyncDocGET(id: string): Promise<{
-        [key: string]: any;
-    } | null>;
+    cloudSyncDocGET(id: string): Promise<CloudFolderInfo | null>;
     private cloudSyncDocGETWithCallbacks;
     private processCloudSyncDocGETWithCallbacks;
-    protected processCloudSyncDocGET(xhr: any): {
-        [key: string]: any;
-    } | null | null;
+    protected processCloudSyncDocGET(xhr: any): CloudFolderInfo | null | null;
     /**
      * Requests all compliance items that have changed since the last key map update
      */
@@ -4213,6 +4217,14 @@ export interface CloudChange {
     removed?: boolean;
     WhenModified?: Date;
 }
+export interface CloudFolderInfo {
+    KMK?: string;
+    path?: string | undefined;
+    id?: string | undefined;
+    scanned?: string | undefined;
+    url?: string | undefined;
+    error?: string | undefined;
+}
 /** A single cloud-storage definition.  Mirrors the CloudStore table in LVData.xsd; consumed by the System Admin Dashboard Cloud Storage tool.  The Have*Secret flags report whether a secret is on file without exposing it. */
 export interface CloudStore {
     /** Row key (xsfCldStore) */
@@ -6137,11 +6149,17 @@ export interface FieldAudit {
     /** when the change was persisted */
     ChangeWhen?: Date;
     /** string representation of the prior field value */
-    PriorValue?: any | undefined;
+    PriorValue?: string | undefined;
     /** string representation of the new field value */
     NewValue?: string | undefined;
     /** user that made the change */
     ByUser?: string | undefined;
+    /** The column that was changed in table.field format */
+    ColName?: string | undefined;
+    /** When true, this entry was inferred by a gap */
+    IsInferred?: boolean;
+    /** When true, this value is a guid  */
+    IsGuid?: boolean;
     /** eTag */
     ETag?: string | undefined;
 }

package/dist/SwaggerClients.js

@@ -1984,7 +1984,7 @@ class LookupClient extends APIClientBase_1.APIClientBase {
     /**
      * Returns list of prior values for this field
      * @param dataMember Name of table
-     * @param dataField Name of field
+     * @param dataField Name of field; use zero for all fields
      * @param rowKey PK identifier of specific record
      * @param sinceWhen (optional) Optional date since when data should be returned
      */
@@ -4490,6 +4490,79 @@ class CatalogClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
+    /**
+     * Returns a site helper script, stylesheet or image held in the catalog
+     * @param assetPath Path below /zPublicHTML, eg js/XTSDocHelper.js
+     */
+    getPublicAsset(assetPath) {
+        return new Promise((resolve, reject) => {
+            this.getPublicAssetWithCallbacks(assetPath, (result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    getPublicAssetWithCallbacks(assetPath, onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/catalog/asset/{assetPath}";
+        if (assetPath === undefined || assetPath === null)
+            throw new globalThis.Error("The parameter 'assetPath' must be defined.");
+        url_ = url_.replace("{assetPath}", encodeURIComponent("" + assetPath));
+        url_ = url_.replace(/[?&]$/, "");
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "get",
+            dataType: "text",
+            headers: {
+                "Accept": "application/octet-stream"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processGetPublicAssetWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processGetPublicAssetWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processGetPublicAssetWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetPublicAsset(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processGetPublicAsset(xhr) {
+        const status = xhr.status;
+        let _headers = {};
+        if (status === 200 || status === 206) {
+            const _responseText = xhr.responseText;
+            let result200 = null;
+            result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return result200;
+        }
+        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("No such file in this site\'s catalog", status, _responseText, _headers, result404);
+        }
+        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;
+    }
     /**
      * Returns a background task ID and initiates a task to build a PDF of all documents enumerated in the exportRequest
      * @param exportRequest Specifics for export requested
@@ -32621,9 +32694,9 @@ class XTSClient extends APIClientBase_1.APIClientBase {
         this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
     }
     /**
-     * Requests the document be requeued for cloud sync
+     * Requests the document's cloud folder be requeued for an inbound scan
      * @param fileKey (optional)
-     * @return Request enqueued
+     * @return Scan queued - XTSCloudRequeue reported Updated
      */
     cloudSyncDocPUT(id, fileKey) {
         return new Promise((resolve, reject) => {
@@ -32672,12 +32745,6 @@ class XTSClient extends APIClientBase_1.APIClientBase {
             result202 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
             return result202;
         }
-        else if (status === 400) {
-            const _responseText = xhr.responseText;
-            let result400 = null;
-            result400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Peer and message (body) both required", status, _responseText, _headers, result400);
-        }
         else if (status === 401) {
             const _responseText = xhr.responseText;
             let result401 = null;
@@ -32688,13 +32755,13 @@ class XTSClient extends APIClientBase_1.APIClientBase {
             const _responseText = xhr.responseText;
             let result403 = null;
             result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Not a valid peer", status, _responseText, _headers, result403);
+            return throwException("Requires DOC | Attachments with Update", status, _responseText, _headers, result403);
         }
         else if (status === 500) {
             const _responseText = xhr.responseText;
             let result500 = null;
             result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Failure", status, _responseText, _headers, result500);
+            return throwException("No scan was queued - XTSCloudRequeue reported Failed, or an exception occurred", status, _responseText, _headers, result500);
         }
         else if (status !== 200 && status !== 204) {
             const _responseText = xhr.responseText;
@@ -32703,7 +32770,7 @@ class XTSClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Requests information about the document related to cloud storage
+     * Returns cloud storage information for a document's published folder
      */
     cloudSyncDocGET(id) {
         return new Promise((resolve, reject) => {