@shieldiot/pulse-lib 1.0.5 → 1.0.7

package/src/lib/enums/SeverityTypeCode.ts

@@ -1,40 +0,0 @@
-
-// Severity type (level) code
-export enum SeverityTypeCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Low severity [1] 
-    LOW = 1,
- 
-    // Medium severity [2] 
-    MEDIUM = 2,
- 
-    // High severity [3] 
-    HIGH = 3,
- 
-    // Critical severity [4] 
-    CRITICAL = 4,
- 
-}
-
-// Return list of SeverityTypeCode values and their display names
-export function GetSeverityTypeCodes() : Map<SeverityTypeCode, string> {
-
-    let result = new Map<SeverityTypeCode, string>();
-
-    
-    result.set(SeverityTypeCode.UNDEFINED, 'Undefined');
-    
-    result.set(SeverityTypeCode.LOW, 'Low');
-    
-    result.set(SeverityTypeCode.MEDIUM, 'Medium');
-    
-    result.set(SeverityTypeCode.HIGH, 'High');
-    
-    result.set(SeverityTypeCode.CRITICAL, 'Critical');
-    
-
-    return result;
-}

package/src/lib/enums/TrafficDirectionCode.ts

@@ -1,35 +0,0 @@
-
-// Account type code
-export enum TrafficDirectionCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // Denotes inbound network traffic  [1] 
-    INBOUND = 1,
- 
-    // Denotes outbound network traffic [2] 
-    OUTBOUND = 2,
- 
-    // Denotes bidirectional network traffic [3] 
-    INOUT = 3,
- 
-}
-
-// Return list of TrafficDirectionCode values and their display names
-export function GetTrafficDirectionCodes() : Map<TrafficDirectionCode, string> {
-
-    let result = new Map<TrafficDirectionCode, string>();
-
-    
-    result.set(TrafficDirectionCode.UNDEFINED, 'Undefined');
-    
-    result.set(TrafficDirectionCode.INBOUND, 'Inbound');
-    
-    result.set(TrafficDirectionCode.OUTBOUND, 'Outbound');
-    
-    result.set(TrafficDirectionCode.INOUT, 'Inout');
-    
-
-    return result;
-}

package/src/lib/enums/UserStatusCode.ts

@@ -1,40 +0,0 @@
-
-// User status code
-export enum UserStatusCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // User is registered and pending verification [1] 
-    PENDING = 1,
- 
-    // Active user in the system [2] 
-    ACTIVE = 2,
- 
-    // Blocked user (only account system can unblock the user) [4] 
-    BLOCKED = 3,
- 
-    // Suspended user (about to be deleted) [8] 
-    SUSPENDED = 4,
- 
-}
-
-// Return list of UserStatusCode values and their display names
-export function GetUserStatusCodes() : Map<UserStatusCode, string> {
-
-    let result = new Map<UserStatusCode, string>();
-
-    
-    result.set(UserStatusCode.UNDEFINED, 'Undefined');
-    
-    result.set(UserStatusCode.PENDING, 'Pending');
-    
-    result.set(UserStatusCode.ACTIVE, 'Active');
-    
-    result.set(UserStatusCode.BLOCKED, 'Blocked');
-    
-    result.set(UserStatusCode.SUSPENDED, 'Suspended');
-    
-
-    return result;
-}

package/src/lib/enums/UserTypeCode.ts

