@tais00/core 0.7.0

package/README.md

@@ -0,0 +1,172 @@
+# `@dify-chat/core`
+
+![version](https://img.shields.io/npm/v/@dify-chat/core) ![NPM Last Update](https://img.shields.io/npm/last-update/@dify-chat/core) ![NPM Downloads](https://img.shields.io/npm/dm/@dify-chat/core)
+
+`@dify-chat/core` 是 [Dify Chat](https://github.com/lexmin0412/dify-chat) 项目中的核心包，它提供了应用、对话等全局上下文的注入和获取功能。
+
+下面将介绍如何在你的应用中集成和使用它。
+
+## 安装
+
+通过 npm/yarn/pnpm 安装：
+
+```bash
+# npm
+npm install @dify-chat/core
+# yarn
+yarn add @dify-chat/core
+# pnpm
+pnpm add @dify-chat/core
+```
+
+## 使用方法
+
+### 全局上下文
+
+#### AppContext
+
+`AppContext` 是应用上下文，提供了当前应用配置的获取和更新功能。
+
+**AppContextProvider**
+
+在应用切换功能的最上层组件中使用 `AppContextProvider` 提供应用上下文：
+
+```tsx
+import { AppContextProvider, ICurrentApp } from '@dify-chat/core';
+import { createDifyApiInstance } from '@dify-chat/api';
+import { generateUuidV4 } from '@dify-chat/helpers'
+
+const YourChatComponent = () => {
+
+  const { user } = useDifyChat();
+  const [appList, setAppList] = useState<ICurrentApp[]>([])
+
+  // 实现获取应用列表的逻辑
+  const getAppList = async () => {
+    setAppList([...])
+  }
+
+  const [appLoading, setAppLoading] = useState(true)
+  const [ currentApp, setCurrentApp ] = useState<ICurrentApp[]>([]);
+  const [currentAppId, setCurrentAppId] = useState('')
+  const [difyApi] = useState(() => createDifyApiInstance({
+    user,
+    apiBase: '',
+    apiKey: '',
+  }))
+
+  // 定义获取应用参数的函数
+  const getAppInfo = async() => {
+    // 先更新 difyApi 的参数
+    difyApi.updateOptions({
+      user,
+      apiBase: newApp.requestConfig.apiBase,
+      apiKey: newApp.requestConfig.apiKey,
+    })
+    setAppLoading(true)
+    // 根据新的 currentAppId 获取新的应用信息
+    const appConfig = appList.find(item => item.id === currentAppId)
+    const difyAppInfo = await difyApi.getAppInfo()
+		const appParameters = await getAppParameters(difyApi)
+    setAppLoading(false)
+    setCurrentApp({
+			config: {
+				id: generateUuidV4(),
+				info: difyAppInfo,
+        requestConfig: appConfig.requestConfig,
+        answerForm: appConfig.answerForm,
+			},
+			parameters: appParameters,
+		})
+  }
+
+  // 初始化时获取应用列表
+  useEffect(()=>{
+    getAppList()
+  }, [])
+
+  // 监听 currentAppId 变化，更新当前应用配置
+  useEffect(() => {
+    updateAppInfo()
+  }, [currentAppId])
+
+  return (
+    <AppContextProvider
+			value={{
+				appLoading,
+				currentAppId,
+				setCurrentAppId,
+				currentApp: currentApp,
+				setCurrentApp,
+			}}
+		>
+      Your Chat Inner Component
+      <Button onClick={()=>setCurrentAppId('new-app-id')}>切换应用</Button>
+    </>
+  )
+}
+```
+
+**useAppContext hook**
+
+在你的子组件中使用 `useAppContext` 钩子获取应用上下文：
+
+```tsx
+import { useAppContext } from '@dify-chat/core'
+
+const YourInnerComponent = () => {
+	const { currentApp, currentAppId } = useAppContext()
+	console.log(`当前应用ID：${currentAppId}`, `当前应用：${currentApp}`)
+}
+```
+
+#### 对话上下文
+
+`ConversationContext` 是对话上下文，提供了对话相关的功能，包括获取/更新对话列表、获取/更新当前对话 ID、获取当前对话信息等。
+
+**ConversationContextProvider**
+
+在具备对话切换功能的最上层组件中使用 `ConversationContextProvider` 提供对话上下文：
+
+```tsx
+import { ConversationsContextProvider } from '@dify-chat/core';
+
+const YourChatComponent = () => {
+  const { user } = useDifyChat();
+  const [conversations, setConversations] = useState([])
+  const [currentConversationId, setCurrentConversationId] = useState('')
+
+  // 实现获取对话列表的逻辑
+  const listConversations = async () => {
+    setConversations([...])
+  }
+
+  useEffect(()=>{
+    listConversations()
+  }, [])
+
+  return (
+    <ConversationsContextProvider value={{
+      conversations,
+      setConversations,
+      currentConversationId,
+      setCurrentConversationId,
+    }}>
+      <YourInnerComponent />
+    </ConversationContextProvider>
+  )
+}
+```
+
+**`useConversationsContext` hook**
+
+在你的子组件中使用 `useConversationsContext` 钩子获取对话上下文：
+
+```tsx
+import { useConversationsContext } from '@dify-chat/core'
+
+const YourInnerComponent = () => {
+	const { conversations, currentConversationId } = useConversationsContext()
+	console.log(`当前对话ID：${currentConversationId}`, `对话列表：${conversations}`)
+}
+```

package/dist/constants/app.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 应用类型
+ */
+export declare enum AppModeEnums {
+    /**
+     * 文本生成
+     */
+    TEXT_GENERATOR = "completion",
+    /**
+     * 聊天助手
+     */
+    CHATBOT = "chat",
+    /**
+     * 工作流
+     */
+    WORKFLOW = "workflow",
+    /**
+     * 支持工作流编排的聊天助手
+     */
+    CHATFLOW = "advanced-chat",
+    /**
+     * 具备推理和自主调用能力的聊天助手
+     */
+    AGENT = "agent-chat"
+}
+/**
+ * 应用类型的展示标签
+ */
+export declare const AppModeLabels: {
+    completion: string;
+    chat: string;
+    workflow: string;
+    "advanced-chat": string;
+    "agent-chat": string;
+};
+/**
+ * 应用类型的展示名称
+ */
+export declare const AppModeNames: {
+    completion: string;
+    chat: string;
+    workflow: string;
+    "advanced-chat": string;
+    "agent-chat": string;
+};
+/**
+ * 应用类型选项
+ */
+export declare const AppModeOptions: {
+    label: string;
+    value: AppModeEnums;
+}[];
+/**
+ * 开场白展示模式
+ */
+export declare const OpeningStatementDisplayMode: {
+    Default: string;
+    Always: string;
+};
+/**
+ * 开场白展示模式选项
+ */
+export declare const OpeningStatementDisplayModeOptions: {
+    label: string;
+    value: string;
+}[];

package/dist/constants/index.d.ts

@@ -0,0 +1,35 @@
+export * from './app';
+/**
+ * 消息角色
+ */
+export type IMessageRole = 'local' | 'user' | 'ai';
+/**
+ * 聊天中的角色
+ */
+export declare const Roles: {
+    /**
+     * 用户
+     */
+    readonly USER: "user";
+    /**
+     * AI
+     */
+    readonly AI: "ai";
+    /**
+     * 本地，用户已发送但还未收到响应
+     */
+    readonly LOCAL: "local";
+};
+/**
+ * 运行模式
+ */
+export declare const RunningModes: {
+    /**
+     * 单应用
+     */
+    readonly SingleApp: "singleApp";
+    /**
+     * 多应用
+     */
+    readonly MultiApp: "multiApp";
+};

package/dist/enums/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 应用状态
+ */
+export declare enum EIsEnabled {
+    /**
+     * 启用
+     */
+    enabled = 1,
+    /**
+     * 禁用
+     */
+    disabled = 2
+}

package/dist/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './use-apps';
+export * from './use-conversations';
+export * from './use-dify-chat';

package/dist/hooks/use-apps.d.ts

@@ -0,0 +1,31 @@
+import React from 'react';
+import { IDifyAppItem } from '../repository';
+import { IDifyAppParameters, IDifyAppSiteSetting } from '../types';
+export interface ICurrentApp {
+    config: IDifyAppItem;
+    /**
+     * 应用参数
+     */
+    parameters: IDifyAppParameters;
+    /**
+     * 应用 WebApp 设置, 需要 Dify >= 1.4.0
+     */
+    site?: IDifyAppSiteSetting;
+}
+export interface IAppContext {
+    appLoading?: boolean;
+    currentAppId?: string;
+    setCurrentAppId: (appId: string) => void;
+    currentApp?: ICurrentApp;
+    setCurrentApp: (app: ICurrentApp | undefined) => void;
+}
+/**
+ * 应用的默认 WebApp 设置
+ */
+export declare const DEFAULT_APP_SITE_SETTING: IDifyAppSiteSetting;
+export declare const AppContext: React.Context<IAppContext>;
+export declare const AppContextProvider: React.Provider<IAppContext>;
+/**
+ * 获取应用上下文
+ */
+export declare const useAppContext: () => IAppContext;

package/dist/hooks/use-conversations.d.ts

@@ -0,0 +1,40 @@
+import React from 'react';
+interface IConversationItem {
+    created_at: number;
+    id: string;
+    inputs: Record<string, unknown>;
+    introduction: string;
+    name: string;
+    status: 'normal';
+    updated_at: number;
+}
+/**
+ * 对话上下文类型
+ */
+export interface IConversationContext {
+    conversations: IConversationItem[];
+    setConversations: React.Dispatch<React.SetStateAction<IConversationItem[]>>;
+    currentConversationId: string;
+    setCurrentConversationId: React.Dispatch<React.SetStateAction<string>>;
+    currentConversationInfo?: IConversationItem;
+}
+/**
+ * 对话上下文
+ */
+export declare const ConversationContext: React.Context<IConversationContext>;
+/**
+ * 对话上下文 Provoder
+ */
+export declare const ConversationsContextProvider: React.Provider<IConversationContext>;
+/**
+ * 获取对话上下文
+ */
+export declare function useConversationsContext(): IConversationContext;
+export declare const useConversations: () => {
+    conversations: IConversationItem[];
+    setConversations: React.Dispatch<React.SetStateAction<IConversationItem[]>>;
+    currentConversationId: string | undefined;
+    setCurrentConversationId: React.Dispatch<React.SetStateAction<string | undefined>>;
+    currentConversationInfo: IConversationItem | undefined;
+};
+export {};

package/dist/hooks/use-dify-chat.d.ts

@@ -0,0 +1,63 @@
+import React from 'react';
+import { AppModeEnums } from '../constants';
+import { DifyAppStore, DifyAppStoreReadonly, IDifyAppItem } from '../repository';
+export type IDifyChatMode = 'singleApp' | 'multiApp';
+interface IDifyChatContextBase {
+    /**
+     * 当前用户
+     */
+    user: string;
+}
+/**
+ * 单应用模式下的上下文
+ */
+export interface IDifyChatContextSingleApp extends IDifyChatContextBase {
+    /**
+     * 交互模式 - 单应用
+     */
+    mode: 'singleApp';
+    /**
+     * 当前应用配置
+     */
+    appConfig: Omit<IDifyAppItem, 'id' | 'info'> & {
+        /**
+         * 应用信息 可选，主要是为了兼容旧版本 dify(<=1.3.1) 的 /info 接口没有返回 mode 的情况
+         */
+        info?: {
+            /**
+             * 应用类型
+             */
+            mode?: AppModeEnums;
+        };
+    };
+}
+/**
+ * 多应用模式下的上下文
+ */
+export interface IDifyChatContextMultiApp extends IDifyChatContextBase {
+    /**
+     * 交互模式 - 多应用
+     */
+    mode: 'multiApp';
+    /**
+     * 应用服务，用于实现应用列表的 CRUD 管理
+     */
+    appService: DifyAppStore | DifyAppStoreReadonly;
+}
+/**
+ * DifyChat 上下文类型
+ */
+type IDifyChatContext = IDifyChatContextSingleApp | IDifyChatContextMultiApp;
+/**
+ * DifyChat 全局上下文
+ */
+export declare const DifyChatContext: React.Context<IDifyChatContext>;
+/**
+ * DifyChatContext 的 Provider
+ */
+export declare const DifyChatProvider: React.Provider<IDifyChatContext>;
+/**
+ * 使用 DifyChat 的 context 值
+ */
+export declare const useDifyChat: () => IDifyChatContext;
+export {};