@isdk/ai-tool 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (467) hide show
  1. package/README.cn.md +103 -237
  2. package/README.md +101 -186
  3. package/dist/chunk-LNTIQQNN.mjs +1 -0
  4. package/dist/chunk-VIG2GB47.mjs +1 -1
  5. package/dist/funcs.d.mts +1 -1
  6. package/dist/funcs.d.ts +1 -1
  7. package/dist/funcs.js +1 -1
  8. package/dist/funcs.mjs +1 -1
  9. package/dist/index-BCco-g_I.d.mts +1781 -0
  10. package/dist/index-BCco-g_I.d.ts +1781 -0
  11. package/dist/index.d.mts +1068 -9
  12. package/dist/index.d.ts +1068 -9
  13. package/dist/index.js +1 -1
  14. package/dist/index.mjs +1 -1
  15. package/dist/test/util.js +1 -1
  16. package/docs/api/README.md +165 -0
  17. package/docs/{_media → api/_media}/CONTRIBUTING.md +3 -3
  18. package/docs/api/_media/pubsub.md +326 -0
  19. package/docs/api/_media/server_client_tools.md +88 -0
  20. package/docs/api/_media/toolFunc.md +183 -0
  21. package/docs/api/_media/transport.md +137 -0
  22. package/docs/{classes → api/classes}/AbortError.md +139 -54
  23. package/docs/api/classes/AlreadyExistsError.md +431 -0
  24. package/docs/api/classes/BaseError.md +440 -0
  25. package/docs/{classes → api/classes}/BinarySemaphore.md +25 -25
  26. package/docs/{classes → api/classes}/CancelableAbility.md +25 -25
  27. package/docs/api/classes/ClientToolTransport.md +310 -0
  28. package/docs/{classes → api/classes}/ClientTools.md +642 -180
  29. package/docs/{classes → api/classes}/CommonError.md +139 -54
  30. package/docs/{classes → api/classes}/ConfigFile.md +54 -5
  31. package/docs/{classes → api/classes}/EnvPromptTemplate.md +94 -48
  32. package/docs/{classes → api/classes}/EventClient.md +725 -232
  33. package/docs/{classes → api/classes}/EventEmitter.md +12 -12
  34. package/docs/{classes → api/classes}/EventServer.md +658 -205
  35. package/docs/{classes → api/classes}/EventToolFunc.md +561 -109
  36. package/docs/{classes → api/classes}/FStringPromptTemplate.md +94 -48
  37. package/docs/{classes → api/classes}/FewShotPromptTemplate.md +100 -52
  38. package/docs/{classes → api/classes}/GolangPromptTemplate.md +99 -53
  39. package/docs/api/classes/HttpClientToolTransport.md +324 -0
  40. package/docs/api/classes/HttpServerToolTransport.md +324 -0
  41. package/docs/{classes → api/classes}/IntSet.md +12 -12
  42. package/docs/{classes → api/classes}/LRUCache.md +26 -26
  43. package/docs/api/classes/NotFoundError.md +431 -0
  44. package/docs/api/classes/NotImplementationError.md +431 -0
  45. package/docs/{classes → api/classes}/PromptExampleSelector.md +9 -9
  46. package/docs/{classes → api/classes}/PromptTemplate.md +91 -47
  47. package/docs/api/classes/ReadableStreamError.md +451 -0
  48. package/docs/api/classes/ResClientTools.md +2878 -0
  49. package/docs/api/classes/ResServerTools.md +2856 -0
  50. package/docs/api/classes/SSEChannel.md +272 -0
  51. package/docs/{classes → api/classes}/Semaphore.md +26 -26
  52. package/docs/api/classes/ServerToolTransport.md +323 -0
  53. package/docs/{classes → api/classes}/ServerTools.md +579 -120
  54. package/docs/{classes → api/classes}/SignalGate.md +9 -9
  55. package/docs/api/classes/SseClientPubSubTransport.md +92 -0
  56. package/docs/api/classes/SseServerPubSubTransport.md +234 -0
  57. package/docs/{classes → api/classes}/TaskAbortController.md +9 -9
  58. package/docs/api/classes/ToolFunc.md +2665 -0
  59. package/docs/api/classes/ToolTransport.md +143 -0
  60. package/docs/api/classes/YamlTypeBaseObject.md +31 -0
  61. package/docs/api/enumerations/AsyncFeatureBits.md +33 -0
  62. package/docs/api/enumerations/AsyncFeatures.md +33 -0
  63. package/docs/api/enumerations/ErrorCode.md +177 -0
  64. package/docs/api/enumerations/HashAlgorithm.md +97 -0
  65. package/docs/{functions → api/functions}/AIArgProcessor.md +1 -1
  66. package/docs/{functions → api/functions}/AIStream.md +1 -1
  67. package/docs/{functions → api/functions}/ChoiceArgProcessor.md +1 -1
  68. package/docs/api/functions/DefaultDateFormat.md +21 -0
  69. package/docs/{functions → api/functions}/ObjectArgsToArgsInfo.md +1 -1
  70. package/docs/{functions → api/functions}/RateLimit.md +1 -1
  71. package/docs/{functions → api/functions}/TemplateArgProcessor.md +1 -1
  72. package/docs/api/functions/addDate.md +71 -0
  73. package/docs/{functions → api/functions}/assignDirs.md +1 -1
  74. package/docs/{functions → api/functions}/backendEventable.md +1 -1
  75. package/docs/{functions → api/functions}/beforeShutdown.md +1 -1
  76. package/docs/api/functions/calcPerplexity.md +60 -0
  77. package/docs/api/functions/calcPerplexitySimple.md +42 -0
  78. package/docs/api/functions/canonicalize.md +33 -0
  79. package/docs/{functions → api/functions}/completeSentences.md +1 -1
  80. package/docs/{functions → api/functions}/concatText.md +1 -1
  81. package/docs/{functions → api/functions}/countLLMTokens.md +1 -1
  82. package/docs/{functions → api/functions}/countRegexMatches.md +1 -1
  83. package/docs/{functions → api/functions}/createAbilityInjector.md +4 -4
  84. package/docs/{functions → api/functions}/createCallbacksTransformer.md +1 -1
  85. package/docs/{functions → api/functions}/createEmptyReadableStream.md +1 -1
  86. package/docs/{functions → api/functions}/createEndWithRepetitionDetector.md +1 -1
  87. package/docs/{functions → api/functions}/createError.md +1 -1
  88. package/docs/{functions → api/functions}/createEventStreamTransformer.md +1 -1
  89. package/docs/{functions → api/functions}/createHfValueFunc.md +1 -1
  90. package/docs/{functions → api/functions}/createLRUCache.md +1 -1
  91. package/docs/{functions → api/functions}/createYamlObjectTag.md +1 -1
  92. package/docs/{functions → api/functions}/dateToText.md +1 -1
  93. package/docs/{functions → api/functions}/decodeCharset.md +1 -1
  94. package/docs/api/functions/defaultsWithConcat.md +74 -0
  95. package/docs/{functions → api/functions}/detectCharset.md +1 -1
  96. package/docs/{functions → api/functions}/encodeLLMTokens.md +1 -1
  97. package/docs/{functions → api/functions}/ensureQuoted.md +1 -1
  98. package/docs/{functions → api/functions}/eventable.md +1 -1
  99. package/docs/{functions → api/functions}/expandConfig.md +1 -1
  100. package/docs/{functions → api/functions}/expandEnv.md +1 -1
  101. package/docs/{functions → api/functions}/expandObjEnv.md +1 -1
  102. package/docs/{functions → api/functions}/expandPath.md +1 -1
  103. package/docs/api/functions/expandPathInObject.md +29 -0
  104. package/docs/api/functions/expandPaths.md +25 -0
  105. package/docs/{functions → api/functions}/extNameLevel.md +1 -1
  106. package/docs/{functions → api/functions}/fileIsExists.md +1 -1
  107. package/docs/{functions → api/functions}/filterValidFnScope.md +1 -1
  108. package/docs/{functions → api/functions}/findIndexNonEmptyFrom.md +1 -1
  109. package/docs/{functions → api/functions}/findPort.md +1 -1
  110. package/docs/{functions → api/functions}/formatISO.md +1 -1
  111. package/docs/{functions → api/functions}/formatTextWithSpace.md +1 -1
  112. package/docs/api/functions/funcGetMeta.md +27 -0
  113. package/docs/api/functions/funcWithMeta.md +41 -0
  114. package/docs/api/functions/genUrlParamsStr.md +27 -0
  115. package/docs/{functions → api/functions}/getAllEnumKeys.md +1 -1
  116. package/docs/{functions → api/functions}/getConfigFileNames.md +1 -1
  117. package/docs/{functions → api/functions}/getConfigs.md +1 -1
  118. package/docs/{functions → api/functions}/getEnvVairables.md +1 -1
  119. package/docs/{functions → api/functions}/getFileMetaInfo.md +1 -1
  120. package/docs/{functions → api/functions}/getHashAlgoBySize.md +1 -1
  121. package/docs/{functions → api/functions}/getKeysPath.md +1 -1
  122. package/docs/{functions → api/functions}/getLLMTokenizer.md +1 -1
  123. package/docs/{functions → api/functions}/getMultiLevelExtname.md +1 -1
  124. package/docs/{functions → api/functions}/getPackageDir.md +1 -1
  125. package/docs/{functions → api/functions}/getRealFilepath.md +1 -1
  126. package/docs/{functions → api/functions}/getResponseErrorReadableStream.md +1 -1
  127. package/docs/{functions → api/functions}/getXDGConfigs.md +1 -1
  128. package/docs/{functions → api/functions}/hasDirectoryIn.md +1 -1
  129. package/docs/{functions → api/functions}/hash.md +1 -1
  130. package/docs/{functions → api/functions}/hashFile.md +1 -1
  131. package/docs/api/functions/hashObject.md +25 -0
  132. package/docs/{functions → api/functions}/hashStream.md +1 -1
  133. package/docs/api/functions/initShutdown.md +15 -0
  134. package/docs/{functions → api/functions}/isLangUsingSpaces.md +1 -1
  135. package/docs/{functions → api/functions}/isListItemString.md +1 -1
  136. package/docs/{functions → api/functions}/isModelNameMatched.md +1 -1
  137. package/docs/{functions → api/functions}/isPunctuationChar.md +1 -1
  138. package/docs/{functions → api/functions}/isQuoted.md +1 -1
  139. package/docs/{functions → api/functions}/isRegExp.md +1 -1
  140. package/docs/{functions → api/functions}/isSameString.md +1 -1
  141. package/docs/{functions → api/functions}/isSectionString.md +1 -1
  142. package/docs/{functions → api/functions}/isSentenceEnding.md +1 -1
  143. package/docs/{functions → api/functions}/isSepLineString.md +1 -1
  144. package/docs/{functions → api/functions}/isStrWrapped.md +1 -1
  145. package/docs/{functions → api/functions}/isSubdirectory.md +2 -2
  146. package/docs/{functions → api/functions}/isTitleString.md +1 -1
  147. package/docs/{functions → api/functions}/isValidFilename.md +1 -1
  148. package/docs/{functions → api/functions}/isValidFilepath.md +1 -1
  149. package/docs/{functions → api/functions}/isWebStream.md +1 -1
  150. package/docs/api/functions/joinSplitWords.md +46 -0
  151. package/docs/{functions → api/functions}/jsonFilterToWhere.md +1 -1
  152. package/docs/{functions → api/functions}/jsonToMarkdownStr.md +9 -1
  153. package/docs/{functions → api/functions}/loadAIConfig.md +1 -1
  154. package/docs/{functions → api/functions}/loadConfig.md +1 -1
  155. package/docs/{functions → api/functions}/loadConfigFile.md +1 -1
  156. package/docs/{functions → api/functions}/loadFileFromPaths.md +1 -1
  157. package/docs/{functions → api/functions}/loadTextFromPaths.md +1 -1
  158. package/docs/{functions → api/functions}/lrucache.md +1 -1
  159. package/docs/{functions → api/functions}/makeToolFuncCancelable.md +1 -1
  160. package/docs/{functions → api/functions}/matchUrlProtocol.md +1 -1
  161. package/docs/{functions → api/functions}/memoize.md +1 -1
  162. package/docs/api/functions/mergeArray.md +57 -0
  163. package/docs/{functions → api/functions}/messagesToText.md +1 -1
  164. package/docs/api/functions/normalizePath.md +21 -0
  165. package/docs/{functions → api/functions}/paramsSizeToScaleStr.md +1 -1
  166. package/docs/{functions → api/functions}/parseCommand.md +1 -1
  167. package/docs/{functions → api/functions}/parseDateFormat.md +1 -1
  168. package/docs/{functions → api/functions}/parseISO.md +1 -1
  169. package/docs/{functions → api/functions}/parseJsJson.md +1 -1
  170. package/docs/{functions → api/functions}/parseJsJsonSimpleSync.md +1 -1
  171. package/docs/{functions → api/functions}/parseObjectArgInfo.md +1 -1
  172. package/docs/{functions → api/functions}/parseObjectArgumentInfos.md +1 -1
  173. package/docs/{functions → api/functions}/parseObjectArguments.md +1 -1
  174. package/docs/{functions → api/functions}/parseObjectArgumentsAsArgInfos.md +1 -1
  175. package/docs/{functions → api/functions}/parseYaml.md +1 -1
  176. package/docs/api/functions/pruneSubdirectories.md +35 -0
  177. package/docs/api/functions/pruneSubdirectoriesInPlace.md +38 -0
  178. package/docs/{functions → api/functions}/quoteStr.md +1 -1
  179. package/docs/{functions → api/functions}/readFilenamesRecursiveSync.md +1 -1
  180. package/docs/{functions → api/functions}/readTextFileChunks.md +1 -1
  181. package/docs/{functions → api/functions}/readTextFileChunksEx.md +1 -1
  182. package/docs/{functions → api/functions}/readableFromAsyncIterable.md +1 -1
  183. package/docs/{functions → api/functions}/registerCoreTools.md +1 -1
  184. package/docs/{functions → api/functions}/registerYamlTag.md +1 -1
  185. package/docs/{functions → api/functions}/removeMarkdownBold.md +1 -1
  186. package/docs/{functions → api/functions}/removeMarkdownBoldAndItalic.md +1 -1
  187. package/docs/{functions → api/functions}/removeMarkdownItalic.md +1 -1
  188. package/docs/{functions → api/functions}/replaceWithPlaceholder.md +1 -1
  189. package/docs/{functions → api/functions}/restoreFromPlacehoders.md +1 -1
  190. package/docs/{functions → api/functions}/sanitizeFilename.md +1 -1
  191. package/docs/{functions → api/functions}/sanitizeFilepath.md +1 -1
  192. package/docs/{functions → api/functions}/saveConfigFile.md +1 -1
  193. package/docs/{functions → api/functions}/scaleStrToParamsSize.md +1 -1
  194. package/docs/{functions → api/functions}/shutdown.md +1 -1
  195. package/docs/{functions → api/functions}/simplifyObjectArguments.md +1 -1
  196. package/docs/api/functions/sleep.md +36 -0
  197. package/docs/{functions → api/functions}/sortedValues.md +1 -1
  198. package/docs/{functions → api/functions}/splitChunks.md +1 -1
  199. package/docs/{functions → api/functions}/splitParagraph.md +1 -1
  200. package/docs/{functions → api/functions}/splitSentence.md +1 -1
  201. package/docs/api/functions/splitWords.md +42 -0
  202. package/docs/{functions → api/functions}/stringifyYaml.md +1 -1
  203. package/docs/{functions → api/functions}/stripConsoleColor.md +1 -1
  204. package/docs/{functions → api/functions}/textToDate.md +1 -1
  205. package/docs/{functions → api/functions}/throwError.md +3 -3
  206. package/docs/{functions → api/functions}/toDate.md +1 -1
  207. package/docs/{functions → api/functions}/toDateTime.md +1 -1
  208. package/docs/{functions → api/functions}/toRegExp.md +1 -1
  209. package/docs/{functions → api/functions}/trimStartOfStreamHelper.md +1 -1
  210. package/docs/{functions → api/functions}/truncTo.md +1 -1
  211. package/docs/{functions → api/functions}/truncateByToken.md +1 -1
  212. package/docs/{functions → api/functions}/truncateToTokenLimit.md +1 -1
  213. package/docs/{functions → api/functions}/truncateToTokenLimitEx.md +1 -1
  214. package/docs/{functions → api/functions}/uuid.md +1 -1
  215. package/docs/{functions → api/functions}/uuidParse.md +1 -1
  216. package/docs/{functions → api/functions}/uuidStringify.md +1 -1
  217. package/docs/{functions → api/functions}/uuidValidate.md +1 -1
  218. package/docs/{functions → api/functions}/uuidVersion.md +1 -1
  219. package/docs/{functions → api/functions}/uuidv1.md +9 -5
  220. package/docs/{functions → api/functions}/uuidv4.md +9 -5
  221. package/docs/{functions → api/functions}/uuidv5.md +9 -5
  222. package/docs/api/functions/wait.md +45 -0
  223. package/docs/{functions → api/functions}/wrapEventEmitter.md +1 -1
  224. package/docs/{functions → api/functions}/xxhash.md +1 -1
  225. package/docs/{functions → api/functions}/xxhash32.md +1 -1
  226. package/docs/{functions → api/functions}/xxhash64.md +1 -1
  227. package/docs/{functions → api/functions}/xxhashAsStr.md +1 -1
  228. package/docs/api/functions/yieldExec.md +27 -0
  229. package/docs/{globals.md → api/globals.md} +44 -1
  230. package/docs/api/interfaces/AIChatAssistantMessageParam.md +129 -0
  231. package/docs/api/interfaces/AIChatContentPartImage.md +29 -0
  232. package/docs/api/interfaces/AIChatContentPartText.md +25 -0
  233. package/docs/api/interfaces/AIChatMessageParamBase.md +68 -0
  234. package/docs/api/interfaces/AIChatMessageToolCall.md +41 -0
  235. package/docs/{interfaces → api/interfaces}/AIChatSystemMessageParam.md +9 -9
  236. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  237. package/docs/api/interfaces/AIChatToolChoiceObject.md +25 -0
  238. package/docs/api/interfaces/AIChatToolFunc.md +41 -0
  239. package/docs/api/interfaces/AIChatToolFuncParam.md +37 -0
  240. package/docs/api/interfaces/AIChatToolMessageParam.md +113 -0
  241. package/docs/api/interfaces/AIChatToolParam.md +25 -0
  242. package/docs/api/interfaces/AIChatToolTypeObject.md +17 -0
  243. package/docs/api/interfaces/AIChatUserMessageParam.md +137 -0
  244. package/docs/api/interfaces/AIChoiceConfig.md +65 -0
  245. package/docs/api/interfaces/AIResult.md +65 -0
  246. package/docs/{interfaces → api/interfaces}/AIStreamParser.md +2 -2
  247. package/docs/api/interfaces/AIStreamParserOptions.md +21 -0
  248. package/docs/api/interfaces/BaseFunc.md +299 -0
  249. package/docs/api/interfaces/BaseFuncItem.md +221 -0
  250. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  251. package/docs/api/interfaces/BinarySemaphoreOptions.md +57 -0
  252. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  253. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  254. package/docs/api/interfaces/CancelableAbilityOptions.md +113 -0
  255. package/docs/api/interfaces/ClientFuncItem.md +326 -0
  256. package/docs/api/interfaces/EventClientFuncParams.md +51 -0
  257. package/docs/api/interfaces/EventServerFuncParams.md +73 -0
  258. package/docs/{interfaces → api/interfaces}/FewShotPromptTemplateOptions.md +24 -12
  259. package/docs/api/interfaces/FuncItem.md +281 -0
  260. package/docs/api/interfaces/FuncParam.md +51 -0
  261. package/docs/api/interfaces/FuncParams.md +28 -0
  262. package/docs/api/interfaces/Funcs.md +15 -0
  263. package/docs/api/interfaces/HashAlgoParams.md +33 -0
  264. package/docs/api/interfaces/IClientToolTransport.md +155 -0
  265. package/docs/api/interfaces/IFileMetaInfo.md +65 -0
  266. package/docs/api/interfaces/IPubSubClientTransport.md +70 -0
  267. package/docs/api/interfaces/IPubSubServerTransport.md +241 -0
  268. package/docs/api/interfaces/IReadTextFileChunksOptions.md +143 -0
  269. package/docs/api/interfaces/IServerToolTransport.md +159 -0
  270. package/docs/api/interfaces/IToolTransport.md +73 -0
  271. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +99 -0
  272. package/docs/api/interfaces/JsonFilter.md +13 -0
  273. package/docs/api/interfaces/ParseObjectArgumentOptions.md +89 -0
  274. package/docs/api/interfaces/ProbabilityItem.md +41 -0
  275. package/docs/api/interfaces/PromptExampleSelectorOptions.md +34 -0
  276. package/docs/{interfaces → api/interfaces}/PromptTemplateOptions.md +15 -7
  277. package/docs/api/interfaces/PubSubClient.md +27 -0
  278. package/docs/api/interfaces/PubSubClientStream.md +196 -0
  279. package/docs/api/interfaces/PubSubServerSession.md +103 -0
  280. package/docs/api/interfaces/RemoteFuncItem.md +316 -0
  281. package/docs/api/interfaces/ReplacePlacehoderOptions.md +41 -0
  282. package/docs/api/interfaces/ResClientFuncParams.md +37 -0
  283. package/docs/api/interfaces/ResServerFuncParams.md +73 -0
  284. package/docs/api/interfaces/SanitizeFilenameOptions.md +25 -0
  285. package/docs/api/interfaces/SectionStringOptions.md +25 -0
  286. package/docs/api/interfaces/SemaphoreOptions.md +89 -0
  287. package/docs/api/interfaces/SemaphoreTaskItem.md +73 -0
  288. package/docs/api/interfaces/ServerFuncItem.md +339 -0
  289. package/docs/api/interfaces/ServerFuncParams.md +41 -0
  290. package/docs/api/interfaces/SplitSentenceOptions.md +41 -0
  291. package/docs/{interfaces → api/interfaces}/StreamCallbacksAndOptions.md +5 -5
  292. package/docs/{interfaces → api/interfaces}/TaskAbortControllers.md +1 -1
  293. package/docs/{interfaces → api/interfaces}/TaskPromise.md +6 -6
  294. package/docs/api/interfaces/ToolFuncPackage.md +57 -0
  295. package/docs/{namespaces → api/namespaces}/EventStates/variables/ABORT.md +1 -1
  296. package/docs/{namespaces → api/namespaces}/EventStates/variables/CONTINUE.md +1 -1
  297. package/docs/{namespaces → api/namespaces}/EventStates/variables/DONE.md +1 -1
  298. package/docs/{namespaces → api/namespaces}/EventStates/variables/STOPPED.md +1 -1
  299. package/docs/{namespaces → api/namespaces}/uuidv5/variables/DNS.md +1 -1
  300. package/docs/{namespaces → api/namespaces}/uuidv5/variables/URL.md +1 -1
  301. package/docs/{type-aliases → api/type-aliases}/AIChatContentPart.md +1 -1
  302. package/docs/{type-aliases → api/type-aliases}/AIChatMessageParam.md +1 -1
  303. package/docs/{type-aliases → api/type-aliases}/AIChatRole.md +1 -1
  304. package/docs/{type-aliases → api/type-aliases}/AIChatToolChoiceParam.md +1 -1
  305. package/docs/{type-aliases → api/type-aliases}/AIMessageType.md +1 -1
  306. package/docs/api/type-aliases/AIModelNameRule.md +14 -0
  307. package/docs/api/type-aliases/AIModelNameRuleFn.md +28 -0
  308. package/docs/api/type-aliases/AIModelNameRules.md +13 -0
  309. package/docs/{type-aliases → api/type-aliases}/AITextGenerationFinishReason.md +1 -1
  310. package/docs/api/type-aliases/ActionName.md +13 -0
  311. package/docs/api/type-aliases/ArrayMergeWay.md +11 -0
  312. package/docs/api/type-aliases/AsyncTaskId.md +11 -0
  313. package/docs/{type-aliases → api/type-aliases}/BeforeShutdownListener.md +1 -1
  314. package/docs/{type-aliases → api/type-aliases}/EventErrorListenerFn.md +1 -1
  315. package/docs/{type-aliases → api/type-aliases}/EventListenerFn.md +1 -1
  316. package/docs/api/type-aliases/FuncParamType.md +13 -0
  317. package/docs/{type-aliases → api/type-aliases}/PromptExamples.md +1 -1
  318. package/docs/api/type-aliases/PubSubClientId.md +14 -0
  319. package/docs/api/type-aliases/PubSubCtx.md +37 -0
  320. package/docs/api/type-aliases/RpcMethodHandler.md +34 -0
  321. package/docs/{type-aliases → api/type-aliases}/SemaphoreIsReadyFuncType.md +1 -1
  322. package/docs/api/type-aliases/TFunc.md +33 -0
  323. package/docs/{variables → api/variables}/AIChatRoles.md +1 -1
  324. package/docs/{variables → api/variables}/AIMessageTypes.md +1 -1
  325. package/docs/{variables → api/variables}/AITextGenerationFinishReasons.md +1 -1
  326. package/docs/{variables → api/variables}/AbortErrorCode.md +1 -1
  327. package/docs/api/variables/ActionNames.md +13 -0
  328. package/docs/{variables → api/variables}/AlreadyExistsErrorCode.md +1 -1
  329. package/docs/api/variables/ArrayMergeWay.md +25 -0
  330. package/docs/api/variables/ArrayMergeWaySymbol.md +11 -0
  331. package/docs/api/variables/ClientToolFuncSchema.md +83 -0
  332. package/docs/{variables → api/variables}/DEFAULT_CONFIG_NAME.md +1 -1
  333. package/docs/{variables → api/variables}/DefaultAsyncSemaphoreCapacity.md +1 -1
  334. package/docs/api/variables/EventBusName.md +11 -0
  335. package/docs/api/variables/EventName.md +11 -0
  336. package/docs/{variables → api/variables}/FilenameReservedRegex.md +1 -1
  337. package/docs/api/variables/FuncMetaSymbol.md +15 -0
  338. package/docs/{variables → api/variables}/InternalErrorCode.md +1 -1
  339. package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES.md +1 -1
  340. package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  341. package/docs/{variables → api/variables}/NotFoundErrorCode.md +1 -1
  342. package/docs/{variables → api/variables}/NotImplementedErrorCode.md +1 -1
  343. package/docs/api/variables/PASSING_SCORE.md +13 -0
  344. package/docs/api/variables/RStreamErrCode.md +11 -0
  345. package/docs/api/variables/RemoteToolFuncSchema.md +84 -0
  346. package/docs/api/variables/ResponseRStreamErrCode.md +11 -0
  347. package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md +1 -1
  348. package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md +1 -1
  349. package/docs/api/variables/SecondaryCache.md +11 -0
  350. package/docs/api/variables/ServerToolFuncSchema.md +83 -0
  351. package/docs/api/variables/StrangeHumanName.md +11 -0
  352. package/docs/api/variables/ToolAsyncCancelableBit.md +11 -0
  353. package/docs/api/variables/ToolAsyncMultiTaskBit.md +11 -0
  354. package/docs/api/variables/ToolAsyncPriorityBit.md +11 -0
  355. package/docs/{variables → api/variables}/ToolFuncSchema.md +14 -1
  356. package/docs/{variables → api/variables}/WindowsReservedNameRegex.md +1 -1
  357. package/docs/api/variables/base32768.md +11 -0
  358. package/docs/{variables → api/variables}/defaultTemplateFormat.md +1 -1
  359. package/docs/api/variables/event.md +11 -0
  360. package/docs/api/variables/eventClient.md +11 -0
  361. package/docs/api/variables/eventServer.md +11 -0
  362. package/docs/api/variables/lrucache.md +11 -0
  363. package/docs/{variables → api/variables}/mimeType.md +1 -1
  364. package/docs/{variables → api/variables}/uuidNIL.md +1 -1
  365. package/docs/pubsub.md +326 -0
  366. package/docs/server_client_tools.md +88 -0
  367. package/docs/toolFunc.md +183 -0
  368. package/docs/transport.md +137 -0
  369. package/package.json +38 -40
  370. package/dist/chunk-OYDBRUZJ.mjs +0 -1
  371. package/dist/index-BkwhCK1q.d.mts +0 -899
  372. package/dist/index-BkwhCK1q.d.ts +0 -899
  373. package/docs/README.md +0 -250
  374. package/docs/classes/AlreadyExistsError.md +0 -346
  375. package/docs/classes/BaseError.md +0 -359
  376. package/docs/classes/NotFoundError.md +0 -346
  377. package/docs/classes/NotImplementationError.md +0 -346
  378. package/docs/classes/ReadableStreamError.md +0 -366
  379. package/docs/classes/ResClientTools.md +0 -2451
  380. package/docs/classes/ResServerTools.md +0 -2427
  381. package/docs/classes/SSEChannel.md +0 -270
  382. package/docs/classes/ToolFunc.md +0 -2201
  383. package/docs/classes/YamlTypeBaseObject.md +0 -31
  384. package/docs/enumerations/AsyncFeatureBits.md +0 -33
  385. package/docs/enumerations/AsyncFeatures.md +0 -33
  386. package/docs/enumerations/ErrorCode.md +0 -177
  387. package/docs/enumerations/HashAlgorithm.md +0 -97
  388. package/docs/functions/canonicalize.md +0 -21
  389. package/docs/functions/initShutdown.md +0 -15
  390. package/docs/functions/wait.md +0 -21
  391. package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
  392. package/docs/interfaces/AIChatContentPartImage.md +0 -29
  393. package/docs/interfaces/AIChatContentPartText.md +0 -25
  394. package/docs/interfaces/AIChatMessageParamBase.md +0 -68
  395. package/docs/interfaces/AIChatMessageToolCall.md +0 -41
  396. package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
  397. package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
  398. package/docs/interfaces/AIChatToolFunc.md +0 -41
  399. package/docs/interfaces/AIChatToolFuncParam.md +0 -37
  400. package/docs/interfaces/AIChatToolMessageParam.md +0 -113
  401. package/docs/interfaces/AIChatToolParam.md +0 -25
  402. package/docs/interfaces/AIChatToolTypeObject.md +0 -17
  403. package/docs/interfaces/AIChatUserMessageParam.md +0 -137
  404. package/docs/interfaces/AIChoiceConfig.md +0 -65
  405. package/docs/interfaces/AIResult.md +0 -65
  406. package/docs/interfaces/AIStreamParserOptions.md +0 -21
  407. package/docs/interfaces/BaseFunc.md +0 -157
  408. package/docs/interfaces/BaseFuncItem.md +0 -101
  409. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
  410. package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
  411. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
  412. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
  413. package/docs/interfaces/CancelableAbilityOptions.md +0 -113
  414. package/docs/interfaces/ClientFuncItem.md +0 -175
  415. package/docs/interfaces/EventClientFuncParams.md +0 -51
  416. package/docs/interfaces/EventServerFuncParams.md +0 -67
  417. package/docs/interfaces/FuncItem.md +0 -143
  418. package/docs/interfaces/FuncParam.md +0 -61
  419. package/docs/interfaces/FuncParams.md +0 -13
  420. package/docs/interfaces/Funcs.md +0 -13
  421. package/docs/interfaces/HashAlgoParams.md +0 -33
  422. package/docs/interfaces/IFileMetaInfo.md +0 -65
  423. package/docs/interfaces/IReadTextFileChunksOptions.md +0 -143
  424. package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
  425. package/docs/interfaces/JsonFilter.md +0 -13
  426. package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
  427. package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
  428. package/docs/interfaces/RemoteFuncItem.md +0 -164
  429. package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
  430. package/docs/interfaces/ResClientFuncParams.md +0 -37
  431. package/docs/interfaces/ResServerFuncParams.md +0 -69
  432. package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
  433. package/docs/interfaces/SectionStringOptions.md +0 -25
  434. package/docs/interfaces/SemaphoreOptions.md +0 -89
  435. package/docs/interfaces/SemaphoreTaskItem.md +0 -73
  436. package/docs/interfaces/ServerFuncItem.md +0 -183
  437. package/docs/interfaces/ServerFuncParams.md +0 -35
  438. package/docs/interfaces/SplitSentenceOptions.md +0 -41
  439. package/docs/interfaces/ToolFuncPackage.md +0 -47
  440. package/docs/type-aliases/AIModelNameRule.md +0 -11
  441. package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
  442. package/docs/type-aliases/AIModelNameRules.md +0 -11
  443. package/docs/type-aliases/ActionName.md +0 -11
  444. package/docs/type-aliases/AsyncTaskId.md +0 -11
  445. package/docs/type-aliases/FuncParamType.md +0 -11
  446. package/docs/type-aliases/TFunc.md +0 -25
  447. package/docs/variables/ActionNames.md +0 -11
  448. package/docs/variables/ClientToolFuncSchema.md +0 -101
  449. package/docs/variables/EventBusName.md +0 -11
  450. package/docs/variables/EventName.md +0 -11
  451. package/docs/variables/PASSING_SCORE.md +0 -11
  452. package/docs/variables/RStreamErrCode.md +0 -11
  453. package/docs/variables/RemoteToolFuncSchema.md +0 -101
  454. package/docs/variables/ResponseRStreamErrCode.md +0 -11
  455. package/docs/variables/SecondaryCache.md +0 -11
  456. package/docs/variables/ServerToolFuncSchema.md +0 -101
  457. package/docs/variables/ToolAsyncCancelableBit.md +0 -11
  458. package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
  459. package/docs/variables/ToolAsyncPriorityBit.md +0 -11
  460. package/docs/variables/base32768.md +0 -11
  461. package/docs/variables/event.md +0 -11
  462. package/docs/variables/eventClient.md +0 -11
  463. package/docs/variables/eventServer.md +0 -11
  464. package/docs/variables/lrucache.md +0 -11
  465. /package/docs/{_media → api/_media}/LICENSE-MIT +0 -0
  466. /package/docs/{namespaces → api/namespaces}/EventStates/README.md +0 -0
  467. /package/docs/{namespaces → api/namespaces}/uuidv5/README.md +0 -0
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: CancelableAbility
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L74)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L74)
10
10
 
