@loaders.gl/xml 4.2.0-alpha.4 → 4.2.0-alpha.5

package/dist/lib/parsers/parse-xml.js

@@ -1,42 +1,56 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { StreamingXMLParser } from "./streaming-xml-parser.js";
 import { uncapitalizeKeys } from "../xml-utils/uncapitalize.js";
 import { XMLParser as FastXMLParser } from 'fast-xml-parser';
 export function parseXMLSync(text, options) {
-  if (options !== null && options !== void 0 && options._parser && options._parser !== 'fast-xml-parser') {
-    throw new Error(options === null || options === void 0 ? void 0 : options._parser);
-  }
-  const fastXMLOptions = {
-    allowBooleanAttributes: true,
-    ignoreDeclaration: true,
-    removeNSPrefix: options === null || options === void 0 ? void 0 : options.removeNSPrefix,
-    textNodeName: options === null || options === void 0 ? void 0 : options.textNodeName,
-    isArray: (name, jpath, isLeafNode, isAttribute) => {
-      var _options$arrayPaths;
-      const array = Boolean(options === null || options === void 0 ? void 0 : (_options$arrayPaths = options.arrayPaths) === null || _options$arrayPaths === void 0 ? void 0 : _options$arrayPaths.some(path => jpath === path));
-      return array;
-    },
-    ...(options === null || options === void 0 ? void 0 : options._fastXML)
-  };
-  const xml = fastParseXML(text, fastXMLOptions);
-  return options !== null && options !== void 0 && options.uncapitalizeKeys ? uncapitalizeKeys(xml) : xml;
+    if (options?._parser && options._parser !== 'fast-xml-parser') {
+        throw new Error(options?._parser);
+    }
+    const fastXMLOptions = {
+        // Default FastXML options
+        // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#allowbooleanattributes
+        allowBooleanAttributes: true,
+        // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#ignoredeclaration
+        ignoreDeclaration: true,
+        // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#removensprefix
+        removeNSPrefix: options?.removeNSPrefix,
+        // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#textnodename
+        textNodeName: options?.textNodeName,
+        // Let's application specify keys that are always arrays
+        isArray: (name, jpath, isLeafNode, isAttribute) => {
+            const array = Boolean(options?.arrayPaths?.some((path) => jpath === path));
+            return array;
+        },
+        // Application overrides
+        ...options?._fastXML
+    };
+    const xml = fastParseXML(text, fastXMLOptions);
+    // Note - could be done with FastXML tag processing
+    return options?.uncapitalizeKeys ? uncapitalizeKeys(xml) : xml;
 }
 export function fastParseXML(text, options) {
-  const parser = new FastXMLParser({
-    ignoreAttributes: false,
-    attributeNamePrefix: '',
-    ...options
-  });
-  const parsedXML = parser.parse(text);
-  return parsedXML;
+    const parser = new FastXMLParser({
+        ignoreAttributes: false,
+        attributeNamePrefix: '',
+        ...options
+    });
+    const parsedXML = parser.parse(text);
+    return parsedXML;
 }
