@shieldiot/pulse-lib 1.0.10 → 1.0.11

package/dist/cjs/lib/common/SessionTransform.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionTransform = void 0;
+// Session data transformation parameters (to calculate z-score)
+class SessionTransform {
+    constructor(packetsIn, packetsOut, bytesIn, bytesOut) {
+        if (packetsIn !== undefined) {
+            this.packetsIn = packetsIn;
+        }
+        if (packetsOut !== undefined) {
+            this.packetsOut = packetsOut;
+        }
+        if (bytesIn !== undefined) {
+            this.bytesIn = bytesIn;
+        }
+        if (bytesOut !== undefined) {
+            this.bytesOut = bytesOut;
+        }
+    }
+}
+exports.SessionTransform = SessionTransform;

package/dist/cjs/lib/common/SeverityConditionConfig.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeverityConditionConfig = void 0;
+// SeverityConditionConfig is a set of severity configuration configs
+class SeverityConditionConfig {
+    constructor(conditionSeverity, sevs, countTH, severityFactor, severityRange) {
+        if (conditionSeverity !== undefined) {
+            this.conditionSeverity = conditionSeverity;
+        }
+        if (sevs !== undefined) {
+            this.sevs = sevs;
+        }
+        if (countTH !== undefined) {
+            this.countTH = countTH;
+        }
+        if (severityFactor !== undefined) {
+            this.severityFactor = severityFactor;
+        }
+        if (severityRange !== undefined) {
+            this.severityRange = severityRange;
+        }
+    }
+}
+exports.SeverityConditionConfig = SeverityConditionConfig;

package/dist/cjs/lib/common/SeverityIntervalTuple.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeverityIntervalTuple = void 0;
+// SeverityIntervalTuple  is tuple of SeverityTypeCode and Interval
+class SeverityIntervalTuple {
+    constructor(severity, interval) {
+        if (severity !== undefined) {
+            this.severity = severity;
+        }
+        if (interval !== undefined) {
+            this.interval = interval;
+        }
+    }
+}
+exports.SeverityIntervalTuple = SeverityIntervalTuple;

package/dist/cjs/lib/common/ShieldexConfig.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShieldexConfig = void 0;
+// ShieldexConfig is a shieldex configuration values for the Risk calculation
+class ShieldexConfig {
+    constructor(alphaWeightFactor, percentFactor, lowRiskWeight, mediumRiskWeight, highRiskWeight, criticalRiskWeight) {
+        if (alphaWeightFactor !== undefined) {
+            this.alphaWeightFactor = alphaWeightFactor;
+        }
+        if (percentFactor !== undefined) {
+            this.percentFactor = percentFactor;
+        }
+        if (lowRiskWeight !== undefined) {
+            this.lowRiskWeight = lowRiskWeight;
+        }
+        if (mediumRiskWeight !== undefined) {
+            this.mediumRiskWeight = mediumRiskWeight;
+        }
+        if (highRiskWeight !== undefined) {
+            this.highRiskWeight = highRiskWeight;
+        }
+        if (criticalRiskWeight !== undefined) {
+            this.criticalRiskWeight = criticalRiskWeight;
+        }
+    }
+}
+exports.ShieldexConfig = ShieldexConfig;

package/dist/cjs/lib/common/StringIntValue.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringIntValue = void 0;
+// String Int Value tuple
+class StringIntValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.StringIntValue = StringIntValue;

package/dist/cjs/lib/common/StringKeyIntValue.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringKeyIntValue = void 0;
+// Key Value string  to int tuple
+class StringKeyIntValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.StringKeyIntValue = StringKeyIntValue;

package/dist/cjs/lib/common/StringKeyValue.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringKeyValue = void 0;
+// Key Value string tuple
+class StringKeyValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.StringKeyValue = StringKeyValue;

package/dist/cjs/lib/common/Thresholds.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Thresholds = void 0;
+// Thresholds is a list of stream configuration thresholds
+class Thresholds {
+    constructor(inactiveDeviceWindowMin) {
+        if (inactiveDeviceWindowMin !== undefined) {
+            this.inactiveDeviceWindowMin = inactiveDeviceWindowMin;
+        }
+    }
+}
+exports.Thresholds = Thresholds;

package/dist/cjs/lib/common/TimeDataPoint.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeDataPoint = void 0;
+// TimeDataPoint model represents a generic datapoint in time
+class TimeDataPoint {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.TimeDataPoint = TimeDataPoint;

package/dist/cjs/lib/common/TimeDataPoint2D.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeDataPoint2D = void 0;
+// TimeDataPoint2D model represents a 2 dimensions datapoint in time
+class TimeDataPoint2D {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.TimeDataPoint2D = TimeDataPoint2D;

package/dist/cjs/lib/common/TimeDataPointFloat.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeDataPointFloat = void 0;
+// TimeDataPointFloat model represents a float datapoint in time
+class TimeDataPointFloat {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.TimeDataPointFloat = TimeDataPointFloat;

package/dist/cjs/lib/common/TimeFrame.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeFrame = void 0;
+// TimeFrame represents a finite time window (from - to)
+class TimeFrame {
+    constructor(from, to) {
+        if (from !== undefined) {
+            this.from = from;
+        }
+        if (to !== undefined) {
+            this.to = to;
+        }
+    }
+}
+exports.TimeFrame = TimeFrame;

package/dist/cjs/lib/common/TimeSeries.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeSeries = void 0;
+// TimeSeries model represents a generic set of data points over time
+class TimeSeries {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.TimeSeries = TimeSeries;

package/dist/cjs/lib/common/TimeSeriesOf2D.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeSeriesOf2D = void 0;
+// TimeSeriesOf2D model represents a 2 dimension samples over time
+class TimeSeriesOf2D {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.TimeSeriesOf2D = TimeSeriesOf2D;

package/dist/cjs/lib/common/TimeSeriesOfDataConsumption.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeSeriesOfDataConsumption = void 0;
+// TimeSeriesOfDataConsumption model represents a data consumption (in, out, total Kb) samples over time
+class TimeSeriesOfDataConsumption {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.TimeSeriesOfDataConsumption = TimeSeriesOfDataConsumption;

package/dist/cjs/lib/common/TimeSeriesOfFloat.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeSeriesOfFloat = void 0;
+// TimeSeriesOfFloat model represents a float set of data points over time
+class TimeSeriesOfFloat {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.TimeSeriesOfFloat = TimeSeriesOfFloat;

package/dist/cjs/lib/common/TokenData.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenData = void 0;
+// TokenData model represents a user in account which is encrypted with the JWT token
+class TokenData {
+    constructor(accountId, subjectId, subjectType, role, status, expiresIn) {
+        if (accountId !== undefined) {
+            this.accountId = accountId;
+        }
+        if (subjectId !== undefined) {
+            this.subjectId = subjectId;
+        }
+        if (subjectType !== undefined) {
+            this.subjectType = subjectType;
+        }
+        if (role !== undefined) {
+            this.role = role;
+        }
+        if (status !== undefined) {
+            this.status = status;
+        }
+        if (expiresIn !== undefined) {
+            this.expiresIn = expiresIn;
+        }
+    }
+}
+exports.TokenData = TokenData;

package/dist/cjs/lib/common/Tuple.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tuple = void 0;
+// Tuple model represents a generic key-value pair
+class Tuple {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.Tuple = Tuple;

package/dist/cjs/lib/common/UsageTransform.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsageTransform = void 0;
+// Usage data transformation parameters (to calculate z-score)
+class UsageTransform {
+    constructor(packetsIn, packetsOut, bytesIn, bytesOut, endpointsCount, portsCount) {
+        if (packetsIn !== undefined) {
+            this.packetsIn = packetsIn;
+        }
+        if (packetsOut !== undefined) {
+            this.packetsOut = packetsOut;
+        }
+        if (bytesIn !== undefined) {
+            this.bytesIn = bytesIn;
+        }
+        if (bytesOut !== undefined) {
+            this.bytesOut = bytesOut;
+        }
+        if (endpointsCount !== undefined) {
+            this.endpointsCount = endpointsCount;
+        }
+        if (portsCount !== undefined) {
+            this.portsCount = portsCount;
+        }
+    }
+}
+exports.UsageTransform = UsageTransform;

package/dist/cjs/lib/common/ZScore.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZScore = void 0;
+// ZScore parameters
+class ZScore {
+    constructor(mean, sD) {
+        if (mean !== undefined) {
+            this.mean = mean;
+        }
+        if (sD !== undefined) {
+            this.sD = sD;
+        }
+    }
+}
+exports.ZScore = ZScore;

package/dist/cjs/lib/common/index.js

@@ -0,0 +1,60 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AccountRole"), exports);
+__exportStar(require("./ConsumptionData"), exports);
+__exportStar(require("./ConsumptionTimeDataPoint"), exports);
+__exportStar(require("./DeviceConfig"), exports);
+__exportStar(require("./DeviceScoreConfig"), exports);
+__exportStar(require("./DevicesAtRiskConfig"), exports);
+__exportStar(require("./EventSeverityConfig"), exports);
+__exportStar(require("./FloatKeyValue"), exports);
+__exportStar(require("./GeoData"), exports);
+__exportStar(require("./GraphSeries"), exports);
+__exportStar(require("./Indicator"), exports);
+__exportStar(require("./IntKeySeriesDataValue"), exports);
+__exportStar(require("./IntKeyValue"), exports);
+__exportStar(require("./Interval"), exports);
+__exportStar(require("./Link"), exports);
+__exportStar(require("./Location"), exports);
+__exportStar(require("./LoginParams"), exports);
+__exportStar(require("./MaliciousIPCard"), exports);
+__exportStar(require("./MaliciousIPData"), exports);
+__exportStar(require("./NetworkMap"), exports);
+__exportStar(require("./Node"), exports);
+__exportStar(require("./RuleBasedSeverityConditionConfig"), exports);
+__exportStar(require("./RuleCountThresholdConfig"), exports);
+__exportStar(require("./SeriesData"), exports);
+__exportStar(require("./SessionTransform"), exports);
+__exportStar(require("./SeverityConditionConfig"), exports);
+__exportStar(require("./SeverityIntervalTuple"), exports);
+__exportStar(require("./ShieldexConfig"), exports);
+__exportStar(require("./StringIntValue"), exports);
+__exportStar(require("./StringKeyIntValue"), exports);
+__exportStar(require("./StringKeyValue"), exports);
+__exportStar(require("./Thresholds"), exports);
+__exportStar(require("./TimeDataPoint"), exports);
+__exportStar(require("./TimeDataPoint2D"), exports);
+__exportStar(require("./TimeDataPointFloat"), exports);
+__exportStar(require("./TimeFrame"), exports);
+__exportStar(require("./TimeSeries"), exports);
+__exportStar(require("./TimeSeriesOf2D"), exports);
+__exportStar(require("./TimeSeriesOfDataConsumption"), exports);
+__exportStar(require("./TimeSeriesOfFloat"), exports);
+__exportStar(require("./TokenData"), exports);
+__exportStar(require("./Tuple"), exports);
+__exportStar(require("./UsageTransform"), exports);
+__exportStar(require("./ZScore"), exports);

package/dist/cjs/lib/entities/Account.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Account = void 0;
+const base_1 = require("../base");
+// Account entity in the system represents customer account
+class Account extends base_1.BaseEntity {
+}
+exports.Account = Account;

package/dist/cjs/lib/entities/AccountDTO.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountDTO = void 0;
+const base_1 = require("../base");
+// AccountDTO includes additional data for display
+class AccountDTO extends base_1.BaseEntity {
+}
+exports.AccountDTO = AccountDTO;

package/dist/cjs/lib/entities/AccountSettings.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountSettings = void 0;
+// AccountSettings is a set of account attributes
+class AccountSettings {
+    constructor(logo, defaultHomePageView, complianceReportSettings, teaserPopUpSettings) {
+        if (logo !== undefined) {
+            this.logo = logo;
+        }
+        if (defaultHomePageView !== undefined) {
+            this.defaultHomePageView = defaultHomePageView;
+        }
+        if (complianceReportSettings !== undefined) {
+            this.complianceReportSettings = complianceReportSettings;
+        }
+        if (teaserPopUpSettings !== undefined) {
+            this.teaserPopUpSettings = teaserPopUpSettings;
+        }
+    }
+}
+exports.AccountSettings = AccountSettings;

package/dist/cjs/lib/entities/Action.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Action = void 0;
+const base_1 = require("../base");
+// Action entity is a user action applied on an event or device
+class Action extends base_1.BaseEntity {
+}
+exports.Action = Action;

package/dist/cjs/lib/entities/Alert.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Alert = void 0;
+const base_1 = require("../base");
+// Cyber event entity
+// The Event entity is created by multiple services (e.g. ip reputation, static rules, anomaly detection) by analyzing network statistics (usage and session data) and related to specific IP address.
+// Since it is not always clear what is the actual device with the IP address (RADIUS or DIAMETER logs can be provided later), we should be able to create event without device Id and assign the device Id later on.
+// For this purpose, when the device Id is not provided, the event will be created with the `unknown` value in the deviceId field and the eventId must follow the following pattern: streamId:timestamp:ip_address
+class Alert extends base_1.BaseEntity {
+}
+exports.Alert = Alert;

package/dist/cjs/lib/entities/AlertWithDevice.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AlertWithDevice = void 0;
+const base_1 = require("../base");
+// AlertWithDevice entity is an event with the device information (for display only)
+class AlertWithDevice extends base_1.BaseEntity {
+}
+exports.AlertWithDevice = AlertWithDevice;

package/dist/cjs/lib/entities/ApiKey.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiKey = void 0;
+const base_1 = require("../base");
+// ApiKey entity is a structure representing the source data fields encapsulated in the API key
+class ApiKey extends base_1.BaseEntity {
+}
+exports.ApiKey = ApiKey;

package/dist/cjs/lib/entities/AuditLog.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuditLog = void 0;
+const base_1 = require("../base");
+// Audit Log - each entry represents a single action done by user
+class AuditLog extends base_1.BaseEntity {
+}
+exports.AuditLog = AuditLog;

package/dist/cjs/lib/entities/BulkDevices.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkDevices = void 0;
+// BulkDevices list of devices for bulk operations
+class BulkDevices {
+    constructor(values) {
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.BulkDevices = BulkDevices;

package/dist/cjs/lib/entities/Checkpoint.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Checkpoint = void 0;
+const base_1 = require("../base");
+// Checkpoint represents parsing status in time that preserves parsing cycle statistics and last checkpoint (timestamp) to avoid parsing the same files over and over again
+class Checkpoint extends base_1.BaseEntity {
+}
+exports.Checkpoint = Checkpoint;

package/dist/cjs/lib/entities/ComplianceReportSettings.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComplianceReportSettings = void 0;
+// ComplianceReportSettings is a set of account's compliance report settings.
+class ComplianceReportSettings {
+    constructor(title, subTitle, header, footer) {
+        if (title !== undefined) {
+            this.title = title;
+        }
+        if (subTitle !== undefined) {
+            this.subTitle = subTitle;
+        }
+        if (header !== undefined) {
+            this.header = header;
+        }
+        if (footer !== undefined) {
+            this.footer = footer;
+        }
+    }
+}
+exports.ComplianceReportSettings = ComplianceReportSettings;

package/dist/cjs/lib/entities/Condition.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Condition = void 0;
+class Condition {
+    constructor(field, operator, values, strings) {
+        if (field !== undefined) {
+            this.field = field;
+        }
+        if (operator !== undefined) {
+            this.operator = operator;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+        if (strings !== undefined) {
+            this.strings = strings;
+        }
+    }
+}
+exports.Condition = Condition;

package/dist/cjs/lib/entities/ConfigParam.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigParam = void 0;
+const base_1 = require("../base");
+// ConfigParam stores a key-value pair as a system configuration parameter
+// The id is the key of the parameter
+class ConfigParam extends base_1.BaseEntity {
+}
+exports.ConfigParam = ConfigParam;

package/dist/cjs/lib/entities/ConfigParams.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigParams = void 0;
+const base_1 = require("../base");
+// ConfigParams stores a list of system configuration parameters
+class ConfigParams extends base_1.BaseEntity {
+}
+exports.ConfigParams = ConfigParams;

package/dist/cjs/lib/entities/DNSRecord.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DNSRecord = void 0;
+const base_1 = require("../base");
+// DNSRecord represents network statistics of DNS requests
+// The createdOn field represents the first communication time of the device within this time window
+// The updatedOn field represents the last communication time of the device within this time window
+class DNSRecord extends base_1.BaseEntity {
+}
+exports.DNSRecord = DNSRecord;