@nirovision/alarm-helpers/dist/alarmHelpers.js

"use strict";
var __assign = (this && this.__assign) || Object.assign || function(t) {
    for (var s, i = 1, n = arguments.length; i < n; i++) {
        s = arguments[i];
        for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
            t[p] = s[p];
    }
    return t;
};
Object.defineProperty(exports, "__esModule", { value: true });
var _ = require("lodash");
var moment = require("moment-timezone");
var request = require("request-promise");
var AlarmHelpers = /** @class */ (function () {
    function AlarmHelpers(config) {
        /**
         * Every time an 'event' happens, a 'context' object is sent from Nirovision
         * containing information pertinent to the event.
         */
        this.context = config.context;
        this.config = this.context.config;
        this.notificationUri = config.notificationUri;
    }
    /**
     * Returns the webhookId of the event.
     */
    AlarmHelpers.prototype.webhookId = function () {
        return (this.context)
            ? this.context.webhookId
            : undefined;
    };
    /**
     * Returns the id of the company.
     */
    AlarmHelpers.prototype.companyId = function () {
        return (this.context && this.context.event)
            ? this.context.event.companyId
            : undefined;
    };
    /**
     * Returns all information about the location.
     */
    AlarmHelpers.prototype.location = function () {
        return (this.context)
            ? this.context.location
            : undefined;
    };
    /**
     * Returns the name of the location.
     */
    AlarmHelpers.prototype.locationName = function () {
        return (this.context && this.context.location)
            ? this.context.location.name
            : undefined;
    };
    /**
     * Returns the id of the location.
     */
    AlarmHelpers.prototype.locationId = function () {
        return (this.context && this.context.location)
            ? this.context.location.id
            : undefined;
    };
    /**
     * Returns the timezone of the location.
     */
    AlarmHelpers.prototype.timezone = function () {
        return (this.context && this.context.location)
            ? this.context.location.timezone
            : '';
    };
    /**
     * Returns all information about the camera.
     */
    AlarmHelpers.prototype.camera = function () {
        return (this.context)
            ? this.context.camera
            : undefined;
    };
    /**
     * Returns the name of the camera.
     */
    AlarmHelpers.prototype.cameraName = function () {
        return (this.context && this.context.camera)
            ? this.context.camera.name
            : undefined;
    };
    /**
     * Returns the id of the camera.
     */
    AlarmHelpers.prototype.cameraId = function () {
        return (this.context && this.context.camera)
            ? this.context.camera.id
            : undefined;
    };
    /**
     * Returns all information about the geofence.
     */
    AlarmHelpers.prototype.geofence = function () {
        return (this.context)
            ? this.context.geofence
            : undefined;
    };
    /**
     * Returns the status of the geofence.
     */
    AlarmHelpers.prototype.geofenceStatus = function () {
        return (this.context && this.context.geofence)
            ? this.context.geofence.status
            : undefined;
    };
    /**
     * Returns all information about each user on the geofence.
     */
    AlarmHelpers.prototype.geofenceUsers = function () {
        return (this.context && this.context.geofence)
            ? this.context.geofence.users
            : undefined;
    };
    /**
     * Returns the presence of each user on the geofence.
     */
    AlarmHelpers.prototype.geofenceUsersPresence = function () {
        return (this.context && this.context.geofence)
            ? _.map(this.context.geofence.users, function (geofenceUser) {
                return geofenceUser.presence;
            })
            : undefined;
    };
    /**
     * Returns the device of each user on the geofence.
     */
    AlarmHelpers.prototype.geofenceUsersDevice = function () {
        return (this.context && this.context.geofence)
            ? _.map(this.context.geofence.users, function (geofenceUser) {
                return geofenceUser.deviceName;
            })
            : undefined;
    };
    /**
     * Returns all information about each user on the company.
     */
    AlarmHelpers.prototype.users = function () {
        return (this.context)
            ? this.context.users
            : undefined;
    };
    /**
     * Returns the id of each user on the company.
     */
    AlarmHelpers.prototype.userIds = function () {
        return (this.context)
            ? _.map(this.context.users, function (user) {
                return user.id;
            })
            : undefined;
    };
    /**
     * Returns the name of each user on the company.
     */
    AlarmHelpers.prototype.userNames = function () {
        return (this.context)
            ? _.map(this.context.users, function (user) {
                return user.name;
            })
            : undefined;
    };
    /**
     * Returns the email of each user on the company.
     */
    AlarmHelpers.prototype.userEmails = function () {
        return (this.context)
            ? _.map(this.context.users, function (user) {
                return user.email;
            })
            : undefined;
    };
    /**
     * Returns the eventId of the event.
     */
    AlarmHelpers.prototype.eventId = function () {
        return (this.context && this.context.event)
            ? this.context.event.id
            : undefined;
    };
    /**
     * Returns all information about the event.
     */
    AlarmHelpers.prototype.event = function () {
        return (this.context)
            ? this.context.event
            : undefined;
    };
    /**
     * Returns the id of the identity associated with the event if it exists.
     */
    AlarmHelpers.prototype.identityId = function () {
        return (this.context && this.context.identity)
            ? this.context.identity.id
            : undefined;
    };
    /**
     * Returns the identity name associated with the event if it exists.
     */
    AlarmHelpers.prototype.identityName = function () {
        return (this.context && this.context.identity)
            ? this.context.identity.name
            : undefined;
    };
    /**
     * Returns the topic of the event.
     */
    AlarmHelpers.prototype.topic = function () {
        return (this.context && this.context.event)
            ? this.context.event.topic
            : undefined;
    };
    /**
     * Returns the timestamp of the event.
     */
    AlarmHelpers.prototype.timestamp = function () {
        return (this.context && this.context.event)
            ? this.context.event.timestamp
            : undefined;
    };
    /**
     * Returns the tagged feature of the event if it exists.
     */
    AlarmHelpers.prototype.feature = function () {
        return (this.context && this.context.event && this.context.event.data)
            ? this.context.event.data.feature
            : undefined;
    };
    /**
     * Returns the bounding box of the event if it exists.
     */
    AlarmHelpers.prototype.boundingBox = function () {
        return (this.context && this.context.event && this.context.event.data)
            ? this.context.event.data.boundingBox
            : undefined;
    };
    /**
     * Returns the image url of the event.
     */
    AlarmHelpers.prototype.image = function () {
        return (this.context)
            ? this.context.imageUrl
            : undefined;
    };
    /**
     * Checks if the the event was tagged with a 'face' feature.
     */
    AlarmHelpers.prototype.faceDetected = function () {
        return (this.context && this.context.event && this.context.event.data)
            ? this.context.event.data.feature === 'FACE'
            : false;
    };
    /**
     * Checks if the the event was tagged with a 'person' feature.
     */
    AlarmHelpers.prototype.personDetected = function () {
        return (this.context && this.context.event && this.context.event.data)
            ? this.context.event.data.feature === 'PERSON'
            : false;
    };
    /**
     * Checks if the the event was tagged with a 'car' feature.
     */
    AlarmHelpers.prototype.carDetected = function () {
        return (this.context && this.context.event && this.context.event.data)
            ? this.context.event.data.feature === 'CAR'
            : false;
    };
    /**
     * Checks if the the event was tagged with a 'person' feature and that the confidence
     * was greater than the input confidence.
     */
    AlarmHelpers.prototype.personDetectedWithConfidence = function (confidence) {
        return (this.context && this.context.event && this.context.event.data)
            ? this.context.event.data.feature === 'PERSON' && this.context.event.data.confidence >= confidence
            : false;
    };
    /**
     * Checks whether the location id in the alarm configuration matches the location id in
     * the event.
     */
    AlarmHelpers.prototype.matchesLocation = function () {
        return (this.config && this.config.location && this.config.location.id)
            ? this.config.location.id === this.locationId()
            : true;
    };
    /**
     * Checks whether the geofence status in the alarm configuration matches the geofence status
     * in the event.
     */
    AlarmHelpers.prototype.matchesGeofenceStatus = function () {
        return (this.config && this.config.location && this.config.location.geofence)
            ? this.config.location.geofence === this.geofenceStatus()
            : true;
    };
    /**
     * Checks whether the camera(s) id(s) in the alarm configuration matches the camera id
     * in the event.
     */
    AlarmHelpers.prototype.matchesCameras = function () {
        return (this.config && this.config.location && this.config.location.cameras)
            ? _.includes(this.config.location.cameras, this.cameraId())
            : true;
    };
    /**
     * Checks whether the feature in the alarm configuration matches the feature in the event.
     */
    AlarmHelpers.prototype.matchesFeature = function () {
        return (this.config && this.config.features)
            ? _.includes(this.config.features, this.feature())
            : true;
    };
    /**
     * Checks whether the identity(s) id(s) in the alarm configuration matches the identity id
     * in the event.
     */
    AlarmHelpers.prototype.matchesIdentities = function () {
        return (this.config && this.config.identities)
            ? _.includes(this.config.identities, this.identityId())
            : true;
    };
    /**
     * Gets the current time in military time and the current day and checks it against the
     * schedule that may be specified in the alarm configuration. This can be useful when
     * choosing whether to trigger a script based on the schedule.
     */
    AlarmHelpers.prototype.inSchedule = function () {
        var timeAtTimezone = moment().tz(this.timezone());
        var currentTime = parseInt(timeAtTimezone.format('HHmm'), 10);
        var currentDay = timeAtTimezone.format('dddd').toUpperCase();
        if (this.config && this.config.schedule) {
            if (this.config.schedule.isInverted) {
                return !_.includes(_.range(this.config.schedule.start, this.config.schedule.end), currentTime) &&
                    !_.includes(this.config.schedule.days, currentDay);
            }
            return _.includes(_.range(this.config.schedule.start, this.config.schedule.end), currentTime) &&
                _.includes(this.config.schedule.days, currentDay);
        }
        return true;
    };
    /**
     * Formats the timestamp sent in the event to be ISO8601 format.
     */
    AlarmHelpers.prototype.formattedTimestamp = function () {
        return moment(this.timestamp()).tz(this.timezone()).toISOString(true);
    };
    /**
     * Sends a notification to the Nirovision notification service or another specified service.
     * Generally this function will always want to be used as the final step of the script, after
     * the conditions of the script have been met and the desired notification has been constructed.
     */
    AlarmHelpers.prototype.sendNotification = function (notification) {
        return request({
            method: 'POST',
            uri: this.notificationUri ? this.notificationUri : "https://api.nirovision.com/v1/notifications",
            headers: {
                'Authorization': "Bearer " + this.context.accessToken,
                'nirovision-event-id': this.context.event.id,
            },
            body: __assign({ companyId: this.companyId() }, notification),
            json: true,
            timeout: 15000,
        });
    };
    return AlarmHelpers;
}());
exports.default = AlarmHelpers;