@loaders.gl/wms 3.4.0-alpha.1 → 3.4.0-alpha.3

package/dist/lib/{data-sources/image-services → services/ogc}/wms-service.d.ts

@@ -1,47 +1,66 @@
 import type { ImageType } from '@loaders.gl/images';
-import type { ImageSourceMetadata, GetImageParameters } from '../image-source';
-import { ImageSource } from '../image-source';
-import { ImageServiceProps } from './image-service';
-import type { WMSCapabilities, WMSFeatureInfo, WMSLayerDescription } from '../../wms/wms-types';
+import type { ImageSourceMetadata, GetImageParameters } from '../../sources/image-source';
+import type { ImageSourceProps } from '../../sources/image-source';
+import { ImageSource } from '../../sources/image-source';
+import type { WMSCapabilities } from '../../../wms-capabilities-loader';
+import type { WMSFeatureInfo } from '../../../wip/wms-feature-info-loader';
+import type { WMSLayerDescription } from '../../../wip/wms-layer-description-loader';
+import type { WMSLoaderOptions } from '../../../wms-error-loader';
+/** Static WMS parameters (not viewport or selected pixel dependent) that can be provided as defaults */
+export type WMSParameters = {
+    /** WMS version */
+    version?: '1.3.0' | '1.1.1';
+    /** Layers to render */
+    layers?: string[];
+    /** Coordinate Reference System (CRS) for the image (not the bounding box) */
+    crs?: string;
+    /** Requested format for the return image */
+    format?: 'image/png';
+    /** Requested MIME type of returned feature info */
+    info_format?: 'text/plain' | 'application/geojson' | 'application/vnd.ogc.gml';
+    /** Styling - Not yet supported */
+    styles?: unknown;
+    /** Any additional parameters specific to this WMSService */
+    transparent?: boolean;
+};
 type WMSCommonParameters = {
-    /** In case the endpoint supports multiple services */
-    service?: 'WMS';
     /** In case the endpoint supports multiple WMS versions */
-    version?: '1.1.1' | '1.3.0';
-};
-export type WMSGetCapabilitiesParameters = WMSCommonParameters & {
-    /** Request type */
-    request?: 'GetCapabilities';
+    version?: '1.3.0' | '1.1.1';
 };
+/** Parameters for GetCapabilities */
+export type WMSGetCapabilitiesParameters = WMSCommonParameters;
+/** Parameters for GetMap */
 export type WMSGetMapParameters = WMSCommonParameters & {
-    /** Request type */
-    request?: 'GetMap';
     /** Layers to render */
     layers: string | string[];
-    /** Styling */
-    styles?: unknown;
     /** bounding box of the requested map image */
     bbox: [number, number, number, number];
     /** pixel width of returned image */
     width: number;
     /** pixels */
     height: number;
-    /** srs for the image (not the bounding box) */
-    srs?: string;
+    /** Coordinate Reference System for the image (not the bounding box). */
+    crs?: string;
+    /** Styling */
+    styles?: unknown;
+    /** Don't render background when no data */
+    transparent?: boolean;
     /** requested format for the return image */
     format?: 'image/png';
 };
