Skip to content

New release 4.2.0 - #11

Merged
Inventure71 merged 3 commits into
mainfrom
v10
Jun 18, 2026
Merged

Inventure71 merged 3 commits into
mainfrom
v10

Conversation

@Inventure71

Copy link
Copy Markdown
Owner

This pull request prepares the 4.2.0 release of the package, focusing on tightening the package boundary, improving performance, hardening runtime and CLI behaviors, and clarifying documentation for static hosting and integration. It introduces stricter CLI validation, reduces allocations in simulation hot loops, and makes the package easier to consume in both dynamic and static hosting environments. Documentation has been updated to reflect the new boundaries, migration notes, and integration patterns, especially for static HTML hosts and pre-JS placeholders.

Release and Package Boundary Updates

  • Added a comprehensive 4.2.0 changelog entry describing package boundary tightening, improved CLI validation, performance optimizations, and updated migration/verification notes.
  • Updated installation and migration documentation to clarify that local JavaScript training scripts are no longer part of the published package, and hosts should use documented APIs for model integration. [1] [2]
  • Added a new CLI command npm run consumer:bundle-boundaries to verify subpath bundle boundaries and updated related documentation. [1] [2]

Static Hosting and Placeholder Guidance

  • Expanded documentation to guide static HTML hosts: clarified that pre-JS placeholders must be rendered at build time and CSS copied into static outputs, with new references to the "Startup Loading" doc throughout. [1] [2] [3] [4] [5]
  • Clarified in the component inventory and getting started docs that pre-JS placeholders are host-rendered, not package-rendered, and provided explicit instructions for static integration. [1] [2]

Performance and Runtime Improvements

  • Summarized in the changelog: reduced allocations in simulation hot loops, improved reuse of geometry and data structures, and optimized race/rules/timing logic for better runtime performance.

Hardening and Validation

  • Documented stricter CLI validation for scripts, improved physics mode handling, and better alignment of browser expert resets with physics mode contracts.

Documentation Organization

  • Added and referenced a new "Testing Reliability Guide" to help contributors with risk-driven test selection and audit standards.

These changes collectively improve package reliability, performance, and integration clarity for both dynamic and static hosts.

…tegration

- Updated INSTALL_AND_UPDATE.md with migration notes for version 4.1.0, clarifying the use of the new `@inventure71/paddockjs/placeholder` HTML helper and its CSS stylesheet for improved simulator loading experience.
- Enhanced README.md to include usage examples for the placeholder feature, ensuring clarity for developers integrating the simulator.
- Introduced a new loading.md document detailing the startup loading phases, including pre-JS placeholders and package loading overlays, to guide users on implementation in both bundled and static HTML environments.
- Updated component_inventory.md and getting-started.md to reflect the new placeholder functionality and its integration into the simulator's loading process.
- Added a new npm script `consumer:bundle-boundaries` to validate that the root browser import remains the CSS/asset-owning simulator bundle while ensuring that `/placeholder`, `/data`, and `/environment` are lightweight as per their roles.
- Updated `INSTALL_AND_UPDATE.md` to include details about the new bundle boundaries check, enhancing clarity for developers on testing package integrity.
- Enhanced `README.md` to reflect the addition of the `consumer:bundle-boundaries` command in the testing workflow, ensuring users are informed about its purpose and usage.
- Introduced a new `Testing Reliability Guide` document to provide comprehensive guidelines on risk-driven test selection and required verification processes, improving overall testing practices.
- Bump package version to 4.2.0 in package.json and package-lock.json.
- Update .gitignore to include the new `.claude/` directory.
- Revise CHANGELOG.md to document minor changes, performance improvements, and fixes introduced in this release.
- Enhance INSTALL_AND_UPDATE.md with migration notes for version 4.2.0, clarifying that no breaking changes are required from version 4.1.0.
- Update documentation across multiple files to reflect the latest features and improvements, ensuring clarity for developers integrating the simulator.
@Inventure71
Inventure71 merged commit fedff4e into main Jun 18, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant