@shieldiot/pulse-lib 1.0.10 → 1.0.11

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

@@ -0,0 +1,17 @@
+// Session data transformation parameters (to calculate z-score)
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,20 @@
+// SeverityConditionConfig is a set of severity configuration configs
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// SeverityIntervalTuple  is tuple of SeverityTypeCode and Interval
+export class SeverityIntervalTuple {
+    constructor(severity, interval) {
+        if (severity !== undefined) {
+            this.severity = severity;
+        }
+        if (interval !== undefined) {
+            this.interval = interval;
+        }
+    }
+}

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

@@ -0,0 +1,23 @@
+// ShieldexConfig is a shieldex configuration values for the Risk calculation
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// String Int Value tuple
+export class StringIntValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// Key Value string  to int tuple
+export class StringKeyIntValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// Key Value string tuple
+export class StringKeyValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,8 @@
+// Thresholds is a list of stream configuration thresholds
+export class Thresholds {
+    constructor(inactiveDeviceWindowMin) {
+        if (inactiveDeviceWindowMin !== undefined) {
+            this.inactiveDeviceWindowMin = inactiveDeviceWindowMin;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// TimeDataPoint model represents a generic datapoint in time
+export class TimeDataPoint {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// TimeDataPoint2D model represents a 2 dimensions datapoint in time
+export class TimeDataPoint2D {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// TimeDataPointFloat model represents a float datapoint in time
+export class TimeDataPointFloat {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// TimeFrame represents a finite time window (from - to)
+export class TimeFrame {
+    constructor(from, to) {
+        if (from !== undefined) {
+            this.from = from;
+        }
+        if (to !== undefined) {
+            this.to = to;
+        }
+    }
+}

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

@@ -0,0 +1,14 @@
+// TimeSeries model represents a generic set of data points over time
+export class TimeSeries {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

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

@@ -0,0 +1,14 @@
+// TimeSeriesOf2D model represents a 2 dimension samples over time
+export class TimeSeriesOf2D {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

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

@@ -0,0 +1,14 @@
+// TimeSeriesOfDataConsumption model represents a data consumption (in, out, total Kb) samples over time
+export class TimeSeriesOfDataConsumption {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

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

@@ -0,0 +1,14 @@
+// TimeSeriesOfFloat model represents a float set of data points over time
+export class TimeSeriesOfFloat {
+    constructor(name, range, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (range !== undefined) {
+            this.range = range;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

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

@@ -0,0 +1,23 @@
+// TokenData model represents a user in account which is encrypted with the JWT token
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// Tuple model represents a generic key-value pair
+export class Tuple {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

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

@@ -0,0 +1,23 @@
+// Usage data transformation parameters (to calculate z-score)
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,11 @@
+// ZScore parameters
+export class ZScore {
+    constructor(mean, sD) {
+        if (mean !== undefined) {
+            this.mean = mean;
+        }
+        if (sD !== undefined) {
+            this.sD = sD;
+        }
+    }
+}

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

@@ -0,0 +1,44 @@
+export * from './AccountRole';
+export * from './ConsumptionData';
+export * from './ConsumptionTimeDataPoint';
+export * from './DeviceConfig';
+export * from './DeviceScoreConfig';
+export * from './DevicesAtRiskConfig';
+export * from './EventSeverityConfig';
+export * from './FloatKeyValue';
+export * from './GeoData';
+export * from './GraphSeries';
+export * from './Indicator';
+export * from './IntKeySeriesDataValue';
+export * from './IntKeyValue';
+export * from './Interval';
+export * from './Link';
+export * from './Location';
+export * from './LoginParams';
+export * from './MaliciousIPCard';
+export * from './MaliciousIPData';
+export * from './NetworkMap';
+export * from './Node';
+export * from './RuleBasedSeverityConditionConfig';
+export * from './RuleCountThresholdConfig';
+export * from './SeriesData';
+export * from './SessionTransform';
+export * from './SeverityConditionConfig';
+export * from './SeverityIntervalTuple';
+export * from './ShieldexConfig';
+export * from './StringIntValue';
+export * from './StringKeyIntValue';
+export * from './StringKeyValue';
+export * from './Thresholds';
+export * from './TimeDataPoint';
+export * from './TimeDataPoint2D';
+export * from './TimeDataPointFloat';
+export * from './TimeFrame';
+export * from './TimeSeries';
+export * from './TimeSeriesOf2D';
+export * from './TimeSeriesOfDataConsumption';
+export * from './TimeSeriesOfFloat';
+export * from './TokenData';
+export * from './Tuple';
+export * from './UsageTransform';
+export * from './ZScore';

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// Account entity in the system represents customer account
+export class Account extends BaseEntity {
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// AccountDTO includes additional data for display
+export class AccountDTO extends BaseEntity {
+}

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

@@ -0,0 +1,17 @@
+// AccountSettings is a set of account attributes
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// Action entity is a user action applied on an event or device
+export class Action extends BaseEntity {
+}

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

@@ -0,0 +1,7 @@
+import { BaseEntity } from '../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
+export class Alert extends BaseEntity {
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// AlertWithDevice entity is an event with the device information (for display only)
+export class AlertWithDevice extends BaseEntity {
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// ApiKey entity is a structure representing the source data fields encapsulated in the API key
+export class ApiKey extends BaseEntity {
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// Audit Log - each entry represents a single action done by user
+export class AuditLog extends BaseEntity {
+}

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

@@ -0,0 +1,8 @@
+// BulkDevices list of devices for bulk operations
+export class BulkDevices {
+    constructor(values) {
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../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
+export class Checkpoint extends BaseEntity {
+}

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

@@ -0,0 +1,17 @@
+// ComplianceReportSettings is a set of account's compliance report settings.
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,16 @@
+export 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;
+        }
+    }
+}

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

@@ -0,0 +1,5 @@
+import { BaseEntity } from '../base';
+// ConfigParam stores a key-value pair as a system configuration parameter
+// The id is the key of the parameter
+export class ConfigParam extends BaseEntity {
+}

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

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// ConfigParams stores a list of system configuration parameters
+export class ConfigParams extends BaseEntity {
+}

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

@@ -0,0 +1,6 @@
+import { BaseEntity } from '../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
+export class DNSRecord extends BaseEntity {
+}

package/dist/esm/lib/entities/DataIngestion.js

@@ -0,0 +1,41 @@
+// DataIngestion is the ingestion pipeline configuration
+export class DataIngestion {
+    constructor(inputURI, format, archiveURI, inputFilesExt, subNets, exclude, usageTimeWindowSec, sessionTimeWindowSec, schedule, defaultDeviceType, deviceCreationPolicy, deviceIdentityPolicy) {
+        if (inputURI !== undefined) {
+            this.inputURI = inputURI;
+        }
+        if (format !== undefined) {
+            this.format = format;
+        }
+        if (archiveURI !== undefined) {
+            this.archiveURI = archiveURI;
+        }
+        if (inputFilesExt !== undefined) {
+            this.inputFilesExt = inputFilesExt;
+        }
+        if (subNets !== undefined) {
+            this.subNets = subNets;
+        }
+        if (exclude !== undefined) {
+            this.exclude = exclude;
+        }
+        if (usageTimeWindowSec !== undefined) {
+            this.usageTimeWindowSec = usageTimeWindowSec;
+        }
+        if (sessionTimeWindowSec !== undefined) {
+            this.sessionTimeWindowSec = sessionTimeWindowSec;
+        }
+        if (schedule !== undefined) {
+            this.schedule = schedule;
+        }
+        if (defaultDeviceType !== undefined) {
+            this.defaultDeviceType = defaultDeviceType;
+        }
+        if (deviceCreationPolicy !== undefined) {
+            this.deviceCreationPolicy = deviceCreationPolicy;
+        }
+        if (deviceIdentityPolicy !== undefined) {
+            this.deviceIdentityPolicy = deviceIdentityPolicy;
+        }
+    }
+}

package/dist/esm/lib/entities/DataPointOfDeviceReport.js

@@ -0,0 +1,11 @@
+// TimeSeriesOfDeviceReport model represents a time series of DeviceReport
+export class DataPointOfDeviceReport {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

package/dist/esm/lib/entities/Device.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// Device entity is an IoT device representation with attributes and state
+export class Device extends BaseEntity {
+}

package/dist/esm/lib/entities/DeviceReport.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// DeviceReport is a periodic (usually daily) snapshot on status of all devices, field createdOn indicates the snapshot time
+export class DeviceReport extends BaseEntity {
+}

package/dist/esm/lib/entities/DeviceWithEvents.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// DeviceWithEvents entity is a device with its related events (for display only)
+export class DeviceWithEvents extends BaseEntity {
+}

package/dist/esm/lib/entities/Distribution.js

@@ -0,0 +1,14 @@
+// Distribution model represents a grouped counts of elements of generic type int (usually enum)
+export class Distribution {
+    constructor(name, total, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (total !== undefined) {
+            this.total = total;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

package/dist/esm/lib/entities/Event.js

@@ -0,0 +1,6 @@
+import { BaseEntity } from '../base';
+// Alert entity
+// The Alert entity representing an aggregation of many Event occurrences of the same type on the same device in a fixed time period (30 days)
+// The purpose of this aggregation is to avoid flooding the user with many (hundreds and thousands) of events of the same type
+export class Event extends BaseEntity {
+}

package/dist/esm/lib/entities/EventOccurrence.js

@@ -0,0 +1,20 @@
+// A single instance of event generated for the same deviceId based on the same rule on the same month
+export class EventOccurrence {
+    constructor(timestamp, source, sourceIp, indicators, trafficDirection) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (source !== undefined) {
+            this.source = source;
+        }
+        if (sourceIp !== undefined) {
+            this.sourceIp = sourceIp;
+        }
+        if (indicators !== undefined) {
+            this.indicators = indicators;
+        }
+        if (trafficDirection !== undefined) {
+            this.trafficDirection = trafficDirection;
+        }
+    }
+}

package/dist/esm/lib/entities/EventWithDevice.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// EventWithDevice entity is an event with the device information (for display only)
+export class EventWithDevice extends BaseEntity {
+}

package/dist/esm/lib/entities/Feature.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// Feature entity is capability in the system used for feature toggle
+export class Feature extends BaseEntity {
+}

package/dist/esm/lib/entities/FeaturesGroup.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// FeaturesGroup group represents a group of capabilities in the system used for feature toggle
+export class FeaturesGroup extends BaseEntity {
+}

package/dist/esm/lib/entities/Group.js

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../base';
+// Group represents a set of memberships to various accounts.
+export class Group extends BaseEntity {
+}

package/dist/esm/lib/entities/Image.js

@@ -0,0 +1,5 @@
+import { BaseEntity } from '../base';
+// Image stores a small base64 picture (such as: user avatar, account logo, etc) or URI (for large pictures) in the database
+// The id of the image is the entity id * @Table: image
+export class Image extends BaseEntity {
+}

package/dist/esm/lib/entities/Insight.js

@@ -0,0 +1,5 @@
+import { BaseEntity } from '../base';
+// Insight
+// The Insight entity is created by the insights micro service and represents an account-wide insight.
+export class Insight extends BaseEntity {
+}