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

The SurrealDB SDK for JavaScript

import { SurrealTypeError } from "@tai-kun/surrealdb/errors";
import type { RpcParams, RpcResultMapping } from "@tai-kun/surrealdb/types";
import { getTimeoutSignal } from "@tai-kun/surrealdb/utils";
import type { UnionToIntersection, ValueOf } from "type-fest";
import rpc_, { type InlineRpcMethod, type InlineRpcOptions } from "./rpc";

const callRpc = rpc_ as (
  endpoint: string | URL,
  method: InlineRpcMethod,
  options: InlineRpcOptions & {
    readonly params: RpcParams<InlineRpcMethod> | undefined;
  },
) => Promise<unknown>;

export type CreateInlineRpcOptions = Omit<InlineRpcOptions, "signal"> & {
  readonly timeout?: number | undefined;
};

interface RpcWithRequiredParams<TMethod extends InlineRpcMethod> {
  <TResult extends RpcResultMapping[TMethod]>(
    method: TMethod,
    options: InlineRpcOptions & { readonly params: RpcParams<TMethod> },
  ): Promise<TResult>;
}

interface RpcWithOptionalParams<TMethod extends InlineRpcMethod> {
  <TResult extends RpcResultMapping[TMethod]>(
    method: TMethod,
    options?:
      | (InlineRpcOptions & { readonly params?: RpcParams<TMethod> })
      | undefined,
  ): Promise<TResult>;
}

/**
 * @experimental
 */
export default function createRpc(
  endpoint: string | URL,
  options: CreateInlineRpcOptions | undefined = {},
): UnionToIntersection<
  ValueOf<
    {
      [TMethod in InlineRpcMethod]: undefined extends RpcParams<TMethod>
        ? RpcWithOptionalParams<TMethod>
        : RpcWithRequiredParams<TMethod>;
    }
  >
> {
  endpoint = new URL(endpoint); // copy
  const {
    timeout = 5000,
    ...defaults
  } = options || {};

  async function rpc(
    method: InlineRpcMethod,
    options:
      | (InlineRpcOptions & { readonly params?: any })
      | undefined = {},
  ): Promise<any> {
    const {
      fetch = defaults.fetch,
      token: tokenProp,
      params,
      signal,
      database = defaults.database,
      formatter = defaults.formatter,
      namespace = defaults.namespace,
    } = options;

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

    const result = await callRpc(endpoint, method, {
      fetch,
      token: defaults.token ?? tokenProp,
      params,
      signal: signal || getTimeoutSignal(timeout),
      database,
      formatter,
      namespace,
    });

    return result;
  }

  return rpc;
}