@loaders.gl/wms 3.3.2 → 3.4.0-alpha.2

package/dist/lib/services/ogc/csw-service.d.ts

@@ -0,0 +1,115 @@
+import type { DataSourceProps } from '../../sources/data-source';
+import { DataSource } from '../../sources/data-source';
+import type { CSWCapabilities } from '../../../csw-capabilities-loader';
+import type { CSWRecords } from '../../../csw-records-loader';
+import type { CSWDomain } from '../../../csw-domain-loader';
+type CSWCommonParameters = {
+    /** In case the endpoint supports multiple services */
+    service?: 'CSW';
+    /** In case the endpoint supports multiple CSW versions */
+    version?: '1.1.1' | '2.0.0' | '2.0.1' | '3.0.0' | '3.0.0';
+};
+export type CSWGetCapabilitiesParameters = CSWCommonParameters & {
+    /** Request type */
+    request?: 'GetCapabilities';
+};
+export type CSWGetRecordsParameters = CSWCommonParameters & {
+    /** Request type */
+    request?: 'GetRecords';
+    /** type of records */
+    typenames: 'csw:Record';
+};
+export type CSWGetDomainParameters = CSWCommonParameters & {
+    /** Request type */
+    request?: 'GetDomain';
+};
+export type Service = {
+    name: string;
+    type: string;
+    url: string;
+    params?: string;
+    scheme?: string;
+};
+export type CSWServiceProps = DataSourceProps & {
+    url: string;
+};
+/**
+ * The CSWService class provides
+ * - provides type safe methods to form URLs to a CSW service
+ * - provides type safe methods to query and parse results (and errors) from a CSW service
+ * - implements the ImageService interface
+ * @note Only the URL parameter conversion is supported. XML posts are not supported.
+ */
+export declare class CSWService extends DataSource {
+    static type: 'csw';
+    static testURL: (url: string) => boolean;
+    props: CSWServiceProps;
+    capabilities: CSWCapabilities | null;
+    /** A list of loaders used by the CSWService methods */
+    readonly loaders: ({
+        /** In case the endpoint supports multiple CSW versions */
+        id: string;
+        name: string;
+        module: string;
+        version: any;
+        worker: boolean;
+        extensions: string[];
+        mimeTypes: string[];
+        testText: (text: string) => boolean;
+        options: {
+            csw: {};
+        };
+        parse: (arrayBuffer: ArrayBuffer, options?: import("../../../csw-capabilities-loader").CSWLoaderOptions | undefined) => Promise<CSWCapabilities>;
+        parseTextSync: (text: string, options?: import("../../../csw-capabilities-loader").CSWLoaderOptions | undefined) => CSWCapabilities;
+    } | {
+        id: string;
+        name: string;
+        module: string;
+        version: any;
+        worker: boolean;
+        extensions: string[];
+        mimeTypes: string[];
+        testText: (text: string) => boolean;
+        options: {
+            wms: {
+                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;
+    })[];
+    /** Create a CSWService */
+    constructor(props: CSWServiceProps);
+    getMetadata(): Promise<CSWCapabilities>;
+    normalizeMetadata(capabilities: CSWCapabilities): CSWCapabilities;
+    getServiceDirectory(options: {
+        includeUnknown?: boolean;
+    }): Promise<Service[]>;
+    _parseOGCUrl(url: string): {
+        url: string;
+        params: string;
+    };
+    /** Get Capabilities */
+    getCapabilities(wmsParameters?: CSWGetCapabilitiesParameters, vendorParameters?: Record<string, unknown>): Promise<CSWCapabilities>;
+    /** Get Records */
+    getRecords(wmsParameters?: CSWGetRecordsParameters, vendorParameters?: Record<string, unknown>): Promise<CSWRecords>;
+    /** Get Domain */
+    getDomain(wmsParameters?: CSWGetDomainParameters, vendorParameters?: Record<string, unknown>): Promise<CSWDomain>;
+    /** Generate a URL for the GetCapabilities request */
+    getCapabilitiesURL(wmsParameters?: CSWGetCapabilitiesParameters, vendorParameters?: Record<string, unknown>): string;
+    /** Generate a URL for the GetCapabilities request */
+    getRecordsURL(wmsParameters?: CSWGetRecordsParameters, vendorParameters?: Record<string, unknown>): string;
+    /** Generate a URL for the GetCapabilities request */
+    getDomainURL(wmsParameters?: CSWGetDomainParameters, vendorParameters?: Record<string, unknown>): string;
+    /**
+     * @note case _getCSWUrl may need to be overridden to handle certain backends?
+     * */
+    protected _getCSWUrl(options: Record<string, unknown>, vendorParameters?: Record<string, unknown>): string;
+    /** Checks for and parses a CSW XML formatted ServiceError and throws an exception */
+    protected _checkResponse(response: Response, arrayBuffer: ArrayBuffer): void;
+    /** Error situation detected */
+    protected _parseError(arrayBuffer: ArrayBuffer): Error;
+}
+export {};
+//# sourceMappingURL=csw-service.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"csw-service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/ogc/csw-service.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAC,UAAU,EAAC,MAAM,2BAA2B,CAAC;AAErD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,kCAAkC,CAAC;AAGtE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,6BAA6B,CAAC;AAG5D,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,4BAA4B,CAAC;AAK1D,KAAK,mBAAmB,GAAG;IACzB,sDAAsD;IACtD,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CAC3D,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,GAAG;IAC/D,mBAAmB;IACnB,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,GAAG;IAC1D,mBAAmB;IACnB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,sBAAsB;IACtB,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IACzD,mBAAmB;IACnB,OAAO,CAAC,EAAE,WAAW,CAAC;CAEvB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAElG,MAAM,MAAM,eAAe,GAAG,eAAe,GAAG;IAC9C,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,UAAU;IACxC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAS;IAC3B,MAAM,CAAC,OAAO,QAAS,MAAM,KAAG,OAAO,CAAsC;IAE7E,KAAK,EAAE,eAAe,CAAC;IACvB,YAAY,EAAE,eAAe,GAAG,IAAI,CAAQ;IAE5C,uDAAuD;IACvD,QAAQ,CAAC,OAAO;QA3ChB,0DAA0D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SA2CC;IAE3D,0BAA0B;gBACd,KAAK,EAAE,eAAe;IAK5B,WAAW,IAAI,OAAO,CAAC,eAAe,CAAC;IAK7C,iBAAiB,CAAC,YAAY,EAAE,eAAe,GAAG,eAAe;IAI3D,mBAAmB,CAAC,OAAO,EAAE;QAAC,cAAc,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAoClF,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC;IAUxD,uBAAuB;IACjB,eAAe,CACnB,aAAa,CAAC,EAAE,4BAA4B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,eAAe,CAAC;IAS3B,kBAAkB;IACZ,UAAU,CACd,aAAa,CAAC,EAAE,uBAAuB,EACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,UAAU,CAAC;IAQtB,iBAAiB;IACX,SAAS,CACb,aAAa,CAAC,EAAE,sBAAsB,EACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,SAAS,CAAC;IAWrB,qDAAqD;IACrD,kBAAkB,CAChB,aAAa,CAAC,EAAE,4BAA4B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAWT,qDAAqD;IACrD,aAAa,CACX,aAAa,CAAC,EAAE,uBAAuB,EACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAYT,qDAAqD;IACrD,YAAY,CACV,aAAa,CAAC,EAAE,sBAAsB,EACtC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAaT;;SAEK;IACL,SAAS,CAAC,UAAU,CAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAeT,qFAAqF;IACrF,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,EAAE,WAAW,EAAE,WAAW,GAAG,IAAI;IAQ5E,+BAA+B;IAC/B,SAAS,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,GAAG,KAAK;CAIvD"}

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

@@ -0,0 +1,170 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CSWService = void 0;
+const data_source_1 = require("../../sources/data-source");
+const csw_capabilities_loader_1 = require("../../../csw-capabilities-loader");
+const csw_records_loader_1 = require("../../../csw-records-loader");
+const csw_domain_loader_1 = require("../../../csw-domain-loader");
+const wms_error_loader_1 = require("../../../wms-error-loader");
+/**
+ * The CSWService class provides
+ * - provides type safe methods to form URLs to a CSW service
+ * - provides type safe methods to query and parse results (and errors) from a CSW service
+ * - implements the ImageService interface
+ * @note Only the URL parameter conversion is supported. XML posts are not supported.
+ */
+class CSWService extends data_source_1.DataSource {
+    /** Create a CSWService */
+    constructor(props) {
+        super(props);
+        this.capabilities = null;
+        /** A list of loaders used by the CSWService methods */
+        this.loaders = [wms_error_loader_1.WMSErrorLoader, csw_capabilities_loader_1.CSWCapabilitiesLoader];
+        this.props = props;
+    }
+    async getMetadata() {
+        const capabilities = await this.getCapabilities();
+        return this.normalizeMetadata(capabilities);
+    }
+    normalizeMetadata(capabilities) {
+        return capabilities;
+    }
+    async getServiceDirectory(options) {
+        const services = [];
+        const unknownServices = [];
+        const records = await this.getRecords();
+        for (const record of records.records) {
+            for (const reference of record.references) {
+                const url = reference.value;
+                switch (reference.scheme) {
+                    case 'OGC:WMS':
+                        services.push({ name: record.title, type: 'ogc-wms-service', ...this._parseOGCUrl(url) });
+                        break;
+                    case 'OGC:WMTS':
+                        services.push({
+                            name: record.title,
+                            type: 'ogc-wmts-service',
+                            ...this._parseOGCUrl(url)
+                        });
+                        break;
+                    case 'OGC:WFS':
+                        services.push({ name: record.title, type: 'ogc-wfs-service', ...this._parseOGCUrl(url) });
+                        break;
+                    default:
+                        unknownServices.push({
+                            name: record.title,
+                            type: 'unknown',
+                            url: reference.value,
+                            scheme: reference.scheme
+                        });
+                }
+            }
+        }
+        return options?.includeUnknown ? services.concat(unknownServices) : services;
+    }
+    _parseOGCUrl(url) {
+        const parts = url.split('?');
+        return {
+            url: parts[0],
+            params: parts[1] || ''
+        };
+    }
+    // CSW 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 csw_capabilities_loader_1.CSWCapabilitiesLoader.parse(arrayBuffer, this.props.loadOptions);
+        return capabilities;
+    }
+    /** Get Records */
+    async getRecords(wmsParameters, vendorParameters) {
+        const url = this.getRecordsURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return await csw_records_loader_1.CSWRecordsLoader.parse(arrayBuffer, this.props.loadOptions);
+    }
+    /** Get Domain */
+    async getDomain(wmsParameters, vendorParameters) {
+        const url = this.getDomainURL(wmsParameters, vendorParameters);
+        const response = await this.fetch(url);
+        const arrayBuffer = await response.arrayBuffer();
+        this._checkResponse(response, arrayBuffer);
+        return await csw_domain_loader_1.CSWDomainLoader.parse(arrayBuffer, this.props.loadOptions);
+    }
+    // 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: '3.0.0',
+            ...wmsParameters,
+            ...vendorParameters,
+            service: 'CSW',
+            request: 'GetCapabilities'
+        };
+        return this._getCSWUrl(options, vendorParameters);
+    }
+    /** Generate a URL for the GetCapabilities request */
+    getRecordsURL(wmsParameters, vendorParameters) {
+        const options = {
+            version: '3.0.0',
+            typenames: 'csw:Record',
+            ...wmsParameters,
+            ...vendorParameters,
+            service: 'CSW',
+            request: 'GetRecords'
+        };
+        return this._getCSWUrl(options, vendorParameters);
+    }
+    /** Generate a URL for the GetCapabilities request */
+    getDomainURL(wmsParameters, vendorParameters) {
+        const options = {
+            version: '3.0.0',
+            ...wmsParameters,
+            ...vendorParameters,
+            service: 'CSW',
+            request: 'GetDomain'
+        };
+        return this._getCSWUrl(options, vendorParameters);
+    }
+    // INTERNAL METHODS
+    /**
+     * @note case _getCSWUrl may need to be overridden to handle certain backends?
+     * */
+    _getCSWUrl(options, vendorParameters) {
+        let url = this.props.url;
+        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 CSW 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.props.loadOptions);
+            throw new Error(error);
+        }
+    }
+    /** Error situation detected */
+    _parseError(arrayBuffer) {
+        const error = wms_error_loader_1.WMSErrorLoader.parseSync(arrayBuffer, this.props.loadOptions);
+        return new Error(error);
+    }
+}
+exports.CSWService = CSWService;
+CSWService.type = 'csw';
+CSWService.testURL = (url) => url.toLowerCase().includes('csw');

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

