@shieldiot/pulse-lib 1.0.5 → 1.0.6

package/src/lib/entities/UsageRecord.ts

@@ -1,101 +0,0 @@
-import { BaseEntity } from '../entities';
-
-
-
-// UsageRecord represents network statistics
-// The unique Id of usage record is based on the template: [window_start_time]-[stream_id]-[device_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 UsageRecord extends BaseEntity {
- 
-    // Indication to the source location of the record 
-    public source: string;
- 
-    // Account Id 
-    public accountId: string;
- 
-    // Stream Id 
-    public streamId: string;
- 
-    // Device Id 
-    public deviceId: string;
- 
-    // Device IP (temporary IP that was allocated to this device in the time this record was created) 
-    public deviceIp: 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;
- 
-    // List of source ports 
-    public srcPortsList: number[];
- 
-    // Number of source ports 
-    public srcPortsCount: number;
- 
-    // List of destination ports 
-    public dstPortsList: number[];
- 
-    // Number of destination ports 
-    public dstPortsCount: number;
- 
-    // List of outbound endpoints 
-    public endpointsList: string[];
- 
-    // Number of outbound endpoints (IPs) 
-    public endpointsCount: number;
- 
-    // List of outbound endpoints that sent data to the device 
-    public srcEndpoints: string[];
- 
-    // Number of outbound endpoints that sent data to the device 
-    public srcEndpointsCount: number;
- 
-    // List of outbound endpoints that received data from the device 
-    public dstEndpoints: string[];
- 
-    // Number of outbound endpoints that received data from the device 
-    public dstEndpointsCount: number;
- 
-    // 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;
- 
-    // Number of outgoing Ack flags (applicable only for TCP based protocols) 
-    public srcAckFlags: number;
- 
-    // Number of incoming Ack flags (applicable only for TCP based protocols) 
-    public dstAckFlags: number;
- 
-    // Number of outgoing Syn flags (applicable only for TCP based protocols) 
-    public srcSynFlags: number;
- 
-    // Number of incoming Syn flags (applicable only for TCP based protocols) 
-    public dstSynFlags: number;
- 
-    // Number of outgoing Rst flags (applicable only for TCP based protocols) 
-    public srcRstFlags: number;
- 
-    // Number of incoming Rst flags (applicable only for TCP based protocols) 
-    public dstRstFlags: number;
- 
-    // List of labels 
-    public labels: string[];
- 
- 
-}
-
-

package/src/lib/entities/User.ts

@@ -1,45 +0,0 @@
-import { UserTypeCode } from '../enums';
-import { UserStatusCode } from '../enums';
-import { StringKeyValue } from '../common';
-import { BaseEntity } from '../entities';
-
-
-
-// User represents a human / system operator that has access to the system, and can perform operations
-// User authentication is done by an external identity provider
-export class User extends BaseEntity {
- 
-    // User name 
-    public name: string;
- 
-    // The user identity in the external system (e.g. Billing, CRM etc) @json:externalId"` 
-    public externalId: string;
- 
-    // User email 
-    public email: string;
- 
-    // User mobile phone number (for notification and validation) 
-    public mobile: string;
- 
-    // User type: UNDEFINED | SYSADMIN | SUPPORT | USER 
-    public type: UserTypeCode;
- 
-    // User status: UNDEFINED | PENDING | ACTIVE | BLOCKED | SUSPENDED 
-    public status: UserStatusCode;
- 
-    // Default account Id 
-    public defaultAccount: string;
- 
-    // When the user signed in for the last time [Epoch milliseconds Timestamp] 
-    public lastSignIn: number;
- 
-    // List of custom attributes (key-value pairs) 
-    public labels: StringKeyValue[];
- 
-    // List of groups that the user belongs to and inherits accounts access from 
-    public groups: string;
- 
- 
-}
-
-

package/src/lib/entities/UserMembership.ts

