esri-gl 0.9.0-alpha.10

package/LICENSE

@@ -0,0 +1,227 @@
+   -------------------------------------------------------------------------------
+
+   MIT License
+
+   Copyright (c) 2025 esri-gl
+
+   Permission is hereby granted, free of charge, to any person obtaining a copy
+   of this software and associated documentation files (the "Software"), to deal
+   in the Software without restriction, including without limitation the rights
+   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   copies of the Software, and to permit persons to whom the Software is
+   furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in all
+   copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+   SOFTWARE.
+
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-2025 - FrontierSI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,455 @@
+# esri-gl
+
+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
+
+### Supported Services
+
+- **Dynamic Map Services** - Server-rendered raster tiles from ArcGIS Map Services
+- **Tiled Map Services** - Pre-cached tile services for optimal performance  
+- **Image Services** - Analytical raster data with server-side processing
+- **Vector Tile Services** - Client-rendered vector tiles for fast styling
+- **Vector Basemap Styles** - Esri's vector basemap styles with custom styling
+- **Feature Services** - Vector data with smart vector tile detection and GeoJSON fallback
+
+### Advanced Features
+
+- **Smart Vector Tile Detection** - Automatically detects vector tile endpoints with GeoJSON fallback
+- **Dynamic Layer Management** - Add/remove layers dynamically with proper cleanup
+- **Identify Tasks** - Query features and raster data at specific locations
+- **Bounding Box Filtering** - Optimize performance with viewport-based data loading  
+- **Layer Definitions** - Filter data server-side using SQL-like expressions
+- **Time-aware Services** - Support for temporal data visualization
+- **Attribution Management** - Automatic service attribution handling
+- **TypeScript Support** - Full type safety with comprehensive interfaces
+
+## Installation
+
+### Stable Release
+```bash
+npm install esri-gl
+```
+
+### Alpha/Beta Releases
+```bash
+# Latest alpha release (current: v0.1.0-alpha.2)
+npm install esri-gl@alpha
+
+# Specific alpha version
+npm install esri-gl@0.1.0-alpha.2
+
+# Latest beta release  
+npm install esri-gl@beta
+```
+
+### GitHub Packages (Alternative Registry)
+```bash
+# Configure npm to use GitHub Packages for @muimsd scope
+npm config set @muimsd:registry https://npm.pkg.github.com/
+
+# Install from GitHub Packages
+npm install @muimsd/esri-gl
+
+# Or use the setup script
+./scripts/github-packages.sh configure
+./scripts/github-packages.sh install
+```
+
+## Quick Start
+
+### Basic Usage with MapLibre GL JS
+
+```typescript
+import { Map } from 'maplibre-gl';
+import { DynamicMapService, VectorTileService, FeatureService } from 'esri-gl';
+
+const map = new Map({
+  container: 'map',
+  style: 'https://demotiles.maplibre.org/style.json',
+  center: [-95, 37],
+  zoom: 4
+});
+
+map.on('load', () => {
+  // Add a dynamic map service
+  const dynamicService = new DynamicMapService('census-source', map, {
+    url: 'https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer'
+  });
+
+  map.addLayer({
+    id: 'census-layer',
+    type: 'raster',
+    source: 'census-source'
+  });
+
+  // Add a feature service with smart vector tile detection
+  const featureService = new FeatureService('parcels-source', map, {
+    url: 'https://services.arcgis.com/.../FeatureServer/0',
+    useVectorTiles: true, // Automatically detects and falls back to GeoJSON if needed
+    useBoundingBox: true, // Optimize with viewport filtering
+    where: "STATUS = 'Active'", // Server-side filtering
+    outFields: '*'
+  });
+
+  map.addLayer({
+    id: 'parcels-layer',
+    type: 'fill',
+    source: 'parcels-source',
+    paint: {
+      'fill-color': '#007cbf',
+      'fill-opacity': 0.5
+    }
+  });
+});
+```
+
+### Using with Mapbox GL JS
+
+```typescript
+import mapboxgl from 'mapbox-gl';
+import { VectorBasemapStyle, ImageService } from 'esri-gl';
+
+mapboxgl.accessToken = 'your-mapbox-token';
+
+const map = new mapboxgl.Map({
+  container: 'map',
+  center: [-95, 37],
+  zoom: 4
+});
+
+map.on('load', () => {
+  // Add Esri vector basemap style
+  const basemapService = new VectorBasemapStyle('basemap-source', map, {
+    style: 'arcgis/streets'
+  });
+
+  // Add image service for analytical raster data
+  const imageService = new ImageService('elevation-source', map, {
+    url: 'https://sampleserver6.arcgisonline.com/arcgis/rest/services/Elevation/ImageServer',
+    renderingRule: {
+      rasterFunction: 'Hillshade'
+    }
+  });
+
+  map.addLayer({
+    id: 'elevation-layer',
+    type: 'raster',
+    source: 'elevation-source'
+  });
+});
+```
+
+## Service Classes
+
+### DynamicMapService
+Server-rendered raster tiles from ArcGIS Map Services.
+
+```typescript
+const service = new DynamicMapService('source-id', map, {
+  url: 'https://example.com/arcgis/rest/services/MyService/MapServer',
+  layers: [0, 1, 2], // Specific layers to display
+  layerDefs: {
+    0: "POP2000 > 100000", // Filter layer 0
+    1: "STATE_NAME = 'California'" // Filter layer 1
+  },
+  transparent: true,
+  format: 'png32'
+});
+```
+
+### TiledMapService  
+Pre-cached tile services for optimal performance.
+
+```typescript
+const service = new TiledMapService('source-id', map, {
+  url: 'https://example.com/arcgis/rest/services/MyTiledService/MapServer'
+});
+```
+
+### FeatureService
+Vector data with intelligent vector tile detection and automatic GeoJSON fallback.
+
+```typescript
+const service = new FeatureService('source-id', map, {
+  url: 'https://example.com/arcgis/rest/services/MyService/FeatureServer/0',
+  useVectorTiles: true, // Smart detection with fallback
+  useBoundingBox: true, // Viewport-based loading
+  where: '1=1',
+  outFields: '*',
+  maxRecordCount: 2000
+});
+```
+
+### VectorTileService
+Client-rendered vector tiles for fast styling and interaction.
+
+```typescript
+const service = new VectorTileService('source-id', map, {
+  url: 'https://example.com/arcgis/rest/services/MyService/VectorTileServer'
+});
+```
+
+### ImageService
+Analytical raster data with server-side processing capabilities.
+
+```typescript
+const service = new ImageService('source-id', map, {
+  url: 'https://example.com/arcgis/rest/services/MyImageService/ImageServer',
+  renderingRule: {
+    rasterFunction: 'Stretch',
+    rasterFunctionArguments: {
+      StretchType: 6,
+      NumberOfStandardDeviations: 2
+    }
+  },
+  mosaicRule: {
+    mosaicMethod: 'esriMosaicLockRaster',
+    lockRasterIds: [1, 2, 3]
+  }
+});
+```
+
+### VectorBasemapStyle
+Esri's vector basemap styles with customization options.
+
+```typescript
+const service = new VectorBasemapStyle('source-id', map, {
+  style: 'arcgis/streets', // or 'arcgis/navigation', 'arcgis/topographic', etc.
+  language: 'en',
+  worldview: 'USA'
+});
+```
+
+## Task-Based Operations
+
+Modeled after Esri Leaflet's chainable task pattern for querying and identifying features.
+
+### IdentifyFeatures
+Query vector features at specific locations.
+
+```typescript
+import { IdentifyFeatures } from 'esri-gl';
+
+const identifyService = new IdentifyFeatures({
+  url: 'https://example.com/arcgis/rest/services/MyService/MapServer'
+});
+
+// Identify features at a point
+const results = await identifyService
+  .at({ lng: -95, lat: 37 })
+  .tolerance(5)
+  .layers('all')
+  .returnGeometry(true)
+  .run(map);
+
+console.log('Identified features:', results);
+```
+
+### IdentifyImage
+Query raster values from image services.
+
+```typescript
+import { identifyImage } from 'esri-gl';
+
+const results = await identifyImage({
+  url: 'https://example.com/arcgis/rest/services/Elevation/ImageServer'
+}).at({ lng: -120, lat: 40 });
+
+console.log('Elevation value:', results.value);
+```
+
+### Query
+Advanced feature querying with spatial and attribute filters.
+
+```typescript
+import { query } from 'esri-gl';
+
+const results = await query({
+  url: 'https://example.com/arcgis/rest/services/MyService/FeatureServer/0'
+})
+.where("STATE_NAME = 'California'")
+.intersects({
+  type: 'Point',
+  coordinates: [-118, 34]
+})
+.run();
+```
+
+## Advanced Features
+
+### Dynamic Layer Management
+
+```typescript
+// Add layers dynamically
+const service = new DynamicMapService('census-source', map, {
+  url: 'https://example.com/MapServer'
+});
+
+// Update visible layers
+service.setLayers([0, 2, 5]);
+
+// Update layer definitions
+service.setLayerDefs({
+  0: "POP2000 > 50000",
+  2: "STATE_NAME IN ('California', 'Nevada')"
+});
+
+// Clean up
+service.remove();
+```
+
+### Smart Vector Tile Detection
+
+The `FeatureService` automatically detects vector tile availability:
+
+```typescript
+const service = new FeatureService('smart-source', map, {
+  url: 'https://example.com/FeatureServer/0',
+  useVectorTiles: true // Will automatically:
+  // 1. Check for VectorTileServer endpoint
+  // 2. Test various URL patterns
+  // 3. Fall back to GeoJSON if vector tiles unavailable
+  // 4. Log the decision process to console
+});
+```
+
+### Performance Optimization
+
+```typescript
+const service = new FeatureService('optimized-source', map, {
+  url: 'https://example.com/FeatureServer/0',
+  useBoundingBox: true, // Only load features in current viewport
+  maxRecordCount: 1000, // Limit records per request
+  where: 'STATUS = "Active"', // Server-side filtering
+  outFields: ['OBJECTID', 'NAME', 'STATUS'] // Limit fields
+});
+```
+
+## Development
+
+### Build System
+- **Library Build**: Rollup with `@rollup/plugin-typescript` (UMD + ESM outputs)
+- **Type Declarations**: Consolidated in `dist/types/` directory
+- **Demo Development**: Vite dev server  
+- **Documentation**: Docusaurus build system
+- **Test Coverage**: 92.94% with 651 focused test cases
+
+### Development Commands
+
+```bash
+# Start demo development server
+npm run dev
+
+# Build library (both UMD and ESM)
+npm run build
+
+# Watch mode for library development  
+npm run build:watch
+
+# Type checking
+npm run type-check
+
+# Linting and formatting
+npm run lint
+npm run format
+
+# Run tests
+npm run test
+npm run test:watch
+npm run test:coverage
+
+# Build documentation
+npm run build-docs
+npm run dev:docs
+```
+
+### Project Structure
+
+```
+src/
+├── Services/           # Core service classes
+│   ├── DynamicMapService.ts
+│   ├── FeatureService.ts
+│   ├── ImageService.ts
+│   ├── TiledMapService.ts
+│   ├── VectorTileService.ts
+│   └── VectorBasemapStyle.ts
+├── Tasks/             # Task-based operations
+│   ├── Find.ts
+│   ├── IdentifyFeatures.ts
+│   ├── IdentifyImage.ts
+│   └── Query.ts
+├── demo/              # Demo React components
+├── tests/             # Comprehensive test suite (92.94% coverage)
+└── types.ts           # TypeScript interfaces
+
+dist/
+├── types/             # Consolidated TypeScript declarations
+├── esri-gl.js         # UMD build
+├── esri-gl.esm.js     # ESM build  
+└── esri-gl.min.js     # Minified UMD build
+```
+
+## Browser Support
+
+- **Modern Browsers**: Chrome, Firefox, Safari, Edge (ES2018+)
+- **MapLibre GL JS**: v2.0+ (recommended), v1.15+
+- **Mapbox GL JS**: v2.0+ (recommended), v1.13+
+
+## TypeScript Support
+
+esri-gl is written in TypeScript and provides full type definitions consolidated in a single directory:
+
+```typescript
+import type { 
+  DynamicMapServiceOptions,
+  FeatureServiceOptions,
+  IdentifyResult,
+  EsriGeoJSONFeatureCollection 
+} from 'esri-gl';
+
+const options: FeatureServiceOptions = {
+  url: 'https://example.com/FeatureServer/0',
+  useVectorTiles: true,
+  where: '1=1'
+};
+```
+
+All type declarations are available in the `dist/types/` directory after building.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch: `git checkout -b feature/my-feature`
+3. Make changes and add tests
+4. Run validation: `npm run validate`
+5. Commit changes: `git commit -m 'Add new feature'`
+6. Push to branch: `git push origin feature/my-feature`
+7. Submit a pull request
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Acknowledgements
+
+- **Esri Leaflet** - Inspiration for API design and architectural patterns
+- **MapLibre GL JS** & **Mapbox GL JS** - Incredible WebGL mapping libraries
+- **Esri ArcGIS Platform** - Comprehensive GIS services and APIs
+- **[mapbox-gl-esri-sources](https://github.com/frontiersi/mapbox-gl-esri-sources/)** - Reference implementation for Esri service integration patterns