@isdk/ai-tool 0.7.0 → 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-BCco-g_I.d.mts → index-BLW3R7VS.d.mts} +114 -69
  8. package/dist/{index-BCco-g_I.d.ts → index-BLW3R7VS.d.ts} +114 -69
  9. package/dist/index.d.mts +101 -38
  10. package/dist/index.d.ts +101 -38
  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 +182 -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 +258 -201
  37. package/docs/api/classes/EventEmitter.md +14 -14
  38. package/docs/api/classes/EventServer.md +220 -237
  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 +40 -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 +658 -143
  53. package/docs/api/classes/ResServerTools.md +643 -133
  54. package/docs/api/classes/RpcMethodsClientTool.md +3303 -0
  55. package/docs/api/classes/RpcMethodsServerTool.md +3248 -0
  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 +167 -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 +17 -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 +5 -5
  276. package/docs/api/interfaces/ResServerFuncParams.md +14 -10
  277. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +25 -0
  278. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +61 -0
  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 +4 -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 +51 -0
  333. package/docs/api/variables/RpcMethodsServerToolSchema.md +21 -0
  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 +10 -9
  355. package/dist/chunk-LNTIQQNN.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: TaskPromise\<T\>
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:70](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L70)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:70](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L70)
10
10
 
11
11
  ## Extends
12
12
 
@@ -14,7 +14,9 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:70]
14
14
 
15
15
  ## Type Parameters
16
16
 
17
- **T** = `any`
17
+ ### T
18
+
19
+ `T` = `any`
18
20
 
19
21
  ## Properties
20
22
 
@@ -34,13 +36,13 @@ Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/ty
34
36
 
35
37
  > `optional` **task**: [`TaskAbortController`](../classes/TaskAbortController.md)
36
38
 
37
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:71](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L71)
39
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:71](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L71)
38
40
 
39
41
  ## Methods
40
42
 
41
43
  ### catch()
42
44
 
43
- > **catch**\<`TResult`\>(`onrejected`?): `Promise`\<`T` \| `TResult`\>
45
+ > **catch**\<`TResult`\>(`onrejected?`): `Promise`\<`T` \| `TResult`\>
44
46
 
45
47
  Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1557
46
48
 
@@ -48,7 +50,9 @@ Attaches a callback for only the rejection of the Promise.
48
50
 
49
51
  #### Type Parameters
50
52
 
51
- **TResult** = `never`
53
+ ##### TResult
54
+
55
+ `TResult` = `never`
52
56
 
53
57
  #### Parameters
54
58
 
@@ -72,7 +76,7 @@ A Promise for the completion of the callback.
72
76
 
73
77
  ### finally()
74
78
 
75
- > **finally**(`onfinally`?): `Promise`\<`T`\>
79
+ > **finally**(`onfinally?`): `Promise`\<`T`\>
76
80
 
77
81
  Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2018.promise.d.ts:29
78
82
 
@@ -101,7 +105,7 @@ A Promise for the completion of the callback.
101
105
 
102
106
  ### then()
103
107
 
