@falai/agent 0.6.8 → 0.7.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 (231) hide show
  1. package/README.md +62 -59
  2. package/dist/adapters/MemoryAdapter.js +2 -2
  3. package/dist/adapters/MemoryAdapter.js.map +1 -1
  4. package/dist/adapters/MongoAdapter.js +2 -2
  5. package/dist/adapters/MongoAdapter.js.map +1 -1
  6. package/dist/adapters/OpenSearchAdapter.js +7 -7
  7. package/dist/adapters/OpenSearchAdapter.js.map +1 -1
  8. package/dist/adapters/PostgreSQLAdapter.js +9 -9
  9. package/dist/adapters/PostgreSQLAdapter.js.map +1 -1
  10. package/dist/adapters/PrismaAdapter.js +3 -3
  11. package/dist/adapters/PrismaAdapter.js.map +1 -1
  12. package/dist/adapters/RedisAdapter.js +2 -2
  13. package/dist/adapters/RedisAdapter.js.map +1 -1
  14. package/dist/adapters/SQLiteAdapter.d.ts +3 -3
  15. package/dist/adapters/SQLiteAdapter.d.ts.map +1 -1
  16. package/dist/adapters/SQLiteAdapter.js +11 -11
  17. package/dist/adapters/SQLiteAdapter.js.map +1 -1
  18. package/dist/adapters/index.d.ts +1 -1
  19. package/dist/adapters/index.d.ts.map +1 -1
  20. package/dist/cjs/adapters/MemoryAdapter.js +2 -2
  21. package/dist/cjs/adapters/MemoryAdapter.js.map +1 -1
  22. package/dist/cjs/adapters/MongoAdapter.js +2 -2
  23. package/dist/cjs/adapters/MongoAdapter.js.map +1 -1
  24. package/dist/cjs/adapters/OpenSearchAdapter.js +7 -7
  25. package/dist/cjs/adapters/OpenSearchAdapter.js.map +1 -1
  26. package/dist/cjs/adapters/PostgreSQLAdapter.js +9 -9
  27. package/dist/cjs/adapters/PostgreSQLAdapter.js.map +1 -1
  28. package/dist/cjs/adapters/PrismaAdapter.js +3 -3
  29. package/dist/cjs/adapters/PrismaAdapter.js.map +1 -1
  30. package/dist/cjs/adapters/RedisAdapter.js +2 -2
  31. package/dist/cjs/adapters/RedisAdapter.js.map +1 -1
  32. package/dist/cjs/adapters/SQLiteAdapter.d.ts +3 -3
  33. package/dist/cjs/adapters/SQLiteAdapter.d.ts.map +1 -1
  34. package/dist/cjs/adapters/SQLiteAdapter.js +11 -11
  35. package/dist/cjs/adapters/SQLiteAdapter.js.map +1 -1
  36. package/dist/cjs/adapters/index.d.ts +1 -1
  37. package/dist/cjs/adapters/index.d.ts.map +1 -1
  38. package/dist/cjs/constants/index.d.ts +4 -4
  39. package/dist/cjs/constants/index.js +5 -5
  40. package/dist/cjs/core/Agent.d.ts +22 -22
  41. package/dist/cjs/core/Agent.d.ts.map +1 -1
  42. package/dist/cjs/core/Agent.js +160 -152
  43. package/dist/cjs/core/Agent.js.map +1 -1
  44. package/dist/cjs/core/Events.d.ts +6 -6
  45. package/dist/cjs/core/Events.d.ts.map +1 -1
  46. package/dist/cjs/core/PersistenceManager.d.ts +13 -13
  47. package/dist/cjs/core/PersistenceManager.d.ts.map +1 -1
  48. package/dist/cjs/core/PersistenceManager.js +24 -24
  49. package/dist/cjs/core/PersistenceManager.js.map +1 -1
  50. package/dist/cjs/core/ResponseEngine.d.ts +3 -8
  51. package/dist/cjs/core/ResponseEngine.d.ts.map +1 -1
  52. package/dist/cjs/core/ResponseEngine.js +8 -8
  53. package/dist/cjs/core/ResponseEngine.js.map +1 -1
  54. package/dist/cjs/core/Route.d.ts +17 -17
  55. package/dist/cjs/core/Route.d.ts.map +1 -1
  56. package/dist/cjs/core/Route.js +33 -33
  57. package/dist/cjs/core/Route.js.map +1 -1
  58. package/dist/cjs/core/RoutingEngine.d.ts +30 -30
  59. package/dist/cjs/core/RoutingEngine.d.ts.map +1 -1
  60. package/dist/cjs/core/RoutingEngine.js +192 -192
  61. package/dist/cjs/core/RoutingEngine.js.map +1 -1
  62. package/dist/cjs/core/Step.d.ts +72 -0
  63. package/dist/cjs/core/Step.d.ts.map +1 -0
  64. package/dist/cjs/core/Step.js +150 -0
  65. package/dist/cjs/core/Step.js.map +1 -0
  66. package/dist/cjs/core/ToolExecutor.d.ts +5 -5
  67. package/dist/cjs/core/ToolExecutor.d.ts.map +1 -1
  68. package/dist/cjs/core/ToolExecutor.js +8 -8
  69. package/dist/cjs/core/ToolExecutor.js.map +1 -1
  70. package/dist/cjs/core/Transition.d.ts +14 -14
  71. package/dist/cjs/core/Transition.d.ts.map +1 -1
  72. package/dist/cjs/core/Transition.js +48 -19
  73. package/dist/cjs/core/Transition.js.map +1 -1
  74. package/dist/cjs/index.d.ts +7 -7
  75. package/dist/cjs/index.d.ts.map +1 -1
  76. package/dist/cjs/index.js +8 -8
  77. package/dist/cjs/index.js.map +1 -1
  78. package/dist/cjs/types/agent.d.ts +8 -8
  79. package/dist/cjs/types/agent.d.ts.map +1 -1
  80. package/dist/cjs/types/ai.d.ts +2 -2
  81. package/dist/cjs/types/ai.d.ts.map +1 -1
  82. package/dist/cjs/types/history.d.ts +3 -3
  83. package/dist/cjs/types/history.d.ts.map +1 -1
  84. package/dist/cjs/types/index.d.ts +1 -1
  85. package/dist/cjs/types/index.d.ts.map +1 -1
  86. package/dist/cjs/types/persistence.d.ts +5 -5
  87. package/dist/cjs/types/persistence.d.ts.map +1 -1
  88. package/dist/cjs/types/route.d.ts +57 -52
  89. package/dist/cjs/types/route.d.ts.map +1 -1
  90. package/dist/cjs/types/session.d.ts +27 -27
  91. package/dist/cjs/types/session.d.ts.map +1 -1
  92. package/dist/cjs/types/session.js +48 -50
  93. package/dist/cjs/types/session.js.map +1 -1
  94. package/dist/cjs/types/tool.d.ts +13 -13
  95. package/dist/cjs/types/tool.d.ts.map +1 -1
  96. package/dist/cjs/utils/id.d.ts +8 -3
  97. package/dist/cjs/utils/id.d.ts.map +1 -1
  98. package/dist/cjs/utils/id.js +16 -7
  99. package/dist/cjs/utils/id.js.map +1 -1
  100. package/dist/constants/index.d.ts +4 -4
  101. package/dist/constants/index.js +4 -4
  102. package/dist/core/Agent.d.ts +22 -22
  103. package/dist/core/Agent.d.ts.map +1 -1
  104. package/dist/core/Agent.js +162 -154
  105. package/dist/core/Agent.js.map +1 -1
  106. package/dist/core/Events.d.ts +6 -6
  107. package/dist/core/Events.d.ts.map +1 -1
  108. package/dist/core/PersistenceManager.d.ts +13 -13
  109. package/dist/core/PersistenceManager.d.ts.map +1 -1
  110. package/dist/core/PersistenceManager.js +25 -25
  111. package/dist/core/PersistenceManager.js.map +1 -1
  112. package/dist/core/ResponseEngine.d.ts +3 -8
  113. package/dist/core/ResponseEngine.d.ts.map +1 -1
  114. package/dist/core/ResponseEngine.js +8 -8
  115. package/dist/core/ResponseEngine.js.map +1 -1
  116. package/dist/core/Route.d.ts +17 -17
  117. package/dist/core/Route.d.ts.map +1 -1
  118. package/dist/core/Route.js +33 -33
  119. package/dist/core/Route.js.map +1 -1
  120. package/dist/core/RoutingEngine.d.ts +30 -30
  121. package/dist/core/RoutingEngine.d.ts.map +1 -1
  122. package/dist/core/RoutingEngine.js +193 -193
  123. package/dist/core/RoutingEngine.js.map +1 -1
  124. package/dist/core/Step.d.ts +72 -0
  125. package/dist/core/Step.d.ts.map +1 -0
  126. package/dist/core/Step.js +146 -0
  127. package/dist/core/Step.js.map +1 -0
  128. package/dist/core/ToolExecutor.d.ts +5 -5
  129. package/dist/core/ToolExecutor.d.ts.map +1 -1
  130. package/dist/core/ToolExecutor.js +8 -8
  131. package/dist/core/ToolExecutor.js.map +1 -1
  132. package/dist/core/Transition.d.ts +14 -14
  133. package/dist/core/Transition.d.ts.map +1 -1
  134. package/dist/core/Transition.js +48 -19
  135. package/dist/core/Transition.js.map +1 -1
  136. package/dist/index.d.ts +7 -7
  137. package/dist/index.d.ts.map +1 -1
  138. package/dist/index.js +4 -4
  139. package/dist/index.js.map +1 -1
  140. package/dist/types/agent.d.ts +8 -8
  141. package/dist/types/agent.d.ts.map +1 -1
  142. package/dist/types/ai.d.ts +2 -2
  143. package/dist/types/ai.d.ts.map +1 -1
  144. package/dist/types/history.d.ts +3 -3
  145. package/dist/types/history.d.ts.map +1 -1
  146. package/dist/types/index.d.ts +1 -1
  147. package/dist/types/index.d.ts.map +1 -1
  148. package/dist/types/persistence.d.ts +5 -5
  149. package/dist/types/persistence.d.ts.map +1 -1
  150. package/dist/types/route.d.ts +57 -52
  151. package/dist/types/route.d.ts.map +1 -1
  152. package/dist/types/session.d.ts +27 -27
  153. package/dist/types/session.d.ts.map +1 -1
  154. package/dist/types/session.js +44 -46
  155. package/dist/types/session.js.map +1 -1
  156. package/dist/types/tool.d.ts +13 -13
  157. package/dist/types/tool.d.ts.map +1 -1
  158. package/dist/utils/id.d.ts +8 -3
  159. package/dist/utils/id.d.ts.map +1 -1
  160. package/dist/utils/id.js +14 -6
  161. package/dist/utils/id.js.map +1 -1
  162. package/docs/ADAPTERS.md +21 -21
  163. package/docs/AGENT.md +57 -55
  164. package/docs/API_REFERENCE.md +218 -220
  165. package/docs/ARCHITECTURE.md +99 -104
  166. package/docs/CONTEXT_MANAGEMENT.md +81 -88
  167. package/docs/DOCS.md +18 -18
  168. package/docs/DOMAINS.md +16 -16
  169. package/docs/EXAMPLES.md +43 -43
  170. package/docs/GETTING_STARTED.md +60 -63
  171. package/docs/PERSISTENCE.md +66 -70
  172. package/docs/PROVIDERS.md +2 -2
  173. package/docs/README.md +6 -6
  174. package/docs/ROUTES.md +218 -220
  175. package/docs/STEPS.md +883 -0
  176. package/examples/business-onboarding.ts +84 -81
  177. package/examples/company-qna-agent.ts +68 -67
  178. package/examples/custom-database-persistence.ts +87 -89
  179. package/examples/declarative-agent.ts +32 -32
  180. package/examples/domain-scoping.ts +18 -18
  181. package/examples/extracted-data-modification.ts +92 -97
  182. package/examples/healthcare-agent.ts +89 -91
  183. package/examples/openai-agent.ts +29 -32
  184. package/examples/opensearch-persistence.ts +43 -45
  185. package/examples/persistent-onboarding.ts +65 -66
  186. package/examples/prisma-persistence.ts +108 -112
  187. package/examples/prisma-schema.example.prisma +3 -3
  188. package/examples/redis-persistence.ts +67 -73
  189. package/examples/route-transitions.ts +71 -47
  190. package/examples/rules-prohibitions.ts +28 -28
  191. package/examples/streaming-agent.ts +24 -24
  192. package/examples/travel-agent.ts +94 -109
  193. package/package.json +1 -1
  194. package/src/adapters/MemoryAdapter.ts +3 -3
  195. package/src/adapters/MongoAdapter.ts +3 -3
  196. package/src/adapters/OpenSearchAdapter.ts +8 -8
  197. package/src/adapters/PostgreSQLAdapter.ts +10 -10
  198. package/src/adapters/PrismaAdapter.ts +4 -4
  199. package/src/adapters/RedisAdapter.ts +3 -3
  200. package/src/adapters/SQLiteAdapter.ts +15 -15
  201. package/src/adapters/index.ts +1 -1
  202. package/src/constants/index.ts +4 -4
  203. package/src/core/Agent.ts +210 -206
  204. package/src/core/Events.ts +12 -12
  205. package/src/core/PersistenceManager.ts +32 -36
  206. package/src/core/ResponseEngine.ts +11 -17
  207. package/src/core/Route.ts +55 -49
  208. package/src/core/RoutingEngine.ts +244 -252
  209. package/src/core/Step.ts +197 -0
  210. package/src/core/ToolExecutor.ts +11 -11
  211. package/src/core/Transition.ts +72 -26
  212. package/src/index.ts +8 -8
  213. package/src/types/agent.ts +8 -8
  214. package/src/types/ai.ts +2 -2
  215. package/src/types/history.ts +3 -3
  216. package/src/types/index.ts +1 -1
  217. package/src/types/persistence.ts +6 -6
  218. package/src/types/route.ts +77 -61
  219. package/src/types/session.ts +75 -78
  220. package/src/types/tool.ts +17 -17
  221. package/src/utils/id.ts +15 -6
  222. package/dist/cjs/core/State.d.ts +0 -72
  223. package/dist/cjs/core/State.d.ts.map +0 -1
  224. package/dist/cjs/core/State.js +0 -148
  225. package/dist/cjs/core/State.js.map +0 -1
  226. package/dist/core/State.d.ts +0 -72
  227. package/dist/core/State.d.ts.map +0 -1
  228. package/dist/core/State.js +0 -144
  229. package/dist/core/State.js.map +0 -1
  230. package/docs/STATES.md +0 -888
  231. package/src/core/State.ts +0 -212
