netscape-bookmark-parser 1.1.2 → 1.1.4

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

@@ -5,12 +5,114 @@
  * 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.HTMLString;
+     * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
+     * ```
+     */
+    get HTMLString(): string;
+    /**
+     * @deprecated Use {@link HTMLString} instead.
+     *
+     * Gets the BookmarksTree as an HTML string in Netscape Bookmark format.
+     */
     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,UAAU,IAAI,MAAM,CA+CvB;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;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,10 +142,40 @@ 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");
+        return new DOMParser().parseFromString(this.HTMLString, "text/html");
     }
-    get HTMLText() {
+    /**
+     * 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.HTMLString;
+     * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
+     * ```
+     */
+    get HTMLString() {
         const escapeHtml = (text) => {
             return text
                 .replace(/&/g, "&amp;")
@@ -118,4 +214,12 @@ ${createBookmarkList(this)}</BODY>
 </HTML>`;
         return htmlTemplate;
     }
+    /**
+     * @deprecated Use {@link HTMLString} instead.
+     *
+     * Gets the BookmarksTree as an HTML string in Netscape Bookmark format.
+     */
+    get HTMLText() {
+        return this.HTMLString;
+    }
 }

package/package.json

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