@cloudnux/core-cloud-provider 0.2.0 → 0.5.0

package/dist/index.d.ts

@@ -131,77 +131,105 @@ interface EventMessage {
     publishedAt: Date;
 }
 
-interface LocationService {
-    /**
-     * Search for places based on a query
-     * @param query Search query
-     * @param options Search options like bounding box, filters, etc.
-     * @returns Promise containing search results
-     */
-    searchPlaces(query: string, options?: PlaceSearchOptions): Promise<PlaceSearchResult[]>;
-    /**
-     * Get detailed information about a specific place
-     * @param placeId ID of the place to get details for
-     * @returns Promise containing place details
-     */
-    getPlaceDetails(placeId: string): Promise<PlaceDetails>;
+interface LocationProviderConfig {
+    apiKey?: string;
+    region?: string;
+    language?: string;
+    countries?: string[];
+    timeout?: number;
+    retryAttempts?: number;
+    metadata?: Record<string, any>;
 }
-interface PlaceSearchOptions {
-    /** Bounding box to search within */
-    boundingBox?: {
-        minLongitude: number;
-        minLatitude: number;
-        maxLongitude: number;
-        maxLatitude: number;
-    };
-    /** Maximum number of results to return */
+interface Coordinates {
+    lat: number;
+    lng: number;
+}
+interface RoutePoint {
+    lat: number;
+    lng: number;
+    distanceFromStartKm: number;
+}
+interface SuggestionParams {
+    query: string;
     maxResults?: number;
-    /** Filter results by category */
-    categories?: string[];
-    /** Language code for results */
     language?: string;
+    countries?: string[];
+    biasPosition?: Coordinates;
+    placeTypes?: string[];
 }
-interface PlaceSearchResult {
-    /** Unique identifier for the place */
-    placeId: string;
-    /** Place name */
-    text: string;
+interface ReverseGeocodeParams {
+    coordinates: Coordinates;
+    language?: string;
+    maxResults?: number;
 }
-interface PlaceDetails extends PlaceSearchResult {
-    /** Place address */
-    address?: string;
-    /** Geographic coordinates */
-    coordinates: {
-        latitude: number;
-        longitude: number;
-    };
-    /** Distance from search center if applicable */
+interface LocationSuggestion {
+    title: string;
+    subtitle?: string;
+    coordinates?: Coordinates;
+    placeId?: string;
+    queryId?: string;
+    placeType?: string;
     distance?: number;
-    /** Place categories/types */
-    categories?: string[];
-    /** Full formatted address */
-    formattedAddress: string;
-    /** Phone number */
-    phoneNumber?: string;
-    /** Website URL */
-    website?: string;
-    /** Opening hours */
-    openingHours?: {
-        periods: {
-            day: number;
-            open?: string;
-            close?: string;
-        }[];
-        weekdayText?: string[];
-    };
-    /** Reviews if available */
-    reviews?: {
-        rating: number;
-        text?: string;
-        time?: number;
-    }[];
-    /** Additional place data */
-    additionalData?: Record<string, any>;
+    provider: string;
+    rawData?: any;
+}
+interface LocationAddress {
+    fullAddress: string;
+    street?: string;
+    streetNumber?: string;
+    city?: string;
+    district?: string;
+    region?: string;
+    postalCode?: string;
+    country?: string;
+    countryCode?: string;
+    coordinates: Coordinates;
+    placeType?: string;
+    accuracy?: number;
+    provider: string;
+    rawData?: any;
+}
+interface RouteResult {
+    totalDistanceKm: number;
+    totalDurationMinutes: number;
+    /** Route coordinates as [lng, lat] pairs for GeoJSON */
+    /** TODO: convert array to coordinates */
+    coordinates: Coordinates[];
+    /** Sampled points along route for corridor search */
+    sampledPoints: RoutePoint[];
+    /** Bounding box [minLng, minLat, maxLng, maxLat] */
+    bbox: [number, number, number, number];
+    /** Individual leg data */
+    legs: Array<{
+        distanceKm: number;
+        durationMinutes: number;
+        /** TODO: convert array to coordinates */
+        coordinates: Coordinates[];
+        startPosition: Coordinates;
+        endPosition: Coordinates;
+    }>;
+}
+interface LocationService {
+    /**
+   * Get autocomplete suggestions for search box
+   * Use case: User types "Stock..." → Show ["Stockholm", "Stockton", ...]
+   */
+    getSuggestions(params: SuggestionParams): Promise<LocationSuggestion[]>;
+    /**
+     * Get address from coordinates (reverse geocoding)
+     * Use case: User clicks "Get my location" → Show "Drottninggatan 10, Stockholm"
+     */
+    reverseGeocode(params: ReverseGeocodeParams): Promise<LocationAddress>;
+    /**
+     * Calculate route between origin and destination with optional waypoints
+     * Use case: User plans trip → Show route on map + details
+     */
+    calculateRoute(origin: Coordinates, destination: Coordinates, waypoints?: Coordinates[], avoidTolls?: boolean): Promise<RouteResult>;
+    /**
+     * Optional: Get detailed location info if suggestion doesn't have coordinates
+     * Use case: User selects suggestion → Need full coordinates
+     */
+    getLocationDetails?(placeId: string): Promise<LocationAddress>;
 }
 
 interface StorageService {
@@ -381,4 +409,4 @@ interface CloudProvider {
     createFunctionsService(): FunctionsService;
 }
 
-export { type BaseEntry, type CloudProvider, type Entry, type Entrypoint, ErrorCode, type EventBrokerService, type EventEntry, type EventFunctionContext, type EventMessage, type EventRequest, type EventResponse, type EventTrigger, type FunctionContext, type FunctionsService, type HTTPAuth, type HTTPRequest, type HTTPResponse, type HandlerType, type HttpEntry, type HttpFunctionContext, type HttpMethod, type HttpTrigger, type LocationService, type MessageFilter, type PeekOptions, type PlaceDetails, type PlaceSearchOptions, type PlaceSearchResult, type PublishOptions, type ReadOptions, type ScheduleEntry, type ScheduleFunctionContext, type ScheduleRequest, type ScheduleResponse, type ScheduleTrigger, type StorageService, type StorageWriteOptions, type StorageWriteResult };
+export { type BaseEntry, type CloudProvider, type Coordinates, type Entry, type Entrypoint, ErrorCode, type EventBrokerService, type EventEntry, type EventFunctionContext, type EventMessage, type EventRequest, type EventResponse, type EventTrigger, type FunctionContext, type FunctionsService, type HTTPAuth, type HTTPRequest, type HTTPResponse, type HandlerType, type HttpEntry, type HttpFunctionContext, type HttpMethod, type HttpTrigger, type LocationAddress, type LocationProviderConfig, type LocationService, type LocationSuggestion, type MessageFilter, type PeekOptions, type PublishOptions, type ReadOptions, type ReverseGeocodeParams, type RoutePoint, type RouteResult, type ScheduleEntry, type ScheduleFunctionContext, type ScheduleRequest, type ScheduleResponse, type ScheduleTrigger, type StorageService, type StorageWriteOptions, type StorageWriteResult, type SuggestionParams };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cloudnux/core-cloud-provider",
-  "version": "0.2.0",
+  "version": "0.5.0",
   "description": "CloudNux core interfaces and types for multi-cloud abstraction",
   "license": "MIT",
   "type": "module",
@@ -37,8 +37,6 @@
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
     "type-check": "tsc --noEmit",
-    "test": "vitest run",
-    "test:watch": "vitest",
     "clean": "rm -rf dist"
   },
   "dependencies": {},