Skip to main content

Changelog

This documentation targets @waylocate/embed@0.2.1 speaking wire protocol waylocate: 1.

All notable changes to @waylocate/embed are documented here. The format follows Keep a Changelog, and this package follows semantic versioning on its JavaScript API.

The wire protocol is versioned separately by the waylocate field on every message and changes far less often. Each release notes the protocol it speaks and, where relevant, the minimum map build a feature needs.

Unreleased​

0.2.1 — 2026-08-14​

Patch release. Speaks protocol v1.

Fixed​

  • Documentation and packaging fixes ahead of public docs site launch.

0.2.0 — 2026-08-14​

Transport-agnostic Tier 1 API. Speaks protocol v1.

Added​

  • mount() — transport-free entry point. Pass a container and campus intent; the SDK creates the embed surface, connects, and returns a WaylocateMap handle. Supports AbortSignal for StrictMode-safe teardown.
  • @waylocate/embed/react — <CampusMap> component and useCampusMap() hook. Renders a single container div; props for building, floor, and room sync declaratively after connect.
  • @waylocate/embed/protocol subpath for wire protocol and transport internals.
  • docs/embed/API_STABILITY.md — three-tier stability contract.
  • surface.test.ts — snapshots Tier 1 exports and rejects transport vocabulary.

Changed​

  • Root export surface slimmed to Tier 1 + Tier 2 (mount, connect, buildEmbedUrl, WaylocateMap, payload types, errors). Wire helpers moved to /protocol.
  • Verify script smoke-tests all subpaths under bundler and Node16 resolution.

Notes​

  • Moving internals to /protocol is breaking for anyone importing createEmbedHostClient from the root. Do that before 1.0.0 while the package is still on the next dist-tag.
  • IIFE global (WaylocateEmbed) exports mount instead of protocol internals.

0.1.0 — 2026-08-14​

First release. Speaks protocol v1.

Added​

  • connect() — typed handle with host.hello handshake race.
  • buildEmbedUrl() — iframe src builder with host validation.
  • Typed command namespaces, camera paths, self-managing on() / off().
  • WaylocateError, createEmbedHostClient(), ESM/CJS/IIFE builds.