@strevokit/meeting-sdk 0.0.0-stage → 0.6.0
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/CHANGELOG.md +68 -0
- package/LICENSE +215 -0
- package/README.md +141 -2
- package/dist/index.d.ts +231 -0
- package/dist/index.js +2817 -0
- package/dist/index.js.map +7 -0
- package/docs/api-reference.md +343 -0
- package/docs/examples/react.tsx +144 -0
- package/docs/examples/vanilla.html +101 -0
- package/package.json +62 -4
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to `@strevokit/meeting-sdk` are documented here. The format follows
|
|
4
|
+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the package follows
|
|
5
|
+
[semantic versioning](https://semver.org/). Before 1.0.0, breaking changes bump the minor version.
|
|
6
|
+
|
|
7
|
+
## [Unreleased]
|
|
8
|
+
|
|
9
|
+
## [0.6.0]
|
|
10
|
+
|
|
11
|
+
Bundles `@strevokit/signaling-protocol` 1.6.0.
|
|
12
|
+
|
|
13
|
+
### Changed
|
|
14
|
+
|
|
15
|
+
- Remote `screen` media is delivered in ordinary 1-to-1 peer meetings; shell consumers can render
|
|
16
|
+
`remoteMedia(id).screen`. When the meeting cannot carry screen bits, `startScreenShare()` rejects with
|
|
17
|
+
`unsupported_environment` before opening the display-capture prompt.
|
|
18
|
+
|
|
19
|
+
## [0.5.0]
|
|
20
|
+
|
|
21
|
+
Bundles `@strevokit/signaling-protocol` 1.6.0.
|
|
22
|
+
|
|
23
|
+
### Added
|
|
24
|
+
|
|
25
|
+
- `endMeeting()`: hosts can end the meeting for everyone. Sends `meeting.end` over signaling, resolving when the meeting is ended and every connection closes. Non-hosts reject with `not_permitted`; calls when not joined reject with `not_joined`.
|
|
26
|
+
- Close code 4004 mapped to `meeting_ended`.
|
|
27
|
+
|
|
28
|
+
## [0.4.0]
|
|
29
|
+
|
|
30
|
+
Bundles `@strevokit/signaling-protocol` 1.5.0. No changes are needed in existing integrations.
|
|
31
|
+
|
|
32
|
+
### Added
|
|
33
|
+
|
|
34
|
+
- Device choice: `enableCamera(options?)` and `unmute(options?)` accept `MediaDeviceOptions` with a `deviceId` from
|
|
35
|
+
`navigator.mediaDevices.enumerateDevices()`. Calling either while that device kind is already on switches to the
|
|
36
|
+
chosen device in place, without turning it off, so other participants see no interruption.
|
|
37
|
+
- A chosen device that is missing rejects with `device_not_found`, and a busy one with `device_unavailable`; the
|
|
38
|
+
device already in use keeps running.
|
|
39
|
+
|
|
40
|
+
## [0.3.0]
|
|
41
|
+
|
|
42
|
+
Bundles `@strevokit/signaling-protocol` 1.5.0. Calls connect on more networks and stay connected through credential
|
|
43
|
+
renewals, with no changes needed in existing integrations.
|
|
44
|
+
|
|
45
|
+
## [0.2.0]
|
|
46
|
+
|
|
47
|
+
Bundles `@strevokit/signaling-protocol` 1.4.0. No changes are needed in existing integrations.
|
|
48
|
+
|
|
49
|
+
### Added
|
|
50
|
+
|
|
51
|
+
- Remote media: `remote_media_changed` event and `remoteMedia(participantId)`, so you can render other participants'
|
|
52
|
+
camera and microphone.
|
|
53
|
+
- Connection status per participant: `media_connection_changed` event and `mediaConnectionStatus(participantId)`.
|
|
54
|
+
- Error codes `media_connection_failed` and `media_participant_limit`.
|
|
55
|
+
|
|
56
|
+
## [0.1.0]
|
|
57
|
+
|
|
58
|
+
Bundles `@strevokit/signaling-protocol` 1.3.0.
|
|
59
|
+
|
|
60
|
+
### Added
|
|
61
|
+
|
|
62
|
+
- `createMeetingEngine(options)` returning a `MeetingEngine`: `join()`, `leave()`, `dispose()`, and the participant
|
|
63
|
+
list with each participant's role and media state.
|
|
64
|
+
- Local media controls: `enableCamera()`, `disableCamera()`, `mute()`, `unmute()`, `startScreenShare()`, and
|
|
65
|
+
`stopScreenShare()`, with `localMediaState` and `localMedia` for self-preview.
|
|
66
|
+
- Events: `state_changed`, `joined`, `participant_joined`, `participant_left`, `participant_reconnected`,
|
|
67
|
+
`participant_media_changed`, `local_media_changed`, `error`, and `closed`.
|
|
68
|
+
- `MeetingError` with stable codes, user-safe messages, and a `retryable` flag.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
Copyright 2026 Agilia IT
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
|
14
|
+
|
|
15
|
+
Apache License
|
|
16
|
+
Version 2.0, January 2004
|
|
17
|
+
http://www.apache.org/licenses/
|
|
18
|
+
|
|
19
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
20
|
+
|
|
21
|
+
1. Definitions.
|
|
22
|
+
|
|
23
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
24
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
25
|
+
|
|
26
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
27
|
+
the copyright owner that is granting the License.
|
|
28
|
+
|
|
29
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
30
|
+
other entities that control, are controlled by, or are under common
|
|
31
|
+
control with that entity. For the purposes of this definition,
|
|
32
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
33
|
+
direction or management of such entity, whether by contract or
|
|
34
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
35
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
36
|
+
|
|
37
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
38
|
+
exercising permissions granted by this License.
|
|
39
|
+
|
|
40
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
41
|
+
including but not limited to software source code, documentation
|
|
42
|
+
source, and configuration files.
|
|
43
|
+
|
|
44
|
+
"Object" form shall mean any form resulting from mechanical
|
|
45
|
+
transformation or translation of a Source form, including but
|
|
46
|
+
not limited to compiled object code, generated documentation,
|
|
47
|
+
and conversions to other media types.
|
|
48
|
+
|
|
49
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
50
|
+
Object form, made available under the License, as indicated by a
|
|
51
|
+
copyright notice that is included in or attached to the work
|
|
52
|
+
(an example is provided in the Appendix below).
|
|
53
|
+
|
|
54
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
55
|
+
form, that is based on (or derived from) the Work and for which the
|
|
56
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
57
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
58
|
+
of this License, Derivative Works shall not include works that remain
|
|
59
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
60
|
+
the Work and Derivative Works thereof.
|
|
61
|
+
|
|
62
|
+
"Contribution" shall mean any work of authorship, including
|
|
63
|
+
the original version of the Work and any modifications or additions
|
|
64
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
65
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
66
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
67
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
68
|
+
means any form of electronic, verbal, or written communication sent
|
|
69
|
+
to the Licensor or its representatives, including but not limited to
|
|
70
|
+
communication on electronic mailing lists, source code control systems,
|
|
71
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
72
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
73
|
+
excluding communication that is conspicuously marked or otherwise
|
|
74
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
75
|
+
|
|
76
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
77
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
78
|
+
subsequently incorporated within the Work.
|
|
79
|
+
|
|
80
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
81
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
82
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
83
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
84
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
85
|
+
Work and such Derivative Works in Source or Object form.
|
|
86
|
+
|
|
87
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
88
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
89
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
90
|
+
(except as stated in this section) patent license to make, have made,
|
|
91
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
92
|
+
where such license applies only to those patent claims licensable
|
|
93
|
+
by such Contributor that are necessarily infringed by their
|
|
94
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
95
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
96
|
+
institute patent litigation against any entity (including a
|
|
97
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
98
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
99
|
+
or contributory patent infringement, then any patent licenses
|
|
100
|
+
granted to You under this License for that Work shall terminate
|
|
101
|
+
as of the date such litigation is filed.
|
|
102
|
+
|
|
103
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
104
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
105
|
+
modifications, and in Source or Object form, provided that You
|
|
106
|
+
meet the following conditions:
|
|
107
|
+
|
|
108
|
+
(a) You must give any other recipients of the Work or
|
|
109
|
+
Derivative Works a copy of this License; and
|
|
110
|
+
|
|
111
|
+
(b) You must cause any modified files to carry prominent notices
|
|
112
|
+
stating that You changed the files; and
|
|
113
|
+
|
|
114
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
115
|
+
that You distribute, all copyright, patent, trademark, and
|
|
116
|
+
attribution notices from the Source form of the Work,
|
|
117
|
+
excluding those notices that do not pertain to any part of
|
|
118
|
+
the Derivative Works; and
|
|
119
|
+
|
|
120
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
121
|
+
distribution, then any Derivative Works that You distribute must
|
|
122
|
+
include a readable copy of the attribution notices contained
|
|
123
|
+
within such NOTICE file, excluding those notices that do not
|
|
124
|
+
pertain to any part of the Derivative Works, in at least one
|
|
125
|
+
of the following places: within a NOTICE text file distributed
|
|
126
|
+
as part of the Derivative Works; within the Source form or
|
|
127
|
+
documentation, if provided along with the Derivative Works; or,
|
|
128
|
+
within a display generated by the Derivative Works, if and
|
|
129
|
+
wherever such third-party notices normally appear. The contents
|
|
130
|
+
of the NOTICE file are for informational purposes only and
|
|
131
|
+
do not modify the License. You may add Your own attribution
|
|
132
|
+
notices within Derivative Works that You distribute, alongside
|
|
133
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
134
|
+
that such additional attribution notices cannot be construed
|
|
135
|
+
as modifying the License.
|
|
136
|
+
|
|
137
|
+
You may add Your own copyright statement to Your modifications and
|
|
138
|
+
may provide additional or different license terms and conditions
|
|
139
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
140
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
141
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
142
|
+
the conditions stated in this License.
|
|
143
|
+
|
|
144
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
145
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
146
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
147
|
+
this License, without any additional terms or conditions.
|
|
148
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
149
|
+
the terms of any separate license agreement you may have executed
|
|
150
|
+
with Licensor regarding such Contributions.
|
|
151
|
+
|
|
152
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
153
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
154
|
+
except as required for reasonable and customary use in describing the
|
|
155
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
156
|
+
|
|
157
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
158
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
159
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
160
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
161
|
+
implied, including, without limitation, any warranties or conditions
|
|
162
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
163
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
164
|
+
appropriateness of using or redistributing the Work and assume any
|
|
165
|
+
risks associated with Your exercise of permissions under this License.
|
|
166
|
+
|
|
167
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
168
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
169
|
+
unless required by applicable law (such as deliberate and grossly
|
|
170
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
171
|
+
liable to You for damages, including any direct, indirect, special,
|
|
172
|
+
incidental, or consequential damages of any character arising as a
|
|
173
|
+
result of this License or out of the use or inability to use the
|
|
174
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
175
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
176
|
+
other commercial damages or losses), even if such Contributor
|
|
177
|
+
has been advised of the possibility of such damages.
|
|
178
|
+
|
|
179
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
180
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
181
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
182
|
+
or other liability obligations and/or rights consistent with this
|
|
183
|
+
License. However, in accepting such obligations, You may act only
|
|
184
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
185
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
186
|
+
defend, and hold each Contributor harmless for any liability
|
|
187
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
188
|
+
of your accepting any such warranty or additional liability.
|
|
189
|
+
|
|
190
|
+
END OF TERMS AND CONDITIONS
|
|
191
|
+
|
|
192
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
193
|
+
|
|
194
|
+
To apply the Apache License to your work, attach the following
|
|
195
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
196
|
+
replaced with your own identifying information. (Don't include
|
|
197
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
198
|
+
comment syntax for the file format. We also recommend that a
|
|
199
|
+
file or class name and description of purpose be included on the
|
|
200
|
+
same "printed page" as the copyright notice for easier
|
|
201
|
+
identification within third-party archives.
|
|
202
|
+
|
|
203
|
+
Copyright 2026 Agilia IT
|
|
204
|
+
|
|
205
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
206
|
+
you may not use this file except in compliance with the License.
|
|
207
|
+
You may obtain a copy of the License at
|
|
208
|
+
|
|
209
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
210
|
+
|
|
211
|
+
Unless required by applicable law or agreed to in writing, software
|
|
212
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
213
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
214
|
+
See the License for the specific language governing permissions and
|
|
215
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,142 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @strevokit/meeting-sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Embed Strevokit meetings in your web product.
|
|
4
|
+
|
|
5
|
+
The SDK is **headless**: it joins a meeting, keeps the participant list up to date, and controls the local camera,
|
|
6
|
+
microphone, and screen share. It has no UI and no runtime dependencies, so it works with any framework. Build your own
|
|
7
|
+
interface on top of it, or use the Strevokit UI components when they are available.
|
|
8
|
+
|
|
9
|
+
- Zero runtime dependencies, one ES module, full TypeScript types.
|
|
10
|
+
- One interface (`MeetingEngine`) for every meeting size. Your code never changes when the platform changes how media
|
|
11
|
+
is delivered.
|
|
12
|
+
- Stable error codes with user-safe messages.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @strevokit/meeting-sdk
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
The package is ESM-only and runs in browsers. Use it through a bundler (Vite, webpack, esbuild, and so on) or a native
|
|
21
|
+
`<script type="module">`.
|
|
22
|
+
|
|
23
|
+
## Quick start
|
|
24
|
+
|
|
25
|
+
### 1. Mint a join token on your backend
|
|
26
|
+
|
|
27
|
+
Join tokens are short-lived and single-use. Your backend mints one per participant with its Strevokit API credential.
|
|
28
|
+
**Never** send the API credential to the browser.
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
// Server side (for example, a route in your backend).
|
|
32
|
+
const response = await fetch(`https://api.example.com/v1/meetings/${meetingPublicId}/join-token`, {
|
|
33
|
+
method: "POST",
|
|
34
|
+
headers: {
|
|
35
|
+
Authorization: `Bearer ${process.env.STREVOKIT_API_CREDENTIAL}`,
|
|
36
|
+
"Content-Type": "application/json",
|
|
37
|
+
},
|
|
38
|
+
body: JSON.stringify({ participant_public_id: participantPublicId }),
|
|
39
|
+
});
|
|
40
|
+
const { data } = await response.json(); // { token, expires_at, expires_in }
|
|
41
|
+
// Return data.token to the signed-in user's browser.
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 2. Join from the browser
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { createMeetingEngine, MeetingError } from "@strevokit/meeting-sdk";
|
|
48
|
+
|
|
49
|
+
const engine = createMeetingEngine({
|
|
50
|
+
token, // from your backend
|
|
51
|
+
realtimeUrl: "wss://realtime.example.com", // your Strevokit realtime endpoint
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
engine.on("joined", ({ self, participants }) => {
|
|
55
|
+
console.log(`Joined as ${self.role} with ${participants.length} others`);
|
|
56
|
+
});
|
|
57
|
+
engine.on("participant_joined", ({ participant }) => addTile(participant));
|
|
58
|
+
engine.on("participant_left", ({ participantId }) => removeTile(participantId));
|
|
59
|
+
engine.on("participant_media_changed", ({ participantId, kind, enabled }) => updateTile(participantId, kind, enabled));
|
|
60
|
+
engine.on("closed", ({ reason, error }) => showEndScreen(reason, error?.message));
|
|
61
|
+
|
|
62
|
+
try {
|
|
63
|
+
await engine.join();
|
|
64
|
+
} catch (error) {
|
|
65
|
+
if (error instanceof MeetingError) showError(error.message); // safe to show to users
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### 3. Control media
|
|
70
|
+
|
|
71
|
+
```ts
|
|
72
|
+
await engine.enableCamera();
|
|
73
|
+
selfPreview.srcObject = engine.localMedia.camera; // a MediaStream for a <video> element
|
|
74
|
+
|
|
75
|
+
await engine.unmute();
|
|
76
|
+
await engine.startScreenShare(); // rejects with `not_permitted` if your role may not share
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Every media method is idempotent and rejects with a `MeetingError` (for example `permission_denied` or
|
|
80
|
+
`device_not_found`) without changing any state.
|
|
81
|
+
|
|
82
|
+
### 4. Show other participants
|
|
83
|
+
|
|
84
|
+
```ts
|
|
85
|
+
engine.on("remote_media_changed", ({ participantId, kind, stream }) => {
|
|
86
|
+
if (kind === "camera") videoFor(participantId).srcObject = stream; // a <video autoplay playsinline muted>
|
|
87
|
+
if (kind === "microphone") audioFor(participantId).srcObject = stream; // an <audio autoplay>
|
|
88
|
+
});
|
|
89
|
+
engine.on("media_connection_changed", ({ participantId, status }) => {
|
|
90
|
+
// "connecting" | "connected" | "interrupted" | "failed", or null when there is no connection any more
|
|
91
|
+
showStatus(participantId, status);
|
|
92
|
+
});
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
`stream` is `null` when that media stops being available. `engine.remoteMedia(participantId)` and
|
|
96
|
+
`engine.mediaConnectionStatus(participantId)` return the current values at any time.
|
|
97
|
+
|
|
98
|
+
### 5. Leave
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
await engine.leave(); // releases camera, microphone, and screen; then `closed` fires with reason "left"
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
An engine joins once. To join again, mint a new token and create a new engine. Call `engine.dispose()` when your
|
|
105
|
+
component unmounts; it releases everything immediately and emits nothing.
|
|
106
|
+
|
|
107
|
+
More examples: [plain HTML](./docs/examples/vanilla.html) and [React](./docs/examples/react.tsx).
|
|
108
|
+
|
|
109
|
+
## Browser support
|
|
110
|
+
|
|
111
|
+
Current versions of Chrome, Edge, Firefox, and Safari. The page must be served over HTTPS (browsers only allow camera,
|
|
112
|
+
microphone, and screen access in secure contexts). In an unsupported browser the SDK throws or rejects with
|
|
113
|
+
`unsupported_environment`.
|
|
114
|
+
|
|
115
|
+
## Security
|
|
116
|
+
|
|
117
|
+
- **The join token stays in memory.** The SDK sends it only during the connection handshake. It never appears in URLs,
|
|
118
|
+
storage, events, error messages, or log output.
|
|
119
|
+
- **Identity comes from the token.** Role and participant identity are decided by your backend when it mints the token.
|
|
120
|
+
The SDK never sends a role or identity of its own.
|
|
121
|
+
- **Embed origins are allow-listed.** Joins are accepted only from the origins configured for your tenant. A join from
|
|
122
|
+
any other site fails with `origin_not_allowed`.
|
|
123
|
+
- **Local development.** `realtimeUrl` must use `wss://`. Plain `ws://` is accepted only for `localhost` and
|
|
124
|
+
`127.0.0.1`.
|
|
125
|
+
|
|
126
|
+
## Versioning
|
|
127
|
+
|
|
128
|
+
The package follows [semantic versioning](https://semver.org/). The public API is exactly what
|
|
129
|
+
[docs/api-reference.md](./docs/api-reference.md) describes. Before 1.0.0, breaking changes bump the minor version; from
|
|
130
|
+
1.0.0 they bump the major version. New event types and error codes may be added in minor versions, so handle unknown
|
|
131
|
+
values generically. See the [changelog](./CHANGELOG.md).
|
|
132
|
+
|
|
133
|
+
## Documentation
|
|
134
|
+
|
|
135
|
+
- [API reference](./docs/api-reference.md): every export, method, event, error code, and close reason.
|
|
136
|
+
- [Examples](./docs/examples/).
|
|
137
|
+
|
|
138
|
+
## Source and releases
|
|
139
|
+
|
|
140
|
+
The source is published at [github.com/AgiliaIT/strevokit-meeting-sdk](https://github.com/AgiliaIT/strevokit-meeting-sdk).
|
|
141
|
+
Releases are published to npm from that repository with npm provenance, and tagged `meeting-sdk-v<version>`. Report
|
|
142
|
+
problems through its [issues](https://github.com/AgiliaIT/strevokit-meeting-sdk/issues).
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,231 @@
|
|
|
1
|
+
/** Why the engine closed. */
|
|
2
|
+
export declare type CloseReason = "left" | "meeting_ended" | "session_replaced" | "connection_lost" | "join_failed" | "error";
|
|
3
|
+
|
|
4
|
+
/** Engine lifecycle state. `closed` is terminal: create a new engine to join again. */
|
|
5
|
+
export declare type ConnectionState = "idle" | "connecting" | "joining" | "joined" | "leaving" | "closed";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Creates a meeting engine for one participant. Pass the join token your backend issued and the realtime
|
|
9
|
+
* service URL, then call `join()`.
|
|
10
|
+
*
|
|
11
|
+
* @throws TypeError when `realtimeUrl` or `joinTimeoutMs` is malformed.
|
|
12
|
+
* @throws MeetingError `join_token_invalid` when the token is not a valid join token, or
|
|
13
|
+
* `unsupported_environment` when the browser has no WebSocket support.
|
|
14
|
+
*/
|
|
15
|
+
export declare function createMeetingEngine(options: MeetingEngineOptions): MeetingEngine;
|
|
16
|
+
|
|
17
|
+
/** Local captures available for rendering, such as a self-preview. `null` when that capture is off. */
|
|
18
|
+
export declare interface LocalMedia {
|
|
19
|
+
readonly camera: MediaStream | null;
|
|
20
|
+
readonly microphone: MediaStream | null;
|
|
21
|
+
readonly screen: MediaStream | null;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/** Status of the audio and video connection to another participant. */
|
|
25
|
+
export declare type MediaConnectionStatus = "connecting" | "connected" | "interrupted" | "failed";
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Which device to use for {@link MeetingEngine.enableCamera} or {@link MeetingEngine.unmute}. Omit `deviceId` to use
|
|
29
|
+
* the browser's default device.
|
|
30
|
+
*/
|
|
31
|
+
export declare interface MediaDeviceOptions {
|
|
32
|
+
/** A `deviceId` from `navigator.mediaDevices.enumerateDevices()`. */
|
|
33
|
+
readonly deviceId?: string;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/** A kind of local or remote media. */
|
|
37
|
+
export declare type MediaKind = "camera" | "microphone" | "screen";
|
|
38
|
+
|
|
39
|
+
/** `true` means on: camera on, microphone unmuted, screen being shared. */
|
|
40
|
+
export declare interface MediaState {
|
|
41
|
+
readonly camera: boolean;
|
|
42
|
+
readonly microphone: boolean;
|
|
43
|
+
readonly screen: boolean;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** A meeting session for one participant. One engine joins at most once. */
|
|
47
|
+
export declare interface MeetingEngine {
|
|
48
|
+
/** Current lifecycle state. */
|
|
49
|
+
readonly state: ConnectionState;
|
|
50
|
+
/** Set once `joined` fires; `null` before. */
|
|
51
|
+
readonly self: SelfParticipant | null;
|
|
52
|
+
/** Other participants currently present (never includes self). */
|
|
53
|
+
readonly participants: readonly Participant[];
|
|
54
|
+
/** Current local media state. */
|
|
55
|
+
readonly localMediaState: MediaState;
|
|
56
|
+
/** Current local captures, for rendering. */
|
|
57
|
+
readonly localMedia: LocalMedia;
|
|
58
|
+
/** Media currently received from a participant. All fields are `null` when nothing is available. */
|
|
59
|
+
remoteMedia(participantId: string): RemoteMedia;
|
|
60
|
+
/** Status of the audio and video connection to a participant, or `null` when there is none. */
|
|
61
|
+
mediaConnectionStatus(participantId: string): MediaConnectionStatus | null;
|
|
62
|
+
/** Connect and join the meeting. Resolves once admitted and the participant list is known. */
|
|
63
|
+
join(): Promise<void>;
|
|
64
|
+
/** Leave the meeting and release every device. Never rejects. */
|
|
65
|
+
leave(): Promise<void>;
|
|
66
|
+
/** End the meeting for everyone. Only hosts may end a meeting. Resolves once the meeting has ended. */
|
|
67
|
+
endMeeting(): Promise<void>;
|
|
68
|
+
/**
|
|
69
|
+
* Start the camera. With `options.deviceId`, use that camera; when the camera is already on with another device,
|
|
70
|
+
* switch to it without turning the camera off. Rejects with `device_not_found` when the device is missing, leaving
|
|
71
|
+
* the current camera running.
|
|
72
|
+
*/
|
|
73
|
+
enableCamera(options?: MediaDeviceOptions): Promise<void>;
|
|
74
|
+
/** Stop the camera and release it. */
|
|
75
|
+
disableCamera(): Promise<void>;
|
|
76
|
+
/** Mute the microphone. */
|
|
77
|
+
mute(): Promise<void>;
|
|
78
|
+
/**
|
|
79
|
+
* Unmute the microphone, capturing it on first use. With `options.deviceId`, use that microphone; when it is already
|
|
80
|
+
* unmuted with another device, switch to it without muting. Rejects with `device_not_found` when the device is
|
|
81
|
+
* missing, leaving the current microphone running.
|
|
82
|
+
*/
|
|
83
|
+
unmute(options?: MediaDeviceOptions): Promise<void>;
|
|
84
|
+
/** Start sharing the screen. Only hosts may share. */
|
|
85
|
+
startScreenShare(): Promise<void>;
|
|
86
|
+
/** Stop sharing the screen. */
|
|
87
|
+
stopScreenShare(): Promise<void>;
|
|
88
|
+
/** Subscribe to one event type. Returns an unsubscribe function. */
|
|
89
|
+
on<K extends MeetingEventType>(type: K, listener: MeetingEventListener<K>): () => void;
|
|
90
|
+
/** Release everything immediately: devices, connection, listeners. Emits nothing. Idempotent. */
|
|
91
|
+
dispose(): void;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/** Options for {@link createMeetingEngine}. */
|
|
95
|
+
export declare interface MeetingEngineOptions {
|
|
96
|
+
/** Join token issued by your backend for this participant. Kept in memory only and never logged. */
|
|
97
|
+
token: string;
|
|
98
|
+
/**
|
|
99
|
+
* Realtime service base URL, for example `wss://realtime.example.com`. `ws://` is accepted only for
|
|
100
|
+
* `localhost` and `127.0.0.1`. No path, query, or fragment.
|
|
101
|
+
*/
|
|
102
|
+
realtimeUrl: string;
|
|
103
|
+
/** Milliseconds to wait for admission before `join()` rejects with `join_timeout`. Default 15000, range 1000–60000. */
|
|
104
|
+
joinTimeoutMs?: number;
|
|
105
|
+
/** Optional diagnostics sink. The SDK never passes the join token or raw exception text to it. */
|
|
106
|
+
logger?: MeetingLogger;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* The single error type raised by the SDK. `message` is a short English sentence that is safe to show to users;
|
|
111
|
+
* branch on `code` rather than on `message`.
|
|
112
|
+
*/
|
|
113
|
+
export declare class MeetingError extends Error {
|
|
114
|
+
readonly name: "MeetingError";
|
|
115
|
+
/** Stable machine-readable code. */
|
|
116
|
+
readonly code: MeetingErrorCode;
|
|
117
|
+
/** True when retrying the same action later (with a fresh token for join errors) may succeed. */
|
|
118
|
+
readonly retryable: boolean;
|
|
119
|
+
constructor(code: MeetingErrorCode);
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* Every code a {@link MeetingError} can carry. Codes are stable strings; new codes may be added in minor
|
|
124
|
+
* versions, so handle unknown codes generically.
|
|
125
|
+
*/
|
|
126
|
+
export declare type MeetingErrorCode = "join_token_invalid" | "join_token_expired" | "origin_not_allowed" | "connection_failed" | "join_timeout" | "join_cancelled" | "connection_lost" | "session_replaced" | "service_unavailable" | "rate_limited" | "meeting_ended" | "protocol_error" | "already_joined" | "engine_closed" | "not_joined" | "not_permitted" | "permission_denied" | "device_not_found" | "device_unavailable" | "screen_share_cancelled" | "unsupported_environment" | "media_connection_failed" | "media_participant_limit";
|
|
127
|
+
|
|
128
|
+
/** Listener for one event type. */
|
|
129
|
+
export declare type MeetingEventListener<K extends MeetingEventType> = (event: MeetingEventMap[K]) => void;
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Payload of every event, keyed by event type. New event types may be added in minor versions, so do not
|
|
133
|
+
* treat this map as closed.
|
|
134
|
+
*/
|
|
135
|
+
export declare interface MeetingEventMap {
|
|
136
|
+
state_changed: {
|
|
137
|
+
readonly state: ConnectionState;
|
|
138
|
+
readonly previous: ConnectionState;
|
|
139
|
+
};
|
|
140
|
+
joined: {
|
|
141
|
+
readonly self: SelfParticipant;
|
|
142
|
+
readonly participants: readonly Participant[];
|
|
143
|
+
};
|
|
144
|
+
participant_joined: {
|
|
145
|
+
readonly participant: Participant;
|
|
146
|
+
};
|
|
147
|
+
participant_left: {
|
|
148
|
+
readonly participantId: string;
|
|
149
|
+
readonly reason: ParticipantLeftReason;
|
|
150
|
+
};
|
|
151
|
+
participant_reconnected: {
|
|
152
|
+
readonly participantId: string;
|
|
153
|
+
};
|
|
154
|
+
participant_media_changed: {
|
|
155
|
+
readonly participantId: string;
|
|
156
|
+
readonly kind: MediaKind;
|
|
157
|
+
readonly enabled: boolean;
|
|
158
|
+
};
|
|
159
|
+
local_media_changed: {
|
|
160
|
+
readonly kind: MediaKind;
|
|
161
|
+
readonly enabled: boolean;
|
|
162
|
+
readonly stream: MediaStream | null;
|
|
163
|
+
};
|
|
164
|
+
/** Media from another participant became available (`stream`) or stopped being available (`null`). */
|
|
165
|
+
remote_media_changed: {
|
|
166
|
+
readonly participantId: string;
|
|
167
|
+
readonly kind: MediaKind;
|
|
168
|
+
readonly stream: MediaStream | null;
|
|
169
|
+
};
|
|
170
|
+
/** The audio and video connection to another participant changed. `null`: there is no connection any more. */
|
|
171
|
+
media_connection_changed: {
|
|
172
|
+
readonly participantId: string;
|
|
173
|
+
readonly status: MediaConnectionStatus | null;
|
|
174
|
+
};
|
|
175
|
+
error: {
|
|
176
|
+
readonly error: MeetingError;
|
|
177
|
+
};
|
|
178
|
+
closed: {
|
|
179
|
+
readonly reason: CloseReason;
|
|
180
|
+
readonly error?: MeetingError;
|
|
181
|
+
};
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
/** Name of an engine event. */
|
|
185
|
+
export declare type MeetingEventType = keyof MeetingEventMap;
|
|
186
|
+
|
|
187
|
+
/** Optional diagnostics sink. Every method is optional. */
|
|
188
|
+
export declare interface MeetingLogger {
|
|
189
|
+
debug?(message: string, fields?: Readonly<Record<string, string | number | boolean>>): void;
|
|
190
|
+
info?(message: string, fields?: Readonly<Record<string, string | number | boolean>>): void;
|
|
191
|
+
warn?(message: string, fields?: Readonly<Record<string, string | number | boolean>>): void;
|
|
192
|
+
error?(message: string, fields?: Readonly<Record<string, string | number | boolean>>): void;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
/** Another participant in the meeting. */
|
|
196
|
+
export declare interface Participant {
|
|
197
|
+
/** Opaque participant ID. */
|
|
198
|
+
readonly id: string;
|
|
199
|
+
readonly role: ParticipantRole;
|
|
200
|
+
readonly displayName?: string;
|
|
201
|
+
readonly media: MediaState;
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
/** Why another participant left. Unknown platform reasons are reported as `"other"`. */
|
|
205
|
+
export declare type ParticipantLeftReason = "left" | "disconnected" | "removed" | "meeting_ended" | "other";
|
|
206
|
+
|
|
207
|
+
/** Role assigned by the platform when the join token was issued. */
|
|
208
|
+
export declare type ParticipantRole = "host" | "participant";
|
|
209
|
+
|
|
210
|
+
/** Media received from another participant, for rendering. `null` when that media is not available. */
|
|
211
|
+
export declare interface RemoteMedia {
|
|
212
|
+
readonly camera: MediaStream | null;
|
|
213
|
+
readonly microphone: MediaStream | null;
|
|
214
|
+
/**
|
|
215
|
+
* Live display stream while the remote participant is sharing their screen and peer media has
|
|
216
|
+
* attached it; otherwise `null`. May be non-null in ordinary one-to-one meetings.
|
|
217
|
+
*/
|
|
218
|
+
readonly screen: MediaStream | null;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
/** The participant using this engine. */
|
|
222
|
+
export declare interface SelfParticipant {
|
|
223
|
+
/** Opaque participant ID. */
|
|
224
|
+
readonly id: string;
|
|
225
|
+
readonly role: ParticipantRole;
|
|
226
|
+
readonly displayName?: string;
|
|
227
|
+
/** ISO-8601 UTC timestamp from the platform. */
|
|
228
|
+
readonly joinedAt: string;
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
export { }
|