@isdk/ai-tool 0.5.8 → 0.6.0

package/docs/classes/EnvPromptTemplate.md

@@ -6,7 +6,34 @@
 
 # Class: EnvPromptTemplate
 
-Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:5](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/env-prompt-template.ts#L5)
+Defined in: packages/template-engines/dist/index.d.ts:623
+
+The `StringTemplate` class is a versatile template engine that supports dynamic template creation,
+formatting, and partial data processing. It extends the `BaseFactory` class and provides methods
+for handling template strings, validating input variables, and managing template configurations.
+
+## Example
+
+```typescript
+import { StringTemplate } from './template';
+
+// Register a custom template class
+class CustomTemplate extends StringTemplate {
+  _initialize(options?: StringTemplateOptions): void {}
+  _format(data: Record<string, any>): string {
+    return `Formatted: ${data.text}`;
+  }
+}
+StringTemplate.register(CustomTemplate);
+
+// Create a new instance with a custom template format
+const template = new StringTemplate("{{text}}", { templateFormat: "Custom" });
+console.log(template instanceof CustomTemplate); // Output: true
+
+// Format the template with data
+const result = await template.format({ text: "Hello World" });
+console.log(result); // Output: "Formatted: Hello World"
+```
 
 ## Extends
 
@@ -18,22 +45,38 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:5](https:/
 
 > **new EnvPromptTemplate**(`template`?, `options`?): [`EnvPromptTemplate`](EnvPromptTemplate.md)
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L69)
+Defined in: packages/template-engines/dist/index.d.ts:162
+
+Initializes a new instance of the `StringTemplate` class.
 
 #### Parameters
 
 ##### template?
 
+Either a template string or an options object.
+
 `string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 ##### options?
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Additional configuration options for the template.
+
 #### Returns
 
 [`EnvPromptTemplate`](EnvPromptTemplate.md)
 
+#### Example
+
+```typescript
+const template = new StringTemplate("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+console.log(template instanceof TestStringTemplate); // Output: true
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`constructor`](PromptTemplate.md#constructors)
@@ -44,7 +87,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://gi
 
 > **compiledTemplate**: `any`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L21)
+Defined in: packages/template-engines/dist/index.d.ts:53
+
+Declares the compiled template instance.
 
 #### Inherited from
 
@@ -56,7 +101,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://gi
 
 > **data**: `undefined` \| `Record`\<`string`, `any`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L24)
+Defined in: packages/template-engines/dist/index.d.ts:65
+
+Declares the data object used for template interpolation.
 
 #### Inherited from
 
@@ -68,7 +115,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://gi
 
 > **inputVariables**: `undefined` \| `string`[]
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L25)
+Defined in: packages/template-engines/dist/index.d.ts:69
+
+Declares the list of input variables expected by the template.
 
 #### Inherited from
 
@@ -80,7 +129,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://gi
 
 > **template**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L22)
+Defined in: packages/template-engines/dist/index.d.ts:57
+
+Declares the raw template string.
 
 #### Inherited from
 
