@meetsmore-oss/use-ai-core 1.2.1

package/dist/types.d.ts

@@ -0,0 +1,248 @@
+import type { Tool, Message, Context, RunAgentInput, State, RunStartedEvent, RunFinishedEvent, RunErrorEvent, StepStartedEvent, StepFinishedEvent, TextMessageStartEvent, TextMessageContentEvent, TextMessageEndEvent, TextMessageChunkEvent, ToolCallStartEvent, ToolCallArgsEvent, ToolCallEndEvent, ToolCallChunkEvent, ToolCallResultEvent, StateSnapshotEvent, StateDeltaEvent, MessagesSnapshotEvent, RawEvent, CustomEvent, ActivitySnapshotEvent, ActivityDeltaEvent } from '@ag-ui/core';
+/**
+ * Error codes sent from server to client.
+ * Used to identify specific error types for proper handling and messaging.
+ */
+export declare enum ErrorCode {
+    /** Error when AI API is experiencing high load (HTTP 529) */
+    API_OVERLOADED = "API_OVERLOADED",
+    /** Error when rate limit is exceeded (HTTP 429) */
+    RATE_LIMITED = "RATE_LIMITED",
+    /** Generic error for unknown or unexpected errors */
+    UNKNOWN_ERROR = "UNKNOWN_ERROR"
+}
+export type { Tool, Message, Context, RunAgentInput, State, RunStartedEvent, RunFinishedEvent, RunErrorEvent, StepStartedEvent, StepFinishedEvent, TextMessageStartEvent, TextMessageContentEvent, TextMessageEndEvent, TextMessageChunkEvent, ToolCallStartEvent, ToolCallArgsEvent, ToolCallEndEvent, ToolCallChunkEvent, ToolCallResultEvent, StateSnapshotEvent, StateDeltaEvent, MessagesSnapshotEvent, RawEvent, CustomEvent, ActivitySnapshotEvent, ActivityDeltaEvent, };
+/**
+ * Extended tool definition with use-ai specific features.
+ * Extends AG-UI Tool type with confirmationRequired flag.
+ */
+export interface ToolDefinition {
+    /** The unique name of the tool */
+    name: string;
+    /** Human-readable description of what the tool does */
+    description: string;
+    /** JSON Schema describing the tool's input parameters */
+    parameters: {
+        type: 'object';
+        properties: Record<string, unknown>;
+        required?: string[];
+    };
+    /** Whether the tool requires explicit user confirmation before execution */
+    confirmationRequired?: boolean;
+}
+/**
+ * Base interface for all messages sent from client to server over WebSocket.
+ * Uses AG-UI RunAgentInput format for agent execution.
+ */
+export interface ClientMessage {
+    /** The type of message being sent */
+    type: 'run_agent' | 'tool_result' | 'abort_run';
+    /** The message payload */
+    data: unknown;
+}
+/**
+ * Message sent from client to server to run the agent.
+ * Includes tools, messages, and state using AG-UI RunAgentInput format.
+ */
+export interface RunAgentMessage {
+    type: 'run_agent';
+    data: RunAgentInput;
+}
+/**
+ * Message sent from client to server with the result of a tool execution.
+ * This maps to AG-UI ToolCallResultEvent.
+ */
+export interface ToolResultMessage {
+    type: 'tool_result';
+    data: {
+        /** Message ID for the tool result */
+        messageId: string;
+        /** The unique ID of the tool call being responded to */
+        toolCallId: string;
+        /** The result content (stringified) */
+        content: string;
+        /** Role is always 'tool' for tool results */
+        role: 'tool';
+    };
+}
+/**
+ * Message sent from client to server to abort a running agent execution.
+ */
+export interface AbortRunMessage {
+    type: 'abort_run';
+    data: {
+        /** Run ID to abort */
+        runId: string;
+    };
+}
+/**
+ * AG-UI event type - all events from server to client.
+ * Server emits AG-UI standard events.
+ */
+export type AGUIEvent = RunStartedEvent | RunFinishedEvent | RunErrorEvent | StepStartedEvent | StepFinishedEvent | TextMessageStartEvent | TextMessageContentEvent | TextMessageEndEvent | TextMessageChunkEvent | ToolCallStartEvent | ToolCallArgsEvent | ToolCallEndEvent | ToolCallChunkEvent | ToolCallResultEvent | StateSnapshotEvent | StateDeltaEvent | MessagesSnapshotEvent | ActivitySnapshotEvent | ActivityDeltaEvent | RawEvent | CustomEvent;
+export { EventType } from '@ag-ui/core';
+/**
+ * HTTP headers configuration for a single MCP endpoint.
+ * Can be used for authentication, custom headers, or any HTTP header needs.
+ */
+export interface McpHeadersConfig {
+    /** HTTP headers to send to the MCP endpoint */
+    headers: Record<string, string>;
+}
+/**
+ * Information about an available agent on the server.
+ */
+export interface AgentInfo {
+    /** The unique identifier/key for this agent */
+    id: string;
+    /** Human-readable name of the agent */
+    name: string;
+    /** Annotation/description shown in the agent selector UI */
+    annotation?: string;
+}
+/**
+ * Extended forwardedProps type for use-ai protocol.
+ * Uses AG-UI's forwardedProps extension point for use-ai specific features.
+ */
+export interface UseAIForwardedProps {
+    /** MCP headers configuration for MCP endpoint authentication */
+    mcpHeaders?: McpHeadersMap;
+    /** Agent ID to use for this request (falls back to server default if not specified) */
+    agent?: string;
+}
+/**
+ * Mapping of MCP endpoint patterns to HTTP headers configurations.
+ * Patterns can be:
+ * - Constant strings: `'https://api.example.com'` - Exact match
+ * - Glob patterns: `'https://*.meetsmore.com'` - Wildcard matching using picomatch
+ *
+ * @example
+ * ```typescript
+ * {
+ *   // Exact match
+ *   'https://api.example.com': {
+ *     headers: { 'Authorization': 'Bearer token123' }
+ *   },
+ *   // Wildcard subdomain
+ *   'https://*.meetsmore.com': {
+ *     headers: { 'X-API-Key': 'key456' }
+ *   },
+ *   // Multiple wildcards
+ *   '*://*.example.com': {
+ *     headers: { 'X-Custom': 'value' }
+ *   }
+ * }
+ * ```
+ */
+export type McpHeadersMap = Record<string, McpHeadersConfig>;
+/**
+ * Status of a workflow execution.
+ */
+export type WorkflowStatus = 'idle' | 'running' | 'completed' | 'error';
+/**
+ * Extended message type for use-ai.
+ * Includes AG-UI protocol messages ('run_agent', 'tool_result', 'abort_run')
+ * plus use-ai-specific extensions ('run_workflow').
+ *
+ * Note: This extends beyond AG-UI protocol to support headless workflow triggers.
+ * For AG-UI compliance, use ClientMessage instead.
+ */
+export interface UseAIClientMessage {
+    type: 'run_agent' | 'tool_result' | 'abort_run' | 'run_workflow';
+    data: unknown;
+}
+/**
+ * Message sent from client to server to run a workflow (headless execution).
+ *
+ * This is a use-ai-specific extension, NOT part of AG-UI protocol.
+ * Used for triggering workflows without chat UI (e.g., button click, file upload).
+ *
+ * Workflows differ from agents:
+ * - No conversation history (stateless)
+ * - No chat UI involvement
+ * - Can use external platforms (Dify, Flowise, etc.)
+ * - Still supports tool calls to frontend
+ *
+ * @example
+ * ```typescript
+ * socket.emit('message', {
+ *   type: 'run_workflow',
+ *   data: {
+ *     runner: 'dify',
+ *     workflowId: 'pdf-processor',
+ *     inputs: { file: pdfData },
+ *     tools: [insertTextTool],
+ *     runId: uuidv4(),
+ *     threadId: uuidv4(),
+ *   }
+ * });
+ * ```
+ */
+export interface RunWorkflowMessage {
+    type: 'run_workflow';
+    data: {
+        /** The runner to use (e.g., 'dify', 'flowise') */
+        runner: string;
+        /** The workflow identifier (depends on which platform you are using) */
+        workflowId: string;
+        /** Input data for the workflow */
+        inputs: Record<string, any>;
+        /** Available tools that the workflow can call */
+        tools?: ToolDefinition[];
+        /** Run ID for tracking */
+        runId: string;
+        /** Thread ID for conversation tracking */
+        threadId: string;
+        /**
+         * AG-UI extension point for additional fields in messages.
+         * We use it to send `mcpHeaders`.
+         * @see RunAgentInput['forwardedProps']
+         */
+        forwardedProps?: {
+            /**
+             * A map of current McpHeaders that should be applied to MCP tool calls (e.g. auth headers)
+             */
+            mcpHeaders?: McpHeadersMap;
+        };
+    };
+}
+/**
+ * Text content part for multimodal messages.
+ */
+export interface TextContent {
+    type: 'text';
+    text: string;
+}
+/**
+ * Image content part for multimodal messages.
+ * URL can be a data URL (base64) or a remote URL.
+ */
+export interface ImageContent {
+    type: 'image';
+    /** Image URL (data URL or remote URL) */
+    url: string;
+}
+/**
+ * File content part for multimodal messages.
+ * Used for non-image files like PDFs, documents, etc.
+ */
+export interface FileContent {
+    type: 'file';
+    /** File URL (data URL or remote URL) */
+    url: string;
+    /** MIME type of the file */
+    mimeType: string;
+    /** Original file name */
+    name: string;
+}
+/**
+ * Content part for multimodal messages.
+ * A message can contain multiple content parts of different types.
+ */
+export type MultimodalContent = TextContent | ImageContent | FileContent;
+/**
+ * User message content - can be a simple string or multimodal content array.
+ * When multimodal, the array can contain text, images, and files.
+ */
+export type UserMessageContent = string | MultimodalContent[];
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EAEL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EAEjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EAErB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EAEnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EAErB,QAAQ,EACR,WAAW,EAEX,qBAAqB,EACrB,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,oBAAY,SAAS;IACnB,6DAA6D;IAC7D,cAAc,mBAAmB;IACjC,mDAAmD;IACnD,YAAY,iBAAiB;IAC7B,qDAAqD;IACrD,aAAa,kBAAkB;CAChC;AAED,YAAY,EACV,IAAI,EACJ,OAAO,EACP,OAAO,EACP,aAAa,EACb,KAAK,EACL,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACrB,QAAQ,EACR,WAAW,EACX,qBAAqB,EACrB,kBAAkB,GACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,WAAW,EAAE,MAAM,CAAC;IACpB,yDAAyD;IACzD,UAAU,EAAE;QACV,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACpC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IACF,4EAA4E;IAC5E,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,qCAAqC;IACrC,IAAI,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,CAAC;IAChD,0BAA0B;IAC1B,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,aAAa,CAAC;IACpB,IAAI,EAAE;QACJ,qCAAqC;QACrC,SAAS,EAAE,MAAM,CAAC;QAClB,wDAAwD;QACxD,UAAU,EAAE,MAAM,CAAC;QACnB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,6CAA6C;QAC7C,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE;QACJ,sBAAsB;QACtB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;;GAGG;AACH,MAAM,MAAM,SAAS,GACjB,eAAe,GACf,gBAAgB,GAChB,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,qBAAqB,GACrB,uBAAuB,GACvB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,kBAAkB,GAClB,eAAe,GACf,qBAAqB,GACrB,qBAAqB,GACrB,kBAAkB,GAClB,QAAQ,GACR,WAAW,CAAC;AAGhB,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AASxC;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,4DAA4D;IAC5D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,gEAAgE;IAChE,UAAU,CAAC,EAAE,aAAa,CAAC;IAC3B,uFAAuF;IACvF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW,GAAG,OAAO,CAAC;AAExE;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,WAAW,GAAG,aAAa,GAAG,WAAW,GAAG,cAAc,CAAC;IACjE,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE;QACJ,kDAAkD;QAClD,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,UAAU,EAAE,MAAM,CAAC;QACnB,kCAAkC;QAClC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC5B,iDAAiD;QACjD,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;QACzB,0BAA0B;QAC1B,KAAK,EAAE,MAAM,CAAC;QACd,0CAA0C;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB;;;;WAIG;QACH,cAAc,CAAC,EAAE;YACf;;eAEG;YACH,UAAU,CAAC,EAAE,aAAa,CAAA;SAC3B,CAAA;KACF,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,yCAAyC;IACzC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAC;AAEzE;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,iBAAiB,EAAE,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@meetsmore-oss/use-ai-core",
+  "version": "1.2.1",
+  "license": "BUSL-1.1",
+  "files": [
+    "dist"
+  ],
+  "author": {
+    "name": "Zachary Davison",
+    "url": "https://github.com/mm-zacharydavison"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/meetsmore/use-ai.git",
+    "directory": "packages/core"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "build": "bun build ./src/index.ts --outdir ./dist --target node --format esm && tsc --emitDeclarationOnly --declaration --declarationMap"
+  },
+  "dependencies": {
+    "@ag-ui/core": "^0.0.41"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.9.3"
+  }
+}