uneeq-js 2.47.0 → 2.47.2

package/package.json

@@ -1,62 +1,64 @@
-{
-  "name": "uneeq-js",
-  "version": "2.47.0",
-  "description": "",
-  "main": "dist/index.js",
-  "types": "dist/src/index.d.ts",
-  "scripts": {
-    "start": "npx webpack -w",
-    "test-local": "npx karma start karma.conf.js -logLevel=DEBUG",
-    "test": "npx karma start --browsers ChromeHeadless --single-run",
-    "test:windows": "karma start karma.conf.js",
-    "build": "webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js",
-    "lint": "npx tslint -p tsconfig.json --fix",
-    "docs": "npx typedoc --options"
-  },
-  "files": [
-    "dist",
-    "!dist/test"
-  ],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {
-    "@stomp/stompjs": "^6.0.0",
-    "@uehreka/seriously": "^1.0.1",
-    "fast-text-encoding": "^1.0.0",
-    "intrinsic-scale": "^3.0.4",
-    "onnxruntime-web": "^1.15.1",
-    "promjs": "^0.4.1",
-    "ring-buffer-ts": "^1.2.0",
-    "rxjs": "^7.8.1",
-    "rxjs-compat": "^6.6.7",
-    "simple-peer": "^9.11.1",
-    "webrtc-adapter": "^8.2.3"
-  },
-  "devDependencies": {
-    "@types/dom-mediacapture-record": "^1.0.16",
-    "@types/jasmine": "^2.8.8",
-    "@types/node": "^10.9.4",
-    "fetch-mock": "7.7.3",
-    "ignore-styles": "^5.0.1",
-    "jasmine": "^5.1.0",
-    "jasmine-core": "^5.1.0",
-    "karma": "^6.4.2",
-    "karma-chrome-launcher": "^3.2.0",
-    "karma-firefox-launcher": "^2.1.2",
-    "karma-jasmine": "^5.1.0",
-    "karma-jasmine-html-reporter": "^2.1.0",
-    "karma-requirejs": "^1.1.0",
-    "karma-typescript": "^5.5.4",
-    "karma-typescript-es6-transform": "^5.5.4",
-    "nock": "^9.6.1",
-    "requirejs": "^2.3.6",
-    "ts-loader": "^9.4.4",
-    "ts-node": "^7.0.1",
-    "tslint": "^5.11.0",
-    "tslint-no-focused-test": "^0.5.0",
-    "typedoc": "^0.18.0",
-    "typescript": "^5.1.6",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.4"
-  }
-}
+{
+  "name": "uneeq-js",
+  "version": "2.47.2",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "start": "npx webpack -w",
+    "test-local": "npx karma start karma.conf.js -logLevel=DEBUG",
+    "test": "npx karma start --browsers ChromeHeadless --single-run",
+    "test:windows": "karma start karma.conf.js",
+    "build": "webpack --config webpack.config.prod.js && webpack --config webpack.config.umd.js",
+    "lint": "npx tslint -p tsconfig.json --fix",
+    "docs": "npx typedoc --options"
+  },
+  "files": [
+    "dist",
+    "!dist/test"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@stomp/stompjs": "^6.0.0",
+    "@uehreka/seriously": "^1.0.1",
+    "crossoriginworker": "^1.1.0",
+    "fast-text-encoding": "^1.0.0",
+    "intrinsic-scale": "^3.0.4",
+    "onnxruntime-web": "^1.15.1",
+    "opus-media-recorder": "^0.8.0",
+    "promjs": "^0.4.1",
+    "ring-buffer-ts": "^1.2.0",
+    "rxjs": "^7.8.1",
+    "rxjs-compat": "^6.6.7",
+    "simple-peer": "^9.11.1",
+    "webrtc-adapter": "^8.2.3"
+  },
+  "devDependencies": {
+    "@types/dom-mediacapture-record": "^1.0.16",
+    "@types/jasmine": "^2.8.8",
+    "@types/node": "^10.9.4",
+    "fetch-mock": "7.7.3",
+    "ignore-styles": "^5.0.1",
+    "jasmine": "^5.1.0",
+    "jasmine-core": "^5.1.0",
+    "karma": "^6.4.2",
+    "karma-chrome-launcher": "^3.2.0",
+    "karma-firefox-launcher": "^2.1.2",
+    "karma-jasmine": "^5.1.0",
+    "karma-jasmine-html-reporter": "^2.1.0",
+    "karma-requirejs": "^1.1.0",
+    "karma-typescript": "^5.5.4",
+    "karma-typescript-es6-transform": "^5.5.4",
+    "nock": "^9.6.1",
+    "requirejs": "^2.3.6",
+    "ts-loader": "^9.4.4",
+    "ts-node": "^7.0.1",
+    "tslint": "^5.11.0",
+    "tslint-no-focused-test": "^0.5.0",
+    "typedoc": "^0.18.0",
+    "typescript": "^5.1.6",
+    "webpack": "^5.88.2",
+    "webpack-cli": "^5.1.4"
+  }
+}

