@isdk/ai-tool 0.7.1 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (359) hide show
  1. package/dist/chunk-4FKBOPZI.mjs +1 -0
  2. package/dist/{chunk-VIG2GB47.mjs → chunk-TGTHY57V.mjs} +1 -1
  3. package/dist/funcs.d.mts +1 -2
  4. package/dist/funcs.d.ts +1 -2
  5. package/dist/funcs.js +1 -1
  6. package/dist/funcs.mjs +1 -1
  7. package/dist/{index-DEUnmyUq.d.mts → index-BLW3R7VS.d.mts} +103 -69
  8. package/dist/{index-DEUnmyUq.d.ts → index-BLW3R7VS.d.ts} +103 -69
  9. package/dist/index.d.mts +100 -37
  10. package/dist/index.d.ts +100 -37
  11. package/dist/index.js +1 -1
  12. package/dist/index.mjs +1 -1
  13. package/dist/test/util.js +1 -1
  14. package/dist/test/util.mjs +1 -1
  15. package/docs/api/{namespaces → @isdk/namespaces}/EventStates/README.md +2 -2
  16. package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/ABORT.md +2 -2
  17. package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/CONTINUE.md +2 -2
  18. package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/DONE.md +2 -2
  19. package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/STOPPED.md +2 -2
  20. package/docs/api/@isdk/namespaces/uuidv5/README.md +12 -0
  21. package/docs/api/{namespaces → @isdk/namespaces}/uuidv5/variables/DNS.md +2 -2
  22. package/docs/api/{namespaces → @isdk/namespaces}/uuidv5/variables/URL.md +2 -2
  23. package/docs/api/_media/pubsub.md +427 -105
  24. package/docs/api/_media/server_client_tools.md +5 -3
  25. package/docs/api/_media/toolFunc.md +3 -1
  26. package/docs/api/classes/AbortError.md +8 -8
  27. package/docs/api/classes/AlreadyExistsError.md +8 -8
  28. package/docs/api/classes/BaseError.md +14 -14
  29. package/docs/api/classes/BinarySemaphore.md +39 -39
  30. package/docs/api/classes/CancelableAbility.md +43 -39
  31. package/docs/api/classes/ClientToolTransport.md +22 -22
  32. package/docs/api/classes/ClientTools.md +178 -154
  33. package/docs/api/classes/CommonError.md +12 -12
  34. package/docs/api/classes/ConfigFile.md +6 -6
  35. package/docs/api/classes/EnvPromptTemplate.md +14 -14
  36. package/docs/api/classes/EventClient.md +240 -198
  37. package/docs/api/classes/EventEmitter.md +14 -14
  38. package/docs/api/classes/EventServer.md +208 -233
  39. package/docs/api/classes/EventToolFunc.md +144 -116
  40. package/docs/api/classes/FStringPromptTemplate.md +14 -14
  41. package/docs/api/classes/FewShotPromptTemplate.md +30 -26
  42. package/docs/api/classes/GolangPromptTemplate.md +13 -13
  43. package/docs/api/classes/HttpClientToolTransport.md +23 -23
  44. package/docs/api/classes/HttpServerToolTransport.md +32 -27
  45. package/docs/api/classes/IntSet.md +21 -21
  46. package/docs/api/classes/LRUCache.md +18 -18
  47. package/docs/api/classes/NotFoundError.md +8 -8
  48. package/docs/api/classes/NotImplementationError.md +8 -8
  49. package/docs/api/classes/PromptExampleSelector.md +17 -15
  50. package/docs/api/classes/PromptTemplate.md +15 -15
  51. package/docs/api/classes/ReadableStreamError.md +12 -12
  52. package/docs/api/classes/ResClientTools.md +180 -152
  53. package/docs/api/classes/ResServerTools.md +163 -139
  54. package/docs/api/classes/RpcMethodsClientTool.md +174 -146
  55. package/docs/api/classes/RpcMethodsServerTool.md +157 -133
  56. package/docs/api/classes/SSEChannel.md +142 -52
  57. package/docs/api/classes/Semaphore.md +40 -40
  58. package/docs/api/classes/ServerToolTransport.md +32 -27
  59. package/docs/api/classes/ServerTools.md +163 -139
  60. package/docs/api/classes/SignalGate.md +19 -17
  61. package/docs/api/classes/SseClientPubSubTransport.md +38 -10
  62. package/docs/api/classes/SseServerPubSubTransport.md +115 -42
  63. package/docs/api/classes/TaskAbortController.md +13 -13
  64. package/docs/api/classes/ToolFunc.md +157 -129
  65. package/docs/api/classes/ToolTransport.md +13 -13
  66. package/docs/api/classes/YamlTypeBaseObject.md +5 -5
  67. package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
  68. package/docs/api/enumerations/AsyncFeatures.md +4 -4
  69. package/docs/api/enumerations/HashAlgorithm.md +12 -12
  70. package/docs/api/functions/AIArgProcessor.md +2 -2
  71. package/docs/api/functions/AIStream.md +8 -4
  72. package/docs/api/functions/ChoiceArgProcessor.md +2 -2
  73. package/docs/api/functions/DefaultDateFormat.md +2 -2
  74. package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
  75. package/docs/api/functions/RateLimit.md +2 -2
  76. package/docs/api/functions/TemplateArgProcessor.md +2 -2
  77. package/docs/api/functions/addDate.md +7 -3
  78. package/docs/api/functions/assignDirs.md +1 -1
  79. package/docs/api/functions/beforeShutdown.md +1 -1
  80. package/docs/api/functions/calcPerplexity.md +2 -2
  81. package/docs/api/functions/calcPerplexitySimple.md +1 -1
  82. package/docs/api/functions/canonicalize.md +1 -1
  83. package/docs/api/functions/completeSentences.md +1 -1
  84. package/docs/api/functions/concatText.md +1 -1
  85. package/docs/api/functions/countLLMTokens.md +1 -1
  86. package/docs/api/functions/countRegexMatches.md +1 -1
  87. package/docs/api/functions/createAbilityInjector.md +16 -8
  88. package/docs/api/functions/createCallbacksTransformer.md +7 -3
  89. package/docs/api/functions/createEmptyReadableStream.md +1 -1
  90. package/docs/api/functions/createEndWithRepetitionDetector.md +2 -2
  91. package/docs/api/functions/createError.md +1 -1
  92. package/docs/api/functions/createEventStreamTransformer.md +8 -4
  93. package/docs/api/functions/createHfValueFunc.md +1 -1
  94. package/docs/api/functions/createLRUCache.md +2 -2
  95. package/docs/api/functions/createYamlObjectTag.md +1 -1
  96. package/docs/api/functions/dateToText.md +1 -1
  97. package/docs/api/functions/decodeCharset.md +2 -2
  98. package/docs/api/functions/defaultsWithConcat.md +1 -1
  99. package/docs/api/functions/detectCharset.md +2 -2
  100. package/docs/api/functions/encodeLLMTokens.md +1 -1
  101. package/docs/api/functions/ensureQuoted.md +1 -1
  102. package/docs/api/functions/eventable.md +6 -8
  103. package/docs/api/functions/expandConfig.md +2 -2
  104. package/docs/api/functions/expandObjEnv.md +1 -1
  105. package/docs/api/functions/expandPath.md +2 -2
  106. package/docs/api/functions/expandPathInObject.md +2 -2
  107. package/docs/api/functions/expandPaths.md +2 -2
  108. package/docs/api/functions/fileIsExists.md +1 -1
  109. package/docs/api/functions/filterValidFnScope.md +2 -2
  110. package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
  111. package/docs/api/functions/findPort.md +1 -1
  112. package/docs/api/functions/formatISO.md +1 -1
  113. package/docs/api/functions/formatTextWithSpace.md +2 -2
  114. package/docs/api/functions/funcGetMeta.md +1 -1
  115. package/docs/api/functions/funcWithMeta.md +2 -2
  116. package/docs/api/functions/genUrlParamsStr.md +8 -2
  117. package/docs/api/functions/getAllEnumKeys.md +4 -2
  118. package/docs/api/functions/getConfigFileNames.md +2 -2
  119. package/docs/api/functions/getConfigs.md +2 -2
  120. package/docs/api/functions/getFileMetaInfo.md +1 -1
  121. package/docs/api/functions/getHashAlgoBySize.md +1 -1
  122. package/docs/api/functions/getKeysPath.md +4 -2
  123. package/docs/api/functions/getLLMTokenizer.md +1 -1
  124. package/docs/api/functions/getMultiLevelExtname.md +1 -1
  125. package/docs/api/functions/getPackageDir.md +1 -1
  126. package/docs/api/functions/getRealFilepath.md +1 -1
  127. package/docs/api/functions/getResponseErrorReadableStream.md +2 -2
  128. package/docs/api/functions/getXDGConfigs.md +1 -1
  129. package/docs/api/functions/hasDirectoryIn.md +2 -2
  130. package/docs/api/functions/hash.md +1 -1
  131. package/docs/api/functions/hashFile.md +2 -2
  132. package/docs/api/functions/hashObject.md +2 -2
  133. package/docs/api/functions/hashStream.md +1 -1
  134. package/docs/api/functions/initShutdown.md +1 -1
  135. package/docs/api/functions/isLangUsingSpaces.md +1 -1
  136. package/docs/api/functions/isListItemString.md +1 -1
  137. package/docs/api/functions/isModelNameMatched.md +2 -2
  138. package/docs/api/functions/isPunctuationChar.md +1 -1
  139. package/docs/api/functions/isQuoted.md +1 -1
  140. package/docs/api/functions/isRegExp.md +1 -1
  141. package/docs/api/functions/isSameString.md +1 -1
  142. package/docs/api/functions/isSectionString.md +2 -2
  143. package/docs/api/functions/isSentenceEnding.md +1 -1
  144. package/docs/api/functions/isSepLineString.md +1 -1
  145. package/docs/api/functions/isStrWrapped.md +1 -1
  146. package/docs/api/functions/isSubdirectory.md +1 -1
  147. package/docs/api/functions/isTitleString.md +2 -2
  148. package/docs/api/functions/isWebStream.md +1 -1
  149. package/docs/api/functions/joinSplitWords.md +1 -1
  150. package/docs/api/functions/jsonFilterToWhere.md +2 -2
  151. package/docs/api/functions/jsonToMarkdownStr.md +2 -2
  152. package/docs/api/functions/loadAIConfig.md +1 -1
  153. package/docs/api/functions/loadConfig.md +1 -1
  154. package/docs/api/functions/loadConfigFile.md +1 -1
  155. package/docs/api/functions/loadFileFromPaths.md +2 -2
  156. package/docs/api/functions/loadTextFromPaths.md +3 -3
  157. package/docs/api/functions/lrucache.md +1 -1
  158. package/docs/api/functions/matchUrlProtocol.md +1 -1
  159. package/docs/api/functions/memoize.md +5 -3
  160. package/docs/api/functions/mergeArray.md +1 -1
  161. package/docs/api/functions/messagesToText.md +1 -1
  162. package/docs/api/functions/nanoid.md +45 -0
  163. package/docs/api/functions/normalizePath.md +1 -1
  164. package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
  165. package/docs/api/functions/parseCommand.md +3 -3
  166. package/docs/api/functions/parseDateFormat.md +7 -3
  167. package/docs/api/functions/parseISO.md +7 -3
  168. package/docs/api/functions/parseJsJson.md +2 -2
  169. package/docs/api/functions/parseJsJsonSimpleSync.md +2 -2
  170. package/docs/api/functions/parseObjectArgInfo.md +2 -2
  171. package/docs/api/functions/parseObjectArgumentInfos.md +2 -2
  172. package/docs/api/functions/parseObjectArguments.md +2 -2
  173. package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +2 -2
  174. package/docs/api/functions/parseYaml.md +1 -1
  175. package/docs/api/functions/pruneSubdirectories.md +1 -1
  176. package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
  177. package/docs/api/functions/quoteStr.md +1 -1
  178. package/docs/api/functions/readFilenamesRecursiveSync.md +2 -2
  179. package/docs/api/functions/readTextFileChunks.md +2 -2
  180. package/docs/api/functions/readTextFileChunksEx.md +2 -2
  181. package/docs/api/functions/readableFromAsyncIterable.md +4 -2
  182. package/docs/api/functions/registerCoreTools.md +1 -1
  183. package/docs/api/functions/removeMarkdownBold.md +2 -2
  184. package/docs/api/functions/removeMarkdownBoldAndItalic.md +2 -2
  185. package/docs/api/functions/removeMarkdownItalic.md +2 -2
  186. package/docs/api/functions/replaceWithPlaceholder.md +2 -2
  187. package/docs/api/functions/restoreFromPlacehoders.md +2 -2
  188. package/docs/api/functions/sanitizeFilename.md +1 -1
  189. package/docs/api/functions/sanitizeFilepath.md +1 -1
  190. package/docs/api/functions/saveConfigFile.md +1 -1
  191. package/docs/api/functions/scaleStrToParamsSize.md +1 -1
  192. package/docs/api/functions/shutdown.md +1 -1
  193. package/docs/api/functions/simplifyObjectArguments.md +1 -1
  194. package/docs/api/functions/sleep.md +1 -1
  195. package/docs/api/functions/sortedValues.md +4 -2
  196. package/docs/api/functions/splitChunks.md +2 -2
  197. package/docs/api/functions/splitParagraph.md +2 -2
  198. package/docs/api/functions/splitSentence.md +1 -1
  199. package/docs/api/functions/splitWords.md +1 -1
  200. package/docs/api/functions/stringifyYaml.md +1 -1
  201. package/docs/api/functions/stripConsoleColor.md +1 -1
  202. package/docs/api/functions/textToDate.md +1 -1
  203. package/docs/api/functions/throwError.md +1 -1
  204. package/docs/api/functions/toDate.md +7 -3
  205. package/docs/api/functions/toDateTime.md +1 -1
  206. package/docs/api/functions/trimStartOfStreamHelper.md +3 -3
  207. package/docs/api/functions/truncTo.md +1 -1
  208. package/docs/api/functions/truncateByToken.md +2 -2
  209. package/docs/api/functions/truncateToTokenLimit.md +2 -2
  210. package/docs/api/functions/truncateToTokenLimitEx.md +2 -2
  211. package/docs/api/functions/uuid.md +15 -6
  212. package/docs/api/functions/uuidStringify.md +1 -1
  213. package/docs/api/functions/uuidv1.md +5 -3
  214. package/docs/api/functions/uuidv4.md +5 -3
  215. package/docs/api/functions/uuidv5.md +5 -3
  216. package/docs/api/functions/uuidv6.md +61 -0
  217. package/docs/api/functions/uuidv7.md +61 -0
  218. package/docs/api/functions/wrapEventEmitter.md +1 -1
  219. package/docs/api/functions/xxhash.md +1 -1
  220. package/docs/api/functions/xxhash32.md +1 -1
  221. package/docs/api/functions/xxhash64.md +1 -1
  222. package/docs/api/functions/xxhashAsStr.md +1 -1
  223. package/docs/api/functions/yieldExec.md +1 -1
  224. package/docs/api/globals.md +11 -6
  225. package/docs/api/interfaces/AIChatAssistantMessageParam.md +12 -12
  226. package/docs/api/interfaces/AIChatContentPartImage.md +3 -3
  227. package/docs/api/interfaces/AIChatContentPartText.md +3 -3
  228. package/docs/api/interfaces/AIChatMessageParamBase.md +7 -7
  229. package/docs/api/interfaces/AIChatMessageToolCall.md +4 -4
  230. package/docs/api/interfaces/AIChatSystemMessageParam.md +9 -9
  231. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  232. package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
  233. package/docs/api/interfaces/AIChatToolFunc.md +5 -5
  234. package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
  235. package/docs/api/interfaces/AIChatToolMessageParam.md +10 -10
  236. package/docs/api/interfaces/AIChatToolParam.md +2 -2
  237. package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
  238. package/docs/api/interfaces/AIChatUserMessageParam.md +13 -13
  239. package/docs/api/interfaces/AIChoiceConfig.md +8 -8
  240. package/docs/api/interfaces/AIResult.md +12 -8
  241. package/docs/api/interfaces/AIStreamParser.md +8 -6
  242. package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
  243. package/docs/api/interfaces/BaseFunc.md +17 -17
  244. package/docs/api/interfaces/BaseFuncItem.md +15 -15
  245. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  246. package/docs/api/interfaces/BinarySemaphoreOptions.md +5 -5
  247. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  248. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  249. package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
  250. package/docs/api/interfaces/ClientFuncItem.md +21 -25
  251. package/docs/api/interfaces/EventClientFuncParams.md +5 -5
  252. package/docs/api/interfaces/EventServerFuncParams.md +14 -6
  253. package/docs/api/interfaces/FewShotPromptTemplateOptions.md +9 -7
  254. package/docs/api/interfaces/FuncItem.md +18 -18
  255. package/docs/api/interfaces/FuncParam.md +5 -5
  256. package/docs/api/interfaces/FuncParams.md +1 -1
  257. package/docs/api/interfaces/Funcs.md +1 -1
  258. package/docs/api/interfaces/HashAlgoParams.md +4 -4
  259. package/docs/api/interfaces/IClientToolTransport.md +9 -9
  260. package/docs/api/interfaces/IFileMetaInfo.md +8 -8
  261. package/docs/api/interfaces/IPubSubClientTransport.md +31 -7
  262. package/docs/api/interfaces/IPubSubServerTransport.md +92 -47
  263. package/docs/api/interfaces/IReadTextFileChunksOptions.md +13 -13
  264. package/docs/api/interfaces/IServerToolTransport.md +19 -14
  265. package/docs/api/interfaces/IToolTransport.md +6 -6
  266. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +11 -11
  267. package/docs/api/interfaces/JsonFilter.md +1 -1
  268. package/docs/api/interfaces/ParseObjectArgumentOptions.md +11 -11
  269. package/docs/api/interfaces/ProbabilityItem.md +4 -4
  270. package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
  271. package/docs/api/interfaces/PubSubClientStream.md +26 -14
  272. package/docs/api/interfaces/PubSubServerSession.md +8 -8
  273. package/docs/api/interfaces/RemoteFuncItem.md +21 -25
  274. package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
  275. package/docs/api/interfaces/ResClientFuncParams.md +3 -3
  276. package/docs/api/interfaces/ResServerFuncParams.md +6 -6
  277. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +2 -2
  278. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +4 -4
  279. package/docs/api/interfaces/SectionStringOptions.md +3 -3
  280. package/docs/api/interfaces/SemaphoreOptions.md +7 -7
  281. package/docs/api/interfaces/SemaphoreTaskItem.md +6 -6
  282. package/docs/api/interfaces/ServerFuncItem.md +22 -26
  283. package/docs/api/interfaces/ServerFuncParams.md +3 -3
  284. package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
  285. package/docs/api/interfaces/StreamCallbacksAndOptions.md +11 -7
  286. package/docs/api/interfaces/TaskAbortControllers.md +1 -1
  287. package/docs/api/interfaces/TaskPromise.md +17 -9
  288. package/docs/api/interfaces/ToolFuncPackage.md +5 -5
  289. package/docs/api/type-aliases/AIChatContentPart.md +2 -2
  290. package/docs/api/type-aliases/AIChatMessageParam.md +2 -2
  291. package/docs/api/type-aliases/AIChatRole.md +2 -2
  292. package/docs/api/type-aliases/AIChatToolChoiceParam.md +2 -2
  293. package/docs/api/type-aliases/AIMessageType.md +2 -2
  294. package/docs/api/type-aliases/AIModelNameRule.md +2 -2
  295. package/docs/api/type-aliases/AIModelNameRuleFn.md +2 -2
  296. package/docs/api/type-aliases/AIModelNameRules.md +2 -2
  297. package/docs/api/type-aliases/AITextGenerationFinishReason.md +2 -2
  298. package/docs/api/type-aliases/ActionName.md +2 -2
  299. package/docs/api/type-aliases/ArrayMergeWay.md +2 -2
  300. package/docs/api/type-aliases/AsyncTaskId.md +2 -2
  301. package/docs/api/type-aliases/BeforeShutdownListener.md +2 -2
  302. package/docs/api/type-aliases/EventErrorListenerFn.md +2 -2
  303. package/docs/api/type-aliases/EventListenerFn.md +2 -2
  304. package/docs/api/type-aliases/FuncParamType.md +2 -2
  305. package/docs/api/type-aliases/PromptExamples.md +5 -3
  306. package/docs/api/type-aliases/PubSubClientId.md +2 -2
  307. package/docs/api/type-aliases/PubSubCtx.md +24 -4
  308. package/docs/api/type-aliases/RpcMethodHandler.md +2 -2
  309. package/docs/api/type-aliases/SSEClient.md +53 -0
  310. package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +2 -2
  311. package/docs/api/type-aliases/TFunc.md +2 -2
  312. package/docs/api/type-aliases/UUIDVersions.md +11 -0
  313. package/docs/api/variables/AIChatRoles.md +1 -1
  314. package/docs/api/variables/AIMessageTypes.md +1 -1
  315. package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
  316. package/docs/api/variables/ActionNames.md +1 -1
  317. package/docs/api/variables/ArrayMergeWay.md +2 -2
  318. package/docs/api/variables/ArrayMergeWaySymbol.md +2 -2
  319. package/docs/api/variables/ClientEventPrefix.md +11 -0
  320. package/docs/api/variables/ClientToolFuncSchema.md +4 -2
  321. package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
  322. package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  323. package/docs/api/variables/EventBusName.md +1 -1
  324. package/docs/api/variables/EventName.md +1 -1
  325. package/docs/api/variables/FuncMetaSymbol.md +2 -2
  326. package/docs/api/variables/LLM_TOKENIZER_NAMES.md +4 -4
  327. package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  328. package/docs/api/variables/PASSING_SCORE.md +1 -1
  329. package/docs/api/variables/RStreamErrCode.md +1 -1
  330. package/docs/api/variables/RemoteToolFuncSchema.md +4 -2
  331. package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
  332. package/docs/api/variables/RpcMethodsClientToolSchema.md +4 -2
  333. package/docs/api/variables/RpcMethodsServerToolSchema.md +2 -2
  334. package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
  335. package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  336. package/docs/api/variables/SecondaryCache.md +1 -1
  337. package/docs/api/variables/ServerToolFuncSchema.md +4 -2
  338. package/docs/api/variables/StrangeHumanName.md +1 -1
  339. package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
  340. package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
  341. package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
  342. package/docs/api/variables/ToolFuncSchema.md +4 -2
  343. package/docs/api/variables/backendEventable.md +11 -0
  344. package/docs/api/variables/base32768.md +1 -1
  345. package/docs/api/variables/event.md +1 -1
  346. package/docs/api/variables/eventClient.md +1 -1
  347. package/docs/api/variables/eventServer.md +1 -1
  348. package/docs/api/variables/lrucache.md +1 -1
  349. package/docs/api/variables/makeToolFuncCancelable.md +11 -0
  350. package/docs/api/{functions → variables}/wait.md +16 -14
  351. package/docs/pubsub.md +427 -105
  352. package/docs/server_client_tools.md +5 -3
  353. package/docs/toolFunc.md +3 -1
  354. package/package.json +8 -7
  355. package/dist/chunk-4XRPAC7C.mjs +0 -1
  356. package/docs/api/functions/backendEventable.md +0 -29
  357. package/docs/api/functions/makeToolFuncCancelable.md +0 -29
  358. package/docs/api/interfaces/PubSubClient.md +0 -27
  359. package/docs/api/namespaces/uuidv5/README.md +0 -12
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: SignalGate\<T\>
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L20)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L20)
10
10
 
