@nocobase/plugin-ai 2.3.0-alpha.1 → 3.0.0-alpha.1

package/dist/client-v2/ai-employees/chatbox/stores/workflow-tasks.d.ts

@@ -6,6 +6,7 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
+import type { AIEmployee } from '../../types';
 export type WorkflowTask = {
     id: string;
     sessionId: string;
@@ -28,6 +29,7 @@ export type WorkflowTaskOutputSchema = {
     properties?: Record<string, WorkflowTaskOutputSchema>;
 };
 export type WorkflowTaskDetail = WorkflowTask & {
+    aiEmployee?: AIEmployee | null;
     readonly?: boolean;
     structuredOutputSchema?: WorkflowTaskOutputSchema | string | null;
     config?: {
@@ -39,22 +41,32 @@ export type WorkflowTaskDetail = WorkflowTask & {
         [key: string]: unknown;
     } | null;
 };
-type WorkflowTasksState = {
+type WorkflowTaskStateUpdater<T> = T | ((prev: T) => T);
+export declare const JOB_STATUS: {
+    readonly PENDING: 0;
+    readonly RESOLVED: 1;
+    readonly FAILED: -1;
+    readonly ERROR: -2;
+    readonly ABORTED: -3;
+    readonly CANCELED: -4;
+    readonly REJECTED: -5;
+    readonly RETRY_NEEDED: -6;
+};
+export declare const normalizeWorkflowTask: (workflowTask: WorkflowTask) => WorkflowTask;
+export declare class WorkflowTaskModel {
     workflowTasks: WorkflowTask[];
-    currentWorkflowTask?: WorkflowTaskDetail;
+    currentWorkflowTask: WorkflowTaskDetail | undefined;
     unreadCount: number;
     loading: boolean;
     keyword: string;
-    selectedJobStatus?: number;
-};
-type WorkflowTasksActions = {
-    setWorkflowTasks: (workflowTasks: WorkflowTask[] | ((prev: WorkflowTask[]) => WorkflowTask[])) => void;
-    setCurrentWorkflowTask: (workflowTask: WorkflowTaskDetail | undefined | ((prev?: WorkflowTaskDetail) => WorkflowTaskDetail | undefined)) => void;
-    setUnreadCount: (unreadCount: number | ((prev: number) => number)) => void;
+    selectedJobStatus: number | undefined;
+    constructor();
+    setWorkflowTasks: (workflowTasks: WorkflowTaskStateUpdater<WorkflowTask[]>) => void;
+    setCurrentWorkflowTask: (currentWorkflowTask: WorkflowTaskDetail | ((prev?: WorkflowTaskDetail) => WorkflowTaskDetail | undefined)) => void;
+    setUnreadCount: (unreadCount: WorkflowTaskStateUpdater<number>) => void;
     markWorkflowTaskRead: (sessionId: string) => void;
     setLoading: (loading: boolean) => void;
     setKeyword: (keyword: string) => void;
     setSelectedJobStatus: (selectedJobStatus: number | undefined) => void;
-};
-export declare const useWorkflowTasksStore: import("./create-selectors").ObservableStore<WorkflowTasksState & WorkflowTasksActions>;
+}
 export {};

package/dist/client-v2/ai-employees/chatbox/upload.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { APIClient } from '@nocobase/client-v2';
+import type { Attachment, UploadAIFileOptions } from '../types';
+type AIFileUploadRequestOptions = UploadAIFileOptions & {
+    action?: string;
+    data?: Record<string, string | Blob>;
+    fieldName?: string;
+    headers?: Record<string, string>;
+    withCredentials?: boolean;
+};
+export declare function uploadAIFile(apiClient: Pick<APIClient, 'request'>, file: Blob, options?: AIFileUploadRequestOptions): Promise<Attachment>;
+export {};

package/dist/client-v2/ai-employees/chatbox/utils.d.ts

@@ -6,12 +6,36 @@
  * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
-import { ContextItem, SkillSettings, TaskMessage, Message } from '../types';
-export declare function normalizeAIFileUploadAttachment<T extends Record<string, unknown>>(fileData: T, status: string): T & {
+import type { APIClient } from '@nocobase/client-v2';
+import type { AIConfigRepository } from '../../repositories/AIConfigRepository';
+import { ContextItem, SkillSettings, TaskMessage, Message, type AIEmployee, type Task, type TriggerTaskOptions } from '../types';
+export type RunJSAIEmployeeTriggerTaskOptions = Omit<TriggerTaskOptions, 'aiEmployee'> & {
+    aiEmployee?: string | AIEmployee;
+};
+export type NormalizeTriggerTaskOptionsContext = {
+    aiConfigRepository?: Pick<AIConfigRepository, 'getAIEmployees'> | null;
+    apiClient?: Pick<APIClient, 'resource'> | null;
+};
+export declare const getTargetChatBoxUid: (tasks?: Task[]) => string;
+export declare function normalizeTriggerTaskOptions(options: RunJSAIEmployeeTriggerTaskOptions, context?: NormalizeTriggerTaskOptionsContext): Promise<TriggerTaskOptions | null>;
+export declare function normalizeAIFileUploadAttachment<T extends Record<string, unknown>>(fileData: T, status?: string): T & {
+    filename?: string;
     source?: Record<string, unknown>;
-    status: string;
+    status?: string;
+};
+export declare function normalizeAIFileUploadAttachment<T>(fileData: T, status?: string): T;
+export declare const AI_EMPLOYEE_ATTACHMENT_COUNT_LIMIT = 10;
+export declare const AI_EMPLOYEE_ATTACHMENT_SIZE_LIMIT_DEFAULT: number;
+export type AttachmentLimitViolation = {
+    type: 'count';
+    limit: number;
+} | {
+    type: 'size';
+    limit: number;
 };
-export declare function normalizeAIFileUploadAttachment<T>(fileData: T, status: string): T;
+export declare function resolveStorageSizeLimit(rules: unknown): number;
+export declare function validateAIEmployeeAttachmentLimits(attachments: unknown[], sizeLimit: number): AttachmentLimitViolation | null;
+export declare function formatAttachmentSizeLimit(size: number): string;
 export declare function isCurrentLiveMessage(latestMessageId: string | undefined, messageId?: string, toolCallMessageId?: unknown): boolean;
 export declare const parseTask: (task: {
     message?: TaskMessage;

package/dist/client-v2/ai-employees/frontend-tools.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { ToolsOptions } from '@nocobase/client-v2';
+export declare const loadFrontendTool: [string, ToolsOptions];
+export declare const executeFrontendTool: [string, ToolsOptions];

package/dist/client-v2/ai-employees/tools/SuggestionsOptionsCard.d.ts

@@ -12,5 +12,5 @@ type SuggestionsArgs = {
     options?: string[] | string;
     [key: string]: unknown;
 };
-export declare const SuggestionsOptionsCard: React.FC<ToolsUIProperties<SuggestionsArgs>>;
+export declare const SuggestionsOptionsCard: React.MemoExoticComponent<import("@formily/reactive-react").ReactFC<ToolsUIProperties<SuggestionsArgs>>>;
 export {};

package/dist/client-v2/ai-employees/tools/WorkflowTaskOutputCard.d.ts

@@ -12,5 +12,5 @@ type WorkflowTaskOutputArgs = {
     result?: Record<string, unknown>;
     [key: string]: unknown;
 };
-export declare const WorkflowTaskOutputCard: React.FC<ToolsUIProperties<WorkflowTaskOutputArgs>>;
+export declare const WorkflowTaskOutputCard: React.MemoExoticComponent<import("@formily/reactive-react").ReactFC<ToolsUIProperties<WorkflowTaskOutputArgs>>>;
 export {};

package/dist/client-v2/ai-employees/types.d.ts

@@ -10,6 +10,7 @@ import type { BubbleProps } from '@ant-design/x';
 import type { ComponentType } from 'react';
 import type { Application } from '@nocobase/client-v2';
 import type { FlowEngineContext } from '@nocobase/flow-engine';
+import type { FrontendToolManifest } from '../../common/frontend-tools';
 export type Selector = {
     onSelect: (options: {
         uid: string;
@@ -78,6 +79,7 @@ export type ContextItem = {
     uid: string;
     title?: string;
     content?: unknown;
+    frontendTools?: FrontendToolManifest[];
 };
 type ActionParams = {
     item: ContextItem;
@@ -119,6 +121,7 @@ export type WorkContextOptions = {
     actions?: ActionOptions[];
     children?: Record<string, Omit<WorkContextOptions, 'children'>>;
     getContent?: (app: Application, item: ContextItem) => Promise<unknown>;
+    getFrontendTools?: (app: Application, item: ContextItem) => Promise<FrontendToolManifest[]>;
 };
 export type ToolCall<T = unknown> = {
     id: string;
@@ -136,13 +139,36 @@ export type ToolCall<T = unknown> = {
     [key: string]: unknown;
 };
 export type Attachment = {
+    id?: string | number;
+    uid?: string;
+    name?: string;
     filename?: string;
+    url?: string;
+    preview?: string;
+    thumbUrl?: string;
+    size?: number;
+    mimetype?: string;
+    type?: string;
+    percent?: number;
     status?: string;
+    source?: {
+        dataSourceKey?: string;
+        collectionName?: string;
+        field?: string;
+    };
+    meta?: {
+        source?: Attachment['source'];
+        [key: string]: unknown;
+    };
     response?: {
         data?: Attachment;
     };
     [key: string]: unknown;
 };
+export type UploadAIFileOptions = {
+    onProgress?: (percent: number) => void;
+    signal?: AbortSignal;
+};
 export type MessageType = 'text' | 'greeting';
 export type Message = Omit<BubbleProps, 'content'> & {
     key?: string | number;
@@ -192,6 +218,7 @@ export type TaskMessage = {
 };
 export type Task = {
     title?: string;
+    chatBoxUid?: string;
     message?: TaskMessage;
     autoSend?: boolean;
     skillSettings?: SkillSettings;
@@ -204,8 +231,10 @@ export type Task = {
 export type TriggerTaskOptions = {
     aiEmployee?: AIEmployee;
     tasks?: Task[];
+    chatBoxUid?: string;
     auto?: boolean;
     open?: boolean;
+    onResponseLoadingChange?: (loading: boolean) => void;
 };
 export type SendOptions = {
     sessionId?: string;
@@ -224,6 +253,7 @@ export type SendOptions = {
         llmService: string;
         model: string;
     } | null;
+    onResponseLoadingChange?: (loading: boolean) => void;
 };
 export type ResendOptions = {
     sessionId: string;

package/dist/client-v2/block/ai-chat-box/AIChatBoxBlockModel.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+import { BlockModel } from '@nocobase/client-v2';
+import { type ChatBoxRuntime } from '../../ai-employees/chatbox/stores/runtime';
+import type { AIChatBoxBlockProps, AIChatBoxBlockStructure } from './types';
+export declare class AIChatBoxBlockModel extends BlockModel<AIChatBoxBlockStructure> {
+    props: AIChatBoxBlockProps;
+    chatBoxRuntime?: ChatBoxRuntime;
+    afterAddAsSubModel(): Promise<void>;
+    renderComponent(): React.JSX.Element;
+    renderActions(): React.JSX.Element;
+    renderConfigureActions(): React.JSX.Element;
+    renderConfigureItems(): React.JSX.Element;
+}

package/dist/client-v2/block/ai-chat-box/AIChatBoxCoreModel.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+import { FlowModel } from '@nocobase/flow-engine';
+export declare class AIChatBoxCoreModel extends FlowModel {
+    render(): React.JSX.Element;
+}

package/dist/client-v2/block/ai-chat-box/components/AIChatBoxCoreView.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+export declare const AIChatBoxCoreView: React.FC;

package/dist/client-v2/block/ai-chat-box/components/AIChatBoxView.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+export declare const AI_CHAT_BOX_CORE_MIN_WIDTH = 400;
+export declare const AI_CHAT_BOX_CORE_MIN_HEIGHT = 420;
+export declare const AIChatBoxView: React.FC;

package/dist/client-v2/block/ai-chat-box/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export { AIChatBoxBlockModel } from './AIChatBoxBlockModel';
+export { AIChatBoxCoreModel } from './AIChatBoxCoreModel';
+export { AIChatBoxActionGroupModel, AIChatBoxItemGroupModel } from './sub-models';
+export { AI_CHAT_BOX_BLOCK_SETTINGS_FLOW_KEY } from './settings';
+export { getAIChatBoxConversationScope, getAIChatBoxCreateScope, getAIChatBoxSettings, getAIChatBoxWorkContext, getDefaultAIChatBoxSettings, normalizeAIChatBoxScopeForSave, normalizeAIChatBoxWorkContext, } from './utils';
+export type { AIChatBoxBlockProps, AIChatBoxBlockStructure, AIChatBoxSettings } from './types';

package/dist/client-v2/block/ai-chat-box/settings.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export declare const AI_CHAT_BOX_BLOCK_SETTINGS_FLOW_KEY = "aiChatBoxBlockSettings";
+type AIChatBoxBlockModelConstructor = typeof import('./AIChatBoxBlockModel').AIChatBoxBlockModel;
+export declare const registerAIChatBoxBlockSettings: (ModelClass: AIChatBoxBlockModelConstructor) => void;
+export {};

package/dist/client-v2/block/ai-chat-box/sub-models.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import React from 'react';
+import { ActionGroupModel, ActionModel } from '@nocobase/client-v2';
+import { FlowModel, type FlowModelContext, type SubModelItem } from '@nocobase/flow-engine';
+import type { AIChatBoxBlockModel } from './AIChatBoxBlockModel';
+export declare const AI_CHAT_BOX_ACTION_MODEL_NAMES: readonly ["JSActionModel", "AIEmployeeActionModel"];
+export declare const AI_CHAT_BOX_ITEM_MODEL_NAMES: readonly ["JSBlockModel", "IframeBlockModel", "MarkdownBlockModel"];
+export declare const isAIChatBoxCoreModel: (model: FlowModel) => boolean;
+export declare class AIChatBoxItemGroupModel extends FlowModel {
+    static defineChildren(ctx: FlowModelContext): Promise<SubModelItem[]>;
+}
+export declare class AIChatBoxActionGroupModel extends ActionGroupModel {
+    static baseClass: typeof ActionModel;
+    static defineChildren(ctx: FlowModelContext): Promise<SubModelItem[]>;
+}
+export declare const moveAddedItemBeforeCore: (model: AIChatBoxBlockModel, addedModel: FlowModel) => Promise<void>;
+export declare const renderAIChatBoxActions: (model: AIChatBoxBlockModel) => React.JSX.Element;
+export declare const renderAIChatBoxConfigureActions: (model: AIChatBoxBlockModel) => React.JSX.Element;
+export declare const renderAIChatBoxConfigureItems: (model: AIChatBoxBlockModel) => React.JSX.Element;

package/dist/client-v2/block/ai-chat-box/types.d.ts

@@ -0,0 +1,38 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { ActionModel } from '@nocobase/client-v2';
+import type { FlowModel } from '@nocobase/flow-engine';
+import type { ContextItem } from '../../ai-employees/types';
+export type AIChatBoxBlockStructure = {
+    subModels: {
+        items: FlowModel[];
+        actions: ActionModel[];
+    };
+};
+export type AIChatBoxBlockProps = {
+    minWidth?: number;
+    height?: number;
+    showMessages?: boolean;
+    scope?: string;
+    systemPrompt?: string;
+    defaultUserMessage?: string;
+    workContext?: ContextItem[];
+    allowedAIEmployees?: string[];
+    allowedModels?: string[];
+    senderPlaceholder?: string;
+    showContextSelector?: boolean;
+    showUpload?: boolean;
+    showWebSearch?: boolean;
+    showEmployeeSelect?: boolean;
+    showModelSelect?: boolean;
+    showDisclaimer?: boolean;
+};
+export type AIChatBoxSettings = Required<Pick<AIChatBoxBlockProps, 'showMessages' | 'minWidth' | 'height' | 'systemPrompt' | 'defaultUserMessage' | 'workContext' | 'allowedAIEmployees' | 'allowedModels' | 'senderPlaceholder' | 'showContextSelector' | 'showUpload' | 'showWebSearch' | 'showEmployeeSelect' | 'showModelSelect' | 'showDisclaimer'>> & {
+    scope?: string;
+};

package/dist/client-v2/block/ai-chat-box/utils.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import type { ContextItem } from '../../ai-employees/types';
+import type { AIChatBoxBlockModel } from './AIChatBoxBlockModel';
+import type { AIChatBoxBlockProps, AIChatBoxSettings } from './types';
+type AIChatBoxScopeRenderContext = {
+    resolveJsonTemplate?: (template: string) => unknown | Promise<unknown>;
+};
+export declare const DEFAULT_AI_CHAT_BOX_WIDTH = 400;
+export declare const DEFAULT_AI_CHAT_BOX_HEIGHT = 650;
+export declare const getDefaultAIChatBoxSettings: () => AIChatBoxSettings;
+export declare const getAIChatBoxSettings: (props?: AIChatBoxBlockProps) => AIChatBoxSettings;
+export declare const normalizeAIChatBoxHeight: (height: unknown) => number;
+export declare const getAIChatBoxConversationScope: (model: AIChatBoxBlockModel) => string;
+export declare const getAIChatBoxCreateScope: (model: AIChatBoxBlockModel) => string;
+export declare const renderAIChatBoxScope: (scope: string | undefined, ctx?: AIChatBoxScopeRenderContext) => Promise<string>;
+export declare const normalizeAIChatBoxScopeForSave: (scope: string | undefined) => string;
+export declare const normalizeAIChatBoxWorkContext: (workContext: ContextItem[] | undefined) => ContextItem[];
+export declare const getAIChatBoxWorkContext: (model: AIChatBoxBlockModel) => ContextItem[];
+export {};

package/dist/client-v2/index.d.ts

@@ -13,18 +13,16 @@ export { AddContextButton } from './ai-employees/AddContextButton';
 export { AISelection } from './ai-employees/AISelection';
 export { AISelectionControl } from './ai-employees/AISelectionControl';
 export { avatars, avatarsMap } from './ai-employees/avatars';
-export type { AIEmployee, Attachment, ChatEditorRef, ContextItem, Conversation, Message, SkillSettings, Task, TriggerTaskOptions, WebSearching, } from './ai-employees/types';
+export type { AIEmployee, Attachment, ChatEditorRef, ContextItem, Conversation, Message, SkillSettings, Task, TriggerTaskOptions, UploadAIFileOptions, WebSearching, } from './ai-employees/types';
 export { formatModelLabel } from './llm-services/model-label';
 export { createModelSettingsForm, ModelSelect, OptionsFields, type OptionField } from './llm-providers/forms';
 export { AIConfigRepository, type LLMServiceItem } from './repositories/AIConfigRepository';
 export { AIPluginFeatureManagerImpl } from './manager/ai-feature-manager';
 export { AIManager } from './manager/ai-manager';
-export type { LLMProviderOptions, ToolModalProps, ToolOptions } from './manager/ai-manager';
+export type { LLMProviderOptions, ToolModalProps, ToolOptions, TriggerModelTaskOptions } from './manager/ai-manager';
 export * from './features';
 export { defaultVectorStorePropForm } from './features/components';
 export { useAIConfigRepository } from './repositories/hooks/useAIConfigRepository';
-export { useChatMessagesStore } from './ai-employees/chatbox/stores/chat-messages';
-export { useChatBoxStore } from './ai-employees/chatbox/stores/chat-box';
-export { useChatConversationsStore } from './ai-employees/chatbox/stores/chat-conversations';
 export { useChatBoxActions } from './ai-employees/chatbox/hooks/useChatBoxActions';
+export { ChatBoxRuntimeProvider, getGlobalChatBoxRuntime, type ChatBoxRuntime, } from './ai-employees/chatbox/stores/runtime';
 export { ChatBox, ChatBoxLayout, ChatButton, AIEmployeeSwitcher, ModelSwitcher, } from './ai-employees/chatbox/components';