@arenarium/maps 1.0.200 → 1.0.202

package/README.md

@@ -41,7 +41,7 @@ const mapManager = new arenarium.MapManager(...);
 
 ## Initialization
 
-To initialize the map, first add a container element to your HTML where the map will be rendered. Then depending on the map library used there are different instructions:
+To initialize the map, first add a container element to your HTML where the map will be rendered. Then go to the [API Keys](https://arenarium.dev/keys) page and create a new API key. Then depending on the map library used there are different instructions:
 
 ```html
 <div id="map"></div>
@@ -55,7 +55,7 @@ First, install the `maplibre-gl` library:
 npm install maplibre-gl
 ```
 
-Next, use the `MapManager` class which requires a `maplibre.Map` class, a `maplibre.Marker` class and a `MapOptions` object.
+Next, create a `MapLibreProvider` instance which requires a `maplibre.Map` class, a `maplibre.Marker` class and a `MapOptions` object. Use the `MapLibreProvider` instance, along with the API key, to initialize the map manager.
 
 ```js
 import maplibregl from 'maplibre-gl';
@@ -72,7 +72,7 @@ const maplibreProvider = new MapLibreProvider(maplibregl.Map, maplibregl.Marker,
 });
 
 // Initialize the map manager with the provider
-const mapManager = new MapManager(maplibreProvider);
+const mapManager = new MapManager("YOUR_API_KEY", maplibreProvider);
 
 // Access the maplibre instance for direct map interactions
 const maplibreMap = mapLibreProvider.getMap();
@@ -100,7 +100,7 @@ First, install the `mapbox-gl` library:
 npm install mapbox-gl
 ```
 
-Next, use the `MapManager` class which requires a `mapbox.Map` class, a `mapbox.Marker` class and a `MapOptions` object.
+Next, create a `MapboxProvider` instance which requires a `mapbox.Map` class, a `mapbox.Marker` class and a `mapbox.MapOptions` object. Use the `MapboxProvider` instance, along with the API key, to initialize the map manager.
 
 ```js
 import mapbox from 'mapbox-gl';
@@ -117,7 +117,7 @@ const mapboxProvider = new MapboxProvider(mapbox.Map, mapbox.Marker, {
 });
 
 // Initialize the map manager with the provider
-const mapManager = new MapManager(mapboxProvider);
+const mapManager = new MapManager("YOUR_API_KEY", mapboxProvider);
 
 // Access the mapbox instance for direct map interactions
 const mapboxMap = mapboxProvider.getMap();
@@ -131,7 +131,7 @@ First, install the `@googlemaps/js-api-loader` library:
 npm install @googlemaps/js-api-loader
 ```
 
-To use Google Maps, you'll need to load the Google Maps JavaScript API and create a Google Maps provider instance.
+To use Google Maps, you'll need to load the Google Maps JavaScript API and create a Google Maps provider instance. Next, create a `GoogleMapsProvider` instance which requires a `google.maps.Map` class, a `google.maps.Marker.AdvancedMarkerElement` class, and a `google.maps.MapOptions`. Use the `GoogleMapsProvider` instance, along with the API key, to initialize the map manager.
 
 ```js
 import { Loader } from '@googlemaps/js-api-loader';
@@ -158,7 +158,7 @@ const mapGoogleProvider = new GoogleMapsProvider(mapsLibrary.Map, markerLibrary.
 });
 
 // Initialize the map manager with the provider
-const mapManager = new MapManager(mapGoogleProvider);
+const mapManager = new MapManager("YOUR_API_KEY", mapGoogleProvider);
 
 // Access the Google Maps instance for direct map interactions
 const mapGoogle = mapGoogleProvider.getMap();
@@ -279,38 +279,20 @@ You can change the markers style by using the predefined CSS variables:
 --arenarium-maps-tooltip-shadow-hover: ...;
 ```
 
-## Logs
+# API
 
-Some events and errors are logged to via the api. These logs are used for debugging and monitoring purposes in order to improve the library. To enable or disable logging, set the `api.log.enabled` property to `true` or `false` in the map configuration. By default, logging is disabled for development environments.
-
-```js
-const mapManager = new MapManager(mapProvider, {
-    api: {
-        log: {
-            enabled: false
-        }
-    }
-});
-```
-
-## API
-
-While the library works out of the box, it is recommended to use the API for calculating the marker states. The calculations can be compute intensive and api could offer a more standerdized performance, and benefits from caching.
-
-To use the API, create an API key at https://arenarium.dev/keys, use the domains field to whitelist the domains you want to use the API for. Then when initializing the map manager, provide the api key:
+You can provide a your own backend URL to the map manager to use the API for calculating the marker states. For more information about the API, please feel free to reach out.
 
 ```js
 const mapManager = new MapManager(mapProvider, {
     api: {
         states: {
-            key: 'YOUR_API_KEY'
+            url: 'YOUR_BACKEND_URL'
         }
     }
 });
 ```
 
-For more information about the API, please feel free to reach out.
-
 # Examples
 
 [https://github.com/arenarium-dev/arenarium-maps-svelte-kit-example](https://github.com/arenarium-dev/arenarium-maps-svelte-kit-example)

package/dist/index.d.ts

@@ -37,23 +37,18 @@ declare const mapConfigurationSchema: z.ZodObject<{
 	api: z.ZodOptional<z.ZodObject<{
 		states: z.ZodOptional<z.ZodObject<{
 			url: z.ZodString;
-			singleRequest: z.ZodOptional<z.ZodBoolean>;
 		}, "strip", z.ZodTypeAny, {
 			url: string;
-			singleRequest?: boolean | undefined;
 		}, {
 			url: string;
-			singleRequest?: boolean | undefined;
 		}>>;
 	}, "strip", z.ZodTypeAny, {
 		states?: {
 			url: string;
-			singleRequest?: boolean | undefined;
 		} | undefined;
 	}, {
 		states?: {
 			url: string;
-			singleRequest?: boolean | undefined;
 		} | undefined;
 	}>>;
 }, "strip", z.ZodTypeAny, {
@@ -70,7 +65,6 @@ declare const mapConfigurationSchema: z.ZodObject<{
 	api?: {
 		states?: {
 			url: string;
-			singleRequest?: boolean | undefined;
 		} | undefined;
 	} | undefined;
 }, {
@@ -87,7 +81,6 @@ declare const mapConfigurationSchema: z.ZodObject<{
 	api?: {
 		states?: {
 			url: string;
-			singleRequest?: boolean | undefined;
 		} | undefined;
 	} | undefined;
 }>;
@@ -515,7 +508,6 @@ export type MapMarker = z.infer<typeof mapMarkerSchema>;
 export declare class MapManager {
 	private apiKey;
 	private apiStatesUrl;
-	private apiStatesSingleRequest;
 	private mapProvider;
 	private markerDataArray;
 	private markerDataMap;