@ceralive/cerastream 2026.8.1 → 2026.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,6 +8,7 @@ engine's JSON-RPC 2.0 / NDJSON control plane over a Unix domain socket.
8
8
  - The eight v1 control methods (Zod params + result schemas + inferred types)
9
9
  - The nine server-push event payloads (discriminated union)
10
10
  - Two-tier error codes (RPC + runtime)
11
+ - Typed capture-probe causes retained on runtime events and rejected-start exceptions
11
12
  - A unified engine config schema (= `start` params)
12
13
  - A `CerastreamClient` interface + `connect()` factory (UDS transport)
13
14
  - Additive `client.getCapabilities()` discovery for platform, source, encoder, and
package/dist/client.js CHANGED
@@ -183,7 +183,7 @@ class ClientImpl {
183
183
  if (!parsed.success)
184
184
  return;
185
185
  const { id, error } = parsed.data;
186
- const rpcErr = new CerastreamRpcError(error.code, error.message, error.data?.code, id);
186
+ const rpcErr = new CerastreamRpcError(error.code, error.message, error.data?.code, id, error.data);
187
187
  if (id == null)
188
188
  return; // parse error with null id — no request to settle.
189
189
  const pending = this.pending.get(id);
@@ -8,7 +8,7 @@ export declare const PROTOCOL_VERSION: 'cerastream-ipc/1';
8
8
  * additive-only within protocol major `cerastream-ipc/1` (ADR-0002 §4); this value
9
9
  * only moves when the wire schema itself does, in lockstep across both languages.
10
10
  */
11
- export declare const SCHEMA_VERSION: '0.11.0';
11
+ export declare const SCHEMA_VERSION: '0.12.0';
12
12
  /** Runtime dir holding both control + preview sockets. systemd `RuntimeDirectory=cerastream`. */
13
13
  export declare const DEFAULT_IPC_DIR: '/run/cerastream';
14
14
  /** Env override for the IPC dir (tests/dev). Defaults to {@link DEFAULT_IPC_DIR}. */
package/dist/constants.js CHANGED
@@ -11,7 +11,7 @@ export const PROTOCOL_VERSION = 'cerastream-ipc/1';
11
11
  * additive-only within protocol major `cerastream-ipc/1` (ADR-0002 §4); this value
12
12
  * only moves when the wire schema itself does, in lockstep across both languages.
13
13
  */
14
- export const SCHEMA_VERSION = '0.11.0';
14
+ export const SCHEMA_VERSION = '0.12.0';
15
15
  /** Runtime dir holding both control + preview sockets. systemd `RuntimeDirectory=cerastream`. */
16
16
  export const DEFAULT_IPC_DIR = '/run/cerastream';
17
17
  /** Env override for the IPC dir (tests/dev). Defaults to {@link DEFAULT_IPC_DIR}. */
package/dist/errors.d.ts CHANGED
@@ -20,7 +20,11 @@ export declare class CerastreamRpcError extends Error {
20
20
  readonly dataCode: string | undefined;
21
21
  /** The request id this error answered, when present. */
22
22
  readonly requestId: number | string | null;
23
- constructor(code: number, message: string, dataCode: string | undefined, requestId: number | string | null);
23
+ /** Full JSON-RPC `error.data` object, retained for additive typed detail. */
24
+ readonly data?: unknown;
25
+ constructor(code: number, message: string, dataCode: string | undefined, requestId: number | string | null, data?: unknown);
26
+ /** Typed capture-probe failures carried by a rejected stream start. */
27
+ captureCauses(): readonly CaptureCauseEntry[];
24
28
  }
25
29
  /**
26
30
  * Machine-readable classification of a {@link CerastreamConnectionError}, stable
@@ -91,6 +95,21 @@ export declare const processErrorCodeSchema: z.ZodEnum<{
91
95
  srtla_no_connections: "srtla_no_connections";
92
96
  }>;
93
97
  export type ProcessErrorCode = z.infer<typeof processErrorCodeSchema>;
98
+ export declare const captureCauseSchema: z.ZodEnum<{
99
+ device_busy: "device_busy";
100
+ negotiation_failed: "negotiation_failed";
101
+ no_signal: "no_signal";
102
+ }>;
103
+ export type CaptureCause = z.infer<typeof captureCauseSchema>;
104
+ export declare const captureCauseEntrySchema: z.ZodObject<{
105
+ device: z.ZodString;
106
+ cause: z.ZodEnum<{
107
+ device_busy: "device_busy";
108
+ negotiation_failed: "negotiation_failed";
109
+ no_signal: "no_signal";
110
+ }>;
111
+ }, z.core.$strip>;
112
+ export type CaptureCauseEntry = z.infer<typeof captureCauseEntrySchema>;
94
113
  /**
95
114
  * Why a capture device became `capture_unrecoverable` — the `reason` field of the
96
115
  * `error` event. Mirrors the Rust `CaptureUnrecoverableReason`.
package/dist/errors.js CHANGED
@@ -23,12 +23,21 @@ export class CerastreamRpcError extends Error {
23
23
  dataCode;
24
24
  /** The request id this error answered, when present. */
25
25
  requestId;
26
- constructor(code, message, dataCode, requestId) {
26
+ /** Full JSON-RPC `error.data` object, retained for additive typed detail. */
27
+ data;
28
+ constructor(code, message, dataCode, requestId, data) {
27
29
  super(message);
28
30
  this.name = 'CerastreamRpcError';
29
31
  this.code = code;
30
32
  this.dataCode = dataCode;
31
33
  this.requestId = requestId;
34
+ if (data !== undefined)
35
+ this.data = data;
36
+ }
37
+ /** Typed capture-probe failures carried by a rejected stream start. */
38
+ captureCauses() {
39
+ const parsed = rpcCaptureDataSchema.safeParse(this.data);
40
+ return parsed.success ? parsed.data.capture_causes : [];
32
41
  }
33
42
  }
34
43
  /**
@@ -129,6 +138,16 @@ export const processErrorCodeSchema = z.enum([
129
138
  // would be lying. Always carries a captureUnrecoverableReasonSchema `reason`.
130
139
  'capture_unrecoverable',
131
140
  ]);
141
+ export const captureCauseSchema = z.enum(['negotiation_failed', 'no_signal', 'device_busy']);
142
+ export const captureCauseEntrySchema = z.object({
143
+ device: z.string(),
144
+ cause: captureCauseSchema,
145
+ });
146
+ const rpcCaptureDataSchema = z
147
+ .object({
148
+ capture_causes: z.array(captureCauseEntrySchema),
149
+ })
150
+ .passthrough();
132
151
  /**
133
152
  * Why a capture device became `capture_unrecoverable` — the `reason` field of the
134
153
  * `error` event. Mirrors the Rust `CaptureUnrecoverableReason`.
package/dist/events.d.ts CHANGED
@@ -239,6 +239,11 @@ export declare const runtimeErrorEventSchema: z.ZodObject<{
239
239
  }>;
240
240
  reason: z.ZodOptional<z.ZodString>;
241
241
  selected: z.ZodOptional<z.ZodBoolean>;
242
+ capture_cause: z.ZodOptional<z.ZodEnum<{
243
+ device_busy: "device_busy";
244
+ negotiation_failed: "negotiation_failed";
245
+ no_signal: "no_signal";
246
+ }>>;
242
247
  }, z.core.$strip>;
243
248
  /** Payload of a {@link runtimeErrorEventSchema} event. */
244
249
  export type RuntimeErrorEvent = z.infer<typeof runtimeErrorEventSchema>;
@@ -457,6 +462,11 @@ export declare const eventParamsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
457
462
  }>;
