@shieldiot/pulse-lib 1.0.1

package/src/lib/entities/Account.ts

@@ -0,0 +1,45 @@
+import { AccountStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+import { BaseEntity } from '../entities';
+import { AccountTypeCode } from '../enums';
+
+
+
+// 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;
+ 
+ 
+}
+
+

package/src/lib/entities/AccountDTO.d.ts

@@ -0,0 +1,20 @@
+import { BaseEntity } from '../entities';
+import { AccountTypeCode } from '../enums';
+import { AccountStatusCode } from '../enums';
+import { FeatureCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+export declare class AccountDTO extends BaseEntity {
+    name: string;
+    externalId: string;
+    description: string;
+    type: AccountTypeCode;
+    status: AccountStatusCode;
+    groups: string[];
+    features: FeatureCode[];
+    expiredOn: number;
+    tags: string[];
+    labels: StringKeyValue[];
+    settings: AccountSettings;
+}
+//# sourceMappingURL=AccountDTO.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AccountDTO.d.ts","sourceRoot":"","sources":["AccountDTO.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAK9C,qBAAa,UAAW,SAAQ,UAAU;IAG/B,IAAI,EAAE,MAAM,CAAC;IAGb,UAAU,EAAE,MAAM,CAAC;IAGnB,WAAW,EAAE,MAAM,CAAC;IAGpB,IAAI,EAAE,eAAe,CAAC;IAGtB,MAAM,EAAE,iBAAiB,CAAC;IAG1B,MAAM,EAAE,MAAM,EAAE,CAAC;IAGjB,QAAQ,EAAE,WAAW,EAAE,CAAC;IAGxB,SAAS,EAAE,MAAM,CAAC;IAGlB,IAAI,EAAE,MAAM,EAAE,CAAC;IAGf,MAAM,EAAE,cAAc,EAAE,CAAC;IAGzB,QAAQ,EAAE,eAAe,CAAC;CAGpC"}

package/src/lib/entities/AccountDTO.js

@@ -0,0 +1,27 @@
+import { BaseEntity } from '../entities';
+// AccountDTO includes additional data for display
+export class AccountDTO extends BaseEntity {
+    // Account name 
+    name;
+    // The account identity in the external system (e.g. Billing, CRM etc) @json:externalId"` 
+    externalId;
+    // Account description 
+    description;
+    // Account Type: UNDEFINED | DEMO | TRIAL | PARTNER | CUSTOMER 
+    type;
+    // Account status: UNDEFINED | ACTIVE | SUSPENDED 
+    status;
+    // List of associated account groups (for feature toggle) 
+    groups;
+    // List of all features from all the groups 
+    features;
+    // When the account will be expired [Epoch milliseconds Timestamp] (0 means no expiration time) 
+    expiredOn;
+    // Additional user defined tags 
+    tags;
+    // List of custom attributes (key-value pairs) 
+    labels;
+    // Account specific attributes 
+    settings;
+}
+//# sourceMappingURL=AccountDTO.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AccountDTO.js","sourceRoot":"","sources":["AccountDTO.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AASzC,kDAAkD;AAClD,MAAM,OAAO,UAAW,SAAQ,UAAU;IAEtC,gBAAgB;IACT,IAAI,CAAS;IAEpB,0FAA0F;IACnF,UAAU,CAAS;IAE1B,uBAAuB;IAChB,WAAW,CAAS;IAE3B,+DAA+D;IACxD,IAAI,CAAkB;IAE7B,kDAAkD;IAC3C,MAAM,CAAoB;IAEjC,0DAA0D;IACnD,MAAM,CAAW;IAExB,4CAA4C;IACrC,QAAQ,CAAgB;IAE/B,gGAAgG;IACzF,SAAS,CAAS;IAEzB,gCAAgC;IACzB,IAAI,CAAW;IAEtB,+CAA+C;IACxC,MAAM,CAAmB;IAEhC,+BAA+B;IACxB,QAAQ,CAAkB;CAGpC"}

package/src/lib/entities/AccountDTO.ts

@@ -0,0 +1,49 @@
+import { BaseEntity } from '../entities';
+import { AccountTypeCode } from '../enums';
+import { AccountStatusCode } from '../enums';
+import { FeatureCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+
+
+
+// AccountDTO includes additional data for display
+export class AccountDTO 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[];
+ 
+    // List of all features from all the groups 
+    public features: FeatureCode[];
+ 
+    // 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;
+ 
+ 
+}
+
+

package/src/lib/entities/AccountSettings.d.ts

@@ -0,0 +1,11 @@
+import { ComplianceReportSettings } from '../entities';
+import { TeaserPopUpSettings } from '../entities';
+import { HomePageViewCode } from '../enums';
+export declare class AccountSettings {
+    logo: string;
+    defaultHomePageView: HomePageViewCode;
+    complianceReportSettings: ComplianceReportSettings;
+    teaserPopUpSettings: TeaserPopUpSettings;
+    constructor(logo?: string, defaultHomePageView?: HomePageViewCode, complianceReportSettings?: ComplianceReportSettings, teaserPopUpSettings?: TeaserPopUpSettings);
+}
+//# sourceMappingURL=AccountSettings.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSettings.d.ts","sourceRoot":"","sources":["AccountSettings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAK5C,qBAAa,eAAe;IAGjB,IAAI,EAAE,MAAM,CAAC;IAGb,mBAAmB,EAAE,gBAAgB,CAAC;IAGtC,wBAAwB,EAAE,wBAAwB,CAAC;IAGnD,mBAAmB,EAAE,mBAAmB,CAAC;gBAEnC,IAAI,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,gBAAgB,EAAE,wBAAwB,CAAC,EAAE,wBAAwB,EAAE,mBAAmB,CAAC,EAAE,mBAAmB;CAOrK"}

package/src/lib/entities/AccountSettings.js

@@ -0,0 +1,26 @@
+// AccountSettings is a set of account attributes
+export class AccountSettings {
+    // Account logo URL (starts with http) or embedded image (base64) 
+    logo;
+    // Default home page view 
+    defaultHomePageView;
+    // ComplianceReportSettings specific attributes 
+    complianceReportSettings;
+    // Teaser pop up settings attributes 
+    teaserPopUpSettings;
+    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;
+        }
+    }
+}
+//# sourceMappingURL=AccountSettings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSettings.js","sourceRoot":"","sources":["AccountSettings.ts"],"names":[],"mappings":"AAMA,iDAAiD;AACjD,MAAM,OAAO,eAAe;IAExB,kEAAkE;IAC3D,IAAI,CAAS;IAEpB,0BAA0B;IACnB,mBAAmB,CAAmB;IAE7C,gDAAgD;IACzC,wBAAwB,CAA2B;IAE1D,qCAAqC;IAC9B,mBAAmB,CAAsB;IAE/C,YAAY,IAAa,EAAE,mBAAsC,EAAE,wBAAmD,EAAE,mBAAyC;QAC9J,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAAC,CAAC;QAC7C,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAAC,CAAC;QAC1F,IAAI,wBAAwB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;QAAC,CAAC;QACzG,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAAC,CAAC;IAC9F,CAAC;CAEJ"}

