@volter/twin-livekit 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,106 @@
+# @volter/twin-livekit
+
+A local **LiveKit control-plane twin** for offline room and egress tests. It
+models the Twirp JSON APIs used by `livekit-server-sdk` for room lifecycle,
+participant inspection, metadata updates, and room-composite egress.
+
+```bash
+world-livekit serve [--port N] [--root DIR] [--read-only]
+world-livekit conformance [--root DIR]
+```
+
+## Coverage
+
+The capability manifest (`src/livekit-capabilities.ts`) is an honest partial
+denominator for LiveKit server APIs: RoomService, Egress, Ingress, SIP, agent
+dispatch, webhooks, tokens, recording outputs, auth/error behavior, and media
+plane behavior are enumerated.
+
+**Modeled:**
+
+- **RoomService**: `CreateRoom`, `ListRooms`, `DeleteRoom`,
+  `UpdateRoomMetadata`, `ListParticipants`, `GetParticipant`,
+  `RemoveParticipant`, `UpdateParticipant` (including atomic permission grant
+  replacement), `MutePublishedTrack`, `UpdateSubscriptions`, `SendData`,
+  `ForwardParticipant` (mirror into a destination room; mirror cannot publish)
+  and `MoveParticipant` (relocate; left source, present in destination).
+- **Participants/tracks**: deterministic local participant rows with track
+  source and muted state, permission grants, and per-participant subscription
+  sets, including the `SCREEN_SHARE` checks Runhuman uses. Participant rows are
+  seeded through the local-only `livekit.Twin` test hook; the real WebRTC
+  join/media path is not claimed as vendor API coverage.
+- **Egress**: all five start verbs — `StartRoomCompositeEgress`,
+  `StartWebEgress`, `StartParticipantEgress`, `StartTrackCompositeEgress`,
+  `StartTrackEgress` (each tagged with the correct protobuf `request` oneof
+  case) — plus `ListEgress`, `StopEgress`, `UpdateLayout`, `UpdateStream`
+  (add/remove stream URLs), segment outputs, image (thumbnail) outputs, the
+  per-egress `webhookUrl` config field, and terminal failure-state transitions
+  (`FAILED`/`ABORTED`/`LIMIT_REACHED`). Image/webhook config is persisted on the
+  request and round-trips via `ListEgress`; this twin records the control-plane
+  state rather than running egress workers that render bytes.
+- **Ingress**: `CreateIngress`, `UpdateIngress`, `ListIngress`,
+  `DeleteIngress`; RTMP/WHIP/URL input types with stream-key/URL minting and
+  the RTMP-transcoding vs WHIP-bypass defaults.
+- **SIP** (`SIPService`): `CreateSIPInboundTrunk` / `CreateSIPOutboundTrunk` +
+  `ListSIPInboundTrunk` / `ListSIPOutboundTrunk` (filter by id/number) +
+  `DeleteSIPTrunk`; `CreateSIPDispatchRule` (direct + individual `rule` oneof) +
+  `ListSIPDispatchRule` (filter by id/trunk, wildcard rules match) +
+  `DeleteSIPDispatchRule`; `CreateSIPParticipant` (dials over a known outbound
+  trunk and adds a `kind=SIP` room participant) + `TransferSIPParticipant`
+  (records the transfer destination on participant attributes). Trunk/rule
+  *update* verbs are still TODO. This twin models SIP control, not signalling/RTP.
+- **Agent dispatch** (`AgentDispatchService`): `CreateDispatch`, `ListDispatch`
+  (filter by room + dispatch id), and `DeleteDispatch`. This twin models the
+  dispatch records, not an agent worker runtime.
+- **Access tokens**: `mintAccessToken` / `verifyAccessToken` produce and check
+  HS256 grant JWTs that are byte-compatible with the SDK's `AccessToken` and
+  `TokenVerifier` (video + SIP grants, exp/nbf, forgery rejection).
+- **Webhooks**: `buildWebhookBody` / `signWebhookHeader` / `verifyWebhook`
+  produce and verify signed webhook deliveries (HMAC auth header + body
+  `sha256`) that round-trip with the SDK's `WebhookReceiver`, covering room,
+  participant, egress, and ingress events.
+- **Auth & errors**: opt-in access-token enforcement (`apiKeys` on the server /
+  handler) yields vendor-faithful `unauthenticated` (missing/invalid/expired
+  token) and `permission_denied` (missing grant) Twirp errors, plus an
+  `resource_exhausted` egress capacity quota.
+- **SDK fidelity**: tests drive the unmodified `RoomServiceClient`,
+  `EgressClient`, `IngressClient`, `SipClient`, `AgentDispatchClient`,
+  `AccessToken`/`TokenVerifier`, and `WebhookReceiver` against the local twin.
+- **Connector**: injected-client pull folds rooms/participants/egresses/ingresses
+  into local state (`pullLiveKitSnapshot`), plus SIP trunks/dispatch rules
+  (`pullLiveKitSIP`) and per-room agent dispatches (`pullLiveKitAgentDispatch`),
+  all idempotent; push confirms pending room metadata and egress stop actions.
+
+**Planned (todo):**
+
+- **Outbound webhook delivery** — POST the signed event bodies the twin already
+  builds to the configured `webhookUrl`, with the documented retry schedule.
+- **Still TODO** (not faked): SIP trunk/dispatch-rule *update* verbs
+  (`UpdateSIPInboundTrunk` / `UpdateSIPOutboundTrunk` / `UpdateSIPDispatchRule`,
+  replace + field-merge). Unmodeled SIP/agent ops fail with a vendor-faithful
+  `not_found` Twirp error rather than being faked.
+
+### No UI mirror
+
+LiveKit is a vendor whose **product is the API**: the twin models the server-side SFU control plane
+(RoomService, Egress, Ingress, SIP, agent dispatch, tokens, webhooks), which applications drive from
+code. LiveKit Cloud's console is incidental project/key tooling, not where the work happens. Per
+[../../../docs/contributing/adding-a-twin.md](../../../docs/contributing/adding-a-twin.md) ("Does this vendor get a mirror?") and
+[../../../docs/contributing/architecture.md](../../../docs/contributing/architecture.md) C1b, this pack ships **no React mirror and no UI
+capabilities** — omit rather than fabricate a dashboard. Coverage is API + connector + tokens.
+
+## The store door
+
+LiveKit's server API is Twirp: every operation, `ListRooms` included, is a POST to
+`/twirp/livekit.<Service>/<Method>`. The vendor surface has no GET, so twin state had no
+ordinary read. `GET /twin/store/{rooms,participants,egress,ingress}` is that read — the pack's
+own named deterministic projections over stored state, served by the same fetch adapter the
+Twirp paths come out of (the `mailgun` precedent). They are deliberately **out of the capability
+manifest**: counting scaffolding the vendor does not have would pad the denominator. `GET /twin`
+names them under `stores`.
+
+## Architecture
+
+State lives in the `@volter/world-core` event/action log. The serve path makes no real
+LiveKit calls. Connector functions accept injected executors for real LiveKit
+I/O and are not used by the local handler.

