netscape-bookmark-parser 1.1.2 → 1.1.3

package/README-ja.md

@@ -1,10 +1,10 @@
 # Netscape Bookmark Parser
 
+ブラウザのブックマークファイル（HTML 形式）を解析し、構造化データとして操作するための TypeScript/JavaScript ライブラリです。Deno と Node.js の両方のランタイムに対応しています。
+
 > **注意:**  
 > この README は AI 生成されたドキュメントです。詳細はほぼ正確ですが、不正確な説明が含まれる可能性があります。
 
-ブラウザのブックマークファイル（HTML 形式）を解析し、構造化データとして操作するための TypeScript/JavaScript ライブラリです。Deno と Node.js の両方のランタイムに対応しています。
-
 ## 機能
 
 - **HTML ブックマークファイルの解析**: Chrome、Firefox、Safari、その他のブラウザからエクスポートされた HTML ブックマークファイルを解析
@@ -22,6 +22,10 @@
 npm install netscape-bookmark-parser
 ```
 
+```typescript
+import { BookmarksParser, BookmarksTree } from "netscape-bookmark-parser";
+```
+
 ### Deno
 
 ```typescript
@@ -58,26 +62,13 @@ function handleFileUpload(event: Event) {
 }
 ```
 
-#### オプション 2: 直接 ES モジュールインポート
-
-```html
-<script type="module">
-	import {
-		BookmarksParser,
-		BookmarksTree,
-	} from "./node_modules/netscape-bookmark-parser/esm/mod_web.js";
-
-	// ブックマーク処理コードをここに...
-</script>
-```
-
-#### オプション 3: Import Maps を使用した CDN
+#### オプション 2: Import Maps を使用した CDN
 
 ```html
 <script type="importmap">
 	{
 		"imports": {
-			"netscape-bookmark-parser/web": "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.2/esm/mod_web.js"
+			"netscape-bookmark-parser/web": "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.3/esm/mod_web.js"
 		}
 	}
 </script>
@@ -89,14 +80,14 @@ function handleFileUpload(event: Event) {
 </script>
 ```
 
-#### オプション 4: CDN を直接インポート
+#### オプション 3: CDN を直接インポート
 
 ```html
 <script type="module">
 	import {
 		BookmarksParser,
 		BookmarksTree,
-	} from "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.2/esm/mod_web.js";
+	} from "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.3/esm/mod_web.js";
 
 	// import maps なしでの直接 CDN インポート
 </script>
@@ -622,7 +613,12 @@ MIT License - 詳細は[LICENSE](LICENSE)ファイルを参照してください
 
 ## 変更履歴
 
-### v1.1.2（最新）
+### v1.1.3（最新）
+
+- 📝 **JSDoc コメント追加**: 主要なクラス・メソッドに JSDoc 形式のコメントを追加し、型情報と API 自動ドキュメント生成を強化
+- 📚 **ドキュメント更新**: インストール手順（Node.js/npm）に TypeScript でのインポート例を追加
+
+### v1.1.2
 
 - 📝 **ドキュメント強化**: 最新バージョン参照と改善された例を含む包括的な README ドキュメントの更新
 - 🔧 **バージョン一貫性**: 全ドキュメントとコード例でのバージョン番号の同期

package/README.md

@@ -1,11 +1,10 @@
 # Netscape Bookmark Parser
 
-> **Note:**  
-> This README is an AI-generated document. Details are mostly accurate but might include inaccurate description.
-
 A TypeScript/JavaScript library for parsing browser bookmark files (HTML format) and manipulating them as structured data. Compatible with both Deno and Node.js runtimes.
 
-日本語ドキュメント: [`./README-ja.md`](./README-ja.md)
+> **Note:**  
+> This README is an AI-generated document. Details are mostly accurate but might include inaccurate description.
+> 日本語ドキュメント: [`./README-ja.md`](./README-ja.md)
 
 ## Features
 
