@synnaxlabs/client 0.23.1 → 0.24.0

package/dist/ontology/payload.d.ts

@@ -14,28 +14,28 @@ export declare const idZ: z.ZodObject<{
     key: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     key: string;
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
 }, {
     key: string;
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
 }>;
 export type IDPayload = z.infer<typeof idZ>;
 export declare const stringIDZ: z.ZodEffects<z.ZodString, {
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     key: string;
 }, string>;
 export declare const crudeIDZ: z.ZodUnion<[z.ZodEffects<z.ZodString, {
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     key: string;
 }, string>, z.ZodObject<{
     type: z.ZodUnion<[z.ZodLiteral<"label">, z.ZodLiteral<"builtin">, z.ZodLiteral<"cluster">, z.ZodLiteral<"channel">, z.ZodLiteral<"node">, z.ZodLiteral<"group">, z.ZodLiteral<"range">, z.ZodLiteral<"range-alias">, z.ZodLiteral<"user">, z.ZodLiteral<"workspace">, z.ZodLiteral<"schematic">, z.ZodLiteral<"lineplot">, z.ZodLiteral<"rack">, z.ZodLiteral<"device">, z.ZodLiteral<"task">]>;
     key: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     key: string;
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
 }, {
     key: string;
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
 }>]>;
 export declare class ID {
     type: ResourceType;
@@ -44,20 +44,20 @@ export declare class ID {
     toString(): string;
     get payload(): z.infer<typeof idZ>;
     static readonly z: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodEffects<z.ZodString, {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         key: string;
     }, string>, z.ZodObject<{
         type: z.ZodUnion<[z.ZodLiteral<"label">, z.ZodLiteral<"builtin">, z.ZodLiteral<"cluster">, z.ZodLiteral<"channel">, z.ZodLiteral<"node">, z.ZodLiteral<"group">, z.ZodLiteral<"range">, z.ZodLiteral<"range-alias">, z.ZodLiteral<"user">, z.ZodLiteral<"workspace">, z.ZodLiteral<"schematic">, z.ZodLiteral<"lineplot">, z.ZodLiteral<"rack">, z.ZodLiteral<"device">, z.ZodLiteral<"task">]>;
         key: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>]>, z.ZodType<ID, z.ZodTypeDef, ID>]>, ID, string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>;
 }
 export declare const Root: ID;
