@loaders.gl/wms 3.3.0-alpha.12 → 3.3.0-alpha.13

package/dist/wms-error-loader.d.ts

@@ -0,0 +1,34 @@
+import type { LoaderWithParser, LoaderOptions } from '@loaders.gl/loader-utils';
+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 declare const WMSErrorLoader: {
+    id: string;
+    name: string;
+    module: string;
+    version: any;
+    worker: boolean;
+    extensions: string[];
+    mimeTypes: string[];
+    testText: typeof testXMLFile;
+    options: {
+        wms: {
+            throwOnError: boolean;
+        };
+    };
+    parse: (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) => Promise<string>;
+    parseSync: (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) => string;
+    parseTextSync: (text: string, options?: WMSLoaderOptions) => string;
+};
+declare function testXMLFile(text: string): boolean;
+export declare const _typecheckWMSErrorLoader: LoaderWithParser;
+export {};
+//# sourceMappingURL=wms-error-loader.d.ts.map

package/dist/wms-error-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wms-error-loader.d.ts","sourceRoot":"","sources":["../src/wms-error-loader.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,gBAAgB,EAAE,aAAa,EAAC,MAAM,0BAA0B,CAAC;AAO9E,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC7C,GAAG,CAAC,EAAE;QACJ,oFAAoF;QACpF,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,oCAAoC;QACpC,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;yBAeE,WAAW,YAAY,gBAAgB,KAAG,QAAQ,MAAM,CAAC;6BAE3D,WAAW,YAAY,gBAAgB,KAAG,MAAM;0BAEnD,MAAM,YAAY,gBAAgB,KAAG,MAAM;CAClE,CAAC;AAEF,iBAAS,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAG1C;AAYD,eAAO,MAAM,wBAAwB,EAAE,gBAAiC,CAAC"}

package/dist/wms-error-loader.js

@@ -0,0 +1,43 @@
+"use strict";
+// loaders.gl, MIT license
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._typecheckWMSErrorLoader = exports.WMSErrorLoader = void 0;
+const parse_wms_1 = require("./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';
+/**
+ * Loader for the response to the WMS GetCapability request
+ */
+exports.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, options) => parseTextSync(new TextDecoder().decode(arrayBuffer), options),
+    parseSync: (arrayBuffer, options) => parseTextSync(new TextDecoder().decode(arrayBuffer), options),
+    parseTextSync: (text, options) => parseTextSync(text, options)
+};
+function testXMLFile(text) {
+    // TODO - There could be space first.
+    return text.startsWith('<?xml');
+}
+function parseTextSync(text, options) {
+    const wmsOptions = { ...exports.WMSErrorLoader.options.wms, ...options?.wms };
+    const error = (0, parse_wms_1.parseWMSError)(text, wmsOptions);
+    const message = wmsOptions.minimalErrors ? error : `WMS Service error: ${error}`;
+    if (wmsOptions.throwOnError) {
+        throw new Error(message);
+    }
+    return message;
+}
+exports._typecheckWMSErrorLoader = exports.WMSErrorLoader;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/wms",
-  "version": "3.3.0-alpha.12",
+  "version": "3.3.0-alpha.13",
   "description": "Framework-independent loaders for the WMS (Web Map Service) standard",
   "license": "MIT",
   "publishConfig": {
@@ -35,19 +35,20 @@
   ],
   "scripts": {
     "pre-build": "npm run build-bundle",
-    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js"
+    "build-bundle": "esbuild src/bundle.ts --bundle --outfile=dist/dist.min.js --platform=node"
   },
   "dependencies": {
     "@babel/runtime": "^7.3.1",
-    "@loaders.gl/images": "3.3.0-alpha.12",
-    "@loaders.gl/loader-utils": "3.3.0-alpha.12",
-    "@loaders.gl/schema": "3.3.0-alpha.12",
-    "@loaders.gl/xml": "3.3.0-alpha.12",
+    "@loaders.gl/images": "3.3.0-alpha.13",
+    "@loaders.gl/loader-utils": "3.3.0-alpha.13",
+    "@loaders.gl/schema": "3.3.0-alpha.13",
+    "@loaders.gl/xml": "3.3.0-alpha.13",
     "@turf/rewind": "^5.1.5",
-    "deep-strict-equal": "^0.2.0"
+    "deep-strict-equal": "^0.2.0",
+    "lerc": "^4.0.1"
   },
   "devDependencies": {
     "xmldom": "0.6.0"
   },
