@knocklabs/agent-toolkit 0.2.0 → 0.4.0

package/dist/{chunk-QG5UJT76.js → chunk-WSJ5XINN.js}

@@ -20,7 +20,23 @@ var KnockTool = (args) => {
     ...restOfArgs,
     parameters,
     fullDescription,
-    bindExecute: (knockClient, config) => execute(knockClient, config)
+    bindExecute: (knockClient, config) => async (input) => {
+      try {
+        return await execute(knockClient, config)(input);
+      } catch (error) {
+        console.error(error);
+        if (error instanceof Error) {
+          return {
+            message: `An error occurred with the call to the Knock API: ${error.message}`,
+            error
+          };
+        }
+        return {
+          message: "An unknown error occurred with the call to the Knock API.",
+          error
+        };
+      }
+    }
   };
 };
 
@@ -251,8 +267,271 @@ var permissions5 = {
   read: ["listEnvironments"]
 };
 
-// src/lib/tools/message-types.ts
+// src/lib/tools/guides.ts
+import { z as z6 } from "zod";
+
+// src/lib/tools/shared.ts
 import { z as z5 } from "zod";
+var recipientSchema = z5.union([
+  z5.string().describe("A user ID (string)."),
+  z5.object({ id: z5.string(), collection: z5.string() }).describe("A reference to an object in a collection.")
+]).describe(
+  "A recipient can be a user ID or a reference to an object in a collection."
+);
+var conditionSchema = z5.object({
+  operator: z5.enum([
+    "equal_to",
+    "not_equal_to",
+    "greater_than",
+    "less_than",
+    "greater_than_or_equal_to",
+    "less_than_or_equal_to",
+    "contains",
+    "not_contains",
+    "contains_all",
+    "empty",
+    "not_empty"
+  ]).describe("(string): The operator to apply to the argument."),
+  value: z5.any().describe("(any): The value of the condition."),
+  argument: z5.string().optional().describe(
+    "(string): The argument of the condition. Can be empty when using empty or not_empty operators."
+  )
+}).describe("(object): A condition.");
+
+// src/lib/tools/guides.ts
+function serializeGuide(guide) {
+  return {
+    key: guide.key,
+    name: guide.name,
+    description: guide.description,
+    type: guide.type,
+    active: guide.active,
+    steps: (guide.steps ?? []).map((step) => ({
+      ref: step.ref,
+      name: step.name,
+      schemaKey: step.schema_key,
+      schemaVariantKey: step.schema_variant_key,
+      schemaContent: step.values
+    }))
+  };
+}
+var listGuides = KnockTool({
+  method: "list_guides",
+  name: "List guides",
+  description: `
+  List all guides available for the given environment. Returns structural information about the guides, including the key, name, description, type, and status.
+
+  Use this tool when you need to understand which guides are available in the environment.
+  `,
+  parameters: z6.object({
+    environment: z6.string().optional().describe(
+      "(string): The environment to list guides for. Defaults to `development`."
+    ),
+    page_size: z6.number().optional().describe("(number): The number of guides to return per page."),
+    after: z6.string().optional().describe("(string): The cursor to use for pagination.")
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const allGuides = [];
+    const listParams = {
+      environment: params.environment ?? config.environment ?? "development",
+      page_size: params.page_size,
+      after: params.after
+    };
+    for await (const guide of knockClient.guides.list(listParams)) {
+      allGuides.push(serializeGuide(guide));
+    }
+    return allGuides;
+  }
+});
+var getGuide = KnockTool({
+  method: "get_guide",
+  name: "Get guide",
+  description: `
+  Get a guide by its key. Returns structural information about the guide, including the key, name, description, type, and status.
+
+  Use this tool when you need to retrieve information about a specific guide.
+  `,
+  parameters: z6.object({
+    environment: z6.string().optional().describe(
+      "(string): The environment to get the guide for. Defaults to `development`."
+    ),
+    guideKey: z6.string().describe("(string): The key of the guide to get."),
+    hide_uncommitted_changes: z6.boolean().optional().describe(
+      "(boolean): Whether to hide uncommitted changes and return only published version."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const guide = await knockClient.guides.retrieve(params.guideKey, {
+      environment: params.environment ?? config.environment ?? "development",
+      hide_uncommitted_changes: params.hide_uncommitted_changes
+    });
+    return serializeGuide(guide);
+  }
+});
+var createOrUpdateGuide = KnockTool({
+  method: "upsert_guide",
+  name: "Upsert guide",
+  description: `
+  Create or update a guide. A guide defines an in-app guide that can be displayed to users based on priority and other conditions.
+
+  Use this tool when you need to create a new guide or update an existing one. The guide will be created with the specified configuration.
+
+  Note: This endpoint only operates on guides in the "development" environment.
+
+  ## Guide step schema
+
+  When working with guide steps, you must use a \`schemaKey\` and \`schemaVariantKey\` to reference the message type schema that the step's content conforms to. You can use the \`list_message_types\` tool to get a list of available message types and the available variants for that message type.
+
+  You **must** supply a \`schemaContent\` that sets the content for each of the fields in the \`fields\` object inside of the message type schema variant you select.
+  
+  For example, if you have a message type schema with a \`fields\` object that looks like this:
+
+  \`\`\`json
+  {
+    "fields": {
+      "title": {
+        "type": "string",
+        "required": true
+      }
+    }
+  }
+  \`\`\`
+
+  You would need to supply a \`schemaContent\` that looks like this:
+
+  \`\`\`json
+  {
+    "title": "Hello, world!"
+  }
+  \`\`\`
+
+  ### Guide targeting
+
+  By default, a guide will target all users. If you want to target users with specific attributes, you can use \`targetPropertyConditions\` to describe the targeting conditions.
+
+  When using targeting conditions, you can use the following properties:
+
+  - \`recipient\`: Use a property on the recipient
+  - \`data\`: Use data coming from the application
+  - \`tenant\`: Use a property on the tenant
+
+  For example, if you want to target users with the email \`john.doe@example.com\`, you would supply the following targeting conditions:
+
+  \`\`\`json
+  [
+    { "operator": "equal_to", "value": "john.doe@example.com", "argument": "recipient.email" }
+  ]
+  \`\`\`
+
+  ### Activation location rules
+
+  You can supply a list of activation location rules to describe where in your application the guide should be shown. Each activation rule is a directive that describes whether the guide should be shown or hidden based on the pathname of the page.
+
+  For example, if you want to show the guide on all pages except for the \`admin\` path, you would supply the following activation location rules:
+
+  \`\`\`json
+  [
+    { "directive": "allow", "pathname": "*" },
+    { "directive": "block", "pathname": "/admin" }
+  ]
+  \`\`\`
+  `,
+  parameters: z6.object({
+    environment: z6.string().optional().describe(
+      "(string): The environment to upsert the guide for. Defaults to `development`."
+    ),
+    guideKey: z6.string().describe(
+      "(string): The key of the guide to upsert. Must be at minimum 3 characters and at maximum 255 characters in length. Must be in the format of ^[a-z0-9_-]+$."
+    ),
+    name: z6.string().describe(
+      "(string): A name for the guide. Must be at maximum 255 characters in length."
+    ),
+    channelKey: z6.string().optional().describe(
+      "(string): The key of the channel in which the guide exists. Defaults to `knock-guide`."
+    ).default("knock-guide"),
+    description: z6.string().optional().describe(
+      "(string): An arbitrary string attached to a guide object. Maximum of 280 characters allowed."
+    ),
+    step: z6.object({
+      name: z6.string().describe("(string): The name of the step.").optional().default("Default"),
+      ref: z6.string().describe("(string): The unique identifier of the step.").optional().default("default"),
+      schemaKey: z6.string().describe(
+        "(string): The key of the schema that the step's content conforms to."
+      ),
+      schemaVariantKey: z6.string().describe(
+        "(string): The key of the schema variant that the step's content conforms to."
+      ).optional().default("default"),
+      schemaContent: z6.record(z6.string(), z6.any()).describe(
+        "(object): A map of values that make up the step's content. Each value must conform to its respective template schema field settings."
+      )
+    }).describe("(object): The guide step to upsert."),
+    targetPropertyConditions: z6.array(conditionSchema).describe(
+      "(array): A list of property conditions that describe the target audience for the guide. Conditions are joined as AND operations."
+    ),
+    activationLocationRules: z6.array(
+      z6.object({
+        directive: z6.enum(["allow", "block"]).describe(
+          "(string): The directive to apply to the activation location rule (allow or block)."
+        ),
+        pathname: z6.string().describe(
+          "(string): The pathname to target. Should correspond to a URI in your application."
+        )
+      })
+    ).describe(
+      "(array): A list of activation location rules that describe where in your application the guide should be shown."
+    )
+  }),
+  execute: (knockClient, config) => async (params) => {
+    const messageType = await knockClient.messageTypes.retrieve(
+      params.step.schemaKey,
+      {
+        environment: params.environment ?? config.environment ?? "development"
+      }
+    );
+    const schemaVariant = messageType.variants.find(
+      (variant) => variant.key === params.step.schemaVariantKey
+    );
+    if (!schemaVariant) {
+      throw new Error(
+        `Schema variant ${params.step.schemaVariantKey} not found in message type ${messageType.key}`
+      );
+    }
+    const result = await knockClient.guides.upsert(params.guideKey, {
+      environment: params.environment ?? config.environment ?? "development",
+      guide: {
+        name: params.name,
+        description: params.description,
+        channel_key: params.channelKey ?? "knock-guide",
+        steps: [
+          {
+            ref: params.step.ref ?? "default",
+            schema_key: messageType.key,
+            schema_semver: messageType.semver,
+            schema_variant_key: schemaVariant.key,
+            values: params.step.schemaContent
+          }
+        ],
+        target_property_conditions: {
+          all: params.targetPropertyConditions
+        },
+        activation_location_rules: params.activationLocationRules
+      }
+    });
+    return serializeGuide(result.guide);
+  }
+});
+var guides = {
+  listGuides,
+  getGuide,
+  createOrUpdateGuide
+};
+var permissions6 = {
+  read: ["listGuides", "getGuide"],
+  manage: ["createOrUpdateGuide"]
+};
+
+// src/lib/tools/message-types.ts
+import { z as z7 } from "zod";
 function serializeMessageTypeResponse(messageType) {
   return {
     key: messageType.key,
@@ -265,8 +544,8 @@ 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().optional().describe(
+  parameters: z7.object({
+    environment: z7.string().optional().describe(
       "(string): The environment to list message types for. Defaults to `development`."
     )
   }),
@@ -328,29 +607,29 @@ var createOrUpdateMessageType = KnockTool({
   }
   </example>
   `,
-  parameters: z5.object({
-    environment: z5.string().optional().describe(
+  parameters: z7.object({
+    environment: z7.string().optional().describe(
       "(string): The environment to create or update the message type in. Defaults to `development`."
     ),
-    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(
+    messageTypeKey: z7.string().describe("(string): The key of the message type to create or update."),
+    name: z7.string().describe("(string): The name of the message type."),
+    description: z7.string().optional().describe("(string): The description of the message type."),
+    preview: z7.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(
+    variants: z7.array(
+      z7.object({
+        key: z7.string().describe("(string): The key of the variant."),
+        name: z7.string().describe("(string): The name of the variant."),
+        description: z7.string().optional().describe("(string): The description of the variant."),
+        fields: z7.array(
+          z7.object({
+            key: z7.string().describe("(string): The key of the field."),
+            type: z7.string().describe(
               "(string): The type of the field. One of `text`, `textarea`, `button`, `markdown`, `select`, `multi_select`, `image`."
             ),
-            label: z5.string().describe("(string): The label of the field."),
-            settings: z5.object({}).optional().describe("(object): The settings of the field.")
+            label: z7.string().describe("(string): The label of the field."),
+            settings: z7.object({}).optional().describe("(object): The settings of the field.")
           })
         ).describe("(array): The fields of the variant.")
       })
@@ -372,24 +651,24 @@ var messageTypes = {
   listMessageTypes,
   createOrUpdateMessageType
 };
-var permissions6 = {
+var permissions7 = {
   read: ["listMessageTypes"],
   manage: ["createOrUpdateMessageType"]
 };
 
 // src/lib/tools/messages.ts
-import { z as z6 } from "zod";
+import { z as z8 } 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: z6.object({
-    environment: z6.string().optional().describe(
+  parameters: z8.object({
+    environment: z8.string().optional().describe(
       "(string): The environment to retrieve the message from. Defaults to `development`."
     ),
-    messageId: z6.string().describe("(string): The messageId of the message to retrieve.")
+    messageId: z8.string().describe("(string): The messageId of the message to retrieve.")
   }),
   execute: (knockClient) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -399,21 +678,21 @@ var getMessageContent = KnockTool({
 var messages = {
   getMessageContent
 };
-var permissions7 = {
+var permissions8 = {
   read: ["getMessageContent"]
 };
 
 // src/lib/tools/objects.ts
-import { z as z7 } from "zod";
+import { z as z9 } 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: z7.object({
-    environment: z7.string().optional().describe(
+  parameters: z9.object({
+    environment: z9.string().optional().describe(
       "(string): The environment to list objects from. Defaults to `development`."
     ),
-    collection: z7.string().describe("(string): The collection to list objects from.")
+    collection: z9.string().describe("(string): The collection to list objects from.")
   }),
   execute: (knockClient, _config) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -424,12 +703,12 @@ 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: z7.object({
-    environment: z7.string().optional().describe(
+  parameters: z9.object({
+    environment: z9.string().optional().describe(
       "(string): The environment to get the object from. Defaults to `development`."
     ),
-    collection: z7.string().describe("(string): The collection to get the object from."),
-    objectId: z7.string().describe("(string): The ID of the object to get.")
+    collection: z9.string().describe("(string): The collection to get the object from."),
+    objectId: z9.string().describe("(string): The ID of the object to get.")
   }),
   execute: (knockClient, _config) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -442,13 +721,13 @@ var createOrUpdateObject = KnockTool({
   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: z7.object({
-    environment: z7.string().optional().describe(
+  parameters: z9.object({
+    environment: z9.string().optional().describe(
       "(string): The environment to create or update the object in. Defaults to `development`."
     ),
-    collection: z7.string().describe("(string): The collection to create or update the object in."),
-    objectId: z7.string().describe("(string): The ID of the object to create or update."),
-    properties: z7.record(z7.string(), z7.any()).optional().describe("(object): The properties to set on the object.")
+    collection: z9.string().describe("(string): The collection to create or update the object in."),
+    objectId: z9.string().describe("(string): The ID of the object to create or update."),
+    properties: z9.record(z9.string(), z9.any()).optional().describe("(object): The properties to set on the object.")
   }),
   execute: (knockClient, _config) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -469,13 +748,13 @@ var subscribeUsersToObject = KnockTool({
 
   Before using this tool, you should create the object in the collection using the createOrUpdateObject tool.
   `,
-  parameters: z7.object({
-    environment: z7.string().optional().describe(
+  parameters: z9.object({
+    environment: z9.string().optional().describe(
       "(string): The environment to subscribe the user to. Defaults to `development`."
     ),
-    collection: z7.string().describe("(string): The collection to subscribe the user to."),
-    objectId: z7.string().describe("(string): The ID of the object to subscribe the user to."),
-    userIds: z7.array(z7.string()).describe(
+    collection: z9.string().describe("(string): The collection to subscribe the user to."),
+    objectId: z9.string().describe("(string): The ID of the object to subscribe the user to."),
+    userIds: z9.array(z9.string()).describe(
       "(array): The IDs of the users to subscribe to the object. If not provided, the current user will be subscribed."
     )
   }),
@@ -496,13 +775,13 @@ var unsubscribeUsersFromObject = KnockTool({
   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: z7.object({
-    environment: z7.string().optional().describe(
+  parameters: z9.object({
+    environment: z9.string().optional().describe(
       "(string): The environment to unsubscribe the user from. Defaults to `development`."
     ),
-    collection: z7.string().describe("(string): The collection to unsubscribe the user from."),
-    objectId: z7.string().describe("(string): The ID of the object to unsubscribe the user from."),
-    userIds: z7.array(z7.string()).describe(
+    collection: z9.string().describe("(string): The collection to unsubscribe the user from."),
+    objectId: z9.string().describe("(string): The ID of the object to unsubscribe the user from."),
+    userIds: z9.array(z9.string()).describe(
       "(array): The IDs of the users to unsubscribe from the object."
     )
   }),
@@ -524,7 +803,7 @@ var objects = {
   subscribeUsersToObject,
   unsubscribeUsersFromObject
 };
-var permissions8 = {
+var permissions9 = {
   read: ["listObjects", "getObject"],
   manage: [
     "createOrUpdateObject",
@@ -534,7 +813,7 @@ var permissions8 = {
 };
 
 // src/lib/tools/partials.ts
-import { z as z8 } from "zod";
+import { z as z10 } from "zod";
 function serializePartial(partial) {
   return {
     key: partial.key,
@@ -549,8 +828,8 @@ var listPartials = KnockTool({
   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: z8.object({
-    environment: z8.string().optional().describe(
+  parameters: z10.object({
+    environment: z10.string().optional().describe(
       "(string): The environment to list partials for. Defaults to `development`."
     )
   }),
@@ -570,11 +849,11 @@ var getPartial = KnockTool({
   description: `
   Get a partial by its key. Use this tool when you need to know if a specific partial exists by key.
   `,
-  parameters: z8.object({
-    environment: z8.string().optional().describe(
+  parameters: z10.object({
+    environment: z10.string().optional().describe(
       "(string): The environment to get the partial for. Defaults to `development`."
     ),
-    key: z8.string().describe("(string): The key of the partial to get.")
+    key: z10.string().describe("(string): The key of the partial to get.")
   }),
   execute: (knockClient, config) => async (params) => {
     const partial = await knockClient.partials.retrieve(params.key, {
@@ -604,15 +883,15 @@ var createOrUpdatePartial = KnockTool({
 
   Changes to a partial MUST be committed before they can be used in a template.
   `,
-  parameters: z8.object({
-    environment: z8.string().optional().describe(
+  parameters: z10.object({
+    environment: z10.string().optional().describe(
       "(string): The environment to upsert the partial for. Defaults to `development`."
     ),
-    key: z8.string().describe("(string): The key of the partial to upsert."),
-    name: z8.string().describe("(string): The name of the partial."),
-    description: z8.string().optional().describe("(string): The description of the partial."),
-    content: z8.string().describe("(string): The content of the partial."),
-    type: z8.enum(["html", "text", "json", "markdown"]).describe("(string): The type of the partial.")
+    key: z10.string().describe("(string): The key of the partial to upsert."),
+    name: z10.string().describe("(string): The name of the partial."),
+    description: z10.string().optional().describe("(string): The description of the partial."),
+    content: z10.string().describe("(string): The content of the partial."),
+    type: z10.enum(["html", "text", "json", "markdown"]).describe("(string): The type of the partial.")
   }),
   execute: (knockClient, config) => async (params) => {
     const partial = await knockClient.partials.upsert(params.key, {
@@ -632,13 +911,13 @@ var partials = {
   listPartials,
   createOrUpdatePartial
 };
-var permissions9 = {
+var permissions10 = {
   read: ["getPartial", "listPartials"],
   manage: ["createOrUpdatePartial"]
 };
 
 // src/lib/tools/tenants.ts
-import { z as z9 } from "zod";
+import { z as z11 } from "zod";
 var getTenant = KnockTool({
   method: "get_tenant",
   name: "Get tenant",
@@ -647,11 +926,11 @@ var getTenant = KnockTool({
   
   Use this tool when you need to lookup the information about a tenant, including name, and if there are any custom properties set.
   `,
-  parameters: z9.object({
-    environment: z9.string().optional().describe(
+  parameters: z11.object({
+    environment: z11.string().optional().describe(
       "(string): The environment to retrieve the tenant from. Defaults to `development`."
     ),
-    tenantId: z9.string().describe("(string): The ID of the tenant to retrieve.")
+    tenantId: z11.string().describe("(string): The ID of the tenant to retrieve.")
   }),
   execute: (knockClient) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -666,8 +945,8 @@ var listTenants = KnockTool({
   
   Use this tool when you need to list all tenants in an environment.
   `,
-  parameters: z9.object({
-    environment: z9.string().optional().describe(
+  parameters: z11.object({
+    environment: z11.string().optional().describe(
       "(string): The environment to retrieve the tenants from. Defaults to `development`."
     )
   }),
@@ -684,13 +963,13 @@ var createOrUpdateTenant = KnockTool({
   
   Use this tool when you need to create a new tenant, or update an existing tenant's properties.
   `,
-  parameters: z9.object({
-    environment: z9.string().optional().describe(
+  parameters: z11.object({
+    environment: z11.string().optional().describe(
       "(string): The environment to set the tenant in. Defaults to `development`."
     ),
-    tenantId: z9.string().describe("(string): The ID of the tenant to update."),
-    name: z9.string().optional().describe("(string): The name of the tenant."),
-    properties: z9.record(z9.string(), z9.any()).optional().describe("(object): The properties to set on the tenant.")
+    tenantId: z11.string().describe("(string): The ID of the tenant to update."),
+    name: z11.string().optional().describe("(string): The name of the tenant."),
+    properties: z11.record(z11.string(), z11.any()).optional().describe("(object): The properties to set on the tenant.")
   }),
   execute: (knockClient) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -705,28 +984,17 @@ var tenants = {
   listTenants,
   createOrUpdateTenant
 };
-var permissions10 = {
+var permissions11 = {
   read: ["getTenant", "listTenants"],
   manage: ["createOrUpdateTenant"]
 };
 
 // src/lib/tools/users.ts
-import { z as z12 } from "zod";
+import { z as z13 } from "zod";
 
 // src/lib/tools/workflows-as-tools.ts
 import jsonSchemaToZod from "json-schema-to-zod";
-import { z as z11 } from "zod";
-
-// src/lib/tools/shared.ts
-import { z as z10 } from "zod";
-var recipientSchema = z10.union([
-  z10.string().describe("A user ID (string)."),
-  z10.object({ id: z10.string(), collection: z10.string() }).describe("A reference to an object in a collection.")
-]).describe(
-  "A recipient can be a user ID or a reference to an object in a collection."
-);
-
-// src/lib/tools/workflows-as-tools.ts
+import { z as z12 } from "zod";
 function workflowAsTool(workflow) {
   return KnockTool({
     method: `trigger_${workflow.key.replace("-", "_")}_workflow`,
@@ -736,18 +1004,18 @@ function workflowAsTool(workflow) {
     ${workflow.description ? `Additional information to consider on when to use this tool: ${workflow.description}` : ""}
     
     Returns the workflow run ID, which can be used to lookup messages produced by the workflow.`,
-    parameters: z11.object({
-      environment: z11.string().optional(),
+    parameters: z12.object({
+      environment: z12.string().optional(),
       actor: recipientSchema.optional().describe("An optional actor to trigger the workflow with."),
-      recipients: z11.array(recipientSchema).describe(
+      recipients: z12.array(recipientSchema).describe(
         "An optional array of recipients to trigger the workflow with."
       ).optional(),
       // Here we dynamically generate a zod schema from the workflow's `trigger_data_json_schema`
       // This allows us to validate the data passed to the workflow
       data: workflow.trigger_data_json_schema ? eval(jsonSchemaToZod(workflow.trigger_data_json_schema)).describe(
         "The data to pass to the workflow."
-      ) : z11.record(z11.string(), z11.any()).optional().describe("The data to pass to the workflow."),
-      tenant: z11.string().optional().describe("The tenant ID to trigger the workflow for.")
+      ) : z12.record(z12.string(), z12.any()).optional().describe("The data to pass to the workflow."),
+      tenant: z12.string().optional().describe("The tenant ID to trigger the workflow for.")
     }),
     execute: (knockClient, config) => async (params) => {
       const publicClient = await knockClient.publicApi(params.environment);
@@ -874,11 +1142,11 @@ var getUser = KnockTool({
 
    If the userId is not provided, it will use the userId from the config.
    `,
-  parameters: z12.object({
-    environment: z12.string().optional().describe(
+  parameters: z13.object({
+    environment: z13.string().optional().describe(
       "(string): The environment to retrieve the user from. Defaults to `development`."
     ),
-    userId: z12.string().optional().describe("(string): The userId of the User to retrieve.")
+    userId: z13.string().optional().describe("(string): The userId of the User to retrieve.")
   }),
   execute: (knockClient, config) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -896,15 +1164,15 @@ var createOrUpdateUser = KnockTool({
 
   If the userId is not provided, it will use the userId from the config.
   `,
-  parameters: z12.object({
-    environment: z12.string().optional().describe(
+  parameters: z13.object({
+    environment: z13.string().optional().describe(
       "(string): The environment to create or update the user in. Defaults to `development`."
     ),
-    userId: z12.string().optional().describe("(string): The userId of the User to update."),
-    email: z12.string().optional().describe("(string): The email of the User to update."),
-    name: z12.string().optional().describe("(string): The name of the User to update."),
-    phoneNumber: z12.string().optional().describe("(string): The phone number of the User to update."),
-    customProperties: z12.record(z12.string(), z12.any()).optional().describe(
+    userId: z13.string().optional().describe("(string): The userId of the User to update."),
+    email: z13.string().optional().describe("(string): The email of the User to update."),
+    name: z13.string().optional().describe("(string): The name of the User to update."),
+    phoneNumber: z13.string().optional().describe("(string): The phone number of the User to update."),
+    customProperties: z13.record(z13.string(), z13.any()).optional().describe(
       "(object): A dictionary of custom properties to update for the User."
     )
   }),
@@ -930,14 +1198,14 @@ var getUserPreferences = KnockTool({
 
   If the userId is not provided, it will use the userId from the config. 
   `,
-  parameters: z12.object({
-    environment: z12.string().optional().describe(
+  parameters: z13.object({
+    environment: z13.string().optional().describe(
       "(string): The environment to retrieve the user preferences from. Defaults to `development`."
     ),
-    userId: z12.string().optional().describe(
+    userId: z13.string().optional().describe(
       "(string): The userId of the User to retrieve Preferences for."
     ),
-    preferenceSetId: z12.string().optional().describe(
+    preferenceSetId: z13.string().optional().describe(
       "(string): The preferenceSetId of the User to retrieve preferences for. Defaults to `default`."
     )
   }),
@@ -986,18 +1254,18 @@ var setUserPreferences = KnockTool({
     </example>
   </examples>
   `,
-  parameters: z12.object({
-    environment: z12.string().optional().describe(
+  parameters: z13.object({
+    environment: z13.string().optional().describe(
       "(string): The environment to set the user preferences in. Defaults to `development`."
     ),
-    userId: z12.string().optional().describe("(string): The userId of the User to update preferences for."),
-    workflows: z12.record(z12.string(), z12.any()).optional().describe(
+    userId: z13.string().optional().describe("(string): The userId of the User to update preferences for."),
+    workflows: z13.record(z13.string(), z13.any()).optional().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: z12.record(z12.string(), z12.any()).optional().describe(
+    categories: z13.record(z13.string(), z13.any()).optional().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: z12.record(z12.string(), z12.boolean()).optional().describe(
+    channel_types: z13.record(z13.string(), z13.boolean()).optional().describe(
       "(object): The channel types to update where the key is the channel type, and the value of the object is a boolean value."
     )
   }),
@@ -1038,12 +1306,12 @@ var getUserMessages = KnockTool({
 
   If the userId is not provided, it will use the userId from the config.
   `,
-  parameters: z12.object({
-    environment: z12.string().optional().describe(
+  parameters: z13.object({
+    environment: z13.string().optional().describe(
       "(string): The environment to retrieve the user messages from. Defaults to `development`."
     ),
-    userId: z12.string().optional().describe("(string): The userId of the User to retrieve messages for."),
-    workflowRunId: z12.string().optional().describe(
+    userId: z13.string().optional().describe("(string): The userId of the User to retrieve messages for."),
+    workflowRunId: z13.string().optional().describe(
       "(string): The workflowRunId of the User to retrieve. Use this when you want to retrieve messages sent from a workflow trigger."
     )
   }),
@@ -1065,16 +1333,16 @@ var users = {
   setUserPreferences,
   getUserMessages
 };
-var permissions11 = {
+var permissions12 = {
   read: ["getUser", "getUserMessages", "getUserPreferences"],
   manage: ["createOrUpdateUser", "setUserPreferences"]
 };
 
 // src/lib/tools/workflows.ts
-import { z as z14 } from "zod";
+import { z as z15 } from "zod";
 
 // src/lib/tools/workflow-steps.ts
-import { z as z13 } from "zod";
+import { z as z14 } from "zod";
 function generateStepRef(stepType) {
   const randomString = Math.random().toString(36).substring(2, 7).toUpperCase();
   return `${stepType}_${randomString}`;
@@ -1136,39 +1404,39 @@ var SHARED_PROMPTS = {
   </example>
   `
 };
-var contentBlockSchema = z13.union([
-  z13.object({
-    type: z13.literal("markdown"),
-    content: z13.string().describe("(string): The markdown content of the block.")
+var contentBlockSchema = z14.union([
+  z14.object({
+    type: z14.literal("markdown"),
+    content: z14.string().describe("(string): The markdown content of the block.")
   }),
-  z13.object({
-    type: z13.literal("html"),
-    content: z13.string().describe("(string): The HTML content of the block.")
+  z14.object({
+    type: z14.literal("html"),
+    content: z14.string().describe("(string): The HTML content of the block.")
   }),
-  z13.object({
-    type: z13.literal("image"),
-    url: z13.string().describe("(string): The URL of the image.")
+  z14.object({
+    type: z14.literal("image"),
+    url: z14.string().describe("(string): The URL of the image.")
   }),
-  z13.object({
-    type: z13.literal("button_set"),
-    buttons: z13.array(
-      z13.object({
-        label: z13.string().describe("(string): The label of the button."),
-        action: z13.string().describe("(string): The action of the button."),
-        variant: z13.enum(["solid", "outline"]).default("solid").describe(
+  z14.object({
+    type: z14.literal("button_set"),
+    buttons: z14.array(
+      z14.object({
+        label: z14.string().describe("(string): The label of the button."),
+        action: z14.string().describe("(string): The action of the button."),
+        variant: z14.enum(["solid", "outline"]).default("solid").describe(
           "(enum): The variant of the button. Defaults to `solid`."
         )
       })
     ).describe("(array): The buttons for the button set.")
   }),
-  z13.object({
-    type: z13.literal("divider")
+  z14.object({
+    type: z14.literal("divider")
   }),
-  z13.object({
-    type: z13.literal("partial"),
-    key: z13.string().describe("(string): The key of the partial to use."),
-    name: z13.string().describe("(string): The name of the partial."),
-    attrs: z13.record(z13.string(), z13.string()).describe(
+  z14.object({
+    type: z14.literal("partial"),
+    key: z14.string().describe("(string): The key of the partial to use."),
+    name: z14.string().describe("(string): The name of the partial."),
+    attrs: z14.record(z14.string(), z14.string()).describe(
       "(object): The attributes for the partial. ALWAYS supply an empty object when you don't know which params are required."
     )
   })
@@ -1278,19 +1546,19 @@ Hello, {{ recipient.name }}."
 
   Unless asked otherwise, you should write content for the email in a concise and formal writing style. Do NOT use complex language or try to over explain. Keep the subject line to 8 words or less.
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().optional().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().optional().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    htmlContent: z13.string().describe(
+    htmlContent: z14.string().optional().describe(
       "(string): The HTML content of the email template. Use this when not setting blocks."
     ),
-    blocks: z13.array(contentBlockSchema).describe(
+    blocks: z14.array(contentBlockSchema).optional().describe(
       "(array): The blocks for the email step. Use this when you don't need to set HTML directly."
     ),
-    layoutKey: z13.string().describe("(string): The key of the layout to use for the email step."),
-    subject: z13.string().describe("(string): The subject of the email step.")
+    layoutKey: z14.string().describe("(string): The key of the layout to use for the email step."),
+    subject: z14.string().describe("(string): The subject of the email step.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1334,12 +1602,12 @@ var createOrUpdateSmsStepInWorkflow = KnockTool({
 
   ${SHARED_PROMPTS.liquid}
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().optional().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().optional().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    content: z13.string().describe("(string): The content of the SMS.")
+    content: z14.string().describe("(string): The content of the SMS.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1380,13 +1648,13 @@ var createOrUpdatePushStepInWorkflow = KnockTool({
 
   Be terse in your writing as this is a push notification and should be direct and to the point.
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().optional().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().optional().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    title: z13.string().describe("(string): The title of the push notification."),
-    content: z13.string().describe("(string): The content (body) of the push notification.")
+    title: z14.string().describe("(string): The title of the push notification."),
+    content: z14.string().describe("(string): The content (body) of the push notification.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1426,15 +1694,15 @@ var createOrUpdateInAppFeedStepInWorkflow = KnockTool({
 
   ${SHARED_PROMPTS.liquid}
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().optional().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().optional().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    actionUrl: z13.string().describe(
+    actionUrl: z14.string().describe(
       "(string): The URL to navigate to when the in app feed is tapped."
     ),
-    body: z13.string().describe("(string): The markdown content of the in app feed.")
+    body: z14.string().describe("(string): The markdown content of the in app feed.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1474,12 +1742,12 @@ var createOrUpdateChatStepInWorkflow = KnockTool({
 
   ${SHARED_PROMPTS.liquid}
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    body: z13.string().describe("(string): The markdown content of the notification.")
+    body: z14.string().describe("(string): The markdown content of the notification.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1525,13 +1793,13 @@ var createOrUpdateDelayStepInWorkflow = KnockTool({
   }
   </example>
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().optional().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().optional().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    delayValue: z13.number().describe("(number): The value of the delay."),
-    delayUnit: z13.enum(["seconds", "minutes", "hours", "days"]).describe("(enum): The unit of the delay.")
+    delayValue: z14.number().describe("(number): The value of the delay."),
+    delayUnit: z14.enum(["seconds", "minutes", "hours", "days"]).describe("(enum): The unit of the delay.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1584,14 +1852,14 @@ var createOrUpdateBatchStepInWorkflow = KnockTool({
   }
   </example>
   `,
-  parameters: z13.object({
-    workflowKey: z13.string().describe("(string): The key of the workflow to add the step to."),
-    stepRef: z13.string().optional().describe(
+  parameters: z14.object({
+    workflowKey: z14.string().describe("(string): The key of the workflow to add the step to."),
+    stepRef: z14.string().optional().describe(
       "(string): The reference of the step to update. If not provided, a new step will be created."
     ),
-    batchWindow: z13.object({
-      value: z13.number().describe("(number): The value of the batch window."),
-      unit: z13.enum(["seconds", "minutes", "hours", "days"]).describe("(enum): The unit of the batch window.")
+    batchWindow: z14.object({
+      value: z14.number().describe("(number): The value of the batch window."),
+      unit: z14.enum(["seconds", "minutes", "hours", "days"]).describe("(enum): The unit of the batch window.")
     })
   }),
   execute: (knockClient, config) => async (params) => {
@@ -1656,8 +1924,8 @@ var listWorkflows = KnockTool({
 
   Use this tool when you need to understand which workflows are available to be called.
   `,
-  parameters: z14.object({
-    environment: z14.string().optional().describe(
+  parameters: z15.object({
+    environment: z15.string().optional().describe(
       "(string): The environment to list workflows for. Defaults to `development`."
     )
   }),
@@ -1678,11 +1946,11 @@ var getWorkflow = KnockTool({
   description: `
   Get a workflow by key. Returns structural information about the workflow, including the key, name, description, and categories.
   `,
-  parameters: z14.object({
-    environment: z14.string().optional().describe(
+  parameters: z15.object({
+    environment: z15.string().optional().describe(
       "(string): The environment to get the workflow for. Defaults to `development`."
     ),
-    workflowKey: z14.string().describe("(string): The key of the workflow to get.")
+    workflowKey: z15.string().describe("(string): The key of the workflow to get.")
   }),
   execute: (knockClient, config) => async (params) => {
     const workflow2 = await knockClient.workflows.retrieve(params.workflowKey, {
@@ -1703,16 +1971,16 @@ var triggerWorkflow = KnockTool({
 
   Returns the workflow run ID, which can be used to lookup messages produced by the workflow.
   `,
-  parameters: z14.object({
-    environment: z14.string().optional().describe(
+  parameters: z15.object({
+    environment: z15.string().optional().describe(
       "(string): The environment to trigger the workflow in. Defaults to `development`."
     ),
-    workflowKey: z14.string().describe("(string): The key of the workflow to trigger."),
-    recipients: z14.array(z14.string()).optional().describe(
+    workflowKey: z15.string().describe("(string): The key of the workflow to trigger."),
+    recipients: z15.array(z15.string()).optional().describe(
       "(array): The recipients to trigger the workflow for. This is an array of user IDs."
     ),
-    data: z14.record(z14.string(), z14.any()).optional().describe("(object): Data to pass to the workflow."),
-    tenant: z14.record(z14.string(), z14.any()).optional().describe(
+    data: z15.record(z15.string(), z15.any()).optional().describe("(object): Data to pass to the workflow."),
+    tenant: z15.record(z15.string(), z15.any()).optional().describe(
       "(object): The tenant to trigger the workflow for. Must contain an id if being sent."
     )
   }),
@@ -1732,16 +2000,16 @@ var createWorkflow = KnockTool({
   description: `
   Create a new workflow, which is used to control the flow of notifications. Use this tool when you're asked to create a new workflow, or you need to create a new workflow before adding a step to it.
   `,
-  parameters: z14.object({
-    environment: z14.string().optional().describe(
+  parameters: z15.object({
+    environment: z15.string().optional().describe(
       "(string): The environment to create the workflow in. Defaults to `development`."
     ),
-    workflowKey: z14.string().describe(
+    workflowKey: z15.string().describe(
       "(string): The key of the workflow to create. Only use a kebab-case string with no spaces or special characters."
     ),
-    name: z14.string().describe("(string): The name of the workflow."),
-    description: z14.string().describe("(string): The description of the workflow."),
-    categories: z14.array(z14.string()).describe("(array): The categories to add to the workflow.")
+    name: z15.string().describe("(string): The name of the workflow."),
+    description: z15.string().describe("(string): The description of the workflow."),
+    categories: z15.array(z15.string()).describe("(array): The categories to add to the workflow.")
   }),
   execute: (knockClient, config) => async (params) => {
     const result = await knockClient.workflows.upsert(params.workflowKey, {
@@ -1770,18 +2038,18 @@ var createOneOffWorkflowSchedule = KnockTool({
   - In one hour, send a password reset email to a user
   - In two weeks, send a survey to a user
   `,
-  parameters: z14.object({
-    environment: z14.string().optional().describe(
+  parameters: z15.object({
+    environment: z15.string().optional().describe(
       "(string): The environment to create the workflow in. Defaults to `development`."
     ),
-    workflowKey: z14.string().describe("(string): The key of the workflow to schedule."),
-    userId: z14.string().describe(
+    workflowKey: z15.string().describe("(string): The key of the workflow to schedule."),
+    userId: z15.string().describe(
       "(string): The userId of the user to schedule the workflow for."
     ),
-    scheduledAt: z14.string().describe(
+    scheduledAt: z15.string().describe(
       "(string): The date and time to schedule the workflow for. Must be in ISO 8601 format."
     ),
-    data: z14.record(z14.string(), z14.any()).optional().describe("(object): Data to pass to the workflow.")
+    data: z15.record(z15.string(), z15.any()).optional().describe("(object): Data to pass to the workflow.")
   }),
   execute: (knockClient, config) => async (params) => {
     const publicClient = await knockClient.publicApi(params.environment);
@@ -1800,7 +2068,7 @@ var workflows = {
   ...workflowStepTools,
   createOneOffWorkflowSchedule
 };
-var permissions12 = {
+var permissions13 = {
   read: ["listWorkflows", "getWorkflow"],
   manage: [
     "createWorkflow",
@@ -1817,6 +2085,7 @@ var tools = {
   documentation,
   emailLayouts,
   environments,
+  guides,
   messages,
   messageTypes,
   objects,
@@ -1831,6 +2100,7 @@ var allTools = {
   ...documentation,
   ...emailLayouts,
   ...environments,
+  ...guides,
   ...messageTypes,
   ...messages,
   ...objects,
@@ -1845,13 +2115,14 @@ var toolPermissions = {
   documentation: permissions3,
   emailLayouts: permissions4,
   environments: permissions5,
-  messages: permissions7,
-  messageTypes: permissions6,
-  objects: permissions8,
-  partials: permissions9,
-  tenants: permissions10,
-  users: permissions11,
-  workflows: permissions12
+  guides: permissions6,
+  messages: permissions8,
+  messageTypes: permissions7,
+  objects: permissions9,
+  partials: permissions10,
+  tenants: permissions11,
+  users: permissions12,
+  workflows: permissions13
 };
 
 export {
@@ -1862,4 +2133,4 @@ export {
   getToolsByPermissionsInCategories,
   getToolMap
 };
-//# sourceMappingURL=chunk-QG5UJT76.js.map
+//# sourceMappingURL=chunk-WSJ5XINN.js.map