testaugnitosdk2 1.0.12

package/dist/client/MobileClient.d.ts

@@ -0,0 +1,17 @@
+import { SDKConfigMobile } from '../config/SDKConfigMobile';
+import { NotificationClient } from './NotificationClient';
+export declare class MobileClient {
+    private _config;
+    private _notificationClient;
+    private _logTag;
+    /** Callback when a mobile client is requesting to connect */
+    onConnectionRequest?: () => void;
+    /** Callback when a mobile client has scanned the QR Code */
+    onMobileScan?: () => void;
+    constructor(_config: SDKConfigMobile, _notificationClient: NotificationClient);
+    dispose(): void;
+    private onMobileScanCallback;
+    private onConnectionRequestCallback;
+    private createWebSocketForMobileMic;
+    stopMobileListening(): void;
+}

package/dist/client/NotificationClient.d.ts

@@ -0,0 +1,25 @@
+import { AugnitoAppNotification, AugnitoMobileSocketResponse } from '../support/AugnitoMobileSocketResponse';
+import { SDKConfigMobile } from '../config/SDKConfigMobile';
+export declare class NotificationClient {
+    private _config;
+    private _logTag;
+    /** Callback when a mobile client is requesting to connect */
+    onConnectionRequest?: (augnitoResponse: AugnitoMobileSocketResponse) => void;
+    /** Callback when a mobile client has scanned the QR Code */
+    onMobileScan?: () => void;
+    /** Callback when vocabulary has been added to the model **/
+    onVocabularyAdded?: (notification: AugnitoAppNotification) => void;
+    private _pushNotificationSocket;
+    get notificationSocket(): WebSocket | null;
+    constructor(_config: SDKConfigMobile);
+    Send(message: string): void;
+    ensureNotificationClientConnected(): void;
+    createNotificationClient(): void;
+    private createNotificationSocket;
+    closeMobileWebSocket(): boolean;
+    dispose(): void;
+    private onMobileScanCallback;
+    private onVocabularyAddedCallback;
+    private onConnectionRequestCallback;
+    getReplyMessage(JSONResponse: AugnitoMobileSocketResponse, messageType: string): string;
+}

package/dist/client/PhilipsMicClient.d.ts

@@ -0,0 +1,17 @@
+import { PhilipsMicConfig } from '../config/PhilipsMicConfig';
+export declare class PhilipsMicClient {
+    private _config;
+    private _enableLogs?;
+    private _logTag;
+    private intervalInMillis;
+    private isRecodingIsPressed;
+    private counter;
+    private WasMicStartedByPressToSpeak;
+    onPhilipsMicPressed?: (isStart: boolean | undefined) => void;
+    constructor(_config: PhilipsMicConfig, _enableLogs?: boolean | undefined);
+    getConnectedPhilipsDeviceName: (idStr: any) => string;
+    gamepadCallBack: () => void;
+    private HandlePushToTalk;
+    private CheckForRECPressed;
+    private onPhilipsMicPressedCallback;
+}

package/dist/client/WebClient.d.ts

@@ -0,0 +1,59 @@
+import { SDKConfig } from '../config/SDKConfig';
+import { AugnitoSource } from '../support/AugnitoSource';
+/**
+ * Augnito Web SDK Client
+ */
+declare class WebClient {
+    private _logTag;
+    private _speechSocket;
+    private _isConnecting;
+    private _config;
+    constructor(config: SDKConfig);
+    isConnecting(): boolean;
+    /**
+     * Returns the connected state
+     * @returns true, if the socket state is OPEN; otherwise false
+     */
+    get connected(): boolean;
+    /**
+     * Retrieves the client SDK configuration
+     * @returns The SDKConfig
+     */
+    getConfig(): SDKConfig;
+    /**
+     * Toggles the Speech API connection
+     * @description if already connected, it will stop the web socket; otherwise, it will start a new connection
+     */
+    toggleListening(): void;
+    /**
+     * @description
+     * Creates Augnito Client
+     *
+     * @param {String} socketURL The URL of the socket
+     * @param {AugnitoSource} source The source of the application
+     */
+    startListening(socketURL: string, source: AugnitoSource): void;
+    /**
+     * Stops the web socket if the connection is alive.
+     * @param alertEndOfSession If true, EndOfSession event will be fired.
+     * @returns
+     */
+    stopListening(alertEndOfSession: boolean): void;
+    /**
+     * closes all sockets and streams
+     */
+    dispose(): void;
+    private createWebSocket;
+    private clearAll;
+    private closeWebSocket;
+    private onPartialText;
+    private onEvent;
+    private onError;
+    private onSocketPartialResult;
+    private onSocketFinalResult;
+    private onSessionEvent;
+    private onEndOfSession;
+    private onReadyForSpeech;
+    private onMicrophoneOnError;
+}
+export { WebClient };

