@knocklabs/agent-toolkit 0.1.7 → 0.1.9

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

@@ -1,18 +1,52 @@
-import { T as ToolkitConfig, a as ToolCategory } from '../types-DmmGlWVt.js';
-import { ToolSet } from 'ai';
+import { ToolSet, Tool } from 'ai';
+import { T as ToolkitConfig, a as ToolCategory } from '../types-BJFe1DAl.js';
 
-declare const createKnockToolkit: (config: ToolkitConfig) => {
+/**
+ * Creates a Knock toolkit for use with the AI SDK.
+ *
+ * You can filter the set of tools that are available by setting the `config.permissions` property.
+ *
+ * When the `config.permissions.workflows.run` is set, then workflow triggers for
+ * the specified workflows will be included in the returned tools.
+ *
+ * You can also specify a list of workflow keys to include in the returned tools, should you wish to
+ * limit the set of workflows that are available.
+ *
+ * @example
+ * ```ts
+ * const toolkit = await createKnockToolkit({
+ *   permissions: {
+ *     workflows: { read: true },
+ *   },
+ * });
+ * ```
+ *
+ * @param config - The configuration to use for the toolkit
+ * @returns A toolkit for use with the AI SDK
+ */
+declare const createKnockToolkit: (config: ToolkitConfig) => Promise<{
     /**
-     * Get all tools for all categories
-     * @returns An array of all tools
+     * Get all tools for all categories. When the `config.permissions.workflows.run` is set, then workflow triggers for
+     * the specified workflows will be included in the returned tools.
+     *
+     * @returns A promise that resolves to a set of tools
      */
-    getAllTools: () => ToolSet;
+    getAllTools: () => Promise<ToolSet>;
     /**
-     * Get all tools for a specific category
+     * Get all tools for a specific category. When trying to get tools for the `workflows` category and the run permission is set,
+     * the workflow triggers for the specified workflows will be included in the returned tools.
+     *
      * @param category - The category of tools to get
      * @returns An array of tools for the given category
      */
-    getTools: (category: ToolCategory) => ToolSet;
-};
+    getTools: (category: ToolCategory) => Promise<ToolSet>;
+    /**
+     * Get a map of all tools by method name. When the `config.permissions.workflows.run` is set, then workflow triggers for
+     * the specified workflows will be included in the returned tools.
+     *
+     * @returns A map of all tools by method name
+     */
+    getToolMap: () => Promise<Record<string, Tool>>;
+}>;
 
 export { createKnockToolkit };

package/dist/ai-sdk/index.js

@@ -1,9 +1,10 @@
 import {
   createKnockClient
-} from "../chunk-CXOB4H3U.js";
+} from "../chunk-OMZBTWDH.js";
 import {
+  getToolMap,
   getToolsByPermissionsInCategories
-} from "../chunk-3CUTEODM.js";
+} from "../chunk-6UHXLKAV.js";
 
 // src/ai-sdk/tool-converter.ts
 import { tool } from "ai";
@@ -15,35 +16,60 @@ var knockToolToAiTool = (knockClient, config, knockTool) => {
     execute: knockTool.bindExecute(knockClient, config)
   });
 };
+var knockToolsToToolSet = (knockClient, config, knockTools) => {
+  return knockTools.reduce(
+    (acc, tool2) => {
+      acc[tool2.method] = knockToolToAiTool(knockClient, config, tool2);
+      return acc;
+    },
+    {}
+  );
+};
 
 // src/ai-sdk/index.ts
