@isdk/ai-tool 0.6.0 → 0.7.0

package/docs/api/interfaces/ClientFuncItem.md

@@ -0,0 +1,326 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ClientFuncItem
+
+# Interface: ClientFuncItem
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/client-tools.ts#L16)
+
+Alias for `RemoteFuncItem` on the client side.
+
+## Extends
+
+- [`RemoteFuncItem`](RemoteFuncItem.md)
+
+## Extended by
+
+- [`ClientTools`](../classes/ClientTools.md)
+
+## Properties
+
+### action?
+
+> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L95)
+
+The action to be used for the remote call. This typically represents an RPC method name.
+Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
+
+***
+
+### alias?
+
+> `optional` **alias**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
+
+Optional aliases for the function name.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`alias`](RemoteFuncItem.md#alias)
+
+***
+
+### ~~apiRoot?~~
+
+> `optional` **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L89)
+
+The root endpoint for the remote service.
+
+#### Deprecated
+
+Use `transport` instead.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
+
+***
+
+### asyncFeatures?
+
+> `optional` **asyncFeatures**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
+
+A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
+This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
+
+#### See
+
+AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
+
+#### Example
+
+```ts
+import { AsyncFeatures } from './utils';
+const func = new ToolFunc({
+  name: 'cancellableTask',
+  asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
+  // ...
+});
+```
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`asyncFeatures`](RemoteFuncItem.md#asyncfeatures)
+
+***
+
+### depends?
+
+> `optional` **depends**: `object`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L167)
+
+A map of dependencies this function has on other tool functions.
+Declaring dependencies ensures that they are automatically registered when this function is registered.
+This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
+
+#### Index Signature
+
+\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
+
+#### Example
+
+```ts
+const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
+const mainFunc = new ToolFunc({
+  name: 'main',
+  depends: {
+    helper: helperFunc,
+  },
+  func() {
+    // We can now safely run the dependency
+    const result = this.runSync('helper');
+    return `Hello, ${result}`;
+  }
+});
+// When mainFunc is registered, helperFunc will be registered automatically.
+mainFunc.register();
+```
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`depends`](RemoteFuncItem.md#depends)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L172)
+
+A detailed description of what the function does.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`description`](RemoteFuncItem.md#description)
+
+***
+
+### ~~fetchOptions?~~
+
+> `optional` **fetchOptions**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L101)
+
+Options to be passed to the underlying `fetch` call in an HTTP transport.
+
+#### Deprecated
+
+Use `transport` instead.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
+
+If true, indicates that this function should be treated as a server-side API.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
+
+The unique name of the function.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name-2)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L81)
+
+Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L86)
+
+The expected return type of the function, described as a string or a JSON schema object.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
+
+The execution scope or context (`this`) for the function.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
+
+A lifecycle hook called once during the `ToolFunc` instance's initialization.
+It allows for initial setup, state configuration, or property modification on the instance
+before it is used or registered. The `this` context is the `ToolFunc` instance itself.
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+The configuration options for the function.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```ts
+const myFunc = new ToolFunc({
+  name: 'myFunc',
+  customState: 'initial',
+  setup() {
+    // `this` is the myFunc instance
+    this.customState = 'configured';
+  }
+});
+console.log(myFunc.customState); // Outputs: 'configured'
+```
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
+
+If true, indicates that the function has the *capability* to stream its output.
+Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
+
+Tags for grouping or filtering functions.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)
+
+***
+
+### title?
+
+> `optional` **title**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
+
+A concise, human-readable title for the function, often used in UI or by AI.
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`title`](RemoteFuncItem.md#title)

package/docs/api/interfaces/EventClientFuncParams.md

@@ -0,0 +1,51 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventClientFuncParams
+
+# Interface: EventClientFuncParams
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-client.ts#L6)
+
+## Properties
+
+### act?
+
+> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-client.ts#L9)
+
+***
+
+### data?
+
+> `optional` **data**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-client.ts#L8)
+
+***
+
+### event?
+
+> `optional` **event**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-client.ts#L7)
+
+***
+
+### listener()?
+
+> `optional` **listener**: (...`args`) => `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-client.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-client.ts#L10)
+
+#### Parameters
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`void`

package/docs/api/interfaces/EventServerFuncParams.md

@@ -0,0 +1,73 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventServerFuncParams
+
+# Interface: EventServerFuncParams
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L14)
+
+Defines the structure for parameters passed to a `ServerTools` function.
+By convention, it includes optional `_req` and `_res` properties for direct
+access to the underlying transport's request and response objects (e.g., from Node.js http).
+
+## Extends
+
+- [`ServerFuncParams`](ServerFuncParams.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### \_req?
+
+> `optional` **\_req**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L15)
+
+The underlying request object from the transport layer (e.g., `IncomingMessage`).
+
+#### Inherited from
+
+[`ServerFuncParams`](ServerFuncParams.md).[`_req`](ServerFuncParams.md#_req)
+
+***
+
+### \_res?
+
+> `optional` **\_res**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L20)
+
+The underlying response or reply object from the transport layer (e.g., `ServerResponse`).
+
+#### Inherited from
+
+[`ServerFuncParams`](ServerFuncParams.md).[`_res`](ServerFuncParams.md#_res)
+
+***
+
+### act?
+
+> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:17](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L17)
+
+***
+
+### data?
+
+> `optional` **data**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:16](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L16)
+
+***
+
+### event?
+
+> `optional` **event**: `string` \| `string`[]
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/funcs/event-server.ts#L15)

package/docs/{interfaces → api/interfaces}/FewShotPromptTemplateOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: FewShotPromptTemplateOptions\<T\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/few-shot-prompt-template.ts#L10)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L10)
 
 ## Extends
 
@@ -26,7 +26,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](h
 
 > `optional` **compiledTemplate**: `any`
 
-Defined in: packages/template-engines/dist/index.d.ts:18
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:18
 
 #### Inherited from
 
@@ -38,7 +38,7 @@ Defined in: packages/template-engines/dist/index.d.ts:18
 
 > `optional` **data**: `Record`\<`string`, `any`\>
 
-Defined in: packages/template-engines/dist/index.d.ts:15
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:15
 
 #### Inherited from
 
@@ -50,7 +50,7 @@ Defined in: packages/template-engines/dist/index.d.ts:15
 
 > **examplePrompt**: [`PromptTemplateOptions`](PromptTemplateOptions.md) \| [`PromptTemplate`](../classes/PromptTemplate.md)
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/few-shot-prompt-template.ts#L19)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L19)
 
 An [PromptTemplate](../classes/PromptTemplate.md) used to format a single example.
 
@@ -60,7 +60,7 @@ An [PromptTemplate](../classes/PromptTemplate.md) used to format a single exampl
 
 > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/few-shot-prompt-template.ts#L14)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L14)
 
 The few shot examples to use in the prompt.
 
@@ -70,7 +70,7 @@ The few shot examples to use in the prompt.
 
 > `optional` **exampleSeparator**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/few-shot-prompt-template.ts#L24)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L24)
 
 String separator used to join the prefix, the examples, and suffix.
 
@@ -80,7 +80,7 @@ String separator used to join the prefix, the examples, and suffix.
 
 > `optional` **ignoreInitialize**: `boolean`
 
-Defined in: packages/template-engines/dist/index.d.ts:19
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:19
 
 #### Inherited from
 
@@ -88,11 +88,23 @@ Defined in: packages/template-engines/dist/index.d.ts:19
 
 ***
 
+### index?
+
+> `optional` **index**: `number`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:20
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`index`](PromptTemplateOptions.md#index)
+
+***
+
 ### inputVariables?
 
 > `optional` **inputVariables**: `string`[]
 
-Defined in: packages/template-engines/dist/index.d.ts:17
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:17
 
 #### Inherited from
 
@@ -104,7 +116,7 @@ Defined in: packages/template-engines/dist/index.d.ts:17
 
 > `optional` **prefix**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/few-shot-prompt-template.ts#L31)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L31)
 
 A prompt template string to put before the examples.
 
@@ -118,7 +130,7 @@ A prompt template string to put before the examples.
 
 > `optional` **suffix**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/prompt/few-shot-prompt-template.ts#L36)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L36)
 
 A prompt template string to put after the examples.
 
@@ -128,7 +140,7 @@ A prompt template string to put after the examples.
 
 > `optional` **template**: `string`
 
-Defined in: packages/template-engines/dist/index.d.ts:14
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:14
 
 #### Inherited from
 
@@ -140,7 +152,7 @@ Defined in: packages/template-engines/dist/index.d.ts:14
 
 > `optional` **templateFormat**: `string`
 
-Defined in: packages/template-engines/dist/index.d.ts:16
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:16
 
 #### Inherited from