@loaders.gl/wms 4.0.0-alpha.23 → 4.0.0-alpha.25

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

@@ -1,233 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseWMSCapabilities = void 0;
-const xml_1 = require("@loaders.gl/xml");
-const parse_xml_helpers_1 = require("../xml/parse-xml-helpers");
-/**
- * Parses a typed data structure from raw XML for `GetCapabilities` response
- * @note Error handlings is fairly weak
- */
-function parseWMSCapabilities(xmlText, options) {
-    const parsedXML = xml_1.XMLLoader.parseTextSync?.(xmlText, options);
-    const xmlCapabilities = parsedXML.WMT_MS_Capabilities || parsedXML.WMS_Capabilities || parsedXML;
-    const capabilities = extractCapabilities(xmlCapabilities);
-    // In case the processed, normalized capabilities do not contain everything,
-    // the user can get the parsed XML structure.
-    if (options?.inheritedLayerProps) {
-        // Traverse layers and inject missing props from parents
-        for (const layer of capabilities.layers) {
-            addInheritedLayerProps(layer, null);
-        }
-        // Not yet implemented
-    }
-    if (options?.includeRawData || options?.raw) {
-        capabilities.raw = xmlCapabilities;
-    }
-    if (options?.includeXMLText) {
-        capabilities.xml = xmlText;
-    }
-    return capabilities;
-}
-exports.parseWMSCapabilities = parseWMSCapabilities;
-/** Extract typed capability data from XML */
-function extractCapabilities(xml) {
-    const capabilities = {
-        version: String(xml.version || ''),
-        name: String(xml.Service?.Name || 'unnamed'),
-        title: xml.Service?.Title ? String(xml.Service?.Title) : undefined,
-        abstract: xml.Service?.Abstract ? String(xml.Service?.Abstract) : undefined,
-        keywords: (0, parse_xml_helpers_1.getXMLStringArray)(xml.Service?.KeywordList?.Keyword),
-        fees: xml.Service?.Fees ? JSON.stringify(xml.Service?.Fees) : undefined,
-        accessConstraints: xml.Service?.AccessConstraints
-            ? JSON.stringify(xml.Service?.AccessConstraints)
-            : undefined,
-        layerLimit: (0, parse_xml_helpers_1.getXMLInteger)(xml.Service?.LayerLimit),
-        maxWidth: (0, parse_xml_helpers_1.getXMLInteger)(xml.Service?.maxWidth),
-        maxHeight: (0, parse_xml_helpers_1.getXMLInteger)(xml.Service?.maxHeight),
-        layers: [],
-        requests: extractRequests(xml.Capability?.Request),
-        exceptions: extractExceptions(xml.Exception)
-        // contact field is a mess of largely irrelevant information, put it last
-        // contact: xml.Service?.Contact ? JSON.stringify(xml.Service?.Contact) : undefined,
-    };
-    // LAYERS
-    const xmlLayers = (0, parse_xml_helpers_1.getXMLArray)(xml.Capability?.Layer);
-    for (const xmlSubLayer of xmlLayers) {
-        capabilities.layers.push(extractLayer(xmlSubLayer));
-    }
-    // Clean up object
-    for (const [key, value] of Object.entries(capabilities)) {
-        if (value === undefined) {
-            delete capabilities[key];
-        }
-    }
-    return capabilities;
-}
-/** Extract typed request metadata from XML requests field */
-function extractRequests(xmlRequests) {
-    const requests = {};
-    for (const [name, xmlRequest] of Object.entries(xmlRequests || {})) {
-        const mimeTypes = (0, parse_xml_helpers_1.getXMLStringArray)(xmlRequest?.Format);
-        requests[name] = { mimeTypes };
-    }
-    return requests;
-}
-function extractExceptions(xmlException) {
-    const xmlExceptionFormats = (0, parse_xml_helpers_1.getXMLArray)(xmlException?.Format);
-    if (xmlExceptionFormats.length > 0) {
-        return {
-            mimeTypes: (0, parse_xml_helpers_1.getXMLStringArray)(xmlException)
-        };
-    }
-    return undefined;
-}
-/** Extract request data */
-// eslint-disable-next-line complexity, max-statements
-function extractLayer(xmlLayer) {
-    const layer = {
-        // All layers must have a title
-        title: String(xmlLayer?.Title || ''),
-        // Name is required only if renderable
-        name: xmlLayer?.Name && String(xmlLayer?.Name),
-        abstract: xmlLayer?.Name && String(xmlLayer?.Abstract),
-        keywords: (0, parse_xml_helpers_1.getXMLStringArray)(xmlLayer.KeywordList?.Keyword)
-    };
-    // WMS 1.3.0 changes SRS to CRS
-    const crs = xmlLayer?.CRS || xmlLayer?.SRS;
-    if (crs && Array.isArray(crs) && crs.every((_) => typeof _ === 'string')) {
-        layer.crs = crs;
-    }
-    // v1.3.0 extract simple geographic bounding box
-    let geographicBoundingBox = xmlLayer?.EX_GeographicBoundingBox && extractEXBoundingBox(xmlLayer?.EX_GeographicBoundingBox);
-    if (geographicBoundingBox) {
-        layer.geographicBoundingBox = geographicBoundingBox;
-    }
-    // v1.1.1 extract simple geographic bounding box
-    geographicBoundingBox =
-        xmlLayer?.LatLonBoundingBox && extractLatLonBoundingBox(xmlLayer?.LatLonBoundingBox);
-    if (geographicBoundingBox) {
-        layer.geographicBoundingBox = geographicBoundingBox;
-    }
-    // Extract per-CRS bounding boxes
-    const boundingBoxes = xmlLayer?.BoundingBox && extractWMSBoundingBoxes(xmlLayer?.BoundingBox);
-    if (boundingBoxes && boundingBoxes.length > 0) {
-        layer.boundingBoxes = boundingBoxes;
-    }
-    // Extract dimensions
-    const xmlDimensions = (0, parse_xml_helpers_1.getXMLArray)(xmlLayer?.Dimension);
-    const dimensions = xmlDimensions.map((xml) => extractDimension(xml));
-    if (dimensions.length) {
-        layer.dimensions = dimensions;
-    }
-    if (xmlLayer?.opaque) {
-        layer.opaque = (0, parse_xml_helpers_1.getXMLBoolean)(xmlLayer?.opaque);
-    }
-    if (xmlLayer?.cascaded) {
-        layer.cascaded = (0, parse_xml_helpers_1.getXMLBoolean)(xmlLayer?.cascaded);
-    }
-    if (xmlLayer?.queryable) {
-        layer.queryable = (0, parse_xml_helpers_1.getXMLBoolean)(xmlLayer?.queryable);
-    }
-    // Single layer is not represented as array in XML
-    const xmlLayers = (0, parse_xml_helpers_1.getXMLArray)(xmlLayer?.Layer);
-    const layers = [];
-    for (const xmlSubLayer of xmlLayers) {
-        layers.push(extractLayer(xmlSubLayer));
-    }
-    if (layers.length > 0) {
-        layer.layers = layers;
-    }
-    // Clean up object
-    for (const [key, value] of Object.entries(layer)) {
-        if (value === undefined) {
-            delete layer[key];
-        }
-    }
-    return layer;
-}
-/** WMS 1.3.0 Loosely defined geospatial bounding box in unspecified CRS for quick content searches */
-function extractEXBoundingBox(xmlBoundingBox) {
-    const { westBoundLongitude: w, northBoundLatitude: n, eastBoundLongitude: e, southBoundLatitude: s } = xmlBoundingBox;
-    return [
-        [w, s],
-        [e, n]
-    ];
-}
-/** WMS 1.1.1 Loosely defined geospatial bounding box in unspecified CRS for quick content searches */
-function extractLatLonBoundingBox(xmlBoundingBox) {
-    const { minx, miny, maxx, maxy } = xmlBoundingBox;
-    return [
-        [minx, miny],
-        [maxx, maxy]
-    ];
-}
-/** Loosely defined geospatial bounding box in unspecified CRS for quick content searches */
-function extractWMSBoundingBoxes(xmlBoundingBoxes) {
-    const xmlBoxes = (0, parse_xml_helpers_1.getXMLArray)(xmlBoundingBoxes);
-    return xmlBoxes.map((xmlBox) => extractWMSBoundingBox(xmlBox));
-}
-/** Loosely defined geospatial bounding box in unspecified CRS for quick content searches */
-function extractWMSBoundingBox(xmlBoundingBox) {
-    const { CRS, SRS, minx, miny, maxx, maxy, resx, resy } = xmlBoundingBox;
-    const boundingBox = {
-        // CRS in 1.3.0, SRS in 1.1.1
-        crs: CRS || SRS,
-        boundingBox: [
-            [(0, parse_xml_helpers_1.getXMLFloat)(minx), (0, parse_xml_helpers_1.getXMLFloat)(miny)],
-            [(0, parse_xml_helpers_1.getXMLFloat)(maxx), (0, parse_xml_helpers_1.getXMLFloat)(maxy)]
-        ]
-    };
-    if (resx) {
-        boundingBox.xResolution = resx;
-    }
-    if (resy) {
-        boundingBox.yResolution = resy;
-    }
-    return boundingBox;
-}
-/**
- * Extracts optional WMS Dimension layer field
- * @param xmlDimension
- * @example <Dimension name="time" units="ISO8601" default="2018-01-01" nearestValue="0">2001-01-01/2018-01-01/P1Y</Dimension>
- * @see https://mapserver.org/ogc/wms_dimension.html
- */
-function extractDimension(xmlDimension) {
-    const { name, units, value: extent } = xmlDimension;
-    const dimension = { name, units, extent };
-    if (xmlDimension.unitSymbol) {
-        dimension.unitSymbol = xmlDimension.unitSymbol;
-    }
-    if (xmlDimension.default) {
-        dimension.defaultValue = xmlDimension.default;
-    }
-    if (xmlDimension.multipleValues) {
-        dimension.multipleValues = (0, parse_xml_helpers_1.getXMLBoolean)(xmlDimension.multipleValues);
-    }
-    if (xmlDimension.nearestValue) {
-        dimension.nearestValue = (0, parse_xml_helpers_1.getXMLBoolean)(xmlDimension.nearestValue);
-    }
-    if (xmlDimension.current) {
-        dimension.current = (0, parse_xml_helpers_1.getXMLBoolean)(xmlDimension.current);
-    }
-    return dimension;
-}
-/** Traverse layers and inject missing props from parents */
-// eslint-disable-next-line complexity
-function addInheritedLayerProps(layer, parent) {
-    if (parent?.geographicBoundingBox && !layer.geographicBoundingBox) {
-        layer.geographicBoundingBox = [...parent.geographicBoundingBox];
-    }
-    if (parent?.crs && !layer.crs) {
-        layer.crs = [...parent.crs];
-    }
-    if (parent?.boundingBoxes && !layer.boundingBoxes) {
-        layer.boundingBoxes = [...parent.boundingBoxes];
-    }
-    if (parent?.dimensions && !layer.dimensions) {
-        layer.dimensions = [...parent.dimensions];
-    }
-    for (const subLayer of layer.layers || []) {
-        addInheritedLayerProps(subLayer, layer);
-    }
-}

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

