Rename note content field

Author: KrisBraun

.changeset/three-tables-vanish.md

@@ -0,0 +1,10 @@
+---
+"@plotday/tool-gmail": minor
+"@plotday/tool-google-calendar": minor
+"@plotday/tool-google-contacts": minor
+"@plotday/tool-outlook-calendar": minor
+"@plotday/tool-slack": minor
+"@plotday/twister": minor
+---
+
+Changed: BREAKING: Note content field renamed for clarity

tools/gmail/src/gmail-api.ts

@@ -453,7 +453,7 @@ export function transformGmailThread(thread: GmailThread): ActivityWithNotes {
       id: `gmail:${thread.id}:${message.id}` as any,
       activity: activity,
       author: emailAddressToActor(sender),
-      note: body || message.snippet,
+      content: body || message.snippet,
       links: null,
       mentions: mentions.length > 0 ? mentions : null,
       tags: null,

tools/google-calendar/src/google-calendar.ts

@@ -524,7 +524,7 @@ export class GoogleCalendar
             if (hasDescription || hasLinks) {
               notes.push({
                 activity: { id: "" }, // Will be filled in by the API
-                note: hasDescription ? description : null,
+                content: hasDescription ? description : null,
                 links: hasLinks ? links : null,
                 noteType: "text",
               });
@@ -620,7 +620,7 @@ export class GoogleCalendar
       if (hasDescription || hasLinks) {
         notes.push({
           activity: { id: "" }, // Will be filled in by the API
-          note: hasDescription ? description : null,
+          content: hasDescription ? description : null,
           links: hasLinks ? links : null,
           noteType: "text",
         });

tools/slack/src/slack-api.ts

@@ -319,7 +319,7 @@ export function transformSlackThread(
       id: `slack:${channelId}:${message.ts}` as any,
       activity: activity,
       author: slackUserToActor(userId),
-      note: text,
+      content: text,
       links: null,
       mentions: mentions.length > 0 ? mentions : null,
       tags: null,

twister/src/plot.ts

@@ -203,7 +203,7 @@ export type ActivityMeta = {
  * const task: Activity = {
  *   type: ActivityType.Note,
  *   title: "New campaign brainstorming ideas",
- *   note: "We could rent a bouncy castle...",
+ *   content: "We could rent a bouncy castle...",
  *   author: { id: "user-1", name: "John Doe", type: ActorType.User },
  *   priority: { id: "work", title: "Work" },
  *   // ... other fields
@@ -406,7 +406,7 @@ export type PickPriorityConfig = {
  * const newNote: NewActivity = {
  *   type: ActivityType.Note,
  *   title: "Meeting notes",
- *   note: "Discussed Q4 roadmap..."
+ *   content: "Discussed Q4 roadmap..."
  *   // Defaults to pickPriority: { content: true }
  * };
  *
@@ -478,7 +478,7 @@ export type Note = Omit<ActivityCommon, "type"> & {
   /** The parent activity this note belongs to */
   activity: Activity;
   /** Primary content for the note (markdown) */
-  note: string | null;
+  content: string | null;
   /** Array of interactive links attached to the note */
   links: Array<ActivityLink> | null;
 };
@@ -505,7 +505,7 @@ export type NewNote = Partial<Omit<Note, "id" | "author" | "activity">> & {
  * Type for updating existing notes.
  */
 export type NoteUpdate = Pick<Note, "id"> &
-  Partial<Pick<Note, "draft" | "private" | "note" | "links" | "mentions">> & {
+  Partial<Pick<Note, "draft" | "private" | "content" | "links" | "mentions">> & {
     /**
      * Format of the note content. Determines how the note is processed:
      * - 'text': Plain text that will be converted to markdown (auto-links URLs, preserves line breaks)

twists/calendar-sync/src/index.ts

@@ -106,7 +106,7 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
       end: null,
       notes: [
         {
-          note: "Connect a calendar account to get started. You can connect as many as you like.",
+          content: "Connect a calendar account to get started. You can connect as many as you like.",
           links: [googleAuthLink, outlookAuthLink],
         },
       ],
@@ -197,7 +197,7 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
       activity.meta = {
         ...activity.meta,
         // Add a hash so we can add a new note if it changes
-        descriptionHash: quickHash(activity.notes[0]?.note ?? ""),
+        descriptionHash: quickHash(activity.notes[0]?.content ?? ""),
       };
     }
 
@@ -314,12 +314,12 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
     // Check for description changes
     if (
       existing.meta &&
-      existing.meta.descriptionHash !== quickHash(incoming.notes[0]?.note ?? "")
+      existing.meta.descriptionHash !== quickHash(incoming.notes[0]?.content ?? "")
     ) {
-      updatedDescription = incoming.notes[0]?.note ?? undefined;
+      updatedDescription = incoming.notes[0]?.content ?? undefined;
       updates.meta = {
         ...(incoming.meta ?? existing.meta),
-        descriptionHash: quickHash(incoming.notes[0]?.note ?? ""),
+        descriptionHash: quickHash(incoming.notes[0]?.content ?? ""),
       };
       hasChanges = true;
     }
@@ -339,7 +339,7 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
       // Add a new note with the updated description
       await this.tools.plot.createNote({
         activity: { id: existing.id },
-        note: `*Calendar description updated*: ${updatedDescription}`,
+        content: `*Calendar description updated*: ${updatedDescription}`,
       });
     }
   }
@@ -378,7 +378,7 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
         if (activity) {
           await this.tools.plot.createNote({
             activity,
-            note: `I couldn't find any calendars for that account.`,
+            content: `I couldn't find any calendars for that account.`,
           });
         } else {
           console.warn("No parent activity found for no calendars note");
@@ -437,7 +437,7 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
       start: new Date(),
       notes: [
         {
-          note: `Which ${providerName} calendars you'd like to sync?`,
+          content: `Which ${providerName} calendars you'd like to sync?`,
           links,
         },
       ],
@@ -478,7 +478,7 @@ export default class CalendarSyncTwist extends Twist<CalendarSyncTwist> {
       }
       await this.tools.plot.createNote({
         activity,
-        note: `Reading your ${calendarName} calendar.`,
+        content: `Reading your ${calendarName} calendar.`,
       });
     } catch (error) {
       console.error(

twists/chat/src/index.ts

@@ -1,13 +1,12 @@
 import { Type } from "typebox";
 
 import {
-  type Activity,
   ActivityType,
-  Twist,
   ActorType,
+  type Note,
   Tag,
   type ToolBuilder,
-  type Note,
+  Twist,
 } from "@plotday/twister";
 import { AI, type AIMessage } from "@plotday/twister/tools/ai";
 import { ActivityAccess, Plot } from "@plotday/twister/tools/plot";
@@ -29,15 +28,15 @@ export default class ChatTwist extends Twist<ChatTwist> {
                 "Can you help me plan my day?",
                 "Write me a summary of this article",
               ],
-              handler: this.responsd,
+              handler: this.respond,
             },
           ],
         },
       }),
     };
   }
 
-  async responsd(note: Note) {
+  async respond(note: Note) {
     const activity = note.activity;
 
     // Get all notes in this activity (conversation history)
@@ -69,15 +68,13 @@ You can also create tasks, but should only do so when the user explicitly asks y
         : []),
       // Include all previous notes in the conversation
       ...previousNotes
-        .filter((n: Note) => n.note)
+        .filter((n: Note) => n.content)
         .map(
           (prevNote: Note) =>
             ({
               role:
-                prevNote.author.type === ActorType.Twist
-                  ? "assistant"
-                  : "user",
-              content: prevNote.note!,
+                prevNote.author.type === ActorType.Twist ? "assistant" : "user",
+              content: prevNote.content!,
             } satisfies AIMessage)
         ),
     ];
@@ -128,7 +125,7 @@ You can also create tasks, but should only do so when the user explicitly asks y
         title: response.output!.message.title,
         notes: [
           {
-            note: response.output!.message.note,
+            content: response.output!.message.note,
           },
         ],
         priority: activity.priority,
@@ -140,7 +137,7 @@ You can also create tasks, but should only do so when the user explicitly asks y
           notes: item.note
             ? [
                 {
-                  note: item.note,
+                  content: item.note,
                 },
               ]
             : undefined,

twists/message-tasks/src/index.ts

@@ -171,7 +171,7 @@ export default class MessageTasksTwist extends Twist<MessageTasksTwist> {
       start: new Date(),
       notes: [
         {
-          note: "I'll analyze your message threads and create tasks when action is needed.",
+          content: "I'll analyze your message threads and create tasks when action is needed.",
           links: [slackAuthLink],
         },
       ],
@@ -207,7 +207,7 @@ export default class MessageTasksTwist extends Twist<MessageTasksTwist> {
         if (activity) {
           await this.tools.plot.createNote({
             activity,
-            note: `No channels found for ${provider}.`,
+            content: `No channels found for ${provider}.`,
           });
         }
         return;
@@ -225,7 +225,7 @@ export default class MessageTasksTwist extends Twist<MessageTasksTwist> {
       if (activity) {
         await this.tools.plot.createNote({
           activity,
-          note: `Failed to connect to ${provider}. Please try again.`,
+          content: `Failed to connect to ${provider}. Please try again.`,
         });
       }
     }
@@ -268,7 +268,7 @@ export default class MessageTasksTwist extends Twist<MessageTasksTwist> {
     if (activity) {
       await this.tools.plot.createNote({
         activity,
-        note: `Which ${provider} channels should I monitor?`,
+        content: `Which ${provider} channels should I monitor?`,
         links,
       });
     }
@@ -313,7 +313,7 @@ export default class MessageTasksTwist extends Twist<MessageTasksTwist> {
       if (activity) {
         await this.tools.plot.createNote({
           activity,
-          note: `Now monitoring #${channelName} for actionable threads`,
+          content: `Now monitoring #${channelName} for actionable threads`,
         });
       }
     } catch (error) {
@@ -325,7 +325,7 @@ export default class MessageTasksTwist extends Twist<MessageTasksTwist> {
       if (activity) {
         await this.tools.plot.createNote({
           activity,
-          note: `Failed to monitor #${channelName}. Please try again.`,
+          content: `Failed to monitor #${channelName}. Please try again.`,
         });
       }
     }
@@ -412,7 +412,7 @@ If a task is needed, create a clear, actionable title that describes what the us
       },
       ...thread.notes.map((note, idx) => ({
         role: "user" as const,
-        content: `[Message ${idx + 1}] User: ${note.note || "(empty message)"}`,
+        content: `[Message ${idx + 1}] User: ${note.content || "(empty message)"}`,
       })),
     ];
 
@@ -517,12 +517,12 @@ If a task is needed, create a clear, actionable title that describes what the us
       notes: analysis.taskNote
         ? [
             {
-              note: `${analysis.taskNote}\n\n---\nFrom #${channelName}`,
+              content: `${analysis.taskNote}\n\n---\nFrom #${channelName}`,
             },
           ]
         : [
             {
-              note: `From #${channelName}`,
+              content: `From #${channelName}`,
             },
           ],
       meta: {
@@ -566,7 +566,7 @@ Return true only if there's clear evidence the task is done.`,
       },
       ...recentMessages.map((note) => ({
         role: "user" as const,
-        content: `User: ${note.note || ""}`,
+        content: `User: ${note.content || ""}`,
       })),
     ];