-var createKnockToolkit = (config) => {
+var createKnockToolkit = async (config) => {
   const knockClient = createKnockClient(config);
-  const allowedToolsByCategory = getToolsByPermissionsInCategories(config);
+  const allowedToolsByCategory = await getToolsByPermissionsInCategories(
+    knockClient,
+    config
+  );
+  const allTools = Object.values(allowedToolsByCategory).flat();
+  const toolsByMethod = getToolMap(allTools);
   return {
     /**
-     * Get all tools for all categories
-     * @returns An array of all tools
+     * Get all tools for all categories. When the `config.permissions.workflows.run` is set, then workflow triggers for
+     * the specified workflows will be included in the returned tools.
+     *
+     * @returns A promise that resolves to a set of tools
      */
-    getAllTools: () => {
-      return Object.values(allowedToolsByCategory).flat().reduce(
-        (acc, tool2) => ({
-          ...acc,
-          [tool2.method]: knockToolToAiTool(knockClient, config, tool2)
-        }),
-        {}
-      );
+    getAllTools: async () => {
+      return knockToolsToToolSet(knockClient, config, allTools);
     },
     /**
-     * Get all tools for a specific category
+     * Get all tools for a specific category. When trying to get tools for the `workflows` category and the run permission is set,
+     * the workflow triggers for the specified workflows will be included in the returned tools.
+     *
      * @param category - The category of tools to get
      * @returns An array of tools for the given category
      */
-    getTools: (category) => {
-      return allowedToolsByCategory[category].reduce(
-        (acc, tool2) => ({
+    getTools: async (category) => {
+      return knockToolsToToolSet(
+        knockClient,
+        config,
+        allowedToolsByCategory[category]
+      );
+    },
+    /**
+     * Get a map of all tools by method name. When the `config.permissions.workflows.run` is set, then workflow triggers for
+     * the specified workflows will be included in the returned tools.
+     *
+     * @returns A map of all tools by method name
+     */
+    getToolMap: async () => {
+      return Object.entries(toolsByMethod).reduce(
+        (acc, [method, tool2]) => ({
           ...acc,
-          [tool2.method]: knockToolToAiTool(knockClient, config, tool2)
+          [method]: knockToolToAiTool(knockClient, config, tool2)
         }),
         {}
       );

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

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ai-sdk/tool-converter.ts","../../src/ai-sdk/index.ts"],"sourcesContent":["import type { Tool } from \"ai\";\nimport { tool } from \"ai\";\nimport { KnockClient } from \"../lib/knock-client.js\";\nimport { KnockTool } from \"../lib/knock-tool.js\";\nimport { Config } from \"../types.js\";\nimport { z } from \"zod\";\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\nexport { knockToolToAiTool };\n","import { ToolCategory, ToolkitConfig } from \"../types.js\";\nimport { getToolsByPermissionsInCategories } from \"../lib/utils.js\";\nimport { createKnockClient } from \"../lib/knock-client.js\";\nimport { ToolSet } from \"ai\";\nimport { knockToolToAiTool } from \"./tool-converter.js\";\n\nconst createKnockToolkit = (config: ToolkitConfig) => {\n  const knockClient = createKnockClient(config);\n  const allowedToolsByCategory = getToolsByPermissionsInCategories(config);\n\n  return {\n    /**\n     * Get all tools for all categories\n     * @returns An array of all tools\n     */\n    getAllTools: (): ToolSet => {\n      return Object.values(allowedToolsByCategory)\n        .flat()\n        .reduce(\n          (acc, tool) => ({\n            ...acc,\n            [tool.method]: knockToolToAiTool(knockClient, config, tool),\n          }),\n          {} as ToolSet\n        );\n    },\n\n    /**\n     * Get all tools for a specific category\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 allowedToolsByCategory[category].reduce(\n        (acc, tool) => ({\n          ...acc,\n          [tool.method]: knockToolToAiTool(knockClient, config, tool),\n        }),\n        {} as ToolSet\n      );\n    },\n  };\n};\n\nexport { createKnockToolkit };\n"],"mappings":";;;;;;;;AACA,SAAS,YAAY;AAIrB,SAAS,SAAS;AAKlB,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;;;ACdA,IAAM,qBAAqB,CAAC,WAA0B;AACpD,QAAM,cAAc,kBAAkB,MAAM;AAC5C,QAAM,yBAAyB,kCAAkC,MAAM;AAEvE,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA,IAKL,aAAa,MAAe;AAC1B,aAAO,OAAO,OAAO,sBAAsB,EACxC,KAAK,EACL;AAAA,QACC,CAAC,KAAKA,WAAU;AAAA,UACd,GAAG;AAAA,UACH,CAACA,MAAK,MAAM,GAAG,kBAAkB,aAAa,QAAQA,KAAI;AAAA,QAC5D;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOA,UAAU,CAAC,aAAoC;AAC7C,aAAO,uBAAuB,QAAQ,EAAE;AAAA,QACtC,CAAC,KAAKA,WAAU;AAAA,UACd,GAAG;AAAA,UACH,CAACA,MAAK,MAAM,GAAG,kBAAkB,aAAa,QAAQA,KAAI;AAAA,QAC5D;AAAA,QACA,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AACF;","names":["tool"]}
+{"version":3,"sources":["../../src/ai-sdk/tool-converter.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 { Tool, ToolSet } from \"ai\";\n\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\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.run` 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 (config: ToolkitConfig) => {\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  return {\n    /**\n     * Get all tools for all categories. When the `config.permissions.workflows.run` is set, then workflow triggers for\n     * the specified workflows will be included in the returned tools.\n     *\n     * @returns A promise that resolves to a set of tools\n     */\n    getAllTools: async (): Promise<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 run 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: async (category: ToolCategory): Promise<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. When the `config.permissions.workflows.run` is set, then workflow triggers for\n     * the specified workflows will be included in the returned tools.\n     *\n     * @returns A map of all tools by method name\n     */\n    getToolMap: async (): Promise<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\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;;;ACPA,IAAM,qBAAqB,OAAO,WAA0B;AAC1D,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,SAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOL,aAAa,YAA8B;AACzC,aAAO,oBAAoB,aAAa,QAAQ,QAAQ;AAAA,IAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IASA,UAAU,OAAO,aAA6C;AAC5D,aAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA,uBAAuB,QAAQ;AAAA,MACjC;AAAA,IACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAQA,YAAY,YAA2C;AACrD,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,EACF;AACF;","names":["tool","tool"]}