11
11
  An asynchronous signal gate that blocks operations until a signal is emitted.
12
12
  This class allows multiple awaiters to wait for a signal and resolves all pending promises with the emitted value.
@@ -26,17 +26,19 @@ valueGate.signal(42); // Must provide a number value
26
26
 
27
27
  ## Type Parameters
28
28
 
29
- **T** = `void`
29
+ ### T
30
+
31
+ `T` = `void`
30
32
 
31
33
  ## Constructors
32
34
 
33
- ### new SignalGate()
35
+ ### Constructor
34
36
 
35
- > **new SignalGate**\<`T`\>(): [`SignalGate`](SignalGate.md)\<`T`\>
37
+ > **new SignalGate**\<`T`\>(): `SignalGate`\<`T`\>
36
38
 
37
39
  #### Returns
38
40
 
39
- [`SignalGate`](SignalGate.md)\<`T`\>
41
+ `SignalGate`\<`T`\>
40
42
 
41
43
  ## Properties
42
44
 
@@ -44,7 +46,7 @@ valueGate.signal(42); // Must provide a number value
44
46
 
45
47
  > `protected` **\_isSignaled**: `boolean` = `false`
46
48
 
47
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L21)
49
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L21)
48
50
 
49
51
  ***
50
52
 
@@ -52,7 +54,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:21](
52
54
 
53
55
  > `protected` **\_signalValue**: `undefined` \| `T`
54
56
 
55
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L22)
57
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L22)
56
58
 
