@shieldiot/pulse-lib 1.0.5 → 1.0.6

package/src/lib/entities/Integration.ts

@@ -1,81 +0,0 @@
-import { StringKeyValue } from '../common';
-import { EventTypeCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { DeviceActionCode } from '../enums';
-import { BaseEntity } from '../entities';
-import { IntegrationTypeCode } from '../enums';
-import { IntegrationTriggerCode } from '../enums';
-import { HttpMethodCode } from '../enums';
-
-
-
-// Integration specifications
-export class Integration extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id (leave empty to apply integration on all streams) 
-    public streamId: string;
- 
-    // Integration type (HTTP | SMTP | EMAIL ...) 
-    public type: IntegrationTypeCode;
- 
-    // Integration trigger (EVENT | ACTION ...) 
-    public trigger: IntegrationTriggerCode;
- 
-    // Integration name 
-    public name: string;
- 
-    // Is integration enabled 
-    public enabled: boolean;
- 
-    // Host name or ip address (applicable for all protocols) 
-    public host: string;
- 
-    // Port number (applicable for all protocols) 
-    public port: number;
- 
-    // User (applicable for all protocols) 
-    public user: string;
- 
-    // Password (applicable for all protocols) 
-    public password: string;
- 
-    // HTTP protocol URL path (applicable for http/https protocols) 
-    public url: string;
- 
-    // HTTP protocol method: GET | POST | PUT | PATCH | DELETE (applicable for http/https protocols) 
-    public method: HttpMethodCode;
- 
-    // HTTP protocol Headers (applicable for http/https protocols) 
-    public headers: StringKeyValue[];
- 
-    // Message content mime type 
-    public mimeType: string;
- 
-    // SMTP/EMAIL protocol List of recipients 
-    public recipients: string[];
- 
-    // SMTP/EMAIL protocol Message subject template 
-    public subject: string;
- 
-    // Message body template 
-    public body: string;
- 
-    // SMTP/EMAIL sender (will be: system@pulseiot.io if it is empty) 
-    public from: string;
- 
-    // Activate integration only if the event object type code is in the list (empty list means no filter) 
-    public eventTypes: EventTypeCode[];
- 
-    // Activate integration only if the event severity matching this value 
-    public eventSeverity: SeverityTypeCode;
- 
-    // Activate integration only for specific action (applicable for Trigger = ACTION) 
-    public preventiveAction: DeviceActionCode;
- 
- 
-}
-
-

package/src/lib/entities/Member.ts

@@ -1,22 +0,0 @@
-import { MemberRoleCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// Member represents a user in the account and the role he has in this account
-// User may have several memberships for several accounts, each with a different role
-export class Member extends BaseEntity {
- 
-    // User Id 
-    public userId: string;
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Member role in the account 
-    public role: MemberRoleCode;
- 
- 
-}
-
-

package/src/lib/entities/Radius.ts

@@ -1,45 +0,0 @@
-import { StringKeyValue } from '../common';
-import { BaseEntity } from '../entities';
-
-
-
-// Radius entity is an IP allocation to device IMSI entry
-export class Radius extends BaseEntity {
- 
-    // Indication to the source location of the record 
-    public source: string;
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // When the IP was assigned to the subscriber [Epoch milliseconds Timestamp] 
-    public assignedOn: 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;
- 
-    // Country name 
-    public country: string;
- 
-    // Mobile network operator name 
-    public operator: string;
- 
-    // Custom attributes (key-value pairs) 
-    public attributes: StringKeyValue[];
- 
- 
-}
-
-

package/src/lib/entities/Report.ts

@@ -1,37 +0,0 @@
-import { BaseEntity } from '../entities';
-import { ReportTypeCode } from '../enums';
-import { TimeFrame } from '../common';
-
-
-
-// Report entity represents a system generated and scheduled report data
-export class Report extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // User who owns the report 
-    public userId: string;
- 
-    // Report name 
-    public name: string;
- 
-    // Report scheduler in Crontab format (6 space-separated fields: sec, min, hour, day, month, dayOfWeek) see syntax (https://en.wikipedia.org/wiki/Cron) Empty string means no scheduling 
-    public cron: string;
- 
-    // Email recipients list 
-    public recipients: string[];
- 
-    // Email subject 
-    public subject: string;
- 
-    // Report type (COMPLIANCE | DEVICES | EVENTS ...) 
-    public reportType: ReportTypeCode;
- 
-    // Absolute or relative time (epoch time milliseconds) to define start time and end time 
-    public timeFrame: TimeFrame;
- 
- 
-}
-
-