11
11
  ## Indexable
12
12
 
@@ -28,7 +28,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github
28
28
 
29
29
  > **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
30
30
 
31
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:86](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L86)
31
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L86)
32
32
 
33
33
  ***
34
34
 
@@ -36,7 +36,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:86](https://github
36
36
 
37
37
  > **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
38
38
 
39
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L87)
39
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L87)
40
40
 
41
41
  ***
42
42
 
@@ -44,7 +44,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github
44
44
 
45
45
  > `optional` **\_asyncFeatures**: `number`
46
46
 
47
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L75)
47
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L75)
48
48
 
49
49
  ***
50
50
 
@@ -52,7 +52,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github
52
52
 
53
53
  > `optional` **\_isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
54
54
 
55
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L77)
55
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L77)
56
56
 
57
57
  ***
58
58
 
@@ -60,7 +60,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github
60
60
 
61
61
  > **\_maxTaskConcurrency**: `undefined` \| `number`
62
62
 
63
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L76)
63
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L76)
64
64
 
65
65
  ***
66
66
 
@@ -68,7 +68,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github
68
68
 
69
69
  > **cleanMultiTaskAborter**: (`id`, `aborters`) => `void`
70
70
 
71
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L84)
71
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L84)
72
72
 
73
73
  #### Parameters