@@ -1,22 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseWMSError = void 0;
-const xml_1 = require("@loaders.gl/xml");
-/**
- * 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.value || serviceExceptionXML.code || 'Unknown error';
-    return message;
-}
-exports.parseWMSError = parseWMSError;

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

@@ -1,27 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseWMSFeatureInfo = void 0;
-const xml_1 = require("@loaders.gl/xml");
-/**
- * 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 }
-    };
-}

package/dist/lib/parsers/wms/parse-wms-layer-description.js

@@ -1,15 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseWMSLayerDescription = void 0;
-const xml_1 = require("@loaders.gl/xml");
-/**
- * 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;

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

@@ -1,68 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getXMLBoolean = exports.getXMLInteger = exports.getXMLFloat = exports.getXMLStringArray = exports.getXMLArray = void 0;
-/** A single element of an array is not represented as an array in XML */
-function getXMLArray(xmlValue) {
-    // Already an array, return as is
-    if (Array.isArray(xmlValue)) {
-        return xmlValue;
-    }
-    // Single value, wrap in array
-    if (xmlValue) {
-        return [xmlValue];
-    }
-    // nullish, return empty array
-    return [];
-}
-exports.getXMLArray = getXMLArray;
-/** Get a list of strings from XML */
-function getXMLStringArray(xmlValue) {
-    const xmlArray = getXMLArray(xmlValue);
-    if (xmlArray.length > 0 && xmlArray.every((_) => typeof _ === 'string')) {
-        return xmlArray;
-    }
-    // TODO - error handling?
-    return [];
-}
-exports.getXMLStringArray = getXMLStringArray;
-/** Get XML float */
-function getXMLFloat(xmlValue, defaultValue = undefined) {
-    switch (typeof xmlValue) {
-        case 'number':
-            return xmlValue;
-        case 'string':
-            return parseFloat(xmlValue);
-        default:
-            return undefined;
-    }
-}
-exports.getXMLFloat = getXMLFloat;
-/** Get XML integer */
-function getXMLInteger(xmlValue, defaultValue = undefined) {
-    switch (typeof xmlValue) {
-        case 'number':
-            return xmlValue;
-        case 'string':
-            return parseInt(xmlValue, 10);
-        default:
-            return undefined;
-    }
-}
-exports.getXMLInteger = getXMLInteger;
-/** Somewhat arbitrary boolean parsing */
-function getXMLBoolean(xmlValue) {
-    switch (xmlValue) {
-        case 'true':
-            return true;
-        case 'false':
-            return false;
-        case '1':
-            return true;
-        case '0':
-            return false;
-        default:
-            return false;
-    }
-}
-exports.getXMLBoolean = getXMLBoolean;

