@voltkit-rtc/client 0.6.0 → 0.7.0

package/dist/cjs/errors.d.ts

@@ -0,0 +1,571 @@
+/**
+ * One error registry for every VoltKit SDK (docs/sdk-contract.json): the codes
+ * the controller and the media nodes answer with, passed through unchanged, and
+ * the ones the SDKs raise themselves. Switch on `error.code`, never on the
+ * message.
+ *
+ * Kept as a literal here, since the package cannot read the repository's docs
+ * at runtime, and checked against the contract by
+ * scripts/test/sdk-contract-browser.sh and test/contract.test.mjs. One code per
+ * line, so that check can read it.
+ */
+/** Who raises a code: the server (controller or media node) or the SDK itself. */
+export type ErrorOrigin = 'server' | 'sdk';
+export interface ErrorInfo {
+    origin: ErrorOrigin;
+    /** A join (or reconnect) refused with it must not be retried with the same token. */
+    terminal: boolean;
+    /** Trying the same call again later can succeed. */
+    retryable: boolean;
+}
+export declare const ERROR_CODES: {
+    readonly 'bad-json': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'bad-params': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'unknown-method': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'too-many-requests': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'not-joined': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'already-joined': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly internal: {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'node-error': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'no-token': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'bad-token': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'wrong-tenant': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'token-mismatch': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-room': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'room-ended': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly kicked: {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'no-node': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'no-capacity': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'stage-full': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'participant-quota': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'viewer-quota': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'quota-exhausted': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'daily-limit-reached': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'monthly-limit-reached': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'tenant-suspended': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'billing-unavailable': {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly forbidden: {
+        readonly origin: "server";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'not-in-room': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-participant': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'bad-transport': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-transport': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-producer': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-consumer': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'cannot-consume': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'consumer-cap': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'producer-cap': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'room-cap': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly draining: {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'bad-request': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'source-already-published': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'force-muted': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'media-disabled': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'frame-rate-not-allowed': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'video-quality-not-allowed': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'audio-quality-not-allowed': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'video-not-allowed': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'audio-not-allowed': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'video-subscription-limit': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'slot-taken': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'slot-blocked': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'slot-occupied': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'chat-muted': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'rate-limited': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'no-message': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'chat-unavailable': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly closed: {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly unauthorized: {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'bad-signature': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'operator-only': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'bad-role': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'room-exists': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'room-quota': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'no-nodes': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'capacity-exhausted': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly unavailable: {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'not-found': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'broadcast-disabled': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'chat-disabled': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-stream': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'stream-exists': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'stream-quota': {
+        readonly origin: "server";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly network: {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'rates-unconfigured': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly redirected: {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'not-connected': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly timeout: {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'connect-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly replaced: {
+        readonly origin: "sdk";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'reconnect-gave-up': {
+        readonly origin: "sdk";
+        readonly terminal: true;
+        readonly retryable: false;
+    };
+    readonly 'devices-gone': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly unpublished: {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'frame-rate-fallback': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'codec-fallback': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'quality-unavailable': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-active': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-unsupported': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-no-video': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly disconnected: {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'produce-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'consume-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'media-unavailable': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'music-unavailable': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'no-camera': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'camera-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'unknown-producer': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-denied': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'screen-share-service-required': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-source-required': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-setup-required': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-share-start-timeout': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'screen-share-ended': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'screen-share-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'screen-share-size-unavailable': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: true;
+    };
+    readonly 'screen-audio-unavailable': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'screen-stop-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+    readonly 'degradation-preference-failed': {
+        readonly origin: "sdk";
+        readonly terminal: false;
+        readonly retryable: false;
+    };
+};
+/** Every code in the registry. A newer server may still send one this SDK predates. */
+export type ErrorCode = keyof typeof ERROR_CODES;
+/** The registry entry for a code, or undefined for one this SDK does not know. */
+export declare function errorInfo(code: string): ErrorInfo | undefined;
+/**
+ * Whether reconnecting cannot fix a join refused with this code: a room that
+ * has ended is not coming back, and a token that is wrong will be wrong next
+ * time too. Unknown codes are not terminal, so a newer server's code never
+ * stops a reconnect that could succeed.
+ */
+export declare function isTerminalError(code: string): boolean;
+/**
+ * An error with a machine-readable code: returned by the server (its code
+ * passed through unchanged, known to this SDK or not) or raised by the SDK
+ * itself with a registry code. `data` is what the server attached so the app
+ * can act on a refusal rather than merely report it: `{ slots }` for
+ * `slot-occupied`, for instance.
+ */
+export declare class RpcError extends Error {
+    readonly code: ErrorCode | (string & {});
+    readonly data?: unknown | undefined;
+    constructor(code: ErrorCode | (string & {}), message: string, data?: unknown | undefined);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/cjs/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,kFAAkF;AAClF,MAAM,MAAM,WAAW,GAAG,QAAQ,GAAG,KAAK,CAAC;AAE3C,MAAM,WAAW,SAAS;IACxB,MAAM,EAAE,WAAW,CAAC;IACpB,qFAAqF;IACrF,QAAQ,EAAE,OAAO,CAAC;IAClB,oDAAoD;IACpD,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0GsB,CAAC;AAE/C,uFAAuF;AACvF,MAAM,MAAM,SAAS,GAAG,MAAM,OAAO,WAAW,CAAC;AAEjD,kFAAkF;AAClF,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAErD;AAED;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,KAAK;IACrB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC;IAAmB,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO;gBAAzE,IAAI,EAAE,SAAS,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,EAAW,IAAI,CAAC,EAAE,OAAO,YAAA;CAI/F"}