agentfootprint 2.2.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/AGENTS.md +52 -0
  2. package/CLAUDE.md +52 -0
  3. package/README.md +286 -209
  4. package/ai-instructions/claude-code/SKILL.md +24 -5
  5. package/ai-instructions/clinerules +22 -5
  6. package/ai-instructions/copilot-instructions.md +22 -5
  7. package/ai-instructions/cursor/agentfootprint.md +22 -5
  8. package/ai-instructions/kiro/agentfootprint.md +22 -5
  9. package/ai-instructions/windsurfrules +22 -5
  10. package/dist/adapters/llm/AnthropicProvider.js +0 -31
  11. package/dist/adapters/llm/AnthropicProvider.js.map +1 -1
  12. package/dist/adapters/llm/BedrockProvider.js +2 -28
  13. package/dist/adapters/llm/BedrockProvider.js.map +1 -1
  14. package/dist/adapters/llm/BrowserAnthropicProvider.js +1 -31
  15. package/dist/adapters/llm/BrowserAnthropicProvider.js.map +1 -1
  16. package/dist/adapters/llm/BrowserOpenAIProvider.js +1 -11
  17. package/dist/adapters/llm/BrowserOpenAIProvider.js.map +1 -1
  18. package/dist/adapters/llm/MockProvider.js +35 -1
  19. package/dist/adapters/llm/MockProvider.js.map +1 -1
  20. package/dist/adapters/llm/OpenAIProvider.js +3 -29
  21. package/dist/adapters/llm/OpenAIProvider.js.map +1 -1
  22. package/dist/adapters/memory/agentcore.js +305 -0
  23. package/dist/adapters/memory/agentcore.js.map +1 -0
  24. package/dist/adapters/memory/redis.js +287 -0
  25. package/dist/adapters/memory/redis.js.map +1 -0
  26. package/dist/core/Agent.js +16 -0
  27. package/dist/core/Agent.js.map +1 -1
  28. package/dist/esm/adapters/llm/AnthropicProvider.js +0 -31
  29. package/dist/esm/adapters/llm/AnthropicProvider.js.map +1 -1
  30. package/dist/esm/adapters/llm/BedrockProvider.js +2 -28
  31. package/dist/esm/adapters/llm/BedrockProvider.js.map +1 -1
  32. package/dist/esm/adapters/llm/BrowserAnthropicProvider.js +1 -31
  33. package/dist/esm/adapters/llm/BrowserAnthropicProvider.js.map +1 -1
  34. package/dist/esm/adapters/llm/BrowserOpenAIProvider.js +1 -11
  35. package/dist/esm/adapters/llm/BrowserOpenAIProvider.js.map +1 -1
  36. package/dist/esm/adapters/llm/MockProvider.js +35 -1
  37. package/dist/esm/adapters/llm/MockProvider.js.map +1 -1
  38. package/dist/esm/adapters/llm/OpenAIProvider.js +3 -29
  39. package/dist/esm/adapters/llm/OpenAIProvider.js.map +1 -1
  40. package/dist/esm/adapters/memory/agentcore.js +301 -0
  41. package/dist/esm/adapters/memory/agentcore.js.map +1 -0
  42. package/dist/esm/adapters/memory/redis.js +283 -0
  43. package/dist/esm/adapters/memory/redis.js.map +1 -0
  44. package/dist/esm/core/Agent.js +16 -0
  45. package/dist/esm/core/Agent.js.map +1 -1
  46. package/dist/esm/index.js +3 -3
  47. package/dist/esm/index.js.map +1 -1
  48. package/dist/esm/lib/injection-engine/SkillRegistry.js +83 -0
  49. package/dist/esm/lib/injection-engine/SkillRegistry.js.map +1 -0
  50. package/dist/esm/lib/injection-engine/factories/defineSkill.js +34 -0
  51. package/dist/esm/lib/injection-engine/factories/defineSkill.js.map +1 -1
  52. package/dist/esm/lib/injection-engine/index.js +2 -55
  53. package/dist/esm/lib/injection-engine/index.js.map +1 -1
  54. package/dist/esm/lib/injection-engine/types.js.map +1 -1
  55. package/dist/esm/lib/mcp/index.js +1 -0
  56. package/dist/esm/lib/mcp/index.js.map +1 -1
  57. package/dist/esm/lib/mcp/mcpClient.js +29 -24
  58. package/dist/esm/lib/mcp/mcpClient.js.map +1 -1
  59. package/dist/esm/lib/mcp/mockMcpClient.js +97 -0
  60. package/dist/esm/lib/mcp/mockMcpClient.js.map +1 -0
  61. package/dist/esm/lib/rag/defineRAG.js +0 -18
  62. package/dist/esm/lib/rag/defineRAG.js.map +1 -1
  63. package/dist/esm/lib/rag/indexDocuments.js +39 -4
  64. package/dist/esm/lib/rag/indexDocuments.js.map +1 -1
  65. package/dist/esm/memory/causal/loadSnapshot.js +1 -1
  66. package/dist/esm/memory/define.js +0 -14
  67. package/dist/esm/memory/define.js.map +1 -1
  68. package/dist/esm/memory/define.types.js +0 -10
  69. package/dist/esm/memory/define.types.js.map +1 -1
  70. package/dist/esm/resilience/index.js +0 -44
  71. package/dist/esm/resilience/index.js.map +1 -1
  72. package/dist/esm/stream.js +0 -29
  73. package/dist/esm/stream.js.map +1 -1
  74. package/dist/index.js +4 -1
  75. package/dist/index.js.map +1 -1
  76. package/dist/lib/injection-engine/SkillRegistry.js +87 -0
  77. package/dist/lib/injection-engine/SkillRegistry.js.map +1 -0
  78. package/dist/lib/injection-engine/factories/defineSkill.js +36 -1
  79. package/dist/lib/injection-engine/factories/defineSkill.js.map +1 -1
  80. package/dist/lib/injection-engine/index.js +4 -55
  81. package/dist/lib/injection-engine/index.js.map +1 -1
  82. package/dist/lib/injection-engine/types.js.map +1 -1
  83. package/dist/lib/mcp/index.js +3 -1
  84. package/dist/lib/mcp/index.js.map +1 -1
  85. package/dist/lib/mcp/mcpClient.js +29 -24
  86. package/dist/lib/mcp/mcpClient.js.map +1 -1
  87. package/dist/lib/mcp/mockMcpClient.js +101 -0
  88. package/dist/lib/mcp/mockMcpClient.js.map +1 -0
  89. package/dist/lib/rag/defineRAG.js +0 -18
  90. package/dist/lib/rag/defineRAG.js.map +1 -1
  91. package/dist/lib/rag/indexDocuments.js +39 -4
  92. package/dist/lib/rag/indexDocuments.js.map +1 -1
  93. package/dist/memory/causal/loadSnapshot.js +1 -1
  94. package/dist/memory/define.js +0 -14
  95. package/dist/memory/define.js.map +1 -1
  96. package/dist/memory/define.types.js +0 -10
  97. package/dist/memory/define.types.js.map +1 -1
  98. package/dist/resilience/index.js +0 -44
  99. package/dist/resilience/index.js.map +1 -1
  100. package/dist/stream.js +0 -29
  101. package/dist/stream.js.map +1 -1
  102. package/dist/types/adapters/llm/AnthropicProvider.d.ts +0 -31
  103. package/dist/types/adapters/llm/AnthropicProvider.d.ts.map +1 -1
  104. package/dist/types/adapters/llm/BedrockProvider.d.ts +2 -28
  105. package/dist/types/adapters/llm/BedrockProvider.d.ts.map +1 -1
  106. package/dist/types/adapters/llm/BrowserAnthropicProvider.d.ts +1 -31
  107. package/dist/types/adapters/llm/BrowserAnthropicProvider.d.ts.map +1 -1
  108. package/dist/types/adapters/llm/BrowserOpenAIProvider.d.ts +1 -11
  109. package/dist/types/adapters/llm/BrowserOpenAIProvider.d.ts.map +1 -1
  110. package/dist/types/adapters/llm/MockProvider.d.ts +45 -0
  111. package/dist/types/adapters/llm/MockProvider.d.ts.map +1 -1
  112. package/dist/types/adapters/llm/OpenAIProvider.d.ts +3 -29
  113. package/dist/types/adapters/llm/OpenAIProvider.d.ts.map +1 -1
  114. package/dist/types/adapters/memory/agentcore.d.ts +157 -0
  115. package/dist/types/adapters/memory/agentcore.d.ts.map +1 -0
  116. package/dist/types/adapters/memory/redis.d.ts +126 -0
  117. package/dist/types/adapters/memory/redis.d.ts.map +1 -0
  118. package/dist/types/core/Agent.d.ts +14 -0
  119. package/dist/types/core/Agent.d.ts.map +1 -1
  120. package/dist/types/index.d.ts +3 -3
  121. package/dist/types/index.d.ts.map +1 -1
  122. package/dist/types/lib/injection-engine/SkillRegistry.d.ts +50 -0
  123. package/dist/types/lib/injection-engine/SkillRegistry.d.ts.map +1 -0
  124. package/dist/types/lib/injection-engine/factories/defineSkill.d.ts +72 -0
  125. package/dist/types/lib/injection-engine/factories/defineSkill.d.ts.map +1 -1
  126. package/dist/types/lib/injection-engine/index.d.ts +2 -55
  127. package/dist/types/lib/injection-engine/index.d.ts.map +1 -1
  128. package/dist/types/lib/injection-engine/types.d.ts +10 -0
  129. package/dist/types/lib/injection-engine/types.d.ts.map +1 -1
  130. package/dist/types/lib/mcp/index.d.ts +1 -0
  131. package/dist/types/lib/mcp/index.d.ts.map +1 -1
  132. package/dist/types/lib/mcp/mcpClient.d.ts +0 -17
  133. package/dist/types/lib/mcp/mcpClient.d.ts.map +1 -1
  134. package/dist/types/lib/mcp/mockMcpClient.d.ts +66 -0
  135. package/dist/types/lib/mcp/mockMcpClient.d.ts.map +1 -0
  136. package/dist/types/lib/mcp/types.d.ts +2 -0
  137. package/dist/types/lib/mcp/types.d.ts.map +1 -1
  138. package/dist/types/lib/rag/defineRAG.d.ts +18 -21
  139. package/dist/types/lib/rag/defineRAG.d.ts.map +1 -1
  140. package/dist/types/lib/rag/indexDocuments.d.ts +30 -1
  141. package/dist/types/lib/rag/indexDocuments.d.ts.map +1 -1
  142. package/dist/types/memory/causal/loadSnapshot.d.ts +1 -1
  143. package/dist/types/memory/define.d.ts +0 -14
  144. package/dist/types/memory/define.d.ts.map +1 -1
  145. package/dist/types/memory/define.types.d.ts +2 -12
  146. package/dist/types/memory/define.types.d.ts.map +1 -1
  147. package/dist/types/resilience/index.d.ts +0 -44
  148. package/dist/types/resilience/index.d.ts.map +1 -1
  149. package/dist/types/stream.d.ts +0 -29
  150. package/dist/types/stream.d.ts.map +1 -1
  151. package/package.json +39 -1
