feat(frontend): enable Yuque datasource option with optional base_url

Flip the Yuque tile to available, add a base_url field (optional) for users
on private Yuque deployments, and populate the permission doc/page links.
Introduces an optional flag on ConnectorDef.fields so the Test Connection
validator skips empty optional fields; required fields get a visible * mark.

Also adds an optional hintKey on ConnectorDef.fields for per-field guidance
text, a Yuque-specific prereq guide, and a base_url hint explaining when to
leave it empty vs fill it for Yuque Enterprise / self-hosted deployments.
This commit is contained in:
nullkey
2026-04-21 17:29:53 +08:00
committed by lyingbug
parent 4939011b0d
commit 16792713c5
3 changed files with 43 additions and 8 deletions
@@ -149,7 +149,7 @@ interface ConnectorDef {
permissionDocUrl: string
permissionPageUrl: string
requiredPermissions: string[]
fields: { key: string; labelKey: string; placeholder: string; secret?: boolean }[]
fields: { key: string; labelKey: string; placeholder: string; secret?: boolean; optional?: boolean; hintKey?: string }[]
}
const connectorDefs = computed<ConnectorDef[]>(() => [
@@ -183,13 +183,17 @@ const connectorDefs = computed<ConnectorDef[]>(() => [
},
{
type: 'yuque',
available: false,
docUrl: 'https://www.yuque.com/settings/tokens',
permissionDocUrl: '',
permissionPageUrl: '',
requiredPermissions: [],
available: true,
docUrl: 'https://www.yuque.com/yuque/developer/api',
permissionDocUrl: 'https://www.yuque.com/yuque/developer/api',
permissionPageUrl: 'https://www.yuque.com/settings/tokens',
requiredPermissions: [
'repo:read',
'doc:read',
],
fields: [
{ key: 'api_token', labelKey: 'datasource.field.apiToken', placeholder: '', secret: true },
{ key: 'base_url', labelKey: 'datasource.field.baseUrl', placeholder: 'https://www.yuque.com', optional: true, hintKey: 'datasource.field.baseUrlHint' },
],
},
])
@@ -244,6 +248,7 @@ function selectType(def: ConnectorDef) {
async function testConnection() {
const fields = currentDef.value?.fields || []
for (const f of fields) {
if (f.optional) continue
if (!form.value.config.credentials[f.key]) {
MessagePlugin.warning(`${t(f.labelKey)} ${t('datasource.isRequired')}`)
return
@@ -373,6 +378,7 @@ function toggleResource(id: string) {
function validateStep1Fields(): boolean {
const fields = currentDef.value?.fields || []
for (const f of fields) {
if (f.optional) continue
if (!form.value.config.credentials[f.key]) {
MessagePlugin.warning(`${t(f.labelKey)} ${t('datasource.isRequired')}`)
return false
@@ -458,6 +464,7 @@ async function handleClose() {
const resourceTypeLabelMap: Record<string, string> = {
wiki_space: 'datasource.resourceType.wikiSpace',
doc_category: 'datasource.resourceType.docCategory',
book: 'datasource.resourceType.book',
}
function resourceTypeLabel(type: string): string {
@@ -549,7 +556,7 @@ const stepTitles = computed(() => [
</div>
</div>
<a :href="currentDef.permissionPageUrl" target="_blank" rel="noopener" class="ds-prereq-link">
{{ t('datasource.prereqOpenConsole') }}
{{ t(`datasource.prereqOpenConsole_${form.type}`, t('datasource.prereqOpenConsole')) }}
</a>
</div>
@@ -565,12 +572,16 @@ const stepTitles = computed(() => [
</div>
<div v-for="field in currentDef?.fields || []" :key="field.key" class="form-item">
<label class="form-label">{{ t(field.labelKey) }}</label>
<label class="form-label">
{{ t(field.labelKey) }}
<span v-if="!field.optional" class="required-mark">*</span>
</label>
<t-input
v-model="form.config.credentials[field.key]"
:placeholder="field.placeholder"
:type="field.secret ? 'password' : 'text'"
/>
<div v-if="field.hintKey" class="form-hint">{{ t(field.hintKey) }}</div>
</div>
<div class="form-actions">
@@ -871,7 +882,9 @@ const stepTitles = computed(() => [
.form-item { margin-bottom: 16px; }
.form-label { display: block; font-size: 13px; font-weight: 500; margin-bottom: 6px; color: var(--td-text-color-primary); }
.required-mark { color: var(--td-error-color); margin-left: 2px; }
.form-tip { font-size: 12px; color: var(--td-text-color-placeholder); margin: 4px 0 12px; }
.form-hint { font-size: 12px; color: var(--td-text-color-placeholder); margin-top: 6px; line-height: 1.5; }
.form-actions { display: flex; align-items: center; gap: 8px; margin-top: 12px; }
.test-ok { color: var(--td-success-color); font-size: 13px; display: flex; align-items: center; gap: 4px; }