package/src/lib/entities/AccountSettings.ts

@@ -0,0 +1,31 @@
+import { ComplianceReportSettings } from '../entities';
+import { TeaserPopUpSettings } from '../entities';
+import { HomePageViewCode } from '../enums';
+
+
+
+// AccountSettings is a set of account attributes
+export class AccountSettings {
+ 
+    // Account logo URL (starts with http) or embedded image (base64) 
+    public logo: string;
+ 
+    // Default home page view 
+    public defaultHomePageView: HomePageViewCode;
+ 
+    // ComplianceReportSettings specific attributes 
+    public complianceReportSettings: ComplianceReportSettings;
+ 
+    // Teaser pop up settings attributes 
+    public teaserPopUpSettings: TeaserPopUpSettings;
+ 
+     constructor(logo?: string, defaultHomePageView?: HomePageViewCode, complianceReportSettings?: ComplianceReportSettings, teaserPopUpSettings?: 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/src/lib/entities/Action.d.ts

@@ -0,0 +1,11 @@
+import { DeviceActionCode } from '../enums';
+import { BaseEntity } from '../entities';
+export declare class Action extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    eventId: string;
+    deviceId: string;
+    action: DeviceActionCode;
+    userId: string;
+}
+//# sourceMappingURL=Action.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Action.d.ts","sourceRoot":"","sources":["Action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,qBAAa,MAAO,SAAQ,UAAU;IAG3B,SAAS,EAAE,MAAM,CAAC;IAGlB,QAAQ,EAAE,MAAM,CAAC;IAGjB,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,EAAE,MAAM,CAAC;IAGjB,MAAM,EAAE,gBAAgB,CAAC;IAGzB,MAAM,EAAE,MAAM,CAAC;CAGzB"}

package/src/lib/entities/Action.js

@@ -0,0 +1,17 @@
+import { BaseEntity } from '../entities';
+// Action entity is a user action applied on an event or device
+export class Action extends BaseEntity {
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // Event Id (in case action was applied on an event) 
+    eventId;
+    // Device Id (in case action was applied on a device) 
+    deviceId;
+    // Action type: UNDEFINED | REDIRECT | SUSPEND | BLOCK_IP ... 
+    action;
+    // User id who applied the action 
+    userId;
+}
+//# sourceMappingURL=Action.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Action.js","sourceRoot":"","sources":["Action.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,+DAA+D;AAC/D,MAAM,OAAO,MAAO,SAAQ,UAAU;IAElC,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,qDAAqD;IAC9C,OAAO,CAAS;IAEvB,sDAAsD;IAC/C,QAAQ,CAAS;IAExB,8DAA8D;IACvD,MAAM,CAAmB;IAEhC,kCAAkC;IAC3B,MAAM,CAAS;CAGzB"}

package/src/lib/entities/Action.ts

@@ -0,0 +1,30 @@
+import { DeviceActionCode } from '../enums';
+import { BaseEntity } from '../entities';
+
+
+
+// Action entity is a user action applied on an event or device
+export class Action extends BaseEntity {
+ 
+    // Account Id 
+    public accountId: string;
+ 
+    // Stream Id 
+    public streamId: string;
+ 
+    // Event Id (in case action was applied on an event) 
+    public eventId: string;
+ 
+    // Device Id (in case action was applied on a device) 
+    public deviceId: string;
+ 
+    // Action type: UNDEFINED | REDIRECT | SUSPEND | BLOCK_IP ... 
+    public action: DeviceActionCode;
+ 
+    // User id who applied the action 
+    public userId: string;
+ 
+ 
+}
+
+

package/src/lib/entities/Alert.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"Alert.d.ts","sourceRoot":"","sources":["Alert.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,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,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAQ3C,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,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,gBAAgB,EAAE,oBAAoB,CAAC;IAGvC,eAAe,EAAE,MAAM,CAAC;IAGxB,gBAAgB,EAAE,OAAO,CAAC;CAGpC"}

package/src/lib/entities/Alert.js

@@ -0,0 +1,54 @@
+import { BaseEntity } from '../entities';
+// 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 {
+    // 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;
+    // 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;
+    // 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=Alert.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Alert.js","sourceRoot":"","sources":["Alert.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAMzC,qBAAqB;AACrB,sMAAsM;AACtM,qNAAqN;AACrN,kNAAkN;AAClN,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,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,qEAAqE;IAC9D,gBAAgB,CAAuB;IAE9C,2EAA2E;IACpE,eAAe,CAAS;IAE/B,2BAA2B;IACpB,gBAAgB,CAAU;CAGpC"}

package/src/lib/entities/Alert.ts

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"AlertWithDevice.d.ts","sourceRoot":"","sources":["AlertWithDevice.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,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,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAKxC,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,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,gBAAgB,EAAE,oBAAoB,CAAC;IAGvC,eAAe,EAAE,MAAM,CAAC;IAGxB,gBAAgB,EAAE,OAAO,CAAC;IAG1B,MAAM,EAAE,MAAM,CAAC;CAGzB"}

package/src/lib/entities/AlertWithDevice.js

@@ -0,0 +1,53 @@
+import { BaseEntity } from '../entities';
+// AlertWithDevice entity is an event with the device information (for display only)
+export class AlertWithDevice 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;
+    // 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;
+    // 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=AlertWithDevice.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AlertWithDevice.js","sourceRoot":"","sources":["AlertWithDevice.ts"],"names":[],"mappings":"AAOA,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,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,qEAAqE;IAC9D,gBAAgB,CAAuB;IAE9C,2EAA2E;IACpE,eAAe,CAAS;IAE/B,2BAA2B;IACpB,gBAAgB,CAAU;IAEjC,gCAAgC;IACzB,MAAM,CAAS;CAGzB"}