@strevokit/meeting-sdk 0.0.0-stage → 0.8.0

package/CHANGELOG.md

@@ -0,0 +1,96 @@
+# Changelog
+
+All notable changes to `@strevokit/meeting-sdk` are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the package follows
+[semantic versioning](https://semver.org/). Before 1.0.0, breaking changes bump the minor version.
+
+## [Unreleased]
+
+## [0.8.0]
+
+Bundles `@strevokit/signaling-protocol` 1.6.0.
+
+### Changed
+
+- A live camera or microphone whose capture ends may continue on another device of that kind. The kind stays on, and
+  the change is not announced as stopped or started. When no other device of that kind can be opened, the kind turns
+  off and is announced as before.
+
+## [0.7.0]
+
+Bundles `@strevokit/signaling-protocol` 1.6.0.
+
+### Added
+
+- Connection state `reconnecting` for automatic meeting-service recovery after an unexpected drop while joined.
+- Optional `getJoinToken` and `reconnectWindowMs` on `MeetingEngineOptions` so hosts can mint a fresh join token
+  during recovery (default recovery window 120 seconds).
+- Media-path recovery while the room connection stays up: restart after a sustained interruption, and one bounded
+  link recreate after a failure within the recovery window.
+
+### Documentation
+
+- Backend API guide covering `POST /v1/meetings`, `POST /v1/meetings/{public_id}/participants`,
+  `POST /v1/meetings/{public_id}/join-token`, and related embed-origin / get / end routes, with an Express-style
+  integration example.
+
+## [0.6.0]
+
+Bundles `@strevokit/signaling-protocol` 1.6.0.
+
+### Changed
+
+- Remote `screen` media is delivered in ordinary 1-to-1 peer meetings; shell consumers can render
+  `remoteMedia(id).screen`. When the meeting cannot carry screen bits, `startScreenShare()` rejects with
+  `unsupported_environment` before opening the display-capture prompt.
+
+## [0.5.0]
+
+Bundles `@strevokit/signaling-protocol` 1.6.0.
+
+### Added
+
+- `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`.
+- Close code 4004 mapped to `meeting_ended`.
+
+## [0.4.0]
+
+Bundles `@strevokit/signaling-protocol` 1.5.0. No changes are needed in existing integrations.
+
+### Added
+
+- Device choice: `enableCamera(options?)` and `unmute(options?)` accept `MediaDeviceOptions` with a `deviceId` from
+  `navigator.mediaDevices.enumerateDevices()`. Calling either while that device kind is already on switches to the
+  chosen device in place, without turning it off, so other participants see no interruption.
+- A chosen device that is missing rejects with `device_not_found`, and a busy one with `device_unavailable`; the
+  device already in use keeps running.
+
+## [0.3.0]
+
+Bundles `@strevokit/signaling-protocol` 1.5.0. Calls connect on more networks and stay connected through credential
+renewals, with no changes needed in existing integrations.
+
+## [0.2.0]
+
+Bundles `@strevokit/signaling-protocol` 1.4.0. No changes are needed in existing integrations.
+
+### Added
+
+- Remote media: `remote_media_changed` event and `remoteMedia(participantId)`, so you can render other participants'
+  camera and microphone.
+- Connection status per participant: `media_connection_changed` event and `mediaConnectionStatus(participantId)`.
+- Error codes `media_connection_failed` and `media_participant_limit`.
+
+## [0.1.0]
+
+Bundles `@strevokit/signaling-protocol` 1.3.0.
+
+### Added
+
+- `createMeetingEngine(options)` returning a `MeetingEngine`: `join()`, `leave()`, `dispose()`, and the participant
+  list with each participant's role and media state.
+- Local media controls: `enableCamera()`, `disableCamera()`, `mute()`, `unmute()`, `startScreenShare()`, and
+  `stopScreenShare()`, with `localMediaState` and `localMedia` for self-preview.
+- Events: `state_changed`, `joined`, `participant_joined`, `participant_left`, `participant_reconnected`,
+  `participant_media_changed`, `local_media_changed`, `error`, and `closed`.
+- `MeetingError` with stable codes, user-safe messages, and a `retryable` flag.

package/LICENSE

@@ -0,0 +1,215 @@
+Copyright 2026 Agilia IT
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Agilia IT
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,174 @@
-# Temporary Holding Version
+# @strevokit/meeting-sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Embed Strevokit meetings in your web product.
+
+The SDK is **headless**: it joins a meeting, keeps the participant list up to date, and controls the local camera,
+microphone, and screen share. It has no UI and no runtime dependencies, so it works with any framework. Build your own
+interface on top of it, or use the Strevokit UI components when they are available.
+
+- Zero runtime dependencies, one ES module, full TypeScript types.
+- One interface (`MeetingEngine`) for every meeting size. Your code never changes when the platform changes how media
+  is delivered.
+- Stable error codes with user-safe messages.
+
+## Install
+
+```bash
+npm install @strevokit/meeting-sdk
+```
+
+The package is ESM-only and runs in browsers. Use it through a bundler (Vite, webpack, esbuild, and so on) or a native
+`<script type="module">`.
+
+## Quick start
+
+### 1. Prepare the meeting on your backend
+
+Your backend talks to the Strevokit HTTP API with its API credential, then returns only a short-lived join token to the
+browser. **Never** send the API credential to the browser. Full request and response shapes:
+[Backend API](./docs/backend-api.md).
+
+```ts
+// Server side. Headers on every call:
+//   Authorization: Bearer ${process.env.STREVOKIT_API_CREDENTIAL}
+//   Content-Type: application/json
+const api = "https://api.example.com"; // your Strevokit API base URL
+const headers = {
+  Authorization: `Bearer ${process.env.STREVOKIT_API_CREDENTIAL}`,
+  "Content-Type": "application/json",
+};
+
+// Once per environment: allow-list the origin that hosts your page.
+await fetch(`${api}/v1/embed-origins`, {
+  method: "POST",
+  headers,
+  body: JSON.stringify({ origin: "https://app.example.com" }),
+});
+
+// Create the meeting, then authorize each person who may join.
+const { data: meeting } = await fetch(`${api}/v1/meetings`, {
+  method: "POST",
+  headers,
+  body: JSON.stringify({ type: "one_to_one", max_participants: 2 }),
+}).then((r) => r.json());
+
+const { data: participant } = await fetch(`${api}/v1/meetings/${meeting.public_id}/participants`, {
+  method: "POST",
+  headers,
+  body: JSON.stringify({
+    external_user_id: "user_42",
+    display_name: "Alex",
+    role: "host",
+  }),
+}).then((r) => r.json());
+
+// When the signed-in user opens the meeting page, mint a join token and return only data.token.
+const { data } = await fetch(`${api}/v1/meetings/${meeting.public_id}/join-token`, {
+  method: "POST",
+  headers,
+  body: JSON.stringify({ participant_public_id: participant.public_id }),
+}).then((r) => r.json()); // { token, expires_at, expires_in }
+```
+
+### 2. Join from the browser
+
+```ts
+import { createMeetingEngine, MeetingError } from "@strevokit/meeting-sdk";
+
+const engine = createMeetingEngine({
+  token, // from your backend
+  realtimeUrl: "wss://realtime.example.com", // your Strevokit realtime endpoint
+});
+
+engine.on("joined", ({ self, participants }) => {
+  console.log(`Joined as ${self.role} with ${participants.length} others`);
+});
+engine.on("participant_joined", ({ participant }) => addTile(participant));
+engine.on("participant_left", ({ participantId }) => removeTile(participantId));
+engine.on("participant_media_changed", ({ participantId, kind, enabled }) => updateTile(participantId, kind, enabled));
+engine.on("closed", ({ reason, error }) => showEndScreen(reason, error?.message));
+
+try {
+  await engine.join();
+} catch (error) {
+  if (error instanceof MeetingError) showError(error.message); // safe to show to users
+}
+```
+
+### 3. Control media
+
+```ts
+await engine.enableCamera();
+selfPreview.srcObject = engine.localMedia.camera; // a MediaStream for a <video> element
+
+await engine.unmute();
+await engine.startScreenShare(); // rejects with `not_permitted` if your role may not share
+```
+
+Every media method is idempotent and rejects with a `MeetingError` (for example `permission_denied` or
+`device_not_found`) without changing any state.
+
+### 4. Show other participants
+
+```ts
+engine.on("remote_media_changed", ({ participantId, kind, stream }) => {
+  if (kind === "camera") videoFor(participantId).srcObject = stream; // a <video autoplay playsinline muted>
+  if (kind === "microphone") audioFor(participantId).srcObject = stream; // an <audio autoplay>
+});
+engine.on("media_connection_changed", ({ participantId, status }) => {
+  // "connecting" | "connected" | "interrupted" | "failed", or null when there is no connection any more
+  showStatus(participantId, status);
+});
+```
+
+`stream` is `null` when that media stops being available. `engine.remoteMedia(participantId)` and
+`engine.mediaConnectionStatus(participantId)` return the current values at any time.
+
+### 5. Leave
+
+```ts
+await engine.leave(); // releases camera, microphone, and screen; then `closed` fires with reason "left"
+```
+
+An engine joins once. To join again, mint a new token and create a new engine. Call `engine.dispose()` when your
+component unmounts; it releases everything immediately and emits nothing.
+
+More examples: [plain HTML](./docs/examples/vanilla.html), [React](./docs/examples/react.tsx), and
+[backend integration](./docs/examples/backend-integration.md).
+
+## Browser support
+
+Current versions of Chrome, Edge, Firefox, and Safari. The page must be served over HTTPS (browsers only allow camera,
+microphone, and screen access in secure contexts). In an unsupported browser the SDK throws or rejects with
+`unsupported_environment`.
+
+## Security
+
+- **The join token stays in memory.** The SDK sends it only during the connection handshake. It never appears in URLs,
+  storage, events, error messages, or log output.
+- **Identity comes from the token.** Role and participant identity are decided by your backend when it mints the token.
+  The SDK never sends a role or identity of its own.
+- **Embed origins are allow-listed.** Joins are accepted only from the origins configured for your tenant. A join from
+  any other site fails with `origin_not_allowed`.
+- **Local development.** `realtimeUrl` must use `wss://`. Plain `ws://` is accepted only for `localhost` and
+  `127.0.0.1`.
+
+## Versioning
+
+The package follows [semantic versioning](https://semver.org/). The public API is exactly what
+[docs/api-reference.md](./docs/api-reference.md) describes. Before 1.0.0, breaking changes bump the minor version; from
+1.0.0 they bump the major version. New event types and error codes may be added in minor versions, so handle unknown
+values generically. See the [changelog](./CHANGELOG.md).
+
+## Documentation
+
+- [Backend API](./docs/backend-api.md): create meeting, authorize participants, mint join tokens, and related routes
+  (`POST` / `GET` / `DELETE` with request and response shapes).
+- [API reference](./docs/api-reference.md): every export, method, event, error code, and close reason.
+- [Examples](./docs/examples/).
+
+## Source and releases
+
+The source is published at [github.com/AgiliaIT/strevokit-meeting-sdk](https://github.com/AgiliaIT/strevokit-meeting-sdk).
+Releases are published to npm from that repository with npm provenance, and tagged `meeting-sdk-v<version>`. Report
+problems through its [issues](https://github.com/AgiliaIT/strevokit-meeting-sdk/issues).