@synnaxlabs/x 0.16.0 → 0.23.0

package/src/kv/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/kv/types.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/math/index.ts

@@ -0,0 +1,10 @@
+// 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 math from "@/math/math";

package/src/math/math.ts

@@ -0,0 +1,33 @@
+// 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.
+
+type Value = number | bigint;
+
+/** @returns the product of a and b, coercing b to the type of a if necessary. */
+export const sub = <V extends Value>(a: V, b: Value): V => {
+  if (typeof a === "bigint") return (a - BigInt(b)) as V;
+  return (a - Number(b)) as V;
+};
+
+/** @returns the sum of a and b, coercing b to the type of a if necessary. */
+export const add = <V extends Value>(a: V, b: Value): V => {
+  if (typeof a === "bigint") return (a + BigInt(b)) as V;
+  // @ts-expect-error - a is a number but typescript doesn't recognize that.
+  return (a + Number(b)) as V;
+};
+
+/** @returns true if a is close to b within epsilon. */
+export const closeTo = (a: number, b: number, epsilon = 0.0001): boolean =>
+  Math.abs(a - b) < epsilon;
+
+/** @returns the nearest number to num with 1 significant digit. */
+export const roundToNearestMagnitude = (num: number): number => {
+  const magnitude = Math.pow(10, Math.floor(Math.log10(num)));
+  return Math.round(num / magnitude) * magnitude;
+};

package/src/migrate/index.ts

@@ -1 +1,10 @@
+// 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 migrate from "@/migrate/migrate";

package/src/migrate/migrate.spec.ts

