@limble/limble-tree 0.12.4 → 1.0.0-alpha.1

package/lib/limble-tree-root/drop-zone.service.d.ts

@@ -1,62 +0,0 @@
-import { Branch, BranchCoordinates } from "../classes/Branch";
-import { DragStateService } from "../singletons/drag-state.service";
-import type { ProcessedOptions } from "./tree.service";
-import { DropZone } from "../classes/DropZone";
-import { TreeConstructionStatus } from "./tree-construction-status.service";
-import * as i0 from "@angular/core";
-export interface DropZoneFamily {
-    /** The deepest member of the family */
-    founder: DropZone;
-    /** All the drop zones that belong to this family */
-    members: Array<DropZone>;
-}
-export declare class DropZoneService {
-    private readonly dragStateService;
-    private readonly dropZoneArchive;
-    private readonly dropZoneInventory;
-    private readonly dropZoneFamilies;
-    private visibleFamily;
-    private activeDropZone;
-    private tree;
-    private treeOptions;
-    private tempFamilies;
-    private readonly update$;
-    constructor(dragStateService: DragStateService, treeConstructionStatus: TreeConstructionStatus);
-    addDropZone(newDropZone: DropZone): void;
-    /** hides all drop zones */
-    clearVisibleZones(): void;
-    getActiveDropZone(): DropZoneService["activeDropZone"];
-    getDropZone(coordinates: BranchCoordinates): DropZone | undefined;
-    init(tree: Branch<any>, treeOptions: ProcessedOptions): void;
-    removeDropZone(dropZone: DropZone): void;
-    /** hides all drop zones, deletes all the family assignments,
-     * and empties the dropZoneInventory
-     */
-    reset(): void;
-    /**
-     * Restores the service to its initial state: hides all drop zones,
-     * deletes all the family assignments, and empties the dropZoneInventory
-     * and dropZoneArchive.
-     */
-    restart(): void;
-    restoreFamilies(): void;
-    /**
-     * Shows the drop zone family of the drop zone indicated by `coordinates`.
-     */
-    showDropZoneFamily(
-    /** Note: this drop zone may not exist in the dropZoneInventory; we have to search the inventory based on its location */
-    dropZone: DropZone, options?: {
-        joinFamilies?: boolean;
-        activateLowestInsteadOfFounder?: boolean;
-    }): void;
-    swapActiveDropZone(newActiveDropZone: DropZone): void;
-    update(): void;
-    private assignFamilies;
-    private buildInventory;
-    private setActiveDropZone;
-    private showDropZone;
-    private updateDropZones;
-    private zoneIsAllowed;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DropZoneService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DropZoneService>;
-}

package/lib/limble-tree-root/limble-tree-root.component.d.ts

@@ -1,37 +0,0 @@
-import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnChanges, OnDestroy } from "@angular/core";
-import { DropZoneService } from "./drop-zone.service";
-import { LimbleTreeData, LimbleTreeOptions, TreeDrop } from "../limble-tree-root/tree.service";
-import { TreeService } from "./tree.service";
-import { DragStateService } from "../singletons/drag-state.service";
-import { GlobalEventsService } from "../singletons/global-events.service";
-import * as i0 from "@angular/core";
-export declare class LimbleTreeRootComponent implements AfterViewInit, OnChanges, OnDestroy {
-    private readonly treeService;
-    private readonly dropZoneService;
-    private readonly dragStateService;
-    private readonly globalEventsService;
-    private readonly ngZone;
-    private readonly changeDetectorRef;
-    private readonly el;
-    data: LimbleTreeData | undefined;
-    options: LimbleTreeOptions | undefined;
-    itemsPerPage: number | undefined;
-    page: number | undefined;
-    private host;
-    readonly treeChange: EventEmitter<null>;
-    readonly treeDrop: EventEmitter<TreeDrop>;
-    private readonly changesSubscription;
-    private readonly dropSubscription;
-    placeholder: boolean;
-    constructor(treeService: TreeService, dropZoneService: DropZoneService, dragStateService: DragStateService, globalEventsService: GlobalEventsService, ngZone: NgZone, changeDetectorRef: ChangeDetectorRef, el: ElementRef<Element>);
-    ngAfterViewInit(): void;
-    ngOnChanges(): void;
-    /** Rebuild the tree */
-    update(): void;
-    dragoverHandler(event: DragEvent): void;
-    dragleaveHandler(event: DragEvent): void;
-    dropHandler(event: DragEvent): void;
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LimbleTreeRootComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<LimbleTreeRootComponent, "limble-tree-root", never, { "data": "data"; "options": "options"; "itemsPerPage": "itemsPerPage"; "page": "page"; }, { "treeChange": "treeChange"; "treeDrop": "treeDrop"; }, never, never>;
-}

