augnitoambientsdk - npm Package Compare versions

Comparing version 2.0.2 to 2.0.3

package.json

 {
   "name": "augnitoambientsdk",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Use this typescript SDK to integrate Augnito’s Ambient Tech within your EMR. To get access credentials or know more about how Augnito Ambient can benefit you, please visit our website and connect with our sales team: https://augnito.ai/",
@@ -5,0 +5,0 @@ "main": "dist/augnitoambientsdk.js",

README.md

@@ -9,4 +9,12 @@ # Augnito Ambient SDK
 
-      npm install augnitoambientsdk
+### [Typescript](#tab/tab-ts)
 
+```js
+npm install augnitoambientsdk
+```
+
+### [Vanilla JS](#tab/tab-js)
+
+use https://cdn.jsdelivr.net/npm/augnitoambientsdk@latest/dist/augnitoambientsdk.js to import the library from npm using CDN url.
+
 ## Basic Usage
@@ -16,2 +24,4 @@
 
+### [Typescript](#tab/tab-ts)
+
 ```js
@@ -21,2 +31,8 @@ import { AugnitoAmbient, AmbientConfig } from "augnitoambientsdk";
 
+### [Vanilla JS](#tab/tab-js)
+
+```js
+import { AugnitoAmbient } from "https://cdn.jsdelivr.net/npm/augnitoambientsdk@latest/dist/augnitoambientsdk.js";
+```
+
 ### Create the configuration file and instantiate Augnito Ambient Manager
@@ -55,12 +71,5 @@
 
+  ### [Typescript](#tab/tab-ts)
+
   ```js
-  /** Response JSON for each item of speciality and visit type
-   * ID: number,
-   * ConfigID: number,
-   * Value: string,
-   * Description: string,
-   * IsSelected: boolean,
-   * IsDefault: boolean
-   */
-
   //Get list of specialities enabled for organisation
@@ -70,3 +79,18 @@ const specialities = await augnitoAmbient.getUserConfiguration(
   );
+  ```
 
+  ### [Vanilla JS](#tab/tab-js)
+
+  ```js
+  import { SettingsConfigType } from "https://cdn.jsdelivr.net/npm/augnitoambientsdk@latest/dist/augnitoambientsdk.js";
+
+  //Get list of specialities enabled for organisation
+  const specialities = await augnitoAmbient.getUserConfiguration(
+    SettingsConfigType["SPECIALITY"]
+  );
+  ```
+
+  ### [Typescript](#tab/tab-ts)
+
+  ```js
   //Get list of visit types enabled for organisation
@@ -78,2 +102,24 @@ const visitTypes = await augnitoAmbient.getUserConfiguration(
 
+  ### [Vanilla JS](#tab/tab-js)
+
+  ```js
+  import { SettingsConfigType } from "https://cdn.jsdelivr.net/npm/augnitoambientsdk@latest/dist/augnitoambientsdk.js";
+
+  //Get list of visit types enabled for organisation
+  const visitTypes = await augnitoAmbient.getUserConfiguration(
+    SettingsConfigType["VISIT_TYPE"]
+  );
+  ```
+
+  Response JSON for each item of speciality and visit type has the following structure
+
+  ```js
+  ID: number;
+  ConfigID: number;
+  Value: string;
+  Description: string;
+  IsSelected: boolean;
+  IsDefault: boolean;
+  ```
+
 ### 2- Toggle the client
@@ -100,3 +146,3 @@
 );
-example: augnitoAmbient.toggleListening("wav","{'Region': 1, 'Speciality': 11, 'NoteType': 1, 'VisitType':29, 'Gender': 0}")
+example: augnitoAmbient.toggleListening("wav",`{"Region": 1, "Speciality": 11, "NoteType": 1, "VisitType":29, "Gender": 0}`)
 
@@ -111,3 +157,3 @@ //Toggles the Pause/Resume recording
 );
-example: augnitoAmbient.togglePauseResumeListening("wav","{'Region': 1, 'Speciality': 11, 'NoteType': 1, 'VisitType':29, 'Gender': 0}")
+example: augnitoAmbient.togglePauseResumeListening("wav",`{"Region": 1, "Speciality": 11, "NoteType": 1, "VisitType":29, "Gender": 0}`)
 ```
@@ -114,0 +160,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

108892

increased by1.06%

Number of lines in readme file

334

increased by15.97%

No dependency changes