gds-lens 1.0.3 → 1.2.0

package/CHANGELOG.md

@@ -7,6 +7,108 @@ follows [semantic versioning](https://semver.org/spec/v2.0.0.html).
 From 1.0.0 on, a breaking change to the element's API waits for a major
 version. Before that, `0.x` releases changed it freely.
 
+## [1.2.0] - 2026-09-03
+
+### Added
+
+- `gds-load` and `gds-error` events on the element, dispatched however a load
+  was started -- the `src` attribute, `load()`, or a host pushing bytes through
+  its surface. Until now a load that came from `src` could fail only into the
+  viewer's own error panel, with nothing for the embedding page to observe.
+  `detail` carries `{ layerCount, cellCount }` and `{ message }` respectively.
+  Prefixed rather than `load` / `error`, which every HTML element already has
+  with other types attached.
+- `showLoading(label?)` on the element. The surface had it; a page fetching its
+  own bytes and calling `load(bytes)` could not reach it without `ready`, so it
+  sat on "No layout loaded" for the length of the download.
+- A message when WebGL2 cannot be had: unsupported, disabled, or the page over
+  its limit on live contexts. The renderer's `main()` returns quietly when its
+  context creation fails -- which is what lets the same module run in the parse
+  worker and under Node, where there is no canvas -- and nothing on the other
+  side ever asked, so the result was a canvas that never drew and a `load()`
+  that reported success. The viewer now asks (`isGlReady`) and says so, and a
+  lost context (`webglcontextlost`, after a GPU reset or the browser reclaiming
+  it) is reported the same way rather than left as a black canvas.
+
+### Changed
+
+- `load()` settles on the outcome. It used to resolve as soon as the file had
+  been handed to the parse worker, so it never rejected on a file the parser
+  refused -- contrary to what the React docs claimed of it. It now resolves
+  once the layout is on screen and rejects with the same message the viewer
+  shows. A load superseded by a newer one rejects with an error named
+  `AbortError`, the name `fetch()` uses for the same thing.
+
+- The demo page's layout is served as gzipped OASIS rather than gzipped GDSII:
+  the same design, 4.4 MB down from 8.1 MB. `site/make-demo-assets.py` writes
+  OASIS now.
+
+### Fixed
+
+- The parse worker wrote a dozen lines to the console on every load, into the
+  embedding page's DevTools, whether or not tracing had been asked for. The
+  relay to the on-screen debug panel was always meant to be unconditional; the
+  copy to the real console was not. It is now gated on the same flag as the
+  main thread's breadcrumbs (the `debug` attribute or `?gdsDebug=1`). The test
+  meant to catch this filtered on `[GDS]`, and the worker's prefix is
+  `[GDS worker]`.
+- `destroy()` did not release the viewer. Six listeners on `window` (the
+  keyboard shortcuts and the coordinate menu's dismissal) were never removed,
+  and a listener's closure holds the whole viewer, wasm instance included; the
+  renderer's own `mouseup` and `resize` callbacks on `window` did the same from
+  the other side, and the WebGL context waited on garbage collection. Every
+  listener now carries an abort signal that `dispose()` fires, and the renderer
+  exports a `destroyRenderer()` that unregisters its callbacks and destroys the
+  context outright -- so a page calling `destroy()` because it hit the per-page
+  context cap gets its slot back when it asks, not when the collector gets to
+  it.
+- Two quick changes to `src` (or two `load(url)` calls) could show the older
+  layout: the viewer superseded an in-flight *parse*, but the fetch in front of
+  it was nobody's to cancel, so a slow first file landing after a small second
+  one won. Each `load()` now aborts the fetch before it, and a load parked on
+  gzip expansion notices it has been superseded when it wakes.
+
+## [1.1.0] - 2026-08-31
+
+### Added
+
+- Touch: one finger pans the layout, two pinch to zoom about the point between
+  them and drag the view with it. Lifting one finger of a pinch hands the
+  gesture to the other rather than ending it, so a pinch that relaxes into a
+  drag does not jump.
+
+### Changed
+
+- On a touch-only device (a coarse pointer *and* no hover, so a touchscreen
+  laptop is not one) the control panel starts collapsed to its title bar, and
+  both it and the cell hierarchy are capped at 85% of the viewport width. A
+  panel sized for a window is most of a phone screen, and the layout is what
+  someone opening the viewer came for.
+- Measure mode is offered greyed out where there is no hovering pointer. It is
+  placed by clicking two points, and without hover the snap indicator only
+  appears after the tap that already used it, under a fingertip.
+- The demo page drops its tagline, its file button, its status line and its
+  what-this-is-built-from footer line below 620px. Two of those cannot work on
+  touch anyway: there is no drag-and-drop, and the file picker's extension
+  filter greys out `.gds`/`.oas` in the iOS Files app.
+
+### Fixed
+
+- Touch input did not work at all on iOS. The gestures were handled in the
+  renderer, through `emscripten_set_touchstart_callback`, and that callback
+  never runs on iOS Safari: the events reach the canvas and the handler behind
+  them does not fire. Emscripten resolves mouse and touch targets through the
+  same code path, so the mouse handlers next to them were fine, which is what
+  made this invisible from a desktop. The gestures are now ordinary listeners
+  on the element, driving the camera through the exported `getCamera` /
+  `setCamera` -- the same arithmetic, with nothing between the DOM event and
+  the state it changes. Covered by a test that spells out the touch lists.
+- A two-finger pinch over the viewer zoomed the page on iOS instead of the
+  layout. Safari answers a pinch with its own page zoom, delivered as a
+  proprietary `GestureEvent`, and it does that over an element that has already
+  claimed the gesture with `touch-action: none`. Refused on the canvas alone,
+  so a pinch anywhere else in an embedding page still zooms it.
+
 ## [1.0.3] - 2026-08-31
 
 ### Fixed
@@ -348,7 +450,10 @@ web page rather than for a webview.
   worker-loading route and shipped unsubstituted. The `createWorker` host hook
   replaces it.
 
-[Unreleased]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.0.2...HEAD
+[Unreleased]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.0.3...v1.1.0
+[1.0.3]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.0.2...v1.0.3
 [1.0.2]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.0.1...v1.0.2
 [1.0.1]: https://github.com/EthanLowenthal/GDS-Lens/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/EthanLowenthal/GDS-Lens/compare/v0.1.1...v1.0.0

package/README.md

@@ -15,9 +15,6 @@ a given release does.
 
 ![The viewer: a cell hierarchy tree, a rendered photonic layout, and the layer and display controls](https://raw.githubusercontent.com/EthanLowenthal/GDS-Lens/main/images/example.png)
 
-> **Status**: 1.0. The element's API is stable, and breaking changes wait
-> for a major version. See [the changelog](CHANGELOG.md).
-
 ## Quick start
 
 ```sh
@@ -32,10 +29,10 @@ import "gds-lens";   // registers <gds-lens>
 <gds-lens src="chip.gds" style="width: 100%; height: 600px"></gds-lens>
 ```
 
-That's the whole thing. Pan with the mouse, zoom with the wheel. The import
-pulls in one self-contained module — the parser, the renderer, the WebAssembly
-binary, and the control panel — so there is nothing to copy and nothing
-else to serve.
+That's the whole thing. Pan with the mouse, zoom with the wheel; on a touch
+screen, drag to pan and pinch to zoom. The import pulls in one self-contained
+module — the parser, the renderer, the WebAssembly binary, and the control
+panel — so there is nothing to copy and nothing else to serve.
 
 Or drive it from JavaScript:
 
@@ -106,14 +103,54 @@ The element exposes the following members:
 
 | Member | Returns | Description |
 |---|---|---|
-| `ready` | `Promise<Viewer>` | Resolves once the engine has mounted. Every method in the following table awaits this, so you rarely need it directly. |
-| `load(source, options?)` | `Promise<void>` | `source` is a URL string, a `Uint8Array`, or an `ArrayBuffer`. `options.reload` keeps the current camera and layer visibility instead of framing the design. |
+| `ready` | `Promise<ViewerSurface>` | Resolves once the engine has mounted. Every method in the following table awaits this, so you rarely need it directly. |
+| `load(source, options?)` | `Promise<void>` | `source` is a URL string, a `Uint8Array`, or an `ArrayBuffer`. `options.reload` keeps the current camera and layer visibility instead of framing the design. Resolves once the layout is on screen; rejects on a failed fetch, a file the parser refuses, or — with an error named `AbortError` — when a later load superseded this one. |
+| `showLoading(label?)` | `Promise<void>` | Shows the loading overlay, for the wait before a `load()` of bytes the page is fetching itself. `load(url)` does this on its own. |
 | `goToPoint(x, y)` | `Promise<boolean>` | Centers on a coordinate in microns and flashes a crosshair. Resolves `true` if the point is inside the layout. |
 | `setLyp(name, text)` | `Promise<void>` | Applies a `.lyp` layer-properties file. Pass `""` to clear. |
 | `setMarkers(name, text)` | `Promise<void>` | Applies a marker database. The viewer detects the format from the content. |
 | `showError(message)` | `Promise<void>` | Replaces the view with an error message. |
 | `destroy()` | `Promise<void>` | Releases the viewer's WebAssembly instance and WebGL context for good. Rarely needed — see [Removal parks the viewer](#removal-parks-the-viewer). |
 
+Every `load()` cancels the one before it, so two quick changes to `src` show
+the second layout even when the first is the slower download.
+
+#### Events
+
+The element dispatches two events on itself, whichever way a load was started
+— the `src` attribute, `load()`, or a host pushing bytes through its surface.
+Neither bubbles.
+
+| Event | `detail` | When |
+|---|---|---|
+| `gds-load` | `{ layerCount, cellCount }` | A layout finished loading and is on screen. |
+| `gds-error` | `{ message }` | A load failed, or `showError()` was called. `message` is the text the viewer shows. |
+
+```js
+viewer.addEventListener("gds-load", (event) => {
+    console.log(`${event.detail.layerCount} layers, ${event.detail.cellCount} cells`);
+});
+viewer.addEventListener("gds-error", (event) => {
+    reportProblem(event.detail.message);
+});
+```
+
+The names carry a prefix because `load` and `error` already have meanings —
+and types — on every HTML element.
+
+#### Keyboard shortcuts
+
+The keys act on the viewer that was last pointed at, so on a page with several
+they go to the one under the mouse.
+
+| Key | Action |
+|---|---|
+| `[` / `]` | Previous / next marker in the selected marker's category. |
+| `m` | Toggle measure mode. Click two points to place a ruler. |
+| `Esc` | Abandon a ruler being placed; with none in progress, clear the finished ones and return to pan mode. Also closes the coordinate menu. |
+| `h` | Show or hide the cell hierarchy. |
+| `/` | Focus the cell filter box. |
+
 #### Several viewers on one page
 
 Each `<gds-lens>` drives its own viewer, with its own shadow tree, its own