@@ -24,6 +23,10 @@ A TypeScript/JavaScript library for parsing browser bookmark files (HTML format)
 npm install netscape-bookmark-parser
 ```
 
+```typescript
+import { BookmarksParser, BookmarksTree } from "netscape-bookmark-parser";
+```
+
 ### Deno
 
 ```typescript
@@ -60,26 +63,13 @@ function handleFileUpload(event: Event) {
 }
 ```
 
-#### Option 2: Direct ES Module Import
-
-```html
-<script type="module">
-	import {
-		BookmarksParser,
-		BookmarksTree,
-	} from "./node_modules/netscape-bookmark-parser/esm/mod_web.js";
-
-	// Your bookmark processing code here...
-</script>
-```
-
-#### Option 3: CDN with Import Maps
+#### Option 2: CDN with Import Maps
 
 ```html
 <script type="importmap">
 	{
 		"imports": {
-			"netscape-bookmark-parser/web": "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.2/esm/mod_web.js"
+			"netscape-bookmark-parser/web": "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.3/esm/mod_web.js"
 		}
 	}
 </script>
@@ -91,14 +81,14 @@ function handleFileUpload(event: Event) {
 </script>
 ```
 
-#### Option 4: Direct CDN Import
+#### Option 3: Direct CDN Import
 
 ```html
 <script type="module">
 	import {
 		BookmarksParser,
 		BookmarksTree,
-	} from "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.2/esm/mod_web.js";
+	} from "https://cdn.jsdelivr.net/npm/netscape-bookmark-parser@1.1.3/esm/mod_web.js";
 
 	// Direct CDN import without import maps
 </script>
@@ -623,7 +613,12 @@ When reporting issues, please include:
 
 ## Changelog
 
-### v1.1.2 (Latest)
+### v1.1.3 (Latest)
+
+- 📝 **Added JSDoc comments**: Added JSDoc-style comments to major classes and methods to improve type information and enable automatic API documentation generation
+- 📚 **Documentation Update**: Added TypeScript import example for Node.js/npm in the Installation section
+
+### v1.1.2
 
 - 📝 **Documentation Enhancement**: Updated comprehensive README documentation with latest version references and improved examples
 - 🔧 **Version Consistency**: Synchronized version numbers across all documentation and code examples

package/esm/src/BookmarksParser/BookmarksParser.d.ts

@@ -5,7 +5,62 @@
  * https://opensource.org/licenses/MIT
  */
 import { BookmarksTree } from "../BookmarksTree/index.js";
+/**
+ * A parser for Netscape Bookmark format files
+ *
+ * This class provides static methods to parse Netscape Bookmark format HTML strings
+ * and convert them into BookmarksTree instances for easier manipulation.
+ *
+ * @example
+ * ```typescript
+ * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+ * <HTML>
+ * <BODY>
+ * <DL><p>
+ *     <DT><A HREF="https://google.com">Google</A>
+ *     <DT><H3>Development</H3>
+ *     <DL><p>
+ *         <DT><A HREF="https://github.com">GitHub</A>
+ *     </DL><p>
+ * </DL>
+ * </BODY>
+ * </HTML>`;
+ *
+ * const tree = BookmarksParser.parse(bookmarkHtml);
+ * ```
+ */
 export declare class BookmarksParser {
+    /**
+     * Parses a Netscape Bookmark format HTML string into a BookmarksTree
+     *
+     * Takes an HTML string in Netscape Bookmark format and converts it into a structured
+     * BookmarksTree that preserves the hierarchical organization of folders and bookmarks.
+     *
+     * @param data The HTML string in Netscape Bookmark format to parse
+     * @returns A BookmarksTree representing the parsed bookmark structure
+     *
+     * @example
+     * ```typescript
+     * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+     * <HTML>
+     * <BODY>
+     * <DL><p>
+     *     <DT><A HREF="https://google.com">Google</A>
+     *     <DT><H3>Development</H3>
+     *     <DL><p>
+     *         <DT><A HREF="https://github.com">GitHub</A>
+     *     </DL><p>
+     * </DL>
+     * </BODY>
+     * </HTML>`;
+     *
+     * const tree = BookmarksParser.parse(bookmarkHtml);
+     * console.log(tree.get("Google")); // "https://google.com"
+     *
+     * const folder = tree.get("Development");
+     * console.log(folder.get("GitHub")); // "https://github.com"
+     * ```
+     */
     static parse(data: string): BookmarksTree;
 }
 //# sourceMappingURL=BookmarksParser.d.ts.map

