codebuff 1.0.326 → 1.0.327

package/dist/common/src/util/saxy.d.ts

@@ -0,0 +1,179 @@
+import { Transform } from 'node:stream';
+export type TextNode = {
+    /** The text value */
+    contents: string;
+};
+export type CDATANode = {
+    /** The CDATA contents */
+    contents: string;
+};
+export type CommentNode = {
+    /** The comment contents */
+    contents: string;
+};
+export type ProcessingInstructionNode = {
+    /** The instruction contents */
+    contents: string;
+};
+/** Information about an opened tag */
+export type TagOpenNode = {
+    /** Name of the tag that was opened. */
+    name: string;
+    /**
+     * Attributes passed to the tag, in a string representation
+     * (use Saxy.parseAttributes to get an attribute-value mapping).
+     */
+    attrs: string;
+    /**
+     * Whether the tag self-closes (tags of the form ``).
+     * Such tags will not be followed by a closing tag.
+     */
+    isSelfClosing: boolean;
+    /**
+     * The original text of the tag, including angle brackets and attributes.
+     */
+    rawTag: string;
+};
+/** Information about a closed tag */
+export type TagCloseNode = {
+    /** Name of the tag that was closed. */
+    name: string;
+    /**
+     * The original text of the tag, including angle brackets.
+     */
+    rawTag: string;
+};
+export type NextFunction = (err?: Error) => void;
+export interface SaxyEvents {
+    finish: () => void;
+    error: (err: Error) => void;
+    text: (data: TextNode) => void;
+    cdata: (data: CDATANode) => void;
+    comment: (data: CommentNode) => void;
+    processinginstruction: (data: ProcessingInstructionNode) => void;
+    tagopen: (data: TagOpenNode) => void;
+    tagclose: (data: TagCloseNode) => void;
+}
+export type SaxyEventNames = keyof SaxyEvents;
+export type SaxyEventArgs = Error | TextNode | CDATANode | CommentNode | ProcessingInstructionNode | TagOpenNode | TagCloseNode;
+export interface Saxy {
+    on<U extends SaxyEventNames>(event: U, listener: SaxyEvents[U]): this;
+    on(event: string | symbol | Event, listener: (...args: any[]) => void): this;
+    once<U extends SaxyEventNames>(event: U, listener: SaxyEvents[U]): this;
+}
+/**
+ * Schema for defining allowed tags and their children
+ */
+export type TagSchema = {
+    [topLevelTag: string]: (string | RegExp)[];
+};
+/**
+ * Parse a string of XML attributes to a map of attribute names to their values.
+ *
+ * @param input A string of XML attributes
+ * @throws If the string is malformed
+ * @return A map of attribute names to their values
+ */
+export declare const parseAttrs: (input: string) => {
+    attrs: Record<string, string>;
+    errors: string[];
+};
+/**
+ * Parse an XML stream and emit events corresponding
+ * to the different tokens encountered.
+ */
+export declare class Saxy extends Transform {
+    private _decoder;
+    private _tagStack;
+    private _waiting;
+    private _schema;
+    private _textBuffer;
+    private _shouldParseEntities;
+    /**
+     * Parse a string of XML attributes to a map of attribute names
+     * to their values
+     *
+     * @param input A string of XML attributes
+     * @throws If the string is malformed
+     * @return A map of attribute names to their values
+     */
+    static parseAttrs: (input: string) => {
+        attrs: Record<string, string>;
+        errors: string[];
+    };
+    /**
+     * Expand a piece of XML text by replacing all XML entities
+     * by their canonical value. Ignore invalid and unknown
+     * entities
+     *
+     * @param input A string of XML text
+     * @return The input string, expanded
+     */
+    static parseEntities: (input: string) => string;
+    /**
+     * Create a new parser instance.
+     * @param schema Optional schema defining allowed top-level tags and their children
+     */
+    constructor(schema?: TagSchema, shouldParseEntities?: boolean);
+    /**
+     * Handle a chunk of data written into the stream.
+     *
+     * @param chunk Chunk of data.
+     * @param encoding Encoding of the string, or 'buffer'.
+     * @param callback Called when the chunk has been parsed, with
+     * an optional error argument.
+     */
+    _write(chunk: Buffer | string, encoding: string, callback: NextFunction): void;
+    /**
+     * Handle the end of incoming data.
+     *
+     * @param callback
+     */
+    _final(callback: NextFunction): void;
+    /**
+     * Immediately parse a complete chunk of XML and close the stream.
+     *
+     * @param input Input chunk.
+     */
+    parse(input: Buffer | string): this;
+    /**
+     * Put the stream into waiting mode, which means we need more data
+     * to finish parsing the current token.
+     *
+     * @param token Type of token that is being parsed.
+     * @param data Pending data.
+     */
+    private _wait;
+    /**
+     * Put the stream out of waiting mode.
+     *
+     * @return Any data that was pending.
+     */
+    private _unwait;
+    /**
+     * Handle the opening of a tag in the text stream.
+     *
+     * Push the tag into the opened tag stack and emit the
+     * corresponding event on the event emitter.
+     *
+     * @param node Information about the opened tag.
+     */
+    private _handleTagOpening;
+    /**
+     * Parse a XML chunk.
+     *
+     * @private
+     * @param input A string with the chunk data.
+     * @param callback Called when the chunk has been parsed, with
+     * an optional error argument.
+     */
+    private _parseChunk;
+    /**
+     * Check if a potential XML tag start is actually a valid tag
+     * @param input The input string
+     * @param pos Position after the < character
+     * @returns true if this is a valid XML tag start
+     */
+    private _isXMLTagStart;
+}
+//# sourceMappingURL=saxy.d.ts.map

