geoai 0.0.7 → 1.0.0-rc.2

package/CHANGELOG.md

@@ -1,10 +1,39 @@
 # Changelog
 
-All notable changes to the @geobase.js/geoai project will be documented in this file.
+All notable changes to the geoai project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0-rc.1] - 2024-01-XX
+
+### Release Candidate
+This is the first release candidate for version 1.0.0. This RC includes all the features and improvements planned for the final 1.0.0 release.
+
+## [1.0.0-rc.2] - 2025-01-XX
+
+### Release Candidate
+- Bug fixes and improvements
+- Minor documentation updates and example references to the new RC version.
+- Internal release scripts updated to support rc.2 flow.
+- No functional changes to the library API.
+
+## [1.0.0] - 2024-01-XX
+
+### Changed
+- **BREAKING**: Renamed package from `geoai-js` to `geoai`
+- Updated all import statements and package references
+- Updated build output structure from `geoai-js.js` to `geoai.js`
+- Updated documentation and examples
+- Updated repository URLs and homepage
+
+### Migration Guide
+To migrate from the old package:
+1. Update your package.json: `"geoai-js": "^0.0.7"` → `"geoai": "^1.0.0"`
+2. Update all import statements: `import { geoai } from "geoai"` → `import { geoai } from "geoai"`
+3. Update any build configurations that reference the old package name
+4. Update any documentation or scripts that reference the old package
+
 ## [0.0.7] - 2024-12-19
 
 ### Fixed
@@ -27,7 +56,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial public release of @geobase.js/geoai
+- Initial public release of geoai
 - Support for multiple Geo AI models:
   - Object Detection
   - Building Footprint Segmentation

package/LICENSE.md

@@ -1,9 +1,9 @@
 MIT License
 
-Copyright (c) 2022 Kamil Bysiec
+Copyright (c) 2025 SpacialDB UG (Decision Labs)
 
-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:
+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.
+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.

package/README.md