package/src/core/State.ts DELETED
@@ -1,212 +0,0 @@
1
- /**
2
- * State in the route DSL
3
- */
4
-
5
- import type {
6
- StateRef,
7
- TransitionSpec,
8
- TransitionResult,
9
- } from "../types/route";
10
- import type { Guideline } from "../types/agent";
11
-
12
- import { END_STATE } from "../constants";
13
- import { Transition } from "./Transition";
14
- import { generateStateId } from "../utils/id";
15
-
16
- /**
17
- * Represents a state within a route
18
- */
19
- export class State<TContext = unknown, TExtracted = unknown> {
20
- public readonly id: string;
21
- private transitions: Transition<TContext, TExtracted>[] = [];
22
- private guidelines: Guideline[] = [];
23
- public gatherFields?: string[];
24
- public skipIf?: (extracted: Partial<TExtracted>) => boolean;
25
- public requiredData?: string[];
26
- public chatState?: string;
27
-
28
- constructor(
29
- public readonly routeId: string,
30
- public description?: string,
31
- customId?: string,
32
- gatherFields?: string[],
33
- skipIf?: (extracted: Partial<TExtracted>) => boolean,
34
- requiredData?: string[],
35
- chatState?: string
36
- ) {
37
- // Use provided ID or generate a deterministic one
38
- this.id = customId || generateStateId(routeId, description);
39
- this.gatherFields = gatherFields;
40
- this.skipIf = skipIf;
41
- this.requiredData = requiredData;
42
- this.chatState = chatState;
43
- }
44
-
45
- /**
46
- * Configure the state properties after creation
47
- * Useful for overriding initial state configuration
48
- */
49
- configure(config: {
50
- description?: string;
51
- gatherFields?: string[];
52
- skipIf?: (extracted: Partial<TExtracted>) => boolean;
53
- requiredData?: string[];
54
- chatState?: string;
55
- }): this {
56
- if (config.description !== undefined) {
57
- this.description = config.description;
58
- }
59
- if (config.gatherFields !== undefined) {
60
- this.gatherFields = config.gatherFields;
61
- }
62
- if (config.skipIf !== undefined) {
63
- this.skipIf = config.skipIf;
64
- }
65
- if (config.requiredData !== undefined) {
66
- this.requiredData = config.requiredData;
67
- }
68
- if (config.chatState !== undefined) {
69
- this.chatState = config.chatState;
70
- }
71
- return this;
72
- }
73
-
74
- /**
75
- * Create a transition from this state to another
76
- *
77
- * @param spec - Transition specification (chatState, toolState, or direct state)
78
- * @returns TransitionResult that supports chaining
79
- */
80
- transitionTo(
81
- spec: TransitionSpec<TContext, TExtracted>
82
- ): TransitionResult<TContext, TExtracted> {
83
- // Handle END_STATE
84
- if (
85
- spec.state &&
86
- typeof spec.state === "symbol" &&
87
- spec.state === END_STATE
88
- ) {
89
- const endTransition = new Transition<TContext, TExtracted>(
90
- this.getRef(),
91
- { state: END_STATE, condition: spec.condition, chatState: spec.chatState }
92
- );
93
- this.transitions.push(endTransition);
94
-
95
- // Return a terminal state reference
96
- return this.createTerminalRef();
97
- }
98
-
99
- // Handle direct state reference
100
- if (spec.state && typeof spec.state !== "symbol") {
101
- const transition = new Transition<TContext, TExtracted>(
102
- this.getRef(),
103
- spec
104
- );
105
- this.transitions.push(transition);
106
-
107
- return this.createStateRefWithTransition(spec.state);
108
- }
109
-
110
- // Create new target state for chatState or toolState
111
- const targetState = new State<TContext, TExtracted>(
112
- this.routeId,
113
- spec.chatState,
114
- spec.id, // Use custom ID if provided
115
- spec.gather,
116
- spec.skipIf,
117
- spec.requiredData,
118
- spec.chatState
119
- );
120
- const transition = new Transition<TContext, TExtracted>(
121
- this.getRef(),
122
- spec
123
- );
124
- transition.setTarget(targetState);
125
-
126
- this.transitions.push(transition);
127
-
128
- return this.createStateRefWithTransition(targetState.getRef(), targetState);
129
- }
130
-
131
- /**
132
- * Add a guideline specific to this state
133
- */
134
- addGuideline(guideline: Guideline): void {
135
- this.guidelines.push(guideline);
136
- }
137
-
138
- /**
139
- * Get guidelines for this state
140
- */
141
- getGuidelines(): Guideline[] {
142
- return [...this.guidelines];
143
- }
144
-
145
- /**
146
- * Get all transitions from this state
147
- */
148
- getTransitions(): Transition<TContext, TExtracted>[] {
149
- return [...this.transitions];
150
- }
151
-
152
- /**
153
- * Check if this state should be skipped based on extracted data
154
- */
155
- shouldSkip(extracted: Partial<TExtracted>): boolean {
156
- if (!this.skipIf) return false;
157
- return this.skipIf(extracted);
158
- }
159
-
160
- /**
161
- * Check if this state has all required data to proceed
162
- */
163
- hasRequiredData(extracted: Partial<TExtracted>): boolean {
164
- if (!this.requiredData || this.requiredData.length === 0) return true;
165
- return this.requiredData.every(
166
- (key) => extracted[key as keyof TExtracted] !== undefined
167
- );
168
- }
169
-
170
- /**
171
- * Get state reference
172
- */
173
- getRef(): StateRef {
174
- return {
175
- id: this.id,
176
- routeId: this.routeId,
177
- };
178
- }
179
-
180
- /**
181
- * Create a state reference with transitionTo capability for chaining
182
- */
183
- private createStateRefWithTransition(
184
- ref: StateRef,
185
- state?: State<TContext, TExtracted>
186
- ): TransitionResult<TContext, TExtracted> {
187
- const stateInstance = state || this;
188
-
189
- return {
190
- ...ref,
191
- transitionTo: (spec: TransitionSpec<TContext, TExtracted>) =>
192
- stateInstance.transitionTo(spec),
193
- };
194
- }
195
-
196
- /**
197
- * Create a terminal state reference (for END_STATE)
198
- */
199
- private createTerminalRef(): TransitionResult<TContext, TExtracted> {
200
- const terminalRef: StateRef = {
201
- id: "END",
202
- routeId: this.routeId,
203
- };
204
-
205
- return {
206
- ...terminalRef,
207
- transitionTo: () => {
208
- throw new Error("Cannot transition from END_STATE state");
209
- },
210
- };
211
- }
212
- }