@loaders.gl/wms 4.0.0-alpha.9 → 4.0.0-beta.2

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

@@ -1,48 +0,0 @@
-// loaders.gl, MIT license
-
-import {ImageSource} from './sources/image-source';
-import {ImageService, ImageServiceProps} from './services/generic/image-service';
-import type {WMSServiceProps} from './services/ogc/wms-service';
-import {WMSService} from './services/ogc/wms-service';
-import {ArcGISImageServer} from './services/arcgis/arcgis-image-service';
-
-export type ImageServiceType = 'wms' | 'arcgis-image-server' | 'template';
-
-const SERVICES = [WMSService, ArcGISImageServer, ImageService];
-
-type ImageSourceProps = ImageServiceProps &
-  WMSServiceProps & {
-    type?: ImageServiceType | 'auto';
-  };
-
-/**
- * Creates an image source
- * If type is not supplied, will try to automatically detect the the
- * @param url URL to the image source
- * @param type type of source. if not known, set to 'auto'
- * @returns an ImageSource instance
- */
-export function createImageSource(props: ImageSourceProps): ImageSource<ImageSourceProps> {
-  const {type = 'auto'} = props;
-  const serviceType = type === 'auto' ? guessServiceType(props.url) : type;
-  switch (serviceType) {
-    case 'template':
-      return new ImageService(props);
-    case 'wms':
-      return new WMSService(props);
-    default:
-      // currently only wms service supported
-      throw new Error('Not a valid image source type');
-  }
-}
-
-/** Guess service type from URL */
-function guessServiceType(url: string): ImageServiceType {
-  for (const Service of SERVICES) {
-    if (Service.testURL && Service.testURL(url)) {
-      return Service.type;
-    }
-  }
-  // If all else fails, guess that this is MS service
-  return 'wms';
-}

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

@@ -1,73 +0,0 @@
-// loaders.gl, MIT license
-
-import type {LoaderOptions} from '@loaders.gl/loader-utils';
-
-export type DataSourceProps = {
-  /** LoaderOptions provide an option to override `fetch`. Will also be passed to any sub loaders */
-  loadOptions?: LoaderOptions;
-};
-
-/** base class of all data sources */
-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;
-
-  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;
-  }
-}
-
-/**
- * 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);
-}

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

@@ -1,92 +0,0 @@
-// loaders.gl, MIT license
-
-import type {ImageType} from '@loaders.gl/images';
-import type {DataSourceProps} from './data-source';
-import {DataSource} from './data-source';
-
-/**
- * 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[];
-  layers: ImageSourceLayer[];
-};
-
-/** Description of one data layer in the image source */
-export type ImageSourceLayer = {
-  /** Name of this layer */
-  name?: string;
-  /** Human readable title of this layer */
-  title?: string;
-  /** Coordinate systems supported by this layer */
-  crs?: string[];
-  /** layer limits in unspecified CRS:84-like lng/lat, for quick access w/o CRS calculations. */
-  geographicBoundingBox?: [min: [x: number, y: number], max: [x: number, y: number]];
-  /** Sub layers of this layer */
-  layers?: ImageSourceLayer[];
-
-  /** @deprecated from v3.4: non-vis.gl style bounding box. Use `.geographicBoundingBox` instead */
-  boundingBox?: [number, number, number, number];
-};
-
-/** Generic parameters for requesting an image from an image source */
-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;
-  /** crs for the image (not the bounding box) */
-  crs?: 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;
-  /** crs for the image (not the bounding box) */
-  crs?: string;
-  /** requested format for the return image */
-  format?: 'image/png';
-};
-
-export type ImageSourceProps = DataSourceProps;
-
-/**
- * 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<
-  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,61 +0,0 @@
-// loaders.gl, MIT license
-
-import type {ImageType} from '@loaders.gl/images';
-import {DataSource, DataSourceProps} from './data-source';
-
-/**
- * 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 TileSourceMetadata.
- */
-export type TileSourceMetadata = {
-  name: string;
-  title?: string;
-  abstract?: string;
-  keywords: string[];
-  layer: {
-    name: string;
-    title?: string;
-    srs?: string[];
-    boundingBox?: [number, number, number, number];
-    layers: TileSourceLayer[];
-  };
-};
-
-export type TileSourceLayer = {
-  name: string;
-  title?: string;
-  srs?: string[];
-  boundingBox?: [number, number, number, number];
-  layers: TileSourceLayer[];
-};
-
-export type GetTileParameters = {
-  /** Layers to render */
-  layers: string | string[];
-  /** Styling */
-  styles?: unknown;
-  /** bounding box of the requested map image */
-  zoom: number;
-  /** tile x coordinate */
-  x: number;
-  /** tile y coordinate */
-  y: number;
-  /** srs for the image (not the bounding box) */
-  srs?: string;
-  /** requested format for the return image */
-  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<PropsT extends TileSourceProps> extends DataSource<PropsT> {
-  abstract getMetadata(): Promise<TileSourceMetadata>;
-  abstract getTile(parameters: GetTileParameters): Promise<ImageType>;
-}

package/src/lib/sources/utils/utils.ts

@@ -1,42 +0,0 @@
-// loaders.gl, MIT license
-
-import type {LoaderOptions} from '@loaders.gl/loader-utils';
-
-/**
- * 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 extends {loadOptions?: any}>(
-  props: Props
-): Required<Props> {
-  // @ts-expect-error
-  return {
-    // Default fetch
-    ...props,
-    loadOptions: {
-      ...props.loadOptions,
-      fetch: getFetchFunction(props.loadOptions)
-    }
-  };
-}