@jablum/weather-mcp 1.7.0

package/dist/services/noaa.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Service for interacting with the NOAA Weather API
+ */
+import type { PointsResponse, ForecastResponse, ObservationResponse, ObservationCollectionResponse, StationCollectionResponse, AlertCollectionResponse, NWPSGauge, NWPSStageFlowResponse, USGSIVResponse } from '../types/noaa.js';
+export interface NOAAServiceConfig {
+    userAgent?: string;
+    baseURL?: string;
+    nwpsBaseURL?: string;
+    usgsBaseURL?: string;
+    timeout?: number;
+    maxRetries?: number;
+}
+export declare class NOAAService {
+    private client;
+    private nwpsClient;
+    private usgsClient;
+    private maxRetries;
+    private cache;
+    constructor(config?: NOAAServiceConfig);
+    /**
+     * Handle API errors with retry logic and helpful status information
+     */
+    private handleError;
+    /**
+     * Make request with retry logic
+     */
+    private makeRequest;
+    /**
+     * Get cache statistics
+     */
+    getCacheStats(): import("../utils/cache.js").CacheStats;
+    /**
+     * Clear the cache
+     */
+    clearCache(): void;
+    /**
+     * Check if the NOAA API is operational
+     * Performs a lightweight health check by requesting a well-known endpoint
+     * @returns Object with status information
+     */
+    checkServiceStatus(): Promise<{
+        operational: boolean;
+        message: string;
+        statusPage: string;
+        timestamp: string;
+    }>;
+    /**
+     * Convert lat/lon coordinates to NWS grid information
+     * This is the first step for getting forecast or observation data
+     */
+    getPointData(latitude: number, longitude: number): Promise<PointsResponse>;
+    /**
+     * Get forecast for a location using grid coordinates
+     */
+    getForecast(office: string, gridX: number, gridY: number): Promise<ForecastResponse>;
+    /**
+     * Get hourly forecast for a location using grid coordinates
+     */
+    getHourlyForecast(office: string, gridX: number, gridY: number): Promise<ForecastResponse>;
+    /**
+     * Get forecast for a location using lat/lon (convenience method)
+     * This combines getPointData and getForecast
+     */
+    getForecastByCoordinates(latitude: number, longitude: number): Promise<ForecastResponse>;
+    /**
+     * Get hourly forecast for a location using lat/lon (convenience method)
+     * This combines getPointData and getHourlyForecast
+     */
+    getHourlyForecastByCoordinates(latitude: number, longitude: number): Promise<ForecastResponse>;
+    /**
+     * Get gridpoint data for a location using grid coordinates
+     * Contains detailed forecast data including fire weather indices
+     */
+    getGridpointData(office: string, gridX: number, gridY: number): Promise<import('../types/noaa.js').GridpointResponse>;
+    /**
+     * Get gridpoint data for a location using lat/lon (convenience method)
+     * This combines getPointData and getGridpointData
+     */
+    getGridpointDataByCoordinates(latitude: number, longitude: number): Promise<import('../types/noaa.js').GridpointResponse>;
+    /**
+     * Get nearest observation stations for a location
+     */
+    getStations(latitude: number, longitude: number): Promise<StationCollectionResponse>;
+    /**
+     * Get the latest observation from a station
+     */
+    getLatestObservation(stationId: string): Promise<ObservationResponse>;
+    /**
+     * Get observations from a station within a time range
+     */
+    getObservations(stationId: string, startTime?: Date, endTime?: Date, limit?: number): Promise<ObservationCollectionResponse>;
+    /**
+     * Get current conditions for a location (convenience method)
+     * This combines getStations and getLatestObservation
+     */
+    getCurrentConditions(latitude: number, longitude: number): Promise<ObservationResponse>;
+    /**
+     * Get historical observations for a location (convenience method)
+     */
+    getHistoricalObservations(latitude: number, longitude: number, startTime: Date, endTime: Date, limit?: number): Promise<ObservationCollectionResponse>;
+    /**
+     * Get active weather alerts for a location
+     * @param latitude Latitude coordinate
+     * @param longitude Longitude coordinate
+     * @param activeOnly Whether to filter to only active alerts (default: true)
+     * @returns Collection of weather alerts
+     */
+    getAlerts(latitude: number, longitude: number, activeOnly?: boolean): Promise<AlertCollectionResponse>;
+    /**
+     * NWPS (National Water Prediction Service) Methods for River Gauges
+     */
+    /**
+     * Get a specific river gauge by its NWSLI identifier
+     * @param lid 5-character NWSLI identifier (e.g., "LOLT2")
+     * @returns River gauge data with current conditions and flood stages
+     */
+    getNWPSGauge(lid: string): Promise<NWPSGauge>;
+    /**
+     * Get stage/flow time series data for a specific gauge
+     * @param lid 5-character NWSLI identifier
+     * @returns Time series of stage and flow data
+     */
+    getNWPSStageFlow(lid: string): Promise<NWPSStageFlowResponse>;
+    /**
+     * Get all NWPS gauges (warning: large response, should be filtered)
+     * Note: This endpoint returns all gauges across the US. Consider using
+     * geographic filtering or querying by specific gauge IDs instead.
+     * @returns Array of all river gauges
+     * @deprecated Use getNWPSGaugesInBoundingBox instead to avoid downloading entire catalog
+     */
+    getAllNWPSGauges(): Promise<NWPSGauge[]>;
+    /**
+     * Get NWPS river gauges within a bounding box
+     * More efficient than getAllNWPSGauges() for location-specific queries
+     * @param west Western longitude boundary
+     * @param south Southern latitude boundary
+     * @param east Eastern longitude boundary
+     * @param north Northern latitude boundary
+     * @returns Array of gauges within the bounding box
+     */
+    getNWPSGaugesInBoundingBox(west: number, south: number, east: number, north: number): Promise<NWPSGauge[]>;
+    /**
+     * USGS Water Services Methods for Streamflow Data
+     */
+    /**
+     * Get real-time streamflow data for sites within a bounding box
+     * @param west Western longitude boundary
+     * @param south Southern latitude boundary
+     * @param east Eastern longitude boundary
+     * @param north Northern latitude boundary
+     * @returns USGS instantaneous values response with streamflow data
+     */
+    getUSGSStreamflow(west: number, south: number, east: number, north: number): Promise<USGSIVResponse>;
+    /**
+     * Get real-time streamflow data for a specific USGS site
+     * @param siteNumber USGS site number (e.g., "01646500")
+     * @returns USGS instantaneous values response with streamflow data
+     */
+    getUSGSStreamflowForSite(siteNumber: string): Promise<USGSIVResponse>;
+}
+//# sourceMappingURL=noaa.d.ts.map