package/dist/src/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/src/cli.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+import { keepProcessAlive } from '@volter/world-core/lifecycle';
+import { hasFlag, optionValue } from '@volter/world-core/args';
+import { createLiveKitTwinServer } from "./livekit-server.js";
+const [cmd, ...rest] = process.argv.slice(2);
+const port = Number(optionValue(rest, '--port', '0')) || undefined;
+const root = optionValue(rest, '--root') || undefined;
+const readOnly = hasFlag(rest, '--read-only');
+if (cmd === 'serve') {
+    const server = await createLiveKitTwinServer({ readOnly, ...(root ? { root } : {}), ...(port ? { port } : {}) });
+    process.stdout.write(`livekit twin${readOnly ? ' [read-only]' : ''} at http://127.0.0.1:${server.port}\n`);
+    await keepProcessAlive();
+}
+else if (cmd === 'conformance') {
+    const { checkLiveKitConformance } = await import("./livekit-conformance.js");
+    const report = await checkLiveKitConformance({ ...(root ? { root } : {}) });
+    process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
+    if (!report.ok)
+        process.exitCode = 1;
+}
+else {
+    process.stdout.write('Usage: world-livekit serve|conformance [--port N] [--root DIR] [--read-only]\n');
+}

package/dist/src/egress-service-cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/src/egress-service-cli.js

