@tai-kun/surrealdb/src/errors/general.ts

The SurrealDB SDK for JavaScript

import getTypeName, { type TypeName } from "./get-type-name";

// dprint-ignore
type ErrorOptionsBase =
  "cause" extends keyof Error
    ? Readonly<ErrorOptions>
    : { readonly cause?: unknown } // polyfill

export interface SurrealErrorOptions extends ErrorOptionsBase {}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#surrealerror)
 */
export class SurrealError extends Error {
  static {
    this.prototype.name = "SurrealError";
  }

  constructor(message: string, options?: SurrealErrorOptions | undefined) {
    super(message, options);

    if (!("cause" in this) && options && "cause" in options) {
      this.cause = options.cause; // polyfill
    }
  }
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#surrealtypeerror)
 */
export class SurrealTypeError extends SurrealError {
  static {
    this.prototype.name = "SurrealTypeError";
  }

  expected: string;
  actual: TypeName;

  constructor(
    expected: TypeName | readonly TypeName[],
    actual: unknown,
    options?: SurrealErrorOptions | undefined,
  ) {
    expected = typeof expected === "string"
      ? expected
      : expected.slice().sort().join(" | ");
    actual = getTypeName(actual);
    super(`Expected ${expected} but got ${actual}.`, options);
    this.expected = expected;
    this.actual = actual as string;
  }
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#surrealvalueerror)
 */
export class SurrealValueError extends SurrealError {
  static {
    this.prototype.name = "SurrealValueError";
  }

  constructor(
    public expected: string | readonly string[],
    public actual: unknown,
    options?: SurrealErrorOptions | undefined,
  ) {
    expected = typeof expected === "string"
      ? expected
      : expected.slice().sort().join(" | ");
    let s = String(actual);
    s = s && (
      typeof actual === "string"
        ? actual.length < 30 - 2
          ? JSON.stringify(actual)
          : JSON.stringify(`${actual.slice(0, 11)} ... ${actual.slice(-11)}`)
        : s.length < 30
        ? s
        : `${s.slice(0, 12)} ... ${s.slice(-12)}`
    );
    super(
      `Expected ${expected} but got type ${getTypeName(actual)}${
        s && ` of value ${s}`
      }.`,
      options,
    );
  }
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#surrealaggregateerror)
 */
export class SurrealAggregateError extends SurrealError {
  static {
    this.prototype.name = "SurrealAggregateError";
  }

  override cause: unknown[];

  constructor(
    message: string,
    errors: readonly unknown[],
    options?: Omit<SurrealErrorOptions, "cause"> | undefined,
  ) {
    super(message, options);
    this.cause = errors.slice();
  }
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#circularreferenceerror)
 */
export class CircularReferenceError extends SurrealError {
  static {
    this.prototype.name = "CircularReferenceError";
  }

  constructor(
    public reference: unknown,
    options?: SurrealErrorOptions | undefined,
  ) {
    super("Circular reference is detected", options);
  }
}

/**
 * {@link NumberRangeError}
 */
export interface NumberRangeErrorOptions extends SurrealErrorOptions {
  readonly integer?: boolean | undefined;
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#numberrangeerror)
 */
export class NumberRangeError extends SurrealError {
  static {
    this.prototype.name = "NumberRangeError";
  }

  integer: boolean;

  constructor(
    public range: [from: number | bigint, to: number | bigint],
    public actual: number | bigint,
    options: NumberRangeErrorOptions | undefined = {},
  ) {
    super(
      `Value ${actual} is out of range. Expected value to be between `
        + `${range[0]} and ${range[1]}`
        + (options.integer ? " as an integer." : "."),
      options,
    );
    this.integer = !!options.integer;
  }
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#unsupportedruntimeerror)
 */
export class UnsupportedRuntimeError extends SurrealError {
  static {
    this.prototype.name = "UnsupportedRuntimeError";
  }

  // @ts-expect-error
  cause: string;

  constructor(reason: string) {
    super("Unsupported runtime.", { cause: reason });
  }
}

/**
 * [API Reference](https://tai-kun.github.io/surrealdb.js/v2/guides/errors/#unreachableerror)
 */
export class UnreachableError extends SurrealError {
  static {
    this.prototype.name = "UnreachableError";
  }

  constructor(options?: SurrealErrorOptions | undefined) {
    super("Unreachable code reached.", options);
  }
}

export function unreachable(): never;

export function unreachable(cause: never): never;

export function unreachable(...a: [cause?: never]): never {
  throw new UnreachableError(a.length > 0 && { cause: a[0] } || undefined);
}