siderust-js 0.1.0

package/README.md

@@ -0,0 +1,138 @@
+# siderust-js workspace
+
+JavaScript and WebAssembly bindings for Siderust astronomy.
+
+This repository is the publishable JS workspace. It contains the npm packages,
+the shared Rust binding core used by both targets, and the Node/Web transport
+layers that expose the public JS API.
+
+The public surface is strongly typed around `qtty-js` and `tempoch-js`:
+quantities must be passed as `@siderust/qtty` or `@siderust/qtty-web`
+`Quantity` objects, and times and windows must be passed as
+`@siderust/tempoch` or `@siderust/tempoch-web` `JulianDate`,
+`ModifiedJulianDate`, and `Period` objects.
+
+## Packages
+
+| Package | Target | Status | Notes |
+| --- | --- | --- | --- |
+| [`@siderust/siderust`](./siderust-node/README.md) | Node.js | `0.1.0` | Native addon built with `napi-rs`; requires `@siderust/qtty` and `@siderust/tempoch` objects at the public API boundary. |
+| [`@siderust/siderust-web`](./siderust-web/README.md) | Browsers / bundlers | `0.1.0` | WebAssembly build with `wasm-bindgen`; requires `await init()` plus `@siderust/qtty-web` and `@siderust/tempoch-web` objects in the API. |
+
+The Node and Web packages are intended to stay aligned. Platform differences
+are transport details, not separate domain models.
+
+## Repository layout
+
+```text
+siderust-js/
+├── siderust-core/  Shared Rust binding logic used by both targets
+├── siderust-node/  Node package: @siderust/siderust
+├── siderust-web/   Browser package: @siderust/siderust-web
+└── scripts/        CI helpers for the Node package
+```
+
+## What ships in 0.1.0
+
+- A Node package exposing observer and star models, coordinate transforms,
+  ephemerides, altitude/azimuth event search, time-window intersection, and
+  lunar phase helpers.
+- A browser/WASM package exposing the same astronomy surface with explicit
+  asynchronous initialization via `init()`.
+- A strict typed JS API that uses `Quantity`, `JulianDate`,
+  `ModifiedJulianDate`, and `Period` at the public boundary rather than raw
+  numbers or `*Like` aliases.
+- TypeScript declarations for both packages matching the runtime surface.
+- Node and Web tests, examples, and package-level READMEs for the current API.
+
+## Install
+
+### Node.js
+
+```bash
+npm install @siderust/siderust @siderust/qtty @siderust/tempoch
+```
+
+```js
+const { Quantity } = require('@siderust/qtty');
+const { JulianDate } = require('@siderust/tempoch');
+const { Observer, bodyAltitudeAt } = require('@siderust/siderust');
+
+const observer = new Observer(
+  new Quantity(-17.8925, 'Degree'),
+  new Quantity(28.7543, 'Degree'),
+  new Quantity(2396, 'Meter'),
+);
+
+const altitude = bodyAltitudeAt(
+  'Sun',
+  observer,
+  new JulianDate(2451545.0).toModifiedJulianDate(),
+);
+
+console.log(altitude.value, altitude.unit);
+```
+
+### Browser / WebAssembly
+
+```bash
+npm install @siderust/siderust-web @siderust/qtty-web @siderust/tempoch-web
+```
+
+```js
+import { init as initQtty, Quantity } from '@siderust/qtty-web';
+import { init as initTempoch, JulianDate } from '@siderust/tempoch-web';
+import { init, vsop87Heliocentric } from '@siderust/siderust-web';
+
+await initQtty();
+await initTempoch();
+await init();
+
+const mars = vsop87Heliocentric('Mars', new JulianDate(2451545.0));
+console.log(mars.x.to('Kilometer').value);
+```
+
+## Development
+
+Clone the repository:
+
+```bash
+git clone git@github.com:Siderust/siderust-js.git
+cd siderust-js
+```
+
+### Node package workflow
+
+```bash
+cd siderust-node
+npm ci
+npm run build:debug
+npm test
+```
+
+The repository also exposes CI helpers:
+
+```bash
+./scripts/ci.sh all
+```
+
+### Web package workflow
+
+`siderust-web` uses `wasm-pack`:
+
+```bash
+cd siderust-web
+wasm-pack build --target web --out-dir pkg --release --scope siderust
+npm test
+```
+
+## Related documentation
+
+- [`siderust-node/README.md`](./siderust-node/README.md) for the Node package
+  API and examples.
+- [`siderust-web/README.md`](./siderust-web/README.md) for the Web package API
+  and examples.
+
+## License
+
+AGPL-3.0. See [LICENSE](./LICENSE).

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "siderust-js",
+  "version": "0.1.0",
+  "description": " Precision astronomy & satellite mechanics in safe, fast Rust. ",
+  "license": "AGPL-3.0-or-later",
+  "author": "VPRamon",
+  "type": "commonjs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/qtty-js/.github/workflows/ci.yml

