@knocklabs/agent-toolkit 0.1.2 → 0.1.3

package/dist/lib/tools/objects.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/tools/objects.ts","../../../src/lib/knock-tool.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { KnockTool } from \"../knock-tool.js\";\n\nconst listObjects = KnockTool({\n  method: \"list_objects\",\n  name: \"List objects\",\n  description:\n    \"List all objects in a single collection. Objects are used to model custom collections in Knock that are NOT users or tenants. Use this tool when you need to return a paginated list of objects in a single collection.\",\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to list objects from.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.list(params.collection);\n  },\n});\n\nconst getObject = KnockTool({\n  method: \"get_object\",\n  name: \"Get object\",\n  description:\n    \"Get an object wihin a collection. Returns information about the object including any custom properties. Use this tool when you need to retrieve an object to understand it's properties.\",\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to get the object from.\"),\n    objectId: z.string().describe(\"(string): The ID of the object to get.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.get(params.collection, params.objectId);\n  },\n});\n\nconst createOrUpdateObject = KnockTool({\n  method: \"create_or_update_object\",\n  name: \"Create or update object\",\n  description: `Create or update an object in a specific collection. Objects are used to model custom collections in Knock that are NOT users or tenants. If the object does not exist, it will be created. If the object exists, it will be updated with the provided properties. The update will always perform an upsert operation, so you do not need to provide the full properties each time.\n  \n  Use this tool when you need to create a new object, or update an existing custom-object. Custom objects can be used to subscribe users' to as lists, and also send non-user facing notifications to.`,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to create or update the object in.\"),\n    objectId: z\n      .string()\n      .describe(\"(string): The ID of the object to create or update.\"),\n    properties: z\n      .record(z.string(), z.any())\n      .describe(\"(object): The properties to set on the object.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.set(\n      params.collection,\n      params.objectId,\n      params.properties\n    );\n  },\n});\n\nconst deleteObject = KnockTool({\n  method: \"delete_object\",\n  name: \"Delete object\",\n  description: `Delete an object from a specific collection. Use this tool when you need to remove an object from the system.`,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to delete the object from.\"),\n    objectId: z.string().describe(\"(string): The ID of the object to delete.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    await publicClient.objects.delete(params.collection, params.objectId);\n    return { success: true };\n  },\n});\n\nconst subscribeUsersToObject = KnockTool({\n  method: \"subscribe_users_to_object\",\n  name: \"Subscribe users to object\",\n  description: `\n  Subscribe a list of users to an object in a specific collection. We use this to model lists of users, for pub-sub use cases.\n  \n  Use this tool when you need to subscribe one or more users to an object where you will then trigger workflows for those lists of users to send notifications to.\n\n  Before using this tool, you should create the object in the collection using the createOrUpdateObject tool.\n  `,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to subscribe the user to.\"),\n    objectId: z\n      .string()\n      .describe(\"(string): The ID of the object to subscribe the user to.\"),\n    userIds: z\n      .array(z.string())\n      .describe(\n        \"(array): The IDs of the users to subscribe to the object. If not provided, the current user will be subscribed.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.addSubscriptions(\n      params.collection,\n      params.objectId,\n      {\n        recipients: params.userIds ?? [config.userId],\n      }\n    );\n  },\n});\n\nconst unsubscribeUsersFromObject = KnockTool({\n  method: \"unsubscribe_users_from_object\",\n  name: \"Unsubscribe users from object\",\n  description: `Unsubscribe a list of users from an object in a specific collection. We use this to model lists of users, for pub-sub use cases.\n  \n  Use this tool when you need to unsubscribe one or more users from an object where you will then trigger workflows for those lists of users to send notifications to.`,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to unsubscribe the user from.\"),\n    objectId: z\n      .string()\n      .describe(\"(string): The ID of the object to unsubscribe the user from.\"),\n    userIds: z\n      .array(z.string())\n      .describe(\n        \"(array): The IDs of the users to unsubscribe from the object.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.deleteSubscriptions(\n      params.collection,\n      params.objectId,\n      {\n        recipients: params.userIds ?? [config.userId],\n      }\n    );\n  },\n});\n\nexport const objects = {\n  listObjects,\n  getObject,\n  createOrUpdateObject,\n  deleteObject,\n  subscribeUsersToObject,\n  unsubscribeUsersFromObject,\n};\n\nexport const permissions = {\n  read: [\"listObjects\", \"getObject\"],\n  manage: [\n    \"createOrUpdateObject\",\n    \"deleteObject\",\n    \"subscribeUsersToObject\",\n    \"unsubscribeUsersFromObject\",\n  ],\n};\n","import type { ZodObject } from \"zod\";\nimport { z } from \"zod\";\nimport { Config } from \"../types.js\";\nimport { KnockClient } from \"./knock-client.js\";\n\nexport interface KnockToolDefinition {\n  /**\n   * The method name of the tool. This is a machine-readable string.\n   */\n  method: string;\n  /**\n   * The name of the tool. This can be used to reference the tool in the code.\n   * A descriptive LLM-readable string.\n   */\n  name: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, including examples where useful.\n   */\n  description: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, usage and input parameters.\n   * Ths is intended to be used by the underlying LLM.\n   */\n  fullDescription: string;\n\n  /**\n   * The Zod schema for the input parameters of the tool\n   */\n  parameters?: ZodObject<any>;\n  /**\n   * The actual implementation of the tool.\n   */\n  execute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nexport interface KnockTool extends Omit<KnockToolDefinition, \"execute\"> {\n  bindExecute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nconst trimLines = (text: string) =>\n  text\n    .split(\"\\n\")\n    .map((l) => l.trim())\n    .filter(Boolean)\n    .join(\"\\n\");\n\nexport const KnockTool = (\n  args: Omit<KnockToolDefinition, \"fullDescription\">\n): KnockTool => {\n  const { execute, ...restOfArgs } = args;\n  const parameters = restOfArgs.parameters\n    ? restOfArgs.parameters\n    : z.object({});\n\n  const schemaEntries = Object.entries(parameters.shape);\n\n  const argsStr =\n    schemaEntries.length === 0\n      ? \"Takes no arguments\"\n      : schemaEntries\n          .map(([key, value]) => {\n            return `- ${key}: ${(value as any).description || \"\"}`;\n          })\n          .join(\"\\n\");\n\n  const fullDescription = trimLines(`\n  Tool name:\n  ${args.name}\n  Description:\n  ${args.description}.\n  Arguments:\n  ${argsStr}\n  `);\n\n  return {\n    ...restOfArgs,\n    parameters,\n    fullDescription,\n    bindExecute: (knockClient: KnockClient, config: Config) =>\n      execute(knockClient, config),\n  };\n};\n"],"mappings":";AAAA,SAAS,KAAAA,UAAS;;;ACClB,SAAS,SAAS;AA8ClB,IAAM,YAAY,CAAC,SACjB,KACG,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,OAAO,EACd,KAAK,IAAI;AAEP,IAAM,YAAY,CACvB,SACc;AACd,QAAM,EAAE,SAAS,GAAG,WAAW,IAAI;AACnC,QAAM,aAAa,WAAW,aAC1B,WAAW,aACX,EAAE,OAAO,CAAC,CAAC;AAEf,QAAM,gBAAgB,OAAO,QAAQ,WAAW,KAAK;AAErD,QAAM,UACJ,cAAc,WAAW,IACrB,uBACA,cACG,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AACrB,WAAO,KAAK,GAAG,KAAM,MAAc,eAAe,EAAE;AAAA,EACtD,CAAC,EACA,KAAK,IAAI;AAElB,QAAM,kBAAkB,UAAU;AAAA;AAAA,IAEhC,KAAK,IAAI;AAAA;AAAA,IAET,KAAK,WAAW;AAAA;AAAA,IAEhB,OAAO;AAAA,GACR;AAED,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,aAAa,CAAC,aAA0B,WACtC,QAAQ,aAAa,MAAM;AAAA,EAC/B;AACF;;;ADtFA,IAAM,cAAc,UAAU;AAAA,EAC5B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aACE;AAAA,EACF,YAAYC,GAAE,OAAO;AAAA,IACnB,YAAYA,GACT,OAAO,EACP,SAAS,gDAAgD;AAAA,EAC9D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ,KAAK,OAAO,UAAU;AAAA,EAC1D;AACF,CAAC;AAED,IAAM,YAAY,UAAU;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aACE;AAAA,EACF,YAAYA,GAAE,OAAO;AAAA,IACnB,YAAYA,GACT,OAAO,EACP,SAAS,kDAAkD;AAAA,IAC9D,UAAUA,GAAE,OAAO,EAAE,SAAS,wCAAwC;AAAA,EACxE,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ,IAAI,OAAO,YAAY,OAAO,QAAQ;AAAA,EAC1E;AACF,CAAC;AAED,IAAM,uBAAuB,UAAU;AAAA,EACrC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAYA,GAAE,OAAO;AAAA,IACnB,YAAYA,GACT,OAAO,EACP,SAAS,6DAA6D;AAAA,IACzE,UAAUA,GACP,OAAO,EACP,SAAS,qDAAqD;AAAA,IACjE,YAAYA,GACT,OAAOA,GAAE,OAAO,GAAGA,GAAE,IAAI,CAAC,EAC1B,SAAS,gDAAgD;AAAA,EAC9D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP,OAAO;AAAA,IACT;AAAA,EACF;AACF,CAAC;AAED,IAAM,eAAe,UAAU;AAAA,EAC7B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA,EACb,YAAYA,GAAE,OAAO;AAAA,IACnB,YAAYA,GACT,OAAO,EACP,SAAS,qDAAqD;AAAA,IACjE,UAAUA,GAAE,OAAO,EAAE,SAAS,2CAA2C;AAAA,EAC3E,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,UAAM,aAAa,QAAQ,OAAO,OAAO,YAAY,OAAO,QAAQ;AACpE,WAAO,EAAE,SAAS,KAAK;AAAA,EACzB;AACF,CAAC;AAED,IAAM,yBAAyB,UAAU;AAAA,EACvC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOb,YAAYA,GAAE,OAAO;AAAA,IACnB,YAAYA,GACT,OAAO,EACP,SAAS,oDAAoD;AAAA,IAChE,UAAUA,GACP,OAAO,EACP,SAAS,0DAA0D;AAAA,IACtE,SAASA,GACN,MAAMA,GAAE,OAAO,CAAC,EAChB;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP;AAAA,QACE,YAAY,OAAO,WAAW,CAAC,OAAO,MAAM;AAAA,MAC9C;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAED,IAAM,6BAA6B,UAAU;AAAA,EAC3C,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAYA,GAAE,OAAO;AAAA,IACnB,YAAYA,GACT,OAAO,EACP,SAAS,wDAAwD;AAAA,IACpE,UAAUA,GACP,OAAO,EACP,SAAS,8DAA8D;AAAA,IAC1E,SAASA,GACN,MAAMA,GAAE,OAAO,CAAC,EAChB;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP;AAAA,QACE,YAAY,OAAO,WAAW,CAAC,OAAO,MAAM;AAAA,MAC9C;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAEM,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,eAAe,WAAW;AAAA,EACjC,QAAQ;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":["z","z"]}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/lib/tools/partials.js

