@isdk/ai-tool 0.8.2 → 0.9.0

package/docs/api/classes/EnvPromptTemplate.md

@@ -6,7 +6,7 @@
 
 # Class: EnvPromptTemplate
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:657
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:732
 
 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
@@ -45,7 +45,7 @@ console.log(result); // Output: "Formatted: Hello World"
 
 > **new EnvPromptTemplate**(`template?`, `options?`): `EnvStringTemplate`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:187
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:252
 
 Initializes a new instance of the `StringTemplate` class.
 
@@ -87,7 +87,7 @@ console.log(template instanceof TestStringTemplate); // Output: true
 
 > **compiledTemplate**: `any`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:54
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:55
 
 Declares the compiled template instance.
 
@@ -99,9 +99,9 @@ Declares the compiled template instance.
 
 ### data
 
-> **data**: `undefined` \| `Record`\<`string`, `any`\>
+> **data**: `Record`\<`string`, `any`\> \| `undefined`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:66
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:67
 
 Declares the data object used for template interpolation.
 
@@ -113,9 +113,9 @@ Declares the data object used for template interpolation.
 
 ### inputVariables
 
-> **inputVariables**: `undefined` \| `string`[]
+> **inputVariables**: `string`[] \| `undefined`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:70
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:71
 
 Declares the list of input variables expected by the template.
 
@@ -125,11 +125,25 @@ Declares the list of input variables expected by the template.
 
 ***
 