74
74
 
@@ -90,7 +90,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github
90
90
 
91
91
  > **generateAsyncTaskId**: (`taskId`?, `aborters`?) => [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
92
92
 
93
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L83)
93
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L83)
94
94
 
95
95
  #### Parameters
96
96
 
@@ -114,7 +114,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github
114
114
 
115
115
  > **get** **maxTaskConcurrency**(): `undefined` \| `number`
116
116
 
117
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L89)
117
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L89)
118
118
 
119
119
  ##### Returns
120
120
 
@@ -128,7 +128,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github
128
128
 
129
129
  > **get** **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
130
130
 
131
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L93)
131
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L93)
132
132
 
133
133
  ##### Returns
134
134
 
@@ -140,7 +140,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github
140
140
 
141
141
  > **\_cleanMultiTaskAborter**(`id`, `aborters`): `void`
142
142
 
143
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:273](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L273)
143
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:281](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L281)
144
144
 
145
145
  #### Parameters
146
146
 
@@ -162,7 +162,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:273](https://githu
162
162
 
163
163
  > **\_generateAsyncTaskId**(`taskId`?, `aborters`?): [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
164
164
 
165
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:173](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L173)
165
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:173](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L173)
166
166
 
167
167
  #### Parameters
168
168
 
@@ -184,7 +184,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:173](https://githu
184
184
 
185
185
  > **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
186
186
 
187
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:253](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L253)
187
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:261](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L261)
188
188
 
