@plasius/gpu-demo-viewer 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on Keep a Changelog and this project adheres to SemVer.
+
+## [Unreleased]
+
+- **Fixed**
+  - Added `index.js` compatibility entry shims for the root viewer and the
+    showcase so stale cached entry URLs do not 404 when the runtime loads from
+    `main.js`.
+  - Prefilled the root viewer with a working showcase target so the initial
+    `Open showcase` action works before client-side hydration completes.
+  - Clamped showcase telemetry queue depths so the embedded preview no longer
+    throws on arrival when stress or spray counts spike.
+  - Guarded wavefront renderer setup and initial probe rendering against stale
+    async settings changes so older GPU work cannot replace the current renderer,
+    update overlays, or restart the loop.
+
+### Added
+
+- Shared 3D harbor showcase with GLTF ships and physics metadata for cross-package validation.
+- Experimental wavefront path-tracing technique demo using the renderer WebGPU
+  mesh BVH path with 540p, 720p, and 1080p presets, model-only skybox/environment
+  termination, reflection, refraction, smooth normals, a denoise post-pass toggle,
+  and queue-depth telemetry.
+- Live wavefront assessment controls with pause/resume, render-once, a 4K
+  target preset, FPS/rays-per-second telemetry, and a 100% stacked frame timing
+  chart for dispatch, GPU wait, probe/readback, overlay, and frame pacing.
+- Ambient residual handling for shallow no-light and max-depth wavefront paths
+  so the demo approximates unresolved high-order indirect bounces without
+  replacing active-ray emissive or environment hits.
+- WebGPU compute-backed wavefront inspection mode with 360p, 720p, and 1080p
+  presets, GPU primary-ray dispatch, compacted continuation queues, fixed tile
+  bounce dispatch, and renderer-owned stats.
+- Added tiled GPU ray queues and a 4K UHD preset so ray queue memory scales by
+  tile size instead of full output resolution.
+- Browser manifest coverage tests and a GLTF asset contract test.
+- Added a physics focus mode for the shared showcase and promoted
+  `gpu-physics` to a browser-backed 3D demo entry.
+- Added baseline governance and validation scripts for repo standardization:
+  `NFR.md`, `docs/adrs`, `npm run build`, and `npm run typecheck`.
+
+### Changed
+
+- Refreshed the viewer's shared GPU package baselines onto the latest stable
+  published `@plasius/gpu-*` releases.
+- Replaced the old CPU/static wavefront tracer with a renderer-owned mesh BVH
+  WebGPU mount so customer-visible wavefront output no longer uses analytic
+  scene objects.
+- The wavefront demo now exposes samples-per-pixel controls, defaults its
+  540p/720p/1080p presets to 8 spp, and reports screen pixels separately from
+  primary ray samples.
+- The wavefront demo now updates renderer camera uniforms every RAF frame so
+  the mesh BVH view has visible realtime motion instead of repeating one static
+  path-traced frame.
+- The wavefront performance panel now treats GPU completion as a sampled sync
+  metric instead of hard-blocking every frame, reducing viewer-side queue
+  serialization while still showing where occasional GPU waits land.
+- The wavefront demo now submits only benchmark model meshes with ungated
+  skybox/environment lighting, removing the previous synthetic floor, wall,
+  emissive-panel, and fluid-surface blockers from the validation scene.
+- The viewer now classifies the cloth, fluid, lighting, performance, and debug demos as browser-based 3D visual examples.
+- Strengthened the shared showcase lighting and shadow model so the harbor demos
+  present a more ray-traced near-field look.
+- The viewer now consumes the shared harbor runtime from `@plasius/gpu-shared`
+  instead of owning that source directly.
+- The showcase browser entry now imports `@plasius/gpu-shared` through an
+  import map instead of coupling directly to a deep `node_modules/.../dist`
+  path.
+- The viewer package now has public npm metadata, package payload validation,
+  and a GitHub Actions CD workflow so it follows the same release posture as
+  the other public `@plasius/*` package repositories.

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2025 Plasius LTD
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/NFR.md

@@ -0,0 +1,32 @@
+# Non-Functional Requirements for @plasius/gpu-demo-viewer
+
+## 1. Purpose
+
+This document defines non-functional requirements for the shared GPU demo viewer.
+The repo is static validation tooling with embedded catalog metadata and browser
+entry surfaces.
+
+## 2. Security
+
+- No secrets, auth credentials, or environment-derived runtime values may be
+  committed in viewer source assets or manifest files.
+- Third-party scripts or network resources used by demos must remain explicit and
+  auditable.
+
+## 3. Reliability and Determinism
+
+- Demo manifest and showcase definitions must be stable, deterministic, and
+  mechanically testable.
+- Existing demo tests must continue to cover manifest shape and asset compatibility.
+
+## 4. Build and Validation
+
+- Validation baseline for this repo is: `npm run lint`, `npm run test`,
+  `npm run typecheck`, and `npm run build`.
+- New baseline controls should not require browser execution for static verification.
+
+## 5. Rollout and Documentation
+
+- This viewer is intentionally non-user-facing runtime infrastructure.
+- Baseline operations are governed by the parent feature flag:
+  `platform.repo-hardening-sweep.enabled`.

