speechstate 2.0.0-beta.6 → 2.0.0-beta.7

package/README.org

@@ -1,3 +1,4 @@
+#+STARTUP: inlineimages
 #+TITLE: SpeechState
 
 * SDK
@@ -27,6 +28,7 @@
   interface Settings {
     locale?: string;
     azureCredentials: string | AzureCredentials;
+    azureLanguageCredentials?: AzureLanguageCredentials;
     asrDefaultCompleteTimeout?: number;
     asrDefaultNoInputTimeout?: number;
     ttsDefaultVoice?: string;
@@ -48,7 +50,7 @@ Example action:
 *** DM to SpeechState
 - ~{ type: "PREPARE" }~  
 - ~{ type: "SPEAK"; value: Agenda }~ 
-- ~{ type: "LISTEN" }~
+- ~{ type: "LISTEN"; value?: RecogniseParameters }~
 - ~{ type: "CONTROL" }~
 - ~{ type: "STOP" }~
 
@@ -56,22 +58,38 @@ Example action:
 *** SpeechState to DM
 - ~{ type: "ASRTTS_READY" }~  
 - ~{ type: "ASR_NOINPUT" }~
-- ~{ type: "RECOGNISED"; value: Hypothesis[] }~  
+- ~{ type: "RECOGNISED"; value: Hypothesis[]; nluValue?: any }~  
 - ~{ type: "SPEAK_COMPLETE" }~ 
 - ~{ type: "ASR_STARTED" }~ 
 - ~{ type: "TTS_STARTED" }~ 
 ** Types:
 #+begin_src typescript
-interface Hypothesis {
+  interface Hypothesis {
+      utterance: string;
+      confidence: number;
+  }
+
+  interface Agenda {
     utterance: string;
-    confidence: number;
-}
-  
-interface Agenda {
-  utterance: string;
-  voice?: string; // defaults to "en-US-DavisNeural"
-  streamURL?: string;
-}
+    voice?: string; // defaults to "en-US-DavisNeural"
+    streamURL?: string;
+  }
+
+  interface RecogniseParameters {
+    noInputTimeout?: number;
+    completeTimeout?: number;
+    locale?: string;
+    hints?: string[];
+    nlu?: boolean | AzureLanguageCredentials;
+  }
+
+  interface AzureLanguageCredentials {
+    endpoint: string;
+    key: string;
+    projectName: string;
+    deploymentName: string;
+  }
+
 #+end_src
 
 
@@ -93,3 +111,33 @@ interface Agenda {
    - Resource group: group name from the previous step
 5. Within your Speech Service go to: *Resourse management → Keys and
    Endpoint* and copy your KEY 1.
+* Sequence diagrams
+#+begin_src plantuml :results output replace :file docs/diagrams/dm-speechstate.svg :exports results
+  skinparam defaultFontName Helvetica
+  participant       SpeechState       as SS
+  hnote across: Initialization
+  create SS
+  DM -> SS : **spawn**
+  DM -> SS : PREPARE
+  SS -> DM : ASRTTS_READY
+  hnote across: Speech Synthesis 
+  DM -> SS : LISTEN
+  activate SS
+  SS --> DM : TTS_STARTED
+  return SPEAK_COMPLETE
+  hnote across: Speech Recognition
+  DM -> SS : LISTEN
+  activate SS
+  SS --> DM : ASR_STARTED
+  return RECOGNISED
+  DM -> SS : LISTEN
+  activate SS
+  SS --> DM : ASR_STARTED
+  ... > noInputTimeout ...
+  return ASR_NOINPUT
+#+end_src
+
+#+RESULTS:
+[[file:docs/diagrams/dm-speechstate.svg]]
+
+

package/README.plantuml

@@ -0,0 +1,3 @@
+@startuml
+Bob -> Alice : Hello World!
+@enduml

package/dist/asr.js

@@ -148,7 +148,7 @@ exports.asrMachine = (0, xstate_1.setup)({
             on: {
                 START: {
                     target: "Recognising",
-                    actions: (0, xstate_1.assign)({ params: ({ event }) => event.value }),
+                    actions: (0, xstate_1.assign)({ params: ({ event }) => event.value || {} }),
                 },
             },
         },

package/dist/speechstate.d.ts

@@ -5,7 +5,8 @@ interface SSContext {
     asrRef?: any;
     ttsRef?: any;
 }
-type SSEvent = {
+/** events sent to the spawned `speechstate` machine **/
+type SSEventExtIn = {
     type: "PREPARE";
 } | {
     type: "CONTROL";
@@ -14,28 +15,34 @@ type SSEvent = {
 } | {
     type: "SPEAK";
     value: Agenda;
-} | {
-    type: "TTS_READY";
-} | {
-    type: "TTS_STARTED";
-} | {
-    type: "TTS_ERROR";
-} | {
-    type: "SPEAK_COMPLETE";
-} | {
-    type: "ASR_READY";
 } | {
     type: "LISTEN";
     value: RecogniseParameters;
+};
+/** for sendParent, not type-checked */
+type SSEventExtOut = {
+    type: "ASR_NOINPUT";
+} | {
+    type: "ASRTTS_READY";
 } | {
     type: "ASR_STARTED";
 } | {
-    type: "ASR_NOINPUT";
+    type: "TTS_STARTED";
+} | {
+    type: "SPEAK_COMPLETE";
 } | {
     type: "RECOGNISED";
     value: Hypothesis[];
     nluValue?: any;
 };
+type SSEventIntIn = {
+    type: "TTS_READY";
+} | {
+    type: "ASR_READY";
+} | {
+    type: "TTS_ERROR";
+};
+type SSEvent = SSEventIntIn | SSEventExtIn | SSEventExtOut;
 declare const speechstate: import("xstate").StateMachine<SSContext, SSEvent, Record<string, import("xstate").AnyActorRef>, import("xstate").ProvidedActor, import("xstate").ParameterizedObject, import("xstate").ParameterizedObject, string, import("xstate").StateValue, string, Settings, {}, import("xstate").ResolveTypegenMeta<import("xstate").TypegenDisabled, SSEvent, import("xstate").ProvidedActor, import("xstate").ParameterizedObject, import("xstate").ParameterizedObject, string, string>>;
 export { speechstate };
 //# sourceMappingURL=speechstate.d.ts.map

package/dist/speechstate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"speechstate.d.ts","sourceRoot":"","sources":["../src/speechstate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC5E,UAAU,SAAS;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED,KAAK,OAAO,GACR;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC1B;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,mBAAmB,CAAA;CAAE,GAC9C;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,UAAU,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AAEhE,QAAA,MAAM,WAAW,odA6PhB,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"speechstate.d.ts","sourceRoot":"","sources":["../src/speechstate.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC5E,UAAU,SAAS;IACjB,QAAQ,EAAE,QAAQ,CAAC;IACnB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,GAAG,CAAC;CACd;AAED,wDAAwD;AACxD,KAAK,YAAY,GACb;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAChB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEnD,uCAAuC;AACvC,KAAK,aAAa,GACd;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,gBAAgB,CAAA;CAAE,GAC1B;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,UAAU,EAAE,CAAC;IAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,CAAC;AAEhE,KAAK,YAAY,GACb;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,CAAC;AAE1B,KAAK,OAAO,GAAG,YAAY,GAAG,YAAY,GAAG,aAAa,CAAC;AAE3D,QAAA,MAAM,WAAW,odA6PhB,CAAC;AAEF,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "speechstate",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0-beta.7",
   "license": "GPL-3.0",
   "homepage": "http://localhost/speechstate",
   "main": "./dist/index.js",