@@ -7,35 +7,6 @@
7
7
  * framework that accepts an async iterable response body
8
8
  * (Fetch Response, Express res.write, Hono streaming, etc.).
9
9
  * Emits: N/A — observes only.
10
- *
11
- * ─── 7-panel design review (2026-04-28) ─────────────────────────────
12
- *
13
- * LLM-AI system design ✓ One-line-per-event SSE format. Each
14
- * event = one observation; each chunk
15
- * includes the `runtimeStageId` for
16
- * cross-view binding.
17
- * Performance ✓ AsyncIterable<string> — no buffering;
18
- * yields each event as it arrives. Stops
19
- * naturally when the run completes.
20
- * Scalability ✓ Per-run instance. No shared state;
21
- * many concurrent SSE streams safe.
22
- * Research alignment ✓ Standard SSE wire format
23
- * (text/event-stream). Browsers'
24
- * native EventSource API consumes directly.
25
- * Flexibility ✓ `format` option for full event payload
26
- * vs slim text-only mode (chat UIs that
27
- * only want token deltas). `filter`
28
- * predicate gates events.
29
- * Abstraction-modular ✓ One function (`toSSE`) + one class
30
- * (`SSEFormatter`); class is sugar for
31
- * consumers who prefer .pipeTo() shape.
32
- * Software engineering ✓ Pure observer. No global state. Tests
33
- * cover unit + scenario + property +
34
- * security + performance.
35
- *
36
- * ─── 7-pattern test coverage ────────────────────────────────────────
37
- *
38
- * See `test/stream/unit/SSEFormatter.test.ts`.
39
10
  */
