@shieldiot/pulse-lib 1.0.11 → 1.0.12

package/README.md

@@ -1,8 +1,9 @@
 # Pulse IoT client library
 
-This package is a typescript client library for the pulse IoT API
+This package is a typescript client library for the pulse IoT API.
+The library includes all the types and services exposed the the pulse API.
 
-##### Install dependencies with npm:
+## Install
 
 Install dependencies:
 `npm i`
@@ -20,7 +21,12 @@ let pc = new PulseClient("https://your-pulse-api-endpoint", "your-api-key", "you
 pc.UsrRulesService.find("streamId").pipe();
 
 ```
+The apiKey and accessToken parameters in the PulseClient constructor are optional since
+it is recomended to use HTTP interceptors to inject the API key and access token instead of constructor injection.
+
+The use of interceptor is better since for any API response, the response header includes new access toekn with
+new expiration time. Using the same token without refreshing it will eventually result access denied error after the expiration time of the original token (30 minutes).
+The use of constructor injection of access token is recomended for non-expired tokens only (system-to-system integration).
 
-It is recomended to use HTTP interceptors to inject the API key and access token
 
 

package/dist/cjs/index.js

@@ -14,7 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./config"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./lib"), exports);
 __exportStar(require("./lib/pulse-client"), exports);

package/dist/cjs/lib/index.js

@@ -19,4 +19,3 @@ __exportStar(require("./common"), exports);
 __exportStar(require("./entities"), exports);
 __exportStar(require("./enums"), exports);
 __exportStar(require("./services"), exports);
-__exportStar(require("./pulse-client"), exports);

package/dist/cjs/lib/pulse-client.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PulseClient = void 0;
 const axios_1 = __importDefault(require("axios"));
-const config_1 = require("../config");
 const utils_1 = require("../utils");
 const services_1 = require("./services");
 const services_2 = require("./services");
@@ -38,9 +37,6 @@ const services_25 = require("./services");
 class PulseClient {
     // Constructor
     constructor(apiUrl, apiKey, accessToken) {
-        this.config = new config_1.PulseConfig();
-        this.config.api = apiUrl;
-        this.config.apiKey = apiKey;
         // Set axios config
         let axiosRequestConfiguration = {
             baseURL: apiUrl,
@@ -55,31 +51,31 @@ class PulseClient {
         this.axiosInst = axios_1.default.create(axiosRequestConfiguration);
         this.restSvc = new utils_1.RestUtil(this.axiosInst);
         // initialize services
-        this.SupportStreamAnalyticsConfig = new services_1.SupportStreamAnalyticsConfig(this.config, this.restSvc);
-        this.SysAccountsService = new services_2.SysAccountsService(this.config, this.restSvc);
-        this.SysAuditLogService = new services_3.SysAuditLogService(this.config, this.restSvc);
-        this.SysCheckpointsService = new services_4.SysCheckpointsService(this.config, this.restSvc);
-        this.SysConfigService = new services_5.SysConfigService(this.config, this.restSvc);
-        this.SysFeaturesService = new services_6.SysFeaturesService(this.config, this.restSvc);
-        this.SysGroupsService = new services_7.SysGroupsService(this.config, this.restSvc);
-        this.SysInsightsService = new services_8.SysInsightsService(this.config, this.restSvc);
-        this.SysKeysService = new services_9.SysKeysService(this.config, this.restSvc);
-        this.SysMembersService = new services_10.SysMembersService(this.config, this.restSvc);
-        this.SysRuleTemplatesService = new services_11.SysRuleTemplatesService(this.config, this.restSvc);
-        this.SysRulesService = new services_12.SysRulesService(this.config, this.restSvc);
-        this.SysStatisticsService = new services_13.SysStatisticsService(this.config, this.restSvc);
-        this.SysStreamsService = new services_14.SysStreamsService(this.config, this.restSvc);
-        this.SysUsersService = new services_15.SysUsersService(this.config, this.restSvc);
-        this.UsrInsightsService = new services_16.UsrInsightsService(this.config, this.restSvc);
-        this.UsrIntegrationsService = new services_17.UsrIntegrationsService(this.config, this.restSvc);
-        this.UsrMembersService = new services_18.UsrMembersService(this.config, this.restSvc);
-        this.UsrUserService = new services_19.UsrUserService(this.config, this.restSvc);
-        this.UsrAlertsService = new services_20.UsrAlertsService(this.config, this.restSvc);
-        this.UsrDevicesService = new services_21.UsrDevicesService(this.config, this.restSvc);
-        this.UsrEventsService = new services_22.UsrEventsService(this.config, this.restSvc);
-        this.UsrNetworkService = new services_23.UsrNetworkService(this.config, this.restSvc);
-        this.UsrReportsService = new services_24.UsrReportsService(this.config, this.restSvc);
-        this.UsrRulesService = new services_25.UsrRulesService(this.config, this.restSvc);
+        this.UsrAlertsService = new services_1.UsrAlertsService(apiUrl, this.restSvc);
+        this.UsrDevicesService = new services_2.UsrDevicesService(apiUrl, this.restSvc);
+        this.UsrEventsService = new services_3.UsrEventsService(apiUrl, this.restSvc);
+        this.UsrNetworkService = new services_4.UsrNetworkService(apiUrl, this.restSvc);
+        this.UsrReportsService = new services_5.UsrReportsService(apiUrl, this.restSvc);
+        this.UsrRulesService = new services_6.UsrRulesService(apiUrl, this.restSvc);
+        this.SupportStreamAnalyticsConfig = new services_7.SupportStreamAnalyticsConfig(apiUrl, this.restSvc);
+        this.SysAccountsService = new services_8.SysAccountsService(apiUrl, this.restSvc);
+        this.SysAuditLogService = new services_9.SysAuditLogService(apiUrl, this.restSvc);
+        this.SysCheckpointsService = new services_10.SysCheckpointsService(apiUrl, this.restSvc);
+        this.SysConfigService = new services_11.SysConfigService(apiUrl, this.restSvc);
+        this.SysFeaturesService = new services_12.SysFeaturesService(apiUrl, this.restSvc);
+        this.SysGroupsService = new services_13.SysGroupsService(apiUrl, this.restSvc);
+        this.SysInsightsService = new services_14.SysInsightsService(apiUrl, this.restSvc);
+        this.SysKeysService = new services_15.SysKeysService(apiUrl, this.restSvc);
+        this.SysMembersService = new services_16.SysMembersService(apiUrl, this.restSvc);
+        this.SysRuleTemplatesService = new services_17.SysRuleTemplatesService(apiUrl, this.restSvc);
+        this.SysRulesService = new services_18.SysRulesService(apiUrl, this.restSvc);
+        this.SysStatisticsService = new services_19.SysStatisticsService(apiUrl, this.restSvc);
+        this.SysStreamsService = new services_20.SysStreamsService(apiUrl, this.restSvc);
+        this.SysUsersService = new services_21.SysUsersService(apiUrl, this.restSvc);
+        this.UsrInsightsService = new services_22.UsrInsightsService(apiUrl, this.restSvc);
+        this.UsrIntegrationsService = new services_23.UsrIntegrationsService(apiUrl, this.restSvc);
+        this.UsrMembersService = new services_24.UsrMembersService(apiUrl, this.restSvc);
+        this.UsrUserService = new services_25.UsrUserService(apiUrl, this.restSvc);
     }
 }
 exports.PulseClient = PulseClient;

package/dist/cjs/lib/services/supportStreamAnalyticsConfig.js

@@ -6,12 +6,12 @@ exports.SupportStreamAnalyticsConfig = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SupportStreamAnalyticsConfig {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/support/stream-analytics-config';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new stream analytics configuration

package/dist/cjs/lib/services/sysAccountsService.js

@@ -6,12 +6,12 @@ exports.SysAccountsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysAccountsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/accounts';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new account

package/dist/cjs/lib/services/sysAuditLogService.js

@@ -6,12 +6,12 @@ exports.SysAuditLogService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysAuditLogService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/audit-log';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Get single log entry by id

package/dist/cjs/lib/services/sysCheckpointsService.js

@@ -6,12 +6,12 @@ exports.SysCheckpointsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysCheckpointsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/checkpoints';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Get a single checkpoint entry by id

package/dist/cjs/lib/services/sysConfigService.js

@@ -6,12 +6,12 @@ exports.SysConfigService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysConfigService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/config';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new configuration parameter

package/dist/cjs/lib/services/sysFeaturesService.js

@@ -6,12 +6,12 @@ exports.SysFeaturesService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysFeaturesService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/features';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Find list of feature

package/dist/cjs/lib/services/sysGroupsService.js

@@ -6,12 +6,12 @@ exports.SysGroupsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysGroupsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/groups';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new groups

package/dist/cjs/lib/services/sysInsightsService.js

@@ -6,12 +6,12 @@ exports.SysInsightsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysInsightsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/insights';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new insight query

package/dist/cjs/lib/services/sysKeysService.js

@@ -6,12 +6,12 @@ exports.SysKeysService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysKeysService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/keys';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new API key

package/dist/cjs/lib/services/sysMembersService.js

@@ -6,12 +6,12 @@ exports.SysMembersService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysMembersService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/members';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new member

package/dist/cjs/lib/services/sysRuleTemplatesService.js

@@ -6,12 +6,12 @@ exports.SysRuleTemplatesService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysRuleTemplatesService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/rule-templates';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new rule template

package/dist/cjs/lib/services/sysRulesService.js

@@ -6,12 +6,12 @@ exports.SysRulesService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysRulesService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/rules';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new rule

package/dist/cjs/lib/services/sysStatisticsService.js

@@ -6,12 +6,12 @@ exports.SysStatisticsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysStatisticsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/statistics';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Get accounts distribution by field

package/dist/cjs/lib/services/sysStreamsService.js

@@ -6,12 +6,12 @@ exports.SysStreamsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysStreamsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/streams';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new stream

package/dist/cjs/lib/services/sysUsersService.js

@@ -6,12 +6,12 @@ exports.SysUsersService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class SysUsersService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/sys/users';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new user

package/dist/cjs/lib/services/usrAlertsService.js

@@ -6,12 +6,12 @@ exports.UsrAlertsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrAlertsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/alerts';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Get single alert by id

package/dist/cjs/lib/services/usrDevicesService.js

@@ -6,12 +6,12 @@ exports.UsrDevicesService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrDevicesService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/devices';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new device

package/dist/cjs/lib/services/usrEventsService.js

@@ -6,12 +6,12 @@ exports.UsrEventsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrEventsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/events';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Get single event by id

package/dist/cjs/lib/services/usrInsightsService.js

@@ -6,12 +6,12 @@ exports.UsrInsightsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrInsightsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/insights';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Find list of insights by day

package/dist/cjs/lib/services/usrIntegrationsService.js

@@ -6,12 +6,12 @@ exports.UsrIntegrationsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrIntegrationsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/integrations';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new integration

package/dist/cjs/lib/services/usrMembersService.js

@@ -6,12 +6,12 @@ exports.UsrMembersService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrMembersService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/members';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new member

package/dist/cjs/lib/services/usrNetworkService.js

@@ -6,12 +6,12 @@ exports.UsrNetworkService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrNetworkService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/network';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Find list of usage records by query

package/dist/cjs/lib/services/usrReportsService.js

@@ -6,12 +6,12 @@ exports.UsrReportsService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrReportsService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/reports';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new report

package/dist/cjs/lib/services/usrRulesService.js

@@ -6,12 +6,12 @@ exports.UsrRulesService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrRulesService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/rules';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Create new rule

package/dist/cjs/lib/services/usrUserService.js

@@ -6,12 +6,12 @@ exports.UsrUserService = void 0;
 // @RequestHeader X-ACCESS-TOKEN The token to identify the logged-in user 
 class UsrUserService {
     // Class constructor
-    constructor(config, rest) {
-        this.config = config;
+    constructor(apiUrl, rest) {
+        this.apiUrl = apiUrl;
         this.rest = rest;
         // URL to web api
         this.baseUrl = '/user';
-        this.baseUrl = this.config.api + this.baseUrl;
+        this.baseUrl = apiUrl + this.baseUrl;
     }
     /**
      * Authorize user, verify user exists in the system (user was already authenticated by OAuth provider)

package/dist/esm/index.js

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

package/dist/esm/lib/index.js

@@ -3,4 +3,3 @@ export * from './common';
 export * from './entities';
 export * from './enums';
 export * from './services';
-export * from './pulse-client';