package/dist/lib/services/arcgis/arcgis-image-service.js

@@ -1,94 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArcGISImageServer = void 0;
-const image_source_1 = require("../../sources/image-source");
-/**
- * ArcGIS ImageServer
- * Note - exports a big API, that could be exposed here if there is a use case
- * @see https://developers.arcgis.com/rest/services-reference/enterprise/image-service.htm
- */
-class ArcGISImageServer extends image_source_1.ImageSource {
-    constructor(props) {
-        super(props);
-    }
-    // ImageSource (normalized endpoints)
-    async getMetadata() {
-        return (await this.metadata());
-        // TODO - normalize metadata
-    }
-    async getImage(parameters) {
-        throw new Error('not implemented');
-        // TODO - Map generic parameters to ArcGIS specific parameters
-        // return await this.exportImage(parameters);
-    }
-    // ImageServer endpoints
-    async metadata() {
-        // We just need a JSON parsing...
-        // return this.getUrl({path: '', ...options});
-        throw new Error('not implemented');
-    }
-    /**
-     * Form a URL to an ESRI ImageServer
-     // https://sampleserver6.arcgisonline.com/arcgis/rest/services/NLCDLandCover2001/ImageServer/exportImage?bbox=${bounds[0]},${bounds[1]},${bounds[2]},${bounds[3]}&bboxSR=4326&size=${width},${height}&imageSR=102100&time=&format=jpgpng&pixelType=U8&noData=&noDataInterpretation=esriNoDataMatchAny&interpolation=+RSP_NearestNeighbor&compression=&compressionQuality=&bandIds=&mosaicRule=&renderingRule=&f=image`,
-     */
-    exportImage(options) {
-        // See WMSService.getMap()
-        throw new Error('not implemented');
-    }
-    // URL creators
-    metadataURL(options) {
-        return `${this.props.url}?f=pjson`;
-    }
-    /**
-     * Form a URL to an ESRI ImageServer
-     // https://sampleserver6.arcgisonline.com/arcgis/rest/services/NLCDLandCover2001/ImageServer/exportImage?
-     //   bbox=${bounds[0]},${bounds[1]},${bounds[2]},${bounds[3]}&bboxSR=4326&
-     //   size=${width},${height}&imageSR=102100&time=&format=jpgpng&pixelType=U8&
-     //   noData=&noDataInterpretation=esriNoDataMatchAny&interpolation=+RSP_NearestNeighbor&compression=&
-     //   compressionQuality=&bandIds=&mosaicRule=&renderingRule=&
-     //   f=image
-     */
-    exportImageURL(options) {
-        const bbox = `bbox=${options.bbox[0]},${options.bbox[1]},${options.bbox[2]},${options.bbox[3]}`;
-        const size = `size=${options.width},${options.height}`;
-        const arcgisOptions = { ...options, bbox, size };
-        // @ts-expect-error
-        delete arcgisOptions.width;
-        // @ts-expect-error
-        delete arcgisOptions.height;
-        return this.getUrl('exportImage', arcgisOptions);
-    }
-    // INTERNAL METHODS
-    /**
-     * @note protected, since perhaps getWMSUrl may need to be overridden to handle certain backends?
-     * @note if override is common, maybe add a callback prop?
-     * */
-    getUrl(path, options, extra) {
-        let url = `${this.props.url}/${path}`;
-        let first = true;
-        for (const [key, value] of Object.entries(options)) {
-            url += first ? '?' : '&';
-            first = false;
-            if (Array.isArray(value)) {
-                url += `${key.toUpperCase()}=${value.join(',')}`;
-            }
-            else {
-                url += `${key.toUpperCase()}=${value ? String(value) : ''}`;
-            }
-        }
-        return url;
-    }
-    /** Checks for and parses a WMS XML formatted ServiceError and throws an exception */
-    async checkResponse(response) {
-        if (!response.ok) {
-            // } || response.headers['content-type'] === WMSErrorLoader.mimeTypes[0]) {
-            // const arrayBuffer = await response.arrayBuffer();
-            // const error = await WMSErrorLoader.parse(arrayBuffer, this.loadOptions);
-            throw new Error('error');
-        }
-    }
-}
-exports.ArcGISImageServer = ArcGISImageServer;
-ArcGISImageServer.type = 'arcgis-image-server';
-ArcGISImageServer.testURL = (url) => url.toLowerCase().includes('ImageServer');

