@road-labs/map-sdk 0.0.28-rc.6 → 0.0.28-rc.7

package/README.md

@@ -30,10 +30,9 @@ The `App` component accepts the following props:
 | :-------------------------- | :------- | :--------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------- |
 | `height`                    | Yes      | Both       | Both    | Height of the map container in pixels.                                                                                                                                                                                              | `-`                     |
 | `gestureHandling`           | Yes      | Both       | Both    | Google Maps SDK parameter controlling how gestures (scroll, pinch, etc.) interact with the map. Allowed values: `greedy`, `cooperative`, `none`, `auto`. We suggest a default value of `greedy`.                                        | `-`                     |
-| `authorization`             | Yes      | v2         | Both    | The public authorization key to search for locations.                                                                                                                                                                                | `-`                     |
-| `context`                   | Yes      | Both       | Both    | Context type for the map. Allowed values: `"cpo"` or `"msp"`.                                                                                                                                                                        | `-`                     |
+| `authorization`             | Yes      | v2         | Both    | The public map key. Besides granting access it decides what kind of map this is: its remote configuration carries the context (`cpo` or `msp`), the operators, publishing modes and Google Maps key. The context is never passed as a prop. On `cpo` maps the widget uses the `/1/map/cpo/*` endpoints, draws locations individually while the view holds at most 1000 of them, and colours pins and filters by the OCPP status the station reports (Faulted red, Unavailable amber, in-session blue, Available green, no report grey, a fault outranking everything else on a pin). `msp` maps keep the clustering, filters and colours the mobile apps use. | `-`                     |
 | `version`                   | No       | Both       | Both    | Which version of the map SDK do you wish to use.                                                                                                                                                                                     | `v1`                    |
-| `language`                  | No       | Both       | Both    | Language of the widget. Supported values: `en`. If nothing is set, it will use the browser language.                                                                                                                                | Browser language        |
+| `language`                  | No       | Both       | Both    | Language of the widget. Supported values: `en`, `nl`, `de`, `fr`, `it`, `es` and their regional variants (e.g. `nl-NL`, `de-AT`), matched case-insensitively. Unsupported values fall back to `en`. If nothing is set, the browser language is used. | Browser language        |
 | `position {lat,lng}`        | No       | Both       | Both    | Initial latitude/longitude to center the map on load. If not provided, defaults to visitor's IP-based location.                                                                                                                      | Visitor IP location     |
 | `useBrowserLocation`        | No       | Both       | Both    | Use the browser location to center the map.                                                                                                                                                                                          | `false`                 |
 | `enableZoomControls`        | No       | Both       | Both    | Whether to display zoom (+/-) controls in the bottom-right corner.                                                                                                                                                                   | `false`                 |
@@ -41,7 +40,7 @@ The `App` component accepts the following props:
 | `enablePlacesSearch`        | No       | Both       | Both    | Enables address search input at the top of the map.                                                                                                                                                                                  | `true`                  |
 | `locationId`                | No       | Both       | Both    | If provided, the map will zoom to the given `locationId` and open its sidebar (if enabled). Overrides `position`.                                                                                                                    | `-`                     |
 | `locationBaseUrl`           | No       | Both       | Both    | Base URL for location data. When set, the location name links to `locationBaseUrl/{locationId}`.                                                                                                                                     | `-`                     |
-| `locationUrlTemplate`       | No       | v2         | cpo     | URL template that makes the location name in the details view a clickable link, opening in a new tab. The `{{locationId}}` placeholder is replaced with the location id (e.g. `https://example.com/loc/{{locationId}}/details`). Applies only when `context` is `cpo`. Takes precedence over `locationBaseUrl`. | `-`                     |
+| `locationUrlTemplate`       | No       | v2         | cpo     | URL template that makes the location name in the details view a clickable link, opening in a new tab. The `{{locationId}}` placeholder is replaced with the location id (e.g. `https://example.com/loc/{{locationId}}/details`). Applies only when the map key's context is `cpo`. Takes precedence over `locationBaseUrl`. | `-`                     |
 | `apiRoot`                   | No       | Both       | Both    | The root URL of the API.                                                                                                                                                                                                             | `-`                     |
 | `googleApiKey`              | No       | Both       | Both    | Google Maps API key. If not provided, you can set your own Google API key.                                                                                                                                                            | `-`                     |
 | `theming {}`                | No       | Both       | Both    | Controls widget look and feel with keys: `brandColor`, `backgroundColor`, `textColor`, `borderColor`, `fontFamily`. Accepts HEX values (e.g. `#ff3d00`). If `backgroundColor` is provided without `shadowRoot`, a shadow root will be automatically created. | `-`                     |
@@ -49,11 +48,10 @@ The `App` component accepts the following props:
 | `sdkRoot`                   | No       | Both       | Both    | Root URL for SDK CSS file. Required when using automatic shadow root creation with theming (when `theming` is provided without `shadowRoot`). The stylesheet will be loaded from `sdkRoot + "/styles.css"`.                          | `-`                     |
 | `limitToLocationIds`        | No       | v2         | Both    | Constrains the map to only show the locations with the configured IDs. Provided that they exist in the dataset.                                                                                                                      | All available locations |
 | `preferredOperators`        | No       | v2         | Both    | Array of operator names. Ensures that the selected operators appear at the top of the operator selector dropdown.                                                                                                                   | `[]`                    |
