format

Author: ianmacartney

example/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>;

example/convex/schema.ts

@@ -0,0 +1,5 @@
+import { defineSchema } from "convex/server";
+
+export default defineSchema({
+  // Any tables used by the example app go here.
+});

example/convex/setup.test.ts

@@ -0,0 +1,16 @@
+/// <reference types="vite/client" />
+import { test } from "vitest";
+import { convexTest } from "convex-test";
+import schema from "./schema.js";
+import component from "@convex-dev/twilio/test";
+
+const modules = import.meta.glob("./**/*.*s");
+// When users want to write tests that use your component, they need to
+// explicitly register it with its schema and modules.
+export function initConvexTest() {
+  const t = convexTest(schema, modules);
+  component.register(t);
+  return t;
+}
+
+test("setup", () => {});

src/component/messages.ts

@@ -42,7 +42,7 @@ export const create = action({
         To: args.to,
         Body: args.body,
         StatusCallback: args.status_callback,
-      },
+      }
     );
     // store some properties as fields and the rest as a nested object
     const databaseMessage = convertToDatabaseMessage(message);
@@ -83,9 +83,9 @@ export const list = query({
       ctx.db
         .query("messages")
         .withIndex("by_account_sid", (q) =>
-          q.eq("account_sid", args.account_sid),
+          q.eq("account_sid", args.account_sid)
         ),
-      args.limit,
+      args.limit
     );
   },
 });
@@ -101,9 +101,9 @@ export const listIncoming = query({
       ctx.db
         .query("messages")
         .withIndex("by_account_sid_and_direction", (q) =>
-          q.eq("account_sid", args.account_sid).eq("direction", "inbound"),
+          q.eq("account_sid", args.account_sid).eq("direction", "inbound")
         ),
-      args.limit,
+      args.limit
     );
   },
 });
@@ -118,9 +118,9 @@ export const listOutgoing = query({
       ctx.db
         .query("messages")
         .withIndex("by_account_sid_and_direction", (q) =>
-          q.eq("account_sid", args.account_sid).eq("direction", "outbound-api"),
+          q.eq("account_sid", args.account_sid).eq("direction", "outbound-api")
         ),
-      args.limit,
+      args.limit
     );
   },
 });
@@ -135,7 +135,7 @@ export const getBySid = query({
     const message = await ctx.db
       .query("messages")
       .withIndex("by_sid", (q) =>
-        q.eq("account_sid", args.account_sid).eq("sid", args.sid),
+        q.eq("account_sid", args.account_sid).eq("sid", args.sid)
       )
       .first();
     return message && withoutSystemFields(message);
@@ -154,9 +154,9 @@ export const getTo = query({
       ctx.db
         .query("messages")
         .withIndex("by_to", (q) =>
-          q.eq("account_sid", args.account_sid).eq("to", args.to),
+          q.eq("account_sid", args.account_sid).eq("to", args.to)
         ),
-      args.limit,
+      args.limit
     );
   },
 });
@@ -173,9 +173,9 @@ export const getFrom = query({
       ctx.db
         .query("messages")
         .withIndex("by_from", (q) =>
-          q.eq("account_sid", args.account_sid).eq("from", args.from),
+          q.eq("account_sid", args.account_sid).eq("from", args.from)
         ),
-      args.limit,
+      args.limit
     );
   },
 });
@@ -194,9 +194,9 @@ export const getByCounterparty = query({
         .withIndex("by_counterparty", (q) =>
           q
             .eq("account_sid", args.account_sid)
-            .eq("counterparty", args.counterparty),
+            .eq("counterparty", args.counterparty)
         ),
-      args.limit,
+      args.limit
     );
   },
 });
