een-api-toolkit 0.3.60 → 0.3.67

package/docs/AI-CONTEXT.md

@@ -1,6 +1,6 @@
 # EEN API Toolkit - AI Reference
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > This documentation is optimized for AI assistants. It provides focused, domain-specific
 > references to help you understand and use the een-api-toolkit efficiently.

package/docs/ai-reference/AI-AUTH.md

@@ -1,6 +1,6 @@
 # Authentication - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > OAuth flow implementation, token management, and session handling.
 > Load this document when implementing login, logout, or auth guards.

package/docs/ai-reference/AI-AUTOMATIONS.md

@@ -1,6 +1,6 @@
 # Automations API - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for automation rules and alert actions.
 > Load this document when working with automated alert workflows.

package/docs/ai-reference/AI-DEVICES.md

@@ -1,6 +1,6 @@
 # Cameras & Bridges API - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for camera and bridge management.
 > Load this document when working with devices.

package/docs/ai-reference/AI-EVENT-DATA-SCHEMAS.md

@@ -1,6 +1,6 @@
 # Event Type to Data Schemas Mapping - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for event type to data schema mappings.
 > Load this document when building dynamic event queries with the `include` parameter.
@@ -112,124 +112,123 @@ const schemas = EVENT_TYPE_DATA_SCHEMAS['een.personDetectionEvent.v1']
 
 ## Event Type to Data Schemas Reference
 
+
 ### Detection Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.motionDetectionEvent.v1` | `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.motionInRegionDetectionEvent.v1` | `motionRegion`, `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.personDetectionEvent.v1` | `objectDetection`, `personAttributes`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification`, `objectRegionMapping`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay`, `geoLocation` |
