mindoodb 0.0.1

package/dist/core/indexing/virtualviews/VirtualViewNavigator.d.ts

@@ -0,0 +1,330 @@
+import type { VirtualView } from "./VirtualView";
+import type { VirtualViewEntryData } from "./VirtualViewEntryData";
+import type { IViewEntryAccessCheck } from "./IViewEntryAccessCheck";
+import { WithCategories, WithDocuments, SelectedOnly, ScopedDocId } from "./types";
+/**
+ * Navigator for traversing a VirtualView tree structure.
+ * Handles expanded/collapsed states, selection, and access control.
+ */
+export declare class VirtualViewNavigator {
+    private readonly view;
+    private topEntry;
+    private readonly withCategories;
+    private readonly withDocuments;
+    private readonly accessCheck;
+    private readonly dontShowEmptyCategories;
+    /** Stack of traversal states for navigation */
+    private currentEntryStack;
+    /** Selection state - if selectAll is true, this is a deselection list */
+    private selectedOrDeselectedEntries;
+    private selectAll;
+    /** Expansion state - if expandAllByDefault is true, this is a collapse list */
+    private expandedOrCollapsedEntries;
+    private expandAllByDefault;
+    private expandLevel;
+    constructor(view: VirtualView, topEntry: VirtualViewEntryData, withCategories: WithCategories, withDocuments: WithDocuments, accessCheck?: IViewEntryAccessCheck | null, dontShowEmptyCategories?: boolean);
+    private initializeTraversal;
+    private createTraversalInfo;
+    getView(): VirtualView;
+    isDontShowEmptyCategories(): boolean;
+    /**
+     * Set a new root for navigation (restrict to subtree)
+     */
+    setRoot(newRoot: VirtualViewEntryData): this;
+    /**
+     * Get the current entry at the cursor position
+     */
+    getCurrentEntry(): VirtualViewEntryData | null;
+    /**
+     * Move to the first entry
+     */
+    gotoFirst(): boolean;
+    /**
+     * Move to the last entry (taking expansion into account)
+     */
+    gotoLast(): boolean;
+    /**
+     * Move to the next entry (respecting expand states)
+     */
+    gotoNext(): boolean;
+    /**
+     * Get the current entry without type filtering (for internal navigation)
+     */
+    private getCurrentEntryRaw;
+    /**
+     * Check visibility without type filtering
+     */
+    private isVisibleRaw;
+    /**
+     * Move to next sibling without checking type filter
+     */
+    private gotoNextSiblingRaw;
+    /**
+     * Move to the previous entry (respecting expand states)
+     */
+    gotoPrev(): boolean;
+    /**
+     * Move to the next sibling
+     */
+    gotoNextSibling(): boolean;
+    /**
+     * Move to the previous sibling
+     */
+    gotoPrevSibling(): boolean;
+    /**
+     * Move to the parent entry
+     */
+    gotoParent(): boolean;
+    /**
+     * Move to the first child of current entry
+     */
+    gotoFirstChild(): boolean;
+    /**
+     * Move to the last child of current entry
+     */
+    gotoLastChild(): boolean;
+    private gotoDeepestExpandedDescendant;
+    /**
+     * Move to a specific position (e.g., "1.2.3")
+     */
+    gotoPos(posStr: string): boolean;
+    /**
+     * Move to a specific position array (e.g., [1, 2, 3])
+     */
+    gotoPosArray(pos: number[]): boolean;
+    /**
+     * Get the entry at a specific position without moving the cursor
+     *
+     * @param posStr Position string e.g. "1.2.3"
+     * @returns The entry at the position or null if not found
+     */
+    getPos(posStr: string): VirtualViewEntryData | null;
+    /**
+     * Get the entry at a specific position array without moving the cursor
+     *
+     * @param pos Position array e.g. [1, 2, 3]
+     * @returns The entry at the position or null if not found
+     */
+    getPosArray(pos: number[]): VirtualViewEntryData | null;
+    /**
+     * Find a category entry by path string (e.g., "Category1\\Category1.1")
+     * Navigates through the category tree from the top entry.
+     *
+     * @param category Category path with backslash separators
+     * @returns The category entry or null if not found
+     */
+    findCategoryEntry(category: string): VirtualViewEntryData | null;
+    /**
+     * Find a category entry by array of category parts
+     * Navigates through the category tree from the top entry.
+     *
+     * @param categoryParts Array of category values e.g. ["Category1", "Category1.1"]
+     * @returns The category entry or null if not found
+     */
+    findCategoryEntryByParts(categoryParts: unknown[]): VirtualViewEntryData | null;
+    /**
+     * Iterate forward through entries
+     */
+    entriesForward(selectedOnly?: SelectedOnly): AsyncGenerator<VirtualViewEntryData>;
+    /**
+     * Iterate forward through entries starting from a specific position
+     *
+     * @param startPos Starting position string e.g. "1.2.3"
+     * @param selectedOnly Whether to only yield selected entries
+     */
+    entriesForwardFromPosition(startPos: string, selectedOnly?: SelectedOnly): AsyncGenerator<VirtualViewEntryData>;
+    /**
+     * Iterate backward through entries
+     */
+    entriesBackward(selectedOnly?: SelectedOnly): AsyncGenerator<VirtualViewEntryData>;
+    /**
+     * Move to next selected entry
+     */
+    gotoNextSelected(): boolean;
+    /**
+     * Move to previous selected entry
+     */
+    gotoPrevSelected(): boolean;
+    private isVisible;
+    /**
+     * Select an entry
+     */
+    select(origin: string, docId: string, selectParentCategories?: boolean): this;
+    /**
+     * Deselect an entry
+     */
+    deselect(origin: string, docId: string): this;
+    /**
+     * Select all entries
+     */
+    selectAllEntries(): this;
+    /**
+     * Deselect all entries
+     */
+    deselectAllEntries(): this;
+    /**
+     * Check if an entry is selected
+     */
+    isSelected(origin: string, docId: string): boolean;
+    isSelectAllByDefault(): boolean;
+    /**
+     * Returns whether all entries are deselected by default
+     */
+    isDeselectAllByDefault(): boolean;
+    /**
+     * Expand an entry
+     */
+    expand(origin: string, docId: string): this;
+    /**
+     * Collapse an entry
+     */
+    collapse(origin: string, docId: string): this;
+    /**
+     * Expand by position string
+     */
+    expandPos(posStr: string): this;
+    /**
+     * Collapse by position string
+     */
+    collapsePos(posStr: string): this;
+    /**
+     * Expand by position array
+     *
+     * @param pos Position array e.g. [1, 2, 3]
+     */
+    expandPosArray(pos: number[]): this;
+    /**
+     * Collapse by position array
+     *
+     * @param pos Position array e.g. [1, 2, 3]
+     */
+    collapsePosArray(pos: number[]): this;
+    private getEntryAtPos;
+    /**
+     * Collapse all entries
+     */
+    collapseAll(): this;
+    /**
+     * Expand all entries
+     */
+    expandAll(): this;
+    /**
+     * Expand entries up to a specific level
+     */
+    expandToLevel(level: number): this;
+    /**
+     * Check if an entry is expanded
+     */
+    isExpanded(entry: VirtualViewEntryData): boolean;
+    /**
+     * Check if an entry is expanded by origin and docId
+     * Does not check expandLevel - only checks the expand/collapse state
+     *
+     * @param origin Origin of the entry
+     * @param docId Document ID of the entry
+     * @returns true if expanded
+     */
+    isExpandedByDocId(origin: string, docId: string): boolean;
+    isExpandAllByDefault(): boolean;
+    isCollapseAllByDefault(): boolean;
+    getExpandLevel(): number;
+    getSelectedOrDeselectedEntries(): Set<string>;
+    setSelectedOrDeselectedEntries(entries: Set<string>): this;
+    getExpandedOrCollapsedEntries(): Set<string>;
+    setExpandedOrCollapsedEntries(entries: Set<string>): this;
+    /**
+     * Get child documents of an entry
+     */
+    childDocuments(entry: VirtualViewEntryData, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Get child categories of an entry
+     */
+    childCategories(entry: VirtualViewEntryData, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Get all child entries of an entry
+     */
+    childEntries(entry: VirtualViewEntryData, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Get child documents within a key range (inclusive)
+     *
+     * @param entry Parent entry
+     * @param startKey Start key value
+     * @param endKey End key value
+     * @param descending Whether to return in descending order
+     * @returns Filtered child documents within the range
+     */
+    childDocumentsBetween(entry: VirtualViewEntryData, startKey: unknown, endKey: unknown, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Get child documents by key (exact or prefix match)
+     *
+     * @param entry Parent entry
+     * @param key Key value to search for
+     * @param isExact Whether to match exactly or by prefix
+     * @param descending Whether to return in descending order
+     * @returns Matching child documents
+     */
+    childDocumentsByKey(entry: VirtualViewEntryData, key: string, isExact: boolean, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Get child categories within a key range (inclusive)
+     *
+     * @param entry Parent entry
+     * @param startKey Start key value
+     * @param endKey End key value
+     * @param descending Whether to return in descending order
+     * @returns Filtered child categories within the range
+     */
+    childCategoriesBetween(entry: VirtualViewEntryData, startKey: unknown, endKey: unknown, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Get child categories by key (exact or prefix match)
+     *
+     * @param entry Parent entry
+     * @param key Key value to search for
+     * @param isExact Whether to match exactly or by prefix
+     * @param descending Whether to return in descending order
+     * @returns Matching child categories
+     */
+    childCategoriesByKey(entry: VirtualViewEntryData, key: string, isExact: boolean, descending?: boolean): VirtualViewEntryData[];
+    /**
+     * Compare two position arrays for sorting
+     */
+    private static comparePositions;
+    /**
+     * Get all occurrences of a document in the view, sorted by position
+     *
+     * @param origin Origin of the document
+     * @param docId Document ID
+     * @returns Array of entries sorted by position
+     */
+    getSortedEntries(origin: string, docId: string): VirtualViewEntryData[];
+    /**
+     * Get all occurrences of multiple documents in the view, sorted by position
+     *
+     * @param origin Origin of the documents
+     * @param docIds Set of document IDs
+     * @returns Array of entries sorted by position
+     */
+    getSortedEntriesMultiple(origin: string, docIds: Set<string>): VirtualViewEntryData[];
+    /**
+     * Get all occurrences of scoped document IDs in the view, sorted by position
+     *
+     * @param scopedDocIds Set of scoped document IDs (origin + docId)
+     * @returns Array of entries sorted by position
+     */
+    getSortedEntriesScoped(scopedDocIds: Set<ScopedDocId>): VirtualViewEntryData[];
+    /**
+     * Get document IDs sorted by their position in the view
+     *
+     * @param origin Origin of the documents
+     * @param docIds Set of document IDs
+     * @returns Array of document IDs sorted by their position in the view
+     */
+    getSortedDocIds(origin: string, docIds: Set<string>): string[];
+    /**
+     * Get scoped document IDs sorted by their position in the view
+     *
+     * @param scopedDocIds Set of scoped document IDs
+     * @returns Array of scoped document IDs sorted by their position in the view
+     */
+    getSortedDocIdsScoped(scopedDocIds: Set<ScopedDocId>): ScopedDocId[];
+}
+//# sourceMappingURL=VirtualViewNavigator.d.ts.map

package/dist/core/indexing/virtualviews/VirtualViewNavigator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VirtualViewNavigator.d.ts","sourceRoot":"","sources":["../../../../src/core/indexing/virtualviews/VirtualViewNavigator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EACL,cAAc,EACd,aAAa,EACb,YAAY,EAIZ,WAAW,EAEZ,MAAM,SAAS,CAAC;AAajB;;;GAGG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAc;IACnC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAU;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAU;IACxC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+B;IAC3D,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAAU;IAElD,+CAA+C;IAC/C,OAAO,CAAC,iBAAiB,CAAuB;IAEhD,yEAAyE;IACzE,OAAO,CAAC,2BAA2B,CAA0B;IAC7D,OAAO,CAAC,SAAS,CAAkB;IAEnC,+EAA+E;IAC/E,OAAO,CAAC,0BAA0B,CAA0B;IAC5D,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,WAAW,CAAa;gBAG9B,IAAI,EAAE,WAAW,EACjB,QAAQ,EAAE,oBAAoB,EAC9B,cAAc,EAAE,cAAc,EAC9B,aAAa,EAAE,aAAa,EAC5B,WAAW,GAAE,qBAAqB,GAAG,IAAW,EAChD,uBAAuB,GAAE,OAAe;IAiB1C,OAAO,CAAC,mBAAmB;IAO3B,OAAO,CAAC,mBAAmB;IAc3B,OAAO,IAAI,WAAW;IAItB,yBAAyB,IAAI,OAAO;IAIpC;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI;IAQ5C;;OAEG;IACH,eAAe,IAAI,oBAAoB,GAAG,IAAI;IA0B9C;;OAEG;IACH,SAAS,IAAI,OAAO;IA4BpB;;OAEG;IACH,QAAQ,IAAI,OAAO;IAwBnB;;OAEG;IACH,QAAQ,IAAI,OAAO;IAiEnB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;IACH,OAAO,CAAC,YAAY;IAQpB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAkB1B;;OAEG;IACH,QAAQ,IAAI,OAAO;IAoBnB;;OAEG;IACH,eAAe,IAAI,OAAO;IAkB1B;;OAEG;IACH,eAAe,IAAI,OAAO;IAkB1B;;OAEG;IACH,UAAU,IAAI,OAAO;IAQrB;;OAEG;IACH,cAAc,IAAI,OAAO;IAuBzB;;OAEG;IACH,aAAa,IAAI,OAAO;IAuBxB,OAAO,CAAC,6BAA6B;IAerC;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAKhC;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO;IAsCpC;;;;;OAKG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI;IAKnD;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,oBAAoB,GAAG,IAAI;IAmBvD;;;;;;OAMG;IACH,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,oBAAoB,GAAG,IAAI;IAKhE;;;;;;OAMG;IACH,wBAAwB,CAAC,aAAa,EAAE,OAAO,EAAE,GAAG,oBAAoB,GAAG,IAAI;IAwB/E;;OAEG;IACI,cAAc,CAAC,YAAY,GAAE,YAA8B,GAAG,cAAc,CAAC,oBAAoB,CAAC;IAezG;;;;;OAKG;IACI,0BAA0B,CAC/B,QAAQ,EAAE,MAAM,EAChB,YAAY,GAAE,YAA8B,GAC3C,cAAc,CAAC,oBAAoB,CAAC;IAevC;;OAEG;IACI,eAAe,CAAC,YAAY,GAAE,YAA8B,GAAG,cAAc,CAAC,oBAAoB,CAAC;IAe1G;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAU3B;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAY3B,OAAO,CAAC,SAAS;IAkBjB;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,sBAAsB,GAAE,OAAe,GAAG,IAAI;IA4BpF;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAY7C;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAMxB;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAM1B;;OAEG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IASlD,oBAAoB,IAAI,OAAO;IAI/B;;OAEG;IACH,sBAAsB,IAAI,OAAO;IAMjC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAY3C;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAY7C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQ/B;;OAEG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQjC;;;;OAIG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI;IAQnC;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI;IAQrC,OAAO,CAAC,aAAa;IAarB;;OAEG;IACH,WAAW,IAAI,IAAI;IAMnB;;OAEG;IACH,SAAS,IAAI,IAAI;IAMjB;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,oBAAoB,GAAG,OAAO;IAchD;;;;;;;OAOG;IACH,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO;IAgBzD,oBAAoB,IAAI,OAAO;IAI/B,sBAAsB,IAAI,OAAO;IAIjC,cAAc,IAAI,MAAM;IAMxB,8BAA8B,IAAI,GAAG,CAAC,MAAM,CAAC;IAI7C,8BAA8B,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI;IAK1D,6BAA6B,IAAI,GAAG,CAAC,MAAM,CAAC;IAI5C,6BAA6B,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI;IAOzD;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,oBAAoB,EAAE,UAAU,GAAE,OAAe,GAAG,oBAAoB,EAAE;IAMhG;;OAEG;IACH,eAAe,CAAC,KAAK,EAAE,oBAAoB,EAAE,UAAU,GAAE,OAAe,GAAG,oBAAoB,EAAE;IAMjG;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,oBAAoB,EAAE,UAAU,GAAE,OAAe,GAAG,oBAAoB,EAAE;IAQ9F;;;;;;;;OAQG;IACH,qBAAqB,CACnB,KAAK,EAAE,oBAAoB,EAC3B,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,OAAO,EACf,UAAU,GAAE,OAAe,GAC1B,oBAAoB,EAAE;IAkBzB;;;;;;;;OAQG;IACH,mBAAmB,CACjB,KAAK,EAAE,oBAAoB,EAC3B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,UAAU,GAAE,OAAe,GAC1B,oBAAoB,EAAE;IAUzB;;;;;;;;OAQG;IACH,sBAAsB,CACpB,KAAK,EAAE,oBAAoB,EAC3B,QAAQ,EAAE,OAAO,EACjB,MAAM,EAAE,OAAO,EACf,UAAU,GAAE,OAAe,GAC1B,oBAAoB,EAAE;IAiBzB;;;;;;;;OAQG;IACH,oBAAoB,CAClB,KAAK,EAAE,oBAAoB,EAC3B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,EAChB,UAAU,GAAE,OAAe,GAC1B,oBAAoB,EAAE;IAYzB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAU/B;;;;;;OAMG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,oBAAoB,EAAE;IAOvE;;;;;;OAMG;IACH,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,oBAAoB,EAAE;IAarF;;;;;OAKG;IACH,sBAAsB,CAAC,YAAY,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,oBAAoB,EAAE;IAa9E;;;;;;OAMG;IACH,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE;IAiB9D;;;;;OAKG;IACH,qBAAqB,CAAC,YAAY,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,WAAW,EAAE;CAiBrE"}