@xpert-ai/contracts 3.9.3 → 3.9.5

package/src/ai/knowledge-pipeline.d.ts

@@ -94,6 +94,10 @@ export interface IWFNKnowledgeBase extends IWorkflowNode {
      * @deprecated Configure rerank model on the knowledgebase.
      */
     rerankModel?: ICopilotModel;
+    /**
+     * @deprecated Configure chat model on the knowledgebase.
+     */
+    chatModel?: ICopilotModel;
     /**
      * @deprecated Configure vision model on the knowledgebase.
      */

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

@@ -5,6 +5,7 @@ import { IKnowledgeDocument } from './knowledge-doc.model';
 import { IXpert } from './xpert.model';
 import { IIntegration } from '../integration.model';
 import { IDocChunkMetadata } from './knowledge-doc-chunk.model';
+import type { GraphRagConfig, KnowledgeGraphStatus } from './knowledge-graph.model';
 /**
  * Non-internal types should remain the same as IntegrationEnum.
  */
@@ -67,6 +68,11 @@ export type TKnowledgebase = {
      */
     copilotModel?: ICopilotModel;
     copilotModelId?: string;
+    /**
+     * Chat model for knowledgebase LLM tasks.
+     */
+    chatModel?: ICopilotModel | null;
+    chatModelId?: string | null;
     embeddingCollectionName?: string | null;
     embeddingModelFingerprint?: string | null;
     embeddingDimensions?: number | null;
@@ -79,6 +85,10 @@ export type TKnowledgebase = {
     pendingEmbeddingRevision?: number | null;
     rebuildTaskId?: string | null;
     embeddingRebuildError?: string | null;
+    graphRag?: GraphRagConfig | null;
+    graphStatus?: KnowledgeGraphStatus | null;
+    graphRevision?: number | null;
+    graphIndexError?: string | null;
     rerankModel?: ICopilotModel;
     rerankModelId?: string;
     visionModel?: ICopilotModel;

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

@@ -1,7 +1,8 @@
-import { IWorkflowNode, WorkflowNodeTypeEnum } from "./xpert-workflow.model";
-import { I18nObject, IconDefinition } from "../types";
-import { TXpertFeatureKey, TXpertGraph, TXpertTeamNode } from "./xpert.model";
-import { JsonSchemaObjectType } from "./types";
+import { IWorkflowNode, WorkflowNodeTypeEnum } from './xpert-workflow.model';
+import { I18nObject, IconDefinition } from '../types';
+import { TXpertFeatureKey, TXpertGraph, TXpertTeamNode } from './xpert.model';
+import { JsonSchemaObjectType } from './types';
+import type { SkillSlashCommand } from './skill.model';
 export declare const LEGACY_SANDBOX_COMPRESSION_MIDDLEWARE_NAME = "SandboxCompressionMiddleware";
 export declare const CONTEXT_COMPRESSION_MIDDLEWARE_NAME = "ContextCompressionMiddleware";
 export interface IWFNMiddleware extends IWorkflowNode {
@@ -30,5 +31,6 @@ export type TAgentMiddlewareMeta = {
     description?: I18nObject;
     configSchema?: JsonSchemaObjectType;
     features?: TXpertFeatureKey[];
+    slashCommands?: SkillSlashCommand[];
 };
 export declare function getAgentMiddlewareNodes(graph: TXpertGraph, agentKey: string): TXpertTeamNode[];

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

@@ -0,0 +1,51 @@
+import { IconDefinition } from '../types';
+import { IBasePerWorkspaceEntityModel } from './xpert-workspace.model';
+import { SkillSlashCommandAvailability } from './skill.model';
+export type PromptWorkflowVisibility = 'private' | 'team' | 'tenant';
+export type PromptWorkflowSourceType = 'xpert' | 'workspace_prompt_workflow' | 'skill';
+export type PromptWorkflowCommandPriority = 'normal' | 'preferred';
+export type TPromptWorkflow = {
+    name: string;
+    label?: string;
+    description?: string;
+    icon?: string | IconDefinition | Record<string, unknown>;
+    category?: string;
+    aliases?: string[];
+    argsHint?: string;
+    template: string;
+    tags?: string[];
+    visibility?: PromptWorkflowVisibility;
+    runtimeCapabilities?: unknown;
+    archivedAt?: Date | string | null;
+};
+export interface IPromptWorkflow extends IBasePerWorkspaceEntityModel, TPromptWorkflow {
+}
+export type TPromptWorkflowCommandSnapshot = TPromptWorkflow & {
+    workflowId?: string;
+    workspaceId?: string;
+};
+export type TXpertCommandProfileEntry = {
+    id?: string;
+    source: PromptWorkflowSourceType;
+    enabled?: boolean;
+    order?: number;
+    priority?: PromptWorkflowCommandPriority;
+    workflowId?: string;
+    skillCommandName?: string;
+    snapshot?: TPromptWorkflowCommandSnapshot;
+    name?: string;
+    label?: string;
+    description?: string;
+    icon?: string | IconDefinition | Record<string, unknown>;
+    category?: string;
+    aliases?: string[];
+    argsHint?: string;
+    template?: string;
+    runtimeCapabilities?: unknown;
+    availability?: SkillSlashCommandAvailability;
+};
+export type TXpertCommandProfile = {
+    version: 1;
+    enabled?: boolean;
+    commands?: TXpertCommandProfileEntry[];
+};

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

@@ -1,8 +1,9 @@
-import { IBasePerTenantAndOrganizationEntityModel } from "../base-entity.model";
-import { I18nObject, IconDefinition } from "../types";
-import { JsonSchemaObjectType } from "./types";
-import { IWorkflowNode, WorkflowNodeTypeEnum } from "./xpert-workflow.model";
-import { IBasePerWorkspaceEntityModel } from "./xpert-workspace.model";
+import type { ChatKitPromptWorkflow, ChatKitSlashCommand, ChatKitSlashCommandAction, ChatKitSlashCommandAvailability, ChatKitSlashCommandCapability, ChatKitSlashCommandKind } from '@xpert-ai/chatkit-types';
+import { IBasePerTenantAndOrganizationEntityModel } from '../base-entity.model';
+import { I18nObject, IconDefinition } from '../types';
+import { JsonSchemaObjectType } from './types';
+import { IWorkflowNode, WorkflowNodeTypeEnum } from './xpert-workflow.model';
+import { IBasePerWorkspaceEntityModel } from './xpert-workspace.model';
 export type SkillId = string;
 export declare const WORKSPACE_PUBLIC_SKILL_SOURCE_PROVIDER = "workspace-public";
 export declare const WORKSPACE_PUBLIC_SKILL_REPOSITORY_NAME = "Workspace Shared Skills";
@@ -21,6 +22,14 @@ export interface ISkillRepositoryIndexPublisher {
     image?: string;
     kind?: string;
 }
+export type SkillSlashCommandCapability = ChatKitSlashCommandCapability;
+export type SkillSlashCommandAction = ChatKitSlashCommandAction;
+export type SkillSlashCommandAvailability = ChatKitSlashCommandAvailability;
+export type SkillSlashCommandKind = ChatKitSlashCommandKind;
+export type SkillPromptWorkflow = ChatKitPromptWorkflow;
+export type SkillSlashCommand = Omit<ChatKitSlashCommand, 'icon'> & {
+    icon?: ChatKitSlashCommand['icon'] | IconDefinition;
+};
 export interface IShareSkillPackageInput {
     displayName: string;
     description: string;
@@ -50,6 +59,7 @@ export interface SkillMetadata {
         permissions?: string[];
         tools?: string[];
     };
+    commands?: SkillSlashCommand[];
     mcp?: {
         servers?: string[];
     };

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

@@ -1,18 +1,5 @@
-import type { TChatRequestHuman, TInterruptCommand } from '@xpert-ai/chatkit-types';
-import { STATE_VARIABLE_HUMAN } from '@xpert-ai/chatkit-types';
-export type TXpertFollowUpMode = 'queue' | 'steer';
-export type TXpertChatState = {
-    [STATE_VARIABLE_HUMAN]?: TChatRequestHuman;
-} & Record<string, any>;
-export type TXpertChatResumeDecision = {
-    type: 'confirm' | 'reject';
-    payload?: unknown;
-};
-export type TXpertChatInterruptPatch = Pick<TInterruptCommand, 'agentKey' | 'toolCalls' | 'update'>;
-export type TXpertChatTarget = {
-    aiMessageId?: string;
-    executionId?: string;
-};
+import type { FollowUpBehavior, TChatRequestHuman, TXpertChatInterruptPatch, TXpertChatResumeDecision, TXpertChatResumeRequest, TXpertChatState, TXpertChatTarget } from '@xpert-ai/chatkit-types';
+export type TXpertFollowUpMode = FollowUpBehavior;
 export type TXpertChatSource = {
     aiMessageId?: string;
     executionId?: string;
@@ -29,14 +16,6 @@ export type TXpertChatSendRequest = {
     };
     state?: TXpertChatState;
 };
-export type TXpertChatResumeRequest = {
-    action: 'resume';
-    conversationId: string;
-    target: TXpertChatTarget;
-    decision: TXpertChatResumeDecision;
-    patch?: TXpertChatInterruptPatch;
-    state?: TXpertChatState;
-};
 export type TXpertChatRetryRequest = {
     action: 'retry';
     conversationId: string;

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

@@ -14,6 +14,7 @@ import { IIntegration } from '../integration.model';
 import { TChatFrom } from './chat.model';
 import { IWorkflowNode, TVariableAssigner, TWFCase, VariableOperationEnum } from './xpert-workflow.model';
 import { IEnvironment } from './environment.model';
+import { TXpertCommandProfile } from './prompt-workflow.model';
 export type ToolCall = LToolCall;
 export declare enum XpertTypeEnum {
     /**
@@ -134,6 +135,7 @@ export type TXpert = {
      */
     memory?: TLongTermMemory;
     features?: TXpertFeatures;
+    commandProfile?: TXpertCommandProfile;
     /**
      * Version of role: '1' '2' '2.1' '2.2'...
      */
@@ -520,16 +522,21 @@ export type TChatOptions = {
  * Knowledgebase retrieval settings
  */
 export type TKBRetrievalSettings = {
-    metadata: {
+    mode?: 'vector' | 'graph' | 'hybrid';
+    neighborHops?: number;
+    entityTopK?: number;
+    communityTopK?: number;
+    graphWeight?: number;
+    metadata?: {
         filtering_mode: 'disabled' | 'automatic' | 'manual';
         /**
          * Conditions (filter) when mode is manual
          */
-        filtering_conditions: TWFCase;
+        filtering_conditions?: TWFCase;
         /**
          * Parameter fields (tool call) when mode is automatic
          */
-        fields: Record<string, object>;
+        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

@@ -1,6 +1,6 @@
 import { IPoint } from '../types';
 import { IXpertAgent } from './xpert-agent.model';
-import { IXpert, TXpertTeamConnection, TXpertTeamDraft, TXpertTeamNode } from './xpert.model';
+import { IXpert, TXpertGraph, TXpertTeamConnection, TXpertTeamDraft, TXpertTeamNode } from './xpert.model';
 export declare function omitXpertRelations(xpert: Partial<IXpert>): {
     environmentId?: string;
     workspaceId?: string;
@@ -32,11 +32,12 @@ export declare function omitXpertRelations(xpert: Partial<IXpert>): {
     summarize?: import("./xpert.model").TSummarize;
     memory?: import("./xpert.model").TLongTermMemory;
     features?: import("./xpert.model").TXpertFeatures;
+    commandProfile?: import("./prompt-workflow.model").TXpertCommandProfile;
     version?: string;
     latest?: boolean;
     releaseNotes?: string;
     exportedTemplate?: import("./xpert.model").TXpertExportedTemplate | null;
-    graph?: import("./xpert.model").TXpertGraph;
+    graph?: TXpertGraph;
     api?: import("./xpert.model").TChatApi;
     app?: import("./xpert.model").TChatApp;
     userId?: string;
@@ -53,6 +54,9 @@ export declare function omitXpertRelations(xpert: Partial<IXpert>): {
  * @returns
  */
 export declare function figureOutXpert(xpert: IXpert, isDraft: boolean): Partial<IXpert>;
+export declare function resolveRuntimeXpert(xpert: IXpert, isDraft: boolean): IXpert;
+export declare function resolveDraftRuntimeGraph(xpert: IXpert, draft: TXpertTeamDraft): TXpertGraph;
+export declare function resolveDraftPrimaryAgent(xpert: IXpert, draft: TXpertTeamDraft, graph: TXpertGraph): IXpertAgent | undefined;
 export declare function xpertLabel(agent: Partial<IXpert>): string;
 export declare function createXpertGraph(xpert: IXpert, position: IPoint): {
     nodes: TXpertTeamNode[];

package/src/api-key.model.d.ts

@@ -1,4 +1,5 @@
 import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+import { SecretTokenBindingType } from './secret-token.model';
 import { IUser } from './user.model';
 /**
  * Represents an API key used for authentication and authorization.
@@ -48,8 +49,16 @@ export declare enum ApiKeyBindingType {
 }
 export type ApiPrincipalType = 'api_key' | 'client_secret';
 export interface IApiPrincipal extends IUser {
-    apiKey: IApiKey;
     principalType: ApiPrincipalType;
+    apiKey?: IApiKey;
+    /**
+     * Binding target kind for short-lived client_secret principals.
+     * Examples:
+     * - api_key => secret_token.entityId is the backing ApiKey id
+     * - public_xpert => secret_token.entityId is the public xpert id
+     */
+    clientSecretBindingType?: SecretTokenBindingType | null;
+    clientSecretId?: string | null;
     /**
      * Resource owner / key creator. Used for audit and ownership metadata.
      */

package/src/secret-token.model.d.ts

@@ -1,11 +1,17 @@
-import { IBaseEntityModel } from './base-entity.model';
-export interface ISecretToken extends IBaseEntityModel {
+import { IBasePerTenantAndOrganizationEntityModel } from './base-entity.model';
+export declare enum SecretTokenBindingType {
+    API_KEY = "api_key",
+    PUBLIC_XPERT = "public_xpert"
+}
+export interface ISecretToken extends IBasePerTenantAndOrganizationEntityModel {
     entityId?: string;
+    type?: SecretTokenBindingType;
     token: string;
     validUntil?: Date;
     expired?: boolean;
 }
-export interface ISecretTokenFindInput extends IBaseEntityModel {
+export interface ISecretTokenFindInput extends IBasePerTenantAndOrganizationEntityModel {
     entityId?: string;
+    type?: SecretTokenBindingType;
     token?: string;
 }