+/**
+ * Parameters for GetFeatureInfo
+ * @see https://imagery.pasda.psu.edu/arcgis/services/pasda/UrbanTreeCanopy_Landcover/MapServer/WmsServer?SERVICE=WMS&
+ */
 export type WMSGetFeatureInfoParameters = WMSCommonParameters & {
-    /** Request type */
-    request?: 'GetFeatureInfo';
     /** x coordinate for the feature info request */
     x: number;
     /** y coordinate for the feature info request */
     y: number;
     /** list of layers to query (could be different from rendered layers) */
     query_layers: string[];
-    /** MIME type of returned feature info */
-    info_format?: 'text/plain' | 'application/vnd.ogc.gml';
+    /** Requested MIME type of returned feature info */
+    info_format?: 'text/plain' | 'application/geojson' | 'application/vnd.ogc.gml';
     /** Layers to render */
     layers: string[];
     /** Styling */
@@ -57,13 +76,18 @@ export type WMSGetFeatureInfoParameters = WMSCommonParameters & {
     /** requested format for the return image */
     format?: 'image/png';
 };
-export type WMSDescribeLayerParameters = WMSCommonParameters & {
-    /** Request type */
-    request?: 'DescribeLayer';
-};
-export type WMSGetLegendGraphicParameters = WMSCommonParameters & {
-    /** Request type */
-    request?: 'GetLegendGraphic';
+/** Parameters for DescribeLayer */
+export type WMSDescribeLayerParameters = WMSCommonParameters;
+/** Parameters for GetLegendGraphic */
+export type WMSGetLegendGraphicParameters = WMSCommonParameters;
+/** Properties for creating a enw WMS service */
+export type WMSServiceProps = ImageSourceProps & {
+    /** Base URL to the service */
+    url: string;
+    /** Default WMS parameters. If not provided here, must be provided in the various request */
+    wmsParameters?: WMSParameters;
+    /** Any additional service specific parameters */
+    vendorParameters?: Record<string, unknown>;
 };
 /**
  * The WMSService class provides
@@ -75,8 +99,11 @@ export type WMSGetLegendGraphicParameters = WMSCommonParameters & {
 export declare class WMSService extends ImageSource {
     static type: 'wms';
     static testURL: (url: string) => boolean;
-    props: Required<ImageServiceProps>;
-    fetch: (url: string, options?: RequestInit) => Promise<Response>;
+    readonly url: string;
+    /** Default static WMS parameters */
+    wmsParameters: Required<WMSParameters>;
+    /** Default static vendor parameters */
+    vendorParameters?: Record<string, unknown>;
     capabilities: WMSCapabilities | null;
     /** A list of loaders used by the WMSService methods */
     readonly loaders: ({
@@ -93,12 +120,15 @@ export declare class WMSService extends ImageSource {
                 throwOnError: boolean;
             };
         };
-        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-error-loader").WMSLoaderOptions | undefined) => Promise<string>;
-        parseSync: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-error-loader").WMSLoaderOptions | undefined) => string;
-        parseTextSync: (text: string, options?: import("../../../wms-error-loader").WMSLoaderOptions | undefined) => string;
+        parse: (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions | undefined) => Promise<string>;
+        /** WMS version */
+        parseSync: (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions | undefined) => string;
+        parseTextSync: (text: string, options?: WMSLoaderOptions | undefined) => string;
     } | {
         id: string;
         name: string;
+        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => Promise<WMSFeatureInfo>;
+        parseTextSync: (text: string, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => WMSFeatureInfo;
         module: string;
         version: any;
         worker: boolean;
@@ -108,24 +138,11 @@ export declare class WMSService extends ImageSource {
         options: {
             wms: {};
         };
-        /** In case the endpoint supports multiple services */
-        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => Promise<WMSCapabilities>;
-        parseTextSync: (text: string, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => WMSCapabilities;
-    } | {
-        id: string;
-        module: string;
-        name: string;
-        version: any;
-        mimeTypes: string[];
-        extensions: string[];
-        parse: typeof import("modules/images/src/lib/parsers/parse-image").default;
-        tests: ((arrayBuffer: any) => boolean)[];
-        options: import("@loaders.gl/images").ImageLoaderOptions;
     } | {
         id: string;
         name: string;
-        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => Promise<WMSFeatureInfo>;
-        parseTextSync: (text: string, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => WMSFeatureInfo;
+        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => Promise<WMSLayerDescription>;
+        parseTextSync: (text: string, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => WMSLayerDescription;
         module: string;
         version: any;
         worker: boolean;
@@ -137,35 +154,32 @@ export declare class WMSService extends ImageSource {
         };
     } | {
         id: string;
-        name: string;
-        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => Promise<WMSLayerDescription>;
-        parseTextSync: (text: string, options?: import("../../../wms-capabilities-loader").WMSLoaderOptions | undefined) => WMSLayerDescription;
         module: string;
+        name: string;
         version: any;
-        worker: boolean;
-        extensions: string[];
         mimeTypes: string[];
-        testText: (text: string) => boolean;
-        options: {
-            wms: {};
-        };
+        extensions: string[];
+        parse: typeof import("modules/images/src/lib/parsers/parse-image").default;
+        tests: ((arrayBuffer: any) => boolean)[];
+        options: import("@loaders.gl/images").ImageLoaderOptions;
     })[];
     /** Create a WMSService */
-    constructor(props: ImageServiceProps);
+    constructor(props: WMSServiceProps);
     getMetadata(): Promise<ImageSourceMetadata>;
     getImage(parameters: GetImageParameters): Promise<ImageType>;
+    normalizeMetadata(capabilities: WMSCapabilities): ImageSourceMetadata;
     /** Get Capabilities */
     getCapabilities(wmsParameters?: WMSGetCapabilitiesParameters, vendorParameters?: Record<string, unknown>): Promise<WMSCapabilities>;
     /** Get a map image */
-    getMap(options: WMSGetMapParameters, vendorParameters?: Record<string, unknown>): Promise<ImageType>;
+    getMap(wmsParameters: WMSGetMapParameters, vendorParameters?: Record<string, unknown>): Promise<ImageType>;
     /** Get Feature Info for a coordinate */
-    getFeatureInfo(options: WMSGetFeatureInfoParameters, vendorParameters?: Record<string, unknown>): Promise<WMSFeatureInfo>;
+    getFeatureInfo(wmsParameters: WMSGetFeatureInfoParameters, vendorParameters?: Record<string, unknown>): Promise<WMSFeatureInfo>;
     /** Get Feature Info for a coordinate */
-    getFeatureInfoText(options: WMSGetFeatureInfoParameters, vendorParameters?: Record<string, unknown>): Promise<string>;
+    getFeatureInfoText(wmsParameters: WMSGetFeatureInfoParameters, vendorParameters?: Record<string, unknown>): Promise<string>;
     /** Get more information about a layer */
-    describeLayer(options: WMSDescribeLayerParameters, vendorParameters?: Record<string, unknown>): Promise<WMSLayerDescription>;
+    describeLayer(wmsParameters: WMSDescribeLayerParameters, vendorParameters?: Record<string, unknown>): Promise<WMSLayerDescription>;
     /** Get an image with a semantic legend */
-    getLegendGraphic(options: WMSGetLegendGraphicParameters, vendorParameters?: Record<string, unknown>): Promise<ImageType>;
+    getLegendGraphic(wmsParameters: WMSGetLegendGraphicParameters, vendorParameters?: Record<string, unknown>): Promise<ImageType>;
     /** Generate a URL for the GetCapabilities request */
     getCapabilitiesURL(wmsParameters?: WMSGetCapabilitiesParameters, vendorParameters?: Record<string, unknown>): string;
     /** Generate a URL for the GetMap request */
@@ -175,10 +189,20 @@ export declare class WMSService extends ImageSource {
     /** Generate a URL for the GetFeatureInfo request */
     describeLayerURL(wmsParameters: WMSDescribeLayerParameters, vendorParameters?: Record<string, unknown>): string;
     getLegendGraphicURL(wmsParameters: WMSGetLegendGraphicParameters, vendorParameters?: Record<string, unknown>): string;
+    _parseWMSUrl(url: string): {
+        url: string;
+        parameters: Record<string, unknown>;
+    };
     /**
+     * Generate a URL with parameters
      * @note case _getWMSUrl may need to be overridden to handle certain backends?
+     * @note at the moment, only URLs with parameters are supported (no XML payloads)
      * */
-    protected _getWMSUrl(options: Record<string, unknown>, vendorParameters?: Record<string, unknown>): string;
+    protected _getWMSUrl(request: string, wmsParameters: WMSCommonParameters & {
+        [key: string]: unknown;
+    }, vendorParameters?: Record<string, unknown>): string;
+    _getParameterValue(version: string, key: string, value: unknown): string;
+    protected _fetchArrayBuffer(url: string): Promise<ArrayBuffer>;
     /** Checks for and parses a WMS XML formatted ServiceError and throws an exception */
     protected _checkResponse(response: Response, arrayBuffer: ArrayBuffer): void;
     /** Error situation detected */

package/dist/lib/services/ogc/wms-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wms-service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/ogc/wms-service.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,oBAAoB,CAAC;AAIlD,OAAO,KAAK,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,4BAA4B,CAAC;AACxF,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAC,WAAW,EAAC,MAAM,4BAA4B,CAAC;AAEvD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AACtE,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,sCAAsC,CAAC;AACzE,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,2CAA2C,CAAC;AAMnF,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,2BAA2B,CAAC;AAGhE,wGAAwG;AACxG,MAAM,MAAM,aAAa,GAAG;IAC1B,kBAAkB;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC5B,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,6EAA6E;IAC7E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,mDAAmD;IACnD,WAAW,CAAC,EAAE,YAAY,GAAG,qBAAqB,GAAG,yBAAyB,CAAC;IAC/E,kCAAkC;IAClC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC7B,CAAC;AAEF,qCAAqC;AACrC,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,CAAC;AAE/D,4BAA4B;AAC5B,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,uBAAuB;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,8CAA8C;IAC9C,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG,mBAAmB,GAAG;IAC9D,gDAAgD;IAChD,CAAC,EAAE,MAAM,CAAC;IACV,gDAAgD;IAChD,CAAC,EAAE,MAAM,CAAC;IACV,wEAAwE;IACxE,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,mDAAmD;IACnD,WAAW,CAAC,EAAE,YAAY,GAAG,qBAAqB,GAAG,yBAAyB,CAAC;IAE/E,uBAAuB;IACvB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,mCAAmC;AACnC,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,CAAC;AAE7D,sCAAsC;AACtC,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,CAAC;AAIhE,gDAAgD;AAChD,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAC/C,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,4FAA4F;IAC5F,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,iDAAiD;IACjD,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,WAAW;IACzC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAS;IAC3B,MAAM,CAAC,OAAO,QAAS,MAAM,KAAG,OAAO,CAAsC;IAE7E,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,oCAAoC;IACpC,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IACvC,uCAAuC;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE3C,YAAY,EAAE,eAAe,GAAG,IAAI,CAAQ;IAE5C,uDAAuD;IACvD,QAAQ,CAAC,OAAO;;;;;;;;;;;;;;;QAhHhB,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAsHhB;IAEF,0BAA0B;gBACd,KAAK,EAAE,eAAe;IAwB5B,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAK3C,QAAQ,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAOlE,iBAAiB,CAAC,YAAY,EAAE,eAAe,GAAG,mBAAmB;IAMrE,uBAAuB;IACjB,eAAe,CACnB,aAAa,CAAC,EAAE,4BAA4B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,eAAe,CAAC;IAU3B,sBAAsB;IAChB,MAAM,CACV,aAAa,EAAE,mBAAmB,EAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,SAAS,CAAC;IAYrB,wCAAwC;IAClC,cAAc,CAClB,aAAa,EAAE,2BAA2B,EAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,cAAc,CAAC;IAQ1B,wCAAwC;IAClC,kBAAkB,CACtB,aAAa,EAAE,2BAA2B,EAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,MAAM,CAAC;IAQlB,yCAAyC;IACnC,aAAa,CACjB,aAAa,EAAE,0BAA0B,EACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAQ/B,0CAA0C;IACpC,gBAAgB,CACpB,aAAa,EAAE,6BAA6B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,SAAS,CAAC;IAerB,qDAAqD;IACrD,kBAAkB,CAChB,aAAa,CAAC,EAAE,4BAA4B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAQT,4CAA4C;IAC5C,SAAS,CACP,aAAa,EAAE,mBAAmB,EAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAgBT,oDAAoD;IACpD,iBAAiB,CACf,aAAa,EAAE,2BAA2B,EAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAmBT,oDAAoD;IACpD,gBAAgB,CACd,aAAa,EAAE,0BAA0B,EACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAQT,mBAAmB,CACjB,aAAa,EAAE,6BAA6B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAWT,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAC;IAa7E;;;;SAIK;IACL,SAAS,CAAC,UAAU,CAClB,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,mBAAmB,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,EAC7D,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IA2BT,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,MAAM;cAqBxD,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOpE,qFAAqF;IACrF,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI;IAY5E,+BAA+B;IAC/B,SAAS,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,KAAK;CAIvD"}

package/dist/lib/services/ogc/wms-service.js

@@ -0,0 +1,266 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WMSService = void 0;
+const images_1 = require("@loaders.gl/images");
+const loader_utils_1 = require("@loaders.gl/loader-utils");
+const image_source_1 = require("../../sources/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(props);
+        this.capabilities = null;
+        /** 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
+        ];
+        // TODO - defaults such as version, layers etc could be extracted from a base URL with parameters
+        // This would make pasting in any WMS URL more likely to make this class just work.
+        // const {baseUrl, parameters} = this._parseWMSUrl(props.url);
+        this.url = props.url;
+        this.wmsParameters = {
+            layers: undefined,
+            styles: undefined,
+            version: '1.3.0',
+            crs: 'EPSG:4326',
+            format: 'image/png',
+            info_format: 'text/plain',
+            transparent: undefined,
+            ...props.wmsParameters
+        };
+        this.vendorParameters = props.vendorParameters || {};
+    }
+    // ImageSource implementation
+    async getMetadata() {
+        const capabilities = await this.getCapabilities();
+        return this.normalizeMetadata(capabilities);
+    }
+    async getImage(parameters) {
+        // WMS 1.3.0 renamed SRS to CRS (sigh...)
+        const wmsParameters = { ...parameters, crs: parameters.srs };
+        delete wmsParameters.srs;
+        return await this.getMap(wmsParameters);
+    }
+    normalizeMetadata(capabilities) {
+        return capabilities;
+    }
+    // WMS Service API Stubs
+    /** Get Capabilities */
+    async getCapabilities(wmsParameters, vendorParameters) {
+        const url = this.getCapabilitiesURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        const capabilities = await wms_capabilities_loader_1.WMSCapabilitiesLoader.parse(arrayBuffer, this.loadOptions);
+        this.capabilities = capabilities;
+        return capabilities;
+    }
+    /** Get a map image */
+    async getMap(wmsParameters, vendorParameters) {
+        const url = this.getMapURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        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(wmsParameters, vendorParameters) {
+        const url = this.getFeatureInfoURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return await wms_feature_info_loader_1.WMSFeatureInfoLoader.parse(arrayBuffer, this.loadOptions);
+    }
+    /** Get Feature Info for a coordinate */
+    async getFeatureInfoText(wmsParameters, vendorParameters) {
+        const url = this.getFeatureInfoURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return new TextDecoder().decode(arrayBuffer);
+    }
+    /** Get more information about a layer */
+    async describeLayer(wmsParameters, vendorParameters) {
+        const url = this.describeLayerURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        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(wmsParameters, vendorParameters) {
+        const url = this.getLegendGraphicURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        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 = {
+            version: this.wmsParameters.version,
+            ...wmsParameters
+        };
+        return this._getWMSUrl('GetCapabilities', options, vendorParameters);
+    }
+    /** Generate a URL for the GetMap request */
+    getMapURL(wmsParameters, vendorParameters) {
+        const options = {
+            version: this.wmsParameters.version,
+            // layers: [],
+            // bbox: [-77.87304, 40.78975, -77.85828, 40.80228],
+            // width: 1200,
+            // height: 900,
+            styles: this.wmsParameters.styles,
+            crs: this.wmsParameters.crs,
+            format: this.wmsParameters.format,
+            transparent: this.wmsParameters.transparent,
+            ...wmsParameters
+        };
+        return this._getWMSUrl('GetMap', options, vendorParameters);
+    }
+    /** Generate a URL for the GetFeatureInfo request */
+    getFeatureInfoURL(wmsParameters, vendorParameters) {
+        const options = {
+            version: this.wmsParameters.version,
+            // layers: this.props.layers,
+            // bbox: [-77.87304, 40.78975, -77.85828, 40.80228],
+            // width: 1200,
+            // height: 900,
+            // x: undefined!,
+            // y: undefined!,
+            // query_layers: [],
+            srs: this.wmsParameters.crs,
+            format: this.wmsParameters.format,
+            info_format: this.wmsParameters.info_format,
+            styles: this.wmsParameters.styles,
+            ...wmsParameters
+        };
+        return this._getWMSUrl('GetFeatureInfo', options, vendorParameters);
+    }
+    /** Generate a URL for the GetFeatureInfo request */
+    describeLayerURL(wmsParameters, vendorParameters) {
+        const options = {
+            version: this.wmsParameters.version,
+            ...wmsParameters
+        };
+        return this._getWMSUrl('DescribeLayer', options, vendorParameters);
+    }
+    getLegendGraphicURL(wmsParameters, vendorParameters) {
+        const options = {
+            version: this.wmsParameters.version,
+            // format?
+            ...wmsParameters
+        };
+        return this._getWMSUrl('GetLegendGraphic', options, vendorParameters);
+    }
+    // INTERNAL METHODS
+    _parseWMSUrl(url) {
+        const [baseUrl, search] = url.split('?');
+        const searchParams = search.split('&');
+        const parameters = {};
+        for (const parameter of searchParams) {
+            const [key, value] = parameter.split('=');
+            parameters[key] = value;
+        }
+        return { url: baseUrl, parameters };
+    }
+    /**
+     * Generate a URL with parameters
+     * @note case _getWMSUrl may need to be overridden to handle certain backends?
+     * @note at the moment, only URLs with parameters are supported (no XML payloads)
+     * */
+    _getWMSUrl(request, wmsParameters, vendorParameters) {
+        let url = this.url;
+        let first = true;
+        // Add any vendor searchParams
+        const allParameters = {
+            service: 'WMS',
+            version: wmsParameters.version,
+            request,
+            ...wmsParameters,
+            ...this.vendorParameters,
+            ...vendorParameters
+        };
+        // Encode the keys
+        for (const [key, value] of Object.entries(allParameters)) {
+            // hack to preserve test cases. Not super clear if keys should be included when values are undefined
+            if (key !== 'transparent' || value) {
+                url += first ? '?' : '&';
+                first = false;
+                url += this._getParameterValue(wmsParameters.version, key, value);
+            }
+        }
+        return encodeURI(url);
+    }
+    _getParameterValue(version, key, value) {
+        // SRS parameter changed to CRS in 1.3.0, in non-backwards compatible way (sigh...)
+        if (key === 'crs' && version !== '1.3.0') {
+            key = 'srs';
+        }
+        key = key.toUpperCase();
+        // TODO - in v1.3.0 only, the order of parameters for BBOX depends on whether the CRS definition has flipped axes
+        // You will see this in the GetCapabilities request at 1.3.0 - the response should show the flipped axes.
+        // BBOX=xmin,ymin,xmax,ymax NON-FLIPPED
+        // BBOX=ymin,xmin,ymax,xmax FLIPPED
+        // / EPSG:4326 needs to have flipped axes. 4326 1 WGS 84 Latitude North Longitude East
+        // In WMS 1.1.1 EPSG:4326 is wrongly defined as having long/lat coordinate axes. In WMS 1.3.0 the correct axes lat/long are used. CRS:84 is defined by OGC as having the same datum as EPSG:4326 (that is the World Geodetic System 1984 datum ~ EPSG::6326) but axis order of long/lat.
+        // CRS:84 was introduced with the publication of the WMS 1.3.0 specification, to overcome this issue.
+        return Array.isArray(value)
+            ? `${key}=${value.join(',')}`
+            : `${key}=${value ? String(value) : ''}`;
+    }
+    async _fetchArrayBuffer(url) {
+        const response = await this.fetch(url);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return arrayBuffer;
+    }
+    /** 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)) {
+            // We want error responses to throw exceptions, the WMSErrorLoader can do this
+            const loadOptions = (0, loader_utils_1.mergeLoaderOptions)(this.loadOptions, {
+                wms: { throwOnError: true }
+            });
+            const error = wms_error_loader_1.WMSErrorLoader.parseSync(arrayBuffer, 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);
+    }
+}
+WMSService.type = 'wms';
+WMSService.testURL = (url) => url.toLowerCase().includes('wms');
+exports.WMSService = WMSService;

package/dist/lib/sources/data-source.d.ts

@@ -0,0 +1,22 @@
+import type { LoaderOptions } from '@loaders.gl/loader-utils';
+export type DataSourceProps = {
+    /** LoaderOptions provide an option to override `fetch`. Will also be passed to any sub loaders */
+    loadOptions?: LoaderOptions;
+};
+/** base class of all data sources */
+export declare abstract class DataSource {
+    /** A resolved fetch function extracted from loadOptions prop */
+    fetch: (url: string, options?: RequestInit) => Promise<Response>;
+    /** The actual load options, if calling a loaders.gl loader */
+    loadOptions: LoaderOptions;
+    constructor(props: DataSourceProps);
+}
+/**
+ * Gets the current fetch function from options
+ * @todo - move to loader-utils module
+ * @todo - use in core module counterpart
+ * @param options
+ * @param context
+ */
+export declare function getFetchFunction(options?: LoaderOptions): (url: string, fetchOptions?: RequestInit) => Promise<Response>;
+//# sourceMappingURL=data-source.d.ts.map

package/dist/lib/sources/data-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-source.d.ts","sourceRoot":"","sources":["../../../src/lib/sources/data-source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAE5D,MAAM,MAAM,eAAe,GAAG;IAC5B,kGAAkG;IAClG,WAAW,CAAC,EAAE,aAAa,CAAC;CAC7B,CAAC;AAEF,qCAAqC;AACrC,8BAAsB,UAAU;IAC9B,gEAAgE;IAChE,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjE,8DAA8D;IAC9D,WAAW,EAAE,aAAa,CAAC;gBAEf,KAAK,EAAE,eAAe;CAInC;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,aAAa,SAKvC,MAAM,iBAAiB,WAAW,uBAWlD"}

package/dist/lib/sources/data-source.js

@@ -0,0 +1,34 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFetchFunction = exports.DataSource = void 0;
+/** base class of all data sources */
+class DataSource {
+    constructor(props) {
+        this.loadOptions = { ...props.loadOptions };
+        this.fetch = getFetchFunction(this.loadOptions);
+    }
+}
+exports.DataSource = DataSource;
+/**
+ * Gets the current fetch function from options
+ * @todo - move to loader-utils module
+ * @todo - use in core module counterpart
+ * @param options
+ * @param context
+ */
+function getFetchFunction(options) {
+    const fetchFunction = options?.fetch;
+    // options.fetch can be a function
+    if (fetchFunction && typeof fetchFunction === 'function') {
+        return (url, fetchOptions) => fetchFunction(url, fetchOptions);
+    }
+    // options.fetch can be an options object, use global fetch with those options
+    const fetchOptions = options?.fetch;
+    if (fetchOptions && typeof fetchOptions !== 'function') {
+        return (url) => fetch(url, fetchOptions);
+    }
+    // else return the global fetch function
+    return (url) => fetch(url);
+}
+exports.getFetchFunction = getFetchFunction;

package/dist/lib/{data-sources → sources}/image-source.d.ts

@@ -1,4 +1,6 @@
 import type { ImageType } from '@loaders.gl/images';
+import type { DataSourceProps } from './data-source';
+import { DataSource } from './data-source';
 /**
  * Normalized capabilities of an Image service
  * @example
@@ -10,20 +12,14 @@ export type ImageSourceMetadata = {
     title?: string;
     abstract?: string;
     keywords: string[];
-    layer: {
-        name: string;
-        title?: string;
-        srs?: string[];
-        boundingBox?: [number, number, number, number];
-        layers: ImageSourceLayer[];
-    };
+    layers: ImageSourceLayer[];
 };
 export type ImageSourceLayer = {
-    name: string;
+    name?: string;
     title?: string;
     srs?: string[];
     boundingBox?: [number, number, number, number];
-    layers: ImageSourceLayer[];
+    layers?: ImageSourceLayer[];
 };
 export type GetImageParameters = {
     /** Layers to render */
@@ -61,12 +57,13 @@ export type ImageFormat = {
     /** requested format for the return image */
     format?: 'image/png';
 };
+export type ImageSourceProps = DataSourceProps;
 /**
  * MapImageSource - data sources that allow data to be queried by (geospatial) extents
  * @note
  * - If geospatial, bounding box is expected to be in web mercator coordinates
  */
-export declare abstract class ImageSource {
+export declare abstract class ImageSource extends DataSource {
     abstract getMetadata(): Promise<ImageSourceMetadata>;
     abstract getImage(parameters: GetImageParameters): Promise<ImageType>;
 }

package/dist/lib/sources/image-source.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-source.d.ts","sourceRoot":"","sources":["../../../src/lib/sources/image-source.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,eAAe,CAAC;AACnD,OAAO,EAAC,UAAU,EAAC,MAAM,eAAe,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,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,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,uBAAuB;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,8CAA8C;IAC9C,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG;IACzB,uBAAuB;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC1B,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,8CAA8C;IAC9C,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CACxC,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;IACd,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,eAAe,CAAC;AAE/C;;;;GAIG;AACH,8BAAsB,WAAY,SAAQ,UAAU;IAClD,QAAQ,CAAC,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IACpD,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;CACtE"}

package/dist/lib/{data-sources → sources}/image-source.js

@@ -2,11 +2,12 @@
 // loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ImageSource = void 0;
+const data_source_1 = require("./data-source");
 /**
  * MapImageSource - data sources that allow data to be queried by (geospatial) extents
  * @note
  * - If geospatial, bounding box is expected to be in web mercator coordinates
  */
-class ImageSource {
+class ImageSource extends data_source_1.DataSource {
 }
 exports.ImageSource = ImageSource;