@synnaxlabs/x 0.11.0 → 0.12.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @synnaxlabs/x@0.11.0 build /home/runner/work/synnax/synnax/x/ts
+> @synnaxlabs/x@0.12.0 build /home/runner/work/synnax/synnax/x/ts
 > tsc --noEmit && vite build
 
 vite v5.1.2 building for production...
@@ -10,8 +10,8 @@ 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.es.js  289.91 kB │ gzip: 54.74 kB │ map: 595.98 kB
+[vite:dts] Declaration files built in 2784ms.
 
-dist/x.cjs.js  290.12 kB │ gzip: 54.70 kB │ map: 594.39 kB
-✓ built in 3.62s
+dist/x.cjs.js  290.78 kB │ gzip: 54.89 kB │ map: 596.09 kB
+✓ built in 3.63s

package/dist/telem/series.d.ts

@@ -23,7 +23,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 +62,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 +70,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 +89,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 +118,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/x.cjs.js

@@ -6470,7 +6470,7 @@ class Series {
       bufferUsage: glBufferUsage
     };
   }
-  static alloc({ length, dataType, ...props }) {
+  static alloc({ capacity: length, dataType, ...props }) {
     if (length === 0)
       throw new Error("[Series] - cannot allocate an array of length 0");
     const data = new new DataType(dataType).Array(length);
@@ -6515,12 +6515,20 @@ class Series {
     else if (this._refCount < 0)
       throw new Error("cannot release an array with a negative reference count");
   }
+  /**
+   * 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) {
     if (!other.dataType.equals(this.dataType))
       throw new Error("buffer must be of the same type as this array");
     if (this.writePos === FULL_BUFFER)
       return 0;
-    const available = this.cap - this.writePos;
+    const available = this.capacity - this.writePos;
     const toWrite = available < other.length ? other.slice(0, available) : other;
     this.underlyingData.set(toWrite.data, this.writePos);
     this.maybeRecomputeMinMax(toWrite);
@@ -6567,18 +6575,18 @@ class Series {
     validateFieldNotNull("timeRange", this._timeRange);
     return this._timeRange;
   }
-  /** @returns the capacity of the underlying buffer in bytes. */
-  get byteCap() {
+  /** @returns the capacity of the series in bytes. */
+  get byteCapacity() {
     return new Size(this.buffer.byteLength);
   }
-  /** @returns the capacity of the underlying buffer in samples. */
-  get cap() {
-    return this.dataType.density.length(this.byteCap);
+  /** @returns the capacity of the series in samples. */
+  get capacity() {
+    return this.dataType.density.length(this.byteCapacity);
   }
-  /** @returns the length of the underlying buffer in samples. */
+  /** @returns the length of the series in bytes. */
   get byteLength() {
     if (this.writePos === FULL_BUFFER)
-      return this.byteCap;
+      return this.byteCapacity;
     return this.dataType.density.size(this.writePos);
   }
   /** @returns the number of samples in this array. */
@@ -6679,10 +6687,15 @@ class Series {
   get range() {
     return addSamples(this.max, -this.min);
   }
-  at(index) {
+  at(index, required) {
+    if (index < 0)
+      index = this.length + index;
     const v = this.data[index];
-    if (v == null)
+    if (v == null) {
+      if (required)
+        throw new Error(`[series] - no value at index ${index}`);
       return void 0;
+    }
     return addSamples(v, this.sampleOffset);
   }
   /**
@@ -6696,7 +6709,7 @@ class Series {
     const cf = newF(value);
     while (left2 <= right2) {
       const mid = Math.floor((left2 + right2) / 2);
-      const cmp = cf(this.at(mid), value);
+      const cmp = cf(this.at(mid, true), value);
       if (cmp === 0)
         return mid;
       if (cmp < 0)
@@ -6718,7 +6731,7 @@ class Series {
     gl.bindBuffer(gl.ARRAY_BUFFER, this.gl.buffer);
     if (this.writePos !== FULL_BUFFER) {
       if (prevBuffer === 0) {
-        gl.bufferData(gl.ARRAY_BUFFER, this.byteCap.valueOf(), gl.STATIC_DRAW);
+        gl.bufferData(gl.ARRAY_BUFFER, this.byteCapacity.valueOf(), gl.STATIC_DRAW);
       }
       const byteOffset = this.dataType.density.size(prevBuffer).valueOf();
       const slice = this.underlyingData.slice(this.gl.prevBuffer, this.writePos);