@loaders.gl/xml 3.4.0-alpha.3 → 4.0.0-alpha.6

package/dist/lib/parsers/parse-xml.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parse-xml.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-xml.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAEhD,uDAAuD;AACvD,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEvD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,GAAG,CAU7E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAK,GAAG,GAAG,CAUjE"}
+{"version":3,"file":"parse-xml.d.ts","sourceRoot":"","sources":["../../../src/lib/parsers/parse-xml.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,kBAAkB,CAAC;AAIvD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAC;AAEhD,MAAM,MAAM,eAAe,GAAG;IAC5B,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAGtB,OAAO,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC;IACpC,uFAAuF;IACvF,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,2FAA2F;IAC3F,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB,CAAC;AAEF,uDAAuD;AACvD,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;AAEvD,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,GAAG,CAgCzE;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,GAAG,CAU7E;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAK,GAAG,GAAG,CAUjE"}

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

@@ -1,9 +1,37 @@
 "use strict";
 // loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseXMLInBatches = exports.fastParseXML = void 0;
+exports.parseXMLInBatches = exports.fastParseXML = exports.parseXMLSync = void 0;
 const streaming_xml_parser_1 = require("./streaming-xml-parser");
+const uncapitalize_1 = require("../xml-utils/uncapitalize");
 const fast_xml_parser_1 = require("fast-xml-parser");
+function parseXMLSync(text, options) {
+    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 ? (0, uncapitalize_1.uncapitalizeKeys)(xml) : xml;
+}
+exports.parseXMLSync = parseXMLSync;
 function fastParseXML(text, options) {
     const parser = new fast_xml_parser_1.XMLParser({
         ignoreAttributes: false,

package/dist/xml-loader.d.ts

@@ -1,45 +1,10 @@
 import type { LoaderWithParser, LoaderOptions } from '@loaders.gl/loader-utils';
-import type { SAXParserOptions } from './sax-ts/sax';
-import { FastXMLParserOptions } from './lib/parsers/parse-xml';
+import type { ParseXMLOptions } from './lib/parsers/parse-xml';
 export type XMLLoaderOptions = LoaderOptions & {
-    xml?: {
-        parser?: 'fast-xml-parser' | string;
-        /** XML is typically PascalCase, JavaScript prefects camelCase */
-        uncapitalizeKeys?: boolean;
-        removeNSPrefix?: boolean;
-        textNodeName?: string;
-        arrayPaths?: string[];
-    };
-    /** @deprecated Experimental, passes options to fast-xml-parser, IF it is being used */
-    _fastXML?: FastXMLParserOptions;
-    /** @deprecated Experimental, passes options to the SAX XML parser, IF it is being used. */
-    _sax?: SAXParserOptions;
+    xml?: ParseXMLOptions;
 };
 /**
  * Loader for XML files
  */
-export declare const XMLLoader: {
-    name: string;
-    id: string;
-    module: string;
-    version: any;
-    worker: boolean;
-    extensions: string[];
-    mimeTypes: string[];
-    testText: typeof testXMLFile;
-    options: {
-        xml: {
-            parser: string;
-            uncapitalizeKeys: boolean;
-            removeNSPrefix: boolean;
-            textNodeName: string;
-            arrayPaths: never[];
-        };
-    };
-    parse: (arrayBuffer: ArrayBuffer, options?: XMLLoaderOptions) => Promise<any>;
-    parseTextSync: (text: string, options?: XMLLoaderOptions) => any;
-};
-declare function testXMLFile(text: string): boolean;
-export declare const _typecheckXMLLoader: LoaderWithParser;
-export {};
+export declare const XMLLoader: LoaderWithParser<any, never, XMLLoaderOptions>;
 //# sourceMappingURL=xml-loader.d.ts.map

package/dist/xml-loader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"xml-loader.d.ts","sourceRoot":"","sources":["../src/xml-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAC9E,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,cAAc,CAAC;AACnD,OAAO,EAAe,oBAAoB,EAAC,MAAM,yBAAyB,CAAC;AAO3E,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE;QAEJ,MAAM,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC;QACpC,iEAAiE;QACjE,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;IACF,uFAAuF;IACvF,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,2FAA2F;IAC3F,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;yBAkBO,WAAW,YAAY,gBAAgB;0BAE5C,MAAM,YAAY,gBAAgB;CACzD,CAAC;AAEF,iBAAS,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG1C;AAwCD,eAAO,MAAM,mBAAmB,EAAE,gBAA4B,CAAC"}
+{"version":3,"file":"xml-loader.d.ts","sourceRoot":"","sources":["../src/xml-loader.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAC9E,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAO7D,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,gBAAgB,CAAC,GAAG,EAAE,KAAK,EAAE,gBAAgB,CAyBpE,CAAC"}

package/dist/xml-loader.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._typecheckXMLLoader = exports.XMLLoader = void 0;
+exports.XMLLoader = void 0;
 const parse_xml_1 = require("./lib/parsers/parse-xml");
-const uncapitalize_1 = require("./lib/xml-utils/uncapitalize");
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
@@ -20,47 +19,20 @@ exports.XMLLoader = {
     testText: testXMLFile,
     options: {
         xml: {
-            parser: 'fast-xml-parser',
+            _parser: 'fast-xml-parser',
             uncapitalizeKeys: false,
             removeNSPrefix: false,
             textNodeName: 'value',
             arrayPaths: []
         }
     },
-    parse: async (arrayBuffer, options) => parseTextSync(new TextDecoder().decode(arrayBuffer), options),
-    parseTextSync: (text, options) => parseTextSync(text, options)
+    parse: async (arrayBuffer, options) => (0, parse_xml_1.parseXMLSync)(new TextDecoder().decode(arrayBuffer), {
+        ...exports.XMLLoader.options.xml,
+        ...options?.xml
+    }),
+    parseTextSync: (text, options) => (0, parse_xml_1.parseXMLSync)(text, { ...exports.XMLLoader.options.xml, ...options?.xml })
 };
 function testXMLFile(text) {
     // TODO - There could be space first.
     return text.startsWith('<?xml');
 }
-function parseTextSync(text, options) {
-    const xmlOptions = { ...exports.XMLLoader.options.xml, ...options?.xml };
-    switch (xmlOptions.parser) {
-        case 'fast-xml-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,
-                // XMLLoader Options: Map to FastXMLOptions
-                // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#removensprefix
-                removeNSPrefix: xmlOptions.removeNSPrefix,
-                // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#textnodename
-                textNodeName: xmlOptions.textNodeName,
-                isArray: (name, jpath, isLeafNode, isAttribute) => {
-                    const array = Boolean(xmlOptions?.arrayPaths?.some((path) => jpath === path));
-                    return array;
-                },
-                // Application overrides
-                ...options?._fastXML
-            };
-            const xml = (0, parse_xml_1.fastParseXML)(text, fastXMLOptions);
-            // Note - could be done with FastXML tag processing
-            return xmlOptions.uncapitalizeKeys ? (0, uncapitalize_1.uncapitalizeKeys)(xml) : xml;
-        default:
-            throw new Error(options?.xml?.parser);
-    }
-}
-exports._typecheckXMLLoader = exports.XMLLoader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/xml",
-  "version": "3.4.0-alpha.3",
+  "version": "4.0.0-alpha.6",
   "description": "Framework-independent loaders for the XML (eXtensible Markup Language) format",
   "license": "MIT",
   "publishConfig": {
@@ -33,12 +33,12 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/loader-utils": "3.4.0-alpha.3",
-    "@loaders.gl/schema": "3.4.0-alpha.3",
+    "@loaders.gl/loader-utils": "4.0.0-alpha.6",
+    "@loaders.gl/schema": "4.0.0-alpha.6",
     "fast-xml-parser": "^4.1.3"
   },
   "devDependencies": {
     "xmldom": "0.6.0"
   },
-  "gitHead": "a954528dd1d78a1f128d8f6b07e4baeb7a296924"
+  "gitHead": "acc1985050dfaa0f1f0c066f8da5bce7454a046c"
 }

package/src/html-loader.ts

@@ -35,12 +35,12 @@ function parseTextSync(text: string, options?: XMLLoaderOptions): any {
   // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/5.Entities.md
   options = mergeLoaderOptions(options, {
     xml: {
-      parser: 'fast-xml-parser'
-    },
-    _fastXML: {
-      htmlEntities: true
+      _parser: 'fast-xml-parser',
+      _fastXML: {
+        htmlEntities: true
+      }
     }
   });
 
-  return XMLLoader.parseTextSync(text, options);
+  return XMLLoader.parseTextSync?.(text, options);
 }

package/src/lib/parsers/parse-xml.ts

@@ -1,13 +1,64 @@
 // loaders.gl, MIT license
 
+import type {SAXParserOptions} from '../../sax-ts/sax';
 import {StreamingXMLParser} from './streaming-xml-parser';
+import {uncapitalizeKeys} from '../xml-utils/uncapitalize';
 import {XMLParser as FastXMLParser} from 'fast-xml-parser';
 import type {X2jOptions} from 'fast-xml-parser';
 
+export type ParseXMLOptions = {
+  /** XML is typically PascalCase, JavaScript prefects camelCase */
+  uncapitalizeKeys?: boolean;
+  removeNSPrefix?: boolean;
+  textNodeName?: string;
+  arrayPaths?: string[];
+
+  // NOTE: Only fast-xml-parser is implemented
+  _parser?: 'fast-xml-parser' | 'sax';
+  /** @deprecated Experimental, passes options to fast-xml-parser, IF it is being used */
+  _fastXML?: _FastParseXMLOptions;
+  /** @deprecated Experimental, passes options to the SAX XML parser, IF it is being used. */
+  _sax?: SAXParserOptions;
+};
+
 /** Type for passing through fast-xml-parser options */
-export type FastXMLParserOptions = Partial<X2jOptions>;
+export type _FastParseXMLOptions = Partial<X2jOptions>;
+
+export function parseXMLSync(text: string, options?: ParseXMLOptions): any {
+  if (options?._parser && options._parser !== 'fast-xml-parser') {
+    throw new Error(options?._parser);
+  }
+
+  const fastXMLOptions: _FastParseXMLOptions = {
+    // 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: string, jpath: string, isLeafNode: boolean, isAttribute: boolean) => {
+      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: string, options: FastXMLParserOptions): any {
+export function fastParseXML(text: string, options: _FastParseXMLOptions): any {
   const parser = new FastXMLParser({
     ignoreAttributes: false,
     attributeNamePrefix: '',

package/src/xml-loader.ts

@@ -1,32 +1,19 @@
 import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import type {SAXParserOptions} from './sax-ts/sax';
-import {fastParseXML, FastXMLParserOptions} from './lib/parsers/parse-xml';
-import {uncapitalizeKeys} from './lib/xml-utils/uncapitalize';
+import type {ParseXMLOptions} from './lib/parsers/parse-xml';
+import {parseXMLSync} from './lib/parsers/parse-xml';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
 export type XMLLoaderOptions = LoaderOptions & {
-  xml?: {
-    // TODO - type this harder
-    parser?: 'fast-xml-parser' | string;
-    /** XML is typically PascalCase, JavaScript prefects camelCase */
-    uncapitalizeKeys?: boolean;
-    removeNSPrefix?: boolean;
-    textNodeName?: string;
-    arrayPaths?: string[];
-  };
-  /** @deprecated Experimental, passes options to fast-xml-parser, IF it is being used */
-  _fastXML?: FastXMLParserOptions;
-  /** @deprecated Experimental, passes options to the SAX XML parser, IF it is being used. */
-  _sax?: SAXParserOptions;
+  xml?: ParseXMLOptions;
 };
 
 /**
  * Loader for XML files
  */
-export const XMLLoader = {
+export const XMLLoader: LoaderWithParser<any, never, XMLLoaderOptions> = {
   name: 'XML',
   id: 'xml',
   module: 'xml',
@@ -37,7 +24,7 @@ export const XMLLoader = {
   testText: testXMLFile,
   options: {
     xml: {
-      parser: 'fast-xml-parser',
+      _parser: 'fast-xml-parser',
       uncapitalizeKeys: false,
       removeNSPrefix: false,
       textNodeName: 'value',
@@ -45,51 +32,15 @@ export const XMLLoader = {
     }
   },
   parse: async (arrayBuffer: ArrayBuffer, options?: XMLLoaderOptions) =>
-    parseTextSync(new TextDecoder().decode(arrayBuffer), options),
-  parseTextSync: (text: string, options?: XMLLoaderOptions) => parseTextSync(text, options)
+    parseXMLSync(new TextDecoder().decode(arrayBuffer), {
+      ...XMLLoader.options.xml,
+      ...options?.xml
+    }),
+  parseTextSync: (text: string, options?: XMLLoaderOptions) =>
+    parseXMLSync(text, {...XMLLoader.options.xml, ...options?.xml})
 };
 
 function testXMLFile(text: string): boolean {
   // TODO - There could be space first.
   return text.startsWith('<?xml');
 }
-
-function parseTextSync(text: string, options?: XMLLoaderOptions): any {
-  const xmlOptions: Required<XMLLoaderOptions['xml']> = {...XMLLoader.options.xml, ...options?.xml};
-  switch (xmlOptions.parser) {
-    case 'fast-xml-parser':
-      const fastXMLOptions: FastXMLParserOptions = {
-        // 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,
-
-        // XMLLoader Options: Map to FastXMLOptions
-
-        // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#removensprefix
-        removeNSPrefix: xmlOptions.removeNSPrefix,
-
-        // https://github.com/NaturalIntelligence/fast-xml-parser/blob/master/docs/v4/2.XMLparseOptions.md#textnodename
-        textNodeName: xmlOptions.textNodeName,
-
-        isArray: (name: string, jpath: string, isLeafNode: boolean, isAttribute: boolean) => {
-          const array = Boolean(xmlOptions?.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 xmlOptions.uncapitalizeKeys ? uncapitalizeKeys(xml) : xml;
-
-    default:
-      throw new Error(options?.xml?.parser);
-  }
-}
-
-export const _typecheckXMLLoader: LoaderWithParser = XMLLoader;