@isdk/ai-tool 0.1.0 → 0.1.2

package/dist/index.d.ts

@@ -6,8 +6,9 @@ export { e as AIModelNameRule, d as AIModelNameRuleFn, n as AbortError, j as Abo
 import { BaseFactory } from 'custom-factory';
 import { Event } from 'events-ex';
 import * as _base32768 from 'base32768';
+import _memoize, { Options } from 'memoizee';
 export { NIL as uuidNIL, parse as uuidParse, stringify as uuidStringify, validate as uuidValidate, version as uuidVersion, v1 as uuidv1, v4 as uuidv4, v5 as uuidv5 } from 'uuid';
-export * from 'json-canonicalize';
+export { canonicalize } from 'json-canonicalize';
 export { stringify as stringifyYaml } from 'yaml';
 export { mimeType } from 'mime-type/with-db';
 export { Config as ConfigFile } from 'load-config-file';
@@ -1254,6 +1255,7 @@ declare function getAllEnumKeys<T extends object>(enumType: T): Array<keyof type
  * console.log(json); // { name: 'John' }
  */
 declare function parseJsJson(input: string, scope?: Record<string, any>): any;
+declare function filterValidFnScope(scope?: Record<string, any>): Record<string, any> | undefined;
 
 /**
  * Retrieves an array of all key paths as strings for a nested object or array.
@@ -1270,6 +1272,19 @@ declare function getKeysPath<TValue extends object>(value: TValue): string[];
 
 declare function createEndWithRepetitionDetector(repetitionThreshold: number): (value: string) => RegExpExecArray | null;
 
+/**
+ * Checks if a file (not a directory) exists at the specified path.
+ *
+ * @param filepath - The path to the file to check.
+ * @returns true if the file exists and is not a directory; otherwise, false.
+ *
+ * @example
+ * ```typescript
+ * const exists = fileIsExists('path/to/file.txt');
+ * console.log(exists); // Outputs: true or false
+ * ```
+ */
+declare function fileIsExists(filepath: string): boolean | undefined;
 /**
  * Loads a file from given paths, optionally searching for specific extensions.
  *
@@ -1301,16 +1316,21 @@ declare function loadTextFromPaths(filename: string, searchPaths?: string[], ext
  * Optionally filters the results using a file matching callback.
  *
  * @param dir - A single directory path or an array of directory paths to start the search from.
- * @param isFileMatched - An optional callback that determines whether a file should be included in the result.
+ * @param options.isFileMatched - An optional callback that determines whether a file should be included in the result.
+ * @param options.signal - An optional signal to abort the operation.
  * @returns An array of file paths that match the criteria.
  *
  * @example
 * ```typescript
-* const files = readFilenamesRecursiveSync('/path/to/directory', (filepath) => filepath.endsWith('.js'));
+* const files = readFilenamesRecursiveSync('/path/to/directory', {isFileMatched: (filepath) => filepath.endsWith('.js')});
 * console.log(files); // Outputs an array of JavaScript file paths.
 * ```
 */
-declare function readFilenamesRecursiveSync(dir: string | string[], isFileMatched?: (filepath: string) => boolean, signal?: AbortSignal): string[];
+declare function readFilenamesRecursiveSync(dir: string | string[], options?: {
+    isFileMatched?: (filepath: string) => boolean;
+    signal?: AbortSignal;
+    level?: number;
+}): string[];
 /**
  * Resolves the real file path, handling symbolic links.
  *
@@ -1464,4 +1484,91 @@ declare class IntSet {
  */
 declare function countRegexMatches(content: string, regex: RegExp): number;
 
-export { type AIChatAssistantMessageParam, type AIChatContentPart, type AIChatContentPartImage, type AIChatContentPartText, type AIChatMessageParam, type AIChatMessageParamBase, type AIChatMessageToolCall, type AIChatRole, AIChatRoles, type AIChatSystemMessageParam, type AIChatToolMessageParam, type AIChatUserMessageParam, type AIMessageType, AIMessageTypes, AIModelNameRules, type AIResult, AIStream, type AIStreamParser, type AIStreamParserOptions, type AITextGenerationFinishReason, AITextGenerationFinishReasons, AsyncFeatures, type AsyncTaskId, BaseError, CancelableAbility, type CancelableAbilityOptions, CommonError, DefaultAsyncSemaphoreCapacity, type DotenvExpandOptions, type DotenvExpandOutput, type DotenvParseInput, type DotenvParseOutput, type DotenvPopulateInput, EventBusName, type EventErrorListenerFn, type EventListenerFn, EventName, FStringPromptTemplate, type FStringPromptTemplateNode, FewShotPromptTemplate, type FewShotPromptTemplateOptions, FilenameReservedRegex, GolangPromptTemplate, builtins as HFBuiltins, EnvironmentEx as HFEnvironment, Interpreter as HFInterpreter, Template as HFTemplate, HfPromptTemplate, IntSet, type JsonFilter, PromptExampleSelector, type PromptExampleSelectorOptions, type PromptExamples, PromptTemplate, type PromptTemplateOptions, type PromptTemplateType, PromptTemplateTypes, type PromptType, PromptTypes, RStreamErrCode, RateLimit, ReadableStreamError, ResponseRStreamErrCode, type SanitizeFilenameOptions, Semaphore, type StreamCallbacksAndOptions, TaskAbortController, type TaskAbortControllers, type TaskPromise, ToolFunc, WindowsReservedNameRegex, XXHashAlgorithm, backendEventable, base32768, countRegexMatches, createCallbacksTransformer, createEmptyReadableStream, createEndWithRepetitionDetector, createEventStreamTransformer, createHfValueFunc, dateToText, defaultTemplateFormat, expandEnv, expandObjEnv, extNameLevel, filenameReservedRegex, getAllEnumKeys, getConfigFileNames, getConfigs, getKeysPath, getMultiLevelExtname, getRealFilepath, getResponseErrorReadableStream, parse as hfParse, tokenize as hfTokenize, interpolateEnv, interpolateFString, interpolateGolangTemplate, isModelNameMatched, isValidFilename, isValidFilepath, isWebStream, jsonFilterToWhere, jsonToMarkdownStr, loadFileFromPaths, loadTextFromPaths, makeToolFuncCancelable, matchUrlProtocol, messagesToText, paramsSizeToScaleStr, parseFString, parseJsJson, parseYaml, reControlCharsRegex, readFilenamesRecursiveSync, readableFromAsyncIterable, registerYamlTag, sanitizeFilename, sanitizeFilepath, saveConfigFile, scaleStrToParamsSize, sortedValues, splitSentence, textToDate, toDateTime, trimStartOfStreamHelper, truncTo, uuid, wait, xxhash, xxhash32, xxhash64, xxhashAsStr };
+type ArgInfo = [boolean, string];
+type ArgProcessor = (arg: ArgInfo, ix: number, scope?: Record<string, any>, options?: ParseObjectArgumentOptions) => string | void | Promise<string | void>;
+interface AIChoiceConfig {
+    items?: string[];
+    maxPick?: number;
+    minPick?: number;
+    separator?: string;
+    prefix?: string;
+    type?: 'random' | 'ai';
+    end?: string;
+}
+interface ParseObjectArgumentOptions {
+    delimiter?: string;
+    argProcessor?: ArgProcessor;
+    returnArrayOnly?: boolean;
+    templateFormat?: string;
+    templateData?: Record<string, any>;
+}
+/**
+ * Asynchronously parses a string of object arguments into an actual object.
+ * @param argsStr The string of arguments to be parsed.
+ * @param scope An optional scope object that provides values for variables during parsing.
+ * @param options An optional configuration object containing the delimiter and argument processor.
+ * @returns The parsed object or undefined.
+ *
+ * This function first parses the argument string into an object string and then converts it
+ * into a proper JavaScript/JSON object based on the parsing results and configuration options.
+ * It handles the conversion of single objects, arrays, and key-value pairs. The default delimiter
+ * between parameters is a comma (`,`), but this can be customized using the `options.delimiter`.
+ * Parameter assignment always uses an equal sign (`=`) and cannot be modified.
+ *
+ * The function returns:
+ * - An object if the input string represents a set of key-value pairs.
+ * - An array if the input string represents a sequence of elements, where each element can be
+ *   parsed as a number (indices are used as keys).
+ * - A single value if the input string represents a single value or a single key-value pair.
+ * - `undefined` if the input string is empty or cannot be parsed into a valid object.
+ *
+ * @example
+ * ```typescript
+ * // Example call with default delimiter
+ * const result = await parseObjectArguments("name=John,age=30");
+ * console.log(result); // Output: { name: 'John', age: '30' }
+ *
+ * // Example call with custom delimiter
+ * const resultCustomDelimiter = await parseObjectArguments("name=John|age=30", undefined, { delimiter: '|' });
+ * console.log(resultCustomDelimiter); // Output: { name: 'John', age: '30' }
+ *
+ * // Example with a single value
+ * const singleValue = await parseObjectArguments("42");
+ * console.log(singleValue); // Output: 42
+ *
+ * // Example with an array
+ * const arrayResult = await parseObjectArguments("1,2,3");
+ * console.log(arrayResult); // Output: [1, 2, 3]
+ * ```
+ */
+declare function parseObjectArguments(argsStr: string, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): Promise<any>;
+declare function parseObjectArgumentInfos(args: ArgInfo[], scope?: Record<string, any>, options?: ParseObjectArgumentOptions): Promise<any>;
+declare function ChoiceArgProcessor(argInfo: ArgInfo, _ix: number, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): string | undefined;
+declare function TemplateArgProcessor([isNamedArg, arg]: ArgInfo, ix: number, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): Promise<string | undefined>;
+declare function AIArgProcessor(argInfo: ArgInfo, ix: number, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): Promise<string | undefined>;
+declare function quoteStr(str: string): string;
+declare function parseObjectArgInfo(argInfo: ArgInfo, ix: number, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): Promise<string>;
+/**
+ * Parses an object arguments string into an array of ArgInfo.
+ *
+ * This function processes a parameter string and parses it according to specific rules, allowing for custom delimiters.
+ * It can handle quotes, escape characters, and expressions within brackets. The parsing is designed to interpret
+ * object literal strings from dynamic languages, such as JSON objects or similar custom formats.
+ *
+ * @param argsStr The string containing the arguments to be parsed.
+ * @param scope An optional scope object used for further processing of the parsed arguments. Default is undefined.
+ * @param options Parsing options, including:
+ *   - delimiter: The character used to separate arguments. Default is ','.
+ *   - argProcessor: An optional instance of ArgProcessor used for further processing of the parsed arguments.
+ * @returns An array of parsed argument information, where each item contains a boolean indicating whether the argument is named,
+ *          and the string representation of the argument.
+ */
+declare function parseObjectArgumentsAsArgInfos(argsStr: string, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): ArgInfo[];
+declare function parseCommand(commandStr: string, scope?: Record<string, any>, options?: ParseObjectArgumentOptions): Promise<{
+    command: string;
+    args?: Record<string, any>;
+}>;
+
+declare function memoize<F extends (...args: any[]) => any>(fn: any, options?: Options<F>): F & _memoize.Memoized<F>;
+
+export { AIArgProcessor, type AIChatAssistantMessageParam, type AIChatContentPart, type AIChatContentPartImage, type AIChatContentPartText, type AIChatMessageParam, type AIChatMessageParamBase, type AIChatMessageToolCall, type AIChatRole, AIChatRoles, type AIChatSystemMessageParam, type AIChatToolMessageParam, type AIChatUserMessageParam, type AIChoiceConfig, type AIMessageType, AIMessageTypes, AIModelNameRules, type AIResult, AIStream, type AIStreamParser, type AIStreamParserOptions, type AITextGenerationFinishReason, AITextGenerationFinishReasons, AsyncFeatures, type AsyncTaskId, BaseError, CancelableAbility, type CancelableAbilityOptions, ChoiceArgProcessor, CommonError, DefaultAsyncSemaphoreCapacity, type DotenvExpandOptions, type DotenvExpandOutput, type DotenvParseInput, type DotenvParseOutput, type DotenvPopulateInput, EventBusName, type EventErrorListenerFn, type EventListenerFn, EventName, FStringPromptTemplate, type FStringPromptTemplateNode, FewShotPromptTemplate, type FewShotPromptTemplateOptions, FilenameReservedRegex, GolangPromptTemplate, builtins as HFBuiltins, EnvironmentEx as HFEnvironment, Interpreter as HFInterpreter, Template as HFTemplate, HfPromptTemplate, IntSet, type JsonFilter, type ParseObjectArgumentOptions, PromptExampleSelector, type PromptExampleSelectorOptions, type PromptExamples, PromptTemplate, type PromptTemplateOptions, type PromptTemplateType, PromptTemplateTypes, type PromptType, PromptTypes, RStreamErrCode, RateLimit, ReadableStreamError, ResponseRStreamErrCode, type SanitizeFilenameOptions, Semaphore, type StreamCallbacksAndOptions, TaskAbortController, type TaskAbortControllers, type TaskPromise, TemplateArgProcessor, ToolFunc, WindowsReservedNameRegex, XXHashAlgorithm, backendEventable, base32768, countRegexMatches, createCallbacksTransformer, createEmptyReadableStream, createEndWithRepetitionDetector, createEventStreamTransformer, createHfValueFunc, dateToText, defaultTemplateFormat, expandEnv, expandObjEnv, extNameLevel, fileIsExists, filenameReservedRegex, filterValidFnScope, getAllEnumKeys, getConfigFileNames, getConfigs, getKeysPath, getMultiLevelExtname, getRealFilepath, getResponseErrorReadableStream, parse as hfParse, tokenize as hfTokenize, interpolateEnv, interpolateFString, interpolateGolangTemplate, isModelNameMatched, isValidFilename, isValidFilepath, isWebStream, jsonFilterToWhere, jsonToMarkdownStr, loadFileFromPaths, loadTextFromPaths, makeToolFuncCancelable, matchUrlProtocol, memoize, messagesToText, paramsSizeToScaleStr, parseCommand, parseFString, parseJsJson, parseObjectArgInfo, parseObjectArgumentInfos, parseObjectArguments, parseObjectArgumentsAsArgInfos, parseYaml, quoteStr, reControlCharsRegex, readFilenamesRecursiveSync, readableFromAsyncIterable, registerYamlTag, sanitizeFilename, sanitizeFilepath, saveConfigFile, scaleStrToParamsSize, sortedValues, splitSentence, textToDate, toDateTime, trimStartOfStreamHelper, truncTo, uuid, wait, xxhash, xxhash32, xxhash64, xxhashAsStr };