esri-gl 0.9.0-alpha.9 → 0.9.0

package/README.md

@@ -2,19 +2,10 @@
 
 A TypeScript library that bridges Esri ArcGIS REST services with MapLibre GL JS and Mapbox GL JS. It replicates Esri Leaflet's architecture patterns while being compatible with modern WebGL mapping libraries.
 
-> **🚧 Development Notice**
-> 
-> This project is currently under active development. APIs may change between releases and some features may not be fully stable. Please use with caution in production environments and check the [changelog](CHANGES.md) for breaking changes between versions.
-
 [![npm version](https://badge.fury.io/js/esri-gl.svg)](https://badge.fury.io/js/esri-gl)
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## 🔗 Links
-
-- **📚 [Documentation](https://esri-gl.netlify.app/)** - Complete API reference and guides
-- **🎮 [Live Demos](https://esri-gl-demo.netlify.app/)** - Interactive examples and code samples
-
 **Note**: This library is compatible with both **MapLibre GL JS** and **Mapbox GL JS**.
 
 ## Features

package/dist/types/Layers/BasemapLayer.d.ts

@@ -0,0 +1,30 @@
+import { Layer, type LayerOptions } from './Layer';
+export interface BasemapLayerOptions extends LayerOptions {
+    key?: string;
+    apikey?: string;
+    token?: string;
+    language?: string;
+    worldview?: string;
+    style?: string;
+}
+/**
+ * BasemapLayer for MapLibre GL JS - equivalent to Esri Leaflet's BasemapLayer
+ * Provides access to Esri's basemap services as vector tile layers
+ */
+export declare class BasemapLayer extends Layer {
+    private static readonly BASEMAPS;
+    private config;
+    constructor(key: string | BasemapLayerOptions, options?: BasemapLayerOptions);
+    protected _createSource(): void;
+    protected _createLayer(): void;
+    /**
+     * Set the basemap key
+     */
+    setBasemap(key: string): BasemapLayer;
+    /**
+     * Get available basemap keys
+     */
+    static getAvailableBasemaps(): string[];
+}
+export declare function basemapLayer(key: string | BasemapLayerOptions, options?: BasemapLayerOptions): BasemapLayer;
+export default basemapLayer;

package/dist/types/Layers/DynamicMapLayer.d.ts

@@ -0,0 +1,75 @@
+import { RasterLayer, RasterLayerOptions } from './RasterLayer';
+import { MapService } from '../Services/MapService';
+export interface DynamicMapLayerOptions extends RasterLayerOptions {
+    url: string;
+    layers?: number[] | false;
+    layerDefs?: Record<string, string> | false;
+    timeOptions?: Record<string, unknown> | false;
+    dynamicLayers?: unknown[] | false;
+}
+/**
+ * DynamicMapLayer - Displays ArcGIS Server Map Services as raster layers
+ * Equivalent to Esri Leaflet's DynamicMapLayer but adapted for MapLibre GL JS
+ */
+export declare class DynamicMapLayer extends RasterLayer {
+    protected service: MapService;
+    constructor(options: DynamicMapLayerOptions);
+    /**
+     * Get dynamic layers
+     */
+    getDynamicLayers(): unknown[] | false;
+    /**
+     * Set dynamic layers
+     */
+    setDynamicLayers(dynamicLayers: unknown[]): DynamicMapLayer;
+    /**
+     * Get layers
+     */
+    getLayers(): number[] | false;
+    /**
+     * Set layers
+     */
+    setLayers(layers: number[] | false): DynamicMapLayer;
+    /**
+     * Get layer definitions
+     */
+    getLayerDefs(): Record<string, string> | false;
+    /**
+     * Set layer definitions
+     */
+    setLayerDefs(layerDefs: Record<string, string> | false): DynamicMapLayer;
+    /**
+     * Get time options
+     */
+    getTimeOptions(): Record<string, unknown> | false;
+    /**
+     * Set time options
+     */
+    setTimeOptions(timeOptions: Record<string, unknown> | false): DynamicMapLayer;
+    /**
+     * Create a query task
+     */
+    query(): import("../main").Query;
+    /**
+     * Create an identify task
+     */
+    identify(): import("../main").IdentifyFeatures;
+    /**
+     * Create a find task
+     */
+    find(): import("../main").Find;
+    /**
+     * Build export parameters for the service
+     */
+    protected _buildExportParams(): Record<string, unknown>;
+    /**
+     * Request export from the service
+     */
+    protected _requestExport(params: Record<string, unknown>, bounds: [number, number, number, number]): Promise<void>;
+    /**
+     * Update the layer
+     */
+    protected _update(): void;
+}
+export declare function dynamicMapLayer(options: DynamicMapLayerOptions): DynamicMapLayer;
+export default dynamicMapLayer;

package/dist/types/Layers/Layer.d.ts

@@ -0,0 +1,67 @@
+import type { Map } from '@/types';
+export interface LayerOptions {
+    url?: string;
+    opacity?: number;
+    attribution?: string;
+    interactive?: boolean;
+    zIndex?: number;
+    className?: string;
+}
+/**
+ * Base Layer class for MapLibre GL JS layers
+ * Similar to Esri Leaflet's layer functionality but adapted for MapLibre
+ *
+ * This is equivalent to Leaflet's Layer class but for MapLibre GL JS
+ */
+export declare class Layer {
+    options: LayerOptions;
+    protected _map?: Map;
+    protected _sourceId: string;
+    protected _layerId: string;
+    constructor(options?: LayerOptions);
+    /**
+     * Add layer to map
+     */
+    addTo(map: Map): Layer;
+    /**
+     * Remove layer from map
+     */
+    remove(): Layer;
+    /**
+     * Set layer opacity
+     */
+    setOpacity(opacity: number): Layer;
+    /**
+     * Get layer opacity
+     */
+    getOpacity(): number;
+    /**
+     * Set layer z-index
+     */
+    setZIndex(zIndex: number): Layer;
+    /**
+     * Get the source ID
+     */
+    getSourceId(): string;
+    /**
+     * Get the layer ID
+     */
+    getLayerId(): string;
+    /**
+     * Get attribution text
+     */
+    getAttribution(): string | undefined;
+    /**
+     * Create the source - to be implemented by subclasses
+     */
+    protected _createSource(): void;
+    /**
+     * Create the layer - to be implemented by subclasses
+     */
+    protected _createLayer(): void;
+    /**
+     * Update the source - to be implemented by subclasses
+     */
+    protected _updateSource(): void;
+}
+export default Layer;

package/dist/types/Layers/RasterLayer.d.ts

@@ -0,0 +1,71 @@
+import { Layer, type LayerOptions } from './Layer';
+import { Service } from '../Services/Service';
+export interface RasterLayerOptions extends LayerOptions {
+    service?: Service;
+    updateInterval?: number;
+    format?: string;
+    transparent?: boolean;
+    f?: string;
+    useCors?: boolean;
+    from?: Date;
+    to?: Date;
+}
+/**
+ * RasterLayer - Base class for raster-based layers like DynamicMapLayer and ImageMapLayer
+ * Equivalent to Esri Leaflet's RasterLayer but adapted for MapLibre GL JS
+ */
+export declare class RasterLayer extends Layer {
+    protected service?: Service;
+    protected _currentImage?: {
+        bounds: [number, number, number, number];
+        url: string;
+    };
+    constructor(options?: RasterLayerOptions);
+    /**
+     * Set time range for temporal data
+     */
+    setTimeRange(from: Date, to: Date): RasterLayer;
+    /**
+     * Get time range
+     */
+    getTimeRange(): [Date?, Date?];
+    /**
+     * Authenticate with token
+     */
+    authenticate(token: string): RasterLayer;
+    /**
+     * Get service metadata
+     */
+    metadata(callback: (error: Error | null, metadata?: unknown) => void): RasterLayer;
+    /**
+     * Redraw the layer
+     */
+    redraw(): RasterLayer;
+    protected _createSource(): void;
+    protected _createLayer(): void;
+    /**
+     * Update the layer - to be implemented by subclasses
+     */
+    protected _update(): void;
+    /**
+     * Build export parameters - to be implemented by subclasses
+     */
+    protected _buildExportParams(): Record<string, unknown>;
+    /**
+     * Request export - to be implemented by subclasses
+     */
+    protected _requestExport(_params: Record<string, unknown>, _bounds: [number, number, number, number]): void;
+    /**
+     * Calculate bounding box for current map view
+     */
+    protected _calculateBbox(): string;
+    /**
+     * Calculate image size for current map view
+     */
+    protected _calculateImageSize(): string;
+    /**
+     * Render image overlay
+     */
+    protected _renderImage(url: string, bounds: [number, number, number, number]): void;
+}
+export default RasterLayer;

package/dist/types/examples/EsriLeafletStyleAPI.d.ts

@@ -1,8 +1,9 @@
 /**
  * Esri Leaflet Style API Examples
  * This demonstrates how our implementation now matches Esri Leaflet exactly
- * Updated to use Services-only approach
  */
+import { DynamicMapLayer } from '../Layers/DynamicMapLayer';
 declare const service: import("../Services/SimpleMapService").MapService;
+declare const dynamicLayer: DynamicMapLayer;
 declare function exampleAsync(): Promise<void>;
-export { service, exampleAsync };
+export { service, dynamicLayer, exampleAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esri-gl",
-  "version": "0.9.0-alpha.9",
+  "version": "0.9.0",
   "type": "module",
   "description": "A module for making it easier to use Esri services in mapbox-gl or maplibre-gl.",
   "main": "dist/esri-gl.js",
@@ -102,15 +102,5 @@
   "homepage": "https://esri-gl.netlify.app",
   "demo": "https://esri-gl-demo.netlify.app",
   "author": "Muhammad Imran Siddique 2025, Rowan Winsemius 2020-2025",
-  "license": "MIT",
-  "keywords": [
-    "mapbox",
-    "maplibre",
-    "map",
-    "esri",
-    "gl",
-    "typescript",
-    "react",
-    "react-map-gl"
-  ]
+  "license": "MIT"
 }