@metad/contracts 3.7.0 → 3.8.0

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,3 +1,4 @@
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
 import { IconDefinition } from './types';
 export type PluginName = string;
 export interface PluginMeta {
@@ -11,3 +12,10 @@ 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";
+    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;