@metad/contracts 3.7.0 → 3.8.1

package/src/ai/xpert-tool-mcp.model.d.ts

@@ -1,7 +1,8 @@
 export declare enum MCPServerType {
     SSE = "sse",
     STDIO = "stdio",
-    CODE = "code"
+    CODE = "code",
+    HTTP = "http"
 }
 /**
  * Configuration for stdio transport connection
@@ -23,6 +24,19 @@ export interface SSEConnection {
     headers?: Record<string, string>;
     useNodeEventSource?: boolean;
 }
+/**
+ * Configuration for Streamable HTTP transport connection
+ */
+export interface HttpConnection {
+    transport: "http";
+    url: string;
+    headers?: Record<string, string>;
+    /**
+     * Whether to automatically fallback to SSE if Streamable HTTP is not available.
+     * Defaults to true.
+     */
+    automaticSSEFallback?: boolean;
+}
 export type TMCPServerReconnect = {
     /**
      * Whether to automatically restart the process if it exits
@@ -51,6 +65,11 @@ export type TMCPServer = {
     url?: string;
     headers?: Record<string, string>;
     useNodeEventSource?: boolean;
+    /**
+     * Whether to automatically fallback to SSE if Streamable HTTP is not available.
+     * Defaults to true. Only applicable for HTTP transport.
+     */
+    automaticSSEFallback?: boolean;
     /**
      * Default timeout in milliseconds for tool execution. Must be greater than 0.
      * If not specified, tools will use their own configured timeout values.

package/src/ai/xpert-workflow.model.d.ts

@@ -1,16 +1,18 @@
 import { I18nObject, IconDefinition } from "../types";
 import { ICopilotModel } from "./copilot-model.model";
 import { TKBRecallParams } from "./knowledgebase.model";
-import { ApiAuthType, TErrorHandling, TXpertRefParameter } from "./types";
+import { ApiAuthType, JsonSchemaObjectType, TErrorHandling, TXpertRefParameter } from "./types";
 import { TKBRetrievalSettings, TStateVariable, TXpertParameter } from "./xpert.model";
 export type TWorkflowNodeMeta = {
     name: string;
     label: I18nObject;
     icon: IconDefinition;
-    configSchema: any;
+    configSchema: JsonSchemaObjectType;
 };
 export type TWorkflowTriggerMeta = TWorkflowNodeMeta;
 export declare enum WorkflowNodeTypeEnum {
+    START = "start",
+    END = "end",
     /**
      * Trigger
      */
@@ -25,7 +27,11 @@ export declare enum WorkflowNodeTypeEnum {
     IF_ELSE = "if-else",
     LIST_OPERATOR = "list-operator",
     VARIABLE_AGGREGATOR = "variable-aggregator",
+    /**
+     * @deprecated use ITERATOR instead
+     */
     ITERATING = "iterating",
+    ITERATOR = "iterator",
     HTTP = "http",
     SUBFLOW = "subflow",
     TOOL = "tool",
@@ -149,6 +155,31 @@ export interface IWFNVariableAggregator extends IWorkflowNode {
     inputs: string[];
     outputType: string;
 }
+export interface IWFNIterator extends IWorkflowNode {
+    type: WorkflowNodeTypeEnum.ITERATOR;
+    /**
+     * Variable name of input array in state
+     */
+    inputVariable: string;
+    outputParams?: TXpertRefParameter[];
+    /**
+     * Execute in parallel, otherwise execute sequentially
+     */
+    parallel?: boolean;
+    /**
+     * Maximum number of parallel task
+     */
+    maximum?: number;
+    /**
+     * - terminate: terminate on error
+     * - ignore: ignore error and continue
+     * - remove: remove error output
+     */
+    errorMode?: 'terminate' | 'ignore' | 'remove';
+}
+/**
+ * @deprecated use IWFNIterator instead
+ */
 export interface IWFNIterating extends IWorkflowNode {
     type: WorkflowNodeTypeEnum.ITERATING;
     /**
@@ -173,10 +204,18 @@ export interface IWFNIterating extends IWorkflowNode {
     errorMode?: 'terminate' | 'ignore' | 'remove';
 }
 /**
- * The parameter name that represents the entire current element in array
+ * @deprecated use `IteratorItemParameterName` instead
  */
 export declare const IteratingItemParameterName = "$item";
+/**
+ * @deprecated use `IteratorIndexParameterName` instead
+ */
 export declare const IteratingIndexParameterName = "$index";
+/**
+ * The parameter name that represents the entire current element in array
+ */
+export declare const IteratorItemParameterName = "$item";
+export declare const IteratorIndexParameterName = "$index";
 export interface IWFNAnswer extends IWorkflowNode {
     type: WorkflowNodeTypeEnum.ANSWER;
     promptTemplate: string;
@@ -393,9 +432,14 @@ export declare function genListOperatorKey(): string;
 export declare function genVariableAggregatorKey(): string;
 export declare function genJSONStringifyKey(): string;
 export declare function genJSONParseKey(): string;
+export declare function genXpertIteratorKey(): string;
+export declare function genXpertStartKey(key: string): string;
 export declare function isAgentKey(key: string): boolean;
 export declare function isRouterKey(key: string): boolean;
+/**
+ * @deprecated use `isIteratorKey` instead
+ */
 export declare function isIteratingKey(key: string): boolean;
-export declare function isWorkflowKey(key: string): boolean;
+export declare function isIteratorKey(key: string): boolean;
 export declare function workflowNodeIdentifier(node: IWorkflowNode): string;
 export {};

package/src/ai/xpert.model.d.ts

@@ -1,4 +1,4 @@
-import { ToolCall as LToolCall } from '@langchain/core/dist/messages/tool';
+import { ToolCall as LToolCall } from '@langchain/core/messages/tool';
 import { RunnableToolLike } from '@langchain/core/runnables';
 import { StructuredToolInterface } from '@langchain/core/tools';
 import { ITag } from '../tag-entity.model';
@@ -10,11 +10,9 @@ import { IXpertAgent } from './xpert-agent.model';
 import { IXpertToolset } from './xpert-toolset.model';
 import { IBasePerWorkspaceEntityModel } from './xpert-workspace.model';
 import { IIntegration } from '../integration.model';
-import { TChatFrom, TSensitiveOperation } from './chat.model';
+import { TChatFrom } from './chat.model';
 import { IWorkflowNode, TVariableAssigner, TWFCase, VariableOperationEnum } from './xpert-workflow.model';
 import { IEnvironment } from './environment.model';
-import { IStorageFile } from '../storage-file.model';
-import { STATE_VARIABLE_HUMAN, TInterruptCommand } from '../agent/graph';
 export type ToolCall = LToolCall;
 export declare enum XpertTypeEnum {
     /**
@@ -30,6 +28,10 @@ export declare enum XpertTypeEnum {
      */
     Knowledge = "knowledge"
 }
+export type TXpertSandboxFeature = {
+    enabled: boolean;
+    provider?: string;
+};
 export type TXpertFeatures = {
     opener: {
         enabled: boolean;
@@ -59,6 +61,10 @@ export type TXpertFeatures = {
         enabled: boolean;
         scoreThreshold?: number;
     };
+    /**
+     * Sandbox feature
+     */
+    sandbox?: TXpertSandboxFeature;
 };
 export type TXpert = {
     /**
@@ -261,6 +267,7 @@ export type TXpertAgentConfig = {
          * Custom description for the tool
          */
         description?: string;
+        parameters?: Record<string, any>;
     }>;
 };
 export type TStateVariableType = XpertParameterTypeEnum | 'object' | 'array[string]' | 'array[number]' | 'array[object]';
@@ -373,33 +380,43 @@ export type TXpertTeamDraft = TXpertGraph & {
     checklist?: ChecklistItem[];
 };
 export type TXpertTeamNodeType = 'agent' | 'knowledge' | 'toolset' | 'xpert' | 'workflow';
-export type TXpertTeamNode = {
+export type TXpertTeamNodeBase = {
     key: string;
-    type: TXpertTeamNodeType;
     position: IRect;
     size?: ISize;
     hash?: string;
     parentId?: string;
     readonly?: boolean;
-} & ({
-    type: 'agent';
-    entity: IXpertAgent;
-} | {
-    type: 'knowledge';
-    entity: IKnowledgebase;
-} | {
-    type: 'toolset';
-    entity: IXpertToolset;
-} | {
-    type: 'xpert';
-    entity: IXpert;
-    nodes?: TXpertTeamNode[];
-    connections?: TXpertTeamConnection[];
-    expanded?: boolean;
-} | {
-    type: 'workflow';
-    entity: IWorkflowNode;
-});
+};
+/** type -> entity + extra props */
+export type TXpertTeamNodeSpec = {
+    agent: {
+        entity: IXpertAgent;
+    };
+    knowledge: {
+        entity: IKnowledgebase;
+    };
+    toolset: {
+        entity: IXpertToolset;
+    };
+    xpert: {
+        entity: IXpert;
+        nodes?: TXpertTeamNode[];
+        connections?: TXpertTeamConnection[];
+        expanded?: boolean;
+    };
+    workflow: {
+        entity: IWorkflowNode;
+    };
+};
+/** If you want TXpertTeamNodeType always match spec keys */
+export type TXpertTeamNodeType2 = keyof TXpertTeamNodeSpec;
+export type TXpertTeamNode<T extends TXpertTeamNodeType = TXpertTeamNodeType> = T extends TXpertTeamNodeType ? TXpertTeamNodeBase & {
+    type: T;
+} & TXpertTeamNodeSpec[T] : never;
+export type NodeOf<T extends keyof TXpertTeamNodeSpec> = TXpertTeamNode<T>;
+export type NodeEntity<T extends keyof TXpertTeamNodeSpec> = TXpertTeamNodeSpec[T]['entity'];
+export type AnyNodeEntity = NodeEntity<keyof TXpertTeamNodeSpec>;
 export interface IRect extends IPoint, Partial<ISize> {
     gravityCenter?: IPoint;
 }
@@ -423,83 +440,12 @@ export interface TXpertTeamConnection {
     type: 'edge' | TXpertTeamNodeType;
     readonly?: boolean;
 }
-export declare enum ChatMessageTypeEnum {
-    MESSAGE = "message",
-    EVENT = "event"
-}
-/**
- * https://js.langchain.com/docs/how_to/streaming/#event-reference
- */
-export declare enum ChatMessageEventTypeEnum {
-    ON_CONVERSATION_START = "on_conversation_start",
-    ON_CONVERSATION_END = "on_conversation_end",
-    ON_MESSAGE_START = "on_message_start",
-    ON_MESSAGE_END = "on_message_end",
-    ON_TOOL_START = "on_tool_start",
-    ON_TOOL_END = "on_tool_end",
-    ON_TOOL_ERROR = "on_tool_error",
-    /**
-     * Step message in tool call
-     */
-    ON_TOOL_MESSAGE = "on_tool_message",
-    ON_AGENT_START = "on_agent_start",
-    ON_AGENT_END = "on_agent_end",
-    ON_RETRIEVER_START = "on_retriever_start",
-    ON_RETRIEVER_END = "on_retriever_end",
-    ON_RETRIEVER_ERROR = "on_retriever_error",
-    ON_INTERRUPT = "on_interrupt",
-    ON_ERROR = "on_error",
-    ON_CHAT_EVENT = "on_chat_event"
-}
-/**
- * Human input message, include parameters and attachments
- */
-export type TChatRequestHuman = {
-    input?: string;
-    files?: Partial<IStorageFile>[];
-    [key: string]: unknown;
-};
-export type TChatRequest = {
-    /**
-     * The human input, include parameters
-     */
-    input: TChatRequestHuman;
-    /**
-     * Custom graph state
-     */
-    state?: {
-        [STATE_VARIABLE_HUMAN]: TChatRequestHuman;
-    } & Record<string, any>;
-    xpertId: string;
-    agentKey?: string;
-    projectId?: string;
-    conversationId?: string;
-    environmentId?: string;
-    id?: string;
-    executionId?: string;
-    confirm?: boolean;
-    /**
-     * Reject the sensitive tool calls
-     */
-    reject?: boolean;
-    /**
-     * Message to update parameters of last tool call message
-     * @deprecated use `command` instead
-     */
-    operation?: TSensitiveOperation;
-    command?: TInterruptCommand;
-    retry?: boolean;
-};
 export type TChatOptions = {
+    xpertId?: string;
     conversationId?: string;
-    /**
-     * @deprecated
-     */
-    knowledgebases?: string[];
-    /**
-     * @deprecated
-     */
-    toolsets?: string[];
+    messageId?: string;
+    thread_id?: string;
+    checkpointId?: string;
     /**
      * The language used by the current browser page
      */
@@ -528,6 +474,10 @@ export type TChatOptions = {
      * Specify environment with variables to run
      */
     environment?: IEnvironment;
+    /**
+     * PRO: Specify a sandbox environment container to run in
+     */
+    sandboxEnvironmentId?: string;
     /**
      * Specify additional tools
      */
@@ -549,3 +499,4 @@ export type TKBRetrievalSettings = {
         fields: Record<string, object>;
     };
 };
+export declare function isXpertNodeType<T extends TXpertTeamNodeType>(type: T): (node: TXpertTeamNode) => node is NodeOf<T>;

package/src/ai/xpert.utils.d.ts

@@ -44,6 +44,13 @@ export declare function omitXpertRelations(xpert: Partial<IXpert>): {
     copilotModelId?: string;
     tags?: import("..").ITag[];
 };
+/**
+ * Figure out latest xpert or draft xpert.
+ *
+ * @param xpert
+ * @param isDraft Is draft
+ * @returns
+ */
 export declare function figureOutXpert(xpert: IXpert, isDraft: boolean): Partial<IXpert>;
 export declare function xpertLabel(agent: Partial<IXpert>): string;
 export declare function createXpertGraph(xpert: IXpert, position: IPoint): {

package/src/integration/lark.d.ts

@@ -1,11 +1,5 @@
 import { TIntegrationProvider } from '../integration.model';
-export type TIntegrationLarkOptions = {
-    isLark?: boolean;
-    appId: string;
-    appSecret: string;
-    verificationToken: string;
-    encryptKey: string;
-    xpertId: string;
-    preferLanguage: string;
-};
+/**
+ * @deprecated use plugin
+ */
 export declare const IntegrationLarkProvider: TIntegrationProvider;

package/src/integration.model.d.ts

@@ -81,10 +81,5 @@ export type TIntegrationProvider = {
     schema?: TParameterSchema;
     features?: IntegrationFeatureEnum[];
     helpUrl?: string;
-    /**
-     * Webhook URL generator, for example:
-     * `{{apiBaseUrl}}/api/integration/webhook/{{integrationId}}`
-     */
-    webhookUrl?: string;
     pro?: boolean;
 };

package/src/organization-contact.model.d.ts

@@ -17,7 +17,6 @@ export interface IOrganizationContact extends IBaseEntityWithMembers {
     imageUrl?: string;
     inviteStatus?: string;
     tags: ITag[];
-    contact: IContact;
     budget?: number;
     budgetType?: OrganizationContactBudgetTypeEnum;
 }

package/src/organization.model.d.ts

@@ -70,7 +70,6 @@ export interface IOrganization extends IBasePerTenantEntityModel {
     defaultStartTime?: string;
     defaultEndTime?: string;
     registrationDate?: Date;
-    contact: IContact;
     separateInvoiceItemTaxAndDiscount?: boolean;
     minimumProjectSize?: string;
     show_clients?: boolean;

package/src/plugin.d.ts

@@ -1,8 +1,23 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
 import { IconDefinition } from './types';
 export type PluginName = string;
+export declare const PLUGIN_LEVEL: {
+    readonly SYSTEM: "system";
+    readonly ORGANIZATION: "organization";
+};
+/**
+ * Classifies plugin scope and governance.
+ * - `system`: built-in/platform-managed plugin that users cannot install/uninstall from org APIs.
+ * - `organization`: tenant/org-managed plugin that can be installed and removed per organization.
+ */
+export type PluginLevel = (typeof PLUGIN_LEVEL)[keyof typeof PLUGIN_LEVEL];
 export interface PluginMeta {
     name: PluginName;
     version: string;
+    /**
+     * Declares the plugin's operational level used for visibility and install/uninstall guardrails.
+     */
+    level?: PluginLevel;
     icon?: IconDefinition;
     category: 'set' | 'doc-source' | 'agent' | 'tools' | 'model' | 'vlm' | 'vector-store' | 'integration' | 'datasource' | 'database' | 'middleware';
     displayName: string;
@@ -11,3 +26,11 @@ export interface PluginMeta {
     author: string;
     homepage?: string;
 }
+export interface IPlugin extends IBasePerTenantAndOrganizationEntityModel {
+    pluginName: string;
+    packageName: string;
+    version?: string;
+    source?: 'marketplace' | 'local' | 'git' | 'url' | 'npm' | 'code' | 'env';
+    level?: PluginLevel;
+    config: Record<string, any>;
+}

package/src/user.model.d.ts

@@ -2,7 +2,7 @@ import { IRole } from './role.model';
 import { IBasePerTenantEntityModel } from './base-entity.model';
 import { ITag } from './tag-entity.model';
 import { IEmployee } from './employee.model';
-import { IOrganization } from './organization.model';
+import { IUserOrganization } from './user-organization.model';
 export declare enum UserType {
     USER = "user",// Regular user
     COMMUNICATION = "communication"
@@ -27,7 +27,7 @@ export interface IUser extends IBasePerTenantEntityModel {
     preferredLanguage?: string;
     paymentsId?: string;
     fullName?: string;
-    organizations?: IOrganization[];
+    organizations?: IUserOrganization[];
     isImporting?: boolean;
     sourceId?: string;
     emailVerified?: boolean;