57
59
  ***
58
60
 
@@ -60,7 +62,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:22](
60
62
 
61
63
  > `protected` **waitQueue**: `object`[] = `[]`
62
64
 
63
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L23)
65
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L23)
64
66
 
65
67
  #### reject()
66
68
 
@@ -98,7 +100,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:23](
98
100
 
99
101
  > **get** **signaled**(): `boolean`
100
102
 
101
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L28)
103
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L28)
102
104
 
103
105
  ##### Returns
104
106
 
@@ -108,9 +110,9 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:28](
108
110
 
109
111
  ### abort()
110
112
 
111
- > **abort**(`reason`?): `void`
113
+ > **abort**(`reason?`): `void`
112
114
 
113
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L65)
115
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L65)
114
116
 
115
117
  Aborts all pending waits, rejecting their promises with an error.
116
118
  This does **not** reset the signal state (the gate remains signaled or unsignaled).
@@ -133,7 +135,7 @@ The reason for aborting the waits.
133
135
 
134
136
  > **reset**(): `void`
135
137
 
136
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L53)
138
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L53)
137
139
 
138
140
  Resets the gate to its initial state, allowing a new signal to be emitted.
139
141
 
@@ -145,12 +147,12 @@ Resets the gate to its initial state, allowing a new signal to be emitted.
145
147
 
