effect 4.0.0-beta.71 → 4.0.0-beta.73

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 (999) hide show
  1. package/dist/Array.d.ts +65 -111
  2. package/dist/Array.d.ts.map +1 -1
  3. package/dist/Array.js +28 -44
  4. package/dist/Array.js.map +1 -1
  5. package/dist/BigDecimal.d.ts +66 -58
  6. package/dist/BigDecimal.d.ts.map +1 -1
  7. package/dist/BigDecimal.js +30 -26
  8. package/dist/BigDecimal.js.map +1 -1
  9. package/dist/BigInt.d.ts +21 -19
  10. package/dist/BigInt.d.ts.map +1 -1
  11. package/dist/BigInt.js +17 -15
  12. package/dist/BigInt.js.map +1 -1
  13. package/dist/Boolean.d.ts +15 -17
  14. package/dist/Boolean.d.ts.map +1 -1
  15. package/dist/Boolean.js +13 -13
  16. package/dist/Boolean.js.map +1 -1
  17. package/dist/Brand.d.ts +2 -3
  18. package/dist/Brand.d.ts.map +1 -1
  19. package/dist/Brand.js +2 -3
  20. package/dist/Brand.js.map +1 -1
  21. package/dist/Cache.d.ts +9 -9
  22. package/dist/Cache.js +3 -3
  23. package/dist/Cause.d.ts +35 -39
  24. package/dist/Cause.d.ts.map +1 -1
  25. package/dist/Cause.js +31 -33
  26. package/dist/Cause.js.map +1 -1
  27. package/dist/Channel.d.ts +141 -99
  28. package/dist/Channel.d.ts.map +1 -1
  29. package/dist/Channel.js +56 -42
  30. package/dist/Channel.js.map +1 -1
  31. package/dist/ChannelSchema.d.ts +3 -3
  32. package/dist/ChannelSchema.js +1 -1
  33. package/dist/Chunk.d.ts +67 -54
  34. package/dist/Chunk.d.ts.map +1 -1
  35. package/dist/Chunk.js +33 -22
  36. package/dist/Chunk.js.map +1 -1
  37. package/dist/Clock.d.ts +3 -3
  38. package/dist/Clock.js +1 -1
  39. package/dist/Combiner.d.ts +6 -10
  40. package/dist/Combiner.d.ts.map +1 -1
  41. package/dist/Combiner.js +6 -10
  42. package/dist/Combiner.js.map +1 -1
  43. package/dist/Config.d.ts +9 -10
  44. package/dist/Config.d.ts.map +1 -1
  45. package/dist/Config.js +7 -8
  46. package/dist/Config.js.map +1 -1
  47. package/dist/ConfigProvider.d.ts +4 -4
  48. package/dist/ConfigProvider.js +4 -4
  49. package/dist/Console.d.ts +11 -7
  50. package/dist/Console.d.ts.map +1 -1
  51. package/dist/Console.js +11 -7
  52. package/dist/Console.js.map +1 -1
  53. package/dist/Context.d.ts +35 -35
  54. package/dist/Context.js +13 -13
  55. package/dist/Cron.d.ts +7 -6
  56. package/dist/Cron.d.ts.map +1 -1
  57. package/dist/Cron.js +7 -6
  58. package/dist/Cron.js.map +1 -1
  59. package/dist/Crypto.d.ts +1 -1
  60. package/dist/Crypto.js +1 -1
  61. package/dist/Data.d.ts +26 -32
  62. package/dist/Data.d.ts.map +1 -1
  63. package/dist/Data.js +9 -8
  64. package/dist/Data.js.map +1 -1
  65. package/dist/DateTime.d.ts +164 -122
  66. package/dist/DateTime.d.ts.map +1 -1
  67. package/dist/DateTime.js +86 -66
  68. package/dist/DateTime.js.map +1 -1
  69. package/dist/Deferred.d.ts +6 -6
  70. package/dist/Deferred.js +4 -4
  71. package/dist/Duration.d.ts +39 -39
  72. package/dist/Duration.js +21 -21
  73. package/dist/Effect.d.ts +220 -309
  74. package/dist/Effect.d.ts.map +1 -1
  75. package/dist/Effect.js +115 -140
  76. package/dist/Effect.js.map +1 -1
  77. package/dist/Effectable.d.ts +2 -2
  78. package/dist/Effectable.js +2 -2
  79. package/dist/Encoding.d.ts +13 -10
  80. package/dist/Encoding.d.ts.map +1 -1
  81. package/dist/Encoding.js +12 -9
  82. package/dist/Encoding.js.map +1 -1
  83. package/dist/Equal.d.ts +3 -4
  84. package/dist/Equal.d.ts.map +1 -1
  85. package/dist/Equal.js +2 -3
  86. package/dist/Equal.js.map +1 -1
  87. package/dist/Equivalence.d.ts +5 -19
  88. package/dist/Equivalence.d.ts.map +1 -1
  89. package/dist/Equivalence.js +5 -14
  90. package/dist/Equivalence.js.map +1 -1
  91. package/dist/ErrorReporter.d.ts +14 -13
  92. package/dist/ErrorReporter.d.ts.map +1 -1
  93. package/dist/ErrorReporter.js +10 -9
  94. package/dist/ErrorReporter.js.map +1 -1
  95. package/dist/ExecutionPlan.d.ts +7 -2
  96. package/dist/ExecutionPlan.d.ts.map +1 -1
  97. package/dist/ExecutionPlan.js +7 -2
  98. package/dist/ExecutionPlan.js.map +1 -1
  99. package/dist/Exit.d.ts +25 -23
  100. package/dist/Exit.d.ts.map +1 -1
  101. package/dist/Exit.js +13 -13
  102. package/dist/Exit.js.map +1 -1
  103. package/dist/Fiber.d.ts +4 -4
  104. package/dist/Fiber.js +2 -2
  105. package/dist/FiberHandle.d.ts +6 -6
  106. package/dist/FiberHandle.js +4 -4
  107. package/dist/FiberMap.d.ts +18 -18
  108. package/dist/FiberMap.js +8 -8
  109. package/dist/FiberSet.d.ts +21 -13
  110. package/dist/FiberSet.d.ts.map +1 -1
  111. package/dist/FiberSet.js +17 -9
  112. package/dist/FiberSet.js.map +1 -1
  113. package/dist/FileSystem.d.ts +13 -9
  114. package/dist/FileSystem.d.ts.map +1 -1
  115. package/dist/FileSystem.js +11 -7
  116. package/dist/FileSystem.js.map +1 -1
  117. package/dist/Filter.d.ts +2 -2
  118. package/dist/Filter.js +2 -2
  119. package/dist/Formatter.d.ts +1 -3
  120. package/dist/Formatter.d.ts.map +1 -1
  121. package/dist/Formatter.js +1 -3
  122. package/dist/Formatter.js.map +1 -1
  123. package/dist/Function.d.ts +12 -12
  124. package/dist/Function.js +12 -12
  125. package/dist/Graph.d.ts +22 -22
  126. package/dist/Graph.js +12 -12
  127. package/dist/HKT.d.ts +5 -4
  128. package/dist/HKT.d.ts.map +1 -1
  129. package/dist/Hash.d.ts +3 -3
  130. package/dist/Hash.js +3 -3
  131. package/dist/HashMap.d.ts +33 -35
  132. package/dist/HashMap.d.ts.map +1 -1
  133. package/dist/HashMap.js +11 -13
  134. package/dist/HashMap.js.map +1 -1
  135. package/dist/HashRing.d.ts +7 -9
  136. package/dist/HashRing.d.ts.map +1 -1
  137. package/dist/HashRing.js +3 -5
  138. package/dist/HashRing.js.map +1 -1
  139. package/dist/HashSet.d.ts +16 -16
  140. package/dist/HashSet.js +6 -6
  141. package/dist/Inspectable.d.ts +4 -4
  142. package/dist/Inspectable.js +4 -4
  143. package/dist/Iterable.d.ts +82 -56
  144. package/dist/Iterable.d.ts.map +1 -1
  145. package/dist/Iterable.js +28 -20
  146. package/dist/Iterable.js.map +1 -1
  147. package/dist/JsonPatch.d.ts +1 -1
  148. package/dist/JsonPatch.js +1 -1
  149. package/dist/JsonPointer.d.ts +3 -3
  150. package/dist/JsonPointer.js +3 -3
  151. package/dist/JsonSchema.d.ts +13 -23
  152. package/dist/JsonSchema.d.ts.map +1 -1
  153. package/dist/JsonSchema.js +13 -23
  154. package/dist/JsonSchema.js.map +1 -1
  155. package/dist/Latch.d.ts +2 -2
  156. package/dist/Latch.js +2 -2
  157. package/dist/Layer.d.ts +47 -27
  158. package/dist/Layer.d.ts.map +1 -1
  159. package/dist/Layer.js +23 -15
  160. package/dist/Layer.js.map +1 -1
  161. package/dist/LayerMap.d.ts +1 -2
  162. package/dist/LayerMap.d.ts.map +1 -1
  163. package/dist/LayerMap.js +1 -2
  164. package/dist/LayerMap.js.map +1 -1
  165. package/dist/LogLevel.d.ts +3 -3
  166. package/dist/LogLevel.js +3 -3
  167. package/dist/Logger.d.ts +2 -2
  168. package/dist/Logger.js +2 -2
  169. package/dist/ManagedRuntime.d.ts +1 -1
  170. package/dist/ManagedRuntime.js +1 -1
  171. package/dist/Match.d.ts +32 -37
  172. package/dist/Match.d.ts.map +1 -1
  173. package/dist/Match.js +32 -37
  174. package/dist/Match.js.map +1 -1
  175. package/dist/Metric.d.ts +35 -21
  176. package/dist/Metric.d.ts.map +1 -1
  177. package/dist/Metric.js +34 -20
  178. package/dist/Metric.js.map +1 -1
  179. package/dist/MutableHashMap.d.ts +13 -19
  180. package/dist/MutableHashMap.d.ts.map +1 -1
  181. package/dist/MutableHashMap.js +5 -7
  182. package/dist/MutableHashMap.js.map +1 -1
  183. package/dist/MutableHashSet.d.ts +4 -4
  184. package/dist/MutableHashSet.js +2 -2
  185. package/dist/MutableList.d.ts +16 -6
  186. package/dist/MutableList.d.ts.map +1 -1
  187. package/dist/MutableList.js +15 -5
  188. package/dist/MutableList.js.map +1 -1
  189. package/dist/MutableRef.d.ts +5 -4
  190. package/dist/MutableRef.d.ts.map +1 -1
  191. package/dist/MutableRef.js +3 -2
  192. package/dist/MutableRef.js.map +1 -1
  193. package/dist/NonEmptyIterable.d.ts +3 -3
  194. package/dist/NonEmptyIterable.js +1 -1
  195. package/dist/Number.d.ts +20 -18
  196. package/dist/Number.d.ts.map +1 -1
  197. package/dist/Number.js +16 -14
  198. package/dist/Number.js.map +1 -1
  199. package/dist/Optic.d.ts +11 -18
  200. package/dist/Optic.d.ts.map +1 -1
  201. package/dist/Optic.js +7 -14
  202. package/dist/Optic.js.map +1 -1
  203. package/dist/Option.d.ts +21 -24
  204. package/dist/Option.d.ts.map +1 -1
  205. package/dist/Option.js +9 -10
  206. package/dist/Option.js.map +1 -1
  207. package/dist/Order.d.ts +11 -38
  208. package/dist/Order.d.ts.map +1 -1
  209. package/dist/Order.js +11 -33
  210. package/dist/Order.js.map +1 -1
  211. package/dist/Ordering.d.ts +5 -5
  212. package/dist/Ordering.js +3 -3
  213. package/dist/PartitionedSemaphore.d.ts +4 -8
  214. package/dist/PartitionedSemaphore.d.ts.map +1 -1
  215. package/dist/PartitionedSemaphore.js +3 -7
  216. package/dist/PartitionedSemaphore.js.map +1 -1
  217. package/dist/Path.d.ts +4 -7
  218. package/dist/Path.d.ts.map +1 -1
  219. package/dist/Path.js +3 -6
  220. package/dist/Path.js.map +1 -1
  221. package/dist/Pipeable.d.ts +2 -2
  222. package/dist/Pipeable.js +2 -2
  223. package/dist/PlatformError.d.ts +1 -1
  224. package/dist/PlatformError.js +1 -1
  225. package/dist/Predicate.d.ts +2 -81
  226. package/dist/Predicate.d.ts.map +1 -1
  227. package/dist/Predicate.js +2 -47
  228. package/dist/Predicate.js.map +1 -1
  229. package/dist/PrimaryKey.d.ts +3 -3
  230. package/dist/PrimaryKey.js +1 -1
  231. package/dist/PubSub.d.ts +147 -46
  232. package/dist/PubSub.d.ts.map +1 -1
  233. package/dist/PubSub.js +93 -32
  234. package/dist/PubSub.js.map +1 -1
  235. package/dist/Pull.d.ts +1 -1
  236. package/dist/Pull.js +1 -1
  237. package/dist/Queue.d.ts +40 -24
  238. package/dist/Queue.d.ts.map +1 -1
  239. package/dist/Queue.js +36 -20
  240. package/dist/Queue.js.map +1 -1
  241. package/dist/RcMap.d.ts +3 -3
  242. package/dist/RcMap.js +1 -1
  243. package/dist/Record.d.ts +79 -52
  244. package/dist/Record.d.ts.map +1 -1
  245. package/dist/Record.js +33 -22
  246. package/dist/Record.js.map +1 -1
  247. package/dist/Redactable.d.ts +7 -7
  248. package/dist/Redactable.js +7 -7
  249. package/dist/Reducer.d.ts +0 -2
  250. package/dist/Reducer.d.ts.map +1 -1
  251. package/dist/Reducer.js +0 -2
  252. package/dist/Reducer.js.map +1 -1
  253. package/dist/Ref.d.ts +12 -12
  254. package/dist/Ref.js +10 -10
  255. package/dist/References.d.ts +20 -20
  256. package/dist/References.js +20 -20
  257. package/dist/RegExp.d.ts +2 -2
  258. package/dist/RegExp.js +2 -2
  259. package/dist/Request.d.ts +3 -3
  260. package/dist/Request.js +3 -3
  261. package/dist/RequestResolver.d.ts +11 -14
  262. package/dist/RequestResolver.d.ts.map +1 -1
  263. package/dist/RequestResolver.js +5 -6
  264. package/dist/RequestResolver.js.map +1 -1
  265. package/dist/Result.d.ts +52 -34
  266. package/dist/Result.d.ts.map +1 -1
  267. package/dist/Result.js +44 -20
  268. package/dist/Result.js.map +1 -1
  269. package/dist/Runtime.d.ts +1 -1
  270. package/dist/Runtime.js +1 -1
  271. package/dist/Schedule.d.ts +20 -24
  272. package/dist/Schedule.d.ts.map +1 -1
  273. package/dist/Schedule.js +12 -12
  274. package/dist/Schedule.js.map +1 -1
  275. package/dist/Scheduler.d.ts +3 -3
  276. package/dist/Scheduler.js +3 -3
  277. package/dist/Schema.d.ts +480 -210
  278. package/dist/Schema.d.ts.map +1 -1
  279. package/dist/Schema.js +410 -172
  280. package/dist/Schema.js.map +1 -1
  281. package/dist/SchemaAST.d.ts +40 -32
  282. package/dist/SchemaAST.d.ts.map +1 -1
  283. package/dist/SchemaAST.js +40 -32
  284. package/dist/SchemaAST.js.map +1 -1
  285. package/dist/SchemaGetter.d.ts +4 -6
  286. package/dist/SchemaGetter.d.ts.map +1 -1
  287. package/dist/SchemaGetter.js +4 -6
  288. package/dist/SchemaGetter.js.map +1 -1
  289. package/dist/SchemaIssue.d.ts +35 -47
  290. package/dist/SchemaIssue.d.ts.map +1 -1
  291. package/dist/SchemaIssue.js +31 -42
  292. package/dist/SchemaIssue.js.map +1 -1
  293. package/dist/SchemaParser.d.ts +16 -12
  294. package/dist/SchemaParser.d.ts.map +1 -1
  295. package/dist/SchemaParser.js +16 -12
  296. package/dist/SchemaParser.js.map +1 -1
  297. package/dist/SchemaRepresentation.d.ts +47 -62
  298. package/dist/SchemaRepresentation.d.ts.map +1 -1
  299. package/dist/SchemaRepresentation.js +44 -58
  300. package/dist/SchemaRepresentation.js.map +1 -1
  301. package/dist/SchemaTransformation.d.ts +16 -18
  302. package/dist/SchemaTransformation.d.ts.map +1 -1
  303. package/dist/SchemaTransformation.js +13 -15
  304. package/dist/SchemaTransformation.js.map +1 -1
  305. package/dist/Scope.d.ts +51 -14
  306. package/dist/Scope.d.ts.map +1 -1
  307. package/dist/Scope.js +29 -8
  308. package/dist/Scope.js.map +1 -1
  309. package/dist/ScopedCache.d.ts +12 -12
  310. package/dist/ScopedCache.js +4 -4
  311. package/dist/ScopedRef.d.ts +2 -2
  312. package/dist/ScopedRef.js +2 -2
  313. package/dist/Semaphore.d.ts +1 -1
  314. package/dist/Semaphore.js +1 -1
  315. package/dist/Sink.d.ts +36 -41
  316. package/dist/Sink.d.ts.map +1 -1
  317. package/dist/Sink.js +21 -24
  318. package/dist/Sink.js.map +1 -1
  319. package/dist/Stdio.d.ts +5 -4
  320. package/dist/Stdio.d.ts.map +1 -1
  321. package/dist/Stdio.js +4 -3
  322. package/dist/Stdio.js.map +1 -1
  323. package/dist/Stream.d.ts +264 -165
  324. package/dist/Stream.d.ts.map +1 -1
  325. package/dist/Stream.js +103 -62
  326. package/dist/Stream.js.map +1 -1
  327. package/dist/String.d.ts +48 -47
  328. package/dist/String.d.ts.map +1 -1
  329. package/dist/String.js +32 -29
  330. package/dist/String.js.map +1 -1
  331. package/dist/Struct.d.ts +35 -100
  332. package/dist/Struct.d.ts.map +1 -1
  333. package/dist/Struct.js +13 -38
  334. package/dist/Struct.js.map +1 -1
  335. package/dist/SubscriptionRef.d.ts +268 -91
  336. package/dist/SubscriptionRef.d.ts.map +1 -1
  337. package/dist/SubscriptionRef.js +90 -31
  338. package/dist/SubscriptionRef.js.map +1 -1
  339. package/dist/Symbol.d.ts +1 -1
  340. package/dist/Symbol.js +1 -1
  341. package/dist/SynchronizedRef.d.ts +27 -27
  342. package/dist/SynchronizedRef.js +9 -9
  343. package/dist/Terminal.d.ts +8 -3
  344. package/dist/Terminal.d.ts.map +1 -1
  345. package/dist/Terminal.js +8 -3
  346. package/dist/Terminal.js.map +1 -1
  347. package/dist/Tracer.d.ts +25 -7
  348. package/dist/Tracer.d.ts.map +1 -1
  349. package/dist/Tracer.js +25 -7
  350. package/dist/Tracer.js.map +1 -1
  351. package/dist/Trie.d.ts +21 -23
  352. package/dist/Trie.d.ts.map +1 -1
  353. package/dist/Trie.js +7 -7
  354. package/dist/Trie.js.map +1 -1
  355. package/dist/Tuple.d.ts +26 -73
  356. package/dist/Tuple.d.ts.map +1 -1
  357. package/dist/Tuple.js +10 -31
  358. package/dist/Tuple.js.map +1 -1
  359. package/dist/TxChunk.d.ts +2 -2
  360. package/dist/TxChunk.js +2 -2
  361. package/dist/TxHashMap.d.ts +20 -20
  362. package/dist/TxHashMap.js +8 -8
  363. package/dist/TxHashSet.d.ts +14 -14
  364. package/dist/TxHashSet.js +6 -6
  365. package/dist/TxPriorityQueue.d.ts +14 -6
  366. package/dist/TxPriorityQueue.d.ts.map +1 -1
  367. package/dist/TxPriorityQueue.js +12 -4
  368. package/dist/TxPriorityQueue.js.map +1 -1
  369. package/dist/TxPubSub.d.ts +4 -4
  370. package/dist/TxPubSub.js +4 -4
  371. package/dist/TxQueue.d.ts +10 -10
  372. package/dist/TxQueue.js +10 -10
  373. package/dist/TxReentrantLock.d.ts +48 -12
  374. package/dist/TxReentrantLock.d.ts.map +1 -1
  375. package/dist/TxReentrantLock.js +38 -10
  376. package/dist/TxReentrantLock.js.map +1 -1
  377. package/dist/TxRef.d.ts +1 -1
  378. package/dist/TxRef.js +1 -1
  379. package/dist/TxSubscriptionRef.d.ts +1 -1
  380. package/dist/TxSubscriptionRef.js +1 -1
  381. package/dist/Types.d.ts +8 -7
  382. package/dist/Types.d.ts.map +1 -1
  383. package/dist/Unify.d.ts +19 -19
  384. package/dist/Utils.d.ts +1 -2
  385. package/dist/Utils.d.ts.map +1 -1
  386. package/dist/Utils.js +1 -2
  387. package/dist/Utils.js.map +1 -1
  388. package/dist/testing/TestSchema.d.ts +3 -11
  389. package/dist/testing/TestSchema.d.ts.map +1 -1
  390. package/dist/testing/TestSchema.js +3 -11
  391. package/dist/testing/TestSchema.js.map +1 -1
  392. package/dist/unstable/ai/AiError.d.ts +10 -5
  393. package/dist/unstable/ai/AiError.d.ts.map +1 -1
  394. package/dist/unstable/ai/AiError.js +10 -5
  395. package/dist/unstable/ai/AiError.js.map +1 -1
  396. package/dist/unstable/ai/Chat.d.ts +20 -5
  397. package/dist/unstable/ai/Chat.d.ts.map +1 -1
  398. package/dist/unstable/ai/Chat.js +20 -5
  399. package/dist/unstable/ai/Chat.js.map +1 -1
  400. package/dist/unstable/ai/EmbeddingModel.d.ts +5 -4
  401. package/dist/unstable/ai/EmbeddingModel.d.ts.map +1 -1
  402. package/dist/unstable/ai/EmbeddingModel.js +4 -3
  403. package/dist/unstable/ai/EmbeddingModel.js.map +1 -1
  404. package/dist/unstable/ai/IdGenerator.d.ts +7 -2
  405. package/dist/unstable/ai/IdGenerator.d.ts.map +1 -1
  406. package/dist/unstable/ai/IdGenerator.js +7 -2
  407. package/dist/unstable/ai/IdGenerator.js.map +1 -1
  408. package/dist/unstable/ai/LanguageModel.d.ts +10 -5
  409. package/dist/unstable/ai/LanguageModel.d.ts.map +1 -1
  410. package/dist/unstable/ai/LanguageModel.js +10 -5
  411. package/dist/unstable/ai/LanguageModel.js.map +1 -1
  412. package/dist/unstable/ai/McpSchema.d.ts +291 -169
  413. package/dist/unstable/ai/McpSchema.d.ts.map +1 -1
  414. package/dist/unstable/ai/McpSchema.js +270 -147
  415. package/dist/unstable/ai/McpSchema.js.map +1 -1
  416. package/dist/unstable/ai/McpServer.d.ts +49 -13
  417. package/dist/unstable/ai/McpServer.d.ts.map +1 -1
  418. package/dist/unstable/ai/McpServer.js +21 -9
  419. package/dist/unstable/ai/McpServer.js.map +1 -1
  420. package/dist/unstable/ai/Prompt.d.ts +1 -1
  421. package/dist/unstable/ai/Prompt.js +1 -1
  422. package/dist/unstable/ai/Response.d.ts +1 -1
  423. package/dist/unstable/ai/Response.js +1 -1
  424. package/dist/unstable/ai/Tokenizer.d.ts +7 -2
  425. package/dist/unstable/ai/Tokenizer.d.ts.map +1 -1
  426. package/dist/unstable/ai/Tokenizer.js +7 -2
  427. package/dist/unstable/ai/Tokenizer.js.map +1 -1
  428. package/dist/unstable/ai/Tool.d.ts +3 -3
  429. package/dist/unstable/ai/Tool.js +3 -3
  430. package/dist/unstable/cli/CliError.d.ts +3 -3
  431. package/dist/unstable/cli/CliError.js +3 -3
  432. package/dist/unstable/cli/CliOutput.d.ts +1 -1
  433. package/dist/unstable/cli/Command.d.ts +3 -3
  434. package/dist/unstable/cli/Command.js +1 -1
  435. package/dist/unstable/cli/Flag.d.ts +9 -9
  436. package/dist/unstable/cli/Flag.js +3 -3
  437. package/dist/unstable/cli/GlobalFlag.d.ts +13 -6
  438. package/dist/unstable/cli/GlobalFlag.d.ts.map +1 -1
  439. package/dist/unstable/cli/GlobalFlag.js +13 -6
  440. package/dist/unstable/cli/GlobalFlag.js.map +1 -1
  441. package/dist/unstable/cli/Param.d.ts +2 -2
  442. package/dist/unstable/cli/Param.js +2 -2
  443. package/dist/unstable/cli/Primitive.d.ts +1 -1
  444. package/dist/unstable/cli/Primitive.js +1 -1
  445. package/dist/unstable/cli/Prompt.d.ts +11 -6
  446. package/dist/unstable/cli/Prompt.d.ts.map +1 -1
  447. package/dist/unstable/cli/Prompt.js +26 -9
  448. package/dist/unstable/cli/Prompt.js.map +1 -1
  449. package/dist/unstable/cli/internal/parser.js +1 -1
  450. package/dist/unstable/cluster/ClusterMetrics.d.ts +5 -5
  451. package/dist/unstable/cluster/ClusterMetrics.js +5 -5
  452. package/dist/unstable/cluster/ClusterSchema.d.ts +11 -2
  453. package/dist/unstable/cluster/ClusterSchema.d.ts.map +1 -1
  454. package/dist/unstable/cluster/ClusterSchema.js +11 -2
  455. package/dist/unstable/cluster/ClusterSchema.js.map +1 -1
  456. package/dist/unstable/cluster/ClusterWorkflowEngine.d.ts.map +1 -1
  457. package/dist/unstable/cluster/ClusterWorkflowEngine.js +49 -10
  458. package/dist/unstable/cluster/ClusterWorkflowEngine.js.map +1 -1
  459. package/dist/unstable/cluster/DeliverAt.d.ts +6 -1
  460. package/dist/unstable/cluster/DeliverAt.d.ts.map +1 -1
  461. package/dist/unstable/cluster/DeliverAt.js +6 -1
  462. package/dist/unstable/cluster/DeliverAt.js.map +1 -1
  463. package/dist/unstable/cluster/Entity.d.ts +15 -5
  464. package/dist/unstable/cluster/Entity.d.ts.map +1 -1
  465. package/dist/unstable/cluster/Entity.js +15 -5
  466. package/dist/unstable/cluster/Entity.js.map +1 -1
  467. package/dist/unstable/cluster/EntityResource.d.ts +6 -6
  468. package/dist/unstable/cluster/EntityResource.d.ts.map +1 -1
  469. package/dist/unstable/cluster/EntityResource.js +9 -8
  470. package/dist/unstable/cluster/EntityResource.js.map +1 -1
  471. package/dist/unstable/cluster/Envelope.d.ts +11 -11
  472. package/dist/unstable/cluster/Envelope.d.ts.map +1 -1
  473. package/dist/unstable/cluster/Envelope.js +11 -11
  474. package/dist/unstable/cluster/Envelope.js.map +1 -1
  475. package/dist/unstable/cluster/HttpRunner.d.ts +16 -8
  476. package/dist/unstable/cluster/HttpRunner.d.ts.map +1 -1
  477. package/dist/unstable/cluster/HttpRunner.js +16 -8
  478. package/dist/unstable/cluster/HttpRunner.js.map +1 -1
  479. package/dist/unstable/cluster/Message.d.ts +10 -10
  480. package/dist/unstable/cluster/Message.js +10 -10
  481. package/dist/unstable/cluster/MessageStorage.d.ts +7 -7
  482. package/dist/unstable/cluster/MessageStorage.js +6 -6
  483. package/dist/unstable/cluster/Reply.d.ts +18 -8
  484. package/dist/unstable/cluster/Reply.d.ts.map +1 -1
  485. package/dist/unstable/cluster/Reply.js +18 -8
  486. package/dist/unstable/cluster/Reply.js.map +1 -1
  487. package/dist/unstable/cluster/Runner.d.ts +1 -1
  488. package/dist/unstable/cluster/Runner.js +1 -1
  489. package/dist/unstable/cluster/RunnerAddress.d.ts +7 -1
  490. package/dist/unstable/cluster/RunnerAddress.d.ts.map +1 -1
  491. package/dist/unstable/cluster/RunnerAddress.js +7 -1
  492. package/dist/unstable/cluster/RunnerAddress.js.map +1 -1
  493. package/dist/unstable/cluster/RunnerHealth.d.ts +4 -4
  494. package/dist/unstable/cluster/RunnerHealth.js +4 -4
  495. package/dist/unstable/cluster/RunnerServer.d.ts +4 -3
  496. package/dist/unstable/cluster/RunnerServer.d.ts.map +1 -1
  497. package/dist/unstable/cluster/RunnerServer.js +4 -3
  498. package/dist/unstable/cluster/RunnerServer.js.map +1 -1
  499. package/dist/unstable/cluster/Runners.d.ts +1 -1
  500. package/dist/unstable/cluster/ShardId.d.ts +2 -2
  501. package/dist/unstable/cluster/ShardId.js +2 -2
  502. package/dist/unstable/cluster/Sharding.d.ts +8 -3
  503. package/dist/unstable/cluster/Sharding.d.ts.map +1 -1
  504. package/dist/unstable/cluster/Sharding.js +8 -3
  505. package/dist/unstable/cluster/Sharding.js.map +1 -1
  506. package/dist/unstable/cluster/ShardingConfig.d.ts +3 -3
  507. package/dist/unstable/cluster/ShardingConfig.js +3 -3
  508. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts +1 -2
  509. package/dist/unstable/cluster/ShardingRegistrationEvent.d.ts.map +1 -1
  510. package/dist/unstable/cluster/ShardingRegistrationEvent.js +1 -2
  511. package/dist/unstable/cluster/ShardingRegistrationEvent.js.map +1 -1
  512. package/dist/unstable/cluster/SingleRunner.d.ts +1 -1
  513. package/dist/unstable/cluster/SingleRunner.js +1 -1
  514. package/dist/unstable/cluster/Snowflake.d.ts +6 -5
  515. package/dist/unstable/cluster/Snowflake.d.ts.map +1 -1
  516. package/dist/unstable/cluster/Snowflake.js +6 -5
  517. package/dist/unstable/cluster/Snowflake.js.map +1 -1
  518. package/dist/unstable/cluster/SocketRunner.d.ts +6 -1
  519. package/dist/unstable/cluster/SocketRunner.d.ts.map +1 -1
  520. package/dist/unstable/cluster/SocketRunner.js +6 -1
  521. package/dist/unstable/cluster/SocketRunner.js.map +1 -1
  522. package/dist/unstable/cluster/TestRunner.d.ts +1 -1
  523. package/dist/unstable/cluster/TestRunner.js +1 -1
  524. package/dist/unstable/encoding/Msgpack.d.ts +2 -1
  525. package/dist/unstable/encoding/Msgpack.d.ts.map +1 -1
  526. package/dist/unstable/encoding/Msgpack.js +2 -1
  527. package/dist/unstable/encoding/Msgpack.js.map +1 -1
  528. package/dist/unstable/encoding/Sse.d.ts +3 -3
  529. package/dist/unstable/encoding/Sse.js +3 -3
  530. package/dist/unstable/eventlog/EventGroup.d.ts +1 -1
  531. package/dist/unstable/eventlog/EventGroup.js +1 -1
  532. package/dist/unstable/eventlog/EventJournal.d.ts +7 -7
  533. package/dist/unstable/eventlog/EventJournal.js +5 -5
  534. package/dist/unstable/eventlog/EventLog.d.ts +11 -10
  535. package/dist/unstable/eventlog/EventLog.d.ts.map +1 -1
  536. package/dist/unstable/eventlog/EventLog.js +9 -8
  537. package/dist/unstable/eventlog/EventLog.js.map +1 -1
  538. package/dist/unstable/eventlog/EventLogEncryption.d.ts +8 -3
  539. package/dist/unstable/eventlog/EventLogEncryption.d.ts.map +1 -1
  540. package/dist/unstable/eventlog/EventLogEncryption.js +8 -3
  541. package/dist/unstable/eventlog/EventLogEncryption.js.map +1 -1
  542. package/dist/unstable/eventlog/EventLogMessage.d.ts +28 -28
  543. package/dist/unstable/eventlog/EventLogMessage.d.ts.map +1 -1
  544. package/dist/unstable/eventlog/EventLogMessage.js +27 -27
  545. package/dist/unstable/eventlog/EventLogMessage.js.map +1 -1
  546. package/dist/unstable/eventlog/EventLogRemote.d.ts +14 -4
  547. package/dist/unstable/eventlog/EventLogRemote.d.ts.map +1 -1
  548. package/dist/unstable/eventlog/EventLogRemote.js +14 -4
  549. package/dist/unstable/eventlog/EventLogRemote.js.map +1 -1
  550. package/dist/unstable/eventlog/EventLogServer.d.ts +7 -2
  551. package/dist/unstable/eventlog/EventLogServer.d.ts.map +1 -1
  552. package/dist/unstable/eventlog/EventLogServer.js +7 -2
  553. package/dist/unstable/eventlog/EventLogServer.js.map +1 -1
  554. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts +7 -2
  555. package/dist/unstable/eventlog/EventLogServerEncrypted.d.ts.map +1 -1
  556. package/dist/unstable/eventlog/EventLogServerEncrypted.js +7 -2
  557. package/dist/unstable/eventlog/EventLogServerEncrypted.js.map +1 -1
  558. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts +37 -7
  559. package/dist/unstable/eventlog/EventLogServerUnencrypted.d.ts.map +1 -1
  560. package/dist/unstable/eventlog/EventLogServerUnencrypted.js +37 -7
  561. package/dist/unstable/eventlog/EventLogServerUnencrypted.js.map +1 -1
  562. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts +33 -7
  563. package/dist/unstable/eventlog/EventLogSessionAuth.d.ts.map +1 -1
  564. package/dist/unstable/eventlog/EventLogSessionAuth.js +33 -7
  565. package/dist/unstable/eventlog/EventLogSessionAuth.js.map +1 -1
  566. package/dist/unstable/http/Cookies.d.ts +40 -39
  567. package/dist/unstable/http/Cookies.d.ts.map +1 -1
  568. package/dist/unstable/http/Cookies.js +18 -17
  569. package/dist/unstable/http/Cookies.js.map +1 -1
  570. package/dist/unstable/http/FetchHttpClient.d.ts +6 -1
  571. package/dist/unstable/http/FetchHttpClient.d.ts.map +1 -1
  572. package/dist/unstable/http/FetchHttpClient.js +6 -1
  573. package/dist/unstable/http/FetchHttpClient.js.map +1 -1
  574. package/dist/unstable/http/Headers.d.ts +8 -7
  575. package/dist/unstable/http/Headers.d.ts.map +1 -1
  576. package/dist/unstable/http/Headers.js +6 -5
  577. package/dist/unstable/http/Headers.js.map +1 -1
  578. package/dist/unstable/http/HttpBody.d.ts +6 -2
  579. package/dist/unstable/http/HttpBody.d.ts.map +1 -1
  580. package/dist/unstable/http/HttpBody.js +6 -2
  581. package/dist/unstable/http/HttpBody.js.map +1 -1
  582. package/dist/unstable/http/HttpClient.d.ts +29 -9
  583. package/dist/unstable/http/HttpClient.d.ts.map +1 -1
  584. package/dist/unstable/http/HttpClient.js +15 -5
  585. package/dist/unstable/http/HttpClient.js.map +1 -1
  586. package/dist/unstable/http/HttpClientError.d.ts +15 -14
  587. package/dist/unstable/http/HttpClientError.d.ts.map +1 -1
  588. package/dist/unstable/http/HttpClientError.js +12 -11
  589. package/dist/unstable/http/HttpClientError.js.map +1 -1
  590. package/dist/unstable/http/HttpClientRequest.d.ts +1 -1
  591. package/dist/unstable/http/HttpClientRequest.js +1 -1
  592. package/dist/unstable/http/HttpEffect.d.ts +3 -3
  593. package/dist/unstable/http/HttpEffect.js +3 -3
  594. package/dist/unstable/http/HttpMethod.d.ts +16 -5
  595. package/dist/unstable/http/HttpMethod.d.ts.map +1 -1
  596. package/dist/unstable/http/HttpMethod.js +16 -5
  597. package/dist/unstable/http/HttpMethod.js.map +1 -1
  598. package/dist/unstable/http/HttpRouter.d.ts +18 -13
  599. package/dist/unstable/http/HttpRouter.d.ts.map +1 -1
  600. package/dist/unstable/http/HttpRouter.js +14 -9
  601. package/dist/unstable/http/HttpRouter.js.map +1 -1
  602. package/dist/unstable/http/HttpServer.d.ts +4 -4
  603. package/dist/unstable/http/HttpServer.js +4 -4
  604. package/dist/unstable/http/HttpServerError.d.ts +9 -9
  605. package/dist/unstable/http/HttpServerError.js +7 -7
  606. package/dist/unstable/http/HttpServerRequest.d.ts +20 -5
  607. package/dist/unstable/http/HttpServerRequest.d.ts.map +1 -1
  608. package/dist/unstable/http/HttpServerRequest.js +20 -5
  609. package/dist/unstable/http/HttpServerRequest.js.map +1 -1
  610. package/dist/unstable/http/HttpServerResponse.d.ts +24 -24
  611. package/dist/unstable/http/HttpServerResponse.js +8 -8
  612. package/dist/unstable/http/HttpTraceContext.d.ts +4 -4
  613. package/dist/unstable/http/HttpTraceContext.js +4 -4
  614. package/dist/unstable/http/Multipart.d.ts +2 -2
  615. package/dist/unstable/http/Multipart.js +2 -2
  616. package/dist/unstable/http/Url.d.ts +14 -17
  617. package/dist/unstable/http/Url.d.ts.map +1 -1
  618. package/dist/unstable/http/Url.js +5 -6
  619. package/dist/unstable/http/Url.js.map +1 -1
  620. package/dist/unstable/http/UrlParams.d.ts +10 -10
  621. package/dist/unstable/http/UrlParams.js +6 -6
  622. package/dist/unstable/httpapi/HttpApi.d.ts +2 -2
  623. package/dist/unstable/httpapi/HttpApi.js +2 -2
  624. package/dist/unstable/httpapi/HttpApiBuilder.d.ts +3 -3
  625. package/dist/unstable/httpapi/HttpApiBuilder.js +4 -5
  626. package/dist/unstable/httpapi/HttpApiBuilder.js.map +1 -1
  627. package/dist/unstable/httpapi/HttpApiError.d.ts +2 -2
  628. package/dist/unstable/httpapi/HttpApiError.js +1 -1
  629. package/dist/unstable/httpapi/HttpApiSchema.d.ts +4 -7
  630. package/dist/unstable/httpapi/HttpApiSchema.d.ts.map +1 -1
  631. package/dist/unstable/httpapi/HttpApiSchema.js +3 -6
  632. package/dist/unstable/httpapi/HttpApiSchema.js.map +1 -1
  633. package/dist/unstable/httpapi/HttpApiSecurity.d.ts +27 -5
  634. package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map +1 -1
  635. package/dist/unstable/httpapi/HttpApiSecurity.js +26 -3
  636. package/dist/unstable/httpapi/HttpApiSecurity.js.map +1 -1
  637. package/dist/unstable/httpapi/HttpApiTest.d.ts +1 -1
  638. package/dist/unstable/httpapi/HttpApiTest.js +1 -1
  639. package/dist/unstable/httpapi/OpenApi.d.ts +7 -1
  640. package/dist/unstable/httpapi/OpenApi.d.ts.map +1 -1
  641. package/dist/unstable/httpapi/OpenApi.js +9 -3
  642. package/dist/unstable/httpapi/OpenApi.js.map +1 -1
  643. package/dist/unstable/observability/OtlpLogger.d.ts +1 -1
  644. package/dist/unstable/observability/OtlpLogger.js +1 -1
  645. package/dist/unstable/observability/PrometheusMetrics.d.ts +2 -2
  646. package/dist/unstable/observability/PrometheusMetrics.js +2 -2
  647. package/dist/unstable/persistence/KeyValueStore.d.ts +8 -3
  648. package/dist/unstable/persistence/KeyValueStore.d.ts.map +1 -1
  649. package/dist/unstable/persistence/KeyValueStore.js +6 -1
  650. package/dist/unstable/persistence/KeyValueStore.js.map +1 -1
  651. package/dist/unstable/persistence/Persistable.d.ts +8 -3
  652. package/dist/unstable/persistence/Persistable.d.ts.map +1 -1
  653. package/dist/unstable/persistence/Persistable.js +8 -3
  654. package/dist/unstable/persistence/Persistable.js.map +1 -1
  655. package/dist/unstable/persistence/PersistedQueue.d.ts +10 -5
  656. package/dist/unstable/persistence/PersistedQueue.d.ts.map +1 -1
  657. package/dist/unstable/persistence/PersistedQueue.js +9 -4
  658. package/dist/unstable/persistence/PersistedQueue.js.map +1 -1
  659. package/dist/unstable/persistence/RateLimiter.d.ts +20 -10
  660. package/dist/unstable/persistence/RateLimiter.d.ts.map +1 -1
  661. package/dist/unstable/persistence/RateLimiter.js +19 -9
  662. package/dist/unstable/persistence/RateLimiter.js.map +1 -1
  663. package/dist/unstable/process/ChildProcess.d.ts +14 -14
  664. package/dist/unstable/process/ChildProcess.js +7 -7
  665. package/dist/unstable/process/ChildProcessSpawner.d.ts +2 -2
  666. package/dist/unstable/process/ChildProcessSpawner.js +2 -2
  667. package/dist/unstable/reactivity/AsyncResult.d.ts +36 -5
  668. package/dist/unstable/reactivity/AsyncResult.d.ts.map +1 -1
  669. package/dist/unstable/reactivity/AsyncResult.js +14 -3
  670. package/dist/unstable/reactivity/AsyncResult.js.map +1 -1
  671. package/dist/unstable/reactivity/Atom.d.ts +45 -13
  672. package/dist/unstable/reactivity/Atom.d.ts.map +1 -1
  673. package/dist/unstable/reactivity/Atom.js +34 -10
  674. package/dist/unstable/reactivity/Atom.js.map +1 -1
  675. package/dist/unstable/reactivity/AtomRegistry.d.ts +7 -2
  676. package/dist/unstable/reactivity/AtomRegistry.d.ts.map +1 -1
  677. package/dist/unstable/reactivity/AtomRegistry.js +7 -2
  678. package/dist/unstable/reactivity/AtomRegistry.js.map +1 -1
  679. package/dist/unstable/reactivity/Hydration.d.ts +6 -1
  680. package/dist/unstable/reactivity/Hydration.d.ts.map +1 -1
  681. package/dist/unstable/reactivity/Hydration.js +6 -1
  682. package/dist/unstable/reactivity/Hydration.js.map +1 -1
  683. package/dist/unstable/reactivity/Reactivity.d.ts +6 -1
  684. package/dist/unstable/reactivity/Reactivity.d.ts.map +1 -1
  685. package/dist/unstable/reactivity/Reactivity.js +6 -1
  686. package/dist/unstable/reactivity/Reactivity.js.map +1 -1
  687. package/dist/unstable/rpc/Rpc.d.ts +18 -14
  688. package/dist/unstable/rpc/Rpc.d.ts.map +1 -1
  689. package/dist/unstable/rpc/Rpc.js +15 -11
  690. package/dist/unstable/rpc/Rpc.js.map +1 -1
  691. package/dist/unstable/rpc/RpcClient.d.ts +27 -12
  692. package/dist/unstable/rpc/RpcClient.d.ts.map +1 -1
  693. package/dist/unstable/rpc/RpcClient.js +27 -12
  694. package/dist/unstable/rpc/RpcClient.js.map +1 -1
  695. package/dist/unstable/rpc/RpcClientError.d.ts +2 -2
  696. package/dist/unstable/rpc/RpcClientError.js +2 -2
  697. package/dist/unstable/rpc/RpcMessage.d.ts +5 -5
  698. package/dist/unstable/rpc/RpcMessage.js +4 -4
  699. package/dist/unstable/rpc/RpcSchema.d.ts +1 -1
  700. package/dist/unstable/rpc/RpcSchema.js +1 -1
  701. package/dist/unstable/rpc/RpcSerialization.d.ts +19 -12
  702. package/dist/unstable/rpc/RpcSerialization.d.ts.map +1 -1
  703. package/dist/unstable/rpc/RpcSerialization.js +19 -12
  704. package/dist/unstable/rpc/RpcSerialization.js.map +1 -1
  705. package/dist/unstable/rpc/RpcServer.d.ts +22 -17
  706. package/dist/unstable/rpc/RpcServer.d.ts.map +1 -1
  707. package/dist/unstable/rpc/RpcServer.js +22 -17
  708. package/dist/unstable/rpc/RpcServer.js.map +1 -1
  709. package/dist/unstable/schema/Model.d.ts +32 -33
  710. package/dist/unstable/schema/Model.d.ts.map +1 -1
  711. package/dist/unstable/schema/Model.js +25 -26
  712. package/dist/unstable/schema/Model.js.map +1 -1
  713. package/dist/unstable/schema/VariantSchema.d.ts +1 -1
  714. package/dist/unstable/schema/VariantSchema.js +1 -1
  715. package/dist/unstable/socket/Socket.d.ts +8 -2
  716. package/dist/unstable/socket/Socket.d.ts.map +1 -1
  717. package/dist/unstable/socket/Socket.js +8 -2
  718. package/dist/unstable/socket/Socket.js.map +1 -1
  719. package/dist/unstable/socket/SocketServer.d.ts +2 -2
  720. package/dist/unstable/socket/SocketServer.js +1 -1
  721. package/dist/unstable/sql/SqlClient.d.ts +7 -2
  722. package/dist/unstable/sql/SqlClient.d.ts.map +1 -1
  723. package/dist/unstable/sql/SqlClient.js +7 -2
  724. package/dist/unstable/sql/SqlClient.js.map +1 -1
  725. package/dist/unstable/sql/SqlConnection.d.ts +1 -1
  726. package/dist/unstable/sql/SqlConnection.js +1 -1
  727. package/dist/unstable/sql/SqlError.d.ts +2 -2
  728. package/dist/unstable/sql/SqlError.js +2 -2
  729. package/dist/unstable/sql/SqlResolver.d.ts +3 -3
  730. package/dist/unstable/sql/SqlResolver.js +1 -1
  731. package/dist/unstable/sql/SqlSchema.d.ts +19 -4
  732. package/dist/unstable/sql/SqlSchema.d.ts.map +1 -1
  733. package/dist/unstable/sql/SqlSchema.js +19 -4
  734. package/dist/unstable/sql/SqlSchema.js.map +1 -1
  735. package/dist/unstable/workers/Transferable.d.ts +3 -6
  736. package/dist/unstable/workers/Transferable.d.ts.map +1 -1
  737. package/dist/unstable/workers/Transferable.js +3 -6
  738. package/dist/unstable/workers/Transferable.js.map +1 -1
  739. package/dist/unstable/workers/Worker.d.ts +1 -1
  740. package/dist/unstable/workers/Worker.js +1 -1
  741. package/dist/unstable/workers/WorkerError.d.ts +1 -1
  742. package/dist/unstable/workflow/DurableClock.d.ts +2 -2
  743. package/dist/unstable/workflow/DurableClock.js +2 -2
  744. package/dist/unstable/workflow/DurableDeferred.d.ts +12 -12
  745. package/dist/unstable/workflow/DurableDeferred.js +7 -7
  746. package/dist/unstable/workflow/DurableQueue.d.ts +3 -3
  747. package/dist/unstable/workflow/DurableQueue.js +3 -3
  748. package/dist/unstable/workflow/Workflow.d.ts +22 -23
  749. package/dist/unstable/workflow/Workflow.d.ts.map +1 -1
  750. package/dist/unstable/workflow/Workflow.js +17 -18
  751. package/dist/unstable/workflow/Workflow.js.map +1 -1
  752. package/dist/unstable/workflow/WorkflowEngine.d.ts +26 -8
  753. package/dist/unstable/workflow/WorkflowEngine.d.ts.map +1 -1
  754. package/dist/unstable/workflow/WorkflowEngine.js +25 -7
  755. package/dist/unstable/workflow/WorkflowEngine.js.map +1 -1
  756. package/package.json +1 -1
  757. package/src/Array.ts +65 -113
  758. package/src/BigDecimal.ts +66 -58
  759. package/src/BigInt.ts +21 -19
  760. package/src/Boolean.ts +15 -17
  761. package/src/Brand.ts +2 -3
  762. package/src/Cache.ts +9 -9
  763. package/src/Cause.ts +35 -39
  764. package/src/Channel.ts +149 -107
  765. package/src/ChannelSchema.ts +3 -3
  766. package/src/Chunk.ts +67 -54
  767. package/src/Clock.ts +3 -3
  768. package/src/Combiner.ts +6 -10
  769. package/src/Config.ts +9 -10
  770. package/src/ConfigProvider.ts +4 -4
  771. package/src/Console.ts +11 -7
  772. package/src/Context.ts +36 -36
  773. package/src/Cron.ts +7 -6
  774. package/src/Crypto.ts +1 -1
  775. package/src/Data.ts +26 -32
  776. package/src/DateTime.ts +164 -122
  777. package/src/Deferred.ts +6 -6
  778. package/src/Duration.ts +39 -39
  779. package/src/Effect.ts +220 -309
  780. package/src/Effectable.ts +2 -2
  781. package/src/Encoding.ts +13 -10
  782. package/src/Equal.ts +3 -4
  783. package/src/Equivalence.ts +5 -19
  784. package/src/ErrorReporter.ts +14 -13
  785. package/src/ExecutionPlan.ts +7 -2
  786. package/src/Exit.ts +25 -23
  787. package/src/Fiber.ts +4 -4
  788. package/src/FiberHandle.ts +6 -6
  789. package/src/FiberMap.ts +20 -20
  790. package/src/FiberSet.ts +21 -13
  791. package/src/FileSystem.ts +13 -9
  792. package/src/Filter.ts +2 -2
  793. package/src/Formatter.ts +1 -3
  794. package/src/Function.ts +12 -12
  795. package/src/Graph.ts +22 -22
  796. package/src/HKT.ts +5 -4
  797. package/src/Hash.ts +3 -3
  798. package/src/HashMap.ts +33 -35
  799. package/src/HashRing.ts +7 -9
  800. package/src/HashSet.ts +16 -16
  801. package/src/Inspectable.ts +4 -4
  802. package/src/Iterable.ts +82 -56
  803. package/src/JsonPatch.ts +1 -1
  804. package/src/JsonPointer.ts +3 -3
  805. package/src/JsonSchema.ts +13 -23
  806. package/src/Latch.ts +2 -2
  807. package/src/Layer.ts +47 -27
  808. package/src/LayerMap.ts +1 -2
  809. package/src/LogLevel.ts +3 -3
  810. package/src/Logger.ts +6 -6
  811. package/src/ManagedRuntime.ts +1 -1
  812. package/src/Match.ts +32 -37
  813. package/src/Metric.ts +35 -21
  814. package/src/MutableHashMap.ts +21 -31
  815. package/src/MutableHashSet.ts +4 -4
  816. package/src/MutableList.ts +16 -6
  817. package/src/MutableRef.ts +5 -4
  818. package/src/NonEmptyIterable.ts +3 -3
  819. package/src/Number.ts +20 -18
  820. package/src/Optic.ts +11 -18
  821. package/src/Option.ts +21 -24
  822. package/src/Order.ts +11 -38
  823. package/src/Ordering.ts +5 -5
  824. package/src/PartitionedSemaphore.ts +4 -8
  825. package/src/Path.ts +4 -7
  826. package/src/Pipeable.ts +2 -2
  827. package/src/PlatformError.ts +1 -1
  828. package/src/Predicate.ts +2 -81
  829. package/src/PrimaryKey.ts +3 -3
  830. package/src/PubSub.ts +147 -46
  831. package/src/Pull.ts +1 -1
  832. package/src/Queue.ts +40 -24
  833. package/src/RcMap.ts +3 -3
  834. package/src/Record.ts +79 -52
  835. package/src/Redactable.ts +7 -7
  836. package/src/Reducer.ts +0 -2
  837. package/src/Ref.ts +32 -32
  838. package/src/References.ts +20 -20
  839. package/src/RegExp.ts +2 -2
  840. package/src/Request.ts +3 -3
  841. package/src/RequestResolver.ts +11 -14
  842. package/src/Result.ts +52 -34
  843. package/src/Runtime.ts +1 -1
  844. package/src/Schedule.ts +28 -36
  845. package/src/Scheduler.ts +3 -3
  846. package/src/Schema.ts +480 -210
  847. package/src/SchemaAST.ts +40 -32
  848. package/src/SchemaGetter.ts +4 -6
  849. package/src/SchemaIssue.ts +35 -47
  850. package/src/SchemaParser.ts +16 -12
  851. package/src/SchemaRepresentation.ts +47 -62
  852. package/src/SchemaTransformation.ts +16 -18
  853. package/src/Scope.ts +51 -14
  854. package/src/ScopedCache.ts +14 -14
  855. package/src/ScopedRef.ts +2 -2
  856. package/src/Semaphore.ts +1 -1
  857. package/src/Sink.ts +36 -41
  858. package/src/Stdio.ts +5 -4
  859. package/src/Stream.ts +275 -176
  860. package/src/String.ts +50 -49
  861. package/src/Struct.ts +35 -100
  862. package/src/SubscriptionRef.ts +268 -91
  863. package/src/Symbol.ts +1 -1
  864. package/src/SynchronizedRef.ts +27 -27
  865. package/src/Terminal.ts +8 -3
  866. package/src/Tracer.ts +25 -7
  867. package/src/Trie.ts +21 -23
  868. package/src/Tuple.ts +26 -73
  869. package/src/TxChunk.ts +2 -2
  870. package/src/TxHashMap.ts +22 -22
  871. package/src/TxHashSet.ts +22 -22
  872. package/src/TxPriorityQueue.ts +14 -6
  873. package/src/TxPubSub.ts +4 -4
  874. package/src/TxQueue.ts +10 -10
  875. package/src/TxReentrantLock.ts +48 -12
  876. package/src/TxRef.ts +1 -1
  877. package/src/TxSubscriptionRef.ts +1 -1
  878. package/src/Types.ts +8 -7
  879. package/src/Unify.ts +19 -19
  880. package/src/Utils.ts +1 -2
  881. package/src/testing/TestSchema.ts +3 -11
  882. package/src/unstable/ai/AiError.ts +10 -5
  883. package/src/unstable/ai/Chat.ts +20 -5
  884. package/src/unstable/ai/EmbeddingModel.ts +5 -4
  885. package/src/unstable/ai/IdGenerator.ts +7 -2
  886. package/src/unstable/ai/LanguageModel.ts +10 -5
  887. package/src/unstable/ai/McpSchema.ts +291 -169
  888. package/src/unstable/ai/McpServer.ts +49 -13
  889. package/src/unstable/ai/Prompt.ts +1 -1
  890. package/src/unstable/ai/Response.ts +1 -1
  891. package/src/unstable/ai/Tokenizer.ts +7 -2
  892. package/src/unstable/ai/Tool.ts +3 -3
  893. package/src/unstable/cli/CliError.ts +3 -3
  894. package/src/unstable/cli/CliOutput.ts +1 -1
  895. package/src/unstable/cli/Command.ts +3 -3
  896. package/src/unstable/cli/Flag.ts +9 -9
  897. package/src/unstable/cli/GlobalFlag.ts +13 -6
  898. package/src/unstable/cli/Param.ts +2 -2
  899. package/src/unstable/cli/Primitive.ts +1 -1
  900. package/src/unstable/cli/Prompt.ts +37 -13
  901. package/src/unstable/cli/internal/parser.ts +1 -1
  902. package/src/unstable/cluster/ClusterMetrics.ts +5 -5
  903. package/src/unstable/cluster/ClusterSchema.ts +11 -2
  904. package/src/unstable/cluster/ClusterWorkflowEngine.ts +63 -11
  905. package/src/unstable/cluster/DeliverAt.ts +6 -1
  906. package/src/unstable/cluster/Entity.ts +15 -5
  907. package/src/unstable/cluster/EntityResource.ts +13 -10
  908. package/src/unstable/cluster/Envelope.ts +11 -11
  909. package/src/unstable/cluster/HttpRunner.ts +16 -8
  910. package/src/unstable/cluster/Message.ts +10 -10
  911. package/src/unstable/cluster/MessageStorage.ts +7 -7
  912. package/src/unstable/cluster/Reply.ts +18 -8
  913. package/src/unstable/cluster/Runner.ts +1 -1
  914. package/src/unstable/cluster/RunnerAddress.ts +7 -1
  915. package/src/unstable/cluster/RunnerHealth.ts +4 -4
  916. package/src/unstable/cluster/RunnerServer.ts +4 -3
  917. package/src/unstable/cluster/Runners.ts +1 -1
  918. package/src/unstable/cluster/ShardId.ts +2 -2
  919. package/src/unstable/cluster/Sharding.ts +8 -3
  920. package/src/unstable/cluster/ShardingConfig.ts +3 -3
  921. package/src/unstable/cluster/ShardingRegistrationEvent.ts +1 -2
  922. package/src/unstable/cluster/SingleRunner.ts +1 -1
  923. package/src/unstable/cluster/Snowflake.ts +6 -5
  924. package/src/unstable/cluster/SocketRunner.ts +6 -1
  925. package/src/unstable/cluster/TestRunner.ts +1 -1
  926. package/src/unstable/encoding/Msgpack.ts +2 -1
  927. package/src/unstable/encoding/Sse.ts +3 -3
  928. package/src/unstable/eventlog/EventGroup.ts +1 -1
  929. package/src/unstable/eventlog/EventJournal.ts +7 -7
  930. package/src/unstable/eventlog/EventLog.ts +11 -10
  931. package/src/unstable/eventlog/EventLogEncryption.ts +8 -3
  932. package/src/unstable/eventlog/EventLogMessage.ts +28 -28
  933. package/src/unstable/eventlog/EventLogRemote.ts +14 -4
  934. package/src/unstable/eventlog/EventLogServer.ts +7 -2
  935. package/src/unstable/eventlog/EventLogServerEncrypted.ts +7 -2
  936. package/src/unstable/eventlog/EventLogServerUnencrypted.ts +37 -7
  937. package/src/unstable/eventlog/EventLogSessionAuth.ts +33 -7
  938. package/src/unstable/http/Cookies.ts +40 -39
  939. package/src/unstable/http/FetchHttpClient.ts +6 -1
  940. package/src/unstable/http/Headers.ts +10 -9
  941. package/src/unstable/http/HttpBody.ts +6 -2
  942. package/src/unstable/http/HttpClient.ts +29 -9
  943. package/src/unstable/http/HttpClientError.ts +15 -14
  944. package/src/unstable/http/HttpClientRequest.ts +1 -1
  945. package/src/unstable/http/HttpEffect.ts +3 -3
  946. package/src/unstable/http/HttpMethod.ts +16 -5
  947. package/src/unstable/http/HttpRouter.ts +18 -13
  948. package/src/unstable/http/HttpServer.ts +4 -4
  949. package/src/unstable/http/HttpServerError.ts +9 -9
  950. package/src/unstable/http/HttpServerRequest.ts +20 -5
  951. package/src/unstable/http/HttpServerResponse.ts +24 -24
  952. package/src/unstable/http/HttpTraceContext.ts +4 -4
  953. package/src/unstable/http/Multipart.ts +2 -2
  954. package/src/unstable/http/Url.ts +14 -17
  955. package/src/unstable/http/UrlParams.ts +10 -10
  956. package/src/unstable/httpapi/HttpApi.ts +2 -2
  957. package/src/unstable/httpapi/HttpApiBuilder.ts +5 -6
  958. package/src/unstable/httpapi/HttpApiError.ts +2 -2
  959. package/src/unstable/httpapi/HttpApiSchema.ts +4 -7
  960. package/src/unstable/httpapi/HttpApiSecurity.ts +36 -8
  961. package/src/unstable/httpapi/HttpApiTest.ts +1 -1
  962. package/src/unstable/httpapi/OpenApi.ts +9 -3
  963. package/src/unstable/observability/OtlpLogger.ts +1 -1
  964. package/src/unstable/observability/PrometheusMetrics.ts +2 -2
  965. package/src/unstable/persistence/KeyValueStore.ts +8 -3
  966. package/src/unstable/persistence/Persistable.ts +8 -3
  967. package/src/unstable/persistence/PersistedQueue.ts +10 -5
  968. package/src/unstable/persistence/RateLimiter.ts +20 -10
  969. package/src/unstable/process/ChildProcess.ts +14 -14
  970. package/src/unstable/process/ChildProcessSpawner.ts +2 -2
  971. package/src/unstable/reactivity/AsyncResult.ts +58 -7
  972. package/src/unstable/reactivity/Atom.ts +53 -13
  973. package/src/unstable/reactivity/AtomRegistry.ts +7 -2
  974. package/src/unstable/reactivity/Hydration.ts +6 -1
  975. package/src/unstable/reactivity/Reactivity.ts +6 -1
  976. package/src/unstable/rpc/Rpc.ts +18 -14
  977. package/src/unstable/rpc/RpcClient.ts +27 -12
  978. package/src/unstable/rpc/RpcClientError.ts +2 -2
  979. package/src/unstable/rpc/RpcMessage.ts +5 -5
  980. package/src/unstable/rpc/RpcSchema.ts +1 -1
  981. package/src/unstable/rpc/RpcSerialization.ts +19 -12
  982. package/src/unstable/rpc/RpcServer.ts +22 -17
  983. package/src/unstable/schema/Model.ts +32 -33
  984. package/src/unstable/schema/VariantSchema.ts +1 -1
  985. package/src/unstable/socket/Socket.ts +8 -2
  986. package/src/unstable/socket/SocketServer.ts +2 -2
  987. package/src/unstable/sql/SqlClient.ts +7 -2
  988. package/src/unstable/sql/SqlConnection.ts +1 -1
  989. package/src/unstable/sql/SqlError.ts +2 -2
  990. package/src/unstable/sql/SqlResolver.ts +3 -3
  991. package/src/unstable/sql/SqlSchema.ts +19 -4
  992. package/src/unstable/workers/Transferable.ts +3 -6
  993. package/src/unstable/workers/Worker.ts +1 -1
  994. package/src/unstable/workers/WorkerError.ts +1 -1
  995. package/src/unstable/workflow/DurableClock.ts +2 -2
  996. package/src/unstable/workflow/DurableDeferred.ts +12 -12
  997. package/src/unstable/workflow/DurableQueue.ts +3 -3
  998. package/src/unstable/workflow/Workflow.ts +22 -23
  999. package/src/unstable/workflow/WorkflowEngine.ts +26 -8