@@ -1,11 +1,20 @@
+// 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 { z } from "zod";
 
 import {
-  type Migration,
   migratable,
-  migrator,
+  type Migration,
   type Migrations,
+  migrator,
 } from "@/migrate/migrate";
 
 const entityV0_0_0 = migratable.extend({
@@ -29,6 +38,7 @@ type EntityV0_0_2 = z.infer<typeof entityV0_0_2>;
 
 const migrations: Migrations = {
   "0.0.0": ((entity: EntityV0_0_0): EntityV0_0_1 => {
+
     const { name, ...rest } = entity;
     return {
       ...rest,

package/src/migrate/migrate.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 { compare } from "@/compare";

package/src/mock/MockGLBufferController.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,9 +7,9 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { vi, Mock } from "vitest";
+import { type Mock,vi } from "vitest";
 
-import { GLBufferController } from "@/telem/gl";
+import { type GLBufferController } from "@/telem/gl";
 
 export class MockGLBufferController implements GLBufferController {
   ARRAY_BUFFER: number = 1;
@@ -27,7 +27,7 @@ export class MockGLBufferController implements GLBufferController {
   deleteBufferMock: Mock<[WebGLBuffer | null]> = vi.fn();
 
   deleteBuffer(buffer: WebGLBuffer | null): void {
-    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+     
     if (buffer != null) delete this.buffers[buffer as number];
     this.deleteBufferMock(buffer);
   }
@@ -42,13 +42,13 @@ export class MockGLBufferController implements GLBufferController {
   bufferData(
     target: number,
     dataOrSize: ArrayBufferLike | number,
-    usage: number
+    usage: number,
   ): void {
     if (typeof dataOrSize === "number")
       this.buffers[this.targets[target]] = new ArrayBuffer(dataOrSize);
     else this.buffers[this.targets[target]] = dataOrSize;
 
-    this.bufferDataMock(target, dataOrSize as any, usage);
+    this.bufferDataMock(target, dataOrSize, usage);
   }
 
   bindBuffer(target: number, buffer: WebGLBuffer | null): void {

package/src/mock/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/observe/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/observe/observe.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.
@@ -15,19 +15,50 @@ export interface Observable<T> {
   onChange: (handler: Handler<T>) => Destructor;
 }
 
-export class Observer<T> implements Observable<T> {
-  private readonly handlers: Map<Handler<T>, null>;
+export interface ObservableAsyncCloseable<T> extends Observable<T> {
+  close: () => Promise<void>;
+}
+
+export type Transform<I, O> = (value: I) => [O, true] | [O | null, false];
+
+export class Observer<I, O = I> implements Observable<O> {
+  private readonly handlers: Map<Handler<O>, null>;
+  private readonly transform?: Transform<I, O>;
+
+  constructor(transform?: Transform<I, O>, handlers?: Map<Handler<O>, null>) {
+    this.transform = transform;
+    this.handlers = handlers ?? new Map();
+  }
+
+  onChange(handler: Handler<O>): Destructor {
+    this.handlers.set(handler, null);
+    return () => this.handlers.delete(handler);
+  }
+
+  notify(value: I): void {
+    let newValue: O = value as unknown as O;
+    if (this.transform != null) {
+      const [nv, changed] = this.transform(value);
+      if (!changed) return;
+      newValue = nv;
+    }
+    this.handlers.forEach((_, handler) => handler(newValue));
+  }
+}
+
+export class BaseObserver<V> implements Observable<V> {
+  private readonly handlers: Map<Handler<V>, null>;
 
-  constructor(handlers?: Map<Handler<T>, null>) {
+  constructor(handlers?: Map<Handler<V>, null>) {
     this.handlers = handlers ?? new Map();
   }
 
-  onChange(handler: Handler<T>): Destructor {
+  onChange(handler: Handler<V>): Destructor {
     this.handlers.set(handler, null);
     return () => this.handlers.delete(handler);
   }
 
-  notify(value: T): void {
+  notify(value: V): void {
     this.handlers.forEach((_, handler) => handler(value));
   }
 }

package/src/observe/obsever.spec.ts

@@ -0,0 +1,56 @@
+// 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 { observe } from "@/observe";
+
+describe("observe", () => {
+  describe("Observer", () => {
+    it("should correctly notify the receives of values", () => {
+      const observer = new observe.Observer<number>();
+      const values: number[] = [];
+      observer.onChange((value) => values.push(value));
+      observer.notify(1);
+      observer.notify(2);
+      expect(values).toEqual([1, 2]);
+    });
+    it("should stop notifying a handler after the destructor is called", () => {
+      const observer = new observe.Observer<number>();
+      const values: number[] = [];
+      const destructor = observer.onChange((value) => values.push(value));
+      observer.notify(1);
+      destructor();
+      observer.notify(2);
+      expect(values).toEqual([1]);
+    });
+    it("should correctly transform an observed value", () => {
+      const observer = new observe.Observer<number, string>((value) => [
+        value.toString(),
+        true,
+      ]);
+      const values: string[] = [];
+      observer.onChange((value) => values.push(value));
+      observer.notify(1);
+      observer.notify(2);
+      expect(values).toEqual(["1", "2"]);
+    });
+    it("should not notify when the transform returns false", () => {
+      const observer = new observe.Observer<number, string>((value) => [
+        value.toString(),
+        false,
+      ]);
+      const values: string[] = [];
+      observer.onChange((value) => values.push(value));
+      observer.notify(1);
+      observer.notify(2);
+      expect(values).toEqual([]);
+    });
+  });
+});

package/src/optional.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,6 @@
 
 export type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 
-
 export type Required<T> = {
-    [P in keyof T]-?: T[P];
-};
+  [P in keyof T]-?: T[P];
+};

package/src/primitive.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/record.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,18 +11,22 @@ import { z } from "zod";
 
 export type Key = string | number | symbol;
 
-export type UnknownRecord = { [key: Key]: unknown };
+export type UnknownRecord = Record<Key, unknown>;
 
-export type Keyed<K extends Key> = { key: K };
+export interface Keyed<K extends Key> {
+  key: K;
+}
 
 export const unknownRecordZ = z.record(
   z.union([z.number(), z.string(), z.symbol()]),
   z.unknown(),
 );
 
-export type Entries<T> = {
-  [K in keyof T]: [K, T[K]];
-}[keyof T][];
+export type Entries<T> = Array<
+  {
+    [K in keyof T]: [K, T[K]];
+  }[keyof T]
+>;
 
 export const getEntries = <T extends Record<Key, unknown>>(obj: T): Entries<T> =>
   Object.entries(obj) as Entries<T>;

package/src/renderable.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/runtime/detect.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.
@@ -17,14 +17,14 @@ export type Runtime = "browser" | "node" | "webworker";
  */
 export const detect = (): Runtime => {
   if (
-    // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
+     
     typeof process !== "undefined" &&
     process.versions != null &&
     process.versions.node != null
   )
     return "node";
 
-  // eslint-disable-next-line @typescript-eslint/prefer-optional-chain
+   
   if (typeof window === "undefined" || window.document === undefined)
     return "webworker";
 

package/src/runtime/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/runtime/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/runtime/os.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,17 @@ export const OPERATING_SYSTEMS = ["MacOS", "Windows", "Linux", "Docker"] as cons
 export const osZ = z.enum(OPERATING_SYSTEMS);
 export type OS = (typeof OPERATING_SYSTEMS)[number];
 
-export interface GetOSProps {
+export type RequiredGetOSProps = {
   force?: OS;
   default?: OS;
-}
+};
+
+export type OptionalGetOSProps = {
+  force?: OS | undefined;
+  default: OS;
+};
+
+export type GetOSProps = RequiredGetOSProps | OptionalGetOSProps;
 
 let os: OS | undefined;
 
@@ -29,10 +36,15 @@ const evalOS = (): OS | undefined => {
   return undefined;
 };
 
-export const getOS = (props: GetOSProps = {}): OS | undefined => {
+export interface GetOS {
+  (props?: RequiredGetOSProps): OS;
+  (props?: OptionalGetOSProps): OS | undefined;
+}
+
+export const getOS = ((props: GetOSProps = {}): OS | undefined => {
   const { force, default: default_ } = props;
   if (force != null) return force;
   if (os != null) return os;
   os = evalOS();
   return os ?? default_;
-};
+}) as unknown as GetOS;

package/src/search.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.
@@ -28,12 +28,14 @@ export const Search = {
 };
 
 export interface TermSearcher<T, K extends Key, E extends Keyed<K>> {
+  readonly type: string;
   search: (term: T) => E[];
   retrieve: (keys: K[]) => E[];
   page: (offset: number, limit: number) => E[];
 }
 
 export interface AsyncTermSearcher<T, K extends Key, E extends Keyed<K>> {
+  readonly type: string;
   search: (term: T) => Promise<E[]>;
   retrieve: (keys: K[]) => Promise<E[]>;
   page: (offset: number, limit: number) => Promise<E[]>;

package/src/shallowCopy.ts

@@ -1,4 +1,3 @@
-
 // Copyright 2024 Synnax Labs, Inc.
 //
 // Use of this software is governed by the Business Source License included in the file
@@ -8,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 const shallowCopy = <T extends unknown>(obj: T): T => {
-    if (Array.isArray(obj)) return [...obj] as T;
-    if (typeof obj === "object" && obj !== null) return { ...obj } as T;
-    return obj;
-}
+export const shallowCopy = <T>(obj: T): T => {
+  if (Array.isArray(obj)) return [...obj] as T;
+  if (typeof obj === "object" && obj !== null) return { ...obj };
+  return obj;
+};

package/src/spatial/base.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,8 @@
 import { z } from "zod";
 
 export const numberCouple = z.tuple([z.number(), z.number()]);
-export type NumberCouple = z.infer<typeof numberCouple>;
+export const bigNumberCouple = z.tuple([z.bigint(), z.bigint()]);
+export type NumberCouple<T extends number | bigint = number> = [T, T];
 
 // Dimensions
 
@@ -53,7 +54,7 @@ export const Y_LOCATIONS = ["top", "bottom"] as const;
 export const yLocation = z.enum(Y_LOCATIONS);
 export type YLocation = (typeof Y_LOCATIONS)[number];
 export const CENTER_LOCATIONS = ["center"] as const;
-export const centerlocation = z.enum(CENTER_LOCATIONS);
+export const centerLocation = z.enum(CENTER_LOCATIONS);
 export type CenterLocation = (typeof CENTER_LOCATIONS)[number];
 export const LOCATIONS = [...OUTER_LOCATIONS, ...CENTER_LOCATIONS] as const;
 export const location = z.enum(LOCATIONS);
@@ -70,10 +71,17 @@ export type Order = (typeof ORDERS)[number];
 // Bounds
 
 export const bounds = z.object({ lower: z.number(), upper: z.number() });
-export type Bounds = z.infer<typeof bounds>;
+export const bigBounds = z.object({ lower: z.bigint(), upper: z.bigint() });
+export interface Bounds<T extends number | bigint = number> {
+  lower: T;
+  upper: T;
+}
 
 export const crudeBounds = z.union([bounds, numberCouple]);
-export type CrudeBounds = z.infer<typeof crudeBounds>;
+export const bigCrudeBounds = z.union([bigBounds, numberCouple]);
+export type CrudeBounds<T extends number | bigint = number> =
+  | Bounds<T>
+  | NumberCouple<T>;
 export const crudeDirection = z.union([direction, location]);
 export type CrudeDirection = z.infer<typeof crudeDirection>;
 export const crudeLocation = z.union([direction, location, z.instanceof(String)]);