104
- > **then**\<`TResult1`, `TResult2`\>(`onfulfilled`?, `onrejected`?): `Promise`\<`TResult1` \| `TResult2`\>
108
+ > **then**\<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`\<`TResult1` \| `TResult2`\>
105
109
 
106
110
  Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1550
107
111
 
@@ -109,9 +113,13 @@ Attaches callbacks for the resolution and/or rejection of the Promise.
109
113
 
110
114
  #### Type Parameters
111
115
 
112
- **TResult1** = `T`
116
+ ##### TResult1
117
+
118
+ `TResult1` = `T`
119
+
120
+ ##### TResult2
113
121
 
114
- • **TResult2** = `never`
122
+ `TResult2` = `never`
115
123
 
116
124
  #### Parameters
117
125
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ToolFuncPackage
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:216](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L216)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:216](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L216)
10
10
 
11
11
  Describes a package of tool functions, including methods for registration and unregistration.
12
12
 
@@ -16,7 +16,7 @@ Describes a package of tool functions, including methods for registration and un
16
16
 
17
17
  > **name**: `string`
18
18
 
19
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:221](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L221)
19
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:221](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L221)
20
20
 
21
21
  The name of the tool function package.
22
22
 
@@ -24,9 +24,9 @@ The name of the tool function package.
24
24
 
25
25
  ### register()
26
26
 
27
- > **register**: (`data`?) => `void`
27
+ > **register**: (`data?`) => `void`
28
28
 
29
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:226](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L226)
29
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:226](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L226)
30
30
 
31
31
  A method to register all functions within the package.
32
32
 
@@ -48,7 +48,7 @@ Optional data to pass to the registration process.
48
48
 
49
49
  > `optional` **unregister**: () => `void`
50
50
 
51
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:230](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L230)
51
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:230](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L230)
52
52
 
53
53
  An optional method to unregister all functions within the package.
54
54
 
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AIChatContentPart
8
8
 
9
- > **AIChatContentPart**: [`AIChatContentPartText`](../interfaces/AIChatContentPartText.md) \| [`AIChatContentPartImage`](../interfaces/AIChatContentPartImage.md)
9
+ > **AIChatContentPart** = [`AIChatContentPartText`](../interfaces/AIChatContentPartText.md) \| [`AIChatContentPartImage`](../interfaces/AIChatContentPartImage.md)
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:83](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L83)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:83](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L83)
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AIChatMessageParam
8
8
 
9
- > **AIChatMessageParam**: [`AIChatMessageParamBase`](../interfaces/AIChatMessageParamBase.md) \| [`AIChatSystemMessageParam`](../interfaces/AIChatSystemMessageParam.md) \| [`AIChatUserMessageParam`](../interfaces/AIChatUserMessageParam.md) \| [`AIChatAssistantMessageParam`](../interfaces/AIChatAssistantMessageParam.md) \| [`AIChatToolMessageParam`](../interfaces/AIChatToolMessageParam.md)
9
+ > **AIChatMessageParam** = [`AIChatMessageParamBase`](../interfaces/AIChatMessageParamBase.md) \| [`AIChatSystemMessageParam`](../interfaces/AIChatSystemMessageParam.md) \| [`AIChatUserMessageParam`](../interfaces/AIChatUserMessageParam.md) \| [`AIChatAssistantMessageParam`](../interfaces/AIChatAssistantMessageParam.md) \| [`AIChatToolMessageParam`](../interfaces/AIChatToolMessageParam.md)
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:47](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L47)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:47](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L47)
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AIChatRole
8
8
 
9
- > **AIChatRole**: *typeof* [`AIChatRoles`](../variables/AIChatRoles.md)\[`number`\] & `string`
9
+ > **AIChatRole** = *typeof* [`AIChatRoles`](../variables/AIChatRoles.md)\[`number`\] & `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:45](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L45)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:45](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L45)
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AIChatToolChoiceParam
8
8
 
9
- > **AIChatToolChoiceParam**: `"auto"` \| `"none"` \| `"required"` \| [`AIChatToolChoiceObject`](../interfaces/AIChatToolChoiceObject.md)
9
+ > **AIChatToolChoiceParam** = `"auto"` \| `"none"` \| `"required"` \| [`AIChatToolChoiceObject`](../interfaces/AIChatToolChoiceObject.md)
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:142](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L142)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:142](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L142)
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AIMessageType
8
8
 
9
- > **AIMessageType**: *typeof* [`AIMessageTypes`](../variables/AIMessageTypes.md)\[`number`\]
9
+ > **AIMessageType** = *typeof* [`AIMessageTypes`](../variables/AIMessageTypes.md)\[`number`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L38)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:38](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L38)
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: AIModelNameRule
8
8
 
9
- > **AIModelNameRule**: `string` \| `RegExp` \| [`AIModelNameRuleFn`](AIModelNameRuleFn.md)
9
+ > **AIModelNameRule** = `string` \| `RegExp` \| [`AIModelNameRuleFn`](AIModelNameRuleFn.md)
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:29](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L29)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:29](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L29)
12
12
 
13
13
  Defines a single rule for matching an AI model name. It can be a simple string,
14
14
  a regular expression, or a custom function.
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: AIModelNameRuleFn()
8
8
 
