ogm-viewer 0.5.0 → 0.6.0

package/dist/types/lib/previewers/raster.d.ts

@@ -1,11 +1,14 @@
-import type { RasterSourceSpecification, RasterLayerSpecification } from 'maplibre-gl';
-import MapLibrePreviewer from './maplibre';
-import type RasterSource from '../sources/raster';
-export default class RasterPreviewer extends MapLibrePreviewer {
-    protected source: RasterSource;
-    protected createSource(): Promise<RasterSourceSpecification>;
+import type { RasterSourceSpecification, LayerSpecification } from 'maplibre-gl';
+import MapPreviewer from './map';
+import type RasterResource from '../resources/raster';
+export type AddRasterSourceObject = RasterSourceSpecification & {
+    id: string;
+};
+export default class RasterPreviewer extends MapPreviewer {
+    protected resource: RasterResource;
+    protected createSources(): Promise<AddRasterSourceObject[]>;
     protected getSourceId(): string;
-    protected createLayers(): Promise<RasterLayerSpecification[]>;
+    protected createLayers(): Promise<LayerSpecification[]>;
     getBounds(): Promise<maplibregl.LngLatBoundsLike | undefined>;
     setOpacity(opacity: number): Promise<void>;
 }

package/dist/types/lib/previewers/tiled-vector.d.ts

@@ -0,0 +1,11 @@
+import VectorPreviewer from './vector';
+import type { FillLayerSpecification, LineLayerSpecification, CircleLayerSpecification, SymbolLayerSpecification } from 'maplibre-gl';
+export default abstract class TiledVectorPreviewer extends VectorPreviewer {
+    protected createPolygonLayer(layerId: string): FillLayerSpecification;
+    protected createPolygonOutlineLayer(layerId: string): LineLayerSpecification;
+    protected createLineLayer(layerId: string): LineLayerSpecification;
+    protected createPointLayer(layerId: string): CircleLayerSpecification;
+    protected createPolygonLabelLayer(layerId: string): SymbolLayerSpecification;
+    protected createLineLabelLayer(layerId: string): SymbolLayerSpecification;
+    protected createPointLabelLayer(layerId: string): SymbolLayerSpecification;
+}

package/dist/types/lib/previewers/tilejson-raster.d.ts

@@ -0,0 +1,8 @@
+import RasterPreviewer from './raster';
+import type { AddRasterSourceObject } from './raster';
+export default class TileJsonRasterPreviewer extends RasterPreviewer {
+    protected createSources(): Promise<AddRasterSourceObject[]>;
+    protected getSourceId(): string;
+    getBounds(): Promise<maplibregl.LngLatBoundsLike | undefined>;
+    private get tilejson();
+}

package/dist/types/lib/previewers/tilejson-vector.d.ts

@@ -0,0 +1,6 @@
+import TiledVectorPreviewer from './tiled-vector';
+import type { AddVectorSourceObject } from './vector';
+export default class TileJsonVectorPreviewer extends TiledVectorPreviewer {
+    protected getSourceId(): string;
+    protected createSources(): Promise<AddVectorSourceObject[]>;
+}

package/dist/types/lib/previewers/vector.d.ts

@@ -1,8 +1,12 @@
-import MapLibrePreviewer from './maplibre';
-import type { FillLayerSpecification, LineLayerSpecification, CircleLayerSpecification, SymbolLayerSpecification, LayerSpecification } from 'maplibre-gl';
-import type VectorSource from '../sources/vector';
-export default abstract class VectorPreviewer extends MapLibrePreviewer {
-    protected source: VectorSource;
+import MapPreviewer from './map';
+import type { FillLayerSpecification, LineLayerSpecification, CircleLayerSpecification, SymbolLayerSpecification, LayerSpecification, VectorSourceSpecification } from 'maplibre-gl';
+import type VectorResource from '../resources/vector';
+export type AddVectorSourceObject = VectorSourceSpecification & {
+    id: string;
+};
+export default abstract class VectorPreviewer extends MapPreviewer {
+    protected resource: VectorResource;
+    protected getSourceId(): string;
     setOpacity(opacity: number): Promise<void>;
     getBounds(): Promise<import("maplibre-gl").LngLatBoundsLike>;
     protected createLayers(): Promise<LayerSpecification[]>;

package/dist/types/lib/previewers/wms.d.ts

@@ -1,8 +1,20 @@
+import type { CircleLayerSpecification, LayerSpecification, LineLayerSpecification, MapGeoJSONFeature } from 'maplibre-gl';
+import type WmsResource from '../resources/wms';
+import type { GetFeatureInfoOptions } from '../resources/wms';
+import type { AddRasterSourceObject } from './raster';
 import RasterPreviewer from './raster';
-import type WmsSource from '../sources/wms';
-import { RasterSourceSpecification } from 'maplibre-gl';
 export default class WmsPreviewer extends RasterPreviewer {
-    protected source: WmsSource;
-    protected createSource(): Promise<RasterSourceSpecification>;
-    protected getSourceId(): string;
+    protected resource: WmsResource;
+    protected createSources(): Promise<AddRasterSourceObject[]>;
+    getSourceId(): string;
+    protected get highlightSourceId(): string;
+    preview(): Promise<void>;
+    clearPreview(): Promise<void>;
+    highlightFeatures(features: MapGeoJSONFeature[]): void;
+    clearHighlight(): void;
+    inspect(options: GetFeatureInfoOptions): Promise<Response>;
+    protected createLayers(): Promise<LayerSpecification[]>;
+    protected createHighlightOutlineLayer(): LineLayerSpecification;
+    protected createHighlightPointLayer(): CircleLayerSpecification;
+    private get highlightSource();
 }

package/dist/types/lib/previewers/wms.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/previewers/wmts.d.ts

@@ -0,0 +1,11 @@
+import RasterPreviewer from './raster';
+import type WmtsResource from '../resources/wmts';
+import type { WmtsLayer } from '../resources/wmts';
+import type { AddRasterSourceObject } from './raster';
+import type { RasterLayerSpecification } from 'maplibre-gl';
+export default class WmtsPreviewer extends RasterPreviewer {
+    protected resource: WmtsResource;
+    protected layers: WmtsLayer[];
+    protected createSources(): Promise<AddRasterSourceObject[]>;
+    protected createLayers(): Promise<RasterLayerSpecification[]>;
+}

package/dist/types/lib/previewers/wmts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/{sources → resources}/cog.d.ts

@@ -1,5 +1,5 @@
-import RasterSource from './raster';
-export default class CogSource extends RasterSource {
+import RasterResource from './raster';
+export default class CogResource extends RasterResource {
     label(): string;
     getMapLibreSourceUrl(): string;
     getScheme(): any;

package/dist/types/lib/{sources → resources}/geojson.d.ts

@@ -1,5 +1,5 @@
-import VectorSource from './vector';
-export default class GeoJSONSource extends VectorSource {
+import VectorResource from './vector';
+export default class GeoJsonResource extends VectorResource {
     private data;
     protected getData(): Promise<any>;
     label(): string;

package/dist/types/lib/{sources → resources}/iiif-manifest.d.ts

@@ -1,7 +1,7 @@
 import iiif3 from '@iiif/presentation-3';
 import iiif2 from '@iiif/presentation-2';
-import IIIFSource from './iiif';
-export default class IIIFManifestSource extends IIIFSource {
+import IIIFResource from './iiif';
+export default class IIIFManifestResource extends IIIFResource {
     protected manifest: iiif3.Manifest | iiif2.Manifest | undefined;
     label(): string;
     getIIIFImageUrls(): Promise<string[]>;

package/dist/types/lib/resources/iiif-manifest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/resources/iiif.d.ts

@@ -0,0 +1,5 @@
+import Resource from './resource';
+export default class IIIFResource extends Resource {
+    label(): string;
+    getIIIFImageUrls(): Promise<string[]>;
+}

package/dist/types/lib/{sources/maplibre.d.ts → resources/map.d.ts}

@@ -1,6 +1,6 @@
 import type { SourceSpecification } from 'maplibre-gl';
-import Source from './source';
-export default abstract class MapLibreSource extends Source {
+import Resource from './resource';
+export default abstract class MapResource extends Resource {
     getMapLibreSourceUrl(): string;
     abstract isVector(): Promise<boolean>;
     abstract getMapLibreSourceType(): Promise<SourceSpecification['type']>;

package/dist/types/lib/resources/openindexmap.d.ts

@@ -0,0 +1,5 @@
+import GeoJsonResource from './geojson';
+export default class OpenIndexMapResource extends GeoJsonResource {
+    getVectorLayers(): Promise<string[]>;
+    label(): string;
+}

package/dist/types/lib/{sources → resources}/pmtiles.d.ts

@@ -1,5 +1,5 @@
 import { Header } from 'pmtiles';
-import Source from './source';
+import Resource from './resource';
 import { type LngLatBoundsLike } from 'maplibre-gl';
 interface VectorLayer {
     id: string;
@@ -8,7 +8,7 @@ interface Metadata {
     type?: string;
     vector_layers: VectorLayer[];
 }
-export default class PMTilesSource extends Source {
+export default class PMTilesResource extends Resource {
     private archive;
     private metadata;
     private header;

package/dist/types/lib/{sources → resources}/raster.d.ts

@@ -1,5 +1,5 @@
-import MapLibreSource from './maplibre';
-export default abstract class RasterSource extends MapLibreSource {
+import MapResource from './map';
+export default abstract class RasterResource extends MapResource {
     isVector(): Promise<boolean>;
     getTileSize(): number | undefined;
     getMapLibreSourceType(): Promise<"raster">;

package/dist/types/lib/{sources/source.d.ts → resources/resource.d.ts}

@@ -1,5 +1,5 @@
 import type { LngLatBoundsLike } from 'maplibre-gl';
-export default abstract class Source {
+export default abstract class Resource {
     url: string;
     protected bounds: LngLatBoundsLike | undefined;
     id: string;

package/dist/types/lib/{sources → resources}/tilejson.d.ts

@@ -1,10 +1,13 @@
-import Source from './source';
-export default class TileJSONSource extends Source {
+import MapResource from './map';
+export default class TileJsonResource extends MapResource {
     private metadata;
     label(): string;
+    getMapLibreSourceUrl(): string;
+    getScheme(): any;
     protected getMetadata(): Promise<any>;
     isVector(): Promise<boolean>;
     getBounds(): Promise<import("maplibre-gl").LngLatBoundsLike>;
+    getTileSize(): Promise<number>;
     getVectorLayers(): Promise<any>;
     getVectorEncoding(): Promise<"mvt" | "mlt">;
     getMapLibreSourceType(): Promise<"vector" | "raster">;

package/dist/types/lib/resources/tms.d.ts

@@ -0,0 +1,5 @@
+import RasterResource from './raster';
+export default class TmsResource extends RasterResource {
+    label(): string;
+    getScheme(): "tms";
+}

package/dist/types/lib/{sources → resources}/vector.d.ts

@@ -1,6 +1,6 @@
 import { SourceSpecification } from 'maplibre-gl';
-import MapLibreSource from './maplibre';
-export default abstract class VectorSource extends MapLibreSource {
+import MapResource from './map';
+export default abstract class VectorResource extends MapResource {
     isVector(): Promise<boolean>;
     getMapLibreSourceType(): Promise<SourceSpecification['type']>;
     abstract getVectorLayers(): Promise<string[]>;

package/dist/types/lib/{sources → resources}/wms.d.ts

@@ -1,15 +1,22 @@
 import { type LngLatBoundsLike } from 'maplibre-gl';
-import RasterSource from './raster';
+import RasterResource from './raster';
 type WmsOptions = {
     layerIds: string[];
     bbox?: string;
-    srs?: string;
+    crs?: string;
     tileSize?: number;
     format?: string;
     transparent?: boolean;
     version?: string;
 };
-export default class WmsSource extends RasterSource {
+export type GetFeatureInfoOptions = {
+    bbox: string;
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+};
+export default class WmsResource extends RasterResource {
     private options;
     private metadata;
     constructor(id: string, url: string, options: WmsOptions, bounds?: LngLatBoundsLike);
@@ -18,7 +25,10 @@ export default class WmsSource extends RasterSource {
     getMapLibreSourceUrl(): string;
     getScheme(): any;
     getTileSize(): number;
-    private get tilesUrl();
-    private get capabilitiesUrl();
+    inspect(options: GetFeatureInfoOptions): Promise<Response>;
+    protected get tilesUrl(): string;
+    protected inspectUrl(inspectOptions: GetFeatureInfoOptions): string;
+    protected get isVersion130(): boolean;
+    protected get capabilitiesUrl(): string;
 }
 export {};

package/dist/types/lib/resources/wms.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/resources/wmts.d.ts

@@ -0,0 +1,59 @@
+import { type LngLatBoundsLike, type RasterSourceSpecification } from 'maplibre-gl';
+import RasterResource from './raster';
+export type WmtsOptions = {
+    layerIds: string[];
+    tileSize?: number;
+};
+export type Bounds = NonNullable<RasterSourceSpecification['bounds']>;
+export type WmtsLayer = {
+    id: string;
+    title: string;
+    tileUrls: string[];
+    tileSize: number;
+    minzoom: number;
+    maxzoom: number;
+    bounds?: Bounds;
+};
+type XyzGrid = {
+    tileSize: number;
+    minzoom: number;
+    maxzoom: number;
+    levelPrefix: string;
+};
+type TileMatrixSet = {
+    id: string;
+    crs: string;
+    grid?: XyzGrid;
+};
+type TileMatrix = {
+    zoom: number;
+    prefix: string;
+    tileWidth: number;
+    tileHeight: number;
+    matrixWidth: number;
+    matrixHeight: number;
+    topLeft: number[];
+};
+export default class WmtsResource extends RasterResource {
+    private options;
+    private metadata;
+    constructor(id: string, url: string, options: WmtsOptions, bounds?: LngLatBoundsLike);
+    label(): string;
+    protected getMetadata(): Promise<Document>;
+    getLayers(): Promise<WmtsLayer[]>;
+    protected isRequested(element: Element): boolean;
+    protected createLayer(element: Element, tileMatrixSets: Map<string, TileMatrixSet>): WmtsLayer | undefined;
+    protected parseBounds(element: Element): Bounds | undefined;
+    protected recordBounds(): Bounds | undefined;
+    protected boundsMinzoom(bounds: Bounds | undefined): number;
+    protected preferKnownHost(templates: string[]): string[];
+    protected getLinkedTileMatrixSets(element: Element, tileMatrixSets: Map<string, TileMatrixSet>): TileMatrixSet[];
+    protected getTileMatrixSets(metadata: Document): Map<string, TileMatrixSet>;
+    protected parseTileMatrixSet(element: Element): TileMatrixSet | undefined;
+    protected parseXyzGrid(element: Element, crs: string): XyzGrid | undefined;
+    protected parseTileMatrix(element: Element): TileMatrix | undefined;
+    protected formatTileUrl(template: string, style: string, tileMatrixSet: TileMatrixSet, dimensionDefaults?: Record<string, string>): string;
+    protected unsupportedGridMessage(elements: Element[], tileMatrixSets: Map<string, TileMatrixSet>): string;
+    getScheme(): "xyz";
+}
+export {};

package/dist/types/lib/resources/wmts.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/resources/xyz.d.ts

@@ -0,0 +1,5 @@
+import RasterResource from './raster';
+export default class XyzResource extends RasterResource {
+    label(): string;
+    getScheme(): "xyz";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ogm-viewer",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "A web-based viewer for previewing OpenGeoMetadata records",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",

package/readme.md

@@ -109,6 +109,7 @@ After tagging, build the project and publish it to npm:
 
 ```bash
 npm run build
+npm login
 npm publish
 ```
 

package/dist/collection/lib/previewers/maplibre.js

@@ -1,56 +0,0 @@
-import Previewer from "./previewer";
-export default class MapLibrePreviewer extends Previewer {
-    // Store reference to the map and styles
-    style;
-    map;
-    // Stored state for added source and layers to allow for cleanup
-    sourceId = null;
-    layerIds = [];
-    // Current opacity state
-    opacity;
-    // Initialize with opacity at the theme's opacity value
-    constructor(source, map, style) {
-        super(source);
-        this.map = map;
-        this.style = style;
-        this.opacity = this.style.opacity;
-    }
-    // Add source and preview layers if they don't already exist
-    async preview() {
-        if (!this.sourceId) {
-            if (this.map.getSource(this.getSourceId())) {
-                return;
-            }
-            const source = await this.createSource();
-            this.map.addSource(this.getSourceId(), source);
-            this.sourceId = this.getSourceId();
-        }
-        if (this.layerIds.length == 0) {
-            const layers = await this.createLayers();
-            layers.forEach(layer => {
-                if (this.map.getLayer(layer.id)) {
-                    return;
-                }
-                this.map.addLayer(layer);
-                this.layerIds.push(layer.id);
-            });
-        }
-    }
-    // Remove preview layers and source
-    async clearPreview() {
-        this.layerIds.forEach(layerId => {
-            if (this.map.getLayer(layerId)) {
-                this.map.removeLayer(layerId);
-            }
-        });
-        this.layerIds = [];
-        if (this.sourceId && this.map.getSource(this.getSourceId())) {
-            this.map.removeSource(this.getSourceId());
-            this.sourceId = null;
-        }
-    }
-    // Unique name for the MapLibre source; default to provided source ID
-    getSourceId() {
-        return this.source.id;
-    }
-}