@@ -79,12 +79,12 @@ export declare const schemaZ: z.ZodObject<{
         type: number;
     }>>;
 }, "strip", z.ZodTypeAny, {
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     fields: Record<string, {
         type: number;
     }>;
 }, {
-    type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+    type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     fields: Record<string, {
         type: number;
     }>;
@@ -92,20 +92,20 @@ export declare const schemaZ: z.ZodObject<{
 export type Schema = z.infer<typeof schemaZ>;
 export declare const resourceSchemaZ: z.ZodEffects<z.ZodObject<{
     id: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodEffects<z.ZodString, {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         key: string;
     }, string>, z.ZodObject<{
         type: z.ZodUnion<[z.ZodLiteral<"label">, z.ZodLiteral<"builtin">, z.ZodLiteral<"cluster">, z.ZodLiteral<"channel">, z.ZodLiteral<"node">, z.ZodLiteral<"group">, z.ZodLiteral<"range">, z.ZodLiteral<"range-alias">, z.ZodLiteral<"user">, z.ZodLiteral<"workspace">, z.ZodLiteral<"schematic">, z.ZodLiteral<"lineplot">, z.ZodLiteral<"rack">, z.ZodLiteral<"device">, z.ZodLiteral<"task">]>;
         key: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>]>, z.ZodType<ID, z.ZodTypeDef, ID>]>, ID, string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>;
     name: z.ZodString;
     schema: z.ZodNullable<z.ZodOptional<z.ZodObject<{
@@ -118,12 +118,12 @@ export declare const resourceSchemaZ: z.ZodEffects<z.ZodObject<{
             type: number;
         }>>;
     }, "strip", z.ZodTypeAny, {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         fields: Record<string, {
             type: number;
         }>;
     }, {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         fields: Record<string, {
             type: number;
         }>;
@@ -134,7 +134,7 @@ export declare const resourceSchemaZ: z.ZodEffects<z.ZodObject<{
     id: ID;
     data?: Record<string, unknown> | null | undefined;
     schema?: {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         fields: Record<string, {
             type: number;
         }>;
@@ -143,11 +143,11 @@ export declare const resourceSchemaZ: z.ZodEffects<z.ZodObject<{
     name: string;
     id: string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     };
     data?: Record<string, unknown> | null | undefined;
     schema?: {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         fields: Record<string, {
             type: number;
         }>;
@@ -157,7 +157,7 @@ export declare const resourceSchemaZ: z.ZodEffects<z.ZodObject<{
     id: ID;
     data?: Record<string, unknown> | null | undefined;
     schema?: {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         fields: Record<string, {
             type: number;
         }>;
@@ -167,11 +167,11 @@ export declare const resourceSchemaZ: z.ZodEffects<z.ZodObject<{
     name: string;
     id: string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     };
     data?: Record<string, unknown> | null | undefined;
     schema?: {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         fields: Record<string, {
             type: number;
         }>;
@@ -182,37 +182,37 @@ export type Resource<T extends UnknownRecord = UnknownRecord> = Omit<z.output<ty
 };
 export declare const relationshipSchemaZ: z.ZodObject<{
     from: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodEffects<z.ZodString, {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         key: string;
     }, string>, z.ZodObject<{
         type: z.ZodUnion<[z.ZodLiteral<"label">, z.ZodLiteral<"builtin">, z.ZodLiteral<"cluster">, z.ZodLiteral<"channel">, z.ZodLiteral<"node">, z.ZodLiteral<"group">, z.ZodLiteral<"range">, z.ZodLiteral<"range-alias">, z.ZodLiteral<"user">, z.ZodLiteral<"workspace">, z.ZodLiteral<"schematic">, z.ZodLiteral<"lineplot">, z.ZodLiteral<"rack">, z.ZodLiteral<"device">, z.ZodLiteral<"task">]>;
         key: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>]>, z.ZodType<ID, z.ZodTypeDef, ID>]>, ID, string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>;
     type: z.ZodString;
     to: z.ZodEffects<z.ZodUnion<[z.ZodUnion<[z.ZodEffects<z.ZodString, {
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
         key: string;
     }, string>, z.ZodObject<{
         type: z.ZodUnion<[z.ZodLiteral<"label">, z.ZodLiteral<"builtin">, z.ZodLiteral<"cluster">, z.ZodLiteral<"channel">, z.ZodLiteral<"node">, z.ZodLiteral<"group">, z.ZodLiteral<"range">, z.ZodLiteral<"range-alias">, z.ZodLiteral<"user">, z.ZodLiteral<"workspace">, z.ZodLiteral<"schematic">, z.ZodLiteral<"lineplot">, z.ZodLiteral<"rack">, z.ZodLiteral<"device">, z.ZodLiteral<"task">]>;
         key: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }, {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>]>, z.ZodType<ID, z.ZodTypeDef, ID>]>, ID, string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     }>;
 }, "strip", z.ZodTypeAny, {
     type: string;
@@ -222,11 +222,11 @@ export declare const relationshipSchemaZ: z.ZodObject<{
     type: string;
     from: string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     };
     to: string | ID | {
         key: string;
-        type: "channel" | "user" | "cluster" | "task" | "rack" | "device" | "label" | "builtin" | "node" | "group" | "range" | "range-alias" | "workspace" | "schematic" | "lineplot";
+        type: "label" | "builtin" | "cluster" | "channel" | "node" | "group" | "range" | "range-alias" | "user" | "workspace" | "schematic" | "lineplot" | "rack" | "device" | "task";
     };
 }>;
 export type Relationship = z.infer<typeof relationshipSchemaZ>;

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

@@ -1 +1 @@
-{"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,EAAO,KAAK,OAAO,EAAY,MAAM,kBAAkB,CAAC;AAsBzE,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"}
+{"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/examples/node/basicReadWrite.js

@@ -30,7 +30,7 @@ const timeChannel = await client.channels.create({
 });
 
 // Create a channel that will be used to store our data.
-const indexChannel = await client.channels.create({
+const dataChannel = await client.channels.create({
     name: "basic_read_write_data",
     isIndex: false,
     dataType: DataType.FLOAT32,
@@ -54,14 +54,14 @@ const data = Float32Array.from({ length: N_SAMPLES }, (_, i) => Math.sin(i / 100
 // otherwise writing the data will fail. Notice how we align the writes with the 'start'
 // timestamp.
 await timeChannel.write(start, time);
-await indexChannel.write(start, data);
+await dataChannel.write(start, data);
 
 // Define the time range to read the data back from
 const tr = new TimeRange(start, start.add(TimeSpan.milliseconds(N_SAMPLES)));
 
 // Read the data back. The order doesn't matter here.
 const readTime = await timeChannel.read(tr);
-const readData = await indexChannel.read(tr);
+const readData = await dataChannel.read(tr);
 
 // Print out some information.
 console.log({
@@ -73,4 +73,4 @@ console.log({
 });
 
 // Make sure to close the client when you're done.
-client.close();
+client.close();

package/examples/node/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "@synnaxlabs/client": "^0.20.0"
+        "@synnaxlabs/client": "^0.21.0"
       }
     },
     "node_modules/@grpc/grpc-js": {
@@ -3653,12 +3653,12 @@
       }
     },
     "node_modules/@synnaxlabs/client": {
-      "version": "0.20.0",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.20.0.tgz",
-      "integrity": "sha512-L4Qve63NTNmqdFiDlDy/rgM1yzAxkyaw6hf+SrsGLSb/u871Hwp/yUoUhYRpY1JjhvjL2N7YPXpr5Y+n8/y5iQ==",
+      "version": "0.21.0",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.21.0.tgz",
+      "integrity": "sha512-WZ5TQ7TaSZgE2AVQSVdj/4XX5mEIEr5fGLzrfI6kSi1vqm8l1Jo9nmpr/81AN8PLz1THMCd5lkz20qmSGtcx8g==",
       "dependencies": {
         "@synnaxlabs/freighter": "0.9.4",
-        "@synnaxlabs/x": "0.16.0",
+        "@synnaxlabs/x": "0.16.1",
         "async-mutex": "^0.4.1",
         "zod": "3.22.4"
       }
@@ -3692,9 +3692,9 @@
       }
     },
     "node_modules/@synnaxlabs/x": {
-      "version": "0.16.0",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.16.0.tgz",
-      "integrity": "sha512-7sJKLZfPR0I9Bpgfe3UYqiGoFhxQ7FgmsEXBwXggThbUdzEl8JsydSQfR6e4GC0OKZZVrGZc0gTdDeSdYQHCKw==",
+      "version": "0.16.1",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.16.1.tgz",
+      "integrity": "sha512-vIqspjkkOregeriSQotu56NQPuX8xLV/7usudYILS3tKLzOCQQ2nR2r3lkVLseSMeiNxw3nLeY+roH3KxK13pA==",
       "dependencies": {
         "async-mutex": "^0.4.1",
         "js-convert-case": "^4.2.0",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.23.1",
+  "version": "0.24.0",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -19,8 +19,8 @@
     "async-mutex": "^0.5.0",
     "nanoid": "^3.0.0",
     "zod": "3.23.8",
-    "@synnaxlabs/x": "0.23.0",
-    "@synnaxlabs/freighter": "0.23.0"
+    "@synnaxlabs/freighter": "0.24.0",
+    "@synnaxlabs/x": "0.24.0"
   },
   "devDependencies": {
     "@types/node": "^20.12.7",
@@ -30,8 +30,8 @@
     "vite": "5.2.11",
     "vitest": "^1.5.0",
     "@synnaxlabs/vite-plugin": "0.0.1",
-    "@synnaxlabs/tsconfig": "0.0.2",
-    "eslint-config-synnaxlabs": "0.0.1"
+    "eslint-config-synnaxlabs": "0.0.1",
+    "@synnaxlabs/tsconfig": "0.0.2"
   },
   "peerDependencies": {
     "zod": "^3.23.8"

package/src/auth/auth.ts

@@ -73,7 +73,7 @@ export class Client {
       }
       reqCtx.params.Authorization = `Bearer ${this.token}`;
       const [resCtx, err] = await next(reqCtx);
-      if (err instanceof InvalidTokenError && this.retryCount < MAX_RETRIES) {
+      if (InvalidTokenError.matches(err) && this.retryCount < MAX_RETRIES) {
         this.authenticated = false;
         this.authenticating = undefined;
         this.retryCount += 1;

package/src/channel/channel.spec.ts

@@ -246,14 +246,15 @@ describe("Channel", () => {
           dataType: DataType.FLOAT32,
         },
       ]);
+      // Retrieve channels here to ensure we check for cache invalidation
+      const initial = await client.channels.retrieve(channels.map((c) => c.key));
+      expect(initial[0].name).toEqual("test1");
+      expect(initial[1].name).toEqual("test2");
       await client.channels.rename(
-        [channels[0].key, channels[1].key],
+        channels.map((c) => c.key),
         ["test3", "test4"],
       );
-      const renamed = await client.channels.retrieve([
-        channels[0].key,
-        channels[1].key,
-      ]);
+      const renamed = await client.channels.retrieve(channels.map((c) => c.key));
       expect(renamed[0].name).toEqual("test3");
       expect(renamed[1].name).toEqual("test4");
     });

package/src/channel/client.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 { type UnaryClient } from "@synnaxlabs/freighter";
+import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 import {
   type CrudeDensity,
@@ -19,6 +19,7 @@ import {
   type TypedArray,
 } from "@synnaxlabs/x/telem";
 import { toArray } from "@synnaxlabs/x/toArray";
+import { z } from "zod";
 
 import {
   type Key,
@@ -39,6 +40,8 @@ import {
 import { type Writer } from "@/channel/writer";
 import { ValidationError } from "@/errors";
 import { type framer } from "@/framer";
+import { ontology } from "@/ontology";
+import { group } from "@/ontology/group";
 import { checkForMultipleOrNoResults } from "@/util/retrieve";
 
 interface CreateOptions {
@@ -150,6 +153,13 @@ export class Channel {
     });
   }
 
+  /***
+   * @returns the ontology ID of the channel
+   */
+  get ontologyID(): ontology.ID {
+    return new ontology.ID({ type: "channel", key: this.key.toString() });
+  }
+
   /**
    * Reads telemetry from the channel between the two timestamps.
    *
@@ -172,6 +182,14 @@ export class Channel {
   }
 }
 
+const RETRIEVE_GROUP_ENDPOINT = "/channel/retrieve-group";
+
+const retrieveGroupReqZ = z.object({});
+
+const retrieveGroupResZ = z.object({
+  group: group.groupZ,
+});
+
 /**
  * The core client class for executing channel operations against a Synnax
  * cluster. This class should not be instantiated directly, and instead should be used
@@ -382,4 +400,15 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
     const { frameClient } = this;
     return payloads.map((p) => new Channel({ ...p, frameClient }));
   }
+
+  async retrieveGroup(): Promise<group.Group> {
+    const res = await sendRequired(
+      this.client,
+      RETRIEVE_GROUP_ENDPOINT,
+      {},
+      retrieveGroupReqZ,
+      retrieveGroupResZ,
+    );
+    return new group.Group(res.group.name, res.group.key);
+  }
 }

package/src/channel/retriever.ts

@@ -103,7 +103,7 @@ export class ClusterRetriever implements Retriever {
 
 export class CacheRetriever implements Retriever {
   private readonly cache: Map<number, Payload>;
-  private readonly namesToKeys: Map<string, number>;
+  private readonly namesToKeys: Map<string, Set<number>>;
   private readonly wrapped: Retriever;
 
   constructor(wrapped: Retriever) {
@@ -128,27 +128,77 @@ export class CacheRetriever implements Retriever {
     const results: Payload[] = [];
     const toFetch: KeysOrNames = [];
     normalized.forEach((keyOrName) => {
-      const c = this.getFromCache(keyOrName);
-      if (c != null) results.push(c);
+      const c = this.get(keyOrName);
+      if (c != null) results.push(...c);
       else toFetch.push(keyOrName as never);
     });
     if (toFetch.length === 0) return results;
     const fetched = await this.wrapped.retrieve(toFetch, options);
-    this.updateCache(fetched);
+    this.set(fetched);
     return results.concat(fetched);
   }
 
-  private updateCache(channels: Payload[]): void {
+  delete(channels: Params): void {
+    const { variant, normalized } = analyzeChannelParams(channels);
+    if (variant === "names")
+      (normalized as string[]).forEach((name) => {
+        const keys = this.namesToKeys.get(name);
+        if (keys == null) return;
+        keys.forEach((k) => this.cache.delete(k));
+        this.namesToKeys.delete(name);
+      });
+    else
+      (normalized as number[]).forEach((key) => {
+        const channel = this.cache.get(key);
+        if (channel == null) return;
+        this.cache.delete(key);
+        this.namesToKeys.delete(channel.name);
+      });
+  }
+
+  rename(keys: Key[], names: string[]): void {
+    keys.forEach((key, i) => {
+      const name = names[i];
+      const ch = this.cache.get(key);
+      if (ch == null) return;
+      this.cache.delete(key);
+      const keys = this.namesToKeys.get(ch.name);
+      if (keys != null) {
+        keys.delete(key);
+        if (keys.size === 0) this.namesToKeys.delete(ch.name);
+      }
+      ch.name = name;
+      this.cache.set(key, ch);
+      const newKeys = this.namesToKeys.get(name);
+      if (newKeys == null) this.namesToKeys.set(name, new Set([key]));
+      else newKeys.add(key);
+    });
+  }
+
+  set(channels: Payload[]): void {
     channels.forEach((channel) => {
       this.cache.set(channel.key, channel);
-      this.namesToKeys.set(channel.name, channel.key);
+      const keys = this.namesToKeys.get(channel.name);
+      if (keys == null) this.namesToKeys.set(channel.name, new Set([channel.key]));
+      else keys.add(channel.key);
     });
   }
 
-  private getFromCache(channel: KeyOrName): Payload | undefined {
-    const key = typeof channel === "number" ? channel : this.namesToKeys.get(channel);
-    if (key == null) return undefined;
-    return this.cache.get(key);
+  private get(channel: KeyOrName): Payload[] | undefined {
+    if (typeof channel === "number") {
+      const ch = this.cache.get(channel);
+      if (ch == null) return undefined;
+      return [ch];
+    }
+    const keys = this.namesToKeys.get(channel);
+    if (keys == null) return undefined;
+    const channels: Payload[] = [];
+    keys.forEach((key) => {
+      const ch = this.cache.get(key);
+      if (ch != null) channels.push(ch);
+    });
+    if (channels.length === 0) return undefined;
+    return channels;
   }
 }
 

package/src/channel/writer.ts

@@ -18,6 +18,7 @@ import {
   type Payload,
   payload,
 } from "@/channel/payload";
+import { CacheRetriever } from "@/channel/retriever";
 
 const createReqZ = z.object({ channels: newPayload.array() });
 const createResZ = z.object({ channels: payload.array() });
@@ -43,21 +44,20 @@ export type RenameProps = z.input<typeof renameReqZ>;
 
 export class Writer {
   private readonly client: UnaryClient;
+  private readonly cache: CacheRetriever;
 
-  constructor(client: UnaryClient) {
+  constructor(client: UnaryClient, cache: CacheRetriever) {
     this.client = client;
+    this.cache = cache;
   }
 
   async create(channels: NewPayload[]): Promise<Payload[]> {
-    return (
-      await sendRequired<typeof createReqZ, typeof createResZ>(
-        this.client,
-        CREATE_ENDPOINT,
-        { channels },
-        createReqZ,
-        createResZ,
-      )
-    ).channels;
+    const { channels: created } = await sendRequired<
+      typeof createReqZ,
+      typeof createResZ
+    >(this.client, CREATE_ENDPOINT, { channels }, createReqZ, createResZ);
+    this.cache.set(created);
+    return created;
   }
 
   async delete(props: DeleteProps): Promise<void> {
@@ -68,6 +68,8 @@ export class Writer {
       deleteReqZ,
       deleteResZ,
     );
+    if (props.keys != null) this.cache.delete(props.keys);
+    if (props.names != null) this.cache.delete(props.names);
   }
 
   async rename(keys: Key[], names: string[]): Promise<void> {
@@ -78,5 +80,6 @@ export class Writer {
       renameReqZ,
       renameResZ,
     );
+    this.cache.rename(keys, names);
   }
 }