@isdk/ai-tool 0.6.0 → 0.7.0

package/docs/{classes → api/classes}/FStringPromptTemplate.md

@@ -6,7 +6,7 @@
 
 # Class: FStringPromptTemplate
 
-Defined in: packages/template-engines/dist/index.d.ts:608
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:641
 
 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 FStringPromptTemplate**(`template`?, `options`?): [`FStringPromptTemplate`](FStringPromptTemplate.md)
 
-Defined in: packages/template-engines/dist/index.d.ts:162
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:187
 
 Initializes a new instance of the `StringTemplate` class.
 
@@ -87,7 +87,7 @@ console.log(template instanceof TestStringTemplate); // Output: true
 
 > **compiledTemplate**: `FStringTemplateNode`[]
 
-Defined in: packages/template-engines/dist/index.d.ts:609
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:642
 
 Declares the compiled template instance.
 
@@ -101,7 +101,7 @@ Declares the compiled template instance.
 
 > **data**: `undefined` \| `Record`\<`string`, `any`\>
 
-Defined in: packages/template-engines/dist/index.d.ts:65
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:66
 
 Declares the data object used for template interpolation.
 
@@ -115,7 +115,7 @@ Declares the data object used for template interpolation.
 
 > **inputVariables**: `undefined` \| `string`[]
 
-Defined in: packages/template-engines/dist/index.d.ts:69
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:70
 
 Declares the list of input variables expected by the template.
 
@@ -129,7 +129,7 @@ Declares the list of input variables expected by the template.
 
 > **template**: `string`
 
-Defined in: packages/template-engines/dist/index.d.ts:57
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:58
 
 Declares the raw template string.
 
@@ -143,7 +143,7 @@ Declares the raw template string.
 
 > **templateFormat**: `undefined` \| `string`
 
-Defined in: packages/template-engines/dist/index.d.ts:61
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:62
 
 Declares the format of the template (e.g., 'default').
 
@@ -157,7 +157,7 @@ Declares the format of the template (e.g., 'default').
 
 > `abstract` `static` **\_aliases**: \[`string`\]
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
 
 **`Internal`**
 
@@ -174,7 +174,7 @@ the key is alias name, the value is the registered name
 
 > `static` **\_baseNameOnly**: `number`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
 
 **`Internal`**
 
@@ -215,7 +215,7 @@ _baseNameOnly
 
 > `abstract` `static` **\_children**: `object`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
 
 **`Internal`**
 
@@ -239,7 +239,7 @@ _children
 
 > `abstract` `static` **\_Factory**: *typeof* `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:41
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:41
 
 **`Internal`**
 
@@ -261,7 +261,7 @@ _Factory
 
 > **get** `static` **aliases**(): `string`[]
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
 
 the aliases of itself
 
@@ -273,7 +273,7 @@ the aliases of itself
 
 > **set** `static` **aliases**(`value`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:196
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:196
 
 ##### Parameters
 
@@ -297,7 +297,7 @@ Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factor
 
 > **get** `static` **Factory**(): *typeof* `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:63
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:63
 
 The Root Factory class
 
@@ -315,7 +315,7 @@ The Root Factory class
 
 > **\_format**(`data`): `string`
 
-Defined in: packages/template-engines/dist/index.d.ts:613
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:647
 
 Placeholder method for formatting the template. Must be implemented by subclasses.
 
@@ -343,7 +343,7 @@ A formatted string or a promise resolving to the formatted string.
 
 > **\_initialize**(`options`?): `void`
 
-Defined in: packages/template-engines/dist/index.d.ts:612
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:646
 
 Placeholder method for initializing the template. Must be implemented by subclasses.
 
@@ -369,7 +369,7 @@ Configuration options for initialization.
 
 > **filterData**(`data`): `Record`\<`string`, `any`\>
 
-Defined in: packages/template-engines/dist/index.d.ts:147
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:172
 
 Filters the input data to include only the specified input variables.
 