@@ -1,38 +0,0 @@
-import { UserTypeCode } from '../enums';
-import { UserStatusCode } from '../enums';
-import { AccountRole } from '../common';
-import { BaseEntity } from '../entities';
-
-
-
-// UserMembership model include user data with a specific account membership
-export class UserMembership extends BaseEntity {
- 
-    // User name 
-    public name: string;
- 
-    // User email 
-    public email: string;
- 
-    // User mobile phone number (for notification and validation) 
-    public mobile: string;
- 
-    // User type: UNDEFINED | SYSADMIN | SUPPORT | USER 
-    public type: UserTypeCode;
- 
-    // User status: UNDEFINED | PENDING | ACTIVE | BLOCKED | SUSPENDED 
-    public status: UserStatusCode;
- 
-    // Default account Id 
-    public defaultAccount: string;
- 
-    // When the user signed in for the last time [Epoch milliseconds Timestamp] 
-    public lastSignIn: number;
- 
-    // User role in the account 
-    public accountRole: AccountRole;
- 
- 
-}
-
-

package/src/lib/entities/UserMemberships.ts

@@ -1,38 +0,0 @@
-import { UserTypeCode } from '../enums';
-import { UserStatusCode } from '../enums';
-import { AccountRole } from '../common';
-import { BaseEntity } from '../entities';
-
-
-
-// UserMemberships model include user data and all its accounts memberships
-export class UserMemberships extends BaseEntity {
- 
-    // User name 
-    public name: string;
- 
-    // User email 
-    public email: string;
- 
-    // User mobile phone number (for notification and validation) 
-    public mobile: string;
- 
-    // User type: UNDEFINED | SYSADMIN | SUPPORT | USER 
-    public type: UserTypeCode;
- 
-    // User status: UNDEFINED | PENDING | ACTIVE | BLOCKED | SUSPENDED 
-    public status: UserStatusCode;
- 
-    // Default account Id 
-    public defaultAccount: string;
- 
-    // When the user signed in for the last time [Epoch milliseconds Timestamp] 
-    public lastSignIn: number;
- 
-    // List of user roles in all accounts 
-    public accountRoles: AccountRole[];
- 
- 
-}
-
-

package/src/lib/entities/index.ts

@@ -1,51 +0,0 @@
-export * from './Account';
-export * from './AccountDTO';
-export * from './AccountSettings';
-export * from './Action';
-export * from './Alert';
-export * from './AlertWithDevice';
-export * from './ApiKey';
-export * from './AuditLog';
-export * from './BaseEntity';
-export * from './BulkDevices';
-export * from './Checkpoint';
-export * from './ComplianceReportSettings';
-export * from './Condition';
-export * from './ConfigParam';
-export * from './DNSRecord';
-export * from './DataIngestion';
-export * from './DataPointOfDeviceReport';
-export * from './Device';
-export * from './DeviceReport';
-export * from './DeviceWithEvents';
-export * from './Distribution';
-export * from './Event';
-export * from './EventOccurrence';
-export * from './EventWithDevice';
-export * from './Feature';
-export * from './FeaturesGroup';
-export * from './Group';
-export * from './Image';
-export * from './Insight';
-export * from './InsightQuery';
-export * from './InsightSpec';
-export * from './IntDistribution';
-export * from './Integration';
-export * from './Member';
-export * from './Radius';
-export * from './Report';
-export * from './Rule';
-export * from './RuleTemplate';
-export * from './SIM';
-export * from './ServiceStatus';
-export * from './SessionRecord';
-export * from './Shieldex';
-export * from './Stream';
-export * from './StreamAnalyticsConfig';
-export * from './StreamConfig';
-export * from './TeaserPopUpSettings';
-export * from './TimeSeriesOfDeviceReport';
-export * from './UsageRecord';
-export * from './User';
-export * from './UserMembership';
-export * from './UserMemberships';

package/src/lib/enums/AccountStatusCode.ts