40
11
  import type { AgentfootprintEvent } from './events/registry.js';
41
12
  import type { RunnerBase } from './core/RunnerBase.js';
@@ -1 +1 @@
1
- {"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,OAAO,CAAC;IAC1D;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,MAAM,CAAC;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,wBAAuB,KAAK,CAAC,GAAG,EAAE,IAAI,EACpC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,EAC7B,OAAO,GAAE,YAAiB,GACzB,aAAa,CAAC,MAAM,CAAC,CA0EvB;AAED;;;GAGG;AACH,qBAAa,YAAY,CAAC,GAAG,GAAG,OAAO,EAAE,IAAI,GAAG,OAAO;IAEnD,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,EAC7B,OAAO,GAAE,YAAiB;IAG7C,8DAA8D;IAC9D,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC;CAGhC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAMrE"}
1
+ {"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../../src/stream.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAChE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAGvD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,OAAO,CAAC;IAC1D;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAClC;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,MAAM,CAAC;IAC5D;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;GAGG;AACH,wBAAuB,KAAK,CAAC,GAAG,EAAE,IAAI,EACpC,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,EAC7B,OAAO,GAAE,YAAiB,GACzB,aAAa,CAAC,MAAM,CAAC,CA0EvB;AAED;;;GAGG;AACH,qBAAa,YAAY,CAAC,GAAG,GAAG,OAAO,EAAE,IAAI,GAAG,OAAO;IAEnD,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBADP,MAAM,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,EAC7B,OAAO,GAAE,YAAiB;IAG7C,8DAA8D;IAC9D,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC;CAGhC;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAMrE"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "agentfootprint",
3
- "version": "2.2.0",
3
+ "version": "2.4.0",
4
4
  "description": "The explainable agent framework — build AI agents you can explain, audit, and trust. Built on footprintjs.",
5
5
  "license": "MIT",
6
6
  "author": "Sanjay Krishna Anbalagan",
@@ -52,10 +52,12 @@
52
52
  "build": "tsc && tsc -p tsconfig.esm.json",
53
53
  "watch": "tsc -w",
54
54
  "test": "vitest run",
55
+ "test:coverage": "vitest run --coverage",
55
56
  "test:examples": "tsc -p examples/tsconfig.json && bash scripts/run-all-examples.sh",
56
57
  "test:examples:typecheck": "tsc -p examples/tsconfig.json",
57
58
  "example": "TSX_TSCONFIG_PATH=examples/runtime.tsconfig.json npx --yes tsx",
58
59
  "test:watch": "vitest --watch",
60
+ "docs:api": "typedoc",
59
61
  "lint": "eslint 'src/**/*.ts' 'test/**/*.ts' --ext .ts",
60
62
  "lint:fix": "eslint 'src/**/*.ts' 'test/**/*.ts' --ext .ts --fix",
61
63
  "format": "prettier --config .prettierrc.js --list-different 'src/**/*.ts' 'test/**/*.ts'",
@@ -114,20 +116,56 @@
114
116
  "types": "./dist/types/injection-engine.d.ts",
115
117
  "import": "./dist/esm/injection-engine.js",
116
118
  "require": "./dist/injection-engine.js"
119
+ },
120
+ "./memory-redis": {
121
+ "types": "./dist/types/adapters/memory/redis.d.ts",
122
+ "import": "./dist/esm/adapters/memory/redis.js",
123
+ "require": "./dist/adapters/memory/redis.js"
124
+ },
125
+ "./memory-agentcore": {
126
+ "types": "./dist/types/adapters/memory/agentcore.d.ts",
127
+ "import": "./dist/esm/adapters/memory/agentcore.js",
128
+ "require": "./dist/adapters/memory/agentcore.js"
117
129
  }