@@ -407,7 +407,7 @@ console.log(filteredData); // Output: { name: "Alice" }
 
 > **format**(`data`?): `Promise`\<`string`\>
 
-Defined in: packages/template-engines/dist/index.d.ts:194
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:219
 
 Formats the template using the provided data, supporting asynchronous processing.
 
@@ -446,7 +446,7 @@ console.log(result); // Output: "Hello"
 
 > **getVariables**(`template`?): `string`[]
 
-Defined in: packages/template-engines/dist/index.d.ts:611
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:645
 
 #### Parameters
 
@@ -464,7 +464,7 @@ Defined in: packages/template-engines/dist/index.d.ts:611
 
 > **initialize**(`options`?): `void`
 
-Defined in: packages/template-engines/dist/index.d.ts:172
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:197
 
 Initializes the template instance with the provided options.
 
@@ -490,7 +490,7 @@ Configuration options for initialization.
 
 > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
 
-Defined in: packages/template-engines/dist/index.d.ts:222
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:247
 
 Creates a new `StringTemplate` instance with partially filled data.
 This is useful for pre-filling some variables while leaving others to be filled later.
@@ -541,7 +541,7 @@ console.log(dateResult.date instanceof Date); // Output: true
 
 > **toJSON**(`options`?): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-Defined in: packages/template-engines/dist/index.d.ts:239
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:264
 
 Serializes the `StringTemplate` instance into a JSON-compatible object.
 
@@ -581,7 +581,7 @@ console.log(serialized);
 
 > `static` **\_findRootFactory**(`aClass`): `undefined` \| *typeof* `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
 
 **`Internal`**
 
@@ -609,7 +609,7 @@ the abstract root factory class
 
 > `static` **\_get**(`name`): `any`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
 
 #### Parameters
 
@@ -631,7 +631,7 @@ Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factor
 
 > `static` **\_register**(`aClass`, `aOptions`?): `boolean`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:145
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:145
 
 **`Internal`**
 
@@ -667,7 +667,7 @@ return true if successful.
 
 > `static` **cleanAliases**(`aName`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:162
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:162
 
 remove all aliases of the registered item or itself
 
@@ -693,7 +693,7 @@ the registered item or name
 
 > `static` **createObject**(`aName`, `aOptions`): `undefined` \| `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:241
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:241
 
 Create a new object instance of Factory
 
@@ -721,7 +721,7 @@ Create a new object instance of Factory
 
 > `abstract` `static` **findRootFactory**(): `undefined` \| *typeof* `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
 
 **`Internal`**
 
@@ -746,7 +746,7 @@ the root factory class
 
 > `static` **forEach**(`cb`): `any`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:227
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:227
 
 executes a provided callback function once for each registered element.
 
@@ -772,7 +772,7 @@ the forEach callback function
 
 > `static` **format**(`options`): `Promise`\<`string`\>
 
-Defined in: packages/template-engines/dist/index.d.ts:101
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:102
 
 Formats a template using the provided options.
 
@@ -811,7 +811,7 @@ console.log(result); // Output: "Hello"
 
 > `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
 
-Defined in: packages/template-engines/dist/index.d.ts:117
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:118
 
 Formats a template if the provided options represent a valid template.
 
@@ -850,7 +850,7 @@ console.log(result); // Output: "Valid Template"
 
 > `abstract` `static` **formatName**(`aName`): `string`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:116
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:116
 
 **`Internal`**
 
@@ -878,7 +878,7 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 > `static` **formatNameFromClass**(`aClass`, `aBaseNameOnly`?): `string`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
 
 **`Internal`**
 
@@ -910,7 +910,7 @@ the name to register
 
 > `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
 
-Defined in: packages/template-engines/dist/index.d.ts:85
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:86
 
 Creates a new instance of the `StringTemplate` class.
 
@@ -954,7 +954,7 @@ console.log(template instanceof TestStringTemplate); // Output: true
 
 > `static` **get**(`name`): `undefined` \| *typeof* `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
 
 Get the registered class via name
 
