dify/web/app/components/plugins/plugin-detail-panel/tool-selector/index.tsx

367 lines
14 KiB
TypeScript
Raw Normal View History

2024-11-13 16:43:43 +08:00
'use client'
import type { FC } from 'react'
import React, { useMemo, useState } from 'react'
import { useTranslation } from 'react-i18next'
2024-12-27 14:09:24 +08:00
import Link from 'next/link'
2024-12-26 17:02:29 +08:00
import {
2024-12-26 18:58:01 +08:00
RiArrowLeftLine,
2024-12-26 17:02:29 +08:00
RiArrowRightUpLine,
} from '@remixicon/react'
2024-11-13 16:43:43 +08:00
import {
PortalToFollowElem,
PortalToFollowElemContent,
PortalToFollowElemTrigger,
} from '@/app/components/base/portal-to-follow-elem'
2024-11-14 13:02:12 +08:00
import ToolTrigger from '@/app/components/plugins/plugin-detail-panel/tool-selector/tool-trigger'
2024-12-27 14:09:24 +08:00
import ToolItem from '@/app/components/plugins/plugin-detail-panel/tool-selector/tool-item'
2024-11-13 16:43:43 +08:00
import ToolPicker from '@/app/components/workflow/block-selector/tool-picker'
2024-11-13 23:28:55 +08:00
import Button from '@/app/components/base/button'
import Indicator from '@/app/components/header/indicator'
2024-11-14 13:02:12 +08:00
import ToolCredentialForm from '@/app/components/plugins/plugin-detail-panel/tool-selector/tool-credentials-form'
2024-11-14 00:01:47 +08:00
import Toast from '@/app/components/base/toast'
2024-12-26 15:29:00 +08:00
import Textarea from '@/app/components/base/textarea'
2024-12-26 17:02:29 +08:00
import Divider from '@/app/components/base/divider'
import Form from '@/app/components/header/account-setting/model-provider-page/model-modal/Form'
import { addDefaultValue, toolParametersToFormSchemas } from '@/app/components/tools/utils/to-form-schema'
2024-11-13 16:43:43 +08:00
2024-11-13 23:28:55 +08:00
import { useAppContext } from '@/context/app-context'
2024-11-14 00:01:47 +08:00
import {
useAllBuiltInTools,
useAllCustomTools,
useAllWorkflowTools,
2024-11-14 00:04:06 +08:00
useInvalidateAllBuiltInTools,
2024-11-14 00:01:47 +08:00
useUpdateProviderCredentials,
} from '@/service/use-tools'
2025-01-07 15:17:16 +08:00
import { useInvalidateInstalledPluginList } from '@/service/use-plugins'
2024-12-30 15:28:00 +08:00
import { usePluginInstalledCheck } from '@/app/components/plugins/plugin-detail-panel/tool-selector/hooks'
2024-11-13 23:28:55 +08:00
import { CollectionType } from '@/app/components/tools/types'
2024-11-13 16:43:43 +08:00
import type { ToolDefaultValue } from '@/app/components/workflow/block-selector/types'
import type {
OffsetOptions,
Placement,
} from '@floating-ui/react'
2024-12-30 15:28:00 +08:00
import { MARKETPLACE_API_PREFIX } from '@/config'
2024-11-13 23:28:55 +08:00
import cn from '@/utils/classnames'
2024-11-13 16:43:43 +08:00
2024-12-27 16:30:19 +08:00
export type ToolValue = {
provider_name: string
tool_name: string
parameters?: Record<string, any>
enabled?: boolean
extra?: Record<string, any>
}
2024-11-13 16:43:43 +08:00
type Props = {
2024-11-14 00:01:47 +08:00
disabled?: boolean
2024-11-13 16:43:43 +08:00
placement?: Placement
offset?: OffsetOptions
2024-12-27 17:29:21 +08:00
scope?: string
value?: ToolValue
2024-11-13 16:43:43 +08:00
onSelect: (tool: {
2024-12-26 18:58:01 +08:00
provider_name: string
2024-11-13 16:43:43 +08:00
tool_name: string
2024-12-26 15:29:00 +08:00
parameters?: Record<string, any>
2024-12-26 17:58:34 +08:00
extra?: Record<string, any>
2024-11-13 16:43:43 +08:00
}) => void
2024-12-27 14:09:24 +08:00
onDelete?: () => void
2024-12-27 17:29:21 +08:00
supportEnableSwitch?: boolean
2024-11-13 16:43:43 +08:00
supportAddCustomTool?: boolean
2024-12-27 17:29:21 +08:00
trigger?: React.ReactNode
controlledState?: boolean
onControlledStateChange?: (state: boolean) => void
2024-11-13 16:43:43 +08:00
}
const ToolSelector: FC<Props> = ({
value,
disabled,
2024-12-26 14:28:31 +08:00
placement = 'left',
2024-11-13 23:28:55 +08:00
offset = 4,
2024-11-13 16:43:43 +08:00
onSelect,
2024-12-27 14:09:24 +08:00
onDelete,
2024-12-26 14:28:31 +08:00
scope,
2024-12-27 17:29:21 +08:00
supportEnableSwitch,
trigger,
controlledState,
onControlledStateChange,
2024-11-13 16:43:43 +08:00
}) => {
const { t } = useTranslation()
const [isShow, onShowChange] = useState(false)
const handleTriggerClick = () => {
if (disabled) return
onShowChange(true)
}
2024-11-13 23:28:55 +08:00
2024-11-13 16:43:43 +08:00
const { data: buildInTools } = useAllBuiltInTools()
const { data: customTools } = useAllCustomTools()
const { data: workflowTools } = useAllWorkflowTools()
2024-11-14 00:04:06 +08:00
const invalidateAllBuiltinTools = useInvalidateAllBuiltInTools()
const invalidateInstalledPluginList = useInvalidateInstalledPluginList()
2024-12-26 17:02:29 +08:00
2024-12-30 15:28:00 +08:00
// plugin info check
const { inMarketPlace, manifest } = usePluginInstalledCheck(value?.provider_name)
2024-11-13 16:43:43 +08:00
const currentProvider = useMemo(() => {
const mergedTools = [...(buildInTools || []), ...(customTools || []), ...(workflowTools || [])]
return mergedTools.find((toolWithProvider) => {
2024-12-26 18:58:01 +08:00
return toolWithProvider.id === value?.provider_name && toolWithProvider.tools.some(tool => tool.name === value?.tool_name)
2024-11-13 16:43:43 +08:00
})
}, [value, buildInTools, customTools, workflowTools])
2024-12-26 17:02:29 +08:00
2024-11-13 16:43:43 +08:00
const [isShowChooseTool, setIsShowChooseTool] = useState(false)
const handleSelectTool = (tool: ToolDefaultValue) => {
2025-01-02 08:43:09 +08:00
const paramValues = addDefaultValue(tool.params, toolParametersToFormSchemas(tool.paramSchemas.filter(param => param.form !== 'llm') as any))
2024-11-13 16:43:43 +08:00
const toolValue = {
2024-12-26 18:58:01 +08:00
provider_name: tool.provider_id,
2024-11-13 16:43:43 +08:00
tool_name: tool.tool_name,
2024-12-26 17:02:29 +08:00
parameters: paramValues,
2024-12-27 17:29:21 +08:00
enabled: tool.is_team_authorization,
2024-12-26 18:58:01 +08:00
extra: {
description: '',
},
2024-11-13 16:43:43 +08:00
}
onSelect(toolValue)
2024-11-13 23:28:55 +08:00
setIsShowChooseTool(false)
2024-11-13 16:43:43 +08:00
}
2024-12-26 15:29:00 +08:00
const handleDescriptionChange = (e: React.ChangeEvent<HTMLTextAreaElement>) => {
onSelect({
...value,
2024-12-26 17:58:34 +08:00
extra: {
...value?.extra,
description: e.target.value || '',
},
2024-12-26 15:29:00 +08:00
} as any)
}
2024-12-26 17:02:29 +08:00
const currentToolParams = useMemo(() => {
if (!currentProvider) return []
2025-01-02 08:43:09 +08:00
return currentProvider.tools.find(tool => tool.name === value?.tool_name)?.parameters.filter(param => param.form !== 'llm') || []
2024-12-26 17:02:29 +08:00
}, [currentProvider, value])
const formSchemas = useMemo(() => toolParametersToFormSchemas(currentToolParams), [currentToolParams])
const handleFormChange = (v: Record<string, any>) => {
const toolValue = {
...value,
parameters: v,
}
onSelect(toolValue as any)
}
2024-12-27 17:29:21 +08:00
const handleEnabledChange = (state: boolean) => {
onSelect({
...value,
enabled: state,
} as any)
}
2024-12-26 15:29:00 +08:00
// authorization
2024-11-13 23:28:55 +08:00
const { isCurrentWorkspaceManager } = useAppContext()
2024-11-14 00:01:47 +08:00
const [isShowSettingAuth, setShowSettingAuth] = useState(false)
const handleCredentialSettingUpdate = () => {
2024-11-14 00:04:06 +08:00
invalidateAllBuiltinTools()
2024-11-14 00:01:47 +08:00
Toast.notify({
type: 'success',
message: t('common.api.actionSuccess'),
})
setShowSettingAuth(false)
onShowChange(false)
}
2024-11-13 23:28:55 +08:00
2024-11-14 00:01:47 +08:00
const { mutate: updatePermission } = useUpdateProviderCredentials({
onSuccess: handleCredentialSettingUpdate,
})
2024-11-13 16:43:43 +08:00
2024-12-30 15:28:00 +08:00
// install from marketplace
2025-01-07 15:17:16 +08:00
2024-12-30 15:28:00 +08:00
const manifestIcon = useMemo(() => {
if (!manifest)
return ''
return `${MARKETPLACE_API_PREFIX}/plugins/${(manifest as any).plugin_id}/icon`
}, [manifest])
const handleInstall = async () => {
2025-01-07 15:17:16 +08:00
invalidateAllBuiltinTools()
invalidateInstalledPluginList()
2024-12-30 15:28:00 +08:00
}
2024-11-13 16:43:43 +08:00
return (
<>
<PortalToFollowElem
placement={placement}
offset={offset}
2024-12-27 17:29:21 +08:00
open={trigger ? controlledState : isShow}
onOpenChange={trigger ? onControlledStateChange : onShowChange}
2024-11-13 16:43:43 +08:00
>
<PortalToFollowElemTrigger
className='w-full'
onClick={handleTriggerClick}
>
2024-12-27 17:29:21 +08:00
{trigger}
{!trigger && !value?.provider_name && (
2024-12-27 14:09:24 +08:00
<ToolTrigger
isConfigure
open={isShow}
value={value}
provider={currentProvider}
/>
)}
2024-12-27 17:29:21 +08:00
{!trigger && value?.provider_name && (
2024-12-27 14:09:24 +08:00
<ToolItem
open={isShow}
2024-12-30 15:28:00 +08:00
icon={currentProvider?.icon || manifestIcon}
2024-12-27 14:09:24 +08:00
providerName={value.provider_name}
toolName={value.tool_name}
2024-12-27 17:29:21 +08:00
showSwitch={supportEnableSwitch}
switchValue={value.enabled}
onSwitchChange={handleEnabledChange}
2024-12-27 14:09:24 +08:00
onDelete={onDelete}
noAuth={currentProvider && !currentProvider.is_team_authorization}
onAuth={() => setShowSettingAuth(true)}
2024-12-30 15:28:00 +08:00
uninstalled={!currentProvider && inMarketPlace}
2025-01-07 15:17:16 +08:00
installInfo={manifest?.latest_package_identifier}
2024-12-30 15:28:00 +08:00
onInstall={() => handleInstall()}
isError={!currentProvider && !inMarketPlace}
errorTip={<div className='space-y-1 max-w-[240px] text-xs'>
<h3 className='text-text-primary font-semibold'>{t('plugin.detailPanel.toolSelector.uninstalledTitle')}</h3>
<p className='text-text-secondary tracking-tight'>{t('plugin.detailPanel.toolSelector.uninstalledContent')}</p>
2024-12-27 14:09:24 +08:00
<p>
2024-12-30 15:28:00 +08:00
<Link href={'/plugins'} className='text-text-accent tracking-tight'>{t('plugin.detailPanel.toolSelector.uninstalledLink')}</Link>
2024-12-27 14:09:24 +08:00
</p>
</div>}
/>
)}
2024-11-13 16:43:43 +08:00
</PortalToFollowElemTrigger>
<PortalToFollowElemContent className='z-[1000]'>
2024-12-26 18:58:01 +08:00
<div className={cn('relative w-[361px] min-h-20 max-h-[642px] pb-4 rounded-xl backdrop-blur-sm bg-components-panel-bg-blur border-[0.5px] border-components-panel-border shadow-lg', !isShowSettingAuth && 'overflow-y-auto pb-2')}>
{!isShowSettingAuth && (
<>
<div className='px-4 pt-3.5 pb-1 text-text-primary system-xl-semibold'>{t('plugin.detailPanel.toolSelector.title')}</div>
{/* base form */}
<div className='px-4 py-2 flex flex-col gap-3'>
<div className='flex flex-col gap-1'>
<div className='h-6 flex items-center system-sm-semibold text-text-secondary'>{t('plugin.detailPanel.toolSelector.toolLabel')}</div>
<ToolPicker
placement='bottom'
offset={offset}
trigger={
<ToolTrigger
open={isShowChooseTool}
value={value}
provider={currentProvider}
/>
}
isShow={isShowChooseTool}
onShowChange={setIsShowChooseTool}
disabled={false}
supportAddCustomTool
onSelect={handleSelectTool}
scope={scope}
2024-12-26 15:29:00 +08:00
/>
2024-12-26 18:58:01 +08:00
</div>
<div className='flex flex-col gap-1'>
<div className='h-6 flex items-center system-sm-semibold text-text-secondary'>{t('plugin.detailPanel.toolSelector.descriptionLabel')}</div>
<Textarea
className='resize-none'
placeholder={t('plugin.detailPanel.toolSelector.descriptionPlaceholder')}
value={value?.extra?.description || ''}
onChange={handleDescriptionChange}
disabled={!value?.provider_name}
/>
</div>
2024-12-26 17:02:29 +08:00
</div>
2024-12-26 18:58:01 +08:00
{/* authorization */}
{currentProvider && currentProvider.type === CollectionType.builtIn && currentProvider.allow_delete && (
<div className='px-4 pt-3 flex flex-col'>
<div className='flex items-center gap-2'>
<div className='text-text-tertiary system-xs-medium-uppercase'>{t('plugin.detailPanel.toolSelector.auth')}</div>
<Divider bgStyle='gradient' className='grow' />
</div>
<div className='py-2'>
{!currentProvider.is_team_authorization && (
<Button
variant='primary'
className={cn('shrink-0 w-full')}
onClick={() => setShowSettingAuth(true)}
disabled={!isCurrentWorkspaceManager}
>
{t('tools.auth.unauthorized')}
</Button>
)}
{currentProvider.is_team_authorization && (
<Button
variant='secondary'
className={cn('shrink-0 w-full')}
onClick={() => setShowSettingAuth(true)}
disabled={!isCurrentWorkspaceManager}
>
<Indicator className='mr-2' color={'green'} />
{t('tools.auth.authorized')}
</Button>
)}
</div>
</div>
)}
{/* tool settings */}
{currentToolParams.length > 0 && currentProvider?.is_team_authorization && (
<div className='px-4 pt-3'>
<div className='flex items-center gap-2'>
<div className='text-text-tertiary system-xs-medium-uppercase'>{t('plugin.detailPanel.toolSelector.settings')}</div>
<Divider bgStyle='gradient' className='grow' />
</div>
<div className='py-2'>
<Form
value={value?.parameters || {}}
onChange={handleFormChange}
formSchemas={formSchemas as any}
isEditMode={true}
showOnVariableMap={{}}
validating={false}
inputClassName='bg-components-input-bg-normal hover:bg-components-input-bg-hover'
fieldMoreInfo={item => item.url
? (<a
href={item.url}
target='_blank' rel='noopener noreferrer'
className='inline-flex items-center text-xs text-text-accent'
>
{t('tools.howToGet')}
<RiArrowRightUpLine className='ml-1 w-3 h-3' />
</a>)
: null}
/>
</div>
</div>
)}
</>
2024-12-26 17:02:29 +08:00
)}
2024-11-13 23:28:55 +08:00
{/* authorization panel */}
2024-11-14 00:01:47 +08:00
{isShowSettingAuth && currentProvider && (
2024-12-26 18:58:01 +08:00
<>
<div className='relative pt-3.5 flex flex-col gap-1'>
<div className='absolute -top-2 left-2 w-[345px] pt-2 rounded-t-xl backdrop-blur-sm bg-components-panel-bg-blur border-[0.5px] border-components-panel-border'></div>
<div
className='px-3 h-6 flex items-center gap-1 text-text-accent-secondary system-xs-semibold-uppercase cursor-pointer'
onClick={() => setShowSettingAuth(false)}
>
<RiArrowLeftLine className='w-4 h-4' />
BACK
</div>
<div className='px-4 text-text-primary system-xl-semibold'>{t('tools.auth.setupModalTitle')}</div>
<div className='px-4 text-text-tertiary system-xs-regular'>{t('tools.auth.setupModalTitleDescription')}</div>
</div>
2024-11-14 00:01:47 +08:00
<ToolCredentialForm
collection={currentProvider}
onCancel={() => setShowSettingAuth(false)}
onSaved={async value => updatePermission({
providerName: currentProvider.name,
credentials: value,
})}
/>
2024-12-26 18:58:01 +08:00
</>
2024-11-13 23:28:55 +08:00
)}
2024-11-13 16:43:43 +08:00
</div>
</PortalToFollowElemContent>
</PortalToFollowElem>
</>
)
}
export default React.memo(ToolSelector)