@knocklabs/agent-toolkit 0.1.13 → 0.1.14

package/dist/ai-sdk/index.d.ts

@@ -1,8 +1,9 @@
 import { ToolSet, Tool } from 'ai';
-import { a as DeferredToolCall, b as DeferredToolCallConfig, K as KnockOutboundWebhookEvent, D as DeferredToolCallInteractionResult } from '../types-CrTRlRnE.js';
+import { a as DeferredToolCall, b as DeferredToolCallConfig, K as KnockOutboundWebhookEvent, D as DeferredToolCallInteractionResult } from '../types-D6xiNyB2.js';
 import { ToolkitConfig, ToolCategory } from '../types.js';
 import { ToolInvocation } from '@ai-sdk/ui-utils';
 import '@knocklabs/node/dist/src/resources/messages/interfaces';
+import '@knocklabs/node/dist/src/resources/workflows/interfaces';
 
 /**
  * Convert a deferred tool call to a tool invocation. Useful when building an assistant

package/dist/ai-sdk/index.js

@@ -2,7 +2,7 @@ import {
   handleMessageInteraction,
   triggerHumanInTheLoopWorkflow,
   wrapToolDescription
-} from "../chunk-6O7VMHBN.js";
+} from "../chunk-IGJSMDBC.js";
 import {
   createKnockClient
 } from "../chunk-TRLABEB7.js";
@@ -106,6 +106,7 @@ var createKnockToolkit = async (config) => {
           description: wrapToolDescription(toolToWrap.description ?? ""),
           execute: async (input, options) => {
             const toolExecution = {
+              id: options.toolCallId,
               method,
               args: input,
               extra: {

package/dist/ai-sdk/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ai-sdk/tool-converter.ts","../../src/ai-sdk/helpers.ts","../../src/ai-sdk/index.ts"],"sourcesContent":["import type { Tool } from \"ai\";\nimport { tool } from \"ai\";\nimport { z } from \"zod\";\n\nimport { KnockClient } from \"../lib/knock-client.js\";\nimport { KnockTool } from \"../lib/knock-tool.js\";\nimport { Config } from \"../types.js\";\n\n/**\n * Convert a KnockTool to an AI Tool, ready to pass to the AI SDK.\n */\nconst knockToolToAiTool = (\n  knockClient: KnockClient,\n  config: Config,\n  knockTool: KnockTool\n): Tool => {\n  return tool({\n    description: knockTool.description,\n    parameters: knockTool.parameters ?? z.object({}),\n    execute: knockTool.bindExecute(knockClient, config),\n  });\n};\n\n/**\n * Convert a list of KnockTools to an AI ToolSet, ready to pass to the AI SDK.\n */\nconst knockToolsToToolSet = (\n  knockClient: KnockClient,\n  config: Config,\n  knockTools: KnockTool[]\n) => {\n  return knockTools.reduce(\n    (acc, tool) => {\n      acc[tool.method] = knockToolToAiTool(knockClient, config, tool);\n      return acc;\n    },\n    {} as Record<string, Tool>\n  );\n};\n\nexport { knockToolToAiTool, knockToolsToToolSet };\n","import { ToolInvocation } from \"@ai-sdk/ui-utils\";\n\nimport { DeferredToolCall } from \"@/lib/human-in-the-loop/types\";\n\n/**\n * Convert a deferred tool call to a tool invocation. Useful when building an assistant\n * response from a deferred tool call.\n *\n * @param deferredToolCall - The deferred tool call to convert.\n * @param result - The result of the tool call.\n * @returns The tool invocation.\n */\nfunction deferredToolCallToToolInvocation(\n  deferredToolCall: DeferredToolCall,\n  result: unknown\n): ToolInvocation {\n  return {\n    args: deferredToolCall.args,\n    toolName: deferredToolCall.method,\n    toolCallId: deferredToolCall.extra?.toolCallId as string,\n    state: \"result\",\n    step: 0,\n    result,\n  };\n}\n\nexport { deferredToolCallToToolInvocation };\n","import { Tool, ToolExecutionOptions, ToolSet } from \"ai\";\n\nimport {\n  handleMessageInteraction,\n  triggerHumanInTheLoopWorkflow,\n  wrapToolDescription,\n} from \"../lib/human-in-the-loop/index.js\";\nimport {\n  DeferredToolCall,\n  DeferredToolCallConfig,\n  KnockOutboundWebhookEvent,\n  DeferredToolCallInteractionResult,\n} from \"../lib/human-in-the-loop/types.js\";\nimport { createKnockClient } from \"../lib/knock-client.js\";\nimport { getToolMap, getToolsByPermissionsInCategories } from \"../lib/utils.js\";\nimport { ToolCategory, ToolkitConfig } from \"../types.js\";\n\nimport { knockToolsToToolSet, knockToolToAiTool } from \"./tool-converter.js\";\n\ntype KnockToolkit = {\n  getAllTools: () => ToolSet;\n  getTools: (category: ToolCategory) => ToolSet;\n  getToolMap: () => Record<string, Tool>;\n  requireHumanInput: (\n    toolsToWrap: ToolSet,\n    inputConfig: DeferredToolCallConfig\n  ) => ToolSet;\n  resumeToolExecution: (toolInteraction: DeferredToolCall) => Promise<unknown>;\n  wrappedToolsRequiringInput: () => Map<string, Tool>;\n  handleMessageInteraction: (\n    event: KnockOutboundWebhookEvent\n  ) => DeferredToolCallInteractionResult | null;\n};\n\n/**\n * Creates a Knock toolkit for use with the AI SDK.\n *\n * You can filter the set of tools that are available by setting the `config.permissions` property.\n *\n * When the `config.permissions.workflows.trigger` is set, then workflow triggers for\n * the specified workflows will be included in the returned tools.\n *\n * You can also specify a list of workflow keys to include in the returned tools, should you wish to\n * limit the set of workflows that are available.\n *\n * @example\n * ```ts\n * const toolkit = await createKnockToolkit({\n *   permissions: {\n *     workflows: { read: true },\n *   },\n * });\n * ```\n *\n * @param config - The configuration to use for the toolkit\n * @returns A toolkit for use with the AI SDK\n */\nconst createKnockToolkit = async (\n  config: ToolkitConfig\n): Promise<KnockToolkit> => {\n  const knockClient = createKnockClient(config);\n  const allowedToolsByCategory = await getToolsByPermissionsInCategories(\n    knockClient,\n    config\n  );\n  const allTools = Object.values(allowedToolsByCategory).flat();\n  const toolsByMethod = getToolMap(allTools);\n\n  const wrappedToolsRequiringInput = new Map<string, Tool>();\n\n  return Promise.resolve({\n    /**\n     * Get all tools for all categories, including workflow triggers when workflows-as-tools are enabled.\n     *\n     * @returns A promise that resolves to a set of tools\n     */\n    getAllTools: (): ToolSet => {\n      return knockToolsToToolSet(knockClient, config, allTools);\n    },\n\n    /**\n     * Get all tools for a specific category. When trying to get tools for the `workflows` category and the trigger permission is set,\n     * the workflow triggers for the specified workflows will be included in the returned tools.\n     *\n     * @param category - The category of tools to get\n     * @returns An array of tools for the given category\n     */\n    getTools: (category: ToolCategory): ToolSet => {\n      return knockToolsToToolSet(\n        knockClient,\n        config,\n        allowedToolsByCategory[category]\n      );\n    },\n\n    /**\n     * Get a map of all tools by method name, including workflow triggers when workflows-as-tools are enabled.\n     *\n     * @returns A map of all tools by method name\n     */\n    getToolMap: (): Record<string, Tool> => {\n      return Object.entries(toolsByMethod).reduce(\n        (acc, [method, tool]) => ({\n          ...acc,\n          [method]: knockToolToAiTool(knockClient, config, tool),\n        }),\n        {} as Record<string, Tool>\n      );\n    },\n\n    /**\n     * Wraps one or more tools to require human input.\n     *\n     * @param toolsToWrap - The tools to wrap\n     * @param inputConfig - The configuration to use for the HITL request\n     */\n    requireHumanInput: (\n      toolsToWrap: ToolSet,\n      inputConfig: DeferredToolCallConfig\n    ): ToolSet => {\n      const wrappedTools: Record<string, Tool> = {};\n\n      for (const [method, toolToWrap] of Object.entries(toolsToWrap)) {\n        // Keep a reference to the original tool so we can use it later\n        wrappedToolsRequiringInput.set(method, { ...toolToWrap });\n\n        const wrappedTool = {\n          ...toolToWrap,\n          description: wrapToolDescription(toolToWrap.description ?? \"\"),\n          execute: async (input: any, options: ToolExecutionOptions) => {\n            const toolExecution = {\n              method,\n              args: input,\n              extra: {\n                toolCallId: options.toolCallId,\n              },\n            };\n\n            await triggerHumanInTheLoopWorkflow({\n              knockClient,\n              config,\n              toolCall: toolExecution,\n              inputConfig,\n            });\n\n            // TODO: Consider injecting a hook here to allow the AI SDK to react to the tool call being deferred\n            return {\n              type: \"tool-status\",\n              status: \"pending-input\",\n              toolCallId: options.toolCallId,\n            };\n          },\n        };\n\n        wrappedTools[method] = wrappedTool;\n      }\n\n      return wrappedTools;\n    },\n\n    /**\n     * Returns any tools that were wrapped with `requireHumanInput`.\n     *\n     * @returns A map of wrapped tools that require human input\n     */\n    wrappedToolsRequiringInput: () => wrappedToolsRequiringInput,\n\n    /**\n     * Resumes the execution of a tool that required human input.\n     *\n     * @param toolInteraction - The tool interaction to resume\n     * @returns A promise that resolves to the result of the tool execution\n     */\n    resumeToolExecution: async (toolInteraction: DeferredToolCall) => {\n      const tool = wrappedToolsRequiringInput.get(toolInteraction.method);\n\n      if (!tool) {\n        throw new Error(\n          `Tool \"${toolInteraction.method}\" not found. Did you forget to wrap the tool with requireHumanInput?`\n        );\n      }\n\n      if (!tool.execute) {\n        throw new Error(\n          `Tool \"${toolInteraction.method}\" does not have an execute method. Nothing to resume.`\n        );\n      }\n\n      const options = toolInteraction.extra as unknown as ToolExecutionOptions;\n      const result = await tool.execute(toolInteraction.args, options);\n\n      // Return two message objects to represent the tool call and the call result having\n      // finished. Note: this can result in duplicate tool call IDs being present in the message history.\n      return {\n        type: \"tool-status\",\n        status: \"completed\",\n        toolCallId: options.toolCallId,\n        result,\n      };\n    },\n\n    /**\n     * Handles a message interaction event by parsing it into a well-known format.\n     *\n     * @param event - The message interaction event\n     * @returns An deferred tool call, or null if the event is not a message interaction\n     */\n    handleMessageInteraction,\n  });\n};\n\nexport * from \"./helpers.js\";\nexport { createKnockToolkit };\n"],"mappings":";;;;;;;;;;;;;;;AACA,SAAS,YAAY;AACrB,SAAS,SAAS;AASlB,IAAM,oBAAoB,CACxB,aACA,QACA,cACS;AACT,SAAO,KAAK;AAAA,IACV,aAAa,UAAU;AAAA,IACvB,YAAY,UAAU,cAAc,EAAE,OAAO,CAAC,CAAC;AAAA,IAC/C,SAAS,UAAU,YAAY,aAAa,MAAM;AAAA,EACpD,CAAC;AACH;AAKA,IAAM,sBAAsB,CAC1B,aACA,QACA,eACG;AACH,SAAO,WAAW;AAAA,IAChB,CAAC,KAAKA,UAAS;AACb,UAAIA,MAAK,MAAM,IAAI,kBAAkB,aAAa,QAAQA,KAAI;AAC9D,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AACF;;;AC1BA,SAAS,iCACP,kBACA,QACgB;AAChB,SAAO;AAAA,IACL,MAAM,iBAAiB;AAAA,IACvB,UAAU,iBAAiB;AAAA,IAC3B,YAAY,iBAAiB,OAAO;AAAA,IACpC,OAAO;AAAA,IACP,MAAM;AAAA,IACN;AAAA,EACF;AACF;;;ACiCA,IAAM,qBAAqB,OACzB,WAC0B;AAC1B,QAAM,cAAc,kBAAkB,MAAM;AAC5C,QAAM,yBAAyB,MAAM;AAAA,IACnC;AAAA,IACA;AAAA,EACF;AACA,QAAM,WAAW,OAAO,OAAO,sBAAsB,EAAE,KAAK;AAC5D,QAAM,gBAAgB,WAAW,QAAQ;AAEzC,QAAM,6BAA6B,oBAAI,IAAkB;AAEzD,SAAO,QAAQ,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMrB,aAAa,MAAe;AAC1B,aAAO,oBAAoB,aAAa,QAAQ,QAAQ;AAAA,IAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,UAAU,CAAC,aAAoC;AAC7C,aAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA,uBAAuB,QAAQ;AAAA,MACjC;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,YAAY,MAA4B;AACtC,aAAO,OAAO,QAAQ,aAAa,EAAE;AAAA,QACnC,CAAC,KAAK,CAAC,QAAQC,KAAI,OAAO;AAAA,UACxB,GAAG;AAAA,UACH,CAAC,MAAM,GAAG,kBAAkB,aAAa,QAAQA,KAAI;AAAA,QACvD;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,mBAAmB,CACjB,aACA,gBACY;AACZ,YAAM,eAAqC,CAAC;AAE5C,iBAAW,CAAC,QAAQ,UAAU,KAAK,OAAO,QAAQ,WAAW,GAAG;AAE9D,mCAA2B,IAAI,QAAQ,EAAE,GAAG,WAAW,CAAC;AAExD,cAAM,cAAc;AAAA,UAClB,GAAG;AAAA,UACH,aAAa,oBAAoB,WAAW,eAAe,EAAE;AAAA,UAC7D,SAAS,OAAO,OAAY,YAAkC;AAC5D,kBAAM,gBAAgB;AAAA,cACpB;AAAA,cACA,MAAM;AAAA,cACN,OAAO;AAAA,gBACL,YAAY,QAAQ;AAAA,cACtB;AAAA,YACF;AAEA,kBAAM,8BAA8B;AAAA,cAClC;AAAA,cACA;AAAA,cACA,UAAU;AAAA,cACV;AAAA,YACF,CAAC;AAGD,mBAAO;AAAA,cACL,MAAM;AAAA,cACN,QAAQ;AAAA,cACR,YAAY,QAAQ;AAAA,YACtB;AAAA,UACF;AAAA,QACF;AAEA,qBAAa,MAAM,IAAI;AAAA,MACzB;AAEA,aAAO;AAAA,IACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,4BAA4B,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQlC,qBAAqB,OAAO,oBAAsC;AAChE,YAAMA,QAAO,2BAA2B,IAAI,gBAAgB,MAAM;AAElE,UAAI,CAACA,OAAM;AACT,cAAM,IAAI;AAAA,UACR,SAAS,gBAAgB,MAAM;AAAA,QACjC;AAAA,MACF;AAEA,UAAI,CAACA,MAAK,SAAS;AACjB,cAAM,IAAI;AAAA,UACR,SAAS,gBAAgB,MAAM;AAAA,QACjC;AAAA,MACF;AAEA,YAAM,UAAU,gBAAgB;AAChC,YAAM,SAAS,MAAMA,MAAK,QAAQ,gBAAgB,MAAM,OAAO;AAI/D,aAAO;AAAA,QACL,MAAM;AAAA,QACN,QAAQ;AAAA,QACR,YAAY,QAAQ;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA;AAAA,EACF,CAAC;AACH;","names":["tool","tool"]}
+{"version":3,"sources":["../../src/ai-sdk/tool-converter.ts","../../src/ai-sdk/helpers.ts","../../src/ai-sdk/index.ts"],"sourcesContent":["import type { Tool } from \"ai\";\nimport { tool } from \"ai\";\nimport { z } from \"zod\";\n\nimport { KnockClient } from \"../lib/knock-client.js\";\nimport { KnockTool } from \"../lib/knock-tool.js\";\nimport { Config } from \"../types.js\";\n\n/**\n * Convert a KnockTool to an AI Tool, ready to pass to the AI SDK.\n */\nconst knockToolToAiTool = (\n  knockClient: KnockClient,\n  config: Config,\n  knockTool: KnockTool\n): Tool => {\n  return tool({\n    description: knockTool.description,\n    parameters: knockTool.parameters ?? z.object({}),\n    execute: knockTool.bindExecute(knockClient, config),\n  });\n};\n\n/**\n * Convert a list of KnockTools to an AI ToolSet, ready to pass to the AI SDK.\n */\nconst knockToolsToToolSet = (\n  knockClient: KnockClient,\n  config: Config,\n  knockTools: KnockTool[]\n) => {\n  return knockTools.reduce(\n    (acc, tool) => {\n      acc[tool.method] = knockToolToAiTool(knockClient, config, tool);\n      return acc;\n    },\n    {} as Record<string, Tool>\n  );\n};\n\nexport { knockToolToAiTool, knockToolsToToolSet };\n","import { ToolInvocation } from \"@ai-sdk/ui-utils\";\n\nimport { DeferredToolCall } from \"@/lib/human-in-the-loop/types\";\n\n/**\n * Convert a deferred tool call to a tool invocation. Useful when building an assistant\n * response from a deferred tool call.\n *\n * @param deferredToolCall - The deferred tool call to convert.\n * @param result - The result of the tool call.\n * @returns The tool invocation.\n */\nfunction deferredToolCallToToolInvocation(\n  deferredToolCall: DeferredToolCall,\n  result: unknown\n): ToolInvocation {\n  return {\n    args: deferredToolCall.args,\n    toolName: deferredToolCall.method,\n    toolCallId: deferredToolCall.extra?.toolCallId as string,\n    state: \"result\",\n    step: 0,\n    result,\n  };\n}\n\nexport { deferredToolCallToToolInvocation };\n","import { Tool, ToolExecutionOptions, ToolSet } from \"ai\";\n\nimport {\n  handleMessageInteraction,\n  triggerHumanInTheLoopWorkflow,\n  wrapToolDescription,\n} from \"../lib/human-in-the-loop/index.js\";\nimport {\n  DeferredToolCall,\n  DeferredToolCallConfig,\n  KnockOutboundWebhookEvent,\n  DeferredToolCallInteractionResult,\n} from \"../lib/human-in-the-loop/types.js\";\nimport { createKnockClient } from \"../lib/knock-client.js\";\nimport { getToolMap, getToolsByPermissionsInCategories } from \"../lib/utils.js\";\nimport { ToolCategory, ToolkitConfig } from \"../types.js\";\n\nimport { knockToolsToToolSet, knockToolToAiTool } from \"./tool-converter.js\";\n\ntype KnockToolkit = {\n  getAllTools: () => ToolSet;\n  getTools: (category: ToolCategory) => ToolSet;\n  getToolMap: () => Record<string, Tool>;\n  requireHumanInput: (\n    toolsToWrap: ToolSet,\n    inputConfig: DeferredToolCallConfig\n  ) => ToolSet;\n  resumeToolExecution: (toolInteraction: DeferredToolCall) => Promise<unknown>;\n  wrappedToolsRequiringInput: () => Map<string, Tool>;\n  handleMessageInteraction: (\n    event: KnockOutboundWebhookEvent\n  ) => DeferredToolCallInteractionResult | null;\n};\n\n/**\n * Creates a Knock toolkit for use with the AI SDK.\n *\n * You can filter the set of tools that are available by setting the `config.permissions` property.\n *\n * When the `config.permissions.workflows.trigger` is set, then workflow triggers for\n * the specified workflows will be included in the returned tools.\n *\n * You can also specify a list of workflow keys to include in the returned tools, should you wish to\n * limit the set of workflows that are available.\n *\n * @example\n * ```ts\n * const toolkit = await createKnockToolkit({\n *   permissions: {\n *     workflows: { read: true },\n *   },\n * });\n * ```\n *\n * @param config - The configuration to use for the toolkit\n * @returns A toolkit for use with the AI SDK\n */\nconst createKnockToolkit = async (\n  config: ToolkitConfig\n): Promise<KnockToolkit> => {\n  const knockClient = createKnockClient(config);\n  const allowedToolsByCategory = await getToolsByPermissionsInCategories(\n    knockClient,\n    config\n  );\n  const allTools = Object.values(allowedToolsByCategory).flat();\n  const toolsByMethod = getToolMap(allTools);\n\n  const wrappedToolsRequiringInput = new Map<string, Tool>();\n\n  return Promise.resolve({\n    /**\n     * Get all tools for all categories, including workflow triggers when workflows-as-tools are enabled.\n     *\n     * @returns A promise that resolves to a set of tools\n     */\n    getAllTools: (): ToolSet => {\n      return knockToolsToToolSet(knockClient, config, allTools);\n    },\n\n    /**\n     * Get all tools for a specific category. When trying to get tools for the `workflows` category and the trigger permission is set,\n     * the workflow triggers for the specified workflows will be included in the returned tools.\n     *\n     * @param category - The category of tools to get\n     * @returns An array of tools for the given category\n     */\n    getTools: (category: ToolCategory): ToolSet => {\n      return knockToolsToToolSet(\n        knockClient,\n        config,\n        allowedToolsByCategory[category]\n      );\n    },\n\n    /**\n     * Get a map of all tools by method name, including workflow triggers when workflows-as-tools are enabled.\n     *\n     * @returns A map of all tools by method name\n     */\n    getToolMap: (): Record<string, Tool> => {\n      return Object.entries(toolsByMethod).reduce(\n        (acc, [method, tool]) => ({\n          ...acc,\n          [method]: knockToolToAiTool(knockClient, config, tool),\n        }),\n        {} as Record<string, Tool>\n      );\n    },\n\n    /**\n     * Wraps one or more tools to require human input.\n     *\n     * @param toolsToWrap - The tools to wrap\n     * @param inputConfig - The configuration to use for the HITL request\n     */\n    requireHumanInput: (\n      toolsToWrap: ToolSet,\n      inputConfig: DeferredToolCallConfig\n    ): ToolSet => {\n      const wrappedTools: Record<string, Tool> = {};\n\n      for (const [method, toolToWrap] of Object.entries(toolsToWrap)) {\n        // Keep a reference to the original tool so we can use it later\n        wrappedToolsRequiringInput.set(method, { ...toolToWrap });\n\n        const wrappedTool = {\n          ...toolToWrap,\n          description: wrapToolDescription(toolToWrap.description ?? \"\"),\n          execute: async (input: any, options: ToolExecutionOptions) => {\n            const toolExecution = {\n              id: options.toolCallId,\n              method,\n              args: input,\n              extra: {\n                toolCallId: options.toolCallId,\n              },\n            };\n\n            await triggerHumanInTheLoopWorkflow({\n              knockClient,\n              config,\n              toolCall: toolExecution,\n              inputConfig,\n            });\n\n            // TODO: Consider injecting a hook here to allow the AI SDK to react to the tool call being deferred\n            return {\n              type: \"tool-status\",\n              status: \"pending-input\",\n              toolCallId: options.toolCallId,\n            };\n          },\n        };\n\n        wrappedTools[method] = wrappedTool;\n      }\n\n      return wrappedTools;\n    },\n\n    /**\n     * Returns any tools that were wrapped with `requireHumanInput`.\n     *\n     * @returns A map of wrapped tools that require human input\n     */\n    wrappedToolsRequiringInput: () => wrappedToolsRequiringInput,\n\n    /**\n     * Resumes the execution of a tool that required human input.\n     *\n     * @param toolInteraction - The tool interaction to resume\n     * @returns A promise that resolves to the result of the tool execution\n     */\n    resumeToolExecution: async (toolInteraction: DeferredToolCall) => {\n      const tool = wrappedToolsRequiringInput.get(toolInteraction.method);\n\n      if (!tool) {\n        throw new Error(\n          `Tool \"${toolInteraction.method}\" not found. Did you forget to wrap the tool with requireHumanInput?`\n        );\n      }\n\n      if (!tool.execute) {\n        throw new Error(\n          `Tool \"${toolInteraction.method}\" does not have an execute method. Nothing to resume.`\n        );\n      }\n\n      const options = toolInteraction.extra as unknown as ToolExecutionOptions;\n      const result = await tool.execute(toolInteraction.args, options);\n\n      // Return two message objects to represent the tool call and the call result having\n      // finished. Note: this can result in duplicate tool call IDs being present in the message history.\n      return {\n        type: \"tool-status\",\n        status: \"completed\",\n        toolCallId: options.toolCallId,\n        result,\n      };\n    },\n\n    /**\n     * Handles a message interaction event by parsing it into a well-known format.\n     *\n     * @param event - The message interaction event\n     * @returns An deferred tool call, or null if the event is not a message interaction\n     */\n    handleMessageInteraction,\n  });\n};\n\nexport * from \"./helpers.js\";\nexport { createKnockToolkit };\n"],"mappings":";;;;;;;;;;;;;;;AACA,SAAS,YAAY;AACrB,SAAS,SAAS;AASlB,IAAM,oBAAoB,CACxB,aACA,QACA,cACS;AACT,SAAO,KAAK;AAAA,IACV,aAAa,UAAU;AAAA,IACvB,YAAY,UAAU,cAAc,EAAE,OAAO,CAAC,CAAC;AAAA,IAC/C,SAAS,UAAU,YAAY,aAAa,MAAM;AAAA,EACpD,CAAC;AACH;AAKA,IAAM,sBAAsB,CAC1B,aACA,QACA,eACG;AACH,SAAO,WAAW;AAAA,IAChB,CAAC,KAAKA,UAAS;AACb,UAAIA,MAAK,MAAM,IAAI,kBAAkB,aAAa,QAAQA,KAAI;AAC9D,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AACF;;;AC1BA,SAAS,iCACP,kBACA,QACgB;AAChB,SAAO;AAAA,IACL,MAAM,iBAAiB;AAAA,IACvB,UAAU,iBAAiB;AAAA,IAC3B,YAAY,iBAAiB,OAAO;AAAA,IACpC,OAAO;AAAA,IACP,MAAM;AAAA,IACN;AAAA,EACF;AACF;;;ACiCA,IAAM,qBAAqB,OACzB,WAC0B;AAC1B,QAAM,cAAc,kBAAkB,MAAM;AAC5C,QAAM,yBAAyB,MAAM;AAAA,IACnC;AAAA,IACA;AAAA,EACF;AACA,QAAM,WAAW,OAAO,OAAO,sBAAsB,EAAE,KAAK;AAC5D,QAAM,gBAAgB,WAAW,QAAQ;AAEzC,QAAM,6BAA6B,oBAAI,IAAkB;AAEzD,SAAO,QAAQ,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMrB,aAAa,MAAe;AAC1B,aAAO,oBAAoB,aAAa,QAAQ,QAAQ;AAAA,IAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,UAAU,CAAC,aAAoC;AAC7C,aAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA,uBAAuB,QAAQ;AAAA,MACjC;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,YAAY,MAA4B;AACtC,aAAO,OAAO,QAAQ,aAAa,EAAE;AAAA,QACnC,CAAC,KAAK,CAAC,QAAQC,KAAI,OAAO;AAAA,UACxB,GAAG;AAAA,UACH,CAAC,MAAM,GAAG,kBAAkB,aAAa,QAAQA,KAAI;AAAA,QACvD;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,mBAAmB,CACjB,aACA,gBACY;AACZ,YAAM,eAAqC,CAAC;AAE5C,iBAAW,CAAC,QAAQ,UAAU,KAAK,OAAO,QAAQ,WAAW,GAAG;AAE9D,mCAA2B,IAAI,QAAQ,EAAE,GAAG,WAAW,CAAC;AAExD,cAAM,cAAc;AAAA,UAClB,GAAG;AAAA,UACH,aAAa,oBAAoB,WAAW,eAAe,EAAE;AAAA,UAC7D,SAAS,OAAO,OAAY,YAAkC;AAC5D,kBAAM,gBAAgB;AAAA,cACpB,IAAI,QAAQ;AAAA,cACZ;AAAA,cACA,MAAM;AAAA,cACN,OAAO;AAAA,gBACL,YAAY,QAAQ;AAAA,cACtB;AAAA,YACF;AAEA,kBAAM,8BAA8B;AAAA,cAClC;AAAA,cACA;AAAA,cACA,UAAU;AAAA,cACV;AAAA,YACF,CAAC;AAGD,mBAAO;AAAA,cACL,MAAM;AAAA,cACN,QAAQ;AAAA,cACR,YAAY,QAAQ;AAAA,YACtB;AAAA,UACF;AAAA,QACF;AAEA,qBAAa,MAAM,IAAI;AAAA,MACzB;AAEA,aAAO;AAAA,IACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,4BAA4B,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQlC,qBAAqB,OAAO,oBAAsC;AAChE,YAAMA,QAAO,2BAA2B,IAAI,gBAAgB,MAAM;AAElE,UAAI,CAACA,OAAM;AACT,cAAM,IAAI;AAAA,UACR,SAAS,gBAAgB,MAAM;AAAA,QACjC;AAAA,MACF;AAEA,UAAI,CAACA,MAAK,SAAS;AACjB,cAAM,IAAI;AAAA,UACR,SAAS,gBAAgB,MAAM;AAAA,QACjC;AAAA,MACF;AAEA,YAAM,UAAU,gBAAgB;AAChC,YAAM,SAAS,MAAMA,MAAK,QAAQ,gBAAgB,MAAM,OAAO;AAI/D,aAAO;AAAA,QACL,MAAM;AAAA,QACN,QAAQ;AAAA,QACR,YAAY,QAAQ;AAAA,QACpB;AAAA,MACF;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA;AAAA,EACF,CAAC;AACH;","names":["tool","tool"]}

