@shieldiot/pulse-lib 1.0.1

package/dist/lib/entities/Account.js

@@ -0,0 +1,25 @@
+import { BaseEntity } from '../entities';
+// Account entity in the system represents customer account
+export class Account 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;
+    // 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=Account.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Account.js","sourceRoot":"","sources":["../../../src/lib/entities/Account.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,2DAA2D;AAC3D,MAAM,OAAO,OAAQ,SAAQ,UAAU;IAEnC,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,gGAAgG;IACzF,SAAS,CAAS;IAEzB,gCAAgC;IACzB,IAAI,CAAW;IAEtB,+CAA+C;IACxC,MAAM,CAAmB;IAEhC,+BAA+B;IACxB,QAAQ,CAAkB;CAGpC"}

package/dist/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/dist/lib/entities/AccountDTO.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountDTO.js","sourceRoot":"","sources":["../../../src/lib/entities/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/dist/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/dist/lib/entities/AccountSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountSettings.js","sourceRoot":"","sources":["../../../src/lib/entities/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/dist/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/dist/lib/entities/Action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Action.js","sourceRoot":"","sources":["../../../src/lib/entities/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/dist/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/dist/lib/entities/Alert.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Alert.js","sourceRoot":"","sources":["../../../src/lib/entities/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/dist/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/dist/lib/entities/AlertWithDevice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AlertWithDevice.js","sourceRoot":"","sources":["../../../src/lib/entities/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"}

package/dist/lib/entities/ApiKey.js

@@ -0,0 +1,19 @@
+import { BaseEntity } from '../entities';
+// ApiKey entity is a structure representing the source data fields encapsulated in the API key
+export class ApiKey extends BaseEntity {
+    // API Key name 
+    name;
+    // Default session token expiration TTL (in minutes), 0 means no TTL 
+    ttl;
+    // Access Control List - list of accessible resources with permissions flags (1:Read, 2:Create, 4:Update, 8:Delete, 16:Action) 
+    acl;
+    // Key version (for key rotation) 
+    version;
+    // Flag to indicate if this a system key or user defined key 
+    systemKey;
+    // Flag to indicate if the key is enabled 
+    enabled;
+    // The API Key (this value is auto generated and not stored in the DB) 
+    key;
+}
+//# sourceMappingURL=ApiKey.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKey.js","sourceRoot":"","sources":["../../../src/lib/entities/ApiKey.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,+FAA+F;AAC/F,MAAM,OAAO,MAAO,SAAQ,UAAU;IAElC,gBAAgB;IACT,IAAI,CAAS;IAEpB,qEAAqE;IAC9D,GAAG,CAAS;IAEnB,+HAA+H;IACxH,GAAG,CAAsB;IAEhC,kCAAkC;IAC3B,OAAO,CAAS;IAEvB,6DAA6D;IACtD,SAAS,CAAU;IAE1B,0CAA0C;IACnC,OAAO,CAAU;IAExB,uEAAuE;IAChE,GAAG,CAAS;CAGtB"}

package/dist/lib/entities/AuditLog.js

@@ -0,0 +1,23 @@
+import { BaseEntity } from '../entities';
+// Audit Log - each entry represents a single action done by user
+export class AuditLog extends BaseEntity {
+    // Account Id (empty if it is non-account entity) 
+    accountId;
+    // User Id 
+    userId;
+    // User type 
+    userType;
+    // Action that was performed 
+    action;
+    // Changed item type 
+    itemType;
+    // Changed item Id 
+    itemId;
+    // Item Name 
+    itemName;
+    // Item value before change [Json] 
+    beforeChange;
+    // Item delta after change [Json] 
+    afterChange;
+}
+//# sourceMappingURL=AuditLog.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AuditLog.js","sourceRoot":"","sources":["../../../src/lib/entities/AuditLog.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,iEAAiE;AACjE,MAAM,OAAO,QAAS,SAAQ,UAAU;IAEpC,kDAAkD;IAC3C,SAAS,CAAS;IAEzB,WAAW;IACJ,MAAM,CAAS;IAEtB,aAAa;IACN,QAAQ,CAAe;IAE9B,6BAA6B;IACtB,MAAM,CAAS;IAEtB,qBAAqB;IACd,QAAQ,CAAS;IAExB,mBAAmB;IACZ,MAAM,CAAS;IAEtB,aAAa;IACN,QAAQ,CAAS;IAExB,mCAAmC;IAC5B,YAAY,CAAS;IAE5B,kCAAkC;IAC3B,WAAW,CAAS;CAG9B"}

package/dist/lib/entities/BaseEntity.js

