@loaders.gl/wms 3.3.0-alpha.9 → 3.3.1

package/dist/lib/wms/parse-wms.d.ts

@@ -0,0 +1,24 @@
+import type { WMSCapabilities, WMSFeatureInfo, WMSLayerDescription } from './wms-types';
+/**
+ * Parses a typed data structure from raw XML for `GetCapabilities` response
+ * @note Error handlings is fairly weak
+ */
+export declare function parseWMSCapabilities(text: string, options: any): WMSCapabilities;
+/**
+ * Parses a typed data structure from raw XML for `GetFeatureInfo` response
+ * @note Error handlings is fairly weak
+ */
+export declare function parseWMSFeatureInfo(text: string, options: any): WMSFeatureInfo;
+/**
+ * Parses a typed data structure from raw XML for `GetFeatureInfo` response
+ * @note Error handlings is fairly weak
+ */
+export declare function parseWMSLayerDescription(text: string, options: any): WMSLayerDescription;
+/**
+ * Extract an error message from WMS error response XML
+ * @param text
+ * @param options
+ * @returns a string with a human readable message
+ */
+export declare function parseWMSError(text: string, options: any): string;
+//# sourceMappingURL=parse-wms.d.ts.map

package/dist/lib/wms/parse-wms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-wms.d.ts","sourceRoot":"","sources":["../../../src/lib/wms/parse-wms.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,eAAe,EAGf,cAAc,EACd,mBAAmB,EAGpB,MAAM,aAAa,CAAC;AAMrB;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAA,GAAG,eAAe,CAK3E;AA8DD;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAA,GAAG,cAAc,CASzE;AAcD;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAA,GAAG,mBAAmB,CAInF;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAA,GAAG,MAAM,CAW3D"}

package/dist/lib/wms/parse-wms.js

