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

package/src/lib/data-sources/image-services/image-service.ts

@@ -1,105 +0,0 @@
-// loaders.gl, MIT license
-
-import {LoaderOptions} from '@loaders.gl/loader-utils';
-import type {ImageType} from '@loaders.gl/images';
-import {ImageLoader} from '@loaders.gl/images';
-
-import type {ImageSourceMetadata, GetImageParameters} from '../image-source';
-import {ImageSource} from '../image-source';
-
-/** Template URL string should contain `${width}` etc which will be substituted. */
-export type ImageServiceProps = {
-  /** Base URL to the service */
-  url: string;
-  /** Any load options to the loaders.gl Loaders used by the WMSService methods */
-  loadOptions?: LoaderOptions;
-};
-
-/**
- * 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
- */
-export class ImageService extends ImageSource {
-  static type: 'template' = 'template';
-  static testURL = (url: string): boolean => url.toLowerCase().includes('{');
-
-  props: Required<ImageServiceProps>;
-  fetch: (url: string, options?: RequestInit) => Promise<Response>;
-
-  constructor(props: ImageServiceProps) {
-    super();
-    this.props = mergeImageServiceProps(props);
-    this.fetch = getFetchFunction(props);
-  }
-
-  // IMAGE SOURCE API
-
-  async getMetadata(): Promise<ImageSourceMetadata> {
-    throw new Error('ImageSource.getMetadata not implemented');
-  }
-
-  async getImage(parameters: GetImageParameters): Promise<ImageType> {
-    const granularParameters = this.getGranularParameters(parameters);
-    const url = this.getURLFromTemplate(granularParameters);
-    const response = await this.fetch(url);
-    const arrayBuffer = await response.arrayBuffer();
-    return await ImageLoader.parse(arrayBuffer);
-  }
-
-  // HELPERS
-
-  /** Break up bounding box in east, north, south, west */
-  protected getGranularParameters(parameters: GetImageParameters): Record<string, unknown> {
-    const [east, north, west, south] = parameters.bbox;
-    return {...parameters, east, north, south, west};
-  }
-
-  /** Supports both ${} and {} notations */
-  protected getURLFromTemplate(parameters: Record<string, unknown>): string {
-    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;
-  }
-}
-
-/**
- * Gets the current fetch function from options
- * @todo - move to loader-utils module
- * @todo - use in core module counterpart
- * @param options
- * @param context
- */
-export function getFetchFunction(options?: LoaderOptions) {
-  const fetchFunction = options?.fetch;
-
-  // options.fetch can be a function
-  if (fetchFunction && typeof fetchFunction === 'function') {
-    return (url: string, fetchOptions?: RequestInit) => 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);
-}
-
-export function mergeImageServiceProps(props: ImageServiceProps): Required<ImageServiceProps> {
-  return {
-    // Default fetch
-    ...props,
-    loadOptions: {
-      ...props.loadOptions,
-      fetch: getFetchFunction(props.loadOptions)
-    }
-  };
-}

package/src/lib/wcs/parse-wcs.ts

@@ -1,39 +0,0 @@
-// loaders.gl, MIT license
-
-import type {WFSCapabilities} from './wcs-types';
-
-import {XMLLoader} from '@loaders.gl/xml';
-
-// GetCapabilities
-
-/**
- * Parses a typed data structure from raw XML for `GetCapabilities` response
- * @note Error handlings is fairly weak
- */
-export function parseWFSCapabilities(text: string, options): WFSCapabilities {
-  // Remove namespaces in XML
-  options = {...options, xml: {...options?.xml, removeNSPrefix: true}};
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  const xmlCapabilities: any = parsedXML.Capabilities || parsedXML;
-  return uncapitalizeKeys(xmlCapabilities);
-}
-
-function uncapitalizeKeys(object: any): any {
-  if (object && typeof object === 'object') {
-    const newObject = {};
-    for (const [key, value] of Object.entries(object)) {
-      newObject[uncapitalize(key)] = uncapitalizeKeys(value);
-    }
-    return newObject;
-  }
-  return object;
-}
-
-/**
- * Uncapitalize first letter of a string
- * @param {string} str
- * @returns {string}
- */
-function uncapitalize(str: string): string {
-  return typeof str === 'string' ? str.charAt(0).toLowerCase() + str.slice(1) : str;
-}

package/src/lib/wfs/parse-wfs.ts