@@ -1,35 +0,0 @@
-
-// Account status code
-export enum AccountStatusCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Active account [1] 
-    ACTIVE = 1,
- 
-    // Suspended (non-active) account [2] 
-    SUSPENDED = 2,
- 
-    // Deleted account [3] 
-    DELETED = 3,
- 
-}
-
-// Return list of AccountStatusCode values and their display names
-export function GetAccountStatusCodes() : Map<AccountStatusCode, string> {
-
-    let result = new Map<AccountStatusCode, string>();
-
-    
-    result.set(AccountStatusCode.UNDEFINED, 'Undefined');
-    
-    result.set(AccountStatusCode.ACTIVE, 'Active');
-    
-    result.set(AccountStatusCode.SUSPENDED, 'Suspended');
-    
-    result.set(AccountStatusCode.DELETED, 'Deleted');
-    
-
-    return result;
-}

package/src/lib/enums/AccountTypeCode.ts

@@ -1,40 +0,0 @@
-
-// Account type code
-export enum AccountTypeCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Demo account for internal use [1] 
-    DEMO = 1,
- 
-    // Trial account for pilots [2] 
-    TRIAL = 2,
- 
-    // Active account for partner [3] 
-    PARTNER = 3,
- 
-    // Active account for paying customers [4] 
-    CUSTOMER = 4,
- 
-}
-
-// Return list of AccountTypeCode values and their display names
-export function GetAccountTypeCodes() : Map<AccountTypeCode, string> {
-
-    let result = new Map<AccountTypeCode, string>();
-
-    
-    result.set(AccountTypeCode.UNDEFINED, 'Undefined');
-    
-    result.set(AccountTypeCode.DEMO, 'Demo');
-    
-    result.set(AccountTypeCode.TRIAL, 'Trial');
-    
-    result.set(AccountTypeCode.PARTNER, 'Partner');
-    
-    result.set(AccountTypeCode.CUSTOMER, 'Customer');
-    
-
-    return result;
-}

package/src/lib/enums/DataSourceCode.ts

@@ -1,35 +0,0 @@
-
-// DataSourceCode represents the sources (indices) of data to apply rules or insights
-export enum DataSourceCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Data source based on Events [1] 
-    EVENT = 1,
- 
-    // Data source based on usage records [2] 
-    USAGE = 2,
- 
-    // Data source based on Session records [3] 
-    SESSION = 3,
- 
-}
-
-// Return list of DataSourceCode values and their display names
-export function GetDataSourceCodes() : Map<DataSourceCode, string> {
-
-    let result = new Map<DataSourceCode, string>();
-
-    
-    result.set(DataSourceCode.UNDEFINED, 'Undefined');
-    
-    result.set(DataSourceCode.EVENT, 'Event');
-    
-    result.set(DataSourceCode.USAGE, 'Usage');
-    
-    result.set(DataSourceCode.SESSION, 'Session');
-    
-
-    return result;
-}

package/src/lib/enums/DeviceActionCode.ts

@@ -1,40 +0,0 @@
-
-// Device action code
-export enum DeviceActionCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Redirect all traffic to an alternative endpoint [1] 
-    REDIRECT = 1,
- 
-    // Suspend device (make it inactive) [2] 
-    SUSPEND = 2,
- 
-    // Throttle traffic from/to the device [3] 
-    THROTTLE = 3,
- 
-    // Block specific external IP [4] 
-    BLOCK_IP = 4,
- 
-}
-
-// Return list of DeviceActionCode values and their display names
-export function GetDeviceActionCodes() : Map<DeviceActionCode, string> {
-
-    let result = new Map<DeviceActionCode, string>();
-
-    
-    result.set(DeviceActionCode.UNDEFINED, 'Undefined');
-    
-    result.set(DeviceActionCode.REDIRECT, 'Redirect');
-    
-    result.set(DeviceActionCode.SUSPEND, 'Suspend');
-    
-    result.set(DeviceActionCode.THROTTLE, 'Throttle');
-    
-    result.set(DeviceActionCode.BLOCK_IP, 'Block Ip');
-    
-
-    return result;
-}