@@ -1,26 +1,67 @@
-[![Main](https://github.com/decision-labs/geobase.js/actions/workflows/main.yml/badge.svg)](https://github.com/decision-labs/geobase.js/actions/workflows/main.yml)
+<h1 align="center">
+  GeoAI <img src="https://cdn-icons-png.flaticon.com/256/5968/5968292.png" alt="JavaScript logo" height="24" style="vertical-align:middle" />
+</h1>
 
-# `@geobase.js/geoai`
+<p align="center" style="margin-top:8px;">A lightweight JavaScript library for running Geo AI models in frontend applications.</p>
 
-A Javascript library for running Geo AI models in frontend applications.
+<p align="center" style="margin:12px 0;">
+  <a href="https://www.npmjs.com/package/geoai"><img alt="npm version" src="https://img.shields.io/npm/v/geoai.svg"></a>
+  <a href="https://github.com/decision-labs/geoai.js/actions/workflows/main.yml" style="margin-left:6px"><img alt="main" src="https://github.com/decision-labs/geoai.js/actions/workflows/main.yml/badge.svg"></a>
+  <a href="https://www.npmjs.com/package/geoai" style="margin-left:6px"><img alt="npm downloads" src="https://img.shields.io/npm/dm/geoai.svg"></a>
+  <a href="https://docs.geobase.app/geoai" style="margin-left:6px"><img alt="docs" src="https://img.shields.io/badge/docs-online-blue"></a>
+</p>
 
-## Installation
+<div align="center" style="margin: 20px 0;">
+  <div style="border-radius: 16px; box-shadow: 0 8px 32px rgba(0, 0, 0, 0.12); overflow: hidden; display: inline-block; border: 2px solid white;">
+    <video width="120%" max-width="1200px" autoplay muted loop style="display: block; object-fit: cover; object-position: center;">
+      <source src="https://docs.geobase.app/geoai-live/video/image-feature-extraction-sm.mp4" type="video/mp4">
+      Your browser does not support the video tag.
+    </video>
+  </div>
+</div>
+
+### Quick install
+
+### NPM Package
+
+[![npm version](https://img.shields.io/npm/v/geoai.svg)](https://www.npmjs.com/package/geoai)
+[![npm downloads](https://img.shields.io/npm/dm/geoai.svg)](https://www.npmjs.com/package/geoai)
 
 ```bash
-npm install @geobase.js/geoai
+npm i geoai
+```
+
+📦 **Package Links:**
+- [npm package](https://www.npmjs.com/package/geoai)
+- [jsDelivr CDN](https://www.jsdelivr.com/package/npm/geoai)
+
+### CDN (Browser)
+
+You can also use GeoAI directly in the browser via CDN:
+
+#### Unpkg CDN
+```html
+<script src="https://unpkg.com/geoai@1.0.0-rc.2/geoai.js"></script>
+```
+
+#### jsDelivr CDN
+```html
+<script src="https://cdn.jsdelivr.net/npm/geoai@1.0.0-rc.2/geoai.min.js"></script>
 ```
 
+When using CDN, the library is available globally as `geoai`.
+
 ## Usage
 
 ### Core Library (Node.js and Browser)
 
+#### NPM Installation
 ```javascript
-import { geoai } from "@geobase.js/geoai";
+import { geoai } from "geoai";
 
-// Initialize the pipeline
+// Initialize the pipeline with ESRI provider (no API key required)
 const pipeline = await geoai.pipeline([{ task: "object-detection" }], {
-  provider: "geobase",
-  apikey: "your-api-key",
+  provider: "esri",
 });
 
 // Run inference
@@ -34,34 +75,90 @@ const result = await pipeline.inference({
 });
 ```
 
-## Architecture
+#### CDN Usage
+```javascript
+// When using CDN, geoai is available globally
+const pipeline = await geoai.pipeline([{ task: "object-detection" }], {
+  provider: "esri",
+});
 
-- **Core Module** (`@geobase.js/geoai`): Pure Javascript/TypeScript library that works in both Node.js and browser environments
+const result = await pipeline.inference({
+  inputs: {
+    polygon: geoJsonFeature,
+  },
+  mapSourceParams: {
+    zoomLevel: 18,
+  },
+});
+```
 
-## API Reference
+### React Hooks
 
-### Core API
+```javascript
+import { useGeoAIWorker } from "geoai/react";
+
+function MyComponent() {
+  const { inference, isLoading, error } = useGeoAIWorker({
+    tasks: ["object-detection"],
+    provider: "esri", // No API key required for ESRI
+  });
+
+  const handleInference = async () => {
+    const result = await inference({
+      inputs: { polygon: geoJsonFeature },
+      mapSourceParams: { zoomLevel: 18 },
+    });
+  };
+
+  return (
+    <div>
+      <button onClick={handleInference} disabled={isLoading}>
+        {isLoading ? "Processing..." : "Run Detection"}
+      </button>
+      {error && <div>Error: {error.message}</div>}
+    </div>
+  );
+}
+```
 
-- `geoai.pipeline(tasks, config)` - Initialize a pipeline with tasks
-- `pipeline.inference(params)` - Run inference with the pipeline
+## Features
 
+- **Multiple AI Tasks**: Object detection, segmentation, classification, and more
+- **Map Provider Support**: Geobase, Mapbox, ESRI, and Google Maps
+- **React Integration**: Hooks for easy React integration
+- **TypeScript Support**: Full TypeScript definitions
+- **Web Worker Support**: Run AI models in background threads
+- **Optimized Performance**: Efficient model loading and inference
+- **CDN Ready**: Available via npm and popular CDNs (unpkg, jsDelivr)
 
 ## Supported Tasks
 
 - Object Detection
-- Building Footprint Segmentation
-- Land Cover Classification
-- Zero-shot Object Detection
-- Oriented Object Detection
-- Oil Storage Tank Detection
+- Building Detection
+- Car Detection
 - Ship Detection
 - Solar Panel Detection
+- Oil Storage Tank Detection
+- Land Cover Classification
 - Wetland Segmentation
+- Building Footprint Segmentation
 - Mask Generation
-- Car-Detection
+- Zero-shot Object Detection
+- Zero-shot Segmentation
+- Image Feature Extraction
+
+For more see the [supported tasks](https://docs.geobase.app/geoai/supported-tasks)
+
+## Documentation
+
+Visit [docs.geobase.app/geoai](https://docs.geobase.app/geoai) for comprehensive documentation, examples, and API reference.
+
+## Contributing
+
+We welcome contributions! Please see our [contributing guide](CONTRIBUTING.md) for details.
 
 ## License
 
-MIT
+MIT License - see [LICENSE.md](LICENSE.md) for details.
 
-~~togglebuild~~
+[//]: <> (Toggle CI on)