@xpert-ai/plugin-sdk 3.6.0-beta.6 → 3.6.0

package/src/lib/toolset/builtin.d.ts

@@ -1,54 +0,0 @@
-import { StructuredToolInterface } from '@langchain/core/tools';
-import { BaseStore } from '@langchain/langgraph';
-import { I18nObject, IXpertToolset, ToolProviderCredentials, TToolCredentials, TToolsetParams, XpertToolsetCategoryEnum } from '@metad/contracts';
-import { Logger } from '@nestjs/common';
-import { CommandBus, QueryBus } from '@nestjs/cqrs';
-import { BaseToolset } from './toolset';
-/**
- * The context params of creating toolset
- */
-export type TBuiltinToolsetParams = TToolsetParams & {
-    commandBus: CommandBus;
-    queryBus: QueryBus;
-    store?: BaseStore;
-};
-export interface IBuiltinToolset {
-    validateCredentials(credentials: TToolCredentials): Promise<void>;
-}
-export declare abstract class BuiltinToolset<T extends StructuredToolInterface = StructuredToolInterface, C = TToolCredentials> extends BaseToolset<T> implements IBuiltinToolset {
-    providerName: string;
-    protected toolset?: IXpertToolset;
-    protected params?: TBuiltinToolsetParams;
-    static provider: string;
-    protected logger: Logger;
-    providerType: XpertToolsetCategoryEnum.BUILTIN;
-    credentialsSchema?: {
-        [key: string]: ToolProviderCredentials;
-    };
-    get tenantId(): string;
-    get organizationId(): string;
-    get commandBus(): CommandBus<import("@nestjs/cqrs").ICommand>;
-    get queryBus(): QueryBus<import("@nestjs/cqrs").IQuery>;
-    get xpertId(): string;
-    constructor(providerName: string, toolset?: IXpertToolset, params?: TBuiltinToolsetParams);
-    validateCredentials(credentials: C): Promise<void>;
-    _validateCredentials(credentials: C): Promise<void>;
-    getId(): string;
-    getCredentials(): C;
-    getToolTitle(name: string): string | I18nObject;
-    /**
-     * Get credentials schema
-     *
-     * @returns Credentials schema
-     */
-    getCredentialsSchema(): {
-        [key: string]: ToolProviderCredentials;
-    };
-    /**
-     * Get toolset entity
-     *
-     * @returns XpertToolset
-     */
-    getToolset(): IXpertToolset;
-    getName(): string;
-}

package/src/lib/toolset/index.d.ts

@@ -1,5 +0,0 @@
-export * from './strategy.decorator';
-export * from './strategy.interface';
-export * from './strategy.registry';
-export * from './builtin';
-export * from './toolset';

package/src/lib/toolset/strategy.decorator.d.ts

@@ -1,5 +0,0 @@
-export declare const TOOLSET_STRATEGY = "TOOLSET_STRATEGY";
-/**
- * Decorator to mark a provider as a Toolset Strategy
- */
-export declare const ToolsetStrategy: (provider: string) => import("@nestjs/common").CustomDecorator<string>;

package/src/lib/toolset/strategy.interface.d.ts

@@ -1,28 +0,0 @@
-import { DynamicStructuredTool } from '@langchain/core/tools';
-import { I18nObject } from '@metad/contracts';
-import { ZodSchema } from 'zod';
-import { BuiltinToolset } from './builtin';
-export interface IToolsetStrategy<TConfig = any> {
-    /**
-     * Metadata about this toolset
-     */
-    readonly meta: {
-        author: string;
-        tags: string[];
-        name: string;
-        label: I18nObject;
-        description?: I18nObject;
-        configSchema: any;
-        icon?: {
-            svg?: string;
-            png?: string;
-            color?: string;
-        };
-    };
-    /**
-     * Validate the configuration
-     */
-    validateConfig(config: TConfig): Promise<void>;
-    create(config: TConfig): Promise<BuiltinToolset>;
-    createTools(): DynamicStructuredTool<ZodSchema>[];
-}

package/src/lib/toolset/strategy.registry.d.ts

@@ -1,6 +0,0 @@
-import { DiscoveryService, Reflector } from '@nestjs/core';
-import { IToolsetStrategy } from './strategy.interface';
-import { BaseStrategyRegistry } from '../strategy';
-export declare class ToolsetRegistry<TConfig = any> extends BaseStrategyRegistry<IToolsetStrategy<TConfig>> {
-    constructor(discoveryService: DiscoveryService, reflector: Reflector);
-}

package/src/lib/toolset/toolset.d.ts