@@ -1,39 +0,0 @@
-// loaders.gl, MIT license
-
-import type {WFSCapabilities} from './wfs-types';
-
-import {XMLLoader} from '@loaders.gl/xml';
-
-// GetCapabilities
-
-/**
- * Parses a typed data structure from raw XML for `GetCapabilities` response
- * @note Error handlings is fairly weak
- */
-export function parseWFSCapabilities(text: string, options): WFSCapabilities {
-  // Remove namespaces in XML
-  options = {...options, xml: {...options?.xml, removeNSPrefix: true}};
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  const xmlCapabilities: any = parsedXML.Capabilities || parsedXML;
-  return uncapitalizeKeys(xmlCapabilities);
-}
-
-function uncapitalizeKeys(object: any): any {
-  if (object && typeof object === 'object') {
-    const newObject = {};
-    for (const [key, value] of Object.entries(object)) {
-      newObject[uncapitalize(key)] = uncapitalizeKeys(value);
-    }
-    return newObject;
-  }
-  return object;
-}
-
-/**
- * Uncapitalize first letter of a string
- * @param {string} str
- * @returns {string}
- */
-function uncapitalize(str: string): string {
-  return typeof str === 'string' ? str.charAt(0).toLowerCase() + str.slice(1) : str;
-}

package/src/lib/wfs/wfs-types.ts

@@ -1,78 +0,0 @@
-// loaders.gl, MIT licenses
-
-/** All capabilities of a WFS service - response to a WFS `GetCapabilities` data structure extracted from XML */
-export type WFSCapabilities = {
-    serviceIdentification: {
-      title: string;
-      serviceTypeVersion: string;
-      serviceType: string;
-    };
-  
-    serviceProvider: {
-      providerName: string;
-      providerSite: string;
-      serviceContact: {
-        individualName: string;
-        positionName: string;
-        contactInfo: {
-          address: {
-            administrativeArea: string;
-            city: string;
-            country: string;
-            deliveryPoint: string;
-            electronicMailAddress: string;
-            postalCode: string;
-          };
-          phone: {
-            voice: string;
-          };
-        };
-      };
-    };
-  
-    operationsMetadata: {
-      GetCapabilities: any;
-      GetFeatureInfo: any;
-      GetTile: any;
-    };
-  
-    contents: {
-      layers: {
-        abstract: string;
-        identifier: string;
-        title: string;
-        formats: string[];
-        styles: {
-          identifier: string;
-          isDefault: string;
-          title: string;
-          abstract?: string;
-        }[];
-        bounds: {
-          left: number;
-          right: number;
-          bottom: number;
-          top: number;
-        };
-        tileMatrixSetLinks: {
-          tileMatrixSet: string;
-        }[];
-        tileMatrixSets: {
-          identifier: string;
-          matrixIds: {
-            identifier: string;
-            matrixHeight: number;
-            matrixWidth: number;
-            scaleDenominator: number;
-            tileWidth: number;
-            tileHeight: number;
-            topLeftCorner: {
-              lon: number;
-              lat: number;
-            };
-          }[];
-        };
-      }[];
-    };
-  };
-  

package/src/lib/wms/parse-wms.ts

