parse5-parser-stream 6.0.1 → 7.0.0

package/README.md

@@ -15,9 +15,8 @@
 </div>
 <br>
 
-
 <p align="center">
-  📖 <a href="https://github.com/inikulin/parse5/tree/master/packages/parse5-parser-stream/docs/index.md"><b>Documentation</b></a> 📖
+  📖 <a href="https://parse5.js.org/modules/parse5_parser_stream.html"><b>Documentation</b></a> 📖
 </p>
 
 ---
@@ -31,5 +30,5 @@
 </p>
 
 <p align="center">
-    <a href="https://github.com/inikulin/parse5/tree/master/docs/version-history.md">Version history</a>
+    <a href="https://github.com/inikulin/parse5/releases">Changelog</a>
 </p>

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+/// <reference types="node" />
+import { Writable } from 'node:stream';
+import { Parser, type ParserOptions, type TreeAdapterTypeMap, type DefaultTreeAdapterMap } from 'parse5';
+/**
+ * Streaming HTML parser with scripting support.
+ * A [writable stream](https://nodejs.org/api/stream.html#stream_class_stream_writable).
+ *
+ * @example
+ *
+ * ```js
+ * const ParserStream = require('parse5-parser-stream');
+ * const http = require('http');
+ * const { finished } = require('node:stream');
+ *
+ * // Fetch the page content and obtain it's <head> node
+ * http.get('http://inikulin.github.io/parse5/', res => {
+ *     const parser = new ParserStream();
+ *
+ *     finished(parser, () => {
+ *         console.log(parser.document.childNodes[1].childNodes[0].tagName); //> 'head'
+ *     });
+ *
+ *     res.pipe(parser);
+ * });
+ * ```
+ *
+ */
+export declare class ParserStream<T extends TreeAdapterTypeMap = DefaultTreeAdapterMap> extends Writable {
+    parser: Parser<T>;
+    static getFragmentStream<T extends TreeAdapterTypeMap>(fragmentContext?: T['parentNode'] | null, options?: ParserOptions<T>): ParserStream<T>;
+    private lastChunkWritten;
+    private writeCallback;
+    private pendingHtmlInsertions;
+    /** The resulting document node. */
+    get document(): T['document'];
+    getFragment(): T['documentFragment'];
+    /**
+     * @param options Parsing options.
+     */
+    constructor(options?: ParserOptions<T>, parser?: Parser<T>);
+    _write(chunk: string, _encoding: string, callback: () => void): void;
+    end(chunk?: any, encoding?: any, callback?: any): any;
+}
+export interface ParserStream<T extends TreeAdapterTypeMap = DefaultTreeAdapterMap> {
+    /**
+     * Raised when parser encounters a `<script>` element. If this event has listeners, parsing will be suspended once
+     * it is emitted. So, if `<script>` has the `src` attribute, you can fetch it, execute and then resume parsing just
+     * like browsers do.
+     *
+     * @example
+     *
+     * ```js
+     * const ParserStream = require('parse5-parser-stream');
+     * const http = require('http');
+     *
+     * const parser = new ParserStream();
+     *
+     * parser.on('script', (scriptElement, documentWrite, resume) => {
+     *     const src = scriptElement.attrs.find(({ name }) => name === 'src').value;
+     *
+     *     http.get(src, res => {
+     *         // Fetch the script content, execute it with DOM built around `parser.document` and
+     *         // `document.write` implemented using `documentWrite`.
+     *         ...
+     *         // Then resume parsing.
+     *         resume();
+     *     });
+     * });
+     *
+     * parser.end('<script src="example.com/script.js"></script>');
+     * ```
+     *
+     * @param event Name of the event
+     * @param handler
+     */
+    on(event: 'script', handler: (scriptElement: T['element'], documentWrite: (html: string) => void, resume: () => void) => void): void;
+    /**
+     * Base event handler.
+     *
+     * @param event Name of the event
+     * @param handler Event handler
+     */
+    on(event: string, handler: (...args: any[]) => void): this;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,86 @@
+import { Writable } from 'node:stream';
+import { Parser } from 'parse5';
+/* eslint-disable unicorn/consistent-function-scoping -- The rule seems to be broken here. */
+/**
+ * Streaming HTML parser with scripting support.
+ * A [writable stream](https://nodejs.org/api/stream.html#stream_class_stream_writable).
+ *
+ * @example
+ *
+ * ```js
+ * const ParserStream = require('parse5-parser-stream');
+ * const http = require('http');
+ * const { finished } = require('node:stream');
+ *
+ * // Fetch the page content and obtain it's <head> node
+ * http.get('http://inikulin.github.io/parse5/', res => {
+ *     const parser = new ParserStream();
+ *
+ *     finished(parser, () => {
+ *         console.log(parser.document.childNodes[1].childNodes[0].tagName); //> 'head'
+ *     });
+ *
+ *     res.pipe(parser);
+ * });
+ * ```
+ *
+ */
+export class ParserStream extends Writable {
+    /**
+     * @param options Parsing options.
+     */
+    constructor(options, parser = new Parser(options)) {
+        super({ decodeStrings: false });
+        this.parser = parser;
+        this.lastChunkWritten = false;
+        this.writeCallback = undefined;
+        this.pendingHtmlInsertions = [];
+        const resume = () => {
+            for (let i = this.pendingHtmlInsertions.length - 1; i >= 0; i--) {
+                this.parser.tokenizer.insertHtmlAtCurrentPos(this.pendingHtmlInsertions[i]);
+            }
+            this.pendingHtmlInsertions.length = 0;
+            //NOTE: keep parsing if we don't wait for the next input chunk
+            this.parser.tokenizer.resume(this.writeCallback);
+        };
+        const documentWrite = (html) => {
+            if (!this.parser.stopped) {
+                this.pendingHtmlInsertions.push(html);
+            }
+        };
+        const scriptHandler = (scriptElement) => {
+            if (this.listenerCount('script') > 0) {
+                this.parser.tokenizer.pause();
+                this.emit('script', scriptElement, documentWrite, resume);
+            }
+        };
+        this.parser.scriptHandler = scriptHandler;
+    }
+    static getFragmentStream(fragmentContext, options) {
+        const parser = Parser.getFragmentParser(fragmentContext, options);
+        const stream = new ParserStream(options, parser);
+        return stream;
+    }
+    /** The resulting document node. */
+    get document() {
+        return this.parser.document;
+    }
+    getFragment() {
+        return this.parser.getFragment();
+    }
+    //WritableStream implementation
+    _write(chunk, _encoding, callback) {
+        if (typeof chunk !== 'string') {
+            throw new TypeError('Parser can work only with string streams.');
+        }
+        this.writeCallback = callback;
+        this.parser.tokenizer.write(chunk, this.lastChunkWritten, this.writeCallback);
+    }
+    // TODO [engine:node@>=16]: Due to issues with Node < 16, we are overriding `end` instead of `_final`.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    end(chunk, encoding, callback) {
+        this.lastChunkWritten = true;
+        super.end(chunk || '', encoding, callback);
+    }
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,10 +1,12 @@
 {
     "name": "parse5-parser-stream",
+    "type": "module",
     "description": "Streaming HTML parser with scripting support.",
-    "version": "6.0.1",
+    "version": "7.0.0",
     "author": "Ivan Nikulin <ifaaan@gmail.com> (https://github.com/inikulin)",
     "contributors": "https://github.com/inikulin/parse5/graphs/contributors",
     "homepage": "https://github.com/inikulin/parse5",
+    "funding": "https://github.com/inikulin/parse5?sponsor=1",
     "keywords": [
         "parse5",
         "parser",
@@ -12,16 +14,19 @@
         "streaming"
     ],
     "license": "MIT",
-    "main": "./lib/index.js",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": "./dist/index.js",
     "dependencies": {
-        "parse5": "^6.0.1"
+        "parse5": "^7.0.0"
     },
     "repository": {
         "type": "git",
         "url": "git://github.com/inikulin/parse5.git"
     },
     "files": [
-        "lib"
-    ],
-    "gitHead": "37227a3429584903cbd1799dade995266fc2dbe6"
+        "dist",
+        "!*.map"
+    ]
 }

