@indexnetwork/protocol 0.3.3 → 0.4.0-rc.12.1

package/dist/shared/interfaces/webhook.interface.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Webhook adapter interface for the protocol layer.
+ * Implemented by the host application and injected via ProtocolDeps.
+ */
+export interface WebhookAdapter {
+    create(userId: string, url: string, events: string[], description?: string): Promise<{
+        id: string;
+        secret: string;
+    }>;
+    list(userId: string): Promise<Array<{
+        id: string;
+        url: string;
+        events: string[];
+        active: boolean;
+        description?: string | null;
+        failureCount: number;
+        createdAt: Date;
+    }>>;
+    delete(userId: string, webhookId: string): Promise<void>;
+    test(userId: string, webhookId: string): Promise<{
+        success: boolean;
+    }>;
+    listEvents(): string[];
+}
+//# sourceMappingURL=webhook.interface.d.ts.map

package/dist/shared/interfaces/webhook.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.interface.d.ts","sourceRoot":"","sources":["../../../src/shared/interfaces/webhook.interface.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAClC,EAAE,EAAE,MAAM,CAAC;QACX,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,EAAE,OAAO,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,YAAY,EAAE,MAAM,CAAC;QACrB,SAAS,EAAE,IAAI,CAAC;KACjB,CAAC,CAAC,CAAC;IACJ,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IACvE,UAAU,IAAI,MAAM,EAAE,CAAC;CACxB"}

package/dist/shared/interfaces/webhook.interface.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=webhook.interface.js.map

package/dist/shared/interfaces/webhook.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.interface.js","sourceRoot":"","sources":["../../../src/shared/interfaces/webhook.interface.ts"],"names":[],"mappings":""}

package/dist/webhook/webhook.tools.d.ts

@@ -0,0 +1,7 @@
+import type { DefineTool, ToolDeps } from '../shared/agent/tool.helpers.js';
+/**
+ * Creates webhook management tools for the chat agent.
+ * Enables registering, listing, deleting, and testing webhook subscriptions.
+ */
+export declare function createWebhookTools(defineTool: DefineTool, deps: ToolDeps): any[];
+//# sourceMappingURL=webhook.tools.d.ts.map

package/dist/webhook/webhook.tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.tools.d.ts","sourceRoot":"","sources":["../../src/webhook/webhook.tools.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAG5E;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,SA4HxE"}

package/dist/webhook/webhook.tools.js

@@ -0,0 +1,127 @@
+import { z } from 'zod';
+import { success, error } from '../shared/agent/tool.helpers.js';
+/**
+ * Creates webhook management tools for the chat agent.
+ * Enables registering, listing, deleting, and testing webhook subscriptions.
+ */
+export function createWebhookTools(defineTool, deps) {
+    const { webhook } = deps;
+    const register_webhook = defineTool({
+        name: 'register_webhook',
+        description: 'Register a webhook URL to receive push notifications when events occur. ' +
+            'The webhook will receive HTTP POST requests with a JSON payload signed with HMAC-SHA256. ' +
+            'Use list_webhook_events to discover available event names before registering.',
+        querySchema: z.object({
+            url: z.string().describe('The HTTPS URL to receive webhook POST requests'),
+            events: z.array(z.string()).describe('Array of event names to subscribe to (e.g. ["opportunity.created"])'),
+            description: z.string().optional().describe('Optional human-readable description of this webhook'),
+        }),
+        handler: async ({ context, query }) => {
+            if (!webhook) {
+                return error('Webhook functionality is not available');
+            }
+            try {
+                const result = await webhook.create(context.userId, query.url, query.events, query.description);
+                return success({
+                    message: 'Webhook registered successfully. Save the secret for verifying signatures.',
+                    id: result.id,
+                    secret: result.secret,
+                });
+            }
+            catch (err) {
+                return error(`Failed to register webhook: ${err instanceof Error ? err.message : String(err)}`);
+            }
+        },
+    });
+    const list_webhooks = defineTool({
+        name: 'list_webhooks',
+        description: "List all webhooks registered by the authenticated user. " +
+            "Secrets are masked for security (only last 4 characters shown).",
+        querySchema: z.object({}),
+        handler: async ({ context }) => {
+            if (!webhook) {
+                return error('Webhook functionality is not available');
+            }
+            try {
+                const webhooks = await webhook.list(context.userId);
+                return success({
+                    count: webhooks.length,
+                    webhooks: webhooks.map(w => ({
+                        id: w.id,
+                        url: w.url,
+                        events: w.events,
+                        active: w.active,
+                        description: w.description,
+                        failureCount: w.failureCount,
+                        createdAt: w.createdAt,
+                    })),
+                });
+            }
+            catch (err) {
+                return error(`Failed to list webhooks: ${err instanceof Error ? err.message : String(err)}`);
+            }
+        },
+    });
+    const delete_webhook = defineTool({
+        name: 'delete_webhook',
+        description: 'Delete a webhook registration by its ID. Only the owner can delete their webhooks.',
+        querySchema: z.object({
+            webhookId: z.string().describe('The ID of the webhook to delete'),
+        }),
+        handler: async ({ context, query }) => {
+            if (!webhook) {
+                return error('Webhook functionality is not available');
+            }
+            try {
+                await webhook.delete(context.userId, query.webhookId);
+                return success({ message: 'Webhook deleted successfully' });
+            }
+            catch (err) {
+                return error(`Failed to delete webhook: ${err instanceof Error ? err.message : String(err)}`);
+            }
+        },
+    });
+    const test_webhook = defineTool({
+        name: 'test_webhook',
+        description: 'Send a test payload to a webhook URL to verify it is working correctly. ' +
+            'The test delivery is enqueued and processed asynchronously.',
+        querySchema: z.object({
+            webhookId: z.string().describe('The ID of the webhook to test'),
+        }),
+        handler: async ({ context, query }) => {
+            if (!webhook) {
+                return error('Webhook functionality is not available');
+            }
+            try {
+                const result = await webhook.test(context.userId, query.webhookId);
+                return success({
+                    message: 'Test webhook delivery enqueued. Check your endpoint for the test payload.',
+                    success: result.success,
+                });
+            }
+            catch (err) {
+                return error(`Failed to test webhook: ${err instanceof Error ? err.message : String(err)}`);
+            }
+        },
+    });
+    const list_webhook_events = defineTool({
+        name: 'list_webhook_events',
+        description: 'List all available webhook event names that can be subscribed to. ' +
+            'Use these event names when registering a webhook with register_webhook.',
+        querySchema: z.object({}),
+        handler: async () => {
+            if (!webhook) {
+                return error('Webhook functionality is not available');
+            }
+            try {
+                const events = webhook.listEvents();
+                return success({ events });
+            }
+            catch (err) {
+                return error(`Failed to list webhook events: ${err instanceof Error ? err.message : String(err)}`);
+            }
+        },
+    });
+    return [register_webhook, list_webhooks, delete_webhook, test_webhook, list_webhook_events];
+}
+//# sourceMappingURL=webhook.tools.js.map

