SY-3833: Strongly Type Schematics on the Core (#2283)

Author: emilbon99

arc/go/graph/codec_gen_test.go

@@ -9,6 +9,7 @@
 
 // Code generated by Oracle. DO NOT EDIT.
 
+import { record } from "@synnaxlabs/x";
 import { z } from "zod";
 
 /**
@@ -22,6 +23,6 @@ export const outputZ = z.object({
    * outputMemoryBases contains memory base addresses for multi-output functions, mapping
    * function keys to their base addresses.
    */
-  outputMemoryBases: z.record(z.string(), z.uint32()),
+  outputMemoryBases: record.nullishToEmpty(z.string(), z.uint32()),
 });
 export interface Output extends z.infer<typeof outputZ> {}

client/ts/src/arc/compiler/types.gen.ts

@@ -9,7 +9,7 @@
 
 // Code generated by Oracle. DO NOT EDIT.
 
-import { array, zod } from "@synnaxlabs/x";
+import { array, record, zod } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { types } from "@/arc/types";
@@ -76,7 +76,7 @@ export const authoritiesZ = z.object({
   /** default is the default authority for all write channels not explicitly listed. */
   default: zod.uint8.optional(),
   /** channels maps channel keys to their specific authority values. */
-  channels: z.record(z.uint32(), zod.uint8),
+  channels: record.nullishToEmpty(z.uint32(), zod.uint8),
 });
 export interface Authorities extends z.infer<typeof authoritiesZ> {}
 

client/ts/src/arc/ir/types.gen.ts

@@ -9,7 +9,7 @@
 
 // Code generated by Oracle. DO NOT EDIT.
 
-import { array, zod } from "@synnaxlabs/x";
+import { array, record, zod } from "@synnaxlabs/x";
 import { z } from "zod";
 
 export enum Kind {
@@ -48,9 +48,9 @@ export const chanDirectionZ = z.enum(ChanDirection);
 /** Channels contains channel declarations for reading from and writing to Synnax channels. */
 export const channelsZ = z.object({
   /** read contains readable channel indices mapped to parameter names. */
-  read: z.record(z.uint32(), z.string()),
+  read: record.nullishToEmpty(z.uint32(), z.string()),
   /** write contains writable channel indices mapped to parameter names. */
-  write: z.record(z.uint32(), z.string()),
+  write: record.nullishToEmpty(z.uint32(), z.string()),
 });
 export interface Channels extends z.infer<typeof channelsZ> {}
 

client/ts/src/arc/types/types.gen.ts

@@ -29,8 +29,8 @@ describe("schematic", () => {
         layout: {},
       });
       const randomSchematic = await client.schematics.create(ws.key, {
+        ...schematic.ZERO_NEW,
         name: "test",
-        data: {},
       });
       await expect(
         userClient.schematics.retrieve({ key: randomSchematic.key }),
@@ -48,8 +48,8 @@ describe("schematic", () => {
         layout: {},
       });
       const randomSchematic = await client.schematics.create(ws.key, {
+        ...schematic.ZERO_NEW,
         name: "test",
-        data: {},
       });
       const retrieved = await userClient.schematics.retrieve({
         key: randomSchematic.key,
@@ -69,8 +69,8 @@ describe("schematic", () => {
         layout: {},
       });
       await userClient.schematics.create(ws.key, {
+        ...schematic.ZERO_NEW,
         name: "test",
-        data: {},
       });
     });
 
@@ -86,8 +86,8 @@ describe("schematic", () => {
       });
       await expect(
         userClient.schematics.create(ws.key, {
+          ...schematic.ZERO_NEW,
           name: "test",
-          data: {},
         }),
       ).rejects.toThrow(AuthError);
     });
@@ -103,8 +103,8 @@ describe("schematic", () => {
         layout: {},
       });
       const randomSchematic = await client.schematics.create(ws.key, {
+        ...schematic.ZERO_NEW,
         name: "test",
-        data: {},
       });
       await userClient.schematics.delete(randomSchematic.key);
       await expect(
@@ -123,8 +123,8 @@ describe("schematic", () => {
         layout: {},
       });
       const randomSchematic = await client.schematics.create(ws.key, {
+        ...schematic.ZERO_NEW,
         name: "test",
-        data: {},
       });
       await expect(userClient.schematics.delete(randomSchematic.key)).rejects.toThrow(
         AuthError,

client/ts/src/schematic/access.spec.ts

@@ -8,13 +8,14 @@
 // included in the file licenses/APL.txt.
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { array, caseconv, record } from "@synnaxlabs/x";
+import { array } from "@synnaxlabs/x";
 import { z } from "zod";
 
 import { symbol } from "@/schematic/symbol";
 import {
   type Key,
   keyZ,
+  type Legend,
   type New,
   newZ,
   type Schematic,
@@ -25,10 +26,9 @@ import { workspace } from "@/workspace";
 
 const renameReqZ = z.object({ key: keyZ, name: z.string() });
 
-const setDataReqZ = z.object({
-  key: keyZ,
-  data: caseconv.preserveCase(record.unknownZ()),
-});
+const setDataBodyZ = schematicZ.omit({ key: true, name: true, snapshot: true });
+export type SetDataBody = z.input<typeof setDataBodyZ>;
+const setDataReqZ = z.object({ key: keyZ, data: setDataBodyZ });
 const deleteReqZ = z.object({ keys: keyZ.array() });
 
 const copyReqZ = z.object({
@@ -95,7 +95,7 @@ export class Client {
     );
   }
 
-  async setData(key: Key, data: record.Unknown): Promise<void> {
+  async setData(key: Key, data: SetDataBody): Promise<void> {
     await sendRequired(
       this.client,
       "/schematic/set-data",
@@ -143,3 +143,17 @@ export class Client {
     return res.schematic;
   }
 }
+
+export const ZERO_LEGEND: Legend = {
+  visible: true,
+  position: { x: 50, y: 50, units: { x: "px", y: "px" } },
+  colors: {},
+};
+
+export const ZERO_NEW: New = {
+  name: "",
+  legend: ZERO_LEGEND,
+  nodes: [],
+  edges: [],
+  configs: {},
+};