@synnaxlabs/client 0.26.1 → 0.27.0

package/src/ranger/ranger.spec.ts

@@ -7,10 +7,12 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
+import { change } from "@synnaxlabs/x";
 import { DataType, Rate, TimeSpan, TimeStamp } from "@synnaxlabs/x/telem";
 import { describe, expect, it } from "vitest";
 
 import { QueryError } from "@/errors";
+import { ranger } from "@/ranger";
 import { type NewPayload } from "@/ranger/payload";
 import { newClient } from "@/setupspecs";
 
@@ -47,6 +49,21 @@ describe("Ranger", () => {
       expect(createdRanges[0].timeRange).toEqual(ranges[0].timeRange);
       expect(createdRanges[1].timeRange).toEqual(ranges[1].timeRange);
     });
+    it("should create a range with a parent", async () => {
+      const parentRange = await client.ranges.create({
+        name: "My New Parent Range",
+        timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
+      });
+      await client.ranges.create(
+        {
+          name: "My New Child Range",
+          timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
+        },
+        { parent: parentRange.ontologyID },
+      );
+      const children = await client.ontology.retrieveChildren(parentRange.ontologyID);
+      expect(children).toHaveLength(1);
+    });
   });
 
   describe("delete", () => {
@@ -109,6 +126,43 @@ describe("Ranger", () => {
     });
   });
 
