convex-helpers 0.1.96 → 0.1.97

package/index.test.ts

@@ -1,7 +1,32 @@
 import { v } from "convex/values";
-import { withoutSystemFields } from "./index.js";
+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);
@@ -20,6 +45,7 @@ test("withoutSystemFields type when it's a union", () => {
     | { _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 }
@@ -35,7 +61,7 @@ test("withoutSystemFields works on validators too", () => {
     _creationTime: v.number(),
     a: v.string(),
   });
-  const { _id, _creationTime, ...rest } = validator.fields;
+  const { _id, _creationTime, ..._rest } = validator.fields;
   const without = withoutSystemFields(validator.fields);
-  expectTypeOf(without).toEqualTypeOf<typeof rest>();
+  expectTypeOf(without).toEqualTypeOf<typeof _rest>();
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convex-helpers",
-  "version": "0.1.96",
+  "version": "0.1.97",
   "description": "A collection of useful code to complement the official convex package.",
   "type": "module",
   "bin": {

package/validators.d.ts

@@ -1,4 +1,4 @@
-import type { GenericValidator, Infer, ObjectType, PropertyValidators, VObject, VOptional, VString, VUnion, Validator } from "convex/values";
+import type { GenericValidator, Infer, ObjectType, OptionalProperty, PropertyValidators, VLiteral, VObject, VOptional, VString, VUnion, Validator } from "convex/values";
 import type { Expand } from "./index.js";
 import type { DataModelFromSchemaDefinition, GenericDatabaseReader, GenericDataModel, SchemaDefinition, TableNamesInDataModel } from "convex/server";
 /**
@@ -18,7 +18,7 @@ import type { DataModelFromSchemaDefinition, GenericDatabaseReader, GenericDataM
  * @param args Values you want to use in a union of literals.
  * @returns A validator for the union of the literals.
  */
-export declare const literals: <V extends string | number | boolean | bigint, T extends V[]>(...args: T) => VUnion<T[number], any>;
+export declare const literals: <T extends (string | number | boolean | bigint)[]>(...args: T) => VUnion<T[number], VLiteral<T[number]>[]>;
 /**
  * nullable define a validator that can be the value or null more consisely.
  *
@@ -32,29 +32,38 @@ export declare const nullable: <V extends Validator<any, "required", any>>(x: V)
  * e.g. `partial({a: v.string(), b: v.number()})` is equivalent to
  * `{a: v.optional(v.string()), b: v.optional(v.number())}`
  *
+ * And `partial(v.object({a: v.string(), b: v.number()}))` is equivalent to
+ * `v.object({a: v.optional(v.string()), b: v.optional(v.number())})`
+ *
  * @param obj The object of validators to make optional. e.g. {a: v.string()}
  * @returns A new object of validators that can be the value or undefined.
  */
-export declare const partial: <T extends PropertyValidators>(obj: T) => { [K in keyof T]: VOptional<T[K]>; };
-/** Any string value. */
+export declare function partial<T extends PropertyValidators>(obj: T): {
+    [K in keyof T]: VOptional<T[K]>;
+};
+export declare function partial<T, V extends Record<string, GenericValidator>, O extends OptionalProperty>(obj: VObject<T, V, O>): PartialVObject<T, V, O>;
+type PartialVObject<T, V extends Record<string, GenericValidator>, O extends OptionalProperty> = VObject<Partial<T>, {
+    [K in keyof V]: VOptional<V[K]>;
+}, O>;
+/** @deprecated Use `v.string()` instead. Any string value. */
 export declare const string: VString<string, "required">;
-/** JavaScript number, represented as a float64 in the database. */
+/** @deprecated Use `v.float64()` instead. JavaScript number, represented as a float64 in the database. */
 export declare const number: import("convex/values").VFloat64<number, "required">;
-/** JavaScript number, represented as a float64 in the database. */
+/** @deprecated Use `v.float64()` instead. JavaScript number, represented as a float64 in the database. */
 export declare const float64: import("convex/values").VFloat64<number, "required">;
-/** boolean value. For typing it only as true, use `l(true)` */
+/** @deprecated Use `v.boolean()` instead. boolean value. For typing it only as true, use `l(true)` */
 export declare const boolean: import("convex/values").VBoolean<boolean, "required">;
-/** bigint, though stored as an int64 in the database. */
-export declare const bigint: import("convex/values").VInt64<bigint, "required">;
-/** bigint, though stored as an int64 in the database. */
+/** @deprecated Use `v.int64()` instead. bigint, though stored as an int64 in the database. */
+export declare const biging: import("convex/values").VInt64<bigint, "required">;
+/** @deprecated Use `v.int64()` instead. bigint, though stored as an int64 in the database. */
 export declare const int64: import("convex/values").VInt64<bigint, "required">;
-/** Any Convex value */
+/** @deprecated Use `v.any()` instead. Any Convex value */
 export declare const any: import("convex/values").VAny<any, "required", string>;
-/** Null value. Underscore is so it doesn't shadow the null builtin */
+/** @deprecated Use `v.null()` instead. Null value. Underscore is so it doesn't shadow the null builtin */
 export declare const null_: import("convex/values").VNull<null, "required">;
-/** Re-export values from v without having to do v.* */
-export declare const id: <TableName extends string>(tableName: TableName) => import("convex/values").VId<import("convex/values").GenericId<TableName>, "required">, object: <T_2 extends PropertyValidators>(fields: T_2) => VObject<import("convex/server").Expand<{ [Property in { [Property_1 in keyof T_2]: T_2[Property_1]["isOptional"] extends "optional" ? Property_1 : never; }[keyof T_2]]?: Exclude<Infer<T_2[Property]>, undefined> | undefined; } & { [Property_1 in Exclude<keyof T_2, { [Property in keyof T_2]: T_2[Property]["isOptional"] extends "optional" ? Property : never; }[keyof T_2]>]: Infer<T_2[Property_1]>; }>, T_2, "required", { [Property_2 in keyof T_2]: Property_2 | `${Property_2 & string}.${T_2[Property_2]["fieldPaths"]}`; }[keyof T_2] & string>, array: <T_1 extends Validator<any, "required", any>>(element: T_1) => import("convex/values").VArray<T_1["type"][], T_1, "required">, bytes: () => import("convex/values").VBytes<ArrayBuffer, "required">, literal: <T extends string | number | bigint | boolean>(literal: T) => import("convex/values").VLiteral<T, "required">, optional: <T_4 extends GenericValidator>(value: T_4) => VOptional<T_4>, union: <T_3 extends Validator<any, "required", any>[]>(...members: T_3) => VUnion<T_3[number]["type"], T_3, "required", T_3[number]["fieldPaths"]>;
-/** ArrayBuffer validator. */
+/** @deprecated Use `v.*()` instead. */
+export declare const id: <TableName extends string>(tableName: TableName) => import("convex/values").VId<import("convex/values").GenericId<TableName>, "required">, object: <T_2 extends PropertyValidators>(fields: T_2) => VObject<import("convex/server").Expand<{ [Property in { [Property_1 in keyof T_2]: T_2[Property_1]["isOptional"] extends "optional" ? Property_1 : never; }[keyof T_2]]?: Exclude<Infer<T_2[Property]>, undefined> | undefined; } & { [Property_1 in Exclude<keyof T_2, { [Property in keyof T_2]: T_2[Property]["isOptional"] extends "optional" ? Property : never; }[keyof T_2]>]: Infer<T_2[Property_1]>; }>, T_2, "required", { [Property_2 in keyof T_2]: Property_2 | `${Property_2 & string}.${T_2[Property_2]["fieldPaths"]}`; }[keyof T_2] & string>, array: <T_1 extends Validator<any, "required", any>>(element: T_1) => import("convex/values").VArray<T_1["type"][], T_1, "required">, bytes: () => import("convex/values").VBytes<ArrayBuffer, "required">, literal: <T extends string | number | bigint | boolean>(literal: T) => VLiteral<T, "required">, optional: <T_4 extends GenericValidator>(value: T_4) => VOptional<T_4>, union: <T_3 extends Validator<any, "required", any>[]>(...members: T_3) => VUnion<T_3[number]["type"], T_3, "required", T_3[number]["fieldPaths"]>;
+/** @deprecated Use `v.bytes()` instead. ArrayBuffer validator. */
 export declare const arrayBuffer: import("convex/values").VBytes<ArrayBuffer, "required">;
 /**
  * Utility to get the validators for fields associated with a table.
@@ -129,7 +138,7 @@ export declare function typedV<Schema extends SchemaDefinition<any, boolean>>(sc
     boolean: () => import("convex/values").VBoolean<boolean, "required">;
     string: () => VString<string, "required">;
     bytes: () => import("convex/values").VBytes<ArrayBuffer, "required">;
-    literal: <T extends string | number | bigint | boolean>(literal: T) => import("convex/values").VLiteral<T, "required">;
+    literal: <T extends string | number | bigint | boolean>(literal: T) => VLiteral<T, "required">;
     array: <T_1 extends Validator<any, "required", any>>(element: T_1) => import("convex/values").VArray<T_1["type"][], T_1, "required">;
     object: <T_2 extends PropertyValidators>(fields: T_2) => VObject<import("convex/server").Expand<{ [Property in { [Property_1 in keyof T_2]: T_2[Property_1]["isOptional"] extends "optional" ? Property_1 : never; }[keyof T_2]]?: Exclude<Infer<T_2[Property]>, undefined> | undefined; } & { [Property_1 in Exclude<keyof T_2, { [Property in keyof T_2]: T_2[Property]["isOptional"] extends "optional" ? Property : never; }[keyof T_2]>]: Infer<T_2[Property_1]>; }>, T_2, "required", { [Property_2 in keyof T_2]: Property_2 | `${Property_2 & string}.${T_2[Property_2]["fieldPaths"]}`; }[keyof T_2] & string>;
     record: <Key extends Validator<string, "required", any>, Value extends Validator<any, "required", any>>(keys: Key, values: Value) => import("convex/values").VRecord<Record<Infer<Key>, Value["type"]>, Key, Value, "required", string>;
@@ -247,4 +256,5 @@ export declare function validate<T extends Validator<any, any, any>>(validator:
  * @returns The parsed value, without fields not specified in the validator.
  */
 export declare function parse<T extends Validator<any, any, any>>(validator: T, value: unknown): Infer<T>;
+export {};
 //# sourceMappingURL=validators.d.ts.map

package/validators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["validators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,KAAK,EACL,UAAU,EACV,kBAAkB,EAClB,OAAO,EACP,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EACV,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,EACV,6BAA6B,EAC7B,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,GACnB,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAC5C,CAAC,SAAS,CAAC,EAAE,EAEb,GAAG,MAAM,CAAC,KACT,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,CAMvB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,iNAClD,CAAC;AAEvB;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,kBAAkB,EAAE,KAAK,CAAC,KAMrD,GACF,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAElC,CAAC;AAIF,wBAAwB;AACxB,eAAO,MAAM,MAAM,6BAAa,CAAC;AACjC,mEAAmE;AACnE,eAAO,MAAM,MAAM,sDAAc,CAAC;AAClC,mEAAmE;AACnE,eAAO,MAAM,OAAO,sDAAc,CAAC;AACnC,+DAA+D;AAC/D,eAAO,MAAM,OAAO,uDAAc,CAAC;AACnC,yDAAyD;AACzD,eAAO,MAAM,MAAM,oDAAY,CAAC;AAChC,yDAAyD;AACzD,eAAO,MAAM,KAAK,oDAAY,CAAC;AAC/B,uBAAuB;AACvB,eAAO,MAAM,GAAG,uDAAU,CAAC;AAC3B,sEAAsE;AACtE,eAAO,MAAM,KAAK,iDAAW,CAAC;AAC9B,uDAAuD;AACvD,eAAO,MAAQ,EAAE,6IAAE,MAAM,0NAMG,CAAC,+TAMC,eAAe,0CAZlB,KAAK,iIAAE,KAAK,iEAAE,OAAO,iHAAE,QAAQ,gEAAE,KAAK,6EAqC9D,WACF,2BACmB,WAAY,eAvCuC,CAAC;AACxE,6BAA6B;AAC7B,eAAO,MAAM,WAAW,yDAAU,CAAC;AAEnC;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,SAAS,MAAM,EACnD,WAAW,SAAS;;;CAIpB,CAAC;AAEH,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,MAAM,IAAI,UAAU,CAC7D,OAAO,YAAY,CAAC,SAAS,CAAC,CAC/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,SAAS,MAAM,EACxB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAE1C,WAAW,SAAS,EACpB,QAAQ,CAAC,KAMJ,MAAM,CAAC,CAAC;;;CAAgB,CAC9B,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAClC,MAAM,SAAS,kBAAkB,IAEjC,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACxC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,GAC9D,SAAS,CACP,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,EACtC,CAAC,CAAC,YAAY,CAAC,EACf,CAAC,CAAC,YAAY,CAAC,GACb;KACG,QAAQ,IAAI,MAAM,MAAM,GAAG,MAAM,GAC9B,GAAG,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,GAC/C,QAAQ;CACb,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,GACxB,MAAM,CACT,CAAC;AAER,eAAO,MAAM,GAAG,GACd,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,EAC7C,SAAS,SAAS,qBAAqB,CACrC,6BAA6B,CAAC,MAAM,CAAC,CACtC,EAED,QAAQ,MAAM,EACd,WAAW,SAAS,KACnB,oBAAoB,CACrB,CAAC,OAAO,MAAM,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,EACjD,YAAY,CAAC,SAAS,CAAC,CAmBxB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,MAAM,CAAC,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,EAClE,MAAM,EAAE,MAAM;IAIZ;;;;OAIG;SAED,SAAS,SAAS,qBAAqB,CACrC,6BAA6B,CAAC,MAAM,CAAC,CACtC,aAEU,SAAS;IAEtB;;;;;;;;OAQG;UAED,SAAS,SAAS,qBAAqB,CACrC,6BAA6B,CAAC,MAAM,CAAC,CACtC,aAEU,SAAS,KACnB,oBAAoB,CACrB,CAAC,OAAO,MAAM,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,EACjD,YAAY,CAAC,SAAS,CAAC,CACxB;;;;;;;;;;;oOA9IuB,CAAC,+TAMC,eAAe;;2DAwB3C,GAAC,wBACA,WACF,2BACmB,WAAY;;;EA+G/B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAAE,QAAQ,CAAC,KACzC,OAAO,CAAC,MAAM,GAAG;IAAE,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAE3C,6EAA6E;AAC7E,eAAO,MAAM,UAAU,EAA0B,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,gBAAgB,EAAE,iBAAiB,CAAC,KAAG,CAC/C,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,EACvE,cAAc,CAAC,KACd,CAA6C,CAAC;AAEjD,qBAAa,eAAgB,SAAQ,KAAK;IAE/B,QAAQ,EAAE,MAAM;IAChB,GAAG,EAAE,MAAM;IACX,IAAI,CAAC,EAAE,MAAM;gBAFb,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,YAAA;CAMvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACzD,SAAS,EAAE,CAAC,EACZ,KAAK,EAAE,OAAO,EACd,IAAI,CAAC,EAAE;IAEL,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,EAAE,CAAC,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IAE7C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAG7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CA+LpB;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACtD,SAAS,EAAE,CAAC,EACZ,KAAK,EAAE,OAAO,GACb,KAAK,CAAC,CAAC,CAAC,CAGV"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["validators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,KAAK,EACL,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,QAAQ,EACR,OAAO,EACP,SAAS,EACT,OAAO,EACP,MAAM,EACN,SAAS,EACV,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,KAAK,EACV,6BAA6B,EAC7B,qBAAqB,EACrB,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,EAAE,EACvE,GAAG,MAAM,CAAC,KAEgC,MAAM,CAC9C,CAAC,CAAC,MAAM,CAAC,EACT,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAExB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,iNAClD,CAAC;AAEvB;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,kBAAkB,EAClD,GAAG,EAAE,CAAC,GACL;KACA,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,CAAC;AACF,wBAAgB,OAAO,CACrB,CAAC,EACD,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAC1C,CAAC,SAAS,gBAAgB,EAC1B,GAAG,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAsDlD,KAAK,cAAc,CACjB,CAAC,EACD,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAC1C,CAAC,SAAS,gBAAgB,IACxB,OAAO,CACT,OAAO,CAAC,CAAC,CAAC,EACV;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC,EACD,CAAC,CACF,CAAC;AAIF,8DAA8D;AAC9D,eAAO,MAAM,MAAM,6BAAa,CAAC;AACjC,0GAA0G;AAC1G,eAAO,MAAM,MAAM,sDAAc,CAAC;AAClC,0GAA0G;AAC1G,eAAO,MAAM,OAAO,sDAAc,CAAC;AACnC,sGAAsG;AACtG,eAAO,MAAM,OAAO,uDAAc,CAAC;AACnC,8FAA8F;AAC9F,eAAO,MAAM,MAAM,oDAAY,CAAC;AAChC,8FAA8F;AAC9F,eAAO,MAAM,KAAK,oDAAY,CAAC;AAC/B,0DAA0D;AAC1D,eAAO,MAAM,GAAG,uDAAU,CAAC;AAC3B,0GAA0G;AAC1G,eAAO,MAAM,KAAK,iDAAW,CAAC;AAC9B,uCAAuC;AACvC,eAAO,MAAQ,EAAE,6IAAE,MAAM,0NAjDqC,CAAC,+TAM/D,eAAe,0CA2CY,KAAK,iIAAE,KAAK,iEAAE,OAAO,yFAAE,QAAQ,gEAAE,KAAK,6EAdjD,WAAW,2BACT,WAAY,eAayC,CAAC;AACxE,kEAAkE;AAClE,eAAO,MAAM,WAAW,yDAAY,CAAC;AAErC;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,GAAI,SAAS,SAAS,MAAM,EACnD,WAAW,SAAS;;;CAIpB,CAAC;AAEH,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,MAAM,IAAI,UAAU,CAC7D,OAAO,YAAY,CAAC,SAAS,CAAC,CAC/B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,GAC3B,SAAS,SAAS,MAAM,EACxB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,EAE1C,WAAW,SAAS,EACpB,QAAQ,CAAC,KAMJ,MAAM,CAAC,CAAC;;;CAAgB,CAC9B,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAC9B,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAClC,MAAM,SAAS,kBAAkB,IAEjC,CAAC,SAAS,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACxC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,GAC9D,SAAS,CACP,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,EACtC,CAAC,CAAC,YAAY,CAAC,EACf,CAAC,CAAC,YAAY,CAAC,GACb;KACG,QAAQ,IAAI,MAAM,MAAM,GAAG,MAAM,GAC9B,GAAG,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,EAAE,GAC/C,QAAQ;CACb,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,GACxB,MAAM,CACT,CAAC;AAER,eAAO,MAAM,GAAG,GACd,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,EAC7C,SAAS,SAAS,qBAAqB,CACrC,6BAA6B,CAAC,MAAM,CAAC,CACtC,EAED,QAAQ,MAAM,EACd,WAAW,SAAS,KACnB,oBAAoB,CACrB,CAAC,OAAO,MAAM,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,EACjD,YAAY,CAAC,SAAS,CAAC,CAmBxB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,MAAM,CAAC,MAAM,SAAS,gBAAgB,CAAC,GAAG,EAAE,OAAO,CAAC,EAClE,MAAM,EAAE,MAAM;IAIZ;;;;OAIG;SAED,SAAS,SAAS,qBAAqB,CACrC,6BAA6B,CAAC,MAAM,CAAC,CACtC,aAEU,SAAS;IAEtB;;;;;;;;OAQG;UAED,SAAS,SAAS,qBAAqB,CACrC,6BAA6B,CAAC,MAAM,CAAC,CACtC,aAEU,SAAS,KACnB,oBAAoB,CACrB,CAAC,OAAO,MAAM,EAAE,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,EACjD,YAAY,CAAC,SAAS,CAAC,CACxB;;;;;;;;;;;oOArMyD,CAAC,+TAM/D,eAAe;;2DA4BiF,GAAG,wBACnF,WAAW,2BACT,WAAY;;;EAmK7B;AAED;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,MAAM,EAAE,QAAQ,CAAC,KACzC,OAAO,CAAC,MAAM,GAAG;IAAE,CAAC,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAE3C,6EAA6E;AAC7E,eAAO,MAAM,UAAU,EAA0B,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;AAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,gBAAgB,EAAE,iBAAiB,CAAC,KAAG,CAC/C,CAAC;AAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,CAAC,EACvE,cAAc,CAAC,KACd,CAA6C,CAAC;AAEjD,qBAAa,eAAgB,SAAQ,KAAK;IAE/B,QAAQ,EAAE,MAAM;IAChB,GAAG,EAAE,MAAM;IACX,IAAI,CAAC,EAAE,MAAM;gBAFb,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,MAAM,YAAA;CAMvB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACzD,SAAS,EAAE,CAAC,EACZ,KAAK,EAAE,OAAO,EACd,IAAI,CAAC,EAAE;IAEL,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,EAAE,CAAC,EAAE,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;IAE7C,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAG7B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,KAAK,IAAI,CAAC,CAAC,MAAM,CAAC,CA+LpB;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EACtD,SAAS,EAAE,CAAC,EACZ,KAAK,EAAE,OAAO,GACb,KAAK,CAAC,CAAC,CAAC,CAGV"}

package/validators.js

@@ -17,9 +17,6 @@ import { v } from "convex/values";
  * @returns A validator for the union of the literals.
  */
 export const literals = (...args) => {
-    // The `any` above is unfortunate, because then we cannot get proper types
-    // for `validator.members`, but without it, TypeScript seems to have a hard
-    // time inferring the TS type for the first parameter.
     return v.union(...args.map(v.literal));
 };
 /**
@@ -29,42 +26,67 @@ export const literals = (...args) => {
  * @returns A new validator that can be the value or null.
  */
 export const nullable = (x) => v.union(v.null(), x);
+export function partial(fieldsOrObjOrUnion) {
+    if (fieldsOrObjOrUnion.isConvexValidator) {
+        if (fieldsOrObjOrUnion.kind === "object") {
+            return partialVObject(fieldsOrObjOrUnion);
+        }
+        return fieldsOrObjOrUnion;
+    }
+    return partialFields(fieldsOrObjOrUnion);
+}
 /**
- * partial helps you define an object of optional validators more concisely.
+ * partialFields helps you define an object of optional validators more concisely.
  *
- * e.g. `partial({a: v.string(), b: v.number()})` is equivalent to
+ * e.g. `partialFields({a: v.string(), b: v.number()})` is equivalent to
  * `{a: v.optional(v.string()), b: v.optional(v.number())}`
  *
  * @param obj The object of validators to make optional. e.g. {a: v.string()}
  * @returns A new object of validators that can be the value or undefined.
  */
-export const partial = (obj) => {
+function partialFields(obj) {
     return Object.fromEntries(Object.entries(obj).map(([k, vv]) => [
         k,
         vv.isOptional === "optional" ? vv : v.optional(vv),
     ]));
-};
+}
+/**
+ * partialObject helps you define an object of optional validators more concisely.
+ *
+ * e.g. `partialObject({a: v.string(), b: v.number()})` is equivalent to
+ * `{a: v.optional(v.string()), b: v.optional(v.number())}`
+ *
+ * @param obj The object of validators to make optional. e.g. {a: v.string()}
+ * @returns A new object of validators that can be the value or undefined.
+ */
+function partialVObject(obj) {
+    const o = v.object(partialFields(obj.fields));
+    if (obj.isOptional === "optional") {
+        return v.optional(o);
+    }
+    return o;
+}
 // Shorthand for defining validators that look like types.
-/** Any string value. */
+/** @deprecated Use `v.string()` instead. Any string value. */
 export const string = v.string();
-/** JavaScript number, represented as a float64 in the database. */
+/** @deprecated Use `v.float64()` instead. JavaScript number, represented as a float64 in the database. */
 export const number = v.float64();
-/** JavaScript number, represented as a float64 in the database. */
+/** @deprecated Use `v.float64()` instead. JavaScript number, represented as a float64 in the database. */
 export const float64 = v.float64();
-/** boolean value. For typing it only as true, use `l(true)` */
+/** @deprecated Use `v.boolean()` instead. boolean value. For typing it only as true, use `l(true)` */
 export const boolean = v.boolean();
-/** bigint, though stored as an int64 in the database. */
-export const bigint = v.int64();
-/** bigint, though stored as an int64 in the database. */
+/** @deprecated Use `v.int64()` instead. bigint, though stored as an int64 in the database. */
+export const biging = v.int64();
+/** @deprecated Use `v.int64()` instead. bigint, though stored as an int64 in the database. */
 export const int64 = v.int64();
-/** Any Convex value */
+/** @deprecated Use `v.any()` instead. Any Convex value */
 export const any = v.any();
-/** Null value. Underscore is so it doesn't shadow the null builtin */
+/** @deprecated Use `v.null()` instead. Null value. Underscore is so it doesn't shadow the null builtin */
 export const null_ = v.null();
-/** Re-export values from v without having to do v.* */
+/** @deprecated Use `v.*()` instead. */
 export const { id, object, array, bytes, literal, optional, union } = v;
-/** ArrayBuffer validator. */
-export const arrayBuffer = bytes();
+/** @deprecated Use `v.bytes()` instead. ArrayBuffer validator. */
+export const arrayBuffer = v.bytes();
 /**
  * Utility to get the validators for fields associated with a table.
  * e.g. for systemFields("users") it would return:
@@ -353,7 +375,7 @@ export function validate(validator, value, opts) {
                     prototype?.constructor?.name === "Object";
                 if (!isSimple) {
                     expected =
-                        prototype?.constructor?.name ?? (typeof prototype || "object");
+                        (prototype?.constructor?.name ?? typeof prototype) || "object";
                     valid = false;
                     break;
                 }

package/validators.ts

@@ -2,7 +2,9 @@ import type {
   GenericValidator,
   Infer,
   ObjectType,
+  OptionalProperty,
   PropertyValidators,
+  VLiteral,
   VObject,
   VOptional,
   VString,
@@ -36,17 +38,13 @@ import type {
  * @param args Values you want to use in a union of literals.
  * @returns A validator for the union of the literals.
  */
-export const literals = <
-  V extends string | number | boolean | bigint,
-  T extends V[],
->(
+export const literals = <T extends (string | number | boolean | bigint)[]>(
   ...args: T
-): VUnion<T[number], any> => {
-  // The `any` above is unfortunate, because then we cannot get proper types
-  // for `validator.members`, but without it, TypeScript seems to have a hard
-  // time inferring the TS type for the first parameter.
-
-  return v.union(...args.map(v.literal)) as any;
+) => {
+  return v.union(...args.map(v.literal)) as VUnion<
+    T[number],
+    VLiteral<T[number]>[]
+  >;
 };
 
 /**
@@ -64,42 +62,109 @@ export const nullable = <V extends Validator<any, "required", any>>(x: V) =>
  * e.g. `partial({a: v.string(), b: v.number()})` is equivalent to
  * `{a: v.optional(v.string()), b: v.optional(v.number())}`
  *
+ * And `partial(v.object({a: v.string(), b: v.number()}))` is equivalent to
+ * `v.object({a: v.optional(v.string()), b: v.optional(v.number())})`
+ *
+ * @param obj The object of validators to make optional. e.g. {a: v.string()}
+ * @returns A new object of validators that can be the value or undefined.
+ */
+export function partial<T extends PropertyValidators>(
+  obj: T,
+): {
+  [K in keyof T]: VOptional<T[K]>;
+};
+export function partial<
+  T,
+  V extends Record<string, GenericValidator>,
+  O extends OptionalProperty,
+>(obj: VObject<T, V, O>): PartialVObject<T, V, O>;
+export function partial(fieldsOrObjOrUnion: any) {
+  if (fieldsOrObjOrUnion.isConvexValidator) {
+    if (fieldsOrObjOrUnion.kind === "object") {
+      return partialVObject(fieldsOrObjOrUnion);
+    }
+    return fieldsOrObjOrUnion;
+  }
+  return partialFields(fieldsOrObjOrUnion);
+}
+
+/**
+ * partialFields helps you define an object of optional validators more concisely.
+ *
+ * e.g. `partialFields({a: v.string(), b: v.number()})` is equivalent to
+ * `{a: v.optional(v.string()), b: v.optional(v.number())}`
+ *
  * @param obj The object of validators to make optional. e.g. {a: v.string()}
  * @returns A new object of validators that can be the value or undefined.
  */
-export const partial = <T extends PropertyValidators>(obj: T) => {
+function partialFields<T extends PropertyValidators>(
+  obj: T,
+): {
+  [K in keyof T]: VOptional<T[K]>;
+} {
   return Object.fromEntries(
     Object.entries(obj).map(([k, vv]) => [
       k,
       vv.isOptional === "optional" ? vv : v.optional(vv),
     ]),
-  ) as {
-    [K in keyof T]: VOptional<T[K]>;
-  };
-};
+  ) as any;
+}
+
+/**
+ * partialObject helps you define an object of optional validators more concisely.
+ *
+ * e.g. `partialObject({a: v.string(), b: v.number()})` is equivalent to
+ * `{a: v.optional(v.string()), b: v.optional(v.number())}`
+ *
+ * @param obj The object of validators to make optional. e.g. {a: v.string()}
+ * @returns A new object of validators that can be the value or undefined.
+ */
+function partialVObject<
+  T,
+  V extends Record<string, GenericValidator>,
+  O extends OptionalProperty,
+>(obj: VObject<T, V, O>): PartialVObject<T, V, O> {
+  const o = v.object(partialFields(obj.fields));
+  if (obj.isOptional === "optional") {
+    return v.optional(o) as any;
+  }
+  return o as any;
+}
+
+type PartialVObject<
+  T,
+  V extends Record<string, GenericValidator>,
+  O extends OptionalProperty,
+> = VObject<
+  Partial<T>,
+  {
+    [K in keyof V]: VOptional<V[K]>;
+  },
+  O
+>;
 
 // Shorthand for defining validators that look like types.
 
-/** Any string value. */
+/** @deprecated Use `v.string()` instead. Any string value. */
 export const string = v.string();
-/** JavaScript number, represented as a float64 in the database. */
+/** @deprecated Use `v.float64()` instead. JavaScript number, represented as a float64 in the database. */
 export const number = v.float64();
-/** JavaScript number, represented as a float64 in the database. */
+/** @deprecated Use `v.float64()` instead. JavaScript number, represented as a float64 in the database. */
 export const float64 = v.float64();
-/** boolean value. For typing it only as true, use `l(true)` */
+/** @deprecated Use `v.boolean()` instead. boolean value. For typing it only as true, use `l(true)` */
 export const boolean = v.boolean();
-/** bigint, though stored as an int64 in the database. */
-export const bigint = v.int64();
-/** bigint, though stored as an int64 in the database. */
+/** @deprecated Use `v.int64()` instead. bigint, though stored as an int64 in the database. */
+export const biging = v.int64();
+/** @deprecated Use `v.int64()` instead. bigint, though stored as an int64 in the database. */
 export const int64 = v.int64();
-/** Any Convex value */
+/** @deprecated Use `v.any()` instead. Any Convex value */
 export const any = v.any();
-/** Null value. Underscore is so it doesn't shadow the null builtin */
+/** @deprecated Use `v.null()` instead. Null value. Underscore is so it doesn't shadow the null builtin */
 export const null_ = v.null();
-/** Re-export values from v without having to do v.* */
+/** @deprecated Use `v.*()` instead. */
 export const { id, object, array, bytes, literal, optional, union } = v;
-/** ArrayBuffer validator. */
-export const arrayBuffer = bytes();
+/** @deprecated Use `v.bytes()` instead. ArrayBuffer validator. */
+export const arrayBuffer = v.bytes();
 
 /**
  * Utility to get the validators for fields associated with a table.
@@ -478,7 +543,7 @@ export function validate<T extends Validator<any, any, any>>(
 
         if (!isSimple) {
           expected =
-            prototype?.constructor?.name ?? (typeof prototype || "object");
+            (prototype?.constructor?.name ?? typeof prototype) || "object";
           valid = false;
           break;
         }