convex-helpers/index.test.ts

A collection of useful code to complement the official convex package.

import { v } from "convex/values";
import { withoutSystemFields, pick, omit } from "./index.js";
import { test, expect, expectTypeOf } from "vitest";

test("pick", () => {
  const obj = { a: "a", b: "b", c: "c" };
  const picked = pick(obj, ["a", "b"]);
  expect(picked).toEqual({ a: "a", b: "b" });
  expect(pick(obj, [])).toEqual({});
  expect(pick(obj, ["a", "b", "c"])).toEqual({ a: "a", b: "b", c: "c" });
  expect(pick(obj, ["a", "b", "c", "d" as any])).toEqual({
    a: "a",
    b: "b",
    c: "c",
  });

  expectTypeOf(picked).toEqualTypeOf<{ a: string; b: string }>();
});

test("omit", () => {
  const obj = { a: "a", b: "b", c: "c" };
  const omitted = omit(obj, ["a", "b"]);
  expect(omitted).toEqual({ c: "c" });
  expect(omit(obj, [])).toEqual({ a: "a", b: "b", c: "c" });
  expect(omit(obj, ["a", "b", "c", "d" as any])).toEqual({});

  expectTypeOf(omitted).toEqualTypeOf<{ c: string }>();
});

test("withoutSystemFields", () => {
  const obj = { _id: "1", _creationTime: 1, a: "a" };
  const without = withoutSystemFields(obj);
  expect(without).toEqual({ a: "a" });
});

test("withoutSystemFields when fields aren't present", () => {
  const obj = { a: "a" };
  const without = withoutSystemFields(obj);
  expect(without).toEqual({ a: "a" });
});

test("withoutSystemFields type when it's a union", () => {
  const obj = { a: "a" } as
    | { a: string }
    | { _id: string; _creationTime: number };
  const without = withoutSystemFields(obj);
  expect(without).toEqual({ a: "a" });
  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
  expectTypeOf(without).toEqualTypeOf<{ a: string } | {}>();
  const obj2 = { _id: "1", _creationTime: 1, a: "a" } as
    | { _id: string; _creationTime: number; a: string }
    | { _id: string; _creationTime: number; b: string };
  const without2 = withoutSystemFields(obj2);
  expect(without2).toEqual({ a: "a" });
  expectTypeOf(without2).toEqualTypeOf<{ a: string } | { b: string }>();
});

test("withoutSystemFields works on validators too", () => {
  const validator = v.object({
    _id: v.string(),
    _creationTime: v.number(),
    a: v.string(),
  });
  const { _id, _creationTime, ..._rest } = validator.fields;
  const without = withoutSystemFields(validator.fields);
  expectTypeOf(without).toEqualTypeOf<typeof _rest>();
});