@synnaxlabs/client 0.22.1 → 0.23.0

package/src/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,10 +8,11 @@
 // included in the file licenses/APL.txt.
 
 export * from "@/channel";
-export { default as Synnax, synnaxPropsZ } from "@/client";
+export { Channel } from "@/channel/client";
 export type { SynnaxProps } from "@/client";
+export { default as Synnax, synnaxPropsZ } from "@/client";
 export * from "@/connection";
-export { Channel } from "@/channel/client";
+export { control } from "@/control";
 export {
   AuthError,
   ContiguityError,
@@ -22,37 +23,37 @@ export {
 } from "@/errors";
 export { framer } from "@/framer";
 export { Frame } from "@/framer/frame";
+export { hardware } from "@/hardware";
+export { device } from "@/hardware/device";
+export { rack } from "@/hardware/rack";
+export { task } from "@/hardware/task";
+export { label } from "@/label";
 export { ontology } from "@/ontology";
-export { control } from "@/control";
-export { Authority } from "@/control/authority";
-export {
-  DataType,
-  Density,
-  Rate,
-  Series,
-  TimeRange,
-  TimeSpan,
-  TimeStamp,
-  MultiSeries,
-} from "@synnaxlabs/x/telem";
+export { ranger } from "@/ranger";
+export { signals } from "@/signals";
+export { workspace } from "@/workspace";
 export type {
-  TypedArray,
   CrudeDataType,
   CrudeDensity,
   CrudeRate,
   CrudeSize,
   CrudeTimeSpan,
   CrudeTimeStamp,
-  TelemValue,
   NumericTelemValue,
+  TelemValue,
   TimeStampStringFormat,
+  TypedArray,
   TZInfo,
 } from "@synnaxlabs/x/telem";
-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";
-export { signals } from "@/signals";
+export {
+  DataType,
+  Density,
+  MultiSeries,
+  Rate,
+  Series,
+  TimeRange,
+  TimeSpan,
+  TimeStamp,
+} from "@synnaxlabs/x/telem";
+import { control } from "@synnaxlabs/x";
+export const Authority = control.Authority;

package/src/label/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -13,7 +13,7 @@ import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 import { type framer } from "@/framer";
 import { type Key, type Label, labelZ } from "@/label/payload";
 import { Retriever } from "@/label/retriever";
-import { Writer, type NewLabelPayload } from "@/label/writer";
+import { type NewLabelPayload,Writer } from "@/label/writer";
 import { type ontology } from "@/ontology";
 import { signals } from "@/signals";
 

package/src/label/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,6 +8,6 @@
 // included in the file licenses/APL.txt.
 
 export * from "@/label/client";
-export * from "@/label/writer";
-export * from "@/label/retriever";
 export * from "@/label/payload";
+export * from "@/label/retriever";
+export * from "@/label/writer";

package/src/label/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/label.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/retriever.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/label/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,25 +8,25 @@
 // included in the file licenses/APL.txt.
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { observe, toArray } from "@synnaxlabs/x";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
+import { z } from "zod";
 
 import { QueryError } from "@/errors";
 import { framer } from "@/framer";
+import { Frame } from "@/framer/frame";
 import { group } from "@/ontology/group";
 import {
   ID,
   IDPayload,
-  RelationshipChange,
-  ResourceChange,
   idZ,
   parseRelationship,
-  resourceSchemaZ,
+  RelationshipChange,
   type Resource,
+  ResourceChange,
+  resourceSchemaZ,
 } from "@/ontology/payload";
 import { Writer } from "@/ontology/writer";
-import { z } from "zod";
-import { observe, toArray } from "@synnaxlabs/x";
-import { Frame } from "@/framer/frame";
 
 const RETRIEVE_ENDPOINT = "/ontology/retrieve";
 

package/src/ontology/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -21,8 +21,8 @@ export class Client {
     this.creator = new Writer(unary);
   }
 
-  async create(parent: ID, name: string): Promise<Group> {
-    return this.sugar(await this.creator.create(parent, name));
+  async create(parent: ID, name: string, key?: string): Promise<Group> {
+    return this.sugar(await this.creator.create(parent, name, key));
   }
 
   async rename(key: string, name: string): Promise<void> {

package/src/ontology/group/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,5 +7,5 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export * from "@/ontology/group/group";
 export * from "@/ontology/group/client";
+export * from "@/ontology/group/group";

package/src/ontology/group/group.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -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 { describe, it, expect } from "vitest";
+import { describe, expect,it } from "vitest";
 
 import { QueryError } from "@/errors";
 import { ontology } from "@/ontology";

package/src/ontology/group/group.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/group/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -11,7 +11,7 @@ import { type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import { type Payload, payloadZ } from "@/ontology/group/payload";
-import { idZ, type ID } from "@/ontology/payload";
+import { type ID, idZ } from "@/ontology/payload";
 
 const resZ = z.object({
   group: payloadZ,
@@ -19,6 +19,7 @@ const resZ = z.object({
 
 const createReqZ = z.object({
   parent: idZ,
+  key: z.string().uuid().optional(),
   name: z.string(),
 });
 
@@ -41,21 +42,36 @@ export class Writer {
     this.client = client;
   }
 
-  async create(parent: ID, name: string): Promise<Payload> {
-    const [res, err] = await this.client.send(Writer.ENDPOINT, {parent, name},createReqZ, resZ);
+  async create(parent: ID, name: string, key?: string): Promise<Payload> {
+    const [res, err] = await this.client.send(
+      Writer.ENDPOINT,
+      { parent, name, key },
+      createReqZ,
+      resZ,
+    );
     if (err != null) throw err;
     return res.group;
   }
 
   async rename(key: string, name: string): Promise<void> {
     const req = { key, name };
-    const [, err] = await this.client.send(Writer.ENDPOINT_RENAME, req, renameReqZ, z.object({}));
+    const [, err] = await this.client.send(
+      Writer.ENDPOINT_RENAME,
+      req,
+      renameReqZ,
+      z.object({}),
+    );
     if (err != null) throw err;
   }
 
   async delete(keys: string[]): Promise<void> {
     const req = { keys };
-    const [, err] = await this.client.send(Writer.ENDPOINT_DELETE, req, deleteReqZ, z.object({}));
+    const [, err] = await this.client.send(
+      Writer.ENDPOINT_DELETE,
+      req,
+      deleteReqZ,
+      z.object({}),
+    );
     if (err != null) throw err;
   }
 }

package/src/ontology/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ontology/ontology.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -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 { describe, expect, test, it } from "vitest";
+import { describe, expect, it,test } from "vitest";
 
 import { ontology } from "@/ontology";
 import { newClient } from "@/setupspecs";

package/src/ontology/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -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 } from "@synnaxlabs/x";
+import { change,UnknownRecord } from "@synnaxlabs/x";
 import { z } from "zod";
 
 export type ResourceChange = change.Change<ID, Resource>;
@@ -109,7 +109,7 @@ export const resourceSchemaZ = z
     };
   });
 
-export type Resource<T extends {} = {}> = Omit<
+export type Resource<T extends UnknownRecord = UnknownRecord> = Omit<
   z.output<typeof resourceSchemaZ>,
   "data"
 > & { data?: T | null };

package/src/ontology/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -10,7 +10,7 @@
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
-import { idZ, type ID } from "@/ontology/payload";
+import { type ID,idZ } from "@/ontology/payload";
 
 const ENDPOINTS = {
   ADD_CHILDREN: "/ontology/add-children",

package/src/ranger/active.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -11,7 +11,7 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import { QueryError } from "@/errors";
-import { type Payload, payloadZ, type Key, keyZ } from "@/ranger/payload";
+import { type Key, keyZ,type Payload, payloadZ } from "@/ranger/payload";
 
 const setActiveResZ = z.object({});
 

package/src/ranger/alias.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -12,7 +12,7 @@ import { type change } from "@synnaxlabs/x/change";
 import { z } from "zod";
 
 import { type channel } from "@/channel";
-import { keyZ as channelKeyZ, type Key as ChannelKey } from "@/channel/payload";
+import { type Key as ChannelKey,keyZ as channelKeyZ } from "@/channel/payload";
 import { type Client as FrameClient } from "@/framer/client";
 import { type Key, keyZ } from "@/ranger/payload";
 import { signals } from "@/signals";

package/src/ranger/client.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -8,33 +8,33 @@
 // included in the file licenses/APL.txt.
 
 import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
+import { CrudeTimeRange, TimeRange } from "@synnaxlabs/x";
 import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 import { toArray } from "@synnaxlabs/x/toArray";
+import { z } from "zod";
 
 import { type Retriever as ChannelRetriever } from "@/channel/retriever";
-import { MultipleFoundError, NotFoundError, QueryError } from "@/errors";
+import { MultipleFoundError, NotFoundError } from "@/errors";
 import { type framer } from "@/framer";
 import { type label } from "@/label";
 import { Active } from "@/ranger/active";
 import { Aliaser } from "@/ranger/alias";
 import { KV } from "@/ranger/kv";
 import {
-  type NewPayload,
+  analyzeParams,
   type Key,
   type Keys,
+  keyZ,
   type Name,
   type Names,
+  type NewPayload,
   type Params,
   type Payload,
-  analyzeParams,
   payloadZ,
-  keyZ,
 } from "@/ranger/payload";
 import { Range } from "@/ranger/range";
 import { type Writer } from "@/ranger/writer";
 import { signals } from "@/signals";
-import { z } from "zod";
-import { CrudeTimeRange, TimeRange } from "@synnaxlabs/x";
 import { nullableArrayZ } from "@/util/zod";
 
 const retrieveReqZ = z.object({
@@ -98,7 +98,7 @@ export class Client implements AsyncTermSearcher<string, Key, Range> {
     return this.sugar(await this.execRetrieve({ term }));
   }
 
-  async page(offset: number, limit: number): Promise<Range[]> {
+  async page(): Promise<Range[]> {
     return [];
   }
 
@@ -122,15 +122,14 @@ export class Client implements AsyncTermSearcher<string, Key, Range> {
   }
 
   private async execRetrieve(req: RetrieveRequest): Promise<Range[]> {
-    return this.sugar(
-      await sendRequired<typeof retrieveReqZ, typeof retrieveResZ>(
-        this.unaryClient,
-        RETRIEVE_ENDPOINT,
-        req,
-        retrieveReqZ,
-        retrieveResZ,
-      ).then((res) => res.ranges),
+    const { ranges } = await sendRequired<typeof retrieveReqZ, typeof retrieveResZ>(
+      this.unaryClient,
+      RETRIEVE_ENDPOINT,
+      req,
+      retrieveReqZ,
+      retrieveResZ,
     );
+    return this.sugar(ranges);
   }
 
   async setActive(range: Key): Promise<void> {

package/src/ranger/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -7,8 +7,8 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
+export type { Alias, AliasChange } from "@/ranger/alias";
 export * from "@/ranger/client";
-export * from "@/ranger/writer";
 export * from "@/ranger/payload";
 export * from "@/ranger/range";
-export type { Alias, AliasChange } from "@/ranger/alias";
+export * from "@/ranger/writer";

package/src/ranger/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/kv.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -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, sendRequired } from "@synnaxlabs/freighter";
+import { sendRequired,type UnaryClient } from "@synnaxlabs/freighter";
 import { isObject } from "@synnaxlabs/x/identity";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";

package/src/ranger/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/range.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -9,7 +9,7 @@
 
 import { type Series, TimeRange } from "@synnaxlabs/x/telem";
 
-import { type Key, type Params, type Name } from "@/channel/payload";
+import { type Key, type Name,type Params } from "@/channel/payload";
 import { type Retriever as ChannelRetriever } from "@/channel/retriever";
 import { QueryError } from "@/errors";
 import { type framer } from "@/framer";

package/src/ranger/ranger.spec.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/ranger/writer.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -11,11 +11,11 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { z } from "zod";
 
 import {
+  keyZ,
   type NewPayload,
+  newPayloadZ,
   type Payload,
   payloadZ,
-  keyZ,
-  newPayloadZ,
 } from "@/ranger/payload";
 
 const createResZ = z.object({

package/src/setupspecs.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/signals/external.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/signals/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/signals/observable.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/transport.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.
@@ -9,10 +9,10 @@
 
 import {
   HTTPClient,
-  WebSocketClient,
   type Middleware,
   type StreamClient,
   type UnaryClient,
+  WebSocketClient,
 } from "@synnaxlabs/freighter";
 import { binary } from "@synnaxlabs/x/binary";
 import { type URL } from "@synnaxlabs/x/url";

package/src/user/index.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.

package/src/user/payload.ts

@@ -1,4 +1,4 @@
-// Copyright 2023 Synnax Labs, Inc.
+// Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
 // licenses/BSL.txt.