@shieldiot/pulse-lib 1.0.1

package/src/lib/entities/DeviceWithEvents.js

@@ -0,0 +1,51 @@
+import { BaseEntity } from '../entities';
+// DeviceWithEvents entity is a device with its related events (for display only)
+export class DeviceWithEvents extends BaseEntity {
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // The device identity in the external system (used for integration) id 
+    externalId;
+    // Device name 
+    name;
+    // Device description 
+    description;
+    // Country name 
+    country;
+    // Mobile network operator name 
+    operator;
+    // Device type: UNDEFINED | CONTROLLER | METER | SENSOR ... 
+    type;
+    // Device status: UNDEFINED | PENDING | ACTIVE |  INACTIVE | SUSPENDED 
+    status;
+    // Device last activity timestamp [Epoch milliseconds Timestamp] 
+    lastActivity;
+    // Device MAC address 
+    mac;
+    // Device IP address (IPv4 or IPv6) 
+    ip;
+    // Device mobile subscriber id (IMSI or SUPI for 5G) 
+    sid;
+    // Device mobile equipment id (IMEI or PEI for 5G) 
+    eid;
+    // Device current security score 
+    score;
+    // List of device tags 
+    tags;
+    // Custom attributes (key-value pairs) 
+    labels;
+    // Number of events for the time period (calculated field) 
+    eventCount;
+    // Action applied on the device 
+    actionApplied;
+    // Who applied the action (user id) 
+    actionAppliedBy;
+    // When action was applied [Epoch milliseconds Timestamp] 
+    actionAppliedOn;
+    // List of SIM cards associated with the device 
+    simCards;
+    // Device events list 
+    events;
+}
+//# sourceMappingURL=DeviceWithEvents.js.map

package/src/lib/entities/DeviceWithEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceWithEvents.js","sourceRoot":"","sources":["DeviceWithEvents.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAUzC,iFAAiF;AACjF,MAAM,OAAO,gBAAiB,SAAQ,UAAU;IAE5C,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,wEAAwE;IACjE,UAAU,CAAS;IAE1B,eAAe;IACR,IAAI,CAAS;IAEpB,sBAAsB;IACf,WAAW,CAAS;IAE3B,gBAAgB;IACT,OAAO,CAAS;IAEvB,gCAAgC;IACzB,QAAQ,CAAS;IAExB,4DAA4D;IACrD,IAAI,CAAiB;IAE5B,uEAAuE;IAChE,MAAM,CAAmB;IAEhC,iEAAiE;IAC1D,YAAY,CAAS;IAE5B,sBAAsB;IACf,GAAG,CAAS;IAEnB,oCAAoC;IAC7B,EAAE,CAAS;IAElB,qDAAqD;IAC9C,GAAG,CAAS;IAEnB,mDAAmD;IAC5C,GAAG,CAAS;IAEnB,iCAAiC;IAC1B,KAAK,CAAS;IAErB,uBAAuB;IAChB,IAAI,CAAW;IAEtB,uCAAuC;IAChC,MAAM,CAAmB;IAEhC,2DAA2D;IACpD,UAAU,CAAS;IAE1B,gCAAgC;IACzB,aAAa,CAAmB;IAEvC,oCAAoC;IAC7B,eAAe,CAAS;IAE/B,0DAA0D;IACnD,eAAe,CAAS;IAE/B,gDAAgD;IACzC,QAAQ,CAAQ;IAEvB,sBAAsB;IACf,MAAM,CAAU;CAG1B"}

package/src/lib/entities/DeviceWithEvents.ts

