@knocklabs/agent-toolkit 0.5.2 → 0.5.4

package/dist/index-qFGypkX3.d.ts

@@ -0,0 +1,272 @@
+import { ZodObject } from 'zod';
+import KnockMgmt from '@knocklabs/mgmt';
+import { Knock } from '@knocklabs/node';
+
+type KnockClient = ReturnType<typeof createKnockClient>;
+declare const createKnockClient: (config: Config) => KnockMgmt & {
+    publicApi: (environmentSlug?: string) => Promise<Knock>;
+};
+
+interface KnockToolDefinition {
+    /**
+     * The method name of the tool. This is a machine-readable string.
+     */
+    method: string;
+    /**
+     * The name of the tool. This can be used to reference the tool in the code.
+     * A descriptive LLM-readable string.
+     */
+    name: string;
+    /**
+     * A descriptive prompt explaining the tool's purpose, including examples where useful.
+     */
+    description: string;
+    /**
+     * A descriptive prompt explaining the tool's purpose, usage and input parameters.
+     * Ths is intended to be used by the underlying LLM.
+     */
+    fullDescription: string;
+    /**
+     * The Zod schema for the input parameters of the tool
+     */
+    parameters?: ZodObject<any>;
+    /**
+     * The actual implementation of the tool.
+     */
+    execute: (knockClient: KnockClient, config: Config) => (input: any) => Promise<unknown>;
+}
+interface KnockTool extends Omit<KnockToolDefinition, "execute"> {
+    bindExecute: (knockClient: KnockClient, config: Config) => (input: any) => Promise<unknown>;
+}
+declare const KnockTool: (args: Omit<KnockToolDefinition, "fullDescription">) => KnockTool;
+
+declare const tools: {
+    channels: {
+        listChannels: KnockTool;
+    };
+    commits: {
+        listCommits: KnockTool;
+        commitAllChanges: KnockTool;
+        promoteAllCommits: KnockTool;
+    };
+    documentation: {
+        searchDocumentation: KnockTool;
+    };
+    emailLayouts: {
+        getEmailLayout: KnockTool;
+        listEmailLayouts: KnockTool;
+        createOrUpdateEmailLayout: KnockTool;
+    };
+    environments: {
+        listEnvironments: KnockTool;
+    };
+    guides: {
+        listGuides: KnockTool;
+        getGuide: KnockTool;
+        createOrUpdateGuide: KnockTool;
+    };
+    messages: {
+        getMessage: KnockTool;
+        getMessageContent: KnockTool;
+        getMessageDeliveryLogs: KnockTool;
+        getMessageEvents: KnockTool;
+    };
+    messageTypes: {
+        listMessageTypes: KnockTool;
+        createOrUpdateMessageType: KnockTool;
+    };
+    objects: {
+        listObjects: KnockTool;
+        getObject: KnockTool;
+        createOrUpdateObject: KnockTool;
+        subscribeUsersToObject: KnockTool;
+        unsubscribeUsersFromObject: KnockTool;
+    };
+    partials: {
+        getPartial: KnockTool;
+        listPartials: KnockTool;
+        createOrUpdatePartial: KnockTool;
+    };
+    tenants: {
+        getTenant: KnockTool;
+        listTenants: KnockTool;
+        createOrUpdateTenant: KnockTool;
+    };
+    users: {
+        getUser: KnockTool;
+        createOrUpdateUser: KnockTool;
+        getUserPreferences: KnockTool;
+        setUserPreferences: KnockTool;
+        getUserMessages: KnockTool;
+    };
+    workflows: {
+        createOneOffWorkflowSchedule: KnockTool;
+        createOrUpdateEmailStepInWorkflow: KnockTool;
+        createOrUpdateSmsStepInWorkflow: KnockTool;
+        createOrUpdatePushStepInWorkflow: KnockTool;
+        createOrUpdateInAppFeedStepInWorkflow: KnockTool;
+        createOrUpdateChatStepInWorkflow: KnockTool;
+        createOrUpdateDelayStepInWorkflow: KnockTool;
+        createOrUpdateBatchStepInWorkflow: KnockTool;
+        listWorkflows: KnockTool;
+        getWorkflow: KnockTool;
+        triggerWorkflow: KnockTool;
+        createWorkflow: KnockTool;
+    };
+};
+declare const allTools: {
+    createOneOffWorkflowSchedule: KnockTool;
+    createOrUpdateEmailStepInWorkflow: KnockTool;
+    createOrUpdateSmsStepInWorkflow: KnockTool;
+    createOrUpdatePushStepInWorkflow: KnockTool;
+    createOrUpdateInAppFeedStepInWorkflow: KnockTool;
+    createOrUpdateChatStepInWorkflow: KnockTool;
+    createOrUpdateDelayStepInWorkflow: KnockTool;
+    createOrUpdateBatchStepInWorkflow: KnockTool;
+    listWorkflows: KnockTool;
+    getWorkflow: KnockTool;
+    triggerWorkflow: KnockTool;
+    createWorkflow: KnockTool;
+    getUser: KnockTool;
+    createOrUpdateUser: KnockTool;
+    getUserPreferences: KnockTool;
+    setUserPreferences: KnockTool;
+    getUserMessages: KnockTool;
+    getTenant: KnockTool;
+    listTenants: KnockTool;
+    createOrUpdateTenant: KnockTool;
+    getPartial: KnockTool;
+    listPartials: KnockTool;
+    createOrUpdatePartial: KnockTool;
+    listObjects: KnockTool;
+    getObject: KnockTool;
+    createOrUpdateObject: KnockTool;
+    subscribeUsersToObject: KnockTool;
+    unsubscribeUsersFromObject: KnockTool;
+    getMessage: KnockTool;
+    getMessageContent: KnockTool;
+    getMessageDeliveryLogs: KnockTool;
+    getMessageEvents: KnockTool;
+    listMessageTypes: KnockTool;
+    createOrUpdateMessageType: KnockTool;
+    listGuides: KnockTool;
+    getGuide: KnockTool;
+    createOrUpdateGuide: KnockTool;
+    listEnvironments: KnockTool;
+    getEmailLayout: KnockTool;
+    listEmailLayouts: KnockTool;
+    createOrUpdateEmailLayout: KnockTool;
+    searchDocumentation: KnockTool;
+    listCommits: KnockTool;
+    commitAllChanges: KnockTool;
+    promoteAllCommits: KnockTool;
+    listChannels: KnockTool;
+};
+declare const toolPermissions: {
+    channels: {
+        read: string[];
+    };
+    commits: {
+        read: string[];
+        manage: string[];
+    };
+    documentation: {
+        read: string[];
+    };
+    emailLayouts: {
+        read: string[];
+        manage: string[];
+    };
+    environments: {
+        read: string[];
+    };
+    guides: {
+        read: string[];
+        manage: string[];
+    };
+    messages: {
+        read: string[];
+    };
+    messageTypes: {
+        read: string[];
+        manage: string[];
+    };
+    objects: {
+        read: string[];
+        manage: string[];
+    };
+    partials: {
+        read: string[];
+        manage: string[];
+    };
+    tenants: {
+        read: string[];
+        manage: string[];
+    };
+    users: {
+        read: string[];
+        manage: string[];
+    };
+    workflows: {
+        read: string[];
+        manage: string[];
+        trigger: never[];
+    };
+};
+
+interface Config {
+    /**
+     * The token to use to authenticate with the service. If not provided, the `serviceToken`
+     * will be resolved from `KNOCK_SERVICE_TOKEN` environment variable.
+     */
+    serviceToken?: string | undefined;
+    /**
+     * When set calls will be made as this user.
+     */
+    userId?: string | undefined;
+    /**
+     * When set calls will be made in this tenant context.
+     */
+    tenantId?: string | undefined;
+    /**
+     * The environment to use as the basis for the API calls. When not defined, will default to
+     * the `development` environment.
+     */
+    environment?: string | undefined;
+    /**
+     * Whether to hide user data from LLM responses. When true, the LLM will not have access to user
+     * data and only the ID will be returned. Defaults to `false`.
+     */
+    hideUserData?: boolean | undefined;
+}
+type TransformPermissions<T> = {
+    [K in keyof T]?: {
+        [P in keyof T[K]]?: boolean;
+    };
+};
+interface ToolkitConfig extends Config {
+    /**
+     * The permissions to use for the toolkit.
+     */
+    permissions: Omit<TransformPermissions<typeof toolPermissions>, "workflows"> & {
+        workflows?: {
+            /**
+             * Whether to allow reading workflows.
+             */
+            read?: boolean | undefined;
+            /**
+             * Whether to allow managing workflows.
+             */
+            manage?: boolean | undefined;
+            /**
+             * Optionally specify a list of workflow keys to turn into workflow trigger tools
+             *
+             * If true, all workflows will be allowed.
+             */
+            trigger?: string[] | undefined;
+        };
+    };
+}
+type ToolCategory = keyof typeof toolPermissions;
+
+export { type Config as C, type KnockClient as K, type ToolkitConfig as T, type ToolCategory as a, KnockTool as b, type TransformPermissions as c, allTools as d, toolPermissions as e, createKnockClient as f, type KnockToolDefinition as g, tools as t };

