een-api-toolkit 0.3.15 → 0.3.20

package/docs/AI-CONTEXT.md

@@ -1,6 +1,6 @@
 # EEN API Toolkit - AI Reference
 
-> **Version:** 0.3.15
+> **Version:** 0.3.20
 >
 > This file is optimized for AI assistants. It contains all API signatures,
 > types, and usage patterns in a single, parseable document.
@@ -214,6 +214,7 @@ Complete Vue 3 applications demonstrating toolkit features:
 | [vue-feeds](../examples/vue-feeds/) | Live video streaming (preview and main) | `src/views/Feeds.vue` |
 | [vue-events](../examples/vue-events/) | Events with bounding box overlays | `src/components/EventsModal.vue` |
 | [vue-alerts-metrics](../examples/vue-alerts-metrics/) | Event metrics, alerts, and notifications | `src/components/MetricsChart.vue`, `AlertsList.vue` |
+| [vue-event-subscriptions](../examples/vue-event-subscriptions/) | Real-time event streaming with SSE | `src/views/Subscriptions.vue`, `LiveEvents.vue` |
 
 ### Configuration
 
@@ -293,6 +294,22 @@ Complete Vue 3 applications demonstrating toolkit features:
 | `listNotifications(params?)` | List notifications with filters | `Result<PaginatedResult<Notification>>` |
 | `getNotification(id)` | Get a specific notification by ID | `Result<Notification>` |
 
+### EventSubscriptions Functions
+
+| Function | Purpose | Returns |
+|----------|---------|---------|
+| `listEventSubscriptions(params?)` | List all event subscriptions | `Result<PaginatedResult<EventSubscription>>` |
+| `getEventSubscription(id)` | Get a specific subscription by ID | `Result<EventSubscription>` |
+| `createEventSubscription(params)` | Create a new event subscription | `Result<EventSubscription>` |
+| `deleteEventSubscription(id)` | Delete an event subscription | `Result<void>` |
+| `connectToEventSubscription(sseUrl, options)` | Connect to SSE stream for real-time events | `Result<SSEConnection>` |
+
+### Utility Functions
+
+| Function | Purpose | Returns |
+|----------|---------|---------|
+| `formatTimestamp(timestamp)` | Convert ISO timestamp from Z to +00:00 format (required by EEN API) | `string` |
+
 ---
 
 ## Core Types
@@ -1275,6 +1292,40 @@ console.log('Session URL:', data.url)
 
 ---
 
+## Utilities
+
+### formatTimestamp
+
+Converts ISO 8601 timestamps from `Z` (Zulu/UTC) format to `+00:00` format, as required by the EEN API.
+
+**Why this is needed:** JavaScript's `Date.toISOString()` returns timestamps with a `Z` suffix (e.g., `2025-01-15T22:30:00.000Z`), but the EEN API requires the `+00:00` format (e.g., `2025-01-15T22:30:00.000+00:00`).
+
+```typescript
+import { formatTimestamp } from 'een-api-toolkit'
+
+// Convert Z format to +00:00 format
+formatTimestamp('2025-01-15T22:30:00.000Z')
+// Returns: '2025-01-15T22:30:00.000+00:00'
+
+// Already in +00:00 format - returns unchanged
+formatTimestamp('2025-01-15T22:30:00.000+00:00')
+// Returns: '2025-01-15T22:30:00.000+00:00'
+
+// Common usage with Date objects
+const now = new Date()
+const apiTimestamp = formatTimestamp(now.toISOString())
+// Returns timestamp in EEN API format
+```
+
+**When to use:**
+- When displaying timestamps that match the exact format used in API calls (e.g., for debugging)
+- When making direct API calls outside of the toolkit
+- When building custom timestamp display components
+
+**Note:** The toolkit's API functions (`listAlerts`, `getEventMetrics`, `listNotifications`, `listEvents`, etc.) automatically apply `formatTimestamp` internally, so you don't need to pre-format timestamps when using these functions.
+
+---
+
 ## Live Video Streaming
 
 The EEN API Toolkit supports two methods for displaying live video from cameras:
