xml-sax-ts 0.4.0 → 0.5.0

package/dist/index.d.ts

@@ -37,15 +37,8 @@ interface ParserOptions {
     allowDoctype?: boolean;
     coalesceText?: boolean;
     trackPosition?: boolean;
-    onOpenTag?: (tag: OpenTag) => void;
-    onCloseTag?: (tag: CloseTag) => void;
-    onText?: (text: string) => void;
-    onCdata?: (text: string) => void;
-    onComment?: (text: string) => void;
-    onProcessingInstruction?: (pi: ProcessingInstruction) => void;
-    onDoctype?: (doctype: Doctype) => void;
-    onError?: (error: Error) => void;
 }
+type XmlChunkIterable = Iterable<string> | AsyncIterable<string>;
 type XmlChild = XmlNode | string;
 interface XmlNode {
     name: string;
@@ -80,24 +73,61 @@ interface XmlInputObject {
 interface ObjectToXmlOptions extends XmlBuilderOptions, SerializeOptions {
 }
 
+type XmlTokenKind = "open-tag" | "close-tag" | "text" | "cdata" | "comment" | "processing-instruction" | "doctype" | "end";
+declare abstract class XmlToken {
+    readonly kind: XmlTokenKind;
+    readonly position: XmlPosition | undefined;
+    protected constructor(kind: XmlTokenKind, position?: XmlPosition);
+}
+declare class OpenTagToken extends XmlToken {
+    readonly tag: OpenTag;
+    readonly depth: number;
+    readonly path: readonly string[];
+    constructor(tag: OpenTag, depth: number, path: readonly string[], position?: XmlPosition);
+}
+declare class CloseTagToken extends XmlToken {
+    readonly tag: CloseTag;
+    readonly depth: number;
+    readonly path: readonly string[];
+    constructor(tag: CloseTag, depth: number, path: readonly string[], position?: XmlPosition);
+}
+declare class TextToken extends XmlToken {
+    readonly text: string;
+    constructor(text: string, position?: XmlPosition);
+}
+declare class CdataToken extends XmlToken {
+    readonly text: string;
+    constructor(text: string, position?: XmlPosition);
+}
+declare class CommentToken extends XmlToken {
+    readonly text: string;
+    constructor(text: string, position?: XmlPosition);
+}
+declare class ProcessingInstructionToken extends XmlToken {
+    readonly processingInstruction: ProcessingInstruction;
+    constructor(processingInstruction: ProcessingInstruction, position?: XmlPosition);
+}
+declare class DoctypeToken extends XmlToken {
+    readonly doctype: Doctype;
+    constructor(doctype: Doctype, position?: XmlPosition);
+}
+declare class EndToken extends XmlToken {
+    constructor(position?: XmlPosition);
+}
+type XmlAnyToken = OpenTagToken | CloseTagToken | TextToken | CdataToken | CommentToken | ProcessingInstructionToken | DoctypeToken | EndToken;
+
 declare class XmlSaxParser {
     private readonly xmlns;
     private readonly includeNamespaceAttributes;
     private readonly allowDoctype;
     private readonly coalesceText;
     private readonly trackPosition;
-    private readonly onOpenTag;
-    private readonly onCloseTag;
-    private readonly onText;
-    private readonly onCdata;
-    private readonly onComment;
-    private readonly onProcessingInstruction;
-    private readonly onDoctype;
-    private readonly onError;
     private buffer;
     private offset;
     private line;
     private column;
+    private readonly pathStack;
+    private readonly tokenQueue;
     private elementStack;
     private nsStack;
     private closed;
@@ -105,8 +135,11 @@ declare class XmlSaxParser {
     private readonly pendingTextParts;
     private readonly _rawAttrs;
     constructor(options?: ParserOptions);
-    feed(chunk: string): void;
-    close(): void;
+    feed(chunk: string): XmlAnyToken[];
+    close(): XmlAnyToken[];
+    drainTokens(): XmlAnyToken[];
+    [Symbol.iterator](): IterableIterator<XmlAnyToken>;
+    iterateChunks(chunks: Iterable<string> | AsyncIterable<string>): AsyncGenerator<XmlAnyToken>;
     private _parseBuffer;
     private _parseMarkupFrom;
     private _handleStartTagRange;
@@ -127,7 +160,11 @@ declare class XmlSaxParser {
     private _advanceSpan;
     private _flushPendingCR;
     private _error;
+    private _position;
+    private _pushToken;
 }
+declare function tokenizeXml(xml: string, options?: ParserOptions): XmlAnyToken[];
+declare function tokenizeXmlAsync(chunks: Iterable<string> | AsyncIterable<string>, options?: ParserOptions): AsyncGenerator<XmlAnyToken>;
 
 declare class XmlSaxError extends Error {
     readonly offset: number;
@@ -139,15 +176,16 @@ declare class XmlSaxError extends Error {
 declare class TreeBuilder {
     private stack;
     private root;
-    onOpenTag: (tag: {
+    onOpenTag(tag: {
         name: string;
         attributes: Record<string, {
             value: string;
         } | string>;
-    }) => void;
-    onText: (text: string) => void;
-    onCdata: (text: string) => void;
-    onCloseTag: () => void;
+    }): void;
+    onText(text: string): void;
+    onCdata(text: string): void;
+    onCloseTag(): void;
+    consume(token: OpenTagToken | TextToken | CdataToken | CloseTagToken): void;
     getRoot(): XmlNode;
 }
 declare function parseXmlString(xml: string, options?: ParserOptions): XmlNode;
@@ -170,12 +208,13 @@ declare class ObjectBuilder {
     private root;
     private rootName;
     constructor(options?: ObjectBuilderOptions);
-    onOpenTag: (tag: OpenTag) => void;
-    onText: (text: string) => void;
-    onCdata: (text: string) => void;
-    onCloseTag: () => void;
+    onOpenTag(tag: OpenTag): void;
+    onText(text: string): void;
+    onCdata(text: string): void;
+    onCloseTag(): void;
+    consume(token: OpenTagToken | TextToken | CdataToken | CloseTagToken): void;
     getResult(): XmlObjectValue;
     getRootName(): string;
 }
 
-export { type ArrayElementSelector, type CloseTag, type Doctype, ObjectBuilder, type ObjectBuilderOptions, type ObjectToXmlOptions, type OpenTag, type ParserOptions, type ProcessingInstruction, type SerializeOptions, TreeBuilder, type XmlAttribute, type XmlBuilderOptions, type XmlChild, type XmlInputObject, type XmlInputValue, type XmlNode, type XmlObjectMap, type XmlObjectValue, type XmlPosition, XmlSaxError, XmlSaxParser, buildObject, buildXmlNode, objectToXml, parseXmlString, resolveName, serializeXml, stripNamespace };
+export { type ArrayElementSelector, CdataToken, type CloseTag, CloseTagToken, CommentToken, type Doctype, DoctypeToken, EndToken, ObjectBuilder, type ObjectBuilderOptions, type ObjectToXmlOptions, type OpenTag, OpenTagToken, type ParserOptions, type ProcessingInstruction, ProcessingInstructionToken, type SerializeOptions, TextToken, TreeBuilder, type XmlAnyToken, type XmlAttribute, type XmlBuilderOptions, type XmlChild, type XmlChunkIterable, type XmlInputObject, type XmlInputValue, type XmlNode, type XmlObjectMap, type XmlObjectValue, type XmlPosition, XmlSaxError, XmlSaxParser, XmlToken, type XmlTokenKind, buildObject, buildXmlNode, objectToXml, parseXmlString, resolveName, serializeXml, stripNamespace, tokenizeXml, tokenizeXmlAsync };