-| `een.personMotionDetectionEvent.v1` | `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification` |
-| `een.animalDetectionEvent.v1` | `objectDetection`, `animalAttributes`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification`, `objectRegionMapping`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.faceDetectionEvent.v1` | `objectDetection`, `personAttributes`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification`, `objectRegionMapping`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.vehicleDetectionEvent.v1` | `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification`, `vehicleAttributes`, `objectRegionMapping`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.vehicleMotionDetectionEvent.v1` | `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification`, `vehicleAttributes` |
-| `een.gunDetectionEvent.v1` | `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectDetection`, `motionRegion`, `objectClassification`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay`, `weaponAttributes`, `personAttributes`, `humanValidationDetails` |
-| `een.weaponDetectionEvent.v1` | `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectDetection`, `motionRegion`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.fallDetectionEvent.v1` | `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.fireDetectionEvent.v1` | `objectDetection`, `objectClassification`, `croppedFrameImageUrl`, `fullFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.spillDetectionEvent.v1` | `objectDetection`, `objectClassification`, `croppedFrameImageUrl`, `fullFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.crowdFormationDetectionEvent.v1` | `objectDetection`, `objectClassification`, `croppedFrameImageUrl`, `fullFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-
-### Camera Analytics Events
+| `een.motionDetectionEvent.v1` | objectDetection, fullFrameImageUrl, croppedFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.motionInRegionDetectionEvent.v1` | motionRegion, objectDetection, fullFrameImageUrl, croppedFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.personDetectionEvent.v1` | objectDetection, personAttributes, fullFrameImageUrl, croppedFrameImageUrl, objectClassification, objectRegionMapping, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay, geoLocation |
+| `een.personMotionDetectionEvent.v1` | objectDetection, fullFrameImageUrl, croppedFrameImageUrl, objectClassification |
+| `een.animalDetectionEvent.v1` | objectDetection, animalAttributes, fullFrameImageUrl, croppedFrameImageUrl, objectClassification, objectRegionMapping, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.faceDetectionEvent.v1` | objectDetection, personAttributes, fullFrameImageUrl, croppedFrameImageUrl, objectClassification, objectRegionMapping, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.vehicleDetectionEvent.v1` | objectDetection, fullFrameImageUrl, croppedFrameImageUrl, objectClassification, vehicleAttributes, objectRegionMapping, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.vehicleMotionDetectionEvent.v1` | objectDetection, fullFrameImageUrl, croppedFrameImageUrl, objectClassification, vehicleAttributes |
+| `een.gunDetectionEvent.v1` | fullFrameImageUrl, croppedFrameImageUrl, objectDetection, motionRegion, objectClassification, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay, weaponAttributes, personAttributes, humanValidationDetails |
+| `een.weaponDetectionEvent.v1` | fullFrameImageUrl, croppedFrameImageUrl, objectDetection, motionRegion, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.fallDetectionEvent.v1` | objectDetection, fullFrameImageUrl, croppedFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.fireDetectionEvent.v1` | objectDetection, objectClassification, croppedFrameImageUrl, fullFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.spillDetectionEvent.v1` | objectDetection, objectClassification, croppedFrameImageUrl, fullFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.crowdFormationDetectionEvent.v1` | objectDetection, objectClassification, croppedFrameImageUrl, fullFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.tamperDetectionEvent.v1` | fullFrameImageUrl |
+| `een.loiterDetectionEvent.v1` | loiterArea, objectDetection, fullFrameImageUrl, croppedFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.gunShotAudioDetectionEvent.v1` | audioDetection, geoLocation |
+| `een.t3AlarmAudioDetectionEvent.v1` | audioDetection |
+| `een.t4AlarmAudioDetectionEvent.v1` | audioDetection |
+| `een.violenceDetectionEvent.v1` | *(none)* |
+| `een.fightDetectionEvent.v1` | *(none)* |
+| `een.handsUpDetectionEvent.v1` | *(none)* |
+| `een.vapeDetectionEvent.v1` | *(none)* |
+
+### Other Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.tamperDetectionEvent.v1` | `fullFrameImageUrl` |
-| `een.loiterDetectionEvent.v1` | `loiterArea`, `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.objectLineCrossEvent.v1` | `lineCrossLine`, `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `entryDirection`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.objectLineCrossCountEvent.v1` | `lineCrossLine`, `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `entryDirection`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.countedObjectLineCrossEvent.v1` | `countedLineCross` |
-| `een.objectIntrusionEvent.v1` | `intrusionArea`, `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `entryDirection`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.objectRemovalEvent.v1` | `monitoredArea`, `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.personTailgateEvent.v1` | `objectDetection`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
-| `een.ppeViolationEvent.v1` | `objectDetection`, `personAttributes`, `fullFrameImageUrl`, `croppedFrameImageUrl`, `objectClassification`, `objectRegionMapping`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay` |
+| `een.objectLineCrossEvent.v1` | lineCrossLine, objectDetection, fullFrameImageUrl, croppedFrameImageUrl, entryDirection, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.objectLineCrossCountEvent.v1` | lineCrossLine, objectDetection, fullFrameImageUrl, croppedFrameImageUrl, entryDirection, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.countedObjectLineCrossEvent.v1` | countedLineCross |
+| `een.objectIntrusionEvent.v1` | intrusionArea, objectDetection, fullFrameImageUrl, croppedFrameImageUrl, entryDirection, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.objectRemovalEvent.v1` | monitoredArea, objectDetection, fullFrameImageUrl, croppedFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.personTailgateEvent.v1` | objectDetection, fullFrameImageUrl, croppedFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
+| `een.edgeReportedDeviceStatusEvent.v1` | deviceCommonStatusUpdate, deviceErrorStatusUpdate |
 
-### AI/Scene Events
+### Camera Analytics Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.sceneLabelEvent.v1` | `objectDetection`, `objectClassification`, `vehicleAttributes`, `personAttributes`, `animalAttributes`, `croppedFrameImageUrl`, `fullFrameImageUrl`, `objectRegionMapping`, `displayOverlay.boundingBox`, `customLabels`, `eevaAttributes`, `fullFrameImageUrlWithOverlay` |
-| `een.eevaQueryEvent.v1` | `customLabels`, `eevaAttributes`, `objectDetection`, `fullFrameImageUrl`, `fullFrameImageUrlWithOverlay`, `displayOverlay.boundingBox` |
+| `een.ppeViolationEvent.v1` | objectDetection, personAttributes, fullFrameImageUrl, croppedFrameImageUrl, objectClassification, objectRegionMapping, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay |
 
