@synnaxlabs/client 0.2.0 → 0.2.1

package/src/lib/telem.ts

@@ -1,657 +0,0 @@
-import { registerCustomTypeEncoder } from '@synnaxlabs/freighter';
-
-const valueOfEncoder = (value: unknown): unknown => value?.valueOf();
-
-/**
- * Represents a nanosecond precision UTC timestamp.
- */
-export class TimeStamp extends Number {
-  constructor(value: UnparsedTimeStamp) {
-    super(value);
-  }
-
-  /**
-   * Checks if the TimeStamp is equal to another TimeStamp.
-   * @param other - the other TimeStamp to compare to.
-   * @returns true if the TimeStamps are equal, false otherwise.
-   */
-  equals(other: UnparsedTimeStamp): boolean {
-    return this.valueOf() === new TimeStamp(other).valueOf();
-  }
-
-  /**
-   * Creates a TimeSpan representing the duration between the two timestamps.
-   * @param other - the other TimeStamp to compare to.
-   * @returns a TimeSpan representing the duration between the two timestamps.
-   * The span is guaranteed to be positive.
-   */
-  span(other: UnparsedTimeStamp): TimeSpan {
-    return this.range(other).span();
-  }
-
-  /**
-   * Creates a TimeRange spanning the given TimeStamp.
-   * @param other - the other TimeStamp to compare to.
-   * @returns a TimeRange spanning the given TimeStamp that is guaranteed to be valid,
-   * regardless of the TimeStamp order.
-   */
-  range(other: UnparsedTimeStamp): TimeRange {
-    return new TimeRange(this, other).makeValid();
-  }
-
-  /**
-   * Creates a TimeRange starting at the TimeStamp and spanning the given TimeSpan.
-   * @param other - the TimeSpan to span.
-   * @returns a TimeRange starting at the TimeStamp and spanning the given TimeSpan.
-   * The TimeRange is guaranteed to be valid.
-   */
-  spanRange(other: UnparsedTimeSpan): TimeRange {
-    return this.range(this.add(other)).makeValid();
-  }
-
-  /**
-   * Checks if the TimeStamp represents the unix epoch.
-   * @returns true if the TimeStamp represents the unix epoch, false otherwise.
-   */
-  isZero(): boolean {
-    return this.valueOf() === 0;
-  }
-
-  /**
-   * Checks if the TimeStamp is after the given TimeStamp.
-   * @param other - the other TimeStamp to compare to.
-   * @returns true if the TimeStamp is after the given TimeStamp, false otherwise.
-   */
-  after(other: UnparsedTimeStamp): boolean {
-    return this.valueOf() > new TimeStamp(other).valueOf();
-  }
-
-  /**
-   * Checks if the TimeStamp is after or equal to the given TimeStamp.
-   * @param other - the other TimeStamp to compare to.
-   * @returns true if the TimeStamp is after or equal to the given TimeStamp, false otherwise.
-   */
-  afterEq(other: UnparsedTimeStamp): boolean {
-    return this.valueOf() >= new TimeStamp(other).valueOf();
-  }
-
-  /**
-   * Checks if the TimeStamp is before the given TimeStamp.
-   * @param other - the other TimeStamp to compare to.
-   * @returns true if the TimeStamp is before the given TimeStamp, false otherwise.
-   */
-  before(other: UnparsedTimeStamp): boolean {
-    return this.valueOf() < new TimeStamp(other).valueOf();
-  }
-
-  /**
-   * Checks if TimeStamp is before or equal to the current timestamp.
-   * @param other - the other TimeStamp to compare to.
-   * @returns true if TimeStamp is before or equal to the current timestamp, false otherwise.
-   */
-  beforeEq(other: UnparsedTimeStamp): boolean {
-    return this.valueOf() <= new TimeStamp(other).valueOf();
-  }
-
-  /**
-   * Adds a TimeSpan to the TimeStamp.
-   * @param span - the TimeSpan to add.
-   * @returns a new TimeStamp representing the sum of the TimeStamp and TimeSpan.
-   */
-  add(span: UnparsedTimeSpan): TimeStamp {
-    return new TimeStamp(this.valueOf() + span.valueOf());
-  }
-
-  /**
-   * Subtracts a TimeSpan from the TimeStamp.
-   * @param span - the TimeSpan to subtract.
-   * @returns a new TimeStamp representing the difference of the TimeStamp and TimeSpan.
-   */
-  sub(span: UnparsedTimeSpan): TimeStamp {
-    return new TimeStamp(this.valueOf() - span.valueOf());
-  }
-
-  /** The maximum possible value for a timestamp */
-  static readonly Max = new TimeStamp(TimeStamp.MAX_VALUE);
-
-  /** The minimum possible value for a timestamp */
-  static readonly Min = new TimeStamp(TimeStamp.MIN_VALUE);
-
-  /** The unix epoch */
-  static readonly Zero = new TimeStamp(0);
-}
-
-/**
- * TimeSpan represents a nanosecond precision duration.
- */
-export class TimeSpan extends Number {
-  constructor(value: UnparsedTimeSpan) {
-    super(value);
-  }
-
-  /**
-   * @returns the number of seconds in the TimeSpan.
-   */
-  seconds(): number {
-    return this.valueOf() / TimeSpan.Seconds(1).valueOf();
-  }
-
-  /**
-   * Checks if the TimeSpan represents a zero duration.
-   * @returns true if the TimeSpan represents a zero duration, false otherwise.
-   */
-  isZero(): boolean {
-    return this.valueOf() === 0;
-  }
-
-  /**
-   * Checks if the TimeSpan is equal to another TimeSpan.
-   * @returns true if the TimeSpans are equal, false otherwise.
-   */
-  equals(other: UnparsedTimeSpan): boolean {
-    return this.valueOf() === new TimeSpan(other).valueOf();
-  }
-
-  /**
-   * Adds a TimeSpan to the TimeSpan.
-   * @returns a new TimeSpan representing the sum of the two TimeSpans.
-   */
-  add(other: UnparsedTimeSpan): TimeSpan {
-    return new TimeSpan(this.valueOf() + new TimeSpan(other).valueOf());
-  }
-
-  /**
-   * Creates a TimeSpan representing the duration between the two timestamps.
-   * @param other
-   */
-  sub(other: UnparsedTimeSpan): TimeSpan {
-    return new TimeSpan(this.valueOf() - new TimeSpan(other).valueOf());
-  }
-
-  /**
-   * Creates a TimeSpan representing the given number of nanoseconds.
-   * @param value - the number of nanoseconds.
-   * @returns a TimeSpan representing the given number of nanoseconds.
-   */
-  static Nanoseconds(value: UnparsedTimeSpan = 1): TimeSpan {
-    return new TimeSpan(value);
-  }
-
-  /**
-   * A nanosecond.
-   */
-  static readonly Nanosecond = TimeSpan.Nanoseconds(1);
-
-  /**
-   * Creates a TimeSpan representing the given number of microseconds.
-   * @param value - the number of microseconds.
-   * @returns a TimeSpan representing the given number of microseconds.
-   */
-  static Microseconds(value: UnparsedTimeStamp = 1): TimeSpan {
-    return TimeSpan.Nanoseconds(value.valueOf() * 1000);
-  }
-
-  /**
-   * A microsecond.
-   */
-  static readonly Microsecond = TimeSpan.Microseconds(1);
-
-  /**
-   * Creates a TimeSpan representing the given number of milliseconds.
-   * @param value - the number of milliseconds.
-   * @returns a TimeSpan representing the given number of milliseconds.
-   */
-  static Milliseconds(value: UnparsedTimeStamp = 1): TimeSpan {
-    return TimeSpan.Microseconds(value.valueOf() * 1000);
-  }
-
-  /**
-   * A millisecond.
-   */
-  static readonly Millisecond = TimeSpan.Milliseconds(1);
-
-  /**
-   * Creates a TimeSpan representing the given number of seconds.
-   * @param value - the number of seconds.
-   * @returns a TimeSpan representing the given number of seconds.
-   */
-  static Seconds(value: UnparsedTimeStamp = 1): TimeSpan {
-    return TimeSpan.Milliseconds(value.valueOf() * 1000);
-  }
-
-  /**
-   * A second.
-   */
-  static readonly Second = TimeSpan.Seconds(1);
-
-  /**
-   * Creates a TimeSpan representing the given number of minutes.
-   * @param value - the number of minutes.
-   * @returns a TimeSpan representing the given number of minutes.
-   */
-  static Minutes(value: UnparsedTimeStamp = 1): TimeSpan {
-    return TimeSpan.Seconds(value.valueOf() * 60);
-  }
-
-  /**
-   * A minute.
-   */
-  static readonly Minute = TimeSpan.Minutes(1);
-
-  /**
-   * Creates a TimeSpan representing the given number of hours.
-   * @param value - the number of hours.
-   * @returns a TimeSpan representing the given number of hours.
-   */
-  static Hours(value: UnparsedTimeStamp = 1): TimeSpan {
-    return TimeSpan.Minutes(value.valueOf() * 60);
-  }
-
-  /**
-   * Represents an hour.
-   */
-  static readonly Hour = TimeSpan.Hours(1);
-
-  /**
-   * The maximum possible value for a TimeSpan.
-   */
-  static readonly Max = new TimeSpan(TimeSpan.MAX_VALUE);
-
-  /**
-   * The minimum possible value for a TimeSpan.
-   */
-  static readonly Min = new TimeSpan(TimeSpan.MIN_VALUE);
-
-  /**
-   * The zero value for a TimeSpan.
-   */
-  static readonly Zero = new TimeSpan(0);
-}
-
-/**
- * Rate represents a data rate in Hz.
- */
-export class Rate extends Number {
-  constructor(value: UnparsedRate) {
-    super(value);
-  }
-
-  /**
-   * @returns the number of seconds in the Rate.
-   */
-  equals(other: UnparsedRate): boolean {
-    return this.valueOf() === new Rate(other).valueOf();
-  }
-
-  /**
-   * Calculates the period of the Rate as a TimeSpan.
-   * @returns a TimeSpan representing the period of the Rate.
-   */
-  period(): TimeSpan {
-    return new TimeSpan(TimeSpan.Seconds(this.valueOf()).valueOf());
-  }
-
-  /**
-   * Calculates the number of samples in the given TimeSpan at this rate.
-   * @param duration - the duration to calculate the sample count from.
-   * @returns the number of samples in the given TimeSpan at this rate.
-   */
-  sampleCount(duration: UnparsedTimeSpan): number {
-    return new TimeSpan(duration).seconds() * this.valueOf();
-  }
-
-  /**
-   * Calculates the number of bytes in the given TimeSpan at this rate.
-   * @param span - the duration to calculate the byte count from.
-   * @param density - the density of the data in bytes per sample.
-   * @returns the number of bytes in the given TimeSpan at this rate.
-   */
-  byteCount(span: UnparsedTimeSpan, density: UnparsedDensity): number {
-    return this.sampleCount(span) * new Density(density).valueOf();
-  }
-
-  /**
-   * Calculates a TimeSpan given the number of samples at this rate.
-   * @param sampleCount - the number of samples in the span.
-   * @returns a TimeSpan that corresponds to the given number of samples.
-   */
-  span(sampleCount: number): TimeSpan {
-    return TimeSpan.Seconds(sampleCount / this.valueOf());
-  }
-
-  /**
-   * Calculates a TimeSpan given the number of bytes at this rate.
-   * @param size - the number of bytes in the span.
-   * @param density - the density of the data in bytes per sample.
-   * @returns a TimeSpan that corresponds to the given number of bytes.
-   */
-  byteSpan(size: Size, density: UnparsedDensity): TimeSpan {
-    return this.span(size.valueOf() / density.valueOf());
-  }
-
-  /**
-   * Creates a Rate representing the given number of Hz.
-   * @param value - the number of Hz.
-   * @returns a Rate representing the given number of Hz.
-   */
-  static Hz(value: number): Rate {
-    return new Rate(value);
-  }
-
-  /**
-   * Creates a Rate representing the given number of kHz.
-   * @param value - the number of kHz.
-   * @returns a Rate representing the given number of kHz.
-   */
-  static KHz(value: number): Rate {
-    return Rate.Hz(value * 1000);
-  }
-}
-
-/**
- * Density represents the number of bytes in a value.
- */
-export class Density extends Number {
-  /**
-   * Creates a Density representing the given number of bytes per value.
-   * @param value - the number of bytes per value.
-   * @returns a Density representing the given number of bytes per value.
-   * @constructor
-   */
-  constructor(value: UnparsedDensity) {
-    super(value);
-  }
-
-  /**
-   * Represents an Unknown/Invalid Density.
-   */
-  static readonly Unknown = new Density(0);
-  /**
-   * Represents a Density of 64 bits per value.
-   */
-  static readonly Bit64 = new Density(8);
-  /**
-   * Represents a Density of 32 bits per value.
-   */
-  static readonly Bit32 = new Density(4);
-  /**
-   * Represents a Density of 16 bits per value.
-   */
-  static readonly Bit16 = new Density(2);
-  /**
-   * Represents a Density of 8 bits per value.
-   */
-  static readonly Bit8 = new Density(1);
-}
-
-/**
- * TimeRange represents a range of time between two TimeStamps. It's important
- * to note that the start of the range is inclusive, while the end of the range
- * is exclusive.
- *
- * @property start - a TimeStamp representing the start of the range.
- * @property end - a Timestamp representing the end of the range.
- */
-export class TimeRange {
-  start: TimeStamp;
-  end: TimeStamp;
-
-  /**
-   * Creates a TimeRange from the given start and end TimeStamps.
-   * @param start - a TimeStamp representing the start of the range.
-   * @param end - a TimeStamp representing the end of the range.
-   */
-  constructor(start: UnparsedTimeStamp, end: UnparsedTimeStamp) {
-    this.start = new TimeStamp(start);
-    this.end = new TimeStamp(end);
-  }
-
-  /**
-   * @returns the TimeSpan occupied by the TimeRange.
-   */
-  span(): TimeSpan {
-    return new TimeSpan(this.end.valueOf() - this.start.valueOf());
-  }
-
-  /**
-   * Checks if the timestamp is valid i.e. the start is before the end.
-   * @returns true if the TimeRange is valid.
-   */
-  isValid(): boolean {
-    return this.start.valueOf() <= this.end.valueOf();
-  }
-
-  /**
-   * Makes sure the TimeRange is valid i.e. the start is before the end.
-   * @returns a TimeRange that is valid.
-   */
-  makeValid(): TimeRange {
-    return this.isValid() ? this : this.swap();
-  }
-
-  /**
-   * Checks if the TimeRange has a zero span.
-   * @returns true if the TimeRange has a zero span.
-   */
-  isZero(): boolean {
-    return this.span().isZero();
-  }
-
-  /**
-   * Creates a new TimeRange with the start and end swapped.
-   * @returns a TimeRange with the start and end swapped.
-   */
-  swap(): TimeRange {
-    return new TimeRange(this.end, this.start);
-  }
-
-  /**
-   * Checks if the TimeRange is equal to the given TimeRange.
-   * @param other - the TimeRange to compare to.
-   * @returns true if the TimeRange is equal to the given TimeRange.
-   */
-  equals(other: TimeRange): boolean {
-    return this.start.equals(other.start) && this.end.equals(other.end);
-  }
-
-  static readonly Max = new TimeRange(TimeStamp.Min, TimeStamp.Max);
-}
-
-/**
- * DataType is a string that represents a data type.
- */
-export class DataType extends String {
-  constructor(value: UnparsedDataType) {
-    if (typeof value === 'string') {
-      super(value);
-    } else {
-      super(value.valueOf());
-    }
-  }
-
-  get arrayConstructor(): TypedArrayConstructor {
-    const v = ARRAY_CONSTRUCTORS.get(this.string);
-    if (v === undefined) {
-      throw new Error(`Unknown data type: ${this.string}`);
-    }
-    return v;
-  }
-
-  get string(): string {
-    return this.valueOf();
-  }
-
-  get density(): Density {
-    const v = DATA_TYPE_DENSITIES.get(this.string);
-    if (v === undefined) {
-      throw new Error(`Unknown data type: ${this.string}`);
-    }
-    return v;
-  }
-
-  checkArray(array: TypedArray): boolean {
-    return array.constructor === this.arrayConstructor;
-  }
-
-  toJSON(): string {
-    return this.string;
-  }
-
-  /**
-   * Represents an Unknown/Invalid DataType.
-   */
-  static readonly Unknown = new DataType('unknown');
-  /**
-   * Represents a 64-bit floating point value.
-   */
-  static readonly Float64 = new DataType('float64');
-  /**
-   * Represents a 32-bit floating point value.
-   */
-  static readonly Float32 = new DataType('float32');
-  /**
-   * Represents a 64-bit signed integer value.
-   */
-  static readonly Int64 = new DataType('int64');
-  /**
-   * Represents a 32-bit signed integer value.
-   */
-  static readonly Int32 = new DataType('int32');
-  /**
-   * Represents a 16-bit signed integer value.
-   */
-  static readonly Int16 = new DataType('int16');
-  /**
-   * Represents a 8-bit signed integer value.
-   */
-  static readonly Int8 = new DataType('int8');
-  /**
-   * Represents a 64-bit unsigned integer value.
-   */
-  static readonly Uint64 = new DataType('uint64');
-  /**
-   * Represents a 32-bit unsigned integer value.
-   */
-  static readonly Uint32 = new DataType('uint32');
-  /**
-   * Represents a 16-bit unsigned integer value.
-   */
-  static readonly Uint16 = new DataType('uint16');
-  /**
-   * Represents a 8-bit unsigned integer value.
-   */
-  static readonly Uint8 = new DataType('uint8');
-}
-
-export class Size extends Number {
-  constructor(value: UnparsedSize) {
-    super(value.valueOf());
-  }
-
-  largerThan(other: Size): boolean {
-    return this.valueOf() > other.valueOf();
-  }
-
-  smallerThan(other: Size): boolean {
-    return this.valueOf() < other.valueOf();
-  }
-
-  static Bytes(value: UnparsedSize): Size {
-    return new Size(value);
-  }
-
-  static readonly Byte = new Size(1);
-
-  static Kilobytes(value: UnparsedSize): Size {
-    return Size.Bytes(value.valueOf() * 1e3);
-  }
-
-  static readonly Kilobyte = Size.Kilobytes(1);
-
-  static Megabytes(value: UnparsedSize): Size {
-    return Size.Kilobytes(value.valueOf() * 1e3);
-  }
-
-  static readonly Megabyte = Size.Megabytes(1);
-
-  static Gigabytes(value: UnparsedSize): Size {
-    return Size.Megabytes(value.valueOf() * 1e3);
-  }
-
-  static readonly Gigabyte = Size.Gigabytes(1);
-
-  static Terabytes(value: UnparsedSize): Size {
-    return Size.Gigabytes(value.valueOf() * 1e3);
-  }
-
-  static readonly Terabyte = Size.Terabytes(1);
-}
-
-export type UnparsedTimeStamp = TimeStamp | TimeSpan | number;
-export type UnparsedTimeSpan = TimeSpan | number;
-export type UnparsedRate = Rate | number;
-export type UnparsedDensity = Density | number;
-export type UnparsedDataType = DataType | string;
-export type UnparsedSize = Size | number;
-
-registerCustomTypeEncoder({ Class: TimeStamp, write: valueOfEncoder });
-registerCustomTypeEncoder({ Class: TimeSpan, write: valueOfEncoder });
-registerCustomTypeEncoder({
-  Class: DataType,
-  write: (v) => (v as DataType).string,
-});
-registerCustomTypeEncoder({ Class: Rate, write: valueOfEncoder });
-registerCustomTypeEncoder({ Class: Density, write: valueOfEncoder });
-
-export type TypedArray =
-  | Uint8Array
-  | Uint16Array
-  | Uint32Array
-  | BigUint64Array
-  | Float32Array
-  | Float64Array
-  | Int8Array
-  | Int16Array
-  | Int32Array
-  | BigInt64Array;
-
-type TypedArrayConstructor =
-  | Uint8ArrayConstructor
-  | Uint16ArrayConstructor
-  | Uint32ArrayConstructor
-  | BigUint64ArrayConstructor
-  | Float32ArrayConstructor
-  | Float64ArrayConstructor
-  | Int8ArrayConstructor
-  | Int16ArrayConstructor
-  | Int32ArrayConstructor
-  | BigInt64ArrayConstructor;
-
-const ARRAY_CONSTRUCTORS: Map<string, TypedArrayConstructor> = new Map<
-  string,
-  TypedArrayConstructor
->([
-  [DataType.Uint8.string, Uint8Array],
-  [DataType.Uint16.string, Uint16Array],
-  [DataType.Uint32.string, Uint32Array],
-  [DataType.Uint64.string, BigUint64Array],
-  [DataType.Float32.string, Float32Array],
-  [DataType.Float64.string, Float64Array],
-  [DataType.Int8.string, Int8Array],
-  [DataType.Int16.string, Int16Array],
-  [DataType.Int32.string, Int32Array],
-  [DataType.Int64.string, BigInt64Array],
-]);
-
-const DATA_TYPE_DENSITIES = new Map<string, Density>([
-  [DataType.Uint8.string, Density.Bit8],
-  [DataType.Uint16.string, Density.Bit16],
-  [DataType.Uint32.string, Density.Bit32],
-  [DataType.Uint64.string, Density.Bit64],
-  [DataType.Float32.string, Density.Bit32],
-  [DataType.Float64.string, Density.Bit64],
-  [DataType.Int8.string, Density.Bit8],
-  [DataType.Int16.string, Density.Bit16],
-  [DataType.Int32.string, Density.Bit32],
-  [DataType.Int64.string, Density.Bit64],
-]);