@@ -1,53 +0,0 @@
-import { BaseToolkit, StructuredTool, StructuredToolInterface } from "@langchain/core/tools";
-import { I18nObject, TStateVariable, TToolsetParams } from "@metad/contracts";
-import { z } from 'zod';
-type ZodObjectAny = z.ZodObject<any, any, any, any>;
-/**
- * Base ability for all toolsets
- */
-export declare abstract class BaseToolset<T extends StructuredToolInterface = StructuredToolInterface> extends BaseToolkit {
-    protected params?: TToolsetParams;
-    abstract providerName: string;
-    tools: T[];
-    stateVariables: TStateVariable[];
-    constructor(params?: TToolsetParams);
-    /**
-     * Async init tools
-     *
-     * @returns
-     */
-    initTools(): Promise<T[]>;
-    /**
-     * Get ID of the toolset
-     */
-    abstract getId(): string;
-    /**
-     * Get name of the toolset
-     */
-    abstract getName(): string;
-    /**
-     * Get one tool
-     *
-     * @param toolName
-     * @returns
-     */
-    getTool(toolName: string): StructuredToolInterface<import("@langchain/core/tools").ToolSchemaBase, any, any>;
-    /**
-     * Get state variables config
-     *
-     * @returns State variables
-     */
-    getVariables(): Promise<TStateVariable[]>;
-    /**
-     * Get title of tool
-     */
-    abstract getToolTitle(name: string): string | I18nObject;
-    /**
-     * Close all (connections).
-     */
-    close(): Promise<void>;
-}
-export declare abstract class BaseTool<T extends ZodObjectAny = ZodObjectAny> extends StructuredTool<T> {
-    schema: any;
-}
-export {};

package/src/lib/types.d.ts

@@ -1,47 +0,0 @@
-import { PluginMeta } from '@metad/contracts';
-import type { DynamicModule, INestApplicationContext } from '@nestjs/common';
-import type { ZodSchema } from 'zod';
-export interface PluginLifecycle {
-    /** Called after module registration but before application startup */
-    onInit?(ctx: PluginContext): Promise<void> | void;
-    /** Called after application startup (can start serving externally) */
-    onStart?(ctx: PluginContext): Promise<void> | void;
-    /** Called during graceful shutdown */
-    onStop?(ctx: PluginContext): Promise<void> | void;
-}
-export interface PluginHealth {
-    /** Returns health status and optional dependency check details */
-    checkHealth?(ctx: PluginContext): Promise<{
-        status: 'up' | 'down';
-        details?: any;
-    }> | {
-        status: 'up' | 'down';
-        details?: any;
-    };
-}
-export interface PluginConfigSpec<T extends object = any> {
-    /** Zod validation schema for plugin-level config (optional) */
-    schema?: ZodSchema<T>;
-    /** Default configuration */
-    defaults?: Partial<T>;
-}
-export interface XpertPlugin<TConfig extends object = any> extends PluginLifecycle, PluginHealth {
-    meta: PluginMeta;
-    config?: PluginConfigSpec<TConfig>;
-    /** Returns the DynamicModule to be mounted to the main application (can be set as global) */
-    register(ctx: PluginContext<TConfig>): DynamicModule;
-}
-export interface PluginContext<TConfig extends object = any> {
-    app: INestApplicationContext;
-    logger: PluginLogger;
-    config: TConfig;
-    /** Helper method to access other Providers in the container */
-    resolve<TInput = any, TResult = TInput>(token: any): TResult;
-}
-export interface PluginLogger {
-    child(meta: Record<string, any>): PluginLogger;
-    debug(msg: string, meta?: any): void;
-    log(msg: string, meta?: any): void;
-    warn(msg: string, meta?: any): void;
-    error(msg: string, meta?: any): void;
-}

package/src/lib/vectorstore/index.d.ts

@@ -1,3 +0,0 @@
-export * from './strategy.decorator';
-export * from './strategy.interface';
-export * from './strategy.registry';

package/src/lib/vectorstore/strategy.decorator.d.ts

@@ -1,2 +0,0 @@
-export declare const VECTOR_STORE_STRATEGY = "VECTOR_STORE_STRATEGY";
-export declare const VectorStoreStrategy: (provider: string) => import("@nestjs/common").CustomDecorator<string>;

package/src/lib/vectorstore/strategy.interface.d.ts

@@ -1,24 +0,0 @@
-import { EmbeddingsInterface } from '@langchain/core/embeddings';
-import { VectorStore } from '@langchain/core/vectorstores';
-/**
- * Interface for VectorStore strategy。
- *
- *
- */
-export interface IVectorStoreStrategy<TConfig extends {
-    collectionName?: string;
-}> {
-    /**
-     * Metadata about the strategy
-     */
-    readonly name: string;
-    readonly description?: string;
-    /**
-     * Validate configuration for VectorStore
-     */
-    validateConfig(config: TConfig): Promise<void>;
-    /**
-     * Create a VectorStore with given config
-     */
-    createStore(embeddings: EmbeddingsInterface, config: TConfig): Promise<VectorStore>;
-}

package/src/lib/vectorstore/strategy.registry.d.ts

@@ -1,6 +0,0 @@
-import { DiscoveryService, Reflector } from '@nestjs/core';
-import { BaseStrategyRegistry } from '../strategy';
-import { IVectorStoreStrategy } from './strategy.interface';
-export declare class VectorStoreRegistry<TConfig = any> extends BaseStrategyRegistry<IVectorStoreStrategy<TConfig>> {
-    constructor(discoveryService: DiscoveryService, reflector: Reflector);
-}