-### License Plate & Fleet Recognition Events
+### AI/Scene Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.lprPlateReadEvent.v1` | `objectDetection`, `lprDetection`, `vehicleAttributes`, `lprAccessType`, `userData`, `userTags`, `croppedFrameImageUrl`, `fullFrameImageUrl`, `displayOverlay.boundingBox`, `fullFrameImageUrlWithOverlay`, `vehicleListInfo`, `resourceDetails`, `vspInsightsSummary` |
-| `een.fleetCodeRecognitionEvent.v1` | `objectDetection`, `dotNumberRecognition`, `truckNumberRecognition`, `trailerNumberRecognition`, `croppedFrameImageUrl`, `fullFrameImageUrl`, `recognizedText`, `resourceDetails` |
+| `een.sceneLabelEvent.v1` | objectDetection, objectClassification, vehicleAttributes, personAttributes, animalAttributes, croppedFrameImageUrl, fullFrameImageUrl, objectRegionMapping, displayOverlay.boundingBox, customLabels, eevaAttributes, fullFrameImageUrlWithOverlay |
+| `een.eevaQueryEvent.v1` | customLabels, eevaAttributes, objectDetection, fullFrameImageUrl, fullFrameImageUrlWithOverlay, displayOverlay.boundingBox |
 
-### Audio Detection Events
+### License Plate & Fleet Recognition Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.gunShotAudioDetectionEvent.v1` | `audioDetection`, `geoLocation` |
-| `een.t3AlarmAudioDetectionEvent.v1` | `audioDetection` |
-| `een.t4AlarmAudioDetectionEvent.v1` | `audioDetection` |
+| `een.lprPlateReadEvent.v1` | objectDetection, lprDetection, vehicleAttributes, lprAccessType, userData, userTags, croppedFrameImageUrl, fullFrameImageUrl, displayOverlay.boundingBox, fullFrameImageUrlWithOverlay, vehicleListInfo, resourceDetails, vspInsightsSummary |
+| `een.fleetCodeRecognitionEvent.v1` | objectDetection, dotNumberRecognition, truckNumberRecognition, trailerNumberRecognition, croppedFrameImageUrl, fullFrameImageUrl, recognizedText, resourceDetails |
 
 ### POS (Point of Sale) Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.posTransactionEvent.v1` | `posTransactionStart`, `posTransactionEnd`, `posTransactionItem`, `posTransactionPayment`, `posTransactionCartChangeTrail`, `posTransactionCardLoadSummary`, `posTransactionFlag`, `posTransactionLabel`, `rawData`, `displayLocationSummary`, `fullFrameImageUrl` |
+| `een.posTransactionEvent.v1` | posTransactionStart, posTransactionEnd, posTransactionItem, posTransactionPayment, posTransactionCartChangeTrail, posTransactionCardLoadSummary, posTransactionFlag, posTransactionLabel, rawData, displayLocationSummary, fullFrameImageUrl |
 
 ### Device & System Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.deviceCloudStatusUpdateEvent.v1` | `deviceCloudStatusUpdate`, `deviceCloudPreviousStatus` |
-| `een.deviceCloudConnectionStatusUpdateEvent.v1` | `deviceCloudConnectionStatusUpdate`, `deviceCloudConnectionPreviousStatus` |
-| `een.edgeReportedDeviceStatusEvent.v1` | `deviceCommonStatusUpdate`, `deviceErrorStatusUpdate` |
-| `een.deviceIOEvent.v1` | `deviceIO` |
-| `een.deviceOperationEvent.v1` | `resourceDetails`, `deviceOperationDetails`, `deviceOperationSubStep`, `deviceOperationUpdate` |
-| `een.ptzPositionUpdateEvent.v1` | `ptzPositionUpdate` |
+| `een.deviceCloudStatusUpdateEvent.v1` | deviceCloudStatusUpdate, deviceCloudPreviousStatus |
+| `een.deviceCloudConnectionStatusUpdateEvent.v1` | deviceCloudConnectionStatusUpdate, deviceCloudConnectionPreviousStatus |
+| `een.deviceIOEvent.v1` | deviceIO |
+| `een.deviceOperationEvent.v1` | resourceDetails, deviceOperationDetails, deviceOperationSubStep, deviceOperationUpdate |
+| `een.ptzPositionUpdateEvent.v1` | ptzPositionUpdate |
+| `een.deviceCreationEvent.v1` | resourceDetails |
+| `een.deviceUpdateEvent.v1` | resourceDetails |
+| `een.deviceDeletionEvent.v1` | resourceDetails |
 
 ### Sensor Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.doorStatusEvent.v1` | `measurementStringValueUpdate` |
