spitfirepm 23.9600.12 → 23.9600.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -25,6 +25,7 @@ apiResult.then( (a) => {
25
25
  ### Change Log
26
26
 
27
27
  ```
28
+ 23.9600.13 - ARR cleanup
28
29
  23.9600.12 - ARR endpoints
29
30
  23.9600.11 - Adds Admin and Manage Tool Data Models and Endpoints
30
31
  23.9600.10 - Adds csi-maintenance
@@ -27,8 +27,8 @@ export declare class AccountClient extends APIClientBase {
27
27
  private processGetAccessAllowsWithCallbacks;
28
28
  protected processGetAccessAllows(xhr: any): PermissionFlags | null;
29
29
  /**
30
- * Mint a short-lived download-session cookie
31
- * @return Download cookie set (or an sfSession cookie was already present)
30
+ * Mint a short-lived download-ticket cookie
31
+ * @return Download ticket cookie set
32
32
  */
33
33
  postDownloadSession(): Promise<string>;
34
34
  private postDownloadSessionWithCallbacks;
@@ -3389,6 +3389,17 @@ export declare class SystemClient extends APIClientBase {
3389
3389
  private getPublicResourceWithCallbacks;
3390
3390
  private processGetPublicResourceWithCallbacks;
3391
3391
  protected processGetPublicResource(xhr: any): string | null | null;
3392
+ /**
3393
+ * Returns the reCAPTCHA Enterprise site key
3394
+ */
3395
+ getRecaptchaConfig(): Promise<{
3396
+ [key: string]: string;
3397
+ } | null>;
3398
+ private getRecaptchaConfigWithCallbacks;
3399
+ private processGetRecaptchaConfigWithCallbacks;
3400
+ protected processGetRecaptchaConfig(xhr: any): {
3401
+ [key: string]: string;
3402
+ } | null | null;
3392
3403
  /**
3393
3404
  * Returns statistical data
3394
3405
  * @param withDetails (optional)
@@ -3776,6 +3787,8 @@ export interface ArrOpenRequest {
3776
3787
  StepKey?: string;
3777
3788
  /** RouteID from the link. */
3778
3789
  RouteID?: string;
3790
+ /** reCAPTCHA Enterprise token from the client, assessed before the route is resolved. */
3791
+ RecaptchaToken?: string | undefined;
3779
3792
  }
3780
3793
  /** Everything the Webix arr view needs to render, plus the (optional) ARR session token. */
3781
3794
  export interface ArrOpenResult {
@@ -16,7 +16,7 @@ class AccountClient extends APIClientBase_1.APIClientBase {
16
16
  jsonParseReviver = undefined;
17
17
  constructor(baseUrl) {
18
18
  super();
19
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
19
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
20
20
  }
21
21
  /**
22
22
  * Authenticates a session and generates a FormsAuthenticationTicket and cookie
@@ -233,8 +233,8 @@ class AccountClient extends APIClientBase_1.APIClientBase {
233
233
  return null;
234
234
  }
235
235
  /**
236
- * Mint a short-lived download-session cookie
237
- * @return Download cookie set (or an sfSession cookie was already present)
236
+ * Mint a short-lived download-ticket cookie
237
+ * @return Download ticket cookie set
238
238
  */
239
239
  postDownloadSession() {
240
240
  return new Promise((resolve, reject) => {
@@ -282,7 +282,7 @@ class AccountClient extends APIClientBase_1.APIClientBase {
282
282
  const _responseText = xhr.responseText;
283
283
  let result401 = null;
284
284
  result401 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
285
- return throwException("No recognized identity", status, _responseText, _headers, result401);
285
+ return throwException("No download-session token presented", status, _responseText, _headers, result401);
286
286
  }
287
287
  else if (status !== 200 && status !== 204) {
288
288
  const _responseText = xhr.responseText;
@@ -637,6 +637,12 @@ class AccountClient extends APIClientBase_1.APIClientBase {
637
637
  result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
638
638
  return throwException("Not allowed", status, _responseText, _headers, result403);
639
639
  }
640
+ else if (status === 500) {
641
+ const _responseText = xhr.responseText;
642
+ let result500 = null;
643
+ result500 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
644
+ return throwException("Backend failure", status, _responseText, _headers, result500);
645
+ }
640
646
  else if (status !== 200 && status !== 204) {
641
647
  const _responseText = xhr.responseText;
642
648
  return throwException("An unexpected server error occurred.", status, _responseText, _headers);
@@ -651,7 +657,7 @@ class ActionItemsClient extends APIClientBase_1.APIClientBase {
651
657
  jsonParseReviver = undefined;
652
658
  constructor(baseUrl) {
653
659
  super();
654
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
660
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
655
661
  }
656
662
  /**
657
663
  * Returns action items for specified User
@@ -1100,7 +1106,7 @@ class AlertsClient extends APIClientBase_1.APIClientBase {
1100
1106
  jsonParseReviver = undefined;
1101
1107
  constructor(baseUrl) {
1102
1108
  super();
1103
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
1109
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
1104
1110
  }
1105
1111
  /**
1106
1112
  * Returns alert items for a specified user
@@ -1510,7 +1516,7 @@ class LookupClient extends APIClientBase_1.APIClientBase {
1510
1516
  jsonParseReviver = undefined;
1511
1517
  constructor(baseUrl) {
1512
1518
  super();
1513
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
1519
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
1514
1520
  }
1515
1521
  /**
1516
1522
  * Returns list of alerts that are recorded about the specified source key
@@ -2922,7 +2928,7 @@ class ARRClient extends APIClientBase_1.APIClientBase {
2922
2928
  jsonParseReviver = undefined;
2923
2929
  constructor(baseUrl) {
2924
2930
  super();
2925
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
2931
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
2926
2932
  }
2927
2933
  /**
2928
2934
  * Build the routed-content download package
@@ -3058,6 +3064,12 @@ class ARRClient extends APIClientBase_1.APIClientBase {
3058
3064
  result400 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
3059
3065
  return throwException("Keys missing or malformed", status, _responseText, _headers, result400);
3060
3066
  }
3067
+ else if (status === 403) {
3068
+ const _responseText = xhr.responseText;
3069
+ let result403 = null;
3070
+ result403 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
3071
+ return throwException("reCAPTCHA verification failed", status, _responseText, _headers, result403);
3072
+ }
3061
3073
  else if (status === 404) {
3062
3074
  const _responseText = xhr.responseText;
3063
3075
  let result404 = null;
@@ -3169,7 +3181,7 @@ class CatalogClient extends APIClientBase_1.APIClientBase {
3169
3181
  jsonParseReviver = undefined;
3170
3182
  constructor(baseUrl) {
3171
3183
  super();
3172
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
3184
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
3173
3185
  }
3174
3186
  /**
3175
3187
  * Releases a resource, usually a PDF of a report or export
@@ -6552,7 +6564,7 @@ class ConfigClient extends APIClientBase_1.APIClientBase {
6552
6564
  jsonParseReviver = undefined;
6553
6565
  constructor(baseUrl) {
6554
6566
  super();
6555
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
6567
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
6556
6568
  }
6557
6569
  /**
6558
6570
  * Updates a flex key by name and segment number. Returns the new definition.
@@ -13242,7 +13254,7 @@ class ContactClient extends APIClientBase_1.APIClientBase {
13242
13254
  jsonParseReviver = undefined;
13243
13255
  constructor(baseUrl) {
13244
13256
  super();
13245
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
13257
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
13246
13258
  }
13247
13259
  /**
13248
13260
  * Adds the contact
@@ -13553,7 +13565,7 @@ class DocumentToolsClient extends APIClientBase_1.APIClientBase {
13553
13565
  jsonParseReviver = undefined;
13554
13566
  constructor(baseUrl) {
13555
13567
  super();
13556
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
13568
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
13557
13569
  }
13558
13570
  /**
13559
13571
  * Returns the header Of the specified document, including a Document Session Key
@@ -22278,7 +22290,7 @@ class ExcelToolsClient extends APIClientBase_1.APIClientBase {
22278
22290
  jsonParseReviver = undefined;
22279
22291
  constructor(baseUrl) {
22280
22292
  super();
22281
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
22293
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
22282
22294
  }
22283
22295
  /**
22284
22296
  * Returns a financial snapshot
@@ -23069,7 +23081,7 @@ class ProjectToolsClient extends APIClientBase_1.APIClientBase {
23069
23081
  jsonParseReviver = undefined;
23070
23082
  constructor(baseUrl) {
23071
23083
  super();
23072
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
23084
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
23073
23085
  }
23074
23086
  /**
23075
23087
  * Removes/clears a Project Budget and optionally the entire Project (if uncommitted)
@@ -25270,7 +25282,7 @@ class ProjectDocListClient extends APIClientBase_1.APIClientBase {
25270
25282
  jsonParseReviver = undefined;
25271
25283
  constructor(baseUrl) {
25272
25284
  super();
25273
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
25285
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
25274
25286
  }
25275
25287
  /**
25276
25288
  * Returns full list of documents on a project that match the requested document type
@@ -25594,7 +25606,7 @@ class ProjectKPIClient extends APIClientBase_1.APIClientBase {
25594
25606
  jsonParseReviver = undefined;
25595
25607
  constructor(baseUrl) {
25596
25608
  super();
25597
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
25609
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
25598
25610
  }
25599
25611
  /**
25600
25612
  * Returns list of KPI facts for the specified project
@@ -25677,7 +25689,7 @@ class ProjectTeamClient extends APIClientBase_1.APIClientBase {
25677
25689
  jsonParseReviver = undefined;
25678
25690
  constructor(baseUrl) {
25679
25691
  super();
25680
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
25692
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
25681
25693
  }
25682
25694
  /**
25683
25695
  * Returns members of the specified project team
@@ -26207,7 +26219,7 @@ class ProjectsClient extends APIClientBase_1.APIClientBase {
26207
26219
  jsonParseReviver = undefined;
26208
26220
  constructor(baseUrl) {
26209
26221
  super();
26210
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
26222
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
26211
26223
  }
26212
26224
  /**
26213
26225
  * Returns projects that match User and hidden filter
@@ -26733,7 +26745,7 @@ class SessionClient extends APIClientBase_1.APIClientBase {
26733
26745
  jsonParseReviver = undefined;
26734
26746
  constructor(baseUrl) {
26735
26747
  super();
26736
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
26748
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
26737
26749
  }
26738
26750
  /**
26739
26751
  * Removes a specific users session; see also api/system/users/idle to auto-prune
@@ -28855,7 +28867,7 @@ class SystemClient extends APIClientBase_1.APIClientBase {
28855
28867
  jsonParseReviver = undefined;
28856
28868
  constructor(baseUrl) {
28857
28869
  super();
28858
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
28870
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
28859
28871
  }
28860
28872
  /**
28861
28873
  * Returns site branding label
@@ -30199,6 +30211,57 @@ class SystemClient extends APIClientBase_1.APIClientBase {
30199
30211
  }
30200
30212
  return null;
30201
30213
  }
30214
+ /**
30215
+ * Returns the reCAPTCHA Enterprise site key
30216
+ */
30217
+ getRecaptchaConfig() {
30218
+ return new Promise((resolve, reject) => {
30219
+ this.getRecaptchaConfigWithCallbacks((result) => resolve(result), (exception, _reason) => reject(exception));
30220
+ });
30221
+ }
30222
+ getRecaptchaConfigWithCallbacks(onSuccess, onFail) {
30223
+ let url_ = this.baseUrl + "/api/system/recaptcha";
30224
+ url_ = url_.replace(/[?&]$/, "");
30225
+ jQuery.ajax({
30226
+ url: url_,
30227
+ beforeSend: this.beforeSend,
30228
+ type: "get",
30229
+ dataType: "text",
30230
+ headers: {
30231
+ "Accept": "application/json"
30232
+ }
30233
+ }).done((_data, _textStatus, xhr) => {
30234
+ this.processGetRecaptchaConfigWithCallbacks(url_, xhr, onSuccess, onFail);
30235
+ }).fail((xhr) => {
30236
+ this.processGetRecaptchaConfigWithCallbacks(url_, xhr, onSuccess, onFail);
30237
+ });
30238
+ }
30239
+ processGetRecaptchaConfigWithCallbacks(_url, xhr, onSuccess, onFail) {
30240
+ try {
30241
+ let result = this.transformResult(_url, xhr, (xhr) => this.processGetRecaptchaConfig(xhr));
30242
+ if (onSuccess !== undefined)
30243
+ onSuccess(result);
30244
+ }
30245
+ catch (e) {
30246
+ if (onFail !== undefined)
30247
+ onFail(e, "http_service_exception");
30248
+ }
30249
+ }
30250
+ processGetRecaptchaConfig(xhr) {
30251
+ const status = xhr.status;
30252
+ let _headers = {};
30253
+ if (status === 200) {
30254
+ const _responseText = xhr.responseText;
30255
+ let result200 = null;
30256
+ result200 = _responseText === "" ? null : JSON.parse(_responseText, this.jsonParseReviver);
30257
+ return result200;
30258
+ }
30259
+ else if (status !== 200 && status !== 204) {
30260
+ const _responseText = xhr.responseText;
30261
+ return throwException("An unexpected server error occurred.", status, _responseText, _headers);
30262
+ }
30263
+ return null;
30264
+ }
30202
30265
  /**
30203
30266
  * Returns statistical data
30204
30267
  * @param withDetails (optional)
@@ -30548,7 +30611,7 @@ class UICFGClient extends APIClientBase_1.APIClientBase {
30548
30611
  jsonParseReviver = undefined;
30549
30612
  constructor(baseUrl) {
30550
30613
  super();
30551
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
30614
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
30552
30615
  }
30553
30616
  /**
30554
30617
  * Returns Live UI CFG data for this user for the requested part
@@ -31017,7 +31080,7 @@ class XTSClient extends APIClientBase_1.APIClientBase {
31017
31080
  jsonParseReviver = undefined;
31018
31081
  constructor(baseUrl) {
31019
31082
  super();
31020
- this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/SFPMS");
31083
+ this.baseUrl = baseUrl ?? this.getBaseUrl("https://dev.spitfirepm.com:8443/sfPMS");
31021
31084
  }
31022
31085
  /**
31023
31086
  * Requests the document be requeued for cloud sync