@@ -1,58 +1,8 @@
-// src/lib/knock-tool.ts
-import { z } from "zod";
-var trimLines = (text) => text.split("\n").map((l) => l.trim()).filter(Boolean).join("\n");
-var KnockTool = (args) => {
-  const { execute, ...restOfArgs } = args;
-  const parameters = restOfArgs.parameters ? restOfArgs.parameters : z.object({});
-  const schemaEntries = Object.entries(parameters.shape);
-  const argsStr = schemaEntries.length === 0 ? "Takes no arguments" : schemaEntries.map(([key, value]) => {
-    return `- ${key}: ${value.description || ""}`;
-  }).join("\n");
-  const fullDescription = trimLines(`
-  Tool name:
-  ${args.name}
-  Description:
-  ${args.description}.
-  Arguments:
-  ${argsStr}
-  `);
-  return {
-    ...restOfArgs,
-    parameters,
-    fullDescription,
-    bindExecute: (knockClient, config) => execute(knockClient, config)
-  };
-};
-
-// src/lib/tools/partials.ts
-import { z as z2 } from "zod";
-var listPartials = KnockTool({
-  method: "list_partials",
-  name: "List partials",
-  description: `List all partials within the environment given. Partials provide common building blocks for notification templates. Returns information about the partial, including the name and the key.
-    
-    Use this tool when you need to know the available partials for the environment, like when building a notification template and wanting to use a partial to build the template.`,
-  parameters: z2.object({
-    environment: z2.string().describe(
-      "(string): The environment to list partials for. Defaults to `development`."
-    )
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const allPartials = [];
-    for await (const partial of knockClient.partials.list({
-      environment: params.environment ?? config.environment ?? "development"
-    })) {
-      allPartials.push(partial);
-    }
-    return allPartials;
-  }
-});
-var partials = {
-  listPartials
-};
-var permissions = {
-  read: ["listPartials"]
-};
+import {
+  partials,
+  permissions
+} from "../../chunk-BY4KQPUO.js";
+import "../../chunk-TOBLV65T.js";
 export {
   partials,
   permissions

package/dist/lib/tools/partials.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/knock-tool.ts","../../../src/lib/tools/partials.ts"],"sourcesContent":["import type { ZodObject } from \"zod\";\nimport { z } from \"zod\";\nimport { Config } from \"../types.js\";\nimport { KnockClient } from \"./knock-client.js\";\n\nexport interface KnockToolDefinition {\n  /**\n   * The method name of the tool. This is a machine-readable string.\n   */\n  method: string;\n  /**\n   * The name of the tool. This can be used to reference the tool in the code.\n   * A descriptive LLM-readable string.\n   */\n  name: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, including examples where useful.\n   */\n  description: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, usage and input parameters.\n   * Ths is intended to be used by the underlying LLM.\n   */\n  fullDescription: string;\n\n  /**\n   * The Zod schema for the input parameters of the tool\n   */\n  parameters?: ZodObject<any>;\n  /**\n   * The actual implementation of the tool.\n   */\n  execute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nexport interface KnockTool extends Omit<KnockToolDefinition, \"execute\"> {\n  bindExecute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nconst trimLines = (text: string) =>\n  text\n    .split(\"\\n\")\n    .map((l) => l.trim())\n    .filter(Boolean)\n    .join(\"\\n\");\n\nexport const KnockTool = (\n  args: Omit<KnockToolDefinition, \"fullDescription\">\n): KnockTool => {\n  const { execute, ...restOfArgs } = args;\n  const parameters = restOfArgs.parameters\n    ? restOfArgs.parameters\n    : z.object({});\n\n  const schemaEntries = Object.entries(parameters.shape);\n\n  const argsStr =\n    schemaEntries.length === 0\n      ? \"Takes no arguments\"\n      : schemaEntries\n          .map(([key, value]) => {\n            return `- ${key}: ${(value as any).description || \"\"}`;\n          })\n          .join(\"\\n\");\n\n  const fullDescription = trimLines(`\n  Tool name:\n  ${args.name}\n  Description:\n  ${args.description}.\n  Arguments:\n  ${argsStr}\n  `);\n\n  return {\n    ...restOfArgs,\n    parameters,\n    fullDescription,\n    bindExecute: (knockClient: KnockClient, config: Config) =>\n      execute(knockClient, config),\n  };\n};\n","import { KnockTool } from \"../knock-tool.js\";\nimport { z } from \"zod\";\nimport { Partial } from \"@knocklabs/mgmt/resources/partials.js\";\n\nconst listPartials = KnockTool({\n  method: \"list_partials\",\n  name: \"List partials\",\n  description: `List all partials within the environment given. Partials provide common building blocks for notification templates. Returns information about the partial, including the name and the key.\n    \n    Use this tool when you need to know the available partials for the environment, like when building a notification template and wanting to use a partial to build the template.`,\n  parameters: z.object({\n    environment: z\n      .string()\n      .describe(\n        \"(string): The environment to list partials for. Defaults to `development`.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const allPartials: Partial[] = [];\n    for await (const partial of knockClient.partials.list({\n      environment: params.environment ?? config.environment ?? \"development\",\n    })) {\n      allPartials.push(partial);\n    }\n    return allPartials;\n  },\n});\n\nexport const partials = {\n  listPartials,\n};\n\nexport const permissions = {\n  read: [\"listPartials\"],\n};\n"],"mappings":";AACA,SAAS,SAAS;AA8ClB,IAAM,YAAY,CAAC,SACjB,KACG,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,OAAO,EACd,KAAK,IAAI;AAEP,IAAM,YAAY,CACvB,SACc;AACd,QAAM,EAAE,SAAS,GAAG,WAAW,IAAI;AACnC,QAAM,aAAa,WAAW,aAC1B,WAAW,aACX,EAAE,OAAO,CAAC,CAAC;AAEf,QAAM,gBAAgB,OAAO,QAAQ,WAAW,KAAK;AAErD,QAAM,UACJ,cAAc,WAAW,IACrB,uBACA,cACG,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AACrB,WAAO,KAAK,GAAG,KAAM,MAAc,eAAe,EAAE;AAAA,EACtD,CAAC,EACA,KAAK,IAAI;AAElB,QAAM,kBAAkB,UAAU;AAAA;AAAA,IAEhC,KAAK,IAAI;AAAA;AAAA,IAET,KAAK,WAAW;AAAA;AAAA,IAEhB,OAAO;AAAA,GACR;AAED,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,aAAa,CAAC,aAA0B,WACtC,QAAQ,aAAa,MAAM;AAAA,EAC/B;AACF;;;ACxFA,SAAS,KAAAA,UAAS;AAGlB,IAAM,eAAe,UAAU;AAAA,EAC7B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAYA,GAAE,OAAO;AAAA,IACnB,aAAaA,GACV,OAAO,EACP;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,cAAyB,CAAC;AAChC,qBAAiB,WAAW,YAAY,SAAS,KAAK;AAAA,MACpD,aAAa,OAAO,eAAe,OAAO,eAAe;AAAA,IAC3D,CAAC,GAAG;AACF,kBAAY,KAAK,OAAO;AAAA,IAC1B;AACA,WAAO;AAAA,EACT;AACF,CAAC;AAEM,IAAM,WAAW;AAAA,EACtB;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,cAAc;AACvB;","names":["z"]}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/lib/tools/tenants.js