@@ -0,0 +1,21 @@
+// Base entity includes common fields for all entities (persistence objects) in the system
+export class BaseEntity {
+    // Entity Id 
+    id;
+    // When the entity was created [Epoch milliseconds Timestamp] 
+    createdOn;
+    // When the entity was updated [Epoch milliseconds Timestamp] 
+    updatedOn;
+    constructor(id, createdOn, updatedOn) {
+        if (id !== undefined) {
+            this.id = id;
+        }
+        if (createdOn !== undefined) {
+            this.createdOn = createdOn;
+        }
+        if (updatedOn !== undefined) {
+            this.updatedOn = updatedOn;
+        }
+    }
+}
+//# sourceMappingURL=BaseEntity.js.map

package/dist/lib/entities/BaseEntity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseEntity.js","sourceRoot":"","sources":["../../../src/lib/entities/BaseEntity.ts"],"names":[],"mappings":"AAGA,0FAA0F;AAC1F,MAAM,OAAO,UAAU;IAEnB,aAAa;IACN,EAAE,CAAS;IAElB,8DAA8D;IACvD,SAAS,CAAS;IAEzB,8DAA8D;IACvD,SAAS,CAAS;IAExB,YAAY,EAAW,EAAE,SAAkB,EAAE,SAAkB;QAC5D,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QAAC,CAAC;QACvC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAAC,CAAC;QAC5D,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAAC,CAAC;IAChE,CAAC;CAEJ"}

package/dist/lib/entities/BulkDevices.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"BulkDevices.js","sourceRoot":"","sources":["../../../src/lib/entities/BulkDevices.ts"],"names":[],"mappings":"AAIA,kDAAkD;AAClD,MAAM,OAAO,WAAW;IAEpB,mBAAmB;IACZ,MAAM,CAAW;IAEvB,YAAY,MAAiB;QAC1B,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;IACvD,CAAC;CAEJ"}

package/dist/lib/entities/Checkpoint.js

@@ -0,0 +1,45 @@
+import { BaseEntity } from '../entities';
+// 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 {
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // Timestamp marking checkpoint time [Epoch milliseconds Timestamp] 
+    checkpoint;
+    // First packet timestamp [Epoch milliseconds Timestamp] 
+    firstPacketTime;
+    // Last packet timestamp [Epoch milliseconds Timestamp] 
+    lastPacketTime;
+    // Checkpoint label (usually file name) 
+    label;
+    // General purpose description 
+    description;
+    // Total elapsed time (between updated and created time) 
+    elapsed;
+    // Total files parsed in this cycle 
+    totalFiles;
+    // Total packets parsed in this cycle 
+    totalPackets;
+    // Total usage records created 
+    totalUsage;
+    // Total session records created 
+    totalSession;
+    // Total RADIUS records created 
+    totalRadius;
+    // Total number of overlapped packets (their timestamp is earlier than the latest checkpoint) 
+    overlappedPackets;
+    // Total number of packets that failed parsing 
+    failedPackets;
+    // Total number of packets nor related to the tracked devices 
+    irrelevantPackets;
+    // Total number of packets that could not be mapped to device identity 
+    unmappedPackets;
+    // Total number of successfully processed packets 
+    processedPackets;
+    // Checkpoint state: 0 - created, 1 - in progress, 2 - completed 
+    state;
+    // Identity of the worker processed the file 
+    processedBy;
+}
+//# sourceMappingURL=Checkpoint.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Checkpoint.js","sourceRoot":"","sources":["../../../src/lib/entities/Checkpoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,2KAA2K;AAC3K,MAAM,OAAO,UAAW,SAAQ,UAAU;IAEtC,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,oEAAoE;IAC7D,UAAU,CAAS;IAE1B,yDAAyD;IAClD,eAAe,CAAS;IAE/B,wDAAwD;IACjD,cAAc,CAAS;IAE9B,wCAAwC;IACjC,KAAK,CAAS;IAErB,+BAA+B;IACxB,WAAW,CAAS;IAE3B,yDAAyD;IAClD,OAAO,CAAS;IAEvB,oCAAoC;IAC7B,UAAU,CAAS;IAE1B,sCAAsC;IAC/B,YAAY,CAAS;IAE5B,+BAA+B;IACxB,UAAU,CAAS;IAE1B,iCAAiC;IAC1B,YAAY,CAAS;IAE5B,gCAAgC;IACzB,WAAW,CAAS;IAE3B,8FAA8F;IACvF,iBAAiB,CAAS;IAEjC,+CAA+C;IACxC,aAAa,CAAS;IAE7B,8DAA8D;IACvD,iBAAiB,CAAS;IAEjC,uEAAuE;IAChE,eAAe,CAAS;IAE/B,kDAAkD;IAC3C,gBAAgB,CAAS;IAEhC,iEAAiE;IAC1D,KAAK,CAAS;IAErB,6CAA6C;IACtC,WAAW,CAAS;CAG9B"}

package/dist/lib/entities/ComplianceReportSettings.js

