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

package/dist/lib/{data-sources → services/arcgis}/arcgis-image-service.js

@@ -1,18 +1,21 @@
 "use strict";
 // loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArcGISImageService = void 0;
-const image_source_1 = require("./image-source");
-class ArcGISImageService extends image_source_1.ImageSource {
+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();
-        this.url = props.url;
-        this.loadOptions = props.loadOptions || {};
-        this.fetch = props.fetch || fetch;
+        super(props);
+        this.props = props;
     }
     // ImageSource (normalized endpoints)
     async getMetadata() {
-        return (await this.info());
+        return (await this.metadata());
         // TODO - normalize metadata
     }
     async getImage(parameters) {
@@ -21,7 +24,7 @@ class ArcGISImageService extends image_source_1.ImageSource {
         // return await this.exportImage(parameters);
     }
     // ImageServer endpoints
-    async info() {
+    async metadata() {
         // We just need a JSON parsing...
         // return this.getUrl({path: '', ...options});
         throw new Error('not implemented');
@@ -35,28 +38,35 @@ class ArcGISImageService extends image_source_1.ImageSource {
         throw new Error('not implemented');
     }
     // URL creators
-    infoURL(options) {
-        return this.url;
-        // return this.getUrl({path: '', ...options});
+    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`,
+     // 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 {boundingBox} = options;
-        // const bbox = `bbox=${boundingBox[0]},${boundingBox[1]},${boundingBox[2]},${boundingBox[3]}`;
-        // const size = `size=${width},${height}`;
-        // return this.getUrl({path: 'exportImage'});
-        return this.url;
+        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(options, extra) {
-        let url = `${this.url}`;
+    getUrl(path, options, extra) {
+        let url = `${this.props.url}/${path}`;
         let first = true;
         for (const [key, value] of Object.entries(options)) {
             url += first ? '?' : '&';
@@ -80,6 +90,6 @@ class ArcGISImageService extends image_source_1.ImageSource {
         }
     }
 }
-exports.ArcGISImageService = ArcGISImageService;
-ArcGISImageService.type = 'arcgis-image-server';
-ArcGISImageService.testURL = (url) => url.toLowerCase().includes('ImageServer');
+ArcGISImageServer.type = 'arcgis-image-server';
+ArcGISImageServer.testURL = (url) => url.toLowerCase().includes('ImageServer');
+exports.ArcGISImageServer = ArcGISImageServer;

package/dist/lib/services/arcgis/arcgis-server.d.ts

@@ -0,0 +1,15 @@
+export type Service = {
+    name: string;
+    type: string;
+    url: string;
+};
+type FetchLike = typeof fetch;
+/**
+ * (Recursively) load the service directory from an ArcGIS Server URL
+ * @param url
+ * @param fetchFile= Optional fetch function override
+ * @returns
+ */
+export declare function getArcGISServices(url: string, fetchFile?: FetchLike): Promise<Service[] | null>;
+export {};
+//# sourceMappingURL=arcgis-server.d.ts.map

package/dist/lib/services/arcgis/arcgis-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arcgis-server.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/arcgis/arcgis-server.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,OAAO,GAAG;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAC,CAAC;AAEhE,KAAK,SAAS,GAAG,OAAO,KAAK,CAAC;AAE9B;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,GAAG,EAAE,MAAM,EACX,SAAS,GAAE,SAAiB,GAC3B,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAM3B"}

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

@@ -0,0 +1,42 @@
+"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/{data-sources/image-services → services/generic}/image-service.d.ts

@@ -1,7 +1,7 @@
 import { LoaderOptions } from '@loaders.gl/loader-utils';
 import type { ImageType } from '@loaders.gl/images';
-import type { ImageSourceMetadata, GetImageParameters } from '../image-source';
-import { ImageSource } from '../image-source';
+import type { ImageSourceMetadata, GetImageParameters } from '../../sources/image-source';
+import { ImageSource } from '../../sources/image-source';
 /** Template URL string should contain `${width}` etc which will be substituted. */
 export type ImageServiceProps = {
     /** Base URL to the service */
@@ -17,8 +17,7 @@ export type ImageServiceProps = {
 export declare class ImageService extends ImageSource {
     static type: 'template';
     static testURL: (url: string) => boolean;
-    props: Required<ImageServiceProps>;
-    fetch: (url: string, options?: RequestInit) => Promise<Response>;
+    props: ImageServiceProps;
     constructor(props: ImageServiceProps);
     getMetadata(): Promise<ImageSourceMetadata>;
     getImage(parameters: GetImageParameters): Promise<ImageType>;
@@ -27,13 +26,4 @@ export declare class ImageService extends ImageSource {
     /** Supports both ${} and {} notations */
     protected getURLFromTemplate(parameters: Record<string, unknown>): string;
 }
-/**
- * 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>;
-export declare function mergeImageServiceProps(props: ImageServiceProps): Required<ImageServiceProps>;
 //# sourceMappingURL=image-service.d.ts.map

package/dist/lib/services/generic/image-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/generic/image-service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,aAAa,EAAC,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,oBAAoB,CAAC;AAGlD,OAAO,KAAK,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,4BAA4B,CAAC;AACxF,OAAO,EAAC,WAAW,EAAC,MAAM,4BAA4B,CAAC;AAEvD,mFAAmF;AACnF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,gFAAgF;IAChF,WAAW,CAAC,EAAE,aAAa,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C,MAAM,CAAC,IAAI,EAAE,UAAU,CAAc;IACrC,MAAM,CAAC,OAAO,QAAS,MAAM,KAAG,OAAO,CAAoC;IAE3E,KAAK,EAAE,iBAAiB,CAAC;gBAEb,KAAK,EAAE,iBAAiB;IAO9B,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAI3C,QAAQ,CAAC,UAAU,EAAE,kBAAkB,GAAG,OAAO,CAAC,SAAS,CAAC;IAUlE,wDAAwD;IACxD,SAAS,CAAC,qBAAqB,CAAC,UAAU,EAAE,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKxF,yCAAyC;IACzC,SAAS,CAAC,kBAAkB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;CAU1E"}

package/dist/lib/{data-sources/adhoc-image-service.js → services/generic/image-service.js}

@@ -1,18 +1,18 @@
 "use strict";
 // loaders.gl, MIT license
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdHocImageService = void 0;
+exports.ImageService = void 0;
 const images_1 = require("@loaders.gl/images");
-const image_source_1 = require("./image-source");
+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 AdHocImageService extends image_source_1.ImageSource {
+class ImageService extends image_source_1.ImageSource {
     constructor(props) {
-        super();
-        this.templateUrl = props.templateUrl;
+        super(props);
+        this.props = props;
     }
     // IMAGE SOURCE API
     async getMetadata() {
@@ -21,7 +21,7 @@ class AdHocImageService extends image_source_1.ImageSource {
     async getImage(parameters) {
         const granularParameters = this.getGranularParameters(parameters);
         const url = this.getURLFromTemplate(granularParameters);
-        const response = await fetch(url);
+        const response = await this.fetch(url);
         const arrayBuffer = await response.arrayBuffer();
         return await images_1.ImageLoader.parse(arrayBuffer);
     }
@@ -31,16 +31,18 @@ class AdHocImageService extends image_source_1.ImageSource {
         const [east, north, west, south] = parameters.bbox;
         return { ...parameters, east, north, south, west };
     }
+    /** Supports both ${} and {} notations */
     getURLFromTemplate(parameters) {
-        let url = this.templateUrl;
+        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.AdHocImageService = AdHocImageService;
-AdHocImageService.type = 'template';
-AdHocImageService.testURL = (url) => url.toLowerCase().includes('{');
+ImageService.type = 'template';
+ImageService.testURL = (url) => url.toLowerCase().includes('{');
+exports.ImageService = ImageService;

package/dist/lib/services/generic/tile-service.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=tile-service.d.ts.map

package/dist/lib/services/generic/tile-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tile-service.d.ts","sourceRoot":"","sources":["../../../../src/lib/services/generic/tile-service.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1 @@
+"use strict";

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,CAAC,EAAE;QAAC,cAAc,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAoCnF,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);
+    }
+}
+CSWService.type = 'csw';
+CSWService.testURL = (url) => url.toLowerCase().includes('csw');
+exports.CSWService = CSWService;