package/lib/limble-tree-root/tree-construction-status.service.d.ts

@@ -1,15 +0,0 @@
-import { BehaviorSubject } from "rxjs";
-import * as i0 from "@angular/core";
-export declare class TreeConstructionStatus {
-    private beingBuilt;
-    private isReady;
-    readonly stable$: BehaviorSubject<boolean>;
-    constructor();
-    constructing(): void;
-    doneConstructing(): void;
-    treeIsStable(): boolean;
-    ready(val: boolean): void;
-    emit(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeConstructionStatus, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<TreeConstructionStatus>;
-}

package/lib/limble-tree-root/tree.service.d.ts

@@ -1,132 +0,0 @@
-import { Type, ViewContainerRef } from "@angular/core";
-import { ComponentCreatorService } from "../singletons/component-creator.service";
-import { DropZoneService } from "./drop-zone.service";
-import { Branch, BranchCoordinates } from "../classes/Branch";
-import { DragStateService } from "../singletons/drag-state.service";
-import { BehaviorSubject, Subject } from "rxjs";
-import { TreeConstructionStatus } from "./tree-construction-status.service";
-import * as i0 from "@angular/core";
-/** An object describing a node of the tree */
-export interface LimbleTreeNode {
-    /** A list of nodes to be rendered "under" this one, one level deeper in the tree. */
-    nodes?: LimbleTreeData;
-    /** An object that describes the component which will represent this node in the visual tree */
-    component?: ComponentObj;
-    collapsed?: boolean;
-    [index: string]: unknown;
-}
-/** An object that the limble-tree-root component uses to build the tree */
-export declare type LimbleTreeData = Array<LimbleTreeNode>;
-/** A group of settings for changing the functionality of the tree */
-export interface LimbleTreeOptions {
-    /** The component object to use if one is not specified for a particular node */
-    defaultComponent?: ComponentObj;
-    /** The number of pixels to indent each level of the tree. Defaults to 45 */
-    indent?: number;
-    /**
-     * Whether to allow "nesting" (placing a node one level deeper than currently exists on the branch).
-     * When this is a boolean, it applies to all nodes. When this is a function, the node in question
-     * is passed in. Defaults to true.
-     */
-    allowNesting?: boolean | ((nodeData: LimbleTreeNode) => boolean);
-    /**
-     * Whether to allow a node to be dragged. When this is a boolean, it applies to all nodes. When this
-     * is a function, the node in question is passed in. Defaults to true.
-     */
-    allowDragging?: boolean | ((nodeData: LimbleTreeNode) => boolean);
-    /** A callback to determine whether a sourceNode can be dropped at a particular location. */
-    allowDrop?: (sourceNode: LimbleTreeNode, proposedParent: LimbleTreeNode | null, proposedIndex: number) => boolean;
-    /** When set to true, list mode will enforce a flat tree structure, meaning there
-     * can only be one level of the tree. `allowNesting` is automatically set to `false`
-     * and any children will be deleted.
-     *
-     * This mode can be used when the same dynamic drag and drop functionality of
-     * the tree is desired, but the tree structure itself is not necessary. This
-     * also opens up the pagination API on the limble-tree-root component. See the
-     * README for details on pagination.
-     */
-    listMode?: boolean;
-}
-/** An object that references the component to be rendered and its bindings */
-export interface ComponentObj {
-    /** The component class */
-    class: Type<unknown>;
-    /** The bindings (inputs and outputs) of the class */
-    bindings?: {
-        [index: string]: unknown;
-    };
-}
-/** The default value for the `indent` option */
-export declare const INDENT = 45;
-/** An options object with default values loaded where applicable */
-export interface ProcessedOptionsBase extends LimbleTreeOptions {
-    defaultComponent?: ComponentObj;
-    indent: number;
-    allowNesting: boolean | ((nodeData: LimbleTreeNode) => boolean);
-    allowDragging: boolean | ((nodeData: LimbleTreeNode) => boolean);
-    allowDrop: (sourceNode: LimbleTreeNode, proposedParent: LimbleTreeNode | null, proposedIndex: number) => boolean;
-    listMode: boolean;
-    itemsPerPage: number | undefined;
-    page: number | undefined;
-}
-export interface ProcessedOptionsWithPagination extends ProcessedOptionsBase {
-    listMode: true;
-    itemsPerPage: number;
-    page: number;
-}
-export interface ProcessedOptionsWithoutPagination extends ProcessedOptionsBase {
-    listMode: false;
-    itemsPerPage: undefined;
-    page: undefined;
-}
-export declare type ProcessedOptions = ProcessedOptionsWithPagination | ProcessedOptionsWithoutPagination;
-/** the value emitted from the root component after a node is dropped */
-export interface TreeDrop {
-    /** The node that was dropped */
-    target: LimbleTreeNode;
-    /** the target's parent before the drag and drop, or null if it was a top-level node */
-    oldParent: LimbleTreeNode | null;
-    /** the index of the node before the drag and drop relative to its old siblings */
-    oldIndex: number;
-    /** the target's parent after the drag and drop, or null if it is now a top-level node */
-    newParent: LimbleTreeNode | null;
-    /** the index of the node after the drag and drop relative to its new siblings */
-    newIndex: number;
-}
-export declare class TreeService {
-    private readonly componentCreatorService;
-    private readonly dropZoneService;
-    private readonly dragStateService;
-    private readonly treeConstructionStatus;
-    readonly changes$: Subject<null>;
-    readonly drops$: Subject<TreeDrop>;
-    host: ViewContainerRef | undefined;
-    treeData: LimbleTreeData | undefined;
-    /** This should never be reassigned. It is assigned in init() and no where else. We need to keep the reference from breaking. */
-    private originalData;
-    treeOptions: ProcessedOptions | undefined;
-    treeModel: Branch<any>;
-    private placeholder;
-    captured: boolean;
-    readonly cleanupSignal$: Subject<boolean>;
-    placeholder$: BehaviorSubject<boolean>;
-    constructor(componentCreatorService: ComponentCreatorService, dropZoneService: DropZoneService, dragStateService: DragStateService, treeConstructionStatus: TreeConstructionStatus);
-    drop(source: Branch<any>, targetCoordinates: BranchCoordinates): void;
-    /** Initializes the service and renders the tree.
-     * @param host - The ViewContainerRef into which the tree will be rendered.
-     * @param data - The data array that was passed in to LimbleTreeRoot, which is
-     * the users' representation of the tree
-     * @param options - The options object that was passed in to LimbleTreeRoot
-     */
-    init(host: ViewContainerRef, data: LimbleTreeData, options?: LimbleTreeOptions, itemsPerPage?: number, page?: number): void;
-    private cleanup;
-    /** Renders the entire tree from root to leaves */
-    private render;
-    /** Renders a branch of the tree and all of its descendants */
-    renderBranch(host: ViewContainerRef, branch: Branch<any>): void;
-    private processOptions;
-    private rebuildTreeData;
-    private rebuildBranch;
-    static ɵfac: i0.ɵɵFactoryDeclaration<TreeService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<TreeService>;
-}

package/lib/singletons/component-creator.service.d.ts

@@ -1,9 +0,0 @@
-import { ComponentFactoryResolver, Type, ViewContainerRef } from "@angular/core";
-import * as i0 from "@angular/core";
-export declare class ComponentCreatorService {
-    private readonly factoryResolver;
-    constructor(factoryResolver: ComponentFactoryResolver);
-    appendComponent<T = unknown>(component: Type<T>, viewContainerRef: ViewContainerRef, index?: number | undefined): import("@angular/core").ComponentRef<T>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ComponentCreatorService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ComponentCreatorService>;
-}

package/lib/singletons/drag-state.service.d.ts

@@ -1,35 +0,0 @@
-import { ViewContainerRef } from "@angular/core";
-import { BehaviorSubject } from "rxjs";
-import type { Branch } from "../classes/Branch";
-import * as i0 from "@angular/core";
-export declare type DragState = "idle" | "dragging" | "droppable" | "captured";
-interface TempData {
-    branch: Branch<any>;
-    parentContainer: ViewContainerRef;
-}
-export declare class DragStateService {
-    /** pushes the new state whenever the state changes */
-    state$: BehaviorSubject<DragState>;
-    /** holds data about the thing being dragged */
-    private _tempData;
-    /** the current state of the drag process */
-    private state;
-    constructor();
-    /** Called to indicate that something is being dragged. Stores that something for later. */
-    dragging(branch: Branch<any>, parentContainer: ViewContainerRef): void;
-    /** Called to indicate that there is a valid active drop zone. Drop is now possible. */
-    droppable(): void;
-    /** Called to indicate that there is no longer a valid active drop zone. Drop is no longer possible. */
-    notDroppable(): void;
-    /** Called to indicate that a drop into a valid drop zone has occurred. Returns the item that was dropped.  */
-    capture(): Branch<any> | undefined;
-    /** Called to reset the service for future drags */
-    release(): void;
-    /** gets the current thing being dragged, if any. */
-    getData(): TempData | undefined;
-    /** gets the current state */
-    getState(): DragState;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DragStateService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<DragStateService>;
-}
-export {};

package/lib/singletons/global-events.service.d.ts

@@ -1,13 +0,0 @@
-import { NgZone } from "@angular/core";
-import * as i0 from "@angular/core";
-export declare class GlobalEventsService {
-    private readonly ngZone;
-    private globalDrag$;
-    private globalDragSubscription;
-    scrolling: boolean;
-    constructor(ngZone: NgZone);
-    addScrolling(): void;
-    removeScrolling(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<GlobalEventsService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<GlobalEventsService>;
-}

package/lib/util.d.ts

@@ -1,13 +0,0 @@
-import type { LimbleTreeNode, ProcessedOptions } from "./limble-tree-root/tree.service";
-export declare function arraysAreEqual(array1: Array<unknown>, array2: Array<unknown>): boolean;
-export declare function isElementDescendant(potentialAncestor: Node, potentialDescendant: Node): boolean | undefined;
-export declare function isNestingAllowed(options?: ProcessedOptions, nodeData?: LimbleTreeNode): boolean;
-export declare function isDraggingAllowed(options?: ProcessedOptions, nodeData?: LimbleTreeNode): boolean;
-export declare function isFirefox(): boolean;
-/** Because drop zones can disappear when the mouse moves, sometimes
- * moving the mouse just a little bit inside the tree causes the tree to
- * shrink such that the mouse is no longer over the tree. In this case,
- * a dragleave event may not fire, and we can't clear the drop zones. This
- * function is used to catch this edge case.
- */
-export declare function suddenTreeExit(event: DragEvent): boolean;