@honkit/html 5.1.5 → 6.0.1

package/lib/dom.d.ts

@@ -1,31 +1,36 @@
-/// <reference types="cheerio" />
+import * as cheerio from "cheerio";
 /**
-    Parse an HTML string and return its content
+ * Load an HTML string and return a cheerio instance
+ * @param html
+ */
+export declare function loadHtml(html: string): cheerio.CheerioAPI;
+/**
+ Parse an HTML string and return its content
 
-    @param html
-    @return {cheerio.Root}
-*/
-export declare function parse(html: string): cheerio.Root | cheerio.Cheerio;
+ @param html
+ @return {cheerio.Root}
+ */
+export declare function parse(html: string): cheerio.CheerioAPI;
 /**
-    Return main element for a DOM
+ Return main element for a DOM
 
-    @param {cheerio.DOM}
-    @return {cheerio.Node}
-*/
+ @param {cheerio.DOM}
+ @return {cheerio.Node}
+ */
 export declare function root($: any): any;
 /**
-    Return text node of an element
+ Return text node of an element
 
-    @param {cheerio.Node}
-    @return {string}
-*/
+ @param {cheerio.Node}
+ @return {string}
+ */
 export declare function textNode($el: any): any;
 /**
-    Cleanup a DOM by removing all useless divs
+ Cleanup a DOM by removing all useless divs
 
-    @param {cheerio.Node}
-    @param {cheerio.DOM}
-    @return {cheerio.Node}
-*/
+ @param {cheerio.Node}
+ @param {cheerio.DOM}
+ @return {cheerio.Node}
+ */
 export declare function cleanup($el: any, $: any): any;
 //# sourceMappingURL=dom.d.ts.map

package/lib/dom.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../src/dom.ts"],"names":[],"mappings":";AAGA;;;;;EAKE;AACF,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,kCAKjC;AAED;;;;;EAKE;AACF,wBAAgB,IAAI,CAAC,CAAC,KAAA,OAGrB;AAED;;;;;EAKE;AACF,wBAAgB,QAAQ,CAAC,GAAG,KAAA,OAS3B;AAED;;;;;;EAME;AACF,wBAAgB,OAAO,CAAC,GAAG,KAAA,EAAE,CAAC,KAAA,OAS7B"}
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../src/dom.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AAOnC;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAEzD;AACD;;;;;GAKG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAKtD;AAED;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,CAAC,KAAA,OAGrB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,GAAG,KAAA,OAS3B;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,KAAA,EAAE,CAAC,KAAA,OAS7B"}

package/lib/dom.js

@@ -26,38 +26,47 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanup = exports.textNode = exports.root = exports.parse = void 0;
+exports.loadHtml = loadHtml;
+exports.parse = parse;
+exports.root = root;
+exports.textNode = textNode;
+exports.cleanup = cleanup;
 const lodash_1 = __importDefault(require("lodash"));
 const cheerio = __importStar(require("cheerio"));
 /**
-    Parse an HTML string and return its content
+ * Load an HTML string and return a cheerio instance
+ * @param html
+ */
+function loadHtml(html) {
+    return cheerio.load(html, { _useHtmlParser2: true });
+}
+/**
+ Parse an HTML string and return its content
 
-    @param html
-    @return {cheerio.Root}
-*/
+ @param html
+ @return {cheerio.Root}
+ */
 function parse(html) {
     const $ = cheerio.load(html, { _useHtmlParser2: true });
     const $el = $("html, body").first();
-    return $el.length > 0 ? $el : $;
+    return ($el.length > 0 ? $el : $);
 }
-exports.parse = parse;
 /**
-    Return main element for a DOM
+ Return main element for a DOM
 
-    @param {cheerio.DOM}
-    @return {cheerio.Node}
-*/
+ @param {cheerio.DOM}
+ @return {cheerio.Node}
+ */
 function root($) {
     const $el = $("html, body, > div").first();
     return $el.length > 0 ? $el : $.root();
 }
