@shieldiot/pulse-lib 1.0.5 → 1.0.6

package/src/lib/common/NetworkMap.ts

@@ -1,22 +0,0 @@
-import { Node } from '../common';
-import { Link } from '../common';
-
-
-
-// NetworkMap is a data structure representing a set of nodes and vertex representing a network
-export class NetworkMap {
- 
-    // List of nodes 
-    public nodes: Node[];
- 
-    // List of links 
-    public links: Link[];
- 
-     constructor(nodes?: Node[], links?: Link[]) { 
-        if (nodes !== undefined) { this.nodes = nodes; }
-        if (links !== undefined) { this.links = links; }
-    }
-
-}
-
-

package/src/lib/common/Node.ts

@@ -1,54 +0,0 @@
-import { DeviceTypeCode } from '../enums';
-import { StringKeyValue } from '../common';
-
-
-
-// Node represents a vertex in a network map
-export class Node {
- 
-    // Node Id 
-    public id: string;
- 
-    // Node name 
-    public name: string;
- 
-    // Node IP 
-    public ip: string;
- 
-    // Device type (for nodes representing a device) 
-    public type: DeviceTypeCode;
- 
-    // Device current security score 
-    public score: number;
- 
-    // List of device tags 
-    public tags: string[];
- 
-    // Custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Number of events for the time period (calculated field) 
-    public eventCount: number;
- 
-    // Is aggregated node 
-    public isGroup: boolean;
- 
-    // 
-    public deviceCount: number;
- 
-     constructor(id?: string, name?: string, ip?: string, type?: DeviceTypeCode, score?: number, tags?: string[], labels?: StringKeyValue[], eventCount?: number, isGroup?: boolean, deviceCount?: number) { 
-        if (id !== undefined) { this.id = id; }
-        if (name !== undefined) { this.name = name; }
-        if (ip !== undefined) { this.ip = ip; }
-        if (type !== undefined) { this.type = type; }
-        if (score !== undefined) { this.score = score; }
-        if (tags !== undefined) { this.tags = tags; }
-        if (labels !== undefined) { this.labels = labels; }
-        if (eventCount !== undefined) { this.eventCount = eventCount; }
-        if (isGroup !== undefined) { this.isGroup = isGroup; }
-        if (deviceCount !== undefined) { this.deviceCount = deviceCount; }
-    }
-
-}
-
-

package/src/lib/common/SeriesData.ts