@@ -92,7 +143,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://gi
 
 > **templateFormat**: `undefined` \| `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L23)
+Defined in: packages/template-engines/dist/index.d.ts:61
+
+Declares the format of the template (e.g., 'default').
 
 #### Inherited from
 
@@ -262,7 +315,9 @@ The Root Factory class
 
 > **\_format**(`data`): `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:35](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/env-prompt-template.ts#L35)
+Defined in: packages/template-engines/dist/index.d.ts:627
+
+Placeholder method for formatting the template. Must be implemented by subclasses.
 
 #### Parameters
 
@@ -270,10 +325,14 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:35](https:
 
 `Record`\<`string`, `any`\>
 
+The data object used for interpolation.
+
 #### Returns
 
 `string`
 
+A formatted string or a promise resolving to the formatted string.
+
 #### Overrides
 
 [`PromptTemplate`](PromptTemplate.md).[`_format`](PromptTemplate.md#_format)
@@ -284,7 +343,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:35](https:
 
 > **\_initialize**(`options`?): `void`
 
-Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/env-prompt-template.ts#L27)
+Defined in: packages/template-engines/dist/index.d.ts:626
+
+Placeholder method for initializing the template. Must be implemented by subclasses.
 
 #### Parameters
 
@@ -292,6 +353,8 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:27](https:
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Configuration options for initialization.
+
 #### Returns
 
 `void`
@@ -306,9 +369,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:27](https:
 
 > **filterData**(`data`): `Record`\<`string`, `any`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L62)
+Defined in: packages/template-engines/dist/index.d.ts:147
 
-Validate/filter the data in inputVariables
+Filters the input data to include only the specified input variables.
 
 #### Parameters
 
@@ -316,10 +379,24 @@ Validate/filter the data in inputVariables
 
 `Record`\<`string`, `any`\>
 
+The data object to validate and filter.
+
 #### Returns
 
 `Record`\<`string`, `any`\>
 
+The filtered data object containing only the allowed keys.
+
+#### Example
+
+```typescript
+const template = new StringTemplate({
+  inputVariables: ['name']
+});
+const filteredData = template.filterData({ name: "Alice", age: 30 });
+console.log(filteredData); // Output: { name: "Alice" }
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`filterData`](PromptTemplate.md#filterdata)
@@ -330,7 +407,9 @@ Validate/filter the data in inputVariables
 
 > **format**(`data`?): `Promise`\<`string`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L109)
+Defined in: packages/template-engines/dist/index.d.ts:194
+
+Formats the template using the provided data, supporting asynchronous processing.
 
 #### Parameters
 
@@ -338,10 +417,25 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
 
 `Record`\<`string`, `any`\>
 
+The data object used for interpolation.
+
 #### Returns
 
 `Promise`\<`string`\>
 
+A promise that resolves to the formatted template string.
+
+#### Example
+
+```typescript
+const template = new StringTemplate("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+const result = await template.format({ text: "Hello" });
+console.log(result); // Output: "Hello"
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format)
@@ -350,15 +444,15 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
 
 ### getVariables()
 
-> **getVariables**(`template`): `string`[]
+> **getVariables**(`template`?): `string`[]
 
-Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/env-prompt-template.ts#L23)
+Defined in: packages/template-engines/dist/index.d.ts:625
 
 #### Parameters
 
-##### template
+##### template?
 
-`string` = `...`
+`string`
 
 #### Returns
 
@@ -368,13 +462,11 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:23](https:
 
 ### initialize()
 
-> `abstract` **initialize**(`options`?): `void`
+> **initialize**(`options`?): `void`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L96)
-
-**`Internal`**
+Defined in: packages/template-engines/dist/index.d.ts:172
 
-initialize instance method
+Initializes the template instance with the provided options.
 
 #### Parameters
 
@@ -382,6 +474,8 @@ initialize instance method
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Configuration options for initialization.
+
 #### Returns
 
 `void`
@@ -396,9 +490,10 @@ initialize instance method
 
 > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L139)
+Defined in: packages/template-engines/dist/index.d.ts:222
 
-it can make sense to "partial" a prompt template - eg pass in a subset of the required values, as to create a new prompt template which expects only the remaining subset of values.
+Creates a new `StringTemplate` instance with partially filled data.
+This is useful for pre-filling some variables while leaving others to be filled later.
 
 #### Parameters
 
@@ -406,13 +501,35 @@ it can make sense to "partial" a prompt template - eg pass in a subset of the re
 
 `Record`\<`string`, `any`\>
 
-the partial data
+The partial data to pre-fill in the new template.
 
 #### Returns
 
 [`PromptTemplate`](PromptTemplate.md)
 
-the new partial PromptTemplate instance
+A new `StringTemplate` instance with the partial data applied.
+
+#### Example
+
+```typescript
+const template = new StringTemplate("{{role}}:{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['role', 'text']
+});
+const partialTemplate = template.partial({ role: "user" });
+console.log(partialTemplate.data); // Output: { role: "user" }
+const result = await partialTemplate.format({ text: "Hello" });
+console.log(result); // Output: { role: "user", text: "Hello" }
+
+// Example with a function
+function getDate() {
+  return new Date();
+}
+const dateTemplate = template.partial({ date: getDate });
+console.log(dateTemplate.data); // Output: { date: getDate }
+const dateResult = await dateTemplate.format({ role: "user" });
+console.log(dateResult.date instanceof Date); // Output: true
+```
 
 #### Inherited from
 
