convex-helpers 0.1.68 → 0.1.69

package/README.md

@@ -609,20 +609,17 @@ these validators help:
 3. Add shorthand for a union of `literals`, a `nullable` field, a `deprecated`
    field, and `brandedString`. To learn more about branded strings see
    [this article](https://stack.convex.dev/using-branded-types-in-validators).
-4. Make the validators look more like TypeScript types, even though they're
-   runtime values. (This is controvercial and not required to use the above).
+4. Add a `doc(schema, "tableName")` helper to validate a document with system
+   fields included.
+5. Add a `typedV(schema)` helper that is a `v` replacement that also has:
+   - `doc("tableName")` that works like `doc` above.
+   - `id("tableName")` that is typed to tables in your schema.
 
 Example:
 
-```js
-import { Table } from "convex-helpers/server";
-import {
-  literals,
-  partial,
-  deprecated,
-  brandedString,
-} from "convex-helpers/validators";
-import { omit, pick } from "convex-helpers";
+```ts
+// convex/schema.ts
+import { literals, deprecated, brandedString } from "convex-helpers/validators";
 import { Infer } from "convex/values";
 
 // Define a validator that requires an Email string type.
@@ -630,40 +627,45 @@ export const emailValidator = brandedString("email");
 // Define the Email type based on the branded string.
 export type Email = Infer<typeof emailValidator>;
 
-export const Account = Table("accounts", {
-  balance: nullable(v.bigint()),
-  status: literals("active", "inactive"),
-  email: emailValidator,
-
-  oldField: deprecated,
-});
-
-// convex/schema.ts
 export default defineSchema({
-  accounts: Account.table.index("status", ["status"]),
+  accounts: defineTable({
+    balance: nullable(v.bigint()),
+    status: literals("active", "inactive"),
+    email: emailValidator,
+    oldField: deprecated,
+  }).index("status", ["status"]),
   //...
 });
 
 // some module
+import { doc, typedV, partial } from "convex-helpers/validators";
+import { omit, pick } from "convex-helpers";
+import schema from "./schema";
+
+// You could export this from your schema file, or define it where you need it.
+const vv = typedV(schema);
+
 export const replaceUser = internalMutation({
   args: {
-    id: Account._id,
+    id: vv.id("accounts"),
     replace: object({
       // You can provide the document with or without system fields.
-      ...Account.withoutSystemFields,
-      ...partial(Account.systemFields),
+      ...schema.tables.accounts.validator.fields,
+      ...partial(systemFields("accounts")),
     }),
   },
+  returns: doc(schema, "accounts"), // See below for vv.doc
   handler: async (ctx, args) => {
     await ctx.db.replace(args.id, args.replace);
+    return await ctx.db.get(args.id);
   },
 });
 
 // A validator just for balance & email: { balance: v.union(...), email: ..}
-const balanceAndEmail = pick(Account.withoutSystemFields, ["balance", "email"]);
+const balanceAndEmail = pick(vv.doc("accounts").fields, ["balance", "email"]);
 
 // A validator for all the fields except balance.
-const accountWithoutBalance = omit(Account.withSystemFields, ["balance"]);
+const accountWithoutBalance = omit(vv.doc("accounts").fields, ["balance"]);
 ```
 
 ## Filter

package/package.json

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

package/react/sessions.js

@@ -102,7 +102,7 @@ export const SessionProvider = ({ useStorage, storageKey, idGenerator, ssrFriend
 export function useSessionQuery(query, ...args) {
     const [sessionId] = useSessionId();
     const skip = args[0] === "skip" || !sessionId;
-    const originalArgs = args[0] === "skip" ? {} : args[0] ?? {};
+    const originalArgs = args[0] === "skip" ? {} : (args[0] ?? {});
     const newArgs = skip ? "skip" : { ...originalArgs, sessionId };
     return useQuery(query, ...[newArgs]);
 }

package/react/sessions.ts

@@ -167,7 +167,7 @@ export function useSessionQuery<Query extends SessionFunction<"query">>(
 ): FunctionReturnType<Query> | undefined {
   const [sessionId] = useSessionId();
   const skip = args[0] === "skip" || !sessionId;
-  const originalArgs = args[0] === "skip" ? {} : args[0] ?? {};
+  const originalArgs = args[0] === "skip" ? {} : (args[0] ?? {});
 
   const newArgs = skip ? "skip" : { ...originalArgs, sessionId };
 
@@ -256,7 +256,7 @@ export function useSessionId(): readonly [
   if (!ctx.ssrFriendly && ctx.sessionId === undefined) {
     throw new Error("Session ID invalid. Clear your storage?");
   }
-  return [ctx.sessionId!, ctx.refreshSessionId, ctx.sessionIdPromise] as const;
+  return [ctx.sessionId, ctx.refreshSessionId, ctx.sessionIdPromise] as const;
 }
 
 /**