@@ -0,0 +1,26 @@
+// ComplianceReportSettings is a set of account's compliance report settings.
+export class ComplianceReportSettings {
+    // Compliance report title 
+    title;
+    // Compliance report subtitle 
+    subTitle;
+    // Compliance report header 
+    header;
+    // Compliance report footer 
+    footer;
+    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;
+        }
+    }
+}
+//# sourceMappingURL=ComplianceReportSettings.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceReportSettings.js","sourceRoot":"","sources":["../../../src/lib/entities/ComplianceReportSettings.ts"],"names":[],"mappings":"AAGA,6EAA6E;AAC7E,MAAM,OAAO,wBAAwB;IAEjC,2BAA2B;IACpB,KAAK,CAAS;IAErB,8BAA8B;IACvB,QAAQ,CAAS;IAExB,4BAA4B;IACrB,MAAM,CAAS;IAEtB,4BAA4B;IACrB,MAAM,CAAS;IAErB,YAAY,KAAc,EAAE,QAAiB,EAAE,MAAe,EAAE,MAAe;QAC5E,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAAC,CAAC;QAChD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAAC,CAAC;QACzD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;QACnD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;IACvD,CAAC;CAEJ"}

package/dist/lib/entities/Condition.js

@@ -0,0 +1,25 @@
+export class Condition {
+    // Field name 
+    field;
+    // Operator symbol: Eq(=), Neq(!), Gt(>), Gte(>=), Lt(<), Lte(<=), In(*), Not In(-), Between(#) 
+    operator;
+    // Operand double values (more than one values applicable for operators: In(*), Not In(-), Range(#) 
+    values;
+    // Operand string values (more than one values applicable for operators: In(*), Not In(-) 
+    strings;
+    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;
+        }
+    }
+}
+//# sourceMappingURL=Condition.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Condition.js","sourceRoot":"","sources":["../../../src/lib/entities/Condition.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,SAAS;IAElB,cAAc;IACP,KAAK,CAAS;IAErB,gGAAgG;IACzF,QAAQ,CAAe;IAE9B,oGAAoG;IAC7F,MAAM,CAAW;IAExB,0FAA0F;IACnF,OAAO,CAAW;IAExB,YAAY,KAAc,EAAE,QAAuB,EAAE,MAAiB,EAAE,OAAkB;QACvF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAAC,CAAC;QAChD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAAC,CAAC;QACzD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;QACnD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAAC,CAAC;IAC1D,CAAC;CAEJ"}

package/dist/lib/entities/ConfigParam.js

@@ -0,0 +1,8 @@
+import { BaseEntity } from '../entities';
+// ConfigParam stores a key-value pair as a system configuration parameter
+// The id is the key of the parameter
+export class ConfigParam extends BaseEntity {
+    // configuration value 
+    value;
+}
+//# sourceMappingURL=ConfigParam.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ConfigParam.js","sourceRoot":"","sources":["../../../src/lib/entities/ConfigParam.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,0EAA0E;AAC1E,qCAAqC;AACrC,MAAM,OAAO,WAAY,SAAQ,UAAU;IAEvC,uBAAuB;IAChB,KAAK,CAAS;CAGxB"}

package/dist/lib/entities/DNSRecord.js

@@ -0,0 +1,25 @@
+import { BaseEntity } from '../entities';
+// 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 {
+    // Indication to the source location of the record 
+    source;
+    // Device Id 
+    deviceId;
+    // Device IP 
+    deviceIp;
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // Start window time [Epoch milliseconds Timestamp] 
+    startTime;
+    // End window time [Epoch milliseconds Timestamp] 
+    endTime;
+    // Fully Qualified Domain Name 
+    fqdn;
+    // List of A records 
+    records;
+}
+//# sourceMappingURL=DNSRecord.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DNSRecord.js","sourceRoot":"","sources":["../../../src/lib/entities/DNSRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAIzC,0DAA0D;AAC1D,oGAAoG;AACpG,mGAAmG;AACnG,MAAM,OAAO,SAAU,SAAQ,UAAU;IAErC,mDAAmD;IAC5C,MAAM,CAAS;IAEtB,aAAa;IACN,QAAQ,CAAS;IAExB,aAAa;IACN,QAAQ,CAAS;IAExB,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,oDAAoD;IAC7C,SAAS,CAAS;IAEzB,kDAAkD;IAC3C,OAAO,CAAS;IAEvB,+BAA+B;IACxB,IAAI,CAAS;IAEpB,qBAAqB;IACd,OAAO,CAAW;CAG5B"}

package/dist/lib/entities/DataIngestion.js

