@yarrow-uz/yarrow-map-web-sdk 1.0.43 → 1.0.45

package/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+## [1.0.45] - 2026-03-12
+
+### Changed
+- Upgraded `maplibre-gl` dependency from `^5.5.0` to `^5.19.0`.
+- Migrated search API to new endpoint (`api.yarrow.uz/api/search/`) with updated query parameters (`lng`, `country`, `sort_by`, `page`, `page_size`).
+- Search results response mapping updated to new API format.
+- Search result markers now fall back to circle markers with text labels when icon images are unavailable.
+- Adjusted dark theme opacity for brand badge and map controls for a softer appearance.
+
+## [1.0.44] - 2026-02-28
+
+### Added
+- Added `apiKey` as a required configuration option.
+- Added `setYarrowApiKey()` and `getYarrowApiKey()` helper functions for API key management.
+- Added axios interceptor to automatically append `api_key` to every request.
+- Added `CHANGELOG.md` to package files for npm distribution.
+
+### Changed
+- Made `apiKey` required in `YarrowMapConfig`, `YarrowMapReactConfig`, and type definitions.
+- Enhanced brand badge and controls appearance with updated CSS properties for improved visual quality.
+- Updated `README.md` with API reference, local development instructions, and apiKey requirement.
+- Removed deprecated legacy constructor signature from YarrowMapConfig (positional arguments).
+
+### Fixed
+- Corrected layer type handling in YarrowMap class for improved functionality.
+
+## [1.0.43] - 2026-02-25
+
+### Added
+- `changeBrandBadgePosition(position)` API to update the brand badge corner at runtime.
+- Type declaration for `changeBrandBadgePosition(position: BrandBadgePosition)`.
+
+### Changed
+- Reduced brand badge `z-index` from `2147483647` to `1000` for better overlay stacking behavior.
+- Updated `README.md` with runtime brand badge positioning docs and API reference.
+
+## [1.0.42] - 2026-02-20
+
+### Added
+- Support for 6-way controls placement: `left`, `left-top`, `left-bottom`, `right`, `right-top`, `right-bottom`.
+- Automatic controls inset when controls and badge share the same corner, preventing overlap.
+- Dynamic collision recalculation using `ResizeObserver` as badge size changes.
+
+### Changed
+- Migrated brand badge asset from PNG to SVG.
+- Improved dark theme compass needle visibility for controls.
+- Updated controls positioning docs and TypeScript declarations to include new placement options.
+
+## [1.0.41] - 2026-02-19
+
+### Added
+- `addSource(sourceId, data)` for explicit GeoJSON source management.
+- `updateSourceData(sourceId, data)` to update existing source data (or create source if missing).
+- `setFeatureState(featureIdentifier, state)` to support per-feature interactive state.
+- `queryRenderedFeatures(geometryOrOptions?, options?)` passthrough support, including `{ layers: [...] }`.
+
+### Changed
+- `addLayer(...)` now supports `options.sourceId` and `options.filter`.
+- `addLayer(...)` paint typing now accepts full expression-based paint values from MapLibre style spec.
+- API docs updated in `README.md` for new source/layer/state/query capabilities.

package/README.md

@@ -40,6 +40,7 @@ This document provides a comprehensive guide to using the Yarrow Map Web SDK for
 - [Advanced Features](#advanced-features)
   - [Custom Icons and Styling](#custom-icons-and-styling)
   - [Performance Optimization](#performance-optimization)
+- [API Reference](#api-reference)
 
 ---
 
@@ -53,6 +54,10 @@ First, add the Yarrow Map Web SDK to your project using your preferred package m
 npm install @yarrow-uz/yarrow-map-web-sdk
 ```
 
+### Local Development
+
+When running your application locally, serve it on **port 8080** to avoid CORS issues with the map API. Running on any other port will cause CORS errors.
+
 ### Initialization
 
 To get started, you need to create an instance of `YarrowMap`. This requires a configuration object that specifies the container element, center coordinates, and zoom level.
@@ -88,6 +93,7 @@ The `YarrowMapConfig` class accepts a single configuration object:
 const mapConfig = new YarrowMapConfig({
   container,    // string | HTMLElement
   center,       // [number, number] - [lng, lat]
+  apiKey,       // string - Required, get from https://dashboard.yarrow.uz/
   zoom,         // number (default: 10)
   minZoom,      // number (default: 0)
   maxZoom,      // number (default: 19)
@@ -109,6 +115,7 @@ const mapConfig = new YarrowMapConfig({
   zoom: 12,
   minZoom: 5,
   maxZoom: 18,
+  apiKey: 'YOUR_API_KEY',   // Required - get from https://dashboard.yarrow.uz/
   theme: 'dark',
   cache: {
     enabled: true,         // Enable local persistent cache (default: false)
@@ -144,6 +151,7 @@ export const MapScreen = () => {
       config={{
         center: [69.2401, 41.2995],
         zoom: 12,
+        apiKey: 'YOUR_API_KEY',   // Required - get from https://dashboard.yarrow.uz/
         brandBadgePosition: 'bottom-left',
       }}
       style={{ width: '100%', height: '600px' }}
@@ -211,6 +219,7 @@ const mapConfig = new YarrowMapConfig({
   zoom: 12,
   minZoom: 5,
   maxZoom: 18,
+  apiKey: 'YOUR_API_KEY',   // Required - get from https://dashboard.yarrow.uz/
   theme: 'dark', // Set initial theme to dark
 });
 ```
@@ -1027,11 +1036,10 @@ interface SearchOptions {
 
 ## Version Information
 
-- **Current Version**: 1.0.43
-- **Dependencies**: maplibre-gl ^5.5.0, axios ^1.7.9
-- **Repository**: https://git.yarrow.uz/yarrow-sdk/frontend/yarrow-map-web-sdk
+- **Current Version**: 1.0.45
+- **Dependencies**: maplibre-gl ^5.19.0, axios ^1.7.9
 - **Changelog**: `CHANGELOG.md`
 
 ## Support
 
-For issues, questions, or contributions, please visit the project repository or contact the Yarrow development team.
+For issues, questions, or contributions, contact the Yarrow development team.

package/dist/config/main.d.ts

@@ -1,3 +1,6 @@
 declare const YARROW_MAP_URL: string;
-export { YARROW_MAP_URL };
+declare const YARROW_SEARCH_API_URL: string;
+export { YARROW_MAP_URL, YARROW_SEARCH_API_URL };
+export declare function setYarrowApiKey(apiKey: string): void;
+export declare function getYarrowApiKey(): string;
 //# sourceMappingURL=main.d.ts.map