@shieldiot/pulse-lib 1.0.10 → 1.0.11

package/dist/cjs/utils/EntitiesResponse.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitiesResponse = void 0;
+const BaseRestResponse_1 = require("./BaseRestResponse");
+// EntitiesResponse message is returned for any action returning multiple entities
+class EntitiesResponse extends BaseRestResponse_1.BaseRestResponse {
+    constructor() {
+        super(...arguments);
+        // Current page (Bulk) number
+        this.page = 0;
+        // Size of page (items in bulk)
+        this.size = 0;
+        // Total number of pages
+        this.pages = 0;
+        // Total number of items in the query
+        this.total = 0;
+        // List of entities
+        this.list = [];
+    }
+}
+exports.EntitiesResponse = EntitiesResponse;

package/dist/cjs/utils/EntityResponse.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityResponse = void 0;
+const BaseRestResponse_1 = require("./BaseRestResponse");
+// EntitiesResponse message is returned for any action returning multiple entities
+class EntityResponse extends BaseRestResponse_1.BaseRestResponse {
+    constructor() {
+        super(...arguments);
+        // Current page (Bulk) number
+        this.page = 0;
+        // Size of page (items in bulk)
+        this.size = 0;
+        // Total number of pages
+        this.pages = 0;
+        // Total number of items in the query
+        this.total = 0;
+    }
+}
+exports.EntityResponse = EntityResponse;

package/dist/cjs/utils/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActionResponse"), exports);
+__exportStar(require("./BaseRestResponse"), exports);
+__exportStar(require("./EntityResponse"), exports);
+__exportStar(require("./EntitiesResponse"), exports);
+__exportStar(require("./rest-util"), exports);

package/dist/cjs/utils/rest-axios-setup.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const initialization = (config) => {
+    //const axiosInstance = axios.create(config);
+    //return axiosInstance;
+    return axios_1.default.create(config);
+};
+exports.default = initialization;

package/dist/cjs/utils/rest-util.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestUtil = void 0;
+const rxjs_1 = require("rxjs");
+// Utility class for all REST services with common functions
+class RestUtil {
+    // Constructor with injected authentication service
+    constructor(axiosInst) {
+        this.axiosInstance = axiosInst;
+    }
+    // Upload is HTTP POST action but the body is File object
+    upload(file, url, ...params) {
+        // const resourceUrl = this.buildUrl(url, ...params);
+        //
+        // const formData: FormData = new FormData();
+        // formData.append('fileKey', file, file.name);
+        //
+        // const req = new HttpRequest('POST', resourceUrl, formData, {
+        //   reportProgress: false,
+        //   responseType: 'json',
+        // });
+        // return this.http.request<T>(req);
+        //return this.http.request(req);
+    }
+    // Download is HTTP GET action but the content is blob
+    download(fileName, url, ...params) {
+        // const resourceUrl = this.buildUrl(url, ...params);
+        //
+        // let downloadLink = fileName
+        //
+        // // extract file name
+        // params.forEach(p => {
+        //   let arr = p.split('=');
+        //   if (arr.length > 1) {
+        //     if (arr[0].toLowerCase() === 'filename') {
+        //       downloadLink = arr[1];
+        //     }
+        //   }
+        // });
+        // // Set content type for: json / csv / xml / pdf /xslx
+        // let contentType = this.getMimeType(downloadLink);
+        //
+        // return this.http.get(resourceUrl, {
+        //   responseType: 'blob',
+        //   reportProgress: true,
+        //   observe: 'events',
+        //   headers: new HttpHeaders({ 'Content-Type': contentType })
+        // });
+    }
+    // HTTP GET action
+    get(url, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return (0, rxjs_1.defer)(() => this.axiosInstance.get(resourceUrl))
+            .pipe((0, rxjs_1.map)((result) => result.data));
+    }
+    // HTTP POST action
+    post(url, body, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return (0, rxjs_1.defer)(() => this.axiosInstance.post(resourceUrl, body))
+            .pipe((0, rxjs_1.map)((result) => result.data));
+    }
+    // HTTP PUT action
+    put(url, body, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return (0, rxjs_1.defer)(() => this.axiosInstance.put(resourceUrl, body))
+            .pipe((0, rxjs_1.map)((result) => result.data));
+    }
+    // HTTP PATCH action
+    patch(url, body, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return (0, rxjs_1.defer)(() => this.axiosInstance.patch(resourceUrl, body))
+            .pipe((0, rxjs_1.map)((result) => result.data));
+    }
+    // HTTP DELETE action
+    delete(url, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return (0, rxjs_1.defer)(() => this.axiosInstance.delete(resourceUrl))
+            .pipe((0, rxjs_1.map)((result) => result.data));
+    }
+    // Construct URL with parameters
+    buildUrl(url, ...params) {
+        return (params.length === 0) ? url : `${url}${params && params.length > 0 ? '?' + params.join('&') : ''}`;
+    }
+    // Return MIME type based on file extension
+    getMimeType(fileName) {
+        // Set content type for: json / csv / xml / pdf /xslx
+        let contentType = 'application/json';
+        if (fileName.toLowerCase().endsWith('csv')) {
+            contentType = 'text/csv';
+        }
+        else if (fileName.toLowerCase().endsWith('xml')) {
+            contentType = 'text/xml';
+        }
+        else if (fileName.toLowerCase().endsWith('pdf')) {
+            contentType = 'application/pdf';
+        }
+        else if (fileName.toLowerCase().endsWith('xlsx')) {
+            contentType = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+        }
+        return contentType;
+    }
+}
+exports.RestUtil = RestUtil;