package/dist/langchain/index.d.ts

@@ -1,5 +1,8 @@
 import { DynamicStructuredTool } from '@langchain/core/tools';
-import { ToolkitConfig, ToolCategory } from '../types.js';
+import { T as ToolkitConfig, a as ToolCategory } from '../index-qFGypkX3.js';
+import 'zod';
+import '@knocklabs/mgmt';
+import '@knocklabs/node';
 
 type KnockToolkit = {
     getAllTools: () => DynamicStructuredTool[];

package/dist/langchain/index.js

@@ -1,10 +1,10 @@
 import {
   createKnockClient
-} from "../chunk-ZIHENQL2.js";
+} from "../chunk-YOH7QKTM.js";
 import {
   getToolMap,
   getToolsByPermissionsInCategories
-} from "../chunk-2KLDMVOD.js";
+} from "../chunk-7U5HNTEY.js";
 import {
   __commonJS,
   __export,

package/dist/mastra/index.d.ts

@@ -1,6 +1,8 @@
 import { Tool } from '@mastra/core/tools';
 import { z } from 'zod';
-import { ToolkitConfig, ToolCategory } from '../types.js';
+import { T as ToolkitConfig, a as ToolCategory } from '../index-qFGypkX3.js';
+import '@knocklabs/mgmt';
+import '@knocklabs/node';
 
 type KnockToolkit = {
     getAllTools: () => Tool<z.ZodObject<any, any>>[];

package/dist/mastra/index.js

@@ -1,10 +1,10 @@
 import {
   createKnockClient
-} from "../chunk-ZIHENQL2.js";
+} from "../chunk-YOH7QKTM.js";
 import {
   getToolMap,
   getToolsByPermissionsInCategories
-} from "../chunk-2KLDMVOD.js";
+} from "../chunk-7U5HNTEY.js";
 import "../chunk-G3PMV62Z.js";
 
 // src/mastra/tool-converter.ts