146
148
  ### signal()
147
149
 
148
- > **signal**(`value`?): `void`
150
+ > **signal**(`value?`): `void`
149
151
 
150
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L38)
152
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L38)
151
153
 
152
- Emits the signal with an optional value, resolving all pending [wait](../functions/wait.md) promises.
153
- Subsequent calls have no effect until [reset](SignalGate.md#reset) is called.
154
+ Emits the signal with an optional value, resolving all pending [wait](../variables/wait.md) promises.
155
+ Subsequent calls have no effect until [reset](#reset) is called.
154
156
 
155
157
  #### Parameters
156
158
 
@@ -170,7 +172,7 @@ The value to emit with the signal (only required if T is not void).
170
172
 
171
173
  > **wait**(): `Promise`\<`T`\>
172
174
 
173
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-signal-gate.ts#L83)
175
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-signal-gate.ts#L83)
174
176
 
175
177
  Returns a promise that resolves with the emitted signal value.
176
178
  If called after the signal has been emitted, resolves immediately with the stored value.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: SseClientPubSubTransport
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:4](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L4)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:5](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-client.ts#L5)
10
10
 
11
11
  Defines the interface for a client-side PubSub transport.
12
12
 
@@ -19,21 +19,21 @@ stream (`PubSubClientStream`) to the server.
19
19
 
20
20
  ## Constructors
21
21
 
22
- ### new SseClientPubSubTransport()
22
+ ### Constructor
23
23
 
24
- > **new SseClientPubSubTransport**(): [`SseClientPubSubTransport`](SseClientPubSubTransport.md)
24
+ > **new SseClientPubSubTransport**(): `SseClientPubSubTransport`
25
25
 
26
26
  #### Returns
27
27
 
28
- [`SseClientPubSubTransport`](SseClientPubSubTransport.md)
28
+ `SseClientPubSubTransport`
29
29
 
30
30
  ## Methods
31
31
 
32
32
  ### connect()
33
33
 
34
- > **connect**(`url`, `params`?): [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
34
+ > **connect**(`url`, `params?`): `Promise`\<[`PubSubClientStream`](../interfaces/PubSubClientStream.md)\>
35
35
 
36
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:5](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L5)
36
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:12](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-client.ts#L12)
37
37
 
38
38
  Establishes a connection to a server endpoint.
39
39
 
@@ -43,18 +43,18 @@ Establishes a connection to a server endpoint.
43
43
 
44
44
  `string`
45
45
 
46
- The URL of the server's PubSub endpoint.
46
+ The full URL of the endpoint, or a path relative to the `apiRoot` that may have been configured on the transport.
47
47
 
48
48
  ##### params?
49
49
 
50
- `Record`\<`string`, `any`\>
50
+ `any`
51
51
 
52
52
  Optional parameters for the connection, which might include
53
53
  things like authentication tokens, initial subscription topics, or a client ID.
54
54
 
55
55
  #### Returns
56
56
 
57
- [`PubSubClientStream`](../interfaces/PubSubClientStream.md)
57
+ `Promise`\<[`PubSubClientStream`](../interfaces/PubSubClientStream.md)\>
58
58
 
59
59
  A `PubSubClientStream` instance that represents the active connection.
60
60
 
@@ -68,7 +68,7 @@ A `PubSubClientStream` instance that represents the active connection.
68
68
 
69
69
  > **disconnect**(`stream`): `void`
70
70
 
71
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:45](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-client.ts#L45)
71
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:80](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-client.ts#L80)
72
72
 
73
73
  Optional. Disconnects a given stream.
74
74
  While the `close` method exists on the stream itself, placing `disconnect`
@@ -90,3 +90,31 @@ The stream to disconnect.
90
90
  #### Implementation of
91
91
 
92
92
  [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md).[`disconnect`](../interfaces/IPubSubClientTransport.md#disconnect)
93
+
94
+ ***
95
+
96
+ ### setApiRoot()
97
+
98
+ > **setApiRoot**(`apiRoot`): `void`
99
+
100
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-client.ts:8](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-client.ts#L8)
101
+
102
+ Optional. Configures the transport with a base URL.
103
+ If implemented, this allows the transport to resolve relative paths
104
+ passed to the `connect` method.
105
+
106
+ #### Parameters
107
+
108
+ ##### apiRoot
109
+
110
+ `string`
111
+
112
+ The base URL for the API.
113
+
114
+ #### Returns
115
+
116
+ `void`
117
+
118
+ #### Implementation of
119
+
120
+ [`IPubSubClientTransport`](../interfaces/IPubSubClientTransport.md).[`setApiRoot`](../interfaces/IPubSubClientTransport.md#setapiroot)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: SseServerPubSubTransport
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:5](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L5)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:5](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L5)
10
10
 
11
11
  Defines the interface for a server-side PubSub transport layer.
12
12
 
@@ -21,13 +21,13 @@ connections, subscriptions, and message passing.
21
21
 
22
22
  ## Constructors
23
23
 
24
- ### new SseServerPubSubTransport()
24
+ ### Constructor
25
25
 
26
- > **new SseServerPubSubTransport**(): [`SseServerPubSubTransport`](SseServerPubSubTransport.md)
26
+ > **new SseServerPubSubTransport**(): `SseServerPubSubTransport`
27
27
 
28
28
  #### Returns
29
29
 
30
- [`SseServerPubSubTransport`](SseServerPubSubTransport.md)
30
+ `SseServerPubSubTransport`
31
31
 
32
32
  ## Properties
33
33
 
@@ -35,7 +35,7 @@ connections, subscriptions, and message passing.
35
35
 
36
36
  > `readonly` **name**: `"sse"` = `'sse'`
37
37
 
38
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:6](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L6)
38
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:6](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L6)
39
39
 
