Merge pull request #1153 from pollen-robotics/origin/1152-port-reachy-mini-sdkjs-to-ts

port reachy-mini-sdk.js to ts

Author: cdussieux

.github/workflows/npm-publish.yml

@@ -8,11 +8,11 @@ on:
     branches:
       - main
     paths:
-      - "js/**"
+      - "ts/**"
       - ".github/workflows/npm-publish.yml"
   pull_request:
     paths:
-      - "js/**"
+      - "ts/**"
       - ".github/workflows/npm-publish.yml"
 
 jobs:
@@ -23,7 +23,7 @@ jobs:
       id-token: write   # required for npm trusted publishing (OIDC)
     defaults:
       run:
-        working-directory: js
+        working-directory: ts
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
       - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e  # v6.4.0
@@ -32,17 +32,19 @@ jobs:
           registry-url: "https://registry.npmjs.org"
 
       # Install deps for the single npm package
-      # (@pollen-robotics/reachy-mini-sdk). The SDK runtime is plain
-      # JS at js/reachy-mini-sdk.js; the optional host shell lives
-      # under js/host/ and is bundled by `npm run build` into
-      # js/host/dist/, surfaced via the `./host*` subpath exports.
-      - name: Install JS package dependencies
+      # (@pollen-robotics/reachy-mini-sdk). The SDK runtime lives at
+      # ts/reachy-mini-sdk.ts (+ ts/lib/*.ts) and is compiled to
+      # ts/dist/ by `npm run build:sdk`. The optional host shell lives
+      # under ts/host/ and is bundled by `npm run build:host` into
+      # ts/host/dist/, surfaced via the `./host*` subpath exports.
+      - name: Install package dependencies
         run: npm ci
 
-      # Build the host bundles into host/dist/. Required for the
-      # `./host`, `./host/auto`, `./host/embed`, and `./host/protocol`
-      # subpath exports to resolve in the published tarball.
-      - name: Build host bundles
+      # Build the SDK dist/ + host bundles into host/dist/. Required
+      # for the `.`, `./host`, `./host/auto`, `./host/embed`, and
+      # `./host/protocol` subpath exports to resolve in the published
+      # tarball.
+      - name: Build SDK and host bundles
         run: npm run build
 
       # pyproject.toml is the single source of truth for the version.

.gitignore

@@ -262,12 +262,26 @@ src/reachy_mini/tools/camera_calibration/images_for_crop_analysis/*
 src/reachy_mini/tools/camera_calibration/images_for_crop_analysis_lite/*
 src/reachy_mini/tools/camera_calibration/*.yaml
 
-# JavaScript (single npm package at js/)
-js/node_modules/
-js/host/dist/
-js/.vite/
+# TypeScript (single npm package at ts/)
+ts/node_modules/
+ts/dist/
+ts/host/dist/
+ts/.vite/
 # The unanchored `lib/` rule above (Python template, intended for
-# root-level build artefacts) also matches `js/host/src/lib/`,
-# which holds TypeScript source. Re-include it explicitly.
-!js/host/src/lib/
-!js/host/src/lib/**
+# root-level build artefacts) also matches `ts/host/src/lib/` and
+# `ts/lib/`, which hold TypeScript source. Re-include them explicitly.
+!ts/host/src/lib/
+!ts/host/src/lib/**
+!ts/lib/
+!ts/lib/**
+# Belt-and-suspenders: declaration outputs ONLY belong under dist/.
+# A stray `tsc` run (or an IDE on-save) can emit `.d.ts(.map)` next to
+# the source; never commit those. `ts/host/src/assets/svg.d.ts` is an
+# ambient declaration (hand-written, not generated) — kept by the rule
+# below.
+ts/lib/*.d.ts
+ts/lib/*.d.ts.map
+ts/*.d.ts
+ts/*.d.ts.map
+ts/host/src/**/*.d.ts.map
+!ts/host/src/assets/svg.d.ts

AGENTS.md

@@ -281,7 +281,7 @@ Lifecycle (advanced — most consumers should just use `autoConnect()`): `authen
 
 Events: `connected`, `disconnected`, `robotsChanged`, `streaming`, `sessionStopped`, `sessionRejected` (robot busy — inspect `e.detail.activeApp`), `state` (every ~500 ms), `videoTrack`, `micSupported`, `error`.
 
-**Full API:** read the top ~90 lines of [`js/reachy-mini-sdk.js`](js/reachy-mini-sdk.js) — the file header is a complete reference.
+**Full API:** read the top ~60 lines of [`ts/reachy-mini-sdk.ts`](ts/reachy-mini-sdk.ts) — the file header is a complete reference.
 
 ### Iframe-embedded apps (mobile shell, vibe-coder preview)
 

docs/source/SDK/javascript-sdk.md

@@ -87,7 +87,7 @@ import { ReachyMini } from "https://cdn.jsdelivr.net/npm/@pollen-robotics/reachy
 > import { mountHost } from "@pollen-robotics/reachy-mini-sdk/host/auto";
 > import { connectToHost } from "@pollen-robotics/reachy-mini-sdk/host/embed";
 > ```
-> See the [host README](https://github.com/pollen-robotics/reachy_mini/tree/main/js/host) for the full integration recipe.
+> See the [host README](https://github.com/pollen-robotics/reachy_mini/tree/main/ts/host) for the full integration recipe.
 
 ### 3. Connect to your robot