@loaders.gl/wms 3.3.0-alpha.8 → 3.3.0

package/src/wip/data-source.ts

@@ -0,0 +1,62 @@
+// loaders.gl, MIT license
+
+/** General data source class */
+// export abstract class DataSource {};
+// export type DataSourceMetadata = {};
+
+// ImageSource
+
+// Tile Source
+
+/** Data source that serves data by tile index *
+export abstract class TileDataSource extends DataSource {};
+
+// Image Tile Data Source
+
+export type ImageTileDataSourceCapabilities = {
+}
+
+export type ImageTile = Record<string, any>;
+
+export type FeatureInfo = {};
+
+export abstract class ImageTileDataSource extends TileDataSource {
+  source: ImageDataSource;
+  
+  constructor(source: ImageDataSource) {
+    super();
+    this.source = source;
+  }
+
+  getCapabilities(): Promise<ImageTileDataSourceCapabilities> {
+    return this.source.getCapabilities();
+  }
+
+  getTile({x, y, z, width, height, layers, parameters}): Promise<ImageType> {
+    const boundingBox = this.getBoundingBoxFromTileIndex(x, y, z);
+    return this.source.getImage({boundingBox, width, height, layers, parameters});
+  }
+
+  getFeatureInfo(): FeatureInfo | null {
+    return null;
+  }
+
+  getBoundingBoxFromTileIndex(x: number, y: number, z: number): [number, number, number, number] {
+    return [0, 0, 1, 1];
+  }
+}
+
+// Vector Tile Source
+
+export type VectorTileDataSourceCapabilities = {
+  // check tile.json
+}
+
+export type VectorTile = Record<string, any>;
+
+export abstract class VectorTileDataSource extends TileDataSource {
+  abstract getCapabilities(): Promise<VectorTileDataSourceCapabilities>;
+  abstract getTile({x, y, z, width, height, layers, parameters}): Promise<VectorTile>;
+}
+
+*/

package/src/wip/gml-loader.ts

@@ -0,0 +1,40 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {parseGML} from '../lib/gml/parse-gml';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type GMLLoaderOptions = LoaderOptions & {
+  gml?: {};
+};
+
+/**
+ * Loader for the response to the GML GetCapability request
+ */
+export const GMLLoader = {
+  name: 'GML',
+  id: 'gml',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['xml'],
+  mimeTypes: ['application/vnd.ogc.gml_xml', 'application/xml', 'text/xml'],
+  testText: testXMLFile,
+  options: {
+    gml: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: GMLLoaderOptions) =>
+    parseGML(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: GMLLoaderOptions) => parseGML(text, options)
+};
+
+function testXMLFile(text: string): boolean {
+  // TODO - There could be space first.
+  return text.startsWith('<?xml');
+}
+
+export const _typecheckGMLLoader: LoaderWithParser = GMLLoader;

package/src/wip/wcs-capabilities-loader.ts

@@ -0,0 +1,40 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {parseWFSCapabilities} from '../lib/wcs/parse-wcs';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type WCSLoaderOptions = LoaderOptions & {
+  wcs?: {};
+};
+
+/**
+ * Loader for the response to the WCS GetCapability request
+ */
+export const WCSCapabilitiesLoader = {
+  id: 'wcs-capabilities',
+  name: 'WFS Capabilities',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['xml'],
+  mimeTypes: ['application/vnd.ogc.wcs_xml', 'application/xml', 'text/xml'],
+  testText: testXMLFile,
+  options: {
+    wms: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: WCSLoaderOptions) =>
+    parseWFSCapabilities(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WCSLoaderOptions) => parseWFSCapabilities(text, options)
+};
+
+function testXMLFile(text: string): boolean {
+  // TODO - There could be space first.
+  return text.startsWith('<?xml');
+}
+
+export const _typecheckWFSCapabilitiesLoader: LoaderWithParser = WCSCapabilitiesLoader;

package/src/wip/wfs-capabilities-loader.ts

@@ -0,0 +1,40 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {parseWFSCapabilities} from '../lib/wfs/parse-wfs';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type WFSLoaderOptions = LoaderOptions & {
+  wfs?: {};
+};
+
+/**
+ * Loader for the response to the WFS GetCapability request
+ */
+export const WFSCapabilitiesLoader = {
+  id: 'wfs-capabilities',
+  name: 'WFS Capabilities',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['xml'],
+  mimeTypes: ['application/vnd.ogc.wfs_xml', 'application/xml', 'text/xml'],
+  testText: testXMLFile,
+  options: {
+    wms: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: WFSLoaderOptions) =>
+    parseWFSCapabilities(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WFSLoaderOptions) => parseWFSCapabilities(text, options)
+};
+
+function testXMLFile(text: string): boolean {
+  // TODO - There could be space first.
+  return text.startsWith('<?xml');
+}
+
+export const _typecheckWFSCapabilitiesLoader: LoaderWithParser = WFSCapabilitiesLoader;

