@synnaxlabs/client 0.53.0 → 0.54.0

package/src/log/types.gen.ts

@@ -0,0 +1,42 @@
+// Copyright 2026 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.
+
+// Code generated by Oracle. DO NOT EDIT.
+
+import { caseconv, record } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import { ontology } from "@/ontology";
+
+export const keyZ = z.uuid();
+export type Key = z.infer<typeof keyZ>;
+
+/**
+ * Log is a timestamped event and message logging component. Logs display
+ * chronological records of events, system messages, and audit trails with
+ * filtering and formatting capabilities.
+ */
+export const logZ = z.object({
+  /** key is the unique identifier for this log. */
+  key: keyZ,
+  /** name is a human-readable name for the log. */
+  name: z.string(),
+  /**
+   * data is the log configuration including message formatting, filtering
+   * rules, and display options.
+   */
+  data: caseconv.preserveCase(record.nullishToEmpty()),
+});
+export interface Log extends z.infer<typeof logZ> {}
+
+export const newZ = logZ.partial({ key: true });
+export interface New extends z.input<typeof newZ> {}
+
+export const ontologyID = ontology.createIDFactory<Key>("log");
+export const TYPE_ONTOLOGY_ID = ontologyID("");

package/src/ontology/payload.ts

@@ -10,6 +10,10 @@
 import { array, type change, primitive, record } from "@synnaxlabs/x";
 import { z } from "zod";
 
+import { RESOURCE_TYPES, type ResourceType, resourceTypeZ } from "@/ontology/types.gen";
+
+export { RESOURCE_TYPES, type ResourceType, resourceTypeZ };
+
 export type ResourceChange = change.Change<ID, Resource>;
 export interface ResourceSet extends change.Set<ID, Resource> {}
 export interface ResourceDelete extends change.Delete<ID, Resource> {}
@@ -19,34 +23,6 @@ export interface RelationshipDelete extends change.Delete<Relationship, undefine
 
 export interface RelationshipDelete extends change.Delete<Relationship, undefined> {}
 
