@loaders.gl/wms 3.3.0-alpha.12 → 3.3.0-alpha.13

package/dist/lib/data-sources/wms-service.js

@@ -0,0 +1,206 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WMSService = void 0;
+const images_1 = require("@loaders.gl/images");
+const image_source_1 = require("./image-source");
+const wms_capabilities_loader_1 = require("../../wms-capabilities-loader");
+const wms_feature_info_loader_1 = require("../../wip/wms-feature-info-loader");
+const wms_layer_description_loader_1 = require("../../wip/wms-layer-description-loader");
+const wms_error_loader_1 = require("../../wms-error-loader");
+/**
+ * The WMSService class provides
+ * - provides type safe methods to form URLs to a WMS service
+ * - provides type safe methods to query and parse results (and errors) from a WMS service
+ * - implements the ImageService interface
+ * @note Only the URL parameter conversion is supported. XML posts are not supported.
+ */
+class WMSService extends image_source_1.ImageSource {
+    /** Create a WMSService */
+    constructor(props) {
+        super();
+        this.loadOptions = {
+            // We want error responses to throw exceptions, the WMSErrorLoader can do this
+            wms: { throwOnError: true }
+        };
+        /** A list of loaders used by the WMSService methods */
+        this.loaders = [
+            images_1.ImageLoader,
+            wms_error_loader_1.WMSErrorLoader,
+            wms_capabilities_loader_1.WMSCapabilitiesLoader,
+            wms_feature_info_loader_1.WMSFeatureInfoLoader,
+            wms_layer_description_loader_1.WMSLayerDescriptionLoader
+        ];
+        this.serviceUrl = props.serviceUrl;
+        // TODO Need an options merge function from loaders.gl to merge subobjects
+        Object.assign(this.loadOptions, props.loadOptions);
+        this.fetch = props.fetch || fetch;
+    }
+    // ImageSource implementation
+    getMetadata() {
+        return this.getCapabilities();
+    }
+    getImage(parameters) {
+        return this.getMap(parameters);
+    }
+    // WMS Service API Stubs
+    /** Get Capabilities */
+    async getCapabilities(wmsParameters, vendorParameters) {
+        const url = this.getCapabilitiesURL(wmsParameters, vendorParameters);
+        const { fetch } = this;
+        const response = await fetch(url, this.loadOptions);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return await wms_capabilities_loader_1.WMSCapabilitiesLoader.parse(arrayBuffer, this.loadOptions);
+    }
+    /** Get a map image */
+    async getMap(options, vendorParameters) {
+        const url = this.getMapURL(options, vendorParameters);
+        const { fetch } = this;
+        const response = await fetch(url, this.loadOptions);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        try {
+            return await images_1.ImageLoader.parse(arrayBuffer, this.loadOptions);
+        }
+        catch {
+            throw this._parseError(arrayBuffer);
+        }
+    }
+    /** Get Feature Info for a coordinate */
+    async getFeatureInfo(options, vendorParameters) {
+        const url = this.getFeatureInfoURL(options, vendorParameters);
+        const response = await this.fetch(url, this.loadOptions);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return await wms_feature_info_loader_1.WMSFeatureInfoLoader.parse(arrayBuffer, this.loadOptions);
+    }
+    /** Get more information about a layer */
+    async describeLayer(options, vendorParameters) {
+        const url = this.describeLayerURL(options, vendorParameters);
+        const response = await this.fetch(url, this.loadOptions);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return await wms_layer_description_loader_1.WMSLayerDescriptionLoader.parse(arrayBuffer, this.loadOptions);
+    }
+    /** Get an image with a semantic legend */
+    async getLegendGraphic(options, vendorParameters) {
+        const url = this.getLegendGraphicURL(options, vendorParameters);
+        const response = await this.fetch(url, this.loadOptions);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        try {
+            return await images_1.ImageLoader.parse(arrayBuffer, this.loadOptions);
+        }
+        catch {
+            throw this._parseError(arrayBuffer);
+        }
+    }
+    // Typed URL creators
+    // For applications that want full control of fetching and parsing
+    /** Generate a URL for the GetCapabilities request */
+    getCapabilitiesURL(wmsParameters, vendorParameters) {
+        const options = {
+            service: 'WMS',
+            version: '1.1.1',
+            request: 'GetCapabilities',
+            ...wmsParameters,
+            ...vendorParameters
+        };
+        return this._getWMSUrl(options, vendorParameters);
+    }
+    /** Generate a URL for the GetMap request */
+    getMapURL(wmsParameters, vendorParameters) {
+        const options = {
+            service: 'WMS',
+            version: '1.1.1',
+            request: 'GetMap',
+            // layers: [],
+            // bbox: [-77.87304, 40.78975, -77.85828, 40.80228],
+            // width: 1200,
+            // height: 900,
+            styles: undefined,
+            srs: 'EPSG:4326',
+            format: 'image/png',
+            ...wmsParameters,
+            ...vendorParameters
+        };
+        return this._getWMSUrl(options, vendorParameters);
+    }
+    /** Generate a URL for the GetFeatureInfo request */
+    getFeatureInfoURL(wmsParameters, vendorParameters) {
+        const options = {
+            service: 'WMS',
+            version: '1.1.1',
+            request: 'GetFeatureInfo',
+            // layers: [],
+            // bbox: [-77.87304, 40.78975, -77.85828, 40.80228],
+            // width: 1200,
+            // height: 900,
+            // x: undefined!,
+            // y: undefined!,
+            // query_layers: [],
+            srs: 'EPSG:4326',
+            format: 'image/png',
+            info_format: 'text/plain',
+            styles: undefined,
+            ...wmsParameters,
+            ...vendorParameters
+        };
+        return this._getWMSUrl(options, vendorParameters);
+    }
+    /** Generate a URL for the GetFeatureInfo request */
+    describeLayerURL(wmsParameters, vendorParameters) {
+        const options = {
+            service: 'WMS',
+            version: '1.1.1',
+            request: 'DescribeLayer',
+            ...wmsParameters,
+            ...vendorParameters
+        };
+        return this._getWMSUrl(options, vendorParameters);
+    }
+    getLegendGraphicURL(wmsParameters, vendorParameters) {
+        const options = {
+            service: 'WMS',
+            version: '1.1.1',
+            request: 'GetLegendGraphic',
+            ...wmsParameters,
+            ...vendorParameters
+        };
+        return this._getWMSUrl(options, vendorParameters);
+    }
+    // INTERNAL METHODS
+    /**
+     * @note case _getWMSUrl may need to be overridden to handle certain backends?
+     * */
+    _getWMSUrl(options, vendorParameters) {
+        let url = `${this.serviceUrl}`;
+        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 encodeURI(url);
+    }
+    /** Checks for and parses a WMS XML formatted ServiceError and throws an exception */
+    _checkResponse(response, arrayBuffer) {
+        const contentType = response.headers['content-type'];
+        if (!response.ok || wms_error_loader_1.WMSErrorLoader.mimeTypes.includes(contentType)) {
+            const error = wms_error_loader_1.WMSErrorLoader.parseSync(arrayBuffer, this.loadOptions);
+            throw new Error(error);
+        }
+    }
+    /** Error situation detected */
+    _parseError(arrayBuffer) {
+        const error = wms_error_loader_1.WMSErrorLoader.parseSync(arrayBuffer, this.loadOptions);
+        return new Error(error);
+    }
+}
+exports.WMSService = WMSService;

