@synnaxlabs/x 0.11.0 → 0.13.0

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
 
-> @synnaxlabs/x@0.11.0 build /home/runner/work/synnax/synnax/x/ts
+> @synnaxlabs/x@0.13.0 build /home/runner/work/synnax/synnax/x/ts
 > tsc --noEmit && vite build
 
 vite v5.1.2 building for production...
 transforming...
 [plugin:vite:resolve] Module "crypto" has been externalized for browser compatibility, imported by "/home/runner/work/synnax/synnax/node_modules/.pnpm/nanoid@3.0.0/node_modules/nanoid/index.js". See https://vitejs.dev/guide/troubleshooting.html#module-externalized-for-browser-compatibility for more details.
-✓ 116 modules transformed.
+✓ 127 modules transformed.
 rendering chunks...
 
 [vite:dts] Start generate declaration files...
 computing gzip size...
-dist/x.es.js  289.25 kB │ gzip: 54.55 kB │ map: 594.27 kB
-[vite:dts] Declaration files built in 2781ms.
+dist/x.js  299.72 kB │ gzip: 56.93 kB │ map: 617.77 kB
+[vite:dts] Declaration files built in 2906ms.
 
-dist/x.cjs.js  290.12 kB │ gzip: 54.70 kB │ map: 594.39 kB
-✓ built in 3.62s
+dist/x.cjs  300.61 kB │ gzip: 57.08 kB │ map: 617.89 kB
+✓ built in 3.78s

package/dist/deep/difference.d.ts

@@ -0,0 +1,3 @@
+type PathValueTuple = [any, any];
+export declare const difference: (obj1: Record<string, any>, obj2: Record<string, any>, path?: string) => Record<string, PathValueTuple>;
+export {};

package/dist/deep/external.d.ts

@@ -5,3 +5,4 @@ export * from './merge';
 export * from './partial';
 export * from './equal';
 export * from './memo';
+export * from './difference';

package/dist/index.d.ts

@@ -24,3 +24,4 @@ export * from './binary';
 export * from './observe';
 export * from './change';
 export * from './shallowCopy';
+export * from './invert';

package/dist/invert.d.ts

@@ -0,0 +1 @@
+export declare const invert: (condition: boolean) => -1 | 1;

package/dist/optional.d.ts

@@ -1 +1,4 @@
 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];
+};

package/dist/spatial/{bounds.d.ts → bounds/bounds.d.ts}

@@ -1,4 +1,4 @@
-import { type Bounds, bounds, type CrudeBounds } from './base';
+import { type Bounds, bounds, type CrudeBounds } from '../base';
 export { type Bounds, bounds };
 export type Crude = CrudeBounds;
 export declare const construct: (lower: number | Crude, upper?: number) => Bounds;

package/dist/spatial/bounds/index.d.ts

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

package/dist/spatial/{box.d.ts → box/box.d.ts}

@@ -1,9 +1,9 @@
 import { z } from "zod";
