tslocalapi 0.0.1__tar.gz

tslocalapi-0.0.1/.claude/settings.local.json

@@ -0,0 +1,11 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(cd /Users/bouke/src/github.com/bouk/tslocalapi && cargo check 2>&1)"
+    ]
+  },
+  "sandbox": {
+    "enabled": false,
+    "autoAllowBashIfSandboxed": false
+  }
+}

tslocalapi-0.0.1/.gitignore

@@ -0,0 +1,144 @@
+# local checkout of tailscale source
+/tailscale
+
+# Rust
+/target
+rust/target
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+python/.venv/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

tslocalapi-0.0.1/CLAUDE.md

@@ -0,0 +1,56 @@
+# Tailscale Local API Client Libraries
+
+Client libraries for the Tailscale Local API in Rust, Python, and TypeScript.
+
+The libraries should use exact ports of the Go source, you can find the original implementation under `tailscale/client/local/`.
+
+## Versioning
+
+Package versions are independently versioned (currently **0.0.1**). The libraries target Tailscale **v1.94.1** (matching `tailscale/` checkout at v1.94.1).
+
+## Project Structure
+
+- `rust/` — Rust crate (async/tokio)
+- `python/` — Python package (async/asyncio)
+- `ts/` — TypeScript/Node.js package
+- `tailscale/` — Go reference source (gitignored)
+
+## Build & Test Commands
+
+- **Rust**: `cargo test`, `cargo check`, `cargo clippy`
+- **Python**: `uv run pytest`, `uvx ty check python/src`
+- **TypeScript**: `npm test`, `npx tsc --noEmit`
+
+## Conventions
+
+- Go JSON uses PascalCase field names; Rust uses serde rename, Python converts snake_case↔PascalCase, TypeScript interfaces match wire format directly
+- All HTTP requests use `Host: local-tailscaled.sock` and header `Tailscale-Cap: 131` (CurrentCapabilityVersion from tailcfg.go)
+- Error mapping: HTTP 403→AccessDeniedError, 412→PreconditionsFailedError, 404 on WhoIs→PeerNotFoundError
+- Connections should be reused where possible (HTTP keep-alive, connection pooling)
+- TDD: write failing tests first, then implement
+- `rust/src/types.rs` is generated by `cmd/typegen` — never edit it manually, fix the generator instead
+
+## Validation
+
+Compare client output against the `tailscale` CLI to verify implementations match the wire format:
+
+```sh
+# Status: capture both outputs and diff
+cargo run --example status 2>/dev/null > /tmp/rust_status.json
+tailscale status --json 2>/dev/null > /tmp/ts_status.json
+
+# WhoIs: use your own Tailscale IP
+cargo run --example whois -- <tailscale-ip> 2>/dev/null > /tmp/rust_whois.json
+tailscale whois --json <tailscale-ip> 2>/dev/null > /tmp/ts_whois.json
+```
+
+Known acceptable differences:
+- **null vs `[]`**: Go serializes nil slices as `null`, Rust empty `Vec` serializes as `[]`. This is cosmetic and handled by `deserialize_null_default` in the generated types.
+- **Ephemeral fields**: `LastWrite`, `RxBytes`, `TxBytes`, `Online`, etc. may differ between captures due to timing.
+
+### typegen pitfalls found during validation
+
+- `tailcfg.RawMessage` is `type RawMessage string` (not `encoding/json.RawMessage` which is `[]byte`) — must be explicitly mapped to `serde_json::Value` in `knownTypeMap`
+- `opt.Bool` resolves as kind=string via reflection but maps to `Option<bool>` — `resolveType` must detect `Option<` prefix in the Rust type to set `isOptional=true`
+- Go map values that are slice types can be `null` in JSON — Rust map value types must be wrapped in `Option<Vec<...>>` for these cases
+- Go nil slices/maps serialize as `null`, not absent — use `deserialize_with = "deserialize_null_default"` (not just `#[serde(default)]`) for `Vec` and `HashMap` fields