velvet-rope 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -1,3 +1,313 @@
-# Temporary Holding Version
+# Velvet Rope
 
-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.
+Passkey sign-in and in-person device linking for small, private web apps. A new device gets in
+only when someone already inside scans its QR code: the scan is the approval. There's no
+password, no email, no invite code to type and no prompt to accept.
+
+- **One passkey per device.** Each one has its own WebAuthn user handle, label and role.
+- **Groups and roles.** A group has members. You define the roles; velvet-rope enforces the
+  admin rules (all admins are equal, and the last admin can't leave).
+- **Fastify + SQLite on the server**, plain ES modules in the browser. There's no framework and
+  no build step in the package.
+
+```
+npm install velvet-rope
+```
+
+Peer dependencies, depending on the parts you use: `fastify`, `@simplewebauthn/server` and
+`@fastify/rate-limit` (server); `@simplewebauthn/browser`, `qrcode` and `jsqr` (browser). The
+server works with either `better-sqlite3` or Node's built-in `node:sqlite` (Node 22.5+; no
+install needed): pass a handle from either, or let `openDatabase` pick whichever is available.
+
+| Import                         | What it is                                                                         |
+| ------------------------------ | ---------------------------------------------------------------------------------- |
+| `velvet-rope/domain`           | Pure rules, shared by server and client: `defineRoles`, link-request lifecycle, expiry |
+| `velvet-rope/server`           | The Fastify plugin, `migrate`, `startSweeper`, `createRateLimiter`, `createInvite` |
+| `velvet-rope/client`           | Headless browser API: `createClient`, `watchJoin`, `startScanner`, `renderQr`, ... |
+| `velvet-rope/ui`               | Drop-in components: `mountJoin`, `mountScanButton`, `openScanner`                  |
+| `velvet-rope/ui/style.css`     | Optional plain styles for the components' `vr-*` classes                           |
+| `velvet-rope/testing`          | Soft authenticator for API tests, `addMember`, `createSession`                     |
+| `velvet-rope/testing/playwright` | `addVirtualAuthenticator`, `twoDevices`, `linkDevice`                           |
+
+## How joining works
+
+1. The new device asks to join, under a label such as "Firefox on Android". It gets a token and
+   a 5-minute link cookie.
+2. It shows a QR code of `https://<app>/link#<token>`. The token sits in the fragment, so it
+   never reaches server logs.
+3. A signed-in member whose role can `link` scans it with the in-app scanner or the phone's
+   camera app.
+4. That device claims the request for its group. This is the approval.
+5. The new device hears `claimed` over Server-Sent Events, or polling as the fallback.
+6. It registers its own passkey.
+7. It's signed in with the linked role (your lowest role). An admin can raise the role later.
+
+## 1. Define roles once
+
+Put the matrix in a file that both server and client import.
+
+```js
+// roles.js
+import { defineRoles } from 'velvet-rope/domain';
+
+export const roles = defineRoles(
+  {
+    // 'link', 'manageMembers' and 'deleteGroup' are velvet-rope's; the rest are yours.
+    admin: ['read', 'write', 'delete', 'link', 'manageMembers', 'deleteGroup'],
+    collaborator: ['read', 'write', 'delete', 'link'],
+    contributor: ['read', 'write'],
+    viewer: ['read'],
+  },
+  { admin: 'admin', linked: 'viewer' },
+);
+
+// A rule that depends on the target stays a pure function, easy to test.
+// Contributors edit only the pages they created.
+export function canEditPage(session, page) {
+  if (roles.can(session.passkey.role, 'delete')) return true;
+  return roles.can(session.passkey.role, 'write') && page.created_by === session.passkey.id;
+}
+```
+
+`roles.can(role, capability)` answers yes or no. `roles.canManageMember(actor, target, change,
+adminCount)` is the per-target rule that the member routes enforce. `defineRoles` throws if the
+admin role lacks velvet-rope's capabilities.
+
+## 2. Server
+
+```js
+import Fastify from 'fastify';
+import velvetRope, { migrate, openDatabase, startSweeper } from 'velvet-rope/server';
+import { roles } from './roles.js';
+
+// better-sqlite3 if installed, otherwise node:sqlite. openDatabase('data/app.db', { driver })
+// forces one; `new Database(...)` / `new DatabaseSync(...)` handles work too, wherever velvet-rope
+// takes a `db`.
+const db = openDatabase('data/app.db');
+db.pragma('foreign_keys = ON');
+migrate(db); // velvet-rope's tables, tracked in velvet_rope_schema
+db.exec(`CREATE TABLE IF NOT EXISTS pages (
+  id TEXT PRIMARY KEY,
+  group_id TEXT NOT NULL REFERENCES groups(id) ON DELETE CASCADE,
+  title TEXT NOT NULL,
+  created_by TEXT
+)`);
+
+const app = Fastify({ trustProxy: 'loopback' });
+await app.register(velvetRope, {
+  db,
+  rp: { id: 'notes.example.com', name: 'Notes', origin: 'https://notes.example.com' },
+  roles,
+  prefix: '/api', // the default
+  cookiePrefix: 'notes', // cookies notes_session / __Host-notes_session, notes_link
+  csrfHeader: 'X-Notes', // every mutating request needs JSON and `X-Notes: 1`
+  groupCreation: 'open', // 'open' | 'invite' | 'closed'
+  // Optional:
+  // rateLimit: createRateLimiter(app, DEFAULT_RATE_LIMITS),
+  // events: createHub(),             // share the hub to publish your own events
+  // hooks: { onAudit(db, entry) {}, onGroupCreated(db, group) {}, onGroupDeleted(db, group) {} },
+  // messages: { link_expired: 'That code has gone stale. Ask for a fresh one.' },
+});
+await app.listen({ port: 3000 });
+startSweeper(db); // hourly clean-up of expired sessions, challenges, join requests, invites
+```
+
+Routes it adds, under `prefix`:
+
+| Route                                                                            | What it does                                    |
+| -------------------------------------------------------------------------------- | ----------------------------------------------- |
+| `POST /groups/options`, `POST /groups`                                           | Create a group; the first passkey is admin      |
+| `POST /auth/options`, `POST /auth`, `POST /auth/sign-out`                        | Discoverable sign-in, sign-out                  |
+| `GET /me`                                                                        | `{ passkey, group }`; slides the cookie         |
+| `POST /link-requests`, `GET /link-requests/current`, `GET /link-requests/current/events` | The new device asks to join and watches |
+| `POST /link-requests/claim`                                                      | A member who can `link` approves by scanning    |
+| `POST /link-requests/current/options`, `POST /link-requests/current/complete`    | The new device registers its passkey            |
+| `GET /members`, `PATCH /members/:id`, `DELETE /members/:id`, `POST /members/leave` | List, rename, set role, revoke, leave         |
+| `DELETE /group`                                                                  | Delete the group (body `{ name }` to confirm)   |
+| `GET /events`                                                                    | The group's Server-Sent Events stream           |
+
+Every refusal is `{ error: code, message }`. The codes are in `src/server/messages.js`. Pass
+`messages` to reword any of them.
+
+## 3. Check permissions in your routes
+
+```js
+import { canEditPage } from './roles.js';
+
+// View: any member whose role has 'read'. Always scope queries by the session's group.
+app.get('/api/pages/:id', { onRequest: app.requireCapability('read') }, async (req, reply) => {
+  const page = db
+    .prepare('SELECT * FROM pages WHERE id = ? AND group_id = ?')
+    .get(req.params.id, req.session.group.id);
+  return page ?? reply.code(404).send({ error: 'not_found' });
+});
+
+// Edit: the role check, then the per-page rule.
+app.put('/api/pages/:id', { onRequest: app.requireCapability('write') }, async (req, reply) => {
+  const page = db
+    .prepare('SELECT * FROM pages WHERE id = ? AND group_id = ?')
+    .get(req.params.id, req.session.group.id);
+  if (!page) return reply.code(404).send({ error: 'not_found' });
+  if (!canEditPage(req.session, page)) return reply.code(403).send({ error: 'forbidden' });
+  // ...save
+});
+
+// Delete: the role alone decides.
+app.delete('/api/pages/:id', { onRequest: app.requireCapability('delete') }, async (req) => {
+  db.prepare('DELETE FROM pages WHERE id = ? AND group_id = ?').run(
+    req.params.id,
+    req.session.group.id,
+  );
+});
+```
+
+The guards and decorators:
+
+- `app.requireSession` answers 401 when there's no live session.
+- `app.requireCapability(cap)` answers 401 the same way, and 403 when the role can't do `cap`.
+- `req.session` is `{ passkey: { id, label, role }, group: { id, name } }`.
+- `req.can(cap)` checks a capability inside a handler.
+- `app.velvetRope.events.publish(groupId, event, data)` sends your own events on the group's
+  stream.
+
+## 4. Browser: who's signed in, and which controls to show
+
+```js
+import { connectSessionEvents, createClient } from 'velvet-rope/client';
+import { canEditPage, roles } from './roles.js';
+
+const client = createClient({ csrfHeader: 'X-Notes' }); // or pass your own getJson/postJson/...
+const me = await client.getMe(); // null when signed out
+
+editButton.hidden = !canEditPage(me, page);
+deleteButton.hidden = !roles.can(me.passkey.role, 'delete');
+
+const events = new EventSource(client.eventsUrl);
+connectSessionEvents(events, {
+  onRoleChanged: (role) => {
+    me.passkey.role = role;
+    rerender();
+  },
+  onRevoked: () => showSignedOut('This device was removed.'),
+  onGroupDeleted: ({ name }) => showSignedOut(`${name} was deleted.`),
+});
+```
+
+Hiding a control only spares people a button that wouldn't work. The server check is what
+enforces access.
+
+The client also has `signIn()`, `signOut()`, `createGroup({ groupName, label, invite })`,
+`listMembers()`, `updateMember(id, { label, role })`, `removeMember(id)`, `leaveGroup()` and
+`deleteGroup(name)`.
+
+## 5. Show the join QR (new device)
+
+```js
+import { createClient } from 'velvet-rope/client';
+import { mountJoin } from 'velvet-rope/ui';
+import 'velvet-rope/ui/style.css';
+
+mountJoin(document.querySelector('#join'), {
+  client: createClient({ csrfHeader: 'X-Notes' }),
+  onJoined: (me) => showHome(me),
+  onCancel: () => showWelcome(),
+  text: { title: 'Join the family notes' }, // any string: see JOIN_TEXT
+  classes: { root: 'card' }, // any class: see JOIN_CLASSES
+});
+```
+
+It covers the label form, the QR code, a countdown, a copy-link fallback, the wait, and the
+passkey prompt. Firefox may need a fresh tap to create the passkey after the wait. When that
+happens, the component shows a **Create passkey** button.
+
+For your own markup, use the same steps headless:
+
+```js
+import { createClient, linkUrl, renderQr, watchJoin } from 'velvet-rope/client';
+
+const client = createClient();
+const { token } = await client.requestJoin('Firefox on Android');
+qrBox.replaceChildren(await renderQr(linkUrl(location.origin, token)));
+const stop = watchJoin({
+  client,
+  onStatus: async ({ status }) => {
+    if (status === 'claimed') {
+      stop();
+      showHome(await client.completeJoin());
+    }
+    if (status === 'expired') showExpired();
+  },
+});
+```
+
+## 6. Add the scanner (signed-in device)
+
+```js
+import { mountScanButton } from 'velvet-rope/ui';
+
+if (roles.can(me.passkey.role, 'link')) {
+  mountScanButton(toolbar, {
+    client,
+    onLinked: ({ label }) => toast(`Linked ${label}. Set its role in Members.`),
+    onError: (message) => toast(message),
+    text: { button: 'Add a device' },
+  });
+}
+```
+
+The scanner and `jsqr` load only when someone presses the button. To build your own camera view,
+call `startScanner({ video, onText })` from `velvet-rope/client`.
+
+**Opened with the phone's camera app.** The QR is an ordinary link to `/link#<token>`. Serve
+your app there, and on page load:
+
+```js
+import { takeLinkFromLocation } from 'velvet-rope/client';
+
+const token = takeLinkFromLocation(); // reads #token and clears it from the address bar
+if (token) me ? await client.claimLink(token) : rememberForAfterSignIn(token);
+```
+
+## 7. Testing
+
+```js
+import { addMember, createSoftAuthenticator } from 'velvet-rope/testing';
+
+// A real passkey for fastify.inject tests: the server's verification runs unmocked.
+const phone = createSoftAuthenticator({ origin: 'http://localhost:5173' });
+const options = (await post('/api/groups/options', { groupName: 'Home', label: 'Phone' })).json();
+await post('/api/groups', { response: phone.register(options) });
+
+// Or skip the ceremony: a member with a role, signed in.
+const { token } = addMember(db, { groupId, role: 'contributor' });
+const cookie = `notes_session=${token}`;
+```
+
+```js
+// Playwright (Chromium)
+import { linkDevice, twoDevices } from 'velvet-rope/testing/playwright';
+
+const { phone, desktop, close } = await twoDevices(browser);
+// ...the phone creates a group...
+await linkDevice({
+  joiner: desktop,
+  scanner: phone,
+  label: 'Desktop',
+  openJoin: (page) => page.goto('/join'),
+});
+```
+
+## Security notes
+
+- Session cookies, challenges, link tokens and invite codes are 256-bit random values, stored
+  only as SHA-256 hashes.
+- The session cookie is `HttpOnly; Secure; SameSite=Strict`, with a 30-day sliding expiry and the
+  `__Host-` prefix on HTTPS.
+- On top of SameSite=Strict, mutating requests need JSON and the CSRF header.
+- Challenges are single-use and expire after 5 minutes. A join request expires 5 minutes after
+  it's created, and claiming doesn't extend it.
+- Every query in the plugin is scoped to the session's group. Scope yours the same way.
+- Nothing secret is logged. WebAuthn error text, which can echo challenges, is never returned.
+
+Testing on a real phone needs real HTTPS with a valid certificate. WebAuthn accepts
+`http://localhost` only on the machine itself.