@chrtco/sdk 0.10.4 → 0.10.6

package/dist/index.cjs

@@ -800,6 +800,37 @@ var FeaturesEndpoint = class {
   }
 };
 
+// src/endpoints/search.ts
+var SearchEndpoint = class {
+  constructor(http) {
+    this.http = http;
+  }
+  /**
+   * Search the gazetteer.
+   *
+   * `near` biases ranking and never filters — "Newport" is Rhode Island, Oregon
+   * *and* California, and all three come back with the nearest first. `bbox`
+   * does filter.
+   */
+  async find(options) {
+    return this.http.request(
+      "/search",
+      {
+        q: options.q,
+        near: options.near ? `${options.near[0]},${options.near[1]}` : void 0,
+        bbox: options.bbox ? options.bbox.join(",") : void 0,
+        kind: options.kind,
+        // Both spellings are accepted server-side; the SDK sends the
+        // comma-joined form so one array maps to one query parameter.
+        layer: Array.isArray(options.layer) ? options.layer.join(",") : options.layer,
+        limit: options.limit,
+        offset: options.offset
+      },
+      options.signal
+    );
+  }
+};
+
 // src/endpoints/query.ts
 var METRES_PER_NAUTICAL_MILE2 = 1852;
 var QueryEndpoint = class {
@@ -28677,6 +28708,7 @@ var Chrt = class {
    */
   interact;
   featuresEp;
+  searchEp;
   queryEp;
   http;
   tileAuth;
@@ -28697,6 +28729,7 @@ var Chrt = class {
     this.coverage = new CoverageEndpoint(this.http);
     this.weather = new WeatherEndpoint(this.http);
     this.featuresEp = new FeaturesEndpoint(this.http);
+    this.searchEp = new SearchEndpoint(this.http);
     this.queryEp = new QueryEndpoint(this.http);
     this.offline = new OfflineEndpoint(this.http, config.deviceId, config.manifestPath);
     this.interact = new InteractClient(this.http);
@@ -28706,6 +28739,32 @@ var Chrt = class {
   async features(options) {
     return this.featuresEp.list(options);
   }
+  /**
+   * CHRTsearch — find charted places by name.
+   *
+   * The only CHRT surface addressed by NAME rather than by space or identifier.
+   * Text in, a small ranked list of named charted places out.
+   *
+   * ```ts
+   * const { results } = await chrt.search({ q: "cutty harbor", near: [-70.93, 41.42] });
+   * // -> [{ name: "Cuttyhunk Harbor Channel", class: "Fairway", kind: "place", ... }]
+   * ```
+   *
+   * Three things worth knowing before wiring it to a text field:
+   *
+   * 1. **Pass `near`.** It biases ranking and never filters. "Newport" is
+   *    Rhode Island, Oregon *and* California; without `near` the first row is
+   *    the wrong Newport most of the time.
+   * 2. **It is metered separately** from `features()` — exhausting one does not
+   *    affect the other. Sized for a typeahead, and not gated by tier.
+   * 3. **An empty `results` array is not proof a place does not exist.** If the
+   *    response carries a `coverage` block, CHRT holds no charts at that
+   *    position and the search could not run there. That is a different answer
+   *    from "nothing matched", and neither means the water is clear.
+   */
+  async search(options) {
+    return this.searchEp.find(options);
+  }
   /** Spatial proximity query around a point */
   async query(options) {
     return this.queryEp.nearby(options);