convex-helpers 0.1.83 → 0.1.84

package/index.d.ts

@@ -57,7 +57,19 @@ export declare function pick<T extends Record<string, any>, Keys extends (keyof
  * @param keys The keys to omit from the object.
  * @returns A new object with the keys you omitted removed.
  */
-export declare function omit<T extends Record<string, any>, Keys extends (keyof T)[]>(obj: T, keys: Keys): BetterOmit<T, Keys[number]>;
+export declare function omit<T extends Record<string, any>, Keys extends (keyof T)[]>(obj: T, keys: Keys): Expand<BetterOmit<T, Keys[number]>>;
+/**
+ * Removes the _id and _creationTime fields from an object.
+ * This enables easily cloning a Convex document like:
+ * ```ts
+ * const doc = await db.get(id);
+ * const clone = withoutSystemFields(doc);
+ * await db.insert(table, clone);
+ * ```
+ * @param obj The object to remove the _id and _creationTime fields from.
+ * @returns A new object with the _id and _creationTime fields removed.
+ */
+export declare function withoutSystemFields<T extends Record<string, any>>(obj: T): Expand<BetterOmit<T, "_id" | "_creationTime">>;
 declare const error: unique symbol;
 export type ErrorMessage<Reason extends string> = Reason & {
     __error: typeof error;

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAC7C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EACtD,cAAc,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GACjE,OAAO,CAAC,MAAM,EAAE,CAAC,CASnB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,CAEpD;AAED,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAE/C;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAKhE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAC1E,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,IAAI,GAIL,GACF,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAC1B,CACF;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAC1E,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,IAAI,GAIL,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CACjC;AAGD,QAAA,MAAM,KAAK,eAAW,CAAC;AACvB,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,MAAM,IAAI,MAAM,GAAG;IACzD,OAAO,EAAE,OAAO,KAAK,CAAC;CACvB,CAAC;AAGF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAChD;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI;KAC5C,QAAQ,IAAI,MAAM,CAAC,IAAI,QAAQ,SAAS,CAAC,GAAG,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;CAC5E,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,UAAU,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IACpD,UAAU,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAC/B;KACG,GAAG,IAAI,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC;CAC3C,GACD,KAAK,CAAC;AAEZ;;GAEG;AACH;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACrB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,GAC/D,IAAI,GACJ,KAAK,CAAC;AAEZ;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAItE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,wBAAsB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAC7C,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EACtD,cAAc,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GACjE,OAAO,CAAC,MAAM,EAAE,CAAC,CASnB;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,CAEpD;AAED,qBAAa,iBAAkB,SAAQ,KAAK;CAAG;AAE/C;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAAC,CAKhE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAC1E,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,IAAI,GAIL,GACF,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAC1B,CACF;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAC1E,GAAG,EAAE,CAAC,EACN,IAAI,EAAE,IAAI,GAIL,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CACzC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,kDAExE;AAGD,QAAA,MAAM,KAAK,eAAW,CAAC;AACvB,MAAM,MAAM,YAAY,CAAC,MAAM,SAAS,MAAM,IAAI,MAAM,GAAG;IACzD,OAAO,EAAE,OAAO,KAAK,CAAC;CACvB,CAAC;AAGF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAChD;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI;KAC5C,QAAQ,IAAI,MAAM,CAAC,IAAI,QAAQ,SAAS,CAAC,GAAG,KAAK,GAAG,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;CAC5E,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,UAAU,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IACpD,UAAU,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAC/B;KACG,GAAG,IAAI,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC;CAC3C,GACD,KAAK,CAAC;AAEZ;;GAEG;AACH;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IACrB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,GAC/D,IAAI,GACJ,KAAK,CAAC;AAEZ;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAItE"}

package/index.js

@@ -78,6 +78,20 @@ export function pick(obj, keys) {
 export function omit(obj, keys) {
     return Object.fromEntries(Object.entries(obj).filter(([k]) => !keys.includes(k)));
 }
+/**
+ * Removes the _id and _creationTime fields from an object.
+ * This enables easily cloning a Convex document like:
+ * ```ts
+ * const doc = await db.get(id);
+ * const clone = withoutSystemFields(doc);
+ * await db.insert(table, clone);
+ * ```
+ * @param obj The object to remove the _id and _creationTime fields from.
+ * @returns A new object with the _id and _creationTime fields removed.
+ */
+export function withoutSystemFields(obj) {
+    return omit(obj, ["_id", "_creationTime"]);
+}
 // Type utils:
 const error = Symbol();
 /**

package/index.test.ts

@@ -0,0 +1,29 @@
+import { withoutSystemFields } from "./index.js";
+import { test, expect, expectTypeOf } from "vitest";
+
+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" });
+  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 }>();
+});

package/index.ts

@@ -95,7 +95,22 @@ export function omit<T extends Record<string, any>, Keys extends (keyof T)[]>(
 ) {
   return Object.fromEntries(
     Object.entries(obj).filter(([k]) => !keys.includes(k as Keys[number])),
-  ) as BetterOmit<T, Keys[number]>;
+  ) as Expand<BetterOmit<T, Keys[number]>>;
+}
+
+/**
+ * Removes the _id and _creationTime fields from an object.
+ * This enables easily cloning a Convex document like:
+ * ```ts
+ * const doc = await db.get(id);
+ * const clone = withoutSystemFields(doc);
+ * await db.insert(table, clone);
+ * ```
+ * @param obj The object to remove the _id and _creationTime fields from.
+ * @returns A new object with the _id and _creationTime fields removed.
+ */
+export function withoutSystemFields<T extends Record<string, any>>(obj: T) {
+  return omit(obj, ["_id", "_creationTime"]);
 }
 
 // Type utils:

package/package.json

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