Notification rich content

src/component/_generated/component.ts

@@ -52,6 +52,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
           mutableContent?: boolean;
           numPreviousFailures: number;
           priority?: "default" | "normal" | "high";
+          richContent?: { audio?: string; image?: string; video?: string };
           sound?: string | null;
           state:
             | "awaiting_delivery"
@@ -93,6 +94,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
           mutableContent?: boolean;
           numPreviousFailures: number;
           priority?: "default" | "normal" | "high";
+          richContent?: { audio?: string; image?: string; video?: string };
           sound?: string | null;
           state:
             | "awaiting_delivery"
@@ -168,6 +170,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
               | "time-sensitive";
             mutableContent?: boolean;
             priority?: "default" | "normal" | "high";
+            richContent?: { audio?: string; image?: string; video?: string };
             sound?: string | null;
             subtitle?: string;
             title?: string;
@@ -200,6 +203,7 @@ export type ComponentApi<Name extends string | undefined = string | undefined> =
                 | "time-sensitive";
               mutableContent?: boolean;
               priority?: "default" | "normal" | "high";
+              richContent?: { audio?: string; image?: string; video?: string };
               sound?: string | null;
               subtitle?: string;
               title?: string;

src/component/_generated/dataModel.ts

@@ -38,7 +38,7 @@ export type Doc<TableName extends TableNames> = DocumentByName<
  * Convex documents are uniquely identified by their `Id`, which is accessible
  * on the `_id` field. To learn more, see [Document IDs](https://docs.convex.dev/using/document-ids).
  *
- * Documents can be loaded using `db.get(id)` in query and mutation functions.
+ * Documents can be loaded using `db.get(tableName, id)` in query and mutation functions.
  *
  * IDs are just strings at runtime, but this type can be used to distinguish them from other
  * strings when type checking.

src/component/_generated/server.ts

@@ -107,11 +107,6 @@ export const internalAction: ActionBuilder<DataModel, "internal"> =
  */
 export const httpAction: HttpActionBuilder = httpActionGeneric;
 
-type GenericCtx =
-  | GenericActionCtx<DataModel>
-  | GenericMutationCtx<DataModel>
-  | GenericQueryCtx<DataModel>;
-
 /**
  * A set of services for use within Convex query functions.
  *

src/component/schema.ts

@@ -26,6 +26,13 @@ export const notificationFields = {
   channelId: v.optional(v.string()),
   categoryId: v.optional(v.string()),
   mutableContent: v.optional(v.boolean()),
+  richContent: v.optional(
+    v.object({
+      image: v.optional(v.string()),
+      audio: v.optional(v.string()),
+      video: v.optional(v.string()),
+    }),
+  ),
 };
 
 /**
@@ -143,6 +150,18 @@ export type NotificationFields = {
    * Defaults to false.
    */
   mutableContent?: boolean;
+
+  /**
+   * iOS Only
+   *
+   * Rich content to display with the notification.
+   * Contains URLs to media files (image, audio, or video) to be displayed with the notification.
+   */
+  richContent?: {
+    image?: string;
+    audio?: string;
+    video?: string;
+  };
 };
 
 export const notificationState = v.union(