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

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

@@ -8,16 +8,43 @@ export type DataSourceProps = {
 };
 
 /** base class of all data sources */
-export abstract class DataSource {
+export abstract class DataSource<PropsT extends DataSourceProps> {
   /** A resolved fetch function extracted from loadOptions prop */
   fetch: (url: string, options?: RequestInit) => Promise<Response>;
   /** The actual load options, if calling a loaders.gl loader */
   loadOptions: LoaderOptions;
+  _needsRefresh: boolean = true;
 
-  constructor(props: DataSourceProps) {
+  props: PropsT;
+
+  constructor(props: PropsT) {
+    this.props = {...props};
     this.loadOptions = {...props.loadOptions};
     this.fetch = getFetchFunction(this.loadOptions);
   }
+
+  setProps(props: PropsT) {
+    this.props = Object.assign(this.props, props);
+    // TODO - add a shallow compare to avoid setting refresh if no change?
+    this.setNeedsRefresh();
+  }
+
+  /** Mark this data source as needing a refresh (redraw) */
+  setNeedsRefresh(): void {
+    this._needsRefresh = true;
+  }
+
+  /**
+   * Does this data source need refreshing?
+   * @note The specifics of the refresh mechanism depends on type of data source
+   */
+  getNeedsRefresh(clear: boolean = true) {
+    const needsRefresh = this._needsRefresh;
+    if (clear) {
+      this._needsRefresh = false;
+    }
+    return needsRefresh;
+  }
 }
 
 /**

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

@@ -21,7 +21,7 @@ export type ImageSourceMetadata = {
 export type ImageSourceLayer = {
   name?: string;
   title?: string;
-  srs?: string[];
+  crs?: string[];
   boundingBox?: [number, number, number, number];
   layers?: ImageSourceLayer[];
 };
@@ -37,8 +37,8 @@ export type GetImageParameters = {
   width: number;
   /** pixels */
   height: number;
-  /** srs for the image (not the bounding box) */
-  srs?: string;
+  /** crs for the image (not the bounding box) */
+  crs?: string;
   /** requested format for the return image */
   format?: 'image/png';
 };
@@ -61,8 +61,8 @@ export type ImageFormat = {
   width: number;
   /** pixels */
   height: number;
-  /** srs for the image (not the bounding box) */
-  srs?: string;
+  /** crs for the image (not the bounding box) */
+  crs?: string;
   /** requested format for the return image */
   format?: 'image/png';
 };
@@ -74,7 +74,9 @@ export type ImageSourceProps = DataSourceProps;
  * @note
  * - If geospatial, bounding box is expected to be in web mercator coordinates
  */
-export abstract class ImageSource extends DataSource {
+export abstract class ImageSource<
+  PropsT extends ImageSourceProps = ImageSourceProps
+> extends DataSource<PropsT> {
   abstract getMetadata(): Promise<ImageSourceMetadata>;
   abstract getImage(parameters: GetImageParameters): Promise<ImageType>;
 }

package/src/lib/sources/tile-source.ts

@@ -1,7 +1,7 @@
 // loaders.gl, MIT license
 
 import type {ImageType} from '@loaders.gl/images';
-import {DataSource} from './data-source';
+import {DataSource, DataSourceProps} from './data-source';
 
 /**
  * Normalized capabilities of an Image service
@@ -48,12 +48,14 @@ export type GetTileParameters = {
   format?: 'image/png';
 };
 
+type TileSourceProps = DataSourceProps;
+
 /**
  * MapTileSource - 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 TileSource extends DataSource {
+export abstract class TileSource<PropsT extends TileSourceProps> extends DataSource<PropsT> {
   abstract getMetadata(): Promise<TileSourceMetadata>;
   abstract getTile(parameters: GetTileParameters): Promise<ImageType>;
 }

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

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=tile-service.js.map

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

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

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

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=tile-service.js.map

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

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

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

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

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

@@ -1 +0,0 @@
-{"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

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