@@ -0,0 +1,86 @@
+import { BaseEntity } from '../entities';
+import { DeviceTypeCode } from '../enums';
+import { DeviceStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { DeviceActionCode } from '../enums';
+import { SIM } from '../entities';
+import { Event } from '../entities';
+
+
+
+// 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.d.ts

@@ -0,0 +1,8 @@
+import { Tuple } from '../common';
+export declare class Distribution {
+    name: string;
+    total: number;
+    values: Tuple[];
+    constructor(name?: string, total?: number, values?: Tuple[]);
+}
+//# sourceMappingURL=Distribution.d.ts.map

package/src/lib/entities/Distribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Distribution.d.ts","sourceRoot":"","sources":["Distribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAKlC,qBAAa,YAAY;IAGd,IAAI,EAAE,MAAM,CAAC;IAGb,KAAK,EAAE,MAAM,CAAC;IAGd,MAAM,EAAE,KAAK,EAAE,CAAC;gBAEV,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE;CAM/D"}

package/src/lib/entities/Distribution.js

@@ -0,0 +1,21 @@
+// Distribution model represents a grouped counts of elements of generic type int (usually enum)
+export class Distribution {
+    // Name of the time series 
+    name;
+    // Total count (of all group elements) 
+    total;
+    // Series of generic data points 
+    values;
+    constructor(name, total, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (total !== undefined) {
+            this.total = total;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+//# sourceMappingURL=Distribution.js.map

package/src/lib/entities/Distribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Distribution.js","sourceRoot":"","sources":["Distribution.ts"],"names":[],"mappings":"AAIA,gGAAgG;AAChG,MAAM,OAAO,YAAY;IAErB,2BAA2B;IACpB,IAAI,CAAS;IAEpB,uCAAuC;IAChC,KAAK,CAAS;IAErB,iCAAiC;IAC1B,MAAM,CAAU;IAEtB,YAAY,IAAa,EAAE,KAAc,EAAE,MAAgB;QACxD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAAC,CAAC;QAC7C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAAC,CAAC;QAChD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;IACvD,CAAC;CAEJ"}

package/src/lib/entities/Distribution.ts

@@ -0,0 +1,25 @@
+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.d.ts

@@ -0,0 +1,39 @@
+import { BaseEntity } from '../entities';
+import { EventTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { TrafficDirectionCode } from '../enums';
+import { SeverityTypeCode } from '../enums';
+import { Indicator } from '../common';
+import { RuleTypeCode } from '../enums';
+import { EventCategoryCode } from '../enums';
+import { EventOccurrence } from '../entities';
+export declare class Event extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    deviceId: string;
+    startTime: number;
+    endTime: number;
+    type: EventTypeCode;
+    severity: SeverityTypeCode;
+    score: number;
+    probability: number;
+    status: EventStatusCode;
+    indicators: Indicator[];
+    ruleType: RuleTypeCode;
+    ruleId: string;
+    sourceIp: string;
+    targetIp: string;
+    targetLocation: GeoData;
+    description: string;
+    tags: string[];
+    labels: StringKeyValue[];
+    category: EventCategoryCode;
+    recommendedAction: string;
+    occurrences: EventOccurrence[];
+    trafficDirection: TrafficDirectionCode;
+    confidenceScore: number;
+    occurrencesCount: boolean;
+}
+//# sourceMappingURL=Event.d.ts.map

package/src/lib/entities/Event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Event.d.ts","sourceRoot":"","sources":["Event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAO9C,qBAAa,KAAM,SAAQ,UAAU;IAG1B,SAAS,EAAE,MAAM,CAAC;IAGlB,QAAQ,EAAE,MAAM,CAAC;IAGjB,QAAQ,EAAE,MAAM,CAAC;IAGjB,SAAS,EAAE,MAAM,CAAC;IAGlB,OAAO,EAAE,MAAM,CAAC;IAGhB,IAAI,EAAE,aAAa,CAAC;IAGpB,QAAQ,EAAE,gBAAgB,CAAC;IAG3B,KAAK,EAAE,MAAM,CAAC;IAGd,WAAW,EAAE,MAAM,CAAC;IAGpB,MAAM,EAAE,eAAe,CAAC;IAGxB,UAAU,EAAE,SAAS,EAAE,CAAC;IAGxB,QAAQ,EAAE,YAAY,CAAC;IAGvB,MAAM,EAAE,MAAM,CAAC;IAGf,QAAQ,EAAE,MAAM,CAAC;IAGjB,QAAQ,EAAE,MAAM,CAAC;IAGjB,cAAc,EAAE,OAAO,CAAC;IAGxB,WAAW,EAAE,MAAM,CAAC;IAGpB,IAAI,EAAE,MAAM,EAAE,CAAC;IAGf,MAAM,EAAE,cAAc,EAAE,CAAC;IAGzB,QAAQ,EAAE,iBAAiB,CAAC;IAG5B,iBAAiB,EAAE,MAAM,CAAC;IAG1B,WAAW,EAAE,eAAe,EAAE,CAAC;IAG/B,gBAAgB,EAAE,oBAAoB,CAAC;IAGvC,eAAe,EAAE,MAAM,CAAC;IAGxB,gBAAgB,EAAE,OAAO,CAAC;CAGpC"}

package/src/lib/entities/Event.js

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

package/src/lib/entities/Event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Event.js","sourceRoot":"","sources":["Event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAczC,eAAe;AACf,8IAA8I;AAC9I,8HAA8H;AAC9H,MAAM,OAAO,KAAM,SAAQ,UAAU;IAEjC,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,aAAa;IACN,QAAQ,CAAS;IAExB,oDAAoD;IAC7C,SAAS,CAAS;IAEzB,kDAAkD;IAC3C,OAAO,CAAS;IAEvB,sEAAsE;IAC/D,IAAI,CAAgB;IAE3B,oEAAoE;IAC7D,QAAQ,CAAmB;IAElC,gCAAgC;IACzB,KAAK,CAAS;IAErB,6CAA6C;IACtC,WAAW,CAAS;IAE3B,qDAAqD;IAC9C,MAAM,CAAkB;IAE/B,4BAA4B;IACrB,UAAU,CAAc;IAE/B,2DAA2D;IACpD,QAAQ,CAAe;IAE9B,wEAAwE;IACjE,MAAM,CAAS;IAEtB,uEAAuE;IAChE,QAAQ,CAAS;IAExB,iEAAiE;IAC1D,QAAQ,CAAS;IAExB,+CAA+C;IACxC,cAAc,CAAU;IAE/B,qBAAqB;IACd,WAAW,CAAS;IAE3B,yBAAyB;IAClB,IAAI,CAAW;IAEtB,+CAA+C;IACxC,MAAM,CAAmB;IAEhC,kBAAkB;IACX,QAAQ,CAAoB;IAEnC,yDAAyD;IAClD,iBAAiB,CAAS;IAEjC,2DAA2D;IACpD,WAAW,CAAoB;IAEtC,qEAAqE;IAC9D,gBAAgB,CAAuB;IAE9C,2EAA2E;IACpE,eAAe,CAAS;IAE/B,2BAA2B;IACpB,gBAAgB,CAAU;CAGpC"}

package/src/lib/entities/Event.ts

@@ -0,0 +1,98 @@
+import { BaseEntity } from '../entities';
+import { EventTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { TrafficDirectionCode } from '../enums';
+import { SeverityTypeCode } from '../enums';
+import { Indicator } from '../common';
+import { RuleTypeCode } from '../enums';
+import { EventCategoryCode } from '../enums';
+import { EventOccurrence } from '../entities';
+
+
+
+// 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.d.ts

@@ -0,0 +1,11 @@
+import { Indicator } from '../common';
+import { TrafficDirectionCode } from '../enums';
+export declare class EventOccurrence {
+    timestamp: number;
+    source: string;
+    sourceIp: string;
+    indicators: Indicator[];
+    trafficDirection: TrafficDirectionCode;
+    constructor(timestamp?: number, source?: string, sourceIp?: string, indicators?: Indicator[], trafficDirection?: TrafficDirectionCode);
+}
+//# sourceMappingURL=EventOccurrence.d.ts.map

package/src/lib/entities/EventOccurrence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventOccurrence.d.ts","sourceRoot":"","sources":["EventOccurrence.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAKhD,qBAAa,eAAe;IAGjB,SAAS,EAAE,MAAM,CAAC;IAGlB,MAAM,EAAE,MAAM,CAAC;IAGf,QAAQ,EAAE,MAAM,CAAC;IAGjB,UAAU,EAAE,SAAS,EAAE,CAAC;IAGxB,gBAAgB,EAAE,oBAAoB,CAAC;gBAEjC,SAAS,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,SAAS,EAAE,EAAE,gBAAgB,CAAC,EAAE,oBAAoB;CAQzI"}

package/src/lib/entities/EventOccurrence.js

@@ -0,0 +1,31 @@
+// 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] 
+    timestamp;
+    // Referenced source file 
+    source;
+    // The allocated IP for the device at the time of the event occurrence 
+    sourceIp;
+    // List of event occurrence indicators 
+    indicators;
+    // Denotes network traffic direction: UNDEFINED | INBOUND | OUTBOUND 
+    trafficDirection;
+    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;
+        }
+    }
+}
+//# sourceMappingURL=EventOccurrence.js.map

package/src/lib/entities/EventOccurrence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventOccurrence.js","sourceRoot":"","sources":["EventOccurrence.ts"],"names":[],"mappings":"AAKA,sGAAsG;AACtG,MAAM,OAAO,eAAe;IAExB,wDAAwD;IACjD,SAAS,CAAS;IAEzB,0BAA0B;IACnB,MAAM,CAAS;IAEtB,uEAAuE;IAChE,QAAQ,CAAS;IAExB,uCAAuC;IAChC,UAAU,CAAc;IAE/B,qEAAqE;IAC9D,gBAAgB,CAAuB;IAE7C,YAAY,SAAkB,EAAE,MAAe,EAAE,QAAiB,EAAE,UAAwB,EAAE,gBAAuC;QAClI,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAAC,CAAC;QAC5D,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;QACnD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAAC,CAAC;QACzD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAAC,CAAC;QAC/D,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAAC,CAAC;IACrF,CAAC;CAEJ"}

package/src/lib/entities/EventOccurrence.ts

@@ -0,0 +1,34 @@
+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.d.ts

@@ -0,0 +1,40 @@
+import { EventOccurrence } from '../entities';
+import { EventTypeCode } from '../enums';
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { Indicator } from '../common';
+import { RuleTypeCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { Device } from '../entities';
+import { BaseEntity } from '../entities';
+import { EventCategoryCode } from '../enums';
+import { TrafficDirectionCode } from '../enums';
+export declare class EventWithDevice extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    deviceId: string;
+    startTime: number;
+    endTime: number;
+    type: EventTypeCode;
+    severity: SeverityTypeCode;
+    score: number;
+    probability: number;
+    status: EventStatusCode;
+    indicators: Indicator[];
+    ruleType: RuleTypeCode;
+    ruleId: string;
+    targetIp: string;
+    targetLocation: GeoData;
+    description: string;
+    tags: string[];
+    labels: StringKeyValue[];
+    category: EventCategoryCode;
+    recommendedAction: string;
+    occurrences: EventOccurrence[];
+    trafficDirection: TrafficDirectionCode;
+    confidenceScore: number;
+    occurrencesCount: boolean;
+    device: Device;
+}
+//# sourceMappingURL=EventWithDevice.d.ts.map

package/src/lib/entities/EventWithDevice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventWithDevice.d.ts","sourceRoot":"","sources":["EventWithDevice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAKhD,qBAAa,eAAgB,SAAQ,UAAU;IAGpC,SAAS,EAAE,MAAM,CAAC;IAGlB,QAAQ,EAAE,MAAM,CAAC;IAGjB,QAAQ,EAAE,MAAM,CAAC;IAGjB,SAAS,EAAE,MAAM,CAAC;IAGlB,OAAO,EAAE,MAAM,CAAC;IAGhB,IAAI,EAAE,aAAa,CAAC;IAGpB,QAAQ,EAAE,gBAAgB,CAAC;IAG3B,KAAK,EAAE,MAAM,CAAC;IAGd,WAAW,EAAE,MAAM,CAAC;IAGpB,MAAM,EAAE,eAAe,CAAC;IAGxB,UAAU,EAAE,SAAS,EAAE,CAAC;IAGxB,QAAQ,EAAE,YAAY,CAAC;IAGvB,MAAM,EAAE,MAAM,CAAC;IAGf,QAAQ,EAAE,MAAM,CAAC;IAGjB,cAAc,EAAE,OAAO,CAAC;IAGxB,WAAW,EAAE,MAAM,CAAC;IAGpB,IAAI,EAAE,MAAM,EAAE,CAAC;IAGf,MAAM,EAAE,cAAc,EAAE,CAAC;IAGzB,QAAQ,EAAE,iBAAiB,CAAC;IAG5B,iBAAiB,EAAE,MAAM,CAAC;IAG1B,WAAW,EAAE,eAAe,EAAE,CAAC;IAG/B,gBAAgB,EAAE,oBAAoB,CAAC;IAGvC,eAAe,EAAE,MAAM,CAAC;IAGxB,gBAAgB,EAAE,OAAO,CAAC;IAG1B,MAAM,EAAE,MAAM,CAAC;CAGzB"}

package/src/lib/entities/EventWithDevice.js

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

package/src/lib/entities/EventWithDevice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventWithDevice.js","sourceRoot":"","sources":["EventWithDevice.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,oFAAoF;AACpF,MAAM,OAAO,eAAgB,SAAQ,UAAU;IAE3C,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,aAAa;IACN,QAAQ,CAAS;IAExB,oDAAoD;IAC7C,SAAS,CAAS;IAEzB,kDAAkD;IAC3C,OAAO,CAAS;IAEvB,sEAAsE;IAC/D,IAAI,CAAgB;IAE3B,oEAAoE;IAC7D,QAAQ,CAAmB;IAElC,gCAAgC;IACzB,KAAK,CAAS;IAErB,6CAA6C;IACtC,WAAW,CAAS;IAE3B,qDAAqD;IAC9C,MAAM,CAAkB;IAE/B,4BAA4B;IACrB,UAAU,CAAc;IAE/B,oBAAoB;IACb,QAAQ,CAAe;IAE9B,kBAAkB;IACX,MAAM,CAAS;IAEtB,iEAAiE;IAC1D,QAAQ,CAAS;IAExB,+CAA+C;IACxC,cAAc,CAAU;IAE/B,qBAAqB;IACd,WAAW,CAAS;IAE3B,yBAAyB;IAClB,IAAI,CAAW;IAEtB,+CAA+C;IACxC,MAAM,CAAmB;IAEhC,kBAAkB;IACX,QAAQ,CAAoB;IAEnC,yDAAyD;IAClD,iBAAiB,CAAS;IAEjC,2DAA2D;IACpD,WAAW,CAAoB;IAEtC,qEAAqE;IAC9D,gBAAgB,CAAuB;IAE9C,2EAA2E;IACpE,eAAe,CAAS;IAE/B,2BAA2B;IACpB,gBAAgB,CAAU;IAEjC,gCAAgC;IACzB,MAAM,CAAS;CAGzB"}