@isdk/ai-tool 0.8.2 → 0.9.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 (405) hide show
  1. package/dist/chunk-BIJ2JH4U.mjs +1 -0
  2. package/dist/chunk-OYMVHUDZ.mjs +1 -0
  3. package/dist/funcs.d.mts +16 -5
  4. package/dist/funcs.d.ts +16 -5
  5. package/dist/funcs.js +1 -1
  6. package/dist/funcs.mjs +1 -1
  7. package/dist/index.d.mts +839 -563
  8. package/dist/index.d.ts +839 -563
  9. package/dist/index.js +1 -1
  10. package/dist/index.mjs +1 -1
  11. package/dist/test/util.d.mts +1 -1
  12. package/dist/test/util.d.ts +1 -1
  13. package/dist/test/util.js +1 -1
  14. package/dist/test/util.mjs +1 -1
  15. package/docs/api/@isdk/namespaces/ClientTools/README.md +11 -0
  16. package/docs/api/@isdk/namespaces/ClientTools/functions/get.md +27 -0
  17. package/docs/api/@isdk/namespaces/EventStates/variables/ABORT.md +1 -1
  18. package/docs/api/@isdk/namespaces/EventStates/variables/CONTINUE.md +1 -1
  19. package/docs/api/@isdk/namespaces/EventStates/variables/DONE.md +1 -1
  20. package/docs/api/@isdk/namespaces/EventStates/variables/STOPPED.md +1 -1
  21. package/docs/api/classes/BinarySemaphore.md +148 -67
  22. package/docs/api/classes/CancelableAbility.md +95 -43
  23. package/docs/api/classes/ClientToolTransport.md +31 -16
  24. package/docs/api/classes/ClientTools.md +868 -158
  25. package/docs/api/classes/CmdArgLexer.md +82 -0
  26. package/docs/api/classes/CmdArgParser.md +56 -0
  27. package/docs/api/classes/ConfigFile.md +6 -6
  28. package/docs/api/classes/EnvPromptTemplate.md +224 -52
  29. package/docs/api/classes/EventClient.md +902 -192
  30. package/docs/api/classes/EventEmitter.md +62 -12
  31. package/docs/api/classes/EventServer.md +895 -182
  32. package/docs/api/classes/EventToolFunc.md +801 -123
  33. package/docs/api/classes/FStringPromptTemplate.md +224 -52
  34. package/docs/api/classes/FewShotPromptTemplate.md +231 -59
  35. package/docs/api/classes/GolangPromptTemplate.md +224 -52
  36. package/docs/api/classes/HttpClientToolTransport.md +33 -19
  37. package/docs/api/classes/HttpServerToolTransport.md +15 -15
  38. package/docs/api/classes/IntSet.md +21 -21
  39. package/docs/api/classes/MailboxClientTransport.md +398 -0
  40. package/docs/api/classes/MailboxServerTransport.md +433 -0
  41. package/docs/api/classes/PromptExampleSelector.md +11 -11
  42. package/docs/api/classes/PromptTemplate.md +199 -51
  43. package/docs/api/classes/ReadableStreamError.md +2 -2
  44. package/docs/api/classes/ResClientTools.md +875 -165
  45. package/docs/api/classes/ResServerTools.md +869 -156
  46. package/docs/api/classes/RpcMethodsClientTool.md +870 -160
  47. package/docs/api/classes/RpcMethodsServerTool.md +865 -152
  48. package/docs/api/classes/SSEChannel.md +23 -23
  49. package/docs/api/classes/Semaphore.md +148 -76
  50. package/docs/api/classes/ServerToolTransport.md +14 -13
  51. package/docs/api/classes/ServerTools.md +854 -138
  52. package/docs/api/classes/SignalGate.md +12 -12
  53. package/docs/api/classes/SseClientPubSubTransport.md +4 -4
  54. package/docs/api/classes/SseServerPubSubTransport.md +13 -13
  55. package/docs/api/classes/TaskAbortController.md +33 -11
  56. package/docs/api/classes/ToolFunc.md +725 -119
  57. package/docs/api/classes/ToolTransport.md +7 -7
  58. package/docs/api/classes/YamlTypeBaseObject.md +2 -2
  59. package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
  60. package/docs/api/enumerations/AsyncFeatures.md +4 -4
  61. package/docs/api/enumerations/CmdArgTokenType.md +129 -0
  62. package/docs/api/enumerations/HashAlgorithm.md +38 -12
  63. package/docs/api/functions/AIArgProcessor.md +8 -17
  64. package/docs/api/functions/AIStream.md +1 -1
  65. package/docs/api/functions/ChoiceArgProcessor.md +13 -15
  66. package/docs/api/functions/DefaultDateFormat.md +1 -1
  67. package/docs/api/functions/ObjectArgsToArgsInfo.md +11 -9
  68. package/docs/api/functions/RateLimit.md +33 -6
  69. package/docs/api/functions/TemplateArgProcessor.md +13 -15
  70. package/docs/api/functions/assignDirs.md +1 -1
  71. package/docs/api/functions/beforeShutdown.md +3 -3
  72. package/docs/api/functions/calcPerplexity.md +3 -3
  73. package/docs/api/functions/calcPerplexitySimple.md +3 -3
  74. package/docs/api/functions/cmdArgEvaluate.md +28 -0
  75. package/docs/api/functions/cmdArgsToMergedObject.md +34 -0
  76. package/docs/api/functions/completeSentences.md +1 -1
  77. package/docs/api/functions/concatText.md +1 -1
  78. package/docs/api/functions/countLLMTokens.md +1 -1
  79. package/docs/api/functions/countRegexMatches.md +1 -1
  80. package/docs/api/functions/createCallbacksTransformer.md +23 -19
  81. package/docs/api/functions/createEmptyReadableStream.md +1 -1
  82. package/docs/api/functions/createEndWithRepetitionDetector.md +4 -4
  83. package/docs/api/functions/createEventStreamTransformer.md +1 -1
  84. package/docs/api/functions/createHfValueFunc.md +1 -1
  85. package/docs/api/functions/createLRUCache.md +1 -1
  86. package/docs/api/functions/createYamlObjectTag.md +1 -1
  87. package/docs/api/functions/dateToText.md +1 -1
  88. package/docs/api/functions/decodeCharset.md +1 -1
  89. package/docs/api/functions/defaultsWithConcat.md +1 -1
  90. package/docs/api/functions/detectCharset.md +1 -1
  91. package/docs/api/functions/encodeLLMTokens.md +1 -1
  92. package/docs/api/functions/ensureQuoted.md +3 -1
  93. package/docs/api/functions/evaluateExpression.md +40 -0
  94. package/docs/api/functions/eventable.md +1 -1
  95. package/docs/api/functions/expandConfig.md +1 -1
  96. package/docs/api/functions/expandEnv.md +1 -1
  97. package/docs/api/functions/expandObjEnv.md +1 -1
  98. package/docs/api/functions/expandPath.md +1 -1
  99. package/docs/api/functions/expandPathInObject.md +1 -1
  100. package/docs/api/functions/expandPaths.md +1 -1
  101. package/docs/api/functions/extNameLevel.md +1 -1
  102. package/docs/api/functions/extractCodeBlock.md +51 -0
  103. package/docs/api/functions/fileIsExists.md +3 -3
  104. package/docs/api/functions/filterValidFnScope.md +3 -3
  105. package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
  106. package/docs/api/functions/findPort.md +13 -5
  107. package/docs/api/functions/formatTextWithSpace.md +1 -1
  108. package/docs/api/functions/funcGetMeta.md +1 -1
  109. package/docs/api/functions/funcWithMeta.md +4 -4
  110. package/docs/api/functions/genUrlParamsStr.md +1 -1
  111. package/docs/api/functions/getAllEnumKeys.md +1 -1
  112. package/docs/api/functions/getConfigFileNames.md +1 -1
  113. package/docs/api/functions/getConfigs.md +1 -1
  114. package/docs/api/functions/getEnvVairables.md +1 -1
  115. package/docs/api/functions/getFileMetaInfo.md +1 -1
  116. package/docs/api/functions/getHashAlgoBySize.md +1 -1
  117. package/docs/api/functions/getKeysPath.md +1 -1
  118. package/docs/api/functions/getLLMTokenizer.md +1 -1
  119. package/docs/api/functions/getMultiLevelExtname.md +1 -1
  120. package/docs/api/functions/getPackageDir.md +1 -1
  121. package/docs/api/functions/getRealFilepath.md +1 -1
  122. package/docs/api/functions/getResponseErrorReadableStream.md +2 -2
  123. package/docs/api/functions/getXDGConfigs.md +1 -1
  124. package/docs/api/functions/hasDirectoryIn.md +3 -3
  125. package/docs/api/functions/hash.md +25 -4
  126. package/docs/api/functions/hashFile.md +1 -1
  127. package/docs/api/functions/hashObject.md +23 -1
  128. package/docs/api/functions/hashStream.md +25 -4
  129. package/docs/api/functions/initShutdown.md +1 -1
  130. package/docs/api/functions/isIdentifier.md +30 -0
  131. package/docs/api/functions/isLangUsingSpaces.md +1 -1
  132. package/docs/api/functions/isListItemString.md +3 -3
  133. package/docs/api/functions/isModelNameMatched.md +3 -3
  134. package/docs/api/functions/isPathIdentifier.md +23 -0
  135. package/docs/api/functions/isPunctuationChar.md +1 -1
  136. package/docs/api/functions/isQuoted.md +4 -1
  137. package/docs/api/functions/isRegExp.md +20 -1
  138. package/docs/api/functions/isSameString.md +1 -1
  139. package/docs/api/functions/isSectionString.md +3 -3
  140. package/docs/api/functions/isSentenceEnding.md +1 -1
  141. package/docs/api/functions/isSepLineString.md +3 -3
  142. package/docs/api/functions/isStrWrapped.md +3 -1
  143. package/docs/api/functions/isSubdirectory.md +1 -1
  144. package/docs/api/functions/isTitleString.md +3 -3
  145. package/docs/api/functions/isValidFilename.md +1 -1
  146. package/docs/api/functions/isValidFilepath.md +1 -1
  147. package/docs/api/functions/isWebStream.md +1 -1
  148. package/docs/api/functions/joinSplitWords.md +1 -1
  149. package/docs/api/functions/jsonFilterToWhere.md +1 -1
  150. package/docs/api/functions/jsonToMarkdownStr.md +1 -1
  151. package/docs/api/functions/loadAIConfig.md +1 -1
  152. package/docs/api/functions/loadConfig.md +1 -1
  153. package/docs/api/functions/loadConfigFile.md +1 -1
  154. package/docs/api/functions/loadFileFromPaths.md +1 -1
  155. package/docs/api/functions/loadTextFromPaths.md +1 -1
  156. package/docs/api/functions/lrucache.md +1 -1
  157. package/docs/api/functions/matchUrlProtocol.md +3 -3
  158. package/docs/api/functions/memoize.md +1 -1
  159. package/docs/api/functions/mergeArray.md +1 -1
  160. package/docs/api/functions/messagesToText.md +1 -1
  161. package/docs/api/functions/normalizePath.md +1 -1
  162. package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
  163. package/docs/api/functions/parseCommand.md +21 -4
  164. package/docs/api/functions/parseJsJson.md +1 -1
  165. package/docs/api/functions/parseJsJsonSimpleSync.md +1 -1
  166. package/docs/api/functions/parseObjectArguments.md +17 -33
  167. package/docs/api/functions/parseYaml.md +1 -1
  168. package/docs/api/functions/prependNewlineIfMultiline.md +39 -0
  169. package/docs/api/functions/pruneSubdirectories.md +1 -1
  170. package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
  171. package/docs/api/functions/quoteStr.md +4 -1
  172. package/docs/api/functions/readFilenamesRecursiveSync.md +1 -1
  173. package/docs/api/functions/readTextFileChunks.md +1 -1
  174. package/docs/api/functions/readTextFileChunksEx.md +1 -1
  175. package/docs/api/functions/readableFromAsyncIterable.md +1 -1
  176. package/docs/api/functions/registerCoreTools.md +1 -1
  177. package/docs/api/functions/registerYamlTag.md +2 -2
  178. package/docs/api/functions/removeMarkdownBold.md +1 -1
  179. package/docs/api/functions/removeMarkdownBoldAndItalic.md +1 -1
  180. package/docs/api/functions/removeMarkdownItalic.md +1 -1
  181. package/docs/api/functions/replaceWithPlaceholder.md +3 -18
  182. package/docs/api/functions/restoreFromPlacehoders.md +2 -20
  183. package/docs/api/functions/sanitizeFilename.md +1 -1
  184. package/docs/api/functions/sanitizeFilepath.md +1 -1
  185. package/docs/api/functions/saveConfigFile.md +1 -1
  186. package/docs/api/functions/scaleStrToParamsSize.md +1 -1
  187. package/docs/api/functions/shutdown.md +2 -2
  188. package/docs/api/functions/simplifyObjectArguments.md +4 -1
  189. package/docs/api/functions/simplifyResult.md +34 -0
  190. package/docs/api/functions/sleep.md +1 -1
  191. package/docs/api/functions/sortedValues.md +1 -1
  192. package/docs/api/functions/splitChunks.md +1 -1
  193. package/docs/api/functions/splitParagraph.md +1 -1
  194. package/docs/api/functions/splitSentence.md +1 -1
  195. package/docs/api/functions/splitWords.md +1 -1
  196. package/docs/api/functions/stringifyYaml.md +1 -1
  197. package/docs/api/functions/stripConsoleColor.md +1 -1
  198. package/docs/api/functions/textToDate.md +1 -1
  199. package/docs/api/functions/textify.md +43 -0
  200. package/docs/api/functions/toDateTime.md +3 -3
  201. package/docs/api/functions/toRegExp.md +1 -1
  202. package/docs/api/functions/trimStartOfStreamHelper.md +1 -1
  203. package/docs/api/functions/truncTo.md +1 -1
  204. package/docs/api/functions/truncateByToken.md +1 -1
  205. package/docs/api/functions/truncateToTokenLimit.md +1 -1
  206. package/docs/api/functions/truncateToTokenLimitEx.md +1 -1
  207. package/docs/api/functions/uuid.md +1 -1
  208. package/docs/api/functions/wrapEventEmitter.md +1 -1
  209. package/docs/api/functions/wrapFlagValue.md +29 -0
  210. package/docs/api/functions/xxhash.md +27 -6
  211. package/docs/api/functions/xxhash32.md +22 -4
  212. package/docs/api/functions/xxhash64.md +22 -4
  213. package/docs/api/functions/xxhashAsStr.md +27 -6
  214. package/docs/api/functions/yieldExec.md +1 -1
  215. package/docs/api/globals.md +51 -18
  216. package/docs/api/interfaces/AIChatAssistantMessageParam.md +14 -14
  217. package/docs/api/interfaces/AIChatContentPartBase.md +26 -0
  218. package/docs/api/interfaces/AIChatContentPartImage.md +15 -3
  219. package/docs/api/interfaces/AIChatContentPartText.md +15 -3
  220. package/docs/api/interfaces/AIChatMessageParamBase.md +9 -9
  221. package/docs/api/interfaces/AIChatMessageToolCall.md +12 -8
  222. package/docs/api/interfaces/AIChatSystemMessageParam.md +10 -10
  223. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  224. package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
  225. package/docs/api/interfaces/AIChatToolDefinition.md +45 -0
  226. package/docs/api/interfaces/AIChatToolFunc.md +5 -5
  227. package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
  228. package/docs/api/interfaces/AIChatToolMessageParam.md +13 -13
  229. package/docs/api/interfaces/AIChatToolParam.md +2 -2
  230. package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
  231. package/docs/api/interfaces/AIChatUserMessageParam.md +14 -14
  232. package/docs/api/interfaces/AIResult.md +7 -7
  233. package/docs/api/interfaces/AIStreamParser.md +2 -2
  234. package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
  235. package/docs/api/interfaces/BaseFunc.md +15 -15
  236. package/docs/api/interfaces/BaseFuncItem.md +16 -16
  237. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +9 -2
  238. package/docs/api/interfaces/BinarySemaphoreOptions.md +22 -5
  239. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +7 -5
  240. package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
  241. package/docs/api/interfaces/ClientFuncItem.md +70 -19
  242. package/docs/api/interfaces/CmdArgAIChoiceConfig.md +97 -0
  243. package/docs/api/interfaces/CmdArgArgsInfo.md +31 -0
  244. package/docs/api/interfaces/CmdArgContext.md +103 -0
  245. package/docs/api/interfaces/CmdArgFlagMetadata.md +21 -0
  246. package/docs/api/interfaces/CmdArgMapResult.md +41 -0
  247. package/docs/api/interfaces/CmdArgParseResult.md +51 -0
  248. package/docs/api/interfaces/CmdArgParsedCommand.md +41 -0
  249. package/docs/api/interfaces/CmdArgParserOptions.md +225 -0
  250. package/docs/api/interfaces/CmdArgProcessorResultOptions.md +22 -0
  251. package/docs/api/interfaces/CmdArgSimplifyOptions.md +101 -0
  252. package/docs/api/interfaces/CmdArgToken.md +51 -0
  253. package/docs/api/interfaces/EventClientFuncParams.md +5 -5
  254. package/docs/api/interfaces/EventServerFuncParams.md +21 -7
  255. package/docs/api/interfaces/FewShotPromptTemplateOptions.md +18 -6
  256. package/docs/api/interfaces/FuncItem.md +19 -15
  257. package/docs/api/interfaces/FuncParam.md +5 -5
  258. package/docs/api/interfaces/FuncParams.md +1 -1
  259. package/docs/api/interfaces/Funcs.md +1 -1
  260. package/docs/api/interfaces/HashAlgoParams.md +36 -5
  261. package/docs/api/interfaces/IClientToolTransport.md +24 -10
  262. package/docs/api/interfaces/IFileMetaInfo.md +8 -8
  263. package/docs/api/interfaces/IPubSubClientTransport.md +4 -4
  264. package/docs/api/interfaces/IPubSubServerTransport.md +14 -14
  265. package/docs/api/interfaces/IReadTextFileChunksOptions.md +11 -11
  266. package/docs/api/interfaces/IServerToolTransport.md +8 -8
  267. package/docs/api/interfaces/IToolTransport.md +5 -5
  268. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +10 -10
  269. package/docs/api/interfaces/JsonFilter.md +1 -1
  270. package/docs/api/interfaces/MailboxClientOptions.md +74 -0
  271. package/docs/api/interfaces/MailboxServerOptions.md +69 -0
  272. package/docs/api/interfaces/ProbabilityItem.md +4 -4
  273. package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
  274. package/docs/api/interfaces/PromptTemplateOptions.md +8 -0
  275. package/docs/api/interfaces/PubSubClientStream.md +11 -11
  276. package/docs/api/interfaces/PubSubServerSession.md +8 -8
  277. package/docs/api/interfaces/RegisterOptions.md +298 -0
  278. package/docs/api/interfaces/RemoteFuncItem.md +63 -20
  279. package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
  280. package/docs/api/interfaces/ResClientFuncParams.md +3 -3
  281. package/docs/api/interfaces/ResServerFuncParams.md +20 -6
  282. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +2 -2
  283. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +18 -4
  284. package/docs/api/interfaces/SanitizeFilenameOptions.md +3 -3
  285. package/docs/api/interfaces/SectionStringOptions.md +3 -3
  286. package/docs/api/interfaces/SemaphoreOptions.md +30 -7
  287. package/docs/api/interfaces/SemaphoreTaskItem.md +18 -5
  288. package/docs/api/interfaces/ServerFuncItem.md +71 -20
  289. package/docs/api/interfaces/ServerFuncParams.md +14 -4
  290. package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
  291. package/docs/api/interfaces/StreamCallbacksAndOptions.md +80 -7
  292. package/docs/api/interfaces/TaskAbortControllers.md +2 -2
  293. package/docs/api/interfaces/TaskPromise.md +6 -6
  294. package/docs/api/interfaces/TextifyInlineOptions.md +51 -0
  295. package/docs/api/interfaces/TextifyOptions.md +108 -0
  296. package/docs/api/interfaces/ToolFuncContext.md +73 -0
  297. package/docs/api/interfaces/ToolFuncPackage.md +4 -4
  298. package/docs/api/interfaces/ToolFuncRegistryIsolateOptions.md +41 -0
  299. package/docs/api/interfaces/UnregisterOptions.md +56 -0
  300. package/docs/api/type-aliases/AIChatContentPart.md +2 -2
  301. package/docs/api/type-aliases/AIChatMessageParam.md +1 -1
  302. package/docs/api/type-aliases/AIChatRole.md +2 -2
  303. package/docs/api/type-aliases/AIChatTemplateCaps.md +239 -0
  304. package/docs/api/type-aliases/AIChatToolChoiceParam.md +1 -1
  305. package/docs/api/type-aliases/AIMessageType.md +1 -1
  306. package/docs/api/type-aliases/AIModelNameRule.md +1 -1
  307. package/docs/api/type-aliases/AIModelNameRuleFn.md +1 -1
  308. package/docs/api/type-aliases/AIModelNameRules.md +1 -1
  309. package/docs/api/type-aliases/AITextGenerationFinishReason.md +1 -1
  310. package/docs/api/type-aliases/ActionName.md +1 -1
  311. package/docs/api/type-aliases/ArgProcessor.md +24 -0
  312. package/docs/api/type-aliases/ArrayMergeWay.md +1 -1
  313. package/docs/api/type-aliases/AsyncTaskId.md +1 -1
  314. package/docs/api/type-aliases/BeforeShutdownListener.md +1 -1
  315. package/docs/api/type-aliases/CmdArgFlagValue.md +14 -0
  316. package/docs/api/type-aliases/CmdArgFlagsRecord.md +13 -0
  317. package/docs/api/type-aliases/EventErrorListenerFn.md +1 -1
  318. package/docs/api/type-aliases/EventListenerFn.md +1 -1
  319. package/docs/api/type-aliases/FuncParamType.md +1 -1
  320. package/docs/api/type-aliases/PromptExamples.md +1 -1
  321. package/docs/api/type-aliases/PubSubClientId.md +1 -1
  322. package/docs/api/type-aliases/PubSubCtx.md +6 -6
  323. package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
  324. package/docs/api/type-aliases/SSEClient.md +5 -5
  325. package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +4 -1
  326. package/docs/api/type-aliases/SimplifiedResultType.md +14 -0
  327. package/docs/api/type-aliases/StreamCloseStatus.md +16 -0
  328. package/docs/api/type-aliases/TFunc.md +1 -1
  329. package/docs/api/type-aliases/TextifyInlineStyleMode.md +16 -0
  330. package/docs/api/type-aliases/TextifyStringQuoting.md +16 -0
  331. package/docs/api/type-aliases/UUIDVersions.md +3 -1
  332. package/docs/api/variables/AIChatRoles.md +2 -2
  333. package/docs/api/variables/AIMessageTypes.md +1 -1
  334. package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
  335. package/docs/api/variables/ActionNames.md +1 -1
  336. package/docs/api/variables/ArrayMergeWay.md +1 -1
  337. package/docs/api/variables/ArrayMergeWaySymbol.md +1 -1
  338. package/docs/api/variables/CMD_ARG_FLAG_SYMBOL.md +21 -0
  339. package/docs/api/variables/CMD_ARG_PROCESSOR_RESULT.md +22 -0
  340. package/docs/api/variables/CMD_ARG_UNRESOLVED_SYMBOL.md +16 -0
  341. package/docs/api/variables/ClientEventPrefix.md +2 -2
  342. package/docs/api/variables/ClientToolFuncSchema.md +27 -17
  343. package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
  344. package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +4 -1
  345. package/docs/api/variables/EventBusName.md +2 -2
  346. package/docs/api/variables/EventName.md +2 -2
  347. package/docs/api/variables/FilenameReservedRegex.md +1 -1
  348. package/docs/api/variables/FuncMetaSymbol.md +2 -2
  349. package/docs/api/variables/IDENTIFIER_REGEX.md +14 -0
  350. package/docs/api/variables/LLM_TOKENIZER_NAMES.md +1 -1
  351. package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  352. package/docs/api/variables/PASSING_SCORE.md +1 -1
  353. package/docs/api/variables/PATH_IDENTIFIER_REGEX.md +13 -0
  354. package/docs/api/variables/RESERVED_WORDS.md +13 -0
  355. package/docs/api/variables/RStreamErrCode.md +1 -1
  356. package/docs/api/variables/RemoteToolFuncSchema.md +36 -4
  357. package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
  358. package/docs/api/variables/RpcMethodsClientToolSchema.md +2 -2
  359. package/docs/api/variables/RpcMethodsServerToolSchema.md +2 -2
  360. package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
  361. package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  362. package/docs/api/variables/SecondaryCache.md +1 -1
  363. package/docs/api/variables/ServerToolFuncSchema.md +27 -17
  364. package/docs/api/variables/StrangeHumanName.md +1 -1
  365. package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
  366. package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
  367. package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
  368. package/docs/api/variables/ToolFuncSchema.md +13 -13
  369. package/docs/api/variables/WindowsReservedNameRegex.md +1 -1
  370. package/docs/api/variables/backendEventable.md +23 -3
  371. package/docs/api/variables/base32768.md +2 -2
  372. package/docs/api/variables/event.md +1 -1
  373. package/docs/api/variables/eventClient.md +1 -1
  374. package/docs/api/variables/eventServer.md +1 -1
  375. package/docs/api/variables/lrucache.md +1 -1
  376. package/docs/api/variables/makeToolFuncCancelable.md +23 -3
  377. package/docs/api/variables/wait.md +1 -1
  378. package/docs/transport.dev.md +206 -0
  379. package/package.json +12 -10
  380. package/dist/chunk-4FKBOPZI.mjs +0 -1
  381. package/dist/chunk-TGTHY57V.mjs +0 -1
  382. package/dist/find-port-qS1CZ9c-.d.mts +0 -3
  383. package/dist/find-port-qS1CZ9c-.d.ts +0 -3
  384. package/dist/index-BLW3R7VS.d.mts +0 -1826
  385. package/dist/index-BLW3R7VS.d.ts +0 -1826
  386. package/docs/api/@isdk/namespaces/uuidv5/README.md +0 -12
  387. package/docs/api/@isdk/namespaces/uuidv5/variables/DNS.md +0 -11
  388. package/docs/api/@isdk/namespaces/uuidv5/variables/URL.md +0 -11
  389. package/docs/api/functions/nanoid.md +0 -45
  390. package/docs/api/functions/parseObjectArgInfo.md +0 -33
  391. package/docs/api/functions/parseObjectArgumentInfos.md +0 -29
  392. package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +0 -46
  393. package/docs/api/functions/uuidParse.md +0 -21
  394. package/docs/api/functions/uuidStringify.md +0 -25
  395. package/docs/api/functions/uuidValidate.md +0 -21
  396. package/docs/api/functions/uuidVersion.md +0 -21
  397. package/docs/api/functions/uuidv1.md +0 -61
  398. package/docs/api/functions/uuidv4.md +0 -61
  399. package/docs/api/functions/uuidv5.md +0 -69
  400. package/docs/api/functions/uuidv6.md +0 -61
  401. package/docs/api/functions/uuidv7.md +0 -61
  402. package/docs/api/interfaces/AIChoiceConfig.md +0 -65
  403. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
  404. package/docs/api/interfaces/ParseObjectArgumentOptions.md +0 -89
  405. package/docs/api/variables/uuidNIL.md +0 -11
