@knocklabs/agent-toolkit 0.1.1 → 0.1.3

package/dist/chunk-PDMA6RIB.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/modelcontextprotocol/index.ts"],"sourcesContent":["import type { KnockTool } from \"../lib/knock-tool.js\";\nimport { allTools } from \"../lib/tools/index.js\";\nimport { KnockMcpServer } from \"./adapter.js\";\nimport { Config } from \"../types.js\";\nimport { KnockClient } from \"../lib/knock-client.js\";\n\ntype CreateKnockMcpServerParams = {\n  /**\n   * Array of Knock tools to enable in the server.\n   */\n  tools?: KnockTool[];\n\n  /**\n   * A Knock client to use for the server.\n   */\n  knockClient: KnockClient;\n\n  /**\n   * The config to use for the server.\n   */\n  config: Config;\n};\n\n/**\n * Creates a Knock MCP Server with the given parameters.\n */\nexport const createKnockMcpServer = async (\n  params: CreateKnockMcpServerParams\n): Promise<KnockMcpServer> => {\n  const { tools, knockClient, config } = params;\n\n  return Promise.resolve(\n    new KnockMcpServer(knockClient, config, tools || Object.values(allTools))\n  );\n};\n"],"mappings":";;;;;;;;AA0BO,IAAM,uBAAuB,OAClC,WAC4B;AAC5B,QAAM,EAAE,OAAO,aAAa,OAAO,IAAI;AAEvC,SAAO,QAAQ;AAAA,IACb,IAAI,eAAe,aAAa,QAAQ,SAAS,OAAO,OAAO,QAAQ,CAAC;AAAA,EAC1E;AACF;","names":[]}

package/dist/chunk-RYMJEH6P.js