@@ -0,0 +1,66 @@
+// DataIngestion is the ingestion pipeline configuration
+export class DataIngestion {
+    // Input files locations 
+    inputURI;
+    // File format: pcap / pcapng (default) 
+    format;
+    // Where to archive processed files 
+    archiveURI;
+    // Input files extensions (filter by extensions) - ignore if empty 
+    inputFilesExt;
+    // List of IoT devices subnets - ignore if empty 
+    subNets;
+    // List of subnets or IPs to exclude 
+    exclude;
+    // Usage time window for aggregation (in seconds) 
+    usageTimeWindowSec;
+    // Session time window for aggregation (in seconds) 
+    sessionTimeWindowSec;
+    // Cron schedule template in 6 segment format (see: https://en.wikipedia.org/wiki/Cron) - leave empty for immediate processing 
+    schedule;
+    // Default device type: UNDEFINED | OTHER | CONTROLLER | METER | SENSOR ... 
+    defaultDeviceType;
+    // Device creation policy based on the PCP parsing (NONE | IP | SID | EID) 
+    deviceCreationPolicy;
+    // How to identify devices during the PCAP parsing (NONE | IP | SID | EID) 
+    deviceIdentityPolicy;
+    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;
+        }
+    }
+}
+//# sourceMappingURL=DataIngestion.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataIngestion.js","sourceRoot":"","sources":["../../../src/lib/entities/DataIngestion.ts"],"names":[],"mappings":"AAMA,wDAAwD;AACxD,MAAM,OAAO,aAAa;IAEtB,yBAAyB;IAClB,QAAQ,CAAS;IAExB,wCAAwC;IACjC,MAAM,CAAS;IAEtB,oCAAoC;IAC7B,UAAU,CAAS;IAE1B,mEAAmE;IAC5D,aAAa,CAAW;IAE/B,iDAAiD;IAC1C,OAAO,CAAW;IAEzB,qCAAqC;IAC9B,OAAO,CAAW;IAEzB,kDAAkD;IAC3C,kBAAkB,CAAS;IAElC,oDAAoD;IAC7C,oBAAoB,CAAS;IAEpC,+HAA+H;IACxH,QAAQ,CAAS;IAExB,4EAA4E;IACrE,iBAAiB,CAAiB;IAEzC,2EAA2E;IACpE,oBAAoB,CAAqB;IAEhD,2EAA2E;IACpE,oBAAoB,CAAqB;IAE/C,YAAY,QAAiB,EAAE,MAAe,EAAE,UAAmB,EAAE,aAAwB,EAAE,OAAkB,EAAE,OAAkB,EAAE,kBAA2B,EAAE,oBAA6B,EAAE,QAAiB,EAAE,iBAAkC,EAAE,oBAAyC,EAAE,oBAAyC;QAC3U,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAAC,CAAC;QACzD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAAC,CAAC;QACnD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAAC,CAAC;QAC/D,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAAC,CAAC;QACxE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAAC,CAAC;QACtD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAAC,CAAC;QACtD,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAAC,CAAC;QACvF,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAAC,CAAC;QAC7F,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAAC,CAAC;QACzD,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAAC,CAAC;QACpF,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAAC,CAAC;QAC7F,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QAAC,CAAC;IACjG,CAAC;CAEJ"}

package/dist/lib/entities/DataPointOfDeviceReport.js

@@ -0,0 +1,16 @@
+// TimeSeriesOfDeviceReport model represents a time series of DeviceReport
+export class DataPointOfDeviceReport {
+    // Sata point timestamp [Epoch milliseconds Timestamp] 
+    timestamp;
+    // Device report value 
+    value;
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+//# sourceMappingURL=DataPointOfDeviceReport.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataPointOfDeviceReport.js","sourceRoot":"","sources":["../../../src/lib/entities/DataPointOfDeviceReport.ts"],"names":[],"mappings":"AAIA,0EAA0E;AAC1E,MAAM,OAAO,uBAAuB;IAEhC,uDAAuD;IAChD,SAAS,CAAS;IAEzB,uBAAuB;IAChB,KAAK,CAAe;IAE1B,YAAY,SAAkB,EAAE,KAAoB;QACjD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAAC,CAAC;QAC5D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAAC,CAAC;IACpD,CAAC;CAEJ"}

package/dist/lib/entities/Device.js

@@ -0,0 +1,49 @@
+import { BaseEntity } from '../entities';
+// Device entity is an IoT device representation with attributes and state
+export class Device extends BaseEntity {
+    // Account Id 
+    accountId;
+    // Stream Id 
+    streamId;
+    // The device identity in the external system (used for integration) 
+    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;
+}
+//# sourceMappingURL=Device.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Device.js","sourceRoot":"","sources":["../../../src/lib/entities/Device.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAKzC,0EAA0E;AAC1E,MAAM,OAAO,MAAO,SAAQ,UAAU;IAElC,cAAc;IACP,SAAS,CAAS;IAEzB,aAAa;IACN,QAAQ,CAAS;IAExB,qEAAqE;IAC9D,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;CAG1B"}