package/dist/modelcontextprotocol/index.d.ts

@@ -1,43 +1,9 @@
-import { K as KnockClient } from '../knock-client-BH7Juvis.js';
-import { ZodObject } from 'zod';
-import { Config } from '../types.js';
+import { K as KnockClient, C as Config, b as KnockTool } from '../index-qFGypkX3.js';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import 'zod';
 import '@knocklabs/mgmt';
 import '@knocklabs/node';
 
-interface KnockToolDefinition {
-    /**
-     * The method name of the tool. This is a machine-readable string.
-     */
-    method: string;
-    /**
-     * The name of the tool. This can be used to reference the tool in the code.
-     * A descriptive LLM-readable string.
-     */
-    name: string;
-    /**
-     * A descriptive prompt explaining the tool's purpose, including examples where useful.
-     */
-    description: string;
-    /**
-     * A descriptive prompt explaining the tool's purpose, usage and input parameters.
-     * Ths is intended to be used by the underlying LLM.
-     */
-    fullDescription: string;
-    /**
-     * The Zod schema for the input parameters of the tool
-     */
-    parameters?: ZodObject<any>;
-    /**
-     * The actual implementation of the tool.
-     */
-    execute: (knockClient: KnockClient, config: Config) => (input: any) => Promise<unknown>;
-}
-interface KnockTool extends Omit<KnockToolDefinition, "execute"> {
-    bindExecute: (knockClient: KnockClient, config: Config) => (input: any) => Promise<unknown>;
-}
-declare const KnockTool: (args: Omit<KnockToolDefinition, "fullDescription">) => KnockTool;
-
 declare class KnockMcpServer extends McpServer {
     constructor(knockClient: KnockClient, config: Config, tools: KnockTool[]);
 }

package/dist/modelcontextprotocol/index.js

@@ -1,7 +1,7 @@
 import {
   createKnockMcpServer
-} from "../chunk-ZNG6J5G2.js";
-import "../chunk-2KLDMVOD.js";
+} from "../chunk-HIHS5S2N.js";
+import "../chunk-7U5HNTEY.js";
 import "../chunk-G3PMV62Z.js";
 export {
   createKnockMcpServer

package/dist/modelcontextprotocol/local-server.js

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
-import {
-  createKnockMcpServer
-} from "../chunk-ZNG6J5G2.js";
 import {
   createKnockClient
-} from "../chunk-ZIHENQL2.js";
+} from "../chunk-YOH7QKTM.js";
+import {
+  createKnockMcpServer
+} from "../chunk-HIHS5S2N.js";
 import {
   filterTools,
   tools
-} from "../chunk-2KLDMVOD.js";
+} from "../chunk-7U5HNTEY.js";
 import "../chunk-G3PMV62Z.js";
 
 // src/modelcontextprotocol/local-server.ts

package/dist/openai/index.d.ts

@@ -1,5 +1,8 @@
 import { ChatCompletionTool, ChatCompletionMessageToolCall, ChatCompletionToolMessageParam } from 'openai/resources.mjs';
-import { ToolkitConfig, ToolCategory } from '../types.js';
+import { T as ToolkitConfig, a as ToolCategory } from '../index-qFGypkX3.js';
+import 'zod';
+import '@knocklabs/mgmt';
+import '@knocklabs/node';
 
 type KnockToolkit = {
     getAllTools: () => ChatCompletionTool[];

package/dist/openai/index.js

@@ -1,10 +1,10 @@
 import {
   createKnockClient
-} from "../chunk-ZIHENQL2.js";
+} from "../chunk-YOH7QKTM.js";
 import {
   getToolMap,
   getToolsByPermissionsInCategories
-} from "../chunk-2KLDMVOD.js";
+} from "../chunk-7U5HNTEY.js";
 import "../chunk-G3PMV62Z.js";
 
 // src/openai/tool-converter.ts

package/dist/types.d.ts

@@ -1,108 +1,4 @@
-declare const toolPermissions: {
-    channels: {
-        read: string[];
-    };
-    commits: {
-        read: string[];
-        manage: string[];
-    };
-    documentation: {
-        read: string[];
-    };
-    emailLayouts: {
-        read: string[];
-        manage: string[];
-    };
-    environments: {
-        read: string[];
-    };
-    guides: {
-        read: string[];
-        manage: string[];
-    };
-    messages: {
-        read: string[];
-    };
-    messageTypes: {
-        read: string[];
-        manage: string[];
-    };
-    objects: {
-        read: string[];
-        manage: string[];
-    };
-    partials: {
-        read: string[];
-        manage: string[];
-    };
-    tenants: {
-        read: string[];
-        manage: string[];
-    };
-    users: {
-        read: string[];
-        manage: string[];
-    };
-    workflows: {
-        read: string[];
-        manage: string[];
-        trigger: never[];
-    };
-};
-
-interface Config {
-    /**
-     * The token to use to authenticate with the service. If not provided, the `serviceToken`
-     * will be resolved from `KNOCK_SERVICE_TOKEN` environment variable.
-     */
-    serviceToken?: string | undefined;
-    /**
-     * When set calls will be made as this user.
-     */
-    userId?: string | undefined;
-    /**
-     * When set calls will be made in this tenant context.
-     */
-    tenantId?: string | undefined;
-    /**
-     * The environment to use as the basis for the API calls. When not defined, will default to
-     * the `development` environment.
-     */
-    environment?: string | undefined;
-    /**
-     * Whether to hide user data from LLM responses. When true, the LLM will not have access to user
-     * data and only the ID will be returned. Defaults to `false`.
-     */
-    hideUserData?: boolean | undefined;
-}
-type TransformPermissions<T> = {
-    [K in keyof T]?: {
-        [P in keyof T[K]]?: boolean;
-    };
-};
-interface ToolkitConfig extends Config {
-    /**
-     * The permissions to use for the toolkit.
-     */
-    permissions: Omit<TransformPermissions<typeof toolPermissions>, "workflows"> & {
-        workflows?: {
-            /**
-             * Whether to allow reading workflows.
-             */
-            read?: boolean | undefined;
-            /**
-             * Whether to allow managing workflows.
-             */
-            manage?: boolean | undefined;
-            /**
-             * Optionally specify a list of workflow keys to turn into workflow trigger tools
-             *
-             * If true, all workflows will be allowed.
-             */
-            trigger?: string[] | undefined;
-        };
-    };
-}
-type ToolCategory = keyof typeof toolPermissions;
-
-export type { Config, ToolCategory, ToolkitConfig, TransformPermissions };
+export { C as Config, a as ToolCategory, T as ToolkitConfig, c as TransformPermissions } from './index-qFGypkX3.js';
+import 'zod';
+import '@knocklabs/mgmt';
+import '@knocklabs/node';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/agent-toolkit",
-  "version": "0.5.2",
+  "version": "0.5.4",
   "description": "A toolkit for working with Knock in Agent workflows.",
   "main": "src/index.js",
   "scripts": {
@@ -47,6 +47,10 @@
     },
     "./types": {
       "types": "./dist/types.d.ts"
+    },
+    "./core": {
+      "types": "./dist/core/index.d.ts",
+      "default": "./dist/core/index.js"
     }
   },
   "bin": {