Add more typings (#224)

* Add typings

* Fix typing

* Clean up typings

* Add barrel file

* Add entry

* Moved entry

Author: compulim

CHANGELOG.md

@@ -15,7 +15,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Changed
 
-- 💥 Modernized some code with TypeScript, more type-aligned to W3C Speech API, and moved to official Event Target API, in PR [#220](https://github.com/compulim/web-speech-cognitive-services/pull/220)
+- 💥 Modernized some code with TypeScript, more type-aligned to W3C Speech API, and moved to official Event Target API, in PR [#220](https://github.com/compulim/web-speech-cognitive-services/pull/220) and [#224](https://github.com/compulim/web-speech-cognitive-services/pull/224)
    -  `SpeechRecognitionResult` and `SpeechRecognitionResultList` is now a array-like object, use `Array.from()` to convert them into an array
 - Updated build tools and added named exports via CJS/ESM
 - Bumped dependencies, in PR [#216](https://github.com/compulim/web-speech-cognitive-services/pull/216) and [#218](https://github.com/compulim/web-speech-cognitive-services/issues/218)

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText.js

@@ -1,6 +1,4 @@
-import createSpeechRecognitionPonyfill, {
-  createSpeechRecognitionPonyfillFromRecognizer
-} from './SpeechToText/createSpeechRecognitionPonyfill';
+import { createSpeechRecognitionPonyfill, createSpeechRecognitionPonyfillFromRecognizer } from './SpeechToText/index';
 
 export default createSpeechRecognitionPonyfill;
 

…rvices/SpeechToText/SpeechGrammarList.js …rvices/SpeechToText/SpeechGrammarList.tspackages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechGrammarList.js renamed to packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechGrammarList.ts packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechGrammarList.js renamed to packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechGrammarList.ts

@@ -1,23 +1,25 @@
 /* eslint class-methods-use-this: "off" */
 
-export default class {
+export default class SpeechGrammarList {
   constructor() {
-    this._phrases = [];
+    this.#phrases = [];
   }
 
   addFromString() {
     throw new Error('JSGF is not supported');
   }
 
-  get phrases() {
-    return this._phrases;
+  #phrases: readonly string[];
+
+  get phrases(): readonly string[] {
+    return this.#phrases;
   }
 
-  set phrases(value) {
+  set phrases(value: readonly string[]) {
     if (Array.isArray(value)) {
-      this._phrases = value;
+      this.#phrases = Object.freeze([...value]);
     } else if (typeof value === 'string') {
-      this._phrases = [value];
+      this.#phrases = Object.freeze([value]);
     } else {
       throw new Error(`The provided value is not an array or of type 'string'`);
     }

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechRecognitionErrorEvent.ts

@@ -6,7 +6,8 @@ export type SpeechRecognitionErrorType =
   | 'network'
   | 'no-speech'
   | 'not-allowed'
-  | 'service-not-allowed';
+  | 'service-not-allowed'
+  | 'unknown';
 
 export type SpeechRecognitionErrorEventInit = {
   error: SpeechRecognitionErrorType;
@@ -31,4 +32,8 @@ export default class SpeechRecognitionErrorEvent extends Event {
   get message(): string | undefined {
     return this.#message;
   }
+
+  override get type(): 'error' {
+    return 'error';
+  }
 }

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechRecognitionEvent.ts

@@ -54,4 +54,8 @@ export default class SpeechRecognitionEvent<
   get results(): SpeechRecognitionResultList {
     return this.#results;
   }
+
+  override get type(): T {
+    return super.type as T;
+  }
 }

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechRecognitionEventListenerMap.ts

@@ -1,4 +1,4 @@
-import EventListenerMap from './EventListenerMap';
+import EventListenerMap from './private/EventListenerMap';
 import type SpeechRecognitionErrorEvent from './SpeechRecognitionErrorEvent';
 import type SpeechRecognitionEvent from './SpeechRecognitionEvent';
 

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechRecognitionResult.ts

@@ -1,4 +1,4 @@
-import FakeArray from './FakeArray';
+import FakeArray from './private/FakeArray';
 
 export type SpeechRecognitionResultInit = {
   isFinal: boolean;

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/SpeechRecognitionResultList.ts

@@ -1,4 +1,4 @@
-import FakeArray from './FakeArray';
+import FakeArray from './private/FakeArray';
 import type SpeechRecognitionResult from './SpeechRecognitionResult';
 
 export default class SpeechRecognitionResultList extends FakeArray<SpeechRecognitionResult> {

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/cognitiveServiceEventResultToWebSpeechRecognitionResult.test.js

@@ -6,6 +6,8 @@ import cognitiveServiceEventResultToWebSpeechRecognitionResult from './cognitive
 
 test('Multiple results with RecognitionStatus === "Success"', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult({
+    duration: 0,
+    errorDetails: '',
     json: {
       NBest: [
         {
@@ -25,7 +27,11 @@ test('Multiple results with RecognitionStatus === "Success"', () => {
       ],
       RecognitionStatus: 'Success'
     },
-    reason: 3
+    offset: 0,
+    properties: '',
+    reason: 3,
+    resultId: '',
+    text: ''
   });
 
   expect(resultList[0]).toEqual(expect.objectContaining({ confidence: 0.25, transcript: 'No.' }));
@@ -35,7 +41,13 @@ test('Multiple results with RecognitionStatus === "Success"', () => {
 
 test('Single interim results', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult({
+    duration: 0,
+    errorDetails: '',
+    json: {},
+    offset: 0,
+    properties: '',
     reason: 2,
+    resultId: '',
     text: 'No.'
   });
 
@@ -45,6 +57,8 @@ test('Single interim results', () => {
 
 test('Single final results', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult({
+    duration: 0,
+    errorDetails: '',
     json: {
       NBest: [
         {
@@ -56,7 +70,11 @@ test('Single final results', () => {
         }
       ]
     },
-    reason: 3
+    offset: 0,
+    properties: '',
+    reason: 3,
+    resultId: '',
+    text: ''
   });
 
   expect(resultList[0]).toEqual(expect.objectContaining({ confidence: 0.25, transcript: 'No.' }));
@@ -66,6 +84,8 @@ test('Single final results', () => {
 test('Single final results with ITN', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult(
     {
+      duration: 0,
+      errorDetails: '',
       json: {
         NBest: [
           {
@@ -77,9 +97,14 @@ test('Single final results with ITN', () => {
           }
         ]
       },
-      reason: 3
+      offset: 0,
+      properties: '',
+      reason: 3,
+      resultId: '',
+      text: ''
     },
     {
+      maxAlternatives: 1,
       textNormalization: 'itn'
     }
   );
@@ -91,6 +116,8 @@ test('Single final results with ITN', () => {
 test('Single final results with lexical', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult(
     {
+      duration: 0,
+      errorDetails: '',
       json: {
         NBest: [
           {
@@ -102,9 +129,14 @@ test('Single final results with lexical', () => {
           }
         ]
       },
-      reason: 3
+      offset: 0,
+      properties: '',
+      reason: 3,
+      resultId: '',
+      text: ''
     },
     {
+      maxAlternatives: 1,
       textNormalization: 'lexical'
     }
   );
@@ -116,6 +148,8 @@ test('Single final results with lexical', () => {
 test('Single final results with masked ITN', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult(
     {
+      duration: 0,
+      errorDetails: '',
       json: {
         NBest: [
           {
@@ -127,9 +161,14 @@ test('Single final results with masked ITN', () => {
           }
         ]
       },
-      reason: 3
+      offset: 0,
+      properties: '',
+      reason: 3,
+      resultId: '',
+      text: ''
     },
     {
+      maxAlternatives: 1,
       textNormalization: 'maskeditn'
     }
   );
@@ -141,6 +180,8 @@ test('Single final results with masked ITN', () => {
 test('Result is iterable', () => {
   const resultList = cognitiveServiceEventResultToWebSpeechRecognitionResult(
     {
+      duration: 0,
+      errorDetails: '',
       json: {
         NBest: [
           {
@@ -152,9 +193,16 @@ test('Result is iterable', () => {
           }
         ]
       },
-      reason: 3
+      offset: 0,
+      properties: '',
+      reason: 3,
+      resultId: '',
+      text: ''
     },
-    {}
+    {
+      maxAlternatives: 1,
+      textNormalization: 'display'
+    }
   );
 
   const [firstAlternative] = resultList;

packages/web-speech-cognitive-services/src/SpeechServices/SpeechToText/cognitiveServiceEventResultToWebSpeechRecognitionResult.ts

@@ -1,15 +1,15 @@
 import SpeechSDK from '../SpeechSDK';
 
-import { type RecognitionResult } from 'microsoft-cognitiveservices-speech-sdk';
 import SpeechRecognitionAlternative from './SpeechRecognitionAlternative';
 import SpeechRecognitionResult from './SpeechRecognitionResult';
+import type { SerializedRecognitionResult } from './private/serializeRecognitionResult';
 
 const {
   ResultReason: { RecognizingSpeech, RecognizedSpeech }
 } = SpeechSDK;
 
 export default function (
-  result: RecognitionResult,
+  result: SerializedRecognitionResult,
   init?:
     | {
         maxAlternatives: number;