package/dist/lib/gml/deep-strict-equal.d.ts

@@ -0,0 +1,3 @@
+/** @todo replace this ridiculous choice of deepStrictEqual */
+export declare function deepStrictEqual(actual: unknown, expected: unknown, strict?: boolean): any;
+//# sourceMappingURL=deep-strict-equal.d.ts.map

package/dist/lib/gml/deep-strict-equal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deep-strict-equal.d.ts","sourceRoot":"","sources":["../../../src/lib/gml/deep-strict-equal.ts"],"names":[],"mappings":"AA0BA,8DAA8D;AAE9D,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,OAyCnF"}

package/dist/lib/gml/deep-strict-equal.js

@@ -0,0 +1,119 @@
+"use strict";
+// https://github.com/nodejs/node/commit/c1d82ac2ff15594840e2a1b9531b506ae067ed27;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepStrictEqual = void 0;
+// http://wiki.commonjs.org/wiki/Unit_Testing/1.0
+//
+// THIS IS NOT TESTED NOR LIKELY TO WORK OUTSIDE V8!
+//
+// Originally from narwhal.js (http://narwhaljs.org)
+// Copyright (c) 2009 Thomas Robinson <280north.com>
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the 'Software'), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+/** @todo replace this ridiculous choice of deepStrictEqual */
+// eslint-disable-next-line complexity
+function deepStrictEqual(actual, expected, strict) {
+    // 7.1. All identical values are equivalent, as determined by ===.
+    if (actual === expected) {
+        return true;
+        // } else if (actual instanceof Buffer && expected instanceof Buffer) {
+        //   return compare(actual, expected) === 0;
+        // // 7.2. If the expected value is a Date object, the actual value is
+        // // equivalent if it is also a Date object that refers to the same time.
+    }
+    else if (actual instanceof Date && expected instanceof Date) {
+        return actual.getTime() === expected.getTime();
+        // 7.3 If the expected value is a RegExp object, the actual value is
+        // equivalent if it is also a RegExp object with the same source and
+        // properties (`global`, `multiline`, `lastIndex`, `ignoreCase`).
+    }
+    else if (actual instanceof RegExp && expected instanceof RegExp) {
+        return (actual.source === expected.source &&
+            actual.global === expected.global &&
+            actual.multiline === expected.multiline &&
+            actual.lastIndex === expected.lastIndex &&
+            actual.ignoreCase === expected.ignoreCase);
+        // 7.4. Other pairs that do not both pass typeof value == 'object',
+        // equivalence is determined by ==.
+    }
+    else if ((actual === null || typeof actual !== 'object') &&
+        (expected === null || typeof expected !== 'object')) {
+        // eslint-disable-next-line eqeqeq
+        return strict ? actual === expected : actual == expected;
+        // 7.5 For all other Object pairs, including Array objects, equivalence is
+        // determined by having the same number of owned properties (as verified
+        // with Object.prototype.hasOwnProperty.call), the same set of keys
+        // (although not necessarily the same order), equivalent values for every
+        // corresponding key, and an identical 'prototype' property. Note: this
+        // accounts for both named and indexed properties on Arrays.
+    }
+    return objEquiv(actual, expected, strict);
+}
+exports.deepStrictEqual = deepStrictEqual;
+// eslint-disable-next-line @typescript-eslint/unbound-method
+const pSlice = Array.prototype.slice;
+function isPrimitive(arg) {
+    return arg === null || (typeof arg !== 'object' && typeof arg !== 'function');
+}
+function isArguments(object) {
+    // eslint-disable-next-line eqeqeq
+    return Object.prototype.toString.call(object) == '[object Arguments]';
+}
+// eslint-disable-next-line complexity
+function objEquiv(a, b, strict) {
+    if (a === null || a === undefined || b === null || b === undefined)
+        return false;
+    // if one is a primitive, the other must be same
+    if (isPrimitive(a) || isPrimitive(b))
+        return a === b;
+    if (strict && Object.getPrototypeOf(a) !== Object.getPrototypeOf(b))
+        return false;
+    const aIsArgs = isArguments(a);
+    const bIsArgs = isArguments(b);
+    if ((aIsArgs && !bIsArgs) || (!aIsArgs && bIsArgs))
+        return false;
+    if (aIsArgs) {
+        a = pSlice.call(a);
+        b = pSlice.call(b);
+        return deepStrictEqual(a, b, strict);
+    }
+    const ka = Object.keys(a);
+    const kb = Object.keys(b);
+    let key;
+    let i;
+    // having the same number of owned properties (keys incorporates
+    // hasOwnProperty)
+    if (ka.length !== kb.length)
+        return false;
+    // the same set of keys (although not necessarily the same order),
+    ka.sort();
+    kb.sort();
+    // ~~~cheap key test
+    for (i = ka.length - 1; i >= 0; i--) {
+        if (ka[i] !== kb[i])
+            return false;
+    }
+    // equivalent values for every corresponding key, and
+    // ~~~possibly expensive deep test
+    for (i = ka.length - 1; i >= 0; i--) {
+        key = ka[i];
+        if (!deepStrictEqual(a[key], b[key], strict))
+            return false;
+    }
+    return true;
+}

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

