@rapidmx/meet-plugin 0.14.1 → 0.16.0

package/README.md

@@ -1,55 +1,35 @@
-# RapidMX: Video Conferencing
-
-[![CI](https://github.com/RapidMX/meet-plugin/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/RapidMX/meet-plugin/actions/workflows/build.yml)
-[![Coverage Status](https://coveralls.io/repos/github/RapidMX/meet-plugin/badge.svg?branch=main)](https://coveralls.io/github/RapidMX/meet-plugin?branch=main)
-[![npm version](https://img.shields.io/npm/v/@rapidmx/meet-plugin)](https://www.npmjs.com/package/@rapidmx/meet-plugin)
-
-Private and public WebRTC video meetings for a [RapidMX server](https://github.com/RapidMX/server). A mailbox owner
-turns on video conferencing for a calendar event; a private meeting mints one link per invitee (inserted into the
-invite's location and body), a public meeting shares a single link. Joining needs no account: a guest picks a name
-(auto-filled from their RapidMX profile when signed in), checks their camera and microphone, and enters. Calls are
-peer-to-peer WebRTC (no media server). Each pair of participants uses the best path that works, tried in order:
-
-1. **Direct peer-to-peer**, the preferred path.
-2. **Relayed through a configured TURN server**, for a participant a direct connection can't reach. A plain `turn:`
-   address is offered over both UDP and TCP, so a network that blocks UDP can still reach it.
-3. **Proxied by the RapidMX server itself over a WebSocket**, the last resort for a participant whose network lets
-   nothing but ordinary HTTPS out. Video is lower quality and sound may lag; it needs a browser with WebCodecs, and
-   can be turned off with the `mail:videoconf:relay:enabled` setting. A tile says when a participant is on the TURN
-   relay or the server relay.
-
-Participants can put **video filters** on their camera from the lobby or during the call: a blurred or custom
-background, black and white / sepia / night vision / pixelate looks, and face accessories. They run entirely in the
-browser (MediaPipe, loaded only when a filter needs it - from public CDNs by default, or from your own server with
-`mail:videoconf:effects:assets_url`), and the devices, on/off state and filters a participant chose are remembered in
-their browser's `localStorage` for next time.
-
-This plugin's `apps/` also ship the public join/lobby/in-call pages and the personal Settings screen - see
-`package.json`'s `rapidmx.plugin.ui` for exactly what's mounted where. Its `ui.appRail` entry adds a **Meet** button
-to the web client's app rail, shown only for a user who has a personal room: the entry's `resolveFrom`
-(`/mail/video-meetings/personal-room`, i.e. `GET /api/mail/video-meetings/personal-room`) answers
-`{ href: "/meet/<token>", label }` for the caller's personal room (the oldest still-active public meeting of the first
-mailbox they own that has one) or 404 when there is none, in which case the button stays hidden.
-
-## What it adds
-
-_(Filled in as each phase lands - see `.claude/NOTES.md` for the running detail, and `RELEASE_NOTES.md` for the
-full changelog.)_
-
-**Phase 1 (backend data model, routes, signaling) - done.** A mailbox owner creates a `VideoMeeting` through
-`/api/mail/video-meetings` - `private` (one join link minted per invitee) or `public` (one shared link) - and an
-anonymous participant joins through `GET .../join/:token`, which hands back the meeting's public details, an ICE
-server list (public STUN always, TURN when configured) and a short-lived guest token already authorized to
-exchange WebRTC signaling on that one meeting's channel over the server's existing `/push` route. No new realtime
-infrastructure and no UI yet - see `.claude/NOTES.md`'s dated entry for the full design.
-
-## Development
-
-Same layout and tooling as this project's other plugins (`@rapidmx/booking-plugin`, `@rapidmx/mapi-plugin`,
-`@rapidmx/autodiscover-plugin`): `yarn install`, `yarn test:prod`, `yarn build`. `@rapidmx/restapi` and
-`@rapidmx/web-client` are portal-linked in `package.json`'s `resolutions` during local development against a
-matching working tree of those repos.
-
-## License
-
-MPL-2.0 - see `LICENSE`.
+# RapidMX: Meet Plugin
+
+[![CI](https://github.com/RapidMX/meet-plugin/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/RapidMX/meet-plugin/actions/workflows/build.yml)
+[![Coverage Status](https://coveralls.io/repos/github/RapidMX/meet-plugin/badge.svg?branch=main)](https://coveralls.io/github/RapidMX/meet-plugin?branch=main)
+[![npm version](https://img.shields.io/npm/v/@rapidmx/meet-plugin)](https://www.npmjs.com/package/@rapidmx/meet-plugin)
+
+Private and public WebRTC video meetings for a [RapidMX server](https://github.com/RapidMX/server). A mailbox owner
+turns on video conferencing for a calendar event; a private meeting mints one link per invitee (inserted into the
+invite's location and body), a public meeting shares a single link. Joining needs no account: a guest picks a name
+(auto-filled from their RapidMX profile when signed in), checks their camera and microphone, and enters. Calls are
+peer-to-peer WebRTC (no media server). Each pair of participants uses the best path that works, tried in order:
+
+1. **Direct peer-to-peer**, the preferred path.
+2. **Relayed through a configured TURN server**, for a participant a direct connection can't reach. A plain `turn:`
+   address is offered over both UDP and TCP, so a network that blocks UDP can still reach it.
+3. **Proxied by the RapidMX server itself over a WebSocket**, the last resort for a participant whose network lets
+   nothing but ordinary HTTPS out. Video is lower quality and sound may lag; it needs a browser with WebCodecs, and
+   can be turned off with the `mail:videoconf:relay:enabled` setting. A tile says when a participant is on the TURN
+   relay or the server relay.
+
+Participants can put **video filters** on their camera from the lobby or during the call: a blurred or custom
+background, black and white / sepia / night vision / pixelate looks, and face accessories. They run entirely in the
+browser (MediaPipe, loaded only when a filter needs it - from public CDNs by default, or from your own server with
+`mail:videoconf:effects:assets_url`), and the devices, on/off state and filters a participant chose are remembered in
+their browser's `localStorage` for next time.
+
+During a call, participants can **chat** (Markdown, emoji, GIFs from the server's Giphy proxy, and image links shown
+as images) and draw together on a **shared whiteboard** (five pen types, a stencil for shapes, stamps, swatches and a
+color wheel). Both travel over the call's own signaling WebSocket (`/api/mail/video-meetings/signal/<meeting>`) and
+last only as long as the call - a late joiner gets them from a participant already there, and nothing is stored on
+the server.
+
+## License
+
+MPL-2.0 - see `LICENSE`.