@xpert-ai/plugin-sdk 3.9.8 → 4.0.0

package/src/lib/agent/middleware/runtime-capability.d.ts

@@ -0,0 +1,22 @@
+export type RuntimeCapabilityKey<T> = {
+    readonly id: string;
+    readonly description?: string;
+    readonly __type?: T;
+};
+export declare function createRuntimeCapability<T>(id: string, options?: {
+    description?: string;
+}): RuntimeCapabilityKey<T>;
+export interface AgentMiddlewareRuntimeCapabilityRegistry {
+    has<T>(key: RuntimeCapabilityKey<T> | string): boolean;
+    get<T>(key: RuntimeCapabilityKey<T> | string): T | undefined;
+    require<T>(key: RuntimeCapabilityKey<T> | string): T;
+}
+export declare const XPERT_RUNTIME_CAPABILITIES_TOKEN = "XPERT_RUNTIME_CAPABILITIES";
+export declare class DefaultAgentMiddlewareRuntimeCapabilityRegistry implements AgentMiddlewareRuntimeCapabilityRegistry {
+    private readonly capabilities;
+    constructor(entries?: Array<[RuntimeCapabilityKey<unknown> | string, unknown]>);
+    register<T>(key: RuntimeCapabilityKey<T> | string, implementation: T): this;
+    has<T>(key: RuntimeCapabilityKey<T> | string): boolean;
+    get<T>(key: RuntimeCapabilityKey<T> | string): T | undefined;
+    require<T>(key: RuntimeCapabilityKey<T> | string): T;
+}

package/src/lib/agent/middleware/runtime.d.ts

@@ -1,11 +1,14 @@
 import { Embeddings } from '@langchain/core/embeddings';
 import { BaseLanguageModel } from '@langchain/core/language_models/base';
 import { BaseChatModel } from '@langchain/core/language_models/chat_models';
-import type { Runtime as LangGraphRuntime } from "@langchain/langgraph";
-import type { BaseMessage } from "@langchain/core/messages";
-import { ICopilotModel, ILLMUsage, IXpertAgentExecution, JSONValue, TSandboxConfigurable } from "@xpert-ai/contracts";
+import type { Runtime as LangGraphRuntime } from '@langchain/langgraph';
+import type { BaseMessage } from '@langchain/core/messages';
+import { ICopilotModel, ILLMUsage, IXpertAgentExecution, JSONValue, TSandboxConfigurable } from '@xpert-ai/contracts';
 import { Subscriber } from 'rxjs';
 import { IRerank } from '../../ai-model/types';
+import type { AgentMiddlewareRuntimeCapabilityRegistry } from './runtime-capability';
+export * from './runtime-capability';
+export * from './capabilities';
 /**
  * Type for the agent's built-in state properties.
  */
