@corti/dictation-web 0.3.0 → 0.4.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (201) hide show
  1. package/README.md +9 -4
  2. package/dist/bundle.js +3100 -1630
  3. package/dist/components/audio-visualiser.d.ts +5 -3
  4. package/dist/components/audio-visualiser.js +38 -46
  5. package/dist/components/audio-visualiser.js.map +1 -1
  6. package/dist/components/corti-dictation.d.ts +122 -0
  7. package/dist/components/corti-dictation.js +238 -0
  8. package/dist/components/corti-dictation.js.map +1 -0
  9. package/dist/components/device-selector.d.ts +14 -0
  10. package/dist/components/device-selector.js +75 -0
  11. package/dist/components/device-selector.js.map +1 -0
  12. package/dist/components/language-selector.d.ts +15 -0
  13. package/dist/components/language-selector.js +74 -0
  14. package/dist/components/language-selector.js.map +1 -0
  15. package/dist/components/recording-button.d.ts +29 -0
  16. package/dist/components/recording-button.js +217 -0
  17. package/dist/components/recording-button.js.map +1 -0
  18. package/dist/components/settings-menu.d.ts +9 -15
  19. package/dist/components/settings-menu.js +48 -161
  20. package/dist/components/settings-menu.js.map +1 -1
  21. package/dist/constants.d.ts +8 -2
  22. package/dist/constants.js +38 -12
  23. package/dist/constants.js.map +1 -1
  24. package/dist/contexts/dictation-context.d.ts +99 -0
  25. package/dist/contexts/dictation-context.js +257 -0
  26. package/dist/contexts/dictation-context.js.map +1 -0
  27. package/dist/controllers/DictationController.d.ts +35 -0
  28. package/dist/controllers/DictationController.js +130 -0
  29. package/dist/controllers/DictationController.js.map +1 -0
  30. package/dist/controllers/MediaController.d.ts +31 -0
  31. package/dist/controllers/MediaController.js +99 -0
  32. package/dist/controllers/MediaController.js.map +1 -0
  33. package/dist/controllers/devices-controller.d.ts +26 -0
  34. package/dist/controllers/devices-controller.js +99 -0
  35. package/dist/controllers/devices-controller.js.map +1 -0
  36. package/dist/controllers/dictation-controller.d.ts +28 -0
  37. package/dist/controllers/dictation-controller.js +141 -0
  38. package/dist/controllers/dictation-controller.js.map +1 -0
  39. package/dist/controllers/languages-controller.d.ts +26 -0
  40. package/dist/controllers/languages-controller.js +83 -0
  41. package/dist/controllers/languages-controller.js.map +1 -0
  42. package/dist/controllers/media-controller.d.ts +24 -0
  43. package/dist/controllers/media-controller.js +115 -0
  44. package/dist/controllers/media-controller.js.map +1 -0
  45. package/dist/index.d.ts +9 -1
  46. package/dist/index.js +29 -3
  47. package/dist/index.js.map +1 -1
  48. package/dist/package.json +14 -0
  49. package/dist/src/components/audio-visualiser.d.ts +14 -0
  50. package/dist/src/components/audio-visualiser.js +57 -0
  51. package/dist/src/components/audio-visualiser.js.map +1 -0
  52. package/dist/src/components/corti-dictation.d.ts +123 -0
  53. package/dist/src/components/corti-dictation.js +224 -0
  54. package/dist/src/components/corti-dictation.js.map +1 -0
  55. package/dist/src/components/device-selector.d.ts +24 -0
  56. package/dist/src/components/device-selector.js +106 -0
  57. package/dist/src/components/device-selector.js.map +1 -0
  58. package/dist/src/components/language-selector.d.ts +24 -0
  59. package/dist/src/components/language-selector.js +100 -0
  60. package/dist/src/components/language-selector.js.map +1 -0
  61. package/dist/src/components/recording-button.d.ts +37 -0
  62. package/dist/src/components/recording-button.js +203 -0
  63. package/dist/src/components/recording-button.js.map +1 -0
  64. package/dist/src/components/settings-menu.d.ts +16 -0
  65. package/dist/src/components/settings-menu.js +80 -0
  66. package/dist/src/components/settings-menu.js.map +1 -0
  67. package/dist/src/constants.d.ts +4 -0
  68. package/dist/src/constants.js +37 -0
  69. package/dist/src/constants.js.map +1 -0
  70. package/dist/src/contexts/dictation-context.d.ts +97 -0
  71. package/dist/src/contexts/dictation-context.js +208 -0
  72. package/dist/src/contexts/dictation-context.js.map +1 -0
  73. package/dist/src/controllers/DictationController.d.ts +35 -0
  74. package/dist/src/controllers/DictationController.js +130 -0
  75. package/dist/src/controllers/DictationController.js.map +1 -0
  76. package/dist/src/controllers/MediaController.d.ts +31 -0
  77. package/dist/src/controllers/MediaController.js +99 -0
  78. package/dist/src/controllers/MediaController.js.map +1 -0
  79. package/dist/src/icons/icons.d.ts +17 -0
  80. package/dist/src/icons/icons.js +158 -0
  81. package/dist/src/icons/icons.js.map +1 -0
  82. package/dist/src/styles/ComponentStyles.d.ts +2 -0
  83. package/dist/src/styles/ComponentStyles.js +18 -0
  84. package/dist/src/styles/ComponentStyles.js.map +1 -0
  85. package/dist/src/styles/audio-visualiser.d.ts +2 -0
  86. package/dist/src/styles/audio-visualiser.js +33 -0
  87. package/dist/src/styles/audio-visualiser.js.map +1 -0
  88. package/dist/src/styles/buttons.d.ts +2 -0
  89. package/dist/src/styles/buttons.js +52 -0
  90. package/dist/src/styles/buttons.js.map +1 -0
  91. package/dist/src/styles/callout.d.ts +2 -0
  92. package/dist/src/styles/callout.js +23 -0
  93. package/dist/src/styles/callout.js.map +1 -0
  94. package/dist/src/styles/default-theme.d.ts +2 -0
  95. package/dist/src/styles/default-theme.js +50 -0
  96. package/dist/src/styles/default-theme.js.map +1 -0
  97. package/dist/src/styles/recording-button.d.ts +2 -0
  98. package/dist/src/styles/recording-button.js +8 -0
  99. package/dist/src/styles/recording-button.js.map +1 -0
  100. package/dist/src/styles/select.d.ts +2 -0
  101. package/dist/src/styles/select.js +36 -0
  102. package/dist/src/styles/select.js.map +1 -0
  103. package/dist/src/styles/settings-menu.d.ts +2 -0
  104. package/dist/src/styles/settings-menu.js +34 -0
  105. package/dist/src/styles/settings-menu.js.map +1 -0
  106. package/dist/src/types.d.ts +7 -0
  107. package/dist/src/types.js +2 -0
  108. package/dist/src/types.js.map +1 -0
  109. package/dist/src/utils/auth.d.ts +9 -0
  110. package/dist/src/utils/auth.js +21 -0
  111. package/dist/src/utils/auth.js.map +1 -0
  112. package/dist/src/utils/converters.d.ts +4 -0
  113. package/dist/src/utils/converters.js +8 -0
  114. package/dist/src/utils/converters.js.map +1 -0
  115. package/dist/src/utils/devices.d.ts +26 -0
  116. package/dist/src/utils/devices.js +53 -0
  117. package/dist/src/utils/devices.js.map +1 -0
  118. package/dist/src/utils/events.d.ts +44 -0
  119. package/dist/src/utils/events.js +88 -0
  120. package/dist/src/utils/events.js.map +1 -0
  121. package/dist/src/utils/languages.d.ts +7 -0
  122. package/dist/src/utils/languages.js +29 -0
  123. package/dist/src/utils/languages.js.map +1 -0
  124. package/dist/src/utils/media.d.ts +6 -0
  125. package/dist/src/utils/media.js +39 -0
  126. package/dist/src/utils/media.js.map +1 -0
  127. package/dist/src/utils/token.d.ts +13 -0
  128. package/dist/src/utils/token.js +60 -0
  129. package/dist/src/utils/token.js.map +1 -0
  130. package/dist/src/utils/validation.d.ts +1 -0
  131. package/dist/src/utils/validation.js +7 -0
  132. package/dist/src/utils/validation.js.map +1 -0
  133. package/dist/stories/audio-visualiser.stories.d.ts +39 -0
  134. package/dist/stories/audio-visualiser.stories.js +71 -0
  135. package/dist/stories/audio-visualiser.stories.js.map +1 -0
  136. package/dist/stories/corti-dictation.stories.d.ts +27 -0
  137. package/dist/stories/corti-dictation.stories.js +129 -0
  138. package/dist/stories/corti-dictation.stories.js.map +1 -0
  139. package/dist/stories/device-selector.stories.d.ts +18 -0
  140. package/dist/stories/device-selector.stories.js +84 -0
  141. package/dist/stories/device-selector.stories.js.map +1 -0
  142. package/dist/stories/language-selector.stories.d.ts +18 -0
  143. package/dist/stories/language-selector.stories.js +53 -0
  144. package/dist/stories/language-selector.stories.js.map +1 -0
  145. package/dist/stories/recording-button.stories.d.ts +27 -0
  146. package/dist/stories/recording-button.stories.js +90 -0
  147. package/dist/stories/recording-button.stories.js.map +1 -0
  148. package/dist/stories/settings-menu.stories.d.ts +23 -0
  149. package/dist/stories/settings-menu.stories.js +156 -0
  150. package/dist/stories/settings-menu.stories.js.map +1 -0
  151. package/dist/styles/ComponentStyles.js +5 -39
  152. package/dist/styles/ComponentStyles.js.map +1 -1
  153. package/dist/styles/audio-visualiser.d.ts +2 -0
  154. package/dist/styles/audio-visualiser.js +33 -0
  155. package/dist/styles/audio-visualiser.js.map +1 -0
  156. package/dist/styles/buttons.js +19 -26
  157. package/dist/styles/buttons.js.map +1 -1
  158. package/dist/styles/callout.js +7 -17
  159. package/dist/styles/callout.js.map +1 -1
  160. package/dist/styles/component-styles.d.ts +2 -0
  161. package/dist/styles/component-styles.js +22 -0
  162. package/dist/styles/component-styles.js.map +1 -0
  163. package/dist/styles/default-theme.d.ts +2 -0
  164. package/dist/styles/default-theme.js +14 -0
  165. package/dist/styles/default-theme.js.map +1 -0
  166. package/dist/styles/recording-button.d.ts +2 -0
  167. package/dist/styles/recording-button.js +8 -0
  168. package/dist/styles/recording-button.js.map +1 -0
  169. package/dist/styles/select.js +9 -9
  170. package/dist/styles/select.js.map +1 -1
  171. package/dist/styles/settings-menu.d.ts +2 -0
  172. package/dist/styles/settings-menu.js +34 -0
  173. package/dist/styles/settings-menu.js.map +1 -0
  174. package/dist/tsconfig.stories.tsbuildinfo +1 -0
  175. package/dist/types.d.ts +6 -8
  176. package/dist/types.js.map +1 -1
  177. package/dist/utils/auth.d.ts +9 -0
  178. package/dist/utils/auth.js +21 -0
  179. package/dist/utils/auth.js.map +1 -0
  180. package/dist/utils/converters.d.ts +4 -0
  181. package/dist/utils/converters.js +8 -0
  182. package/dist/utils/converters.js.map +1 -0
  183. package/dist/utils/devices.d.ts +26 -0
  184. package/dist/utils/devices.js +53 -0
  185. package/dist/utils/devices.js.map +1 -0
  186. package/dist/utils/events.d.ts +44 -0
  187. package/dist/utils/events.js +88 -0
  188. package/dist/utils/events.js.map +1 -0
  189. package/dist/utils/languages.d.ts +8 -0
  190. package/dist/utils/languages.js +29 -0
  191. package/dist/utils/languages.js.map +1 -0
  192. package/dist/utils/media.d.ts +6 -0
  193. package/dist/utils/media.js +39 -0
  194. package/dist/utils/media.js.map +1 -0
  195. package/dist/utils/token.d.ts +13 -0
  196. package/dist/utils/token.js +60 -0
  197. package/dist/utils/token.js.map +1 -0
  198. package/dist/utils/validation.d.ts +1 -0
  199. package/dist/utils/validation.js +7 -0
  200. package/dist/utils/validation.js.map +1 -0
  201. package/package.json +29 -55