package/dist/esm/config.js

@@ -0,0 +1,7 @@
+export class PulseConfig {
+    constructor() {
+        this.api = '';
+        this.apiKey = '';
+        this.accessToken = '';
+    }
+}

package/dist/esm/index.js

@@ -1,2 +1,4 @@
-import { Num } from './Num';
-export { Num };
+export * from './config';
+export * from './utils';
+export * from './lib';
+export * from './lib/pulse-client';

package/dist/esm/lib/base/BaseEntity.js

@@ -0,0 +1,14 @@
+// Base entity includes common fields for all entities (persistence objects) in the system
+export class BaseEntity {
+    constructor(id, createdOn, updatedOn) {
+        if (id !== undefined) {
+            this.id = id;
+        }
+        if (createdOn !== undefined) {
+            this.createdOn = createdOn;
+        }
+        if (updatedOn !== undefined) {
+            this.updatedOn = updatedOn;
+        }
+    }
+}

package/dist/esm/lib/base/index.js

@@ -0,0 +1 @@
+export * from './BaseEntity';

package/dist/esm/lib/common/AccountRole.js

@@ -0,0 +1,14 @@
+// Account role represents the role of the user in the account
+export class AccountRole {
+    constructor(accountId, accountName, role) {
+        if (accountId !== undefined) {
+            this.accountId = accountId;
+        }
+        if (accountName !== undefined) {
+            this.accountName = accountName;
+        }
+        if (role !== undefined) {
+            this.role = role;
+        }
+    }
+}

package/dist/esm/lib/common/ConsumptionData.js

@@ -0,0 +1,14 @@
+// A set of input, output data values
+export class ConsumptionData {
+    constructor(dataIn, dataOut, total) {
+        if (dataIn !== undefined) {
+            this.dataIn = dataIn;
+        }
+        if (dataOut !== undefined) {
+            this.dataOut = dataOut;
+        }
+        if (total !== undefined) {
+            this.total = total;
+        }
+    }
+}

package/dist/esm/lib/common/ConsumptionTimeDataPoint.js

