@synnaxlabs/client 0.25.0 → 0.26.1

package/src/hardware/rack/payload.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+
+import { ontology } from "@/ontology";
+
+export const rackKeyZ = z.number();
+
+export type RackKey = z.infer<typeof rackKeyZ>;
+
+export const rackZ = z.object({
+  key: rackKeyZ,
+  name: z.string(),
+});
+
+export type RackPayload = z.infer<typeof rackZ>;
+
+export const newRackZ = rackZ.partial({ key: true });
+
+export type NewRack = z.input<typeof newRackZ>;
+
+export const RackOntologyType = "rack" as ontology.ResourceType;
+
+export const ontologyID = (key: RackKey): ontology.ID =>
+  new ontology.ID({ type: RackOntologyType, key: key.toString() });

package/src/hardware/task/client.ts

@@ -8,7 +8,6 @@
 // included in the file licenses/APL.txt.
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
-import { binary, type observe } from "@synnaxlabs/x";
 import { id } from "@synnaxlabs/x";
 import { type UnknownRecord } from "@synnaxlabs/x/record";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
@@ -19,6 +18,7 @@ import { z } from "zod";
 import { framer } from "@/framer";
 import { type Frame } from "@/framer/frame";
 import { rack } from "@/hardware/rack";
+import { NewTask, newTaskZ, Payload, State, StateObservable, stateZ, TaskKey, taskKeyZ, taskZ } from "@/hardware/task/payload";
 import { signals } from "@/signals";
 import { analyzeParams, checkForMultipleOrNoResults } from "@/util/retrieve";
 import { nullableArrayZ } from "@/util/zod";
@@ -26,89 +26,6 @@ import { nullableArrayZ } from "@/util/zod";
 const TASK_STATE_CHANNEL = "sy_task_state";
 const TASK_CMD_CHANNEL = "sy_task_cmd";
 
-export const taskKeyZ = z.union([
-  z.string(),
-  z.bigint().transform((k) => k.toString()),
-  z.number().transform((k) => k.toString()),
-]);
-
-export type TaskKey = z.infer<typeof taskKeyZ>;
-
-export const stateZ = z.object({
-  task: taskKeyZ,
-  variant: z.string(),
-  key: z.string().optional(),
-  details: z
-    .record(z.unknown())
-    .or(
-      z.string().transform((c) => {
-        if (c === "") return {};
-        return JSON.parse(c);
-      }),
-    )
-    .or(z.array(z.unknown()))
-    .or(z.null()),
-});
-
-export type State<D extends {} = UnknownRecord> = Omit<
-  z.infer<typeof stateZ>,
-  "details"
-> & {
-  details?: D;
-};
-
-export const taskZ = z.object({
-  key: taskKeyZ,
-  name: z.string(),
-  type: z.string(),
-  internal: z.boolean().optional(),
-  config: z.record(z.unknown()).or(
-    z.string().transform((c) => {
-      if (c === "") return {};
-      return binary.JSON_ECD.decodeString(c);
-    }),
-  ) as z.ZodType<UnknownRecord>,
-  state: stateZ.optional().nullable(),
-});
-
-export const newTaskZ = taskZ.omit({ key: true }).extend({
-  key: taskKeyZ.transform((k) => k.toString()).optional(),
-  config: z.unknown().transform((c) => binary.JSON_ECD.encodeString(c)),
-});
-
-export type NewTask<
-  C extends UnknownRecord = UnknownRecord,
-  T extends string = string,
-> = Omit<z.input<typeof newTaskZ>, "config" | "state"> & {
-  type: T;
-  config: C;
-};
-
-export type Payload<
-  C extends UnknownRecord = UnknownRecord,
-  D extends {} = UnknownRecord,
-  T extends string = string,
-> = Omit<z.output<typeof taskZ>, "config" | "type" | "state"> & {
-  type: T;
-  config: C;
-  state?: State<D> | null;
-};
-
-export const commandZ = z.object({
-  task: taskKeyZ,
-  type: z.string(),
-  key: z.string(),
-  args: z.record(z.unknown()).or(
-    z.string().transform((c) => {
-      if (c === "") return {};
-      return JSON.parse(c);
-    }),
-  ) as z.ZodType<UnknownRecord>,
-});
-
-export type StateObservable<D extends UnknownRecord = UnknownRecord> =
-  observe.ObservableAsyncCloseable<State<D>>;
-
 export class Task<
   C extends UnknownRecord = UnknownRecord,
   D extends {} = UnknownRecord,

