@nuforge/editor 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,128 @@
+import * as t from '@nuforge/types';
+import { Nu } from '@nuforge/core';
+import { MutationEntry } from '@nuforge/reactivity';
+
+interface PropSchemaField {
+    name: string;
+    type: 'string' | 'number' | 'boolean' | 'expression' | 'enum';
+    label?: string;
+    default?: string | number | boolean;
+    options?: string[];
+}
+interface Block {
+    id: string;
+    label: string;
+    icon?: string;
+    category?: string;
+    create: () => t.Template;
+    props?: PropSchemaField[];
+}
+declare function defineBlock(block: Block): Block;
+declare class BlockRegistry {
+    private readonly blocks;
+    constructor(initial?: Block[]);
+    register(block: Block): void;
+    get(id: string): Block | undefined;
+    all(): Block[];
+    byCategory(): Record<string, Block[]>;
+}
+declare const DEFAULT_BLOCKS: Block[];
+
+declare function lit(value: string | number | boolean): t.Literal;
+declare function text(value: string): t.TagTemplate;
+declare function el(tag: string, props?: Record<string, t.Expression>, children?: t.Template[]): t.TagTemplate;
+
+type DropPosition = 'before' | 'after' | 'inside';
+declare function dropPositionFromPointer(clientY: number, rect: {
+    top: number;
+    height: number;
+}, opts?: {
+    allowInside?: boolean;
+}): DropPosition;
+declare function templateLabel(node: t.Template): string;
+declare function templateChildren(node: t.Template): t.Template[];
+declare function isTextTemplate(node: t.Template): boolean;
+declare function textPreview(node: t.Template): string | null;
+declare function canHaveChildren(node: t.Template | null): boolean;
+declare function isAncestorOf(nu: Nu, ancestor: t.Template, node: t.Template): boolean;
+
+interface CreateEditorOptions {
+    blocks?: Block[];
+    defaultBlocks?: boolean;
+}
+declare class Editor {
+    readonly nu: Nu;
+    readonly blocks: BlockRegistry;
+    readonly commands: CommandRegistry;
+    constructor(nu: Nu, opts?: CreateEditorOptions);
+    insertNode(parent: t.Template, child: t.Template, index?: number): void;
+    removeNode(node: t.Template): boolean;
+    moveNode(dragged: t.Template, target: t.Template, position: DropPosition): boolean;
+    private clipboardNode;
+    copyNode(node: t.Template): void;
+    cutNode(node: t.Template): boolean;
+    canPaste(): boolean;
+    pasteNode(target: t.Template, position?: DropPosition): t.Template | null;
+    duplicateNode(node: t.Template): t.Template | null;
+    insertNodeAt(node: t.Template, target: t.Template, position: DropPosition): t.Template | null;
+    insertBlockAt(blockId: string, target: t.Template, position: DropPosition): t.Template | null;
+    private insertCloneRelativeTo;
+    updateProps(node: t.Template, props: Record<string, t.Expression>): void;
+    setProp(node: t.Template, key: string, expr: t.Expression): void;
+    removeProp(node: t.Template, key: string): void;
+    setExpression(node: t.Template, key: string, source: string): boolean;
+    setText(node: t.Template, value: string): boolean;
+    setTag(node: t.TagTemplate, tag: string): void;
+    addClass(node: t.Template, name: string): void;
+    setClassCondition(node: t.Template, name: string, source: string): boolean;
+    removeClass(node: t.Template, name: string): void;
+    setCondition(node: t.Template, source: string): boolean;
+    clearCondition(node: t.Template): void;
+    setEach(node: t.Template, iterator: string, alias?: string, indexName?: string): boolean;
+    clearEach(node: t.Template): void;
+    addState(component: t.NuComponent, name?: string, init?: string): t.Val;
+    removeState(component: t.NuComponent, val: t.Val): void;
+    setStateInit(val: t.Val, source: string): boolean;
+    addComponentProp(component: t.NuComponent, name?: string, init?: string): t.ComponentProp;
+    removeComponentProp(component: t.NuComponent, prop: t.ComponentProp): void;
+    setComponentPropInit(prop: t.ComponentProp, source: string): boolean;
+    insertBlock(blockId: string, parent: t.Template, index?: number): t.Template | null;
+    private uniqueName;
+    addComponent(name?: string): t.NuComponent;
+    renameComponent(component: t.NuComponent, name: string): boolean;
+    removeComponent(component: t.NuComponent): boolean;
+    duplicateComponent(component: t.NuComponent): t.NuComponent;
+    private walkTemplates;
+    getComponents(): t.NuComponent[];
+    getComponent(name: string): t.NuComponent | undefined;
+    getRootTemplate(name: string): t.Template | null;
+    getChildren(node: t.Template): t.Template[];
+    getSiblings(node: t.Template): t.Template[];
+    getNodeIndex(node: t.Template): number;
+    getNodePath(node: t.Type): Array<string | number>;
+    onChange(cb: (entries: MutationEntry[]) => void): () => void;
+    onStructureChange(cb: () => void): () => void;
+    private spliceFromParent;
+    private applyMove;
+    private insertRelativeTo;
+}
+declare function createEditor(nu: Nu, opts?: CreateEditorOptions): Editor;
+
+interface Command {
+    id: string;
+    label: string;
+    shortcut?: string;
+    run: (editor: Editor) => void;
+}
+declare class CommandRegistry {
+    private readonly editor;
+    private readonly commands;
+    constructor(editor: Editor);
+    register(command: Command): void;
+    get(id: string): Command | undefined;
+    all(): Command[];
+    run(id: string): void;
+}
+
+export { BlockRegistry, CommandRegistry, DEFAULT_BLOCKS, Editor, canHaveChildren, createEditor, defineBlock, dropPositionFromPointer, el, isAncestorOf, isTextTemplate, lit, templateChildren, templateLabel, text, textPreview };
+export type { Block, Command, CreateEditorOptions, DropPosition, PropSchemaField };