package/dist/lib/services/arcgis/arcgis-server.js

@@ -1,42 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getArcGISServices = void 0;
-/**
- * (Recursively) load the service directory from an ArcGIS Server URL
- * @param url
- * @param fetchFile= Optional fetch function override
- * @returns
- */
-async function getArcGISServices(url, fetchFile = fetch) {
-    if (url.includes('rest/services')) {
-        const serverUrl = url.replace(/rest\/services.*$/i, 'rest/services');
-        return loadServiceDirectory(serverUrl, fetchFile, []);
-    }
-    return null;
-}
-exports.getArcGISServices = getArcGISServices;
-async function loadServiceDirectory(serverUrl, fetch, path) {
-    const serviceUrl = `${serverUrl}/${path.join('/')}`;
-    const response = await fetch(`${serviceUrl}?f=pjson`);
-    const directory = await response.json();
-    const services = extractServices(directory, serviceUrl);
-    const folders = (directory.folders || []);
-    const promises = folders.map((folder) => loadServiceDirectory(`${serverUrl}`, fetch, [...path, folder]));
-    for (const folderServices of await Promise.all(promises)) {
-        services.push(...folderServices);
-    }
-    return services;
-}
-function extractServices(directory, url) {
-    const arcgisServices = (directory.services || []);
-    const services = [];
-    for (const service of arcgisServices) {
-        services.push({
-            name: service.name,
-            type: `arcgis-${service.type.toLocaleLowerCase().replace('server', '-server')}`,
-            url: `${url}${service.name}/${service.type}`
-        });
-    }
-    return services;
-}