-  "gitHead": "e807cde8f2fcb3503fa01ae3ac6b148ff5326649"
+  "gitHead": "429a5667c9903cc2de4d1f3e55e1c2f2e58a3ff6"
 }

package/src/index.ts

@@ -4,29 +4,50 @@
 
 export {WMSErrorLoader} from './wms-error-loader';
 
-export type {WMSCapabilities, WMSFeatureInfo, WMSLayerDescription} from './lib/wms/wms-types';
 export type {WMSLoaderOptions} from './wms-capabilities-loader';
+
+export type {WMSCapabilities} from './lib/wms/wms-types';
 export {WMSCapabilitiesLoader} from './wms-capabilities-loader';
-export {WMSFeatureInfoLoader} from './wms-feature-info-loader';
-export {WMSLayerDescriptionLoader} from './wms-layer-description-loader';
 
 export type {WMSServiceProps} from './lib/data-sources/wms-service';
 export {WMSService} from './lib/data-sources/wms-service';
 
-// WFS
+// NOTE: Will likely move to tiles module
+export type {ImageSourceMetadata as _ImageSourceMetadata} from './lib/data-sources/image-source';
+export {ImageSource as _ImageSource} from './lib/data-sources/image-source';
+
+export {AdHocImageService as _AdHocImageService} from './lib/data-sources/adhoc-image-service';
+
+// WIP /////////////////////////////////////////////////////////////////
+// Plumbing set up but details of parsing and typing not yet completed
+
+// WMS
 
-export type {WFSCapabilities} from './lib/wfs/wfs-types';
-export type {WFSLoaderOptions} from './wfs-capabilities-loader';
-export {WFSCapabilitiesLoader} from './wfs-capabilities-loader';
+export type {WMSFeatureInfo as _WMSFeatureInfo} from './lib/wms/wms-types';
+export {WMSFeatureInfoLoader as _WMSFeatureInfoLoader} from './wip/wms-feature-info-loader';
+
+export type {WMSLayerDescription as _WMSLayerDescription} from './lib/wms/wms-types';
+export {WMSLayerDescriptionLoader as _WMSLayerDescriptionLoader} from './wip/wms-layer-description-loader';
 
 // WMTS
 
-export type {WMTSCapabilities} from './lib/wmts/wmts-types';
-export type {WMTSLoaderOptions} from './wmts-capabilities-loader';
-export {WMTSCapabilitiesLoader} from './wmts-capabilities-loader';
+export type {WMTSCapabilities as _WMTSCapabilities} from './lib/wmts/wmts-types';
+export type {WMTSLoaderOptions as _WMTSLoaderOptions} from './wip/wmts-capabilities-loader';
+export {WMTSCapabilitiesLoader as _WMTSCapabilitiesLoader} from './wip/wmts-capabilities-loader';
+
+// WFS
+
+export type {WFSCapabilities as _WFSCapabilities} from './lib/wfs/wfs-types';
+export type {WFSLoaderOptions as _WFSLoaderOptions} from './wip/wfs-capabilities-loader';
+export {WFSCapabilitiesLoader as _WFSCapabilitiesLoader} from './wip/wfs-capabilities-loader';
 
 // GML
 
-export type {GeoJSON} from '@loaders.gl/schema';
-export type {GMLLoaderOptions} from './gml-loader';
-export {GMLLoader} from './gml-loader';
+export type {GeoJSON as _GeoJSON} from '@loaders.gl/schema';
+export type {GMLLoaderOptions as _GMLLoaderOptions} from './wip/gml-loader';
+export {GMLLoader as _GMLLoader} from './wip/gml-loader';
+
+// LERC
+
+export type {LERCData} from './lib/lerc/lerc-types';
+export {LERCLoader} from './lerc-loader';

package/src/lerc-loader.ts

