@isdk/ai-tool 0.2.0 → 0.2.1

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 (248) hide show
  1. package/dist/chunk-TOUPOZHH.mjs +1 -0
  2. package/dist/funcs.d.mts +1 -1
  3. package/dist/funcs.d.ts +1 -1
  4. package/dist/funcs.js +1 -1
  5. package/dist/funcs.mjs +1 -1
  6. package/dist/{index-nP9lSU6E.d.mts → index-DUEs7T8M.d.mts} +2 -2
  7. package/dist/{index-nP9lSU6E.d.ts → index-DUEs7T8M.d.ts} +2 -2
  8. package/dist/index.d.mts +3 -3
  9. package/dist/index.d.ts +3 -3
  10. package/dist/index.js +1 -1
  11. package/dist/index.mjs +1 -1
  12. package/docs/README.md +5 -3
  13. package/docs/_media/CONTRIBUTING.md +18 -0
  14. package/docs/_media/LICENSE-MIT +22 -0
  15. package/docs/classes/AbortError.md +108 -129
  16. package/docs/classes/AlreadyExistsError.md +105 -126
  17. package/docs/classes/BaseError.md +112 -125
  18. package/docs/classes/CancelableAbility.md +136 -188
  19. package/docs/classes/ClientTools.md +1005 -1107
  20. package/docs/classes/CommonError.md +115 -136
  21. package/docs/classes/ConfigFile.md +150 -163
  22. package/docs/classes/EventClient.md +1128 -1282
  23. package/docs/classes/EventServer.md +1165 -1303
  24. package/docs/classes/EventToolFunc.md +958 -1028
  25. package/docs/classes/FStringPromptTemplate.md +352 -438
  26. package/docs/classes/FewShotPromptTemplate.md +364 -464
  27. package/docs/classes/GolangPromptTemplate.md +352 -438
  28. package/docs/classes/HFEnvironment.md +53 -79
  29. package/docs/classes/HFInterpreter.md +20 -377
  30. package/docs/classes/HFTemplate.md +21 -33
  31. package/docs/classes/HfPromptTemplate.md +352 -438
  32. package/docs/classes/IntSet.md +67 -100
  33. package/docs/classes/NotFoundError.md +105 -126
  34. package/docs/classes/NotImplementationError.md +105 -126
  35. package/docs/classes/PromptExampleSelector.md +58 -70
  36. package/docs/classes/PromptTemplate.md +338 -422
  37. package/docs/classes/ReadableStreamError.md +108 -129
  38. package/docs/classes/ResClientTools.md +916 -1026
  39. package/docs/classes/ResServerTools.md +919 -1026
  40. package/docs/classes/SSEChannel.md +93 -112
  41. package/docs/classes/Semaphore.md +44 -140
  42. package/docs/classes/ServerTools.md +981 -1072
  43. package/docs/classes/TaskAbortController.md +46 -66
  44. package/docs/classes/ToolFunc.md +840 -910
  45. package/docs/enumerations/AsyncFeatureBits.md +37 -0
  46. package/docs/enumerations/AsyncFeatures.md +37 -0
  47. package/docs/enumerations/ErrorCode.md +217 -0
  48. package/docs/enumerations/XXHashAlgorithm.md +27 -0
  49. package/docs/functions/AIArgProcessor.md +27 -0
  50. package/docs/functions/AIStream.md +50 -0
  51. package/docs/functions/ChoiceArgProcessor.md +27 -0
  52. package/docs/functions/RateLimit.md +33 -0
  53. package/docs/functions/TemplateArgProcessor.md +27 -0
  54. package/docs/functions/backendEventable.md +23 -0
  55. package/docs/functions/canonicalize.md +21 -0
  56. package/docs/functions/countRegexMatches.md +33 -0
  57. package/docs/functions/createAbilityInjector.md +87 -0
  58. package/docs/functions/createCallbacksTransformer.md +49 -0
  59. package/docs/functions/createEmptyReadableStream.md +23 -0
  60. package/docs/functions/createEndWithRepetitionDetector.md +29 -0
  61. package/docs/functions/createError.md +35 -0
  62. package/docs/functions/createEventStreamTransformer.md +33 -0
  63. package/docs/functions/createHfValueFunc.md +29 -0
  64. package/docs/functions/createLRUCache.md +23 -0
  65. package/docs/functions/dateToText.md +23 -0
  66. package/docs/functions/expandEnv.md +40 -0
  67. package/docs/functions/expandObjEnv.md +54 -0
  68. package/docs/functions/extNameLevel.md +43 -0
  69. package/docs/functions/fileIsExists.md +34 -0
  70. package/docs/functions/filenameReservedRegex.md +22 -0
  71. package/docs/functions/filterValidFnScope.md +21 -0
  72. package/docs/functions/findPort.md +23 -0
  73. package/docs/functions/formatISO.md +71 -0
  74. package/docs/functions/getAllEnumKeys.md +31 -0
  75. package/docs/functions/getConfigFileNames.md +23 -0
  76. package/docs/functions/getConfigs.md +23 -0
  77. package/docs/functions/getKeysPath.md +38 -0
  78. package/docs/functions/getMultiLevelExtname.md +31 -0
  79. package/docs/functions/getPackageDir.md +39 -0
  80. package/docs/functions/getRealFilepath.md +34 -0
  81. package/docs/functions/getResponseErrorReadableStream.md +21 -0
  82. package/docs/functions/hfParse.md +24 -0
  83. package/docs/functions/hfTokenize.md +25 -0
  84. package/docs/functions/interpolateEnv.md +25 -0
  85. package/docs/functions/interpolateFString.md +27 -0
  86. package/docs/functions/interpolateGolangTemplate.md +31 -0
  87. package/docs/functions/isModelNameMatched.md +45 -0
  88. package/docs/functions/isValidFilename.md +38 -0
  89. package/docs/functions/isValidFilepath.md +27 -0
  90. package/docs/functions/isWebStream.md +21 -0
  91. package/docs/functions/jsonFilterToWhere.md +45 -0
  92. package/docs/functions/jsonToMarkdownStr.md +31 -0
  93. package/docs/functions/loadFileFromPaths.md +54 -0
  94. package/docs/functions/loadTextFromPaths.md +29 -0
  95. package/docs/functions/lrucache.md +29 -0
  96. package/docs/functions/makeToolFuncCancelable.md +23 -0
  97. package/docs/functions/matchUrlProtocol.md +48 -0
  98. package/docs/functions/memoize.md +27 -0
  99. package/docs/functions/messagesToText.md +21 -0
  100. package/docs/functions/paramsSizeToScaleStr.md +32 -0
  101. package/docs/functions/parseCommand.md +33 -0
  102. package/docs/functions/parseDateFormat.md +360 -0
  103. package/docs/functions/parseFString.md +26 -0
  104. package/docs/functions/parseISO.md +72 -0
  105. package/docs/functions/parseJsJson.md +38 -0
  106. package/docs/functions/parseObjectArgInfo.md +27 -0
  107. package/docs/functions/parseObjectArgumentInfos.md +25 -0
  108. package/docs/functions/parseObjectArguments.md +68 -0
  109. package/docs/functions/parseObjectArgumentsAsArgInfos.md +42 -0
  110. package/docs/functions/parseYaml.md +21 -0
  111. package/docs/functions/quoteStr.md +21 -0
  112. package/docs/functions/reControlCharsRegex.md +21 -0
  113. package/docs/functions/readFilenamesRecursiveSync.md +47 -0
  114. package/docs/functions/readableFromAsyncIterable.md +28 -0
  115. package/docs/functions/registerCoreTools.md +17 -0
  116. package/docs/functions/registerYamlTag.md +21 -0
  117. package/docs/functions/sanitizeFilename.md +37 -0
  118. package/docs/functions/sanitizeFilepath.md +31 -0
  119. package/docs/functions/saveConfigFile.md +25 -0
  120. package/docs/functions/scaleStrToParamsSize.md +27 -0
  121. package/docs/functions/simplifyObjectArguments.md +21 -0
  122. package/docs/functions/sortedValues.md +25 -0
  123. package/docs/functions/splitSentence.md +37 -0
  124. package/docs/functions/stringifyYaml.md +49 -0
  125. package/docs/functions/textToDate.md +23 -0
  126. package/docs/functions/throwError.md +37 -0
  127. package/docs/functions/toDate.md +76 -0
  128. package/docs/functions/toDateTime.md +21 -0
  129. package/docs/functions/trimStartOfStreamHelper.md +41 -0
  130. package/docs/functions/truncTo.md +47 -0
  131. package/docs/functions/uuid.md +23 -0
  132. package/docs/functions/uuidParse.md +21 -0
  133. package/docs/functions/uuidStringify.md +23 -0
  134. package/docs/functions/uuidValidate.md +21 -0
  135. package/docs/functions/uuidVersion.md +21 -0
  136. package/docs/functions/uuidv1.md +47 -0
  137. package/docs/functions/uuidv4.md +47 -0
  138. package/docs/functions/uuidv5.md +51 -0
  139. package/docs/functions/wait.md +21 -0
  140. package/docs/functions/xxhash.md +25 -0
  141. package/docs/functions/xxhash32.md +23 -0
  142. package/docs/functions/xxhash64.md +23 -0
  143. package/docs/functions/xxhashAsStr.md +25 -0
  144. package/docs/globals.md +236 -0
  145. package/docs/interfaces/AIChatAssistantMessageParam.md +29 -38
  146. package/docs/interfaces/AIChatContentPartImage.md +11 -16
  147. package/docs/interfaces/AIChatContentPartText.md +9 -12
  148. package/docs/interfaces/AIChatMessageParamBase.md +12 -19
  149. package/docs/interfaces/AIChatMessageToolCall.md +18 -21
  150. package/docs/interfaces/AIChatSystemMessageParam.md +16 -22
  151. package/docs/interfaces/AIChatToolMessageParam.md +19 -26
  152. package/docs/interfaces/AIChatUserMessageParam.md +32 -42
  153. package/docs/interfaces/AIChoiceConfig.md +31 -39
  154. package/docs/interfaces/AIResult.md +26 -33
  155. package/docs/interfaces/AIStreamParser.md +24 -18
  156. package/docs/interfaces/AIStreamParserOptions.md +8 -10
  157. package/docs/interfaces/BaseFunc.md +55 -75
  158. package/docs/interfaces/BaseFuncItem.md +43 -61
  159. package/docs/interfaces/CancelableAbilityOptions.md +43 -54
  160. package/docs/interfaces/ClientFuncItem.md +66 -83
  161. package/docs/interfaces/DotenvExpandOptions.md +15 -19
  162. package/docs/interfaces/DotenvExpandOutput.md +11 -14
  163. package/docs/interfaces/DotenvParseInput.md +6 -2
  164. package/docs/interfaces/DotenvParseOutput.md +6 -2
  165. package/docs/interfaces/DotenvPopulateInput.md +6 -2
  166. package/docs/interfaces/EventClientFuncParams.md +22 -33
  167. package/docs/interfaces/EventServerFuncParams.md +27 -35
  168. package/docs/interfaces/FewShotPromptTemplateOptions.md +58 -74
  169. package/docs/interfaces/FuncItem.md +53 -70
  170. package/docs/interfaces/FuncParam.md +29 -36
  171. package/docs/interfaces/FuncParams.md +6 -2
  172. package/docs/interfaces/Funcs.md +6 -2
  173. package/docs/interfaces/JsonFilter.md +6 -2
  174. package/docs/interfaces/ParseObjectArgumentOptions.md +23 -29
  175. package/docs/interfaces/PromptExampleSelectorOptions.md +13 -16
  176. package/docs/interfaces/PromptTemplateOptions.md +31 -40
  177. package/docs/interfaces/RemoteFuncItem.md +64 -82
  178. package/docs/interfaces/ResClientFuncParams.md +14 -19
  179. package/docs/interfaces/ResServerFuncParams.md +28 -36
  180. package/docs/interfaces/SanitizeFilenameOptions.md +11 -14
  181. package/docs/interfaces/ServerFuncItem.md +70 -88
  182. package/docs/interfaces/ServerFuncParams.md +15 -20
  183. package/docs/interfaces/StreamCallbacksAndOptions.md +36 -65
  184. package/docs/interfaces/TaskAbortControllers.md +6 -2
  185. package/docs/interfaces/TaskPromise.md +48 -61
  186. package/docs/interfaces/ToolFuncPackage.md +18 -32
  187. package/docs/type-aliases/AIChatContentPart.md +13 -0
  188. package/docs/type-aliases/AIChatMessageParam.md +13 -0
  189. package/docs/type-aliases/AIChatRole.md +13 -0
  190. package/docs/type-aliases/AIMessageType.md +13 -0
  191. package/docs/type-aliases/AIModelNameRule.md +13 -0
  192. package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
  193. package/docs/type-aliases/AIModelNameRules.md +13 -0
  194. package/docs/type-aliases/AITextGenerationFinishReason.md +13 -0
  195. package/docs/type-aliases/ActionName.md +13 -0
  196. package/docs/type-aliases/AsyncTaskId.md +13 -0
  197. package/docs/type-aliases/EventErrorListenerFn.md +27 -0
  198. package/docs/type-aliases/EventListenerFn.md +25 -0
  199. package/docs/type-aliases/FStringPromptTemplateNode.md +16 -0
  200. package/docs/type-aliases/FuncParamType.md +13 -0
  201. package/docs/type-aliases/PromptExamples.md +17 -0
  202. package/docs/type-aliases/PromptTemplateType.md +13 -0
  203. package/docs/type-aliases/PromptType.md +13 -0
  204. package/docs/type-aliases/TFunc.md +23 -0
  205. package/docs/variables/AIChatRoles.md +13 -0
  206. package/docs/variables/AIMessageTypes.md +13 -0
  207. package/docs/variables/AITextGenerationFinishReasons.md +13 -0
  208. package/docs/variables/AbortErrorCode.md +13 -0
  209. package/docs/variables/ActionNames.md +13 -0
  210. package/docs/variables/AlreadyExistsErrorCode.md +13 -0
  211. package/docs/variables/ClientToolFuncSchema.md +87 -0
  212. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +13 -0
  213. package/docs/variables/EventBusName.md +13 -0
  214. package/docs/variables/EventName.md +13 -0
  215. package/docs/variables/FilenameReservedRegex.md +16 -0
  216. package/docs/variables/HFBuiltins.md +92 -0
  217. package/docs/variables/InternalErrorCode.md +13 -0
  218. package/docs/variables/NotFoundErrorCode.md +13 -0
  219. package/docs/variables/NotImplementedErrorCode.md +13 -0
  220. package/docs/variables/PASSING_SCORE.md +13 -0
  221. package/docs/variables/PromptTemplateTypes.md +13 -0
  222. package/docs/variables/PromptTypes.md +16 -0
  223. package/docs/variables/RStreamErrCode.md +13 -0
  224. package/docs/variables/RemoteToolFuncSchema.md +87 -0
  225. package/docs/variables/ResponseRStreamErrCode.md +13 -0
  226. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +13 -0
  227. package/docs/variables/ServerToolFuncSchema.md +87 -0
  228. package/docs/variables/ToolAsyncCancelableBit.md +13 -0
  229. package/docs/variables/ToolAsyncMultiTaskBit.md +13 -0
  230. package/docs/variables/ToolAsyncPriorityBit.md +13 -0
  231. package/docs/variables/ToolFuncSchema.md +125 -0
  232. package/docs/variables/WindowsReservedNameRegex.md +15 -0
  233. package/docs/variables/base32768.md +13 -0
  234. package/docs/variables/defaultTemplateFormat.md +13 -0
  235. package/docs/variables/event.md +13 -0
  236. package/docs/variables/eventClient.md +13 -0
  237. package/docs/variables/eventServer.md +13 -0
  238. package/docs/variables/lrucache.md +13 -0
  239. package/docs/variables/mimeType.md +13 -0
  240. package/docs/variables/uuidNIL.md +13 -0
  241. package/package.json +26 -27
  242. package/dist/chunk-W2LO3HZT.mjs +0 -1
  243. package/docs/.nojekyll +0 -1
  244. package/docs/enums/AsyncFeatureBits.md +0 -41
  245. package/docs/enums/AsyncFeatures.md +0 -41
  246. package/docs/enums/ErrorCode.md +0 -239
  247. package/docs/enums/XXHashAlgorithm.md +0 -30
  248. package/docs/modules.md +0 -4062