package/dist/commands/AugnitoCommands.d.ts

@@ -0,0 +1,93 @@
+declare enum AugnitoCommands {
+    BOLD_IT = "boldit",
+    UN_BOLD_IT = "unboldit",
+    UNDERLINE_IT = "underlineit",
+    ITALICIZE_IT = "italicizeit",
+    UNITALICIZE_IT = "unitalicizeit",
+    COPY_IT = "copyit",
+    CUT_IT = "cutit",
+    PASTE_IT = "pasteit",
+    PRESS_DELETE = "pressdelete",
+    HEADER_IT = "headerit",
+    CAPITALIZED_IT = "capitalizeit",
+    UN_CAPITALIZED_IT = "uncapitalizeit",
+    UNDO_IT = "undoit",
+    REDO_IT = "redoit",
+    SELECT_PREVIOUS_WORD = "selectpreviousword",
+    SELECT_NEXT_WORD = "selectnextword",
+    SELECT_WORD = "selectword",
+    SELECT_ALL = "selectall",
+    SELECT = "select",
+    DESELECT_IT = "deselectit",
+    GO_TO_LINE_START = "gotolinestart",
+    GO_TO_LINE_END = "gotolineend",
+    SELECT_ACTIVE_LINE = "selectactiveline",
+    SELECT_ACTIVE_PARAGRAPH = "selectactiveparagraph",
+    SELECT_ACTIVE_WORD = "selectactiveword",
+    SELECT_ACTIVE_SENTENCE = "selectactivesentence",
+    SELECT_ACTIVE_CHAR = "selectactivechar",
+    BULLET_LIST_START = "bulletliststart",
+    NUMBER_LIST_START = "numberliststart",
+    BULLET_LIST_STOP = "bulletliststop",
+    NUMBER_LIST_STOP = "numberliststop",
+    LIST_STOP = "stoplist",
+    ALIGN_LEFT = "alignleft",
+    ALIGN_RIGHT = "alignright",
+    ALIGN_CENTER = "aligncenter",
+    ALIGN_JUSTIFY = "alignjustify",
+    STOP_MIC = "stopmic",
+    GO_UP = "goup",
+    GO_DOWN = "godown",
+    GO_RIGHT = "goright",
+    GO_LEFT = "goleft",
+    TAB_SPACE_ADD = "tabspaceadd",
+    SPACE_ADD = "spaceadd",
+    BACKSPACE = "backspace",
+    START_BOLD_TEXT = "boldstart",
+    STOP_BOLD_TEXT = "boldstop",
+    GO_TO_DOCUMENT_START = "gotodocumentstart",
+    GO_TO_DOCUMENT_END = "gotodocumentend",
+    GO_TO_NEXT_PAGE = "gotonextpage",
+    GO_TO_PREVIOUS_PAGE = "gotopreviouspage",
+    OK = "ok",
+    DOCUMENT_SAVE = "documentsave",
+    DOCUMENT_PRINT = "documentprint",
+    NEW_DOCUMENT = "newdocument",
+    SELECT_PARAGRAPH = "paragraph",
+    NEXT_LINE_TEXT = "@newline@",
+    SELECT_LINE = "selectline",
+    SELECT_CHAR = "char",
+    SELECT_SENTENCE = "selectsentence",
+    DELETE = "delete",
+    GOTO = "goto",
+    DELETE_PREVIOUS_WORD = "deletepreviousword",
+    UNDERLIE_PREVIOUS_WORD = "underlinepreviousword",
+    CAPITALIZE_PREVIOUS_WORD = "capitalizepreviousword",
+    ITALICIZE_PREVIOUS_WORD = "italicizepreviousword",
+    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",
+    SELECT_PREVIOUS_PARAGRAPH = "selectpreviousparagraph",
+    SELECT_NEXT_PARAGRAPH = "selectnextparagraph",
+    SETFONTSIZEN = "setfontsize",
+    INSERT_BEFORE_TEXT = "insertbefore",
+    INSERT_AFTER_TEXT = "insertafter",
+    DELETE_PREVIOUS_SENTENCE = "deleteprevioussentence",
+    SELECT_PREVIOUS_SENTENCE = "selectprevioussentence",
+    SELECT_NEXT_SENTENCE = "selectnextsentence",
+    START_CAPITAL_TEXT = "capitalizestart",
+    STOP_CAPITAL_TEXT = "capitalizestop",
+    NEXT_FIELD = "dynamicfieldnext",
+    PREVIOUS_FIELD = "dynamicfieldprevious",
+    GET_ORDER = "getorder",
+    ADD_MEDICINE = "addmedicine",
+    NUMBER = "number"
+}
+export { AugnitoCommands };

