@synnaxlabs/client 0.49.2 → 0.50.0

package/src/framer/reader.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -13,13 +13,14 @@ import { type CrudeTimeRange, csv, runtime } from "@synnaxlabs/x";
 import { type channel } from "@/channel";
 import { UnexpectedError } from "@/errors";
 import { type Frame } from "@/framer/frame";
-import { Iterator } from "@/framer/iterator";
+import { Iterator, type IteratorConfig } from "@/framer/iterator";
 
 export interface ReadRequest {
   channels: channel.Params;
   timeRange: CrudeTimeRange;
-  channelNames?: Map<channel.KeyOrName, string>;
+  channelNames?: Record<channel.KeyOrName, string>;
   responseType: "csv";
+  iteratorConfig?: IteratorConfig;
 }
 
 export class Reader {
@@ -32,7 +33,12 @@ export class Reader {
   }
 
   async read(request: ReadRequest): Promise<ReadableStream<Uint8Array>> {
-    const { channels: channelParams, timeRange, channelNames } = request;
+    const {
+      channels: channelParams,
+      timeRange,
+      channelNames,
+      iteratorConfig,
+    } = request;
     const channelPayloads = await this.retriever.retrieve(channelParams);
     const allKeys = new Set<channel.Key>();
     channelPayloads.forEach((ch) => {
@@ -51,6 +57,7 @@ export class Reader {
       Array.from(allKeys),
       this.retriever,
       this.streamClient,
+      iteratorConfig,
     );
     return createCSVReadableStream({
       iterator,
@@ -63,7 +70,7 @@ export class Reader {
 interface CreateCSVExportStreamParams {
   iterator: Iterator;
   channelPayloads: channel.Payload[];
-  headers?: Map<channel.KeyOrName, string>;
+  headers?: Record<channel.KeyOrName, string>;
 }
 
 const createCSVReadableStream = ({
@@ -219,7 +226,7 @@ interface ColumnMetaResult {
 const buildColumnMeta = (
   channels: channel.Payload[],
   groups: Map<channel.Key, channel.Keys>,
-  headers?: Map<channel.KeyOrName, string>,
+  headers?: Record<channel.KeyOrName, string>,
 ): ColumnMetaResult => {
   const channelMap = new Map(channels.map((ch) => [ch.key, ch]));
   const columns: ColumnMeta[] = [];
@@ -233,7 +240,7 @@ const buildColumnMeta = (
       if (ch == null) throw new UnexpectedError(`Channel ${key} not found`);
       const meta: ColumnMeta = {
         key,
-        header: headers?.get(key) ?? headers?.get(ch.name) ?? ch.name,
+        header: headers?.[key] ?? headers?.[ch.name] ?? ch.name,
       };
       columns.push(meta);
       groupColumns.push(meta);

package/src/framer/streamProxy.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/streamer.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -389,7 +389,6 @@ describe("Streamer", () => {
             dataType: DataType.FLOAT64,
             virtual: true,
             expression: `return ${channelA.name} + ${channelB.name}`,
-            requires: [channelA.key, channelB.key],
           });
 
           const streamer = await client.openStreamer(calcChannel.key);

package/src/framer/streamer.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -74,7 +74,7 @@ type ParsedStreamerConfig = z.output<typeof streamerConfigZ>;
  * resources. We recommend using the streamer within a try-finally block to ensure
  * that it is closed properly in the event of an error.
  *
- * For details documentation, see https://docs.synnaxlabs.com/reference/typescript-client/stream-data
+ * For detailed documentation, see https://docs.synnaxlabs.com/reference/client/working-with-data/streaming-data
  */
 export interface Streamer extends AsyncIterator<Frame>, AsyncIterable<Frame> {
   /** The keys of the channels currently being streamed from. */
@@ -111,7 +111,7 @@ export const createStreamOpener =
     if (cfg.useHighPerformanceCodec)
       client = client.withCodec(new WSStreamerCodec(adapter.codec));
     const stream = await client.stream("/frame/stream", reqZ, resZ);
-    const streamer = new CoreStreamer(
+    const streamer = new BaseStreamer(
       stream,
       adapter,
       cfg.downsampleFactor,
@@ -140,7 +140,7 @@ export const openStreamer = async (
   config: StreamerConfig,
 ): Promise<Streamer> => await createStreamOpener(retriever, client)(config);
 
-class CoreStreamer implements Streamer {
+class BaseStreamer implements Streamer {
   private readonly stream: StreamProxy<typeof reqZ, typeof resZ>;
   private readonly adapter: ReadAdapter;
   private readonly downsampleFactor: number;

package/src/framer/writer.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/framer/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -45,6 +45,7 @@ export { task } from "@/task";
 export { createTestClientWithPolicy } from "@/testutil/access";
 export { createTestClient, TEST_CLIENT_PARAMS } from "@/testutil/client";
 export { user } from "@/user";
+export { view } from "@/view";
 export { workspace } from "@/workspace";
 export { lineplot } from "@/workspace/lineplot";
 export { log } from "@/workspace/log";

package/src/label/access.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/label.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -37,15 +37,14 @@ const retrieveReqZ = z.object({
 });
 export interface RetrieveRequest extends z.infer<typeof retrieveReqZ> {}
 
-export interface RetrieveOptions
-  extends Pick<
-    RetrieveRequest,
-    "excludeFieldData" | "types" | "children" | "parents"
-  > {}
+export interface RetrieveOptions extends Pick<
+  RetrieveRequest,
+  "excludeFieldData" | "types" | "children" | "parents"
+> {}
 
 const retrieveResZ = z.object({ resources: resourceZ.array() });
 
-/** The core client class for executing queries against a Synnax cluster ontology */
+/** The main client class for executing queries against a Synnax cluster ontology */
 export class Client {
   readonly type: string = "ontology";
   groups: group.Client;

package/src/ontology/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/access.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/group.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/ontology.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -43,6 +43,7 @@ export const resourceTypeZ = z.enum([
   "arc",
   "schematic_symbol",
   "status",
+  "view",
 ]);
 export type ResourceType = z.infer<typeof resourceTypeZ>;
 
@@ -103,8 +104,10 @@ export const resourceZ = z
     data: record.unknownZ.optional().nullable(),
   })
   .transform((resource) => ({ key: idToString(resource.id), ...resource }));
-export interface Resource<T extends record.Unknown = record.Unknown>
-  extends Omit<z.infer<typeof resourceZ>, "data"> {
+export interface Resource<T extends record.Unknown = record.Unknown> extends Omit<
+  z.infer<typeof resourceZ>,
+  "data"
+> {
   data?: T | null;
 }
 

package/src/ontology/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/rack/access.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/rack/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/rack/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/rack/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/rack/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/rack/rack.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/access.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/alias.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/kv.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/ranger.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/status/access.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/status/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/status/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/status/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/status/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/status/status.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/task/access.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/task/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -66,11 +66,15 @@ export interface TaskExecuteCommandSyncParams extends TaskExecuteCommandParams {
   timeout?: CrudeTimeSpan;
 }
 
-export interface ExecuteCommandsSyncParams<StatusData extends z.ZodType>
-  extends Omit<ExecuteCommandsSyncInternalParams<StatusData>, "frameClient" | "name"> {}
+export interface ExecuteCommandsSyncParams<StatusData extends z.ZodType> extends Omit<
+  ExecuteCommandsSyncInternalParams<StatusData>,
+  "frameClient" | "name"
+> {}
 
-export interface ExecuteCommandSyncParams<StatusData extends z.ZodType>
-  extends Omit<ExecuteCommandSyncInternalParams<StatusData>, "frameClient" | "name"> {}
+export interface ExecuteCommandSyncParams<StatusData extends z.ZodType> extends Omit<
+  ExecuteCommandSyncInternalParams<StatusData>,
+  "frameClient" | "name"
+> {}
 
 export class Task<
   Type extends z.ZodLiteral<string> = z.ZodLiteral<string>,
@@ -558,7 +562,8 @@ const executeCommands = async ({
 };
 
 interface ExecuteCommandSyncInternalParams<StatusData extends z.ZodType = z.ZodType>
-  extends Omit<ExecuteCommandsSyncInternalParams<StatusData>, "commands">,
+  extends
+    Omit<ExecuteCommandsSyncInternalParams<StatusData>, "commands">,
     TaskExecuteCommandSyncParams {
   task: Key;
 }

package/src/task/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/task/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2025 Synnax Labs, Inc.
+// Copyright 2026 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.