@@ -1,40 +0,0 @@
-
-// User type code
-export enum UserTypeCode {
- 
-    // Undefined [0] 
-    UNDEFINED = 0,
- 
-    // System administrator has access to all accounts and permissions to perform all actions [1] 
-    SYSADMIN = 1,
- 
-    // Support user has view permissions only for all accounts that enabled option Enable Support [2] 
-    SUPPORT = 2,
- 
-    // Account user - has access to specific accounts with role based access control [3] 
-    USER = 3,
- 
-    // Account service - to be used by other systems to perform actions using the API (can't login as a user to the portal)' [4]` 
-    SERVICE = 4,
- 
-}
-
-// Return list of UserTypeCode values and their display names
-export function GetUserTypeCodes() : Map<UserTypeCode, string> {
-
-    let result = new Map<UserTypeCode, string>();
-
-    
-    result.set(UserTypeCode.UNDEFINED, 'Undefined');
-    
-    result.set(UserTypeCode.SYSADMIN, 'Sysadmin');
-    
-    result.set(UserTypeCode.SUPPORT, 'Support');
-    
-    result.set(UserTypeCode.USER, 'User');
-    
-    result.set(UserTypeCode.SERVICE, 'Service');
-    
-
-    return result;
-}

package/src/lib/enums/index.ts

@@ -1,29 +0,0 @@
-export * from './AccountStatusCode';
-export * from './AccountTypeCode';
-export * from './DataSourceCode';
-export * from './DeviceActionCode';
-export * from './DeviceCreationCode';
-export * from './DeviceIdentityCode';
-export * from './DeviceStatusCode';
-export * from './DeviceTypeCode';
-export * from './DirectionContextCode';
-export * from './EventCategoryCode';
-export * from './EventStatusCode';
-export * from './EventTypeCode';
-export * from './FeatureCode';
-export * from './HomePageViewCode';
-export * from './HttpMethodCode';
-export * from './InsightStatusCode';
-export * from './InsightTypeCode';
-export * from './IntegrationTriggerCode';
-export * from './IntegrationTypeCode';
-export * from './MemberRoleCode';
-export * from './NetworkMapTypeCode';
-export * from './OperatorCode';
-export * from './PermissionCode';
-export * from './ReportTypeCode';
-export * from './RuleTypeCode';
-export * from './SeverityTypeCode';
-export * from './TrafficDirectionCode';
-export * from './UserStatusCode';
-export * from './UserTypeCode';

package/src/lib/index.ts

@@ -1,4 +0,0 @@
-export * from './common';
-export * from './entities';
-export * from './enums';
-export * from './services';

package/src/lib/pulse-client.ts