package/dist/webhook/webhook.tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.tools.js","sourceRoot":"","sources":["../../src/webhook/webhook.tools.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,iCAAiC,CAAC;AAEjE;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,UAAsB,EAAE,IAAc;IACvE,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IAEzB,MAAM,gBAAgB,GAAG,UAAU,CAAC;QAClC,IAAI,EAAE,kBAAkB;QACxB,WAAW,EACT,0EAA0E;YAC1E,2FAA2F;YAC3F,+EAA+E;QACjF,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gDAAgD,CAAC;YAC1E,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,qEAAqE,CAAC;YAC3G,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qDAAqD,CAAC;SACnG,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;gBAChG,OAAO,OAAO,CAAC;oBACb,OAAO,EAAE,4EAA4E;oBACrF,EAAE,EAAE,MAAM,CAAC,EAAE;oBACb,MAAM,EAAE,MAAM,CAAC,MAAM;iBACtB,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,+BAA+B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClG,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,UAAU,CAAC;QAC/B,IAAI,EAAE,eAAe;QACrB,WAAW,EACT,0DAA0D;YAC1D,iEAAiE;QACnE,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;YAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACpD,OAAO,OAAO,CAAC;oBACb,KAAK,EAAE,QAAQ,CAAC,MAAM;oBACtB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;wBAC3B,EAAE,EAAE,CAAC,CAAC,EAAE;wBACR,GAAG,EAAE,CAAC,CAAC,GAAG;wBACV,MAAM,EAAE,CAAC,CAAC,MAAM;wBAChB,MAAM,EAAE,CAAC,CAAC,MAAM;wBAChB,WAAW,EAAE,CAAC,CAAC,WAAW;wBAC1B,YAAY,EAAE,CAAC,CAAC,YAAY;wBAC5B,SAAS,EAAE,CAAC,CAAC,SAAS;qBACvB,CAAC,CAAC;iBACJ,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,4BAA4B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC/F,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,UAAU,CAAC;QAChC,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,oFAAoF;QACjG,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,iCAAiC,CAAC;SAClE,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;gBACtD,OAAO,OAAO,CAAC,EAAE,OAAO,EAAE,8BAA8B,EAAE,CAAC,CAAC;YAC9D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,6BAA6B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAChG,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,UAAU,CAAC;QAC9B,IAAI,EAAE,cAAc;QACpB,WAAW,EACT,0EAA0E;YAC1E,6DAA6D;QAC/D,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;SAChE,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE;YACpC,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;gBACnE,OAAO,OAAO,CAAC;oBACb,OAAO,EAAE,2EAA2E;oBACpF,OAAO,EAAE,MAAM,CAAC,OAAO;iBACxB,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,2BAA2B,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9F,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,UAAU,CAAC;QACrC,IAAI,EAAE,qBAAqB;QAC3B,WAAW,EACT,oEAAoE;YACpE,yEAAyE;QAC3E,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;QACzB,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,wCAAwC,CAAC,CAAC;YACzD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;gBACpC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;YAC7B,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,KAAK,CAAC,kCAAkC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACrG,CAAC;QACH,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC;AAC9F,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indexnetwork/protocol",
-  "version": "0.3.3",
+  "version": "0.4.0-rc.12.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -10,7 +10,9 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",