@isdk/ai-tool 0.5.2 → 0.5.4

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 (331) hide show
  1. package/dist/funcs.js +1 -1
  2. package/dist/index.js +1 -1
  3. package/docs/README.md +250 -0
  4. package/docs/_media/CONTRIBUTING.md +18 -0
  5. package/docs/_media/LICENSE-MIT +22 -0
  6. package/docs/classes/AbortError.md +366 -0
  7. package/docs/classes/AlreadyExistsError.md +346 -0
  8. package/docs/classes/BaseError.md +359 -0
  9. package/docs/classes/BinarySemaphore.md +418 -0
  10. package/docs/classes/CancelableAbility.md +467 -0
  11. package/docs/classes/ClientTools.md +2715 -0
  12. package/docs/classes/CommonError.md +377 -0
  13. package/docs/classes/ConfigFile.md +353 -0
  14. package/docs/classes/EnvPromptTemplate.md +1158 -0
  15. package/docs/classes/EventClient.md +3149 -0
  16. package/docs/classes/EventEmitter.md +299 -0
  17. package/docs/classes/EventServer.md +3175 -0
  18. package/docs/classes/EventToolFunc.md +2557 -0
  19. package/docs/classes/FStringPromptTemplate.md +1158 -0
  20. package/docs/classes/FewShotPromptTemplate.md +1180 -0
  21. package/docs/classes/GolangPromptTemplate.md +1158 -0
  22. package/docs/classes/HFEnvironment.md +184 -0
  23. package/docs/classes/HFInterpreter.md +77 -0
  24. package/docs/classes/HFTemplate.md +67 -0
  25. package/docs/classes/HfPromptTemplate.md +1158 -0
  26. package/docs/classes/IntSet.md +216 -0
  27. package/docs/classes/LRUCache.md +601 -0
  28. package/docs/classes/NotFoundError.md +346 -0
  29. package/docs/classes/NotImplementationError.md +346 -0
  30. package/docs/classes/PromptExampleSelector.md +195 -0
  31. package/docs/classes/PromptTemplate.md +1088 -0
  32. package/docs/classes/ReadableStreamError.md +366 -0
  33. package/docs/classes/ResClientTools.md +2431 -0
  34. package/docs/classes/ResServerTools.md +2407 -0
  35. package/docs/classes/SSEChannel.md +270 -0
  36. package/docs/classes/Semaphore.md +538 -0
  37. package/docs/classes/ServerTools.md +2623 -0
  38. package/docs/classes/SignalGate.md +182 -0
  39. package/docs/classes/TaskAbortController.md +131 -0
  40. package/docs/classes/ToolFunc.md +2177 -0
  41. package/docs/classes/YamlTypeBaseObject.md +31 -0
  42. package/docs/enumerations/AsyncFeatureBits.md +33 -0
  43. package/docs/enumerations/AsyncFeatures.md +33 -0
  44. package/docs/enumerations/ErrorCode.md +177 -0
  45. package/docs/enumerations/HashAlgorithm.md +97 -0
  46. package/docs/functions/AIArgProcessor.md +33 -0
  47. package/docs/functions/AIStream.md +52 -0
  48. package/docs/functions/ChoiceArgProcessor.md +33 -0
  49. package/docs/functions/ObjectArgsToArgsInfo.md +29 -0
  50. package/docs/functions/RateLimit.md +37 -0
  51. package/docs/functions/TemplateArgProcessor.md +33 -0
  52. package/docs/functions/assignDirs.md +33 -0
  53. package/docs/functions/backendEventable.md +29 -0
  54. package/docs/functions/beforeShutdown.md +29 -0
  55. package/docs/functions/canonicalize.md +21 -0
  56. package/docs/functions/completeSentences.md +25 -0
  57. package/docs/functions/concatText.md +25 -0
  58. package/docs/functions/countLLMTokens.md +25 -0
  59. package/docs/functions/countRegexMatches.md +35 -0
  60. package/docs/functions/createAbilityInjector.md +119 -0
  61. package/docs/functions/createCallbacksTransformer.md +49 -0
  62. package/docs/functions/createEmptyReadableStream.md +21 -0
  63. package/docs/functions/createEndWithRepetitionDetector.md +31 -0
  64. package/docs/functions/createError.md +39 -0
  65. package/docs/functions/createEventStreamTransformer.md +33 -0
  66. package/docs/functions/createHfValueFunc.md +31 -0
  67. package/docs/functions/createLRUCache.md +25 -0
  68. package/docs/functions/createYamlObjectTag.md +25 -0
  69. package/docs/functions/dateToText.md +25 -0
  70. package/docs/functions/decodeCharset.md +25 -0
  71. package/docs/functions/detectCharset.md +25 -0
  72. package/docs/functions/encodeLLMTokens.md +25 -0
  73. package/docs/functions/ensureQuoted.md +25 -0
  74. package/docs/functions/eventable.md +82 -0
  75. package/docs/functions/expandConfig.md +25 -0
  76. package/docs/functions/expandEnv.md +40 -0
  77. package/docs/functions/expandObjEnv.md +58 -0
  78. package/docs/functions/expandPath.md +25 -0
  79. package/docs/functions/extNameLevel.md +43 -0
  80. package/docs/functions/fileIsExists.md +34 -0
  81. package/docs/functions/filenameReservedRegex.md +20 -0
  82. package/docs/functions/filterValidFnScope.md +21 -0
  83. package/docs/functions/findIndexNonEmptyFrom.md +25 -0
  84. package/docs/functions/findPort.md +25 -0
  85. package/docs/functions/formatISO.md +69 -0
  86. package/docs/functions/formatTextWithSpace.md +63 -0
  87. package/docs/functions/getAllEnumKeys.md +31 -0
  88. package/docs/functions/getConfigFileNames.md +25 -0
  89. package/docs/functions/getConfigs.md +25 -0
  90. package/docs/functions/getEnvVairables.md +21 -0
  91. package/docs/functions/getFileMetaInfo.md +21 -0
  92. package/docs/functions/getHashAlgoBySize.md +21 -0
  93. package/docs/functions/getKeysPath.md +38 -0
  94. package/docs/functions/getLLMTokenizer.md +21 -0
  95. package/docs/functions/getMultiLevelExtname.md +33 -0
  96. package/docs/functions/getPackageDir.md +39 -0
  97. package/docs/functions/getRealFilepath.md +34 -0
  98. package/docs/functions/getResponseErrorReadableStream.md +21 -0
  99. package/docs/functions/getXDGConfigs.md +37 -0
  100. package/docs/functions/hasDirectoryIn.md +40 -0
  101. package/docs/functions/hash.md +25 -0
  102. package/docs/functions/hashFile.md +25 -0
  103. package/docs/functions/hashStream.md +25 -0
  104. package/docs/functions/hfParse.md +24 -0
  105. package/docs/functions/hfTokenize.md +27 -0
  106. package/docs/functions/initShutdown.md +15 -0
  107. package/docs/functions/interpolateEnv.md +29 -0
  108. package/docs/functions/interpolateFString.md +29 -0
  109. package/docs/functions/interpolateGolangTemplate.md +35 -0
  110. package/docs/functions/isLangUsingSpaces.md +21 -0
  111. package/docs/functions/isListItemString.md +21 -0
  112. package/docs/functions/isModelNameMatched.md +47 -0
  113. package/docs/functions/isPunctuationChar.md +36 -0
  114. package/docs/functions/isQuoted.md +21 -0
  115. package/docs/functions/isRegExp.md +21 -0
  116. package/docs/functions/isSameString.md +36 -0
  117. package/docs/functions/isSectionString.md +25 -0
  118. package/docs/functions/isSentenceEnding.md +21 -0
  119. package/docs/functions/isSepLineString.md +21 -0
  120. package/docs/functions/isStrWrapped.md +25 -0
  121. package/docs/functions/isSubdirectory.md +41 -0
  122. package/docs/functions/isTitleString.md +25 -0
  123. package/docs/functions/isValidFilename.md +38 -0
  124. package/docs/functions/isValidFilepath.md +27 -0
  125. package/docs/functions/isWebStream.md +21 -0
  126. package/docs/functions/jsonFilterToWhere.md +47 -0
  127. package/docs/functions/jsonToMarkdownStr.md +39 -0
  128. package/docs/functions/loadAIConfig.md +21 -0
  129. package/docs/functions/loadConfig.md +25 -0
  130. package/docs/functions/loadConfigFile.md +25 -0
  131. package/docs/functions/loadFileFromPaths.md +64 -0
  132. package/docs/functions/loadTextFromPaths.md +37 -0
  133. package/docs/functions/lrucache.md +35 -0
  134. package/docs/functions/makeToolFuncCancelable.md +29 -0
  135. package/docs/functions/matchUrlProtocol.md +48 -0
  136. package/docs/functions/memoize.md +29 -0
  137. package/docs/functions/messagesToText.md +21 -0
  138. package/docs/functions/paramsSizeToScaleStr.md +34 -0
  139. package/docs/functions/parseCommand.md +29 -0
  140. package/docs/functions/parseDateFormat.md +362 -0
  141. package/docs/functions/parseFString.md +26 -0
  142. package/docs/functions/parseISO.md +70 -0
  143. package/docs/functions/parseJsJson.md +40 -0
  144. package/docs/functions/parseJsJsonSimpleSync.md +25 -0
  145. package/docs/functions/parseObjectArgInfo.md +33 -0
  146. package/docs/functions/parseObjectArgumentInfos.md +29 -0
  147. package/docs/functions/parseObjectArguments.md +72 -0
  148. package/docs/functions/parseObjectArgumentsAsArgInfos.md +46 -0
  149. package/docs/functions/parseYaml.md +25 -0
  150. package/docs/functions/quoteStr.md +21 -0
  151. package/docs/functions/reControlCharsRegex.md +19 -0
  152. package/docs/functions/readFilenamesRecursiveSync.md +53 -0
  153. package/docs/functions/readTextFileChunks.md +53 -0
  154. package/docs/functions/readTextFileChunksEx.md +25 -0
  155. package/docs/functions/readableFromAsyncIterable.md +28 -0
  156. package/docs/functions/registerCoreTools.md +15 -0
  157. package/docs/functions/registerYamlTag.md +21 -0
  158. package/docs/functions/removeMarkdownBold.md +25 -0
  159. package/docs/functions/removeMarkdownBoldAndItalic.md +25 -0
  160. package/docs/functions/removeMarkdownItalic.md +25 -0
  161. package/docs/functions/replaceWithPlaceholder.md +43 -0
  162. package/docs/functions/restoreFromPlacehoders.md +49 -0
  163. package/docs/functions/sanitizeFilename.md +39 -0
  164. package/docs/functions/sanitizeFilepath.md +33 -0
  165. package/docs/functions/saveConfigFile.md +29 -0
  166. package/docs/functions/scaleStrToParamsSize.md +27 -0
  167. package/docs/functions/shutdown.md +33 -0
  168. package/docs/functions/simplifyObjectArguments.md +21 -0
  169. package/docs/functions/sortedValues.md +25 -0
  170. package/docs/functions/splitChunks.md +25 -0
  171. package/docs/functions/splitParagraph.md +34 -0
  172. package/docs/functions/splitSentence.md +39 -0
  173. package/docs/functions/stringifyYaml.md +25 -0
  174. package/docs/functions/stripConsoleColor.md +21 -0
  175. package/docs/functions/textToDate.md +25 -0
  176. package/docs/functions/throwError.md +41 -0
  177. package/docs/functions/toDate.md +74 -0
  178. package/docs/functions/toDateTime.md +21 -0
  179. package/docs/functions/toRegExp.md +34 -0
  180. package/docs/functions/trimStartOfStreamHelper.md +41 -0
  181. package/docs/functions/truncTo.md +51 -0
  182. package/docs/functions/truncateByToken.md +25 -0
  183. package/docs/functions/truncateToTokenLimit.md +46 -0
  184. package/docs/functions/truncateToTokenLimitEx.md +25 -0
  185. package/docs/functions/uuid.md +25 -0
  186. package/docs/functions/uuidParse.md +21 -0
  187. package/docs/functions/uuidStringify.md +25 -0
  188. package/docs/functions/uuidValidate.md +21 -0
  189. package/docs/functions/uuidVersion.md +21 -0
  190. package/docs/functions/uuidv1.md +55 -0
  191. package/docs/functions/uuidv4.md +55 -0
  192. package/docs/functions/uuidv5.md +63 -0
  193. package/docs/functions/wait.md +21 -0
  194. package/docs/functions/wrapEventEmitter.md +27 -0
  195. package/docs/functions/xxhash.md +29 -0
  196. package/docs/functions/xxhash32.md +25 -0
  197. package/docs/functions/xxhash64.md +25 -0
  198. package/docs/functions/xxhashAsStr.md +29 -0
  199. package/docs/globals.md +329 -0
  200. package/docs/interfaces/AIChatAssistantMessageParam.md +129 -0
  201. package/docs/interfaces/AIChatContentPartImage.md +29 -0
  202. package/docs/interfaces/AIChatContentPartText.md +25 -0
  203. package/docs/interfaces/AIChatMessageParamBase.md +68 -0
  204. package/docs/interfaces/AIChatMessageToolCall.md +41 -0
  205. package/docs/interfaces/AIChatSystemMessageParam.md +105 -0
  206. package/docs/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  207. package/docs/interfaces/AIChatToolChoiceObject.md +25 -0
  208. package/docs/interfaces/AIChatToolFunc.md +41 -0
  209. package/docs/interfaces/AIChatToolFuncParam.md +37 -0
  210. package/docs/interfaces/AIChatToolMessageParam.md +113 -0
  211. package/docs/interfaces/AIChatToolParam.md +25 -0
  212. package/docs/interfaces/AIChatToolTypeObject.md +17 -0
  213. package/docs/interfaces/AIChatUserMessageParam.md +137 -0
  214. package/docs/interfaces/AIChoiceConfig.md +65 -0
  215. package/docs/interfaces/AIResult.md +65 -0
  216. package/docs/interfaces/AIStreamParser.md +43 -0
  217. package/docs/interfaces/AIStreamParserOptions.md +21 -0
  218. package/docs/interfaces/BaseFunc.md +145 -0
  219. package/docs/interfaces/BaseFuncItem.md +93 -0
  220. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  221. package/docs/interfaces/BinarySemaphoreOptions.md +57 -0
  222. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  223. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  224. package/docs/interfaces/CancelableAbilityOptions.md +113 -0
  225. package/docs/interfaces/ClientFuncItem.md +163 -0
  226. package/docs/interfaces/DotenvExpandOptions.md +43 -0
  227. package/docs/interfaces/DotenvExpandOutput.md +25 -0
  228. package/docs/interfaces/DotenvParseInput.md +13 -0
  229. package/docs/interfaces/DotenvParseOutput.md +13 -0
  230. package/docs/interfaces/DotenvPopulateInput.md +13 -0
  231. package/docs/interfaces/EventClientFuncParams.md +51 -0
  232. package/docs/interfaces/EventServerFuncParams.md +67 -0
  233. package/docs/interfaces/FewShotPromptTemplateOptions.md +147 -0
  234. package/docs/interfaces/FuncItem.md +131 -0
  235. package/docs/interfaces/FuncParam.md +61 -0
  236. package/docs/interfaces/FuncParams.md +13 -0
  237. package/docs/interfaces/Funcs.md +13 -0
  238. package/docs/interfaces/HashAlgoParams.md +33 -0
  239. package/docs/interfaces/IFileMetaInfo.md +65 -0
  240. package/docs/interfaces/IReadTextFileChunksOptions.md +143 -0
  241. package/docs/interfaces/ITruncateToTokenLimitOptions.md +99 -0
  242. package/docs/interfaces/JsonFilter.md +13 -0
  243. package/docs/interfaces/ParseObjectArgumentOptions.md +89 -0
  244. package/docs/interfaces/PromptExampleSelectorOptions.md +34 -0
  245. package/docs/interfaces/PromptTemplateOptions.md +65 -0
  246. package/docs/interfaces/RemoteFuncItem.md +152 -0
  247. package/docs/interfaces/ReplacePlacehoderOptions.md +41 -0
  248. package/docs/interfaces/ResClientFuncParams.md +37 -0
  249. package/docs/interfaces/ResServerFuncParams.md +69 -0
  250. package/docs/interfaces/SanitizeFilenameOptions.md +25 -0
  251. package/docs/interfaces/SectionStringOptions.md +25 -0
  252. package/docs/interfaces/SemaphoreOptions.md +89 -0
  253. package/docs/interfaces/SemaphoreTaskItem.md +73 -0
  254. package/docs/interfaces/ServerFuncItem.md +171 -0
  255. package/docs/interfaces/ServerFuncParams.md +35 -0
  256. package/docs/interfaces/SplitSentenceOptions.md +41 -0
  257. package/docs/interfaces/StreamCallbacksAndOptions.md +99 -0
  258. package/docs/interfaces/TaskAbortControllers.md +13 -0
  259. package/docs/interfaces/TaskPromise.md +138 -0
  260. package/docs/interfaces/ToolFuncPackage.md +47 -0
  261. package/docs/namespaces/EventStates/README.md +14 -0
  262. package/docs/namespaces/EventStates/variables/ABORT.md +11 -0
  263. package/docs/namespaces/EventStates/variables/CONTINUE.md +11 -0
  264. package/docs/namespaces/EventStates/variables/DONE.md +11 -0
  265. package/docs/namespaces/EventStates/variables/STOPPED.md +11 -0
  266. package/docs/namespaces/uuidv5/README.md +12 -0
  267. package/docs/namespaces/uuidv5/variables/DNS.md +11 -0
  268. package/docs/namespaces/uuidv5/variables/URL.md +11 -0
  269. package/docs/type-aliases/AIChatContentPart.md +11 -0
  270. package/docs/type-aliases/AIChatMessageParam.md +11 -0
  271. package/docs/type-aliases/AIChatRole.md +11 -0
  272. package/docs/type-aliases/AIChatToolChoiceParam.md +11 -0
  273. package/docs/type-aliases/AIMessageType.md +11 -0
  274. package/docs/type-aliases/AIModelNameRule.md +11 -0
  275. package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
  276. package/docs/type-aliases/AIModelNameRules.md +11 -0
  277. package/docs/type-aliases/AITextGenerationFinishReason.md +11 -0
  278. package/docs/type-aliases/ActionName.md +11 -0
  279. package/docs/type-aliases/AsyncTaskId.md +11 -0
  280. package/docs/type-aliases/BeforeShutdownListener.md +23 -0
  281. package/docs/type-aliases/EventErrorListenerFn.md +33 -0
  282. package/docs/type-aliases/EventListenerFn.md +29 -0
  283. package/docs/type-aliases/FStringPromptTemplateNode.md +14 -0
  284. package/docs/type-aliases/FuncParamType.md +11 -0
  285. package/docs/type-aliases/PromptExamples.md +15 -0
  286. package/docs/type-aliases/PromptTemplateType.md +11 -0
  287. package/docs/type-aliases/PromptType.md +11 -0
  288. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +15 -0
  289. package/docs/type-aliases/TFunc.md +25 -0
  290. package/docs/variables/AIChatRoles.md +11 -0
  291. package/docs/variables/AIMessageTypes.md +11 -0
  292. package/docs/variables/AITextGenerationFinishReasons.md +11 -0
  293. package/docs/variables/AbortErrorCode.md +11 -0
  294. package/docs/variables/ActionNames.md +11 -0
  295. package/docs/variables/AlreadyExistsErrorCode.md +11 -0
  296. package/docs/variables/ClientToolFuncSchema.md +101 -0
  297. package/docs/variables/DEFAULT_CONFIG_NAME.md +11 -0
  298. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +11 -0
  299. package/docs/variables/EventBusName.md +11 -0
  300. package/docs/variables/EventName.md +11 -0
  301. package/docs/variables/FilenameReservedRegex.md +14 -0
  302. package/docs/variables/HFBuiltins.md +122 -0
  303. package/docs/variables/InternalErrorCode.md +11 -0
  304. package/docs/variables/LLM_TOKENIZER_NAMES.md +81 -0
  305. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +11 -0
  306. package/docs/variables/NotFoundErrorCode.md +11 -0
  307. package/docs/variables/NotImplementedErrorCode.md +11 -0
  308. package/docs/variables/PASSING_SCORE.md +11 -0
  309. package/docs/variables/PromptTemplateTypes.md +11 -0
  310. package/docs/variables/PromptTypes.md +14 -0
  311. package/docs/variables/RStreamErrCode.md +11 -0
  312. package/docs/variables/RemoteToolFuncSchema.md +101 -0
  313. package/docs/variables/ResponseRStreamErrCode.md +11 -0
  314. package/docs/variables/SHUTDOWN_SIGNALS.md +17 -0
  315. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +11 -0
  316. package/docs/variables/SecondaryCache.md +11 -0
  317. package/docs/variables/ServerToolFuncSchema.md +101 -0
  318. package/docs/variables/ToolAsyncCancelableBit.md +11 -0
  319. package/docs/variables/ToolAsyncMultiTaskBit.md +11 -0
  320. package/docs/variables/ToolAsyncPriorityBit.md +11 -0
  321. package/docs/variables/ToolFuncSchema.md +133 -0
  322. package/docs/variables/WindowsReservedNameRegex.md +13 -0
  323. package/docs/variables/base32768.md +11 -0
  324. package/docs/variables/defaultTemplateFormat.md +11 -0
  325. package/docs/variables/event.md +11 -0
  326. package/docs/variables/eventClient.md +11 -0
  327. package/docs/variables/eventServer.md +11 -0
  328. package/docs/variables/lrucache.md +11 -0
  329. package/docs/variables/mimeType.md +11 -0
  330. package/docs/variables/uuidNIL.md +11 -0
  331. package/package.json +2 -2
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / PASSING\_SCORE
6
+
7
+ # Variable: PASSING\_SCORE
8
+
9
+ > `const` **PASSING\_SCORE**: `0.618` = `0.618`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/consts.ts:3](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L3)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / PromptTemplateTypes
6
+
7
+ # Variable: PromptTemplateTypes
8
+
9
+ > `const` **PromptTemplateTypes**: readonly \[`"internal"`, `"hf"`, `"fill"`\]
10
+
11
+ Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/consts.ts#L12)
@@ -0,0 +1,14 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / PromptTypes
6
+
7
+ # Variable: PromptTypes
8
+
9
+ > `const` **PromptTypes**: readonly \[`"chat"`, `"char"`, `"plan"`\]
10
+
11
+ Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/consts.ts#L5)
12
+
13
+ Prompt Type
14
+ defaults to `chat`
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / RStreamErrCode
6
+
7
+ # Variable: RStreamErrCode
8
+
9
+ > `const` **RStreamErrCode**: `600` = `600`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:3](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/error-readable-stream.ts#L3)
@@ -0,0 +1,101 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / RemoteToolFuncSchema
6
+
7
+ # Variable: RemoteToolFuncSchema
8
+
9
+ > `const` **RemoteToolFuncSchema**: `object`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/consts.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L13)
12
+
13
+ ## Type declaration
14
+
15
+ ### action
16
+
17
+ > **action**: `object`
18
+
19
+ #### action.type
20
+
21
+ > **type**: `string` = `'string'`
22
+
23
+ #### action.assign()
24
+
25
+ ##### Parameters
26
+
27
+ ###### value
28
+
29
+ `"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
30
+
31
+ ###### dest
32
+
33
+ `any`
34
+
35
+ ###### src?
36
+
37
+ `any`
38
+
39
+ ###### name?
40
+
41
+ `string`
42
+
43
+ ###### options?
44
+
45
+ `any`
46
+
47
+ ##### Returns
48
+
49
+ `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
50
+
51
+ ### allowExportFunc
52
+
53
+ > **allowExportFunc**: `object`
54
+
55
+ #### allowExportFunc.type
56
+
57
+ > **type**: `string` = `'boolean'`
58
+
59
+ ### apiRoot
60
+
61
+ > **apiRoot**: `object`
62
+
63
+ #### apiRoot.type
64
+
65
+ > **type**: `string` = `'string'`
66
+
67
+ #### apiRoot.get()
68
+
69
+ ##### Parameters
70
+
71
+ ###### this
72
+
73
+ `any`
74
+
75
+ ##### Returns
76
+
77
+ `any`
78
+
79
+ #### apiRoot.set()
80
+
81
+ ##### Parameters
82
+
83
+ ###### this
84
+
85
+ `any`
86
+
87
+ ###### value
88
+
89
+ `string`
90
+
91
+ ##### Returns
92
+
93
+ `void`
94
+
95
+ ### fetchOptions
96
+
97
+ > **fetchOptions**: `object`
98
+
99
+ #### fetchOptions.type
100
+
101
+ > **type**: `string` = `'object'`
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ResponseRStreamErrCode
6
+
7
+ # Variable: ResponseRStreamErrCode
8
+
9
+ > `const` **ResponseRStreamErrCode**: `601` = `601`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:4](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/error-readable-stream.ts#L4)
@@ -0,0 +1,17 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / SHUTDOWN\_SIGNALS
6
+
7
+ # Variable: SHUTDOWN\_SIGNALS
8
+
9
+ > `const` **SHUTDOWN\_SIGNALS**: `string`[]
10
+
11
+ Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/node/before-shutdown.ts#L21)
12
+
13
+ System signals the app will listen to initiate shutdown.
14
+
15
+ ## Const
16
+
17
+ SIGINT, a.k.a Ctrl + C, and SIGTERM by default
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / SSEChannelAlreadyClosedErrCode
6
+
7
+ # Variable: SSEChannelAlreadyClosedErrCode
8
+
9
+ > `const` **SSEChannelAlreadyClosedErrCode**: `498` = `498`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:17](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/event/sse-channel.ts#L17)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / SecondaryCache
6
+
7
+ # Variable: SecondaryCache
8
+
9
+ > `const` **SecondaryCache**: *typeof* `Cache` = `_Cache`
10
+
11
+ Defined in: [packages/ai-tool/src/funcs/lrucache.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/lrucache.ts#L6)
@@ -0,0 +1,101 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ServerToolFuncSchema
6
+
7
+ # Variable: ServerToolFuncSchema
8
+
9
+ > `const` **ServerToolFuncSchema**: `object`
10
+
11
+ Defined in: [packages/ai-tool/src/server-tools.ts:62](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L62)
12
+
13
+ ## Type declaration
14
+
15
+ ### action
16
+
17
+ > **action**: `object`
18
+
19
+ #### action.type
20
+
21
+ > **type**: `string` = `'string'`
22
+
23
+ #### action.assign()
24
+
25
+ ##### Parameters
26
+
27
+ ###### value
28
+
29
+ `"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
30
+
31
+ ###### dest
32
+
33
+ `any`
34
+
35
+ ###### src?
36
+
37
+ `any`
38
+
39
+ ###### name?
40
+
41
+ `string`
42
+
43
+ ###### options?
44
+
45
+ `any`
46
+
47
+ ##### Returns
48
+
49
+ `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
50
+
51
+ ### allowExportFunc
52
+
53
+ > **allowExportFunc**: `object`
54
+
55
+ #### allowExportFunc.type
56
+
57
+ > **type**: `string` = `'boolean'`
58
+
59
+ ### apiRoot
60
+
61
+ > **apiRoot**: `object`
62
+
63
+ #### apiRoot.type
64
+
65
+ > **type**: `string` = `'string'`
66
+
67
+ #### apiRoot.get()
68
+
69
+ ##### Parameters
70
+
71
+ ###### this
72
+
73
+ `any`
74
+
75
+ ##### Returns
76
+
77
+ `any`
78
+
79
+ #### apiRoot.set()
80
+
81
+ ##### Parameters
82
+
83
+ ###### this
84
+
85
+ `any`
86
+
87
+ ###### value
88
+
89
+ `string`
90
+
91
+ ##### Returns
92
+
93
+ `void`
94
+
95
+ ### fetchOptions
96
+
97
+ > **fetchOptions**: `object`
98
+
99
+ #### fetchOptions.type
100
+
101
+ > **type**: `string` = `'object'`
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ToolAsyncCancelableBit
6
+
7
+ # Variable: ToolAsyncCancelableBit
8
+
9
+ > `const` **ToolAsyncCancelableBit**: `1` = `1`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L11)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ToolAsyncMultiTaskBit
6
+
7
+ # Variable: ToolAsyncMultiTaskBit
8
+
9
+ > `const` **ToolAsyncMultiTaskBit**: `0` = `0`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L10)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ToolAsyncPriorityBit
6
+
7
+ # Variable: ToolAsyncPriorityBit
8
+
9
+ > `const` **ToolAsyncPriorityBit**: `2` = `2`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L12)
@@ -0,0 +1,133 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ToolFuncSchema
6
+
7
+ # Variable: ToolFuncSchema
8
+
9
+ > `const` **ToolFuncSchema**: `object`
10
+
11
+ Defined in: [packages/ai-tool/src/tool-func.ts:330](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L330)
12
+
13
+ ## Type declaration
14
+
15
+ ### asyncFeatures
16
+
17
+ > **asyncFeatures**: `object`
18
+
19
+ #### asyncFeatures.type
20
+
21
+ > **type**: `string` = `'number'`
22
+
23
+ ### depends
24
+
25
+ > **depends**: `object`
26
+
27
+ #### depends.exported
28
+
29
+ > **exported**: `boolean` = `false`
30
+
31
+ #### depends.type
32
+
33
+ > **type**: `string` = `'object'`
34
+
35
+ ### description
36
+
37
+ > **description**: `object`
38
+
39
+ #### description.type
40
+
41
+ > **type**: `string` = `'string'`
42
+
43
+ ### func
44
+
45
+ > **func**: `object`
46
+
47
+ #### func.type
48
+
49
+ > **type**: `string` = `'function'`
50
+
51
+ #### func.assign()
52
+
53
+ ##### Parameters
54
+
55
+ ###### value
56
+
57
+ `string` | `Function`
58
+
59
+ ###### dest
60
+
61
+ [`ToolFunc`](../classes/ToolFunc.md)
62
+
63
+ ###### src?
64
+
65
+ [`ToolFunc`](../classes/ToolFunc.md)
66
+
67
+ ###### name?
68
+
69
+ `string`
70
+
71
+ ###### options?
72
+
73
+ `any`
74
+
75
+ ##### Returns
76
+
77
+ `string` \| `Function`
78
+
79
+ ### isApi
80
+
81
+ > **isApi**: `object`
82
+
83
+ #### isApi.type
84
+
85
+ > **type**: `string` = `'boolean'`
86
+
87
+ ### name
88
+
89
+ > **name**: `object`
90
+
91
+ #### name.type
92
+
93
+ > **type**: `string` = `'string'`
94
+
95
+ ### params
96
+
97
+ > **params**: `object`
98
+
99
+ #### params.type
100
+
101
+ > **type**: `string` = `'object'`
102
+
103
+ ### result
104
+
105
+ > **result**: `object`
106
+
107
+ #### result.type
108
+
109
+ > **type**: `string` = `'any'`
110
+
111
+ ### setup
112
+
113
+ > **setup**: `object`
114
+
115
+ #### setup.type
116
+
117
+ > **type**: `string` = `'function'`
118
+
119
+ ### stream
120
+
121
+ > **stream**: `object`
122
+
123
+ #### stream.type
124
+
125
+ > **type**: `string` = `'boolean'`
126
+
127
+ ### tags
128
+
129
+ > **tags**: `object`
130
+
131
+ #### tags.type
132
+
133
+ > **type**: `string`[]
@@ -0,0 +1,13 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / WindowsReservedNameRegex
6
+
7
+ # Variable: WindowsReservedNameRegex
8
+
9
+ > `const` **WindowsReservedNameRegex**: `RegExp`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/filename.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/filename.ts#L13)
12
+
13
+ Regular expression pattern for reserved names on Windows systems.
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / base32768
6
+
7
+ # Variable: base32768
8
+
9
+ > `const` **base32768**: `__module` = `_base32768`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/hash/hash.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/hash.ts#L7)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / defaultTemplateFormat
6
+
7
+ # Variable: defaultTemplateFormat
8
+
9
+ > `const` **defaultTemplateFormat**: `"default"` = `'default'`
10
+
11
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L8)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / event
6
+
7
+ # Variable: event
8
+
9
+ > `const` **event**: [`EventToolFunc`](../classes/EventToolFunc.md)
10
+
11
+ Defined in: [packages/ai-tool/src/funcs/event.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L22)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / eventClient
6
+
7
+ # Variable: eventClient
8
+
9
+ > `const` **eventClient**: [`EventClient`](../classes/EventClient.md)
10
+
11
+ Defined in: [packages/ai-tool/src/funcs/event-client.ts:180](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-client.ts#L180)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / eventServer
6
+
7
+ # Variable: eventServer
8
+
9
+ > `const` **eventServer**: [`EventServer`](../classes/EventServer.md)
10
+
11
+ Defined in: [packages/ai-tool/src/funcs/event-server.ts:133](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-server.ts#L133)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / lrucache
6
+
7
+ # Variable: lrucache
8
+
9
+ > `const` **lrucache**: [`ToolFunc`](../classes/ToolFunc.md)
10
+
11
+ Defined in: [packages/ai-tool/src/funcs/lrucache.ts:42](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/lrucache.ts#L42)
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / mimeType
6
+
7
+ # Variable: mimeType
8
+
9
+ > `const` **mimeType**: `MimeType`
10
+
11
+ Defined in: node\_modules/.pnpm/mime-type@5.0.0/node\_modules/mime-type/src/with-db.d.ts:3
@@ -0,0 +1,11 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / uuidNIL
6
+
7
+ # Variable: uuidNIL
8
+
9
+ > `const` **uuidNIL**: `"00000000-0000-0000-0000-000000000000"`
10
+
11
+ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/nil.d.ts:1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@isdk/ai-tool",
3
- "version": "0.5.2",
3
+ "version": "0.5.4",
4
4
  "author": "Riceball LEE <snowyu.lee@gmail.com>",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -73,7 +73,7 @@
73
73
  "type-fest": "^4.31.0",
74
74
  "typedoc": "^0.27.7",
75
75
  "typedoc-plugin-markdown": "^4.4.2",
76
- "typescript": "^5.7.2",
76
+ "typescript": "^5.7.3",
77
77
  "vite": "^6.0.7",
78
78
  "vite-plugin-wasm": "^3.4.1",
79
79
  "vitest": "^2.1.8"