package/readme.md

@@ -1,204 +1,58 @@
-# uneeq-js
-This package is for use inside web projects to establish a live session with a digital human.
-
-## Usage and Documentation:
-https://docs.uneeq.io/build-your-own-experience
-
-#### Installation Notes
-To use uneeq-js with a typescript version < 3.8, 'skipLibCheck' must be set to true.
-
-## Release Notes
-#### 2.47.0
-* Added pre-alpha release of speech_recognition input mode.
-
-#### 2.46.7
-* Updated dependency versions
-
-#### 2.46.6
-* Fix build pipeline
-
-#### 2.46.5
-* Dependency version updates
-
-#### 2.46.4
-* Improve locale detection to ensure we fall back to supported speech to text languages
-
-#### 2.46.3
-* Fix for sessions to start without localStorage availability.
-
-#### 2.46.2
-* Fix for session starting in incognito browser windows.
-
-#### 2.46.1
-* Tweaking locale detection to better handle null or undefined input
-
-#### 2.46.0
-* Adding automatic detection of speech to text language - If no speechToTextLocales set, we will try to automatically detect a users browser language. If we cannot do that, we will fall back to en-US as the default speech to text language.
-
-#### 2.45.0
-* Added ability to, when starting a session, specify up to four languages (using locale codes) that a Digital Human should understand
-
-#### 2.44.6
-* Fixed an issue when ending a session that would cause newly created sessions to be ended shortly after.
-
-#### 2.44.5
-* Fixed issue preventing Firefox based sessions from starting
-
-#### 2.44.4
-* Updated voice activity mode to no longer request the users microphone when the session becomes live.
-
-#### 2.44.3
-* Fix for DigitalHumanUnmuted message on video play.
-
-#### 2.44.2
-* Added DigitalHumanUnmuted message when video plays in unmuted mode.
-
-#### 2.44.1
-* Optimized publish stream and improved audio performance on iOS
-
-#### 2.44.0
-* Added beta support for session resume.
-
-#### 2.43.0
-* Adding support for setting a background image and name tag image when starting a session using new fields in UneeqOptions. Url restrictions apply, please reach out to the Customer Service team.
-
-#### 2.42.3
-* Fixed issue that caused voiceActivity input not to work when using autoStart
-
-#### 2.42.2
-* Improved responsiveness of RecordingStartedMessage when using VOICE_ACTIVITY input mode.
-
-#### 2.42.1
-* Fixed behaviour in Safari so that DigitalHumanPlayedInMutedModeSuccess is emitted when video starts in muted state.
-* Added a new message 'DigitalHumanUnmuted'.
-
-#### 2.42.0
-* Allow digital human videos that are blocked by browser autoplay policy to be played in muted state without user interaction with the page.
-
-#### 2.41.1
-* Fix for VOICE_ACTIVITY disengaging during long utterances.
-
-#### 2.41.0
-* Added support for voice activity detection
-
-#### 2.40.2
-* Minor tweak to client performance metricing
-
-#### 2.40.1
-* Fixed an issue that would sometimes cause a session to start with no video.
-
-#### 2.40.0
-* Adds support for upcoming instructions field
-
-#### 2.39.8
-* Improvements to support upcoming feature
-
-#### 2.39.7
-* Minor fixes to support upcoming feature releases.
-
-#### 2.39.6
-* Fixed video scaling issues when running in a low bandwidth environment.
-* Fixed an issue that occasionally caused the video stream not to render in Safari 15
-
-#### 2.39.1
-* Support for Safari 15
-
-#### 2.39.0
-* Adding support for upcoming features
-
-#### 2.38.3
-* Improves the quality of the UneeQ watermark for customers in our Starter pricing tier
-
-#### 2.38.1
-* Fixed an issue that could cause reconnections to fail.
-
-#### 2.38.0
-* Adds support for transparent background
-
-#### 2.37.2
-* Adds hasDisplayHtml boolean to AvatarAnswerContentMessage to be able to distinguish inclusion of displayHtml
-#### 2.37.0
-* Adds client resolution detection to identify screen ratios.
-
-#### 2.36.6
-* Improved audio management.
-
-#### 2.36.4
-* Added ClientPerformanceMessage to identify if session quality is being impacted by client-side conditions.
-* Added enableClientPerformanceMessage option to control the visibility of client-side network performance messages in the developer console.
-* Added transcriptId to AvatarAnswerMessage, AvatarAnswerContentMessage and AvatarQuestionMessage to link between a question and an answer.
-
-#### 2.35.0
-* Fixed a bug that caused enabling/changing media devices to take a long time to be functional.
-
-#### 2.32.0
-* Users who lose network connection for more than 10 seconds will have their session ended and SessionError will occur.
-
-#### 2.31.1
-* Resolved an issue that caused Chrome to be very slow to detect network connection lost, and not send ConnectionLost message.
-
-#### 2.31.0
-* Add support for stop speaking api
-* Add support for AvatarRequestIgnored and AvatarRequestCompleted messages.
-
-#### 2.30.3
-* Updated readme and removed post install script.
-
-#### 2.30.0
-* Add graceful handling of end sessions messages from websocket - ending the session on the client side.
-
-#### 2.29.2
-* Added new messages: StartedSpeakingMessage, FinishedSpeakingMessage and SessionInfoMessage.
-* Deprecated message: AvatarTextInputFinishedMessage (use FinishedSpeakingMessage)
-
-#### 2.29.1
-* Added the ability to start a session without microphone access and request access to mic/cam mid-session.
-* Fixed an issue that caused some iOS devices to experience low volume.
-* Fixed an issue that caused some iOS devices to play audio from the wrong speaker.
-* *There is a known issue on some iOS devices that can cause audio to crackle when using sendLocalVideo: false with sendLocalAudio: true.*
-
-#### 2.29.0
-* Allow for microphone and camera enable/disable.
-* *This version has been deprecated due to crackling audio on iOS devices.*
-
-#### 2.28.1
-* Fixed a bug which could cause an error when starting a session.
-
-#### 2.28.0
-* Added sendLocalVideo: boolean to UneeqOptions. sendLocalVideo: false will not request or publish the users video stream.
-
-#### 2.27.2
-* Sending information to indicate if user has denied permission for audio/video device
-
-#### 2.27.1
-* Fix for video not playing when changing device (introduced in 2.27.0).
-
-#### 2.27.0
-* Addressed SDP issue causing some sessions not to start following Safari update.
-
-#### 2.26.5
-* Fix for occasional video freeze on session start.
-
-#### 2.26.4
-* Added OnlineStatusUpdateMessage.
-
-#### 2.26.3
-* Send media devices availability to the server
-
-#### 2.26.2
-* Set websocket reconnection and timeout limits.
-
-#### 2.26.1
-* Added timezone to session start request.
-
-#### 2.26.0
-* Added ClientMediaStreamUpdate message. Shifted SessionLiveMessage to only send once audio and video are streaming between client and server.
-
-#### 2.25.2
-* Added sessionId as a parameter on Uneeq class and log it upon session start.
-
-#### 2.25.1
-* Added release notes to readme.
-
-#### 2.25.0
-* Update to match faceme-sdk version number + fixes.
+# uneeq-js
+This package is for use inside web projects to establish a live session with a digital human.
+
+## Running Locally
+- `npm i && npm start`
+
+## Usage
+Inside a web project you can install this package `npm i uneeq`, and begin a session with a digital human:
+```
+let uneeq = new Uneeq(UneeqOptions);
+uneeq.initWithToken(token);
+```
+
+For details on obtaining a token, please refer to:<br/>
+https://docs.uneeq.io/#/chatbot_integration?id=obtaining-an-access-token
+
+## Unit Tests
+Unit testing is performed via Jasmine with Karma.
+- `npm test`
+- In Windows, you will need to install Karma globally `npm install -g karma-cli`. After installing you can run Karma tests with the command `npm run test:windows`.
+
+## Linting
+Lint rules are defined in tslint.json
+- `npm run lint`
+
+## Documentation
+- `npm run docs` will output documentation to the docs/ folder using typedoc
+
+## Publish a new version to NPM
+- `./release.sh`
+- Submit a merge request.
+- Follow code review, merge the code
+- GitLab will automatically publish new versions to NPM
+
+A detailed guide to releasing uneeq-js can be found here:
+https://faceme.atlassian.net/wiki/spaces/PM/pages/1564246028/Web+SDK+uneeq-js+release+and+test+process
+
+### Deprecating a version in NPM
+- Think you need to deprecate a version in NPM? See the [runbook](https://faceme.atlassian.net/wiki/spaces/SUP/pages/1115160577/Deprecating+a+version+of+uneeq-js+in+the+NPM+registry).
+
+## Local Development
+You can develop this package locally but you'll still need to connect the npm package to a running front end application
+in order to test any changes or additions. The best method for doing this is with `npm link`.
+
+## Releasing a beta version
+Releasing a beta SDK is not a very clean process and must be performed manually from a development machine, though it is possible to incorporate this via Gitlab CI, this is not a simple process. For now you can follow these steps:
+1. Commit all changes locally
+2. Delete node_modules folder
+3. Fresh install all node_modules (for safety) `npm i`
+4. Lint and Test the project: `npm run lint` , `npm run test`
+5. Update release notes file release-notes.md
+6. Build the project `./build.sh`
+7. Step 6 will generate some changes to readme files, you need to commit these before step 8. It is likely you will want to revert these before final release (not a great process!)
+8. Increment version number `npm version patch` (or minor/major) - this step required a clean working directory
+9. Log in to NPM registry `npm login` (production vault in 1pass)
+10. Publish to NPM `npm publish --tag beta`
+
+The newly published version can be installed in a project via `npm i uneeq-js@beta`