@loaders.gl/wms 3.4.0 → 3.4.2

package/src/lib/services/ogc/wms-service.ts

@@ -42,6 +42,10 @@ export type WMSParameters = {
   styles?: unknown;
   /** Any additional parameters specific to this WMSService (GetMap) */
   transparent?: boolean;
+  /** If layer supports time dimension */
+  time?: string;
+  /** If layer supports elevation dimension */
+  elevation?: string;
 };
 
 /** Parameters for GetCapabilities */
@@ -60,6 +64,8 @@ export type WMSGetMapParameters = {
   width: number;
   /** pixels */
   height: number;
+  /** requested format for the return image. can be provided in service constructor */
+  format?: 'image/png';
   /** Layers to render - can be provided in service constructor */
   layers?: string | string[];
   /** Coordinate Reference System for the image (not bounding box). can be provided in service constructor. */
@@ -68,8 +74,10 @@ export type WMSGetMapParameters = {
   styles?: unknown;
   /** Don't render background when no data. can be provided in service constructor */
   transparent?: boolean;
-  /** requested format for the return image. can be provided in service constructor */
-  format?: 'image/png';
+  /** If layer supports time dimension */
+  time?: string;
+  /** If layer supports elevation dimension */
+  elevation?: string;
 };
 
 /** GetMap parameters that are specific to the current view */
@@ -213,6 +221,8 @@ export class WMSService extends ImageSource<WMSServiceProps> {
       format: 'image/png',
       info_format: 'text/plain',
       transparent: undefined!,
+      time: undefined!,
+      elevation: undefined!,
       ...props.wmsParameters
     };
 
@@ -342,6 +352,8 @@ export class WMSService extends ImageSource<WMSServiceProps> {
       version: this.wmsParameters.version,
       format: this.wmsParameters.format,
       transparent: this.wmsParameters.transparent,
+      time: this.wmsParameters.time,
+      elevation: this.wmsParameters.elevation,
       layers: this.wmsParameters.layers,
       styles: this.wmsParameters.styles,
       crs: this.wmsParameters.crs,
@@ -440,9 +452,10 @@ export class WMSService extends ImageSource<WMSServiceProps> {
     };
 
     // Encode the keys
+    const IGNORE_EMPTY_KEYS = ['transparent', 'time', 'elevation'];
     for (const [key, value] of Object.entries(allParameters)) {
       // hack to preserve test cases. Not super clear if keys should be included when values are undefined
-      if (key !== 'transparent' || value) {
+      if (!IGNORE_EMPTY_KEYS.includes(key) || value) {
         url += first ? '?' : '&';
         first = false;
         url += this._getURLParameter(key, value, wmsParameters);

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

@@ -1,7 +1,8 @@
 // loaders.gl, MIT license
 
 import type {LoaderWithParser} from '@loaders.gl/loader-utils';
-import {WMSCapabilitiesLoader, WMSLoaderOptions} from '../wms-capabilities-loader';
+import type {XMLLoaderOptions} from '@loaders.gl/xml';
+import {WMSCapabilitiesLoader} from '../wms-capabilities-loader';
 
 import type {WMSFeatureInfo} from '../lib/parsers/wms/parse-wms-features';
 import {parseWMSFeatureInfo} from '../lib/parsers/wms/parse-wms-features';
@@ -17,9 +18,9 @@ export const WMSFeatureInfoLoader = {
   id: 'wms-feature-info',
   name: 'WMS FeatureInfo',
 
-  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+  parse: async (arrayBuffer: ArrayBuffer, options?: XMLLoaderOptions) =>
     parseWMSFeatureInfo(new TextDecoder().decode(arrayBuffer), options),
-  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSFeatureInfo(text, options)
+  parseTextSync: (text: string, options?: XMLLoaderOptions) => parseWMSFeatureInfo(text, options)
 };
 
 export const _typecheckWMSFeatureInfoLoader: LoaderWithParser = WMSFeatureInfoLoader;

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

@@ -1,7 +1,7 @@
 // loaders.gl, MIT license
 
 import type {LoaderWithParser} from '@loaders.gl/loader-utils';
-import type{WMSLoaderOptions} from '../wms-capabilities-loader';
+import type {XMLLoaderOptions} from '@loaders.gl/xml';
 import {WMSCapabilitiesLoader} from '../wms-capabilities-loader';
 
 import type {WMSLayerDescription} from '../lib/parsers/wms/parse-wms-layer-description';
@@ -18,9 +18,9 @@ export const WMSLayerDescriptionLoader = {
   id: 'wms-layer-description',
   name: 'WMS DescribeLayer',
 
-  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+  parse: async (arrayBuffer: ArrayBuffer, options?: XMLLoaderOptions) =>
     parseWMSLayerDescription(new TextDecoder().decode(arrayBuffer), options),
-  parseTextSync: (text: string, options?: WMSLoaderOptions) => parseWMSLayerDescription(text, options)
+  parseTextSync: (text: string, options?: XMLLoaderOptions) => parseWMSLayerDescription(text, options)
 };
 
 export const _typecheckWMSFeatureInfoLoader: LoaderWithParser = WMSLayerDescriptionLoader;

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

@@ -1,6 +1,7 @@
 // loaders.gl, MIT license
 
-import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
+import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import type {XMLLoaderOptions} from '@loaders.gl/xml';
 // import type {WMTSCapabilities} from './lib/wmts/parse-wmts-capabilities';
 import {parseWMTSCapabilities} from './lib/wmts/parse-wmts-capabilities';
 
@@ -10,7 +11,7 @@ const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
 // export type {WMTSCapabilities};
 
-export type WMTSLoaderOptions = LoaderOptions & {
+export type WMTSLoaderOptions = XMLLoaderOptions & {
   wmts?: {};
 };
 

package/src/wms-capabilities-loader.ts

@@ -1,21 +1,32 @@
 // loaders.gl, MIT license
 
-import type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';
-import type {WMSCapabilities} from './lib/parsers/wms/parse-wms-capabilities';
+import type {LoaderWithParser} from '@loaders.gl/loader-utils';
+import type {XMLLoaderOptions} from '@loaders.gl/xml';
 import {parseWMSCapabilities} from './lib/parsers/wms/parse-wms-capabilities';
 
 // __VERSION__ is injected by babel-plugin-version-inline
 // @ts-ignore TS2304: Cannot find name '__VERSION__'.
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';
 
-// Parsed data type
-export type {WMSCapabilities};
-
-export type WMSLoaderOptions = LoaderOptions & {
+// Parsed data types
+export type {
+  WMSCapabilities,
+  WMSLayer,
+  WMSBoundingBox,
+  WMSDimension,
+  WMSRequest,
+  WMSExceptions
+} from './lib/parsers/wms/parse-wms-capabilities';
+
+export type WMSCapabilitiesLoaderOptions = XMLLoaderOptions & {
   wms?: {
     /** Add inherited layer information to sub layers */
     inheritedLayerProps?: boolean;
-    /** Whether to include "raw" XML-derived JSON */
+    /** Include the "raw" JSON (parsed but untyped, unprocessed XML). May contain additional fields */
+    includeRawData?: boolean;
+    /** Include the original XML document text. May contain additional information. */
+    includeXMLText?: boolean;
+    /** @deprecated Use options.includeRawData` */
     raw?: boolean;
   };
 };
@@ -36,9 +47,11 @@ export const WMSCapabilitiesLoader = {
   options: {
     wms: {}
   },
-  parse: async (arrayBuffer: ArrayBuffer, options?: WMSLoaderOptions) =>
+  parse: async (arrayBuffer: ArrayBuffer, options?: WMSCapabilitiesLoaderOptions) =>
+    // TODO pass in XML options
     parseWMSCapabilities(new TextDecoder().decode(arrayBuffer), options?.wms),
-  parseTextSync: (text: string, options?: WMSLoaderOptions) =>
+  parseTextSync: (text: string, options?: WMSCapabilitiesLoaderOptions) =>
+    // TODO pass in XML options
     parseWMSCapabilities(text, options?.wms)
 };