@@ -54,7 +57,7 @@ export type WithMaybeContext<TContext> = undefined extends TContext ? {
 /**
  * Runtime information available to middleware (readonly).
  */
-export type Runtime<TContext = unknown> = Partial<Omit<LangGraphRuntime<TContext>, "context" | "configurable">> & WithMaybeContext<TContext> & {
+export type Runtime<TContext = unknown> = Partial<Omit<LangGraphRuntime<TContext>, 'context' | 'configurable'>> & WithMaybeContext<TContext> & {
     configurable?: {
         thread_id?: string;
         sandbox?: TSandboxConfigurable | null;
@@ -75,8 +78,26 @@ export type AgentMiddlewareWrapWorkflowNodeExecutionParams = {
     subscriber?: Subscriber<MessageEvent>;
     catchError?: (error: Error) => Promise<void>;
 };
+export type AgentMiddlewareEventStatus = 'running' | 'success' | 'fail';
+export type AgentMiddlewareEvent = {
+    type?: 'middleware_event';
+    middlewareName?: string;
+    middlewareKey?: string;
+    title?: string;
+    message?: string;
+    status?: AgentMiddlewareEventStatus;
+    phase?: string;
+    executionId?: string;
+    threadId?: string;
+    created_date?: string;
+    end_date?: string;
+    error?: unknown;
+    data?: unknown;
+    [key: string]: unknown;
+};
 export interface AgentMiddlewareRuntimeApi {
     createModelClient<T = AgentMiddlewareModelClient>(copilotModel: ICopilotModel, options: AgentMiddlewareCreateModelClientOptions): Promise<T>;
     wrapWorkflowNodeExecution<T>(run: (execution: Partial<IXpertAgentExecution>) => Promise<AgentMiddlewareWrapWorkflowNodeExecutionResult<T>>, params: AgentMiddlewareWrapWorkflowNodeExecutionParams): Promise<T>;
+    emitMiddlewareEvent?(event: AgentMiddlewareEvent): Promise<void> | void;
+    capabilities?: AgentMiddlewareRuntimeCapabilityRegistry;
 }
-export {};

package/src/lib/agent/middleware/strategy.interface.d.ts

@@ -1,11 +1,12 @@
 import { IWFNMiddleware, TAgentMiddlewareMeta, TXpertFeatures } from '@xpert-ai/contracts';
-import { StructuredToolInterface } from "@langchain/core/tools";
+import { StructuredToolInterface } from '@langchain/core/tools';
 import { RunnableToolLike } from '@langchain/core/runnables';
 import { AgentMiddleware } from './types';
 import { PromiseOrValue } from '../../types';
 import { AgentMiddlewareRuntimeApi } from './runtime';
 export interface IAgentMiddlewareContext {
     tenantId: string;
+    organizationId?: string | null;
     userId: string;
     workspaceId?: string;
     projectId?: string;

package/src/lib/types.d.ts

@@ -1,4 +1,4 @@
-import { JsonSchemaObjectType, PluginMeta } from '@xpert-ai/contracts';
+import { IconDefinition, JsonSchemaObjectType, PluginMeta, PluginTargetApp, PluginTargetAppMeta, TAvatar, XpertTypeEnum } from '@xpert-ai/contracts';
 import type { DynamicModule, INestApplicationContext } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 import type { ZodSchema } from 'zod';
@@ -36,11 +36,43 @@ export interface PluginConfigSpec<T extends object = any> {
 export interface XpertPlugin<TConfig extends object = any> extends PluginLifecycle, PluginHealth {
     meta: PluginMeta;
     config?: PluginConfigSpec<TConfig>;
+    /**
+     * Xpert DSL templates contributed by this plugin. The platform namespaces
+     * template ids as `${pluginName}:${key}` when exposing them through the
+     * xpert-template API.
+     */
+    templates?: XpertTemplateContribution[] | XpertTemplateProvider;
     /** Declares the required system-level permissions for this plugin. */
     permissions?: Permissions;
     /** Returns the DynamicModule to be mounted to the main application (can be set as global) */
     register(ctx: PluginContext<TConfig>): DynamicModule;
 }
+export interface XpertTemplateContribution {
+    key: string;
+    id?: string;
+    name?: string;
+    title?: string;
+    description?: string;
+    category?: string;
+    copyright?: string | null;
+    privacyPolicy?: string | null;
+    avatar?: TAvatar;
+    icon?: IconDefinition;
+    type?: XpertTypeEnum | 'project';
+    targetApps?: PluginTargetApp[];
+    targetAppMeta?: PluginTargetAppMeta | null;
+    dslContent?: string;
+    export_data?: string;
+    order?: number;
+    default?: boolean;
+    startPrompts?: string[];
+    releaseNotes?: string;
+    xpertName?: string;
+    [key: string]: unknown;
+}
+export interface XpertTemplateProvider {
+    listTemplates(ctx: PluginContext): PromiseOrValue<XpertTemplateContribution[]>;
+}
 export interface PluginContext<TConfig extends object = any> {
     module: ModuleRef;
     app?: INestApplicationContext;

package/src/lib/view-extension/index.d.ts

@@ -1,4 +1,5 @@
 export * from './provider.decorator';
 export * from './provider.interface';
 export * from './provider.registry';
+export * from './remote-component-html';
 export * from './tokens';

package/src/lib/view-extension/provider.interface.d.ts

@@ -1,7 +1,16 @@
-import { XpertExtensionViewManifest, XpertResolvedViewHostContext, XpertViewActionRequest, XpertViewActionResult, XpertViewDataResult, XpertViewQuery } from '@xpert-ai/contracts';
+import { XpertExtensionViewManifest, XpertRemoteComponentEntry, XpertRemoteComponentViewSchema, XpertResolvedViewHostContext, XpertViewActionRequest, XpertViewActionResult, XpertViewDataResult, XpertViewParameterOptionsQuery, XpertViewParameterOptionsResult, XpertViewQuery } from '@xpert-ai/contracts';
+export interface XpertViewFileActionFile {
+    buffer: Buffer;
+    originalname?: string;
+    mimetype?: string;
+    size?: number;
+}
 export interface IXpertViewExtensionProvider {
     supports(context: XpertResolvedViewHostContext): Promise<boolean> | boolean;
     getViewManifests(context: XpertResolvedViewHostContext, slot: string): Promise<XpertExtensionViewManifest[]> | XpertExtensionViewManifest[];
     getViewData(context: XpertResolvedViewHostContext, viewKey: string, query: XpertViewQuery): Promise<XpertViewDataResult> | XpertViewDataResult;
     executeViewAction?(context: XpertResolvedViewHostContext, viewKey: string, actionKey: string, request: XpertViewActionRequest): Promise<XpertViewActionResult> | XpertViewActionResult;
+    executeViewFileAction?(context: XpertResolvedViewHostContext, viewKey: string, actionKey: string, request: XpertViewActionRequest, file: XpertViewFileActionFile): Promise<XpertViewActionResult> | XpertViewActionResult;
+    getViewParameterOptions?(context: XpertResolvedViewHostContext, viewKey: string, parameterKey: string, query: XpertViewParameterOptionsQuery): Promise<XpertViewParameterOptionsResult> | XpertViewParameterOptionsResult;
+    getRemoteComponentEntry?(context: XpertResolvedViewHostContext, viewKey: string, component: XpertRemoteComponentViewSchema['component']): Promise<XpertRemoteComponentEntry> | XpertRemoteComponentEntry;
 }

package/src/lib/view-extension/remote-component-html.d.ts

@@ -0,0 +1,9 @@
+export interface RenderRemoteReactIframeHtmlOptions {
+    title: string;
+    reactUmd: string;
+    reactDomUmd: string;
+    appScript: string;
+    appCss?: string;
+    lang?: string;
+}
+export declare function renderRemoteReactIframeHtml(options: RenderRemoteReactIframeHtmlOptions): string;