Merge pull request #3 from get-convex/lee/return-types

Author: ldanilek

example/convex/_generated/api.d.ts

@@ -65,6 +65,8 @@ export declare const components: {
             isDeleted: boolean;
             ts: number;
           }>;
+          pageStatus?: null | "SplitRequired" | "SplitRecommended";
+          splitCursor?: null | string;
         }
       >;
       listHistory: FunctionReference<
@@ -91,6 +93,8 @@ export declare const components: {
             isDeleted: boolean;
             ts: number;
           }>;
+          pageStatus?: null | "SplitRequired" | "SplitRecommended";
+          splitCursor?: null | string;
         }
       >;
       listSnapshot: FunctionReference<
@@ -118,8 +122,8 @@ export declare const components: {
             isDeleted: boolean;
             ts: number;
           }>;
-          pageStatus?: "SplitRecommended";
-          splitCursor?: string;
+          pageStatus?: null | "SplitRequired" | "SplitRecommended";
+          splitCursor?: null | string;
         }
       >;
       update: FunctionReference<

example/convex/example.ts

@@ -6,6 +6,8 @@ import { paginationOptsValidator } from "convex/server";
 import { Triggers } from "convex-helpers/server/triggers";
 import { DataModel } from "./_generated/dataModel";
 import { customCtx, customMutation } from "convex-helpers/server/customFunctions";
+import { PaginatedQueryReference } from "convex/react";
+import { api } from "./_generated/api";
 
 const userAuditLog = new TableHistory<DataModel, "users">(components.userAuditLog, {
   serializability: "wallclock",
@@ -65,6 +67,8 @@ export const listDocumentHistory = query({
   },
 });
 
+const _typeAssertion: PaginatedQueryReference = api.example.listDocumentHistory;
+
 export const listSnapshot = query({
   args: {
     snapshotTs: v.number(),

src/client/index.ts

@@ -143,7 +143,7 @@ type RunMutationCtx = {
   runMutation: GenericMutationCtx<GenericDataModel>["runMutation"];
 };
 
-export type OpaqueIds<T> = T extends GenericId<infer _T> | string
+export type OpaqueIds<T> = T extends GenericId<infer _T>
   ? string
   : T extends (infer U)[]
     ? OpaqueIds<U>[]

src/component/_generated/api.d.ts

@@ -53,6 +53,8 @@ export type Mounts = {
           isDeleted: boolean;
           ts: number;
         }>;
+        pageStatus?: null | "SplitRequired" | "SplitRecommended";
+        splitCursor?: null | string;
       }
     >;
     listHistory: FunctionReference<
@@ -79,6 +81,8 @@ export type Mounts = {
           isDeleted: boolean;
           ts: number;
         }>;
+        pageStatus?: null | "SplitRequired" | "SplitRecommended";
+        splitCursor?: null | string;
       }
     >;
     listSnapshot: FunctionReference<
@@ -106,8 +110,8 @@ export type Mounts = {
           isDeleted: boolean;
           ts: number;
         }>;
-        pageStatus?: "SplitRecommended";
-        splitCursor?: string;
+        pageStatus?: null | "SplitRequired" | "SplitRecommended";
+        splitCursor?: null | string;
       }
     >;
     update: FunctionReference<

src/component/lib.ts

@@ -1,4 +1,4 @@
-import { v, Infer } from "convex/values";
+import { v, Infer, Validator } from "convex/values";
 import { internalMutation, mutation, query, QueryCtx } from "./_generated/server";
 import { paginator } from "convex-helpers/server/pagination";
 import schema from "./schema.js";
@@ -85,16 +85,23 @@ export const update = mutation({
   },
 });
 
+function paginationResultValidator<T>(itemValidator: Validator<T, "required", string>) {
+  return v.object({
+    continueCursor: v.string(),
+    isDone: v.boolean(),
+    page: v.array(itemValidator),
+    pageStatus: v.optional(v.union(v.null(), v.literal("SplitRequired"), v.literal("SplitRecommended"))),
+    splitCursor: v.optional(v.union(v.null(), v.string())),
+  });
+}
+export type PaginationResult<T> = Infer<ReturnType<typeof paginationResultValidator<T>>>;
+
 export const listHistory = query({
   args: {
     maxTs: v.number(),
     paginationOpts: paginationOptsValidator,
   },
-  returns: v.object({
-    continueCursor: v.string(),
-    isDone: v.boolean(),
-    page: v.array(historyEntryValidator),
-  }),
+  returns: paginationResultValidator(historyEntryValidator),
   handler: async (ctx, args) => {
     const results = await paginator(ctx.db, schema)
       .query("history")
@@ -124,11 +131,7 @@ export const listDocumentHistory = query({
     maxTs: v.number(),
     paginationOpts: paginationOptsValidator,
   },
-  returns: v.object({
-    continueCursor: v.string(),
-    isDone: v.boolean(),
-    page: v.array(historyEntryValidator),
-  }),
+  returns: paginationResultValidator(historyEntryValidator),
   handler: async (ctx, args) => {
     const results = await paginator(ctx.db, schema)
       .query("history")
@@ -151,13 +154,7 @@ export const listSnapshot = query({
     currentTs: v.number(),
     paginationOpts: paginationOptsValidator,
   },
-  returns: v.object({
-    continueCursor: v.string(),
-    isDone: v.boolean(),
-    page: v.array(historyEntryValidator),
-    splitCursor: v.optional(v.string()),
-    pageStatus: v.optional(v.literal("SplitRecommended")),
-  }),
+  returns: paginationResultValidator(historyEntryValidator),
   handler: async (ctx, args) => {
     const pageSize = args.paginationOpts.numItems;
     const page: HistoryEntry[] = [];
@@ -234,12 +231,13 @@ export const listSnapshot = query({
         page.push(extractHistoryEntry(revision));
       }
     }
-    return {
+    const output: PaginationResult<HistoryEntry> = {
       continueCursor: allIdsBeforeCurrentTs[allIdsBeforeCurrentTs.length - 1],
       isDone: false,
       page,
       ...maybeSplit(allIdsSeen, pageSize),
     };
+    return output;
   },
 });