footprintjs 3.0.20 → 3.0.21
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.
- package/README.md +34 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
<a href="https://www.npmjs.com/package/footprintjs"><img src="https://img.shields.io/npm/v/footprintjs.svg?style=flat" alt="npm version"></a>
|
|
11
11
|
<a href="https://github.com/footprintjs/footPrint/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License"></a>
|
|
12
12
|
<a href="https://www.npmjs.com/package/footprintjs"><img src="https://img.shields.io/npm/dm/footprintjs.svg" alt="Downloads"></a>
|
|
13
|
-
<a href="https://footprintjs.github.io/footprint-
|
|
14
|
-
<a href="https://footprintjs.github.io/footprint-playground/"><img src="https://img.shields.io/badge/Playground-
|
|
15
|
-
<a href="https://footprintjs.github.io/footPrint/"><img src="https://img.shields.io/badge/
|
|
13
|
+
<a href="https://footprintjs.github.io/footprint-playground/samples/llm-agent-tool"><img src="https://img.shields.io/badge/Try_with_LLM-Live_Demo-7c6cf0?style=flat" alt="Try with LLM"></a>
|
|
14
|
+
<a href="https://footprintjs.github.io/footprint-playground/"><img src="https://img.shields.io/badge/Playground-37%2B_samples-6366f1?style=flat" alt="Interactive Playground"></a>
|
|
15
|
+
<a href="https://footprintjs.github.io/footPrint/"><img src="https://img.shields.io/badge/Docs-footprintjs-3178c6?style=flat&logo=typescript&logoColor=white" alt="Docs"></a>
|
|
16
16
|
</p>
|
|
17
17
|
|
|
18
18
|
<br>
|
|
@@ -125,7 +125,25 @@ console.log(result.narrative);
|
|
|
125
125
|
|
|
126
126
|
> **[Try it in the browser](https://footprintjs.github.io/footprint-playground/)** — no install needed
|
|
127
127
|
>
|
|
128
|
-
> **[Browse
|
|
128
|
+
> **[Browse 37+ examples](https://footprintjs.github.io/footprint-playground/)** — patterns, recorders, subflows, integrations, and a full loan underwriting demo
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Try With Your LLM
|
|
133
|
+
|
|
134
|
+
Expose any flowchart as an MCP tool in one line — the description, input schema, and step list are auto-generated from the graph.
|
|
135
|
+
|
|
136
|
+
```typescript
|
|
137
|
+
const tool = chart.toMCPTool();
|
|
138
|
+
// { name: 'assesscredit', description: '1. AssessCredit\n2. ...', inputSchema: { ... } }
|
|
139
|
+
|
|
140
|
+
// Register with any MCP server or pass directly to the Anthropic SDK:
|
|
141
|
+
const anthropicTool = { name: tool.name, description: tool.description, input_schema: tool.inputSchema };
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
The LLM calls the tool, gets back the decision and causal trace, and explains the result to the user — all from the same graph that runs in production.
|
|
145
|
+
|
|
146
|
+
> **[Live demo: Claude calls a credit-decision flowchart as an MCP tool](https://footprintjs.github.io/footprint-playground/samples/llm-agent-tool)** — enter your API key, watch the tool call happen, see the trace.
|
|
129
147
|
|
|
130
148
|
---
|
|
131
149
|
|
|
@@ -137,12 +155,12 @@ console.log(result.narrative);
|
|
|
137
155
|
| **Decision Evidence** | `decide()` / `select()` auto-capture WHY a branch was chosen — operators, thresholds, pass/fail |
|
|
138
156
|
| **TypedScope<T>** | Typed property access — `scope.creditScore = 750` instead of `scope.setValue('creditScore', 750)` |
|
|
139
157
|
| **Auto Narrative** | Build-time descriptions for tool selection, runtime traces for explanation |
|
|
140
|
-
| **7 Patterns** | Linear, parallel fork, conditional, multi-select, subflow, streaming, loops
|
|
141
|
-
| **Transactional State** | Atomic commits, safe merges, time-travel replay
|
|
142
|
-
| **PII Redaction** | Per-key or declarative `RedactionPolicy` with audit trail
|
|
143
|
-
| **Flow Recorders** | 8 narrative strategies for loop compression
|
|
144
|
-
| **Contracts** | I/O schemas (Zod/JSON Schema) + OpenAPI 3.1
|
|
145
|
-
| **Cancellation** | AbortSignal, timeout, early termination via `
|
|
158
|
+
| **7 Patterns** | Linear, parallel fork, conditional, multi-select, subflow, streaming, loops |
|
|
159
|
+
| **Transactional State** | Atomic commits, safe merges, time-travel replay |
|
|
160
|
+
| **PII Redaction** | Per-key or declarative `RedactionPolicy` with audit trail |
|
|
161
|
+
| **Flow Recorders** | 8 narrative strategies for loop compression |
|
|
162
|
+
| **Contracts** | I/O schemas (Zod/JSON Schema) + OpenAPI 3.1 + MCP tool generation |
|
|
163
|
+
| **Cancellation** | AbortSignal, timeout, early termination via `scope.$break()` |
|
|
146
164
|
|
|
147
165
|
---
|
|
148
166
|
|
|
@@ -151,7 +169,8 @@ console.log(result.narrative);
|
|
|
151
169
|
FootPrint ships with built-in instructions for every major AI coding assistant. Your AI tool understands the API, patterns, and anti-patterns out of the box.
|
|
152
170
|
|
|
153
171
|
```bash
|
|
154
|
-
|
|
172
|
+
# Download and run the setup script from GitHub
|
|
173
|
+
npx degit footprintjs/footPrint/ai-instructions footprint-ai && bash footprint-ai/setup.sh && rm -rf footprint-ai
|
|
155
174
|
```
|
|
156
175
|
|
|
157
176
|
| Tool | What gets installed |
|
|
@@ -170,10 +189,10 @@ npx footprintjs-setup
|
|
|
170
189
|
|
|
171
190
|
| Resource | Link |
|
|
172
191
|
|----------|------|
|
|
173
|
-
| **
|
|
174
|
-
| **
|
|
175
|
-
| **
|
|
176
|
-
| **Try it** | [Interactive Playground](https://footprintjs.github.io/footprint-playground/) · [
|
|
192
|
+
| **Getting Started** | [Quick Start](https://footprintjs.github.io/footPrint/getting-started/quick-start/) · [Key Concepts](https://footprintjs.github.io/footPrint/getting-started/key-concepts/) · [Why footprintjs?](https://footprintjs.github.io/footPrint/getting-started/why/) |
|
|
193
|
+
| **Guides** | [Building](https://footprintjs.github.io/footPrint/guides/building/) · [Decision branching](https://footprintjs.github.io/footPrint/guides/decision-branching/) · [Recorders](https://footprintjs.github.io/footPrint/guides/recording/) · [Subflows](https://footprintjs.github.io/footPrint/guides/subflows/) · [Self-describing APIs](https://footprintjs.github.io/footPrint/guides/self-describing/) |
|
|
194
|
+
| **API Reference** | [flowChart() / Builder](https://footprintjs.github.io/footPrint/api/flowchart/) · [decide() / select()](https://footprintjs.github.io/footPrint/api/decide/) · [FlowChartExecutor](https://footprintjs.github.io/footPrint/api/executor/) · [Recorders](https://footprintjs.github.io/footPrint/api/recorders/) · [Contract & Self-describing](https://footprintjs.github.io/footPrint/api/contract/) |
|
|
195
|
+
| **Try it** | [Interactive Playground](https://footprintjs.github.io/footprint-playground/) · [Try with your LLM](https://footprintjs.github.io/footprint-playground/try-with-ai) · [Live Demo](https://footprintjs.github.io/footprint-demo/) |
|
|
177
196
|
|
|
178
197
|
---
|
|
179
198
|
|
package/package.json
CHANGED