@umbraci/jsmind 0.10.0 → 0.10.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@umbraci/jsmind",
-    "version": "0.10.0",
+    "version": "0.10.2",
     "description": "jsMind is a pure javascript library for mindmap, it base on html5 canvas. jsMind was released under BSD license, you can embed it in any project, if only you observe the license.",
     "main": "lib/jsmind.js",
     "module": "es/jsmind.js",

package/types/generated/jsmind.d.ts

@@ -220,30 +220,47 @@ declare class jsMind {
      */
     add_node(parent_node: string | import("./jsmind.node.js").Node, node_id: string, topic: string, data?: Record<string, any> | undefined, direction?: ("left" | "center" | "right" | "-1" | "0" | "1" | number) | undefined): import("./jsmind.node.js").Node | null;
     /**
-     * Add multiple nodes to the mind map with optimized performance.
-     * Supports standard jsMind formats: node_tree, node_array, and freemind with nested children structure.
+     * Add multiple nodes in batch.
+     *
+     * This method provides atomic batch node creation with automatic rollback on failure.
+     * All nodes are created in a single operation, and if any node fails to create,
+     * all previously created nodes in this batch will be automatically removed.
+     *
+     * **Note**: This is a batch operation API that uses standard field names only.
+     * For data import with custom fieldNames, use `show()` instead.
+     *
+     * @example
+     * // Using standard field names
+     * jm.add_nodes('parent_id', [
+     *     { id: 'node1', topic: 'Node 1', data: { color: 'red' }, children: [
+     *         { id: 'node1-1', topic: 'Child 1' }
+     *     ]}
+     * ]);
+     *
      * @param {string | import('./jsmind.node.js').Node} parent_node - Parent node for all new nodes
-     * @param {Array<{id?: string, topic?: string, data?: Record<string, any>, direction?: ('left'|'center'|'right'|'-1'|'0'|'1'|number), children?: Array, [key: string]: any}>} nodes_data - Array of node data objects with same format as add_node
+     * @param {Array<{id: string, topic: string, data?: Record<string, any>, direction?: ('left'|'center'|'right'|'-1'|'0'|'1'|number), children?: Array}>} nodes_data - Array of node data objects with standard field names (id, topic, children, data, direction)
      * @returns {Array<import('./jsmind.node.js').Node|null>} Array of created nodes (flattened from all levels)
      */
     add_nodes(parent_node: string | import("./jsmind.node.js").Node, nodes_data: Array<{
-        id?: string;
-        topic?: string;
+        id: string;
+        topic: string;
         data?: Record<string, any>;
         direction?: ("left" | "center" | "right" | "-1" | "0" | "1" | number);
         children?: any[];
-        [key: string]: any;
     }>): Array<import("./jsmind.node.js").Node | null>;
     /**
-     * Recursively add nodes using existing format processors.
+     * Recursively add nodes using standard field names.
+     * This is a batch operation API that uses standard field names only.
+     * For data import with custom fieldNames, use `show()` instead.
      * @private
      * @param {import('./jsmind.node.js').Node} parent_node
-     * @param {object} node_data
+     * @param {object} node_data - Node data object with standard field names (id, topic, children, data, direction)
      * @returns {Array<import('./jsmind.node.js').Node|null>}
      */
     private _add_nodes_recursive;
     /**
      * Count expected nodes recursively.
+     * Supports custom field names via options.fieldNames configuration.
      * @private
      * @param {Array} nodes_data
      * @returns {number}
@@ -282,11 +299,14 @@ declare class jsMind {
      */
     remove_node(node: string | import("./jsmind.node.js").Node): boolean;
     /**
-     * Update the topic (text content) of a node.
+     * Update the topic (text content) and/or data of a node.
      * @param {string} node_id
-     * @param {string} topic
+     * @param {string|{topic?:string, data?:Record<string,any>}} topic_or_options - Topic string or options object
      */
-    update_node(node_id: string, topic: string): void;
+    update_node(node_id: string, topic_or_options: string | {
+        topic?: string;
+        data?: Record<string, any>;
+    }): void;
     /**
      * Move a node and optionally change direction.
      * @param {string} node_id
@@ -300,7 +320,14 @@ declare class jsMind {
      * @returns {void}
      */
     select_node(node: string | import("./jsmind.node.js").Node): void;
-    /** @returns {import('./jsmind.node.js').Node|null} */
+    /**
+     * Get the currently selected node.
+     *
+     * This is a query API that returns the internal Node instance.
+     * For data export with custom fieldNames, use `get_data()` instead.
+     *
+     * @returns {import('./jsmind.node.js').Node|null} Node instance or null
+     */
     get_selected_node(): import("./jsmind.node.js").Node | null;
     /** clear selection */
     select_clear(): void;

package/types/generated/jsmind.node.d.ts

@@ -59,4 +59,11 @@ export class Node {
         w: number;
         h: number;
     };
+    /**
+     * Convert node to plain object with custom field names.
+     * @param {Record<string,string>=} fieldNames - Field names mapping
+     * @param {boolean=} includeChildren - Whether to include children nodes (default: false)
+     * @returns {Record<string, any>} Plain object representation of node
+     */
+    toObject(fieldNames?: Record<string, string> | undefined, includeChildren?: boolean | undefined): Record<string, any>;
 }