npm - @isdk/ai-tool - Versions diffs - 0.6.0 → 0.7.1 - Mend

@isdk/ai-tool 0.6.0 → 0.7.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 (473) hide show

package/docs/interfaces/ServerFuncItem.md DELETED Viewed

@@ -1,183 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / ServerFuncItem
-# Interface: ServerFuncItem
-Defined in: [packages/ai-tool/src/server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L13)
-## Extends
-- [`RemoteFuncItem`](RemoteFuncItem.md)
-## Extended by
-- [`ServerTools`](../classes/ServerTools.md)
-## Properties
-### action?
-> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
-Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L35)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
-***
-### alias?
-> `optional` **alias**: `string` \| `string`[]
-Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L31)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`alias`](RemoteFuncItem.md#alias)
-***
-### allowExportFunc?
-> `optional` **allowExportFunc**: `boolean`
-Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L14)
-***
-### apiRoot?
-> `optional` **apiRoot**: `string`
-Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L34)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
-***
-### fetchOptions?
-> `optional` **fetchOptions**: `any`
-Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L36)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
-***
-### isApi?
-> `optional` **isApi**: `boolean`
-Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L29)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
-***
-### name?
-> `optional` **name**: `string`
-Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L23)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
-***
-### params?
-> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
-Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L24)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
-***
-### result?
-> `optional` **result**: `string`
-Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L25)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
-***
-### scope?
-> `optional` **scope**: `any`
-Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L26)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
-***
-### setup()?
-> `optional` **setup**: (`this`, `options`?) => `void`
-Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L28)
-#### Parameters
-##### this
-[`ToolFunc`](../classes/ToolFunc.md)
-##### options?
-[`FuncItem`](FuncItem.md)
-#### Returns
-`void`
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
-***
-### stream?
-> `optional` **stream**: `boolean`
-Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L30)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
-***
-### tags?
-> `optional` **tags**: `string` \| `string`[]
-Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L27)
-#### Inherited from
-[`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)

package/docs/interfaces/ServerFuncParams.md DELETED Viewed

@@ -1,35 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / ServerFuncParams
-# Interface: ServerFuncParams
-Defined in: [packages/ai-tool/src/server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L8)
-Convention: Always pass _req, _res
-## Extended by
-- [`EventServerFuncParams`](EventServerFuncParams.md)
-## Indexable
-\[`name`: `string`\]: `any`
-## Properties
-### \_req?
-> `optional` **\_req**: `IncomingMessage`
-Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L9)
-***
-### \_res?
-> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
-Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/server-tools.ts#L10)

package/docs/interfaces/SplitSentenceOptions.md DELETED Viewed

@@ -1,41 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / SplitSentenceOptions
-# Interface: SplitSentenceOptions
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:25](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L25)
-## Properties
-### best?
-> `optional` **best**: `boolean`
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:26](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L26)
-***
-### completeSentence?
-> `optional` **completeSentence**: `boolean`
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:27](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L27)
-***
-### ignoreEmptyLine?
-> `optional` **ignoreEmptyLine**: `boolean`
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L29)
-***
-### isMarkdown?
-> `optional` **isMarkdown**: `boolean`
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:28](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L28)

package/docs/interfaces/ToolFuncPackage.md DELETED Viewed

@@ -1,47 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / ToolFuncPackage
-# Interface: ToolFuncPackage
-Defined in: [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L46)
-## Properties
-### name
-> **name**: `string`
-Defined in: [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L47)
-***
-### register()
-> **register**: (`data`?) => `void`
-Defined in: [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L48)
-#### Parameters
-##### data?
-`any`
-#### Returns
-`void`
-***
-### unregister()?
-> `optional` **unregister**: () => `void`
-Defined in: [packages/ai-tool/src/tool-func.ts:49](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L49)
-#### Returns
-`void`

package/docs/type-aliases/AIModelNameRule.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / AIModelNameRule
-# Type Alias: AIModelNameRule
-> **AIModelNameRule**: `string` \| `RegExp` \| [`AIModelNameRuleFn`](AIModelNameRuleFn.md)
-Defined in: [packages/ai-tool/src/utils/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L10)

package/docs/type-aliases/AIModelNameRuleFn.md DELETED Viewed

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / AIModelNameRuleFn
-# Type Alias: AIModelNameRuleFn()
-> **AIModelNameRuleFn**: (`name`) => `string` \| `RegExpExecArray` \| `undefined`
-Defined in: [packages/ai-tool/src/utils/consts.ts:8](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L8)
-## Parameters
-### name
-`string`
-## Returns
-`string` \| `RegExpExecArray` \| `undefined`

package/docs/type-aliases/AIModelNameRules.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / AIModelNameRules
-# Type Alias: AIModelNameRules
-> **AIModelNameRules**: [`AIModelNameRule`](AIModelNameRule.md) \| [`AIModelNameRule`](AIModelNameRule.md)[]
-Defined in: [packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L11)

package/docs/type-aliases/ActionName.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / ActionName
-# Type Alias: ActionName
-> **ActionName**: *typeof* [`ActionNames`](../variables/ActionNames.md)\[`number`\]
-Defined in: [packages/ai-tool/src/utils/consts.ts:6](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L6)

package/docs/type-aliases/AsyncTaskId.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / AsyncTaskId
-# Type Alias: AsyncTaskId
-> **AsyncTaskId**: `string` \| `number`
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:27](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L27)

package/docs/type-aliases/FuncParamType.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / FuncParamType
-# Type Alias: FuncParamType
-> **FuncParamType**: `string`
-Defined in: [packages/ai-tool/src/tool-func.ts:6](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L6)

package/docs/type-aliases/TFunc.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / TFunc
-# Type Alias: TFunc()
-> **TFunc**: (`this`, ...`params`) => `any`
-Defined in: [packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/tool-func.ts#L20)
-## Parameters
-### this
-[`ToolFunc`](../classes/ToolFunc.md)
-### params
-...`any`[]
-## Returns
-`any`

package/docs/variables/ActionNames.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / ActionNames
-# Variable: ActionNames
-> `const` **ActionNames**: readonly \[`"get"`, `"post"`, `"put"`, `"delete"`, `"patch"`, `"list"`, `"res"`\]
-Defined in: [packages/ai-tool/src/utils/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L5)

package/docs/variables/ClientToolFuncSchema.md DELETED Viewed

@@ -1,101 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / ClientToolFuncSchema
-# Variable: ClientToolFuncSchema
-> `const` **ClientToolFuncSchema**: `object`
-Defined in: [packages/ai-tool/src/client-tools.ts:159](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/client-tools.ts#L159)
-## Type declaration
-### action
-> **action**: `object`
-#### action.type
-> **type**: `string` = `'string'`
-#### action.assign()
-##### Parameters
-###### value
-`"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
-###### dest
-`any`
-###### src?
-`any`
-###### name?
-`string`
-###### options?
-`any`
-##### Returns
-`"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
-### allowExportFunc
-> **allowExportFunc**: `object`
-#### allowExportFunc.type
-> **type**: `string` = `'boolean'`
-### apiRoot
-> **apiRoot**: `object`
-#### apiRoot.type
-> **type**: `string` = `'string'`
-#### apiRoot.get()
-##### Parameters
-###### this
-`any`
-##### Returns
-`any`
-#### apiRoot.set()
-##### Parameters
-###### this
-`any`
-###### value
-`string`
-##### Returns
-`void`
-### fetchOptions
-> **fetchOptions**: `object`
-#### fetchOptions.type
-> **type**: `string` = `'object'`

package/docs/variables/EventBusName.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / EventBusName
-# Variable: EventBusName
-> `const` **EventBusName**: `"event-bus"` = `'event-bus'`
-Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/event/event-ability.ts#L9)

package/docs/variables/EventName.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / EventName
-# Variable: EventName
-> `const` **EventName**: `"event"` = `'event'`
-Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:8](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/event/event-ability.ts#L8)

package/docs/variables/PASSING_SCORE.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / PASSING\_SCORE
-# Variable: PASSING\_SCORE
-> `const` **PASSING\_SCORE**: `0.618` = `0.618`
-Defined in: [packages/ai-tool/src/utils/consts.ts:3](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L3)

package/docs/variables/RStreamErrCode.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / RStreamErrCode
-# Variable: RStreamErrCode
-> `const` **RStreamErrCode**: `600` = `600`
-Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:3](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/error-readable-stream.ts#L3)

package/docs/variables/RemoteToolFuncSchema.md DELETED Viewed

@@ -1,101 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-***
-[@isdk/ai-tool](../globals.md) / RemoteToolFuncSchema
-# Variable: RemoteToolFuncSchema
-> `const` **RemoteToolFuncSchema**: `object`
-Defined in: [packages/ai-tool/src/utils/consts.ts:13](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/consts.ts#L13)
-## Type declaration
-### action
-> **action**: `object`
-#### action.type
-> **type**: `string` = `'string'`
-#### action.assign()
-##### Parameters
-###### value
-`"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
-###### dest
-`any`
-###### src?
-`any`
-###### name?
-`string`
-###### options?
-`any`
-##### Returns
-`"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
-### allowExportFunc
-> **allowExportFunc**: `object`
-#### allowExportFunc.type
-> **type**: `string` = `'boolean'`
-### apiRoot
-> **apiRoot**: `object`
-#### apiRoot.type
-> **type**: `string` = `'string'`
-#### apiRoot.get()
-##### Parameters
-###### this
-`any`
-##### Returns
-`any`
-#### apiRoot.set()
-##### Parameters
-###### this
-`any`
-###### value
-`string`
-##### Returns
-`void`
-### fetchOptions
-> **fetchOptions**: `object`
-#### fetchOptions.type
-> **type**: `string` = `'object'`