task: Pepare for NPM publish, etc (#18)(#17)

Author: nfreear

.github/workflows/nodejs.yml

@@ -6,7 +6,7 @@ on: [push]
 
 # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 env:
-  NODE_VERSION: 18
+  NODE_VERSION: 22
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
@@ -41,19 +41,18 @@ jobs:
       with:
         node-version: ${{ env.NODE_VERSION }}
     - run: npm ci
-    - run: npm run build --if-present
+    - run: npm run build:site --if-present
     - run: npm test
 
     # Deploy.
     - name: Setup Pages
-      uses: actions/configure-pages@v2
+      uses: actions/configure-pages@v5
     - name: Upload artifact
-      uses: actions/upload-pages-artifact@v2
+      uses: actions/upload-pages-artifact@v3
       with:
-        # Upload one directory.
-        path: '.'
+        path: _site
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v2
+      uses: actions/deploy-pages@v4
 
 # End.

.npmignore

@@ -0,0 +1,8 @@
+_site
+.github
+test
+CHANGELOG.md
+LICENSE
+*BAK*
+*__.js
+*.ts

LICENSE

@@ -1,7 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2020-2023 Nick Freear and contributors.
-
+Copyright © 2020-2025 Nick Freear and contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the “Software”), to deal

_site/.gitignore

@@ -0,0 +1 @@
+*.*

demo/lib/example-app.js

@@ -8,40 +8,34 @@
 
 // @ts-check
 
-// import 'ms-cog-speech-sdk';
-// import { createDictationRecognizerPonyfill, getDictationRecognizerConfig, fireMockActionsEvent } from 'adapt-speech-recog';
-import { createAdaptiveRecognizerPonyfill, getAdaptiveRecognizerConfig, fireMockActionsEvent } from 'adaptive-speech-recog';
+import {
+  createAdaptiveRecognizerPonyfill, getAdaptiveRecognizerConfig, fireMockActionsEvent
+} from 'adaptive-speech-recog';
 import { webApiSpeechRecogDemo } from 'web-speech-recog';
 
 const USE_WEB_API = param(/webapi=(true)/);
 
-/* const OPT = { }; */
+const FORM = document.querySelector('#exampleAppForm');
+const FORM_EL = FORM.elements;
 