@@ -0,0 +1,50 @@
+// loaders.gl, MIT license
+
+import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import type {LERCData} from './lib/lerc/lerc-types';
+import * as Lerc from 'lerc';
+
+// __VERSION__ is injected by babel-plugin-version-inline
+// @ts-ignore TS2304: Cannot find name '__VERSION__'.
+const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
+
+export type LERCLoaderOptions = LoaderOptions & {
+  lerc?: {
+    /**	The number of bytes to skip in the input byte stream. A valid Lerc file is expected at that position. */
+    inputOffset?: number;
+    /**	It is recommended to use the returned mask instead of setting this value. */
+    noDataValue?: number;
+    /**	(ndepth LERC2 only) If true, returned depth values are pixel-interleaved. */
+    returnInterleaved?: boolean;
+  };
+};
+
+/**
+ * Loader for the LERC raster format
+ */
+export const LERCLoader = {
+  id: 'lerc',
+  name: 'LERC',
+
+  module: 'wms',
+  version: VERSION,
+  worker: false,
+  extensions: ['lrc', 'lerc', 'lerc2', 'lerc1'],
+  mimeTypes: ['application/octet-stream'],
+  // test: ?,
+  options: {
+    wms: {}
+  },
+  parse: async (arrayBuffer: ArrayBuffer, options?: LERCLoaderOptions) =>
+    parseLERC(arrayBuffer, options)
+};
+
+async function parseLERC(arrayBuffer: ArrayBuffer, options?: LERCLoaderOptions): Promise<LERCData> {
+  // Load the WASM library
+  await Lerc.load();
+  // Perform the decode
+  const pixelBlock = Lerc.decode(arrayBuffer, options?.lerc);
+  return pixelBlock;
+}
+
+export const _typecheckLERCLoader: LoaderWithParser = LERCLoader;

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

@@ -0,0 +1,58 @@
+// loaders.gl, MIT license
+
+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';
+
+export type AdHocImageServiceProps = {
+  /** Template URL string should contain `${width}` etc which will be substituted. */
+  templateUrl: string;
+};
+
+/**
+ * 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 AdHocImageService extends ImageSource {
+  templateUrl: string;
+
+  constructor(props: AdHocImageServiceProps) {
+    super();
+    this.templateUrl = props.templateUrl;
+  }
+
+  // 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 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};
+  }
+
+  protected getURLFromTemplate(parameters: Record<string, unknown>): string {
+    let url = this.templateUrl;
+    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));
+    }
+    return url;
+  }
+}

package/src/lib/data-sources/image-source.ts

@@ -0,0 +1,82 @@
+// loaders.gl, MIT license
+
+import type {ImageType} from '@loaders.gl/images';
+
+/**
+ * Normalized capabilities of an Image service
+ * @example
+ *  The WMSService will normalize the response to the WMS `GetCapabilities` data structure extracted from WMS XML response
+ *  into an ImageSourceMetadata.
+ */
+export type ImageSourceMetadata = {
+  name: string;
+  title?: string;
+  abstract?: string;
+  keywords: string[];
+  layer: {
+    name: string;
+    title?: string;
+    srs?: string[];
+    boundingBox?: [number, number, number, number];
+    layers: ImageSourceLayer[];
+  };
+};
+
+export type ImageSourceLayer = {
+  name: string;
+  title?: string;
+  srs?: string[];
+  boundingBox?: [number, number, number, number];
+  layers: ImageSourceLayer[];
+};
+
+export type GetImageParameters = {
+  /** Layers to render */
+  layers: string | string[];
+  /** Styling */
+  styles?: unknown;
+  /** bounding box of the requested map image */
+  bbox: [number, number, number, number];
+  /** pixel width of returned image */
+  width: number;
+  /** pixels */
+  height: number;
+  /** srs for the image (not the bounding box) */
+  srs?: string;
+  /** requested format for the return image */
+  format?: 'image/png';
+};
+
+// Attempt to break down GetImageParameters
+export type ImageFilters = {
+  /** Layers to render */
+  layers: string | string[];
+  /** Styling */
+  styles?: unknown;
+};
+
+export type ImageRegion = {
+  /** bounding box of the requested map image */
+  bbox: [number, number, number, number];
+};
+
+export type ImageFormat = {
+  /** pixel width of returned image */
+  width: number;
+  /** pixels */
+  height: number;
+  /** srs for the image (not the bounding box) */
+  srs?: string;
+  /** requested format for the return image */
+  format?: 'image/png';
+};
+
+/**
+ * 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 abstract class ImageSource {
+  abstract getMetadata(): Promise<ImageSourceMetadata>;
+  abstract getImage(parameters: GetImageParameters): Promise<ImageType>;
+}