@@ -0,0 +1,11 @@
+// ConsumptionTimeDataPoint model represents a 2 dimensions datapoint in time
+export class ConsumptionTimeDataPoint {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

package/dist/esm/lib/common/DeviceConfig.js

@@ -0,0 +1,11 @@
+// DeviceConfig is a set of device related configurations
+export class DeviceConfig {
+    constructor(devicesAtRiskConfig, deviceScoreConfig) {
+        if (devicesAtRiskConfig !== undefined) {
+            this.devicesAtRiskConfig = devicesAtRiskConfig;
+        }
+        if (deviceScoreConfig !== undefined) {
+            this.deviceScoreConfig = deviceScoreConfig;
+        }
+    }
+}

package/dist/esm/lib/common/DeviceScoreConfig.js

@@ -0,0 +1,56 @@
+// DeviceScoreConfig is a set of parameters for device score config
+export class DeviceScoreConfig {
+    constructor(deviceScoreAlphaFactor, occurrenceThreshold, ruleCountThreshold, lowWeightAlphaFactor, mediumWeightAlphaFactor, highWeightAlphaFactor, highVolumeWeightAlphaFactor, abnormalOutPortsAlphaFactor, abnormalOutEndpointsAlphaFactor, suspiciousIpAlphaFactor, defaultSeverityRange, defaultSeverityFactor, severityConditionConfigs, ruleCountThresholdConfigs, ruleBasedSeverityConditionConfigs, isSeverityBased, isAlertBased) {
+        if (deviceScoreAlphaFactor !== undefined) {
+            this.deviceScoreAlphaFactor = deviceScoreAlphaFactor;
+        }
+        if (occurrenceThreshold !== undefined) {
+            this.occurrenceThreshold = occurrenceThreshold;
+        }
+        if (ruleCountThreshold !== undefined) {
+            this.ruleCountThreshold = ruleCountThreshold;
+        }
+        if (lowWeightAlphaFactor !== undefined) {
+            this.lowWeightAlphaFactor = lowWeightAlphaFactor;
+        }
+        if (mediumWeightAlphaFactor !== undefined) {
+            this.mediumWeightAlphaFactor = mediumWeightAlphaFactor;
+        }
+        if (highWeightAlphaFactor !== undefined) {
+            this.highWeightAlphaFactor = highWeightAlphaFactor;
+        }
+        if (highVolumeWeightAlphaFactor !== undefined) {
+            this.highVolumeWeightAlphaFactor = highVolumeWeightAlphaFactor;
+        }
+        if (abnormalOutPortsAlphaFactor !== undefined) {
+            this.abnormalOutPortsAlphaFactor = abnormalOutPortsAlphaFactor;
+        }
+        if (abnormalOutEndpointsAlphaFactor !== undefined) {
+            this.abnormalOutEndpointsAlphaFactor = abnormalOutEndpointsAlphaFactor;
+        }
+        if (suspiciousIpAlphaFactor !== undefined) {
+            this.suspiciousIpAlphaFactor = suspiciousIpAlphaFactor;
+        }
+        if (defaultSeverityRange !== undefined) {
+            this.defaultSeverityRange = defaultSeverityRange;
+        }
+        if (defaultSeverityFactor !== undefined) {
+            this.defaultSeverityFactor = defaultSeverityFactor;
+        }
+        if (severityConditionConfigs !== undefined) {
+            this.severityConditionConfigs = severityConditionConfigs;
+        }
+        if (ruleCountThresholdConfigs !== undefined) {
+            this.ruleCountThresholdConfigs = ruleCountThresholdConfigs;
+        }
+        if (ruleBasedSeverityConditionConfigs !== undefined) {
+            this.ruleBasedSeverityConditionConfigs = ruleBasedSeverityConditionConfigs;
+        }
+        if (isSeverityBased !== undefined) {
+            this.isSeverityBased = isSeverityBased;
+        }
+        if (isAlertBased !== undefined) {
+            this.isAlertBased = isAlertBased;
+        }
+    }
+}

package/dist/esm/lib/common/DevicesAtRiskConfig.js

@@ -0,0 +1,8 @@
+// DevicesAtRiskConfig is int of minimal score for device to be at risk
+export class DevicesAtRiskConfig {
+    constructor(minScore) {
+        if (minScore !== undefined) {
+            this.minScore = minScore;
+        }
+    }
+}

package/dist/esm/lib/common/EventSeverityConfig.js

@@ -0,0 +1,8 @@
+// EventSeverityConfig is a list of event severity configuration
+export class EventSeverityConfig {
+    constructor(severityConfigs) {
+        if (severityConfigs !== undefined) {
+            this.severityConfigs = severityConfigs;
+        }
+    }
+}

package/dist/esm/lib/common/FloatKeyValue.js

@@ -0,0 +1,11 @@
+// Key Value float tuple
+export class FloatKeyValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

package/dist/esm/lib/common/GeoData.js

@@ -0,0 +1,24 @@
+// GeoData model represents Geographic data associated with IP
+// This structure is based on the Elasticsearch GeoIP pipeline fetching data from MaxMind database
+export class GeoData {
+    constructor(countryIsoCode, countryName, regionIsoCode, regionName, cityName, location) {
+        if (countryIsoCode !== undefined) {
+            this.country_iso_code = countryIsoCode;
+        }
+        if (countryName !== undefined) {
+            this.country_name = countryName;
+        }
+        if (regionIsoCode !== undefined) {
+            this.region_iso_code = regionIsoCode;
+        }
+        if (regionName !== undefined) {
+            this.region_name = regionName;
+        }
+        if (cityName !== undefined) {
+            this.city_name = cityName;
+        }
+        if (location !== undefined) {
+            this.location = location;
+        }
+    }
+}

package/dist/esm/lib/common/GraphSeries.js

@@ -0,0 +1,11 @@
+// GraphSeries model represents a generic set of data points over interval
+export class GraphSeries {
+    constructor(name, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}

package/dist/esm/lib/common/Indicator.js

@@ -0,0 +1,20 @@
+// Indicator model represents a feature and feature value within a normal range
+export class Indicator {
+    constructor(name, significance, min, max, actual) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (significance !== undefined) {
+            this.significance = significance;
+        }
+        if (min !== undefined) {
+            this.min = min;
+        }
+        if (max !== undefined) {
+            this.max = max;
+        }
+        if (actual !== undefined) {
+            this.actual = actual;
+        }
+    }
+}

package/dist/esm/lib/common/IntKeySeriesDataValue.js

@@ -0,0 +1,11 @@
+// Key: int Value SeriesData  tuple
+export class IntKeySeriesDataValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

package/dist/esm/lib/common/IntKeyValue.js

@@ -0,0 +1,11 @@
+// Key Value int tuple
+export class IntKeyValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}

