@synnaxlabs/client 0.22.1 → 0.23.0

package/src/framer/deleter.spec.ts

@@ -0,0 +1,129 @@
+// 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, Rate, TimeRange, TimeStamp } from "@synnaxlabs/x/telem";
+import { describe, expect, test } from "vitest";
+import { NotFoundError, UnauthorizedError } from "@/errors"
+
+import { type channel } from "@/channel";
+import { newClient } from "@/setupspecs";
+import { randomSeries } from "@/util/telem";
+
+const client = newClient();
+
+const newChannel = async (): Promise<channel.Channel> =>
+  await client.channels.create({
+    name: "test",
+    leaseholder: 1,
+    rate: Rate.hz(1),
+    dataType: DataType.FLOAT64,
+  });
+
+const newIndexDataChannelPair = async (): Promise<channel.Channel[]> => {
+  const ind = await client.channels.create({
+    name: "index",
+    leaseholder: 1,
+    isIndex: true,
+    dataType: DataType.TIMESTAMP,
+  })
+  const data = await client.channels.create({
+    name: "data",
+    leaseholder: 1,
+    index: ind.key,
+    dataType: DataType.INT64,
+  })
+
+  return [ind, data]
+}
+
+describe("Deleter", () => {
+  test("Client - basic delete", async () => {
+    const ch = await newChannel();
+    const data = randomSeries(10, ch.dataType);
+    await client.write(TimeStamp.seconds(0), ch.key, data);
+
+    await client.delete(ch.key, TimeStamp.seconds(2).range(TimeStamp.seconds(5)))
+
+    const res = await client.read(TimeRange.MAX, ch.key);
+    expect(res.length).toEqual(data.length - 3);
+    expect(res.data.slice(0, 2)).toEqual(data.slice(0, 2))
+    expect(res.data.slice(2)).toEqual(data.slice(5))
+  });
+  test("Client - basic delete by name", async () => {
+    const ch = await newChannel()
+    const data = randomSeries(10, ch.dataType);
+    await client.write(TimeStamp.seconds(0), ch.key, data);
+
+    await client.delete(ch.name, TimeStamp.seconds(2).range(TimeStamp.seconds(5)))
+
+    const res = await client.read(TimeRange.MAX, ch.key);
+    expect(res.length).toEqual(data.length - 3);
+    expect(res.data.slice(0, 2)).toEqual(data.slice(0, 2))
+    expect(res.data.slice(2)).toEqual(data.slice(5))
+  })
+  test("Client - delete name not found", async () => {
+    const ch = await newChannel();
+    const data = randomSeries(10, ch.dataType);
+    await client.write(TimeStamp.seconds(0), ch.key, data);
+
+    await expect(
+      client.delete(["billy bob", ch.name], TimeRange.MAX)
+    ).rejects.toThrow(NotFoundError)
+
+    const res = await client.read(TimeRange.MAX, ch.key);
+    expect(res.data).toEqual(data);
+  })
+  test("Client - delete key not found", async () => {
+    const ch = await newChannel();
+    const data = randomSeries(10, ch.dataType);
+    await client.write(TimeStamp.seconds(0), ch.key, data);
+
+    await expect(
+      client.delete([ch.key, 1232], TimeRange.MAX)
+    ).rejects.toThrow(NotFoundError)
+
+    const res = await client.read(TimeRange.MAX, ch.key);
+    expect(res.data).toEqual(data);
+  })
+
+  test("Client - delete with writer", async () => {
+    const ch = await newChannel();
+
+    const writer = await client.openWriter({
+      start: TimeStamp.seconds(10),
+      channels: [ch.key],
+    });
+
+    await expect(
+      client.delete(
+      [ch.key], TimeStamp.seconds(12).range(TimeStamp.seconds(30)))
+    ).rejects.toThrow(UnauthorizedError)
+
+    await writer.close()
+  })
+
+  test("Client - delete index channel alone", async () => {
+    const chs = await newIndexDataChannelPair()
+    const index = chs[0]
+    const dat = chs[1]
+    const data = randomSeries(10, dat.dataType)
+
+    const time = BigInt64Array.from({ length: 10 },
+      (_, i) => (TimeStamp.milliseconds(i)).valueOf());
+
+    await index.write(0, time)
+    await dat.write(0, data)
+
+    await expect(
+      client.delete(
+        [index.key], TimeStamp.milliseconds(2).range(TimeStamp.milliseconds(5))
+      )
+    ).rejects.toThrow()
+  })
+});