-| `een.batteryLevelUpdateEvent.v1` | `batteryLevelUpdate` |
-| `een.measurementThresholdStatusEvent.v1` | `measurementThresholdStatus`, `measurementValueUpdate`, `measurementStringValueUpdate` |
-| `een.thermalCameraThresholdStatusEvent.v1` | `thermalCameraValueUpdate`, `thermalMonitoredArea` |
+| `een.doorStatusEvent.v1` | measurementStringValueUpdate |
+| `een.batteryLevelUpdateEvent.v1` | batteryLevelUpdate |
+| `een.measurementThresholdStatusEvent.v1` | measurementThresholdStatus, measurementValueUpdate, measurementStringValueUpdate |
+| `een.thermalCameraThresholdStatusEvent.v1` | thermalCameraValueUpdate, thermalMonitoredArea |
 
 ### Resource Management Events
 
-All resource management events use `resourceDetails.v1`:
-
-- `een.layoutCreationEvent.v1`, `een.layoutUpdateEvent.v1`, `een.layoutDeletionEvent.v1`
-- `een.deviceCreationEvent.v1`, `een.deviceUpdateEvent.v1`, `een.deviceDeletionEvent.v1`
-- `een.userCreationEvent.v1`, `een.userUpdateEvent.v1`, `een.userDeletionEvent.v1`
-- `een.accountCreationEvent.v1`, `een.accountUpdateEvent.v1`, `een.accountDeletionEvent.v1`
-
-### Job Events
-
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.jobCreationEvent.v1` | `jobDetails`, `ownerDetails` |
-| `een.jobUpdateEvent.v1` | `jobDetails`, `ownerDetails` |
-| `een.jobDeletionEvent.v1` | `ownerDetails` |
+| `een.layoutCreationEvent.v1` | resourceDetails |
+| `een.layoutUpdateEvent.v1` | resourceDetails |
+| `een.layoutDeletionEvent.v1` | resourceDetails |
+| `een.userCreationEvent.v1` | resourceDetails |
+| `een.userUpdateEvent.v1` | resourceDetails |
+| `een.userDeletionEvent.v1` | resourceDetails |
+| `een.accountCreationEvent.v1` | resourceDetails |
+| `een.accountUpdateEvent.v1` | resourceDetails |
+| `een.accountDeletionEvent.v1` | resourceDetails |
+| `een.jobCreationEvent.v1` | jobDetails, ownerDetails |
+| `een.jobUpdateEvent.v1` | jobDetails, ownerDetails |
+| `een.jobDeletionEvent.v1` | ownerDetails |
 
 ### Safety & Protocol Events
 
 | Event Type | Data Schemas |
 |------------|--------------|
-| `een.panicButtonEvent.v1` | `geoLocation` |
+| `een.panicButtonEvent.v1` | geoLocation |
 | `een.evacuateProtocolEvent.v1` | *(none)* |
 | `een.holdProtocolEvent.v1` | *(none)* |
 | `een.lockdownProtocolEvent.v1` | *(none)* |
 | `een.secureProtocolEvent.v1` | *(none)* |
 | `een.shelterProtocolEvent.v1` | *(none)* |
 
-### Behavioral Events
-
-These events have no associated data schemas:
-
-- `een.violenceDetectionEvent.v1`
-- `een.fightDetectionEvent.v1`
-- `een.handsUpDetectionEvent.v1`
-- `een.vapeDetectionEvent.v1`
-
 ---
 
 ## Common Data Schemas
@@ -321,8 +320,11 @@ This mapping is derived from the Eagle Eye Networks API v3.0 specification (`eve
 
 ## Maintenance
 
-When new event types are added to the EEN API:
-1. Check the API specification for the new event type
-2. Find the `dataSchemas` array in the event schema
-3. Add the mapping to `src/events/dataSchemas.ts`
-4. Update the `KnownEventType` and `DataSchema` types as needed
+This file is auto-generated from `src/events/dataSchemas.ts` by `scripts/generate-event-data-schemas-doc.ts`.
+
+To update:
+1. Modify `src/events/dataSchemas.ts` with new event types or data schemas
+2. Run `npm run docs:ai-context` to regenerate this file
+3. The script automatically extracts types, mappings, and generates tables
+
+Do not edit this file manually - changes will be overwritten on next generation.

package/docs/ai-reference/AI-EVENTS.md

@@ -1,6 +1,6 @@
 # Events, Alerts & Real-Time Streaming - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for events, alerts, metrics, and SSE subscriptions.
 > Load this document when implementing event-driven features.