package/dist/esm/lib/common/Interval.js

@@ -0,0 +1,11 @@
+// Interval represents a finite int window (from - to)
+export class Interval {
+    constructor(from, to) {
+        if (from !== undefined) {
+            this.from = from;
+        }
+        if (to !== undefined) {
+            this.to = to;
+        }
+    }
+}

package/dist/esm/lib/common/Link.js

@@ -0,0 +1,26 @@
+// Link represents a relation between two nodes
+export class Link {
+    constructor(id, name, src, dst, value, severity, eventCount) {
+        if (id !== undefined) {
+            this.id = id;
+        }
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (src !== undefined) {
+            this.src = src;
+        }
+        if (dst !== undefined) {
+            this.dst = dst;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+        if (severity !== undefined) {
+            this.severity = severity;
+        }
+        if (eventCount !== undefined) {
+            this.eventCount = eventCount;
+        }
+    }
+}

package/dist/esm/lib/common/Location.js

@@ -0,0 +1,11 @@
+// WGS-84 Geo Location
+export class Location {
+    constructor(lat, lon) {
+        if (lat !== undefined) {
+            this.lat = lat;
+        }
+        if (lon !== undefined) {
+            this.lon = lon;
+        }
+    }
+}

package/dist/esm/lib/common/LoginParams.js

@@ -0,0 +1,14 @@
+// Login parameters data model
+export class LoginParams {
+    constructor(email, password, accessToken) {
+        if (email !== undefined) {
+            this.email = email;
+        }
+        if (password !== undefined) {
+            this.password = password;
+        }
+        if (accessToken !== undefined) {
+            this.accessToken = accessToken;
+        }
+    }
+}

package/dist/esm/lib/common/MaliciousIPCard.js

@@ -0,0 +1,29 @@
+// MaliciousIPCard is a data structure representing malicious IP card
+export class MaliciousIPCard {
+    constructor(maliciousIp, maliciousIpDns, countryCode, ipDescription, lastEventTime, attackCategories, numberOfDevices, eventsBySeverityBreakdown) {
+        if (maliciousIp !== undefined) {
+            this.maliciousIp = maliciousIp;
+        }
+        if (maliciousIpDns !== undefined) {
+            this.maliciousIpDns = maliciousIpDns;
+        }
+        if (countryCode !== undefined) {
+            this.countryCode = countryCode;
+        }
+        if (ipDescription !== undefined) {
+            this.ipDescription = ipDescription;
+        }
+        if (lastEventTime !== undefined) {
+            this.lastEventTime = lastEventTime;
+        }
+        if (attackCategories !== undefined) {
+            this.attackCategories = attackCategories;
+        }
+        if (numberOfDevices !== undefined) {
+            this.numberOfDevices = numberOfDevices;
+        }
+        if (eventsBySeverityBreakdown !== undefined) {
+            this.eventsBySeverityBreakdown = eventsBySeverityBreakdown;
+        }
+    }
+}

package/dist/esm/lib/common/MaliciousIPData.js

@@ -0,0 +1,17 @@
+// MaliciousIPData is a data structure representing malicious IP and its statistics
+export class MaliciousIPData {
+    constructor(iP, totalEvents, totalDevices, totalMaliciousIPs) {
+        if (iP !== undefined) {
+            this.ip = iP;
+        }
+        if (totalEvents !== undefined) {
+            this.totalEvents = totalEvents;
+        }
+        if (totalDevices !== undefined) {
+            this.totalDevices = totalDevices;
+        }
+        if (totalMaliciousIPs !== undefined) {
+            this.totalMaliciousIPs = totalMaliciousIPs;
+        }
+    }
+}

package/dist/esm/lib/common/NetworkMap.js

@@ -0,0 +1,11 @@
+// NetworkMap is a data structure representing a set of nodes and vertex representing a network
+export class NetworkMap {
+    constructor(nodes, links) {
+        if (nodes !== undefined) {
+            this.nodes = nodes;
+        }
+        if (links !== undefined) {
+            this.links = links;
+        }
+    }
+}

package/dist/esm/lib/common/Node.js

@@ -0,0 +1,35 @@
+// Node represents a vertex in a network map
+export class Node {
+    constructor(id, name, ip, type, score, tags, labels, eventCount, isGroup, deviceCount) {
+        if (id !== undefined) {
+            this.id = id;
+        }
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (ip !== undefined) {
+            this.ip = ip;
+        }
+        if (type !== undefined) {
+            this.type = type;
+        }
+        if (score !== undefined) {
+            this.score = score;
+        }
+        if (tags !== undefined) {
+            this.tags = tags;
+        }
+        if (labels !== undefined) {
+            this.labels = labels;
+        }
+        if (eventCount !== undefined) {
+            this.eventCount = eventCount;
+        }
+        if (isGroup !== undefined) {
+            this.isGroup = isGroup;
+        }
+        if (deviceCount !== undefined) {
+            this.deviceCount = deviceCount;
+        }
+    }
+}

package/dist/esm/lib/common/RuleBasedSeverityConditionConfig.js

@@ -0,0 +1,17 @@
+// RuleBasedSeverityConditionConfig is a set of severity types code configs
+export class RuleBasedSeverityConditionConfig {
+    constructor(severityType, bias, ruleConditionThresholdConfig, ruleTypesThreshold) {
+        if (severityType !== undefined) {
+            this.severityType = severityType;
+        }
+        if (bias !== undefined) {
+            this.bias = bias;
+        }
+        if (ruleConditionThresholdConfig !== undefined) {
+            this.ruleConditionThresholdConfig = ruleConditionThresholdConfig;
+        }
+        if (ruleTypesThreshold !== undefined) {
+            this.ruleTypesThreshold = ruleTypesThreshold;
+        }
+    }
+}

package/dist/esm/lib/common/RuleCountThresholdConfig.js

@@ -0,0 +1,11 @@
+// RuleCountThresholdConfig is a set of event type to threshold
+export class RuleCountThresholdConfig {
+    constructor(eventType, threshold) {
+        if (eventType !== undefined) {
+            this.eventType = eventType;
+        }
+        if (threshold !== undefined) {
+            this.threshold = threshold;
+        }
+    }
+}

package/dist/esm/lib/common/SeriesData.js

@@ -0,0 +1,11 @@
+// SeriesData model represents a generic datapoint in interval range
+export class SeriesData {
+    constructor(interval, values) {
+        if (interval !== undefined) {
+            this.interval = interval;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}