@arbium/enterprise-agent-connect-client 0.1.1 → 0.1.2-dev.cba5f68

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 import { type AppLive } from "./steps.js";
-import type { Agent, CheckOutcome, Connection, Connector, Limits, SiteAccess, TeamsTriggerInput } from "./types.js";
+import type { Agent, CheckOutcome, Connection, Connector, EventSubscriptionInput, EventTriggerInput, Limits, SiteAccess, TeamsTriggerInput } from "./types.js";
 export * from "./steps.js";
 export type * from "./types.js";
 /** A refusal the admin should read (4xx with an `error`): bad input, a failed connection
@@ -115,6 +115,7 @@ export declare function createClient(options: ClientOptions): {
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         afterConnect: {
             title: string;
@@ -144,6 +145,7 @@ export declare function createClient(options: ClientOptions): {
                 field: string;
                 value: string;
             };
+            capabilities?: string[];
         }[];
         fields: {
             id: string;
@@ -161,6 +163,7 @@ export declare function createClient(options: ClientOptions): {
                 field: string;
                 value: string;
             };
+            optional: boolean;
         }[];
         capabilities: {
             id: string;
@@ -244,6 +247,7 @@ export declare function createClient(options: ClientOptions): {
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -261,6 +265,7 @@ export declare function createClient(options: ClientOptions): {
             path: string;
             label: string;
             show: string;
+            name?: string;
             match?: {
                 [key: string]: string | number | boolean;
             };
@@ -280,6 +285,7 @@ export declare function createClient(options: ClientOptions): {
                 type: "header";
                 header: string;
                 value: string;
+                prefix?: string;
             } | {
                 type: "bearer";
                 token: string;
@@ -292,6 +298,14 @@ export declare function createClient(options: ClientOptions): {
                 tokenUrl: string;
                 clientId: string;
                 clientSecret: string;
+                scope?: string;
+            } | {
+                type: "query";
+                param: string;
+                value: string;
+            };
+            headers: {
+                [key: string]: string;
             };
             tools: {
                 name: string;
@@ -300,13 +314,173 @@ export declare function createClient(options: ClientOptions): {
                 path: string;
                 params: {
                     [key: string]: {
-                        type: "string" | "number" | "integer" | "boolean";
+                        type: "string" | "number" | "integer" | "boolean" | "array";
                         description: string;
                         in: "path" | "query" | "body";
+                        name?: string;
                         required: boolean;
+                        default?: (string | number | boolean) | (string | number | boolean)[];
+                        enum?: (string | number | boolean)[];
+                        items?: "string" | "number" | "integer" | "boolean";
+                        join?: string;
+                        limit?: string;
+                    };
+                };
+                destructive: boolean;
+                answerLimits: {
+                    field: string;
+                    limit: string;
+                }[];
+                result?: {
+                    items?: string;
+                    fields?: string[];
+                };
+                paging?: {
+                    param: string;
+                    body: string;
+                } | {
+                    param: string;
+                    header: string;
+                } | {
+                    param: string;
+                    link: true;
+                };
+            }[];
+            allowInsecureHttp: boolean;
+        };
+        soap?: {
+            endpoint: string;
+            version: "1.1" | "1.2";
+            namespaces: {
+                [key: string]: string;
+            };
+            auth?: {
+                type: "header";
+                header: string;
+                value: string;
+                prefix?: string;
+            } | {
+                type: "bearer";
+                token: string;
+            } | {
+                type: "basic";
+                username: string;
+                password: string;
+            };
+            wsSecurity?: {
+                username: string;
+                password: string;
+                digest: boolean;
+            };
+            verify?: {
+                tool: string;
+                args: {
+                    [key: string]: string | number | boolean;
+                };
+                show: string;
+            };
+            tools: {
+                name: string;
+                description: string;
+                operation: string;
+                soapAction?: string;
+                body: string;
+                params: {
+                    [key: string]: {
+                        type: "string" | "number" | "integer" | "boolean";
+                        description: string;
+                        required: boolean;
+                        limit?: string;
+                    };
+                };
+                result?: string;
+                fields?: string[];
+                readOnly: boolean;
+                destructive: boolean;
+                answerLimits: {
+                    field: string;
+                    limit: string;
+                }[];
+            }[];
+            allowInsecureHttp: boolean;
+        };
+        odata?: {
+            serviceRoot: string;
+            version: "2" | "4";
+            auth: {
+                type: "header";
+                header: string;
+                value: string;
+                prefix?: string;
+            } | {
+                type: "bearer";
+                token: string;
+            } | {
+                type: "basic";
+                username: string;
+                password: string;
+            } | {
+                type: "oauth2";
+                tokenUrl: string;
+                clientId: string;
+                clientSecret: string;
+                scope?: string;
+            } | {
+                type: "query";
+                param: string;
+                value: string;
+            };
+            headers: {
+                [key: string]: string;
+            };
+            csrf: boolean;
+            paging: "skip" | "server";
+            tools: {
+                name: string;
+                description: string;
+                kind: "list" | "get" | "create" | "update" | "function" | "action";
+                entitySet?: string;
+                function?: string;
+                key: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
                         limit?: string;
                     };
                 };
+                filters: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                        op: "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "contains" | "startswith";
+                    };
+                };
+                fields: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                    };
+                };
+                params: {
+                    [key: string]: {
+                        type: "string" | "integer" | "number" | "decimal" | "boolean" | "guid" | "datetime" | "datetimeoffset";
+                        description: string;
+                        property?: string;
+                        required?: boolean;
+                        limit?: string;
+                    };
+                };
+                select: string[];
+                orderBy?: string;
+                top: number;
                 destructive: boolean;
                 answerLimits: {
                     field: string;
@@ -315,6 +489,142 @@ export declare function createClient(options: ClientOptions): {
             }[];
             allowInsecureHttp: boolean;
         };
+        sql?: {
+            engine: "postgres" | "sqlserver" | "mysql" | "oracle";
+            host: string;
+            port?: number;
+            database: string;
+            auth: {
+                user: string;
+                password: string;
+            };
+            tls: "verify" | "insecure" | "off";
+            timeoutSeconds: number;
+            maxRows: number;
+            tools: {
+                name: string;
+                description: string;
+                sql: string;
+                params: {
+                    [key: string]: {
+                        type: "string" | "number" | "integer" | "boolean";
+                        description: string;
+                        required: boolean;
+                        limit?: string;
+                    };
+                };
+                write: boolean;
+                destructive: boolean;
+                answerLimits: {
+                    column: string;
+                    limit: string;
+                }[];
+            }[];
+        };
+        events?: {
+            types: {
+                id: string;
+                label: string;
+            }[];
+            fields: {
+                [key: string]: string;
+            };
+            limits: {
+                [key: string]: string;
+            };
+            webhook?: {
+                verify: {
+                    type: "hmac-sha256";
+                    header: string;
+                    prefix: string;
+                } | {
+                    type: "token";
+                    header: string;
+                } | {
+                    type: "none";
+                };
+                allowInsecure: boolean;
+                type: {
+                    field: string;
+                } | {
+                    header: string;
+                };
+                deliveryId?: {
+                    field: string;
+                } | {
+                    header: string;
+                };
+                timestamp?: {
+                    at: {
+                        field: string;
+                    } | {
+                        header: string;
+                    };
+                    unit: "s" | "ms" | "iso";
+                    toleranceSeconds: number;
+                };
+                setup: {
+                    title: string;
+                    body: string;
+                    link?: {
+                        label: string;
+                        href: string;
+                    };
+                    copy?: string[];
+                    shell?: "bash" | "powershell";
+                    permissions?: boolean;
+                    certificate?: boolean;
+                    click?: string[];
+                    clickUnavailable?: true;
+                    siteRole?: "read" | "write";
+                    agentCheck?: boolean;
+                    confirm?: string;
+                    live?: string;
+                    settings?: {
+                        id: string;
+                        label: string;
+                        help?: string;
+                        placeholder?: string;
+                        pattern: string;
+                    }[];
+                    option?: {
+                        field: string;
+                        value: string;
+                    };
+                }[];
+                register?: {
+                    method: "GET" | "POST" | "PUT";
+                    path: string;
+                    body?: unknown;
+                    location: string;
+                };
+            };
+            self?: {
+                request: {
+                    method: "GET" | "POST" | "PUT";
+                    path: string;
+                    body?: unknown;
+                };
+                id: string;
+                fields: string[];
+            };
+            poll?: {
+                request: {
+                    method: "GET" | "POST" | "PUT";
+                    path: string;
+                    body?: unknown;
+                };
+                filter?: string;
+                items: string;
+                wrap?: string;
+                cursor: string;
+                deliveryId: string[];
+                types: {
+                    type: string;
+                    same?: [string, string];
+                }[];
+            };
+        };
     }[]>;
     providers: () => Promise<{
         id: string;
@@ -811,6 +1121,136 @@ export declare function createClient(options: ClientOptions): {
         finishedAt: string | null;
         replyTokenAt: string;
     }[]>;
+    eventSubscriptions: (o: string) => Promise<{
+        id: string;
+        connectorId: string;
+        source: "webhook" | "poll";
+        filter: string;
+        intervalSeconds: number;
+        cursor: string | null;
+        polledAt: string | null;
+        lastError: string | null;
+        registered: string | null;
+        url: string | null;
+        createdBy: string;
+        createdAt: string;
+    }[]>;
+    subscribeEvents: (o: string, body: EventSubscriptionInput) => Promise<{
+        subscription: import("./schema.js").components["schemas"]["EventSubscription"];
+        secret: string | null;
+        setup: {
+            title: string;
+            body: string;
+            link?: {
+                label: string;
+                href: string;
+            };
+            copy?: string[];
+            shell?: "bash" | "powershell";
+            permissions?: boolean;
+            certificate?: boolean;
+            click?: string[];
+            clickUnavailable?: true;
+            siteRole?: "read" | "write";
+            agentCheck?: boolean;
+            confirm?: string;
+            live?: string;
+            settings?: {
+                id: string;
+                label: string;
+                help?: string;
+                placeholder?: string;
+                pattern: string;
+            }[];
+            option?: {
+                field: string;
+                value: string;
+            };
+        }[];
+        registration: {
+            ok: boolean;
+            message: string;
+        } | null;
+    }>;
+    rotateEventSecret: (o: string, id: string, by: string) => Promise<{
+        subscription: import("./schema.js").components["schemas"]["EventSubscription"];
+        secret: string;
+    }>;
+    unsubscribeEvents: (o: string, id: string, by: string) => Promise<void>;
+    eventTriggers: (o: string, id: string) => Promise<{
+        id: string;
+        agentId: string;
+        connectorId: string;
+        enabled: boolean;
+        eventTypes: string[];
+        conditions: ({
+            field: string;
+            in: string[];
+        } | {
+            field: string;
+            notIn: string[];
+        })[];
+        prompt: string;
+        runner: string;
+        settings: {
+            [key: string]: unknown;
+        };
+        hasSigningSecret: boolean;
+        managedAgentId: string | null;
+        environmentId: string | null;
+        vaultIds: string[];
+        budgetCents: number;
+        maxRunsPerHour: number;
+        maxCentsPerDay: number;
+        maxConcurrent: number;
+        updatedBy: string | null;
+        updatedAt: string;
+    }[]>;
+    setEventTrigger: (o: string, id: string, a: string, body: EventTriggerInput) => Promise<{
+        id: string;
+        agentId: string;
+        connectorId: string;
+        enabled: boolean;
+        eventTypes: string[];
+        conditions: ({
+            field: string;
+            in: string[];
+        } | {
+            field: string;
+            notIn: string[];
+        })[];
+        prompt: string;
+        runner: string;
+        settings: {
+            [key: string]: unknown;
+        };
+        hasSigningSecret: boolean;
+        managedAgentId: string | null;
+        environmentId: string | null;
+        vaultIds: string[];
+        budgetCents: number;
+        maxRunsPerHour: number;
+        maxCentsPerDay: number;
+        maxConcurrent: number;
+        updatedBy: string | null;
+        updatedAt: string;
+    }>;
+    removeEventTrigger: (o: string, id: string, a: string, by: string) => Promise<void>;
+    eventRuns: (o: string, id: string, limit?: number) => Promise<{
+        id: string;
+        agentId: string;
+        triggerId: string;
+        connectorId: string;
+        eventType: string;
+        deliveryId: string;
+        runner: string;
+        sessionId: string | null;
+        state: "starting" | "running" | "ended" | "failed";
+        error: string | null;
+        costCents: number | null;
+        startedAt: string;
+        finishedAt: string | null;
+    }[]>;
     claudeKey: (o: string) => Promise<{
         set: false;
     } | {

package/lib/index.js

@@ -140,6 +140,18 @@ export function createClient(options) {
         teamsTrigger: (o, id) => maybe(`${agent(o, id)}/teams-trigger`),
         setTeamsTrigger: (o, id, body) => call("PUT", `${agent(o, id)}/teams-trigger`, body),
         teamsRuns: (o, id, limit = 20) => call("GET", `${agent(o, id)}/teams-runs?limit=${limit}`),
+        // App events that start agents (docs/triggers.md). A webhook's secret is in the answer to
+        // subscribeEvents and rotateEventSecret only.
+        eventSubscriptions: (o) => call("GET", `${org(o)}/event-subscriptions`),
+        subscribeEvents: (o, body) => call("POST", `${org(o)}/event-subscriptions`, body),
+        rotateEventSecret: (o, id, by) => call("POST", `${org(o)}/event-subscriptions/${seg(id)}/secret`, {
+            by,
+        }),
+        unsubscribeEvents: (o, id, by) => call("DELETE", `${org(o)}/event-subscriptions/${seg(id)}`, { by }),
+        eventTriggers: (o, id) => call("GET", `${agent(o, id)}/event-triggers`),
+        setEventTrigger: (o, id, a, body) => call("PUT", `${agent(o, id)}/event-triggers/${seg(a)}`, body),
+        removeEventTrigger: (o, id, a, by) => call("DELETE", `${agent(o, id)}/event-triggers/${seg(a)}`, { by }),
+        eventRuns: (o, id, limit = 20) => call("GET", `${agent(o, id)}/event-runs?limit=${limit}`),
         // The organization's Claude API key: write-only, shown by its last four characters.
         claudeKey: (o) => call("GET", `${org(o)}/claude-key`),
         setClaudeKey: (o, apiKey, by) => call("PUT", `${org(o)}/claude-key`, { apiKey, by }),
@@ -185,7 +197,7 @@ export function createClient(options) {
         async appStates(o, connectors, connections) {
             const apps = connectors.map((connector) => {
                 const connection = connections.find((c) => c.connectorId === connector.id) ?? null;
-                const liveSteps = chosenSteps(connector, [...connector.setup, ...connector.afterConnect], connection?.config ?? {}).filter((s) => s.live);
+                const liveSteps = chosenSteps(connector, [...connector.setup, ...connector.afterConnect], connection?.config ?? {}, connection?.capabilities ?? []).filter((s) => s.live);
                 return { connector, connection, liveSteps };
             });
             const liveSteps = apps.flatMap((a) => a.liveSteps);