40
40
  A unique, human-readable name for the transport (e.g., 'sse', 'websocket').
41
41
 
@@ -49,7 +49,7 @@ A unique, human-readable name for the transport (e.g., 'sse', 'websocket').
49
49
 
50
50
  > `readonly` **protocol**: `"sse"`
51
51
 
52
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:7](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L7)
52
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:7](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L7)
53
53
 
54
54
  The protocol identifier.
55
55
 
@@ -59,23 +59,79 @@ The protocol identifier.
59
59
 
60
60
  ## Methods
61
61
 
62
- ### mount()?
62
+ ### connect()
63
63
 
64
- > `optional` **mount**(): `void`
64
+ > **connect**(`options?`): [`PubSubServerSession`](../interfaces/PubSubServerSession.md)
65
65
 
66
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L13)
66
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:14](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L14)
67
67
 
68
- Optional method to mount or register the transport's endpoint with an HTTP
69
- server or framework. This is typically required for protocols like SSE or
70
- WebSockets that need to handle incoming HTTP requests at a specific path.
68
+ Connects a client, establishing a persistent communication channel.
69
+
70
+ This method is designed to be generic. Transport-specific details, such as
71
+ HTTP request/response objects, are passed inside the `options` parameter.
72
+ For protocols like SSE, initial events can be passed to be subscribed to at connection time.
73
+
74
+ #### Parameters
75
+
76
+ ##### options?
77
+
78
+ A container for transport-specific parameters, including optional initial events.
79
+
80
+ ###### clientId?
81
+
82
+ `string`
83
+
84
+ ###### events?
85
+
86
+ `string`[]
87
+
88
+ ###### req
89
+
90
+ `IncomingMessage`
91
+
92
+ ###### res
93
+
94
+ `ServerResponse`
71
95
 