@@ -6,20 +6,28 @@
6
6
 
7
7
  # Function: findPort()
8
8
 
9
- > **findPort**(`port`, `portRetryCount`): `Promise`\<`number`\>
9
+ > **findPort**(`port`, `options?`): `Promise`\<`number`\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/find-port.ts:3](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/find-port.ts#L3)
11
+ Defined in: @isdk/util/dist/index.d.ts:1044
12
+
13
+ Finds an available port.
12
14
 
13
15
  ## Parameters
14
16
 
15
17
  ### port
16
18
 
17
- `string` | `number`
19
+ The starting port number or a string representation of it. Defaults to 0 (random port).
20
+
21
+ `string` | `number` | `undefined`
18
22
 
19
- ### portRetryCount
23
+ ### options?
20
24
 
21
- `number` = `10`
25
+ Either the retry count (number) or an options object.
26
+
27
+ `number` | `FindPortOptions`
22
28
 
23
29
  ## Returns
24
30
 
25
31
  `Promise`\<`number`\>
32
+
33
+ A promise that resolves to the available port number.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **formatTextWithSpace**(`input`, `options?`): `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/format-text-with-space.ts:25](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/format-text-with-space.ts#L25)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/format-text-with-space.ts:25](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/format-text-with-space.ts#L25)
12
12
 
13
13
  Formats the input text by replacing delimiters with spaces and optionally capitalizing the first letter of each word.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **funcGetMeta**(`fn`): `any`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:904](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L904)
11
+ Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:1001
12
12
 
13
13
  Retrieves metadata associated with a function or `ToolFunc` instance.
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: funcWithMeta()
8
8
 
9
- > **funcWithMeta**(`fn`, `meta`, `ignoreExists?`): `undefined` \| `Function` \| [`ToolFunc`](../classes/ToolFunc.md)
9
+ > **funcWithMeta**(`fn`, `meta`, `ignoreExists?`): `Function` \| [`ToolFunc`](../classes/ToolFunc.md) \| `undefined`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:886](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L886)
11
+ Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:994
12
12
 
13
13
  Attaches metadata to a function or `ToolFunc` object.
14
14
 
@@ -30,12 +30,12 @@ The metadata object to attach. The operation is skipped if this is not a non-nul
30
30
 
31
31
  ### ignoreExists?
32
32
 
33
- `boolean` = `true`
33
+ `boolean`
34
34
 
35
35
  If `true`, new metadata overwrites existing keys. If `false`, it merges deeply, preserving existing values.
36
36
 
37
37
  ## Returns
38
38
 
39
- `undefined` \| `Function` \| [`ToolFunc`](../classes/ToolFunc.md)
39
+ `Function` \| [`ToolFunc`](../classes/ToolFunc.md) \| `undefined`
40
40
 
41
41
  The updated function or `ToolFunc` with metadata, or `undefined` if the operation was skipped.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **genUrlParamsStr**(`objParam`, `omitQuestionMark?`): `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/gen-url-params.ts:7](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/gen-url-params.ts#L7)
11
+ Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:401
12
12
 
13
13
  Utility to serialize an object into a URL query parameter string.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getAllEnumKeys**\<`T`\>(`enumType`): keyof `T`[]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/get-all-enum-keys.ts:7](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/get-all-enum-keys.ts#L7)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/get-all-enum-keys.ts:7](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/get-all-enum-keys.ts#L7)
12
12
 
13
13
  Retrieves all string keys from the given enumeration(number).
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getConfigFileNames**(`directoryPath`, `filter?`): `string`[]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/config.ts:17](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/config.ts#L17)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/config.ts:17](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/config.ts#L17)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getConfigs**(`directoryPath`, `filter?`): `any`[]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/config.ts:41](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/config.ts#L41)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/config.ts:41](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/config.ts#L41)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getEnvVairables**(`value`): `string`[]
10
10
 
11
- Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:674
11
+ Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:751
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getFileMetaInfo**(`filepath`): `Promise`\<[`IFileMetaInfo`](../interfaces/IFileMetaInfo.md)\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:236](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/load-file-from-paths.ts#L236)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:236](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/load-file-from-paths.ts#L236)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getHashAlgoBySize**(`size`): [`HashAlgorithm`](../enumerations/HashAlgorithm.md)
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:249](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/load-file-from-paths.ts#L249)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:249](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/load-file-from-paths.ts#L249)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getKeysPath**\<`TValue`\>(`value`): `string`[]
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/get-keys-path.ts:21](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/get-keys-path.ts#L21)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/get-keys-path.ts:21](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/get-keys-path.ts#L21)
12
12
 
13
13
  Retrieves an array of all key paths as strings for a nested object or array.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getLLMTokenizer**(`modelId`): `Promise`\<`PreTrainedTokenizer`\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/llm-tokenizer.ts:58](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/llm-tokenizer.ts#L58)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/llm-tokenizer.ts:58](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/llm-tokenizer.ts#L58)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getMultiLevelExtname**(`filename`, `level?`): `string`
10
10
 
11
- Defined in: @isdk/util/dist/index.d.ts:191
11
+ Defined in: @isdk/util/dist/index.d.ts:192
12
12
 
13
13
  Retrieves multi-level file extension
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getPackageDir**(`cwd`): `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/get-package-dir.ts:18](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/get-package-dir.ts#L18)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/get-package-dir.ts:18](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/get-package-dir.ts#L18)
12
12
 
13
13
  Retrieves the package directory from the current working directory.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getRealFilepath**(`filepath`): `string`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:210](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/load-file-from-paths.ts#L210)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:210](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/load-file-from-paths.ts#L210)
12
12
 
13
13
  Resolves the real file path, handling symbolic links.
14
14
 
@@ -8,13 +8,13 @@
8
8
 
9
9
  > **getResponseErrorReadableStream**(`body?`): `ReadableStream`\<`any`\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/stream/error-readable-stream.ts#L12)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/stream/error-readable-stream.ts#L12)
12
12
 
13
13
  ## Parameters
14
14
 
15
15
  ### body?
16
16
 
17
- `null` | `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>
17
+ `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\> | `null`
18
18
 
19
19
  ## Returns
20
20
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **getXDGConfigs**(`config`): `object`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-config.ts:62](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/load-config.ts#L62)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-config.ts:62](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/load-config.ts#L62)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: hasDirectoryIn()
8
8
 
9
- > **hasDirectoryIn**(`dir`, `dirs?`): `undefined` \| `boolean`
9
+ > **hasDirectoryIn**(`dir`, `dirs?`): `boolean` \| `undefined`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/has-directory-in.ts:37](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/has-directory-in.ts#L37)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/has-directory-in.ts:37](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/has-directory-in.ts#L37)
12
12
 
13
13
  Checks if a given directory is a subdirectory of any directory in the provided array.
14
14
 
@@ -28,7 +28,7 @@ An array of directory paths.
28
28
 
29
29
  ## Returns
30
30
 
31
- `undefined` \| `boolean`
31
+ `boolean` \| `undefined`
32
32
 
33
33
  true if the given directory is a subdirectory of any directory in the array; otherwise, false.
34
34
 
@@ -6,9 +6,13 @@
6
6
 
7
7
  # Function: hash()
8
8
 
9
- > **hash**(`value`, `__namedParameters`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
9
+ > **hash**(`value`, `options?`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:31](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/hash/hash.ts#L31)
11
+ Defined in: @isdk/ai-tools/packages/hash/dist/index.d.ts:218
12
+
13
+ Hashes a given value.
14
+
15
+ The value can be a string, Buffer, ArrayBuffer, or any other type supported by `hash-wasm`.
12
16
 
13
17
  ## Parameters
14
18
 
@@ -16,10 +20,27 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:31](https://
16
20
 
17
21
  `IDataType`
18
22
 
19
- ### \_\_namedParameters
23
+ The value to hash.
24
+
25
+ ### options?
26
+
27
+ [`HashAlgoParams`](../interfaces/HashAlgoParams.md)
20
28
 
21
- [`HashAlgoParams`](../interfaces/HashAlgoParams.md) = `{}`
29
+ Hashing options.
22
30
 
23
31
  ## Returns
24
32
 
25
33
  `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
34
+
35
+ A promise that resolves to the hash result.
36
+
37
+ ## Example
38
+
39
+ ```typescript
40
+ const textHash = await hash('hello world');
41
+
42
+ const textHashAsHex = await hash('hello world', {
43
+ hashAlgo: HashAlgorithm.sha256,
44
+ outputType: 'hex'
45
+ });
46
+ ```
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **hashFile**(`filepath`, `options?`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:219](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/load-file-from-paths.ts#L219)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/load-file-from-paths.ts:219](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/load-file-from-paths.ts#L219)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,11 @@
8
8
 
9
9
  > **hashObject**(`value`, `options?`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:41](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/hash/hash.ts#L41)
11
+ Defined in: @isdk/ai-tools/packages/hash/dist/index.d.ts:239
12
+
13
+ Hashes a JavaScript object by first converting it to a canonical JSON string.
14
+
15
+ This ensures that objects with the same properties but different key order produce the same hash.
12
16
 
13
17
  ## Parameters
14
18
 
@@ -16,10 +20,28 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:41](https://
16
20
 
17
21
  `any`
18
22
 
23
+ The object to hash.
24
+
19
25
  ### options?
20
26
 
21
27
  [`HashAlgoParams`](../interfaces/HashAlgoParams.md)
22
28
 
29
+ Hashing options.
30
+
23
31
  ## Returns
24
32
 
25
33
  `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
34
+
35
+ A promise that resolves to the hash result.
36
+
37
+ ## Example
38
+
39
+ ```typescript
40
+ const obj1 = { a: 1, b: 2 };
41
+ const obj2 = { b: 2, a: 1 };
42
+
43
+ const hash1 = await hashObject(obj1);
44
+ const hash2 = await hashObject(obj2);
45
+
46
+ console.log(hash1 === hash2); // true
47
+ ```
@@ -6,9 +6,14 @@
6
6
 
7
7
  # Function: hashStream()
8
8
 
9
- > **hashStream**(`stream`, `__namedParameters`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
9
+ > **hashStream**(`stream`, `options?`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:16](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/hash/hash.ts#L16)
11
+ Defined in: @isdk/ai-tools/packages/hash/dist/index.d.ts:198
12
+
13
+ Hashes a readable stream of data.
14
+
15
+ This function is useful for hashing large files or data streams without loading the entire
16
+ content into memory.
12
17
 
13
18
  ## Parameters
14
19
 
@@ -16,10 +21,26 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/hash.ts:16](https://
16
21
 
17
22
  `ReadableStream`
18
23
 
19
- ### \_\_namedParameters
24
+ The readable stream to hash.
25
+
26
+ ### options?
27
+
28
+ [`HashAlgoParams`](../interfaces/HashAlgoParams.md)
20
29
 
21
- [`HashAlgoParams`](../interfaces/HashAlgoParams.md) = `{}`
30
+ Hashing options.
22
31
 
23
32
  ## Returns
24
33
 
25
34
  `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
35
+
36
+ A promise that resolves to the hash result.
37
+
38
+ ## Example
39
+
40
+ ```typescript
41
+ // In Node.js
42
+ import { createReadStream } from 'fs';
43
+ const stream = createReadStream('path/to/file');
44
+ const fileHash = await hashStream(stream);
45
+ console.log(fileHash);
46
+ ```
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **initShutdown**(): `void`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/node/before-shutdown.ts:103](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/node/before-shutdown.ts#L103)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/node/before-shutdown.ts:103](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/node/before-shutdown.ts#L103)
12
12
 
13
13
  ## Returns
14
14
 
@@ -0,0 +1,30 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / isIdentifier
6
+
7
+ # Function: isIdentifier()
8
+
9
+ > **isIdentifier**(`s`, `options?`): `boolean`
10
+
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:32](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L32)
12
+
13
+ Checks if a string is a valid JS identifier and not a reserved word.
14
+ Supports optional flag prefix stripping.
15
+
16
+ ## Parameters
17
+
18
+ ### s
19
+
20
+ `string`
21
+
22
+ ### options?
23
+
24
+ #### flagPrefix?
25
+
26
+ `string` \| `string`[]
27
+
28
+ ## Returns
29
+
30
+ `boolean`
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isLangUsingSpaces**(`isoCode`): `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:260](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L260)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:260](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L260)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: isListItemString()
8
8
 
9
- > **isListItemString**(`text`): `null` \| `RegExpExecArray`
9
+ > **isListItemString**(`text`): `RegExpExecArray` \| `null`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:223](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L223)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:223](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L223)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -18,4 +18,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:223](ht
18
18
 
19
19
  ## Returns
20
20
 
21
- `null` \| `RegExpExecArray`
21
+ `RegExpExecArray` \| `null`
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: isModelNameMatched()
8
8
 
9
- > **isModelNameMatched**(`modelName`, `rule?`): `undefined` \| `string` \| `RegExpExecArray`
9
+ > **isModelNameMatched**(`modelName`, `rule?`): `string` \| `RegExpExecArray` \| `undefined`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/is-model-name-matched.ts#L21)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/is-model-name-matched.ts#L21)
12
12
 
13
13
  Checks if the provided model name matches the given rule.
14
14
 
@@ -28,7 +28,7 @@ An optional rule that can be a string, an array of strings, a regular expression
28
28
 
29
29
  ## Returns
30
30
 
31
- `undefined` \| `string` \| `RegExpExecArray`
31
+ `string` \| `RegExpExecArray` \| `undefined`
32
32
 
33
33
  matched result if the model name matches the rule, undefined otherwise.
34
34
 
@@ -0,0 +1,23 @@
1
+ [**@isdk/ai-tool**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / isPathIdentifier
6
+
7
+ # Function: isPathIdentifier()
8
+
9
+ > **isPathIdentifier**(`s`): `boolean`
10
+
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:76](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L76)
12
+
13
+ Checks if a string is a valid path identifier (dot-separated identifiers).
14
+
15
+ ## Parameters
16
+
17
+ ### s
18
+
19
+ `string`
20
+
21
+ ## Returns
22
+
23
+ `boolean`
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isPunctuationChar**(`char`): `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:245](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L245)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:245](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L245)
12
12
 