package/docs/interfaces/ClientFuncItem.md CHANGED
@@ -1,196 +1,179 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ClientFuncItem
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: ClientFuncItem
4
-
5
- ## Hierarchy
3
+ ***
6
4
 
7
- - [`RemoteFuncItem`](RemoteFuncItem.md)
5
+ [@isdk/ai-tool](../globals.md) / ClientFuncItem
8
6
 
9
- ↳ **`ClientFuncItem`**
7
+ # Interface: ClientFuncItem
10
8
 
11
- ↳↳ [`ClientTools`](../classes/ClientTools.md)
9
+ ## Extends
12
10
 
13
- ## Table of contents
11
+ - [`RemoteFuncItem`](RemoteFuncItem.md)
14
12
 
15
- ### Properties
13
+ ## Extended by
16
14
 
17
- - [action](ClientFuncItem.md#action)
18
- - [apiRoot](ClientFuncItem.md#apiroot)
19
- - [fetchOptions](ClientFuncItem.md#fetchoptions)
20
- - [isApi](ClientFuncItem.md#isapi)
21
- - [name](ClientFuncItem.md#name)
22
- - [params](ClientFuncItem.md#params)
23
- - [result](ClientFuncItem.md#result)
24
- - [scope](ClientFuncItem.md#scope)
25
- - [setup](ClientFuncItem.md#setup)
26
- - [stream](ClientFuncItem.md#stream)
27
- - [tags](ClientFuncItem.md#tags)
15
+ - [`ClientTools`](../classes/ClientTools.md)
28
16
 
29
17
  ## Properties
30
18
 
31
- ### action
19
+ ### action?
32
20
 
33
- • `Optional` **action**: ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"``
21
+ > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
34
22
 
35
23
  #### Inherited from
36
24
 
37
- [RemoteFuncItem](RemoteFuncItem.md).[action](RemoteFuncItem.md#action)
25
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
38
26
 
39
27
  #### Defined in
40
28
 
41
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/consts.ts#L35)
29
+ [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L35)
42
30
 
43
- ___
31
+ ***
44
32
 
45
- ### apiRoot
33
+ ### apiRoot?
46
34
 
47
- • `Optional` **apiRoot**: `string`
35
+ > `optional` **apiRoot**: `string`
48
36
 
49
37
  #### Inherited from
50
38
 
51
- [RemoteFuncItem](RemoteFuncItem.md).[apiRoot](RemoteFuncItem.md#apiroot)
39
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
52
40
 
53
41
  #### Defined in
54
42
 
55
- [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/consts.ts#L34)
43
+ [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L34)
56
44
 
57
- ___
45
+ ***
58
46
 
59
- ### fetchOptions
47
+ ### fetchOptions?
60
48
 
61
- • `Optional` **fetchOptions**: `any`
49
+ > `optional` **fetchOptions**: `any`
62
50
 
63
51
  #### Inherited from
64
52
 
65
- [RemoteFuncItem](RemoteFuncItem.md).[fetchOptions](RemoteFuncItem.md#fetchoptions)
53
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
66
54
 
67
55
  #### Defined in
68
56
 
69
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/consts.ts#L36)
57
+ [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L36)
70
58
 
71
- ___
59
+ ***
72
60
 
73
- ### isApi
61
+ ### isApi?
74
62
 
75
- • `Optional` **isApi**: `boolean`
63
+ > `optional` **isApi**: `boolean`
76
64
 
77
65
  #### Inherited from
78
66
 
79
- [RemoteFuncItem](RemoteFuncItem.md).[isApi](RemoteFuncItem.md#isapi)
67
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
80
68
 
81
69
  #### Defined in
82
70
 
83
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L47)
71
+ [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L47)
84
72
 
85
- ___
73
+ ***
86
74
 
87
- ### name
75
+ ### name?
88
76
 
89
- • `Optional` **name**: `string`
77
+ > `optional` **name**: `string`
90
78
 
91
79
  #### Inherited from
92
80
 
93
- [RemoteFuncItem](RemoteFuncItem.md).[name](RemoteFuncItem.md#name)
81
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
94
82
 
95
83
  #### Defined in
96
84
 
97
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L41)
85
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L41)
98
86
 
99
- ___
87
+ ***
100
88
 
101
- ### params
89
+ ### params?
102
90
 
103
- • `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
91
+ > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
104
92
 
105
93
  #### Inherited from
106
94
 
107
- [RemoteFuncItem](RemoteFuncItem.md).[params](RemoteFuncItem.md#params)
95
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
108
96
 
109
97
  #### Defined in
110
98
 
111
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L42)
99
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L42)
112
100
 
113
- ___
101
+ ***
114
102
 
115
- ### result
103
+ ### result?
116
104
 
117
- • `Optional` **result**: `string`
105
+ > `optional` **result**: `string`
118
106
 
119
107
  #### Inherited from
120
108
 
121
- [RemoteFuncItem](RemoteFuncItem.md).[result](RemoteFuncItem.md#result)
109
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
122
110
 
123
111
  #### Defined in
124
112
 
125
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L43)
113
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L43)
126
114
 
127
- ___
115
+ ***
128
116
 
129
- ### scope
117
+ ### scope?
130
118
 
131
- • `Optional` **scope**: `any`
119
+ > `optional` **scope**: `any`
132
120
 
133
121
  #### Inherited from
134
122
 
135
- [RemoteFuncItem](RemoteFuncItem.md).[scope](RemoteFuncItem.md#scope)
123
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
136
124
 
137
125
  #### Defined in
138
126
 
139
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L44)
140
-
141
- ___
127
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L44)
142
128
 
143
- ### setup
129
+ ***
144
130
 
145
- • `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
131
+ ### setup()?
146
132
 
147
- #### Type declaration
133
+ > `optional` **setup**: (`this`, `options`?) => `void`
148
134
 
149
- ▸ (`this`, `options?`): `void`
135
+ #### Parameters
150
136
 
151
- ##### Parameters
137
+ • **this**: [`ToolFunc`](../classes/ToolFunc.md)
152
138
 
153
- | Name | Type |
154
- | :------ | :------ |
155
- | `this` | [`ToolFunc`](../classes/ToolFunc.md) |
156
- | `options?` | [`FuncItem`](FuncItem.md) |
139
+ • **options?**: [`FuncItem`](FuncItem.md)
157
140
 
158
- ##### Returns
141
+ #### Returns
159
142
 
160
143
  `void`
161
144
 
162
145
  #### Inherited from
163
146
 
164
- [RemoteFuncItem](RemoteFuncItem.md).[setup](RemoteFuncItem.md#setup)
147
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
165
148
 
166
149
  #### Defined in
167
150
 
168
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L46)
151
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L46)
169
152
 
170
- ___
153
+ ***
171
154
 
172
- ### stream
155
+ ### stream?
173
156
 
174
- • `Optional` **stream**: `boolean`
157
+ > `optional` **stream**: `boolean`
175
158
 
176
159
  #### Inherited from
177
160
 
178
- [RemoteFuncItem](RemoteFuncItem.md).[stream](RemoteFuncItem.md#stream)
161
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
179
162
 
180
163
  #### Defined in
181
164
 
182
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L48)
165
+ [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L48)
183
166
 
184
- ___
167
+ ***
185
168
 
186
- ### tags
169
+ ### tags?
187
170
 
188
- • `Optional` **tags**: `string` \| `string`[]
171
+ > `optional` **tags**: `string` \| `string`[]
189
172
 
190
173
  #### Inherited from
191
174
 
192
- [RemoteFuncItem](RemoteFuncItem.md).[tags](RemoteFuncItem.md#tags)
175
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)
193
176
 
194
177
  #### Defined in
195
178
 
196
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L45)
179
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L45)
package/docs/interfaces/DotenvExpandOptions.md CHANGED
@@ -1,30 +1,26 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvExpandOptions
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: DotenvExpandOptions
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@isdk/ai-tool](../globals.md) / DotenvExpandOptions
8
6
 
9
- - [error](DotenvExpandOptions.md#error)
10
- - [parsed](DotenvExpandOptions.md#parsed)
11
- - [processEnv](DotenvExpandOptions.md#processenv)
7
+ # Interface: DotenvExpandOptions
12
8
 
13
9
  ## Properties
14
10
 
15
- ### error
11
+ ### error?
16
12
 
17
- • `Optional` **error**: `Error`
13
+ > `optional` **error**: `Error`
18
14
 
19
15
  #### Defined in
20
16
 
21
- [packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/template/env.ts#L188)
17
+ [packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L188)
22
18
 
23
- ___
19
+ ***
24
20
 
25
- ### parsed
21
+ ### parsed?
26
22
 
27
- • `Optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
23
+ > `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
28
24
 
29
25
  Default: `object`
30
26
 
@@ -32,13 +28,13 @@ Object coming from dotenv's parsed result.
32
28
 
33
29
  #### Defined in
34
30
 
35
- [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/template/env.ts#L204)
31
+ [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L204)
36
32
 
37
- ___
33
+ ***
38
34
 
39
- ### processEnv
35
+ ### processEnv?
40
36
 
41
- • `Optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
37
+ > `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
42
38
 
43
39
  Default: `process.env`
44
40
 
@@ -48,4 +44,4 @@ example: `const processEnv = {}; require('dotenv').config({ processEnv: processE
48
44
 
49
45
  #### Defined in
50
46
 
51
- [packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/template/env.ts#L197)
47
+ [packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L197)
package/docs/interfaces/DotenvExpandOutput.md CHANGED
@@ -1,30 +1,27 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvExpandOutput
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: DotenvExpandOutput
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@isdk/ai-tool](../globals.md) / DotenvExpandOutput
8
6
 
9
- - [error](DotenvExpandOutput.md#error)
10
- - [parsed](DotenvExpandOutput.md#parsed)
7
+ # Interface: DotenvExpandOutput
11
8
 
12
9
  ## Properties
13
10
 
14
- ### error
11
+ ### error?
15
12
 
16
- • `Optional` **error**: `Error`
13
+ > `optional` **error**: `Error`
17
14
 
18
15
  #### Defined in
19
16
 
20
- [packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/template/env.ts#L208)
17
+ [packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L208)
21
18
 
22
- ___
19
+ ***
23
20
 
24
- ### parsed
21
+ ### parsed?
25
22
 
26
- • `Optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
23
+ > `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
27
24
 
28
25
  #### Defined in
29
26
 
30
- [packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/template/env.ts#L209)
27
+ [packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/env.ts#L209)
package/docs/interfaces/DotenvParseInput.md CHANGED
@@ -1,7 +1,11 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvParseInput
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / DotenvParseInput
2
6
 
3
7
  # Interface: DotenvParseInput
4
8
 
5
9
  ## Indexable
6
10
 
7
- ▪ [name: `string`]: `string` \| `undefined`
11
+ \[`name`: `string`\]: `string` \| `undefined`
package/docs/interfaces/DotenvParseOutput.md CHANGED
@@ -1,7 +1,11 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvParseOutput
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / DotenvParseOutput
2
6
 
3
7
  # Interface: DotenvParseOutput
4
8
 
5
9
  ## Indexable
6
10
 
7
- ▪ [name: `string`]: `string` \| `undefined`
11
+ \[`name`: `string`\]: `string` \| `undefined`
package/docs/interfaces/DotenvPopulateInput.md CHANGED
@@ -1,7 +1,11 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvPopulateInput
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / DotenvPopulateInput
2
6
 
3
7
  # Interface: DotenvPopulateInput
4
8
 
5
9
  ## Indexable
6
10
 
7
- ▪ [name: `string`]: `string` \| `undefined`
11
+ \[`name`: `string`\]: `string` \| `undefined`
package/docs/interfaces/EventClientFuncParams.md CHANGED
@@ -1,66 +1,55 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / EventClientFuncParams
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: EventClientFuncParams
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@isdk/ai-tool](../globals.md) / EventClientFuncParams
8
6
 
9
- - [act](EventClientFuncParams.md#act)
10
- - [data](EventClientFuncParams.md#data)
11
- - [event](EventClientFuncParams.md#event)
12
- - [listener](EventClientFuncParams.md#listener)
7
+ # Interface: EventClientFuncParams
13
8
 
14
9
  ## Properties
15
10
 
16
- ### act
11
+ ### act?
17
12
 
18
- • `Optional` **act**: ``"sub"`` \| ``"pub"`` \| ``"unsub"`` \| ``"init"``
13
+ > `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
19
14
 
20
15
  #### Defined in
21
16
 
22
- [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-client.ts#L8)
17
+ [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-client.ts#L8)
23
18
 
24
- ___
19
+ ***
25
20
 
26
- ### data
21
+ ### data?
27
22
 
28
- • `Optional` **data**: `any`
23
+ > `optional` **data**: `any`
29
24
 
30
25
  #### Defined in
31
26
 
32
- [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-client.ts#L7)
27
+ [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-client.ts#L7)
33
28
 
34
- ___
29
+ ***
35
30
 
36
- ### event
31
+ ### event?
37
32
 
38
- • `Optional` **event**: `string` \| `string`[]
33
+ > `optional` **event**: `string` \| `string`[]
39
34
 
40
35
  #### Defined in
41
36
 
42
- [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-client.ts#L6)
43
-
44
- ___
45
-
46
- ### listener
37
+ [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-client.ts#L6)
47
38
 
48
- • `Optional` **listener**: (...`args`: `any`[]) => `void`
39
+ ***
49
40
 
50
- #### Type declaration
41
+ ### listener()?
51
42
 
52
- ▸ (`...args`): `void`
43
+ > `optional` **listener**: (...`args`) => `void`
53
44
 
54
- ##### Parameters
45
+ #### Parameters
55
46
 
56
- | Name | Type |
57
- | :------ | :------ |
58
- | `...args` | `any`[] |
47
+ • ...**args**: `any`[]
59
48
 
60
- ##### Returns
49
+ #### Returns
61
50
 
62
51
  `void`
63
52
 
64
53
  #### Defined in
65
54
 
66
- [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-client.ts#L9)
55
+ [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-client.ts#L9)
package/docs/interfaces/EventServerFuncParams.md CHANGED
@@ -1,79 +1,71 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / EventServerFuncParams
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / EventServerFuncParams
2
6
 
3
7
  # Interface: EventServerFuncParams
4
8
 
5
9
  Convention: Always pass _req, _res
6
10
 
7
- ## Hierarchy
11
+ ## Extends
8
12
 
9
13
  - [`ServerFuncParams`](ServerFuncParams.md)
10
14
 
11
- ↳ **`EventServerFuncParams`**
12
-
13
- ## Table of contents
14
-
15
- ### Properties
16
-
17
- - [\_req](EventServerFuncParams.md#_req)
18
- - [\_res](EventServerFuncParams.md#_res)
19
- - [act](EventServerFuncParams.md#act)
20
- - [data](EventServerFuncParams.md#data)
21
- - [event](EventServerFuncParams.md#event)
22
-
23
15
  ## Properties
24
16
 
25
- ### \_req
17
+ ### \_req?
26
18
 
27
- • `Optional` **\_req**: `IncomingMessage`
19
+ > `optional` **\_req**: `IncomingMessage`
28
20
 
29
21
  #### Inherited from
30
22
 
31
- [ServerFuncParams](ServerFuncParams.md).[_req](ServerFuncParams.md#_req)
23
+ [`ServerFuncParams`](ServerFuncParams.md).[`_req`](ServerFuncParams.md#_req)
32
24
 
33
25
  #### Defined in
34
26
 
35
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L9)
27
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L9)
36
28
 
37
- ___
29
+ ***
38
30
 
39
- ### \_res
31
+ ### \_res?
40
32
 
41
- • `Optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
33
+ > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
42
34
 
43
35
  #### Inherited from
44
36
 
45
- [ServerFuncParams](ServerFuncParams.md).[_res](ServerFuncParams.md#_res)
37
+ [`ServerFuncParams`](ServerFuncParams.md).[`_res`](ServerFuncParams.md#_res)
46
38
 
47
39
  #### Defined in
48
40
 
49
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L10)
41
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L10)
50
42
 
51
- ___
43
+ ***
52
44
 
53
- ### act
45
+ ### act?
54
46
 
55
- • `Optional` **act**: ``"sub"`` \| ``"pub"`` \| ``"unsub"``
47
+ > `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
56
48
 
57
49
  #### Defined in
58
50
 
59
- [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-server.ts#L15)
51
+ [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-server.ts#L15)
60
52
 
61
- ___
53
+ ***
62
54
 
63
- ### data
55
+ ### data?
64
56
 
65
- • `Optional` **data**: `any`
57
+ > `optional` **data**: `any`
66
58
 
67
59
  #### Defined in
68
60
 
69
- [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-server.ts#L14)
61
+ [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-server.ts#L14)
70
62
 
71
- ___
63
+ ***
72
64
 
73
- ### event
65
+ ### event?
74
66
 
75
- • `Optional` **event**: `string` \| `string`[]
67
+ > `optional` **event**: `string` \| `string`[]
76
68
 
77
69
  #### Defined in
78
70
 
79
- [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/funcs/event-server.ts#L13)
71
+ [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/funcs/event-server.ts#L13)