72
96
  #### Returns
73
97
 
74
- `void`
98
+ [`PubSubServerSession`](../interfaces/PubSubServerSession.md)
99
+
100
+ A `PubSubServerSession` object representing the newly connected client session.
101
+
102
+ #### Implementation of
103
+
104
+ [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`connect`](../interfaces/IPubSubServerTransport.md#connect)
105
+
106
+ ***
107
+
108
+ ### getSessionFromReq()
109
+
110
+ > **getSessionFromReq**(`req`): `undefined` \| [`PubSubServerSession`](../interfaces/PubSubServerSession.md)
111
+
112
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:44](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L44)
113
+
114
+ Optional. Finds and returns a session based on a request object.
115
+ This is used by higher-level tools to find the correct session
116
+ for operations like adding a subscription via a generic RPC call.
117
+
118
+ #### Parameters
119
+
120
+ ##### req
121
+
122
+ `IncomingMessage`
123
+
124
+ The request object (e.g., http.IncomingMessage or Electron.IpcMainEvent).
125
+
126
+ #### Returns
127
+
128
+ `undefined` \| [`PubSubServerSession`](../interfaces/PubSubServerSession.md)
129
+
130
+ The corresponding session, or undefined if not found.
75
131
 
76
132
  #### Implementation of
77
133
 
