@chrtco/sdk 0.10.3 → 0.10.4

package/dist/index.js

@@ -448,6 +448,79 @@ var CellsEndpoint = class {
   }
 };
 
+// src/endpoints/weather.ts
+var WeatherEndpoint = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Observed conditions from the nearest reporting NOAA NDBC station.
+   *
+   * A **measurement, not a forecast**, and not live — most buoys report hourly
+   * and the median observation is around 40 minutes old. `observed.ageMinutes`
+   * is on every response and should be displayed: a readout that looks current
+   * but is 90 minutes stale is worse than one that says so.
+   *
+   * `unavailable` names every field the station did not report, so absence is
+   * stated rather than inferred from a missing key.
+   */
+  async conditions(options) {
+    return this.http.request(
+      "/weather/conditions",
+      {
+        lat: options.lat,
+        lon: options.lon,
+        units: options.units,
+        station: options.station
+      },
+      options.signal
+    );
+  }
+  /**
+   * Active NWS marine warnings for the zone — Small Craft Advisory, Gale,
+   * Storm, Hurricane Force Wind, Special Marine Warning. Most severe first.
+   *
+   * Its own call, so warnings can be re-checked cheaply (~60 s) without pulling
+   * a forecast you already have.
+   *
+   * **`expires` and `ends` are different.** `expires` is when the *bulletin*
+   * lapses — alerts are usually re-issued before then. `ends` is when the
+   * *hazard* is expected to be over. They are routinely hours apart, so
+   * describe the hazard with `ends` and use `expires` only to decide when to
+   * re-fetch.
+   *
+   * Display `instruction` verbatim: it is NWS's own advice to mariners.
+   */
+  async alerts(options) {
+    return this.http.request(
+      "/weather/marine-alerts",
+      { lat: options.lat, lon: options.lon, zone: options.zone },
+      options.signal
+    );
+  }
+  /**
+   * The NWS marine zone forecast — U.S. coastal and Great Lakes waters.
+   *
+   * Periods are NWS's own and are **neither hourly nor uniform**: `OVERNIGHT`,
+   * `TUE NIGHT`, `WED NIGHT THROUGH THU NIGHT`. A single period can span days.
+   * Flattening them into an hourly series invents resolution the data does not
+   * have.
+   *
+   * `expires` is the forecast's **own** stated validity, taken from the
+   * bulletin, not a TTL CHRT invented. `source.productId` identifies the
+   * upstream NWS product, so you can verify CHRT against NOAA directly.
+   *
+   * Offshore zones are not yet supported and fail with `501`.
+   */
+  async forecast(options) {
+    return this.http.request(
+      "/weather/marine-forecast",
+      { lat: options.lat, lon: options.lon, zone: options.zone },
+      options.signal
+    );
+  }
+};
+
 // src/endpoints/coverage.ts
 var METRES_PER_NAUTICAL_MILE = 1852;
 var CoverageEndpoint = class {
@@ -28383,6 +28456,14 @@ var Chrt = class {
   cells;
   /** Coverage data — list available chart sources */
   coverage;
+  /**
+   * CHRTweather — NOAA-backed marine weather: observed conditions, active
+   * warnings, and the NWS zone forecast. U.S. waters only, and requires the
+   * `weather:read` scope on your key — a chart key does not carry it.
+   *
+   * An empty result from any of these never means calm water.
+   */
+  weather;
   /**
    * CHRToffline — download MBTiles bundles for offline use.
    * Requires `deviceId` in config. Manifest-based budget enforcement
@@ -28414,6 +28495,7 @@ var Chrt = class {
     this.tiles = new TilesEndpoint(this.http, this.tileAuth, tileOpts);
     this.cells = new CellsEndpoint(this.http);
     this.coverage = new CoverageEndpoint(this.http);
+    this.weather = new WeatherEndpoint(this.http);
     this.featuresEp = new FeaturesEndpoint(this.http);
     this.queryEp = new QueryEndpoint(this.http);
     this.offline = new OfflineEndpoint(this.http, config.deviceId, config.manifestPath);
@@ -28749,6 +28831,7 @@ export {
   TileAuth,
   TileTokenError,
   WATER_BODY_LAYER_GROUPS,
+  WeatherEndpoint,
   applyChrtSymbolSet,
   applyColorTheme,
   applyCustomStyleSettings,