@loaders.gl/wms 3.3.0-alpha.10

package/src/lib/parse-wms.ts

@@ -0,0 +1,92 @@
+// loaders.gl, MIT license
+
+import type {
+  WMSCapabilities,
+  WMSLayer,
+  WMSRequest,
+  WMSFeatureInfo
+  // WMSFeature,
+  // WMSLayerDescription
+} from '../wms-types';
+
+import {XMLLoader} from '@loaders.gl/xml';
+
+// GetCapabilities
+
+/**
+ * Parses a typed data structure from raw XML for `GetCapabilities` response
+ * @note Error handlings is fairly weak
+ */
+export function parseWMSCapabilities(text: string, options): WMSCapabilities {
+  const parsedXML = XMLLoader.parseTextSync(text, options);
+  const xmlCapabilities: any =
+    parsedXML.WMT_MS_Capabilities || parsedXML.WMS_Capabilities || parsedXML;
+  return extractCapabilities(xmlCapabilities);
+}
+
+/** Extract typed capability data from XML */
+function extractCapabilities(xml: any): WMSCapabilities {
+  const capabilities: WMSCapabilities = {
+    name: xml.Service?.Name || 'unnamed',
+    title: xml.Service?.Title,
+    keywords: [],
+    requests: {},
+    layer: extractLayer(xml.Capability?.Layer),
+    raw: xml
+  };
+
+  for (const keyword of xml.Service?.KeywordList?.Keyword || []) {
+    capabilities.keywords.push(keyword);
+  }
+
+  for (const [name, xmlRequest] of Object.entries(xml.Capability?.Request || {})) {
+    capabilities.requests[name] = extractRequest(name, xmlRequest);
+  }
+
+  return capabilities;
+}
+
+/** Extract typed request data from XML */
+function extractRequest(name: string, xmlRequest: any): WMSRequest {
+  const format: string | string[] = xmlRequest?.Format;
+  const mimeTypes: string[] = Array.isArray(format) ? format : [format];
+  return {name, mimeTypes};
+}
+
+/** Extract request data */
+function extractLayer(xmlLayer: any): WMSLayer {
+  const layer: WMSLayer = {
+    name: xmlLayer?.Name,
+    title: xmlLayer?.Title,
+    srs: xmlLayer?.SRS || [],
+    layers: []
+  };
+
+  for (const xmlSubLayer of xmlLayer?.Layer || []) {
+    layer.layers?.push(extractLayer(xmlSubLayer));
+  }
+
+  return layer;
+}
+
+// GetFeatureInfo
+
+/**
+ * Parses a typed data structure from raw XML for `GetFeatureInfo` response
+ * @note Error handlings is fairly weak
+ */
+export function parseWMSFeatureInfo(text: string, options): WMSFeatureInfo {
+  const parsedXML = XMLLoader.parseTextSync(text, options);
+  const xmlFeatureInfo: any = parsedXML.FeatureInfoResponse?.FIELDS || [];
+
+  const xmlFeatures = Array.isArray(xmlFeatureInfo) ? xmlFeatureInfo : [xmlFeatureInfo];
+
+  return {
+    features: xmlFeatures.map((xmlFeature) => extractFeature(xmlFeature))
+  };
+}
+
+function extractFeature(xmlFeature: any) {
+  const xmlFields = xmlFeature || {};
+  return {attributes: xmlFields};
+}

package/src/wms-capabilities-loader.ts

@@ -0,0 +1,40 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {parseWMSCapabilities} from './lib/parse-wms';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type WMSLoaderOptions = LoaderOptions & {
+  wms?: {};
+};
+
+/**
+ * Loader for the response to the WMS GetCapability request
+ */
+export const WMSCapabilitiesLoader = {
+  name: 'WMS Capabilities',
+  id: 'wms-capabilities',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['xml'],
+  mimeTypes: ['application/vnd.ogc.wms_xml', 'application/xml', 'text/xml'],
+  testText: testXMLFile,
+  options: {
+    wms: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+    parseWMSCapabilities(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSCapabilities(text, options)
+};
+
+function testXMLFile(text: string): boolean {
+  // TODO - There could be space first.
+  return text.startsWith('<?xml');
+}
+
+export const _typecheckWMSCapabilitiesLoader: LoaderWithParser = WMSCapabilitiesLoader;

package/src/wms-feature-info-loader.ts

@@ -0,0 +1,21 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import {WMSCapabilitiesLoader, WMSLoaderOptions} from './wms-capabilities-loader';
+import {parseWMSFeatureInfo} from './lib/parse-wms';
+
+/**
+ * Loader for the response to the WMS GetFeatureInfo request
+ */
+export const WMSFeatureInfoLoader = {
+  ...WMSCapabilitiesLoader,
+
+  name: 'WMS FeatureInfo',
+  id: 'wms-feature-info',
+
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+    parseWMSFeatureInfo(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSFeatureInfo(text, options)
+};
+
+export const _typecheckWMSFeatureInfoLoader: LoaderWithParser = WMSFeatureInfoLoader;

package/src/wms-layer-description-loader.ts

@@ -0,0 +1,21 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import {WMSCapabilitiesLoader, WMSLoaderOptions} from './wms-capabilities-loader';
+import {parseWMSFeatureInfo} from './lib/parse-wms';
+
+/**
+ * Loader for the response to the WMS GetFeatureInfo request
+ */
+export const WMSLayerDescriptionLoader = {
+  ...WMSCapabilitiesLoader,
+
+  name: 'WMS DescribeLayer',
+  id: 'wms-layer-description',
+
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+    parseWMSFeatureInfo(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSFeatureInfo(text, options)
+};
+
+export const _typecheckWMSFeatureInfoLoader: LoaderWithParser = WMSLayerDescriptionLoader;