118
130
  },
119
131
  "sideEffects": false,
120
132
  "peerDependencies": {
121
133
  "footprintjs": ">=4.14.0"
122
134
  },
135
+ "peerDependenciesMeta": {
136
+ "@anthropic-ai/sdk": {
137
+ "optional": true
138
+ },
139
+ "openai": {
140
+ "optional": true
141
+ },
142
+ "@aws-sdk/client-bedrock-runtime": {
143
+ "optional": true
144
+ },
145
+ "@aws-sdk/client-bedrock-agent-runtime": {
146
+ "optional": true
147
+ },
148
+ "@modelcontextprotocol/sdk": {
149
+ "optional": true
150
+ },
151
+ "ioredis": {
152
+ "optional": true
153
+ },
154
+ "zod": {
155
+ "optional": true
156
+ }
157
+ },
123
158
  "devDependencies": {
124
159
  "@types/node": "^25.5.2",
125
160
  "@typescript-eslint/eslint-plugin": "^5.61.0",
126
161
  "@typescript-eslint/parser": "^5.61.0",
162
+ "@vitest/coverage-v8": "^4.1.5",
127
163
  "eslint": "^8.44.0",
128
164
  "eslint-config-prettier": "^6.15.0",
129
165
  "footprintjs": "^4.14.0",
130
166
  "prettier": "^2.8.1",
167
+ "typedoc": "^0.28.19",
168
+ "typedoc-plugin-markdown": "^4.11.0",
131
169
  "typescript": "~5.4.5",
132
170
  "vitest": "^4.1.5",
133
171
  "zod": "^3.25.76"