package/src/lib/entities/Rule.ts

@@ -1,65 +0,0 @@
-import { SeverityTypeCode } from '../enums';
-import { BaseEntity } from '../entities';
-import { RuleTypeCode } from '../enums';
-import { DataSourceCode } from '../enums';
-import { Condition } from '../entities';
-import { DeviceTypeCode } from '../enums';
-import { EventTypeCode } from '../enums';
-
-
-
-// Deterministic Rule definition
-export class Rule extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Rule name 
-    public name: string;
- 
-    // Rule type 
-    public type: RuleTypeCode;
- 
-    // Rule description 
-    public description: string;
- 
-    // Flag to indicate if this is a system rule (read-only) or user-defined rule 
-    public isSystemRule: boolean;
- 
-    // Flag to indicate if this rule is active (true) or suspended (false), only active rules are evaluated 
-    public isActiveRule: boolean;
- 
-    // Rule context - what is the data source to evaluate the rule on 
-    public context: DataSourceCode;
- 
-    // List of AND conditions, all of them must be true for the rule to trigger event 
-    public matchAll: Condition[];
- 
-    // List of OR conditions, at least one of them must be true for the rule to trigger event} 
-    public matchAny: Condition[];
- 
-    // Exclude devices with ID included in this list 
-    public excludeIDs: string[];
- 
-    // Exclude devices with type included in this list 
-    public excludeTags: string[];
- 
-    // Exclude devices with this type 
-    public excludeTypes: DeviceTypeCode[];
- 
-    // The time duration (in seconds) for consecutive aggregations 
-    public timeWindowSec: number;
- 
-    // Set the event type on events generated by this rule 
-    public setEventType: EventTypeCode;
- 
-    // Set the event severity on events generated by this rule 
-    public setEventSeverity: SeverityTypeCode;
- 
- 
-}
-
-

package/src/lib/entities/RuleTemplate.ts

@@ -1,38 +0,0 @@
-import { DataSourceCode } from '../enums';
-import { EventTypeCode } from '../enums';
-import { SeverityTypeCode } from '../enums';
-import { BaseEntity } from '../entities';
-
-
-
-// RuleTemplate entity is used to define rules quickly based on pre-defined templates
-export class RuleTemplate extends BaseEntity {
- 
-    // Rule template name 
-    public name: string;
- 
-    // Rule template description 
-    public description: string;
- 
-    // Rule context - what is the data source to evaluate the rule on 
-    public context: DataSourceCode;
- 
-    // List of AND conditions, all of them must be true for the rule to trigger event 
-    public matchAll: string[];
- 
-    // List of OR conditions, at least one of them must be true for the rule to trigger event 
-    public matchAny: string[];
- 
-    // The time duration (in seconds) for consecutive aggregations 
-    public timeWindowSec: number;
- 
-    // Set the event type on events generated by this rule 
-    public setEventType: EventTypeCode;
- 
-    // Set the event severity on events generated by this rule 
-    public setEventSeverity: SeverityTypeCode;
- 
- 
-}
-
-

package/src/lib/entities/SIM.ts