458
463
  reason: z.ZodOptional<z.ZodString>;
459
464
  selected: z.ZodOptional<z.ZodBoolean>;
465
+ capture_cause: z.ZodOptional<z.ZodEnum<{
466
+ device_busy: "device_busy";
467
+ negotiation_failed: "negotiation_failed";
468
+ no_signal: "no_signal";
469
+ }>>;
460
470
  }, z.core.$strip>, z.ZodObject<{
461
471
  type: z.ZodLiteral<"preview">;
462
472
  seq: z.ZodNumber;
@@ -649,6 +659,11 @@ export declare const cerastreamEventSchema: z.ZodObject<{
649
659
  }>;
650
660
  reason: z.ZodOptional<z.ZodString>;
651
661
  selected: z.ZodOptional<z.ZodBoolean>;
662
+ capture_cause: z.ZodOptional<z.ZodEnum<{
663
+ device_busy: "device_busy";
664
+ negotiation_failed: "negotiation_failed";
665
+ no_signal: "no_signal";
666
+ }>>;
652
667
  }, z.core.$strip>, z.ZodObject<{
653
668
  type: z.ZodLiteral<"preview">;
654
669
  seq: z.ZodNumber;
@@ -850,6 +865,11 @@ export declare const eventSchemas: {
850
865
  }>;
851
866
  reason: z.ZodOptional<z.ZodString>;
852
867
  selected: z.ZodOptional<z.ZodBoolean>;
868
+ capture_cause: z.ZodOptional<z.ZodEnum<{
869
+ device_busy: "device_busy";
870
+ negotiation_failed: "negotiation_failed";
871
+ no_signal: "no_signal";
872
+ }>>;
853
873
  }, z.core.$strip>;
854
874
  readonly preview: z.ZodObject<{
855
875
  type: z.ZodLiteral<"preview">;
package/dist/events.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { z } from 'zod';
2
- import { processErrorCodeSchema, processErrorSourceSchema } from './errors.js';
2
+ import { captureCauseSchema, processErrorCodeSchema, processErrorSourceSchema } from './errors.js';
3
3
  import { captureDeviceSchema, configChangePhaseSchema, inputModeSchema, mediaClassSchema, previewEncodeFallbackSchema, previewEncodeModeSchema, streamStateSchema, } from './types.js';
4
4
  // Server → client `event` notifications, delivered after `subscribe-events`
5
5
  // (schema.md "Events"). Each event is the inner `params` of an rpcEventSchema:
@@ -119,6 +119,8 @@ export const runtimeErrorEventSchema = z.object({
119
119
  source: processErrorSourceSchema,
120
120
  reason: z.string().optional(), // structured replacement for the stderr <reason>
121
121
  selected: z.boolean().optional(), // additive (0.11.0): the degraded input is the operator's OWN selection, so the stream will not move itself and only they can pick another — a materially different operator response than a degraded non-selected input, and one to branch on rather than string-match. Absent ⇒ false
122
+ // The code stays capture_video_error because older consumers reject unknown code values.
123
+ capture_cause: captureCauseSchema.optional(),
122
124
  });
123
125
  /** `preview` event — a preview-session lifecycle/phase change. */
124
126
  export const previewEventSchema = z.object({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ceralive/cerastream",
3
- "version": "2026.8.1",
3
+ "version": "2026.9.0",
4
4
  "description": "Type-safe TypeScript schema + IPC client for the cerastream streaming engine (JSON-RPC 2.0 / NDJSON over a Unix domain socket).",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",