@knocklabs/agent-toolkit 0.1.3 → 0.1.4

package/dist/chunk-RPKDXX4O.js

@@ -0,0 +1,1023 @@
+// 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/channels.ts
+var listChannels = KnockTool({
+  method: "list_channels",
+  name: "List channels",
+  description: `
+  Returns a list of all of the channels configured in the account. Each channel returns information about the type of channel it is (email, sms, push, etc), and the provider that's used to power the channel.
+
+  Use this tool when you need to know about the channels configured in the Knock account, like when configuring a workflow.
+  `,
+  execute: (knockClient) => async (params) => {
+    const allChannels = [];
+    for await (const channel of knockClient.channels.list()) {
+      allChannels.push(channel);
+    }
+    return allChannels;
+  }
+});
+var channels = {
+  listChannels
+};
+var permissions = {
+  read: ["listChannels"]
+};
+
+// src/lib/tools/commits.ts
+import { z as z2 } from "zod";
+var listCommits = KnockTool({
+  method: "list_commits",
+  name: "List commits",
+  description: `
+  Returns all commits available in the environment. Use this tool when you are asked to see what changes are available to be deployed.
+  `,
+  parameters: z2.object({
+    environment: z2.string().describe(
+      "(string): The environment to list commits for. Defaults to `development`."
+    ),
+    promoted: z2.boolean().describe(
+      "(boolean): Whether to only return promoted commits. Defaults to `false`."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    return await knockClient.commits.list({
+      environment: params.environment ?? config.environment ?? "development",
+      promoted: params.promoted ?? false
+    });
+  }
+});
+var commitAllChanges = KnockTool({
+  method: "commit_all_changes",
+  name: "Commit all changes",
+  description: `
+  Commit all pending changes to the current environment. Use this tool when you are asked to save all changes to the current environment. This can only be used in the development environment.
+  `,
+  parameters: z2.object({
+    message: z2.string().describe("(string): The message to include in the commit.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    return await knockClient.commits.commitAll({
+      environment: config.environment ?? "development",
+      commit_message: params.message
+    });
+  }
+});
+var promoteAllCommits = KnockTool({
+  method: "promote_all_commits",
+  name: "Promote all commits",
+  description: `
+  Promote all commits to the next environment. Use this tool when you are asked to deploy all changes. 
+
+  When not specified, the \`toEnvironment\` will default to the environment that comes after the environment specified in the config.
+  `,
+  parameters: z2.object({
+    toEnvironment: z2.string().describe("(string): The environment to promote all commits to.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    return await knockClient.put("/v1/commits/promote", {
+      body: { to_environment: params.toEnvironment }
+    });
+  }
+});
+var commits = {
+  listCommits,
+  commitAllChanges,
+  promoteAllCommits
+};
+var permissions2 = {
+  read: ["listCommits"],
+  manage: ["commitAllChanges", "promoteAllCommits"]
+};
+
+// src/lib/tools/email-layouts.ts
+import { z as z3 } from "zod";
+var listEmailLayouts = KnockTool({
+  method: "list_email_layouts",
+  name: "List email layouts",
+  description: `List all email layouts within the environment given. Returns information about the email layout, including the name and the key. 
+  
+  Use this tool when building a workflow that is building an email notification when you need to know the available email layouts.`,
+  parameters: z3.object({
+    environment: z3.string().describe(
+      "(string): The environment to list email layouts for. Defaults to `development`."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const allEmailLayouts = [];
+    for await (const emailLayout of knockClient.emailLayouts.list({
+      environment: params.environment ?? config.environment ?? "development"
+    })) {
+      allEmailLayouts.push(emailLayout);
+    }
+    return allEmailLayouts;
+  }
+});
+var emailLayouts = {
+  listEmailLayouts
+};
+var permissions3 = {
+  read: ["listEmailLayouts"]
+};
+
+// src/lib/tools/environments.ts
+var listEnvironments = KnockTool({
+  method: "list_environments",
+  name: "List environments",
+  description: `
+  Lists all environments available, returning the slug, name, and the order of each environment. Use this tool when you need to see what environments are available to deploy to.
+  `,
+  execute: (knockClient) => async (params) => {
+    const allEnvironments = [];
+    for await (const environment of knockClient.environments.list()) {
+      allEnvironments.push(environment);
+    }
+    return allEnvironments;
+  }
+});
+var environments = {
+  listEnvironments
+};
+var permissions4 = {
+  read: ["listEnvironments"]
+};
+
+// src/lib/tools/messages.ts
+import { z as z4 } from "zod";
+var getMessageContent = KnockTool({
+  method: "get_message_content",
+  name: "Get message content",
+  description: `
+  Retrieves the complete contents of a single message, specified by the messageId. The message contents includes the rendered template that was sent to the recipient. Use this tool when you want to surface information about the emails, SMS, and push notifications that were sent to a user.
+  `,
+  parameters: z4.object({
+    messageId: z4.string().describe("(string): The messageId of the message to retrieve.")
+  }),
+  execute: (knockClient) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.messages.getContent(params.messageId);
+  }
+});
+var messages = {
+  getMessageContent
+};
+var permissions5 = {
+  read: ["getMessageContent"]
+};
+
+// src/lib/tools/message-types.ts
+import { z as z5 } from "zod";
+var listMessageTypes = KnockTool({
+  method: "list_message_types",
+  name: "List message types",
+  description: "List all message types available for the environment. Each message type returns the schema, which includes information about the variants and the fields available per-variant. Use this tool when you need to understand the different message types that are available for the environment for use in Guides.",
+  parameters: z5.object({
+    environment: z5.string().describe(
+      "(string): The environment to list message types for. Defaults to `development`."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const allMessageTypes = [];
+    for await (const messageType of knockClient.messageTypes.list({
+      environment: params.environment ?? config.environment ?? "development"
+    })) {
+      allMessageTypes.push(messageType);
+    }
+    return allMessageTypes;
+  }
+});
+var createOrUpdateMessageType = KnockTool({
+  method: "create_or_update_message_type",
+  name: "Create or update message type",
+  description: `
+  Create or update a message type. A message type is a schema that defines fields available to an editor within Knock. Message types always have at least one variant, that MUST be named "default".
+  
+  Use this tool when you need to create a new message type, or update an existing message type. You must pass the FULL message type to this tool if you're going to update an existing message type.
+
+  The preview is a string of HTML that will be rendered in the Knock UI as a representation of the message type. It is shared across all variants. It supports liquid, where the field name is available as a variable, so a field named "text" will be rendered as {{ text }}.
+
+  <example>
+   <description>
+    Create a new message type for a banner component that has a text and an action URL.
+   </description>
+   <input>
+    {
+      "messageTypeKey": "banner",
+      "name": "Banner",
+      "description": "A banner component that has a text and an action URL.",
+      "preview": "<div>{{ text }}</div>",
+      "variants": [
+        {
+          "key": "default",
+          "name": "Default",
+          "fields": [
+            {
+              "key": "text",
+              "type": "text",
+              "label": "Text",
+              "settings": {
+                "max_length": 100,
+              },
+            },
+            {
+              "key": "action_url",
+              "type": "text",
+              "label": "Action URL",
+              "settings": {
+                "placeholder": "https://example.com",
+              },
+            }
+          ]
+        }
+      ]
+    }
+   </input>
+  </example>
+  <example>
+   <description>
+    Create a message type for a card component that has an icon type, title, body, and a single action button.
+   </description>
+   <input>
+    {
+      "messageTypeKey": "card",
+      "name": "Card",
+      "description": "A single-action card component.",
+      "preview": "
+        <div>
+          <h2>{{ title }}</h2>
+          <p>{{ body }}</p>
+          <button>Action</button>
+        </div>
+      ",
+      "variants": [
+        {
+          "key": "default",
+          "name": "Default",
+          "fields": [
+            {
+              "key": "icon_type",
+              "type": "select",
+              "label": "Icon type",
+              "settings": {
+                "options": [
+                  {
+                    "value": "warning",
+                    "label": "Warning",
+                  },
+                  {
+                    "value": "success",
+                    "label": "Success",
+                  },
+                  {
+                    "value": "info",
+                    "label": "Info",
+                  },
+                  {
+                    "value": "error",
+                    "label": "Error",
+                  },
+                ]
+              },
+            },
+            {
+              "key": "title",
+              "type": "text",
+              "label": "Title",
+            },
+            {
+              "key": "description",
+              "type": "markdown",
+              "label": "Description",
+            },
+            {
+              "key": "action_button",
+              "type": "button",
+              "label": "Action button",
+            },
+          ]
+        }
+      ]
+    }
+   </input>
+  </example>
+  `,
+  parameters: z5.object({
+    messageTypeKey: z5.string().describe("(string): The key of the message type to create or update."),
+    name: z5.string().describe("(string): The name of the message type."),
+    description: z5.string().optional().describe("(string): The description of the message type."),
+    preview: z5.string().optional().describe(
+      "(string): The preview of the variant. This is a string of HTML that will be rendered in the preview of the message type. There is a single preview shared by all variants."
+    ),
+    variants: z5.array(
+      z5.object({
+        key: z5.string().describe("(string): The key of the variant."),
+        name: z5.string().describe("(string): The name of the variant."),
+        description: z5.string().optional().describe("(string): The description of the variant."),
+        fields: z5.array(
+          z5.object({
+            key: z5.string().describe("(string): The key of the field."),
+            type: z5.string().describe(
+              "(string): The type of the field. One of `text`, `textarea`, `button`, `markdown`, `select`, `multi_select`."
+            ),
+            label: z5.string().describe("(string): The label of the field."),
+            settings: z5.object({}).describe("(object): The settings of the field.")
+          })
+        ).describe("(array): The fields of the variant.")
+      })
+    ).describe("(array): The variants of the message type.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    return await knockClient.messageTypes.upsert(params.messageTypeKey, {
+      message_type: {
+        name: params.name,
+        variants: params.variants,
+        description: params.description ?? "",
+        preview: params.preview ?? "<div></div>"
+      },
+      environment: params.environment ?? config.environment ?? "development"
+    });
+  }
+});
+var messageTypes = {
+  listMessageTypes,
+  createOrUpdateMessageType
+};
+var permissions6 = {
+  read: ["listMessageTypes"],
+  manage: ["createOrUpdateMessageType"]
+};
+
+// src/lib/tools/objects.ts
+import { z as z6 } from "zod";
+var listObjects = KnockTool({
+  method: "list_objects",
+  name: "List objects",
+  description: "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.",
+  parameters: z6.object({
+    collection: z6.string().describe("(string): The collection to list objects from.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.objects.list(params.collection);
+  }
+});
+var getObject = KnockTool({
+  method: "get_object",
+  name: "Get object",
+  description: "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.",
+  parameters: z6.object({
+    collection: z6.string().describe("(string): The collection to get the object from."),
+    objectId: z6.string().describe("(string): The ID of the object to get.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.objects.get(params.collection, params.objectId);
+  }
+});
+var createOrUpdateObject = KnockTool({
+  method: "create_or_update_object",
+  name: "Create or update object",
+  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.
+  
+  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.`,
+  parameters: z6.object({
+    collection: z6.string().describe("(string): The collection to create or update the object in."),
+    objectId: z6.string().describe("(string): The ID of the object to create or update."),
+    properties: z6.record(z6.string(), z6.any()).describe("(object): The properties to set on the object.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.objects.set(
+      params.collection,
+      params.objectId,
+      params.properties
+    );
+  }
+});
+var deleteObject = KnockTool({
+  method: "delete_object",
+  name: "Delete object",
+  description: `Delete an object from a specific collection. Use this tool when you need to remove an object from the system.`,
+  parameters: z6.object({
+    collection: z6.string().describe("(string): The collection to delete the object from."),
+    objectId: z6.string().describe("(string): The ID of the object to delete.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    await publicClient.objects.delete(params.collection, params.objectId);
+    return { success: true };
+  }
+});
+var subscribeUsersToObject = KnockTool({
+  method: "subscribe_users_to_object",
+  name: "Subscribe users to object",
+  description: `
+  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.
+  
+  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.
+
+  Before using this tool, you should create the object in the collection using the createOrUpdateObject tool.
+  `,
+  parameters: z6.object({
+    collection: z6.string().describe("(string): The collection to subscribe the user to."),
+    objectId: z6.string().describe("(string): The ID of the object to subscribe the user to."),
+    userIds: z6.array(z6.string()).describe(
+      "(array): The IDs of the users to subscribe to the object. If not provided, the current user will be subscribed."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.objects.addSubscriptions(
+      params.collection,
+      params.objectId,
+      {
+        recipients: params.userIds ?? [config.userId]
+      }
+    );
+  }
+});
+var unsubscribeUsersFromObject = KnockTool({
+  method: "unsubscribe_users_from_object",
+  name: "Unsubscribe users from object",
+  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.
+  
+  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.`,
+  parameters: z6.object({
+    collection: z6.string().describe("(string): The collection to unsubscribe the user from."),
+    objectId: z6.string().describe("(string): The ID of the object to unsubscribe the user from."),
+    userIds: z6.array(z6.string()).describe(
+      "(array): The IDs of the users to unsubscribe from the object."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.objects.deleteSubscriptions(
+      params.collection,
+      params.objectId,
+      {
+        recipients: params.userIds ?? [config.userId]
+      }
+    );
+  }
+});
+var objects = {
+  listObjects,
+  getObject,
+  createOrUpdateObject,
+  deleteObject,
+  subscribeUsersToObject,
+  unsubscribeUsersFromObject
+};
+var permissions7 = {
+  read: ["listObjects", "getObject"],
+  manage: [
+    "createOrUpdateObject",
+    "deleteObject",
+    "subscribeUsersToObject",
+    "unsubscribeUsersFromObject"
+  ]
+};
+
+// src/lib/tools/partials.ts
+import { z as z7 } 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: z7.object({
+    environment: z7.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 permissions8 = {
+  read: ["listPartials"]
+};
+
+// src/lib/tools/tenants.ts
+import { z as z8 } from "zod";
+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: z8.object({
+    tenantId: z8.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: z8.object({
+    tenantId: z8.string().describe("(string): The ID of the tenant to update."),
+    name: z8.string().describe("(string): The name of the tenant."),
+    properties: z8.record(z8.string(), z8.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: z8.object({
+    tenantId: z8.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 permissions9 = {
+  read: ["getTenant"],
+  manage: ["setTenant", "deleteTenant"]
+};
+
+// src/lib/tools/users.ts
+import { z as z9 } from "zod";
+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: z9.object({
+    userId: z9.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: z9.object({
+    userId: z9.string().describe("(string): The userId of the User to update."),
+    email: z9.string().describe("(string): The email of the User to update."),
+    name: z9.string().describe("(string): The name of the User to update."),
+    phoneNumber: z9.string().describe("(string): The phone number of the User to update."),
+    customProperties: z9.record(z9.string(), z9.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: z9.object({
+    userId: z9.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: z9.object({
+    userId: z9.string().describe(
+      "(string): The userId of the User to retrieve Preferences for."
+    ),
+    preferenceSetId: z9.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: z9.object({
+    userId: z9.string().describe("(string): The userId of the User to update preferences for."),
+    workflows: z9.record(z9.string(), z9.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: z9.record(z9.string(), z9.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: z9.record(z9.string(), z9.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: z9.object({
+    userId: z9.string().describe("(string): The userId of the User to retrieve messages for."),
+    workflowRunId: z9.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 permissions10 = {
+  read: ["getUser", "getUserPreferences", "getUserMessages"],
+  manage: ["createOrUpdateUser", "deleteUser", "setUserPreferences"]
+};
+
+// src/lib/tools/workflows.ts
+import { z as z10 } from "zod";
+var listWorkflows = KnockTool({
+  method: "list_workflows",
+  name: "List workflows",
+  description: `
+  List all workflows available for the given environment. Returns structural information about the workflows, including the key, name, description, and categories. Will also return the steps that make up the workflow. 
+
+  Use this tool when you need to understand which workflows are available to be called. 
+  `,
+  parameters: z10.object({
+    environment: z10.string().describe(
+      "(string): The environment to list workflows for. Defaults to `development`."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const allWorkflows = [];
+    const listParams = {
+      environment: params.environment ?? config.environment ?? "development"
+    };
+    for await (const workflow of knockClient.workflows.list(listParams)) {
+      allWorkflows.push(workflow);
+    }
+    return allWorkflows;
+  }
+});
+var triggerWorkflow = KnockTool({
+  method: "trigger_workflow",
+  name: "Trigger workflow",
+  description: `
+  Trigger a workflow for one or more recipients.
+
+  Use this tool when you need to trigger a workflow to send a notification across the channels configured for the workflow. The workflow must be committed in the environment for you to trigger it.
+
+  When recipients aren't provided, the workflow will be triggered for the current user specified in the config.
+  `,
+  parameters: z10.object({
+    workflowKey: z10.string().describe("(string): The key of the workflow to trigger."),
+    recipients: z10.array(z10.string()).describe("(array): The recipients to trigger the workflow for."),
+    data: z10.record(z10.string(), z10.any()).describe("(object): Data to pass to the workflow."),
+    tenant: z10.record(z10.string(), z10.any()).describe(
+      "(object): The tenant to trigger the workflow for. Must contain an id if being sent."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    const result = await publicClient.workflows.trigger(params.workflowKey, {
+      recipients: params.recipients,
+      data: params.data,
+      tenant: params.tenant
+    });
+    return result.workflow_run_id;
+  }
+});
+var createEmailWorkflow = KnockTool({
+  method: "create_email_workflow",
+  name: "Create email workflow",
+  description: `
+  Creates a simple email workflow with a single step that sends an email to the recipient. Use this tool when you need to need to create an email notification, and you don't need to specify any additional steps. You can only create workflows in the development environment.
+
+  The content of the email you supply should ONLY ever be in markdown format for simplicity. You can supply dynamic variables to the subject and body of the email using the liquid template language.
+
+  When writing markdown, be sure to use headings (##) to separate sections of the email. Use an informal writing style, and avoid using complex language.
+
+  The following variables are available to use in the email subject and body:
+
+  - \`recipient.name\`: The name of the recipient.
+  - \`recipient.email\`: The email of the recipient.
+  - \`recipient.phone_number\`: The phone number of the recipient.
+  - \`tenant.id\`: The id of the tenant.
+  - \`tenant.name\`: The name of the tenant.
+
+  You can supply any other dynamic variables by referencing them under the \`data\` key in the \`data\` parameter when triggering the workflow. You add those like \`{{ data.variable_name }}\`.
+
+  You can also supply a list of categories to the workflow. These are used to categorize workflows for notification preferences. Categories should be supplied as lowercase strings in kebab case.
+
+  Once you've created the workflow, you should ask if you should commit the changes to the environment.
+  `,
+  parameters: z10.object({
+    environment: z10.string().describe(
+      "(string): The environment to create the workflow in. Defaults to `development`."
+    ),
+    workflowKey: z10.string().describe("(string): The key of the workflow."),
+    name: z10.string().describe("(string): The name of the workflow."),
+    categories: z10.array(z10.string()).describe("(array): The categories to add to the workflow."),
+    subject: z10.string().describe("(string): The subject of the email."),
+    body: z10.string().describe("(string): The body of the email.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const emailChannelsPage = await knockClient.channels.list();
+    const emailChannels = emailChannelsPage.entries.filter(
+      (channel) => channel.type === "email"
+    );
+    if (emailChannels.length === 0) {
+      throw new Error("No email channels found");
+    }
+    const workflowParams = {
+      environment: params.environment ?? config.environment ?? "development",
+      workflow: {
+        name: params.name,
+        categories: params.categories ?? [],
+        steps: [
+          {
+            type: "channel",
+            channel_key: emailChannels[0].key,
+            template: {
+              settings: {
+                layout_key: "default"
+              },
+              subject: params.subject,
+              visual_blocks: [
+                // @ts-ignore
+                {
+                  type: "markdown",
+                  content: params.body
+                }
+              ]
+            },
+            name: "Email",
+            ref: "email_1"
+          }
+        ]
+      }
+    };
+    return await knockClient.workflows.upsert(
+      params.workflowKey,
+      workflowParams
+    );
+  }
+});
+var createOneOffWorkflowSchedule = KnockTool({
+  method: "create_one_off_workflow_schedule",
+  name: "Create one-off workflow schedule",
+  description: `
+  Create a one-off workflow schedule for a user. Use this tool when you need to schedule the execution of a workflow for a specific user in the future, like to power a delayed notification.
+  
+  Schedules can accept a set of data that will be passed to the workflow trigger when it is executed. When the userId is not provided, the schedule will be created for the current user specified in the config.
+
+  Examples:
+  
+  - In three days, send a welcome email to a user
+  - In one hour, send a password reset email to a user
+  - In two weeks, send a survey to a user
+  `,
+  parameters: z10.object({
+    workflowKey: z10.string().describe("(string): The key of the workflow to schedule."),
+    userId: z10.string().describe(
+      "(string): The userId of the user to schedule the workflow for."
+    ),
+    scheduledAt: z10.string().describe(
+      "(string): The date and time to schedule the workflow for. Must be in ISO 8601 format."
+    ),
+    data: z10.record(z10.string(), z10.any()).describe("(object): Data to pass to the workflow.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const publicClient = await knockClient.publicApi();
+    return await publicClient.workflows.createSchedules(params.workflowKey, {
+      recipients: [params.userId ?? config.userId],
+      scheduled_at: params.scheduledAt,
+      data: params.data
+    });
+  }
+});
+var workflows = {
+  listWorkflows,
+  triggerWorkflow,
+  createEmailWorkflow,
+  createOneOffWorkflowSchedule
+};
+var permissions11 = {
+  read: ["listWorkflows"],
+  manage: ["createEmailWorkflow", "createOneOffWorkflowSchedule"],
+  trigger: ["triggerWorkflow"]
+};
+
+// src/lib/tools/index.ts
+var tools = {
+  channels,
+  commits,
+  emailLayouts,
+  environments,
+  messages,
+  messageTypes,
+  objects,
+  partials,
+  tenants,
+  users,
+  workflows
+};
+var allTools = {
+  ...channels,
+  ...commits,
+  ...emailLayouts,
+  ...environments,
+  ...messageTypes,
+  ...messages,
+  ...objects,
+  ...partials,
+  ...tenants,
+  ...users,
+  ...workflows
+};
+var toolPermissions = {
+  channels: permissions,
+  commits: permissions2,
+  emailLayouts: permissions3,
+  environments: permissions4,
+  messages: permissions5,
+  messageTypes: permissions6,
+  objects: permissions7,
+  partials: permissions8,
+  tenants: permissions9,
+  users: permissions10,
+  workflows: permissions11
+};
+
+export {
+  tools,
+  allTools,
+  toolPermissions
+};
+//# sourceMappingURL=chunk-RPKDXX4O.js.map