@shieldiot/pulse-lib 1.0.5 → 1.0.6

package/src/lib/entities/Device.ts

@@ -1,82 +0,0 @@
-import { BaseEntity } from '../entities';
-import { DeviceTypeCode } from '../enums';
-import { DeviceStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { DeviceActionCode } from '../enums';
-import { SIM } from '../entities';
-
-
-
-// Device entity is an IoT device representation with attributes and state
-export class Device extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // The device identity in the external system (used for integration) 
-    public externalId: string;
- 
-    // Device name 
-    public name: string;
- 
-    // Device description 
-    public description: string;
- 
-    // Country name 
-    public country: string;
- 
-    // Mobile network operator name 
-    public operator: string;
- 
-    // Device type: UNDEFINED | CONTROLLER | METER | SENSOR ... 
-    public type: DeviceTypeCode;
- 
-    // Device status: UNDEFINED | PENDING | ACTIVE |  INACTIVE | SUSPENDED 
-    public status: DeviceStatusCode;
- 
-    // Device last activity timestamp [Epoch milliseconds Timestamp] 
-    public lastActivity: number;
- 
-    // Device MAC address 
-    public mac: string;
- 
-    // Device IP address (IPv4 or IPv6) 
-    public ip: string;
- 
-    // Device mobile subscriber id (IMSI or SUPI for 5G) 
-    public sid: string;
- 
-    // Device mobile equipment id (IMEI or PEI for 5G) 
-    public eid: string;
- 
-    // 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;
- 
-    // Action applied on the device 
-    public actionApplied: DeviceActionCode;
- 
-    // Who applied the action (user id) 
-    public actionAppliedBy: string;
- 
-    // When action was applied [Epoch milliseconds Timestamp] 
-    public actionAppliedOn: number;
- 
-    // List of SIM cards associated with the device 
-    public simCards: SIM[];
- 
- 
-}
-
-

package/src/lib/entities/DeviceReport.ts

@@ -1,29 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// DeviceReport is a periodic (usually daily) snapshot on status of all devices, field createdOn indicates the snapshot time
-export class DeviceReport extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Total device count 
-    public totalDevices: number;
- 
-    // Total active device count 
-    public activeDevices: number;
- 
-    // Total device at risk count 
-    public devicesAtRisk: number;
- 
-    // Total affected device count: (where their distinct event count is more than 0) 
-    public affectedDevices: number;
- 
- 
-}
-
-

package/src/lib/entities/DeviceWithEvents.ts

@@ -1,86 +0,0 @@
-import { SIM } from '../entities';
-import { Event } from '../entities';
-import { BaseEntity } from '../entities';
-import { DeviceTypeCode } from '../enums';
-import { DeviceStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { DeviceActionCode } from '../enums';
-
-
-
-// DeviceWithEvents entity is a device with its related events (for display only)
-export class DeviceWithEvents extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // The device identity in the external system (used for integration) id 
-    public externalId: string;
- 
-    // Device name 
-    public name: string;
- 
-    // Device description 
-    public description: string;
- 
-    // Country name 
-    public country: string;
- 
-    // Mobile network operator name 
-    public operator: string;
- 
-    // Device type: UNDEFINED | CONTROLLER | METER | SENSOR ... 
-    public type: DeviceTypeCode;
- 
-    // Device status: UNDEFINED | PENDING | ACTIVE |  INACTIVE | SUSPENDED 
-    public status: DeviceStatusCode;
- 
-    // Device last activity timestamp [Epoch milliseconds Timestamp] 
-    public lastActivity: number;
- 
-    // Device MAC address 
-    public mac: string;
- 
-    // Device IP address (IPv4 or IPv6) 
-    public ip: string;
- 
-    // Device mobile subscriber id (IMSI or SUPI for 5G) 
-    public sid: string;
- 
-    // Device mobile equipment id (IMEI or PEI for 5G) 
-    public eid: string;
- 
-    // 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;
- 
-    // Action applied on the device 
-    public actionApplied: DeviceActionCode;
- 
-    // Who applied the action (user id) 
-    public actionAppliedBy: string;
- 
-    // When action was applied [Epoch milliseconds Timestamp] 
-    public actionAppliedOn: number;
- 
-    // List of SIM cards associated with the device 
-    public simCards: SIM[];
- 
-    // Device events list 
-    public events: Event[];
- 
- 
-}
-
-

