fix. import / export

Author: masataka

context.ts

@@ -44,7 +44,7 @@ export class Element extends QName {
     private _parent?: Element;
 
     uri?: string;
-    standAlone = false;
+    emptyElement = false;
 
     constructor(name: string, parent?: Element) {
         super(name);
@@ -78,7 +78,7 @@ export class Element extends QName {
     }
 }
 
-// read only Attribute
+/** information of parsed attribute, readonly. */
 export class AttributeInfo extends QName {
     private _attribute: Attribute;
 
@@ -100,7 +100,7 @@ export class AttributeInfo extends QName {
     }
 }
 
-// read only Element
+/** information of parsed element, readonly. */
 export class ElementInfo extends QName {
     private _element: Element;
 
@@ -127,12 +127,8 @@ export class ElementInfo extends QName {
         });
     }
 
-    get prefixMappings(): { ns: string, uri: string }[] {
-        return this._element.prefixMappings;
-    }
-
-    get standAlone(): boolean {
-        return this._element.standAlone;
+    get emptyElement(): boolean {
+        return this._element.emptyElement;
     }
 }
 
@@ -141,20 +137,20 @@ export interface XMLPosition {
     column: number;
 }
 
-export interface Locatable {
+export interface XMLLocator {
     position: XMLPosition;
 }
 
 export class XMLParseContext {
-    private _locator?: Locatable;
+    private _locator?: XMLLocator;
     private _memento = '';
     private _elementStack: Element[] = [];
     private _namespaces: { [ns: string]: string | undefined } = {};
 
     quote: '' | '"' | '\'' = '';
     state = 'BEFORE_DOCUMENT';
 
-    constructor(locator?: Locatable) {
+    constructor(locator?: XMLLocator) {
         this._locator = locator;
     }
 
@@ -211,6 +207,7 @@ export interface XMLParseHandler {
     (cx: XMLParseContext, c: string): XMLParseEvent[];
 }
 
+/** XML parsing error. the parser convert this error to "error" event. */
 export class XMLParseError extends Error {
     private _position: XMLPosition;
 
@@ -219,10 +216,12 @@ export class XMLParseError extends Error {
         this._position = cx.position;
     }
 
+    /** line number on XML source */
     get line(): number {
         return this._position.line;
     }
 
+    /** column number on XML source */
     get column(): number {
         return this._position.column;
     }

context_test.ts

@@ -1,7 +1,16 @@
 // Copyright 2020 Masataka Kurihara. All rights reserved. MIT license.
 
-import { assertEquals } from 'https://deno.land/std@0.74.0/testing/asserts.ts';
-import { Attribute, AttributeInfo, Element, ElementInfo, XMLParseContext } from './context.ts';
+import {
+    assertEquals,
+} from 'https://deno.land/std@0.74.0/testing/asserts.ts';
+
+import {
+    Attribute,
+    AttributeInfo,
+    Element,
+    ElementInfo,
+    XMLParseContext,
+} from './context.ts';
 
 Deno.test('Attribute xmlns', () => {
     const attribute = new Attribute('xmlns');
@@ -53,15 +62,15 @@ Deno.test('ElementInfo', () => {
     const element = new Element('a:b', parent);
     element.newAttribute('c');
     element.uri = 'https://xmlp.test/xmlns/a';
-    element.standAlone = true;
+    element.emptyElement = true;
     const elementInfo = new ElementInfo(element);
     assertEquals(elementInfo.qName, 'a:b');
     assertEquals(elementInfo.prefix, 'a');
     assertEquals(elementInfo.localPart, 'b');
     assertEquals(elementInfo.uri, 'https://xmlp.test/xmlns/a');
     assertEquals(elementInfo.parent!.qName, 'parent');
     assertEquals(elementInfo.attributes[0].qName, 'c');
-    assertEquals(elementInfo.standAlone, true);
+    assertEquals(elementInfo.emptyElement, true);
 });
 
 Deno.test('XMLParseContext memento & appendMemento & clearMemento', () => {

handler.ts

@@ -1,6 +1,11 @@
 // Copyright 2020 Masataka Kurihara. All rights reserved. MIT license.
 
-import { XMLParseContext, XMLParseEvent, XMLParseError, ElementInfo } from './context.ts';
+import {
+    XMLParseContext,
+    XMLParseEvent,
+    XMLParseError,
+    ElementInfo,
+} from './context.ts';
 
 const NAME_HEAD = /[:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]/
 const NAME_BODY = /[:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u00B7\u0300-\u036F\u203F-\u2040.\d-]/
@@ -291,7 +296,7 @@ export function handleEmptyElementTag(cx: XMLParseContext, c: string): XMLParseE
         throw new XMLParseError('Forward-slash in start-tag not followed by &gt', cx);
     }
     const element = cx.peekElement()!;
-    element.standAlone = true;
+    element.emptyElement = true;
     events = emitStartElement(cx).concat(emitEndElement(cx, element.qName));
     cx.state = 'GENERAL_STUFF';
     return events;

handler_test.ts

@@ -1,7 +1,14 @@
 // Copyright 2020 Masataka Kurihara. All rights reserved. MIT license.
 
-import { assertEquals, assertThrows } from 'https://deno.land/std@0.74.0/testing/asserts.ts';
-import { XMLParseContext } from './context.ts';
+import {
+    assertEquals,
+    assertThrows,
+} from 'https://deno.land/std@0.74.0/testing/asserts.ts';
+
+import {
+    XMLParseContext,
+} from './context.ts';
+
 import * as handler from './handler.ts';
 
 Deno.test('handleBeforeDocument', () => {

mod.ts

@@ -1,6 +1,15 @@
 // Copyright 2020 Masataka Kurihara. All rights reserved. MIT license.
 
-export * from './parser.ts';
+export {
+    SAXParser,
+    PullParser,
+} from './parser.ts';
+export type {
+    PullResult,
+} from './parser.ts';
 
-// to implement a new handler
-export * from './context.ts';
+export {
+    AttributeInfo,
+    ElementInfo,
+    XMLParseError,
+} from './context.ts';

parser.ts

@@ -1,9 +1,18 @@
 // Copyright 2020 Masataka Kurihara. All rights reserved. MIT license.
 
-import { Locatable, XMLParseHandler, XMLParseContext, XMLPosition, ElementInfo, XMLParseEvent, XMLParseError } from './context.ts';
+import {
+    XMLParseHandler,
+    XMLParseContext,
+    XMLParseEvent,
+    XMLParseError,
+    XMLLocator,
+    XMLPosition,
+    ElementInfo,
+} from './context.ts';
+
 import * as handler from './handler.ts';
 
-export abstract class ParserBase implements Locatable {
+export abstract class ParserBase implements XMLLocator {
     private _cx = new XMLParseContext(this);
     private _handlers: { [state: string]: XMLParseHandler } = {};
     private _chunk = '';
@@ -106,19 +115,13 @@ export abstract class ParserBase implements Locatable {
         return this._position;
     }
 }
-/**
- * Custom SAX event listener type, register by {@code SAXParser#on}.
- */
-export interface SAXListener {
-    // deno-lint-ignore no-explicit-any
-    (...arg: any[]): void;
-}
 
 /**
  * SAX-style XML parser.
  */
 export class SAXParser extends ParserBase implements UnderlyingSink<Uint8Array> {
-    private _listeners: { [name: string]: SAXListener[] } = {};
+    // deno-lint-ignore no-explicit-any
+    private _listeners: { [name: string]: ((...arg: any[]) => void)[] } = {};
     private _controller?: WritableStreamDefaultController;
 
     protected fireListeners(event: XMLParseEvent) {
@@ -152,6 +155,11 @@ export class SAXParser extends ParserBase implements UnderlyingSink<Uint8Array>
         }
     }
 
+    /**
+     * implements UnderlyingSink<Uint8Array>
+     * @param chunk XML data chunk
+     * @param controller error reporter, Deno writable stream uses internal.
+     */
     write(chunk: Uint8Array, controller?: WritableStreamDefaultController) {
         try {
             this._controller = controller;
@@ -210,9 +218,9 @@ export class SAXParser extends ParserBase implements UnderlyingSink<Uint8Array>
     on(event: 'end_element', listener: (element: ElementInfo) => void): this;
     on(event: 'end_prefix_mapping', listener: (ns: string, uri: string) => void): this;
     on(event: 'end_document', listener: () => void): this;
+    on(event: 'error', listener: (error: XMLParseError) => void): this;
     // deno-lint-ignore no-explicit-any
-    on(event: 'error', listener: (error: any) => void): this;
-    on(event: string, listener: SAXListener): this {
+    on(event: string, listener: (...arg: any[]) => void): this {
         const list = this._listeners[event] || [];
         list.push(listener);
         this._listeners[event] = list;

parser_test.ts

@@ -1,8 +1,24 @@
 // Copyright 2020 Masataka Kurihara. All rights reserved. MIT license.
 
-import { assert, assertEquals, assertThrows } from 'https://deno.land/std@0.74.0/testing/asserts.ts';
-import { ElementInfo, XMLParseContext, XMLParseEvent, XMLParseError } from "./context.ts";
-import { ParserBase, SAXParser, PullParser, PullResult } from './parser.ts';
+import {
+    assert,
+    assertEquals,
+    assertThrows,
+} from 'https://deno.land/std@0.74.0/testing/asserts.ts';
+
+import {
+    ElementInfo,
+    XMLParseContext,
+    XMLParseEvent,
+    XMLParseError,
+} from "./context.ts";
+
+import {
+    ParserBase,
+    SAXParser,
+    PullParser,
+    PullResult,
+} from './parser.ts';
 
 Deno.test('ParserBase chunk & hasNext & readNext & position', () => {
     // protected -> public visiblity