189
189
  #### Parameters
190
190
 
@@ -206,7 +206,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:253](https://githu
206
206
 
207
207
  > **$generateAsyncTaskId**(`taskId`?, `aborters`?): `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
208
208
 
209
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:186](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L186)
209
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:186](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L186)
210
210
 
211
211
  #### Parameters
212
212
 
@@ -228,7 +228,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:186](https://githu
228
228
 
229
229
  > **abort**(`reason`?, `data`?): `void`
230
230
 
231
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:330](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L330)
231
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:338](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L338)
232
232
 
233
233
  #### Parameters
234
234
 
@@ -250,7 +250,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:330](https://githu
250
250
 
251
251
  > **cleanTaskAborter**(`aborter`): `void`
252
252
 
253
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:263](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L263)
253
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:271](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L271)
254
254
 
255
255
  #### Parameters
256
256
 
@@ -268,7 +268,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:263](https://githu
268
268
 
269
269
  > **createAborter**(`params`?, `taskId`?, `raiseError`?): [`TaskAbortController`](TaskAbortController.md)
270
270
 
271
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:197](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L197)
271
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:197](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L197)
272
272
 
273
273
  #### Parameters
274
274
 
@@ -294,7 +294,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:197](https://githu
294
294
 
295
295
  > **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
296
296
 
297
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:277](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L277)
297
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:285](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L285)
298
298
 
299
299
  #### Type Parameters
300
300
 
@@ -330,7 +330,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:277](https://githu
330
330
 
331
331
  > **getRunningTask**(`taskId`?): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
332
332
 
333
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:135](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L135)
333
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:135](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L135)
334
334
 
335
335
  #### Parameters
336
336
 
@@ -348,7 +348,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:135](https://githu
348
348
 
349
349
  > **getRunningTaskCount**(): `number`
350
350
 
351
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L158)
351
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L158)
352
352
 
353
353
  #### Returns
354
354
 
@@ -360,7 +360,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:158](https://githu
360
360
 
361
361
  > **getSemaphore**(`isReadyFn`): `undefined` \| [`Semaphore`](Semaphore.md)
362
362
 
363
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L97)
363
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L97)
364
364
 
365
365
  #### Parameters
366
366
 
@@ -378,7 +378,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github
378
378
 
379
379
  > **hasAsyncFeature**(`feature`): `boolean`
380
380
 
381
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:114](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L114)
381
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L114)
382
382
 
383
383
  #### Parameters
384
384
 
@@ -396,7 +396,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:114](https://githu
396
396
 
397
397
  > **isAborted**(`taskId`?): `boolean`
398
398
 
399
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:120](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L120)
399
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:120](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L120)
400
400
 
401
401
  #### Parameters
402
402
 
@@ -414,7 +414,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:120](https://githu
414
414
 
415
415
  > **runAsyncCancelableTask**\<`Output`\>(`params`, `runTask`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
416
416
 
417
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:315](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L315)
417
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:323](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L323)
418
418
 
419
419
  #### Type Parameters
420
420
 
@@ -454,7 +454,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:315](https://githu
454
454
 
455
455
  > `static` **hasAsyncFeature**(`feature`): `boolean`
456
456
 
457
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:107](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L107)
457
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:107](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L107)
458
458
 
459
459
  #### Parameters
460
460
 
@@ -0,0 +1,310 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ClientToolTransport
6
+
7
+ # Class: `abstract` ClientToolTransport
8
+
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:36](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L36)
10
+
11
+ A concrete client transport implementation that uses the browser/node `fetch` API.
12
+
13
+ ## Extends
14
+
15
+ - [`ToolTransport`](ToolTransport.md)
16
+
17
+ ## Extended by
18
+
19
+ - [`HttpClientToolTransport`](HttpClientToolTransport.md)
20
+
21
+ ## Implements
22
+
23
+ - [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
24
+
25
+ ## Constructors
26
+
27
+ ### new ClientToolTransport()
28
+
29
+ > **new ClientToolTransport**(`apiRoot`): [`ClientToolTransport`](ClientToolTransport.md)
30
+
31
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L41)
32
+
33
+ #### Parameters
34
+
35
+ ##### apiRoot
36
+
37
+ `string`
38
+
39
+ #### Returns
40
+
41
+ [`ClientToolTransport`](ClientToolTransport.md)
42
+
43
+ #### Overrides
44
+
45
+ [`ToolTransport`](ToolTransport.md).[`constructor`](ToolTransport.md#constructors)
46
+
47
+ ## Properties
48
+
49
+ ### apiRoot
50
+
51
+ > **apiRoot**: `string`
52
+
53
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:37](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L37)
54
+
55
+ The root endpoint for the remote service.
56
+ For HTTP, this is a URL. For IPC, it could be a channel name.
57
+
58
+ #### Implementation of
59
+
60
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md).[`apiRoot`](../interfaces/IClientToolTransport.md#apiroot)
61
+
62
+ #### Overrides
63
+
64
+ [`ToolTransport`](ToolTransport.md).[`apiRoot`](ToolTransport.md#apiroot)
65
+
66
+ ***
67
+
68
+ ### options?
69
+
70
+ > `optional` **options**: `any`
71
+
72
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:36](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L36)
73
+
74
+ Additional options for the transport start or fetch, passed by mount.
75
+
76
+ #### Implementation of
77
+
78
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md).[`options`](../interfaces/IClientToolTransport.md#options)
79
+
80
+ #### Inherited from
81
+
82
+ [`ToolTransport`](ToolTransport.md).[`options`](ToolTransport.md#options)
83
+
84
+ ***
85
+
86
+ ### Tools
87
+
88
+ > **Tools**: *typeof* [`ClientTools`](ClientTools.md)
89
+
90
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L38)
91
+
92
+ #### Implementation of
93
+
94
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md).[`Tools`](../interfaces/IClientToolTransport.md#tools)
95
+
96
+ #### Overrides
97
+
98
+ [`ToolTransport`](ToolTransport.md).[`Tools`](ToolTransport.md#tools)
99
+
100
+ ## Methods
101
+
102
+ ### \_fetch()
103
+
104
+ > `abstract` **\_fetch**(`name`, `args`?, `act`?, `subName`?, `fetchOptions`?): `any`
105
+
106
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:75](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L75)
107
+
108
+ #### Parameters
109
+
110
+ ##### name
111
+
112
+ `string`
113
+
114
+ ##### args?
115
+
116
+ `any`
117
+
118
+ ##### act?
119
+
120
+ `string`
121
+
122
+ ##### subName?
123
+
124
+ `any`
125
+
126
+ ##### fetchOptions?
127
+
128
+ `any`
129
+
130
+ #### Returns
131
+
132
+ `any`
133
+
134
+ ***
135
+
136
+ ### \_mount()
137
+
138
+ > **\_mount**(`clientTools`, `apiPrefix`, `options`?): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
139
+
140
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L49)
141
+
142
+ #### Parameters
143
+
144
+ ##### clientTools
145
+
146
+ *typeof* [`ClientTools`](ClientTools.md)
147
+
148
+ ##### apiPrefix
149
+
150
+ `string`
151
+
152
+ ##### options?
153
+
154
+ `any`
155
+
156
+ #### Returns
157
+
158
+ `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
159
+
160
+ #### Overrides
161
+
162
+ [`ToolTransport`](ToolTransport.md).[`_mount`](ToolTransport.md#_mount)
163
+
164
+ ***
165
+
166
+ ### fetch()
167
+
168
+ > **fetch**(`name`, `args`?, `act`?, `subName`?, `fetchOptions`?): `Promise`\<`any`\>
169
+
170
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:64](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L64)
171
+
172
+ Fetches data from the server.
173
+
174
+ #### Parameters
175
+
176
+ ##### name
177
+
178
+ `string`
179
+
180
+ The name of the tool function to fetch.
181
+
182
+ ##### args?
183
+
184
+ `any`
185
+
186
+ The object parameters to pass to the server.
187
+
188
+ ##### act?
189
+
190
+ `string`
191
+
192
+ The action to perform on the server.
193
+
194
+ ##### subName?
195
+
196
+ `any`
197
+
198
+ The name of the sub-resource to fetch.
199
+
200
+ ##### fetchOptions?
201
+
202
+ `any`
203
+
204
+ #### Returns
205
+
206
+ `Promise`\<`any`\>
207
+
208
+ A promise that resolves with the fetched data.
209
+
210
+ #### Implementation of
211
+
212
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md).[`fetch`](../interfaces/IClientToolTransport.md#fetch)
213
+
214
+ ***
215
+
216
+ ### loadApis()
217
+
218
+ > **loadApis**(): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
219
+
220
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:58](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L58)
221
+
222
+ Connects to the server's discovery endpoint to get the list of available tools.
223
+
224
+ #### Returns
225
+
226
+ `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
227
+
228
+ A promise that resolves to a map of tool function metadata.
229
+
230
+ #### Implementation of
231
+
232
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md).[`loadApis`](../interfaces/IClientToolTransport.md#loadapis)
233
+
234
+ ***
235
+
236
+ ### mount()
237
+
238
+ > **mount**(`Tools`, `apiRoot`?, `options`?): `any`
239
+
240
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L42)
241
+
242
+ #### Parameters
243
+
244
+ ##### Tools
245
+
246
+ *typeof* [`ToolFunc`](ToolFunc.md)
247
+
248
+ ##### apiRoot?
249
+
250
+ `string`
251
+
252
+ ##### options?
253
+
254
+ `any`
255
+
256
+ #### Returns
257
+
258
+ `any`
259
+
260
+ #### Implementation of
261
+
262
+ [`IClientToolTransport`](../interfaces/IClientToolTransport.md).[`mount`](../interfaces/IClientToolTransport.md#mount)
263
+
264
+ #### Inherited from
265
+
266
+ [`ToolTransport`](ToolTransport.md).[`mount`](ToolTransport.md#mount)
267
+
268
+ ***
269
+
270
+ ### setApiRoot()
271
+
272
+ > **setApiRoot**(`apiRoot`): `void`
273
+
274
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L38)
275
+
276
+ #### Parameters
277
+
278
+ ##### apiRoot
279
+
280
+ `string`
281
+
282
+ #### Returns
283
+
284
+ `void`
285
+
286
+ #### Inherited from
287
+
288
+ [`ToolTransport`](ToolTransport.md).[`setApiRoot`](ToolTransport.md#setapiroot)
289
+
290
+ ***
291
+
292
+ ### toObject()
293
+
294
+ > `abstract` **toObject**(`res`, `args`?): `any`
295
+
296
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/client.ts#L76)
297
+
298
+ #### Parameters
299
+
300
+ ##### res
301
+
302
+ `any`
303
+
304
+ ##### args?
305
+
306
+ `any`
307
+
308
+ #### Returns
309
+
310
+ `any`