package/src/lib/enums/DeviceCreationCode.ts

@@ -1,40 +0,0 @@
-
-// Device creation policy code
-export enum DeviceCreationCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Do not create device [1] 
-    NONE = 1,
- 
-    // Create Device based on static IP [2] 
-    IP = 2,
- 
-    // Create Device based on Subscriber Id - IMSI [3] 
-    SID = 3,
- 
-    // Create Device based on Equipment Id - IMEI [4] 
-    EID = 4,
- 
-}
-
-// Return list of DeviceCreationCode values and their display names
-export function GetDeviceCreationCodes() : Map<DeviceCreationCode, string> {
-
-    let result = new Map<DeviceCreationCode, string>();
-
-    
-    result.set(DeviceCreationCode.UNDEFINED, 'Undefined');
-    
-    result.set(DeviceCreationCode.NONE, 'None');
-    
-    result.set(DeviceCreationCode.IP, 'Ip');
-    
-    result.set(DeviceCreationCode.SID, 'Sid');
-    
-    result.set(DeviceCreationCode.EID, 'Eid');
-    
-
-    return result;
-}

package/src/lib/enums/DeviceIdentityCode.ts

@@ -1,55 +0,0 @@
-
-// Set the device unique identity policy
-export enum DeviceIdentityCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Device Identity is provided by the system [1] 
-    AUTO = 1,
- 
-    // Device Identity is based on static IP: ip@stream_id [2] 
-    IP = 2,
- 
-    // Device Identity is based on Subscriber Id: imsi@stream_id [3] 
-    IMSI = 3,
- 
-    // Device Identity is based on SIM ICCID: iccid@stream_id [4] 
-    ICCID = 4,
- 
-    // Device Identity is based on MSISDN: msisdn@stream_id [5] 
-    MSISDN = 5,
- 
-    // Device Identity is based on Equipment Id: imei@stream_id [6] 
-    IMEI = 6,
- 
-    // Device Identity is based on MAC address: mac@stream_id [7] 
-    MAC = 7,
- 
-}
-
-// Return list of DeviceIdentityCode values and their display names
-export function GetDeviceIdentityCodes() : Map<DeviceIdentityCode, string> {
-
-    let result = new Map<DeviceIdentityCode, string>();
-
-    
-    result.set(DeviceIdentityCode.UNDEFINED, 'Undefined');
-    
-    result.set(DeviceIdentityCode.AUTO, 'Auto');
-    
-    result.set(DeviceIdentityCode.IP, 'Ip');
-    
-    result.set(DeviceIdentityCode.IMSI, 'Imsi');
-    
-    result.set(DeviceIdentityCode.ICCID, 'Iccid');
-    
-    result.set(DeviceIdentityCode.MSISDN, 'Msisdn');
-    
-    result.set(DeviceIdentityCode.IMEI, 'Imei');
-    
-    result.set(DeviceIdentityCode.MAC, 'Mac');
-    
-
-    return result;
-}

package/src/lib/enums/DeviceStatusCode.ts

@@ -1,40 +0,0 @@
-
-// Device status code
-export enum DeviceStatusCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Device is registered and pending verification [1] 
-    PENDING = 1,
- 
-    // Active device in the system [2] 
-    ACTIVE = 2,
- 
-    // Inactive device [3] 
-    INACTIVE = 3,
- 
-    // Blocked device [4] 
-    BLOCKED = 4,
- 
-}
-
-// Return list of DeviceStatusCode values and their display names
-export function GetDeviceStatusCodes() : Map<DeviceStatusCode, string> {
-
-    let result = new Map<DeviceStatusCode, string>();
-
-    
-    result.set(DeviceStatusCode.UNDEFINED, 'Undefined');
-    
-    result.set(DeviceStatusCode.PENDING, 'Pending');
-    
-    result.set(DeviceStatusCode.ACTIVE, 'Active');
-    
-    result.set(DeviceStatusCode.INACTIVE, 'Inactive');
-    
-    result.set(DeviceStatusCode.BLOCKED, 'Blocked');
-    
-
-    return result;
-}