@@ -1002,6 +1002,7 @@ watch([timeRange, selectedEventTypes], () => {
                   class="json-button"
                   @click="openJsonViewer(event.id)"
                   title="View JSON data"
+                  aria-label="View event JSON data"
                   data-testid="json-button"
                 >{ }</button>
               </div>

package/docs/ai-reference/AI-GROUPING.md

@@ -1,6 +1,6 @@
 # Layouts API - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for layout management (camera grouping).
 > Load this document when working with layouts.

package/docs/ai-reference/AI-JOBS.md

@@ -1,6 +1,6 @@
 # Jobs, Exports, Files & Downloads - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for async jobs, video exports, and file management.
 > Load this document when implementing export workflows or file downloads.

package/docs/ai-reference/AI-MEDIA.md

@@ -1,6 +1,6 @@
 # Media & Live Video - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for media retrieval, live streaming, and video playback.
 > Load this document when implementing video features.

package/docs/ai-reference/AI-SETUP.md

@@ -1,6 +1,6 @@
 # Vue 3 Application Setup - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete guide for setting up a Vue 3 application with the een-api-toolkit.
 > Load this document when creating a new project or troubleshooting setup issues.

package/docs/ai-reference/AI-USERS.md

@@ -1,6 +1,6 @@
 # Users API - EEN API Toolkit
 
-> **Version:** 0.3.60
+> **Version:** 0.3.67
 >
 > Complete reference for user management.
 > Load this document when working with user data.

package/examples/vue-alerts-metrics/README.md

@@ -123,13 +123,23 @@ This example demonstrates the following `een-api-toolkit` functions:
 - `initEenToolkit()` - Initialize the toolkit
 - `getAuthUrl()` - Get OAuth authorization URL
 - `handleAuthCallback()` - Handle OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `useAuthStore()` - Access authentication state
+- `getCurrentUser()` - Get current user profile
 - `getCameras()` - List available cameras
 - `listEventFieldValues()` - Get available event types for a camera
 - `getEventMetrics()` - Fetch event metrics time-series data
 - `listAlertTypes()` - Get available alert types
 - `listAlerts()` - Fetch alerts for a camera
+- `getAlert()` - Get a single alert by ID
 - `listNotifications()` - Fetch notifications for a camera
+- `getNotification()` - Get a single notification by ID
+- `getRecordedImage()` - Fetch recorded image at a timestamp
+- `initMediaSession()` - Initialize media session for image access
+- `listMedia()` - Get media intervals
+- `formatTimestamp()` - Format timestamps for display
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Known Limitations
 

package/examples/vue-automations/README.md

@@ -29,10 +29,14 @@ This is the recommended strategy for high-security deployments where protecting
 - `listAlertConditionRules()` - List alert condition rules with optional includes
 - `listAlertActionRules()` - List alert action rules
 - `listAlertActions()` - List alert actions
+- `getCurrentUser()` - Get current user profile
 - `useAuthStore()` - Authentication state management
 - `getAuthUrl()` - Generate OAuth login URL
 - `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-bridges/README.md

@@ -18,8 +18,14 @@ A Vue 3 example demonstrating how to list and view EEN bridge devices using the
 
 - `getBridges()` - List bridges with filtering and pagination
 - `getBridge()` - Get single bridge by ID
+- `getCurrentUser()` - Get current user profile
 - `useAuthStore()` - Authentication state management
+- `getAuthUrl()` - Generate OAuth login URL
+- `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-cameras/README.md

@@ -18,8 +18,15 @@ A Vue 3 example demonstrating how to list and view EEN cameras using the een-api
 
 - `getCameras()` - List cameras with filtering and pagination
 - `getCamera()` - Get single camera by ID
+- `getCameraSettings()` - Get camera settings
+- `getCurrentUser()` - Get current user profile
 - `useAuthStore()` - Authentication state management
+- `getAuthUrl()` - Generate OAuth login URL
+- `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-event-subscriptions/README.md

@@ -76,6 +76,16 @@ This example demonstrates how to use the Event Subscriptions API from the EEN AP
 - `connectToEventSubscription(sseUrl, options)` - Connect to SSE stream
 - `getCameras()` - List cameras for filter selection
 - `listEventTypes()` - List event types for filter selection
+- `getCurrentUser()` - Get current user profile
+- `initMediaSession()` - Initialize media session for image access
+- `listMedia()` - Get media intervals
+- `formatTimestamp()` - Format timestamps for display
+- `useAuthStore()` - Authentication state management
+- `getAuthUrl()` - Generate OAuth login URL
+- `handleAuthCallback()` - Process OAuth callback
+- `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Event Subscription Lifecycle
 

package/examples/vue-events/README.md

@@ -23,12 +23,24 @@ A Vue 3 example demonstrating how to query and display events from EEN cameras u
 ## APIs Used
 
 - `listEvents()` - List events with actor, type, and timestamp filters
+- `getEvent()` - Get a single event by ID
 - `listEventFieldValues()` - Get available event types for a specific camera
 - `listEventTypes()` - Get human-readable names for event types
+- `getIncludeParameterForEventTypes()` - Get include parameters for event types
+- `getDataSchemasForEventType()` - Get data schemas for a specific event type
 - `getRecordedImage()` - Fetch preview image at event timestamp
 - `getCameras()` - List cameras for the camera grid
+- `getCurrentUser()` - Get current user profile
+- `initMediaSession()` - Initialize media session for image access
+- `listMedia()` - Get media intervals
+- `formatTimestamp()` - Format timestamps for display
 - `useAuthStore()` - Authentication state management
+- `getAuthUrl()` - Generate OAuth login URL
+- `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-events/src/components/EventsModal.vue

@@ -715,6 +715,7 @@ watch([timeRange, selectedEventTypes], () => {
                   class="json-button"
                   @click="openJsonViewer(event.id)"
                   title="View JSON data"
+                  aria-label="View event JSON data"
                   data-testid="json-button"
                 >{ }</button>
               </div>

package/examples/vue-feeds/README.md

@@ -22,7 +22,12 @@ A Vue 3 example demonstrating how to list camera feeds and display live video us
 - `listFeeds()` - List feeds with streaming URLs (HLS, Multipart, FLV, RTSP)
 - `initMediaSession()` - Initialize session cookie for media access
 - `useAuthStore()` - Authentication state management
+- `getAuthUrl()` - Generate OAuth login URL
+- `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Video Streaming Modes
 

package/examples/vue-feeds/src/App.vue

@@ -1,8 +1,9 @@
 <script setup lang="ts">
-import { onMounted } from 'vue'
+import { onMounted, computed } from 'vue'
 import { useAuthStore } from 'een-api-toolkit'
 
 const authStore = useAuthStore()
+const isAuthenticated = computed(() => authStore.isAuthenticated)
 
 // Initialize auth store from localStorage on app mount
 onMounted(() => {
@@ -16,9 +17,9 @@ onMounted(() => {
       <h1>EEN Feeds Example</h1>
       <nav>
         <router-link to="/" data-testid="nav-home">Home</router-link>
-        <router-link v-if="!authStore.isAuthenticated" to="/login" data-testid="nav-login">Login</router-link>
-        <router-link v-if="authStore.isAuthenticated" to="/feeds" data-testid="nav-feeds">Feeds</router-link>
-        <router-link v-if="authStore.isAuthenticated" to="/logout" data-testid="nav-logout">Logout</router-link>
+        <router-link v-if="!isAuthenticated" to="/login" data-testid="nav-login">Login</router-link>
+        <router-link v-if="isAuthenticated" to="/feeds" data-testid="nav-feeds">Feeds</router-link>
+        <router-link v-if="isAuthenticated" to="/logout" data-testid="nav-logout">Logout</router-link>
       </nav>
     </header>
     <main>

package/examples/vue-feeds/src/views/Home.vue

@@ -1,7 +1,9 @@
 <script setup lang="ts">
+import { computed } from 'vue'
 import { useAuthStore, getStorageStrategy, STORAGE_STRATEGY_DESCRIPTIONS } from 'een-api-toolkit'
 
 const authStore = useAuthStore()
+const isAuthenticated = computed(() => authStore.isAuthenticated)
 
 const storageStrategy = getStorageStrategy()
 const storageDescription = STORAGE_STRATEGY_DESCRIPTIONS[storageStrategy]
@@ -11,7 +13,7 @@ const storageDescription = STORAGE_STRATEGY_DESCRIPTIONS[storageStrategy]
   <div class="home">
     <h2>Welcome to the EEN Feeds Example</h2>
 
-    <div v-if="!authStore.isAuthenticated" class="login-prompt" data-testid="not-authenticated">
+    <div v-if="!isAuthenticated" class="login-prompt" data-testid="not-authenticated">
       <p>Please log in to view camera feeds.</p>
       <router-link to="/login">
         <button data-testid="login-button">Login with Eagle Eye Networks</button>

package/examples/vue-jobs/README.md

@@ -27,14 +27,21 @@ This is the recommended strategy for high-security deployments where protecting
 
 - `listJobs()` - List jobs with filtering and pagination
 - `getJob()` - Get single job details
+- `deleteJob()` - Delete a job
 - `createExportJob()` - Create video export job
 - `listFiles()` - List files with pagination
 - `downloadFile()` - Download file content
+- `deleteFile()` - Delete a file
 - `getCameras()` - Get cameras for export selection
+- `getCurrentUser()` - Get current user profile
+- `formatTimestamp()` - Format timestamps for display
 - `useAuthStore()` - Authentication state management
 - `getAuthUrl()` - Generate OAuth login URL
 - `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-layouts/README.md

@@ -30,7 +30,6 @@ This is the recommended strategy for high-security deployments where protecting
 ## APIs Used
 
 - `getLayouts()` - List layouts with pagination and filtering
-- `getLayout()` - Get a specific layout by ID
 - `createLayout()` - Create a new layout
 - `updateLayout()` - Update an existing layout
 - `deleteLayout()` - Delete a layout
@@ -39,7 +38,10 @@ This is the recommended strategy for high-security deployments where protecting
 - `useAuthStore()` - Authentication state management
 - `getAuthUrl()` - Generate OAuth login URL
 - `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-media/README.md

@@ -88,7 +88,12 @@ Streams recorded video using HLS (HTTP Live Streaming) protocol with adaptive bi
 | `initMediaSession()` | HLS Video | Initialize media session for video URLs |
 | `listMedia()` | HLS Video | Get media intervals with streaming URLs |
 | `useAuthStore()` | All pages | Authentication state management |
+| `getAuthUrl()` | Login | Generate OAuth login URL |
+| `handleAuthCallback()` | Callback | Process OAuth callback |
+| `revokeToken()` | Logout | Revoke authentication token on logout |
 | `initEenToolkit()` | App initialization | Configure toolkit settings |
+| `getStorageStrategy()` | Home | Get the current storage strategy |
+| `STORAGE_STRATEGY_DESCRIPTIONS` | Home | Human-readable storage strategy descriptions |
 
 **Note on `useAuthStore()`:** All toolkit functions (`getCameras`, `getLiveImage`, `getRecordedImage`, `listMedia`) use `useAuthStore()` internally to get the authentication token. The HLS Video page is the only one that explicitly calls `useAuthStore()` in its code because HLS.js is a third-party library that makes its own HTTP requests - the token must be manually passed to HLS.js via the `xhrSetup` callback.
 

package/examples/vue-users/README.md

@@ -30,7 +30,10 @@ This is the recommended strategy for high-security deployments where protecting
 - `useAuthStore()` - Authentication state management
 - `getAuthUrl()` - Generate OAuth login URL
 - `handleAuthCallback()` - Process OAuth callback
+- `revokeToken()` - Revoke authentication token on logout
 - `initEenToolkit()` - Toolkit initialization
+- `getStorageStrategy()` - Get the current storage strategy
+- `STORAGE_STRATEGY_DESCRIPTIONS` - Human-readable storage strategy descriptions
 
 ## Setup
 

package/examples/vue-users/package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "een-api-toolkit-example",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "een-api-toolkit-example",
-      "version": "0.0.26",
+      "version": "0.0.27",
       "dependencies": {
         "een-api-toolkit": "file:../..",
         "pinia": "^3.0.4",

package/examples/vue-users/package.json

@@ -1,6 +1,6 @@
 {
   "name": "een-api-toolkit-example",
-  "version": "0.0.26",
+  "version": "0.0.27",
   "private": true,
   "type": "module",
   "scripts": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "een-api-toolkit",
-  "version": "0.3.60",
+  "version": "0.3.67",
   "description": "EEN Video platform API v3.0 library for Vue 3",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -30,6 +30,7 @@
     "test:watch": "vitest",
     "test:e2e": "playwright test",
     "test:e2e:ui": "playwright test --ui",
+    "test:e2e:examples": "./scripts/run-examples-e2e.sh",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
     "typecheck": "vue-tsc --noEmit",