een-api-toolkit 0.3.85 → 0.3.91

package/.claude/agents/een-devices-agent.md

@@ -403,6 +403,27 @@ if (isCameraOnline(camera.status)) {
 }
 ```
 
+## PTZ Camera Support
+
+When the user asks about PTZ (Pan/Tilt/Zoom) camera controls, presets, or camera movement,
+**delegate to the `een-ptz-agent`** which has specialized knowledge of:
+- `getPtzPosition()`, `movePtz()`, `getPtzSettings()`, `updatePtzSettings()`
+- Direction pad controls, click-to-center, preset management
+- PTZ automation modes (homeReturn, tour, manualOnly)
+
+To check if a camera supports PTZ, use `getCamera(id, { include: ['capabilities'] })` and check
+the nested `capabilities.ptz.capable` field:
+
+```typescript
+const result = await getCamera(cameraId, { include: ['capabilities'] })
+const capabilities = result.data?.capabilities as { ptz?: { capable?: boolean } } | undefined
+if (capabilities?.ptz?.capable) {
+  // This camera supports PTZ - use een-ptz-agent for PTZ-specific tasks
+}
+```
+
+**IMPORTANT:** The capability is at `capabilities.ptz.capable` (nested object), NOT `capabilities.ptzCapable`.
+
 ## Constraints
 - Always check authentication before API calls
 - Use appropriate status filters to reduce payload

package/.claude/agents/een-ptz-agent.md

@@ -0,0 +1,235 @@
+---
+name: een-ptz-agent
+description: |
+  Use this agent when working with PTZ camera controls: getting position,
+  moving cameras, managing presets, or implementing PTZ control UI
+  with the een-api-toolkit.
+model: inherit
+color: orange
+---
+
+You are an expert in PTZ (Pan/Tilt/Zoom) camera control with the een-api-toolkit.
+
+## Examples
+
+<example>
+Context: User wants to add PTZ controls to their app.
+user: "How do I add PTZ controls to my camera view?"
+assistant: "I'll use the een-ptz-agent to help implement PTZ controls using movePtz() and getPtzPosition()."
+<Task tool call to launch een-ptz-agent>
+</example>
+
+<example>
+Context: User wants to manage PTZ presets.
+user: "How do I save and load PTZ presets?"
+assistant: "I'll use the een-ptz-agent to implement preset management with getPtzSettings() and updatePtzSettings()."
+<Task tool call to launch een-ptz-agent>
+</example>
+
+<example>
+Context: User wants click-to-center functionality.
+user: "How do I make the camera center on where I click in the video?"
+assistant: "I'll use the een-ptz-agent to implement click-to-center using movePtz() with the centerOn move type."
+<Task tool call to launch een-ptz-agent>
+</example>
+
+## Context Files
+- docs/AI-CONTEXT.md (overview)
+- docs/ai-reference/AI-AUTH.md (auth is required)
+- docs/ai-reference/AI-DEVICES.md (camera selection)
+- docs/ai-reference/AI-PTZ.md (primary reference)
+- docs/ai-reference/AI-MEDIA.md (live video integration)
+
+## Reference Examples
+- examples/vue-ptz/ (complete PTZ control app with live video)
+
+## Your Capabilities
+1. Get current PTZ position with getPtzPosition()
+2. Move cameras with movePtz() (position, direction, centerOn)
+3. Get PTZ settings and presets with getPtzSettings()
+4. Update settings, presets, and mode with updatePtzSettings()
+5. Implement direction pad controls
+6. Implement click-to-center on live video
+7. Manage PTZ presets (save, load, delete)
+8. Configure automation modes (homeReturn, tour, manualOnly)
+
+## Key Types
+
+### PtzPosition
+```typescript
+interface PtzPosition {
+  x?: number  // Pan (horizontal)
+  y?: number  // Tilt (vertical)
+  z?: number  // Zoom level
+}
+```
+
+### PtzMove (discriminated union)
+```typescript
+// Absolute position
+{ moveType: 'position', x?: number, y?: number, z?: number }
+
+// Relative direction
+{ moveType: 'direction', direction: PtzDirection[], stepSize?: PtzStepSize }
+
+// Center on point in frame
+{ moveType: 'centerOn', relativeX: number, relativeY: number }
+
+type PtzDirection = 'up' | 'down' | 'left' | 'right' | 'in' | 'out'
+type PtzStepSize = 'small' | 'medium' | 'large'
+```
+
+### PtzSettings
+```typescript
+interface PtzSettings {
+  presets: PtzPreset[]
+  homePreset: string | null
+  mode: PtzMode           // 'homeReturn' | 'tour' | 'manualOnly'
+  autoStartDelay: number  // seconds
+}
+
+interface PtzPreset {
+  name: string
+  position: PtzPosition
+  timeAtPreset: number    // seconds at preset during tour
+}
+```
+
+### PtzSettingsUpdate
+```typescript
+interface PtzSettingsUpdate {
+  presets?: PtzPreset[]
+  homePreset?: string | null
+  mode?: PtzMode
+  autoStartDelay?: number
+}
+```
+
+## Key Functions
+
+### getPtzPosition(cameraId)
+Get current camera position:
+```typescript
+import { getPtzPosition } from 'een-api-toolkit'
+
+const { data, error } = await getPtzPosition('camera-123')
+if (data) {
+  console.log(`Pan: ${data.x}, Tilt: ${data.y}, Zoom: ${data.z}`)
+}
+```
+
+### movePtz(cameraId, move)
+Move camera with three move types:
+```typescript
+import { movePtz } from 'een-api-toolkit'
+
+// Absolute position
+await movePtz('camera-123', { moveType: 'position', x: 0.5, y: -0.3, z: 2.0 })
+
+// Direction with step size
+await movePtz('camera-123', {
+  moveType: 'direction',
+  direction: ['up', 'left'],
+  stepSize: 'medium'
+})
+
+// Center on point in video frame (0.0 to 1.0)
+await movePtz('camera-123', {
+  moveType: 'centerOn',
+  relativeX: 0.75,
+  relativeY: 0.5
+})
+```
+
+### getPtzSettings(cameraId)
+Get presets and automation settings:
+```typescript
+import { getPtzSettings } from 'een-api-toolkit'
+
+const { data, error } = await getPtzSettings('camera-123')
+if (data) {
+  console.log('Mode:', data.mode)
+  console.log('Presets:', data.presets.map(p => p.name))
+  console.log('Home:', data.homePreset)
+}
+```
+
+### updatePtzSettings(cameraId, settings)
+Update settings (partial update - only provided fields change):
+```typescript
+import { updatePtzSettings } from 'een-api-toolkit'
+
+// Change mode
+await updatePtzSettings('camera-123', { mode: 'tour' })
+
+// To add a preset, first fetch existing presets and append the new one
+const { data: settings } = await getPtzSettings('camera-123')
+const newPreset = { name: 'Entrance', position: { x: 0, y: 0, z: 1 }, timeAtPreset: 10 }
+await updatePtzSettings('camera-123', {
+  presets: [...(settings?.presets ?? []), newPreset],
+  homePreset: 'Entrance'
+})
+```
+
+## Click-to-Center Pattern
+
+```typescript
+function handleVideoClick(event: MouseEvent) {
+  const video = event.currentTarget as HTMLVideoElement
+  const rect = video.getBoundingClientRect()
+  const relativeX = (event.clientX - rect.left) / rect.width
+  const relativeY = (event.clientY - rect.top) / rect.height
+
+  movePtz(cameraId, {
+    moveType: 'centerOn',
+    relativeX,
+    relativeY
+  })
+}
+```
+
+## Error Handling
+
+| Error Code | Meaning | Action |
+|------------|---------|--------|
+| AUTH_REQUIRED | Not authenticated | Redirect to login |
+| NOT_FOUND | Camera not found or no PTZ support | Show "not found" message |
+| FORBIDDEN | No permission | Show access denied message |
+| VALIDATION_ERROR | Empty camera ID | Fix input |
+| API_ERROR | Server error | Show error, allow retry |
+
+## Detecting PTZ-Capable Cameras
+
+To check if a camera supports PTZ, fetch it with `include: ['capabilities']` and check the
+nested `capabilities.ptz.capable` field. The structure is:
+
+```typescript
+// Response from getCamera(id, { include: ['capabilities'] })
+{
+  capabilities: {
+    ptz: {
+      capable: true,       // Camera supports PTZ
+      panTilt: true,       // Supports pan/tilt
+      zoom: true,          // Supports zoom
+      positionMove: true,  // Supports absolute position moves
+      directionMove: true, // Supports directional moves
+      centerOnMove: true,  // Supports center-on moves
+      fisheye: false       // Whether camera is fisheye
+    }
+  }
+}
+```
+
+**IMPORTANT:** The PTZ capability is at `capabilities.ptz.capable` (nested under a `ptz` object),
+NOT at `capabilities.ptzCapable` (flat). Always use `capabilities?.ptz?.capable` to check.
+
+Also check `effectivePermissions.controlPTZ` to verify the user has permission to move the camera,
+and `effectivePermissions.editPTZStations` for managing presets.
+
+## Constraints
+- Always check authentication before API calls
+- Verify camera has PTZ capability (`capabilities.ptz.capable`) before showing controls
+- Check user permissions (`effectivePermissions.controlPTZ`) before enabling movement
+- Poll position periodically (every 5s) for position display
+- Handle 204 responses for PUT/PATCH (no response body)
+- Use encodeURIComponent for camera IDs in URLs

package/CHANGELOG.md

@@ -2,24 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.3.85] - 2026-02-17
+## [0.3.91] - 2026-02-21
 
 ### Release Summary
 
-#### PR #113: fix: address three security review findings
-## Summary
-- **HIGH**: Validate hostname before persisting OAuth token — `setBaseUrl()` now returns boolean; `handleAuthCallback()` checks it before calling `setToken()`, preventing token persistence when hostname is rejected
-- **MEDIUM**: Pin external proxy repo clone in CI workflows (`validate-pr`, `test-release`) to commit SHA `4e8f45f` to prevent supply chain attacks
-- **LOW**: Remove unnecessary `id-token: write` permission from `claude-code-review` workflow
-
-## Test plan
-- [x] 644/644 unit tests pass
-- [x] 225/225 E2E tests pass across all 11 example apps
-- [x] Lint clean, build succeeds
-- [ ] Validate-PR workflow passes on this PR
-
-🤖 Generated with [Claude Code](https://claude.com/claude-code)
-
 #### PR #118: Release v0.3.85 - API coverage docs and workflow security fix
 ## Summary
 
@@ -51,23 +37,66 @@ v0.3.85
 
 🤖 Generated with [Claude Code](https://claude.com/claude-code)
 
+#### PR #128: Release v0.3.89: PTZ camera control API and vue-ptz example
+## Summary
+
+This release adds PTZ (Pan/Tilt/Zoom) camera control support to the toolkit:
+
+- **PTZ API functions**: `getPtzPosition()`, `movePtz()`, `getPtzSettings()`, `updatePtzSettings()` with full TypeScript types
+- **PTZ types**: `PtzPosition`, `PtzMove` (discriminated union: position/direction/centerOn), `PtzSettings`, `PtzPreset`, `PtzSettingsUpdate`
+- **vue-ptz example app**: Complete PTZ control application with live video, direction pad, click-to-center, position display, preset management, and API call logging
+- **Camera capabilities**: Added `capabilities` field to `Camera` type for PTZ detection via `include: ['capabilities']`
+- **Documentation**: AI-PTZ.md reference doc, een-ptz-agent, updated AI-CONTEXT.md and CLAUDE.md
+- **E2E tests**: Conditional PTZ API tests that exercise position read, direction move, and preset loading when a PTZ camera is available
+
+### Additional changes
+- Dependabot: CodeQL action bump to 4.32.3
+- CI: Use floating v1 tag for claude-code-action instead of SHA pin
+
+## Commits
+
+- `c552fd0` feat: add PTZ camera control API and vue-ptz example app
+- `6a12649` fix: use single getCameras call with include and pagination for PTZ discovery
+- `2b04b26` fix: address review findings in vue-ptz example app
+- `92a18e4` fix: address remaining review findings
+- `4d01c2c` fix: use floating v1 tag for claude-code-action instead of SHA pin
+- `3f197ba` chore(deps): bump github/codeql-action from 4.32.2 to 4.32.3
+
+## Test Results
+
+| Check | Result |
+|-------|--------|
+| Lint | Pass (0 errors) |
+| Unit tests | 681 passed (24 suites) |
+| Build | Pass |
+| E2E (12 apps) | All passed |
+| Security review | No vulnerabilities found |
+| Confidential data scan | Clean |
+
+**Version**: 0.3.89
+
+🤖 Generated with [Claude Code](https://claude.com/claude-code)
+
 
 ### Detailed Changes
 
 #### Features
-- feat: add EEN API coverage documentation and agent
+- feat: add PTZ camera control API and vue-ptz example app
 
 #### Bug Fixes
-- fix: restrict npm-publish workflow_dispatch to production branch
-- fix: restrict workflow_dispatch to production branch to prevent supply chain attack
+- fix: address remaining PR #128 review findings
+- fix: address PR #128 review findings
+- fix: address remaining review findings
+- fix: address review findings in vue-ptz example app
+- fix: use single getCameras call with include and pagination for PTZ discovery
+- fix: use floating v1 tag for claude-code-action instead of SHA pin
 
 #### Other Changes
-- docs: rename een-api-coverage-agent to api-coverage-agent
-- docs: add missing agents to README agent list
+- chore(deps): bump github/codeql-action from 4.32.2 to 4.32.3
 
 ### Links
 - [npm package](https://www.npmjs.com/package/een-api-toolkit)
-- [Full Changelog](https://github.com/klaushofrichter/een-api-toolkit/compare/v0.3.82...v0.3.85)
+- [Full Changelog](https://github.com/klaushofrichter/een-api-toolkit/compare/v0.3.85...v0.3.91)
 
 ---
-*Released: 2026-02-17 11:45:53 CST*
+*Released: 2026-02-21 17:41:30 CST*