-exports.root = root;
 /**
-    Return text node of an element
+ Return text node of an element
 
-    @param {cheerio.Node}
-    @return {string}
-*/
+ @param {cheerio.Node}
+ @return {string}
+ */
 function textNode($el) {
     return lodash_1.default.reduce($el.children, (text, e) => {
         if (e.type == "text")
@@ -65,14 +74,13 @@ function textNode($el) {
         return text;
     }, "");
 }
-exports.textNode = textNode;
 /**
-    Cleanup a DOM by removing all useless divs
+ Cleanup a DOM by removing all useless divs
 
-    @param {cheerio.Node}
-    @param {cheerio.DOM}
-    @return {cheerio.Node}
-*/
+ @param {cheerio.Node}
+ @param {cheerio.DOM}
+ @return {cheerio.Node}
+ */
 function cleanup($el, $) {
     $el.find("div").each(function () {
         const $div = $(this);
@@ -81,4 +89,3 @@ function cleanup($el, $) {
     });
     return $el;
 }
-exports.cleanup = cleanup;

package/lib/index.d.ts

@@ -1,4 +1,8 @@
 import { SummaryPart } from "./summary";
+/**
+ * Utility for loading HTML content
+ */
+export { loadHtml } from "./dom";
 export type ToHTMLOptions = {
     baseDirectory: string;
 };

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAgB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAcjD,MAAM,MAAM,aAAa,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;AAElF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,CAAC;AAC5B,MAAM,MAAM,aAAa,GAAG,CAAC,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,KAAK,EAAE,WAAW,EAAE,CAAC;CACxB,CAAC,GAAG;IACD,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,EAAE,CAAC,GAAG;IACpF,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,EAAE,CAAC,GAAG;IACjF,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,CAAC,CACtB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC,GAAG;IAGD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;CAClE,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG;IAClB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAYF,iBAAS,YAAY,CAAC,MAAM,KAAA,EAAE,MAAM,MAAY,GAAG,OAAO,CAwBzD;AAED,QAAA,MAAM,aAAa,SAA2B,CAAC;AAC/C,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAgB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAcjD;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,MAAM,MAAM,aAAa,GAAG;IACxB,aAAa,EAAE,MAAM,CAAC;CACzB,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;AAElF,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,EAAE,GAAG,KAAK,MAAM,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,CAAC;AAC5B,MAAM,MAAM,aAAa,GAAG,CAAC,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,KAAK,EAAE,WAAW,EAAE,CAAC;CACxB,CAAC,GAAG;IACD,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,EAAE,CAAC,GAAG;IACpF,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,EAAE,CAAC,GAAG;IACjF,MAAM,EAAE,cAAc,CAAC;CAC1B,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACvB,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,CAAC,CACtB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC,GAAG;IAGD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,MAAM,CAAC;CAClE,CAAC;AACF,MAAM,MAAM,YAAY,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,aAAa,KACtB;IACD,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,OAAO,GAAG;IAClB,OAAO,EAAE,aAAa,CAAC;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,MAAM,EAAE,YAAY,CAAC;CACxB,CAAC;AAYF,iBAAS,YAAY,CAAC,MAAM,KAAA,EAAE,MAAM,MAAY,GAAG,OAAO,CAwBzD;AAED,QAAA,MAAM,aAAa,SAA2B,CAAC;AAC/C,OAAO,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/lib/index.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createParser = exports.default = void 0;
+exports.default = exports.loadHtml = void 0;
+exports.createParser = createParser;
 const lodash_1 = __importDefault(require("lodash"));
 const totext_1 = __importDefault(require("./totext"));
 // import
@@ -19,6 +20,11 @@ const htmlParser = {
     readme: readme_1.default,
     page: page_1.default
 };
+/**
+ * Utility for loading HTML content
+ */
+var dom_1 = require("./dom");
+Object.defineProperty(exports, "loadHtml", { enumerable: true, get: function () { return dom_1.loadHtml; } });
 // Compose a function with a transform function for the first argument only
 function compose(toHTML, fn) {
     return function (content, options) {
@@ -50,6 +56,5 @@ function createParser(toHTML, toText = undefined) {
     parser.glossary.toText = _toText.glossary;
     return parser;
 }
-exports.createParser = createParser;
 const defaultParser = createParser(lodash_1.default.identity);
 exports.default = defaultParser;

package/lib/readme.d.ts

@@ -5,8 +5,8 @@
     @return {Object}
 */
 declare function parseReadme(html: any): {
-    title: any;
-    description: any;
+    title: string;
+    description: string;
 };
 export default parseReadme;
 //# sourceMappingURL=readme.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honkit/html",
-  "version": "5.1.5",
+  "version": "6.0.1",
   "description": "Parse HTML content for gitbook",
   "homepage": "https://github.com/honkit/honkit",
   "bugs": {
@@ -38,18 +38,18 @@
     "prepublish": "npm run --if-present build"
   },
   "dependencies": {
-    "cheerio": "^1.0.0-rc.12",
-    "lodash": "^4.13.1",
-    "q": "^1.1.2"
+    "cheerio": "^1.0.0",
+    "lodash": "^4.17.21",
+    "q": "^1.5.1"
   },
   "devDependencies": {
-    "mocha": "^10.2.0",
+    "mocha": "^10.7.3",
     "rimraf": "^3.0.2",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.8.3"
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d75ed67c85e3fc6976e837b56402f84e860886c7"
+  "gitHead": "8a67601b23ce480bce2bd1a8fb787f1f6f56656f"
 }