Module index

@honua/sdk-js — reviewed common workflow.

The root owns the shortest protocol-neutral path: connect to a source, query it, inspect/explain the accepted query, and mount it through the lightweight MapLibre source bridge. Advanced protocol clients, renderers, app state, migration, styling, realtime, offline, and analysis APIs remain supported from their focused subpaths. The root stabilizes only the planner vocabulary required to explain and mount this common workflow; the complete @honua/sdk-js/query-planner subpath remains experimental.

The exact runtime and declaration surface is governed by config/root-surface.json; npm run verify:root-surface fails on barrel, migration, or replacement drift.

Index

Classes

HonuaAbortError HonuaAuthError HonuaCapabilityNotSupportedError HonuaClient HonuaDiscoveryError HonuaGeometryError HonuaGrpcError HonuaHttpError HonuaMapLibreSourceAdapterError HonuaNetworkError HonuaQueryPlanExecutionError HonuaQueryPlanningError HonuaSdkError HonuaTimeoutError

Interfaces

AdapterTypeMap AggregationHistogramBucketAliases AggregationHistogramBucketSpec AggregationMetric AggregationSpec AggregationTimeIntervalSpec AggregationTimeSeriesAliases AggregationTimeSeriesSpec CanonicalFeature CanonicalQuery CanonicalSpatialFilter ConnectDiscoveryCache ConnectDiscoveryCacheContext ConnectDiscoverySnapshot ConnectDiscoverySourceSnapshot ConnectOptions CreateDatasetOptions Dataset DegradedReason ExecuteQueryPlanOptions ExplainQueryOptions GeoParquetSourceProfiler HonuaAuthCredentials HonuaAuthProvider HonuaAuthProviderContext HonuaClientOptions HonuaConnection HonuaConnectionInspection HonuaErrorCodeDescriptor HonuaErrorMetadata HonuaErrorOptions LocalAggregatePlanStep MapLibreSourceDiagnostic MapLibreSourceProjection MountedMapLibreSource MountSourceToMapLibreOptions PaginationSpec Query QueryExecutionPlanV1 QueryIrSourceIdentity QueryIrV1 QueryPlanExecution QueryPlanningEstimates RemoteQueryPlanStep Result SerializedHonuaError SerializedHonuaErrorCause SortSpec Source SourceAnalyticsCapabilities SourceDescriptor SourceFreshnessContract SourceHistogramCapabilityMetadata SourceLocator SourceSchema SourceTimeSeriesCapabilityMetadata SourceToMapLibreMap SpatialFilter

Type Aliases

AdapterFor AdapterKind AggregationFn AggregationTimeIntervalUnit Capabilities Capability CapabilityPolicy ConnectCacheStatus ConnectProtocolHint ConnectResolvedProtocol DatasetId FeatureId HonuaAuthCredentialsProvider HonuaAuthErrorCode HonuaAuthProviderResult HonuaDiscoveryErrorCode HonuaError HonuaErrorCategory HonuaErrorCode HonuaErrorDomain HonuaErrorEnvelopeContext HonuaErrorEnvelopeContextValue HonuaGeometryErrorCode HonuaTransport JsonPrimitive JsonValue MapLibreGeometryKind MapLibreSourceAdapterErrorCode MapLibreSourceDiagnosticCode MapLibreSourceStrategy MapLibreSourceWorkflowState Protocol QueryFallbackPolicy QueryPlanExecutionErrorCode QueryPlanExecutor QueryPlanningErrorCode QueryPlanStep RemoteCompiledQueryV1 SourceId SourceResolver

Variables

HONUA_CONNECT_ADAPTER_VERSION HONUA_CONNECT_DISCOVERY_SNAPSHOT_VERSION HONUA_CONNECT_PROJECTION_VERSION HONUA_ERROR_CODE_REGISTRY HONUA_ERROR_KIND HONUA_MINIMUM_SUPPORTED_SERVER_VERSION MAX_LOCAL_MATERIALIZATION_ROWS PROTOCOL_DEFAULT_CAPABILITIES QUERY_IR_KIND QUERY_IR_VERSION QUERY_PLAN_KIND QUERY_PLAN_VERSION

Functions

bufferEnvelope capabilities connect createDataset envelope executeQueryPlan explainQuery hashQueryPlan isHonuaError isHonuaErrorCode mountSourceToMapLibre point polygon sanitizeHonuaErrorContext serializeHonuaError spatialContains spatialIntersects spatialWithin

Settings

Member Visibility