@isdk/ai-tool 0.3.0 → 0.5.0

package/dist/index-BC3GQn6-.d.ts

@@ -1,488 +0,0 @@
-import { EventEmitter, Event } from 'events-ex';
-import { AdvancePropertyManager } from 'property-manager';
-import { ICacheOptions, Cache } from 'secondary-cache';
-import * as _isdk_common_error from '@isdk/common-error';
-import { IncomingMessage, ServerResponse } from 'http';
-
-declare const ToolAsyncMultiTaskBit = 0;
-declare const ToolAsyncCancelableBit = 1;
-declare const ToolAsyncPriorityBit = 2;
-declare enum AsyncFeatureBits {
-    MultiTask = 0,
-    Cancelable = 1,
-    Priority = 2
-}
-declare enum AsyncFeatures {
-    MultiTask = 1,// B0001
-    Cancelable = 2,// B010
-    Priority = 4
-}
-type FuncParamType = string;
-interface FuncParam {
-    name?: string;
-    type?: FuncParamType;
-    required?: boolean;
-    description?: string;
-    asyncFeatures?: number;
-    depends?: {
-        [name: string]: ToolFunc;
-    };
-}
-interface FuncParams {
-    [name: string]: FuncParam | FuncParamType;
-}
-type TFunc = (this: ToolFunc, ...params: any[]) => any;
-interface BaseFuncItem {
-    name?: string;
-    params?: FuncParams | FuncParam[];
-    result?: string;
-    scope?: any;
-    tags?: string | string[];
-    setup?: (this: ToolFunc, options?: FuncItem) => void;
-    isApi?: boolean;
-    stream?: boolean;
-}
-interface FuncItem extends BaseFuncItem {
-    func?: TFunc;
-}
-interface BaseFunc extends BaseFuncItem {
-    func(...params: any): any;
-}
-interface Funcs {
-    [name: string]: ToolFunc;
-}
-interface ToolFuncPackage {
-    name: string;
-    register: (data?: any) => void;
-    unregister?: () => void;
-}
-declare interface ToolFunc extends BaseFunc {
-    [name: string]: any;
-}
-declare class ToolFunc extends AdvancePropertyManager {
-    static items: Funcs;
-    static dataPath: string;
-    static get(name: string): ToolFunc;
-    static list(): Funcs;
-    static getByTag(tagName: string): ToolFunc | undefined;
-    static getAllByTag(tagName: string): ToolFunc[];
-    static hasAsyncFeature(feature: AsyncFeatureBits): boolean;
-    static run(name: string, params?: any): Promise<any>;
-    static runSync(name: string, params?: any): any;
-    static getFunc(name: string): any;
-    static runWithPos(name: string, ...params: any[]): Promise<any>;
-    static runWithPosSync(name: string, ...params: any[]): any;
-    static getFuncWithPos(name: string): any;
-    static register(name: string, options: FuncItem): boolean | ToolFunc;
-    static register(func: Function, options: FuncItem): boolean | ToolFunc;
-    static register(name: string | ToolFunc | Function | FuncItem, options?: FuncItem): boolean | ToolFunc;
-    static unregister(name: string): ToolFunc | undefined;
-    constructor(name: string | Function | FuncItem, options?: FuncItem | any);
-    register(): boolean | ToolFunc;
-    unregister(): any;
-    arr2ObjParams(params: any[]): any[];
-    obj2ArrParams(params?: any): any[];
-    runSync(params?: any): any;
-    run(params?: any): Promise<any>;
-    runAs(name: string, params?: any): Promise<any>;
-    runAsSync(name: string, params?: any): any;
-    getFunc(name?: string): any;
-    runWithPosSync(...params: any[]): any;
-    runWithPosAsSync(name: string, ...params: any[]): any;
-    runWithPos(...params: any[]): Promise<any>;
-    runWithPosAs(name: string, ...params: any[]): Promise<any>;
-    getFuncWithPos(name?: string): any;
-    hasAsyncFeature(feature: AsyncFeatureBits): boolean;
-    isStream(params: any): boolean | undefined;
-}
-declare const ToolFuncSchema: {
-    name: {
-        type: string;
-    };
-    description: {
-        type: string;
-    };
-    func: {
-        type: string;
-        assign(value: Function | string, dest: ToolFunc, src?: ToolFunc, name?: string, options?: any): string | Function;
-    };
-    params: {
-        type: string;
-    };
-    result: {
-        type: string;
-    };
-    setup: {
-        type: string;
-    };
-    depends: {
-        type: string;
-        exported: boolean;
-    };
-    tags: {
-        type: string[];
-    };
-    isApi: {
-        type: string;
-    };
-    stream: {
-        type: string;
-    };
-    asyncFeatures: {
-        type: string;
-    };
-};
-
-declare const PASSING_SCORE = 0.618;
-declare const ActionNames: readonly ["get", "post", "put", "delete", "patch", "list", "res"];
-type ActionName = typeof ActionNames[number];
-type AIModelNameRuleFn = (name: string) => string | RegExpExecArray | undefined;
-type AIModelNameRule = string | RegExp | AIModelNameRuleFn;
-type AIModelNameRules = AIModelNameRule | AIModelNameRule[];
-declare const RemoteToolFuncSchema: {
-    apiRoot: {
-        type: string;
-        get(this: any): any;
-        set(this: any, value: string): void;
-    };
-    action: {
-        type: string;
-        assign(value: ActionName, dest: any, src?: any, name?: string, options?: any): "get" | "post" | "put" | "delete" | "patch" | "list" | "res";
-    };
-    fetchOptions: {
-        type: string;
-    };
-    allowExportFunc: {
-        type: string;
-    };
-};
-interface RemoteFuncItem extends BaseFuncItem {
-    apiRoot?: string;
-    action?: ActionName;
-    fetchOptions?: any;
-}
-
-type Events = (string | RegExp)[];
-type Client = {
-    req: IncomingMessage;
-    res: ServerResponse;
-    events?: Events;
-};
-declare const SSEChannelAlreadyClosedErrCode = 498;
-/**
- * A class for creating Server-Sent Events (SSE) channels.
- * @example
- * const sseChannel = new SSEChannel({ pingInterval: 5000 })
- * sseChannel.publish('Hello, world!', 'greeting')
- */
-declare class SSEChannel {
-    _active: boolean;
-    clients: Set<Client>;
-    messages: Record<string, any>[];
-    nextID: number;
-    options: Record<string, any>;
-    pingTimer?: NodeJS.Timeout;
-    get active(): boolean;
-    set active(v: boolean);
-    /**
-     * Creates a new SSE channel.
-     * @param options - The options for the SSE channel.
-     */
-    constructor(options?: Record<string, any>);
-    /**
-     * Publishes a message to the SSE channel.
-     * @param {string | Record<string, any>} data - The data to send. It can be a string or an object.
-     * @param {string} eventName - The name of the event.
-     * @returns {number | undefined} - Returns the ID of the message.
-     * @throws Will throw an error if the channel is closed.
-     */
-    publish(data?: string | Record<string, any>, eventName?: string): number | undefined;
-    /**
-     * Subscribes a client to the SSE channel.
-     * @param {IncomingMessage} req - The request object.
-     * @param {ServerResponse} res - The response object.
-     * @param {Events} events - The events to subscribe to.
-     * @returns {Client} - Returns the client object.
-     * @throws Will throw an error if the channel is closed.
-     */
-    subscribe(req: IncomingMessage, res: ServerResponse, events?: Events): {
-        req: IncomingMessage;
-        res: ServerResponse<IncomingMessage>;
-        events: Events | undefined;
-    };
-    /**
-     * Unsubscribes a client from the SSE channel.
-     * @param {Client} c - The client to unsubscribe.
-     */
-    unsubscribe(c: Client): void;
-    clearClients(): void;
-    /**
-     * Lists the clients connected to the SSE channel grouped by IP address.
-     * @returns - Returns an object where the keys are the IP addresses and the values are the number of clients connected from each IP.
-     */
-    listClients(): Record<string, number>;
-    /**
-     * Gets the number of clients subscribed to the SSE channel.
-     * @returns - Returns the number of clients.
-     */
-    getSubscriberCount(): number;
-}
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
-
-interface ClientFuncItem extends RemoteFuncItem {
-}
-declare interface ClientTools extends ClientFuncItem {
-    [name: string]: any;
-}
-declare class ClientTools extends ToolFunc {
-    apiRoot: string | undefined;
-    private static _apiRoot?;
-    static get apiRoot(): string | undefined;
-    static setApiRoot(v: string): void;
-    static loadFrom(): Promise<void>;
-    static loadFromSync(items: Funcs): void;
-    static fetch(name: string, objParam?: any): Promise<any>;
-    getUrlParams(objParam: any): string;
-    fetch(objParam?: any, act?: ActionName, subName?: any): Promise<Response>;
-    errorFrom(res: Response): Promise<_isdk_common_error.CommonError>;
-    func(objParam: any): Promise<any>;
-}
-declare const ClientToolFuncSchema: {
-    apiRoot: {
-        type: string;
-        get(this: any): any;
-        set(this: any, value: string): void;
-    };
-    action: {
-        type: string;
-        assign(value: ActionName, dest: any, src?: any, name?: string, options?: any): "get" | "post" | "put" | "delete" | "patch" | "list" | "res";
-    };
-    fetchOptions: {
-        type: string;
-    };
-    allowExportFunc: {
-        type: string;
-    };
-};
-
-/**
- * Convention: Always pass _req, _res
- */
-interface ServerFuncParams {
-    _req?: IncomingMessage;
-    _res?: ServerResponse;
-    [name: string]: any;
-}
-interface ServerFuncItem extends RemoteFuncItem {
-    allowExportFunc?: boolean;
-}
-declare interface ServerTools extends ServerFuncItem {
-    [name: string]: any;
-}
-declare class ServerTools extends ToolFunc {
-    private static _apiRoot?;
-    static get apiRoot(): string | undefined;
-    static setApiRoot(v: string): void;
-    static toJSON(): {
-        [name: string]: ServerTools;
-    };
-    func({}: {}): Promise<any> | any;
-}
-declare const ServerToolFuncSchema: {
-    apiRoot: {
-        type: string;
-        get(this: any): any;
-        set(this: any, value: string): void;
-    };
-    action: {
-        type: string;
-        assign(value: ActionName, dest: any, src?: any, name?: string, options?: any): "get" | "post" | "put" | "delete" | "patch" | "list" | "res";
-    };
-    fetchOptions: {
-        type: string;
-    };
-    allowExportFunc: {
-        type: string;
-    };
-};
-
-declare class EventToolFunc extends ToolFunc {
-    _emitter: EventEmitter;
-    description: string;
-    result: string;
-    get emitter(): EventEmitter;
-    func(): EventEmitter;
-}
-declare const event: EventToolFunc;
-
-declare function _lrucache(this: ToolFunc, { key, value, options }?: {
-    key?: string;
-    value?: any;
-    options?: ICacheOptions | number;
-}): Cache;
-declare function createLRUCache(name: string, options?: ICacheOptions | number): ToolFunc;
-declare const lrucache: ToolFunc;
-
-interface RpcMethodsClientFuncParams {
-    act?: string;
-    [name: string]: any;
-}
-declare class RpcMethodsClientTool extends ClientTools {
-    _func(action: ActionName, options: RpcMethodsClientFuncParams): Promise<any>;
-    func(options: RpcMethodsClientFuncParams): Promise<any>;
-    assignMethods(methods: string[]): void;
-}
-
-interface ResClientFuncParams extends RpcMethodsClientFuncParams {
-    id?: string | number;
-}
-interface ResClientTools {
-    get?({ id }: ResClientFuncParams): any;
-    post?(options: ResClientFuncParams): any;
-    put?({ id }: ResClientFuncParams): any;
-    delete?({ id }: ResClientFuncParams): any;
-    list?(options: ResClientFuncParams): any;
-}
-declare class ResClientTools extends RpcMethodsClientTool {
-    fetch(options: ResClientFuncParams, action: ActionName): Promise<Response>;
-}
-
-interface EventClientFuncParams {
-    event?: string | string[];
-    data?: any;
-    act?: 'sub' | 'pub' | 'unsub' | 'init';
-    listener?: (...args: any[]) => void;
-}
-declare class EventClient extends ResClientTools {
-    _es: EventSource | undefined;
-    _esEvents: string[] | undefined;
-    _sseEvents: Record<string, (e: MessageEvent) => void>;
-    _forwardEvents: Set<string>;
-    get evtSource(): EventSource;
-    get active(): boolean;
-    set active(v: boolean);
-    name: string;
-    description: string;
-    initEventSource(events?: string | string[]): EventSource;
-    esListener(event: MessageEvent): void;
-    ebListener: (this: Event, ...data: any[]) => Promise<void>;
-    /**
-     * subscribe server sent event(SSE)
-     * @param events
-     */
-    subscribe(events: string | string[]): Promise<any>;
-    /**
-     * unsubscribe server sent event(SSE)
-     * @param events
-     */
-    unsubscribe(events: string | string[]): Promise<any>;
-    /**
-     * forward local event(s) to server
-     *
-     * subscribe these local events to forward/publish to server
-     *
-     * Note: pls backendEventable(ClientTools or EventClient) first
-     * @param events
-     */
-    forwardEvent(events: string | string[]): void;
-    /**
-     * unforward local event(s) to server
-     *
-     * unsubscribe these local events not to forward/publish to server
-     *
-     * Note: pls backendEventable(ClientTools or EventClient) first
-     * @param events
-     */
-    unforwardEvent(events: string | string[]): void;
-    init(events: string | string[]): Promise<any>;
-}
-declare const eventClient: EventClient;
-
-interface RpcMethodsServerFuncParams extends ServerFuncParams {
-    act?: string;
-}
-interface RpcMethodsServerTool {
-    methods: string[];
-}
-declare class RpcMethodsServerTool extends ServerTools {
-    static SpecialRpcMethodNames?: string[];
-    params: FuncParams;
-    get SpecialRpcMethodNames(): any;
-    initRpcMethods(methods?: string[]): void;
-    constructor(name: string | Function | FuncItem, options?: FuncItem | any);
-    cast(key: string, value: any): any;
-    getMethodFromParams(params: RpcMethodsServerFuncParams): string | undefined;
-    castParams(params: RpcMethodsServerFuncParams): RpcMethodsServerFuncParams;
-    func(params: RpcMethodsServerFuncParams): any;
-}
-
-interface ResServerFuncParams extends RpcMethodsServerFuncParams {
-    id?: string | number;
-    val?: any;
-}
-interface ResServerTools {
-    get?({ id }: ResServerFuncParams): any;
-    post?(options: ResServerFuncParams): any;
-    put?({ id }: ResServerFuncParams): any;
-    delete?({ id }: ResServerFuncParams): any;
-    list?(options?: ResServerFuncParams): any;
-}
-declare class ResServerTools extends RpcMethodsServerTool {
-    static SpecialRpcMethodNames: any;
-    action: ActionName;
-    params: FuncParams;
-    constructor(name: string | Function | FuncItem, options?: FuncItem | any);
-    getMethodFromParams(params: ResServerFuncParams): string | undefined;
-    castParams(params: RpcMethodsServerFuncParams): RpcMethodsServerFuncParams;
-}
-
-interface EventServerFuncParams extends ServerFuncParams {
-    event?: string | string[];
-    data?: any;
-    act?: 'sub' | 'pub' | 'unsub';
-}
-declare class EventServer extends ResServerTools {
-    static _sse: SSEChannel | undefined;
-    static get sse(): SSEChannel;
-    name: string;
-    description: string;
-    result: string;
-    depends: {
-        "event-bus": EventToolFunc;
-    };
-    get sse(): any;
-    static publish(data: any, event: string): number | undefined;
-    static ebListener: (this: Event, ...data: any[]) => void;
-    static subscribe(req: IncomingMessage, res: ServerResponse, events?: string[]): {
-        req: IncomingMessage;
-        res: ServerResponse<IncomingMessage>;
-        events: (string | RegExp)[] | undefined;
-    };
-    static alreadyForward(event: string): true | undefined;
-    publishSSE(data: any, event: string): any;
-    subscribeSSE(req: IncomingMessage, res: ServerResponse, events?: string | string[]): any;
-    forward(events: string | string[]): void;
-    unforward(events: string | string[]): void;
-    list({ _req, _res, event }: EventServerFuncParams): void;
-    $sub({ event }: EventServerFuncParams): {
-        event: string | string[];
-    } | undefined;
-    $unsub({ event }: EventServerFuncParams): {
-        event: string | string[];
-    } | undefined;
-    $publish({ event: events, data }: EventServerFuncParams): {
-        event: string[];
-    } | undefined;
-    isStream(params: ServerFuncParams): boolean;
-}
-declare const eventServer: EventServer;
-
-declare function registerCoreTools(): void;
-
-export { AsyncFeatures as A, type BaseFuncItem as B, type ClientFuncItem as C, event as D, EventToolFunc as E, type FuncParamType as F, createLRUCache as G, lrucache as H, type EventClientFuncParams as I, EventClient as J, eventClient as K, type EventServerFuncParams as L, EventServer as M, eventServer as N, type ResClientFuncParams as O, PASSING_SCORE as P, ResClientTools as Q, RemoteToolFuncSchema as R, SSEChannelAlreadyClosedErrCode as S, ToolFunc as T, type ResServerFuncParams as U, ResServerTools as V, _lrucache as _, type AIModelNameRules as a, ActionNames as b, type ActionName as c, type AIModelNameRuleFn as d, type AIModelNameRule as e, type RemoteFuncItem as f, SSEChannel as g, ToolAsyncMultiTaskBit as h, ToolAsyncCancelableBit as i, ToolAsyncPriorityBit as j, AsyncFeatureBits as k, type FuncParam as l, type FuncParams as m, type TFunc as n, type FuncItem as o, type BaseFunc as p, type Funcs as q, type ToolFuncPackage as r, ToolFuncSchema as s, ClientTools as t, ClientToolFuncSchema as u, type ServerFuncParams as v, type ServerFuncItem as w, ServerTools as x, ServerToolFuncSchema as y, registerCoreTools as z };