-export function parseXMLInBatches(text) {
-  let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  const parser = new StreamingXMLParser({
-    ...options,
-    strict: true
-  });
-  parser.write(text);
-  parser.close();
-  return parser.result;
+/**
+ * @todo Build a streaming XML parser based on sax-js
+ * @param text
+ * @param options
+ * @returns
+ */
+export function parseXMLInBatches(text, options = {}) {
+    const parser = new StreamingXMLParser({
+        ...options,
+        strict: true
+    });
+    parser.write(text);
+    parser.close();
+    return parser.result;
 }
-//# sourceMappingURL=parse-xml.js.map

package/dist/lib/parsers/streaming-xml-parser.d.ts

@@ -1,4 +1,4 @@
-import { SAXParser, SAXParserOptions } from '../../sax-ts/sax';
+import { SAXParser, SAXParserOptions } from "../../sax-ts/sax.js";
 export type StreamingXMLParserOptions = SAXParserOptions;
 /**
  * StreamingXMLParser builds a JSON object using the events emitted by the SAX parser

package/dist/lib/parsers/streaming-xml-parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streaming-xml-parser.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/streaming-xml-parser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,SAAS,EAAE,gBAAgB,EAAC,MAAM,kBAAkB,CAAC;AAG7D,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,CAAC;AAEzD;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,MAAM,YAAa;IACnB,cAAc,UAAM;IACpB,YAAY;;;OAA6C;gBAG7C,OAAO,EAAE,gBAAgB;IA+CrC,KAAK,IAAI,IAAI;IAMb,KAAK,CAAC,KAAK,KAAA,GAAG,IAAI;IAIlB,KAAK,IAAI,IAAI;IAMb,UAAU,CAAC,KAAK,KAAA,GAAG,IAAI;IAYvB,UAAU,CAAC,YAAY,UAAK,GAAG,IAAI;IAOnC,WAAW,IAAI,IAAI;IAKnB,WAAW,CAAC,YAAY,KAAK,GAAG,IAAI;IAOpC,YAAY,IAAI,IAAI;CAIrB"}
+{"version":3,"file":"streaming-xml-parser.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/streaming-xml-parser.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,SAAS,EAAE,gBAAgB,EAAC,4BAAyB;AAG7D,MAAM,MAAM,yBAAyB,GAAG,gBAAgB,CAAC;AAEzD;;GAEG;AACH,qBAAa,kBAAkB;IAC7B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,MAAM,YAAa;IACnB,cAAc,UAAM;IACpB,YAAY;;;OAA6C;gBAG7C,OAAO,EAAE,gBAAgB;IA+CrC,KAAK,IAAI,IAAI;IAMb,KAAK,CAAC,KAAK,KAAA,GAAG,IAAI;IAIlB,KAAK,IAAI,IAAI;IAMb,UAAU,CAAC,KAAK,KAAA,GAAG,IAAI;IAYvB,UAAU,CAAC,YAAY,UAAK,GAAG,IAAI;IAOnC,WAAW,IAAI,IAAI;IAKnB,WAAW,CAAC,YAAY,KAAK,GAAG,IAAI;IAOpC,YAAY,IAAI,IAAI;CAIrB"}

package/dist/lib/parsers/streaming-xml-parser.js

@@ -1,105 +1,97 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// @ts-nocheck
+/* eslint-disable */
 import { SAXParser } from "../../sax-ts/sax.js";
+/**
+ * StreamingXMLParser builds a JSON object using the events emitted by the SAX parser
+ */
 export class StreamingXMLParser {
-  constructor(options) {
-    this.parser = void 0;
-    this.result = undefined;
-    this.previousStates = [];
-    this.currentState = Object.freeze({
-      container: [],
-      key: null
-    });
-    this.reset();
-    this.parser = new SAXParser({
-      onready: () => {
-        this.previousStates.length = 0;
-        this.currentState.container.length = 0;
-      },
-      onopentag: _ref => {
-        let {
-          name,
-          attributes,
-          isSelfClosing
-        } = _ref;
-        this._openObject({});
-        if (typeof name !== 'undefined') {
-          this.parser.emit('onkey', name);
+    // jsonpath: JSONPath = new JSONPath();
+    constructor(options) {
+        this.result = undefined;
+        this.previousStates = [];
+        this.currentState = Object.freeze({ container: [], key: null });
+        this.reset();
+        this.parser = new SAXParser({
+            onready: () => {
+                this.previousStates.length = 0;
+                this.currentState.container.length = 0;
+            },
+            onopentag: ({ name, attributes, isSelfClosing }) => {
+                this._openObject({});
+                if (typeof name !== 'undefined') {
+                    this.parser.emit('onkey', name);
+                }
+            },
+            onkey: (name) => {
+                this.currentState.key = name;
+            },
+            onclosetag: () => {
+                this._closeObject();
+            },
+            onopenarray: () => {
+                this._openArray();
+            },
+            onclosearray: () => {
+                this._closeArray();
+            },
+            ontext: (value) => {
+                this._pushOrSet(value);
+            },
+            onerror: (error) => {
+                throw error;
+            },
+            onend: () => {
+                this.result = this.currentState.container.pop();
+            },
+            ...options
+        });
+    }
+    reset() {
+        this.result = undefined;
+        this.previousStates = [];
+        this.currentState = Object.freeze({ container: [], key: null });
+    }
+    write(chunk) {
+        this.parser.write(chunk);
+    }
+    close() {
+        this.parser.close();
+    }
+    // PRIVATE METHODS
+    _pushOrSet(value) {
+        const { container, key } = this.currentState;
+        if (key !== null) {
+            container[key] = value;
+            this.currentState.key = null;
         }
-      },
-      onkey: name => {
-        this.currentState.key = name;
-      },
-      onclosetag: () => {
-        this._closeObject();
-      },
-      onopenarray: () => {
-        this._openArray();
-      },
-      onclosearray: () => {
-        this._closeArray();
-      },
-      ontext: value => {
-        this._pushOrSet(value);
-      },
-      onerror: error => {
-        throw error;
-      },
-      onend: () => {
-        this.result = this.currentState.container.pop();
-      },
-      ...options
-    });
-  }
-  reset() {
-    this.result = undefined;
-    this.previousStates = [];
-    this.currentState = Object.freeze({
-      container: [],
-      key: null
-    });
-  }
-  write(chunk) {
-    this.parser.write(chunk);
-  }
-  close() {
-    this.parser.close();
-  }
-  _pushOrSet(value) {
-    const {
-      container,
-      key
-    } = this.currentState;
-    if (key !== null) {
-      container[key] = value;
-      this.currentState.key = null;
-    } else if (Array.isArray(container)) {
-      container.push(value);
-    } else if (container) {}
-  }
-  _openArray() {
-    let newContainer = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-    this._pushOrSet(newContainer);
-    this.previousStates.push(this.currentState);
-    this.currentState = {
-      container: newContainer,
-      isArray: true,
-      key: null
-    };
-  }
-  _closeArray() {
-    this.currentState = this.previousStates.pop();
-  }
-  _openObject() {
-    let newContainer = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    this._pushOrSet(newContainer);
-    this.previousStates.push(this.currentState);
-    this.currentState = {
-      container: newContainer,
-      isArray: false,
-      key: null
-    };
-  }
-  _closeObject() {
-    this.currentState = this.previousStates.pop();
-  }
+        else if (Array.isArray(container)) {
+            container.push(value);
+        }
+        else if (container) {
+            // break for debug
+        }
+    }
+    _openArray(newContainer = []) {
+        // this.jsonpath.push(null);
+        this._pushOrSet(newContainer);
+        this.previousStates.push(this.currentState);
+        this.currentState = { container: newContainer, isArray: true, key: null };
+    }
+    _closeArray() {
+        // this.jsonpath.pop();
+        this.currentState = this.previousStates.pop();
+    }
+    _openObject(newContainer = {}) {
+        // this.jsonpath.push(null);
+        this._pushOrSet(newContainer);
+        this.previousStates.push(this.currentState);
+        this.currentState = { container: newContainer, isArray: false, key: null };
+    }
+    _closeObject() {
+        // this.jsonpath.pop();
+        this.currentState = this.previousStates.pop();
+    }
 }
-//# sourceMappingURL=streaming-xml-parser.js.map

package/dist/lib/xml-utils/uncapitalize.js

@@ -1,17 +1,29 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+/**
+ * Uncapitalize first letter of a string
+ * @param str
+ * @returns
+ */
 export function uncapitalize(str) {
-  return typeof str === 'string' ? str.charAt(0).toLowerCase() + str.slice(1) : str;
+    return typeof str === 'string' ? str.charAt(0).toLowerCase() + str.slice(1) : str;
 }
+/**
+ * Recursively uncapitalize all keys in a nested object
+ * @param object
+ * @returns
+ */
 export function uncapitalizeKeys(object) {
-  if (Array.isArray(object)) {
-    return object.map(element => uncapitalizeKeys(element));
-  }
-  if (object && typeof object === 'object') {
-    const newObject = {};
-    for (const [key, value] of Object.entries(object)) {
-      newObject[uncapitalize(key)] = uncapitalizeKeys(value);
+    if (Array.isArray(object)) {
+        return object.map((element) => uncapitalizeKeys(element));
     }
-    return newObject;
-  }
-  return object;
+    if (object && typeof object === 'object') {
+        const newObject = {};
+        for (const [key, value] of Object.entries(object)) {
+            newObject[uncapitalize(key)] = uncapitalizeKeys(value);
+        }
+        return newObject;
+    }
+    return object;
 }
-//# sourceMappingURL=uncapitalize.js.map

package/dist/lib/xml-utils/xml-utils.js

@@ -1,14 +1,28 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+// TODO - these utilities could be moved to the XML parser.
+// uncapitalizeKeys could be an XMLLoader option
+/**
+ * Extracts a value or array and always return an array
+ * Useful since XML parses to object instead of array when only a single value is provided
+ */
 export function convertXMLValueToArray(xmlValue) {
-  if (Array.isArray(xmlValue)) {
-    return xmlValue;
-  }
-  if (xmlValue && typeof xmlValue === 'object' && xmlValue['0']) {}
-  if (xmlValue) {
-    return [xmlValue];
-  }
-  return [];
+    if (Array.isArray(xmlValue)) {
+        return xmlValue;
+    }
+    if (xmlValue && typeof xmlValue === 'object' && xmlValue['0']) {
+        // Error this is an objectified array
+    }
+    if (xmlValue) {
+        return [xmlValue];
+    }
+    return [];
 }
+/**
+ * Mutates a field in place, converting it to array
+ * Useful since XML parses to object instead of array when only a single value is provided
+ */
 export function convertXMLFieldToArrayInPlace(xml, key) {
-  xml[key] = convertXMLValueToArray(xml[key]);
+    xml[key] = convertXMLValueToArray(xml[key]);
 }
-//# sourceMappingURL=xml-utils.js.map