package/src/lib/enums/DeviceTypeCode.ts

@@ -1,90 +0,0 @@
-
-// Device type code
-export enum DeviceTypeCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Other (Unknown Device) [1] 
-    OTHER = 1,
- 
-    // Industrial Controller [2] 
-    CONTROLLER = 2,
- 
-    // General smart meter [3] 
-    METER = 3,
- 
-    // General sensor [4] 
-    SENSOR = 4,
- 
-    // General camera [5] 
-    CAMERA = 5,
- 
-    // Point of sale [6] 
-    POS = 6,
- 
-    // Pump [7] 
-    PUMP = 7,
- 
-    // EV charging station [8] 
-    CHARGING_STATION = 8,
- 
-    // Smart lightning [9] 
-    LIGHTNING = 9,
- 
-    // Temperature sensor [10] 
-    TEMPERATURE_SENSOR = 10,
- 
-    // Air Quality sensor [11] 
-    AIR_QUALITY_SENSOR = 11,
- 
-    // Valve [12] 
-    VALVE = 12,
- 
-    // Gateway [13] 
-    GATEWAY = 13,
- 
-    // ATM [14] 
-    ATM = 14,
- 
-}
-
-// Return list of DeviceTypeCode values and their display names
-export function GetDeviceTypeCodes() : Map<DeviceTypeCode, string> {
-
-    let result = new Map<DeviceTypeCode, string>();
-
-    
-    result.set(DeviceTypeCode.UNDEFINED, 'Undefined');
-    
-    result.set(DeviceTypeCode.OTHER, 'Other');
-    
-    result.set(DeviceTypeCode.CONTROLLER, 'Controller');
-    
-    result.set(DeviceTypeCode.METER, 'Meter');
-    
-    result.set(DeviceTypeCode.SENSOR, 'Sensor');
-    
-    result.set(DeviceTypeCode.CAMERA, 'Camera');
-    
-    result.set(DeviceTypeCode.POS, 'Pos');
-    
-    result.set(DeviceTypeCode.PUMP, 'Pump');
-    
-    result.set(DeviceTypeCode.CHARGING_STATION, 'Charging Station');
-    
-    result.set(DeviceTypeCode.LIGHTNING, 'Lightning');
-    
-    result.set(DeviceTypeCode.TEMPERATURE_SENSOR, 'Temperature Sensor');
-    
-    result.set(DeviceTypeCode.AIR_QUALITY_SENSOR, 'Air Quality Sensor');
-    
-    result.set(DeviceTypeCode.VALVE, 'Valve');
-    
-    result.set(DeviceTypeCode.GATEWAY, 'Gateway');
-    
-    result.set(DeviceTypeCode.ATM, 'Atm');
-    
-
-    return result;
-}

package/src/lib/enums/DirectionContextCode.ts

@@ -1,40 +0,0 @@
-
-// Direction context code
-export enum DirectionContextCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Event list context [1] 
-    EVENT_LIST = 1,
- 
-    // Device list context  [2] 
-    DEVICE_LIST = 2,
- 
-    // Event details context [3] 
-    EVENT_DETAILS = 3,
- 
-    // Device details context [4] 
-    DEVICE_DETAILS = 4,
- 
-}
-
-// Return list of DirectionContextCode values and their display names
-export function GetDirectionContextCodes() : Map<DirectionContextCode, string> {
-
-    let result = new Map<DirectionContextCode, string>();
-
-    
-    result.set(DirectionContextCode.UNDEFINED, 'Undefined');
-    
-    result.set(DirectionContextCode.EVENT_LIST, 'Event List');
-    
-    result.set(DirectionContextCode.DEVICE_LIST, 'Device List');
-    
-    result.set(DirectionContextCode.EVENT_DETAILS, 'Event Details');
-    
-    result.set(DirectionContextCode.DEVICE_DETAILS, 'Device Details');
-    
-
-    return result;
-}