78
- [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`mount`](../interfaces/IPubSubServerTransport.md#mount)
134
+ [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`getSessionFromReq`](../interfaces/IPubSubServerTransport.md#getsessionfromreq)
79
135
 
80
136
  ***
81
137
 
@@ -83,7 +139,7 @@ WebSockets that need to handle incoming HTTP requests at a specific path.
83
139
 
84
140
  > **onConnection**(`cb`): `void`
85
141
 
86
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:44](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L44)
142
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:69](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L69)
87
143
 
88
144
  Registers a callback to be invoked when a new client connection is established
89
145
  and a session is created.
@@ -110,7 +166,7 @@ The callback function that receives the new `PubSubServerSession`.
110
166
 
111
167
  > **onDisconnect**(`cb`): `void`
112
168
 
113
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:45](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L45)
169
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:70](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L70)
114
170
 
115
171
  Registers a callback to be invoked when a client disconnects.
116
172
 
@@ -135,9 +191,9 @@ The callback function that receives the `PubSubServerSession` of the
135
191
 
136
192
  ### publish()
137
193
 
138
- > **publish**(`event`, `data`, `target`?): `void`
194
+ > **publish**(`event`, `data`, `target?`): `void`
139
195
 
140
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:40](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L40)
196
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:65](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L65)
141
197
 
142
198
  Publishes an event from the server to connected clients.
143
199
 
@@ -182,53 +238,70 @@ A single `PubSubClientId` or an array of IDs to
182
238
 
183
239
  ### subscribe()
184
240
 
185
- > **subscribe**(`events`?, `options`?): `Client`
241
+ > **subscribe**(`session`, `events`): `void`
186
242
 
187
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/sse-server.ts#L15)
243
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:53](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L53)
188
244
 
189
- Establishes a connection with a client and subscribes it to an event stream.
245
+ Subscribes a client session to one or more events.
190
246
 