package/src/hardware/task/external.ts

@@ -0,0 +1,11 @@
+// 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.
+
+export * from "@/hardware/task/client";
+export * from "@/hardware/task/payload";

package/src/hardware/task/index.ts

@@ -7,4 +7,4 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export * as task from "@/hardware/task/client";
+export * as task from "@/hardware/task/external";

package/src/hardware/task/payload.ts

@@ -0,0 +1,92 @@
+import { binary, observe, UnknownRecord } from "@synnaxlabs/x";
+import { z } from "zod";
+
+import { ontology } from "@/ontology";
+
+export const taskKeyZ = z.union([
+  z.string(),
+  z.bigint().transform((k) => k.toString()),
+  z.number().transform((k) => k.toString()),
+]);
+
+export type TaskKey = z.infer<typeof taskKeyZ>;
+
+export const stateZ = z.object({
+  task: taskKeyZ,
+  variant: z.string(),
+  key: z.string().optional(),
+  details: z
+    .record(z.unknown())
+    .or(
+      z.string().transform((c) => {
+        if (c === "") return {};
+        return JSON.parse(c);
+      }),
+    )
+    .or(z.array(z.unknown()))
+    .or(z.null()),
+});
+
+export type State<D extends {} = UnknownRecord> = Omit<
+  z.infer<typeof stateZ>,
+  "details"
+> & {
+  details?: D;
+};
+
+export const taskZ = z.object({
+  key: taskKeyZ,
+  name: z.string(),
+  type: z.string(),
+  internal: z.boolean().optional(),
+  config: z.record(z.unknown()).or(
+    z.string().transform((c) => {
+      if (c === "") return {};
+      return binary.JSON_CODEC.decodeString(c);
+    }),
+  ) as z.ZodType<UnknownRecord>,
+  state: stateZ.optional().nullable(),
+});
+
+export const newTaskZ = taskZ.omit({ key: true }).extend({
+  key: taskKeyZ.transform((k) => k.toString()).optional(),
+  config: z.unknown().transform((c) => binary.JSON_CODEC.encodeString(c)),
+});
+
+export type NewTask<
+  C extends UnknownRecord = UnknownRecord,
+  T extends string = string,
+> = Omit<z.input<typeof newTaskZ>, "config" | "state"> & {
+  type: T;
+  config: C;
+};
+
+export type Payload<
+  C extends UnknownRecord = UnknownRecord,
+  D extends {} = UnknownRecord,
+  T extends string = string,
+> = Omit<z.output<typeof taskZ>, "config" | "type" | "state"> & {
+  type: T;
+  config: C;
+  state?: State<D> | null;
+};
+
+export const commandZ = z.object({
+  task: taskKeyZ,
+  type: z.string(),
+  key: z.string(),
+  args: z.record(z.unknown()).or(
+    z.string().transform((c) => {
+      if (c === "") return {};
+      return JSON.parse(c);
+    }),
+  ) as z.ZodType<UnknownRecord>,
+});
+
+export type StateObservable<D extends UnknownRecord = UnknownRecord> =
+  observe.ObservableAsyncCloseable<State<D>>;
+
+export const DeviceOntologyType = "task" as ontology.ResourceType;
+
+export const ontologyID = (key: TaskKey): ontology.ID =>
+  new ontology.ID({ type: DeviceOntologyType, key: key.toString() });

package/src/label/payload.ts

