@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
  # Interface: FuncItem
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L184)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L184)
10
10
 
11
11
  Extends `BaseFuncItem` to include the actual function implementation.
12
12
 
@@ -20,7 +20,7 @@ Extends `BaseFuncItem` to include the actual function implementation.
20
20
 
21
21
  > `optional` **alias**: `string` \| `string`[]
22
22
 
23
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L130)
23
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L130)
24
24
 
25
25
  Optional aliases for the function name.
26
26
 
@@ -34,7 +34,7 @@ Optional aliases for the function name.
34
34
 
35
35
  > `optional` **asyncFeatures**: `number`
36
36
 
37
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L144)
37
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L144)
38
38
 
39
39
  A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
40
40
  This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
@@ -64,7 +64,7 @@ const func = new ToolFunc({
64
64
 
65
65
  > `optional` **depends**: `object`
66
66
 
67
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L167)
67
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L167)
68
68
 
69
69
  A map of dependencies this function has on other tool functions.
70
70
  Declaring dependencies ensures that they are automatically registered when this function is registered.
@@ -103,7 +103,7 @@ mainFunc.register();
103
103
 
104
104
  > `optional` **description**: `string`
105
105
 
106
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
106
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L172)
107
107
 
108
108
  A detailed description of what the function does.
109
109
 
@@ -117,7 +117,7 @@ A detailed description of what the function does.
117
117
 
118
118
  > `optional` **func**: [`TFunc`](../type-aliases/TFunc.md)
119
119
 
120
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:189](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L189)
120
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:189](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L189)
121
121
 
122
122
  The implementation of the tool function.
123
123
 
@@ -127,7 +127,7 @@ The implementation of the tool function.
127
127
 
128
128
  > `optional` **isApi**: `boolean`
129
129
 
130
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L119)
130
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L119)
131
131
 
132
132
  If true, indicates that this function should be treated as a server-side API.
133
133
 
@@ -141,13 +141,13 @@ If true, indicates that this function should be treated as a server-side API.
141
141
 
142
142
  > `optional` **name**: `string`
143
143
 
144
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L76)
144
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L76)
145
145
 
146
146
  The unique name of the function.
147
147
 
148
148
  #### Inherited from
149
149
 
150
- [`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name-2)
150
+ [`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
151
151
 
152
152
  ***
153
153
 
@@ -155,7 +155,7 @@ The unique name of the function.
155
155
 
156
156
  > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
157
157
 
158
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L81)
158
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L81)
159
159
 
160
160
  Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
161
161
 
@@ -169,7 +169,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
169
169
 
170
170
  > `optional` **result**: `string` \| `Record`\<`string`, `any`\>
171
171
 
172
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
172
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L86)
173
173
 
174
174
  The expected return type of the function, described as a string or a JSON schema object.
175
175
 
@@ -183,7 +183,7 @@ The expected return type of the function, described as a string or a JSON schema
183
183
 
184
184
  > `optional` **scope**: `any`
185
185
 
186
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L91)
186
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L91)
187
187
 
188
188
  The execution scope or context (`this`) for the function.
189
189
 
@@ -195,9 +195,9 @@ The execution scope or context (`this`) for the function.
195
195
 
196
196
  ### setup()?
197
197
 
198
- > `optional` **setup**: (`this`, `options`?) => `void`
198
+ > `optional` **setup**: (`this`, `options?`) => `void`
199
199
 
200
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L114)
200
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L114)
201
201
 
202
202
  A lifecycle hook called once during the `ToolFunc` instance's initialization.
203
203
  It allows for initial setup, state configuration, or property modification on the instance
@@ -211,7 +211,7 @@ before it is used or registered. The `this` context is the `ToolFunc` instance i
211
211
 
212
212
  ##### options?
213
213
 
214
- [`FuncItem`](FuncItem.md)
214
+ `FuncItem`
215
215
 
216
216
  The configuration options for the function.
217
217
 
@@ -243,7 +243,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
243
243
 
244
244
  > `optional` **stream**: `boolean`
245
245
 
246
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L125)
246
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L125)
247
247
 
248
248
  If true, indicates that the function has the *capability* to stream its output.
249
249
  Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
@@ -258,7 +258,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
258
258
 
259
259
  > `optional` **tags**: `string` \| `string`[]
260
260
 
261
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L96)
261
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L96)
262
262
 
263
263
  Tags for grouping or filtering functions.
264
264
 
@@ -272,7 +272,7 @@ Tags for grouping or filtering functions.
272
272
 
273
273
  > `optional` **title**: `string`
274
274
 
275
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L177)
275
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L177)
276
276
 
277
277
  A concise, human-readable title for the function, often used in UI or by AI.
278
278
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: FuncParam
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L15)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:15](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L15)
10
10
 