9
- > **AIModelNameRuleFn**: (`name`) => `string` \| `RegExpExecArray` \| `undefined`
9
+ > **AIModelNameRuleFn** = (`name`) => `string` \| `RegExpExecArray` \| `undefined`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:23](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L23)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:23](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L23)
12
12
 
13
13
  Defines the signature for a function that processes an AI model's name,
14
14
  typically for matching or validation purposes.
@@ -6,8 +6,8 @@
6
6
 
7
7
  # Type Alias: AIModelNameRules
8
8
 
9
- > **AIModelNameRules**: [`AIModelNameRule`](AIModelNameRule.md) \| [`AIModelNameRule`](AIModelNameRule.md)[]
9
+ > **AIModelNameRules** = [`AIModelNameRule`](AIModelNameRule.md) \| [`AIModelNameRule`](AIModelNameRule.md)[]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:33](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L33)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:33](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L33)
12
12
 
13
13
  Represents a collection of one or more AI model name matching rules.
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AITextGenerationFinishReason
8
8
 
9
- > **AITextGenerationFinishReason**: *typeof* [`AITextGenerationFinishReasons`](../variables/AITextGenerationFinishReasons.md)\[`number`\]
9
+ > **AITextGenerationFinishReason** = *typeof* [`AITextGenerationFinishReasons`](../variables/AITextGenerationFinishReasons.md)\[`number`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L14)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:14](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L14)
@@ -6,8 +6,8 @@
6
6
 
7
7
  # Type Alias: ActionName
8
8
 
9
- > **ActionName**: *typeof* [`ActionNames`](../variables/ActionNames.md)\[`number`\]
9
+ > **ActionName** = *typeof* [`ActionNames`](../variables/ActionNames.md)\[`number`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L15)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:15](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L15)
12
12
 
13
13
  Represents a valid action name for a remote tool, derived from the `ActionNames` tuple.
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: ArrayMergeWay
8
8
 
