convex-backend PR 48: Add schema to Pagination demo (#34671)

This PR adds the `schema.ts` to the Pagination demo.

----

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Co-authored-by: Bram Borggreve <[email protected]>
GitOrigin-RevId: 65ba5e9b332a52e2531f750ae6943b77072040e4

Author: 2 people

npm-packages/demos/pagination/convex/_generated/dataModel.d.ts

@@ -8,29 +8,29 @@
  * @module
  */
 
-import { AnyDataModel } from "convex/server";
+import type {
+  DataModelFromSchemaDefinition,
+  DocumentByName,
+  TableNamesInDataModel,
+  SystemTableNames,
+} from "convex/server";
 import type { GenericId } from "convex/values";
-
-/**
- * No `schema.ts` file found!
- *
- * This generated code has permissive types like `Doc = any` because
- * Convex doesn't know your schema. If you'd like more type safety, see
- * https://docs.convex.dev/using/schemas for instructions on how to add a
- * schema file.
- *
- * After you change a schema, rerun codegen with `npx convex dev`.
- */
+import schema from "../schema.js";
 
 /**
  * The names of all of your Convex tables.
  */
-export type TableNames = string;
+export type TableNames = TableNamesInDataModel<DataModel>;
 
 /**
  * The type of a document stored in Convex.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
  */
-export type Doc = any;
+export type Doc<TableName extends TableNames> = DocumentByName<
+  DataModel,
+  TableName
+>;
 
 /**
  * An identifier for a document in Convex.
@@ -42,8 +42,10 @@ export type Doc = any;
  *
  * IDs are just strings at runtime, but this type can be used to distinguish them from other
  * strings when type checking.
+ *
+ * @typeParam TableName - A string literal type of the table name (like "users").
  */
-export type Id<TableName extends TableNames = TableNames> =
+export type Id<TableName extends TableNames | SystemTableNames> =
   GenericId<TableName>;
 
 /**
@@ -55,4 +57,4 @@ export type Id<TableName extends TableNames = TableNames> =
  * This type is used to parameterize methods like `queryGeneric` and
  * `mutationGeneric` to make them type-safe.
  */
-export type DataModel = AnyDataModel;
+export type DataModel = DataModelFromSchemaDefinition<typeof schema>;

npm-packages/demos/pagination/convex/messages.ts

@@ -47,7 +47,10 @@ export const listWithTransformation = query({
 });
 // @snippet end listWithTransformation
 
-export const send = mutation(async (ctx, args) => {
-  const { body, author } = args;
-  await ctx.db.insert("messages", { body, author });
+export const send = mutation({
+  args: { body: v.string(), author: v.string() },
+  handler: async (ctx, args) => {
+    const { body, author } = args;
+    await ctx.db.insert("messages", { body, author });
+  },
 });

npm-packages/demos/pagination/convex/schema.ts

@@ -0,0 +1,9 @@
+import { defineSchema, defineTable } from "convex/server";
+import { v } from "convex/values";
+
+export default defineSchema({
+  messages: defineTable({
+    author: v.string(),
+    body: v.string(),
+  }),
+});

npm-packages/demos/pagination/src/_listingWithArgument.tsx

@@ -13,7 +13,7 @@ export function App() {
   );
   return (
     <div>
-      {results?.map(({ _id, text }) => <div key={_id}>{text}</div>)}
+      {results?.map(({ _id, body }) => <div key={_id}>{body}</div>)}
       <button onClick={() => loadMore(5)} disabled={status !== "CanLoadMore"}>
         Load More
       </button>

npm-packages/demos/pagination/src/_simpleListing.tsx

@@ -13,7 +13,7 @@ export function App() {
   );
   return (
     <div>
-      {results?.map(({ _id, text }) => <div key={_id}>{text}</div>)}
+      {results?.map(({ _id, body }) => <div key={_id}>{body}</div>)}
       <button onClick={() => loadMore(5)} disabled={status !== "CanLoadMore"}>
         Load More
       </button>