@synnaxlabs/client 0.22.0 → 0.23.0

package/src/channel/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -27,6 +27,7 @@ export const payload = z.object({
   leaseholder: z.number(),
   index: z.number(),
   isIndex: z.boolean(),
+  internal: z.boolean(),
   alias: z.string().optional(),
 });
 
@@ -38,6 +39,7 @@ export const newPayload = payload.extend({
   index: z.number().optional(),
   rate: Rate.z.optional().default(0),
   isIndex: z.boolean().optional(),
+  internal: z.boolean().optional().default(false),
   virtual: z.boolean().optional().default(false),
 });
 

package/src/channel/retriever.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -22,7 +22,7 @@ import {
   payload,
 } from "@/channel/payload";
 import { QueryError } from "@/errors";
-import { type ParamAnalysisResult, analyzeParams } from "@/util/retrieve";
+import { analyzeParams, type ParamAnalysisResult } from "@/util/retrieve";
 import { nullableArrayZ } from "@/util/zod";
 
 const reqZ = z.object({
@@ -76,7 +76,9 @@ export class ClusterRetriever implements Retriever {
   }
 
   async retrieve(channels: Params, options?: RetrieveOptions): Promise<Payload[]> {
-    let { variant, normalized } = analyzeChannelParams(channels);
+    const res = analyzeChannelParams(channels);
+    const { variant } = res;
+    let { normalized } = res;
     if (variant === "keys" && (normalized as Key[]).indexOf(0) !== -1)
       normalized = (normalized as Key[]).filter((k) => k !== 0);
     if (normalized.length === 0) return [];
@@ -185,7 +187,7 @@ export class DebouncedBatchRetriever implements Retriever {
     const { normalized, variant } = analyzeChannelParams(channels);
     // Bypass on name fetches for now.
     if (variant === "names") return await this.wrapped.retrieve(normalized);
-    // eslint-disable-next-line @typescript-eslint/promise-function-async
+
     const a = new Promise<Payload[]>((resolve, reject) => {
       void this.mu.runExclusive(() => {
         this.requests.set(normalized as Key[], { resolve, reject });

package/src/channel/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -11,11 +11,12 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import {
+  Key,
+  keyZ,
+  type NewPayload,
+  newPayload,
   type Payload,
   payload,
-  newPayload,
-  type NewPayload,
-  keyZ,
 } from "@/channel/payload";
 
 const createReqZ = z.object({ channels: newPayload.array() });
@@ -27,10 +28,18 @@ const deleteReqZ = z.object({
 });
 const deleteResZ = z.object({});
 
+const renameReqZ = z.object({
+  keys: keyZ.array(),
+  names: z.string().array(),
+});
+const renameResZ = z.object({});
+
 const CREATE_ENDPOINT = "/channel/create";
 const DELETE_ENDPOINT = "/channel/delete";
+const RENAME_ENDPOINT = "/channel/rename";
 
 export type DeleteProps = z.input<typeof deleteReqZ>;
+export type RenameProps = z.input<typeof renameReqZ>;
 
 export class Writer {
   private readonly client: UnaryClient;
@@ -60,4 +69,14 @@ export class Writer {
       deleteResZ,
     );
   }
+
+  async rename(keys: Key[], names: string[]): Promise<void> {
+    await sendRequired<typeof renameReqZ, typeof renameResZ>(
+      this.client,
+      RENAME_ENDPOINT,
+      { keys, names },
+      renameReqZ,
+      renameResZ,
+    );
+  }
 }

package/src/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -14,6 +14,7 @@ import { z } from "zod";
 import { auth } from "@/auth";
 import { channel } from "@/channel";
 import { connection } from "@/connection";
+import { control } from "@/control";
 import { errorsMiddleware } from "@/errors";
 import { framer } from "@/framer";
 import { hardware } from "@/hardware";
@@ -59,7 +60,6 @@ export type ParsedSynnaxProps = z.output<typeof synnaxPropsZ>;
  * @property connectivity - Client for retrieving connectivity information.
  * @property ontology - Client for querying the cluster's ontology.
  */
-// eslint-disable-next-line import/no-default-export
 export default class Synnax extends framer.Client {
   readonly createdAt: TimeStamp;
   readonly props: ParsedSynnaxProps;
@@ -71,6 +71,7 @@ export default class Synnax extends framer.Client {
   readonly workspaces: workspace.Client;
   readonly labels: label.Client;
   readonly hardware: hardware.Client;
+  readonly control: control.Client;
   static readonly connectivity = connection.Checker;
   private readonly transport: Transport;
 
@@ -106,7 +107,7 @@ export default class Synnax extends framer.Client {
       new channel.ClusterRetriever(transport.unary),
     );
     const chCreator = new channel.Writer(transport.unary);
-    super(transport.stream, chRetriever);
+    super(transport.stream, transport.unary, chRetriever);
     this.createdAt = TimeStamp.now();
     this.props = props;
     this.auth = auth_;
@@ -117,6 +118,7 @@ export default class Synnax extends framer.Client {
       connectivityPollFrequency,
       props.name,
     );
+    this.control = new control.Client(this);
     this.ontology = new ontology.Client(transport.unary, this);
     const rangeWriter = new ranger.Writer(this.transport.unary);
     this.labels = new label.Client(this.transport.unary, this);

package/src/connection/checker.ts

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

package/src/connection/connection.spec.ts

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

package/src/connection/index.ts

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

package/src/control/client.ts

@@ -0,0 +1,17 @@
+import { StateTracker } from "@/control/state";
+import { framer } from "@/framer";
+
+const CONTROL_STATE_KEY = "sy_node_1_control";
+
+export class Client {
+  private readonly framer: framer.Client;
+
+  constructor(framer: framer.Client) {
+    this.framer = framer;
+  }
+
+  async openStateTracker(): Promise<StateTracker> {
+    const stream = await this.framer.openStreamer(CONTROL_STATE_KEY);
+    return new StateTracker(stream);
+  }
+}

package/src/control/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,5 +7,5 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export * from "@/control/authority";
+export * from "@/control/client";
 export * from "@/control/state";

package/src/control/index.ts

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

package/src/control/state.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -9,14 +9,13 @@
 
 import { describe, expect, it } from "vitest";
 
-import { control } from "@/control";
 import { newClient } from "@/setupspecs";
 
 const client = newClient();
 
 describe("state", () => {
   it("should receive the initial control state from the cluster", async () => {
-    const s = await control.StateTracker.open(client);
+    const s = await client.control.openStateTracker();
     await new Promise((resolve) => setTimeout(resolve, 50));
     expect(s.states.size).toBeGreaterThan(0);
     await s.close();

package/src/control/state.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,65 +7,21 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
+import { control } from "@synnaxlabs/x";
 import { binary } from "@synnaxlabs/x/binary";
-import { type Destructor } from "@synnaxlabs/x/destructor";
 import { observe } from "@synnaxlabs/x/observe";
 import { z } from "zod";
 
 import { type Key as ChannelKey } from "@/channel/payload";
-import { Authority } from "@/control/authority";
-import { type Client as FrameClient } from "@/framer/client";
+import { framer } from "@/framer";
 import { type Streamer as FrameStreamer } from "@/framer/streamer";
 
-export const subjectZ = z.object({
-  name: z.string(),
-  key: z.string(),
-});
-
-export interface Subject {
-  name: string;
-  key: string;
-}
-
-export const stateZ = z.object({
-  subject: subjectZ,
-  resource: z.number(),
-  authority: Authority.z,
-});
-
-export interface State {
-  subject: Subject;
-  resource: ChannelKey;
-  authority: Authority;
-}
-
-export const filterTransfersByChannelKey =
-  (...resources: ChannelKey[]) =>
-  (transfers: Transfer[]): Transfer[] =>
-    transfers.filter((t) => {
-      let ok = false;
-      if (t.to != null) ok = resources.includes(t.to.resource);
-      if (t.from != null && !ok) ok = resources.includes(t.from.resource);
-      return ok;
-    });
-
-interface Release {
-  from: State;
-  to?: null;
-}
-
-interface Acquire {
-  from?: null;
-  to: State;
-}
-
-export type Transfer =
-  | {
-      from: State;
-      to: State;
-    }
-  | Release
-  | Acquire;
+export type Authority = control.Authority;
+export const Authority = control.Authority;
+export type Transfer = control.Transfer<ChannelKey>;
+export type State = control.State<ChannelKey>;
+export type Subject = control.Subject;
+export const stateZ = control.stateZ(z.number());
 
 export const transferString = (t: Transfer): string => {
   if (t.to == null) return `${t.from?.resource} - ${t.from?.subject.name} -> released`;
@@ -79,22 +35,24 @@ export const transferString = (t: Transfer): string => {
 };
 
 interface Update {
-  transfers: Transfer[];
+  transfers: control.Transfer<ChannelKey>[];
 }
 
-export class StateTracker implements observe.Observable<Transfer[]> {
+export class StateTracker
+  extends framer.ObservableStreamer<Transfer[]>
+  implements observe.ObservableAsyncCloseable<Transfer[]>
+{
   readonly states: Map<ChannelKey, State>;
-  private readonly streamer: FrameStreamer;
   private readonly ecd: binary.EncoderDecoder;
-  private readonly observer: observe.Observer<Transfer[]>;
-  private readonly closePromise: Promise<void>;
 
-  private constructor(streamer: FrameStreamer) {
+  constructor(streamer: FrameStreamer) {
+    super(streamer, (frame) => {
+      const update: Update = this.ecd.decode(frame.series[0].buffer);
+      this.merge(update);
+      return [update.transfers, true];
+    });
     this.states = new Map();
     this.ecd = new binary.JSONEncoderDecoder();
-    this.observer = new observe.Observer<Transfer[]>();
-    this.streamer = streamer;
-    this.closePromise = this.stream();
   }
 
   subjects(): Subject[] {
@@ -103,28 +61,6 @@ export class StateTracker implements observe.Observable<Transfer[]> {
     return Array.from(subjects.values());
   }
 
-  onChange(handler: observe.Handler<Transfer[]>): Destructor {
-    return this.observer.onChange(handler);
-  }
-
-  async close(): Promise<void> {
-    this.streamer.close();
-    await this.closePromise;
-  }
-
-  static async open(client: FrameClient): Promise<StateTracker> {
-    const streamer = await client.openStreamer("sy_node_1_control");
-    return new StateTracker(streamer);
-  }
-
-  private async stream(): Promise<void> {
-    for await (const frame of this.streamer) {
-      const update: Update = this.ecd.decode(frame.series[0].buffer);
-      this.merge(update);
-      this.observer.notify(update.transfers);
-    }
-  }
-
   private merge(update: Update): void {
     update.transfers.forEach((t) => {
       if (t.from == null && t.to == null) console.warn("Invalid transfer: ", t);

package/src/errors.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,10 +8,10 @@
 // included in the file licenses/APL.txt.
 
 import {
+  type ErrorPayload,
   type Middleware,
   registerError,
   Unreachable,
-  type ErrorPayload,
 } from "@synnaxlabs/freighter";
 
 const _FREIGHTER_EXCEPTION_PREFIX = "sy.";
@@ -99,6 +99,14 @@ export class RouteError extends Error {
   }
 }
 
+export class ControlError extends Error {
+  static readonly TYPE = _FREIGHTER_EXCEPTION_PREFIX + "control";
+}
+
+export class UnauthorizedError extends ControlError {
+  static readonly TYPE = ControlError.TYPE + ".unauthorized";
+}
+
 /**
  * Raised when time-series data is not contiguous.
  */
@@ -109,9 +117,7 @@ const decode = (payload: ErrorPayload): Error | null => {
   if (payload.type.startsWith(ValidationError.TYPE)) {
     if (payload.type === FieldError.TYPE) {
       const values = payload.data.split(": ");
-      if (values.length < 2) {
-        return new ValidationError(payload.data);
-      }
+      if (values.length < 2) return new ValidationError(payload.data);
       return new FieldError(values[0], values[1]);
     }
     return new ValidationError(payload.data);
@@ -135,10 +141,15 @@ const decode = (payload: ErrorPayload): Error | null => {
     return new QueryError(payload.data);
   }
 
-  if (payload.type.startsWith(RouteError.TYPE)) {
-    return new RouteError(payload.data, payload.data);
+  if (payload.type.startsWith(ControlError.TYPE)) {
+    if (payload.type.startsWith(UnauthorizedError.TYPE))
+      return new UnauthorizedError(payload.data);
+    return new ControlError(payload.data);
   }
 
+  if (payload.type.startsWith(RouteError.TYPE))
+    return new RouteError(payload.data, payload.data);
+
   return new UnexpectedError(payload.data);
 };
 

package/src/framer/adapter.spec.ts

@@ -1,3 +1,12 @@
+// Copyright 2024 Synnax Labs, Inc.
+//
+// Use of this software is governed by the Business Source License included in the file
+// licenses/BSL.txt.
+//
+// As of the Change Date specified in that file, in accordance with the Business Source
+// License, use of this software will be governed by the Apache License, Version 2.0,
+// included in the file licenses/APL.txt.
+
 import { DataType, Series, TimeStamp } from "@synnaxlabs/x/telem";
 import { beforeAll, describe, expect, it } from "vitest";
 

package/src/framer/adapter.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -11,14 +11,14 @@ import { type CrudeSeries, Series } from "@synnaxlabs/x/telem";
 
 import {
   type Key,
+  type KeyOrName,
   type Name,
   type Params,
-  type KeyOrName,
   type Payload,
 } from "@/channel/payload";
 import {
-  type Retriever,
   analyzeChannelParams,
+  type Retriever,
   retrieveRequired,
 } from "@/channel/retriever";
 import { ValidationError } from "@/errors";

package/src/framer/client.spec.ts

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

package/src/framer/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,28 +7,35 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type StreamClient } from "@synnaxlabs/freighter";
+import {type StreamClient, UnaryClient } from "@synnaxlabs/freighter";
 import {
-  type CrudeTimeStamp,
   type CrudeSeries,
   type CrudeTimeRange,
+  type CrudeTimeStamp,
   type MultiSeries,
-} from "@synnaxlabs/x/telem";
+  TimeRange,
+  TimeSpan,
+} from "@synnaxlabs/x";
 
-import { KeysOrNames, type KeyOrName, type Params } from "@/channel/payload";
-import { type Retriever, analyzeChannelParams } from "@/channel/retriever";
+import { type Key, type KeyOrName, KeysOrNames, type Params} from "@/channel/payload";
+import { analyzeChannelParams,type Retriever } from "@/channel/retriever";
 import { Frame } from "@/framer/frame";
 import { Iterator } from "@/framer/iterator";
 import { Streamer, type StreamerConfig } from "@/framer/streamer";
-import { Writer, WriterMode, type WriterConfig } from "@/framer/writer";
+import { Writer, type WriterConfig,WriterMode } from "@/framer/writer";
+import { Deleter } from "@/framer/deleter";
 
 export class Client {
-  private readonly stream: StreamClient;
+  private readonly streamClient: StreamClient;
+  // private readonly unaryClient: UnaryClient;
   private readonly retriever: Retriever;
+  private readonly deleter: Deleter;
 
-  constructor(stream: StreamClient, retriever: Retriever) {
-    this.stream = stream;
+  constructor(stream: StreamClient, unary: UnaryClient, retriever: Retriever) {
+    this.streamClient = stream;
+    // this.unaryClient = unary;
     this.retriever = retriever;
+    this.deleter = new Deleter(unary);
   }
 
   /**
@@ -39,7 +46,7 @@ export class Client {
    * @returns a new {@link TypedIterator}.
    */
   async openIterator(tr: CrudeTimeRange, channels: Params): Promise<Iterator> {
-    return await Iterator._open(tr, channels, this.retriever, this.stream);
+    return await Iterator._open(tr, channels, this.retriever, this.streamClient);
   }
 
   /**
@@ -52,7 +59,7 @@ export class Client {
   async openWriter(config: WriterConfig | Params): Promise<Writer> {
     if (Array.isArray(config) || typeof config !== "object")
       config = { channels: config as Params };
-    return await Writer._open(this.retriever, this.stream, config);
+    return await Writer._open(this.retriever, this.streamClient, config);
   }
 
   /***
@@ -82,7 +89,7 @@ export class Client {
   async openStreamer(config: StreamerConfig | Params): Promise<Streamer> {
     if (Array.isArray(config) || typeof config !== "object")
       config = { channels: config as Params };
-    return await Streamer._open(this.retriever, this.stream, config);
+    return await Streamer._open(this.retriever, this.streamClient, config);
   }
 
   async write(
@@ -135,10 +142,12 @@ export class Client {
       start,
       channels: channels as Params,
       mode: WriterMode.PersistOnly,
+      errOnUnauthorized: true,
+      enableAutoCommit: true,
+      autoIndexPersistInterval: TimeSpan.MAX,
     });
     try {
       await w.write(channels as Params, data);
-      await w.commit();
     } finally {
       await w.close();
     }
@@ -165,4 +174,15 @@ export class Client {
     }
     return frame;
   }
+
+  async delete(
+    channels: Params,
+    timeRange : TimeRange,
+  ): Promise<void> {
+
+    const { normalized, variant } = analyzeChannelParams(channels);
+    if (variant === "keys")
+      return await this.deleter.delete({ keys: normalized as Key[], bounds: timeRange });
+    return await this.deleter.delete({ names: normalized as string[], bounds: timeRange });
+  }
 }