@@ -1,32 +0,0 @@
-
-
-
-// SIM entity represents a physical SIM (Subscriber Identity Module) card used in an IoT device to access the internet via a cellular provider
-export class SIM {
- 
-    // Unique SIM Identity (ICCID or IMSI or MSISDN or IP in this order) 
-    public id: string;
- 
-    // The IP allocation of the SIM 
-    public ip: string;
- 
-    // The unique serial number, integrated circuit card identification 
-    public iccid: string;
- 
-    // The international mobile subscriber identity number 
-    public imsi: string;
- 
-    // Mobile Subscriber ISDN Number (the actual phone number with the country prefix) 
-    public msisdn: string;
- 
-     constructor(id?: string, iP?: string, iCCID?: string, iMSI?: string, mSISDN?: string) { 
-        if (id !== undefined) { this.id = id; }
-        if (iP !== undefined) { this.ip = iP; }
-        if (iCCID !== undefined) { this.iccid = iCCID; }
-        if (iMSI !== undefined) { this.imsi = iMSI; }
-        if (mSISDN !== undefined) { this.msisdn = mSISDN; }
-    }
-
-}
-
-

package/src/lib/entities/ServiceStatus.ts

@@ -1,26 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// ServiceStatus represents applicative status of a pulse service with a set of metrics
-export class ServiceStatus extends BaseEntity {
- 
-    // Service name 
-    public serviceName: string;
- 
-    // Host (machine) name 
-    public hostName: string;
- 
-    // Start time of the service [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // Account Id (if applicable) 
-    public accountId: string;
- 
-    // Map[ of application metrics 
-    public metrics: any;
- 
- 
-}
-
-

package/src/lib/entities/SessionRecord.ts

@@ -1,71 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// SessionRecord represents network statistics for a session
-// The unique Id of session record is based on the template: [window_start_time]-[device_id]-[session_id]
-// 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 SessionRecord extends BaseEntity {
- 
-    // Indication to the source location of the record 
-    public source: string;
- 
-    // Session Id is a unique identifier within the time window 
-    public sessionId: string;
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Device SIM card ID (to support multiple SIMs) 
-    public simId: string;
- 
-    // Start window time [Epoch milliseconds Timestamp] 
-    public startTime: number;
- 
-    // End window time [Epoch milliseconds Timestamp] 
-    public endTime: number;
- 
-    // Device (source) IP (the IP that was allocated to this device in the time this record was created) 
-    public deviceIp: string;
- 
-    // Device (source) port 
-    public devicePort: number;
- 
-    // Destination (remote) IP 
-    public dstIP: string;
- 
-    // Destination (remote) Port 
-    public dstPort: number;
- 
-    // Destination (remote) DNS name FQDN 
-    public dstDns: string;
- 
-    // Protocol 
-    public protocol: string;
- 
-    // Number of incoming packets (to the device) 
-    public packetsIn: number;
- 
-    // Number of outgoing packets (from the device) 
-    public packetsOut: number;
- 
-    // Total number of incoming bytes (to the device) 
-    public bytesIn: number;
- 
-    // Total number of outgoing bytes (from the device) 
-    public bytesOut: number;
- 
-    // List of labels 
-    public labels: string[];
- 
- 
-}
-
-

package/src/lib/entities/Shieldex.ts

@@ -1,23 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// Shieldex is a security score per account level calculated periodically
-export class Shieldex extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Total number of events per account per stream 
-    public eventCount: number;
- 
-    // Shield index score (1-100) 
-    public score: number;
- 
- 
-}
-
-

package/src/lib/entities/Stream.ts

@@ -1,31 +0,0 @@
-import { StringKeyValue } from '../common';
-import { StreamConfig } from '../entities';
-import { BaseEntity } from '../entities';
-
-
-
-// Stream represents data stream configuration for group of identical IoT devices service the same purpose and sharing the same attributes (e.g. water meter, point-of-sale, ATM IP camera etc)
-export class Stream extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream name 
-    public name: string;
- 
-    // Stream description 
-    public description: string;
- 
-    // Flag to indicate if stream is enabled (to be processed) 
-    public enabled: boolean;
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // Stream configuration 
-    public config: StreamConfig;
- 
- 
-}
-
-

package/src/lib/entities/StreamAnalyticsConfig.ts