@@ -0,0 +1,151 @@
+name: Qtty JS CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+env:
+  NODE_VERSION: '20'
+
+jobs:
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+          cache-dependency-path: qtty-node/package-lock.json
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            qtty-node -> qtty-node/target
+      - run: ./scripts/ci.sh install
+      - run: ./scripts/ci.sh format
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+          cache-dependency-path: qtty-node/package-lock.json
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            qtty-node -> qtty-node/target
+      - run: ./scripts/ci.sh install
+      - run: ./scripts/ci.sh lint
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+          cache-dependency-path: qtty-node/package-lock.json
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            qtty-node -> qtty-node/target
+      - run: ./scripts/ci.sh install
+      - run: BUILD_MODE=release ./scripts/ci.sh build
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+          cache-dependency-path: qtty-node/package-lock.json
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            qtty-node -> qtty-node/target
+      - run: ./scripts/ci.sh install
+      - run: ./scripts/ci.sh build
+      - run: ./scripts/ci.sh test
+
+  coverage:
+    name: Test & Coverage
+    if: ${{ github.event_name == 'push' || github.event.pull_request.draft == false }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: npm
+          cache-dependency-path: qtty-node/package-lock.json
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: |
+            qtty-node -> qtty-node/target
+      - run: ./scripts/ci.sh install
+      - run: ./scripts/ci.sh build
+      - run: ./scripts/ci.sh coverage
+      - name: Build coverage summary
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: qtty-node/coverage/cobertura-coverage.xml
+          badge: true
+          format: markdown
+          output: file
+      - name: Publish to job summary
+        run: cat code-coverage-results.md >> "$GITHUB_STEP_SUMMARY"
+      - name: Post coverage as PR comment
+        if: github.event_name == 'pull_request'
+        uses: mshick/add-pr-comment@v2
+        with:
+          message-id: qtty-js-coverage
+          message-path: code-coverage-results.md
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Upload coverage report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: qtty-js-coverage
+          path: qtty-node/coverage
+          retention-days: 7

package/qtty-js/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "qtty"]
+	path = qtty
+	url = git@github.com:Siderust/qtty.git

package/qtty-js/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to the JavaScript workspace are documented here.
+
+The vendored Rust workspace keeps its own history in
+[`qtty/CHANGELOG.md`](./qtty/CHANGELOG.md).
+
+## [0.1.0] - 2026-03-08
+
+### Added
+- Initial `qtty-js` release repository with the vendored `qtty` submodule as
+  the canonical Rust backend.
+- `@siderust/qtty` for Node.js, exposing `Quantity`, `DerivedQuantity`,
+  `convert`, compatibility helpers, unit metadata helpers, `listUnits()`, and a
+  typed `Unit` constant map.
+- `@siderust/qtty/units` factory exports for ergonomic quantity construction in
+  Node.js, including named factories, dynamic `unit(name)` lookup, and the
+  `units` registry.
+- `@siderust/qtty-web` for browsers and bundlers, exposing the same core
+  quantity model over WebAssembly with explicit async initialization via
+  `init()`.
+- TypeScript declaration files for the Node and Web packages.
+- Node examples covering quickstart usage, arithmetic, serialization, unit
+  factories, and astronomy-oriented conversions.
+- Node automated tests and GitHub Actions CI for format, lint, build, test, and
+  coverage.
+- Repository versioning is now centered on the JavaScript workspace release
+  line, starting at `1.0.0`, while the internal native crate in `qtty-node`
+  continues to track the Rust backend line separately.
+- Conversion rules, unit metadata, and FFI semantics are inherited from the
+  vendored `qtty` workspace and `qtty-ffi`.