@shieldiot/pulse-lib 1.0.10 → 1.0.12

package/README.md

@@ -1,7 +1,9 @@
-# Step by Step manual install
+# Pulse IoT client library
 
+This package is a typescript client library for the pulse IoT API.
+The library includes all the types and services exposed the the pulse API.
 
-##### Install dependencies with npm:
+## Install
 
 Install dependencies:
 `npm i`
@@ -10,35 +12,21 @@ Build package:
 `npm run build`
 
 
-##### Test localy:
+##### How to use:
 
-Create a symlink in the global folder:
-`npm link`
+```typescript
+import { Account, PulseClient } from 'pulse-lib'
 
-Go to another folder (the consumer project) and run:
-`npm link pulse-lib`
+let pc = new PulseClient("https://your-pulse-api-endpoint", "your-api-key", "your-access-token");
+pc.UsrRulesService.find("streamId").pipe();
 
-Create sample code in the consumer folder:
-
-```javascript
-import { Num } from 'pulse-lib'
-console.log(new Num(5).add(new Num(6)).val() === 11)
 ```
+The apiKey and accessToken parameters in the PulseClient constructor are optional since
+it is recomended to use HTTP interceptors to inject the API key and access token instead of constructor injection.
 
-Build and run the project to test the library
-
-Uninstall the globally-installed package:
-`npm uninstall pulse-lib -g`
-
-# Step by Step CI/CD install (repeat git actions workflow)
-
-Set env variable:
-`export NODE_AUTH_TOKEN="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"`
-
-Add Scope:
-`node tools/packagejson name pulse-lib`
+The use of interceptor is better since for any API response, the response header includes new access toekn with
+new expiration time. Using the same token without refreshing it will eventually result access denied error after the expiration time of the original token (30 minutes).
+The use of constructor injection of access token is recomended for non-expired tokens only (system-to-system integration).
 
-Publish to NPM
-`npm publish`
 
 

package/dist/cjs/index.js

@@ -1,5 +1,19 @@
 "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 });
-exports.Num = void 0;
-var Num_1 = require("./Num");
-Object.defineProperty(exports, "Num", { enumerable: true, get: function () { return Num_1.Num; } });
+__exportStar(require("./utils"), exports);
+__exportStar(require("./lib"), exports);
+__exportStar(require("./lib/pulse-client"), exports);

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEntity = void 0;
+// Base entity includes common fields for all entities (persistence objects) in the system
+class BaseEntity {
+    constructor(id, createdOn, updatedOn) {
+        if (id !== undefined) {
+            this.id = id;
+        }
+        if (createdOn !== undefined) {
+            this.createdOn = createdOn;
+        }
+        if (updatedOn !== undefined) {
+            this.updatedOn = updatedOn;
+        }
+    }
+}
+exports.BaseEntity = BaseEntity;

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

@@ -0,0 +1,17 @@
+"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("./BaseEntity"), exports);

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountRole = void 0;
+// Account role represents the role of the user in the account
+class AccountRole {
+    constructor(accountId, accountName, role) {
+        if (accountId !== undefined) {
+            this.accountId = accountId;
+        }
+        if (accountName !== undefined) {
+            this.accountName = accountName;
+        }
+        if (role !== undefined) {
+            this.role = role;
+        }
+    }
+}
+exports.AccountRole = AccountRole;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsumptionData = void 0;
+// A set of input, output data values
+class ConsumptionData {
+    constructor(dataIn, dataOut, total) {
+        if (dataIn !== undefined) {
+            this.dataIn = dataIn;
+        }
+        if (dataOut !== undefined) {
+            this.dataOut = dataOut;
+        }
+        if (total !== undefined) {
+            this.total = total;
+        }
+    }
+}
+exports.ConsumptionData = ConsumptionData;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConsumptionTimeDataPoint = void 0;
+// ConsumptionTimeDataPoint model represents a 2 dimensions datapoint in time
+class ConsumptionTimeDataPoint {
+    constructor(timestamp, value) {
+        if (timestamp !== undefined) {
+            this.timestamp = timestamp;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.ConsumptionTimeDataPoint = ConsumptionTimeDataPoint;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceConfig = void 0;
+// DeviceConfig is a set of device related configurations
+class DeviceConfig {
+    constructor(devicesAtRiskConfig, deviceScoreConfig) {
+        if (devicesAtRiskConfig !== undefined) {
+            this.devicesAtRiskConfig = devicesAtRiskConfig;
+        }
+        if (deviceScoreConfig !== undefined) {
+            this.deviceScoreConfig = deviceScoreConfig;
+        }
+    }
+}
+exports.DeviceConfig = DeviceConfig;

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceScoreConfig = void 0;
+// DeviceScoreConfig is a set of parameters for device score config
+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;
+        }
+    }
+}
+exports.DeviceScoreConfig = DeviceScoreConfig;

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DevicesAtRiskConfig = void 0;
+// DevicesAtRiskConfig is int of minimal score for device to be at risk
+class DevicesAtRiskConfig {
+    constructor(minScore) {
+        if (minScore !== undefined) {
+            this.minScore = minScore;
+        }
+    }
+}
+exports.DevicesAtRiskConfig = DevicesAtRiskConfig;

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventSeverityConfig = void 0;
+// EventSeverityConfig is a list of event severity configuration
+class EventSeverityConfig {
+    constructor(severityConfigs) {
+        if (severityConfigs !== undefined) {
+            this.severityConfigs = severityConfigs;
+        }
+    }
+}
+exports.EventSeverityConfig = EventSeverityConfig;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FloatKeyValue = void 0;
+// Key Value float tuple
+class FloatKeyValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.FloatKeyValue = FloatKeyValue;

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

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeoData = void 0;
+// GeoData model represents Geographic data associated with IP
+// This structure is based on the Elasticsearch GeoIP pipeline fetching data from MaxMind database
+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;
+        }
+    }
+}
+exports.GeoData = GeoData;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphSeries = void 0;
+// GraphSeries model represents a generic set of data points over interval
+class GraphSeries {
+    constructor(name, values) {
+        if (name !== undefined) {
+            this.name = name;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.GraphSeries = GraphSeries;

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Indicator = void 0;
+// Indicator model represents a feature and feature value within a normal range
+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;
+        }
+    }
+}
+exports.Indicator = Indicator;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntKeySeriesDataValue = void 0;
+// Key: int Value SeriesData  tuple
+class IntKeySeriesDataValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.IntKeySeriesDataValue = IntKeySeriesDataValue;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IntKeyValue = void 0;
+// Key Value int tuple
+class IntKeyValue {
+    constructor(key, value) {
+        if (key !== undefined) {
+            this.key = key;
+        }
+        if (value !== undefined) {
+            this.value = value;
+        }
+    }
+}
+exports.IntKeyValue = IntKeyValue;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Interval = void 0;
+// Interval represents a finite int window (from - to)
+class Interval {
+    constructor(from, to) {
+        if (from !== undefined) {
+            this.from = from;
+        }
+        if (to !== undefined) {
+            this.to = to;
+        }
+    }
+}
+exports.Interval = Interval;

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Link = void 0;
+// Link represents a relation between two nodes
+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;
+        }
+    }
+}
+exports.Link = Link;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Location = void 0;
+// WGS-84 Geo Location
+class Location {
+    constructor(lat, lon) {
+        if (lat !== undefined) {
+            this.lat = lat;
+        }
+        if (lon !== undefined) {
+            this.lon = lon;
+        }
+    }
+}
+exports.Location = Location;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoginParams = void 0;
+// Login parameters data model
+class LoginParams {
+    constructor(email, password, accessToken) {
+        if (email !== undefined) {
+            this.email = email;
+        }
+        if (password !== undefined) {
+            this.password = password;
+        }
+        if (accessToken !== undefined) {
+            this.accessToken = accessToken;
+        }
+    }
+}
+exports.LoginParams = LoginParams;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaliciousIPCard = void 0;
+// MaliciousIPCard is a data structure representing malicious IP card
+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;
+        }
+    }
+}
+exports.MaliciousIPCard = MaliciousIPCard;

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaliciousIPData = void 0;
+// MaliciousIPData is a data structure representing malicious IP and its statistics
+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;
+        }
+    }
+}
+exports.MaliciousIPData = MaliciousIPData;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkMap = void 0;
+// NetworkMap is a data structure representing a set of nodes and vertex representing a network
+class NetworkMap {
+    constructor(nodes, links) {
+        if (nodes !== undefined) {
+            this.nodes = nodes;
+        }
+        if (links !== undefined) {
+            this.links = links;
+        }
+    }
+}
+exports.NetworkMap = NetworkMap;

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

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Node = void 0;
+// Node represents a vertex in a network map
+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;
+        }
+    }
+}
+exports.Node = Node;

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleBasedSeverityConditionConfig = void 0;
+// RuleBasedSeverityConditionConfig is a set of severity types code configs
+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;
+        }
+    }
+}
+exports.RuleBasedSeverityConditionConfig = RuleBasedSeverityConditionConfig;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RuleCountThresholdConfig = void 0;
+// RuleCountThresholdConfig is a set of event type to threshold
+class RuleCountThresholdConfig {
+    constructor(eventType, threshold) {
+        if (eventType !== undefined) {
+            this.eventType = eventType;
+        }
+        if (threshold !== undefined) {
+            this.threshold = threshold;
+        }
+    }
+}
+exports.RuleCountThresholdConfig = RuleCountThresholdConfig;

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

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeriesData = void 0;
+// SeriesData model represents a generic datapoint in interval range
+class SeriesData {
+    constructor(interval, values) {
+        if (interval !== undefined) {
+            this.interval = interval;
+        }
+        if (values !== undefined) {
+            this.values = values;
+        }
+    }
+}
+exports.SeriesData = SeriesData;