package/README.md

@@ -0,0 +1,128 @@
+# @plasius/gpu-demo-viewer
+
+Static root-level launcher for validating the `gpu-*` package demos from one place.
+
+## Purpose
+
+This viewer exists to accelerate manual validation across the GPU package surface:
+
+- browser-backed demos can be launched or embedded from one URL
+- the integrated showcase consumes the shared 3D harbor runtime from `@plasius/gpu-shared`
+- the experimental wavefront path-tracing demo mounts the
+  `@plasius/gpu-renderer` WebGPU mesh BVH renderer
+- remaining code-example demos still expose their recommended command and entry file
+- the manifest is tested so new `gpu-*` demo folders do not get missed
+
+## Run
+
+From this package:
+
+```bash
+npm run demo
+```
+
+Then open:
+
+```text
+http://localhost:8000/gpu-demo-viewer/
+```
+
+The server points at the workspace root, so sibling package demos remain reachable from the viewer.
+
+To open the experimental wavefront path-tracing technique demo directly:
+
+```text
+http://localhost:8000/gpu-demo-viewer/wavefront/?experimental=wavefront
+```
+
+Deterministic 540p capture settings are available at:
+
+```text
+http://localhost:8000/gpu-demo-viewer/wavefront/?experimental=wavefront&capture=1
+```
+
+The displayed primary-ray count is calculated as:
+
+```text
+render width x render height x samples per pixel
+```
+
+The debug panel also reports the separate screen-pixel count so render
+resolution and stochastic sampling cost remain visible independently.
+Continuation rays are then spawned from the active queue by bounce depth inside
+the renderer. The active demo presets are 960x540 capture, 1280x720 balanced,
+1920x1080 detail, and a 3840x2160 4K target. The 540p/720p/1080p presets
+default to 8 samples per pixel, while 4K defaults to 4 samples per pixel; the
+renderer keeps queue buffers tile-bounded so these targets do not require
+full-frame ray queues.
+
+The wavefront page runs a live render loop by default. The performance panel
+shows FPS, frame timing, primary rays per second, and a 100% stacked timing bar
+for the viewer-observed frame budget: WebGPU command dispatch, GPU completion
+wait, optional probe/readback, overlay update, and requestAnimationFrame pacing.
+These timings are browser-side measurements; they identify where the viewer is
+blocked each frame but do not yet replace future GPU timestamp-query profiling
+inside individual compute passes.
+
+## Static Validation Contract
+
+This repository is a public npm package that ships the static validation
+surface for the `gpu-*` family.
+
+- `npm run demo` serves the workspace root so sibling `gpu-*` demos are
+  reachable from one URL.
+- `npm run typecheck` syntax-checks the shipped browser entrypoints and
+  manifest modules.
+- `npm run build` verifies the static contract documented in
+  `docs/adrs/adr-0001-gpu-demo-viewer-governance-baseline.md`.
+- `npm run pack:check` verifies the public npm package payload before GitHub
+  Actions publishes it.
+- Releases are published only through `.github/workflows/cd.yml` with npm
+  provenance and the GitHub `production` environment.
+
+## Validation Notes
+
+- Browser-backed WebGPU demos still require `localhost` or `HTTPS`.
+- The wavefront path-tracing demo is a WebGPU renderer mount, not a CPU/static
+  canvas tracer. It submits only the benchmark model mesh set with
+  `displayQuality: true`, builds the renderer mesh BVH on the GPU, disables
+  environment portals, and leaves skybox/environment lighting as the only
+  scene lighting source. The demo intentionally excludes the previous synthetic
+  room, floor, wall, emissive-panel, and fluid-surface geometry so most escaped
+  paths should terminate against the skybox rather than unlit scene blockers.
+  Shallow no-light/max-depth paths return the renderer ambient residual to
+  approximate unresolved high-order indirect bounces. The demo exposes 1, 4, 8,
+  and 16 samples-per-pixel settings and defaults to 8 spp for the 540p, 720p,
+  and 1080p presets. The denoise toggle runs the renderer post pass; denoise
+  smooths neighboring pixels but does not replace active-ray skybox/environment
+  hits as the primary lighting source. The loop updates camera uniforms every
+  animation frame through `@plasius/gpu-renderer` so the FPS counter represents
+  a moving realtime render rather than repeated presentation of one static
+  frame.
+- The wavefront performance chart is intended for local tuning: compare
+  resolution, depth, samples-per-pixel, and denoise settings while watching
+  whether time is dominated by command dispatch, sampled GPU completion sync,
+  readback, overlay work, or frame pacing. The demo does not hard-sync every
+  frame; completion sync is sampled periodically to avoid making the viewer
+  itself serialize the GPU queue.
+- The shared integration showcase is 3D but does not require WebGPU initialization just to render the validation scene.
+- The showcase now resolves `@plasius/gpu-shared` through an import map so the browser entry uses the package public surface instead of a deep internal file path.
+- `gpu-world-generator` is launched from its built `demo/dist/` bundle in the viewer because its source demo uses a Vite workflow.
+- Code-example packages are listed for discovery but are not embedded in an iframe.
+
+## Local Checks
+
+```bash
+npm run build
+npm run typecheck
+npm run lint
+npm run pack:check
+npm test
+```
+
+## Governance
+
+- Non-functional requirements: [`NFR.md`](./NFR.md)
+- Delivery workflow: [`WORKFLOW.md`](./WORKFLOW.md)
+- Feature flags and capabilities: [`FLAGS_AND_CAPABILITIES.md`](./FLAGS_AND_CAPABILITIES.md)
+- Architectural decision log: [`docs/adrs/index.md`](./docs/adrs/index.md)