package/dist/commands/AugnitoCommandsRegex.d.ts

@@ -0,0 +1,9 @@
+import { PrepareCommandRecipe, ActionRecipe } from '../recipe/ActionRecipe';
+declare abstract class AugnitoCommandsRegex {
+    static prepareRecipe(command: PrepareCommandRecipe): Partial<ActionRecipe>;
+    static fillDynamicCommand(recipe: Partial<ActionRecipe>, commandText: string): Partial<ActionRecipe>;
+    static setActionCommandVariant(cmdAction: string): string;
+    static setActiveObjectType(item: string): string;
+    static setSelectObjectType(item: string): string;
+}
+export { AugnitoCommandsRegex };

package/dist/commands/AugnitoCommandsStatic.d.ts

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

package/dist/commands/AugnitoCustomCommands.d.ts

@@ -0,0 +1,8 @@
+import { PrepareCommandRecipe, ActionRecipe } from '../recipe/ActionRecipe';
+import { CustomCommandModel } from './utils/CustomCommandModel';
+declare abstract class AugnitoCustomCommands {
+    static dynamicList: CustomCommandModel[] | undefined;
+    static addCommand(commandName: string, functionParam?: any, callback?: (param?: any) => void): void;
+    static prepareCustomCommandRecipe(command: PrepareCommandRecipe): Partial<ActionRecipe | null>;
+}
+export { AugnitoCustomCommands };

package/dist/commands/index.d.ts

@@ -0,0 +1 @@
+export * from './AugnitoCommands';

package/dist/commands/utils/CustomCommandModel.d.ts

@@ -0,0 +1,5 @@
+export interface CustomCommandModel {
+    CommandName: string;
+    CustomCallback?: (paramter?: any) => void;
+    CustomCallbackParameter: any;
+}

package/dist/commands/utils/TextToWordInteger.d.ts

@@ -0,0 +1,5 @@
+declare class TextWordToInteger {
+    private _wordToDigit;
+    parse(word: string): number;
+}
+export { TextWordToInteger };

package/dist/config/AugnitoConfig.d.ts

