borderless-agent 0.0.1-alpha.1

package/dist/types.d.ts

@@ -0,0 +1,144 @@
+/**
+ * types.ts — Public type definitions for the agentic-system library.
+ *
+ * Users import these to define tools, skills, and configure agents.
+ */
+import type { LLMProvider } from './llmProtocol';
+/**
+ * A tool the agent can call. Users provide `execute` — the runtime handler.
+ *
+ * @example
+ * ```ts
+ * const searchTool: ToolDefinition = {
+ *   name: 'search_docs',
+ *   description: 'Search project documentation',
+ *   parameters: {
+ *     query: { type: 'string', description: 'Search query' },
+ *   },
+ *   required: ['query'],
+ *   execute: async (args) => {
+ *     const results = await mySearch(args.query);
+ *     return JSON.stringify(results);
+ *   },
+ * };
+ * ```
+ */
+export interface ToolDefinition {
+    /** Unique tool name (used by the LLM to invoke it). */
+    name: string;
+    /** Human-readable description shown to the LLM. */
+    description: string;
+    /**
+     * JSON-Schema-style parameter map.
+     * Keys are param names, values describe the type.
+     */
+    parameters?: Record<string, {
+        type: string;
+        description?: string;
+        enum?: string[];
+    }>;
+    /** Names of required parameters. */
+    required?: string[];
+    /**
+     * Runtime handler. Receives parsed arguments, returns a string result
+     * that is fed back to the LLM as the tool observation.
+     */
+    execute: (args: Record<string, any>) => Promise<string> | string;
+    /**
+     * If true, the tool is mutating and requires user approval before
+     * execution (only relevant when approval callbacks are set).
+     */
+    requiresApproval?: boolean;
+}
+/**
+ * A skill that can be loaded by the agent on demand via the Skill tool.
+ *
+ * @example
+ * ```ts
+ * const pythonSkill: SkillDefinition = {
+ *   name: 'python-expert',
+ *   description: 'Expert knowledge about Python best practices',
+ *   body: '## Python style guide\n- Use type hints...',
+ * };
+ * ```
+ */
+export interface SkillDefinition {
+    name: string;
+    description: string;
+    /** Markdown body injected into context when the skill is loaded. */
+    body: string;
+}
+export interface LLMConfig {
+    apiKey: string;
+    model?: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+export interface StorageConfig {
+    backend: 'file' | 'cloud' | 'memory';
+    /** For file backend: root directory for all data. */
+    dir?: string;
+    /** For cloud backend: S3 bucket name. */
+    bucket?: string;
+    /** For cloud backend: S3 endpoint URL. */
+    endpoint?: string;
+    /** For cloud backend: AWS region. */
+    region?: string;
+}
+export interface AgentConfig {
+    /** LLM provider instance (takes precedence over llmConfig). */
+    llm?: LLMProvider;
+    /** LLM connection config (used if llm is not provided). */
+    llmConfig?: LLMConfig;
+    /** Base system prompt. */
+    systemPrompt?: string;
+    /** User-defined tools. */
+    tools?: ToolDefinition[];
+    /** User-defined skills. */
+    skills?: SkillDefinition[];
+    /** Include built-in tools (bash, read_file, etc.). Default: true. */
+    includeBuiltinTools?: boolean;
+    /** Storage config. */
+    storage?: StorageConfig;
+    /** Enable long-term memory. Default: false. */
+    enableMemory?: boolean;
+    /** Enable streaming by default. Default: false. */
+    enableStreaming?: boolean;
+    /** Enable context management (history trimming, budgeting). Default: true. */
+    enableContext?: boolean;
+    /** Max tool rounds per turn. Default: 20. */
+    maxToolRounds?: number;
+    /** Callback for executor approval. Return true to approve. */
+    approvalCallback?: (toolName: string, args: Record<string, any>) => Promise<boolean> | boolean;
+}
+export interface ChatResult {
+    /** Final assistant text. */
+    reply: string;
+    /** Full updated message history. */
+    history: Record<string, any>[];
+    /** Whether tools were called during this turn. */
+    hadToolCalls: boolean;
+    /** Session ID (if session is active). */
+    sessionId?: string;
+}
+export interface StreamChunk {
+    /** Content delta (partial text). Present on streaming chunks. */
+    delta?: string;
+    /** Final reply. Present on the last chunk. */
+    reply?: string;
+    /** Whether this is the final chunk. */
+    done: boolean;
+}
+export interface AgentSession {
+    /** Session identifier. */
+    readonly id: string;
+    /** Send a message within this session (preserves history). */
+    chat(message: string): Promise<ChatResult>;
+    /** Stream a message within this session. */
+    stream(message: string): AsyncGenerator<StreamChunk>;
+    /** Get the current conversation history. */
+    getHistory(): Record<string, any>[];
+    /** Persist the session to storage. */
+    save(): Promise<void>;
+}
+//# 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":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAMjD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,cAAc;IAC3B,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IACrF,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACjE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAMD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;CAChB;AAMD,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC1B,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IACrC,qDAAqD;IACrD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IACxB,+DAA+D;IAC/D,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,2DAA2D;IAC3D,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0BAA0B;IAC1B,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,2BAA2B;IAC3B,MAAM,CAAC,EAAE,eAAe,EAAE,CAAC;IAC3B,qEAAqE;IACrE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,sBAAsB;IACtB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,+CAA+C;IAC/C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mDAAmD;IACnD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,8EAA8E;IAC9E,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;CAClG;AAMD,MAAM,WAAW,UAAU;IACvB,4BAA4B;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IAC/B,kDAAkD;IAClD,YAAY,EAAE,OAAO,CAAC;IACtB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,IAAI,EAAE,OAAO,CAAC;CACjB;AAMD,MAAM,WAAW,YAAY;IACzB,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,4CAA4C;IAC5C,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IACrD,4CAA4C;IAC5C,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IACpC,sCAAsC;IACtC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB"}

package/dist/types.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * types.ts — Public type definitions for the agentic-system library.
+ *
+ * Users import these to define tools, skills, and configure agents.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "borderless-agent",
+  "version": "0.0.1-alpha.1",
+  "description": "Portable agentic AI framework — build agents with custom tools, skills, and system prompts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/main.js",
+    "dev": "npx ts-node src/main.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "agent",
+    "ai",
+    "llm",
+    "openai",
+    "tools",
+    "skills"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "openai": "^4.50.0",
+    "dotenv": "^16.4.0",
+    "express": "^4.18.0",
+    "uuid": "^9.0.0",
+    "@aws-sdk/client-s3": "^3.500.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.0",
+    "@types/node": "^20.11.0",
+    "@types/express": "^4.17.21",
+    "@types/uuid": "^9.0.7",
+    "ts-node": "^10.9.0"
+  }
+}