11
11
  Describes a single function parameter, including its name, type, and description.
12
12
 
@@ -16,7 +16,7 @@ Describes a single function parameter, including its name, type, and description
16
16
 
17
17
  > `optional` **description**: `string`
18
18
 
19
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L38)
19
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L38)
20
20
 
21
21
  A description of the parameter, explaining its purpose and usage.
22
22
 
@@ -26,7 +26,7 @@ A description of the parameter, explaining its purpose and usage.
26
26
 
27
27
  > `optional` **name**: `string`
28
28
 
29
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L20)
29
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L20)
30
30
 
31
31
  The name of the parameter.
32
32
 
@@ -36,7 +36,7 @@ The name of the parameter.
36
36
 
37
37
  > `optional` **required**: `boolean`
38
38
 
39
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L32)
39
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:32](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L32)
40
40
 
41
41
  Indicates whether the parameter is required.
42
42
 
@@ -46,6 +46,6 @@ Indicates whether the parameter is required.
46
46
 
47
47
  > `optional` **type**: `string`
48
48
 
49
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L26)
49
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L26)
50
50
 
51
51
  The data type of the parameter, represented as a string identifier (e.g., 'string', 'number').
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: FuncParams
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:54](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L54)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:54](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L54)
10
10
 
11
11
  A map of function parameters, where each key is the parameter name.
12
12
  The value can be either a detailed `FuncParam` object or a simple type string.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: Funcs
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:208](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L208)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:208](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L208)
10
10
 
11
11
  A map of registered `ToolFunc` instances, indexed by their names.
12
12
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: HashAlgoParams
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/hash/hash.ts#L10)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:10](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/hash/hash.ts#L10)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:10](https://
14
14
 
15
15
  > `optional` **hashAlgo**: [`HashAlgorithm`](../enumerations/HashAlgorithm.md)
16
16
 
17
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:11](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/hash/hash.ts#L11)
17
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:11](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/hash/hash.ts#L11)
18
18
 
19
19
  ***
20
20
 
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:11](https://
22
22
 
23
23
  > `optional` **outputType**: `"string"` \| `"hex"` \| `"binary"`
24
24
 
25
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/hash/hash.ts#L13)
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:13](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/hash/hash.ts#L13)
26
26
 
27
27
  ***
28
28
 
@@ -30,4 +30,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:13](https://
30
30
 
31
31
  > `optional` **seed**: `number`
32
32
 
33
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:12](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/hash/hash.ts#L12)
33
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:12](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/hash/hash.ts#L12)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: IClientToolTransport
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L10)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:10](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/client.ts#L10)
10
10
 
11
11
  Defines the public interface for a client-side transport,
12
12
  responsible for communicating with a ServerTransport.
@@ -25,7 +25,7 @@ responsible for communicating with a ServerTransport.
25
25
 
26
26
  > **apiRoot**: `string`
27
27
 
28
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:22](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/base.ts#L22)
28
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:22](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/base.ts#L22)
29
29
 
30
30
  The root endpoint for the remote service.
31
31
  For HTTP, this is a URL. For IPC, it could be a channel name.
@@ -40,7 +40,7 @@ For HTTP, this is a URL. For IPC, it could be a channel name.
40
40
 
41
41
  > `optional` **options**: `any`
42
42
 
43
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:26](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/base.ts#L26)
43
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:26](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/base.ts#L26)
44
44
 
45
45
  Additional options for the transport start or fetch, passed by mount.
46
46
 
@@ -54,7 +54,7 @@ Additional options for the transport start or fetch, passed by mount.
54
54
 
55
55
  > **Tools**: *typeof* [`ToolFunc`](../classes/ToolFunc.md)
56
56
 
57
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:17](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/base.ts#L17)
57
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:17](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/base.ts#L17)
58
58
 
59
59
  #### Inherited from
60
60
 
@@ -64,9 +64,9 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:17](https://
64
64
 
65
65
  ### fetch()
66
66
 
67
- > **fetch**(`name`, `args`?, `act`?, `subName`?, `options`?): `any`
67
+ > **fetch**(`name`, `args?`, `act?`, `subName?`, `options?`): `any`
68
68
 
69
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:28](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L28)
69
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:28](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/client.ts#L28)
70
70
 
71
71
  Fetches data from the server.
72
72
 
@@ -114,7 +114,7 @@ A promise that resolves with the fetched data.
114
114
 
115
115
  > **loadApis**(): `Promise`\<[`Funcs`](Funcs.md)\>
116
116
 
117
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L15)
117
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:15](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/client.ts#L15)
118
118
 
119
119
  Connects to the server's discovery endpoint to get the list of available tools.
120
120
 
@@ -128,9 +128,9 @@ A promise that resolves to a map of tool function metadata.
128
128
 
129
129
  ### mount()
130
130
 
131
- > **mount**(`clientTools`, `apiPrefix`?, `options`?): `any`
131
+ > **mount**(`clientTools`, `apiPrefix?`, `options?`): `any`
132
132
 
133
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:17](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/client.ts#L17)
133
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:17](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/client.ts#L17)
134
134
 
135
135
  #### Parameters
136
136
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: IFileMetaInfo
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:225](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L225)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:225](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L225)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
14
14
 
