@laserfiche/types-lf-ui-components 13.0.1 → 13.1.0--preview-2920922867

package/index.d.ts

@@ -31,6 +31,9 @@
 
 
 
+
+
+
 
 
 
@@ -198,13 +201,6 @@ declare interface IUserTrackingEvent {
     userId: string;
 }
 
-export declare class LfBreadcrumbsComponent {
-    breadcrumbs: TreeNode[];
-    breadcrumbSelected: CustomEvent<TreeNode | undefined>;
-
-
-}
-
 export declare class LfChecklistComponent {
 
     action_button_text: string | undefined;
@@ -695,6 +691,75 @@ export declare class LfMetadataModule {
 
 }
 
+export declare class LfRepositoryBrowserComponent {
+
+
+
+
+
+    get breadcrumbs(): LfTreeNode[];
+    get currentFolder(): LfTreeNode | undefined;
+    itemSize: number;
+    /**
+     * function to initialize the lf-file-explorer component
+     * @param provider LfRepositoryService service
+     * @param selectedNode the id of the node to select, or a Entry starting from the selected entry
+     */
+    initAsync: (treeNodeService: LfTreeNodeService, selectedNode?: string | LfTreeNode | undefined) => Promise<void>;
+    isSelectable?: (treeNode: LfTreeNode) => Promise<boolean>;
+    multiple: boolean;
+    setSelectedValuesAsync: (valuesToSelect: LfTreeNode[]) => Promise<void>;
+    refreshAsync: () => Promise<void>;
+    /**
+     * Focuses the first item in the repository browser list
+     * TODO: Add an optional parameter to allow for focusing a specific node
+     */
+    focus: () => void;
+    entrySelected: CustomEvent<LfTreeNode[] | undefined>;
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+}
+
+export declare class LfRepositoryBrowserModule {
+
+}
+
+export declare class LfSelectionListModule {
+}
+
 export declare class LfToolbarComponent {
     displayed_options: ToolbarOption[];
     dropdown_options: ToolbarOption[];
@@ -748,6 +813,45 @@ declare abstract class LfTreeKeysDirective {
 
 
 
+}
+
+export declare interface LfTreeNode {
+    id: string;
+    icon: string | string[];
+    isContainer: boolean;
+    isLeaf: boolean;
+    name: string;
+    path: string;
+}
+
+export declare interface LfTreeNodePage {
+    page: LfTreeNode[];
+    nextPage: string | undefined;
+}
+
+export declare interface LfTreeNodeService {
+    /**
+     * Gets entry data for the lf-repository-browser to display
+     * @param folder: string that represents the ID of the folder to get data from
+     * @param nextPage: string representing the next page requested
+     **/
+    getFolderChildrenAsync(folder: LfTreeNode, nextPage?: string): Promise<LfTreeNodePage>;
+    /**
+     * Returns the root entry
+     */
+    getRootTreeNodeAsync(): Promise<LfTreeNode | undefined>;
+    /**
+     * Gets the parent Entry of the passed in node
+     * @param treeNode: Entry object to get the parent of
+     * returns - Promise with the parent of the parameter entry or undefined if its the root of the entry does not have a parent
+     */
+    getParentTreeNodeAsync(treeNode: LfTreeNode): Promise<LfTreeNode | undefined>;
+    /**
+     * Gets the full Entry data of an entry id
+     * @param id: string that represents the id of an Entry to get
+     * returns - Entry associated with the id parameter or undefined if the entry does not exist
+     */
+    getTreeNodeByIdAsync(id: string): Promise<LfTreeNode | undefined>;
 }
 
 export declare interface LfTreeProviders {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@laserfiche/types-lf-ui-components",
-  "version": "13.0.1",
+  "version": "13.1.0--preview-2920922867",
   "scripts": {},
   "dependencies": {},
   "devDependencies": {},