@putdotio/taizn 1.2.0 → 1.4.0

package/docs/DISTRIBUTION.md

@@ -0,0 +1,54 @@
+# Distribution
+
+## Delivery Model
+
+Every merge to `main` should be releasable.
+
+CI runs:
+
+1. `vp install`
+2. `vp run verify`
+3. `semantic-release` on `main`
+
+The Effect source helper exits when `CI` is set, so install, pack, publish, and
+release automation do not clone the ignored Effect source checkout.
+
+The release workflow publishes the scoped `@putdotio/taizn` package to npm, creates a
+GitHub release, and commits the released `package.json` version back to `main`
+with `[skip ci]`.
+
+Verify jobs can cancel stale runs; release jobs queue so package publishing is
+not interrupted.
+
+## Release Environment
+
+The release job uses the GitHub Environment named `release`.
+
+Environment entries:
+
+- secrets: `PUTIO_RELEASE_BOT_PRIVATE_KEY`
+- variables: `PUTIO_RELEASE_BOT_CLIENT_ID`
+- approval: none
+- branch policy: `main`
+- deployment records: disabled with `deployment: false`
+
+The npm package uses Trusted Publishing from GitHub Actions. On npm, configure owner `putdotio`, repository `taizn`, workflow `ci.yml`, and Environment named `release` for the package.
+
+During the `@semantic-release/npm` publish step, npm detects the GitHub OIDC identity, mints short-lived publish credentials, and publishes provenance for the release job.
+
+Release GitHub writes use `putio-release-bot`, and the release-bot remote is configured only after dependencies are installed.
+
+## Local Checks
+
+```bash
+vp install
+vp run verify
+```
+
+## Versioning
+
+Conventional Commits drive releases:
+
+- `feat:` publishes a minor release
+- `fix:` publishes a patch release
+- breaking changes publish a major release

package/docs/TV_REMOTE.md

@@ -0,0 +1,70 @@
+# Samsung TV Remote
+
+`taizn tv` wraps Samsung's websocket remote-control API for local development
+and smoke checks against a physical TV or monitor.
+
+## Commands
+
+```bash
+taizn tv info
+taizn tv pair
+taizn tv press KEY_ENTER
+taizn tv press --delay-ms 250 KEY_HOME KEY_DOWN KEY_ENTER
+```
+
+- `info` reads the TV's local `/api/v2/` metadata and reports remote-control
+  support.
+- `pair` opens a Samsung remote websocket and waits for the TV to approve the
+  client. When pairing succeeds, it stores the token in `.taizn/remote.json`.
+- `press` reconnects with the paired token and sends a Samsung remote key such
+  as `KEY_HOME`, `KEY_BACK`, `KEY_UP`, `KEY_DOWN`, `KEY_LEFT`, `KEY_RIGHT`, or
+  `KEY_ENTER`. Pass multiple keys to send a navigation sequence on one
+  websocket connection. `--delay-ms` controls the delay between sequence keys.
+
+## Environment
+
+```bash
+TAIZN_TV_HOST=<tv-ip>
+TAIZN_TV_INFO_PORT=8001
+TAIZN_TV_NAME=taizn
+TAIZN_TV_PORT=8002
+TAIZN_TV_PROTOCOL=wss
+TAIZN_TV_TIMEOUT_MS=30000
+TAIZN_TV_TOKEN=<paired-remote-token>
+```
+
+`TAIZN_TV_HOST` is optional when `TAIZN_TARGET=<tv-ip>:26101` is set; `taizn`
+uses the host part of `TAIZN_TARGET` as a fallback. The default remote endpoint
+is `wss://<tv-ip>:8002`. Use `TAIZN_TV_PROTOCOL=ws` and `TAIZN_TV_PORT=8001`
+only for older TVs or test fixtures that do not support the TLS endpoint.
+`TAIZN_TV_INFO_PORT` controls the HTTP metadata endpoint used by `tv info`.
+
+`TAIZN_TV_TOKEN` overrides `.taizn/remote.json` for one-off runs. Do not commit
+remote tokens. `TAIZN_TV_TIMEOUT_MS` controls websocket pairing/key-press and
+HTTP info request timeouts.
+
+## Pairing
+
+Run:
+
+```bash
+TAIZN_TV_HOST=<tv-ip> taizn tv pair
+```
+
+If the TV shows an allow prompt, approve it. If no prompt appears, check the TV
+settings for IP remote control and device permissions, then retry pairing.
+
+Successful pairing prints the token and writes:
+
+```txt
+.taizn/remote.json
+```
+
+The `.taizn/` directory is local state and must stay ignored.
+
+## Scope
+
+Remote commands send key presses only. They do not install widgets, launch
+applications, or capture screenshots. Use the regular `taizn install` and Tizen
+CLI commands for app lifecycle work. Use logs, app-level probes, Samsung Web
+Inspector, Remote Test Lab, or external capture when visual proof is needed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putdotio/taizn",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "A tiny CLI companion for interacting with Tizen ecosystem.",
   "keywords": [
     "cli",
@@ -23,6 +23,7 @@
   },
   "files": [
     "dist",
+    "docs",
     "README.md"
   ],
   "type": "module",
@@ -39,21 +40,21 @@
     "live:test:install": "vp pack src/taizn.ts && node live-test/run-live-test.ts --install",
     "live:test:profile": "vp pack src/taizn.ts && node live-test/run-live-test.ts --profile",
     "prepack": "vp pack src/taizn.ts",
+    "prepare": "./scripts/prepare-effect.sh",
     "smoke": "vp pack src/taizn.ts && node dist/taizn.mjs --version && node dist/taizn.mjs --help >/dev/null",
-    "test": "vp test --passWithNoTests",
+    "test": "vitest run --passWithNoTests",
     "typecheck": "tsc --noEmit",
-    "verify": "vp check . && tsc --noEmit && vp pack src/taizn.ts && vp test --passWithNoTests && npm pack --dry-run"
+    "verify": "vp check . && tsc --noEmit && vp pack src/taizn.ts && vp run test && npm pack --dry-run"
   },
   "dependencies": {
-    "@effect/cli": "^0.75.1",
-    "@effect/platform": "^0.96.1",
-    "@effect/platform-node": "^0.106.0",
-    "@effect/printer": "^0.49.0",
-    "@effect/printer-ansi": "^0.49.0",
-    "effect": "^3.21.2"
+    "@effect/platform-node": "4.0.0-beta.66",
+    "effect": "4.0.0-beta.66",
+    "ws": "^8.20.1"
   },
   "devDependencies": {
+    "@effect/vitest": "4.0.0-beta.66",
     "@types/node": "^25.7.0",
+    "@types/ws": "^8.18.1",
     "typescript": "^6.0.2",
     "vite-plus": "^0.1.20",
     "vitest": "^4.1.6"