@synnaxlabs/client 0.13.6 → 0.14.0

package/dist/connection/checker.d.ts

@@ -27,6 +27,7 @@ export declare class Checker {
     private readonly _state;
     private readonly pollFrequency;
     private readonly client;
+    private readonly name?;
     private interval?;
     private readonly onChangeHandlers;
     static readonly connectionStateZ: z.ZodObject<{
@@ -50,7 +51,7 @@ export declare class Checker {
      * @param pollFreq - The frequency at which to poll the cluster for
      *   connectivity information.
      */
-    constructor(client: UnaryClient, pollFreq?: TimeSpan);
+    constructor(client: UnaryClient, pollFreq?: TimeSpan, name?: string);
     /** Stops the connectivity client from polling the cluster for connectivity */
     stopChecking(): void;
     /**

package/dist/connection/index.d.ts

@@ -1 +1 @@
-export * as connection from '../connection/checker';
+export * as connection from './checker';

package/dist/control/external.d.ts

@@ -1,2 +1,2 @@
-export * from '../control/authority';
-export * from '../control/state';
+export * from './authority';
+export * from './state';

package/dist/control/index.d.ts

@@ -1 +1 @@
-export * as control from '../control/external';
+export * as control from './external';

package/dist/control/state.d.ts

@@ -1,7 +1,7 @@
 import { type Destructor, observe } from "@synnaxlabs/x";
 import { z } from "zod";
 import { type Key as ChannelKey } from '../channel/payload';
-import { Authority } from '../control/authority';
+import { Authority } from './authority';
 import { type Client as FrameClient } from '../framer/client';
 export declare const subjectZ: z.ZodObject<{
     name: z.ZodString;

package/dist/framer/adapter.d.ts

@@ -1,6 +1,6 @@
 import { type Key, type Params } from '../channel/payload';
 import { type Retriever } from '../channel/retriever';
-import { type Frame } from '../framer/frame';
+import { type Frame } from './frame';
 export declare class BackwardFrameAdapter {
     private adapter;
     retriever: Retriever;

package/dist/framer/client.d.ts

@@ -2,10 +2,10 @@ import { type StreamClient } from "@synnaxlabs/freighter";
 import { type NativeTypedArray, type Series, type TimeRange, type CrudeTimeStamp, TimeStamp } from "@synnaxlabs/x";
 import { type KeyOrName, type Params } from '../channel/payload';
 import { type Retriever } from '../channel/retriever';
-import { Frame } from '../framer/frame';
-import { Iterator } from '../framer/iterator';
-import { Streamer } from '../framer/streamer';
-import { Writer, type WriterConfig } from '../framer/writer';
+import { Frame } from './frame';
+import { Iterator } from './iterator';
+import { Streamer } from './streamer';
+import { Writer, type WriterConfig } from './writer';
 export declare class Client {
     private readonly stream;
     private readonly retriever;

package/dist/framer/external.d.ts

@@ -1,5 +1,5 @@
-export * from '../framer/client';
-export * from '../framer/frame';
-export * from '../framer/iterator';
-export * from '../framer/streamer';
-export * from '../framer/writer';
+export * from './client';
+export * from './frame';
+export * from './iterator';
+export * from './streamer';
+export * from './writer';

package/dist/framer/index.d.ts

@@ -1 +1 @@
-export * as framer from '../framer/external';
+export * as framer from './external';

package/dist/framer/iterator.d.ts

@@ -2,7 +2,7 @@ import { type StreamClient } from "@synnaxlabs/freighter";
 import { type CrudeTimeSpan, type CrudeTimeStamp, TimeRange, TimeSpan } from "@synnaxlabs/x";
 import { type Params } from '../channel/payload';
 import { type Retriever } from '../channel/retriever';
-import { Frame } from '../framer/frame';
+import { Frame } from './frame';
 export declare const AUTO_SPAN: TimeSpan;
 /**
  * Used to iterate over a clusters telemetry in time-order. It should not be

package/dist/framer/streamer.d.ts

@@ -2,7 +2,7 @@ import { type StreamClient } from "@synnaxlabs/freighter";
 import { type CrudeTimeStamp } from "@synnaxlabs/x";
 import { type Key, type Params } from '../channel/payload';
 import { type Retriever } from '../channel/retriever';
-import { Frame } from '../framer/frame';
+import { Frame } from './frame';
 export declare class Streamer implements AsyncIterator<Frame>, AsyncIterable<Frame> {
     private readonly stream;
     private readonly adapter;

package/dist/framer/writer.d.ts

@@ -5,7 +5,7 @@ import { type Key, type KeyOrName, type Params } from '../channel/payload';
 import { type Retriever } from '../channel/retriever';
 import { Authority } from '../control/authority';
 import { type Subject as ControlSubject } from '../control/state';
-import { type CrudeFrame } from '../framer/frame';
+import { type CrudeFrame } from './frame';
 declare enum Command {
     Open = 0,
     Write = 1,

package/dist/hardware/client.d.ts

@@ -0,0 +1,9 @@
+import { type device } from './device';
+import { type rack } from './rack';
+import { type task } from './task';
+export declare class Client {
+    readonly tasks: task.Client;
+    readonly racks: rack.Client;
+    readonly devices: device.Client;
+    constructor(tasks: task.Client, racks: rack.Client, devices: device.Client);
+}

package/dist/hardware/device/client.d.ts

@@ -0,0 +1,16 @@
+import { type framer } from '../../framer';
+import { type Device } from './payload';
+import { type Retriever } from './retriever';
+import { type Writer } from './writer';
+import { signals } from '../../signals';
+export declare class Client {
+    private readonly retriever;
+    private readonly writer;
+    private readonly frameClient;
+    constructor(retriever: Retriever, writer: Writer, frameClient: framer.Client);
+    create(device: Device): Promise<Device>;
+    retrieve(key: string): Promise<Device>;
+    retrieve(keys: string[]): Promise<Device[]>;
+    delete(keys: string[]): Promise<void>;
+    openDeviceTracker(): Promise<signals.Observable<string, Device>>;
+}

package/dist/hardware/device/device.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hardware/device/external.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './retriever';
+export * from './writer';

package/dist/hardware/device/index.d.ts

@@ -0,0 +1 @@
+export * as device from './external';

package/dist/hardware/device/payload.d.ts

@@ -0,0 +1,29 @@
+import { z } from "zod";
+export declare const deviceKeyZ: z.ZodString;
+export declare const deviceZ: z.ZodObject<{
+    key: z.ZodString;
+    rack: z.ZodNumber;
+    name: z.ZodString;
+    make: z.ZodString;
+    model: z.ZodString;
+    location: z.ZodString;
+    properties: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    key: string;
+    rack: number;
+    make: string;
+    model: string;
+    location: string;
+    properties: string;
+}, {
+    name: string;
+    key: string;
+    rack: number;
+    make: string;
+    model: string;
+    location: string;
+    properties: string;
+}>;
+export type Device = z.infer<typeof deviceZ>;
+export type DeviceKey = z.infer<typeof deviceKeyZ>;

package/dist/hardware/device/retriever.d.ts

@@ -0,0 +1,7 @@
+import { type UnaryClient } from "@synnaxlabs/freighter";
+import { type Device } from './payload';
+export declare class Retriever {
+    private readonly client;
+    constructor(client: UnaryClient);
+    retrieve(keys: string[]): Promise<Device[]>;
+}

package/dist/hardware/device/writer.d.ts

@@ -0,0 +1,8 @@
+import { type UnaryClient } from "@synnaxlabs/freighter";
+import { type Device } from './payload';
+export declare class Writer {
+    private readonly client;
+    constructor(client: UnaryClient);
+    create(devices: Device[]): Promise<Device[]>;
+    delete(keys: string[]): Promise<void>;
+}

package/dist/hardware/external.d.ts

@@ -0,0 +1,2 @@
+export * from './rack';
+export * from './client';

package/dist/hardware/index.d.ts

@@ -0,0 +1 @@
+export * as hardware from './external';

package/dist/hardware/rack/client.d.ts

@@ -0,0 +1,29 @@
+import { type framer } from '../../framer';
+import { type NewRack } from './payload';
+import { type Retriever } from './retriever';
+import { type Writer } from './writer';
+import { type NewTask, type Task } from '../task/payload';
+import { type Retriever as TaskRetriever } from '../task/retriever';
+import { type Writer as TaskWriter } from '../task/writer';
+export declare class Client {
+    private readonly retriever;
+    private readonly writer;
+    private readonly frameClient;
+    private readonly taskWriter;
+    private readonly taskRetriever;
+    constructor(retriever: Retriever, writer: Writer, frameClient: framer.Client, taskWriter: TaskWriter, taskRetriever: TaskRetriever);
+    create(rack: NewRack): Promise<Rack>;
+    retrieve(key: number): Promise<Rack>;
+    private sugar;
+}
+export declare class Rack {
+    key: number;
+    name: string;
+    private readonly writer;
+    private readonly retriever;
+    constructor(key: number, name: string, _writer: TaskWriter, _retriever: TaskRetriever);
+    listTasks(): Promise<Task[]>;
+    retrieveTasks(): Promise<Task[]>;
+    createTask(task: NewTask): Promise<Task>;
+    deleteTask(task: bigint): Promise<void>;
+}

package/dist/hardware/rack/external.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './writer';
+export * from './retriever';

package/dist/hardware/rack/index.d.ts

@@ -0,0 +1 @@
+export * as rack from './external';

package/dist/hardware/rack/payload.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+export declare const rackKeyZ: z.ZodNumber;
+export type RackKey = z.infer<typeof rackKeyZ>;
+export declare const rackZ: z.ZodObject<{
+    key: z.ZodNumber;
+    name: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    key: number;
+}, {
+    name: string;
+    key: number;
+}>;
+export type RackPayload = z.infer<typeof rackZ>;
+export declare const newRackZ: z.ZodObject<{
+    name: z.ZodString;
+    key: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    key?: number | undefined;
+}, {
+    name: string;
+    key?: number | undefined;
+}>;
+export type NewRack = z.input<typeof newRackZ>;

package/dist/hardware/rack/rack.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hardware/rack/retriever.d.ts

@@ -0,0 +1,7 @@
+import { type UnaryClient } from "@synnaxlabs/freighter";
+import { type RackPayload } from './payload';
+export declare class Retriever {
+    private readonly client;
+    constructor(client: UnaryClient);
+    retrieve(keys: number[]): Promise<RackPayload[]>;
+}

package/dist/hardware/rack/writer.d.ts

@@ -0,0 +1,8 @@
+import { NewRack, RackPayload } from './payload';
+import { UnaryClient } from "@synnaxlabs/freighter";
+export declare class Writer {
+    private readonly client;
+    constructor(client: UnaryClient);
+    create(racks: NewRack[]): Promise<RackPayload[]>;
+    delete(keys: number[]): Promise<void>;
+}

package/dist/hardware/task/client.d.ts

@@ -0,0 +1,12 @@
+import { type NewTask, type Task } from './payload';
+import { type Retriever } from './retriever';
+import { type Writer } from './writer';
+export declare class Client {
+    private readonly retriever;
+    private readonly writer;
+    constructor(retriever: Retriever, writer: Writer);
+    create(task: NewTask): Promise<Task>;
+    retrieve(rack: number): Promise<Task[]>;
+    retrieve(keys: string[]): Promise<Task[]>;
+    retrieve(key: string): Promise<Task>;
+}

package/dist/hardware/task/external.d.ts

@@ -0,0 +1,3 @@
+export * from './client';
+export * from './retriever';
+export * from './writer';

package/dist/hardware/task/index.d.ts

@@ -0,0 +1 @@
+export * as task from './external';

package/dist/hardware/task/payload.d.ts

@@ -0,0 +1,40 @@
+import { type UnknownRecord } from "@synnaxlabs/x";
+import { z } from "zod";
+export declare const taskKeyZ: z.ZodEffects<z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, string, number | bigint>;
+export declare const taskZ: z.ZodObject<{
+    key: z.ZodEffects<z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, string, number | bigint>;
+    name: z.ZodString;
+    type: z.ZodString;
+    config: z.ZodType<Partial<Record<import("@synnaxlabs/x").Key, unknown>>, z.ZodTypeDef, Partial<Record<import("@synnaxlabs/x").Key, unknown>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    key: string;
+    type: string;
+    config: Partial<Record<import("@synnaxlabs/x").Key, unknown>>;
+}, {
+    name: string;
+    key: number | bigint;
+    type: string;
+    config: Partial<Record<import("@synnaxlabs/x").Key, unknown>>;
+}>;
+export declare const newTaskZ: z.ZodObject<{
+    name: z.ZodString;
+    type: z.ZodString;
+    key: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodUnion<[z.ZodBigInt, z.ZodNumber]>, string, number | bigint>, string, number | bigint>>;
+    config: z.ZodEffects<z.ZodUnknown, string, unknown>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    type: string;
+    config: string;
+    key?: string | undefined;
+}, {
+    name: string;
+    type: string;
+    key?: number | bigint | undefined;
+    config?: unknown;
+}>;
+export type NewTask = z.input<typeof newTaskZ>;
+export type Task<T extends string = string, C extends UnknownRecord = UnknownRecord> = Omit<z.infer<typeof taskZ>, "config" | "type"> & {
+    type: T;
+    config: C;
+};

package/dist/hardware/task/retriever.d.ts

@@ -0,0 +1,20 @@
+import { type UnaryClient } from "@synnaxlabs/freighter";
+import { z } from "zod";
+import { type Task } from './payload';
+declare const retrieveReqZ: z.ZodObject<{
+    rack: z.ZodOptional<z.ZodNumber>;
+    keys: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    rack?: number | undefined;
+    keys?: string[] | undefined;
+}, {
+    rack?: number | undefined;
+    keys?: string[] | undefined;
+}>;
+export type RetrieveRequest = z.infer<typeof retrieveReqZ>;
+export declare class Retriever {
+    private readonly client;
+    constructor(client: UnaryClient);
+    retrieve(params: RetrieveRequest): Promise<Task[]>;
+}
+export {};

package/dist/hardware/task/task.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/hardware/task/writer.d.ts

@@ -0,0 +1,8 @@
+import { type UnaryClient } from "@synnaxlabs/freighter";
+import { type NewTask, type Task } from './payload';
+export declare class Writer {
+    private readonly client;
+    constructor(client: UnaryClient);
+    create(tasks: NewTask[]): Promise<Task[]>;
+    delete(keys: bigint[]): Promise<void>;
+}

package/dist/index.d.ts

@@ -14,3 +14,4 @@ export type { NativeTypedArray, CrudeDataType, CrudeDensity, CrudeRate, CrudeSiz
 export { workspace } from './workspace';
 export { ranger } from './ranger';
 export { label } from './label';
+export { hardware } from './hardware';

package/dist/label/client.d.ts

@@ -1,8 +1,8 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
 import { type AsyncTermSearcher } from "@synnaxlabs/x";
 import { type framer } from '../framer';
-import { type Key, type Label } from '../label/payload';
-import { type NewLabelPayload } from '../label/writer';
+import { type Key, type Label } from './payload';
+import { type NewLabelPayload } from './writer';
 import { type ontology } from '../ontology';
 import { signals } from '../signals';
 export declare class Client implements AsyncTermSearcher<string, Key, Label> {

package/dist/label/external.d.ts

@@ -1,4 +1,4 @@
-export * from '../label/client';
-export * from '../label/writer';
-export * from '../label/retriever';
-export * from '../label/payload';
+export * from './client';
+export * from './writer';
+export * from './retriever';
+export * from './payload';

package/dist/label/index.d.ts

@@ -1 +1 @@
-export * as label from '../label/external';
+export * as label from './external';

package/dist/label/retriever.d.ts

@@ -1,5 +1,5 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
-import { type Label, type Params } from '../label/payload';
+import { type Label, type Params } from './payload';
 import { ontology } from '../ontology';
 export declare class Retriever {
     private static readonly ENDPOINT;

package/dist/label/writer.d.ts

@@ -1,6 +1,6 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
-import { type Key, type Label } from '../label/payload';
+import { type Key, type Label } from './payload';
 import { ontology } from '../ontology';
 export declare const newLabelPayloadZ: z.ZodObject<{
     name: z.ZodString;

package/dist/ontology/client.d.ts

@@ -1,10 +1,10 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
 import { type AsyncTermSearcher } from "@synnaxlabs/x";
 import { type Client as FrameClient } from '../framer/client';
-import { group } from '../ontology/group';
-import { type ID, type Resource } from '../ontology/payload';
-import { Retriever } from '../ontology/retriever';
-import { ChangeTracker } from '../ontology/signals';
+import { group } from './group';
+import { type ID, type Resource } from './payload';
+import { Retriever } from './retriever';
+import { ChangeTracker } from './signals';
 /** The core client class for executing queries against a Synnax cluster ontology */
 export declare class Client implements AsyncTermSearcher<string, string, Resource> {
     groups: group.Client;

package/dist/ontology/external.d.ts

@@ -1,3 +1,3 @@
-export * from '../ontology/client';
-export * from '../ontology/payload';
-export * from '../ontology/signals';
+export * from './client';
+export * from './payload';
+export * from './signals';

package/dist/ontology/group/client.d.ts

@@ -1,6 +1,6 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
-import { type ID } from '../../ontology/payload';
-import { Group } from "./group";
+import { type ID } from '../payload';
+import { Group } from './group';
 export declare class Client {
     private readonly creator;
     constructor(unary: UnaryClient);

package/dist/ontology/group/external.d.ts

@@ -1,2 +1,2 @@
-export * from '../../ontology/group/group';
-export * from '../../ontology/group/client';
+export * from './group';
+export * from './client';

package/dist/ontology/group/group.d.ts

@@ -1,4 +1,4 @@
-import { ontology } from '../../ontology';
+import { ontology } from '..';
 export declare class Group {
     key: string;
     name: string;

package/dist/ontology/group/index.d.ts

@@ -1 +1 @@
-export * as group from '../../ontology/group/external';
+export * as group from './external';

package/dist/ontology/group/writer.d.ts

@@ -1,6 +1,6 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
-import { type Payload } from '../../ontology/group/payload';
-import { type ID } from '../../ontology/payload';
+import { type Payload } from './payload';
+import { type ID } from '../payload';
 export declare class Writer {
     private static readonly ENDPOINT;
     private static readonly ENDPOINT_RENAME;

package/dist/ontology/index.d.ts

@@ -1 +1 @@
-export * as ontology from '../ontology/external';
+export * as ontology from './external';