@@ -0,0 +1,113 @@
+import { PhilipsMicMode } from '../interop';
+import { EditorType } from '../interop/core/EditorType';
+import { TargetEditor } from '../interop/core/TargetEditor';
+/**
+ * Augnito Client Configuration
+ */
+interface AugnitoConfig {
+    /**
+     * Server configuration: India, UK, US
+     * @description Mandatory field
+     */
+    server: string | AugnitoAPIServer;
+    /**
+     * Application's Acccount Code
+     * @description Mandatory field
+     */
+    accountCode: string;
+    /**
+     * Application's Access Key
+     * @description Mandatory field
+     */
+    accessKey: string;
+    /**
+     * Language Model Id
+     * @description Mandatory field
+     */
+    lmId: string;
+    /**
+     * Optional Field: Enables or Disables Logging system
+     * @description True if logs are enabled; Otherwise false
+     */
+    enableLogs?: boolean;
+    /**
+     * Unique identifier of the current user (from client application)
+     * @description Mandatory field
+     */
+    userTag: string;
+    /**
+     * The name of the current Application
+     * @description Mandatory field
+     */
+    sourceApp: string;
+    /**
+     * Optional Field: To set noise cancellation value
+     * @description default value is 1,
+     */
+    noiseCt?: string;
+    /**
+     * Optional Field: To be used with Augnito Mobile SDK
+     * DeviceId should be provided if mobile client is going to be created.
+     */
+    deviceId?: string;
+    /**
+     * Optional Field: Client application can pass an encrypted login token via this
+     * parameter which may represent user login timestamp.
+     */
+    loginToken?: string;
+    /**
+     * Optional Field: The client application can pass any name of component, application window, microphone
+     * identifier, etc. to tag to a speech session. This information may be used for later analysis.
+     */
+    otherInfo?: string;
+    /**
+     * The list of valid editors
+     */
+    listOfControls?: TargetEditor[];
+    /**
+     * Sets the editor WYSIWYG editor
+     */
+    editor?: EditorType;
+    /**
+     * Sets PhilipsMic push to talk or hands free mode
+     */
+    philipsMicMode?: PhilipsMicMode;
+    /**
+     * Require early initialisation of recorder mic to start listening immediately on mic start
+     */
+    earlyInitialiseRecorder?: boolean;
+    /**
+     * Require early initialisation and streaming of audio which is dictated just before resuming mic. The value indicates interval (in seconds) of audio which needs to be streamed while resuming mic
+     */
+    pauseStateBufferInterval?: number;
+    /**
+     * Sets rate (in milliseconds) at which toggleListening is executed by delaying its invocation, default being 300ms
+     */
+    debounceDelay?: number;
+    /**
+       * Sets regular speech profile
+       */
+    switchToRegularSpeechProfile?: boolean;
+}
+/**
+ * Speech API Server
+ */
+declare enum AugnitoAPIServer {
+    /**
+     * Augnito's India Server
+     */
+    INDIA = 0,
+    /**
+     * Augnito's United Kingdom Server
+     */
+    UK = 1,
+    /**
+     * Augnito's United States Server
+     */
+    US = 2,
+    /**
+     * Augnito's Saudi Arabia Server
+     */
+    KSA = 3
+}
+export { AugnitoConfig, AugnitoAPIServer };

package/dist/config/AugnitoFormattingConfig.d.ts

@@ -0,0 +1,10 @@
+export interface AugnitoFormattingConfig {
+    UserCode: string;
+    SubscriptionCode: string;
+    AccessKey: string;
+    SmId: string;
+    DeviceCode: string | undefined;
+    SourceApp: string;
+    Server: string;
+    enableLogs?: boolean;
+}

package/dist/config/AugnitoMobileConfig.d.ts

@@ -0,0 +1,7 @@
+export interface AugnitoMobileConfig {
+    /**
+     * Optional Field: Enables or Disables Logging system
+     * @description True if logs are enabled; Otherwise false
+     */
+    enableLogs?: boolean;
+}

package/dist/config/AugnitoVocabularyConfig.d.ts

@@ -0,0 +1,10 @@
+export interface AugnitoVocabularyConfig {
+    UserCode: string;
+    SubscriptionCode: string;
+    AccessKey: string;
+    SmId: string;
+    DeviceCode: string | undefined;
+    SourceApp: string;
+    Server: string;
+    enableLogs?: boolean;
+}

package/dist/config/ConfigValidator.d.ts

@@ -0,0 +1,15 @@
+import { WebClient } from '../client/WebClient';
+import { AugnitoConfig } from './AugnitoConfig';
+import { AugnitoMobileConfig } from './AugnitoMobileConfig';
+/**
+ * Validates the augnito config has all the mandatory fields
+ * @param config The config sent by the client application
+ */
+declare const validateConfig: (config: AugnitoConfig) => AugnitoConfig;
+/**
+ * Validates the mobile augnito config has all the mandatory fields
+ * @param webClient The AugnitoClient
+ * @param config The config sent by the client application
+ */
+declare const validateMobileConfig: (webClient: WebClient, config: AugnitoMobileConfig) => AugnitoMobileConfig;
+export { validateConfig, validateMobileConfig };

package/dist/config/IConfiguration .d.ts

@@ -0,0 +1,35 @@
+/**
+ * Represents an entry point for application configuration properties
+ */
+export interface IConfiguration {
+    /**
+     * Sets the Language model to be used
+     * @param lmId The new language model
+     */
+    setLmId(lmId: string): void;
+    /**
+     * Sets a custom speech url to be used to open the socket connection
+     * @param speechURL The new SpeechURL
+     */
+    setSpeechURL(speechURL: string): void;
+    /**
+     * Sets a custom domain name to be used to open the socket connection
+     * @param domainName The new Domain Name
+     */
+    setDomainName(domainName: string): void;
+    /**
+     * Sets the Account Code to be used
+     * @param accountCode The new Account code
+     */
+    setAccountCode(accountCode: string): void;
+    /**
+     * Sets the Access Key to be used
+     * @param accessKey Thew new Access Key
+     */
+    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;
+}