@@ -1,30 +0,0 @@
-import { DeviceConfig } from '../common';
-import { BaseEntity } from '../entities';
-import { Thresholds } from '../common';
-import { ShieldexConfig } from '../common';
-import { EventSeverityConfig } from '../common';
-
-
-
-// Internal structure used by the AI to fine-tune the analytics thresholds
-export class StreamAnalyticsConfig extends BaseEntity {
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Set of stream configuration thresholds 
-    public thresholds: Thresholds;
- 
-    // Set of stream shieldex configuration 
-    public shieldexConfig: ShieldexConfig;
- 
-    // Set of event severity configuration 
-    public eventSeverityConfig: EventSeverityConfig;
- 
-    // Set of device related configurations 
-    public deviceConfig: DeviceConfig;
- 
- 
-}
-
-

package/src/lib/entities/StreamConfig.ts

@@ -1,52 +0,0 @@
-import { DeviceConfig } from '../common';
-import { DataIngestion } from '../entities';
-import { SessionTransform } from '../common';
-import { UsageTransform } from '../common';
-import { Thresholds } from '../common';
-import { ShieldexConfig } from '../common';
-import { EventSeverityConfig } from '../common';
-import { DeviceActionCode } from '../enums';
-
-
-
-// StreamConfig is a stream configuration description
-export class StreamConfig {
- 
-    // Stream data ingestion pipeline 
-    public ingest: DataIngestion;
- 
-    // Session data transform parameters (normalize values) 
-    public sessionTransform: SessionTransform;
- 
-    // Usage data transform parameters (normalize values) 
-    public usageTransform: UsageTransform;
- 
-    // Set of stream configuration thresholds 
-    public thresholds: Thresholds;
- 
-    // Set of stream shieldex configuration 
-    public shieldexConfig: ShieldexConfig;
- 
-    // Set of event severity configuration 
-    public eventSeverityConfig: EventSeverityConfig;
- 
-    // Set of available preventive actions to apply 
-    public preventiveActions: DeviceActionCode[];
- 
-    // Set of device related configurations 
-    public deviceConfig: DeviceConfig;
- 
-     constructor(ingest?: DataIngestion, sessionTransform?: SessionTransform, usageTransform?: UsageTransform, thresholds?: Thresholds, shieldexConfig?: ShieldexConfig, eventSeverityConfig?: EventSeverityConfig, preventiveActions?: DeviceActionCode[], deviceConfig?: DeviceConfig) { 
-        if (ingest !== undefined) { this.ingest = ingest; }
-        if (sessionTransform !== undefined) { this.sessionTransform = sessionTransform; }
-        if (usageTransform !== undefined) { this.usageTransform = usageTransform; }
-        if (thresholds !== undefined) { this.thresholds = thresholds; }
-        if (shieldexConfig !== undefined) { this.shieldexConfig = shieldexConfig; }
-        if (eventSeverityConfig !== undefined) { this.eventSeverityConfig = eventSeverityConfig; }
-        if (preventiveActions !== undefined) { this.preventiveActions = preventiveActions; }
-        if (deviceConfig !== undefined) { this.deviceConfig = deviceConfig; }
-    }
-
-}
-
-

package/src/lib/entities/TeaserPopUpSettings.ts

@@ -1,24 +0,0 @@
-
-
-
-// TeaserPopUpSettings is a set of account's teaser pop up settings.
-export class TeaserPopUpSettings {
- 
-    // Teaser Pop Up header 
-    public header: string;
- 
-    // Teaser Pop Up content 
-    public content: string;
- 
-    // Teaser Pop Up notification content 
-    public notificationContent: string;
- 
-     constructor(header?: string, content?: string, notificationContent?: string) { 
-        if (header !== undefined) { this.header = header; }
-        if (content !== undefined) { this.content = content; }
-        if (notificationContent !== undefined) { this.notificationContent = notificationContent; }
-    }
-
-}
-
-

package/src/lib/entities/TimeSeriesOfDeviceReport.ts

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