@loaders.gl/wms 4.2.0-alpha.3 → 4.2.0-alpha.5

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

@@ -1,335 +1,354 @@
+// loaders.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 import { XMLLoader } from '@loaders.gl/xml';
 import { deepStrictEqual } from "./deep-strict-equal.js";
 import rewind from '@turf/rewind';
-function noTransform() {
-  for (var _len = arguments.length, coords = new Array(_len), _key = 0; _key < _len; _key++) {
-    coords[_key] = arguments[_key];
-  }
-  return coords;
+function noTransform(...coords) {
+    return coords;
 }
+/**
+ * Parses a typed data structure from raw XML for GML features
+ * @note Error handlings is fairly weak
+ */
 export function parseGML(text, options) {
-  var _XMLLoader$parseTextS;
-  const parsedXML = (_XMLLoader$parseTextS = XMLLoader.parseTextSync) === null || _XMLLoader$parseTextS === void 0 ? void 0 : _XMLLoader$parseTextS.call(XMLLoader, text, options);
-  options = {
-    transformCoords: noTransform,
-    stride: 2,
-    ...options
-  };
-  const context = createChildContext(parsedXML, options, {});
-  return parseGMLToGeometry(parsedXML, options, context);
+    // GeoJSON | null {
+    const parsedXML = XMLLoader.parseTextSync?.(text, options);
+    options = { transformCoords: noTransform, stride: 2, ...options };
+    const context = createChildContext(parsedXML, options, {});
+    return parseGMLToGeometry(parsedXML, options, context);
 }
+/** Parse a GeoJSON geometry from GML XML */
 export function parseGMLToGeometry(inputXML, options, context) {
-  const childContext = createChildContext(inputXML, options, context);
-  let geometry = null;
-  const [name, xml] = getFirstKeyValue(inputXML);
-  switch (name) {
-    case 'gml:LineString':
-      geometry = {
-        type: 'LineString',
-        coordinates: parseLinearRingOrLineString(xml, options, childContext)
-      };
-      break;
-    case 'gml:Polygon':
-    case 'gml:Rectangle':
-      geometry = {
-        type: 'Polygon',
-        coordinates: parsePolygonOrRectangle(xml, options, childContext)
-      };
-      break;
-    case 'gml:Surface':
-      geometry = {
-        type: 'MultiPolygon',
-        coordinates: parseSurface(xml, options, childContext)
-      };
-      break;
-    case 'gml:MultiSurface':
-      geometry = {
-        type: 'MultiPolygon',
-        coordinates: parseMultiSurface(xml, options, childContext)
-      };
-      break;
-    default:
-      return null;
-  }
-  return rewind(geometry, {
-    mutate: true
-  });
+    const childContext = createChildContext(inputXML, options, context);
+    let geometry = null;
+    const [name, xml] = getFirstKeyValue(inputXML);
+    switch (name) {
+        // case 'gml:MultiPoint':
+        //   geometry = {
+        //     type: 'MultiPoint',
+        //     coordinates: parseMultiPoint(xml, options, childContext)
+        //   };
+        //   break;
+        case 'gml:LineString':
+            geometry = {
+                type: 'LineString',
+                coordinates: parseLinearRingOrLineString(xml, options, childContext)
+            };
+            break;
+        // case 'gml:MultiLineString':
+        //   geometry = {
+        //     type: 'MultiLineString',
+        //     coordinates: parseMultiLineString(xml, options, childContext)
+        //   };
+        //   break;
+        case 'gml:Polygon':
+        case 'gml:Rectangle':
+            geometry = {
+                type: 'Polygon',
+                coordinates: parsePolygonOrRectangle(xml, options, childContext)
+            };
+            break;
+        case 'gml:Surface':
+            geometry = {
+                type: 'MultiPolygon',
+                coordinates: parseSurface(xml, options, childContext)
+            };
+            break;
+        case 'gml:MultiSurface':
+            geometry = {
+                type: 'MultiPolygon',
+                coordinates: parseMultiSurface(xml, options, childContext)
+            };
+            break;
+        default:
+            return null;
+    }
+    // todo
+    return rewind(geometry, { mutate: true });
 }
+/** Parse a list of coordinates from a string */
 function parseCoords(s, options, context) {
-  const stride = context.srsDimension || options.stride || 2;
-  const coords = s.replace(/\s+/g, ' ').trim().split(' ');
-  if (coords.length === 0 || coords.length % stride !== 0) {
-    throw new Error(`invalid coordinates list (stride ${stride})`);
-  }
-  const points = [];
-  for (let i = 0; i < coords.length - 1; i += stride) {
-    var _options$transformCoo;
-    const point = coords.slice(i, i + stride).map(parseFloat);
-    points.push(((_options$transformCoo = options.transformCoords) === null || _options$transformCoo === void 0 ? void 0 : _options$transformCoo.call(options, ...point)) || point);
-  }
-  return points;
+    const stride = context.srsDimension || options.stride || 2;
+    // Handle white space
+    const coords = s.replace(/\s+/g, ' ').trim().split(' ');
+    if (coords.length === 0 || coords.length % stride !== 0) {
+        throw new Error(`invalid coordinates list (stride ${stride})`);
+    }
+    const points = [];
+    for (let i = 0; i < coords.length - 1; i += stride) {
+        const point = coords.slice(i, i + stride).map(parseFloat);
+        points.push(options.transformCoords?.(...point) || point);
+    }
+    return points;
 }
 export function parsePosList(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const coords = textOf(xml);
-  if (!coords) {
-    throw new Error('invalid gml:posList element');
-  }
-  return parseCoords(coords, options, childContext);
+    const childContext = createChildContext(xml, options, context);
+    const coords = textOf(xml);
+    if (!coords) {
+        throw new Error('invalid gml:posList element');
+    }
+    return parseCoords(coords, options, childContext);
 }
 export function parsePos(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const coords = textOf(xml);
-  if (!coords) {
-    throw new Error('invalid gml:pos element');
-  }
-  const points = parseCoords(coords, options, childContext);
-  if (points.length !== 1) {
-    throw new Error('gml:pos must have 1 point');
-  }
-  return points[0];
+    const childContext = createChildContext(xml, options, context);
+    const coords = textOf(xml);
+    if (!coords) {
+        throw new Error('invalid gml:pos element');
+    }
+    const points = parseCoords(coords, options, childContext);
+    if (points.length !== 1) {
+        throw new Error('gml:pos must have 1 point');
+    }
+    return points[0];
 }
 export function parsePoint(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const pos = findIn(xml, 'gml:pos');
-  if (!pos) {
-    throw new Error('invalid gml:Point element, expected a gml:pos subelement');
-  }
-  return parsePos(pos, options, childContext);
+    const childContext = createChildContext(xml, options, context);
+    // TODO AV: Parse other gml:Point options
+    const pos = findIn(xml, 'gml:pos');
+    if (!pos) {
+        throw new Error('invalid gml:Point element, expected a gml:pos subelement');
+    }
+    return parsePos(pos, options, childContext);
 }
 export function parseLinearRingOrLineString(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  let points = [];
-  const posList = findIn(xml, 'gml:posList');
-  if (posList) {
-    points = parsePosList(posList, options, childContext);
-  } else {
-    for (const [childName, childXML] of Object.entries(xml)) {
-      switch (childName) {
-        case 'gml:Point':
-          points.push(parsePoint(childXML, options, childContext));
-          break;
-        case 'gml:pos':
-          points.push(parsePos(childXML, options, childContext));
-          break;
-        default:
-          continue;
-      }
+    // or a LineStringSegment
+    const childContext = createChildContext(xml, options, context);
+    let points = [];
+    const posList = findIn(xml, 'gml:posList');
+    if (posList) {
+        points = parsePosList(posList, options, childContext);
+    }
+    else {
+        for (const [childName, childXML] of Object.entries(xml)) {
+            switch (childName) {
+                case 'gml:Point':
+                    points.push(parsePoint(childXML, options, childContext));
+                    break;
+                case 'gml:pos':
+                    points.push(parsePos(childXML, options, childContext));
+                    break;
+                default:
+                    continue;
+            }
+        }
     }
-  }
-  if (points.length === 0) {
-    throw new Error(`${xml.name} must have > 0 points`);
-  }
-  return points;
+    if (points.length === 0) {
+        throw new Error(`${xml.name} must have > 0 points`);
+    }
+    return points;
 }
 export function parseCurveSegments(xml, options, context) {
-  const points = [];
-  for (const [childName, childXML] of Object.entries(xml)) {
-    switch (childName) {
-      case 'gml:LineStringSegment':
-        const points2 = parseLinearRingOrLineString(childXML, options, context);
-        const end = points[points.length - 1];
-        const start = points2[0];
-        if (end && start && deepStrictEqual(end, start)) {
-          points2.shift();
+    const points = [];
+    for (const [childName, childXML] of Object.entries(xml)) {
+        switch (childName) {
+            case 'gml:LineStringSegment':
+                const points2 = parseLinearRingOrLineString(childXML, options, context);
+                // remove overlapping
+                const end = points[points.length - 1];
+                const start = points2[0];
+                if (end && start && deepStrictEqual(end, start)) {
+                    points2.shift();
+                }
+                points.push(...points2);
+                break;
+            default:
+                continue;
         }
-        points.push(...points2);
-        break;
-      default:
-        continue;
     }
-  }
-  if (points.length === 0) {
-    throw new Error('gml:Curve > gml:segments must have > 0 points');
-  }
-  return points;
+    if (points.length === 0) {
+        throw new Error('gml:Curve > gml:segments must have > 0 points');
+    }
+    return points;
 }
 export function parseRing(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const points = [];
-  for (const [childName, childXML] of Object.entries(xml)) {
-    switch (childName) {
-      case 'gml:curveMember':
-        let points2;
-        const lineString = findIn(childXML, 'gml:LineString');
-        if (lineString) {
-          points2 = parseLinearRingOrLineString(lineString, options, childContext);
-        } else {
-          const segments = findIn(childXML, 'gml:Curve', 'gml:segments');
-          if (!segments) {
-            throw new Error(`invalid ${childName} element`);
-          }
-          points2 = parseCurveSegments(segments, options, childContext);
-        }
-        const end = points[points.length - 1];
-        const start = points2[0];
-        if (end && start && deepStrictEqual(end, start)) {
-          points2.shift();
+    const childContext = createChildContext(xml, options, context);
+    const points = [];
+    for (const [childName, childXML] of Object.entries(xml)) {
+        switch (childName) {
+            case 'gml:curveMember':
+                let points2;
+                const lineString = findIn(childXML, 'gml:LineString');
+                if (lineString) {
+                    points2 = parseLinearRingOrLineString(lineString, options, childContext);
+                }
+                else {
+                    const segments = findIn(childXML, 'gml:Curve', 'gml:segments');
+                    if (!segments) {
+                        throw new Error(`invalid ${childName} element`);
+                    }
+                    points2 = parseCurveSegments(segments, options, childContext);
+                }
+                // remove overlapping
+                const end = points[points.length - 1];
+                const start = points2[0];
+                if (end && start && deepStrictEqual(end, start)) {
+                    points2.shift();
+                }
+                points.push(...points2);
+                break;
         }
-        points.push(...points2);
-        break;
     }
-  }
-  if (points.length < 4) {
-    throw new Error(`${xml.name} must have >= 4 points`);
-  }
-  return points;
+    if (points.length < 4) {
+        throw new Error(`${xml.name} must have >= 4 points`);
+    }
+    return points;
 }
 export function parseExteriorOrInterior(xml, options, context) {
-  const linearRing = findIn(xml, 'gml:LinearRing');
-  if (linearRing) {
-    return parseLinearRingOrLineString(linearRing, options, context);
-  }
-  const ring = findIn(xml, 'gml:Ring');
-  if (!ring) {
-    throw new Error(`invalid ${xml.name} element`);
-  }
-  return parseRing(ring, options, context);
+    const linearRing = findIn(xml, 'gml:LinearRing');
+    if (linearRing) {
+        return parseLinearRingOrLineString(linearRing, options, context);
+    }
+    const ring = findIn(xml, 'gml:Ring');
+    if (!ring) {
+        throw new Error(`invalid ${xml.name} element`);
+    }
+    return parseRing(ring, options, context);
 }
 export function parsePolygonOrRectangle(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const exterior = findIn(xml, 'gml:exterior');
-  if (!exterior) {
-    throw new Error(`invalid ${xml.name} element`);
-  }
-  const pointLists = [parseExteriorOrInterior(exterior, options, childContext)];
-  for (const [childName, childXML] of Object.entries(xml)) {
-    switch (childName) {
-      case 'gml:interior':
-        pointLists.push(parseExteriorOrInterior(childXML, options, childContext));
-        break;
+    // or PolygonPatch
+    const childContext = createChildContext(xml, options, context);
+    const exterior = findIn(xml, 'gml:exterior');
+    if (!exterior) {
+        throw new Error(`invalid ${xml.name} element`);
+    }
+    const pointLists = [parseExteriorOrInterior(exterior, options, childContext)];
+    for (const [childName, childXML] of Object.entries(xml)) {
+        switch (childName) {
+            case 'gml:interior':
+                pointLists.push(parseExteriorOrInterior(childXML, options, childContext));
+                break;
+        }
     }
-  }
-  return pointLists;
+    return pointLists;
 }
 export function parseSurface(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const patches = findIn(xml, 'gml:patches');
-  if (!patches) {
-    throw new Error(`invalid ${xml.name} element`);
-  }
-  const polygons = [];
-  for (const [childName, childXML] of Object.entries(xml)) {
-    switch (childName) {
-      case 'gml:PolygonPatch':
-      case 'gml:Rectangle':
-        polygons.push(parsePolygonOrRectangle(childXML, options, childContext));
-        break;
-      default:
-        continue;
+    const childContext = createChildContext(xml, options, context);
+    const patches = findIn(xml, 'gml:patches');
+    if (!patches) {
+        throw new Error(`invalid ${xml.name} element`);
     }
-  }
-  if (polygons.length === 0) {
-    throw new Error(`${xml.name} must have > 0 polygons`);
-  }
-  return polygons;
+    const polygons = [];
+    for (const [childName, childXML] of Object.entries(xml)) {
+        switch (childName) {
+            case 'gml:PolygonPatch':
+            case 'gml:Rectangle':
+                polygons.push(parsePolygonOrRectangle(childXML, options, childContext));
+                break;
+            default:
+                continue;
+        }
+    }
+    if (polygons.length === 0) {
+        throw new Error(`${xml.name} must have > 0 polygons`);
+    }
+    return polygons;
 }
 export function parseCompositeSurface(xml, options, context) {
-  const childContext = createChildContext(xml, options, context);
-  const polygons = [];
-  for (const [childName, childXML] of Object.entries(xml)) {
-    switch (childName) {
-      case 'gml:surfaceMember':
-      case 'gml:surfaceMembers':
-        const [c2Name, c2Xml] = getFirstKeyValue(childXML);
-        switch (c2Name) {
-          case 'gml:Surface':
-            polygons.push(...parseSurface(c2Xml, options, childContext));
-            break;
-          case 'gml:Polygon':
-            polygons.push(parsePolygonOrRectangle(c2Xml, options, childContext));
-            break;
+    const childContext = createChildContext(xml, options, context);
+    const polygons = [];
+    for (const [childName, childXML] of Object.entries(xml)) {
+        switch (childName) {
+            case 'gml:surfaceMember':
+            case 'gml:surfaceMembers':
+                const [c2Name, c2Xml] = getFirstKeyValue(childXML);
+                switch (c2Name) {
+                    case 'gml:Surface':
+                        polygons.push(...parseSurface(c2Xml, options, childContext));
+                        break;
+                    case 'gml:Polygon':
+                        polygons.push(parsePolygonOrRectangle(c2Xml, options, childContext));
+                        break;
+                }
+                break;
         }
-        break;
     }
-  }
-  if (polygons.length === 0) {
-    throw new Error(`${xml.name} must have > 0 polygons`);
-  }
-  return polygons;
+    if (polygons.length === 0) {
+        throw new Error(`${xml.name} must have > 0 polygons`);
+    }
+    return polygons;
 }
 export function parseMultiSurface(xml, options, context) {
-  let el = xml;
-  const surfaceMembers = findIn(xml, 'gml:LinearRing');
-  if (surfaceMembers) {
-    el = surfaceMembers;
-  }
-  const polygons = [];
-  for (const [childName, childXML] of Object.entries(el)) {
-    switch (childName) {
-      case 'gml:Surface':
-        const polygons2 = parseSurface(childXML, options, context);
-        polygons.push(...polygons2);
-        break;
-      case 'gml:surfaceMember':
-        const polygons3 = parseSurfaceMember(childXML, options, context);
-        polygons.push(...polygons3);
-        break;
-      case 'gml:surfaceMembers':
-        const polygonXML = findIn(childXML, 'gml:Polygon');
-        for (const surfaceMemberXML of polygonXML) {
-          const polygons3 = parseSurfaceMember(surfaceMemberXML, options, context);
-          polygons.push(...polygons3);
+    let el = xml;
+    const surfaceMembers = findIn(xml, 'gml:LinearRing');
+    if (surfaceMembers) {
+        el = surfaceMembers;
+    }
+    const polygons = [];
+    for (const [childName, childXML] of Object.entries(el)) {
+        switch (childName) {
+            case 'gml:Surface':
+                const polygons2 = parseSurface(childXML, options, context);
+                polygons.push(...polygons2);
+                break;
+            case 'gml:surfaceMember':
+                const polygons3 = parseSurfaceMember(childXML, options, context);
+                polygons.push(...polygons3);
+                break;
+            case 'gml:surfaceMembers':
+                const polygonXML = findIn(childXML, 'gml:Polygon');
+                for (const surfaceMemberXML of polygonXML) {
+                    const polygons3 = parseSurfaceMember(surfaceMemberXML, options, context);
+                    polygons.push(...polygons3);
+                }
+                break;
         }
-        break;
     }
-  }
-  if (polygons.length === 0) {
-    throw new Error(`${xml.name} must have > 0 polygons`);
-  }
-  return polygons;
+    if (polygons.length === 0) {
+        throw new Error(`${xml.name} must have > 0 polygons`);
+    }
+    return polygons;
 }
 function parseSurfaceMember(xml, options, context) {
-  const [childName, childXml] = getFirstKeyValue(xml);
-  switch (childName) {
-    case 'gml:CompositeSurface':
-      return parseCompositeSurface(childXml, options, context);
-    case 'gml:Surface':
-      return parseSurface(childXml, options, context);
-    case 'gml:Polygon':
-      return [parsePolygonOrRectangle(childXml, options, context)];
-  }
-  throw new Error(`${childName} must have polygons`);
+    const [childName, childXml] = getFirstKeyValue(xml);
+    switch (childName) {
+        case 'gml:CompositeSurface':
+            return parseCompositeSurface(childXml, options, context);
+        case 'gml:Surface':
+            return parseSurface(childXml, options, context);
+        case 'gml:Polygon':
+            return [parsePolygonOrRectangle(childXml, options, context)];
+    }
+    throw new Error(`${childName} must have polygons`);
 }
+// Helpers
 function textOf(el) {
-  if (typeof el !== 'string') {
-    throw new Error('expected string');
-  }
-  return el;
+    if (typeof el !== 'string') {
+        throw new Error('expected string');
+    }
+    return el;
 }
-function findIn(root) {
-  let el = root;
-  for (var _len2 = arguments.length, tags = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
-    tags[_key2 - 1] = arguments[_key2];
-  }
-  for (const tag of tags) {
-    const child = el[tag];
-    if (!child) {
-      return null;
+function findIn(root, ...tags) {
+    let el = root;
+    for (const tag of tags) {
+        const child = el[tag];
+        if (!child) {
+            return null;
+        }
+        el = child;
     }
-    el = child;
-  }
-  return el;
+    return el;
 }
+/** @returns the first [key, value] pair in an object, or ['', null] if empty object */
 function getFirstKeyValue(object) {
-  if (object && typeof object === 'object') {
-    for (const [key, value] of Object.entries(object)) {
-      return [key, value];
+    if (object && typeof object === 'object') {
+        for (const [key, value] of Object.entries(object)) {
+            return [key, value];
+        }
     }
-  }
-  return ['', null];
+    return ['', null];
 }
+/** A bit heavyweight for just tracking dimension? */
 function createChildContext(xml, options, context) {
-  const srsDimensionAttribute = xml.attributes && xml.attributes.srsDimension;
-  if (srsDimensionAttribute) {
-    const srsDimension = parseInt(srsDimensionAttribute);
-    if (Number.isNaN(srsDimension) || srsDimension <= 0) {
-      throw new Error(`invalid srsDimension attribute value "${srsDimensionAttribute}", expected a positive integer`);
+    const srsDimensionAttribute = xml.attributes && xml.attributes.srsDimension;
+    if (srsDimensionAttribute) {
+        const srsDimension = parseInt(srsDimensionAttribute);
+        if (Number.isNaN(srsDimension) || srsDimension <= 0) {
+            throw new Error(`invalid srsDimension attribute value "${srsDimensionAttribute}", expected a positive integer`);
+        }
+        const childContext = Object.create(context);
+        childContext.srsDimension = srsDimension;
+        return childContext;
     }
-    const childContext = Object.create(context);
-    childContext.srsDimension = srsDimension;
-    return childContext;
-  }
-  return context;
+    return context;
 }
-//# sourceMappingURL=parse-gml.js.map