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;
    featureNamespace?: string;
    geoparquet?: {
        bboxColumn?: string;
        geometryColumn?: string;
        geometryEncoding?: "geojson" | "wkb" | "native";
        urls?: readonly string[];
    };
    layerId?: number;
    layout?:
        | "honua-facade"
        | "ogc-api"
        | "auto"
        | "stac-api"
        | "stac-static";
    serviceId?: string;
    srsName?: string | number;
    styleId?: string;
    taskName?: string;
    tileMatrixSetId?: string;
    typeName?: string;
    url: string;
}

Properties

basePath? collectionId? entitySet? featureNamespace? geoparquet? layerId? layout? serviceId? srsName? styleId? taskName? tileMatrixSetId? typeName? url

Properties

OptionalbasePath

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.

OptionalcollectionId

collectionId?: string | number

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

OptionalentitySet

entitySet?: string

OData entity-set identifier.

OptionalfeatureNamespace

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.

Optionalgeoparquet

geoparquet?: {
    bboxColumn?: string;
    geometryColumn?: string;
    geometryEncoding?: "geojson" | "wkb" | "native";
    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"

    Physical geometry encoding (wkb GeoParquet BLOB, native Parquet GEOMETRY/GEOGRAPHY, or geojson string). Read by the deterministic query planner (@honua/sdk-js/query-planner) to compile DuckDB SQL without a profiling round-trip. Defaults to wkb.

  • Optionalurls?: readonly string[]

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

OptionallayerId

layerId?: number

GeoServices layer identifier within the service.

Optionallayout

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.

OptionalserviceId

serviceId?: string

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

OptionalsrsName

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.

OptionalstyleId

styleId?: string

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

OptionaltaskName

taskName?: string

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

OptionaltileMatrixSetId

tileMatrixSetId?: string

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

OptionaltypeName

typeName?: string

WFS / WMS type-name identifier.

url

url: string

Fully qualified URL to the protocol endpoint.

Settings

Member Visibility

On This Page

Properties