@@ -1,190 +0,0 @@
-import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { PulseConfig } from "../config";
-import { RestUtil } from "../utils";
-
-import { SupportStreamAnalyticsConfig } from "./services";
-import { SysAccountsService } from "./services";
-import { SysAuditLogService } from "./services";
-import { SysCheckpointsService } from "./services";
-import { SysConfigService } from "./services";
-import { SysFeaturesService } from "./services";
-import { SysGroupsService } from "./services";
-import { SysInsightsService } from "./services";
-import { SysKeysService } from "./services";
-import { SysMembersService } from "./services";
-import { SysRuleTemplatesService } from "./services";
-import { SysRulesService } from "./services";
-import { SysStatisticsService } from "./services";
-import { SysStreamsService } from "./services";
-import { SysUsersService } from "./services";
-import { UsrInsightsService } from "./services";
-import { UsrIntegrationsService } from "./services";
-import { UsrMembersService } from "./services";
-import { UsrUserService } from "./services";
-import { UsrAlertsService } from "./services";
-import { UsrDevicesService } from "./services";
-import { UsrEventsService } from "./services";
-import { UsrNetworkService } from "./services";
-import { UsrReportsService } from "./services";
-import { UsrRulesService } from "./services";
-
-
-// PulseClient is the main entry point of the client library.
-// Create a single global instance of PulseClient in your application and use
-// Factory methods to get service endpoints
-export class PulseClient {
-
-    config: PulseConfig;
-    restSvc: RestUtil;
-    axiosInst: AxiosInstance;
-
-    // Constructor
-    constructor(apiUrl: string, apiKey: string, accessToken: string) {
-        this.config = new PulseConfig();
-        this.config.api = apiUrl;
-        this.config.apiKey = apiKey;
-
-        // Set axios config
-        let axiosRequestConfiguration: AxiosRequestConfig = {
-            baseURL: apiUrl,
-            responseType: 'json',
-            headers: {
-                'Content-Type': 'application/json',
-                'X-API-KEY': apiKey,
-                'X-ACCESS-TOKEN': accessToken,
-            },
-        };
-        // Set axios instance
-        this.axiosInst = axios.create(axiosRequestConfiguration);
-        this.restSvc = new RestUtil(this.axiosInst);
-    }
-
-
-    
-    // Factory method for SupportStreamAnalyticsConfig
-    public SupportStreamAnalyticsConfig(): SupportStreamAnalyticsConfig {
-        return new SupportStreamAnalyticsConfig(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysAccountsService
-    public SysAccountsService(): SysAccountsService {
-        return new SysAccountsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysAuditLogService
-    public SysAuditLogService(): SysAuditLogService {
-        return new SysAuditLogService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysCheckpointsService
-    public SysCheckpointsService(): SysCheckpointsService {
-        return new SysCheckpointsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysConfigService
-    public SysConfigService(): SysConfigService {
-        return new SysConfigService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysFeaturesService
-    public SysFeaturesService(): SysFeaturesService {
-        return new SysFeaturesService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysGroupsService
-    public SysGroupsService(): SysGroupsService {
-        return new SysGroupsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysInsightsService
-    public SysInsightsService(): SysInsightsService {
-        return new SysInsightsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysKeysService
-    public SysKeysService(): SysKeysService {
-        return new SysKeysService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysMembersService
-    public SysMembersService(): SysMembersService {
-        return new SysMembersService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysRuleTemplatesService
-    public SysRuleTemplatesService(): SysRuleTemplatesService {
-        return new SysRuleTemplatesService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysRulesService
-    public SysRulesService(): SysRulesService {
-        return new SysRulesService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysStatisticsService
-    public SysStatisticsService(): SysStatisticsService {
-        return new SysStatisticsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysStreamsService
-    public SysStreamsService(): SysStreamsService {
-        return new SysStreamsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for SysUsersService
-    public SysUsersService(): SysUsersService {
-        return new SysUsersService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrInsightsService
-    public UsrInsightsService(): UsrInsightsService {
-        return new UsrInsightsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrIntegrationsService
-    public UsrIntegrationsService(): UsrIntegrationsService {
-        return new UsrIntegrationsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrMembersService
-    public UsrMembersService(): UsrMembersService {
-        return new UsrMembersService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrUserService
-    public UsrUserService(): UsrUserService {
-        return new UsrUserService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrAlertsService
-    public UsrAlertsService(): UsrAlertsService {
-        return new UsrAlertsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrDevicesService
-    public UsrDevicesService(): UsrDevicesService {
-        return new UsrDevicesService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrEventsService
-    public UsrEventsService(): UsrEventsService {
-        return new UsrEventsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrNetworkService
-    public UsrNetworkService(): UsrNetworkService {
-        return new UsrNetworkService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrReportsService
-    public UsrReportsService(): UsrReportsService {
-        return new UsrReportsService(this.config, this.restSvc);
-    }
-    
-    // Factory method for UsrRulesService
-    public UsrRulesService(): UsrRulesService {
-        return new UsrRulesService(this.config, this.restSvc);
-    }
-    
-
-}

package/src/lib/services/index.ts

@@ -1,26 +0,0 @@
-export * from './services.export';
-export * from './supportStreamAnalyticsConfig';
-export * from './sysAccountsService';
-export * from './sysAuditLogService';
-export * from './sysCheckpointsService';
-export * from './sysConfigService';
-export * from './sysFeaturesService';
-export * from './sysGroupsService';
-export * from './sysInsightsService';
-export * from './sysKeysService';
-export * from './sysMembersService';
-export * from './sysRuleTemplatesService';
-export * from './sysRulesService';
-export * from './sysStatisticsService';
-export * from './sysStreamsService';
-export * from './sysUsersService';
-export * from './usrAlertsService';
-export * from './usrDevicesService';
-export * from './usrEventsService';
-export * from './usrInsightsService';
-export * from './usrIntegrationsService';
-export * from './usrMembersService';
-export * from './usrNetworkService';
-export * from './usrReportsService';
-export * from './usrRulesService';
-export * from './usrUserService';

package/src/lib/services/services.export.ts

@@ -1,54 +0,0 @@
-import { SupportStreamAnalyticsConfig } from './supportStreamAnalyticsConfig';
-import { SysAccountsService } from './sysAccountsService';
-import { SysAuditLogService } from './sysAuditLogService';
-import { SysCheckpointsService } from './sysCheckpointsService';
-import { SysConfigService } from './sysConfigService';
-import { SysFeaturesService } from './sysFeaturesService';
-import { SysGroupsService } from './sysGroupsService';
-import { SysInsightsService } from './sysInsightsService';
-import { SysKeysService } from './sysKeysService';
-import { SysMembersService } from './sysMembersService';
-import { SysRuleTemplatesService } from './sysRuleTemplatesService';
-import { SysRulesService } from './sysRulesService';
-import { SysStatisticsService } from './sysStatisticsService';
-import { SysStreamsService } from './sysStreamsService';
-import { SysUsersService } from './sysUsersService';
-import { UsrInsightsService } from './usrInsightsService';
-import { UsrIntegrationsService } from './usrIntegrationsService';
-import { UsrMembersService } from './usrMembersService';
-import { UsrUserService } from './usrUserService';
-import { UsrAlertsService } from './usrAlertsService';
-import { UsrDevicesService } from './usrDevicesService';
-import { UsrEventsService } from './usrEventsService';
-import { UsrNetworkService } from './usrNetworkService';
-import { UsrReportsService } from './usrReportsService';
-import { UsrRulesService } from './usrRulesService';
-
-export const Services = [
-    SupportStreamAnalyticsConfig,
-    SysAccountsService,
-    SysAuditLogService,
-    SysCheckpointsService,
-    SysConfigService,
-    SysFeaturesService,
-    SysGroupsService,
-    SysInsightsService,
-    SysKeysService,
-    SysMembersService,
-    SysRuleTemplatesService,
-    SysRulesService,
-    SysStatisticsService,
-    SysStreamsService,
-    SysUsersService,
-    UsrInsightsService,
-    UsrIntegrationsService,
-    UsrMembersService,
-    UsrUserService,
-    UsrAlertsService,
-    UsrDevicesService,
-    UsrEventsService,
-    UsrNetworkService,
-    UsrReportsService,
-    UsrRulesService,
-    
-]

package/src/lib/services/supportStreamAnalyticsConfig.ts

@@ -1,63 +0,0 @@
-import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
-import { PulseConfig } from '../../config';
-
-import { StreamAnalyticsConfig } from '../entities';
-
-
-
-// List of AI support related actions for system support only 
-// @RequestHeader X-API-KEY The key to identify the application (console) 
-// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
-export class SupportStreamAnalyticsConfig {
-
-  // URL to web api
-  private baseUrl = '/support/stream-analytics-config';
-
-  // Class constructor
-  constructor(private config: PulseConfig, private rest: RestUtil) {
-    this.baseUrl = this.config.api + this.baseUrl;
-  }
-
-
-  /**
-   * Create new stream analytics configuration
-   */
-  create(body?: StreamAnalyticsConfig) {
-    return this.rest.put<EntityResponse<StreamAnalyticsConfig>>(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
-  }
-
-  /**
-   * Update existing stream analytics configuration
-   */
-  update(body?: StreamAnalyticsConfig) {
-    return this.rest.patch<EntityResponse<StreamAnalyticsConfig>>(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
-  }
-
-  /**
-   * Delete stream analytics configuration from the system
-   */
-  delete(id?: string) {
-    return this.rest.delete<ActionResponse>(`${this.baseUrl}/${id}`);
-  }
-
-  /**
-   * Get single stream analytics configuration by stream id
-   */
-  get(id?: string) {
-    return this.rest.get<EntityResponse<StreamAnalyticsConfig>>(`${this.baseUrl}/${id}`);
-  }
-
-  /**
-   * Find list of stream analytics configurations by query
-   */
-  find(search?: string, sort?: string, page?: number, size?: number) {
-    const params = [];		
-    if (search != null) { params.push(`search=${search}`); }
-    if (sort != null) { params.push(`sort=${sort}`); }
-    if (page != null) { params.push(`page=${page}`); }
-    if (size != null) { params.push(`size=${size}`); }
-
-		return this.rest.get<EntitiesResponse<StreamAnalyticsConfig>>(`${this.baseUrl}`, ...params);
-  }
-
-}

package/src/lib/services/sysAccountsService.ts

@@ -1,90 +0,0 @@
-import { RestUtil, EntityResponse, EntitiesResponse, ActionResponse } from '../../utils';
-import { PulseConfig } from '../../config';
-
-import { AccountStatusCode } from '../enums';
-import { Image } from '../entities';
-import { Account } from '../entities';
-import { AccountSettings } from '../entities';
-import { AccountTypeCode } from '../enums';
-
-
-
-// List of account related actions for system administrator only 
-// @RequestHeader X-API-KEY The key to identify the application (console) 
-// @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
-export class SysAccountsService {
-
-  // URL to web api
-  private baseUrl = '/sys/accounts';
-
-  // Class constructor
-  constructor(private config: PulseConfig, private rest: RestUtil) {
-    this.baseUrl = this.config.api + this.baseUrl;
-  }
-
-
-  /**
-   * Create new account
-   */
-  create(body?: Account) {
-    return this.rest.put<EntityResponse<Account>>(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
-  }
-
-  /**
-   * Update existing account in the system
-   */
-  update(body?: Account) {
-    return this.rest.patch<EntityResponse<Account>>(`${this.baseUrl}`, typeof body === 'object' ? JSON.stringify(body) : body);
-  }
-
-  /**
-   * Update existing account settings in the system
-   */
-  updateSettings(body?: AccountSettings) {
-    return this.rest.patch<ActionResponse>(`${this.baseUrl}/{id}`, typeof body === 'object' ? JSON.stringify(body) : body);
-  }
-
-  /**
-   * Delete account from the system and all its related content
-   */
-  delete(id?: string) {
-    return this.rest.delete<ActionResponse>(`${this.baseUrl}/${id}`);
-  }
-
-  /**
-   * Get single account by id
-   */
-  get(id?: string) {
-    return this.rest.get<EntityResponse<Account>>(`${this.baseUrl}/${id}`);
-  }
-
-  /**
-   * Find list of accounts by query
-   */
-  find(search?: string, type?: AccountTypeCode[], status?: AccountStatusCode[], sort?: string, page?: number, size?: number) {
-    const params = [];		
-    if (search != null) { params.push(`search=${search}`); }
-    if (type != null) { params.push(`type=${type}`); }
-    if (status != null) { params.push(`status=${status}`); }
-    if (sort != null) { params.push(`sort=${sort}`); }
-    if (page != null) { params.push(`page=${page}`); }
-    if (size != null) { params.push(`size=${size}`); }
-
-		return this.rest.get<EntitiesResponse<Account>>(`${this.baseUrl}`, ...params);
-  }
-
-  /**
-   * Save account's logo image
-   */
-  saveLogo() {
-    return this.rest.patch<ActionResponse>(`${this.baseUrl}/logo`, '');
-  }
-
-  /**
-   * Get account's logo image
-   */
-  getLogo(id?: string) {
-    return this.rest.get<EntityResponse<Image>>(`${this.baseUrl}/logo`);
-  }
-
-}