package/src/framer/deleter.ts

@@ -0,0 +1,49 @@
+// 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 { sendRequired, UnaryClient } from "@synnaxlabs/freighter";
+import { TimeRange } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import { keyZ } from "@/channel/payload";
+
+const reqZ = z.object({
+  keys: keyZ.array().optional(),
+  names: z.string().array().optional(),
+  bounds: TimeRange.z,
+});
+
+type RequestProps = z.infer<typeof reqZ>;
+
+const resZ = z.object({});
+
+const ENDPOINT = "/frame/delete";
+
+export class Deleter {
+  /*
+  Deleter is used to delete a time range of telemetry from the data engine.
+   */
+  private readonly client: UnaryClient;
+
+  constructor(
+    client: UnaryClient,
+  ) {
+    this.client = client;
+  }
+
+  async delete(props: RequestProps): Promise<void> {
+    await sendRequired<typeof reqZ, typeof resZ>(
+      this.client,
+      ENDPOINT,
+      props,
+      reqZ,
+      resZ,
+    );
+  }
+}

package/src/framer/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.

package/src/framer/frame.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/frame.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,13 +8,13 @@
 // included in the file licenses/APL.txt.
 
 import {
-  Size,
+  DataType,
+  MultiSeries,
   Series,
+  Size,
+  type TelemValue,
   TimeRange,
-  DataType,
   TimeStamp,
-  type TelemValue,
-  MultiSeries,
 } from "@synnaxlabs/x/telem";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { unique } from "@synnaxlabs/x/unique";
@@ -60,7 +60,7 @@ export type CrudeFrame =
   | Record<KeyOrName, Series[] | Series>;
 
 /**
- * A frame is a collection of related typed arrays keyed to a particular channel. Frames
+ * A frame is a collection of series mapped to a particular channel. Frames
  * can be keyed by channel name or channel key, but not both.
  *
  * Frames have two important characteristics: alignment and orientation.
@@ -283,10 +283,10 @@ export class Frame {
   }
 
   /**
-   * Pushes a set of typed arrays for the given channel onto the frame.
+   * Pushes a set of series for the given channel onto the frame.
    *
    * @param key the channel key or name;
-   * @param v the typed arrays to push.
+   * @param v the series to push.
    */
   push(key: KeyOrName, ...v: Series[]): void;
 