@@ -0,0 +1,115 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseWMSError = exports.parseWMSLayerDescription = exports.parseWMSFeatureInfo = exports.parseWMSCapabilities = void 0;
+const xml_1 = require("@loaders.gl/xml");
+// GetCapabilities
+/**
+ * Parses a typed data structure from raw XML for `GetCapabilities` response
+ * @note Error handlings is fairly weak
+ */
+function parseWMSCapabilities(text, options) {
+    const parsedXML = xml_1.XMLLoader.parseTextSync(text, options);
+    const xmlCapabilities = parsedXML.WMT_MS_Capabilities || parsedXML.WMS_Capabilities || parsedXML;
+    return extractCapabilities(xmlCapabilities);
+}
+exports.parseWMSCapabilities = parseWMSCapabilities;
+/** Extract typed capability data from XML */
+function extractCapabilities(xml) {
+    const capabilities = {
+        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, xmlRequest) {
+    const format = xmlRequest?.Format;
+    const mimeTypes = Array.isArray(format) ? format : [format];
+    return { name, mimeTypes };
+}
+/** Extract request data */
+function extractLayer(xmlLayer) {
+    const layer = {
+        name: xmlLayer?.Name,
+        title: xmlLayer?.Title,
+        srs: xmlLayer?.SRS || [],
+        layers: []
+    };
+    // Single layer is not represented as array in XML
+    const xmlLayers = getXMLArray(xmlLayer?.Layer);
+    for (const xmlSubLayer of xmlLayers) {
+        layer.layers?.push(extractLayer(xmlSubLayer));
+    }
+    return layer;
+}
+function getXMLArray(xmlValue) {
+    if (Array.isArray(xmlValue)) {
+        return xmlValue;
+    }
+    if (xmlValue) {
+        return [xmlValue];
+    }
+    return [];
+}
+// GetFeatureInfo
+/**
+ * Parses a typed data structure from raw XML for `GetFeatureInfo` response
+ * @note Error handlings is fairly weak
+ */
+function parseWMSFeatureInfo(text, options) {
+    const parsedXML = xml_1.XMLLoader.parseTextSync(text, options);
+    const xmlFeatureInfo = parsedXML.FeatureInfoResponse?.FIELDS || [];
+    const xmlFeatures = Array.isArray(xmlFeatureInfo) ? xmlFeatureInfo : [xmlFeatureInfo];
+    return {
+        features: xmlFeatures.map((xmlFeature) => extractFeature(xmlFeature))
+    };
+}
+exports.parseWMSFeatureInfo = parseWMSFeatureInfo;
+function extractFeature(xmlFeature) {
+    const xmlFields = xmlFeature || {};
+    // TODO - not correct
+    return {
+        attributes: xmlFields,
+        type: '',
+        bounds: { bottom: 0, top: 0, left: 0, right: 0 }
+    };
+}
+// GetFeatureInfo
+/**
+ * Parses a typed data structure from raw XML for `GetFeatureInfo` response
+ * @note Error handlings is fairly weak
+ */
+function parseWMSLayerDescription(text, options) {
+    const parsedXML = xml_1.XMLLoader.parseTextSync(text, options);
+    // TODO - implement parser
+    return parsedXML;
+}
+exports.parseWMSLayerDescription = parseWMSLayerDescription;
+/**
+ * Extract an error message from WMS error response XML
+ * @param text
+ * @param options
+ * @returns a string with a human readable message
+ */
+function parseWMSError(text, options) {
+    const parsedXML = xml_1.XMLLoader.parseTextSync?.(text, options);
+    const serviceExceptionXML = parsedXML?.ServiceExceptionReport?.ServiceException ||
+        parsedXML?.['ogc:ServiceExceptionReport']?.['ogc:ServiceException'];
+    // Sigh, can be either a string or an object
+    const message = typeof serviceExceptionXML === 'string'
+        ? serviceExceptionXML
+        : serviceExceptionXML['#text'] || serviceExceptionXML.code || 'Unknown error';
+    return message;
+}
+exports.parseWMSError = parseWMSError;

package/dist/lib/wms/wms-types.d.ts

@@ -0,0 +1,100 @@
+/** All capabilities of a WMS service - response to a WMS `GetCapabilities` data structure extracted from XML */
+export type WMSCapabilities = {
+    name: string;
+    title?: string;
+    abstract?: string;
+    keywords: string[];
+    layer: {
+        name: string;
+        title?: string;
+        srs?: string[];
+        boundingBox?: [number, number, number, number];
+        layers: WMSLayer[];
+    };
+    requests: Record<string, WMSRequest>;
+    raw: Record<string, unknown>;
+};
+export type WMSLayer = {
+    name: string;
+    title?: string;
+    srs?: string[];
+    boundingBox?: [number, number, number, number];
+    layers: WMSLayer[];
+};
+export type WMSRequest = {
+    name: string;
+    mimeTypes: string[];
+};
+/** WMS Feature info - response to a WMS `GetFeatureInfo` request */
+export type WMSFeatureInfo = {
+    features: WMSFeature[];
+};
+export type WMSFeature = {
+    attributes: Record<string, number | string>;
+    type: string;
+    bounds: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+};
+/** Layer description - response to a WMS `DescribeLayer` request  */
+export type WMSLayerDescription = {
+    layers: {}[];
+};
+/**
+ * <EX_GeographicBoundingBox>
+ *     <westBoundLongitude>-180</westBoundLongitude>
+ *     <eastBoundLongitude>180</eastBoundLongitude>
+ *     <southBoundLatitude>-65</southBoundLatitude>
+ *     <northBoundLatitude>75</northBoundLatitude>
+ * </EX_GeographicBoundingBox>
+ * <BoundingBox CRS="EPSG:4326"
+ *             minx="-65" miny="-180" maxx="75" maxy="180" />
+ */
+export type Layer = {
+    name: string;
+    title: string;
+    abstract?: string;
+    crs: string;
+    queryable?: boolean;
+    opaque?: boolean;
+    cascaded?: boolean;
+    geographicBoundingBox: number[];
+    boundingBox: number[];
+    boundingBoxCRS: string;
+    layers: Layer[];
+};
+/**
+ * <Style>
+ * <Name>default</Name>
+ * <Title>default</Title>
+ * <LegendURL width="89" height="21">
+ *    <Format>image/png</Format>
+ *    <OnlineResource xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://mapserver.ngdc.noaa.gov/cgi-bin/public/gcv4/?version=1.3.0&amp;service=WMS&amp;request=GetLegendGraphic&amp;sld_version=1.1.0&amp;layer=countries&amp;format=image/png&amp;STYLE=default"/>
+ * </LegendURL>
+ * </Style>
+ */
+export type Style = {
+    name: string;
+    title: string;
+    legendUrl?: {
+        width: number;
+        height: number;
+        format: string;
+        onlineResource: string;
+    };
+};
+export type WMSService = {
+    rawData: unknown;
+    name: string;
+    title: string;
+    onlineResource?: string;
+    contactInformation?: string;
+    maxWidth?: number;
+    maxHeight?: number;
+    capabilities: {};
+    untypedData: unknown;
+};
+//# sourceMappingURL=wms-types.d.ts.map

package/dist/lib/wms/wms-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wms-types.d.ts","sourceRoot":"","sources":["../../../src/lib/wms/wms-types.ts"],"names":[],"mappings":"AAEA,gHAAgH;AAChH,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAC/C,MAAM,EAAE,QAAQ,EAAE,CAAC;KACpB,CAAC;IACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,EAAE,QAAQ,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC;AAIF,oEAAoE;AACpE,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,UAAU,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,CAAC;CACpE,CAAC;AAIF,qEAAqE;AACrE,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,EAAE,EAAE,CAAC;CACd,CAAC;AAkCF;;;;;;;;;GASG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;CACH,CAAC;AAIF,MAAM,MAAM,UAAU,GAAG;IACvB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,EAIb,CAAC;IAEF,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC"}