Improve callback type safety

Author: KrisBraun

.changeset/free-meals-switch.md

@@ -0,0 +1,13 @@
+---
+"@plotday/twister": minor
+"@plotday/tool-outlook-calendar": patch
+"@plotday/tool-google-calendar": patch
+"@plotday/tool-google-contacts": patch
+"@plotday/tool-linear": patch
+"@plotday/tool-asana": patch
+"@plotday/tool-gmail": patch
+"@plotday/tool-slack": patch
+"@plotday/tool-jira": patch
+---
+
+Changed: Improve callback type safety

tools/asana/src/asana.ts

@@ -1,12 +1,14 @@
 import * as asana from "asana";
 
 import {
+  type Activity,
   type ActivityLink,
   ActivityLinkType,
+  ActivityMeta,
   ActivityType,
   type NewActivityWithNotes,
   type NewNote,
-  Uuid,
+  type Serializable,
 } from "@plotday/twister";
 import type {
   Project,
@@ -74,13 +76,9 @@ export class Asana extends Tool<Asana> implements ProjectTool {
    * Request Asana OAuth authorization
    */
   async requestAuth<
-    TCallback extends (auth: ProjectAuth, ...args: any[]) => any
-  >(
-    callback: TCallback,
-    ...extraArgs: TCallback extends (auth: any, ...rest: infer R) => any
-      ? R
-      : []
-  ): Promise<ActivityLink> {
+    TArgs extends Serializable[],
+    TCallback extends (auth: ProjectAuth, ...args: TArgs) => any
+  >(callback: TCallback, ...extraArgs: TArgs): Promise<ActivityLink> {
     const asanaScopes = ["default"];
 
     // Generate opaque token for authorization
@@ -153,16 +151,15 @@ export class Asana extends Tool<Asana> implements ProjectTool {
    * Start syncing tasks from an Asana project
    */
   async startSync<
-    TCallback extends (task: NewActivityWithNotes, ...args: any[]) => any
+    TArgs extends Serializable[],
+    TCallback extends (task: NewActivityWithNotes, ...args: TArgs) => any
   >(
     options: {
       authToken: string;
       projectId: string;
     } & ProjectSyncOptions,
     callback: TCallback,
-    ...extraArgs: TCallback extends (task: any, ...rest: infer R) => any
-      ? R
-      : []
+    ...extraArgs: TArgs
   ): Promise<void> {
     const { authToken, projectId, timeMin } = options;
 
@@ -384,7 +381,10 @@ export class Asana extends Tool<Asana> implements ProjectTool {
       },
       author: authorContact,
       assignee: assigneeContact ?? null, // Explicitly set to null for unassigned tasks
-      done: task.completed && task.completed_at ? new Date(task.completed_at) : null,
+      done:
+        task.completed && task.completed_at
+          ? new Date(task.completed_at)
+          : null,
       notes,
     };
   }
@@ -393,37 +393,29 @@ export class Asana extends Tool<Asana> implements ProjectTool {
    * Update task with new values
    *
    * @param authToken - Authorization token
-   * @param update - ActivityUpdate with changed fields
+   * @param activity - The updated activity
    */
-  async updateIssue(
-    authToken: string,
-    update: import("@plotday/twister").ActivityUpdate
-  ): Promise<void> {
+  async updateIssue(authToken: string, activity: Activity): Promise<void> {
     // Extract Asana task GID from meta
-    const source = update.meta?.source as string | undefined;
-    const taskGid = source?.split(":").pop();
+    const taskGid = activity.meta?.taskGid as string | undefined;
     if (!taskGid) {
-      throw new Error("Invalid source format for Asana task");
+      throw new Error("Asana task GID not found in activity meta");
     }
 
     const client = await this.getClient(authToken);
     const updateFields: any = {};
 
     // Handle title
-    if (update.title !== undefined) {
-      updateFields.name = update.title;
+    if (activity.title !== null) {
+      updateFields.name = activity.title;
     }
 
     // Handle assignee
-    if (update.assignee !== undefined) {
-      updateFields.assignee = update.assignee?.id || null;
-    }
+    updateFields.assignee = activity.assignee?.id || null;
 
     // Handle completion status based on done
     // Asana only has completed boolean (no In Progress state)
-    if (update.done !== undefined) {
-      updateFields.completed = update.done !== null;
-    }
+    updateFields.completed = activity.done !== null;
 
     // Apply updates if any fields changed
     if (Object.keys(updateFields).length > 0) {
@@ -435,17 +427,21 @@ export class Asana extends Tool<Asana> implements ProjectTool {
    * Add a comment (story) to an Asana task
    *
    * @param authToken - Authorization token
-   * @param issueId - Asana task GID
+   * @param meta - Activity metadata containing taskGid
    * @param body - Comment text (markdown not directly supported, plain text)
    */
   async addIssueComment(
     authToken: string,
-    issueId: string,
+    meta: ActivityMeta,
     body: string
   ): Promise<void> {
+    const taskGid = meta.taskGid as string | undefined;
+    if (!taskGid) {
+      throw new Error("Asana task GID not found in activity meta");
+    }
     const client = await this.getClient(authToken);
 
-    await client.tasks.addComment(issueId, {
+    await client.tasks.addComment(taskGid, {
       text: body,
     });
   }

tools/gmail/src/gmail.ts

@@ -1,5 +1,6 @@
 import {
   type ActivityLink,
+  Serializable,
   type SyncUpdate,
   Tool,
   type ToolBuilder,
@@ -111,10 +112,9 @@ export class Gmail extends Tool<Gmail> implements MessagingTool {
   }
 
   async requestAuth<
-    TCallback extends (auth: MessagingAuth, ...args: any[]) => any
-  >(callback: TCallback, ...extraArgs: any[]): Promise<ActivityLink> {
-    console.log("Requesting Gmail auth");
-
+    TArgs extends Serializable[],
+    TCallback extends (auth: MessagingAuth, ...args: TArgs) => any
+  >(callback: TCallback, ...extraArgs: TArgs): Promise<ActivityLink> {
     // Gmail OAuth scopes for read-only access
     const gmailScopes = [
       "https://www.googleapis.com/auth/gmail.readonly",
@@ -199,16 +199,15 @@ export class Gmail extends Tool<Gmail> implements MessagingTool {
   }
 
   async startSync<
-    TCallback extends (syncUpdate: SyncUpdate, ...args: any[]) => any
+    TArgs extends Serializable[],
+    TCallback extends (syncUpdate: SyncUpdate, ...args: TArgs) => any
   >(
     options: {
       authToken: string;
       channelId: string;
     } & MessageSyncOptions,
     callback: TCallback,
-    ...extraArgs: TCallback extends (syncUpdate: any, ...rest: infer R) => any
-      ? R
-      : []
+    ...extraArgs: TArgs
   ): Promise<void> {
     const { authToken, channelId, timeMin } = options;
     console.log("Starting Gmail sync for channel", channelId);
@@ -237,7 +236,6 @@ export class Gmail extends Tool<Gmail> implements MessagingTool {
 
     await this.set(`sync_state_${channelId}`, initialState);
 
-    console.log("Starting initial Gmail sync");
     // Start sync batch using run tool for long-running operation
     const syncCallback = await this.callback(
       this.syncBatch,

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

@@ -3,13 +3,13 @@ import {
   type Activity,
   type ActivityLink,
   ActivityLinkType,
-  ActivityUpdate,
   type ActorId,
   ConferencingProvider,
   type NewActivityWithNotes,
   type NewActor,
   type NewContact,
   type NewNote,
+  Serializable,
   Tag,
   Tool,
   type ToolBuilder,
@@ -140,8 +140,9 @@ export class GoogleCalendar
   }
 
   async requestAuth<
-    TCallback extends (auth: CalendarAuth, ...args: any[]) => any
-  >(callback: TCallback, ...extraArgs: any[]): Promise<ActivityLink> {
+    TArgs extends Serializable[],
+    TCallback extends (auth: CalendarAuth, ...args: TArgs) => any
+  >(callback: TCallback, ...extraArgs: TArgs): Promise<ActivityLink> {
     console.log("Requesting Google Calendar auth");
 
     // Combine calendar and contacts scopes for single OAuth flow
@@ -238,14 +239,15 @@ export class GoogleCalendar
   }
 
   async startSync<
-    TCallback extends (activity: NewActivityWithNotes, ...args: any[]) => any
+    TArgs extends Serializable[],
+    TCallback extends (activity: NewActivityWithNotes, ...args: TArgs) => any
   >(
     options: {
       authToken: string;
       calendarId: string;
     } & SyncOptions,
     callback: TCallback,
-    ...extraArgs: any[]
+    ...extraArgs: TArgs
   ): Promise<void> {
     const { authToken, calendarId } = options;
     console.log("Saving callback");
@@ -836,14 +838,12 @@ export class GoogleCalendar
   async onActivityUpdated(
     activity: Activity,
     changes: {
-      update: ActivityUpdate;
-      previous: Activity;
       tagsAdded: Record<Tag, ActorId[]>;
       tagsRemoved: Record<Tag, ActorId[]>;
     }
   ): Promise<void> {
     // Only process calendar events
-    const source = activity.meta?.source;
+    const source = activity.source;
     if (
       !source ||
       typeof source !== "string" ||

tools/google-contacts/src/google-contacts.ts

@@ -1,4 +1,9 @@
-import { Tool, type ToolBuilder, type NewContact } from "@plotday/twister";
+import {
+  type NewContact,
+  Serializable,
+  Tool,
+  type ToolBuilder,
+} from "@plotday/twister";
 import { type Callback } from "@plotday/twister/tools/callbacks";
 import {
   AuthLevel,
@@ -9,10 +14,7 @@ import {
 } from "@plotday/twister/tools/integrations";
 import { Network } from "@plotday/twister/tools/network";
 
-import type {
-  ContactAuth,
-  GoogleContacts as IGoogleContacts,
-} from "./types";
+import type { ContactAuth, GoogleContacts as IGoogleContacts } from "./types";
 
 type ContactTokens = {
   connections?: {
@@ -269,8 +271,9 @@ export default class GoogleContacts
   }
 
   async requestAuth<
-    TCallback extends (auth: ContactAuth, ...args: any[]) => any
-  >(callback: TCallback, ...extraArgs: any[]): Promise<any> {
+    TArgs extends Serializable[],
+    TCallback extends (auth: ContactAuth, ...args: TArgs) => any
+  >(callback: TCallback, ...extraArgs: TArgs): Promise<any> {
     const opaqueToken = crypto.randomUUID();
 
     // Create callback token for parent
@@ -311,12 +314,9 @@ export default class GoogleContacts
   }
 
   async startSync<
-    TCallback extends (contacts: NewContact[], ...args: any[]) => any
-  >(
-    authToken: string,
-    callback: TCallback,
-    ...extraArgs: any[]
-  ): Promise<void> {
+    TArgs extends Serializable[],
+    TCallback extends (contacts: NewContact[], ...args: TArgs) => any
+  >(authToken: string, callback: TCallback, ...extraArgs: TArgs): Promise<void> {
     const storedAuthToken = await this.get<AuthToken>(
       `auth_token:${authToken}`
     );
@@ -356,12 +356,13 @@ export default class GoogleContacts
    * @param extraArgs - Additional arguments to pass to the callback
    */
   async syncWithAuth<
-    TCallback extends (contacts: NewContact[], ...args: any[]) => any
+    TArgs extends Serializable[],
+    TCallback extends (contacts: NewContact[], ...args: TArgs) => any
   >(
     authorization: Authorization,
     authToken: AuthToken,
     callback?: TCallback,
-    ...extraArgs: any[]
+    ...extraArgs: TArgs
   ): Promise<void> {
     // Validate authorization has required contacts scopes
     const hasRequiredScopes = GoogleContacts.SCOPES.every((scope) =>