@hazeljs/realtime 0.2.0-rc.3
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.
- package/LICENSE +192 -0
- package/README.md +243 -0
- package/dist/index.d.ts +22 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +28 -0
- package/dist/providers/openai/index.d.ts +5 -0
- package/dist/providers/openai/index.d.ts.map +1 -0
- package/dist/providers/openai/index.js +7 -0
- package/dist/providers/openai/openai-realtime.client.d.ts +74 -0
- package/dist/providers/openai/openai-realtime.client.d.ts.map +1 -0
- package/dist/providers/openai/openai-realtime.client.js +211 -0
- package/dist/providers/openai/openai-realtime.client.test.d.ts +2 -0
- package/dist/providers/openai/openai-realtime.client.test.d.ts.map +1 -0
- package/dist/providers/openai/openai-realtime.client.test.js +262 -0
- package/dist/providers/openai/openai-realtime.session.d.ts +63 -0
- package/dist/providers/openai/openai-realtime.session.d.ts.map +1 -0
- package/dist/providers/openai/openai-realtime.session.js +95 -0
- package/dist/providers/openai/openai-realtime.session.test.d.ts +2 -0
- package/dist/providers/openai/openai-realtime.session.test.d.ts.map +1 -0
- package/dist/providers/openai/openai-realtime.session.test.js +149 -0
- package/dist/realtime-bootstrap.service.d.ts +16 -0
- package/dist/realtime-bootstrap.service.d.ts.map +1 -0
- package/dist/realtime-bootstrap.service.js +23 -0
- package/dist/realtime.gateway.d.ts +45 -0
- package/dist/realtime.gateway.d.ts.map +1 -0
- package/dist/realtime.gateway.js +94 -0
- package/dist/realtime.gateway.test.d.ts +2 -0
- package/dist/realtime.gateway.test.d.ts.map +1 -0
- package/dist/realtime.gateway.test.js +230 -0
- package/dist/realtime.module.d.ts +40 -0
- package/dist/realtime.module.d.ts.map +1 -0
- package/dist/realtime.module.js +87 -0
- package/dist/realtime.service.d.ts +41 -0
- package/dist/realtime.service.d.ts.map +1 -0
- package/dist/realtime.service.js +81 -0
- package/dist/realtime.service.test.d.ts +2 -0
- package/dist/realtime.service.test.d.ts.map +1 -0
- package/dist/realtime.service.test.js +129 -0
- package/dist/realtime.types.d.ts +81 -0
- package/dist/realtime.types.d.ts.map +1 -0
- package/dist/realtime.types.js +5 -0
- package/dist/realtime.types.test.d.ts +2 -0
- package/dist/realtime.types.test.d.ts.map +1 -0
- package/dist/realtime.types.test.js +61 -0
- package/package.json +58 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
Copyright 2024 HazelJS Team
|
|
6
|
+
|
|
7
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
8
|
+
you may not use this file except in compliance with the License.
|
|
9
|
+
You may obtain a copy of the License at
|
|
10
|
+
|
|
11
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
+
|
|
13
|
+
Unless required by applicable law or agreed to in writing, software
|
|
14
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
15
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
16
|
+
See the License for the specific language governing permissions and
|
|
17
|
+
limitations under the License.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
22
|
+
|
|
23
|
+
1. Definitions.
|
|
24
|
+
|
|
25
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
26
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
27
|
+
|
|
28
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
29
|
+
the copyright owner that is granting the License.
|
|
30
|
+
|
|
31
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
32
|
+
other entities that control, are controlled by, or are under common
|
|
33
|
+
control with that entity. For the purposes of this definition,
|
|
34
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
35
|
+
direction or management of such entity, whether by contract or
|
|
36
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
37
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
38
|
+
|
|
39
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
40
|
+
exercising permissions granted by this License.
|
|
41
|
+
|
|
42
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
43
|
+
including but not limited to software source code, documentation
|
|
44
|
+
source, and configuration files.
|
|
45
|
+
|
|
46
|
+
"Object" form shall mean any form resulting from mechanical
|
|
47
|
+
transformation or translation of a Source form, including but
|
|
48
|
+
not limited to compiled object code, generated documentation,
|
|
49
|
+
and conversions to other media types.
|
|
50
|
+
|
|
51
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
52
|
+
Object form, made available under the License, as indicated by a
|
|
53
|
+
copyright notice that is included in or attached to the work
|
|
54
|
+
(an example is provided in the Appendix below).
|
|
55
|
+
|
|
56
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
57
|
+
form, that is based on (or derived from) the Work and for which the
|
|
58
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
59
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
60
|
+
of this License, Derivative Works shall not include works that remain
|
|
61
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
62
|
+
the Work and Derivative Works thereof.
|
|
63
|
+
|
|
64
|
+
"Contribution" shall mean any work of authorship, including
|
|
65
|
+
the original version of the Work and any modifications or additions
|
|
66
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
67
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
68
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
69
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
70
|
+
means any form of electronic, verbal, or written communication sent
|
|
71
|
+
to the Licensor or its representatives, including but not limited to
|
|
72
|
+
communication on electronic mailing lists, source code control systems,
|
|
73
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
74
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
75
|
+
excluding communication that is conspicuously marked or otherwise
|
|
76
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
77
|
+
|
|
78
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
79
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
80
|
+
subsequently incorporated within the Work.
|
|
81
|
+
|
|
82
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
83
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
84
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
85
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
86
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
87
|
+
Work and such Derivative Works in Source or Object form.
|
|
88
|
+
|
|
89
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
90
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
91
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
92
|
+
(except as stated in this section) patent license to make, have made,
|
|
93
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
94
|
+
where such license applies only to those patent claims licensable
|
|
95
|
+
by such Contributor that are necessarily infringed by their
|
|
96
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
97
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
98
|
+
institute patent litigation against any entity (including a
|
|
99
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
100
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
101
|
+
or contributory patent infringement, then any patent licenses
|
|
102
|
+
granted to You under this License for that Work shall terminate
|
|
103
|
+
as of the date such litigation is filed.
|
|
104
|
+
|
|
105
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
106
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
107
|
+
modifications, and in Source or Object form, provided that You
|
|
108
|
+
meet the following conditions:
|
|
109
|
+
|
|
110
|
+
(a) You must give any other recipients of the Work or
|
|
111
|
+
Derivative Works a copy of this License; and
|
|
112
|
+
|
|
113
|
+
(b) You must cause any modified files to carry prominent notices
|
|
114
|
+
stating that You changed the files; and
|
|
115
|
+
|
|
116
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
117
|
+
that You distribute, all copyright, patent, trademark, and
|
|
118
|
+
attribution notices from the Source form of the Work,
|
|
119
|
+
excluding those notices that do not pertain to any part of
|
|
120
|
+
the Derivative Works; and
|
|
121
|
+
|
|
122
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
123
|
+
distribution, then any Derivative Works that You distribute must
|
|
124
|
+
include a readable copy of the attribution notices contained
|
|
125
|
+
within such NOTICE file, excluding those notices that do not
|
|
126
|
+
pertain to any part of the Derivative Works, in at least one
|
|
127
|
+
of the following places: within a NOTICE text file distributed
|
|
128
|
+
as part of the Derivative Works; within the Source form or
|
|
129
|
+
documentation, if provided along with the Derivative Works; or,
|
|
130
|
+
within a display generated by the Derivative Works, if and
|
|
131
|
+
wherever such third-party notices normally appear. The contents
|
|
132
|
+
of the NOTICE file are for informational purposes only and
|
|
133
|
+
do not modify the License. You may add Your own attribution
|
|
134
|
+
notices within Derivative Works that You distribute, alongside
|
|
135
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
136
|
+
that such additional attribution notices cannot be construed
|
|
137
|
+
as modifying the License.
|
|
138
|
+
|
|
139
|
+
You may add Your own copyright statement to Your modifications and
|
|
140
|
+
may provide additional or different license terms and conditions
|
|
141
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
142
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
143
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
144
|
+
the conditions stated in this License.
|
|
145
|
+
|
|
146
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
147
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
148
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
149
|
+
this License, without any additional terms or conditions.
|
|
150
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
151
|
+
the terms of any separate license agreement you may have executed
|
|
152
|
+
with Licensor regarding such Contributions.
|
|
153
|
+
|
|
154
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
155
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
156
|
+
except as required for reasonable and customary use in describing the
|
|
157
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
158
|
+
|
|
159
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
160
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
161
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
162
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
163
|
+
implied, including, without limitation, any warranties or conditions
|
|
164
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
165
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
166
|
+
appropriateness of using or redistributing the Work and assume any
|
|
167
|
+
risks associated with Your exercise of permissions under this License.
|
|
168
|
+
|
|
169
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
170
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
171
|
+
unless required by applicable law (such as deliberate and grossly
|
|
172
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
173
|
+
liable to You for damages, including any direct, indirect, special,
|
|
174
|
+
incidental, or consequential damages of any character arising as a
|
|
175
|
+
result of this License or out of the use or inability to use the
|
|
176
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
177
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
178
|
+
other commercial damages or losses), even if such Contributor
|
|
179
|
+
has been advised of the possibility of such damages.
|
|
180
|
+
|
|
181
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
182
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
183
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
184
|
+
or other liability obligations and/or rights consistent with this
|
|
185
|
+
License. However, in accepting such obligations, You may act only
|
|
186
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
187
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
188
|
+
defend, and hold each Contributor harmless for any liability
|
|
189
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
190
|
+
of your accepting any such warranty or additional liability.
|
|
191
|
+
|
|
192
|
+
END OF TERMS AND CONDITIONS
|
package/README.md
ADDED
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
# @hazeljs/realtime
|
|
2
|
+
|
|
3
|
+
**Voice AI, the HazelJS way.**
|
|
4
|
+
|
|
5
|
+
Low-latency speech-to-speech with OpenAI Realtime API. Connect via WebSocket for voice conversations with sub-second latency — no separate STT → LLM → TTS pipeline.
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@hazeljs/realtime)
|
|
8
|
+
[](https://www.npmjs.com/package/@hazeljs/realtime)
|
|
9
|
+
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- 🎙️ **Speech-to-Speech** — Native voice in, voice out — no intermediate text step
|
|
14
|
+
- ⚡ **Low Latency** — Sub-second response via WebSocket to OpenAI Realtime API
|
|
15
|
+
- 🔌 **WebSocket** — Built on @hazeljs/websocket with @Realtime decorator
|
|
16
|
+
- 🎛️ **Configurable** — Instructions, voice, output modalities per session
|
|
17
|
+
- 🔄 **Bidirectional** — Proxy client ↔ OpenAI; send audio, receive audio + text
|
|
18
|
+
- 📡 **Event-Driven** — Forward any OpenAI Realtime client/server events
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install @hazeljs/realtime @hazeljs/core @hazeljs/websocket
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Environment
|
|
29
|
+
|
|
30
|
+
Set `OPENAI_API_KEY` or pass `openaiApiKey` in `RealtimeModule.forRoot()`.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Quick Start
|
|
35
|
+
|
|
36
|
+
### 1. Register Realtime Module
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
// app.module.ts
|
|
40
|
+
import { HazelModule } from '@hazeljs/core';
|
|
41
|
+
import { RealtimeModule } from '@hazeljs/realtime';
|
|
42
|
+
|
|
43
|
+
@HazelModule({
|
|
44
|
+
imports: [
|
|
45
|
+
RealtimeModule.forRoot({
|
|
46
|
+
openaiApiKey: process.env.OPENAI_API_KEY,
|
|
47
|
+
path: '/realtime',
|
|
48
|
+
defaultSessionConfig: {
|
|
49
|
+
instructions: 'You are a helpful voice assistant. Speak clearly and briefly.',
|
|
50
|
+
voice: 'marin',
|
|
51
|
+
outputModalities: ['audio', 'text'],
|
|
52
|
+
},
|
|
53
|
+
}),
|
|
54
|
+
],
|
|
55
|
+
})
|
|
56
|
+
export class AppModule {}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### 2. Bootstrap
|
|
60
|
+
|
|
61
|
+
```typescript
|
|
62
|
+
// main.ts
|
|
63
|
+
import { HazelApp } from '@hazeljs/core';
|
|
64
|
+
import { AppModule } from './app.module';
|
|
65
|
+
|
|
66
|
+
async function bootstrap() {
|
|
67
|
+
const app = new HazelApp(AppModule);
|
|
68
|
+
const port = parseInt(process.env.PORT ?? '3000', 10);
|
|
69
|
+
|
|
70
|
+
await app.listen(port);
|
|
71
|
+
|
|
72
|
+
console.log(`Realtime voice AI at ws://localhost:${port}/realtime`);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
bootstrap().catch(console.error);
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
The RealtimeGateway is automatically attached to the HTTP server when the app starts listening (via `OnApplicationBootstrap`).
|
|
79
|
+
|
|
80
|
+
For advanced use cases (e.g. custom HTTP server, attaching to a different port), you can still attach manually:
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
import { RealtimeGateway } from '@hazeljs/realtime';
|
|
84
|
+
|
|
85
|
+
const server = app.getServer();
|
|
86
|
+
const gateway = app.getContainer().resolve(RealtimeGateway);
|
|
87
|
+
if (server && gateway) gateway.attachToServer(server);
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 3. Connect from Client
|
|
91
|
+
|
|
92
|
+
```javascript
|
|
93
|
+
const ws = new WebSocket('ws://localhost:3000/realtime');
|
|
94
|
+
|
|
95
|
+
ws.onopen = () => {
|
|
96
|
+
// Optional: update session config
|
|
97
|
+
ws.send(JSON.stringify({
|
|
98
|
+
type: 'session.update',
|
|
99
|
+
session: { instructions: 'Be extra friendly!' },
|
|
100
|
+
}));
|
|
101
|
+
};
|
|
102
|
+
|
|
103
|
+
ws.onmessage = (e) => {
|
|
104
|
+
const { event, data } = JSON.parse(e.data);
|
|
105
|
+
if (event === 'realtime') {
|
|
106
|
+
if (data.type === 'response.output_audio.delta') {
|
|
107
|
+
// Play base64 PCM: data.delta
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
};
|
|
111
|
+
|
|
112
|
+
// Send audio (base64 PCM 24kHz)
|
|
113
|
+
ws.send(JSON.stringify({
|
|
114
|
+
type: 'input_audio_buffer.append',
|
|
115
|
+
audio: base64PcmChunk,
|
|
116
|
+
}));
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## Configuration
|
|
122
|
+
|
|
123
|
+
### RealtimeModule.forRoot(options)
|
|
124
|
+
|
|
125
|
+
| Option | Type | Description |
|
|
126
|
+
|--------|------|-------------|
|
|
127
|
+
| `openaiApiKey` | string | OpenAI API key (or use `OPENAI_API_KEY` env) |
|
|
128
|
+
| `path` | string | WebSocket path (default: `/realtime`) |
|
|
129
|
+
| `defaultSessionConfig` | RealtimeSessionConfig | Default session config |
|
|
130
|
+
| `defaultProvider` | 'openai' \| 'gemini' | Provider (OpenAI supported first) |
|
|
131
|
+
|
|
132
|
+
### RealtimeSessionConfig
|
|
133
|
+
|
|
134
|
+
| Option | Type | Description |
|
|
135
|
+
|--------|------|-------------|
|
|
136
|
+
| `instructions` | string | System prompt for the model |
|
|
137
|
+
| `voice` | OpenAIVoice | alloy, ash, ballad, coral, echo, sage, shimmer, verse, marin, cedar |
|
|
138
|
+
| `outputModalities` | ('audio' \| 'text')[] | Output modes (default: ['audio', 'text']) |
|
|
139
|
+
| `inputFormat` | RealtimeAudioFormat | PCM format (default: 24kHz) |
|
|
140
|
+
| `turnDetection` | boolean | Enable VAD (default: true) |
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
## Client Events
|
|
145
|
+
|
|
146
|
+
Send any [OpenAI Realtime client event](https://platform.openai.com/docs/api-reference/realtime-client-events) over the WebSocket:
|
|
147
|
+
|
|
148
|
+
| Event | Description |
|
|
149
|
+
|-------|-------------|
|
|
150
|
+
| `session.update` | Update session config |
|
|
151
|
+
| `input_audio_buffer.append` | Send base64 PCM audio |
|
|
152
|
+
| `input_audio_buffer.commit` | Commit buffer (when VAD disabled) |
|
|
153
|
+
| `input_audio_buffer.clear` | Clear buffer |
|
|
154
|
+
| `conversation.item.create` | Add text message |
|
|
155
|
+
| `response.create` | Trigger model response |
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
## Server Events
|
|
160
|
+
|
|
161
|
+
You receive `{ event: 'realtime', data: <OpenAI server event> }`:
|
|
162
|
+
|
|
163
|
+
| Event | Description |
|
|
164
|
+
|-------|-------------|
|
|
165
|
+
| `session.created` / `session.updated` | Session lifecycle |
|
|
166
|
+
| `response.output_audio.delta` | Audio chunk (base64) |
|
|
167
|
+
| `response.output_audio.done` | Audio complete |
|
|
168
|
+
| `response.output_text.delta` / `response.output_text.done` | Text stream |
|
|
169
|
+
| `response.done` | Response complete |
|
|
170
|
+
| `input_audio_buffer.speech_started` / `speech_stopped` | VAD events |
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Audio Format
|
|
175
|
+
|
|
176
|
+
- **Input**: PCM 16-bit, 24kHz (or 8kHz for telephony)
|
|
177
|
+
- **Output**: PCM 16-bit, 24kHz
|
|
178
|
+
|
|
179
|
+
Encode/decode base64 for transport over WebSocket.
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
## Use Cases
|
|
184
|
+
|
|
185
|
+
- 🎙️ **Voice Assistants** — Hands-free, low-latency voice interfaces
|
|
186
|
+
- 📞 **Call Centers** — Real-time AI agents with natural speech
|
|
187
|
+
- ♿ **Accessibility** — Voice-first interfaces
|
|
188
|
+
- 🤖 **Robotics** — Voice control for devices
|
|
189
|
+
- 🎮 **Gaming** — In-game voice NPCs
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## API Reference
|
|
194
|
+
|
|
195
|
+
### RealtimeGateway
|
|
196
|
+
|
|
197
|
+
```typescript
|
|
198
|
+
class RealtimeGateway extends WebSocketGateway {
|
|
199
|
+
constructor(realtimeService: RealtimeService, options?: RealtimeGatewayOptions);
|
|
200
|
+
attachToServer(server: HttpServer, options?: { path?: string; maxPayload?: number }): WebSocketServer;
|
|
201
|
+
}
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### RealtimeService
|
|
205
|
+
|
|
206
|
+
```typescript
|
|
207
|
+
class RealtimeService {
|
|
208
|
+
createOpenAISession(client: RealtimeClientAdapter, overrides?: {...}): Promise<OpenAIRealtimeSession>;
|
|
209
|
+
getSession(clientId: string): OpenAIRealtimeSession | undefined;
|
|
210
|
+
removeSession(clientId: string): void;
|
|
211
|
+
getStats(): RealtimeSessionStats[];
|
|
212
|
+
}
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Testing
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
npm test
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## Contributing
|
|
226
|
+
|
|
227
|
+
Contributions are welcome! Please read our [Contributing Guide](../../CONTRIBUTING.md) for details.
|
|
228
|
+
|
|
229
|
+
---
|
|
230
|
+
|
|
231
|
+
## License
|
|
232
|
+
|
|
233
|
+
Apache 2.0 © [HazelJS](https://hazeljs.com)
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## Links
|
|
238
|
+
|
|
239
|
+
- [Documentation](https://hazeljs.com/docs/packages/realtime)
|
|
240
|
+
- [OpenAI Realtime API](https://platform.openai.com/docs/guides/realtime)
|
|
241
|
+
- [GitHub](https://github.com/hazel-js/hazeljs)
|
|
242
|
+
- [Issues](https://github.com/hazel-js/hazeljs/issues)
|
|
243
|
+
- [Discord](https://discord.com/channels/1448263814238965833/1448263814859456575)
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hazeljs/realtime - Real-time voice AI for HazelJS
|
|
3
|
+
*
|
|
4
|
+
* Low-latency speech-to-speech with OpenAI Realtime API.
|
|
5
|
+
* Connect via WebSocket at /realtime for voice conversations.
|
|
6
|
+
*
|
|
7
|
+
* @example
|
|
8
|
+
* ```ts
|
|
9
|
+
* import { HazelApp } from '@hazeljs/core';
|
|
10
|
+
* import { RealtimeModule } from '@hazeljs/realtime';
|
|
11
|
+
*
|
|
12
|
+
* const app = new HazelApp(AppModule);
|
|
13
|
+
* await app.listen(3000);
|
|
14
|
+
* // RealtimeGateway is auto-attached via OnApplicationBootstrap
|
|
15
|
+
* ```
|
|
16
|
+
*/
|
|
17
|
+
export { RealtimeModule } from './realtime.module';
|
|
18
|
+
export { RealtimeService } from './realtime.service';
|
|
19
|
+
export { RealtimeGateway } from './realtime.gateway';
|
|
20
|
+
export { OpenAIRealtimeClient, OpenAIRealtimeSession } from './providers/openai';
|
|
21
|
+
export type { RealtimeProvider, RealtimeSessionConfig, RealtimeModuleOptions, RealtimeSessionStats, OpenAIVoice, RealtimeClientEvent, RealtimeServerEvent, } from './realtime.types';
|
|
22
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AACjF,YAAY,EACV,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACX,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @hazeljs/realtime - Real-time voice AI for HazelJS
|
|
4
|
+
*
|
|
5
|
+
* Low-latency speech-to-speech with OpenAI Realtime API.
|
|
6
|
+
* Connect via WebSocket at /realtime for voice conversations.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* ```ts
|
|
10
|
+
* import { HazelApp } from '@hazeljs/core';
|
|
11
|
+
* import { RealtimeModule } from '@hazeljs/realtime';
|
|
12
|
+
*
|
|
13
|
+
* const app = new HazelApp(AppModule);
|
|
14
|
+
* await app.listen(3000);
|
|
15
|
+
* // RealtimeGateway is auto-attached via OnApplicationBootstrap
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
+
exports.OpenAIRealtimeSession = exports.OpenAIRealtimeClient = exports.RealtimeGateway = exports.RealtimeService = exports.RealtimeModule = void 0;
|
|
20
|
+
var realtime_module_1 = require("./realtime.module");
|
|
21
|
+
Object.defineProperty(exports, "RealtimeModule", { enumerable: true, get: function () { return realtime_module_1.RealtimeModule; } });
|
|
22
|
+
var realtime_service_1 = require("./realtime.service");
|
|
23
|
+
Object.defineProperty(exports, "RealtimeService", { enumerable: true, get: function () { return realtime_service_1.RealtimeService; } });
|
|
24
|
+
var realtime_gateway_1 = require("./realtime.gateway");
|
|
25
|
+
Object.defineProperty(exports, "RealtimeGateway", { enumerable: true, get: function () { return realtime_gateway_1.RealtimeGateway; } });
|
|
26
|
+
var openai_1 = require("./providers/openai");
|
|
27
|
+
Object.defineProperty(exports, "OpenAIRealtimeClient", { enumerable: true, get: function () { return openai_1.OpenAIRealtimeClient; } });
|
|
28
|
+
Object.defineProperty(exports, "OpenAIRealtimeSession", { enumerable: true, get: function () { return openai_1.OpenAIRealtimeSession; } });
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { OpenAIRealtimeClient } from './openai-realtime.client';
|
|
2
|
+
export type { OpenAIRealtimeClientOptions, RealtimeEventHandler } from './openai-realtime.client';
|
|
3
|
+
export { OpenAIRealtimeSession } from './openai-realtime.session';
|
|
4
|
+
export type { OpenAIRealtimeSessionOptions, RealtimeClientAdapter, } from './openai-realtime.session';
|
|
5
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/openai/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,YAAY,EAAE,2BAA2B,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAClG,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAClE,YAAY,EACV,4BAA4B,EAC5B,qBAAqB,GACtB,MAAM,2BAA2B,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.OpenAIRealtimeSession = exports.OpenAIRealtimeClient = void 0;
|
|
4
|
+
var openai_realtime_client_1 = require("./openai-realtime.client");
|
|
5
|
+
Object.defineProperty(exports, "OpenAIRealtimeClient", { enumerable: true, get: function () { return openai_realtime_client_1.OpenAIRealtimeClient; } });
|
|
6
|
+
var openai_realtime_session_1 = require("./openai-realtime.session");
|
|
7
|
+
Object.defineProperty(exports, "OpenAIRealtimeSession", { enumerable: true, get: function () { return openai_realtime_session_1.OpenAIRealtimeSession; } });
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* OpenAI Realtime API WebSocket client
|
|
3
|
+
* Connects to wss://api.openai.com/v1/realtime and handles bidirectional event flow
|
|
4
|
+
*/
|
|
5
|
+
import type { RealtimeClientEvent, RealtimeServerEvent, RealtimeSessionConfig } from '../../realtime.types';
|
|
6
|
+
export interface OpenAIRealtimeClientOptions {
|
|
7
|
+
apiKey: string;
|
|
8
|
+
model?: string;
|
|
9
|
+
sessionConfig?: RealtimeSessionConfig;
|
|
10
|
+
}
|
|
11
|
+
export type RealtimeEventHandler = (event: RealtimeServerEvent) => void | Promise<void>;
|
|
12
|
+
/**
|
|
13
|
+
* Low-level OpenAI Realtime API WebSocket client
|
|
14
|
+
*/
|
|
15
|
+
export declare class OpenAIRealtimeClient {
|
|
16
|
+
private ws;
|
|
17
|
+
private readonly apiKey;
|
|
18
|
+
private readonly model;
|
|
19
|
+
private readonly sessionConfig?;
|
|
20
|
+
private eventHandlers;
|
|
21
|
+
private genericHandlers;
|
|
22
|
+
private _connected;
|
|
23
|
+
constructor(options: OpenAIRealtimeClientOptions);
|
|
24
|
+
get connected(): boolean;
|
|
25
|
+
/**
|
|
26
|
+
* Connect to OpenAI Realtime API
|
|
27
|
+
*/
|
|
28
|
+
connect(): Promise<void>;
|
|
29
|
+
/**
|
|
30
|
+
* Send session.update with config
|
|
31
|
+
*/
|
|
32
|
+
private sendSessionUpdate;
|
|
33
|
+
/**
|
|
34
|
+
* Send a client event to OpenAI
|
|
35
|
+
*/
|
|
36
|
+
send(event: RealtimeClientEvent): void;
|
|
37
|
+
/**
|
|
38
|
+
* Append audio to input buffer (base64 PCM)
|
|
39
|
+
*/
|
|
40
|
+
appendAudio(base64Audio: string): void;
|
|
41
|
+
/**
|
|
42
|
+
* Commit input buffer (when VAD disabled)
|
|
43
|
+
*/
|
|
44
|
+
commitInputBuffer(): void;
|
|
45
|
+
/**
|
|
46
|
+
* Clear input buffer
|
|
47
|
+
*/
|
|
48
|
+
clearInputBuffer(): void;
|
|
49
|
+
/**
|
|
50
|
+
* Create a response (trigger model to respond)
|
|
51
|
+
*/
|
|
52
|
+
createResponse(options?: {
|
|
53
|
+
outputModalities?: ('audio' | 'text')[];
|
|
54
|
+
}): void;
|
|
55
|
+
/**
|
|
56
|
+
* Add text to conversation
|
|
57
|
+
*/
|
|
58
|
+
addConversationItem(text: string): void;
|
|
59
|
+
/**
|
|
60
|
+
* Subscribe to server events
|
|
61
|
+
*/
|
|
62
|
+
on(eventType: string, handler: RealtimeEventHandler): () => void;
|
|
63
|
+
/**
|
|
64
|
+
* Subscribe to all events
|
|
65
|
+
*/
|
|
66
|
+
onAny(handler: RealtimeEventHandler): () => void;
|
|
67
|
+
private handleServerEvent;
|
|
68
|
+
private emit;
|
|
69
|
+
/**
|
|
70
|
+
* Disconnect and cleanup
|
|
71
|
+
*/
|
|
72
|
+
disconnect(): void;
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=openai-realtime.client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"openai-realtime.client.d.ts","sourceRoot":"","sources":["../../../src/providers/openai/openai-realtime.client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAI9B,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,qBAAqB,CAAC;CACvC;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAExF;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,EAAE,CAA0B;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAwB;IACvD,OAAO,CAAC,aAAa,CAAqD;IAC1E,OAAO,CAAC,eAAe,CAAwC;IAC/D,OAAO,CAAC,UAAU,CAAS;gBAEf,OAAO,EAAE,2BAA2B;IAMhD,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAyC9B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAkCzB;;OAEG;IACH,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAOtC;;OAEG;IACH,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAOtC;;OAEG;IACH,iBAAiB,IAAI,IAAI;IAIzB;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;OAEG;IACH,cAAc,CAAC,OAAO,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,CAAC,OAAO,GAAG,MAAM,CAAC,EAAE,CAAA;KAAE,GAAG,IAAI;IAO3E;;OAEG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAWvC;;OAEG;IACH,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,oBAAoB,GAAG,MAAM,IAAI;IAWhE;;OAEG;IACH,KAAK,CAAC,OAAO,EAAE,oBAAoB,GAAG,MAAM,IAAI;IAKhD,OAAO,CAAC,iBAAiB;IAoBzB,OAAO,CAAC,IAAI;IAIZ;;OAEG;IACH,UAAU,IAAI,IAAI;CAUnB"}
|