spitfirepm 23.9600.12 → 23.9600.14

package/README.md

@@ -25,6 +25,7 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
+23.9600.13  - ARR cleanup
 23.9600.12  - ARR endpoints
 23.9600.11  - Adds Admin and Manage Tool Data Models and Endpoints
 23.9600.10  - Adds csi-maintenance

package/dist/SwaggerClients.d.ts

@@ -27,8 +27,8 @@ export declare class AccountClient extends APIClientBase {
     private processGetAccessAllowsWithCallbacks;
     protected processGetAccessAllows(xhr: any): PermissionFlags | null;
     /**
-     * Mint a short-lived download-session cookie
-     * @return Download cookie set (or an sfSession cookie was already present)
+     * Mint a short-lived download-ticket cookie
+     * @return Download ticket cookie set
      */
     postDownloadSession(): Promise<string>;
     private postDownloadSessionWithCallbacks;
@@ -384,13 +384,13 @@ export declare class ARRClient extends APIClientBase {
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(baseUrl?: string);
     /**
-     * Build the routed-content download package
+     * Queue the routed-content download package build
      * @param data download request {RouteID}
      */
-    getContent(data: ArrResponseData): Promise<string | null>;
+    getContent(data: ArrResponseData): Promise<string>;
     private getContentWithCallbacks;
     private processGetContentWithCallbacks;
-    protected processGetContent(xhr: any): string | null | null;
+    protected processGetContent(xhr: any): string | null;
     /**
      * Open a route-response link
      * @param request open request {StepKey, RouteID}
@@ -3389,6 +3389,17 @@ export declare class SystemClient extends APIClientBase {
     private getPublicResourceWithCallbacks;
     private processGetPublicResourceWithCallbacks;
     protected processGetPublicResource(xhr: any): string | null | null;
+    /**
+     * Returns the reCAPTCHA Enterprise site key
+     */
+    getRecaptchaConfig(): Promise<{
+        [key: string]: string;
+    } | null>;
+    private getRecaptchaConfigWithCallbacks;
+    private processGetRecaptchaConfigWithCallbacks;
+    protected processGetRecaptchaConfig(xhr: any): {
+        [key: string]: string;
+    } | null | null;
     /**
      * Returns statistical data
      * @param withDetails (optional)
@@ -3776,6 +3787,8 @@ export interface ArrOpenRequest {
     StepKey?: string;
     /** RouteID from the link. */
     RouteID?: string;
+    /** reCAPTCHA Enterprise token from the client, assessed before the route is resolved. */
+    RecaptchaToken?: string | undefined;
 }
 /** Everything the Webix arr view needs to render, plus the (optional) ARR session token. */
 export interface ArrOpenResult {

package/dist/SwaggerClients.js

@@ -233,8 +233,8 @@ class AccountClient extends APIClientBase_1.APIClientBase {
         return null;
     }
     /**
-     * Mint a short-lived download-session cookie
-     * @return Download cookie set (or an sfSession cookie was already present)
+     * Mint a short-lived download-ticket cookie
+     * @return Download ticket cookie set
      */
     postDownloadSession() {
         return new Promise((resolve, reject) => {
@@ -282,7 +282,7 @@ class AccountClient extends APIClientBase_1.APIClientBase {
             const _responseText = xhr.responseText;
             let result401 = null;
             result401 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("No recognized identity", status, _responseText, _headers, result401);
+            return throwException("No download-session token presented", status, _responseText, _headers, result401);
         }
         else if (status !== 200 && status !== 204) {
             const _responseText = xhr.responseText;
@@ -637,6 +637,12 @@ class AccountClient extends APIClientBase_1.APIClientBase {
             result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
             return throwException("Not allowed", 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("Backend 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);
@@ -2925,7 +2931,7 @@ class ARRClient extends APIClientBase_1.APIClientBase {
         this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
     }
     /**
-     * Build the routed-content download package
+     * Queue the routed-content download package build
      * @param data download request {RouteID}
      */
     getContent(data) {
@@ -2995,7 +3001,7 @@ class ARRClient extends APIClientBase_1.APIClientBase {
             const _responseText = xhr.responseText;
             let result500 = null;
             result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
-            return throwException("Could not build package; see response", status, _responseText, _headers, result500);
+            return throwException("Could not queue package build; see response", status, _responseText, _headers, result500);
         }
         else if (status !== 200 && status !== 204) {
             const _responseText = xhr.responseText;
@@ -3058,6 +3064,12 @@ class ARRClient extends APIClientBase_1.APIClientBase {
             result400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
             return throwException("Keys missing or malformed", status, _responseText, _headers, result400);
         }
+        else if (status === 403) {
+            const _responseText = xhr.responseText;
+            let result403 = null;
+            result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
+            return throwException("reCAPTCHA verification failed", status, _responseText, _headers, result403);
+        }
         else if (status === 404) {
             const _responseText = xhr.responseText;
             let result404 = null;
@@ -30199,6 +30211,57 @@ class SystemClient extends APIClientBase_1.APIClientBase {
         }
         return null;
     }
+    /**
+     * Returns the reCAPTCHA Enterprise site key
+     */
+    getRecaptchaConfig() {
+        return new Promise((resolve, reject) => {
+            this.getRecaptchaConfigWithCallbacks((result) => resolve(result), (exception, _reason) => reject(exception));
+        });
+    }
+    getRecaptchaConfigWithCallbacks(onSuccess, onFail) {
+        let url_ = this.baseUrl + "/api/system/recaptcha";
+        url_ = url_.replace(/[?&]$/, "");
+        jQuery.ajax({
+            url: url_,
+            beforeSend: this.beforeSend,
+            type: "get",
+            dataType: "text",
+            headers: {
+                "Accept": "application/json"
+            }
+        }).done((_data, _textStatus, xhr) => {
+            this.processGetRecaptchaConfigWithCallbacks(url_, xhr, onSuccess, onFail);
+        }).fail((xhr) => {
+            this.processGetRecaptchaConfigWithCallbacks(url_, xhr, onSuccess, onFail);
+        });
+    }
+    processGetRecaptchaConfigWithCallbacks(_url, xhr, onSuccess, onFail) {
+        try {
+            let result = this.transformResult(_url, xhr, (xhr) => this.processGetRecaptchaConfig(xhr));
+            if (onSuccess !== undefined)
+                onSuccess(result);
+        }
+        catch (e) {
+            if (onFail !== undefined)
+                onFail(e, "http_service_exception");
+        }
+    }
+    processGetRecaptchaConfig(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;
+    }
     /**
      * Returns statistical data
      * @param withDetails (optional)