@bpmnkit/core 0.1.1 → 0.2.0

package/dist/xml/xml-parser.d.ts

@@ -1,4 +1,36 @@
 import type { XmlElement } from "../types/xml-element.js";
+/** What a sink wants the scanner to do with an element after its start tag. */
+export declare const Visit: {
+    /** Report child elements and character data. */
+    readonly All: 0;
+    /**
+     * Skip the element's content: the scanner fast-forwards past the matching
+     * end tag without building attributes or decoding text for anything inside,
+     * and `end` is not called for it.
+     */
+    readonly Skip: 1;
+    /** Report child elements but drop character data without decoding it. */
+    readonly ElementsOnly: 2;
+};
+export type Visit = (typeof Visit)[keyof typeof Visit];
+/** Receives the events of one XML document from {@link scanXml}. */
+export interface XmlSink {
+    /**
+     * @param name qualified name, e.g. "bpmn:task"
+     * @param local name without its prefix, e.g. "task" (same string as `name` when unprefixed)
+     * @param selfClosing true for `<a/>`; `end` follows immediately
+     */
+    start(name: string, local: string, attributes: Record<string, string>, selfClosing: boolean): Visit;
+    /** Character data or CDATA directly inside the current element, entities decoded. */
+    text(text: string): void;
+    end(name: string): void;
+}
+/**
+ * Scan an XML document, reporting the root element and everything inside it to
+ * `sink`. Returns false when the document has no root element. Content after
+ * the root element is ignored.
+ */
+export declare function scanXml(xml: string, sink: XmlSink): boolean;
 /**
  * Parse an XML string into an XmlElement tree.
  * Returns the root element with all namespace prefixes preserved.