package/README.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Corti Dictation Web Component
2
2
 
3
+ [![Published on npm](https://img.shields.io/npm/v/@corti/dictation-web.svg?logo=npm)](https://www.npmjs.com/package/@corti/dictation-web)
4
+ [![License: MIT](https://img.shields.io/npm/l/%40corti%2Fdictation-web)](https://opensource.org/licenses/MIT)
5
+ [![Get Support on Discord](https://img.shields.io/badge/Discord-Get%20Support-5865F2.svg?logo=discord&logoColor=fff)](https://discord.com/invite/zXeXHgnZXX)
6
+ [![Live Demo](https://img.shields.io/badge/Live%20Demo-blue.svg?logo=rocket&logoColor=fff)](https://codepen.io/hccullen/pen/OPJmxQR)
7
+
3
8
  ## Overview
4
9
 
5
10
  The **Corti Dictation Web Component** is a web component that enables real-time speech-to-text dictation using Corti's Dictation API. It provides a simple interface for capturing audio, streaming it to the API, and handling transcripts.
@@ -143,13 +148,13 @@ The refresh mechanism automatically handles token renewal when the access token
143
148
 
144
149
  ## Usage Examples
145
150
 
146
- Explore practical implementations and usage examples in the [Demo Folder](https://github.com/corticph/dictation-web-sdk/tree/main/demo). These demos can also be run locally.
151
+ Explore practical implementations and usage examples in the [Demo Folder](https://github.com/corticph/dictation-web/tree/main/demo). These demos can also be run locally.
147
152
 
148
153
  ## Styling
149
154
 
150
- ![UI Overview](https://github.com/corticph/dictation-web-sdk/blob/main/docs/ui.png)
155
+ ![UI Overview](https://github.com/corticph/dictation-web/blob/main/docs/ui.png)
151
156
 
152
- The default UI is designed to be slotted into existing applications seamlessly, however, it also supports custom styling as well as theming. The UI can be fully customized using CSS properties. Refer to our [Styling Guide](https://github.com/corticph/dictation-web-sdk/blob/main/docs/styling.md) for detailed instructions.
157
+ The default UI is designed to be slotted into existing applications seamlessly, however, it also supports custom styling as well as theming. The UI can be fully customized using CSS properties. Refer to our [Styling Guide](https://github.com/corticph/dictation-web/blob/main/docs/styling.md) for detailed instructions.
153
158
 
154
159
  ## License
155
160
 
@@ -157,4 +162,4 @@ This Web Component library is licensed under MIT.
157
162
 
158
163
  ## Support
159
164
 
160
- For issues or questions, contact **Corti Support** at [support@corti.ai](mailto:help@corti.ai).
165
+ For issues or questions, contact **Corti Support** at [help@corti.ai](mailto:help@corti.ai) or [join our Discord](https://discord.com/invite/zXeXHgnZXX).