@shieldiot/pulse-lib 1.0.2 → 1.0.4

package/dist/config.d.ts

@@ -0,0 +1,5 @@
+export declare class PulseConfig {
+    api: string;
+    apiKey: string;
+    accessToken: string;
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { PulseClient } from "./lib/pulse-client";
+export default PulseClient;

package/dist/lib/common/AccountRole.d.ts

@@ -0,0 +1,7 @@
+import { MemberRoleCode } from '../enums';
+export declare class AccountRole {
+    accountId: string;
+    accountName: string;
+    role: MemberRoleCode;
+    constructor(accountId?: string, accountName?: string, role?: MemberRoleCode);
+}

package/dist/lib/common/ConsumptionData.d.ts

@@ -0,0 +1,6 @@
+export declare class ConsumptionData {
+    dataIn: number;
+    dataOut: number;
+    total: number;
+    constructor(dataIn?: number, dataOut?: number, total?: number);
+}

package/dist/lib/common/ConsumptionTimeDataPoint.d.ts

@@ -0,0 +1,6 @@
+import { ConsumptionData } from '../common';
+export declare class ConsumptionTimeDataPoint {
+    timestamp: number;
+    value: ConsumptionData;
+    constructor(timestamp?: number, value?: ConsumptionData);
+}

package/dist/lib/common/DeviceConfig.d.ts

@@ -0,0 +1,7 @@
+import { DeviceScoreConfig } from '../common';
+import { DevicesAtRiskConfig } from '../common';
+export declare class DeviceConfig {
+    devicesAtRiskConfig: DevicesAtRiskConfig;
+    deviceScoreConfig: DeviceScoreConfig;
+    constructor(devicesAtRiskConfig?: DevicesAtRiskConfig, deviceScoreConfig?: DeviceScoreConfig);
+}

package/dist/lib/common/DeviceScoreConfig.d.ts

@@ -0,0 +1,6 @@
+export declare class DeviceScoreConfig {
+    deviceScoreAlphaFactor: number;
+    occurrenceThreshold: number;
+    ruleCountThreshold: number;
+    constructor(deviceScoreAlphaFactor?: number, occurrenceThreshold?: number, ruleCountThreshold?: number);
+}

package/dist/lib/common/DevicesAtRiskConfig.d.ts

@@ -0,0 +1,4 @@
+export declare class DevicesAtRiskConfig {
+    minScore: number;
+    constructor(minScore?: number);
+}

package/dist/lib/common/EventSeverityConfig.d.ts

@@ -0,0 +1,5 @@
+import { SeverityIntervalTuple } from '../common';
+export declare class EventSeverityConfig {
+    severityConfigs: SeverityIntervalTuple[];
+    constructor(severityConfigs?: SeverityIntervalTuple[]);
+}

package/dist/lib/common/FloatKeyValue.d.ts

@@ -0,0 +1,5 @@
+export declare class FloatKeyValue {
+    key: number;
+    value: number;
+    constructor(key?: number, value?: number);
+}

package/dist/lib/common/GeoData.d.ts

@@ -0,0 +1,10 @@
+import { Location } from '../common';
+export declare class GeoData {
+    country_iso_code: string;
+    country_name: string;
+    region_iso_code: string;
+    region_name: string;
+    city_name: string;
+    location: Location;
+    constructor(countryIsoCode?: string, countryName?: string, regionIsoCode?: string, regionName?: string, cityName?: string, location?: Location);
+}

package/dist/lib/common/GraphSeries.d.ts

@@ -0,0 +1,6 @@
+import { IntKeySeriesDataValue } from '../common';
+export declare class GraphSeries {
+    name: string;
+    values: IntKeySeriesDataValue[];
+    constructor(name?: string, values?: IntKeySeriesDataValue[]);
+}

package/dist/lib/common/Indicator.d.ts

@@ -0,0 +1,8 @@
+export declare class Indicator {
+    name: string;
+    significance: number;
+    min: number;
+    max: number;
+    actual: number;
+    constructor(name?: string, significance?: number, min?: number, max?: number, actual?: number);
+}

package/dist/lib/common/IntKeySeriesDataValue.d.ts

@@ -0,0 +1,6 @@
+import { SeriesData } from '../common';
+export declare class IntKeySeriesDataValue {
+    key: number;
+    value: SeriesData;
+    constructor(key?: number, value?: SeriesData);
+}

package/dist/lib/common/IntKeyValue.d.ts

@@ -0,0 +1,5 @@
+export declare class IntKeyValue {
+    key: number;
+    value: number;
+    constructor(key?: number, value?: number);
+}

package/dist/lib/common/Interval.d.ts

@@ -0,0 +1,5 @@
+export declare class Interval {
+    from: number;
+    to: number;
+    constructor(from?: number, to?: number);
+}

package/dist/lib/common/Link.d.ts

@@ -0,0 +1,11 @@
+import { SeverityTypeCode } from '../enums';
+export declare class Link {
+    id: string;
+    name: string;
+    src: string;
+    dst: string;
+    value: number;
+    severity: SeverityTypeCode;
+    eventCount: number;
+    constructor(id?: string, name?: string, src?: string, dst?: string, value?: number, severity?: SeverityTypeCode, eventCount?: number);
+}

package/dist/lib/common/Location.d.ts

@@ -0,0 +1,5 @@
+export declare class Location {
+    lat: number;
+    lon: number;
+    constructor(lat?: number, lon?: number);
+}

package/dist/lib/common/LoginParams.d.ts

@@ -0,0 +1,6 @@
+export declare class LoginParams {
+    email: string;
+    password: string;
+    accessToken: string;
+    constructor(email?: string, password?: string, accessToken?: string);
+}

package/dist/lib/common/MaliciousIPCard.d.ts

@@ -0,0 +1,12 @@
+import { IntDistribution } from '../entities';
+export declare class MaliciousIPCard {
+    maliciousIp: string;
+    maliciousIpDns: string;
+    countryCode: string;
+    ipDescription: string;
+    lastEventTime: number;
+    attackCategories: string[];
+    numberOfDevices: number;
+    eventsBySeverityBreakdown: IntDistribution;
+    constructor(maliciousIp?: string, maliciousIpDns?: string, countryCode?: string, ipDescription?: string, lastEventTime?: number, attackCategories?: string[], numberOfDevices?: number, eventsBySeverityBreakdown?: IntDistribution);
+}

package/dist/lib/common/MaliciousIPData.d.ts

@@ -0,0 +1,7 @@
+export declare class MaliciousIPData {
+    ip: string;
+    totalEvents: number;
+    totalDevices: number;
+    totalMaliciousIPs: number;
+    constructor(iP?: string, totalEvents?: number, totalDevices?: number, totalMaliciousIPs?: number);
+}

package/dist/lib/common/NetworkMap.d.ts

@@ -0,0 +1,7 @@
+import { Node } from '../common';
+import { Link } from '../common';
+export declare class NetworkMap {
+    nodes: Node[];
+    links: Link[];
+    constructor(nodes?: Node[], links?: Link[]);
+}

package/dist/lib/common/Node.d.ts

@@ -0,0 +1,15 @@
+import { StringKeyValue } from '../common';
+import { DeviceTypeCode } from '../enums';
+export declare class Node {
+    id: string;
+    name: string;
+    ip: string;
+    type: DeviceTypeCode;
+    score: number;
+    tags: string[];
+    labels: StringKeyValue[];
+    eventCount: number;
+    isGroup: boolean;
+    deviceCount: number;
+    constructor(id?: string, name?: string, ip?: string, type?: DeviceTypeCode, score?: number, tags?: string[], labels?: StringKeyValue[], eventCount?: number, isGroup?: boolean, deviceCount?: number);
+}

package/dist/lib/common/SeriesData.d.ts

@@ -0,0 +1,7 @@
+import { Interval } from '../common';
+import { StringKeyIntValue } from '../common';
+export declare class SeriesData {
+    interval: Interval;
+    values: StringKeyIntValue[];
+    constructor(interval?: Interval, values?: StringKeyIntValue[]);
+}

package/dist/lib/common/SessionTransform.d.ts

@@ -0,0 +1,8 @@
+import { ZScore } from '../common';
+export declare class SessionTransform {
+    packetsIn: ZScore;
+    packetsOut: ZScore;
+    bytesIn: ZScore;
+    bytesOut: ZScore;
+    constructor(packetsIn?: ZScore, packetsOut?: ZScore, bytesIn?: ZScore, bytesOut?: ZScore);
+}

package/dist/lib/common/SeverityIntervalTuple.d.ts

@@ -0,0 +1,7 @@
+import { SeverityTypeCode } from '../enums';
+import { Interval } from '../common';
+export declare class SeverityIntervalTuple {
+    severity: SeverityTypeCode;
+    interval: Interval;
+    constructor(severity?: SeverityTypeCode, interval?: Interval);
+}

package/dist/lib/common/ShieldexConfig.d.ts

@@ -0,0 +1,9 @@
+export declare class ShieldexConfig {
+    alphaWeightFactor: number;
+    percentFactor: number;
+    lowRiskWeight: number;
+    mediumRiskWeight: number;
+    highRiskWeight: number;
+    criticalRiskWeight: number;
+    constructor(alphaWeightFactor?: number, percentFactor?: number, lowRiskWeight?: number, mediumRiskWeight?: number, highRiskWeight?: number, criticalRiskWeight?: number);
+}

package/dist/lib/common/StringIntValue.d.ts

@@ -0,0 +1,5 @@
+export declare class StringIntValue {
+    key: string;
+    value: number;
+    constructor(key?: string, value?: number);
+}

package/dist/lib/common/StringKeyIntValue.d.ts

@@ -0,0 +1,5 @@
+export declare class StringKeyIntValue {
+    key: string;
+    value: number;
+    constructor(key?: string, value?: number);
+}

package/dist/lib/common/StringKeyValue.d.ts

@@ -0,0 +1,5 @@
+export declare class StringKeyValue {
+    key: string;
+    value: string;
+    constructor(key?: string, value?: string);
+}

package/dist/lib/common/Thresholds.d.ts

@@ -0,0 +1,4 @@
+export declare class Thresholds {
+    inactiveDeviceWindowMin: number;
+    constructor(inactiveDeviceWindowMin?: number);
+}

package/dist/lib/common/TimeDataPoint.d.ts

@@ -0,0 +1,5 @@
+export declare class TimeDataPoint {
+    timestamp: number;
+    value: any;
+    constructor(timestamp?: number, value?: any);
+}

package/dist/lib/common/TimeDataPoint2D.d.ts

@@ -0,0 +1,6 @@
+import { FloatKeyValue } from '../common';
+export declare class TimeDataPoint2D {
+    timestamp: number;
+    value: FloatKeyValue[];
+    constructor(timestamp?: number, value?: FloatKeyValue[]);
+}

package/dist/lib/common/TimeDataPointFloat.d.ts

@@ -0,0 +1,5 @@
+export declare class TimeDataPointFloat {
+    timestamp: number;
+    value: number;
+    constructor(timestamp?: number, value?: number);
+}

package/dist/lib/common/TimeFrame.d.ts

@@ -0,0 +1,5 @@
+export declare class TimeFrame {
+    from: number;
+    to: number;
+    constructor(from?: number, to?: number);
+}

package/dist/lib/common/TimeSeries.d.ts

@@ -0,0 +1,8 @@
+import { TimeFrame } from '../common';
+import { TimeDataPoint } from '../common';
+export declare class TimeSeries {
+    name: string;
+    range: TimeFrame;
+    values: TimeDataPoint[];
+    constructor(name?: string, range?: TimeFrame, values?: TimeDataPoint[]);
+}

package/dist/lib/common/TimeSeriesOf2D.d.ts

@@ -0,0 +1,8 @@
+import { TimeFrame } from '../common';
+import { TimeDataPoint2D } from '../common';
+export declare class TimeSeriesOf2D {
+    name: string;
+    range: TimeFrame;
+    values: TimeDataPoint2D[];
+    constructor(name?: string, range?: TimeFrame, values?: TimeDataPoint2D[]);
+}

package/dist/lib/common/TimeSeriesOfDataConsumption.d.ts

@@ -0,0 +1,8 @@
+import { TimeFrame } from '../common';
+import { ConsumptionTimeDataPoint } from '../common';
+export declare class TimeSeriesOfDataConsumption {
+    name: string;
+    range: TimeFrame;
+    values: ConsumptionTimeDataPoint[];
+    constructor(name?: string, range?: TimeFrame, values?: ConsumptionTimeDataPoint[]);
+}

package/dist/lib/common/TimeSeriesOfFloat.d.ts

@@ -0,0 +1,8 @@
+import { TimeFrame } from '../common';
+import { TimeDataPointFloat } from '../common';
+export declare class TimeSeriesOfFloat {
+    name: string;
+    range: TimeFrame;
+    values: TimeDataPointFloat[];
+    constructor(name?: string, range?: TimeFrame, values?: TimeDataPointFloat[]);
+}

package/dist/lib/common/TokenData.d.ts

@@ -0,0 +1,12 @@
+import { UserTypeCode } from '../enums';
+import { MemberRoleCode } from '../enums';
+import { UserStatusCode } from '../enums';
+export declare class TokenData {
+    accountId: string;
+    subjectId: string;
+    subjectType: UserTypeCode;
+    role: MemberRoleCode;
+    status: UserStatusCode;
+    expiresIn: number;
+    constructor(accountId?: string, subjectId?: string, subjectType?: UserTypeCode, role?: MemberRoleCode, status?: UserStatusCode, expiresIn?: number);
+}

package/dist/lib/common/Tuple.d.ts

@@ -0,0 +1,5 @@
+export declare class Tuple {
+    key: any;
+    value: any;
+    constructor(key?: any, value?: any);
+}

package/dist/lib/common/UsageTransform.d.ts

@@ -0,0 +1,10 @@
+import { ZScore } from '../common';
+export declare class UsageTransform {
+    packetsIn: ZScore;
+    packetsOut: ZScore;
+    bytesIn: ZScore;
+    bytesOut: ZScore;
+    endpointsCount: ZScore;
+    portsCount: ZScore;
+    constructor(packetsIn?: ZScore, packetsOut?: ZScore, bytesIn?: ZScore, bytesOut?: ZScore, endpointsCount?: ZScore, portsCount?: ZScore);
+}

package/dist/lib/common/ZScore.d.ts

@@ -0,0 +1,5 @@
+export declare class ZScore {
+    mean: number;
+    sD: number;
+    constructor(mean?: number, sD?: number);
+}

package/dist/lib/common/index.d.ts

@@ -0,0 +1,42 @@
+export * from './AccountRole';
+export * from './ConsumptionData';
+export * from './ConsumptionTimeDataPoint';
+export * from './DeviceConfig';
+export * from './DeviceScoreConfig';
+export * from './DevicesAtRiskConfig';
+export * from './EventSeverityConfig';
+export * from './FloatKeyValue';
+export * from './GeoData';
+export * from './GraphSeries';
+export * from './Indicator';
+export * from './IntKeySeriesDataValue';
+export * from './IntKeyValue';
+export * from './Interval';
+export * from './Link';
+export * from './Location';
+export * from './LoginParams';
+export * from './MaliciousIPCard';
+export * from './MaliciousIPData';
+export * from './NetworkMap';
+export * from './Node';
+export * from './SeriesData';
+export * from './SessionTransform';
+export * from './SeverityIntervalTuple';
+export * from './ShieldexConfig';
+export * from './StringIntValue';
+export * from './StringKeyIntValue';
+export * from './StringKeyValue';
+export * from './Thresholds';
+export * from './TimeDataPoint';
+export * from './TimeDataPoint2D';
+export * from './TimeDataPointFloat';
+export * from './TimeFrame';
+export * from './TimeSeries';
+export * from './TimeSeriesOf2D';
+export * from './TimeSeriesOfDataConsumption';
+export * from './TimeSeriesOfFloat';
+export * from './TokenData';
+export * from './Tuple';
+export * from './UsageTransform';
+export * from './ZScore';
+export * from './index';

package/dist/lib/entities/Account.d.ts

@@ -0,0 +1,17 @@
+import { AccountStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+import { BaseEntity } from '../entities';
+import { AccountTypeCode } from '../enums';
+export declare class Account extends BaseEntity {
+    name: string;
+    externalId: string;
+    description: string;
+    type: AccountTypeCode;
+    status: AccountStatusCode;
+    groups: string[];
+    expiredOn: number;
+    tags: string[];
+    labels: StringKeyValue[];
+    settings: AccountSettings;
+}

package/dist/lib/entities/AccountDTO.d.ts

@@ -0,0 +1,19 @@
+import { BaseEntity } from '../entities';
+import { AccountTypeCode } from '../enums';
+import { AccountStatusCode } from '../enums';
+import { FeatureCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+export declare class AccountDTO extends BaseEntity {
+    name: string;
+    externalId: string;
+    description: string;
+    type: AccountTypeCode;
+    status: AccountStatusCode;
+    groups: string[];
+    features: FeatureCode[];
+    expiredOn: number;
+    tags: string[];
+    labels: StringKeyValue[];
+    settings: AccountSettings;
+}

package/dist/lib/entities/AccountSettings.d.ts

@@ -0,0 +1,10 @@
+import { ComplianceReportSettings } from '../entities';
+import { TeaserPopUpSettings } from '../entities';
+import { HomePageViewCode } from '../enums';
+export declare class AccountSettings {
+    logo: string;
+    defaultHomePageView: HomePageViewCode;
+    complianceReportSettings: ComplianceReportSettings;
+    teaserPopUpSettings: TeaserPopUpSettings;
+    constructor(logo?: string, defaultHomePageView?: HomePageViewCode, complianceReportSettings?: ComplianceReportSettings, teaserPopUpSettings?: TeaserPopUpSettings);
+}

package/dist/lib/entities/Action.d.ts

@@ -0,0 +1,10 @@
+import { DeviceActionCode } from '../enums';
+import { BaseEntity } from '../entities';
+export declare class Action extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    eventId: string;
+    deviceId: string;
+    action: DeviceActionCode;
+    userId: string;
+}

package/dist/lib/entities/Alert.d.ts

@@ -0,0 +1,34 @@
+import { EventTypeCode } from '../enums';
+import { RuleTypeCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { EventCategoryCode } from '../enums';
+import { TrafficDirectionCode } from '../enums';
+import { BaseEntity } from '../entities';
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+export declare class Alert extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    deviceId: string;
+    startTime: number;
+    endTime: number;
+    type: EventTypeCode;
+    severity: SeverityTypeCode;
+    score: number;
+    probability: number;
+    status: EventStatusCode;
+    ruleType: RuleTypeCode;
+    ruleId: string;
+    sourceIp: string;
+    targetIp: string;
+    targetLocation: GeoData;
+    description: string;
+    tags: string[];
+    labels: StringKeyValue[];
+    category: EventCategoryCode;
+    recommendedAction: string;
+    trafficDirection: TrafficDirectionCode;
+    confidenceScore: number;
+    occurrencesCount: boolean;
+}

package/dist/lib/entities/AlertWithDevice.d.ts

@@ -0,0 +1,36 @@
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { EventCategoryCode } from '../enums';
+import { TrafficDirectionCode } from '../enums';
+import { Device } from '../entities';
+import { BaseEntity } from '../entities';
+import { EventTypeCode } from '../enums';
+import { RuleTypeCode } from '../enums';
+export declare class AlertWithDevice extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    deviceId: string;
+    startTime: number;
+    endTime: number;
+    type: EventTypeCode;
+    severity: SeverityTypeCode;
+    score: number;
+    probability: number;
+    status: EventStatusCode;
+    ruleType: RuleTypeCode;
+    ruleId: string;
+    sourceIp: string;
+    targetIp: string;
+    targetLocation: GeoData;
+    description: string;
+    tags: string[];
+    labels: StringKeyValue[];
+    category: EventCategoryCode;
+    recommendedAction: string;
+    trafficDirection: TrafficDirectionCode;
+    confidenceScore: number;
+    occurrencesCount: boolean;
+    device: Device;
+}

package/dist/lib/entities/ApiKey.d.ts

@@ -0,0 +1,11 @@
+import { StringKeyIntValue } from '../common';
+import { BaseEntity } from '../entities';
+export declare class ApiKey extends BaseEntity {
+    name: string;
+    ttl: number;
+    acl: StringKeyIntValue[];
+    version: number;
+    systemKey: boolean;
+    enabled: boolean;
+    key: string;
+}

package/dist/lib/entities/AuditLog.d.ts

@@ -0,0 +1,13 @@
+import { UserTypeCode } from '../enums';
+import { BaseEntity } from '../entities';
+export declare class AuditLog extends BaseEntity {
+    accountId: string;
+    userId: string;
+    userType: UserTypeCode;
+    action: string;
+    itemType: string;
+    itemId: string;
+    itemName: string;
+    beforeChange: string;
+    afterChange: string;
+}

package/dist/lib/entities/BaseEntity.d.ts

@@ -0,0 +1,6 @@
+export declare class BaseEntity {
+    id: string;
+    createdOn: number;
+    updatedOn: number;
+    constructor(id?: string, createdOn?: number, updatedOn?: number);
+}

package/dist/lib/entities/BulkDevices.d.ts

@@ -0,0 +1,5 @@
+import { Device } from '../entities';
+export declare class BulkDevices {
+    values: Device[];
+    constructor(values?: Device[]);
+}

package/dist/lib/entities/Checkpoint.d.ts

@@ -0,0 +1,23 @@
+import { BaseEntity } from '../entities';
+export declare class Checkpoint extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    checkpoint: number;
+    firstPacketTime: number;
+    lastPacketTime: number;
+    label: string;
+    description: string;
+    elapsed: number;
+    totalFiles: number;
+    totalPackets: number;
+    totalUsage: number;
+    totalSession: number;
+    totalRadius: number;
+    overlappedPackets: number;
+    failedPackets: number;
+    irrelevantPackets: number;
+    unmappedPackets: number;
+    processedPackets: number;
+    state: number;
+    processedBy: string;
+}

package/dist/lib/entities/ComplianceReportSettings.d.ts

@@ -0,0 +1,7 @@
+export declare class ComplianceReportSettings {
+    title: string;
+    subTitle: string;
+    header: string;
+    footer: string;
+    constructor(title?: string, subTitle?: string, header?: string, footer?: string);
+}

package/dist/lib/entities/Condition.d.ts

@@ -0,0 +1,8 @@
+import { OperatorCode } from '../enums';
+export declare class Condition {
+    field: string;
+    operator: OperatorCode;
+    values: number[];
+    strings: string[];
+    constructor(field?: string, operator?: OperatorCode, values?: number[], strings?: string[]);
+}

package/dist/lib/entities/ConfigParam.d.ts

@@ -0,0 +1,4 @@
+import { BaseEntity } from '../entities';
+export declare class ConfigParam extends BaseEntity {
+    value: string;
+}