@@ -980,7 +980,7 @@ return the registered class if found the name
 
 > `static` **getAliases**(`aClass`): `string`[]
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
 
 get the aliases of the aClass
 
@@ -1008,7 +1008,7 @@ aliases
 
 > `static` **getDisplayName**(`aClass`): `undefined` \| `string`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
 
 Get the display name from aClass
 
@@ -1034,7 +1034,7 @@ the class, name or itself, means itself if no aClass
 
 > `static` **getNameFrom**(`aClass`): `string`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:122
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:122
 
 Get the unique(registered) name in the factory
 
@@ -1060,7 +1060,7 @@ the unique name in the factory
 
 > `static` **getRealName**(`name`): `any`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
 
 #### Parameters
 
@@ -1082,7 +1082,7 @@ Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factor
 
 > `static` **getRealNameFromAlias**(`alias`): `undefined` \| `string`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:106
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:106
 
 get the unique name in the factory from an alias name
 
@@ -1110,7 +1110,7 @@ the unique name in the factory
 
 > `static` **isTemplate**(`templateOpt`): `boolean`
 
-Defined in: packages/template-engines/dist/index.d.ts:610
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:644
 
 Determines whether the given options represent a valid template.
 
@@ -1144,11 +1144,57 @@ console.log(isValid); // Output: true
 
 ***
 
+### matchTemplateSegment()
+
+> `static` **matchTemplateSegment**(`template`, `index`?): `undefined` \| `RegExpExecArray`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:643
+
+Matches and extracts a single template segment from the provided template options.
+This method is designed to identify individual segments of a template string.
+
+#### Parameters
+
+##### template
+
+`string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+##### index?
+
+`number`
+
+The default starting position in the template string to begin matching (default: 0).
+               This value is used only if `templateOpt.index` is not provided or invalid.
+
+#### Returns
+
+`undefined` \| `RegExpExecArray`
+
+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.
+
+#### Example
+
+```typescript
+const template = "{{name}} is {{age}} years old";
+let match = StringTemplate.matchTemplateSegment({ template });
+while (match) {
+  console.log(match[0]); // Output: "{{name}}"
+  match = StringTemplate.matchTemplateSegment({ template }, match.index + match[0].length);
+}
+```
+
+#### Overrides
+
+[`PromptTemplate`](PromptTemplate.md).[`matchTemplateSegment`](PromptTemplate.md#matchtemplatesegment)
+
+***
+
 ### register()
 
 > `static` **register**(...`args`): `boolean`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:137
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:137
 
 register the aClass to the factory
 
@@ -1174,7 +1220,7 @@ return true if successful.
 
 > `static` **registeredClass**(`aName`): `false` \| *typeof* `BaseFactory`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:151
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:151
 
 Check the name, alias or itself whether registered.
 
@@ -1202,7 +1248,7 @@ the registered class if registered, otherwise returns false
 
 > `static` **removeAlias**(...`aliases`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
 
 remove specified aliases
 
@@ -1228,7 +1274,7 @@ the aliases to remove
 
 > `static` **setAlias**(`aClass`, `alias`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:189
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:189
 
 set alias to a class
 
@@ -1258,7 +1304,7 @@ the class to set alias
 
 > `static` **setAliases**(`aClass`, ...`aAliases`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:183
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:183
 
 set aliases to a class
 
@@ -1300,7 +1346,7 @@ import { BaseFactory } from 'custom-factory'
 
 > `static` **setDisplayName**(`aClass`, `aDisplayName`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:212
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:212
 
 Set the display name to the aClass
 
@@ -1332,7 +1378,7 @@ the display name to set
 
 > `static` **unregister**(`aName`): `boolean`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157
 
 unregister this class in the factory