+### raw
+
+> **raw**: `boolean` \| `undefined`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:75
+
+Declares whether to return the raw value if the template is a pure placeholder.
+
+#### Inherited from
+
+[`PromptTemplate`](PromptTemplate.md).[`raw`](PromptTemplate.md#raw)
+
+***
+
 ### template
 
 > **template**: `string`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:58
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:59
 
 Declares the raw template string.
 
@@ -141,9 +155,9 @@ Declares the raw template string.
 
 ### templateFormat
 
-> **templateFormat**: `undefined` \| `string`
+> **templateFormat**: `string` \| `undefined`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:62
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:63
 
 Declares the format of the template (e.g., 'default').
 
@@ -315,7 +329,7 @@ The Root Factory class
 
 > **\_format**(`data`): `string`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:662
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:739
 
 Placeholder method for formatting the template. Must be implemented by subclasses.
 
@@ -343,7 +357,7 @@ A formatted string or a promise resolving to the formatted string.
 
 > **\_initialize**(`options?`): `void`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:661
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:738
 
 Placeholder method for initializing the template. Must be implemented by subclasses.
 
@@ -369,7 +383,7 @@ Configuration options for initialization.
 
 > **filterData**(`data`): `Record`\<`string`, `any`\>
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:172
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:237
 
 Filters the input data to include only the specified input variables.
 
@@ -405,9 +419,9 @@ console.log(filteredData); // Output: { name: "Alice" }
 
 ### format()
 
-> **format**(`data?`): `Promise`\<`string`\>
+> **format**(`data?`, `visited?`): `Promise`\<`any`\>
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:219
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:284
 
 Formats the template using the provided data, supporting asynchronous processing.
 
@@ -419,9 +433,13 @@ Formats the template using the provided data, supporting asynchronous processing
 
 The data object used for interpolation.
 
+##### visited?
+
+`Set`\<`any`\>
+
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`any`\>
 
 A promise that resolves to the formatted template string.
 
@@ -442,11 +460,31 @@ console.log(result); // Output: "Hello"
 
 ***
 
+### getPurePlaceholderVariable()
+
+> **getPurePlaceholderVariable**(): `string` \| `undefined`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:200
+
+Returns the variable name if this template instance is a pure placeholder.
+
+#### Returns
+
+`string` \| `undefined`
+
+The variable name if the template is a pure placeholder, undefined otherwise.
+
+#### Inherited from
+
+[`PromptTemplate`](PromptTemplate.md).[`getPurePlaceholderVariable`](PromptTemplate.md#getpureplaceholdervariable)
+
+***
+
 ### getVariables()
 
 > **getVariables**(`template?`): `string`[]
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:660
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:737
 
 #### Parameters
 
@@ -464,7 +502,7 @@ Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:660
 
 > **initialize**(`options?`): `void`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:197
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:262
 
 Initializes the template instance with the provided options.
 
@@ -486,11 +524,31 @@ Configuration options for initialization.
 
 ***
 
+### isPurePlaceholder()
+
+> **isPurePlaceholder**(): `boolean`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:222
+
+Checks if this template instance is a pure placeholder.
+
+#### Returns
+
+`boolean`
+
+True if the template is a pure placeholder, false otherwise.
+
+#### Inherited from
+
+[`PromptTemplate`](PromptTemplate.md).[`isPurePlaceholder`](PromptTemplate.md#ispureplaceholder)
+
+***
+
 ### partial()
 
 > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:247
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:312
 
 Creates a new `StringTemplate` instance with partially filled data.
 This is useful for pre-filling some variables while leaving others to be filled later.
@@ -537,11 +595,51 @@ console.log(dateResult.date instanceof Date); // Output: true
 
 ***
 
+### renderRawValue()
+
+> **renderRawValue**(`value`, `data`, `visited?`): `Promise`\<`any`\>
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:214
+
+Renders the raw value recursively, resolving any nested templates.
+
+#### Parameters
+
+##### value
+
+`any`
+
+The value to render.
+
+##### data
+
+`Record`\<`string`, `any`\>
+
+The data object used for interpolation.
+
+##### visited?
+
+`Set`\<`any`\>
+
+A set to track visited objects to avoid infinite recursion.
+
+#### Returns
+
+`Promise`\<`any`\>
+
+A promise that resolves to the rendered raw value.
+
+#### Inherited from
+
+[`PromptTemplate`](PromptTemplate.md).[`renderRawValue`](PromptTemplate.md#renderrawvalue)
+
+***
+
 ### toJSON()
 
 > **toJSON**(`options?`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:264
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:329
 
 Serializes the `StringTemplate` instance into a JSON-compatible object.
 
@@ -579,7 +677,7 @@ console.log(serialized);
 
 ### \_findRootFactory()
 
-> `static` **\_findRootFactory**(`aClass`): `undefined` \| *typeof* `BaseFactory`
+> `static` **\_findRootFactory**(`aClass`): *typeof* `BaseFactory` \| `undefined`
 
 Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
 
@@ -597,7 +695,7 @@ the abstract root factory class
 
 #### Returns
 
-`undefined` \| *typeof* `BaseFactory`
+*typeof* `BaseFactory` \| `undefined`
 
 #### Inherited from
 
@@ -677,7 +775,7 @@ remove all aliases of the registered item or itself
 
 the registered item or name
 
-`undefined` | `string` | *typeof* `BaseFactory`
+`string` | *typeof* `BaseFactory` | `undefined`
 
 #### Returns
 
@@ -691,7 +789,7 @@ the registered item or name
 
 ### createObject()
 
-> `static` **createObject**(`aName`, `aOptions`): `undefined` \| `BaseFactory`
+> `static` **createObject**(`aName`, `aOptions`): `BaseFactory` \| `undefined`
 
 Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:241
 
@@ -709,7 +807,7 @@ Create a new object instance of Factory
 
 #### Returns
 
-`undefined` \| `BaseFactory`
+`BaseFactory` \| `undefined`
 
 #### Inherited from
 
@@ -719,7 +817,7 @@ Create a new object instance of Factory
 
 ### findRootFactory()
 
-> `abstract` `static` **findRootFactory**(): `undefined` \| *typeof* `BaseFactory`
+> `abstract` `static` **findRootFactory**(): *typeof* `BaseFactory` \| `undefined`
 
 Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
 
@@ -732,7 +830,7 @@ or set _Factory directly.
 
 #### Returns
 
-`undefined` \| *typeof* `BaseFactory`
+*typeof* `BaseFactory` \| `undefined`
 
 the root factory class
 
@@ -754,7 +852,7 @@ executes a provided callback function once for each registered element.
 
 ##### cb
 
-(`ctor`, `name`) => `undefined` \| `string`
+(`ctor`, `name`) => `string` \| `undefined`
 
 the forEach callback function
 
@@ -770,9 +868,9 @@ the forEach callback function
 
 ### format()
 
-> `static` **format**(`options`): `Promise`\<`string`\>
+> `static` **format**(`options`): `Promise`\<`any`\>
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:102
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:107
 
 Formats a template using the provided options.
 
@@ -786,7 +884,7 @@ Configuration options for the template.
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`any`\>
 
 A promise that resolves to the formatted template string.
 
@@ -809,9 +907,9 @@ console.log(result); // Output: "Hello"
 
 ### formatIf()
 
-> `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
+> `static` **formatIf**(`options`): `Promise`\<`any`\>
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:118
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:123
 
 Formats a template if the provided options represent a valid template.
 
@@ -825,7 +923,7 @@ Configuration options to check and format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `string`\>
+`Promise`\<`any`\>
 
 A promise that resolves to the formatted template string if valid; otherwise, undefined.
 
@@ -910,7 +1008,7 @@ the name to register
 
 > `static` **from**(`template?`, `options?`): [`PromptTemplate`](PromptTemplate.md)
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:86
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:91
 
 Creates a new instance of the `StringTemplate` class.
 
@@ -952,7 +1050,7 @@ console.log(template instanceof TestStringTemplate); // Output: true
 
 ### get()
 
-> `static` **get**(`name`): `undefined` \| *typeof* `BaseFactory`
+> `static` **get**(`name`): *typeof* `BaseFactory` \| `undefined`
 
 Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
 
@@ -966,7 +1064,7 @@ Get the registered class via name
 
 #### Returns
 
-`undefined` \| *typeof* `BaseFactory`
+*typeof* `BaseFactory` \| `undefined`
 
 return the registered class if found the name
 
@@ -990,7 +1088,7 @@ get the aliases of the aClass
 
 the class or name to get aliases, means itself if no aClass specified
 
-`undefined` | `string` | *typeof* `BaseFactory`
+`string` | *typeof* `BaseFactory` | `undefined`
 
 #### Returns
 
@@ -1006,7 +1104,7 @@ aliases
 
 ### getDisplayName()
 
-> `static` **getDisplayName**(`aClass`): `undefined` \| `string`
+> `static` **getDisplayName**(`aClass`): `string` \| `undefined`
 
 Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
 
@@ -1018,11 +1116,11 @@ Get the display name from aClass
 
 the class, name or itself, means itself if no aClass
 
-`undefined` | `string` | `Function`
+`string` | `Function` | `undefined`
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 #### Inherited from
 
@@ -1056,6 +1154,42 @@ the unique name in the factory
 
 ***
 
+### getPurePlaceholderVariable()
+
+> `static` **getPurePlaceholderVariable**(`templateOpt`): `string` \| `undefined`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:734
+
+Returns the variable name if the template is a pure placeholder.
+
+#### Parameters
+
+##### templateOpt
+
+The template options or template string to check.
+
+`string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+#### Returns
+
+`string` \| `undefined`
+
+The variable name if the template is a pure placeholder, undefined otherwise.
+
+#### Example
+
+```typescript
+StringTemplate.getPurePlaceholderVariable("{{text}}"); // "text"
+StringTemplate.getPurePlaceholderVariable("  {{text}}  "); // "text"
+StringTemplate.getPurePlaceholderVariable("Hello {{text}}"); // undefined
+```
+
+#### Overrides
+
+[`PromptTemplate`](PromptTemplate.md).[`getPurePlaceholderVariable`](PromptTemplate.md#getpureplaceholdervariable-2)
+
+***
+
 ### getRealName()
 
 > `static` **getRealName**(`name`): `any`
@@ -1080,7 +1214,7 @@ Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_module
 
 ### getRealNameFromAlias()
 
-> `static` **getRealNameFromAlias**(`alias`): `undefined` \| `string`
+> `static` **getRealNameFromAlias**(`alias`): `string` \| `undefined`
 
 Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:106
 
@@ -1096,7 +1230,7 @@ the alias name
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 the unique name in the factory
 
@@ -1106,11 +1240,49 @@ the unique name in the factory
 
 ***
 
+### isPurePlaceholder()
+
+> `static` **isPurePlaceholder**(`templateOpt`): `boolean`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:735
+
+Checks if the template string is a pure placeholder (optionally surrounded by whitespace).
+A pure placeholder means the template contains only one template segment and no other text.
+
+#### Parameters
+
+##### templateOpt
+
+The template options or template string to check.
+
+`string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+#### Returns
+
+`boolean`
+
+True if the template is a pure placeholder, false otherwise.
+
+#### Example
+
+```typescript
+StringTemplate.isPurePlaceholder("{{text}}"); // true
+StringTemplate.isPurePlaceholder("  {{text}}  "); // true
+StringTemplate.isPurePlaceholder("Hello {{text}}"); // false
+StringTemplate.isPurePlaceholder("{{text1}}{{text2}}"); // false
+```
+
+#### Overrides
+
+[`PromptTemplate`](PromptTemplate.md).[`isPurePlaceholder`](PromptTemplate.md#ispureplaceholder-2)
+
+***
+
 ### isTemplate()
 
 > `static` **isTemplate**(`templateOpt`): `boolean`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:659
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:736
 
 Determines whether the given options represent a valid template.
 
@@ -1146,9 +1318,9 @@ console.log(isValid); // Output: true
 
 ### matchTemplateSegment()
 
-> `static` **matchTemplateSegment**(`template`, `index?`): `undefined` \| `RegExpExecArray`
+> `static` **matchTemplateSegment**(`template`, `index?`): `RegExpExecArray` \| `undefined`
 
-Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:658
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:733
 
 Matches and extracts a single template segment from the provided template options.
 This method is designed to identify individual segments of a template string.
@@ -1168,7 +1340,7 @@ The default starting position in the template string to begin matching (default:
 
 #### Returns
 
-`undefined` \| `RegExpExecArray`
+`RegExpExecArray` \| `undefined`
 
 A `RegExpExecArray` representing the matched template segment, or `undefined` if no match is found.
          The `index` property of the result can be used to calculate the next position for iteration.
@@ -1230,7 +1402,7 @@ Check the name, alias or itself whether registered.
 
 the class name
 
-`undefined` | `string`
+`string` | `undefined`
 
 #### Returns
 
@@ -1284,7 +1456,7 @@ set alias to a class
 
 the class to set alias
 
-`undefined` | `string` | *typeof* `BaseFactory`
+`string` | *typeof* `BaseFactory` | `undefined`
 
 ##### alias
 
@@ -1314,7 +1486,7 @@ set aliases to a class
 
 the class to set aliases
 
-`undefined` | `string` | *typeof* `BaseFactory`
+`string` | *typeof* `BaseFactory` | `undefined`
 
 ##### aAliases
 
@@ -1356,7 +1528,7 @@ Set the display name to the aClass
 
 the class, name or itself, means itself if no aClass
 
-`undefined` | `string` | `Function`
+`string` | `Function` | `undefined`
 
 ##### aDisplayName
 
@@ -1388,7 +1560,7 @@ unregister this class in the factory
 
 the registered name or class, no name means unregister itself.
 
-`undefined` | `string` | `Function`
+`string` | `Function` | `undefined`
 
 #### Returns