package/src/lib/entities/Distribution.ts

@@ -1,25 +0,0 @@
-import { Tuple } from '../common';
-
-
-
-// Distribution model represents a grouped counts of elements of generic type int (usually enum)
-export class Distribution {
- 
-    // Name of the time series 
-    public name: string;
- 
-    // Total count (of all group elements) 
-    public total: number;
- 
-    // Series of generic data points 
-    public values: Tuple[];
- 
-     constructor(name?: string, total?: number, values?: Tuple[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (total !== undefined) { this.total = total; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-

package/src/lib/entities/Event.ts

@@ -1,98 +0,0 @@
-import { GeoData } from '../common';
-import { StringKeyValue } from '../common';
-import { EventCategoryCode } from '../enums';
-import { EventOccurrence } from '../entities';
-import { BaseEntity } from '../entities';
-import { EventStatusCode } from '../enums';
-import { Indicator } from '../common';
-import { RuleTypeCode } from '../enums';
-import { EventTypeCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { TrafficDirectionCode } from '../enums';
-
-
-
-// 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 {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public endTime: number;
- 
-    // Event type: UNDEFINED | DDOS | PORT_SCANNING | DEVICE_TAKEOVER ... 
-    public type: EventTypeCode;
- 
-    // Event severity level: UNDEFINED | LOW | MEDIUM | HIGH | CRITICAL 
-    public severity: SeverityTypeCode;
- 
-    // Event current security score 
-    public score: number;
- 
-    // Probability score by IP reputation engine 
-    public probability: number;
- 
-    // Event workflow status: UNDEFINED | NEW | OPEN ... 
-    public status: EventStatusCode;
- 
-    // List of event indicators 
-    public indicators: Indicator[];
- 
-    // Rule type: UNDEFINED | SUSPICIOUS_IP | STATIC | ANOMALY 
-    public ruleType: RuleTypeCode;
- 
-    // Static Rule id (in case of SUSPICIOUS_IP, it should be the IP value) 
-    public ruleId: string;
- 
-    // The allocated IP for the device at the time of the event occurrence 
-    public sourceIp: string;
- 
-    // Target IP address for some of the events (e.g. suspicious IP) 
-    public targetIp: string;
- 
-    // GeoIP information based on MaxMind database 
-    public targetLocation: GeoData;
- 
-    // Event description 
-    public description: string;
- 
-    // Additional Event tags 
-    public tags: string[];
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Event category 
-    public category: EventCategoryCode;
- 
-    // Recommended action description to apply on the device 
-    public recommendedAction: string;
- 
-    // DEPRECATED: List of occurrences of the aggregated event 
-    public occurrences: EventOccurrence[];
- 
-    // Denotes network traffic direction: UNDEFINED | INBOUND | OUTBOUND 
-    public trafficDirection: TrafficDirectionCode;
- 
-    // Contains confidence score of malicious IP detection. Value range: 0-100 
-    public confidenceScore: number;
- 
-    // Event occurrences count 
-    public occurrencesCount: boolean;
- 
- 
-}
-
-

package/src/lib/entities/EventOccurrence.ts

@@ -1,34 +0,0 @@
-import { Indicator } from '../common';
-import { TrafficDirectionCode } from '../enums';
-
-
-
-// A single instance of event generated for the same deviceId based on the same rule on the same month
-export class EventOccurrence {
- 
-    // Event occurrence time [Epoch milliseconds Timestamp] 
-    public timestamp: number;
- 
-    // Referenced source file 
-    public source: string;
- 
-    // The allocated IP for the device at the time of the event occurrence 
-    public sourceIp: string;
- 
-    // List of event occurrence indicators 
-    public indicators: Indicator[];
- 
-    // Denotes network traffic direction: UNDEFINED | INBOUND | OUTBOUND 
-    public trafficDirection: TrafficDirectionCode;
- 
-     constructor(timestamp?: number, source?: string, sourceIp?: string, indicators?: Indicator[], trafficDirection?: TrafficDirectionCode) { 
-        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/src/lib/entities/EventWithDevice.ts

@@ -1,97 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { Indicator } from '../common';
-import { RuleTypeCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { EventOccurrence } from '../entities';
-import { Device } from '../entities';
-import { BaseEntity } from '../entities';
-import { EventTypeCode } from '../enums';
-import { EventStatusCode } from '../enums';
-import { GeoData } from '../common';
-import { EventCategoryCode } from '../enums';
-import { TrafficDirectionCode } from '../enums';
-
-
-
-// EventWithDevice entity is an event with the device information (for display only)
-export class EventWithDevice extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public endTime: number;
- 
-    // Event type: UNDEFINED | DDOS | PORT_SCANNING | DEVICE_TAKEOVER ... 
-    public type: EventTypeCode;
- 
-    // Event severity level: UNDEFINED | LOW | MEDIUM | HIGH | CRITICAL 
-    public severity: SeverityTypeCode;
- 
-    // Event current security score 
-    public score: number;
- 
-    // Probability score by IP reputation engine 
-    public probability: number;
- 
-    // Event workflow status: UNDEFINED | NEW | OPEN ... 
-    public status: EventStatusCode;
- 
-    // List of event indicators 
-    public indicators: Indicator[];
- 
-    // Rule engine type 
-    public ruleType: RuleTypeCode;
- 
-    // Static Rule id 
-    public ruleId: string;
- 
-    // Target IP address for some of the events (e.g. suspicious IP) 
-    public targetIp: string;
- 
-    // GeoIP information based on MaxMind database 
-    public targetLocation: GeoData;
- 
-    // Event description 
-    public description: string;
- 
-    // Additional Event tags 
-    public tags: string[];
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Event category 
-    public category: EventCategoryCode;
- 
-    // Recommended action description to apply on the device 
-    public recommendedAction: string;
- 
-    // DEPRECATED: List of occurrences of the aggregated event 
-    public occurrences: EventOccurrence[];
- 
-    // Denotes network traffic direction: UNDEFINED | INBOUND | OUTBOUND 
-    public trafficDirection: TrafficDirectionCode;
- 
-    // Contains confidence score of malicious IP detection. Value range: 0-100 
-    public confidenceScore: number;
- 
-    // Event occurrences count 
-    public occurrencesCount: boolean;
- 
-    // Device attached to the event 
-    public device: Device;
- 
- 
-}
-
-

package/src/lib/entities/Feature.ts

@@ -1,18 +0,0 @@
-import { BaseEntity } from '../entities';
-import { FeatureCode } from '../enums';
-
-
-
-// Feature entity is capability in the system used for feature toggle
-export class Feature extends BaseEntity {
- 
-    // Feature code 
-    public code: FeatureCode;
- 
-    // Feature name 
-    public name: string;
- 
- 
-}
-
-

package/src/lib/entities/FeaturesGroup.ts

@@ -1,18 +0,0 @@
-import { FeatureCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// FeaturesGroup group represents a group of capabilities in the system used for feature toggle
-export class FeaturesGroup extends BaseEntity {
- 
-    // Features group display name 
-    public name: string;
- 
-    // List of features 
-    public features: FeatureCode[];
- 
- 
-}
-
-

package/src/lib/entities/Group.ts

@@ -1,24 +0,0 @@
-import { AccountRole } from '../common';
-import { BaseEntity } from '../entities';
-
-
-
-// Group represents a set of memberships to various accounts.
-export class Group extends BaseEntity {
- 
-    // Group name 
-    public name: string;
- 
-    // The group identity in the external system (e.g. Billing, CRM etc) @json:externalId"` 
-    public externalId: string;
- 
-    // Group email 
-    public email: string;
- 
-    // List of group roles in the accounts 
-    public accountRoles: AccountRole[];
- 
- 
-}
-
-

package/src/lib/entities/Image.ts

@@ -1,18 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// 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 {
- 
-    // Image content URL (starts with http) or embedded image (base64) 
-    public content: string;
- 
-    // Image content Mime Type 
-    public contentType: string;
- 
- 
-}
-
-

package/src/lib/entities/Insight.ts

@@ -1,49 +0,0 @@
-import { InsightTypeCode } from '../enums';
-import { InsightStatusCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { DirectionContextCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// Insight
-// The Insight entity is created by the insights micro service and represents an account-wide insight.
-export class Insight extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Insight specification Id 
-    public specId: string;
- 
-    // Insight day (number representing a day in the format of: yyyymmdd) 
-    public dayId: number;
- 
-    // Insight type: UNDEFINED | EVENTS | STATISTICS 
-    public type: InsightTypeCode;
- 
-    // Insight status: UNDEFINED | INACTIVE | PENDING | ACTIVE 
-    public status: InsightStatusCode;
- 
-    // The string representing the insight description in the UI 
-    public description: string;
- 
-    // Linked objects for this insight 
-    public links: string[];
- 
-    // Event severity: UNDEFINED | LOW | MEDIUM |  HIGH | ... 
-    public severity: SeverityTypeCode;
- 
-    // Title : short description of insight 
-    public title: string;
- 
-    // InsightDirectionContext: UNDEFINED | EVENT_LIST | DEVICE_LIST | EVENT_DETAILS | DEVICE_DETAILS 
-    public insightDirectionContext: DirectionContextCode;
- 
- 
-}
-
-

package/src/lib/entities/InsightQuery.ts

@@ -1,29 +0,0 @@
-import { InsightTypeCode } from '../enums';
-import { DirectionContextCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// InsightQuery
-// The InsightQuery entity is a definition of insight query to execute periodically in order to generate "insights" for the users.
-export class InsightQuery extends BaseEntity {
- 
-    // Insight type: UNDEFINED | EVENTS | STATISTICS 
-    public type: InsightTypeCode;
- 
-    // Templated string to show the description in the UI 
-    public description: string;
- 
-    // Insight query definition (KQL) 
-    public query: string;
- 
-    // InsightDirectionContext: UNDEFINED | EVENT_LIST | DEVICE_LIST | EVENT_DETAILS | DEVICE_DETAILS 
-    public insightDirectionContext: DirectionContextCode;
- 
-    // Insight UI query definition . query to use from API as response to UI on clickable insight 
-    public uIQuery: string;
- 
- 
-}
-
-

package/src/lib/entities/InsightSpec.ts

@@ -1,28 +0,0 @@
-import { InsightStatusCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// InsightSpec
-// The InsightSpec entity is a link between account and stream Id to insight query.
-export class InsightSpec extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Insight query Id 
-    public queryId: string;
- 
-    // Is Insight enabled (if disabled, it will not be calculated) 
-    public enabled: boolean;
- 
-    // Insight status: UNDEFINED | INACTIVE | PENDING | ACTIVE 
-    public status: InsightStatusCode;
- 
- 
-}
-
-

package/src/lib/entities/IntDistribution.ts

@@ -1,25 +0,0 @@
-import { IntKeyValue } from '../common';
-
-
-
-// IntDistribution model represents a grouped counts of elements of type int (usually enum)
-export class IntDistribution {
- 
-    // Distribution name 
-    public name: string;
- 
-    // Total count (of all elements) 
-    public total: number;
- 
-    // List of elements mapped to counter 
-    public values: IntKeyValue[];
- 
-     constructor(name?: string, total?: number, values?: IntKeyValue[]) { 
-        if (name !== undefined) { this.name = name; }
-        if (total !== undefined) { this.total = total; }
-        if (values !== undefined) { this.values = values; }
-    }
-
-}
-
-