@synnaxlabs/client 0.15.0 → 0.15.2

package/src/hardware/device/client.ts

@@ -1,7 +1,16 @@
-import { toArray } from "@synnaxlabs/x";
+// 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 { AsyncTermSearcher, toArray } from "@synnaxlabs/x";
 
 import { type framer } from "@/framer";
-import { type Device, deviceZ } from "@/hardware/device/payload";
+import { type Device, deviceZ, DeviceKey } from "@/hardware/device/payload";
 import { type Retriever } from "@/hardware/device/retriever";
 import { type Writer } from "@/hardware/device/writer";
 import { signals } from "@/signals";
@@ -9,7 +18,7 @@ import { signals } from "@/signals";
 const DEVICE_SET_NAME = "sy_device_set";
 const DEVICE_DELETE_NAME = "sy_device_delete";
 
-export class Client {
+export class Client implements AsyncTermSearcher<string, DeviceKey, Device>{
   private readonly retriever: Retriever;
   private readonly writer: Writer;
   private readonly frameClient: framer.Client;
@@ -33,6 +42,16 @@ export class Client {
     return Array.isArray(keys) ? res : res[0];
   }
 
+  async search(term: string): Promise<Device[]> {
+    const res = await this.retriever.search(term);
+    return res;
+  }
+
+  async page(offset: number, limit: number): Promise<Device[]> {
+    const res = await this.retriever.page(offset, limit);
+    return res;
+  }
+
   async delete(keys: string[]): Promise<void> {
     await this.writer.delete(keys);
   }

package/src/hardware/device/device.spec.ts

@@ -1,3 +1,12 @@
+// 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 { describe, expect, it } from "vitest";
 
 import { newClient } from "@/setupspecs";

package/src/hardware/device/external.ts

@@ -1,3 +1,12 @@
+// 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/device/client";
 export * from "@/hardware/device/retriever";
 export * from "@/hardware/device/writer";

package/src/hardware/device/index.ts

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

package/src/hardware/device/payload.ts

@@ -1,3 +1,12 @@
+// 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 { z } from "zod";
 
 import { rackKeyZ } from "@/hardware/rack/payload";

package/src/hardware/device/retriever.ts

@@ -11,11 +11,15 @@ import { type UnaryClient, sendRequired } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import { type Device, deviceKeyZ, deviceZ } from "@/hardware/device/payload";
+import { AsyncTermSearcher } from "@synnaxlabs/x";
 
 const RETRIEVE_ENDPOINT = "/hardware/device/retrieve";
 
 const retrieveDeviceReqZ = z.object({
-  keys: deviceKeyZ.array(),
+  search: z.string().optional(),
+  limit: z.number().optional(),
+  offset: z.number().optional(),
+  keys: deviceKeyZ.array().optional(),
 });
 
 const retrieveDeviceResZ = z.object({
@@ -29,6 +33,23 @@ export class Retriever {
     this.client = client;
   }
 
+  async search(term: string): Promise<Device[]> {
+    const res = await sendRequired<
+      typeof retrieveDeviceReqZ,
+      typeof retrieveDeviceResZ
+    >(this.client, RETRIEVE_ENDPOINT, { keys: [term] }, retrieveDeviceResZ);
+    return res.devices;
+  }
+
+  async page(offset: number, limit: number): Promise<Device[]> {
+    const res = await sendRequired<
+      typeof retrieveDeviceReqZ,
+      typeof retrieveDeviceResZ
+    >(this.client, RETRIEVE_ENDPOINT, { offset, limit }, retrieveDeviceResZ);
+    return res.devices;
+  }
+  
+
   async retrieve(keys: string[]): Promise<Device[]> {
     const res = await sendRequired<
       typeof retrieveDeviceReqZ,

package/src/hardware/device/writer.ts

@@ -1,3 +1,12 @@
+// 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 { type UnaryClient, sendRequired } from "@synnaxlabs/freighter";
 import { z } from "zod";
 

package/src/hardware/external.ts

@@ -7,5 +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 * from "@/hardware/rack";
 export * from "@/hardware/client";

package/src/hardware/rack/client.ts

@@ -8,14 +8,15 @@
 // included in the file licenses/APL.txt.
 
 import { type framer } from "@/framer";
-import { type NewRack, type RackPayload } from "@/hardware/rack/payload";
+import { RackKey, type NewRack, type RackPayload } from "@/hardware/rack/payload";
 import { type Retriever } from "@/hardware/rack/retriever";
 import { type Writer } from "@/hardware/rack/writer";
 import { type NewTask, type Task } from "@/hardware/task/payload";
 import { type Retriever as TaskRetriever } from "@/hardware/task/retriever";
 import { type Writer as TaskWriter } from "@/hardware/task/writer";
+import { AsyncTermSearcher, toArray } from "@synnaxlabs/x";
 
-export class Client {
+export class Client implements AsyncTermSearcher<string, RackKey, Rack> {
   private readonly retriever: Retriever;
   private readonly writer: Writer;
   private readonly frameClient: framer.Client;
@@ -41,8 +42,23 @@ export class Client {
     return this.sugar(res)[0];
   }
 
-  async retrieve(key: number): Promise<Rack> {
-    const res = await this.retriever.retrieve([key]);
+  async search(term: string): Promise<Rack[]> {
+    const res = await this.retriever.search(term);
+    return this.sugar(res);
+  }
+
+  async page(offset: number, limit: number): Promise<Rack[]> {
+    const res = await this.retriever.page(offset, limit);
+    return this.sugar(res);
+  }
+
+  async retrieve(key: RackKey): Promise<Rack>;
+
+  async retrieve(keys: RackKey[]): Promise<Rack[]>;
+
+  async retrieve(key: RackKey | RackKey[]): Promise<Rack | Rack[]> {
+    const res = await this.retriever.retrieve(toArray(key));
+    if (Array.isArray(key)) return this.sugar(res);
     return this.sugar(res)[0];
   }
 

package/src/hardware/rack/external.ts

@@ -1,3 +1,12 @@
+// 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/rack/client";
 export * from "@/hardware/rack/writer";
-export * from "@/hardware/rack/retriever";
+export * from "@/hardware/rack/retriever";

package/src/hardware/rack/index.ts

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

package/src/hardware/rack/payload.ts

@@ -1,3 +1,12 @@
+// 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 { z } from "zod";
 
 
@@ -14,4 +23,4 @@ export type RackPayload = z.infer<typeof rackZ>;
 
 export const newRackZ = rackZ.partial({ key: true });
 
-export type NewRack = z.input<typeof newRackZ>;
+export type NewRack = z.input<typeof newRackZ>;

package/src/hardware/rack/rack.spec.ts

@@ -1,3 +1,12 @@
+// 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 { describe, expect, it } from "vitest";
 
 import { newClient } from "@/setupspecs";

package/src/hardware/rack/retriever.ts

@@ -1,3 +1,12 @@
+// 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 { type UnaryClient, sendRequired } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
@@ -6,13 +15,17 @@ import { rackKeyZ, rackZ, type RackPayload } from "@/hardware/rack/payload";
 const RETRIEVE_ENDPOINT = "/hardware/rack/retrieve";
 
 const retrieveRackReqZ = z.object({
-  keys: rackKeyZ.array(),
+  keys: rackKeyZ.array().optional(),
+  search: z.string().optional(),
+  offset: z.number().optional(),
+  limit: z.number().optional(),
 });
 
 const retrieveRackResZ = z.object({
   racks: rackZ.array(),
 });
 
+
 export class Retriever {
   private readonly client: UnaryClient;
 
@@ -20,6 +33,26 @@ export class Retriever {
     this.client = client;
   }
 
+  async page(offset: number, limit: number): Promise<RackPayload[]> {
+    const res = await sendRequired<typeof retrieveRackReqZ, typeof retrieveRackResZ>(
+      this.client,
+      RETRIEVE_ENDPOINT,
+      { offset, limit },
+      retrieveRackResZ,
+    );
+    return res.racks;
+  }
+
+  async search(term: string): Promise<RackPayload[]> {
+    const res = await sendRequired<typeof retrieveRackReqZ, typeof retrieveRackResZ>(
+      this.client,
+      RETRIEVE_ENDPOINT,
+      { search: term },
+      retrieveRackResZ,
+    );
+    return res.racks;
+  }
+
   async retrieve(keys: number[]): Promise<RackPayload[]> {
     const res = await sendRequired<typeof retrieveRackReqZ, typeof retrieveRackResZ>(
       this.client,

package/src/hardware/task/client.ts

@@ -7,13 +7,13 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { toArray } from "@synnaxlabs/x";
+import { AsyncTermSearcher, toArray } from "@synnaxlabs/x";
 
-import { type NewTask, type Task } from "@/hardware/task/payload";
+import { TaskKey, type NewTask, type Task } from "@/hardware/task/payload";
 import { type RetrieveRequest, type Retriever } from "@/hardware/task/retriever";
 import { type Writer } from "@/hardware/task/writer";
 
-export class Client {
+export class Client implements AsyncTermSearcher<string, TaskKey, Task> {
   private readonly retriever: Retriever;
   private readonly writer: Writer;
 
@@ -22,6 +22,16 @@ export class Client {
     this.writer = writer;
   }
 
+  async search(term: string): Promise<Task[]> {
+    const res = await this.retriever.search(term);
+    return res;
+  }
+
+  async page(offset: number, limit: number): Promise<Task[]> {
+    const res = await this.retriever.page(offset, limit);
+    return res;
+  }
+
   async create(task: NewTask): Promise<Task> {
     const res = await this.writer.create([task]);
     return res[0];

package/src/hardware/task/payload.ts

@@ -15,6 +15,8 @@ export const taskKeyZ = z
   .or(z.number())
   .transform((k) => k.toString());
 
+export type TaskKey = z.infer<typeof taskKeyZ>;
+
 export const taskZ = z.object({
   key: taskKeyZ,
   name: z.string(),

package/src/hardware/task/retriever.ts

@@ -16,6 +16,8 @@ import { type Task, taskZ } from "@/hardware/task/payload";
 const retrieveReqZ = z.object({
   rack: rackKeyZ.optional(),
   keys: z.string().array().optional(),
+  offset: z.number().optional(),
+  limit: z.number().optional(),
 });
 
 const rerieveResS = z.object({
@@ -42,4 +44,24 @@ export class Retriever {
     );
     return res.tasks;
   }
+
+  async search(term: string): Promise<Task[]> {
+    const res = await sendRequired<typeof retrieveReqZ, typeof rerieveResS>(
+      this.client,
+      RETRIEVE_ENDPOINT,
+      { keys: [term] },
+      rerieveResS,
+    );
+    return res.tasks;
+  }
+
+  async page(offset: number, limit: number): Promise<Task[]> {
+    const res = await sendRequired<typeof retrieveReqZ, typeof rerieveResS>(
+      this.client,
+      RETRIEVE_ENDPOINT,
+      { offset, limit },
+      rerieveResS,
+    );
+    return res.tasks;
+  }
 }

package/src/index.ts

@@ -52,3 +52,6 @@ export { workspace } from "@/workspace";
 export { ranger } from "@/ranger";
 export { label } from "@/label";
 export { hardware } from "@/hardware";
+export { rack } from "@/hardware/rack";
+export { task } from "@/hardware/task";
+export { device } from "@/hardware/device";