netscape-bookmark-parser 1.1.3 → 1.1.4

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

@@ -103,10 +103,16 @@ export declare class BookmarksTree extends Map<string, string | BookmarksTree> {
      * ```typescript
      * const tree = new BookmarksTree();
      * tree.set("Google", "https://google.com");
-     * const html = tree.HTMLText;
+     * 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/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;;;;;;;;;;;;;;;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"}
+{"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,UAAU,IAAI,MAAM,CA+CvB;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;CACD"}

package/esm/src/BookmarksTree/BookmarksTree.js

@@ -157,7 +157,7 @@ export class BookmarksTree extends Map {
      * ```
      */
     toDOM() {
-        return new DOMParser().parseFromString(this.HTMLText, "text/html");
+        return new DOMParser().parseFromString(this.HTMLString, "text/html");
     }
     /**
      * Gets the BookmarksTree as an HTML string in Netscape Bookmark format
@@ -171,11 +171,11 @@ export class BookmarksTree extends Map {
      * ```typescript
      * const tree = new BookmarksTree();
      * tree.set("Google", "https://google.com");
-     * const html = tree.HTMLText;
+     * const html = tree.HTMLString;
      * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
      * ```
      */
-    get HTMLText() {
+    get HTMLString() {
         const escapeHtml = (text) => {
             return text
                 .replace(/&/g, "&amp;")
@@ -214,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/esm/src/web/BookmarksParser/BookmarksParser.d.ts

@@ -4,6 +4,7 @@
  * This software is released under the MIT License.
  * https://opensource.org/licenses/MIT
  */
+import type { HTMLDocument } from "../deps.js";
 import { BookmarksTree } from "../BookmarksTree/index.js";
 /**
  * A parser for Netscape Bookmark format files
@@ -31,13 +32,10 @@ import { BookmarksTree } from "../BookmarksTree/index.js";
  */
 export declare class BookmarksParser {
     /**
-     * Parses a Netscape Bookmark format HTML string into a BookmarksTree
+     * Alias for the {@link parseFromHTMLString} method.
      *
-     * 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
+     * @param htmlString HTML string in Netscape Bookmark format
+     * @returns The parsed BookmarksTree
      *
      * @example
      * ```typescript
@@ -55,12 +53,78 @@ export declare class BookmarksParser {
      * </HTML>`;
      *
      * const tree = BookmarksParser.parse(bookmarkHtml);
-     * console.log(tree.get("Google")); // "https://google.com"
+     * ```
+     */
+    static parse(htmlString: string): BookmarksTree;
+    /**
+     * Parses a Netscape Bookmark format HTML string and returns a BookmarksTree.
+     *
+     * @param htmlString HTML string in Netscape Bookmark format
+     * @returns The parsed BookmarksTree
+     *
+     * @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.parseFromHTMLString(bookmarkHtml);
+     * ```
+     */
+    static parseFromHTMLString(htmlString: string): BookmarksTree;
+    /**
+     * Creates a BookmarksTree from an existing HTMLDocument.
+     *
+     * This is an alias for {@link BookmarksTree.fromDOM}.
+     *
+     * Use this when you already have a parsed HTMLDocument and want to convert it to a BookmarksTree.
+     *
+     * @param dom An HTMLDocument instance
+     * @returns The parsed BookmarksTree
+     *
+     * @example
+     * ```typescript
+     * const dom = new DOMParser().parseFromString(bookmarkHtml, "text/html");
+     * const tree = BookmarksParser.parseFromDOM(dom);
+     * ```
+     */
+    static parseFromDOM(dom: HTMLDocument): BookmarksTree;
+    /**
+     * Parses a JSON string and returns a BookmarksTree.
      *
-     * const folder = tree.get("Development");
-     * console.log(folder.get("GitHub")); // "https://github.com"
+     * @param jsonString JSON string representing the bookmark structure
+     * @returns The parsed BookmarksTree
+     *
+     * @example
+     * ```typescript
+     * const json = '{"Google":"https://google.com","Development":{"GitHub":"https://github.com"}}';
+     * const tree = BookmarksParser.parseFromJSONString(json);
+     * ```
+     */
+    static parseFromJSONString(jsonString: string): BookmarksTree;
+    /**
+     * Parses a JSON object and returns a BookmarksTree.
+     *
+     * This is an alias for {@link BookmarksTree.fromJSON}.
+     *
+     * @param jsonObj JSON object representing the bookmark structure
+     * @returns The parsed BookmarksTree
+     *
+     * @example
+     * ```typescript
+     * const obj = { "Google": "https://google.com", "Development": { "GitHub": "https://github.com" } };
+     * const tree = BookmarksParser.parseFromJSON(obj);
      * ```
      */
-    static parse(data: string): BookmarksTree;
+    static parseFromJSON(jsonObj: Record<string, unknown>): 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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,eAAe;IAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,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,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,eAAe;IAC3B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAI/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAM7D;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa;IAIrD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa;IAK7D;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,aAAa;CAGrE"}

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

@@ -32,13 +32,10 @@ import { BookmarksTree } from "../BookmarksTree/index.js";
  */
 export class BookmarksParser {
     /**
-     * Parses a Netscape Bookmark format HTML string into a BookmarksTree
+     * Alias for the {@link parseFromHTMLString} method.
      *
-     * 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
+     * @param htmlString HTML string in Netscape Bookmark format
+     * @returns The parsed BookmarksTree
      *
      * @example
      * ```typescript
@@ -56,15 +53,90 @@ export class BookmarksParser {
      * </HTML>`;
      *
      * const tree = BookmarksParser.parse(bookmarkHtml);
-     * console.log(tree.get("Google")); // "https://google.com"
+     * ```
+     */
+    static parse(htmlString) {
+        return this.parseFromHTMLString(htmlString);
+    }
+    /**
+     * Parses a Netscape Bookmark format HTML string and returns a BookmarksTree.
+     *
+     * @param htmlString HTML string in Netscape Bookmark format
+     * @returns The parsed BookmarksTree
+     *
+     * @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 folder = tree.get("Development");
-     * console.log(folder.get("GitHub")); // "https://github.com"
+     * const tree = BookmarksParser.parseFromHTMLString(bookmarkHtml);
      * ```
      */
-    static parse(data) {
-        const dom = new DOMParser().parseFromString(data, "text/html");
+    static parseFromHTMLString(htmlString) {
+        const dom = new DOMParser().parseFromString(htmlString, "text/html");
         const tree = BookmarksTree.fromDOM(dom);
         return tree;
     }
+    /**
+     * Creates a BookmarksTree from an existing HTMLDocument.
+     *
+     * This is an alias for {@link BookmarksTree.fromDOM}.
+     *
+     * Use this when you already have a parsed HTMLDocument and want to convert it to a BookmarksTree.
+     *
+     * @param dom An HTMLDocument instance
+     * @returns The parsed BookmarksTree
+     *
+     * @example
+     * ```typescript
+     * const dom = new DOMParser().parseFromString(bookmarkHtml, "text/html");
+     * const tree = BookmarksParser.parseFromDOM(dom);
+     * ```
+     */
+    static parseFromDOM(dom) {
+        return BookmarksTree.fromDOM(dom);
+    }
+    /**
+     * Parses a JSON string and returns a BookmarksTree.
+     *
+     * @param jsonString JSON string representing the bookmark structure
+     * @returns The parsed BookmarksTree
+     *
+     * @example
+     * ```typescript
+     * const json = '{"Google":"https://google.com","Development":{"GitHub":"https://github.com"}}';
+     * const tree = BookmarksParser.parseFromJSONString(json);
+     * ```
+     */
+    static parseFromJSONString(jsonString) {
+        const obj = JSON.parse(jsonString);
+        return BookmarksTree.fromJSON(obj);
+    }
+    /**
+     * Parses a JSON object and returns a BookmarksTree.
+     *
+     * This is an alias for {@link BookmarksTree.fromJSON}.
+     *
+     * @param jsonObj JSON object representing the bookmark structure
+     * @returns The parsed BookmarksTree
+     *
+     * @example
+     * ```typescript
+     * const obj = { "Google": "https://google.com", "Development": { "GitHub": "https://github.com" } };
+     * const tree = BookmarksParser.parseFromJSON(obj);
+     * ```
+     */
+    static parseFromJSON(jsonObj) {
+        return BookmarksTree.fromJSON(jsonObj);
+    }
 }

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

@@ -103,10 +103,16 @@ export declare class BookmarksTree extends Map<string, string | BookmarksTree> {
      * ```typescript
      * const tree = new BookmarksTree();
      * tree.set("Google", "https://google.com");
-     * const html = tree.HTMLText;
+     * 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;;;;;;;;;;;;;;;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"}
+{"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

@@ -157,7 +157,7 @@ export class BookmarksTree extends Map {
      * ```
      */
     toDOM() {
-        return new DOMParser().parseFromString(this.HTMLText, "text/html");
+        return new DOMParser().parseFromString(this.HTMLString, "text/html");
     }
     /**
      * Gets the BookmarksTree as an HTML string in Netscape Bookmark format
@@ -171,11 +171,11 @@ export class BookmarksTree extends Map {
      * ```typescript
      * const tree = new BookmarksTree();
      * tree.set("Google", "https://google.com");
-     * const html = tree.HTMLText;
+     * const html = tree.HTMLString;
      * console.log(html); // <!DOCTYPE NETSCAPE-Bookmark-file-1>...
      * ```
      */
-    get HTMLText() {
+    get HTMLString() {
         const escapeHtml = (text) => {
             return text
                 .replace(/&/g, "&amp;")
@@ -214,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.3",
+  "version": "1.1.4",
   "keywords": [
     "bookmark",
     "parser",