@@ -316,7 +316,7 @@ export class Frame {
   }
 
   /**
-   * @returns a shallow copy of this frame containing all typed arrays in the current frame and the
+   * @returns a shallow copy of this frame containing all series in the current frame and the
    * provided frame.
    */
   concat(frame: Frame): Frame {
@@ -338,7 +338,7 @@ export class Frame {
 
   /**
    * @returns a new frame containing the mapped output of the provided function.
-   * @param fn a function that takes a channel key and typed array and returns a
+   * @param fn a function that takes a channel key and series and returns a
    * boolean.
    */
   map(fn: (k: KeyOrName, arr: Series, i: number) => [KeyOrName, Series]): Frame {
@@ -348,9 +348,9 @@ export class Frame {
   }
 
   /**
-   * Iterates over all typed arrays in the current frame.
+   * Iterates over all series in the current frame.
    *
-   * @param fn a function that takes a channel key and typed array.
+   * @param fn a function that takes a channel key and series.
    */
   forEach(fn: (k: KeyOrName, arr: Series, i: number) => void): void {
     this.columns.forEach((k, i) => {
@@ -372,9 +372,9 @@ export class Frame {
   }
 
   /**
-   * @returns a new frame containing all typed arrays in the current frame that pass
+   * @returns a new frame containing all series in the current frame that pass
    * the provided filter function.
-   * @param fn a function that takes a channel key and typed array and returns a boolean.
+   * @param fn a function that takes a channel key and series and returns a boolean.
    */
   filter(fn: (k: KeyOrName, arr: Series, i: number) => boolean): Frame {
     const frame = new Frame();

package/src/framer/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/framer/iterator.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.
@@ -8,7 +8,7 @@
 // included in the file licenses/APL.txt.
 
 import { DataType, Rate, TimeRange, TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
-import { describe, test, expect } from "vitest";
+import { describe, expect,test } from "vitest";
 
 import { type channel } from "@/channel";
 import { newClient } from "@/setupspecs";

package/src/framer/iterator.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,12 +9,12 @@
 
 import { errorZ, type Stream, type StreamClient } from "@synnaxlabs/freighter";
 import {
+  type CrudeTimeRange,
   type CrudeTimeSpan,
   type CrudeTimeStamp,
   TimeRange,
   TimeSpan,
   TimeStamp,
-  type CrudeTimeRange,
 } from "@synnaxlabs/x/telem";
 import { z } from "zod";
 

package/src/framer/streamProxy.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,11 +7,9 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type Stream, EOF } from "@synnaxlabs/freighter";
+import { EOF, type Stream } from "@synnaxlabs/freighter";
 import { type z } from "zod";
 
-import { UnexpectedError } from "@/errors";
-
 export class StreamProxy<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny> {
   readonly name: string;
   private readonly stream: Stream<RQ, RS>;

package/src/framer/streamer.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.
@@ -7,8 +7,8 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { describe, test, expect, it } from "vitest";
 import { DataType, Rate, TimeStamp } from "@synnaxlabs/x/telem";
+import { describe, expect, it,test } from "vitest";
 
 import { type channel } from "@/channel";
 import { newClient } from "@/setupspecs";

package/src/framer/streamer.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,9 +7,9 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { errorZ, type Stream, type StreamClient } from "@synnaxlabs/freighter";
+import { EOF, errorZ, type Stream, type StreamClient } from "@synnaxlabs/freighter";
 import { observe } from "@synnaxlabs/x";
-import { TimeStamp, type CrudeTimeStamp } from "@synnaxlabs/x/telem";
+import { type CrudeTimeStamp, TimeStamp } from "@synnaxlabs/x/telem";
 import { z } from "zod";
 
 import { type Key, type Params } from "@/channel/payload";
@@ -67,8 +67,9 @@ export class Streamer implements AsyncIterator<Frame>, AsyncIterable<Frame> {
     try {
       const frame = await this.read();
       return { done: false, value: frame };
-    } catch (EOF) {
-      return { done: true, value: undefined };
+    } catch (err) {
+      if (err instanceof EOF) return { done: true, value: undefined };
+      throw err;
     }
   }
 

package/src/framer/writer.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.
@@ -11,6 +11,7 @@ import { DataType, Rate, TimeRange, TimeSpan, TimeStamp } from "@synnaxlabs/x/te
 import { describe, expect, test } from "vitest";
 
 import { type channel } from "@/channel";
+import { UnauthorizedError } from "@/errors";
 import { ALWAYS_INDEX_PERSIST_ON_AUTO_COMMIT, WriterMode } from "@/framer/writer";
 import { newClient } from "@/setupspecs";
 import { randomSeries } from "@/util/telem";
@@ -113,6 +114,22 @@ describe("Writer", () => {
       }
       expect(true).toBeTruthy();
     });
+    test("write with errOnUnauthorized", async () => {
+      const ch = await newChannel();
+      const w1 = await client.openWriter({
+        start: 0,
+        channels: ch.key,
+      });
+
+      await expect(
+        client.openWriter({
+          start: 0,
+          channels: ch.key,
+          errOnUnauthorized: true,
+        }),
+      ).rejects.toThrow(UnauthorizedError);
+      await w1.close();
+    });
   });
   describe("Client", () => {
     test("Client - basic write", async () => {

package/src/framer/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.
@@ -7,32 +7,27 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-/* eslint-disable @typescript-eslint/no-throw-literal */
 import type { Stream, StreamClient } from "@synnaxlabs/freighter";
 import { decodeError, errorZ } from "@synnaxlabs/freighter";
+import { control } from "@synnaxlabs/x";
 import {
-  TimeStamp,
-  type CrudeTimeStamp,
   type CrudeSeries,
+  type CrudeTimeStamp,
   TimeSpan,
+  TimeStamp,
 } from "@synnaxlabs/x/telem";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
 import {
-  type KeysOrNames,
   type Key,
   type KeyOrName,
+  type KeysOrNames,
   type Params,
 } from "@/channel/payload";
 import { type Retriever } from "@/channel/retriever";
-import { Authority } from "@/control/authority";
-import {
-  subjectZ as controlSubjectZ,
-  type Subject as ControlSubject,
-} from "@/control/state";
 import { WriteFrameAdapter } from "@/framer/adapter";
-import { frameZ, type CrudeFrame } from "@/framer/frame";
+import { type CrudeFrame, frameZ } from "@/framer/frame";
 import { StreamProxy } from "@/framer/streamProxy";
 
 enum Command {
@@ -41,7 +36,6 @@ enum Command {
   Commit = 2,
   Error = 3,
   SetAuthority = 4,
-  SetMode = 5,
 }
 
 export enum WriterMode {
@@ -54,10 +48,11 @@ export const ALWAYS_INDEX_PERSIST_ON_AUTO_COMMIT: TimeSpan = new TimeSpan(-1);
 
 const netConfigZ = z.object({
   start: TimeStamp.z.optional(),
-  controlSubject: controlSubjectZ.optional(),
+  controlSubject: control.subjectZ.optional(),
   keys: z.number().array().optional(),
-  authorities: Authority.z.array().optional(),
+  authorities: control.Authority.z.array().optional(),
   mode: z.nativeEnum(WriterMode).optional(),
+  errOnUnauthorized: z.boolean().optional(),
   enableAutoCommit: z.boolean().optional(),
   autoIndexPersistInterval: TimeSpan.z.optional(),
 });
@@ -84,14 +79,17 @@ export interface WriterConfig {
   // start sets the starting timestamp for the first sample in the writer.
   start?: CrudeTimeStamp;
   // controlSubject sets the control subject of the writer.
-  controlSubject?: ControlSubject;
+  controlSubject?: control.Subject;
   // authorities set the control authority to set for each channel on the writer.
   // Defaults to absolute authority. If not working with concurrent control,
   // it's best to leave this as the default.
-  authorities?: Authority | Authority[];
+  authorities?: control.Authority | control.Authority[];
   // mode sets the persistence and streaming mode of the writer. The default
   // mode is WriterModePersistStream.
   mode?: WriterMode;
+  // errOnUnauthorized sets whether the writer raises an error when it attempts to write
+  // to a channel without permission.
+  errOnUnauthorized?: boolean,
   //  enableAutoCommit determines whether the writer will automatically commit.
   //  If enableAutoCommit is true, then the writer will commit after each write, and
   //  will flush that commit to index after the specified autoIndexPersistInterval.
@@ -159,9 +157,10 @@ export class Writer {
     {
       channels,
       start = TimeStamp.now(),
-      authorities = Authority.Absolute,
+      authorities = control.Authority.Absolute,
       controlSubject: subject,
       mode = WriterMode.PersistStream,
+      errOnUnauthorized = false,
       enableAutoCommit = false,
       autoIndexPersistInterval = TimeSpan.SECOND,
     }: WriterConfig,
@@ -177,6 +176,7 @@ export class Writer {
         controlSubject: subject,
         authorities: toArray(authorities),
         mode,
+        errOnUnauthorized,
         enableAutoCommit,
         autoIndexPersistInterval,
       },
@@ -219,7 +219,7 @@ export class Writer {
     return true;
   }
 
-  async setAuthority(value: Record<Key, Authority>): Promise<boolean> {
+  async setAuthority(value: Record<Key, control.Authority>): Promise<boolean> {
     const res = await this.execute({
       command: Command.SetAuthority,
       config: {
@@ -230,14 +230,6 @@ export class Writer {
     return res.ack;
   }
 
-  async setMode(mode: WriterMode): Promise<boolean> {
-    const res = await this.execute({
-      command: Command.SetMode,
-      config: { mode },
-    });
-    return res.ack;
-  }
-
   /**
    * Commits the written frames to the database. Commit is synchronous, meaning that it
    * will not return until all frames have been commited to the database.
@@ -272,7 +264,7 @@ export class Writer {
   }
 
   async execute(req: Request): Promise<Response> {
-    // @ts-expect-error
+    // @ts-expect-error - frame payload adjustments
     this.stream.send(req);
     while (true) {
       const res = await this.stream.receive();

package/src/hardware/device/client.ts

@@ -7,8 +7,8 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type UnaryClient, sendRequired } from "@synnaxlabs/freighter";
-import { type UnknownRecord, toArray } from "@synnaxlabs/x";
+import { sendRequired,type UnaryClient } from "@synnaxlabs/freighter";
+import { toArray,type UnknownRecord } from "@synnaxlabs/x";
 import { binary } from "@synnaxlabs/x/binary";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 import { z } from "zod";

package/src/hardware/device/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/hardware/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.

package/src/hardware/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/hardware/rack/rack.spec.ts

@@ -22,7 +22,7 @@ describe("Rack", () => {
       expect(r.key).toBeGreaterThan(0n);
     });
     it("should return an error if the rack doesn't have a name", async () => {
-      // @ts-expect-error
+      // @ts-expect-error - Testing for error
       await expect(client.hardware.racks.create({})).rejects.toThrow(ZodError);
     });
   });

package/src/hardware/task/client.ts

@@ -7,11 +7,11 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type UnaryClient, sendRequired } from "@synnaxlabs/freighter";
+import { sendRequired,type UnaryClient } from "@synnaxlabs/freighter";
 import { binary, type observe } from "@synnaxlabs/x";
 import { type UnknownRecord } from "@synnaxlabs/x/record";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
-import { TimeSpan, type CrudeTimeSpan } from "@synnaxlabs/x/telem";
+import { type CrudeTimeSpan,TimeSpan } from "@synnaxlabs/x/telem";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { nanoid } from "nanoid";
 import { z } from "zod";
@@ -316,7 +316,7 @@ export class Client implements AsyncTermSearcher<string, TaskKey, Payload> {
       { number: "rack", string: "keys" },
       { convertNumericStrings: false },
     );
-    let req: RetrieveRequest = { ...options };
+    const req: RetrieveRequest = { ...options };
     if (variant === "rack") req.rack = rack as number;
     else req.keys = normalized as string[];
     const tasks = await this.execRetrieve(req);

package/src/hardware/task/task.spec.ts

@@ -7,11 +7,11 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
+import { nanoid } from "nanoid";
 import { describe, expect, it } from "vitest";
 
-import { newClient } from "@/setupspecs";
 import { task } from "@/hardware/task";
-import { nanoid } from "nanoid";
+import { newClient } from "@/setupspecs";
 
 const client = newClient();