@@ -1,96 +1,8 @@
-// src/lib/tools/tenants.ts
-import { z as z2 } from "zod";
-
-// src/lib/knock-tool.ts
-import { z } from "zod";
-var trimLines = (text) => text.split("\n").map((l) => l.trim()).filter(Boolean).join("\n");
-var KnockTool = (args) => {
-  const { execute, ...restOfArgs } = args;
-  const parameters = restOfArgs.parameters ? restOfArgs.parameters : z.object({});
-  const schemaEntries = Object.entries(parameters.shape);
-  const argsStr = schemaEntries.length === 0 ? "Takes no arguments" : schemaEntries.map(([key, value]) => {
-    return `- ${key}: ${value.description || ""}`;
-  }).join("\n");
-  const fullDescription = trimLines(`
-  Tool name:
-  ${args.name}
-  Description:
-  ${args.description}.
-  Arguments:
-  ${argsStr}
-  `);
-  return {
-    ...restOfArgs,
-    parameters,
-    fullDescription,
-    bindExecute: (knockClient, config) => execute(knockClient, config)
-  };
-};
-
-// src/lib/tools/tenants.ts
-var getTenant = KnockTool({
-  method: "get_tenant",
-  name: "Get tenant",
-  description: `
-  Retrieves a tenant by their ID. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object.
-  
-  Use this tool when you need to lookup the information about a tenant, including name, and if there are any custom properties set.
-  `,
-  parameters: z2.object({
-    tenantId: z2.string().describe("(string): The ID of the tenant to retrieve.")
-  }),
-  execute: (knockClient) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    return await publicClient.tenants.get(params.tenantId);
-  }
-});
-var setTenant = KnockTool({
-  method: "set_tenant",
-  name: "Set tenant",
-  description: `
-  Creates or updates a tenant using the properties provided. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object.
-  
-  Use this tool when you need to create a new tenant, or update an existing tenant's properties.
-  `,
-  parameters: z2.object({
-    tenantId: z2.string().describe("(string): The ID of the tenant to update."),
-    name: z2.string().describe("(string): The name of the tenant."),
-    properties: z2.record(z2.string(), z2.any()).describe("(object): The properties to set on the tenant.")
-  }),
-  execute: (knockClient) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    return await publicClient.tenants.set(params.tenantId, {
-      name: params.name,
-      ...params.properties
-    });
-  }
-});
-var deleteTenant = KnockTool({
-  method: "delete_tenant",
-  name: "Delete tenant",
-  description: `
-  Deletes a tenant. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object.
-  
-  Use this tool when you've been asked to remove a tenant from the system.
-  `,
-  parameters: z2.object({
-    tenantId: z2.string().describe("(string): The ID of the tenant to delete.")
-  }),
-  execute: (knockClient) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    await publicClient.tenants.delete(params.tenantId);
-    return { success: true };
-  }
-});
-var tenants = {
-  getTenant,
-  setTenant,
-  deleteTenant
-};
-var permissions = {
-  read: ["getTenant"],
-  manage: ["setTenant", "deleteTenant"]
-};
+import {
+  permissions,
+  tenants
+} from "../../chunk-JTYQTWCX.js";
+import "../../chunk-TOBLV65T.js";
 export {
   permissions,
   tenants

package/dist/lib/tools/tenants.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/tools/tenants.ts","../../../src/lib/knock-tool.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { KnockTool } from \"../knock-tool.js\";\n\nconst getTenant = KnockTool({\n  method: \"get_tenant\",\n  name: \"Get tenant\",\n  description: `\n  Retrieves a tenant by their ID. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object.\n  \n  Use this tool when you need to lookup the information about a tenant, including name, and if there are any custom properties set.\n  `,\n  parameters: z.object({\n    tenantId: z\n      .string()\n      .describe(\"(string): The ID of the tenant to retrieve.\"),\n  }),\n  execute: (knockClient) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.tenants.get(params.tenantId);\n  },\n});\n\nconst setTenant = KnockTool({\n  method: \"set_tenant\",\n  name: \"Set tenant\",\n  description: `\n  Creates or updates a tenant using the properties provided. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object.\n  \n  Use this tool when you need to create a new tenant, or update an existing tenant's properties.\n  `,\n  parameters: z.object({\n    tenantId: z.string().describe(\"(string): The ID of the tenant to update.\"),\n    name: z.string().describe(\"(string): The name of the tenant.\"),\n    properties: z\n      .record(z.string(), z.any())\n      .describe(\"(object): The properties to set on the tenant.\"),\n  }),\n  execute: (knockClient) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.tenants.set(params.tenantId, {\n      name: params.name,\n      ...params.properties,\n    });\n  },\n});\n\nconst deleteTenant = KnockTool({\n  method: \"delete_tenant\",\n  name: \"Delete tenant\",\n  description: `\n  Deletes a tenant. Tenants in Knock are used to model organizations, teams, and other groups of users. They are a special type of object.\n  \n  Use this tool when you've been asked to remove a tenant from the system.\n  `,\n  parameters: z.object({\n    tenantId: z.string().describe(\"(string): The ID of the tenant to delete.\"),\n  }),\n  execute: (knockClient) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    await publicClient.tenants.delete(params.tenantId);\n    return { success: true };\n  },\n});\n\nexport const tenants = {\n  getTenant,\n  setTenant,\n  deleteTenant,\n};\n\nexport const permissions = {\n  read: [\"getTenant\"],\n  manage: [\"setTenant\", \"deleteTenant\"],\n};\n","import type { ZodObject } from \"zod\";\nimport { z } from \"zod\";\nimport { Config } from \"../types.js\";\nimport { KnockClient } from \"./knock-client.js\";\n\nexport interface KnockToolDefinition {\n  /**\n   * The method name of the tool. This is a machine-readable string.\n   */\n  method: string;\n  /**\n   * The name of the tool. This can be used to reference the tool in the code.\n   * A descriptive LLM-readable string.\n   */\n  name: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, including examples where useful.\n   */\n  description: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, usage and input parameters.\n   * Ths is intended to be used by the underlying LLM.\n   */\n  fullDescription: string;\n\n  /**\n   * The Zod schema for the input parameters of the tool\n   */\n  parameters?: ZodObject<any>;\n  /**\n   * The actual implementation of the tool.\n   */\n  execute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nexport interface KnockTool extends Omit<KnockToolDefinition, \"execute\"> {\n  bindExecute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nconst trimLines = (text: string) =>\n  text\n    .split(\"\\n\")\n    .map((l) => l.trim())\n    .filter(Boolean)\n    .join(\"\\n\");\n\nexport const KnockTool = (\n  args: Omit<KnockToolDefinition, \"fullDescription\">\n): KnockTool => {\n  const { execute, ...restOfArgs } = args;\n  const parameters = restOfArgs.parameters\n    ? restOfArgs.parameters\n    : z.object({});\n\n  const schemaEntries = Object.entries(parameters.shape);\n\n  const argsStr =\n    schemaEntries.length === 0\n      ? \"Takes no arguments\"\n      : schemaEntries\n          .map(([key, value]) => {\n            return `- ${key}: ${(value as any).description || \"\"}`;\n          })\n          .join(\"\\n\");\n\n  const fullDescription = trimLines(`\n  Tool name:\n  ${args.name}\n  Description:\n  ${args.description}.\n  Arguments:\n  ${argsStr}\n  `);\n\n  return {\n    ...restOfArgs,\n    parameters,\n    fullDescription,\n    bindExecute: (knockClient: KnockClient, config: Config) =>\n      execute(knockClient, config),\n  };\n};\n"],"mappings":";AAAA,SAAS,KAAAA,UAAS;;;ACClB,SAAS,SAAS;AA8ClB,IAAM,YAAY,CAAC,SACjB,KACG,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,OAAO,EACd,KAAK,IAAI;AAEP,IAAM,YAAY,CACvB,SACc;AACd,QAAM,EAAE,SAAS,GAAG,WAAW,IAAI;AACnC,QAAM,aAAa,WAAW,aAC1B,WAAW,aACX,EAAE,OAAO,CAAC,CAAC;AAEf,QAAM,gBAAgB,OAAO,QAAQ,WAAW,KAAK;AAErD,QAAM,UACJ,cAAc,WAAW,IACrB,uBACA,cACG,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AACrB,WAAO,KAAK,GAAG,KAAM,MAAc,eAAe,EAAE;AAAA,EACtD,CAAC,EACA,KAAK,IAAI;AAElB,QAAM,kBAAkB,UAAU;AAAA;AAAA,IAEhC,KAAK,IAAI;AAAA;AAAA,IAET,KAAK,WAAW;AAAA;AAAA,IAEhB,OAAO;AAAA,GACR;AAED,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,aAAa,CAAC,aAA0B,WACtC,QAAQ,aAAa,MAAM;AAAA,EAC/B;AACF;;;ADtFA,IAAM,YAAY,UAAU;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAYC,GAAE,OAAO;AAAA,IACnB,UAAUA,GACP,OAAO,EACP,SAAS,6CAA6C;AAAA,EAC3D,CAAC;AAAA,EACD,SAAS,CAAC,gBAAgB,OAAO,WAAW;AAC1C,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ,IAAI,OAAO,QAAQ;AAAA,EACvD;AACF,CAAC;AAED,IAAM,YAAY,UAAU;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAYA,GAAE,OAAO;AAAA,IACnB,UAAUA,GAAE,OAAO,EAAE,SAAS,2CAA2C;AAAA,IACzE,MAAMA,GAAE,OAAO,EAAE,SAAS,mCAAmC;AAAA,IAC7D,YAAYA,GACT,OAAOA,GAAE,OAAO,GAAGA,GAAE,IAAI,CAAC,EAC1B,SAAS,gDAAgD;AAAA,EAC9D,CAAC;AAAA,EACD,SAAS,CAAC,gBAAgB,OAAO,WAAW;AAC1C,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ,IAAI,OAAO,UAAU;AAAA,MACrD,MAAM,OAAO;AAAA,MACb,GAAG,OAAO;AAAA,IACZ,CAAC;AAAA,EACH;AACF,CAAC;AAED,IAAM,eAAe,UAAU;AAAA,EAC7B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAYA,GAAE,OAAO;AAAA,IACnB,UAAUA,GAAE,OAAO,EAAE,SAAS,2CAA2C;AAAA,EAC3E,CAAC;AAAA,EACD,SAAS,CAAC,gBAAgB,OAAO,WAAW;AAC1C,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,UAAM,aAAa,QAAQ,OAAO,OAAO,QAAQ;AACjD,WAAO,EAAE,SAAS,KAAK;AAAA,EACzB;AACF,CAAC;AAEM,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,WAAW;AAAA,EAClB,QAAQ,CAAC,aAAa,cAAc;AACtC;","names":["z","z"]}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/lib/tools/users.js