package/dist/services/noaa.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noaa.d.ts","sourceRoot":"","sources":["../../src/services/noaa.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,KAAK,EACV,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,6BAA6B,EAC7B,yBAAyB,EACzB,uBAAuB,EAEvB,SAAS,EACT,qBAAqB,EACrB,cAAc,EACf,MAAM,kBAAkB,CAAC;AAa1B,MAAM,WAAW,iBAAiB;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,KAAK,CAAQ;gBAET,MAAM,GAAE,iBAAsB;IA2D1C;;OAEG;YACW,WAAW;IA+DzB;;OAEG;YACW,WAAW;IA2BzB;;OAEG;IACH,aAAa;IAIb;;OAEG;IACH,UAAU,IAAI,IAAI;IAIlB;;;;OAIG;IACG,kBAAkB,IAAI,OAAO,CAAC;QAClC,WAAW,EAAE,OAAO,CAAC;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAqDF;;;OAGG;IACG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAyBhF;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqB1F;;OAEG;IACG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAqBhG;;;OAGG;IACG,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAM9F;;;OAGG;IACG,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAMpG;;;OAGG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,kBAAkB,EAAE,iBAAiB,CAAC;IAqB3H;;;OAGG;IACG,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,kBAAkB,EAAE,iBAAiB,CAAC;IAM/H;;OAEG;IACG,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAqB1F;;OAEG;IACG,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqB3E;;OAEG;IACG,eAAe,CACnB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,IAAI,EAChB,OAAO,CAAC,EAAE,IAAI,EACd,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,6BAA6B,CAAC;IAuDzC;;;OAGG;IACG,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqB7F;;OAEG;IACG,yBAAyB,CAC7B,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,IAAI,EACf,OAAO,EAAE,IAAI,EACb,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,6BAA6B,CAAC;IA0BzC;;;;;;OAMG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,UAAU,GAAE,OAAc,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAsCnC;;OAEG;IAEH;;;;OAIG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAqBnD;;;;OAIG;IACG,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAqBnE;;;;;;OAMG;IACG,gBAAgB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAqB9C;;;;;;;;OAQG;IACG,0BAA0B,CAC9B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,SAAS,EAAE,CAAC;IAoEvB;;OAEG;IAEH;;;;;;;OAOG;IACG,iBAAiB,CACrB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,cAAc,CAAC;IA4C1B;;;;OAIG;IACG,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;CAsB5E"}