@honua/sdk-js
    Preparing search index...

    Interface SourceLocator

    Protocol-specific endpoint information. Field-compatible with the server SourceBinding.locator shape documented in docs/source-binding-alignment.md (a Honua SDK SourceDescriptor may be exported into a server SourceBinding without re-shaping the locator).

    interface SourceLocator {
        basePath?: string;
        collectionId?: string | number;
        entitySet?: string;
        featureInfo?: FeatureInfoRequestBinding;
        featureNamespace?: string;
        geometryName?: string;
        geoparquet?: {
            bboxColumn?: string;
            geometryColumn?: string;
            geometryEncoding?:
                | "geojson"
                | "wkb"
                | "native"
                | "geoarrow-point"
                | "geoarrow-linestring"
                | "geoarrow-polygon"
                | "geoarrow-multipoint"
                | "geoarrow-multilinestring"
                | "geoarrow-multipolygon";
            nativeDimensions?: "xyz"
            | "xy";
            urls?: readonly string[];
        };
        layerId?: number;
        layout?: "honua-facade"
        | "ogc-api"
        | "auto"
        | "stac-api"
        | "stac-static";
        raster?: RasterRequestBinding;
        serviceId?: string;
        sourceType?: "vector" | "raster";
        srsName?: string | number;
        stacStatic?: {
            maxAssetProbes: number;
            maxAssets: number;
            maxDepth: number;
            maxDocumentBytes: number;
            maxDocuments: number;
            maxLinksPerDocument: number;
        };
        styleId?: string;
        taskName?: string;
        tileMatrixSetId?: string;
        typeName?: string;
        url: string;
    }
    Index

    Properties

    basePath? collectionId? entitySet? featureInfo? featureNamespace? geometryName? geoparquet? layerId? layout? raster? serviceId? sourceType? srsName? stacStatic? styleId? taskName? tileMatrixSetId? typeName? url

    Properties

    basePath?: string

    Raw endpoint path prefix for the OGC API Tiles / Maps / Records / Processes families when the service is a third-party root discovered by connect() rather than the Honua facade. Defaults (when omitted) to the family's facade prefix (/ogc/tiles, /ogc/maps, /ogc/records, /ogc/processes). OGC API Features and STAC instead use SourceLocator.layout.

    collectionId?: string | number

    OGC API Features / Tiles / Maps collection identifier, or Records catalog id.

    entitySet?: string

    OData entity-set identifier.

    featureInfo?: FeatureInfoRequestBinding

    Exact, capability-reviewed WMS GetFeatureInfo operation selected by connect().

    featureNamespace?: string

    WFS feature namespace URI bound to the prefix in typeName. Required for WFS-T applyEdits when typeName carries a namespace prefix (e.g. parcels:lot) — the prefix is declared on the <wfs:Transaction> root with this URI so the per-handle feature element resolves to the schema element the server expects. The namespace URI typically appears on the <wfs:WFS_Capabilities> root (xmlns:<prefix>=…); record it on the descriptor so applyEdits does not have to fetch capabilities synchronously.

    geometryName?: string

    WFS geometry property name (e.g. the_geom, msGeometry, geom) used by FES spatial predicates and WFS-T <wfs:Insert> / <wfs:Update> payloads. When omitted the adapter resolves it per feature type from DescribeFeatureType and caches it; set this to pin the property on schema-less servers, on types that declare several geometries, or to skip the schema round-trip entirely. Resolution failure fails closed — the adapter never falls back to a vendor default.

    geoparquet?: {
        bboxColumn?: string;
        geometryColumn?: string;
        geometryEncoding?:
            | "geojson"
            | "wkb"
            | "native"
            | "geoarrow-point"
            | "geoarrow-linestring"
            | "geoarrow-polygon"
            | "geoarrow-multipoint"
            | "geoarrow-multilinestring"
            | "geoarrow-multipolygon";
        nativeDimensions?: "xyz"
        | "xy";
        urls?: readonly string[];
    }

    GeoParquet source addressing. url carries the primary file or a hive-partitioned glob (e.g. an Overture theme prefix ending in /**/*.parquet); urls lists multiple files read as one relation via read_parquet([...]). geometryColumn pins the geometry column when the file lacks GeoParquet geo metadata (Parquet-native GEOMETRY/GEOGRAPHY).

    Type Declaration

    • OptionalbboxColumn?: string

      Optional GeoParquet 1.1 bbox-covering struct column (e.g. bbox) used by the query planner to push an envelope filter down to row-group pruning.

    • OptionalgeometryColumn?: string

      Explicit geometry column name (overrides metadata detection).

    • OptionalgeometryEncoding?:
          | "geojson"
          | "wkb"
          | "native"
          | "geoarrow-point"
          | "geoarrow-linestring"
          | "geoarrow-polygon"
          | "geoarrow-multipoint"
          | "geoarrow-multilinestring"
          | "geoarrow-multipolygon"

      Physical geometry encoding (wkb GeoParquet BLOB, native Parquet GEOMETRY/GEOGRAPHY, geojson string, or a GeoParquet 1.1 native single-geometry geoarrow-* encoding — see GeometryEncoding in core/geoparquet-sql.ts, mirrored here by value to keep this contract module dependency-free of any protocol-specific compiler). Read by the deterministic query planner (@honua/sdk-js/query-planner) to compile DuckDB SQL without a profiling round-trip. Defaults to wkb.

    • OptionalnativeDimensions?: "xyz" | "xy"

      Coordinate dimensions physically stored by a geoarrow-* geometryEncoding. Meaningful only for those encodings.

    • Optionalurls?: readonly string[]

      Additional files unioned with url via read_parquet([...]).

    layerId?: number

    GeoServices layer identifier within the service.

    layout?: "honua-facade" | "ogc-api" | "auto" | "stac-api" | "stac-static"

    OGC API / STAC endpoint-layout discovery mode.

    • honua-facade (default) addresses Honua Server's fixed facade paths (/ogc/features/..., /stac/...) with zero discovery round-trips.
    • ogc-api (OGC API Features/Records) / stac-api (STAC) treat url as the service root and discover collection / item / search paths from the landing page links (spec-driven, backend-agnostic).
    • auto probes the facade first and falls back to discovery.
    • stac-static (STAC only) reads a static catalog.json tree by following child / item links.

    Existing Honua-Server callers omit this field and see no behaviour change.

    raster?: RasterRequestBinding

    Exact, capability-reviewed raster operation selected by connect().

    serviceId?: string

    GeoServices service identifier (FeatureServer / MapServer / ImageServer / Geometry / GP).

    sourceType?: "vector" | "raster"

    PMTiles payload kind selected from bounded archive-header evidence.

    srsName?: string | number

    WFS coordinate reference system for the layer's native geometry (e.g. EPSG:4326, a numeric WKID, or an OGC URN like urn:ogc:def:crs:EPSG::4326). When set, WFS-T applyEdits emits it as the srsName attribute on <wfs:Insert> / <wfs:Update> geometries. Servers that require srsName on transaction geometry, or whose native CRS differs from the unqualified default, otherwise reject or mis-place the written feature.

    stacStatic?: {
        maxAssetProbes: number;
        maxAssets: number;
        maxDepth: number;
        maxDocumentBytes: number;
        maxDocuments: number;
        maxLinksPerDocument: number;
    }

    Execution guardrails for a stac-static source. connect() records the exact normalized discovery policy here so later Source.query() calls cannot traverse a broader tree than the one that was admitted. Manually constructed static-STAC sources use the same conservative defaults.

    styleId?: string

    OGC API Maps / Tiles style identifier for styled-output endpoints.

    taskName?: string

    GP Service task identifier (for geoservices-gp-service).

    tileMatrixSetId?: string

    OGC API Tiles tile-matrix-set identifier (e.g. WebMercatorQuad).

    typeName?: string

    WFS / WMS type-name identifier.

    url: string

    Fully qualified URL to the protocol endpoint.

    Settings

    Member Visibility

    On This Page

    Properties