@@ -1,8 +1,11 @@
 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';
 type WMSCommonParameters = {
     /** In case the endpoint supports multiple services */
     service?: 'WMS';
@@ -40,7 +43,7 @@ export type WMSGetFeatureInfoParameters = WMSCommonParameters & {
     y: number;
     /** list of layers to query (could be different from rendered layers) */
     query_layers: string[];
-    /** MIME type of returned feature info */
+    /** Requested MIME type of returned feature info */
     info_format?: 'text/plain' | 'application/vnd.ogc.gml';
     /** Layers to render */
     layers: string[];
@@ -65,6 +68,23 @@ export type WMSGetLegendGraphicParameters = WMSCommonParameters & {
     /** Request type */
     request?: 'GetLegendGraphic';
 };
+/** Properties for initializing a WMS service */
+export type WMSServiceProps = ImageSourceProps & {
+    /** Base URL to the service */
+    url: string;
+    /** WMS version */
+    version?: '1.1.1' | '1.3.0';
+    /** Layers to render */
+    layers?: string[];
+    /** SRS for the image (not the bounding box) */
+    srs?: string;
+    /** Requested format for the return image */
+    format?: 'image/png';
+    /** Requested MIME type of returned feature info */
+    info_format?: 'text/plain' | 'application/vnd.ogc.gml';
+    /** Styling */
+    styles?: unknown;
+};
 /**
  * The WMSService class provides
  * - provides type safe methods to form URLs to a WMS service
@@ -75,8 +95,7 @@ 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>;
+    props: Required<WMSServiceProps>;
     capabilities: WMSCapabilities | null;
     /** A list of loaders used by the WMSService methods */
     readonly loaders: ({
@@ -93,9 +112,9 @@ 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>;
+        parseSync: (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions | undefined) => string;
+        parseTextSync: (text: string, options?: WMSLoaderOptions | undefined) => string;
     } | {
         id: string;
         name: string;
@@ -108,19 +127,8 @@ 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;
@@ -149,11 +157,22 @@ export declare class WMSService extends ImageSource {
         options: {
             wms: {};
         };
+    } | {
+        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;
     })[];
     /** 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 */

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,KAAK,mBAAmB,GAAG;IACzB,sDAAsD;IACtD,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,mBAAmB,GAAG;IAC/D,mBAAmB;IACnB,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,GAAG;IACtD,mBAAmB;IACnB,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,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,2BAA2B,GAAG,mBAAmB,GAAG;IAC9D,mBAAmB;IACnB,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAE3B,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,yBAAyB,CAAC;IAEvD,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,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,GAAG;IAC7D,mBAAmB;IACnB,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,mBAAmB,GAAG;IAChE,mBAAmB;IACnB,OAAO,CAAC,EAAE,kBAAkB,CAAC;CAC9B,CAAC;AAEF,gDAAgD;AAChD,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAC/C,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC5B,uBAAuB;IACvB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,+CAA+C;IAC/C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,mDAAmD;IACnD,WAAW,CAAC,EAAE,YAAY,GAAG,yBAAyB,CAAC;IACvD,cAAc;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,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,KAAK,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IACjC,YAAY,EAAE,eAAe,GAAG,IAAI,CAAQ;IAE5C,uDAAuD;IACvD,QAAQ,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAMd;IAEF,0BAA0B;gBACd,KAAK,EAAE,eAAe;IAmB5B,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAK3C,QAAQ,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAIlE,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,OAAO,EAAE,mBAAmB,EAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,SAAS,CAAC;IAYrB,wCAAwC;IAClC,cAAc,CAClB,OAAO,EAAE,2BAA2B,EACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,cAAc,CAAC;IAQ1B,wCAAwC;IAClC,kBAAkB,CACtB,OAAO,EAAE,2BAA2B,EACpC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,MAAM,CAAC;IAQlB,yCAAyC;IACnC,aAAa,CACjB,OAAO,EAAE,0BAA0B,EACnC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAQ/B,0CAA0C;IACpC,gBAAgB,CACpB,OAAO,EAAE,6BAA6B,EACtC,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;IAWT,4CAA4C;IAC5C,SAAS,CACP,aAAa,EAAE,mBAAmB,EAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAkBT,oDAAoD;IACpD,iBAAiB,CACf,aAAa,EAAE,2BAA2B,EAC1C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAsBT,oDAAoD;IACpD,gBAAgB,CACd,aAAa,EAAE,0BAA0B,EACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAWT,mBAAmB,CACjB,aAAa,EAAE,6BAA6B,EAC5C,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAcT;;SAEK;IACL,SAAS,CAAC,UAAU,CAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,MAAM;IAeT,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/{data-sources/image-services → services/ogc}/wms-service.js

@@ -3,8 +3,8 @@
 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 image_service_1 = require("./image-service");
+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");
@@ -19,7 +19,7 @@ const wms_error_loader_1 = require("../../../wms-error-loader");
 class WMSService extends image_source_1.ImageSource {
     /** Create a WMSService */
     constructor(props) {
-        super();
+        super(props);
         this.capabilities = null;
         /** A list of loaders used by the WMSService methods */
         this.loaders = [
@@ -29,20 +29,29 @@ class WMSService extends image_source_1.ImageSource {
             wms_feature_info_loader_1.WMSFeatureInfoLoader,
             wms_layer_description_loader_1.WMSLayerDescriptionLoader
         ];
-        this.props = (0, image_service_1.mergeImageServiceProps)(props);
-        this.fetch = (0, image_service_1.getFetchFunction)(this.props);
-        this.props.loadOptions = {
-            ...this.props.loadOptions,
-            // We want error responses to throw exceptions, the WMSErrorLoader can do this
-            wms: { ...this.props.loadOptions?.wms, throwOnError: true }
+        // 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.
+        this.props = {
+            loadOptions: undefined,
+            layers: undefined,
+            styles: undefined,
+            version: '1.1.1',
+            srs: 'EPSG:4326',
+            format: 'image/png',
+            info_format: 'text/plain',
+            ...props
         };
     }
     // ImageSource implementation
-    getMetadata() {
-        return this.getCapabilities();
+    async getMetadata() {
+        const capabilities = await this.getCapabilities();
+        return this.normalizeMetadata(capabilities);
     }
-    getImage(parameters) {
-        return this.getMap(parameters);
+    async getImage(parameters) {
+        return await this.getMap(parameters);
+    }
+    normalizeMetadata(capabilities) {
+        return capabilities;
     }
     // WMS Service API Stubs
     /** Get Capabilities */
@@ -78,7 +87,6 @@ class WMSService extends image_source_1.ImageSource {
     }
     /** Get Feature Info for a coordinate */
     async getFeatureInfoText(options, vendorParameters) {
-        options = { ...options, info_format: 'text/plain' };
         const url = this.getFeatureInfoURL(options, vendorParameters);
         const response = await this.fetch(url);
         const arrayBuffer = await response.arrayBuffer();
@@ -112,7 +120,7 @@ class WMSService extends image_source_1.ImageSource {
     getCapabilitiesURL(wmsParameters, vendorParameters) {
         const options = {
             service: 'WMS',
-            version: '1.1.1',
+            version: this.props.version,
             request: 'GetCapabilities',
             ...wmsParameters,
             ...vendorParameters
@@ -123,15 +131,15 @@ class WMSService extends image_source_1.ImageSource {
     getMapURL(wmsParameters, vendorParameters) {
         const options = {
             service: 'WMS',
-            version: '1.1.1',
+            version: this.props.version,
             request: 'GetMap',
             // layers: [],
             // bbox: [-77.87304, 40.78975, -77.85828, 40.80228],
             // width: 1200,
             // height: 900,
-            styles: undefined,
-            srs: 'EPSG:4326',
-            format: 'image/png',
+            styles: this.props.styles,
+            srs: this.props.srs,
+            format: this.props.format,
             ...wmsParameters,
             ...vendorParameters
         };
@@ -141,19 +149,19 @@ class WMSService extends image_source_1.ImageSource {
     getFeatureInfoURL(wmsParameters, vendorParameters) {
         const options = {
             service: 'WMS',
-            version: '1.1.1',
+            version: this.props.version,
             request: 'GetFeatureInfo',
-            // layers: [],
+            // layers: this.props.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,
+            srs: this.props.srs,
+            format: this.props.format,
+            info_format: this.props.info_format,
+            styles: this.props.styles,
             ...wmsParameters,
             ...vendorParameters
         };
@@ -163,7 +171,7 @@ class WMSService extends image_source_1.ImageSource {
     describeLayerURL(wmsParameters, vendorParameters) {
         const options = {
             service: 'WMS',
-            version: '1.1.1',
+            version: this.props.version,
             request: 'DescribeLayer',
             ...wmsParameters,
             ...vendorParameters
@@ -173,8 +181,9 @@ class WMSService extends image_source_1.ImageSource {
     getLegendGraphicURL(wmsParameters, vendorParameters) {
         const options = {
             service: 'WMS',
-            version: '1.1.1',
+            version: this.props.version,
             request: 'GetLegendGraphic',
+            // format?
             ...wmsParameters,
             ...vendorParameters
         };
@@ -203,7 +212,11 @@ class WMSService extends image_source_1.ImageSource {
     _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.props.loadOptions);
+            // We want error responses to throw exceptions, the WMSErrorLoader can do this
+            const loadOptions = (0, loader_utils_1.mergeLoaderOptions)(this.props.loadOptions, {
+                wms: { throwOnError: true }
+            });
+            const error = wms_error_loader_1.WMSErrorLoader.parseSync(arrayBuffer, loadOptions);
             throw new Error(error);
         }
     }

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
@@ -61,12 +63,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>;
 }