@@ -110,9 +110,9 @@ export const optional = <S extends Schema.Top>(schema: S): Schema.decodeTo<Schem
110
110
  // =============================================================================
111
111
 
112
112
  /**
113
- * A uniquely identifying ID for a request in JSON-RPC.
113
+ * Schema for JSON-RPC request identifiers, allowing string or number ids.
114
114
  *
115
- * @category common
115
+ * @category schemas
116
116
  * @since 4.0.0
117
117
  */
118
118
  export const RequestId: Schema.Union<[
@@ -121,18 +121,18 @@ export const RequestId: Schema.Union<[
121
121
  ]> = Schema.Union([Schema.String, Schema.Number])
122
122
 
123
123
  /**
124
- * A uniquely identifying ID for a request in JSON-RPC.
124
+ * Type represented by the JSON-RPC request identifier schema.
125
125
  *
126
- * @category common
126
+ * @category models
127
127
  * @since 4.0.0
128
128
  */
129
129
  export type RequestId = typeof RequestId.Type
130
130
 
131
131
  /**
132
- * A progress token, used to associate progress notifications with the original
133
- * request.
132
+ * Schema for MCP progress tokens that associate progress notifications with the
133
+ * original request.
134
134
  *
135
- * @category common
135
+ * @category schemas
136
136
  * @since 4.0.0
137
137
  */
138
138
  export const ProgressToken: Schema.Union<[
@@ -141,10 +141,9 @@ export const ProgressToken: Schema.Union<[
141
141
  ]> = Schema.Union([Schema.String, Schema.Number])
142
142
 
143
143
  /**
144
- * A progress token, used to associate progress notifications with the original
145
- * request.
144
+ * Type represented by the MCP progress token schema.
146
145
  *
147
- * @category common
146
+ * @category models
148
147
  * @since 4.0.0
149
148
  */
150
149
  export type ProgressToken = typeof ProgressToken.Type
@@ -157,7 +156,7 @@ export type ProgressToken = typeof ProgressToken.Type
157
156
  * Request metadata may include a progress token that asks the receiver to send
158
157
  * out-of-band progress notifications for the request.
159
158
  *
160
- * @category common
159
+ * @category schemas
161
160
  * @since 4.0.0
162
161
  */
163
162
  export class RequestMeta extends Schema.Opaque<RequestMeta>()(Schema.Struct({
@@ -181,7 +180,7 @@ export class RequestMeta extends Schema.Opaque<RequestMeta>()(Schema.Struct({
181
180
  * The `_meta` field is reserved for protocol, extension, or implementation
182
181
  * metadata attached to a result.
183
182
  *
184
- * @category common
183
+ * @category schemas
185
184
  * @since 4.0.0
186
185
  */
187
186
  export class ResultMeta extends Schema.Opaque<ResultMeta>()(Schema.Struct({
@@ -200,7 +199,7 @@ export class ResultMeta extends Schema.Opaque<ResultMeta>()(Schema.Struct({
200
199
  * The `_meta` field is reserved for protocol, extension, or implementation
201
200
  * metadata attached to a notification.
202
201
  *
203
- * @category common
202
+ * @category schemas
204
203
  * @since 4.0.0
205
204
  */
206
205
  export class NotificationMeta extends Schema.Opaque<NotificationMeta>()(Schema.Struct({
@@ -212,9 +211,9 @@ export class NotificationMeta extends Schema.Opaque<NotificationMeta>()(Schema.S
212
211
  })) {}
213
212
 
214
213
  /**
215
- * An opaque token used to represent a cursor for pagination.
214
+ * Schema for opaque cursor tokens used in pagination.
216
215
  *
217
- * @category common
216
+ * @category schemas
218
217
  * @since 4.0.0
219
218
  */
220
219
  export const Cursor: typeof Schema.String = Schema.String
@@ -226,7 +225,7 @@ export const Cursor: typeof Schema.String = Schema.String
226
225
  *
227
226
  * A cursor is an opaque string token used to continue paginated requests.
228
227
  *
229
- * @category common
228
+ * @category models
230
229
  * @since 4.0.0
231
230
  */
232
231
  export type Cursor = typeof Cursor.Type
@@ -239,7 +238,7 @@ export type Cursor = typeof Cursor.Type
239
238
  * It includes the base request metadata fields plus an optional cursor
240
239
  * indicating where the server should continue listing results.
241
240
  *
242
- * @category common
241
+ * @category schemas
243
242
  * @since 4.0.0
244
243
  */
245
244
  export class PaginatedRequestMeta extends Schema.Opaque<PaginatedRequestMeta>()(Schema.Struct({
@@ -259,7 +258,7 @@ export class PaginatedRequestMeta extends Schema.Opaque<PaginatedRequestMeta>()(
259
258
  * It includes the base result metadata fields plus an optional `nextCursor`,
260
259
  * which indicates that more results may be available.
261
260
  *
262
- * @category common
261
+ * @category schemas
263
262
  * @since 4.0.0
264
263
  */
265
264
  export class PaginatedResultMeta extends Schema.Opaque<PaginatedResultMeta>()(Schema.Struct({
@@ -272,9 +271,9 @@ export class PaginatedResultMeta extends Schema.Opaque<PaginatedResultMeta>()(Sc
272
271
  })) {}
273
272
 
274
273
  /**
275
- * The sender or recipient of messages and data in a conversation.
274
+ * Schema for MCP conversation roles, allowing user and assistant.
276
275
  *
277
- * @category common
276
+ * @category schemas
278
277
  * @since 4.0.0
279
278
  */
280
279
  export const Role: Schema.Literals<["user", "assistant"]> = Schema.Literals(["user", "assistant"])
@@ -286,16 +285,20 @@ export const Role: Schema.Literals<["user", "assistant"]> = Schema.Literals(["us
286
285
  *
287
286
  * Valid roles are `"user"` and `"assistant"`.
288
287
  *
289
- * @category common
288
+ * @category models
290
289
  * @since 4.0.0
291
290
  */
292
291
  export type Role = typeof Role.Type
293
292
 
294
293
  /**
295
- * Optional annotations for the client. The client can use annotations to
296
- * inform how objects are used or displayed.
294
+ * Schema for optional client-facing annotations on MCP objects.
295
+ *
296
+ * **When to use**
297
+ *
298
+ * Use to describe intended audience and priority metadata for objects shown or
299
+ * processed by a client.
297
300
  *
298
- * @category common
301
+ * @category schemas
299
302
  * @since 4.0.0
300
303
  */
301
304
  export class Annotations extends Schema.Opaque<Annotations>()(Schema.Struct({
@@ -319,7 +322,7 @@ export class Annotations extends Schema.Opaque<Annotations>()(Schema.Struct({
319
322
  /**
320
323
  * Describes the name and version of an MCP implementation.
321
324
  *
322
- * @category common
325
+ * @category schemas
323
326
  * @since 4.0.0
324
327
  */
325
328
  export class Implementation extends Schema.Opaque<Implementation>()(Schema.Struct({
@@ -329,11 +332,19 @@ export class Implementation extends Schema.Opaque<Implementation>()(Schema.Struc
329
332
  })) {}
330
333
 
331
334
  /**
332
- * Capabilities a client may support. Known capabilities are defined here, in
333
- * this schema, but this is not a closed set: any client can define its own,
334
- * additional capabilities.
335
+ * Describes capabilities advertised by an MCP client.
336
+ *
337
+ * **When to use**
338
+ *
339
+ * Use to describe which optional MCP features a client supports during
340
+ * initialization.
335
341
  *
336
- * @category common
342
+ * **Details**
343
+ *
344
+ * Known capabilities are represented by this schema, but the capability set is
345
+ * open and clients may define additional capabilities.
346
+ *
347
+ * @category schemas
337
348
  * @since 4.0.0
338
349
  */
339
350
  export class ClientCapabilities extends Schema.Class<ClientCapabilities>(
@@ -368,11 +379,19 @@ export class ClientCapabilities extends Schema.Class<ClientCapabilities>(
368
379
  }) {}
369
380
 
370
381
  /**
371
- * Capabilities that a server may support. Known capabilities are defined
372
- * here, in this schema, but this is not a closed set: any server can define
373
- * its own, additional capabilities.
382
+ * Describes capabilities advertised by an MCP server.
374
383
  *
375
- * @category common
384
+ * **When to use**
385
+ *
386
+ * Use to describe which optional MCP features a server supports during
387
+ * initialization.
388
+ *
389
+ * **Details**
390
+ *
391
+ * Known capabilities are represented by this schema, but the capability set is
392
+ * open and servers may define additional capabilities.
393
+ *
394
+ * @category schemas
376
395
  * @since 4.0.0
377
396
  */
378
397
  export class ServerCapabilities extends Schema.Opaque<ServerCapabilities>()(Schema.Struct({
@@ -431,14 +450,14 @@ export class ServerCapabilities extends Schema.Opaque<ServerCapabilities>()(Sche
431
450
  // =============================================================================
432
451
 
433
452
  /**
434
- * Base schema for MCP and JSON-RPC error objects.
453
+ * Schema for MCP and JSON-RPC error objects.
435
454
  *
436
455
  * **Details**
437
456
  *
438
457
  * It contains the numeric error `code`, a concise `message`, and optional
439
458
  * sender-defined `data`.
440
459
  *
441
- * @category errors
460
+ * @category schemas
442
461
  * @since 4.0.0
443
462
  */
444
463
  export class McpErrorBase extends Schema.Class<McpErrorBase>(
@@ -461,45 +480,76 @@ export class McpErrorBase extends Schema.Class<McpErrorBase>(
461
480
  }) {}
462
481
 
463
482
  /**
464
- * JSON-RPC error code for requests that are not valid request objects.
483
+ * Represents the JSON-RPC error code for requests that are not valid request objects.
465
484
  *
466
- * @category errors
485
+ * **When to use**
486
+ *
487
+ * Use when you need the JSON-RPC error code for requests that are not valid
488
+ * request objects.
489
+ *
490
+ * @category constants
467
491
  * @since 4.0.0
468
492
  */
469
493
  export const INVALID_REQUEST_ERROR_CODE = -32600 as const
470
494
  /**
471
- * JSON-RPC error code for requests whose method does not exist or is not
495
+ * Represents the JSON-RPC error code for requests whose method does not exist or is not
472
496
  * available.
473
497
  *
474
- * @category errors
498
+ * **When to use**
499
+ *
500
+ * Use when you need the JSON-RPC error code for requests whose method does not
501
+ * exist or is not available.
502
+ *
503
+ * @category constants
475
504
  * @since 4.0.0
476
505
  */
477
506
  export const METHOD_NOT_FOUND_ERROR_CODE = -32601 as const
478
507
  /**
479
- * JSON-RPC error code for invalid method parameters.
508
+ * Represents the JSON-RPC error code for invalid method parameters.
480
509
  *
481
- * @category errors
510
+ * **When to use**
511
+ *
512
+ * Use when you need the JSON-RPC error code for invalid method parameters.
513
+ *
514
+ * @category constants
482
515
  * @since 4.0.0
483
516
  */
484
517
  export const INVALID_PARAMS_ERROR_CODE = -32602 as const
485
518
  /**
486
- * JSON-RPC error code for internal server errors.
519
+ * Represents the JSON-RPC error code for internal server errors.
487
520
  *
488
- * @category errors
521
+ * **When to use**
522
+ *
523
+ * Use when you need the JSON-RPC error code for internal server errors.
524
+ *
525
+ * @category constants
489
526
  * @since 4.0.0
490
527
  */
491
528
  export const INTERNAL_ERROR_CODE = -32603 as const
492
529
  /**
493
- * JSON-RPC error code for invalid JSON that could not be parsed.
530
+ * Represents the JSON-RPC error code for invalid JSON that could not be parsed.
494
531
  *
495
- * @category errors
532
+ * **When to use**
533
+ *
534
+ * Use when you need the JSON-RPC error code for invalid JSON that could not be
535
+ * parsed.
536
+ *
537
+ * @category constants
496
538
  * @since 4.0.0
497
539
  */
498
540
  export const PARSE_ERROR_CODE = -32700 as const
499
541
 
500
542
  /**
501
- * MCP/JSON-RPC error for invalid JSON that could not be parsed. This error
502
- * uses the standard parse error code `-32700`.
543
+ * Represents an MCP/JSON-RPC error for invalid JSON that could not be parsed.
544
+ *
545
+ * **When to use**
546
+ *
547
+ * Use to report a JSON parse failure before a valid JSON-RPC request object is
548
+ * available.
549
+ *
550
+ * **Details**
551
+ *
552
+ * Uses the standard JSON-RPC parse error code `-32700`.
503
553
  *
504
554
  * @category errors
505
555
  * @since 4.0.0
@@ -511,8 +561,16 @@ export class ParseError extends Schema.ErrorClass<ParseError>("effect/ai/McpSche
511
561
  }) {}
512
562
 
513
563
  /**
514
- * MCP/JSON-RPC error for a request object that is not valid. This error uses
515
- * the standard invalid request code `-32600`.
564
+ * Represents an MCP/JSON-RPC error for a request object that is not valid.
565
+ *
566
+ * **When to use**
567
+ *
568
+ * Use to report a syntactically parsed JSON-RPC request that is not a valid
569
+ * request object.
570
+ *
571
+ * **Details**
572
+ *
573
+ * Uses the standard JSON-RPC invalid request code `-32600`.
516
574
  *
517
575
  * @category errors
518
576
  * @since 4.0.0
@@ -524,8 +582,15 @@ export class InvalidRequest extends Schema.ErrorClass<InvalidRequest>("effect/ai
524
582
  }) {}
525
583
 
526
584
  /**
527
- * MCP/JSON-RPC error for a method that does not exist or is not available.
528
- * This error uses the standard method not found code `-32601`.
585
+ * Represents an MCP/JSON-RPC error for an unavailable method.
586
+ *
587
+ * **When to use**
588
+ *
589
+ * Use to report a JSON-RPC method that does not exist or is not available.
590
+ *
591
+ * **Details**
592
+ *
593
+ * Uses the standard JSON-RPC method-not-found code `-32601`.
529
594
  *
530
595
  * @category errors
531
596
  * @since 4.0.0
@@ -537,8 +602,16 @@ export class MethodNotFound extends Schema.ErrorClass<MethodNotFound>("effect/ai
537
602
  }) {}
538
603
 
539
604
  /**
540
- * MCP/JSON-RPC error for invalid method parameters. This error uses the
541
- * standard invalid params code `-32602`.
605
+ * Represents an MCP/JSON-RPC error for invalid method parameters.
606
+ *
607
+ * **When to use**
608
+ *
609
+ * Use to report a request whose method parameters do not match the method
610
+ * schema.
611
+ *
612
+ * **Details**
613
+ *
614
+ * Uses the standard JSON-RPC invalid params code `-32602`.
542
615
  *
543
616
  * @category errors
544
617
  * @since 4.0.0
@@ -550,8 +623,16 @@ export class InvalidParams extends Schema.ErrorClass<InvalidParams>("effect/ai/M
550
623
  }) {}
551
624
 
552
625
  /**
553
- * MCP/JSON-RPC error for unexpected internal server failures. This error uses
554
- * the standard internal error code `-32603` and includes
626
+ * Represents an MCP/JSON-RPC error for unexpected internal server failures.
627
+ *
628
+ * **When to use**
629
+ *
630
+ * Use to report an unexpected server-side failure while handling a valid
631
+ * request.
632
+ *
633
+ * **Details**
634
+ *
635
+ * Uses the standard JSON-RPC internal error code `-32603` and includes
555
636
  * `InternalError.notImplemented` for unimplemented handlers.
556
637
  *
557
638
  * @category errors
@@ -586,9 +667,15 @@ export const McpError = Schema.Union([
586
667
  // =============================================================================
587
668
 
588
669
  /**
589
- * A ping, issued by either the server or the client, to check that the other
590
- * party is still alive. The receiver must promptly respond, or else may be
591
- * disconnected.
670
+ * Represents an MCP ping request used to check whether the peer is still alive.
671
+ *
672
+ * **When to use**
673
+ *
674
+ * Use to implement client or server liveness checks.
675
+ *
676
+ * **Details**
677
+ *
678
+ * The receiver should respond promptly; otherwise the sender may disconnect.
592
679
  *
593
680
  * @category ping
594
681
  * @since 4.0.0
@@ -604,8 +691,7 @@ export class Ping extends Rpc.make("ping", {
604
691
  // =============================================================================
605
692
 
606
693
  /**
607
- * After receiving an initialize request from the client, the server sends this
608
- * response.
694
+ * Schema for the server's response to an initialize request from the client.
609
695
  *
610
696
  * @category initialization
611
697
  * @since 4.0.0
@@ -631,8 +717,8 @@ export class InitializeResult extends Schema.Opaque<InitializeResult>()(Schema.S
631
717
  })) {}
632
718
 
633
719
  /**
634
- * This request is sent from the client to the server when it first connects,
635
- * asking it to begin initialization.
720
+ * Sent from the client to the server when it first connects, asking it to begin
721
+ * initialization.
636
722
  *
637
723
  * @category initialization
638
724
  * @since 4.0.0
@@ -661,8 +747,7 @@ export class Initialize extends Rpc.make("initialize", {
661
747
  }) {}
662
748
 
663
749
  /**
664
- * This notification is sent from the client to the server after initialization
665
- * has finished.
750
+ * Sent from the client to the server after initialization has finished.
666
751
  *
667
752
  * @category initialization
668
753
  * @since 4.0.0
@@ -676,8 +761,8 @@ export class InitializedNotification extends Rpc.make("notifications/initialized
676
761
  // =============================================================================
677
762
 
678
763
  /**
679
- * Notification sent by either peer to cancel a previously issued request in
680
- * the same direction.
764
+ * Sent from either peer to cancel a previously issued request in the same
765
+ * direction.
681
766
  *
682
767
  * **Details**
683
768
  *
@@ -710,8 +795,7 @@ export class CancelledNotification extends Rpc.make("notifications/cancelled", {
710
795
  // =============================================================================
711
796
 
712
797
  /**
713
- * An out-of-band notification used to inform the receiver of a progress update
714
- * for a long-running request.
798
+ * Sent from either peer to report progress for a long-running request.
715
799
  *
716
800
  * @category progress
717
801
  * @since 4.0.0
@@ -745,7 +829,7 @@ export class ProgressNotification extends Rpc.make("notifications/progress", {
745
829
  // =============================================================================
746
830
 
747
831
  /**
748
- * A known resource that the server is capable of reading.
832
+ * Schema for a known resource that the server is capable of reading.
749
833
  *
750
834
  * @category resources
751
835
  * @since 4.0.0
@@ -797,7 +881,7 @@ export class Resource extends Schema.Class<Resource>(
797
881
  }) {}
798
882
 
799
883
  /**
800
- * A template description for resources available on the server.
884
+ * Schema for a template description of resources available on the server.
801
885
  *
802
886
  * @category resources
803
887
  * @since 4.0.0
@@ -843,7 +927,7 @@ export class ResourceTemplate extends Schema.Class<ResourceTemplate>(
843
927
  }) {}
844
928
 
845
929
  /**
846
- * The contents of a specific resource or sub-resource.
930
+ * Schema for the contents of a specific resource or sub-resource.
847
931
  *
848
932
  * @category resources
849
933
  * @since 4.0.0
@@ -864,7 +948,7 @@ export class ResourceContents extends Schema.Opaque<ResourceContents>()(Schema.S
864
948
  })) {}
865
949
 
866
950
  /**
867
- * The contents of a text resource, which can be represented as a string.
951
+ * Schema for text resource contents represented as a string.
868
952
  *
869
953
  * @category resources
870
954
  * @since 4.0.0
@@ -879,7 +963,7 @@ export class TextResourceContents extends Schema.Opaque<TextResourceContents>()(
879
963
  })) {}
880
964
 
881
965
  /**
882
- * The contents of a binary resource, which can be represented as a Uint8Array.
966
+ * Schema for binary resource contents represented as a `Uint8Array`.
883
967
  *
884
968
  * @category resources
885
969
  * @since 4.0.0
@@ -893,7 +977,7 @@ export class BlobResourceContents extends Schema.Opaque<BlobResourceContents>()(
893
977
  })) {}
894
978
 
895
979
  /**
896
- * The server's response to a resources/list request from the client.
980
+ * Schema for the server's response to a resources/list request from the client.
897
981
  *
898
982
  * @category resources
899
983
  * @since 4.0.0
@@ -918,7 +1002,8 @@ export class ListResources extends Rpc.make("resources/list", {
918
1002
  }) {}
919
1003
 
920
1004
  /**
921
- * The server's response to a resources/templates/list request from the client.
1005
+ * Schema for the server's response to a resources/templates/list request from
1006
+ * the client.
922
1007
  *
923
1008
  * @category resources
924
1009
  * @since 4.0.0
@@ -943,7 +1028,7 @@ export class ListResourceTemplates extends Rpc.make("resources/templates/list",
943
1028
  }) {}
944
1029
 
945
1030
  /**
946
- * The server's response to a resources/read request from the client.
1031
+ * Schema for the server's response to a resources/read request from the client.
947
1032
  *
948
1033
  * @category resources
949
1034
  * @since 4.0.0
@@ -973,9 +1058,15 @@ export class ReadResource extends Rpc.make("resources/read", {
973
1058
  }) {}
974
1059
 
975
1060
  /**
976
- * An optional notification from the server to the client, informing it that the
977
- * list of resources it can read from has changed. This may be issued by servers
978
- * without any previous subscription from the client.
1061
+ * Represents a notification that the server's resource list changed.
1062
+ *
1063
+ * **When to use**
1064
+ *
1065
+ * Use to notify clients that `resources/list` should be requested again.
1066
+ *
1067
+ * **Details**
1068
+ *
1069
+ * Servers may send this notification without a previous client subscription.
979
1070
  *
980
1071
  * @category resources
981
1072
  * @since 4.0.0
@@ -1024,7 +1115,7 @@ export class Unsubscribe extends Rpc.make("resources/unsubscribe", {
1024
1115
  }) {}
1025
1116
 
1026
1117
  /**
1027
- * Notification sent by the server when a subscribed resource URI has changed.
1118
+ * Sent from the server when a subscribed resource URI has changed.
1028
1119
  *
1029
1120
  * **Details**
1030
1121
  *
@@ -1051,7 +1142,7 @@ export class ResourceUpdatedNotification extends Rpc.make("notifications/resourc
1051
1142
  /**
1052
1143
  * Describes an argument that a prompt can accept.
1053
1144
  *
1054
- * @category prompts
1145
+ * @category schemas
1055
1146
  * @since 4.0.0
1056
1147
  */
1057
1148
  export class PromptArgument extends Schema.Opaque<PromptArgument>()(Schema.Struct({
@@ -1071,9 +1162,9 @@ export class PromptArgument extends Schema.Opaque<PromptArgument>()(Schema.Struc
1071
1162
  })) {}
1072
1163
 
1073
1164
  /**
1074
- * A prompt or prompt template that the server offers.
1165
+ * Represents a prompt or prompt template that the server offers.
1075
1166
  *
1076
- * @category prompts
1167
+ * @category schemas
1077
1168
  * @since 4.0.0
1078
1169
  */
1079
1170
  export class Prompt extends Schema.Class<Prompt>(
@@ -1095,9 +1186,9 @@ export class Prompt extends Schema.Class<Prompt>(
1095
1186
  }) {}
1096
1187
 
1097
1188
  /**
1098
- * Text provided to or from an LLM.
1189
+ * Represents text content provided to or from an LLM.
1099
1190
  *
1100
- * @category prompts
1191
+ * @category schemas
1101
1192
  * @since 4.0.0
1102
1193
  */
1103
1194
  export class TextContent extends Schema.Opaque<TextContent>()(Schema.Struct({
@@ -1113,9 +1204,9 @@ export class TextContent extends Schema.Opaque<TextContent>()(Schema.Struct({
1113
1204
  })) {}
1114
1205
 
1115
1206
  /**
1116
- * An image provided to or from an LLM.
1207
+ * Represents image content provided to or from an LLM.
1117
1208
  *
1118
- * @category prompts
1209
+ * @category schemas
1119
1210
  * @since 4.0.0
1120
1211
  */
1121
1212
  export class ImageContent extends Schema.Opaque<ImageContent>()(Schema.Struct({
@@ -1136,9 +1227,9 @@ export class ImageContent extends Schema.Opaque<ImageContent>()(Schema.Struct({
1136
1227
  })) {}
1137
1228
 
1138
1229
  /**
1139
- * Audio provided to or from an LLM.
1230
+ * Represents audio content provided to or from an LLM.
1140
1231
  *
1141
- * @category prompts
1232
+ * @category schemas
1142
1233
  * @since 4.0.0
1143
1234
  */
1144
1235
  export class AudioContent extends Schema.Opaque<AudioContent>()(Schema.Struct({
@@ -1159,14 +1250,14 @@ export class AudioContent extends Schema.Opaque<AudioContent>()(Schema.Struct({
1159
1250
  })) {}
1160
1251
 
1161
1252
  /**
1162
- * The contents of a resource, embedded into a prompt or tool call result.
1253
+ * Represents resource contents embedded into a prompt or tool call result.
1163
1254
  *
1164
1255
  * **Details**
1165
1256
  *
1166
1257
  * It is up to the client how best to render embedded resources for the benefit
1167
1258
  * of the LLM and/or the user.
1168
1259
  *
1169
- * @category prompts
1260
+ * @category schemas
1170
1261
  * @since 4.0.0
1171
1262
  */
1172
1263
  export class EmbeddedResource extends Schema.Opaque<EmbeddedResource>()(Schema.Struct({
@@ -1179,15 +1270,14 @@ export class EmbeddedResource extends Schema.Opaque<EmbeddedResource>()(Schema.S
1179
1270
  })) {}
1180
1271
 
1181
1272
  /**
1182
- * A resource that the server is capable of reading, included in a prompt or
1183
- * tool call result.
1273
+ * Represents a readable resource included in a prompt or tool call result.
1184
1274
  *
1185
1275
  * **Gotchas**
1186
1276
  *
1187
1277
  * Resource links returned by tools are not guaranteed to appear in the results
1188
1278
  * of `resources/list` requests.
1189
1279
  *
1190
- * @category prompts
1280
+ * @category schemas
1191
1281
  * @since 4.0.0
1192
1282
  */
1193
1283
  export class ResourceLink extends Schema.Opaque<ResourceLink>()(Schema.Struct({
@@ -1196,10 +1286,10 @@ export class ResourceLink extends Schema.Opaque<ResourceLink>()(Schema.Struct({
1196
1286
  })) {}
1197
1287
 
1198
1288
  /**
1199
- * Union of MCP content blocks that can appear in prompt messages or tool
1200
- * results, including text, media, embedded resources, and resource links.
1289
+ * Schema for MCP content blocks that can appear in prompt messages or tool
1290
+ * results.
1201
1291
  *
1202
- * @category prompts
1292
+ * @category schemas
1203
1293
  * @since 4.0.0
1204
1294
  */
1205
1295
  export const ContentBlock = Schema.Union([
@@ -1218,7 +1308,7 @@ export const ContentBlock = Schema.Union([
1218
1308
  * This is similar to `SamplingMessage`, but also supports the embedding of
1219
1309
  * resources from the MCP server.
1220
1310
  *
1221
- * @category prompts
1311
+ * @category schemas
1222
1312
  * @since 4.0.0
1223
1313
  */
1224
1314
  export class PromptMessage extends Schema.Opaque<PromptMessage>()(Schema.Struct({
@@ -1227,9 +1317,9 @@ export class PromptMessage extends Schema.Opaque<PromptMessage>()(Schema.Struct(
1227
1317
  })) {}
1228
1318
 
1229
1319
  /**
1230
- * The server's response to a prompts/list request from the client.
1320
+ * Represents the server response to a prompts/list request from the client.
1231
1321
  *
1232
- * @category prompts
1322
+ * @category schemas
1233
1323
  * @since 4.0.0
1234
1324
  */
1235
1325
  export class ListPromptsResult extends Schema.Class<ListPromptsResult>(
@@ -1243,7 +1333,7 @@ export class ListPromptsResult extends Schema.Class<ListPromptsResult>(
1243
1333
  * Sent from the client to request a list of prompts and prompt templates the
1244
1334
  * server has.
1245
1335
  *
1246
- * @category prompts
1336
+ * @category protocols
1247
1337
  * @since 4.0.0
1248
1338
  */
1249
1339
  export class ListPrompts extends Rpc.make("prompts/list", {
@@ -1253,9 +1343,9 @@ export class ListPrompts extends Rpc.make("prompts/list", {
1253
1343
  }) {}
1254
1344
 
1255
1345
  /**
1256
- * The server's response to a prompts/get request from the client.
1346
+ * Represents the server response to a prompts/get request from the client.
1257
1347
  *
1258
- * @category prompts
1348
+ * @category schemas
1259
1349
  * @since 4.0.0
1260
1350
  */
1261
1351
  export class GetPromptResult extends Schema.Class<GetPromptResult>(
@@ -1270,9 +1360,9 @@ export class GetPromptResult extends Schema.Class<GetPromptResult>(
1270
1360
  }) {}
1271
1361
 
1272
1362
  /**
1273
- * Used by the client to get a prompt provided by the server.
1363
+ * Sent from the client to get a prompt provided by the server.
1274
1364
  *
1275
- * @category prompts
1365
+ * @category protocols
1276
1366
  * @since 4.0.0
1277
1367
  */
1278
1368
  export class GetPrompt extends Rpc.make("prompts/get", {
@@ -1293,11 +1383,17 @@ export class GetPrompt extends Rpc.make("prompts/get", {
1293
1383
  }) {}
1294
1384
 
1295
1385
  /**
1296
- * An optional notification from the server to the client, informing it that
1297
- * the list of prompts it offers has changed. This may be issued by servers
1298
- * without any previous subscription from the client.
1386
+ * Represents a notification that the server's prompt list changed.
1387
+ *
1388
+ * **When to use**
1389
+ *
1390
+ * Use to notify clients that `prompts/list` should be requested again.
1391
+ *
1392
+ * **Details**
1393
+ *
1394
+ * Servers may send this notification without a previous client subscription.
1299
1395
  *
1300
- * @category prompts
1396
+ * @category protocols
1301
1397
  * @since 4.0.0
1302
1398
  */
1303
1399
  export class PromptListChangedNotification extends Rpc.make("notifications/prompts/list_changed", {
@@ -1309,7 +1405,7 @@ export class PromptListChangedNotification extends Rpc.make("notifications/promp
1309
1405
  // =============================================================================
1310
1406
 
1311
1407
  /**
1312
- * Additional properties describing a Tool to clients.
1408
+ * Schema for additional properties describing a tool to clients.
1313
1409
  *
1314
1410
  * **Details**
1315
1411
  *
@@ -1366,7 +1462,7 @@ export class ToolAnnotations extends Schema.Opaque<ToolAnnotations>()(Schema.Str
1366
1462
  })) {}
1367
1463
 
1368
1464
  /**
1369
- * Definition for a tool the client can call.
1465
+ * Schema for the definition of a tool the client can call.
1370
1466
  *
1371
1467
  * @category tools
1372
1468
  * @since 4.0.0
@@ -1403,7 +1499,7 @@ export class Tool extends Schema.Class<Tool>(
1403
1499
  }) {}
1404
1500
 
1405
1501
  /**
1406
- * The server's response to a tools/list request from the client.
1502
+ * Schema for the server's response to a tools/list request from the client.
1407
1503
  *
1408
1504
  * @category tools
1409
1505
  * @since 4.0.0
@@ -1428,7 +1524,7 @@ export class ListTools extends Rpc.make("tools/list", {
1428
1524
  }) {}
1429
1525
 
1430
1526
  /**
1431
- * The server's response to a tool call.
1527
+ * Schema for the server's response to a tool call.
1432
1528
  *
1433
1529
  * **Details**
1434
1530
  *
@@ -1455,7 +1551,7 @@ export class CallToolResult extends Schema.Class<CallToolResult>("@effect/ai/Mcp
1455
1551
  }) {}
1456
1552
 
1457
1553
  /**
1458
- * Used by the client to invoke a tool provided by the server.
1554
+ * Represents a client request to invoke a tool provided by the server.
1459
1555
  *
1460
1556
  * **When to use**
1461
1557
  *
@@ -1482,9 +1578,15 @@ export class CallTool extends Rpc.make("tools/call", {
1482
1578
  }) {}
1483
1579
 
1484
1580
  /**
1485
- * An optional notification from the server to the client, informing it that
1486
- * the list of tools it offers has changed. This may be issued by servers
1487
- * without any previous subscription from the client.
1581
+ * Represents a notification that the server's tool list changed.
1582
+ *
1583
+ * **When to use**
1584
+ *
1585
+ * Use to notify clients that `tools/list` should be requested again.
1586
+ *
1587
+ * **Details**
1588
+ *
1589
+ * Servers may send this notification without a previous client subscription.
1488
1590
  *
1489
1591
  * @category tools
1490
1592
  * @since 4.0.0
@@ -1498,8 +1600,8 @@ export class ToolListChangedNotification extends Rpc.make("notifications/tools/l
1498
1600
  // =============================================================================
1499
1601
 
1500
1602
  /**
1501
- * The severity of a log message, mapped to syslog message severities as
1502
- * specified in RFC 5424 section 6.2.1:
1603
+ * Schema for log message severity levels, mapped to syslog message severities
1604
+ * as specified in RFC 5424 section 6.2.1:
1503
1605
  * https://datatracker.ietf.org/doc/html/rfc5424#section-6.2.1.
1504
1606
  *
1505
1607
  * @category logging
@@ -1536,7 +1638,7 @@ export const LoggingLevel: Schema.Literals<[
1536
1638
  export type LoggingLevel = typeof LoggingLevel.Type
1537
1639
 
1538
1640
  /**
1539
- * A request from the client to the server, to enable or adjust logging.
1641
+ * Sent from the client to the server to enable or adjust logging.
1540
1642
  *
1541
1643
  * @category logging
1542
1644
  * @since 4.0.0
@@ -1555,7 +1657,7 @@ export class SetLevel extends Rpc.make("logging/setLevel", {
1555
1657
  }) {}
1556
1658
 
1557
1659
  /**
1558
- * Server notification carrying a log message for the client.
1660
+ * Sent from the server to the client carrying a log message.
1559
1661
  *
1560
1662
  * **Details**
1561
1663
  *
@@ -1600,7 +1702,7 @@ export class SamplingMessage extends Schema.Opaque<SamplingMessage>()(Schema.Str
1600
1702
  })) {}
1601
1703
 
1602
1704
  /**
1603
- * Hints to use for model selection.
1705
+ * Schema for model selection hints.
1604
1706
  *
1605
1707
  * **Details**
1606
1708
  *
@@ -1627,8 +1729,8 @@ export class ModelHint extends Schema.Opaque<ModelHint>()(Schema.Struct({
1627
1729
  })) {}
1628
1730
 
1629
1731
  /**
1630
- * The server's preferences for model selection, requested of the client during
1631
- * sampling.
1732
+ * Schema for the server's model selection preferences requested of the client
1733
+ * during sampling.
1632
1734
  *
1633
1735
  * **Details**
1634
1736
  *
@@ -1681,10 +1783,16 @@ export class ModelPreferences extends Schema.Class<ModelPreferences>(
1681
1783
  }) {}
1682
1784
 
1683
1785
  /**
1684
- * The client's response to a sampling/create_message request from the server.
1685
- * The client should inform the user before returning the sampled message, to
1686
- * allow them to inspect the response (human in the loop) and decide whether to
1687
- * allow the server to see it.
1786
+ * Represents a client response to an MCP sampling request.
1787
+ *
1788
+ * **When to use**
1789
+ *
1790
+ * Use to return the message produced by client-side model sampling.
1791
+ *
1792
+ * **Details**
1793
+ *
1794
+ * The client should let the user inspect the sampled message before returning
1795
+ * it to the server.
1688
1796
  *
1689
1797
  * @category sampling
1690
1798
  * @since 4.0.0
@@ -1703,10 +1811,17 @@ export class CreateMessageResult extends Schema.Class<CreateMessageResult>(
1703
1811
  }) {}
1704
1812
 
1705
1813
  /**
1706
- * A request from the server to sample an LLM via the client. The client has
1707
- * full discretion over which model to select. The client should also inform the
1708
- * user before beginning sampling, to allow them to inspect the request (human
1709
- * in the loop) and decide whether to approve it.
1814
+ * Represents a server request for the client to sample an LLM.
1815
+ *
1816
+ * **When to use**
1817
+ *
1818
+ * Use when an MCP server needs the client to perform model sampling on its
1819
+ * behalf.
1820
+ *
1821
+ * **Details**
1822
+ *
1823
+ * The client chooses the model and should ask the user to approve the sampling
1824
+ * request before it begins.
1710
1825
  *
1711
1826
  * @category sampling
1712
1827
  * @since 4.0.0
@@ -1751,7 +1866,7 @@ export class CreateMessage extends Rpc.make("sampling/createMessage", {
1751
1866
  // =============================================================================
1752
1867
 
1753
1868
  /**
1754
- * A reference to a resource or resource template definition.
1869
+ * Schema for a reference to a resource or resource template definition.
1755
1870
  *
1756
1871
  * @category autocomplete
1757
1872
  * @since 4.0.0
@@ -1765,7 +1880,7 @@ export class ResourceReference extends Schema.Opaque<ResourceReference>()(Schema
1765
1880
  })) {}
1766
1881
 
1767
1882
  /**
1768
- * Identifies a prompt.
1883
+ * Schema for a prompt reference used in autocomplete requests.
1769
1884
  *
1770
1885
  * @category autocomplete
1771
1886
  * @since 4.0.0
@@ -1780,7 +1895,7 @@ export class PromptReference extends Schema.Opaque<PromptReference>()(Schema.Str
1780
1895
  })) {}
1781
1896
 
1782
1897
  /**
1783
- * The server's response to a completion/complete request
1898
+ * Schema for the server's response to a completion/complete request.
1784
1899
  *
1785
1900
  * @category autocomplete
1786
1901
  * @since 4.0.0
@@ -1818,7 +1933,7 @@ export class CompleteResult extends Schema.Opaque<CompleteResult>()(Schema.Struc
1818
1933
  }
1819
1934
 
1820
1935
  /**
1821
- * A request from the client to the server, to ask for completion options.
1936
+ * Sent from the client to the server to ask for completion options.
1822
1937
  *
1823
1938
  * @category autocomplete
1824
1939
  * @since 4.0.0
@@ -1887,9 +2002,11 @@ export class Root extends Schema.Class<Root>(
1887
2002
  }) {}
1888
2003
 
1889
2004
  /**
1890
- * The client's response to a roots/list request from the server. This result
1891
- * contains an array of Root objects, each representing a root directory or file
1892
- * that the server can operate on.
2005
+ * Represents a client response containing the roots available to the server.
2006
+ *
2007
+ * **When to use**
2008
+ *
2009
+ * Use to return the directories or files that an MCP server may operate on.
1893
2010
  *
1894
2011
  * @category roots
1895
2012
  * @since 4.0.0
@@ -1922,10 +2039,15 @@ export class ListRoots extends Rpc.make("roots/list", {
1922
2039
  }) {}
1923
2040
 
1924
2041
  /**
1925
- * A notification from the client to the server, informing it that the list of
1926
- * roots has changed. This notification should be sent whenever the client adds,
1927
- * removes, or modifies any root. The server should then request an updated list
1928
- * of roots using the ListRootsRequest.
2042
+ * Represents a notification that the client's root list changed.
2043
+ *
2044
+ * **When to use**
2045
+ *
2046
+ * Use to tell the server that it should request an updated roots list.
2047
+ *
2048
+ * **Details**
2049
+ *
2050
+ * Send this when the client adds, removes, or modifies a root.
1929
2051
  *
1930
2052
  * @category roots
1931
2053
  * @since 4.0.0
@@ -1939,7 +2061,7 @@ export class RootsListChangedNotification extends Rpc.make("notifications/roots/
1939
2061
  // =============================================================================
1940
2062
 
1941
2063
  /**
1942
- * The client's response to an elicitation request
2064
+ * Schema for an accepted client response to an elicitation request.
1943
2065
  *
1944
2066
  * @category elicitation
1945
2067
  * @since 4.0.0
@@ -1963,7 +2085,7 @@ export class ElicitAcceptResult extends Schema.Class<ElicitAcceptResult>(
1963
2085
  }) {}
1964
2086
 
1965
2087
  /**
1966
- * The client's response to an elicitation request
2088
+ * Schema for a declined or canceled client response to an elicitation request.
1967
2089
  *
1968
2090
  * @category elicitation
1969
2091
  * @since 4.0.0
@@ -1982,7 +2104,7 @@ export class ElicitDeclineResult extends Schema.Class<ElicitDeclineResult>(
1982
2104
  }) {}
1983
2105
 
1984
2106
  /**
1985
- * The client's response to an elicitation request
2107
+ * Schema for every client response to an elicitation request.
1986
2108
  *
1987
2109
  * @category elicitation
1988
2110
  * @since 4.0.0
@@ -1993,8 +2115,8 @@ export const ElicitResult = Schema.Union([
1993
2115
  ])
1994
2116
 
1995
2117
  /**
1996
- * Request sent by the server asking the client to collect structured input
1997
- * from the user.
2118
+ * Sent from the server asking the client to collect structured input from the
2119
+ * user.
1998
2120
  *
1999
2121
  * **Details**
2000
2122
  *
@@ -2085,7 +2207,7 @@ export class McpServerClientMiddleware extends RpcMiddleware.Service<McpServerCl
2085
2207
  * Encoded JSON-RPC request message for an RPC in `Group`, including the request
2086
2208
  * id, method, and encoded payload.
2087
2209
  *
2088
- * @category protocol
2210
+ * @category protocols
2089
2211
  * @since 4.0.0
2090
2212
  */
2091
2213
  export type RequestEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
@@ -2109,7 +2231,7 @@ export type RequestEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
2109
2231
  * Encoded notification message for an RPC in `Group`, including the method and
2110
2232
  * encoded payload without a request id.
2111
2233
  *
2112
- * @category protocol
2234
+ * @category protocols
2113
2235
  * @since 4.0.0
2114
2236
  */
2115
2237
  export type NotificationEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
@@ -2132,7 +2254,7 @@ export type NotificationEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
2132
2254
  * Encoded success response for an RPC in `Group`, containing the original
2133
2255
  * request id and encoded result.
2134
2256
  *
2135
- * @category protocol
2257
+ * @category protocols
2136
2258
  * @since 4.0.0
2137
2259
  */
2138
2260
  export type SuccessEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
@@ -2155,7 +2277,7 @@ export type SuccessEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
2155
2277
  * Encoded failure response for an RPC in `Group`, containing the original
2156
2278
  * request id and encoded error.
2157
2279
  *
2158
- * @category protocol
2280
+ * @category protocols
2159
2281
  * @since 4.0.0
2160
2282
  */
2161
2283
  export type FailureEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
@@ -2183,7 +2305,7 @@ export type FailureEncoded<Group extends RpcGroup.Any> = RpcGroup.Rpcs<
2183
2305
  * completion, and ping requests, and installs `McpServerClientMiddleware` for
2184
2306
  * handlers.
2185
2307
  *
2186
- * @category protocol
2308
+ * @category protocols
2187
2309
  * @since 4.0.0
2188
2310
  */
2189
2311
  export class ClientRequestRpcs extends RpcGroup.make(
@@ -2205,7 +2327,7 @@ export class ClientRequestRpcs extends RpcGroup.make(
2205
2327
  /**
2206
2328
  * Encoded union of all client-to-server MCP request messages.
2207
2329
  *
2208
- * @category protocol
2330
+ * @category protocols
2209
2331
  * @since 4.0.0
2210
2332
  */
2211
2333
  export type ClientRequestEncoded = RequestEncoded<typeof ClientRequestRpcs>
@@ -2214,7 +2336,7 @@ export type ClientRequestEncoded = RequestEncoded<typeof ClientRequestRpcs>
2214
2336
  * RPC group for notifications that MCP clients send to the server, such as
2215
2337
  * cancellation, progress, initialization completion, and roots list changes.
2216
2338
  *
2217
- * @category protocol
2339
+ * @category protocols
2218
2340
  * @since 4.0.0
2219
2341
  */
2220
2342
  export class ClientNotificationRpcs extends RpcGroup.make(
@@ -2227,7 +2349,7 @@ export class ClientNotificationRpcs extends RpcGroup.make(
2227
2349
  /**
2228
2350
  * Encoded union of all client-to-server MCP notification messages.
2229
2351
  *
2230
- * @category protocol
2352
+ * @category protocols
2231
2353
  * @since 4.0.0
2232
2354
  */
2233
2355
  export type ClientNotificationEncoded = NotificationEncoded<typeof ClientNotificationRpcs>
@@ -2235,7 +2357,7 @@ export type ClientNotificationEncoded = NotificationEncoded<typeof ClientNotific
2235
2357
  /**
2236
2358
  * RPC group combining all client-to-server MCP requests and notifications.
2237
2359
  *
2238
- * @category protocol
2360
+ * @category protocols
2239
2361
  * @since 4.0.0
2240
2362
  */
2241
2363
  export class ClientRpcs extends ClientRequestRpcs.merge(ClientNotificationRpcs) {}
@@ -2243,7 +2365,7 @@ export class ClientRpcs extends ClientRequestRpcs.merge(ClientNotificationRpcs)
2243
2365
  /**
2244
2366
  * Encoded success response sent by a client for a server-initiated request.
2245
2367
  *
2246
- * @category protocol
2368
+ * @category protocols
2247
2369
  * @since 4.0.0
2248
2370
  */
2249
2371
  export type ClientSuccessEncoded = SuccessEncoded<typeof ServerRequestRpcs>
@@ -2251,7 +2373,7 @@ export type ClientSuccessEncoded = SuccessEncoded<typeof ServerRequestRpcs>
2251
2373
  /**
2252
2374
  * Encoded failure response sent by a client for a server-initiated request.
2253
2375
  *
2254
- * @category protocol
2376
+ * @category protocols
2255
2377
  * @since 4.0.0
2256
2378
  */
2257
2379
  export type ClientFailureEncoded = FailureEncoded<typeof ServerRequestRpcs>
@@ -2260,7 +2382,7 @@ export type ClientFailureEncoded = FailureEncoded<typeof ServerRequestRpcs>
2260
2382
  * RPC group for requests that an MCP server can send to a client, including
2261
2383
  * ping, sampling, roots listing, and elicitation.
2262
2384
  *
2263
- * @category protocol
2385
+ * @category protocols
2264
2386
  * @since 4.0.0
2265
2387
  */
2266
2388
  export class ServerRequestRpcs extends RpcGroup.make(
@@ -2273,7 +2395,7 @@ export class ServerRequestRpcs extends RpcGroup.make(
2273
2395
  /**
2274
2396
  * Encoded union of all server-to-client MCP request messages.
2275
2397
  *
2276
- * @category protocol
2398
+ * @category protocols
2277
2399
  * @since 4.0.0
2278
2400
  */
2279
2401
  export type ServerRequestEncoded = RequestEncoded<typeof ServerRequestRpcs>
@@ -2283,7 +2405,7 @@ export type ServerRequestEncoded = RequestEncoded<typeof ServerRequestRpcs>
2283
2405
  * including cancellation, progress, logging, and list or resource update
2284
2406
  * notifications.
2285
2407
  *
2286
- * @category protocol
2408
+ * @category protocols
2287
2409
  * @since 4.0.0
2288
2410
  */
2289
2411
  export class ServerNotificationRpcs extends RpcGroup.make(
@@ -2299,7 +2421,7 @@ export class ServerNotificationRpcs extends RpcGroup.make(
2299
2421
  /**
2300
2422
  * Encoded union of all server-to-client MCP notification messages.
2301
2423
  *
2302
- * @category protocol
2424
+ * @category protocols
2303
2425
  * @since 4.0.0
2304
2426
  */
2305
2427
  export type ServerNotificationEncoded = NotificationEncoded<typeof ServerNotificationRpcs>
@@ -2307,7 +2429,7 @@ export type ServerNotificationEncoded = NotificationEncoded<typeof ServerNotific
2307
2429
  /**
2308
2430
  * Encoded success response sent by the server for a client-initiated request.
2309
2431
  *
2310
- * @category protocol
2432
+ * @category protocols
2311
2433
  * @since 4.0.0
2312
2434
  */
2313
2435
  export type ServerSuccessEncoded = SuccessEncoded<typeof ClientRequestRpcs>
@@ -2315,7 +2437,7 @@ export type ServerSuccessEncoded = SuccessEncoded<typeof ClientRequestRpcs>
2315
2437
  /**
2316
2438
  * Encoded failure response sent by the server for a client-initiated request.
2317
2439
  *
2318
- * @category protocol
2440
+ * @category protocols
2319
2441
  * @since 4.0.0
2320
2442
  */
2321
2443
  export type ServerFailureEncoded = FailureEncoded<typeof ClientRequestRpcs>
@@ -2323,7 +2445,7 @@ export type ServerFailureEncoded = FailureEncoded<typeof ClientRequestRpcs>
2323
2445
  /**
2324
2446
  * Encoded server response to a client request, either success or failure.
2325
2447
  *
2326
- * @category protocol
2448
+ * @category protocols
2327
2449
  * @since 4.0.0
2328
2450
  */
2329
2451
  export type ServerResultEncoded = ServerSuccessEncoded | ServerFailureEncoded
@@ -2332,7 +2454,7 @@ export type ServerResultEncoded = ServerSuccessEncoded | ServerFailureEncoded
2332
2454
  * Encoded MCP messages accepted from a client by the server protocol: client
2333
2455
  * requests and client notifications.
2334
2456
  *
2335
- * @category protocol
2457
+ * @category protocols
2336
2458
  * @since 4.0.0
2337
2459
  */
2338
2460
  export type FromClientEncoded = ClientRequestEncoded | ClientNotificationEncoded
@@ -2341,7 +2463,7 @@ export type FromClientEncoded = ClientRequestEncoded | ClientNotificationEncoded
2341
2463
  * Encoded MCP messages emitted by the server protocol to a client: server
2342
2464
  * responses and server notifications.
2343
2465
  *
2344
- * @category protocol
2466
+ * @category protocols
2345
2467
  * @since 4.0.0
2346
2468
  */
2347
2469
  export type FromServerEncoded = ServerResultEncoded | ServerNotificationEncoded
@@ -2396,7 +2518,7 @@ export interface Param<Name extends string, S extends Schema.Top> extends
2396
2518
  }
2397
2519
 
2398
2520
  /**
2399
- * Helper to create a param for a resource URI template.
2521
+ * Creates a parameter for a resource URI template.
2400
2522
  *
2401
2523
  * @category parameters
2402
2524
  * @since 4.0.0