package/src/lib/transport.ts

@@ -1,37 +0,0 @@
-import {
-  HTTPClientFactory,
-  JSONEncoderDecoder,
-  Middleware,
-  StreamClient,
-  UnaryClient,
-  URL,
-  WebSocketClient,
-} from '@synnaxlabs/freighter';
-
-export default class Transport {
-  url: URL;
-  httpFactory: HTTPClientFactory;
-  streamClient: StreamClient;
-
-  constructor(url: URL) {
-    this.url = url.child('/api/v1/');
-    this.httpFactory = new HTTPClientFactory(
-      this.url,
-      new JSONEncoderDecoder()
-    );
-    this.streamClient = new WebSocketClient(new JSONEncoderDecoder(), this.url);
-  }
-
-  getClient(): UnaryClient {
-    return this.httpFactory.getClient();
-  }
-
-  postClient(): UnaryClient {
-    return this.httpFactory.postClient();
-  }
-
-  use(...middleware: Middleware[]) {
-    this.httpFactory.use(...middleware);
-    this.streamClient.use(...middleware);
-  }
-}

package/src/lib/user/payload.ts

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-
-export const UserPayloadSchema = z.object({
-  key: z.string(),
-  username: z.string(),
-});
-
-export type UserPayload = z.infer<typeof UserPayloadSchema>;

package/src/lib/util/telem.ts

@@ -1,13 +0,0 @@
-import { DataType, TypedArray } from '../telem';
-
-export const randomTypedArray = (
-  length: number,
-  dataType: DataType
-): TypedArray => {
-  // generate random bytes of the correct length
-  const bytes = new Uint8Array(length * dataType.density.valueOf());
-  for (let i = 0; i < bytes.byteLength; i++) {
-    bytes[i] = Math.floor(Math.random() * 256);
-  }
-  return new dataType.arrayConstructor(bytes.buffer);
-};