package/assets/brigantine.gltf

@@ -0,0 +1,93 @@
+{
+  "asset": {
+    "version": "2.0",
+    "generator": "Plasius demo asset generator"
+  },
+  "scene": 0,
+  "scenes": [
+    {
+      "nodes": [0]
+    }
+  ],
+  "nodes": [
+    {
+      "mesh": 0,
+      "name": "brigantine",
+      "extras": {
+        "physics": {
+          "shape": "box",
+          "halfExtents": [1.35, 0.95, 3.9],
+          "mass": 3200,
+          "restitution": 0.22,
+          "linearDamping": 0.04,
+          "angularDamping": 0.08,
+          "waterline": 0.42
+        }
+      }
+    }
+  ],
+  "meshes": [
+    {
+      "name": "brigantine-hull",
+      "primitives": [
+        {
+          "attributes": {
+            "POSITION": 0
+          },
+          "indices": 1,
+          "material": 0
+        }
+      ]
+    }
+  ],
+  "materials": [
+    {
+      "name": "painted-hull",
+      "pbrMetallicRoughness": {
+        "baseColorFactor": [0.56, 0.33, 0.22, 1],
+        "metallicFactor": 0.08,
+        "roughnessFactor": 0.92
+      }
+    }
+  ],
+  "buffers": [
+    {
+      "uri": "data:application/octet-stream;base64,mpmZvwAAAL/NzEzAmpmZPwAAAL/NzEzAzcysvzMzs74zM7O/zcysPzMzs74zM7O/AACgv83MTL3NzMw/AACgP83MTL3NzMw/AAAAAOxROL4zM4NAAAAAAGZm5j4AAHBAMzNzvzMzsz6amRnAMzNzPzMzsz6amRnAzcxMvz0K1z7NzEw/zcxMPz0K1z7NzEw/AAAAADMzcz9mZma/AAACAAMAAAADAAEAAgAEAAUAAgAFAAMABAAHAAUABAAGAAcABQAHAAYAAAABAAkAAAAJAAgACAAJAAwAAgAIAAwAAwAMAAkAAgAMAAoAAwALAAwAAgAKAAQAAwAFAAsACgAMAAsAAAAIAAIAAQADAAkABAAKAAYABQAGAAsAAgAKAAsAAgALAAMA",
+      "byteLength": 294
+    }
+  ],
+  "bufferViews": [
+    {
+      "buffer": 0,
+      "byteOffset": 0,
+      "byteLength": 156,
+      "target": 34962
+    },
+    {
+      "buffer": 0,
+      "byteOffset": 156,
+      "byteLength": 138,
+      "target": 34963
+    }
+  ],
+  "accessors": [
+    {
+      "bufferView": 0,
+      "byteOffset": 0,
+      "componentType": 5126,
+      "count": 13,
+      "type": "VEC3",
+      "min": [-1.35, -0.5, -3.2],
+      "max": [1.35, 0.95, 4.1]
+    },
+    {
+      "bufferView": 1,
+      "byteOffset": 0,
+      "componentType": 5123,
+      "count": 69,
+      "type": "SCALAR",
+      "max": [12],
+      "min": [0]
+    }
+  ]
+}

package/docs/adrs/adr-0001-gpu-demo-viewer-governance-baseline.md

@@ -0,0 +1,28 @@
+# ADR-0001: Define static viewer governance and validation baseline
+
+## Status
+
+Accepted
+
+## Context
+
+`@plasius/gpu-demo-viewer` is a shared validation surface for GPU demos. It is
+intended to be lightweight and static, but still needs baseline governance docs and
+verification commands to remain release-safe and auditable across repo sweeps.
+
+## Decision
+
+- Add repository-level governance documentation required by default (`NFR.md`).
+- Add ADR index and baseline ADR for public reasoning traceability.
+- Introduce `typecheck` as the canonical syntax-validation gate for shipped
+  browser entrypoints and manifest modules.
+- Define `build` as a static-contract verification step rather than a bundler
+  pipeline.
+- Record a short changelog line for the baseline completion.
+
+## Consequences
+
+- The repo now has explicit governance expectations and deterministic checks for
+  future governance and release reviews.
+- Existing behavior and demo flows are unchanged; only process and validation
+  entry points were strengthened.

package/docs/adrs/index.md

@@ -0,0 +1,5 @@
+# ADR Index
+
+## Scene and Governance ADRs
+
+- [ADR 0001: Define static viewer governance baseline and build checks](./adr-0001-gpu-demo-viewer-governance-baseline.md)