@laserfiche/types-lf-ui-components 13.1.0--preview-2927979043 → 13.1.0

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.
Files changed (2) hide show
  1. package/index.d.ts +12 -15
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -705,7 +705,7 @@ export declare class LfRepositoryBrowserComponent {
705
705
  * @param provider LfRepositoryService service
706
706
  * @param selectedNode the id of the node to select, or a Entry starting from the selected entry
707
707
  */
708
- initAsync: (treeNodeService: LfTreeNodeService, selectedNode?: string | LfTreeNode | undefined) => Promise<void>;
708
+ initAsync: (treeNodeService: LfTreeNodeService, selectedNode?: LfTreeNode | undefined) => Promise<void>;
709
709
  isSelectable?: (treeNode: LfTreeNode) => Promise<boolean>;
710
710
  multiple: boolean;
711
711
  setSelectedValuesAsync: (valuesToSelect: LfTreeNode[]) => Promise<void>;
@@ -749,7 +749,7 @@ export declare class LfRepositoryBrowserComponent {
749
749
 
750
750
 
751
751
 
752
-
752
+ private makeDataCall;
753
753
 
754
754
 
755
755
  }
@@ -830,29 +830,26 @@ export declare interface LfTreeNodePage {
830
830
  nextPage: string | undefined;
831
831
  }
832
832
 
833
+ /**
834
+ * A tree data structure provider that can be used as a data source for UI components, such as the lf-repository-browser component, to navigate a tree structure.
835
+ */
833
836
  export declare interface LfTreeNodeService {
834
837
  /**
835
- * Gets entry data for the lf-repository-browser to display
838
+ * Returns a page containing the children or the parent tree node. The implementation may provide expose ordering and filtering functionality.
836
839
  * @param folder: string that represents the ID of the folder to get data from
837
- * @param nextPage: string representing the next page requested
840
+ * @param nextPage: string representing the next page requested. If undefined, the first page is returned
838
841
  **/
839
842
  getFolderChildrenAsync(folder: LfTreeNode, nextPage?: string): Promise<LfTreeNodePage>;
840
843
  /**
841
- * Returns the root entry
844
+ * Returns the root LfTreeNode
842
845
  */
843
- getRootTreeNodeAsync(): Promise<LfTreeNode | undefined>;
846
+ getRootTreeNodeAsync(): Promise<LfTreeNode>;
844
847
  /**
845
- * Gets the parent Entry of the passed in node
846
- * @param treeNode: Entry object to get the parent of
847
- * returns - Promise with the parent of the parameter entry or undefined if its the root of the entry does not have a parent
848
+ * Gets the parent LfTreeNode of the passed in node
849
+ * @param treeNode: LfTreeNode object to get the parent of
850
+ * returns - Promise with the parent of the parameter LfTreeNode or undefined if its the root LfTreeNode and does not have a parent
848
851
  */
849
852
  getParentTreeNodeAsync(treeNode: LfTreeNode): Promise<LfTreeNode | undefined>;
850
- /**
851
- * Gets the full Entry data of an entry id
852
- * @param id: string that represents the id of an Entry to get
853
- * returns - Entry associated with the id parameter or undefined if the entry does not exist
854
- */
855
- getTreeNodeByIdAsync(id: string): Promise<LfTreeNode | undefined>;
856
853
  }
857
854
 
858
855
  export declare interface LfTreeProviders {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@laserfiche/types-lf-ui-components",
3
- "version": "13.1.0--preview-2927979043",
3
+ "version": "13.1.0",
4
4
  "scripts": {},
5
5
  "dependencies": {},
6
6
  "devDependencies": {},