15
15
  > **ctime**: `Date`
16
16
 
17
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:228](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L228)
17
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:228](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L228)
18
18
 
19
19
  ***
20
20
 
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
22
22
 
23
23
  > **hash**: `string`
24
24
 
25
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:230](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L230)
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:230](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L230)
26
26
 
27
27
  ***
28
28
 
@@ -30,7 +30,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
30
30
 
31
31
  > **id**: `string`
32
32
 
33
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:232](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L232)
33
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:232](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L232)
34
34
 
35
35
  ***
36
36
 
@@ -38,7 +38,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
38
38
 
39
39
  > **mimeType**: `string`
40
40
 
41
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:231](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L231)
41
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:231](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L231)
42
42
 
43
43
  ***
44
44
 
@@ -46,7 +46,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
46
46
 
47
47
  > **mtime**: `Date`
48
48
 
49
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:227](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L227)
49
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:227](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L227)
50
50
 
51
51
  ***
52
52
 
@@ -54,7 +54,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
54
54
 
55
55
  > **name**: `string`
56
56
 
57
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:226](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L226)
57
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:226](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L226)
58
58
 
59
59
  ***
60
60
 
@@ -62,4 +62,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:2
62
62
 
63
63
  > **size**: `number`
64
64
 
65
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:229](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/load-file-from-paths.ts#L229)
65
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:229](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-file-from-paths.ts#L229)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: IPubSubClientTransport
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:74](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/client.ts#L74)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:81](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/client.ts#L81)
10
10
 
11
11
  Defines the interface for a client-side PubSub transport.
12
12
 
@@ -17,9 +17,9 @@ stream (`PubSubClientStream`) to the server.
17
17
 
18
18
  ### connect()
19
19
 
20
- > **connect**: (`url`, `params`?) => [`PubSubClientStream`](PubSubClientStream.md)
20
+ > **connect**: (`url`, `params?`) => [`PubSubClientStream`](PubSubClientStream.md) \| `Promise`\<[`PubSubClientStream`](PubSubClientStream.md)\>
21
21
 
22
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:82](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/client.ts#L82)
22
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:89](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/client.ts#L89)
23
23
 
24
24
  Establishes a connection to a server endpoint.
25
25
 
@@ -29,18 +29,18 @@ Establishes a connection to a server endpoint.
29
29
 
30
30
  `string`
31
31
 
32
- The URL of the server's PubSub endpoint.
32
+ The full URL of the endpoint, or a path relative to the `apiRoot` that may have been configured on the transport.
33
33
 
34
34
  ##### params?
35
35
 
36
- `Record`\<`string`, `any`\>
36
+ `any`
37
37
 
38
38
  Optional parameters for the connection, which might include
39
39
  things like authentication tokens, initial subscription topics, or a client ID.
40
40
 
41
41
  #### Returns
42
42
 
43
- [`PubSubClientStream`](PubSubClientStream.md)
43
+ [`PubSubClientStream`](PubSubClientStream.md) \| `Promise`\<[`PubSubClientStream`](PubSubClientStream.md)\>
44
44
 
45
45
  A `PubSubClientStream` instance that represents the active connection.
46
46
 
@@ -50,7 +50,7 @@ A `PubSubClientStream` instance that represents the active connection.
50
50
 
51
51
  > `optional` **disconnect**: (`stream`) => `void`
52
52
 
53
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/transports/pubsub/client.ts#L91)
53
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:98](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/client.ts#L98)
54
54
 
55
55
  Optional. Disconnects a given stream.
56
56
  While the `close` method exists on the stream itself, placing `disconnect`
@@ -68,3 +68,27 @@ The stream to disconnect.
68
68
  #### Returns
69
69
 
70
70
  `void`
71
+
72
+ ***
73
+
74
+ ### setApiRoot()?
75
+
76
+ > `optional` **setApiRoot**: (`apiRoot`) => `void`
77
+
78
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:106](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/client.ts#L106)
79
+
80
+ Optional. Configures the transport with a base URL.
81
+ If implemented, this allows the transport to resolve relative paths
82
+ passed to the `connect` method.
83
+
84
+ #### Parameters
85
+
86
+ ##### apiRoot
87
+
88
+ `string`
89
+
90
+ The base URL for the API.
91
+
92
+ #### Returns
93
+
94
+ `void`