@@ -25,5 +25,7 @@ export const labelZ = z.object({
 
 export type Label = z.infer<typeof labelZ>;
 
+export const LabelOntologyType = "label" as ontology.ResourceType;
+
 export const ontologyID = (key: Key): ontology.ID =>
-  new ontology.ID({ type: "label", key });
+  new ontology.ID({ type: LabelOntologyType, key });

package/src/ontology/payload.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 { change,UnknownRecord } from "@synnaxlabs/x";
+import { change, UnknownRecord } from "@synnaxlabs/x";
 import { z } from "zod";
 
 export type ResourceChange = change.Change<ID, Resource>;
@@ -33,10 +33,15 @@ const resourceTypeZ = z.union([
   z.literal("rack"),
   z.literal("device"),
   z.literal("task"),
+  z.literal("policy"),
 ]);
 
 export type ResourceType = z.infer<typeof resourceTypeZ>;
 
+export const BuiltinOntologyType = "builtin" as ResourceType;
+export const ClusterOntologyType = "cluster" as ResourceType;
+export const NodeOntologyType = "node" as ResourceType;
+
 export const idZ = z.object({ type: resourceTypeZ, key: z.string() });
 
 export type IDPayload = z.infer<typeof idZ>;

package/src/ranger/payload.ts

@@ -11,6 +11,8 @@ import { TimeRange } from "@synnaxlabs/x/telem";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
+import { ontology } from "@/ontology";
+
 export const keyZ = z.string().uuid();
 export type Key = z.infer<typeof keyZ>;
 export type Name = string;
@@ -70,3 +72,12 @@ export const analyzeParams = (params: Params): ParamAnalysisResult => {
     actual: params,
   } as const as ParamAnalysisResult;
 };
+
+export const RangeOntologyType = "range" as ontology.ResourceType;
+export const RangeAliasOntologyType = "range-alias" as ontology.ResourceType;
+
+export const rangeOntologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: RangeOntologyType, key: key });
+
+export const rangeAliasOntologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: RangeAliasOntologyType, key: key });

package/src/setupspecs.ts

@@ -11,6 +11,8 @@ import Synnax, { type SynnaxProps } from "@/client";
 
 export const HOST = "localhost";
 export const PORT = 9090;