package/src/wip/wms-feature-info-loader.ts

@@ -0,0 +1,21 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import {WMSCapabilitiesLoader, WMSLoaderOptions} from '../wms-capabilities-loader';
+import {parseWMSFeatureInfo} from '../lib/wms/parse-wms';
+
+/**
+ * Loader for the response to the WMS GetFeatureInfo request
+ */
+export const WMSFeatureInfoLoader = {
+  ...WMSCapabilitiesLoader,
+
+  id: 'wms-feature-info',
+  name: 'WMS FeatureInfo',
+
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+    parseWMSFeatureInfo(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSFeatureInfo(text, options)
+};
+
+export const _typecheckWMSFeatureInfoLoader: LoaderWithParser = WMSFeatureInfoLoader;

package/src/wip/wms-layer-description-loader.md.disabled.md

@@ -0,0 +1,47 @@
+# WMSLayerDescriptionLoader
+
+<p class="badges">
+  <img src="https://img.shields.io/badge/From-v3.3-blue.svg?style=flat-square" alt="From-v3.3" />
+	<img src="https://img.shields.io/badge/-BETA-teal.svg" alt="BETA" />
+</p>
+
+The `WMSLayerDescriptionLoader` parses the XML-formatted response from the 
+the [OGC](https://www.opengeospatial.org/) [WMS](https://www.ogc.org/standards/wms) (Web Map Service) standard `DescribeLayer` request into a typed JavaScript data structure.
+
+> Note that the WMS standard is rather verbose and the XML responses can contain many rarely used metadata fields, not all of which are extracted by this loader. If this is a problem, it is possible to use the `XMLLoader` directly though the result will be untyped and not normalized.
+
+| Loader                | Characteristic                                       |
+| --------------------- | ---------------------------------------------------- |
+| File Extension        | `.xml`                                               |
+| File Type             | Text                                                 |
+| File Format           | [WMS](https://en.wikipedia.org/wiki/Web_Map_Service) |
+| Data Format           | Data structure         |
+| Decoder Type          | Synchronous                                          |
+| Worker Thread Support | No                                                  |
+| Streaming Support     | No                                                   |
+
+## Usage
+
+```js
+import {WMSLayerDescriptionLoader} from '@loaders.gl/wms';
+import {load} from '@loaders.gl/core';
+
+// Form a WMS request
+const url = `${WMS_SERVICE_URL}?REQUEST=DescribeLayer&LAYER=...`;
+
+const data = await load(url, WMSLayerDescriptionLoader, options);
+```
+
+## Parsed Data Format
+
+```typescript
+/** All capabilities of a WMS service. Typed data structure extracted from XML */
+export type WMSLayerDescription = {
+  // TO BE DOCUMENTED
+}
+```
+
+## Options
+
+| Option | Type | Default | Description |
+| ------ | ---- | ------- | ----------- |

package/src/wip/wms-layer-description-loader.ts

@@ -0,0 +1,21 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import {WMSCapabilitiesLoader, WMSLoaderOptions} from '../wms-capabilities-loader';
+import {parseWMSLayerDescription} from '../lib/wms/parse-wms';
+
+/**
+ * Loader for the response to the WMS DescribeLayer request
+ */
+export const WMSLayerDescriptionLoader = {
+  ...WMSCapabilitiesLoader,
+
+  id: 'wms-layer-description',
+  name: 'WMS DescribeLayer',
+
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+    parseWMSLayerDescription(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSLayerDescription(text, options)
+};
+
+export const _typecheckWMSFeatureInfoLoader: LoaderWithParser = WMSLayerDescriptionLoader;

package/src/wip/wmts-capabilities-loader.ts

@@ -0,0 +1,40 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {parseWMTSCapabilities} from '../lib/wmts/parse-wmts';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type WMTSLoaderOptions = LoaderOptions & {
+  wmts?: {};
+};
+
+/**
+ * Loader for the response to the WMTS GetCapability request
+ */
+export const WMTSCapabilitiesLoader = {
+  id: 'wmts-capabilities',
+  name: 'WMTS Capabilities',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['xml'],
+  mimeTypes: ['application/vnd.ogc.wmts_xml', 'application/xml', 'text/xml'],
+  testText: testXMLFile,
+  options: {
+    wms: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMTSLoaderOptions) =>
+    parseWMTSCapabilities(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMTSLoaderOptions) => parseWMTSCapabilities(text, options)
+};
+
+function testXMLFile(text: string): boolean {
+  // TODO - There could be space first.
+  return text.startsWith('<?xml');
+}
+
+export const _typecheckWMTSCapabilitiesLoader: LoaderWithParser = WMTSCapabilitiesLoader;

package/src/wms-capabilities-loader.ts

@@ -1,20 +1,23 @@
+// loaders.gl, MIT license
+
 import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import {parseWMSCapabilities} from './lib/parse-wms-capabilities';
+import {parseWMSCapabilities} from './lib/wms/parse-wms';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
-export type WMSCapabilitiesLoaderOptions = LoaderOptions & {
+export type WMSLoaderOptions = LoaderOptions & {
   wms?: {};
 };
 
 /**
- * Worker loader for the OBJ geometry format
+ * Loader for the response to the WMS GetCapability request
  */
 export const WMSCapabilitiesLoader = {
+  id: 'wms-capabilities',
   name: 'WMS Capabilities',
-  id: 'wms',
+
   module: 'wms',
   version: VERSION,
   worker: false,
@@ -22,12 +25,11 @@ export const WMSCapabilitiesLoader = {
   mimeTypes: ['application/vnd.ogc.wms_xml', 'application/xml', 'text/xml'],
   testText: testXMLFile,
   options: {
-    obj: {}
+    wms: {}
   },
-  parse: async (arrayBuffer: ArrayBuffer, options?: WMSCapabilitiesLoaderOptions) =>
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
     parseWMSCapabilities(new TextDecoder().decode(arrayBuffer), options),
-  parseTextSync: (text: string, options?: WMSCapabilitiesLoaderOptions) =>
-    parseWMSCapabilities(text, options)
+  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSCapabilities(text, options)
 };
 
 function testXMLFile(text: string): boolean {

package/src/wms-error-loader.ts

@@ -0,0 +1,59 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import {parseWMSError} from './lib/wms/parse-wms';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type WMSLoaderOptions = LoaderOptions & {
+  wms?: {
+    /** By default the error loader will throw an error with the parsed error message */
+    throwOnError?: boolean;
+    /** Do not add any text to errors */
+    minimalErrors?: boolean;
+  };
+};
+
+/**
+ * Loader for the response to the WMS GetCapability request
+ */
+export const WMSErrorLoader = {
+  id: 'wms-error',
+  name: 'WMS Error',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['xml'],
+  mimeTypes: ['application/vnd.ogc.se_xml', 'application/xml', 'text/xml'],
+  testText: testXMLFile,
+  options: {
+    wms: {
+      throwOnError: false
+    }
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions): Promise<string> =>
+    parseTextSync(new TextDecoder().decode(arrayBuffer), options),
+  parseSync: (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions): string =>
+    parseTextSync(new TextDecoder().decode(arrayBuffer), options),
+  parseTextSync: (text: string, options?: WMSLoaderOptions): string => parseTextSync(text, options)
+};
+
+function testXMLFile(text: string): boolean {
+  // TODO - There could be space first.
+  return text.startsWith('<?xml');
+}
+
+function parseTextSync(text: string, options?: WMSLoaderOptions): string {
+  const wmsOptions: WMSLoaderOptions['wms'] = {...WMSErrorLoader.options.wms, ...options?.wms};
+  const error = parseWMSError(text, wmsOptions);
+  const message = wmsOptions.minimalErrors ? error : `WMS Service error: ${error}`;
+  if (wmsOptions.throwOnError) {
+    throw new Error(message);
+  }
+  return message;
+}
+
+export const _typecheckWMSErrorLoader: LoaderWithParser = WMSErrorLoader;

package/dist/es5/lib/parse-wms-capabilities.js

@@ -1,19 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.parseWMSCapabilities = parseWMSCapabilities;
-var _xml = require("@loaders.gl/xml");
-
-function parseWMSCapabilities(text, options) {
-  var parsedXML = _xml.XMLLoader.parseTextSync(text, options);
-  if (parsedXML.WMT_MS_Capabilities) {
-    return parsedXML.WMT_MS_Capabilities;
-  }
-  if (parsedXML.WMS_Capabilities) {
-    return parsedXML.WMS_Capabilities;
-  }
-  return parsedXML;
-}
-//# sourceMappingURL=parse-wms-capabilities.js.map

package/dist/es5/lib/parse-wms-capabilities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse-wms-capabilities.js","names":["parseWMSCapabilities","text","options","parsedXML","XMLLoader","parseTextSync","WMT_MS_Capabilities","WMS_Capabilities"],"sources":["../../../src/lib/parse-wms-capabilities.ts"],"sourcesContent":["// loaders.gl, MIT license\n\nimport {XMLLoader} from '@loaders.gl/xml';\n\nexport function parseWMSCapabilities(text, options) {\n  const parsedXML = XMLLoader.parseTextSync(text, options);\n  if (parsedXML.WMT_MS_Capabilities) {\n    return parsedXML.WMT_MS_Capabilities;\n  }\n  if (parsedXML.WMS_Capabilities) {\n    return parsedXML.WMS_Capabilities;\n  }\n  return parsedXML;\n}\n"],"mappings":";;;;;;AAEA;;AAEO,SAASA,oBAAoB,CAACC,IAAI,EAAEC,OAAO,EAAE;EAClD,IAAMC,SAAS,GAAGC,cAAS,CAACC,aAAa,CAACJ,IAAI,EAAEC,OAAO,CAAC;EACxD,IAAIC,SAAS,CAACG,mBAAmB,EAAE;IACjC,OAAOH,SAAS,CAACG,mBAAmB;EACtC;EACA,IAAIH,SAAS,CAACI,gBAAgB,EAAE;IAC9B,OAAOJ,SAAS,CAACI,gBAAgB;EACnC;EACA,OAAOJ,SAAS;AAClB"}

package/dist/esm/lib/parse-wms-capabilities.js

@@ -1,14 +0,0 @@
-
-
-import { XMLLoader } from '@loaders.gl/xml';
-export function parseWMSCapabilities(text, options) {
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  if (parsedXML.WMT_MS_Capabilities) {
-    return parsedXML.WMT_MS_Capabilities;
-  }
-  if (parsedXML.WMS_Capabilities) {
-    return parsedXML.WMS_Capabilities;
-  }
-  return parsedXML;
-}
-//# sourceMappingURL=parse-wms-capabilities.js.map

package/dist/esm/lib/parse-wms-capabilities.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse-wms-capabilities.js","names":["XMLLoader","parseWMSCapabilities","text","options","parsedXML","parseTextSync","WMT_MS_Capabilities","WMS_Capabilities"],"sources":["../../../src/lib/parse-wms-capabilities.ts"],"sourcesContent":["// loaders.gl, MIT license\n\nimport {XMLLoader} from '@loaders.gl/xml';\n\nexport function parseWMSCapabilities(text, options) {\n  const parsedXML = XMLLoader.parseTextSync(text, options);\n  if (parsedXML.WMT_MS_Capabilities) {\n    return parsedXML.WMT_MS_Capabilities;\n  }\n  if (parsedXML.WMS_Capabilities) {\n    return parsedXML.WMS_Capabilities;\n  }\n  return parsedXML;\n}\n"],"mappings":";;AAEA,SAAQA,SAAS,QAAO,iBAAiB;AAEzC,OAAO,SAASC,oBAAoB,CAACC,IAAI,EAAEC,OAAO,EAAE;EAClD,MAAMC,SAAS,GAAGJ,SAAS,CAACK,aAAa,CAACH,IAAI,EAAEC,OAAO,CAAC;EACxD,IAAIC,SAAS,CAACE,mBAAmB,EAAE;IACjC,OAAOF,SAAS,CAACE,mBAAmB;EACtC;EACA,IAAIF,SAAS,CAACG,gBAAgB,EAAE;IAC9B,OAAOH,SAAS,CAACG,gBAAgB;EACnC;EACA,OAAOH,SAAS;AAClB"}

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

@@ -1,14 +0,0 @@
-// loaders.gl, MIT license
-
-import {XMLLoader} from '@loaders.gl/xml';
-
-export function parseWMSCapabilities(text, options) {
-  const parsedXML = XMLLoader.parseTextSync(text, options);
-  if (parsedXML.WMT_MS_Capabilities) {
-    return parsedXML.WMT_MS_Capabilities;
-  }
-  if (parsedXML.WMS_Capabilities) {
-    return parsedXML.WMS_Capabilities;
-  }
-  return parsedXML;
-}