@shieldiot/pulse-lib 1.0.3 → 1.0.4

package/dist/lib/services/usrEventsService.d.ts

@@ -0,0 +1,93 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { IntDistribution } from '../entities';
+import { TimeSeriesOf2D } from '../common';
+import { Event } from '../entities';
+import { SeverityTypeCode } from '../enums';
+import { EventCategoryCode } from '../enums';
+import { EventStatusCode } from '../enums';
+import { RuleTypeCode } from '../enums';
+import { EventWithDevice } from '../entities';
+import { TimeSeriesOfFloat } from '../common';
+import { MaliciousIPCard } from '../common';
+import { EventTypeCode } from '../enums';
+import { MaliciousIPData } from '../common';
+import { StringKeyValue } from '../common';
+export declare class UsrEventsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Get single event by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Event>>;
+    /**
+     * Find list of events by query
+     */
+    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>>;
+    /**
+     * Export list of events by query to a file with the specified format
+     */
+    exportFormat(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): void;
+    /**
+     * Find top 10 events by their severity filter by query
+     */
+    getTop(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<EventWithDevice>>;
+    /**
+     * Get top malicious IPs
+     */
+    getTopMaliciousIPs(streamId?: string, top?: number, from?: number, to?: number): import("rxjs").Observable<EntitiesResponse<MaliciousIPData>>;
+    /**
+     * Find events distribution by type filtered by query
+     */
+    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[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
+    /**
+     * Find events distribution by status filtered by query
+     */
+    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[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
+    /**
+     * Find events distribution by severity filtered by query
+     */
+    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[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
+    /**
+     * Find events distribution by rule filtered by query
+     */
+    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[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
+    /**
+     * Find events distribution by category filtered by query
+     */
+    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[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<IntDistribution>>;
+    /**
+     * Get current shieldex value as ActionResponse, the Key contains the shield index and the data includes the trend
+     */
+    getShieldex(): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get histogram of events over time by dimension (type | severity | status | ruleType | category)
+     */
+    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[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntityResponse<TimeSeriesOf2D>>;
+    /**
+     * Get histogram of shieldex values over time
+     */
+    shieldexTimeline(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
+    /**
+     * Export event source file
+     */
+    exportSource(id?: string): void;
+    /**
+     * Get total number devices at risk (affected by the events matching the query)
+     */
+    getTotalDevicesAtRisk(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>;
+    /**
+     * Get malicious IP data card for specific malicious IP
+     */
+    getMaliciousIpCard(streamId?: string, targetIp?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<MaliciousIPCard>>;
+    /**
+     * Apply DNS lookup for each IP in the list
+     */
+    getIpLookup(ip?: string[]): import("rxjs").Observable<EntitiesResponse<StringKeyValue>>;
+    /**
+     * Find list of events by insight id query
+     */
+    findByInsightContext(): import("rxjs").Observable<EntitiesResponse<Event>>;
+}

package/dist/lib/services/usrInsightsService.d.ts

@@ -0,0 +1,13 @@
+import { RestUtil, EntitiesResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Insight } from '../entities';
+export declare class UsrInsightsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Find list of insights by day
+     */
+    getDailyInsights(dayId?: string): import("rxjs").Observable<EntitiesResponse<Insight>>;
+}

package/dist/lib/services/usrIntegrationsService.d.ts

@@ -0,0 +1,37 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Integration } from '../entities';
+export declare class UsrIntegrationsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new integration
+     */
+    create(body?: Integration): import("rxjs").Observable<EntityResponse<Integration>>;
+    /**
+     * Update existing integration
+     */
+    update(body?: Integration): import("rxjs").Observable<EntityResponse<Integration>>;
+    /**
+     * Delete integration from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single integration by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Integration>>;
+    /**
+     * Find list of integrations by query
+     */
+    find(accountId?: string, streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Integration>>;
+    /**
+     * Validate format of the templates in the fields
+     */
+    validate(body?: Integration): import("rxjs").Observable<EntityResponse<Integration>>;
+    /**
+     * Test the integration with pseudo data
+     */
+    test(body?: Integration): import("rxjs").Observable<EntityResponse<Integration>>;
+}

package/dist/lib/services/usrMembersService.d.ts

@@ -0,0 +1,34 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { MemberRoleCode } from '../enums';
+import { Member } from '../entities';
+export declare class UsrMembersService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new member
+     */
+    create(body?: Member): import("rxjs").Observable<EntityResponse<Member>>;
+    /**
+     * Update existing member in the system
+     */
+    update(body?: Member): import("rxjs").Observable<EntityResponse<Member>>;
+    /**
+     * Delete member from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single member by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Member>>;
+    /**
+     * Find list of members by query
+     */
+    find(userId?: string, role?: MemberRoleCode[], sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Member>>;
+    /**
+     * Find list of registered emails by query
+     */
+    findEmails(search?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Member>>;
+}

package/dist/lib/services/usrNetworkService.d.ts

@@ -0,0 +1,18 @@
+import { RestUtil, EntitiesResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { UsageRecord } from '../entities';
+import { SessionRecord } from '../entities';
+export declare class UsrNetworkService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Find list of usage records by query
+     */
+    findUsage(streamId?: string, deviceId?: string, simId?: string, from?: number, to?: number, include?: number, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<UsageRecord>>;
+    /**
+     * Find list of session records by query
+     */
+    findSession(streamId?: string, deviceId?: string, simId?: string, from?: number, to?: number, include?: number, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<SessionRecord>>;
+}

package/dist/lib/services/usrReportsService.d.ts

@@ -0,0 +1,47 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Report } from '../entities';
+import { TimeSeries } from '../common';
+import { GraphSeries } from '../common';
+export declare class UsrReportsService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new report
+     */
+    create(body?: Report): import("rxjs").Observable<EntityResponse<Report>>;
+    /**
+     * Update existing report in the system
+     */
+    update(body?: Report): import("rxjs").Observable<EntityResponse<Report>>;
+    /**
+     * Delete a report from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single report by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Report>>;
+    /**
+     * Find list of reports by query
+     */
+    find(accountId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Report>>;
+    /**
+     * Get compliance report
+     */
+    getComplianceReport(streamId?: string, from?: number, to?: number): void;
+    /**
+     * Get histogram of network activity over time
+     */
+    getNetworkActivityOverTime(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<TimeSeries>>;
+    /**
+     * Get histogram of device distribution by number of destinations
+     */
+    getDeviceDistributionByNumberOfDestinations(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<GraphSeries>>;
+    /**
+     * Get histogram of device distribution by communication frequency
+     */
+    getDeviceGroupsByCommunicationFrequency(streamId?: string, from?: number, to?: number): import("rxjs").Observable<EntityResponse<GraphSeries>>;
+}

package/dist/lib/services/usrRulesService.d.ts

@@ -0,0 +1,34 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { Rule } from '../entities';
+import { TimeSeriesOfFloat } from '../common';
+export declare class UsrRulesService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Create new rule
+     */
+    create(body?: Rule): import("rxjs").Observable<EntityResponse<Rule>>;
+    /**
+     * Update existing rule in the system
+     */
+    update(body?: Rule): import("rxjs").Observable<EntityResponse<Rule>>;
+    /**
+     * Delete a rule from the system
+     */
+    delete(id?: string): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get single rule by id
+     */
+    get(id?: string): import("rxjs").Observable<EntityResponse<Rule>>;
+    /**
+     * Find list of rules by query
+     */
+    find(streamId?: string, search?: string, sort?: string, page?: number, size?: number): import("rxjs").Observable<EntitiesResponse<Rule>>;
+    /**
+     * Analyze rule configuration against historic data
+     */
+    analyze(from?: number, to?: number, interval?: number, size?: number, body?: Rule): import("rxjs").Observable<EntityResponse<TimeSeriesOfFloat>>;
+}

package/dist/lib/services/usrUserService.d.ts

@@ -0,0 +1,65 @@
+import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
+import { PulseConfig } from '../../config';
+import { LoginParams } from '../common';
+import { User } from '../entities';
+import { AccountDTO } from '../entities';
+import { Image } from '../entities';
+import { Feature } from '../entities';
+import { Stream } from '../entities';
+import { UserMemberships } from '../entities';
+export declare class UsrUserService {
+    private config;
+    private rest;
+    private baseUrl;
+    constructor(config: PulseConfig, rest: RestUtil);
+    /**
+     * Authorize user, verify user exists in the system (user was already authenticated by OAuth provider)
+     * The response includes access token valid for 20 minutes. The client side should renew the token before expiration using refresh-token method
+     */
+    authorize(body?: LoginParams): import("rxjs").Observable<EntityResponse<User>>;
+    /**
+     * Refresh token (set new expiration time) and associate with new account if required
+     * The response includes the account details and the newly refreshed token in the HTTP header X-ACCESS-TOKEN
+     */
+    setAccount(id?: string): import("rxjs").Observable<EntityResponse<AccountDTO>>;
+    /**
+     * Get the user's current account details
+     */
+    getAccount(): import("rxjs").Observable<EntityResponse<AccountDTO>>;
+    /**
+     * Get user's current account logo
+     */
+    getAccountLogo(): import("rxjs").Observable<EntityResponse<Image>>;
+    /**
+     * Get the user's current account features (aggregated list of all features in all the account's features groups)
+     */
+    getAccountFeatures(): import("rxjs").Observable<EntitiesResponse<Feature>>;
+    /**
+     * Get the user's current account streams (accessible by the user)
+     */
+    getAccountStreams(): import("rxjs").Observable<EntitiesResponse<Stream>>;
+    /**
+     * Get all the user memberships (all accounts that the current user has access to)
+     */
+    getMemberships(): import("rxjs").Observable<EntityResponse<UserMemberships>>;
+    /**
+     * Save user's avatar image
+     */
+    saveAvatar(body?: Image): import("rxjs").Observable<ActionResponse>;
+    /**
+     * Get user's avatar image
+     */
+    getAvatar(): import("rxjs").Observable<EntityResponse<Image>>;
+    /**
+     * Get arbitrary image by Id
+     */
+    getImage(id?: string): import("rxjs").Observable<EntityResponse<Image>>;
+    /**
+     * Get arbitrary image by Id as stream of bytes
+     */
+    getImageBytes(id?: string): void;
+    /**
+     * Get personal access token
+     */
+    getAccessToken(): import("rxjs").Observable<ActionResponse>;
+}

package/dist/public-api.d.ts

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

package/dist/utils/ActionResponse.d.ts

@@ -0,0 +1,5 @@
+import { BaseRestResponse } from './BaseRestResponse';
+export declare class ActionResponse extends BaseRestResponse {
+    key: string;
+    data: string;
+}

package/dist/utils/BaseRestResponse.d.ts

@@ -0,0 +1,4 @@
+export declare class BaseRestResponse {
+    code: number;
+    error: string;
+}

package/dist/utils/EntitiesResponse.d.ts

@@ -0,0 +1,8 @@
+import { BaseRestResponse } from './BaseRestResponse';
+export declare class EntitiesResponse<T> extends BaseRestResponse {
+    page: number;
+    size: number;
+    pages: number;
+    total: number;
+    list: T[];
+}

package/dist/utils/EntityResponse.d.ts

@@ -0,0 +1,8 @@
+import { BaseRestResponse } from './BaseRestResponse';
+export declare class EntityResponse<T> extends BaseRestResponse {
+    page: number;
+    size: number;
+    pages: number;
+    total: number;
+    entity: T;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ActionResponse';
+export * from './BaseRestResponse';
+export * from './EntityResponse';
+export * from './EntitiesResponse';
+export * from './rest-util';

package/dist/utils/rest-axios-setup.d.ts

@@ -0,0 +1,3 @@
+import { AxiosRequestConfig, AxiosInstance } from 'axios';
+declare const initialization: (config: AxiosRequestConfig) => AxiosInstance;
+export default initialization;

package/dist/utils/rest-util.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from 'axios';
+import { Observable } from 'rxjs';
+export declare class RestUtil {
+    axiosInstance: AxiosInstance;
+    constructor(axiosInst: AxiosInstance);
+    upload<T>(file: File, url: string, ...params: string[]): void;
+    download(fileName: string, url: string, ...params: string[]): void;
+    get<T>(url: string, ...params: string[]): Observable<T>;
+    post<T>(url: string, body?: string, ...params: string[]): Observable<T>;
+    put<T>(url: string, body?: string, ...params: string[]): Observable<T>;
+    patch<T>(url: string, body?: string, ...params: string[]): Observable<T>;
+    delete<T>(url: string, ...params: string[]): Observable<T>;
+    private buildUrl;
+    private getMimeType;
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@shieldiot/pulse-lib",
   "author": "Shield IoT",
   "license": "ISC",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "A TypeScript library for the pulse-api based on axios",
   "main": "dist/index.js",
   "type": "module",

package/tsconfig.json

@@ -17,7 +17,7 @@
     // "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": false,                      /* Generates corresponding '.d.ts' file. */
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
     "sourceMap": true,                        /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
@@ -56,7 +56,7 @@
     // "types": [],                           /* Type declaration files to be included in compilation. */
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
     // "resolveJsonModule": true,
-    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    "esModuleInterop": true                   /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
     // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */