@isdk/ai-tool 0.5.7 → 0.6.0

package/docs/functions/filenameReservedRegex.md

@@ -1,20 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / filenameReservedRegex
-
-# Function: filenameReservedRegex()
-
-> **filenameReservedRegex**(): `RegExp`
-
-Defined in: [packages/ai-tool/src/utils/filename.ts:42](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/filename.ts#L42)
-
-Returns a new regular expression instance for reserved filename characters with the 'g' flag.
-use this to reset the with global option
-
-## Returns
-
-`RegExp`
-
-A compiled regular expression for reserved filename characters.

package/docs/functions/hfParse.md

@@ -1,24 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hfParse
-
-# Function: hfParse()
-
-> **hfParse**(`tokens`): `Program`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/parser.ts:33](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/jinja/src/parser.ts#L33)
-
-Generate the Abstract Syntax Tree (AST) from a list of tokens.
-Operator precedence can be found here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_precedence#table
-
-## Parameters
-
-### tokens
-
-`Token`[]
-
-## Returns
-
-`Program`

package/docs/functions/hfTokenize.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hfTokenize
-
-# Function: hfTokenize()
-
-> **hfTokenize**(`source`, `options`): `Token`[]
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/lexer.ts:203](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/jinja/src/lexer.ts#L203)
-
-Generate a list of tokens from a source string.
-
-## Parameters
-
-### source
-
-`string`
-
-### options
-
-`PreprocessOptions` = `{}`
-
-## Returns
-
-`Token`[]

package/docs/functions/interpolateEnv.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateEnv
-
-# Function: interpolateEnv()
-
-> **interpolateEnv**(`value`, `processEnv`, `parsed`?): `any`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:31](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L31)
-
-## Parameters
-
-### value
-
-`string`
-
-### processEnv
-
-`Record`\<`string`, `any`\>
-
-### parsed?
-
-`Record`\<`string`, `any`\>
-
-## Returns
-
-`any`