package/esm/src/BookmarksParser/BookmarksParser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BookmarksParser.d.ts","sourceRoot":"","sources":["../../../src/src/BookmarksParser/BookmarksParser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,qBAAa,eAAe;IAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;CAKzC"}
+{"version":3,"file":"BookmarksParser.d.ts","sourceRoot":"","sources":["../../../src/src/BookmarksParser/BookmarksParser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,eAAe;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;CAKzC"}

package/esm/src/BookmarksParser/BookmarksParser.js

@@ -6,7 +6,62 @@
  */
 import { DOMParser } from "../deps.js";
 import { BookmarksTree } from "../BookmarksTree/index.js";
+/**
+ * A parser for Netscape Bookmark format files
+ *
+ * This class provides static methods to parse Netscape Bookmark format HTML strings
+ * and convert them into BookmarksTree instances for easier manipulation.
+ *
+ * @example
+ * ```typescript
+ * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+ * <HTML>
+ * <BODY>
+ * <DL><p>
+ *     <DT><A HREF="https://google.com">Google</A>
+ *     <DT><H3>Development</H3>
+ *     <DL><p>
+ *         <DT><A HREF="https://github.com">GitHub</A>
+ *     </DL><p>
+ * </DL>
+ * </BODY>
+ * </HTML>`;
+ *
+ * const tree = BookmarksParser.parse(bookmarkHtml);
+ * ```
+ */
 export class BookmarksParser {
+    /**
+     * Parses a Netscape Bookmark format HTML string into a BookmarksTree
+     *
+     * Takes an HTML string in Netscape Bookmark format and converts it into a structured
+     * BookmarksTree that preserves the hierarchical organization of folders and bookmarks.
+     *
+     * @param data The HTML string in Netscape Bookmark format to parse
+     * @returns A BookmarksTree representing the parsed bookmark structure
+     *
+     * @example
+     * ```typescript
+     * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+     * <HTML>
+     * <BODY>
+     * <DL><p>
+     *     <DT><A HREF="https://google.com">Google</A>
+     *     <DT><H3>Development</H3>
+     *     <DL><p>
+     *         <DT><A HREF="https://github.com">GitHub</A>
+     *     </DL><p>
+     * </DL>
+     * </BODY>
+     * </HTML>`;
+     *
+     * const tree = BookmarksParser.parse(bookmarkHtml);
+     * console.log(tree.get("Google")); // "https://google.com"
+     *
+     * const folder = tree.get("Development");
+     * console.log(folder.get("GitHub")); // "https://github.com"
+     * ```
+     */
     static parse(data) {
         const dom = new DOMParser().parseFromString(data, "text/html");
         const tree = BookmarksTree.fromDOM(dom);

package/esm/src/BookmarksTree/BookmarksTree.d.ts

@@ -5,12 +5,108 @@
  * https://opensource.org/licenses/MIT
  */
 import { type HTMLDocument } from "../deps.js";
+/**
+ * A class representing a bookmark tree in Netscape Bookmark format
+ *
+ * This class extends Map and manages folders (BookmarksTree) and bookmarks (URL strings)
+ * in a hierarchical structure.
+ *
+ * @example
+ * ```typescript
+ * const tree = new BookmarksTree();
+ * tree.set("Google", "https://google.com");
+ *
+ * const folder = new BookmarksTree();
+ * folder.set("GitHub", "https://github.com");
+ * tree.set("Development", folder);
+ * ```
+ */
 export declare class BookmarksTree extends Map<string, string | BookmarksTree> {
+    /**
+     * Creates a new BookmarksTree instance
+     */
     constructor();
+    /**
+     * Converts the BookmarksTree to a JSON object
+     *
+     * Folders are recursively converted to objects, and bookmarks are preserved as strings.
+     *
+     * @returns JSON object representation of the bookmark data
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const json = tree.toJSON();
+     * // { "Google": "https://google.com" }
+     * ```
+     */
     toJSON(): Record<string, unknown>;
+    /**
+     * Creates a BookmarksTree from a JSON object
+     *
+     * String properties are treated as bookmarks, and object properties are
+     * recursively processed as folders.
+     *
+     * @param json The source JSON object to convert
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const json = { "Google": "https://google.com", "Development": { "GitHub": "https://github.com" } };
+     * const tree = BookmarksTree.fromJSON(json);
+     * ```
+     */
     static fromJSON(json: Record<string, unknown>): BookmarksTree;
+    /**
+     * Creates a BookmarksTree from an HTML document (Netscape Bookmark format)
+     *
+     * Parses Netscape Bookmark format HTML and generates a BookmarksTree that preserves
+     * the hierarchical structure. H3 elements within DT elements are treated as folders,
+     * and A elements are treated as bookmarks.
+     *
+     * @param dom The HTML document to parse
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const parser = new DOMParser();
+     * const dom = parser.parseFromString(bookmarkHtml, "text/html");
+     * const tree = BookmarksTree.fromDOM(dom);
+     * ```
+     */
     static fromDOM(dom: HTMLDocument): BookmarksTree;
+    /**
+     * Converts the BookmarksTree to an HTML document
+     *
+     * Generates an HTML document in Netscape Bookmark format.
+     *
+     * @returns HTML document in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const dom = tree.toDOM();
+     * ```
+     */
     toDOM(): HTMLDocument;
+    /**
+     * Gets the BookmarksTree as an HTML string in Netscape Bookmark format
+     *
+     * Generates a complete HTML document string including DOCTYPE, metadata, and body
+     * in Netscape Bookmark format.
+     *
+     * @returns HTML string in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const html = tree.HTMLText;
+     * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
+     * ```
+     */
     get HTMLText(): string;
 }
 //# sourceMappingURL=BookmarksTree.d.ts.map

package/esm/src/BookmarksTree/BookmarksTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BookmarksTree.d.ts","sourceRoot":"","sources":["../../../src/src/BookmarksTree/BookmarksTree.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAExE,qBAAa,aAAc,SAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;;IAKrE,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAcjC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa;IAmB7D,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IA8ChD,KAAK,IAAI,YAAY;IAIrB,IAAI,QAAQ,IAAI,MAAM,CA+CrB;CACD"}
+{"version":3,"file":"BookmarksTree.d.ts","sourceRoot":"","sources":["../../../src/src/BookmarksTree/BookmarksTree.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAExE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;IACrE;;OAEG;;IAKH;;;;;;;;;;;;;;OAcG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAcjC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa;IAmB7D;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IA8ChD;;;;;;;;;;;;;OAaG;IACH,KAAK,IAAI,YAAY;IAIrB;;;;;;;;;;;;;;;OAeG;IACH,IAAI,QAAQ,IAAI,MAAM,CA+CrB;CACD"}

package/esm/src/BookmarksTree/BookmarksTree.js

@@ -5,10 +5,44 @@
  * https://opensource.org/licenses/MIT
  */
 import { DOMParser } from "../deps.js";
+/**
+ * A class representing a bookmark tree in Netscape Bookmark format
+ *
+ * This class extends Map and manages folders (BookmarksTree) and bookmarks (URL strings)
+ * in a hierarchical structure.
+ *
+ * @example
+ * ```typescript
+ * const tree = new BookmarksTree();
+ * tree.set("Google", "https://google.com");
+ *
+ * const folder = new BookmarksTree();
+ * folder.set("GitHub", "https://github.com");
+ * tree.set("Development", folder);
+ * ```
+ */
 export class BookmarksTree extends Map {
+    /**
+     * Creates a new BookmarksTree instance
+     */
     constructor() {
         super();
     }
+    /**
+     * Converts the BookmarksTree to a JSON object
+     *
+     * Folders are recursively converted to objects, and bookmarks are preserved as strings.
+     *
+     * @returns JSON object representation of the bookmark data
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const json = tree.toJSON();
+     * // { "Google": "https://google.com" }
+     * ```
+     */
     toJSON() {
         const json = {};
         for (const [key, value] of this.entries()) {
@@ -21,6 +55,21 @@ export class BookmarksTree extends Map {
         }
         return json;
     }
+    /**
+     * Creates a BookmarksTree from a JSON object
+     *
+     * String properties are treated as bookmarks, and object properties are
+     * recursively processed as folders.
+     *
+     * @param json The source JSON object to convert
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const json = { "Google": "https://google.com", "Development": { "GitHub": "https://github.com" } };
+     * const tree = BookmarksTree.fromJSON(json);
+     * ```
+     */
     static fromJSON(json) {
         const tree = new BookmarksTree();
         if (typeof json === "object" && json !== null) {
@@ -35,6 +84,23 @@ export class BookmarksTree extends Map {
         }
         return tree;
     }
+    /**
+     * Creates a BookmarksTree from an HTML document (Netscape Bookmark format)
+     *
+     * Parses Netscape Bookmark format HTML and generates a BookmarksTree that preserves
+     * the hierarchical structure. H3 elements within DT elements are treated as folders,
+     * and A elements are treated as bookmarks.
+     *
+     * @param dom The HTML document to parse
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const parser = new DOMParser();
+     * const dom = parser.parseFromString(bookmarkHtml, "text/html");
+     * const tree = BookmarksTree.fromDOM(dom);
+     * ```
+     */
     static fromDOM(dom) {
         const tree = new BookmarksTree();
         const document = dom;
@@ -76,9 +142,39 @@ export class BookmarksTree extends Map {
         }
         return tree;
     }
+    /**
+     * Converts the BookmarksTree to an HTML document
+     *
+     * Generates an HTML document in Netscape Bookmark format.
+     *
+     * @returns HTML document in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const dom = tree.toDOM();
+     * ```
+     */
     toDOM() {
         return new DOMParser().parseFromString(this.HTMLText, "text/html");
     }
+    /**
+     * Gets the BookmarksTree as an HTML string in Netscape Bookmark format
+     *
+     * Generates a complete HTML document string including DOCTYPE, metadata, and body
+     * in Netscape Bookmark format.
+     *
+     * @returns HTML string in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const html = tree.HTMLText;
+     * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
+     * ```
+     */
     get HTMLText() {
         const escapeHtml = (text) => {
             return text

package/esm/src/web/BookmarksParser/BookmarksParser.d.ts

@@ -5,7 +5,62 @@
  * https://opensource.org/licenses/MIT
  */
 import { BookmarksTree } from "../BookmarksTree/index.js";
+/**
+ * A parser for Netscape Bookmark format files
+ *
+ * This class provides static methods to parse Netscape Bookmark format HTML strings
+ * and convert them into BookmarksTree instances for easier manipulation.
+ *
+ * @example
+ * ```typescript
+ * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+ * <HTML>
+ * <BODY>
+ * <DL><p>
+ *     <DT><A HREF="https://google.com">Google</A>
+ *     <DT><H3>Development</H3>
+ *     <DL><p>
+ *         <DT><A HREF="https://github.com">GitHub</A>
+ *     </DL><p>
+ * </DL>
+ * </BODY>
+ * </HTML>`;
+ *
+ * const tree = BookmarksParser.parse(bookmarkHtml);
+ * ```
+ */
 export declare class BookmarksParser {
+    /**
+     * Parses a Netscape Bookmark format HTML string into a BookmarksTree
+     *
+     * Takes an HTML string in Netscape Bookmark format and converts it into a structured
+     * BookmarksTree that preserves the hierarchical organization of folders and bookmarks.
+     *
+     * @param data The HTML string in Netscape Bookmark format to parse
+     * @returns A BookmarksTree representing the parsed bookmark structure
+     *
+     * @example
+     * ```typescript
+     * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+     * <HTML>
+     * <BODY>
+     * <DL><p>
+     *     <DT><A HREF="https://google.com">Google</A>
+     *     <DT><H3>Development</H3>
+     *     <DL><p>
+     *         <DT><A HREF="https://github.com">GitHub</A>
+     *     </DL><p>
+     * </DL>
+     * </BODY>
+     * </HTML>`;
+     *
+     * const tree = BookmarksParser.parse(bookmarkHtml);
+     * console.log(tree.get("Google")); // "https://google.com"
+     *
+     * const folder = tree.get("Development");
+     * console.log(folder.get("GitHub")); // "https://github.com"
+     * ```
+     */
     static parse(data: string): BookmarksTree;
 }
 //# sourceMappingURL=BookmarksParser.d.ts.map

package/esm/src/web/BookmarksParser/BookmarksParser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BookmarksParser.d.ts","sourceRoot":"","sources":["../../../../src/src/web/BookmarksParser/BookmarksParser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,qBAAa,eAAe;IAC3B,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;CAKzC"}
+{"version":3,"file":"BookmarksParser.d.ts","sourceRoot":"","sources":["../../../../src/src/web/BookmarksParser/BookmarksParser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,eAAe;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;CAKzC"}

package/esm/src/web/BookmarksParser/BookmarksParser.js

@@ -6,7 +6,62 @@
  */
 import { DOMParser } from "../deps.js";
 import { BookmarksTree } from "../BookmarksTree/index.js";
+/**
+ * A parser for Netscape Bookmark format files
+ *
+ * This class provides static methods to parse Netscape Bookmark format HTML strings
+ * and convert them into BookmarksTree instances for easier manipulation.
+ *
+ * @example
+ * ```typescript
+ * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+ * <HTML>
+ * <BODY>
+ * <DL><p>
+ *     <DT><A HREF="https://google.com">Google</A>
+ *     <DT><H3>Development</H3>
+ *     <DL><p>
+ *         <DT><A HREF="https://github.com">GitHub</A>
+ *     </DL><p>
+ * </DL>
+ * </BODY>
+ * </HTML>`;
+ *
+ * const tree = BookmarksParser.parse(bookmarkHtml);
+ * ```
+ */
 export class BookmarksParser {
+    /**
+     * Parses a Netscape Bookmark format HTML string into a BookmarksTree
+     *
+     * Takes an HTML string in Netscape Bookmark format and converts it into a structured
+     * BookmarksTree that preserves the hierarchical organization of folders and bookmarks.
+     *
+     * @param data The HTML string in Netscape Bookmark format to parse
+     * @returns A BookmarksTree representing the parsed bookmark structure
+     *
+     * @example
+     * ```typescript
+     * const bookmarkHtml = `<!DOCTYPE NETSCAPE-Bookmark-file-1>
+     * <HTML>
+     * <BODY>
+     * <DL><p>
+     *     <DT><A HREF="https://google.com">Google</A>
+     *     <DT><H3>Development</H3>
+     *     <DL><p>
+     *         <DT><A HREF="https://github.com">GitHub</A>
+     *     </DL><p>
+     * </DL>
+     * </BODY>
+     * </HTML>`;
+     *
+     * const tree = BookmarksParser.parse(bookmarkHtml);
+     * console.log(tree.get("Google")); // "https://google.com"
+     *
+     * const folder = tree.get("Development");
+     * console.log(folder.get("GitHub")); // "https://github.com"
+     * ```
+     */
     static parse(data) {
         const dom = new DOMParser().parseFromString(data, "text/html");
         const tree = BookmarksTree.fromDOM(dom);

package/esm/src/web/BookmarksTree/BookmarksTree.d.ts

@@ -5,12 +5,108 @@
  * https://opensource.org/licenses/MIT
  */
 import { type HTMLDocument } from "../deps.js";
+/**
+ * A class representing a bookmark tree in Netscape Bookmark format
+ *
+ * This class extends Map and manages folders (BookmarksTree) and bookmarks (URL strings)
+ * in a hierarchical structure.
+ *
+ * @example
+ * ```typescript
+ * const tree = new BookmarksTree();
+ * tree.set("Google", "https://google.com");
+ *
+ * const folder = new BookmarksTree();
+ * folder.set("GitHub", "https://github.com");
+ * tree.set("Development", folder);
+ * ```
+ */
 export declare class BookmarksTree extends Map<string, string | BookmarksTree> {
+    /**
+     * Creates a new BookmarksTree instance
+     */
     constructor();
+    /**
+     * Converts the BookmarksTree to a JSON object
+     *
+     * Folders are recursively converted to objects, and bookmarks are preserved as strings.
+     *
+     * @returns JSON object representation of the bookmark data
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const json = tree.toJSON();
+     * // { "Google": "https://google.com" }
+     * ```
+     */
     toJSON(): Record<string, unknown>;
+    /**
+     * Creates a BookmarksTree from a JSON object
+     *
+     * String properties are treated as bookmarks, and object properties are
+     * recursively processed as folders.
+     *
+     * @param json The source JSON object to convert
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const json = { "Google": "https://google.com", "Development": { "GitHub": "https://github.com" } };
+     * const tree = BookmarksTree.fromJSON(json);
+     * ```
+     */
     static fromJSON(json: Record<string, unknown>): BookmarksTree;
+    /**
+     * Creates a BookmarksTree from an HTML document (Netscape Bookmark format)
+     *
+     * Parses Netscape Bookmark format HTML and generates a BookmarksTree that preserves
+     * the hierarchical structure. H3 elements within DT elements are treated as folders,
+     * and A elements are treated as bookmarks.
+     *
+     * @param dom The HTML document to parse
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const parser = new DOMParser();
+     * const dom = parser.parseFromString(bookmarkHtml, "text/html");
+     * const tree = BookmarksTree.fromDOM(dom);
+     * ```
+     */
     static fromDOM(dom: HTMLDocument): BookmarksTree;
+    /**
+     * Converts the BookmarksTree to an HTML document
+     *
+     * Generates an HTML document in Netscape Bookmark format.
+     *
+     * @returns HTML document in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const dom = tree.toDOM();
+     * ```
+     */
     toDOM(): HTMLDocument;
+    /**
+     * Gets the BookmarksTree as an HTML string in Netscape Bookmark format
+     *
+     * Generates a complete HTML document string including DOCTYPE, metadata, and body
+     * in Netscape Bookmark format.
+     *
+     * @returns HTML string in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const html = tree.HTMLText;
+     * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
+     * ```
+     */
     get HTMLText(): string;
 }
 //# sourceMappingURL=BookmarksTree.d.ts.map

package/esm/src/web/BookmarksTree/BookmarksTree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BookmarksTree.d.ts","sourceRoot":"","sources":["../../../../src/src/web/BookmarksTree/BookmarksTree.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAExE,qBAAa,aAAc,SAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;;IAKrE,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAcjC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa;IAmB7D,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IA8ChD,KAAK,IAAI,YAAY;IAIrB,IAAI,QAAQ,IAAI,MAAM,CA+CrB;CACD"}
+{"version":3,"file":"BookmarksTree.d.ts","sourceRoot":"","sources":["../../../../src/src/web/BookmarksTree/BookmarksTree.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAA2B,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAExE;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,CAAC;IACrE;;OAEG;;IAKH;;;;;;;;;;;;;;OAcG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAcjC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa;IAmB7D;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IA8ChD;;;;;;;;;;;;;OAaG;IACH,KAAK,IAAI,YAAY;IAIrB;;;;;;;;;;;;;;;OAeG;IACH,IAAI,QAAQ,IAAI,MAAM,CA+CrB;CACD"}

package/esm/src/web/BookmarksTree/BookmarksTree.js

@@ -5,10 +5,44 @@
  * https://opensource.org/licenses/MIT
  */
 import { DOMParser } from "../deps.js";
+/**
+ * A class representing a bookmark tree in Netscape Bookmark format
+ *
+ * This class extends Map and manages folders (BookmarksTree) and bookmarks (URL strings)
+ * in a hierarchical structure.
+ *
+ * @example
+ * ```typescript
+ * const tree = new BookmarksTree();
+ * tree.set("Google", "https://google.com");
+ *
+ * const folder = new BookmarksTree();
+ * folder.set("GitHub", "https://github.com");
+ * tree.set("Development", folder);
+ * ```
+ */
 export class BookmarksTree extends Map {
+    /**
+     * Creates a new BookmarksTree instance
+     */
     constructor() {
         super();
     }
+    /**
+     * Converts the BookmarksTree to a JSON object
+     *
+     * Folders are recursively converted to objects, and bookmarks are preserved as strings.
+     *
+     * @returns JSON object representation of the bookmark data
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const json = tree.toJSON();
+     * // { "Google": "https://google.com" }
+     * ```
+     */
     toJSON() {
         const json = {};
         for (const [key, value] of this.entries()) {
@@ -21,6 +55,21 @@ export class BookmarksTree extends Map {
         }
         return json;
     }
+    /**
+     * Creates a BookmarksTree from a JSON object
+     *
+     * String properties are treated as bookmarks, and object properties are
+     * recursively processed as folders.
+     *
+     * @param json The source JSON object to convert
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const json = { "Google": "https://google.com", "Development": { "GitHub": "https://github.com" } };
+     * const tree = BookmarksTree.fromJSON(json);
+     * ```
+     */
     static fromJSON(json) {
         const tree = new BookmarksTree();
         if (typeof json === "object" && json !== null) {
@@ -35,6 +84,23 @@ export class BookmarksTree extends Map {
         }
         return tree;
     }
+    /**
+     * Creates a BookmarksTree from an HTML document (Netscape Bookmark format)
+     *
+     * Parses Netscape Bookmark format HTML and generates a BookmarksTree that preserves
+     * the hierarchical structure. H3 elements within DT elements are treated as folders,
+     * and A elements are treated as bookmarks.
+     *
+     * @param dom The HTML document to parse
+     * @returns A new BookmarksTree instance
+     *
+     * @example
+     * ```typescript
+     * const parser = new DOMParser();
+     * const dom = parser.parseFromString(bookmarkHtml, "text/html");
+     * const tree = BookmarksTree.fromDOM(dom);
+     * ```
+     */
     static fromDOM(dom) {
         const tree = new BookmarksTree();
         const document = dom;
@@ -76,9 +142,39 @@ export class BookmarksTree extends Map {
         }
         return tree;
     }
+    /**
+     * Converts the BookmarksTree to an HTML document
+     *
+     * Generates an HTML document in Netscape Bookmark format.
+     *
+     * @returns HTML document in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const dom = tree.toDOM();
+     * ```
+     */
     toDOM() {
         return new DOMParser().parseFromString(this.HTMLText, "text/html");
     }
+    /**
+     * Gets the BookmarksTree as an HTML string in Netscape Bookmark format
+     *
+     * Generates a complete HTML document string including DOCTYPE, metadata, and body
+     * in Netscape Bookmark format.
+     *
+     * @returns HTML string in Netscape Bookmark format
+     *
+     * @example
+     * ```typescript
+     * const tree = new BookmarksTree();
+     * tree.set("Google", "https://google.com");
+     * const html = tree.HTMLText;
+     * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
+     * ```
+     */
     get HTMLText() {
         const escapeHtml = (text) => {
             return text

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "netscape-bookmark-parser",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "keywords": [
     "bookmark",
     "parser",