@tai-kun/surrealdb/src/surreal/inline/create-query.ts

The SurrealDB SDK for JavaScript

import { SurrealTypeError } from "@tai-kun/surrealdb/errors";
import type { InferSlotVars } from "@tai-kun/surrealdb/standard-client";
import type { PreparedQueryLike, SlotLike } from "@tai-kun/surrealdb/types";
import { getTimeoutSignal } from "@tai-kun/surrealdb/utils";
import type { Simplify } from "type-fest";
import req, { type InlineQueryOptions } from "./query";

type Override<T, U> = Simplify<Omit<T, keyof U> & U>;

export type CreateInlineQueryOptions = Omit<InlineQueryOptions, "signal"> & {
  readonly timeout?: number | undefined;
  readonly bindings?: { readonly [p: string]: unknown };
};

/**
 * @experimental
 */
export default function createQuery(
  endpoint: string | URL,
  options?: CreateInlineQueryOptions | undefined,
): {
  <T extends readonly unknown[] = unknown[]>(
    surql: string,
    vars?: { readonly [p: string]: unknown } | undefined,
    options?: InlineQueryOptions | undefined,
  ): Promise<T>;
  <T>(
    surql: Override<PreparedQueryLike, {
      readonly slots: readonly (never | SlotLike<string, false>)[];
      readonly __type: T;
    }>,
    vars?: { readonly [p: string]: unknown } | undefined,
    options?: InlineQueryOptions | undefined,
  ): Promise<T>;
  <S extends SlotLike, T>(
    surql: Override<PreparedQueryLike, {
      readonly slots: readonly S[];
      readonly __type: T;
    }>,
    vars: Simplify<InferSlotVars<S> & { readonly [p: string]: unknown }>,
    options?: InlineQueryOptions | undefined,
  ): Promise<T>;
} {
  const {
    timeout = 5000,
    bindings,
    ...defaults
  } = options || {};

  return async function query(
    surql: string | PreparedQueryLike,
    vars?: { readonly [p: string]: unknown } | undefined,
    options: InlineQueryOptions | undefined = {},
  ) {
    const {
      fetch = defaults.fetch,
      token: tokenProp,
      signal,
      database = defaults.database,
      formatter = defaults.formatter,
      namespace = defaults.namespace,
    } = options;

    if (defaults.token !== undefined && tokenProp !== undefined) {
      throw new SurrealTypeError("undefined", tokenProp);
    }

    if (bindings) {
      if (vars) {
        vars = Object.assign({}, bindings, vars);
      } else {
        vars = bindings;
      }
    }

    return await req(endpoint, surql as string, vars, {
      fetch,
      token: defaults.token ?? tokenProp,
      signal: signal || getTimeoutSignal(timeout),
      database,
      formatter,
      namespace,
    });
  };
}