@road-labs/map-sdk 0.0.27 → 0.0.28-rc.10

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 type PublishingMode = "PUBLISHING_MODE_PUBLIC" | "PUBLISHING_MODE_PRIVATE";
+export type MapKind = "roaming" | "cpo";
 export type FilterConfiguration = {
     showOperatorOnly?: string;
     preferredOperators: string[];
@@ -6,7 +7,35 @@ export type FilterConfiguration = {
     showPublishingModeFilter?: boolean;
     publishingMode?: PublishingMode[];
     showVehicleAvailabilityFilter?: boolean;
+    showSearchPhraseFilter?: boolean;
+    showExcludeOperatorFilter?: boolean;
+    showPaymentMethodFilter?: boolean;
     operators?: string[];
+    showAnalytics?: boolean;
+    showPriceFilter?: boolean;
+};
+export type EnergyPrice = {
+    amount: number;
+    currency: string;
+};
+export type AnalyticsBucket = {
+    name: string;
+    count: number;
+};
+export type Analytics = {
+    context: "cpo" | "msp";
+    locations: {
+        total: number;
+    };
+    evses: {
+        total: number;
+        byStatus?: AnalyticsBucket[];
+    };
+    connectors: {
+        total: number;
+        byPowerType: AnalyticsBucket[];
+        byOcppStatus?: AnalyticsBucket[];
+    };
 };
 export type RoadMapOptions = {
     gestureHandling: string;
@@ -15,13 +44,16 @@ export type RoadMapOptions = {
     enableZoomControls?: boolean;
     height: number;
     position?: Position;
+    zoomLevel?: number;
     useBrowserLocation?: boolean;
     sdkRoot?: string;
     apiRoot?: string;
     googleApiKey?: string;
     locationId?: string;
     locationBaseUrl?: string;
-    version?: "v1" | "v2";
+    locationUrlTemplate?: string;
+    version?: "v1" | "v2" | "v3";
+    currency?: string;
     authorization: string;
     language?: string;
     shadowRoot?: any;
@@ -33,7 +65,12 @@ export type RoadMapOptions = {
         fontFamily: string;
     };
     limitToLocationIds?: string[];
-    context: "cpo" | "msp";
+    infraProviderId?: string;
+    partyId?: string;
+    partyIds?: string[];
+    evseId?: string;
+    from?: string;
+    to?: string;
     onMarkerClicked?: ({ ids }: {
         ids: any;
     }) => {};
@@ -70,13 +107,12 @@ export type GeohashItem = {
         lat: number;
         lon: number;
     };
-    statuses: [
-        {
-            name: string;
-            count: number;
-        }
-    ];
+    statuses: Array<{
+        name: string;
+        count: number;
+    }>;
     count: number;
+    energyPrice?: EnergyPrice;
 };
 export type OcpiPriceComponent = {
     type: "FLAT" | "TIME" | "ENERGY" | "PARKING_TIME" | "CONGESTION_TIME";
@@ -253,6 +289,7 @@ export type OcpiLocation = {
     country_code: string;
     party_id: string;
     id: string;
+    externalId?: string;
     publish: boolean;
     publish_allowed_to?: Array<{
         uid: string;

package/dist/utils/buckets.d.ts

@@ -0,0 +1,2 @@
+import { GeohashItem } from '../types';
+export declare function mergeBuckets(existing: GeohashItem[], incoming: GeohashItem[]): GeohashItem[];

package/dist/utils/buckets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/filters.d.ts

@@ -9,5 +9,9 @@ export declare const defaultFilter: {
     powerType: any;
     operatorOnly: string;
     remoteStartStop: boolean;
+    searchPhrase: string;
+    excludeOperator: any[];
+    authMethodCapabilities: any[];
+    maxEnergyPrice: any;
 };
 export declare function hasFilters(filter: any): boolean;

package/dist/utils/filters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/formatters.d.ts

@@ -17,4 +17,4 @@ export declare function getSocketText(connector: any): string;
 export declare function formatConnectorStandard(value: any): any;
 export declare function getStatusLabel(t: MapContextType["t"], status: any): string;
 export declare function getLocationLabel(t: MapContextType["t"], location: any): string;
-export declare function getStatusColorFromEvses(evses?: any[]): "#33AC19" | "#005CEE" | "#EB001B";
+export declare function getStatusColorFromEvses(evses?: any[]): string;

package/dist/utils/i18n.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/location.d.ts

@@ -1 +1 @@
-export declare function getColorForStatus(status: any): "#33AC19" | "#005CEE" | "#EB001B";
+export declare function getColorForStatus(status: any): string;

package/dist/utils/openingTimes.d.ts

@@ -16,6 +16,8 @@ export type OpeningTimes = {
 };
 type Translate = (key: keyof LabelsType, args?: Record<string, string>) => string;
 export declare function getWeekdayLabel(t: Translate, weekday: number): string;
+export declare function getWeekdayFullLabel(language: string, weekday: number): string;
+export declare function getTodayWeekday(now?: Date): number;
 export declare function groupRegularHoursByWeekday(regularHours: RegularHours[] | undefined): Record<number, RegularHours[]>;
 export declare function formatPeriod(begin: string, end: string): string;
 export type OpenStatus = {
@@ -23,9 +25,11 @@ export type OpenStatus = {
     nextChange?: {
         time: string;
         label: "opens" | "closes";
+        day?: number;
     };
 };
 export declare function isOpenNow(openingTimes: OpeningTimes | undefined, now?: Date): OpenStatus;
 export declare function getFutureExceptionalPeriods(periods: ExceptionalPeriod[] | undefined, now?: Date): ExceptionalPeriod[];
-export declare function formatExceptionalRange(p: ExceptionalPeriod): string;
+export declare function formatExceptionalDate(language: string, dateStr: string): string;
+export declare function formatExceptionalTime(p: ExceptionalPeriod): string;
 export {};

package/dist/utils/pinState.d.ts

@@ -0,0 +1,43 @@
+import { EnergyPrice, GeohashItem, MapKind } from '../types';
+export type PinTone = "available" | "inUse" | "offline" | "fault" | "planned" | "unknown";
+export type PinGlyph = "bolt" | "ratio" | "dash" | "plus" | "alert";
+export type PinColours = {
+    ring: string;
+    text: string;
+};
+export type PinSlice = {
+    tone: PinTone;
+    ring: string;
+    fraction: number;
+};
+export type PinState = {
+    tone: PinTone;
+    colours: PinColours;
+    glyph: PinGlyph;
+    free: number;
+    total: number;
+    split: PinSlice[];
+};
+export type UnitCounts = {
+    free: number;
+    busy: number;
+    fault: number;
+    planned: number;
+    unknown: number;
+    offline: number;
+    total: number;
+};
+export declare function countUnits(statuses?: Array<{
+    name: string;
+    count: number;
+}>): UnitCounts;
+export declare function pinTone(counts: UnitCounts, kind: MapKind, cluster: boolean): PinTone;
+export declare function pinGlyph(counts: UnitCounts, tone: PinTone): PinGlyph;
+export declare function pinColours(tone: PinTone, kind: MapKind): PinColours;
+export declare function pinSplit(counts: UnitCounts, kind: MapKind): PinSlice[];
+export declare function describePin(statuses: Array<{
+    name: string;
+    count: number;
+}> | undefined, kind?: MapKind, cluster?: boolean): PinState;
+export declare function isCluster(data: Pick<GeohashItem, "count" | "ids">): boolean;
+export declare function pinPrice(data: GeohashItem): EnergyPrice | undefined;

package/dist/utils/pinState.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/price.d.ts

@@ -0,0 +1,8 @@
+import { EnergyPrice } from '../types';
+export declare function usablePrice(price?: EnergyPrice): price is EnergyPrice;
+export declare function formatEnergyPrice(language: string, price?: EnergyPrice): string | undefined;
+export type PriceTick = {
+    value: number | undefined;
+    label: string;
+};
+export declare function priceTicks(language: string, currency: string, anyLabel: string): PriceTick[];

package/dist/utils/price.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/request.d.ts

@@ -1,4 +1,4 @@
-import { RemoteConfig } from '../types';
+import { Analytics, MapKind, RemoteConfig } from '../types';
 type RequestOptionsType = {
     method?: string;
     body?: string;
@@ -9,11 +9,27 @@ type RequestOptionsType = {
     };
 };
 export declare function request(url: string, options?: RequestOptionsType): Promise<any>;
-export declare function _fetchGeohashes(apiRoot: any, version: any, authorization: any, limitToLocationIds: any, { precision, bbox, ...props }: {
+export declare function buildSearchBody(limitToLocationIds: string[], props: Record<string, any>): {
+    chargingAccessibility: any;
+    searchPhrase: any;
+    excludeOperator: any;
+    authMethodCapabilities: any;
+    currency: any;
+    maxEnergyPrice: {
+        amount: number;
+        currency: any;
+    };
+    operator?: any[];
+    locationIds: string[];
+};
+export declare function mapSearchPath(apiRoot: string, kind: MapKind, endpoint: "search" | "analytics"): string;
+export declare function _fetchGeohashes(apiRoot: any, version: any, authorization: any, limitToLocationIds: any, { precision, ...props }: {
     [x: string]: any;
     precision: any;
-    bbox: any;
-}): Promise<any>;
+}, kind?: MapKind): Promise<any>;
+export declare function _fetchAnalytics(apiRoot: any, version: any, authorization: any, limitToLocationIds: any, props: any, kind?: MapKind): Promise<{
+    data: Analytics;
+}>;
 export declare function _fetchTariffs(apiRoot: any, version: any, authorization: any, { origin, ids }: {
     origin: any;
     ids: any;

package/dist/utils/request.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/status.d.ts

@@ -0,0 +1,23 @@
+import { LabelsType } from '../i18n';
+import { MapKind } from '../types';
+export declare function normaliseStatus(status?: string): string;
+export type Palette = {
+    green: string;
+    blue: string;
+    red: string;
+    amber: string;
+    grey: string;
+};
+export declare const classicPalette: Palette;
+export declare const modernPalette: Palette;
+export declare function paletteFor(version?: string): Palette;
+export declare const inSessionStatuses: Set<string>;
+export type StatusTone = "available" | "inSession" | "fault" | "unavailable" | "unknown" | "offline";
+export declare function statusTone(status?: string, kind?: MapKind): StatusTone;
+export declare function toneColour(tone: StatusTone, kind?: MapKind, version?: string): string;
+export declare function getStatusColor(status?: string, kind?: MapKind, version?: string): string;
+export declare function getStatusLabelKey(status?: string): keyof LabelsType;
+export declare function pickMarkerColor(statuses?: Array<{
+    name: string;
+    count: number;
+}>, kind?: MapKind, version?: string): string;

package/dist/utils/status.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/statusFilters.d.ts

@@ -0,0 +1,15 @@
+import { LabelsType } from '../i18n';
+import { MapKind } from '../types';
+export type StatusFilterOption = {
+    id: string;
+    labelKey: keyof LabelsType;
+    values: string[];
+    color: string;
+};
+export declare function getStatusFilterOptions(kind?: MapKind, version?: string): StatusFilterOption[];
+export declare function toggleOption(action: "remove" | "add", existing: string[], values: string[]): string[];
+export declare function findStatusFilterOption(kind: MapKind | undefined, status: string): StatusFilterOption | undefined;
+export declare function isStatusFilterActive(kind: MapKind | undefined, selected: string[], status: string): boolean;
+export declare function toggleStatusFilter(kind: MapKind | undefined, selected: string[], status: string): string[] | undefined;
+export declare function withoutStatusFilter(filters: Record<string, any> | undefined): Record<string, any>;
+export declare function statusForLocations(kind: MapKind | undefined, status: string[] | undefined): string[] | undefined;

package/dist/utils/statusFilters.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/version.d.ts

@@ -0,0 +1,3 @@
+export type MapVersion = "v1" | "v2" | "v3";
+export declare function versionRank(version?: string): number;
+export declare function atLeast(version: string | undefined, min: MapVersion): boolean;

package/dist/utils/version.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@road-labs/map-sdk",
-  "version": "0.0.27",
+  "version": "0.0.28-rc.10",
   "description": "",
   "main": "dist/index.js",
   "module": "dist/index.mjs",