@isdk/ai-tool 0.0.2

package/docs/interfaces/DotenvExpandOptions.md

@@ -0,0 +1,51 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvExpandOptions
+
+# Interface: DotenvExpandOptions
+
+## Table of contents
+
+### Properties
+
+- [error](DotenvExpandOptions.md#error)
+- [parsed](DotenvExpandOptions.md#parsed)
+- [processEnv](DotenvExpandOptions.md#processenv)
+
+## Properties
+
+### error
+
+• `Optional` **error**: `Error`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/template/env.ts#L188)
+
+___
+
+### parsed
+
+• `Optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
+
+Default: `object`
+
+Object coming from dotenv's parsed result.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/template/env.ts#L204)
+
+___
+
+### processEnv
+
+• `Optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
+
+Default: `process.env`
+
+Specify an object to write your secrets to. Defaults to process.env environment variables.
+
+example: `const processEnv = {}; require('dotenv').config({ processEnv: processEnv })`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/template/env.ts#L197)

package/docs/interfaces/DotenvExpandOutput.md

@@ -0,0 +1,30 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvExpandOutput
+
+# Interface: DotenvExpandOutput
+
+## Table of contents
+
+### Properties
+
+- [error](DotenvExpandOutput.md#error)
+- [parsed](DotenvExpandOutput.md#parsed)
+
+## Properties
+
+### error
+
+• `Optional` **error**: `Error`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/template/env.ts#L208)
+
+___
+
+### parsed
+
+• `Optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/template/env.ts#L209)

package/docs/interfaces/DotenvParseInput.md

@@ -0,0 +1,7 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvParseInput
+
+# Interface: DotenvParseInput
+
+## Indexable
+
+▪ [name: `string`]: `string` \| `undefined`

package/docs/interfaces/DotenvParseOutput.md

@@ -0,0 +1,7 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvParseOutput
+
+# Interface: DotenvParseOutput
+
+## Indexable
+
+▪ [name: `string`]: `string` \| `undefined`

package/docs/interfaces/DotenvPopulateInput.md

@@ -0,0 +1,7 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / DotenvPopulateInput
+
+# Interface: DotenvPopulateInput
+
+## Indexable
+
+▪ [name: `string`]: `string` \| `undefined`

package/docs/interfaces/EventClientFuncParams.md

@@ -0,0 +1,66 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / EventClientFuncParams
+
+# Interface: EventClientFuncParams
+
+## Table of contents
+
+### Properties
+
+- [act](EventClientFuncParams.md#act)
+- [data](EventClientFuncParams.md#data)
+- [event](EventClientFuncParams.md#event)
+- [listener](EventClientFuncParams.md#listener)
+
+## Properties
+
+### act
+
+• `Optional` **act**: ``"sub"`` \| ``"pub"`` \| ``"unsub"`` \| ``"init"``
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-client.ts#L8)
+
+___
+
+### data
+
+• `Optional` **data**: `any`
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-client.ts#L7)
+
+___
+
+### event
+
+• `Optional` **event**: `string` \| `string`[]
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-client.ts#L6)
+
+___
+
+### listener
+
+• `Optional` **listener**: (...`args`: `any`[]) => `void`
+
+#### Type declaration
+
+▸ (`...args`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `...args` | `any`[] |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-client.ts#L9)

package/docs/interfaces/EventServerFuncParams.md

@@ -0,0 +1,79 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / EventServerFuncParams
+
+# Interface: EventServerFuncParams
+
+Convention: Always pass _req, _res
+
+## Hierarchy
+
+- [`ServerFuncParams`](ServerFuncParams.md)
+
+  ↳ **`EventServerFuncParams`**
+
+## Table of contents
+
+### Properties
+
+- [\_req](EventServerFuncParams.md#_req)
+- [\_res](EventServerFuncParams.md#_res)
+- [act](EventServerFuncParams.md#act)
+- [data](EventServerFuncParams.md#data)
+- [event](EventServerFuncParams.md#event)
+
+## Properties
+
+### \_req
+
+• `Optional` **\_req**: `IncomingMessage`
+
+#### Inherited from
+
+[ServerFuncParams](ServerFuncParams.md).[_req](ServerFuncParams.md#_req)
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L9)
+
+___
+
+### \_res
+
+• `Optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
+
+#### Inherited from
+
+[ServerFuncParams](ServerFuncParams.md).[_res](ServerFuncParams.md#_res)
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L10)
+
+___
+
+### act
+
+• `Optional` **act**: ``"sub"`` \| ``"pub"`` \| ``"unsub"``
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-server.ts#L15)
+
+___
+
+### data
+
+• `Optional` **data**: `any`
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-server.ts#L14)
+
+___
+
+### event
+
+• `Optional` **event**: `string` \| `string`[]
+
+#### Defined in
+
+[packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/funcs/event-server.ts#L13)

package/docs/interfaces/FewShotPromptTemplateOptions.md

@@ -0,0 +1,179 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / FewShotPromptTemplateOptions
+
+# Interface: FewShotPromptTemplateOptions\<T\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+## Hierarchy
+
+- [`PromptTemplateOptions`](PromptTemplateOptions.md)
+
+  ↳ **`FewShotPromptTemplateOptions`**
+
+## Table of contents
+
+### Properties
+
+- [compiledTemplate](FewShotPromptTemplateOptions.md#compiledtemplate)
+- [data](FewShotPromptTemplateOptions.md#data)
+- [examplePrompt](FewShotPromptTemplateOptions.md#exampleprompt)
+- [exampleSeparator](FewShotPromptTemplateOptions.md#exampleseparator)
+- [examples](FewShotPromptTemplateOptions.md#examples)
+- [ignoreInitialize](FewShotPromptTemplateOptions.md#ignoreinitialize)
+- [inputVariables](FewShotPromptTemplateOptions.md#inputvariables)
+- [prefix](FewShotPromptTemplateOptions.md#prefix)
+- [suffix](FewShotPromptTemplateOptions.md#suffix)
+- [template](FewShotPromptTemplateOptions.md#template)
+- [templateFormat](FewShotPromptTemplateOptions.md#templateformat)
+
+## Properties
+
+### compiledTemplate
+
+• `Optional` **compiledTemplate**: `any`
+
+#### Inherited from
+
+[PromptTemplateOptions](PromptTemplateOptions.md).[compiledTemplate](PromptTemplateOptions.md#compiledtemplate)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L15)
+
+___
+
+### data
+
+• `Optional` **data**: `Record`\<`string`, `any`\>
+
+#### Inherited from
+
+[PromptTemplateOptions](PromptTemplateOptions.md).[data](PromptTemplateOptions.md#data)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L12)
+
+___
+
+### examplePrompt
+
+• **examplePrompt**: [`PromptTemplateOptions`](PromptTemplateOptions.md) \| [`PromptTemplate`](../classes/PromptTemplate.md)
+
+An [PromptTemplate](../classes/PromptTemplate.md) used to format a single example.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/few-shot-prompt-template.ts#L19)
+
+___
+
+### exampleSeparator
+
+• `Optional` **exampleSeparator**: `string`
+
+String separator used to join the prefix, the examples, and suffix.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/few-shot-prompt-template.ts#L24)
+
+___
+
+### examples
+
+• **examples**: [`PromptExamples`](../modules.md#promptexamples)\<`T`\>
+
+The few shot examples to use in the prompt.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/few-shot-prompt-template.ts#L14)
+
+___
+
+### ignoreInitialize
+
+• `Optional` **ignoreInitialize**: `boolean`
+
+#### Inherited from
+
+[PromptTemplateOptions](PromptTemplateOptions.md).[ignoreInitialize](PromptTemplateOptions.md#ignoreinitialize)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L16)
+
+___
+
+### inputVariables
+
+• `Optional` **inputVariables**: `string`[]
+
+#### Inherited from
+
+[PromptTemplateOptions](PromptTemplateOptions.md).[inputVariables](PromptTemplateOptions.md#inputvariables)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L14)
+
+___
+
+### prefix
+
+• `Optional` **prefix**: `string`
+
+A prompt template string to put before the examples.
+
+**`Default Value`**
+
+`""`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/few-shot-prompt-template.ts#L31)
+
+___
+
+### suffix
+
+• `Optional` **suffix**: `string`
+
+A prompt template string to put after the examples.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/few-shot-prompt-template.ts#L36)
+
+___
+
+### template
+
+• `Optional` **template**: `string`
+
+#### Inherited from
+
+[PromptTemplateOptions](PromptTemplateOptions.md).[template](PromptTemplateOptions.md#template)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L11)
+
+___
+
+### templateFormat
+
+• `Optional` **templateFormat**: `string`
+
+#### Inherited from
+
+[PromptTemplateOptions](PromptTemplateOptions.md).[templateFormat](PromptTemplateOptions.md#templateformat)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L13)

package/docs/interfaces/FuncItem.md

@@ -0,0 +1,130 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / FuncItem
+
+# Interface: FuncItem
+
+## Hierarchy
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+  ↳ **`FuncItem`**
+
+## Table of contents
+
+### Properties
+
+- [func](FuncItem.md#func)
+- [name](FuncItem.md#name)
+- [params](FuncItem.md#params)
+- [result](FuncItem.md#result)
+- [scope](FuncItem.md#scope)
+- [setup](FuncItem.md#setup)
+- [tags](FuncItem.md#tags)
+
+## Properties
+
+### func
+
+• `Optional` **func**: [`TFunc`](../modules.md#tfunc)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L30)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[name](BaseFuncItem.md#name)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
+
+___
+
+### params
+
+• `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[params](BaseFuncItem.md#params)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
+
+___
+
+### result
+
+• `Optional` **result**: `string`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[result](BaseFuncItem.md#result)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
+
+___
+
+### scope
+
+• `Optional` **scope**: `any`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[scope](BaseFuncItem.md#scope)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
+
+___
+
+### setup
+
+• `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
+
+#### Type declaration
+
+▸ (`this`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `this` | [`ToolFunc`](../classes/ToolFunc.md) |
+| `options?` | [`FuncItem`](FuncItem.md) |
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[setup](BaseFuncItem.md#setup)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string` \| `string`[]
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[tags](BaseFuncItem.md#tags)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)

package/docs/interfaces/FuncParam.md

@@ -0,0 +1,67 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / FuncParam
+
+# Interface: FuncParam
+
+## Table of contents
+
+### Properties
+
+- [depends](FuncParam.md#depends)
+- [description](FuncParam.md#description)
+- [name](FuncParam.md#name)
+- [required](FuncParam.md#required)
+- [type](FuncParam.md#type)
+
+## Properties
+
+### depends
+
+• `Optional` **depends**: `Object`
+
+#### Index signature
+
+▪ [name: `string`]: [`ToolFunc`](../classes/ToolFunc.md)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:11](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L11)
+
+___
+
+### description
+
+• `Optional` **description**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L10)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:7](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L7)
+
+___
+
+### required
+
+• `Optional` **required**: `boolean`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:9](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L9)
+
+___
+
+### type
+
+• `Optional` **type**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:8](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L8)

package/docs/interfaces/FuncParams.md

@@ -0,0 +1,7 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / FuncParams
+
+# Interface: FuncParams
+
+## Indexable
+
+▪ [name: `string`]: [`FuncParam`](FuncParam.md) \| [`FuncParamType`](../modules.md#funcparamtype)

package/docs/interfaces/Funcs.md

@@ -0,0 +1,7 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / Funcs
+
+# Interface: Funcs
+
+## Indexable
+
+▪ [name: `string`]: [`ToolFunc`](../classes/ToolFunc.md)

package/docs/interfaces/IOptions.md

@@ -0,0 +1,30 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / IOptions
+
+# Interface: IOptions
+
+## Table of contents
+
+### Properties
+
+- [exclude](IOptions.md#exclude)
+- [include](IOptions.md#include)
+
+## Properties
+
+### exclude
+
+• `Optional` **exclude**: `string` \| `string`[]
+
+#### Defined in
+
+node_modules/.pnpm/json-canonicalize@1.0.6/node_modules/json-canonicalize/types/canonicalize-ex.d.ts:2
+
+___
+
+### include
+
+• `Optional` **include**: `string`[]
+
+#### Defined in
+
+node_modules/.pnpm/json-canonicalize@1.0.6/node_modules/json-canonicalize/types/canonicalize-ex.d.ts:3

package/docs/interfaces/JsonFilter.md

@@ -0,0 +1,7 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / JsonFilter
+
+# Interface: JsonFilter
+
+## Indexable
+
+▪ [key: `string`]: `any`