@@ -1,231 +1,8 @@
-// src/lib/tools/users.ts
-import { z as z2 } from "zod";
-
-// src/lib/knock-tool.ts
-import { z } from "zod";
-var trimLines = (text) => text.split("\n").map((l) => l.trim()).filter(Boolean).join("\n");
-var KnockTool = (args) => {
-  const { execute, ...restOfArgs } = args;
-  const parameters = restOfArgs.parameters ? restOfArgs.parameters : z.object({});
-  const schemaEntries = Object.entries(parameters.shape);
-  const argsStr = schemaEntries.length === 0 ? "Takes no arguments" : schemaEntries.map(([key, value]) => {
-    return `- ${key}: ${value.description || ""}`;
-  }).join("\n");
-  const fullDescription = trimLines(`
-  Tool name:
-  ${args.name}
-  Description:
-  ${args.description}.
-  Arguments:
-  ${argsStr}
-  `);
-  return {
-    ...restOfArgs,
-    parameters,
-    fullDescription,
-    bindExecute: (knockClient, config) => execute(knockClient, config)
-  };
-};
-
-// src/lib/tools/users.ts
-var getUser = KnockTool({
-  method: "get_user",
-  name: "Get user",
-  description: `
-   Retrieves the complete user object for the given userId, including email, name, phone number, and any custom properties. Use this tool when you need to retrieve a user's complete profile.
-
-   If the userId is not provided, it will use the userId from the config.
-   `,
-  parameters: z2.object({
-    userId: z2.string().describe("(string): The userId of the User to retrieve.")
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    return await publicClient.users.get(params.userId ?? config.userId);
-  }
-});
-var createOrUpdateUser = KnockTool({
-  method: "create_or_update_user",
-  name: "Create or update user",
-  description: `
-  Creates a new user if they don't exist, or updates the user object for the given userId, including email, name, phone number, and any custom properties.
-  
-  Use this tool when you need to update a user's profile.
-
-  If the userId is not provided, it will use the userId from the config.
-  `,
-  parameters: z2.object({
-    userId: z2.string().describe("(string): The userId of the User to update."),
-    email: z2.string().describe("(string): The email of the User to update."),
-    name: z2.string().describe("(string): The name of the User to update."),
-    phoneNumber: z2.string().describe("(string): The phone number of the User to update."),
-    customProperties: z2.record(z2.string(), z2.any()).describe(
-      "(object): A dictionary of custom properties to update for the User."
-    )
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    return await publicClient.users.identify(params.userId, {
-      email: params.email,
-      name: params.name,
-      phone_number: params.phoneNumber,
-      ...params.customProperties ?? {}
-    });
-  }
-});
-var deleteUser = KnockTool({
-  method: "delete_user",
-  name: "Delete user",
-  description: `
-  Deletes a user. Use this tool when you've been asked to remove a user from the system.
-  `,
-  parameters: z2.object({
-    userId: z2.string().describe("(string): The userId of the User to delete.")
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    await publicClient.users.delete(params.userId);
-    return { success: true };
-  }
-});
-var getUserPreferences = KnockTool({
-  method: "get_user_preferences",
-  name: "Get user preferences",
-  description: `
-  Retrieves the user's notification preferences for the given userId.
-
-  If the userId is not provided, it will use the userId from the config. 
-  `,
-  parameters: z2.object({
-    userId: z2.string().describe(
-      "(string): The userId of the User to retrieve Preferences for."
-    ),
-    preferenceSetId: z2.string().describe(
-      "(string): The preferenceSetId of the User to retrieve preferences for. Defaults to `default`."
-    )
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    return await publicClient.users.getPreferences(
-      params.userId ?? config.userId,
-      {
-        preferenceSet: params.preferenceSetId ?? "default"
-      }
-    );
-  }
-});
-var setUserPreferences = KnockTool({
-  method: "set_user_preferences",
-  name: "Set user preferences",
-  description: `
-  Overwrites the user's notification preferences for the given userId. Allows setting per-workflow, per-category, or per-channel notification preferences. Use this tool when you are asked to update a user's notification preferences.
-
-  If the userId is not provided, it will use the userId from the config.
-
-  Instructions:
-
-  - You must ALWAYS provide a full preference set to this tool.
-  - When setting per-workflow preferences, the key in the object should be the workflow key.
-  - Workflow and category preferences should always have channel types underneath.
-  - The channel types available to you are: email, sms, push, chat, and in_app_feed.
-  - To turn OFF a preference, you must set it to false.
-  - To turn ON a preference, you must set it to true.
-
-  <examples>
-    <example>
-      <description>
-        Update the user's preferences to turn off email notifications for the "welcome" workflow.
-      </description>
-      <input>
-        {
-          "workflows": {
-            "welcome": {
-              "channel_types": {
-                "email": false
-              }
-            }
-          }
-        }
-    </example>
-  </examples>
-  `,
-  parameters: z2.object({
-    userId: z2.string().describe("(string): The userId of the User to update preferences for."),
-    workflows: z2.record(z2.string(), z2.any()).describe(
-      "(object): The workflows to update where the key is the workflow key, and the value of the object is an object that contains a `channel_types` key with a boolean value for each channel type."
-    ),
-    categories: z2.record(z2.string(), z2.any()).describe(
-      "(object): The categories to update where the key is the category key, and the value of the object is an object that contains a `channel_types` key with a boolean value for each channel type."
-    ),
-    channel_types: z2.record(z2.string(), z2.boolean()).describe(
-      "(object): The channel types to update where the key is the channel type, and the value of the object is a boolean value."
-    )
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    const existingPreferences = await publicClient.users.getPreferences(
-      params.userId ?? config.userId,
-      {
-        preferenceSet: "default"
-      }
-    );
-    const updatedPreferences = {
-      ...existingPreferences,
-      workflows: {
-        ...existingPreferences.workflows,
-        ...params.workflows
-      },
-      categories: {
-        ...existingPreferences.categories,
-        ...params.categories
-      },
-      channel_types: {
-        ...existingPreferences.channel_types,
-        ...params.channel_types
-      }
-    };
-    return await publicClient.users.setPreferences(
-      params.userId ?? config.userId,
-      updatedPreferences
-    );
-  }
-});
-var getUserMessages = KnockTool({
-  method: "get_user_messages",
-  name: "Get user messages",
-  description: `
-  Retrieves the messages that this user has received from the service. Use this tool when you need information about the notifications that the user has received, including if the message has been read, seen, or interacted with. This will return a list of messages across all of the channels.
-
-  If the userId is not provided, it will use the userId from the config.
-  `,
-  parameters: z2.object({
-    userId: z2.string().describe("(string): The userId of the User to retrieve messages for."),
-    workflowRunId: z2.string().describe(
-      "(string): The workflowRunId of the User to retrieve. Use this when you want to retrieve messages sent from a workflow trigger."
-    )
-  }),
-  execute: (knockClient, config) => async (params) => {
-    const publicClient = await knockClient.publicApi();
-    return await publicClient.users.getMessages(
-      params.userId ?? config.userId,
-      {
-        workflow_run_id: params.workflowRunId
-      }
-    );
-  }
-});
-var users = {
-  getUser,
-  deleteUser,
-  createOrUpdateUser,
-  getUserPreferences,
-  setUserPreferences,
-  getUserMessages
-};
-var permissions = {
-  read: ["getUser", "getUserPreferences", "getUserMessages"],
-  manage: ["createOrUpdateUser", "deleteUser", "setUserPreferences"]
-};
+import {
+  permissions,
+  users
+} from "../../chunk-VJFA3ZVW.js";
+import "../../chunk-TOBLV65T.js";
 export {
   permissions,
   users

package/dist/lib/tools/users.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/tools/users.ts","../../../src/lib/knock-tool.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { KnockTool } from \"../knock-tool.js\";\n\nconst getUser = KnockTool({\n  method: \"get_user\",\n  name: \"Get user\",\n  description: `\n   Retrieves the complete user object for the given userId, including email, name, phone number, and any custom properties. Use this tool when you need to retrieve a user's complete profile.\n\n   If the userId is not provided, it will use the userId from the config.\n   `,\n  parameters: z.object({\n    userId: z\n      .string()\n      .describe(\"(string): The userId of the User to retrieve.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n\n    return await publicClient.users.get(params.userId ?? config.userId);\n  },\n});\n\nconst createOrUpdateUser = KnockTool({\n  method: \"create_or_update_user\",\n  name: \"Create or update user\",\n  description: `\n  Creates a new user if they don't exist, or updates the user object for the given userId, including email, name, phone number, and any custom properties.\n  \n  Use this tool when you need to update a user's profile.\n\n  If the userId is not provided, it will use the userId from the config.\n  `,\n  parameters: z.object({\n    userId: z.string().describe(\"(string): The userId of the User to update.\"),\n    email: z.string().describe(\"(string): The email of the User to update.\"),\n    name: z.string().describe(\"(string): The name of the User to update.\"),\n    phoneNumber: z\n      .string()\n      .describe(\"(string): The phone number of the User to update.\"),\n    customProperties: z\n      .record(z.string(), z.any())\n      .describe(\n        \"(object): A dictionary of custom properties to update for the User.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n\n    return await publicClient.users.identify(params.userId, {\n      email: params.email,\n      name: params.name,\n      phone_number: params.phoneNumber,\n      ...(params.customProperties ?? {}),\n    });\n  },\n});\n\nconst deleteUser = KnockTool({\n  method: \"delete_user\",\n  name: \"Delete user\",\n  description: `\n  Deletes a user. Use this tool when you've been asked to remove a user from the system.\n  `,\n  parameters: z.object({\n    userId: z.string().describe(\"(string): The userId of the User to delete.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    await publicClient.users.delete(params.userId);\n    return { success: true };\n  },\n});\n\nconst getUserPreferences = KnockTool({\n  method: \"get_user_preferences\",\n  name: \"Get user preferences\",\n  description: `\n  Retrieves the user's notification preferences for the given userId.\n\n  If the userId is not provided, it will use the userId from the config. \n  `,\n  parameters: z.object({\n    userId: z\n      .string()\n      .describe(\n        \"(string): The userId of the User to retrieve Preferences for.\"\n      ),\n    preferenceSetId: z\n      .string()\n      .describe(\n        \"(string): The preferenceSetId of the User to retrieve preferences for. Defaults to `default`.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n\n    return await publicClient.users.getPreferences(\n      params.userId ?? config.userId,\n      {\n        preferenceSet: params.preferenceSetId ?? \"default\",\n      }\n    );\n  },\n});\n\nconst setUserPreferences = KnockTool({\n  method: \"set_user_preferences\",\n  name: \"Set user preferences\",\n  description: `\n  Overwrites the user's notification preferences for the given userId. Allows setting per-workflow, per-category, or per-channel notification preferences. Use this tool when you are asked to update a user's notification preferences.\n\n  If the userId is not provided, it will use the userId from the config.\n\n  Instructions:\n\n  - You must ALWAYS provide a full preference set to this tool.\n  - When setting per-workflow preferences, the key in the object should be the workflow key.\n  - Workflow and category preferences should always have channel types underneath.\n  - The channel types available to you are: email, sms, push, chat, and in_app_feed.\n  - To turn OFF a preference, you must set it to false.\n  - To turn ON a preference, you must set it to true.\n\n  <examples>\n    <example>\n      <description>\n        Update the user's preferences to turn off email notifications for the \"welcome\" workflow.\n      </description>\n      <input>\n        {\n          \"workflows\": {\n            \"welcome\": {\n              \"channel_types\": {\n                \"email\": false\n              }\n            }\n          }\n        }\n    </example>\n  </examples>\n  `,\n  parameters: z.object({\n    userId: z\n      .string()\n      .describe(\"(string): The userId of the User to update preferences for.\"),\n    workflows: z\n      .record(z.string(), z.any())\n      .describe(\n        \"(object): The workflows to update where the key is the workflow key, and the value of the object is an object that contains a `channel_types` key with a boolean value for each channel type.\"\n      ),\n    categories: z\n      .record(z.string(), z.any())\n      .describe(\n        \"(object): The categories to update where the key is the category key, and the value of the object is an object that contains a `channel_types` key with a boolean value for each channel type.\"\n      ),\n    channel_types: z\n      .record(z.string(), z.boolean())\n      .describe(\n        \"(object): The channel types to update where the key is the channel type, and the value of the object is a boolean value.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n\n    const existingPreferences = await publicClient.users.getPreferences(\n      params.userId ?? config.userId,\n      {\n        preferenceSet: \"default\",\n      }\n    );\n\n    const updatedPreferences = {\n      ...existingPreferences,\n      workflows: {\n        ...existingPreferences.workflows,\n        ...params.workflows,\n      },\n      categories: {\n        ...existingPreferences.categories,\n        ...params.categories,\n      },\n      channel_types: {\n        ...existingPreferences.channel_types,\n        ...params.channel_types,\n      },\n    };\n\n    return await publicClient.users.setPreferences(\n      params.userId ?? config.userId,\n      updatedPreferences\n    );\n  },\n});\n\nconst getUserMessages = KnockTool({\n  method: \"get_user_messages\",\n  name: \"Get user messages\",\n  description: `\n  Retrieves the messages that this user has received from the service. Use this tool when you need information about the notifications that the user has received, including if the message has been read, seen, or interacted with. This will return a list of messages across all of the channels.\n\n  If the userId is not provided, it will use the userId from the config.\n  `,\n  parameters: z.object({\n    userId: z\n      .string()\n      .describe(\"(string): The userId of the User to retrieve messages for.\"),\n    workflowRunId: z\n      .string()\n      .describe(\n        \"(string): The workflowRunId of the User to retrieve. Use this when you want to retrieve messages sent from a workflow trigger.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n\n    return await publicClient.users.getMessages(\n      params.userId ?? config.userId,\n      {\n        workflow_run_id: params.workflowRunId,\n      }\n    );\n  },\n});\n\nexport const users = {\n  getUser,\n  deleteUser,\n  createOrUpdateUser,\n  getUserPreferences,\n  setUserPreferences,\n  getUserMessages,\n};\n\nexport const permissions = {\n  read: [\"getUser\", \"getUserPreferences\", \"getUserMessages\"],\n  manage: [\"createOrUpdateUser\", \"deleteUser\", \"setUserPreferences\"],\n};\n","import type { ZodObject } from \"zod\";\nimport { z } from \"zod\";\nimport { Config } from \"../types.js\";\nimport { KnockClient } from \"./knock-client.js\";\n\nexport interface KnockToolDefinition {\n  /**\n   * The method name of the tool. This is a machine-readable string.\n   */\n  method: string;\n  /**\n   * The name of the tool. This can be used to reference the tool in the code.\n   * A descriptive LLM-readable string.\n   */\n  name: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, including examples where useful.\n   */\n  description: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, usage and input parameters.\n   * Ths is intended to be used by the underlying LLM.\n   */\n  fullDescription: string;\n\n  /**\n   * The Zod schema for the input parameters of the tool\n   */\n  parameters?: ZodObject<any>;\n  /**\n   * The actual implementation of the tool.\n   */\n  execute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nexport interface KnockTool extends Omit<KnockToolDefinition, \"execute\"> {\n  bindExecute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nconst trimLines = (text: string) =>\n  text\n    .split(\"\\n\")\n    .map((l) => l.trim())\n    .filter(Boolean)\n    .join(\"\\n\");\n\nexport const KnockTool = (\n  args: Omit<KnockToolDefinition, \"fullDescription\">\n): KnockTool => {\n  const { execute, ...restOfArgs } = args;\n  const parameters = restOfArgs.parameters\n    ? restOfArgs.parameters\n    : z.object({});\n\n  const schemaEntries = Object.entries(parameters.shape);\n\n  const argsStr =\n    schemaEntries.length === 0\n      ? \"Takes no arguments\"\n      : schemaEntries\n          .map(([key, value]) => {\n            return `- ${key}: ${(value as any).description || \"\"}`;\n          })\n          .join(\"\\n\");\n\n  const fullDescription = trimLines(`\n  Tool name:\n  ${args.name}\n  Description:\n  ${args.description}.\n  Arguments:\n  ${argsStr}\n  `);\n\n  return {\n    ...restOfArgs,\n    parameters,\n    fullDescription,\n    bindExecute: (knockClient: KnockClient, config: Config) =>\n      execute(knockClient, config),\n  };\n};\n"],"mappings":";AAAA,SAAS,KAAAA,UAAS;;;ACClB,SAAS,SAAS;AA8ClB,IAAM,YAAY,CAAC,SACjB,KACG,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,OAAO,EACd,KAAK,IAAI;AAEP,IAAM,YAAY,CACvB,SACc;AACd,QAAM,EAAE,SAAS,GAAG,WAAW,IAAI;AACnC,QAAM,aAAa,WAAW,aAC1B,WAAW,aACX,EAAE,OAAO,CAAC,CAAC;AAEf,QAAM,gBAAgB,OAAO,QAAQ,WAAW,KAAK;AAErD,QAAM,UACJ,cAAc,WAAW,IACrB,uBACA,cACG,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AACrB,WAAO,KAAK,GAAG,KAAM,MAAc,eAAe,EAAE;AAAA,EACtD,CAAC,EACA,KAAK,IAAI;AAElB,QAAM,kBAAkB,UAAU;AAAA;AAAA,IAEhC,KAAK,IAAI;AAAA;AAAA,IAET,KAAK,WAAW;AAAA;AAAA,IAEhB,OAAO;AAAA,GACR;AAED,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,aAAa,CAAC,aAA0B,WACtC,QAAQ,aAAa,MAAM;AAAA,EAC/B;AACF;;;ADtFA,IAAM,UAAU,UAAU;AAAA,EACxB,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAYC,GAAE,OAAO;AAAA,IACnB,QAAQA,GACL,OAAO,EACP,SAAS,+CAA+C;AAAA,EAC7D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AAEjD,WAAO,MAAM,aAAa,MAAM,IAAI,OAAO,UAAU,OAAO,MAAM;AAAA,EACpE;AACF,CAAC;AAED,IAAM,qBAAqB,UAAU;AAAA,EACnC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOb,YAAYA,GAAE,OAAO;AAAA,IACnB,QAAQA,GAAE,OAAO,EAAE,SAAS,6CAA6C;AAAA,IACzE,OAAOA,GAAE,OAAO,EAAE,SAAS,4CAA4C;AAAA,IACvE,MAAMA,GAAE,OAAO,EAAE,SAAS,2CAA2C;AAAA,IACrE,aAAaA,GACV,OAAO,EACP,SAAS,mDAAmD;AAAA,IAC/D,kBAAkBA,GACf,OAAOA,GAAE,OAAO,GAAGA,GAAE,IAAI,CAAC,EAC1B;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AAEjD,WAAO,MAAM,aAAa,MAAM,SAAS,OAAO,QAAQ;AAAA,MACtD,OAAO,OAAO;AAAA,MACd,MAAM,OAAO;AAAA,MACb,cAAc,OAAO;AAAA,MACrB,GAAI,OAAO,oBAAoB,CAAC;AAAA,IAClC,CAAC;AAAA,EACH;AACF,CAAC;AAED,IAAM,aAAa,UAAU;AAAA,EAC3B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAYA,GAAE,OAAO;AAAA,IACnB,QAAQA,GAAE,OAAO,EAAE,SAAS,6CAA6C;AAAA,EAC3E,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,UAAM,aAAa,MAAM,OAAO,OAAO,MAAM;AAC7C,WAAO,EAAE,SAAS,KAAK;AAAA,EACzB;AACF,CAAC;AAED,IAAM,qBAAqB,UAAU;AAAA,EACnC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAYA,GAAE,OAAO;AAAA,IACnB,QAAQA,GACL,OAAO,EACP;AAAA,MACC;AAAA,IACF;AAAA,IACF,iBAAiBA,GACd,OAAO,EACP;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AAEjD,WAAO,MAAM,aAAa,MAAM;AAAA,MAC9B,OAAO,UAAU,OAAO;AAAA,MACxB;AAAA,QACE,eAAe,OAAO,mBAAmB;AAAA,MAC3C;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAED,IAAM,qBAAqB,UAAU;AAAA,EACnC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgCb,YAAYA,GAAE,OAAO;AAAA,IACnB,QAAQA,GACL,OAAO,EACP,SAAS,6DAA6D;AAAA,IACzE,WAAWA,GACR,OAAOA,GAAE,OAAO,GAAGA,GAAE,IAAI,CAAC,EAC1B;AAAA,MACC;AAAA,IACF;AAAA,IACF,YAAYA,GACT,OAAOA,GAAE,OAAO,GAAGA,GAAE,IAAI,CAAC,EAC1B;AAAA,MACC;AAAA,IACF;AAAA,IACF,eAAeA,GACZ,OAAOA,GAAE,OAAO,GAAGA,GAAE,QAAQ,CAAC,EAC9B;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AAEjD,UAAM,sBAAsB,MAAM,aAAa,MAAM;AAAA,MACnD,OAAO,UAAU,OAAO;AAAA,MACxB;AAAA,QACE,eAAe;AAAA,MACjB;AAAA,IACF;AAEA,UAAM,qBAAqB;AAAA,MACzB,GAAG;AAAA,MACH,WAAW;AAAA,QACT,GAAG,oBAAoB;AAAA,QACvB,GAAG,OAAO;AAAA,MACZ;AAAA,MACA,YAAY;AAAA,QACV,GAAG,oBAAoB;AAAA,QACvB,GAAG,OAAO;AAAA,MACZ;AAAA,MACA,eAAe;AAAA,QACb,GAAG,oBAAoB;AAAA,QACvB,GAAG,OAAO;AAAA,MACZ;AAAA,IACF;AAEA,WAAO,MAAM,aAAa,MAAM;AAAA,MAC9B,OAAO,UAAU,OAAO;AAAA,MACxB;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAED,IAAM,kBAAkB,UAAU;AAAA,EAChC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAYA,GAAE,OAAO;AAAA,IACnB,QAAQA,GACL,OAAO,EACP,SAAS,4DAA4D;AAAA,IACxE,eAAeA,GACZ,OAAO,EACP;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AAEjD,WAAO,MAAM,aAAa,MAAM;AAAA,MAC9B,OAAO,UAAU,OAAO;AAAA,MACxB;AAAA,QACE,iBAAiB,OAAO;AAAA,MAC1B;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAEM,IAAM,QAAQ;AAAA,EACnB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,WAAW,sBAAsB,iBAAiB;AAAA,EACzD,QAAQ,CAAC,sBAAsB,cAAc,oBAAoB;AACnE;","names":["z","z"]}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}