9
- > **ArrayMergeWay**: *typeof* [`ArrayMergeWay`](../variables/ArrayMergeWay.md)\[keyof *typeof* [`ArrayMergeWay`](../variables/ArrayMergeWay.md)\]
9
+ > **ArrayMergeWay** = *typeof* [`ArrayMergeWay`](../variables/ArrayMergeWay.md)\[keyof *typeof* [`ArrayMergeWay`](../variables/ArrayMergeWay.md)\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/merge-with-concat.ts:6](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/merge-with-concat.ts#L6)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/merge-with-concat.ts:6](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/merge-with-concat.ts#L6)
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Type Alias: AsyncTaskId
8
8
 
9
- > **AsyncTaskId**: `string` \| `number`
9
+ > **AsyncTaskId** = `string` \| `number`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:27](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L27)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:27](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/cancelable-ability.ts#L27)
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: BeforeShutdownListener()
8
8
 
9
- > **BeforeShutdownListener**: (`signalOrEvent`) => `Promise`\<`void`\> \| `void`
9
+ > **BeforeShutdownListener** = (`signalOrEvent`) => `Promise`\<`void`\> \| `void`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/node/before-shutdown.ts:13](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/node/before-shutdown.ts#L13)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/node/before-shutdown.ts:13](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/node/before-shutdown.ts#L13)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: EventErrorListenerFn()
8
8
 
9
- > **EventErrorListenerFn**: (`this`, `err`, `name`, ...`args`) => `any`
9
+ > **EventErrorListenerFn** = (`this`, `err`, `name`, ...`args`) => `any`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/event/event-ability.ts#L11)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/event-ability.ts#L11)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: EventListenerFn()
8
8
 
9
- > **EventListenerFn**: (`this`, `name`, ...`args`) => `any`
9
+ > **EventListenerFn** = (`this`, `name`, ...`args`) => `any`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/event/event-ability.ts#L10)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/event-ability.ts#L10)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,8 +6,8 @@
6
6
 
7
7
  # Type Alias: FuncParamType
8
8
 
9
- > **FuncParamType**: `string`
9
+ > **FuncParamType** = `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L10)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L10)
12
12
 
13
13
  Represents the data type of a function parameter as a string (e.g., `'string'`, `'number'`).
@@ -6,10 +6,12 @@
6
6
 
7
7
  # Type Alias: PromptExamples\<T\>
8
8
 
9
- > **PromptExamples**\<`T`\>: `Iterable`\<`PromiseLike`\<`T`\> \| `T`\> \| `AsyncIterable`\<`T`\>
9
+ > **PromptExamples**\<`T`\> = `Iterable`\<`PromiseLike`\<`T`\> \| `T`\> \| `AsyncIterable`\<`T`\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:3](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/prompt-example-selector.ts#L3)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:3](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/prompt/prompt-example-selector.ts#L3)
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- **T** = `any`
15
+ ### T
16
+
17
+ `T` = `any`
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: PubSubClientId
8
8
 
9
- > **PubSubClientId**: `string`
9
+ > **PubSubClientId** = `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:8](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L8)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:7](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/server.ts#L7)
12
12
 
13
13
  Represents the unique identifier for a client connected to the PubSub transport.
14
14
  This ID is used for targeted message publishing.
@@ -6,32 +6,52 @@
6
6
 
7
7
  # Type Alias: PubSubCtx\<T\>
8
8
 
9
- > **PubSubCtx**\<`T`\>: `object`
9
+ > **PubSubCtx**\<`T`\> = `object`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:1](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/base.ts#L1)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:1](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/base.ts#L1)
12
12
 
13
13
  ## Type Parameters
14
14
 
15
- **T** = `any`
15
+ ### T
16
16
 
17
- ## Type declaration
17
+ `T` = `any`
18
+
19
+ ## Properties
18
20
 
19
21
  ### event
20
22
 
21
23
  > **event**: `string`
22
24
 
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:2](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/base.ts#L2)
26
+
27
+ ***
28
+
23
29
  ### from?
24
30
 
25
31
  > `optional` **from**: `string`
26
32
 
33
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:5](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/base.ts#L5)
34
+
35
+ ***
36
+
27
37
  ### id?
28
38
 
29
39
  > `optional` **id**: `string`
30
40
 
41
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:3](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/base.ts#L3)
42
+
43
+ ***
44
+
31
45
  ### meta?
32
46
 
33
47
  > `optional` **meta**: `any`
34
48
 
49
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:6](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/base.ts#L6)
50
+
51
+ ***
52
+
35
53
  ### ts?
36
54
 
37
55
  > `optional` **ts**: `number`
56
+
57
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/base.ts:4](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/pubsub/base.ts#L4)
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: RpcMethodHandler()
8
8
 
9
- > **RpcMethodHandler**: (`params`, `context`?) => `Promise`\<`any`\> \| `any`
9
+ > **RpcMethodHandler** = (`params`, `context?`) => `Promise`\<`any`\> \| `any`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L14)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:14](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/transports/base.ts#L14)
12
12
 
13
13
  The generic handler for a remote procedure call (RPC) method.
14
14
  It receives the parameters and returns the result.
@@ -0,0 +1,53 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / SSEClient
6
+
7
+ # Type Alias: SSEClient
8
+
9
+ > **SSEClient** = `object`
10
+
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/sse-channel.ts:10](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/sse-channel.ts#L10)
12
+
13
+ Represents a client connected to the SSE channel.
14
+
15
+ ## Properties
16
+
17
+ ### clientId
18
+
19
+ > **clientId**: `string`
20
+
21
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/sse-channel.ts:20](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/sse-channel.ts#L20)
22
+
23
+ A unique identifier for the client.
24
+
25
+ ***
26
+
27
+ ### events?
28
+
29
+ > `optional` **events**: `Events`
30
+
31
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/sse-channel.ts:16](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/sse-channel.ts#L16)
32
+
33
+ An array of event names or patterns that the client is subscribed to.
34
+
35
+ ***
36
+
37
+ ### req
38
+
39
+ > **req**: `IncomingMessage`
40
+
41
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/sse-channel.ts:12](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/sse-channel.ts#L12)
42
+
43
+ The incoming HTTP request from the client.
44
+
45
+ ***
46
+
47
+ ### res
48
+
49
+ > **res**: `ServerResponse`
50
+
51
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/sse-channel.ts:14](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/sse-channel.ts#L14)
52
+
53
+ The server response object used to send events to the client.
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: SemaphoreIsReadyFuncType()
8
8
 
9
- > **SemaphoreIsReadyFuncType**: () => `Promise`\<`boolean`\> \| `boolean`
9
+ > **SemaphoreIsReadyFuncType** = () => `Promise`\<`boolean`\> \| `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L11)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:11](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-semaphore.ts#L11)
12
12
 
13
13
  ## Returns
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Type Alias: TFunc()
8
8
 
9
- > **TFunc**: (`this`, ...`params`) => `any`
9
+ > **TFunc** = (`this`, ...`params`) => `any`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:65](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L65)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:65](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/tool-func.ts#L65)
12
12
 
13
13
  Defines the signature for a tool function's implementation.
14
14
 
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / UUIDVersions
6
+
7
+ # Type Alias: UUIDVersions
8
+
9
+ > **UUIDVersions** = keyof *typeof* `uuids`
10
+
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/uuid.ts:8](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/hash/uuid.ts#L8)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **AIChatRoles**: readonly \[`"user"`, `"assistant"`, `"system"`, `"tool"`, `"tool_calls"`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:43](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L43)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:43](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L43)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **AIMessageTypes**: readonly \[`"human"`, `"ai"`, `"generic"`, `"system"`, `"tool"`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:37](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L37)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:37](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L37)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **AITextGenerationFinishReasons**: readonly \[`"stop"`, `"length"`, `"content_filter"`, `"tool_calls"`, `"function_call"`, `"abort"`, `"error"`, `"other"`, `null`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:4](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L4)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:4](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/chat.ts#L4)
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **ActionNames**: readonly \[`"get"`, `"post"`, `"put"`, `"delete"`, `"patch"`, `"list"`, `"res"`\]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L11)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/consts.ts#L11)
12
12
 
13
13
  A tuple of supported action names for remote tool interactions.
@@ -8,9 +8,9 @@
8
8
 
9
9
  > `const` **ArrayMergeWay**: `object`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/merge-with-concat.ts:6](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/merge-with-concat.ts#L6)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/merge-with-concat.ts:6](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/merge-with-concat.ts#L6)
12
12
 
13
- ## Type declaration
13
+ ## Type Declaration
14
14
 
15
15
  ### end
16
16
 
@@ -6,6 +6,6 @@
6
6
 
7
7
  # Variable: ArrayMergeWaySymbol
8
8
 
9
- > `const` **ArrayMergeWaySymbol**: *typeof* [`ArrayMergeWaySymbol`](ArrayMergeWaySymbol.md)
9
+ > `const` **ArrayMergeWaySymbol**: *typeof* `ArrayMergeWaySymbol`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/merge-with-concat.ts:4](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/merge-with-concat.ts#L4)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/merge-with-concat.ts:4](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/merge-with-concat.ts#L4)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ClientEventPrefix
6
+
7
+ # Variable: ClientEventPrefix
8
+
9
+ > `const` **ClientEventPrefix**: `"client:"` = `'client:'`
10
+
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:12](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/funcs/event-server.ts#L12)
@@ -8,13 +8,13 @@
8
8
 
9
9
  > `const` **ClientToolFuncSchema**: `object`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:147](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/client-tools.ts#L147)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:149](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/client-tools.ts#L149)
12
12
 
13
13
  **`Internal`**
14
14
 
15
15
  The schema definition for `ClientTools` properties.
16
16
 
17
- ## Type declaration
17
+ ## Type Declaration
18
18
 
19
19
  ### action
20
20
 
@@ -31,6 +31,8 @@ to corresponding HTTP methods. Defaults to 'post'.
31
31
 
32
32
  #### action.assign()
33
33
 
34
+ > **assign**(`value`, `dest`, `src?`, `name?`, `options?`): `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
35
+
34
36
  ##### Parameters
35
37
 
36
38
  ###### value
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **DEFAULT\_CONFIG\_NAME**: `".ai"` = `'.ai'`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-config.ts:5](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/load-config.ts#L5)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-config.ts:5](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/load-config.ts#L5)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:9](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L9)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:9](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/async-semaphore.ts#L9)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **EventBusName**: `"event-bus"` = `'event-bus'`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/event/event-ability.ts#L9)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/d0765f898f217d97c57c6949502b4a7bef5dce5e/src/utils/event/event-ability.ts#L9)