@@ -0,0 +1,140 @@
+import {
+  KnockTool
+} from "./chunk-TOBLV65T.js";
+
+// src/lib/tools/objects.ts
+import { z } 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: z.object({
+    collection: z.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: z.object({
+    collection: z.string().describe("(string): The collection to get the object from."),
+    objectId: z.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: z.object({
+    collection: z.string().describe("(string): The collection to create or update the object in."),
+    objectId: z.string().describe("(string): The ID of the object to create or update."),
+    properties: z.record(z.string(), z.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: z.object({
+    collection: z.string().describe("(string): The collection to delete the object from."),
+    objectId: z.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: z.object({
+    collection: z.string().describe("(string): The collection to subscribe the user to."),
+    objectId: z.string().describe("(string): The ID of the object to subscribe the user to."),
+    userIds: z.array(z.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: z.object({
+    collection: z.string().describe("(string): The collection to unsubscribe the user from."),
+    objectId: z.string().describe("(string): The ID of the object to unsubscribe the user from."),
+    userIds: z.array(z.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 permissions = {
+  read: ["listObjects", "getObject"],
+  manage: [
+    "createOrUpdateObject",
+    "deleteObject",
+    "subscribeUsersToObject",
+    "unsubscribeUsersFromObject"
+  ]
+};
+
+export {
+  objects,
+  permissions
+};
+//# sourceMappingURL=chunk-RYMJEH6P.js.map

package/dist/chunk-RYMJEH6P.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/tools/objects.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { KnockTool } from \"../knock-tool.js\";\n\nconst listObjects = KnockTool({\n  method: \"list_objects\",\n  name: \"List objects\",\n  description:\n    \"List all objects in a single collection. Objects are used to model custom collections in Knock that are NOT users or tenants. Use this tool when you need to return a paginated list of objects in a single collection.\",\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to list objects from.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.list(params.collection);\n  },\n});\n\nconst getObject = KnockTool({\n  method: \"get_object\",\n  name: \"Get object\",\n  description:\n    \"Get an object wihin a collection. Returns information about the object including any custom properties. Use this tool when you need to retrieve an object to understand it's properties.\",\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to get the object from.\"),\n    objectId: z.string().describe(\"(string): The ID of the object to get.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.get(params.collection, params.objectId);\n  },\n});\n\nconst createOrUpdateObject = KnockTool({\n  method: \"create_or_update_object\",\n  name: \"Create or update object\",\n  description: `Create or update an object in a specific collection. Objects are used to model custom collections in Knock that are NOT users or tenants. If the object does not exist, it will be created. If the object exists, it will be updated with the provided properties. The update will always perform an upsert operation, so you do not need to provide the full properties each time.\n  \n  Use this tool when you need to create a new object, or update an existing custom-object. Custom objects can be used to subscribe users' to as lists, and also send non-user facing notifications to.`,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to create or update the object in.\"),\n    objectId: z\n      .string()\n      .describe(\"(string): The ID of the object to create or update.\"),\n    properties: z\n      .record(z.string(), z.any())\n      .describe(\"(object): The properties to set on the object.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.set(\n      params.collection,\n      params.objectId,\n      params.properties\n    );\n  },\n});\n\nconst deleteObject = KnockTool({\n  method: \"delete_object\",\n  name: \"Delete object\",\n  description: `Delete an object from a specific collection. Use this tool when you need to remove an object from the system.`,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to delete the object from.\"),\n    objectId: z.string().describe(\"(string): The ID of the object to delete.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    await publicClient.objects.delete(params.collection, params.objectId);\n    return { success: true };\n  },\n});\n\nconst subscribeUsersToObject = KnockTool({\n  method: \"subscribe_users_to_object\",\n  name: \"Subscribe users to object\",\n  description: `\n  Subscribe a list of users to an object in a specific collection. We use this to model lists of users, for pub-sub use cases.\n  \n  Use this tool when you need to subscribe one or more users to an object where you will then trigger workflows for those lists of users to send notifications to.\n\n  Before using this tool, you should create the object in the collection using the createOrUpdateObject tool.\n  `,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to subscribe the user to.\"),\n    objectId: z\n      .string()\n      .describe(\"(string): The ID of the object to subscribe the user to.\"),\n    userIds: z\n      .array(z.string())\n      .describe(\n        \"(array): The IDs of the users to subscribe to the object. If not provided, the current user will be subscribed.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.addSubscriptions(\n      params.collection,\n      params.objectId,\n      {\n        recipients: params.userIds ?? [config.userId],\n      }\n    );\n  },\n});\n\nconst unsubscribeUsersFromObject = KnockTool({\n  method: \"unsubscribe_users_from_object\",\n  name: \"Unsubscribe users from object\",\n  description: `Unsubscribe a list of users from an object in a specific collection. We use this to model lists of users, for pub-sub use cases.\n  \n  Use this tool when you need to unsubscribe one or more users from an object where you will then trigger workflows for those lists of users to send notifications to.`,\n  parameters: z.object({\n    collection: z\n      .string()\n      .describe(\"(string): The collection to unsubscribe the user from.\"),\n    objectId: z\n      .string()\n      .describe(\"(string): The ID of the object to unsubscribe the user from.\"),\n    userIds: z\n      .array(z.string())\n      .describe(\n        \"(array): The IDs of the users to unsubscribe from the object.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const publicClient = await knockClient.publicApi();\n    return await publicClient.objects.deleteSubscriptions(\n      params.collection,\n      params.objectId,\n      {\n        recipients: params.userIds ?? [config.userId],\n      }\n    );\n  },\n});\n\nexport const objects = {\n  listObjects,\n  getObject,\n  createOrUpdateObject,\n  deleteObject,\n  subscribeUsersToObject,\n  unsubscribeUsersFromObject,\n};\n\nexport const permissions = {\n  read: [\"listObjects\", \"getObject\"],\n  manage: [\n    \"createOrUpdateObject\",\n    \"deleteObject\",\n    \"subscribeUsersToObject\",\n    \"unsubscribeUsersFromObject\",\n  ],\n};\n"],"mappings":";;;;;AAAA,SAAS,SAAS;AAGlB,IAAM,cAAc,UAAU;AAAA,EAC5B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aACE;AAAA,EACF,YAAY,EAAE,OAAO;AAAA,IACnB,YAAY,EACT,OAAO,EACP,SAAS,gDAAgD;AAAA,EAC9D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ,KAAK,OAAO,UAAU;AAAA,EAC1D;AACF,CAAC;AAED,IAAM,YAAY,UAAU;AAAA,EAC1B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aACE;AAAA,EACF,YAAY,EAAE,OAAO;AAAA,IACnB,YAAY,EACT,OAAO,EACP,SAAS,kDAAkD;AAAA,IAC9D,UAAU,EAAE,OAAO,EAAE,SAAS,wCAAwC;AAAA,EACxE,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ,IAAI,OAAO,YAAY,OAAO,QAAQ;AAAA,EAC1E;AACF,CAAC;AAED,IAAM,uBAAuB,UAAU;AAAA,EACrC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAY,EAAE,OAAO;AAAA,IACnB,YAAY,EACT,OAAO,EACP,SAAS,6DAA6D;AAAA,IACzE,UAAU,EACP,OAAO,EACP,SAAS,qDAAqD;AAAA,IACjE,YAAY,EACT,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC,EAC1B,SAAS,gDAAgD;AAAA,EAC9D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP,OAAO;AAAA,IACT;AAAA,EACF;AACF,CAAC;AAED,IAAM,eAAe,UAAU;AAAA,EAC7B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA,EACb,YAAY,EAAE,OAAO;AAAA,IACnB,YAAY,EACT,OAAO,EACP,SAAS,qDAAqD;AAAA,IACjE,UAAU,EAAE,OAAO,EAAE,SAAS,2CAA2C;AAAA,EAC3E,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,UAAM,aAAa,QAAQ,OAAO,OAAO,YAAY,OAAO,QAAQ;AACpE,WAAO,EAAE,SAAS,KAAK;AAAA,EACzB;AACF,CAAC;AAED,IAAM,yBAAyB,UAAU;AAAA,EACvC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOb,YAAY,EAAE,OAAO;AAAA,IACnB,YAAY,EACT,OAAO,EACP,SAAS,oDAAoD;AAAA,IAChE,UAAU,EACP,OAAO,EACP,SAAS,0DAA0D;AAAA,IACtE,SAAS,EACN,MAAM,EAAE,OAAO,CAAC,EAChB;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP;AAAA,QACE,YAAY,OAAO,WAAW,CAAC,OAAO,MAAM;AAAA,MAC9C;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAED,IAAM,6BAA6B,UAAU;AAAA,EAC3C,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAY,EAAE,OAAO;AAAA,IACnB,YAAY,EACT,OAAO,EACP,SAAS,wDAAwD;AAAA,IACpE,UAAU,EACP,OAAO,EACP,SAAS,8DAA8D;AAAA,IAC1E,SAAS,EACN,MAAM,EAAE,OAAO,CAAC,EAChB;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,eAAe,MAAM,YAAY,UAAU;AACjD,WAAO,MAAM,aAAa,QAAQ;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP;AAAA,QACE,YAAY,OAAO,WAAW,CAAC,OAAO,MAAM;AAAA,MAC9C;AAAA,IACF;AAAA,EACF;AACF,CAAC;AAEM,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,eAAe,WAAW;AAAA,EACjC,QAAQ;AAAA,IACN;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}

package/dist/chunk-THLK376Y.js

@@ -0,0 +1,191 @@
+import {
+  KnockTool
+} from "./chunk-TOBLV65T.js";
+
+// src/lib/tools/message-types.ts
+import { z } 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: z.object({
+    environment: z.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: z.object({
+    messageTypeKey: z.string().describe("(string): The key of the message type to create or update."),
+    name: z.string().describe("(string): The name of the message type."),
+    description: z.string().optional().describe("(string): The description of the message type."),
+    preview: z.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: z.array(
+      z.object({
+        key: z.string().describe("(string): The key of the variant."),
+        name: z.string().describe("(string): The name of the variant."),
+        description: z.string().optional().describe("(string): The description of the variant."),
+        fields: z.array(
+          z.object({
+            key: z.string().describe("(string): The key of the field."),
+            type: z.string().describe(
+              "(string): The type of the field. One of `text`, `textarea`, `button`, `markdown`, `select`, `multi_select`."
+            ),
+            label: z.string().describe("(string): The label of the field."),
+            settings: z.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 permissions = {
+  read: ["listMessageTypes"],
+  manage: ["createOrUpdateMessageType"]
+};
+
+export {
+  messageTypes,
+  permissions
+};
+//# sourceMappingURL=chunk-THLK376Y.js.map

package/dist/chunk-THLK376Y.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/tools/message-types.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { KnockTool } from \"../knock-tool.js\";\nimport { MessageType } from \"@knocklabs/mgmt/resources/message-types.js\";\n\nconst listMessageTypes = KnockTool({\n  method: \"list_message_types\",\n  name: \"List message types\",\n  description:\n    \"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.\",\n  parameters: z.object({\n    environment: z\n      .string()\n      .describe(\n        \"(string): The environment to list message types for. Defaults to `development`.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    const allMessageTypes: MessageType[] = [];\n    for await (const messageType of knockClient.messageTypes.list({\n      environment: params.environment ?? config.environment ?? \"development\",\n    })) {\n      allMessageTypes.push(messageType);\n    }\n    return allMessageTypes;\n  },\n});\n\nconst createOrUpdateMessageType = KnockTool({\n  method: \"create_or_update_message_type\",\n  name: \"Create or update message type\",\n  description: `\n  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\".\n  \n  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.\n\n  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 }}.\n\n  <example>\n   <description>\n    Create a new message type for a banner component that has a text and an action URL.\n   </description>\n   <input>\n    {\n      \"messageTypeKey\": \"banner\",\n      \"name\": \"Banner\",\n      \"description\": \"A banner component that has a text and an action URL.\",\n      \"preview\": \"<div>{{ text }}</div>\",\n      \"variants\": [\n        {\n          \"key\": \"default\",\n          \"name\": \"Default\",\n          \"fields\": [\n            {\n              \"key\": \"text\",\n              \"type\": \"text\",\n              \"label\": \"Text\",\n              \"settings\": {\n                \"max_length\": 100,\n              },\n            },\n            {\n              \"key\": \"action_url\",\n              \"type\": \"text\",\n              \"label\": \"Action URL\",\n              \"settings\": {\n                \"placeholder\": \"https://example.com\",\n              },\n            }\n          ]\n        }\n      ]\n    }\n   </input>\n  </example>\n  <example>\n   <description>\n    Create a message type for a card component that has an icon type, title, body, and a single action button.\n   </description>\n   <input>\n    {\n      \"messageTypeKey\": \"card\",\n      \"name\": \"Card\",\n      \"description\": \"A single-action card component.\",\n      \"preview\": \"\n        <div>\n          <h2>{{ title }}</h2>\n          <p>{{ body }}</p>\n          <button>Action</button>\n        </div>\n      \",\n      \"variants\": [\n        {\n          \"key\": \"default\",\n          \"name\": \"Default\",\n          \"fields\": [\n            {\n              \"key\": \"icon_type\",\n              \"type\": \"select\",\n              \"label\": \"Icon type\",\n              \"settings\": {\n                \"options\": [\n                  {\n                    \"value\": \"warning\",\n                    \"label\": \"Warning\",\n                  },\n                  {\n                    \"value\": \"success\",\n                    \"label\": \"Success\",\n                  },\n                  {\n                    \"value\": \"info\",\n                    \"label\": \"Info\",\n                  },\n                  {\n                    \"value\": \"error\",\n                    \"label\": \"Error\",\n                  },\n                ]\n              },\n            },\n            {\n              \"key\": \"title\",\n              \"type\": \"text\",\n              \"label\": \"Title\",\n            },\n            {\n              \"key\": \"description\",\n              \"type\": \"markdown\",\n              \"label\": \"Description\",\n            },\n            {\n              \"key\": \"action_button\",\n              \"type\": \"button\",\n              \"label\": \"Action button\",\n            },\n          ]\n        }\n      ]\n    }\n   </input>\n  </example>\n  `,\n  parameters: z.object({\n    messageTypeKey: z\n      .string()\n      .describe(\"(string): The key of the message type to create or update.\"),\n    name: z.string().describe(\"(string): The name of the message type.\"),\n    description: z\n      .string()\n      .optional()\n      .describe(\"(string): The description of the message type.\"),\n    preview: z\n      .string()\n      .optional()\n      .describe(\n        \"(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.\"\n      ),\n    variants: z\n      .array(\n        z.object({\n          key: z.string().describe(\"(string): The key of the variant.\"),\n          name: z.string().describe(\"(string): The name of the variant.\"),\n          description: z\n            .string()\n            .optional()\n            .describe(\"(string): The description of the variant.\"),\n          fields: z\n            .array(\n              z.object({\n                key: z.string().describe(\"(string): The key of the field.\"),\n                type: z\n                  .string()\n                  .describe(\n                    \"(string): The type of the field. One of `text`, `textarea`, `button`, `markdown`, `select`, `multi_select`.\"\n                  ),\n                label: z.string().describe(\"(string): The label of the field.\"),\n                settings: z\n                  .object({})\n                  .describe(\"(object): The settings of the field.\"),\n              })\n            )\n            .describe(\"(array): The fields of the variant.\"),\n        })\n      )\n      .describe(\"(array): The variants of the message type.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    return await knockClient.messageTypes.upsert(params.messageTypeKey, {\n      message_type: {\n        name: params.name,\n        variants: params.variants,\n        description: params.description ?? \"\",\n        preview: params.preview ?? \"<div></div>\",\n      },\n      environment: params.environment ?? config.environment ?? \"development\",\n    });\n  },\n});\n\nexport const messageTypes = {\n  listMessageTypes,\n  createOrUpdateMessageType,\n};\n\nexport const permissions = {\n  read: [\"listMessageTypes\"],\n  manage: [\"createOrUpdateMessageType\"],\n};\n"],"mappings":";;;;;AAAA,SAAS,SAAS;AAIlB,IAAM,mBAAmB,UAAU;AAAA,EACjC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aACE;AAAA,EACF,YAAY,EAAE,OAAO;AAAA,IACnB,aAAa,EACV,OAAO,EACP;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,UAAM,kBAAiC,CAAC;AACxC,qBAAiB,eAAe,YAAY,aAAa,KAAK;AAAA,MAC5D,aAAa,OAAO,eAAe,OAAO,eAAe;AAAA,IAC3D,CAAC,GAAG;AACF,sBAAgB,KAAK,WAAW;AAAA,IAClC;AACA,WAAO;AAAA,EACT;AACF,CAAC;AAED,IAAM,4BAA4B,UAAU;AAAA,EAC1C,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgHb,YAAY,EAAE,OAAO;AAAA,IACnB,gBAAgB,EACb,OAAO,EACP,SAAS,4DAA4D;AAAA,IACxE,MAAM,EAAE,OAAO,EAAE,SAAS,yCAAyC;AAAA,IACnE,aAAa,EACV,OAAO,EACP,SAAS,EACT,SAAS,gDAAgD;AAAA,IAC5D,SAAS,EACN,OAAO,EACP,SAAS,EACT;AAAA,MACC;AAAA,IACF;AAAA,IACF,UAAU,EACP;AAAA,MACC,EAAE,OAAO;AAAA,QACP,KAAK,EAAE,OAAO,EAAE,SAAS,mCAAmC;AAAA,QAC5D,MAAM,EAAE,OAAO,EAAE,SAAS,oCAAoC;AAAA,QAC9D,aAAa,EACV,OAAO,EACP,SAAS,EACT,SAAS,2CAA2C;AAAA,QACvD,QAAQ,EACL;AAAA,UACC,EAAE,OAAO;AAAA,YACP,KAAK,EAAE,OAAO,EAAE,SAAS,iCAAiC;AAAA,YAC1D,MAAM,EACH,OAAO,EACP;AAAA,cACC;AAAA,YACF;AAAA,YACF,OAAO,EAAE,OAAO,EAAE,SAAS,mCAAmC;AAAA,YAC9D,UAAU,EACP,OAAO,CAAC,CAAC,EACT,SAAS,sCAAsC;AAAA,UACpD,CAAC;AAAA,QACH,EACC,SAAS,qCAAqC;AAAA,MACnD,CAAC;AAAA,IACH,EACC,SAAS,4CAA4C;AAAA,EAC1D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,WAAO,MAAM,YAAY,aAAa,OAAO,OAAO,gBAAgB;AAAA,MAClE,cAAc;AAAA,QACZ,MAAM,OAAO;AAAA,QACb,UAAU,OAAO;AAAA,QACjB,aAAa,OAAO,eAAe;AAAA,QACnC,SAAS,OAAO,WAAW;AAAA,MAC7B;AAAA,MACA,aAAa,OAAO,eAAe,OAAO,eAAe;AAAA,IAC3D,CAAC;AAAA,EACH;AACF,CAAC;AAEM,IAAM,eAAe;AAAA,EAC1B;AAAA,EACA;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,kBAAkB;AAAA,EACzB,QAAQ,CAAC,2BAA2B;AACtC;","names":[]}

package/dist/chunk-TLHETJRF.js

@@ -0,0 +1,75 @@
+import {
+  KnockTool
+} from "./chunk-TOBLV65T.js";
+
+// src/lib/tools/commits.ts
+import { z } 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: z.object({
+    environment: z.string().describe(
+      "(string): The environment to list commits for. Defaults to `development`."
+    ),
+    promoted: z.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: z.object({
+    message: z.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: z.object({
+    toEnvironment: z.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 permissions = {
+  read: ["listCommits"],
+  manage: ["commitAllChanges", "promoteAllCommits"]
+};
+
+export {
+  commits,
+  permissions
+};
+//# sourceMappingURL=chunk-TLHETJRF.js.map

package/dist/chunk-TLHETJRF.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/tools/commits.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { KnockTool } from \"../knock-tool.js\";\n\nconst listCommits = KnockTool({\n  method: \"list_commits\",\n  name: \"List commits\",\n  description: `\n  Returns all commits available in the environment. Use this tool when you are asked to see what changes are available to be deployed.\n  `,\n  parameters: z.object({\n    environment: z\n      .string()\n      .describe(\n        \"(string): The environment to list commits for. Defaults to `development`.\"\n      ),\n    promoted: z\n      .boolean()\n      .describe(\n        \"(boolean): Whether to only return promoted commits. Defaults to `false`.\"\n      ),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    return await knockClient.commits.list({\n      environment: params.environment ?? config.environment ?? \"development\",\n      promoted: params.promoted ?? false,\n    });\n  },\n});\n\nconst commitAllChanges = KnockTool({\n  method: \"commit_all_changes\",\n  name: \"Commit all changes\",\n  description: `\n  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.\n  `,\n  parameters: z.object({\n    message: z\n      .string()\n      .describe(\"(string): The message to include in the commit.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    return await knockClient.commits.commitAll({\n      environment: config.environment ?? \"development\",\n      commit_message: params.message,\n    });\n  },\n});\n\nconst promoteAllCommits = KnockTool({\n  method: \"promote_all_commits\",\n  name: \"Promote all commits\",\n  description: `\n  Promote all commits to the next environment. Use this tool when you are asked to deploy all changes. \n\n  When not specified, the \\`toEnvironment\\` will default to the environment that comes after the environment specified in the config.\n  `,\n  parameters: z.object({\n    toEnvironment: z\n      .string()\n      .describe(\"(string): The environment to promote all commits to.\"),\n  }),\n  execute: (knockClient, config) => async (params) => {\n    return await knockClient.put(\"/v1/commits/promote\", {\n      body: { to_environment: params.toEnvironment },\n    });\n  },\n});\n\nexport const commits = {\n  listCommits,\n  commitAllChanges,\n  promoteAllCommits,\n};\n\nexport const permissions = {\n  read: [\"listCommits\"],\n  manage: [\"commitAllChanges\", \"promoteAllCommits\"],\n};\n"],"mappings":";;;;;AAAA,SAAS,SAAS;AAGlB,IAAM,cAAc,UAAU;AAAA,EAC5B,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAY,EAAE,OAAO;AAAA,IACnB,aAAa,EACV,OAAO,EACP;AAAA,MACC;AAAA,IACF;AAAA,IACF,UAAU,EACP,QAAQ,EACR;AAAA,MACC;AAAA,IACF;AAAA,EACJ,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,WAAO,MAAM,YAAY,QAAQ,KAAK;AAAA,MACpC,aAAa,OAAO,eAAe,OAAO,eAAe;AAAA,MACzD,UAAU,OAAO,YAAY;AAAA,IAC/B,CAAC;AAAA,EACH;AACF,CAAC;AAED,IAAM,mBAAmB,UAAU;AAAA,EACjC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA,EAGb,YAAY,EAAE,OAAO;AAAA,IACnB,SAAS,EACN,OAAO,EACP,SAAS,iDAAiD;AAAA,EAC/D,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,WAAO,MAAM,YAAY,QAAQ,UAAU;AAAA,MACzC,aAAa,OAAO,eAAe;AAAA,MACnC,gBAAgB,OAAO;AAAA,IACzB,CAAC;AAAA,EACH;AACF,CAAC;AAED,IAAM,oBAAoB,UAAU;AAAA,EAClC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,EAKb,YAAY,EAAE,OAAO;AAAA,IACnB,eAAe,EACZ,OAAO,EACP,SAAS,sDAAsD;AAAA,EACpE,CAAC;AAAA,EACD,SAAS,CAAC,aAAa,WAAW,OAAO,WAAW;AAClD,WAAO,MAAM,YAAY,IAAI,uBAAuB;AAAA,MAClD,MAAM,EAAE,gBAAgB,OAAO,cAAc;AAAA,IAC/C,CAAC;AAAA,EACH;AACF,CAAC;AAEM,IAAM,UAAU;AAAA,EACrB;AAAA,EACA;AAAA,EACA;AACF;AAEO,IAAM,cAAc;AAAA,EACzB,MAAM,CAAC,aAAa;AAAA,EACpB,QAAQ,CAAC,oBAAoB,mBAAmB;AAClD;","names":[]}

package/dist/chunk-TOBLV65T.js

@@ -0,0 +1,30 @@
+// 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)
+  };
+};
+
+export {
+  KnockTool
+};
+//# sourceMappingURL=chunk-TOBLV65T.js.map

package/dist/chunk-TOBLV65T.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/lib/knock-tool.ts"],"sourcesContent":["import type { ZodObject } from \"zod\";\nimport { z } from \"zod\";\nimport { Config } from \"../types.js\";\nimport { KnockClient } from \"./knock-client.js\";\n\nexport interface KnockToolDefinition {\n  /**\n   * The method name of the tool. This is a machine-readable string.\n   */\n  method: string;\n  /**\n   * The name of the tool. This can be used to reference the tool in the code.\n   * A descriptive LLM-readable string.\n   */\n  name: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, including examples where useful.\n   */\n  description: string;\n\n  /**\n   * A descriptive prompt explaining the tool's purpose, usage and input parameters.\n   * Ths is intended to be used by the underlying LLM.\n   */\n  fullDescription: string;\n\n  /**\n   * The Zod schema for the input parameters of the tool\n   */\n  parameters?: ZodObject<any>;\n  /**\n   * The actual implementation of the tool.\n   */\n  execute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nexport interface KnockTool extends Omit<KnockToolDefinition, \"execute\"> {\n  bindExecute: (\n    knockClient: KnockClient,\n    config: Config\n  ) => (input: any) => Promise<unknown>;\n}\n\nconst trimLines = (text: string) =>\n  text\n    .split(\"\\n\")\n    .map((l) => l.trim())\n    .filter(Boolean)\n    .join(\"\\n\");\n\nexport const KnockTool = (\n  args: Omit<KnockToolDefinition, \"fullDescription\">\n): KnockTool => {\n  const { execute, ...restOfArgs } = args;\n  const parameters = restOfArgs.parameters\n    ? restOfArgs.parameters\n    : z.object({});\n\n  const schemaEntries = Object.entries(parameters.shape);\n\n  const argsStr =\n    schemaEntries.length === 0\n      ? \"Takes no arguments\"\n      : schemaEntries\n          .map(([key, value]) => {\n            return `- ${key}: ${(value as any).description || \"\"}`;\n          })\n          .join(\"\\n\");\n\n  const fullDescription = trimLines(`\n  Tool name:\n  ${args.name}\n  Description:\n  ${args.description}.\n  Arguments:\n  ${argsStr}\n  `);\n\n  return {\n    ...restOfArgs,\n    parameters,\n    fullDescription,\n    bindExecute: (knockClient: KnockClient, config: Config) =>\n      execute(knockClient, config),\n  };\n};\n"],"mappings":";AACA,SAAS,SAAS;AA8ClB,IAAM,YAAY,CAAC,SACjB,KACG,MAAM,IAAI,EACV,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EACnB,OAAO,OAAO,EACd,KAAK,IAAI;AAEP,IAAM,YAAY,CACvB,SACc;AACd,QAAM,EAAE,SAAS,GAAG,WAAW,IAAI;AACnC,QAAM,aAAa,WAAW,aAC1B,WAAW,aACX,EAAE,OAAO,CAAC,CAAC;AAEf,QAAM,gBAAgB,OAAO,QAAQ,WAAW,KAAK;AAErD,QAAM,UACJ,cAAc,WAAW,IACrB,uBACA,cACG,IAAI,CAAC,CAAC,KAAK,KAAK,MAAM;AACrB,WAAO,KAAK,GAAG,KAAM,MAAc,eAAe,EAAE;AAAA,EACtD,CAAC,EACA,KAAK,IAAI;AAElB,QAAM,kBAAkB,UAAU;AAAA;AAAA,IAEhC,KAAK,IAAI;AAAA;AAAA,IAET,KAAK,WAAW;AAAA;AAAA,IAEhB,OAAO;AAAA,GACR;AAED,SAAO;AAAA,IACL,GAAG;AAAA,IACH;AAAA,IACA;AAAA,IACA,aAAa,CAAC,aAA0B,WACtC,QAAQ,aAAa,MAAM;AAAA,EAC/B;AACF;","names":[]}