package/src/lib/workflow/index.d.ts

@@ -1,2 +0,0 @@
-export * from './trigger/index';
-export * from './node/index';

package/src/lib/workflow/node/index.d.ts

@@ -1,3 +0,0 @@
-export * from './strategy.decorator';
-export * from './strategy.interface';
-export * from './strategy.registry';

package/src/lib/workflow/node/strategy.decorator.d.ts

@@ -1,5 +0,0 @@
-export declare const WORKFLOW_NODE_STRATEGY = "WORKFLOW_NODE_STRATEGY";
-/**
- * Decorator to mark a provider as a Workflow Node Strategy
- */
-export declare const WorkflowNodeStrategy: (provider: string) => import("@nestjs/common").CustomDecorator<string>;

package/src/lib/workflow/node/strategy.interface.d.ts

@@ -1,40 +0,0 @@
-import { Runnable } from '@langchain/core/runnables';
-import { BaseChannel } from '@langchain/langgraph';
-import { IEnvironment, IWorkflowNode, TWorkflowNodeMeta, TXpertGraph, TXpertParameter, TXpertTeamNode } from '@metad/contracts';
-export type TWorkflowNodeParams<TConfig = any> = {
-    xpertId: string;
-    agentKey?: string;
-    node: TXpertTeamNode;
-    config: TConfig;
-};
-/**
- * Workflow Node Strategy interface
- */
-export interface IWorkflowNodeStrategy<TConfig = any, TResult = any> {
-    /**
-     * Metadata describing the node (type, label, description, config schema, etc.)
-     */
-    meta: TWorkflowNodeMeta;
-    /**
-     * Create the node subgraph
-     */
-    create(payload: {
-        graph: TXpertGraph;
-        node: TXpertTeamNode & {
-            type: 'workflow';
-        };
-        xpertId: string;
-        environment: IEnvironment;
-        isDraft: boolean;
-    }): {
-        name?: string;
-        graph: Runnable;
-        ends: string[];
-        channel: {
-            name: string;
-            annotation: BaseChannel;
-        };
-        navigator?: (state: any, config: any) => Promise<any>;
-    };
-    outputVariables(entity: IWorkflowNode): TXpertParameter[];
-}

package/src/lib/workflow/node/strategy.registry.d.ts

@@ -1,9 +0,0 @@
-import { DiscoveryService, Reflector } from '@nestjs/core';
-import { BaseStrategyRegistry } from '../../strategy';
-import { IWorkflowNodeStrategy } from './strategy.interface';
-/**
- * Registry for Workflow Node Strategies
- */
-export declare class WorkflowNodeRegistry<TConfig = any, TResult = any> extends BaseStrategyRegistry<IWorkflowNodeStrategy<TConfig, TResult>> {
-    constructor(discoveryService: DiscoveryService, reflector: Reflector);
-}

package/src/lib/workflow/trigger/index.d.ts

@@ -1,3 +0,0 @@
-export * from './strategy.decorator';
-export * from './strategy.interface';
-export * from './strategy.registry';

package/src/lib/workflow/trigger/strategy.decorator.d.ts

@@ -1,2 +0,0 @@
-export declare const WORKFLOW_TRIGGER_STRATEGY = "WORKFLOW_TRIGGER_STRATEGY";
-export declare const WorkflowTriggerStrategy: (provider: string) => import("@nestjs/common").CustomDecorator<string>;

package/src/lib/workflow/trigger/strategy.interface.d.ts

@@ -1,22 +0,0 @@
-import { TWorkflowTriggerMeta, TXpertTeamNode } from '@metad/contracts';
-export type TWorkflowTriggerParams<T> = {
-    xpertId: string;
-    agentKey?: string;
-    node?: TXpertTeamNode;
-    config: T;
-};
-export interface IWorkflowTriggerStrategy<T> {
-    meta: TWorkflowTriggerMeta;
-    validate(payload: TWorkflowTriggerParams<T>): Promise<any[]>;
-    /**
-     * Initialize the trigger when publish xpert workflow
-     *
-     * @param payload
-     * @param callback
-     */
-    publish(payload: TWorkflowTriggerParams<T>, callback: (payload: any) => void): Promise<any> | void;
-    /**
-     * Stop the trigger
-     */
-    stop(payload: TWorkflowTriggerParams<T>): void;
-}

package/src/lib/workflow/trigger/strategy.registry.d.ts

@@ -1,6 +0,0 @@
-import { DiscoveryService, Reflector } from '@nestjs/core';
-import { BaseStrategyRegistry } from '../../strategy';
-import { IWorkflowTriggerStrategy } from './strategy.interface';
-export declare class WorkflowTriggerRegistry<T = any> extends BaseStrategyRegistry<IWorkflowTriggerStrategy<T>> {
-    constructor(discoveryService: DiscoveryService, reflector: Reflector);
-}