mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 20:42:30 +08:00
d81e4095de
### What problem does this PR solve? Google drive supports web-based credentials. <img width="1204" height="612" alt="image" src="https://github.com/user-attachments/assets/70291c63-a2dd-4a80-ae20-807fe034cdbc" /> ### Type of change - [x] New Feature (non-breaking change which adds functionality)
437 lines
12 KiB
TypeScript
437 lines
12 KiB
TypeScript
import { FormFieldType } from '@/components/dynamic-form';
|
|
import SvgIcon from '@/components/svg-icon';
|
|
import { t } from 'i18next';
|
|
import GoogleDriveTokenField from './component/google-drive-token-field';
|
|
|
|
export enum DataSourceKey {
|
|
CONFLUENCE = 'confluence',
|
|
S3 = 's3',
|
|
NOTION = 'notion',
|
|
DISCORD = 'discord',
|
|
GOOGLE_DRIVE = 'google_drive',
|
|
// GMAIL = 'gmail',
|
|
// JIRA = 'jira',
|
|
// SHAREPOINT = 'sharepoint',
|
|
// SLACK = 'slack',
|
|
// TEAMS = 'teams',
|
|
}
|
|
|
|
export const DataSourceInfo = {
|
|
[DataSourceKey.S3]: {
|
|
name: 'S3',
|
|
description: t(`setting.${DataSourceKey.S3}Description`),
|
|
icon: <SvgIcon name={'data-source/s3'} width={38} />,
|
|
},
|
|
[DataSourceKey.NOTION]: {
|
|
name: 'Notion',
|
|
description: t(`setting.${DataSourceKey.NOTION}Description`),
|
|
icon: <SvgIcon name={'data-source/notion'} width={38} />,
|
|
},
|
|
[DataSourceKey.DISCORD]: {
|
|
name: 'Discord',
|
|
description: t(`setting.${DataSourceKey.DISCORD}Description`),
|
|
icon: <SvgIcon name={'data-source/discord'} width={38} />,
|
|
},
|
|
[DataSourceKey.CONFLUENCE]: {
|
|
name: 'Confluence',
|
|
description: t(`setting.${DataSourceKey.CONFLUENCE}Description`),
|
|
icon: <SvgIcon name={'data-source/confluence'} width={38} />,
|
|
},
|
|
[DataSourceKey.GOOGLE_DRIVE]: {
|
|
name: 'Google Drive',
|
|
description: t(`setting.${DataSourceKey.GOOGLE_DRIVE}Description`),
|
|
icon: <SvgIcon name={'data-source/google-drive'} width={38} />,
|
|
},
|
|
};
|
|
|
|
export const DataSourceFormBaseFields = [
|
|
{
|
|
id: 'Id',
|
|
name: 'id',
|
|
type: FormFieldType.Text,
|
|
required: false,
|
|
hidden: true,
|
|
},
|
|
{
|
|
label: 'Name',
|
|
name: 'name',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Source',
|
|
name: 'source',
|
|
type: FormFieldType.Select,
|
|
required: true,
|
|
hidden: true,
|
|
options: Object.keys(DataSourceKey).map((item) => ({
|
|
label: item,
|
|
value: DataSourceKey[item as keyof typeof DataSourceKey],
|
|
})),
|
|
},
|
|
];
|
|
|
|
export const DataSourceFormFields = {
|
|
[DataSourceKey.S3]: [
|
|
{
|
|
label: 'AWS Access Key ID',
|
|
name: 'config.credentials.aws_access_key_id',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'AWS Secret Access Key',
|
|
name: 'config.credentials.aws_secret_access_key',
|
|
type: FormFieldType.Password,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Bucket Name',
|
|
name: 'config.bucket_name',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Bucket Type',
|
|
name: 'config.bucket_type',
|
|
type: FormFieldType.Select,
|
|
options: [
|
|
{ label: 'S3', value: 's3' },
|
|
{ label: 'R2', value: 'r2' },
|
|
{ label: 'Google Cloud Storage', value: 'google_cloud_storage' },
|
|
{ label: 'OCI Storage', value: 'oci_storage' },
|
|
],
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Prefix',
|
|
name: 'config.prefix',
|
|
type: FormFieldType.Text,
|
|
required: false,
|
|
tooltip: t('setting.s3PrefixTip'),
|
|
},
|
|
],
|
|
[DataSourceKey.NOTION]: [
|
|
{
|
|
label: 'Notion Integration Token',
|
|
name: 'config.credentials.notion_integration_token',
|
|
type: FormFieldType.Password,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Root Page Id',
|
|
name: 'config.root_page_id',
|
|
type: FormFieldType.Text,
|
|
required: false,
|
|
},
|
|
],
|
|
[DataSourceKey.DISCORD]: [
|
|
{
|
|
label: 'Discord Bot Token',
|
|
name: 'config.credentials.discord_bot_token',
|
|
type: FormFieldType.Password,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Server IDs',
|
|
name: 'config.server_ids',
|
|
type: FormFieldType.Tag,
|
|
required: false,
|
|
},
|
|
{
|
|
label: 'Channels',
|
|
name: 'config.channels',
|
|
type: FormFieldType.Tag,
|
|
required: false,
|
|
},
|
|
],
|
|
|
|
[DataSourceKey.CONFLUENCE]: [
|
|
{
|
|
label: 'Confluence Username',
|
|
name: 'config.credentials.confluence_username',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
tooltip: 'A descriptive name for the connector.',
|
|
},
|
|
{
|
|
label: 'Confluence Access Token',
|
|
name: 'config.credentials.confluence_access_token',
|
|
type: FormFieldType.Password,
|
|
required: true,
|
|
},
|
|
{
|
|
label: 'Wiki Base URL',
|
|
name: 'config.wiki_base',
|
|
type: FormFieldType.Text,
|
|
required: false,
|
|
tooltip: t('setting.confluenceWikiBaseUrlTip'),
|
|
},
|
|
{
|
|
label: 'Is Cloud',
|
|
name: 'config.is_cloud',
|
|
type: FormFieldType.Checkbox,
|
|
required: false,
|
|
tooltip: t('setting.confluenceIsCloudTip'),
|
|
},
|
|
],
|
|
[DataSourceKey.GOOGLE_DRIVE]: [
|
|
{
|
|
label: 'Primary Admin Email',
|
|
name: 'config.credentials.google_primary_admin',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
placeholder: 'admin@example.com',
|
|
tooltip: t('setting.google_drivePrimaryAdminTip'),
|
|
},
|
|
{
|
|
label: 'OAuth Token JSON',
|
|
name: 'config.credentials.google_tokens',
|
|
type: FormFieldType.Textarea,
|
|
required: true,
|
|
render: (fieldProps) => (
|
|
<GoogleDriveTokenField
|
|
value={fieldProps.value}
|
|
onChange={fieldProps.onChange}
|
|
placeholder='{ "token": "...", "refresh_token": "...", ... }'
|
|
/>
|
|
),
|
|
tooltip: t('setting.google_driveTokenTip'),
|
|
},
|
|
{
|
|
label: 'My Drive Emails',
|
|
name: 'config.my_drive_emails',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
placeholder: 'user1@example.com,user2@example.com',
|
|
tooltip: t('setting.google_driveMyDriveEmailsTip'),
|
|
},
|
|
{
|
|
label: 'Shared Folder URLs',
|
|
name: 'config.shared_folder_urls',
|
|
type: FormFieldType.Textarea,
|
|
required: true,
|
|
placeholder:
|
|
'https://drive.google.com/drive/folders/XXXXX,https://drive.google.com/drive/folders/YYYYY',
|
|
tooltip: t('setting.google_driveSharedFoldersTip'),
|
|
},
|
|
// The fields below are intentionally disabled for now. Uncomment them when we
|
|
// reintroduce shared drive controls or advanced impersonation options.
|
|
// {
|
|
// label: 'Shared Drive URLs',
|
|
// name: 'config.shared_drive_urls',
|
|
// type: FormFieldType.Text,
|
|
// required: false,
|
|
// placeholder:
|
|
// 'Optional: comma-separated shared drive links if you want to include them.',
|
|
// },
|
|
// {
|
|
// label: 'Specific User Emails',
|
|
// name: 'config.specific_user_emails',
|
|
// type: FormFieldType.Text,
|
|
// required: false,
|
|
// placeholder:
|
|
// 'Optional: comma-separated list of users to impersonate (overrides defaults).',
|
|
// },
|
|
// {
|
|
// label: 'Include My Drive',
|
|
// name: 'config.include_my_drives',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: true,
|
|
// },
|
|
// {
|
|
// label: 'Include Shared Drives',
|
|
// name: 'config.include_shared_drives',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: false,
|
|
// },
|
|
// {
|
|
// label: 'Include “Shared with me”',
|
|
// name: 'config.include_files_shared_with_me',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: false,
|
|
// },
|
|
// {
|
|
// label: 'Allow Images',
|
|
// name: 'config.allow_images',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: false,
|
|
// },
|
|
{
|
|
label: '',
|
|
name: 'config.credentials.authentication_method',
|
|
type: FormFieldType.Text,
|
|
required: false,
|
|
hidden: true,
|
|
defaultValue: 'uploaded',
|
|
},
|
|
],
|
|
[DataSourceKey.GOOGLE_DRIVE]: [
|
|
{
|
|
label: 'Primary Admin Email',
|
|
name: 'config.credentials.google_primary_admin',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
placeholder: 'admin@example.com',
|
|
tooltip: t('setting.google_drivePrimaryAdminTip'),
|
|
},
|
|
{
|
|
label: 'OAuth Token JSON',
|
|
name: 'config.credentials.google_tokens',
|
|
type: FormFieldType.Textarea,
|
|
required: true,
|
|
render: (fieldProps) => (
|
|
<GoogleDriveTokenField
|
|
value={fieldProps.value}
|
|
onChange={fieldProps.onChange}
|
|
placeholder='{ "token": "...", "refresh_token": "...", ... }'
|
|
/>
|
|
),
|
|
tooltip: t('setting.google_driveTokenTip'),
|
|
},
|
|
{
|
|
label: 'My Drive Emails',
|
|
name: 'config.my_drive_emails',
|
|
type: FormFieldType.Text,
|
|
required: true,
|
|
placeholder: 'user1@example.com,user2@example.com',
|
|
tooltip: t('setting.google_driveMyDriveEmailsTip'),
|
|
},
|
|
{
|
|
label: 'Shared Folder URLs',
|
|
name: 'config.shared_folder_urls',
|
|
type: FormFieldType.Textarea,
|
|
required: true,
|
|
placeholder:
|
|
'https://drive.google.com/drive/folders/XXXXX,https://drive.google.com/drive/folders/YYYYY',
|
|
tooltip: t('setting.google_driveSharedFoldersTip'),
|
|
},
|
|
// The fields below are intentionally disabled for now. Uncomment them when we
|
|
// reintroduce shared drive controls or advanced impersonation options.
|
|
// {
|
|
// label: 'Shared Drive URLs',
|
|
// name: 'config.shared_drive_urls',
|
|
// type: FormFieldType.Text,
|
|
// required: false,
|
|
// placeholder:
|
|
// 'Optional: comma-separated shared drive links if you want to include them.',
|
|
// },
|
|
// {
|
|
// label: 'Specific User Emails',
|
|
// name: 'config.specific_user_emails',
|
|
// type: FormFieldType.Text,
|
|
// required: false,
|
|
// placeholder:
|
|
// 'Optional: comma-separated list of users to impersonate (overrides defaults).',
|
|
// },
|
|
// {
|
|
// label: 'Include My Drive',
|
|
// name: 'config.include_my_drives',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: true,
|
|
// },
|
|
// {
|
|
// label: 'Include Shared Drives',
|
|
// name: 'config.include_shared_drives',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: false,
|
|
// },
|
|
// {
|
|
// label: 'Include “Shared with me”',
|
|
// name: 'config.include_files_shared_with_me',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: false,
|
|
// },
|
|
// {
|
|
// label: 'Allow Images',
|
|
// name: 'config.allow_images',
|
|
// type: FormFieldType.Checkbox,
|
|
// required: false,
|
|
// defaultValue: false,
|
|
// },
|
|
{
|
|
label: '',
|
|
name: 'config.credentials.authentication_method',
|
|
type: FormFieldType.Text,
|
|
required: false,
|
|
hidden: true,
|
|
defaultValue: 'uploaded',
|
|
},
|
|
],
|
|
};
|
|
|
|
export const DataSourceFormDefaultValues = {
|
|
[DataSourceKey.S3]: {
|
|
name: '',
|
|
source: DataSourceKey.S3,
|
|
config: {
|
|
bucket_name: '',
|
|
bucket_type: 's3',
|
|
prefix: '',
|
|
credentials: {
|
|
aws_access_key_id: '',
|
|
aws_secret_access_key: '',
|
|
},
|
|
},
|
|
},
|
|
[DataSourceKey.NOTION]: {
|
|
name: '',
|
|
source: DataSourceKey.NOTION,
|
|
config: {
|
|
root_page_id: '',
|
|
credentials: {
|
|
notion_integration_token: '',
|
|
},
|
|
},
|
|
},
|
|
[DataSourceKey.DISCORD]: {
|
|
name: '',
|
|
source: DataSourceKey.DISCORD,
|
|
config: {
|
|
server_ids: [],
|
|
channels: [],
|
|
credentials: {
|
|
discord_bot_token: '',
|
|
},
|
|
},
|
|
},
|
|
[DataSourceKey.CONFLUENCE]: {
|
|
name: '',
|
|
source: DataSourceKey.CONFLUENCE,
|
|
config: {
|
|
wiki_base: '',
|
|
is_cloud: true,
|
|
credentials: {
|
|
confluence_username: '',
|
|
confluence_access_token: '',
|
|
},
|
|
},
|
|
},
|
|
[DataSourceKey.GOOGLE_DRIVE]: {
|
|
name: '',
|
|
source: DataSourceKey.GOOGLE_DRIVE,
|
|
config: {
|
|
include_shared_drives: false,
|
|
include_my_drives: true,
|
|
include_files_shared_with_me: false,
|
|
allow_images: false,
|
|
shared_drive_urls: '',
|
|
shared_folder_urls: '',
|
|
my_drive_emails: '',
|
|
specific_user_emails: '',
|
|
credentials: {
|
|
google_primary_admin: '',
|
|
google_tokens: '',
|
|
authentication_method: 'uploaded',
|
|
},
|
|
},
|
|
},
|
|
};
|