SDK sample catalog
This inventory is generated from samples/catalog.v2.json. Do not edit it by hand.
Catalog contract: honua.sdk.sample-catalog.v2 · SDK: @honua/sdk-js (effective version derived from package.json) · 35 executable examples
Golden journey readiness
Journey IDs are stable roadmap slots. planned candidates remain recipes or labs until their golden quality profile and evidence are satisfied; only qualified candidates use the golden track.
| Journey | Status | Candidate sample |
|---|---|---|
first-map |
qualified | maplibre-quickstart |
service-explorer |
qualified | service-explorer |
planning-permitting |
planned | planning-permitting-workbench |
incident-operations |
planned | realtime-incident-dashboard |
imagery-terrain |
qualified | imagery-cog-quickstart |
cloud-native-analysis |
planned | spatial-analytics-workbench |
arcgis-migration |
qualified | migration-workbench |
Executable samples
| Sample | Track | Journey candidate | Support | Lifecycle | Quality profile | Data | Configuration | Demonstration |
|---|---|---|---|---|---|---|---|---|
ai-spatial-app-builder |
lab | - | experimental | active | browser-lab | hybrid | approved | Proves typed proposals, shared policy validation, signed single-use approval, bounded execution, refusal, and verified receipt states. |
app-bootstrap-basic |
lab | - | deprecated | retire | browser-lab | fixture | not-required | Bootstraps a minimal application through the legacy app-platform compatibility surface. |
arcgis-source-app |
fixture | - | internal | active | internal-fixture | fixture | not-required | Provides the ArcGIS JavaScript source application used by the migration end-to-end harness. |
automatic-source-workflow |
fixture | - | internal | active | browser-fixture | fixture | not-required | Exercises automatic MapLibre strategy selection, interaction state, refresh, and disposal against deterministic browser fixtures. |
cesium-route-playback |
lab | - | experimental | rework | browser-lab | hybrid | legacy-unsafe | Explores bounded route playback and elevation context through an optional Cesium consumer integration. |
columnar-query-quickstart |
recipe | - | experimental | active | browser-recipe | fixture | not-required | Executes an exact Honua Server Arrow fixture through bounded pushdown, decoding, cancellation, evidence, and a deterministic MapLibre handoff. |
coverages-wcs-basic |
recipe | - | experimental | active | browser-recipe | fixture | not-required | Renders named-band OGC API Coverages and WCS subsets through one MapLibre image handoff. |
edit-workflow-demo |
recipe | - | supported | replace | browser-recipe | fixture | not-required | Demonstrates optimistic edits, attachments, conflicts, and safe recovery. |
geocoding-quickstart |
recipe | - | supported | active | browser-recipe | fixture | not-required | Turns a reviewed address result into a synchronized MapLibre pin with score, locator, and provenance in view. |
geoprocessing-job-runner |
recipe | - | supported | merge | browser-recipe | fixture | not-required | Runs a deterministic Honolulu buffer job and renders the verified polygon result. |
imagery-cog-quickstart |
golden | imagery-terrain | supported | active | golden-browser | hybrid | approved | Searches STAC, renders a bounded direct COG window in MapLibre, compares published imagery, and samples terrain elevation profiles. |
kepler-analytics |
lab | - | experimental | rework | browser-lab | hybrid | legacy-unsafe | Replays operations data through kepler.gl with linked filters and KPI evidence. |
maplibre-quickstart |
golden | first-map | supported | active | golden-browser | hybrid | approved | Starts with all 48 governed Maui County census tracts on an interactive map, then reveals the endpoint, accepted query plan, provenance, and protocol diagnostics behind it. |
mcp-gis-assistant |
lab | - | experimental | rework | browser-lab | fixture | not-required | Demonstrates assistant tool discovery and safe SDK-backed spatial operations. |
migration-workbench |
golden | arcgis-migration | supported | active | golden-browser | fixture | not-required | Scans and transforms ArcGIS application source with auditable compatibility results. |
nl-map-control |
lab | - | experimental | active | browser-lab | fixture | approved | A recorded fixture LLM compiles a canned instruction into an inspectable plan; read-only plans auto-execute, mutating plans require a signed agent-safety approval, and every execution emits a receipt beside the live map effects. |
node-backend-quickstart |
recipe | - | supported | active | headless-recipe | hybrid | approved | Uses the protocol-neutral client from a Node service without browser dependencies. |
oauth-signin |
recipe | - | supported | active | browser-recipe | fixture | not-required | Demonstrates browser authentication and session lifecycle without embedding credentials. |
offline-region-reference |
fixture | - | experimental | active | browser-fixture | fixture | not-required | Proves that a persisted IndexedDB region, a durable queued edit, and a bounded host-owned application shell survive reload after browser networking is disabled, then replays that edit exactly once against a loopback fixture transport on reconnect and reports one composed local-first state. |
overture-geoparquet |
lab | - | experimental | active | browser-lab | hybrid | not-required | Plans and executes bounded Overture GeoParquet queries with truthful worker, range, memory, and pruning evidence. |
planning-permitting-workbench |
lab | planning-permitting | supported | active | browser-lab | fixture | not-required | Runs public SDK geocoding, metadata-backed queries, bounded geometry analysis, edit and attachment recovery, and review export against deterministic same-origin services. |
pmtiles-static |
recipe | - | supported | active | browser-recipe | fixture | not-required | Loads a static PMTiles archive without a Honua server. |
react-quickstart |
recipe | - | supported | active | browser-recipe | hybrid | approved | Focused React provider, hooks, and map-component recipe alongside the framework-neutral First Map journey. |
realtime-incident-dashboard |
lab | incident-operations | supported | active | browser-lab | hybrid | approved | Runs live-first incident command with observable reconciliation and a guarded, resettable edit lab. |
runtime-parity-showcase |
lab | - | experimental | replace | browser-lab | fixture | not-required | Compares supported rendering paths and makes fidelity differences explicit. |
service-explorer |
golden | service-explorer | supported | active | golden-browser | hybrid | approved | Turns a service URL into inspected protocol truth, accepted plans, a bounded query, and copyable map code. |
shared-renderer-state |
lab | - | experimental | active | browser-lab | fixture | not-required | Exercises loop-safe camera, selection, filter, and time synchronization across MapLibre and Cesium. |
sketch-editing |
recipe | - | experimental | active | browser-recipe | fixture | not-required | terra-draw draw modes drive the edit-sketch workflow: undo/redo, snapping, and applyEdits submission. |
spatial-analytics-workbench |
lab | cloud-native-analysis | experimental | rework | browser-lab | hybrid | approved | Explains and accepts one plan linking AOI, map, table, chart, provenance, and reusable output. |
stac-imagery-browser |
recipe | - | experimental | active | browser-recipe | fixture | not-required | Searches Maui imagery by bounds and time, renders a selected preview, and inspects a signed PMTiles v3 handoff. |
storytelling-25d-map |
lab | - | supported | merge | browser-lab | hybrid | legacy-unsafe | Combines terrain, extrusion, OGC overlays, and route playback in a guided story. |
temporal-playback |
recipe | - | experimental | active | browser-recipe | fixture | not-required | Animates a month of seeded synthetic seismic events with createTemporalPlayback, styled by a first-class classBreaksRenderer whose legend derives from renderer.legendItems(). |
terrain-rgb-elevation |
recipe | - | supported | merge | browser-recipe | hybrid | legacy-unsafe | Reads Terrain-RGB tiles for point elevation and route profiles. |
unified-ops-workspace |
lab | - | deprecated | retire | browser-lab | fixture | not-required | Composes incident command, analysis, and shared workspace state. |
web-components-basic |
lab | - | deprecated | retire | browser-lab | fixture | not-required | Demonstrates the SDK custom-element controls against a map. |
The catalog also carries fixture/live evidence, evidence expiry, endpoint configuration names, provenance, attribution, freshness, lifecycle targets, validation profiles, and the complete 21-route honua.io migration mapping. The current presentation-safe projection is samples/dist/honua-site-samples.v3.json; v2 remains published for existing consumers, and v4 is published for cutover -- identical to v3 except that sampleBundles.publication.releaseTag is renamed releaseTagTemplate, the name the {sourceCommit} template has needed since honua-io/honua-sdk-js#1325.