13
13
  Checks if the given character is a punctuation mark.
14
14
  This function supports both Chinese and English punctuation marks.
@@ -8,7 +8,10 @@
8
8
 
9
9
  > **isQuoted**(`s`): `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:195](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/parse-command.ts#L195)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:85](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L85)
12
+
13
+ Checks if a string is wrapped in quotes (", ', `).
14
+ Leading and trailing whitespace are ignored.
12
15
 
13
16
  ## Parameters
14
17
 
@@ -8,7 +8,12 @@
8
8
 
9
9
  > **isRegExp**(`value`): `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/isRegExp.ts#L3)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/isRegExp.ts:21](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/isRegExp.ts#L21)
12
+
13
+ Checks if the provided value is a regular expression.
14
+
15
+ This function determines whether the given value is a regular expression
16
+ by using both string-based and object-based validation methods.
12
17
 
13
18
  ## Parameters
14
19
 
@@ -16,6 +21,20 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/isRegExp.ts:3](https://gi
16
21
 
17
22
  `any`
18
23
 
24
+ The value to be checked for being a regular expression
25
+
19
26
  ## Returns
20
27
 
21
28
  `boolean`
29
+
30
+ `true` if the value is a regular expression, otherwise `false`
31
+
32
+ ## Example
33
+
34
+ ```typescript
35
+ isRegExp(/abc/); // true
36
+ isRegExp(new RegExp('abc')); // true
37
+ isRegExp('/abc/'); // true
38
+ isRegExp('abc'); // false
39
+ isRegExp(123); // false
40
+ ```
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSameString**(`str1`, `str2`): `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/is-same-string.ts:13](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/is-same-string.ts#L13)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/is-same-string.ts:13](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/is-same-string.ts#L13)
12
12
 
13
13
  Compares two strings to check if they are the same.
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: isSectionString()
8
8
 
9
- > **isSectionString**(`text`, `options?`): `null` \| `RegExpExecArray`
9
+ > **isSectionString**(`text`, `options?`): `RegExpExecArray` \| `null`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L197)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L197)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -22,4 +22,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:197](ht
22
22
 
23
23
  ## Returns
24
24
 
25
- `null` \| `RegExpExecArray`
25
+ `RegExpExecArray` \| `null`
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSentenceEnding**(`text`): `boolean`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L187)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L187)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: isSepLineString()
8
8
 
9
- > **isSepLineString**(`text`): `null` \| `RegExpExecArray`
9
+ > **isSepLineString**(`text`): `RegExpExecArray` \| `null`
10
10
 
11
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L227)
11
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L227)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -18,4 +18,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:227](ht
18
18
 
19
19
  ## Returns
20
20
 
21
- `null` \| `RegExpExecArray`
21
+ `RegExpExecArray` \| `null`