@chrtco/sdk 0.10.4 → 0.10.5

package/dist/index.d.cts

@@ -1040,6 +1040,158 @@ interface MarineForecastResponse {
     attribution: string;
     disclaimer: string;
 }
+/**
+ * One gazetteer hit.
+ *
+ * A hit is a PLACE, not a feature: a point, an extent, and the identity you
+ * need to go and fetch the feature itself. If you want geometry, follow `lnam`
+ * and `cell_id` into `features()` or CHRTinteract.
+ */
+interface SearchHit {
+    /** The `OBJNAM` verbatim, exactly as the hydrographic office charted it. */
+    name: string;
+    /**
+     * A point GUARANTEED to lie inside real charted geometry carrying this name.
+     *
+     * Not a bbox centroid, and not a polygon centroid either — a centroid can
+     * fall outside a concave area entirely, or inside a different, smaller
+     * feature. Safe to fly a camera to.
+     */
+    lon: number;
+    lat: number;
+    /**
+     * `[west, south, east, north]`, unioned across every charted instance of this
+     * place — so fitting a camera to it covers the whole thing rather than one
+     * chart cell's slice of it.
+     *
+     * DEGENERATE for a point feature (`west === east`, `south === north`). Never
+     * null, so `fitBounds` never has to be guarded.
+     */
+    bbox: [number, number, number, number];
+    /** S-57 layer acronym, e.g. `"SEAARE"`. */
+    layer: string;
+    /**
+     * `place` — the name describes water or ground you can **be in**.
+     * `object` — the name describes a **thing at** a position.
+     *
+     * Branch on this before writing a name into a sentence about position. It is
+     * the difference between "you are in Nantasket Roads" and the nonsense
+     * "you are in Boston South Channel Buoy 11".
+     */
+    kind: "place" | "object";
+    /** Short human label to render beside the name, e.g. `"Bay"`, `"Lateral buoy"`. */
+    class: string;
+    /**
+     * `secondary` marks survey and utility descriptors — dredged-area names,
+     * pipelines, cables, recommended tracks. Fully searchable, but never sorted
+     * above a `primary` hit in the same match tier, so a typeahead shows
+     * "Quincy Bay" rather than "51-Foot Outer Harbor Confluence RIQ".
+     */
+    rank: "primary" | "secondary";
+    /**
+     * Colloquial names a skipper actually says, composed for buoys and beacons:
+     * `"South River Buoy 16"` carries `["red 16", "r16", "red nun 16"]`. Empty
+     * for everything else. `q` matches these at the same tiers as the name.
+     */
+    aliases: string[];
+    /**
+     * S-57 long name of the largest-scale instance — the stable handle for
+     * re-resolving this hit later.
+     *
+     * **Not a de-duplication key.** The same place carries a different `LNAM` in
+     * every cell that charts it (measured: 25 instances of "Vineyard Sound", 25
+     * distinct LNAMs), and occasionally one `LNAM` spans several cells. CHRT has
+     * already de-duplicated; you do not need to.
+     */
+    lnam: string;
+    /** Source cell, and its data currency — inline, so a row renders without a second call. */
+    cell_id: string;
+    chart_source: string;
+    edition: number | null;
+    update_number: number | null;
+    issue_date: string | null;
+    /** Compilation scale denominator of the source cell. */
+    scale: number | null;
+    /** S-57 minimum display scale, where the feature carries one. */
+    scamin: number | null;
+    /** Metres from `near`. Absent when `near` was not supplied. */
+    distance_m?: number;
+    /** True bearing from `near` in degrees, geodesic. Absent when `near` was not supplied. */
+    bearing_deg?: number;
+    /**
+     * Which tier matched. The ranking order is
+     * `exact` → `prefix` → `all_words` → `substring` → `fuzzy`, then primary
+     * before secondary, then distance, then largest scale.
+     *
+     * `fuzzy` appears only when nothing matched at the four stricter tiers.
+     */
+    match: "exact" | "prefix" | "all_words" | "substring" | "fuzzy";
+}
+/**
+ * Present whenever the `near`/`bbox` you supplied falls outside CHRT's
+ * coverage — **with or without results**.
+ *
+ * The notice is about the POSITION, not about the result set being empty. A
+ * query can match places by name thousands of kilometres away while CHRT holds
+ * no charts where you actually are; returning that list silently is the most
+ * misleading answer available. When `results` accompany this block they matched
+ * by NAME only, and their `distance_m` is measured from a position CHRT cannot
+ * chart — do not present them as nearby.
+ *
+ * Its absence means the position is inside coverage, or you gave no position.
+ * So an empty `results` with no `coverage` block is a genuine in-coverage miss:
+ * "we have charts here and nothing is called that", as distinct from "we have
+ * no charts here". Neither is ever a statement that the water is clear.
+ */
+interface SearchCoverageNotice {
+    covered: false;
+    code: "outside_coverage";
+    message: string;
+    chart_sources: string[] | null;
+}
+interface SearchResponse {
+    results: SearchHit[];
+    /** Exact count of all matches — not an estimate, and not the page length. */
+    total_count: number;
+    limit: number;
+    offset: number;
+    coverage?: SearchCoverageNotice;
+    attribution: string;
+    disclaimer: string;
+}
+interface SearchOptions {
+    /**
+     * Free text. Multi-word in ANY order — `"cutty harbor"` finds
+     * "Cuttyhunk Harbor Channel". 2–120 characters.
+     */
+    q: string;
+    /**
+     * `[longitude, latitude]` — a RANKING BIAS, never a filter.
+     *
+     * Supply it. "Newport" is Rhode Island, Oregon *and* California; without
+     * `near` the first row is the wrong Newport most of the time, and a skipper
+     * off Block Island is offered a place 2,500 miles away.
+     */
+    near?: [number, number];
+    /** `[west, south, east, north]` — a HARD filter, for "search only this chart". */
+    bbox?: [number, number, number, number];
+    /** Restrict to places or to objects. Omit for both. */
+    kind?: "place" | "object" | "all";
+    /**
+     * S-57 layer acronym, or several.
+     *
+     * Note that named lights are on `LNDMRK`, not `LIGHTS` — only 50 of the
+     * 48,814 `LIGHTS` features in the corpus carry a name, so filtering to
+     * `LIGHTS` to find "Deer Island Light" returns nothing.
+     */
+    layer?: string | string[];
+    /** Page size, default 20, clamped to 100. */
+    limit?: number;
+    /** Pagination offset. */
+    offset?: number;
+    /** AbortSignal to cancel the request — pass one per keystroke in a typeahead. */
+    signal?: AbortSignal;
+}
 
 declare class ChrtError extends Error {
     status: number;
@@ -3774,6 +3926,7 @@ declare class Chrt {
      */
     readonly interact: InteractClient;
     private featuresEp;
+    private searchEp;
     private queryEp;
     private http;
     private tileAuth;
@@ -3784,6 +3937,30 @@ declare class Chrt {
     constructor(apiKeyOrConfig: string | ChrtConfig);
     /** Query GeoJSON features by bounding box */
     features(options: FeaturesOptions): Promise<FeatureCollection>;
+    /**
+     * 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.
+     */
+    search(options: SearchOptions): Promise<SearchResponse>;
     /** Spatial proximity query around a point */
     query(options: QueryOptions): Promise<QueryResponse>;
     /**
@@ -3976,4 +4153,4 @@ declare class Chrt {
     warmTiles(region?: string): Promise<void>;
 }
 
-export { ALL_NAV_AID_LAYERS, ALL_WATER_BODY_LAYERS, AREA_QUERY_LAYERS, ATON_EXPRESSION_CLASSES, type AheadCoverageCell, type AheadFeatureProperties, type AheadOptions, type AheadResponse, type AlongRouteFeatureProperties, type AlongRouteOptions, type AlongRouteResponse, type AreaInspectResult, type AtlasStyle, type AttachOptions, BAND_DRAW_ORDER, BAND_PRIORITY_RANGES, type BBox, BRIDGE_QUERY_LAYERS, BUILD_MAXZOOM, BUILD_MINZOOM, type BandCode, type BandPriorityRange, type BridgeInspectResult, type BuildOfflineStyleOptions, type BuildSourcesOptions, CHART_BAND_CODES, CHART_CASCADE_CODES, CHART_SECTIONS, CHRTRASTER_REF_CROPS, CHRTRASTER_SVGS, CHRT_ATON_COLORS, CHRT_GLYPH_NAMES, CHRT_GLYPH_SVGS, CHRT_ICON_EXPRESSIONS, CHRT_ICON_PREFIX, CHRT_SDF_GLYPHS, CHRT_STYLE_MODES, type CandidateQueryOptions, type CandidatesEventContext, type CellDeletedEvent, type CellDetail, type CellEventData, type CellNewEvent, type CellUpdatedData, type CellUpdatedEvent, type CellsOptions, type CellsResponse, type ChartSection, Chrt, type ChrtConfig, ChrtError, type ChrtStyleMode, type ChrtStyleOptions, type ChrtStyleTheme, type ChrtSymbolSet, type ClickAnchor, ColorTableName, type CoverageOptions, type CoverageResponse, type CoverageRouteCell, type CoverageRouteOptions, type CoverageRouteResponse, type CoverageSource, type CustomStyleConfig, DEFAULT_CLICK_TOLERANCE, DEFAULT_CUSTOM_STYLE_CONFIG, DEFAULT_INSPECT_CLASS_RANK, DEFAULT_LABEL_SETTINGS, DEFAULT_NAV_AID_SETTINGS, DEFAULT_REGION, DEFAULT_SAFETY_CONTOUR_M, DEFAULT_SOUNDING_SETTINGS, DEFAULT_TILE_BASE_URL, DEFAULT_TILE_REGION, DEFAULT_WATER_BODY_SETTINGS, type DecodedAreaFeature, type DecodedBridge, type DecodedNavAid, type DecodedProperty, type DisplayCategory, type DisplayMode, type FeatureCollection, type FeaturesOptions, type FetchStyleOptions, FileSystemAdapter, type FlashPattern, type FlashPhase, type GenerateCustomStyleOptions, type GeneratedCustomStyle, type GeoJsonFeature, type GeoJsonGeometry, type GeomType, INSPECT_CLASS_RANK, INSPECT_RANK_DEVIATIONS, type InspectCandidate, type InspectCandidateSet, type InspectEnrichment, type InspectEventContext, type InspectNotice, type InspectOptions, type InspectResult, type InspectTargetClass, type InspectableFeature, InteractClient, type InteractEntitlement, InteractError, type InteractErrorCode, type InteractHandle, type InteractMapLike, type InteractMapMouseEvent, LABELED_LAYERS, LABEL_BEHAVIOR, LABEL_LAYER_GROUPS, LABEL_PRIORITY, type LabelBehavior, type LabelConfigOptions, type LabelLayerConfig, type LabelSettings, type LookupEntry, type MapLibreStyle, type MapboxStyle, type MapboxVectorSource, type MarineAlert, type MarineAlertsOptions, type MarineAlertsResponse, type MarineConditionsOptions, type MarineConditionsResponse, type MarineForecastOptions, type MarineForecastPeriod, type MarineForecastResponse, type MarineSeas, type MarineStation, type MarineSwellTrain, type MarineWind, type MarineZoneRef, NAUTICAL_SYMBOLS, NAV_AID_LAYER_GROUPS, NAV_AID_QUERY_LAYERS, NON_SOLAS_DISCLAIMER, NON_SOLAS_DISCLAIMER_SHORT, type NauticalCategory, type NauticalSymbol, type NavAidInspectResult, type NavAidSettings, type NearbyMarineStation, type OfflineBundleResponse, type OfflineDownloadOptions, type OfflineDownloadProgress, type OfflineDownloadResult, OfflineError, type OfflineErrorCode, type OfflineFetchStyleOptions, type OfflineHeartbeatOptions, type OfflineRegionSummary, type OfflineRemoveOptions, OfflineStyleError, type OfflineStylePlatform, type OfflineStyleResponse, type PmtilesVectorSource, type QueryFeatureProperties, type QueryOptions, type QueryResponse, RASTER_ATON_CLASSES, RASTER_GLYPH_NAMES, RASTER_ICON_PREFIX, type ResolvedStyle, type ResolvedTheme, type S101Feature, S101_CHART_SECTIONS, S101_FEATURES, S101_ICON_PREFIX, S101_NEW_SYMBOLS, S101_SOURCE_COMMIT, S101_SYMBOL_GROUPS, S101_SYMBOL_NAMES, S52_ATON_LOOKUPS, S52_ATON_LOOKUPS_PAPER, S52_DRAW_ORDER, S52_LOOKUP, S52_PATTERN_SPRITE_PREFIX, SOUNDING_LAYERS, SYMBOL_FAMILIES, SYMBOL_FAMILY_META, SYMBOL_GROUPS, SYMBOL_MAP, type ScaleBand, type SectorArcFeature, type SectorArcFeatureCollection, type SectorInfo, type SoundingSettings, type SourceMode, type StyleGeneratorOptions, type StyleLayer, type StyleUrlOptions, type SymbolFamily, type SymbolFamilyMeta, type SymbolGroup, TileAuth, type TileGroup, type TileGroupsResponse, TileTokenError, type TileTokenErrorCode, type TileTokenResponse, type TransformRequest, type TransformedRequest, type VectorSourceSpec, type VesselProfile, WATER_BODY_LAYER_GROUPS, type WaterBodySettings, WeatherEndpoint, type WeatherReading, type WebhookEvent, type WebhookEventType, type WebhookPayload, applyChrtSymbolSet, applyColorTheme, applyCustomStyleSettings, applyRasterSymbolSet, applyS101SymbolSet, atonIconExpression, bandFilterExpression, buildFlashPattern, buildLabelLayer, buildLayersForClass, buildOfflineStyle, buildSectorArcGeoJSON, buildSectorArcsFC, buildSectorsFromFeatures, buildSources, candidateRank, chrtAtonTintExpression, chrtLightTintExpression, collectCandidates, collectClickCandidates, combineWithBandFilter, daymarkColor, decimateFeatures, decodeAreaFeatureProps, decodeBridgeProps, decodeCandidate, decodeNavAidProps, depareColor, depareFillExpression, deriveMarinerName, extractNavAidDesignation, featureIdentity, generateCustomStyle, generateSpriteManifest, generateSpriteSheet, generateStyle, generateStyleJSON, getAvailableLineSymbols, getAvailablePatterns, getAvailablePointSymbols, getCollisionSettings, getDrawPriority, getGridSizeForZoom, getIconExpression, getLabelBehavior, getLabelConfig, getLabelPriority, getLookupEntry, getMaxCellsForZoom, getOrderedClasses, getRasterSvg, getS52SvgString, getS52SymbolStats, getStyleStats, getSymbolSvgString, getThemedS101Svg, getThemedS52Svg, getTopmarkMeaning, hazardColor, hazardFillExpression, iconExpressionForFamily, isLabelLayerVisible, isNavAidLayer, isNavAidLayerVisible, isSoundingLayerVisible, isVisibleInMode, isWaterBodyLayerVisible, labelSortKey, lateralColor, lateralFillExpression, lightColor, lightFillExpression, lightsIconExpression, normalizeStyleMode, normalizeTheme, paginate, parseListCodes, parseSymbolFamily, parseWebhook, patternSpriteId, preprocessLights, preprocessNavAids, preprocessSoundings, preprocessWaterBodies, rasterAtonIconExpression, resolveCustomTheme, resolveRasterImage, resolveS101Color, resolveStyle, resolveTargetClass, sanitizeCustomStyleConfig, scaleSizeValue, scaminToMinZoom, styleModeBand, withinBboxFilter, worldMinusBboxPolygon };
+export { ALL_NAV_AID_LAYERS, ALL_WATER_BODY_LAYERS, AREA_QUERY_LAYERS, ATON_EXPRESSION_CLASSES, type AheadCoverageCell, type AheadFeatureProperties, type AheadOptions, type AheadResponse, type AlongRouteFeatureProperties, type AlongRouteOptions, type AlongRouteResponse, type AreaInspectResult, type AtlasStyle, type AttachOptions, BAND_DRAW_ORDER, BAND_PRIORITY_RANGES, type BBox, BRIDGE_QUERY_LAYERS, BUILD_MAXZOOM, BUILD_MINZOOM, type BandCode, type BandPriorityRange, type BridgeInspectResult, type BuildOfflineStyleOptions, type BuildSourcesOptions, CHART_BAND_CODES, CHART_CASCADE_CODES, CHART_SECTIONS, CHRTRASTER_REF_CROPS, CHRTRASTER_SVGS, CHRT_ATON_COLORS, CHRT_GLYPH_NAMES, CHRT_GLYPH_SVGS, CHRT_ICON_EXPRESSIONS, CHRT_ICON_PREFIX, CHRT_SDF_GLYPHS, CHRT_STYLE_MODES, type CandidateQueryOptions, type CandidatesEventContext, type CellDeletedEvent, type CellDetail, type CellEventData, type CellNewEvent, type CellUpdatedData, type CellUpdatedEvent, type CellsOptions, type CellsResponse, type ChartSection, Chrt, type ChrtConfig, ChrtError, type ChrtStyleMode, type ChrtStyleOptions, type ChrtStyleTheme, type ChrtSymbolSet, type ClickAnchor, ColorTableName, type CoverageOptions, type CoverageResponse, type CoverageRouteCell, type CoverageRouteOptions, type CoverageRouteResponse, type CoverageSource, type CustomStyleConfig, DEFAULT_CLICK_TOLERANCE, DEFAULT_CUSTOM_STYLE_CONFIG, DEFAULT_INSPECT_CLASS_RANK, DEFAULT_LABEL_SETTINGS, DEFAULT_NAV_AID_SETTINGS, DEFAULT_REGION, DEFAULT_SAFETY_CONTOUR_M, DEFAULT_SOUNDING_SETTINGS, DEFAULT_TILE_BASE_URL, DEFAULT_TILE_REGION, DEFAULT_WATER_BODY_SETTINGS, type DecodedAreaFeature, type DecodedBridge, type DecodedNavAid, type DecodedProperty, type DisplayCategory, type DisplayMode, type FeatureCollection, type FeaturesOptions, type FetchStyleOptions, FileSystemAdapter, type FlashPattern, type FlashPhase, type GenerateCustomStyleOptions, type GeneratedCustomStyle, type GeoJsonFeature, type GeoJsonGeometry, type GeomType, INSPECT_CLASS_RANK, INSPECT_RANK_DEVIATIONS, type InspectCandidate, type InspectCandidateSet, type InspectEnrichment, type InspectEventContext, type InspectNotice, type InspectOptions, type InspectResult, type InspectTargetClass, type InspectableFeature, InteractClient, type InteractEntitlement, InteractError, type InteractErrorCode, type InteractHandle, type InteractMapLike, type InteractMapMouseEvent, LABELED_LAYERS, LABEL_BEHAVIOR, LABEL_LAYER_GROUPS, LABEL_PRIORITY, type LabelBehavior, type LabelConfigOptions, type LabelLayerConfig, type LabelSettings, type LookupEntry, type MapLibreStyle, type MapboxStyle, type MapboxVectorSource, type MarineAlert, type MarineAlertsOptions, type MarineAlertsResponse, type MarineConditionsOptions, type MarineConditionsResponse, type MarineForecastOptions, type MarineForecastPeriod, type MarineForecastResponse, type MarineSeas, type MarineStation, type MarineSwellTrain, type MarineWind, type MarineZoneRef, NAUTICAL_SYMBOLS, NAV_AID_LAYER_GROUPS, NAV_AID_QUERY_LAYERS, NON_SOLAS_DISCLAIMER, NON_SOLAS_DISCLAIMER_SHORT, type NauticalCategory, type NauticalSymbol, type NavAidInspectResult, type NavAidSettings, type NearbyMarineStation, type OfflineBundleResponse, type OfflineDownloadOptions, type OfflineDownloadProgress, type OfflineDownloadResult, OfflineError, type OfflineErrorCode, type OfflineFetchStyleOptions, type OfflineHeartbeatOptions, type OfflineRegionSummary, type OfflineRemoveOptions, OfflineStyleError, type OfflineStylePlatform, type OfflineStyleResponse, type PmtilesVectorSource, type QueryFeatureProperties, type QueryOptions, type QueryResponse, RASTER_ATON_CLASSES, RASTER_GLYPH_NAMES, RASTER_ICON_PREFIX, type ResolvedStyle, type ResolvedTheme, type S101Feature, S101_CHART_SECTIONS, S101_FEATURES, S101_ICON_PREFIX, S101_NEW_SYMBOLS, S101_SOURCE_COMMIT, S101_SYMBOL_GROUPS, S101_SYMBOL_NAMES, S52_ATON_LOOKUPS, S52_ATON_LOOKUPS_PAPER, S52_DRAW_ORDER, S52_LOOKUP, S52_PATTERN_SPRITE_PREFIX, SOUNDING_LAYERS, SYMBOL_FAMILIES, SYMBOL_FAMILY_META, SYMBOL_GROUPS, SYMBOL_MAP, type ScaleBand, type SearchCoverageNotice, type SearchHit, type SearchOptions, type SearchResponse, type SectorArcFeature, type SectorArcFeatureCollection, type SectorInfo, type SoundingSettings, type SourceMode, type StyleGeneratorOptions, type StyleLayer, type StyleUrlOptions, type SymbolFamily, type SymbolFamilyMeta, type SymbolGroup, TileAuth, type TileGroup, type TileGroupsResponse, TileTokenError, type TileTokenErrorCode, type TileTokenResponse, type TransformRequest, type TransformedRequest, type VectorSourceSpec, type VesselProfile, WATER_BODY_LAYER_GROUPS, type WaterBodySettings, WeatherEndpoint, type WeatherReading, type WebhookEvent, type WebhookEventType, type WebhookPayload, applyChrtSymbolSet, applyColorTheme, applyCustomStyleSettings, applyRasterSymbolSet, applyS101SymbolSet, atonIconExpression, bandFilterExpression, buildFlashPattern, buildLabelLayer, buildLayersForClass, buildOfflineStyle, buildSectorArcGeoJSON, buildSectorArcsFC, buildSectorsFromFeatures, buildSources, candidateRank, chrtAtonTintExpression, chrtLightTintExpression, collectCandidates, collectClickCandidates, combineWithBandFilter, daymarkColor, decimateFeatures, decodeAreaFeatureProps, decodeBridgeProps, decodeCandidate, decodeNavAidProps, depareColor, depareFillExpression, deriveMarinerName, extractNavAidDesignation, featureIdentity, generateCustomStyle, generateSpriteManifest, generateSpriteSheet, generateStyle, generateStyleJSON, getAvailableLineSymbols, getAvailablePatterns, getAvailablePointSymbols, getCollisionSettings, getDrawPriority, getGridSizeForZoom, getIconExpression, getLabelBehavior, getLabelConfig, getLabelPriority, getLookupEntry, getMaxCellsForZoom, getOrderedClasses, getRasterSvg, getS52SvgString, getS52SymbolStats, getStyleStats, getSymbolSvgString, getThemedS101Svg, getThemedS52Svg, getTopmarkMeaning, hazardColor, hazardFillExpression, iconExpressionForFamily, isLabelLayerVisible, isNavAidLayer, isNavAidLayerVisible, isSoundingLayerVisible, isVisibleInMode, isWaterBodyLayerVisible, labelSortKey, lateralColor, lateralFillExpression, lightColor, lightFillExpression, lightsIconExpression, normalizeStyleMode, normalizeTheme, paginate, parseListCodes, parseSymbolFamily, parseWebhook, patternSpriteId, preprocessLights, preprocessNavAids, preprocessSoundings, preprocessWaterBodies, rasterAtonIconExpression, resolveCustomTheme, resolveRasterImage, resolveS101Color, resolveStyle, resolveTargetClass, sanitizeCustomStyleConfig, scaleSizeValue, scaminToMinZoom, styleModeBand, withinBboxFilter, worldMinusBboxPolygon };

package/dist/index.d.ts

@@ -1040,6 +1040,158 @@ interface MarineForecastResponse {
     attribution: string;
     disclaimer: string;
 }
+/**
+ * One gazetteer hit.
+ *
+ * A hit is a PLACE, not a feature: a point, an extent, and the identity you
+ * need to go and fetch the feature itself. If you want geometry, follow `lnam`
+ * and `cell_id` into `features()` or CHRTinteract.
+ */
+interface SearchHit {
+    /** The `OBJNAM` verbatim, exactly as the hydrographic office charted it. */
+    name: string;
+    /**
+     * A point GUARANTEED to lie inside real charted geometry carrying this name.
+     *
+     * Not a bbox centroid, and not a polygon centroid either — a centroid can
+     * fall outside a concave area entirely, or inside a different, smaller
+     * feature. Safe to fly a camera to.
+     */
+    lon: number;
+    lat: number;
+    /**
+     * `[west, south, east, north]`, unioned across every charted instance of this
+     * place — so fitting a camera to it covers the whole thing rather than one
+     * chart cell's slice of it.
+     *
+     * DEGENERATE for a point feature (`west === east`, `south === north`). Never
+     * null, so `fitBounds` never has to be guarded.
+     */
+    bbox: [number, number, number, number];
+    /** S-57 layer acronym, e.g. `"SEAARE"`. */
+    layer: string;
+    /**
+     * `place` — the name describes water or ground you can **be in**.
+     * `object` — the name describes a **thing at** a position.
+     *
+     * Branch on this before writing a name into a sentence about position. It is
+     * the difference between "you are in Nantasket Roads" and the nonsense
+     * "you are in Boston South Channel Buoy 11".
+     */
+    kind: "place" | "object";
+    /** Short human label to render beside the name, e.g. `"Bay"`, `"Lateral buoy"`. */
+    class: string;
+    /**
+     * `secondary` marks survey and utility descriptors — dredged-area names,
+     * pipelines, cables, recommended tracks. Fully searchable, but never sorted
+     * above a `primary` hit in the same match tier, so a typeahead shows
+     * "Quincy Bay" rather than "51-Foot Outer Harbor Confluence RIQ".
+     */
+    rank: "primary" | "secondary";
+    /**
+     * Colloquial names a skipper actually says, composed for buoys and beacons:
+     * `"South River Buoy 16"` carries `["red 16", "r16", "red nun 16"]`. Empty
+     * for everything else. `q` matches these at the same tiers as the name.
+     */
+    aliases: string[];
+    /**
+     * S-57 long name of the largest-scale instance — the stable handle for
+     * re-resolving this hit later.
+     *
+     * **Not a de-duplication key.** The same place carries a different `LNAM` in
+     * every cell that charts it (measured: 25 instances of "Vineyard Sound", 25
+     * distinct LNAMs), and occasionally one `LNAM` spans several cells. CHRT has
+     * already de-duplicated; you do not need to.
+     */
+    lnam: string;
+    /** Source cell, and its data currency — inline, so a row renders without a second call. */
+    cell_id: string;
+    chart_source: string;
+    edition: number | null;
+    update_number: number | null;
+    issue_date: string | null;
+    /** Compilation scale denominator of the source cell. */
+    scale: number | null;
+    /** S-57 minimum display scale, where the feature carries one. */
+    scamin: number | null;
+    /** Metres from `near`. Absent when `near` was not supplied. */
+    distance_m?: number;
+    /** True bearing from `near` in degrees, geodesic. Absent when `near` was not supplied. */
+    bearing_deg?: number;
+    /**
+     * Which tier matched. The ranking order is
+     * `exact` → `prefix` → `all_words` → `substring` → `fuzzy`, then primary
+     * before secondary, then distance, then largest scale.
+     *
+     * `fuzzy` appears only when nothing matched at the four stricter tiers.
+     */
+    match: "exact" | "prefix" | "all_words" | "substring" | "fuzzy";
+}
+/**
+ * Present whenever the `near`/`bbox` you supplied falls outside CHRT's
+ * coverage — **with or without results**.
+ *
+ * The notice is about the POSITION, not about the result set being empty. A
+ * query can match places by name thousands of kilometres away while CHRT holds
+ * no charts where you actually are; returning that list silently is the most
+ * misleading answer available. When `results` accompany this block they matched
+ * by NAME only, and their `distance_m` is measured from a position CHRT cannot
+ * chart — do not present them as nearby.
+ *
+ * Its absence means the position is inside coverage, or you gave no position.
+ * So an empty `results` with no `coverage` block is a genuine in-coverage miss:
+ * "we have charts here and nothing is called that", as distinct from "we have
+ * no charts here". Neither is ever a statement that the water is clear.
+ */
+interface SearchCoverageNotice {
+    covered: false;
+    code: "outside_coverage";
+    message: string;
+    chart_sources: string[] | null;
+}
+interface SearchResponse {
+    results: SearchHit[];
+    /** Exact count of all matches — not an estimate, and not the page length. */
+    total_count: number;
+    limit: number;
+    offset: number;
+    coverage?: SearchCoverageNotice;
+    attribution: string;
+    disclaimer: string;
+}
+interface SearchOptions {
+    /**
+     * Free text. Multi-word in ANY order — `"cutty harbor"` finds
+     * "Cuttyhunk Harbor Channel". 2–120 characters.
+     */
+    q: string;
+    /**
+     * `[longitude, latitude]` — a RANKING BIAS, never a filter.
+     *
+     * Supply it. "Newport" is Rhode Island, Oregon *and* California; without
+     * `near` the first row is the wrong Newport most of the time, and a skipper
+     * off Block Island is offered a place 2,500 miles away.
+     */
+    near?: [number, number];
+    /** `[west, south, east, north]` — a HARD filter, for "search only this chart". */
+    bbox?: [number, number, number, number];
+    /** Restrict to places or to objects. Omit for both. */
+    kind?: "place" | "object" | "all";
+    /**
+     * S-57 layer acronym, or several.
+     *
+     * Note that named lights are on `LNDMRK`, not `LIGHTS` — only 50 of the
+     * 48,814 `LIGHTS` features in the corpus carry a name, so filtering to
+     * `LIGHTS` to find "Deer Island Light" returns nothing.
+     */
+    layer?: string | string[];
+    /** Page size, default 20, clamped to 100. */
+    limit?: number;
+    /** Pagination offset. */
+    offset?: number;
+    /** AbortSignal to cancel the request — pass one per keystroke in a typeahead. */
+    signal?: AbortSignal;
+}
 
 declare class ChrtError extends Error {
     status: number;
@@ -3774,6 +3926,7 @@ declare class Chrt {
      */
     readonly interact: InteractClient;
     private featuresEp;
+    private searchEp;
     private queryEp;
     private http;
     private tileAuth;
@@ -3784,6 +3937,30 @@ declare class Chrt {
     constructor(apiKeyOrConfig: string | ChrtConfig);
     /** Query GeoJSON features by bounding box */
     features(options: FeaturesOptions): Promise<FeatureCollection>;
+    /**
+     * 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.
+     */
+    search(options: SearchOptions): Promise<SearchResponse>;
     /** Spatial proximity query around a point */
     query(options: QueryOptions): Promise<QueryResponse>;
     /**
@@ -3976,4 +4153,4 @@ declare class Chrt {
     warmTiles(region?: string): Promise<void>;
 }
 
-export { ALL_NAV_AID_LAYERS, ALL_WATER_BODY_LAYERS, AREA_QUERY_LAYERS, ATON_EXPRESSION_CLASSES, type AheadCoverageCell, type AheadFeatureProperties, type AheadOptions, type AheadResponse, type AlongRouteFeatureProperties, type AlongRouteOptions, type AlongRouteResponse, type AreaInspectResult, type AtlasStyle, type AttachOptions, BAND_DRAW_ORDER, BAND_PRIORITY_RANGES, type BBox, BRIDGE_QUERY_LAYERS, BUILD_MAXZOOM, BUILD_MINZOOM, type BandCode, type BandPriorityRange, type BridgeInspectResult, type BuildOfflineStyleOptions, type BuildSourcesOptions, CHART_BAND_CODES, CHART_CASCADE_CODES, CHART_SECTIONS, CHRTRASTER_REF_CROPS, CHRTRASTER_SVGS, CHRT_ATON_COLORS, CHRT_GLYPH_NAMES, CHRT_GLYPH_SVGS, CHRT_ICON_EXPRESSIONS, CHRT_ICON_PREFIX, CHRT_SDF_GLYPHS, CHRT_STYLE_MODES, type CandidateQueryOptions, type CandidatesEventContext, type CellDeletedEvent, type CellDetail, type CellEventData, type CellNewEvent, type CellUpdatedData, type CellUpdatedEvent, type CellsOptions, type CellsResponse, type ChartSection, Chrt, type ChrtConfig, ChrtError, type ChrtStyleMode, type ChrtStyleOptions, type ChrtStyleTheme, type ChrtSymbolSet, type ClickAnchor, ColorTableName, type CoverageOptions, type CoverageResponse, type CoverageRouteCell, type CoverageRouteOptions, type CoverageRouteResponse, type CoverageSource, type CustomStyleConfig, DEFAULT_CLICK_TOLERANCE, DEFAULT_CUSTOM_STYLE_CONFIG, DEFAULT_INSPECT_CLASS_RANK, DEFAULT_LABEL_SETTINGS, DEFAULT_NAV_AID_SETTINGS, DEFAULT_REGION, DEFAULT_SAFETY_CONTOUR_M, DEFAULT_SOUNDING_SETTINGS, DEFAULT_TILE_BASE_URL, DEFAULT_TILE_REGION, DEFAULT_WATER_BODY_SETTINGS, type DecodedAreaFeature, type DecodedBridge, type DecodedNavAid, type DecodedProperty, type DisplayCategory, type DisplayMode, type FeatureCollection, type FeaturesOptions, type FetchStyleOptions, FileSystemAdapter, type FlashPattern, type FlashPhase, type GenerateCustomStyleOptions, type GeneratedCustomStyle, type GeoJsonFeature, type GeoJsonGeometry, type GeomType, INSPECT_CLASS_RANK, INSPECT_RANK_DEVIATIONS, type InspectCandidate, type InspectCandidateSet, type InspectEnrichment, type InspectEventContext, type InspectNotice, type InspectOptions, type InspectResult, type InspectTargetClass, type InspectableFeature, InteractClient, type InteractEntitlement, InteractError, type InteractErrorCode, type InteractHandle, type InteractMapLike, type InteractMapMouseEvent, LABELED_LAYERS, LABEL_BEHAVIOR, LABEL_LAYER_GROUPS, LABEL_PRIORITY, type LabelBehavior, type LabelConfigOptions, type LabelLayerConfig, type LabelSettings, type LookupEntry, type MapLibreStyle, type MapboxStyle, type MapboxVectorSource, type MarineAlert, type MarineAlertsOptions, type MarineAlertsResponse, type MarineConditionsOptions, type MarineConditionsResponse, type MarineForecastOptions, type MarineForecastPeriod, type MarineForecastResponse, type MarineSeas, type MarineStation, type MarineSwellTrain, type MarineWind, type MarineZoneRef, NAUTICAL_SYMBOLS, NAV_AID_LAYER_GROUPS, NAV_AID_QUERY_LAYERS, NON_SOLAS_DISCLAIMER, NON_SOLAS_DISCLAIMER_SHORT, type NauticalCategory, type NauticalSymbol, type NavAidInspectResult, type NavAidSettings, type NearbyMarineStation, type OfflineBundleResponse, type OfflineDownloadOptions, type OfflineDownloadProgress, type OfflineDownloadResult, OfflineError, type OfflineErrorCode, type OfflineFetchStyleOptions, type OfflineHeartbeatOptions, type OfflineRegionSummary, type OfflineRemoveOptions, OfflineStyleError, type OfflineStylePlatform, type OfflineStyleResponse, type PmtilesVectorSource, type QueryFeatureProperties, type QueryOptions, type QueryResponse, RASTER_ATON_CLASSES, RASTER_GLYPH_NAMES, RASTER_ICON_PREFIX, type ResolvedStyle, type ResolvedTheme, type S101Feature, S101_CHART_SECTIONS, S101_FEATURES, S101_ICON_PREFIX, S101_NEW_SYMBOLS, S101_SOURCE_COMMIT, S101_SYMBOL_GROUPS, S101_SYMBOL_NAMES, S52_ATON_LOOKUPS, S52_ATON_LOOKUPS_PAPER, S52_DRAW_ORDER, S52_LOOKUP, S52_PATTERN_SPRITE_PREFIX, SOUNDING_LAYERS, SYMBOL_FAMILIES, SYMBOL_FAMILY_META, SYMBOL_GROUPS, SYMBOL_MAP, type ScaleBand, type SectorArcFeature, type SectorArcFeatureCollection, type SectorInfo, type SoundingSettings, type SourceMode, type StyleGeneratorOptions, type StyleLayer, type StyleUrlOptions, type SymbolFamily, type SymbolFamilyMeta, type SymbolGroup, TileAuth, type TileGroup, type TileGroupsResponse, TileTokenError, type TileTokenErrorCode, type TileTokenResponse, type TransformRequest, type TransformedRequest, type VectorSourceSpec, type VesselProfile, WATER_BODY_LAYER_GROUPS, type WaterBodySettings, WeatherEndpoint, type WeatherReading, type WebhookEvent, type WebhookEventType, type WebhookPayload, applyChrtSymbolSet, applyColorTheme, applyCustomStyleSettings, applyRasterSymbolSet, applyS101SymbolSet, atonIconExpression, bandFilterExpression, buildFlashPattern, buildLabelLayer, buildLayersForClass, buildOfflineStyle, buildSectorArcGeoJSON, buildSectorArcsFC, buildSectorsFromFeatures, buildSources, candidateRank, chrtAtonTintExpression, chrtLightTintExpression, collectCandidates, collectClickCandidates, combineWithBandFilter, daymarkColor, decimateFeatures, decodeAreaFeatureProps, decodeBridgeProps, decodeCandidate, decodeNavAidProps, depareColor, depareFillExpression, deriveMarinerName, extractNavAidDesignation, featureIdentity, generateCustomStyle, generateSpriteManifest, generateSpriteSheet, generateStyle, generateStyleJSON, getAvailableLineSymbols, getAvailablePatterns, getAvailablePointSymbols, getCollisionSettings, getDrawPriority, getGridSizeForZoom, getIconExpression, getLabelBehavior, getLabelConfig, getLabelPriority, getLookupEntry, getMaxCellsForZoom, getOrderedClasses, getRasterSvg, getS52SvgString, getS52SymbolStats, getStyleStats, getSymbolSvgString, getThemedS101Svg, getThemedS52Svg, getTopmarkMeaning, hazardColor, hazardFillExpression, iconExpressionForFamily, isLabelLayerVisible, isNavAidLayer, isNavAidLayerVisible, isSoundingLayerVisible, isVisibleInMode, isWaterBodyLayerVisible, labelSortKey, lateralColor, lateralFillExpression, lightColor, lightFillExpression, lightsIconExpression, normalizeStyleMode, normalizeTheme, paginate, parseListCodes, parseSymbolFamily, parseWebhook, patternSpriteId, preprocessLights, preprocessNavAids, preprocessSoundings, preprocessWaterBodies, rasterAtonIconExpression, resolveCustomTheme, resolveRasterImage, resolveS101Color, resolveStyle, resolveTargetClass, sanitizeCustomStyleConfig, scaleSizeValue, scaminToMinZoom, styleModeBand, withinBboxFilter, worldMinusBboxPolygon };
+export { ALL_NAV_AID_LAYERS, ALL_WATER_BODY_LAYERS, AREA_QUERY_LAYERS, ATON_EXPRESSION_CLASSES, type AheadCoverageCell, type AheadFeatureProperties, type AheadOptions, type AheadResponse, type AlongRouteFeatureProperties, type AlongRouteOptions, type AlongRouteResponse, type AreaInspectResult, type AtlasStyle, type AttachOptions, BAND_DRAW_ORDER, BAND_PRIORITY_RANGES, type BBox, BRIDGE_QUERY_LAYERS, BUILD_MAXZOOM, BUILD_MINZOOM, type BandCode, type BandPriorityRange, type BridgeInspectResult, type BuildOfflineStyleOptions, type BuildSourcesOptions, CHART_BAND_CODES, CHART_CASCADE_CODES, CHART_SECTIONS, CHRTRASTER_REF_CROPS, CHRTRASTER_SVGS, CHRT_ATON_COLORS, CHRT_GLYPH_NAMES, CHRT_GLYPH_SVGS, CHRT_ICON_EXPRESSIONS, CHRT_ICON_PREFIX, CHRT_SDF_GLYPHS, CHRT_STYLE_MODES, type CandidateQueryOptions, type CandidatesEventContext, type CellDeletedEvent, type CellDetail, type CellEventData, type CellNewEvent, type CellUpdatedData, type CellUpdatedEvent, type CellsOptions, type CellsResponse, type ChartSection, Chrt, type ChrtConfig, ChrtError, type ChrtStyleMode, type ChrtStyleOptions, type ChrtStyleTheme, type ChrtSymbolSet, type ClickAnchor, ColorTableName, type CoverageOptions, type CoverageResponse, type CoverageRouteCell, type CoverageRouteOptions, type CoverageRouteResponse, type CoverageSource, type CustomStyleConfig, DEFAULT_CLICK_TOLERANCE, DEFAULT_CUSTOM_STYLE_CONFIG, DEFAULT_INSPECT_CLASS_RANK, DEFAULT_LABEL_SETTINGS, DEFAULT_NAV_AID_SETTINGS, DEFAULT_REGION, DEFAULT_SAFETY_CONTOUR_M, DEFAULT_SOUNDING_SETTINGS, DEFAULT_TILE_BASE_URL, DEFAULT_TILE_REGION, DEFAULT_WATER_BODY_SETTINGS, type DecodedAreaFeature, type DecodedBridge, type DecodedNavAid, type DecodedProperty, type DisplayCategory, type DisplayMode, type FeatureCollection, type FeaturesOptions, type FetchStyleOptions, FileSystemAdapter, type FlashPattern, type FlashPhase, type GenerateCustomStyleOptions, type GeneratedCustomStyle, type GeoJsonFeature, type GeoJsonGeometry, type GeomType, INSPECT_CLASS_RANK, INSPECT_RANK_DEVIATIONS, type InspectCandidate, type InspectCandidateSet, type InspectEnrichment, type InspectEventContext, type InspectNotice, type InspectOptions, type InspectResult, type InspectTargetClass, type InspectableFeature, InteractClient, type InteractEntitlement, InteractError, type InteractErrorCode, type InteractHandle, type InteractMapLike, type InteractMapMouseEvent, LABELED_LAYERS, LABEL_BEHAVIOR, LABEL_LAYER_GROUPS, LABEL_PRIORITY, type LabelBehavior, type LabelConfigOptions, type LabelLayerConfig, type LabelSettings, type LookupEntry, type MapLibreStyle, type MapboxStyle, type MapboxVectorSource, type MarineAlert, type MarineAlertsOptions, type MarineAlertsResponse, type MarineConditionsOptions, type MarineConditionsResponse, type MarineForecastOptions, type MarineForecastPeriod, type MarineForecastResponse, type MarineSeas, type MarineStation, type MarineSwellTrain, type MarineWind, type MarineZoneRef, NAUTICAL_SYMBOLS, NAV_AID_LAYER_GROUPS, NAV_AID_QUERY_LAYERS, NON_SOLAS_DISCLAIMER, NON_SOLAS_DISCLAIMER_SHORT, type NauticalCategory, type NauticalSymbol, type NavAidInspectResult, type NavAidSettings, type NearbyMarineStation, type OfflineBundleResponse, type OfflineDownloadOptions, type OfflineDownloadProgress, type OfflineDownloadResult, OfflineError, type OfflineErrorCode, type OfflineFetchStyleOptions, type OfflineHeartbeatOptions, type OfflineRegionSummary, type OfflineRemoveOptions, OfflineStyleError, type OfflineStylePlatform, type OfflineStyleResponse, type PmtilesVectorSource, type QueryFeatureProperties, type QueryOptions, type QueryResponse, RASTER_ATON_CLASSES, RASTER_GLYPH_NAMES, RASTER_ICON_PREFIX, type ResolvedStyle, type ResolvedTheme, type S101Feature, S101_CHART_SECTIONS, S101_FEATURES, S101_ICON_PREFIX, S101_NEW_SYMBOLS, S101_SOURCE_COMMIT, S101_SYMBOL_GROUPS, S101_SYMBOL_NAMES, S52_ATON_LOOKUPS, S52_ATON_LOOKUPS_PAPER, S52_DRAW_ORDER, S52_LOOKUP, S52_PATTERN_SPRITE_PREFIX, SOUNDING_LAYERS, SYMBOL_FAMILIES, SYMBOL_FAMILY_META, SYMBOL_GROUPS, SYMBOL_MAP, type ScaleBand, type SearchCoverageNotice, type SearchHit, type SearchOptions, type SearchResponse, type SectorArcFeature, type SectorArcFeatureCollection, type SectorInfo, type SoundingSettings, type SourceMode, type StyleGeneratorOptions, type StyleLayer, type StyleUrlOptions, type SymbolFamily, type SymbolFamilyMeta, type SymbolGroup, TileAuth, type TileGroup, type TileGroupsResponse, TileTokenError, type TileTokenErrorCode, type TileTokenResponse, type TransformRequest, type TransformedRequest, type VectorSourceSpec, type VesselProfile, WATER_BODY_LAYER_GROUPS, type WaterBodySettings, WeatherEndpoint, type WeatherReading, type WebhookEvent, type WebhookEventType, type WebhookPayload, applyChrtSymbolSet, applyColorTheme, applyCustomStyleSettings, applyRasterSymbolSet, applyS101SymbolSet, atonIconExpression, bandFilterExpression, buildFlashPattern, buildLabelLayer, buildLayersForClass, buildOfflineStyle, buildSectorArcGeoJSON, buildSectorArcsFC, buildSectorsFromFeatures, buildSources, candidateRank, chrtAtonTintExpression, chrtLightTintExpression, collectCandidates, collectClickCandidates, combineWithBandFilter, daymarkColor, decimateFeatures, decodeAreaFeatureProps, decodeBridgeProps, decodeCandidate, decodeNavAidProps, depareColor, depareFillExpression, deriveMarinerName, extractNavAidDesignation, featureIdentity, generateCustomStyle, generateSpriteManifest, generateSpriteSheet, generateStyle, generateStyleJSON, getAvailableLineSymbols, getAvailablePatterns, getAvailablePointSymbols, getCollisionSettings, getDrawPriority, getGridSizeForZoom, getIconExpression, getLabelBehavior, getLabelConfig, getLabelPriority, getLookupEntry, getMaxCellsForZoom, getOrderedClasses, getRasterSvg, getS52SvgString, getS52SymbolStats, getStyleStats, getSymbolSvgString, getThemedS101Svg, getThemedS52Svg, getTopmarkMeaning, hazardColor, hazardFillExpression, iconExpressionForFamily, isLabelLayerVisible, isNavAidLayer, isNavAidLayerVisible, isSoundingLayerVisible, isVisibleInMode, isWaterBodyLayerVisible, labelSortKey, lateralColor, lateralFillExpression, lightColor, lightFillExpression, lightsIconExpression, normalizeStyleMode, normalizeTheme, paginate, parseListCodes, parseSymbolFamily, parseWebhook, patternSpriteId, preprocessLights, preprocessNavAids, preprocessSoundings, preprocessWaterBodies, rasterAtonIconExpression, resolveCustomTheme, resolveRasterImage, resolveS101Color, resolveStyle, resolveTargetClass, sanitizeCustomStyleConfig, scaleSizeValue, scaminToMinZoom, styleModeBand, withinBboxFilter, worldMinusBboxPolygon };

package/dist/index.js

@@ -600,6 +600,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 {
@@ -28477,6 +28508,7 @@ var Chrt = class {
    */
   interact;
   featuresEp;
+  searchEp;
   queryEp;
   http;
   tileAuth;
@@ -28497,6 +28529,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);
@@ -28506,6 +28539,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);