From 5cb4429e992c707350a291892f8e57497398002e Mon Sep 17 00:00:00 2001 From: Luke Date: Mon, 18 Mar 2024 17:08:31 +0000 Subject: [PATCH] chore: update package details and community files --- .github/CODE_OF_CONDUCT.md | 76 -------- CHANGELOG.md | 361 +++++++++++++++++++++++++++++++++++++ CODE_OF_CONDUCT.md | 131 ++++++++++++++ CONTRIBUTING.md | 50 +++++ KNOWN_ISSUES.md | 1 - README.md | 116 ++++++++++++ package.json | 3 +- 7 files changed, 659 insertions(+), 79 deletions(-) delete mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md delete mode 100644 KNOWN_ISSUES.md create mode 100644 README.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md deleted file mode 100644 index 2431eed..0000000 --- a/.github/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,76 +0,0 @@ -# Contributor Covenant Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at {your_email}. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..a60a7b2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,361 @@ +Change Log + +# [0.1.0](https://github.com/deepgram-devs/deepgram-conversational-demo/compare/0.0.33...0.1.0) (2024-03-14) + +### Bug Fixes + +- limit toast to 1 ([745df35](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/745df356870b4e46e06041e11adca6b113b0eb80)) +- remove un-speechable character ([620a085](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/620a085c0bdb7e70c674be8053d7775049a2c442)) + +### Features + +- improve latency output ([8717682](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/8717682e096e9dfb3ae6abcea2a39e70b9934035)) +- introduce audio element instead of dom record for audio playback ([#23](https://github.com/deepgram-devs/deepgram-conversational-demo/issues/23)) ([72941bf](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/72941bf628562248794dbee1be0868caf97394a6)) +- introduce failsafe for uncaptured utterance ([#22](https://github.com/deepgram-devs/deepgram-conversational-demo/issues/22)) ([8ae14d5](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/8ae14d5af013964e56e9d951488d74eb26a276ea)) +- replace code link with stars count button and link ([26853d6](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/26853d687a6467a90676a9b4c47a1510ac7e535b)) +- update readme ([544aa1b](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/544aa1b3ea85d1c842fb3248b4311a86c5d4f3c4)) +- updating copy ([#25](https://github.com/deepgram-devs/deepgram-conversational-demo/issues/25)) ([43748e7](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/43748e71624ae373785cdfc1d561722243ed79c7)) +- welcome and prompt tweaks ([a50f1e6](https://github.com/deepgram-devs/deepgram-conversational-demo/commit/a50f1e68cc2a040c773321821dcd901012531c4d)) + +# 0.0.33 (2024-03-07) + +### Features + +- Michelle llm prompt (#21) ([eb8bffd](https://bitbucket.org/projects/test/repos/my-project/commits/eb8bffd7a6080cdbf0dd388544c7a99c98441979)) +- remove STT latency stub for now ([327bab7](https://bitbucket.org/projects/test/repos/my-project/commits/327bab7080bc9d3c7ffe1dd1f2d1e47848ad8b07)) + +# 0.0.32 (2024-03-06) + +### Features + +- fixing toast output, switching back to gpt-3.5-turbo-0125 ([2f0c108](https://bitbucket.org/projects/test/repos/my-project/commits/2f0c108927c1c202e07a404e6393989153baf273)) + +# 0.0.31 (2024-03-06) + +### Features + +- tweaking the TTS input script mid-request ([b312db8](https://bitbucket.org/projects/test/repos/my-project/commits/b312db8813ef042b83c85e5cd28cda8fb64c93f6)) + +# 0.0.30 (2024-03-06) + +### Features + +- remove chance for two websocket connections to open - introduce toast ([100b781](https://bitbucket.org/projects/test/repos/my-project/commits/100b7819034a029cf8b1fa7ab302a4b803def876)) + +# 0.0.29 (2024-03-06) + +### Bug Fixes + +- build issues ([f6fd30a](https://bitbucket.org/projects/test/repos/my-project/commits/f6fd30adb6776032c0b8a71f6c6bf91611d18fcf)) + +# 0.0.28 (2024-03-06) + +### Bug Fixes + +- firefox would still have zerobyte data in queue, closing connection ([0dfbe3a](https://bitbucket.org/projects/test/repos/my-project/commits/0dfbe3a31c1bbf00ace4072bb7bc11b26c7de820)) + +# 0.0.27 (2024-03-06) + +### Features + +- rearchitect deepgram connection into context ([67f0fe0](https://bitbucket.org/projects/test/repos/my-project/commits/67f0fe0dc88fe888f407e1e9dc6b388c1cbc7229)) + +# 0.0.26 (2024-03-05) + +### Features + +- fix welcome message to be less... funky ([ef0fc68](https://bitbucket.org/projects/test/repos/my-project/commits/ef0fc68d0f33b3fd60e94d9080c89222b85458de)) +- mute microphone when window visibility changes to !==visible ([c523108](https://bitbucket.org/projects/test/repos/my-project/commits/c523108cbbbb8dc10c65542ef3a0156e18d29fcf)) + +### Bug Fixes + +- rerunning connection creation when every context changed was breaking events ([ae726f4](https://bitbucket.org/projects/test/repos/my-project/commits/ae726f412e24ac4722db52f752352437ceabd095)) +- always add a speech_final transcript to the array, but trim the concat audio for the utterance space joining ([f5c483c](https://bitbucket.org/projects/test/repos/my-project/commits/f5c483cbb669cafef95d12afab4ec17740f50680)) +- don't request an API key when there is a connection or existing key ([7df0b2a](https://bitbucket.org/projects/test/repos/my-project/commits/7df0b2a446cd0adb5abe492691867168b06ca2d7)) +- resolve incomplete-is-final errors ([22a5474](https://bitbucket.org/projects/test/repos/my-project/commits/22a54749e338c0968bf2824c3e16787882d45438)) + +### Chores + +- updating known issues ([7fdc875](https://bitbucket.org/projects/test/repos/my-project/commits/7fdc8759f2dbda646eb618f469b46f01a2c4cfe2)) + +# 0.0.25 (2024-03-05) + +### Features + +- edit controls design ([4a67a18](https://bitbucket.org/projects/test/repos/my-project/commits/4a67a18f1461389d8010f0295292e9adc2d685c6)) +- context driven voice model ([b3537ab](https://bitbucket.org/projects/test/repos/my-project/commits/b3537ab80dc7debe96bada7b1d3e49fdd404d444)) +- show voice avatars ([e21454d](https://bitbucket.org/projects/test/repos/my-project/commits/e21454d5c4c28a5058abc291923d972117fee9a8)) +- add voice selection menu ([1b790dd](https://bitbucket.org/projects/test/repos/my-project/commits/1b790dd8af29fec8c5901056478738f8878d71dd)) +- add accent and language to model selection ([0803c8c](https://bitbucket.org/projects/test/repos/my-project/commits/0803c8c341dd02fde4dfaa4d96df0827f2368a3b)) +- use product icons on launchpage ([eee7b23](https://bitbucket.org/projects/test/repos/my-project/commits/eee7b230370607fede453191cf7c5e9cf774a9c8)) +- remove product icons in favour of green bullets ([91caa7f](https://bitbucket.org/projects/test/repos/my-project/commits/91caa7fdee0e3837dc0b257e66f4c4cb7df6805d)) +- tweak bullets ([b466a14](https://bitbucket.org/projects/test/repos/my-project/commits/b466a14574dd49c1facd4496010195185f5ce928)) + +# 0.0.24 (2024-03-05) + +### Features + +- add real network latency for tts ([5a03391](https://bitbucket.org/projects/test/repos/my-project/commits/5a03391b28ad56762744403ce454288f558e1a7d)) + +# 0.0.23 (2024-03-05) + +### Features + +- add settings button, remove flowbite ([931348e](https://bitbucket.org/projects/test/repos/my-project/commits/931348ec4514426d7fef0d902b9366fa7346f8f6)) + +# 0.0.22 (2024-03-05) + +### Features + +- download transcript button ([0c8f78d](https://bitbucket.org/projects/test/repos/my-project/commits/0c8f78d7f329d3c7dd73bd79e038c9d6114a2138)) + +### Bug Fixes + +- fixing social url ([1a33173](https://bitbucket.org/projects/test/repos/my-project/commits/1a33173f13ab57e4676974455c62187a03f9a844)) +- of course the vercel_url env param doesn't have a protocol... ([aff2d15](https://bitbucket.org/projects/test/repos/my-project/commits/aff2d15c4c8af4eb487e154c43469651e9e86c95)) +- hard fix for metadata baseurl ([43eee55](https://bitbucket.org/projects/test/repos/my-project/commits/43eee5503e1fcd0bd1b51d19540a4448b40b7a0a)) +- typos in prompt ([3bd3725](https://bitbucket.org/projects/test/repos/my-project/commits/3bd372554a5e685aee3f8097942774b906223c30)) + +### Chores + +- add new issue to known_issues ([752d420](https://bitbucket.org/projects/test/repos/my-project/commits/752d42081a7afec261cc8efa7325d2fae16b95bd)) + +# 0.0.21 (2024-03-04) + +### Bug Fixes + +- fixing bits ([2631a9e](https://bitbucket.org/projects/test/repos/my-project/commits/2631a9e7cf3a56e75b41bbfa84ec637946672b10)) + +# 0.0.20 (2024-03-04) + +### Bug Fixes + +- use black bg behind black bg image ([c769d8b](https://bitbucket.org/projects/test/repos/my-project/commits/c769d8b7b3b7e87adb60c03d047e45b739bb4380)) + +# 0.0.19 (2024-03-04) + +### Features + +- text tweaks ([ebba538](https://bitbucket.org/projects/test/repos/my-project/commits/ebba538141813dd68a7ccb31b3d4d7116511e2ec)) + +# 0.0.18 (2024-03-04) + +### Features + +- mobile ux tweaks ([95f5fd2](https://bitbucket.org/projects/test/repos/my-project/commits/95f5fd2ac7c501f69c0572dc978fcbf86e5f4d06)) + +# 0.0.17 (2024-03-04) + +### Features + +- TTS/LLM latency visible ([d4d0b24](https://bitbucket.org/projects/test/repos/my-project/commits/d4d0b246971168c34a8e38a9dcd9a787606ae2d2)) +- add bolt icon to metadata ([1fe299c](https://bitbucket.org/projects/test/repos/my-project/commits/1fe299cd76aa7193e666d6c0e1f067fc7cf6a49d)) +- changing stuff ([d6cfa05](https://bitbucket.org/projects/test/repos/my-project/commits/d6cfa05db4c45359b0cfe896be609c2fc2f9a78f)) +- endpoint tuning ([d2a11bf](https://bitbucket.org/projects/test/repos/my-project/commits/d2a11bf59d51ae6ba372779d448e0edd3c82ce4b)) +- metadata, share icons ([9751355](https://bitbucket.org/projects/test/repos/my-project/commits/97513555df3786bef285a9edfea34e6cfd710a01)) +- contextual greeting ([82a6462](https://bitbucket.org/projects/test/repos/my-project/commits/82a64627e2f09d2c5eab15b14cbfcdf8f14323c3)) + +# 0.0.16 (2024-03-04) + +### Features + +- add message metadata to it's own context ([8c7eba7](https://bitbucket.org/projects/test/repos/my-project/commits/8c7eba7a1a1fc9f6ec447feb0b0af10f00b856b7)) + +### Bug Fixes + +- nudge logo up 1px ([4036c88](https://bitbucket.org/projects/test/repos/my-project/commits/4036c88e1f998951e7bbcb3a987e3e5e4971b48d)) +- tweak logo positioning and font ([d5b55f0](https://bitbucket.org/projects/test/repos/my-project/commits/d5b55f02083a5bdcb913dc4d120e6bd6c032fbc8)) +- tweaking welcome message contrast ([d200106](https://bitbucket.org/projects/test/repos/my-project/commits/d200106460d473ac33e204ff89b3c8a0846b4e43)) + +### Chores + +- move exclamation icon tsx file to icons folder ([a92efe0](https://bitbucket.org/projects/test/repos/my-project/commits/a92efe0101e801bd4a0fcda2971ba4d070f4ea55)) + +# 0.0.15 (2024-03-04) + +### Features + +- some layout changes, fullstory added ([eb7bf3b](https://bitbucket.org/projects/test/repos/my-project/commits/eb7bf3bf686b402dac7a9a6fa2558400ef2c292a)) +- tweaking latency display ([3a12535](https://bitbucket.org/projects/test/repos/my-project/commits/3a12535c038e3b6a3e95cc0a9a9e30ab18c8ce50)) +- chat bubble latency ([73153ea](https://bitbucket.org/projects/test/repos/my-project/commits/73153ea154662e4ad2145a1fe2b658d392359246)) + +# 0.0.14 (2024-03-04) + +### Features + +- flesh out dynamic greetings ([0ef489b](https://bitbucket.org/projects/test/repos/my-project/commits/0ef489b6398f084f10d9e5e6e6b345b32d60c170)) +- use TTS for welcome message ([c74f4f6](https://bitbucket.org/projects/test/repos/my-project/commits/c74f4f65af61c9c78915552a47a960933f8fdedd)) + +### Chores + +- smol tweaks ([2993a98](https://bitbucket.org/projects/test/repos/my-project/commits/2993a98902dd45dfb13ad57cc7393e21dab6f897)) +- add link to known issues ([bff88a1](https://bitbucket.org/projects/test/repos/my-project/commits/bff88a19acf028a7d81d5308da896629b26d9291)) + +# 0.0.13 (2024-03-04) + +### Bug Fixes + +- use deepgram favicon on demo ([dc48e2c](https://bitbucket.org/projects/test/repos/my-project/commits/dc48e2c07528c43f06c4ea00c6f8c143b6f98a21)) +- Delay after unmuting the microphone for a second time (#16) ([6b54ce3](https://bitbucket.org/projects/test/repos/my-project/commits/6b54ce3b8073d6b7ee6ee0b898951503b9e8060a)) + +### Chores + +- add opengraph/metadata to known issues ([db73eef](https://bitbucket.org/projects/test/repos/my-project/commits/db73eefcb5540ff86491a292dddc36032b445c4a)) +- add roleplay prompt injection protection to the known issue list ([6a36785](https://bitbucket.org/projects/test/repos/my-project/commits/6a367855f5d6d19bc3d5fc399a85620d8e6e70b8)) +- update known issues file for issues links ([be9ff46](https://bitbucket.org/projects/test/repos/my-project/commits/be9ff46e5f2c95e4e17a1ffed4901869627c131e)) +- readme update and community files (#13) ([629cd2f](https://bitbucket.org/projects/test/repos/my-project/commits/629cd2f8316e9eb0256e919c3395263cfbb166e3)) +- update known issues ([d246613](https://bitbucket.org/projects/test/repos/my-project/commits/d24661341fbddee43889d1441c15ae4c14668d35)) + +# 0.0.12 (2024-02-29) + +### Features + +- add iOS disabled audio playback notice on launchpage ([8da9351](https://bitbucket.org/projects/test/repos/my-project/commits/8da93513febe891003ec9b69d16bc598cbc4cbba)) + +### Bug Fixes + +- switch headphone icon to SVG ([569ef92](https://bitbucket.org/projects/test/repos/my-project/commits/569ef92494ba66b87496ec597612327e899a4cb7)) + +### Chores + +- add favicon issue to known issues ([a11c9c3](https://bitbucket.org/projects/test/repos/my-project/commits/a11c9c390cad6bd9b03e7de2ff0f679b241a15df)) +- add headphone icon to known issues ([0658872](https://bitbucket.org/projects/test/repos/my-project/commits/06588725b381ed49cc21d2bf38bca6c4dabd1371)) +- add need for mobile ux tweaks to known issues ([cf1a86e](https://bitbucket.org/projects/test/repos/my-project/commits/cf1a86e23f65a72f8a51ee77245259ea18efdaf8)) + +# 0.0.11 (2024-02-29) + +### Features + +- avoid one word answers in the prompt ([85ae601](https://bitbucket.org/projects/test/repos/my-project/commits/85ae60102f7d431e62a70a2cae002d4d713d38de)) +- update sample environment variable ([c3f0ee0](https://bitbucket.org/projects/test/repos/my-project/commits/c3f0ee00aea7577dea0cafcdadb6f8b315a470b6)) +- fix disappearing button on mobile launchpage ([4e946fc](https://bitbucket.org/projects/test/repos/my-project/commits/4e946fcf3592c954bcd56677a7b3b84a8c2b3acc)) + +### Chores + +- update KNOWN_ISSUES.md with more thoughts ([0aa9136](https://bitbucket.org/projects/test/repos/my-project/commits/0aa91362fbfac85e4fc8f9393b3fc2966e103406)) + +# 0.0.10 (2024-02-29) + +### Features + +- unedge the TTS api route ([b905161](https://bitbucket.org/projects/test/repos/my-project/commits/b905161773dd3dfd5b4291d7b5540d567e4dbe82)) + +# 0.0.9 (2024-02-29) + +### Features + +- change colour of message metadata line ([4a2ac6c](https://bitbucket.org/projects/test/repos/my-project/commits/4a2ac6cac3a80d970c15378edacb67c9f0a75446)) +- avatar tweaks, barge-in works, update prompt ([c426341](https://bitbucket.org/projects/test/repos/my-project/commits/c426341a2edb41507b2b8f76f7ccf552f0106992)) +- switching over to production values ([5a3ea5b](https://bitbucket.org/projects/test/repos/my-project/commits/5a3ea5b5d63106cfce7c6eea191cc06006504ae3)) +- update user avatar ([af324e4](https://bitbucket.org/projects/test/repos/my-project/commits/af324e4acd0738ad8bc7e1e11634537613112c1c)) +- add CTA buttons in the header ([6205b35](https://bitbucket.org/projects/test/repos/my-project/commits/6205b352304dca1de70aed2b9b8155e349298490)) +- add headphones message ([8427a42](https://bitbucket.org/projects/test/repos/my-project/commits/8427a426ad09ce4445fd1d8ecb79010b4a06187d)) +- better loading/connecting messages ([9b4e011](https://bitbucket.org/projects/test/repos/my-project/commits/9b4e0117bc896ceb6711a0e47c10d3e967d0d577)) +- ux tweaks, better messages, styling ([a9d7117](https://bitbucket.org/projects/test/repos/my-project/commits/a9d711790b50201c21d4b4732ff88a5c76684173)) +- add GTM for analytics ([92734c4](https://bitbucket.org/projects/test/repos/my-project/commits/92734c4b56c134deca1de5ee2a012b9879b84ca9)) +- add heap analytics ([913049f](https://bitbucket.org/projects/test/repos/my-project/commits/913049f112af66dc093178e07ae4b8fd71ca6dcf)) +- switch to console heap project ([1741b70](https://bitbucket.org/projects/test/repos/my-project/commits/1741b70eb140ef176d82341ebe8b2678a19257c3)) +- tweak splash screen for readability ([36155aa](https://bitbucket.org/projects/test/repos/my-project/commits/36155aa9eb0349187e46a87392bbcd71dbe23527)) +- tweak splash screen for UX ([b6e3fc0](https://bitbucket.org/projects/test/repos/my-project/commits/b6e3fc007bea761c02d2f0f663c984a79baf5c5d)) + +# 0.0.8 (2024-02-29) + +### Features + +- remove local VAD attempts ([47815ca](https://bitbucket.org/projects/test/repos/my-project/commits/47815ca4ac0bbf87188fef7dfcd959e5d05229ff)) + +# 0.0.7 (2024-02-29) + +### Features + +- working audio queue and server-side latency ([0f8937f](https://bitbucket.org/projects/test/repos/my-project/commits/0f8937f52bd3a8349f03a2347804c0c8f8022b95)) +- major rebuild of nowplaying and audio queue to use contexts ([f41498d](https://bitbucket.org/projects/test/repos/my-project/commits/f41498dc69d1bc22501300bc86acf50d2e28692f)) +- disable audio control button ([bddade1](https://bitbucket.org/projects/test/repos/my-project/commits/bddade19752fcc3323a4bdb7d057aa04fdb684bf)) +- TTS latency display included ([9e74cb0](https://bitbucket.org/projects/test/repos/my-project/commits/9e74cb0d36c1bdeba6c88f8675dd20786b2b1e4f)) +- audio controls plugged in ([f71dc32](https://bitbucket.org/projects/test/repos/my-project/commits/f71dc320bc0ffba9f51a8f4ef6fdac4ed37c199c)) + +### Chores + +- removed debug outline ([cdf6270](https://bitbucket.org/projects/test/repos/my-project/commits/cdf62703ae2f277f753860c4653735bf41fb2216)) + +# 0.0.6 (2024-02-28) + +### Features + +- add welcome message to audio queue ([fe3c608](https://bitbucket.org/projects/test/repos/my-project/commits/fe3c60838bbe7ec22f1d31370f4c0505223eeba2)) +- tweak design and audio controls ([a47c14c](https://bitbucket.org/projects/test/repos/my-project/commits/a47c14c80a60d30c94ef3e13684e1bddc389fb62)) + +### Chore + +- remove some logging ([73442a1](https://bitbucket.org/projects/test/repos/my-project/commits/73442a111493688e0815a7f26e9c0796954eb2ce)) + +# 0.0.5 (2024-02-28) + +### Features + +- minor tweaks ([a99eb42](https://bitbucket.org/projects/test/repos/my-project/commits/a99eb42b3deb9c630d38109954c592d6f3a849ed)) +- requeue messages ([3b04f46](https://bitbucket.org/projects/test/repos/my-project/commits/3b04f46c1c99950e4b00739b955eac21bbbb2d12)) +- plug LLM response back into TTS ([d9fbbdd](https://bitbucket.org/projects/test/repos/my-project/commits/d9fbbddc2ef16a6ad76deb2f22905e6dc4a21dcf)) +- audio plays from queue ([9993720](https://bitbucket.org/projects/test/repos/my-project/commits/99937205ed113ae87cee632fed53c6aaf25e38a6)) + +# 0.0.4 (2024-02-21) + +### Features + +- playback TTS response in the browser ([e42f551](https://bitbucket.org/projects/test/repos/my-project/commits/e42f551d801737fe80e4330481e428ca25782776)) +- support streaming response from TTS server ([eb8c97a](https://bitbucket.org/projects/test/repos/my-project/commits/eb8c97a271d9c8f0e48eb5b4afad1c6aef80948d)) +- moving TTS playback control button ([2d65cf7](https://bitbucket.org/projects/test/repos/my-project/commits/2d65cf7d769250d0e81e087a1efc07a3f2a32ebf)) +- add unsent text queue - queue all the things ([71add80](https://bitbucket.org/projects/test/repos/my-project/commits/71add808ff84186447bca5d4942118d087819ad6)) + +# 0.0.3 (2024-02-16) + +### Features + +- overhaul controls ([e8436c8](https://bitbucket.org/projects/test/repos/my-project/commits/e8436c8af56fd0bcf0d9b1ae17963668a8a9e94e)) +- fixing stuff ([b4e1853](https://bitbucket.org/projects/test/repos/my-project/commits/b4e18530041f8ea1d2cedff11511d6da3569ae5e)) +- remove guard ([aae419d](https://bitbucket.org/projects/test/repos/my-project/commits/aae419d27505b8498c8c1f651f4a7f008959d11a)) +- remove edge from core page ([6c2e221](https://bitbucket.org/projects/test/repos/my-project/commits/6c2e2214f09a373ebf79af1727a900e24408b497)) +- edge build ([7684598](https://bitbucket.org/projects/test/repos/my-project/commits/7684598daaa04de523230066c4b78f26685c3d88)) + +### Bug Fixes + +- renaming component cases ([9e0e112](https://bitbucket.org/projects/test/repos/my-project/commits/9e0e112f1a8c9afdbaa0139bd27c6112e6f72f7d)) +- fix casing problems ([00ef060](https://bitbucket.org/projects/test/repos/my-project/commits/00ef060ae672377b95d63d42f2425f9d5f845d09)) + +### Chores + +- use component aliases ([ab5fa9b](https://bitbucket.org/projects/test/repos/my-project/commits/ab5fa9b6ea4930cf4fa83a43eecedae752178325)) + +# 0.0.2 (2024-02-16) + +### Features + +- llm integrated into chatbot ([ce13e56](https://bitbucket.org/projects/test/repos/my-project/commits/ce13e564d872d642f797d19636b77cf246a28f56)) + +### Bug Fixes + +- fix callback deps ([f28bde8](https://bitbucket.org/projects/test/repos/my-project/commits/f28bde83793f4b44d7174e5c6d5e4a1803a02aeb)) +- update deepgram transcription options ([b620eaf](https://bitbucket.org/projects/test/repos/my-project/commits/b620eaff635277691f92f9cca2137766d8228e36)) +- fix background on mobile ([10e5901](https://bitbucket.org/projects/test/repos/my-project/commits/10e59013ded39eb1a7edaeb468a0658f9b112b39)) + +### Chores + +- llm initial setup ([7d23b1a](https://bitbucket.org/projects/test/repos/my-project/commits/7d23b1a862178482f86a3fe634658ba7d5872b3a)) + +# 0.0.1 (2024-02-11) + +### Features + +- adding greeting, initial state, key events ([c8308d3](https://bitbucket.org/projects/test/repos/my-project/commits/c8308d343f4f5a2db182206d1db7f64544c8b005)) +- add text entry for conversation (but only when mic is disabled) ([e68833c](https://bitbucket.org/projects/test/repos/my-project/commits/e68833cbbe27c250dd8d3854e13aea2bc12b0795)) +- tidy up before next big bit ([d67e2b2](https://bitbucket.org/projects/test/repos/my-project/commits/d67e2b2e1c0953991b87c7d422a92cd1af8ef798)) +- better volume interaction ([d80849a](https://bitbucket.org/projects/test/repos/my-project/commits/d80849a0f892607fabb1195b8164c58b7c1275cf)) +- window scrolls to bottom smoothly as messages come in ([217b32e](https://bitbucket.org/projects/test/repos/my-project/commits/217b32e6c87af4b41e9d922f9b21cd8e2ed9b298)) +- introduce client-side VAD ([8e16fe5](https://bitbucket.org/projects/test/repos/my-project/commits/8e16fe5e49f360ceab880c8c1cf76633256f9d9e)) +- simplify vad events ([2b78439](https://bitbucket.org/projects/test/repos/my-project/commits/2b7843956de43dae3a4f6268f999b42c9916366e)) + +### Chores + +- pre-LLM request improvements ([8f48453](https://bitbucket.org/projects/test/repos/my-project/commits/8f4845359cce717db167789ace599f509ee06652)) +- transient changes ([9bf74be](https://bitbucket.org/projects/test/repos/my-project/commits/9bf74be35b616e3e1bddcda454c869c4fedf031a)) +- tidy up ([02f0772](https://bitbucket.org/projects/test/repos/my-project/commits/02f0772acdfeed1e1583f209e0becd17baed7619)) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ca84293 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,131 @@ +# Code of Conduct + +The Deepgram developer community is filled with amazing, clever and creative people, and we're excited for you to join us. Our goal is to create safe and inclusive spaces, have meaningful conversations, and explore ways to make sure that every voice is heard and understood. + +#### Being a Good Community Member + +Because we prioritize creating a safe space for our members, we believe in actively working on how we, as individuals, can ensure a positive community environment through our own actions and mindsets. + +Every supportive community starts with each member. We feel it’s important to be open to others, respectful, and supportive. As part of the Deepgram community, please begin by thinking carefully about and agreeing with the following statements: + +- I will be welcoming to everyone at the table; +- I will be patient and open to learning from everyone around me; +- I will treat everyone with respect, because they deserve it; +- I will be mindful of the needs and boundaries of others; + +We strive to create a space where we learn and grow together. Here are some other key things you can do to make the community great: + +### BE HUMBLE + +People come from all different places, and it’s best not to make assumptions about what they think or feel. Approach others with curiosity and openness. We **all** have a lot to learn from each other. + +### BE HELPFUL + +If someone asks for help, consider jumping in. You don’t have to be an expert to talk through a problem, suggest a resource, or help find a solution. We all have something to contribute. + +### ENCOURAGE OTHERS + +There’s no one path to have a career in technology or to this community. Let’s engage others in ways that create opportunities for learning and fun for all of us. + +## Our Pledge + +Everyone who participates in our community must agree to abide by our Code of Conduct. By agreeing, you help create a welcoming, respectful, and friendly community based on respect and trust. We are committed to creating a harassment-free community. + +These rules will be strictly enforced in any and all of our official spaces, including direct messages, social media, and physical and virtual events. Everyone who participates in these spaces is required to agree to this community code. We also ask and expect community members to observe these rules anywhere the community is meeting (for example, online chats on unofficial platforms or event after-parties). + +## Our Standards + +### BE RESPECTFUL + +Exercise consideration and respect in your speech and actions. Be willing to accept and give feedback gracefully. + +Don’t make offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, neuro(a)typicality, physical appearance, body size, race, ethnicity, immigration status, religion, experience level, socioeconomic status, nationality, or other identity markers. + +Additionally, don’t insult or demean others. This includes making unwelcome comments about a person’s lifestyle choices and practices, including things related to diet, health, parenting, drugs, or employment. It’s not okay to insult or demean others if it’s "just a joke." + +### BE WELCOMING AND OPEN + +Encourage others, be supportive and willing to listen, and be willing to learn from others’ perspectives and experiences. Lead with empathy and kindness. + +Don’t engage in gatekeeping behaviors, like questioning the intelligence or knowledge of others as a way to prove their credentials. And don’t exclude people for prejudicial reasons. + +### RESPECT PRIVACY + +Do not publish private communications without consent. Additionally, never disclose private aspects of a person’s personal identity without consent, except as necessary to protect them from intentional abuse. + +### RESPECT PERSONAL BOUNDARIES + +Do not introduce gratuitous or off-topic sexual images, languages, or behavior in spaces where they are not appropriate. Never make physical contact or simulated physical contact without consent or after a request to stop. Additionally, do not continue to message others about anything if they ask you to stop or leave them alone. + +#### BE A GOOD NEIGHBOR + +Contribute to the community in a positive and thoughtful way. Consider what’s best for the overall community. Do not make threats of violence, intimidate others, incite violence or intimidation against others, incite self-harm, stalk, follow, or otherwise harass others. Be mindful of your surroundings and of your fellow participants. + +Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential. + +# Additional rules for online spaces + +For Deepgram’s official online spaces, like our YouTube & Twitch chats, we have some additional rules. Any of the following behaviors can result in a ban without warning. + +### DON'T SPAM + +Don't spam. We'll ban you. + +### KEEP IT LEGAL + +If it’s illegal, it’s not allowed on our websites or in our online spaces. Please don’t share links to pirated material or other nefarious things. + +### NO TROLLING + +Please be earnest. Don’t use excessive sarcasm to annoy or undermine other people. And don’t bait them with bad faith comments or abuse. + +### PORNOGRAPHY AND OTHER NSFW STUFF + +Please don’t post it or link to it. It doesn’t belong in our online spaces. + +### FOUL AND GRAPHIC LANGUAGE + +Please do not use excessive curse words. Additionally, do not use graphic sexual or violent language — again, think of our spaces as places for people of all ages. + +# Enforcement & Reporting + +If you are being harassed by a member of the Deepgram developer community, if you observe someone else being harassed, or you experience actions or behaviors that are contrary to our Code of Conduct, please report the behavior by contacting our team at [devrel@deepgram.com](mailto:devrel@deepgram.com). + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**_Community Impact:_** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. + +**_Consequence:_** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**_Community Impact:_** A violation through a single incident or series of actions. + +**_Consequence:_** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. + +### 3. Temporary Ban + +**_Community Impact:_** A serious violation of community standards, including sustained inappropriate behavior. + +**_Consequence:_** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**_Community Impact:_** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. + +**_Consequence:_** A permanent ban from any sort of public interaction within the community. + +# Attribution + +This Code of Conduct is adapted from: + +- Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct +- https://eventhandler.community/conduct/, which itself is inspired by Quest, who in turn provides credit to Scripto, the #botALLY Code of Conduct, the LGBTQ in Tech code of Conduct, and the XOXO Code of Conduct. + +Community Impact Guidelines, which were copied from InnerSource Commons, were inspired by Mozilla’s code of conduct enforcement ladder. + +For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..af13027 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributing Guidelines + +Want to contribute to this project? We ❤️ it! + +Here are a few types of contributions that we would be interested in hearing about. + +- Bug fixes + - If you find a bug, please first report it using Github Issues. + - Issues that have already been identified as a bug will be labeled `🐛 bug`. + - If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number. + - Include a test that isolates the bug and verifies that it was fixed. +- New Features + - If you'd like to accomplish something in the extension that it doesn't already do, describe the problem in a new Github Issue. + - Issues that have been identified as a feature request will be labeled `✨ enhancement`. + - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending + too much time writing the code. In some cases, `✨ enhancement`s may not align well with the project objectives at + the time. +- Tests, Documentation, Miscellaneous + - If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative + implementation of something that may have more advantages, or any other change we would still be glad hear about + it. + - If its a trivial change, go ahead and send a Pull Request with the changes you have in mind + - If not, open a Github Issue to discuss the idea first. +- Snippets + - To add snippets: + - Add a directory in the `snippets` folder with the name of the language. + - Add one or more files in the language directory with snippets. + - Update the `package.json` to include the snippets you added. + +We also welcome anyone to work on any existing issues with the `👋🏽 good first issue` tag. + +## Requirements + +For a contribution to be accepted: + +- The test suite must be complete and pass +- Code must follow existing styling conventions +- Commit messages must be descriptive. Related issues should be mentioned by number. + +If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still +continue to add more commits to the branch you have sent the Pull Request from. + +## How To + +1. Fork this repository on GitHub. +1. Clone/fetch your fork to your local development machine. +1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out. +1. Make your changes and commit them. (Did the tests pass? No linting errors?) +1. Push your new branch to your fork. (e.g. `git push myname issue-12`) +1. Open a Pull Request from your new branch to the original fork's `main` branch. diff --git a/KNOWN_ISSUES.md b/KNOWN_ISSUES.md deleted file mode 100644 index 2f2372a..0000000 --- a/KNOWN_ISSUES.md +++ /dev/null @@ -1 +0,0 @@ -# Known Issues diff --git a/README.md b/README.md new file mode 100644 index 0000000..c2f9ccd --- /dev/null +++ b/README.md @@ -0,0 +1,116 @@ +# React NowPlaying + +[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4) + +A cross-browser cross-device friendly React context to auto-play audio in a browser. + +## Demo / Development + +This repo has a self-contained demo that does not get bundled with the package. To run this locally, you simply need to do the following; + +```bash +# install dependencies +npm i + +# run local demo +npm run dev +``` + +## Getting Started + +### Installation + +```bash +npm i react-nowplaying +``` + +### Add to your project + +Import the React context provider; + +```tsx +import { NowPlayingContextProvider } from "react-nowplaying"; +``` + +And, just as any custom context provider, wrap the part of your app you need to be context aware in the custom provider's tags. + +```tsx +// layout.tsx + +//... + +export default function RootLayout({ + children, +}: Readonly<{ + children: React.ReactNode; +}>) { + return ( + + + {children} // e.g. custom provider tags wrap entire body of app + + + ); +} +``` + +Now, you can provide your data `Blob` to the play function. + +```tsx +export default function MyComponent() { + const { play } = useNowPlaying(); + + const playAudio = () => { + // get your audio blob + play(blob, "audio/mp3"); + }; + + return ( + + ); +} +``` + +## How It Works + +In our recent project, we faced challenges with automatically playing audio across different browsers and devices, including Safari, Firefox, and all iOS devices. Our solution involved complex adjustments to enable automatic playback of audio files (in Blob format) received from our API. Instead of utilizing the Web Audio API, we opted for a workaround that involves a hidden audio element on the webpage. Here’s how it works: + +- When audio is ready to play, the webpage updates a hidden audio element with the audio source and type, allowing the audio to play automatically. +- We created a custom hook that mimics the audio controls you'd find in the Web Audio API, making it easier to manage playback. This includes features for playing and finishing, with callbacks named onPlay and onFinish to handle these actions. +- Additionally, this custom hook provides a player object, which can be used to attach custom event handlers for more advanced audio control. + +This approach allows for seamless audio playback across a wide range of browsers and devices, ensuring users have a consistent experience. + +## Getting Help + +We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either: + +- [Open an issue in this repository](https://github.com/deepgram-devs/deepgram-aura-tts-demo/issues) +- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions) +- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4) + +## Author + +[Deepgram](https://deepgram.com) + +## Known Issues + +For a list of known issues and potential bugs, please visit our [Issues](https://github.com/deepgram-devs/react-nowplaying/issues) page. We regularly update this section as new issues are discovered and resolved. + +## Collaborating + +We welcome contributions from the community. For instructions on how to get involved, please read our [Collaborating Guide](CONTRIBUTING.md). + +## Code of Conduct + +To ensure a welcoming and safe environment for all contributors, we adhere to a Code of Conduct. All participants in our project are expected to read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). We are committed to making participation in this project a harassment-free experience for everyone. + +## Changelog + +Stay updated with the changes and improvements made to our project by checking out our [Changelog](CHANGELOG.md). This document includes a detailed list of changes, including new features, bug fixes, and other important updates. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details. diff --git a/package.json b/package.json index 1d58078..235c2e7 100644 --- a/package.json +++ b/package.json @@ -16,11 +16,10 @@ "cross-browser", "cross-device" ], - "author": "", + "author": "Luke Oliff (https://deepgram.com)", "license": "MIT", "scripts": { "dev": "concurrently --kill-others \"tsc-watch\" \"npm --prefix=demo/ run dev\"", - "preview-build": "tsc -p tsconfig.json && npm --prefix=demo/ run build", "build": "tsc -p tsconfig.json" }, "resolutions": {