package/dist/config/PhilipsMicConfig.d.ts

@@ -0,0 +1,8 @@
+import { PhilipsMicMode } from '../interop/core/PhilipsMicMode';
+export interface PhilipsMicConfig {
+    /**
+     * Optional Field: Enables or Disables Logging system
+     * @description True if logs are enabled; Otherwise false
+     */
+    philipsMicMode?: PhilipsMicMode;
+}

package/dist/config/SDKConfig.d.ts

@@ -0,0 +1,40 @@
+import { AugnitoConfig } from './AugnitoConfig';
+import { AugnitoSDKEvent } from '../support/AugnitoSDKEvent';
+import { AugnitoSocketResponse } from '../support/AugnitoSocketResponse';
+import { AugnitoSource } from '../support/AugnitoSource';
+import { IConfiguration } from './IConfiguration ';
+/**
+ * Augnito SDK Config
+ */
+export declare class SDKConfig implements IConfiguration {
+    private _config;
+    qrCode: string;
+    customSpeechURL: string | undefined;
+    readonly contentType: string;
+    readonly noiseCt: string;
+    readonly interval: number;
+    domainURL: string;
+    macroServiceURL: string;
+    pushNotificationURL: string;
+    speechMicURL: string;
+    source: AugnitoSource;
+    onSocketPartialResult?: (data: string) => void;
+    onSocketFinalResult?: (data: AugnitoSocketResponse) => void;
+    onEndOfSession?: (isConnected: boolean) => void;
+    onReadyForSpeech?: (isConnected: boolean) => void;
+    onEvent?: (e: AugnitoSDKEvent, data: string) => void;
+    onSessionEvent?: (data: AugnitoSocketResponse) => void;
+    onError?: (data: string) => void;
+    onMicrophoneOnError?: (isWebClient: boolean) => void;
+    constructor(_config: AugnitoConfig);
+    setLmId(lmId: string): void;
+    setSpeechURL(speechURL: string): void;
+    setDomainName(domainName: string): void;
+    setAccountCode(accountCode: string): void;
+    setAccessKey(accessKey: string): void;
+    setEnableLogs(enableLogs: boolean): void;
+    get clientConfig(): AugnitoConfig;
+    get enableLogs(): boolean | undefined;
+    prepareSpeechURL(): string;
+    private getQRCode;
+}

package/dist/config/SDKConfigMobile.d.ts

@@ -0,0 +1,21 @@
+import { WebClient } from '../client/WebClient';
+import { AugnitoMobileSocketResponse } from '../support/AugnitoMobileSocketResponse';
+import { AugnitoMobileConfig } from './AugnitoMobileConfig';
+/**
+ * Mobile SDK Config
+ */
+export declare class SDKConfigMobile {
+    private _config;
+    private _webClient;
+    onMicrophoneOnError?: (isWebClient: boolean) => void;
+    constructor(_config: AugnitoMobileConfig, _webClient: WebClient);
+    get clientConfig(): AugnitoMobileConfig;
+    get enableLogs(): boolean | undefined;
+    setEnableLogs(enableLogs: boolean): void;
+    get deviceId(): string | undefined;
+    get userTag(): string;
+    startListening(JSONResponse: AugnitoMobileSocketResponse): void;
+    stopListening(): void;
+    prepareNotificationURL(): string;
+    prepareSpeechMicURL(JSONResponse: AugnitoMobileSocketResponse): string;
+}

package/dist/config/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AugnitoConfig';
+export * from './AugnitoMobileConfig';
+export * from './IConfiguration ';
+export * from './PhilipsMicConfig';

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export { Augnito } from './Augnito';
+export { AugnitoMobile } from './AugnitoMobile';
+export { AugnitoSDKErrorMessage } from './support/AugnitoSDKErrorMessage';
+export { AugnitoSDKError } from './support/AugnitoSDKErrors';
+export * from './interop';
+export * from './config/';
+export * from './commands';
+export * from './recipe';
+export * from './config';
+export * from './api';