spitfirepm 23.9500.13 → 23.9600.3

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,8 @@ apiResult.then( (a) => {
25
25
  ### Change Log
26
26
 
27
27
  ```
28
+ 23.9600.3 - Adds PresetSearch ShowTree
29
+ 23.9600.1 - Constructing a view model of 3000 records and many fields improved
28
30
  23.9500.12 - DataModels are now interfaces instead of classes (increases ES2022 compatability)
29
31
  23.9500.11 - Adds Preset Search FolderSource
30
32
  23.9500.8 - Vite 8 compatibility
@@ -396,9 +396,9 @@ export declare class CatalogClient extends APIClientBase {
396
396
  private processCatalogAndAttachWithCallbacks;
397
397
  protected processCatalogAndAttach(xhr: any): string | null | null;
398
398
  /**
399
- * Sends a resource file to the current user via email
399
+ * Sends a resource file To the current user via email
400
400
  * @param fileKey Catalog File Key
401
- * @param location Specifies where to look for the specified key. Use CK, CRT, RS
401
+ * @param location Specifies where To look For the specified key. Use CK, CRT, RS
402
402
  * @param refDMK (optional) Specifies the related document key
403
403
  */
404
404
  sendFile(fileKey: string, location: string | null, refDMK?: string | null | undefined): Promise<string | null>;
@@ -414,7 +414,7 @@ export declare class CatalogClient extends APIClientBase {
414
414
  private processGetCatalogAccessHistoryWithCallbacks;
415
415
  protected processGetCatalogAccessHistory(xhr: any): FileAccessHistory[] | null | null;
416
416
  /**
417
- * Gets share state of file (check in/out, lock, etc
417
+ * Gets share state Of file (check In/out, lock, etc
418
418
  * @param fileKey Catalog File Key
419
419
  */
420
420
  getFileAccessControl(fileKey: string): Promise<FileInformation | null>;
@@ -422,10 +422,10 @@ export declare class CatalogClient extends APIClientBase {
422
422
  private processGetFileAccessControlWithCallbacks;
423
423
  protected processGetFileAccessControl(xhr: any): FileInformation | null | null;
424
424
  /**
425
- * Changes share state of file (check in/out, lock, etc
425
+ * Changes share state Of file (check In/out, lock, etc
426
426
  * @param fileKey Catalog File Key
427
427
  * @param newStatus New Status O(ut);L(ock);U(nlock);I(n);X(cancel);SYS
428
- * @param expires (optional) When a checkout or lock expires
428
+ * @param expires (optional) When a checkout Or lock expires
429
429
  */
430
430
  updateFileAccess(fileKey: string, newStatus: string | null, expires?: Date | undefined): Promise<boolean>;
431
431
  private updateFileAccessWithCallbacks;
@@ -562,8 +562,8 @@ export declare class CatalogClient extends APIClientBase {
562
562
  protected processAddFolder(xhr: any): FileInformation | null | null;
563
563
  /**
564
564
  * Returns a list of files in the specified location
565
- * @param folderDesignation Catalog Folder ID (GUID or root)
566
- * @param catalogFilters ClientDataSummary (of FileKey and eTags) and Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
565
+ * @param folderDesignation Catalog Folder ID (GUID Or root)
566
+ * @param catalogFilters ClientDataSummary (of FileKey And eTags) And Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used UserKey, FileKey, DocMasterKey(attached To), MaxItems, TimeoutFactor
567
567
  */
568
568
  getChangedFolderContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<DataDifferential | null>;
569
569
  private getChangedFolderContentsWithCallbacks;
@@ -612,7 +612,7 @@ export declare class CatalogClient extends APIClientBase {
612
612
  private processMoveIntoFolderWithCallbacks;
613
613
  protected processMoveIntoFolder(xhr: any): FileInformation | null | null;
614
614
  /**
615
- * Returns URI for appropriate icon
615
+ * Returns URI For appropriate icon
616
616
  * @param fileType File type such As PDF, DOCX, etc
617
617
  * @param iconSize (optional) 16,20,24,32 etc; small(20); big(32)
618
618
  */
@@ -621,9 +621,9 @@ export declare class CatalogClient extends APIClientBase {
621
621
  private processGetIconForTypeWithCallbacks;
622
622
  protected processGetIconForType(xhr: any): any | null;
623
623
  /**
624
- * Returns URI for appropriate icon for each file type
624
+ * Returns URI For appropriate icon For Each file type
625
625
  * @param iconSize (optional) 16,20,24,32 etc; small(20); big(32)
626
- * @param eTag (optional) Returns nothing if eTag matches supplied eTag
626
+ * @param eTag (optional) Returns Nothing If eTag matches supplied eTag
627
627
  */
628
628
  getIconListByType(iconSize?: string | null | undefined, eTag?: string | null | undefined): Promise<any>;
629
629
  private getIconListByTypeWithCallbacks;
@@ -664,7 +664,7 @@ export declare class CatalogClient extends APIClientBase {
664
664
  private processDeleteObjectWithCallbacks;
665
665
  protected processDeleteObject(xhr: any): any | null;
666
666
  /**
667
- * Returns settings for a preset search
667
+ * Returns settings For a preset search
668
668
  * @param setID Set ID
669
669
  */
670
670
  postPresetSearch(setID: string | null): Promise<CatalogPreset | null>;
@@ -672,7 +672,7 @@ export declare class CatalogClient extends APIClientBase {
672
672
  private processPostPresetSearchWithCallbacks;
673
673
  protected processPostPresetSearch(xhr: any): CatalogPreset | null | null;
674
674
  /**
675
- * Returns settings for a preset search
675
+ * Returns settings For a preset search
676
676
  * @param setID Set ID
677
677
  */
678
678
  getPresetSearch(setID: string | null): Promise<CatalogPreset | null>;
@@ -687,18 +687,18 @@ export declare class CatalogClient extends APIClientBase {
687
687
  private processGetRootFolderNameWithCallbacks;
688
688
  protected processGetRootFolderName(xhr: any): any | null;
689
689
  /**
690
- * Returns changes to the list of files and folders that match the criteria
691
- * @param folderDesignation Catalog Folder ID (GUID or ROOT)
692
- * @param catalogFilters ClientDataSummary (of FileKey and eTags) and Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
690
+ * Returns changes to the list of files And folders that match the criteria
691
+ * @param folderDesignation Catalog Folder ID (GUID Or ROOT)
692
+ * @param catalogFilters ClientDataSummary (of FileKey And eTags) And Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used UserKey, FileKey, DocMasterKey(attached To), MaxItems, TimeoutFactor
693
693
  */
694
694
  getChangedSearchContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<DataDifferential | null>;
695
695
  private getChangedSearchContentsWithCallbacks;
696
696
  private processGetChangedSearchContentsWithCallbacks;
697
697
  protected processGetChangedSearchContents(xhr: any): DataDifferential | null | null;
698
698
  /**
699
- * Returns a list of files and folders that match the criteria
700
- * @param folderDesignation Catalog Folder ID (GUID or ROOT)
701
- * @param catalogFilters Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used: UserKey, FileKey, DocMasterKey (attached to), MaxItems, TimeoutFactor
699
+ * Returns a list of files And folders that match the criteria
700
+ * @param folderDesignation Catalog Folder ID (GUID Or ROOT)
701
+ * @param catalogFilters Additional Filters, including ProjectLike, TitleLike (filename), ContainsText, HasHash, DocNoLike, ForDocType, PrimaryDateRange, RefDateRange; seldom used UserKey, FileKey, DocMasterKey(attached To), MaxItems, TimeoutFactor
702
702
  */
703
703
  searchContents(folderDesignation: string | null, catalogFilters: QueryFilters): Promise<FileInformation[] | null>;
704
704
  private searchContentsWithCallbacks;
@@ -736,6 +736,7 @@ export declare class CatalogClient extends APIClientBase {
736
736
  protected processUploadChunk(xhr: any): XferFilesStatus[] | null | null;
737
737
  /**
738
738
  * Returns the tree Of folders
739
+ * @param folderSource Blank or Catalog for standard folders, D3 for Dynamic Document Depth
739
740
  */
740
741
  getFolderTree(folderSource: string | null): Promise<FileInformation[] | null>;
741
742
  private getFolderTreeWithCallbacks;
@@ -843,14 +844,6 @@ export declare class DocumentToolsClient extends APIClientBase {
843
844
  beforeSend: any;
844
845
  protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
845
846
  constructor(baseUrl?: string);
846
- /**
847
- * Returns the header Of the specified document, including a Document Session Key
848
- * @param id Document Key
849
- */
850
- getDocHeader(id: string): Promise<DocMasterDetail | null>;
851
- private getDocHeaderWithCallbacks;
852
- private processGetDocHeaderWithCallbacks;
853
- protected processGetDocHeader(xhr: any): DocMasterDetail | null | null;
854
847
  /**
855
848
  * Deletes the specified document
856
849
  * @param id Document Key
@@ -868,6 +861,14 @@ export declare class DocumentToolsClient extends APIClientBase {
868
861
  private updateDocHeaderWithCallbacks;
869
862
  private processUpdateDocHeaderWithCallbacks;
870
863
  protected processUpdateDocHeader(xhr: any): any | null;
864
+ /**
865
+ * Returns the header Of the specified document, including a Document Session Key
866
+ * @param id Document Key
867
+ */
868
+ getDocHeader(id: string): Promise<DocMasterDetail | null>;
869
+ private getDocHeaderWithCallbacks;
870
+ private processGetDocHeaderWithCallbacks;
871
+ protected processGetDocHeader(xhr: any): DocMasterDetail | null | null;
871
872
  /**
872
873
  * Updates a Single field On the header Of the specified document
873
874
  * @param id Document Key
@@ -1748,7 +1749,7 @@ export declare class DocumentToolsClient extends APIClientBase {
1748
1749
  protected processGetDocState(xhr: any): DocumentState | null | null;
1749
1750
  /**
1750
1751
  * Returns list of tabs
1751
- * @param id Document Key
1752
+ * @param id Document Key or Document Type Key
1752
1753
  */
1753
1754
  getDocTabs(id: string): Promise<TabStripDetails[] | null>;
1754
1755
  private getDocTabsWithCallbacks;
@@ -3205,6 +3206,8 @@ applies to DUE date filtering */
3205
3206
  IncludeDocuments?: boolean;
3206
3207
  /** when true, includes Files in the search result (sets hidden filter) */
3207
3208
  IncludeFiles?: boolean;
3209
+ /** when true, shows the folder tree panel */
3210
+ ShowTree?: boolean;
3208
3211
  /** Subtype (sets filter) */
3209
3212
  Subtype?: string | undefined;
3210
3213
  /** Page Title */