package/lib/index.js

@@ -1,83 +0,0 @@
-'use strict';
-
-const { Writable } = require('stream');
-const Parser = require('parse5/lib/parser');
-
-class ParserStream extends Writable {
-    constructor(options) {
-        super({ decodeStrings: false });
-
-        this.parser = new Parser(options);
-
-        this.lastChunkWritten = false;
-        this.writeCallback = null;
-        this.pausedByScript = false;
-
-        this.document = this.parser.treeAdapter.createDocument();
-
-        this.pendingHtmlInsertions = [];
-
-        this._resume = this._resume.bind(this);
-        this._documentWrite = this._documentWrite.bind(this);
-        this._scriptHandler = this._scriptHandler.bind(this);
-
-        this.parser._bootstrap(this.document, null);
-    }
-
-    //WritableStream implementation
-    _write(chunk, encoding, callback) {
-        if (typeof chunk !== 'string') {
-            throw new TypeError('Parser can work only with string streams.');
-        }
-
-        this.writeCallback = callback;
-        this.parser.tokenizer.write(chunk, this.lastChunkWritten);
-        this._runParsingLoop();
-    }
-
-    end(chunk, encoding, callback) {
-        this.lastChunkWritten = true;
-        super.end(chunk || '', encoding, callback);
-    }
-
-    //Scriptable parser implementation
-    _runParsingLoop() {
-        this.parser.runParsingLoopForCurrentChunk(this.writeCallback, this._scriptHandler);
-    }
-
-    _resume() {
-        if (!this.pausedByScript) {
-            throw new Error('Parser was already resumed');
-        }
-
-        while (this.pendingHtmlInsertions.length) {
-            const html = this.pendingHtmlInsertions.pop();
-
-            this.parser.tokenizer.insertHtmlAtCurrentPos(html);
-        }
-
-        this.pausedByScript = false;
-
-        //NOTE: keep parsing if we don't wait for the next input chunk
-        if (this.parser.tokenizer.active) {
-            this._runParsingLoop();
-        }
-    }
-
-    _documentWrite(html) {
-        if (!this.parser.stopped) {
-            this.pendingHtmlInsertions.push(html);
-        }
-    }
-
-    _scriptHandler(scriptElement) {
-        if (this.listenerCount('script') > 0) {
-            this.pausedByScript = true;
-            this.emit('script', scriptElement, this._documentWrite, this._resume);
-        } else {
-            this._runParsingLoop();
-        }
-    }
-}
-
-module.exports = ParserStream;