@@ -1,142 +0,0 @@
-// loaders.gl, MIT license
-
-import type {
-  WMSCapabilities,
-  WMSLayer,
-  WMSRequest,
-  WMSFeatureInfo,
-  WMSLayerDescription
-  // WMSFeature,
-  // WMSLayerDescription
-} from './wms-types';
-
-import {XMLLoader} from '@loaders.gl/xml';
-
-// GetCapabilities
-
-/**
- * Parses a typed data structure from raw XML for `GetCapabilities` response
- * @note Error handlings is fairly weak
- */
-export function parseWMSCapabilities(text: string, options): WMSCapabilities {
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  const xmlCapabilities: any =
-    parsedXML.WMT_MS_Capabilities || parsedXML.WMS_Capabilities || parsedXML;
-  return extractCapabilities(xmlCapabilities);
-}
-
-/** Extract typed capability data from XML */
-function extractCapabilities(xml: any): WMSCapabilities {
-  const capabilities: WMSCapabilities = {
-    name: xml.Service?.Name || 'unnamed',
-    title: xml.Service?.Title,
-    keywords: [],
-    requests: {},
-    layer: extractLayer(xml.Capability?.Layer),
-    raw: xml
-  };
-
-  for (const keyword of xml.Service?.KeywordList?.Keyword || []) {
-    capabilities.keywords.push(keyword);
-  }
-
-  for (const [name, xmlRequest] of Object.entries(xml.Capability?.Request || {})) {
-    capabilities.requests[name] = extractRequest(name, xmlRequest);
-  }
-
-  return capabilities;
-}
-
-/** Extract typed request data from XML */
-function extractRequest(name: string, xmlRequest: any): WMSRequest {
-  const format: string | string[] = xmlRequest?.Format;
-  const mimeTypes: string[] = Array.isArray(format) ? format : [format];
-  return {name, mimeTypes};
-}
-
-/** Extract request data */
-function extractLayer(xmlLayer: any): WMSLayer {
-  const layer: WMSLayer = {
-    name: xmlLayer?.Name,
-    title: xmlLayer?.Title,
-    srs: xmlLayer?.SRS || [],
-    layers: []
-  };
-
-  // Single layer is not represented as array in XML
-  const xmlLayers = getXMLArray(xmlLayer?.Layer);
-
-  for (const xmlSubLayer of xmlLayers) {
-    layer.layers?.push(extractLayer(xmlSubLayer));
-  }
-
-  return layer;
-}
-
-function getXMLArray(xmlValue: any) {
-  if (Array.isArray(xmlValue)) {
-    return xmlValue;
-  }
-  if (xmlValue) {
-    return [xmlValue];
-  }
-  return [];
-}
-
-// GetFeatureInfo
-
-/**
- * Parses a typed data structure from raw XML for `GetFeatureInfo` response
- * @note Error handlings is fairly weak
- */
-export function parseWMSFeatureInfo(text: string, options): WMSFeatureInfo {
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  const xmlFeatureInfo: any = parsedXML.FeatureInfoResponse?.FIELDS || [];
-
-  const xmlFeatures = Array.isArray(xmlFeatureInfo) ? xmlFeatureInfo : [xmlFeatureInfo];
-
-  return {
-    features: xmlFeatures.map((xmlFeature) => extractFeature(xmlFeature))
-  };
-}
-
-function extractFeature(xmlFeature: any) {
-  const xmlFields = xmlFeature || {};
-  // TODO - not correct
-  return {
-    attributes: xmlFields,
-    type: '',
-    bounds: {bottom: 0, top: 0, left: 0, right: 0}
-  };
-}
-
-// GetFeatureInfo
-
-/**
- * Parses a typed data structure from raw XML for `GetFeatureInfo` response
- * @note Error handlings is fairly weak
- */
-export function parseWMSLayerDescription(text: string, options): WMSLayerDescription {
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  // TODO - implement parser
-  return parsedXML as unknown as WMSLayerDescription;
-}
-
-/**
- * Extract an error message from WMS error response XML
- * @param text
- * @param options
- * @returns a string with a human readable message
- */
-export function parseWMSError(text: string, options): string {
-  const parsedXML = XMLLoader.parseTextSync?.(text, options);
-  const serviceExceptionXML =
-    parsedXML?.ServiceExceptionReport?.ServiceException ||
-    parsedXML?.['ogc:ServiceExceptionReport']?.['ogc:ServiceException'];
-  // Sigh, can be either a string or an object
-  const message =
-    typeof serviceExceptionXML === 'string'
-      ? serviceExceptionXML
-      : serviceExceptionXML['#text'] || serviceExceptionXML.code || 'Unknown error';
-  return message;
-}

package/src/lib/wmts/parse-wmts.ts

@@ -1,39 +0,0 @@
-// loaders.gl, MIT license
-
-import type {WMTSCapabilities} from './wmts-types';
-
-import {XMLLoader} from '@loaders.gl/xml';
-
-// GetCapabilities
-
-/**
- * Parses a typed data structure from raw XML for `GetCapabilities` response
- * @note Error handlings is fairly weak
- */
-export function parseWMTSCapabilities(text: string, options): WMTSCapabilities {
-  // Remove namespaces in XML
-  options = {...options, xml: {...options?.xml, removeNSPrefix: true}};
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  const xmlCapabilities: any = parsedXML.Capabilities || parsedXML;
-  return uncapitalizeKeys(xmlCapabilities);
-}
-
-function uncapitalizeKeys(object: any): any {
-  if (object && typeof object === 'object') {
-    const newObject = {};
-    for (const [key, value] of Object.entries(object)) {
-      newObject[uncapitalize(key)] = uncapitalizeKeys(value);
-    }
-    return newObject;
-  }
-  return object;
-}
-
-/**
- * Uncapitalize first letter of a string
- * @param {string} str
- * @returns {string}
- */
-function uncapitalize(str: string): string {
-  return typeof str === 'string' ? str.charAt(0).toLowerCase() + str.slice(1) : str;
-}