@synnaxlabs/client 0.56.1 → 0.57.0

package/src/modbus/types.gen.ts

@@ -0,0 +1,185 @@
+// 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 { id, zod } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import { channel } from "@/channel";
+import { device } from "@/device";
+import { task } from "@/task";
+
+/** RegisterValue interprets one or more 16-bit registers as a single typed value. */
+export const registerValueZ = z.object({
+  /** dataType is the data type the register contents are interpreted as. */
+  dataType: z.string().default("uint8"),
+  /** bytesSwapped is true when the byte order within each 16-bit word is swapped. */
+  bytesSwapped: z.boolean().default(false),
+  /** wordsSwapped is true when the word order of multi-register values is swapped. */
+  wordsSwapped: z.boolean().default(false),
+});
+export interface RegisterValue extends z.infer<typeof registerValueZ> {}
+
+/** BaseReadChannel carries the fields every Modbus read channel shares. */
+export const baseReadChannelZ = z.object({
+  /** key uniquely identifies the channel within the task. */
+  key: z.string().default(id.create),
+  /** name is the human-readable channel name. */
+  name: z.string().default(""),
+  /** disabled is true when the channel is excluded from acquisition. */
+  disabled: z.boolean().default(false),
+  /** channel is the Synnax channel that samples are written to. */
+  channel: channel.keyZ.default(0),
+  /** address is the Modbus address the channel reads from. */
+  address: zod.uint16.default(0),
+});
+export interface BaseReadChannel extends z.infer<typeof baseReadChannelZ> {}
+
+/** BaseWriteChannel carries the fields every Modbus write channel shares. */
+export const baseWriteChannelZ = z.object({
+  /** key uniquely identifies the channel within the task. */
+  key: z.string().default(id.create),
+  /** name is the human-readable channel name. */
+  name: z.string().default(""),
+  /** disabled is true when the channel is excluded from the task. */
+  disabled: z.boolean().default(false),
+  /** channel is the Synnax channel commands are read from. */
+  channel: channel.keyZ.default(0),
+  /** address is the Modbus address the channel writes to. */
+  address: zod.uint16.default(0),
+});
+export interface BaseWriteChannel extends z.infer<typeof baseWriteChannelZ> {}
+
+export const scanConfigZ = task.scanConfigZ;
+export interface ScanConfig extends z.infer<typeof scanConfigZ> {}
+
+/** CoilReadChannel reads a single bit from a coil. */
+export const coilReadChannelZ = baseReadChannelZ.extend({
+  type: z.literal("coil"),
+});
+export interface CoilReadChannel extends z.infer<typeof coilReadChannelZ> {}
+
+/** DiscreteInputReadChannel reads a single bit from a discrete input. */
+export const discreteInputReadChannelZ = baseReadChannelZ.extend({
+  type: z.literal("discrete_input"),
+});
+export interface DiscreteInputReadChannel extends z.infer<
+  typeof discreteInputReadChannelZ
+> {}
+
+/**
+ * HoldingRegisterReadChannel reads a typed value from one or more holding registers.
+ */
+export const holdingRegisterReadChannelZ = baseReadChannelZ
+  .extend(registerValueZ.shape)
+  .extend({
+    type: z.literal("holding_register"),
+    /** stringLength is the length, in characters, when data_type is a string. */
+    stringLength: z.int32().default(0),
+  });
+export interface HoldingRegisterReadChannel extends z.infer<
+  typeof holdingRegisterReadChannelZ
+> {}
+
+/** InputRegisterReadChannel reads a typed value from one or more input registers. */
+export const inputRegisterReadChannelZ = baseReadChannelZ
+  .extend(registerValueZ.shape)
+  .extend({
+    type: z.literal("input_register"),
+    /** stringLength is the length, in characters, when data_type is a string. */
+    stringLength: z.int32().default(0),
+  });
+export interface InputRegisterReadChannel extends z.infer<
+  typeof inputRegisterReadChannelZ
+> {}
+
+export const READ_CHANNEL_TYPES = [
+  "coil",
+  "discrete_input",
+  "holding_register",
+  "input_register",
+] as const;
+export const readChannelTypeZ = z.enum(READ_CHANNEL_TYPES);
+export type ReadChannelType = z.infer<typeof readChannelTypeZ>;
+
+/**
+ * ReadChannel is a single Modbus read channel. The type field selects the register
+ * space the channel reads from and the fields that accompany it.
+ */
+export const readChannelZ = z.discriminatedUnion("type", [
+  coilReadChannelZ,
+  discreteInputReadChannelZ,
+  holdingRegisterReadChannelZ,
+  inputRegisterReadChannelZ,
+]);
+export type ReadChannel =
+  | CoilReadChannel
+  | DiscreteInputReadChannel
+  | HoldingRegisterReadChannel
+  | InputRegisterReadChannel;
+
+export const READ_CHANNEL_SCHEMAS: {
+  [K in ReadChannelType]: z.ZodType<Extract<ReadChannel, { type: K }>>;
+} = {
+  coil: coilReadChannelZ,
+  discrete_input: discreteInputReadChannelZ,
+  holding_register: holdingRegisterReadChannelZ,
+  input_register: inputRegisterReadChannelZ,
+};
+
+/** CoilWriteChannel writes a single bit to a coil. */
+export const coilWriteChannelZ = baseWriteChannelZ.extend({
+  type: z.literal("coil"),
+});
+export interface CoilWriteChannel extends z.infer<typeof coilWriteChannelZ> {}
+
+/**
+ * HoldingRegisterWriteChannel writes a typed value to one or more holding registers.
+ */
+export const holdingRegisterWriteChannelZ = baseWriteChannelZ
+  .extend(registerValueZ.shape)
+  .extend({
+    type: z.literal("holding_register"),
+  });
+export interface HoldingRegisterWriteChannel extends z.infer<
+  typeof holdingRegisterWriteChannelZ
+> {}
+
+export const WRITE_CHANNEL_TYPES = ["coil", "holding_register"] as const;
+export const writeChannelTypeZ = z.enum(WRITE_CHANNEL_TYPES);
+export type WriteChannelType = z.infer<typeof writeChannelTypeZ>;
+
+/**
+ * WriteChannel is a single Modbus write channel. The type field selects the register
+ * space the channel writes to and the fields that accompany it.
+ */
+export const writeChannelZ = z.discriminatedUnion("type", [
+  coilWriteChannelZ,
+  holdingRegisterWriteChannelZ,
+]);
+export type WriteChannel = CoilWriteChannel | HoldingRegisterWriteChannel;
+
+export const WRITE_CHANNEL_SCHEMAS: {
+  [K in WriteChannelType]: z.ZodType<Extract<WriteChannel, { type: K }>>;
+} = {
+  coil: coilWriteChannelZ,
+  holding_register: holdingRegisterWriteChannelZ,
+};
+
+export const readConfigZ = task.readConfigZ.extend({
+  device: device.keyZ.default(""),
+  channels: readChannelZ.array().default(() => []),
+});
+export interface ReadConfig extends z.infer<typeof readConfigZ> {}
+
+export const writeConfigZ = task.writeConfigZ.extend({
+  channels: writeChannelZ.array().default(() => []),
+});
+export interface WriteConfig extends z.infer<typeof writeConfigZ> {}

package/src/ni/external.ts

@@ -0,0 +1,10 @@
+// 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.
+
+export * from "@/ni/types.gen";

package/src/ni/index.ts

@@ -0,0 +1,10 @@
+// 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.
+
+export * as ni from "@/ni/external";