een-api-toolkit 0.3.97 → 0.3.103
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +117 -55
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +6 -2
- package/dist/index.js +6 -0
- package/dist/index.js.map +1 -1
- package/docs/AI-CONTEXT.md +1 -1
- package/docs/ai-reference/AI-AUTH.md +1 -1
- package/docs/ai-reference/AI-AUTOMATIONS.md +1 -1
- package/docs/ai-reference/AI-DEVICES.md +1 -1
- package/docs/ai-reference/AI-EVENT-DATA-SCHEMAS.md +2 -1
- package/docs/ai-reference/AI-EVENTS.md +1 -1
- package/docs/ai-reference/AI-GROUPING.md +1 -1
- package/docs/ai-reference/AI-JOBS.md +1 -1
- package/docs/ai-reference/AI-MEDIA.md +1 -1
- package/docs/ai-reference/AI-PTZ.md +1 -1
- package/docs/ai-reference/AI-SETUP.md +1 -1
- package/docs/ai-reference/AI-USERS.md +1 -1
- package/examples/vue-ptz/src/components/PositionInput.vue +236 -58
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1440,9 +1440,13 @@ export declare interface CreateLayoutParams {
|
|
|
1440
1440
|
* These are the schema names as they appear in the event's `dataSchemas` array.
|
|
1441
1441
|
* When using in the `include` parameter, prefix with `data.`.
|
|
1442
1442
|
*
|
|
1443
|
+
* Not all schemas are mapped to specific event types in `EVENT_TYPE_DATA_SCHEMAS`.
|
|
1444
|
+
* Unmapped schemas (e.g., alert-related, counting, trajectory) may still appear in
|
|
1445
|
+
* API responses as part of an event's `data` array.
|
|
1446
|
+
*
|
|
1443
1447
|
* @category Events
|
|
1444
1448
|
*/
|
|
1445
|
-
export declare type DataSchema = 'een.objectDetection.v1' | 'een.objectClassification.v1' | 'een.objectRegionMapping.v1' | 'een.fullFrameImageUrl.v1' | 'een.croppedFrameImageUrl.v1' | 'een.fullFrameImageUrlWithOverlay.v1' | 'een.displayOverlay.boundingBox.v1' | 'een.personAttributes.v1' | 'een.vehicleAttributes.v1' | 'een.animalAttributes.v1' | 'een.weaponAttributes.v1' | 'een.geoLocation.v1' | 'een.entryDirection.v1' | 'een.motionRegion.v1' | 'een.loiterArea.v1' | 'een.lineCrossLine.v1' | 'een.intrusionArea.v1' | 'een.monitoredArea.v1' | 'een.thermalMonitoredArea.v1' | 'een.countedLineCross.v1' | 'een.eevaAttributes.v1' | 'een.customLabels.v1' | 'een.humanValidationDetails.v1' | 'een.lprDetection.v1' | 'een.lprAccessType.v1' | 'een.userData.v1' | 'een.userTags.v1' | 'een.vehicleListInfo.v1' | 'een.vspInsightsSummary.v1' | 'een.dotNumberRecognition.v1' | 'een.truckNumberRecognition.v1' | 'een.trailerNumberRecognition.v1' | 'een.recognizedText.v1' | 'een.audioDetection.v1' | 'een.posTransactionStart.v1' | 'een.posTransactionEnd.v1' | 'een.posTransactionItem.v1' | 'een.posTransactionPayment.v1' | 'een.posTransactionCartChangeTrail.v1' | 'een.posTransactionCardLoadSummary.v1' | 'een.posTransactionFlag.v1' | 'een.posTransactionLabel.v1' | 'een.rawData.v1' | 'een.displayLocationSummary.v1' | 'een.deviceCloudStatusUpdate.v1' | 'een.deviceCloudPreviousStatus.v1' | 'een.deviceCloudConnectionStatusUpdate.v1' | 'een.deviceCloudConnectionPreviousStatus.v1' | 'een.deviceCommonStatusUpdate.v1' | 'een.deviceErrorStatusUpdate.v1' | 'een.deviceIO.v1' | 'een.deviceOperationDetails.v1' | 'een.deviceOperationSubStep.v1' | 'een.deviceOperationUpdate.v1' | 'een.ptzPositionUpdate.v1' | 'een.measurementStringValueUpdate.v1' | 'een.batteryLevelUpdate.v1' | 'een.measurementThresholdStatus.v1' | 'een.measurementValueUpdate.v1' | 'een.thermalCameraValueUpdate.v1' | 'een.resourceDetails.v1' | 'een.jobDetails.v1' | 'een.ownerDetails.v1';
|
|
1449
|
+
export declare type DataSchema = 'een.objectDetection.v1' | 'een.objectClassification.v1' | 'een.objectRegionMapping.v1' | 'een.fullFrameImageUrl.v1' | 'een.croppedFrameImageUrl.v1' | 'een.fullFrameImageUrlWithOverlay.v1' | 'een.displayOverlay.boundingBox.v1' | 'een.bestImageUrl.v1' | 'een.personAttributes.v1' | 'een.vehicleAttributes.v1' | 'een.animalAttributes.v1' | 'een.weaponAttributes.v1' | 'een.geoLocation.v1' | 'een.entryDirection.v1' | 'een.trajectory.v1' | 'een.motionRegion.v1' | 'een.loiterArea.v1' | 'een.lineCrossLine.v1' | 'een.intrusionArea.v1' | 'een.monitoredArea.v1' | 'een.thermalMonitoredArea.v1' | 'een.countedLineCross.v1' | 'een.eevaAttributes.v1' | 'een.customLabels.v1' | 'een.humanValidationDetails.v1' | 'een.lprDetection.v1' | 'een.lprAccessType.v1' | 'een.userData.v1' | 'een.userTags.v1' | 'een.vehicleListInfo.v1' | 'een.vspInsightsSummary.v1' | 'een.vspVisitDetails.v1' | 'een.dotNumberRecognition.v1' | 'een.truckNumberRecognition.v1' | 'een.trailerNumberRecognition.v1' | 'een.recognizedText.v1' | 'een.audioDetection.v1' | 'een.posTransactionStart.v1' | 'een.posTransactionEnd.v1' | 'een.posTransactionItem.v1' | 'een.posTransactionPayment.v1' | 'een.posTransactionCartChangeTrail.v1' | 'een.posTransactionCardLoadSummary.v1' | 'een.posTransactionFlag.v1' | 'een.posTransactionLabel.v1' | 'een.rawData.v1' | 'een.displayLocationSummary.v1' | 'een.credentialAccessActivation.v1' | 'een.userAccessActivation.v1' | 'een.deviceCloudStatusUpdate.v1' | 'een.deviceStatusUpdate.v1' | 'een.deviceCloudPreviousStatus.v1' | 'een.deviceCloudConnectionStatusUpdate.v1' | 'een.deviceCloudConnectionPreviousStatus.v1' | 'een.deviceCommonStatusUpdate.v1' | 'een.deviceErrorStatusUpdate.v1' | 'een.deviceIO.v1' | 'een.deviceOperationDetails.v1' | 'een.deviceOperationSubStep.v1' | 'een.deviceOperationUpdate.v1' | 'een.ptzPositionUpdate.v1' | 'een.measurementStringValueUpdate.v1' | 'een.batteryLevelUpdate.v1' | 'een.measurementThresholdStatus.v1' | 'een.measurementValueUpdate.v1' | 'een.thermalCameraValueUpdate.v1' | 'een.countData.v1' | 'een.creatorDetails.v1' | 'een.resourceDetails.v1' | 'een.alertConditionRuleInfo.v1' | 'een.alertInfo.v1' | 'een.gunDetectionAlertInfo.v1' | 'een.lprRuleCountAggrAlertInfo.v1' | 'een.lprRuleWatchAlertInfo.v1' | 'een.smartAlertObjectCountAlertInfo.v1' | 'een.jobDetails.v1' | 'een.ownerDetails.v1';
|
|
1446
1450
|
|
|
1447
1451
|
/**
|
|
1448
1452
|
* Delete an event subscription.
|
|
@@ -4463,7 +4467,7 @@ export declare type JobState = 'pending' | 'started' | 'success' | 'failure' | '
|
|
|
4463
4467
|
*
|
|
4464
4468
|
* @category Events
|
|
4465
4469
|
*/
|
|
4466
|
-
export declare type KnownEventType = 'een.motionDetectionEvent.v1' | 'een.motionInRegionDetectionEvent.v1' | 'een.personDetectionEvent.v1' | 'een.personMotionDetectionEvent.v1' | 'een.animalDetectionEvent.v1' | 'een.faceDetectionEvent.v1' | 'een.vehicleDetectionEvent.v1' | 'een.vehicleMotionDetectionEvent.v1' | 'een.gunDetectionEvent.v1' | 'een.weaponDetectionEvent.v1' | 'een.fallDetectionEvent.v1' | 'een.fireDetectionEvent.v1' | 'een.spillDetectionEvent.v1' | 'een.crowdFormationDetectionEvent.v1' | 'een.tamperDetectionEvent.v1' | 'een.loiterDetectionEvent.v1' | 'een.objectLineCrossEvent.v1' | 'een.objectLineCrossCountEvent.v1' | 'een.countedObjectLineCrossEvent.v1' | 'een.objectIntrusionEvent.v1' | 'een.objectRemovalEvent.v1' | 'een.personTailgateEvent.v1' | 'een.ppeViolationEvent.v1' | 'een.sceneLabelEvent.v1' | 'een.eevaQueryEvent.v1' | 'een.lprPlateReadEvent.v1' | 'een.fleetCodeRecognitionEvent.v1' | 'een.gunShotAudioDetectionEvent.v1' | 'een.t3AlarmAudioDetectionEvent.v1' | 'een.t4AlarmAudioDetectionEvent.v1' | 'een.posTransactionEvent.v1' | 'een.deviceCloudStatusUpdateEvent.v1' | 'een.deviceCloudConnectionStatusUpdateEvent.v1' | 'een.edgeReportedDeviceStatusEvent.v1' | 'een.deviceIOEvent.v1' | 'een.deviceOperationEvent.v1' | 'een.ptzPositionUpdateEvent.v1' | 'een.doorStatusEvent.v1' | 'een.batteryLevelUpdateEvent.v1' | 'een.measurementThresholdStatusEvent.v1' | 'een.thermalCameraThresholdStatusEvent.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' | 'een.jobCreationEvent.v1' | 'een.jobUpdateEvent.v1' | 'een.jobDeletionEvent.v1' | 'een.panicButtonEvent.v1' | 'een.evacuateProtocolEvent.v1' | 'een.holdProtocolEvent.v1' | 'een.lockdownProtocolEvent.v1' | 'een.secureProtocolEvent.v1' | 'een.shelterProtocolEvent.v1' | 'een.violenceDetectionEvent.v1' | 'een.fightDetectionEvent.v1' | 'een.handsUpDetectionEvent.v1' | 'een.vapeDetectionEvent.v1';
|
|
4470
|
+
export declare type KnownEventType = 'een.motionDetectionEvent.v1' | 'een.motionInRegionDetectionEvent.v1' | 'een.personDetectionEvent.v1' | 'een.personMotionDetectionEvent.v1' | 'een.animalDetectionEvent.v1' | 'een.faceDetectionEvent.v1' | 'een.vehicleDetectionEvent.v1' | 'een.vehicleMotionDetectionEvent.v1' | 'een.gunDetectionEvent.v1' | 'een.weaponDetectionEvent.v1' | 'een.fallDetectionEvent.v1' | 'een.fireDetectionEvent.v1' | 'een.spillDetectionEvent.v1' | 'een.crowdFormationDetectionEvent.v1' | 'een.tamperDetectionEvent.v1' | 'een.loiterDetectionEvent.v1' | 'een.objectLineCrossEvent.v1' | 'een.objectLineCrossCountEvent.v1' | 'een.countedObjectLineCrossEvent.v1' | 'een.objectIntrusionEvent.v1' | 'een.objectRemovalEvent.v1' | 'een.personTailgateEvent.v1' | 'een.ppeViolationEvent.v1' | 'een.sceneLabelEvent.v1' | 'een.eevaQueryEvent.v1' | 'een.lprPlateReadEvent.v1' | 'een.fleetCodeRecognitionEvent.v1' | 'een.gunShotAudioDetectionEvent.v1' | 'een.t3AlarmAudioDetectionEvent.v1' | 'een.t4AlarmAudioDetectionEvent.v1' | 'een.posTransactionEvent.v1' | 'een.deviceCloudStatusUpdateEvent.v1' | 'een.deviceCloudConnectionStatusUpdateEvent.v1' | 'een.edgeReportedDeviceStatusEvent.v1' | 'een.deviceIOEvent.v1' | 'een.deviceOperationEvent.v1' | 'een.ptzPositionUpdateEvent.v1' | 'een.doorStatusEvent.v1' | 'een.batteryLevelUpdateEvent.v1' | 'een.measurementThresholdStatusEvent.v1' | 'een.thermalCameraThresholdStatusEvent.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' | 'een.jobCreationEvent.v1' | 'een.jobUpdateEvent.v1' | 'een.jobDeletionEvent.v1' | 'een.accessActivationEvent.v1' | 'een.panicButtonEvent.v1' | 'een.evacuateProtocolEvent.v1' | 'een.holdProtocolEvent.v1' | 'een.lockdownProtocolEvent.v1' | 'een.secureProtocolEvent.v1' | 'een.shelterProtocolEvent.v1' | 'een.violenceDetectionEvent.v1' | 'een.fightDetectionEvent.v1' | 'een.handsUpDetectionEvent.v1' | 'een.vapeDetectionEvent.v1';
|
|
4467
4471
|
|
|
4468
4472
|
/**
|
|
4469
4473
|
* Layout entity from EEN API v3.0.
|
package/dist/index.js
CHANGED
|
@@ -1563,6 +1563,12 @@ const z = {
|
|
|
1563
1563
|
"een.jobCreationEvent.v1": ["een.jobDetails.v1", "een.ownerDetails.v1"],
|
|
1564
1564
|
"een.jobUpdateEvent.v1": ["een.jobDetails.v1", "een.ownerDetails.v1"],
|
|
1565
1565
|
"een.jobDeletionEvent.v1": ["een.ownerDetails.v1"],
|
|
1566
|
+
// Access control events
|
|
1567
|
+
"een.accessActivationEvent.v1": [
|
|
1568
|
+
"een.credentialAccessActivation.v1",
|
|
1569
|
+
"een.creatorDetails.v1",
|
|
1570
|
+
"een.userAccessActivation.v1"
|
|
1571
|
+
],
|
|
1566
1572
|
// Safety and protocol events (no data schemas)
|
|
1567
1573
|
"een.panicButtonEvent.v1": ["een.geoLocation.v1"],
|
|
1568
1574
|
"een.evacuateProtocolEvent.v1": [],
|