@@ -0,0 +1,28 @@
+import type { Geometry, Position } from '@loaders.gl/schema';
+export type ParseGMLOptions = {
+    transformCoords?: Function;
+    stride?: 2 | 3 | 4;
+};
+export type ParseGMLContext = {
+    srsDimension?: number;
+    [key: string]: any;
+};
+/**
+ * Parses a typed data structure from raw XML for GML features
+ * @note Error handlings is fairly weak
+ */
+export declare function parseGML(text: string, options: any): Geometry | null;
+/** Parse a GeoJSON geometry from GML XML */
+export declare function parseGMLToGeometry(inputXML: any, options: ParseGMLOptions, context: ParseGMLContext): Geometry | null;
+export declare function parsePosList(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[];
+export declare function parsePos(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position;
+export declare function parsePoint(xml: any, options: ParseGMLOptions, context: ParseGMLContext): number[];
+export declare function parseLinearRingOrLineString(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[];
+export declare function parseCurveSegments(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[];
+export declare function parseRing(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[];
+export declare function parseExteriorOrInterior(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[];
+export declare function parsePolygonOrRectangle(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[][];
+export declare function parseSurface(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[][][];
+export declare function parseCompositeSurface(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[][][];
+export declare function parseMultiSurface(xml: any, options: ParseGMLOptions, context: ParseGMLContext): Position[][][];
+//# sourceMappingURL=parse-gml.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parse-gml.d.ts","sourceRoot":"","sources":["../../../src/lib/gml/parse-gml.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAIV,QAAQ,EACR,QAAQ,EAST,MAAM,oBAAoB,CAAC;AAU5B,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,CAAC,EAAE,QAAQ,CAAC;IAC3B,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,KAAA,mBAQ7C;AAED,4CAA4C;AAC5C,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,GAAG,EACb,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,GAAG,IAAI,CAuDjB;AAsBD,wBAAgB,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,eAAe,cASxF;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,eAAe,GAAG,QAAQ,CAa/F;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,eAAe,GAAG,MAAM,EAAE,CASjG;AAED,wBAAgB,2BAA2B,CACzC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,CA4BZ;AAED,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,CA0BZ;AAED,wBAAgB,SAAS,CACvB,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,CAuCZ;AAED,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,CAYZ;AAED,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,EAAE,CAoBd;AAED,wBAAgB,YAAY,CAC1B,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,EAAE,EAAE,CA0BhB;AAED,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,EAAE,EAAE,CAyBhB;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,GACvB,QAAQ,EAAE,EAAE,EAAE,CAmChB"}