-export const resourceTypeZ = z.enum([
-  "label",
-  "log",
-  "builtin",
-  "cluster",
-  "channel",
-  "node",
-  "group",
-  "range",
-  "framer",
-  "range-alias",
-  "user",
-  "workspace",
-  "schematic",
-  "lineplot",
-  "rack",
-  "device",
-  "task",
-  "policy",
-  "role",
-  "table",
-  "arc",
-  "schematic_symbol",
-  "status",
-  "view",
-]);
-export type ResourceType = z.infer<typeof resourceTypeZ>;
-
 const stringIDZ = z.string().transform((v) => {
   const [type, key] = v.split(":");
   return { type: resourceTypeZ.parse(type), key: key ?? "" };
@@ -101,7 +77,7 @@ export const resourceZ = z
   .object({
     id: idZ,
     name: z.string(),
-    data: record.unknownZ.optional().nullable(),
+    data: record.unknownZ().optional().nullable(),
   })
   .transform((resource) => ({ key: idToString(resource.id), ...resource }));
 export interface Resource<T extends record.Unknown = record.Unknown> extends Omit<

package/src/ontology/types.gen.ts

@@ -0,0 +1,41 @@
+// Copyright 2026 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.
+
+// Code generated by Oracle. DO NOT EDIT.
+
+import { z } from "zod";
+
+export const RESOURCE_TYPES = [
+  "arc",
+  "builtin",
+  "channel",
+  "cluster",
+  "device",
+  "framer",
+  "group",
+  "label",
+  "lineplot",
+  "log",
+  "node",
+  "policy",
+  "rack",
+  "range",
+  "range-alias",
+  "role",
+  "schematic",
+  "schematic_symbol",
+  "status",
+  "table",
+  "task",
+  "user",
+  "view",
+  "workspace",
+] as const;
+export const resourceTypeZ = z.enum(RESOURCE_TYPES);
+export type ResourceType = z.infer<typeof resourceTypeZ>;

package/src/rack/client.ts

@@ -17,10 +17,11 @@ import {
   keyZ,
   type New,
   newZ,
+  ontologyID,
   type Payload,
-  rackZ,
+  payloadZ,
   type Status,
-} from "@/rack/payload";
+} from "@/rack/types.gen";
 import { type task } from "@/task";
 import { checkForMultipleOrNoResults } from "@/util/retrieve";
 
@@ -30,6 +31,7 @@ export const DELETE_CHANNEL_NAME = "sy_rack_delete";
 const retrieveReqZ = z.object({
   keys: keyZ.array().optional(),
   names: z.string().array().optional(),
+  integration: z.string().optional(),
   searchTerm: z.string().optional(),
   embedded: z.boolean().optional(),
   hostIsNode: z.boolean().optional(),
@@ -37,7 +39,8 @@ const retrieveReqZ = z.object({
   offset: z.int().optional(),
   includeStatus: z.boolean().optional(),
 });
-const retrieveResZ = z.object({ racks: array.nullableZ(rackZ) });
+const retrieveResZ = z.object({ racks: array.nullishToEmpty(payloadZ) });
+export const rackZ = payloadZ;
 
 const singleRetrieveArgsZ = z.union([
   z
@@ -64,7 +67,7 @@ const retrieveArgsZ = z.union([singleRetrieveArgsZ, multiRetrieveArgsZ]);
 export type RetrieveArgs = z.input<typeof retrieveArgsZ>;
 
 const createReqZ = z.object({ racks: newZ.array() });
-const createResZ = z.object({ racks: rackZ.array() });
+const createResZ = z.object({ racks: payloadZ.array() });
 
 const deleteReqZ = z.object({ keys: keyZ.array() });
 const deleteResZ = z.object({});
@@ -125,7 +128,10 @@ export class Client {
     const isSingle = !Array.isArray(payloads);
     const sugared = array
       .toArray(payloads)
-      .map(({ key, name, status }) => new Rack(key, name, this.tasks, status));
+      .map(
+        ({ key, name, status, integrations }) =>
+          new Rack(key, name, this.tasks, status, integrations),
+      );
     return isSingle ? sugared[0] : sugared;
   }
 }
@@ -134,13 +140,21 @@ export class Rack {
   key: Key;
   name: string;
   status?: Status;
+  integrations?: string[];
   private readonly tasks: task.Client;
 
-  constructor(key: Key, name: string, taskClient: task.Client, status?: Status) {
+  constructor(
+    key: Key,
+    name: string,
+    taskClient: task.Client,
+    status?: Status,
+    integrations?: string[],
+  ) {
     this.key = key;
     this.name = name;
     this.tasks = taskClient;
     this.status = status;
+    this.integrations = integrations;
   }
 
   async listTasks(): Promise<task.Task[]> {
@@ -169,11 +183,13 @@ export class Rack {
   }
 
   get payload(): Payload {
-    return { key: this.key, name: this.name, status: this.status };
+    return {
+      key: this.key,
+      name: this.name,
+      status: this.status,
+      integrations: this.integrations,
+    };
   }
 }
 
-export const ontologyID = ontology.createIDFactory<Key>("rack");
-export const TYPE_ONTOLOGY_ID = ontologyID(0);
-
 export const statusKey = (key: Key): string => ontology.idToString(ontologyID(key));

package/src/rack/external.ts

@@ -8,4 +8,4 @@
 // included in the file licenses/APL.txt.
 
 export * from "@/rack/client";
-export * from "@/rack/payload";
+export * from "@/rack/types.gen";

package/src/rack/rack.spec.ts

@@ -79,6 +79,43 @@ describe("Rack", () => {
       expect(retrieved.name).toEqual(name);
     });
   });
+  describe("integrations", () => {
+    it("should create a rack with integrations and retrieve them", async () => {
+      const r = await client.racks.create({
+        name: "rack-with-integrations",
+        integrations: ["ni", "opc", "modbus"],
+      });
+      const retrieved = await client.racks.retrieve({ key: r.key });
+      expect(retrieved.integrations).toEqual(["ni", "opc", "modbus"]);
+    });
+    it("should filter racks by integration", async () => {
+      const r1 = await client.racks.create({
+        name: "rack-ni-opc",
+        integrations: ["ni", "opc"],
+      });
+      const r2 = await client.racks.create({
+        name: "rack-modbus-only",
+        integrations: ["modbus"],
+      });
+      const results = await client.racks.retrieve({ integration: "ni" });
+      const keys = results.map((r) => r.key);
+      expect(keys).toContain(r1.key);
+      expect(keys).not.toContain(r2.key);
+    });
+    it("should update integrations on upsert", async () => {
+      const r = await client.racks.create({
+        name: "rack-update-integrations",
+        integrations: ["ni"],
+      });
+      await client.racks.create({
+        key: r.key,
+        name: "rack-update-integrations",
+        integrations: ["ni", "opc", "arc"],
+      });
+      const retrieved = await client.racks.retrieve({ key: r.key });
+      expect(retrieved.integrations).toEqual(["ni", "opc", "arc"]);
+    });
+  });
   describe("tasks", () => {
     it("should list the tasks on a rack", async () => {
       const r = await client.racks.create({ name: "test" });

package/src/rack/types.gen.ts

@@ -0,0 +1,62 @@
+// Copyright 2026 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.
+
+// Code generated by Oracle. DO NOT EDIT.
+
+import { status, zod } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import { ontology } from "@/ontology";
+
+export const keyZ = z.uint32();
+export type Key = z.infer<typeof keyZ>;
+
+/** StatusDetails contains rack-specific status details. */
+export const statusDetailsZ = z.object({
+  /** rack is the key of the rack this status pertains to. */
+  rack: keyZ,
+});
+export interface StatusDetails extends z.infer<typeof statusDetailsZ> {}
+
+export const statusZ = status.statusZ({ details: statusDetailsZ });
+export type Status = z.infer<typeof statusZ>;
+
+/**
+ * Payload is a collection container for hardware devices and tasks running on a
+ * specific cluster node. Racks serve as the integration point between the
+ * Synnax server and physical hardware via the Driver system.
+ */
+export const payloadZ = z.object({
+  /** key is the composite identifier for this rack. */
+  key: keyZ,
+  /** name is a human-readable name for the rack. */
+  name: z.string().min(1, "Name is required"),
+  /** taskCounter is an internal counter used for generating unique local task keys. */
+  taskCounter: z.uint32().optional(),
+  /** embedded is true if this rack is embedded within the Synnax server process. */
+  embedded: z.boolean().optional(),
+  /** status is the current operational status of the rack. */
+  status: statusZ.optional(),
+  /**
+   * integrations is the list of hardware integrations this rack supports (e.g., "ni", "opc",
+   * "labjack"). An empty or nil list means the rack supports no integrations.
+   */
+  integrations: zod.nullToUndefined(z.string().array()),
+});
+export interface Payload extends z.infer<typeof payloadZ> {}
+
+export const newZ = payloadZ
+  .omit({ taskCounter: true, embedded: true, key: true })
+  .extend({
+    key: z.uint32().default(0),
+  });
+export interface New extends z.input<typeof newZ> {}
+
+export const ontologyID = ontology.createIDFactory<Key>("rack");
+export const TYPE_ONTOLOGY_ID = ontologyID(0);

package/src/range/alias/types.gen.ts

@@ -0,0 +1,30 @@
+// Copyright 2026 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.
+
+// Code generated by Oracle. DO NOT EDIT.
+
+import { z } from "zod";
+
+import { channel } from "@/channel";
+import { ranger } from "@/ranger";
+
+/**
+ * Alias associates a human-readable string alias with a channel within the
+ * context of a specific range. Enables semantic naming of channels that varies by
+ * range context.
+ */
+export const aliasZ = z.object({
+  /** range is the unique identifier of the range containing this alias. */
+  range: ranger.keyZ,
+  /** channel is the unique identifier of the channel being aliased. */
+  channel: channel.keyZ,
+  /** alias is the human-readable name for the channel within this range context. */
+  alias: z.string(),
+});
+export interface Alias extends z.infer<typeof aliasZ> {}

package/src/range/kv/types.gen.ts

@@ -0,0 +1,28 @@
+// Copyright 2026 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.
+
+// Code generated by Oracle. DO NOT EDIT.
+
+import { z } from "zod";
+
+import { ranger } from "@/ranger";
+
+/**
+ * Pair is a key-value metadata pair associated with a specific range, enabling
+ * arbitrary metadata storage on time ranges.
+ */
+export const pairZ = z.object({
+  /** range is the unique identifier of the range owning this key-value pair. */
+  range: ranger.keyZ,
+  /** key is the metadata key name. */
+  key: z.string(),
+  /** value is the metadata value stored as a string for flexibility. */
+  value: z.string(),
+});
+export interface Pair extends z.infer<typeof pairZ> {}

package/src/ranger/alias/client.ts

@@ -12,7 +12,7 @@ import { array } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { channel } from "@/channel";
-import { type Key, keyZ } from "@/ranger/payload";
+import { type Key, keyZ } from "@/ranger/types.gen";
 
 const resolveReqZ = z.object({ range: keyZ, aliases: z.string().array() });
 const resolveResZ = z.object({ aliases: z.record(z.string(), channel.keyZ) });

package/src/ranger/alias/external.ts

@@ -7,13 +7,6 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export {
-  type Alias,
-  type AliasChange,
-  aliasZ,
-  createKey,
-  type DecodedDeleteAliasChange,
-  decodeDeleteChange,
-  DELETE_CHANNEL_NAME,
-  SET_CHANNEL_NAME,
-} from "@/ranger/alias/payload";
+export * from "@/ranger/alias/client";
+export * from "@/ranger/alias/payload";
+export * from "@/ranger/alias/types.gen";

package/src/ranger/alias/payload.spec.ts

@@ -0,0 +1,52 @@
+// Copyright 2026 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 { describe, expect, it } from "vitest";
+
+import { ranger } from "@/ranger";
+
+describe("alias", () => {
+  describe("ontologyID", () => {
+    it("should create an ontology ID with the correct type and composite key", () => {
+      const id = ranger.alias.ontologyID("range-uuid-123", 42);
+      expect(id.type).toBe("range-alias");
+      expect(id.key).toBe("range-uuid-123---42");
+    });
+
+    it("should match the key format produced by createKey", () => {
+      const rangeKey = "abc-def";
+      const channelKey = 7;
+      const id = ranger.alias.ontologyID(rangeKey, channelKey);
+      const key = ranger.alias.createKey({ range: rangeKey, channel: channelKey });
+      expect(id.key).toBe(key);
+    });
+  });
+
+  describe("TYPE_ONTOLOGY_ID", () => {
+    it("should have the correct type and an empty key", () => {
+      expect(ranger.alias.TYPE_ONTOLOGY_ID.type).toBe("range-alias");
+      expect(ranger.alias.TYPE_ONTOLOGY_ID.key).toBe("");
+    });
+  });
+
+  describe("createKey", () => {
+    it("should create a composite key from range and channel", () => {
+      const key = ranger.alias.createKey({ range: "my-range", channel: 10 });
+      expect(key).toBe("my-range---10");
+    });
+  });
+
+  describe("decodeDeleteChange", () => {
+    it("should decode a composite key into range and channel", () => {
+      const decoded = ranger.alias.decodeDeleteChange("my-range---10");
+      expect(decoded.range).toBe("my-range");
+      expect(decoded.channel).toBe(10);
+    });
+  });
+});

package/src/ranger/alias/payload.ts

@@ -8,21 +8,15 @@
 // included in the file licenses/APL.txt.
 
 import { type change } from "@synnaxlabs/x";
-import { z } from "zod";
 
-import { channel } from "@/channel";
-import { type Key, keyZ } from "@/ranger/payload";
+import { type channel } from "@/channel";
+import { type ontology } from "@/ontology";
+import { type Alias } from "@/ranger/alias/types.gen";
+import { type Key } from "@/ranger/types.gen";
 
 export const SET_CHANNEL_NAME = "sy_range_alias_set";
 export const DELETE_CHANNEL_NAME = "sy_range_alias_delete";
 
-export const aliasZ = z.object({
-  alias: z.string().optional(),
-  channel: channel.keyZ,
-  range: keyZ,
-});
-export interface Alias extends z.infer<typeof aliasZ> {}
-
 export type AliasChange = change.Change<string, Alias>;
 
 const SEPARATOR = "---";
@@ -30,6 +24,13 @@ const SEPARATOR = "---";
 export const createKey = (alias: Pick<Alias, "range" | "channel">): string =>
   `${alias.range}${SEPARATOR}${alias.channel}`;
 
+export const ontologyID = (rangeKey: Key, channelKey: channel.Key): ontology.ID => ({
+  type: "range-alias",
+  key: createKey({ range: rangeKey, channel: channelKey }),
+});
+
+export const TYPE_ONTOLOGY_ID: ontology.ID = { type: "range-alias", key: "" };
+
 export interface DecodedDeleteAliasChange {
   range: Key;
   channel: channel.Key;

package/src/ranger/alias/types.gen.ts

@@ -0,0 +1,30 @@
+// Copyright 2026 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.
+
+// Code generated by Oracle. DO NOT EDIT.
+
+import { z } from "zod";
+
+import { channel } from "@/channel";
+import * as ranger from "@/ranger/types.gen";
+
+/**
+ * Alias associates a human-readable string alias with a channel within the
+ * context of a specific range. Enables semantic naming of channels that varies by
+ * range context.
+ */
+export const aliasZ = z.object({
+  /** range is the unique identifier of the range containing this alias. */
+  range: ranger.keyZ,
+  /** channel is the unique identifier of the channel being aliased. */
+  channel: channel.keyZ,
+  /** alias is the human-readable name for the channel within this range context. */
+  alias: z.string(),
+});
+export interface Alias extends z.infer<typeof aliasZ> {}