-import type * as bounds from './bounds';
-import type * as dimensions from './dimensions';
-import * as direction from './direction';
-import * as location from './location';
-import * as xy from './xy';
+import type * as bounds from '../bounds/bounds';
+import type * as dimensions from '../dimensions/dimensions';
+import * as direction from '../direction/direction';
+import * as location from '../location/location';
+import * as xy from '../xy/xy';
 declare const cssBox: z.ZodObject<{
     top: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
     left: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
@@ -97,7 +97,7 @@ export declare const box: z.ZodObject<{
 export type Box = z.infer<typeof box>;
 export type CSS = z.infer<typeof cssBox>;
 export type DOMRect = z.infer<typeof domRect>;
-type Crude = DOMRect | Box | {
+export type Crude = DOMRect | Box | {
     getBoundingClientRect: () => DOMRect;
 };
 /** A box centered at (0,0) with a width and height of 0. */
@@ -147,7 +147,20 @@ export declare const copy: (b: Box, root?: location.CornerXY) => Box;
 export declare const construct: (first: number | DOMRect | xy.XY | Box | {
     getBoundingClientRect: () => DOMRect;
 }, second?: number | xy.XY | dimensions.Dimensions | dimensions.Signed, width?: number, height?: number, coordinateRoot?: location.CornerXY) => Box;
-export declare const resize: (b: Box, dims: dimensions.Dimensions) => Box;
+export interface Resize {
+    /**
+     * Sets the dimensions of the box to the given dimensions.
+     * @example resize(b, { width: 10, height: 10 }) // Sets the box to a 10x10 box.
+     */
+    (b: Crude, dims: dimensions.Dimensions | dimensions.Signed): Box;
+    /**
+     * Sets the dimension along the given direction to the given amount.
+     * @example resize(b, "x", 10) // Sets the width of the box to 10.
+     * @example resize(b, "y", 10) // Sets the height of the box to 10.
+    */
+    (b: Crude, direction: direction.Direction, amount: number): Box;
+}
+export declare const resize: Resize;
 /**
  * Checks if a box contains a point or another box.
  *
@@ -236,5 +249,9 @@ export declare const isBox: (value: unknown) => value is {
     };
 };
 export declare const aspect: (b: Box) => number;
-export declare const translate: (b: Box, t: xy.XY) => Box;
+export declare const translate: (b: Crude, t: xy.XY | direction.Direction, amount?: number) => Box;
+export declare const intersect: (a: Box, b: Box) => Box;
+export declare const area: (b: Box) => number;
+export declare const truncate: (b: Box, precision?: number) => Box;
+export declare const constructWithAlternateRoot: (x: number, y: number, width: number, height: number, currRoot: location.XY, newRoot: location.CornerXY) => Box;
 export {};

package/dist/spatial/box/index.d.ts

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

package/dist/spatial/{dimensions.d.ts → dimensions/dimensions.d.ts}

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { dimensions, type Dimensions } from './base';
+import { dimensions, type Dimensions } from '../base';
 export { dimensions, type Dimensions };
 export declare const signed: z.ZodObject<{
     signedWidth: z.ZodNumber;

package/dist/spatial/dimensions/index.d.ts

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

package/dist/spatial/{direction.d.ts → direction/direction.d.ts}

@@ -1,4 +1,4 @@
-import { type Dimension, type Direction, type Location, type direction, type SignedDimension, type CrudeDirection } from './base';
+import { type Dimension, type Direction, type Location, type direction, type SignedDimension, type CrudeDirection } from '../base';
 export type { Direction, direction };
 export declare const crude: import("zod").ZodUnion<[import("zod").ZodEnum<["x", "y"]>, import("zod").ZodEnum<["top", "right", "bottom", "left", "center"]>]>;
 export type Crude = CrudeDirection;

package/dist/spatial/direction/index.d.ts

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

package/dist/spatial/external.d.ts

@@ -1,8 +1,9 @@
-export * as bounds from './bounds';
-export * as box from './box';
-export * as dimensions from './dimensions';
-export * as direction from './direction';
-export * as location from './location';
-export * as xy from './xy';
-export * as scale from './scale';
+export * from './bounds';
+export { box } from './box';
+export * from './dimensions';
+export * from './direction';
+export * from './location';
+export * from './xy';
+export * from './scale';
+export * from './position';
 export * as spatial from './spatial';

package/dist/spatial/location/index.d.ts

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

package/dist/spatial/{location.d.ts → location/location.d.ts}

@@ -1,11 +1,12 @@
 import { z } from "zod";
-import { location, type Location, X_LOCATIONS, Y_LOCATIONS, CENTER_LOCATIONS, type XLocation, type OuterLocation, type YLocation, outerLocation, type Direction, type CrudeLocation } from './base';
+import { location, type Location, X_LOCATIONS, Y_LOCATIONS, CENTER_LOCATIONS, type XLocation, type OuterLocation, type YLocation, outerLocation, type Direction, type CrudeLocation, type CenterLocation } from '../base';
 export { location, type Location, X_LOCATIONS, Y_LOCATIONS, CENTER_LOCATIONS, outerLocation as outer, };
 export declare const x: z.ZodEnum<["left", "right"]>;
 export declare const y: z.ZodEnum<["top", "bottom"]>;
 export type X = XLocation;
 export type Y = YLocation;
 export type Outer = OuterLocation;
+export type Center = CenterLocation;
 export declare const crude: z.ZodUnion<[z.ZodEnum<["x", "y"]>, z.ZodEnum<["top", "right", "bottom", "left", "center"]>, z.ZodType<String, z.ZodTypeDef, String>]>;
 export type Crude = CrudeLocation;
 export declare const construct: (cl: Crude) => Location;
@@ -13,14 +14,14 @@ export declare const swap: (cl: Crude) => Location;
 export declare const rotate90: (cl: Crude) => Location;
 export declare const direction: (cl: Crude) => Direction;
 export declare const xy: z.ZodObject<{
-    x: z.ZodEnum<["top", "right", "bottom", "left", "center"]>;
-    y: z.ZodEnum<["top", "right", "bottom", "left", "center"]>;
+    x: z.ZodUnion<[z.ZodEnum<["left", "right"]>, z.ZodEnum<["center"]>]>;
+    y: z.ZodUnion<[z.ZodEnum<["top", "bottom"]>, z.ZodEnum<["center"]>]>;
 }, "strip", z.ZodTypeAny, {
-    x: "center" | "top" | "right" | "bottom" | "left";
-    y: "center" | "top" | "right" | "bottom" | "left";
+    x: "center" | "right" | "left";
+    y: "center" | "top" | "bottom";
 }, {
-    x: "center" | "top" | "right" | "bottom" | "left";
-    y: "center" | "top" | "right" | "bottom" | "left";
+    x: "center" | "right" | "left";
+    y: "center" | "top" | "bottom";
 }>;
 export declare const corner: z.ZodObject<{
     x: z.ZodEnum<["left", "right"]>;
@@ -44,9 +45,11 @@ export declare const TOP_CENTER: XY;
 export declare const BOTTOM_CENTER: XY;
 export declare const RIGHT_CENTER: XY;
 export declare const LEFT_CENTER: XY;
+export declare const XY_LOCATIONS: readonly XY[];
 export declare const xyEquals: (a: XY, b: XY) => boolean;
+export declare const xyMatches: (a: XY, l: Partial<XY> | Location) => boolean;
 export declare const xyCouple: (a: XY) => [Location, Location];
-export declare const isX: (a: Crude) => boolean;
-export declare const isY: (a: Crude) => boolean;
+export declare const isX: (a: Crude) => a is "center" | "right" | "left";
+export declare const isY: (a: Crude) => a is "top" | "bottom";
 export declare const xyToString: (a: XY) => string;
 export declare const constructXY: (x: Crude | XY, y?: Crude) => XY;

package/dist/spatial/position/index.d.ts

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

package/dist/spatial/position/position.d.ts

@@ -0,0 +1,20 @@
+import { type Alignment } from '../base';
+import { box } from '../box';
+import { location } from '../location';
+import { xy } from '../xy';
+export declare const posititonSoVisible: (target: HTMLElement, p: xy.XY) => [xy.XY, boolean];
+export interface DialogProps {
+    container: box.Crude;
+    target: box.Crude;
+    dialog: box.Crude;
+    alignments?: Alignment[];
+    initial?: location.Outer | Partial<location.XY> | location.XY;
+    prefer?: Array<location.Outer | Partial<location.XY> | location.XY>;
+    disable?: Array<location.Location | Partial<location.XY>>;
+}
+export interface DialogReturn {
+    location: location.XY;
+    adjustedDialog: box.Box;
+}
+export declare const dialog: ({ container: containerCrude, target: targetCrude, dialog: dialogCrude, initial, prefer, alignments, disable, }: DialogProps) => DialogReturn;
+export declare const getRoot: (option: location.XY, alignment: Alignment) => location.XY;

package/dist/spatial/scale/index.d.ts

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

package/dist/spatial/{scale.d.ts → scale/scale.d.ts}

@@ -1,9 +1,9 @@
 import { z } from "zod";
-import * as bounds from './bounds';
-import { type Box } from './box';
-import type * as dims from './dimensions';
-import * as location from './location';
-import * as xy from './xy';
+import * as bounds from '../bounds/bounds';
+import { type Box } from '../box/box';
+import type * as dims from '../dimensions/dimensions';
+import * as location from '../location/location';
+import * as xy from '../xy/xy';
 export declare const crudeXYTransform: z.ZodObject<{
     offset: z.ZodUnion<[z.ZodNumber, z.ZodObject<{
         x: z.ZodNumber;

package/dist/spatial/scale/scale.spec.d.ts

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

package/dist/spatial/xy/index.d.ts

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

package/dist/spatial/{xy.d.ts → xy/xy.d.ts}

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { clientXY, xy, type ClientXY, type XY, type Direction } from './base';
+import { clientXY, xy, type ClientXY, type XY, type Direction } from '../base';
 export { clientXY, xy, type ClientXY as Client, type XY };
 /** A crude representation of a {@link XY} coordinate as a zod schema. */
 export declare const crudeZ: z.ZodUnion<[z.ZodNumber, z.ZodObject<{
@@ -49,7 +49,7 @@ export type Crude = z.infer<typeof crudeZ>;
  * @param y - If x is a number, the y coordinate. If x is a number and this argument is
  * not given, the y coordinate is assumed to be the same as the x coordinate.
  */
-export declare const construct: (x: Crude, y?: number) => XY;
+export declare const construct: (x: Crude | Direction, y?: number) => XY;
 /** An x and y coordinate of zero */
 export declare const ZERO: {
     x: number;
@@ -83,13 +83,13 @@ export declare const scale: (c: Crude, x: number, y?: number) => XY;
 export declare const translateX: (c: Crude, x: number) => XY;
 /** @returns the given coordinate translated in the Y direction by the given amount. */
 export declare const translateY: (c: Crude, y: number) => XY;
-type TranslateOverloadOne = (a: Crude, b: Crude, ...cb: Crude[]) => XY;
-type TranslateOverloadTwo = (a: Crude, direction: Direction, value: number) => XY;
-/**
- * @returns the given coordinate translated by an arbitrary number of translation
- * coordinates.
- */
-export declare const translate: TranslateOverloadOne & TranslateOverloadTwo;
+interface Translate {
+    /** @returns the sum of the given coordinates. */
+    (a: Crude, b: Crude, ...cb: Crude[]): XY;
+    /** @returns the coordinates translated in the given direction by the given value. */
+    (a: Crude, direction: Direction, value: number): XY;
+}
+export declare const translate: Translate;
 /**
  * @returns the given coordinate the given direction set to the given value.
  * @example set({ x: 1, y: 2 }, "x", 3) // { x: 3, y: 2 }
@@ -117,3 +117,4 @@ export declare const css: (a: Crude) => {
     left: number;
     top: number;
 };
+export declare const truncate: (a: Crude, precision?: number) => XY;

package/dist/spatial/xy/xy.spec.d.ts

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

package/dist/telem/series.d.ts

@@ -10,6 +10,7 @@ export interface SeriesDigest {
     alignment: bounds.Bounds;
     timeRange?: string;
     length: number;
+    capacity: number;
 }
 interface BaseSeriesProps {
     dataType?: CrudeDataType;
@@ -23,7 +24,7 @@ export interface SeriesProps extends BaseSeriesProps {
     data: ArrayBuffer | NativeTypedArray;
 }
 export interface SeriesAllocProps extends BaseSeriesProps {
-    length: number;
+    capacity: number;
     dataType: CrudeDataType;
 }
 export interface SeriesMemInfo {
@@ -62,7 +63,7 @@ export declare class Series {
     private writePos;
     /** Tracks the number of entities currently using this array. */
     private _refCount;
-    static alloc({ length, dataType, ...props }: SeriesAllocProps): Series;
+    static alloc({ capacity: length, dataType, ...props }: SeriesAllocProps): Series;
     static generateTimestamps(length: number, rate: Rate, start: TimeStamp): Series;
     get refCount(): number;
     static fromStrings(data: string[], timeRange?: TimeRange): Series;
@@ -70,6 +71,14 @@ export declare class Series {
     constructor({ data, dataType, timeRange, sampleOffset, glBufferUsage, alignment, key, }: SeriesProps);
     acquire(gl?: GLBufferController): void;
     release(): void;
+    /**
+     * Writes the given series to this series. If the series being written exceeds the
+     * remaining of series being written to, only the portion that fits will be written.
+     * @param other the series to write to this series. The data type of the series written
+     * must be the same as the data type of the series being written to.
+     * @returns the number of samples written. If the entire series fits, this value is
+     * equal to the length of the series being written.
+     */
     write(other: Series): number;
     /** @returns the underlying buffer backing this array. */
     get buffer(): ArrayBufferLike;
@@ -81,11 +90,11 @@ export declare class Series {
     parseJSON<Z extends z.ZodTypeAny>(schema: Z): Array<z.output<Z>>;
     /** @returns the time range of this array. */
     get timeRange(): TimeRange;
-    /** @returns the capacity of the underlying buffer in bytes. */
-    get byteCap(): Size;
-    /** @returns the capacity of the underlying buffer in samples. */
-    get cap(): number;
-    /** @returns the length of the underlying buffer in samples. */
+    /** @returns the capacity of the series in bytes. */
+    get byteCapacity(): Size;
+    /** @returns the capacity of the series in samples. */
+    get capacity(): number;
+    /** @returns the length of the series in bytes. */
     get byteLength(): Size;
     /** @returns the number of samples in this array. */
     get length(): number;
@@ -110,7 +119,8 @@ export declare class Series {
     private maybeRecomputeMinMax;
     enrich(): void;
     get range(): SampleValue;
-    at(index: number): SampleValue;
+    at(index: number, required: true): SampleValue;
+    at(index: number, required?: false): SampleValue | undefined;
     /**
      * @returns the index of the first sample that is greater than or equal to the given value.
      * The underlying array must be sorted. If it is not, the behavior of this method is undefined.

package/dist/telem/telem.d.ts

@@ -153,6 +153,7 @@ export declare class TimeStamp extends Number implements Stringer {
     /** @returns true if the day portion TimeStamp is today, false otherwise. */
     get isToday(): boolean;
     truncate(span: TimeSpan | TimeStamp): TimeStamp;
+    get bigInt(): bigint;
     /**
      * @returns A new TimeStamp representing the current time in UTC. It's important to
      * note that this TimeStamp is only accurate to the millisecond level (that's the best
@@ -198,6 +199,10 @@ export declare class TimeStamp extends Number implements Stringer {
 /** TimeSpan represents a nanosecond precision duration. */
 export declare class TimeSpan extends Number implements Stringer {
     constructor(value: CrudeTimeSpan);
+    lessThan(other: CrudeTimeSpan): boolean;
+    greaterThan(other: CrudeTimeSpan): boolean;
+    lessThanOrEqual(other: CrudeTimeSpan): boolean;
+    greaterThanOrEqual(other: CrudeTimeSpan): boolean;
     remainder(divisor: TimeSpan): TimeSpan;
     truncate(span: TimeSpan): TimeSpan;
     multiply(factor: number): TimeSpan;
@@ -465,6 +470,14 @@ export declare class TimeRange implements Stringer {
     equals(other: TimeRange): boolean;
     toString(): string;
     toPrettyString(): string;
+    /**
+     * Checks if if the two time ranges overlap. If the two time ranges are equal, returns
+     * true.  If the start of one range is equal to the end of the other, returns false.
+     * Just follow the rule [start, end) i.e. start is inclusive and end is exclusive.
+     *
+     * @param other - The other TimeRange to compare to.
+     * @returns True if the two TimeRanges overlap, false otherwise.
+     */
     overlapsWith(other: TimeRange): boolean;
     contains(other: TimeRange): boolean;
     contains(ts: CrudeTimeStamp): boolean;
@@ -562,6 +575,13 @@ export declare class Size extends Number implements Stringer {
     smallerThan(other: CrudeSize): boolean;
     add(other: CrudeSize): Size;
     sub(other: CrudeSize): Size;
+    truncate(span: CrudeSize): Size;
+    remainder(span: CrudeSize): Size;
+    get gigabytes(): number;
+    get megabytes(): number;
+    get kilobytes(): number;
+    get terabytes(): number;
+    toString(): string;
     /**
      * Creates a Size from the given number of bytes.
      *
@@ -611,7 +631,7 @@ export declare class Size extends Number implements Stringer {
     static readonly ZERO: Size;
     /** A zod schema for a Size. */
     static readonly z: z.ZodUnion<[z.ZodEffects<z.ZodNumber, Size, number>, z.ZodType<Size, z.ZodTypeDef, Size>]>;
-    isZero(): boolean;
+    get isZero(): boolean;
 }
 export type CrudeTimeStamp = TimeStamp | TimeSpan | number | Date | string | DateComponents | Number;
 export type TimeStampT = number;