@synnaxlabs/client 0.22.0 → 0.23.0

package/src/util/retrieve.spec.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 { it, describe, expect } from "vitest";
+import { describe, expect,it } from "vitest";
 import { type Primitive } from "zod";
 
 import {

package/src/util/retrieve.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 { toArray, type Primitive } from "@synnaxlabs/x";
+import { type Primitive,toArray } from "@synnaxlabs/x";
 
 import { MultipleFoundError, NotFoundError } from "@/errors";
 

package/src/util/telem.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/util/zod.ts

@@ -1,4 +1,13 @@
-import { z } from "zod";
+// 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";
 
-export const nullableArrayZ = <Z extends z.ZodTypeAny>(item: Z) => z.union([z.null().transform(() => []), item.array()]);
+export const nullableArrayZ = <Z extends z.ZodTypeAny>(item: Z) =>
+  z.union([z.null().transform(() => [] as z.output<Z>[]), item.array()]);

package/src/vite-env.d.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.
 
-// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+ 
 /// <reference types="vite/client" />

package/src/workspace/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,8 +13,8 @@ import { type AsyncTermSearcher } from "@synnaxlabs/x/search";
 
 import { linePlot } from "@/workspace/lineplot";
 import { type Key, type Workspace } from "@/workspace/payload";
-import { schematic } from "@/workspace/schematic";
 import { Retriever } from "@/workspace/retriever";
+import { schematic } from "@/workspace/schematic";
 import { type NewWorkspace, Writer } from "@/workspace/writer";
 
 export class Client implements AsyncTermSearcher<string, Key, Workspace> {

package/src/workspace/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 "@/workspace/payload";
 export * from "@/workspace/client";
+export * from "@/workspace/payload";

package/src/workspace/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/workspace/lineplot/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.
@@ -10,7 +10,7 @@
 import { type UnaryClient } from "@synnaxlabs/freighter";
 import { type UnknownRecord } from "@synnaxlabs/x/record";
 
-import { type LinePlot, type Key, type Params } from "@/workspace/lineplot/payload";
+import { type Key, type LinePlot, type Params } from "@/workspace/lineplot/payload";
 import { Retriever } from "@/workspace/lineplot/retriever";
 import { type NewLinePlot, Writer } from "@/workspace/lineplot/writer";
 

package/src/workspace/lineplot/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 "@/workspace/lineplot/payload";
 export * from "@/workspace/lineplot/client";
+export * from "@/workspace/lineplot/payload";

package/src/workspace/lineplot/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/workspace/lineplot/linePlot.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, test, expect } from "vitest";
+import { describe, expect,test } from "vitest";
 
 import { newClient } from "@/setupspecs";
 

package/src/workspace/lineplot/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/workspace/lineplot/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.
@@ -11,17 +11,11 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
-import { type LinePlot, type Params, linePlotZ } from "@/workspace/lineplot/payload";
+import { type LinePlot, linePlotZ, type Params } from "@/workspace/lineplot/payload";
 
-const reqZ = z.object({
-  keys: z.string().array(),
-});
+const reqZ = z.object({ keys: z.string().array() });
 
-type Request = z.infer<typeof reqZ>;
-
-const resZ = z.object({
-  linePlots: linePlotZ.array(),
-});
+const resZ = z.object({ linePlots: linePlotZ.array() });
 
 export class Retriever {
   private readonly ENDPOINT = "/workspace/lineplot/retrieve";

package/src/workspace/lineplot/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.
@@ -13,11 +13,11 @@ import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
 import {
-  linePlotZ,
+  type Key,
+  keyZ,
   type LinePlot,
+  linePlotZ,
   type Params,
-  keyZ,
-  type Key,
 } from "@/workspace/lineplot/payload";
 import { keyZ as workspaceKeyZ } from "@/workspace/payload";
 

package/src/workspace/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,6 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { binary } from "@synnaxlabs/x/binary";
 import { type UnknownRecord, unknownRecordZ } from "@synnaxlabs/x/record";
 import { z } from "zod";
 
@@ -17,16 +16,22 @@ export type Key = z.infer<typeof keyZ>;
 
 export type Params = Key | Key[];
 
+// --- VERY IMPORTANT ---
+// Synnax's encoders (in the binary package inside x) automatically convert the case
+// of keys in objects to snake_case and back to camelCase when encoding and decoding
+// respectively. This is done to ensure that the keys are consistent across all
+// languages and platforms. Sometimes workspaces have keys that are uuids, which have
+// dashes, and those get messed up. So we just use regular JSON for workspaces.
+const parse = (s: string): UnknownRecord => JSON.parse(s) as UnknownRecord;
+
 export const workspaceZ = z.object({
   name: z.string(),
   key: keyZ,
-  layout: unknownRecordZ.or(
-    z.string().transform((s) => binary.JSON_ECD.decodeString(s) as UnknownRecord),
-  ),
+  layout: unknownRecordZ.or(z.string().transform((s) => parse(s) as UnknownRecord)),
 });
 
 export const workspaceRemoteZ = workspaceZ.omit({ layout: true }).extend({
-  layout: z.string().transform((s) => binary.JSON_ECD.decodeString(s) as UnknownRecord),
+  layout: z.string().transform((s) => parse(s) as UnknownRecord),
 });
 
 export type Workspace = z.infer<typeof workspaceZ>;

package/src/workspace/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.
@@ -11,10 +11,11 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
+import { nullableArrayZ } from "@/util/zod";
 import {
+  keyZ,
   type Params,
   type Workspace,
-  keyZ,
   workspaceRemoteZ,
 } from "@/workspace/payload";
 
@@ -28,9 +29,7 @@ const reqZ = z.object({
 
 type Request = z.infer<typeof reqZ>;
 
-const resZ = z.object({
-  workspaces: workspaceRemoteZ.array(),
-});
+const resZ = z.object({ workspaces: nullableArrayZ(workspaceRemoteZ) });
 
 export class Retriever {
   private static readonly ENDPOINT = "/workspace/retrieve";
@@ -59,6 +58,13 @@ export class Retriever {
   }
 
   private async execute(request: Request): Promise<Workspace[]> {
-    return (await sendRequired(this.client, Retriever.ENDPOINT, request, reqZ, resZ)).workspaces;
+    const res = await sendRequired(
+      this.client,
+      Retriever.ENDPOINT,
+      request,
+      reqZ,
+      resZ,
+    );
+    return res.workspaces;
   }
 }

package/src/workspace/schematic/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.
@@ -12,7 +12,7 @@ import { type UnknownRecord } from "@synnaxlabs/x/record";
 
 import { type Key, type Params, type Schematic } from "@/workspace/schematic/payload";
 import { Retriever } from "@/workspace/schematic/retriever";
-import { Writer, type NewSchematic } from "@/workspace/schematic/writer";
+import { type NewSchematic,Writer } from "@/workspace/schematic/writer";
 
 export class Client {
   private readonly writer: Writer;

package/src/workspace/schematic/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 "@/workspace/schematic/payload";
 export * from "@/workspace/schematic/client";
+export * from "@/workspace/schematic/payload";

package/src/workspace/schematic/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/workspace/schematic/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/workspace/schematic/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.
@@ -11,17 +11,14 @@ import { sendRequired, type UnaryClient } from "@synnaxlabs/freighter";
 import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
-import { type Schematic, type Params, schematicRemoteZ } from "@/workspace/schematic/payload";
+import {
+  type Params,
+  type Schematic,
+  schematicRemoteZ,
+} from "@/workspace/schematic/payload";
 
-const reqZ = z.object({
-  keys: z.string().array(),
-});
-
-type Request = z.infer<typeof reqZ>;
-
-const resZ = z.object({
-  schematics: schematicRemoteZ.array(),
-});
+const reqZ = z.object({ keys: z.string().array() });
+const resZ = z.object({ schematics: schematicRemoteZ.array() });
 
 export class Retriever {
   private readonly ENDPOINT = "/workspace/schematic/retrieve";
@@ -32,12 +29,14 @@ export class Retriever {
   }
 
   async retrieve(params: Params): Promise<Schematic[]> {
-    return (await sendRequired(
-      this.client,
-      this.ENDPOINT,
-      { keys: toArray(params) },
-      reqZ,
-      resZ,
-    )).schematics;
+    return (
+      await sendRequired(
+        this.client,
+        this.ENDPOINT,
+        { keys: toArray(params) },
+        reqZ,
+        resZ,
+      )
+    ).schematics;
   }
 }

package/src/workspace/schematic/schematic.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, test, expect, it } from "vitest";
+import { describe, expect, it,test } from "vitest";
 
 import { ValidationError } from "@/errors";
 import { newClient } from "@/setupspecs";

package/src/workspace/schematic/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.
@@ -14,12 +14,12 @@ import { z } from "zod";
 
 import { keyZ as workspaceKeyZ } from "@/workspace/payload";
 import {
-  schematicZ,
-  type Schematic,
-  type Params,
-  keyZ,
   type Key,
+  keyZ,
+  type Params,
+  type Schematic,
   schematicRemoteZ,
+  schematicZ,
 } from "@/workspace/schematic/payload";
 
 export const newSchematicZ = schematicZ.partial({ key: true, snapshot: true }).transform((p) => ({

package/src/workspace/workspace.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, test, expect } from "vitest";
+import { describe, expect,test } from "vitest";
 
 import { newClient } from "@/setupspecs";
 

package/src/workspace/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.
@@ -13,10 +13,10 @@ import { toArray } from "@synnaxlabs/x/toArray";
 import { z } from "zod";
 
 import {
-  type Workspace,
-  workspaceZ,
   keyZ,
+  type Workspace,
   workspaceRemoteZ,
+  workspaceZ,
 } from "@/workspace/payload";
 
 const newWorkspaceZ = workspaceZ.partial({ key: true }).transform((w) => ({

package/vite.config.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,15 +7,14 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { lib } from "@synnaxlabs/vite-plugin";
+import { isProd, lib } from "@synnaxlabs/vite-plugin";
 import { defineConfig } from "vite";
 
 export default defineConfig({
   plugins: [lib({ name: "client" })],
   build: {
-    minify: true,
     rollupOptions: {
-      external: "zod",
+      external: ["zod"],
     },
   },
   test: {

package/.eslintrc.cjs

@@ -1,18 +0,0 @@
-/*
- * Copyright 2023 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.
- */
-
-module.exports = {
-  root: true,
-  extends: ["synnaxlabs"],
-  parserOptions: {
-    project: "./tsconfig.json",
-  },
-};