@ngstarter-ui/components 21.0.39 → 21.0.41

package/types/ngstarter-ui-components-form-builder.d.ts

@@ -0,0 +1,388 @@
+import * as _angular_forms from '@angular/forms';
+import { ValidatorFn, FormControl, FormGroup } from '@angular/forms';
+import * as _angular_core from '@angular/core';
+import { Type, InjectionToken, EnvironmentProviders, TemplateRef } from '@angular/core';
+import { TreeNodeDropPosition, Tree, TreeNodeDrop } from '@ngstarter-ui/components/tree';
+import * as _ngstarter_ui_components_form_builder from '@ngstarter-ui/components/form-builder';
+
+type FormBuilderFieldWidth = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+type FormBuilderItemKind = 'field' | 'layout' | 'static';
+interface FormBuilderOption {
+    label: string;
+    value: any;
+}
+interface FormBuilderValidationRule {
+    type: 'required' | 'email' | 'minLength' | 'maxLength' | 'min' | 'max' | string;
+    value?: any;
+    message?: string;
+}
+interface FormBuilderVisibility {
+    form?: boolean;
+    email?: boolean;
+    pdf?: boolean;
+    condition?: string;
+}
+interface FormBuilderField {
+    id: string;
+    name: string;
+    type: string;
+    kind?: FormBuilderItemKind;
+    label: string;
+    placeholder?: string;
+    hint?: string;
+    defaultValue?: any;
+    required?: boolean;
+    disabled?: boolean;
+    readonly?: boolean;
+    width?: FormBuilderFieldWidth;
+    options?: FormBuilderOption[];
+    validation?: FormBuilderValidationRule[];
+    visibility?: FormBuilderVisibility;
+    settings?: Record<string, any>;
+    children?: FormBuilderField[];
+}
+interface FormBuilderSection {
+    id: string;
+    title: string;
+    description?: string;
+    collapsed?: boolean;
+    fields: FormBuilderField[];
+}
+interface FormBuilderLayoutItem {
+    kind: 'field' | 'section';
+    id: string;
+}
+interface FormBuilderSchema {
+    title?: string;
+    fields?: FormBuilderField[];
+    layout?: FormBuilderLayoutItem[];
+    sections: FormBuilderSection[];
+}
+interface FormBuilderFieldRenderContext {
+    field: FormBuilderField;
+    control: FormControl;
+    readonly: boolean;
+}
+interface FormBuilderSettingsContext {
+    field: FormBuilderField;
+    schema: FormBuilderSchema;
+    update: (changes: Partial<FormBuilderField>) => void;
+}
+type FormBuilderComponentImporter<T = any> = () => Promise<Type<T>>;
+interface FormBuilderFieldSettingsContext {
+    item: FormBuilderField;
+    field: FormBuilderField;
+    schema: FormBuilderSchema;
+    definition?: FormBuilderFieldDefinition;
+    update: (changes: Partial<FormBuilderField>) => void;
+    updateField: (changes: Partial<FormBuilderField>) => void;
+}
+interface FormBuilderSectionSettingsContext {
+    item: FormBuilderSection;
+    section: FormBuilderSection;
+    schema: FormBuilderSchema;
+    definition?: FormBuilderItemDefinition;
+    update: (changes: Partial<FormBuilderSection>) => void;
+    updateSection: (changes: Partial<FormBuilderSection>) => void;
+}
+interface FormBuilderItemDefinition {
+    type: string;
+    label: string;
+    kind?: FormBuilderItemKind;
+    group?: string;
+    icon?: string;
+    description?: string;
+    defaults?: Partial<FormBuilderField>;
+    renderer?: FormBuilderComponentImporter;
+    settings?: FormBuilderComponentImporter;
+    acceptsChildren?: boolean;
+}
+interface FormBuilderFieldDefinition extends FormBuilderItemDefinition {
+    kind?: FormBuilderItemKind;
+    validators?: (field: FormBuilderField) => ValidatorFn[];
+}
+interface FormBuilderSettingsDefinition {
+    fieldType?: string;
+    itemType?: string;
+    type?: string;
+    kind?: FormBuilderItemKind;
+    component: FormBuilderComponentImporter;
+}
+interface FormBuilderFieldChange {
+    field: FormBuilderField;
+    section?: FormBuilderSection;
+}
+
+declare const FORM_BUILDER_ITEMS: InjectionToken<FormBuilderItemDefinition[]>;
+declare const FORM_BUILDER_FIELDS: InjectionToken<FormBuilderFieldDefinition[]>;
+declare const FORM_BUILDER_SETTINGS: InjectionToken<FormBuilderSettingsDefinition[]>;
+declare function formBuilderField(definition: FormBuilderFieldDefinition): FormBuilderFieldDefinition;
+declare function formBuilderItem(definition: FormBuilderItemDefinition): FormBuilderItemDefinition;
+declare function formBuilderSettings(definition: FormBuilderSettingsDefinition): FormBuilderSettingsDefinition;
+declare function provideFormBuilder(config?: {
+    items?: FormBuilderItemDefinition[];
+    fields?: FormBuilderFieldDefinition[];
+    settings?: FormBuilderSettingsDefinition[];
+}): EnvironmentProviders;
+declare const DEFAULT_FORM_BUILDER_FIELDS: FormBuilderFieldDefinition[];
+declare const DEFAULT_FORM_BUILDER_ITEMS: FormBuilderItemDefinition[];
+declare function validatorsFromRules(rules?: FormBuilderValidationRule[], field?: FormBuilderField): _angular_forms.ValidatorFn[];
+
+interface FormBuilderPaletteGroup {
+    name: string;
+    fields: FormBuilderFieldDefinition[];
+}
+interface FormBuilderFieldTreeNode {
+    id: string;
+    label: string;
+    name?: string;
+    type: string;
+    icon: string;
+    kind: 'section' | 'field';
+    field?: FormBuilderField;
+    section?: FormBuilderSection;
+    children?: FormBuilderFieldTreeNode[];
+}
+interface FormBuilderCanvasItem extends FormBuilderLayoutItem {
+    field?: FormBuilderField;
+    section?: FormBuilderSection;
+}
+type FormBuilderNativeDragItem = {
+    kind: 'field';
+    definition: FormBuilderFieldDefinition;
+} | {
+    kind: 'section';
+};
+declare class FormBuilder {
+    private readonly dialog;
+    private readonly confirmManager;
+    private readonly elementRef;
+    private readonly providedItems;
+    private readonly providedFields;
+    private readonly providedSettings;
+    private readonly previewControls;
+    private readonly fieldTreeNodeCache;
+    private readonly canvasAnimationTimers;
+    private readonly actualFieldsTree;
+    private fieldTreeRootNodes;
+    private fieldTreeStructureKey;
+    private suppressPaletteClick;
+    readonly schema: _angular_core.ModelSignal<FormBuilderSchema>;
+    readonly paletteTitle: _angular_core.InputSignal<string>;
+    readonly inspectorTitle: _angular_core.InputSignal<string>;
+    readonly fieldSelected: _angular_core.OutputEmitterRef<FormBuilderFieldChange>;
+    readonly fieldAdded: _angular_core.OutputEmitterRef<FormBuilderFieldChange>;
+    readonly fieldRemoved: _angular_core.OutputEmitterRef<FormBuilderFieldChange>;
+    protected readonly search: _angular_core.WritableSignal<string>;
+    protected readonly fieldsTabIndex: _angular_core.WritableSignal<number>;
+    protected readonly selectedFieldId: _angular_core.WritableSignal<string | null>;
+    protected readonly nativeDragItem: _angular_core.WritableSignal<FormBuilderNativeDragItem | null>;
+    protected readonly nativeDragFieldDefinition: _angular_core.Signal<FormBuilderFieldDefinition | null>;
+    protected readonly nativeDragSection: _angular_core.Signal<boolean>;
+    protected readonly nativeDropTarget: _angular_core.WritableSignal<{
+        containerId: string;
+        index: number;
+    } | null>;
+    protected readonly expandedFieldTreeNodeIds: _angular_core.WritableSignal<ReadonlySet<string>>;
+    protected readonly definitions: _angular_core.Signal<FormBuilderFieldDefinition[]>;
+    protected readonly settingsDefinitions: _angular_core.Signal<FormBuilderSettingsDefinition[]>;
+    protected readonly canvasItems: _angular_core.Signal<FormBuilderCanvasItem[]>;
+    protected readonly layoutDefinitions: _angular_core.Signal<FormBuilderFieldDefinition[]>;
+    protected readonly paletteGroups: _angular_core.Signal<FormBuilderPaletteGroup[]>;
+    protected readonly selectedField: _angular_core.Signal<FormBuilderField | null>;
+    protected readonly selectedSection: _angular_core.Signal<FormBuilderSection | null>;
+    protected readonly fieldTree: _angular_core.Signal<FormBuilderFieldTreeNode[]>;
+    protected readonly fieldTreeChildrenAccessor: (node: FormBuilderFieldTreeNode) => FormBuilderFieldTreeNode[];
+    protected readonly hasFieldTreeChildren: (_: number, node: FormBuilderFieldTreeNode) => boolean;
+    protected readonly trackFieldTreeNode: (_: number, node: FormBuilderFieldTreeNode) => string;
+    protected readonly fieldTreeDraggablePredicate: (_node: FormBuilderFieldTreeNode) => boolean;
+    protected readonly fieldTreeDropPredicate: (source: FormBuilderFieldTreeNode, target: FormBuilderFieldTreeNode, position: TreeNodeDropPosition) => boolean;
+    protected readonly updateSelectedField: (changes: Partial<FormBuilderField>) => void;
+    protected readonly updateSelectedSection: (changes: Partial<FormBuilderSection>) => void;
+    protected paletteDragStarted(event: DragEvent, definition: FormBuilderFieldDefinition): void;
+    protected sectionPaletteDragStarted(event: DragEvent): void;
+    protected paletteDragEnded(): void;
+    protected paletteClicked(definition: FormBuilderFieldDefinition): void;
+    protected nativeCanvasDragOver(event: DragEvent): void;
+    protected nativeFieldDragOver(event: DragEvent, containerId: string): void;
+    protected nativeSectionDragOver(event: DragEvent, section: FormBuilderSection): void;
+    protected nativeSectionDrop(event: DragEvent, section: FormBuilderSection): void;
+    protected nativeContainerFieldDragOver(event: DragEvent, field: FormBuilderField): void;
+    protected nativeContainerFieldDragLeave(event: DragEvent, field: FormBuilderField): void;
+    protected nativeContainerFieldDrop(event: DragEvent, field: FormBuilderField): void;
+    protected nativeDragLeave(event: DragEvent, containerId: string): void;
+    protected nativeFieldDrop(event: DragEvent, containerId: string): void;
+    protected isNativeDropTarget(containerId: string, index: number): boolean;
+    protected addField(definition: FormBuilderFieldDefinition, sectionId?: string): void;
+    protected addSection(): void;
+    protected openPreview(template: TemplateRef<unknown>): void;
+    protected removeSection(section: FormBuilderSection): void;
+    protected updateSection(section: FormBuilderSection, changes: Partial<FormBuilderSection>): void;
+    protected isSectionCollapsed(section: FormBuilderSection): boolean;
+    protected selectField(field: FormBuilderField, section?: FormBuilderSection): void;
+    protected selectSection(section: FormBuilderSection): void;
+    protected selectCanvasField(field: FormBuilderField, section?: FormBuilderSection): void;
+    protected selectFieldTreeNode(node: FormBuilderFieldTreeNode): void;
+    protected toggleFieldTreeNode(tree: Tree<FormBuilderFieldTreeNode>, node: FormBuilderFieldTreeNode, event: MouseEvent): void;
+    protected isFieldTreeNodeExpanded(tree: Tree<FormBuilderFieldTreeNode>, node: FormBuilderFieldTreeNode): boolean;
+    protected fieldTreePlaceholderIcon(source: FormBuilderFieldTreeNode): string;
+    protected fieldTreeNodeDropped(event: TreeNodeDrop<FormBuilderFieldTreeNode>): void;
+    protected confirmRemoveField(field: FormBuilderField): void;
+    private removeField;
+    protected sectionDropListId(section: FormBuilderSection): string;
+    protected fieldDropListId(field: FormBuilderField): string;
+    protected rootDropListId(): string;
+    protected previewControl(field: FormBuilderField): FormControl;
+    protected patchSelectedField(changes: Partial<FormBuilderField>): void;
+    protected isContainerField(field: FormBuilderField): boolean;
+    protected fieldIcon(field: FormBuilderField): string;
+    protected definitionWidth(definition: FormBuilderFieldDefinition): FormBuilderFieldWidth;
+    private matchesPaletteQuery;
+    private nativeDragOver;
+    private nativeDragOverAtIndex;
+    private setNativeDropTarget;
+    private captureCanvasItemRects;
+    private animateCanvasItemMoves;
+    private getCanvasAnimatedItems;
+    private getCanvasAnimatedItemKey;
+    private insertNativeField;
+    private insertNativeSection;
+    private resolveNativeDragItem;
+    private resolveNativeDropIndex;
+    private setPaletteDragImage;
+    private createField;
+    private defaultWidth;
+    private resolveCanvasItems;
+    private normalizedLayout;
+    private detachFieldFromLocation;
+    private insertFieldIntoTreeSection;
+    private insertFieldAroundTreeSection;
+    private resolveTreeFieldInsertTarget;
+    private insertRootFieldIntoLayout;
+    private resetFieldTreeAfterRejectedDrop;
+    private canDropFieldTreeNode;
+    private dropFieldTreeSection;
+    private isRootFieldTreeNode;
+    private restoreFieldTreeExpansion;
+    private flattenFieldTree;
+    private openActualFieldsTreeForField;
+    private findFieldTreeNodePath;
+    private scrollFieldTreeNodeIntoView;
+    private findFieldTreeNodeElement;
+    private scrollCanvasFieldIntoView;
+    private scrollCanvasSectionIntoView;
+    private scrollCanvasItemIntoView;
+    private findCanvasFieldElement;
+    private findCanvasSectionElement;
+    private syncPreviewControl;
+    private scrollElementFullyIntoView;
+    private afterNextPaint;
+    private upsertSectionTreeNode;
+    private upsertFieldTreeNode;
+    private getCachedFieldTreeNode;
+    private resolveFieldTreeStructureKey;
+    private findContainerLocation;
+    private findFieldContainerLocation;
+    private findFieldLocation;
+    private deletePreviewControls;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilder, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormBuilder, "ngs-form-builder", ["ngsFormBuilder"], { "schema": { "alias": "schema"; "required": false; "isSignal": true; }; "paletteTitle": { "alias": "paletteTitle"; "required": false; "isSignal": true; }; "inspectorTitle": { "alias": "inspectorTitle"; "required": false; "isSignal": true; }; }, { "schema": "schemaChange"; "fieldSelected": "fieldSelected"; "fieldAdded": "fieldAdded"; "fieldRemoved": "fieldRemoved"; }, never, never, true, never>;
+}
+declare function createDefaultFormBuilderSchema(): FormBuilderSchema;
+
+interface FormBuilderRendererCanvasItem extends FormBuilderLayoutItem {
+    field?: FormBuilderField;
+    section?: FormBuilderSection;
+}
+declare class FormBuilderRenderer {
+    private readonly providedItems;
+    private readonly providedFields;
+    private readonly orphanControls;
+    readonly schema: _angular_core.InputSignal<FormBuilderSchema>;
+    readonly readonly: _angular_core.InputSignal<boolean>;
+    readonly showSubmit: _angular_core.InputSignal<boolean>;
+    readonly submitLabel: _angular_core.InputSignal<string>;
+    readonly value: _angular_core.ModelSignal<Record<string, any>>;
+    readonly formSubmit: _angular_core.OutputEmitterRef<Record<string, any>>;
+    readonly formReady: _angular_core.OutputEmitterRef<FormGroup<any>>;
+    protected readonly definitions: _angular_core.Signal<FormBuilderFieldDefinition[]>;
+    protected readonly visibleCanvasItems: _angular_core.Signal<FormBuilderRendererCanvasItem[]>;
+    protected readonly formGroup: _angular_core.Signal<FormGroup<any>>;
+    constructor();
+    protected getControl(field: FormBuilderField): FormControl;
+    protected isContainerField(field: FormBuilderField): boolean;
+    protected visibleChildren(field: FormBuilderField): FormBuilderField[];
+    protected submit(): void;
+    private createFormGroup;
+    private visibleFields;
+    private resolveCanvasItems;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilderRenderer, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormBuilderRenderer, "ngs-form-builder-renderer", ["ngsFormBuilderRenderer"], { "schema": { "alias": "schema"; "required": true; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "showSubmit": { "alias": "showSubmit"; "required": false; "isSignal": true; }; "submitLabel": { "alias": "submitLabel"; "required": false; "isSignal": true; }; "value": { "alias": "value"; "required": false; "isSignal": true; }; }, { "value": "valueChange"; "formSubmit": "formSubmit"; "formReady": "formReady"; }, never, never, true, never>;
+}
+
+declare class FormBuilderFieldHost {
+    readonly field: _angular_core.InputSignal<FormBuilderField>;
+    readonly control: _angular_core.InputSignal<FormControl<any>>;
+    readonly definitions: _angular_core.InputSignal<FormBuilderFieldDefinition[]>;
+    readonly readonly: _angular_core.InputSignal<boolean>;
+    readonly editableCanvas: _angular_core.InputSignal<boolean>;
+    protected readonly customLoaded: _angular_core.WritableSignal<boolean>;
+    protected readonly textInputType: _angular_core.Signal<"email" | "text" | "number">;
+    private readonly anchor;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilderFieldHost, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormBuilderFieldHost, "ngs-form-builder-field-host", ["ngsFormBuilderFieldHost"], { "field": { "alias": "field"; "required": true; "isSignal": true; }; "control": { "alias": "control"; "required": true; "isSignal": true; }; "definitions": { "alias": "definitions"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "editableCanvas": { "alias": "editableCanvas"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class FormBuilderSettingsHost {
+    readonly field: _angular_core.InputSignal<FormBuilderField | null>;
+    readonly section: _angular_core.InputSignal<FormBuilderSection | null>;
+    readonly schema: _angular_core.InputSignal<FormBuilderSchema>;
+    readonly definitions: _angular_core.InputSignal<FormBuilderFieldDefinition[]>;
+    readonly settingsDefinitions: _angular_core.InputSignal<FormBuilderSettingsDefinition[]>;
+    readonly update: _angular_core.InputSignal<((changes: Partial<FormBuilderField>) => void) | undefined>;
+    readonly updateSection: _angular_core.InputSignal<((changes: Partial<FormBuilderSection>) => void) | undefined>;
+    protected readonly itemDefinition: _angular_core.Signal<FormBuilderFieldDefinition | undefined>;
+    protected readonly fieldDefinition: _angular_core.Signal<FormBuilderFieldDefinition | undefined>;
+    protected readonly fieldKind: _angular_core.Signal<_ngstarter_ui_components_form_builder.FormBuilderItemKind>;
+    protected readonly isLayoutField: _angular_core.Signal<boolean>;
+    protected readonly customLoaded: _angular_core.WritableSignal<boolean>;
+    private readonly anchor;
+    constructor();
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<FormBuilderSettingsHost, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<FormBuilderSettingsHost, "ngs-form-builder-settings-host", ["ngsFormBuilderSettingsHost"], { "field": { "alias": "field"; "required": false; "isSignal": true; }; "section": { "alias": "section"; "required": false; "isSignal": true; }; "schema": { "alias": "schema"; "required": true; "isSignal": true; }; "definitions": { "alias": "definitions"; "required": false; "isSignal": true; }; "settingsDefinitions": { "alias": "settingsDefinitions"; "required": false; "isSignal": true; }; "update": { "alias": "update"; "required": false; "isSignal": true; }; "updateSection": { "alias": "updateSection"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class BasicFormBuilderFieldSettings {
+    readonly field: _angular_core.InputSignal<FormBuilderField>;
+    readonly update: _angular_core.InputSignal<(changes: Partial<FormBuilderField>) => void>;
+    protected readonly fieldWidthOptions: FormBuilderFieldWidth[];
+    protected readonly hasCheckedState: _angular_core.Signal<boolean>;
+    protected readonly hasPlaceholder: _angular_core.Signal<boolean>;
+    protected readonly hasOptions: _angular_core.Signal<boolean>;
+    protected readonly optionsText: _angular_core.Signal<string>;
+    protected patch(changes: Partial<FormBuilderField>): void;
+    protected patchOptions(value: string): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BasicFormBuilderFieldSettings, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BasicFormBuilderFieldSettings, "ngs-basic-form-builder-field-settings", ["ngsBasicFormBuilderFieldSettings"], { "field": { "alias": "field"; "required": true; "isSignal": true; }; "update": { "alias": "update"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class BasicFormBuilderLayoutSettings {
+    readonly field: _angular_core.InputSignal<FormBuilderField>;
+    readonly update: _angular_core.InputSignal<(changes: Partial<FormBuilderField>) => void>;
+    protected readonly fieldWidthOptions: FormBuilderFieldWidth[];
+    protected patch(changes: Partial<FormBuilderField>): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BasicFormBuilderLayoutSettings, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BasicFormBuilderLayoutSettings, "ngs-basic-form-builder-layout-settings", ["ngsBasicFormBuilderLayoutSettings"], { "field": { "alias": "field"; "required": true; "isSignal": true; }; "update": { "alias": "update"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+declare class BasicFormBuilderSectionSettings {
+    readonly section: _angular_core.InputSignal<FormBuilderSection>;
+    readonly update: _angular_core.InputSignal<(changes: Partial<FormBuilderSection>) => void>;
+    protected patch(changes: Partial<FormBuilderSection>): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<BasicFormBuilderSectionSettings, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<BasicFormBuilderSectionSettings, "ngs-basic-form-builder-section-settings", ["ngsBasicFormBuilderSectionSettings"], { "section": { "alias": "section"; "required": true; "isSignal": true; }; "update": { "alias": "update"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+}
+
+export { BasicFormBuilderFieldSettings, BasicFormBuilderLayoutSettings, BasicFormBuilderSectionSettings, DEFAULT_FORM_BUILDER_FIELDS, DEFAULT_FORM_BUILDER_ITEMS, FORM_BUILDER_FIELDS, FORM_BUILDER_ITEMS, FORM_BUILDER_SETTINGS, FormBuilder, FormBuilderFieldHost, FormBuilderRenderer, FormBuilderSettingsHost, FormBuilderRenderer as FormRenderer, createDefaultFormBuilderSchema, formBuilderField, formBuilderItem, formBuilderSettings, provideFormBuilder, validatorsFromRules };
+export type { FormBuilderComponentImporter, FormBuilderField, FormBuilderFieldChange, FormBuilderFieldDefinition, FormBuilderFieldRenderContext, FormBuilderFieldSettingsContext, FormBuilderFieldWidth, FormBuilderItemDefinition, FormBuilderItemKind, FormBuilderLayoutItem, FormBuilderOption, FormBuilderSchema, FormBuilderSection, FormBuilderSectionSettingsContext, FormBuilderSettingsContext, FormBuilderSettingsDefinition, FormBuilderValidationRule, FormBuilderVisibility };

package/types/ngstarter-ui-components-tree.d.ts

@@ -1,5 +1,5 @@
 import * as _angular_core from '@angular/core';
-import { ViewContainerRef, OnInit, OnDestroy } from '@angular/core';
+import { ViewContainerRef, TemplateRef, OnInit, OnDestroy } from '@angular/core';
 import { DataSource } from '@angular/cdk/collections';
 import { CdkTree, CdkTreeNodeOutlet, CdkNestedTreeNode, CdkTreeNode, CdkTreeNodePadding, CdkTreeNodeToggle, CdkTreeNodeDef } from '@angular/cdk/tree';
 import { Observable } from 'rxjs';
@@ -18,15 +18,40 @@ interface TreeNodeDrop<T> {
     targetValue: unknown;
     dataSource: T[];
 }
+interface TreeNodeDropContext<T> {
+    source: T;
+    target: T;
+    position: TreeNodeDropPosition;
+}
+interface TreeNodeDragPlaceholderContext<T> {
+    $implicit: T;
+    source: T;
+    target?: T;
+    position?: TreeNodeDropPosition;
+}
 type TreeNodeDropPosition = 'before' | 'inside' | 'after';
+type TreeNodeDragPredicate<T> = (node: T) => boolean;
+type TreeNodeDropPredicate<T> = (source: T, target: T, position: TreeNodeDropPosition) => boolean;
+type TreeDragPreview = 'node' | 'none';
 type TreeFilterMode = 'includeAncestors' | 'includeDescendants';
 type TreeFilterPredicate<T> = (node: T, filterValue: string) => boolean;
+declare class TreeDragPlaceholder<T> {
+    readonly templateRef: TemplateRef<TreeNodeDragPlaceholderContext<T>>;
+    static ngTemplateContextGuard<T>(_directive: TreeDragPlaceholder<T>, _context: unknown): _context is TreeNodeDragPlaceholderContext<T>;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<TreeDragPlaceholder<any>, never>;
+    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<TreeDragPlaceholder<any>, "ng-template[ngsTreeDragPlaceholder]", never, {}, {}, never, never, true, never>;
+}
 declare class Tree<T, K = T> extends CdkTree<T, K> {
     get dataSource(): DataSource<T> | Observable<T[]> | T[];
     set dataSource(dataSource: DataSource<T> | Observable<T[]> | T[]);
     checkable: _angular_core.InputSignalWithTransform<boolean, unknown>;
     selectable: _angular_core.InputSignalWithTransform<boolean, unknown>;
     draggable: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    draggablePredicate: _angular_core.InputSignal<TreeNodeDragPredicate<T>>;
+    dropPredicate: _angular_core.InputSignal<TreeNodeDropPredicate<T>>;
+    reorderOnDrop: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    dragPreview: _angular_core.InputSignal<TreeDragPreview>;
+    nodePaddingIndent: _angular_core.InputSignal<string | number>;
     childrenKey: _angular_core.InputSignal<string>;
     filterValue: _angular_core.InputSignalWithTransform<string, unknown>;
     filterPredicate: _angular_core.InputSignal<TreeFilterPredicate<T>>;
@@ -38,6 +63,7 @@ declare class Tree<T, K = T> extends CdkTree<T, K> {
     readonly _selectedKey: _angular_core.WritableSignal<unknown>;
     readonly _dropTargetKey: _angular_core.WritableSignal<unknown>;
     readonly _dropTargetPosition: _angular_core.WritableSignal<TreeNodeDropPosition | undefined>;
+    readonly _draggedNodeKey: _angular_core.WritableSignal<unknown>;
     private _checkedKeys;
     private _nodeValueByDataKey;
     private _disabledDataKeys;
@@ -45,6 +71,7 @@ declare class Tree<T, K = T> extends CdkTree<T, K> {
     private _draggedNode?;
     private _sourceDataSource?;
     private _filteredNodeOriginals;
+    private _dragPlaceholder?;
     _nodeOutlet: TreeNodeOutlet;
     constructor();
     _toggleNodeChecked(node: T, checked: boolean): void;
@@ -55,11 +82,15 @@ declare class Tree<T, K = T> extends CdkTree<T, K> {
     _canDragNode(node: T): boolean;
     _isNodeDropTarget(node: T): boolean;
     _isNodeDropTargetPosition(node: T, position: TreeNodeDropPosition): boolean;
+    _isNodeDraggingSource(node: T): boolean;
     _startNodeDrag(node: T, event: DragEvent): void;
     _dragNodeOver(node: T, event: DragEvent): void;
     _dragNodeLeave(node: T, event: DragEvent): void;
     _dropNodeInto(node: T, event: DragEvent): void;
     _endNodeDrag(): void;
+    _getDragPreview(): TreeDragPreview;
+    _hasDragPlaceholder(): boolean;
+    _setDragPlaceholderImage(node: T, event: DragEvent, host: HTMLElement): boolean;
     _registerNodeValue(node: T, value: unknown): void;
     _unregisterNodeValueByDataKey(key: unknown): void;
     _registerNodeDisabled(node: T, disabled: boolean): void;
@@ -95,7 +126,7 @@ declare class Tree<T, K = T> extends CdkTree<T, K> {
     private _getTreeNodeKey;
     private _getOriginalFilterNode;
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<Tree<any, any>, never>;
-    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Tree<any, any>, "ngs-tree", ["ngsTree"], { "checkable": { "alias": "checkable"; "required": false; "isSignal": true; }; "selectable": { "alias": "selectable"; "required": false; "isSignal": true; }; "draggable": { "alias": "draggable"; "required": false; "isSignal": true; }; "childrenKey": { "alias": "childrenKey"; "required": false; "isSignal": true; }; "filterValue": { "alias": "filterValue"; "required": false; "isSignal": true; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; "isSignal": true; }; "filterMode": { "alias": "filterMode"; "required": false; "isSignal": true; }; }, { "checkedChange": "checkedChange"; "selectedChange": "selectedChange"; "nodeDrop": "nodeDrop"; }, never, never, true, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<Tree<any, any>, "ngs-tree", ["ngsTree"], { "checkable": { "alias": "checkable"; "required": false; "isSignal": true; }; "selectable": { "alias": "selectable"; "required": false; "isSignal": true; }; "draggable": { "alias": "draggable"; "required": false; "isSignal": true; }; "draggablePredicate": { "alias": "draggablePredicate"; "required": false; "isSignal": true; }; "dropPredicate": { "alias": "dropPredicate"; "required": false; "isSignal": true; }; "reorderOnDrop": { "alias": "reorderOnDrop"; "required": false; "isSignal": true; }; "dragPreview": { "alias": "dragPreview"; "required": false; "isSignal": true; }; "nodePaddingIndent": { "alias": "nodePaddingIndent"; "required": false; "isSignal": true; }; "childrenKey": { "alias": "childrenKey"; "required": false; "isSignal": true; }; "filterValue": { "alias": "filterValue"; "required": false; "isSignal": true; }; "filterPredicate": { "alias": "filterPredicate"; "required": false; "isSignal": true; }; "filterMode": { "alias": "filterMode"; "required": false; "isSignal": true; }; }, { "checkedChange": "checkedChange"; "selectedChange": "selectedChange"; "nodeDrop": "nodeDrop"; }, ["_dragPlaceholder"], never, true, never>;
 }
 
 declare class TreeNode<T, K = T> extends CdkTreeNode<T, K> implements OnInit, OnDestroy {
@@ -121,6 +152,7 @@ declare class TreeNode<T, K = T> extends CdkTreeNode<T, K> implements OnInit, On
     _isDraggable(): boolean;
     _isDropTarget(): boolean;
     _isDropTargetPosition(position: 'before' | 'inside' | 'after'): boolean;
+    _isDraggingSource(): boolean;
     _getDraggableAttribute(): true | null;
     _getAriaGrabbed(): boolean | null;
     _handleDragStart(event: DragEvent): void;
@@ -128,6 +160,7 @@ declare class TreeNode<T, K = T> extends CdkTreeNode<T, K> implements OnInit, On
     _handleDragLeave(event: DragEvent): void;
     _handleDrop(event: DragEvent): void;
     _handleDragEnd(): void;
+    private _setDragImage;
     private _selectNodeFromEvent;
     private _isTreeControlClick;
     private _syncNodeState;
@@ -161,6 +194,7 @@ declare class NestedTreeNode<T, K = T> extends CdkNestedTreeNode<T, K> implement
     _isDraggable(): boolean;
     _isDropTarget(): boolean;
     _isDropTargetPosition(position: 'before' | 'inside' | 'after'): boolean;
+    _isDraggingSource(): boolean;
     _getDraggableAttribute(): true | null;
     _getAriaGrabbed(): boolean | null;
     _handleDragStart(event: DragEvent): void;
@@ -168,6 +202,7 @@ declare class NestedTreeNode<T, K = T> extends CdkNestedTreeNode<T, K> implement
     _handleDragLeave(event: DragEvent): void;
     _handleDrop(event: DragEvent): void;
     _handleDragEnd(): void;
+    private _setDragImage;
     private _selectNodeFromEvent;
     private _isTreeControlClick;
     private _syncNodeState;
@@ -181,8 +216,9 @@ declare class NestedTreeNode<T, K = T> extends CdkNestedTreeNode<T, K> implement
 }
 
 declare class TreeNodePadding<T, K = T> extends CdkTreeNodePadding<T, K> {
+    private readonly tree;
     levelInput: _angular_core.InputSignalWithTransform<number, any>;
-    indentInput: _angular_core.InputSignal<string | number>;
+    indentInput: _angular_core.InputSignal<string | number | undefined>;
     constructor();
     static ɵfac: _angular_core.ɵɵFactoryDeclaration<TreeNodePadding<any, any>, never>;
     static ɵdir: _angular_core.ɵɵDirectiveDeclaration<TreeNodePadding<any, any>, "[ngsTreeNodePadding]", never, { "levelInput": { "alias": "ngsTreeNodePadding"; "required": false; "isSignal": true; }; "indentInput": { "alias": "ngsTreeNodePaddingIndent"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
@@ -199,5 +235,5 @@ declare class TreeNodeDef<T> extends CdkTreeNodeDef<T> {
     static ɵdir: _angular_core.ɵɵDirectiveDeclaration<TreeNodeDef<any>, "[ngsTreeNodeDef]", never, { "when": { "alias": "ngsTreeNodeDefWhen"; "required": false; }; "data": { "alias": "ngsTreeNode"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
 }
 
-export { NestedTreeNode, Tree, TreeNode, TreeNodeDef, TreeNodeOutlet, TreeNodePadding, TreeNodeToggle };
-export type { TreeFilterMode, TreeFilterPredicate, TreeNodeDrop, TreeNodeDropPosition };
+export { NestedTreeNode, Tree, TreeDragPlaceholder, TreeNode, TreeNodeDef, TreeNodeOutlet, TreeNodePadding, TreeNodeToggle };
+export type { TreeDragPreview, TreeFilterMode, TreeFilterPredicate, TreeNodeDragPlaceholderContext, TreeNodeDragPredicate, TreeNodeDrop, TreeNodeDropContext, TreeNodeDropPosition, TreeNodeDropPredicate };