augnitosdk - npm Package Compare versions

Comparing version 0.0.20 to 0.0.22

dist/Augnito.d.ts

@@ -50,2 +50,8 @@ import { AugnitoConfig } from './config/AugnitoConfig';
     onIdleMic?: () => void;
+    /**
+     * Callback triggered when trying to start the connection, but it fails because it is already opened.
+     * It can happen if the client has more than one tab opened.
+     * @param isWebClient If true, the error was raised from the Web Client; otherwise from the mobile client
+     */
+    onMicrophoneOnError?: (isWebClient: boolean) => void;
     constructor(config: AugnitoConfig);
@@ -77,2 +83,7 @@ private get enableLogs();
     initMobileClient(config?: AugnitoMobileConfig): AugnitoMobile;
+    /**
+     * Sends a request to close all opened connections.
+     * To be used in case the Augnito client is instantiated in multiple tabs
+     */
+    requestMicOff(): void;
     /** Returns an Abstract Factory to create different API Clients */
@@ -92,4 +103,6 @@ get apisFactory(): FactoryAPI;
     private onSessionEventCallback;
+    private onMicrophoneOnErrorCallback;
     private createSDKConfig;
     private createWorker;
+    private handleStorageChangeEvent;
 }

dist/client/WebClient.d.ts

@@ -64,3 +64,4 @@ import { SDKConfig } from '../config/SDKConfig';
     private onReadyForSpeech;
+    private onMicrophoneOnError;
 }
 export { WebClient };

dist/commands/AugnitoCommands.d.ts

