@shieldiot/ngx-pulseiot-lib 2.18.1119 → 2.18.1120

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/esm2022/lib/services/UsrEventsService.mjs +178 -16
  2. package/fesm2022/shieldiot-ngx-pulseiot-lib.mjs +177 -15
  3. package/fesm2022/shieldiot-ngx-pulseiot-lib.mjs.map +1 -1
  4. package/lib/services/UsrEventsService.d.ts +25 -22
  5. package/package.json +1 -1
package/lib/services/UsrEventsService.d.ts CHANGED
@@ -1,19 +1,22 @@
1
1
  import { RestUtils } from '../../rest-utils';
2
2
  import { AppConfig } from '../../config';
3
- import { EventTypeCode } from '../model';
4
- import { SeverityTypeCode } from '../model';
5
3
  import { EventWithDevice } from '../model';
6
- import { Tuple } from '../model';
7
- import { MaliciousIpCard } from '../model';
8
- import { SimpleEntity } from '../model';
9
- import { EntityResponse } from '../model';
10
- import { Event } from '../model';
11
- import { EntitiesResponse } from '../model';
12
- import { Device } from '../model';
13
4
  import { MaliciousIPData } from '../model';
14
5
  import { Distribution } from '../model';
15
- import { ActionResponse } from '../model';
16
6
  import { TimeSeries } from '../model';
7
+ import { Device } from '../model';
8
+ import { EntityResponse } from '../model';
9
+ import { EventCategoryCode } from '../model';
10
+ import { ActionResponse } from '../model';
11
+ import { MaliciousIpCard } from '../model';
12
+ import { Event } from '../model';
13
+ import { EventTypeCode } from '../model';
14
+ import { EventStatusCode } from '../model';
15
+ import { RuleTypeCode } from '../model';
16
+ import { SimpleEntity } from '../model';
17
+ import { SeverityTypeCode } from '../model';
18
+ import { EntitiesResponse } from '../model';
19
+ import { Tuple } from '../model';
17
20
  import * as i0 from "@angular/core";
18
21
  export declare class UsrEventsService {
19
22
  private config;
@@ -27,11 +30,11 @@ export declare class UsrEventsService {
27
30
  /**
28
31
  * Find events by query
29
32
  */
30
- find(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Device>>;
33
+ find(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Event>>;
31
34
  /**
32
35
  * Export events by query to a file in a stream of CSV | JSON | XML | XLSX
33
36
  */
34
- export(format?: string, streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<import("@angular/common/http").HttpEvent<Blob>>;
37
+ export(format?: string, streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<import("@angular/common/http").HttpEvent<Blob>>;
35
38
  /**
36
39
  * Export event source file as a stream of source file (pcap)
37
40
  */
@@ -39,31 +42,31 @@ export declare class UsrEventsService {
39
42
  /**
40
43
  * Get top 10 events by their severity and time
41
44
  */
42
- findTop(streamId?: string, deviceId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<EventWithDevice>>;
45
+ findTop(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<EventWithDevice>>;
43
46
  /**
44
47
  * Get top 10 events by their severity and time
45
48
  */
46
- findTopMaliciousIPs(streamId?: string, top?: number): import("rxjs").Observable<EntityResponse<MaliciousIPData>>;
49
+ findTopMaliciousIPs(streamId?: string, top?: number, from?: number, to?: number): import("rxjs").Observable<EntityResponse<MaliciousIPData>>;
47
50
  /**
48
51
  * Get events distribution by type filtered by query
49
52
  */
50
- countByType(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
53
+ countByType(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
51
54
  /**
52
55
  * Get events distribution by status filtered by query
53
56
  */
54
- countByStatus(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
57
+ countByStatus(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
55
58
  /**
56
59
  * Get events distribution by severity filtered by query
57
60
  */
58
- countBySeverity(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
61
+ countBySeverity(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
59
62
  /**
60
63
  * Get events distribution by rule filtered by query
61
64
  */
62
- countByRule(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
65
+ countByRule(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
63
66
  /**
64
67
  * Get events distribution by category filtered by query
65
68
  */
66
- countByCategory(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
69
+ countByCategory(streamId?: string, deviceId?: string, alertId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<EntityResponse<Distribution<number>>>;
67
70
  /**
68
71
  * Get current shield as ActionResponse, the Key contains the shield index and the data includes the trend
69
72
  */
@@ -71,15 +74,15 @@ export declare class UsrEventsService {
71
74
  /**
72
75
  * Get events histogram over the provided time period
73
76
  */
74
- eventsTimeline(streamId?: string, deviceId?: string, alertId?: string, dimension?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<EntityResponse<TimeSeries<Tuple<number, number>[]>>>;
77
+ eventsTimeline(streamId?: string, deviceId?: string, alertId?: string, dimension?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<EntityResponse<TimeSeries<Tuple<number, number>[]>>>;
75
78
  /**
76
79
  * Get shieldex histogram over the provided time period
77
80
  */
78
- shieldexTimeline(streamId?: string): import("rxjs").Observable<EntityResponse<TimeSeries<number>>>;
81
+ shieldexTimeline(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<TimeSeries<number>>>;
79
82
  /**
80
83
  * Get devices at risk number for specific events criteria
81
84
  */
82
- getDevicesAtRisk(streamId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[]): import("rxjs").Observable<ActionResponse>;
85
+ getDevicesAtRisk(streamId?: string, search?: string, from?: number, to?: number, type?: EventTypeCode[], severity?: SeverityTypeCode[], category?: EventCategoryCode[], status?: EventStatusCode[], ruleId?: string[], targetIp?: string, ruleType?: RuleTypeCode[]): import("rxjs").Observable<ActionResponse>;
83
86
  /**
84
87
  * Get malicious IP data card for specific malicious IP
85
88
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shieldiot/ngx-pulseiot-lib",
3
- "version": "2.18.1119",
3
+ "version": "2.18.1120",
4
4
  "description": "Angular client library for PulseIoT backend",
5
5
  "publishConfig": {
6
6
  "access": "public"