@@ -422,20 +539,38 @@ the new partial PromptTemplate instance
 
 ### toJSON()
 
-> **toJSON**(`options`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+> **toJSON**(`options`?): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+Defined in: packages/template-engines/dist/index.d.ts:239
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L147)
+Serializes the `StringTemplate` instance into a JSON-compatible object.
 
 #### Parameters
 
-##### options
+##### options?
 
-[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) = `...`
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+Optional configuration for serialization.
 
 #### Returns
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+A JSON-compatible object representing the template's state.
+
+#### Example
+
+```typescript
+const template = new StringTemplate("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+const serialized = template.toJSON();
+console.log(serialized);
+// Output: { template: "{{text}}", templateFormat: "Test", inputVariables: ['text'] }
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`toJSON`](PromptTemplate.md#tojson)
@@ -637,7 +772,9 @@ the forEach callback function
 
 > `static` **format**(`options`): `Promise`\<`string`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L31)
+Defined in: packages/template-engines/dist/index.d.ts:101
+
+Formats a template using the provided options.
 
 #### Parameters
 
@@ -645,10 +782,25 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Configuration options for the template.
+
 #### Returns
 
 `Promise`\<`string`\>
 
+A promise that resolves to the formatted template string.
+
+#### Example
+
+```typescript
+const result = await StringTemplate.format({
+  template: "{{text}}",
+  data: { text: "Hello" },
+  templateFormat: "Test"
+});
+console.log(result); // Output: "Hello"
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format-2)
@@ -659,9 +811,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
 
 > `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L41)
+Defined in: packages/template-engines/dist/index.d.ts:117
 
-If the given options.template is the template, perform formatting using that template.
+Formats a template if the provided options represent a valid template.
 
 #### Parameters
 
@@ -669,13 +821,24 @@ If the given options.template is the template, perform formatting using that tem
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-The options object to check for being a template and to format.
+Configuration options to check and format.
 
 #### Returns
 
 `Promise`\<`undefined` \| `string`\>
 
-A Promise that resolves to the formatted result if options is a template; otherwise, no value is returned.
+A promise that resolves to the formatted template string if valid; otherwise, undefined.
+
+#### Example
+
+```typescript
+const result = await StringTemplate.formatIf({
+  template: "{{text}}",
+  data: { text: "Valid Template" },
+  templateFormat: "Test"
+});
+console.log(result); // Output: "Valid Template"
+```
 
 #### Inherited from
 
@@ -747,22 +910,40 @@ the name to register
 
 > `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L27)
+Defined in: packages/template-engines/dist/index.d.ts:85
+
+Creates a new instance of the `StringTemplate` class.
 
 #### Parameters
 
 ##### template?
 
+Either a template string or an options object.
+
 `string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 ##### options?
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Additional configuration options for the template.
+
 #### Returns
 
 [`PromptTemplate`](PromptTemplate.md)
 
+A new `StringTemplate` instance.
+
+#### Example
+
+```typescript
+const template = StringTemplate.from("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+console.log(template instanceof TestStringTemplate); // Output: true
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`from`](PromptTemplate.md#from)
@@ -929,18 +1110,34 @@ the unique name in the factory
 
 > `static` **isTemplate**(`templateOpt`): `boolean`
 
-Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:7](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/env-prompt-template.ts#L7)
+Defined in: packages/template-engines/dist/index.d.ts:624
+
+Determines whether the given options represent a valid template.
 
 #### Parameters
 
 ##### templateOpt
 
+The options object to evaluate.
+
 `string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
 `boolean`
 
+A boolean indicating whether the options represent a valid template.
+
+#### Example
+
+```typescript
+const isValid = StringTemplate.isTemplate({
+  template: "{{text}}",
+  templateFormat: "Test"
+});
+console.log(isValid); // Output: true
+```
+
 #### Overrides
 
 [`PromptTemplate`](PromptTemplate.md).[`isTemplate`](PromptTemplate.md#istemplate)