191
- This method is designed to be generic. Transport-specific details, such as
192
- HTTP request/response objects or connection handles, should be passed
193
- inside the `options` parameter to avoid polluting the abstraction layer.
247
+ Note: Not all transports may support subscribing to new events after the
248
+ initial connection. For transports like SSE, this might be a no-op or
249
+ throw an error.
194
250
 
195
251
  #### Parameters
196
252
 
197
- ##### events?
253
+ ##### session
254
+
255
+ [`PubSubServerSession`](../interfaces/PubSubServerSession.md)
256
+
257
+ The `PubSubServerSession` of the client.
258
+
259
+ ##### events
198
260
 
199
261
  `string`[]
200
262
 
201
- Optional array of event names to initially subscribe the client to.
263
+ An array of event names to subscribe to.
202
264
 
203
- ##### options?
265
+ #### Returns
204
266
 
205
- A container for transport-specific parameters.
267
+ `void`
206
268
 
207
- ###### clientId?
269
+ #### Implementation of
208
270
 
209
- `string`
271
+ [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`subscribe`](../interfaces/IPubSubServerTransport.md#subscribe)
272
+
273
+ ***
210
274
 
211
- An optional ID provided by the client. If not provided,
212
- the transport should generate one.
275
+ ### unsubscribe()
213
276
 
214
- ###### req?
277
+ > **unsubscribe**(`session`, `events`): `void`
215
278
 
216
- `IncomingMessage`
279
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/sse-server.ts:59](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/sse-server.ts#L59)
217
280
 
218
- The underlying request object (e.g., `http.IncomingMessage`).
281
+ Unsubscribes a client session from one or more events.
219
282
 
220
- ###### res?
283
+ Note: Not all transports may support unsubscribing from events after the
284
+ initial connection. For transports like SSE, this might be a no-op or
285
+ throw an error.
221
286
 
222
- `ServerResponse`\<`IncomingMessage`\>
287
+ #### Parameters
223
288
 
224
- The underlying response object (e.g., `http.ServerResponse`).
289
+ ##### session
225
290
 
226
- #### Returns
291
+ [`PubSubServerSession`](../interfaces/PubSubServerSession.md)
227
292
 
228
- `Client`
293
+ The `PubSubServerSession` of the client.
229
294
 
230
- A `PubSubClient` object representing the newly connected client.
295
+ ##### events
296
+
297
+ `string`[]
298
+
299
+ An array of event names to unsubscribe from.
300
+
301
+ #### Returns
302
+
303
+ `void`
231
304
 
232
305
  #### Implementation of
233
306
 
234
- [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`subscribe`](../interfaces/IPubSubServerTransport.md#subscribe)
307
+ [`IPubSubServerTransport`](../interfaces/IPubSubServerTransport.md).[`unsubscribe`](../interfaces/IPubSubServerTransport.md#unsubscribe)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: TaskAbortController
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L35)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L35)
10
10
 
11
11
  ## Extends
12
12
 
@@ -14,11 +14,11 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:35]
14
14
 
15
15
  ## Constructors
16
16
 
17
- ### new TaskAbortController()
17
+ ### Constructor
18
18
 
19
- > **new TaskAbortController**(`parent`): [`TaskAbortController`](TaskAbortController.md)
19
+ > **new TaskAbortController**(`parent`): `TaskAbortController`
20
20
 
21
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L41)
21
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L41)
22
22
 
23
23
  #### Parameters
24
24
 
@@ -28,7 +28,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:41]
28
28
 
29
29
  #### Returns
30
30
 
31
- [`TaskAbortController`](TaskAbortController.md)
31
+ `TaskAbortController`
32
32
 
33
33
  #### Overrides
34
34
 
@@ -40,7 +40,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:41]
40
40
 
41
41
  > `optional` **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
42
42
 
43
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L36)
43
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L36)
44
44
 
45
45
  ***
46
46
 
@@ -48,7 +48,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:36]
48
48
 
49
49
  > **parent**: [`CancelableAbility`](CancelableAbility.md)
50
50
 
51
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L39)
51
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L39)
52
52
 
53
53
  ***
54
54
 
@@ -72,7 +72,7 @@ Returns the AbortSignal object associated with this object.
72
72
 
73
73
  > `optional` **streamController**: `ReadableStreamDefaultController`\<`any`\>
74
74
 
75
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L38)
75
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L38)
76
76
 
77
77
  ***
78
78
 
@@ -80,15 +80,15 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:38]
80
80
 
81
81
  > `optional` **timeoutId**: `any`
82
82
 
83
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L37)
83
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L37)
84
84
 
85
85
  ## Methods
86
86
 
87
87
  ### abort()
88
88
 
89
- > **abort**(`reason`?, `data`?): `void`
89
+ > **abort**(`reason?`, `data?`): `void`
90
90
 
91
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L46)
91
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L46)
92
92
 
93
93
  Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted.
94
94
 
@@ -116,9 +116,9 @@ Invoking this method will set this object's AbortSignal's aborted flag and signa
116
116
 
117
117
  ### throwRejected()
118
118
 
119
- > **throwRejected**(`alreadyRejected`?): `undefined` \| `true`
119
+ > **throwRejected**(`alreadyRejected?`): `undefined` \| `true`
120
120
 
121
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L55)
121
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L55)
122
122
 
123
123
  #### Parameters
124
124