@@ -1525,6 +1576,98 @@ video {
 
 ---
 
+## HLS Video Playback Troubleshooting
+
+For detailed troubleshooting, see the [HLS Video Troubleshooting Guide](./guides/HLS-VIDEO-TROUBLESHOOTING.md).
+
+### Overview
+
+HLS video playback from the EEN API requires:
+
+1. **Initialize media session** - `initMediaSession()`
+2. **Find recording intervals** - `listMedia()` with `include: ['hlsUrl']`
+3. **Extract HLS URL** - From interval containing target timestamp
+4. **Configure HLS.js with auth** - Bearer token in Authorization header
+
+### Key Requirements
+
+| Requirement | Details |
+|-------------|---------|
+| Feed Type | HLS only available for `main` feeds, not `preview` |
+| Timestamp Format | Use `formatTimestamp()` to convert `Z` to `+00:00` |
+| Authentication | HLS.js requires `xhr.setRequestHeader('Authorization', `Bearer ${token}`)` |
+| Recording Coverage | Target timestamp must fall within a recording interval |
+
+### Common Issues
+
+#### 401 Unauthorized
+
+**Cause:** Using `withCredentials: true` instead of Authorization header.
+
+```typescript
+// WRONG
+const hls = new Hls({
+  xhrSetup: (xhr) => { xhr.withCredentials = true }
+})
+
+// CORRECT
+import { useAuthStore } from 'een-api-toolkit'
+const authStore = useAuthStore()
+
+const hls = new Hls({
+  xhrSetup: (xhr) => {
+    xhr.setRequestHeader('Authorization', `Bearer ${authStore.token}`)
+  }
+})
+```
+
+#### No Video Available for Timestamp
+
+**Cause:** Search range too narrow or using wrong feed type.
+
+```typescript
+import { listMedia, formatTimestamp } from 'een-api-toolkit'
+
+const targetTime = new Date(alertTimestamp)
+const searchStart = new Date(targetTime.getTime() - 60 * 60 * 1000) // 1 hour before
+const searchEnd = new Date(targetTime.getTime() + 60 * 60 * 1000)   // 1 hour after
+
+const result = await listMedia({
+  deviceId: cameraId,
+  type: 'main',              // MUST be 'main' for HLS
+  mediaType: 'video',
+  startTimestamp: formatTimestamp(searchStart.toISOString()),
+  endTimestamp: formatTimestamp(searchEnd.toISOString()),
+  include: ['hlsUrl']        // MUST include 'hlsUrl'
+})
+
+// Find interval containing target timestamp
+const intervals = result.data?.results ?? []
+const targetTimeMs = targetTime.getTime()
+
+const matchingInterval = intervals.find(i => {
+  if (!i.hlsUrl) return false
+  const start = new Date(i.startTimestamp).getTime()
+  const end = new Date(i.endTimestamp).getTime()
+  return targetTimeMs >= start && targetTimeMs <= end
+})
+```
+
+#### Timestamp Format Error
+
+**Cause:** Using `Z` suffix instead of `+00:00`.
+
+```typescript
+// WRONG
+const timestamp = new Date().toISOString()  // "2025-01-15T22:30:00.000Z"
+
+// CORRECT
+import { formatTimestamp } from 'een-api-toolkit'
+const timestamp = formatTimestamp(new Date().toISOString())  // "2025-01-15T22:30:00.000+00:00"
+```
+
+---
+
 ## Common Patterns
 
 ### Error Handling

package/examples/vue-alerts-metrics/e2e/auth.spec.ts

@@ -283,14 +283,21 @@ test.describe('Vue Alerts & Metrics Example - Auth', () => {
     await expect(page.locator('[data-testid="dashboard-container"]')).toBeVisible({ timeout: TIMEOUTS.UI_UPDATE })
 
     // Test time range buttons
+    const buttonNone = page.locator('[data-testid="time-range-none"]')
     const button1h = page.locator('[data-testid="time-range-1h"]')
     const button24h = page.locator('[data-testid="time-range-24h"]')
 
+    await expect(buttonNone).toBeVisible()
     await expect(button1h).toBeVisible()
     await expect(button24h).toBeVisible()
 
-    // 24h should be active by default
+    // 'None' should be active by default
+    await expect(buttonNone).toHaveClass(/active/)
+
+    // Click 24h and verify it becomes active
+    await button24h.click()
     await expect(button24h).toHaveClass(/active/)
+    await expect(buttonNone).not.toHaveClass(/active/)
 
     // Click 1h and verify it becomes active
     await button1h.click()

package/examples/vue-alerts-metrics/package-lock.json

@@ -10,6 +10,7 @@
       "dependencies": {
         "chart.js": "^4.4.0",
         "een-api-toolkit": "file:../..",
+        "hls.js": "^1.6.15",
         "pinia": "^3.0.4",
         "vue": "^3.4.0",
         "vue-chartjs": "^5.3.0",
@@ -25,7 +26,7 @@
       }
     },
     "../..": {
-      "version": "0.3.14",
+      "version": "0.3.15",
       "license": "MIT",
       "devDependencies": {
         "@eslint/js": "^9.39.2",
@@ -1296,6 +1297,12 @@
         "node": "^8.16.0 || ^10.6.0 || >=11.0.0"
       }
     },
+    "node_modules/hls.js": {
+      "version": "1.6.15",
+      "resolved": "https://registry.npmjs.org/hls.js/-/hls.js-1.6.15.tgz",
+      "integrity": "sha512-E3a5VwgXimGHwpRGV+WxRTKeSp2DW5DI5MWv34ulL3t5UNmyJWCQ1KmLEHbYzcfThfXG8amBL+fCYPneGHC4VA==",
+      "license": "Apache-2.0"
+    },
     "node_modules/hookable": {
       "version": "5.5.3",
       "resolved": "https://registry.npmjs.org/hookable/-/hookable-5.5.3.tgz",

package/examples/vue-alerts-metrics/package.json

@@ -12,12 +12,13 @@
     "test:e2e:ui": "playwright test --ui"
   },
   "dependencies": {
+    "chart.js": "^4.4.0",
     "een-api-toolkit": "file:../..",
+    "hls.js": "^1.6.15",
     "pinia": "^3.0.4",
     "vue": "^3.4.0",
-    "vue-router": "^4.2.0",
-    "chart.js": "^4.4.0",
-    "vue-chartjs": "^5.3.0"
+    "vue-chartjs": "^5.3.0",
+    "vue-router": "^4.2.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.57.0",