package/dist/lib/services/generic/image-service.js

@@ -1,47 +0,0 @@
-"use strict";
-// loaders.gl, MIT license
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ImageService = void 0;
-const images_1 = require("@loaders.gl/images");
-const image_source_1 = require("../../sources/image-source");
-/**
- * Quickly connect to "ad hoc" image sources without subclassing ImageSource.
- * ImageSource allows template url strings to be used to ad hoc connect to arbitrary image data sources
- * Accepts a template url string and builds requests URLs
- */
-class ImageService extends image_source_1.ImageSource {
-    constructor(props) {
-        super(props);
-    }
-    // IMAGE SOURCE API
-    async getMetadata() {
-        throw new Error('ImageSource.getMetadata not implemented');
-    }
-    async getImage(parameters) {
-        const granularParameters = this.getGranularParameters(parameters);
-        const url = this.getURLFromTemplate(granularParameters);
-        const response = await this.fetch(url);
-        const arrayBuffer = await response.arrayBuffer();
-        return await images_1.ImageLoader.parse(arrayBuffer);
-    }
-    // HELPERS
-    /** Break up bounding box in east, north, south, west */
-    getGranularParameters(parameters) {
-        const [east, north, west, south] = parameters.bbox;
-        return { ...parameters, east, north, south, west };
-    }
-    /** Supports both ${} and {} notations */
-    getURLFromTemplate(parameters) {
-        let url = this.props.url;
-        for (const [key, value] of Object.entries(parameters)) {
-            // TODO - parameter could be repeated
-            // const regex = new RegExp(`\${${key}}`, 'g');
-            url = url.replace(`\${${key}}`, String(value));
-            url = url.replace(`{${key}}`, String(value));
-        }
-        return url;
-    }
-}
-exports.ImageService = ImageService;
-ImageService.type = 'template';
-ImageService.testURL = (url) => url.toLowerCase().includes('{');