ballistics-engine 0.36.3 → 0.39.0

package/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 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 2025 Alex Jokela
+
+   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/README.md

@@ -16,7 +16,7 @@ A high-performance ballistics trajectory calculation engine with comprehensive p
 - **Drops Reference: LOS vs Target Plane** - Reference sampled drops to the line of sight (default, unchanged) or to the vertical target plane on steep inclined shots (`trajectory --drops-reference target`: drop ÷ cos(shooting angle), JBM's "target plane" checkbox; sampled table/CSV column relabeled `Drop (target)`/`drop_target_in`; solve-json `shot.drops_reference`) — see [CLI_USAGE.md](CLI_USAGE.md#drops-reference-los-vs-target-plane---drops-reference--mba-1403)
 - **Scope Tracking Correction Factors** - Compensate turrets that don't track their nominal click value: derive `CF = actual/dialed` from a tall-target test (`tall-target` subcommand, pure arithmetic), then `--elevation-cf`/`--windage-cf` (or validated saved-profile fields) DIVIDE every dial-unit output once at the shared conversion boundary — come-ups, range/compare/wind cards, mover lead/Ring, PDF dope card, zero MOA/mrad — never raw inches (an under-tracking scope, CF < 1, needs more dial); `true-velocity` multiplies dialed observations by the CF (scope-dial to true angular) so scope error is not baked into trued MV/BC — see [CLI_USAGE.md](CLI_USAGE.md#scope-tracking-correction-factors---elevation-cf---windage-cf-tall-target--mba-1358)
 - **Equivalent Horizontal Range (BDC shoot-to)** - Inclined zeroed shots print the flat range whose angular correction against the same zero matches the inclined solution (SIG AMR / Leica EHR / Gunwerks style, angular-match inversion over one flat re-solve — not the rifleman's-rule cosine), so fixed BDC turrets/reticles can dial as if flat (`trajectory` summary line; solve-json `summary.equivalent_horizontal_range_m`; public `TrajectorySolver::equivalent_horizontal_range`) — see [CLI_USAGE.md](CLI_USAGE.md#equivalent-horizontal-range-bdc-shoot-to--mba-1395)
-- **Reticle Hold Points** - Place a firing solution where you actually read it: a point in your own reticle, FFP/SFP aware with second-focal-plane subtensions rescaled for the magnification in use (`reticle hold`, native + browser terminal + a new appended C ABI export; `reticle generate mil-grid|tree|bdc` builds descriptions in one shared serde schema that saved profiles, `--reticle-json` and solve-json's optional `reticle` block all speak). Horus/TREMOR grid layouts, wind-dot calibration and any vendor catalog are deliberately excluded — see [CLI_USAGE.md](CLI_USAGE.md#reticle-hold-points-reticle--mba-1361)
+- **Reticle Hold Points** - Place a firing solution where you actually read it: a point in your own reticle, FFP/SFP aware with second-focal-plane subtensions rescaled for the magnification in use (`reticle hold`, native + browser terminal + a new appended C ABI export; `reticle generate mil-grid|tree|bdc` builds descriptions in one shared serde schema that saved profiles, `--reticle-json` and solve-json's optional `reticle` block all speak; `reticle import` converts a third-party Ventum spec into that schema and names on stderr every element it could not represent as a hold — arcs included, with each horseshoe's apex and tips resolved for you rather than invented as marks). Horus/TREMOR grid layouts, wind-dot calibration and any vendor catalog are deliberately excluded — see [CLI_USAGE.md](CLI_USAGE.md#reticle-hold-points-reticle--mba-1361)
 - **Reticle/BDC Inverse Solvers** - Three read-only solvers over an existing load, sharing one drop-vs-range root find: `mark-to-range` maps each reticle subtension to the range where it lands (Nightforce / Nikon Spot On / Swarovski / TRACT), reporting marks the load cannot reach rather than dropping them; `bdc-match` fits the magnification that makes an SFP BDC reticle match the load (Zeiss Rapid-Z; closed-form least squares, with a residual warning when nothing fits); `optimal-zero` min-max searches the one zero that minimizes the largest hold a whole target list needs and reports whether a dead-center hold keeps each inside its vital zone (GeoBallistics HDZ). CLI-only this train — see [CLI_USAGE.md](CLI_USAGE.md#reticlebdc-inverse-solvers--mba-1362)
 - **Robust Hold Corridors** - Solve a bounded set of NAMED segmented-wind scenarios at once (`hold-corridor --scenarios set.json --ranges 200,400,600 [--target rect:WxH|circle:D]`) and get, at every range, each scenario's hold, the min/max corridor they span, the minimax (Chebyshev-center) hold, the worst-case miss from it, and whether one hold keeps every scenario inside the target — with a versioned `RobustHoldReportV1` JSON form. Caps (≤8 scenarios, ≤64 ranges) and malformed segments are structured errors raised *before* any solving, and reordering scenarios cannot change the answer. No probabilities are assigned anywhere: the corridor is the span of the hypotheses you supplied, not a confidence interval — see [CLI_USAGE.md](CLI_USAGE.md#robust-hold-corridors-hold-corridor--mba-1349)
 - **Moving-Target Lead** - Wind-aware hold tables for targets moving at a constant speed/angle, with iterative intercept-range correction for non-perpendicular motion (`lead` subcommand; public `ballistics_engine::calculate_lead` API) — see [CLI_USAGE.md](CLI_USAGE.md#moving-target-lead)
@@ -662,34 +662,38 @@ These bindings depend on the `ballistics-engine` crate published on [crates.io](
 
 ### WASM / npm Package
 
-The engine also compiles to WebAssembly (`src/wasm.rs`, `wasm-bindgen`) and already powers
-[ballistics.sh](https://ballistics.sh) and [ballistics.rs](https://ballistics.rs) in the browser.
-It is not yet published to npm for third-party use — `scripts/build-npm.sh` builds and prepares a
-publish-ready package; publishing itself is a manual step (see below).
+The engine also compiles to WebAssembly (`src/wasm.rs`, `wasm-bindgen`), powers
+[ballistics.sh](https://ballistics.sh) and [ballistics.rs](https://ballistics.rs) in the browser,
+and is published to npm as
+[**`ballistics-engine`**](https://www.npmjs.com/package/ballistics-engine).
 
 ```bash
-scripts/build-npm.sh
+npm install ballistics-engine
 ```
 
-This builds two `wasm-bindgen` targets, both with `--no-default-features` (the default
-`pdf`/`online` features pull in `printpdf`/`ureq`+`ring`, which do not compile for
-`wasm32-unknown-unknown`) plus
-`--features wasm-terminal` (the browser terminal's command set — see
-[Trimming the WASM module](#trimming-the-wasm-module)):
-
-- **`pkg/`** — `--target bundler`, the package meant for `npm publish`. Consumed via a native
-  `.wasm` ES import by bundlers that understand it (webpack with `experiments.asyncWebAssembly`,
-  Vite, Rollup + `@rollup/plugin-wasm`, Parcel).
-- **`pkg-web/`** — `--target web`, a no-bundler build for direct `<script type="module">` browser
-  use or manual Node usage without a bundler — the same `--target` already used to build
-  ballistics.sh/ballistics.rs's WASM. Documented and built for completeness; not published under
-  the primary package name in this initial pass.
-
-`wasm-pack` has no built-in dual-target/"publish both" mode, and stitching bundler- and web-target
-output into one package.json via manual `exports` conditions isn't something `wasm-pack` generates
-or tests for you — see the comment header of `scripts/build-npm.sh` for the full reasoning. A
-single bundler-target package as the published npm artifact, with the web build documented
-separately, is the ecosystem-standard shape for `wasm-bindgen` crates on npm.
+The published package is the `wasm-pack --target web` build: the entry point is an ES module with
+an explicit async `init()`, which is the same artifact ballistics.sh loads. It is built with
+`--no-default-features` (the default `pdf`/`online` features pull in `printpdf`/`ureq`+`ring`,
+which do not compile for `wasm32-unknown-unknown`) plus `--features wasm-terminal` — the browser
+terminal's command set, see [Trimming the WASM module](#trimming-the-wasm-module).
+
+Publishing is automated: `.github/workflows/publish-npm.yml` runs on every `v*` tag and publishes
+with npm trusted publishing (OIDC), so there is no npm token anywhere in this repository and every
+release carries a provenance attestation. `scripts/release/npm-package.sh` builds and verifies the
+exact directory that gets published, and is worth running by hand to inspect a release:
+
+```bash
+scripts/release/npm-package.sh 0.36.3 /tmp/npm-0.36.3
+npm pack --dry-run /tmp/npm-0.36.3     # lists the tarball contents, publishes nothing
+```
+
+`scripts/build-npm.sh` is a separate, exploratory script that builds **both** `wasm-bindgen`
+targets side by side — `pkg/` (`--target bundler`, for webpack with
+`experiments.asyncWebAssembly`, Vite, Rollup + `@rollup/plugin-wasm`, Parcel) and `pkg-web/`
+(`--target web`). Only the web build is published under the `ballistics-engine` name; `wasm-pack`
+has no dual-target/"publish both" mode, and the two targets' module wiring differs enough that
+they cannot be stitched into one package via `exports` conditions without hand-written glue
+`wasm-pack` neither generates nor tests.
 
 ### Trimming the WASM module
 
@@ -788,25 +792,18 @@ Two things are *not* separable, because they are not separate to begin with:
   decision-support) are native-CLI-only — they were never wired into the WASM dispatch, and
   dead-code elimination already keeps them out of the module. There is nothing to remove.
 
-The script also post-processes each `package.json` (name, description, license, repository,
-keywords, and the `files` list — including an `LICENSE-APACHE` entry `wasm-pack` itself omits even
-though it copies the file) and installs `README-npm.md` as the package's `README.md`.
-
-**Before publishing**, edit `pkg/package.json`'s `"name"` — it ships as the placeholder
-`"@SCOPE/ballistics-engine"`. Replace `SCOPE` with the maintainer's real npm org/user scope (a
-scope decision, plus an npm account with publish rights to it, are both needed and don't exist yet
-as of this writing). Then:
-
-```bash
-scripts/build-npm.sh
-cd pkg
-npm pack --dry-run   # sanity-check the tarball contents first
-npm publish --access public
-```
-
-(`--access public` is required the first time a scoped package is published, since scoped packages
-default to private on free npm accounts; `pkg/package.json` also sets `publishConfig.access` to
-`public` so a plain `npm publish` works too.)
+Both packaging scripts post-process the generated `package.json` through
+`scripts/build-npm-postprocess.mjs` (name, description, license, repository, keywords, and the
+`files` list — including a `LICENSE-APACHE` entry `wasm-pack` omits even though it copies the file,
+so the dual-licensed crate would otherwise ship only half its licence text). `build-npm.sh`
+additionally installs `README-npm.md` as its packages' `README.md`; the published package keeps the
+crate's own `README.md`, which is what `wasm-pack` copies.
+
+Publishing is not a manual step. `.github/workflows/publish-npm.yml` builds and publishes on a
+`v*` tag using npm trusted publishing; see `scripts/release/RELEASE.md` ("The npm channel") for the
+one-time npmjs.com setup, what breaks the trust relationship, and how to re-run a tag whose publish
+failed. Ten versions between 0.25.0 and 0.36.3 are missing from npm because the channel was hand-run
+at the time; they are not backfillable and are documented as staying missing.
 
 ## FFI Layer
 

package/package.json

@@ -4,17 +4,18 @@
   "collaborators": [
     "Alex Jokela <email@tinycomputers.io>"
   ],
-  "description": "High-performance ballistics trajectory engine with professional physics",
-  "version": "0.36.3",
+  "description": "High-performance ballistics trajectory engine with professional physics (WASM build)",
+  "version": "0.39.0",
   "license": "MIT OR Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/ajokela/ballistics-engine"
+    "url": "git+https://github.com/ajokela/ballistics-engine.git"
   },
   "files": [
     "ballistics_engine_bg.wasm",
     "ballistics_engine.js",
-    "ballistics_engine.d.ts"
+    "ballistics_engine.d.ts",
+    "LICENSE-APACHE"
   ],
   "main": "ballistics_engine.js",
   "homepage": "https://ballistics.rs/",
@@ -26,6 +27,11 @@
     "ballistics",
     "trajectory",
     "physics",
-    "simulation"
-  ]
-}
+    "simulation",
+    "wasm",
+    "webassembly"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}