Module runtime

@honua/sdk-js/runtime — MapLibre GL JS-first runtime for Honua MapPackage. Consumes a server-produced MapPackage and binds it to a caller-provided MaplibreMap instance.

Example

import { HonuaClient } from "@honua/sdk-js";
import { loadMapPackage } from "@honua/sdk-js/runtime";
import * as maplibregl from "maplibre-gl";

const map = new maplibregl.Map({ container: "map" });
const runtime = await loadMapPackage(pkg, map, {
  client: new HonuaClient({ baseUrl: "https://honua.example.com" }),
  popupFactory: () => new maplibregl.Popup(),
});
runtime.setLayerVisibility("parcels-fill", false);
await runtime.updatePackage(nextPkg);

Index

Classes

BoundedMapPackageFetchCache HonuaExportSafetyError HonuaMapPackageError HonuaMapRuntime HonuaRuntimeDiagnosticError OgcStylesClient QueryTileRequestController QueryTileServerResponseError

Interfaces

BindEditSketchSnappingOptions BindPopupOptions BindTerraDrawSketchOptions CreateTerraDrawSketchOptions CreateTerraDrawSnappingOptions EditSketchSnapIndicatorOptions EditSketchSnappingEvents EditSketchSnappingHandle EnsureOfflineRegionProtocolDeps EnsurePmtilesProtocolDeps ExportMapPackageOptions FetchMapPackageOptions FetchMapPackageResult FetchQueryTileFeatureDetailOptions FetchQueryTileJsonOptions HonuaExportRedaction HonuaMapPackage HonuaMapPackageAttribution HonuaMapPackageDependency HonuaMapPackageDiagnostic HonuaMapPackageExport HonuaMapPackageInitialView HonuaMapPackageLabelBinding HonuaMapPackageLegendEntry HonuaMapPackageLocator HonuaMapPackagePopupBinding HonuaMapPackageProvenance HonuaMapPackageSourceBinding HonuaMapPackageStyleRef HonuaMapPackageThemeSpec HonuaMapPackageWidget HonuaMapRuntimeInternals HonuaMapRuntimeReload HonuaRuntimeDiagnostic HonuaRuntimeTelemetry HonuaRuntimeTelemetrySpan HonuaRuntimeTelemetrySpanResult HonuaStyleRefLayerOverride ImportMapPackageOptions ImportMapPackageResult LegendEntry LoadMapPackageFromIdOptions LoadMapPackageFromIdResult LoadMapPackageOfflineRegion LoadMapPackageOptions MaplibreMap MaplibreProtocolRegistrar MapLibreQueryTileSourceSpec MapLibreRendererFactoryOptions MapLibreRendererMap MapLibreRendererOptions MapLibreRendererPeer MapPackageDiff MapPackageFetchCacheEntry MapPackageFetchCacheState MapPackageRealtimeAdvertisement MapPackageRealtimeCheckpoint MapPackageRealtimeDisconnectedMessage MapPackageRealtimeErrorMessage MapPackageRealtimeEventSource MapPackageRealtimeHeartbeatMessage MapPackageRealtimeMessageBase MapPackageRealtimeObserver MapPackageRealtimeReadyMessage MapPackageRealtimeReconnectOptions MapPackageRealtimeRefetchRequiredMessage MapPackageRealtimeReloadRequiredMessage MapPackageRealtimeStaleMessage MapPackageRealtimeSubscribeRequest MapPackageRealtimeSubscriptionHandle MapPackageRealtimeTransport MapPackageRealtimeUpdatedMessage MapPackageRealtimeWatchOptions MapPackageServerSentEventsTransportOptions MapPackageWatchHandle NativeMapLibreSourceEntry NativeMapLibreSourceSpecification OfflineRegionStyleRefusalV1 OfflineRegionStyleRewriteEntryV1 OfflineRegionStyleRewriteV1 OgcStyleLink OgcStyleList OgcStyleListEntry OgcStyleRefResolverOptions OgcStylesClientOptions OgcStylesRequestOptions PmtilesProtocolLike PmtilesProtocolModuleLike PopupBindingHandle PopupFeature PopupHandle PopupRenderContext QueryTileCacheSnapshot QueryTileDiagnostic QueryTileFeatureDetailFetchResult QueryTileJsonFetchResult QueryTileRequest QueryTileRequestControllerOptions QueryTileRequestTileOptions QueryTileServerFetchOptions QueryTileSourceSpecOptions QueryTileUrlTemplateOptions QueryTileViewport QueryTileViewportRequestOptions QueryTileViewportRequestResult RewriteStyleTilesForOfflineRegionOptions RuntimeClickInteractionOptions RuntimeExplorationSelectionOptions RuntimeFeatureInteractionEvent RuntimeFeatureStateTarget RuntimeHoverInteractionOptions RuntimeLayerOrderOptions RuntimeLayerSpecification RuntimeLayerUpdate RuntimePointerInteractionOptions RuntimeSelectionInteractionOptions RuntimeStyleSpecValidationOptions SetViewStateInput SnappingMap SourceBridgeProjection StyleComposeOptions TerraDrawSketchController TerraDrawSketchFeature TerraDrawSketchFinishContext TerraDrawSketchFinishEvent TerraDrawSketchHandle TerraDrawSketchInstance TerraDrawSnapContext TerraDrawSnapEvent ValidateMapPackageOptions ValidateMapPackageResult WatchMapPackageOptions

Type Aliases

HonuaExportRedactionReason HonuaMapPackageDiagnosticCode HonuaMapPackageDiagnosticSeverity HonuaMapPackageErrorStage HonuaMapPackageFormat HonuaMapPackageProtocol HonuaMapPackageStatus HonuaRuntimeDiagnosticSeverity HonuaRuntimeEvent HonuaRuntimeEventListener HonuaStyleRefBody MapPackageFetchCache MapPackageFetchCacheStatus MapPackageLocator MapPackagePathResolver MapPackageRealtimeAuth MapPackageRealtimeChannel MapPackageRealtimeEventSourceFactory MapPackageRealtimeFallbackMode MapPackageRealtimeMessage MapPackageRealtimeTransportKind MapPackageRealtimeUpdate MapPackageWatchEvent OfflineRegionStyleRefusalReason OfflineRegionTileHandler PopupFactory PopupRenderer QueryTileDiagnosticCode QueryTileDiagnosticSeverity QueryTileFetcher QueryTileLifecycleEvent QueryTileLifecycleListener QueryTileServerFetch RuntimeClickInteractionHandler RuntimeFilterExpression RuntimeHitTestOptions RuntimeLayerOrder RuntimeLayoutSpecification RuntimePaintSpecification RuntimePointerInteractionHandler RuntimeSourceSpecification RuntimeStyleSpecValidationMode RuntimeStyleValue SourceErrorPolicy StyleRefResolver TerraDrawSketchFeatureId ThemeResolver

Variables

DEFAULT_MAP_PACKAGE_CACHE_LIMIT DEFAULT_MAP_PACKAGE_PATH_PREFIX DEFAULT_MAX_EMBEDDED_BYTES DEFAULT_MAX_PACKAGE_BYTES DEFAULT_OGC_STYLES_PATH_PREFIX HONUA_MAP_PACKAGE_EXPORT_KIND_V1 HONUA_MAP_PACKAGE_FORMAT_V1 MAP_PACKAGE_REALTIME_CHANNEL_V1 MAPLIBRE_STYLE_MEDIA_TYPE OFFLINE_REGION_PROTOCOL_SCHEME PMTILES_PROTOCOL_SCHEME TERRA_DRAW_SKETCH_TOOL_MODES

Functions

applyStyleRefs applyTheme bindEditSketchSnapping bindPopup bindTerraDrawSketch buildLegend buildMapLibreQueryTileSourceSpec buildQueryTileJson buildQueryTileUrl buildQueryTileUrlTemplate buildWmsRasterSourceSpec buildWmtsRasterSourceSpec composeStyle createMapPackageServerSentEventsTransport createOgcStyleRefResolver createQueryTileRequestController createTerraDrawSketch createTerraDrawSnapping decodeMapPackageRealtimeMessage defaultMapPackagePath defaultPopupRenderer diagnoseQueryTileSourceSupport diffPackages editSketchToolForTerraDrawMode encodeMapPackageRealtimeUrl ensureOfflineRegionProtocol ensurePmtilesProtocol exportMapPackage featureStateTargetFromSelection featureStateTargetKey featureTargetForLayer fetchMapPackage fetchQueryTileFeatureDetail fetchQueryTileJson hasMapPackageDiagnosticErrors importMapPackage isOfflineRegionProtocolRegistered isPmtilesProtocolRegistered loadMapPackage loadMapPackageFromId maplibreRenderer mapPackageFingerprint materializeRuntimeLayer materializeRuntimeSource materializeStyleValue prepareRuntimeStyleSpecValidation projectSourceBindings protocolForSource queryTilesForViewport readMapPackageRealtimeAdvertisement rendererRuntimeDiagnosticError resetOfflineRegionProtocol resetPmtilesProtocol resolveFeatureIdFromEventFeature resolveMapPackagePath resolveRuntimeBeforeId revertOfflineRegionStyleRewrite rewriteStyleTilesForOfflineRegion selectionTargetForLayer sourceContextForLayer styleDocumentToRefBody styleUsesOfflineRegion styleUsesPmtiles terraDrawSketchToolCapabilities throwRuntimeDiagnostics toHonuaSourceSpec validateMapPackage validateRuntimeFilterExpression validateRuntimeFilterStyleSpec validateRuntimeLayer validateRuntimeLayerStyleSpec validateRuntimeSource validateRuntimeSourceStyleSpec validateRuntimeStyleExpression validateRuntimeStyleExpressionStyleSpec validateRuntimeStyleSpec watchMapPackage