@@ -1,22 +0,0 @@
-import { Interval } from '../common';
-import { StringKeyIntValue } from '../common';
-
-
-
-// SeriesData model represents a generic datapoint in interval range
-export class SeriesData {
- 
-    // Data interval 
-    public interval: Interval;
- 
-    // Custom attributes (key-value pairs) 
-    public values: StringKeyIntValue[];
- 
-     constructor(interval?: Interval, values?: StringKeyIntValue[]) { 
-        if (interval !== undefined) { this.interval = interval; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/SessionTransform.ts

@@ -1,29 +0,0 @@
-import { ZScore } from '../common';
-
-
-
-// Session data transformation parameters (to calculate z-score)
-export class SessionTransform {
- 
-    // ZScore parameters for incoming packets (to the device) 
-    public packetsIn: ZScore;
- 
-    // ZScore parameters for outgoing packets (from the device) 
-    public packetsOut: ZScore;
- 
-    // ZScore parameters for total number of incoming bytes (to the device) 
-    public bytesIn: ZScore;
- 
-    // ZScore parameters for total number of outgoing bytes (from the device) 
-    public bytesOut: ZScore;
- 
-     constructor(packetsIn?: ZScore, packetsOut?: ZScore, bytesIn?: ZScore, bytesOut?: ZScore) { 
-        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/src/lib/common/SeverityIntervalTuple.ts

@@ -1,22 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { Interval } from '../common';
-
-
-
-// SeverityIntervalTuple  is tuple of SeverityTypeCode and Interval
-export class SeverityIntervalTuple {
- 
-    // Event severity type code 
-    public severity: SeverityTypeCode;
- 
-    // Severity interval from-to 
-    public interval: Interval;
- 
-     constructor(severity?: SeverityTypeCode, interval?: Interval) { 
-        if (severity !== undefined) { this.severity = severity; }
-        if (interval !== undefined) { this.interval = interval; }
-    }
-
-}
-
-

package/src/lib/common/ShieldexConfig.ts

@@ -1,36 +0,0 @@
-
-
-
-// ShieldexConfig is a shieldex configuration values for the Risk calculation
-export class ShieldexConfig {
- 
-    // Deprecated: Alpha weight factor for shieldex calculation 
-    public alphaWeightFactor: number;
- 
-    // Deprecated: Percent factor for shieldex calculation 
-    public percentFactor: number;
- 
-    // Low risk devices weight 
-    public lowRiskWeight: number;
- 
-    // Medium risk devices weight 
-    public mediumRiskWeight: number;
- 
-    // High risk devices weight 
-    public highRiskWeight: number;
- 
-    // Critical risk devices weight 
-    public criticalRiskWeight: number;
- 
-     constructor(alphaWeightFactor?: number, percentFactor?: number, lowRiskWeight?: number, mediumRiskWeight?: number, highRiskWeight?: number, criticalRiskWeight?: number) { 
-        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/src/lib/common/StringIntValue.ts

@@ -1,20 +0,0 @@
-
-
-
-// String Int Value tuple
-export class StringIntValue {
- 
-    // Key of tuple 
-    public key: string;
- 
-    // Value of tuple 
-    public value: number;
- 
-     constructor(key?: string, value?: number) { 
-        if (key !== undefined) { this.key = key; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/StringKeyIntValue.ts

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

package/src/lib/common/StringKeyValue.ts

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

package/src/lib/common/Thresholds.ts

@@ -1,16 +0,0 @@
-
-
-
-// Thresholds is a list of stream configuration thresholds
-export class Thresholds {
- 
-    // Total time (in minutes) from the last device activity to change the device status to INACTIVE 
-    public inactiveDeviceWindowMin: number;
- 
-     constructor(inactiveDeviceWindowMin?: number) { 
-        if (inactiveDeviceWindowMin !== undefined) { this.inactiveDeviceWindowMin = inactiveDeviceWindowMin; }
-    }
-
-}
-
-

package/src/lib/common/TimeDataPoint.ts

@@ -1,20 +0,0 @@
-
-
-
-// TimeDataPoint model represents a generic datapoint in time
-export class TimeDataPoint {
- 
-    // Sata point timestamp [Epoch milliseconds Timestamp] 
-    public timestamp: number;
- 
-    // Generic value 
-    public value: any;
- 
-     constructor(timestamp?: number, value?: any) { 
-        if (timestamp !== undefined) { this.timestamp = timestamp; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/TimeDataPoint2D.ts

@@ -1,21 +0,0 @@
-import { FloatKeyValue } from '../common';
-
-
-
-// TimeDataPoint2D model represents a 2 dimensions datapoint in time
-export class TimeDataPoint2D {
- 
-    // Sata point timestamp [Epoch milliseconds Timestamp] 
-    public timestamp: number;
- 
-    // Float value 
-    public value: FloatKeyValue[];
- 
-     constructor(timestamp?: number, value?: FloatKeyValue[]) { 
-        if (timestamp !== undefined) { this.timestamp = timestamp; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/TimeDataPointFloat.ts

@@ -1,20 +0,0 @@
-
-
-
-// TimeDataPointFloat model represents a float datapoint in time
-export class TimeDataPointFloat {
- 
-    // Sata point timestamp [Epoch milliseconds Timestamp] 
-    public timestamp: number;
- 
-    // Float value 
-    public value: number;
- 
-     constructor(timestamp?: number, value?: number) { 
-        if (timestamp !== undefined) { this.timestamp = timestamp; }
-        if (value !== undefined) { this.value = value; }
-    }
-
-}
-
-

package/src/lib/common/TimeFrame.ts

@@ -1,20 +0,0 @@
-
-
-
-// TimeFrame represents a finite time window (from - to)
-export class TimeFrame {
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public from: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public to: number;
- 
-     constructor(from?: number, to?: number) { 
-        if (from !== undefined) { this.from = from; }
-        if (to !== undefined) { this.to = to; }
-    }
-
-}
-
-

package/src/lib/common/TimeSeries.ts

@@ -1,26 +0,0 @@
-import { TimeFrame } from '../common';
-import { TimeDataPoint } from '../common';
-
-
-
-// TimeSeries model represents a generic set of data points over time
-export class TimeSeries {
- 
-    // Name of the time series 
-    public name: string;
- 
-    // Range of the series (from ... to) 
-    public range: TimeFrame;
- 
-    // Series of generic data points 
-    public values: TimeDataPoint[];
- 
-     constructor(name?: string, range?: TimeFrame, values?: TimeDataPoint[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (range !== undefined) { this.range = range; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/TimeSeriesOf2D.ts

@@ -1,26 +0,0 @@
-import { TimeFrame } from '../common';
-import { TimeDataPoint2D } from '../common';
-
-
-
-// TimeSeriesOf2D model represents a 2 dimension samples over time
-export class TimeSeriesOf2D {
- 
-    // Name of the time series 
-    public name: string;
- 
-    // Range of the series (from ... to) 
-    public range: TimeFrame;
- 
-    // Series of float data points 
-    public values: TimeDataPoint2D[];
- 
-     constructor(name?: string, range?: TimeFrame, values?: TimeDataPoint2D[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (range !== undefined) { this.range = range; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/TimeSeriesOfDataConsumption.ts

@@ -1,26 +0,0 @@
-import { TimeFrame } from '../common';
-import { ConsumptionTimeDataPoint } from '../common';
-
-
-
-// TimeSeriesOfDataConsumption model represents a data consumption (in, out, total Kb) samples over time
-export class TimeSeriesOfDataConsumption {
- 
-    // Name of the time series 
-    public name: string;
- 
-    // Range of the series (from ... to) 
-    public range: TimeFrame;
- 
-    // Series of consumption data points 
-    public values: ConsumptionTimeDataPoint[];
- 
-     constructor(name?: string, range?: TimeFrame, values?: ConsumptionTimeDataPoint[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (range !== undefined) { this.range = range; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/TimeSeriesOfFloat.ts

@@ -1,26 +0,0 @@
-import { TimeFrame } from '../common';
-import { TimeDataPointFloat } from '../common';
-
-
-
-// TimeSeriesOfFloat model represents a float set of data points over time
-export class TimeSeriesOfFloat {
- 
-    // Name of the time series 
-    public name: string;
- 
-    // Range of the series (from ... to) 
-    public range: TimeFrame;
- 
-    // Series of float data points 
-    public values: TimeDataPointFloat[];
- 
-     constructor(name?: string, range?: TimeFrame, values?: TimeDataPointFloat[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (range !== undefined) { this.range = range; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/common/TokenData.ts

@@ -1,39 +0,0 @@
-import { UserStatusCode } from '../enums';
-import { UserTypeCode } from '../enums';
-import { MemberRoleCode } from '../enums';
-
-
-
-// TokenData model represents a user in account which is encrypted with the JWT token
-export class TokenData {
- 
-    // Account ID 
-    public accountId: string;
- 
-    // Authenticated subject ID (can be user, or service account) 
-    public subjectId: string;
- 
-    // Subject type: UNDEFINED | SYSADMIN | USER | SERVICE_ACCOUNT 
-    public subjectType: UserTypeCode;
- 
-    // Role of user in the account: UNDEFINED | ADMIN | USER 
-    public role: MemberRoleCode;
- 
-    // User status: UNDEFINED | PENDING | ACTIVE | BLOCKED | SUSPENDED 
-    public status: UserStatusCode;
- 
-    // Token expiration [Epoch milliseconds Timestamp] 
-    public expiresIn: number;
- 
-     constructor(accountId?: string, subjectId?: string, subjectType?: UserTypeCode, role?: MemberRoleCode, status?: UserStatusCode, expiresIn?: number) { 
-        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/src/lib/common/Tuple.ts

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

package/src/lib/common/UsageTransform.ts

@@ -1,37 +0,0 @@
-import { ZScore } from '../common';
-
-
-
-// Usage data transformation parameters (to calculate z-score)
-export class UsageTransform {
- 
-    // ZScore parameters for incoming packets (to the device) 
-    public packetsIn: ZScore;
- 
-    // ZScore parameters for outgoing packets (from the device) 
-    public packetsOut: ZScore;
- 
-    // ZScore parameters for total number of incoming bytes (to the device) 
-    public bytesIn: ZScore;
- 
-    // ZScore parameters for total number of outgoing bytes (from the device) 
-    public bytesOut: ZScore;
- 
-    // ZScore parameters for total number of destination endpoints 
-    public endpointsCount: ZScore;
- 
-    // ZScore parameters for total number of destination ports 
-    public portsCount: ZScore;
- 
-     constructor(packetsIn?: ZScore, packetsOut?: ZScore, bytesIn?: ZScore, bytesOut?: ZScore, endpointsCount?: ZScore, portsCount?: ZScore) { 
-        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/src/lib/common/ZScore.ts

@@ -1,20 +0,0 @@
-
-
-
-// ZScore parameters
-export class ZScore {
- 
-    // Mean value 
-    public mean: number;
- 
-    // Standard Deviation 
-    public sD: number;
- 
-     constructor(mean?: number, sD?: number) { 
-        if (mean !== undefined) { this.mean = mean; }
-        if (sD !== undefined) { this.sD = sD; }
-    }
-
-}
-
-

package/src/lib/common/index.ts

@@ -1,41 +0,0 @@
-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 './SeriesData';
-export * from './SessionTransform';
-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/src/lib/entities/Account.ts

@@ -1,45 +0,0 @@
-import { BaseEntity } from '../entities';
-import { AccountTypeCode } from '../enums';
-import { AccountStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { AccountSettings } from '../entities';
-
-
-
-// Account entity in the system represents customer account
-export class Account extends BaseEntity {
- 
-    // Account name 
-    public name: string;
- 
-    // The account identity in the external system (e.g. Billing, CRM etc) @json:externalId"` 
-    public externalId: string;
- 
-    // Account description 
-    public description: string;
- 
-    // Account Type: UNDEFINED | DEMO | TRIAL | PARTNER | CUSTOMER 
-    public type: AccountTypeCode;
- 
-    // Account status: UNDEFINED | ACTIVE | SUSPENDED 
-    public status: AccountStatusCode;
- 
-    // List of associated account groups (for feature toggle) 
-    public groups: string[];
- 
-    // When the account will be expired [Epoch milliseconds Timestamp] (0 means no expiration time) 
-    public expiredOn: number;
- 
-    // Additional user defined tags 
-    public tags: string[];
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Account specific attributes 
-    public settings: AccountSettings;
- 
- 
-}
-
-