@@ -212,7 +212,7 @@ export const updateStatus = mutation({
     const message = await ctx.db
       .query("messages")
       .withIndex("by_sid", (q) =>
-        q.eq("account_sid", args.account_sid).eq("sid", args.sid),
+        q.eq("account_sid", args.account_sid).eq("sid", args.sid)
       )
       .first();
     if (!message) {
@@ -236,7 +236,7 @@ export const getFromTwilioBySidAndInsert = action({
       args.account_sid,
       args.auth_token,
       {},
-      "GET",
+      "GET"
     );
     const databaseMessage = convertToDatabaseMessage(message);
     return ctx.runMutation(internal.messages.insert, {
@@ -300,7 +300,7 @@ function convertToDatabaseMessage(message: any) {
 
 async function takeOrCollectFields(
   query: Query<NamedTableInfo<DataModel, "messages">>,
-  limit: number | undefined,
+  limit: number | undefined
 ): Promise<Message[]> {
   let messagesPromise;
   if (limit) {

src/component/phone_numbers.ts

@@ -25,7 +25,7 @@ export const create = action({
       path,
       args.account_sid,
       args.auth_token,
-      body,
+      body
     );
     const id = await ctx.runMutation(internal.phone_numbers.insert, {
       phone_number: data,
@@ -66,13 +66,13 @@ export const get = internalQuery({
       _id: v.id("phone_numbers"),
       _creationTime: v.number(),
     }),
-    v.null(),
+    v.null()
   ),
   handler: async (ctx, args) => {
     return await ctx.db
       .query("phone_numbers")
       .withIndex("by_sid", (q) =>
-        q.eq("account_sid", args.account_sid).eq("sid", args.sid),
+        q.eq("account_sid", args.account_sid).eq("sid", args.sid)
       )
       .first();
   },
@@ -89,15 +89,15 @@ export const queryByPhoneNumber = internalQuery({
       _id: v.id("phone_numbers"),
       _creationTime: v.number(),
     }),
-    v.null(),
+    v.null()
   ),
   handler: async (ctx, args) => {
     return await ctx.db
       .query("phone_numbers")
       .withIndex("by_phone_number", (q) =>
         q
           .eq("account_sid", args.account_sid)
-          .eq("phone_number", args.phone_number),
+          .eq("phone_number", args.phone_number)
       )
       .first();
   },
@@ -124,7 +124,7 @@ export const updateSmsUrl = action({
         args.account_sid,
         args.auth_token,
         {},
-        "GET",
+        "GET"
       );
       console.log("Inserting into table");
       convexId = await ctx.runMutation(internal.phone_numbers.insert, {
@@ -141,7 +141,7 @@ export const updateSmsUrl = action({
       args.account_sid,
       args.auth_token,
       body,
-      "POST",
+      "POST"
     );
     await ctx.runMutation(internal.phone_numbers.patch, {
       convexId,
@@ -167,11 +167,11 @@ export const getByPhoneNumber = internalAction({
       {
         phone_number: args.phone_number,
         account_sid: args.account_sid,
-      },
+      }
     );
     if (!phone_number) {
       console.log(
-        `Phone number ${args.phone_number} not found in table - fetching from Twilio`,
+        `Phone number ${args.phone_number} not found in table - fetching from Twilio`
       );
       const phone_number = encodeURIComponent(args.phone_number);
       const path = `IncomingPhoneNumbers.json?PhoneNumber=${phone_number}`;
@@ -180,7 +180,7 @@ export const getByPhoneNumber = internalAction({
         args.account_sid,
         args.auth_token,
         {},
-        "GET",
+        "GET"
       );
       if (data.incoming_phone_numbers.length === 0) {
         throw new Error("Phone number not found");

src/component/schema.ts

@@ -23,7 +23,7 @@ export default defineSchema({
     status: v.string(),
     subresource_uris: v.union(
       v.object({ media: v.string(), feedback: v.optional(v.string()) }),
-      v.null(),
+      v.null()
     ),
     to: v.string(),
     uri: v.string(),

src/component/utils.ts

@@ -3,7 +3,7 @@ export const twilioRequest = async function (
   account_sid: string,
   auth_token: string,
   body: Record<string, string>,
-  method: "POST" | "GET" = "POST",
+  method: "POST" | "GET" = "POST"
 ) {
   const url = `https://api.twilio.com/2010-04-01/Accounts/${account_sid}/${path}`;
   const auth = btoa(`${account_sid}:${auth_token}`);