@shieldiot/pulse-lib 1.0.9 → 1.0.11

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

@@ -0,0 +1,99 @@
+import { defer, map } from 'rxjs';
+// Utility class for all REST services with common functions
+export 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 defer(() => this.axiosInstance.get(resourceUrl))
+            .pipe(map((result) => result.data));
+    }
+    // HTTP POST action
+    post(url, body, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return defer(() => this.axiosInstance.post(resourceUrl, body))
+            .pipe(map((result) => result.data));
+    }
+    // HTTP PUT action
+    put(url, body, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return defer(() => this.axiosInstance.put(resourceUrl, body))
+            .pipe(map((result) => result.data));
+    }
+    // HTTP PATCH action
+    patch(url, body, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return defer(() => this.axiosInstance.patch(resourceUrl, body))
+            .pipe(map((result) => result.data));
+    }
+    // HTTP DELETE action
+    delete(url, ...params) {
+        const resourceUrl = this.buildUrl(url, ...params);
+        return defer(() => this.axiosInstance.delete(resourceUrl))
+            .pipe(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;
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './config';
+export * from './utils';
+export * from './lib';
+export * from './lib/pulse-client';

package/dist/types/lib/base/index.d.ts

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

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

@@ -0,0 +1,24 @@
+import { Interval } from '../common';
+import { SeverityConditionConfig } from '../common';
+import { RuleCountThresholdConfig } from '../common';
+import { RuleBasedSeverityConditionConfig } from '../common';
+export declare class DeviceScoreConfig {
+    deviceScoreAlphaFactor: number;
+    occurrenceThreshold: number;
+    ruleCountThreshold: number;
+    lowWeightAlphaFactor: number;
+    mediumWeightAlphaFactor: number;
+    highWeightAlphaFactor: number;
+    highVolumeWeightAlphaFactor: number;
+    abnormalOutPortsAlphaFactor: number;
+    abnormalOutEndpointsAlphaFactor: number;
+    suspiciousIpAlphaFactor: number;
+    defaultSeverityRange: Interval;
+    defaultSeverityFactor: number;
+    severityConditionConfigs: SeverityConditionConfig[];
+    ruleCountThresholdConfigs: RuleCountThresholdConfig[];
+    ruleBasedSeverityConditionConfigs: RuleBasedSeverityConditionConfig[];
+    isSeverityBased: boolean;
+    isAlertBased: boolean;
+    constructor(deviceScoreAlphaFactor?: number, occurrenceThreshold?: number, ruleCountThreshold?: number, lowWeightAlphaFactor?: number, mediumWeightAlphaFactor?: number, highWeightAlphaFactor?: number, highVolumeWeightAlphaFactor?: number, abnormalOutPortsAlphaFactor?: number, abnormalOutEndpointsAlphaFactor?: number, suspiciousIpAlphaFactor?: number, defaultSeverityRange?: Interval, defaultSeverityFactor?: number, severityConditionConfigs?: SeverityConditionConfig[], ruleCountThresholdConfigs?: RuleCountThresholdConfig[], ruleBasedSeverityConditionConfigs?: RuleBasedSeverityConditionConfig[], isSeverityBased?: boolean, isAlertBased?: boolean);
+}

package/dist/types/lib/common/RuleBasedSeverityConditionConfig.d.ts

@@ -0,0 +1,9 @@
+import { SeverityTypeCode } from '../enums';
+import { RuleCountThresholdConfig } from '../common';
+export declare class RuleBasedSeverityConditionConfig {
+    severityType: SeverityTypeCode;
+    bias: number;
+    ruleConditionThresholdConfig: RuleCountThresholdConfig[];
+    ruleTypesThreshold: number;
+    constructor(severityType?: SeverityTypeCode, bias?: number, ruleConditionThresholdConfig?: RuleCountThresholdConfig[], ruleTypesThreshold?: number);
+}

package/dist/types/lib/common/RuleCountThresholdConfig.d.ts

@@ -0,0 +1,6 @@
+import { EventTypeCode } from '../enums';
+export declare class RuleCountThresholdConfig {
+    eventType: EventTypeCode;
+    threshold: number;
+    constructor(eventType?: EventTypeCode, threshold?: number);
+}

package/dist/types/lib/common/SeverityConditionConfig.d.ts

@@ -0,0 +1,10 @@
+import { SeverityTypeCode } from '../enums';
+import { Interval } from '../common';
+export declare class SeverityConditionConfig {
+    conditionSeverity: SeverityTypeCode;
+    sevs: SeverityTypeCode[];
+    countTH: number;
+    severityFactor: number;
+    severityRange: Interval;
+    constructor(conditionSeverity?: SeverityTypeCode, sevs?: SeverityTypeCode[], countTH?: number, severityFactor?: number, severityRange?: Interval);
+}

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

@@ -0,0 +1,12 @@
+import { MemberRoleCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { UserTypeCode } 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/types/lib/common/index.d.ts

@@ -0,0 +1,44 @@
+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 './RuleBasedSeverityConditionConfig';
+export * from './RuleCountThresholdConfig';
+export * from './SeriesData';
+export * from './SessionTransform';
+export * from './SeverityConditionConfig';
+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';

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

@@ -0,0 +1,17 @@
+import { AccountTypeCode } from '../enums';
+import { AccountStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+import { BaseEntity } from '../base';
+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/types/lib/entities/AccountDTO.d.ts

@@ -0,0 +1,19 @@
+import { AccountTypeCode } from '../enums';
+import { AccountStatusCode } from '../enums';
+import { FeatureCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { AccountSettings } from '../entities';
+import { BaseEntity } from '../base';
+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/types/lib/entities/Alert.d.ts

@@ -0,0 +1,34 @@
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { RuleTypeCode } from '../enums';
+import { TrafficDirectionCode } from '../enums';
+import { BaseEntity } from '../base';
+import { EventTypeCode } from '../enums';
+import { GeoData } from '../common';
+import { StringKeyValue } from '../common';
+import { EventCategoryCode } 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/types/lib/entities/AlertWithDevice.d.ts

@@ -0,0 +1,36 @@
+import { EventTypeCode } from '../enums';
+import { TrafficDirectionCode } from '../enums';
+import { Device } from '../entities';
+import { StringKeyValue } from '../common';
+import { EventCategoryCode } from '../enums';
+import { BaseEntity } from '../base';
+import { SeverityTypeCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { RuleTypeCode } from '../enums';
+import { GeoData } from '../common';
+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/types/lib/entities/ConfigParam.d.ts

@@ -0,0 +1,6 @@
+import { BaseEntity } from '../base';
+export declare class ConfigParam extends BaseEntity {
+    inputType: string;
+    group: string;
+    value: string;
+}

package/dist/types/lib/entities/ConfigParams.d.ts

@@ -0,0 +1,5 @@
+import { ConfigParam } from '../entities';
+import { BaseEntity } from '../base';
+export declare class ConfigParams extends BaseEntity {
+    params: ConfigParam[];
+}

package/dist/types/lib/entities/Device.d.ts

@@ -0,0 +1,30 @@
+import { SIM } from '../entities';
+import { BaseEntity } from '../base';
+import { DeviceTypeCode } from '../enums';
+import { DeviceStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { DeviceActionCode } from '../enums';
+export declare class Device extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    externalId: string;
+    name: string;
+    description: string;
+    country: string;
+    operator: string;
+    type: DeviceTypeCode;
+    status: DeviceStatusCode;
+    lastActivity: number;
+    mac: string;
+    ip: string;
+    sid: string;
+    eid: string;
+    score: number;
+    tags: string[];
+    labels: StringKeyValue[];
+    eventCount: number;
+    actionApplied: DeviceActionCode;
+    actionAppliedBy: string;
+    actionAppliedOn: number;
+    simCards: SIM[];
+}

package/dist/types/lib/entities/DeviceWithEvents.d.ts

@@ -0,0 +1,32 @@
+import { Event } from '../entities';
+import { BaseEntity } from '../base';
+import { DeviceTypeCode } from '../enums';
+import { DeviceStatusCode } from '../enums';
+import { StringKeyValue } from '../common';
+import { DeviceActionCode } from '../enums';
+import { SIM } from '../entities';
+export declare class DeviceWithEvents extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    externalId: string;
+    name: string;
+    description: string;
+    country: string;
+    operator: string;
+    type: DeviceTypeCode;
+    status: DeviceStatusCode;
+    lastActivity: number;
+    mac: string;
+    ip: string;
+    sid: string;
+    eid: string;
+    score: number;
+    tags: string[];
+    labels: StringKeyValue[];
+    eventCount: number;
+    actionApplied: DeviceActionCode;
+    actionAppliedBy: string;
+    actionAppliedOn: number;
+    simCards: SIM[];
+    events: Event[];
+}

package/dist/types/lib/entities/Event.d.ts

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

package/dist/types/lib/entities/EventOccurrence.d.ts

@@ -0,0 +1,10 @@
+import { Indicator } from '../common';
+import { TrafficDirectionCode } from '../enums';
+export declare class EventOccurrence {
+    timestamp: number;
+    source: string;
+    sourceIp: string;
+    indicators: Indicator[];
+    trafficDirection: TrafficDirectionCode;
+    constructor(timestamp?: number, source?: string, sourceIp?: string, indicators?: Indicator[], trafficDirection?: TrafficDirectionCode);
+}

package/dist/types/lib/entities/EventWithDevice.d.ts

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

package/dist/types/lib/entities/Radius.d.ts

@@ -0,0 +1,15 @@
+import { BaseEntity } from '../base';
+import { StringKeyValue } from '../common';
+export declare class Radius extends BaseEntity {
+    source: string;
+    accountId: string;
+    streamId: string;
+    assignedOn: number;
+    mac: string;
+    ip: string;
+    sid: string;
+    eid: string;
+    country: string;
+    operator: string;
+    attributes: StringKeyValue[];
+}

package/dist/types/lib/entities/Rule.d.ts

@@ -0,0 +1,27 @@
+import { RuleTypeCode } from '../enums';
+import { DataSourceCode } from '../enums';
+import { Condition } from '../entities';
+import { DeviceTypeCode } from '../enums';
+import { EventTypeCode } from '../enums';
+import { SeverityTypeCode } from '../enums';
+import { BaseEntity } from '../base';
+export declare class Rule extends BaseEntity {
+    accountId: string;
+    streamId: string;
+    name: string;
+    type: RuleTypeCode;
+    description: string;
+    isSystemRule: boolean;
+    isActiveRule: boolean;
+    context: DataSourceCode;
+    matchAll: Condition[];
+    matchAny: Condition[];
+    excludeIDs: string[];
+    excludeTags: string[];
+    excludeTypes: DeviceTypeCode[];
+    timeWindowSec: number;
+    setEventType: EventTypeCode;
+    setEventSeverity: SeverityTypeCode;
+    lastAlertTimestamp: number;
+    alertsCount: number;
+}

package/dist/types/lib/entities/StreamAnalyticsConfig.d.ts

@@ -0,0 +1,12 @@
+import { Thresholds } from '../common';
+import { ShieldexConfig } from '../common';
+import { EventSeverityConfig } from '../common';
+import { DeviceConfig } from '../common';
+import { BaseEntity } from '../base';
+export declare class StreamAnalyticsConfig extends BaseEntity {
+    accountId: string;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    deviceConfig: DeviceConfig;
+}

package/dist/types/lib/entities/StreamConfig.d.ts

@@ -0,0 +1,19 @@
+import { EventSeverityConfig } from '../common';
+import { DeviceActionCode } from '../enums';
+import { DeviceConfig } from '../common';
+import { DataIngestion } from '../entities';
+import { SessionTransform } from '../common';
+import { UsageTransform } from '../common';
+import { Thresholds } from '../common';
+import { ShieldexConfig } from '../common';
+export declare class StreamConfig {
+    ingest: DataIngestion;
+    sessionTransform: SessionTransform;
+    usageTransform: UsageTransform;
+    thresholds: Thresholds;
+    shieldexConfig: ShieldexConfig;
+    eventSeverityConfig: EventSeverityConfig;
+    preventiveActions: DeviceActionCode[];
+    deviceConfig: DeviceConfig;
+    constructor(ingest?: DataIngestion, sessionTransform?: SessionTransform, usageTransform?: UsageTransform, thresholds?: Thresholds, shieldexConfig?: ShieldexConfig, eventSeverityConfig?: EventSeverityConfig, preventiveActions?: DeviceActionCode[], deviceConfig?: DeviceConfig);
+}

package/dist/types/lib/entities/User.d.ts

@@ -0,0 +1,16 @@
+import { StringKeyValue } from '../common';
+import { BaseEntity } from '../base';
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+export declare class User extends BaseEntity {
+    name: string;
+    externalId: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    labels: StringKeyValue[];
+    groups: string;
+}

package/dist/types/lib/entities/UserMembership.d.ts

@@ -0,0 +1,14 @@
+import { BaseEntity } from '../base';
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { AccountRole } from '../common';
+export declare class UserMembership extends BaseEntity {
+    name: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    accountRole: AccountRole;
+}

package/dist/types/lib/entities/UserMemberships.d.ts

@@ -0,0 +1,14 @@
+import { UserTypeCode } from '../enums';
+import { UserStatusCode } from '../enums';
+import { AccountRole } from '../common';
+import { BaseEntity } from '../base';
+export declare class UserMemberships extends BaseEntity {
+    name: string;
+    email: string;
+    mobile: string;
+    type: UserTypeCode;
+    status: UserStatusCode;
+    defaultAccount: string;
+    lastSignIn: number;
+    accountRoles: AccountRole[];
+}