+const USERNAME = "synnax"
+const PASSWORD = "seldon"
 
 export const newClient = (...props: SynnaxProps[]): Synnax => {
   let _props = {};
@@ -18,8 +20,8 @@ export const newClient = (...props: SynnaxProps[]): Synnax => {
   return new Synnax({
     host: HOST,
     port: PORT,
-    username: "synnax",
-    password: "seldon",
+    username: USERNAME,
+    password: PASSWORD,
     ..._props,
   });
 };

package/src/signals/observable.ts

@@ -26,15 +26,17 @@ export const openObservable = async <K, V>(
   client: framer.Client,
   setChannel: channel.Key | channel.Name,
   deleteChannel: channel.Key | channel.Name,
-  ecd: Decoder<K, V>,
+  codec: Decoder<K, V>,
 ): Promise<Observable<K, V>> => {
   const stream = await client.openStreamer([setChannel, deleteChannel] as channel.Keys);
   const transform = (frame: framer.Frame): [Array<change.Change<K, V>>, boolean] => {
     const changes: Array<change.Change<K, V>> = [];
     if (deleteChannel != null)
-      changes.push(...frame.get(deleteChannel).series.flatMap((s) => ecd("delete", s)));
+      changes.push(
+        ...frame.get(deleteChannel).series.flatMap((s) => codec("delete", s)),
+      );
     if (setChannel != null)
-      changes.push(...frame.get(setChannel).series.flatMap((s) => ecd("set", s)));
+      changes.push(...frame.get(setChannel).series.flatMap((s) => codec("set", s)));
     return [changes, changes.length > 0];
   };
   return new framer.ObservableStreamer<Array<change.Change<K, V>>>(stream, transform);

package/src/transport.ts

@@ -28,9 +28,9 @@ export class Transport {
   constructor(url: URL, secure: boolean = false) {
     this.secure = secure;
     this.url = url.child(baseAPIEndpoint);
-    const ecd = new binary.JSONEncoderDecoder();
-    this.unary = new HTTPClient(this.url, ecd, this.secure);
-    this.stream = new WebSocketClient(this.url, ecd, this.secure);
+    const codec = new binary.JSONCodec();
+    this.unary = new HTTPClient(this.url, codec, this.secure);
+    this.stream = new WebSocketClient(this.url, codec, this.secure);
   }
 
   use(...middleware: Middleware[]): void {

package/src/user/client.ts

@@ -0,0 +1,37 @@
+// 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 { insecureCredentialsZ, tokenResponseZ } from "@/auth/auth";
+import { Payload } from "@/user/payload";
+
+const REGISTER_ENDPOINT = "/user/register";
+
+export class Client {
+  private readonly client: UnaryClient;
+
+  constructor(client: UnaryClient) {
+    this.client = client;
+  }
+
+  async register(username: string, password: string): Promise<Payload> {
+    const { user } = await sendRequired<
+      typeof insecureCredentialsZ,
+      typeof tokenResponseZ
+    >(
+      this.client,
+      REGISTER_ENDPOINT,
+      { username: username, password: password },
+      insecureCredentialsZ,
+      tokenResponseZ,
+    );
+    return user;
+  }
+}

package/src/user/external.ts

@@ -0,0 +1,11 @@
+// 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.
+
+export * from "@/user/client";
+export * from "@/user/payload";

package/src/user/index.ts

@@ -7,4 +7,4 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export * as user from "@/user/payload";
+export * as user from "@/user/external";

package/src/user/payload.ts

@@ -9,9 +9,20 @@
 
 import { z } from "zod";
 
+import { ontology } from "@/ontology";
+
+export const keyZ = z.string().uuid();
+
+export type Key = z.infer<typeof keyZ>;
+
 export const payloadZ = z.object({
   key: z.string(),
   username: z.string(),
 });
 
 export type Payload = z.infer<typeof payloadZ>;
+
+export const UserOntologyType = "user" as ontology.ResourceType;
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: UserOntologyType, key });

package/src/workspace/lineplot/payload.ts

@@ -10,6 +10,8 @@
 import { type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x/record";
 import { z } from "zod";
 
+import { ontology } from "@/ontology";
+
 export const keyZ = z.string().uuid();
 export type Key = z.infer<typeof keyZ>;
 export type Params = Key | Key[];
@@ -21,3 +23,8 @@ export const linePlotZ = z.object({
 });
 
 export type LinePlot = z.infer<typeof linePlotZ>;
+
+export const LineplotOntologyType = "lineplot" as ontology.ResourceType;
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: LineplotOntologyType, key: key });

package/src/workspace/payload.ts

@@ -10,6 +10,8 @@
 import { type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x/record";
 import { z } from "zod";
 
+import { ontology } from "@/ontology";
+
 export const keyZ = z.string().uuid();
 
 export type Key = z.infer<typeof keyZ>;
@@ -35,3 +37,8 @@ export const workspaceRemoteZ = workspaceZ.omit({ layout: true }).extend({
 });
 
 export type Workspace = z.infer<typeof workspaceZ>;
+
+export const WorkspaceOntologyType = "workspace" as ontology.ResourceType;
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: WorkspaceOntologyType, key: key });

package/src/workspace/schematic/payload.ts

@@ -10,6 +10,8 @@
 import { type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x/record";
 import { z } from "zod";
 
+import { ontology } from "@/ontology";
+
 export const keyZ = z.string().uuid();
 export type Key = z.infer<typeof keyZ>;
 export type Params = Key | Key[];
@@ -29,3 +31,8 @@ export const schematicRemoteZ = z.object({
 });
 
 export type Schematic = z.infer<typeof schematicZ>;
+
+export const SchematicOntologyType = "schematic" as ontology.ResourceType;
+
+export const ontologyID = (key: Key): ontology.ID =>
+  new ontology.ID({ type: SchematicOntologyType, key: key });

package/tsconfig.json

@@ -3,5 +3,7 @@
   "compilerOptions": {
     "baseUrl": ".",
   },
-  "include": ["src/**/*"]
-}
+  "include": [
+    "src/**/*"
+  ]
+}