+  describe("retrieveParent", () => {
+    it("should retrieve the parent of a range", async () => {
+      const parentRange = await client.ranges.create({
+        name: "My New Parent Range",
+        timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
+      });
+      const childRange = await client.ranges.create(
+        {
+          name: "My New Child Range",
+          timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
+        },
+        { parent: parentRange.ontologyID },
+      );
+      const parent = await childRange.retrieveParent();
+      expect(parent?.key).toEqual(parentRange.key);
+    });
+  });
+
+  describe("page", () => {
+    it("should page through ranges", async () => {
+      await client.ranges.create({
+        name: "My New One Second Range",
+        timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
+      });
+      await client.ranges.create({
+        name: "My New Two Second Range",
+        timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(2)),
+      });
+      const ranges = await client.ranges.page(0, 1);
+      expect(ranges.length).toEqual(1);
+      const keys = ranges.map((r) => r.key);
+      const next = await client.ranges.page(1, 1);
+      expect(next.length).toEqual(1);
+      expect(next.map((r) => r.key)).not.toContain(keys[0]);
+    });
+  });
+
   describe("KV", () => {
     it("should set, get, and delete a single key", async () => {
       const rng = await client.ranges.create({
@@ -141,82 +195,93 @@ describe("Ranger", () => {
       const res = await rng.kv.list();
       expect(res).toEqual({ foo: "bar", baz: "qux" });
     });
-  });
 
-  describe("Alias", () => {
-    describe("list", () => {
-      it("should list the aliases for the range", async () => {
-        const ch = await client.channels.create({
-          name: "My New Channel",
-          dataType: DataType.FLOAT32,
-          rate: Rate.hz(1),
-        });
+    describe("observable", () => {
+      it("should listen to key-value sets on the range", async () => {
         const rng = await client.ranges.create({
           name: "My New One Second Range",
           timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
         });
-        await rng.setAlias(ch.key, "myalias");
-        const aliases = await rng.listAliases();
-        expect(aliases).toEqual({ [ch.key]: "myalias" });
+        const obs = await rng.kv.openTracker();
+        const res = new Promise<change.Change<string, ranger.KVPair>[]>((resolve) => {
+          obs.onChange((pair) => resolve(pair));
+        });
+        await rng.kv.set("foo", "bar");
+        const pair = await res;
+        expect(pair.length).toBeGreaterThan(0);
+        expect(pair[0].value?.range).toEqual(rng.key);
+        expect(pair[0].value?.key).toEqual("foo");
+        expect(pair[0].value?.value).toEqual("bar");
       });
-    });
-  });
-
-  describe("Active", () => {
-    describe("setActive", () => {
-      it("should create and set a range as active", async () => {
+      it("should listen to key-value deletes on the range", async () => {
         const rng = await client.ranges.create({
           name: "My New One Second Range",
           timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
         });
-        await client.ranges.setActive(rng.key);
-        const retrieved = await client.ranges.retrieveActive();
-        expect(retrieved).not.toBeNull();
-        expect(retrieved?.key).toEqual(rng.key);
+        await rng.kv.set("foo", "bar");
+        const obs = await rng.kv.openTracker();
+        const res = new Promise<change.Change<string, ranger.KVPair>[]>((resolve) => {
+          obs.onChange((changes) => {
+            if (changes.every((c) => c.variant === "delete")) resolve(changes);
+          });
+        });
+        await rng.kv.delete("foo");
+        const pair = await res;
+        expect(pair.length).toBeGreaterThan(0);
+        expect(pair[0].value?.range).toEqual(rng.key);
+        expect(pair[0].value?.key).toEqual("foo");
+        expect(pair[0].value?.value).toHaveLength(0);
       });
-      it("should clear the active range", async () => {
+    });
+  });
+
+  describe("Alias", () => {
+    describe("set + resolve", () => {
+      it("should set and resolve an alias for the range", async () => {
+        const ch = await client.channels.create({
+          name: "My New Channel",
+          dataType: DataType.FLOAT32,
+          rate: Rate.hz(1),
+        });
         const rng = await client.ranges.create({
           name: "My New One Second Range",
           timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
         });
-        await client.ranges.setActive(rng.key);
-        await client.ranges.clearActive(rng.key);
-        const retrieved = await client.ranges.retrieveActive();
-        expect(retrieved).toBeNull();
+        await rng.setAlias(ch.key, "myalias");
+        const resolved = await rng.resolveAlias("myalias");
+        expect(resolved).toEqual(ch.key);
       });
     });
-  });
-
-  describe("Labels", () => {
-    describe("set", () => {
-      it("should set a label on a range", async () => {
+    describe("deleteAlias", () => {
+      it("should remove an alias for the range", async () => {
+        const ch = await client.channels.create({
+          name: "My New Channel",
+          dataType: DataType.FLOAT32,
+          rate: Rate.hz(1),
+        });
         const rng = await client.ranges.create({
           name: "My New One Second Range",
           timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
         });
-        const lbl = await client.labels.create({
-          name: "My New Label",
-          color: "#E774D0",
-        });
-        await rng.addLabel(lbl.key);
-        const retrieved = await rng.labels();
-        expect(retrieved).toEqual([lbl]);
+        await rng.setAlias(ch.key, "myalias");
+        await rng.deleteAlias(ch.key);
+        expect(await rng.resolveAlias("myalias")).toBeUndefined();
       });
     });
-    describe("remove", () => {
-      it("should remove a label from a range", async () => {
+    describe("list", () => {
+      it("should list the aliases for the range", async () => {
+        const ch = await client.channels.create({
+          name: "My New Channel",
+          dataType: DataType.FLOAT32,
+          rate: Rate.hz(1),
+        });
         const rng = await client.ranges.create({
           name: "My New One Second Range",
           timeRange: TimeStamp.now().spanRange(TimeSpan.seconds(1)),
         });
-        const lbl = await client.labels.create({
-          name: "My New Label",
-          color: "#E774D0",
-        });
-        await rng.addLabel(lbl.key);
-        await rng.removeLabel(lbl.key);
-        const retrieved = await rng.labels();
-        expect(retrieved).toEqual([]);
+        await rng.setAlias(ch.key, "myalias");
+        const aliases = await rng.listAliases();
+        expect(aliases).toEqual({ [ch.key]: "myalias" });
       });
     });
   });

package/src/ranger/writer.ts

@@ -10,6 +10,7 @@
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
+import { ontology } from "@/ontology";
 import {
   keyZ,
   type NewPayload,
@@ -23,9 +24,13 @@ const createResZ = z.object({
 });
 
 const createReqZ = z.object({
+  parent: ontology.idZ.optional(),
   ranges: newPayloadZ.array(),
 });
 
+type CreateRequest = z.infer<typeof createReqZ>;
+export type CreateOptions = Pick<CreateRequest, "parent">;
+
 const deleteReqZ = z.object({
   keys: keyZ.array(),
 });
@@ -60,11 +65,11 @@ export class Writer {
     );
   }
 
-  async create(ranges: NewPayload[]): Promise<Payload[]> {
+  async create(ranges: NewPayload[], options?: CreateOptions): Promise<Payload[]> {
     const res = await sendRequired<typeof createReqZ, typeof createResZ>(
       this.client,
       CREATE_ENDPOINT,
-      { ranges },
+      { ranges, ...options },
       createReqZ,
       createResZ,
     );

package/vite.config.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 { isProd, lib } from "@synnaxlabs/vite-plugin";
+import { lib } from "@synnaxlabs/vite-plugin";
 import { defineConfig } from "vite";
 
 export default defineConfig({

package/dist/ranger/active.d.ts

@@ -1,11 +0,0 @@
-import { UnaryClient } from '@synnaxlabs/freighter';
-import { Key, Payload } from './payload';
-
-export declare class Active {
-    private readonly client;
-    constructor(client: UnaryClient);
-    setActive(range: Key): Promise<void>;
-    retrieveActive(): Promise<Payload | null>;
-    clearActive(range: Key): Promise<void>;
-}
-//# sourceMappingURL=active.d.ts.map

package/dist/ranger/active.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"active.d.ts","sourceRoot":"","sources":["../../src/ranger/active.ts"],"names":[],"mappings":"AASA,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIvE,OAAO,EAAE,KAAK,GAAG,EAAQ,KAAK,OAAO,EAAY,MAAM,kBAAkB,CAAC;AAsB1E,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;gBAEzB,MAAM,EAAE,WAAW;IAIzB,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAUpC,cAAc,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC;IAYzC,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;CAS7C"}

package/dist/ranger/range.d.ts

@@ -1,32 +0,0 @@
-import { Series, TimeRange } from '@synnaxlabs/x/telem';
-import { Key, Name, Params } from '../channel/payload';
-import { Retriever as ChannelRetriever } from '../channel/retriever';
-import { framer } from '../framer';
-import { label } from '../label';
-import { Label } from '../label/payload';
-import { Alias, Aliaser } from './alias';
-import { KV } from './kv';
-import { signals } from '../signals';
-
-export declare class Range {
-    key: string;
-    name: string;
-    readonly kv: KV;
-    readonly timeRange: TimeRange;
-    readonly color: string | undefined;
-    readonly channels: ChannelRetriever;
-    private readonly aliaser;
-    private readonly frameClient;
-    private readonly labelClient;
-    constructor(name: string, timeRange: TimeRange | undefined, key: string, color: string | undefined, _frameClient: framer.Client, _kv: KV, _aliaser: Aliaser, _channels: ChannelRetriever, _labelClient: label.Client);
-    setAlias(channel: Key | Name, alias: string): Promise<void>;
-    deleteAlias(...channels: Key[]): Promise<void>;
-    listAliases(): Promise<Record<Key, string>>;
-    openAliasTracker(): Promise<signals.Observable<string, Alias>>;
-    read(channel: Key | Name): Promise<Series>;
-    read(channels: Params): Promise<framer.Frame>;
-    labels(): Promise<Label[]>;
-    addLabel(...labels: label.Key[]): Promise<void>;
-    removeLabel(...labels: label.Key[]): Promise<void>;
-}
-//# sourceMappingURL=range.d.ts.map

package/dist/ranger/range.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"range.d.ts","sourceRoot":"","sources":["../../src/ranger/range.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,MAAM,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,IAAI,EAAC,KAAK,MAAM,EAAE,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,KAAK,SAAS,IAAI,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAEzE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAE7C,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,aAAa,CAAC;AACtC,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,WAAW,CAAC;AAKzC,qBAAa,KAAK;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,EAAE,EAAE,CAAC;IAChB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgB;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;gBAGzC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,SAAS,YAAiB,EACrC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,YAAY,EAAE,MAAM,CAAC,MAAM,EAC3B,GAAG,EAAE,EAAE,EACP,QAAQ,EAAE,OAAO,EACjB,SAAS,EAAE,gBAAgB,EAC3B,YAAY,EAAE,KAAK,CAAC,MAAM;IAatB,QAAQ,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ3D,WAAW,CAAC,GAAG,QAAQ,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9C,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAI3C,gBAAgB,IAAI,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAI9D,IAAI,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;IAE1C,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;IAM7C,MAAM,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;IAI1B,QAAQ,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,WAAW,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAGzD"}

package/src/ranger/active.ts

@@ -1,74 +0,0 @@
-// 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, type UnaryClient } from "@synnaxlabs/freighter";
-import { z } from "zod";
-
-import { QueryError } from "@/errors";
-import { type Key, keyZ, type Payload, payloadZ } from "@/ranger/payload";
-
-const setActiveResZ = z.object({});
-
-const retrieveActiveResZ = z.object({
-  range: payloadZ,
-});
-
-const setActiveReqZ = z.object({
-  range: keyZ,
-});
-
-const clearActiveReqZ = z.object({
-  range: keyZ,
-});
-
-const clearActiveResZ = z.object({});
-
-const SET_ENDPOINT = "/range/set-active";
-const RETRIEVE_ENDPOINT = "/range/retrieve-active";
-const CLEAR_ENDPOINT = "/range/clear-active";
-
-export class Active {
-  private readonly client: UnaryClient;
-
-  constructor(client: UnaryClient) {
-    this.client = client;
-  }
-
-  async setActive(range: Key): Promise<void> {
-    await sendRequired<typeof setActiveReqZ, typeof setActiveResZ>(
-      this.client,
-      SET_ENDPOINT,
-      { range },
-      setActiveReqZ,
-      setActiveResZ,
-    );
-  }
-
-  async retrieveActive(): Promise<Payload | null> {
-    const [res, err] = await this.client.send(
-      RETRIEVE_ENDPOINT,
-      {},
-      z.object({}),
-      retrieveActiveResZ,
-    );
-    if (QueryError.matches(err)) return null;
-    if (err != null) throw err;
-    return res.range;
-  }
-
-  async clearActive(range: Key): Promise<void> {
-    await sendRequired<typeof clearActiveReqZ, typeof clearActiveResZ>(
-      this.client,
-      CLEAR_ENDPOINT,
-      { range },
-      clearActiveReqZ,
-      clearActiveResZ,
-    );
-  }
-}

package/src/ranger/range.ts

@@ -1,98 +0,0 @@
-// 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 { type Series, TimeRange } from "@synnaxlabs/x/telem";
-
-import { type Key, type Name,type Params } from "@/channel/payload";
-import { type Retriever as ChannelRetriever } from "@/channel/retriever";
-import { QueryError } from "@/errors";
-import { type framer } from "@/framer";
-import { type label } from "@/label";
-import { type Label } from "@/label/payload";
-import { ontology } from "@/ontology";
-import { type Alias, type Aliaser } from "@/ranger/alias";
-import { type KV } from "@/ranger/kv";
-import { type signals } from "@/signals";
-
-const ontologyID = (key: string): ontology.ID =>
-  new ontology.ID({ type: "range", key });
-
-export class Range {
-  key: string;
-  name: string;
-  readonly kv: KV;
-  readonly timeRange: TimeRange;
-  readonly color: string | undefined;
-  readonly channels: ChannelRetriever;
-  private readonly aliaser: Aliaser;
-  private readonly frameClient: framer.Client;
-  private readonly labelClient: label.Client;
-
-  constructor(
-    name: string,
-    timeRange: TimeRange = TimeRange.ZERO,
-    key: string,
-    color: string | undefined,
-    _frameClient: framer.Client,
-    _kv: KV,
-    _aliaser: Aliaser,
-    _channels: ChannelRetriever,
-    _labelClient: label.Client,
-  ) {
-    this.key = key;
-    this.name = name;
-    this.timeRange = timeRange;
-    this.frameClient = _frameClient;
-    this.color = color;
-    this.kv = _kv;
-    this.aliaser = _aliaser;
-    this.channels = _channels;
-    this.labelClient = _labelClient;
-  }
-
-  async setAlias(channel: Key | Name, alias: string): Promise<void> {
-    const ch = await this.channels.retrieve(channel);
-    if (ch.length === 0) {
-      throw new QueryError(`Channel ${channel} does not exist`);
-    }
-    await this.aliaser.set({ [ch[0].key]: alias });
-  }
-
-  async deleteAlias(...channels: Key[]): Promise<void> {
-    await this.aliaser.delete(channels);
-  }
-
-  async listAliases(): Promise<Record<Key, string>> {
-    return await this.aliaser.list();
-  }
-
-  async openAliasTracker(): Promise<signals.Observable<string, Alias>> {
-    return await this.aliaser.openChangeTracker();
-  }
-
-  async read(channel: Key | Name): Promise<Series>;
-
-  async read(channels: Params): Promise<framer.Frame>;
-
-  async read(channels: Params): Promise<Series | framer.Frame> {
-    return await this.frameClient.read(this.timeRange, channels);
-  }
-
-  async labels(): Promise<Label[]> {
-    return await this.labelClient.retrieveFor(ontologyID(this.key));
-  }
-
-  async addLabel(...labels: label.Key[]): Promise<void> {
-    await this.labelClient.label(ontologyID(this.key), labels);
-  }
-
-  async removeLabel(...labels: label.Key[]): Promise<void> {
-    await this.labelClient.removeLabels(ontologyID(this.key), labels);
-  }
-}