package/dist/{chunk-CCMSCN5A.js → chunk-GWRZ4NRX.js}

@@ -8,7 +8,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 var KnockMcpServer = class extends McpServer {
   constructor(knockClient, config, tools) {
-    super({ name: "Knock", version: "0.1.13" });
+    super({ name: "Knock", version: "0.1.14" });
     tools.forEach((tool) => {
       const toolParams = tool.parameters ?? z.object({});
       this.tool(
@@ -44,4 +44,4 @@ var createKnockMcpServer = async (params) => {
 export {
   createKnockMcpServer
 };
-//# sourceMappingURL=chunk-CCMSCN5A.js.map
+//# sourceMappingURL=chunk-GWRZ4NRX.js.map

package/dist/{chunk-6O7VMHBN.js → chunk-IGJSMDBC.js}

@@ -11,6 +11,9 @@ async function triggerHumanInTheLoopWorkflow({
   inputConfig
 }) {
   const knock = await knockClient.publicApi(config.environment);
+  if (inputConfig.onBeforeCallKnock) {
+    await inputConfig.onBeforeCallKnock(toolCall);
+  }
   const result = await knock.workflows.trigger(inputConfig.workflow, {
     data: {
       type: "deferred_tool_call",
@@ -21,6 +24,9 @@ async function triggerHumanInTheLoopWorkflow({
     tenant: inputConfig.tenant,
     actor: inputConfig.actor
   });
+  if (inputConfig.onAfterCallKnock) {
+    await inputConfig.onAfterCallKnock(toolCall, result);
+  }
   return result;
 }
 function handleMessageInteraction(event) {
@@ -36,6 +42,7 @@ function handleMessageInteraction(event) {
     workflow: message.source.key,
     interaction: event.event_data,
     toolCall: {
+      id: messageData.tool_call.id,
       method: messageData.tool_call.method,
       args: messageData.tool_call.args,
       extra: messageData.tool_call.extra
@@ -54,4 +61,4 @@ export {
   triggerHumanInTheLoopWorkflow,
   handleMessageInteraction
 };
-//# sourceMappingURL=chunk-6O7VMHBN.js.map
+//# sourceMappingURL=chunk-IGJSMDBC.js.map

package/dist/chunk-IGJSMDBC.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/human-in-the-loop/index.ts"],"sourcesContent":["import { Recipient } from \"@knocklabs/node\";\n\nimport { Config } from \"@/types\";\n\nimport { KnockClient } from \"../knock-client\";\n\nimport {\n  DeferredToolCallWorkflowData,\n  DeferredToolCallConfig,\n  KnockOutboundWebhookEvent,\n  DeferredToolCall,\n  DeferredToolCallInteractionResult,\n} from \"./types\";\n\nfunction wrapToolDescription(description: string) {\n  return `${description}\\n\\nThis tool call is deferred. You will NOT receive a result from this tool but this is NOT an error. Do NOT retry the tool call as the result will be the same. The tool call result will be provided to you in the future.`;\n}\n\n/**\n * Triggers a human in the loop workflow.\n *\n * @param knockClient - The Knock client to use.\n * @param toolCall - The tool call to trigger.\n * @param config - The configuration to use.\n */\nasync function triggerHumanInTheLoopWorkflow({\n  knockClient,\n  config,\n  toolCall,\n  inputConfig,\n}: {\n  knockClient: KnockClient;\n  config: Config;\n  toolCall: DeferredToolCall;\n  inputConfig: DeferredToolCallConfig;\n}) {\n  const knock = await knockClient.publicApi(config.environment);\n\n  if (inputConfig.onBeforeCallKnock) {\n    await inputConfig.onBeforeCallKnock(toolCall);\n  }\n\n  const result = await knock.workflows.trigger(inputConfig.workflow, {\n    data: {\n      type: \"deferred_tool_call\",\n      tool_call: toolCall,\n      metadata: inputConfig.metadata,\n    } as DeferredToolCallWorkflowData,\n    recipients: inputConfig.recipients as Recipient[],\n    tenant: inputConfig.tenant,\n    actor: inputConfig.actor as Recipient,\n  });\n\n  if (inputConfig.onAfterCallKnock) {\n    await inputConfig.onAfterCallKnock(toolCall, result);\n  }\n\n  return result;\n}\n\n/**\n * Given an outboundwebhook event, this function will parse the event into a normalized format.\n *\n * If the event is not associated with a deferred tool call, this function will return null.\n *\n * @param event - The outbound webhook event\n * @returns A deferred tool call interaction result, or null if the event is not a deferred tool call\n */\nfunction handleMessageInteraction(\n  event: KnockOutboundWebhookEvent\n): DeferredToolCallInteractionResult | null {\n  const { data: message } = event;\n\n  // We only care about message.interacted events\n  if (event.type !== \"message.interacted\") {\n    return null;\n  }\n\n  // We only care about messages that contain a tool call\n  if (message.data.type !== \"deferred_tool_call\" || !message.data.tool_call) {\n    return null;\n  }\n\n  const messageData = message.data as DeferredToolCallWorkflowData;\n\n  return {\n    workflow: message.source.key,\n    interaction: event.event_data,\n    toolCall: {\n      id: messageData.tool_call.id,\n      method: messageData.tool_call.method,\n      args: messageData.tool_call.args,\n      extra: messageData.tool_call.extra,\n    },\n    metadata: messageData.metadata,\n    context: {\n      messageId: message.id,\n      channelId: message.channel_id,\n      timestamp: event.created_at,\n    },\n  };\n}\n\nexport {\n  handleMessageInteraction,\n  triggerHumanInTheLoopWorkflow,\n  wrapToolDescription,\n};\n"],"mappings":";AAcA,SAAS,oBAAoB,aAAqB;AAChD,SAAO,GAAG,WAAW;AAAA;AAAA;AACvB;AASA,eAAe,8BAA8B;AAAA,EAC3C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAKG;AACD,QAAM,QAAQ,MAAM,YAAY,UAAU,OAAO,WAAW;AAE5D,MAAI,YAAY,mBAAmB;AACjC,UAAM,YAAY,kBAAkB,QAAQ;AAAA,EAC9C;AAEA,QAAM,SAAS,MAAM,MAAM,UAAU,QAAQ,YAAY,UAAU;AAAA,IACjE,MAAM;AAAA,MACJ,MAAM;AAAA,MACN,WAAW;AAAA,MACX,UAAU,YAAY;AAAA,IACxB;AAAA,IACA,YAAY,YAAY;AAAA,IACxB,QAAQ,YAAY;AAAA,IACpB,OAAO,YAAY;AAAA,EACrB,CAAC;AAED,MAAI,YAAY,kBAAkB;AAChC,UAAM,YAAY,iBAAiB,UAAU,MAAM;AAAA,EACrD;AAEA,SAAO;AACT;AAUA,SAAS,yBACP,OAC0C;AAC1C,QAAM,EAAE,MAAM,QAAQ,IAAI;AAG1B,MAAI,MAAM,SAAS,sBAAsB;AACvC,WAAO;AAAA,EACT;AAGA,MAAI,QAAQ,KAAK,SAAS,wBAAwB,CAAC,QAAQ,KAAK,WAAW;AACzE,WAAO;AAAA,EACT;AAEA,QAAM,cAAc,QAAQ;AAE5B,SAAO;AAAA,IACL,UAAU,QAAQ,OAAO;AAAA,IACzB,aAAa,MAAM;AAAA,IACnB,UAAU;AAAA,MACR,IAAI,YAAY,UAAU;AAAA,MAC1B,QAAQ,YAAY,UAAU;AAAA,MAC9B,MAAM,YAAY,UAAU;AAAA,MAC5B,OAAO,YAAY,UAAU;AAAA,IAC/B;AAAA,IACA,UAAU,YAAY;AAAA,IACtB,SAAS;AAAA,MACP,WAAW,QAAQ;AAAA,MACnB,WAAW,QAAQ;AAAA,MACnB,WAAW,MAAM;AAAA,IACnB;AAAA,EACF;AACF;","names":[]}

package/dist/human-in-the-loop.d.ts

@@ -1,10 +1,11 @@
 import * as _knocklabs_node from '@knocklabs/node';
 import { Config } from './types.js';
 import { K as KnockClient } from './knock-client-BH7Juvis.js';
-import { K as KnockOutboundWebhookEvent, D as DeferredToolCallInteractionResult, a as DeferredToolCall, b as DeferredToolCallConfig } from './types-CrTRlRnE.js';
-export { c as DeferredToolCallWorkflowData } from './types-CrTRlRnE.js';
+import { K as KnockOutboundWebhookEvent, D as DeferredToolCallInteractionResult, a as DeferredToolCall, b as DeferredToolCallConfig } from './types-D6xiNyB2.js';
+export { c as DeferredToolCallWorkflowData } from './types-D6xiNyB2.js';
 import '@knocklabs/mgmt';
 import '@knocklabs/node/dist/src/resources/messages/interfaces';
+import '@knocklabs/node/dist/src/resources/workflows/interfaces';
 
 declare function wrapToolDescription(description: string): string;
 /**

package/dist/human-in-the-loop.js

@@ -2,7 +2,7 @@ import {
   handleMessageInteraction,
   triggerHumanInTheLoopWorkflow,
   wrapToolDescription
-} from "./chunk-6O7VMHBN.js";
+} from "./chunk-IGJSMDBC.js";
 import "./chunk-G3PMV62Z.js";
 export {
   handleMessageInteraction,

package/dist/modelcontextprotocol/index.js

@@ -1,6 +1,6 @@
 import {
   createKnockMcpServer
-} from "../chunk-CCMSCN5A.js";
+} from "../chunk-GWRZ4NRX.js";
 import "../chunk-RMUYOYLN.js";
 import "../chunk-G3PMV62Z.js";
 export {

package/dist/modelcontextprotocol/local-server.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   createKnockMcpServer
-} from "../chunk-CCMSCN5A.js";
+} from "../chunk-GWRZ4NRX.js";
 import {
   createKnockClient
 } from "../chunk-TRLABEB7.js";

package/dist/{types-CrTRlRnE.d.ts → types-D6xiNyB2.d.ts}

@@ -1,4 +1,5 @@
 import { Message } from '@knocklabs/node/dist/src/resources/messages/interfaces';
+import { WorkflowRun } from '@knocklabs/node/dist/src/resources/workflows/interfaces';
 
 type Metadata = Record<string, unknown> | undefined;
 interface DeferredToolCallWorkflowData {
@@ -20,7 +21,7 @@ interface DeferredToolCallConfig {
     /**
      * The recipients to trigger the workflow for.
      */
-    recipients: string[];
+    recipients: string[] | Record<string, unknown>[];
     /**
      * Any extra data to pass to the workflow as context.
      */
@@ -32,9 +33,21 @@ interface DeferredToolCallConfig {
     /**
      * The actor to trigger the workflow for.
      */
-    actor?: string;
+    actor?: string | Record<string, unknown>;
+    /**
+     * A function to call before calling the Knock API.
+     */
+    onBeforeCallKnock?: (toolCall: DeferredToolCall) => Promise<void>;
+    /**
+     * A function to call after calling the Knock API.
+     */
+    onAfterCallKnock?: (toolCall: DeferredToolCall, result: WorkflowRun) => Promise<void>;
 }
 type DeferredToolCall = {
+    /**
+     * The ID of the tool call. Should be automatically generated by the SDK.
+     */
+    id: string;
     /**
      * The method of the tool that was called.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/agent-toolkit",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "A toolkit for working with Knock in Agent workflows.",
   "main": "src/index.js",
   "scripts": {
@@ -52,8 +52,8 @@
     "dist"
   ],
   "dependencies": {
-    "@knocklabs/mgmt": "^0.1.0-rc.0",
-    "@knocklabs/node": "^0.6.18",
+    "@knocklabs/mgmt": "^0.1.0",
+    "@knocklabs/node": "^0.6.19",
     "@modelcontextprotocol/sdk": "^1.7.0",
     "json-schema-to-zod": "^2.6.1",
     "uuid": "^11.1.0",

package/dist/chunk-6O7VMHBN.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/lib/human-in-the-loop/index.ts"],"sourcesContent":["import { Config } from \"@/types\";\n\nimport { KnockClient } from \"../knock-client\";\n\nimport {\n  DeferredToolCallWorkflowData,\n  DeferredToolCallConfig,\n  KnockOutboundWebhookEvent,\n  DeferredToolCall,\n  DeferredToolCallInteractionResult,\n} from \"./types\";\n\nfunction wrapToolDescription(description: string) {\n  return `${description}\\n\\nThis tool call is deferred. You will NOT receive a result from this tool but this is NOT an error. Do NOT retry the tool call as the result will be the same. The tool call result will be provided to you in the future.`;\n}\n\n/**\n * Triggers a human in the loop workflow.\n *\n * @param knockClient - The Knock client to use.\n * @param toolCall - The tool call to trigger.\n * @param config - The configuration to use.\n */\nasync function triggerHumanInTheLoopWorkflow({\n  knockClient,\n  config,\n  toolCall,\n  inputConfig,\n}: {\n  knockClient: KnockClient;\n  config: Config;\n  toolCall: DeferredToolCall;\n  inputConfig: DeferredToolCallConfig;\n}) {\n  const knock = await knockClient.publicApi(config.environment);\n\n  const result = await knock.workflows.trigger(inputConfig.workflow, {\n    data: {\n      type: \"deferred_tool_call\",\n      tool_call: toolCall,\n      metadata: inputConfig.metadata,\n    } as DeferredToolCallWorkflowData,\n    recipients: inputConfig.recipients,\n    tenant: inputConfig.tenant,\n    actor: inputConfig.actor,\n  });\n\n  return result;\n}\n\n/**\n * Given an outboundwebhook event, this function will parse the event into a normalized format.\n *\n * If the event is not associated with a deferred tool call, this function will return null.\n *\n * @param event - The outbound webhook event\n * @returns A deferred tool call interaction result, or null if the event is not a deferred tool call\n */\nfunction handleMessageInteraction(\n  event: KnockOutboundWebhookEvent\n): DeferredToolCallInteractionResult | null {\n  const { data: message } = event;\n\n  // We only care about message.interacted events\n  if (event.type !== \"message.interacted\") {\n    return null;\n  }\n\n  // We only care about messages that contain a tool call\n  if (message.data.type !== \"deferred_tool_call\" || !message.data.tool_call) {\n    return null;\n  }\n\n  const messageData = message.data as DeferredToolCallWorkflowData;\n\n  return {\n    workflow: message.source.key,\n    interaction: event.event_data,\n    toolCall: {\n      method: messageData.tool_call.method,\n      args: messageData.tool_call.args,\n      extra: messageData.tool_call.extra,\n    },\n    metadata: messageData.metadata,\n    context: {\n      messageId: message.id,\n      channelId: message.channel_id,\n      timestamp: event.created_at,\n    },\n  };\n}\n\nexport {\n  handleMessageInteraction,\n  triggerHumanInTheLoopWorkflow,\n  wrapToolDescription,\n};\n"],"mappings":";AAYA,SAAS,oBAAoB,aAAqB;AAChD,SAAO,GAAG,WAAW;AAAA;AAAA;AACvB;AASA,eAAe,8BAA8B;AAAA,EAC3C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAKG;AACD,QAAM,QAAQ,MAAM,YAAY,UAAU,OAAO,WAAW;AAE5D,QAAM,SAAS,MAAM,MAAM,UAAU,QAAQ,YAAY,UAAU;AAAA,IACjE,MAAM;AAAA,MACJ,MAAM;AAAA,MACN,WAAW;AAAA,MACX,UAAU,YAAY;AAAA,IACxB;AAAA,IACA,YAAY,YAAY;AAAA,IACxB,QAAQ,YAAY;AAAA,IACpB,OAAO,YAAY;AAAA,EACrB,CAAC;AAED,SAAO;AACT;AAUA,SAAS,yBACP,OAC0C;AAC1C,QAAM,EAAE,MAAM,QAAQ,IAAI;AAG1B,MAAI,MAAM,SAAS,sBAAsB;AACvC,WAAO;AAAA,EACT;AAGA,MAAI,QAAQ,KAAK,SAAS,wBAAwB,CAAC,QAAQ,KAAK,WAAW;AACzE,WAAO;AAAA,EACT;AAEA,QAAM,cAAc,QAAQ;AAE5B,SAAO;AAAA,IACL,UAAU,QAAQ,OAAO;AAAA,IACzB,aAAa,MAAM;AAAA,IACnB,UAAU;AAAA,MACR,QAAQ,YAAY,UAAU;AAAA,MAC9B,MAAM,YAAY,UAAU;AAAA,MAC5B,OAAO,YAAY,UAAU;AAAA,IAC/B;AAAA,IACA,UAAU,YAAY;AAAA,IACtB,SAAS;AAAA,MACP,WAAW,QAAQ;AAAA,MACnB,WAAW,QAAQ;AAAA,MACnB,WAAW,MAAM;AAAA,IACnB;AAAA,EACF;AACF;","names":[]}