package/dist/common/src/util/saxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"saxy.d.ts","sourceRoot":"","sources":["../../../src/util/saxy.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAIvC,MAAM,MAAM,QAAQ,GAAG;IACrB,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG;IACtC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,WAAW,GAAG;IACxB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,qCAAqC;AACrC,MAAM,MAAM,YAAY,GAAG;IACzB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,KAAK,IAAI,CAAA;AAEhD,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,IAAI,CAAA;IAClB,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,IAAI,CAAA;IAC3B,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAA;IAC9B,KAAK,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAA;IAChC,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAA;IACpC,qBAAqB,EAAE,CAAC,IAAI,EAAE,yBAAyB,KAAK,IAAI,CAAA;IAChE,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAA;IACpC,QAAQ,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAA;CACvC;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,UAAU,CAAA;AAE7C,MAAM,MAAM,aAAa,GACrB,KAAK,GACL,QAAQ,GACR,SAAS,GACT,WAAW,GACX,yBAAyB,GACzB,WAAW,GACX,YAAY,CAAA;AAEhB,MAAM,WAAW,IAAI;IACnB,EAAE,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IACrE,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,IAAI,CAAA;IAC5E,IAAI,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;CACxE;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,WAAW,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CAC3C,CAAA;AA2FD;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,UACd,MAAM,KACZ;IAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAyEnD,CAAA;AAkCD;;;GAGG;AACH,qBAAa,IAAK,SAAQ,SAAS;IACjC,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,SAAS,CAAU;IAC3B,OAAO,CAAC,QAAQ,CAAyC;IACzD,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,oBAAoB,CAAS;IAErC;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,UAhIV,MAAM,KACZ;QAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,MAAM,EAAE,MAAM,EAAE,CAAA;KAAE,CA+HtB;IAE9B;;;;;;;OAOG;IACH,MAAM,CAAC,aAAa,UAvNQ,MAAM,KAAG,MAAM,CAuNP;IAEpC;;;OAGG;gBACS,MAAM,CAAC,EAAE,SAAS,EAAE,mBAAmB,GAAE,OAAc;IAoBnE;;;;;;;OAOG;IACI,MAAM,CACX,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,YAAY;IAUxB;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,YAAY;IAqDpC;;;;OAIG;IACI,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAK1C;;;;;;OAMG;IACH,OAAO,CAAC,KAAK;IAIb;;;;OAIG;IACH,OAAO,CAAC,OAAO;IAUf;;;;;;;OAOG;IACH,OAAO,CAAC,iBAAiB;IAyCzB;;;;;;;OAOG;IACH,OAAO,CAAC,WAAW;IAsMnB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;CAMvB"}