@@ -68,5 +68,10 @@ declare enum AugnitoCommands {
     BOLD_PREVIOUS_WORD = "boldpreviousword",
+    BOLD_LAST_LINE = "boldlastline",
     DELETE_NEXT_WORD = "deletenextword",
     DELETE_PREVIOUS_LINE = "deletepreviousline",
     SELECT_PREVIOUS_LINE = "selectpreviousline",
+    BOLD_PREVIOUS_LINE = "boldpreviousline",
+    UNDERLINE_PREVIOUS_LINE = "underlinepreviousline",
+    ITALICIZE_PREVIOUS_LINE = "italicizepreviousline",
+    CAPITALIZE_PREVIOUS_LINE = "capitalizepreviousline",
     SELECT_NEXT_LINE = "selectnextline",
@@ -73,0 +78,0 @@ SETFONTSIZEN = "setfontsize",

dist/commands/AugnitoCommandsStatic.d.ts

@@ -1,2 +0,2 @@
-import { PrepareCommandRecipe, ActionRecipe } from '../recipe/ActionRecipe';
+import { ActionRecipe, PrepareCommandRecipe } from '../recipe/ActionRecipe';
 declare abstract class AugnitoCommandsStatic {
@@ -3,0 +3,0 @@ static createGoToDocumentEndCommand(): Partial<ActionRecipe>;

dist/config/IConfiguration .d.ts

@@ -30,2 +30,7 @@ /**
     setAccessKey(accessKey: string): void;
+    /**
+     * Enables/Disables the logs for the current instance
+     * @param enableLogs True if the logs are enabled; otherwise false
+     */
+    setEnableLogs(enableLogs: boolean): void;
 }

dist/config/SDKConfig.d.ts

@@ -29,2 +29,3 @@ import { AugnitoConfig } from './AugnitoConfig';
     onError?: (e: AugnitoSDKError, data: string) => void;
+    onMicrophoneOnError?: (isWebClient: boolean) => void;
     constructor(_config: AugnitoConfig);
@@ -36,2 +37,3 @@ setLmId(lmId: string): void;
     setAccessKey(accessKey: string): void;
+    setEnableLogs(enableLogs: boolean): void;
     get clientConfig(): AugnitoConfig;
@@ -38,0 +40,0 @@ get enableLogs(): boolean | undefined;

dist/config/SDKConfigMobile.d.ts

@@ -10,2 +10,3 @@ import { WebClient } from '../client/WebClient';
     private _webClient;
+    onMicrophoneOnError?: (isWebClient: boolean) => void;
     constructor(_config: AugnitoMobileConfig, _webClient: WebClient);
@@ -12,0 +13,0 @@ get clientConfig(): AugnitoMobileConfig;

dist/interop/core/EditorType.d.ts

 declare enum EditorType {
     HTML = 1,
-    CKEDITOR4 = 2
+    CKEDITOR4 = 2,
+    GENERIC = 99
 }
 export { EditorType };

dist/interop/core/ProcessorFactory.d.ts

 import { CKEditor4InteropProcessor } from '../processors/CKEditor4InteropProcessor';
+import { GenericInteropProcessor } from '../processors/GenericInteropProcessor';
 import { HTMLInteropProcessor } from '../processors/HTMLInteropProcessor';
 import { EditorType } from './EditorType';
 export declare class ProcessorFactory {
-    static createProcessor(editorType: EditorType, enableLogs: boolean): HTMLInteropProcessor | CKEditor4InteropProcessor;
+    static createProcessor(editorType: EditorType, enableLogs: boolean): HTMLInteropProcessor | CKEditor4InteropProcessor | GenericInteropProcessor;
 }

package.json

 {
   "name": "augnitosdk",
   "private": false,
-  "version": "0.0.20",
+  "version": "0.0.22",
   "license": "Restricted",
@@ -23,4 +23,6 @@ "files": [
     "clean": "rm -rf ./dist/* ",
+    "clean-win": "if exist dist rd /s /q dist",
     "build-typescript": "npm run clean && tsc",
     "build": "npm run clean && rollup -c",
+    "build-debug": "npm run clean-win && rollup -c rollup.debug.config.js",
     "test": "jest --coverage"
@@ -27,0 +29,0 @@ },

README.md

@@ -45,2 +45,12 @@ # Augnito Speech SDK
 
+> _Note_: If the client does not start, it may be that **_onMicrophoneOnError_** was called. This was implemented to prevent a user from opening a conection in multiple tabs. You can use **_requestMicOff_** to force close other connections.
+
+```js
+augnito.onMicrophoneOnError = (isWebClient: boolean) => {
+  //If you want to use Augnito in this tab.
+  augnito.requestMicOff();
+  augnito.toggleListening();
+};
+```
+
 ## Mobile Application
@@ -66,10 +76,11 @@
 
-| Name            | type                                  | Description                                                                                                                  |
-| --------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| onPartialResult | (text: string) => void                | Partial Result generated from the server                                                                                     |
-| onFinalResult   | (finalText: Recipe) => boolean        | A final result is called when text has been processed by the Speech Server. Returns `true` to stop the processing in the SDK |
-| onCommandResult | (command: Recipe) => boolean          | A command generated from the server. Returns `true` to stop the processing in the SDK                                        |
-| onStateChanged  | (isConnected: boolean) => void        | Callback to indicate the status of the connection has changed.                                                               |
-| onSessionEvent  | (data: AugnitoSocketResponse) => void | Callback to intercept Session Events                                                                                         |
-| onIdleMic       | () => void                            | Callback when the Mic is idle for 5 minutes                                                                                  |
+| Name                | type                                  | Description                                                                                                                                                         |
+| ------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| onPartialResult     | (text: string) => void                | Partial Result generated from the server                                                                                                                            |
+| onFinalResult       | (finalText: Recipe) => boolean        | A final result is called when text has been processed by the Speech Server. Returns `true` to stop the processing in the SDK                                        |
+| onCommandResult     | (command: Recipe) => boolean          | A command generated from the server. Returns `true` to stop the processing in the SDK                                                                               |
+| onStateChanged      | (isConnected: boolean) => void        | Callback to indicate the status of the connection has changed.                                                                                                      |
+| onSessionEvent      | (data: AugnitoSocketResponse) => void | Callback to intercept Session Events                                                                                                                                |
+| onIdleMic           | () => void                            | Callback when the Mic is idle for 5 minutes                                                                                                                         |
+| onMicrophoneOnError | (isWebClient: boolean) => void        | Callback triggered when trying to start the connection, but it fails because it is already opened. (It can be opened in another tab, or it was not closed properly) |
 
@@ -93,2 +104,3 @@ ## Augnito Mobile - Speech Related Callbacks
 | apisFactory      | FactoryAPI    | Returns an Abstract Factory to create different API Clients.                                                                     |
+| requestMicOff    | void          | Sends a request to close all opened connections.                                                                                 |
 
@@ -95,0 +107,0 @@ ## MacrosAPI

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

296168

increased by2.45%

Number of package files

57

increased by3.64%

Lines of code

2415

increased by3.47%

Number of lines in readme file

140

increased by9.38%

No dependency changes