package/docs/functions/interpolateFString.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateFString
-
-# Function: interpolateFString()
-
-> **interpolateFString**(`nodes`, `values`): `string`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:71](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/python.ts#L71)
-
-Type that represents a function that takes a template string and a set
-of input values, and returns a string where all variables in the
-template have been replaced with their corresponding values.
-
-## Parameters
-
-### nodes
-
-[`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
-
-### values
-
-`Record`\<`string`, `any`\>
-
-## Returns
-
-`string`

package/docs/functions/interpolateGolangTemplate.md

@@ -1,35 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateGolangTemplate
-
-# Function: interpolateGolangTemplate()
-
-> **interpolateGolangTemplate**(`str`, `variables`, `initVars`?): `string`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/golang.ts:269](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/golang.ts#L269)
-
-Parse and interpolate template
-
-## Parameters
-
-### str
-
-`string`
-
-golang style template
-
-### variables
-
-`Record`\<`string`, `any`\>
-
-object of variables to insert
-
-### initVars?
-
-`boolean`
-
-## Returns
-
-`string`

package/docs/functions/parseFString.md

@@ -1,26 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / parseFString
-
-# Function: parseFString()
-
-> **parseFString**(`template`): [`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:16](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/python.ts#L16)
-
-Type that represents a function that takes a template string and
-returns an array of `ParsedFStringNode`.
-
-extract from langchain.js/langchain-core/src/prompts/template.ts
-
-## Parameters
-
-### template
-
-`string`
-
-## Returns
-
-[`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]

package/docs/functions/reControlCharsRegex.md

@@ -1,19 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / reControlCharsRegex
-
-# Function: reControlCharsRegex()
-
-> **reControlCharsRegex**(): `RegExp`
-
-Defined in: [packages/ai-tool/src/utils/filename.ts:50](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/filename.ts#L50)
-
-Returns a new regular expression instance for control characters in a filename with the 'g' flag.
-
-## Returns
-
-`RegExp`
-
-A compiled regular expression for control characters in a filename.

package/docs/interfaces/DotenvExpandOptions.md

@@ -1,43 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / DotenvExpandOptions
-
-# Interface: DotenvExpandOptions
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:202](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L202)
-
-## Properties
-
-### error?
-
-> `optional` **error**: `Error`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L203)
-
-***
-
-### parsed?
-
-> `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:219](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L219)
-
-Default: `object`
-
-Object coming from dotenv's parsed result.
-
-***
-
-### processEnv?
-
-> `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:212](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L212)
-
-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 })`

package/docs/interfaces/DotenvExpandOutput.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / DotenvExpandOutput
-
-# Interface: DotenvExpandOutput
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:222](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L222)
-
-## Properties
-
-### error?
-
-> `optional` **error**: `Error`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L223)
-
-***
-
-### parsed?
-
-> `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:224](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L224)

package/docs/interfaces/DotenvParseInput.md

@@ -1,13 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / DotenvParseInput
-
-# Interface: DotenvParseInput
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:194](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L194)
-
-## Indexable
-
-\[`name`: `string`\]: `undefined` \| `string`

package/docs/interfaces/DotenvParseOutput.md

@@ -1,13 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / DotenvParseOutput
-
-# Interface: DotenvParseOutput
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:198](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L198)
-
-## Indexable
-
-\[`name`: `string`\]: `undefined` \| `string`

package/docs/interfaces/DotenvPopulateInput.md

@@ -1,13 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / DotenvPopulateInput
-
-# Interface: DotenvPopulateInput
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:190](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/env.ts#L190)
-
-## Indexable
-
-\[`name`: `string`\]: `undefined` \| `string`

package/docs/type-aliases/FStringPromptTemplateNode.md

@@ -1,14 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / FStringPromptTemplateNode
-
-# Type Alias: FStringPromptTemplateNode
-
-> **FStringPromptTemplateNode**: \{ `text`: `string`; `type`: `"literal"`; \} \| \{ `name`: `string`; `type`: `"variable"`; \}
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:6](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/python.ts#L6)
-
-Type that represents a node in a parsed format string. It can be either
-a literal text or a variable name.

package/docs/type-aliases/PromptTemplateType.md

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptTemplateType
-
-# Type Alias: PromptTemplateType
-
-> **PromptTemplateType**: *typeof* [`PromptTemplateTypes`](../variables/PromptTemplateTypes.md)\[`number`\]
-
-Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:17](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/consts.ts#L17)

package/docs/type-aliases/PromptType.md

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptType
-
-# Type Alias: PromptType
-
-> **PromptType**: *typeof* [`PromptTypes`](../variables/PromptTypes.md)\[`number`\]
-
-Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/consts.ts#L10)

package/docs/variables/HFBuiltins.md

@@ -1,122 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / HFBuiltins
-
-# Variable: HFBuiltins
-
-> `const` **HFBuiltins**: `object`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/builtins.ts:68](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/template/jinja/src/builtins.ts#L68)
-
-## Type declaration
-
-### join()
-
-> **join**: (`value`, `separator`) => `any`
-
-#### Parameters
-
-##### value
-
-`any`
-
-##### separator
-
-`string` = `','`
-
-#### Returns
-
-`any`
-
-### randomInt()
-
-> **randomInt**: (`to`, `from`) => `number`
-
-#### Parameters
-
-##### to
-
-`number`
-
-##### from
-
-`number` = `0`
-
-#### Returns
-
-`number`
-
-### select()
-
-> **select**: (`obj`, `index`?) => `any`
-
-Selects an element from the given object, array, or string.
-
-#### Parameters
-
-##### obj
-
-`any`
-
-Can be an object, array, or string to select from.
-
-##### index?
-
-Optional, specifies the index or key to select. Negative values indicate indices from the end.
-
-`string` | `number`
-
-#### Returns
-
-`any`
-
-The selected element, or `undefined` if the input is empty or not provided.
-
-#### Examples
-
-```ts
-// Selecting an element from an array
-const array = ['apple', 'banana', 'cherry']
-console.log(select(array)) // Random element from the array
-console.log(select(array, 1)) // Second element
-console.log(select(array, -1)) // Last element
-```
-
-```ts
-// Selecting a property from an object
-const obj = { fruit1: 'apple', fruit2: 'banana', fruit3: 'cherry' }
-console.log(select(obj)) // Random property from the object
-console.log(select(obj, 'fruit2')) // Property with key 'fruit2'
-```
-
-```ts
-// Selecting a character from a string
-const str = 'hello'
-console.log(select(str)) // Random character from the string
-console.log(select(str, 1)) // Second character
-console.log(select(str, -1)) // Last character
-```
-
-### tojson()
-
-> **tojson**: (`value`, `indent`?, `depth`?) => `string`
-
-#### Parameters
-
-##### value
-
-`any`
-
-##### indent?
-
-`number` | \{ `depth`: `number`; `indent`: `number`; \}
-
-##### depth?
-
-`number`
-
-#### Returns
-
-`string`

package/docs/variables/PromptTemplateTypes.md

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptTemplateTypes
-
-# Variable: PromptTemplateTypes
-
-> `const` **PromptTemplateTypes**: readonly \[`"internal"`, `"hf"`, `"fill"`\]
-
-Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:12](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/consts.ts#L12)

package/docs/variables/PromptTypes.md

@@ -1,14 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptTypes
-
-# Variable: PromptTypes
-
-> `const` **PromptTypes**: readonly \[`"chat"`, `"char"`, `"plan"`\]
-
-Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/prompt/consts.ts#L5)
-
-Prompt Type
-defaults to `chat`