@@ -0,0 +1,101 @@
+#!/usr/bin/env node
+// @ts-nocheck
+import { spawn, spawnSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
+const PORT = process.env.PORT;
+const LIVEKIT_URL = process.env.LIVEKIT_URL;
+const REDIS_HOST = process.env.REDIS_HOST;
+if (!PORT)
+    throw new Error('PORT is required');
+if (!LIVEKIT_URL)
+    throw new Error('LIVEKIT_URL is required');
+if (!REDIS_HOST)
+    throw new Error('REDIS_HOST is required');
+// Loopback mode (EGRESS_LOOPBACK_PORTS, extra host ports such as an S3 twin's): a forwarding sidecar owns the
+// egress's network namespace and carries 127.0.0.1:<port> to this host's loopback, so the egress reaches LiveKit,
+// Redis and every named port at the same 127.0.0.1 address as everything else on this host. One storage endpoint
+// URL then means the same place to the egress (which uploads to it) and to the host process that reads it back.
+const loopbackPorts = (process.env.EGRESS_LOOPBACK_PORTS ?? '').split(',').map((p) => p.trim()).filter(Boolean);
+const loopback = loopbackPorts.length > 0;
+const portOf = (value) => /:(\d+)/.exec(value ?? '')?.[1];
+const hostLiveKitUrl = loopback ? LIVEKIT_URL : LIVEKIT_URL.replace('127.0.0.1', 'host.docker.internal');
+const hostRedis = loopback ? REDIS_HOST : REDIS_HOST.replace('127.0.0.1', 'host.docker.internal');
+const dockerReachable = (value) => value?.replace('127.0.0.1', 'host.docker.internal').replace('localhost', 'host.docker.internal');
+const proxyUrl = dockerReachable(process.env.HTTPS_PROXY || process.env.HTTP_PROXY || '');
+const caBundle = process.env.AWS_CA_BUNDLE || process.env.SSL_CERT_FILE || '';
+const containerCa = '/tmp/volter-world-ca.pem';
+const configBody = [
+    // The keys of the LiveKit this egress serves (a World names its own); the dev pair is LiveKit's --dev default.
+    `api_key: ${process.env.LIVEKIT_API_KEY ?? 'devkey'}`,
+    `api_secret: ${process.env.LIVEKIT_API_SECRET ?? 'secret'}`,
+    `ws_url: ${hostLiveKitUrl}`,
+    'insecure: true',
+    `health_port: ${PORT}`,
+    'redis:',
+    `  address: ${hostRedis}`,
+    'cpu_cost:',
+    '  room_composite_cpu_cost: 1.0',
+    '  web_cpu_cost: 1.0',
+    '  track_composite_cpu_cost: 1.0',
+    '  track_cpu_cost: 0.5',
+    'log_level: info',
+    '',
+].join('\n');
+const name = `volter-livekit-egress-${PORT}`;
+const sidecar = `${name}-loopback`;
+if (loopback) {
+    const forward = [...new Set([portOf(LIVEKIT_URL), portOf(REDIS_HOST), ...loopbackPorts].filter(Boolean))];
+    const script = forward.map((p) => `socat TCP-LISTEN:${p},fork,reuseaddr,bind=127.0.0.1 TCP:host.docker.internal:${p} &`).join(' ') + ' wait';
+    spawnSync('docker', ['rm', '-f', sidecar], { stdio: 'ignore' });
+    const started = spawnSync('docker', ['run', '-d', '--rm', '--name', sidecar, '-p', `127.0.0.1:${PORT}:${PORT}`, '--entrypoint', 'sh', 'alpine/socat', '-c', script], { stdio: 'inherit' });
+    if (started.status !== 0)
+        throw new Error('the egress loopback sidecar did not start');
+}
+const dockerArgs = [
+    'run',
+    '--rm',
+    '--name',
+    name,
+    '--cap-add=SYS_ADMIN',
+    ...(loopback ? ['--network', `container:${sidecar}`] : ['-p', `127.0.0.1:${PORT}:${PORT}`]),
+    '-e',
+    `EGRESS_CONFIG_BODY=${configBody}`,
+];
+if (proxyUrl) {
+    const noProxy = '127.0.0.1,localhost,host.docker.internal';
+    dockerArgs.push('-e', `HTTPS_PROXY=${proxyUrl}`, '-e', `HTTP_PROXY=${proxyUrl}`, '-e', `https_proxy=${proxyUrl}`, '-e', `http_proxy=${proxyUrl}`, '-e', `NO_PROXY=${noProxy}`, '-e', `no_proxy=${noProxy}`);
+}
+if (caBundle) {
+    if (!existsSync(caBundle))
+        throw new Error(`world CA bundle does not exist: ${caBundle}`);
+    dockerArgs.push('-e', `AWS_CA_BUNDLE=${containerCa}`, '-e', `SSL_CERT_FILE=${containerCa}`);
+}
+dockerArgs.push('livekit/egress:latest');
+const child = spawn('docker', dockerArgs, { stdio: 'inherit' });
+function copyCaIntoContainer(attempt = 0) {
+    if (!caBundle)
+        return;
+    const result = spawnSync('docker', ['cp', caBundle, `${name}:${containerCa}`], { stdio: 'ignore' });
+    if (result.status === 0)
+        return;
+    if (attempt >= 50) {
+        process.stderr.write(`failed to copy world CA into ${name}; S3 egress TLS may fail\n`);
+        return;
+    }
+    setTimeout(() => copyCaIntoContainer(attempt + 1), 100);
+}
+copyCaIntoContainer();
+async function stop() {
+    try {
+        spawn('docker', ['rm', '-f', name], { stdio: 'ignore' });
+        if (loopback)
+            spawn('docker', ['rm', '-f', sidecar], { stdio: 'ignore' });
+    }
+    catch {
+        // best effort
+    }
+}
+process.on('SIGTERM', () => { stop(); process.exit(0); });
+process.on('SIGINT', () => { stop(); process.exit(0); });
+child.on('exit', (code) => { if (loopback)
+    spawnSync('docker', ['rm', '-f', sidecar], { stdio: 'ignore' }); process.exit(code ?? 0); });

package/dist/src/index.d.ts

@@ -0,0 +1,14 @@
+export { handleLiveKitTwinRequest } from './livekit-twin.js';
+export { createLiveKitTwinFetch, createLiveKitTwinServer, type LiveKitTwinFetchOptions } from './livekit-server.js';
+export { liveKitHttpOrigin, liveKitRequestForAction, liveKitTwirpPath, liveLiveKitExecute, pullLiveKitSnapshot, pullLiveKitSIP, pullLiveKitAgentDispatch, pushLiveKitAction, syncLiveKitFromReal, } from './livekit-connector.js';
+export type { LiveKitExecute, LiveKitService } from './livekit-connector.js';
+export { LIVEKIT_BUDGET_CEILING, LIVEKIT_BUDGET_MAX_RETRY_AFTER_S, LIVEKIT_BUDGET_WINDOW_MS, LIVEKIT_CALL_WEIGHTS, LIVEKIT_RATE_BUDGET, LiveKitBudget, LiveKitBudgetError, liveKitBudgetPath, liveKitCallWeight, } from './livekit-budget.js';
+export type { LiveKitBudgetErrorKind, LiveKitBudgetOptions, LiveKitBudgetReservation, LiveKitBudgetSnapshot, } from './livekit-budget.js';
+export { mintAccessToken, verifyAccessToken } from './livekit-token.js';
+export type { LiveKitClaimGrants, LiveKitVideoGrant, LiveKitSIPGrant, MintTokenInput, VerifyResult } from './livekit-token.js';
+export { buildWebhookBody, signWebhookHeader, verifyWebhook } from './livekit-webhook.js';
+export type { WebhookEventInput, WebhookVerifyResult } from './livekit-webhook.js';
+export type { EgressRequestCase, LiveKitEgress, LiveKitIngress, LiveKitParticipant, LiveKitParticipantPermission, LiveKitRequest, LiveKitResponse, LiveKitRoom, LiveKitTrack, LiveKitWebhookEvent, LiveKitSIPInboundTrunk, LiveKitSIPOutboundTrunk, LiveKitSIPDispatchRule, LiveKitSIPParticipant, LiveKitAgentDispatch, } from './livekit-types.js';
+export { EGRESS_STATUS, INGRESS_INPUT, INGRESS_STATUS, PARTICIPANT_STATE, SIP_TRANSPORT, TRACK_SOURCE, TRACK_TYPE } from './livekit-data.js';
+import { type TwinPack } from '@volter/world-core';
+export declare const pack: TwinPack;

package/dist/src/index.js

@@ -0,0 +1,53 @@
+export { handleLiveKitTwinRequest } from "./livekit-twin.js";
+export { createLiveKitTwinFetch, createLiveKitTwinServer } from "./livekit-server.js";
+export { liveKitHttpOrigin, liveKitRequestForAction, liveKitTwirpPath, liveLiveKitExecute, pullLiveKitSnapshot, pullLiveKitSIP, pullLiveKitAgentDispatch, pushLiveKitAction, syncLiveKitFromReal, } from "./livekit-connector.js";
+// The client-side rate budget — the fail-closed backstop `liveLiveKitExecute` routes every live
+// request through. The mechanism is the kernel's (`@volter/world-core` -> rateBudget.ts); these are this
+// vendor's numbers and the typed bindings around them.
+export { LIVEKIT_BUDGET_CEILING, LIVEKIT_BUDGET_MAX_RETRY_AFTER_S, LIVEKIT_BUDGET_WINDOW_MS, LIVEKIT_CALL_WEIGHTS, LIVEKIT_RATE_BUDGET, LiveKitBudget, LiveKitBudgetError, liveKitBudgetPath, liveKitCallWeight, } from "./livekit-budget.js";
+export { mintAccessToken, verifyAccessToken } from "./livekit-token.js";
+export { buildWebhookBody, signWebhookHeader, verifyWebhook } from "./livekit-webhook.js";
+export { EGRESS_STATUS, INGRESS_INPUT, INGRESS_STATUS, PARTICIPANT_STATE, SIP_TRANSPORT, TRACK_SOURCE, TRACK_TYPE } from "./livekit-data.js";
+import { registerPack } from '@volter/world-core';
+import { LIVEKIT_RATE_BUDGET as RATE_BUDGET } from "./livekit-budget.js";
+import { performLiveKitAction, syncLiveKitFromRemote } from "./livekit-connector.js";
+export const pack = {
+    // PROTOCOL 2 (docs/contributing/architecture.md#protocol-2-the-pack-is-a-plugin): the pack is a plugin — its wire, its tree, and its half of the real
+    // state system: perform one entry against LiveKit's Twirp RPCs, refresh the root from them. Moved
+    // 2026-09-08.
+    protocol: '2',
+    refresh: { every: '1m', webhook: true, onDemand: { atMost: '10s' } }, // rooms and egresses move fast
+    stateSystem: { perform: performLiveKitAction, refresh: syncLiveKitFromRemote },
+    // the round trip: create a room — LiveKit's CreateRoom answers the existing room when it is already
+    // there, so it repeats cleanly on a branch
+    roundTrip: { method: 'POST', path: '/twirp/livekit.RoomService/CreateRoom', body: { name: 'round-trip' } },
+    parityOrigin: 'http://twin',
+    vendor: 'livekit',
+    // The SAME object livekit-budget.ts declares at module load — one source of truth, so registering
+    // the pack and importing the connector arm identical numbers.
+    rateBudget: RATE_BUDGET,
+    transport: 'rest',
+    archetype: 'crud',
+    bin: 'world-livekit',
+    resources: ['room', 'participant', 'egress', 'ingress', 'sip_inbound_trunk', 'sip_outbound_trunk', 'sip_dispatch_rule', 'sip_participant', 'agent_dispatch'],
+    specSource: 'LiveKit Server APIs: RoomService (incl. Forward/MoveParticipant), Egress, Ingress, SIP (SIPService), and AgentDispatchService Twirp JSON endpoints + AccessToken/WebhookReceiver schemes used by livekit-server-sdk 2.15.x; this pack models the control plane, not the media plane.',
+    description: 'LiveKit control-plane twin — local rooms, participants, egress/ingress lifecycle, access-token grants, and webhook signing for server SDK integrations.',
+    browserRouting: { apiPathPrefix: '/twirp/', loaderHost: 'https://livekit.cloud' },
+    // INTERCEPTION RULING — hostsNone, the pack's own home for it: real local media plane
+    // (livekit-server) exposed via app-read env (LIVEKIT_URL is ws:// — WebSocket media is
+    // outside the HTTP injector's reach).
+    hostsNone: "real local media plane (livekit-server) exposed via app-read env (LIVEKIT_URL is ws:// — WebSocket media is outside the HTTP injector's reach)",
+    // Adoption, moved off the central maps unchanged (descriptor-first back-migration, adding-a-twin.md §3,
+    // 2026-08-31).
+    adoption: {
+        // LiveKit's official Python distributions: the server API client (the counterpart of
+        // `livekit-server-sdk`), the realtime SDK (`@livekit/rtc-node`), and the agents framework whose
+        // core connects to a LiveKit server.
+        pypi: ['livekit-api', 'livekit', 'livekit-agents'],
+        sdks: ['livekit-server-sdk', '@livekit/rtc-node'],
+        scopes: ['@livekit/'],
+        envStems: ['LIVEKIT'],
+    },
+};
+// registered at import: the kernel learns the pack's state system (protocol 2)
+registerPack(pack);

package/dist/src/livekit-budget.d.ts

@@ -0,0 +1,57 @@
+import { RateBudget, type RateBudgetDeclaration, type RateBudgetOptions, type RateBudgetReservation, type RateBudgetSnapshot } from '@volter/world-core';
+/** Rolling window, in ms. Matches LiveKit's own per-MINUTE Server API limit. */
+export declare const LIVEKIT_BUDGET_WINDOW_MS = 60000;
+/** Weighted units allowed inside one window. 200 reads/60s = 20% of the documented 1,000/min. */
+export declare const LIVEKIT_BUDGET_CEILING = 200;
+/** Seconds. A `Retry-After` above this means the project is throttled hard — fail loudly. */
+export declare const LIVEKIT_BUDGET_MAX_RETRY_AFTER_S = 300;
+/**
+ * Per-call cost, keyed by the Twirp RPC id (`"<Service>/<Method>"`) this connector is about to invoke.
+ * A LiveKit call is not a REST path — it is an RPC — so the RPC id is the honest call key.
+ */
+export declare const LIVEKIT_CALL_WEIGHTS: {
+    /** The per-room inner loop: one `ListParticipants` / `ListDispatch` per room. Unbounded fan-out. */
+    readonly perRoomFanOut: 2;
+    /** A flat `List…` / `Get…` read: one call for a whole collection. */
+    readonly read: 1;
+    /** Anything else, including every mutating method. Priced above a read, never free. */
+    readonly other: 2;
+};
+/**
+ * THE PACK'S DECLARATION — pure data, the only LiveKit-specific thing in the whole budget. Rules are
+ * ordered and first-match-wins, and they are keyed on the Twirp RPC id, so the per-room fan-out rules
+ * must come BEFORE the generic list/get rule.
+ *
+ * Also exported as `pack.rateBudget` (see index.ts), so `registerPack` arms it too.
+ */
+export declare const LIVEKIT_RATE_BUDGET: RateBudgetDeclaration;
+/**
+ * Price one call. Keyed off the Twirp RPC the connector is ABOUT to invoke, so an unclassified method
+ * still costs `defaultWeight` — an unknown method must never be free.
+ */
+export declare function liveKitCallWeight(service: string, method: string): number;
+/** Where LiveKit's ledger lives. API-key-keyed and cwd-independent by default (the limit is per
+ *  PROJECT and the API key identifies the project, so a cwd-scoped ledger would hand the same project
+ *  a fresh allowance in every checkout, worktree and CI matrix leg); pass `root` to opt into
+ *  world-scoped accounting instead. */
+export declare function liveKitBudgetPath(opts?: {
+    root?: string;
+    token?: string;
+} | string): string;
+/** Construction options for LiveKit's budget. The vendor is fixed; everything else may only TIGHTEN. */
+export type LiveKitBudgetOptions = Omit<RateBudgetOptions, 'vendor'>;
+/**
+ * LiveKit's budget — the shared kernel guard bound to this vendor's declaration. A real subclass, not
+ * an alias, so `budget instanceof LiveKitBudget` in `liveLiveKitExecute` still means "a budget that
+ * accounts against LIVEKIT's ledger under LIVEKIT's ceiling": another vendor's `RateBudget` (with its
+ * own, possibly larger, ceiling) is NOT assignable there.
+ */
+export declare class LiveKitBudget extends RateBudget {
+    constructor(opts?: LiveKitBudgetOptions);
+}
+/** The typed refusal. One error class shared with every other vendor's budget; `err.vendor` says
+ *  which one refused, and `err.kind` says why. */
+export { RateBudgetError as LiveKitBudgetError } from '@volter/world-core';
+export type { RateBudgetErrorKind as LiveKitBudgetErrorKind } from '@volter/world-core';
+export type LiveKitBudgetReservation = RateBudgetReservation;
+export type LiveKitBudgetSnapshot = RateBudgetSnapshot;