@shieldiot/pulse-lib 1.0.12 → 1.0.14

package/README.md

@@ -3,30 +3,76 @@
 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
+###### Install
 
-Install dependencies:
-`npm i`
-
-Build package:
-`npm run build`
+Install client library:
+```typescript
+npm i @shieldiot/pulse-lib
+```
 
 
 ##### How to use:
+To use the library, first create a PulseClient instance with the API endpoint URL and optionally the API key and Accesss Token.
 
+> 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 the preferred approach 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).
+
+
+Example: how to search list of devices:
 ```typescript
-import { Account, PulseClient } from 'pulse-lib'
+import { PulseClient } from '@shieldiot/pulse-lib'
+
+
+function searchDevices() : void{
+
+    const apiUrl: string = "http://myaccount-api.pulseiot.io/v1";
+    const apiKey: string = "your_api_key";
+    const accessToken: string = "your_access_token";
 
-let pc = new PulseClient("https://your-pulse-api-endpoint", "your-api-key", "your-access-token");
-pc.UsrRulesService.find("streamId").pipe();
+    // It is recomended to use a single instance of PulseClient for the entire application
+    let cli = new PulseClient(apiUrl, apiKey, accessToken);
+
+    // remember to release the subject: sub to avoid memory leaks
+    let sub = cli.UsrDevicesService.find("streamId").subscribe({
+        next: (res) => console.log("process response", res)
+    });
+};
 
 ```
-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).
+Example2: how to add account:
+```typescript
+import { Account, AccountTypeCode, PulseClient } from '@shieldiot/pulse-lib'
+
+function createAccount() : void{
+
+    const apiUrl: string = "http://myaccount-api.pulseiot.io/v1";
+    const apiKey: string = "your_api_key";
+    const accessToken: string = "your_access_token";
+
+    // It is recomended to use a single instance of PulseClient for the entire application
+    let cli = new PulseClient(apiUrl, apiKey, accessToken);
+
+    // Add account
+    let account = new Account("id");
+    account.name = "new account";
+    account.description = "account description";
+    account.type = AccountTypeCode.CUSTOMER;
+
+    // remember to release the subject: sub to avoid memory leaks
+    let sub = cli.SysAccountsService.create(account).subscribe({
+        next: (res) => console.log("process response", res)
+    });
+};
+
+```
 
+##### Best Practices
 
+* Use a single instance of the PulseClient (as a singleton) for the entire application to avoid high memory consumption since this instance initializes all the pulse services that can be access as readonly properties.
+* All the service methods return a generic typed Observable (e.g. `Observable<EntitiesResponse<Device>>`) that can be used in async manner in the UI or with the subscribe method in the code. Always remember to delete the subject of the subscribe to avoid memory leaks.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shieldiot/pulse-lib",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -32,13 +32,9 @@
   ],
   "author": "Motty Cohen <motty.cohen@shieldiot.io>",
   "license": "MIT",
-  "homepage": "https://github.com/shieldiot/pulse-lib-example",
   "repository": {
     "type": "git",
-    "url": "git@github.com:shieldiot/pulse-lib-example.git"
-  },
-  "bugs": {
-    "url": "https://github.com/shieldiot/pulse-lib-example/issues"
+    "url": "git@bitbucket.org:shieldiot/pulse-dsl.git"
   },
   "dependencies": {
     "axios": "^1.7.7",
@@ -47,7 +43,6 @@
   "devDependencies": {
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
-    "@types/jest": "^29.5.13",
     "@typescript-eslint/eslint-plugin": "^8.8.1",
     "@typescript-eslint/parser": "^8.8.1",
     "eslint": "^9.12.0",
@@ -59,4 +54,4 @@
     "webpack": "^5.95.0",
     "webpack-cli": "^5.1.4"
   }
-}
+}