-const REC_START_BUTTON = document.querySelector('#recognizer-start-button');
-const REC_STOP_BUTTON = document.querySelector('#recognizer-stop-button');
+export default function exampleApp () {
+  console.debug('Form:', FORM_EL, FORM);
 
-// const SDK_SCRIPT = document.querySelector('script[ src *= ".speech.sdk." ]');
+  console.debug('SpeechSDK:', window.SpeechSDK);
 
-const LOG = document.querySelector('#log');
-const RESULT = document.querySelector('#result');
-const PRE_OPT = document.querySelector('#options');
-const ACTIONS = document.querySelector('#actions');
-const SDK_VERSION = document.querySelector('#sdk-version');
-
-console.debug('SpeechSDK:', window.SpeechSDK);
-
-if (USE_WEB_API) {
-  webApiSpeechRecogDemo();
-} else {
-  exampleApp();
+  if (USE_WEB_API) {
+    webApiSpeechRecogDemo();
+  } else {
+    runExampleApp();
+  }
 }
 
-export function exampleApp () {
+export function runExampleApp () {
   const options = getAdaptiveRecognizerConfig(); // WAS: getDictationRecognizerConfig();
 
   if (!options.subscriptionKey || /_/.test(options.subscriptionKey)) {
     document.body.className += 'error config-error';
-    LOG.textContent = 'ERROR: Expecting a URL parameter `?key=AZURE_SPEECH_SUBSCRIPTION_KEY`.';
+    updateLog('ERROR: Expecting a URL parameter `?key=AZURE_SPEECH_SUBSCRIPTION_KEY`.');
     throw new Error('ERROR: Expecting a URL parameter `?key=AZURE_SPEECH_SUBSCRIPTION_KEY`.');
   }
 
@@ -52,15 +46,15 @@ export function exampleApp () {
   console.debug('Ponyfill:', ponyfill);
 
   recognizer.getConfiguration().then(OPT => {
-    PRE_OPT.textContent = 'Options: ' + JSON.stringify(OPT, null, 2); // Was: '\t';
+    FORM_EL.options.textContent = 'Options: ' + JSON.stringify(OPT, null, 2); // Was: '\t';
 
     if (OPT.actionPhrasesEnable) {
       const actionList = fireMockActionsEvent();
 
-      ACTIONS.innerHTML = `Suggested actions: <q>${actionList.join('</q>, <q>')}</q>`;
+      FORM_EL.actions.value = `Suggested actions: <q>${actionList.join('</q>, <q>')}</q>`;
     }
 
-    SDK_VERSION.innerHTML = `Speech SDK <i>${OPT.sdkVersion}</i>`;
+    FORM_EL.sdkVersion.value = `Speech SDK ${OPT.sdkVersion}`;
   });
 
   // recognizer.addEventListener('result', ev => console.warn('Event: result.', ev));
@@ -75,8 +69,8 @@ export function exampleApp () {
 
     console.warn('Result event:', confidence, ev);
 
-    RESULT.textContent = TEXT; // Or: RESULT.value!
-    LOG.textContent += `Result := ${TEXT} (${SOURCE})\n`;
+    FORM_EL.result.value = TEXT; // Or: RESULT.value!
+    updateLog(`Result := ${TEXT} (${SOURCE})`);
 
     if (isFinal) {
       onRecognitionStop();
@@ -87,35 +81,35 @@ export function exampleApp () {
 
   recognizer.onend = (ev) => {
     console.warn('End event:', ev);
-    LOG.textContent += '> End.\n';
+    updateLog('> End.');
 
     onRecognitionStop();
   };
 
-  recognizer.onstart = ev => {
+  recognizer.onstart = (ev) => {
     console.debug('Start event:', ev);
-    LOG.textContent += '> Start\n';
+    updateLog('> Start');
   };
 
-  recognizer.onerror = ev => {
-    const ERROR = ev.data.error;
+  recognizer.onerror = (ev) => {
+    const { error } = ev.data;
 
-    console.error('>> ERROR:', ERROR, ev);
+    console.error('>> ERROR:', error, ev);
 
     onRecognitionStop();
 
     document.body.classList.add('recognizer-error');
-    document.body.setAttribute('data-error', ERROR);
+    document.body.setAttribute('data-error', error);
 
-    if (/microphone initialization: NotAllowedError/.test(ERROR)) {
-      LOG.textContent = '> Warning: microphone blocked.';
+    if (/microphone initialization: NotAllowedError/.test(error)) {
+      updateLog('> Warning: microphone blocked.');
     }
   };
 
   // ----------------------------------------------------
   // Button events.
 
-  REC_START_BUTTON.addEventListener('click', async (ev) => {
+  FORM.addEventListener('submit', async (ev) => {
     ev.preventDefault();
     onButtonStart();
 
@@ -126,13 +120,17 @@ export function exampleApp () {
     // setTimeout(() => enumMediaDevices(), 5000);
   });
 
-  REC_STOP_BUTTON.addEventListener('click', ev => {
+  FORM.addEventListener('reset', (ev) => {
     ev.preventDefault();
 
     console.debug('Recognizer stop button clicked');
 
     recognizer.stop(() => onRecognitionStop());
   });
+
+  function updateLog (value) {
+    FORM_EL.log.value += `${value}\n`;
+  }
 }
 
 // ----------------------------------------------------
@@ -151,9 +149,12 @@ export function exampleApp () {
 }); */
 
 function onButtonStart () {
-  REC_START_BUTTON.disabled = true;
+  FORM_EL.startButton.disabled = true;
+  FORM_EL.stopButton.disabled = false;
+  FORM_EL.stopButton.focus();
+  /* REC_START_BUTTON.disabled = true;
   REC_STOP_BUTTON.disabled = false;
-  REC_STOP_BUTTON.focus();
+  REC_STOP_BUTTON.focus(); */
 }
 
 function onRecognitionStart () {
@@ -162,9 +163,12 @@ function onRecognitionStart () {
 }
 
 function onRecognitionStop () {
-  REC_STOP_BUTTON.disabled = true;
+  FORM_EL.stopButton.disabled = true;
+  FORM_EL.startButton.disbled = false;
+  FORM_EL.startButton.focus();
+  /* REC_STOP_BUTTON.disabled = true;
   REC_START_BUTTON.disabled = false;
-  REC_START_BUTTON.focus();
+  REC_START_BUTTON.focus(); */
 
   document.body.classList.add('recognizer-stopped');
   document.body.classList.remove('recognizer-started');

demo/style.css

@@ -23,17 +23,22 @@ label {
 }
 
 #actions,
+output,
 pre,
 textarea {
   background: var(--pale-grey);
   border: 1px solid var(--border-grey);
   border-radius: .25rem;
+  display: inline-block;
   font-size: small;
-  margin: 1.5rem 0;
+  margin: .5rem 0 1.5rem;
+  min-height: 1rem;
   padding: .5rem;
+  width: 100%;
 }
 
-textarea {
+output,
+.X_textarea {
   font: large/1.5 sans-serif;
   margin: 0;
   width: 98%;

index.html

@@ -11,60 +11,65 @@
 
 <h1> Adaptive speech recognition </h1>
 
-<p id="sdk-version"></p>
+<form id="exampleAppForm">
 
 <p>
-  <button id="recognizer-start-button">Start dictation</button>
-  <button id="recognizer-stop-button" disabled >Stop</button>
-  <i id="recognizer-status" title="Recognizer stopped"></i>
+  <input id="sdk-version" name="sdkVersion" readonly aria-label="SDK Version">
 </p>
 
+<p>
+  <button type="submit" id="startButton">Start dictation</button>
+  <button type="reset" id="stopButton" disabled >Stop</button>
+  <i id="recognizer-status" title="Recognizer stopped"></i>
+</p>
 
 <p>
   <label for="result">Result</label>
-  <textarea id="result" class="output" placeholder="(No result)" rows="2" readonly ></textarea>
+  <output id="result" class="output" placeholder="(No result)"></output>
 </p>
 
 <p id="actions" title="(actions)"></p>
 
-<pre id="log" title="(log)">-
-</pre>
-
-<pre id="options"></pre>
+<p>
+  <label for="log">Log</label>
+  <textarea id="log" readonly></textarea>
+</p>
+<p>
+  <label for="options">Options</label>
+  <textarea id="options" readonly></textarea>
+</p>
 
+</form>
 
 <a class="github-fork-ribbon" href="https://github.com/nfreear/dictation" data-ribbon="Fork me on GitHub" title="Fork 'nfreear/dictation' on GitHub">Fork nfreear/dictation on GitHub</a>
 
-
-<script
-  data-X-src="https://cdn.jsdelivr.net/npm/[email protected]/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js"
-  crossorigin="anonymous"
-></script>
-
 <script type="importmap">
 {
   "imports": {
     "adaptive-speech-recog": "./index.js",
     "patient-speech-recog": "./index.js",
+    "exampleApp": "./demo/lib/example-app.js",
     "web-speech-recog": "./src/web-api-speech-recog.js",
     "ms-cog-speech-sdk.v1.15.1": "https://cdn.jsdelivr.net/npm/[email protected]/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js",
-    "ms-cog-speech-sdk": "https://unpkg.com/microsoft-cognitiveservices-speech-sdk@1.34.0/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js"
+    "ms-cognitive-speech-sdk": "https://unpkg.com/microsoft-cognitiveservices-speech-sdk@1.43.1/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js"
   }
 }
 </script>
 
-<script type="module" src="./demo/lib/example-app.js"></script>
-
+<script type="module">
+  import exampleApp from 'exampleApp';
+  exampleApp();
+</script>
 
 <!--  ====================================================== -->
 
 <footer>
-  © 2020 Nick Freear. All rights reserved.
+  © 2025 Nick Freear. All rights reserved.
   <a href="https://github.com/nfreear/dictation">source</a>
 </footer>
 
 
-<pre class="hide">
+<pre hidden>
 
 NDF, 08-Oct-2020.
 

package.json

@@ -1,15 +1,19 @@
 {
-  "private": true,
   "name": "adaptive-speech-recognizer",
-  "version": "2.0.0-beta",
+  "version": "2.1.0",
   "description": "Adaptive dictation-mode speech recognizer ponyfill compatible with WebChat that gives the user time to think and stutter/stammer.",
   "license": "MIT",
   "repository": "https://github.com/nfreear/dictation.git",
   "author": "Nick Freear",
-  "main": "./index.js",
-  "browser": "./index.js",
+  "main": "index.js",
+  "exports": {
+    ".": "./index.js",
+    "./example-app": "./demo/lib/example-app.js",
+    "./webApiSpeechRecog": "./src/web-api-speech-recog.js"
+  },
   "type": "module",
   "scripts": {
+    "build:site": "cp -R *.js src demo _site",
     "_": "# http://localhost:8080?key=_YOUR_AZURE_SPEECH_SUBSCRIPTION_KEY&actions=true",
     "start": "npm run _ && servor",
     "ts": "npx -p typescript tsc src/**/*.js --declaration --allowJs --emitDeclarationOnly --outDir types",
@@ -21,14 +25,14 @@
     "servor": "^4.0.2"
   },
   "peerDependencies": {
-    "microsoft-cognitiveservices-speech-sdk": "^1.34.0",
+    "microsoft-cognitiveservices-speech-sdk": "^1.43.1",
     "web-speech-cognitive-services": "^7.1.3",
     "react-dictate-button": "^2.0.1"
   },
   "CDN_peerDependencies": {
     "botframework-webchat-root": "^4.10.1",
     "sdk:1.15.1": "https://cdn.jsdelivr.net/npm/[email protected]/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js",
-    "sdk": "https://unpkg.com/microsoft-cognitiveservices-speech-sdk@1.34.0/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js"
+    "sdk": "https://unpkg.com/microsoft-cognitiveservices-speech-sdk@1.43.1/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js"
   },
   "keywords": [
     "microsoft",

src/SpeechSDK.js

@@ -1,9 +1,8 @@
 /**
- * @version 1.34.0
+ * Export `SpeechSDK` globals.
+ * @see https://www.npmjs.com/package/microsoft-cognitiveservices-speech-sdk
  */
-
-import 'https://unpkg.com/[email protected]/distrib/browser/microsoft.cognitiveservices.speech.sdk.bundle-min.js';
-// import 'ms-cognitive-speech-sdk';
+import 'ms-cognitive-speech-sdk';
 
 const {
   AudioConfig, MicAudioSource,