@synnaxlabs/client 0.42.3 → 0.43.0

package/src/client.ts

@@ -10,7 +10,7 @@
 import { breaker } from "@synnaxlabs/x";
 import { TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
 import { URL } from "@synnaxlabs/x/url";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 import { access } from "@/access";
 import { auth } from "@/auth";
@@ -40,11 +40,11 @@ export const synnaxPropsZ = z.object({
   connectivityPollFrequency: TimeSpan.z.default(TimeSpan.seconds(30)),
   secure: z.boolean().optional().default(false),
   name: z.string().optional(),
-  retry: breaker.breakerConfig.optional(),
+  retry: breaker.breakerConfigZ.optional(),
 });
 
 export interface SynnaxProps extends z.input<typeof synnaxPropsZ> {}
-export interface ParsedSynnaxProps extends z.output<typeof synnaxPropsZ> {}
+export interface ParsedSynnaxProps extends z.infer<typeof synnaxPropsZ> {}
 
 /**
  * Client to perform operations against a Synnax cluster.

package/src/connection/checker.ts

@@ -10,7 +10,7 @@
 import type { UnaryClient } from "@synnaxlabs/freighter";
 import { migrate } from "@synnaxlabs/x";
 import { TimeSpan } from "@synnaxlabs/x/telem";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 export const statusZ = z.enum(["disconnected", "connecting", "connected", "failed"]);
 export type Status = z.infer<typeof statusZ>;

package/src/connection/connection.spec.ts

@@ -9,7 +9,7 @@
 
 import { URL } from "@synnaxlabs/x/url";
 import { describe, expect, it } from "vitest";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 import { auth } from "@/auth";
 import { connection } from "@/connection";

package/src/control/client.ts

@@ -21,7 +21,7 @@ export class Client {
 
   async openStateTracker(): Promise<StateTracker> {
     const stream = await framer.HardenedStreamer.open(
-      async () => await this.framer.openStreamer(CONTROL_STATE_KEY),
+      async (p) => await this.framer.openStreamer(p),
       CONTROL_STATE_KEY,
     );
     return new StateTracker(stream);

package/src/control/state.ts

@@ -10,9 +10,10 @@
 import { control } from "@synnaxlabs/x";
 import { binary } from "@synnaxlabs/x/binary";
 import { type observe } from "@synnaxlabs/x/observe";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 import { type channel } from "@/channel";
+import { keyZ } from "@/channel/payload";
 import { framer } from "@/framer";
 
 export type Authority = control.Authority;
@@ -35,12 +36,10 @@ export const transferString = (t: Transfer): string => {
 };
 
 const updateZ = z.object({
-  transfers: z.array(control.transferZ),
+  transfers: z.array(control.transferZ(keyZ)),
 });
 
-interface Update {
-  transfers: control.Transfer<channel.Key>[];
-}
+export interface Update extends z.infer<typeof updateZ> {}
 
 export class StateTracker
   extends framer.ObservableStreamer<Transfer[]>

package/src/errors.spec.ts

@@ -7,8 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type errors, id } from "@synnaxlabs/x";
-import { v4 as uuid } from "uuid";
+import { type errors, id, uuid } from "@synnaxlabs/x";
 import { describe, expect, test } from "vitest";
 
 import {
@@ -61,7 +60,7 @@ test("client", async () => {
     expect(NotFoundError.matches(e)).toBe(true);
   }
   try {
-    await client.workspaces.schematic.retrieve(uuid());
+    await client.workspaces.schematic.retrieve(uuid.create());
   } catch (e) {
     expect(NotFoundError.matches(e)).toBe(true);
   }

package/src/errors.ts

@@ -36,9 +36,9 @@ export class AuthError extends SynnaxError.sub("auth") {}
 /**
  * InvalidTokenError is raised when an authentication token is invalid.
  */
-export class InvalidTokenError extends AuthError.sub("invalid-token") {}
+export class InvalidTokenError extends AuthError.sub("invalid_token") {}
 
-export class ExpiredTokenError extends AuthError.sub("expired-token") {}
+export class ExpiredTokenError extends AuthError.sub("expired_token") {}
 
 /**
  * UnexpectedError is raised when an unexpected error occurs.

package/src/framer/adapter.ts

@@ -12,7 +12,7 @@ import { type CrudeSeries, Series } from "@synnaxlabs/x/telem";
 import { channel } from "@/channel";
 import { ValidationError } from "@/errors";
 import { Codec } from "@/framer/codec";
-import { type Crude, Frame } from "@/framer/frame";
+import { type CrudeFrame, Frame } from "@/framer/frame";
 
 export class ReadAdapter {
   private adapter: Map<channel.Key, channel.Name> | null;
@@ -133,7 +133,7 @@ export class WriteAdapter {
   }
 
   async adapt(
-    columnsOrData: channel.Params | Record<channel.KeyOrName, CrudeSeries> | Crude,
+    columnsOrData: channel.Params | Record<channel.KeyOrName, CrudeSeries> | CrudeFrame,
     series?: CrudeSeries | CrudeSeries[],
   ): Promise<Frame> {
     if (typeof columnsOrData === "string" || typeof columnsOrData === "number") {

package/src/framer/client.ts

@@ -108,6 +108,9 @@ export class Client {
    * and then will start reading new values.
    *
    */
+  async openStreamer(config: StreamerConfig): Promise<Streamer>;
+
+  /** Overload to provide interface compatibility with @see StreamOpener */
   async openStreamer(config: StreamerConfig | channel.Params): Promise<Streamer>;
 
   async openStreamer(config: StreamerConfig | channel.Params): Promise<Streamer> {
@@ -160,9 +163,7 @@ export class Client {
         autoIndexPersistInterval: TimeSpan.MAX,
       });
       await w.write(data_);
-      await w.commit();
-      await w.close();
-      return;
+      return await w.close();
     }
     const w = await this.openWriter({
       start,

package/src/framer/codec.spec.ts

@@ -269,7 +269,7 @@ describe("encoder", () => {
   });
 
   describe("websocket writer codec", () => {
-    it("should correctly e + d a websocket write request", () => {
+    it("should correctly encode and decode a websocket write request", () => {
       const baseCodec = new Codec([1], [DataType.INT32]);
       const fr = new framer.Frame([1], [new Series(new Int32Array([1, 2, 3]))]);
       const writeReq: WriteRequest = {
@@ -280,7 +280,7 @@ describe("encoder", () => {
       const codec = new WSWriterCodec(baseCodec);
       const encoded = codec.encode(msg);
       expect(encoded[0]).toEqual(HIGH_PERF_SPECIAL_CHAR);
-      const decoded = codec.decode<WebsocketMessage<WriteRequest>>(encoded);
+      const decoded = codec.decode(encoded) as WebsocketMessage<WriteRequest>;
       expect(decoded.payload?.command).toEqual(WriterCommand.Write);
       const decodedFr = new Frame(decoded.payload?.frame);
       expect(decodedFr.series[0].data).toEqual(fr.series[0].data);

package/src/framer/codec.ts

@@ -15,7 +15,7 @@ import {
   TimeRange,
   TimeStamp,
 } from "@synnaxlabs/x";
-import { type ZodSchema } from "zod";
+import { type z } from "zod/v4";
 
 import { type channel } from "@/channel";
 import { ValidationError } from "@/errors";
@@ -23,10 +23,6 @@ import { type Frame, type Payload } from "@/framer/frame";
 import { type StreamerResponse } from "@/framer/streamer";
 import { WriterCommand, type WriteRequest } from "@/framer/writer";
 
-// For detailed information about the specifications,
-// please refer to the official RFC 0016 document.
-// Document here: docs/tech/rfc/0016-231001-frame-flight-protocol.md
-
 const seriesPldLength = (series: SeriesPayload): number =>
   series.data.byteLength / series.dataType.density.valueOf();
 
@@ -356,7 +352,7 @@ export class WSWriterCodec implements binary.Codec {
     return data;
   }
 
-  decode<P>(data: Uint8Array | ArrayBuffer, schema?: ZodSchema<P>): P {
+  decode<P extends z.ZodType>(data: Uint8Array | ArrayBuffer, schema?: P): z.infer<P> {
     const dv = new DataView(data instanceof Uint8Array ? data.buffer : data);
     const codec = dv.getUint8(0);
     if (codec === LOW_PER_SPECIAL_CHAR)
@@ -364,7 +360,7 @@ export class WSWriterCodec implements binary.Codec {
     const v: WebsocketMessage<WriteRequest> = { type: "data" };
     const frame = this.base.decode(data, 1);
     v.payload = { command: WriterCommand.Write, frame };
-    return v as P;
+    return v as z.infer<P>;
   }
 }
 
@@ -382,7 +378,7 @@ export class WSStreamerCodec implements binary.Codec {
     return this.lowPerfCodec.encode(payload);
   }
 
-  decode<P>(data: Uint8Array | ArrayBuffer, schema?: ZodSchema<P>): P {
+  decode<P extends z.ZodType>(data: Uint8Array | ArrayBuffer, schema?: P): z.infer<P> {
     const dv = new DataView(data instanceof Uint8Array ? data.buffer : data);
     const codec = dv.getUint8(0);
     if (codec === LOW_PER_SPECIAL_CHAR)
@@ -391,6 +387,6 @@ export class WSStreamerCodec implements binary.Codec {
       type: "data",
       payload: { frame: this.base.decode(data, 1) },
     };
-    return v as P;
+    return v as z.infer<P>;
   }
 }

package/src/framer/deleter.spec.ts

@@ -12,7 +12,7 @@ import { describe, expect, test } from "vitest";
 
 import { NotFoundError, UnauthorizedError } from "@/errors";
 import { newClient } from "@/setupspecs";
-import { newIndexedPair } from "@/testutil/indexedPair";
+import { newIndexedPair } from "@/testutil/channels";
 import { secondsLinspace } from "@/testutil/telem";
 import { randomSeries } from "@/util/telem";
 

package/src/framer/deleter.ts

@@ -9,7 +9,7 @@
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { TimeRange } from "@synnaxlabs/x";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 import { channel } from "@/channel";
 

package/src/framer/frame.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { toArray, unique } from "@synnaxlabs/x";
+import { array, unique } from "@synnaxlabs/x";
 import {
   MultiSeries,
   Series,
@@ -18,7 +18,7 @@ import {
   TimeRange,
   TimeStamp,
 } from "@synnaxlabs/x/telem";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 import { type channel } from "@/channel";
 import { UnexpectedError, ValidationError } from "@/errors";
@@ -31,7 +31,7 @@ type ColumnType = "key" | "name" | null;
 export interface Digest extends Record<channel.KeyOrName, SeriesDigest[]> {}
 
 const columnType = (columns: channel.PrimitiveParams): ColumnType => {
-  const arrKeys = toArray(columns);
+  const arrKeys = array.toArray(columns);
   if (arrKeys.length === 0) return null;
   if (typeof arrKeys[0] === "number") return "key";
   if (!isNaN(parseInt(arrKeys[0]))) return "key";
@@ -42,7 +42,7 @@ const validateMatchedColsAndSeries = (
   columns: channel.PrimitiveParams,
   series: Series[],
 ): void => {
-  const colsArr = toArray(columns);
+  const colsArr = array.toArray(columns);
   if (colsArr.length === series.length) return;
   const colType = columnType(columns);
   if (columnType === null)
@@ -55,7 +55,7 @@ const validateMatchedColsAndSeries = (
   );
 };
 
-export type Crude =
+export type CrudeFrame =
   | Frame
   | CrudePayload
   | Map<channel.KeyOrName, Series[] | Series>
@@ -101,7 +101,7 @@ export class Frame {
   readonly series: Series[] = [];
 
   constructor(
-    columnsOrData: channel.PrimitiveParams | Crude = [],
+    columnsOrData: channel.PrimitiveParams | CrudeFrame = [],
     series: Series | Series[] = [],
   ) {
     if (columnsOrData instanceof Frame) {
@@ -112,7 +112,7 @@ export class Frame {
 
     // Construction from a map.
     if (columnsOrData instanceof Map) {
-      columnsOrData.forEach((v, k) => this.push(k, ...toArray(v)));
+      columnsOrData.forEach((v, k) => this.push(k, ...array.toArray(v)));
       return;
     }
 
@@ -130,8 +130,8 @@ export class Frame {
       } else
         Object.entries(columnsOrData).forEach(([k, v]) => {
           const key = parseInt(k);
-          if (!isNaN(key)) return this.push(key, ...toArray(v));
-          this.push(k, ...toArray(v));
+          if (!isNaN(key)) return this.push(key, ...array.toArray(v));
+          this.push(k, ...array.toArray(v));
         });
       return;
     }
@@ -141,8 +141,8 @@ export class Frame {
       Array.isArray(columnsOrData) ||
       ["string", "number"].includes(typeof columnsOrData)
     ) {
-      const data_ = toArray(series);
-      const cols = toArray(columnsOrData) as channel.Keys | channel.Names;
+      const data_ = array.toArray(series);
+      const cols = array.toArray(columnsOrData) as channel.Keys | channel.Names;
       validateMatchedColsAndSeries(cols, data_);
       data_.forEach((d, i) => this.push(cols[i], d));
       return;
@@ -429,7 +429,7 @@ export class Frame {
     let str = `Frame{\n`;
     this.uniqueColumns.forEach((c) => {
       str += `  ${c}: ${this.get(c)
-        .series.map((c) => c.toString())
+        .series.map((s) => s.toString())
         .join(",")}\n`;
     });
     str += "}";
@@ -439,16 +439,16 @@ export class Frame {
 
 export const frameZ = z.object({
   keys: z.union([
-    z.null().transform(() => [] as number[]),
+    z.null().transform<number[]>(() => []),
     z.number().array().optional().default([]),
   ]),
   series: z.union([
-    z.null().transform(() => [] as Array<z.infer<typeof Series.crudeZ>>),
+    z.null().transform<z.infer<typeof Series.crudeZ>[]>(() => []),
     Series.crudeZ.array().optional().default([]),
   ]),
 });
 
-export interface Payload extends z.output<typeof frameZ> {}
+export interface Payload extends z.infer<typeof frameZ> {}
 
 export interface CrudePayload extends z.input<typeof frameZ> {}
 

package/src/framer/iterator.spec.ts

@@ -12,7 +12,7 @@ import { describe, expect, test } from "vitest";
 
 import { AUTO_SPAN } from "@/framer/iterator";
 import { newClient } from "@/setupspecs";
-import { newIndexedPair } from "@/testutil/indexedPair";
+import { newIndexedPair } from "@/testutil/channels";
 import { secondsLinspace } from "@/testutil/telem";
 import { randomSeries } from "@/util/telem";
 

package/src/framer/iterator.ts

@@ -17,7 +17,7 @@ import {
   TimeSpan,
   TimeStamp,
 } from "@synnaxlabs/x/telem";
-import { z } from "zod";
+import { z } from "zod/v4";
 
 import { channel } from "@/channel";
 import { ReadAdapter } from "@/framer/adapter";

package/src/framer/streamProxy.ts

@@ -8,9 +8,9 @@
 // included in the file licenses/APL.txt.
 
 import { EOF, type Stream } from "@synnaxlabs/freighter";
-import { type z } from "zod";
+import { type z } from "zod/v4";
 
-export class StreamProxy<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny> {
+export class StreamProxy<RQ extends z.ZodType, RS extends z.ZodType> {
   readonly name: string;
   private readonly stream: Stream<RQ, RS>;
 
@@ -19,7 +19,7 @@ export class StreamProxy<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny> {
     this.name = name;
   }
 
-  async receive(): Promise<z.output<RS>> {
+  async receive(): Promise<z.infer<RS>> {
     const [res, err] = await this.stream.receive();
     if (err != null) throw err;
     return res;
@@ -35,7 +35,7 @@ export class StreamProxy<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny> {
       const [res, err] = await this.stream.receive();
       if (res != null)
         console.warn(
-          `${this.name} received unexpected response on closure.
+          `${this.name} received unexpected response on ${JSON.stringify(res)} closure.
         Please report this error to the Synnax team.`,
         );
       if (err != null) {