-| `operators`                 | No       | v2         | Both    | Array of available operators.                                                                                                                                                                                                        | `-`                     |
-| `publishingMode`            | No       | v2         | Both    | Array of available publishing modes. Allowed values: `"PUBLISHING_MODE_PUBLIC"`, `"PUBLISHING_MODE_PRIVATE"`.                                                                                                                         | `-`                     |
 | `showNoAdditionalFeeFilter` | No       | v2         | msp     | Used to configure whether we enable the user to filter out stations that come with additional fees.                                                                                                                                  | `false`                 |
 | `showPublishingModeFilter`  | No       | v2         | cpo     | Used to configure whether we enable the user to filter out public or private stations.                                                                                                                                               | `false`                 |
 | `showOperatorOnly`          | No       | v2         | both    | String value representing the operator name. Include a quick filter option to find a specific operator.                                                                                                                               | `-`                     |
+| `showAnalytics`             | No       | v2         | Both    | Shows status pills next to the filter toggle for the current view and filters: EVSEs by roaming status, and on `cpo` maps a second pill with connectors by the OCPP status the station reports. Clicking a status toggles the matching status filter (the OCPP pill on `cpo` maps, the roaming pill on `msp` maps) and the selected statuses are highlighted; the roaming pill on a `cpo` map is read-only because the CPO search filters on OCPP status. The counts ignore the status selection so every status in the view stays listed; all other filters apply. Fetched from `/1/map/analytics` (`/1/map/cpo/analytics` on `cpo` maps) whenever the view or filters change. Hidden on screens narrower than 768px. | `false`                 |
 | `onMarkerClicked`           | No       | Both       | Both    | Callback function that is called when a marker is clicked. Receives an object with `ids` property containing the location IDs.                                                                                                       | `-`                     |
 
 ### Example
@@ -70,7 +68,6 @@ function MyMap() {
     <App
       height={600}
       authorization="your-authorization-key"
-      context="cpo"
       gestureHandling="greedy"
       apiRoot="https://api.road.io"
       googleApiKey="your-google-maps-api-key"
@@ -85,7 +82,7 @@ function MyMap() {
 }
 ```
 
-**Note**: The `height`, `gestureHandling`, `authorization`, and `context` props are required. All other props are optional.
+**Note**: The `height`, `gestureHandling` and `authorization` props are required. All other props are optional. The map context (`cpo` or `msp`) is not a prop; it comes from the map key's remote configuration.
 
 ### Theming with Shadow DOM
 
@@ -110,7 +107,6 @@ If you don't need custom theming, you can use the SDK without Shadow DOM (simply
 <App
   height={600}
   authorization="your-authorization-key"
-  context="cpo"
   gestureHandling="greedy"
   apiRoot="https://api.road.io"
   // ... other props

package/dist/components/AnalyticsOverlay/AnalyticsOverlay.d.ts

@@ -0,0 +1 @@
+export default function AnalyticsOverlay(): import("react/jsx-runtime").JSX.Element;

package/dist/components/CustomMarker/CustomMarker.d.ts

@@ -1,10 +1,11 @@
 import { default as React } from 'react';
-import { GeohashItem } from '../../types';
+import { GeohashItem, MapKind } from '../../types';
 interface Props {
     data: GeohashItem;
     map?: google.maps.Map;
     onClick: (payload: GeohashItem) => void;
     highlight?: boolean;
+    kind?: MapKind;
 }
 declare const CustomMarker: React.FC<Props>;
 export default CustomMarker;

package/dist/contexts/Map.d.ts

@@ -1,6 +1,12 @@
 import { default as React } from 'react';
 import { LabelsType } from '../i18n';
-import { Location, Position, RoadMapOptions, Status, FilterConfiguration } from '../types';
+import { Analytics, Location, MapKind, Position, RoadMapOptions, Status, FilterConfiguration } from '../types';
+export type SearchBounds = {
+    nwLat: number;
+    nwLng: number;
+    seLat: number;
+    seLng: number;
+};
 export type MapContextType = {
     t: (key: keyof LabelsType, props?: any) => string;
     isReady: boolean;
@@ -11,6 +17,15 @@ export type MapContextType = {
         precision: any;
         bbox: any;
     }) => Promise<any>;
+    fetchAnalytics?: (args: {
+        bbox: SearchBounds;
+        [filter: string]: any;
+    }) => Promise<{
+        data: Analytics;
+    }>;
+    searchBounds?: SearchBounds;
+    setSearchBounds?: (bounds: SearchBounds) => void;
+    mapKind: MapKind;
     fetchLocations?: ({ ids }: {
         ids: any;
     }) => Promise<any>;

package/dist/i18n.d.ts

@@ -1,4 +1,4 @@
-export declare function getLanguage(lng: any): "nl" | "en" | "de" | "fr" | "it" | "es";
+export declare function getLanguage(lng?: string): "nl" | "en" | "de" | "fr" | "it" | "es";
 export type LabelsType = {
     "search.placeholder": string;
     "cdrPrice.flatFee": string;
@@ -48,6 +48,15 @@ export type LabelsType = {
     "filters.clearAll": string;
     "filters.onlyShow": string;
     "filters.statusHeading": string;
+    "evse.statusBlocked": string;
+    "evse.statusClosed": string;
+    "ocpp.statusPreparing": string;
+    "ocpp.statusSuspendedEvse": string;
+    "ocpp.statusSuspendedEv": string;
+    "ocpp.statusFinishing": string;
+    "ocpp.statusFaulted": string;
+    "analytics.roaming": string;
+    "analytics.ocpp": string;
     "filters.chargingAccessibility": string;
     "filters.accessibilityAll": string;
     "filters.accessibilityTesla": string;